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