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