xref: /openbmc/u-boot/README (revision c26e454d)
1c609719bSwdenk#
23a473b2aSwdenk# (C) Copyright 2000 - 2004
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
2824ee89b9SwdenkEmbedded boards based on PowerPC and ARM processors, which can be
2924ee89b9Swdenkinstalled in a boot ROM and used to initialize and test the hardware
3024ee89b9Swdenkor to download and run application code.
31c609719bSwdenk
32c609719bSwdenkThe development of U-Boot is closely related to Linux: some parts of
3324ee89b9Swdenkthe source code originate in the Linux source tree, we have some
3424ee89b9Swdenkheader files in common, and special provision has been made to
35c609719bSwdenksupport booting of Linux images.
36c609719bSwdenk
37c609719bSwdenkSome attention has been paid to make this software easily
38c609719bSwdenkconfigurable and extendable. For instance, all monitor commands are
39c609719bSwdenkimplemented with the same call interface, so that it's very easy to
40c609719bSwdenkadd new commands. Also, instead of permanently adding rarely used
41c609719bSwdenkcode (for instance hardware test utilities) to the monitor, you can
42c609719bSwdenkload and run it dynamically.
43c609719bSwdenk
44c609719bSwdenk
45c609719bSwdenkStatus:
46c609719bSwdenk=======
47c609719bSwdenk
48c609719bSwdenkIn general, all boards for which a configuration option exists in the
49c609719bSwdenkMakefile have been tested to some extent and can be considered
50c609719bSwdenk"working". In fact, many of them are used in production systems.
51c609719bSwdenk
52c609719bSwdenkIn case of problems see the CHANGELOG and CREDITS files to find out
53c609719bSwdenkwho contributed the specific port.
54c609719bSwdenk
55c609719bSwdenk
56c609719bSwdenkWhere to get help:
57c609719bSwdenk==================
58c609719bSwdenk
59c609719bSwdenkIn case you have questions about, problems with or contributions for
60c609719bSwdenkU-Boot you should send a message to the U-Boot mailing list at
61c609719bSwdenk<u-boot-users@lists.sourceforge.net>. There is also an archive of
62c609719bSwdenkprevious traffic on the mailing list - please search the archive
63c609719bSwdenkbefore asking FAQ's. Please see
64c609719bSwdenkhttp://lists.sourceforge.net/lists/listinfo/u-boot-users/
65c609719bSwdenk
66c609719bSwdenk
67c609719bSwdenkWhere we come from:
68c609719bSwdenk===================
69c609719bSwdenk
70c609719bSwdenk- start from 8xxrom sources
7124ee89b9Swdenk- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
72c609719bSwdenk- clean up code
73c609719bSwdenk- make it easier to add custom boards
74c609719bSwdenk- make it possible to add other [PowerPC] CPUs
75c609719bSwdenk- extend functions, especially:
76c609719bSwdenk  * Provide extended interface to Linux boot loader
77c609719bSwdenk  * S-Record download
78c609719bSwdenk  * network boot
79c609719bSwdenk  * PCMCIA / CompactFLash / ATA disk / SCSI ... boot
8024ee89b9Swdenk- create ARMBoot project (http://sourceforge.net/projects/armboot)
81c609719bSwdenk- add other CPU families (starting with ARM)
8224ee89b9Swdenk- create U-Boot project (http://sourceforge.net/projects/u-boot)
8324ee89b9Swdenk
8424ee89b9Swdenk
8524ee89b9SwdenkNames and Spelling:
8624ee89b9Swdenk===================
8724ee89b9Swdenk
8824ee89b9SwdenkThe "official" name of this project is "Das U-Boot". The spelling
8924ee89b9Swdenk"U-Boot" shall be used in all written text (documentation, comments
9024ee89b9Swdenkin source files etc.). Example:
9124ee89b9Swdenk
9224ee89b9Swdenk	This is the README file for the U-Boot project.
9324ee89b9Swdenk
9424ee89b9SwdenkFile names etc. shall be based on the string "u-boot". Examples:
9524ee89b9Swdenk
9624ee89b9Swdenk	include/asm-ppc/u-boot.h
9724ee89b9Swdenk
9824ee89b9Swdenk	#include <asm/u-boot.h>
9924ee89b9Swdenk
10024ee89b9SwdenkVariable names, preprocessor constants etc. shall be either based on
10124ee89b9Swdenkthe string "u_boot" or on "U_BOOT". Example:
10224ee89b9Swdenk
10324ee89b9Swdenk	U_BOOT_VERSION		u_boot_logo
10424ee89b9Swdenk	IH_OS_U_BOOT		u_boot_hush_start
105c609719bSwdenk
106c609719bSwdenk
10793f19cc0SwdenkVersioning:
10893f19cc0Swdenk===========
10993f19cc0Swdenk
11093f19cc0SwdenkU-Boot uses a 3 level version number containing a version, a
11193f19cc0Swdenksub-version, and a patchlevel: "U-Boot-2.34.5" means version "2",
11293f19cc0Swdenksub-version "34", and patchlevel "4".
11393f19cc0Swdenk
11493f19cc0SwdenkThe patchlevel is used to indicate certain stages of development
11593f19cc0Swdenkbetween released versions, i. e. officially released versions of
11693f19cc0SwdenkU-Boot will always have a patchlevel of "0".
11793f19cc0Swdenk
11893f19cc0Swdenk
119c609719bSwdenkDirectory Hierarchy:
120c609719bSwdenk====================
121c609719bSwdenk
1227152b1d0Swdenk- board		Board dependent files
1237152b1d0Swdenk- common	Misc architecture independent functions
124c609719bSwdenk- cpu		CPU specific files
12511dadd54Swdenk  - 74xx_7xx	Files specific to Motorola MPC74xx and 7xx CPUs
12611dadd54Swdenk  - arm720t	Files specific to ARM 720 CPUs
12711dadd54Swdenk  - arm920t	Files specific to ARM 920 CPUs
12811dadd54Swdenk  - arm925t	Files specific to ARM 925 CPUs
12911dadd54Swdenk  - arm926ejs	Files specific to ARM 926 CPUs
13011dadd54Swdenk  - at91rm9200	Files specific to Atmel AT91RM9200 CPUs
13111dadd54Swdenk  - i386	Files specific to i386 CPUs
13211dadd54Swdenk  - ixp		Files specific to Intel XScale IXP CPUs
13311dadd54Swdenk  - mcf52x2	Files specific to Motorola ColdFire MCF52x2 CPUs
13411dadd54Swdenk  - mips	Files specific to MIPS CPUs
13511dadd54Swdenk  - mpc5xx	Files specific to Motorola MPC5xx  CPUs
13611dadd54Swdenk  - mpc5xxx	Files specific to Motorola MPC5xxx CPUs
13711dadd54Swdenk  - mpc8xx	Files specific to Motorola MPC8xx  CPUs
13811dadd54Swdenk  - mpc824x	Files specific to Motorola MPC824x CPUs
13911dadd54Swdenk  - mpc8260	Files specific to Motorola MPC8260 CPUs
14011dadd54Swdenk  - mpc85xx	Files specific to Motorola MPC85xx CPUs
14111dadd54Swdenk  - nios	Files specific to Altera NIOS CPUs
14211dadd54Swdenk  - ppc4xx	Files specific to IBM PowerPC 4xx CPUs
14311dadd54Swdenk  - pxa		Files specific to Intel XScale PXA CPUs
14411dadd54Swdenk  - s3c44b0	Files specific to Samsung S3C44B0 CPUs
14511dadd54Swdenk  - sa1100	Files specific to Intel StrongARM SA1100 CPUs
146c609719bSwdenk- disk		Code for disk drive partition handling
147c609719bSwdenk- doc		Documentation (don't expect too much)
1487152b1d0Swdenk- drivers	Commonly used device drivers
149c609719bSwdenk- dtt		Digital Thermometer and Thermostat drivers
150c609719bSwdenk- examples	Example code for standalone applications, etc.
151c609719bSwdenk- include	Header Files
15211dadd54Swdenk- lib_arm	Files generic to ARM	 architecture
15311dadd54Swdenk- lib_generic	Files generic to all	 architectures
15411dadd54Swdenk- lib_i386	Files generic to i386	 architecture
15511dadd54Swdenk- lib_m68k	Files generic to m68k	 architecture
15611dadd54Swdenk- lib_mips	Files generic to MIPS	 architecture
15711dadd54Swdenk- lib_nios	Files generic to NIOS	 architecture
15811dadd54Swdenk- lib_ppc	Files generic to PowerPC architecture
159c609719bSwdenk- net		Networking code
160c609719bSwdenk- post		Power On Self Test
161c609719bSwdenk- rtc		Real Time Clock drivers
162c609719bSwdenk- tools		Tools to build S-Record or U-Boot images, etc.
163c609719bSwdenk
164c609719bSwdenkSoftware Configuration:
165c609719bSwdenk=======================
166c609719bSwdenk
167c609719bSwdenkConfiguration is usually done using C preprocessor defines; the
168c609719bSwdenkrationale behind that is to avoid dead code whenever possible.
169c609719bSwdenk
170c609719bSwdenkThere are two classes of configuration variables:
171c609719bSwdenk
172c609719bSwdenk* Configuration _OPTIONS_:
173c609719bSwdenk  These are selectable by the user and have names beginning with
174c609719bSwdenk  "CONFIG_".
175c609719bSwdenk
176c609719bSwdenk* Configuration _SETTINGS_:
177c609719bSwdenk  These depend on the hardware etc. and should not be meddled with if
178c609719bSwdenk  you don't know what you're doing; they have names beginning with
179c609719bSwdenk  "CFG_".
180c609719bSwdenk
181c609719bSwdenkLater we will add a configuration tool - probably similar to or even
182c609719bSwdenkidentical to what's used for the Linux kernel. Right now, we have to
183c609719bSwdenkdo the configuration by hand, which means creating some symbolic
184c609719bSwdenklinks and editing some configuration files. We use the TQM8xxL boards
185c609719bSwdenkas an example here.
186c609719bSwdenk
187c609719bSwdenk
188c609719bSwdenkSelection of Processor Architecture and Board Type:
189c609719bSwdenk---------------------------------------------------
190c609719bSwdenk
191c609719bSwdenkFor all supported boards there are ready-to-use default
192c609719bSwdenkconfigurations available; just type "make <board_name>_config".
193c609719bSwdenk
194c609719bSwdenkExample: For a TQM823L module type:
195c609719bSwdenk
196c609719bSwdenk	cd u-boot
197c609719bSwdenk	make TQM823L_config
198c609719bSwdenk
199c609719bSwdenkFor the Cogent platform, you need to specify the cpu type as well;
200c609719bSwdenke.g. "make cogent_mpc8xx_config". And also configure the cogent
201c609719bSwdenkdirectory according to the instructions in cogent/README.
202c609719bSwdenk
203c609719bSwdenk
204c609719bSwdenkConfiguration Options:
205c609719bSwdenk----------------------
206c609719bSwdenk
207c609719bSwdenkConfiguration depends on the combination of board and CPU type; all
208c609719bSwdenksuch information is kept in a configuration file
209c609719bSwdenk"include/configs/<board_name>.h".
210c609719bSwdenk
211c609719bSwdenkExample: For a TQM823L module, all configuration settings are in
212c609719bSwdenk"include/configs/TQM823L.h".
213c609719bSwdenk
214c609719bSwdenk
2157f6c2cbcSwdenkMany of the options are named exactly as the corresponding Linux
2167f6c2cbcSwdenkkernel configuration options. The intention is to make it easier to
2177f6c2cbcSwdenkbuild a config tool - later.
2187f6c2cbcSwdenk
2197f6c2cbcSwdenk
220c609719bSwdenkThe following options need to be configured:
221c609719bSwdenk
222c609719bSwdenk- CPU Type:	Define exactly one of
223c609719bSwdenk
224c609719bSwdenk		PowerPC based CPUs:
225c609719bSwdenk		-------------------
226c609719bSwdenk		CONFIG_MPC823,	CONFIG_MPC850,	CONFIG_MPC855,	CONFIG_MPC860
2270db5bca8Swdenk	or	CONFIG_MPC5xx
228c609719bSwdenk	or	CONFIG_MPC824X, CONFIG_MPC8260
22942d1f039Swdenk	or	CONFIG_MPC85xx
230c609719bSwdenk	or	CONFIG_IOP480
231c609719bSwdenk	or	CONFIG_405GP
23212f34241Swdenk	or	CONFIG_405EP
233c609719bSwdenk	or	CONFIG_440
234c609719bSwdenk	or	CONFIG_MPC74xx
23572755c71Swdenk	or	CONFIG_750FX
236c609719bSwdenk
237c609719bSwdenk		ARM based CPUs:
238c609719bSwdenk		---------------
239c609719bSwdenk		CONFIG_SA1110
240c609719bSwdenk		CONFIG_ARM7
241c609719bSwdenk		CONFIG_PXA250
242c609719bSwdenk
243c609719bSwdenk
244c609719bSwdenk- Board Type:	Define exactly one of
245c609719bSwdenk
246c609719bSwdenk		PowerPC based boards:
247c609719bSwdenk		---------------------
248c609719bSwdenk
249db01a2eaSwdenk		CONFIG_ADCIOP,		CONFIG_ADS860,		CONFIG_AMX860,
250db01a2eaSwdenk		CONFIG_AR405,		CONFIG_BAB7xx,		CONFIG_c2mon,
251db01a2eaSwdenk		CONFIG_CANBT,		CONFIG_CCM,		CONFIG_CMI,
252db01a2eaSwdenk		CONFIG_cogent_mpc8260,	CONFIG_cogent_mpc8xx,	CONFIG_CPCI405,
253db01a2eaSwdenk		CONFIG_CPCI4052,	CONFIG_CPCIISER4,	CONFIG_CPU86,
254db01a2eaSwdenk		CONFIG_CRAYL1,		CONFIG_CU824,		CONFIG_DASA_SIM,
255db01a2eaSwdenk		CONFIG_DB64360,		CONFIG_DB64460,		CONFIG_DU405,
256db01a2eaSwdenk		CONFIG_DUET_ADS,	CONFIG_EBONY,		CONFIG_ELPPC,
257db01a2eaSwdenk		CONFIG_ELPT860,		CONFIG_ep8260,		CONFIG_ERIC,
258db01a2eaSwdenk		CONFIG_ESTEEM192E,	CONFIG_ETX094,		CONFIG_EVB64260,
259db01a2eaSwdenk		CONFIG_FADS823,		CONFIG_FADS850SAR,	CONFIG_FADS860T,
260db01a2eaSwdenk		CONFIG_FLAGADM,		CONFIG_FPS850L,		CONFIG_FPS860L,
261db01a2eaSwdenk		CONFIG_GEN860T,		CONFIG_GENIETV,		CONFIG_GTH,
262db01a2eaSwdenk		CONFIG_gw8260,		CONFIG_hermes,		CONFIG_hymod,
263db01a2eaSwdenk		CONFIG_IAD210,		CONFIG_ICU862,		CONFIG_IP860,
264db01a2eaSwdenk		CONFIG_IPHASE4539,	CONFIG_IVML24,		CONFIG_IVML24_128,
265db01a2eaSwdenk		CONFIG_IVML24_256,	CONFIG_IVMS8,		CONFIG_IVMS8_128,
266db01a2eaSwdenk		CONFIG_IVMS8_256,	CONFIG_JSE,		CONFIG_LANTEC,
267db01a2eaSwdenk		CONFIG_lwmon,		CONFIG_MBX,		CONFIG_MBX860T,
268db01a2eaSwdenk		CONFIG_MHPC,		CONFIG_MIP405,		CONFIG_MOUSSE,
269db01a2eaSwdenk		CONFIG_MPC8260ADS,	CONFIG_MPC8540ADS,	CONFIG_MPC8560ADS,
270db01a2eaSwdenk		CONFIG_MUSENKI,		CONFIG_MVS1,		CONFIG_NETPHONE,
271db01a2eaSwdenk		CONFIG_NETTA,		CONFIG_NETVIA,		CONFIG_NX823,
272db01a2eaSwdenk		CONFIG_OCRTC,		CONFIG_ORSG,		CONFIG_OXC,
273db01a2eaSwdenk		CONFIG_PCI405,		CONFIG_PCIPPC2,		CONFIG_PCIPPC6,
274db01a2eaSwdenk		CONFIG_pcu_e,		CONFIG_PIP405,		CONFIG_PM826,
275db01a2eaSwdenk		CONFIG_ppmc8260,	CONFIG_QS823,		CONFIG_QS850,
276db01a2eaSwdenk		CONFIG_QS860T,		CONFIG_RBC823,		CONFIG_RPXClassic,
277db01a2eaSwdenk		CONFIG_RPXlite,		CONFIG_RPXsuper,	CONFIG_rsdproto,
278db01a2eaSwdenk		CONFIG_sacsng,		CONFIG_Sandpoint8240,	CONFIG_Sandpoint8245,
279db01a2eaSwdenk		CONFIG_sbc8260,		CONFIG_SM850,		CONFIG_SPD823TS,
280db01a2eaSwdenk		CONFIG_SXNI855T,	CONFIG_TQM823L,		CONFIG_TQM8260,
281db01a2eaSwdenk		CONFIG_TQM850L,		CONFIG_TQM855L,		CONFIG_TQM860L,
282db01a2eaSwdenk		CONFIG_TTTech,		CONFIG_UTX8245,		CONFIG_V37,
283db01a2eaSwdenk		CONFIG_W7OLMC,		CONFIG_W7OLMG,		CONFIG_WALNUT405,
284db01a2eaSwdenk		CONFIG_ZPC1900,		CONFIG_ZUMA,
285c609719bSwdenk
286c609719bSwdenk		ARM based boards:
287c609719bSwdenk		-----------------
288c609719bSwdenk
289db01a2eaSwdenk		CONFIG_AT91RM9200DK,		CONFIG_DNP1110,		CONFIG_EP7312,
290db01a2eaSwdenk		CONFIG_H2_OMAP1610,		CONFIG_HHP_CRADLE,	CONFIG_IMPA7,
291db01a2eaSwdenk		CONFIG_INNOVATOROMAP1510,   CONFIG_INNOVATOROMAP1610,	CONFIG_LART,
292db01a2eaSwdenk		CONFIG_LUBBOCK,			CONFIG_SHANNON,		CONFIG_SMDK2400,
29363e73c9aSwdenk		CONFIG_SMDK2410,		CONFIG_TRAB,		CONFIG_VCMA9,
294c609719bSwdenk
295c609719bSwdenk
296c609719bSwdenk- CPU Module Type: (if CONFIG_COGENT is defined)
297c609719bSwdenk		Define exactly one of
298c609719bSwdenk		CONFIG_CMA286_60_OLD
299c609719bSwdenk--- FIXME --- not tested yet:
300c609719bSwdenk		CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
301c609719bSwdenk		CONFIG_CMA287_23, CONFIG_CMA287_50
302c609719bSwdenk
303c609719bSwdenk- Motherboard Type: (if CONFIG_COGENT is defined)
304c609719bSwdenk		Define exactly one of
305c609719bSwdenk		CONFIG_CMA101, CONFIG_CMA102
306c609719bSwdenk
307c609719bSwdenk- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
308c609719bSwdenk		Define one or more of
309c609719bSwdenk		CONFIG_CMA302
310c609719bSwdenk
311c609719bSwdenk- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
312c609719bSwdenk		Define one or more of
313c609719bSwdenk		CONFIG_LCD_HEARTBEAT	- update a character position on
314c609719bSwdenk					  the lcd display every second with
315c609719bSwdenk					  a "rotator" |\-/|\-/
316c609719bSwdenk
3172535d602Swdenk- Board flavour: (if CONFIG_MPC8260ADS is defined)
3182535d602Swdenk		CONFIG_ADSTYPE
3192535d602Swdenk		Possible values are:
3202535d602Swdenk			CFG_8260ADS	- original MPC8260ADS
321180d3f74Swdenk			CFG_8266ADS	- MPC8266ADS
32254387ac9Swdenk			CFG_PQ2FADS	- PQ2FADS-ZU or PQ2FADS-VR
32304a85b3bSwdenk			CFG_8272ADS	- MPC8272ADS
3242535d602Swdenk
325c609719bSwdenk- MPC824X Family Member (if CONFIG_MPC824X is defined)
326c609719bSwdenk		Define exactly one of
327c609719bSwdenk		CONFIG_MPC8240, CONFIG_MPC8245
328c609719bSwdenk
32975d1ea7fSwdenk- 8xx CPU Options: (if using an MPC8xx cpu)
330c609719bSwdenk		Define one or more of
3315da627a4Swdenk		CONFIG_8xx_GCLK_FREQ	- if get_gclk_freq() cannot work
3325da627a4Swdenk					  e.g. if there is no 32KHz
3335da627a4Swdenk					  reference PIT/RTC clock
334c609719bSwdenk
33575d1ea7fSwdenk- 859/866 CPU options: (if using a MPC859 or MPC866 CPU):
33675d1ea7fSwdenk		CFG_866_OSCCLK
33775d1ea7fSwdenk		CFG_866_CPUCLK_MIN
33875d1ea7fSwdenk		CFG_866_CPUCLK_MAX
33975d1ea7fSwdenk		CFG_866_CPUCLK_DEFAULT
34075d1ea7fSwdenk			See doc/README.MPC866
34175d1ea7fSwdenk
34275d1ea7fSwdenk		CFG_MEASURE_CPUCLK
34375d1ea7fSwdenk
34475d1ea7fSwdenk		Define this to measure the actual CPU clock instead
34575d1ea7fSwdenk		of relying on the correctness of the configured
34675d1ea7fSwdenk		values. Mostly useful for board bringup to make sure
34775d1ea7fSwdenk		the PLL is locked at the intended frequency. Note
34875d1ea7fSwdenk		that this requires a (stable) reference clock (32 kHz
34975d1ea7fSwdenk		RTC clock),
35075d1ea7fSwdenk
3515da627a4Swdenk- Linux Kernel Interface:
352c609719bSwdenk		CONFIG_CLOCKS_IN_MHZ
353c609719bSwdenk
354c609719bSwdenk		U-Boot stores all clock information in Hz
355c609719bSwdenk		internally. For binary compatibility with older Linux
356c609719bSwdenk		kernels (which expect the clocks passed in the
357c609719bSwdenk		bd_info data to be in MHz) the environment variable
358c609719bSwdenk		"clocks_in_mhz" can be defined so that U-Boot
359c609719bSwdenk		converts clock data to MHZ before passing it to the
360c609719bSwdenk		Linux kernel.
361c609719bSwdenk		When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
362c609719bSwdenk		"clocks_in_mhz=1" is  automatically  included  in  the
363c609719bSwdenk		default environment.
364c609719bSwdenk
3655da627a4Swdenk		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]
3665da627a4Swdenk
3675da627a4Swdenk		When transfering memsize parameter to linux, some versions
3685da627a4Swdenk		expect it to be in bytes, others in MB.
3695da627a4Swdenk		Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
3705da627a4Swdenk
371c609719bSwdenk- Console Interface:
372c609719bSwdenk		Depending on board, define exactly one serial port
373c609719bSwdenk		(like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
374c609719bSwdenk		CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
375c609719bSwdenk		console by defining CONFIG_8xx_CONS_NONE
376c609719bSwdenk
377c609719bSwdenk		Note: if CONFIG_8xx_CONS_NONE is defined, the serial
378c609719bSwdenk		port routines must be defined elsewhere
379c609719bSwdenk		(i.e. serial_init(), serial_getc(), ...)
380c609719bSwdenk
381c609719bSwdenk		CONFIG_CFB_CONSOLE
382c609719bSwdenk		Enables console device for a color framebuffer. Needs following
383c609719bSwdenk		defines (cf. smiLynxEM, i8042, board/eltec/bab7xx)
384c609719bSwdenk			VIDEO_FB_LITTLE_ENDIAN	graphic memory organisation
385c609719bSwdenk						(default big endian)
386c609719bSwdenk			VIDEO_HW_RECTFILL	graphic chip supports
387c609719bSwdenk						rectangle fill
388c609719bSwdenk						(cf. smiLynxEM)
389c609719bSwdenk			VIDEO_HW_BITBLT		graphic chip supports
390c609719bSwdenk						bit-blit (cf. smiLynxEM)
391c609719bSwdenk			VIDEO_VISIBLE_COLS	visible pixel columns
392c609719bSwdenk						(cols=pitch)
393c609719bSwdenk			VIDEO_VISIBLE_ROWS	visible pixel rows
394c609719bSwdenk			VIDEO_PIXEL_SIZE	bytes per pixel
395c609719bSwdenk			VIDEO_DATA_FORMAT	graphic data format
396c609719bSwdenk						(0-5, cf. cfb_console.c)
397c609719bSwdenk			VIDEO_FB_ADRS		framebuffer address
398c609719bSwdenk			VIDEO_KBD_INIT_FCT	keyboard int fct
399c609719bSwdenk						(i.e. i8042_kbd_init())
400c609719bSwdenk			VIDEO_TSTC_FCT		test char fct
401c609719bSwdenk						(i.e. i8042_tstc)
402c609719bSwdenk			VIDEO_GETC_FCT		get char fct
403c609719bSwdenk						(i.e. i8042_getc)
404c609719bSwdenk			CONFIG_CONSOLE_CURSOR	cursor drawing on/off
405c609719bSwdenk						(requires blink timer
406c609719bSwdenk						cf. i8042.c)
407c609719bSwdenk			CFG_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
408c609719bSwdenk			CONFIG_CONSOLE_TIME	display time/date info in
409c609719bSwdenk						upper right corner
410c609719bSwdenk						(requires CFG_CMD_DATE)
411c609719bSwdenk			CONFIG_VIDEO_LOGO	display Linux logo in
412c609719bSwdenk						upper left corner
413a6c7ad2fSwdenk			CONFIG_VIDEO_BMP_LOGO	use bmp_logo.h instead of
414a6c7ad2fSwdenk						linux_logo.h for logo.
415a6c7ad2fSwdenk						Requires CONFIG_VIDEO_LOGO
416c609719bSwdenk			CONFIG_CONSOLE_EXTRA_INFO
417c609719bSwdenk						addional board info beside
418c609719bSwdenk						the logo
419c609719bSwdenk
420c609719bSwdenk		When CONFIG_CFB_CONSOLE is defined, video console is
421c609719bSwdenk		default i/o. Serial console can be forced with
422c609719bSwdenk		environment 'console=serial'.
423c609719bSwdenk
424a3ad8e26Swdenk		When CONFIG_SILENT_CONSOLE is defined, all console
425a3ad8e26Swdenk		messages (by U-Boot and Linux!) can be silenced with
426a3ad8e26Swdenk		the "silent" environment variable. See
427a3ad8e26Swdenk		doc/README.silent for more information.
428a3ad8e26Swdenk
429c609719bSwdenk- Console Baudrate:
430c609719bSwdenk		CONFIG_BAUDRATE - in bps
431c609719bSwdenk		Select one of the baudrates listed in
432c609719bSwdenk		CFG_BAUDRATE_TABLE, see below.
4333bbc899fSwdenk		CFG_BRGCLK_PRESCALE, baudrate prescale
434c609719bSwdenk
435c609719bSwdenk- Interrupt driven serial port input:
436c609719bSwdenk		CONFIG_SERIAL_SOFTWARE_FIFO
437c609719bSwdenk
438c609719bSwdenk		PPC405GP only.
439c609719bSwdenk		Use an interrupt handler for receiving data on the
440c609719bSwdenk		serial port. It also enables using hardware handshake
441c609719bSwdenk		(RTS/CTS) and UART's built-in FIFO. Set the number of
442c609719bSwdenk		bytes the interrupt driven input buffer should have.
443c609719bSwdenk
444109c0e3aSwdenk		Leave undefined to disable this feature, including
445109c0e3aSwdenk		disable the buffer and hardware handshake.
446c609719bSwdenk
4471d49b1f3Sstroese- Console UART Number:
4481d49b1f3Sstroese		CONFIG_UART1_CONSOLE
4491d49b1f3Sstroese
4501d49b1f3Sstroese		IBM PPC4xx only.
4511d49b1f3Sstroese		If defined internal UART1 (and not UART0) is used
4521d49b1f3Sstroese		as default U-Boot console.
4531d49b1f3Sstroese
454c609719bSwdenk- Boot Delay:	CONFIG_BOOTDELAY - in seconds
455c609719bSwdenk		Delay before automatically booting the default image;
456c609719bSwdenk		set to -1 to disable autoboot.
457c609719bSwdenk
458c609719bSwdenk		See doc/README.autoboot for these options that
459c609719bSwdenk		work with CONFIG_BOOTDELAY. None are required.
460c609719bSwdenk		CONFIG_BOOT_RETRY_TIME
461c609719bSwdenk		CONFIG_BOOT_RETRY_MIN
462c609719bSwdenk		CONFIG_AUTOBOOT_KEYED
463c609719bSwdenk		CONFIG_AUTOBOOT_PROMPT
464c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR
465c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR
466c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR2
467c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR2
468c609719bSwdenk		CONFIG_ZERO_BOOTDELAY_CHECK
469c609719bSwdenk		CONFIG_RESET_TO_RETRY
470c609719bSwdenk
471c609719bSwdenk- Autoboot Command:
472c609719bSwdenk		CONFIG_BOOTCOMMAND
473c609719bSwdenk		Only needed when CONFIG_BOOTDELAY is enabled;
474c609719bSwdenk		define a command string that is automatically executed
475c609719bSwdenk		when no character is read on the console interface
476c609719bSwdenk		within "Boot Delay" after reset.
477c609719bSwdenk
478c609719bSwdenk		CONFIG_BOOTARGS
479c609719bSwdenk		This can be used to pass arguments to the bootm
480c609719bSwdenk		command. The value of CONFIG_BOOTARGS goes into the
481c609719bSwdenk		environment value "bootargs".
482c609719bSwdenk
483c609719bSwdenk		CONFIG_RAMBOOT and CONFIG_NFSBOOT
484c609719bSwdenk		The value of these goes into the environment as
485c609719bSwdenk		"ramboot" and "nfsboot" respectively, and can be used
486c609719bSwdenk		as a convenience, when switching between booting from
487c609719bSwdenk		ram and nfs.
488c609719bSwdenk
489c609719bSwdenk- Pre-Boot Commands:
490c609719bSwdenk		CONFIG_PREBOOT
491c609719bSwdenk
492c609719bSwdenk		When this option is #defined, the existence of the
493c609719bSwdenk		environment variable "preboot" will be checked
494c609719bSwdenk		immediately before starting the CONFIG_BOOTDELAY
495c609719bSwdenk		countdown and/or running the auto-boot command resp.
496c609719bSwdenk		entering interactive mode.
497c609719bSwdenk
498c609719bSwdenk		This feature is especially useful when "preboot" is
499c609719bSwdenk		automatically generated or modified. For an example
500c609719bSwdenk		see the LWMON board specific code: here "preboot" is
501c609719bSwdenk		modified when the user holds down a certain
502c609719bSwdenk		combination of keys on the (special) keyboard when
503c609719bSwdenk		booting the systems
504c609719bSwdenk
505c609719bSwdenk- Serial Download Echo Mode:
506c609719bSwdenk		CONFIG_LOADS_ECHO
507c609719bSwdenk		If defined to 1, all characters received during a
508c609719bSwdenk		serial download (using the "loads" command) are
509c609719bSwdenk		echoed back. This might be needed by some terminal
510c609719bSwdenk		emulations (like "cu"), but may as well just take
511c609719bSwdenk		time on others. This setting #define's the initial
512c609719bSwdenk		value of the "loads_echo" environment variable.
513c609719bSwdenk
514c609719bSwdenk- Kgdb Serial Baudrate: (if CFG_CMD_KGDB is defined)
515c609719bSwdenk		CONFIG_KGDB_BAUDRATE
516c609719bSwdenk		Select one of the baudrates listed in
517c609719bSwdenk		CFG_BAUDRATE_TABLE, see below.
518c609719bSwdenk
519c609719bSwdenk- Monitor Functions:
520c609719bSwdenk		CONFIG_COMMANDS
521c609719bSwdenk		Most monitor functions can be selected (or
522c609719bSwdenk		de-selected) by adjusting the definition of
523c609719bSwdenk		CONFIG_COMMANDS; to select individual functions,
524c609719bSwdenk		#define CONFIG_COMMANDS by "OR"ing any of the
525c609719bSwdenk		following values:
526c609719bSwdenk
527c609719bSwdenk		#define enables commands:
528c609719bSwdenk		-------------------------
529c609719bSwdenk		CFG_CMD_ASKENV	* ask for env variable
53078137c3cSwdenk		CFG_CMD_AUTOSCRIPT Autoscript Support
531c609719bSwdenk		CFG_CMD_BDI	  bdinfo
532c609719bSwdenk		CFG_CMD_BEDBUG	  Include BedBug Debugger
53378137c3cSwdenk		CFG_CMD_BMP	* BMP support
534c609719bSwdenk		CFG_CMD_BOOTD	  bootd
535c609719bSwdenk		CFG_CMD_CACHE	  icache, dcache
536c609719bSwdenk		CFG_CMD_CONSOLE	  coninfo
537c609719bSwdenk		CFG_CMD_DATE	* support for RTC, date/time...
538c609719bSwdenk		CFG_CMD_DHCP	  DHCP support
53978137c3cSwdenk		CFG_CMD_DIAG	* Diagnostics
54078137c3cSwdenk		CFG_CMD_DOC	* Disk-On-Chip Support
54178137c3cSwdenk		CFG_CMD_DTT	  Digital Therm and Thermostat
542c609719bSwdenk		CFG_CMD_ECHO	* echo arguments
543c609719bSwdenk		CFG_CMD_EEPROM	* EEPROM read/write support
544c609719bSwdenk		CFG_CMD_ELF	  bootelf, bootvx
545c609719bSwdenk		CFG_CMD_ENV	  saveenv
546c609719bSwdenk		CFG_CMD_FDC	* Floppy Disk Support
54771f95118Swdenk		CFG_CMD_FAT	  FAT partition support
5482262cfeeSwdenk		CFG_CMD_FDOS	* Dos diskette Support
549c609719bSwdenk		CFG_CMD_FLASH	  flinfo, erase, protect
550c609719bSwdenk		CFG_CMD_FPGA	  FPGA device initialization support
55178137c3cSwdenk		CFG_CMD_HWFLOW	* RTS/CTS hw flow control
552c609719bSwdenk		CFG_CMD_I2C	* I2C serial bus support
553c609719bSwdenk		CFG_CMD_IDE	* IDE harddisk support
554c609719bSwdenk		CFG_CMD_IMI	  iminfo
55578137c3cSwdenk		CFG_CMD_IMLS	  List all found images
556c609719bSwdenk		CFG_CMD_IMMAP	* IMMR dump support
557c609719bSwdenk		CFG_CMD_IRQ	* irqinfo
5582d1a537dSwdenk		CFG_CMD_ITEST	* Integer/string test of 2 values
55978137c3cSwdenk		CFG_CMD_JFFS2	* JFFS2 Support
560c609719bSwdenk		CFG_CMD_KGDB	* kgdb
561c609719bSwdenk		CFG_CMD_LOADB	  loadb
562c609719bSwdenk		CFG_CMD_LOADS	  loads
563c609719bSwdenk		CFG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
564c609719bSwdenk				  loop, mtest
56578137c3cSwdenk		CFG_CMD_MISC	  Misc functions like sleep etc
56671f95118Swdenk		CFG_CMD_MMC	  MMC memory mapped support
567c609719bSwdenk		CFG_CMD_MII	  MII utility commands
56878137c3cSwdenk		CFG_CMD_NAND	* NAND support
569c609719bSwdenk		CFG_CMD_NET	  bootp, tftpboot, rarpboot
570c609719bSwdenk		CFG_CMD_PCI	* pciinfo
571c609719bSwdenk		CFG_CMD_PCMCIA	* PCMCIA support
57278137c3cSwdenk		CFG_CMD_PING	* send ICMP ECHO_REQUEST to network host
573ef5a9672Swdenk		CFG_CMD_PORTIO	* Port I/O
574c609719bSwdenk		CFG_CMD_REGINFO * Register dump
575c609719bSwdenk		CFG_CMD_RUN	  run command in env variable
57678137c3cSwdenk		CFG_CMD_SAVES	  save S record dump
577c609719bSwdenk		CFG_CMD_SCSI	* SCSI Support
57878137c3cSwdenk		CFG_CMD_SDRAM	* print SDRAM configuration information
579c609719bSwdenk		CFG_CMD_SETGETDCR Support for DCR Register access (4xx only)
580c609719bSwdenk		CFG_CMD_SPI	* SPI serial bus support
581c609719bSwdenk		CFG_CMD_USB	* USB support
58278137c3cSwdenk		CFG_CMD_VFD	* VFD support (TRAB)
583c609719bSwdenk		CFG_CMD_BSP	* Board SPecific functions
584a3d991bdSwdenk		CFG_CMD_CDP	* Cisco Discover Protocol support
585c609719bSwdenk		-----------------------------------------------
586c609719bSwdenk		CFG_CMD_ALL	all
587c609719bSwdenk
588c609719bSwdenk		CFG_CMD_DFL	Default configuration; at the moment
589c609719bSwdenk				this is includes all commands, except
590c609719bSwdenk				the ones marked with "*" in the list
591c609719bSwdenk				above.
592c609719bSwdenk
593c609719bSwdenk		If you don't define CONFIG_COMMANDS it defaults to
594c609719bSwdenk		CFG_CMD_DFL in include/cmd_confdefs.h. A board can
595c609719bSwdenk		override the default settings in the respective
596c609719bSwdenk		include file.
597c609719bSwdenk
598c609719bSwdenk		EXAMPLE: If you want all functions except of network
599c609719bSwdenk		support you can write:
600c609719bSwdenk
601c609719bSwdenk		#define CONFIG_COMMANDS (CFG_CMD_ALL & ~CFG_CMD_NET)
602c609719bSwdenk
603c609719bSwdenk
604c609719bSwdenk	Note:	Don't enable the "icache" and "dcache" commands
605c609719bSwdenk		(configuration option CFG_CMD_CACHE) unless you know
606c609719bSwdenk		what you (and your U-Boot users) are doing. Data
607c609719bSwdenk		cache cannot be enabled on systems like the 8xx or
608c609719bSwdenk		8260 (where accesses to the IMMR region must be
609c609719bSwdenk		uncached), and it cannot be disabled on all other
610c609719bSwdenk		systems where we (mis-) use the data cache to hold an
611c609719bSwdenk		initial stack and some data.
612c609719bSwdenk
613c609719bSwdenk
614c609719bSwdenk		XXX - this list needs to get updated!
615c609719bSwdenk
616c609719bSwdenk- Watchdog:
617c609719bSwdenk		CONFIG_WATCHDOG
618c609719bSwdenk		If this variable is defined, it enables watchdog
6197152b1d0Swdenk		support. There must be support in the platform specific
620c609719bSwdenk		code for a watchdog. For the 8xx and 8260 CPUs, the
621c609719bSwdenk		SIU Watchdog feature is enabled in the SYPCR
622c609719bSwdenk		register.
623c609719bSwdenk
624c1551ea8Sstroese- U-Boot Version:
625c1551ea8Sstroese		CONFIG_VERSION_VARIABLE
626c1551ea8Sstroese		If this variable is defined, an environment variable
627c1551ea8Sstroese		named "ver" is created by U-Boot showing the U-Boot
628c1551ea8Sstroese		version as printed by the "version" command.
629c1551ea8Sstroese		This variable is readonly.
630c1551ea8Sstroese
631c609719bSwdenk- Real-Time Clock:
632c609719bSwdenk
633c609719bSwdenk		When CFG_CMD_DATE is selected, the type of the RTC
634c609719bSwdenk		has to be selected, too. Define exactly one of the
635c609719bSwdenk		following options:
636c609719bSwdenk
637c609719bSwdenk		CONFIG_RTC_MPC8xx	- use internal RTC of MPC8xx
638c609719bSwdenk		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
639c609719bSwdenk		CONFIG_RTC_MC146818	- use MC146818 RTC
6401cb8e980Swdenk		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
641c609719bSwdenk		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
6427f70e853Swdenk		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
6433bac3513Swdenk		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
644c609719bSwdenk
645b37c7e5eSwdenk		Note that if the RTC uses I2C, then the I2C interface
646b37c7e5eSwdenk		must also be configured. See I2C Support, below.
647b37c7e5eSwdenk
648c609719bSwdenk- Timestamp Support:
649c609719bSwdenk
650c609719bSwdenk		When CONFIG_TIMESTAMP is selected, the timestamp
651c609719bSwdenk		(date and time) of an image is printed by image
652c609719bSwdenk		commands like bootm or iminfo. This option is
653c609719bSwdenk		automatically enabled when you select CFG_CMD_DATE .
654c609719bSwdenk
655c609719bSwdenk- Partition Support:
656c609719bSwdenk		CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
657c609719bSwdenk		and/or CONFIG_ISO_PARTITION
658c609719bSwdenk
659c609719bSwdenk		If IDE or SCSI support	is  enabled  (CFG_CMD_IDE  or
660c609719bSwdenk		CFG_CMD_SCSI) you must configure support for at least
661c609719bSwdenk		one partition type as well.
662c609719bSwdenk
663c609719bSwdenk- IDE Reset method:
6644d13cbadSwdenk		CONFIG_IDE_RESET_ROUTINE - this is defined in several
6654d13cbadSwdenk		board configurations files but used nowhere!
666c609719bSwdenk
6674d13cbadSwdenk		CONFIG_IDE_RESET - is this is defined, IDE Reset will
6684d13cbadSwdenk		be performed by calling the function
6694d13cbadSwdenk			ide_set_reset(int reset)
6704d13cbadSwdenk		which has to be defined in a board specific file
671c609719bSwdenk
672c609719bSwdenk- ATAPI Support:
673c609719bSwdenk		CONFIG_ATAPI
674c609719bSwdenk
675c609719bSwdenk		Set this to enable ATAPI support.
676c609719bSwdenk
677c40b2956Swdenk- LBA48 Support
678c40b2956Swdenk		CONFIG_LBA48
679c40b2956Swdenk
680c40b2956Swdenk		Set this to enable support for disks larger than 137GB
681c40b2956Swdenk		Also look at CFG_64BIT_LBA ,CFG_64BIT_VSPRINTF and CFG_64BIT_STRTOUL
682c40b2956Swdenk		Whithout these , LBA48 support uses 32bit variables and will 'only'
683c40b2956Swdenk		support disks up to 2.1TB.
684c40b2956Swdenk
685c40b2956Swdenk		CFG_64BIT_LBA:
686c40b2956Swdenk			When enabled, makes the IDE subsystem use 64bit sector addresses.
687c40b2956Swdenk			Default is 32bit.
688c40b2956Swdenk
689c609719bSwdenk- SCSI Support:
690c609719bSwdenk		At the moment only there is only support for the
691c609719bSwdenk		SYM53C8XX SCSI controller; define
692c609719bSwdenk		CONFIG_SCSI_SYM53C8XX to enable it.
693c609719bSwdenk
694c609719bSwdenk		CFG_SCSI_MAX_LUN [8], CFG_SCSI_MAX_SCSI_ID [7] and
695c609719bSwdenk		CFG_SCSI_MAX_DEVICE [CFG_SCSI_MAX_SCSI_ID *
696c609719bSwdenk		CFG_SCSI_MAX_LUN] can be adjusted to define the
697c609719bSwdenk		maximum numbers of LUNs, SCSI ID's and target
698c609719bSwdenk		devices.
699c609719bSwdenk		CFG_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
700c609719bSwdenk
701c609719bSwdenk- NETWORK Support (PCI):
702682011ffSwdenk		CONFIG_E1000
703682011ffSwdenk		Support for Intel 8254x gigabit chips.
704682011ffSwdenk
705c609719bSwdenk		CONFIG_EEPRO100
706c609719bSwdenk		Support for Intel 82557/82559/82559ER chips.
707c609719bSwdenk		Optional CONFIG_EEPRO100_SROM_WRITE enables eeprom
708c609719bSwdenk		write routine for first time initialisation.
709c609719bSwdenk
710c609719bSwdenk		CONFIG_TULIP
711c609719bSwdenk		Support for Digital 2114x chips.
712c609719bSwdenk		Optional CONFIG_TULIP_SELECT_MEDIA for board specific
713c609719bSwdenk		modem chip initialisation (KS8761/QS6611).
714c609719bSwdenk
715c609719bSwdenk		CONFIG_NATSEMI
716c609719bSwdenk		Support for National dp83815 chips.
717c609719bSwdenk
718c609719bSwdenk		CONFIG_NS8382X
719c609719bSwdenk		Support for National dp8382[01] gigabit chips.
720c609719bSwdenk
72145219c46Swdenk- NETWORK Support (other):
72245219c46Swdenk
72345219c46Swdenk		CONFIG_DRIVER_LAN91C96
72445219c46Swdenk		Support for SMSC's LAN91C96 chips.
72545219c46Swdenk
72645219c46Swdenk			CONFIG_LAN91C96_BASE
72745219c46Swdenk			Define this to hold the physical address
72845219c46Swdenk			of the LAN91C96's I/O space
72945219c46Swdenk
73045219c46Swdenk			CONFIG_LAN91C96_USE_32_BIT
73145219c46Swdenk			Define this to enable 32 bit addressing
73245219c46Swdenk
733c609719bSwdenk- USB Support:
734c609719bSwdenk		At the moment only the UHCI host controller is
7354d13cbadSwdenk		supported (PIP405, MIP405, MPC5200); define
736c609719bSwdenk		CONFIG_USB_UHCI to enable it.
737c609719bSwdenk		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
738c609719bSwdenk		end define CONFIG_USB_STORAGE to enable the USB
739c609719bSwdenk		storage devices.
740c609719bSwdenk		Note:
741c609719bSwdenk		Supported are USB Keyboards and USB Floppy drives
742c609719bSwdenk		(TEAC FD-05PUB).
7434d13cbadSwdenk		MPC5200 USB requires additional defines:
7444d13cbadSwdenk			CONFIG_USB_CLOCK
7454d13cbadSwdenk				for 528 MHz Clock: 0x0001bbbb
7464d13cbadSwdenk			CONFIG_USB_CONFIG
7474d13cbadSwdenk				for differential drivers: 0x00001000
7484d13cbadSwdenk				for single ended drivers: 0x00005000
7494d13cbadSwdenk
750c609719bSwdenk
75171f95118Swdenk- MMC Support:
75271f95118Swdenk		The MMC controller on the Intel PXA is supported. To
75371f95118Swdenk		enable this define CONFIG_MMC. The MMC can be
75471f95118Swdenk		accessed from the boot prompt by mapping the device
75571f95118Swdenk		to physical memory similar to flash. Command line is
75671f95118Swdenk		enabled with CFG_CMD_MMC. The MMC driver also works with
75771f95118Swdenk		the FAT fs. This is enabled with CFG_CMD_FAT.
75871f95118Swdenk
759c609719bSwdenk- Keyboard Support:
760c609719bSwdenk		CONFIG_ISA_KEYBOARD
761c609719bSwdenk
762c609719bSwdenk		Define this to enable standard (PC-Style) keyboard
763c609719bSwdenk		support
764c609719bSwdenk
765c609719bSwdenk		CONFIG_I8042_KBD
766c609719bSwdenk		Standard PC keyboard driver with US (is default) and
767c609719bSwdenk		GERMAN key layout (switch via environment 'keymap=de') support.
768c609719bSwdenk		Export function i8042_kbd_init, i8042_tstc and i8042_getc
769c609719bSwdenk		for cfb_console. Supports cursor blinking.
770c609719bSwdenk
771c609719bSwdenk- Video support:
772c609719bSwdenk		CONFIG_VIDEO
773c609719bSwdenk
774c609719bSwdenk		Define this to enable video support (for output to
775c609719bSwdenk		video).
776c609719bSwdenk
777c609719bSwdenk		CONFIG_VIDEO_CT69000
778c609719bSwdenk
779c609719bSwdenk		Enable Chips & Technologies 69000 Video chip
780c609719bSwdenk
781c609719bSwdenk		CONFIG_VIDEO_SMI_LYNXEM
782eeb1b77bSwdenk		Enable Silicon Motion SMI 712/710/810 Video chip. The
783eeb1b77bSwdenk		video output is selected via environment 'videoout'
784eeb1b77bSwdenk		(1 = LCD and 2 = CRT). If videoout is undefined, CRT is
785eeb1b77bSwdenk		assumed.
786c609719bSwdenk
787eeb1b77bSwdenk		For the CT69000 and SMI_LYNXEM drivers, videomode is
788eeb1b77bSwdenk		selected via environment 'videomode'. Two diferent ways
789eeb1b77bSwdenk		are possible:
790eeb1b77bSwdenk		- "videomode=num"   'num' is a standard LiLo mode numbers.
791eeb1b77bSwdenk		Following standard modes are supported  (* is default):
792eeb1b77bSwdenk
793eeb1b77bSwdenk		      Colors	640x480 800x600 1024x768 1152x864 1280x1024
794eeb1b77bSwdenk		-------------+---------------------------------------------
795eeb1b77bSwdenk		      8 bits |	0x301*	0x303	 0x305	  0x161	    0x307
796eeb1b77bSwdenk		     15 bits |	0x310	0x313	 0x316	  0x162	    0x319
797eeb1b77bSwdenk		     16 bits |	0x311	0x314	 0x317	  0x163	    0x31A
798eeb1b77bSwdenk		     24 bits |	0x312	0x315	 0x318	    ?	    0x31B
799eeb1b77bSwdenk		-------------+---------------------------------------------
800c609719bSwdenk		(i.e. setenv videomode 317; saveenv; reset;)
801c609719bSwdenk
802eeb1b77bSwdenk		- "videomode=bootargs" all the video parameters are parsed
803eeb1b77bSwdenk		from the bootargs. (See drivers/videomodes.c)
804eeb1b77bSwdenk
805eeb1b77bSwdenk
806a6c7ad2fSwdenk		CONFIG_VIDEO_SED13806
807a6c7ad2fSwdenk		Enable Epson SED13806 driver. This driver supports 8bpp
808a6c7ad2fSwdenk		and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
809a6c7ad2fSwdenk		or CONFIG_VIDEO_SED13806_16BPP
810a6c7ad2fSwdenk
811682011ffSwdenk- Keyboard Support:
812682011ffSwdenk		CONFIG_KEYBOARD
813682011ffSwdenk
814682011ffSwdenk		Define this to enable a custom keyboard support.
815682011ffSwdenk		This simply calls drv_keyboard_init() which must be
816682011ffSwdenk		defined in your board-specific files.
817682011ffSwdenk		The only board using this so far is RBC823.
818a6c7ad2fSwdenk
819c609719bSwdenk- LCD Support:	CONFIG_LCD
820c609719bSwdenk
821c609719bSwdenk		Define this to enable LCD support (for output to LCD
822c609719bSwdenk		display); also select one of the supported displays
823c609719bSwdenk		by defining one of these:
824c609719bSwdenk
825fd3103bbSwdenk		CONFIG_NEC_NL6448AC33:
826c609719bSwdenk
827fd3103bbSwdenk			NEC NL6448AC33-18. Active, color, single scan.
828c609719bSwdenk
829fd3103bbSwdenk		CONFIG_NEC_NL6448BC20
830c609719bSwdenk
831fd3103bbSwdenk			NEC NL6448BC20-08. 6.5", 640x480.
832fd3103bbSwdenk			Active, color, single scan.
833fd3103bbSwdenk
834fd3103bbSwdenk		CONFIG_NEC_NL6448BC33_54
835fd3103bbSwdenk
836fd3103bbSwdenk			NEC NL6448BC33-54. 10.4", 640x480.
837c609719bSwdenk			Active, color, single scan.
838c609719bSwdenk
839c609719bSwdenk		CONFIG_SHARP_16x9
840c609719bSwdenk
841c609719bSwdenk			Sharp 320x240. Active, color, single scan.
842c609719bSwdenk			It isn't 16x9, and I am not sure what it is.
843c609719bSwdenk
844c609719bSwdenk		CONFIG_SHARP_LQ64D341
845c609719bSwdenk
846c609719bSwdenk			Sharp LQ64D341 display, 640x480.
847c609719bSwdenk			Active, color, single scan.
848c609719bSwdenk
849c609719bSwdenk		CONFIG_HLD1045
850c609719bSwdenk
851c609719bSwdenk			HLD1045 display, 640x480.
852c609719bSwdenk			Active, color, single scan.
853c609719bSwdenk
854c609719bSwdenk		CONFIG_OPTREX_BW
855c609719bSwdenk
856c609719bSwdenk			Optrex	 CBL50840-2 NF-FW 99 22 M5
857c609719bSwdenk			or
858c609719bSwdenk			Hitachi	 LMG6912RPFC-00T
859c609719bSwdenk			or
860c609719bSwdenk			Hitachi	 SP14Q002
861c609719bSwdenk
862c609719bSwdenk			320x240. Black & white.
863c609719bSwdenk
864c609719bSwdenk		Normally display is black on white background; define
865c609719bSwdenk		CFG_WHITE_ON_BLACK to get it inverted.
866c609719bSwdenk
8677152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN
868d791b1dcSwdenk
869d791b1dcSwdenk		If this option is set, the environment is checked for
870d791b1dcSwdenk		a variable "splashimage". If found, the usual display
871d791b1dcSwdenk		of logo, copyright and system information on the LCD
872d791b1dcSwdenk		is supressed and the BMP image at the address
873d791b1dcSwdenk		specified in "splashimage" is loaded instead. The
874d791b1dcSwdenk		console is redirected to the "nulldev", too. This
875d791b1dcSwdenk		allows for a "silent" boot where a splash screen is
876d791b1dcSwdenk		loaded very quickly after power-on.
877d791b1dcSwdenk
878c29fdfc1Swdenk- Compression support:
879c29fdfc1Swdenk		CONFIG_BZIP2
880c29fdfc1Swdenk
881c29fdfc1Swdenk		If this option is set, support for bzip2 compressed
882c29fdfc1Swdenk		images is included. If not, only uncompressed and gzip
883c29fdfc1Swdenk		compressed images are supported.
884c29fdfc1Swdenk
885c29fdfc1Swdenk		NOTE: the bzip2 algorithm requires a lot of RAM, so
886c29fdfc1Swdenk		the malloc area (as defined by CFG_MALLOC_LEN) should
887c29fdfc1Swdenk		be at least 4MB.
888d791b1dcSwdenk
889c609719bSwdenk- Ethernet address:
890c609719bSwdenk		CONFIG_ETHADDR
891c609719bSwdenk		CONFIG_ETH2ADDR
892c609719bSwdenk		CONFIG_ETH3ADDR
893c609719bSwdenk
894c609719bSwdenk		Define a default value for ethernet address to use
895c609719bSwdenk		for the respective ethernet interface, in case this
896c609719bSwdenk		is not determined automatically.
897c609719bSwdenk
898c609719bSwdenk- IP address:
899c609719bSwdenk		CONFIG_IPADDR
900c609719bSwdenk
901c609719bSwdenk		Define a default value for the IP address to use for
902c609719bSwdenk		the default ethernet interface, in case this is not
903c609719bSwdenk		determined through e.g. bootp.
904c609719bSwdenk
905c609719bSwdenk- Server IP address:
906c609719bSwdenk		CONFIG_SERVERIP
907c609719bSwdenk
908c609719bSwdenk		Defines a default value for theIP address of a TFTP
909c609719bSwdenk		server to contact when using the "tftboot" command.
910c609719bSwdenk
911c609719bSwdenk- BOOTP Recovery Mode:
912c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY
913c609719bSwdenk
914c609719bSwdenk		If you have many targets in a network that try to
915c609719bSwdenk		boot using BOOTP, you may want to avoid that all
916c609719bSwdenk		systems send out BOOTP requests at precisely the same
917c609719bSwdenk		moment (which would happen for instance at recovery
918c609719bSwdenk		from a power failure, when all systems will try to
919c609719bSwdenk		boot, thus flooding the BOOTP server. Defining
920c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
921c609719bSwdenk		inserted before sending out BOOTP requests. The
922c609719bSwdenk		following delays are insterted then:
923c609719bSwdenk
924c609719bSwdenk		1st BOOTP request:	delay 0 ... 1 sec
925c609719bSwdenk		2nd BOOTP request:	delay 0 ... 2 sec
926c609719bSwdenk		3rd BOOTP request:	delay 0 ... 4 sec
927c609719bSwdenk		4th and following
928c609719bSwdenk		BOOTP requests:		delay 0 ... 8 sec
929c609719bSwdenk
930fe389a82Sstroese- DHCP Advanced Options:
931fe389a82Sstroese		CONFIG_BOOTP_MASK
932fe389a82Sstroese
933fe389a82Sstroese		You can fine tune the DHCP functionality by adding
934fe389a82Sstroese		these flags to the CONFIG_BOOTP_MASK define:
935fe389a82Sstroese
936fe389a82Sstroese		CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
937fe389a82Sstroese		serverip from a DHCP server, it is possible that more
938fe389a82Sstroese		than one DNS serverip is offered to the client.
939fe389a82Sstroese		If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
940fe389a82Sstroese		serverip will be stored in the additional environment
941fe389a82Sstroese		variable "dnsip2". The first DNS serverip is always
942fe389a82Sstroese		stored in the variable "dnsip", when CONFIG_BOOTP_DNS
943fe389a82Sstroese		is added to the CONFIG_BOOTP_MASK.
944fe389a82Sstroese
945fe389a82Sstroese		CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
946fe389a82Sstroese		to do a dynamic update of a DNS server. To do this, they
947fe389a82Sstroese		need the hostname of the DHCP requester.
948fe389a82Sstroese		If CONFIG_BOOP_SEND_HOSTNAME is added to the
949fe389a82Sstroese		CONFIG_BOOTP_MASK, the content of the "hostname"
950fe389a82Sstroese		environment variable is passed as option 12 to
951fe389a82Sstroese		the DHCP server.
952fe389a82Sstroese
953a3d991bdSwdenk - CDP Options:
954a3d991bdSwdenk 		CONFIG_CDP_DEVICE_ID
955a3d991bdSwdenk
956a3d991bdSwdenk		The device id used in CDP trigger frames.
957a3d991bdSwdenk
958a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID_PREFIX
959a3d991bdSwdenk
960a3d991bdSwdenk		A two character string which is prefixed to the MAC address
961a3d991bdSwdenk		of the device.
962a3d991bdSwdenk
963a3d991bdSwdenk		CONFIG_CDP_PORT_ID
964a3d991bdSwdenk
965a3d991bdSwdenk		A printf format string which contains the ascii name of
966a3d991bdSwdenk		the port. Normally is set to "eth%d" which sets
967a3d991bdSwdenk		eth0 for the first ethernet, eth1 for the second etc.
968a3d991bdSwdenk
969a3d991bdSwdenk		CONFIG_CDP_CAPABILITIES
970a3d991bdSwdenk
971a3d991bdSwdenk		A 32bit integer which indicates the device capabilities;
972a3d991bdSwdenk		0x00000010 for a normal host which does not forwards.
973a3d991bdSwdenk
974a3d991bdSwdenk		CONFIG_CDP_VERSION
975a3d991bdSwdenk
976a3d991bdSwdenk		An ascii string containing the version of the software.
977a3d991bdSwdenk
978a3d991bdSwdenk		CONFIG_CDP_PLATFORM
979a3d991bdSwdenk
980a3d991bdSwdenk		An ascii string containing the name of the platform.
981a3d991bdSwdenk
982a3d991bdSwdenk		CONFIG_CDP_TRIGGER
983a3d991bdSwdenk
984a3d991bdSwdenk		A 32bit integer sent on the trigger.
985a3d991bdSwdenk
986a3d991bdSwdenk		CONFIG_CDP_POWER_CONSUMPTION
987a3d991bdSwdenk
988a3d991bdSwdenk		A 16bit integer containing the power consumption of the
989a3d991bdSwdenk		device in .1 of milliwatts.
990a3d991bdSwdenk
991a3d991bdSwdenk		CONFIG_CDP_APPLIANCE_VLAN_TYPE
992a3d991bdSwdenk
993a3d991bdSwdenk		A byte containing the id of the VLAN.
994a3d991bdSwdenk
995c609719bSwdenk- Status LED:	CONFIG_STATUS_LED
996c609719bSwdenk
997c609719bSwdenk		Several configurations allow to display the current
998c609719bSwdenk		status using a LED. For instance, the LED will blink
999c609719bSwdenk		fast while running U-Boot code, stop blinking as
1000c609719bSwdenk		soon as a reply to a BOOTP request was received, and
1001c609719bSwdenk		start blinking slow once the Linux kernel is running
1002c609719bSwdenk		(supported by a status LED driver in the Linux
1003c609719bSwdenk		kernel). Defining CONFIG_STATUS_LED enables this
1004c609719bSwdenk		feature in U-Boot.
1005c609719bSwdenk
1006c609719bSwdenk- CAN Support:	CONFIG_CAN_DRIVER
1007c609719bSwdenk
1008c609719bSwdenk		Defining CONFIG_CAN_DRIVER enables CAN driver support
1009c609719bSwdenk		on those systems that support this (optional)
1010c609719bSwdenk		feature, like the TQM8xxL modules.
1011c609719bSwdenk
1012c609719bSwdenk- I2C Support:	CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1013c609719bSwdenk
1014b37c7e5eSwdenk		These enable I2C serial bus commands. Defining either of
1015b37c7e5eSwdenk		(but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
1016b37c7e5eSwdenk		include the appropriate I2C driver for the selected cpu.
1017c609719bSwdenk
1018b37c7e5eSwdenk		This will allow you to use i2c commands at the u-boot
1019b37c7e5eSwdenk		command line (as long as you set CFG_CMD_I2C in
1020b37c7e5eSwdenk		CONFIG_COMMANDS) and communicate with i2c based realtime
1021b37c7e5eSwdenk		clock chips. See common/cmd_i2c.c for a description of the
1022c609719bSwdenk		command line interface.
1023c609719bSwdenk
1024b37c7e5eSwdenk		CONFIG_HARD_I2C selects the CPM hardware driver for I2C.
1025c609719bSwdenk
1026b37c7e5eSwdenk		CONFIG_SOFT_I2C configures u-boot to use a software (aka
1027b37c7e5eSwdenk		bit-banging) driver instead of CPM or similar hardware
1028b37c7e5eSwdenk		support for I2C.
1029c609719bSwdenk
1030b37c7e5eSwdenk		There are several other quantities that must also be
1031b37c7e5eSwdenk		defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
1032c609719bSwdenk
1033b37c7e5eSwdenk		In both cases you will need to define CFG_I2C_SPEED
1034b37c7e5eSwdenk		to be the frequency (in Hz) at which you wish your i2c bus
1035b37c7e5eSwdenk		to run and CFG_I2C_SLAVE to be the address of this node (ie
1036b37c7e5eSwdenk		the cpu's i2c node address).
1037c609719bSwdenk
1038b37c7e5eSwdenk		Now, the u-boot i2c code for the mpc8xx (cpu/mpc8xx/i2c.c)
1039b37c7e5eSwdenk		sets the cpu up as a master node and so its address should
1040b37c7e5eSwdenk		therefore be cleared to 0 (See, eg, MPC823e User's Manual
1041b37c7e5eSwdenk		p.16-473). So, set CFG_I2C_SLAVE to 0.
1042b37c7e5eSwdenk
1043b37c7e5eSwdenk		That's all that's required for CONFIG_HARD_I2C.
1044b37c7e5eSwdenk
1045b37c7e5eSwdenk		If you use the software i2c interface (CONFIG_SOFT_I2C)
1046b37c7e5eSwdenk		then the following macros need to be defined (examples are
1047b37c7e5eSwdenk		from include/configs/lwmon.h):
1048c609719bSwdenk
1049c609719bSwdenk		I2C_INIT
1050c609719bSwdenk
1051b37c7e5eSwdenk		(Optional). Any commands necessary to enable the I2C
1052c609719bSwdenk		controller or configure ports.
1053c609719bSwdenk
1054b37c7e5eSwdenk		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
1055b37c7e5eSwdenk
1056c609719bSwdenk		I2C_PORT
1057c609719bSwdenk
1058c609719bSwdenk		(Only for MPC8260 CPU). The I/O port to use (the code
1059c609719bSwdenk		assumes both bits are on the same port). Valid values
1060c609719bSwdenk		are 0..3 for ports A..D.
1061c609719bSwdenk
1062c609719bSwdenk		I2C_ACTIVE
1063c609719bSwdenk
1064c609719bSwdenk		The code necessary to make the I2C data line active
1065c609719bSwdenk		(driven).  If the data line is open collector, this
1066c609719bSwdenk		define can be null.
1067c609719bSwdenk
1068b37c7e5eSwdenk		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
1069b37c7e5eSwdenk
1070c609719bSwdenk		I2C_TRISTATE
1071c609719bSwdenk
1072c609719bSwdenk		The code necessary to make the I2C data line tri-stated
1073c609719bSwdenk		(inactive).  If the data line is open collector, this
1074c609719bSwdenk		define can be null.
1075c609719bSwdenk
1076b37c7e5eSwdenk		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1077b37c7e5eSwdenk
1078c609719bSwdenk		I2C_READ
1079c609719bSwdenk
1080c609719bSwdenk		Code that returns TRUE if the I2C data line is high,
1081c609719bSwdenk		FALSE if it is low.
1082c609719bSwdenk
1083b37c7e5eSwdenk		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1084b37c7e5eSwdenk
1085c609719bSwdenk		I2C_SDA(bit)
1086c609719bSwdenk
1087c609719bSwdenk		If <bit> is TRUE, sets the I2C data line high. If it
1088c609719bSwdenk		is FALSE, it clears it (low).
1089c609719bSwdenk
1090b37c7e5eSwdenk		eg: #define I2C_SDA(bit) \
1091b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
1092b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
1093b37c7e5eSwdenk
1094c609719bSwdenk		I2C_SCL(bit)
1095c609719bSwdenk
1096c609719bSwdenk		If <bit> is TRUE, sets the I2C clock line high. If it
1097c609719bSwdenk		is FALSE, it clears it (low).
1098c609719bSwdenk
1099b37c7e5eSwdenk		eg: #define I2C_SCL(bit) \
1100b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
1101b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
1102b37c7e5eSwdenk
1103c609719bSwdenk		I2C_DELAY
1104c609719bSwdenk
1105c609719bSwdenk		This delay is invoked four times per clock cycle so this
1106c609719bSwdenk		controls the rate of data transfer.  The data rate thus
1107b37c7e5eSwdenk		is 1 / (I2C_DELAY * 4). Often defined to be something
1108b37c7e5eSwdenk		like:
1109b37c7e5eSwdenk
1110b37c7e5eSwdenk		#define I2C_DELAY  udelay(2)
1111c609719bSwdenk
111247cd00faSwdenk		CFG_I2C_INIT_BOARD
111347cd00faSwdenk
111447cd00faSwdenk		When a board is reset during an i2c bus transfer
111547cd00faSwdenk		chips might think that the current transfer is still
111647cd00faSwdenk		in progress. On some boards it is possible to access
111747cd00faSwdenk		the i2c SCLK line directly, either by using the
111847cd00faSwdenk		processor pin as a GPIO or by having a second pin
111947cd00faSwdenk		connected to the bus. If this option is defined a
112047cd00faSwdenk		custom i2c_init_board() routine in boards/xxx/board.c
112147cd00faSwdenk		is run early in the boot sequence.
112247cd00faSwdenk
1123c609719bSwdenk- SPI Support:	CONFIG_SPI
1124c609719bSwdenk
1125c609719bSwdenk		Enables SPI driver (so far only tested with
1126c609719bSwdenk		SPI EEPROM, also an instance works with Crystal A/D and
1127c609719bSwdenk		D/As on the SACSng board)
1128c609719bSwdenk
1129c609719bSwdenk		CONFIG_SPI_X
1130c609719bSwdenk
1131c609719bSwdenk		Enables extended (16-bit) SPI EEPROM addressing.
1132c609719bSwdenk		(symmetrical to CONFIG_I2C_X)
1133c609719bSwdenk
1134c609719bSwdenk		CONFIG_SOFT_SPI
1135c609719bSwdenk
1136c609719bSwdenk		Enables a software (bit-bang) SPI driver rather than
1137c609719bSwdenk		using hardware support. This is a general purpose
1138c609719bSwdenk		driver that only requires three general I/O port pins
1139c609719bSwdenk		(two outputs, one input) to function. If this is
1140c609719bSwdenk		defined, the board configuration must define several
1141c609719bSwdenk		SPI configuration items (port pins to use, etc). For
1142c609719bSwdenk		an example, see include/configs/sacsng.h.
1143c609719bSwdenk
1144c609719bSwdenk- FPGA Support: CONFIG_FPGA_COUNT
1145c609719bSwdenk
1146c609719bSwdenk		Specify the number of FPGA devices to support.
1147c609719bSwdenk
1148c609719bSwdenk		CONFIG_FPGA
1149c609719bSwdenk
1150c609719bSwdenk		Used to specify the types of FPGA devices.  For example,
1151c609719bSwdenk		#define CONFIG_FPGA  CFG_XILINX_VIRTEX2
1152c609719bSwdenk
1153c609719bSwdenk		CFG_FPGA_PROG_FEEDBACK
1154c609719bSwdenk
1155c609719bSwdenk		Enable printing of hash marks during FPGA configuration.
1156c609719bSwdenk
1157c609719bSwdenk		CFG_FPGA_CHECK_BUSY
1158c609719bSwdenk
1159c609719bSwdenk		Enable checks on FPGA configuration interface busy
1160c609719bSwdenk		status by the configuration function. This option
1161c609719bSwdenk		will require a board or device specific function to
1162c609719bSwdenk		be written.
1163c609719bSwdenk
1164c609719bSwdenk		CONFIG_FPGA_DELAY
1165c609719bSwdenk
1166c609719bSwdenk		If defined, a function that provides delays in the FPGA
1167c609719bSwdenk		configuration driver.
1168c609719bSwdenk
1169c609719bSwdenk		CFG_FPGA_CHECK_CTRLC
1170c609719bSwdenk		Allow Control-C to interrupt FPGA configuration
1171c609719bSwdenk
1172c609719bSwdenk		CFG_FPGA_CHECK_ERROR
1173c609719bSwdenk
1174c609719bSwdenk		Check for configuration errors during FPGA bitfile
1175c609719bSwdenk		loading. For example, abort during Virtex II
1176c609719bSwdenk		configuration if the INIT_B line goes low (which
1177c609719bSwdenk		indicated a CRC error).
1178c609719bSwdenk
1179c609719bSwdenk		CFG_FPGA_WAIT_INIT
1180c609719bSwdenk
1181c609719bSwdenk		Maximum time to wait for the INIT_B line to deassert
1182c609719bSwdenk		after PROB_B has been deasserted during a Virtex II
1183c609719bSwdenk		FPGA configuration sequence. The default time is 500
1184c609719bSwdenk		mS.
1185c609719bSwdenk
1186c609719bSwdenk		CFG_FPGA_WAIT_BUSY
1187c609719bSwdenk
1188c609719bSwdenk		Maximum time to wait for BUSY to deassert during
1189c609719bSwdenk		Virtex II FPGA configuration. The default is 5 mS.
1190c609719bSwdenk
1191c609719bSwdenk		CFG_FPGA_WAIT_CONFIG
1192c609719bSwdenk
1193c609719bSwdenk		Time to wait after FPGA configuration. The default is
1194c609719bSwdenk		200 mS.
1195c609719bSwdenk
1196c609719bSwdenk- Configuration Management:
1197c609719bSwdenk		CONFIG_IDENT_STRING
1198c609719bSwdenk
1199c609719bSwdenk		If defined, this string will be added to the U-Boot
1200c609719bSwdenk		version information (U_BOOT_VERSION)
1201c609719bSwdenk
1202c609719bSwdenk- Vendor Parameter Protection:
1203c609719bSwdenk
1204c609719bSwdenk		U-Boot considers the values of the environment
1205c609719bSwdenk		variables "serial#" (Board Serial Number) and
12067152b1d0Swdenk		"ethaddr" (Ethernet Address) to be parameters that
1207c609719bSwdenk		are set once by the board vendor / manufacturer, and
1208c609719bSwdenk		protects these variables from casual modification by
1209c609719bSwdenk		the user. Once set, these variables are read-only,
1210c609719bSwdenk		and write or delete attempts are rejected. You can
1211c609719bSwdenk		change this behviour:
1212c609719bSwdenk
1213c609719bSwdenk		If CONFIG_ENV_OVERWRITE is #defined in your config
1214c609719bSwdenk		file, the write protection for vendor parameters is
121547cd00faSwdenk		completely disabled. Anybody can change or delete
1216c609719bSwdenk		these parameters.
1217c609719bSwdenk
1218c609719bSwdenk		Alternatively, if you #define _both_ CONFIG_ETHADDR
1219c609719bSwdenk		_and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
1220c609719bSwdenk		ethernet address is installed in the environment,
1221c609719bSwdenk		which can be changed exactly ONCE by the user. [The
1222c609719bSwdenk		serial# is unaffected by this, i. e. it remains
1223c609719bSwdenk		read-only.]
1224c609719bSwdenk
1225c609719bSwdenk- Protected RAM:
1226c609719bSwdenk		CONFIG_PRAM
1227c609719bSwdenk
1228c609719bSwdenk		Define this variable to enable the reservation of
1229c609719bSwdenk		"protected RAM", i. e. RAM which is not overwritten
1230c609719bSwdenk		by U-Boot. Define CONFIG_PRAM to hold the number of
1231c609719bSwdenk		kB you want to reserve for pRAM. You can overwrite
1232c609719bSwdenk		this default value by defining an environment
1233c609719bSwdenk		variable "pram" to the number of kB you want to
1234c609719bSwdenk		reserve. Note that the board info structure will
1235c609719bSwdenk		still show the full amount of RAM. If pRAM is
1236c609719bSwdenk		reserved, a new environment variable "mem" will
1237c609719bSwdenk		automatically be defined to hold the amount of
1238c609719bSwdenk		remaining RAM in a form that can be passed as boot
1239c609719bSwdenk		argument to Linux, for instance like that:
1240c609719bSwdenk
1241c609719bSwdenk			setenv bootargs ... mem=\$(mem)
1242c609719bSwdenk			saveenv
1243c609719bSwdenk
1244c609719bSwdenk		This way you can tell Linux not to use this memory,
1245c609719bSwdenk		either, which results in a memory region that will
1246c609719bSwdenk		not be affected by reboots.
1247c609719bSwdenk
1248c609719bSwdenk		*WARNING* If your board configuration uses automatic
1249c609719bSwdenk		detection of the RAM size, you must make sure that
1250c609719bSwdenk		this memory test is non-destructive. So far, the
1251c609719bSwdenk		following board configurations are known to be
1252c609719bSwdenk		"pRAM-clean":
1253c609719bSwdenk
1254c609719bSwdenk			ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
1255c609719bSwdenk			HERMES, IP860, RPXlite, LWMON, LANTEC,
1256c609719bSwdenk			PCU_E, FLAGADM, TQM8260
1257c609719bSwdenk
1258c609719bSwdenk- Error Recovery:
1259c609719bSwdenk		CONFIG_PANIC_HANG
1260c609719bSwdenk
1261c609719bSwdenk		Define this variable to stop the system in case of a
1262c609719bSwdenk		fatal error, so that you have to reset it manually.
1263c609719bSwdenk		This is probably NOT a good idea for an embedded
1264c609719bSwdenk		system where you want to system to reboot
1265c609719bSwdenk		automatically as fast as possible, but it may be
1266c609719bSwdenk		useful during development since you can try to debug
1267c609719bSwdenk		the conditions that lead to the situation.
1268c609719bSwdenk
1269c609719bSwdenk		CONFIG_NET_RETRY_COUNT
1270c609719bSwdenk
1271c609719bSwdenk		This variable defines the number of retries for
1272c609719bSwdenk		network operations like ARP, RARP, TFTP, or BOOTP
1273c609719bSwdenk		before giving up the operation. If not defined, a
1274c609719bSwdenk		default value of 5 is used.
1275c609719bSwdenk
1276c609719bSwdenk- Command Interpreter:
127704a85b3bSwdenk		CFG_AUTO_COMPLETE
127804a85b3bSwdenk
127904a85b3bSwdenk		Enable auto completion of commands using TAB.
128004a85b3bSwdenk
1281c609719bSwdenk		CFG_HUSH_PARSER
1282c609719bSwdenk
1283c609719bSwdenk		Define this variable to enable the "hush" shell (from
1284c609719bSwdenk		Busybox) as command line interpreter, thus enabling
1285c609719bSwdenk		powerful command line syntax like
1286c609719bSwdenk		if...then...else...fi conditionals or `&&' and '||'
1287c609719bSwdenk		constructs ("shell scripts").
1288c609719bSwdenk
1289c609719bSwdenk		If undefined, you get the old, much simpler behaviour
1290c609719bSwdenk		with a somewhat smaller memory footprint.
1291c609719bSwdenk
1292c609719bSwdenk
1293c609719bSwdenk		CFG_PROMPT_HUSH_PS2
1294c609719bSwdenk
1295c609719bSwdenk		This defines the secondary prompt string, which is
1296c609719bSwdenk		printed when the command interpreter needs more input
1297c609719bSwdenk		to complete a command. Usually "> ".
1298c609719bSwdenk
1299c609719bSwdenk	Note:
1300c609719bSwdenk
1301c609719bSwdenk		In the current implementation, the local variables
1302c609719bSwdenk		space and global environment variables space are
1303c609719bSwdenk		separated. Local variables are those you define by
13043b57fe0aSwdenk		simply typing `name=value'. To access a local
1305c609719bSwdenk		variable later on, you have write `$name' or
13063b57fe0aSwdenk		`${name}'; to execute the contents of a variable
13073b57fe0aSwdenk		directly type `$name' at the command prompt.
1308c609719bSwdenk
1309c609719bSwdenk		Global environment variables are those you use
1310c609719bSwdenk		setenv/printenv to work with. To run a command stored
1311c609719bSwdenk		in such a variable, you need to use the run command,
1312c609719bSwdenk		and you must not use the '$' sign to access them.
1313c609719bSwdenk
1314c609719bSwdenk		To store commands and special characters in a
1315c609719bSwdenk		variable, please use double quotation marks
1316c609719bSwdenk		surrounding the whole text of the variable, instead
1317c609719bSwdenk		of the backslashes before semicolons and special
1318c609719bSwdenk		symbols.
1319c609719bSwdenk
1320a8c7c708Swdenk- Default Environment:
1321c609719bSwdenk		CONFIG_EXTRA_ENV_SETTINGS
1322c609719bSwdenk
1323c609719bSwdenk		Define this to contain any number of null terminated
1324c609719bSwdenk		strings (variable = value pairs) that will be part of
13257152b1d0Swdenk		the default environment compiled into the boot image.
13262262cfeeSwdenk
1327c609719bSwdenk		For example, place something like this in your
1328c609719bSwdenk		board's config file:
1329c609719bSwdenk
1330c609719bSwdenk		#define CONFIG_EXTRA_ENV_SETTINGS \
1331c609719bSwdenk			"myvar1=value1\0" \
1332c609719bSwdenk			"myvar2=value2\0"
1333c609719bSwdenk
1334c609719bSwdenk		Warning: This method is based on knowledge about the
1335c609719bSwdenk		internal format how the environment is stored by the
13362262cfeeSwdenk		U-Boot code. This is NOT an official, exported
1337c609719bSwdenk		interface! Although it is unlikely that this format
13387152b1d0Swdenk		will change soon, there is no guarantee either.
1339c609719bSwdenk		You better know what you are doing here.
1340c609719bSwdenk
1341c609719bSwdenk		Note: overly (ab)use of the default environment is
1342c609719bSwdenk		discouraged. Make sure to check other ways to preset
1343c609719bSwdenk		the environment like the autoscript function or the
1344c609719bSwdenk		boot command first.
1345c609719bSwdenk
1346a8c7c708Swdenk- DataFlash Support:
13472abbe075Swdenk		CONFIG_HAS_DATAFLASH
13482abbe075Swdenk
13492abbe075Swdenk		Defining this option enables DataFlash features and
13502abbe075Swdenk		allows to read/write in Dataflash via the standard
13512abbe075Swdenk		commands cp, md...
13522abbe075Swdenk
13533f85ce27Swdenk- SystemACE Support:
13543f85ce27Swdenk		CONFIG_SYSTEMACE
13553f85ce27Swdenk
13563f85ce27Swdenk		Adding this option adds support for Xilinx SystemACE
13573f85ce27Swdenk		chips attached via some sort of local bus. The address
13583f85ce27Swdenk		of the chip must alsh be defined in the
13593f85ce27Swdenk		CFG_SYSTEMACE_BASE macro. For example:
13603f85ce27Swdenk
13613f85ce27Swdenk		#define CONFIG_SYSTEMACE
13623f85ce27Swdenk		#define CFG_SYSTEMACE_BASE 0xf0000000
13633f85ce27Swdenk
13643f85ce27Swdenk		When SystemACE support is added, the "ace" device type
13653f85ce27Swdenk		becomes available to the fat commands, i.e. fatls.
13663f85ce27Swdenk
1367a8c7c708Swdenk- Show boot progress:
1368c609719bSwdenk		CONFIG_SHOW_BOOT_PROGRESS
1369c609719bSwdenk
1370c609719bSwdenk		Defining this option allows to add some board-
1371c609719bSwdenk		specific code (calling a user-provided function
1372c609719bSwdenk		"show_boot_progress(int)") that enables you to show
1373c609719bSwdenk		the system's boot progress on some display (for
1374c609719bSwdenk		example, some LED's) on your board. At the moment,
1375c609719bSwdenk		the following checkpoints are implemented:
1376c609719bSwdenk
1377c609719bSwdenk  Arg	Where			When
1378c609719bSwdenk    1	common/cmd_bootm.c	before attempting to boot an image
1379c609719bSwdenk   -1	common/cmd_bootm.c	Image header has bad	 magic number
1380c609719bSwdenk    2	common/cmd_bootm.c	Image header has correct magic number
1381c609719bSwdenk   -2	common/cmd_bootm.c	Image header has bad	 checksum
1382c609719bSwdenk    3	common/cmd_bootm.c	Image header has correct checksum
1383c609719bSwdenk   -3	common/cmd_bootm.c	Image data   has bad	 checksum
1384c609719bSwdenk    4	common/cmd_bootm.c	Image data   has correct checksum
1385c609719bSwdenk   -4	common/cmd_bootm.c	Image is for unsupported architecture
1386c609719bSwdenk    5	common/cmd_bootm.c	Architecture check OK
1387c609719bSwdenk   -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi, standalone)
1388c609719bSwdenk    6	common/cmd_bootm.c	Image Type check OK
1389c609719bSwdenk   -6	common/cmd_bootm.c	gunzip uncompression error
1390c609719bSwdenk   -7	common/cmd_bootm.c	Unimplemented compression type
1391c609719bSwdenk    7	common/cmd_bootm.c	Uncompression OK
1392c609719bSwdenk   -8	common/cmd_bootm.c	Wrong Image Type (not kernel, multi, standalone)
1393c609719bSwdenk    8	common/cmd_bootm.c	Image Type check OK
1394c609719bSwdenk   -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
1395c609719bSwdenk    9	common/cmd_bootm.c	Start initial ramdisk verification
1396c609719bSwdenk  -10	common/cmd_bootm.c	Ramdisk header has bad	   magic number
1397c609719bSwdenk  -11	common/cmd_bootm.c	Ramdisk header has bad	   checksum
1398c609719bSwdenk   10	common/cmd_bootm.c	Ramdisk header is OK
1399c609719bSwdenk  -12	common/cmd_bootm.c	Ramdisk data   has bad	   checksum
1400c609719bSwdenk   11	common/cmd_bootm.c	Ramdisk data   has correct checksum
1401c609719bSwdenk   12	common/cmd_bootm.c	Ramdisk verification complete, start loading
1402c609719bSwdenk  -13	common/cmd_bootm.c	Wrong Image Type (not PPC Linux Ramdisk)
1403c609719bSwdenk   13	common/cmd_bootm.c	Start multifile image verification
1404c609719bSwdenk   14	common/cmd_bootm.c	No initial ramdisk, no multifile, continue.
1405c609719bSwdenk   15	common/cmd_bootm.c	All preparation done, transferring control to OS
1406c609719bSwdenk
140763e73c9aSwdenk  -30	lib_ppc/board.c		Fatal error, hang the system
140863e73c9aSwdenk  -31	post/post.c		POST test failed, detected by post_output_backlog()
140963e73c9aSwdenk  -32	post/post.c		POST test failed, detected by post_run_single()
141063e73c9aSwdenk
1411c609719bSwdenk   -1	common/cmd_doc.c	Bad usage of "doc" command
1412c609719bSwdenk   -1	common/cmd_doc.c	No boot device
1413c609719bSwdenk   -1	common/cmd_doc.c	Unknown Chip ID on boot device
1414c609719bSwdenk   -1	common/cmd_doc.c	Read Error on boot device
1415c609719bSwdenk   -1	common/cmd_doc.c	Image header has bad magic number
1416c609719bSwdenk
1417c609719bSwdenk   -1	common/cmd_ide.c	Bad usage of "ide" command
1418c609719bSwdenk   -1	common/cmd_ide.c	No boot device
1419c609719bSwdenk   -1	common/cmd_ide.c	Unknown boot device
1420c609719bSwdenk   -1	common/cmd_ide.c	Unknown partition table
1421c609719bSwdenk   -1	common/cmd_ide.c	Invalid partition type
1422c609719bSwdenk   -1	common/cmd_ide.c	Read Error on boot device
1423c609719bSwdenk   -1	common/cmd_ide.c	Image header has bad magic number
1424c609719bSwdenk
1425206c60cbSwdenk   -1	common/cmd_nand.c	Bad usage of "nand" command
1426206c60cbSwdenk   -1	common/cmd_nand.c	No boot device
1427206c60cbSwdenk   -1	common/cmd_nand.c	Unknown Chip ID on boot device
1428206c60cbSwdenk   -1	common/cmd_nand.c	Read Error on boot device
1429206c60cbSwdenk   -1	common/cmd_nand.c	Image header has bad magic number
1430206c60cbSwdenk
1431206c60cbSwdenk   -1	common/env_common.c	Environment has a bad CRC, using default
1432c609719bSwdenk
1433c609719bSwdenk
1434c609719bSwdenkModem Support:
1435c609719bSwdenk--------------
1436c609719bSwdenk
143785ec0bccSwdenk[so far only for SMDK2400 and TRAB boards]
1438c609719bSwdenk
1439c609719bSwdenk- Modem support endable:
1440c609719bSwdenk		CONFIG_MODEM_SUPPORT
1441c609719bSwdenk
1442c609719bSwdenk- RTS/CTS Flow control enable:
1443c609719bSwdenk		CONFIG_HWFLOW
1444c609719bSwdenk
1445c609719bSwdenk- Modem debug support:
1446c609719bSwdenk		CONFIG_MODEM_SUPPORT_DEBUG
1447c609719bSwdenk
1448c609719bSwdenk		Enables debugging stuff (char screen[1024], dbg())
1449c609719bSwdenk		for modem support. Useful only with BDI2000.
1450c609719bSwdenk
1451a8c7c708Swdenk- Interrupt support (PPC):
1452a8c7c708Swdenk
1453a8c7c708Swdenk		There are common interrupt_init() and timer_interrupt()
1454a8c7c708Swdenk		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
1455a8c7c708Swdenk		for cpu specific initialization. interrupt_init_cpu()
1456a8c7c708Swdenk		should set decrementer_count to appropriate value. If
1457a8c7c708Swdenk		cpu resets decrementer automatically after interrupt
1458a8c7c708Swdenk		(ppc4xx) it should set decrementer_count to zero.
1459a8c7c708Swdenk		timer_interrupt() calls timer_interrupt_cpu() for cpu
1460a8c7c708Swdenk		specific handling. If board has watchdog / status_led
1461a8c7c708Swdenk		/ other_activity_monitor it works automatically from
1462a8c7c708Swdenk		general timer_interrupt().
1463a8c7c708Swdenk
1464c609719bSwdenk- General:
1465c609719bSwdenk
1466c609719bSwdenk		In the target system modem support is enabled when a
1467c609719bSwdenk		specific key (key combination) is pressed during
1468c609719bSwdenk		power-on. Otherwise U-Boot will boot normally
1469c609719bSwdenk		(autoboot). The key_pressed() fuction is called from
1470c609719bSwdenk		board_init(). Currently key_pressed() is a dummy
1471c609719bSwdenk		function, returning 1 and thus enabling modem
1472c609719bSwdenk		initialization.
1473c609719bSwdenk
1474c609719bSwdenk		If there are no modem init strings in the
1475c609719bSwdenk		environment, U-Boot proceed to autoboot; the
1476c609719bSwdenk		previous output (banner, info printfs) will be
1477c609719bSwdenk		supressed, though.
1478c609719bSwdenk
1479c609719bSwdenk		See also: doc/README.Modem
1480c609719bSwdenk
1481c609719bSwdenk
1482c609719bSwdenkConfiguration Settings:
1483c609719bSwdenk-----------------------
1484c609719bSwdenk
1485c609719bSwdenk- CFG_LONGHELP: Defined when you want long help messages included;
1486c609719bSwdenk		undefine this when you're short of memory.
1487c609719bSwdenk
1488c609719bSwdenk- CFG_PROMPT:	This is what U-Boot prints on the console to
1489c609719bSwdenk		prompt for user input.
1490c609719bSwdenk
1491c609719bSwdenk- CFG_CBSIZE:	Buffer size for input from the Console
1492c609719bSwdenk
1493c609719bSwdenk- CFG_PBSIZE:	Buffer size for Console output
1494c609719bSwdenk
1495c609719bSwdenk- CFG_MAXARGS:	max. Number of arguments accepted for monitor commands
1496c609719bSwdenk
1497c609719bSwdenk- CFG_BARGSIZE: Buffer size for Boot Arguments which are passed to
1498c609719bSwdenk		the application (usually a Linux kernel) when it is
1499c609719bSwdenk		booted
1500c609719bSwdenk
1501c609719bSwdenk- CFG_BAUDRATE_TABLE:
1502c609719bSwdenk		List of legal baudrate settings for this board.
1503c609719bSwdenk
1504c609719bSwdenk- CFG_CONSOLE_INFO_QUIET
1505c609719bSwdenk		Suppress display of console information at boot.
1506c609719bSwdenk
1507c609719bSwdenk- CFG_CONSOLE_IS_IN_ENV
1508c609719bSwdenk		If the board specific function
1509c609719bSwdenk			extern int overwrite_console (void);
1510c609719bSwdenk		returns 1, the stdin, stderr and stdout are switched to the
1511c609719bSwdenk		serial port, else the settings in the environment are used.
1512c609719bSwdenk
1513c609719bSwdenk- CFG_CONSOLE_OVERWRITE_ROUTINE
1514c609719bSwdenk		Enable the call to overwrite_console().
1515c609719bSwdenk
1516c609719bSwdenk- CFG_CONSOLE_ENV_OVERWRITE
1517c609719bSwdenk		Enable overwrite of previous console environment settings.
1518c609719bSwdenk
1519c609719bSwdenk- CFG_MEMTEST_START, CFG_MEMTEST_END:
1520c609719bSwdenk		Begin and End addresses of the area used by the
1521c609719bSwdenk		simple memory test.
1522c609719bSwdenk
1523c609719bSwdenk- CFG_ALT_MEMTEST:
1524c609719bSwdenk		Enable an alternate, more extensive memory test.
1525c609719bSwdenk
15265f535fe1Swdenk- CFG_MEMTEST_SCRATCH:
15275f535fe1Swdenk		Scratch address used by the alternate memory test
15285f535fe1Swdenk		You only need to set this if address zero isn't writeable
15295f535fe1Swdenk
1530c609719bSwdenk- CFG_TFTP_LOADADDR:
1531c609719bSwdenk		Default load address for network file downloads
1532c609719bSwdenk
1533c609719bSwdenk- CFG_LOADS_BAUD_CHANGE:
1534c609719bSwdenk		Enable temporary baudrate change while serial download
1535c609719bSwdenk
1536c609719bSwdenk- CFG_SDRAM_BASE:
1537c609719bSwdenk		Physical start address of SDRAM. _Must_ be 0 here.
1538c609719bSwdenk
1539c609719bSwdenk- CFG_MBIO_BASE:
1540c609719bSwdenk		Physical start address of Motherboard I/O (if using a
1541c609719bSwdenk		Cogent motherboard)
1542c609719bSwdenk
1543c609719bSwdenk- CFG_FLASH_BASE:
1544c609719bSwdenk		Physical start address of Flash memory.
1545c609719bSwdenk
1546c609719bSwdenk- CFG_MONITOR_BASE:
1547c609719bSwdenk		Physical start address of boot monitor code (set by
1548c609719bSwdenk		make config files to be same as the text base address
1549c609719bSwdenk		(TEXT_BASE) used when linking) - same as
1550c609719bSwdenk		CFG_FLASH_BASE when booting from flash.
1551c609719bSwdenk
1552c609719bSwdenk- CFG_MONITOR_LEN:
15533b57fe0aSwdenk		Size of memory reserved for monitor code, used to
15543b57fe0aSwdenk		determine _at_compile_time_ (!) if the environment is
15553b57fe0aSwdenk		embedded within the U-Boot image, or in a separate
15563b57fe0aSwdenk		flash sector.
1557c609719bSwdenk
1558c609719bSwdenk- CFG_MALLOC_LEN:
1559c609719bSwdenk		Size of DRAM reserved for malloc() use.
1560c609719bSwdenk
1561c609719bSwdenk- CFG_BOOTMAPSZ:
1562c609719bSwdenk		Maximum size of memory mapped by the startup code of
1563c609719bSwdenk		the Linux kernel; all data that must be processed by
1564c609719bSwdenk		the Linux kernel (bd_info, boot arguments, eventually
1565c609719bSwdenk		initrd image) must be put below this limit.
1566c609719bSwdenk
1567c609719bSwdenk- CFG_MAX_FLASH_BANKS:
1568c609719bSwdenk		Max number of Flash memory banks
1569c609719bSwdenk
1570c609719bSwdenk- CFG_MAX_FLASH_SECT:
1571c609719bSwdenk		Max number of sectors on a Flash chip
1572c609719bSwdenk
1573c609719bSwdenk- CFG_FLASH_ERASE_TOUT:
1574c609719bSwdenk		Timeout for Flash erase operations (in ms)
1575c609719bSwdenk
1576c609719bSwdenk- CFG_FLASH_WRITE_TOUT:
1577c609719bSwdenk		Timeout for Flash write operations (in ms)
1578c609719bSwdenk
15798564acf9Swdenk- CFG_FLASH_LOCK_TOUT
15808564acf9Swdenk		Timeout for Flash set sector lock bit operation (in ms)
15818564acf9Swdenk
15828564acf9Swdenk- CFG_FLASH_UNLOCK_TOUT
15838564acf9Swdenk		Timeout for Flash clear lock bits operation (in ms)
15848564acf9Swdenk
15858564acf9Swdenk- CFG_FLASH_PROTECTION
15868564acf9Swdenk		If defined, hardware flash sectors protection is used
15878564acf9Swdenk		instead of U-Boot software protection.
15888564acf9Swdenk
1589c609719bSwdenk- CFG_DIRECT_FLASH_TFTP:
1590c609719bSwdenk
1591c609719bSwdenk		Enable TFTP transfers directly to flash memory;
1592c609719bSwdenk		without this option such a download has to be
1593c609719bSwdenk		performed in two steps: (1) download to RAM, and (2)
1594c609719bSwdenk		copy from RAM to flash.
1595c609719bSwdenk
1596c609719bSwdenk		The two-step approach is usually more reliable, since
1597c609719bSwdenk		you can check if the download worked before you erase
1598c609719bSwdenk		the flash, but in some situations (when sytem RAM is
1599c609719bSwdenk		too limited to allow for a tempory copy of the
1600c609719bSwdenk		downloaded image) this option may be very useful.
1601c609719bSwdenk
1602c609719bSwdenk- CFG_FLASH_CFI:
1603c609719bSwdenk		Define if the flash driver uses extra elements in the
16045653fc33Swdenk		common flash structure for storing flash geometry.
16055653fc33Swdenk
16065653fc33Swdenk- CFG_FLASH_CFI_DRIVER
16075653fc33Swdenk		This option also enables the building of the cfi_flash driver
16085653fc33Swdenk		in the drivers directory
160953cf9435Sstroese
161053cf9435Sstroese- CFG_RX_ETH_BUFFER:
161153cf9435Sstroese		Defines the number of ethernet receive buffers. On some
161253cf9435Sstroese		ethernet controllers it is recommended to set this value
161353cf9435Sstroese		to 8 or even higher (EEPRO100 or 405 EMAC), since all
161453cf9435Sstroese		buffers can be full shortly after enabling the interface
161553cf9435Sstroese		on high ethernet traffic.
161653cf9435Sstroese		Defaults to 4 if not defined.
1617c609719bSwdenk
1618c609719bSwdenkThe following definitions that deal with the placement and management
1619c609719bSwdenkof environment data (variable area); in general, we support the
1620c609719bSwdenkfollowing configurations:
1621c609719bSwdenk
1622c609719bSwdenk- CFG_ENV_IS_IN_FLASH:
1623c609719bSwdenk
1624c609719bSwdenk	Define this if the environment is in flash memory.
1625c609719bSwdenk
1626c609719bSwdenk	a) The environment occupies one whole flash sector, which is
1627c609719bSwdenk	   "embedded" in the text segment with the U-Boot code. This
1628c609719bSwdenk	   happens usually with "bottom boot sector" or "top boot
1629c609719bSwdenk	   sector" type flash chips, which have several smaller
1630c609719bSwdenk	   sectors at the start or the end. For instance, such a
1631c609719bSwdenk	   layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
1632c609719bSwdenk	   such a case you would place the environment in one of the
1633c609719bSwdenk	   4 kB sectors - with U-Boot code before and after it. With
1634c609719bSwdenk	   "top boot sector" type flash chips, you would put the
1635c609719bSwdenk	   environment in one of the last sectors, leaving a gap
1636c609719bSwdenk	   between U-Boot and the environment.
1637c609719bSwdenk
1638c609719bSwdenk	- CFG_ENV_OFFSET:
1639c609719bSwdenk
1640c609719bSwdenk	   Offset of environment data (variable area) to the
1641c609719bSwdenk	   beginning of flash memory; for instance, with bottom boot
1642c609719bSwdenk	   type flash chips the second sector can be used: the offset
1643c609719bSwdenk	   for this sector is given here.
1644c609719bSwdenk
1645c609719bSwdenk	   CFG_ENV_OFFSET is used relative to CFG_FLASH_BASE.
1646c609719bSwdenk
1647c609719bSwdenk	- CFG_ENV_ADDR:
1648c609719bSwdenk
1649c609719bSwdenk	   This is just another way to specify the start address of
1650c609719bSwdenk	   the flash sector containing the environment (instead of
1651c609719bSwdenk	   CFG_ENV_OFFSET).
1652c609719bSwdenk
1653c609719bSwdenk	- CFG_ENV_SECT_SIZE:
1654c609719bSwdenk
1655c609719bSwdenk	   Size of the sector containing the environment.
1656c609719bSwdenk
1657c609719bSwdenk
1658c609719bSwdenk	b) Sometimes flash chips have few, equal sized, BIG sectors.
1659c609719bSwdenk	   In such a case you don't want to spend a whole sector for
1660c609719bSwdenk	   the environment.
1661c609719bSwdenk
1662c609719bSwdenk	- CFG_ENV_SIZE:
1663c609719bSwdenk
1664c609719bSwdenk	   If you use this in combination with CFG_ENV_IS_IN_FLASH
1665c609719bSwdenk	   and CFG_ENV_SECT_SIZE, you can specify to use only a part
1666c609719bSwdenk	   of this flash sector for the environment. This saves
1667c609719bSwdenk	   memory for the RAM copy of the environment.
1668c609719bSwdenk
1669c609719bSwdenk	   It may also save flash memory if you decide to use this
1670c609719bSwdenk	   when your environment is "embedded" within U-Boot code,
1671c609719bSwdenk	   since then the remainder of the flash sector could be used
1672c609719bSwdenk	   for U-Boot code. It should be pointed out that this is
1673c609719bSwdenk	   STRONGLY DISCOURAGED from a robustness point of view:
1674c609719bSwdenk	   updating the environment in flash makes it always
1675c609719bSwdenk	   necessary to erase the WHOLE sector. If something goes
1676c609719bSwdenk	   wrong before the contents has been restored from a copy in
1677c609719bSwdenk	   RAM, your target system will be dead.
1678c609719bSwdenk
1679c609719bSwdenk	- CFG_ENV_ADDR_REDUND
1680c609719bSwdenk	  CFG_ENV_SIZE_REDUND
1681c609719bSwdenk
1682c609719bSwdenk	   These settings describe a second storage area used to hold
1683c609719bSwdenk	   a redundand copy of the environment data, so that there is
16843e38691eSwdenk	   a valid backup copy in case there is a power failure during
1685c609719bSwdenk	   a "saveenv" operation.
1686c609719bSwdenk
1687c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the
1688c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds*
1689c609719bSwdenkaccordingly!
1690c609719bSwdenk
1691c609719bSwdenk
1692c609719bSwdenk- CFG_ENV_IS_IN_NVRAM:
1693c609719bSwdenk
1694c609719bSwdenk	Define this if you have some non-volatile memory device
1695c609719bSwdenk	(NVRAM, battery buffered SRAM) which you want to use for the
1696c609719bSwdenk	environment.
1697c609719bSwdenk
1698c609719bSwdenk	- CFG_ENV_ADDR:
1699c609719bSwdenk	- CFG_ENV_SIZE:
1700c609719bSwdenk
1701c609719bSwdenk	  These two #defines are used to determin the memory area you
1702c609719bSwdenk	  want to use for environment. It is assumed that this memory
1703c609719bSwdenk	  can just be read and written to, without any special
1704c609719bSwdenk	  provision.
1705c609719bSwdenk
1706c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early
1707c609719bSwdenkin U-Boot initalization (when we try to get the setting of for the
1708c609719bSwdenkconsole baudrate). You *MUST* have mappend your NVRAM area then, or
1709c609719bSwdenkU-Boot will hang.
1710c609719bSwdenk
1711c609719bSwdenkPlease note that even with NVRAM we still use a copy of the
1712c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to
1713c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv"
1714c609719bSwdenkto save the current settings.
1715c609719bSwdenk
1716c609719bSwdenk
1717c609719bSwdenk- CFG_ENV_IS_IN_EEPROM:
1718c609719bSwdenk
1719c609719bSwdenk	Use this if you have an EEPROM or similar serial access
1720c609719bSwdenk	device and a driver for it.
1721c609719bSwdenk
1722c609719bSwdenk	- CFG_ENV_OFFSET:
1723c609719bSwdenk	- CFG_ENV_SIZE:
1724c609719bSwdenk
1725c609719bSwdenk	  These two #defines specify the offset and size of the
1726c609719bSwdenk	  environment area within the total memory of your EEPROM.
1727c609719bSwdenk
1728c609719bSwdenk	- CFG_I2C_EEPROM_ADDR:
1729c609719bSwdenk	  If defined, specified the chip address of the EEPROM device.
1730c609719bSwdenk	  The default address is zero.
1731c609719bSwdenk
1732c609719bSwdenk	- CFG_EEPROM_PAGE_WRITE_BITS:
1733c609719bSwdenk	  If defined, the number of bits used to address bytes in a
1734c609719bSwdenk	  single page in the EEPROM device.  A 64 byte page, for example
1735c609719bSwdenk	  would require six bits.
1736c609719bSwdenk
1737c609719bSwdenk	- CFG_EEPROM_PAGE_WRITE_DELAY_MS:
1738c609719bSwdenk	  If defined, the number of milliseconds to delay between
1739c609719bSwdenk	  page writes.	The default is zero milliseconds.
1740c609719bSwdenk
1741c609719bSwdenk	- CFG_I2C_EEPROM_ADDR_LEN:
1742c609719bSwdenk	  The length in bytes of the EEPROM memory array address.  Note
1743c609719bSwdenk	  that this is NOT the chip address length!
1744c609719bSwdenk
1745c609719bSwdenk	- CFG_EEPROM_SIZE:
1746c609719bSwdenk	  The size in bytes of the EEPROM device.
1747c609719bSwdenk
1748c609719bSwdenk
17495779d8d9Swdenk- CFG_ENV_IS_IN_DATAFLASH:
17505779d8d9Swdenk
17515779d8d9Swdenk	Define this if you have a DataFlash memory device which you
17525779d8d9Swdenk	want to use for the environment.
17535779d8d9Swdenk
17545779d8d9Swdenk	- CFG_ENV_OFFSET:
17555779d8d9Swdenk	- CFG_ENV_ADDR:
17565779d8d9Swdenk	- CFG_ENV_SIZE:
17575779d8d9Swdenk
17585779d8d9Swdenk	  These three #defines specify the offset and size of the
17595779d8d9Swdenk	  environment area within the total memory of your DataFlash placed
17605779d8d9Swdenk	  at the specified address.
17615779d8d9Swdenk
17625779d8d9Swdenk
1763c609719bSwdenk- CFG_SPI_INIT_OFFSET
1764c609719bSwdenk
1765c609719bSwdenk	Defines offset to the initial SPI buffer area in DPRAM. The
1766c609719bSwdenk	area is used at an early stage (ROM part) if the environment
1767c609719bSwdenk	is configured to reside in the SPI EEPROM: We need a 520 byte
1768c609719bSwdenk	scratch DPRAM area. It is used between the two initialization
1769c609719bSwdenk	calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
1770c609719bSwdenk	to be a good choice since it makes it far enough from the
1771c609719bSwdenk	start of the data area as well as from the stack pointer.
1772c609719bSwdenk
1773c609719bSwdenkPlease note that the environment is read-only as long as the monitor
1774c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been
1775c609719bSwdenkcreated; also, when using EEPROM you will have to use getenv_r()
1776c609719bSwdenkuntil then to read environment variables.
1777c609719bSwdenk
177885ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor
177985ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working
178085ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is
178185ec0bccSwdenknecessary, because the first environment variable we need is the
178285ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't
178385ec0bccSwdenkhave any device yet where we could complain.]
1784c609719bSwdenk
1785c609719bSwdenkNote: once the monitor has been relocated, then it will complain if
1786c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you
178785ec0bccSwdenkuse the "saveenv" command to store a valid environment.
1788c609719bSwdenk
1789fc3e2165Swdenk- CFG_FAULT_ECHO_LINK_DOWN:
1790fc3e2165Swdenk		Echo the inverted Ethernet link state to the fault LED.
1791fc3e2165Swdenk
1792fc3e2165Swdenk		Note: If this option is active, then CFG_FAULT_MII_ADDR
1793fc3e2165Swdenk		      also needs to be defined.
1794fc3e2165Swdenk
1795fc3e2165Swdenk- CFG_FAULT_MII_ADDR:
1796fc3e2165Swdenk		MII address of the PHY to check for the Ethernet link state.
1797c609719bSwdenk
1798c40b2956Swdenk- CFG_64BIT_VSPRINTF:
1799c40b2956Swdenk		Makes vsprintf (and all *printf functions) support printing
1800c40b2956Swdenk		of 64bit values by using the L quantifier
1801c40b2956Swdenk
1802c40b2956Swdenk- CFG_64BIT_STRTOUL:
1803c40b2956Swdenk		Adds simple_strtoull that returns a 64bit value
1804c40b2956Swdenk
1805c609719bSwdenkLow Level (hardware related) configuration options:
1806dc7c9a1aSwdenk---------------------------------------------------
1807c609719bSwdenk
1808c609719bSwdenk- CFG_CACHELINE_SIZE:
1809c609719bSwdenk		Cache Line Size of the CPU.
1810c609719bSwdenk
1811c609719bSwdenk- CFG_DEFAULT_IMMR:
1812c609719bSwdenk		Default address of the IMMR after system reset.
18132535d602Swdenk
18142535d602Swdenk		Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
18152535d602Swdenk		and RPXsuper) to be able to adjust the position of
18162535d602Swdenk		the IMMR register after a reset.
1817c609719bSwdenk
18187f6c2cbcSwdenk- Floppy Disk Support:
18197f6c2cbcSwdenk		CFG_FDC_DRIVE_NUMBER
18207f6c2cbcSwdenk
18217f6c2cbcSwdenk		the default drive number (default value 0)
18227f6c2cbcSwdenk
18237f6c2cbcSwdenk		CFG_ISA_IO_STRIDE
18247f6c2cbcSwdenk
18257f6c2cbcSwdenk		defines the spacing between fdc chipset registers
18267f6c2cbcSwdenk		(default value 1)
18277f6c2cbcSwdenk
18287f6c2cbcSwdenk		CFG_ISA_IO_OFFSET
18297f6c2cbcSwdenk
18307f6c2cbcSwdenk		defines the offset of register from address. It
18317f6c2cbcSwdenk		depends on which part of the data bus is connected to
18327f6c2cbcSwdenk		the fdc chipset. (default value 0)
18337f6c2cbcSwdenk
18347f6c2cbcSwdenk		If CFG_ISA_IO_STRIDE CFG_ISA_IO_OFFSET and
18357f6c2cbcSwdenk		CFG_FDC_DRIVE_NUMBER are undefined, they take their
18367f6c2cbcSwdenk		default value.
18377f6c2cbcSwdenk
18387f6c2cbcSwdenk		if CFG_FDC_HW_INIT is defined, then the function
18397f6c2cbcSwdenk		fdc_hw_init() is called at the beginning of the FDC
18407f6c2cbcSwdenk		setup. fdc_hw_init() must be provided by the board
18417f6c2cbcSwdenk		source code. It is used to make hardware dependant
18427f6c2cbcSwdenk		initializations.
18437f6c2cbcSwdenk
1844c609719bSwdenk- CFG_IMMR:	Physical address of the Internal Memory Mapped
1845c609719bSwdenk		Register; DO NOT CHANGE! (11-4)
1846c609719bSwdenk		[MPC8xx systems only]
1847c609719bSwdenk
1848c609719bSwdenk- CFG_INIT_RAM_ADDR:
1849c609719bSwdenk
18507152b1d0Swdenk		Start address of memory area that can be used for
1851c609719bSwdenk		initial data and stack; please note that this must be
1852c609719bSwdenk		writable memory that is working WITHOUT special
1853c609719bSwdenk		initialization, i. e. you CANNOT use normal RAM which
1854c609719bSwdenk		will become available only after programming the
1855c609719bSwdenk		memory controller and running certain initialization
1856c609719bSwdenk		sequences.
1857c609719bSwdenk
1858c609719bSwdenk		U-Boot uses the following memory types:
1859c609719bSwdenk		- MPC8xx and MPC8260: IMMR (internal memory of the CPU)
1860c609719bSwdenk		- MPC824X: data cache
1861c609719bSwdenk		- PPC4xx:  data cache
1862c609719bSwdenk
186385ec0bccSwdenk- CFG_GBL_DATA_OFFSET:
1864c609719bSwdenk
1865c609719bSwdenk		Offset of the initial data structure in the memory
1866c609719bSwdenk		area defined by CFG_INIT_RAM_ADDR. Usually
186785ec0bccSwdenk		CFG_GBL_DATA_OFFSET is chosen such that the initial
1868c609719bSwdenk		data is located at the end of the available space
1869c609719bSwdenk		(sometimes written as (CFG_INIT_RAM_END -
1870c609719bSwdenk		CFG_INIT_DATA_SIZE), and the initial stack is just
1871c609719bSwdenk		below that area (growing from (CFG_INIT_RAM_ADDR +
187285ec0bccSwdenk		CFG_GBL_DATA_OFFSET) downward.
1873c609719bSwdenk
1874c609719bSwdenk	Note:
1875c609719bSwdenk		On the MPC824X (or other systems that use the data
1876c609719bSwdenk		cache for initial memory) the address chosen for
1877c609719bSwdenk		CFG_INIT_RAM_ADDR is basically arbitrary - it must
1878c609719bSwdenk		point to an otherwise UNUSED address space between
1879c609719bSwdenk		the top of RAM and the start of the PCI space.
1880c609719bSwdenk
1881c609719bSwdenk- CFG_SIUMCR:	SIU Module Configuration (11-6)
1882c609719bSwdenk
1883c609719bSwdenk- CFG_SYPCR:	System Protection Control (11-9)
1884c609719bSwdenk
1885c609719bSwdenk- CFG_TBSCR:	Time Base Status and Control (11-26)
1886c609719bSwdenk
1887c609719bSwdenk- CFG_PISCR:	Periodic Interrupt Status and Control (11-31)
1888c609719bSwdenk
1889c609719bSwdenk- CFG_PLPRCR:	PLL, Low-Power, and Reset Control Register (15-30)
1890c609719bSwdenk
1891c609719bSwdenk- CFG_SCCR:	System Clock and reset Control Register (15-27)
1892c609719bSwdenk
1893c609719bSwdenk- CFG_OR_TIMING_SDRAM:
1894c609719bSwdenk		SDRAM timing
1895c609719bSwdenk
1896c609719bSwdenk- CFG_MAMR_PTA:
1897c609719bSwdenk		periodic timer for refresh
1898c609719bSwdenk
1899c609719bSwdenk- CFG_DER:	Debug Event Register (37-47)
1900c609719bSwdenk
1901c609719bSwdenk- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CFG_REMAP_OR_AM,
1902c609719bSwdenk  CFG_PRELIM_OR_AM, CFG_OR_TIMING_FLASH, CFG_OR0_REMAP,
1903c609719bSwdenk  CFG_OR0_PRELIM, CFG_BR0_PRELIM, CFG_OR1_REMAP, CFG_OR1_PRELIM,
1904c609719bSwdenk  CFG_BR1_PRELIM:
1905c609719bSwdenk		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
1906c609719bSwdenk
1907c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
1908c609719bSwdenk  CFG_OR_TIMING_SDRAM, CFG_OR2_PRELIM, CFG_BR2_PRELIM,
1909c609719bSwdenk  CFG_OR3_PRELIM, CFG_BR3_PRELIM:
1910c609719bSwdenk		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
1911c609719bSwdenk
1912c609719bSwdenk- CFG_MAMR_PTA, CFG_MPTPR_2BK_4K, CFG_MPTPR_1BK_4K, CFG_MPTPR_2BK_8K,
1913c609719bSwdenk  CFG_MPTPR_1BK_8K, CFG_MAMR_8COL, CFG_MAMR_9COL:
1914c609719bSwdenk		Machine Mode Register and Memory Periodic Timer
1915c609719bSwdenk		Prescaler definitions (SDRAM timing)
1916c609719bSwdenk
1917c609719bSwdenk- CFG_I2C_UCODE_PATCH, CFG_I2C_DPMEM_OFFSET [0x1FC0]:
1918c609719bSwdenk		enable I2C microcode relocation patch (MPC8xx);
1919c609719bSwdenk		define relocation offset in DPRAM [DSP2]
1920c609719bSwdenk
1921c609719bSwdenk- CFG_SPI_UCODE_PATCH, CFG_SPI_DPMEM_OFFSET [0x1FC0]:
1922c609719bSwdenk		enable SPI microcode relocation patch (MPC8xx);
1923c609719bSwdenk		define relocation offset in DPRAM [SCC4]
1924c609719bSwdenk
1925c609719bSwdenk- CFG_USE_OSCCLK:
1926c609719bSwdenk		Use OSCM clock mode on MBX8xx board. Be careful,
1927c609719bSwdenk		wrong setting might damage your board. Read
1928c609719bSwdenk		doc/README.MBX before setting this variable!
1929c609719bSwdenk
1930ea909b76Swdenk- CFG_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
1931ea909b76Swdenk		Offset of the bootmode word in DPRAM used by post
1932ea909b76Swdenk		(Power On Self Tests). This definition overrides
1933ea909b76Swdenk		#define'd default value in commproc.h resp.
1934ea909b76Swdenk		cpm_8260.h.
1935ea909b76Swdenk
19365d232d0eSwdenk- CFG_PCI_SLV_MEM_LOCAL, CFG_PCI_SLV_MEM_BUS, CFG_PICMR0_MASK_ATTRIB,
19375d232d0eSwdenk  CFG_PCI_MSTR0_LOCAL, CFG_PCIMSK0_MASK, CFG_PCI_MSTR1_LOCAL,
19385d232d0eSwdenk  CFG_PCIMSK1_MASK, CFG_PCI_MSTR_MEM_LOCAL, CFG_PCI_MSTR_MEM_BUS,
19395d232d0eSwdenk  CFG_CPU_PCI_MEM_START, CFG_PCI_MSTR_MEM_SIZE, CFG_POCMR0_MASK_ATTRIB,
19405d232d0eSwdenk  CFG_PCI_MSTR_MEMIO_LOCAL, CFG_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
19415d232d0eSwdenk  CFG_PCI_MSTR_MEMIO_SIZE, CFG_POCMR1_MASK_ATTRIB, CFG_PCI_MSTR_IO_LOCAL,
19425d232d0eSwdenk  CFG_PCI_MSTR_IO_BUS, CFG_CPU_PCI_IO_START, CFG_PCI_MSTR_IO_SIZE,
19435d232d0eSwdenk  CFG_POCMR2_MASK_ATTRIB: (MPC826x only)
19445d232d0eSwdenk		Overrides the default PCI memory map in cpu/mpc8260/pci.c if set.
19455d232d0eSwdenk
1946*c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12]
1947*c26e454dSwdenk		Define to enable FEC[12] on a 8xx series processor.
1948*c26e454dSwdenk
1949*c26e454dSwdenk- CONFIG_FEC[12]_PHY
1950*c26e454dSwdenk		Define to the hardcoded PHY address which corresponds
1951*c26e454dSwdenk		to the given FEC.
1952*c26e454dSwdenk
1953*c26e454dSwdenk		i.e.
1954*c26e454dSwdenk                  #define CONFIG_FEC1_PHY 4
1955*c26e454dSwdenk		means that the PHY with address 4 is connected to FEC1
1956*c26e454dSwdenk
1957*c26e454dSwdenk		When set to -1, means to probe for first available.
1958*c26e454dSwdenk
1959*c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR
1960*c26e454dSwdenk		The PHY does not have a RXERR line (RMII only).
1961*c26e454dSwdenk		(so program the FEC to ignore it).
1962*c26e454dSwdenk
1963*c26e454dSwdenk- CONFIG_RMII
1964*c26e454dSwdenk		Enable RMII mode for all FECs.
1965*c26e454dSwdenk		Note that this is a global option, we can't
1966*c26e454dSwdenk		have one FEC in standard MII mode and another in RMII mode.
1967*c26e454dSwdenk
1968c609719bSwdenkBuilding the Software:
1969c609719bSwdenk======================
1970c609719bSwdenk
1971c609719bSwdenkBuilding U-Boot has been tested in native PPC environments (on a
1972c609719bSwdenkPowerBook G3 running LinuxPPC 2000) and in cross environments
1973c609719bSwdenk(running RedHat 6.x and 7.x Linux on x86, Solaris 2.6 on a SPARC, and
1974c609719bSwdenkNetBSD 1.5 on x86).
1975c609719bSwdenk
1976c609719bSwdenkIf you are not using a native PPC environment, it is assumed that you
1977c609719bSwdenkhave the GNU cross compiling tools available in your path and named
1978c609719bSwdenkwith a prefix of "powerpc-linux-". If this is not the case, (e.g. if
1979c609719bSwdenkyou are using Monta Vista's Hard Hat Linux CDK 1.2) you must change
1980c609719bSwdenkthe definition of CROSS_COMPILE in Makefile. For HHL on a 4xx CPU,
1981c609719bSwdenkchange it to:
1982c609719bSwdenk
1983c609719bSwdenk	CROSS_COMPILE = ppc_4xx-
1984c609719bSwdenk
1985c609719bSwdenk
1986c609719bSwdenkU-Boot is intended to be  simple  to  build.  After  installing	 the
1987c609719bSwdenksources	 you must configure U-Boot for one specific board type. This
1988c609719bSwdenkis done by typing:
1989c609719bSwdenk
1990c609719bSwdenk	make NAME_config
1991c609719bSwdenk
1992c609719bSwdenkwhere "NAME_config" is the name of one of the existing
1993c609719bSwdenkconfigurations; the following names are supported:
1994c609719bSwdenk
1995db01a2eaSwdenk	ADCIOP_config		ADS860_config		AR405_config
1996db01a2eaSwdenk	at91rm9200dk_config	CANBT_config		cmi_mpc5xx_config
1997db01a2eaSwdenk	cogent_common_config	cogent_mpc8260_config	cogent_mpc8xx_config
1998db01a2eaSwdenk	CPCI405_config		CPCIISER4_config	CU824_config
1999db01a2eaSwdenk	DUET_ADS_config		EBONY_config		ELPT860_config
2000db01a2eaSwdenk	ESTEEM192E_config	ETX094_config		FADS823_config
2001db01a2eaSwdenk	FADS850SAR_config	FADS860T_config		FPS850L_config
2002db01a2eaSwdenk	FPS860L_config		GEN860T_config		GENIETV_config
2003db01a2eaSwdenk	GTH_config		hermes_config		hymod_config
2004db01a2eaSwdenk	IP860_config		IVML24_config		IVMS8_config
2005db01a2eaSwdenk	JSE_config		LANTEC_config		lwmon_config
2006db01a2eaSwdenk	MBX860T_config		MBX_config		MPC8260ADS_config
2007db01a2eaSwdenk	MPC8540ADS_config	MPC8560ADS_config	NETVIA_config
2008db01a2eaSwdenk	omap1510inn_config	omap1610h2_config	omap1610inn_config
2009db01a2eaSwdenk	pcu_e_config		PIP405_config		QS823_config
2010db01a2eaSwdenk	QS850_config		QS860T_config		RPXlite_config
2011db01a2eaSwdenk	RPXsuper_config		rsdproto_config		Sandpoint8240_config
2012db01a2eaSwdenk	sbc8260_config		SM850_config		SPD823TS_config
2013db01a2eaSwdenk	SXNI855T_config		TQM823L_config		TQM850L_config
2014db01a2eaSwdenk	TQM855L_config		TQM860L_config		WALNUT405_config
2015db01a2eaSwdenk	ZPC1900_config
201654387ac9Swdenk
2017c609719bSwdenk	Note: for some board special configuration names may exist; check  if
2018c609719bSwdenk	      additional  information is available from the board vendor; for
2019c609719bSwdenk	      instance, the TQM8xxL systems run normally at 50 MHz and use  a
2020c609719bSwdenk	      SCC  for	10baseT	 ethernet; there are also systems with 80 MHz
2021c609719bSwdenk	      CPU clock, and an optional Fast Ethernet	module	is  available
2022c609719bSwdenk	      for  CPU's  with FEC. You can select such additional "features"
2023c609719bSwdenk	      when chosing the configuration, i. e.
2024c609719bSwdenk
2025c609719bSwdenk	      make TQM860L_config
2026c609719bSwdenk		- will configure for a plain TQM860L, i. e. 50MHz, no FEC
2027c609719bSwdenk
2028c609719bSwdenk	      make TQM860L_FEC_config
2029c609719bSwdenk		- will configure for a TQM860L at 50MHz with FEC for ethernet
2030c609719bSwdenk
2031c609719bSwdenk	      make TQM860L_80MHz_config
2032c609719bSwdenk		- will configure for a TQM860L at 80 MHz, with normal 10baseT
2033c609719bSwdenk		  interface
2034c609719bSwdenk
2035c609719bSwdenk	      make TQM860L_FEC_80MHz_config
2036c609719bSwdenk		- will configure for a TQM860L at 80 MHz with FEC for ethernet
2037c609719bSwdenk
2038c609719bSwdenk	      make TQM823L_LCD_config
2039c609719bSwdenk		- will configure for a TQM823L with U-Boot console on LCD
2040c609719bSwdenk
2041c609719bSwdenk	      make TQM823L_LCD_80MHz_config
2042c609719bSwdenk		- will configure for a TQM823L at 80 MHz with U-Boot console on LCD
2043c609719bSwdenk
2044c609719bSwdenk	      etc.
2045c609719bSwdenk
2046c609719bSwdenk
2047c609719bSwdenk	Finally, type "make all", and you should get some working U-Boot
20487152b1d0Swdenk	images ready for download to / installation on your system:
2049c609719bSwdenk
2050c609719bSwdenk	- "u-boot.bin" is a raw binary image
2051c609719bSwdenk	- "u-boot" is an image in ELF binary format
2052c609719bSwdenk	- "u-boot.srec" is in Motorola S-Record format
2053c609719bSwdenk
2054c609719bSwdenk
2055c609719bSwdenk	Please be aware that the Makefiles assume you are using GNU make, so
2056c609719bSwdenk	for instance on NetBSD you might need to use "gmake" instead of
2057c609719bSwdenk	native "make".
2058c609719bSwdenk
2059c609719bSwdenk
2060c609719bSwdenk	If the system board that you have is not listed, then you will need
2061c609719bSwdenk	to port U-Boot to your hardware platform. To do this, follow these
2062c609719bSwdenk	steps:
2063c609719bSwdenk
2064c609719bSwdenk	1.  Add a new configuration option for your board to the toplevel
206585ec0bccSwdenk	    "Makefile" and to the "MAKEALL" script, using the existing
206685ec0bccSwdenk	    entries as examples. Note that here and at many other places
20677152b1d0Swdenk	    boards and other names are listed in alphabetical sort order. Please
206885ec0bccSwdenk	    keep this order.
2069c609719bSwdenk	2.  Create a new directory to hold your board specific code. Add any
207085ec0bccSwdenk	    files you need. In your board directory, you will need at least
207185ec0bccSwdenk	    the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
207285ec0bccSwdenk	3.  Create a new configuration file "include/configs/<board>.h" for
207385ec0bccSwdenk	    your board
2074c609719bSwdenk	3.  If you're porting U-Boot to a new CPU, then also create a new
2075c609719bSwdenk	    directory to hold your CPU specific code. Add any files you need.
207685ec0bccSwdenk	4.  Run "make <board>_config" with your new name.
2077c609719bSwdenk	5.  Type "make", and you should get a working "u-boot.srec" file
2078c609719bSwdenk	    to be installed on your target system.
207985ec0bccSwdenk	6.  Debug and solve any problems that might arise.
2080c609719bSwdenk	    [Of course, this last step is much harder than it sounds.]
2081c609719bSwdenk
2082c609719bSwdenk
2083c609719bSwdenk	Testing of U-Boot Modifications, Ports to New Hardware, etc.:
2084c609719bSwdenk	==============================================================
2085c609719bSwdenk
2086c609719bSwdenk	If you have modified U-Boot sources (for instance added a new	board
2087c609719bSwdenk	or  support  for  new  devices,	 a new CPU, etc.) you are expected to
2088c609719bSwdenk	provide feedback to the other developers. The feedback normally takes
2089c609719bSwdenk	the form of a "patch", i. e. a context diff against a certain (latest
2090c609719bSwdenk	official or latest in CVS) version of U-Boot sources.
2091c609719bSwdenk
2092c609719bSwdenk	But before you submit such a patch, please verify that	your  modifi-
2093c609719bSwdenk	cation	did not break existing code. At least make sure that *ALL* of
2094c609719bSwdenk	the supported boards compile WITHOUT ANY compiler warnings. To do so,
2095c609719bSwdenk	just run the "MAKEALL" script, which will configure and build U-Boot
2096c609719bSwdenk	for ALL supported system. Be warned, this will take a while. You  can
20977152b1d0Swdenk	select	which  (cross)	compiler  to use by passing a `CROSS_COMPILE'
2098c609719bSwdenk	environment variable to the script, i. e. to use the cross tools from
2099c609719bSwdenk	MontaVista's Hard Hat Linux you can type
2100c609719bSwdenk
2101c609719bSwdenk		CROSS_COMPILE=ppc_8xx- MAKEALL
2102c609719bSwdenk
2103c609719bSwdenk	or to build on a native PowerPC system you can type
2104c609719bSwdenk
2105c609719bSwdenk		CROSS_COMPILE=' ' MAKEALL
2106c609719bSwdenk
2107c609719bSwdenk	See also "U-Boot Porting Guide" below.
2108c609719bSwdenk
2109c609719bSwdenk
2110c609719bSwdenk	Monitor Commands - Overview:
2111c609719bSwdenk	============================
2112c609719bSwdenk
2113c609719bSwdenk	go	- start application at address 'addr'
2114c609719bSwdenk	run	- run commands in an environment variable
2115c609719bSwdenk	bootm	- boot application image from memory
2116c609719bSwdenk	bootp	- boot image via network using BootP/TFTP protocol
2117c609719bSwdenk	tftpboot- boot image via network using TFTP protocol
2118c609719bSwdenk		       and env variables "ipaddr" and "serverip"
2119c609719bSwdenk		       (and eventually "gatewayip")
2120c609719bSwdenk	rarpboot- boot image via network using RARP/TFTP protocol
2121c609719bSwdenk	diskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
2122c609719bSwdenk	loads	- load S-Record file over serial line
2123c609719bSwdenk	loadb	- load binary file over serial line (kermit mode)
2124c609719bSwdenk	md	- memory display
2125c609719bSwdenk	mm	- memory modify (auto-incrementing)
2126c609719bSwdenk	nm	- memory modify (constant address)
2127c609719bSwdenk	mw	- memory write (fill)
2128c609719bSwdenk	cp	- memory copy
2129c609719bSwdenk	cmp	- memory compare
2130c609719bSwdenk	crc32	- checksum calculation
2131c609719bSwdenk	imd	- i2c memory display
2132c609719bSwdenk	imm	- i2c memory modify (auto-incrementing)
2133c609719bSwdenk	inm	- i2c memory modify (constant address)
2134c609719bSwdenk	imw	- i2c memory write (fill)
2135c609719bSwdenk	icrc32	- i2c checksum calculation
2136c609719bSwdenk	iprobe	- probe to discover valid I2C chip addresses
2137c609719bSwdenk	iloop	- infinite loop on address range
2138c609719bSwdenk	isdram	- print SDRAM configuration information
2139c609719bSwdenk	sspi	- SPI utility commands
2140c609719bSwdenk	base	- print or set address offset
2141c609719bSwdenk	printenv- print environment variables
2142c609719bSwdenk	setenv	- set environment variables
2143c609719bSwdenk	saveenv - save environment variables to persistent storage
2144c609719bSwdenk	protect - enable or disable FLASH write protection
2145c609719bSwdenk	erase	- erase FLASH memory
2146c609719bSwdenk	flinfo	- print FLASH memory information
2147c609719bSwdenk	bdinfo	- print Board Info structure
2148c609719bSwdenk	iminfo	- print header information for application image
2149c609719bSwdenk	coninfo - print console devices and informations
2150c609719bSwdenk	ide	- IDE sub-system
2151c609719bSwdenk	loop	- infinite loop on address range
2152c609719bSwdenk	mtest	- simple RAM test
2153c609719bSwdenk	icache	- enable or disable instruction cache
2154c609719bSwdenk	dcache	- enable or disable data cache
2155c609719bSwdenk	reset	- Perform RESET of the CPU
2156c609719bSwdenk	echo	- echo args to console
2157c609719bSwdenk	version - print monitor version
2158c609719bSwdenk	help	- print online help
2159c609719bSwdenk	?	- alias for 'help'
2160c609719bSwdenk
2161c609719bSwdenk
2162c609719bSwdenk	Monitor Commands - Detailed Description:
2163c609719bSwdenk	========================================
2164c609719bSwdenk
2165c609719bSwdenk	TODO.
2166c609719bSwdenk
2167c609719bSwdenk	For now: just type "help <command>".
2168c609719bSwdenk
2169c609719bSwdenk
2170c609719bSwdenk	Environment Variables:
2171c609719bSwdenk	======================
2172c609719bSwdenk
2173c609719bSwdenk	U-Boot supports user configuration using Environment Variables which
2174c609719bSwdenk	can be made persistent by saving to Flash memory.
2175c609719bSwdenk
2176c609719bSwdenk	Environment Variables are set using "setenv", printed using
2177c609719bSwdenk	"printenv", and saved to Flash using "saveenv". Using "setenv"
2178c609719bSwdenk	without a value can be used to delete a variable from the
2179c609719bSwdenk	environment. As long as you don't save the environment you are
2180c609719bSwdenk	working with an in-memory copy. In case the Flash area containing the
2181c609719bSwdenk	environment is erased by accident, a default environment is provided.
2182c609719bSwdenk
2183c609719bSwdenk	Some configuration options can be set using Environment Variables:
2184c609719bSwdenk
2185c609719bSwdenk	  baudrate	- see CONFIG_BAUDRATE
2186c609719bSwdenk
2187c609719bSwdenk	  bootdelay	- see CONFIG_BOOTDELAY
2188c609719bSwdenk
2189c609719bSwdenk	  bootcmd	- see CONFIG_BOOTCOMMAND
2190c609719bSwdenk
2191c609719bSwdenk	  bootargs	- Boot arguments when booting an RTOS image
2192c609719bSwdenk
2193c609719bSwdenk	  bootfile	- Name of the image to load with TFTP
2194c609719bSwdenk
2195c609719bSwdenk	  autoload	- if set to "no" (any string beginning with 'n'),
2196c609719bSwdenk			  "bootp" will just load perform a lookup of the
2197c609719bSwdenk			  configuration from the BOOTP server, but not try to
2198c609719bSwdenk			  load any image using TFTP
2199c609719bSwdenk
2200c609719bSwdenk	  autostart	- if set to "yes", an image loaded using the "bootp",
2201c609719bSwdenk			  "rarpboot", "tftpboot" or "diskboot" commands will
2202c609719bSwdenk			  be automatically started (by internally calling
2203c609719bSwdenk			  "bootm")
2204c609719bSwdenk
22054a6fd34bSwdenk			  If set to "no", a standalone image passed to the
22064a6fd34bSwdenk			  "bootm" command will be copied to the load address
22074a6fd34bSwdenk			  (and eventually uncompressed), but NOT be started.
22084a6fd34bSwdenk			  This can be used to load and uncompress arbitrary
22094a6fd34bSwdenk			  data.
22104a6fd34bSwdenk
2211c609719bSwdenk	  initrd_high	- restrict positioning of initrd images:
2212c609719bSwdenk			  If this variable is not set, initrd images will be
2213c609719bSwdenk			  copied to the highest possible address in RAM; this
2214c609719bSwdenk			  is usually what you want since it allows for
2215c609719bSwdenk			  maximum initrd size. If for some reason you want to
2216c609719bSwdenk			  make sure that the initrd image is loaded below the
2217c609719bSwdenk			  CFG_BOOTMAPSZ limit, you can set this environment
2218c609719bSwdenk			  variable to a value of "no" or "off" or "0".
2219c609719bSwdenk			  Alternatively, you can set it to a maximum upper
2220c609719bSwdenk			  address to use (U-Boot will still check that it
2221c609719bSwdenk			  does not overwrite the U-Boot stack and data).
2222c609719bSwdenk
2223c609719bSwdenk			  For instance, when you have a system with 16 MB
22247152b1d0Swdenk			  RAM, and want to reserve 4 MB from use by Linux,
2225c609719bSwdenk			  you can do this by adding "mem=12M" to the value of
2226c609719bSwdenk			  the "bootargs" variable. However, now you must make
22277152b1d0Swdenk			  sure that the initrd image is placed in the first
2228c609719bSwdenk			  12 MB as well - this can be done with
2229c609719bSwdenk
2230c609719bSwdenk			  setenv initrd_high 00c00000
2231c609719bSwdenk
223238b99261Swdenk			  If you set initrd_high to 0xFFFFFFFF, this is an
223338b99261Swdenk			  indication to U-Boot that all addresses are legal
223438b99261Swdenk			  for the Linux kernel, including addresses in flash
223538b99261Swdenk			  memory. In this case U-Boot will NOT COPY the
223638b99261Swdenk			  ramdisk at all. This may be useful to reduce the
223738b99261Swdenk			  boot time on your system, but requires that this
223838b99261Swdenk			  feature is supported by your Linux kernel.
223938b99261Swdenk
2240c609719bSwdenk	  ipaddr	- IP address; needed for tftpboot command
2241c609719bSwdenk
2242c609719bSwdenk	  loadaddr	- Default load address for commands like "bootp",
2243dc7c9a1aSwdenk			  "rarpboot", "tftpboot", "loadb" or "diskboot"
2244c609719bSwdenk
2245c609719bSwdenk	  loads_echo	- see CONFIG_LOADS_ECHO
2246c609719bSwdenk
2247c609719bSwdenk	  serverip	- TFTP server IP address; needed for tftpboot command
2248c609719bSwdenk
2249c609719bSwdenk	  bootretry	- see CONFIG_BOOT_RETRY_TIME
2250c609719bSwdenk
2251c609719bSwdenk	  bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
2252c609719bSwdenk
2253c609719bSwdenk	  bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
2254c609719bSwdenk
2255a3d991bdSwdenk	  ethprime	- When CONFIG_NET_MULTI is enabled controls which
2256a3d991bdSwdenk			  interface is used first.
2257a3d991bdSwdenk
2258a3d991bdSwdenk	  ethact	- When CONFIG_NET_MULTI is enabled controls which
2259a3d991bdSwdenk			  interface is currently active. For example you
2260a3d991bdSwdenk			  can do the following
2261a3d991bdSwdenk
2262a3d991bdSwdenk			  => setenv ethact FEC ETHERNET
2263a3d991bdSwdenk			  => ping 192.168.0.1 # traffic sent on FEC ETHERNET
2264a3d991bdSwdenk			  => setenv ethact SCC ETHERNET
2265a3d991bdSwdenk			  => ping 10.0.0.1 # traffic sent on SCC ETHERNET
2266a3d991bdSwdenk
2267a3d991bdSwdenk	   netretry	- When set to "no" each network operation will
2268a3d991bdSwdenk			  either succeed or fail without retrying.
2269a3d991bdSwdenk			  Useful on scripts which control the retry operation
2270a3d991bdSwdenk			  themselves.
2271a3d991bdSwdenk
2272a3d991bdSwdenk	   vlan		- When set to a value < 4095 the traffic over
2273a3d991bdSwdenk			  ethernet is encapsulated/received over 802.1q
2274a3d991bdSwdenk			  VLAN tagged frames.
2275c609719bSwdenk
2276c609719bSwdenk	The following environment variables may be used and automatically
2277c609719bSwdenk	updated by the network boot commands ("bootp" and "rarpboot"),
2278c609719bSwdenk	depending the information provided by your boot server:
2279c609719bSwdenk
2280c609719bSwdenk	  bootfile	- see above
2281c609719bSwdenk	  dnsip		- IP address of your Domain Name Server
2282fe389a82Sstroese	  dnsip2	- IP address of your secondary Domain Name Server
2283c609719bSwdenk	  gatewayip	- IP address of the Gateway (Router) to use
2284c609719bSwdenk	  hostname	- Target hostname
2285c609719bSwdenk	  ipaddr	- see above
2286c609719bSwdenk	  netmask	- Subnet Mask
2287c609719bSwdenk	  rootpath	- Pathname of the root filesystem on the NFS server
2288c609719bSwdenk	  serverip	- see above
2289c609719bSwdenk
2290c609719bSwdenk
2291c609719bSwdenk	There are two special Environment Variables:
2292c609719bSwdenk
2293c609719bSwdenk	  serial#	- contains hardware identification information such
2294c609719bSwdenk			  as type string and/or serial number
2295c609719bSwdenk	  ethaddr	- Ethernet address
2296c609719bSwdenk
2297c609719bSwdenk	These variables can be set only once (usually during manufacturing of
2298c609719bSwdenk	the board). U-Boot refuses to delete or overwrite these variables
2299c609719bSwdenk	once they have been set once.
2300c609719bSwdenk
2301c609719bSwdenk
2302c1551ea8Sstroese	Further special Environment Variables:
2303c1551ea8Sstroese
2304c1551ea8Sstroese	  ver		- Contains the U-Boot version string as printed
2305c1551ea8Sstroese			  with the "version" command. This variable is
2306c1551ea8Sstroese			  readonly (see CONFIG_VERSION_VARIABLE).
2307c1551ea8Sstroese
2308c1551ea8Sstroese
2309c609719bSwdenk	Please note that changes to some configuration parameters may take
2310c609719bSwdenk	only effect after the next boot (yes, that's just like Windoze :-).
2311c609719bSwdenk
2312c609719bSwdenk
2313f07771ccSwdenk	Command Line Parsing:
2314f07771ccSwdenk	=====================
2315f07771ccSwdenk
2316f07771ccSwdenk	There are two different command line parsers available with U-Boot:
23177152b1d0Swdenk	the old "simple" one, and the much more powerful "hush" shell:
2318f07771ccSwdenk
2319f07771ccSwdenk	Old, simple command line parser:
2320f07771ccSwdenk	--------------------------------
2321f07771ccSwdenk
2322f07771ccSwdenk	- supports environment variables (through setenv / saveenv commands)
2323f07771ccSwdenk	- several commands on one line, separated by ';'
2324f07771ccSwdenk	- variable substitution using "... $(name) ..." syntax
2325f07771ccSwdenk	- special characters ('$', ';') can be escaped by prefixing with '\',
2326f07771ccSwdenk	  for example:
2327f07771ccSwdenk		setenv bootcmd bootm \$(address)
2328f07771ccSwdenk	- You can also escape text by enclosing in single apostrophes, for example:
2329f07771ccSwdenk		setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
2330f07771ccSwdenk
2331f07771ccSwdenk	Hush shell:
2332f07771ccSwdenk	-----------
2333f07771ccSwdenk
2334f07771ccSwdenk	- similar to Bourne shell, with control structures like
2335f07771ccSwdenk	  if...then...else...fi, for...do...done; while...do...done,
2336f07771ccSwdenk	  until...do...done, ...
2337f07771ccSwdenk	- supports environment ("global") variables (through setenv / saveenv
2338f07771ccSwdenk	  commands) and local shell variables (through standard shell syntax
2339f07771ccSwdenk	  "name=value"); only environment variables can be used with "run"
2340f07771ccSwdenk	  command
2341f07771ccSwdenk
2342f07771ccSwdenk	General rules:
2343f07771ccSwdenk	--------------
2344f07771ccSwdenk
2345f07771ccSwdenk	(1) If a command line (or an environment variable executed by a "run"
2346f07771ccSwdenk	    command) contains several commands separated by semicolon, and
2347f07771ccSwdenk	    one of these commands fails, then the remaining commands will be
2348f07771ccSwdenk	    executed anyway.
2349f07771ccSwdenk
2350f07771ccSwdenk	(2) If you execute several variables with one call to run (i. e.
2351f07771ccSwdenk	    calling run with a list af variables as arguments), any failing
2352f07771ccSwdenk	    command will cause "run" to terminate, i. e. the remaining
2353f07771ccSwdenk	    variables are not executed.
2354f07771ccSwdenk
2355c609719bSwdenk	Note for Redundant Ethernet Interfaces:
2356c609719bSwdenk	=======================================
2357c609719bSwdenk
23587152b1d0Swdenk	Some boards come with redundant ethernet interfaces; U-Boot supports
2359c609719bSwdenk	such configurations and is capable of automatic selection of a
23607152b1d0Swdenk	"working" interface when needed. MAC assignment works as follows:
2361c609719bSwdenk
2362c609719bSwdenk	Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
2363c609719bSwdenk	MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
2364c609719bSwdenk	"eth1addr" (=>eth1), "eth2addr", ...
2365c609719bSwdenk
2366c609719bSwdenk	If the network interface stores some valid MAC address (for instance
2367c609719bSwdenk	in SROM), this is used as default address if there is NO correspon-
2368c609719bSwdenk	ding setting in the environment; if the corresponding environment
2369c609719bSwdenk	variable is set, this overrides the settings in the card; that means:
2370c609719bSwdenk
2371c609719bSwdenk	o If the SROM has a valid MAC address, and there is no address in the
2372c609719bSwdenk	  environment, the SROM's address is used.
2373c609719bSwdenk
2374c609719bSwdenk	o If there is no valid address in the SROM, and a definition in the
2375c609719bSwdenk	  environment exists, then the value from the environment variable is
2376c609719bSwdenk	  used.
2377c609719bSwdenk
2378c609719bSwdenk	o If both the SROM and the environment contain a MAC address, and
2379c609719bSwdenk	  both addresses are the same, this MAC address is used.
2380c609719bSwdenk
2381c609719bSwdenk	o If both the SROM and the environment contain a MAC address, and the
2382c609719bSwdenk	  addresses differ, the value from the environment is used and a
2383c609719bSwdenk	  warning is printed.
2384c609719bSwdenk
2385c609719bSwdenk	o If neither SROM nor the environment contain a MAC address, an error
2386c609719bSwdenk	  is raised.
2387c609719bSwdenk
2388c609719bSwdenk
2389c609719bSwdenk	Image Formats:
2390c609719bSwdenk	==============
2391c609719bSwdenk
2392c609719bSwdenk	The "boot" commands of this monitor operate on "image" files which
2393c609719bSwdenk	can be basicly anything, preceeded by a special header; see the
2394c609719bSwdenk	definitions in include/image.h for details; basicly, the header
2395c609719bSwdenk	defines the following image properties:
2396c609719bSwdenk
2397c609719bSwdenk	* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
2398c609719bSwdenk	  4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
23997f70e853Swdenk	  LynxOS, pSOS, QNX, RTEMS, ARTOS;
24001f4bb37dSwdenk	  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, ARTOS, LynxOS).
2401c609719bSwdenk	* Target CPU Architecture (Provisions for Alpha, ARM, Intel x86,
24023d1e8a9dSwdenk	  IA64, MIPS, NIOS, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
24033d1e8a9dSwdenk	  Currently supported: ARM, Intel x86, MIPS, NIOS, PowerPC).
2404c29fdfc1Swdenk	* Compression Type (uncompressed, gzip, bzip2)
2405c609719bSwdenk	* Load Address
2406c609719bSwdenk	* Entry Point
2407c609719bSwdenk	* Image Name
2408c609719bSwdenk	* Image Timestamp
2409c609719bSwdenk
2410c609719bSwdenk	The header is marked by a special Magic Number, and both the header
2411c609719bSwdenk	and the data portions of the image are secured against corruption by
2412c609719bSwdenk	CRC32 checksums.
2413c609719bSwdenk
2414c609719bSwdenk
2415c609719bSwdenk	Linux Support:
2416c609719bSwdenk	==============
2417c609719bSwdenk
2418c609719bSwdenk	Although U-Boot should support any OS or standalone application
24197152b1d0Swdenk	easily, the main focus has always been on Linux during the design of
2420c609719bSwdenk	U-Boot.
2421c609719bSwdenk
2422c609719bSwdenk	U-Boot includes many features that so far have been part of some
2423c609719bSwdenk	special "boot loader" code within the Linux kernel. Also, any
2424c609719bSwdenk	"initrd" images to be used are no longer part of one big Linux image;
2425c609719bSwdenk	instead, kernel and "initrd" are separate images. This implementation
24267152b1d0Swdenk	serves several purposes:
2427c609719bSwdenk
2428c609719bSwdenk	- the same features can be used for other OS or standalone
2429c609719bSwdenk	  applications (for instance: using compressed images to reduce the
2430c609719bSwdenk	  Flash memory footprint)
2431c609719bSwdenk
2432c609719bSwdenk	- it becomes much easier to port new Linux kernel versions because
24337152b1d0Swdenk	  lots of low-level, hardware dependent stuff are done by U-Boot
2434c609719bSwdenk
2435c609719bSwdenk	- the same Linux kernel image can now be used with different "initrd"
2436c609719bSwdenk	  images; of course this also means that different kernel images can
2437c609719bSwdenk	  be run with the same "initrd". This makes testing easier (you don't
2438c609719bSwdenk	  have to build a new "zImage.initrd" Linux image when you just
2439c609719bSwdenk	  change a file in your "initrd"). Also, a field-upgrade of the
2440c609719bSwdenk	  software is easier now.
2441c609719bSwdenk
2442c609719bSwdenk
2443c609719bSwdenk	Linux HOWTO:
2444c609719bSwdenk	============
2445c609719bSwdenk
2446c609719bSwdenk	Porting Linux to U-Boot based systems:
2447c609719bSwdenk	---------------------------------------
2448c609719bSwdenk
2449c609719bSwdenk	U-Boot cannot save you from doing all the necessary modifications to
2450c609719bSwdenk	configure the Linux device drivers for use with your target hardware
2451c609719bSwdenk	(no, we don't intend to provide a full virtual machine interface to
2452c609719bSwdenk	Linux :-).
2453c609719bSwdenk
2454c609719bSwdenk	But now you can ignore ALL boot loader code (in arch/ppc/mbxboot).
2455c609719bSwdenk
2456c609719bSwdenk	Just make sure your machine specific header file (for instance
2457c609719bSwdenk	include/asm-ppc/tqm8xx.h) includes the same definition of the Board
2458c609719bSwdenk	Information structure as we define in include/u-boot.h, and make
2459c609719bSwdenk	sure that your definition of IMAP_ADDR uses the same value as your
2460c609719bSwdenk	U-Boot configuration in CFG_IMMR.
2461c609719bSwdenk
2462c609719bSwdenk
2463c609719bSwdenk	Configuring the Linux kernel:
2464c609719bSwdenk	-----------------------------
2465c609719bSwdenk
2466c609719bSwdenk	No specific requirements for U-Boot. Make sure you have some root
2467c609719bSwdenk	device (initial ramdisk, NFS) for your target system.
2468c609719bSwdenk
2469c609719bSwdenk
2470c609719bSwdenk	Building a Linux Image:
2471c609719bSwdenk	-----------------------
2472c609719bSwdenk
247324ee89b9Swdenk	With U-Boot, "normal" build targets like "zImage" or "bzImage" are
247424ee89b9Swdenk	not used. If you use recent kernel source, a new build target
247524ee89b9Swdenk	"uImage" will exist which automatically builds an image usable by
247624ee89b9Swdenk	U-Boot. Most older kernels also have support for a "pImage" target,
247724ee89b9Swdenk	which was introduced for our predecessor project PPCBoot and uses a
247824ee89b9Swdenk	100% compatible format.
2479c609719bSwdenk
2480c609719bSwdenk	Example:
2481c609719bSwdenk
2482c609719bSwdenk		make TQM850L_config
2483c609719bSwdenk		make oldconfig
2484c609719bSwdenk		make dep
248524ee89b9Swdenk		make uImage
2486c609719bSwdenk
248724ee89b9Swdenk	The "uImage" build target uses a special tool (in 'tools/mkimage') to
248824ee89b9Swdenk	encapsulate a compressed Linux kernel image with header	 information,
248924ee89b9Swdenk	CRC32 checksum etc. for use with U-Boot. This is what we are doing:
2490c609719bSwdenk
249124ee89b9Swdenk	* build a standard "vmlinux" kernel image (in ELF binary format):
249224ee89b9Swdenk
249324ee89b9Swdenk	* convert the kernel into a raw binary image:
249424ee89b9Swdenk
249524ee89b9Swdenk		${CROSS_COMPILE}-objcopy -O binary \
249624ee89b9Swdenk					 -R .note -R .comment \
249724ee89b9Swdenk					 -S vmlinux linux.bin
249824ee89b9Swdenk
249924ee89b9Swdenk	* compress the binary image:
250024ee89b9Swdenk
250124ee89b9Swdenk		gzip -9 linux.bin
250224ee89b9Swdenk
250324ee89b9Swdenk	* package compressed binary image for U-Boot:
250424ee89b9Swdenk
250524ee89b9Swdenk		mkimage -A ppc -O linux -T kernel -C gzip \
250624ee89b9Swdenk			-a 0 -e 0 -n "Linux Kernel Image" \
250724ee89b9Swdenk			-d linux.bin.gz uImage
250824ee89b9Swdenk
250924ee89b9Swdenk
251024ee89b9Swdenk	The "mkimage" tool can also be used to create ramdisk images for use
251124ee89b9Swdenk	with U-Boot, either separated from the Linux kernel image, or
251224ee89b9Swdenk	combined into one file. "mkimage" encapsulates the images with a 64
251324ee89b9Swdenk	byte header containing information about target architecture,
251424ee89b9Swdenk	operating system, image type, compression method, entry points, time
251524ee89b9Swdenk	stamp, CRC32 checksums, etc.
251624ee89b9Swdenk
251724ee89b9Swdenk	"mkimage" can be called in two ways: to verify existing images and
251824ee89b9Swdenk	print the header information, or to build new images.
2519c609719bSwdenk
2520c609719bSwdenk	In the first form (with "-l" option) mkimage lists the information
2521c609719bSwdenk	contained in the header of an existing U-Boot image; this includes
2522c609719bSwdenk	checksum verification:
2523c609719bSwdenk
2524c609719bSwdenk		tools/mkimage -l image
2525c609719bSwdenk		  -l ==> list image header information
2526c609719bSwdenk
2527c609719bSwdenk	The second form (with "-d" option) is used to build a U-Boot image
2528c609719bSwdenk	from a "data file" which is used as image payload:
2529c609719bSwdenk
2530c609719bSwdenk		tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
2531c609719bSwdenk			      -n name -d data_file image
2532c609719bSwdenk		  -A ==> set architecture to 'arch'
2533c609719bSwdenk		  -O ==> set operating system to 'os'
2534c609719bSwdenk		  -T ==> set image type to 'type'
2535c609719bSwdenk		  -C ==> set compression type 'comp'
2536c609719bSwdenk		  -a ==> set load address to 'addr' (hex)
2537c609719bSwdenk		  -e ==> set entry point to 'ep' (hex)
2538c609719bSwdenk		  -n ==> set image name to 'name'
2539c609719bSwdenk		  -d ==> use image data from 'datafile'
2540c609719bSwdenk
2541c609719bSwdenk	Right now, all Linux kernels use the same load address	(0x00000000),
2542c609719bSwdenk	but the entry point address depends on the kernel version:
2543c609719bSwdenk
2544c609719bSwdenk	- 2.2.x kernels have the entry point at 0x0000000C,
254524ee89b9Swdenk	- 2.3.x and later kernels have the entry point at 0x00000000.
2546c609719bSwdenk
2547c609719bSwdenk	So a typical call to build a U-Boot image would read:
2548c609719bSwdenk
254924ee89b9Swdenk		-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
255024ee89b9Swdenk		> -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
255124ee89b9Swdenk		> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz \
255224ee89b9Swdenk		> examples/uImage.TQM850L
255324ee89b9Swdenk		Image Name:   2.4.4 kernel for TQM850L
2554c609719bSwdenk		Created:      Wed Jul 19 02:34:59 2000
2555c609719bSwdenk		Image Type:   PowerPC Linux Kernel Image (gzip compressed)
2556c609719bSwdenk		Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
2557c609719bSwdenk		Load Address: 0x00000000
255824ee89b9Swdenk		Entry Point:  0x00000000
2559c609719bSwdenk
2560c609719bSwdenk	To verify the contents of the image (or check for corruption):
2561c609719bSwdenk
256224ee89b9Swdenk		-> tools/mkimage -l examples/uImage.TQM850L
256324ee89b9Swdenk		Image Name:   2.4.4 kernel for TQM850L
2564c609719bSwdenk		Created:      Wed Jul 19 02:34:59 2000
2565c609719bSwdenk		Image Type:   PowerPC Linux Kernel Image (gzip compressed)
2566c609719bSwdenk		Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
2567c609719bSwdenk		Load Address: 0x00000000
256824ee89b9Swdenk		Entry Point:  0x00000000
2569c609719bSwdenk
2570c609719bSwdenk	NOTE: for embedded systems where boot time is critical you can trade
2571c609719bSwdenk	speed for memory and install an UNCOMPRESSED image instead: this
2572c609719bSwdenk	needs more space in Flash, but boots much faster since it does not
2573c609719bSwdenk	need to be uncompressed:
2574c609719bSwdenk
257524ee89b9Swdenk		-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz
257624ee89b9Swdenk		-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
257724ee89b9Swdenk		> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
257824ee89b9Swdenk		> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux \
257924ee89b9Swdenk		> examples/uImage.TQM850L-uncompressed
258024ee89b9Swdenk		Image Name:   2.4.4 kernel for TQM850L
2581c609719bSwdenk		Created:      Wed Jul 19 02:34:59 2000
2582c609719bSwdenk		Image Type:   PowerPC Linux Kernel Image (uncompressed)
2583c609719bSwdenk		Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
2584c609719bSwdenk		Load Address: 0x00000000
258524ee89b9Swdenk		Entry Point:  0x00000000
2586c609719bSwdenk
2587c609719bSwdenk
2588c609719bSwdenk	Similar you can build U-Boot images from a 'ramdisk.image.gz' file
2589c609719bSwdenk	when your kernel is intended to use an initial ramdisk:
2590c609719bSwdenk
2591c609719bSwdenk		-> tools/mkimage -n 'Simple Ramdisk Image' \
2592c609719bSwdenk		> -A ppc -O linux -T ramdisk -C gzip \
2593c609719bSwdenk		> -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
2594c609719bSwdenk		Image Name:   Simple Ramdisk Image
2595c609719bSwdenk		Created:      Wed Jan 12 14:01:50 2000
2596c609719bSwdenk		Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
2597c609719bSwdenk		Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
2598c609719bSwdenk		Load Address: 0x00000000
2599c609719bSwdenk		Entry Point:  0x00000000
2600c609719bSwdenk
2601c609719bSwdenk
2602c609719bSwdenk	Installing a Linux Image:
2603c609719bSwdenk	-------------------------
2604c609719bSwdenk
2605c609719bSwdenk	To downloading a U-Boot image over the serial (console) interface,
2606c609719bSwdenk	you must convert the image to S-Record format:
2607c609719bSwdenk
2608c609719bSwdenk		objcopy -I binary -O srec examples/image examples/image.srec
2609c609719bSwdenk
2610c609719bSwdenk	The 'objcopy' does not understand the information in the U-Boot
2611c609719bSwdenk	image header, so the resulting S-Record file will be relative to
2612c609719bSwdenk	address 0x00000000. To load it to a given address, you need to
2613c609719bSwdenk	specify the target address as 'offset' parameter with the 'loads'
2614c609719bSwdenk	command.
2615c609719bSwdenk
2616c609719bSwdenk	Example: install the image to address 0x40100000 (which on the
2617c609719bSwdenk	TQM8xxL is in the first Flash bank):
2618c609719bSwdenk
2619c609719bSwdenk		=> erase 40100000 401FFFFF
2620c609719bSwdenk
2621c609719bSwdenk		.......... done
2622c609719bSwdenk		Erased 8 sectors
2623c609719bSwdenk
2624c609719bSwdenk		=> loads 40100000
2625c609719bSwdenk		## Ready for S-Record download ...
2626c609719bSwdenk		~>examples/image.srec
2627c609719bSwdenk		1 2 3 4 5 6 7 8 9 10 11 12 13 ...
2628c609719bSwdenk		...
2629c609719bSwdenk		15989 15990 15991 15992
2630c609719bSwdenk		[file transfer complete]
2631c609719bSwdenk		[connected]
2632c609719bSwdenk		## Start Addr = 0x00000000
2633c609719bSwdenk
2634c609719bSwdenk
2635c609719bSwdenk	You can check the success of the download using the 'iminfo' command;
2636c609719bSwdenk	this includes a checksum verification so you  can  be  sure  no	 data
2637c609719bSwdenk	corruption happened:
2638c609719bSwdenk
2639c609719bSwdenk		=> imi 40100000
2640c609719bSwdenk
2641c609719bSwdenk		## Checking Image at 40100000 ...
2642c609719bSwdenk		   Image Name:	 2.2.13 for initrd on TQM850L
2643c609719bSwdenk		   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
2644c609719bSwdenk		   Data Size:	 335725 Bytes = 327 kB = 0 MB
2645c609719bSwdenk		   Load Address: 00000000
2646c609719bSwdenk		   Entry Point:	 0000000c
2647c609719bSwdenk		   Verifying Checksum ... OK
2648c609719bSwdenk
2649c609719bSwdenk
2650c609719bSwdenk	Boot Linux:
2651c609719bSwdenk	-----------
2652c609719bSwdenk
2653c609719bSwdenk	The "bootm" command is used to boot an application that is stored in
2654c609719bSwdenk	memory (RAM or Flash). In case of a Linux kernel image, the contents
2655c609719bSwdenk	of the "bootargs" environment variable is passed to the kernel as
2656c609719bSwdenk	parameters. You can check and modify this variable using the
2657c609719bSwdenk	"printenv" and "setenv" commands:
2658c609719bSwdenk
2659c609719bSwdenk
2660c609719bSwdenk		=> printenv bootargs
2661c609719bSwdenk		bootargs=root=/dev/ram
2662c609719bSwdenk
2663c609719bSwdenk		=> setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
2664c609719bSwdenk
2665c609719bSwdenk		=> printenv bootargs
2666c609719bSwdenk		bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
2667c609719bSwdenk
2668c609719bSwdenk		=> bootm 40020000
2669c609719bSwdenk		## Booting Linux kernel at 40020000 ...
2670c609719bSwdenk		   Image Name:	 2.2.13 for NFS on TQM850L
2671c609719bSwdenk		   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
2672c609719bSwdenk		   Data Size:	 381681 Bytes = 372 kB = 0 MB
2673c609719bSwdenk		   Load Address: 00000000
2674c609719bSwdenk		   Entry Point:	 0000000c
2675c609719bSwdenk		   Verifying Checksum ... OK
2676c609719bSwdenk		   Uncompressing Kernel Image ... OK
2677c609719bSwdenk		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
2678c609719bSwdenk		Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
2679c609719bSwdenk		time_init: decrementer frequency = 187500000/60
2680c609719bSwdenk		Calibrating delay loop... 49.77 BogoMIPS
2681c609719bSwdenk		Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
2682c609719bSwdenk		...
2683c609719bSwdenk
2684c609719bSwdenk	If you want to boot a Linux kernel with initial ram disk, you pass
26857152b1d0Swdenk	the memory addresses of both the kernel and the initrd image (PPBCOOT
2686c609719bSwdenk	format!) to the "bootm" command:
2687c609719bSwdenk
2688c609719bSwdenk		=> imi 40100000 40200000
2689c609719bSwdenk
2690c609719bSwdenk		## Checking Image at 40100000 ...
2691c609719bSwdenk		   Image Name:	 2.2.13 for initrd on TQM850L
2692c609719bSwdenk		   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
2693c609719bSwdenk		   Data Size:	 335725 Bytes = 327 kB = 0 MB
2694c609719bSwdenk		   Load Address: 00000000
2695c609719bSwdenk		   Entry Point:	 0000000c
2696c609719bSwdenk		   Verifying Checksum ... OK
2697c609719bSwdenk
2698c609719bSwdenk		## Checking Image at 40200000 ...
2699c609719bSwdenk		   Image Name:	 Simple Ramdisk Image
2700c609719bSwdenk		   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
2701c609719bSwdenk		   Data Size:	 566530 Bytes = 553 kB = 0 MB
2702c609719bSwdenk		   Load Address: 00000000
2703c609719bSwdenk		   Entry Point:	 00000000
2704c609719bSwdenk		   Verifying Checksum ... OK
2705c609719bSwdenk
2706c609719bSwdenk		=> bootm 40100000 40200000
2707c609719bSwdenk		## Booting Linux kernel at 40100000 ...
2708c609719bSwdenk		   Image Name:	 2.2.13 for initrd on TQM850L
2709c609719bSwdenk		   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
2710c609719bSwdenk		   Data Size:	 335725 Bytes = 327 kB = 0 MB
2711c609719bSwdenk		   Load Address: 00000000
2712c609719bSwdenk		   Entry Point:	 0000000c
2713c609719bSwdenk		   Verifying Checksum ... OK
2714c609719bSwdenk		   Uncompressing Kernel Image ... OK
2715c609719bSwdenk		## Loading RAMDisk Image at 40200000 ...
2716c609719bSwdenk		   Image Name:	 Simple Ramdisk Image
2717c609719bSwdenk		   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
2718c609719bSwdenk		   Data Size:	 566530 Bytes = 553 kB = 0 MB
2719c609719bSwdenk		   Load Address: 00000000
2720c609719bSwdenk		   Entry Point:	 00000000
2721c609719bSwdenk		   Verifying Checksum ... OK
2722c609719bSwdenk		   Loading Ramdisk ... OK
2723c609719bSwdenk		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
2724c609719bSwdenk		Boot arguments: root=/dev/ram
2725c609719bSwdenk		time_init: decrementer frequency = 187500000/60
2726c609719bSwdenk		Calibrating delay loop... 49.77 BogoMIPS
2727c609719bSwdenk		...
2728c609719bSwdenk		RAMDISK: Compressed image found at block 0
2729c609719bSwdenk		VFS: Mounted root (ext2 filesystem).
2730c609719bSwdenk
2731c609719bSwdenk		bash#
2732c609719bSwdenk
27336069ff26Swdenk	More About U-Boot Image Types:
27346069ff26Swdenk	------------------------------
27356069ff26Swdenk
27366069ff26Swdenk	U-Boot supports the following image types:
27376069ff26Swdenk
27386069ff26Swdenk	   "Standalone Programs" are directly runnable in the environment
27396069ff26Swdenk		provided by U-Boot; it is expected that (if they behave
27406069ff26Swdenk		well) you can continue to work in U-Boot after return from
27416069ff26Swdenk		the Standalone Program.
27426069ff26Swdenk	   "OS Kernel Images" are usually images of some Embedded OS which
27436069ff26Swdenk		will take over control completely. Usually these programs
27446069ff26Swdenk		will install their own set of exception handlers, device
27456069ff26Swdenk		drivers, set up the MMU, etc. - this means, that you cannot
27466069ff26Swdenk		expect to re-enter U-Boot except by resetting the CPU.
27476069ff26Swdenk	   "RAMDisk Images" are more or less just data blocks, and their
27486069ff26Swdenk		parameters (address, size) are passed to an OS kernel that is
27496069ff26Swdenk		being started.
27506069ff26Swdenk	   "Multi-File Images" contain several images, typically an OS
27516069ff26Swdenk		(Linux) kernel image and one or more data images like
27526069ff26Swdenk		RAMDisks. This construct is useful for instance when you want
27536069ff26Swdenk		to boot over the network using BOOTP etc., where the boot
27546069ff26Swdenk		server provides just a single image file, but you want to get
27556069ff26Swdenk		for instance an OS kernel and a RAMDisk image.
27566069ff26Swdenk
27576069ff26Swdenk		"Multi-File Images" start with a list of image sizes, each
27586069ff26Swdenk		image size (in bytes) specified by an "uint32_t" in network
27596069ff26Swdenk		byte order. This list is terminated by an "(uint32_t)0".
27606069ff26Swdenk		Immediately after the terminating 0 follow the images, one by
27616069ff26Swdenk		one, all aligned on "uint32_t" boundaries (size rounded up to
27626069ff26Swdenk		a multiple of 4 bytes).
27636069ff26Swdenk
27646069ff26Swdenk	   "Firmware Images" are binary images containing firmware (like
27656069ff26Swdenk		U-Boot or FPGA images) which usually will be programmed to
27666069ff26Swdenk		flash memory.
27676069ff26Swdenk
27686069ff26Swdenk	   "Script files" are command sequences that will be executed by
27696069ff26Swdenk		U-Boot's command interpreter; this feature is especially
27706069ff26Swdenk		useful when you configure U-Boot to use a real shell (hush)
27716069ff26Swdenk		as command interpreter.
27726069ff26Swdenk
2773c609719bSwdenk
2774c609719bSwdenk	Standalone HOWTO:
2775c609719bSwdenk	=================
2776c609719bSwdenk
2777c609719bSwdenk	One of the features of U-Boot is that you can dynamically load and
2778c609719bSwdenk	run "standalone" applications, which can use some resources of
2779c609719bSwdenk	U-Boot like console I/O functions or interrupt services.
2780c609719bSwdenk
2781c609719bSwdenk	Two simple examples are included with the sources:
2782c609719bSwdenk
2783c609719bSwdenk	"Hello World" Demo:
2784c609719bSwdenk	-------------------
2785c609719bSwdenk
2786c609719bSwdenk	'examples/hello_world.c' contains a small "Hello World" Demo
2787c609719bSwdenk	application; it is automatically compiled when you build U-Boot.
2788c609719bSwdenk	It's configured to run at address 0x00040004, so you can play with it
2789c609719bSwdenk	like that:
2790c609719bSwdenk
2791c609719bSwdenk		=> loads
2792c609719bSwdenk		## Ready for S-Record download ...
2793c609719bSwdenk		~>examples/hello_world.srec
2794c609719bSwdenk		1 2 3 4 5 6 7 8 9 10 11 ...
2795c609719bSwdenk		[file transfer complete]
2796c609719bSwdenk		[connected]
2797c609719bSwdenk		## Start Addr = 0x00040004
2798c609719bSwdenk
2799c609719bSwdenk		=> go 40004 Hello World! This is a test.
2800c609719bSwdenk		## Starting application at 0x00040004 ...
2801c609719bSwdenk		Hello World
2802c609719bSwdenk		argc = 7
2803c609719bSwdenk		argv[0] = "40004"
2804c609719bSwdenk		argv[1] = "Hello"
2805c609719bSwdenk		argv[2] = "World!"
2806c609719bSwdenk		argv[3] = "This"
2807c609719bSwdenk		argv[4] = "is"
2808c609719bSwdenk		argv[5] = "a"
2809c609719bSwdenk		argv[6] = "test."
2810c609719bSwdenk		argv[7] = "<NULL>"
2811c609719bSwdenk		Hit any key to exit ...
2812c609719bSwdenk
2813c609719bSwdenk		## Application terminated, rc = 0x0
2814c609719bSwdenk
2815c609719bSwdenk	Another example, which demonstrates how to register a CPM interrupt
2816c609719bSwdenk	handler with the U-Boot code, can be found in 'examples/timer.c'.
2817c609719bSwdenk	Here, a CPM timer is set up to generate an interrupt every second.
2818c609719bSwdenk	The interrupt service routine is trivial, just printing a '.'
2819c609719bSwdenk	character, but this is just a demo program. The application can be
2820c609719bSwdenk	controlled by the following keys:
2821c609719bSwdenk
2822c609719bSwdenk		? - print current values og the CPM Timer registers
2823c609719bSwdenk		b - enable interrupts and start timer
2824c609719bSwdenk		e - stop timer and disable interrupts
2825c609719bSwdenk		q - quit application
2826c609719bSwdenk
2827c609719bSwdenk		=> loads
2828c609719bSwdenk		## Ready for S-Record download ...
2829c609719bSwdenk		~>examples/timer.srec
2830c609719bSwdenk		1 2 3 4 5 6 7 8 9 10 11 ...
2831c609719bSwdenk		[file transfer complete]
2832c609719bSwdenk		[connected]
2833c609719bSwdenk		## Start Addr = 0x00040004
2834c609719bSwdenk
2835c609719bSwdenk		=> go 40004
2836c609719bSwdenk		## Starting application at 0x00040004 ...
2837c609719bSwdenk		TIMERS=0xfff00980
2838c609719bSwdenk		Using timer 1
2839c609719bSwdenk		  tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
2840c609719bSwdenk
2841c609719bSwdenk	Hit 'b':
2842c609719bSwdenk		[q, b, e, ?] Set interval 1000000 us
2843c609719bSwdenk		Enabling timer
2844c609719bSwdenk	Hit '?':
2845c609719bSwdenk		[q, b, e, ?] ........
2846c609719bSwdenk		tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
2847c609719bSwdenk	Hit '?':
2848c609719bSwdenk		[q, b, e, ?] .
2849c609719bSwdenk		tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
2850c609719bSwdenk	Hit '?':
2851c609719bSwdenk		[q, b, e, ?] .
2852c609719bSwdenk		tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
2853c609719bSwdenk	Hit '?':
2854c609719bSwdenk		[q, b, e, ?] .
2855c609719bSwdenk		tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
2856c609719bSwdenk	Hit 'e':
2857c609719bSwdenk		[q, b, e, ?] ...Stopping timer
2858c609719bSwdenk	Hit 'q':
2859c609719bSwdenk		[q, b, e, ?] ## Application terminated, rc = 0x0
2860c609719bSwdenk
2861c609719bSwdenk
286285ec0bccSwdenk	Minicom warning:
286385ec0bccSwdenk	================
286485ec0bccSwdenk
28657152b1d0Swdenk	Over time, many people have reported problems when trying to use the
286685ec0bccSwdenk	"minicom" terminal emulation program for serial download. I (wd)
286785ec0bccSwdenk	consider minicom to be broken, and recommend not to use it. Under
2868f07771ccSwdenk	Unix, I recommend to use C-Kermit for general purpose use (and
286985ec0bccSwdenk	especially for kermit binary protocol download ("loadb" command), and
287085ec0bccSwdenk	use "cu" for S-Record download ("loads" command).
287185ec0bccSwdenk
287252f52c14Swdenk	Nevertheless, if you absolutely want to use it try adding this
287352f52c14Swdenk	configuration to your "File transfer protocols" section:
287452f52c14Swdenk
287552f52c14Swdenk		   Name	   Program			Name U/D FullScr IO-Red. Multi
287652f52c14Swdenk		X  kermit  /usr/bin/kermit -i -l %l -s	 Y    U	   Y	   N	  N
287752f52c14Swdenk		Y  kermit  /usr/bin/kermit -i -l %l -r	 N    D	   Y	   N	  N
287852f52c14Swdenk
287952f52c14Swdenk
2880c609719bSwdenk	NetBSD Notes:
2881c609719bSwdenk	=============
2882c609719bSwdenk
2883c609719bSwdenk	Starting at version 0.9.2, U-Boot supports NetBSD both as host
2884c609719bSwdenk	(build U-Boot) and target system (boots NetBSD/mpc8xx).
2885c609719bSwdenk
2886c609719bSwdenk	Building requires a cross environment; it is known to work on
2887c609719bSwdenk	NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
2888c609719bSwdenk	need gmake since the Makefiles are not compatible with BSD make).
2889c609719bSwdenk	Note that the cross-powerpc package does not install include files;
2890c609719bSwdenk	attempting to build U-Boot will fail because <machine/ansi.h> is
2891c609719bSwdenk	missing.  This file has to be installed and patched manually:
2892c609719bSwdenk
2893c609719bSwdenk		# cd /usr/pkg/cross/powerpc-netbsd/include
2894c609719bSwdenk		# mkdir powerpc
2895c609719bSwdenk		# ln -s powerpc machine
2896c609719bSwdenk		# cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
2897c609719bSwdenk		# ${EDIT} powerpc/ansi.h	## must remove __va_list, _BSD_VA_LIST
2898c609719bSwdenk
2899c609719bSwdenk	Native builds *don't* work due to incompatibilities between native
2900c609719bSwdenk	and U-Boot include files.
2901c609719bSwdenk
2902c609719bSwdenk	Booting assumes that (the first part of) the image booted is a
2903c609719bSwdenk	stage-2 loader which in turn loads and then invokes the kernel
2904c609719bSwdenk	proper. Loader sources will eventually appear in the NetBSD source
2905c609719bSwdenk	tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
2906c609719bSwdenk	meantime, send mail to bruno@exet-ag.de and/or wd@denx.de for
2907c609719bSwdenk	details.
2908c609719bSwdenk
2909c609719bSwdenk
2910c609719bSwdenk	Implementation Internals:
2911c609719bSwdenk	=========================
2912c609719bSwdenk
2913c609719bSwdenk	The following is not intended to be a complete description of every
2914c609719bSwdenk	implementation detail. However, it should help to understand the
2915c609719bSwdenk	inner workings of U-Boot and make it easier to port it to custom
2916c609719bSwdenk	hardware.
2917c609719bSwdenk
2918c609719bSwdenk
2919c609719bSwdenk	Initial Stack, Global Data:
2920c609719bSwdenk	---------------------------
2921c609719bSwdenk
2922c609719bSwdenk	The implementation of U-Boot is complicated by the fact that U-Boot
2923c609719bSwdenk	starts running out of ROM (flash memory), usually without access to
2924c609719bSwdenk	system RAM (because the memory controller is not initialized yet).
2925c609719bSwdenk	This means that we don't have writable Data or BSS segments, and BSS
2926c609719bSwdenk	is not initialized as zero. To be able to get a C environment working
2927c609719bSwdenk	at all, we have to allocate at least a minimal stack. Implementation
2928c609719bSwdenk	options for this are defined and restricted by the CPU used: Some CPU
2929c609719bSwdenk	models provide on-chip memory (like the IMMR area on MPC8xx and
2930c609719bSwdenk	MPC826x processors), on others (parts of) the data cache can be
2931c609719bSwdenk	locked as (mis-) used as memory, etc.
2932c609719bSwdenk
29337152b1d0Swdenk		Chris Hallinan posted a good summary of	 these	issues	to  the
293443d9616cSwdenk		u-boot-users mailing list:
293543d9616cSwdenk
293643d9616cSwdenk		Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
293743d9616cSwdenk		From: "Chris Hallinan" <clh@net1plus.com>
293843d9616cSwdenk		Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
293943d9616cSwdenk		...
294043d9616cSwdenk
294143d9616cSwdenk		Correct me if I'm wrong, folks, but the way I understand it
294243d9616cSwdenk		is this: Using DCACHE as initial RAM for Stack, etc, does not
294343d9616cSwdenk		require any physical RAM backing up the cache. The cleverness
294443d9616cSwdenk		is that the cache is being used as a temporary supply of
294543d9616cSwdenk		necessary storage before the SDRAM controller is setup. It's
294643d9616cSwdenk		beyond the scope of this list to expain the details, but you
294743d9616cSwdenk		can see how this works by studying the cache architecture and
294843d9616cSwdenk		operation in the architecture and processor-specific manuals.
294943d9616cSwdenk
295043d9616cSwdenk		OCM is On Chip Memory, which I believe the 405GP has 4K. It
295143d9616cSwdenk		is another option for the system designer to use as an
295243d9616cSwdenk		initial stack/ram area prior to SDRAM being available. Either
295343d9616cSwdenk		option should work for you. Using CS 4 should be fine if your
295443d9616cSwdenk		board designers haven't used it for something that would
295543d9616cSwdenk		cause you grief during the initial boot! It is frequently not
295643d9616cSwdenk		used.
295743d9616cSwdenk
295843d9616cSwdenk		CFG_INIT_RAM_ADDR should be somewhere that won't interfere
295943d9616cSwdenk		with your processor/board/system design. The default value
296043d9616cSwdenk		you will find in any recent u-boot distribution in
296143d9616cSwdenk		Walnut405.h should work for you. I'd set it to a value larger
296243d9616cSwdenk		than your SDRAM module. If you have a 64MB SDRAM module, set
296343d9616cSwdenk		it above 400_0000. Just make sure your board has no resources
296443d9616cSwdenk		that are supposed to respond to that address! That code in
296543d9616cSwdenk		start.S has been around a while and should work as is when
296643d9616cSwdenk		you get the config right.
296743d9616cSwdenk
296843d9616cSwdenk		-Chris Hallinan
296943d9616cSwdenk		DS4.COM, Inc.
297043d9616cSwdenk
2971c609719bSwdenk	It is essential to remember this, since it has some impact on the C
2972c609719bSwdenk	code for the initialization procedures:
2973c609719bSwdenk
2974c609719bSwdenk	* Initialized global data (data segment) is read-only. Do not attempt
2975c609719bSwdenk	  to write it.
2976c609719bSwdenk
2977c609719bSwdenk	* Do not use any unitialized global data (or implicitely initialized
2978c609719bSwdenk	  as zero data - BSS segment) at all - this is undefined, initiali-
29797152b1d0Swdenk	  zation is performed later (when relocating to RAM).
2980c609719bSwdenk
2981c609719bSwdenk	* Stack space is very limited. Avoid big data buffers or things like
2982c609719bSwdenk	  that.
2983c609719bSwdenk
2984c609719bSwdenk	Having only the stack as writable memory limits means we cannot use
2985c609719bSwdenk	normal global data to share information beween the code. But it
2986c609719bSwdenk	turned out that the implementation of U-Boot can be greatly
2987c609719bSwdenk	simplified by making a global data structure (gd_t) available to all
2988c609719bSwdenk	functions. We could pass a pointer to this data as argument to _all_
2989c609719bSwdenk	functions, but this would bloat the code. Instead we use a feature of
2990c609719bSwdenk	the GCC compiler (Global Register Variables) to share the data: we
2991c609719bSwdenk	place a pointer (gd) to the global data into a register which we
2992c609719bSwdenk	reserve for this purpose.
2993c609719bSwdenk
29947152b1d0Swdenk	When choosing a register for such a purpose we are restricted by the
2995c609719bSwdenk	relevant  (E)ABI  specifications for the current architecture, and by
2996c609719bSwdenk	GCC's implementation.
2997c609719bSwdenk
2998c609719bSwdenk	For PowerPC, the following registers have specific use:
2999c609719bSwdenk		R1:	stack pointer
3000c609719bSwdenk		R2:	TOC pointer
3001c609719bSwdenk		R3-R4:	parameter passing and return values
3002c609719bSwdenk		R5-R10: parameter passing
3003c609719bSwdenk		R13:	small data area pointer
3004c609719bSwdenk		R30:	GOT pointer
3005c609719bSwdenk		R31:	frame pointer
3006c609719bSwdenk
3007c609719bSwdenk		(U-Boot also uses R14 as internal GOT pointer.)
3008c609719bSwdenk
3009c609719bSwdenk	    ==> U-Boot will use R29 to hold a pointer to the global data
3010c609719bSwdenk
3011c609719bSwdenk	    Note: on PPC, we could use a static initializer (since the
3012c609719bSwdenk	    address of the global data structure is known at compile time),
3013c609719bSwdenk	    but it turned out that reserving a register results in somewhat
3014c609719bSwdenk	    smaller code - although the code savings are not that big (on
3015c609719bSwdenk	    average for all boards 752 bytes for the whole U-Boot image,
3016c609719bSwdenk	    624 text + 127 data).
3017c609719bSwdenk
3018c609719bSwdenk	On ARM, the following registers are used:
3019c609719bSwdenk
3020c609719bSwdenk		R0:	function argument word/integer result
3021c609719bSwdenk		R1-R3:	function argument word
3022c609719bSwdenk		R9:	GOT pointer
3023c609719bSwdenk		R10:	stack limit (used only if stack checking if enabled)
3024c609719bSwdenk		R11:	argument (frame) pointer
3025c609719bSwdenk		R12:	temporary workspace
3026c609719bSwdenk		R13:	stack pointer
3027c609719bSwdenk		R14:	link register
3028c609719bSwdenk		R15:	program counter
3029c609719bSwdenk
3030c609719bSwdenk	    ==> U-Boot will use R8 to hold a pointer to the global data
3031c609719bSwdenk
3032c609719bSwdenk
3033c609719bSwdenk	Memory Management:
3034c609719bSwdenk	------------------
3035c609719bSwdenk
3036c609719bSwdenk	U-Boot runs in system state and uses physical addresses, i.e. the
3037c609719bSwdenk	MMU is not used either for address mapping nor for memory protection.
3038c609719bSwdenk
3039c609719bSwdenk	The available memory is mapped to fixed addresses using the memory
3040c609719bSwdenk	controller. In this process, a contiguous block is formed for each
3041c609719bSwdenk	memory type (Flash, SDRAM, SRAM), even when it consists of several
3042c609719bSwdenk	physical memory banks.
3043c609719bSwdenk
3044c609719bSwdenk	U-Boot is installed in the first 128 kB of the first Flash bank (on
3045c609719bSwdenk	TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
3046c609719bSwdenk	booting and sizing and initializing DRAM, the code relocates itself
3047c609719bSwdenk	to the upper end of DRAM. Immediately below the U-Boot code some
3048c609719bSwdenk	memory is reserved for use by malloc() [see CFG_MALLOC_LEN
3049c609719bSwdenk	configuration setting]. Below that, a structure with global Board
3050c609719bSwdenk	Info data is placed, followed by the stack (growing downward).
3051c609719bSwdenk
3052c609719bSwdenk	Additionally, some exception handler code is copied to the low 8 kB
3053c609719bSwdenk	of DRAM (0x00000000 ... 0x00001FFF).
3054c609719bSwdenk
3055c609719bSwdenk	So a typical memory configuration with 16 MB of DRAM could look like
3056c609719bSwdenk	this:
3057c609719bSwdenk
3058c609719bSwdenk		0x0000 0000	Exception Vector code
3059c609719bSwdenk		      :
3060c609719bSwdenk		0x0000 1FFF
3061c609719bSwdenk		0x0000 2000	Free for Application Use
3062c609719bSwdenk		      :
3063c609719bSwdenk		      :
3064c609719bSwdenk
3065c609719bSwdenk		      :
3066c609719bSwdenk		      :
3067c609719bSwdenk		0x00FB FF20	Monitor Stack (Growing downward)
3068c609719bSwdenk		0x00FB FFAC	Board Info Data and permanent copy of global data
3069c609719bSwdenk		0x00FC 0000	Malloc Arena
3070c609719bSwdenk		      :
3071c609719bSwdenk		0x00FD FFFF
3072c609719bSwdenk		0x00FE 0000	RAM Copy of Monitor Code
3073c609719bSwdenk		...		eventually: LCD or video framebuffer
3074c609719bSwdenk		...		eventually: pRAM (Protected RAM - unchanged by reset)
3075c609719bSwdenk		0x00FF FFFF	[End of RAM]
3076c609719bSwdenk
3077c609719bSwdenk
3078c609719bSwdenk	System Initialization:
3079c609719bSwdenk	----------------------
3080c609719bSwdenk
3081c609719bSwdenk	In the reset configuration, U-Boot starts at the reset entry point
3082c609719bSwdenk	(on most PowerPC systens at address 0x00000100). Because of the reset
3083c609719bSwdenk	configuration for CS0# this is a mirror of the onboard Flash memory.
30847152b1d0Swdenk	To be able to re-map memory U-Boot then jumps to its link address.
3085c609719bSwdenk	To be able to implement the initialization code in C, a (small!)
3086c609719bSwdenk	initial stack is set up in the internal Dual Ported RAM (in case CPUs
3087c609719bSwdenk	which provide such a feature like MPC8xx or MPC8260), or in a locked
3088c609719bSwdenk	part of the data cache. After that, U-Boot initializes the CPU core,
3089c609719bSwdenk	the caches and the SIU.
3090c609719bSwdenk
3091c609719bSwdenk	Next, all (potentially) available memory banks are mapped using a
3092c609719bSwdenk	preliminary mapping. For example, we put them on 512 MB boundaries
3093c609719bSwdenk	(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
3094c609719bSwdenk	on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
3095c609719bSwdenk	programmed for SDRAM access. Using the temporary configuration, a
3096c609719bSwdenk	simple memory test is run that determines the size of the SDRAM
3097c609719bSwdenk	banks.
3098c609719bSwdenk
3099c609719bSwdenk	When there is more than one SDRAM bank, and the banks are of
31007152b1d0Swdenk	different size, the largest is mapped first. For equal size, the first
3101c609719bSwdenk	bank (CS2#) is mapped first. The first mapping is always for address
3102c609719bSwdenk	0x00000000, with any additional banks following immediately to create
3103c609719bSwdenk	contiguous memory starting from 0.
3104c609719bSwdenk
3105c609719bSwdenk	Then, the monitor installs itself at the upper end of the SDRAM area
3106c609719bSwdenk	and allocates memory for use by malloc() and for the global Board
3107c609719bSwdenk	Info data; also, the exception vector code is copied to the low RAM
3108c609719bSwdenk	pages, and the final stack is set up.
3109c609719bSwdenk
3110c609719bSwdenk	Only after this relocation will you have a "normal" C environment;
3111c609719bSwdenk	until that you are restricted in several ways, mostly because you are
3112c609719bSwdenk	running from ROM, and because the code will have to be relocated to a
3113c609719bSwdenk	new address in RAM.
3114c609719bSwdenk
3115c609719bSwdenk
3116c609719bSwdenk	U-Boot Porting Guide:
3117c609719bSwdenk	----------------------
3118c609719bSwdenk
3119c609719bSwdenk	[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
31206aff3115Swdenk	list, October 2002]
3121c609719bSwdenk
3122c609719bSwdenk
3123c609719bSwdenk	int main (int argc, char *argv[])
3124c609719bSwdenk	{
3125c609719bSwdenk		sighandler_t no_more_time;
3126c609719bSwdenk
3127c609719bSwdenk		signal (SIGALRM, no_more_time);
3128c609719bSwdenk		alarm (PROJECT_DEADLINE - toSec (3 * WEEK));
3129c609719bSwdenk
3130c609719bSwdenk		if (available_money > available_manpower) {
3131c609719bSwdenk			pay consultant to port U-Boot;
3132c609719bSwdenk			return 0;
3133c609719bSwdenk		}
3134c609719bSwdenk
3135c609719bSwdenk		Download latest U-Boot source;
3136c609719bSwdenk
31376aff3115Swdenk		Subscribe to u-boot-users mailing list;
31386aff3115Swdenk
3139c609719bSwdenk		if (clueless) {
3140c609719bSwdenk			email ("Hi, I am new to U-Boot, how do I get started?");
3141c609719bSwdenk		}
3142c609719bSwdenk
3143c609719bSwdenk		while (learning) {
3144c609719bSwdenk			Read the README file in the top level directory;
31457cb22f97Swdenk			Read http://www.denx.de/twiki/bin/view/DULG/Manual ;
3146c609719bSwdenk			Read the source, Luke;
3147c609719bSwdenk		}
3148c609719bSwdenk
3149c609719bSwdenk		if (available_money > toLocalCurrency ($2500)) {
3150c609719bSwdenk			Buy a BDI2000;
3151c609719bSwdenk		} else {
3152c609719bSwdenk			Add a lot of aggravation and time;
3153c609719bSwdenk		}
3154c609719bSwdenk
3155c609719bSwdenk		Create your own board support subdirectory;
3156c609719bSwdenk
31576aff3115Swdenk		Create your own board config file;
31586aff3115Swdenk
3159c609719bSwdenk		while (!running) {
3160c609719bSwdenk			do {
3161c609719bSwdenk				Add / modify source code;
3162c609719bSwdenk			} until (compiles);
3163c609719bSwdenk			Debug;
3164c609719bSwdenk			if (clueless)
3165c609719bSwdenk				email ("Hi, I am having problems...");
3166c609719bSwdenk		}
3167c609719bSwdenk		Send patch file to Wolfgang;
3168c609719bSwdenk
3169c609719bSwdenk		return 0;
3170c609719bSwdenk	}
3171c609719bSwdenk
3172c609719bSwdenk	void no_more_time (int sig)
3173c609719bSwdenk	{
3174c609719bSwdenk	      hire_a_guru();
3175c609719bSwdenk	}
3176c609719bSwdenk
3177c609719bSwdenk
3178c609719bSwdenk	Coding Standards:
3179c609719bSwdenk	-----------------
3180c609719bSwdenk
3181c609719bSwdenk	All contributions to U-Boot should conform to the Linux kernel
3182c609719bSwdenk	coding style; see the file "Documentation/CodingStyle" in your Linux
3183c609719bSwdenk	kernel source directory.
3184c609719bSwdenk
3185c609719bSwdenk	Please note that U-Boot is implemented in C (and to some small parts
3186c609719bSwdenk	in Assembler); no C++ is used, so please do not use C++ style
3187c609719bSwdenk	comments (//) in your code.
3188c609719bSwdenk
3189c178d3daSwdenk	Please also stick to the following formatting rules:
3190180d3f74Swdenk	- remove any trailing white space
3191180d3f74Swdenk	- use TAB characters for indentation, not spaces
3192180d3f74Swdenk	- make sure NOT to use DOS '\r\n' line feeds
3193180d3f74Swdenk	- do not add more than 2 empty lines to source files
3194180d3f74Swdenk	- do not add trailing empty lines to source files
3195180d3f74Swdenk
3196c609719bSwdenk	Submissions which do not conform to the standards may be returned
3197c609719bSwdenk	with a request to reformat the changes.
3198c609719bSwdenk
3199c609719bSwdenk
3200c609719bSwdenk	Submitting Patches:
3201c609719bSwdenk	-------------------
3202c609719bSwdenk
3203c609719bSwdenk	Since the number of patches for U-Boot is growing, we need to
3204c609719bSwdenk	establish some rules. Submissions which do not conform to these rules
3205c609719bSwdenk	may be rejected, even when they contain important and valuable stuff.
3206c609719bSwdenk
3207c609719bSwdenk
3208c609719bSwdenk	When you send a patch, please include the following information with
3209c609719bSwdenk	it:
3210c609719bSwdenk
3211c609719bSwdenk	* For bug fixes: a description of the bug and how your patch fixes
3212c609719bSwdenk	  this bug. Please try to include a way of demonstrating that the
3213c609719bSwdenk	  patch actually fixes something.
3214c609719bSwdenk
3215c609719bSwdenk	* For new features: a description of the feature and your
3216c609719bSwdenk	  implementation.
3217c609719bSwdenk
3218c609719bSwdenk	* A CHANGELOG entry as plaintext (separate from the patch)
3219c609719bSwdenk
3220c609719bSwdenk	* For major contributions, your entry to the CREDITS file
3221c609719bSwdenk
3222c609719bSwdenk	* When you add support for a new board, don't forget to add this
3223c609719bSwdenk	  board to the MAKEALL script, too.
3224c609719bSwdenk
3225c609719bSwdenk	* If your patch adds new configuration options, don't forget to
3226c609719bSwdenk	  document these in the README file.
3227c609719bSwdenk
3228c609719bSwdenk	* The patch itself. If you are accessing the CVS repository use "cvs
3229c609719bSwdenk	  update; cvs diff -puRN"; else, use "diff -purN OLD NEW". If your
3230c609719bSwdenk	  version of diff does not support these options, then get the latest
3231c609719bSwdenk	  version of GNU diff.
3232c609719bSwdenk
32336dff5529Swdenk	  The current directory when running this command shall be the top
32346dff5529Swdenk	  level directory of the U-Boot source tree, or it's parent directory
32356dff5529Swdenk	  (i. e. please make sure that your patch includes sufficient
32366dff5529Swdenk	  directory information for the affected files).
32376dff5529Swdenk
3238c609719bSwdenk	  We accept patches as plain text, MIME attachments or as uuencoded
3239c609719bSwdenk	  gzipped text.
3240c609719bSwdenk
324152f52c14Swdenk	* If one logical set of modifications affects or creates several
324252f52c14Swdenk	  files, all these changes shall be submitted in a SINGLE patch file.
324352f52c14Swdenk
324452f52c14Swdenk	* Changesets that contain different, unrelated modifications shall be
324552f52c14Swdenk	  submitted as SEPARATE patches, one patch per changeset.
324652f52c14Swdenk
324752f52c14Swdenk
3248c609719bSwdenk	Notes:
3249c609719bSwdenk
3250c609719bSwdenk	* Before sending the patch, run the MAKEALL script on your patched
3251c609719bSwdenk	  source tree and make sure that no errors or warnings are reported
3252c609719bSwdenk	  for any of the boards.
3253c609719bSwdenk
3254c609719bSwdenk	* Keep your modifications to the necessary minimum: A patch
3255c609719bSwdenk	  containing several unrelated changes or arbitrary reformats will be
3256c609719bSwdenk	  returned with a request to re-formatting / split it.
3257c609719bSwdenk
3258c609719bSwdenk	* If you modify existing code, make sure that your new code does not
3259c609719bSwdenk	  add to the memory footprint of the code ;-) Small is beautiful!
3260c609719bSwdenk	  When adding new features, these should compile conditionally only
3261c609719bSwdenk	  (using #ifdef), and the resulting code with the new feature
3262c609719bSwdenk	  disabled must not need more memory than the old code without your
3263c609719bSwdenk	  modification.
3264