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