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