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