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