xref: /rk3399_rockchip-uboot/README (revision 0b953ffc653fc5ab3d3fa47abf0dd9b8bd0703f5)
1#
2# (C) Copyright 2000 - 2005
3# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4#
5# See file CREDITS for list of people who contributed to this
6# project.
7#
8# This program is free software; you can redistribute it and/or
9# modify it under the terms of the GNU General Public License as
10# published by the Free Software Foundation; either version 2 of
11# the License, or (at your option) any later version.
12#
13# This program is distributed in the hope that it will be useful,
14# but WITHOUT ANY WARRANTY; without even the implied warranty of
15# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	See the
16# GNU General Public License for more details.
17#
18# You should have received a copy of the GNU General Public License
19# along with this program; if not, write to the Free Software
20# Foundation, Inc., 59 Temple Place, Suite 330, Boston,
21# MA 02111-1307 USA
22#
23
24Summary:
25========
26
27This directory contains the source code for U-Boot, a boot loader for
28Embedded boards based on PowerPC, ARM, MIPS and several other
29processors, which can be installed in a boot ROM and used to
30initialize and test the hardware or to download and run application
31code.
32
33The development of U-Boot is closely related to Linux: some parts of
34the source code originate in the Linux source tree, we have some
35header files in common, and special provision has been made to
36support booting of Linux images.
37
38Some attention has been paid to make this software easily
39configurable and extendable. For instance, all monitor commands are
40implemented with the same call interface, so that it's very easy to
41add new commands. Also, instead of permanently adding rarely used
42code (for instance hardware test utilities) to the monitor, you can
43load and run it dynamically.
44
45
46Status:
47=======
48
49In general, all boards for which a configuration option exists in the
50Makefile have been tested to some extent and can be considered
51"working". In fact, many of them are used in production systems.
52
53In case of problems see the CHANGELOG and CREDITS files to find out
54who contributed the specific port.
55
56
57Where to get help:
58==================
59
60In case you have questions about, problems with or contributions for
61U-Boot you should send a message to the U-Boot mailing list at
62<u-boot-users@lists.sourceforge.net>. There is also an archive of
63previous traffic on the mailing list - please search the archive
64before asking FAQ's. Please see
65http://lists.sourceforge.net/lists/listinfo/u-boot-users/
66
67
68Where we come from:
69===================
70
71- start from 8xxrom sources
72- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
73- clean up code
74- make it easier to add custom boards
75- make it possible to add other [PowerPC] CPUs
76- extend functions, especially:
77  * Provide extended interface to Linux boot loader
78  * S-Record download
79  * network boot
80  * PCMCIA / CompactFLash / ATA disk / SCSI ... boot
81- create ARMBoot project (http://sourceforge.net/projects/armboot)
82- add other CPU families (starting with ARM)
83- create U-Boot project (http://sourceforge.net/projects/u-boot)
84
85
86Names and Spelling:
87===================
88
89The "official" name of this project is "Das U-Boot". The spelling
90"U-Boot" shall be used in all written text (documentation, comments
91in source files etc.). Example:
92
93	This is the README file for the U-Boot project.
94
95File names etc. shall be based on the string "u-boot". Examples:
96
97	include/asm-ppc/u-boot.h
98
99	#include <asm/u-boot.h>
100
101Variable names, preprocessor constants etc. shall be either based on
102the string "u_boot" or on "U_BOOT". Example:
103
104	U_BOOT_VERSION		u_boot_logo
105	IH_OS_U_BOOT		u_boot_hush_start
106
107
108Versioning:
109===========
110
111U-Boot uses a 3 level version number containing a version, a
112sub-version, and a patchlevel: "U-Boot-2.34.5" means version "2",
113sub-version "34", and patchlevel "4".
114
115The patchlevel is used to indicate certain stages of development
116between released versions, i. e. officially released versions of
117U-Boot will always have a patchlevel of "0".
118
119
120Directory Hierarchy:
121====================
122
123- board		Board dependent files
124- common	Misc architecture independent functions
125- cpu		CPU specific files
126  - 74xx_7xx	Files specific to Freescale MPC74xx and 7xx CPUs
127  - arm720t	Files specific to ARM 720 CPUs
128  - arm920t	Files specific to ARM 920 CPUs
129    - at91rm9200 Files specific to Atmel AT91RM9200 CPU
130    - imx	Files specific to Freescale MC9328 i.MX CPUs
131    - s3c24x0	Files specific to Samsung S3C24X0 CPUs
132  - arm925t	Files specific to ARM 925 CPUs
133  - arm926ejs	Files specific to ARM 926 CPUs
134  - arm1136	Files specific to ARM 1136 CPUs
135  - i386	Files specific to i386 CPUs
136  - ixp		Files specific to Intel XScale IXP CPUs
137  - mcf52x2	Files specific to Freescale ColdFire MCF52x2 CPUs
138  - mips	Files specific to MIPS CPUs
139  - mpc5xx	Files specific to Freescale MPC5xx  CPUs
140  - mpc5xxx	Files specific to Freescale MPC5xxx CPUs
141  - mpc8xx	Files specific to Freescale MPC8xx  CPUs
142  - mpc8220	Files specific to Freescale MPC8220 CPUs
143  - mpc824x	Files specific to Freescale MPC824x CPUs
144  - mpc8260	Files specific to Freescale MPC8260 CPUs
145  - mpc85xx	Files specific to Freescale MPC85xx CPUs
146  - nios	Files specific to Altera NIOS CPUs
147  - nios2	Files specific to Altera Nios-II CPUs
148  - ppc4xx	Files specific to AMCC PowerPC 4xx CPUs
149  - pxa		Files specific to Intel XScale PXA CPUs
150  - s3c44b0	Files specific to Samsung S3C44B0 CPUs
151  - sa1100	Files specific to Intel StrongARM SA1100 CPUs
152- disk		Code for disk drive partition handling
153- doc		Documentation (don't expect too much)
154- drivers	Commonly used device drivers
155- dtt		Digital Thermometer and Thermostat drivers
156- examples	Example code for standalone applications, etc.
157- include	Header Files
158- lib_arm	Files generic to ARM	 architecture
159- lib_generic	Files generic to all	 architectures
160- lib_i386	Files generic to i386	 architecture
161- lib_m68k	Files generic to m68k	 architecture
162- lib_mips	Files generic to MIPS	 architecture
163- lib_nios	Files generic to NIOS	 architecture
164- lib_ppc	Files generic to PowerPC architecture
165- net		Networking code
166- post		Power On Self Test
167- rtc		Real Time Clock drivers
168- tools		Tools to build S-Record or U-Boot images, etc.
169
170Software Configuration:
171=======================
172
173Configuration is usually done using C preprocessor defines; the
174rationale behind that is to avoid dead code whenever possible.
175
176There are two classes of configuration variables:
177
178* Configuration _OPTIONS_:
179  These are selectable by the user and have names beginning with
180  "CONFIG_".
181
182* Configuration _SETTINGS_:
183  These depend on the hardware etc. and should not be meddled with if
184  you don't know what you're doing; they have names beginning with
185  "CFG_".
186
187Later we will add a configuration tool - probably similar to or even
188identical to what's used for the Linux kernel. Right now, we have to
189do the configuration by hand, which means creating some symbolic
190links and editing some configuration files. We use the TQM8xxL boards
191as an example here.
192
193
194Selection of Processor Architecture and Board Type:
195---------------------------------------------------
196
197For all supported boards there are ready-to-use default
198configurations available; just type "make <board_name>_config".
199
200Example: For a TQM823L module type:
201
202	cd u-boot
203	make TQM823L_config
204
205For the Cogent platform, you need to specify the cpu type as well;
206e.g. "make cogent_mpc8xx_config". And also configure the cogent
207directory according to the instructions in cogent/README.
208
209
210Configuration Options:
211----------------------
212
213Configuration depends on the combination of board and CPU type; all
214such information is kept in a configuration file
215"include/configs/<board_name>.h".
216
217Example: For a TQM823L module, all configuration settings are in
218"include/configs/TQM823L.h".
219
220
221Many of the options are named exactly as the corresponding Linux
222kernel configuration options. The intention is to make it easier to
223build a config tool - later.
224
225
226The following options need to be configured:
227
228- CPU Type:	Define exactly one of
229
230		PowerPC based CPUs:
231		-------------------
232		CONFIG_MPC823,	CONFIG_MPC850,	CONFIG_MPC855,	CONFIG_MPC860
233	or	CONFIG_MPC5xx
234	or	CONFIG_MPC8220
235	or	CONFIG_MPC824X, CONFIG_MPC8260
236	or	CONFIG_MPC85xx
237	or	CONFIG_IOP480
238	or	CONFIG_405GP
239	or	CONFIG_405EP
240	or	CONFIG_440
241	or	CONFIG_MPC74xx
242	or	CONFIG_750FX
243
244		ARM based CPUs:
245		---------------
246		CONFIG_SA1110
247		CONFIG_ARM7
248		CONFIG_PXA250
249		CONFIG_CPU_MONAHANS
250
251		MicroBlaze based CPUs:
252		----------------------
253		CONFIG_MICROBLAZE
254
255		Nios-2 based CPUs:
256		----------------------
257		CONFIG_NIOS2
258
259
260- Board Type:	Define exactly one of
261
262		PowerPC based boards:
263		---------------------
264
265		CONFIG_ADCIOP		CONFIG_GEN860T		CONFIG_PCIPPC2
266		CONFIG_ADS860		CONFIG_GENIETV		CONFIG_PCIPPC6
267		CONFIG_AMX860		CONFIG_GTH		CONFIG_pcu_e
268		CONFIG_AP1000		CONFIG_gw8260		CONFIG_PIP405
269		CONFIG_AR405		CONFIG_hermes		CONFIG_PM826
270		CONFIG_BAB7xx		CONFIG_hymod		CONFIG_ppmc8260
271		CONFIG_c2mon		CONFIG_IAD210		CONFIG_QS823
272		CONFIG_CANBT		CONFIG_ICU862		CONFIG_QS850
273		CONFIG_CCM		CONFIG_IP860		CONFIG_QS860T
274		CONFIG_CMI		CONFIG_IPHASE4539	CONFIG_RBC823
275		CONFIG_cogent_mpc8260	CONFIG_IVML24		CONFIG_RPXClassic
276		CONFIG_cogent_mpc8xx	CONFIG_IVML24_128	CONFIG_RPXlite
277		CONFIG_CPCI405		CONFIG_IVML24_256	CONFIG_RPXsuper
278		CONFIG_CPCI4052		CONFIG_IVMS8		CONFIG_rsdproto
279		CONFIG_CPCIISER4	CONFIG_IVMS8_128	CONFIG_sacsng
280		CONFIG_CPU86		CONFIG_IVMS8_256	CONFIG_Sandpoint8240
281		CONFIG_CRAYL1		CONFIG_JSE		CONFIG_Sandpoint8245
282		CONFIG_CSB272		CONFIG_LANTEC		CONFIG_sbc8260
283		CONFIG_CU824		CONFIG_lwmon		CONFIG_sbc8560
284		CONFIG_DASA_SIM		CONFIG_MBX		CONFIG_SM850
285		CONFIG_DB64360		CONFIG_MBX860T		CONFIG_SPD823TS
286		CONFIG_DB64460		CONFIG_MHPC		CONFIG_STXGP3
287		CONFIG_DU405		CONFIG_MIP405		CONFIG_SXNI855T
288		CONFIG_DUET_ADS		CONFIG_MOUSSE		CONFIG_TQM823L
289		CONFIG_EBONY		CONFIG_MPC8260ADS	CONFIG_TQM8260
290		CONFIG_ELPPC		CONFIG_MPC8540ADS	CONFIG_TQM850L
291		CONFIG_ELPT860		CONFIG_MPC8540EVAL	CONFIG_TQM855L
292		CONFIG_ep8260		CONFIG_MPC8560ADS	CONFIG_TQM860L
293		CONFIG_ERIC		CONFIG_MUSENKI		CONFIG_TTTech
294		CONFIG_ESTEEM192E	CONFIG_MVS1		CONFIG_UTX8245
295		CONFIG_ETX094		CONFIG_NETPHONE		CONFIG_V37
296		CONFIG_EVB64260		CONFIG_NETTA		CONFIG_W7OLMC
297		CONFIG_FADS823		CONFIG_NETVIA		CONFIG_W7OLMG
298		CONFIG_FADS850SAR	CONFIG_NX823		CONFIG_WALNUT
299		CONFIG_FADS860T		CONFIG_OCRTC		CONFIG_ZPC1900
300		CONFIG_FLAGADM		CONFIG_ORSG		CONFIG_ZUMA
301		CONFIG_FPS850L		CONFIG_OXC
302		CONFIG_FPS860L		CONFIG_PCI405
303
304		ARM based boards:
305		-----------------
306
307		CONFIG_ARMADILLO,	CONFIG_AT91RM9200DK,	CONFIG_CERF250,
308		CONFIG_CSB637,		CONFIG_DELTA,		CONFIG_DNP1110,
309	 	CONFIG_EP7312,		CONFIG_H2_OMAP1610,	CONFIG_HHP_CRADLE,
310		CONFIG_IMPA7,		CONFIG_INNOVATOROMAP1510, CONFIG_INNOVATOROMAP1610,
311		CONFIG_KB9202,		CONFIG_LART,		CONFIG_LPD7A400,
312		CONFIG_LUBBOCK,		CONFIG_OSK_OMAP5912,	CONFIG_OMAP2420H4,
313		CONFIG_SHANNON,		CONFIG_P2_OMAP730,	CONFIG_SMDK2400,
314		CONFIG_SMDK2410,	CONFIG_TRAB,		CONFIG_VCMA9
315
316		MicroBlaze based boards:
317		------------------------
318
319		CONFIG_SUZAKU
320
321		Nios-2 based boards:
322		------------------------
323
324		CONFIG_PCI5441 CONFIG_PK1C20
325
326
327- CPU Module Type: (if CONFIG_COGENT is defined)
328		Define exactly one of
329		CONFIG_CMA286_60_OLD
330--- FIXME --- not tested yet:
331		CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
332		CONFIG_CMA287_23, CONFIG_CMA287_50
333
334- Motherboard Type: (if CONFIG_COGENT is defined)
335		Define exactly one of
336		CONFIG_CMA101, CONFIG_CMA102
337
338- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
339		Define one or more of
340		CONFIG_CMA302
341
342- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
343		Define one or more of
344		CONFIG_LCD_HEARTBEAT	- update a character position on
345					  the lcd display every second with
346					  a "rotator" |\-/|\-/
347
348- Board flavour: (if CONFIG_MPC8260ADS is defined)
349		CONFIG_ADSTYPE
350		Possible values are:
351			CFG_8260ADS	- original MPC8260ADS
352			CFG_8266ADS	- MPC8266ADS
353			CFG_PQ2FADS	- PQ2FADS-ZU or PQ2FADS-VR
354			CFG_8272ADS	- MPC8272ADS
355
356- MPC824X Family Member (if CONFIG_MPC824X is defined)
357		Define exactly one of
358		CONFIG_MPC8240, CONFIG_MPC8245
359
360- 8xx CPU Options: (if using an MPC8xx cpu)
361		CONFIG_8xx_GCLK_FREQ	- deprecated: CPU clock if
362					  get_gclk_freq() cannot work
363					  e.g. if there is no 32KHz
364					  reference PIT/RTC clock
365		CONFIG_8xx_OSCLK	- PLL input clock (either EXTCLK
366					  or XTAL/EXTAL)
367
368- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
369		CFG_8xx_CPUCLK_MIN
370		CFG_8xx_CPUCLK_MAX
371		CONFIG_8xx_CPUCLK_DEFAULT
372			See doc/README.MPC866
373
374		CFG_MEASURE_CPUCLK
375
376		Define this to measure the actual CPU clock instead
377		of relying on the correctness of the configured
378		values. Mostly useful for board bringup to make sure
379		the PLL is locked at the intended frequency. Note
380		that this requires a (stable) reference clock (32 kHz
381		RTC clock or CFG_8XX_XIN)
382
383- Intel Monahans options:
384		CFG_MONAHANS_RUN_MODE_OSC_RATIO
385
386		Defines the Monahans run mode to oscillator
387		ratio. Valid values are 8, 16, 24, 31. The core
388		frequency is this value multiplied by 13 MHz.
389
390		CFG_MONAHANS_TURBO_RUN_MODE_RATIO
391
392		Defines the Monahans turbo mode to oscillator
393		ratio. Valid values are 1 (default if undefined) and
394		2. The core frequency as calculated above is multiplied
395		by this value.
396
397- Linux Kernel Interface:
398		CONFIG_CLOCKS_IN_MHZ
399
400		U-Boot stores all clock information in Hz
401		internally. For binary compatibility with older Linux
402		kernels (which expect the clocks passed in the
403		bd_info data to be in MHz) the environment variable
404		"clocks_in_mhz" can be defined so that U-Boot
405		converts clock data to MHZ before passing it to the
406		Linux kernel.
407		When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
408		"clocks_in_mhz=1" is  automatically  included  in  the
409		default environment.
410
411		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]
412
413		When transfering memsize parameter to linux, some versions
414		expect it to be in bytes, others in MB.
415		Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
416
417		CONFIG_OF_FLAT_TREE
418
419		New kernel versions are expecting firmware settings to be
420		passed using flat open firmware trees.
421		The environment variable "disable_of", when set, disables this
422		functionality.
423
424		CONFIG_OF_FLAT_TREE_MAX_SIZE
425
426		The maximum size of the constructed OF tree.
427
428		OF_CPU - The proper name of the cpus node.
429		OF_TBCLK - The timebase frequency.
430
431- Serial Ports:
432		CFG_PL010_SERIAL
433
434		Define this if you want support for Amba PrimeCell PL010 UARTs.
435
436		CFG_PL011_SERIAL
437
438		Define this if you want support for Amba PrimeCell PL011 UARTs.
439
440		CONFIG_PL011_CLOCK
441
442		If you have Amba PrimeCell PL011 UARTs, set this variable to
443		the clock speed of the UARTs.
444
445		CONFIG_PL01x_PORTS
446
447		If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
448		define this to a list of base addresses for each (supported)
449		port. See e.g. include/configs/versatile.h
450
451
452- Console Interface:
453		Depending on board, define exactly one serial port
454		(like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
455		CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
456		console by defining CONFIG_8xx_CONS_NONE
457
458		Note: if CONFIG_8xx_CONS_NONE is defined, the serial
459		port routines must be defined elsewhere
460		(i.e. serial_init(), serial_getc(), ...)
461
462		CONFIG_CFB_CONSOLE
463		Enables console device for a color framebuffer. Needs following
464		defines (cf. smiLynxEM, i8042, board/eltec/bab7xx)
465			VIDEO_FB_LITTLE_ENDIAN	graphic memory organisation
466						(default big endian)
467			VIDEO_HW_RECTFILL	graphic chip supports
468						rectangle fill
469						(cf. smiLynxEM)
470			VIDEO_HW_BITBLT		graphic chip supports
471						bit-blit (cf. smiLynxEM)
472			VIDEO_VISIBLE_COLS	visible pixel columns
473						(cols=pitch)
474			VIDEO_VISIBLE_ROWS	visible pixel rows
475			VIDEO_PIXEL_SIZE	bytes per pixel
476			VIDEO_DATA_FORMAT	graphic data format
477						(0-5, cf. cfb_console.c)
478			VIDEO_FB_ADRS		framebuffer address
479			VIDEO_KBD_INIT_FCT	keyboard int fct
480						(i.e. i8042_kbd_init())
481			VIDEO_TSTC_FCT		test char fct
482						(i.e. i8042_tstc)
483			VIDEO_GETC_FCT		get char fct
484						(i.e. i8042_getc)
485			CONFIG_CONSOLE_CURSOR	cursor drawing on/off
486						(requires blink timer
487						cf. i8042.c)
488			CFG_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
489			CONFIG_CONSOLE_TIME	display time/date info in
490						upper right corner
491						(requires CFG_CMD_DATE)
492			CONFIG_VIDEO_LOGO	display Linux logo in
493						upper left corner
494			CONFIG_VIDEO_BMP_LOGO	use bmp_logo.h instead of
495						linux_logo.h for logo.
496						Requires CONFIG_VIDEO_LOGO
497			CONFIG_CONSOLE_EXTRA_INFO
498						addional board info beside
499						the logo
500
501		When CONFIG_CFB_CONSOLE is defined, video console is
502		default i/o. Serial console can be forced with
503		environment 'console=serial'.
504
505		When CONFIG_SILENT_CONSOLE is defined, all console
506		messages (by U-Boot and Linux!) can be silenced with
507		the "silent" environment variable. See
508		doc/README.silent for more information.
509
510- Console Baudrate:
511		CONFIG_BAUDRATE - in bps
512		Select one of the baudrates listed in
513		CFG_BAUDRATE_TABLE, see below.
514		CFG_BRGCLK_PRESCALE, baudrate prescale
515
516- Interrupt driven serial port input:
517		CONFIG_SERIAL_SOFTWARE_FIFO
518
519		PPC405GP only.
520		Use an interrupt handler for receiving data on the
521		serial port. It also enables using hardware handshake
522		(RTS/CTS) and UART's built-in FIFO. Set the number of
523		bytes the interrupt driven input buffer should have.
524
525		Leave undefined to disable this feature, including
526		disable the buffer and hardware handshake.
527
528- Console UART Number:
529		CONFIG_UART1_CONSOLE
530
531		AMCC PPC4xx only.
532		If defined internal UART1 (and not UART0) is used
533		as default U-Boot console.
534
535- Boot Delay:	CONFIG_BOOTDELAY - in seconds
536		Delay before automatically booting the default image;
537		set to -1 to disable autoboot.
538
539		See doc/README.autoboot for these options that
540		work with CONFIG_BOOTDELAY. None are required.
541		CONFIG_BOOT_RETRY_TIME
542		CONFIG_BOOT_RETRY_MIN
543		CONFIG_AUTOBOOT_KEYED
544		CONFIG_AUTOBOOT_PROMPT
545		CONFIG_AUTOBOOT_DELAY_STR
546		CONFIG_AUTOBOOT_STOP_STR
547		CONFIG_AUTOBOOT_DELAY_STR2
548		CONFIG_AUTOBOOT_STOP_STR2
549		CONFIG_ZERO_BOOTDELAY_CHECK
550		CONFIG_RESET_TO_RETRY
551
552- Autoboot Command:
553		CONFIG_BOOTCOMMAND
554		Only needed when CONFIG_BOOTDELAY is enabled;
555		define a command string that is automatically executed
556		when no character is read on the console interface
557		within "Boot Delay" after reset.
558
559		CONFIG_BOOTARGS
560		This can be used to pass arguments to the bootm
561		command. The value of CONFIG_BOOTARGS goes into the
562		environment value "bootargs".
563
564		CONFIG_RAMBOOT and CONFIG_NFSBOOT
565		The value of these goes into the environment as
566		"ramboot" and "nfsboot" respectively, and can be used
567		as a convenience, when switching between booting from
568		ram and nfs.
569
570- Pre-Boot Commands:
571		CONFIG_PREBOOT
572
573		When this option is #defined, the existence of the
574		environment variable "preboot" will be checked
575		immediately before starting the CONFIG_BOOTDELAY
576		countdown and/or running the auto-boot command resp.
577		entering interactive mode.
578
579		This feature is especially useful when "preboot" is
580		automatically generated or modified. For an example
581		see the LWMON board specific code: here "preboot" is
582		modified when the user holds down a certain
583		combination of keys on the (special) keyboard when
584		booting the systems
585
586- Serial Download Echo Mode:
587		CONFIG_LOADS_ECHO
588		If defined to 1, all characters received during a
589		serial download (using the "loads" command) are
590		echoed back. This might be needed by some terminal
591		emulations (like "cu"), but may as well just take
592		time on others. This setting #define's the initial
593		value of the "loads_echo" environment variable.
594
595- Kgdb Serial Baudrate: (if CFG_CMD_KGDB is defined)
596		CONFIG_KGDB_BAUDRATE
597		Select one of the baudrates listed in
598		CFG_BAUDRATE_TABLE, see below.
599
600- Monitor Functions:
601		CONFIG_COMMANDS
602		Most monitor functions can be selected (or
603		de-selected) by adjusting the definition of
604		CONFIG_COMMANDS; to select individual functions,
605		#define CONFIG_COMMANDS by "OR"ing any of the
606		following values:
607
608		#define enables commands:
609		-------------------------
610		CFG_CMD_ASKENV	* ask for env variable
611		CFG_CMD_AUTOSCRIPT Autoscript Support
612		CFG_CMD_BDI	  bdinfo
613		CFG_CMD_BEDBUG	* Include BedBug Debugger
614		CFG_CMD_BMP	* BMP support
615		CFG_CMD_BSP	* Board specific commands
616		CFG_CMD_BOOTD	  bootd
617		CFG_CMD_CACHE	* icache, dcache
618		CFG_CMD_CONSOLE	  coninfo
619		CFG_CMD_DATE	* support for RTC, date/time...
620		CFG_CMD_DHCP	* DHCP support
621		CFG_CMD_DIAG	* Diagnostics
622		CFG_CMD_DOC	* Disk-On-Chip Support
623		CFG_CMD_DTT	* Digital Therm and Thermostat
624		CFG_CMD_ECHO	* echo arguments
625		CFG_CMD_EEPROM	* EEPROM read/write support
626		CFG_CMD_ELF	* bootelf, bootvx
627		CFG_CMD_ENV	  saveenv
628		CFG_CMD_FDC	* Floppy Disk Support
629		CFG_CMD_FAT	* FAT partition support
630		CFG_CMD_FDOS	* Dos diskette Support
631		CFG_CMD_FLASH	  flinfo, erase, protect
632		CFG_CMD_FPGA	  FPGA device initialization support
633		CFG_CMD_HWFLOW	* RTS/CTS hw flow control
634		CFG_CMD_I2C	* I2C serial bus support
635		CFG_CMD_IDE	* IDE harddisk support
636		CFG_CMD_IMI	  iminfo
637		CFG_CMD_IMLS	  List all found images
638		CFG_CMD_IMMAP	* IMMR dump support
639		CFG_CMD_IRQ	* irqinfo
640		CFG_CMD_ITEST	  Integer/string test of 2 values
641		CFG_CMD_JFFS2	* JFFS2 Support
642		CFG_CMD_KGDB	* kgdb
643		CFG_CMD_LOADB	  loadb
644		CFG_CMD_LOADS	  loads
645		CFG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
646				  loop, loopw, mtest
647		CFG_CMD_MISC	  Misc functions like sleep etc
648		CFG_CMD_MMC	* MMC memory mapped support
649		CFG_CMD_MII	* MII utility commands
650		CFG_CMD_NAND	* NAND support
651		CFG_CMD_NET	  bootp, tftpboot, rarpboot
652		CFG_CMD_PCI	* pciinfo
653		CFG_CMD_PCMCIA	* PCMCIA support
654		CFG_CMD_PING	* send ICMP ECHO_REQUEST to network host
655		CFG_CMD_PORTIO	* Port I/O
656		CFG_CMD_REGINFO * Register dump
657		CFG_CMD_RUN	  run command in env variable
658		CFG_CMD_SAVES	* save S record dump
659		CFG_CMD_SCSI	* SCSI Support
660		CFG_CMD_SDRAM	* print SDRAM configuration information
661				  (requires CFG_CMD_I2C)
662		CFG_CMD_SETGETDCR Support for DCR Register access (4xx only)
663		CFG_CMD_SPI	* SPI serial bus support
664		CFG_CMD_USB	* USB support
665		CFG_CMD_VFD	* VFD support (TRAB)
666		CFG_CMD_BSP	* Board SPecific functions
667		CFG_CMD_CDP	* Cisco Discover Protocol support
668		-----------------------------------------------
669		CFG_CMD_ALL	all
670
671		CONFIG_CMD_DFL	Default configuration; at the moment
672				this is includes all commands, except
673				the ones marked with "*" in the list
674				above.
675
676		If you don't define CONFIG_COMMANDS it defaults to
677		CONFIG_CMD_DFL in include/cmd_confdefs.h. A board can
678		override the default settings in the respective
679		include file.
680
681		EXAMPLE: If you want all functions except of network
682		support you can write:
683
684		#define CONFIG_COMMANDS (CFG_CMD_ALL & ~CFG_CMD_NET)
685
686
687	Note:	Don't enable the "icache" and "dcache" commands
688		(configuration option CFG_CMD_CACHE) unless you know
689		what you (and your U-Boot users) are doing. Data
690		cache cannot be enabled on systems like the 8xx or
691		8260 (where accesses to the IMMR region must be
692		uncached), and it cannot be disabled on all other
693		systems where we (mis-) use the data cache to hold an
694		initial stack and some data.
695
696
697		XXX - this list needs to get updated!
698
699- Watchdog:
700		CONFIG_WATCHDOG
701		If this variable is defined, it enables watchdog
702		support. There must be support in the platform specific
703		code for a watchdog. For the 8xx and 8260 CPUs, the
704		SIU Watchdog feature is enabled in the SYPCR
705		register.
706
707- U-Boot Version:
708		CONFIG_VERSION_VARIABLE
709		If this variable is defined, an environment variable
710		named "ver" is created by U-Boot showing the U-Boot
711		version as printed by the "version" command.
712		This variable is readonly.
713
714- Real-Time Clock:
715
716		When CFG_CMD_DATE is selected, the type of the RTC
717		has to be selected, too. Define exactly one of the
718		following options:
719
720		CONFIG_RTC_MPC8xx	- use internal RTC of MPC8xx
721		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
722		CONFIG_RTC_MC146818	- use MC146818 RTC
723		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
724		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
725		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
726		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
727		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
728
729		Note that if the RTC uses I2C, then the I2C interface
730		must also be configured. See I2C Support, below.
731
732- Timestamp Support:
733
734		When CONFIG_TIMESTAMP is selected, the timestamp
735		(date and time) of an image is printed by image
736		commands like bootm or iminfo. This option is
737		automatically enabled when you select CFG_CMD_DATE .
738
739- Partition Support:
740		CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
741		and/or CONFIG_ISO_PARTITION
742
743		If IDE or SCSI support	is  enabled  (CFG_CMD_IDE  or
744		CFG_CMD_SCSI) you must configure support for at least
745		one partition type as well.
746
747- IDE Reset method:
748		CONFIG_IDE_RESET_ROUTINE - this is defined in several
749		board configurations files but used nowhere!
750
751		CONFIG_IDE_RESET - is this is defined, IDE Reset will
752		be performed by calling the function
753			ide_set_reset(int reset)
754		which has to be defined in a board specific file
755
756- ATAPI Support:
757		CONFIG_ATAPI
758
759		Set this to enable ATAPI support.
760
761- LBA48 Support
762		CONFIG_LBA48
763
764		Set this to enable support for disks larger than 137GB
765		Also look at CFG_64BIT_LBA ,CFG_64BIT_VSPRINTF and CFG_64BIT_STRTOUL
766		Whithout these , LBA48 support uses 32bit variables and will 'only'
767		support disks up to 2.1TB.
768
769		CFG_64BIT_LBA:
770			When enabled, makes the IDE subsystem use 64bit sector addresses.
771			Default is 32bit.
772
773- SCSI Support:
774		At the moment only there is only support for the
775		SYM53C8XX SCSI controller; define
776		CONFIG_SCSI_SYM53C8XX to enable it.
777
778		CFG_SCSI_MAX_LUN [8], CFG_SCSI_MAX_SCSI_ID [7] and
779		CFG_SCSI_MAX_DEVICE [CFG_SCSI_MAX_SCSI_ID *
780		CFG_SCSI_MAX_LUN] can be adjusted to define the
781		maximum numbers of LUNs, SCSI ID's and target
782		devices.
783		CFG_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
784
785- NETWORK Support (PCI):
786		CONFIG_E1000
787		Support for Intel 8254x gigabit chips.
788
789		CONFIG_EEPRO100
790		Support for Intel 82557/82559/82559ER chips.
791		Optional CONFIG_EEPRO100_SROM_WRITE enables eeprom
792		write routine for first time initialisation.
793
794		CONFIG_TULIP
795		Support for Digital 2114x chips.
796		Optional CONFIG_TULIP_SELECT_MEDIA for board specific
797		modem chip initialisation (KS8761/QS6611).
798
799		CONFIG_NATSEMI
800		Support for National dp83815 chips.
801
802		CONFIG_NS8382X
803		Support for National dp8382[01] gigabit chips.
804
805- NETWORK Support (other):
806
807		CONFIG_DRIVER_LAN91C96
808		Support for SMSC's LAN91C96 chips.
809
810			CONFIG_LAN91C96_BASE
811			Define this to hold the physical address
812			of the LAN91C96's I/O space
813
814			CONFIG_LAN91C96_USE_32_BIT
815			Define this to enable 32 bit addressing
816
817		CONFIG_DRIVER_SMC91111
818		Support for SMSC's LAN91C111 chip
819
820			CONFIG_SMC91111_BASE
821			Define this to hold the physical address
822			of the device (I/O space)
823
824			CONFIG_SMC_USE_32_BIT
825			Define this if data bus is 32 bits
826
827			CONFIG_SMC_USE_IOFUNCS
828			Define this to use i/o functions instead of macros
829			(some hardware wont work with macros)
830
831- USB Support:
832		At the moment only the UHCI host controller is
833		supported (PIP405, MIP405, MPC5200); define
834		CONFIG_USB_UHCI to enable it.
835		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
836		and define CONFIG_USB_STORAGE to enable the USB
837		storage devices.
838		Note:
839		Supported are USB Keyboards and USB Floppy drives
840		(TEAC FD-05PUB).
841		MPC5200 USB requires additional defines:
842			CONFIG_USB_CLOCK
843				for 528 MHz Clock: 0x0001bbbb
844			CONFIG_USB_CONFIG
845				for differential drivers: 0x00001000
846				for single ended drivers: 0x00005000
847
848
849- MMC Support:
850		The MMC controller on the Intel PXA is supported. To
851		enable this define CONFIG_MMC. The MMC can be
852		accessed from the boot prompt by mapping the device
853		to physical memory similar to flash. Command line is
854		enabled with CFG_CMD_MMC. The MMC driver also works with
855		the FAT fs. This is enabled with CFG_CMD_FAT.
856
857- Journaling Flash filesystem support:
858		CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
859		CONFIG_JFFS2_NAND_DEV
860		Define these for a default partition on a NAND device
861
862		CFG_JFFS2_FIRST_SECTOR,
863		CFG_JFFS2_FIRST_BANK, CFG_JFFS2_NUM_BANKS
864		Define these for a default partition on a NOR device
865
866		CFG_JFFS_CUSTOM_PART
867		Define this to create an own partition. You have to provide a
868		function struct part_info* jffs2_part_info(int part_num)
869
870		If you define only one JFFS2 partition you may also want to
871		#define CFG_JFFS_SINGLE_PART	1
872		to disable the command chpart. This is the default when you
873		have not defined a custom partition
874
875- Keyboard Support:
876		CONFIG_ISA_KEYBOARD
877
878		Define this to enable standard (PC-Style) keyboard
879		support
880
881		CONFIG_I8042_KBD
882		Standard PC keyboard driver with US (is default) and
883		GERMAN key layout (switch via environment 'keymap=de') support.
884		Export function i8042_kbd_init, i8042_tstc and i8042_getc
885		for cfb_console. Supports cursor blinking.
886
887- Video support:
888		CONFIG_VIDEO
889
890		Define this to enable video support (for output to
891		video).
892
893		CONFIG_VIDEO_CT69000
894
895		Enable Chips & Technologies 69000 Video chip
896
897		CONFIG_VIDEO_SMI_LYNXEM
898		Enable Silicon Motion SMI 712/710/810 Video chip. The
899		video output is selected via environment 'videoout'
900		(1 = LCD and 2 = CRT). If videoout is undefined, CRT is
901		assumed.
902
903		For the CT69000 and SMI_LYNXEM drivers, videomode is
904		selected via environment 'videomode'. Two diferent ways
905		are possible:
906		- "videomode=num"   'num' is a standard LiLo mode numbers.
907		Following standard modes are supported	(* is default):
908
909		      Colors	640x480 800x600 1024x768 1152x864 1280x1024
910		-------------+---------------------------------------------
911		      8 bits |	0x301*	0x303	 0x305	  0x161	    0x307
912		     15 bits |	0x310	0x313	 0x316	  0x162	    0x319
913		     16 bits |	0x311	0x314	 0x317	  0x163	    0x31A
914		     24 bits |	0x312	0x315	 0x318	    ?	    0x31B
915		-------------+---------------------------------------------
916		(i.e. setenv videomode 317; saveenv; reset;)
917
918		- "videomode=bootargs" all the video parameters are parsed
919		from the bootargs. (See drivers/videomodes.c)
920
921
922		CONFIG_VIDEO_SED13806
923		Enable Epson SED13806 driver. This driver supports 8bpp
924		and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
925		or CONFIG_VIDEO_SED13806_16BPP
926
927- Keyboard Support:
928		CONFIG_KEYBOARD
929
930		Define this to enable a custom keyboard support.
931		This simply calls drv_keyboard_init() which must be
932		defined in your board-specific files.
933		The only board using this so far is RBC823.
934
935- LCD Support:	CONFIG_LCD
936
937		Define this to enable LCD support (for output to LCD
938		display); also select one of the supported displays
939		by defining one of these:
940
941		CONFIG_NEC_NL6448AC33:
942
943			NEC NL6448AC33-18. Active, color, single scan.
944
945		CONFIG_NEC_NL6448BC20
946
947			NEC NL6448BC20-08. 6.5", 640x480.
948			Active, color, single scan.
949
950		CONFIG_NEC_NL6448BC33_54
951
952			NEC NL6448BC33-54. 10.4", 640x480.
953			Active, color, single scan.
954
955		CONFIG_SHARP_16x9
956
957			Sharp 320x240. Active, color, single scan.
958			It isn't 16x9, and I am not sure what it is.
959
960		CONFIG_SHARP_LQ64D341
961
962			Sharp LQ64D341 display, 640x480.
963			Active, color, single scan.
964
965		CONFIG_HLD1045
966
967			HLD1045 display, 640x480.
968			Active, color, single scan.
969
970		CONFIG_OPTREX_BW
971
972			Optrex	 CBL50840-2 NF-FW 99 22 M5
973			or
974			Hitachi	 LMG6912RPFC-00T
975			or
976			Hitachi	 SP14Q002
977
978			320x240. Black & white.
979
980		Normally display is black on white background; define
981		CFG_WHITE_ON_BLACK to get it inverted.
982
983- Splash Screen Support: CONFIG_SPLASH_SCREEN
984
985		If this option is set, the environment is checked for
986		a variable "splashimage". If found, the usual display
987		of logo, copyright and system information on the LCD
988		is suppressed and the BMP image at the address
989		specified in "splashimage" is loaded instead. The
990		console is redirected to the "nulldev", too. This
991		allows for a "silent" boot where a splash screen is
992		loaded very quickly after power-on.
993
994- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
995
996		If this option is set, additionally to standard BMP
997		images, gzipped BMP images can be displayed via the
998		splashscreen support or the bmp command.
999
1000- Compression support:
1001		CONFIG_BZIP2
1002
1003		If this option is set, support for bzip2 compressed
1004		images is included. If not, only uncompressed and gzip
1005		compressed images are supported.
1006
1007		NOTE: the bzip2 algorithm requires a lot of RAM, so
1008		the malloc area (as defined by CFG_MALLOC_LEN) should
1009		be at least 4MB.
1010
1011- MII/PHY support:
1012		CONFIG_PHY_ADDR
1013
1014		The address of PHY on MII bus.
1015
1016		CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1017
1018		The clock frequency of the MII bus
1019
1020		CONFIG_PHY_GIGE
1021
1022		If this option is set, support for speed/duplex
1023		detection of Gigabit PHY is included.
1024
1025		CONFIG_PHY_RESET_DELAY
1026
1027		Some PHY like Intel LXT971A need extra delay after
1028		reset before any MII register access is possible.
1029		For such PHY, set this option to the usec delay
1030		required. (minimum 300usec for LXT971A)
1031
1032		CONFIG_PHY_CMD_DELAY (ppc4xx)
1033
1034		Some PHY like Intel LXT971A need extra delay after
1035		command issued before MII status register can be read
1036
1037- Ethernet address:
1038		CONFIG_ETHADDR
1039		CONFIG_ETH2ADDR
1040		CONFIG_ETH3ADDR
1041
1042		Define a default value for ethernet address to use
1043		for the respective ethernet interface, in case this
1044		is not determined automatically.
1045
1046- IP address:
1047		CONFIG_IPADDR
1048
1049		Define a default value for the IP address to use for
1050		the default ethernet interface, in case this is not
1051		determined through e.g. bootp.
1052
1053- Server IP address:
1054		CONFIG_SERVERIP
1055
1056		Defines a default value for theIP address of a TFTP
1057		server to contact when using the "tftboot" command.
1058
1059- BOOTP Recovery Mode:
1060		CONFIG_BOOTP_RANDOM_DELAY
1061
1062		If you have many targets in a network that try to
1063		boot using BOOTP, you may want to avoid that all
1064		systems send out BOOTP requests at precisely the same
1065		moment (which would happen for instance at recovery
1066		from a power failure, when all systems will try to
1067		boot, thus flooding the BOOTP server. Defining
1068		CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1069		inserted before sending out BOOTP requests. The
1070		following delays are insterted then:
1071
1072		1st BOOTP request:	delay 0 ... 1 sec
1073		2nd BOOTP request:	delay 0 ... 2 sec
1074		3rd BOOTP request:	delay 0 ... 4 sec
1075		4th and following
1076		BOOTP requests:		delay 0 ... 8 sec
1077
1078- DHCP Advanced Options:
1079		CONFIG_BOOTP_MASK
1080
1081		You can fine tune the DHCP functionality by adding
1082		these flags to the CONFIG_BOOTP_MASK define:
1083
1084		CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1085		serverip from a DHCP server, it is possible that more
1086		than one DNS serverip is offered to the client.
1087		If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1088		serverip will be stored in the additional environment
1089		variable "dnsip2". The first DNS serverip is always
1090		stored in the variable "dnsip", when CONFIG_BOOTP_DNS
1091		is added to the CONFIG_BOOTP_MASK.
1092
1093		CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1094		to do a dynamic update of a DNS server. To do this, they
1095		need the hostname of the DHCP requester.
1096		If CONFIG_BOOP_SEND_HOSTNAME is added to the
1097		CONFIG_BOOTP_MASK, the content of the "hostname"
1098		environment variable is passed as option 12 to
1099		the DHCP server.
1100
1101 - CDP Options:
1102		CONFIG_CDP_DEVICE_ID
1103
1104		The device id used in CDP trigger frames.
1105
1106		CONFIG_CDP_DEVICE_ID_PREFIX
1107
1108		A two character string which is prefixed to the MAC address
1109		of the device.
1110
1111		CONFIG_CDP_PORT_ID
1112
1113		A printf format string which contains the ascii name of
1114		the port. Normally is set to "eth%d" which sets
1115		eth0 for the first ethernet, eth1 for the second etc.
1116
1117		CONFIG_CDP_CAPABILITIES
1118
1119		A 32bit integer which indicates the device capabilities;
1120		0x00000010 for a normal host which does not forwards.
1121
1122		CONFIG_CDP_VERSION
1123
1124		An ascii string containing the version of the software.
1125
1126		CONFIG_CDP_PLATFORM
1127
1128		An ascii string containing the name of the platform.
1129
1130		CONFIG_CDP_TRIGGER
1131
1132		A 32bit integer sent on the trigger.
1133
1134		CONFIG_CDP_POWER_CONSUMPTION
1135
1136		A 16bit integer containing the power consumption of the
1137		device in .1 of milliwatts.
1138
1139		CONFIG_CDP_APPLIANCE_VLAN_TYPE
1140
1141		A byte containing the id of the VLAN.
1142
1143- Status LED:	CONFIG_STATUS_LED
1144
1145		Several configurations allow to display the current
1146		status using a LED. For instance, the LED will blink
1147		fast while running U-Boot code, stop blinking as
1148		soon as a reply to a BOOTP request was received, and
1149		start blinking slow once the Linux kernel is running
1150		(supported by a status LED driver in the Linux
1151		kernel). Defining CONFIG_STATUS_LED enables this
1152		feature in U-Boot.
1153
1154- CAN Support:	CONFIG_CAN_DRIVER
1155
1156		Defining CONFIG_CAN_DRIVER enables CAN driver support
1157		on those systems that support this (optional)
1158		feature, like the TQM8xxL modules.
1159
1160- I2C Support:	CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1161
1162		These enable I2C serial bus commands. Defining either of
1163		(but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
1164		include the appropriate I2C driver for the selected cpu.
1165
1166		This will allow you to use i2c commands at the u-boot
1167		command line (as long as you set CFG_CMD_I2C in
1168		CONFIG_COMMANDS) and communicate with i2c based realtime
1169		clock chips. See common/cmd_i2c.c for a description of the
1170		command line interface.
1171
1172		CONFIG_HARD_I2C selects the CPM hardware driver for I2C.
1173
1174		CONFIG_SOFT_I2C configures u-boot to use a software (aka
1175		bit-banging) driver instead of CPM or similar hardware
1176		support for I2C.
1177
1178		There are several other quantities that must also be
1179		defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
1180
1181		In both cases you will need to define CFG_I2C_SPEED
1182		to be the frequency (in Hz) at which you wish your i2c bus
1183		to run and CFG_I2C_SLAVE to be the address of this node (ie
1184		the cpu's i2c node address).
1185
1186		Now, the u-boot i2c code for the mpc8xx (cpu/mpc8xx/i2c.c)
1187		sets the cpu up as a master node and so its address should
1188		therefore be cleared to 0 (See, eg, MPC823e User's Manual
1189		p.16-473). So, set CFG_I2C_SLAVE to 0.
1190
1191		That's all that's required for CONFIG_HARD_I2C.
1192
1193		If you use the software i2c interface (CONFIG_SOFT_I2C)
1194		then the following macros need to be defined (examples are
1195		from include/configs/lwmon.h):
1196
1197		I2C_INIT
1198
1199		(Optional). Any commands necessary to enable the I2C
1200		controller or configure ports.
1201
1202		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
1203
1204		I2C_PORT
1205
1206		(Only for MPC8260 CPU). The I/O port to use (the code
1207		assumes both bits are on the same port). Valid values
1208		are 0..3 for ports A..D.
1209
1210		I2C_ACTIVE
1211
1212		The code necessary to make the I2C data line active
1213		(driven).  If the data line is open collector, this
1214		define can be null.
1215
1216		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
1217
1218		I2C_TRISTATE
1219
1220		The code necessary to make the I2C data line tri-stated
1221		(inactive).  If the data line is open collector, this
1222		define can be null.
1223
1224		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1225
1226		I2C_READ
1227
1228		Code that returns TRUE if the I2C data line is high,
1229		FALSE if it is low.
1230
1231		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1232
1233		I2C_SDA(bit)
1234
1235		If <bit> is TRUE, sets the I2C data line high. If it
1236		is FALSE, it clears it (low).
1237
1238		eg: #define I2C_SDA(bit) \
1239			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
1240			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
1241
1242		I2C_SCL(bit)
1243
1244		If <bit> is TRUE, sets the I2C clock line high. If it
1245		is FALSE, it clears it (low).
1246
1247		eg: #define I2C_SCL(bit) \
1248			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
1249			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
1250
1251		I2C_DELAY
1252
1253		This delay is invoked four times per clock cycle so this
1254		controls the rate of data transfer.  The data rate thus
1255		is 1 / (I2C_DELAY * 4). Often defined to be something
1256		like:
1257
1258		#define I2C_DELAY  udelay(2)
1259
1260		CFG_I2C_INIT_BOARD
1261
1262		When a board is reset during an i2c bus transfer
1263		chips might think that the current transfer is still
1264		in progress. On some boards it is possible to access
1265		the i2c SCLK line directly, either by using the
1266		processor pin as a GPIO or by having a second pin
1267		connected to the bus. If this option is defined a
1268		custom i2c_init_board() routine in boards/xxx/board.c
1269		is run early in the boot sequence.
1270
1271		CONFIG_I2CFAST (PPC405GP|PPC405EP only)
1272
1273		This option enables configuration of bi_iic_fast[] flags
1274		in u-boot bd_info structure based on u-boot environment
1275		variable "i2cfast". (see also i2cfast)
1276
1277- SPI Support:	CONFIG_SPI
1278
1279		Enables SPI driver (so far only tested with
1280		SPI EEPROM, also an instance works with Crystal A/D and
1281		D/As on the SACSng board)
1282
1283		CONFIG_SPI_X
1284
1285		Enables extended (16-bit) SPI EEPROM addressing.
1286		(symmetrical to CONFIG_I2C_X)
1287
1288		CONFIG_SOFT_SPI
1289
1290		Enables a software (bit-bang) SPI driver rather than
1291		using hardware support. This is a general purpose
1292		driver that only requires three general I/O port pins
1293		(two outputs, one input) to function. If this is
1294		defined, the board configuration must define several
1295		SPI configuration items (port pins to use, etc). For
1296		an example, see include/configs/sacsng.h.
1297
1298- FPGA Support: CONFIG_FPGA_COUNT
1299
1300		Specify the number of FPGA devices to support.
1301
1302		CONFIG_FPGA
1303
1304		Used to specify the types of FPGA devices.  For example,
1305		#define CONFIG_FPGA  CFG_XILINX_VIRTEX2
1306
1307		CFG_FPGA_PROG_FEEDBACK
1308
1309		Enable printing of hash marks during FPGA configuration.
1310
1311		CFG_FPGA_CHECK_BUSY
1312
1313		Enable checks on FPGA configuration interface busy
1314		status by the configuration function. This option
1315		will require a board or device specific function to
1316		be written.
1317
1318		CONFIG_FPGA_DELAY
1319
1320		If defined, a function that provides delays in the FPGA
1321		configuration driver.
1322
1323		CFG_FPGA_CHECK_CTRLC
1324		Allow Control-C to interrupt FPGA configuration
1325
1326		CFG_FPGA_CHECK_ERROR
1327
1328		Check for configuration errors during FPGA bitfile
1329		loading. For example, abort during Virtex II
1330		configuration if the INIT_B line goes low (which
1331		indicated a CRC error).
1332
1333		CFG_FPGA_WAIT_INIT
1334
1335		Maximum time to wait for the INIT_B line to deassert
1336		after PROB_B has been deasserted during a Virtex II
1337		FPGA configuration sequence. The default time is 500
1338		mS.
1339
1340		CFG_FPGA_WAIT_BUSY
1341
1342		Maximum time to wait for BUSY to deassert during
1343		Virtex II FPGA configuration. The default is 5 mS.
1344
1345		CFG_FPGA_WAIT_CONFIG
1346
1347		Time to wait after FPGA configuration. The default is
1348		200 mS.
1349
1350- Configuration Management:
1351		CONFIG_IDENT_STRING
1352
1353		If defined, this string will be added to the U-Boot
1354		version information (U_BOOT_VERSION)
1355
1356- Vendor Parameter Protection:
1357
1358		U-Boot considers the values of the environment
1359		variables "serial#" (Board Serial Number) and
1360		"ethaddr" (Ethernet Address) to be parameters that
1361		are set once by the board vendor / manufacturer, and
1362		protects these variables from casual modification by
1363		the user. Once set, these variables are read-only,
1364		and write or delete attempts are rejected. You can
1365		change this behviour:
1366
1367		If CONFIG_ENV_OVERWRITE is #defined in your config
1368		file, the write protection for vendor parameters is
1369		completely disabled. Anybody can change or delete
1370		these parameters.
1371
1372		Alternatively, if you #define _both_ CONFIG_ETHADDR
1373		_and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
1374		ethernet address is installed in the environment,
1375		which can be changed exactly ONCE by the user. [The
1376		serial# is unaffected by this, i. e. it remains
1377		read-only.]
1378
1379- Protected RAM:
1380		CONFIG_PRAM
1381
1382		Define this variable to enable the reservation of
1383		"protected RAM", i. e. RAM which is not overwritten
1384		by U-Boot. Define CONFIG_PRAM to hold the number of
1385		kB you want to reserve for pRAM. You can overwrite
1386		this default value by defining an environment
1387		variable "pram" to the number of kB you want to
1388		reserve. Note that the board info structure will
1389		still show the full amount of RAM. If pRAM is
1390		reserved, a new environment variable "mem" will
1391		automatically be defined to hold the amount of
1392		remaining RAM in a form that can be passed as boot
1393		argument to Linux, for instance like that:
1394
1395			setenv bootargs ... mem=\${mem}
1396			saveenv
1397
1398		This way you can tell Linux not to use this memory,
1399		either, which results in a memory region that will
1400		not be affected by reboots.
1401
1402		*WARNING* If your board configuration uses automatic
1403		detection of the RAM size, you must make sure that
1404		this memory test is non-destructive. So far, the
1405		following board configurations are known to be
1406		"pRAM-clean":
1407
1408			ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
1409			HERMES, IP860, RPXlite, LWMON, LANTEC,
1410			PCU_E, FLAGADM, TQM8260
1411
1412- Error Recovery:
1413		CONFIG_PANIC_HANG
1414
1415		Define this variable to stop the system in case of a
1416		fatal error, so that you have to reset it manually.
1417		This is probably NOT a good idea for an embedded
1418		system where you want to system to reboot
1419		automatically as fast as possible, but it may be
1420		useful during development since you can try to debug
1421		the conditions that lead to the situation.
1422
1423		CONFIG_NET_RETRY_COUNT
1424
1425		This variable defines the number of retries for
1426		network operations like ARP, RARP, TFTP, or BOOTP
1427		before giving up the operation. If not defined, a
1428		default value of 5 is used.
1429
1430- Command Interpreter:
1431		CFG_AUTO_COMPLETE
1432
1433		Enable auto completion of commands using TAB.
1434
1435		CFG_HUSH_PARSER
1436
1437		Define this variable to enable the "hush" shell (from
1438		Busybox) as command line interpreter, thus enabling
1439		powerful command line syntax like
1440		if...then...else...fi conditionals or `&&' and '||'
1441		constructs ("shell scripts").
1442
1443		If undefined, you get the old, much simpler behaviour
1444		with a somewhat smaller memory footprint.
1445
1446
1447		CFG_PROMPT_HUSH_PS2
1448
1449		This defines the secondary prompt string, which is
1450		printed when the command interpreter needs more input
1451		to complete a command. Usually "> ".
1452
1453	Note:
1454
1455		In the current implementation, the local variables
1456		space and global environment variables space are
1457		separated. Local variables are those you define by
1458		simply typing `name=value'. To access a local
1459		variable later on, you have write `$name' or
1460		`${name}'; to execute the contents of a variable
1461		directly type `$name' at the command prompt.
1462
1463		Global environment variables are those you use
1464		setenv/printenv to work with. To run a command stored
1465		in such a variable, you need to use the run command,
1466		and you must not use the '$' sign to access them.
1467
1468		To store commands and special characters in a
1469		variable, please use double quotation marks
1470		surrounding the whole text of the variable, instead
1471		of the backslashes before semicolons and special
1472		symbols.
1473
1474- Default Environment:
1475		CONFIG_EXTRA_ENV_SETTINGS
1476
1477		Define this to contain any number of null terminated
1478		strings (variable = value pairs) that will be part of
1479		the default environment compiled into the boot image.
1480
1481		For example, place something like this in your
1482		board's config file:
1483
1484		#define CONFIG_EXTRA_ENV_SETTINGS \
1485			"myvar1=value1\0" \
1486			"myvar2=value2\0"
1487
1488		Warning: This method is based on knowledge about the
1489		internal format how the environment is stored by the
1490		U-Boot code. This is NOT an official, exported
1491		interface! Although it is unlikely that this format
1492		will change soon, there is no guarantee either.
1493		You better know what you are doing here.
1494
1495		Note: overly (ab)use of the default environment is
1496		discouraged. Make sure to check other ways to preset
1497		the environment like the autoscript function or the
1498		boot command first.
1499
1500- DataFlash Support:
1501		CONFIG_HAS_DATAFLASH
1502
1503		Defining this option enables DataFlash features and
1504		allows to read/write in Dataflash via the standard
1505		commands cp, md...
1506
1507- SystemACE Support:
1508		CONFIG_SYSTEMACE
1509
1510		Adding this option adds support for Xilinx SystemACE
1511		chips attached via some sort of local bus. The address
1512		of the chip must alsh be defined in the
1513		CFG_SYSTEMACE_BASE macro. For example:
1514
1515		#define CONFIG_SYSTEMACE
1516		#define CFG_SYSTEMACE_BASE 0xf0000000
1517
1518		When SystemACE support is added, the "ace" device type
1519		becomes available to the fat commands, i.e. fatls.
1520
1521- TFTP Fixed UDP Port:
1522		CONFIG_TFTP_PORT
1523
1524		If this is defined, the environment variable tftpsrcp
1525		is used to supply the TFTP UDP source port value.
1526		If tftpsrcp isn't defined, the normal pseudo-random port
1527		number generator is used.
1528
1529		Also, the environment variable tftpdstp is used to supply
1530		the TFTP UDP destination port value.  If tftpdstp isn't
1531		defined, the normal port 69 is used.
1532
1533		The purpose for tftpsrcp is to allow a TFTP server to
1534		blindly start the TFTP transfer using the pre-configured
1535		target IP address and UDP port. This has the effect of
1536		"punching through" the (Windows XP) firewall, allowing
1537		the remainder of the TFTP transfer to proceed normally.
1538		A better solution is to properly configure the firewall,
1539		but sometimes that is not allowed.
1540
1541- Show boot progress:
1542		CONFIG_SHOW_BOOT_PROGRESS
1543
1544		Defining this option allows to add some board-
1545		specific code (calling a user-provided function
1546		"show_boot_progress(int)") that enables you to show
1547		the system's boot progress on some display (for
1548		example, some LED's) on your board. At the moment,
1549		the following checkpoints are implemented:
1550
1551  Arg	Where			When
1552    1	common/cmd_bootm.c	before attempting to boot an image
1553   -1	common/cmd_bootm.c	Image header has bad	 magic number
1554    2	common/cmd_bootm.c	Image header has correct magic number
1555   -2	common/cmd_bootm.c	Image header has bad	 checksum
1556    3	common/cmd_bootm.c	Image header has correct checksum
1557   -3	common/cmd_bootm.c	Image data   has bad	 checksum
1558    4	common/cmd_bootm.c	Image data   has correct checksum
1559   -4	common/cmd_bootm.c	Image is for unsupported architecture
1560    5	common/cmd_bootm.c	Architecture check OK
1561   -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi, standalone)
1562    6	common/cmd_bootm.c	Image Type check OK
1563   -6	common/cmd_bootm.c	gunzip uncompression error
1564   -7	common/cmd_bootm.c	Unimplemented compression type
1565    7	common/cmd_bootm.c	Uncompression OK
1566   -8	common/cmd_bootm.c	Wrong Image Type (not kernel, multi, standalone)
1567    8	common/cmd_bootm.c	Image Type check OK
1568   -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
1569    9	common/cmd_bootm.c	Start initial ramdisk verification
1570  -10	common/cmd_bootm.c	Ramdisk header has bad	   magic number
1571  -11	common/cmd_bootm.c	Ramdisk header has bad	   checksum
1572   10	common/cmd_bootm.c	Ramdisk header is OK
1573  -12	common/cmd_bootm.c	Ramdisk data   has bad	   checksum
1574   11	common/cmd_bootm.c	Ramdisk data   has correct checksum
1575   12	common/cmd_bootm.c	Ramdisk verification complete, start loading
1576  -13	common/cmd_bootm.c	Wrong Image Type (not PPC Linux Ramdisk)
1577   13	common/cmd_bootm.c	Start multifile image verification
1578   14	common/cmd_bootm.c	No initial ramdisk, no multifile, continue.
1579   15	common/cmd_bootm.c	All preparation done, transferring control to OS
1580
1581  -30	lib_ppc/board.c		Fatal error, hang the system
1582  -31	post/post.c		POST test failed, detected by post_output_backlog()
1583  -32	post/post.c		POST test failed, detected by post_run_single()
1584
1585   -1	common/cmd_doc.c	Bad usage of "doc" command
1586   -1	common/cmd_doc.c	No boot device
1587   -1	common/cmd_doc.c	Unknown Chip ID on boot device
1588   -1	common/cmd_doc.c	Read Error on boot device
1589   -1	common/cmd_doc.c	Image header has bad magic number
1590
1591   -1	common/cmd_ide.c	Bad usage of "ide" command
1592   -1	common/cmd_ide.c	No boot device
1593   -1	common/cmd_ide.c	Unknown boot device
1594   -1	common/cmd_ide.c	Unknown partition table
1595   -1	common/cmd_ide.c	Invalid partition type
1596   -1	common/cmd_ide.c	Read Error on boot device
1597   -1	common/cmd_ide.c	Image header has bad magic number
1598
1599   -1	common/cmd_nand.c	Bad usage of "nand" command
1600   -1	common/cmd_nand.c	No boot device
1601   -1	common/cmd_nand.c	Unknown Chip ID on boot device
1602   -1	common/cmd_nand.c	Read Error on boot device
1603   -1	common/cmd_nand.c	Image header has bad magic number
1604
1605   -1	common/env_common.c	Environment has a bad CRC, using default
1606
1607
1608Modem Support:
1609--------------
1610
1611[so far only for SMDK2400 and TRAB boards]
1612
1613- Modem support endable:
1614		CONFIG_MODEM_SUPPORT
1615
1616- RTS/CTS Flow control enable:
1617		CONFIG_HWFLOW
1618
1619- Modem debug support:
1620		CONFIG_MODEM_SUPPORT_DEBUG
1621
1622		Enables debugging stuff (char screen[1024], dbg())
1623		for modem support. Useful only with BDI2000.
1624
1625- Interrupt support (PPC):
1626
1627		There are common interrupt_init() and timer_interrupt()
1628		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
1629		for cpu specific initialization. interrupt_init_cpu()
1630		should set decrementer_count to appropriate value. If
1631		cpu resets decrementer automatically after interrupt
1632		(ppc4xx) it should set decrementer_count to zero.
1633		timer_interrupt() calls timer_interrupt_cpu() for cpu
1634		specific handling. If board has watchdog / status_led
1635		/ other_activity_monitor it works automatically from
1636		general timer_interrupt().
1637
1638- General:
1639
1640		In the target system modem support is enabled when a
1641		specific key (key combination) is pressed during
1642		power-on. Otherwise U-Boot will boot normally
1643		(autoboot). The key_pressed() fuction is called from
1644		board_init(). Currently key_pressed() is a dummy
1645		function, returning 1 and thus enabling modem
1646		initialization.
1647
1648		If there are no modem init strings in the
1649		environment, U-Boot proceed to autoboot; the
1650		previous output (banner, info printfs) will be
1651		supressed, though.
1652
1653		See also: doc/README.Modem
1654
1655
1656Configuration Settings:
1657-----------------------
1658
1659- CFG_LONGHELP: Defined when you want long help messages included;
1660		undefine this when you're short of memory.
1661
1662- CFG_PROMPT:	This is what U-Boot prints on the console to
1663		prompt for user input.
1664
1665- CFG_CBSIZE:	Buffer size for input from the Console
1666
1667- CFG_PBSIZE:	Buffer size for Console output
1668
1669- CFG_MAXARGS:	max. Number of arguments accepted for monitor commands
1670
1671- CFG_BARGSIZE: Buffer size for Boot Arguments which are passed to
1672		the application (usually a Linux kernel) when it is
1673		booted
1674
1675- CFG_BAUDRATE_TABLE:
1676		List of legal baudrate settings for this board.
1677
1678- CFG_CONSOLE_INFO_QUIET
1679		Suppress display of console information at boot.
1680
1681- CFG_CONSOLE_IS_IN_ENV
1682		If the board specific function
1683			extern int overwrite_console (void);
1684		returns 1, the stdin, stderr and stdout are switched to the
1685		serial port, else the settings in the environment are used.
1686
1687- CFG_CONSOLE_OVERWRITE_ROUTINE
1688		Enable the call to overwrite_console().
1689
1690- CFG_CONSOLE_ENV_OVERWRITE
1691		Enable overwrite of previous console environment settings.
1692
1693- CFG_MEMTEST_START, CFG_MEMTEST_END:
1694		Begin and End addresses of the area used by the
1695		simple memory test.
1696
1697- CFG_ALT_MEMTEST:
1698		Enable an alternate, more extensive memory test.
1699
1700- CFG_MEMTEST_SCRATCH:
1701		Scratch address used by the alternate memory test
1702		You only need to set this if address zero isn't writeable
1703
1704- CFG_TFTP_LOADADDR:
1705		Default load address for network file downloads
1706
1707- CFG_LOADS_BAUD_CHANGE:
1708		Enable temporary baudrate change while serial download
1709
1710- CFG_SDRAM_BASE:
1711		Physical start address of SDRAM. _Must_ be 0 here.
1712
1713- CFG_MBIO_BASE:
1714		Physical start address of Motherboard I/O (if using a
1715		Cogent motherboard)
1716
1717- CFG_FLASH_BASE:
1718		Physical start address of Flash memory.
1719
1720- CFG_MONITOR_BASE:
1721		Physical start address of boot monitor code (set by
1722		make config files to be same as the text base address
1723		(TEXT_BASE) used when linking) - same as
1724		CFG_FLASH_BASE when booting from flash.
1725
1726- CFG_MONITOR_LEN:
1727		Size of memory reserved for monitor code, used to
1728		determine _at_compile_time_ (!) if the environment is
1729		embedded within the U-Boot image, or in a separate
1730		flash sector.
1731
1732- CFG_MALLOC_LEN:
1733		Size of DRAM reserved for malloc() use.
1734
1735- CFG_BOOTMAPSZ:
1736		Maximum size of memory mapped by the startup code of
1737		the Linux kernel; all data that must be processed by
1738		the Linux kernel (bd_info, boot arguments, eventually
1739		initrd image) must be put below this limit.
1740
1741- CFG_MAX_FLASH_BANKS:
1742		Max number of Flash memory banks
1743
1744- CFG_MAX_FLASH_SECT:
1745		Max number of sectors on a Flash chip
1746
1747- CFG_FLASH_ERASE_TOUT:
1748		Timeout for Flash erase operations (in ms)
1749
1750- CFG_FLASH_WRITE_TOUT:
1751		Timeout for Flash write operations (in ms)
1752
1753- CFG_FLASH_LOCK_TOUT
1754		Timeout for Flash set sector lock bit operation (in ms)
1755
1756- CFG_FLASH_UNLOCK_TOUT
1757		Timeout for Flash clear lock bits operation (in ms)
1758
1759- CFG_FLASH_PROTECTION
1760		If defined, hardware flash sectors protection is used
1761		instead of U-Boot software protection.
1762
1763- CFG_DIRECT_FLASH_TFTP:
1764
1765		Enable TFTP transfers directly to flash memory;
1766		without this option such a download has to be
1767		performed in two steps: (1) download to RAM, and (2)
1768		copy from RAM to flash.
1769
1770		The two-step approach is usually more reliable, since
1771		you can check if the download worked before you erase
1772		the flash, but in some situations (when sytem RAM is
1773		too limited to allow for a tempory copy of the
1774		downloaded image) this option may be very useful.
1775
1776- CFG_FLASH_CFI:
1777		Define if the flash driver uses extra elements in the
1778		common flash structure for storing flash geometry.
1779
1780- CFG_FLASH_CFI_DRIVER
1781		This option also enables the building of the cfi_flash driver
1782		in the drivers directory
1783
1784- CFG_FLASH_QUIET_TEST
1785		If this option is defined, the common CFI flash doesn't
1786		print it's warning upon not recognized FLASH banks. This
1787		is useful, if some of the configured banks are only
1788		optionally available.
1789
1790- CFG_RX_ETH_BUFFER:
1791		Defines the number of ethernet receive buffers. On some
1792		ethernet controllers it is recommended to set this value
1793		to 8 or even higher (EEPRO100 or 405 EMAC), since all
1794		buffers can be full shortly after enabling the interface
1795		on high ethernet traffic.
1796		Defaults to 4 if not defined.
1797
1798The following definitions that deal with the placement and management
1799of environment data (variable area); in general, we support the
1800following configurations:
1801
1802- CFG_ENV_IS_IN_FLASH:
1803
1804	Define this if the environment is in flash memory.
1805
1806	a) The environment occupies one whole flash sector, which is
1807	   "embedded" in the text segment with the U-Boot code. This
1808	   happens usually with "bottom boot sector" or "top boot
1809	   sector" type flash chips, which have several smaller
1810	   sectors at the start or the end. For instance, such a
1811	   layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
1812	   such a case you would place the environment in one of the
1813	   4 kB sectors - with U-Boot code before and after it. With
1814	   "top boot sector" type flash chips, you would put the
1815	   environment in one of the last sectors, leaving a gap
1816	   between U-Boot and the environment.
1817
1818	- CFG_ENV_OFFSET:
1819
1820	   Offset of environment data (variable area) to the
1821	   beginning of flash memory; for instance, with bottom boot
1822	   type flash chips the second sector can be used: the offset
1823	   for this sector is given here.
1824
1825	   CFG_ENV_OFFSET is used relative to CFG_FLASH_BASE.
1826
1827	- CFG_ENV_ADDR:
1828
1829	   This is just another way to specify the start address of
1830	   the flash sector containing the environment (instead of
1831	   CFG_ENV_OFFSET).
1832
1833	- CFG_ENV_SECT_SIZE:
1834
1835	   Size of the sector containing the environment.
1836
1837
1838	b) Sometimes flash chips have few, equal sized, BIG sectors.
1839	   In such a case you don't want to spend a whole sector for
1840	   the environment.
1841
1842	- CFG_ENV_SIZE:
1843
1844	   If you use this in combination with CFG_ENV_IS_IN_FLASH
1845	   and CFG_ENV_SECT_SIZE, you can specify to use only a part
1846	   of this flash sector for the environment. This saves
1847	   memory for the RAM copy of the environment.
1848
1849	   It may also save flash memory if you decide to use this
1850	   when your environment is "embedded" within U-Boot code,
1851	   since then the remainder of the flash sector could be used
1852	   for U-Boot code. It should be pointed out that this is
1853	   STRONGLY DISCOURAGED from a robustness point of view:
1854	   updating the environment in flash makes it always
1855	   necessary to erase the WHOLE sector. If something goes
1856	   wrong before the contents has been restored from a copy in
1857	   RAM, your target system will be dead.
1858
1859	- CFG_ENV_ADDR_REDUND
1860	  CFG_ENV_SIZE_REDUND
1861
1862	   These settings describe a second storage area used to hold
1863	   a redundand copy of the environment data, so that there is
1864	   a valid backup copy in case there is a power failure during
1865	   a "saveenv" operation.
1866
1867BE CAREFUL! Any changes to the flash layout, and some changes to the
1868source code will make it necessary to adapt <board>/u-boot.lds*
1869accordingly!
1870
1871
1872- CFG_ENV_IS_IN_NVRAM:
1873
1874	Define this if you have some non-volatile memory device
1875	(NVRAM, battery buffered SRAM) which you want to use for the
1876	environment.
1877
1878	- CFG_ENV_ADDR:
1879	- CFG_ENV_SIZE:
1880
1881	  These two #defines are used to determin the memory area you
1882	  want to use for environment. It is assumed that this memory
1883	  can just be read and written to, without any special
1884	  provision.
1885
1886BE CAREFUL! The first access to the environment happens quite early
1887in U-Boot initalization (when we try to get the setting of for the
1888console baudrate). You *MUST* have mappend your NVRAM area then, or
1889U-Boot will hang.
1890
1891Please note that even with NVRAM we still use a copy of the
1892environment in RAM: we could work on NVRAM directly, but we want to
1893keep settings there always unmodified except somebody uses "saveenv"
1894to save the current settings.
1895
1896
1897- CFG_ENV_IS_IN_EEPROM:
1898
1899	Use this if you have an EEPROM or similar serial access
1900	device and a driver for it.
1901
1902	- CFG_ENV_OFFSET:
1903	- CFG_ENV_SIZE:
1904
1905	  These two #defines specify the offset and size of the
1906	  environment area within the total memory of your EEPROM.
1907
1908	- CFG_I2C_EEPROM_ADDR:
1909	  If defined, specified the chip address of the EEPROM device.
1910	  The default address is zero.
1911
1912	- CFG_EEPROM_PAGE_WRITE_BITS:
1913	  If defined, the number of bits used to address bytes in a
1914	  single page in the EEPROM device.  A 64 byte page, for example
1915	  would require six bits.
1916
1917	- CFG_EEPROM_PAGE_WRITE_DELAY_MS:
1918	  If defined, the number of milliseconds to delay between
1919	  page writes.	The default is zero milliseconds.
1920
1921	- CFG_I2C_EEPROM_ADDR_LEN:
1922	  The length in bytes of the EEPROM memory array address.  Note
1923	  that this is NOT the chip address length!
1924
1925	- CFG_I2C_EEPROM_ADDR_OVERFLOW:
1926	  EEPROM chips that implement "address overflow" are ones
1927	  like Catalyst 24WC04/08/16 which has 9/10/11 bits of
1928	  address and the extra bits end up in the "chip address" bit
1929	  slots. This makes a 24WC08 (1Kbyte) chip look like four 256
1930	  byte chips.
1931
1932	  Note that we consider the length of the address field to
1933	  still be one byte because the extra address bits are hidden
1934	  in the chip address.
1935
1936	- CFG_EEPROM_SIZE:
1937	  The size in bytes of the EEPROM device.
1938
1939
1940- CFG_ENV_IS_IN_DATAFLASH:
1941
1942	Define this if you have a DataFlash memory device which you
1943	want to use for the environment.
1944
1945	- CFG_ENV_OFFSET:
1946	- CFG_ENV_ADDR:
1947	- CFG_ENV_SIZE:
1948
1949	  These three #defines specify the offset and size of the
1950	  environment area within the total memory of your DataFlash placed
1951	  at the specified address.
1952
1953- CFG_ENV_IS_IN_NAND:
1954
1955	Define this if you have a NAND device which you want to use
1956	for the environment.
1957
1958	- CFG_ENV_OFFSET:
1959	- CFG_ENV_SIZE:
1960
1961	  These two #defines specify the offset and size of the environment
1962	  area within the first NAND device.
1963
1964	- CFG_ENV_OFFSET_REDUND
1965
1966	  This setting describes a second storage area of CFG_ENV_SIZE
1967	  size used to hold a redundant copy of the environment data,
1968	  so that there is a valid backup copy in case there is a
1969	  power failure during a "saveenv" operation.
1970
1971	Note: CFG_ENV_OFFSET and CFG_ENV_OFFSET_REDUND must be aligned
1972	to a block boundary, and CFG_ENV_SIZE must be a multiple of
1973	the NAND devices block size.
1974
1975- CFG_SPI_INIT_OFFSET
1976
1977	Defines offset to the initial SPI buffer area in DPRAM. The
1978	area is used at an early stage (ROM part) if the environment
1979	is configured to reside in the SPI EEPROM: We need a 520 byte
1980	scratch DPRAM area. It is used between the two initialization
1981	calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
1982	to be a good choice since it makes it far enough from the
1983	start of the data area as well as from the stack pointer.
1984
1985Please note that the environment is read-only as long as the monitor
1986has been relocated to RAM and a RAM copy of the environment has been
1987created; also, when using EEPROM you will have to use getenv_r()
1988until then to read environment variables.
1989
1990The environment is protected by a CRC32 checksum. Before the monitor
1991is relocated into RAM, as a result of a bad CRC you will be working
1992with the compiled-in default environment - *silently*!!! [This is
1993necessary, because the first environment variable we need is the
1994"baudrate" setting for the console - if we have a bad CRC, we don't
1995have any device yet where we could complain.]
1996
1997Note: once the monitor has been relocated, then it will complain if
1998the default environment is used; a new CRC is computed as soon as you
1999use the "saveenv" command to store a valid environment.
2000
2001- CFG_FAULT_ECHO_LINK_DOWN:
2002		Echo the inverted Ethernet link state to the fault LED.
2003
2004		Note: If this option is active, then CFG_FAULT_MII_ADDR
2005		      also needs to be defined.
2006
2007- CFG_FAULT_MII_ADDR:
2008		MII address of the PHY to check for the Ethernet link state.
2009
2010- CFG_64BIT_VSPRINTF:
2011		Makes vsprintf (and all *printf functions) support printing
2012		of 64bit values by using the L quantifier
2013
2014- CFG_64BIT_STRTOUL:
2015		Adds simple_strtoull that returns a 64bit value
2016
2017Low Level (hardware related) configuration options:
2018---------------------------------------------------
2019
2020- CFG_CACHELINE_SIZE:
2021		Cache Line Size of the CPU.
2022
2023- CFG_DEFAULT_IMMR:
2024		Default address of the IMMR after system reset.
2025
2026		Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
2027		and RPXsuper) to be able to adjust the position of
2028		the IMMR register after a reset.
2029
2030- Floppy Disk Support:
2031		CFG_FDC_DRIVE_NUMBER
2032
2033		the default drive number (default value 0)
2034
2035		CFG_ISA_IO_STRIDE
2036
2037		defines the spacing between fdc chipset registers
2038		(default value 1)
2039
2040		CFG_ISA_IO_OFFSET
2041
2042		defines the offset of register from address. It
2043		depends on which part of the data bus is connected to
2044		the fdc chipset. (default value 0)
2045
2046		If CFG_ISA_IO_STRIDE CFG_ISA_IO_OFFSET and
2047		CFG_FDC_DRIVE_NUMBER are undefined, they take their
2048		default value.
2049
2050		if CFG_FDC_HW_INIT is defined, then the function
2051		fdc_hw_init() is called at the beginning of the FDC
2052		setup. fdc_hw_init() must be provided by the board
2053		source code. It is used to make hardware dependant
2054		initializations.
2055
2056- CFG_IMMR:	Physical address of the Internal Memory.
2057		DO NOT CHANGE unless you know exactly what you're
2058		doing! (11-4) [MPC8xx/82xx systems only]
2059
2060- CFG_INIT_RAM_ADDR:
2061
2062		Start address of memory area that can be used for
2063		initial data and stack; please note that this must be
2064		writable memory that is working WITHOUT special
2065		initialization, i. e. you CANNOT use normal RAM which
2066		will become available only after programming the
2067		memory controller and running certain initialization
2068		sequences.
2069
2070		U-Boot uses the following memory types:
2071		- MPC8xx and MPC8260: IMMR (internal memory of the CPU)
2072		- MPC824X: data cache
2073		- PPC4xx:  data cache
2074
2075- CFG_GBL_DATA_OFFSET:
2076
2077		Offset of the initial data structure in the memory
2078		area defined by CFG_INIT_RAM_ADDR. Usually
2079		CFG_GBL_DATA_OFFSET is chosen such that the initial
2080		data is located at the end of the available space
2081		(sometimes written as (CFG_INIT_RAM_END -
2082		CFG_INIT_DATA_SIZE), and the initial stack is just
2083		below that area (growing from (CFG_INIT_RAM_ADDR +
2084		CFG_GBL_DATA_OFFSET) downward.
2085
2086	Note:
2087		On the MPC824X (or other systems that use the data
2088		cache for initial memory) the address chosen for
2089		CFG_INIT_RAM_ADDR is basically arbitrary - it must
2090		point to an otherwise UNUSED address space between
2091		the top of RAM and the start of the PCI space.
2092
2093- CFG_SIUMCR:	SIU Module Configuration (11-6)
2094
2095- CFG_SYPCR:	System Protection Control (11-9)
2096
2097- CFG_TBSCR:	Time Base Status and Control (11-26)
2098
2099- CFG_PISCR:	Periodic Interrupt Status and Control (11-31)
2100
2101- CFG_PLPRCR:	PLL, Low-Power, and Reset Control Register (15-30)
2102
2103- CFG_SCCR:	System Clock and reset Control Register (15-27)
2104
2105- CFG_OR_TIMING_SDRAM:
2106		SDRAM timing
2107
2108- CFG_MAMR_PTA:
2109		periodic timer for refresh
2110
2111- CFG_DER:	Debug Event Register (37-47)
2112
2113- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CFG_REMAP_OR_AM,
2114  CFG_PRELIM_OR_AM, CFG_OR_TIMING_FLASH, CFG_OR0_REMAP,
2115  CFG_OR0_PRELIM, CFG_BR0_PRELIM, CFG_OR1_REMAP, CFG_OR1_PRELIM,
2116  CFG_BR1_PRELIM:
2117		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
2118
2119- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
2120  CFG_OR_TIMING_SDRAM, CFG_OR2_PRELIM, CFG_BR2_PRELIM,
2121  CFG_OR3_PRELIM, CFG_BR3_PRELIM:
2122		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
2123
2124- CFG_MAMR_PTA, CFG_MPTPR_2BK_4K, CFG_MPTPR_1BK_4K, CFG_MPTPR_2BK_8K,
2125  CFG_MPTPR_1BK_8K, CFG_MAMR_8COL, CFG_MAMR_9COL:
2126		Machine Mode Register and Memory Periodic Timer
2127		Prescaler definitions (SDRAM timing)
2128
2129- CFG_I2C_UCODE_PATCH, CFG_I2C_DPMEM_OFFSET [0x1FC0]:
2130		enable I2C microcode relocation patch (MPC8xx);
2131		define relocation offset in DPRAM [DSP2]
2132
2133- CFG_SPI_UCODE_PATCH, CFG_SPI_DPMEM_OFFSET [0x1FC0]:
2134		enable SPI microcode relocation patch (MPC8xx);
2135		define relocation offset in DPRAM [SCC4]
2136
2137- CFG_USE_OSCCLK:
2138		Use OSCM clock mode on MBX8xx board. Be careful,
2139		wrong setting might damage your board. Read
2140		doc/README.MBX before setting this variable!
2141
2142- CFG_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
2143		Offset of the bootmode word in DPRAM used by post
2144		(Power On Self Tests). This definition overrides
2145		#define'd default value in commproc.h resp.
2146		cpm_8260.h.
2147
2148- CFG_PCI_SLV_MEM_LOCAL, CFG_PCI_SLV_MEM_BUS, CFG_PICMR0_MASK_ATTRIB,
2149  CFG_PCI_MSTR0_LOCAL, CFG_PCIMSK0_MASK, CFG_PCI_MSTR1_LOCAL,
2150  CFG_PCIMSK1_MASK, CFG_PCI_MSTR_MEM_LOCAL, CFG_PCI_MSTR_MEM_BUS,
2151  CFG_CPU_PCI_MEM_START, CFG_PCI_MSTR_MEM_SIZE, CFG_POCMR0_MASK_ATTRIB,
2152  CFG_PCI_MSTR_MEMIO_LOCAL, CFG_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
2153  CFG_PCI_MSTR_MEMIO_SIZE, CFG_POCMR1_MASK_ATTRIB, CFG_PCI_MSTR_IO_LOCAL,
2154  CFG_PCI_MSTR_IO_BUS, CFG_CPU_PCI_IO_START, CFG_PCI_MSTR_IO_SIZE,
2155  CFG_POCMR2_MASK_ATTRIB: (MPC826x only)
2156		Overrides the default PCI memory map in cpu/mpc8260/pci.c if set.
2157
2158- CONFIG_ETHER_ON_FEC[12]
2159		Define to enable FEC[12] on a 8xx series processor.
2160
2161- CONFIG_FEC[12]_PHY
2162		Define to the hardcoded PHY address which corresponds
2163		to the given FEC; i. e.
2164			#define CONFIG_FEC1_PHY 4
2165		means that the PHY with address 4 is connected to FEC1
2166
2167		When set to -1, means to probe for first available.
2168
2169- CONFIG_FEC[12]_PHY_NORXERR
2170		The PHY does not have a RXERR line (RMII only).
2171		(so program the FEC to ignore it).
2172
2173- CONFIG_RMII
2174		Enable RMII mode for all FECs.
2175		Note that this is a global option, we can't
2176		have one FEC in standard MII mode and another in RMII mode.
2177
2178- CONFIG_CRC32_VERIFY
2179		Add a verify option to the crc32 command.
2180		The syntax is:
2181
2182		=> crc32 -v <address> <count> <crc32>
2183
2184		Where address/count indicate a memory area
2185		and crc32 is the correct crc32 which the
2186		area should have.
2187
2188- CONFIG_LOOPW
2189		Add the "loopw" memory command. This only takes effect if
2190		the memory commands are activated globally (CFG_CMD_MEM).
2191
2192- CONFIG_MX_CYCLIC
2193		Add the "mdc" and "mwc" memory commands. These are cyclic
2194		"md/mw" commands.
2195		Examples:
2196
2197		=> mdc.b 10 4 500
2198		This command will print 4 bytes (10,11,12,13) each 500 ms.
2199
2200		=> mwc.l 100 12345678 10
2201		This command will write 12345678 to address 100 all 10 ms.
2202
2203		This only takes effect if the memory commands are activated
2204		globally (CFG_CMD_MEM).
2205
2206- CONFIG_SKIP_LOWLEVEL_INIT
2207- CONFIG_SKIP_RELOCATE_UBOOT
2208
2209		[ARM only] If these variables are defined, then
2210		certain low level initializations (like setting up
2211		the memory controller) are omitted and/or U-Boot does
2212		not relocate itself into RAM.
2213		Normally these variables MUST NOT be defined. The
2214		only exception is when U-Boot is loaded (to RAM) by
2215		some other boot loader or by a debugger which
2216		performs these intializations itself.
2217
2218
2219Building the Software:
2220======================
2221
2222Building U-Boot has been tested in native PPC environments (on a
2223PowerBook G3 running LinuxPPC 2000) and in cross environments
2224(running RedHat 6.x and 7.x Linux on x86, Solaris 2.6 on a SPARC, and
2225NetBSD 1.5 on x86).
2226
2227If you are not using a native PPC environment, it is assumed that you
2228have the GNU cross compiling tools available in your path and named
2229with a prefix of "powerpc-linux-". If this is not the case, (e.g. if
2230you are using Monta Vista's Hard Hat Linux CDK 1.2) you must change
2231the definition of CROSS_COMPILE in Makefile. For HHL on a 4xx CPU,
2232change it to:
2233
2234	CROSS_COMPILE = ppc_4xx-
2235
2236
2237U-Boot is intended to be  simple  to  build.  After  installing	 the
2238sources	 you must configure U-Boot for one specific board type. This
2239is done by typing:
2240
2241	make NAME_config
2242
2243where "NAME_config" is the name of one of the existing
2244configurations; the following names are supported:
2245
2246	ADCIOP_config		FPS860L_config		omap730p2_config
2247	ADS860_config		GEN860T_config		pcu_e_config
2248	Alaska8220_config
2249	AR405_config		GENIETV_config		PIP405_config
2250	at91rm9200dk_config	GTH_config		QS823_config
2251	CANBT_config		hermes_config		QS850_config
2252	cmi_mpc5xx_config	hymod_config		QS860T_config
2253	cogent_common_config	IP860_config		RPXlite_config
2254	cogent_mpc8260_config	IVML24_config		RPXlite_DW_config
2255	cogent_mpc8xx_config	IVMS8_config		RPXsuper_config
2256	CPCI405_config		JSE_config		rsdproto_config
2257	CPCIISER4_config	LANTEC_config		Sandpoint8240_config
2258	csb272_config		lwmon_config		sbc8260_config
2259	CU824_config		MBX860T_config		sbc8560_33_config
2260	DUET_ADS_config		MBX_config		sbc8560_66_config
2261	EBONY_config		MPC8260ADS_config	SM850_config
2262	ELPT860_config		MPC8540ADS_config	SPD823TS_config
2263	ESTEEM192E_config	MPC8540EVAL_config	stxgp3_config
2264	ETX094_config		MPC8560ADS_config	SXNI855T_config
2265	FADS823_config		NETVIA_config		TQM823L_config
2266	FADS850SAR_config	omap1510inn_config	TQM850L_config
2267	FADS860T_config		omap1610h2_config	TQM855L_config
2268	FPS850L_config		omap1610inn_config	TQM860L_config
2269				omap5912osk_config	walnut_config
2270				omap2420h4_config	Yukon8220_config
2271							ZPC1900_config
2272
2273Note: for some board special configuration names may exist; check if
2274      additional information is available from the board vendor; for
2275      instance, the TQM823L systems are available without (standard)
2276      or with LCD support. You can select such additional "features"
2277      when chosing the configuration, i. e.
2278
2279      make TQM823L_config
2280	- will configure for a plain TQM823L, i. e. no LCD support
2281
2282      make TQM823L_LCD_config
2283	- will configure for a TQM823L with U-Boot console on LCD
2284
2285      etc.
2286
2287
2288Finally, type "make all", and you should get some working U-Boot
2289images ready for download to / installation on your system:
2290
2291- "u-boot.bin" is a raw binary image
2292- "u-boot" is an image in ELF binary format
2293- "u-boot.srec" is in Motorola S-Record format
2294
2295
2296Please be aware that the Makefiles assume you are using GNU make, so
2297for instance on NetBSD you might need to use "gmake" instead of
2298native "make".
2299
2300
2301If the system board that you have is not listed, then you will need
2302to port U-Boot to your hardware platform. To do this, follow these
2303steps:
2304
23051.  Add a new configuration option for your board to the toplevel
2306    "Makefile" and to the "MAKEALL" script, using the existing
2307    entries as examples. Note that here and at many other places
2308    boards and other names are listed in alphabetical sort order. Please
2309    keep this order.
23102.  Create a new directory to hold your board specific code. Add any
2311    files you need. In your board directory, you will need at least
2312    the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
23133.  Create a new configuration file "include/configs/<board>.h" for
2314    your board
23153.  If you're porting U-Boot to a new CPU, then also create a new
2316    directory to hold your CPU specific code. Add any files you need.
23174.  Run "make <board>_config" with your new name.
23185.  Type "make", and you should get a working "u-boot.srec" file
2319    to be installed on your target system.
23206.  Debug and solve any problems that might arise.
2321    [Of course, this last step is much harder than it sounds.]
2322
2323
2324Testing of U-Boot Modifications, Ports to New Hardware, etc.:
2325==============================================================
2326
2327If you have modified U-Boot sources (for instance added a new	board
2328or  support  for  new  devices,	 a new CPU, etc.) you are expected to
2329provide feedback to the other developers. The feedback normally takes
2330the form of a "patch", i. e. a context diff against a certain (latest
2331official or latest in CVS) version of U-Boot sources.
2332
2333But before you submit such a patch, please verify that	your  modifi-
2334cation	did not break existing code. At least make sure that *ALL* of
2335the supported boards compile WITHOUT ANY compiler warnings. To do so,
2336just run the "MAKEALL" script, which will configure and build U-Boot
2337for ALL supported system. Be warned, this will take a while. You  can
2338select	which  (cross)	compiler  to use by passing a `CROSS_COMPILE'
2339environment variable to the script, i. e. to use the cross tools from
2340MontaVista's Hard Hat Linux you can type
2341
2342	CROSS_COMPILE=ppc_8xx- MAKEALL
2343
2344or to build on a native PowerPC system you can type
2345
2346	CROSS_COMPILE=' ' MAKEALL
2347
2348See also "U-Boot Porting Guide" below.
2349
2350
2351Monitor Commands - Overview:
2352============================
2353
2354go	- start application at address 'addr'
2355run	- run commands in an environment variable
2356bootm	- boot application image from memory
2357bootp	- boot image via network using BootP/TFTP protocol
2358tftpboot- boot image via network using TFTP protocol
2359	       and env variables "ipaddr" and "serverip"
2360	       (and eventually "gatewayip")
2361rarpboot- boot image via network using RARP/TFTP protocol
2362diskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
2363loads	- load S-Record file over serial line
2364loadb	- load binary file over serial line (kermit mode)
2365md	- memory display
2366mm	- memory modify (auto-incrementing)
2367nm	- memory modify (constant address)
2368mw	- memory write (fill)
2369cp	- memory copy
2370cmp	- memory compare
2371crc32	- checksum calculation
2372imd	- i2c memory display
2373imm	- i2c memory modify (auto-incrementing)
2374inm	- i2c memory modify (constant address)
2375imw	- i2c memory write (fill)
2376icrc32	- i2c checksum calculation
2377iprobe	- probe to discover valid I2C chip addresses
2378iloop	- infinite loop on address range
2379isdram	- print SDRAM configuration information
2380sspi	- SPI utility commands
2381base	- print or set address offset
2382printenv- print environment variables
2383setenv	- set environment variables
2384saveenv - save environment variables to persistent storage
2385protect - enable or disable FLASH write protection
2386erase	- erase FLASH memory
2387flinfo	- print FLASH memory information
2388bdinfo	- print Board Info structure
2389iminfo	- print header information for application image
2390coninfo - print console devices and informations
2391ide	- IDE sub-system
2392loop	- infinite loop on address range
2393loopw	- infinite write loop on address range
2394mtest	- simple RAM test
2395icache	- enable or disable instruction cache
2396dcache	- enable or disable data cache
2397reset	- Perform RESET of the CPU
2398echo	- echo args to console
2399version - print monitor version
2400help	- print online help
2401?	- alias for 'help'
2402
2403
2404Monitor Commands - Detailed Description:
2405========================================
2406
2407TODO.
2408
2409For now: just type "help <command>".
2410
2411
2412Environment Variables:
2413======================
2414
2415U-Boot supports user configuration using Environment Variables which
2416can be made persistent by saving to Flash memory.
2417
2418Environment Variables are set using "setenv", printed using
2419"printenv", and saved to Flash using "saveenv". Using "setenv"
2420without a value can be used to delete a variable from the
2421environment. As long as you don't save the environment you are
2422working with an in-memory copy. In case the Flash area containing the
2423environment is erased by accident, a default environment is provided.
2424
2425Some configuration options can be set using Environment Variables:
2426
2427  baudrate	- see CONFIG_BAUDRATE
2428
2429  bootdelay	- see CONFIG_BOOTDELAY
2430
2431  bootcmd	- see CONFIG_BOOTCOMMAND
2432
2433  bootargs	- Boot arguments when booting an RTOS image
2434
2435  bootfile	- Name of the image to load with TFTP
2436
2437  autoload	- if set to "no" (any string beginning with 'n'),
2438		  "bootp" will just load perform a lookup of the
2439		  configuration from the BOOTP server, but not try to
2440		  load any image using TFTP
2441
2442  autostart	- if set to "yes", an image loaded using the "bootp",
2443		  "rarpboot", "tftpboot" or "diskboot" commands will
2444		  be automatically started (by internally calling
2445		  "bootm")
2446
2447		  If set to "no", a standalone image passed to the
2448		  "bootm" command will be copied to the load address
2449		  (and eventually uncompressed), but NOT be started.
2450		  This can be used to load and uncompress arbitrary
2451		  data.
2452
2453  i2cfast	- (PPC405GP|PPC405EP only)
2454		  if set to 'y' configures Linux I2C driver for fast
2455		  mode (400kHZ). This environment variable is used in
2456		  initialization code. So, for changes to be effective
2457		  it must be saved and board must be reset.
2458
2459  initrd_high	- restrict positioning of initrd images:
2460		  If this variable is not set, initrd images will be
2461		  copied to the highest possible address in RAM; this
2462		  is usually what you want since it allows for
2463		  maximum initrd size. If for some reason you want to
2464		  make sure that the initrd image is loaded below the
2465		  CFG_BOOTMAPSZ limit, you can set this environment
2466		  variable to a value of "no" or "off" or "0".
2467		  Alternatively, you can set it to a maximum upper
2468		  address to use (U-Boot will still check that it
2469		  does not overwrite the U-Boot stack and data).
2470
2471		  For instance, when you have a system with 16 MB
2472		  RAM, and want to reserve 4 MB from use by Linux,
2473		  you can do this by adding "mem=12M" to the value of
2474		  the "bootargs" variable. However, now you must make
2475		  sure that the initrd image is placed in the first
2476		  12 MB as well - this can be done with
2477
2478		  setenv initrd_high 00c00000
2479
2480		  If you set initrd_high to 0xFFFFFFFF, this is an
2481		  indication to U-Boot that all addresses are legal
2482		  for the Linux kernel, including addresses in flash
2483		  memory. In this case U-Boot will NOT COPY the
2484		  ramdisk at all. This may be useful to reduce the
2485		  boot time on your system, but requires that this
2486		  feature is supported by your Linux kernel.
2487
2488  ipaddr	- IP address; needed for tftpboot command
2489
2490  loadaddr	- Default load address for commands like "bootp",
2491		  "rarpboot", "tftpboot", "loadb" or "diskboot"
2492
2493  loads_echo	- see CONFIG_LOADS_ECHO
2494
2495  serverip	- TFTP server IP address; needed for tftpboot command
2496
2497  bootretry	- see CONFIG_BOOT_RETRY_TIME
2498
2499  bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
2500
2501  bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
2502
2503  ethprime	- When CONFIG_NET_MULTI is enabled controls which
2504		  interface is used first.
2505
2506  ethact	- When CONFIG_NET_MULTI is enabled controls which
2507		  interface is currently active. For example you
2508		  can do the following
2509
2510		  => setenv ethact FEC ETHERNET
2511		  => ping 192.168.0.1 # traffic sent on FEC ETHERNET
2512		  => setenv ethact SCC ETHERNET
2513		  => ping 10.0.0.1 # traffic sent on SCC ETHERNET
2514
2515   netretry	- When set to "no" each network operation will
2516		  either succeed or fail without retrying.
2517		  When set to "once" the network operation will
2518		  fail when all the available network interfaces
2519		  are tried once without success.
2520		  Useful on scripts which control the retry operation
2521		  themselves.
2522
2523  tftpsrcport	- If this is set, the value is used for TFTP's
2524		  UDP source port.
2525
2526  tftpdstport	- If this is set, the value is used for TFTP's UDP
2527		  destination port instead of the Well Know Port 69.
2528
2529   vlan		- When set to a value < 4095 the traffic over
2530		  ethernet is encapsulated/received over 802.1q
2531		  VLAN tagged frames.
2532
2533The following environment variables may be used and automatically
2534updated by the network boot commands ("bootp" and "rarpboot"),
2535depending the information provided by your boot server:
2536
2537  bootfile	- see above
2538  dnsip		- IP address of your Domain Name Server
2539  dnsip2	- IP address of your secondary Domain Name Server
2540  gatewayip	- IP address of the Gateway (Router) to use
2541  hostname	- Target hostname
2542  ipaddr	- see above
2543  netmask	- Subnet Mask
2544  rootpath	- Pathname of the root filesystem on the NFS server
2545  serverip	- see above
2546
2547
2548There are two special Environment Variables:
2549
2550  serial#	- contains hardware identification information such
2551		  as type string and/or serial number
2552  ethaddr	- Ethernet address
2553
2554These variables can be set only once (usually during manufacturing of
2555the board). U-Boot refuses to delete or overwrite these variables
2556once they have been set once.
2557
2558
2559Further special Environment Variables:
2560
2561  ver		- Contains the U-Boot version string as printed
2562		  with the "version" command. This variable is
2563		  readonly (see CONFIG_VERSION_VARIABLE).
2564
2565
2566Please note that changes to some configuration parameters may take
2567only effect after the next boot (yes, that's just like Windoze :-).
2568
2569
2570Command Line Parsing:
2571=====================
2572
2573There are two different command line parsers available with U-Boot:
2574the old "simple" one, and the much more powerful "hush" shell:
2575
2576Old, simple command line parser:
2577--------------------------------
2578
2579- supports environment variables (through setenv / saveenv commands)
2580- several commands on one line, separated by ';'
2581- variable substitution using "... ${name} ..." syntax
2582- special characters ('$', ';') can be escaped by prefixing with '\',
2583  for example:
2584	setenv bootcmd bootm \${address}
2585- You can also escape text by enclosing in single apostrophes, for example:
2586	setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
2587
2588Hush shell:
2589-----------
2590
2591- similar to Bourne shell, with control structures like
2592  if...then...else...fi, for...do...done; while...do...done,
2593  until...do...done, ...
2594- supports environment ("global") variables (through setenv / saveenv
2595  commands) and local shell variables (through standard shell syntax
2596  "name=value"); only environment variables can be used with "run"
2597  command
2598
2599General rules:
2600--------------
2601
2602(1) If a command line (or an environment variable executed by a "run"
2603    command) contains several commands separated by semicolon, and
2604    one of these commands fails, then the remaining commands will be
2605    executed anyway.
2606
2607(2) If you execute several variables with one call to run (i. e.
2608    calling run with a list af variables as arguments), any failing
2609    command will cause "run" to terminate, i. e. the remaining
2610    variables are not executed.
2611
2612Note for Redundant Ethernet Interfaces:
2613=======================================
2614
2615Some boards come with redundant ethernet interfaces; U-Boot supports
2616such configurations and is capable of automatic selection of a
2617"working" interface when needed. MAC assignment works as follows:
2618
2619Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
2620MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
2621"eth1addr" (=>eth1), "eth2addr", ...
2622
2623If the network interface stores some valid MAC address (for instance
2624in SROM), this is used as default address if there is NO correspon-
2625ding setting in the environment; if the corresponding environment
2626variable is set, this overrides the settings in the card; that means:
2627
2628o If the SROM has a valid MAC address, and there is no address in the
2629  environment, the SROM's address is used.
2630
2631o If there is no valid address in the SROM, and a definition in the
2632  environment exists, then the value from the environment variable is
2633  used.
2634
2635o If both the SROM and the environment contain a MAC address, and
2636  both addresses are the same, this MAC address is used.
2637
2638o If both the SROM and the environment contain a MAC address, and the
2639  addresses differ, the value from the environment is used and a
2640  warning is printed.
2641
2642o If neither SROM nor the environment contain a MAC address, an error
2643  is raised.
2644
2645
2646Image Formats:
2647==============
2648
2649The "boot" commands of this monitor operate on "image" files which
2650can be basicly anything, preceeded by a special header; see the
2651definitions in include/image.h for details; basicly, the header
2652defines the following image properties:
2653
2654* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
2655  4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
2656  LynxOS, pSOS, QNX, RTEMS, ARTOS;
2657  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, ARTOS, LynxOS).
2658* Target CPU Architecture (Provisions for Alpha, ARM, Intel x86,
2659  IA64, MIPS, NIOS, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
2660  Currently supported: ARM, Intel x86, MIPS, NIOS, PowerPC).
2661* Compression Type (uncompressed, gzip, bzip2)
2662* Load Address
2663* Entry Point
2664* Image Name
2665* Image Timestamp
2666
2667The header is marked by a special Magic Number, and both the header
2668and the data portions of the image are secured against corruption by
2669CRC32 checksums.
2670
2671
2672Linux Support:
2673==============
2674
2675Although U-Boot should support any OS or standalone application
2676easily, the main focus has always been on Linux during the design of
2677U-Boot.
2678
2679U-Boot includes many features that so far have been part of some
2680special "boot loader" code within the Linux kernel. Also, any
2681"initrd" images to be used are no longer part of one big Linux image;
2682instead, kernel and "initrd" are separate images. This implementation
2683serves several purposes:
2684
2685- the same features can be used for other OS or standalone
2686  applications (for instance: using compressed images to reduce the
2687  Flash memory footprint)
2688
2689- it becomes much easier to port new Linux kernel versions because
2690  lots of low-level, hardware dependent stuff are done by U-Boot
2691
2692- the same Linux kernel image can now be used with different "initrd"
2693  images; of course this also means that different kernel images can
2694  be run with the same "initrd". This makes testing easier (you don't
2695  have to build a new "zImage.initrd" Linux image when you just
2696  change a file in your "initrd"). Also, a field-upgrade of the
2697  software is easier now.
2698
2699
2700Linux HOWTO:
2701============
2702
2703Porting Linux to U-Boot based systems:
2704---------------------------------------
2705
2706U-Boot cannot save you from doing all the necessary modifications to
2707configure the Linux device drivers for use with your target hardware
2708(no, we don't intend to provide a full virtual machine interface to
2709Linux :-).
2710
2711But now you can ignore ALL boot loader code (in arch/ppc/mbxboot).
2712
2713Just make sure your machine specific header file (for instance
2714include/asm-ppc/tqm8xx.h) includes the same definition of the Board
2715Information structure as we define in include/u-boot.h, and make
2716sure that your definition of IMAP_ADDR uses the same value as your
2717U-Boot configuration in CFG_IMMR.
2718
2719
2720Configuring the Linux kernel:
2721-----------------------------
2722
2723No specific requirements for U-Boot. Make sure you have some root
2724device (initial ramdisk, NFS) for your target system.
2725
2726
2727Building a Linux Image:
2728-----------------------
2729
2730With U-Boot, "normal" build targets like "zImage" or "bzImage" are
2731not used. If you use recent kernel source, a new build target
2732"uImage" will exist which automatically builds an image usable by
2733U-Boot. Most older kernels also have support for a "pImage" target,
2734which was introduced for our predecessor project PPCBoot and uses a
2735100% compatible format.
2736
2737Example:
2738
2739	make TQM850L_config
2740	make oldconfig
2741	make dep
2742	make uImage
2743
2744The "uImage" build target uses a special tool (in 'tools/mkimage') to
2745encapsulate a compressed Linux kernel image with header	 information,
2746CRC32 checksum etc. for use with U-Boot. This is what we are doing:
2747
2748* build a standard "vmlinux" kernel image (in ELF binary format):
2749
2750* convert the kernel into a raw binary image:
2751
2752	${CROSS_COMPILE}-objcopy -O binary \
2753				 -R .note -R .comment \
2754				 -S vmlinux linux.bin
2755
2756* compress the binary image:
2757
2758	gzip -9 linux.bin
2759
2760* package compressed binary image for U-Boot:
2761
2762	mkimage -A ppc -O linux -T kernel -C gzip \
2763		-a 0 -e 0 -n "Linux Kernel Image" \
2764		-d linux.bin.gz uImage
2765
2766
2767The "mkimage" tool can also be used to create ramdisk images for use
2768with U-Boot, either separated from the Linux kernel image, or
2769combined into one file. "mkimage" encapsulates the images with a 64
2770byte header containing information about target architecture,
2771operating system, image type, compression method, entry points, time
2772stamp, CRC32 checksums, etc.
2773
2774"mkimage" can be called in two ways: to verify existing images and
2775print the header information, or to build new images.
2776
2777In the first form (with "-l" option) mkimage lists the information
2778contained in the header of an existing U-Boot image; this includes
2779checksum verification:
2780
2781	tools/mkimage -l image
2782	  -l ==> list image header information
2783
2784The second form (with "-d" option) is used to build a U-Boot image
2785from a "data file" which is used as image payload:
2786
2787	tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
2788		      -n name -d data_file image
2789	  -A ==> set architecture to 'arch'
2790	  -O ==> set operating system to 'os'
2791	  -T ==> set image type to 'type'
2792	  -C ==> set compression type 'comp'
2793	  -a ==> set load address to 'addr' (hex)
2794	  -e ==> set entry point to 'ep' (hex)
2795	  -n ==> set image name to 'name'
2796	  -d ==> use image data from 'datafile'
2797
2798Right now, all Linux kernels for PowerPC systems use the same load
2799address (0x00000000), but the entry point address depends on the
2800kernel version:
2801
2802- 2.2.x kernels have the entry point at 0x0000000C,
2803- 2.3.x and later kernels have the entry point at 0x00000000.
2804
2805So a typical call to build a U-Boot image would read:
2806
2807	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
2808	> -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
2809	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz \
2810	> examples/uImage.TQM850L
2811	Image Name:   2.4.4 kernel for TQM850L
2812	Created:      Wed Jul 19 02:34:59 2000
2813	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
2814	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
2815	Load Address: 0x00000000
2816	Entry Point:  0x00000000
2817
2818To verify the contents of the image (or check for corruption):
2819
2820	-> tools/mkimage -l examples/uImage.TQM850L
2821	Image Name:   2.4.4 kernel for TQM850L
2822	Created:      Wed Jul 19 02:34:59 2000
2823	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
2824	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
2825	Load Address: 0x00000000
2826	Entry Point:  0x00000000
2827
2828NOTE: for embedded systems where boot time is critical you can trade
2829speed for memory and install an UNCOMPRESSED image instead: this
2830needs more space in Flash, but boots much faster since it does not
2831need to be uncompressed:
2832
2833	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz
2834	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
2835	> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
2836	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux \
2837	> examples/uImage.TQM850L-uncompressed
2838	Image Name:   2.4.4 kernel for TQM850L
2839	Created:      Wed Jul 19 02:34:59 2000
2840	Image Type:   PowerPC Linux Kernel Image (uncompressed)
2841	Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
2842	Load Address: 0x00000000
2843	Entry Point:  0x00000000
2844
2845
2846Similar you can build U-Boot images from a 'ramdisk.image.gz' file
2847when your kernel is intended to use an initial ramdisk:
2848
2849	-> tools/mkimage -n 'Simple Ramdisk Image' \
2850	> -A ppc -O linux -T ramdisk -C gzip \
2851	> -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
2852	Image Name:   Simple Ramdisk Image
2853	Created:      Wed Jan 12 14:01:50 2000
2854	Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
2855	Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
2856	Load Address: 0x00000000
2857	Entry Point:  0x00000000
2858
2859
2860Installing a Linux Image:
2861-------------------------
2862
2863To downloading a U-Boot image over the serial (console) interface,
2864you must convert the image to S-Record format:
2865
2866	objcopy -I binary -O srec examples/image examples/image.srec
2867
2868The 'objcopy' does not understand the information in the U-Boot
2869image header, so the resulting S-Record file will be relative to
2870address 0x00000000. To load it to a given address, you need to
2871specify the target address as 'offset' parameter with the 'loads'
2872command.
2873
2874Example: install the image to address 0x40100000 (which on the
2875TQM8xxL is in the first Flash bank):
2876
2877	=> erase 40100000 401FFFFF
2878
2879	.......... done
2880	Erased 8 sectors
2881
2882	=> loads 40100000
2883	## Ready for S-Record download ...
2884	~>examples/image.srec
2885	1 2 3 4 5 6 7 8 9 10 11 12 13 ...
2886	...
2887	15989 15990 15991 15992
2888	[file transfer complete]
2889	[connected]
2890	## Start Addr = 0x00000000
2891
2892
2893You can check the success of the download using the 'iminfo' command;
2894this includes a checksum verification so you  can  be  sure  no	 data
2895corruption happened:
2896
2897	=> imi 40100000
2898
2899	## Checking Image at 40100000 ...
2900	   Image Name:	 2.2.13 for initrd on TQM850L
2901	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
2902	   Data Size:	 335725 Bytes = 327 kB = 0 MB
2903	   Load Address: 00000000
2904	   Entry Point:	 0000000c
2905	   Verifying Checksum ... OK
2906
2907
2908Boot Linux:
2909-----------
2910
2911The "bootm" command is used to boot an application that is stored in
2912memory (RAM or Flash). In case of a Linux kernel image, the contents
2913of the "bootargs" environment variable is passed to the kernel as
2914parameters. You can check and modify this variable using the
2915"printenv" and "setenv" commands:
2916
2917
2918	=> printenv bootargs
2919	bootargs=root=/dev/ram
2920
2921	=> setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
2922
2923	=> printenv bootargs
2924	bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
2925
2926	=> bootm 40020000
2927	## Booting Linux kernel at 40020000 ...
2928	   Image Name:	 2.2.13 for NFS on TQM850L
2929	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
2930	   Data Size:	 381681 Bytes = 372 kB = 0 MB
2931	   Load Address: 00000000
2932	   Entry Point:	 0000000c
2933	   Verifying Checksum ... OK
2934	   Uncompressing Kernel Image ... OK
2935	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
2936	Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
2937	time_init: decrementer frequency = 187500000/60
2938	Calibrating delay loop... 49.77 BogoMIPS
2939	Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
2940	...
2941
2942If you want to boot a Linux kernel with initial ram disk, you pass
2943the memory addresses of both the kernel and the initrd image (PPBCOOT
2944format!) to the "bootm" command:
2945
2946	=> imi 40100000 40200000
2947
2948	## Checking Image at 40100000 ...
2949	   Image Name:	 2.2.13 for initrd on TQM850L
2950	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
2951	   Data Size:	 335725 Bytes = 327 kB = 0 MB
2952	   Load Address: 00000000
2953	   Entry Point:	 0000000c
2954	   Verifying Checksum ... OK
2955
2956	## Checking Image at 40200000 ...
2957	   Image Name:	 Simple Ramdisk Image
2958	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
2959	   Data Size:	 566530 Bytes = 553 kB = 0 MB
2960	   Load Address: 00000000
2961	   Entry Point:	 00000000
2962	   Verifying Checksum ... OK
2963
2964	=> bootm 40100000 40200000
2965	## Booting Linux kernel at 40100000 ...
2966	   Image Name:	 2.2.13 for initrd on TQM850L
2967	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
2968	   Data Size:	 335725 Bytes = 327 kB = 0 MB
2969	   Load Address: 00000000
2970	   Entry Point:	 0000000c
2971	   Verifying Checksum ... OK
2972	   Uncompressing Kernel Image ... OK
2973	## Loading RAMDisk Image at 40200000 ...
2974	   Image Name:	 Simple Ramdisk Image
2975	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
2976	   Data Size:	 566530 Bytes = 553 kB = 0 MB
2977	   Load Address: 00000000
2978	   Entry Point:	 00000000
2979	   Verifying Checksum ... OK
2980	   Loading Ramdisk ... OK
2981	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
2982	Boot arguments: root=/dev/ram
2983	time_init: decrementer frequency = 187500000/60
2984	Calibrating delay loop... 49.77 BogoMIPS
2985	...
2986	RAMDISK: Compressed image found at block 0
2987	VFS: Mounted root (ext2 filesystem).
2988
2989	bash#
2990
2991More About U-Boot Image Types:
2992------------------------------
2993
2994U-Boot supports the following image types:
2995
2996   "Standalone Programs" are directly runnable in the environment
2997	provided by U-Boot; it is expected that (if they behave
2998	well) you can continue to work in U-Boot after return from
2999	the Standalone Program.
3000   "OS Kernel Images" are usually images of some Embedded OS which
3001	will take over control completely. Usually these programs
3002	will install their own set of exception handlers, device
3003	drivers, set up the MMU, etc. - this means, that you cannot
3004	expect to re-enter U-Boot except by resetting the CPU.
3005   "RAMDisk Images" are more or less just data blocks, and their
3006	parameters (address, size) are passed to an OS kernel that is
3007	being started.
3008   "Multi-File Images" contain several images, typically an OS
3009	(Linux) kernel image and one or more data images like
3010	RAMDisks. This construct is useful for instance when you want
3011	to boot over the network using BOOTP etc., where the boot
3012	server provides just a single image file, but you want to get
3013	for instance an OS kernel and a RAMDisk image.
3014
3015	"Multi-File Images" start with a list of image sizes, each
3016	image size (in bytes) specified by an "uint32_t" in network
3017	byte order. This list is terminated by an "(uint32_t)0".
3018	Immediately after the terminating 0 follow the images, one by
3019	one, all aligned on "uint32_t" boundaries (size rounded up to
3020	a multiple of 4 bytes).
3021
3022   "Firmware Images" are binary images containing firmware (like
3023	U-Boot or FPGA images) which usually will be programmed to
3024	flash memory.
3025
3026   "Script files" are command sequences that will be executed by
3027	U-Boot's command interpreter; this feature is especially
3028	useful when you configure U-Boot to use a real shell (hush)
3029	as command interpreter.
3030
3031
3032Standalone HOWTO:
3033=================
3034
3035One of the features of U-Boot is that you can dynamically load and
3036run "standalone" applications, which can use some resources of
3037U-Boot like console I/O functions or interrupt services.
3038
3039Two simple examples are included with the sources:
3040
3041"Hello World" Demo:
3042-------------------
3043
3044'examples/hello_world.c' contains a small "Hello World" Demo
3045application; it is automatically compiled when you build U-Boot.
3046It's configured to run at address 0x00040004, so you can play with it
3047like that:
3048
3049	=> loads
3050	## Ready for S-Record download ...
3051	~>examples/hello_world.srec
3052	1 2 3 4 5 6 7 8 9 10 11 ...
3053	[file transfer complete]
3054	[connected]
3055	## Start Addr = 0x00040004
3056
3057	=> go 40004 Hello World! This is a test.
3058	## Starting application at 0x00040004 ...
3059	Hello World
3060	argc = 7
3061	argv[0] = "40004"
3062	argv[1] = "Hello"
3063	argv[2] = "World!"
3064	argv[3] = "This"
3065	argv[4] = "is"
3066	argv[5] = "a"
3067	argv[6] = "test."
3068	argv[7] = "<NULL>"
3069	Hit any key to exit ...
3070
3071	## Application terminated, rc = 0x0
3072
3073Another example, which demonstrates how to register a CPM interrupt
3074handler with the U-Boot code, can be found in 'examples/timer.c'.
3075Here, a CPM timer is set up to generate an interrupt every second.
3076The interrupt service routine is trivial, just printing a '.'
3077character, but this is just a demo program. The application can be
3078controlled by the following keys:
3079
3080	? - print current values og the CPM Timer registers
3081	b - enable interrupts and start timer
3082	e - stop timer and disable interrupts
3083	q - quit application
3084
3085	=> loads
3086	## Ready for S-Record download ...
3087	~>examples/timer.srec
3088	1 2 3 4 5 6 7 8 9 10 11 ...
3089	[file transfer complete]
3090	[connected]
3091	## Start Addr = 0x00040004
3092
3093	=> go 40004
3094	## Starting application at 0x00040004 ...
3095	TIMERS=0xfff00980
3096	Using timer 1
3097	  tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
3098
3099Hit 'b':
3100	[q, b, e, ?] Set interval 1000000 us
3101	Enabling timer
3102Hit '?':
3103	[q, b, e, ?] ........
3104	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
3105Hit '?':
3106	[q, b, e, ?] .
3107	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
3108Hit '?':
3109	[q, b, e, ?] .
3110	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
3111Hit '?':
3112	[q, b, e, ?] .
3113	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
3114Hit 'e':
3115	[q, b, e, ?] ...Stopping timer
3116Hit 'q':
3117	[q, b, e, ?] ## Application terminated, rc = 0x0
3118
3119
3120Minicom warning:
3121================
3122
3123Over time, many people have reported problems when trying to use the
3124"minicom" terminal emulation program for serial download. I (wd)
3125consider minicom to be broken, and recommend not to use it. Under
3126Unix, I recommend to use C-Kermit for general purpose use (and
3127especially for kermit binary protocol download ("loadb" command), and
3128use "cu" for S-Record download ("loads" command).
3129
3130Nevertheless, if you absolutely want to use it try adding this
3131configuration to your "File transfer protocols" section:
3132
3133	   Name	   Program			Name U/D FullScr IO-Red. Multi
3134	X  kermit  /usr/bin/kermit -i -l %l -s	 Y    U	   Y	   N	  N
3135	Y  kermit  /usr/bin/kermit -i -l %l -r	 N    D	   Y	   N	  N
3136
3137
3138NetBSD Notes:
3139=============
3140
3141Starting at version 0.9.2, U-Boot supports NetBSD both as host
3142(build U-Boot) and target system (boots NetBSD/mpc8xx).
3143
3144Building requires a cross environment; it is known to work on
3145NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
3146need gmake since the Makefiles are not compatible with BSD make).
3147Note that the cross-powerpc package does not install include files;
3148attempting to build U-Boot will fail because <machine/ansi.h> is
3149missing.  This file has to be installed and patched manually:
3150
3151	# cd /usr/pkg/cross/powerpc-netbsd/include
3152	# mkdir powerpc
3153	# ln -s powerpc machine
3154	# cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
3155	# ${EDIT} powerpc/ansi.h	## must remove __va_list, _BSD_VA_LIST
3156
3157Native builds *don't* work due to incompatibilities between native
3158and U-Boot include files.
3159
3160Booting assumes that (the first part of) the image booted is a
3161stage-2 loader which in turn loads and then invokes the kernel
3162proper. Loader sources will eventually appear in the NetBSD source
3163tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
3164meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
3165
3166
3167Implementation Internals:
3168=========================
3169
3170The following is not intended to be a complete description of every
3171implementation detail. However, it should help to understand the
3172inner workings of U-Boot and make it easier to port it to custom
3173hardware.
3174
3175
3176Initial Stack, Global Data:
3177---------------------------
3178
3179The implementation of U-Boot is complicated by the fact that U-Boot
3180starts running out of ROM (flash memory), usually without access to
3181system RAM (because the memory controller is not initialized yet).
3182This means that we don't have writable Data or BSS segments, and BSS
3183is not initialized as zero. To be able to get a C environment working
3184at all, we have to allocate at least a minimal stack. Implementation
3185options for this are defined and restricted by the CPU used: Some CPU
3186models provide on-chip memory (like the IMMR area on MPC8xx and
3187MPC826x processors), on others (parts of) the data cache can be
3188locked as (mis-) used as memory, etc.
3189
3190	Chris Hallinan posted a good summary of	 these	issues	to  the
3191	u-boot-users mailing list:
3192
3193	Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
3194	From: "Chris Hallinan" <clh@net1plus.com>
3195	Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
3196	...
3197
3198	Correct me if I'm wrong, folks, but the way I understand it
3199	is this: Using DCACHE as initial RAM for Stack, etc, does not
3200	require any physical RAM backing up the cache. The cleverness
3201	is that the cache is being used as a temporary supply of
3202	necessary storage before the SDRAM controller is setup. It's
3203	beyond the scope of this list to expain the details, but you
3204	can see how this works by studying the cache architecture and
3205	operation in the architecture and processor-specific manuals.
3206
3207	OCM is On Chip Memory, which I believe the 405GP has 4K. It
3208	is another option for the system designer to use as an
3209	initial stack/ram area prior to SDRAM being available. Either
3210	option should work for you. Using CS 4 should be fine if your
3211	board designers haven't used it for something that would
3212	cause you grief during the initial boot! It is frequently not
3213	used.
3214
3215	CFG_INIT_RAM_ADDR should be somewhere that won't interfere
3216	with your processor/board/system design. The default value
3217	you will find in any recent u-boot distribution in
3218	walnut.h should work for you. I'd set it to a value larger
3219	than your SDRAM module. If you have a 64MB SDRAM module, set
3220	it above 400_0000. Just make sure your board has no resources
3221	that are supposed to respond to that address! That code in
3222	start.S has been around a while and should work as is when
3223	you get the config right.
3224
3225	-Chris Hallinan
3226	DS4.COM, Inc.
3227
3228It is essential to remember this, since it has some impact on the C
3229code for the initialization procedures:
3230
3231* Initialized global data (data segment) is read-only. Do not attempt
3232  to write it.
3233
3234* Do not use any unitialized global data (or implicitely initialized
3235  as zero data - BSS segment) at all - this is undefined, initiali-
3236  zation is performed later (when relocating to RAM).
3237
3238* Stack space is very limited. Avoid big data buffers or things like
3239  that.
3240
3241Having only the stack as writable memory limits means we cannot use
3242normal global data to share information beween the code. But it
3243turned out that the implementation of U-Boot can be greatly
3244simplified by making a global data structure (gd_t) available to all
3245functions. We could pass a pointer to this data as argument to _all_
3246functions, but this would bloat the code. Instead we use a feature of
3247the GCC compiler (Global Register Variables) to share the data: we
3248place a pointer (gd) to the global data into a register which we
3249reserve for this purpose.
3250
3251When choosing a register for such a purpose we are restricted by the
3252relevant  (E)ABI  specifications for the current architecture, and by
3253GCC's implementation.
3254
3255For PowerPC, the following registers have specific use:
3256	R1:	stack pointer
3257	R2:	TOC pointer
3258	R3-R4:	parameter passing and return values
3259	R5-R10: parameter passing
3260	R13:	small data area pointer
3261	R30:	GOT pointer
3262	R31:	frame pointer
3263
3264	(U-Boot also uses R14 as internal GOT pointer.)
3265
3266    ==> U-Boot will use R29 to hold a pointer to the global data
3267
3268    Note: on PPC, we could use a static initializer (since the
3269    address of the global data structure is known at compile time),
3270    but it turned out that reserving a register results in somewhat
3271    smaller code - although the code savings are not that big (on
3272    average for all boards 752 bytes for the whole U-Boot image,
3273    624 text + 127 data).
3274
3275On ARM, the following registers are used:
3276
3277	R0:	function argument word/integer result
3278	R1-R3:	function argument word
3279	R9:	GOT pointer
3280	R10:	stack limit (used only if stack checking if enabled)
3281	R11:	argument (frame) pointer
3282	R12:	temporary workspace
3283	R13:	stack pointer
3284	R14:	link register
3285	R15:	program counter
3286
3287    ==> U-Boot will use R8 to hold a pointer to the global data
3288
3289
3290Memory Management:
3291------------------
3292
3293U-Boot runs in system state and uses physical addresses, i.e. the
3294MMU is not used either for address mapping nor for memory protection.
3295
3296The available memory is mapped to fixed addresses using the memory
3297controller. In this process, a contiguous block is formed for each
3298memory type (Flash, SDRAM, SRAM), even when it consists of several
3299physical memory banks.
3300
3301U-Boot is installed in the first 128 kB of the first Flash bank (on
3302TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
3303booting and sizing and initializing DRAM, the code relocates itself
3304to the upper end of DRAM. Immediately below the U-Boot code some
3305memory is reserved for use by malloc() [see CFG_MALLOC_LEN
3306configuration setting]. Below that, a structure with global Board
3307Info data is placed, followed by the stack (growing downward).
3308
3309Additionally, some exception handler code is copied to the low 8 kB
3310of DRAM (0x00000000 ... 0x00001FFF).
3311
3312So a typical memory configuration with 16 MB of DRAM could look like
3313this:
3314
3315	0x0000 0000	Exception Vector code
3316	      :
3317	0x0000 1FFF
3318	0x0000 2000	Free for Application Use
3319	      :
3320	      :
3321
3322	      :
3323	      :
3324	0x00FB FF20	Monitor Stack (Growing downward)
3325	0x00FB FFAC	Board Info Data and permanent copy of global data
3326	0x00FC 0000	Malloc Arena
3327	      :
3328	0x00FD FFFF
3329	0x00FE 0000	RAM Copy of Monitor Code
3330	...		eventually: LCD or video framebuffer
3331	...		eventually: pRAM (Protected RAM - unchanged by reset)
3332	0x00FF FFFF	[End of RAM]
3333
3334
3335System Initialization:
3336----------------------
3337
3338In the reset configuration, U-Boot starts at the reset entry point
3339(on most PowerPC systens at address 0x00000100). Because of the reset
3340configuration for CS0# this is a mirror of the onboard Flash memory.
3341To be able to re-map memory U-Boot then jumps to its link address.
3342To be able to implement the initialization code in C, a (small!)
3343initial stack is set up in the internal Dual Ported RAM (in case CPUs
3344which provide such a feature like MPC8xx or MPC8260), or in a locked
3345part of the data cache. After that, U-Boot initializes the CPU core,
3346the caches and the SIU.
3347
3348Next, all (potentially) available memory banks are mapped using a
3349preliminary mapping. For example, we put them on 512 MB boundaries
3350(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
3351on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
3352programmed for SDRAM access. Using the temporary configuration, a
3353simple memory test is run that determines the size of the SDRAM
3354banks.
3355
3356When there is more than one SDRAM bank, and the banks are of
3357different size, the largest is mapped first. For equal size, the first
3358bank (CS2#) is mapped first. The first mapping is always for address
33590x00000000, with any additional banks following immediately to create
3360contiguous memory starting from 0.
3361
3362Then, the monitor installs itself at the upper end of the SDRAM area
3363and allocates memory for use by malloc() and for the global Board
3364Info data; also, the exception vector code is copied to the low RAM
3365pages, and the final stack is set up.
3366
3367Only after this relocation will you have a "normal" C environment;
3368until that you are restricted in several ways, mostly because you are
3369running from ROM, and because the code will have to be relocated to a
3370new address in RAM.
3371
3372
3373U-Boot Porting Guide:
3374----------------------
3375
3376[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
3377list, October 2002]
3378
3379
3380int main (int argc, char *argv[])
3381{
3382	sighandler_t no_more_time;
3383
3384	signal (SIGALRM, no_more_time);
3385	alarm (PROJECT_DEADLINE - toSec (3 * WEEK));
3386
3387	if (available_money > available_manpower) {
3388		pay consultant to port U-Boot;
3389		return 0;
3390	}
3391
3392	Download latest U-Boot source;
3393
3394	Subscribe to u-boot-users mailing list;
3395
3396	if (clueless) {
3397		email ("Hi, I am new to U-Boot, how do I get started?");
3398	}
3399
3400	while (learning) {
3401		Read the README file in the top level directory;
3402		Read http://www.denx.de/twiki/bin/view/DULG/Manual ;
3403		Read the source, Luke;
3404	}
3405
3406	if (available_money > toLocalCurrency ($2500)) {
3407		Buy a BDI2000;
3408	} else {
3409		Add a lot of aggravation and time;
3410	}
3411
3412	Create your own board support subdirectory;
3413
3414	Create your own board config file;
3415
3416	while (!running) {
3417		do {
3418			Add / modify source code;
3419		} until (compiles);
3420		Debug;
3421		if (clueless)
3422			email ("Hi, I am having problems...");
3423	}
3424	Send patch file to Wolfgang;
3425
3426	return 0;
3427}
3428
3429void no_more_time (int sig)
3430{
3431      hire_a_guru();
3432}
3433
3434
3435Coding Standards:
3436-----------------
3437
3438All contributions to U-Boot should conform to the Linux kernel
3439coding style; see the file "Documentation/CodingStyle" in your Linux
3440kernel source directory.
3441
3442Please note that U-Boot is implemented in C (and to some small parts
3443in Assembler); no C++ is used, so please do not use C++ style
3444comments (//) in your code.
3445
3446Please also stick to the following formatting rules:
3447- remove any trailing white space
3448- use TAB characters for indentation, not spaces
3449- make sure NOT to use DOS '\r\n' line feeds
3450- do not add more than 2 empty lines to source files
3451- do not add trailing empty lines to source files
3452
3453Submissions which do not conform to the standards may be returned
3454with a request to reformat the changes.
3455
3456
3457Submitting Patches:
3458-------------------
3459
3460Since the number of patches for U-Boot is growing, we need to
3461establish some rules. Submissions which do not conform to these rules
3462may be rejected, even when they contain important and valuable stuff.
3463
3464Patches shall be sent to the u-boot-users mailing list.
3465
3466When you send a patch, please include the following information with
3467it:
3468
3469* For bug fixes: a description of the bug and how your patch fixes
3470  this bug. Please try to include a way of demonstrating that the
3471  patch actually fixes something.
3472
3473* For new features: a description of the feature and your
3474  implementation.
3475
3476* A CHANGELOG entry as plaintext (separate from the patch)
3477
3478* For major contributions, your entry to the CREDITS file
3479
3480* When you add support for a new board, don't forget to add this
3481  board to the MAKEALL script, too.
3482
3483* If your patch adds new configuration options, don't forget to
3484  document these in the README file.
3485
3486* The patch itself. If you are accessing the CVS repository use "cvs
3487  update; cvs diff -puRN"; else, use "diff -purN OLD NEW". If your
3488  version of diff does not support these options, then get the latest
3489  version of GNU diff.
3490
3491  The current directory when running this command shall be the top
3492  level directory of the U-Boot source tree, or it's parent directory
3493  (i. e. please make sure that your patch includes sufficient
3494  directory information for the affected files).
3495
3496  We accept patches as plain text, MIME attachments or as uuencoded
3497  gzipped text.
3498
3499* If one logical set of modifications affects or creates several
3500  files, all these changes shall be submitted in a SINGLE patch file.
3501
3502* Changesets that contain different, unrelated modifications shall be
3503  submitted as SEPARATE patches, one patch per changeset.
3504
3505
3506Notes:
3507
3508* Before sending the patch, run the MAKEALL script on your patched
3509  source tree and make sure that no errors or warnings are reported
3510  for any of the boards.
3511
3512* Keep your modifications to the necessary minimum: A patch
3513  containing several unrelated changes or arbitrary reformats will be
3514  returned with a request to re-formatting / split it.
3515
3516* If you modify existing code, make sure that your new code does not
3517  add to the memory footprint of the code ;-) Small is beautiful!
3518  When adding new features, these should compile conditionally only
3519  (using #ifdef), and the resulting code with the new feature
3520  disabled must not need more memory than the old code without your
3521  modification.
3522
3523* Remember that there is a size limit of 40 kB per message on the
3524  u-boot-users mailing list. Compression may help.
3525