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