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