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