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