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