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