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