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