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