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