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