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