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