xref: /openbmc/u-boot/README (revision 0b953ffc653fc5ab3d3fa47abf0dd9b8bd0703f5)
1c609719bSwdenk#
2151ab83aSwdenk# (C) Copyright 2000 - 2005
3c609719bSwdenk# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4c609719bSwdenk#
5c609719bSwdenk# See file CREDITS for list of people who contributed to this
6c609719bSwdenk# project.
7c609719bSwdenk#
8c609719bSwdenk# This program is free software; you can redistribute it and/or
9c609719bSwdenk# modify it under the terms of the GNU General Public License as
10c609719bSwdenk# published by the Free Software Foundation; either version 2 of
11c609719bSwdenk# the License, or (at your option) any later version.
12c609719bSwdenk#
13c609719bSwdenk# This program is distributed in the hope that it will be useful,
14c609719bSwdenk# but WITHOUT ANY WARRANTY; without even the implied warranty of
15c609719bSwdenk# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	See the
16c609719bSwdenk# GNU General Public License for more details.
17c609719bSwdenk#
18c609719bSwdenk# You should have received a copy of the GNU General Public License
19c609719bSwdenk# along with this program; if not, write to the Free Software
20c609719bSwdenk# Foundation, Inc., 59 Temple Place, Suite 330, Boston,
21c609719bSwdenk# MA 02111-1307 USA
22c609719bSwdenk#
23c609719bSwdenk
24c609719bSwdenkSummary:
25c609719bSwdenk========
26c609719bSwdenk
2724ee89b9SwdenkThis directory contains the source code for U-Boot, a boot loader for
28e86e5a07SwdenkEmbedded boards based on PowerPC, ARM, MIPS and several other
29e86e5a07Swdenkprocessors, which can be installed in a boot ROM and used to
30e86e5a07Swdenkinitialize and test the hardware or to download and run application
31e86e5a07Swdenkcode.
32c609719bSwdenk
33c609719bSwdenkThe development of U-Boot is closely related to Linux: some parts of
3424ee89b9Swdenkthe source code originate in the Linux source tree, we have some
3524ee89b9Swdenkheader files in common, and special provision has been made to
36c609719bSwdenksupport booting of Linux images.
37c609719bSwdenk
38c609719bSwdenkSome attention has been paid to make this software easily
39c609719bSwdenkconfigurable and extendable. For instance, all monitor commands are
40c609719bSwdenkimplemented with the same call interface, so that it's very easy to
41c609719bSwdenkadd new commands. Also, instead of permanently adding rarely used
42c609719bSwdenkcode (for instance hardware test utilities) to the monitor, you can
43c609719bSwdenkload and run it dynamically.
44c609719bSwdenk
45c609719bSwdenk
46c609719bSwdenkStatus:
47c609719bSwdenk=======
48c609719bSwdenk
49c609719bSwdenkIn general, all boards for which a configuration option exists in the
50c609719bSwdenkMakefile have been tested to some extent and can be considered
51c609719bSwdenk"working". In fact, many of them are used in production systems.
52c609719bSwdenk
53c609719bSwdenkIn case of problems see the CHANGELOG and CREDITS files to find out
54c609719bSwdenkwho contributed the specific port.
55c609719bSwdenk
56c609719bSwdenk
57c609719bSwdenkWhere to get help:
58c609719bSwdenk==================
59c609719bSwdenk
60c609719bSwdenkIn case you have questions about, problems with or contributions for
61c609719bSwdenkU-Boot you should send a message to the U-Boot mailing list at
62c609719bSwdenk<u-boot-users@lists.sourceforge.net>. There is also an archive of
63c609719bSwdenkprevious traffic on the mailing list - please search the archive
64c609719bSwdenkbefore asking FAQ's. Please see
65c609719bSwdenkhttp://lists.sourceforge.net/lists/listinfo/u-boot-users/
66c609719bSwdenk
67c609719bSwdenk
68c609719bSwdenkWhere we come from:
69c609719bSwdenk===================
70c609719bSwdenk
71c609719bSwdenk- start from 8xxrom sources
7224ee89b9Swdenk- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
73c609719bSwdenk- clean up code
74c609719bSwdenk- make it easier to add custom boards
75c609719bSwdenk- make it possible to add other [PowerPC] CPUs
76c609719bSwdenk- extend functions, especially:
77c609719bSwdenk  * Provide extended interface to Linux boot loader
78c609719bSwdenk  * S-Record download
79c609719bSwdenk  * network boot
80c609719bSwdenk  * PCMCIA / CompactFLash / ATA disk / SCSI ... boot
8124ee89b9Swdenk- create ARMBoot project (http://sourceforge.net/projects/armboot)
82c609719bSwdenk- add other CPU families (starting with ARM)
8324ee89b9Swdenk- create U-Boot project (http://sourceforge.net/projects/u-boot)
8424ee89b9Swdenk
8524ee89b9Swdenk
8624ee89b9SwdenkNames and Spelling:
8724ee89b9Swdenk===================
8824ee89b9Swdenk
8924ee89b9SwdenkThe "official" name of this project is "Das U-Boot". The spelling
9024ee89b9Swdenk"U-Boot" shall be used in all written text (documentation, comments
9124ee89b9Swdenkin source files etc.). Example:
9224ee89b9Swdenk
9324ee89b9Swdenk	This is the README file for the U-Boot project.
9424ee89b9Swdenk
9524ee89b9SwdenkFile names etc. shall be based on the string "u-boot". Examples:
9624ee89b9Swdenk
9724ee89b9Swdenk	include/asm-ppc/u-boot.h
9824ee89b9Swdenk
9924ee89b9Swdenk	#include <asm/u-boot.h>
10024ee89b9Swdenk
10124ee89b9SwdenkVariable names, preprocessor constants etc. shall be either based on
10224ee89b9Swdenkthe string "u_boot" or on "U_BOOT". Example:
10324ee89b9Swdenk
10424ee89b9Swdenk	U_BOOT_VERSION		u_boot_logo
10524ee89b9Swdenk	IH_OS_U_BOOT		u_boot_hush_start
106c609719bSwdenk
107c609719bSwdenk
10893f19cc0SwdenkVersioning:
10993f19cc0Swdenk===========
11093f19cc0Swdenk
11193f19cc0SwdenkU-Boot uses a 3 level version number containing a version, a
11293f19cc0Swdenksub-version, and a patchlevel: "U-Boot-2.34.5" means version "2",
11393f19cc0Swdenksub-version "34", and patchlevel "4".
11493f19cc0Swdenk
11593f19cc0SwdenkThe patchlevel is used to indicate certain stages of development
11693f19cc0Swdenkbetween released versions, i. e. officially released versions of
11793f19cc0SwdenkU-Boot will always have a patchlevel of "0".
11893f19cc0Swdenk
11993f19cc0Swdenk
120c609719bSwdenkDirectory Hierarchy:
121c609719bSwdenk====================
122c609719bSwdenk
1237152b1d0Swdenk- board		Board dependent files
1247152b1d0Swdenk- common	Misc architecture independent functions
125c609719bSwdenk- cpu		CPU specific files
126983fda83Swdenk  - 74xx_7xx	Files specific to Freescale MPC74xx and 7xx CPUs
12711dadd54Swdenk  - arm720t	Files specific to ARM 720 CPUs
12811dadd54Swdenk  - arm920t	Files specific to ARM 920 CPUs
129a85f9f21Swdenk    - at91rm9200 Files specific to Atmel AT91RM9200 CPU
130983fda83Swdenk    - imx	Files specific to Freescale MC9328 i.MX CPUs
1311d9f4105Swdenk    - s3c24x0	Files specific to Samsung S3C24X0 CPUs
13211dadd54Swdenk  - arm925t	Files specific to ARM 925 CPUs
13311dadd54Swdenk  - arm926ejs	Files specific to ARM 926 CPUs
1348ed96046Swdenk  - arm1136	Files specific to ARM 1136 CPUs
13511dadd54Swdenk  - i386	Files specific to i386 CPUs
13611dadd54Swdenk  - ixp		Files specific to Intel XScale IXP CPUs
137983fda83Swdenk  - mcf52x2	Files specific to Freescale ColdFire MCF52x2 CPUs
13811dadd54Swdenk  - mips	Files specific to MIPS CPUs
139983fda83Swdenk  - mpc5xx	Files specific to Freescale MPC5xx  CPUs
140983fda83Swdenk  - mpc5xxx	Files specific to Freescale MPC5xxx CPUs
141983fda83Swdenk  - mpc8xx	Files specific to Freescale MPC8xx  CPUs
142983fda83Swdenk  - mpc8220	Files specific to Freescale MPC8220 CPUs
143983fda83Swdenk  - mpc824x	Files specific to Freescale MPC824x CPUs
144983fda83Swdenk  - mpc8260	Files specific to Freescale MPC8260 CPUs
145983fda83Swdenk  - mpc85xx	Files specific to Freescale MPC85xx CPUs
14611dadd54Swdenk  - nios	Files specific to Altera NIOS CPUs
1475c952cf0Swdenk  - nios2	Files specific to Altera Nios-II CPUs
1480c8721a4SWolfgang Denk  - ppc4xx	Files specific to AMCC PowerPC 4xx CPUs
14911dadd54Swdenk  - pxa		Files specific to Intel XScale PXA CPUs
15011dadd54Swdenk  - s3c44b0	Files specific to Samsung S3C44B0 CPUs
15111dadd54Swdenk  - sa1100	Files specific to Intel StrongARM SA1100 CPUs
152c609719bSwdenk- disk		Code for disk drive partition handling
153c609719bSwdenk- doc		Documentation (don't expect too much)
1547152b1d0Swdenk- drivers	Commonly used device drivers
155c609719bSwdenk- dtt		Digital Thermometer and Thermostat drivers
156c609719bSwdenk- examples	Example code for standalone applications, etc.
157c609719bSwdenk- include	Header Files
15811dadd54Swdenk- lib_arm	Files generic to ARM	 architecture
15911dadd54Swdenk- lib_generic	Files generic to all	 architectures
16011dadd54Swdenk- lib_i386	Files generic to i386	 architecture
16111dadd54Swdenk- lib_m68k	Files generic to m68k	 architecture
16211dadd54Swdenk- lib_mips	Files generic to MIPS	 architecture
16311dadd54Swdenk- lib_nios	Files generic to NIOS	 architecture
16411dadd54Swdenk- lib_ppc	Files generic to PowerPC architecture
165c609719bSwdenk- net		Networking code
166c609719bSwdenk- post		Power On Self Test
167c609719bSwdenk- rtc		Real Time Clock drivers
168c609719bSwdenk- tools		Tools to build S-Record or U-Boot images, etc.
169c609719bSwdenk
170c609719bSwdenkSoftware Configuration:
171c609719bSwdenk=======================
172c609719bSwdenk
173c609719bSwdenkConfiguration is usually done using C preprocessor defines; the
174c609719bSwdenkrationale behind that is to avoid dead code whenever possible.
175c609719bSwdenk
176c609719bSwdenkThere are two classes of configuration variables:
177c609719bSwdenk
178c609719bSwdenk* Configuration _OPTIONS_:
179c609719bSwdenk  These are selectable by the user and have names beginning with
180c609719bSwdenk  "CONFIG_".
181c609719bSwdenk
182c609719bSwdenk* Configuration _SETTINGS_:
183c609719bSwdenk  These depend on the hardware etc. and should not be meddled with if
184c609719bSwdenk  you don't know what you're doing; they have names beginning with
185c609719bSwdenk  "CFG_".
186c609719bSwdenk
187c609719bSwdenkLater we will add a configuration tool - probably similar to or even
188c609719bSwdenkidentical to what's used for the Linux kernel. Right now, we have to
189c609719bSwdenkdo the configuration by hand, which means creating some symbolic
190c609719bSwdenklinks and editing some configuration files. We use the TQM8xxL boards
191c609719bSwdenkas an example here.
192c609719bSwdenk
193c609719bSwdenk
194c609719bSwdenkSelection of Processor Architecture and Board Type:
195c609719bSwdenk---------------------------------------------------
196c609719bSwdenk
197c609719bSwdenkFor all supported boards there are ready-to-use default
198c609719bSwdenkconfigurations available; just type "make <board_name>_config".
199c609719bSwdenk
200c609719bSwdenkExample: For a TQM823L module type:
201c609719bSwdenk
202c609719bSwdenk	cd u-boot
203c609719bSwdenk	make TQM823L_config
204c609719bSwdenk
205c609719bSwdenkFor the Cogent platform, you need to specify the cpu type as well;
206c609719bSwdenke.g. "make cogent_mpc8xx_config". And also configure the cogent
207c609719bSwdenkdirectory according to the instructions in cogent/README.
208c609719bSwdenk
209c609719bSwdenk
210c609719bSwdenkConfiguration Options:
211c609719bSwdenk----------------------
212c609719bSwdenk
213c609719bSwdenkConfiguration depends on the combination of board and CPU type; all
214c609719bSwdenksuch information is kept in a configuration file
215c609719bSwdenk"include/configs/<board_name>.h".
216c609719bSwdenk
217c609719bSwdenkExample: For a TQM823L module, all configuration settings are in
218c609719bSwdenk"include/configs/TQM823L.h".
219c609719bSwdenk
220c609719bSwdenk
2217f6c2cbcSwdenkMany of the options are named exactly as the corresponding Linux
2227f6c2cbcSwdenkkernel configuration options. The intention is to make it easier to
2237f6c2cbcSwdenkbuild a config tool - later.
2247f6c2cbcSwdenk
2257f6c2cbcSwdenk
226c609719bSwdenkThe following options need to be configured:
227c609719bSwdenk
228c609719bSwdenk- CPU Type:	Define exactly one of
229c609719bSwdenk
230c609719bSwdenk		PowerPC based CPUs:
231c609719bSwdenk		-------------------
232c609719bSwdenk		CONFIG_MPC823,	CONFIG_MPC850,	CONFIG_MPC855,	CONFIG_MPC860
2330db5bca8Swdenk	or	CONFIG_MPC5xx
234983fda83Swdenk	or	CONFIG_MPC8220
235c609719bSwdenk	or	CONFIG_MPC824X, CONFIG_MPC8260
23642d1f039Swdenk	or	CONFIG_MPC85xx
237c609719bSwdenk	or	CONFIG_IOP480
238c609719bSwdenk	or	CONFIG_405GP
23912f34241Swdenk	or	CONFIG_405EP
240c609719bSwdenk	or	CONFIG_440
241c609719bSwdenk	or	CONFIG_MPC74xx
24272755c71Swdenk	or	CONFIG_750FX
243c609719bSwdenk
244c609719bSwdenk		ARM based CPUs:
245c609719bSwdenk		---------------
246c609719bSwdenk		CONFIG_SA1110
247c609719bSwdenk		CONFIG_ARM7
248c609719bSwdenk		CONFIG_PXA250
249*0b953ffcSMarkus Klotzbuecher		CONFIG_CPU_MONAHANS
250c609719bSwdenk
251507bbe3eSwdenk		MicroBlaze based CPUs:
252507bbe3eSwdenk		----------------------
253857cad37Swdenk		CONFIG_MICROBLAZE
254507bbe3eSwdenk
2555c952cf0Swdenk		Nios-2 based CPUs:
2565c952cf0Swdenk		----------------------
2575c952cf0Swdenk		CONFIG_NIOS2
2585c952cf0Swdenk
259c609719bSwdenk
260c609719bSwdenk- Board Type:	Define exactly one of
261c609719bSwdenk
262c609719bSwdenk		PowerPC based boards:
263c609719bSwdenk		---------------------
264c609719bSwdenk
2657521af1cSWolfgang Denk		CONFIG_ADCIOP		CONFIG_GEN860T		CONFIG_PCIPPC2
2667521af1cSWolfgang Denk		CONFIG_ADS860		CONFIG_GENIETV		CONFIG_PCIPPC6
2677521af1cSWolfgang Denk		CONFIG_AMX860		CONFIG_GTH		CONFIG_pcu_e
2687521af1cSWolfgang Denk		CONFIG_AP1000		CONFIG_gw8260		CONFIG_PIP405
2697521af1cSWolfgang Denk		CONFIG_AR405		CONFIG_hermes		CONFIG_PM826
2707521af1cSWolfgang Denk		CONFIG_BAB7xx		CONFIG_hymod		CONFIG_ppmc8260
2717521af1cSWolfgang Denk		CONFIG_c2mon		CONFIG_IAD210		CONFIG_QS823
2727521af1cSWolfgang Denk		CONFIG_CANBT		CONFIG_ICU862		CONFIG_QS850
2737521af1cSWolfgang Denk		CONFIG_CCM		CONFIG_IP860		CONFIG_QS860T
2747521af1cSWolfgang Denk		CONFIG_CMI		CONFIG_IPHASE4539	CONFIG_RBC823
2757521af1cSWolfgang Denk		CONFIG_cogent_mpc8260	CONFIG_IVML24		CONFIG_RPXClassic
2767521af1cSWolfgang Denk		CONFIG_cogent_mpc8xx	CONFIG_IVML24_128	CONFIG_RPXlite
2777521af1cSWolfgang Denk		CONFIG_CPCI405		CONFIG_IVML24_256	CONFIG_RPXsuper
2787521af1cSWolfgang Denk		CONFIG_CPCI4052		CONFIG_IVMS8		CONFIG_rsdproto
2797521af1cSWolfgang Denk		CONFIG_CPCIISER4	CONFIG_IVMS8_128	CONFIG_sacsng
2807521af1cSWolfgang Denk		CONFIG_CPU86		CONFIG_IVMS8_256	CONFIG_Sandpoint8240
2817521af1cSWolfgang Denk		CONFIG_CRAYL1		CONFIG_JSE		CONFIG_Sandpoint8245
2827521af1cSWolfgang Denk		CONFIG_CSB272		CONFIG_LANTEC		CONFIG_sbc8260
2837521af1cSWolfgang Denk		CONFIG_CU824		CONFIG_lwmon		CONFIG_sbc8560
2847521af1cSWolfgang Denk		CONFIG_DASA_SIM		CONFIG_MBX		CONFIG_SM850
2857521af1cSWolfgang Denk		CONFIG_DB64360		CONFIG_MBX860T		CONFIG_SPD823TS
2867521af1cSWolfgang Denk		CONFIG_DB64460		CONFIG_MHPC		CONFIG_STXGP3
2877521af1cSWolfgang Denk		CONFIG_DU405		CONFIG_MIP405		CONFIG_SXNI855T
2887521af1cSWolfgang Denk		CONFIG_DUET_ADS		CONFIG_MOUSSE		CONFIG_TQM823L
2897521af1cSWolfgang Denk		CONFIG_EBONY		CONFIG_MPC8260ADS	CONFIG_TQM8260
2907521af1cSWolfgang Denk		CONFIG_ELPPC		CONFIG_MPC8540ADS	CONFIG_TQM850L
2917521af1cSWolfgang Denk		CONFIG_ELPT860		CONFIG_MPC8540EVAL	CONFIG_TQM855L
2927521af1cSWolfgang Denk		CONFIG_ep8260		CONFIG_MPC8560ADS	CONFIG_TQM860L
2937521af1cSWolfgang Denk		CONFIG_ERIC		CONFIG_MUSENKI		CONFIG_TTTech
2947521af1cSWolfgang Denk		CONFIG_ESTEEM192E	CONFIG_MVS1		CONFIG_UTX8245
2957521af1cSWolfgang Denk		CONFIG_ETX094		CONFIG_NETPHONE		CONFIG_V37
2967521af1cSWolfgang Denk		CONFIG_EVB64260		CONFIG_NETTA		CONFIG_W7OLMC
2977521af1cSWolfgang Denk		CONFIG_FADS823		CONFIG_NETVIA		CONFIG_W7OLMG
2987521af1cSWolfgang Denk		CONFIG_FADS850SAR	CONFIG_NX823		CONFIG_WALNUT
2997521af1cSWolfgang Denk		CONFIG_FADS860T		CONFIG_OCRTC		CONFIG_ZPC1900
3007521af1cSWolfgang Denk		CONFIG_FLAGADM		CONFIG_ORSG		CONFIG_ZUMA
3017521af1cSWolfgang Denk		CONFIG_FPS850L		CONFIG_OXC
3027521af1cSWolfgang Denk		CONFIG_FPS860L		CONFIG_PCI405
303c609719bSwdenk
304c609719bSwdenk		ARM based boards:
305c609719bSwdenk		-----------------
306c609719bSwdenk
307c570b2fdSWolfgang Denk		CONFIG_ARMADILLO,	CONFIG_AT91RM9200DK,	CONFIG_CERF250,
308*0b953ffcSMarkus Klotzbuecher		CONFIG_CSB637,		CONFIG_DELTA,		CONFIG_DNP1110,
309*0b953ffcSMarkus Klotzbuecher	 	CONFIG_EP7312,		CONFIG_H2_OMAP1610,	CONFIG_HHP_CRADLE,
310*0b953ffcSMarkus Klotzbuecher		CONFIG_IMPA7,		CONFIG_INNOVATOROMAP1510, CONFIG_INNOVATOROMAP1610,
311*0b953ffcSMarkus Klotzbuecher		CONFIG_KB9202,		CONFIG_LART,		CONFIG_LPD7A400,
312*0b953ffcSMarkus Klotzbuecher		CONFIG_LUBBOCK,		CONFIG_OSK_OMAP5912,	CONFIG_OMAP2420H4,
313*0b953ffcSMarkus Klotzbuecher		CONFIG_SHANNON,		CONFIG_P2_OMAP730,	CONFIG_SMDK2400,
314*0b953ffcSMarkus Klotzbuecher		CONFIG_SMDK2410,	CONFIG_TRAB,		CONFIG_VCMA9
315c609719bSwdenk
316507bbe3eSwdenk		MicroBlaze based boards:
317507bbe3eSwdenk		------------------------
318507bbe3eSwdenk
319507bbe3eSwdenk		CONFIG_SUZAKU
320507bbe3eSwdenk
3215c952cf0Swdenk		Nios-2 based boards:
3225c952cf0Swdenk		------------------------
3235c952cf0Swdenk
3245c952cf0Swdenk		CONFIG_PCI5441 CONFIG_PK1C20
3255c952cf0Swdenk
326c609719bSwdenk
327c609719bSwdenk- CPU Module Type: (if CONFIG_COGENT is defined)
328c609719bSwdenk		Define exactly one of
329c609719bSwdenk		CONFIG_CMA286_60_OLD
330c609719bSwdenk--- FIXME --- not tested yet:
331c609719bSwdenk		CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
332c609719bSwdenk		CONFIG_CMA287_23, CONFIG_CMA287_50
333c609719bSwdenk
334c609719bSwdenk- Motherboard Type: (if CONFIG_COGENT is defined)
335c609719bSwdenk		Define exactly one of
336c609719bSwdenk		CONFIG_CMA101, CONFIG_CMA102
337c609719bSwdenk
338c609719bSwdenk- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
339c609719bSwdenk		Define one or more of
340c609719bSwdenk		CONFIG_CMA302
341c609719bSwdenk
342c609719bSwdenk- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
343c609719bSwdenk		Define one or more of
344c609719bSwdenk		CONFIG_LCD_HEARTBEAT	- update a character position on
345c609719bSwdenk					  the lcd display every second with
346c609719bSwdenk					  a "rotator" |\-/|\-/
347c609719bSwdenk
3482535d602Swdenk- Board flavour: (if CONFIG_MPC8260ADS is defined)
3492535d602Swdenk		CONFIG_ADSTYPE
3502535d602Swdenk		Possible values are:
3512535d602Swdenk			CFG_8260ADS	- original MPC8260ADS
352180d3f74Swdenk			CFG_8266ADS	- MPC8266ADS
35354387ac9Swdenk			CFG_PQ2FADS	- PQ2FADS-ZU or PQ2FADS-VR
35404a85b3bSwdenk			CFG_8272ADS	- MPC8272ADS
3552535d602Swdenk
356c609719bSwdenk- MPC824X Family Member (if CONFIG_MPC824X is defined)
357c609719bSwdenk		Define exactly one of
358c609719bSwdenk		CONFIG_MPC8240, CONFIG_MPC8245
359c609719bSwdenk
36075d1ea7fSwdenk- 8xx CPU Options: (if using an MPC8xx cpu)
36166ca92a5Swdenk		CONFIG_8xx_GCLK_FREQ	- deprecated: CPU clock if
36266ca92a5Swdenk					  get_gclk_freq() cannot work
3635da627a4Swdenk					  e.g. if there is no 32KHz
3645da627a4Swdenk					  reference PIT/RTC clock
36566ca92a5Swdenk		CONFIG_8xx_OSCLK	- PLL input clock (either EXTCLK
36666ca92a5Swdenk					  or XTAL/EXTAL)
367c609719bSwdenk
36866ca92a5Swdenk- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
36966ca92a5Swdenk		CFG_8xx_CPUCLK_MIN
37066ca92a5Swdenk		CFG_8xx_CPUCLK_MAX
37166ca92a5Swdenk		CONFIG_8xx_CPUCLK_DEFAULT
37275d1ea7fSwdenk			See doc/README.MPC866
37375d1ea7fSwdenk
37475d1ea7fSwdenk		CFG_MEASURE_CPUCLK
37575d1ea7fSwdenk
37675d1ea7fSwdenk		Define this to measure the actual CPU clock instead
37775d1ea7fSwdenk		of relying on the correctness of the configured
37875d1ea7fSwdenk		values. Mostly useful for board bringup to make sure
37975d1ea7fSwdenk		the PLL is locked at the intended frequency. Note
38075d1ea7fSwdenk		that this requires a (stable) reference clock (32 kHz
38166ca92a5Swdenk		RTC clock or CFG_8XX_XIN)
38275d1ea7fSwdenk
383*0b953ffcSMarkus Klotzbuecher- Intel Monahans options:
384*0b953ffcSMarkus Klotzbuecher		CFG_MONAHANS_RUN_MODE_OSC_RATIO
385*0b953ffcSMarkus Klotzbuecher
386*0b953ffcSMarkus Klotzbuecher		Defines the Monahans run mode to oscillator
387*0b953ffcSMarkus Klotzbuecher		ratio. Valid values are 8, 16, 24, 31. The core
388*0b953ffcSMarkus Klotzbuecher		frequency is this value multiplied by 13 MHz.
389*0b953ffcSMarkus Klotzbuecher
390*0b953ffcSMarkus Klotzbuecher		CFG_MONAHANS_TURBO_RUN_MODE_RATIO
391*0b953ffcSMarkus Klotzbuecher
392*0b953ffcSMarkus Klotzbuecher		Defines the Monahans turbo mode to oscillator
393*0b953ffcSMarkus Klotzbuecher		ratio. Valid values are 1 (default if undefined) and
394*0b953ffcSMarkus Klotzbuecher		2. The core frequency as calculated above is multiplied
395*0b953ffcSMarkus Klotzbuecher		by this value.
396*0b953ffcSMarkus Klotzbuecher
3975da627a4Swdenk- Linux Kernel Interface:
398c609719bSwdenk		CONFIG_CLOCKS_IN_MHZ
399c609719bSwdenk
400c609719bSwdenk		U-Boot stores all clock information in Hz
401c609719bSwdenk		internally. For binary compatibility with older Linux
402c609719bSwdenk		kernels (which expect the clocks passed in the
403c609719bSwdenk		bd_info data to be in MHz) the environment variable
404c609719bSwdenk		"clocks_in_mhz" can be defined so that U-Boot
405c609719bSwdenk		converts clock data to MHZ before passing it to the
406c609719bSwdenk		Linux kernel.
407c609719bSwdenk		When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
408c609719bSwdenk		"clocks_in_mhz=1" is  automatically  included  in  the
409c609719bSwdenk		default environment.
410c609719bSwdenk
4115da627a4Swdenk		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]
4125da627a4Swdenk
4135da627a4Swdenk		When transfering memsize parameter to linux, some versions
4145da627a4Swdenk		expect it to be in bytes, others in MB.
4155da627a4Swdenk		Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
4165da627a4Swdenk
417f57f70aaSWolfgang Denk		CONFIG_OF_FLAT_TREE
418f57f70aaSWolfgang Denk
419f57f70aaSWolfgang Denk		New kernel versions are expecting firmware settings to be
420f57f70aaSWolfgang Denk		passed using flat open firmware trees.
421f57f70aaSWolfgang Denk		The environment variable "disable_of", when set, disables this
422f57f70aaSWolfgang Denk		functionality.
423f57f70aaSWolfgang Denk
424f57f70aaSWolfgang Denk		CONFIG_OF_FLAT_TREE_MAX_SIZE
425f57f70aaSWolfgang Denk
426f57f70aaSWolfgang Denk		The maximum size of the constructed OF tree.
427f57f70aaSWolfgang Denk
428f57f70aaSWolfgang Denk		OF_CPU - The proper name of the cpus node.
429f57f70aaSWolfgang Denk		OF_TBCLK - The timebase frequency.
430f57f70aaSWolfgang Denk
4316705d81eSwdenk- Serial Ports:
4326705d81eSwdenk		CFG_PL010_SERIAL
4336705d81eSwdenk
4346705d81eSwdenk		Define this if you want support for Amba PrimeCell PL010 UARTs.
4356705d81eSwdenk
4366705d81eSwdenk		CFG_PL011_SERIAL
4376705d81eSwdenk
4386705d81eSwdenk		Define this if you want support for Amba PrimeCell PL011 UARTs.
4396705d81eSwdenk
4406705d81eSwdenk		CONFIG_PL011_CLOCK
4416705d81eSwdenk
4426705d81eSwdenk		If you have Amba PrimeCell PL011 UARTs, set this variable to
4436705d81eSwdenk		the clock speed of the UARTs.
4446705d81eSwdenk
4456705d81eSwdenk		CONFIG_PL01x_PORTS
4466705d81eSwdenk
4476705d81eSwdenk		If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
4486705d81eSwdenk		define this to a list of base addresses for each (supported)
4496705d81eSwdenk		port. See e.g. include/configs/versatile.h
4506705d81eSwdenk
4516705d81eSwdenk
452c609719bSwdenk- Console Interface:
453c609719bSwdenk		Depending on board, define exactly one serial port
454c609719bSwdenk		(like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
455c609719bSwdenk		CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
456c609719bSwdenk		console by defining CONFIG_8xx_CONS_NONE
457c609719bSwdenk
458c609719bSwdenk		Note: if CONFIG_8xx_CONS_NONE is defined, the serial
459c609719bSwdenk		port routines must be defined elsewhere
460c609719bSwdenk		(i.e. serial_init(), serial_getc(), ...)
461c609719bSwdenk
462c609719bSwdenk		CONFIG_CFB_CONSOLE
463c609719bSwdenk		Enables console device for a color framebuffer. Needs following
464c609719bSwdenk		defines (cf. smiLynxEM, i8042, board/eltec/bab7xx)
465c609719bSwdenk			VIDEO_FB_LITTLE_ENDIAN	graphic memory organisation
466c609719bSwdenk						(default big endian)
467c609719bSwdenk			VIDEO_HW_RECTFILL	graphic chip supports
468c609719bSwdenk						rectangle fill
469c609719bSwdenk						(cf. smiLynxEM)
470c609719bSwdenk			VIDEO_HW_BITBLT		graphic chip supports
471c609719bSwdenk						bit-blit (cf. smiLynxEM)
472c609719bSwdenk			VIDEO_VISIBLE_COLS	visible pixel columns
473c609719bSwdenk						(cols=pitch)
474c609719bSwdenk			VIDEO_VISIBLE_ROWS	visible pixel rows
475c609719bSwdenk			VIDEO_PIXEL_SIZE	bytes per pixel
476c609719bSwdenk			VIDEO_DATA_FORMAT	graphic data format
477c609719bSwdenk						(0-5, cf. cfb_console.c)
478c609719bSwdenk			VIDEO_FB_ADRS		framebuffer address
479c609719bSwdenk			VIDEO_KBD_INIT_FCT	keyboard int fct
480c609719bSwdenk						(i.e. i8042_kbd_init())
481c609719bSwdenk			VIDEO_TSTC_FCT		test char fct
482c609719bSwdenk						(i.e. i8042_tstc)
483c609719bSwdenk			VIDEO_GETC_FCT		get char fct
484c609719bSwdenk						(i.e. i8042_getc)
485c609719bSwdenk			CONFIG_CONSOLE_CURSOR	cursor drawing on/off
486c609719bSwdenk						(requires blink timer
487c609719bSwdenk						cf. i8042.c)
488c609719bSwdenk			CFG_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
489c609719bSwdenk			CONFIG_CONSOLE_TIME	display time/date info in
490c609719bSwdenk						upper right corner
491c609719bSwdenk						(requires CFG_CMD_DATE)
492c609719bSwdenk			CONFIG_VIDEO_LOGO	display Linux logo in
493c609719bSwdenk						upper left corner
494a6c7ad2fSwdenk			CONFIG_VIDEO_BMP_LOGO	use bmp_logo.h instead of
495a6c7ad2fSwdenk						linux_logo.h for logo.
496a6c7ad2fSwdenk						Requires CONFIG_VIDEO_LOGO
497c609719bSwdenk			CONFIG_CONSOLE_EXTRA_INFO
498c609719bSwdenk						addional board info beside
499c609719bSwdenk						the logo
500c609719bSwdenk
501c609719bSwdenk		When CONFIG_CFB_CONSOLE is defined, video console is
502c609719bSwdenk		default i/o. Serial console can be forced with
503c609719bSwdenk		environment 'console=serial'.
504c609719bSwdenk
505a3ad8e26Swdenk		When CONFIG_SILENT_CONSOLE is defined, all console
506a3ad8e26Swdenk		messages (by U-Boot and Linux!) can be silenced with
507a3ad8e26Swdenk		the "silent" environment variable. See
508a3ad8e26Swdenk		doc/README.silent for more information.
509a3ad8e26Swdenk
510c609719bSwdenk- Console Baudrate:
511c609719bSwdenk		CONFIG_BAUDRATE - in bps
512c609719bSwdenk		Select one of the baudrates listed in
513c609719bSwdenk		CFG_BAUDRATE_TABLE, see below.
5143bbc899fSwdenk		CFG_BRGCLK_PRESCALE, baudrate prescale
515c609719bSwdenk
516c609719bSwdenk- Interrupt driven serial port input:
517c609719bSwdenk		CONFIG_SERIAL_SOFTWARE_FIFO
518c609719bSwdenk
519c609719bSwdenk		PPC405GP only.
520c609719bSwdenk		Use an interrupt handler for receiving data on the
521c609719bSwdenk		serial port. It also enables using hardware handshake
522c609719bSwdenk		(RTS/CTS) and UART's built-in FIFO. Set the number of
523c609719bSwdenk		bytes the interrupt driven input buffer should have.
524c609719bSwdenk
525109c0e3aSwdenk		Leave undefined to disable this feature, including
526109c0e3aSwdenk		disable the buffer and hardware handshake.
527c609719bSwdenk
5281d49b1f3Sstroese- Console UART Number:
5291d49b1f3Sstroese		CONFIG_UART1_CONSOLE
5301d49b1f3Sstroese
5310c8721a4SWolfgang Denk		AMCC PPC4xx only.
5321d49b1f3Sstroese		If defined internal UART1 (and not UART0) is used
5331d49b1f3Sstroese		as default U-Boot console.
5341d49b1f3Sstroese
535c609719bSwdenk- Boot Delay:	CONFIG_BOOTDELAY - in seconds
536c609719bSwdenk		Delay before automatically booting the default image;
537c609719bSwdenk		set to -1 to disable autoboot.
538c609719bSwdenk
539c609719bSwdenk		See doc/README.autoboot for these options that
540c609719bSwdenk		work with CONFIG_BOOTDELAY. None are required.
541c609719bSwdenk		CONFIG_BOOT_RETRY_TIME
542c609719bSwdenk		CONFIG_BOOT_RETRY_MIN
543c609719bSwdenk		CONFIG_AUTOBOOT_KEYED
544c609719bSwdenk		CONFIG_AUTOBOOT_PROMPT
545c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR
546c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR
547c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR2
548c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR2
549c609719bSwdenk		CONFIG_ZERO_BOOTDELAY_CHECK
550c609719bSwdenk		CONFIG_RESET_TO_RETRY
551c609719bSwdenk
552c609719bSwdenk- Autoboot Command:
553c609719bSwdenk		CONFIG_BOOTCOMMAND
554c609719bSwdenk		Only needed when CONFIG_BOOTDELAY is enabled;
555c609719bSwdenk		define a command string that is automatically executed
556c609719bSwdenk		when no character is read on the console interface
557c609719bSwdenk		within "Boot Delay" after reset.
558c609719bSwdenk
559c609719bSwdenk		CONFIG_BOOTARGS
560c609719bSwdenk		This can be used to pass arguments to the bootm
561c609719bSwdenk		command. The value of CONFIG_BOOTARGS goes into the
562c609719bSwdenk		environment value "bootargs".
563c609719bSwdenk
564c609719bSwdenk		CONFIG_RAMBOOT and CONFIG_NFSBOOT
565c609719bSwdenk		The value of these goes into the environment as
566c609719bSwdenk		"ramboot" and "nfsboot" respectively, and can be used
567c609719bSwdenk		as a convenience, when switching between booting from
568c609719bSwdenk		ram and nfs.
569c609719bSwdenk
570c609719bSwdenk- Pre-Boot Commands:
571c609719bSwdenk		CONFIG_PREBOOT
572c609719bSwdenk
573c609719bSwdenk		When this option is #defined, the existence of the
574c609719bSwdenk		environment variable "preboot" will be checked
575c609719bSwdenk		immediately before starting the CONFIG_BOOTDELAY
576c609719bSwdenk		countdown and/or running the auto-boot command resp.
577c609719bSwdenk		entering interactive mode.
578c609719bSwdenk
579c609719bSwdenk		This feature is especially useful when "preboot" is
580c609719bSwdenk		automatically generated or modified. For an example
581c609719bSwdenk		see the LWMON board specific code: here "preboot" is
582c609719bSwdenk		modified when the user holds down a certain
583c609719bSwdenk		combination of keys on the (special) keyboard when
584c609719bSwdenk		booting the systems
585c609719bSwdenk
586c609719bSwdenk- Serial Download Echo Mode:
587c609719bSwdenk		CONFIG_LOADS_ECHO
588c609719bSwdenk		If defined to 1, all characters received during a
589c609719bSwdenk		serial download (using the "loads" command) are
590c609719bSwdenk		echoed back. This might be needed by some terminal
591c609719bSwdenk		emulations (like "cu"), but may as well just take
592c609719bSwdenk		time on others. This setting #define's the initial
593c609719bSwdenk		value of the "loads_echo" environment variable.
594c609719bSwdenk
595c609719bSwdenk- Kgdb Serial Baudrate: (if CFG_CMD_KGDB is defined)
596c609719bSwdenk		CONFIG_KGDB_BAUDRATE
597c609719bSwdenk		Select one of the baudrates listed in
598c609719bSwdenk		CFG_BAUDRATE_TABLE, see below.
599c609719bSwdenk
600c609719bSwdenk- Monitor Functions:
601c609719bSwdenk		CONFIG_COMMANDS
602c609719bSwdenk		Most monitor functions can be selected (or
603c609719bSwdenk		de-selected) by adjusting the definition of
604c609719bSwdenk		CONFIG_COMMANDS; to select individual functions,
605c609719bSwdenk		#define CONFIG_COMMANDS by "OR"ing any of the
606c609719bSwdenk		following values:
607c609719bSwdenk
608c609719bSwdenk		#define enables commands:
609c609719bSwdenk		-------------------------
610c609719bSwdenk		CFG_CMD_ASKENV	* ask for env variable
61178137c3cSwdenk		CFG_CMD_AUTOSCRIPT Autoscript Support
612c609719bSwdenk		CFG_CMD_BDI	  bdinfo
6136705d81eSwdenk		CFG_CMD_BEDBUG	* Include BedBug Debugger
61478137c3cSwdenk		CFG_CMD_BMP	* BMP support
6156705d81eSwdenk		CFG_CMD_BSP	* Board specific commands
616c609719bSwdenk		CFG_CMD_BOOTD	  bootd
6176705d81eSwdenk		CFG_CMD_CACHE	* icache, dcache
618c609719bSwdenk		CFG_CMD_CONSOLE	  coninfo
619c609719bSwdenk		CFG_CMD_DATE	* support for RTC, date/time...
6206705d81eSwdenk		CFG_CMD_DHCP	* DHCP support
62178137c3cSwdenk		CFG_CMD_DIAG	* Diagnostics
62278137c3cSwdenk		CFG_CMD_DOC	* Disk-On-Chip Support
6236705d81eSwdenk		CFG_CMD_DTT	* Digital Therm and Thermostat
624c609719bSwdenk		CFG_CMD_ECHO	* echo arguments
625c609719bSwdenk		CFG_CMD_EEPROM	* EEPROM read/write support
6266705d81eSwdenk		CFG_CMD_ELF	* bootelf, bootvx
627c609719bSwdenk		CFG_CMD_ENV	  saveenv
628c609719bSwdenk		CFG_CMD_FDC	* Floppy Disk Support
6296705d81eSwdenk		CFG_CMD_FAT	* FAT partition support
6302262cfeeSwdenk		CFG_CMD_FDOS	* Dos diskette Support
631c609719bSwdenk		CFG_CMD_FLASH	  flinfo, erase, protect
632c609719bSwdenk		CFG_CMD_FPGA	  FPGA device initialization support
63378137c3cSwdenk		CFG_CMD_HWFLOW	* RTS/CTS hw flow control
634c609719bSwdenk		CFG_CMD_I2C	* I2C serial bus support
635c609719bSwdenk		CFG_CMD_IDE	* IDE harddisk support
636c609719bSwdenk		CFG_CMD_IMI	  iminfo
63778137c3cSwdenk		CFG_CMD_IMLS	  List all found images
638c609719bSwdenk		CFG_CMD_IMMAP	* IMMR dump support
639c609719bSwdenk		CFG_CMD_IRQ	* irqinfo
6406705d81eSwdenk		CFG_CMD_ITEST	  Integer/string test of 2 values
64178137c3cSwdenk		CFG_CMD_JFFS2	* JFFS2 Support
642c609719bSwdenk		CFG_CMD_KGDB	* kgdb
643c609719bSwdenk		CFG_CMD_LOADB	  loadb
644c609719bSwdenk		CFG_CMD_LOADS	  loads
645c609719bSwdenk		CFG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
64656523f12Swdenk				  loop, loopw, mtest
64778137c3cSwdenk		CFG_CMD_MISC	  Misc functions like sleep etc
6486705d81eSwdenk		CFG_CMD_MMC	* MMC memory mapped support
6496705d81eSwdenk		CFG_CMD_MII	* MII utility commands
65078137c3cSwdenk		CFG_CMD_NAND	* NAND support
651c609719bSwdenk		CFG_CMD_NET	  bootp, tftpboot, rarpboot
652c609719bSwdenk		CFG_CMD_PCI	* pciinfo
653c609719bSwdenk		CFG_CMD_PCMCIA	* PCMCIA support
65478137c3cSwdenk		CFG_CMD_PING	* send ICMP ECHO_REQUEST to network host
655ef5a9672Swdenk		CFG_CMD_PORTIO	* Port I/O
656c609719bSwdenk		CFG_CMD_REGINFO * Register dump
657c609719bSwdenk		CFG_CMD_RUN	  run command in env variable
6586705d81eSwdenk		CFG_CMD_SAVES	* save S record dump
659c609719bSwdenk		CFG_CMD_SCSI	* SCSI Support
66078137c3cSwdenk		CFG_CMD_SDRAM	* print SDRAM configuration information
661b1bf6f2cSwdenk				  (requires CFG_CMD_I2C)
662c609719bSwdenk		CFG_CMD_SETGETDCR Support for DCR Register access (4xx only)
663c609719bSwdenk		CFG_CMD_SPI	* SPI serial bus support
664c609719bSwdenk		CFG_CMD_USB	* USB support
66578137c3cSwdenk		CFG_CMD_VFD	* VFD support (TRAB)
666c609719bSwdenk		CFG_CMD_BSP	* Board SPecific functions
667a3d991bdSwdenk		CFG_CMD_CDP	* Cisco Discover Protocol support
668c609719bSwdenk		-----------------------------------------------
669c609719bSwdenk		CFG_CMD_ALL	all
670c609719bSwdenk
67181050926Swdenk		CONFIG_CMD_DFL	Default configuration; at the moment
672c609719bSwdenk				this is includes all commands, except
673c609719bSwdenk				the ones marked with "*" in the list
674c609719bSwdenk				above.
675c609719bSwdenk
676c609719bSwdenk		If you don't define CONFIG_COMMANDS it defaults to
67781050926Swdenk		CONFIG_CMD_DFL in include/cmd_confdefs.h. A board can
678c609719bSwdenk		override the default settings in the respective
679c609719bSwdenk		include file.
680c609719bSwdenk
681c609719bSwdenk		EXAMPLE: If you want all functions except of network
682c609719bSwdenk		support you can write:
683c609719bSwdenk
684c609719bSwdenk		#define CONFIG_COMMANDS (CFG_CMD_ALL & ~CFG_CMD_NET)
685c609719bSwdenk
686c609719bSwdenk
687c609719bSwdenk	Note:	Don't enable the "icache" and "dcache" commands
688c609719bSwdenk		(configuration option CFG_CMD_CACHE) unless you know
689c609719bSwdenk		what you (and your U-Boot users) are doing. Data
690c609719bSwdenk		cache cannot be enabled on systems like the 8xx or
691c609719bSwdenk		8260 (where accesses to the IMMR region must be
692c609719bSwdenk		uncached), and it cannot be disabled on all other
693c609719bSwdenk		systems where we (mis-) use the data cache to hold an
694c609719bSwdenk		initial stack and some data.
695c609719bSwdenk
696c609719bSwdenk
697c609719bSwdenk		XXX - this list needs to get updated!
698c609719bSwdenk
699c609719bSwdenk- Watchdog:
700c609719bSwdenk		CONFIG_WATCHDOG
701c609719bSwdenk		If this variable is defined, it enables watchdog
7027152b1d0Swdenk		support. There must be support in the platform specific
703c609719bSwdenk		code for a watchdog. For the 8xx and 8260 CPUs, the
704c609719bSwdenk		SIU Watchdog feature is enabled in the SYPCR
705c609719bSwdenk		register.
706c609719bSwdenk
707c1551ea8Sstroese- U-Boot Version:
708c1551ea8Sstroese		CONFIG_VERSION_VARIABLE
709c1551ea8Sstroese		If this variable is defined, an environment variable
710c1551ea8Sstroese		named "ver" is created by U-Boot showing the U-Boot
711c1551ea8Sstroese		version as printed by the "version" command.
712c1551ea8Sstroese		This variable is readonly.
713c1551ea8Sstroese
714c609719bSwdenk- Real-Time Clock:
715c609719bSwdenk
716c609719bSwdenk		When CFG_CMD_DATE is selected, the type of the RTC
717c609719bSwdenk		has to be selected, too. Define exactly one of the
718c609719bSwdenk		following options:
719c609719bSwdenk
720c609719bSwdenk		CONFIG_RTC_MPC8xx	- use internal RTC of MPC8xx
721c609719bSwdenk		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
722c609719bSwdenk		CONFIG_RTC_MC146818	- use MC146818 RTC
7231cb8e980Swdenk		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
724c609719bSwdenk		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
7257f70e853Swdenk		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
7263bac3513Swdenk		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
7274c0d4c3bSwdenk		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
728c609719bSwdenk
729b37c7e5eSwdenk		Note that if the RTC uses I2C, then the I2C interface
730b37c7e5eSwdenk		must also be configured. See I2C Support, below.
731b37c7e5eSwdenk
732c609719bSwdenk- Timestamp Support:
733c609719bSwdenk
734c609719bSwdenk		When CONFIG_TIMESTAMP is selected, the timestamp
735c609719bSwdenk		(date and time) of an image is printed by image
736c609719bSwdenk		commands like bootm or iminfo. This option is
737c609719bSwdenk		automatically enabled when you select CFG_CMD_DATE .
738c609719bSwdenk
739c609719bSwdenk- Partition Support:
740c609719bSwdenk		CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
741c609719bSwdenk		and/or CONFIG_ISO_PARTITION
742c609719bSwdenk
743c609719bSwdenk		If IDE or SCSI support	is  enabled  (CFG_CMD_IDE  or
744c609719bSwdenk		CFG_CMD_SCSI) you must configure support for at least
745c609719bSwdenk		one partition type as well.
746c609719bSwdenk
747c609719bSwdenk- IDE Reset method:
7484d13cbadSwdenk		CONFIG_IDE_RESET_ROUTINE - this is defined in several
7494d13cbadSwdenk		board configurations files but used nowhere!
750c609719bSwdenk
7514d13cbadSwdenk		CONFIG_IDE_RESET - is this is defined, IDE Reset will
7524d13cbadSwdenk		be performed by calling the function
7534d13cbadSwdenk			ide_set_reset(int reset)
7544d13cbadSwdenk		which has to be defined in a board specific file
755c609719bSwdenk
756c609719bSwdenk- ATAPI Support:
757c609719bSwdenk		CONFIG_ATAPI
758c609719bSwdenk
759c609719bSwdenk		Set this to enable ATAPI support.
760c609719bSwdenk
761c40b2956Swdenk- LBA48 Support
762c40b2956Swdenk		CONFIG_LBA48
763c40b2956Swdenk
764c40b2956Swdenk		Set this to enable support for disks larger than 137GB
765c40b2956Swdenk		Also look at CFG_64BIT_LBA ,CFG_64BIT_VSPRINTF and CFG_64BIT_STRTOUL
766c40b2956Swdenk		Whithout these , LBA48 support uses 32bit variables and will 'only'
767c40b2956Swdenk		support disks up to 2.1TB.
768c40b2956Swdenk
769c40b2956Swdenk		CFG_64BIT_LBA:
770c40b2956Swdenk			When enabled, makes the IDE subsystem use 64bit sector addresses.
771c40b2956Swdenk			Default is 32bit.
772c40b2956Swdenk
773c609719bSwdenk- SCSI Support:
774c609719bSwdenk		At the moment only there is only support for the
775c609719bSwdenk		SYM53C8XX SCSI controller; define
776c609719bSwdenk		CONFIG_SCSI_SYM53C8XX to enable it.
777c609719bSwdenk
778c609719bSwdenk		CFG_SCSI_MAX_LUN [8], CFG_SCSI_MAX_SCSI_ID [7] and
779c609719bSwdenk		CFG_SCSI_MAX_DEVICE [CFG_SCSI_MAX_SCSI_ID *
780c609719bSwdenk		CFG_SCSI_MAX_LUN] can be adjusted to define the
781c609719bSwdenk		maximum numbers of LUNs, SCSI ID's and target
782c609719bSwdenk		devices.
783c609719bSwdenk		CFG_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
784c609719bSwdenk
785c609719bSwdenk- NETWORK Support (PCI):
786682011ffSwdenk		CONFIG_E1000
787682011ffSwdenk		Support for Intel 8254x gigabit chips.
788682011ffSwdenk
789c609719bSwdenk		CONFIG_EEPRO100
790c609719bSwdenk		Support for Intel 82557/82559/82559ER chips.
791c609719bSwdenk		Optional CONFIG_EEPRO100_SROM_WRITE enables eeprom
792c609719bSwdenk		write routine for first time initialisation.
793c609719bSwdenk
794c609719bSwdenk		CONFIG_TULIP
795c609719bSwdenk		Support for Digital 2114x chips.
796c609719bSwdenk		Optional CONFIG_TULIP_SELECT_MEDIA for board specific
797c609719bSwdenk		modem chip initialisation (KS8761/QS6611).
798c609719bSwdenk
799c609719bSwdenk		CONFIG_NATSEMI
800c609719bSwdenk		Support for National dp83815 chips.
801c609719bSwdenk
802c609719bSwdenk		CONFIG_NS8382X
803c609719bSwdenk		Support for National dp8382[01] gigabit chips.
804c609719bSwdenk
80545219c46Swdenk- NETWORK Support (other):
80645219c46Swdenk
80745219c46Swdenk		CONFIG_DRIVER_LAN91C96
80845219c46Swdenk		Support for SMSC's LAN91C96 chips.
80945219c46Swdenk
81045219c46Swdenk			CONFIG_LAN91C96_BASE
81145219c46Swdenk			Define this to hold the physical address
81245219c46Swdenk			of the LAN91C96's I/O space
81345219c46Swdenk
81445219c46Swdenk			CONFIG_LAN91C96_USE_32_BIT
81545219c46Swdenk			Define this to enable 32 bit addressing
81645219c46Swdenk
817f39748aeSwdenk		CONFIG_DRIVER_SMC91111
818f39748aeSwdenk		Support for SMSC's LAN91C111 chip
819f39748aeSwdenk
820f39748aeSwdenk			CONFIG_SMC91111_BASE
821f39748aeSwdenk			Define this to hold the physical address
822f39748aeSwdenk			of the device (I/O space)
823f39748aeSwdenk
824f39748aeSwdenk			CONFIG_SMC_USE_32_BIT
825f39748aeSwdenk			Define this if data bus is 32 bits
826f39748aeSwdenk
827f39748aeSwdenk			CONFIG_SMC_USE_IOFUNCS
828f39748aeSwdenk			Define this to use i/o functions instead of macros
829f39748aeSwdenk			(some hardware wont work with macros)
830f39748aeSwdenk
831c609719bSwdenk- USB Support:
832c609719bSwdenk		At the moment only the UHCI host controller is
8334d13cbadSwdenk		supported (PIP405, MIP405, MPC5200); define
834c609719bSwdenk		CONFIG_USB_UHCI to enable it.
835c609719bSwdenk		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
83630d56faeSwdenk		and define CONFIG_USB_STORAGE to enable the USB
837c609719bSwdenk		storage devices.
838c609719bSwdenk		Note:
839c609719bSwdenk		Supported are USB Keyboards and USB Floppy drives
840c609719bSwdenk		(TEAC FD-05PUB).
8414d13cbadSwdenk		MPC5200 USB requires additional defines:
8424d13cbadSwdenk			CONFIG_USB_CLOCK
8434d13cbadSwdenk				for 528 MHz Clock: 0x0001bbbb
8444d13cbadSwdenk			CONFIG_USB_CONFIG
8454d13cbadSwdenk				for differential drivers: 0x00001000
8464d13cbadSwdenk				for single ended drivers: 0x00005000
8474d13cbadSwdenk
848c609719bSwdenk
84971f95118Swdenk- MMC Support:
85071f95118Swdenk		The MMC controller on the Intel PXA is supported. To
85171f95118Swdenk		enable this define CONFIG_MMC. The MMC can be
85271f95118Swdenk		accessed from the boot prompt by mapping the device
85371f95118Swdenk		to physical memory similar to flash. Command line is
85471f95118Swdenk		enabled with CFG_CMD_MMC. The MMC driver also works with
85571f95118Swdenk		the FAT fs. This is enabled with CFG_CMD_FAT.
85671f95118Swdenk
8576705d81eSwdenk- Journaling Flash filesystem support:
8586705d81eSwdenk		CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
8596705d81eSwdenk		CONFIG_JFFS2_NAND_DEV
8606705d81eSwdenk		Define these for a default partition on a NAND device
8616705d81eSwdenk
8626705d81eSwdenk		CFG_JFFS2_FIRST_SECTOR,
8636705d81eSwdenk		CFG_JFFS2_FIRST_BANK, CFG_JFFS2_NUM_BANKS
8646705d81eSwdenk		Define these for a default partition on a NOR device
8656705d81eSwdenk
8666705d81eSwdenk		CFG_JFFS_CUSTOM_PART
8676705d81eSwdenk		Define this to create an own partition. You have to provide a
8686705d81eSwdenk		function struct part_info* jffs2_part_info(int part_num)
8696705d81eSwdenk
8706705d81eSwdenk		If you define only one JFFS2 partition you may also want to
8716705d81eSwdenk		#define CFG_JFFS_SINGLE_PART	1
8726705d81eSwdenk		to disable the command chpart. This is the default when you
8736705d81eSwdenk		have not defined a custom partition
8746705d81eSwdenk
875c609719bSwdenk- Keyboard Support:
876c609719bSwdenk		CONFIG_ISA_KEYBOARD
877c609719bSwdenk
878c609719bSwdenk		Define this to enable standard (PC-Style) keyboard
879c609719bSwdenk		support
880c609719bSwdenk
881c609719bSwdenk		CONFIG_I8042_KBD
882c609719bSwdenk		Standard PC keyboard driver with US (is default) and
883c609719bSwdenk		GERMAN key layout (switch via environment 'keymap=de') support.
884c609719bSwdenk		Export function i8042_kbd_init, i8042_tstc and i8042_getc
885c609719bSwdenk		for cfb_console. Supports cursor blinking.
886c609719bSwdenk
887c609719bSwdenk- Video support:
888c609719bSwdenk		CONFIG_VIDEO
889c609719bSwdenk
890c609719bSwdenk		Define this to enable video support (for output to
891c609719bSwdenk		video).
892c609719bSwdenk
893c609719bSwdenk		CONFIG_VIDEO_CT69000
894c609719bSwdenk
895c609719bSwdenk		Enable Chips & Technologies 69000 Video chip
896c609719bSwdenk
897c609719bSwdenk		CONFIG_VIDEO_SMI_LYNXEM
898eeb1b77bSwdenk		Enable Silicon Motion SMI 712/710/810 Video chip. The
899eeb1b77bSwdenk		video output is selected via environment 'videoout'
900eeb1b77bSwdenk		(1 = LCD and 2 = CRT). If videoout is undefined, CRT is
901eeb1b77bSwdenk		assumed.
902c609719bSwdenk
903eeb1b77bSwdenk		For the CT69000 and SMI_LYNXEM drivers, videomode is
904eeb1b77bSwdenk		selected via environment 'videomode'. Two diferent ways
905eeb1b77bSwdenk		are possible:
906eeb1b77bSwdenk		- "videomode=num"   'num' is a standard LiLo mode numbers.
907eeb1b77bSwdenk		Following standard modes are supported	(* is default):
908eeb1b77bSwdenk
909eeb1b77bSwdenk		      Colors	640x480 800x600 1024x768 1152x864 1280x1024
910eeb1b77bSwdenk		-------------+---------------------------------------------
911eeb1b77bSwdenk		      8 bits |	0x301*	0x303	 0x305	  0x161	    0x307
912eeb1b77bSwdenk		     15 bits |	0x310	0x313	 0x316	  0x162	    0x319
913eeb1b77bSwdenk		     16 bits |	0x311	0x314	 0x317	  0x163	    0x31A
914eeb1b77bSwdenk		     24 bits |	0x312	0x315	 0x318	    ?	    0x31B
915eeb1b77bSwdenk		-------------+---------------------------------------------
916c609719bSwdenk		(i.e. setenv videomode 317; saveenv; reset;)
917c609719bSwdenk
918eeb1b77bSwdenk		- "videomode=bootargs" all the video parameters are parsed
919eeb1b77bSwdenk		from the bootargs. (See drivers/videomodes.c)
920eeb1b77bSwdenk
921eeb1b77bSwdenk
922a6c7ad2fSwdenk		CONFIG_VIDEO_SED13806
923a6c7ad2fSwdenk		Enable Epson SED13806 driver. This driver supports 8bpp
924a6c7ad2fSwdenk		and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
925a6c7ad2fSwdenk		or CONFIG_VIDEO_SED13806_16BPP
926a6c7ad2fSwdenk
927682011ffSwdenk- Keyboard Support:
928682011ffSwdenk		CONFIG_KEYBOARD
929682011ffSwdenk
930682011ffSwdenk		Define this to enable a custom keyboard support.
931682011ffSwdenk		This simply calls drv_keyboard_init() which must be
932682011ffSwdenk		defined in your board-specific files.
933682011ffSwdenk		The only board using this so far is RBC823.
934a6c7ad2fSwdenk
935c609719bSwdenk- LCD Support:	CONFIG_LCD
936c609719bSwdenk
937c609719bSwdenk		Define this to enable LCD support (for output to LCD
938c609719bSwdenk		display); also select one of the supported displays
939c609719bSwdenk		by defining one of these:
940c609719bSwdenk
941fd3103bbSwdenk		CONFIG_NEC_NL6448AC33:
942c609719bSwdenk
943fd3103bbSwdenk			NEC NL6448AC33-18. Active, color, single scan.
944c609719bSwdenk
945fd3103bbSwdenk		CONFIG_NEC_NL6448BC20
946c609719bSwdenk
947fd3103bbSwdenk			NEC NL6448BC20-08. 6.5", 640x480.
948fd3103bbSwdenk			Active, color, single scan.
949fd3103bbSwdenk
950fd3103bbSwdenk		CONFIG_NEC_NL6448BC33_54
951fd3103bbSwdenk
952fd3103bbSwdenk			NEC NL6448BC33-54. 10.4", 640x480.
953c609719bSwdenk			Active, color, single scan.
954c609719bSwdenk
955c609719bSwdenk		CONFIG_SHARP_16x9
956c609719bSwdenk
957c609719bSwdenk			Sharp 320x240. Active, color, single scan.
958c609719bSwdenk			It isn't 16x9, and I am not sure what it is.
959c609719bSwdenk
960c609719bSwdenk		CONFIG_SHARP_LQ64D341
961c609719bSwdenk
962c609719bSwdenk			Sharp LQ64D341 display, 640x480.
963c609719bSwdenk			Active, color, single scan.
964c609719bSwdenk
965c609719bSwdenk		CONFIG_HLD1045
966c609719bSwdenk
967c609719bSwdenk			HLD1045 display, 640x480.
968c609719bSwdenk			Active, color, single scan.
969c609719bSwdenk
970c609719bSwdenk		CONFIG_OPTREX_BW
971c609719bSwdenk
972c609719bSwdenk			Optrex	 CBL50840-2 NF-FW 99 22 M5
973c609719bSwdenk			or
974c609719bSwdenk			Hitachi	 LMG6912RPFC-00T
975c609719bSwdenk			or
976c609719bSwdenk			Hitachi	 SP14Q002
977c609719bSwdenk
978c609719bSwdenk			320x240. Black & white.
979c609719bSwdenk
980c609719bSwdenk		Normally display is black on white background; define
981c609719bSwdenk		CFG_WHITE_ON_BLACK to get it inverted.
982c609719bSwdenk
9837152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN
984d791b1dcSwdenk
985d791b1dcSwdenk		If this option is set, the environment is checked for
986d791b1dcSwdenk		a variable "splashimage". If found, the usual display
987d791b1dcSwdenk		of logo, copyright and system information on the LCD
988e94d2cd9Swdenk		is suppressed and the BMP image at the address
989d791b1dcSwdenk		specified in "splashimage" is loaded instead. The
990d791b1dcSwdenk		console is redirected to the "nulldev", too. This
991d791b1dcSwdenk		allows for a "silent" boot where a splash screen is
992d791b1dcSwdenk		loaded very quickly after power-on.
993d791b1dcSwdenk
99498f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
99598f4a3dfSStefan Roese
99698f4a3dfSStefan Roese		If this option is set, additionally to standard BMP
99798f4a3dfSStefan Roese		images, gzipped BMP images can be displayed via the
99898f4a3dfSStefan Roese		splashscreen support or the bmp command.
99998f4a3dfSStefan Roese
1000c29fdfc1Swdenk- Compression support:
1001c29fdfc1Swdenk		CONFIG_BZIP2
1002c29fdfc1Swdenk
1003c29fdfc1Swdenk		If this option is set, support for bzip2 compressed
1004c29fdfc1Swdenk		images is included. If not, only uncompressed and gzip
1005c29fdfc1Swdenk		compressed images are supported.
1006c29fdfc1Swdenk
1007c29fdfc1Swdenk		NOTE: the bzip2 algorithm requires a lot of RAM, so
1008c29fdfc1Swdenk		the malloc area (as defined by CFG_MALLOC_LEN) should
1009c29fdfc1Swdenk		be at least 4MB.
1010d791b1dcSwdenk
101117ea1177Swdenk- MII/PHY support:
101217ea1177Swdenk		CONFIG_PHY_ADDR
101317ea1177Swdenk
101417ea1177Swdenk		The address of PHY on MII bus.
101517ea1177Swdenk
101617ea1177Swdenk		CONFIG_PHY_CLOCK_FREQ (ppc4xx)
101717ea1177Swdenk
101817ea1177Swdenk		The clock frequency of the MII bus
101917ea1177Swdenk
102017ea1177Swdenk		CONFIG_PHY_GIGE
102117ea1177Swdenk
102217ea1177Swdenk		If this option is set, support for speed/duplex
102317ea1177Swdenk		detection of Gigabit PHY is included.
102417ea1177Swdenk
102517ea1177Swdenk		CONFIG_PHY_RESET_DELAY
102617ea1177Swdenk
102717ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
102817ea1177Swdenk		reset before any MII register access is possible.
102917ea1177Swdenk		For such PHY, set this option to the usec delay
103017ea1177Swdenk		required. (minimum 300usec for LXT971A)
103117ea1177Swdenk
103217ea1177Swdenk		CONFIG_PHY_CMD_DELAY (ppc4xx)
103317ea1177Swdenk
103417ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
103517ea1177Swdenk		command issued before MII status register can be read
103617ea1177Swdenk
1037c609719bSwdenk- Ethernet address:
1038c609719bSwdenk		CONFIG_ETHADDR
1039c609719bSwdenk		CONFIG_ETH2ADDR
1040c609719bSwdenk		CONFIG_ETH3ADDR
1041c609719bSwdenk
1042c609719bSwdenk		Define a default value for ethernet address to use
1043c609719bSwdenk		for the respective ethernet interface, in case this
1044c609719bSwdenk		is not determined automatically.
1045c609719bSwdenk
1046c609719bSwdenk- IP address:
1047c609719bSwdenk		CONFIG_IPADDR
1048c609719bSwdenk
1049c609719bSwdenk		Define a default value for the IP address to use for
1050c609719bSwdenk		the default ethernet interface, in case this is not
1051c609719bSwdenk		determined through e.g. bootp.
1052c609719bSwdenk
1053c609719bSwdenk- Server IP address:
1054c609719bSwdenk		CONFIG_SERVERIP
1055c609719bSwdenk
1056c609719bSwdenk		Defines a default value for theIP address of a TFTP
1057c609719bSwdenk		server to contact when using the "tftboot" command.
1058c609719bSwdenk
1059c609719bSwdenk- BOOTP Recovery Mode:
1060c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY
1061c609719bSwdenk
1062c609719bSwdenk		If you have many targets in a network that try to
1063c609719bSwdenk		boot using BOOTP, you may want to avoid that all
1064c609719bSwdenk		systems send out BOOTP requests at precisely the same
1065c609719bSwdenk		moment (which would happen for instance at recovery
1066c609719bSwdenk		from a power failure, when all systems will try to
1067c609719bSwdenk		boot, thus flooding the BOOTP server. Defining
1068c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1069c609719bSwdenk		inserted before sending out BOOTP requests. The
1070c609719bSwdenk		following delays are insterted then:
1071c609719bSwdenk
1072c609719bSwdenk		1st BOOTP request:	delay 0 ... 1 sec
1073c609719bSwdenk		2nd BOOTP request:	delay 0 ... 2 sec
1074c609719bSwdenk		3rd BOOTP request:	delay 0 ... 4 sec
1075c609719bSwdenk		4th and following
1076c609719bSwdenk		BOOTP requests:		delay 0 ... 8 sec
1077c609719bSwdenk
1078fe389a82Sstroese- DHCP Advanced Options:
1079fe389a82Sstroese		CONFIG_BOOTP_MASK
1080fe389a82Sstroese
1081fe389a82Sstroese		You can fine tune the DHCP functionality by adding
1082fe389a82Sstroese		these flags to the CONFIG_BOOTP_MASK define:
1083fe389a82Sstroese
1084fe389a82Sstroese		CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1085fe389a82Sstroese		serverip from a DHCP server, it is possible that more
1086fe389a82Sstroese		than one DNS serverip is offered to the client.
1087fe389a82Sstroese		If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1088fe389a82Sstroese		serverip will be stored in the additional environment
1089fe389a82Sstroese		variable "dnsip2". The first DNS serverip is always
1090fe389a82Sstroese		stored in the variable "dnsip", when CONFIG_BOOTP_DNS
1091fe389a82Sstroese		is added to the CONFIG_BOOTP_MASK.
1092fe389a82Sstroese
1093fe389a82Sstroese		CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1094fe389a82Sstroese		to do a dynamic update of a DNS server. To do this, they
1095fe389a82Sstroese		need the hostname of the DHCP requester.
1096fe389a82Sstroese		If CONFIG_BOOP_SEND_HOSTNAME is added to the
1097fe389a82Sstroese		CONFIG_BOOTP_MASK, the content of the "hostname"
1098fe389a82Sstroese		environment variable is passed as option 12 to
1099fe389a82Sstroese		the DHCP server.
1100fe389a82Sstroese
1101a3d991bdSwdenk - CDP Options:
1102a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID
1103a3d991bdSwdenk
1104a3d991bdSwdenk		The device id used in CDP trigger frames.
1105a3d991bdSwdenk
1106a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID_PREFIX
1107a3d991bdSwdenk
1108a3d991bdSwdenk		A two character string which is prefixed to the MAC address
1109a3d991bdSwdenk		of the device.
1110a3d991bdSwdenk
1111a3d991bdSwdenk		CONFIG_CDP_PORT_ID
1112a3d991bdSwdenk
1113a3d991bdSwdenk		A printf format string which contains the ascii name of
1114a3d991bdSwdenk		the port. Normally is set to "eth%d" which sets
1115a3d991bdSwdenk		eth0 for the first ethernet, eth1 for the second etc.
1116a3d991bdSwdenk
1117a3d991bdSwdenk		CONFIG_CDP_CAPABILITIES
1118a3d991bdSwdenk
1119a3d991bdSwdenk		A 32bit integer which indicates the device capabilities;
1120a3d991bdSwdenk		0x00000010 for a normal host which does not forwards.
1121a3d991bdSwdenk
1122a3d991bdSwdenk		CONFIG_CDP_VERSION
1123a3d991bdSwdenk
1124a3d991bdSwdenk		An ascii string containing the version of the software.
1125a3d991bdSwdenk
1126a3d991bdSwdenk		CONFIG_CDP_PLATFORM
1127a3d991bdSwdenk
1128a3d991bdSwdenk		An ascii string containing the name of the platform.
1129a3d991bdSwdenk
1130a3d991bdSwdenk		CONFIG_CDP_TRIGGER
1131a3d991bdSwdenk
1132a3d991bdSwdenk		A 32bit integer sent on the trigger.
1133a3d991bdSwdenk
1134a3d991bdSwdenk		CONFIG_CDP_POWER_CONSUMPTION
1135a3d991bdSwdenk
1136a3d991bdSwdenk		A 16bit integer containing the power consumption of the
1137a3d991bdSwdenk		device in .1 of milliwatts.
1138a3d991bdSwdenk
1139a3d991bdSwdenk		CONFIG_CDP_APPLIANCE_VLAN_TYPE
1140a3d991bdSwdenk
1141a3d991bdSwdenk		A byte containing the id of the VLAN.
1142a3d991bdSwdenk
1143c609719bSwdenk- Status LED:	CONFIG_STATUS_LED
1144c609719bSwdenk
1145c609719bSwdenk		Several configurations allow to display the current
1146c609719bSwdenk		status using a LED. For instance, the LED will blink
1147c609719bSwdenk		fast while running U-Boot code, stop blinking as
1148c609719bSwdenk		soon as a reply to a BOOTP request was received, and
1149c609719bSwdenk		start blinking slow once the Linux kernel is running
1150c609719bSwdenk		(supported by a status LED driver in the Linux
1151c609719bSwdenk		kernel). Defining CONFIG_STATUS_LED enables this
1152c609719bSwdenk		feature in U-Boot.
1153c609719bSwdenk
1154c609719bSwdenk- CAN Support:	CONFIG_CAN_DRIVER
1155c609719bSwdenk
1156c609719bSwdenk		Defining CONFIG_CAN_DRIVER enables CAN driver support
1157c609719bSwdenk		on those systems that support this (optional)
1158c609719bSwdenk		feature, like the TQM8xxL modules.
1159c609719bSwdenk
1160c609719bSwdenk- I2C Support:	CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1161c609719bSwdenk
1162b37c7e5eSwdenk		These enable I2C serial bus commands. Defining either of
1163b37c7e5eSwdenk		(but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
1164b37c7e5eSwdenk		include the appropriate I2C driver for the selected cpu.
1165c609719bSwdenk
1166b37c7e5eSwdenk		This will allow you to use i2c commands at the u-boot
1167b37c7e5eSwdenk		command line (as long as you set CFG_CMD_I2C in
1168b37c7e5eSwdenk		CONFIG_COMMANDS) and communicate with i2c based realtime
1169b37c7e5eSwdenk		clock chips. See common/cmd_i2c.c for a description of the
1170c609719bSwdenk		command line interface.
1171c609719bSwdenk
1172b37c7e5eSwdenk		CONFIG_HARD_I2C selects the CPM hardware driver for I2C.
1173c609719bSwdenk
1174b37c7e5eSwdenk		CONFIG_SOFT_I2C configures u-boot to use a software (aka
1175b37c7e5eSwdenk		bit-banging) driver instead of CPM or similar hardware
1176b37c7e5eSwdenk		support for I2C.
1177c609719bSwdenk
1178b37c7e5eSwdenk		There are several other quantities that must also be
1179b37c7e5eSwdenk		defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
1180c609719bSwdenk
1181b37c7e5eSwdenk		In both cases you will need to define CFG_I2C_SPEED
1182b37c7e5eSwdenk		to be the frequency (in Hz) at which you wish your i2c bus
1183b37c7e5eSwdenk		to run and CFG_I2C_SLAVE to be the address of this node (ie
1184b37c7e5eSwdenk		the cpu's i2c node address).
1185c609719bSwdenk
1186b37c7e5eSwdenk		Now, the u-boot i2c code for the mpc8xx (cpu/mpc8xx/i2c.c)
1187b37c7e5eSwdenk		sets the cpu up as a master node and so its address should
1188b37c7e5eSwdenk		therefore be cleared to 0 (See, eg, MPC823e User's Manual
1189b37c7e5eSwdenk		p.16-473). So, set CFG_I2C_SLAVE to 0.
1190b37c7e5eSwdenk
1191b37c7e5eSwdenk		That's all that's required for CONFIG_HARD_I2C.
1192b37c7e5eSwdenk
1193b37c7e5eSwdenk		If you use the software i2c interface (CONFIG_SOFT_I2C)
1194b37c7e5eSwdenk		then the following macros need to be defined (examples are
1195b37c7e5eSwdenk		from include/configs/lwmon.h):
1196c609719bSwdenk
1197c609719bSwdenk		I2C_INIT
1198c609719bSwdenk
1199b37c7e5eSwdenk		(Optional). Any commands necessary to enable the I2C
1200c609719bSwdenk		controller or configure ports.
1201c609719bSwdenk
1202b37c7e5eSwdenk		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
1203b37c7e5eSwdenk
1204c609719bSwdenk		I2C_PORT
1205c609719bSwdenk
1206c609719bSwdenk		(Only for MPC8260 CPU). The I/O port to use (the code
1207c609719bSwdenk		assumes both bits are on the same port). Valid values
1208c609719bSwdenk		are 0..3 for ports A..D.
1209c609719bSwdenk
1210c609719bSwdenk		I2C_ACTIVE
1211c609719bSwdenk
1212c609719bSwdenk		The code necessary to make the I2C data line active
1213c609719bSwdenk		(driven).  If the data line is open collector, this
1214c609719bSwdenk		define can be null.
1215c609719bSwdenk
1216b37c7e5eSwdenk		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
1217b37c7e5eSwdenk
1218c609719bSwdenk		I2C_TRISTATE
1219c609719bSwdenk
1220c609719bSwdenk		The code necessary to make the I2C data line tri-stated
1221c609719bSwdenk		(inactive).  If the data line is open collector, this
1222c609719bSwdenk		define can be null.
1223c609719bSwdenk
1224b37c7e5eSwdenk		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1225b37c7e5eSwdenk
1226c609719bSwdenk		I2C_READ
1227c609719bSwdenk
1228c609719bSwdenk		Code that returns TRUE if the I2C data line is high,
1229c609719bSwdenk		FALSE if it is low.
1230c609719bSwdenk
1231b37c7e5eSwdenk		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1232b37c7e5eSwdenk
1233c609719bSwdenk		I2C_SDA(bit)
1234c609719bSwdenk
1235c609719bSwdenk		If <bit> is TRUE, sets the I2C data line high. If it
1236c609719bSwdenk		is FALSE, it clears it (low).
1237c609719bSwdenk
1238b37c7e5eSwdenk		eg: #define I2C_SDA(bit) \
1239b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
1240b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
1241b37c7e5eSwdenk
1242c609719bSwdenk		I2C_SCL(bit)
1243c609719bSwdenk
1244c609719bSwdenk		If <bit> is TRUE, sets the I2C clock line high. If it
1245c609719bSwdenk		is FALSE, it clears it (low).
1246c609719bSwdenk
1247b37c7e5eSwdenk		eg: #define I2C_SCL(bit) \
1248b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
1249b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
1250b37c7e5eSwdenk
1251c609719bSwdenk		I2C_DELAY
1252c609719bSwdenk
1253c609719bSwdenk		This delay is invoked four times per clock cycle so this
1254c609719bSwdenk		controls the rate of data transfer.  The data rate thus
1255b37c7e5eSwdenk		is 1 / (I2C_DELAY * 4). Often defined to be something
1256b37c7e5eSwdenk		like:
1257b37c7e5eSwdenk
1258b37c7e5eSwdenk		#define I2C_DELAY  udelay(2)
1259c609719bSwdenk
126047cd00faSwdenk		CFG_I2C_INIT_BOARD
126147cd00faSwdenk
126247cd00faSwdenk		When a board is reset during an i2c bus transfer
126347cd00faSwdenk		chips might think that the current transfer is still
126447cd00faSwdenk		in progress. On some boards it is possible to access
126547cd00faSwdenk		the i2c SCLK line directly, either by using the
126647cd00faSwdenk		processor pin as a GPIO or by having a second pin
126747cd00faSwdenk		connected to the bus. If this option is defined a
126847cd00faSwdenk		custom i2c_init_board() routine in boards/xxx/board.c
126947cd00faSwdenk		is run early in the boot sequence.
127047cd00faSwdenk
127117ea1177Swdenk		CONFIG_I2CFAST (PPC405GP|PPC405EP only)
127217ea1177Swdenk
127317ea1177Swdenk		This option enables configuration of bi_iic_fast[] flags
127417ea1177Swdenk		in u-boot bd_info structure based on u-boot environment
127517ea1177Swdenk		variable "i2cfast". (see also i2cfast)
127617ea1177Swdenk
1277c609719bSwdenk- SPI Support:	CONFIG_SPI
1278c609719bSwdenk
1279c609719bSwdenk		Enables SPI driver (so far only tested with
1280c609719bSwdenk		SPI EEPROM, also an instance works with Crystal A/D and
1281c609719bSwdenk		D/As on the SACSng board)
1282c609719bSwdenk
1283c609719bSwdenk		CONFIG_SPI_X
1284c609719bSwdenk
1285c609719bSwdenk		Enables extended (16-bit) SPI EEPROM addressing.
1286c609719bSwdenk		(symmetrical to CONFIG_I2C_X)
1287c609719bSwdenk
1288c609719bSwdenk		CONFIG_SOFT_SPI
1289c609719bSwdenk
1290c609719bSwdenk		Enables a software (bit-bang) SPI driver rather than
1291c609719bSwdenk		using hardware support. This is a general purpose
1292c609719bSwdenk		driver that only requires three general I/O port pins
1293c609719bSwdenk		(two outputs, one input) to function. If this is
1294c609719bSwdenk		defined, the board configuration must define several
1295c609719bSwdenk		SPI configuration items (port pins to use, etc). For
1296c609719bSwdenk		an example, see include/configs/sacsng.h.
1297c609719bSwdenk
1298c609719bSwdenk- FPGA Support: CONFIG_FPGA_COUNT
1299c609719bSwdenk
1300c609719bSwdenk		Specify the number of FPGA devices to support.
1301c609719bSwdenk
1302c609719bSwdenk		CONFIG_FPGA
1303c609719bSwdenk
1304c609719bSwdenk		Used to specify the types of FPGA devices.  For example,
1305c609719bSwdenk		#define CONFIG_FPGA  CFG_XILINX_VIRTEX2
1306c609719bSwdenk
1307c609719bSwdenk		CFG_FPGA_PROG_FEEDBACK
1308c609719bSwdenk
1309c609719bSwdenk		Enable printing of hash marks during FPGA configuration.
1310c609719bSwdenk
1311c609719bSwdenk		CFG_FPGA_CHECK_BUSY
1312c609719bSwdenk
1313c609719bSwdenk		Enable checks on FPGA configuration interface busy
1314c609719bSwdenk		status by the configuration function. This option
1315c609719bSwdenk		will require a board or device specific function to
1316c609719bSwdenk		be written.
1317c609719bSwdenk
1318c609719bSwdenk		CONFIG_FPGA_DELAY
1319c609719bSwdenk
1320c609719bSwdenk		If defined, a function that provides delays in the FPGA
1321c609719bSwdenk		configuration driver.
1322c609719bSwdenk
1323c609719bSwdenk		CFG_FPGA_CHECK_CTRLC
1324c609719bSwdenk		Allow Control-C to interrupt FPGA configuration
1325c609719bSwdenk
1326c609719bSwdenk		CFG_FPGA_CHECK_ERROR
1327c609719bSwdenk
1328c609719bSwdenk		Check for configuration errors during FPGA bitfile
1329c609719bSwdenk		loading. For example, abort during Virtex II
1330c609719bSwdenk		configuration if the INIT_B line goes low (which
1331c609719bSwdenk		indicated a CRC error).
1332c609719bSwdenk
1333c609719bSwdenk		CFG_FPGA_WAIT_INIT
1334c609719bSwdenk
1335c609719bSwdenk		Maximum time to wait for the INIT_B line to deassert
1336c609719bSwdenk		after PROB_B has been deasserted during a Virtex II
1337c609719bSwdenk		FPGA configuration sequence. The default time is 500
1338c609719bSwdenk		mS.
1339c609719bSwdenk
1340c609719bSwdenk		CFG_FPGA_WAIT_BUSY
1341c609719bSwdenk
1342c609719bSwdenk		Maximum time to wait for BUSY to deassert during
1343c609719bSwdenk		Virtex II FPGA configuration. The default is 5 mS.
1344c609719bSwdenk
1345c609719bSwdenk		CFG_FPGA_WAIT_CONFIG
1346c609719bSwdenk
1347c609719bSwdenk		Time to wait after FPGA configuration. The default is
1348c609719bSwdenk		200 mS.
1349c609719bSwdenk
1350c609719bSwdenk- Configuration Management:
1351c609719bSwdenk		CONFIG_IDENT_STRING
1352c609719bSwdenk
1353c609719bSwdenk		If defined, this string will be added to the U-Boot
1354c609719bSwdenk		version information (U_BOOT_VERSION)
1355c609719bSwdenk
1356c609719bSwdenk- Vendor Parameter Protection:
1357c609719bSwdenk
1358c609719bSwdenk		U-Boot considers the values of the environment
1359c609719bSwdenk		variables "serial#" (Board Serial Number) and
13607152b1d0Swdenk		"ethaddr" (Ethernet Address) to be parameters that
1361c609719bSwdenk		are set once by the board vendor / manufacturer, and
1362c609719bSwdenk		protects these variables from casual modification by
1363c609719bSwdenk		the user. Once set, these variables are read-only,
1364c609719bSwdenk		and write or delete attempts are rejected. You can
1365c609719bSwdenk		change this behviour:
1366c609719bSwdenk
1367c609719bSwdenk		If CONFIG_ENV_OVERWRITE is #defined in your config
1368c609719bSwdenk		file, the write protection for vendor parameters is
136947cd00faSwdenk		completely disabled. Anybody can change or delete
1370c609719bSwdenk		these parameters.
1371c609719bSwdenk
1372c609719bSwdenk		Alternatively, if you #define _both_ CONFIG_ETHADDR
1373c609719bSwdenk		_and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
1374c609719bSwdenk		ethernet address is installed in the environment,
1375c609719bSwdenk		which can be changed exactly ONCE by the user. [The
1376c609719bSwdenk		serial# is unaffected by this, i. e. it remains
1377c609719bSwdenk		read-only.]
1378c609719bSwdenk
1379c609719bSwdenk- Protected RAM:
1380c609719bSwdenk		CONFIG_PRAM
1381c609719bSwdenk
1382c609719bSwdenk		Define this variable to enable the reservation of
1383c609719bSwdenk		"protected RAM", i. e. RAM which is not overwritten
1384c609719bSwdenk		by U-Boot. Define CONFIG_PRAM to hold the number of
1385c609719bSwdenk		kB you want to reserve for pRAM. You can overwrite
1386c609719bSwdenk		this default value by defining an environment
1387c609719bSwdenk		variable "pram" to the number of kB you want to
1388c609719bSwdenk		reserve. Note that the board info structure will
1389c609719bSwdenk		still show the full amount of RAM. If pRAM is
1390c609719bSwdenk		reserved, a new environment variable "mem" will
1391c609719bSwdenk		automatically be defined to hold the amount of
1392c609719bSwdenk		remaining RAM in a form that can be passed as boot
1393c609719bSwdenk		argument to Linux, for instance like that:
1394c609719bSwdenk
1395fe126d8bSWolfgang Denk			setenv bootargs ... mem=\${mem}
1396c609719bSwdenk			saveenv
1397c609719bSwdenk
1398c609719bSwdenk		This way you can tell Linux not to use this memory,
1399c609719bSwdenk		either, which results in a memory region that will
1400c609719bSwdenk		not be affected by reboots.
1401c609719bSwdenk
1402c609719bSwdenk		*WARNING* If your board configuration uses automatic
1403c609719bSwdenk		detection of the RAM size, you must make sure that
1404c609719bSwdenk		this memory test is non-destructive. So far, the
1405c609719bSwdenk		following board configurations are known to be
1406c609719bSwdenk		"pRAM-clean":
1407c609719bSwdenk
1408c609719bSwdenk			ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
1409c609719bSwdenk			HERMES, IP860, RPXlite, LWMON, LANTEC,
1410c609719bSwdenk			PCU_E, FLAGADM, TQM8260
1411c609719bSwdenk
1412c609719bSwdenk- Error Recovery:
1413c609719bSwdenk		CONFIG_PANIC_HANG
1414c609719bSwdenk
1415c609719bSwdenk		Define this variable to stop the system in case of a
1416c609719bSwdenk		fatal error, so that you have to reset it manually.
1417c609719bSwdenk		This is probably NOT a good idea for an embedded
1418c609719bSwdenk		system where you want to system to reboot
1419c609719bSwdenk		automatically as fast as possible, but it may be
1420c609719bSwdenk		useful during development since you can try to debug
1421c609719bSwdenk		the conditions that lead to the situation.
1422c609719bSwdenk
1423c609719bSwdenk		CONFIG_NET_RETRY_COUNT
1424c609719bSwdenk
1425c609719bSwdenk		This variable defines the number of retries for
1426c609719bSwdenk		network operations like ARP, RARP, TFTP, or BOOTP
1427c609719bSwdenk		before giving up the operation. If not defined, a
1428c609719bSwdenk		default value of 5 is used.
1429c609719bSwdenk
1430c609719bSwdenk- Command Interpreter:
143104a85b3bSwdenk		CFG_AUTO_COMPLETE
143204a85b3bSwdenk
143304a85b3bSwdenk		Enable auto completion of commands using TAB.
143404a85b3bSwdenk
1435c609719bSwdenk		CFG_HUSH_PARSER
1436c609719bSwdenk
1437c609719bSwdenk		Define this variable to enable the "hush" shell (from
1438c609719bSwdenk		Busybox) as command line interpreter, thus enabling
1439c609719bSwdenk		powerful command line syntax like
1440c609719bSwdenk		if...then...else...fi conditionals or `&&' and '||'
1441c609719bSwdenk		constructs ("shell scripts").
1442c609719bSwdenk
1443c609719bSwdenk		If undefined, you get the old, much simpler behaviour
1444c609719bSwdenk		with a somewhat smaller memory footprint.
1445c609719bSwdenk
1446c609719bSwdenk
1447c609719bSwdenk		CFG_PROMPT_HUSH_PS2
1448c609719bSwdenk
1449c609719bSwdenk		This defines the secondary prompt string, which is
1450c609719bSwdenk		printed when the command interpreter needs more input
1451c609719bSwdenk		to complete a command. Usually "> ".
1452c609719bSwdenk
1453c609719bSwdenk	Note:
1454c609719bSwdenk
1455c609719bSwdenk		In the current implementation, the local variables
1456c609719bSwdenk		space and global environment variables space are
1457c609719bSwdenk		separated. Local variables are those you define by
14583b57fe0aSwdenk		simply typing `name=value'. To access a local
1459c609719bSwdenk		variable later on, you have write `$name' or
14603b57fe0aSwdenk		`${name}'; to execute the contents of a variable
14613b57fe0aSwdenk		directly type `$name' at the command prompt.
1462c609719bSwdenk
1463c609719bSwdenk		Global environment variables are those you use
1464c609719bSwdenk		setenv/printenv to work with. To run a command stored
1465c609719bSwdenk		in such a variable, you need to use the run command,
1466c609719bSwdenk		and you must not use the '$' sign to access them.
1467c609719bSwdenk
1468c609719bSwdenk		To store commands and special characters in a
1469c609719bSwdenk		variable, please use double quotation marks
1470c609719bSwdenk		surrounding the whole text of the variable, instead
1471c609719bSwdenk		of the backslashes before semicolons and special
1472c609719bSwdenk		symbols.
1473c609719bSwdenk
1474a8c7c708Swdenk- Default Environment:
1475c609719bSwdenk		CONFIG_EXTRA_ENV_SETTINGS
1476c609719bSwdenk
1477c609719bSwdenk		Define this to contain any number of null terminated
1478c609719bSwdenk		strings (variable = value pairs) that will be part of
14797152b1d0Swdenk		the default environment compiled into the boot image.
14802262cfeeSwdenk
1481c609719bSwdenk		For example, place something like this in your
1482c609719bSwdenk		board's config file:
1483c609719bSwdenk
1484c609719bSwdenk		#define CONFIG_EXTRA_ENV_SETTINGS \
1485c609719bSwdenk			"myvar1=value1\0" \
1486c609719bSwdenk			"myvar2=value2\0"
1487c609719bSwdenk
1488c609719bSwdenk		Warning: This method is based on knowledge about the
1489c609719bSwdenk		internal format how the environment is stored by the
14902262cfeeSwdenk		U-Boot code. This is NOT an official, exported
1491c609719bSwdenk		interface! Although it is unlikely that this format
14927152b1d0Swdenk		will change soon, there is no guarantee either.
1493c609719bSwdenk		You better know what you are doing here.
1494c609719bSwdenk
1495c609719bSwdenk		Note: overly (ab)use of the default environment is
1496c609719bSwdenk		discouraged. Make sure to check other ways to preset
1497c609719bSwdenk		the environment like the autoscript function or the
1498c609719bSwdenk		boot command first.
1499c609719bSwdenk
1500a8c7c708Swdenk- DataFlash Support:
15012abbe075Swdenk		CONFIG_HAS_DATAFLASH
15022abbe075Swdenk
15032abbe075Swdenk		Defining this option enables DataFlash features and
15042abbe075Swdenk		allows to read/write in Dataflash via the standard
15052abbe075Swdenk		commands cp, md...
15062abbe075Swdenk
15073f85ce27Swdenk- SystemACE Support:
15083f85ce27Swdenk		CONFIG_SYSTEMACE
15093f85ce27Swdenk
15103f85ce27Swdenk		Adding this option adds support for Xilinx SystemACE
15113f85ce27Swdenk		chips attached via some sort of local bus. The address
15123f85ce27Swdenk		of the chip must alsh be defined in the
15133f85ce27Swdenk		CFG_SYSTEMACE_BASE macro. For example:
15143f85ce27Swdenk
15153f85ce27Swdenk		#define CONFIG_SYSTEMACE
15163f85ce27Swdenk		#define CFG_SYSTEMACE_BASE 0xf0000000
15173f85ce27Swdenk
15183f85ce27Swdenk		When SystemACE support is added, the "ace" device type
15193f85ce27Swdenk		becomes available to the fat commands, i.e. fatls.
15203f85ce27Swdenk
1521ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port:
1522ecb0ccd9SWolfgang Denk		CONFIG_TFTP_PORT
1523ecb0ccd9SWolfgang Denk
152428cb9375SWolfgang Denk		If this is defined, the environment variable tftpsrcp
1525ecb0ccd9SWolfgang Denk		is used to supply the TFTP UDP source port value.
152628cb9375SWolfgang Denk		If tftpsrcp isn't defined, the normal pseudo-random port
1527ecb0ccd9SWolfgang Denk		number generator is used.
1528ecb0ccd9SWolfgang Denk
152928cb9375SWolfgang Denk		Also, the environment variable tftpdstp is used to supply
153028cb9375SWolfgang Denk		the TFTP UDP destination port value.  If tftpdstp isn't
153128cb9375SWolfgang Denk		defined, the normal port 69 is used.
153228cb9375SWolfgang Denk
153328cb9375SWolfgang Denk		The purpose for tftpsrcp is to allow a TFTP server to
1534ecb0ccd9SWolfgang Denk		blindly start the TFTP transfer using the pre-configured
1535ecb0ccd9SWolfgang Denk		target IP address and UDP port. This has the effect of
1536ecb0ccd9SWolfgang Denk		"punching through" the (Windows XP) firewall, allowing
1537ecb0ccd9SWolfgang Denk		the remainder of the TFTP transfer to proceed normally.
1538ecb0ccd9SWolfgang Denk		A better solution is to properly configure the firewall,
1539ecb0ccd9SWolfgang Denk		but sometimes that is not allowed.
1540ecb0ccd9SWolfgang Denk
1541a8c7c708Swdenk- Show boot progress:
1542c609719bSwdenk		CONFIG_SHOW_BOOT_PROGRESS
1543c609719bSwdenk
1544c609719bSwdenk		Defining this option allows to add some board-
1545c609719bSwdenk		specific code (calling a user-provided function
1546c609719bSwdenk		"show_boot_progress(int)") that enables you to show
1547c609719bSwdenk		the system's boot progress on some display (for
1548c609719bSwdenk		example, some LED's) on your board. At the moment,
1549c609719bSwdenk		the following checkpoints are implemented:
1550c609719bSwdenk
1551c609719bSwdenk  Arg	Where			When
1552c609719bSwdenk    1	common/cmd_bootm.c	before attempting to boot an image
1553c609719bSwdenk   -1	common/cmd_bootm.c	Image header has bad	 magic number
1554c609719bSwdenk    2	common/cmd_bootm.c	Image header has correct magic number
1555c609719bSwdenk   -2	common/cmd_bootm.c	Image header has bad	 checksum
1556c609719bSwdenk    3	common/cmd_bootm.c	Image header has correct checksum
1557c609719bSwdenk   -3	common/cmd_bootm.c	Image data   has bad	 checksum
1558c609719bSwdenk    4	common/cmd_bootm.c	Image data   has correct checksum
1559c609719bSwdenk   -4	common/cmd_bootm.c	Image is for unsupported architecture
1560c609719bSwdenk    5	common/cmd_bootm.c	Architecture check OK
1561c609719bSwdenk   -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi, standalone)
1562c609719bSwdenk    6	common/cmd_bootm.c	Image Type check OK
1563c609719bSwdenk   -6	common/cmd_bootm.c	gunzip uncompression error
1564c609719bSwdenk   -7	common/cmd_bootm.c	Unimplemented compression type
1565c609719bSwdenk    7	common/cmd_bootm.c	Uncompression OK
1566c609719bSwdenk   -8	common/cmd_bootm.c	Wrong Image Type (not kernel, multi, standalone)
1567c609719bSwdenk    8	common/cmd_bootm.c	Image Type check OK
1568c609719bSwdenk   -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
1569c609719bSwdenk    9	common/cmd_bootm.c	Start initial ramdisk verification
1570c609719bSwdenk  -10	common/cmd_bootm.c	Ramdisk header has bad	   magic number
1571c609719bSwdenk  -11	common/cmd_bootm.c	Ramdisk header has bad	   checksum
1572c609719bSwdenk   10	common/cmd_bootm.c	Ramdisk header is OK
1573c609719bSwdenk  -12	common/cmd_bootm.c	Ramdisk data   has bad	   checksum
1574c609719bSwdenk   11	common/cmd_bootm.c	Ramdisk data   has correct checksum
1575c609719bSwdenk   12	common/cmd_bootm.c	Ramdisk verification complete, start loading
1576c609719bSwdenk  -13	common/cmd_bootm.c	Wrong Image Type (not PPC Linux Ramdisk)
1577c609719bSwdenk   13	common/cmd_bootm.c	Start multifile image verification
1578c609719bSwdenk   14	common/cmd_bootm.c	No initial ramdisk, no multifile, continue.
1579c609719bSwdenk   15	common/cmd_bootm.c	All preparation done, transferring control to OS
1580c609719bSwdenk
158163e73c9aSwdenk  -30	lib_ppc/board.c		Fatal error, hang the system
158263e73c9aSwdenk  -31	post/post.c		POST test failed, detected by post_output_backlog()
158363e73c9aSwdenk  -32	post/post.c		POST test failed, detected by post_run_single()
158463e73c9aSwdenk
1585c609719bSwdenk   -1	common/cmd_doc.c	Bad usage of "doc" command
1586c609719bSwdenk   -1	common/cmd_doc.c	No boot device
1587c609719bSwdenk   -1	common/cmd_doc.c	Unknown Chip ID on boot device
1588c609719bSwdenk   -1	common/cmd_doc.c	Read Error on boot device
1589c609719bSwdenk   -1	common/cmd_doc.c	Image header has bad magic number
1590c609719bSwdenk
1591c609719bSwdenk   -1	common/cmd_ide.c	Bad usage of "ide" command
1592c609719bSwdenk   -1	common/cmd_ide.c	No boot device
1593c609719bSwdenk   -1	common/cmd_ide.c	Unknown boot device
1594c609719bSwdenk   -1	common/cmd_ide.c	Unknown partition table
1595c609719bSwdenk   -1	common/cmd_ide.c	Invalid partition type
1596c609719bSwdenk   -1	common/cmd_ide.c	Read Error on boot device
1597c609719bSwdenk   -1	common/cmd_ide.c	Image header has bad magic number
1598c609719bSwdenk
1599206c60cbSwdenk   -1	common/cmd_nand.c	Bad usage of "nand" command
1600206c60cbSwdenk   -1	common/cmd_nand.c	No boot device
1601206c60cbSwdenk   -1	common/cmd_nand.c	Unknown Chip ID on boot device
1602206c60cbSwdenk   -1	common/cmd_nand.c	Read Error on boot device
1603206c60cbSwdenk   -1	common/cmd_nand.c	Image header has bad magic number
1604206c60cbSwdenk
1605206c60cbSwdenk   -1	common/env_common.c	Environment has a bad CRC, using default
1606c609719bSwdenk
1607c609719bSwdenk
1608c609719bSwdenkModem Support:
1609c609719bSwdenk--------------
1610c609719bSwdenk
161185ec0bccSwdenk[so far only for SMDK2400 and TRAB boards]
1612c609719bSwdenk
1613c609719bSwdenk- Modem support endable:
1614c609719bSwdenk		CONFIG_MODEM_SUPPORT
1615c609719bSwdenk
1616c609719bSwdenk- RTS/CTS Flow control enable:
1617c609719bSwdenk		CONFIG_HWFLOW
1618c609719bSwdenk
1619c609719bSwdenk- Modem debug support:
1620c609719bSwdenk		CONFIG_MODEM_SUPPORT_DEBUG
1621c609719bSwdenk
1622c609719bSwdenk		Enables debugging stuff (char screen[1024], dbg())
1623c609719bSwdenk		for modem support. Useful only with BDI2000.
1624c609719bSwdenk
1625a8c7c708Swdenk- Interrupt support (PPC):
1626a8c7c708Swdenk
1627a8c7c708Swdenk		There are common interrupt_init() and timer_interrupt()
1628a8c7c708Swdenk		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
1629a8c7c708Swdenk		for cpu specific initialization. interrupt_init_cpu()
1630a8c7c708Swdenk		should set decrementer_count to appropriate value. If
1631a8c7c708Swdenk		cpu resets decrementer automatically after interrupt
1632a8c7c708Swdenk		(ppc4xx) it should set decrementer_count to zero.
1633a8c7c708Swdenk		timer_interrupt() calls timer_interrupt_cpu() for cpu
1634a8c7c708Swdenk		specific handling. If board has watchdog / status_led
1635a8c7c708Swdenk		/ other_activity_monitor it works automatically from
1636a8c7c708Swdenk		general timer_interrupt().
1637a8c7c708Swdenk
1638c609719bSwdenk- General:
1639c609719bSwdenk
1640c609719bSwdenk		In the target system modem support is enabled when a
1641c609719bSwdenk		specific key (key combination) is pressed during
1642c609719bSwdenk		power-on. Otherwise U-Boot will boot normally
1643c609719bSwdenk		(autoboot). The key_pressed() fuction is called from
1644c609719bSwdenk		board_init(). Currently key_pressed() is a dummy
1645c609719bSwdenk		function, returning 1 and thus enabling modem
1646c609719bSwdenk		initialization.
1647c609719bSwdenk
1648c609719bSwdenk		If there are no modem init strings in the
1649c609719bSwdenk		environment, U-Boot proceed to autoboot; the
1650c609719bSwdenk		previous output (banner, info printfs) will be
1651c609719bSwdenk		supressed, though.
1652c609719bSwdenk
1653c609719bSwdenk		See also: doc/README.Modem
1654c609719bSwdenk
1655c609719bSwdenk
1656c609719bSwdenkConfiguration Settings:
1657c609719bSwdenk-----------------------
1658c609719bSwdenk
1659c609719bSwdenk- CFG_LONGHELP: Defined when you want long help messages included;
1660c609719bSwdenk		undefine this when you're short of memory.
1661c609719bSwdenk
1662c609719bSwdenk- CFG_PROMPT:	This is what U-Boot prints on the console to
1663c609719bSwdenk		prompt for user input.
1664c609719bSwdenk
1665c609719bSwdenk- CFG_CBSIZE:	Buffer size for input from the Console
1666c609719bSwdenk
1667c609719bSwdenk- CFG_PBSIZE:	Buffer size for Console output
1668c609719bSwdenk
1669c609719bSwdenk- CFG_MAXARGS:	max. Number of arguments accepted for monitor commands
1670c609719bSwdenk
1671c609719bSwdenk- CFG_BARGSIZE: Buffer size for Boot Arguments which are passed to
1672c609719bSwdenk		the application (usually a Linux kernel) when it is
1673c609719bSwdenk		booted
1674c609719bSwdenk
1675c609719bSwdenk- CFG_BAUDRATE_TABLE:
1676c609719bSwdenk		List of legal baudrate settings for this board.
1677c609719bSwdenk
1678c609719bSwdenk- CFG_CONSOLE_INFO_QUIET
1679c609719bSwdenk		Suppress display of console information at boot.
1680c609719bSwdenk
1681c609719bSwdenk- CFG_CONSOLE_IS_IN_ENV
1682c609719bSwdenk		If the board specific function
1683c609719bSwdenk			extern int overwrite_console (void);
1684c609719bSwdenk		returns 1, the stdin, stderr and stdout are switched to the
1685c609719bSwdenk		serial port, else the settings in the environment are used.
1686c609719bSwdenk
1687c609719bSwdenk- CFG_CONSOLE_OVERWRITE_ROUTINE
1688c609719bSwdenk		Enable the call to overwrite_console().
1689c609719bSwdenk
1690c609719bSwdenk- CFG_CONSOLE_ENV_OVERWRITE
1691c609719bSwdenk		Enable overwrite of previous console environment settings.
1692c609719bSwdenk
1693c609719bSwdenk- CFG_MEMTEST_START, CFG_MEMTEST_END:
1694c609719bSwdenk		Begin and End addresses of the area used by the
1695c609719bSwdenk		simple memory test.
1696c609719bSwdenk
1697c609719bSwdenk- CFG_ALT_MEMTEST:
1698c609719bSwdenk		Enable an alternate, more extensive memory test.
1699c609719bSwdenk
17005f535fe1Swdenk- CFG_MEMTEST_SCRATCH:
17015f535fe1Swdenk		Scratch address used by the alternate memory test
17025f535fe1Swdenk		You only need to set this if address zero isn't writeable
17035f535fe1Swdenk
1704c609719bSwdenk- CFG_TFTP_LOADADDR:
1705c609719bSwdenk		Default load address for network file downloads
1706c609719bSwdenk
1707c609719bSwdenk- CFG_LOADS_BAUD_CHANGE:
1708c609719bSwdenk		Enable temporary baudrate change while serial download
1709c609719bSwdenk
1710c609719bSwdenk- CFG_SDRAM_BASE:
1711c609719bSwdenk		Physical start address of SDRAM. _Must_ be 0 here.
1712c609719bSwdenk
1713c609719bSwdenk- CFG_MBIO_BASE:
1714c609719bSwdenk		Physical start address of Motherboard I/O (if using a
1715c609719bSwdenk		Cogent motherboard)
1716c609719bSwdenk
1717c609719bSwdenk- CFG_FLASH_BASE:
1718c609719bSwdenk		Physical start address of Flash memory.
1719c609719bSwdenk
1720c609719bSwdenk- CFG_MONITOR_BASE:
1721c609719bSwdenk		Physical start address of boot monitor code (set by
1722c609719bSwdenk		make config files to be same as the text base address
1723c609719bSwdenk		(TEXT_BASE) used when linking) - same as
1724c609719bSwdenk		CFG_FLASH_BASE when booting from flash.
1725c609719bSwdenk
1726c609719bSwdenk- CFG_MONITOR_LEN:
17273b57fe0aSwdenk		Size of memory reserved for monitor code, used to
17283b57fe0aSwdenk		determine _at_compile_time_ (!) if the environment is
17293b57fe0aSwdenk		embedded within the U-Boot image, or in a separate
17303b57fe0aSwdenk		flash sector.
1731c609719bSwdenk
1732c609719bSwdenk- CFG_MALLOC_LEN:
1733c609719bSwdenk		Size of DRAM reserved for malloc() use.
1734c609719bSwdenk
1735c609719bSwdenk- CFG_BOOTMAPSZ:
1736c609719bSwdenk		Maximum size of memory mapped by the startup code of
1737c609719bSwdenk		the Linux kernel; all data that must be processed by
1738c609719bSwdenk		the Linux kernel (bd_info, boot arguments, eventually
1739c609719bSwdenk		initrd image) must be put below this limit.
1740c609719bSwdenk
1741c609719bSwdenk- CFG_MAX_FLASH_BANKS:
1742c609719bSwdenk		Max number of Flash memory banks
1743c609719bSwdenk
1744c609719bSwdenk- CFG_MAX_FLASH_SECT:
1745c609719bSwdenk		Max number of sectors on a Flash chip
1746c609719bSwdenk
1747c609719bSwdenk- CFG_FLASH_ERASE_TOUT:
1748c609719bSwdenk		Timeout for Flash erase operations (in ms)
1749c609719bSwdenk
1750c609719bSwdenk- CFG_FLASH_WRITE_TOUT:
1751c609719bSwdenk		Timeout for Flash write operations (in ms)
1752c609719bSwdenk
17538564acf9Swdenk- CFG_FLASH_LOCK_TOUT
17548564acf9Swdenk		Timeout for Flash set sector lock bit operation (in ms)
17558564acf9Swdenk
17568564acf9Swdenk- CFG_FLASH_UNLOCK_TOUT
17578564acf9Swdenk		Timeout for Flash clear lock bits operation (in ms)
17588564acf9Swdenk
17598564acf9Swdenk- CFG_FLASH_PROTECTION
17608564acf9Swdenk		If defined, hardware flash sectors protection is used
17618564acf9Swdenk		instead of U-Boot software protection.
17628564acf9Swdenk
1763c609719bSwdenk- CFG_DIRECT_FLASH_TFTP:
1764c609719bSwdenk
1765c609719bSwdenk		Enable TFTP transfers directly to flash memory;
1766c609719bSwdenk		without this option such a download has to be
1767c609719bSwdenk		performed in two steps: (1) download to RAM, and (2)
1768c609719bSwdenk		copy from RAM to flash.
1769c609719bSwdenk
1770c609719bSwdenk		The two-step approach is usually more reliable, since
1771c609719bSwdenk		you can check if the download worked before you erase
1772c609719bSwdenk		the flash, but in some situations (when sytem RAM is
1773c609719bSwdenk		too limited to allow for a tempory copy of the
1774c609719bSwdenk		downloaded image) this option may be very useful.
1775c609719bSwdenk
1776c609719bSwdenk- CFG_FLASH_CFI:
1777c609719bSwdenk		Define if the flash driver uses extra elements in the
17785653fc33Swdenk		common flash structure for storing flash geometry.
17795653fc33Swdenk
17805653fc33Swdenk- CFG_FLASH_CFI_DRIVER
17815653fc33Swdenk		This option also enables the building of the cfi_flash driver
17825653fc33Swdenk		in the drivers directory
178353cf9435Sstroese
17845568e613SStefan Roese- CFG_FLASH_QUIET_TEST
17855568e613SStefan Roese		If this option is defined, the common CFI flash doesn't
17865568e613SStefan Roese		print it's warning upon not recognized FLASH banks. This
17875568e613SStefan Roese		is useful, if some of the configured banks are only
17885568e613SStefan Roese		optionally available.
17895568e613SStefan Roese
179053cf9435Sstroese- CFG_RX_ETH_BUFFER:
179153cf9435Sstroese		Defines the number of ethernet receive buffers. On some
179253cf9435Sstroese		ethernet controllers it is recommended to set this value
179353cf9435Sstroese		to 8 or even higher (EEPRO100 or 405 EMAC), since all
179453cf9435Sstroese		buffers can be full shortly after enabling the interface
179553cf9435Sstroese		on high ethernet traffic.
179653cf9435Sstroese		Defaults to 4 if not defined.
1797c609719bSwdenk
1798c609719bSwdenkThe following definitions that deal with the placement and management
1799c609719bSwdenkof environment data (variable area); in general, we support the
1800c609719bSwdenkfollowing configurations:
1801c609719bSwdenk
1802c609719bSwdenk- CFG_ENV_IS_IN_FLASH:
1803c609719bSwdenk
1804c609719bSwdenk	Define this if the environment is in flash memory.
1805c609719bSwdenk
1806c609719bSwdenk	a) The environment occupies one whole flash sector, which is
1807c609719bSwdenk	   "embedded" in the text segment with the U-Boot code. This
1808c609719bSwdenk	   happens usually with "bottom boot sector" or "top boot
1809c609719bSwdenk	   sector" type flash chips, which have several smaller
1810c609719bSwdenk	   sectors at the start or the end. For instance, such a
1811c609719bSwdenk	   layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
1812c609719bSwdenk	   such a case you would place the environment in one of the
1813c609719bSwdenk	   4 kB sectors - with U-Boot code before and after it. With
1814c609719bSwdenk	   "top boot sector" type flash chips, you would put the
1815c609719bSwdenk	   environment in one of the last sectors, leaving a gap
1816c609719bSwdenk	   between U-Boot and the environment.
1817c609719bSwdenk
1818c609719bSwdenk	- CFG_ENV_OFFSET:
1819c609719bSwdenk
1820c609719bSwdenk	   Offset of environment data (variable area) to the
1821c609719bSwdenk	   beginning of flash memory; for instance, with bottom boot
1822c609719bSwdenk	   type flash chips the second sector can be used: the offset
1823c609719bSwdenk	   for this sector is given here.
1824c609719bSwdenk
1825c609719bSwdenk	   CFG_ENV_OFFSET is used relative to CFG_FLASH_BASE.
1826c609719bSwdenk
1827c609719bSwdenk	- CFG_ENV_ADDR:
1828c609719bSwdenk
1829c609719bSwdenk	   This is just another way to specify the start address of
1830c609719bSwdenk	   the flash sector containing the environment (instead of
1831c609719bSwdenk	   CFG_ENV_OFFSET).
1832c609719bSwdenk
1833c609719bSwdenk	- CFG_ENV_SECT_SIZE:
1834c609719bSwdenk
1835c609719bSwdenk	   Size of the sector containing the environment.
1836c609719bSwdenk
1837c609719bSwdenk
1838c609719bSwdenk	b) Sometimes flash chips have few, equal sized, BIG sectors.
1839c609719bSwdenk	   In such a case you don't want to spend a whole sector for
1840c609719bSwdenk	   the environment.
1841c609719bSwdenk
1842c609719bSwdenk	- CFG_ENV_SIZE:
1843c609719bSwdenk
1844c609719bSwdenk	   If you use this in combination with CFG_ENV_IS_IN_FLASH
1845c609719bSwdenk	   and CFG_ENV_SECT_SIZE, you can specify to use only a part
1846c609719bSwdenk	   of this flash sector for the environment. This saves
1847c609719bSwdenk	   memory for the RAM copy of the environment.
1848c609719bSwdenk
1849c609719bSwdenk	   It may also save flash memory if you decide to use this
1850c609719bSwdenk	   when your environment is "embedded" within U-Boot code,
1851c609719bSwdenk	   since then the remainder of the flash sector could be used
1852c609719bSwdenk	   for U-Boot code. It should be pointed out that this is
1853c609719bSwdenk	   STRONGLY DISCOURAGED from a robustness point of view:
1854c609719bSwdenk	   updating the environment in flash makes it always
1855c609719bSwdenk	   necessary to erase the WHOLE sector. If something goes
1856c609719bSwdenk	   wrong before the contents has been restored from a copy in
1857c609719bSwdenk	   RAM, your target system will be dead.
1858c609719bSwdenk
1859c609719bSwdenk	- CFG_ENV_ADDR_REDUND
1860c609719bSwdenk	  CFG_ENV_SIZE_REDUND
1861c609719bSwdenk
1862c609719bSwdenk	   These settings describe a second storage area used to hold
1863c609719bSwdenk	   a redundand copy of the environment data, so that there is
18643e38691eSwdenk	   a valid backup copy in case there is a power failure during
1865c609719bSwdenk	   a "saveenv" operation.
1866c609719bSwdenk
1867c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the
1868c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds*
1869c609719bSwdenkaccordingly!
1870c609719bSwdenk
1871c609719bSwdenk
1872c609719bSwdenk- CFG_ENV_IS_IN_NVRAM:
1873c609719bSwdenk
1874c609719bSwdenk	Define this if you have some non-volatile memory device
1875c609719bSwdenk	(NVRAM, battery buffered SRAM) which you want to use for the
1876c609719bSwdenk	environment.
1877c609719bSwdenk
1878c609719bSwdenk	- CFG_ENV_ADDR:
1879c609719bSwdenk	- CFG_ENV_SIZE:
1880c609719bSwdenk
1881c609719bSwdenk	  These two #defines are used to determin the memory area you
1882c609719bSwdenk	  want to use for environment. It is assumed that this memory
1883c609719bSwdenk	  can just be read and written to, without any special
1884c609719bSwdenk	  provision.
1885c609719bSwdenk
1886c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early
1887c609719bSwdenkin U-Boot initalization (when we try to get the setting of for the
1888c609719bSwdenkconsole baudrate). You *MUST* have mappend your NVRAM area then, or
1889c609719bSwdenkU-Boot will hang.
1890c609719bSwdenk
1891c609719bSwdenkPlease note that even with NVRAM we still use a copy of the
1892c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to
1893c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv"
1894c609719bSwdenkto save the current settings.
1895c609719bSwdenk
1896c609719bSwdenk
1897c609719bSwdenk- CFG_ENV_IS_IN_EEPROM:
1898c609719bSwdenk
1899c609719bSwdenk	Use this if you have an EEPROM or similar serial access
1900c609719bSwdenk	device and a driver for it.
1901c609719bSwdenk
1902c609719bSwdenk	- CFG_ENV_OFFSET:
1903c609719bSwdenk	- CFG_ENV_SIZE:
1904c609719bSwdenk
1905c609719bSwdenk	  These two #defines specify the offset and size of the
1906c609719bSwdenk	  environment area within the total memory of your EEPROM.
1907c609719bSwdenk
1908c609719bSwdenk	- CFG_I2C_EEPROM_ADDR:
1909c609719bSwdenk	  If defined, specified the chip address of the EEPROM device.
1910c609719bSwdenk	  The default address is zero.
1911c609719bSwdenk
1912c609719bSwdenk	- CFG_EEPROM_PAGE_WRITE_BITS:
1913c609719bSwdenk	  If defined, the number of bits used to address bytes in a
1914c609719bSwdenk	  single page in the EEPROM device.  A 64 byte page, for example
1915c609719bSwdenk	  would require six bits.
1916c609719bSwdenk
1917c609719bSwdenk	- CFG_EEPROM_PAGE_WRITE_DELAY_MS:
1918c609719bSwdenk	  If defined, the number of milliseconds to delay between
1919c609719bSwdenk	  page writes.	The default is zero milliseconds.
1920c609719bSwdenk
1921c609719bSwdenk	- CFG_I2C_EEPROM_ADDR_LEN:
1922c609719bSwdenk	  The length in bytes of the EEPROM memory array address.  Note
1923c609719bSwdenk	  that this is NOT the chip address length!
1924c609719bSwdenk
19255cf91d6bSwdenk	- CFG_I2C_EEPROM_ADDR_OVERFLOW:
19265cf91d6bSwdenk	  EEPROM chips that implement "address overflow" are ones
19275cf91d6bSwdenk	  like Catalyst 24WC04/08/16 which has 9/10/11 bits of
19285cf91d6bSwdenk	  address and the extra bits end up in the "chip address" bit
19295cf91d6bSwdenk	  slots. This makes a 24WC08 (1Kbyte) chip look like four 256
19305cf91d6bSwdenk	  byte chips.
19315cf91d6bSwdenk
19325cf91d6bSwdenk	  Note that we consider the length of the address field to
19335cf91d6bSwdenk	  still be one byte because the extra address bits are hidden
19345cf91d6bSwdenk	  in the chip address.
19355cf91d6bSwdenk
1936c609719bSwdenk	- CFG_EEPROM_SIZE:
1937c609719bSwdenk	  The size in bytes of the EEPROM device.
1938c609719bSwdenk
1939c609719bSwdenk
19405779d8d9Swdenk- CFG_ENV_IS_IN_DATAFLASH:
19415779d8d9Swdenk
19425779d8d9Swdenk	Define this if you have a DataFlash memory device which you
19435779d8d9Swdenk	want to use for the environment.
19445779d8d9Swdenk
19455779d8d9Swdenk	- CFG_ENV_OFFSET:
19465779d8d9Swdenk	- CFG_ENV_ADDR:
19475779d8d9Swdenk	- CFG_ENV_SIZE:
19485779d8d9Swdenk
19495779d8d9Swdenk	  These three #defines specify the offset and size of the
19505779d8d9Swdenk	  environment area within the total memory of your DataFlash placed
19515779d8d9Swdenk	  at the specified address.
19525779d8d9Swdenk
195313a5695bSwdenk- CFG_ENV_IS_IN_NAND:
195413a5695bSwdenk
195513a5695bSwdenk	Define this if you have a NAND device which you want to use
195613a5695bSwdenk	for the environment.
195713a5695bSwdenk
195813a5695bSwdenk	- CFG_ENV_OFFSET:
195913a5695bSwdenk	- CFG_ENV_SIZE:
196013a5695bSwdenk
196113a5695bSwdenk	  These two #defines specify the offset and size of the environment
196213a5695bSwdenk	  area within the first NAND device.
19635779d8d9Swdenk
1964e443c944SMarkus Klotzbuecher	- CFG_ENV_OFFSET_REDUND
1965e443c944SMarkus Klotzbuecher
1966e443c944SMarkus Klotzbuecher	  This setting describes a second storage area of CFG_ENV_SIZE
1967e443c944SMarkus Klotzbuecher	  size used to hold a redundant copy of the environment data,
1968e443c944SMarkus Klotzbuecher	  so that there is a valid backup copy in case there is a
1969e443c944SMarkus Klotzbuecher	  power failure during a "saveenv" operation.
1970e443c944SMarkus Klotzbuecher
1971e443c944SMarkus Klotzbuecher	Note: CFG_ENV_OFFSET and CFG_ENV_OFFSET_REDUND must be aligned
1972e443c944SMarkus Klotzbuecher	to a block boundary, and CFG_ENV_SIZE must be a multiple of
1973e443c944SMarkus Klotzbuecher	the NAND devices block size.
1974e443c944SMarkus Klotzbuecher
1975c609719bSwdenk- CFG_SPI_INIT_OFFSET
1976c609719bSwdenk
1977c609719bSwdenk	Defines offset to the initial SPI buffer area in DPRAM. The
1978c609719bSwdenk	area is used at an early stage (ROM part) if the environment
1979c609719bSwdenk	is configured to reside in the SPI EEPROM: We need a 520 byte
1980c609719bSwdenk	scratch DPRAM area. It is used between the two initialization
1981c609719bSwdenk	calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
1982c609719bSwdenk	to be a good choice since it makes it far enough from the
1983c609719bSwdenk	start of the data area as well as from the stack pointer.
1984c609719bSwdenk
1985c609719bSwdenkPlease note that the environment is read-only as long as the monitor
1986c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been
1987c609719bSwdenkcreated; also, when using EEPROM you will have to use getenv_r()
1988c609719bSwdenkuntil then to read environment variables.
1989c609719bSwdenk
199085ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor
199185ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working
199285ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is
199385ec0bccSwdenknecessary, because the first environment variable we need is the
199485ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't
199585ec0bccSwdenkhave any device yet where we could complain.]
1996c609719bSwdenk
1997c609719bSwdenkNote: once the monitor has been relocated, then it will complain if
1998c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you
199985ec0bccSwdenkuse the "saveenv" command to store a valid environment.
2000c609719bSwdenk
2001fc3e2165Swdenk- CFG_FAULT_ECHO_LINK_DOWN:
2002fc3e2165Swdenk		Echo the inverted Ethernet link state to the fault LED.
2003fc3e2165Swdenk
2004fc3e2165Swdenk		Note: If this option is active, then CFG_FAULT_MII_ADDR
2005fc3e2165Swdenk		      also needs to be defined.
2006fc3e2165Swdenk
2007fc3e2165Swdenk- CFG_FAULT_MII_ADDR:
2008fc3e2165Swdenk		MII address of the PHY to check for the Ethernet link state.
2009c609719bSwdenk
2010c40b2956Swdenk- CFG_64BIT_VSPRINTF:
2011c40b2956Swdenk		Makes vsprintf (and all *printf functions) support printing
2012c40b2956Swdenk		of 64bit values by using the L quantifier
2013c40b2956Swdenk
2014c40b2956Swdenk- CFG_64BIT_STRTOUL:
2015c40b2956Swdenk		Adds simple_strtoull that returns a 64bit value
2016c40b2956Swdenk
2017c609719bSwdenkLow Level (hardware related) configuration options:
2018dc7c9a1aSwdenk---------------------------------------------------
2019c609719bSwdenk
2020c609719bSwdenk- CFG_CACHELINE_SIZE:
2021c609719bSwdenk		Cache Line Size of the CPU.
2022c609719bSwdenk
2023c609719bSwdenk- CFG_DEFAULT_IMMR:
2024c609719bSwdenk		Default address of the IMMR after system reset.
20252535d602Swdenk
20262535d602Swdenk		Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
20272535d602Swdenk		and RPXsuper) to be able to adjust the position of
20282535d602Swdenk		the IMMR register after a reset.
2029c609719bSwdenk
20307f6c2cbcSwdenk- Floppy Disk Support:
20317f6c2cbcSwdenk		CFG_FDC_DRIVE_NUMBER
20327f6c2cbcSwdenk
20337f6c2cbcSwdenk		the default drive number (default value 0)
20347f6c2cbcSwdenk
20357f6c2cbcSwdenk		CFG_ISA_IO_STRIDE
20367f6c2cbcSwdenk
20377f6c2cbcSwdenk		defines the spacing between fdc chipset registers
20387f6c2cbcSwdenk		(default value 1)
20397f6c2cbcSwdenk
20407f6c2cbcSwdenk		CFG_ISA_IO_OFFSET
20417f6c2cbcSwdenk
20427f6c2cbcSwdenk		defines the offset of register from address. It
20437f6c2cbcSwdenk		depends on which part of the data bus is connected to
20447f6c2cbcSwdenk		the fdc chipset. (default value 0)
20457f6c2cbcSwdenk
20467f6c2cbcSwdenk		If CFG_ISA_IO_STRIDE CFG_ISA_IO_OFFSET and
20477f6c2cbcSwdenk		CFG_FDC_DRIVE_NUMBER are undefined, they take their
20487f6c2cbcSwdenk		default value.
20497f6c2cbcSwdenk
20507f6c2cbcSwdenk		if CFG_FDC_HW_INIT is defined, then the function
20517f6c2cbcSwdenk		fdc_hw_init() is called at the beginning of the FDC
20527f6c2cbcSwdenk		setup. fdc_hw_init() must be provided by the board
20537f6c2cbcSwdenk		source code. It is used to make hardware dependant
20547f6c2cbcSwdenk		initializations.
20557f6c2cbcSwdenk
205625d6712aSwdenk- CFG_IMMR:	Physical address of the Internal Memory.
205725d6712aSwdenk		DO NOT CHANGE unless you know exactly what you're
205825d6712aSwdenk		doing! (11-4) [MPC8xx/82xx systems only]
2059c609719bSwdenk
2060c609719bSwdenk- CFG_INIT_RAM_ADDR:
2061c609719bSwdenk
20627152b1d0Swdenk		Start address of memory area that can be used for
2063c609719bSwdenk		initial data and stack; please note that this must be
2064c609719bSwdenk		writable memory that is working WITHOUT special
2065c609719bSwdenk		initialization, i. e. you CANNOT use normal RAM which
2066c609719bSwdenk		will become available only after programming the
2067c609719bSwdenk		memory controller and running certain initialization
2068c609719bSwdenk		sequences.
2069c609719bSwdenk
2070c609719bSwdenk		U-Boot uses the following memory types:
2071c609719bSwdenk		- MPC8xx and MPC8260: IMMR (internal memory of the CPU)
2072c609719bSwdenk		- MPC824X: data cache
2073c609719bSwdenk		- PPC4xx:  data cache
2074c609719bSwdenk
207585ec0bccSwdenk- CFG_GBL_DATA_OFFSET:
2076c609719bSwdenk
2077c609719bSwdenk		Offset of the initial data structure in the memory
2078c609719bSwdenk		area defined by CFG_INIT_RAM_ADDR. Usually
207985ec0bccSwdenk		CFG_GBL_DATA_OFFSET is chosen such that the initial
2080c609719bSwdenk		data is located at the end of the available space
2081c609719bSwdenk		(sometimes written as (CFG_INIT_RAM_END -
2082c609719bSwdenk		CFG_INIT_DATA_SIZE), and the initial stack is just
2083c609719bSwdenk		below that area (growing from (CFG_INIT_RAM_ADDR +
208485ec0bccSwdenk		CFG_GBL_DATA_OFFSET) downward.
2085c609719bSwdenk
2086c609719bSwdenk	Note:
2087c609719bSwdenk		On the MPC824X (or other systems that use the data
2088c609719bSwdenk		cache for initial memory) the address chosen for
2089c609719bSwdenk		CFG_INIT_RAM_ADDR is basically arbitrary - it must
2090c609719bSwdenk		point to an otherwise UNUSED address space between
2091c609719bSwdenk		the top of RAM and the start of the PCI space.
2092c609719bSwdenk
2093c609719bSwdenk- CFG_SIUMCR:	SIU Module Configuration (11-6)
2094c609719bSwdenk
2095c609719bSwdenk- CFG_SYPCR:	System Protection Control (11-9)
2096c609719bSwdenk
2097c609719bSwdenk- CFG_TBSCR:	Time Base Status and Control (11-26)
2098c609719bSwdenk
2099c609719bSwdenk- CFG_PISCR:	Periodic Interrupt Status and Control (11-31)
2100c609719bSwdenk
2101c609719bSwdenk- CFG_PLPRCR:	PLL, Low-Power, and Reset Control Register (15-30)
2102c609719bSwdenk
2103c609719bSwdenk- CFG_SCCR:	System Clock and reset Control Register (15-27)
2104c609719bSwdenk
2105c609719bSwdenk- CFG_OR_TIMING_SDRAM:
2106c609719bSwdenk		SDRAM timing
2107c609719bSwdenk
2108c609719bSwdenk- CFG_MAMR_PTA:
2109c609719bSwdenk		periodic timer for refresh
2110c609719bSwdenk
2111c609719bSwdenk- CFG_DER:	Debug Event Register (37-47)
2112c609719bSwdenk
2113c609719bSwdenk- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CFG_REMAP_OR_AM,
2114c609719bSwdenk  CFG_PRELIM_OR_AM, CFG_OR_TIMING_FLASH, CFG_OR0_REMAP,
2115c609719bSwdenk  CFG_OR0_PRELIM, CFG_BR0_PRELIM, CFG_OR1_REMAP, CFG_OR1_PRELIM,
2116c609719bSwdenk  CFG_BR1_PRELIM:
2117c609719bSwdenk		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
2118c609719bSwdenk
2119c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
2120c609719bSwdenk  CFG_OR_TIMING_SDRAM, CFG_OR2_PRELIM, CFG_BR2_PRELIM,
2121c609719bSwdenk  CFG_OR3_PRELIM, CFG_BR3_PRELIM:
2122c609719bSwdenk		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
2123c609719bSwdenk
2124c609719bSwdenk- CFG_MAMR_PTA, CFG_MPTPR_2BK_4K, CFG_MPTPR_1BK_4K, CFG_MPTPR_2BK_8K,
2125c609719bSwdenk  CFG_MPTPR_1BK_8K, CFG_MAMR_8COL, CFG_MAMR_9COL:
2126c609719bSwdenk		Machine Mode Register and Memory Periodic Timer
2127c609719bSwdenk		Prescaler definitions (SDRAM timing)
2128c609719bSwdenk
2129c609719bSwdenk- CFG_I2C_UCODE_PATCH, CFG_I2C_DPMEM_OFFSET [0x1FC0]:
2130c609719bSwdenk		enable I2C microcode relocation patch (MPC8xx);
2131c609719bSwdenk		define relocation offset in DPRAM [DSP2]
2132c609719bSwdenk
2133c609719bSwdenk- CFG_SPI_UCODE_PATCH, CFG_SPI_DPMEM_OFFSET [0x1FC0]:
2134c609719bSwdenk		enable SPI microcode relocation patch (MPC8xx);
2135c609719bSwdenk		define relocation offset in DPRAM [SCC4]
2136c609719bSwdenk
2137c609719bSwdenk- CFG_USE_OSCCLK:
2138c609719bSwdenk		Use OSCM clock mode on MBX8xx board. Be careful,
2139c609719bSwdenk		wrong setting might damage your board. Read
2140c609719bSwdenk		doc/README.MBX before setting this variable!
2141c609719bSwdenk
2142ea909b76Swdenk- CFG_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
2143ea909b76Swdenk		Offset of the bootmode word in DPRAM used by post
2144ea909b76Swdenk		(Power On Self Tests). This definition overrides
2145ea909b76Swdenk		#define'd default value in commproc.h resp.
2146ea909b76Swdenk		cpm_8260.h.
2147ea909b76Swdenk
21485d232d0eSwdenk- CFG_PCI_SLV_MEM_LOCAL, CFG_PCI_SLV_MEM_BUS, CFG_PICMR0_MASK_ATTRIB,
21495d232d0eSwdenk  CFG_PCI_MSTR0_LOCAL, CFG_PCIMSK0_MASK, CFG_PCI_MSTR1_LOCAL,
21505d232d0eSwdenk  CFG_PCIMSK1_MASK, CFG_PCI_MSTR_MEM_LOCAL, CFG_PCI_MSTR_MEM_BUS,
21515d232d0eSwdenk  CFG_CPU_PCI_MEM_START, CFG_PCI_MSTR_MEM_SIZE, CFG_POCMR0_MASK_ATTRIB,
21525d232d0eSwdenk  CFG_PCI_MSTR_MEMIO_LOCAL, CFG_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
21535d232d0eSwdenk  CFG_PCI_MSTR_MEMIO_SIZE, CFG_POCMR1_MASK_ATTRIB, CFG_PCI_MSTR_IO_LOCAL,
21545d232d0eSwdenk  CFG_PCI_MSTR_IO_BUS, CFG_CPU_PCI_IO_START, CFG_PCI_MSTR_IO_SIZE,
21555d232d0eSwdenk  CFG_POCMR2_MASK_ATTRIB: (MPC826x only)
21565d232d0eSwdenk		Overrides the default PCI memory map in cpu/mpc8260/pci.c if set.
21575d232d0eSwdenk
2158c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12]
2159c26e454dSwdenk		Define to enable FEC[12] on a 8xx series processor.
2160c26e454dSwdenk
2161c26e454dSwdenk- CONFIG_FEC[12]_PHY
2162c26e454dSwdenk		Define to the hardcoded PHY address which corresponds
21636e592385Swdenk		to the given FEC; i. e.
2164c26e454dSwdenk			#define CONFIG_FEC1_PHY 4
2165c26e454dSwdenk		means that the PHY with address 4 is connected to FEC1
2166c26e454dSwdenk
2167c26e454dSwdenk		When set to -1, means to probe for first available.
2168c26e454dSwdenk
2169c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR
2170c26e454dSwdenk		The PHY does not have a RXERR line (RMII only).
2171c26e454dSwdenk		(so program the FEC to ignore it).
2172c26e454dSwdenk
2173c26e454dSwdenk- CONFIG_RMII
2174c26e454dSwdenk		Enable RMII mode for all FECs.
2175c26e454dSwdenk		Note that this is a global option, we can't
2176c26e454dSwdenk		have one FEC in standard MII mode and another in RMII mode.
2177c26e454dSwdenk
21785cf91d6bSwdenk- CONFIG_CRC32_VERIFY
21795cf91d6bSwdenk		Add a verify option to the crc32 command.
21805cf91d6bSwdenk		The syntax is:
21815cf91d6bSwdenk
21825cf91d6bSwdenk		=> crc32 -v <address> <count> <crc32>
21835cf91d6bSwdenk
21845cf91d6bSwdenk		Where address/count indicate a memory area
21855cf91d6bSwdenk		and crc32 is the correct crc32 which the
21865cf91d6bSwdenk		area should have.
21875cf91d6bSwdenk
218856523f12Swdenk- CONFIG_LOOPW
218956523f12Swdenk		Add the "loopw" memory command. This only takes effect if
219056523f12Swdenk		the memory commands are activated globally (CFG_CMD_MEM).
219156523f12Swdenk
21927b466641Sstroese- CONFIG_MX_CYCLIC
21937b466641Sstroese		Add the "mdc" and "mwc" memory commands. These are cyclic
21947b466641Sstroese		"md/mw" commands.
21957b466641Sstroese		Examples:
21967b466641Sstroese
21977b466641Sstroese		=> mdc.b 10 4 500
21987b466641Sstroese		This command will print 4 bytes (10,11,12,13) each 500 ms.
21997b466641Sstroese
22007b466641Sstroese		=> mwc.l 100 12345678 10
22017b466641Sstroese		This command will write 12345678 to address 100 all 10 ms.
22027b466641Sstroese
22037b466641Sstroese		This only takes effect if the memory commands are activated
22047b466641Sstroese		globally (CFG_CMD_MEM).
22057b466641Sstroese
22068aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT
22078aa1a2d1Swdenk- CONFIG_SKIP_RELOCATE_UBOOT
22088aa1a2d1Swdenk
22098aa1a2d1Swdenk		[ARM only] If these variables are defined, then
22108aa1a2d1Swdenk		certain low level initializations (like setting up
22118aa1a2d1Swdenk		the memory controller) are omitted and/or U-Boot does
22128aa1a2d1Swdenk		not relocate itself into RAM.
22138aa1a2d1Swdenk		Normally these variables MUST NOT be defined. The
22148aa1a2d1Swdenk		only exception is when U-Boot is loaded (to RAM) by
22158aa1a2d1Swdenk		some other boot loader or by a debugger which
22168aa1a2d1Swdenk		performs these intializations itself.
22178aa1a2d1Swdenk
2218400558b5Swdenk
2219c609719bSwdenkBuilding the Software:
2220c609719bSwdenk======================
2221c609719bSwdenk
2222c609719bSwdenkBuilding U-Boot has been tested in native PPC environments (on a
2223c609719bSwdenkPowerBook G3 running LinuxPPC 2000) and in cross environments
2224c609719bSwdenk(running RedHat 6.x and 7.x Linux on x86, Solaris 2.6 on a SPARC, and
2225c609719bSwdenkNetBSD 1.5 on x86).
2226c609719bSwdenk
2227c609719bSwdenkIf you are not using a native PPC environment, it is assumed that you
2228c609719bSwdenkhave the GNU cross compiling tools available in your path and named
2229c609719bSwdenkwith a prefix of "powerpc-linux-". If this is not the case, (e.g. if
2230c609719bSwdenkyou are using Monta Vista's Hard Hat Linux CDK 1.2) you must change
2231c609719bSwdenkthe definition of CROSS_COMPILE in Makefile. For HHL on a 4xx CPU,
2232c609719bSwdenkchange it to:
2233c609719bSwdenk
2234c609719bSwdenk	CROSS_COMPILE = ppc_4xx-
2235c609719bSwdenk
2236c609719bSwdenk
2237c609719bSwdenkU-Boot is intended to be  simple  to  build.  After  installing	 the
2238c609719bSwdenksources	 you must configure U-Boot for one specific board type. This
2239c609719bSwdenkis done by typing:
2240c609719bSwdenk
2241c609719bSwdenk	make NAME_config
2242c609719bSwdenk
2243c609719bSwdenkwhere "NAME_config" is the name of one of the existing
2244c609719bSwdenkconfigurations; the following names are supported:
2245c609719bSwdenk
22461eaeb58eSwdenk	ADCIOP_config		FPS860L_config		omap730p2_config
22471eaeb58eSwdenk	ADS860_config		GEN860T_config		pcu_e_config
2248983fda83Swdenk	Alaska8220_config
22491eaeb58eSwdenk	AR405_config		GENIETV_config		PIP405_config
22501eaeb58eSwdenk	at91rm9200dk_config	GTH_config		QS823_config
22511eaeb58eSwdenk	CANBT_config		hermes_config		QS850_config
22521eaeb58eSwdenk	cmi_mpc5xx_config	hymod_config		QS860T_config
22531eaeb58eSwdenk	cogent_common_config	IP860_config		RPXlite_config
2254e63c8ee3Swdenk	cogent_mpc8260_config	IVML24_config		RPXlite_DW_config
2255e63c8ee3Swdenk	cogent_mpc8xx_config	IVMS8_config		RPXsuper_config
2256e63c8ee3Swdenk	CPCI405_config		JSE_config		rsdproto_config
2257e63c8ee3Swdenk	CPCIISER4_config	LANTEC_config		Sandpoint8240_config
2258e63c8ee3Swdenk	csb272_config		lwmon_config		sbc8260_config
2259466b7410Swdenk	CU824_config		MBX860T_config		sbc8560_33_config
2260466b7410Swdenk	DUET_ADS_config		MBX_config		sbc8560_66_config
22618b07a110Swdenk	EBONY_config		MPC8260ADS_config	SM850_config
22628b07a110Swdenk	ELPT860_config		MPC8540ADS_config	SPD823TS_config
2263b0e32949SLunsheng Wang	ESTEEM192E_config	MPC8540EVAL_config	stxgp3_config
2264b0e32949SLunsheng Wang	ETX094_config		MPC8560ADS_config	SXNI855T_config
2265b0e32949SLunsheng Wang	FADS823_config		NETVIA_config		TQM823L_config
2266b0e32949SLunsheng Wang	FADS850SAR_config	omap1510inn_config	TQM850L_config
2267b0e32949SLunsheng Wang	FADS860T_config		omap1610h2_config	TQM855L_config
2268b0e32949SLunsheng Wang	FPS850L_config		omap1610inn_config	TQM860L_config
22694b1d95d9SJon Loeliger				omap5912osk_config	walnut_config
2270b0e32949SLunsheng Wang				omap2420h4_config	Yukon8220_config
22718b07a110Swdenk							ZPC1900_config
227254387ac9Swdenk
2273c609719bSwdenkNote: for some board special configuration names may exist; check if
2274c609719bSwdenk      additional information is available from the board vendor; for
22752729af9dSwdenk      instance, the TQM823L systems are available without (standard)
22762729af9dSwdenk      or with LCD support. You can select such additional "features"
2277c609719bSwdenk      when chosing the configuration, i. e.
2278c609719bSwdenk
22792729af9dSwdenk      make TQM823L_config
22802729af9dSwdenk	- will configure for a plain TQM823L, i. e. no LCD support
2281c609719bSwdenk
2282c609719bSwdenk      make TQM823L_LCD_config
2283c609719bSwdenk	- will configure for a TQM823L with U-Boot console on LCD
2284c609719bSwdenk
2285c609719bSwdenk      etc.
2286c609719bSwdenk
2287c609719bSwdenk
2288c609719bSwdenkFinally, type "make all", and you should get some working U-Boot
22897152b1d0Swdenkimages ready for download to / installation on your system:
2290c609719bSwdenk
2291c609719bSwdenk- "u-boot.bin" is a raw binary image
2292c609719bSwdenk- "u-boot" is an image in ELF binary format
2293c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format
2294c609719bSwdenk
2295c609719bSwdenk
2296c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so
2297c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of
2298c609719bSwdenknative "make".
2299c609719bSwdenk
2300c609719bSwdenk
2301c609719bSwdenkIf the system board that you have is not listed, then you will need
2302c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these
2303c609719bSwdenksteps:
2304c609719bSwdenk
2305c609719bSwdenk1.  Add a new configuration option for your board to the toplevel
230685ec0bccSwdenk    "Makefile" and to the "MAKEALL" script, using the existing
230785ec0bccSwdenk    entries as examples. Note that here and at many other places
23087152b1d0Swdenk    boards and other names are listed in alphabetical sort order. Please
230985ec0bccSwdenk    keep this order.
2310c609719bSwdenk2.  Create a new directory to hold your board specific code. Add any
231185ec0bccSwdenk    files you need. In your board directory, you will need at least
231285ec0bccSwdenk    the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
231385ec0bccSwdenk3.  Create a new configuration file "include/configs/<board>.h" for
231485ec0bccSwdenk    your board
2315c609719bSwdenk3.  If you're porting U-Boot to a new CPU, then also create a new
2316c609719bSwdenk    directory to hold your CPU specific code. Add any files you need.
231785ec0bccSwdenk4.  Run "make <board>_config" with your new name.
2318c609719bSwdenk5.  Type "make", and you should get a working "u-boot.srec" file
2319c609719bSwdenk    to be installed on your target system.
232085ec0bccSwdenk6.  Debug and solve any problems that might arise.
2321c609719bSwdenk    [Of course, this last step is much harder than it sounds.]
2322c609719bSwdenk
2323c609719bSwdenk
2324c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.:
2325c609719bSwdenk==============================================================
2326c609719bSwdenk
2327c609719bSwdenkIf you have modified U-Boot sources (for instance added a new	board
2328c609719bSwdenkor  support  for  new  devices,	 a new CPU, etc.) you are expected to
2329c609719bSwdenkprovide feedback to the other developers. The feedback normally takes
2330c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest
2331c609719bSwdenkofficial or latest in CVS) version of U-Boot sources.
2332c609719bSwdenk
2333c609719bSwdenkBut before you submit such a patch, please verify that	your  modifi-
2334c609719bSwdenkcation	did not break existing code. At least make sure that *ALL* of
2335c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so,
2336c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot
2337c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You  can
23387152b1d0Swdenkselect	which  (cross)	compiler  to use by passing a `CROSS_COMPILE'
2339c609719bSwdenkenvironment variable to the script, i. e. to use the cross tools from
2340c609719bSwdenkMontaVista's Hard Hat Linux you can type
2341c609719bSwdenk
2342c609719bSwdenk	CROSS_COMPILE=ppc_8xx- MAKEALL
2343c609719bSwdenk
2344c609719bSwdenkor to build on a native PowerPC system you can type
2345c609719bSwdenk
2346c609719bSwdenk	CROSS_COMPILE=' ' MAKEALL
2347c609719bSwdenk
2348c609719bSwdenkSee also "U-Boot Porting Guide" below.
2349c609719bSwdenk
2350c609719bSwdenk
2351c609719bSwdenkMonitor Commands - Overview:
2352c609719bSwdenk============================
2353c609719bSwdenk
2354c609719bSwdenkgo	- start application at address 'addr'
2355c609719bSwdenkrun	- run commands in an environment variable
2356c609719bSwdenkbootm	- boot application image from memory
2357c609719bSwdenkbootp	- boot image via network using BootP/TFTP protocol
2358c609719bSwdenktftpboot- boot image via network using TFTP protocol
2359c609719bSwdenk	       and env variables "ipaddr" and "serverip"
2360c609719bSwdenk	       (and eventually "gatewayip")
2361c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol
2362c609719bSwdenkdiskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
2363c609719bSwdenkloads	- load S-Record file over serial line
2364c609719bSwdenkloadb	- load binary file over serial line (kermit mode)
2365c609719bSwdenkmd	- memory display
2366c609719bSwdenkmm	- memory modify (auto-incrementing)
2367c609719bSwdenknm	- memory modify (constant address)
2368c609719bSwdenkmw	- memory write (fill)
2369c609719bSwdenkcp	- memory copy
2370c609719bSwdenkcmp	- memory compare
2371c609719bSwdenkcrc32	- checksum calculation
2372c609719bSwdenkimd	- i2c memory display
2373c609719bSwdenkimm	- i2c memory modify (auto-incrementing)
2374c609719bSwdenkinm	- i2c memory modify (constant address)
2375c609719bSwdenkimw	- i2c memory write (fill)
2376c609719bSwdenkicrc32	- i2c checksum calculation
2377c609719bSwdenkiprobe	- probe to discover valid I2C chip addresses
2378c609719bSwdenkiloop	- infinite loop on address range
2379c609719bSwdenkisdram	- print SDRAM configuration information
2380c609719bSwdenksspi	- SPI utility commands
2381c609719bSwdenkbase	- print or set address offset
2382c609719bSwdenkprintenv- print environment variables
2383c609719bSwdenksetenv	- set environment variables
2384c609719bSwdenksaveenv - save environment variables to persistent storage
2385c609719bSwdenkprotect - enable or disable FLASH write protection
2386c609719bSwdenkerase	- erase FLASH memory
2387c609719bSwdenkflinfo	- print FLASH memory information
2388c609719bSwdenkbdinfo	- print Board Info structure
2389c609719bSwdenkiminfo	- print header information for application image
2390c609719bSwdenkconinfo - print console devices and informations
2391c609719bSwdenkide	- IDE sub-system
2392c609719bSwdenkloop	- infinite loop on address range
239356523f12Swdenkloopw	- infinite write loop on address range
2394c609719bSwdenkmtest	- simple RAM test
2395c609719bSwdenkicache	- enable or disable instruction cache
2396c609719bSwdenkdcache	- enable or disable data cache
2397c609719bSwdenkreset	- Perform RESET of the CPU
2398c609719bSwdenkecho	- echo args to console
2399c609719bSwdenkversion - print monitor version
2400c609719bSwdenkhelp	- print online help
2401c609719bSwdenk?	- alias for 'help'
2402c609719bSwdenk
2403c609719bSwdenk
2404c609719bSwdenkMonitor Commands - Detailed Description:
2405c609719bSwdenk========================================
2406c609719bSwdenk
2407c609719bSwdenkTODO.
2408c609719bSwdenk
2409c609719bSwdenkFor now: just type "help <command>".
2410c609719bSwdenk
2411c609719bSwdenk
2412c609719bSwdenkEnvironment Variables:
2413c609719bSwdenk======================
2414c609719bSwdenk
2415c609719bSwdenkU-Boot supports user configuration using Environment Variables which
2416c609719bSwdenkcan be made persistent by saving to Flash memory.
2417c609719bSwdenk
2418c609719bSwdenkEnvironment Variables are set using "setenv", printed using
2419c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv"
2420c609719bSwdenkwithout a value can be used to delete a variable from the
2421c609719bSwdenkenvironment. As long as you don't save the environment you are
2422c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the
2423c609719bSwdenkenvironment is erased by accident, a default environment is provided.
2424c609719bSwdenk
2425c609719bSwdenkSome configuration options can be set using Environment Variables:
2426c609719bSwdenk
2427c609719bSwdenk  baudrate	- see CONFIG_BAUDRATE
2428c609719bSwdenk
2429c609719bSwdenk  bootdelay	- see CONFIG_BOOTDELAY
2430c609719bSwdenk
2431c609719bSwdenk  bootcmd	- see CONFIG_BOOTCOMMAND
2432c609719bSwdenk
2433c609719bSwdenk  bootargs	- Boot arguments when booting an RTOS image
2434c609719bSwdenk
2435c609719bSwdenk  bootfile	- Name of the image to load with TFTP
2436c609719bSwdenk
2437c609719bSwdenk  autoload	- if set to "no" (any string beginning with 'n'),
2438c609719bSwdenk		  "bootp" will just load perform a lookup of the
2439c609719bSwdenk		  configuration from the BOOTP server, but not try to
2440c609719bSwdenk		  load any image using TFTP
2441c609719bSwdenk
2442c609719bSwdenk  autostart	- if set to "yes", an image loaded using the "bootp",
2443c609719bSwdenk		  "rarpboot", "tftpboot" or "diskboot" commands will
2444c609719bSwdenk		  be automatically started (by internally calling
2445c609719bSwdenk		  "bootm")
2446c609719bSwdenk
24474a6fd34bSwdenk		  If set to "no", a standalone image passed to the
24484a6fd34bSwdenk		  "bootm" command will be copied to the load address
24494a6fd34bSwdenk		  (and eventually uncompressed), but NOT be started.
24504a6fd34bSwdenk		  This can be used to load and uncompress arbitrary
24514a6fd34bSwdenk		  data.
24524a6fd34bSwdenk
245317ea1177Swdenk  i2cfast	- (PPC405GP|PPC405EP only)
245417ea1177Swdenk		  if set to 'y' configures Linux I2C driver for fast
245517ea1177Swdenk		  mode (400kHZ). This environment variable is used in
245617ea1177Swdenk		  initialization code. So, for changes to be effective
245717ea1177Swdenk		  it must be saved and board must be reset.
245817ea1177Swdenk
2459c609719bSwdenk  initrd_high	- restrict positioning of initrd images:
2460c609719bSwdenk		  If this variable is not set, initrd images will be
2461c609719bSwdenk		  copied to the highest possible address in RAM; this
2462c609719bSwdenk		  is usually what you want since it allows for
2463c609719bSwdenk		  maximum initrd size. If for some reason you want to
2464c609719bSwdenk		  make sure that the initrd image is loaded below the
2465c609719bSwdenk		  CFG_BOOTMAPSZ limit, you can set this environment
2466c609719bSwdenk		  variable to a value of "no" or "off" or "0".
2467c609719bSwdenk		  Alternatively, you can set it to a maximum upper
2468c609719bSwdenk		  address to use (U-Boot will still check that it
2469c609719bSwdenk		  does not overwrite the U-Boot stack and data).
2470c609719bSwdenk
2471c609719bSwdenk		  For instance, when you have a system with 16 MB
24727152b1d0Swdenk		  RAM, and want to reserve 4 MB from use by Linux,
2473c609719bSwdenk		  you can do this by adding "mem=12M" to the value of
2474c609719bSwdenk		  the "bootargs" variable. However, now you must make
24757152b1d0Swdenk		  sure that the initrd image is placed in the first
2476c609719bSwdenk		  12 MB as well - this can be done with
2477c609719bSwdenk
2478c609719bSwdenk		  setenv initrd_high 00c00000
2479c609719bSwdenk
248038b99261Swdenk		  If you set initrd_high to 0xFFFFFFFF, this is an
248138b99261Swdenk		  indication to U-Boot that all addresses are legal
248238b99261Swdenk		  for the Linux kernel, including addresses in flash
248338b99261Swdenk		  memory. In this case U-Boot will NOT COPY the
248438b99261Swdenk		  ramdisk at all. This may be useful to reduce the
248538b99261Swdenk		  boot time on your system, but requires that this
248638b99261Swdenk		  feature is supported by your Linux kernel.
248738b99261Swdenk
2488c609719bSwdenk  ipaddr	- IP address; needed for tftpboot command
2489c609719bSwdenk
2490c609719bSwdenk  loadaddr	- Default load address for commands like "bootp",
2491dc7c9a1aSwdenk		  "rarpboot", "tftpboot", "loadb" or "diskboot"
2492c609719bSwdenk
2493c609719bSwdenk  loads_echo	- see CONFIG_LOADS_ECHO
2494c609719bSwdenk
2495c609719bSwdenk  serverip	- TFTP server IP address; needed for tftpboot command
2496c609719bSwdenk
2497c609719bSwdenk  bootretry	- see CONFIG_BOOT_RETRY_TIME
2498c609719bSwdenk
2499c609719bSwdenk  bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
2500c609719bSwdenk
2501c609719bSwdenk  bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
2502c609719bSwdenk
2503a3d991bdSwdenk  ethprime	- When CONFIG_NET_MULTI is enabled controls which
2504a3d991bdSwdenk		  interface is used first.
2505a3d991bdSwdenk
2506a3d991bdSwdenk  ethact	- When CONFIG_NET_MULTI is enabled controls which
2507a3d991bdSwdenk		  interface is currently active. For example you
2508a3d991bdSwdenk		  can do the following
2509a3d991bdSwdenk
2510a3d991bdSwdenk		  => setenv ethact FEC ETHERNET
2511a3d991bdSwdenk		  => ping 192.168.0.1 # traffic sent on FEC ETHERNET
2512a3d991bdSwdenk		  => setenv ethact SCC ETHERNET
2513a3d991bdSwdenk		  => ping 10.0.0.1 # traffic sent on SCC ETHERNET
2514a3d991bdSwdenk
2515a3d991bdSwdenk   netretry	- When set to "no" each network operation will
2516a3d991bdSwdenk		  either succeed or fail without retrying.
25176e592385Swdenk		  When set to "once" the network operation will
25186e592385Swdenk		  fail when all the available network interfaces
25196e592385Swdenk		  are tried once without success.
2520a3d991bdSwdenk		  Useful on scripts which control the retry operation
2521a3d991bdSwdenk		  themselves.
2522a3d991bdSwdenk
252328cb9375SWolfgang Denk  tftpsrcport	- If this is set, the value is used for TFTP's
2524ecb0ccd9SWolfgang Denk		  UDP source port.
2525ecb0ccd9SWolfgang Denk
252628cb9375SWolfgang Denk  tftpdstport	- If this is set, the value is used for TFTP's UDP
252728cb9375SWolfgang Denk		  destination port instead of the Well Know Port 69.
252828cb9375SWolfgang Denk
2529a3d991bdSwdenk   vlan		- When set to a value < 4095 the traffic over
2530a3d991bdSwdenk		  ethernet is encapsulated/received over 802.1q
2531a3d991bdSwdenk		  VLAN tagged frames.
2532c609719bSwdenk
2533c609719bSwdenkThe following environment variables may be used and automatically
2534c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"),
2535c609719bSwdenkdepending the information provided by your boot server:
2536c609719bSwdenk
2537c609719bSwdenk  bootfile	- see above
2538c609719bSwdenk  dnsip		- IP address of your Domain Name Server
2539fe389a82Sstroese  dnsip2	- IP address of your secondary Domain Name Server
2540c609719bSwdenk  gatewayip	- IP address of the Gateway (Router) to use
2541c609719bSwdenk  hostname	- Target hostname
2542c609719bSwdenk  ipaddr	- see above
2543c609719bSwdenk  netmask	- Subnet Mask
2544c609719bSwdenk  rootpath	- Pathname of the root filesystem on the NFS server
2545c609719bSwdenk  serverip	- see above
2546c609719bSwdenk
2547c609719bSwdenk
2548c609719bSwdenkThere are two special Environment Variables:
2549c609719bSwdenk
2550c609719bSwdenk  serial#	- contains hardware identification information such
2551c609719bSwdenk		  as type string and/or serial number
2552c609719bSwdenk  ethaddr	- Ethernet address
2553c609719bSwdenk
2554c609719bSwdenkThese variables can be set only once (usually during manufacturing of
2555c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables
2556c609719bSwdenkonce they have been set once.
2557c609719bSwdenk
2558c609719bSwdenk
2559c1551ea8SstroeseFurther special Environment Variables:
2560c1551ea8Sstroese
2561c1551ea8Sstroese  ver		- Contains the U-Boot version string as printed
2562c1551ea8Sstroese		  with the "version" command. This variable is
2563c1551ea8Sstroese		  readonly (see CONFIG_VERSION_VARIABLE).
2564c1551ea8Sstroese
2565c1551ea8Sstroese
2566c609719bSwdenkPlease note that changes to some configuration parameters may take
2567c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-).
2568c609719bSwdenk
2569c609719bSwdenk
2570f07771ccSwdenkCommand Line Parsing:
2571f07771ccSwdenk=====================
2572f07771ccSwdenk
2573f07771ccSwdenkThere are two different command line parsers available with U-Boot:
25747152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell:
2575f07771ccSwdenk
2576f07771ccSwdenkOld, simple command line parser:
2577f07771ccSwdenk--------------------------------
2578f07771ccSwdenk
2579f07771ccSwdenk- supports environment variables (through setenv / saveenv commands)
2580f07771ccSwdenk- several commands on one line, separated by ';'
2581fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax
2582f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\',
2583f07771ccSwdenk  for example:
2584fe126d8bSWolfgang Denk	setenv bootcmd bootm \${address}
2585f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example:
2586f07771ccSwdenk	setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
2587f07771ccSwdenk
2588f07771ccSwdenkHush shell:
2589f07771ccSwdenk-----------
2590f07771ccSwdenk
2591f07771ccSwdenk- similar to Bourne shell, with control structures like
2592f07771ccSwdenk  if...then...else...fi, for...do...done; while...do...done,
2593f07771ccSwdenk  until...do...done, ...
2594f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv
2595f07771ccSwdenk  commands) and local shell variables (through standard shell syntax
2596f07771ccSwdenk  "name=value"); only environment variables can be used with "run"
2597f07771ccSwdenk  command
2598f07771ccSwdenk
2599f07771ccSwdenkGeneral rules:
2600f07771ccSwdenk--------------
2601f07771ccSwdenk
2602f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run"
2603f07771ccSwdenk    command) contains several commands separated by semicolon, and
2604f07771ccSwdenk    one of these commands fails, then the remaining commands will be
2605f07771ccSwdenk    executed anyway.
2606f07771ccSwdenk
2607f07771ccSwdenk(2) If you execute several variables with one call to run (i. e.
2608f07771ccSwdenk    calling run with a list af variables as arguments), any failing
2609f07771ccSwdenk    command will cause "run" to terminate, i. e. the remaining
2610f07771ccSwdenk    variables are not executed.
2611f07771ccSwdenk
2612c609719bSwdenkNote for Redundant Ethernet Interfaces:
2613c609719bSwdenk=======================================
2614c609719bSwdenk
26157152b1d0SwdenkSome boards come with redundant ethernet interfaces; U-Boot supports
2616c609719bSwdenksuch configurations and is capable of automatic selection of a
26177152b1d0Swdenk"working" interface when needed. MAC assignment works as follows:
2618c609719bSwdenk
2619c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding
2620c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0),
2621c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ...
2622c609719bSwdenk
2623c609719bSwdenkIf the network interface stores some valid MAC address (for instance
2624c609719bSwdenkin SROM), this is used as default address if there is NO correspon-
2625c609719bSwdenkding setting in the environment; if the corresponding environment
2626c609719bSwdenkvariable is set, this overrides the settings in the card; that means:
2627c609719bSwdenk
2628c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the
2629c609719bSwdenk  environment, the SROM's address is used.
2630c609719bSwdenk
2631c609719bSwdenko If there is no valid address in the SROM, and a definition in the
2632c609719bSwdenk  environment exists, then the value from the environment variable is
2633c609719bSwdenk  used.
2634c609719bSwdenk
2635c609719bSwdenko If both the SROM and the environment contain a MAC address, and
2636c609719bSwdenk  both addresses are the same, this MAC address is used.
2637c609719bSwdenk
2638c609719bSwdenko If both the SROM and the environment contain a MAC address, and the
2639c609719bSwdenk  addresses differ, the value from the environment is used and a
2640c609719bSwdenk  warning is printed.
2641c609719bSwdenk
2642c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error
2643c609719bSwdenk  is raised.
2644c609719bSwdenk
2645c609719bSwdenk
2646c609719bSwdenkImage Formats:
2647c609719bSwdenk==============
2648c609719bSwdenk
2649c609719bSwdenkThe "boot" commands of this monitor operate on "image" files which
2650c609719bSwdenkcan be basicly anything, preceeded by a special header; see the
2651c609719bSwdenkdefinitions in include/image.h for details; basicly, the header
2652c609719bSwdenkdefines the following image properties:
2653c609719bSwdenk
2654c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
2655c609719bSwdenk  4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
26567f70e853Swdenk  LynxOS, pSOS, QNX, RTEMS, ARTOS;
26571f4bb37dSwdenk  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, ARTOS, LynxOS).
2658c609719bSwdenk* Target CPU Architecture (Provisions for Alpha, ARM, Intel x86,
26593d1e8a9dSwdenk  IA64, MIPS, NIOS, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
26603d1e8a9dSwdenk  Currently supported: ARM, Intel x86, MIPS, NIOS, PowerPC).
2661c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2)
2662c609719bSwdenk* Load Address
2663c609719bSwdenk* Entry Point
2664c609719bSwdenk* Image Name
2665c609719bSwdenk* Image Timestamp
2666c609719bSwdenk
2667c609719bSwdenkThe header is marked by a special Magic Number, and both the header
2668c609719bSwdenkand the data portions of the image are secured against corruption by
2669c609719bSwdenkCRC32 checksums.
2670c609719bSwdenk
2671c609719bSwdenk
2672c609719bSwdenkLinux Support:
2673c609719bSwdenk==============
2674c609719bSwdenk
2675c609719bSwdenkAlthough U-Boot should support any OS or standalone application
26767152b1d0Swdenkeasily, the main focus has always been on Linux during the design of
2677c609719bSwdenkU-Boot.
2678c609719bSwdenk
2679c609719bSwdenkU-Boot includes many features that so far have been part of some
2680c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any
2681c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image;
2682c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation
26837152b1d0Swdenkserves several purposes:
2684c609719bSwdenk
2685c609719bSwdenk- the same features can be used for other OS or standalone
2686c609719bSwdenk  applications (for instance: using compressed images to reduce the
2687c609719bSwdenk  Flash memory footprint)
2688c609719bSwdenk
2689c609719bSwdenk- it becomes much easier to port new Linux kernel versions because
26907152b1d0Swdenk  lots of low-level, hardware dependent stuff are done by U-Boot
2691c609719bSwdenk
2692c609719bSwdenk- the same Linux kernel image can now be used with different "initrd"
2693c609719bSwdenk  images; of course this also means that different kernel images can
2694c609719bSwdenk  be run with the same "initrd". This makes testing easier (you don't
2695c609719bSwdenk  have to build a new "zImage.initrd" Linux image when you just
2696c609719bSwdenk  change a file in your "initrd"). Also, a field-upgrade of the
2697c609719bSwdenk  software is easier now.
2698c609719bSwdenk
2699c609719bSwdenk
2700c609719bSwdenkLinux HOWTO:
2701c609719bSwdenk============
2702c609719bSwdenk
2703c609719bSwdenkPorting Linux to U-Boot based systems:
2704c609719bSwdenk---------------------------------------
2705c609719bSwdenk
2706c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to
2707c609719bSwdenkconfigure the Linux device drivers for use with your target hardware
2708c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to
2709c609719bSwdenkLinux :-).
2710c609719bSwdenk
2711c609719bSwdenkBut now you can ignore ALL boot loader code (in arch/ppc/mbxboot).
2712c609719bSwdenk
2713c609719bSwdenkJust make sure your machine specific header file (for instance
2714c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board
2715c609719bSwdenkInformation structure as we define in include/u-boot.h, and make
2716c609719bSwdenksure that your definition of IMAP_ADDR uses the same value as your
2717c609719bSwdenkU-Boot configuration in CFG_IMMR.
2718c609719bSwdenk
2719c609719bSwdenk
2720c609719bSwdenkConfiguring the Linux kernel:
2721c609719bSwdenk-----------------------------
2722c609719bSwdenk
2723c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root
2724c609719bSwdenkdevice (initial ramdisk, NFS) for your target system.
2725c609719bSwdenk
2726c609719bSwdenk
2727c609719bSwdenkBuilding a Linux Image:
2728c609719bSwdenk-----------------------
2729c609719bSwdenk
273024ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are
273124ee89b9Swdenknot used. If you use recent kernel source, a new build target
273224ee89b9Swdenk"uImage" will exist which automatically builds an image usable by
273324ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target,
273424ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a
273524ee89b9Swdenk100% compatible format.
2736c609719bSwdenk
2737c609719bSwdenkExample:
2738c609719bSwdenk
2739c609719bSwdenk	make TQM850L_config
2740c609719bSwdenk	make oldconfig
2741c609719bSwdenk	make dep
274224ee89b9Swdenk	make uImage
2743c609719bSwdenk
274424ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to
274524ee89b9Swdenkencapsulate a compressed Linux kernel image with header	 information,
274624ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing:
2747c609719bSwdenk
274824ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format):
274924ee89b9Swdenk
275024ee89b9Swdenk* convert the kernel into a raw binary image:
275124ee89b9Swdenk
275224ee89b9Swdenk	${CROSS_COMPILE}-objcopy -O binary \
275324ee89b9Swdenk				 -R .note -R .comment \
275424ee89b9Swdenk				 -S vmlinux linux.bin
275524ee89b9Swdenk
275624ee89b9Swdenk* compress the binary image:
275724ee89b9Swdenk
275824ee89b9Swdenk	gzip -9 linux.bin
275924ee89b9Swdenk
276024ee89b9Swdenk* package compressed binary image for U-Boot:
276124ee89b9Swdenk
276224ee89b9Swdenk	mkimage -A ppc -O linux -T kernel -C gzip \
276324ee89b9Swdenk		-a 0 -e 0 -n "Linux Kernel Image" \
276424ee89b9Swdenk		-d linux.bin.gz uImage
276524ee89b9Swdenk
276624ee89b9Swdenk
276724ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use
276824ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or
276924ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64
277024ee89b9Swdenkbyte header containing information about target architecture,
277124ee89b9Swdenkoperating system, image type, compression method, entry points, time
277224ee89b9Swdenkstamp, CRC32 checksums, etc.
277324ee89b9Swdenk
277424ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and
277524ee89b9Swdenkprint the header information, or to build new images.
2776c609719bSwdenk
2777c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information
2778c609719bSwdenkcontained in the header of an existing U-Boot image; this includes
2779c609719bSwdenkchecksum verification:
2780c609719bSwdenk
2781c609719bSwdenk	tools/mkimage -l image
2782c609719bSwdenk	  -l ==> list image header information
2783c609719bSwdenk
2784c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image
2785c609719bSwdenkfrom a "data file" which is used as image payload:
2786c609719bSwdenk
2787c609719bSwdenk	tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
2788c609719bSwdenk		      -n name -d data_file image
2789c609719bSwdenk	  -A ==> set architecture to 'arch'
2790c609719bSwdenk	  -O ==> set operating system to 'os'
2791c609719bSwdenk	  -T ==> set image type to 'type'
2792c609719bSwdenk	  -C ==> set compression type 'comp'
2793c609719bSwdenk	  -a ==> set load address to 'addr' (hex)
2794c609719bSwdenk	  -e ==> set entry point to 'ep' (hex)
2795c609719bSwdenk	  -n ==> set image name to 'name'
2796c609719bSwdenk	  -d ==> use image data from 'datafile'
2797c609719bSwdenk
279869459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load
279969459791Swdenkaddress (0x00000000), but the entry point address depends on the
280069459791Swdenkkernel version:
2801c609719bSwdenk
2802c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C,
280324ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000.
2804c609719bSwdenk
2805c609719bSwdenkSo a typical call to build a U-Boot image would read:
2806c609719bSwdenk
280724ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
280824ee89b9Swdenk	> -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
280924ee89b9Swdenk	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz \
281024ee89b9Swdenk	> examples/uImage.TQM850L
281124ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
2812c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
2813c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
2814c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
2815c609719bSwdenk	Load Address: 0x00000000
281624ee89b9Swdenk	Entry Point:  0x00000000
2817c609719bSwdenk
2818c609719bSwdenkTo verify the contents of the image (or check for corruption):
2819c609719bSwdenk
282024ee89b9Swdenk	-> tools/mkimage -l examples/uImage.TQM850L
282124ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
2822c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
2823c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
2824c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
2825c609719bSwdenk	Load Address: 0x00000000
282624ee89b9Swdenk	Entry Point:  0x00000000
2827c609719bSwdenk
2828c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade
2829c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this
2830c609719bSwdenkneeds more space in Flash, but boots much faster since it does not
2831c609719bSwdenkneed to be uncompressed:
2832c609719bSwdenk
283324ee89b9Swdenk	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz
283424ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
283524ee89b9Swdenk	> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
283624ee89b9Swdenk	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux \
283724ee89b9Swdenk	> examples/uImage.TQM850L-uncompressed
283824ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
2839c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
2840c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (uncompressed)
2841c609719bSwdenk	Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
2842c609719bSwdenk	Load Address: 0x00000000
284324ee89b9Swdenk	Entry Point:  0x00000000
2844c609719bSwdenk
2845c609719bSwdenk
2846c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file
2847c609719bSwdenkwhen your kernel is intended to use an initial ramdisk:
2848c609719bSwdenk
2849c609719bSwdenk	-> tools/mkimage -n 'Simple Ramdisk Image' \
2850c609719bSwdenk	> -A ppc -O linux -T ramdisk -C gzip \
2851c609719bSwdenk	> -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
2852c609719bSwdenk	Image Name:   Simple Ramdisk Image
2853c609719bSwdenk	Created:      Wed Jan 12 14:01:50 2000
2854c609719bSwdenk	Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
2855c609719bSwdenk	Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
2856c609719bSwdenk	Load Address: 0x00000000
2857c609719bSwdenk	Entry Point:  0x00000000
2858c609719bSwdenk
2859c609719bSwdenk
2860c609719bSwdenkInstalling a Linux Image:
2861c609719bSwdenk-------------------------
2862c609719bSwdenk
2863c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface,
2864c609719bSwdenkyou must convert the image to S-Record format:
2865c609719bSwdenk
2866c609719bSwdenk	objcopy -I binary -O srec examples/image examples/image.srec
2867c609719bSwdenk
2868c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot
2869c609719bSwdenkimage header, so the resulting S-Record file will be relative to
2870c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to
2871c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads'
2872c609719bSwdenkcommand.
2873c609719bSwdenk
2874c609719bSwdenkExample: install the image to address 0x40100000 (which on the
2875c609719bSwdenkTQM8xxL is in the first Flash bank):
2876c609719bSwdenk
2877c609719bSwdenk	=> erase 40100000 401FFFFF
2878c609719bSwdenk
2879c609719bSwdenk	.......... done
2880c609719bSwdenk	Erased 8 sectors
2881c609719bSwdenk
2882c609719bSwdenk	=> loads 40100000
2883c609719bSwdenk	## Ready for S-Record download ...
2884c609719bSwdenk	~>examples/image.srec
2885c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 12 13 ...
2886c609719bSwdenk	...
2887c609719bSwdenk	15989 15990 15991 15992
2888c609719bSwdenk	[file transfer complete]
2889c609719bSwdenk	[connected]
2890c609719bSwdenk	## Start Addr = 0x00000000
2891c609719bSwdenk
2892c609719bSwdenk
2893c609719bSwdenkYou can check the success of the download using the 'iminfo' command;
2894c609719bSwdenkthis includes a checksum verification so you  can  be  sure  no	 data
2895c609719bSwdenkcorruption happened:
2896c609719bSwdenk
2897c609719bSwdenk	=> imi 40100000
2898c609719bSwdenk
2899c609719bSwdenk	## Checking Image at 40100000 ...
2900c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
2901c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
2902c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
2903c609719bSwdenk	   Load Address: 00000000
2904c609719bSwdenk	   Entry Point:	 0000000c
2905c609719bSwdenk	   Verifying Checksum ... OK
2906c609719bSwdenk
2907c609719bSwdenk
2908c609719bSwdenkBoot Linux:
2909c609719bSwdenk-----------
2910c609719bSwdenk
2911c609719bSwdenkThe "bootm" command is used to boot an application that is stored in
2912c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents
2913c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as
2914c609719bSwdenkparameters. You can check and modify this variable using the
2915c609719bSwdenk"printenv" and "setenv" commands:
2916c609719bSwdenk
2917c609719bSwdenk
2918c609719bSwdenk	=> printenv bootargs
2919c609719bSwdenk	bootargs=root=/dev/ram
2920c609719bSwdenk
2921c609719bSwdenk	=> setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
2922c609719bSwdenk
2923c609719bSwdenk	=> printenv bootargs
2924c609719bSwdenk	bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
2925c609719bSwdenk
2926c609719bSwdenk	=> bootm 40020000
2927c609719bSwdenk	## Booting Linux kernel at 40020000 ...
2928c609719bSwdenk	   Image Name:	 2.2.13 for NFS on TQM850L
2929c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
2930c609719bSwdenk	   Data Size:	 381681 Bytes = 372 kB = 0 MB
2931c609719bSwdenk	   Load Address: 00000000
2932c609719bSwdenk	   Entry Point:	 0000000c
2933c609719bSwdenk	   Verifying Checksum ... OK
2934c609719bSwdenk	   Uncompressing Kernel Image ... OK
2935c609719bSwdenk	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
2936c609719bSwdenk	Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
2937c609719bSwdenk	time_init: decrementer frequency = 187500000/60
2938c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
2939c609719bSwdenk	Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
2940c609719bSwdenk	...
2941c609719bSwdenk
2942c609719bSwdenkIf you want to boot a Linux kernel with initial ram disk, you pass
29437152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT
2944c609719bSwdenkformat!) to the "bootm" command:
2945c609719bSwdenk
2946c609719bSwdenk	=> imi 40100000 40200000
2947c609719bSwdenk
2948c609719bSwdenk	## Checking Image at 40100000 ...
2949c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
2950c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
2951c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
2952c609719bSwdenk	   Load Address: 00000000
2953c609719bSwdenk	   Entry Point:	 0000000c
2954c609719bSwdenk	   Verifying Checksum ... OK
2955c609719bSwdenk
2956c609719bSwdenk	## Checking Image at 40200000 ...
2957c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
2958c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
2959c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
2960c609719bSwdenk	   Load Address: 00000000
2961c609719bSwdenk	   Entry Point:	 00000000
2962c609719bSwdenk	   Verifying Checksum ... OK
2963c609719bSwdenk
2964c609719bSwdenk	=> bootm 40100000 40200000
2965c609719bSwdenk	## Booting Linux kernel at 40100000 ...
2966c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
2967c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
2968c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
2969c609719bSwdenk	   Load Address: 00000000
2970c609719bSwdenk	   Entry Point:	 0000000c
2971c609719bSwdenk	   Verifying Checksum ... OK
2972c609719bSwdenk	   Uncompressing Kernel Image ... OK
2973c609719bSwdenk	## Loading RAMDisk Image at 40200000 ...
2974c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
2975c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
2976c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
2977c609719bSwdenk	   Load Address: 00000000
2978c609719bSwdenk	   Entry Point:	 00000000
2979c609719bSwdenk	   Verifying Checksum ... OK
2980c609719bSwdenk	   Loading Ramdisk ... OK
2981c609719bSwdenk	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
2982c609719bSwdenk	Boot arguments: root=/dev/ram
2983c609719bSwdenk	time_init: decrementer frequency = 187500000/60
2984c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
2985c609719bSwdenk	...
2986c609719bSwdenk	RAMDISK: Compressed image found at block 0
2987c609719bSwdenk	VFS: Mounted root (ext2 filesystem).
2988c609719bSwdenk
2989c609719bSwdenk	bash#
2990c609719bSwdenk
29916069ff26SwdenkMore About U-Boot Image Types:
29926069ff26Swdenk------------------------------
29936069ff26Swdenk
29946069ff26SwdenkU-Boot supports the following image types:
29956069ff26Swdenk
29966069ff26Swdenk   "Standalone Programs" are directly runnable in the environment
29976069ff26Swdenk	provided by U-Boot; it is expected that (if they behave
29986069ff26Swdenk	well) you can continue to work in U-Boot after return from
29996069ff26Swdenk	the Standalone Program.
30006069ff26Swdenk   "OS Kernel Images" are usually images of some Embedded OS which
30016069ff26Swdenk	will take over control completely. Usually these programs
30026069ff26Swdenk	will install their own set of exception handlers, device
30036069ff26Swdenk	drivers, set up the MMU, etc. - this means, that you cannot
30046069ff26Swdenk	expect to re-enter U-Boot except by resetting the CPU.
30056069ff26Swdenk   "RAMDisk Images" are more or less just data blocks, and their
30066069ff26Swdenk	parameters (address, size) are passed to an OS kernel that is
30076069ff26Swdenk	being started.
30086069ff26Swdenk   "Multi-File Images" contain several images, typically an OS
30096069ff26Swdenk	(Linux) kernel image and one or more data images like
30106069ff26Swdenk	RAMDisks. This construct is useful for instance when you want
30116069ff26Swdenk	to boot over the network using BOOTP etc., where the boot
30126069ff26Swdenk	server provides just a single image file, but you want to get
30136069ff26Swdenk	for instance an OS kernel and a RAMDisk image.
30146069ff26Swdenk
30156069ff26Swdenk	"Multi-File Images" start with a list of image sizes, each
30166069ff26Swdenk	image size (in bytes) specified by an "uint32_t" in network
30176069ff26Swdenk	byte order. This list is terminated by an "(uint32_t)0".
30186069ff26Swdenk	Immediately after the terminating 0 follow the images, one by
30196069ff26Swdenk	one, all aligned on "uint32_t" boundaries (size rounded up to
30206069ff26Swdenk	a multiple of 4 bytes).
30216069ff26Swdenk
30226069ff26Swdenk   "Firmware Images" are binary images containing firmware (like
30236069ff26Swdenk	U-Boot or FPGA images) which usually will be programmed to
30246069ff26Swdenk	flash memory.
30256069ff26Swdenk
30266069ff26Swdenk   "Script files" are command sequences that will be executed by
30276069ff26Swdenk	U-Boot's command interpreter; this feature is especially
30286069ff26Swdenk	useful when you configure U-Boot to use a real shell (hush)
30296069ff26Swdenk	as command interpreter.
30306069ff26Swdenk
3031c609719bSwdenk
3032c609719bSwdenkStandalone HOWTO:
3033c609719bSwdenk=================
3034c609719bSwdenk
3035c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and
3036c609719bSwdenkrun "standalone" applications, which can use some resources of
3037c609719bSwdenkU-Boot like console I/O functions or interrupt services.
3038c609719bSwdenk
3039c609719bSwdenkTwo simple examples are included with the sources:
3040c609719bSwdenk
3041c609719bSwdenk"Hello World" Demo:
3042c609719bSwdenk-------------------
3043c609719bSwdenk
3044c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo
3045c609719bSwdenkapplication; it is automatically compiled when you build U-Boot.
3046c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it
3047c609719bSwdenklike that:
3048c609719bSwdenk
3049c609719bSwdenk	=> loads
3050c609719bSwdenk	## Ready for S-Record download ...
3051c609719bSwdenk	~>examples/hello_world.srec
3052c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
3053c609719bSwdenk	[file transfer complete]
3054c609719bSwdenk	[connected]
3055c609719bSwdenk	## Start Addr = 0x00040004
3056c609719bSwdenk
3057c609719bSwdenk	=> go 40004 Hello World! This is a test.
3058c609719bSwdenk	## Starting application at 0x00040004 ...
3059c609719bSwdenk	Hello World
3060c609719bSwdenk	argc = 7
3061c609719bSwdenk	argv[0] = "40004"
3062c609719bSwdenk	argv[1] = "Hello"
3063c609719bSwdenk	argv[2] = "World!"
3064c609719bSwdenk	argv[3] = "This"
3065c609719bSwdenk	argv[4] = "is"
3066c609719bSwdenk	argv[5] = "a"
3067c609719bSwdenk	argv[6] = "test."
3068c609719bSwdenk	argv[7] = "<NULL>"
3069c609719bSwdenk	Hit any key to exit ...
3070c609719bSwdenk
3071c609719bSwdenk	## Application terminated, rc = 0x0
3072c609719bSwdenk
3073c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt
3074c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'.
3075c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second.
3076c609719bSwdenkThe interrupt service routine is trivial, just printing a '.'
3077c609719bSwdenkcharacter, but this is just a demo program. The application can be
3078c609719bSwdenkcontrolled by the following keys:
3079c609719bSwdenk
3080c609719bSwdenk	? - print current values og the CPM Timer registers
3081c609719bSwdenk	b - enable interrupts and start timer
3082c609719bSwdenk	e - stop timer and disable interrupts
3083c609719bSwdenk	q - quit application
3084c609719bSwdenk
3085c609719bSwdenk	=> loads
3086c609719bSwdenk	## Ready for S-Record download ...
3087c609719bSwdenk	~>examples/timer.srec
3088c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
3089c609719bSwdenk	[file transfer complete]
3090c609719bSwdenk	[connected]
3091c609719bSwdenk	## Start Addr = 0x00040004
3092c609719bSwdenk
3093c609719bSwdenk	=> go 40004
3094c609719bSwdenk	## Starting application at 0x00040004 ...
3095c609719bSwdenk	TIMERS=0xfff00980
3096c609719bSwdenk	Using timer 1
3097c609719bSwdenk	  tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
3098c609719bSwdenk
3099c609719bSwdenkHit 'b':
3100c609719bSwdenk	[q, b, e, ?] Set interval 1000000 us
3101c609719bSwdenk	Enabling timer
3102c609719bSwdenkHit '?':
3103c609719bSwdenk	[q, b, e, ?] ........
3104c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
3105c609719bSwdenkHit '?':
3106c609719bSwdenk	[q, b, e, ?] .
3107c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
3108c609719bSwdenkHit '?':
3109c609719bSwdenk	[q, b, e, ?] .
3110c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
3111c609719bSwdenkHit '?':
3112c609719bSwdenk	[q, b, e, ?] .
3113c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
3114c609719bSwdenkHit 'e':
3115c609719bSwdenk	[q, b, e, ?] ...Stopping timer
3116c609719bSwdenkHit 'q':
3117c609719bSwdenk	[q, b, e, ?] ## Application terminated, rc = 0x0
3118c609719bSwdenk
3119c609719bSwdenk
312085ec0bccSwdenkMinicom warning:
312185ec0bccSwdenk================
312285ec0bccSwdenk
31237152b1d0SwdenkOver time, many people have reported problems when trying to use the
312485ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd)
312585ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under
3126f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and
312785ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and
312885ec0bccSwdenkuse "cu" for S-Record download ("loads" command).
312985ec0bccSwdenk
313052f52c14SwdenkNevertheless, if you absolutely want to use it try adding this
313152f52c14Swdenkconfiguration to your "File transfer protocols" section:
313252f52c14Swdenk
313352f52c14Swdenk	   Name	   Program			Name U/D FullScr IO-Red. Multi
313452f52c14Swdenk	X  kermit  /usr/bin/kermit -i -l %l -s	 Y    U	   Y	   N	  N
313552f52c14Swdenk	Y  kermit  /usr/bin/kermit -i -l %l -r	 N    D	   Y	   N	  N
313652f52c14Swdenk
313752f52c14Swdenk
3138c609719bSwdenkNetBSD Notes:
3139c609719bSwdenk=============
3140c609719bSwdenk
3141c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host
3142c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx).
3143c609719bSwdenk
3144c609719bSwdenkBuilding requires a cross environment; it is known to work on
3145c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
3146c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make).
3147c609719bSwdenkNote that the cross-powerpc package does not install include files;
3148c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is
3149c609719bSwdenkmissing.  This file has to be installed and patched manually:
3150c609719bSwdenk
3151c609719bSwdenk	# cd /usr/pkg/cross/powerpc-netbsd/include
3152c609719bSwdenk	# mkdir powerpc
3153c609719bSwdenk	# ln -s powerpc machine
3154c609719bSwdenk	# cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
3155c609719bSwdenk	# ${EDIT} powerpc/ansi.h	## must remove __va_list, _BSD_VA_LIST
3156c609719bSwdenk
3157c609719bSwdenkNative builds *don't* work due to incompatibilities between native
3158c609719bSwdenkand U-Boot include files.
3159c609719bSwdenk
3160c609719bSwdenkBooting assumes that (the first part of) the image booted is a
3161c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel
3162c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source
3163c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
31642a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
3165c609719bSwdenk
3166c609719bSwdenk
3167c609719bSwdenkImplementation Internals:
3168c609719bSwdenk=========================
3169c609719bSwdenk
3170c609719bSwdenkThe following is not intended to be a complete description of every
3171c609719bSwdenkimplementation detail. However, it should help to understand the
3172c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom
3173c609719bSwdenkhardware.
3174c609719bSwdenk
3175c609719bSwdenk
3176c609719bSwdenkInitial Stack, Global Data:
3177c609719bSwdenk---------------------------
3178c609719bSwdenk
3179c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot
3180c609719bSwdenkstarts running out of ROM (flash memory), usually without access to
3181c609719bSwdenksystem RAM (because the memory controller is not initialized yet).
3182c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS
3183c609719bSwdenkis not initialized as zero. To be able to get a C environment working
3184c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation
3185c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU
3186c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and
3187c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be
3188c609719bSwdenklocked as (mis-) used as memory, etc.
3189c609719bSwdenk
31907152b1d0Swdenk	Chris Hallinan posted a good summary of	 these	issues	to  the
319143d9616cSwdenk	u-boot-users mailing list:
319243d9616cSwdenk
319343d9616cSwdenk	Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
319443d9616cSwdenk	From: "Chris Hallinan" <clh@net1plus.com>
319543d9616cSwdenk	Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
319643d9616cSwdenk	...
319743d9616cSwdenk
319843d9616cSwdenk	Correct me if I'm wrong, folks, but the way I understand it
319943d9616cSwdenk	is this: Using DCACHE as initial RAM for Stack, etc, does not
320043d9616cSwdenk	require any physical RAM backing up the cache. The cleverness
320143d9616cSwdenk	is that the cache is being used as a temporary supply of
320243d9616cSwdenk	necessary storage before the SDRAM controller is setup. It's
320343d9616cSwdenk	beyond the scope of this list to expain the details, but you
320443d9616cSwdenk	can see how this works by studying the cache architecture and
320543d9616cSwdenk	operation in the architecture and processor-specific manuals.
320643d9616cSwdenk
320743d9616cSwdenk	OCM is On Chip Memory, which I believe the 405GP has 4K. It
320843d9616cSwdenk	is another option for the system designer to use as an
320943d9616cSwdenk	initial stack/ram area prior to SDRAM being available. Either
321043d9616cSwdenk	option should work for you. Using CS 4 should be fine if your
321143d9616cSwdenk	board designers haven't used it for something that would
321243d9616cSwdenk	cause you grief during the initial boot! It is frequently not
321343d9616cSwdenk	used.
321443d9616cSwdenk
321543d9616cSwdenk	CFG_INIT_RAM_ADDR should be somewhere that won't interfere
321643d9616cSwdenk	with your processor/board/system design. The default value
321743d9616cSwdenk	you will find in any recent u-boot distribution in
32188a316c9bSStefan Roese	walnut.h should work for you. I'd set it to a value larger
321943d9616cSwdenk	than your SDRAM module. If you have a 64MB SDRAM module, set
322043d9616cSwdenk	it above 400_0000. Just make sure your board has no resources
322143d9616cSwdenk	that are supposed to respond to that address! That code in
322243d9616cSwdenk	start.S has been around a while and should work as is when
322343d9616cSwdenk	you get the config right.
322443d9616cSwdenk
322543d9616cSwdenk	-Chris Hallinan
322643d9616cSwdenk	DS4.COM, Inc.
322743d9616cSwdenk
3228c609719bSwdenkIt is essential to remember this, since it has some impact on the C
3229c609719bSwdenkcode for the initialization procedures:
3230c609719bSwdenk
3231c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt
3232c609719bSwdenk  to write it.
3233c609719bSwdenk
3234c609719bSwdenk* Do not use any unitialized global data (or implicitely initialized
3235c609719bSwdenk  as zero data - BSS segment) at all - this is undefined, initiali-
32367152b1d0Swdenk  zation is performed later (when relocating to RAM).
3237c609719bSwdenk
3238c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like
3239c609719bSwdenk  that.
3240c609719bSwdenk
3241c609719bSwdenkHaving only the stack as writable memory limits means we cannot use
3242c609719bSwdenknormal global data to share information beween the code. But it
3243c609719bSwdenkturned out that the implementation of U-Boot can be greatly
3244c609719bSwdenksimplified by making a global data structure (gd_t) available to all
3245c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_
3246c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of
3247c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we
3248c609719bSwdenkplace a pointer (gd) to the global data into a register which we
3249c609719bSwdenkreserve for this purpose.
3250c609719bSwdenk
32517152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the
3252c609719bSwdenkrelevant  (E)ABI  specifications for the current architecture, and by
3253c609719bSwdenkGCC's implementation.
3254c609719bSwdenk
3255c609719bSwdenkFor PowerPC, the following registers have specific use:
3256c609719bSwdenk	R1:	stack pointer
3257c609719bSwdenk	R2:	TOC pointer
3258c609719bSwdenk	R3-R4:	parameter passing and return values
3259c609719bSwdenk	R5-R10: parameter passing
3260c609719bSwdenk	R13:	small data area pointer
3261c609719bSwdenk	R30:	GOT pointer
3262c609719bSwdenk	R31:	frame pointer
3263c609719bSwdenk
3264c609719bSwdenk	(U-Boot also uses R14 as internal GOT pointer.)
3265c609719bSwdenk
3266c609719bSwdenk    ==> U-Boot will use R29 to hold a pointer to the global data
3267c609719bSwdenk
3268c609719bSwdenk    Note: on PPC, we could use a static initializer (since the
3269c609719bSwdenk    address of the global data structure is known at compile time),
3270c609719bSwdenk    but it turned out that reserving a register results in somewhat
3271c609719bSwdenk    smaller code - although the code savings are not that big (on
3272c609719bSwdenk    average for all boards 752 bytes for the whole U-Boot image,
3273c609719bSwdenk    624 text + 127 data).
3274c609719bSwdenk
3275c609719bSwdenkOn ARM, the following registers are used:
3276c609719bSwdenk
3277c609719bSwdenk	R0:	function argument word/integer result
3278c609719bSwdenk	R1-R3:	function argument word
3279c609719bSwdenk	R9:	GOT pointer
3280c609719bSwdenk	R10:	stack limit (used only if stack checking if enabled)
3281c609719bSwdenk	R11:	argument (frame) pointer
3282c609719bSwdenk	R12:	temporary workspace
3283c609719bSwdenk	R13:	stack pointer
3284c609719bSwdenk	R14:	link register
3285c609719bSwdenk	R15:	program counter
3286c609719bSwdenk
3287c609719bSwdenk    ==> U-Boot will use R8 to hold a pointer to the global data
3288c609719bSwdenk
3289c609719bSwdenk
3290c609719bSwdenkMemory Management:
3291c609719bSwdenk------------------
3292c609719bSwdenk
3293c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the
3294c609719bSwdenkMMU is not used either for address mapping nor for memory protection.
3295c609719bSwdenk
3296c609719bSwdenkThe available memory is mapped to fixed addresses using the memory
3297c609719bSwdenkcontroller. In this process, a contiguous block is formed for each
3298c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several
3299c609719bSwdenkphysical memory banks.
3300c609719bSwdenk
3301c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on
3302c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
3303c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself
3304c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some
3305c609719bSwdenkmemory is reserved for use by malloc() [see CFG_MALLOC_LEN
3306c609719bSwdenkconfiguration setting]. Below that, a structure with global Board
3307c609719bSwdenkInfo data is placed, followed by the stack (growing downward).
3308c609719bSwdenk
3309c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB
3310c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF).
3311c609719bSwdenk
3312c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like
3313c609719bSwdenkthis:
3314c609719bSwdenk
3315c609719bSwdenk	0x0000 0000	Exception Vector code
3316c609719bSwdenk	      :
3317c609719bSwdenk	0x0000 1FFF
3318c609719bSwdenk	0x0000 2000	Free for Application Use
3319c609719bSwdenk	      :
3320c609719bSwdenk	      :
3321c609719bSwdenk
3322c609719bSwdenk	      :
3323c609719bSwdenk	      :
3324c609719bSwdenk	0x00FB FF20	Monitor Stack (Growing downward)
3325c609719bSwdenk	0x00FB FFAC	Board Info Data and permanent copy of global data
3326c609719bSwdenk	0x00FC 0000	Malloc Arena
3327c609719bSwdenk	      :
3328c609719bSwdenk	0x00FD FFFF
3329c609719bSwdenk	0x00FE 0000	RAM Copy of Monitor Code
3330c609719bSwdenk	...		eventually: LCD or video framebuffer
3331c609719bSwdenk	...		eventually: pRAM (Protected RAM - unchanged by reset)
3332c609719bSwdenk	0x00FF FFFF	[End of RAM]
3333c609719bSwdenk
3334c609719bSwdenk
3335c609719bSwdenkSystem Initialization:
3336c609719bSwdenk----------------------
3337c609719bSwdenk
3338c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point
3339c609719bSwdenk(on most PowerPC systens at address 0x00000100). Because of the reset
3340c609719bSwdenkconfiguration for CS0# this is a mirror of the onboard Flash memory.
33417152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address.
3342c609719bSwdenkTo be able to implement the initialization code in C, a (small!)
3343c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs
3344c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked
3345c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core,
3346c609719bSwdenkthe caches and the SIU.
3347c609719bSwdenk
3348c609719bSwdenkNext, all (potentially) available memory banks are mapped using a
3349c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries
3350c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
3351c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
3352c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a
3353c609719bSwdenksimple memory test is run that determines the size of the SDRAM
3354c609719bSwdenkbanks.
3355c609719bSwdenk
3356c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of
33577152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first
3358c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address
3359c609719bSwdenk0x00000000, with any additional banks following immediately to create
3360c609719bSwdenkcontiguous memory starting from 0.
3361c609719bSwdenk
3362c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area
3363c609719bSwdenkand allocates memory for use by malloc() and for the global Board
3364c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM
3365c609719bSwdenkpages, and the final stack is set up.
3366c609719bSwdenk
3367c609719bSwdenkOnly after this relocation will you have a "normal" C environment;
3368c609719bSwdenkuntil that you are restricted in several ways, mostly because you are
3369c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a
3370c609719bSwdenknew address in RAM.
3371c609719bSwdenk
3372c609719bSwdenk
3373c609719bSwdenkU-Boot Porting Guide:
3374c609719bSwdenk----------------------
3375c609719bSwdenk
3376c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
33776aff3115Swdenklist, October 2002]
3378c609719bSwdenk
3379c609719bSwdenk
3380c609719bSwdenkint main (int argc, char *argv[])
3381c609719bSwdenk{
3382c609719bSwdenk	sighandler_t no_more_time;
3383c609719bSwdenk
3384c609719bSwdenk	signal (SIGALRM, no_more_time);
3385c609719bSwdenk	alarm (PROJECT_DEADLINE - toSec (3 * WEEK));
3386c609719bSwdenk
3387c609719bSwdenk	if (available_money > available_manpower) {
3388c609719bSwdenk		pay consultant to port U-Boot;
3389c609719bSwdenk		return 0;
3390c609719bSwdenk	}
3391c609719bSwdenk
3392c609719bSwdenk	Download latest U-Boot source;
3393c609719bSwdenk
33946aff3115Swdenk	Subscribe to u-boot-users mailing list;
33956aff3115Swdenk
3396c609719bSwdenk	if (clueless) {
3397c609719bSwdenk		email ("Hi, I am new to U-Boot, how do I get started?");
3398c609719bSwdenk	}
3399c609719bSwdenk
3400c609719bSwdenk	while (learning) {
3401c609719bSwdenk		Read the README file in the top level directory;
34027cb22f97Swdenk		Read http://www.denx.de/twiki/bin/view/DULG/Manual ;
3403c609719bSwdenk		Read the source, Luke;
3404c609719bSwdenk	}
3405c609719bSwdenk
3406c609719bSwdenk	if (available_money > toLocalCurrency ($2500)) {
3407c609719bSwdenk		Buy a BDI2000;
3408c609719bSwdenk	} else {
3409c609719bSwdenk		Add a lot of aggravation and time;
3410c609719bSwdenk	}
3411c609719bSwdenk
3412c609719bSwdenk	Create your own board support subdirectory;
3413c609719bSwdenk
34146aff3115Swdenk	Create your own board config file;
34156aff3115Swdenk
3416c609719bSwdenk	while (!running) {
3417c609719bSwdenk		do {
3418c609719bSwdenk			Add / modify source code;
3419c609719bSwdenk		} until (compiles);
3420c609719bSwdenk		Debug;
3421c609719bSwdenk		if (clueless)
3422c609719bSwdenk			email ("Hi, I am having problems...");
3423c609719bSwdenk	}
3424c609719bSwdenk	Send patch file to Wolfgang;
3425c609719bSwdenk
3426c609719bSwdenk	return 0;
3427c609719bSwdenk}
3428c609719bSwdenk
3429c609719bSwdenkvoid no_more_time (int sig)
3430c609719bSwdenk{
3431c609719bSwdenk      hire_a_guru();
3432c609719bSwdenk}
3433c609719bSwdenk
3434c609719bSwdenk
3435c609719bSwdenkCoding Standards:
3436c609719bSwdenk-----------------
3437c609719bSwdenk
3438c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel
3439c609719bSwdenkcoding style; see the file "Documentation/CodingStyle" in your Linux
3440c609719bSwdenkkernel source directory.
3441c609719bSwdenk
3442c609719bSwdenkPlease note that U-Boot is implemented in C (and to some small parts
3443c609719bSwdenkin Assembler); no C++ is used, so please do not use C++ style
3444c609719bSwdenkcomments (//) in your code.
3445c609719bSwdenk
3446c178d3daSwdenkPlease also stick to the following formatting rules:
3447180d3f74Swdenk- remove any trailing white space
3448180d3f74Swdenk- use TAB characters for indentation, not spaces
3449180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds
3450180d3f74Swdenk- do not add more than 2 empty lines to source files
3451180d3f74Swdenk- do not add trailing empty lines to source files
3452180d3f74Swdenk
3453c609719bSwdenkSubmissions which do not conform to the standards may be returned
3454c609719bSwdenkwith a request to reformat the changes.
3455c609719bSwdenk
3456c609719bSwdenk
3457c609719bSwdenkSubmitting Patches:
3458c609719bSwdenk-------------------
3459c609719bSwdenk
3460c609719bSwdenkSince the number of patches for U-Boot is growing, we need to
3461c609719bSwdenkestablish some rules. Submissions which do not conform to these rules
3462c609719bSwdenkmay be rejected, even when they contain important and valuable stuff.
3463c609719bSwdenk
346490dc6704SwdenkPatches shall be sent to the u-boot-users mailing list.
3465c609719bSwdenk
3466c609719bSwdenkWhen you send a patch, please include the following information with
3467c609719bSwdenkit:
3468c609719bSwdenk
3469c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes
3470c609719bSwdenk  this bug. Please try to include a way of demonstrating that the
3471c609719bSwdenk  patch actually fixes something.
3472c609719bSwdenk
3473c609719bSwdenk* For new features: a description of the feature and your
3474c609719bSwdenk  implementation.
3475c609719bSwdenk
3476c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch)
3477c609719bSwdenk
3478c609719bSwdenk* For major contributions, your entry to the CREDITS file
3479c609719bSwdenk
3480c609719bSwdenk* When you add support for a new board, don't forget to add this
3481c609719bSwdenk  board to the MAKEALL script, too.
3482c609719bSwdenk
3483c609719bSwdenk* If your patch adds new configuration options, don't forget to
3484c609719bSwdenk  document these in the README file.
3485c609719bSwdenk
3486c609719bSwdenk* The patch itself. If you are accessing the CVS repository use "cvs
3487c609719bSwdenk  update; cvs diff -puRN"; else, use "diff -purN OLD NEW". If your
3488c609719bSwdenk  version of diff does not support these options, then get the latest
3489c609719bSwdenk  version of GNU diff.
3490c609719bSwdenk
34916dff5529Swdenk  The current directory when running this command shall be the top
34926dff5529Swdenk  level directory of the U-Boot source tree, or it's parent directory
34936dff5529Swdenk  (i. e. please make sure that your patch includes sufficient
34946dff5529Swdenk  directory information for the affected files).
34956dff5529Swdenk
3496c609719bSwdenk  We accept patches as plain text, MIME attachments or as uuencoded
3497c609719bSwdenk  gzipped text.
3498c609719bSwdenk
349952f52c14Swdenk* If one logical set of modifications affects or creates several
350052f52c14Swdenk  files, all these changes shall be submitted in a SINGLE patch file.
350152f52c14Swdenk
350252f52c14Swdenk* Changesets that contain different, unrelated modifications shall be
350352f52c14Swdenk  submitted as SEPARATE patches, one patch per changeset.
350452f52c14Swdenk
350552f52c14Swdenk
3506c609719bSwdenkNotes:
3507c609719bSwdenk
3508c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched
3509c609719bSwdenk  source tree and make sure that no errors or warnings are reported
3510c609719bSwdenk  for any of the boards.
3511c609719bSwdenk
3512c609719bSwdenk* Keep your modifications to the necessary minimum: A patch
3513c609719bSwdenk  containing several unrelated changes or arbitrary reformats will be
3514c609719bSwdenk  returned with a request to re-formatting / split it.
3515c609719bSwdenk
3516c609719bSwdenk* If you modify existing code, make sure that your new code does not
3517c609719bSwdenk  add to the memory footprint of the code ;-) Small is beautiful!
3518c609719bSwdenk  When adding new features, these should compile conditionally only
3519c609719bSwdenk  (using #ifdef), and the resulting code with the new feature
3520c609719bSwdenk  disabled must not need more memory than the old code without your
3521c609719bSwdenk  modification.
352290dc6704Swdenk
352390dc6704Swdenk* Remember that there is a size limit of 40 kB per message on the
352490dc6704Swdenk  u-boot-users mailing list. Compression may help.
3525