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