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