xref: /openbmc/u-boot/README (revision e9b43cae)
1#
2# (C) Copyright 2000 - 2009
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. The MAINTAINERS file lists board
55maintainers.
56
57
58Where to get help:
59==================
60
61In case you have questions about, problems with or contributions for
62U-Boot you should send a message to the U-Boot mailing list at
63<u-boot@lists.denx.de>. There is also an archive of previous traffic
64on the mailing list - please search the archive before asking FAQ's.
65Please see http://lists.denx.de/pipermail/u-boot and
66http://dir.gmane.org/gmane.comp.boot-loaders.u-boot
67
68
69Where to get source code:
70=========================
71
72The U-Boot source code is maintained in the git repository at
73git://www.denx.de/git/u-boot.git ; you can browse it online at
74http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
75
76The "snapshot" links on this page allow you to download tarballs of
77any version you might be interested in. Official releases are also
78available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
79directory.
80
81Pre-built (and tested) images are available from
82ftp://ftp.denx.de/pub/u-boot/images/
83
84
85Where we come from:
86===================
87
88- start from 8xxrom sources
89- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
90- clean up code
91- make it easier to add custom boards
92- make it possible to add other [PowerPC] CPUs
93- extend functions, especially:
94  * Provide extended interface to Linux boot loader
95  * S-Record download
96  * network boot
97  * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
98- create ARMBoot project (http://sourceforge.net/projects/armboot)
99- add other CPU families (starting with ARM)
100- create U-Boot project (http://sourceforge.net/projects/u-boot)
101- current project page: see http://www.denx.de/wiki/U-Boot
102
103
104Names and Spelling:
105===================
106
107The "official" name of this project is "Das U-Boot". The spelling
108"U-Boot" shall be used in all written text (documentation, comments
109in source files etc.). Example:
110
111	This is the README file for the U-Boot project.
112
113File names etc. shall be based on the string "u-boot". Examples:
114
115	include/asm-ppc/u-boot.h
116
117	#include <asm/u-boot.h>
118
119Variable names, preprocessor constants etc. shall be either based on
120the string "u_boot" or on "U_BOOT". Example:
121
122	U_BOOT_VERSION		u_boot_logo
123	IH_OS_U_BOOT		u_boot_hush_start
124
125
126Versioning:
127===========
128
129U-Boot uses a 3 level version number containing a version, a
130sub-version, and a patchlevel: "U-Boot-2.34.5" means version "2",
131sub-version "34", and patchlevel "4".
132
133The patchlevel is used to indicate certain stages of development
134between released versions, i. e. officially released versions of
135U-Boot will always have a patchlevel of "0".
136
137
138Directory Hierarchy:
139====================
140
141/arch			Architecture specific files
142  /arm			Files generic to ARM architecture
143    /cpu		CPU specific files
144      /arm720t		Files specific to ARM 720 CPUs
145      /arm920t		Files specific to ARM 920 CPUs
146        /at91rm9200	Files specific to Atmel AT91RM9200 CPU
147        /imx		Files specific to Freescale MC9328 i.MX CPUs
148        /s3c24x0	Files specific to Samsung S3C24X0 CPUs
149      /arm925t		Files specific to ARM 925 CPUs
150      /arm926ejs	Files specific to ARM 926 CPUs
151      /arm1136		Files specific to ARM 1136 CPUs
152      /ixp		Files specific to Intel XScale IXP CPUs
153      /pxa		Files specific to Intel XScale PXA CPUs
154      /s3c44b0		Files specific to Samsung S3C44B0 CPUs
155      /sa1100		Files specific to Intel StrongARM SA1100 CPUs
156    /lib		Architecture specific library files
157  /avr32		Files generic to AVR32 architecture
158    /cpu		CPU specific files
159    /lib		Architecture specific library files
160  /blackfin		Files generic to Analog Devices Blackfin architecture
161    /cpu		CPU specific files
162    /lib		Architecture specific library files
163  /i386			Files generic to i386 architecture
164    /cpu		CPU specific files
165    /lib		Architecture specific library files
166  /m68k			Files generic to m68k architecture
167    /cpu		CPU specific files
168      /mcf52x2		Files specific to Freescale ColdFire MCF52x2 CPUs
169      /mcf5227x		Files specific to Freescale ColdFire MCF5227x CPUs
170      /mcf532x		Files specific to Freescale ColdFire MCF5329 CPUs
171      /mcf5445x		Files specific to Freescale ColdFire MCF5445x CPUs
172      /mcf547x_8x	Files specific to Freescale ColdFire MCF547x_8x CPUs
173    /lib		Architecture specific library files
174  /microblaze		Files generic to microblaze architecture
175    /cpu		CPU specific files
176    /lib		Architecture specific library files
177  /mips			Files generic to MIPS architecture
178    /cpu		CPU specific files
179    /lib		Architecture specific library files
180  /nios			Files generic to Altera NIOS architecture
181    /cpu		CPU specific files
182    /lib		Architecture specific library files
183  /nios2		Files generic to Altera NIOS2 architecture
184    /cpu		CPU specific files
185    /lib		Architecture specific library files
186  /powerpc		Files generic to PowerPC architecture
187    /cpu		CPU specific files
188      /74xx_7xx		Files specific to Freescale MPC74xx and 7xx CPUs
189      /mpc5xx		Files specific to Freescale MPC5xx CPUs
190      /mpc5xxx		Files specific to Freescale MPC5xxx CPUs
191      /mpc8xx		Files specific to Freescale MPC8xx CPUs
192      /mpc8220		Files specific to Freescale MPC8220 CPUs
193      /mpc824x		Files specific to Freescale MPC824x CPUs
194      /mpc8260		Files specific to Freescale MPC8260 CPUs
195      /mpc85xx		Files specific to Freescale MPC85xx CPUs
196      /ppc4xx		Files specific to AMCC PowerPC 4xx CPUs
197    /lib		Architecture specific library files
198  /sh			Files generic to SH architecture
199    /cpu		CPU specific files
200      /sh2		Files specific to sh2 CPUs
201      /sh3		Files specific to sh3 CPUs
202      /sh4		Files specific to sh4 CPUs
203    /lib		Architecture specific library files
204  /sparc		Files generic to SPARC architecture
205    /cpu		CPU specific files
206      /leon2		Files specific to Gaisler LEON2 SPARC CPU
207      /leon3		Files specific to Gaisler LEON3 SPARC CPU
208    /lib		Architecture specific library files
209/api			Machine/arch independent API for external apps
210/board			Board dependent files
211/common			Misc architecture independent functions
212/disk			Code for disk drive partition handling
213/doc			Documentation (don't expect too much)
214/drivers		Commonly used device drivers
215/examples		Example code for standalone applications, etc.
216/fs			Filesystem code (cramfs, ext2, jffs2, etc.)
217/include		Header Files
218/lib			Files generic to all architectures
219  /libfdt		Library files to support flattened device trees
220  /lzma			Library files to support LZMA decompression
221  /lzo			Library files to support LZO decompression
222/net			Networking code
223/post			Power On Self Test
224/rtc			Real Time Clock drivers
225/tools			Tools to build S-Record or U-Boot images, etc.
226
227Software Configuration:
228=======================
229
230Configuration is usually done using C preprocessor defines; the
231rationale behind that is to avoid dead code whenever possible.
232
233There are two classes of configuration variables:
234
235* Configuration _OPTIONS_:
236  These are selectable by the user and have names beginning with
237  "CONFIG_".
238
239* Configuration _SETTINGS_:
240  These depend on the hardware etc. and should not be meddled with if
241  you don't know what you're doing; they have names beginning with
242  "CONFIG_SYS_".
243
244Later we will add a configuration tool - probably similar to or even
245identical to what's used for the Linux kernel. Right now, we have to
246do the configuration by hand, which means creating some symbolic
247links and editing some configuration files. We use the TQM8xxL boards
248as an example here.
249
250
251Selection of Processor Architecture and Board Type:
252---------------------------------------------------
253
254For all supported boards there are ready-to-use default
255configurations available; just type "make <board_name>_config".
256
257Example: For a TQM823L module type:
258
259	cd u-boot
260	make TQM823L_config
261
262For the Cogent platform, you need to specify the CPU type as well;
263e.g. "make cogent_mpc8xx_config". And also configure the cogent
264directory according to the instructions in cogent/README.
265
266
267Configuration Options:
268----------------------
269
270Configuration depends on the combination of board and CPU type; all
271such information is kept in a configuration file
272"include/configs/<board_name>.h".
273
274Example: For a TQM823L module, all configuration settings are in
275"include/configs/TQM823L.h".
276
277
278Many of the options are named exactly as the corresponding Linux
279kernel configuration options. The intention is to make it easier to
280build a config tool - later.
281
282
283The following options need to be configured:
284
285- CPU Type:	Define exactly one, e.g. CONFIG_MPC85XX.
286
287- Board Type:	Define exactly one, e.g. CONFIG_MPC8540ADS.
288
289- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
290		Define exactly one, e.g. CONFIG_ATSTK1002
291
292- CPU Module Type: (if CONFIG_COGENT is defined)
293		Define exactly one of
294		CONFIG_CMA286_60_OLD
295--- FIXME --- not tested yet:
296		CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
297		CONFIG_CMA287_23, CONFIG_CMA287_50
298
299- Motherboard Type: (if CONFIG_COGENT is defined)
300		Define exactly one of
301		CONFIG_CMA101, CONFIG_CMA102
302
303- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
304		Define one or more of
305		CONFIG_CMA302
306
307- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
308		Define one or more of
309		CONFIG_LCD_HEARTBEAT	- update a character position on
310					  the LCD display every second with
311					  a "rotator" |\-/|\-/
312
313- Board flavour: (if CONFIG_MPC8260ADS is defined)
314		CONFIG_ADSTYPE
315		Possible values are:
316			CONFIG_SYS_8260ADS	- original MPC8260ADS
317			CONFIG_SYS_8266ADS	- MPC8266ADS
318			CONFIG_SYS_PQ2FADS	- PQ2FADS-ZU or PQ2FADS-VR
319			CONFIG_SYS_8272ADS	- MPC8272ADS
320
321- MPC824X Family Member (if CONFIG_MPC824X is defined)
322		Define exactly one of
323		CONFIG_MPC8240, CONFIG_MPC8245
324
325- 8xx CPU Options: (if using an MPC8xx CPU)
326		CONFIG_8xx_GCLK_FREQ	- deprecated: CPU clock if
327					  get_gclk_freq() cannot work
328					  e.g. if there is no 32KHz
329					  reference PIT/RTC clock
330		CONFIG_8xx_OSCLK	- PLL input clock (either EXTCLK
331					  or XTAL/EXTAL)
332
333- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
334		CONFIG_SYS_8xx_CPUCLK_MIN
335		CONFIG_SYS_8xx_CPUCLK_MAX
336		CONFIG_8xx_CPUCLK_DEFAULT
337			See doc/README.MPC866
338
339		CONFIG_SYS_MEASURE_CPUCLK
340
341		Define this to measure the actual CPU clock instead
342		of relying on the correctness of the configured
343		values. Mostly useful for board bringup to make sure
344		the PLL is locked at the intended frequency. Note
345		that this requires a (stable) reference clock (32 kHz
346		RTC clock or CONFIG_SYS_8XX_XIN)
347
348		CONFIG_SYS_DELAYED_ICACHE
349
350		Define this option if you want to enable the
351		ICache only when Code runs from RAM.
352
353- Intel Monahans options:
354		CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
355
356		Defines the Monahans run mode to oscillator
357		ratio. Valid values are 8, 16, 24, 31. The core
358		frequency is this value multiplied by 13 MHz.
359
360		CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
361
362		Defines the Monahans turbo mode to oscillator
363		ratio. Valid values are 1 (default if undefined) and
364		2. The core frequency as calculated above is multiplied
365		by this value.
366
367- Linux Kernel Interface:
368		CONFIG_CLOCKS_IN_MHZ
369
370		U-Boot stores all clock information in Hz
371		internally. For binary compatibility with older Linux
372		kernels (which expect the clocks passed in the
373		bd_info data to be in MHz) the environment variable
374		"clocks_in_mhz" can be defined so that U-Boot
375		converts clock data to MHZ before passing it to the
376		Linux kernel.
377		When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
378		"clocks_in_mhz=1" is automatically included in the
379		default environment.
380
381		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]
382
383		When transferring memsize parameter to linux, some versions
384		expect it to be in bytes, others in MB.
385		Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
386
387		CONFIG_OF_LIBFDT
388
389		New kernel versions are expecting firmware settings to be
390		passed using flattened device trees (based on open firmware
391		concepts).
392
393		CONFIG_OF_LIBFDT
394		 * New libfdt-based support
395		 * Adds the "fdt" command
396		 * The bootm command automatically updates the fdt
397
398		OF_CPU - The proper name of the cpus node (only required for
399			MPC512X and MPC5xxx based boards).
400		OF_SOC - The proper name of the soc node (only required for
401			MPC512X and MPC5xxx based boards).
402		OF_TBCLK - The timebase frequency.
403		OF_STDOUT_PATH - The path to the console device
404
405		boards with QUICC Engines require OF_QE to set UCC MAC
406		addresses
407
408		CONFIG_OF_BOARD_SETUP
409
410		Board code has addition modification that it wants to make
411		to the flat device tree before handing it off to the kernel
412
413		CONFIG_OF_BOOT_CPU
414
415		This define fills in the correct boot CPU in the boot
416		param header, the default value is zero if undefined.
417
418		CONFIG_OF_IDE_FIXUP
419
420		U-Boot can detect if an IDE device is present or not.
421		If not, and this new config option is activated, U-Boot
422		removes the ATA node from the DTS before booting Linux,
423		so the Linux IDE driver does not probe the device and
424		crash. This is needed for buggy hardware (uc101) where
425		no pull down resistor is connected to the signal IDE5V_DD7.
426
427- vxWorks boot parameters:
428
429		bootvx constructs a valid bootline using the following
430		environments variables: bootfile, ipaddr, serverip, hostname.
431		It loads the vxWorks image pointed bootfile.
432
433		CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
434		CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
435		CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
436		CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
437
438		CONFIG_SYS_VXWORKS_ADD_PARAMS
439
440		Add it at the end of the bootline. E.g "u=username pw=secret"
441
442		Note: If a "bootargs" environment is defined, it will overwride
443		the defaults discussed just above.
444
445- Serial Ports:
446		CONFIG_PL010_SERIAL
447
448		Define this if you want support for Amba PrimeCell PL010 UARTs.
449
450		CONFIG_PL011_SERIAL
451
452		Define this if you want support for Amba PrimeCell PL011 UARTs.
453
454		CONFIG_PL011_CLOCK
455
456		If you have Amba PrimeCell PL011 UARTs, set this variable to
457		the clock speed of the UARTs.
458
459		CONFIG_PL01x_PORTS
460
461		If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
462		define this to a list of base addresses for each (supported)
463		port. See e.g. include/configs/versatile.h
464
465
466- Console Interface:
467		Depending on board, define exactly one serial port
468		(like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
469		CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
470		console by defining CONFIG_8xx_CONS_NONE
471
472		Note: if CONFIG_8xx_CONS_NONE is defined, the serial
473		port routines must be defined elsewhere
474		(i.e. serial_init(), serial_getc(), ...)
475
476		CONFIG_CFB_CONSOLE
477		Enables console device for a color framebuffer. Needs following
478		defines (cf. smiLynxEM, i8042, board/eltec/bab7xx)
479			VIDEO_FB_LITTLE_ENDIAN	graphic memory organisation
480						(default big endian)
481			VIDEO_HW_RECTFILL	graphic chip supports
482						rectangle fill
483						(cf. smiLynxEM)
484			VIDEO_HW_BITBLT		graphic chip supports
485						bit-blit (cf. smiLynxEM)
486			VIDEO_VISIBLE_COLS	visible pixel columns
487						(cols=pitch)
488			VIDEO_VISIBLE_ROWS	visible pixel rows
489			VIDEO_PIXEL_SIZE	bytes per pixel
490			VIDEO_DATA_FORMAT	graphic data format
491						(0-5, cf. cfb_console.c)
492			VIDEO_FB_ADRS		framebuffer address
493			VIDEO_KBD_INIT_FCT	keyboard int fct
494						(i.e. i8042_kbd_init())
495			VIDEO_TSTC_FCT		test char fct
496						(i.e. i8042_tstc)
497			VIDEO_GETC_FCT		get char fct
498						(i.e. i8042_getc)
499			CONFIG_CONSOLE_CURSOR	cursor drawing on/off
500						(requires blink timer
501						cf. i8042.c)
502			CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
503			CONFIG_CONSOLE_TIME	display time/date info in
504						upper right corner
505						(requires CONFIG_CMD_DATE)
506			CONFIG_VIDEO_LOGO	display Linux logo in
507						upper left corner
508			CONFIG_VIDEO_BMP_LOGO	use bmp_logo.h instead of
509						linux_logo.h for logo.
510						Requires CONFIG_VIDEO_LOGO
511			CONFIG_CONSOLE_EXTRA_INFO
512						additional board info beside
513						the logo
514
515		When CONFIG_CFB_CONSOLE is defined, video console is
516		default i/o. Serial console can be forced with
517		environment 'console=serial'.
518
519		When CONFIG_SILENT_CONSOLE is defined, all console
520		messages (by U-Boot and Linux!) can be silenced with
521		the "silent" environment variable. See
522		doc/README.silent for more information.
523
524- Console Baudrate:
525		CONFIG_BAUDRATE - in bps
526		Select one of the baudrates listed in
527		CONFIG_SYS_BAUDRATE_TABLE, see below.
528		CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
529
530- Console Rx buffer length
531		With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
532		the maximum receive buffer length for the SMC.
533		This option is actual only for 82xx and 8xx possible.
534		If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
535		must be defined, to setup the maximum idle timeout for
536		the SMC.
537
538- Interrupt driven serial port input:
539		CONFIG_SERIAL_SOFTWARE_FIFO
540
541		PPC405GP only.
542		Use an interrupt handler for receiving data on the
543		serial port. It also enables using hardware handshake
544		(RTS/CTS) and UART's built-in FIFO. Set the number of
545		bytes the interrupt driven input buffer should have.
546
547		Leave undefined to disable this feature, including
548		disable the buffer and hardware handshake.
549
550- Console UART Number:
551		CONFIG_UART1_CONSOLE
552
553		AMCC PPC4xx only.
554		If defined internal UART1 (and not UART0) is used
555		as default U-Boot console.
556
557- Boot Delay:	CONFIG_BOOTDELAY - in seconds
558		Delay before automatically booting the default image;
559		set to -1 to disable autoboot.
560
561		See doc/README.autoboot for these options that
562		work with CONFIG_BOOTDELAY. None are required.
563		CONFIG_BOOT_RETRY_TIME
564		CONFIG_BOOT_RETRY_MIN
565		CONFIG_AUTOBOOT_KEYED
566		CONFIG_AUTOBOOT_PROMPT
567		CONFIG_AUTOBOOT_DELAY_STR
568		CONFIG_AUTOBOOT_STOP_STR
569		CONFIG_AUTOBOOT_DELAY_STR2
570		CONFIG_AUTOBOOT_STOP_STR2
571		CONFIG_ZERO_BOOTDELAY_CHECK
572		CONFIG_RESET_TO_RETRY
573
574- Autoboot Command:
575		CONFIG_BOOTCOMMAND
576		Only needed when CONFIG_BOOTDELAY is enabled;
577		define a command string that is automatically executed
578		when no character is read on the console interface
579		within "Boot Delay" after reset.
580
581		CONFIG_BOOTARGS
582		This can be used to pass arguments to the bootm
583		command. The value of CONFIG_BOOTARGS goes into the
584		environment value "bootargs".
585
586		CONFIG_RAMBOOT and CONFIG_NFSBOOT
587		The value of these goes into the environment as
588		"ramboot" and "nfsboot" respectively, and can be used
589		as a convenience, when switching between booting from
590		RAM and NFS.
591
592- Pre-Boot Commands:
593		CONFIG_PREBOOT
594
595		When this option is #defined, the existence of the
596		environment variable "preboot" will be checked
597		immediately before starting the CONFIG_BOOTDELAY
598		countdown and/or running the auto-boot command resp.
599		entering interactive mode.
600
601		This feature is especially useful when "preboot" is
602		automatically generated or modified. For an example
603		see the LWMON board specific code: here "preboot" is
604		modified when the user holds down a certain
605		combination of keys on the (special) keyboard when
606		booting the systems
607
608- Serial Download Echo Mode:
609		CONFIG_LOADS_ECHO
610		If defined to 1, all characters received during a
611		serial download (using the "loads" command) are
612		echoed back. This might be needed by some terminal
613		emulations (like "cu"), but may as well just take
614		time on others. This setting #define's the initial
615		value of the "loads_echo" environment variable.
616
617- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
618		CONFIG_KGDB_BAUDRATE
619		Select one of the baudrates listed in
620		CONFIG_SYS_BAUDRATE_TABLE, see below.
621
622- Monitor Functions:
623		Monitor commands can be included or excluded
624		from the build by using the #include files
625		"config_cmd_all.h" and #undef'ing unwanted
626		commands, or using "config_cmd_default.h"
627		and augmenting with additional #define's
628		for wanted commands.
629
630		The default command configuration includes all commands
631		except those marked below with a "*".
632
633		CONFIG_CMD_ASKENV	* ask for env variable
634		CONFIG_CMD_BDI		  bdinfo
635		CONFIG_CMD_BEDBUG	* Include BedBug Debugger
636		CONFIG_CMD_BMP		* BMP support
637		CONFIG_CMD_BSP		* Board specific commands
638		CONFIG_CMD_BOOTD	  bootd
639		CONFIG_CMD_CACHE	* icache, dcache
640		CONFIG_CMD_CONSOLE	  coninfo
641		CONFIG_CMD_DATE		* support for RTC, date/time...
642		CONFIG_CMD_DHCP		* DHCP support
643		CONFIG_CMD_DIAG		* Diagnostics
644		CONFIG_CMD_DS4510	* ds4510 I2C gpio commands
645		CONFIG_CMD_DS4510_INFO	* ds4510 I2C info command
646		CONFIG_CMD_DS4510_MEM	* ds4510 I2C eeprom/sram commansd
647		CONFIG_CMD_DS4510_RST	* ds4510 I2C rst command
648		CONFIG_CMD_DTT		* Digital Therm and Thermostat
649		CONFIG_CMD_ECHO		  echo arguments
650		CONFIG_CMD_EDITENV	  edit env variable
651		CONFIG_CMD_EEPROM	* EEPROM read/write support
652		CONFIG_CMD_ELF		* bootelf, bootvx
653		CONFIG_CMD_SAVEENV	  saveenv
654		CONFIG_CMD_FDC		* Floppy Disk Support
655		CONFIG_CMD_FAT		* FAT partition support
656		CONFIG_CMD_FDOS		* Dos diskette Support
657		CONFIG_CMD_FLASH	  flinfo, erase, protect
658		CONFIG_CMD_FPGA		  FPGA device initialization support
659		CONFIG_CMD_HWFLOW	* RTS/CTS hw flow control
660		CONFIG_CMD_I2C		* I2C serial bus support
661		CONFIG_CMD_IDE		* IDE harddisk support
662		CONFIG_CMD_IMI		  iminfo
663		CONFIG_CMD_IMLS		  List all found images
664		CONFIG_CMD_IMMAP	* IMMR dump support
665		CONFIG_CMD_IRQ		* irqinfo
666		CONFIG_CMD_ITEST	  Integer/string test of 2 values
667		CONFIG_CMD_JFFS2	* JFFS2 Support
668		CONFIG_CMD_KGDB		* kgdb
669		CONFIG_CMD_LOADB	  loadb
670		CONFIG_CMD_LOADS	  loads
671		CONFIG_CMD_MD5SUM	  print md5 message digest
672					  (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
673		CONFIG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
674					  loop, loopw, mtest
675		CONFIG_CMD_MISC		  Misc functions like sleep etc
676		CONFIG_CMD_MMC		* MMC memory mapped support
677		CONFIG_CMD_MII		* MII utility commands
678		CONFIG_CMD_MTDPARTS	* MTD partition support
679		CONFIG_CMD_NAND		* NAND support
680		CONFIG_CMD_NET		  bootp, tftpboot, rarpboot
681		CONFIG_CMD_PCA953X	* PCA953x I2C gpio commands
682		CONFIG_CMD_PCA953X_INFO	* PCA953x I2C gpio info command
683		CONFIG_CMD_PCI		* pciinfo
684		CONFIG_CMD_PCMCIA		* PCMCIA support
685		CONFIG_CMD_PING		* send ICMP ECHO_REQUEST to network
686					  host
687		CONFIG_CMD_PORTIO	* Port I/O
688		CONFIG_CMD_REGINFO	* Register dump
689		CONFIG_CMD_RUN		  run command in env variable
690		CONFIG_CMD_SAVES	* save S record dump
691		CONFIG_CMD_SCSI		* SCSI Support
692		CONFIG_CMD_SDRAM	* print SDRAM configuration information
693					  (requires CONFIG_CMD_I2C)
694		CONFIG_CMD_SETGETDCR	  Support for DCR Register access
695					  (4xx only)
696		CONFIG_CMD_SHA1		  print sha1 memory digest
697					  (requires CONFIG_CMD_MEMORY)
698		CONFIG_CMD_SOURCE	  "source" command Support
699		CONFIG_CMD_SPI		* SPI serial bus support
700		CONFIG_CMD_USB		* USB support
701		CONFIG_CMD_VFD		* VFD support (TRAB)
702		CONFIG_CMD_CDP		* Cisco Discover Protocol support
703		CONFIG_CMD_FSL		* Microblaze FSL support
704
705
706		EXAMPLE: If you want all functions except of network
707		support you can write:
708
709		#include "config_cmd_all.h"
710		#undef CONFIG_CMD_NET
711
712	Other Commands:
713		fdt (flattened device tree) command: CONFIG_OF_LIBFDT
714
715	Note:	Don't enable the "icache" and "dcache" commands
716		(configuration option CONFIG_CMD_CACHE) unless you know
717		what you (and your U-Boot users) are doing. Data
718		cache cannot be enabled on systems like the 8xx or
719		8260 (where accesses to the IMMR region must be
720		uncached), and it cannot be disabled on all other
721		systems where we (mis-) use the data cache to hold an
722		initial stack and some data.
723
724
725		XXX - this list needs to get updated!
726
727- Watchdog:
728		CONFIG_WATCHDOG
729		If this variable is defined, it enables watchdog
730		support. There must be support in the platform specific
731		code for a watchdog. For the 8xx and 8260 CPUs, the
732		SIU Watchdog feature is enabled in the SYPCR
733		register.
734
735- U-Boot Version:
736		CONFIG_VERSION_VARIABLE
737		If this variable is defined, an environment variable
738		named "ver" is created by U-Boot showing the U-Boot
739		version as printed by the "version" command.
740		This variable is readonly.
741
742- Real-Time Clock:
743
744		When CONFIG_CMD_DATE is selected, the type of the RTC
745		has to be selected, too. Define exactly one of the
746		following options:
747
748		CONFIG_RTC_MPC8xx	- use internal RTC of MPC8xx
749		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
750		CONFIG_RTC_MC13783	- use MC13783 RTC
751		CONFIG_RTC_MC146818	- use MC146818 RTC
752		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
753		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
754		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
755		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
756		CONFIG_RTC_ISL1208	- use Intersil ISL1208 RTC
757		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
758		CONFIG_SYS_RTC_DS1337_NOOSC	- Turn off the OSC output for DS1337
759
760		Note that if the RTC uses I2C, then the I2C interface
761		must also be configured. See I2C Support, below.
762
763- GPIO Support:
764		CONFIG_PCA953X		- use NXP's PCA953X series I2C GPIO
765		CONFIG_PCA953X_INFO	- enable pca953x info command
766
767		Note that if the GPIO device uses I2C, then the I2C interface
768		must also be configured. See I2C Support, below.
769
770- Timestamp Support:
771
772		When CONFIG_TIMESTAMP is selected, the timestamp
773		(date and time) of an image is printed by image
774		commands like bootm or iminfo. This option is
775		automatically enabled when you select CONFIG_CMD_DATE .
776
777- Partition Support:
778		CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
779		and/or CONFIG_ISO_PARTITION and/or CONFIG_EFI_PARTITION
780
781		If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
782		CONFIG_CMD_SCSI) you must configure support for at
783		least one partition type as well.
784
785- IDE Reset method:
786		CONFIG_IDE_RESET_ROUTINE - this is defined in several
787		board configurations files but used nowhere!
788
789		CONFIG_IDE_RESET - is this is defined, IDE Reset will
790		be performed by calling the function
791			ide_set_reset(int reset)
792		which has to be defined in a board specific file
793
794- ATAPI Support:
795		CONFIG_ATAPI
796
797		Set this to enable ATAPI support.
798
799- LBA48 Support
800		CONFIG_LBA48
801
802		Set this to enable support for disks larger than 137GB
803		Also look at CONFIG_SYS_64BIT_LBA.
804		Whithout these , LBA48 support uses 32bit variables and will 'only'
805		support disks up to 2.1TB.
806
807		CONFIG_SYS_64BIT_LBA:
808			When enabled, makes the IDE subsystem use 64bit sector addresses.
809			Default is 32bit.
810
811- SCSI Support:
812		At the moment only there is only support for the
813		SYM53C8XX SCSI controller; define
814		CONFIG_SCSI_SYM53C8XX to enable it.
815
816		CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
817		CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
818		CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
819		maximum numbers of LUNs, SCSI ID's and target
820		devices.
821		CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
822
823- NETWORK Support (PCI):
824		CONFIG_E1000
825		Support for Intel 8254x gigabit chips.
826
827		CONFIG_E1000_FALLBACK_MAC
828		default MAC for empty EEPROM after production.
829
830		CONFIG_EEPRO100
831		Support for Intel 82557/82559/82559ER chips.
832		Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
833		write routine for first time initialisation.
834
835		CONFIG_TULIP
836		Support for Digital 2114x chips.
837		Optional CONFIG_TULIP_SELECT_MEDIA for board specific
838		modem chip initialisation (KS8761/QS6611).
839
840		CONFIG_NATSEMI
841		Support for National dp83815 chips.
842
843		CONFIG_NS8382X
844		Support for National dp8382[01] gigabit chips.
845
846- NETWORK Support (other):
847
848		CONFIG_DRIVER_AT91EMAC
849		Support for AT91RM9200 EMAC.
850
851			CONFIG_RMII
852			Define this to use reduced MII inteface
853
854			CONFIG_DRIVER_AT91EMAC_QUIET
855			If this defined, the driver is quiet.
856			The driver doen't show link status messages.
857
858		CONFIG_DRIVER_LAN91C96
859		Support for SMSC's LAN91C96 chips.
860
861			CONFIG_LAN91C96_BASE
862			Define this to hold the physical address
863			of the LAN91C96's I/O space
864
865			CONFIG_LAN91C96_USE_32_BIT
866			Define this to enable 32 bit addressing
867
868		CONFIG_DRIVER_SMC91111
869		Support for SMSC's LAN91C111 chip
870
871			CONFIG_SMC91111_BASE
872			Define this to hold the physical address
873			of the device (I/O space)
874
875			CONFIG_SMC_USE_32_BIT
876			Define this if data bus is 32 bits
877
878			CONFIG_SMC_USE_IOFUNCS
879			Define this to use i/o functions instead of macros
880			(some hardware wont work with macros)
881
882		CONFIG_SMC911X
883		Support for SMSC's LAN911x and LAN921x chips
884
885			CONFIG_SMC911X_BASE
886			Define this to hold the physical address
887			of the device (I/O space)
888
889			CONFIG_SMC911X_32_BIT
890			Define this if data bus is 32 bits
891
892			CONFIG_SMC911X_16_BIT
893			Define this if data bus is 16 bits. If your processor
894			automatically converts one 32 bit word to two 16 bit
895			words you may also try CONFIG_SMC911X_32_BIT.
896
897- USB Support:
898		At the moment only the UHCI host controller is
899		supported (PIP405, MIP405, MPC5200); define
900		CONFIG_USB_UHCI to enable it.
901		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
902		and define CONFIG_USB_STORAGE to enable the USB
903		storage devices.
904		Note:
905		Supported are USB Keyboards and USB Floppy drives
906		(TEAC FD-05PUB).
907		MPC5200 USB requires additional defines:
908			CONFIG_USB_CLOCK
909				for 528 MHz Clock: 0x0001bbbb
910			CONFIG_PSC3_USB
911				for USB on PSC3
912			CONFIG_USB_CONFIG
913				for differential drivers: 0x00001000
914				for single ended drivers: 0x00005000
915				for differential drivers on PSC3: 0x00000100
916				for single ended drivers on PSC3: 0x00004100
917			CONFIG_SYS_USB_EVENT_POLL
918				May be defined to allow interrupt polling
919				instead of using asynchronous interrupts
920
921- USB Device:
922		Define the below if you wish to use the USB console.
923		Once firmware is rebuilt from a serial console issue the
924		command "setenv stdin usbtty; setenv stdout usbtty" and
925		attach your USB cable. The Unix command "dmesg" should print
926		it has found a new device. The environment variable usbtty
927		can be set to gserial or cdc_acm to enable your device to
928		appear to a USB host as a Linux gserial device or a
929		Common Device Class Abstract Control Model serial device.
930		If you select usbtty = gserial you should be able to enumerate
931		a Linux host by
932		# modprobe usbserial vendor=0xVendorID product=0xProductID
933		else if using cdc_acm, simply setting the environment
934		variable usbtty to be cdc_acm should suffice. The following
935		might be defined in YourBoardName.h
936
937			CONFIG_USB_DEVICE
938			Define this to build a UDC device
939
940			CONFIG_USB_TTY
941			Define this to have a tty type of device available to
942			talk to the UDC device
943
944			CONFIG_SYS_CONSOLE_IS_IN_ENV
945			Define this if you want stdin, stdout &/or stderr to
946			be set to usbtty.
947
948			mpc8xx:
949				CONFIG_SYS_USB_EXTC_CLK 0xBLAH
950				Derive USB clock from external clock "blah"
951				- CONFIG_SYS_USB_EXTC_CLK 0x02
952
953				CONFIG_SYS_USB_BRG_CLK 0xBLAH
954				Derive USB clock from brgclk
955				- CONFIG_SYS_USB_BRG_CLK 0x04
956
957		If you have a USB-IF assigned VendorID then you may wish to
958		define your own vendor specific values either in BoardName.h
959		or directly in usbd_vendor_info.h. If you don't define
960		CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
961		CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
962		should pretend to be a Linux device to it's target host.
963
964			CONFIG_USBD_MANUFACTURER
965			Define this string as the name of your company for
966			- CONFIG_USBD_MANUFACTURER "my company"
967
968			CONFIG_USBD_PRODUCT_NAME
969			Define this string as the name of your product
970			- CONFIG_USBD_PRODUCT_NAME "acme usb device"
971
972			CONFIG_USBD_VENDORID
973			Define this as your assigned Vendor ID from the USB
974			Implementors Forum. This *must* be a genuine Vendor ID
975			to avoid polluting the USB namespace.
976			- CONFIG_USBD_VENDORID 0xFFFF
977
978			CONFIG_USBD_PRODUCTID
979			Define this as the unique Product ID
980			for your device
981			- CONFIG_USBD_PRODUCTID 0xFFFF
982
983
984- MMC Support:
985		The MMC controller on the Intel PXA is supported. To
986		enable this define CONFIG_MMC. The MMC can be
987		accessed from the boot prompt by mapping the device
988		to physical memory similar to flash. Command line is
989		enabled with CONFIG_CMD_MMC. The MMC driver also works with
990		the FAT fs. This is enabled with CONFIG_CMD_FAT.
991
992- Journaling Flash filesystem support:
993		CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
994		CONFIG_JFFS2_NAND_DEV
995		Define these for a default partition on a NAND device
996
997		CONFIG_SYS_JFFS2_FIRST_SECTOR,
998		CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
999		Define these for a default partition on a NOR device
1000
1001		CONFIG_SYS_JFFS_CUSTOM_PART
1002		Define this to create an own partition. You have to provide a
1003		function struct part_info* jffs2_part_info(int part_num)
1004
1005		If you define only one JFFS2 partition you may also want to
1006		#define CONFIG_SYS_JFFS_SINGLE_PART	1
1007		to disable the command chpart. This is the default when you
1008		have not defined a custom partition
1009
1010- Keyboard Support:
1011		CONFIG_ISA_KEYBOARD
1012
1013		Define this to enable standard (PC-Style) keyboard
1014		support
1015
1016		CONFIG_I8042_KBD
1017		Standard PC keyboard driver with US (is default) and
1018		GERMAN key layout (switch via environment 'keymap=de') support.
1019		Export function i8042_kbd_init, i8042_tstc and i8042_getc
1020		for cfb_console. Supports cursor blinking.
1021
1022- Video support:
1023		CONFIG_VIDEO
1024
1025		Define this to enable video support (for output to
1026		video).
1027
1028		CONFIG_VIDEO_CT69000
1029
1030		Enable Chips & Technologies 69000 Video chip
1031
1032		CONFIG_VIDEO_SMI_LYNXEM
1033		Enable Silicon Motion SMI 712/710/810 Video chip. The
1034		video output is selected via environment 'videoout'
1035		(1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1036		assumed.
1037
1038		For the CT69000 and SMI_LYNXEM drivers, videomode is
1039		selected via environment 'videomode'. Two different ways
1040		are possible:
1041		- "videomode=num"   'num' is a standard LiLo mode numbers.
1042		Following standard modes are supported	(* is default):
1043
1044		      Colors	640x480 800x600 1024x768 1152x864 1280x1024
1045		-------------+---------------------------------------------
1046		      8 bits |	0x301*	0x303	 0x305	  0x161	    0x307
1047		     15 bits |	0x310	0x313	 0x316	  0x162	    0x319
1048		     16 bits |	0x311	0x314	 0x317	  0x163	    0x31A
1049		     24 bits |	0x312	0x315	 0x318	    ?	    0x31B
1050		-------------+---------------------------------------------
1051		(i.e. setenv videomode 317; saveenv; reset;)
1052
1053		- "videomode=bootargs" all the video parameters are parsed
1054		from the bootargs. (See drivers/video/videomodes.c)
1055
1056
1057		CONFIG_VIDEO_SED13806
1058		Enable Epson SED13806 driver. This driver supports 8bpp
1059		and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1060		or CONFIG_VIDEO_SED13806_16BPP
1061
1062- Keyboard Support:
1063		CONFIG_KEYBOARD
1064
1065		Define this to enable a custom keyboard support.
1066		This simply calls drv_keyboard_init() which must be
1067		defined in your board-specific files.
1068		The only board using this so far is RBC823.
1069
1070- LCD Support:	CONFIG_LCD
1071
1072		Define this to enable LCD support (for output to LCD
1073		display); also select one of the supported displays
1074		by defining one of these:
1075
1076		CONFIG_ATMEL_LCD:
1077
1078			HITACHI TX09D70VM1CCA, 3.5", 240x320.
1079
1080		CONFIG_NEC_NL6448AC33:
1081
1082			NEC NL6448AC33-18. Active, color, single scan.
1083
1084		CONFIG_NEC_NL6448BC20
1085
1086			NEC NL6448BC20-08. 6.5", 640x480.
1087			Active, color, single scan.
1088
1089		CONFIG_NEC_NL6448BC33_54
1090
1091			NEC NL6448BC33-54. 10.4", 640x480.
1092			Active, color, single scan.
1093
1094		CONFIG_SHARP_16x9
1095
1096			Sharp 320x240. Active, color, single scan.
1097			It isn't 16x9, and I am not sure what it is.
1098
1099		CONFIG_SHARP_LQ64D341
1100
1101			Sharp LQ64D341 display, 640x480.
1102			Active, color, single scan.
1103
1104		CONFIG_HLD1045
1105
1106			HLD1045 display, 640x480.
1107			Active, color, single scan.
1108
1109		CONFIG_OPTREX_BW
1110
1111			Optrex	 CBL50840-2 NF-FW 99 22 M5
1112			or
1113			Hitachi	 LMG6912RPFC-00T
1114			or
1115			Hitachi	 SP14Q002
1116
1117			320x240. Black & white.
1118
1119		Normally display is black on white background; define
1120		CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
1121
1122- Splash Screen Support: CONFIG_SPLASH_SCREEN
1123
1124		If this option is set, the environment is checked for
1125		a variable "splashimage". If found, the usual display
1126		of logo, copyright and system information on the LCD
1127		is suppressed and the BMP image at the address
1128		specified in "splashimage" is loaded instead. The
1129		console is redirected to the "nulldev", too. This
1130		allows for a "silent" boot where a splash screen is
1131		loaded very quickly after power-on.
1132
1133		CONFIG_SPLASH_SCREEN_ALIGN
1134
1135		If this option is set the splash image can be freely positioned
1136		on the screen. Environment variable "splashpos" specifies the
1137		position as "x,y". If a positive number is given it is used as
1138		number of pixel from left/top. If a negative number is given it
1139		is used as number of pixel from right/bottom. You can also
1140		specify 'm' for centering the image.
1141
1142		Example:
1143		setenv splashpos m,m
1144			=> image at center of screen
1145
1146		setenv splashpos 30,20
1147			=> image at x = 30 and y = 20
1148
1149		setenv splashpos -10,m
1150			=> vertically centered image
1151			   at x = dspWidth - bmpWidth - 9
1152
1153- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1154
1155		If this option is set, additionally to standard BMP
1156		images, gzipped BMP images can be displayed via the
1157		splashscreen support or the bmp command.
1158
1159- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1160
1161		If this option is set, 8-bit RLE compressed BMP images
1162		can be displayed via the splashscreen support or the
1163		bmp command.
1164
1165- Compression support:
1166		CONFIG_BZIP2
1167
1168		If this option is set, support for bzip2 compressed
1169		images is included. If not, only uncompressed and gzip
1170		compressed images are supported.
1171
1172		NOTE: the bzip2 algorithm requires a lot of RAM, so
1173		the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
1174		be at least 4MB.
1175
1176		CONFIG_LZMA
1177
1178		If this option is set, support for lzma compressed
1179		images is included.
1180
1181		Note: The LZMA algorithm adds between 2 and 4KB of code and it
1182		requires an amount of dynamic memory that is given by the
1183		formula:
1184
1185			(1846 + 768 << (lc + lp)) * sizeof(uint16)
1186
1187		Where lc and lp stand for, respectively, Literal context bits
1188		and Literal pos bits.
1189
1190		This value is upper-bounded by 14MB in the worst case. Anyway,
1191		for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1192		total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1193		a very small buffer.
1194
1195		Use the lzmainfo tool to determinate the lc and lp values and
1196		then calculate the amount of needed dynamic memory (ensuring
1197		the appropriate CONFIG_SYS_MALLOC_LEN value).
1198
1199- MII/PHY support:
1200		CONFIG_PHY_ADDR
1201
1202		The address of PHY on MII bus.
1203
1204		CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1205
1206		The clock frequency of the MII bus
1207
1208		CONFIG_PHY_GIGE
1209
1210		If this option is set, support for speed/duplex
1211		detection of gigabit PHY is included.
1212
1213		CONFIG_PHY_RESET_DELAY
1214
1215		Some PHY like Intel LXT971A need extra delay after
1216		reset before any MII register access is possible.
1217		For such PHY, set this option to the usec delay
1218		required. (minimum 300usec for LXT971A)
1219
1220		CONFIG_PHY_CMD_DELAY (ppc4xx)
1221
1222		Some PHY like Intel LXT971A need extra delay after
1223		command issued before MII status register can be read
1224
1225- Ethernet address:
1226		CONFIG_ETHADDR
1227		CONFIG_ETH1ADDR
1228		CONFIG_ETH2ADDR
1229		CONFIG_ETH3ADDR
1230		CONFIG_ETH4ADDR
1231		CONFIG_ETH5ADDR
1232
1233		Define a default value for Ethernet address to use
1234		for the respective Ethernet interface, in case this
1235		is not determined automatically.
1236
1237- IP address:
1238		CONFIG_IPADDR
1239
1240		Define a default value for the IP address to use for
1241		the default Ethernet interface, in case this is not
1242		determined through e.g. bootp.
1243
1244- Server IP address:
1245		CONFIG_SERVERIP
1246
1247		Defines a default value for the IP address of a TFTP
1248		server to contact when using the "tftboot" command.
1249
1250		CONFIG_KEEP_SERVERADDR
1251
1252		Keeps the server's MAC address, in the env 'serveraddr'
1253		for passing to bootargs (like Linux's netconsole option)
1254
1255- Multicast TFTP Mode:
1256		CONFIG_MCAST_TFTP
1257
1258		Defines whether you want to support multicast TFTP as per
1259		rfc-2090; for example to work with atftp.  Lets lots of targets
1260		tftp down the same boot image concurrently.  Note: the Ethernet
1261		driver in use must provide a function: mcast() to join/leave a
1262		multicast group.
1263
1264		CONFIG_BOOTP_RANDOM_DELAY
1265- BOOTP Recovery Mode:
1266		CONFIG_BOOTP_RANDOM_DELAY
1267
1268		If you have many targets in a network that try to
1269		boot using BOOTP, you may want to avoid that all
1270		systems send out BOOTP requests at precisely the same
1271		moment (which would happen for instance at recovery
1272		from a power failure, when all systems will try to
1273		boot, thus flooding the BOOTP server. Defining
1274		CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1275		inserted before sending out BOOTP requests. The
1276		following delays are inserted then:
1277
1278		1st BOOTP request:	delay 0 ... 1 sec
1279		2nd BOOTP request:	delay 0 ... 2 sec
1280		3rd BOOTP request:	delay 0 ... 4 sec
1281		4th and following
1282		BOOTP requests:		delay 0 ... 8 sec
1283
1284- DHCP Advanced Options:
1285		You can fine tune the DHCP functionality by defining
1286		CONFIG_BOOTP_* symbols:
1287
1288		CONFIG_BOOTP_SUBNETMASK
1289		CONFIG_BOOTP_GATEWAY
1290		CONFIG_BOOTP_HOSTNAME
1291		CONFIG_BOOTP_NISDOMAIN
1292		CONFIG_BOOTP_BOOTPATH
1293		CONFIG_BOOTP_BOOTFILESIZE
1294		CONFIG_BOOTP_DNS
1295		CONFIG_BOOTP_DNS2
1296		CONFIG_BOOTP_SEND_HOSTNAME
1297		CONFIG_BOOTP_NTPSERVER
1298		CONFIG_BOOTP_TIMEOFFSET
1299		CONFIG_BOOTP_VENDOREX
1300
1301		CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1302		environment variable, not the BOOTP server.
1303
1304		CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1305		serverip from a DHCP server, it is possible that more
1306		than one DNS serverip is offered to the client.
1307		If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1308		serverip will be stored in the additional environment
1309		variable "dnsip2". The first DNS serverip is always
1310		stored in the variable "dnsip", when CONFIG_BOOTP_DNS
1311		is defined.
1312
1313		CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1314		to do a dynamic update of a DNS server. To do this, they
1315		need the hostname of the DHCP requester.
1316		If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
1317		of the "hostname" environment variable is passed as
1318		option 12 to the DHCP server.
1319
1320		CONFIG_BOOTP_DHCP_REQUEST_DELAY
1321
1322		A 32bit value in microseconds for a delay between
1323		receiving a "DHCP Offer" and sending the "DHCP Request".
1324		This fixes a problem with certain DHCP servers that don't
1325		respond 100% of the time to a "DHCP request". E.g. On an
1326		AT91RM9200 processor running at 180MHz, this delay needed
1327		to be *at least* 15,000 usec before a Windows Server 2003
1328		DHCP server would reply 100% of the time. I recommend at
1329		least 50,000 usec to be safe. The alternative is to hope
1330		that one of the retries will be successful but note that
1331		the DHCP timeout and retry process takes a longer than
1332		this delay.
1333
1334 - CDP Options:
1335		CONFIG_CDP_DEVICE_ID
1336
1337		The device id used in CDP trigger frames.
1338
1339		CONFIG_CDP_DEVICE_ID_PREFIX
1340
1341		A two character string which is prefixed to the MAC address
1342		of the device.
1343
1344		CONFIG_CDP_PORT_ID
1345
1346		A printf format string which contains the ascii name of
1347		the port. Normally is set to "eth%d" which sets
1348		eth0 for the first Ethernet, eth1 for the second etc.
1349
1350		CONFIG_CDP_CAPABILITIES
1351
1352		A 32bit integer which indicates the device capabilities;
1353		0x00000010 for a normal host which does not forwards.
1354
1355		CONFIG_CDP_VERSION
1356
1357		An ascii string containing the version of the software.
1358
1359		CONFIG_CDP_PLATFORM
1360
1361		An ascii string containing the name of the platform.
1362
1363		CONFIG_CDP_TRIGGER
1364
1365		A 32bit integer sent on the trigger.
1366
1367		CONFIG_CDP_POWER_CONSUMPTION
1368
1369		A 16bit integer containing the power consumption of the
1370		device in .1 of milliwatts.
1371
1372		CONFIG_CDP_APPLIANCE_VLAN_TYPE
1373
1374		A byte containing the id of the VLAN.
1375
1376- Status LED:	CONFIG_STATUS_LED
1377
1378		Several configurations allow to display the current
1379		status using a LED. For instance, the LED will blink
1380		fast while running U-Boot code, stop blinking as
1381		soon as a reply to a BOOTP request was received, and
1382		start blinking slow once the Linux kernel is running
1383		(supported by a status LED driver in the Linux
1384		kernel). Defining CONFIG_STATUS_LED enables this
1385		feature in U-Boot.
1386
1387- CAN Support:	CONFIG_CAN_DRIVER
1388
1389		Defining CONFIG_CAN_DRIVER enables CAN driver support
1390		on those systems that support this (optional)
1391		feature, like the TQM8xxL modules.
1392
1393- I2C Support:	CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1394
1395		These enable I2C serial bus commands. Defining either of
1396		(but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
1397		include the appropriate I2C driver for the selected CPU.
1398
1399		This will allow you to use i2c commands at the u-boot
1400		command line (as long as you set CONFIG_CMD_I2C in
1401		CONFIG_COMMANDS) and communicate with i2c based realtime
1402		clock chips. See common/cmd_i2c.c for a description of the
1403		command line interface.
1404
1405		CONFIG_HARD_I2C selects a hardware I2C controller.
1406
1407		CONFIG_SOFT_I2C configures u-boot to use a software (aka
1408		bit-banging) driver instead of CPM or similar hardware
1409		support for I2C.
1410
1411		There are several other quantities that must also be
1412		defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
1413
1414		In both cases you will need to define CONFIG_SYS_I2C_SPEED
1415		to be the frequency (in Hz) at which you wish your i2c bus
1416		to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
1417		the CPU's i2c node address).
1418
1419		Now, the u-boot i2c code for the mpc8xx
1420		(arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
1421		and so its address should therefore be cleared to 0 (See,
1422		eg, MPC823e User's Manual p.16-473). So, set
1423		CONFIG_SYS_I2C_SLAVE to 0.
1424
1425		CONFIG_SYS_I2C_INIT_MPC5XXX
1426
1427		When a board is reset during an i2c bus transfer
1428		chips might think that the current transfer is still
1429		in progress.  Reset the slave devices by sending start
1430		commands until the slave device responds.
1431
1432		That's all that's required for CONFIG_HARD_I2C.
1433
1434		If you use the software i2c interface (CONFIG_SOFT_I2C)
1435		then the following macros need to be defined (examples are
1436		from include/configs/lwmon.h):
1437
1438		I2C_INIT
1439
1440		(Optional). Any commands necessary to enable the I2C
1441		controller or configure ports.
1442
1443		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
1444
1445		I2C_PORT
1446
1447		(Only for MPC8260 CPU). The I/O port to use (the code
1448		assumes both bits are on the same port). Valid values
1449		are 0..3 for ports A..D.
1450
1451		I2C_ACTIVE
1452
1453		The code necessary to make the I2C data line active
1454		(driven).  If the data line is open collector, this
1455		define can be null.
1456
1457		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
1458
1459		I2C_TRISTATE
1460
1461		The code necessary to make the I2C data line tri-stated
1462		(inactive).  If the data line is open collector, this
1463		define can be null.
1464
1465		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1466
1467		I2C_READ
1468
1469		Code that returns TRUE if the I2C data line is high,
1470		FALSE if it is low.
1471
1472		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1473
1474		I2C_SDA(bit)
1475
1476		If <bit> is TRUE, sets the I2C data line high. If it
1477		is FALSE, it clears it (low).
1478
1479		eg: #define I2C_SDA(bit) \
1480			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
1481			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
1482
1483		I2C_SCL(bit)
1484
1485		If <bit> is TRUE, sets the I2C clock line high. If it
1486		is FALSE, it clears it (low).
1487
1488		eg: #define I2C_SCL(bit) \
1489			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
1490			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
1491
1492		I2C_DELAY
1493
1494		This delay is invoked four times per clock cycle so this
1495		controls the rate of data transfer.  The data rate thus
1496		is 1 / (I2C_DELAY * 4). Often defined to be something
1497		like:
1498
1499		#define I2C_DELAY  udelay(2)
1500
1501		CONFIG_SYS_I2C_INIT_BOARD
1502
1503		When a board is reset during an i2c bus transfer
1504		chips might think that the current transfer is still
1505		in progress. On some boards it is possible to access
1506		the i2c SCLK line directly, either by using the
1507		processor pin as a GPIO or by having a second pin
1508		connected to the bus. If this option is defined a
1509		custom i2c_init_board() routine in boards/xxx/board.c
1510		is run early in the boot sequence.
1511
1512		CONFIG_SYS_I2C_BOARD_LATE_INIT
1513
1514		An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
1515		defined a custom i2c_board_late_init() routine in
1516		boards/xxx/board.c is run AFTER the operations in i2c_init()
1517		is completed. This callpoint can be used to unreset i2c bus
1518		using CPU i2c controller register accesses for CPUs whose i2c
1519		controller provide such a method. It is called at the end of
1520		i2c_init() to allow i2c_init operations to setup the i2c bus
1521		controller on the CPU (e.g. setting bus speed & slave address).
1522
1523		CONFIG_I2CFAST (PPC405GP|PPC405EP only)
1524
1525		This option enables configuration of bi_iic_fast[] flags
1526		in u-boot bd_info structure based on u-boot environment
1527		variable "i2cfast". (see also i2cfast)
1528
1529		CONFIG_I2C_MULTI_BUS
1530
1531		This option allows the use of multiple I2C buses, each of which
1532		must have a controller.  At any point in time, only one bus is
1533		active.  To switch to a different bus, use the 'i2c dev' command.
1534		Note that bus numbering is zero-based.
1535
1536		CONFIG_SYS_I2C_NOPROBES
1537
1538		This option specifies a list of I2C devices that will be skipped
1539		when the 'i2c probe' command is issued.  If CONFIG_I2C_MULTI_BUS
1540		is set, specify a list of bus-device pairs.  Otherwise, specify
1541		a 1D array of device addresses
1542
1543		e.g.
1544			#undef	CONFIG_I2C_MULTI_BUS
1545			#define CONFIG_SYS_I2C_NOPROBES	{0x50,0x68}
1546
1547		will skip addresses 0x50 and 0x68 on a board with one I2C bus
1548
1549			#define	CONFIG_I2C_MULTI_BUS
1550			#define CONFIG_SYS_I2C_MULTI_NOPROBES	{{0,0x50},{0,0x68},{1,0x54}}
1551
1552		will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1553
1554		CONFIG_SYS_SPD_BUS_NUM
1555
1556		If defined, then this indicates the I2C bus number for DDR SPD.
1557		If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1558
1559		CONFIG_SYS_RTC_BUS_NUM
1560
1561		If defined, then this indicates the I2C bus number for the RTC.
1562		If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1563
1564		CONFIG_SYS_DTT_BUS_NUM
1565
1566		If defined, then this indicates the I2C bus number for the DTT.
1567		If not defined, then U-Boot assumes that DTT is on I2C bus 0.
1568
1569		CONFIG_SYS_I2C_DTT_ADDR:
1570
1571		If defined, specifies the I2C address of the DTT device.
1572		If not defined, then U-Boot uses predefined value for
1573		specified DTT device.
1574
1575		CONFIG_FSL_I2C
1576
1577		Define this option if you want to use Freescale's I2C driver in
1578		drivers/i2c/fsl_i2c.c.
1579
1580		CONFIG_I2C_MUX
1581
1582		Define this option if you have I2C devices reached over 1 .. n
1583		I2C Muxes like the pca9544a. This option addes a new I2C
1584		Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
1585		new I2C Bus to the existing I2C Busses. If you select the
1586		new Bus with "i2c dev", u-bbot sends first the commandos for
1587		the muxes to activate this new "bus".
1588
1589		CONFIG_I2C_MULTI_BUS must be also defined, to use this
1590		feature!
1591
1592		Example:
1593		Adding a new I2C Bus reached over 2 pca9544a muxes
1594			The First mux with address 70 and channel 6
1595			The Second mux with address 71 and channel 4
1596
1597		=> i2c bus pca9544a:70:6:pca9544a:71:4
1598
1599		Use the "i2c bus" command without parameter, to get a list
1600		of I2C Busses with muxes:
1601
1602		=> i2c bus
1603		Busses reached over muxes:
1604		Bus ID: 2
1605		  reached over Mux(es):
1606		    pca9544a@70 ch: 4
1607		Bus ID: 3
1608		  reached over Mux(es):
1609		    pca9544a@70 ch: 6
1610		    pca9544a@71 ch: 4
1611		=>
1612
1613		If you now switch to the new I2C Bus 3 with "i2c dev 3"
1614		u-boot sends First the Commando to the mux@70 to enable
1615		channel 6, and then the Commando to the mux@71 to enable
1616		the channel 4.
1617
1618		After that, you can use the "normal" i2c commands as
1619		usual, to communicate with your I2C devices behind
1620		the 2 muxes.
1621
1622		This option is actually implemented for the bitbanging
1623		algorithm in common/soft_i2c.c and for the Hardware I2C
1624		Bus on the MPC8260. But it should be not so difficult
1625		to add this option to other architectures.
1626
1627		CONFIG_SOFT_I2C_READ_REPEATED_START
1628
1629		defining this will force the i2c_read() function in
1630		the soft_i2c driver to perform an I2C repeated start
1631		between writing the address pointer and reading the
1632		data.  If this define is omitted the default behaviour
1633		of doing a stop-start sequence will be used.  Most I2C
1634		devices can use either method, but some require one or
1635		the other.
1636
1637- SPI Support:	CONFIG_SPI
1638
1639		Enables SPI driver (so far only tested with
1640		SPI EEPROM, also an instance works with Crystal A/D and
1641		D/As on the SACSng board)
1642
1643		CONFIG_SPI_X
1644
1645		Enables extended (16-bit) SPI EEPROM addressing.
1646		(symmetrical to CONFIG_I2C_X)
1647
1648		CONFIG_SOFT_SPI
1649
1650		Enables a software (bit-bang) SPI driver rather than
1651		using hardware support. This is a general purpose
1652		driver that only requires three general I/O port pins
1653		(two outputs, one input) to function. If this is
1654		defined, the board configuration must define several
1655		SPI configuration items (port pins to use, etc). For
1656		an example, see include/configs/sacsng.h.
1657
1658		CONFIG_HARD_SPI
1659
1660		Enables a hardware SPI driver for general-purpose reads
1661		and writes.  As with CONFIG_SOFT_SPI, the board configuration
1662		must define a list of chip-select function pointers.
1663		Currently supported on some MPC8xxx processors.  For an
1664		example, see include/configs/mpc8349emds.h.
1665
1666		CONFIG_MXC_SPI
1667
1668		Enables the driver for the SPI controllers on i.MX and MXC
1669		SoCs. Currently only i.MX31 is supported.
1670
1671- FPGA Support: CONFIG_FPGA
1672
1673		Enables FPGA subsystem.
1674
1675		CONFIG_FPGA_<vendor>
1676
1677		Enables support for specific chip vendors.
1678		(ALTERA, XILINX)
1679
1680		CONFIG_FPGA_<family>
1681
1682		Enables support for FPGA family.
1683		(SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
1684
1685		CONFIG_FPGA_COUNT
1686
1687		Specify the number of FPGA devices to support.
1688
1689		CONFIG_SYS_FPGA_PROG_FEEDBACK
1690
1691		Enable printing of hash marks during FPGA configuration.
1692
1693		CONFIG_SYS_FPGA_CHECK_BUSY
1694
1695		Enable checks on FPGA configuration interface busy
1696		status by the configuration function. This option
1697		will require a board or device specific function to
1698		be written.
1699
1700		CONFIG_FPGA_DELAY
1701
1702		If defined, a function that provides delays in the FPGA
1703		configuration driver.
1704
1705		CONFIG_SYS_FPGA_CHECK_CTRLC
1706		Allow Control-C to interrupt FPGA configuration
1707
1708		CONFIG_SYS_FPGA_CHECK_ERROR
1709
1710		Check for configuration errors during FPGA bitfile
1711		loading. For example, abort during Virtex II
1712		configuration if the INIT_B line goes low (which
1713		indicated a CRC error).
1714
1715		CONFIG_SYS_FPGA_WAIT_INIT
1716
1717		Maximum time to wait for the INIT_B line to deassert
1718		after PROB_B has been deasserted during a Virtex II
1719		FPGA configuration sequence. The default time is 500
1720		ms.
1721
1722		CONFIG_SYS_FPGA_WAIT_BUSY
1723
1724		Maximum time to wait for BUSY to deassert during
1725		Virtex II FPGA configuration. The default is 5 ms.
1726
1727		CONFIG_SYS_FPGA_WAIT_CONFIG
1728
1729		Time to wait after FPGA configuration. The default is
1730		200 ms.
1731
1732- Configuration Management:
1733		CONFIG_IDENT_STRING
1734
1735		If defined, this string will be added to the U-Boot
1736		version information (U_BOOT_VERSION)
1737
1738- Vendor Parameter Protection:
1739
1740		U-Boot considers the values of the environment
1741		variables "serial#" (Board Serial Number) and
1742		"ethaddr" (Ethernet Address) to be parameters that
1743		are set once by the board vendor / manufacturer, and
1744		protects these variables from casual modification by
1745		the user. Once set, these variables are read-only,
1746		and write or delete attempts are rejected. You can
1747		change this behaviour:
1748
1749		If CONFIG_ENV_OVERWRITE is #defined in your config
1750		file, the write protection for vendor parameters is
1751		completely disabled. Anybody can change or delete
1752		these parameters.
1753
1754		Alternatively, if you #define _both_ CONFIG_ETHADDR
1755		_and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
1756		Ethernet address is installed in the environment,
1757		which can be changed exactly ONCE by the user. [The
1758		serial# is unaffected by this, i. e. it remains
1759		read-only.]
1760
1761- Protected RAM:
1762		CONFIG_PRAM
1763
1764		Define this variable to enable the reservation of
1765		"protected RAM", i. e. RAM which is not overwritten
1766		by U-Boot. Define CONFIG_PRAM to hold the number of
1767		kB you want to reserve for pRAM. You can overwrite
1768		this default value by defining an environment
1769		variable "pram" to the number of kB you want to
1770		reserve. Note that the board info structure will
1771		still show the full amount of RAM. If pRAM is
1772		reserved, a new environment variable "mem" will
1773		automatically be defined to hold the amount of
1774		remaining RAM in a form that can be passed as boot
1775		argument to Linux, for instance like that:
1776
1777			setenv bootargs ... mem=\${mem}
1778			saveenv
1779
1780		This way you can tell Linux not to use this memory,
1781		either, which results in a memory region that will
1782		not be affected by reboots.
1783
1784		*WARNING* If your board configuration uses automatic
1785		detection of the RAM size, you must make sure that
1786		this memory test is non-destructive. So far, the
1787		following board configurations are known to be
1788		"pRAM-clean":
1789
1790			ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
1791			HERMES, IP860, RPXlite, LWMON, LANTEC,
1792			PCU_E, FLAGADM, TQM8260
1793
1794- Error Recovery:
1795		CONFIG_PANIC_HANG
1796
1797		Define this variable to stop the system in case of a
1798		fatal error, so that you have to reset it manually.
1799		This is probably NOT a good idea for an embedded
1800		system where you want the system to reboot
1801		automatically as fast as possible, but it may be
1802		useful during development since you can try to debug
1803		the conditions that lead to the situation.
1804
1805		CONFIG_NET_RETRY_COUNT
1806
1807		This variable defines the number of retries for
1808		network operations like ARP, RARP, TFTP, or BOOTP
1809		before giving up the operation. If not defined, a
1810		default value of 5 is used.
1811
1812		CONFIG_ARP_TIMEOUT
1813
1814		Timeout waiting for an ARP reply in milliseconds.
1815
1816- Command Interpreter:
1817		CONFIG_AUTO_COMPLETE
1818
1819		Enable auto completion of commands using TAB.
1820
1821		Note that this feature has NOT been implemented yet
1822		for the "hush" shell.
1823
1824
1825		CONFIG_SYS_HUSH_PARSER
1826
1827		Define this variable to enable the "hush" shell (from
1828		Busybox) as command line interpreter, thus enabling
1829		powerful command line syntax like
1830		if...then...else...fi conditionals or `&&' and '||'
1831		constructs ("shell scripts").
1832
1833		If undefined, you get the old, much simpler behaviour
1834		with a somewhat smaller memory footprint.
1835
1836
1837		CONFIG_SYS_PROMPT_HUSH_PS2
1838
1839		This defines the secondary prompt string, which is
1840		printed when the command interpreter needs more input
1841		to complete a command. Usually "> ".
1842
1843	Note:
1844
1845		In the current implementation, the local variables
1846		space and global environment variables space are
1847		separated. Local variables are those you define by
1848		simply typing `name=value'. To access a local
1849		variable later on, you have write `$name' or
1850		`${name}'; to execute the contents of a variable
1851		directly type `$name' at the command prompt.
1852
1853		Global environment variables are those you use
1854		setenv/printenv to work with. To run a command stored
1855		in such a variable, you need to use the run command,
1856		and you must not use the '$' sign to access them.
1857
1858		To store commands and special characters in a
1859		variable, please use double quotation marks
1860		surrounding the whole text of the variable, instead
1861		of the backslashes before semicolons and special
1862		symbols.
1863
1864- Commandline Editing and History:
1865		CONFIG_CMDLINE_EDITING
1866
1867		Enable editing and History functions for interactive
1868		commandline input operations
1869
1870- Default Environment:
1871		CONFIG_EXTRA_ENV_SETTINGS
1872
1873		Define this to contain any number of null terminated
1874		strings (variable = value pairs) that will be part of
1875		the default environment compiled into the boot image.
1876
1877		For example, place something like this in your
1878		board's config file:
1879
1880		#define CONFIG_EXTRA_ENV_SETTINGS \
1881			"myvar1=value1\0" \
1882			"myvar2=value2\0"
1883
1884		Warning: This method is based on knowledge about the
1885		internal format how the environment is stored by the
1886		U-Boot code. This is NOT an official, exported
1887		interface! Although it is unlikely that this format
1888		will change soon, there is no guarantee either.
1889		You better know what you are doing here.
1890
1891		Note: overly (ab)use of the default environment is
1892		discouraged. Make sure to check other ways to preset
1893		the environment like the "source" command or the
1894		boot command first.
1895
1896- DataFlash Support:
1897		CONFIG_HAS_DATAFLASH
1898
1899		Defining this option enables DataFlash features and
1900		allows to read/write in Dataflash via the standard
1901		commands cp, md...
1902
1903- SystemACE Support:
1904		CONFIG_SYSTEMACE
1905
1906		Adding this option adds support for Xilinx SystemACE
1907		chips attached via some sort of local bus. The address
1908		of the chip must also be defined in the
1909		CONFIG_SYS_SYSTEMACE_BASE macro. For example:
1910
1911		#define CONFIG_SYSTEMACE
1912		#define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
1913
1914		When SystemACE support is added, the "ace" device type
1915		becomes available to the fat commands, i.e. fatls.
1916
1917- TFTP Fixed UDP Port:
1918		CONFIG_TFTP_PORT
1919
1920		If this is defined, the environment variable tftpsrcp
1921		is used to supply the TFTP UDP source port value.
1922		If tftpsrcp isn't defined, the normal pseudo-random port
1923		number generator is used.
1924
1925		Also, the environment variable tftpdstp is used to supply
1926		the TFTP UDP destination port value.  If tftpdstp isn't
1927		defined, the normal port 69 is used.
1928
1929		The purpose for tftpsrcp is to allow a TFTP server to
1930		blindly start the TFTP transfer using the pre-configured
1931		target IP address and UDP port. This has the effect of
1932		"punching through" the (Windows XP) firewall, allowing
1933		the remainder of the TFTP transfer to proceed normally.
1934		A better solution is to properly configure the firewall,
1935		but sometimes that is not allowed.
1936
1937- Show boot progress:
1938		CONFIG_SHOW_BOOT_PROGRESS
1939
1940		Defining this option allows to add some board-
1941		specific code (calling a user-provided function
1942		"show_boot_progress(int)") that enables you to show
1943		the system's boot progress on some display (for
1944		example, some LED's) on your board. At the moment,
1945		the following checkpoints are implemented:
1946
1947Legacy uImage format:
1948
1949  Arg	Where			When
1950    1	common/cmd_bootm.c	before attempting to boot an image
1951   -1	common/cmd_bootm.c	Image header has bad	 magic number
1952    2	common/cmd_bootm.c	Image header has correct magic number
1953   -2	common/cmd_bootm.c	Image header has bad	 checksum
1954    3	common/cmd_bootm.c	Image header has correct checksum
1955   -3	common/cmd_bootm.c	Image data   has bad	 checksum
1956    4	common/cmd_bootm.c	Image data   has correct checksum
1957   -4	common/cmd_bootm.c	Image is for unsupported architecture
1958    5	common/cmd_bootm.c	Architecture check OK
1959   -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi)
1960    6	common/cmd_bootm.c	Image Type check OK
1961   -6	common/cmd_bootm.c	gunzip uncompression error
1962   -7	common/cmd_bootm.c	Unimplemented compression type
1963    7	common/cmd_bootm.c	Uncompression OK
1964    8	common/cmd_bootm.c	No uncompress/copy overwrite error
1965   -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
1966
1967    9	common/image.c		Start initial ramdisk verification
1968  -10	common/image.c		Ramdisk header has bad	   magic number
1969  -11	common/image.c		Ramdisk header has bad	   checksum
1970   10	common/image.c		Ramdisk header is OK
1971  -12	common/image.c		Ramdisk data   has bad	   checksum
1972   11	common/image.c		Ramdisk data   has correct checksum
1973   12	common/image.c		Ramdisk verification complete, start loading
1974  -13	common/image.c		Wrong Image Type (not PPC Linux ramdisk)
1975   13	common/image.c		Start multifile image verification
1976   14	common/image.c		No initial ramdisk, no multifile, continue.
1977
1978   15	arch/<arch>/lib/bootm.c	All preparation done, transferring control to OS
1979
1980  -30	arch/powerpc/lib/board.c	Fatal error, hang the system
1981  -31	post/post.c		POST test failed, detected by post_output_backlog()
1982  -32	post/post.c		POST test failed, detected by post_run_single()
1983
1984   34	common/cmd_doc.c	before loading a Image from a DOC device
1985  -35	common/cmd_doc.c	Bad usage of "doc" command
1986   35	common/cmd_doc.c	correct usage of "doc" command
1987  -36	common/cmd_doc.c	No boot device
1988   36	common/cmd_doc.c	correct boot device
1989  -37	common/cmd_doc.c	Unknown Chip ID on boot device
1990   37	common/cmd_doc.c	correct chip ID found, device available
1991  -38	common/cmd_doc.c	Read Error on boot device
1992   38	common/cmd_doc.c	reading Image header from DOC device OK
1993  -39	common/cmd_doc.c	Image header has bad magic number
1994   39	common/cmd_doc.c	Image header has correct magic number
1995  -40	common/cmd_doc.c	Error reading Image from DOC device
1996   40	common/cmd_doc.c	Image header has correct magic number
1997   41	common/cmd_ide.c	before loading a Image from a IDE device
1998  -42	common/cmd_ide.c	Bad usage of "ide" command
1999   42	common/cmd_ide.c	correct usage of "ide" command
2000  -43	common/cmd_ide.c	No boot device
2001   43	common/cmd_ide.c	boot device found
2002  -44	common/cmd_ide.c	Device not available
2003   44	common/cmd_ide.c	Device available
2004  -45	common/cmd_ide.c	wrong partition selected
2005   45	common/cmd_ide.c	partition selected
2006  -46	common/cmd_ide.c	Unknown partition table
2007   46	common/cmd_ide.c	valid partition table found
2008  -47	common/cmd_ide.c	Invalid partition type
2009   47	common/cmd_ide.c	correct partition type
2010  -48	common/cmd_ide.c	Error reading Image Header on boot device
2011   48	common/cmd_ide.c	reading Image Header from IDE device OK
2012  -49	common/cmd_ide.c	Image header has bad magic number
2013   49	common/cmd_ide.c	Image header has correct magic number
2014  -50	common/cmd_ide.c	Image header has bad	 checksum
2015   50	common/cmd_ide.c	Image header has correct checksum
2016  -51	common/cmd_ide.c	Error reading Image from IDE device
2017   51	common/cmd_ide.c	reading Image from IDE device OK
2018   52	common/cmd_nand.c	before loading a Image from a NAND device
2019  -53	common/cmd_nand.c	Bad usage of "nand" command
2020   53	common/cmd_nand.c	correct usage of "nand" command
2021  -54	common/cmd_nand.c	No boot device
2022   54	common/cmd_nand.c	boot device found
2023  -55	common/cmd_nand.c	Unknown Chip ID on boot device
2024   55	common/cmd_nand.c	correct chip ID found, device available
2025  -56	common/cmd_nand.c	Error reading Image Header on boot device
2026   56	common/cmd_nand.c	reading Image Header from NAND device OK
2027  -57	common/cmd_nand.c	Image header has bad magic number
2028   57	common/cmd_nand.c	Image header has correct magic number
2029  -58	common/cmd_nand.c	Error reading Image from NAND device
2030   58	common/cmd_nand.c	reading Image from NAND device OK
2031
2032  -60	common/env_common.c	Environment has a bad CRC, using default
2033
2034   64	net/eth.c		starting with Ethernet configuration.
2035  -64	net/eth.c		no Ethernet found.
2036   65	net/eth.c		Ethernet found.
2037
2038  -80	common/cmd_net.c	usage wrong
2039   80	common/cmd_net.c	before calling NetLoop()
2040  -81	common/cmd_net.c	some error in NetLoop() occurred
2041   81	common/cmd_net.c	NetLoop() back without error
2042  -82	common/cmd_net.c	size == 0 (File with size 0 loaded)
2043   82	common/cmd_net.c	trying automatic boot
2044   83	common/cmd_net.c	running "source" command
2045  -83	common/cmd_net.c	some error in automatic boot or "source" command
2046   84	common/cmd_net.c	end without errors
2047
2048FIT uImage format:
2049
2050  Arg	Where			When
2051  100	common/cmd_bootm.c	Kernel FIT Image has correct format
2052 -100	common/cmd_bootm.c	Kernel FIT Image has incorrect format
2053  101	common/cmd_bootm.c	No Kernel subimage unit name, using configuration
2054 -101	common/cmd_bootm.c	Can't get configuration for kernel subimage
2055  102	common/cmd_bootm.c	Kernel unit name specified
2056 -103	common/cmd_bootm.c	Can't get kernel subimage node offset
2057  103	common/cmd_bootm.c	Found configuration node
2058  104	common/cmd_bootm.c	Got kernel subimage node offset
2059 -104	common/cmd_bootm.c	Kernel subimage hash verification failed
2060  105	common/cmd_bootm.c	Kernel subimage hash verification OK
2061 -105	common/cmd_bootm.c	Kernel subimage is for unsupported architecture
2062  106	common/cmd_bootm.c	Architecture check OK
2063 -106	common/cmd_bootm.c	Kernel subimage has wrong type
2064  107	common/cmd_bootm.c	Kernel subimage type OK
2065 -107	common/cmd_bootm.c	Can't get kernel subimage data/size
2066  108	common/cmd_bootm.c	Got kernel subimage data/size
2067 -108	common/cmd_bootm.c	Wrong image type (not legacy, FIT)
2068 -109	common/cmd_bootm.c	Can't get kernel subimage type
2069 -110	common/cmd_bootm.c	Can't get kernel subimage comp
2070 -111	common/cmd_bootm.c	Can't get kernel subimage os
2071 -112	common/cmd_bootm.c	Can't get kernel subimage load address
2072 -113	common/cmd_bootm.c	Image uncompress/copy overwrite error
2073
2074  120	common/image.c		Start initial ramdisk verification
2075 -120	common/image.c		Ramdisk FIT image has incorrect format
2076  121	common/image.c		Ramdisk FIT image has correct format
2077  122	common/image.c		No ramdisk subimage unit name, using configuration
2078 -122	common/image.c		Can't get configuration for ramdisk subimage
2079  123	common/image.c		Ramdisk unit name specified
2080 -124	common/image.c		Can't get ramdisk subimage node offset
2081  125	common/image.c		Got ramdisk subimage node offset
2082 -125	common/image.c		Ramdisk subimage hash verification failed
2083  126	common/image.c		Ramdisk subimage hash verification OK
2084 -126	common/image.c		Ramdisk subimage for unsupported architecture
2085  127	common/image.c		Architecture check OK
2086 -127	common/image.c		Can't get ramdisk subimage data/size
2087  128	common/image.c		Got ramdisk subimage data/size
2088  129	common/image.c		Can't get ramdisk load address
2089 -129	common/image.c		Got ramdisk load address
2090
2091 -130	common/cmd_doc.c	Incorrect FIT image format
2092  131	common/cmd_doc.c	FIT image format OK
2093
2094 -140	common/cmd_ide.c	Incorrect FIT image format
2095  141	common/cmd_ide.c	FIT image format OK
2096
2097 -150	common/cmd_nand.c	Incorrect FIT image format
2098  151	common/cmd_nand.c	FIT image format OK
2099
2100- Automatic software updates via TFTP server
2101		CONFIG_UPDATE_TFTP
2102		CONFIG_UPDATE_TFTP_CNT_MAX
2103		CONFIG_UPDATE_TFTP_MSEC_MAX
2104
2105		These options enable and control the auto-update feature;
2106		for a more detailed description refer to doc/README.update.
2107
2108- MTD Support (mtdparts command, UBI support)
2109		CONFIG_MTD_DEVICE
2110
2111		Adds the MTD device infrastructure from the Linux kernel.
2112		Needed for mtdparts command support.
2113
2114		CONFIG_MTD_PARTITIONS
2115
2116		Adds the MTD partitioning infrastructure from the Linux
2117		kernel. Needed for UBI support.
2118
2119
2120Modem Support:
2121--------------
2122
2123[so far only for SMDK2400 and TRAB boards]
2124
2125- Modem support enable:
2126		CONFIG_MODEM_SUPPORT
2127
2128- RTS/CTS Flow control enable:
2129		CONFIG_HWFLOW
2130
2131- Modem debug support:
2132		CONFIG_MODEM_SUPPORT_DEBUG
2133
2134		Enables debugging stuff (char screen[1024], dbg())
2135		for modem support. Useful only with BDI2000.
2136
2137- Interrupt support (PPC):
2138
2139		There are common interrupt_init() and timer_interrupt()
2140		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
2141		for CPU specific initialization. interrupt_init_cpu()
2142		should set decrementer_count to appropriate value. If
2143		CPU resets decrementer automatically after interrupt
2144		(ppc4xx) it should set decrementer_count to zero.
2145		timer_interrupt() calls timer_interrupt_cpu() for CPU
2146		specific handling. If board has watchdog / status_led
2147		/ other_activity_monitor it works automatically from
2148		general timer_interrupt().
2149
2150- General:
2151
2152		In the target system modem support is enabled when a
2153		specific key (key combination) is pressed during
2154		power-on. Otherwise U-Boot will boot normally
2155		(autoboot). The key_pressed() function is called from
2156		board_init(). Currently key_pressed() is a dummy
2157		function, returning 1 and thus enabling modem
2158		initialization.
2159
2160		If there are no modem init strings in the
2161		environment, U-Boot proceed to autoboot; the
2162		previous output (banner, info printfs) will be
2163		suppressed, though.
2164
2165		See also: doc/README.Modem
2166
2167
2168Configuration Settings:
2169-----------------------
2170
2171- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
2172		undefine this when you're short of memory.
2173
2174- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
2175		width of the commands listed in the 'help' command output.
2176
2177- CONFIG_SYS_PROMPT:	This is what U-Boot prints on the console to
2178		prompt for user input.
2179
2180- CONFIG_SYS_CBSIZE:	Buffer size for input from the Console
2181
2182- CONFIG_SYS_PBSIZE:	Buffer size for Console output
2183
2184- CONFIG_SYS_MAXARGS:	max. Number of arguments accepted for monitor commands
2185
2186- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
2187		the application (usually a Linux kernel) when it is
2188		booted
2189
2190- CONFIG_SYS_BAUDRATE_TABLE:
2191		List of legal baudrate settings for this board.
2192
2193- CONFIG_SYS_CONSOLE_INFO_QUIET
2194		Suppress display of console information at boot.
2195
2196- CONFIG_SYS_CONSOLE_IS_IN_ENV
2197		If the board specific function
2198			extern int overwrite_console (void);
2199		returns 1, the stdin, stderr and stdout are switched to the
2200		serial port, else the settings in the environment are used.
2201
2202- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
2203		Enable the call to overwrite_console().
2204
2205- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
2206		Enable overwrite of previous console environment settings.
2207
2208- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
2209		Begin and End addresses of the area used by the
2210		simple memory test.
2211
2212- CONFIG_SYS_ALT_MEMTEST:
2213		Enable an alternate, more extensive memory test.
2214
2215- CONFIG_SYS_MEMTEST_SCRATCH:
2216		Scratch address used by the alternate memory test
2217		You only need to set this if address zero isn't writeable
2218
2219- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
2220		If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
2221		this specified memory area will get subtracted from the top
2222		(end) of RAM and won't get "touched" at all by U-Boot. By
2223		fixing up gd->ram_size the Linux kernel should gets passed
2224		the now "corrected" memory size and won't touch it either.
2225		This should work for arch/ppc and arch/powerpc. Only Linux
2226		board ports in arch/powerpc with bootwrapper support that
2227		recalculate the memory size from the SDRAM controller setup
2228		will have to get fixed in Linux additionally.
2229
2230		This option can be used as a workaround for the 440EPx/GRx
2231		CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
2232		be touched.
2233
2234		WARNING: Please make sure that this value is a multiple of
2235		the Linux page size (normally 4k). If this is not the case,
2236		then the end address of the Linux memory will be located at a
2237		non page size aligned address and this could cause major
2238		problems.
2239
2240- CONFIG_SYS_TFTP_LOADADDR:
2241		Default load address for network file downloads
2242
2243- CONFIG_SYS_LOADS_BAUD_CHANGE:
2244		Enable temporary baudrate change while serial download
2245
2246- CONFIG_SYS_SDRAM_BASE:
2247		Physical start address of SDRAM. _Must_ be 0 here.
2248
2249- CONFIG_SYS_MBIO_BASE:
2250		Physical start address of Motherboard I/O (if using a
2251		Cogent motherboard)
2252
2253- CONFIG_SYS_FLASH_BASE:
2254		Physical start address of Flash memory.
2255
2256- CONFIG_SYS_MONITOR_BASE:
2257		Physical start address of boot monitor code (set by
2258		make config files to be same as the text base address
2259		(TEXT_BASE) used when linking) - same as
2260		CONFIG_SYS_FLASH_BASE when booting from flash.
2261
2262- CONFIG_SYS_MONITOR_LEN:
2263		Size of memory reserved for monitor code, used to
2264		determine _at_compile_time_ (!) if the environment is
2265		embedded within the U-Boot image, or in a separate
2266		flash sector.
2267
2268- CONFIG_SYS_MALLOC_LEN:
2269		Size of DRAM reserved for malloc() use.
2270
2271- CONFIG_SYS_BOOTM_LEN:
2272		Normally compressed uImages are limited to an
2273		uncompressed size of 8 MBytes. If this is not enough,
2274		you can define CONFIG_SYS_BOOTM_LEN in your board config file
2275		to adjust this setting to your needs.
2276
2277- CONFIG_SYS_BOOTMAPSZ:
2278		Maximum size of memory mapped by the startup code of
2279		the Linux kernel; all data that must be processed by
2280		the Linux kernel (bd_info, boot arguments, FDT blob if
2281		used) must be put below this limit, unless "bootm_low"
2282		enviroment variable is defined and non-zero. In such case
2283		all data for the Linux kernel must be between "bootm_low"
2284		and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.
2285
2286- CONFIG_SYS_MAX_FLASH_BANKS:
2287		Max number of Flash memory banks
2288
2289- CONFIG_SYS_MAX_FLASH_SECT:
2290		Max number of sectors on a Flash chip
2291
2292- CONFIG_SYS_FLASH_ERASE_TOUT:
2293		Timeout for Flash erase operations (in ms)
2294
2295- CONFIG_SYS_FLASH_WRITE_TOUT:
2296		Timeout for Flash write operations (in ms)
2297
2298- CONFIG_SYS_FLASH_LOCK_TOUT
2299		Timeout for Flash set sector lock bit operation (in ms)
2300
2301- CONFIG_SYS_FLASH_UNLOCK_TOUT
2302		Timeout for Flash clear lock bits operation (in ms)
2303
2304- CONFIG_SYS_FLASH_PROTECTION
2305		If defined, hardware flash sectors protection is used
2306		instead of U-Boot software protection.
2307
2308- CONFIG_SYS_DIRECT_FLASH_TFTP:
2309
2310		Enable TFTP transfers directly to flash memory;
2311		without this option such a download has to be
2312		performed in two steps: (1) download to RAM, and (2)
2313		copy from RAM to flash.
2314
2315		The two-step approach is usually more reliable, since
2316		you can check if the download worked before you erase
2317		the flash, but in some situations (when system RAM is
2318		too limited to allow for a temporary copy of the
2319		downloaded image) this option may be very useful.
2320
2321- CONFIG_SYS_FLASH_CFI:
2322		Define if the flash driver uses extra elements in the
2323		common flash structure for storing flash geometry.
2324
2325- CONFIG_FLASH_CFI_DRIVER
2326		This option also enables the building of the cfi_flash driver
2327		in the drivers directory
2328
2329- CONFIG_FLASH_CFI_MTD
2330		This option enables the building of the cfi_mtd driver
2331		in the drivers directory. The driver exports CFI flash
2332		to the MTD layer.
2333
2334- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
2335		Use buffered writes to flash.
2336
2337- CONFIG_FLASH_SPANSION_S29WS_N
2338		s29ws-n MirrorBit flash has non-standard addresses for buffered
2339		write commands.
2340
2341- CONFIG_SYS_FLASH_QUIET_TEST
2342		If this option is defined, the common CFI flash doesn't
2343		print it's warning upon not recognized FLASH banks. This
2344		is useful, if some of the configured banks are only
2345		optionally available.
2346
2347- CONFIG_FLASH_SHOW_PROGRESS
2348		If defined (must be an integer), print out countdown
2349		digits and dots.  Recommended value: 45 (9..1) for 80
2350		column displays, 15 (3..1) for 40 column displays.
2351
2352- CONFIG_SYS_RX_ETH_BUFFER:
2353		Defines the number of Ethernet receive buffers. On some
2354		Ethernet controllers it is recommended to set this value
2355		to 8 or even higher (EEPRO100 or 405 EMAC), since all
2356		buffers can be full shortly after enabling the interface
2357		on high Ethernet traffic.
2358		Defaults to 4 if not defined.
2359
2360The following definitions that deal with the placement and management
2361of environment data (variable area); in general, we support the
2362following configurations:
2363
2364- CONFIG_ENV_IS_IN_FLASH:
2365
2366	Define this if the environment is in flash memory.
2367
2368	a) The environment occupies one whole flash sector, which is
2369	   "embedded" in the text segment with the U-Boot code. This
2370	   happens usually with "bottom boot sector" or "top boot
2371	   sector" type flash chips, which have several smaller
2372	   sectors at the start or the end. For instance, such a
2373	   layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
2374	   such a case you would place the environment in one of the
2375	   4 kB sectors - with U-Boot code before and after it. With
2376	   "top boot sector" type flash chips, you would put the
2377	   environment in one of the last sectors, leaving a gap
2378	   between U-Boot and the environment.
2379
2380	- CONFIG_ENV_OFFSET:
2381
2382	   Offset of environment data (variable area) to the
2383	   beginning of flash memory; for instance, with bottom boot
2384	   type flash chips the second sector can be used: the offset
2385	   for this sector is given here.
2386
2387	   CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
2388
2389	- CONFIG_ENV_ADDR:
2390
2391	   This is just another way to specify the start address of
2392	   the flash sector containing the environment (instead of
2393	   CONFIG_ENV_OFFSET).
2394
2395	- CONFIG_ENV_SECT_SIZE:
2396
2397	   Size of the sector containing the environment.
2398
2399
2400	b) Sometimes flash chips have few, equal sized, BIG sectors.
2401	   In such a case you don't want to spend a whole sector for
2402	   the environment.
2403
2404	- CONFIG_ENV_SIZE:
2405
2406	   If you use this in combination with CONFIG_ENV_IS_IN_FLASH
2407	   and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
2408	   of this flash sector for the environment. This saves
2409	   memory for the RAM copy of the environment.
2410
2411	   It may also save flash memory if you decide to use this
2412	   when your environment is "embedded" within U-Boot code,
2413	   since then the remainder of the flash sector could be used
2414	   for U-Boot code. It should be pointed out that this is
2415	   STRONGLY DISCOURAGED from a robustness point of view:
2416	   updating the environment in flash makes it always
2417	   necessary to erase the WHOLE sector. If something goes
2418	   wrong before the contents has been restored from a copy in
2419	   RAM, your target system will be dead.
2420
2421	- CONFIG_ENV_ADDR_REDUND
2422	  CONFIG_ENV_SIZE_REDUND
2423
2424	   These settings describe a second storage area used to hold
2425	   a redundant copy of the environment data, so that there is
2426	   a valid backup copy in case there is a power failure during
2427	   a "saveenv" operation.
2428
2429BE CAREFUL! Any changes to the flash layout, and some changes to the
2430source code will make it necessary to adapt <board>/u-boot.lds*
2431accordingly!
2432
2433
2434- CONFIG_ENV_IS_IN_NVRAM:
2435
2436	Define this if you have some non-volatile memory device
2437	(NVRAM, battery buffered SRAM) which you want to use for the
2438	environment.
2439
2440	- CONFIG_ENV_ADDR:
2441	- CONFIG_ENV_SIZE:
2442
2443	  These two #defines are used to determine the memory area you
2444	  want to use for environment. It is assumed that this memory
2445	  can just be read and written to, without any special
2446	  provision.
2447
2448BE CAREFUL! The first access to the environment happens quite early
2449in U-Boot initalization (when we try to get the setting of for the
2450console baudrate). You *MUST* have mapped your NVRAM area then, or
2451U-Boot will hang.
2452
2453Please note that even with NVRAM we still use a copy of the
2454environment in RAM: we could work on NVRAM directly, but we want to
2455keep settings there always unmodified except somebody uses "saveenv"
2456to save the current settings.
2457
2458
2459- CONFIG_ENV_IS_IN_EEPROM:
2460
2461	Use this if you have an EEPROM or similar serial access
2462	device and a driver for it.
2463
2464	- CONFIG_ENV_OFFSET:
2465	- CONFIG_ENV_SIZE:
2466
2467	  These two #defines specify the offset and size of the
2468	  environment area within the total memory of your EEPROM.
2469
2470	- CONFIG_SYS_I2C_EEPROM_ADDR:
2471	  If defined, specified the chip address of the EEPROM device.
2472	  The default address is zero.
2473
2474	- CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
2475	  If defined, the number of bits used to address bytes in a
2476	  single page in the EEPROM device.  A 64 byte page, for example
2477	  would require six bits.
2478
2479	- CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
2480	  If defined, the number of milliseconds to delay between
2481	  page writes.	The default is zero milliseconds.
2482
2483	- CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
2484	  The length in bytes of the EEPROM memory array address.  Note
2485	  that this is NOT the chip address length!
2486
2487	- CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
2488	  EEPROM chips that implement "address overflow" are ones
2489	  like Catalyst 24WC04/08/16 which has 9/10/11 bits of
2490	  address and the extra bits end up in the "chip address" bit
2491	  slots. This makes a 24WC08 (1Kbyte) chip look like four 256
2492	  byte chips.
2493
2494	  Note that we consider the length of the address field to
2495	  still be one byte because the extra address bits are hidden
2496	  in the chip address.
2497
2498	- CONFIG_SYS_EEPROM_SIZE:
2499	  The size in bytes of the EEPROM device.
2500
2501	- CONFIG_ENV_EEPROM_IS_ON_I2C
2502	  define this, if you have I2C and SPI activated, and your
2503	  EEPROM, which holds the environment, is on the I2C bus.
2504
2505	- CONFIG_I2C_ENV_EEPROM_BUS
2506	  if you have an Environment on an EEPROM reached over
2507	  I2C muxes, you can define here, how to reach this
2508	  EEPROM. For example:
2509
2510	  #define CONFIG_I2C_ENV_EEPROM_BUS       "pca9547:70:d\0"
2511
2512	  EEPROM which holds the environment, is reached over
2513	  a pca9547 i2c mux with address 0x70, channel 3.
2514
2515- CONFIG_ENV_IS_IN_DATAFLASH:
2516
2517	Define this if you have a DataFlash memory device which you
2518	want to use for the environment.
2519
2520	- CONFIG_ENV_OFFSET:
2521	- CONFIG_ENV_ADDR:
2522	- CONFIG_ENV_SIZE:
2523
2524	  These three #defines specify the offset and size of the
2525	  environment area within the total memory of your DataFlash placed
2526	  at the specified address.
2527
2528- CONFIG_ENV_IS_IN_NAND:
2529
2530	Define this if you have a NAND device which you want to use
2531	for the environment.
2532
2533	- CONFIG_ENV_OFFSET:
2534	- CONFIG_ENV_SIZE:
2535
2536	  These two #defines specify the offset and size of the environment
2537	  area within the first NAND device.
2538
2539	- CONFIG_ENV_OFFSET_REDUND
2540
2541	  This setting describes a second storage area of CONFIG_ENV_SIZE
2542	  size used to hold a redundant copy of the environment data,
2543	  so that there is a valid backup copy in case there is a
2544	  power failure during a "saveenv" operation.
2545
2546	Note: CONFIG_ENV_OFFSET and CONFIG_ENV_OFFSET_REDUND must be aligned
2547	to a block boundary, and CONFIG_ENV_SIZE must be a multiple of
2548	the NAND devices block size.
2549
2550- CONFIG_NAND_ENV_DST
2551
2552	Defines address in RAM to which the nand_spl code should copy the
2553	environment. If redundant environment is used, it will be copied to
2554	CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
2555
2556- CONFIG_SYS_SPI_INIT_OFFSET
2557
2558	Defines offset to the initial SPI buffer area in DPRAM. The
2559	area is used at an early stage (ROM part) if the environment
2560	is configured to reside in the SPI EEPROM: We need a 520 byte
2561	scratch DPRAM area. It is used between the two initialization
2562	calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
2563	to be a good choice since it makes it far enough from the
2564	start of the data area as well as from the stack pointer.
2565
2566Please note that the environment is read-only until the monitor
2567has been relocated to RAM and a RAM copy of the environment has been
2568created; also, when using EEPROM you will have to use getenv_r()
2569until then to read environment variables.
2570
2571The environment is protected by a CRC32 checksum. Before the monitor
2572is relocated into RAM, as a result of a bad CRC you will be working
2573with the compiled-in default environment - *silently*!!! [This is
2574necessary, because the first environment variable we need is the
2575"baudrate" setting for the console - if we have a bad CRC, we don't
2576have any device yet where we could complain.]
2577
2578Note: once the monitor has been relocated, then it will complain if
2579the default environment is used; a new CRC is computed as soon as you
2580use the "saveenv" command to store a valid environment.
2581
2582- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
2583		Echo the inverted Ethernet link state to the fault LED.
2584
2585		Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
2586		      also needs to be defined.
2587
2588- CONFIG_SYS_FAULT_MII_ADDR:
2589		MII address of the PHY to check for the Ethernet link state.
2590
2591- CONFIG_NS16550_MIN_FUNCTIONS:
2592		Define this if you desire to only have use of the NS16550_init
2593		and NS16550_putc functions for the serial driver located at
2594		drivers/serial/ns16550.c.  This option is useful for saving
2595		space for already greatly restricted images, including but not
2596		limited to NAND_SPL configurations.
2597
2598Low Level (hardware related) configuration options:
2599---------------------------------------------------
2600
2601- CONFIG_SYS_CACHELINE_SIZE:
2602		Cache Line Size of the CPU.
2603
2604- CONFIG_SYS_DEFAULT_IMMR:
2605		Default address of the IMMR after system reset.
2606
2607		Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
2608		and RPXsuper) to be able to adjust the position of
2609		the IMMR register after a reset.
2610
2611- Floppy Disk Support:
2612		CONFIG_SYS_FDC_DRIVE_NUMBER
2613
2614		the default drive number (default value 0)
2615
2616		CONFIG_SYS_ISA_IO_STRIDE
2617
2618		defines the spacing between FDC chipset registers
2619		(default value 1)
2620
2621		CONFIG_SYS_ISA_IO_OFFSET
2622
2623		defines the offset of register from address. It
2624		depends on which part of the data bus is connected to
2625		the FDC chipset. (default value 0)
2626
2627		If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
2628		CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
2629		default value.
2630
2631		if CONFIG_SYS_FDC_HW_INIT is defined, then the function
2632		fdc_hw_init() is called at the beginning of the FDC
2633		setup. fdc_hw_init() must be provided by the board
2634		source code. It is used to make hardware dependant
2635		initializations.
2636
2637- CONFIG_SYS_IMMR:	Physical address of the Internal Memory.
2638		DO NOT CHANGE unless you know exactly what you're
2639		doing! (11-4) [MPC8xx/82xx systems only]
2640
2641- CONFIG_SYS_INIT_RAM_ADDR:
2642
2643		Start address of memory area that can be used for
2644		initial data and stack; please note that this must be
2645		writable memory that is working WITHOUT special
2646		initialization, i. e. you CANNOT use normal RAM which
2647		will become available only after programming the
2648		memory controller and running certain initialization
2649		sequences.
2650
2651		U-Boot uses the following memory types:
2652		- MPC8xx and MPC8260: IMMR (internal memory of the CPU)
2653		- MPC824X: data cache
2654		- PPC4xx:  data cache
2655
2656- CONFIG_SYS_GBL_DATA_OFFSET:
2657
2658		Offset of the initial data structure in the memory
2659		area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
2660		CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
2661		data is located at the end of the available space
2662		(sometimes written as (CONFIG_SYS_INIT_RAM_END -
2663		CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
2664		below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
2665		CONFIG_SYS_GBL_DATA_OFFSET) downward.
2666
2667	Note:
2668		On the MPC824X (or other systems that use the data
2669		cache for initial memory) the address chosen for
2670		CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
2671		point to an otherwise UNUSED address space between
2672		the top of RAM and the start of the PCI space.
2673
2674- CONFIG_SYS_SIUMCR:	SIU Module Configuration (11-6)
2675
2676- CONFIG_SYS_SYPCR:	System Protection Control (11-9)
2677
2678- CONFIG_SYS_TBSCR:	Time Base Status and Control (11-26)
2679
2680- CONFIG_SYS_PISCR:	Periodic Interrupt Status and Control (11-31)
2681
2682- CONFIG_SYS_PLPRCR:	PLL, Low-Power, and Reset Control Register (15-30)
2683
2684- CONFIG_SYS_SCCR:	System Clock and reset Control Register (15-27)
2685
2686- CONFIG_SYS_OR_TIMING_SDRAM:
2687		SDRAM timing
2688
2689- CONFIG_SYS_MAMR_PTA:
2690		periodic timer for refresh
2691
2692- CONFIG_SYS_DER:	Debug Event Register (37-47)
2693
2694- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
2695  CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
2696  CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
2697  CONFIG_SYS_BR1_PRELIM:
2698		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
2699
2700- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
2701  CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
2702  CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
2703		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
2704
2705- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
2706  CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
2707		Machine Mode Register and Memory Periodic Timer
2708		Prescaler definitions (SDRAM timing)
2709
2710- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
2711		enable I2C microcode relocation patch (MPC8xx);
2712		define relocation offset in DPRAM [DSP2]
2713
2714- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
2715		enable SMC microcode relocation patch (MPC8xx);
2716		define relocation offset in DPRAM [SMC1]
2717
2718- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
2719		enable SPI microcode relocation patch (MPC8xx);
2720		define relocation offset in DPRAM [SCC4]
2721
2722- CONFIG_SYS_USE_OSCCLK:
2723		Use OSCM clock mode on MBX8xx board. Be careful,
2724		wrong setting might damage your board. Read
2725		doc/README.MBX before setting this variable!
2726
2727- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
2728		Offset of the bootmode word in DPRAM used by post
2729		(Power On Self Tests). This definition overrides
2730		#define'd default value in commproc.h resp.
2731		cpm_8260.h.
2732
2733- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
2734  CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
2735  CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
2736  CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
2737  CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
2738  CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
2739  CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
2740  CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
2741		Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
2742
2743- CONFIG_PCI_DISABLE_PCIE:
2744		Disable PCI-Express on systems where it is supported but not
2745		required.
2746
2747- CONFIG_SPD_EEPROM
2748		Get DDR timing information from an I2C EEPROM. Common
2749		with pluggable memory modules such as SODIMMs
2750
2751  SPD_EEPROM_ADDRESS
2752		I2C address of the SPD EEPROM
2753
2754- CONFIG_SYS_SPD_BUS_NUM
2755		If SPD EEPROM is on an I2C bus other than the first
2756		one, specify here. Note that the value must resolve
2757		to something your driver can deal with.
2758
2759- CONFIG_SYS_83XX_DDR_USES_CS0
2760		Only for 83xx systems. If specified, then DDR should
2761		be configured using CS0 and CS1 instead of CS2 and CS3.
2762
2763- CONFIG_ETHER_ON_FEC[12]
2764		Define to enable FEC[12] on a 8xx series processor.
2765
2766- CONFIG_FEC[12]_PHY
2767		Define to the hardcoded PHY address which corresponds
2768		to the given FEC; i. e.
2769			#define CONFIG_FEC1_PHY 4
2770		means that the PHY with address 4 is connected to FEC1
2771
2772		When set to -1, means to probe for first available.
2773
2774- CONFIG_FEC[12]_PHY_NORXERR
2775		The PHY does not have a RXERR line (RMII only).
2776		(so program the FEC to ignore it).
2777
2778- CONFIG_RMII
2779		Enable RMII mode for all FECs.
2780		Note that this is a global option, we can't
2781		have one FEC in standard MII mode and another in RMII mode.
2782
2783- CONFIG_CRC32_VERIFY
2784		Add a verify option to the crc32 command.
2785		The syntax is:
2786
2787		=> crc32 -v <address> <count> <crc32>
2788
2789		Where address/count indicate a memory area
2790		and crc32 is the correct crc32 which the
2791		area should have.
2792
2793- CONFIG_LOOPW
2794		Add the "loopw" memory command. This only takes effect if
2795		the memory commands are activated globally (CONFIG_CMD_MEM).
2796
2797- CONFIG_MX_CYCLIC
2798		Add the "mdc" and "mwc" memory commands. These are cyclic
2799		"md/mw" commands.
2800		Examples:
2801
2802		=> mdc.b 10 4 500
2803		This command will print 4 bytes (10,11,12,13) each 500 ms.
2804
2805		=> mwc.l 100 12345678 10
2806		This command will write 12345678 to address 100 all 10 ms.
2807
2808		This only takes effect if the memory commands are activated
2809		globally (CONFIG_CMD_MEM).
2810
2811- CONFIG_SKIP_LOWLEVEL_INIT
2812- CONFIG_SKIP_RELOCATE_UBOOT
2813
2814		[ARM only] If these variables are defined, then
2815		certain low level initializations (like setting up
2816		the memory controller) are omitted and/or U-Boot does
2817		not relocate itself into RAM.
2818		Normally these variables MUST NOT be defined. The
2819		only exception is when U-Boot is loaded (to RAM) by
2820		some other boot loader or by a debugger which
2821		performs these initializations itself.
2822
2823- CONFIG_PRELOADER
2824
2825		Modifies the behaviour of start.S when compiling a loader
2826		that is executed before the actual U-Boot. E.g. when
2827		compiling a NAND SPL.
2828
2829Building the Software:
2830======================
2831
2832Building U-Boot has been tested in several native build environments
2833and in many different cross environments. Of course we cannot support
2834all possibly existing versions of cross development tools in all
2835(potentially obsolete) versions. In case of tool chain problems we
2836recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
2837which is extensively used to build and test U-Boot.
2838
2839If you are not using a native environment, it is assumed that you
2840have GNU cross compiling tools available in your path. In this case,
2841you must set the environment variable CROSS_COMPILE in your shell.
2842Note that no changes to the Makefile or any other source files are
2843necessary. For example using the ELDK on a 4xx CPU, please enter:
2844
2845	$ CROSS_COMPILE=ppc_4xx-
2846	$ export CROSS_COMPILE
2847
2848Note: If you wish to generate Windows versions of the utilities in
2849      the tools directory you can use the MinGW toolchain
2850      (http://www.mingw.org).  Set your HOST tools to the MinGW
2851      toolchain and execute 'make tools'.  For example:
2852
2853       $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
2854
2855      Binaries such as tools/mkimage.exe will be created which can
2856      be executed on computers running Windows.
2857
2858U-Boot is intended to be simple to build. After installing the
2859sources you must configure U-Boot for one specific board type. This
2860is done by typing:
2861
2862	make NAME_config
2863
2864where "NAME_config" is the name of one of the existing configu-
2865rations; see the main Makefile for supported names.
2866
2867Note: for some board special configuration names may exist; check if
2868      additional information is available from the board vendor; for
2869      instance, the TQM823L systems are available without (standard)
2870      or with LCD support. You can select such additional "features"
2871      when choosing the configuration, i. e.
2872
2873      make TQM823L_config
2874	- will configure for a plain TQM823L, i. e. no LCD support
2875
2876      make TQM823L_LCD_config
2877	- will configure for a TQM823L with U-Boot console on LCD
2878
2879      etc.
2880
2881
2882Finally, type "make all", and you should get some working U-Boot
2883images ready for download to / installation on your system:
2884
2885- "u-boot.bin" is a raw binary image
2886- "u-boot" is an image in ELF binary format
2887- "u-boot.srec" is in Motorola S-Record format
2888
2889By default the build is performed locally and the objects are saved
2890in the source directory. One of the two methods can be used to change
2891this behavior and build U-Boot to some external directory:
2892
28931. Add O= to the make command line invocations:
2894
2895	make O=/tmp/build distclean
2896	make O=/tmp/build NAME_config
2897	make O=/tmp/build all
2898
28992. Set environment variable BUILD_DIR to point to the desired location:
2900
2901	export BUILD_DIR=/tmp/build
2902	make distclean
2903	make NAME_config
2904	make all
2905
2906Note that the command line "O=" setting overrides the BUILD_DIR environment
2907variable.
2908
2909
2910Please be aware that the Makefiles assume you are using GNU make, so
2911for instance on NetBSD you might need to use "gmake" instead of
2912native "make".
2913
2914
2915If the system board that you have is not listed, then you will need
2916to port U-Boot to your hardware platform. To do this, follow these
2917steps:
2918
29191.  Add a new configuration option for your board to the toplevel
2920    "Makefile" and to the "MAKEALL" script, using the existing
2921    entries as examples. Note that here and at many other places
2922    boards and other names are listed in alphabetical sort order. Please
2923    keep this order.
29242.  Create a new directory to hold your board specific code. Add any
2925    files you need. In your board directory, you will need at least
2926    the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
29273.  Create a new configuration file "include/configs/<board>.h" for
2928    your board
29293.  If you're porting U-Boot to a new CPU, then also create a new
2930    directory to hold your CPU specific code. Add any files you need.
29314.  Run "make <board>_config" with your new name.
29325.  Type "make", and you should get a working "u-boot.srec" file
2933    to be installed on your target system.
29346.  Debug and solve any problems that might arise.
2935    [Of course, this last step is much harder than it sounds.]
2936
2937
2938Testing of U-Boot Modifications, Ports to New Hardware, etc.:
2939==============================================================
2940
2941If you have modified U-Boot sources (for instance added a new board
2942or support for new devices, a new CPU, etc.) you are expected to
2943provide feedback to the other developers. The feedback normally takes
2944the form of a "patch", i. e. a context diff against a certain (latest
2945official or latest in the git repository) version of U-Boot sources.
2946
2947But before you submit such a patch, please verify that your modifi-
2948cation did not break existing code. At least make sure that *ALL* of
2949the supported boards compile WITHOUT ANY compiler warnings. To do so,
2950just run the "MAKEALL" script, which will configure and build U-Boot
2951for ALL supported system. Be warned, this will take a while. You can
2952select which (cross) compiler to use by passing a `CROSS_COMPILE'
2953environment variable to the script, i. e. to use the ELDK cross tools
2954you can type
2955
2956	CROSS_COMPILE=ppc_8xx- MAKEALL
2957
2958or to build on a native PowerPC system you can type
2959
2960	CROSS_COMPILE=' ' MAKEALL
2961
2962When using the MAKEALL script, the default behaviour is to build
2963U-Boot in the source directory. This location can be changed by
2964setting the BUILD_DIR environment variable. Also, for each target
2965built, the MAKEALL script saves two log files (<target>.ERR and
2966<target>.MAKEALL) in the <source dir>/LOG directory. This default
2967location can be changed by setting the MAKEALL_LOGDIR environment
2968variable. For example:
2969
2970	export BUILD_DIR=/tmp/build
2971	export MAKEALL_LOGDIR=/tmp/log
2972	CROSS_COMPILE=ppc_8xx- MAKEALL
2973
2974With the above settings build objects are saved in the /tmp/build,
2975log files are saved in the /tmp/log and the source tree remains clean
2976during the whole build process.
2977
2978
2979See also "U-Boot Porting Guide" below.
2980
2981
2982Monitor Commands - Overview:
2983============================
2984
2985go	- start application at address 'addr'
2986run	- run commands in an environment variable
2987bootm	- boot application image from memory
2988bootp	- boot image via network using BootP/TFTP protocol
2989tftpboot- boot image via network using TFTP protocol
2990	       and env variables "ipaddr" and "serverip"
2991	       (and eventually "gatewayip")
2992rarpboot- boot image via network using RARP/TFTP protocol
2993diskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
2994loads	- load S-Record file over serial line
2995loadb	- load binary file over serial line (kermit mode)
2996md	- memory display
2997mm	- memory modify (auto-incrementing)
2998nm	- memory modify (constant address)
2999mw	- memory write (fill)
3000cp	- memory copy
3001cmp	- memory compare
3002crc32	- checksum calculation
3003i2c	- I2C sub-system
3004sspi	- SPI utility commands
3005base	- print or set address offset
3006printenv- print environment variables
3007setenv	- set environment variables
3008saveenv - save environment variables to persistent storage
3009protect - enable or disable FLASH write protection
3010erase	- erase FLASH memory
3011flinfo	- print FLASH memory information
3012bdinfo	- print Board Info structure
3013iminfo	- print header information for application image
3014coninfo - print console devices and informations
3015ide	- IDE sub-system
3016loop	- infinite loop on address range
3017loopw	- infinite write loop on address range
3018mtest	- simple RAM test
3019icache	- enable or disable instruction cache
3020dcache	- enable or disable data cache
3021reset	- Perform RESET of the CPU
3022echo	- echo args to console
3023version - print monitor version
3024help	- print online help
3025?	- alias for 'help'
3026
3027
3028Monitor Commands - Detailed Description:
3029========================================
3030
3031TODO.
3032
3033For now: just type "help <command>".
3034
3035
3036Environment Variables:
3037======================
3038
3039U-Boot supports user configuration using Environment Variables which
3040can be made persistent by saving to Flash memory.
3041
3042Environment Variables are set using "setenv", printed using
3043"printenv", and saved to Flash using "saveenv". Using "setenv"
3044without a value can be used to delete a variable from the
3045environment. As long as you don't save the environment you are
3046working with an in-memory copy. In case the Flash area containing the
3047environment is erased by accident, a default environment is provided.
3048
3049Some configuration options can be set using Environment Variables.
3050
3051List of environment variables (most likely not complete):
3052
3053  baudrate	- see CONFIG_BAUDRATE
3054
3055  bootdelay	- see CONFIG_BOOTDELAY
3056
3057  bootcmd	- see CONFIG_BOOTCOMMAND
3058
3059  bootargs	- Boot arguments when booting an RTOS image
3060
3061  bootfile	- Name of the image to load with TFTP
3062
3063  bootm_low	- Memory range available for image processing in the bootm
3064		  command can be restricted. This variable is given as
3065		  a hexadecimal number and defines lowest address allowed
3066		  for use by the bootm command. See also "bootm_size"
3067		  environment variable. Address defined by "bootm_low" is
3068		  also the base of the initial memory mapping for the Linux
3069		  kernel -- see the description of CONFIG_SYS_BOOTMAPSZ.
3070
3071  bootm_size	- Memory range available for image processing in the bootm
3072		  command can be restricted. This variable is given as
3073		  a hexadecimal number and defines the size of the region
3074		  allowed for use by the bootm command. See also "bootm_low"
3075		  environment variable.
3076
3077  updatefile	- Location of the software update file on a TFTP server, used
3078		  by the automatic software update feature. Please refer to
3079		  documentation in doc/README.update for more details.
3080
3081  autoload	- if set to "no" (any string beginning with 'n'),
3082		  "bootp" will just load perform a lookup of the
3083		  configuration from the BOOTP server, but not try to
3084		  load any image using TFTP
3085
3086  autostart	- if set to "yes", an image loaded using the "bootp",
3087		  "rarpboot", "tftpboot" or "diskboot" commands will
3088		  be automatically started (by internally calling
3089		  "bootm")
3090
3091		  If set to "no", a standalone image passed to the
3092		  "bootm" command will be copied to the load address
3093		  (and eventually uncompressed), but NOT be started.
3094		  This can be used to load and uncompress arbitrary
3095		  data.
3096
3097  i2cfast	- (PPC405GP|PPC405EP only)
3098		  if set to 'y' configures Linux I2C driver for fast
3099		  mode (400kHZ). This environment variable is used in
3100		  initialization code. So, for changes to be effective
3101		  it must be saved and board must be reset.
3102
3103  initrd_high	- restrict positioning of initrd images:
3104		  If this variable is not set, initrd images will be
3105		  copied to the highest possible address in RAM; this
3106		  is usually what you want since it allows for
3107		  maximum initrd size. If for some reason you want to
3108		  make sure that the initrd image is loaded below the
3109		  CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
3110		  variable to a value of "no" or "off" or "0".
3111		  Alternatively, you can set it to a maximum upper
3112		  address to use (U-Boot will still check that it
3113		  does not overwrite the U-Boot stack and data).
3114
3115		  For instance, when you have a system with 16 MB
3116		  RAM, and want to reserve 4 MB from use by Linux,
3117		  you can do this by adding "mem=12M" to the value of
3118		  the "bootargs" variable. However, now you must make
3119		  sure that the initrd image is placed in the first
3120		  12 MB as well - this can be done with
3121
3122		  setenv initrd_high 00c00000
3123
3124		  If you set initrd_high to 0xFFFFFFFF, this is an
3125		  indication to U-Boot that all addresses are legal
3126		  for the Linux kernel, including addresses in flash
3127		  memory. In this case U-Boot will NOT COPY the
3128		  ramdisk at all. This may be useful to reduce the
3129		  boot time on your system, but requires that this
3130		  feature is supported by your Linux kernel.
3131
3132  ipaddr	- IP address; needed for tftpboot command
3133
3134  loadaddr	- Default load address for commands like "bootp",
3135		  "rarpboot", "tftpboot", "loadb" or "diskboot"
3136
3137  loads_echo	- see CONFIG_LOADS_ECHO
3138
3139  serverip	- TFTP server IP address; needed for tftpboot command
3140
3141  bootretry	- see CONFIG_BOOT_RETRY_TIME
3142
3143  bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
3144
3145  bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
3146
3147  ethprime	- When CONFIG_NET_MULTI is enabled controls which
3148		  interface is used first.
3149
3150  ethact	- When CONFIG_NET_MULTI is enabled controls which
3151		  interface is currently active. For example you
3152		  can do the following
3153
3154		  => setenv ethact FEC ETHERNET
3155		  => ping 192.168.0.1 # traffic sent on FEC ETHERNET
3156		  => setenv ethact SCC ETHERNET
3157		  => ping 10.0.0.1 # traffic sent on SCC ETHERNET
3158
3159  ethrotate	- When set to "no" U-Boot does not go through all
3160		  available network interfaces.
3161		  It just stays at the currently selected interface.
3162
3163  netretry	- When set to "no" each network operation will
3164		  either succeed or fail without retrying.
3165		  When set to "once" the network operation will
3166		  fail when all the available network interfaces
3167		  are tried once without success.
3168		  Useful on scripts which control the retry operation
3169		  themselves.
3170
3171  npe_ucode	- set load address for the NPE microcode
3172
3173  tftpsrcport	- If this is set, the value is used for TFTP's
3174		  UDP source port.
3175
3176  tftpdstport	- If this is set, the value is used for TFTP's UDP
3177		  destination port instead of the Well Know Port 69.
3178
3179  tftpblocksize - Block size to use for TFTP transfers; if not set,
3180		  we use the TFTP server's default block size
3181
3182  tftptimeout	- Retransmission timeout for TFTP packets (in milli-
3183		  seconds, minimum value is 1000 = 1 second). Defines
3184		  when a packet is considered to be lost so it has to
3185		  be retransmitted. The default is 5000 = 5 seconds.
3186		  Lowering this value may make downloads succeed
3187		  faster in networks with high packet loss rates or
3188		  with unreliable TFTP servers.
3189
3190  vlan		- When set to a value < 4095 the traffic over
3191		  Ethernet is encapsulated/received over 802.1q
3192		  VLAN tagged frames.
3193
3194The following environment variables may be used and automatically
3195updated by the network boot commands ("bootp" and "rarpboot"),
3196depending the information provided by your boot server:
3197
3198  bootfile	- see above
3199  dnsip		- IP address of your Domain Name Server
3200  dnsip2	- IP address of your secondary Domain Name Server
3201  gatewayip	- IP address of the Gateway (Router) to use
3202  hostname	- Target hostname
3203  ipaddr	- see above
3204  netmask	- Subnet Mask
3205  rootpath	- Pathname of the root filesystem on the NFS server
3206  serverip	- see above
3207
3208
3209There are two special Environment Variables:
3210
3211  serial#	- contains hardware identification information such
3212		  as type string and/or serial number
3213  ethaddr	- Ethernet address
3214
3215These variables can be set only once (usually during manufacturing of
3216the board). U-Boot refuses to delete or overwrite these variables
3217once they have been set once.
3218
3219
3220Further special Environment Variables:
3221
3222  ver		- Contains the U-Boot version string as printed
3223		  with the "version" command. This variable is
3224		  readonly (see CONFIG_VERSION_VARIABLE).
3225
3226
3227Please note that changes to some configuration parameters may take
3228only effect after the next boot (yes, that's just like Windoze :-).
3229
3230
3231Command Line Parsing:
3232=====================
3233
3234There are two different command line parsers available with U-Boot:
3235the old "simple" one, and the much more powerful "hush" shell:
3236
3237Old, simple command line parser:
3238--------------------------------
3239
3240- supports environment variables (through setenv / saveenv commands)
3241- several commands on one line, separated by ';'
3242- variable substitution using "... ${name} ..." syntax
3243- special characters ('$', ';') can be escaped by prefixing with '\',
3244  for example:
3245	setenv bootcmd bootm \${address}
3246- You can also escape text by enclosing in single apostrophes, for example:
3247	setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
3248
3249Hush shell:
3250-----------
3251
3252- similar to Bourne shell, with control structures like
3253  if...then...else...fi, for...do...done; while...do...done,
3254  until...do...done, ...
3255- supports environment ("global") variables (through setenv / saveenv
3256  commands) and local shell variables (through standard shell syntax
3257  "name=value"); only environment variables can be used with "run"
3258  command
3259
3260General rules:
3261--------------
3262
3263(1) If a command line (or an environment variable executed by a "run"
3264    command) contains several commands separated by semicolon, and
3265    one of these commands fails, then the remaining commands will be
3266    executed anyway.
3267
3268(2) If you execute several variables with one call to run (i. e.
3269    calling run with a list of variables as arguments), any failing
3270    command will cause "run" to terminate, i. e. the remaining
3271    variables are not executed.
3272
3273Note for Redundant Ethernet Interfaces:
3274=======================================
3275
3276Some boards come with redundant Ethernet interfaces; U-Boot supports
3277such configurations and is capable of automatic selection of a
3278"working" interface when needed. MAC assignment works as follows:
3279
3280Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
3281MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
3282"eth1addr" (=>eth1), "eth2addr", ...
3283
3284If the network interface stores some valid MAC address (for instance
3285in SROM), this is used as default address if there is NO correspon-
3286ding setting in the environment; if the corresponding environment
3287variable is set, this overrides the settings in the card; that means:
3288
3289o If the SROM has a valid MAC address, and there is no address in the
3290  environment, the SROM's address is used.
3291
3292o If there is no valid address in the SROM, and a definition in the
3293  environment exists, then the value from the environment variable is
3294  used.
3295
3296o If both the SROM and the environment contain a MAC address, and
3297  both addresses are the same, this MAC address is used.
3298
3299o If both the SROM and the environment contain a MAC address, and the
3300  addresses differ, the value from the environment is used and a
3301  warning is printed.
3302
3303o If neither SROM nor the environment contain a MAC address, an error
3304  is raised.
3305
3306If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
3307will be programmed into hardware as part of the initialization process.  This
3308may be skipped by setting the appropriate 'ethmacskip' environment variable.
3309The naming convention is as follows:
3310"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
3311
3312Image Formats:
3313==============
3314
3315U-Boot is capable of booting (and performing other auxiliary operations on)
3316images in two formats:
3317
3318New uImage format (FIT)
3319-----------------------
3320
3321Flexible and powerful format based on Flattened Image Tree -- FIT (similar
3322to Flattened Device Tree). It allows the use of images with multiple
3323components (several kernels, ramdisks, etc.), with contents protected by
3324SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
3325
3326
3327Old uImage format
3328-----------------
3329
3330Old image format is based on binary files which can be basically anything,
3331preceded by a special header; see the definitions in include/image.h for
3332details; basically, the header defines the following image properties:
3333
3334* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
3335  4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
3336  LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
3337  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
3338  INTEGRITY).
3339* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
3340  IA64, MIPS, NIOS, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
3341  Currently supported: ARM, AVR32, Intel x86, MIPS, NIOS, PowerPC).
3342* Compression Type (uncompressed, gzip, bzip2)
3343* Load Address
3344* Entry Point
3345* Image Name
3346* Image Timestamp
3347
3348The header is marked by a special Magic Number, and both the header
3349and the data portions of the image are secured against corruption by
3350CRC32 checksums.
3351
3352
3353Linux Support:
3354==============
3355
3356Although U-Boot should support any OS or standalone application
3357easily, the main focus has always been on Linux during the design of
3358U-Boot.
3359
3360U-Boot includes many features that so far have been part of some
3361special "boot loader" code within the Linux kernel. Also, any
3362"initrd" images to be used are no longer part of one big Linux image;
3363instead, kernel and "initrd" are separate images. This implementation
3364serves several purposes:
3365
3366- the same features can be used for other OS or standalone
3367  applications (for instance: using compressed images to reduce the
3368  Flash memory footprint)
3369
3370- it becomes much easier to port new Linux kernel versions because
3371  lots of low-level, hardware dependent stuff are done by U-Boot
3372
3373- the same Linux kernel image can now be used with different "initrd"
3374  images; of course this also means that different kernel images can
3375  be run with the same "initrd". This makes testing easier (you don't
3376  have to build a new "zImage.initrd" Linux image when you just
3377  change a file in your "initrd"). Also, a field-upgrade of the
3378  software is easier now.
3379
3380
3381Linux HOWTO:
3382============
3383
3384Porting Linux to U-Boot based systems:
3385---------------------------------------
3386
3387U-Boot cannot save you from doing all the necessary modifications to
3388configure the Linux device drivers for use with your target hardware
3389(no, we don't intend to provide a full virtual machine interface to
3390Linux :-).
3391
3392But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
3393
3394Just make sure your machine specific header file (for instance
3395include/asm-ppc/tqm8xx.h) includes the same definition of the Board
3396Information structure as we define in include/asm-<arch>/u-boot.h,
3397and make sure that your definition of IMAP_ADDR uses the same value
3398as your U-Boot configuration in CONFIG_SYS_IMMR.
3399
3400
3401Configuring the Linux kernel:
3402-----------------------------
3403
3404No specific requirements for U-Boot. Make sure you have some root
3405device (initial ramdisk, NFS) for your target system.
3406
3407
3408Building a Linux Image:
3409-----------------------
3410
3411With U-Boot, "normal" build targets like "zImage" or "bzImage" are
3412not used. If you use recent kernel source, a new build target
3413"uImage" will exist which automatically builds an image usable by
3414U-Boot. Most older kernels also have support for a "pImage" target,
3415which was introduced for our predecessor project PPCBoot and uses a
3416100% compatible format.
3417
3418Example:
3419
3420	make TQM850L_config
3421	make oldconfig
3422	make dep
3423	make uImage
3424
3425The "uImage" build target uses a special tool (in 'tools/mkimage') to
3426encapsulate a compressed Linux kernel image with header	 information,
3427CRC32 checksum etc. for use with U-Boot. This is what we are doing:
3428
3429* build a standard "vmlinux" kernel image (in ELF binary format):
3430
3431* convert the kernel into a raw binary image:
3432
3433	${CROSS_COMPILE}-objcopy -O binary \
3434				 -R .note -R .comment \
3435				 -S vmlinux linux.bin
3436
3437* compress the binary image:
3438
3439	gzip -9 linux.bin
3440
3441* package compressed binary image for U-Boot:
3442
3443	mkimage -A ppc -O linux -T kernel -C gzip \
3444		-a 0 -e 0 -n "Linux Kernel Image" \
3445		-d linux.bin.gz uImage
3446
3447
3448The "mkimage" tool can also be used to create ramdisk images for use
3449with U-Boot, either separated from the Linux kernel image, or
3450combined into one file. "mkimage" encapsulates the images with a 64
3451byte header containing information about target architecture,
3452operating system, image type, compression method, entry points, time
3453stamp, CRC32 checksums, etc.
3454
3455"mkimage" can be called in two ways: to verify existing images and
3456print the header information, or to build new images.
3457
3458In the first form (with "-l" option) mkimage lists the information
3459contained in the header of an existing U-Boot image; this includes
3460checksum verification:
3461
3462	tools/mkimage -l image
3463	  -l ==> list image header information
3464
3465The second form (with "-d" option) is used to build a U-Boot image
3466from a "data file" which is used as image payload:
3467
3468	tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
3469		      -n name -d data_file image
3470	  -A ==> set architecture to 'arch'
3471	  -O ==> set operating system to 'os'
3472	  -T ==> set image type to 'type'
3473	  -C ==> set compression type 'comp'
3474	  -a ==> set load address to 'addr' (hex)
3475	  -e ==> set entry point to 'ep' (hex)
3476	  -n ==> set image name to 'name'
3477	  -d ==> use image data from 'datafile'
3478
3479Right now, all Linux kernels for PowerPC systems use the same load
3480address (0x00000000), but the entry point address depends on the
3481kernel version:
3482
3483- 2.2.x kernels have the entry point at 0x0000000C,
3484- 2.3.x and later kernels have the entry point at 0x00000000.
3485
3486So a typical call to build a U-Boot image would read:
3487
3488	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3489	> -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
3490	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
3491	> examples/uImage.TQM850L
3492	Image Name:   2.4.4 kernel for TQM850L
3493	Created:      Wed Jul 19 02:34:59 2000
3494	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
3495	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
3496	Load Address: 0x00000000
3497	Entry Point:  0x00000000
3498
3499To verify the contents of the image (or check for corruption):
3500
3501	-> tools/mkimage -l examples/uImage.TQM850L
3502	Image Name:   2.4.4 kernel for TQM850L
3503	Created:      Wed Jul 19 02:34:59 2000
3504	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
3505	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
3506	Load Address: 0x00000000
3507	Entry Point:  0x00000000
3508
3509NOTE: for embedded systems where boot time is critical you can trade
3510speed for memory and install an UNCOMPRESSED image instead: this
3511needs more space in Flash, but boots much faster since it does not
3512need to be uncompressed:
3513
3514	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
3515	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3516	> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
3517	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
3518	> examples/uImage.TQM850L-uncompressed
3519	Image Name:   2.4.4 kernel for TQM850L
3520	Created:      Wed Jul 19 02:34:59 2000
3521	Image Type:   PowerPC Linux Kernel Image (uncompressed)
3522	Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
3523	Load Address: 0x00000000
3524	Entry Point:  0x00000000
3525
3526
3527Similar you can build U-Boot images from a 'ramdisk.image.gz' file
3528when your kernel is intended to use an initial ramdisk:
3529
3530	-> tools/mkimage -n 'Simple Ramdisk Image' \
3531	> -A ppc -O linux -T ramdisk -C gzip \
3532	> -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
3533	Image Name:   Simple Ramdisk Image
3534	Created:      Wed Jan 12 14:01:50 2000
3535	Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
3536	Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
3537	Load Address: 0x00000000
3538	Entry Point:  0x00000000
3539
3540
3541Installing a Linux Image:
3542-------------------------
3543
3544To downloading a U-Boot image over the serial (console) interface,
3545you must convert the image to S-Record format:
3546
3547	objcopy -I binary -O srec examples/image examples/image.srec
3548
3549The 'objcopy' does not understand the information in the U-Boot
3550image header, so the resulting S-Record file will be relative to
3551address 0x00000000. To load it to a given address, you need to
3552specify the target address as 'offset' parameter with the 'loads'
3553command.
3554
3555Example: install the image to address 0x40100000 (which on the
3556TQM8xxL is in the first Flash bank):
3557
3558	=> erase 40100000 401FFFFF
3559
3560	.......... done
3561	Erased 8 sectors
3562
3563	=> loads 40100000
3564	## Ready for S-Record download ...
3565	~>examples/image.srec
3566	1 2 3 4 5 6 7 8 9 10 11 12 13 ...
3567	...
3568	15989 15990 15991 15992
3569	[file transfer complete]
3570	[connected]
3571	## Start Addr = 0x00000000
3572
3573
3574You can check the success of the download using the 'iminfo' command;
3575this includes a checksum verification so you can be sure no data
3576corruption happened:
3577
3578	=> imi 40100000
3579
3580	## Checking Image at 40100000 ...
3581	   Image Name:	 2.2.13 for initrd on TQM850L
3582	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3583	   Data Size:	 335725 Bytes = 327 kB = 0 MB
3584	   Load Address: 00000000
3585	   Entry Point:	 0000000c
3586	   Verifying Checksum ... OK
3587
3588
3589Boot Linux:
3590-----------
3591
3592The "bootm" command is used to boot an application that is stored in
3593memory (RAM or Flash). In case of a Linux kernel image, the contents
3594of the "bootargs" environment variable is passed to the kernel as
3595parameters. You can check and modify this variable using the
3596"printenv" and "setenv" commands:
3597
3598
3599	=> printenv bootargs
3600	bootargs=root=/dev/ram
3601
3602	=> setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3603
3604	=> printenv bootargs
3605	bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3606
3607	=> bootm 40020000
3608	## Booting Linux kernel at 40020000 ...
3609	   Image Name:	 2.2.13 for NFS on TQM850L
3610	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3611	   Data Size:	 381681 Bytes = 372 kB = 0 MB
3612	   Load Address: 00000000
3613	   Entry Point:	 0000000c
3614	   Verifying Checksum ... OK
3615	   Uncompressing Kernel Image ... OK
3616	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
3617	Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3618	time_init: decrementer frequency = 187500000/60
3619	Calibrating delay loop... 49.77 BogoMIPS
3620	Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
3621	...
3622
3623If you want to boot a Linux kernel with initial RAM disk, you pass
3624the memory addresses of both the kernel and the initrd image (PPBCOOT
3625format!) to the "bootm" command:
3626
3627	=> imi 40100000 40200000
3628
3629	## Checking Image at 40100000 ...
3630	   Image Name:	 2.2.13 for initrd on TQM850L
3631	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3632	   Data Size:	 335725 Bytes = 327 kB = 0 MB
3633	   Load Address: 00000000
3634	   Entry Point:	 0000000c
3635	   Verifying Checksum ... OK
3636
3637	## Checking Image at 40200000 ...
3638	   Image Name:	 Simple Ramdisk Image
3639	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
3640	   Data Size:	 566530 Bytes = 553 kB = 0 MB
3641	   Load Address: 00000000
3642	   Entry Point:	 00000000
3643	   Verifying Checksum ... OK
3644
3645	=> bootm 40100000 40200000
3646	## Booting Linux kernel at 40100000 ...
3647	   Image Name:	 2.2.13 for initrd on TQM850L
3648	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3649	   Data Size:	 335725 Bytes = 327 kB = 0 MB
3650	   Load Address: 00000000
3651	   Entry Point:	 0000000c
3652	   Verifying Checksum ... OK
3653	   Uncompressing Kernel Image ... OK
3654	## Loading RAMDisk Image at 40200000 ...
3655	   Image Name:	 Simple Ramdisk Image
3656	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
3657	   Data Size:	 566530 Bytes = 553 kB = 0 MB
3658	   Load Address: 00000000
3659	   Entry Point:	 00000000
3660	   Verifying Checksum ... OK
3661	   Loading Ramdisk ... OK
3662	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
3663	Boot arguments: root=/dev/ram
3664	time_init: decrementer frequency = 187500000/60
3665	Calibrating delay loop... 49.77 BogoMIPS
3666	...
3667	RAMDISK: Compressed image found at block 0
3668	VFS: Mounted root (ext2 filesystem).
3669
3670	bash#
3671
3672Boot Linux and pass a flat device tree:
3673-----------
3674
3675First, U-Boot must be compiled with the appropriate defines. See the section
3676titled "Linux Kernel Interface" above for a more in depth explanation. The
3677following is an example of how to start a kernel and pass an updated
3678flat device tree:
3679
3680=> print oftaddr
3681oftaddr=0x300000
3682=> print oft
3683oft=oftrees/mpc8540ads.dtb
3684=> tftp $oftaddr $oft
3685Speed: 1000, full duplex
3686Using TSEC0 device
3687TFTP from server 192.168.1.1; our IP address is 192.168.1.101
3688Filename 'oftrees/mpc8540ads.dtb'.
3689Load address: 0x300000
3690Loading: #
3691done
3692Bytes transferred = 4106 (100a hex)
3693=> tftp $loadaddr $bootfile
3694Speed: 1000, full duplex
3695Using TSEC0 device
3696TFTP from server 192.168.1.1; our IP address is 192.168.1.2
3697Filename 'uImage'.
3698Load address: 0x200000
3699Loading:############
3700done
3701Bytes transferred = 1029407 (fb51f hex)
3702=> print loadaddr
3703loadaddr=200000
3704=> print oftaddr
3705oftaddr=0x300000
3706=> bootm $loadaddr - $oftaddr
3707## Booting image at 00200000 ...
3708   Image Name:	 Linux-2.6.17-dirty
3709   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3710   Data Size:	 1029343 Bytes = 1005.2 kB
3711   Load Address: 00000000
3712   Entry Point:	 00000000
3713   Verifying Checksum ... OK
3714   Uncompressing Kernel Image ... OK
3715Booting using flat device tree at 0x300000
3716Using MPC85xx ADS machine description
3717Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
3718[snip]
3719
3720
3721More About U-Boot Image Types:
3722------------------------------
3723
3724U-Boot supports the following image types:
3725
3726   "Standalone Programs" are directly runnable in the environment
3727	provided by U-Boot; it is expected that (if they behave
3728	well) you can continue to work in U-Boot after return from
3729	the Standalone Program.
3730   "OS Kernel Images" are usually images of some Embedded OS which
3731	will take over control completely. Usually these programs
3732	will install their own set of exception handlers, device
3733	drivers, set up the MMU, etc. - this means, that you cannot
3734	expect to re-enter U-Boot except by resetting the CPU.
3735   "RAMDisk Images" are more or less just data blocks, and their
3736	parameters (address, size) are passed to an OS kernel that is
3737	being started.
3738   "Multi-File Images" contain several images, typically an OS
3739	(Linux) kernel image and one or more data images like
3740	RAMDisks. This construct is useful for instance when you want
3741	to boot over the network using BOOTP etc., where the boot
3742	server provides just a single image file, but you want to get
3743	for instance an OS kernel and a RAMDisk image.
3744
3745	"Multi-File Images" start with a list of image sizes, each
3746	image size (in bytes) specified by an "uint32_t" in network
3747	byte order. This list is terminated by an "(uint32_t)0".
3748	Immediately after the terminating 0 follow the images, one by
3749	one, all aligned on "uint32_t" boundaries (size rounded up to
3750	a multiple of 4 bytes).
3751
3752   "Firmware Images" are binary images containing firmware (like
3753	U-Boot or FPGA images) which usually will be programmed to
3754	flash memory.
3755
3756   "Script files" are command sequences that will be executed by
3757	U-Boot's command interpreter; this feature is especially
3758	useful when you configure U-Boot to use a real shell (hush)
3759	as command interpreter.
3760
3761
3762Standalone HOWTO:
3763=================
3764
3765One of the features of U-Boot is that you can dynamically load and
3766run "standalone" applications, which can use some resources of
3767U-Boot like console I/O functions or interrupt services.
3768
3769Two simple examples are included with the sources:
3770
3771"Hello World" Demo:
3772-------------------
3773
3774'examples/hello_world.c' contains a small "Hello World" Demo
3775application; it is automatically compiled when you build U-Boot.
3776It's configured to run at address 0x00040004, so you can play with it
3777like that:
3778
3779	=> loads
3780	## Ready for S-Record download ...
3781	~>examples/hello_world.srec
3782	1 2 3 4 5 6 7 8 9 10 11 ...
3783	[file transfer complete]
3784	[connected]
3785	## Start Addr = 0x00040004
3786
3787	=> go 40004 Hello World! This is a test.
3788	## Starting application at 0x00040004 ...
3789	Hello World
3790	argc = 7
3791	argv[0] = "40004"
3792	argv[1] = "Hello"
3793	argv[2] = "World!"
3794	argv[3] = "This"
3795	argv[4] = "is"
3796	argv[5] = "a"
3797	argv[6] = "test."
3798	argv[7] = "<NULL>"
3799	Hit any key to exit ...
3800
3801	## Application terminated, rc = 0x0
3802
3803Another example, which demonstrates how to register a CPM interrupt
3804handler with the U-Boot code, can be found in 'examples/timer.c'.
3805Here, a CPM timer is set up to generate an interrupt every second.
3806The interrupt service routine is trivial, just printing a '.'
3807character, but this is just a demo program. The application can be
3808controlled by the following keys:
3809
3810	? - print current values og the CPM Timer registers
3811	b - enable interrupts and start timer
3812	e - stop timer and disable interrupts
3813	q - quit application
3814
3815	=> loads
3816	## Ready for S-Record download ...
3817	~>examples/timer.srec
3818	1 2 3 4 5 6 7 8 9 10 11 ...
3819	[file transfer complete]
3820	[connected]
3821	## Start Addr = 0x00040004
3822
3823	=> go 40004
3824	## Starting application at 0x00040004 ...
3825	TIMERS=0xfff00980
3826	Using timer 1
3827	  tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
3828
3829Hit 'b':
3830	[q, b, e, ?] Set interval 1000000 us
3831	Enabling timer
3832Hit '?':
3833	[q, b, e, ?] ........
3834	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
3835Hit '?':
3836	[q, b, e, ?] .
3837	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
3838Hit '?':
3839	[q, b, e, ?] .
3840	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
3841Hit '?':
3842	[q, b, e, ?] .
3843	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
3844Hit 'e':
3845	[q, b, e, ?] ...Stopping timer
3846Hit 'q':
3847	[q, b, e, ?] ## Application terminated, rc = 0x0
3848
3849
3850Minicom warning:
3851================
3852
3853Over time, many people have reported problems when trying to use the
3854"minicom" terminal emulation program for serial download. I (wd)
3855consider minicom to be broken, and recommend not to use it. Under
3856Unix, I recommend to use C-Kermit for general purpose use (and
3857especially for kermit binary protocol download ("loadb" command), and
3858use "cu" for S-Record download ("loads" command).
3859
3860Nevertheless, if you absolutely want to use it try adding this
3861configuration to your "File transfer protocols" section:
3862
3863	   Name	   Program			Name U/D FullScr IO-Red. Multi
3864	X  kermit  /usr/bin/kermit -i -l %l -s	 Y    U	   Y	   N	  N
3865	Y  kermit  /usr/bin/kermit -i -l %l -r	 N    D	   Y	   N	  N
3866
3867
3868NetBSD Notes:
3869=============
3870
3871Starting at version 0.9.2, U-Boot supports NetBSD both as host
3872(build U-Boot) and target system (boots NetBSD/mpc8xx).
3873
3874Building requires a cross environment; it is known to work on
3875NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
3876need gmake since the Makefiles are not compatible with BSD make).
3877Note that the cross-powerpc package does not install include files;
3878attempting to build U-Boot will fail because <machine/ansi.h> is
3879missing.  This file has to be installed and patched manually:
3880
3881	# cd /usr/pkg/cross/powerpc-netbsd/include
3882	# mkdir powerpc
3883	# ln -s powerpc machine
3884	# cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
3885	# ${EDIT} powerpc/ansi.h	## must remove __va_list, _BSD_VA_LIST
3886
3887Native builds *don't* work due to incompatibilities between native
3888and U-Boot include files.
3889
3890Booting assumes that (the first part of) the image booted is a
3891stage-2 loader which in turn loads and then invokes the kernel
3892proper. Loader sources will eventually appear in the NetBSD source
3893tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
3894meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
3895
3896
3897Implementation Internals:
3898=========================
3899
3900The following is not intended to be a complete description of every
3901implementation detail. However, it should help to understand the
3902inner workings of U-Boot and make it easier to port it to custom
3903hardware.
3904
3905
3906Initial Stack, Global Data:
3907---------------------------
3908
3909The implementation of U-Boot is complicated by the fact that U-Boot
3910starts running out of ROM (flash memory), usually without access to
3911system RAM (because the memory controller is not initialized yet).
3912This means that we don't have writable Data or BSS segments, and BSS
3913is not initialized as zero. To be able to get a C environment working
3914at all, we have to allocate at least a minimal stack. Implementation
3915options for this are defined and restricted by the CPU used: Some CPU
3916models provide on-chip memory (like the IMMR area on MPC8xx and
3917MPC826x processors), on others (parts of) the data cache can be
3918locked as (mis-) used as memory, etc.
3919
3920	Chris Hallinan posted a good summary of these issues to the
3921	U-Boot mailing list:
3922
3923	Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
3924	From: "Chris Hallinan" <clh@net1plus.com>
3925	Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
3926	...
3927
3928	Correct me if I'm wrong, folks, but the way I understand it
3929	is this: Using DCACHE as initial RAM for Stack, etc, does not
3930	require any physical RAM backing up the cache. The cleverness
3931	is that the cache is being used as a temporary supply of
3932	necessary storage before the SDRAM controller is setup. It's
3933	beyond the scope of this list to explain the details, but you
3934	can see how this works by studying the cache architecture and
3935	operation in the architecture and processor-specific manuals.
3936
3937	OCM is On Chip Memory, which I believe the 405GP has 4K. It
3938	is another option for the system designer to use as an
3939	initial stack/RAM area prior to SDRAM being available. Either
3940	option should work for you. Using CS 4 should be fine if your
3941	board designers haven't used it for something that would
3942	cause you grief during the initial boot! It is frequently not
3943	used.
3944
3945	CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
3946	with your processor/board/system design. The default value
3947	you will find in any recent u-boot distribution in
3948	walnut.h should work for you. I'd set it to a value larger
3949	than your SDRAM module. If you have a 64MB SDRAM module, set
3950	it above 400_0000. Just make sure your board has no resources
3951	that are supposed to respond to that address! That code in
3952	start.S has been around a while and should work as is when
3953	you get the config right.
3954
3955	-Chris Hallinan
3956	DS4.COM, Inc.
3957
3958It is essential to remember this, since it has some impact on the C
3959code for the initialization procedures:
3960
3961* Initialized global data (data segment) is read-only. Do not attempt
3962  to write it.
3963
3964* Do not use any uninitialized global data (or implicitely initialized
3965  as zero data - BSS segment) at all - this is undefined, initiali-
3966  zation is performed later (when relocating to RAM).
3967
3968* Stack space is very limited. Avoid big data buffers or things like
3969  that.
3970
3971Having only the stack as writable memory limits means we cannot use
3972normal global data to share information beween the code. But it
3973turned out that the implementation of U-Boot can be greatly
3974simplified by making a global data structure (gd_t) available to all
3975functions. We could pass a pointer to this data as argument to _all_
3976functions, but this would bloat the code. Instead we use a feature of
3977the GCC compiler (Global Register Variables) to share the data: we
3978place a pointer (gd) to the global data into a register which we
3979reserve for this purpose.
3980
3981When choosing a register for such a purpose we are restricted by the
3982relevant  (E)ABI  specifications for the current architecture, and by
3983GCC's implementation.
3984
3985For PowerPC, the following registers have specific use:
3986	R1:	stack pointer
3987	R2:	reserved for system use
3988	R3-R4:	parameter passing and return values
3989	R5-R10: parameter passing
3990	R13:	small data area pointer
3991	R30:	GOT pointer
3992	R31:	frame pointer
3993
3994	(U-Boot also uses R12 as internal GOT pointer. r12
3995	is a volatile register so r12 needs to be reset when
3996	going back and forth between asm and C)
3997
3998    ==> U-Boot will use R2 to hold a pointer to the global data
3999
4000    Note: on PPC, we could use a static initializer (since the
4001    address of the global data structure is known at compile time),
4002    but it turned out that reserving a register results in somewhat
4003    smaller code - although the code savings are not that big (on
4004    average for all boards 752 bytes for the whole U-Boot image,
4005    624 text + 127 data).
4006
4007On Blackfin, the normal C ABI (except for P3) is followed as documented here:
4008	http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
4009
4010    ==> U-Boot will use P3 to hold a pointer to the global data
4011
4012On ARM, the following registers are used:
4013
4014	R0:	function argument word/integer result
4015	R1-R3:	function argument word
4016	R9:	GOT pointer
4017	R10:	stack limit (used only if stack checking if enabled)
4018	R11:	argument (frame) pointer
4019	R12:	temporary workspace
4020	R13:	stack pointer
4021	R14:	link register
4022	R15:	program counter
4023
4024    ==> U-Boot will use R8 to hold a pointer to the global data
4025
4026NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
4027or current versions of GCC may "optimize" the code too much.
4028
4029Memory Management:
4030------------------
4031
4032U-Boot runs in system state and uses physical addresses, i.e. the
4033MMU is not used either for address mapping nor for memory protection.
4034
4035The available memory is mapped to fixed addresses using the memory
4036controller. In this process, a contiguous block is formed for each
4037memory type (Flash, SDRAM, SRAM), even when it consists of several
4038physical memory banks.
4039
4040U-Boot is installed in the first 128 kB of the first Flash bank (on
4041TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
4042booting and sizing and initializing DRAM, the code relocates itself
4043to the upper end of DRAM. Immediately below the U-Boot code some
4044memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
4045configuration setting]. Below that, a structure with global Board
4046Info data is placed, followed by the stack (growing downward).
4047
4048Additionally, some exception handler code is copied to the low 8 kB
4049of DRAM (0x00000000 ... 0x00001FFF).
4050
4051So a typical memory configuration with 16 MB of DRAM could look like
4052this:
4053
4054	0x0000 0000	Exception Vector code
4055	      :
4056	0x0000 1FFF
4057	0x0000 2000	Free for Application Use
4058	      :
4059	      :
4060
4061	      :
4062	      :
4063	0x00FB FF20	Monitor Stack (Growing downward)
4064	0x00FB FFAC	Board Info Data and permanent copy of global data
4065	0x00FC 0000	Malloc Arena
4066	      :
4067	0x00FD FFFF
4068	0x00FE 0000	RAM Copy of Monitor Code
4069	...		eventually: LCD or video framebuffer
4070	...		eventually: pRAM (Protected RAM - unchanged by reset)
4071	0x00FF FFFF	[End of RAM]
4072
4073
4074System Initialization:
4075----------------------
4076
4077In the reset configuration, U-Boot starts at the reset entry point
4078(on most PowerPC systems at address 0x00000100). Because of the reset
4079configuration for CS0# this is a mirror of the onboard Flash memory.
4080To be able to re-map memory U-Boot then jumps to its link address.
4081To be able to implement the initialization code in C, a (small!)
4082initial stack is set up in the internal Dual Ported RAM (in case CPUs
4083which provide such a feature like MPC8xx or MPC8260), or in a locked
4084part of the data cache. After that, U-Boot initializes the CPU core,
4085the caches and the SIU.
4086
4087Next, all (potentially) available memory banks are mapped using a
4088preliminary mapping. For example, we put them on 512 MB boundaries
4089(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
4090on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
4091programmed for SDRAM access. Using the temporary configuration, a
4092simple memory test is run that determines the size of the SDRAM
4093banks.
4094
4095When there is more than one SDRAM bank, and the banks are of
4096different size, the largest is mapped first. For equal size, the first
4097bank (CS2#) is mapped first. The first mapping is always for address
40980x00000000, with any additional banks following immediately to create
4099contiguous memory starting from 0.
4100
4101Then, the monitor installs itself at the upper end of the SDRAM area
4102and allocates memory for use by malloc() and for the global Board
4103Info data; also, the exception vector code is copied to the low RAM
4104pages, and the final stack is set up.
4105
4106Only after this relocation will you have a "normal" C environment;
4107until that you are restricted in several ways, mostly because you are
4108running from ROM, and because the code will have to be relocated to a
4109new address in RAM.
4110
4111
4112U-Boot Porting Guide:
4113----------------------
4114
4115[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
4116list, October 2002]
4117
4118
4119int main(int argc, char *argv[])
4120{
4121	sighandler_t no_more_time;
4122
4123	signal(SIGALRM, no_more_time);
4124	alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
4125
4126	if (available_money > available_manpower) {
4127		Pay consultant to port U-Boot;
4128		return 0;
4129	}
4130
4131	Download latest U-Boot source;
4132
4133	Subscribe to u-boot mailing list;
4134
4135	if (clueless)
4136		email("Hi, I am new to U-Boot, how do I get started?");
4137
4138	while (learning) {
4139		Read the README file in the top level directory;
4140		Read http://www.denx.de/twiki/bin/view/DULG/Manual;
4141		Read applicable doc/*.README;
4142		Read the source, Luke;
4143		/* find . -name "*.[chS]" | xargs grep -i <keyword> */
4144	}
4145
4146	if (available_money > toLocalCurrency ($2500))
4147		Buy a BDI3000;
4148	else
4149		Add a lot of aggravation and time;
4150
4151	if (a similar board exists) {	/* hopefully... */
4152		cp -a board/<similar> board/<myboard>
4153		cp include/configs/<similar>.h include/configs/<myboard>.h
4154	} else {
4155		Create your own board support subdirectory;
4156		Create your own board include/configs/<myboard>.h file;
4157	}
4158	Edit new board/<myboard> files
4159	Edit new include/configs/<myboard>.h
4160
4161	while (!accepted) {
4162		while (!running) {
4163			do {
4164				Add / modify source code;
4165			} until (compiles);
4166			Debug;
4167			if (clueless)
4168				email("Hi, I am having problems...");
4169		}
4170		Send patch file to the U-Boot email list;
4171		if (reasonable critiques)
4172			Incorporate improvements from email list code review;
4173		else
4174			Defend code as written;
4175	}
4176
4177	return 0;
4178}
4179
4180void no_more_time (int sig)
4181{
4182      hire_a_guru();
4183}
4184
4185
4186Coding Standards:
4187-----------------
4188
4189All contributions to U-Boot should conform to the Linux kernel
4190coding style; see the file "Documentation/CodingStyle" and the script
4191"scripts/Lindent" in your Linux kernel source directory.  In sources
4192originating from U-Boot a style corresponding to "Lindent -pcs" (adding
4193spaces before parameters to function calls) is actually used.
4194
4195Source files originating from a different project (for example the
4196MTD subsystem) are generally exempt from these guidelines and are not
4197reformated to ease subsequent migration to newer versions of those
4198sources.
4199
4200Please note that U-Boot is implemented in C (and to some small parts in
4201Assembler); no C++ is used, so please do not use C++ style comments (//)
4202in your code.
4203
4204Please also stick to the following formatting rules:
4205- remove any trailing white space
4206- use TAB characters for indentation, not spaces
4207- make sure NOT to use DOS '\r\n' line feeds
4208- do not add more than 2 empty lines to source files
4209- do not add trailing empty lines to source files
4210
4211Submissions which do not conform to the standards may be returned
4212with a request to reformat the changes.
4213
4214
4215Submitting Patches:
4216-------------------
4217
4218Since the number of patches for U-Boot is growing, we need to
4219establish some rules. Submissions which do not conform to these rules
4220may be rejected, even when they contain important and valuable stuff.
4221
4222Please see http://www.denx.de/wiki/U-Boot/Patches for details.
4223
4224Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
4225see http://lists.denx.de/mailman/listinfo/u-boot
4226
4227When you send a patch, please include the following information with
4228it:
4229
4230* For bug fixes: a description of the bug and how your patch fixes
4231  this bug. Please try to include a way of demonstrating that the
4232  patch actually fixes something.
4233
4234* For new features: a description of the feature and your
4235  implementation.
4236
4237* A CHANGELOG entry as plaintext (separate from the patch)
4238
4239* For major contributions, your entry to the CREDITS file
4240
4241* When you add support for a new board, don't forget to add this
4242  board to the MAKEALL script, too.
4243
4244* If your patch adds new configuration options, don't forget to
4245  document these in the README file.
4246
4247* The patch itself. If you are using git (which is *strongly*
4248  recommended) you can easily generate the patch using the
4249  "git-format-patch". If you then use "git-send-email" to send it to
4250  the U-Boot mailing list, you will avoid most of the common problems
4251  with some other mail clients.
4252
4253  If you cannot use git, use "diff -purN OLD NEW". If your version of
4254  diff does not support these options, then get the latest version of
4255  GNU diff.
4256
4257  The current directory when running this command shall be the parent
4258  directory of the U-Boot source tree (i. e. please make sure that
4259  your patch includes sufficient directory information for the
4260  affected files).
4261
4262  We prefer patches as plain text. MIME attachments are discouraged,
4263  and compressed attachments must not be used.
4264
4265* If one logical set of modifications affects or creates several
4266  files, all these changes shall be submitted in a SINGLE patch file.
4267
4268* Changesets that contain different, unrelated modifications shall be
4269  submitted as SEPARATE patches, one patch per changeset.
4270
4271
4272Notes:
4273
4274* Before sending the patch, run the MAKEALL script on your patched
4275  source tree and make sure that no errors or warnings are reported
4276  for any of the boards.
4277
4278* Keep your modifications to the necessary minimum: A patch
4279  containing several unrelated changes or arbitrary reformats will be
4280  returned with a request to re-formatting / split it.
4281
4282* If you modify existing code, make sure that your new code does not
4283  add to the memory footprint of the code ;-) Small is beautiful!
4284  When adding new features, these should compile conditionally only
4285  (using #ifdef), and the resulting code with the new feature
4286  disabled must not need more memory than the old code without your
4287  modification.
4288
4289* Remember that there is a size limit of 100 kB per message on the
4290  u-boot mailing list. Bigger patches will be moderated. If they are
4291  reasonable and not too big, they will be acknowledged. But patches
4292  bigger than the size limit should be avoided.
4293