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