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