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