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