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