xref: /openbmc/u-boot/README (revision 21d29f7f9f4888a4858b58b368ae7cf8783a6ebf)
1c609719bSwdenk#
2eca3aeb3SWolfgang Denk# (C) Copyright 2000 - 2013
3c609719bSwdenk# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4c609719bSwdenk#
5eca3aeb3SWolfgang Denk# SPDX-License-Identifier:	GPL-2.0+
6c609719bSwdenk#
7c609719bSwdenk
8c609719bSwdenkSummary:
9c609719bSwdenk========
10c609719bSwdenk
1124ee89b9SwdenkThis directory contains the source code for U-Boot, a boot loader for
12e86e5a07SwdenkEmbedded boards based on PowerPC, ARM, MIPS and several other
13e86e5a07Swdenkprocessors, which can be installed in a boot ROM and used to
14e86e5a07Swdenkinitialize and test the hardware or to download and run application
15e86e5a07Swdenkcode.
16c609719bSwdenk
17c609719bSwdenkThe development of U-Boot is closely related to Linux: some parts of
1824ee89b9Swdenkthe source code originate in the Linux source tree, we have some
1924ee89b9Swdenkheader files in common, and special provision has been made to
20c609719bSwdenksupport booting of Linux images.
21c609719bSwdenk
22c609719bSwdenkSome attention has been paid to make this software easily
23c609719bSwdenkconfigurable and extendable. For instance, all monitor commands are
24c609719bSwdenkimplemented with the same call interface, so that it's very easy to
25c609719bSwdenkadd new commands. Also, instead of permanently adding rarely used
26c609719bSwdenkcode (for instance hardware test utilities) to the monitor, you can
27c609719bSwdenkload and run it dynamically.
28c609719bSwdenk
29c609719bSwdenk
30c609719bSwdenkStatus:
31c609719bSwdenk=======
32c609719bSwdenk
33c609719bSwdenkIn general, all boards for which a configuration option exists in the
34c609719bSwdenkMakefile have been tested to some extent and can be considered
35c609719bSwdenk"working". In fact, many of them are used in production systems.
36c609719bSwdenk
37c609719bSwdenkIn case of problems see the CHANGELOG and CREDITS files to find out
3827af930eSAlbert ARIBAUDwho contributed the specific port. The boards.cfg file lists board
39218ca724SWolfgang Denkmaintainers.
40c609719bSwdenk
41adb9d851SRobert P. J. DayNote: There is no CHANGELOG file in the actual U-Boot source tree;
42adb9d851SRobert P. J. Dayit can be created dynamically from the Git log using:
43adb9d851SRobert P. J. Day
44adb9d851SRobert P. J. Day	make CHANGELOG
45adb9d851SRobert P. J. Day
46c609719bSwdenk
47c609719bSwdenkWhere to get help:
48c609719bSwdenk==================
49c609719bSwdenk
50c609719bSwdenkIn case you have questions about, problems with or contributions for
51c609719bSwdenkU-Boot you should send a message to the U-Boot mailing list at
520c32565fSPeter Tyser<u-boot@lists.denx.de>. There is also an archive of previous traffic
530c32565fSPeter Tyseron the mailing list - please search the archive before asking FAQ's.
540c32565fSPeter TyserPlease see http://lists.denx.de/pipermail/u-boot and
550c32565fSPeter Tyserhttp://dir.gmane.org/gmane.comp.boot-loaders.u-boot
56c609719bSwdenk
57c609719bSwdenk
58218ca724SWolfgang DenkWhere to get source code:
59218ca724SWolfgang Denk=========================
60218ca724SWolfgang Denk
61218ca724SWolfgang DenkThe U-Boot source code is maintained in the git repository at
62218ca724SWolfgang Denkgit://www.denx.de/git/u-boot.git ; you can browse it online at
63218ca724SWolfgang Denkhttp://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
64218ca724SWolfgang Denk
65218ca724SWolfgang DenkThe "snapshot" links on this page allow you to download tarballs of
6611ccc33fSMarcel Ziswilerany version you might be interested in. Official releases are also
67218ca724SWolfgang Denkavailable for FTP download from the ftp://ftp.denx.de/pub/u-boot/
68218ca724SWolfgang Denkdirectory.
69218ca724SWolfgang Denk
70d4ee711dSAnatolij GustschinPre-built (and tested) images are available from
71218ca724SWolfgang Denkftp://ftp.denx.de/pub/u-boot/images/
72218ca724SWolfgang Denk
73218ca724SWolfgang Denk
74c609719bSwdenkWhere we come from:
75c609719bSwdenk===================
76c609719bSwdenk
77c609719bSwdenk- start from 8xxrom sources
7824ee89b9Swdenk- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
79c609719bSwdenk- clean up code
80c609719bSwdenk- make it easier to add custom boards
81c609719bSwdenk- make it possible to add other [PowerPC] CPUs
82c609719bSwdenk- extend functions, especially:
83c609719bSwdenk  * Provide extended interface to Linux boot loader
84c609719bSwdenk  * S-Record download
85c609719bSwdenk  * network boot
8611ccc33fSMarcel Ziswiler  * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
8724ee89b9Swdenk- create ARMBoot project (http://sourceforge.net/projects/armboot)
88c609719bSwdenk- add other CPU families (starting with ARM)
8924ee89b9Swdenk- create U-Boot project (http://sourceforge.net/projects/u-boot)
900d28f34bSMagnus Lilja- current project page: see http://www.denx.de/wiki/U-Boot
9124ee89b9Swdenk
9224ee89b9Swdenk
9324ee89b9SwdenkNames and Spelling:
9424ee89b9Swdenk===================
9524ee89b9Swdenk
9624ee89b9SwdenkThe "official" name of this project is "Das U-Boot". The spelling
9724ee89b9Swdenk"U-Boot" shall be used in all written text (documentation, comments
9824ee89b9Swdenkin source files etc.). Example:
9924ee89b9Swdenk
10024ee89b9Swdenk	This is the README file for the U-Boot project.
10124ee89b9Swdenk
10224ee89b9SwdenkFile names etc. shall be based on the string "u-boot". Examples:
10324ee89b9Swdenk
10424ee89b9Swdenk	include/asm-ppc/u-boot.h
10524ee89b9Swdenk
10624ee89b9Swdenk	#include <asm/u-boot.h>
10724ee89b9Swdenk
10824ee89b9SwdenkVariable names, preprocessor constants etc. shall be either based on
10924ee89b9Swdenkthe string "u_boot" or on "U_BOOT". Example:
11024ee89b9Swdenk
11124ee89b9Swdenk	U_BOOT_VERSION		u_boot_logo
11224ee89b9Swdenk	IH_OS_U_BOOT		u_boot_hush_start
113c609719bSwdenk
114c609719bSwdenk
11593f19cc0SwdenkVersioning:
11693f19cc0Swdenk===========
11793f19cc0Swdenk
118360d883aSThomas WeberStarting with the release in October 2008, the names of the releases
119360d883aSThomas Weberwere changed from numerical release numbers without deeper meaning
120360d883aSThomas Weberinto a time stamp based numbering. Regular releases are identified by
121360d883aSThomas Webernames consisting of the calendar year and month of the release date.
122360d883aSThomas WeberAdditional fields (if present) indicate release candidates or bug fix
123360d883aSThomas Weberreleases in "stable" maintenance trees.
12493f19cc0Swdenk
125360d883aSThomas WeberExamples:
126360d883aSThomas Weber	U-Boot v2009.11	    - Release November 2009
127360d883aSThomas Weber	U-Boot v2009.11.1   - Release 1 in version November 2009 stable tree
128360d883aSThomas Weber	U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release
12993f19cc0Swdenk
13093f19cc0Swdenk
131c609719bSwdenkDirectory Hierarchy:
132c609719bSwdenk====================
133c609719bSwdenk
1348d321b81SPeter Tyser/arch			Architecture specific files
1356eae68e4SMasahiro Yamada  /arc			Files generic to ARC architecture
1366eae68e4SMasahiro Yamada    /cpu		CPU specific files
1376eae68e4SMasahiro Yamada      /arc700		Files specific to ARC 700 CPUs
1386eae68e4SMasahiro Yamada    /lib		Architecture specific library files
1398d321b81SPeter Tyser  /arm			Files generic to ARM architecture
1408d321b81SPeter Tyser    /cpu		CPU specific files
1418d321b81SPeter Tyser      /arm720t		Files specific to ARM 720 CPUs
1428d321b81SPeter Tyser      /arm920t		Files specific to ARM 920 CPUs
1436eb0921aSAndreas Bießmann	/at91		Files specific to Atmel AT91RM9200 CPU
1448d321b81SPeter Tyser	/imx		Files specific to Freescale MC9328 i.MX CPUs
1458d321b81SPeter Tyser	/s3c24x0	Files specific to Samsung S3C24X0 CPUs
1468d321b81SPeter Tyser      /arm926ejs	Files specific to ARM 926 CPUs
1478d321b81SPeter Tyser      /arm1136		Files specific to ARM 1136 CPUs
1488d321b81SPeter Tyser      /pxa		Files specific to Intel XScale PXA CPUs
1498d321b81SPeter Tyser      /sa1100		Files specific to Intel StrongARM SA1100 CPUs
1508d321b81SPeter Tyser    /lib		Architecture specific library files
1518d321b81SPeter Tyser  /avr32		Files generic to AVR32 architecture
1528d321b81SPeter Tyser    /cpu		CPU specific files
1538d321b81SPeter Tyser    /lib		Architecture specific library files
1548d321b81SPeter Tyser  /blackfin		Files generic to Analog Devices Blackfin architecture
1558d321b81SPeter Tyser    /cpu		CPU specific files
1568d321b81SPeter Tyser    /lib		Architecture specific library files
1578d321b81SPeter Tyser  /m68k			Files generic to m68k architecture
1588d321b81SPeter Tyser    /cpu		CPU specific files
1598d321b81SPeter Tyser      /mcf52x2		Files specific to Freescale ColdFire MCF52x2 CPUs
1608d321b81SPeter Tyser      /mcf5227x		Files specific to Freescale ColdFire MCF5227x CPUs
1618d321b81SPeter Tyser      /mcf532x		Files specific to Freescale ColdFire MCF5329 CPUs
1628d321b81SPeter Tyser      /mcf5445x		Files specific to Freescale ColdFire MCF5445x CPUs
1638d321b81SPeter Tyser      /mcf547x_8x	Files specific to Freescale ColdFire MCF547x_8x CPUs
1648d321b81SPeter Tyser    /lib		Architecture specific library files
1658d321b81SPeter Tyser  /microblaze		Files generic to microblaze architecture
1668d321b81SPeter Tyser    /cpu		CPU specific files
1678d321b81SPeter Tyser    /lib		Architecture specific library files
1688d321b81SPeter Tyser  /mips			Files generic to MIPS architecture
1698d321b81SPeter Tyser    /cpu		CPU specific files
17092bbd64eSDaniel Schwierzeck      /mips32		Files specific to MIPS32 CPUs
1716eae68e4SMasahiro Yamada      /mips64		Files specific to MIPS64 CPUs
1728d321b81SPeter Tyser    /lib		Architecture specific library files
173afc1ce82SMacpaul Lin  /nds32		Files generic to NDS32 architecture
174afc1ce82SMacpaul Lin    /cpu		CPU specific files
175afc1ce82SMacpaul Lin      /n1213		Files specific to Andes Technology N1213 CPUs
176afc1ce82SMacpaul Lin    /lib		Architecture specific library files
1778d321b81SPeter Tyser  /nios2		Files generic to Altera NIOS2 architecture
1788d321b81SPeter Tyser    /cpu		CPU specific files
1798d321b81SPeter Tyser    /lib		Architecture specific library files
18033c7731bSRobert P. J. Day  /openrisc		Files generic to OpenRISC architecture
18133c7731bSRobert P. J. Day    /cpu		CPU specific files
18233c7731bSRobert P. J. Day    /lib		Architecture specific library files
183a47a12beSStefan Roese  /powerpc		Files generic to PowerPC architecture
1848d321b81SPeter Tyser    /cpu		CPU specific files
1858d321b81SPeter Tyser      /74xx_7xx		Files specific to Freescale MPC74xx and 7xx CPUs
1868d321b81SPeter Tyser      /mpc5xx		Files specific to Freescale MPC5xx CPUs
1878d321b81SPeter Tyser      /mpc5xxx		Files specific to Freescale MPC5xxx CPUs
1888d321b81SPeter Tyser      /mpc8xx		Files specific to Freescale MPC8xx CPUs
1898d321b81SPeter Tyser      /mpc824x		Files specific to Freescale MPC824x CPUs
1908d321b81SPeter Tyser      /mpc8260		Files specific to Freescale MPC8260 CPUs
1918d321b81SPeter Tyser      /mpc85xx		Files specific to Freescale MPC85xx CPUs
1928d321b81SPeter Tyser      /ppc4xx		Files specific to AMCC PowerPC 4xx CPUs
1938d321b81SPeter Tyser    /lib		Architecture specific library files
1948d321b81SPeter Tyser  /sh			Files generic to SH architecture
1958d321b81SPeter Tyser    /cpu		CPU specific files
1968d321b81SPeter Tyser      /sh2		Files specific to sh2 CPUs
1978d321b81SPeter Tyser      /sh3		Files specific to sh3 CPUs
1988d321b81SPeter Tyser      /sh4		Files specific to sh4 CPUs
1998d321b81SPeter Tyser    /lib		Architecture specific library files
2008d321b81SPeter Tyser  /sparc		Files generic to SPARC architecture
2018d321b81SPeter Tyser    /cpu		CPU specific files
2028d321b81SPeter Tyser      /leon2		Files specific to Gaisler LEON2 SPARC CPU
2038d321b81SPeter Tyser      /leon3		Files specific to Gaisler LEON3 SPARC CPU
2048d321b81SPeter Tyser    /lib		Architecture specific library files
20533c7731bSRobert P. J. Day  /x86			Files generic to x86 architecture
20633c7731bSRobert P. J. Day    /cpu		CPU specific files
20733c7731bSRobert P. J. Day    /lib		Architecture specific library files
2088d321b81SPeter Tyser/api			Machine/arch independent API for external apps
2098d321b81SPeter Tyser/board			Board dependent files
2108d321b81SPeter Tyser/common			Misc architecture independent functions
2118d321b81SPeter Tyser/disk			Code for disk drive partition handling
2128d321b81SPeter Tyser/doc			Documentation (don't expect too much)
2138d321b81SPeter Tyser/drivers		Commonly used device drivers
21433c7731bSRobert P. J. Day/dts			Contains Makefile for building internal U-Boot fdt.
2158d321b81SPeter Tyser/examples		Example code for standalone applications, etc.
2168d321b81SPeter Tyser/fs			Filesystem code (cramfs, ext2, jffs2, etc.)
2178d321b81SPeter Tyser/include		Header Files
2188d321b81SPeter Tyser/lib			Files generic to all architectures
2198d321b81SPeter Tyser  /libfdt		Library files to support flattened device trees
2208d321b81SPeter Tyser  /lzma			Library files to support LZMA decompression
2218d321b81SPeter Tyser  /lzo			Library files to support LZO decompression
2228d321b81SPeter Tyser/net			Networking code
2238d321b81SPeter Tyser/post			Power On Self Test
22433c7731bSRobert P. J. Day/spl			Secondary Program Loader framework
2258d321b81SPeter Tyser/tools			Tools to build S-Record or U-Boot images, etc.
226c609719bSwdenk
227c609719bSwdenkSoftware Configuration:
228c609719bSwdenk=======================
229c609719bSwdenk
230c609719bSwdenkConfiguration is usually done using C preprocessor defines; the
231c609719bSwdenkrationale behind that is to avoid dead code whenever possible.
232c609719bSwdenk
233c609719bSwdenkThere are two classes of configuration variables:
234c609719bSwdenk
235c609719bSwdenk* Configuration _OPTIONS_:
236c609719bSwdenk  These are selectable by the user and have names beginning with
237c609719bSwdenk  "CONFIG_".
238c609719bSwdenk
239c609719bSwdenk* Configuration _SETTINGS_:
240c609719bSwdenk  These depend on the hardware etc. and should not be meddled with if
241c609719bSwdenk  you don't know what you're doing; they have names beginning with
2426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  "CONFIG_SYS_".
243c609719bSwdenk
244c609719bSwdenkLater we will add a configuration tool - probably similar to or even
245c609719bSwdenkidentical to what's used for the Linux kernel. Right now, we have to
246c609719bSwdenkdo the configuration by hand, which means creating some symbolic
247c609719bSwdenklinks and editing some configuration files. We use the TQM8xxL boards
248c609719bSwdenkas an example here.
249c609719bSwdenk
250c609719bSwdenk
251c609719bSwdenkSelection of Processor Architecture and Board Type:
252c609719bSwdenk---------------------------------------------------
253c609719bSwdenk
254c609719bSwdenkFor all supported boards there are ready-to-use default
255c609719bSwdenkconfigurations available; just type "make <board_name>_config".
256c609719bSwdenk
257c609719bSwdenkExample: For a TQM823L module type:
258c609719bSwdenk
259c609719bSwdenk	cd u-boot
260c609719bSwdenk	make TQM823L_config
261c609719bSwdenk
26211ccc33fSMarcel ZiswilerFor the Cogent platform, you need to specify the CPU type as well;
263c609719bSwdenke.g. "make cogent_mpc8xx_config". And also configure the cogent
264c609719bSwdenkdirectory according to the instructions in cogent/README.
265c609719bSwdenk
266c609719bSwdenk
26775b3c3aaSSimon GlassSandbox Environment:
26875b3c3aaSSimon Glass--------------------
26975b3c3aaSSimon Glass
27075b3c3aaSSimon GlassU-Boot can be built natively to run on a Linux host using the 'sandbox'
27175b3c3aaSSimon Glassboard. This allows feature development which is not board- or architecture-
27275b3c3aaSSimon Glassspecific to be undertaken on a native platform. The sandbox is also used to
27375b3c3aaSSimon Glassrun some of U-Boot's tests.
27475b3c3aaSSimon Glass
27575b3c3aaSSimon GlassSee board/sandbox/sandbox/README.sandbox for more details.
27675b3c3aaSSimon Glass
27775b3c3aaSSimon Glass
278c609719bSwdenkConfiguration Options:
279c609719bSwdenk----------------------
280c609719bSwdenk
281c609719bSwdenkConfiguration depends on the combination of board and CPU type; all
282c609719bSwdenksuch information is kept in a configuration file
283c609719bSwdenk"include/configs/<board_name>.h".
284c609719bSwdenk
285c609719bSwdenkExample: For a TQM823L module, all configuration settings are in
286c609719bSwdenk"include/configs/TQM823L.h".
287c609719bSwdenk
288c609719bSwdenk
2897f6c2cbcSwdenkMany of the options are named exactly as the corresponding Linux
2907f6c2cbcSwdenkkernel configuration options. The intention is to make it easier to
2917f6c2cbcSwdenkbuild a config tool - later.
2927f6c2cbcSwdenk
2937f6c2cbcSwdenk
294c609719bSwdenkThe following options need to be configured:
295c609719bSwdenk
2962628114eSKim Phillips- CPU Type:	Define exactly one, e.g. CONFIG_MPC85XX.
297c609719bSwdenk
2982628114eSKim Phillips- Board Type:	Define exactly one, e.g. CONFIG_MPC8540ADS.
2996ccec449SWolfgang Denk
3006ccec449SWolfgang Denk- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
30109ea0de0SHaavard Skinnemoen		Define exactly one, e.g. CONFIG_ATSTK1002
302c609719bSwdenk
303c609719bSwdenk- CPU Module Type: (if CONFIG_COGENT is defined)
304c609719bSwdenk		Define exactly one of
305c609719bSwdenk		CONFIG_CMA286_60_OLD
306c609719bSwdenk--- FIXME --- not tested yet:
307c609719bSwdenk		CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
308c609719bSwdenk		CONFIG_CMA287_23, CONFIG_CMA287_50
309c609719bSwdenk
310c609719bSwdenk- Motherboard Type: (if CONFIG_COGENT is defined)
311c609719bSwdenk		Define exactly one of
312c609719bSwdenk		CONFIG_CMA101, CONFIG_CMA102
313c609719bSwdenk
314c609719bSwdenk- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
315c609719bSwdenk		Define one or more of
316c609719bSwdenk		CONFIG_CMA302
317c609719bSwdenk
318c609719bSwdenk- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
319c609719bSwdenk		Define one or more of
320c609719bSwdenk		CONFIG_LCD_HEARTBEAT	- update a character position on
32111ccc33fSMarcel Ziswiler					  the LCD display every second with
322c609719bSwdenk					  a "rotator" |\-/|\-/
323c609719bSwdenk
324cf946c6dSLei Wen- Marvell Family Member
325cf946c6dSLei Wen		CONFIG_SYS_MVFS		- define it if you want to enable
326cf946c6dSLei Wen					  multiple fs option at one time
327cf946c6dSLei Wen					  for marvell soc family
328cf946c6dSLei Wen
329c609719bSwdenk- MPC824X Family Member (if CONFIG_MPC824X is defined)
330c609719bSwdenk		Define exactly one of
331c609719bSwdenk		CONFIG_MPC8240, CONFIG_MPC8245
332c609719bSwdenk
33311ccc33fSMarcel Ziswiler- 8xx CPU Options: (if using an MPC8xx CPU)
33466ca92a5Swdenk		CONFIG_8xx_GCLK_FREQ	- deprecated: CPU clock if
33566ca92a5Swdenk					  get_gclk_freq() cannot work
3365da627a4Swdenk					  e.g. if there is no 32KHz
3375da627a4Swdenk					  reference PIT/RTC clock
33866ca92a5Swdenk		CONFIG_8xx_OSCLK	- PLL input clock (either EXTCLK
33966ca92a5Swdenk					  or XTAL/EXTAL)
340c609719bSwdenk
34166ca92a5Swdenk- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
3426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MIN
3436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MAX
34466ca92a5Swdenk		CONFIG_8xx_CPUCLK_DEFAULT
34575d1ea7fSwdenk			See doc/README.MPC866
34675d1ea7fSwdenk
3476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MEASURE_CPUCLK
34875d1ea7fSwdenk
34975d1ea7fSwdenk		Define this to measure the actual CPU clock instead
35075d1ea7fSwdenk		of relying on the correctness of the configured
35175d1ea7fSwdenk		values. Mostly useful for board bringup to make sure
35275d1ea7fSwdenk		the PLL is locked at the intended frequency. Note
35375d1ea7fSwdenk		that this requires a (stable) reference clock (32 kHz
3546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		RTC clock or CONFIG_SYS_8XX_XIN)
35575d1ea7fSwdenk
356506f3918SHeiko Schocher		CONFIG_SYS_DELAYED_ICACHE
357506f3918SHeiko Schocher
358506f3918SHeiko Schocher		Define this option if you want to enable the
359506f3918SHeiko Schocher		ICache only when Code runs from RAM.
360506f3918SHeiko Schocher
36166412c63SKumar Gala- 85xx CPU Options:
362ffd06e02SYork Sun		CONFIG_SYS_PPC64
363ffd06e02SYork Sun
364ffd06e02SYork Sun		Specifies that the core is a 64-bit PowerPC implementation (implements
365ffd06e02SYork Sun		the "64" category of the Power ISA). This is necessary for ePAPR
366ffd06e02SYork Sun		compliance, among other possible reasons.
367ffd06e02SYork Sun
36866412c63SKumar Gala		CONFIG_SYS_FSL_TBCLK_DIV
36966412c63SKumar Gala
37066412c63SKumar Gala		Defines the core time base clock divider ratio compared to the
37166412c63SKumar Gala		system clock.  On most PQ3 devices this is 8, on newer QorIQ
37266412c63SKumar Gala		devices it can be 16 or 32.  The ratio varies from SoC to Soc.
37366412c63SKumar Gala
3748f29084aSKumar Gala		CONFIG_SYS_FSL_PCIE_COMPAT
3758f29084aSKumar Gala
3768f29084aSKumar Gala		Defines the string to utilize when trying to match PCIe device
3778f29084aSKumar Gala		tree nodes for the given platform.
3788f29084aSKumar Gala
379afa6b551SPrabhakar Kushwaha		CONFIG_SYS_PPC_E500_DEBUG_TLB
380afa6b551SPrabhakar Kushwaha
381afa6b551SPrabhakar Kushwaha		Enables a temporary TLB entry to be used during boot to work
382afa6b551SPrabhakar Kushwaha		around limitations in e500v1 and e500v2 external debugger
383afa6b551SPrabhakar Kushwaha		support. This reduces the portions of the boot code where
384afa6b551SPrabhakar Kushwaha		breakpoints and single stepping do not work.  The value of this
385afa6b551SPrabhakar Kushwaha		symbol should be set to the TLB1 entry to be used for this
386afa6b551SPrabhakar Kushwaha		purpose.
387afa6b551SPrabhakar Kushwaha
38833eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510
38933eee330SScott Wood
39033eee330SScott Wood		Enables a workaround for erratum A004510.  If set,
39133eee330SScott Wood		then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
39233eee330SScott Wood		CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
39333eee330SScott Wood
39433eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
39533eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
39633eee330SScott Wood
39733eee330SScott Wood		Defines one or two SoC revisions (low 8 bits of SVR)
39833eee330SScott Wood		for which the A004510 workaround should be applied.
39933eee330SScott Wood
40033eee330SScott Wood		The rest of SVR is either not relevant to the decision
40133eee330SScott Wood		of whether the erratum is present (e.g. p2040 versus
40233eee330SScott Wood		p2041) or is implied by the build target, which controls
40333eee330SScott Wood		whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
40433eee330SScott Wood
40533eee330SScott Wood		See Freescale App Note 4493 for more information about
40633eee330SScott Wood		this erratum.
40733eee330SScott Wood
40874fa22edSPrabhakar Kushwaha		CONFIG_A003399_NOR_WORKAROUND
40974fa22edSPrabhakar Kushwaha		Enables a workaround for IFC erratum A003399. It is only
41074fa22edSPrabhakar Kushwaha		requred during NOR boot.
41174fa22edSPrabhakar Kushwaha
41233eee330SScott Wood		CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
41333eee330SScott Wood
41433eee330SScott Wood		This is the value to write into CCSR offset 0x18600
41533eee330SScott Wood		according to the A004510 workaround.
41633eee330SScott Wood
41764501c66SPriyanka Jain		CONFIG_SYS_FSL_DSP_DDR_ADDR
41864501c66SPriyanka Jain		This value denotes start offset of DDR memory which is
41964501c66SPriyanka Jain		connected exclusively to the DSP cores.
42064501c66SPriyanka Jain
421765b0bdbSPriyanka Jain		CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
422765b0bdbSPriyanka Jain		This value denotes start offset of M2 memory
423765b0bdbSPriyanka Jain		which is directly connected to the DSP core.
424765b0bdbSPriyanka Jain
42564501c66SPriyanka Jain		CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
42664501c66SPriyanka Jain		This value denotes start offset of M3 memory which is directly
42764501c66SPriyanka Jain		connected to the DSP core.
42864501c66SPriyanka Jain
429765b0bdbSPriyanka Jain		CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
430765b0bdbSPriyanka Jain		This value denotes start offset of DSP CCSR space.
431765b0bdbSPriyanka Jain
432b135991aSPriyanka Jain		CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
433b135991aSPriyanka Jain		Single Source Clock is clocking mode present in some of FSL SoC's.
434b135991aSPriyanka Jain		In this mode, a single differential clock is used to supply
435b135991aSPriyanka Jain		clocks to the sysclock, ddrclock and usbclock.
436b135991aSPriyanka Jain
437fb4a2409SAneesh Bansal		CONFIG_SYS_CPC_REINIT_F
438fb4a2409SAneesh Bansal		This CONFIG is defined when the CPC is configured as SRAM at the
439fb4a2409SAneesh Bansal		time of U-boot entry and is required to be re-initialized.
440fb4a2409SAneesh Bansal
441aade2004STang Yuantian		CONFIG_DEEP_SLEEP
442aade2004STang Yuantian		Inidcates this SoC supports deep sleep feature. If deep sleep is
443aade2004STang Yuantian		supported, core will start to execute uboot when wakes up.
444aade2004STang Yuantian
4456cb461b4SDaniel Schwierzeck- Generic CPU options:
4462a1680e3SYork Sun		CONFIG_SYS_GENERIC_GLOBAL_DATA
4472a1680e3SYork Sun		Defines global data is initialized in generic board board_init_f().
4482a1680e3SYork Sun		If this macro is defined, global data is created and cleared in
4492a1680e3SYork Sun		generic board board_init_f(). Without this macro, architecture/board
4502a1680e3SYork Sun		should initialize global data before calling board_init_f().
4512a1680e3SYork Sun
4526cb461b4SDaniel Schwierzeck		CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
4536cb461b4SDaniel Schwierzeck
4546cb461b4SDaniel Schwierzeck		Defines the endianess of the CPU. Implementation of those
4556cb461b4SDaniel Schwierzeck		values is arch specific.
4566cb461b4SDaniel Schwierzeck
4575614e71bSYork Sun		CONFIG_SYS_FSL_DDR
4585614e71bSYork Sun		Freescale DDR driver in use. This type of DDR controller is
4595614e71bSYork Sun		found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
4605614e71bSYork Sun		SoCs.
4615614e71bSYork Sun
4625614e71bSYork Sun		CONFIG_SYS_FSL_DDR_ADDR
4635614e71bSYork Sun		Freescale DDR memory-mapped register base.
4645614e71bSYork Sun
4655614e71bSYork Sun		CONFIG_SYS_FSL_DDR_EMU
4665614e71bSYork Sun		Specify emulator support for DDR. Some DDR features such as
4675614e71bSYork Sun		deskew training are not available.
4685614e71bSYork Sun
4695614e71bSYork Sun		CONFIG_SYS_FSL_DDRC_GEN1
4705614e71bSYork Sun		Freescale DDR1 controller.
4715614e71bSYork Sun
4725614e71bSYork Sun		CONFIG_SYS_FSL_DDRC_GEN2
4735614e71bSYork Sun		Freescale DDR2 controller.
4745614e71bSYork Sun
4755614e71bSYork Sun		CONFIG_SYS_FSL_DDRC_GEN3
4765614e71bSYork Sun		Freescale DDR3 controller.
4775614e71bSYork Sun
47834e026f9SYork Sun		CONFIG_SYS_FSL_DDRC_GEN4
47934e026f9SYork Sun		Freescale DDR4 controller.
48034e026f9SYork Sun
4819ac4ffbdSYork Sun		CONFIG_SYS_FSL_DDRC_ARM_GEN3
4829ac4ffbdSYork Sun		Freescale DDR3 controller for ARM-based SoCs.
4839ac4ffbdSYork Sun
4845614e71bSYork Sun		CONFIG_SYS_FSL_DDR1
4855614e71bSYork Sun		Board config to use DDR1. It can be enabled for SoCs with
4865614e71bSYork Sun		Freescale DDR1 or DDR2 controllers, depending on the board
4875614e71bSYork Sun		implemetation.
4885614e71bSYork Sun
4895614e71bSYork Sun		CONFIG_SYS_FSL_DDR2
4905614e71bSYork Sun		Board config to use DDR2. It can be eanbeld for SoCs with
4915614e71bSYork Sun		Freescale DDR2 or DDR3 controllers, depending on the board
4925614e71bSYork Sun		implementation.
4935614e71bSYork Sun
4945614e71bSYork Sun		CONFIG_SYS_FSL_DDR3
4955614e71bSYork Sun		Board config to use DDR3. It can be enabled for SoCs with
49634e026f9SYork Sun		Freescale DDR3 or DDR3L controllers.
49734e026f9SYork Sun
49834e026f9SYork Sun		CONFIG_SYS_FSL_DDR3L
49934e026f9SYork Sun		Board config to use DDR3L. It can be enabled for SoCs with
50034e026f9SYork Sun		DDR3L controllers.
50134e026f9SYork Sun
50234e026f9SYork Sun		CONFIG_SYS_FSL_DDR4
50334e026f9SYork Sun		Board config to use DDR4. It can be enabled for SoCs with
50434e026f9SYork Sun		DDR4 controllers.
5055614e71bSYork Sun
5061b4175d6SPrabhakar Kushwaha		CONFIG_SYS_FSL_IFC_BE
5071b4175d6SPrabhakar Kushwaha		Defines the IFC controller register space as Big Endian
5081b4175d6SPrabhakar Kushwaha
5091b4175d6SPrabhakar Kushwaha		CONFIG_SYS_FSL_IFC_LE
5101b4175d6SPrabhakar Kushwaha		Defines the IFC controller register space as Little Endian
5111b4175d6SPrabhakar Kushwaha
512690e4258SPrabhakar Kushwaha		CONFIG_SYS_FSL_PBL_PBI
513690e4258SPrabhakar Kushwaha		It enables addition of RCW (Power on reset configuration) in built image.
514690e4258SPrabhakar Kushwaha		Please refer doc/README.pblimage for more details
515690e4258SPrabhakar Kushwaha
516690e4258SPrabhakar Kushwaha		CONFIG_SYS_FSL_PBL_RCW
517690e4258SPrabhakar Kushwaha		It adds PBI(pre-boot instructions) commands in u-boot build image.
518690e4258SPrabhakar Kushwaha		PBI commands can be used to configure SoC before it starts the execution.
519690e4258SPrabhakar Kushwaha		Please refer doc/README.pblimage for more details
520690e4258SPrabhakar Kushwaha
52189ad7be8SPrabhakar Kushwaha		CONFIG_SPL_FSL_PBL
52289ad7be8SPrabhakar Kushwaha		It adds a target to create boot binary having SPL binary in PBI format
52389ad7be8SPrabhakar Kushwaha		concatenated with u-boot binary.
52489ad7be8SPrabhakar Kushwaha
5254e5b1bd0SYork Sun		CONFIG_SYS_FSL_DDR_BE
5264e5b1bd0SYork Sun		Defines the DDR controller register space as Big Endian
5274e5b1bd0SYork Sun
5284e5b1bd0SYork Sun		CONFIG_SYS_FSL_DDR_LE
5294e5b1bd0SYork Sun		Defines the DDR controller register space as Little Endian
5304e5b1bd0SYork Sun
5316b9e309aSYork Sun		CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
5326b9e309aSYork Sun		Physical address from the view of DDR controllers. It is the
5336b9e309aSYork Sun		same as CONFIG_SYS_DDR_SDRAM_BASE for  all Power SoCs. But
5346b9e309aSYork Sun		it could be different for ARM SoCs.
5356b9e309aSYork Sun
5366b1e1254SYork Sun		CONFIG_SYS_FSL_DDR_INTLV_256B
5376b1e1254SYork Sun		DDR controller interleaving on 256-byte. This is a special
5386b1e1254SYork Sun		interleaving mode, handled by Dickens for Freescale layerscape
5396b1e1254SYork Sun		SoCs with ARM core.
5406b1e1254SYork Sun
5410b953ffcSMarkus Klotzbuecher- Intel Monahans options:
5426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
5430b953ffcSMarkus Klotzbuecher
5440b953ffcSMarkus Klotzbuecher		Defines the Monahans run mode to oscillator
5450b953ffcSMarkus Klotzbuecher		ratio. Valid values are 8, 16, 24, 31. The core
5460b953ffcSMarkus Klotzbuecher		frequency is this value multiplied by 13 MHz.
5470b953ffcSMarkus Klotzbuecher
5486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
5490b953ffcSMarkus Klotzbuecher
5500b953ffcSMarkus Klotzbuecher		Defines the Monahans turbo mode to oscillator
5510b953ffcSMarkus Klotzbuecher		ratio. Valid values are 1 (default if undefined) and
5520b953ffcSMarkus Klotzbuecher		2. The core frequency as calculated above is multiplied
5530b953ffcSMarkus Klotzbuecher		by this value.
5540b953ffcSMarkus Klotzbuecher
55592bbd64eSDaniel Schwierzeck- MIPS CPU options:
55692bbd64eSDaniel Schwierzeck		CONFIG_SYS_INIT_SP_OFFSET
55792bbd64eSDaniel Schwierzeck
55892bbd64eSDaniel Schwierzeck		Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
55992bbd64eSDaniel Schwierzeck		pointer. This is needed for the temporary stack before
56092bbd64eSDaniel Schwierzeck		relocation.
56192bbd64eSDaniel Schwierzeck
56292bbd64eSDaniel Schwierzeck		CONFIG_SYS_MIPS_CACHE_MODE
56392bbd64eSDaniel Schwierzeck
56492bbd64eSDaniel Schwierzeck		Cache operation mode for the MIPS CPU.
56592bbd64eSDaniel Schwierzeck		See also arch/mips/include/asm/mipsregs.h.
56692bbd64eSDaniel Schwierzeck		Possible values are:
56792bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_NO_WA
56892bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_WA
56992bbd64eSDaniel Schwierzeck			CONF_CM_UNCACHED
57092bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_NONCOHERENT
57192bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_CE
57292bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_COW
57392bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_CUW
57492bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_ACCELERATED
57592bbd64eSDaniel Schwierzeck
57692bbd64eSDaniel Schwierzeck		CONFIG_SYS_XWAY_EBU_BOOTCFG
57792bbd64eSDaniel Schwierzeck
57892bbd64eSDaniel Schwierzeck		Special option for Lantiq XWAY SoCs for booting from NOR flash.
57992bbd64eSDaniel Schwierzeck		See also arch/mips/cpu/mips32/start.S.
58092bbd64eSDaniel Schwierzeck
58192bbd64eSDaniel Schwierzeck		CONFIG_XWAY_SWAP_BYTES
58292bbd64eSDaniel Schwierzeck
58392bbd64eSDaniel Schwierzeck		Enable compilation of tools/xway-swap-bytes needed for Lantiq
58492bbd64eSDaniel Schwierzeck		XWAY SoCs for booting from NOR flash. The U-Boot image needs to
58592bbd64eSDaniel Schwierzeck		be swapped if a flash programmer is used.
58692bbd64eSDaniel Schwierzeck
587b67d8816SChristian Riesch- ARM options:
588b67d8816SChristian Riesch		CONFIG_SYS_EXCEPTION_VECTORS_HIGH
589b67d8816SChristian Riesch
590b67d8816SChristian Riesch		Select high exception vectors of the ARM core, e.g., do not
591b67d8816SChristian Riesch		clear the V bit of the c1 register of CP15.
592b67d8816SChristian Riesch
5935356f545SAneesh V		CONFIG_SYS_THUMB_BUILD
5945356f545SAneesh V
5955356f545SAneesh V		Use this flag to build U-Boot using the Thumb instruction
5965356f545SAneesh V		set for ARM architectures. Thumb instruction set provides
5975356f545SAneesh V		better code density. For ARM architectures that support
5985356f545SAneesh V		Thumb2 this flag will result in Thumb2 code generated by
5995356f545SAneesh V		GCC.
6005356f545SAneesh V
601c5d4752cSStephen Warren		CONFIG_ARM_ERRATA_716044
6020678587fSStephen Warren		CONFIG_ARM_ERRATA_742230
6030678587fSStephen Warren		CONFIG_ARM_ERRATA_743622
6040678587fSStephen Warren		CONFIG_ARM_ERRATA_751472
605f71cbfe3SNitin Garg		CONFIG_ARM_ERRATA_794072
606b7588e3bSNitin Garg		CONFIG_ARM_ERRATA_761320
6070678587fSStephen Warren
6080678587fSStephen Warren		If set, the workarounds for these ARM errata are applied early
6090678587fSStephen Warren		during U-Boot startup. Note that these options force the
6100678587fSStephen Warren		workarounds to be applied; no CPU-type/version detection
6110678587fSStephen Warren		exists, unlike the similar options in the Linux kernel. Do not
6120678587fSStephen Warren		set these options unless they apply!
6130678587fSStephen Warren
614795659dcSStephen Warren- CPU timer options:
615795659dcSStephen Warren		CONFIG_SYS_HZ
616795659dcSStephen Warren
617795659dcSStephen Warren		The frequency of the timer returned by get_timer().
618795659dcSStephen Warren		get_timer() must operate in milliseconds and this CONFIG
619795659dcSStephen Warren		option must be set to 1000.
620795659dcSStephen Warren
6215da627a4Swdenk- Linux Kernel Interface:
622c609719bSwdenk		CONFIG_CLOCKS_IN_MHZ
623c609719bSwdenk
624c609719bSwdenk		U-Boot stores all clock information in Hz
625c609719bSwdenk		internally. For binary compatibility with older Linux
626c609719bSwdenk		kernels (which expect the clocks passed in the
627c609719bSwdenk		bd_info data to be in MHz) the environment variable
628c609719bSwdenk		"clocks_in_mhz" can be defined so that U-Boot
629c609719bSwdenk		converts clock data to MHZ before passing it to the
630c609719bSwdenk		Linux kernel.
631c609719bSwdenk		When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
632c609719bSwdenk		"clocks_in_mhz=1" is automatically included in the
633c609719bSwdenk		default environment.
634c609719bSwdenk
6355da627a4Swdenk		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]
6365da627a4Swdenk
63711ccc33fSMarcel Ziswiler		When transferring memsize parameter to linux, some versions
6385da627a4Swdenk		expect it to be in bytes, others in MB.
6395da627a4Swdenk		Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
6405da627a4Swdenk
641fec6d9eeSGerald Van Baren		CONFIG_OF_LIBFDT
642f57f70aaSWolfgang Denk
643f57f70aaSWolfgang Denk		New kernel versions are expecting firmware settings to be
644213bf8c8SGerald Van Baren		passed using flattened device trees (based on open firmware
645213bf8c8SGerald Van Baren		concepts).
646213bf8c8SGerald Van Baren
647213bf8c8SGerald Van Baren		CONFIG_OF_LIBFDT
648213bf8c8SGerald Van Baren		 * New libfdt-based support
649213bf8c8SGerald Van Baren		 * Adds the "fdt" command
6503bb342fcSKim Phillips		 * The bootm command automatically updates the fdt
651213bf8c8SGerald Van Baren
652b55ae402SMarcel Ziswiler		OF_CPU - The proper name of the cpus node (only required for
653b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
654b55ae402SMarcel Ziswiler		OF_SOC - The proper name of the soc node (only required for
655b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
656f57f70aaSWolfgang Denk		OF_TBCLK - The timebase frequency.
657c2871f03SKumar Gala		OF_STDOUT_PATH - The path to the console device
658f57f70aaSWolfgang Denk
65911ccc33fSMarcel Ziswiler		boards with QUICC Engines require OF_QE to set UCC MAC
66011ccc33fSMarcel Ziswiler		addresses
6613bb342fcSKim Phillips
6624e253137SKumar Gala		CONFIG_OF_BOARD_SETUP
6634e253137SKumar Gala
6644e253137SKumar Gala		Board code has addition modification that it wants to make
6654e253137SKumar Gala		to the flat device tree before handing it off to the kernel
6666705d81eSwdenk
6670267768eSMatthew McClintock		CONFIG_OF_BOOT_CPU
6680267768eSMatthew McClintock
66911ccc33fSMarcel Ziswiler		This define fills in the correct boot CPU in the boot
6700267768eSMatthew McClintock		param header, the default value is zero if undefined.
6710267768eSMatthew McClintock
6723887c3fbSHeiko Schocher		CONFIG_OF_IDE_FIXUP
6733887c3fbSHeiko Schocher
6743887c3fbSHeiko Schocher		U-Boot can detect if an IDE device is present or not.
6753887c3fbSHeiko Schocher		If not, and this new config option is activated, U-Boot
6763887c3fbSHeiko Schocher		removes the ATA node from the DTS before booting Linux,
6773887c3fbSHeiko Schocher		so the Linux IDE driver does not probe the device and
6783887c3fbSHeiko Schocher		crash. This is needed for buggy hardware (uc101) where
6793887c3fbSHeiko Schocher		no pull down resistor is connected to the signal IDE5V_DD7.
6803887c3fbSHeiko Schocher
6817eb29398SIgor Grinberg		CONFIG_MACH_TYPE	[relevant for ARM only][mandatory]
6827eb29398SIgor Grinberg
6837eb29398SIgor Grinberg		This setting is mandatory for all boards that have only one
6847eb29398SIgor Grinberg		machine type and must be used to specify the machine type
6857eb29398SIgor Grinberg		number as it appears in the ARM machine registry
6867eb29398SIgor Grinberg		(see http://www.arm.linux.org.uk/developer/machines/).
6877eb29398SIgor Grinberg		Only boards that have multiple machine types supported
6887eb29398SIgor Grinberg		in a single configuration file and the machine type is
6897eb29398SIgor Grinberg		runtime discoverable, do not have to use this setting.
6907eb29398SIgor Grinberg
6910b2f4ecaSNiklaus Giger- vxWorks boot parameters:
6920b2f4ecaSNiklaus Giger
6930b2f4ecaSNiklaus Giger		bootvx constructs a valid bootline using the following
6940b2f4ecaSNiklaus Giger		environments variables: bootfile, ipaddr, serverip, hostname.
6950b2f4ecaSNiklaus Giger		It loads the vxWorks image pointed bootfile.
6960b2f4ecaSNiklaus Giger
6970b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
6980b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
6990b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
7000b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
7010b2f4ecaSNiklaus Giger
7020b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_ADD_PARAMS
7030b2f4ecaSNiklaus Giger
7040b2f4ecaSNiklaus Giger		Add it at the end of the bootline. E.g "u=username pw=secret"
7050b2f4ecaSNiklaus Giger
7060b2f4ecaSNiklaus Giger		Note: If a "bootargs" environment is defined, it will overwride
7070b2f4ecaSNiklaus Giger		the defaults discussed just above.
7080b2f4ecaSNiklaus Giger
7092c451f78SAneesh V- Cache Configuration:
7102c451f78SAneesh V		CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
7112c451f78SAneesh V		CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
7122c451f78SAneesh V		CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
7132c451f78SAneesh V
71493bc2193SAneesh V- Cache Configuration for ARM:
71593bc2193SAneesh V		CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
71693bc2193SAneesh V				      controller
71793bc2193SAneesh V		CONFIG_SYS_PL310_BASE - Physical base address of PL310
71893bc2193SAneesh V					controller register space
71993bc2193SAneesh V
7206705d81eSwdenk- Serial Ports:
72148d0192fSAndreas Engel		CONFIG_PL010_SERIAL
7226705d81eSwdenk
7236705d81eSwdenk		Define this if you want support for Amba PrimeCell PL010 UARTs.
7246705d81eSwdenk
72548d0192fSAndreas Engel		CONFIG_PL011_SERIAL
7266705d81eSwdenk
7276705d81eSwdenk		Define this if you want support for Amba PrimeCell PL011 UARTs.
7286705d81eSwdenk
7296705d81eSwdenk		CONFIG_PL011_CLOCK
7306705d81eSwdenk
7316705d81eSwdenk		If you have Amba PrimeCell PL011 UARTs, set this variable to
7326705d81eSwdenk		the clock speed of the UARTs.
7336705d81eSwdenk
7346705d81eSwdenk		CONFIG_PL01x_PORTS
7356705d81eSwdenk
7366705d81eSwdenk		If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
7376705d81eSwdenk		define this to a list of base addresses for each (supported)
7386705d81eSwdenk		port. See e.g. include/configs/versatile.h
7396705d81eSwdenk
740910f1ae3SJohn Rigby		CONFIG_PL011_SERIAL_RLCR
741910f1ae3SJohn Rigby
742910f1ae3SJohn Rigby		Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
743910f1ae3SJohn Rigby		have separate receive and transmit line control registers.  Set
744910f1ae3SJohn Rigby		this variable to initialize the extra register.
745910f1ae3SJohn Rigby
746910f1ae3SJohn Rigby		CONFIG_PL011_SERIAL_FLUSH_ON_INIT
747910f1ae3SJohn Rigby
748910f1ae3SJohn Rigby		On some platforms (e.g. U8500) U-Boot is loaded by a second stage
749910f1ae3SJohn Rigby		boot loader that has already initialized the UART.  Define this
750910f1ae3SJohn Rigby		variable to flush the UART at init time.
751910f1ae3SJohn Rigby
752d57dee57SKaricheri, Muralidharan		CONFIG_SERIAL_HW_FLOW_CONTROL
753d57dee57SKaricheri, Muralidharan
754d57dee57SKaricheri, Muralidharan		Define this variable to enable hw flow control in serial driver.
755d57dee57SKaricheri, Muralidharan		Current user of this option is drivers/serial/nsl16550.c driver
7566705d81eSwdenk
757c609719bSwdenk- Console Interface:
758c609719bSwdenk		Depending on board, define exactly one serial port
759c609719bSwdenk		(like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
760c609719bSwdenk		CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
761c609719bSwdenk		console by defining CONFIG_8xx_CONS_NONE
762c609719bSwdenk
763c609719bSwdenk		Note: if CONFIG_8xx_CONS_NONE is defined, the serial
764c609719bSwdenk		port routines must be defined elsewhere
765c609719bSwdenk		(i.e. serial_init(), serial_getc(), ...)
766c609719bSwdenk
767c609719bSwdenk		CONFIG_CFB_CONSOLE
768c609719bSwdenk		Enables console device for a color framebuffer. Needs following
769c53043b7SWolfgang Denk		defines (cf. smiLynxEM, i8042)
770c609719bSwdenk			VIDEO_FB_LITTLE_ENDIAN	graphic memory organisation
771c609719bSwdenk						(default big endian)
772c609719bSwdenk			VIDEO_HW_RECTFILL	graphic chip supports
773c609719bSwdenk						rectangle fill
774c609719bSwdenk						(cf. smiLynxEM)
775c609719bSwdenk			VIDEO_HW_BITBLT		graphic chip supports
776c609719bSwdenk						bit-blit (cf. smiLynxEM)
777c609719bSwdenk			VIDEO_VISIBLE_COLS	visible pixel columns
778c609719bSwdenk						(cols=pitch)
779c609719bSwdenk			VIDEO_VISIBLE_ROWS	visible pixel rows
780c609719bSwdenk			VIDEO_PIXEL_SIZE	bytes per pixel
781c609719bSwdenk			VIDEO_DATA_FORMAT	graphic data format
782c609719bSwdenk						(0-5, cf. cfb_console.c)
783c609719bSwdenk			VIDEO_FB_ADRS		framebuffer address
784c609719bSwdenk			VIDEO_KBD_INIT_FCT	keyboard int fct
785c609719bSwdenk						(i.e. i8042_kbd_init())
786c609719bSwdenk			VIDEO_TSTC_FCT		test char fct
787c609719bSwdenk						(i.e. i8042_tstc)
788c609719bSwdenk			VIDEO_GETC_FCT		get char fct
789c609719bSwdenk						(i.e. i8042_getc)
790c609719bSwdenk			CONFIG_CONSOLE_CURSOR	cursor drawing on/off
791c609719bSwdenk						(requires blink timer
792c609719bSwdenk						cf. i8042.c)
7936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
794c609719bSwdenk			CONFIG_CONSOLE_TIME	display time/date info in
795c609719bSwdenk						upper right corner
796602ad3b3SJon Loeliger						(requires CONFIG_CMD_DATE)
797c609719bSwdenk			CONFIG_VIDEO_LOGO	display Linux logo in
798c609719bSwdenk						upper left corner
799a6c7ad2fSwdenk			CONFIG_VIDEO_BMP_LOGO	use bmp_logo.h instead of
800a6c7ad2fSwdenk						linux_logo.h for logo.
801a6c7ad2fSwdenk						Requires CONFIG_VIDEO_LOGO
802c609719bSwdenk			CONFIG_CONSOLE_EXTRA_INFO
80311ccc33fSMarcel Ziswiler						additional board info beside
804c609719bSwdenk						the logo
805c609719bSwdenk
80633a35bbbSPali Rohár		When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
80733a35bbbSPali Rohár		a limited number of ANSI escape sequences (cursor control,
80833a35bbbSPali Rohár		erase functions and limited graphics rendition control).
80933a35bbbSPali Rohár
810c609719bSwdenk		When CONFIG_CFB_CONSOLE is defined, video console is
811c609719bSwdenk		default i/o. Serial console can be forced with
812c609719bSwdenk		environment 'console=serial'.
813c609719bSwdenk
814a3ad8e26Swdenk		When CONFIG_SILENT_CONSOLE is defined, all console
815a3ad8e26Swdenk		messages (by U-Boot and Linux!) can be silenced with
816a3ad8e26Swdenk		the "silent" environment variable. See
817a3ad8e26Swdenk		doc/README.silent for more information.
818a3ad8e26Swdenk
81945ae2546SHeiko Schocher		CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default
82045ae2546SHeiko Schocher			is 0x00.
82145ae2546SHeiko Schocher		CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default
82245ae2546SHeiko Schocher			is 0xa0.
82345ae2546SHeiko Schocher
824c609719bSwdenk- Console Baudrate:
825c609719bSwdenk		CONFIG_BAUDRATE - in bps
826c609719bSwdenk		Select one of the baudrates listed in
8276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
8286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
829c609719bSwdenk
830c92fac91SHeiko Schocher- Console Rx buffer length
831c92fac91SHeiko Schocher		With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
832c92fac91SHeiko Schocher		the maximum receive buffer length for the SMC.
8332b3f12c2SHeiko Schocher		This option is actual only for 82xx and 8xx possible.
834c92fac91SHeiko Schocher		If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
835c92fac91SHeiko Schocher		must be defined, to setup the maximum idle timeout for
836c92fac91SHeiko Schocher		the SMC.
837c92fac91SHeiko Schocher
8389558b48aSGraeme Russ- Pre-Console Buffer:
8399558b48aSGraeme Russ		Prior to the console being initialised (i.e. serial UART
8409558b48aSGraeme Russ		initialised etc) all console output is silently discarded.
8419558b48aSGraeme Russ		Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
8429558b48aSGraeme Russ		buffer any console messages prior to the console being
8439558b48aSGraeme Russ		initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
8449558b48aSGraeme Russ		bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
8459558b48aSGraeme Russ		a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
8469558b48aSGraeme Russ		bytes are output before the console is initialised, the
8479558b48aSGraeme Russ		earlier bytes are discarded.
8489558b48aSGraeme Russ
8499558b48aSGraeme Russ		'Sane' compilers will generate smaller code if
8509558b48aSGraeme Russ		CONFIG_PRE_CON_BUF_SZ is a power of 2
8519558b48aSGraeme Russ
852046a37bdSSonny Rao- Safe printf() functions
853046a37bdSSonny Rao		Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
854046a37bdSSonny Rao		the printf() functions. These are defined in
855046a37bdSSonny Rao		include/vsprintf.h and include snprintf(), vsnprintf() and
856046a37bdSSonny Rao		so on. Code size increase is approximately 300-500 bytes.
857046a37bdSSonny Rao		If this option is not given then these functions will
858046a37bdSSonny Rao		silently discard their buffer size argument - this means
859046a37bdSSonny Rao		you are not getting any overflow checking in this case.
860046a37bdSSonny Rao
861c609719bSwdenk- Boot Delay:	CONFIG_BOOTDELAY - in seconds
862c609719bSwdenk		Delay before automatically booting the default image;
863c609719bSwdenk		set to -1 to disable autoboot.
86493d7212fSJoe Hershberger		set to -2 to autoboot with no delay and not check for abort
86593d7212fSJoe Hershberger		(even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
866c609719bSwdenk
867c609719bSwdenk		See doc/README.autoboot for these options that
868c609719bSwdenk		work with CONFIG_BOOTDELAY. None are required.
869c609719bSwdenk		CONFIG_BOOT_RETRY_TIME
870c609719bSwdenk		CONFIG_BOOT_RETRY_MIN
871c609719bSwdenk		CONFIG_AUTOBOOT_KEYED
872c609719bSwdenk		CONFIG_AUTOBOOT_PROMPT
873c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR
874c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR
875c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR2
876c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR2
877c609719bSwdenk		CONFIG_ZERO_BOOTDELAY_CHECK
878c609719bSwdenk		CONFIG_RESET_TO_RETRY
879c609719bSwdenk
880c609719bSwdenk- Autoboot Command:
881c609719bSwdenk		CONFIG_BOOTCOMMAND
882c609719bSwdenk		Only needed when CONFIG_BOOTDELAY is enabled;
883c609719bSwdenk		define a command string that is automatically executed
884c609719bSwdenk		when no character is read on the console interface
885c609719bSwdenk		within "Boot Delay" after reset.
886c609719bSwdenk
887c609719bSwdenk		CONFIG_BOOTARGS
888c609719bSwdenk		This can be used to pass arguments to the bootm
889c609719bSwdenk		command. The value of CONFIG_BOOTARGS goes into the
890c609719bSwdenk		environment value "bootargs".
891c609719bSwdenk
892c609719bSwdenk		CONFIG_RAMBOOT and CONFIG_NFSBOOT
893c609719bSwdenk		The value of these goes into the environment as
894c609719bSwdenk		"ramboot" and "nfsboot" respectively, and can be used
895c609719bSwdenk		as a convenience, when switching between booting from
89611ccc33fSMarcel Ziswiler		RAM and NFS.
897c609719bSwdenk
898eda0ba38SHeiko Schocher- Bootcount:
899eda0ba38SHeiko Schocher		CONFIG_BOOTCOUNT_LIMIT
900eda0ba38SHeiko Schocher		Implements a mechanism for detecting a repeating reboot
901eda0ba38SHeiko Schocher		cycle, see:
902eda0ba38SHeiko Schocher		http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
903eda0ba38SHeiko Schocher
904eda0ba38SHeiko Schocher		CONFIG_BOOTCOUNT_ENV
905eda0ba38SHeiko Schocher		If no softreset save registers are found on the hardware
906eda0ba38SHeiko Schocher		"bootcount" is stored in the environment. To prevent a
907eda0ba38SHeiko Schocher		saveenv on all reboots, the environment variable
908eda0ba38SHeiko Schocher		"upgrade_available" is used. If "upgrade_available" is
909eda0ba38SHeiko Schocher		0, "bootcount" is always 0, if "upgrade_available" is
910eda0ba38SHeiko Schocher		1 "bootcount" is incremented in the environment.
911eda0ba38SHeiko Schocher		So the Userspace Applikation must set the "upgrade_available"
912eda0ba38SHeiko Schocher		and "bootcount" variable to 0, if a boot was successfully.
913eda0ba38SHeiko Schocher
914c609719bSwdenk- Pre-Boot Commands:
915c609719bSwdenk		CONFIG_PREBOOT
916c609719bSwdenk
917c609719bSwdenk		When this option is #defined, the existence of the
918c609719bSwdenk		environment variable "preboot" will be checked
919c609719bSwdenk		immediately before starting the CONFIG_BOOTDELAY
920c609719bSwdenk		countdown and/or running the auto-boot command resp.
921c609719bSwdenk		entering interactive mode.
922c609719bSwdenk
923c609719bSwdenk		This feature is especially useful when "preboot" is
924c609719bSwdenk		automatically generated or modified. For an example
925c609719bSwdenk		see the LWMON board specific code: here "preboot" is
926c609719bSwdenk		modified when the user holds down a certain
927c609719bSwdenk		combination of keys on the (special) keyboard when
928c609719bSwdenk		booting the systems
929c609719bSwdenk
930c609719bSwdenk- Serial Download Echo Mode:
931c609719bSwdenk		CONFIG_LOADS_ECHO
932c609719bSwdenk		If defined to 1, all characters received during a
933c609719bSwdenk		serial download (using the "loads" command) are
934c609719bSwdenk		echoed back. This might be needed by some terminal
935c609719bSwdenk		emulations (like "cu"), but may as well just take
936c609719bSwdenk		time on others. This setting #define's the initial
937c609719bSwdenk		value of the "loads_echo" environment variable.
938c609719bSwdenk
939602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
940c609719bSwdenk		CONFIG_KGDB_BAUDRATE
941c609719bSwdenk		Select one of the baudrates listed in
9426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
943c609719bSwdenk
944c609719bSwdenk- Monitor Functions:
945602ad3b3SJon Loeliger		Monitor commands can be included or excluded
946602ad3b3SJon Loeliger		from the build by using the #include files
947c6c621bdSStephen Warren		<config_cmd_all.h> and #undef'ing unwanted
948c6c621bdSStephen Warren		commands, or using <config_cmd_default.h>
949602ad3b3SJon Loeliger		and augmenting with additional #define's
950602ad3b3SJon Loeliger		for wanted commands.
951c609719bSwdenk
952602ad3b3SJon Loeliger		The default command configuration includes all commands
953602ad3b3SJon Loeliger		except those marked below with a "*".
954602ad3b3SJon Loeliger
955b401b73dSMarek Vasut		CONFIG_CMD_AES		  AES 128 CBC encrypt/decrypt
956602ad3b3SJon Loeliger		CONFIG_CMD_ASKENV	* ask for env variable
957602ad3b3SJon Loeliger		CONFIG_CMD_BDI		  bdinfo
958602ad3b3SJon Loeliger		CONFIG_CMD_BEDBUG	* Include BedBug Debugger
959602ad3b3SJon Loeliger		CONFIG_CMD_BMP		* BMP support
960602ad3b3SJon Loeliger		CONFIG_CMD_BSP		* Board specific commands
961602ad3b3SJon Loeliger		CONFIG_CMD_BOOTD	  bootd
962602ad3b3SJon Loeliger		CONFIG_CMD_CACHE	* icache, dcache
96308d0d6f3SMichal Simek		CONFIG_CMD_CLK   	* clock command support
964602ad3b3SJon Loeliger		CONFIG_CMD_CONSOLE	  coninfo
965710b9938SMike Frysinger		CONFIG_CMD_CRC32	* crc32
966602ad3b3SJon Loeliger		CONFIG_CMD_DATE		* support for RTC, date/time...
967602ad3b3SJon Loeliger		CONFIG_CMD_DHCP		* DHCP support
968602ad3b3SJon Loeliger		CONFIG_CMD_DIAG		* Diagnostics
969a7c93104SPeter Tyser		CONFIG_CMD_DS4510	* ds4510 I2C gpio commands
970a7c93104SPeter Tyser		CONFIG_CMD_DS4510_INFO	* ds4510 I2C info command
971a7c93104SPeter Tyser		CONFIG_CMD_DS4510_MEM	* ds4510 I2C eeprom/sram commansd
972a7c93104SPeter Tyser		CONFIG_CMD_DS4510_RST	* ds4510 I2C rst command
973602ad3b3SJon Loeliger		CONFIG_CMD_DTT		* Digital Therm and Thermostat
974602ad3b3SJon Loeliger		CONFIG_CMD_ECHO		  echo arguments
975246c6922SPeter Tyser		CONFIG_CMD_EDITENV	  edit env variable
976602ad3b3SJon Loeliger		CONFIG_CMD_EEPROM	* EEPROM read/write support
977602ad3b3SJon Loeliger		CONFIG_CMD_ELF		* bootelf, bootvx
9785e2b3e0cSJoe Hershberger		CONFIG_CMD_ENV_CALLBACK	* display details about env callbacks
979fffad71bSJoe Hershberger		CONFIG_CMD_ENV_FLAGS	* display details about env flags
98088733e2cSAndrew Ruder		CONFIG_CMD_ENV_EXISTS	* check existence of env variable
9810c79cda0SMike Frysinger		CONFIG_CMD_EXPORTENV	* export the environment
98203e2ecf6SStephen Warren		CONFIG_CMD_EXT2		* ext2 command support
98303e2ecf6SStephen Warren		CONFIG_CMD_EXT4		* ext4 command support
98416f4d933SStephen Warren		CONFIG_CMD_FS_GENERIC	* filesystem commands (e.g. load, ls)
98516f4d933SStephen Warren					  that work for multiple fs types
986bdab39d3SMike Frysinger		CONFIG_CMD_SAVEENV	  saveenv
987602ad3b3SJon Loeliger		CONFIG_CMD_FDC		* Floppy Disk Support
98803e2ecf6SStephen Warren		CONFIG_CMD_FAT		* FAT command support
989602ad3b3SJon Loeliger		CONFIG_CMD_FLASH	  flinfo, erase, protect
990602ad3b3SJon Loeliger		CONFIG_CMD_FPGA		  FPGA device initialization support
9914d98b5c8SVincent Stehlé		CONFIG_CMD_FUSE		* Device fuse support
99253fdc7efSAnton Staaf		CONFIG_CMD_GETTIME	* Get time since boot
993a641b979SMike Frysinger		CONFIG_CMD_GO		* the 'go' command (exec code)
994a000b795SKim Phillips		CONFIG_CMD_GREPENV	* search environment
995bf36c5d5SSimon Glass		CONFIG_CMD_HASH		* calculate hash / digest
996602ad3b3SJon Loeliger		CONFIG_CMD_HWFLOW	* RTS/CTS hw flow control
997602ad3b3SJon Loeliger		CONFIG_CMD_I2C		* I2C serial bus support
998602ad3b3SJon Loeliger		CONFIG_CMD_IDE		* IDE harddisk support
999602ad3b3SJon Loeliger		CONFIG_CMD_IMI		  iminfo
10008fdf1e0fSVipin Kumar		CONFIG_CMD_IMLS		  List all images found in NOR flash
10014d98b5c8SVincent Stehlé		CONFIG_CMD_IMLS_NAND	* List all images found in NAND flash
1002602ad3b3SJon Loeliger		CONFIG_CMD_IMMAP	* IMMR dump support
10030c79cda0SMike Frysinger		CONFIG_CMD_IMPORTENV	* import an environment
1004c167cc02SJoe Hershberger		CONFIG_CMD_INI		* import data from an ini file into the env
1005602ad3b3SJon Loeliger		CONFIG_CMD_IRQ		* irqinfo
1006602ad3b3SJon Loeliger		CONFIG_CMD_ITEST	  Integer/string test of 2 values
1007602ad3b3SJon Loeliger		CONFIG_CMD_JFFS2	* JFFS2 Support
1008602ad3b3SJon Loeliger		CONFIG_CMD_KGDB		* kgdb
10094d98b5c8SVincent Stehlé		CONFIG_CMD_LDRINFO	* ldrinfo (display Blackfin loader)
1010d22c338eSJoe Hershberger		CONFIG_CMD_LINK_LOCAL	* link-local IP address auto-configuration
1011d22c338eSJoe Hershberger					  (169.254.*.*)
1012602ad3b3SJon Loeliger		CONFIG_CMD_LOADB	  loadb
1013602ad3b3SJon Loeliger		CONFIG_CMD_LOADS	  loads
10144d98b5c8SVincent Stehlé		CONFIG_CMD_MD5SUM	* print md5 message digest
101502c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
101615a33e49SSimon Glass		CONFIG_CMD_MEMINFO	* Display detailed memory information
1017602ad3b3SJon Loeliger		CONFIG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
1018a2681707SWolfgang Denk					  loop, loopw
10194d98b5c8SVincent Stehlé		CONFIG_CMD_MEMTEST	* mtest
1020602ad3b3SJon Loeliger		CONFIG_CMD_MISC		  Misc functions like sleep etc
1021602ad3b3SJon Loeliger		CONFIG_CMD_MMC		* MMC memory mapped support
1022602ad3b3SJon Loeliger		CONFIG_CMD_MII		* MII utility commands
102368d7d651SStefan Roese		CONFIG_CMD_MTDPARTS	* MTD partition support
1024602ad3b3SJon Loeliger		CONFIG_CMD_NAND		* NAND support
1025602ad3b3SJon Loeliger		CONFIG_CMD_NET		  bootp, tftpboot, rarpboot
10264d98b5c8SVincent Stehlé		CONFIG_CMD_NFS		  NFS support
1027e92739d3SPeter Tyser		CONFIG_CMD_PCA953X	* PCA953x I2C gpio commands
1028e92739d3SPeter Tyser		CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
1029602ad3b3SJon Loeliger		CONFIG_CMD_PCI		* pciinfo
1030602ad3b3SJon Loeliger		CONFIG_CMD_PCMCIA		* PCMCIA support
1031602ad3b3SJon Loeliger		CONFIG_CMD_PING		* send ICMP ECHO_REQUEST to network
1032602ad3b3SJon Loeliger					  host
1033602ad3b3SJon Loeliger		CONFIG_CMD_PORTIO	* Port I/O
1034ff048ea9SKenneth Waters		CONFIG_CMD_READ		* Read raw data from partition
1035602ad3b3SJon Loeliger		CONFIG_CMD_REGINFO	* Register dump
1036602ad3b3SJon Loeliger		CONFIG_CMD_RUN		  run command in env variable
1037d304931fSSimon Glass		CONFIG_CMD_SANDBOX	* sb command to access sandbox features
1038602ad3b3SJon Loeliger		CONFIG_CMD_SAVES	* save S record dump
1039602ad3b3SJon Loeliger		CONFIG_CMD_SCSI		* SCSI Support
1040602ad3b3SJon Loeliger		CONFIG_CMD_SDRAM	* print SDRAM configuration information
1041602ad3b3SJon Loeliger					  (requires CONFIG_CMD_I2C)
1042602ad3b3SJon Loeliger		CONFIG_CMD_SETGETDCR	  Support for DCR Register access
1043602ad3b3SJon Loeliger					  (4xx only)
1044f61ec45eSEric Nelson		CONFIG_CMD_SF		* Read/write/erase SPI NOR flash
10454d98b5c8SVincent Stehlé		CONFIG_CMD_SHA1SUM	* print sha1 memory digest
104602c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY)
10477d861d95SBob Liu		CONFIG_CMD_SOFTSWITCH	* Soft switch setting command for BF60x
104874de7aefSWolfgang Denk		CONFIG_CMD_SOURCE	  "source" command Support
1049602ad3b3SJon Loeliger		CONFIG_CMD_SPI		* SPI serial bus support
10507a83af07SLuca Ceresoli		CONFIG_CMD_TFTPSRV	* TFTP transfer in server mode
10511fb7cd49SSimon Glass		CONFIG_CMD_TFTPPUT	* TFTP put command (upload)
1052da83bcd7SJoe Hershberger		CONFIG_CMD_TIME		* run command and report execution time (ARM specific)
1053da83bcd7SJoe Hershberger		CONFIG_CMD_TIMER	* access to the system tick timer
1054602ad3b3SJon Loeliger		CONFIG_CMD_USB		* USB support
1055602ad3b3SJon Loeliger		CONFIG_CMD_CDP		* Cisco Discover Protocol support
1056c8339f51SMarek Vasut		CONFIG_CMD_MFSL		* Microblaze FSL support
10574d98b5c8SVincent Stehlé		CONFIG_CMD_XIMG		  Load part of Multi Image
105889c8230dSPrzemyslaw Marczak		CONFIG_CMD_UUID		* Generate random UUID or GUID string
1059c609719bSwdenk
1060c609719bSwdenk		EXAMPLE: If you want all functions except of network
1061c609719bSwdenk		support you can write:
1062c609719bSwdenk
1063602ad3b3SJon Loeliger		#include "config_cmd_all.h"
1064602ad3b3SJon Loeliger		#undef CONFIG_CMD_NET
1065c609719bSwdenk
1066213bf8c8SGerald Van Baren	Other Commands:
1067213bf8c8SGerald Van Baren		fdt (flattened device tree) command: CONFIG_OF_LIBFDT
1068c609719bSwdenk
1069c609719bSwdenk	Note:	Don't enable the "icache" and "dcache" commands
1070602ad3b3SJon Loeliger		(configuration option CONFIG_CMD_CACHE) unless you know
1071c609719bSwdenk		what you (and your U-Boot users) are doing. Data
1072c609719bSwdenk		cache cannot be enabled on systems like the 8xx or
1073c609719bSwdenk		8260 (where accesses to the IMMR region must be
1074c609719bSwdenk		uncached), and it cannot be disabled on all other
1075c609719bSwdenk		systems where we (mis-) use the data cache to hold an
1076c609719bSwdenk		initial stack and some data.
1077c609719bSwdenk
1078c609719bSwdenk
1079c609719bSwdenk		XXX - this list needs to get updated!
1080c609719bSwdenk
1081a5ecbe62SWolfgang Denk- Regular expression support:
1082a5ecbe62SWolfgang Denk		CONFIG_REGEX
1083a5ecbe62SWolfgang Denk		If this variable is defined, U-Boot is linked against
1084a5ecbe62SWolfgang Denk		the SLRE (Super Light Regular Expression) library,
1085a5ecbe62SWolfgang Denk		which adds regex support to some commands, as for
1086a5ecbe62SWolfgang Denk		example "env grep" and "setexpr".
1087a5ecbe62SWolfgang Denk
108845ba8077SSimon Glass- Device tree:
108945ba8077SSimon Glass		CONFIG_OF_CONTROL
109045ba8077SSimon Glass		If this variable is defined, U-Boot will use a device tree
109145ba8077SSimon Glass		to configure its devices, instead of relying on statically
109245ba8077SSimon Glass		compiled #defines in the board file. This option is
109345ba8077SSimon Glass		experimental and only available on a few boards. The device
109445ba8077SSimon Glass		tree is available in the global data as gd->fdt_blob.
109545ba8077SSimon Glass
10962c0f79e4SSimon Glass		U-Boot needs to get its device tree from somewhere. This can
10972c0f79e4SSimon Glass		be done using one of the two options below:
1098bbb0b128SSimon Glass
1099bbb0b128SSimon Glass		CONFIG_OF_EMBED
1100bbb0b128SSimon Glass		If this variable is defined, U-Boot will embed a device tree
1101bbb0b128SSimon Glass		binary in its image. This device tree file should be in the
1102bbb0b128SSimon Glass		board directory and called <soc>-<board>.dts. The binary file
1103bbb0b128SSimon Glass		is then picked up in board_init_f() and made available through
1104bbb0b128SSimon Glass		the global data structure as gd->blob.
110545ba8077SSimon Glass
11062c0f79e4SSimon Glass		CONFIG_OF_SEPARATE
11072c0f79e4SSimon Glass		If this variable is defined, U-Boot will build a device tree
11082c0f79e4SSimon Glass		binary. It will be called u-boot.dtb. Architecture-specific
11092c0f79e4SSimon Glass		code will locate it at run-time. Generally this works by:
11102c0f79e4SSimon Glass
11112c0f79e4SSimon Glass			cat u-boot.bin u-boot.dtb >image.bin
11122c0f79e4SSimon Glass
11132c0f79e4SSimon Glass		and in fact, U-Boot does this for you, creating a file called
11142c0f79e4SSimon Glass		u-boot-dtb.bin which is useful in the common case. You can
11152c0f79e4SSimon Glass		still use the individual files if you need something more
11162c0f79e4SSimon Glass		exotic.
11172c0f79e4SSimon Glass
1118c609719bSwdenk- Watchdog:
1119c609719bSwdenk		CONFIG_WATCHDOG
1120c609719bSwdenk		If this variable is defined, it enables watchdog
11216abe6fb6SDetlev Zundel		support for the SoC. There must be support in the SoC
11226abe6fb6SDetlev Zundel		specific code for a watchdog. For the 8xx and 8260
11236abe6fb6SDetlev Zundel		CPUs, the SIU Watchdog feature is enabled in the SYPCR
11246abe6fb6SDetlev Zundel		register.  When supported for a specific SoC is
11256abe6fb6SDetlev Zundel		available, then no further board specific code should
11266abe6fb6SDetlev Zundel		be needed to use it.
11276abe6fb6SDetlev Zundel
11286abe6fb6SDetlev Zundel		CONFIG_HW_WATCHDOG
11296abe6fb6SDetlev Zundel		When using a watchdog circuitry external to the used
11306abe6fb6SDetlev Zundel		SoC, then define this variable and provide board
11316abe6fb6SDetlev Zundel		specific code for the "hw_watchdog_reset" function.
1132c609719bSwdenk
1133c1551ea8Sstroese- U-Boot Version:
1134c1551ea8Sstroese		CONFIG_VERSION_VARIABLE
1135c1551ea8Sstroese		If this variable is defined, an environment variable
1136c1551ea8Sstroese		named "ver" is created by U-Boot showing the U-Boot
1137c1551ea8Sstroese		version as printed by the "version" command.
1138a1ea8e51SBenoît Thébaudeau		Any change to this variable will be reverted at the
1139a1ea8e51SBenoît Thébaudeau		next reset.
1140c1551ea8Sstroese
1141c609719bSwdenk- Real-Time Clock:
1142c609719bSwdenk
1143602ad3b3SJon Loeliger		When CONFIG_CMD_DATE is selected, the type of the RTC
1144c609719bSwdenk		has to be selected, too. Define exactly one of the
1145c609719bSwdenk		following options:
1146c609719bSwdenk
1147c609719bSwdenk		CONFIG_RTC_MPC8xx	- use internal RTC of MPC8xx
1148c609719bSwdenk		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
11494e8b7544SFabio Estevam		CONFIG_RTC_MC13XXX	- use MC13783 or MC13892 RTC
1150c609719bSwdenk		CONFIG_RTC_MC146818	- use MC146818 RTC
11511cb8e980Swdenk		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
1152c609719bSwdenk		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
11537f70e853Swdenk		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
11543bac3513Swdenk		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
11559536dfccSTor Krill		CONFIG_RTC_ISL1208	- use Intersil ISL1208 RTC
11564c0d4c3bSwdenk		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
11576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_DS1337_NOOSC	- Turn off the OSC output for DS1337
115871d19f30SHeiko Schocher		CONFIG_SYS_RV3029_TCR	- enable trickle charger on
115971d19f30SHeiko Schocher					  RV3029 RTC.
1160c609719bSwdenk
1161b37c7e5eSwdenk		Note that if the RTC uses I2C, then the I2C interface
1162b37c7e5eSwdenk		must also be configured. See I2C Support, below.
1163b37c7e5eSwdenk
1164e92739d3SPeter Tyser- GPIO Support:
1165e92739d3SPeter Tyser		CONFIG_PCA953X		- use NXP's PCA953X series I2C GPIO
1166e92739d3SPeter Tyser
11675dec49caSChris Packham		The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
11685dec49caSChris Packham		chip-ngpio pairs that tell the PCA953X driver the number of
11695dec49caSChris Packham		pins supported by a particular chip.
11705dec49caSChris Packham
1171e92739d3SPeter Tyser		Note that if the GPIO device uses I2C, then the I2C interface
1172e92739d3SPeter Tyser		must also be configured. See I2C Support, below.
1173e92739d3SPeter Tyser
1174c609719bSwdenk- Timestamp Support:
1175c609719bSwdenk
1176c609719bSwdenk		When CONFIG_TIMESTAMP is selected, the timestamp
1177c609719bSwdenk		(date and time) of an image is printed by image
1178c609719bSwdenk		commands like bootm or iminfo. This option is
1179602ad3b3SJon Loeliger		automatically enabled when you select CONFIG_CMD_DATE .
1180c609719bSwdenk
1181923c46f9SKarl O. Pinc- Partition Labels (disklabels) Supported:
1182923c46f9SKarl O. Pinc		Zero or more of the following:
1183923c46f9SKarl O. Pinc		CONFIG_MAC_PARTITION   Apple's MacOS partition table.
1184923c46f9SKarl O. Pinc		CONFIG_DOS_PARTITION   MS Dos partition table, traditional on the
1185923c46f9SKarl O. Pinc				       Intel architecture, USB sticks, etc.
1186923c46f9SKarl O. Pinc		CONFIG_ISO_PARTITION   ISO partition table, used on CDROM etc.
1187923c46f9SKarl O. Pinc		CONFIG_EFI_PARTITION   GPT partition table, common when EFI is the
1188923c46f9SKarl O. Pinc				       bootloader.  Note 2TB partition limit; see
1189923c46f9SKarl O. Pinc				       disk/part_efi.c
1190923c46f9SKarl O. Pinc		CONFIG_MTD_PARTITIONS  Memory Technology Device partition table.
1191c609719bSwdenk
1192602ad3b3SJon Loeliger		If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1193218ca724SWolfgang Denk		CONFIG_CMD_SCSI) you must configure support for at
1194923c46f9SKarl O. Pinc		least one non-MTD partition type as well.
1195c609719bSwdenk
1196c609719bSwdenk- IDE Reset method:
11974d13cbadSwdenk		CONFIG_IDE_RESET_ROUTINE - this is defined in several
11984d13cbadSwdenk		board configurations files but used nowhere!
1199c609719bSwdenk
12004d13cbadSwdenk		CONFIG_IDE_RESET - is this is defined, IDE Reset will
12014d13cbadSwdenk		be performed by calling the function
12024d13cbadSwdenk			ide_set_reset(int reset)
12034d13cbadSwdenk		which has to be defined in a board specific file
1204c609719bSwdenk
1205c609719bSwdenk- ATAPI Support:
1206c609719bSwdenk		CONFIG_ATAPI
1207c609719bSwdenk
1208c609719bSwdenk		Set this to enable ATAPI support.
1209c609719bSwdenk
1210c40b2956Swdenk- LBA48 Support
1211c40b2956Swdenk		CONFIG_LBA48
1212c40b2956Swdenk
1213c40b2956Swdenk		Set this to enable support for disks larger than 137GB
12144b142febSHeiko Schocher		Also look at CONFIG_SYS_64BIT_LBA.
1215c40b2956Swdenk		Whithout these , LBA48 support uses 32bit variables and will 'only'
1216c40b2956Swdenk		support disks up to 2.1TB.
1217c40b2956Swdenk
12186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_64BIT_LBA:
1219c40b2956Swdenk			When enabled, makes the IDE subsystem use 64bit sector addresses.
1220c40b2956Swdenk			Default is 32bit.
1221c40b2956Swdenk
1222c609719bSwdenk- SCSI Support:
1223c609719bSwdenk		At the moment only there is only support for the
1224c609719bSwdenk		SYM53C8XX SCSI controller; define
1225c609719bSwdenk		CONFIG_SCSI_SYM53C8XX to enable it.
1226c609719bSwdenk
12276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
12286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
12296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
1230c609719bSwdenk		maximum numbers of LUNs, SCSI ID's and target
1231c609719bSwdenk		devices.
12326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
1233c609719bSwdenk
1234447c031bSStefan Reinauer		The environment variable 'scsidevs' is set to the number of
1235447c031bSStefan Reinauer		SCSI devices found during the last scan.
1236447c031bSStefan Reinauer
1237c609719bSwdenk- NETWORK Support (PCI):
1238682011ffSwdenk		CONFIG_E1000
1239ce5207e1SKyle Moffett		Support for Intel 8254x/8257x gigabit chips.
1240ce5207e1SKyle Moffett
1241ce5207e1SKyle Moffett		CONFIG_E1000_SPI
1242ce5207e1SKyle Moffett		Utility code for direct access to the SPI bus on Intel 8257x.
1243ce5207e1SKyle Moffett		This does not do anything useful unless you set at least one
1244ce5207e1SKyle Moffett		of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1245ce5207e1SKyle Moffett
1246ce5207e1SKyle Moffett		CONFIG_E1000_SPI_GENERIC
1247ce5207e1SKyle Moffett		Allow generic access to the SPI bus on the Intel 8257x, for
1248ce5207e1SKyle Moffett		example with the "sspi" command.
1249ce5207e1SKyle Moffett
1250ce5207e1SKyle Moffett		CONFIG_CMD_E1000
1251ce5207e1SKyle Moffett		Management command for E1000 devices.  When used on devices
1252ce5207e1SKyle Moffett		with SPI support you can reprogram the EEPROM from U-Boot.
1253682011ffSwdenk
1254ac3315c2SAndre Schwarz		CONFIG_E1000_FALLBACK_MAC
125511ccc33fSMarcel Ziswiler		default MAC for empty EEPROM after production.
1256ac3315c2SAndre Schwarz
1257c609719bSwdenk		CONFIG_EEPRO100
1258c609719bSwdenk		Support for Intel 82557/82559/82559ER chips.
125911ccc33fSMarcel Ziswiler		Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
1260c609719bSwdenk		write routine for first time initialisation.
1261c609719bSwdenk
1262c609719bSwdenk		CONFIG_TULIP
1263c609719bSwdenk		Support for Digital 2114x chips.
1264c609719bSwdenk		Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1265c609719bSwdenk		modem chip initialisation (KS8761/QS6611).
1266c609719bSwdenk
1267c609719bSwdenk		CONFIG_NATSEMI
1268c609719bSwdenk		Support for National dp83815 chips.
1269c609719bSwdenk
1270c609719bSwdenk		CONFIG_NS8382X
1271c609719bSwdenk		Support for National dp8382[01] gigabit chips.
1272c609719bSwdenk
127345219c46Swdenk- NETWORK Support (other):
127445219c46Swdenk
1275c041e9d2SJens Scharsig		CONFIG_DRIVER_AT91EMAC
1276c041e9d2SJens Scharsig		Support for AT91RM9200 EMAC.
1277c041e9d2SJens Scharsig
1278c041e9d2SJens Scharsig			CONFIG_RMII
1279c041e9d2SJens Scharsig			Define this to use reduced MII inteface
1280c041e9d2SJens Scharsig
1281c041e9d2SJens Scharsig			CONFIG_DRIVER_AT91EMAC_QUIET
1282c041e9d2SJens Scharsig			If this defined, the driver is quiet.
1283c041e9d2SJens Scharsig			The driver doen't show link status messages.
1284c041e9d2SJens Scharsig
1285efdd7319SRob Herring		CONFIG_CALXEDA_XGMAC
1286efdd7319SRob Herring		Support for the Calxeda XGMAC device
1287efdd7319SRob Herring
12883bb46d23SAshok		CONFIG_LAN91C96
128945219c46Swdenk		Support for SMSC's LAN91C96 chips.
129045219c46Swdenk
129145219c46Swdenk			CONFIG_LAN91C96_BASE
129245219c46Swdenk			Define this to hold the physical address
129345219c46Swdenk			of the LAN91C96's I/O space
129445219c46Swdenk
129545219c46Swdenk			CONFIG_LAN91C96_USE_32_BIT
129645219c46Swdenk			Define this to enable 32 bit addressing
129745219c46Swdenk
12983bb46d23SAshok		CONFIG_SMC91111
1299f39748aeSwdenk		Support for SMSC's LAN91C111 chip
1300f39748aeSwdenk
1301f39748aeSwdenk			CONFIG_SMC91111_BASE
1302f39748aeSwdenk			Define this to hold the physical address
1303f39748aeSwdenk			of the device (I/O space)
1304f39748aeSwdenk
1305f39748aeSwdenk			CONFIG_SMC_USE_32_BIT
1306f39748aeSwdenk			Define this if data bus is 32 bits
1307f39748aeSwdenk
1308f39748aeSwdenk			CONFIG_SMC_USE_IOFUNCS
1309f39748aeSwdenk			Define this to use i/o functions instead of macros
1310f39748aeSwdenk			(some hardware wont work with macros)
1311f39748aeSwdenk
1312dc02badaSHeiko Schocher		CONFIG_DRIVER_TI_EMAC
1313dc02badaSHeiko Schocher		Support for davinci emac
1314dc02badaSHeiko Schocher
1315dc02badaSHeiko Schocher			CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1316dc02badaSHeiko Schocher			Define this if you have more then 3 PHYs.
1317dc02badaSHeiko Schocher
1318b3dbf4a5SMacpaul Lin		CONFIG_FTGMAC100
1319b3dbf4a5SMacpaul Lin		Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1320b3dbf4a5SMacpaul Lin
1321b3dbf4a5SMacpaul Lin			CONFIG_FTGMAC100_EGIGA
1322b3dbf4a5SMacpaul Lin			Define this to use GE link update with gigabit PHY.
1323b3dbf4a5SMacpaul Lin			Define this if FTGMAC100 is connected to gigabit PHY.
1324b3dbf4a5SMacpaul Lin			If your system has 10/100 PHY only, it might not occur
1325b3dbf4a5SMacpaul Lin			wrong behavior. Because PHY usually return timeout or
1326b3dbf4a5SMacpaul Lin			useless data when polling gigabit status and gigabit
1327b3dbf4a5SMacpaul Lin			control registers. This behavior won't affect the
1328b3dbf4a5SMacpaul Lin			correctnessof 10/100 link speed update.
1329b3dbf4a5SMacpaul Lin
1330c2fff331SMike Rapoport		CONFIG_SMC911X
1331557b377dSJens Gehrlein		Support for SMSC's LAN911x and LAN921x chips
1332557b377dSJens Gehrlein
1333c2fff331SMike Rapoport			CONFIG_SMC911X_BASE
1334557b377dSJens Gehrlein			Define this to hold the physical address
1335557b377dSJens Gehrlein			of the device (I/O space)
1336557b377dSJens Gehrlein
1337c2fff331SMike Rapoport			CONFIG_SMC911X_32_BIT
1338557b377dSJens Gehrlein			Define this if data bus is 32 bits
1339557b377dSJens Gehrlein
1340c2fff331SMike Rapoport			CONFIG_SMC911X_16_BIT
1341557b377dSJens Gehrlein			Define this if data bus is 16 bits. If your processor
1342557b377dSJens Gehrlein			automatically converts one 32 bit word to two 16 bit
1343c2fff331SMike Rapoport			words you may also try CONFIG_SMC911X_32_BIT.
1344557b377dSJens Gehrlein
13453d0075faSYoshihiro Shimoda		CONFIG_SH_ETHER
13463d0075faSYoshihiro Shimoda		Support for Renesas on-chip Ethernet controller
13473d0075faSYoshihiro Shimoda
13483d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_USE_PORT
13493d0075faSYoshihiro Shimoda			Define the number of ports to be used
13503d0075faSYoshihiro Shimoda
13513d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_PHY_ADDR
13523d0075faSYoshihiro Shimoda			Define the ETH PHY's address
13533d0075faSYoshihiro Shimoda
135468260aabSYoshihiro Shimoda			CONFIG_SH_ETHER_CACHE_WRITEBACK
135568260aabSYoshihiro Shimoda			If this option is set, the driver enables cache flush.
135668260aabSYoshihiro Shimoda
13575e124724SVadim Bendebury- TPM Support:
135890899cc0SChe-liang Chiou		CONFIG_TPM
135990899cc0SChe-liang Chiou		Support TPM devices.
136090899cc0SChe-liang Chiou
13611b393db5STom Wai-Hong Tam		CONFIG_TPM_TIS_I2C
13621b393db5STom Wai-Hong Tam		Support for i2c bus TPM devices. Only one device
13631b393db5STom Wai-Hong Tam		per system is supported at this time.
13641b393db5STom Wai-Hong Tam
13651b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_BUS_NUMBER
13661b393db5STom Wai-Hong Tam			Define the the i2c bus number for the TPM device
13671b393db5STom Wai-Hong Tam
13681b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS
13691b393db5STom Wai-Hong Tam			Define the TPM's address on the i2c bus
13701b393db5STom Wai-Hong Tam
13711b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_BURST_LIMITATION
13721b393db5STom Wai-Hong Tam			Define the burst count bytes upper limit
13731b393db5STom Wai-Hong Tam
1374c01939c7SDirk Eibach		CONFIG_TPM_ATMEL_TWI
1375c01939c7SDirk Eibach		Support for Atmel TWI TPM device. Requires I2C support.
1376c01939c7SDirk Eibach
137790899cc0SChe-liang Chiou		CONFIG_TPM_TIS_LPC
13785e124724SVadim Bendebury		Support for generic parallel port TPM devices. Only one device
13795e124724SVadim Bendebury		per system is supported at this time.
13805e124724SVadim Bendebury
13815e124724SVadim Bendebury			CONFIG_TPM_TIS_BASE_ADDRESS
13825e124724SVadim Bendebury			Base address where the generic TPM device is mapped
13835e124724SVadim Bendebury			to. Contemporary x86 systems usually map it at
13845e124724SVadim Bendebury			0xfed40000.
13855e124724SVadim Bendebury
1386be6c1529SReinhard Pfau		CONFIG_CMD_TPM
1387be6c1529SReinhard Pfau		Add tpm monitor functions.
1388be6c1529SReinhard Pfau		Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1389be6c1529SReinhard Pfau		provides monitor access to authorized functions.
1390be6c1529SReinhard Pfau
1391be6c1529SReinhard Pfau		CONFIG_TPM
1392be6c1529SReinhard Pfau		Define this to enable the TPM support library which provides
1393be6c1529SReinhard Pfau		functional interfaces to some TPM commands.
1394be6c1529SReinhard Pfau		Requires support for a TPM device.
1395be6c1529SReinhard Pfau
1396be6c1529SReinhard Pfau		CONFIG_TPM_AUTH_SESSIONS
1397be6c1529SReinhard Pfau		Define this to enable authorized functions in the TPM library.
1398be6c1529SReinhard Pfau		Requires CONFIG_TPM and CONFIG_SHA1.
1399be6c1529SReinhard Pfau
1400c609719bSwdenk- USB Support:
1401c609719bSwdenk		At the moment only the UHCI host controller is
14024d13cbadSwdenk		supported (PIP405, MIP405, MPC5200); define
1403c609719bSwdenk		CONFIG_USB_UHCI to enable it.
1404c609719bSwdenk		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
140530d56faeSwdenk		and define CONFIG_USB_STORAGE to enable the USB
1406c609719bSwdenk		storage devices.
1407c609719bSwdenk		Note:
1408c609719bSwdenk		Supported are USB Keyboards and USB Floppy drives
1409c609719bSwdenk		(TEAC FD-05PUB).
14104d13cbadSwdenk		MPC5200 USB requires additional defines:
14114d13cbadSwdenk			CONFIG_USB_CLOCK
14124d13cbadSwdenk				for 528 MHz Clock: 0x0001bbbb
1413307ecb6dSEric Millbrandt			CONFIG_PSC3_USB
1414307ecb6dSEric Millbrandt				for USB on PSC3
14154d13cbadSwdenk			CONFIG_USB_CONFIG
14164d13cbadSwdenk				for differential drivers: 0x00001000
14174d13cbadSwdenk				for single ended drivers: 0x00005000
1418307ecb6dSEric Millbrandt				for differential drivers on PSC3: 0x00000100
1419307ecb6dSEric Millbrandt				for single ended drivers on PSC3: 0x00004100
14206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_USB_EVENT_POLL
1421fdcfaa1bSZhang Wei				May be defined to allow interrupt polling
1422fdcfaa1bSZhang Wei				instead of using asynchronous interrupts
14234d13cbadSwdenk
14249ab4ce22SSimon Glass		CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
14259ab4ce22SSimon Glass		txfilltuning field in the EHCI controller on reset.
14269ab4ce22SSimon Glass
1427aa155058SKuo-Jung Su		CONFIG_USB_HUB_MIN_POWER_ON_DELAY defines the minimum
1428aa155058SKuo-Jung Su		interval for usb hub power-on delay.(minimum 100msec)
1429aa155058SKuo-Jung Su
143016c8d5e7SWolfgang Denk- USB Device:
143116c8d5e7SWolfgang Denk		Define the below if you wish to use the USB console.
143216c8d5e7SWolfgang Denk		Once firmware is rebuilt from a serial console issue the
143316c8d5e7SWolfgang Denk		command "setenv stdin usbtty; setenv stdout usbtty" and
143411ccc33fSMarcel Ziswiler		attach your USB cable. The Unix command "dmesg" should print
143516c8d5e7SWolfgang Denk		it has found a new device. The environment variable usbtty
143616c8d5e7SWolfgang Denk		can be set to gserial or cdc_acm to enable your device to
143716c8d5e7SWolfgang Denk		appear to a USB host as a Linux gserial device or a
143816c8d5e7SWolfgang Denk		Common Device Class Abstract Control Model serial device.
143916c8d5e7SWolfgang Denk		If you select usbtty = gserial you should be able to enumerate
144016c8d5e7SWolfgang Denk		a Linux host by
144116c8d5e7SWolfgang Denk		# modprobe usbserial vendor=0xVendorID product=0xProductID
144216c8d5e7SWolfgang Denk		else if using cdc_acm, simply setting the environment
144316c8d5e7SWolfgang Denk		variable usbtty to be cdc_acm should suffice. The following
144416c8d5e7SWolfgang Denk		might be defined in YourBoardName.h
144516c8d5e7SWolfgang Denk
144616c8d5e7SWolfgang Denk			CONFIG_USB_DEVICE
144716c8d5e7SWolfgang Denk			Define this to build a UDC device
144816c8d5e7SWolfgang Denk
144916c8d5e7SWolfgang Denk			CONFIG_USB_TTY
145016c8d5e7SWolfgang Denk			Define this to have a tty type of device available to
145116c8d5e7SWolfgang Denk			talk to the UDC device
145216c8d5e7SWolfgang Denk
1453f9da0f89SVipin KUMAR			CONFIG_USBD_HS
1454f9da0f89SVipin KUMAR			Define this to enable the high speed support for usb
1455f9da0f89SVipin KUMAR			device and usbtty. If this feature is enabled, a routine
1456f9da0f89SVipin KUMAR			int is_usbd_high_speed(void)
1457f9da0f89SVipin KUMAR			also needs to be defined by the driver to dynamically poll
1458f9da0f89SVipin KUMAR			whether the enumeration has succeded at high speed or full
1459f9da0f89SVipin KUMAR			speed.
1460f9da0f89SVipin KUMAR
14616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_IS_IN_ENV
146216c8d5e7SWolfgang Denk			Define this if you want stdin, stdout &/or stderr to
146316c8d5e7SWolfgang Denk			be set to usbtty.
146416c8d5e7SWolfgang Denk
146516c8d5e7SWolfgang Denk			mpc8xx:
14666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_EXTC_CLK 0xBLAH
146716c8d5e7SWolfgang Denk				Derive USB clock from external clock "blah"
14686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_EXTC_CLK 0x02
146916c8d5e7SWolfgang Denk
14706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_BRG_CLK 0xBLAH
147116c8d5e7SWolfgang Denk				Derive USB clock from brgclk
14726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_BRG_CLK 0x04
147316c8d5e7SWolfgang Denk
147416c8d5e7SWolfgang Denk		If you have a USB-IF assigned VendorID then you may wish to
147516c8d5e7SWolfgang Denk		define your own vendor specific values either in BoardName.h
147616c8d5e7SWolfgang Denk		or directly in usbd_vendor_info.h. If you don't define
147716c8d5e7SWolfgang Denk		CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
147816c8d5e7SWolfgang Denk		CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
147916c8d5e7SWolfgang Denk		should pretend to be a Linux device to it's target host.
148016c8d5e7SWolfgang Denk
148116c8d5e7SWolfgang Denk			CONFIG_USBD_MANUFACTURER
148216c8d5e7SWolfgang Denk			Define this string as the name of your company for
148316c8d5e7SWolfgang Denk			- CONFIG_USBD_MANUFACTURER "my company"
148416c8d5e7SWolfgang Denk
148516c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCT_NAME
148616c8d5e7SWolfgang Denk			Define this string as the name of your product
148716c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCT_NAME "acme usb device"
148816c8d5e7SWolfgang Denk
148916c8d5e7SWolfgang Denk			CONFIG_USBD_VENDORID
149016c8d5e7SWolfgang Denk			Define this as your assigned Vendor ID from the USB
149116c8d5e7SWolfgang Denk			Implementors Forum. This *must* be a genuine Vendor ID
149216c8d5e7SWolfgang Denk			to avoid polluting the USB namespace.
149316c8d5e7SWolfgang Denk			- CONFIG_USBD_VENDORID 0xFFFF
149416c8d5e7SWolfgang Denk
149516c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCTID
149616c8d5e7SWolfgang Denk			Define this as the unique Product ID
149716c8d5e7SWolfgang Denk			for your device
149816c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCTID 0xFFFF
1499c609719bSwdenk
1500d70a560fSIgor Grinberg- ULPI Layer Support:
1501d70a560fSIgor Grinberg		The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1502d70a560fSIgor Grinberg		the generic ULPI layer. The generic layer accesses the ULPI PHY
1503d70a560fSIgor Grinberg		via the platform viewport, so you need both the genric layer and
1504d70a560fSIgor Grinberg		the viewport enabled. Currently only Chipidea/ARC based
1505d70a560fSIgor Grinberg		viewport is supported.
1506d70a560fSIgor Grinberg		To enable the ULPI layer support, define CONFIG_USB_ULPI and
1507d70a560fSIgor Grinberg		CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
15086d365ea0SLucas Stach		If your ULPI phy needs a different reference clock than the
15096d365ea0SLucas Stach		standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
15106d365ea0SLucas Stach		the appropriate value in Hz.
1511c609719bSwdenk
1512c609719bSwdenk- MMC Support:
1513c609719bSwdenk		The MMC controller on the Intel PXA is supported. To
1514c609719bSwdenk		enable this define CONFIG_MMC. The MMC can be
1515c609719bSwdenk		accessed from the boot prompt by mapping the device
1516c609719bSwdenk		to physical memory similar to flash. Command line is
1517602ad3b3SJon Loeliger		enabled with CONFIG_CMD_MMC. The MMC driver also works with
1518602ad3b3SJon Loeliger		the FAT fs. This is enabled with CONFIG_CMD_FAT.
1519c609719bSwdenk
1520afb35666SYoshihiro Shimoda		CONFIG_SH_MMCIF
1521afb35666SYoshihiro Shimoda		Support for Renesas on-chip MMCIF controller
1522afb35666SYoshihiro Shimoda
1523afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_ADDR
1524afb35666SYoshihiro Shimoda			Define the base address of MMCIF registers
1525afb35666SYoshihiro Shimoda
1526afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_CLK
1527afb35666SYoshihiro Shimoda			Define the clock frequency for MMCIF
1528afb35666SYoshihiro Shimoda
15291fd93c6eSPierre Aubert		CONFIG_GENERIC_MMC
15301fd93c6eSPierre Aubert		Enable the generic MMC driver
15311fd93c6eSPierre Aubert
15321fd93c6eSPierre Aubert		CONFIG_SUPPORT_EMMC_BOOT
15331fd93c6eSPierre Aubert		Enable some additional features of the eMMC boot partitions.
15341fd93c6eSPierre Aubert
15351fd93c6eSPierre Aubert		CONFIG_SUPPORT_EMMC_RPMB
15361fd93c6eSPierre Aubert		Enable the commands for reading, writing and programming the
15371fd93c6eSPierre Aubert		key for the Replay Protection Memory Block partition in eMMC.
15381fd93c6eSPierre Aubert
1539b3ba6e94STom Rini- USB Device Firmware Update (DFU) class support:
1540b3ba6e94STom Rini		CONFIG_DFU_FUNCTION
1541b3ba6e94STom Rini		This enables the USB portion of the DFU USB class
1542b3ba6e94STom Rini
1543b3ba6e94STom Rini		CONFIG_CMD_DFU
1544b3ba6e94STom Rini		This enables the command "dfu" which is used to have
1545b3ba6e94STom Rini		U-Boot create a DFU class device via USB.  This command
1546b3ba6e94STom Rini		requires that the "dfu_alt_info" environment variable be
1547b3ba6e94STom Rini		set and define the alt settings to expose to the host.
1548b3ba6e94STom Rini
1549b3ba6e94STom Rini		CONFIG_DFU_MMC
1550b3ba6e94STom Rini		This enables support for exposing (e)MMC devices via DFU.
1551b3ba6e94STom Rini
1552c6631764SPantelis Antoniou		CONFIG_DFU_NAND
1553c6631764SPantelis Antoniou		This enables support for exposing NAND devices via DFU.
1554c6631764SPantelis Antoniou
1555a9479f04SAfzal Mohammed		CONFIG_DFU_RAM
1556a9479f04SAfzal Mohammed		This enables support for exposing RAM via DFU.
1557a9479f04SAfzal Mohammed		Note: DFU spec refer to non-volatile memory usage, but
1558a9479f04SAfzal Mohammed		allow usages beyond the scope of spec - here RAM usage,
1559a9479f04SAfzal Mohammed		one that would help mostly the developer.
1560a9479f04SAfzal Mohammed
1561e7e75c70SHeiko Schocher		CONFIG_SYS_DFU_DATA_BUF_SIZE
1562e7e75c70SHeiko Schocher		Dfu transfer uses a buffer before writing data to the
1563e7e75c70SHeiko Schocher		raw storage device. Make the size (in bytes) of this buffer
1564e7e75c70SHeiko Schocher		configurable. The size of this buffer is also configurable
1565e7e75c70SHeiko Schocher		through the "dfu_bufsiz" environment variable.
1566e7e75c70SHeiko Schocher
1567ea2453d5SPantelis Antoniou		CONFIG_SYS_DFU_MAX_FILE_SIZE
1568ea2453d5SPantelis Antoniou		When updating files rather than the raw storage device,
1569ea2453d5SPantelis Antoniou		we use a static buffer to copy the file into and then write
1570ea2453d5SPantelis Antoniou		the buffer once we've been given the whole file.  Define
1571ea2453d5SPantelis Antoniou		this to the maximum filesize (in bytes) for the buffer.
1572ea2453d5SPantelis Antoniou		Default is 4 MiB if undefined.
1573ea2453d5SPantelis Antoniou
1574001a8319SHeiko Schocher		DFU_DEFAULT_POLL_TIMEOUT
1575001a8319SHeiko Schocher		Poll timeout [ms], is the timeout a device can send to the
1576001a8319SHeiko Schocher		host. The host must wait for this timeout before sending
1577001a8319SHeiko Schocher		a subsequent DFU_GET_STATUS request to the device.
1578001a8319SHeiko Schocher
1579001a8319SHeiko Schocher		DFU_MANIFEST_POLL_TIMEOUT
1580001a8319SHeiko Schocher		Poll timeout [ms], which the device sends to the host when
1581001a8319SHeiko Schocher		entering dfuMANIFEST state. Host waits this timeout, before
1582001a8319SHeiko Schocher		sending again an USB request to the device.
1583001a8319SHeiko Schocher
15843aab70afSSebastian Siewior- USB Device Android Fastboot support:
15853aab70afSSebastian Siewior		CONFIG_CMD_FASTBOOT
15863aab70afSSebastian Siewior		This enables the command "fastboot" which enables the Android
15873aab70afSSebastian Siewior		fastboot mode for the platform's USB device. Fastboot is a USB
15883aab70afSSebastian Siewior		protocol for downloading images, flashing and device control
15893aab70afSSebastian Siewior		used on Android devices.
15903aab70afSSebastian Siewior		See doc/README.android-fastboot for more information.
15913aab70afSSebastian Siewior
15923aab70afSSebastian Siewior		CONFIG_ANDROID_BOOT_IMAGE
15933aab70afSSebastian Siewior		This enables support for booting images which use the Android
15943aab70afSSebastian Siewior		image format header.
15953aab70afSSebastian Siewior
15963aab70afSSebastian Siewior		CONFIG_USB_FASTBOOT_BUF_ADDR
15973aab70afSSebastian Siewior		The fastboot protocol requires a large memory buffer for
15983aab70afSSebastian Siewior		downloads. Define this to the starting RAM address to use for
15993aab70afSSebastian Siewior		downloaded images.
16003aab70afSSebastian Siewior
16013aab70afSSebastian Siewior		CONFIG_USB_FASTBOOT_BUF_SIZE
16023aab70afSSebastian Siewior		The fastboot protocol requires a large memory buffer for
16033aab70afSSebastian Siewior		downloads. This buffer should be as large as possible for a
16043aab70afSSebastian Siewior		platform. Define this to the size available RAM for fastboot.
16053aab70afSSebastian Siewior
16066705d81eSwdenk- Journaling Flash filesystem support:
16076705d81eSwdenk		CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
16086705d81eSwdenk		CONFIG_JFFS2_NAND_DEV
16096705d81eSwdenk		Define these for a default partition on a NAND device
16106705d81eSwdenk
16116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_SECTOR,
16126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
16136705d81eSwdenk		Define these for a default partition on a NOR device
16146705d81eSwdenk
16156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS_CUSTOM_PART
16166705d81eSwdenk		Define this to create an own partition. You have to provide a
16176705d81eSwdenk		function struct part_info* jffs2_part_info(int part_num)
16186705d81eSwdenk
16196705d81eSwdenk		If you define only one JFFS2 partition you may also want to
16206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_JFFS_SINGLE_PART	1
16216705d81eSwdenk		to disable the command chpart. This is the default when you
16226705d81eSwdenk		have not defined a custom partition
16236705d81eSwdenk
1624c30a15e5SDonggeun Kim- FAT(File Allocation Table) filesystem write function support:
1625c30a15e5SDonggeun Kim		CONFIG_FAT_WRITE
1626656f4c65SDonggeun Kim
1627656f4c65SDonggeun Kim		Define this to enable support for saving memory data as a
1628656f4c65SDonggeun Kim		file in FAT formatted partition.
1629656f4c65SDonggeun Kim
1630656f4c65SDonggeun Kim		This will also enable the command "fatwrite" enabling the
1631656f4c65SDonggeun Kim		user to write files to FAT.
1632c30a15e5SDonggeun Kim
163384cd9327SGabe BlackCBFS (Coreboot Filesystem) support
163484cd9327SGabe Black		CONFIG_CMD_CBFS
163584cd9327SGabe Black
163684cd9327SGabe Black		Define this to enable support for reading from a Coreboot
163784cd9327SGabe Black		filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
163884cd9327SGabe Black		and cbfsload.
163984cd9327SGabe Black
16404f0d1a2aSSiva Durga Prasad Paladugu- FAT(File Allocation Table) filesystem cluster size:
16414f0d1a2aSSiva Durga Prasad Paladugu		CONFIG_FS_FAT_MAX_CLUSTSIZE
16424f0d1a2aSSiva Durga Prasad Paladugu
16434f0d1a2aSSiva Durga Prasad Paladugu		Define the max cluster size for fat operations else
16444f0d1a2aSSiva Durga Prasad Paladugu		a default value of 65536 will be defined.
16454f0d1a2aSSiva Durga Prasad Paladugu
1646c609719bSwdenk- Keyboard Support:
1647c609719bSwdenk		CONFIG_ISA_KEYBOARD
1648c609719bSwdenk
1649c609719bSwdenk		Define this to enable standard (PC-Style) keyboard
1650c609719bSwdenk		support
1651c609719bSwdenk
1652c609719bSwdenk		CONFIG_I8042_KBD
1653c609719bSwdenk		Standard PC keyboard driver with US (is default) and
1654c609719bSwdenk		GERMAN key layout (switch via environment 'keymap=de') support.
1655c609719bSwdenk		Export function i8042_kbd_init, i8042_tstc and i8042_getc
1656c609719bSwdenk		for cfb_console. Supports cursor blinking.
1657c609719bSwdenk
1658713cb680SHung-ying Tyan		CONFIG_CROS_EC_KEYB
1659713cb680SHung-ying Tyan		Enables a Chrome OS keyboard using the CROS_EC interface.
1660713cb680SHung-ying Tyan		This uses CROS_EC to communicate with a second microcontroller
1661713cb680SHung-ying Tyan		which provides key scans on request.
1662713cb680SHung-ying Tyan
1663c609719bSwdenk- Video support:
1664c609719bSwdenk		CONFIG_VIDEO
1665c609719bSwdenk
1666c609719bSwdenk		Define this to enable video support (for output to
1667c609719bSwdenk		video).
1668c609719bSwdenk
1669c609719bSwdenk		CONFIG_VIDEO_CT69000
1670c609719bSwdenk
1671c609719bSwdenk		Enable Chips & Technologies 69000 Video chip
1672c609719bSwdenk
1673c609719bSwdenk		CONFIG_VIDEO_SMI_LYNXEM
1674eeb1b77bSwdenk		Enable Silicon Motion SMI 712/710/810 Video chip. The
1675eeb1b77bSwdenk		video output is selected via environment 'videoout'
1676eeb1b77bSwdenk		(1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1677eeb1b77bSwdenk		assumed.
1678c609719bSwdenk
1679eeb1b77bSwdenk		For the CT69000 and SMI_LYNXEM drivers, videomode is
168011ccc33fSMarcel Ziswiler		selected via environment 'videomode'. Two different ways
1681eeb1b77bSwdenk		are possible:
1682eeb1b77bSwdenk		- "videomode=num"   'num' is a standard LiLo mode numbers.
1683eeb1b77bSwdenk		Following standard modes are supported	(* is default):
1684eeb1b77bSwdenk
1685eeb1b77bSwdenk		      Colors	640x480 800x600 1024x768 1152x864 1280x1024
1686eeb1b77bSwdenk		-------------+---------------------------------------------
1687eeb1b77bSwdenk		      8 bits |	0x301*	0x303	 0x305	  0x161	    0x307
1688eeb1b77bSwdenk		     15 bits |	0x310	0x313	 0x316	  0x162	    0x319
1689eeb1b77bSwdenk		     16 bits |	0x311	0x314	 0x317	  0x163	    0x31A
1690eeb1b77bSwdenk		     24 bits |	0x312	0x315	 0x318	    ?	    0x31B
1691eeb1b77bSwdenk		-------------+---------------------------------------------
1692c609719bSwdenk		(i.e. setenv videomode 317; saveenv; reset;)
1693c609719bSwdenk
1694eeb1b77bSwdenk		- "videomode=bootargs" all the video parameters are parsed
16957817cb20SMarcel Ziswiler		from the bootargs. (See drivers/video/videomodes.c)
1696eeb1b77bSwdenk
1697eeb1b77bSwdenk
1698a6c7ad2fSwdenk		CONFIG_VIDEO_SED13806
1699a6c7ad2fSwdenk		Enable Epson SED13806 driver. This driver supports 8bpp
1700a6c7ad2fSwdenk		and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1701a6c7ad2fSwdenk		or CONFIG_VIDEO_SED13806_16BPP
1702a6c7ad2fSwdenk
17037d3053fbSTimur Tabi		CONFIG_FSL_DIU_FB
17047d3053fbSTimur Tabi		Enable the Freescale DIU video driver.	Reference boards for
17057d3053fbSTimur Tabi		SOCs that have a DIU should define this macro to enable DIU
17067d3053fbSTimur Tabi		support, and should also define these other macros:
17077d3053fbSTimur Tabi
17087d3053fbSTimur Tabi			CONFIG_SYS_DIU_ADDR
17097d3053fbSTimur Tabi			CONFIG_VIDEO
17107d3053fbSTimur Tabi			CONFIG_CMD_BMP
17117d3053fbSTimur Tabi			CONFIG_CFB_CONSOLE
17127d3053fbSTimur Tabi			CONFIG_VIDEO_SW_CURSOR
17137d3053fbSTimur Tabi			CONFIG_VGA_AS_SINGLE_DEVICE
17147d3053fbSTimur Tabi			CONFIG_VIDEO_LOGO
17157d3053fbSTimur Tabi			CONFIG_VIDEO_BMP_LOGO
17167d3053fbSTimur Tabi
1717ba8e76bdSTimur Tabi		The DIU driver will look for the 'video-mode' environment
1718ba8e76bdSTimur Tabi		variable, and if defined, enable the DIU as a console during
1719ba8e76bdSTimur Tabi		boot.  See the documentation file README.video for a
1720ba8e76bdSTimur Tabi		description of this variable.
17217d3053fbSTimur Tabi
1722058d59b0SSimon Glass		CONFIG_VIDEO_VGA
1723058d59b0SSimon Glass
1724058d59b0SSimon Glass		Enable the VGA video / BIOS for x86. The alternative if you
1725058d59b0SSimon Glass		are using coreboot is to use the coreboot frame buffer
1726058d59b0SSimon Glass		driver.
1727058d59b0SSimon Glass
1728058d59b0SSimon Glass
1729682011ffSwdenk- Keyboard Support:
1730682011ffSwdenk		CONFIG_KEYBOARD
1731682011ffSwdenk
1732682011ffSwdenk		Define this to enable a custom keyboard support.
1733682011ffSwdenk		This simply calls drv_keyboard_init() which must be
1734682011ffSwdenk		defined in your board-specific files.
1735682011ffSwdenk		The only board using this so far is RBC823.
1736a6c7ad2fSwdenk
1737c609719bSwdenk- LCD Support:	CONFIG_LCD
1738c609719bSwdenk
1739c609719bSwdenk		Define this to enable LCD support (for output to LCD
1740c609719bSwdenk		display); also select one of the supported displays
1741c609719bSwdenk		by defining one of these:
1742c609719bSwdenk
174339cf4804SStelian Pop		CONFIG_ATMEL_LCD:
174439cf4804SStelian Pop
174539cf4804SStelian Pop			HITACHI TX09D70VM1CCA, 3.5", 240x320.
174639cf4804SStelian Pop
1747fd3103bbSwdenk		CONFIG_NEC_NL6448AC33:
1748c609719bSwdenk
1749fd3103bbSwdenk			NEC NL6448AC33-18. Active, color, single scan.
1750c609719bSwdenk
1751fd3103bbSwdenk		CONFIG_NEC_NL6448BC20
1752c609719bSwdenk
1753fd3103bbSwdenk			NEC NL6448BC20-08. 6.5", 640x480.
1754fd3103bbSwdenk			Active, color, single scan.
1755fd3103bbSwdenk
1756fd3103bbSwdenk		CONFIG_NEC_NL6448BC33_54
1757fd3103bbSwdenk
1758fd3103bbSwdenk			NEC NL6448BC33-54. 10.4", 640x480.
1759c609719bSwdenk			Active, color, single scan.
1760c609719bSwdenk
1761c609719bSwdenk		CONFIG_SHARP_16x9
1762c609719bSwdenk
1763c609719bSwdenk			Sharp 320x240. Active, color, single scan.
1764c609719bSwdenk			It isn't 16x9, and I am not sure what it is.
1765c609719bSwdenk
1766c609719bSwdenk		CONFIG_SHARP_LQ64D341
1767c609719bSwdenk
1768c609719bSwdenk			Sharp LQ64D341 display, 640x480.
1769c609719bSwdenk			Active, color, single scan.
1770c609719bSwdenk
1771c609719bSwdenk		CONFIG_HLD1045
1772c609719bSwdenk
1773c609719bSwdenk			HLD1045 display, 640x480.
1774c609719bSwdenk			Active, color, single scan.
1775c609719bSwdenk
1776c609719bSwdenk		CONFIG_OPTREX_BW
1777c609719bSwdenk
1778c609719bSwdenk			Optrex	 CBL50840-2 NF-FW 99 22 M5
1779c609719bSwdenk			or
1780c609719bSwdenk			Hitachi	 LMG6912RPFC-00T
1781c609719bSwdenk			or
1782c609719bSwdenk			Hitachi	 SP14Q002
1783c609719bSwdenk
1784c609719bSwdenk			320x240. Black & white.
1785c609719bSwdenk
1786c609719bSwdenk		Normally display is black on white background; define
17876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
1788c609719bSwdenk
1789676d319eSSimon Glass		CONFIG_LCD_ALIGNMENT
1790676d319eSSimon Glass
1791676d319eSSimon Glass		Normally the LCD is page-aligned (tyically 4KB). If this is
1792676d319eSSimon Glass		defined then the LCD will be aligned to this value instead.
1793676d319eSSimon Glass		For ARM it is sometimes useful to use MMU_SECTION_SIZE
1794676d319eSSimon Glass		here, since it is cheaper to change data cache settings on
1795676d319eSSimon Glass		a per-section basis.
1796676d319eSSimon Glass
17970d89efefSSimon Glass		CONFIG_CONSOLE_SCROLL_LINES
17980d89efefSSimon Glass
17990d89efefSSimon Glass		When the console need to be scrolled, this is the number of
18000d89efefSSimon Glass		lines to scroll by. It defaults to 1. Increasing this makes
18010d89efefSSimon Glass		the console jump but can help speed up operation when scrolling
18020d89efefSSimon Glass		is slow.
1803676d319eSSimon Glass
180445d7f525STom Wai-Hong Tam		CONFIG_LCD_BMP_RLE8
180545d7f525STom Wai-Hong Tam
180645d7f525STom Wai-Hong Tam		Support drawing of RLE8-compressed bitmaps on the LCD.
180745d7f525STom Wai-Hong Tam
1808735987c5STom Wai-Hong Tam		CONFIG_I2C_EDID
1809735987c5STom Wai-Hong Tam
1810735987c5STom Wai-Hong Tam		Enables an 'i2c edid' command which can read EDID
1811735987c5STom Wai-Hong Tam		information over I2C from an attached LCD display.
1812735987c5STom Wai-Hong Tam
18137152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN
1814d791b1dcSwdenk
1815d791b1dcSwdenk		If this option is set, the environment is checked for
1816d791b1dcSwdenk		a variable "splashimage". If found, the usual display
1817d791b1dcSwdenk		of logo, copyright and system information on the LCD
1818e94d2cd9Swdenk		is suppressed and the BMP image at the address
1819d791b1dcSwdenk		specified in "splashimage" is loaded instead. The
1820d791b1dcSwdenk		console is redirected to the "nulldev", too. This
1821d791b1dcSwdenk		allows for a "silent" boot where a splash screen is
1822d791b1dcSwdenk		loaded very quickly after power-on.
1823d791b1dcSwdenk
1824c0880485SNikita Kiryanov		CONFIG_SPLASHIMAGE_GUARD
1825c0880485SNikita Kiryanov
1826c0880485SNikita Kiryanov		If this option is set, then U-Boot will prevent the environment
1827c0880485SNikita Kiryanov		variable "splashimage" from being set to a problematic address
18281551df35STom Rini		(see README.displaying-bmps).
1829c0880485SNikita Kiryanov		This option is useful for targets where, due to alignment
1830c0880485SNikita Kiryanov		restrictions, an improperly aligned BMP image will cause a data
1831c0880485SNikita Kiryanov		abort. If you think you will not have problems with unaligned
1832c0880485SNikita Kiryanov		accesses (for example because your toolchain prevents them)
1833c0880485SNikita Kiryanov		there is no need to set this option.
1834c0880485SNikita Kiryanov
18351ca298ceSMatthias Weisser		CONFIG_SPLASH_SCREEN_ALIGN
18361ca298ceSMatthias Weisser
18371ca298ceSMatthias Weisser		If this option is set the splash image can be freely positioned
18381ca298ceSMatthias Weisser		on the screen. Environment variable "splashpos" specifies the
18391ca298ceSMatthias Weisser		position as "x,y". If a positive number is given it is used as
18401ca298ceSMatthias Weisser		number of pixel from left/top. If a negative number is given it
18411ca298ceSMatthias Weisser		is used as number of pixel from right/bottom. You can also
18421ca298ceSMatthias Weisser		specify 'm' for centering the image.
18431ca298ceSMatthias Weisser
18441ca298ceSMatthias Weisser		Example:
18451ca298ceSMatthias Weisser		setenv splashpos m,m
18461ca298ceSMatthias Weisser			=> image at center of screen
18471ca298ceSMatthias Weisser
18481ca298ceSMatthias Weisser		setenv splashpos 30,20
18491ca298ceSMatthias Weisser			=> image at x = 30 and y = 20
18501ca298ceSMatthias Weisser
18511ca298ceSMatthias Weisser		setenv splashpos -10,m
18521ca298ceSMatthias Weisser			=> vertically centered image
18531ca298ceSMatthias Weisser			   at x = dspWidth - bmpWidth - 9
18541ca298ceSMatthias Weisser
185598f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
185698f4a3dfSStefan Roese
185798f4a3dfSStefan Roese		If this option is set, additionally to standard BMP
185898f4a3dfSStefan Roese		images, gzipped BMP images can be displayed via the
185998f4a3dfSStefan Roese		splashscreen support or the bmp command.
186098f4a3dfSStefan Roese
1861d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1862d5011762SAnatolij Gustschin
1863d5011762SAnatolij Gustschin		If this option is set, 8-bit RLE compressed BMP images
1864d5011762SAnatolij Gustschin		can be displayed via the splashscreen support or the
1865d5011762SAnatolij Gustschin		bmp command.
1866d5011762SAnatolij Gustschin
1867f2b96dfbSLei Wen- Do compresssing for memory range:
1868f2b96dfbSLei Wen		CONFIG_CMD_ZIP
1869f2b96dfbSLei Wen
1870f2b96dfbSLei Wen		If this option is set, it would use zlib deflate method
1871f2b96dfbSLei Wen		to compress the specified memory at its best effort.
1872f2b96dfbSLei Wen
1873c29fdfc1Swdenk- Compression support:
18748ef70478SKees Cook		CONFIG_GZIP
18758ef70478SKees Cook
18768ef70478SKees Cook		Enabled by default to support gzip compressed images.
18778ef70478SKees Cook
1878c29fdfc1Swdenk		CONFIG_BZIP2
1879c29fdfc1Swdenk
1880c29fdfc1Swdenk		If this option is set, support for bzip2 compressed
1881c29fdfc1Swdenk		images is included. If not, only uncompressed and gzip
1882c29fdfc1Swdenk		compressed images are supported.
1883c29fdfc1Swdenk
1884c29fdfc1Swdenk		NOTE: the bzip2 algorithm requires a lot of RAM, so
18856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
1886c29fdfc1Swdenk		be at least 4MB.
1887d791b1dcSwdenk
1888fc9c1727SLuigi 'Comio' Mantellini		CONFIG_LZMA
1889fc9c1727SLuigi 'Comio' Mantellini
1890fc9c1727SLuigi 'Comio' Mantellini		If this option is set, support for lzma compressed
1891fc9c1727SLuigi 'Comio' Mantellini		images is included.
1892fc9c1727SLuigi 'Comio' Mantellini
1893fc9c1727SLuigi 'Comio' Mantellini		Note: The LZMA algorithm adds between 2 and 4KB of code and it
1894fc9c1727SLuigi 'Comio' Mantellini		requires an amount of dynamic memory that is given by the
1895fc9c1727SLuigi 'Comio' Mantellini		formula:
1896fc9c1727SLuigi 'Comio' Mantellini
1897fc9c1727SLuigi 'Comio' Mantellini			(1846 + 768 << (lc + lp)) * sizeof(uint16)
1898fc9c1727SLuigi 'Comio' Mantellini
1899fc9c1727SLuigi 'Comio' Mantellini		Where lc and lp stand for, respectively, Literal context bits
1900fc9c1727SLuigi 'Comio' Mantellini		and Literal pos bits.
1901fc9c1727SLuigi 'Comio' Mantellini
1902fc9c1727SLuigi 'Comio' Mantellini		This value is upper-bounded by 14MB in the worst case. Anyway,
1903fc9c1727SLuigi 'Comio' Mantellini		for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1904fc9c1727SLuigi 'Comio' Mantellini		total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1905fc9c1727SLuigi 'Comio' Mantellini		a very small buffer.
1906fc9c1727SLuigi 'Comio' Mantellini
1907fc9c1727SLuigi 'Comio' Mantellini		Use the lzmainfo tool to determinate the lc and lp values and
1908fc9c1727SLuigi 'Comio' Mantellini		then calculate the amount of needed dynamic memory (ensuring
19096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the appropriate CONFIG_SYS_MALLOC_LEN value).
1910fc9c1727SLuigi 'Comio' Mantellini
19118ef70478SKees Cook		CONFIG_LZO
19128ef70478SKees Cook
19138ef70478SKees Cook		If this option is set, support for LZO compressed images
19148ef70478SKees Cook		is included.
19158ef70478SKees Cook
191617ea1177Swdenk- MII/PHY support:
191717ea1177Swdenk		CONFIG_PHY_ADDR
191817ea1177Swdenk
191917ea1177Swdenk		The address of PHY on MII bus.
192017ea1177Swdenk
192117ea1177Swdenk		CONFIG_PHY_CLOCK_FREQ (ppc4xx)
192217ea1177Swdenk
192317ea1177Swdenk		The clock frequency of the MII bus
192417ea1177Swdenk
192517ea1177Swdenk		CONFIG_PHY_GIGE
192617ea1177Swdenk
192717ea1177Swdenk		If this option is set, support for speed/duplex
192811ccc33fSMarcel Ziswiler		detection of gigabit PHY is included.
192917ea1177Swdenk
193017ea1177Swdenk		CONFIG_PHY_RESET_DELAY
193117ea1177Swdenk
193217ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
193317ea1177Swdenk		reset before any MII register access is possible.
193417ea1177Swdenk		For such PHY, set this option to the usec delay
193517ea1177Swdenk		required. (minimum 300usec for LXT971A)
193617ea1177Swdenk
193717ea1177Swdenk		CONFIG_PHY_CMD_DELAY (ppc4xx)
193817ea1177Swdenk
193917ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
194017ea1177Swdenk		command issued before MII status register can be read
194117ea1177Swdenk
1942c609719bSwdenk- Ethernet address:
1943c609719bSwdenk		CONFIG_ETHADDR
1944c68a05feSrichardretanubun		CONFIG_ETH1ADDR
1945c609719bSwdenk		CONFIG_ETH2ADDR
1946c609719bSwdenk		CONFIG_ETH3ADDR
1947c68a05feSrichardretanubun		CONFIG_ETH4ADDR
1948c68a05feSrichardretanubun		CONFIG_ETH5ADDR
1949c609719bSwdenk
195011ccc33fSMarcel Ziswiler		Define a default value for Ethernet address to use
195111ccc33fSMarcel Ziswiler		for the respective Ethernet interface, in case this
1952c609719bSwdenk		is not determined automatically.
1953c609719bSwdenk
1954c609719bSwdenk- IP address:
1955c609719bSwdenk		CONFIG_IPADDR
1956c609719bSwdenk
1957c609719bSwdenk		Define a default value for the IP address to use for
195811ccc33fSMarcel Ziswiler		the default Ethernet interface, in case this is not
1959c609719bSwdenk		determined through e.g. bootp.
19601ebcd654SWolfgang Denk		(Environment variable "ipaddr")
1961c609719bSwdenk
1962c609719bSwdenk- Server IP address:
1963c609719bSwdenk		CONFIG_SERVERIP
1964c609719bSwdenk
1965c609719bSwdenk		Defines a default value for the IP address of a TFTP
1966c609719bSwdenk		server to contact when using the "tftboot" command.
19671ebcd654SWolfgang Denk		(Environment variable "serverip")
1968c609719bSwdenk
196997cfe861SRobin Getz		CONFIG_KEEP_SERVERADDR
197097cfe861SRobin Getz
197197cfe861SRobin Getz		Keeps the server's MAC address, in the env 'serveraddr'
197297cfe861SRobin Getz		for passing to bootargs (like Linux's netconsole option)
197397cfe861SRobin Getz
19741ebcd654SWolfgang Denk- Gateway IP address:
19751ebcd654SWolfgang Denk		CONFIG_GATEWAYIP
19761ebcd654SWolfgang Denk
19771ebcd654SWolfgang Denk		Defines a default value for the IP address of the
19781ebcd654SWolfgang Denk		default router where packets to other networks are
19791ebcd654SWolfgang Denk		sent to.
19801ebcd654SWolfgang Denk		(Environment variable "gatewayip")
19811ebcd654SWolfgang Denk
19821ebcd654SWolfgang Denk- Subnet mask:
19831ebcd654SWolfgang Denk		CONFIG_NETMASK
19841ebcd654SWolfgang Denk
19851ebcd654SWolfgang Denk		Defines a default value for the subnet mask (or
19861ebcd654SWolfgang Denk		routing prefix) which is used to determine if an IP
19871ebcd654SWolfgang Denk		address belongs to the local subnet or needs to be
19881ebcd654SWolfgang Denk		forwarded through a router.
19891ebcd654SWolfgang Denk		(Environment variable "netmask")
19901ebcd654SWolfgang Denk
199153a5c424SDavid Updegraff- Multicast TFTP Mode:
199253a5c424SDavid Updegraff		CONFIG_MCAST_TFTP
199353a5c424SDavid Updegraff
199453a5c424SDavid Updegraff		Defines whether you want to support multicast TFTP as per
199553a5c424SDavid Updegraff		rfc-2090; for example to work with atftp.  Lets lots of targets
199611ccc33fSMarcel Ziswiler		tftp down the same boot image concurrently.  Note: the Ethernet
199753a5c424SDavid Updegraff		driver in use must provide a function: mcast() to join/leave a
199853a5c424SDavid Updegraff		multicast group.
199953a5c424SDavid Updegraff
2000c609719bSwdenk- BOOTP Recovery Mode:
2001c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY
2002c609719bSwdenk
2003c609719bSwdenk		If you have many targets in a network that try to
2004c609719bSwdenk		boot using BOOTP, you may want to avoid that all
2005c609719bSwdenk		systems send out BOOTP requests at precisely the same
2006c609719bSwdenk		moment (which would happen for instance at recovery
2007c609719bSwdenk		from a power failure, when all systems will try to
2008c609719bSwdenk		boot, thus flooding the BOOTP server. Defining
2009c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
2010c609719bSwdenk		inserted before sending out BOOTP requests. The
20116c33c785SWolfgang Denk		following delays are inserted then:
2012c609719bSwdenk
2013c609719bSwdenk		1st BOOTP request:	delay 0 ... 1 sec
2014c609719bSwdenk		2nd BOOTP request:	delay 0 ... 2 sec
2015c609719bSwdenk		3rd BOOTP request:	delay 0 ... 4 sec
2016c609719bSwdenk		4th and following
2017c609719bSwdenk		BOOTP requests:		delay 0 ... 8 sec
2018c609719bSwdenk
2019fe389a82Sstroese- DHCP Advanced Options:
20201fe80d79SJon Loeliger		You can fine tune the DHCP functionality by defining
20211fe80d79SJon Loeliger		CONFIG_BOOTP_* symbols:
2022fe389a82Sstroese
20231fe80d79SJon Loeliger		CONFIG_BOOTP_SUBNETMASK
20241fe80d79SJon Loeliger		CONFIG_BOOTP_GATEWAY
20251fe80d79SJon Loeliger		CONFIG_BOOTP_HOSTNAME
20261fe80d79SJon Loeliger		CONFIG_BOOTP_NISDOMAIN
20271fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTPATH
20281fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTFILESIZE
20291fe80d79SJon Loeliger		CONFIG_BOOTP_DNS
20301fe80d79SJon Loeliger		CONFIG_BOOTP_DNS2
20311fe80d79SJon Loeliger		CONFIG_BOOTP_SEND_HOSTNAME
20321fe80d79SJon Loeliger		CONFIG_BOOTP_NTPSERVER
20331fe80d79SJon Loeliger		CONFIG_BOOTP_TIMEOFFSET
20341fe80d79SJon Loeliger		CONFIG_BOOTP_VENDOREX
20352c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL
2036fe389a82Sstroese
20375d110f0aSWilson Callan		CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
20385d110f0aSWilson Callan		environment variable, not the BOOTP server.
2039fe389a82Sstroese
20402c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
20412c00e099SJoe Hershberger		after the configured retry count, the call will fail
20422c00e099SJoe Hershberger		instead of starting over.  This can be used to fail over
20432c00e099SJoe Hershberger		to Link-local IP address configuration if the DHCP server
20442c00e099SJoe Hershberger		is not available.
20452c00e099SJoe Hershberger
2046fe389a82Sstroese		CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
2047fe389a82Sstroese		serverip from a DHCP server, it is possible that more
2048fe389a82Sstroese		than one DNS serverip is offered to the client.
2049fe389a82Sstroese		If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
2050fe389a82Sstroese		serverip will be stored in the additional environment
2051fe389a82Sstroese		variable "dnsip2". The first DNS serverip is always
2052fe389a82Sstroese		stored in the variable "dnsip", when CONFIG_BOOTP_DNS
20531fe80d79SJon Loeliger		is defined.
2054fe389a82Sstroese
2055fe389a82Sstroese		CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
2056fe389a82Sstroese		to do a dynamic update of a DNS server. To do this, they
2057fe389a82Sstroese		need the hostname of the DHCP requester.
20585d110f0aSWilson Callan		If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
20591fe80d79SJon Loeliger		of the "hostname" environment variable is passed as
20601fe80d79SJon Loeliger		option 12 to the DHCP server.
2061fe389a82Sstroese
2062d9a2f416SAras Vaichas		CONFIG_BOOTP_DHCP_REQUEST_DELAY
2063d9a2f416SAras Vaichas
2064d9a2f416SAras Vaichas		A 32bit value in microseconds for a delay between
2065d9a2f416SAras Vaichas		receiving a "DHCP Offer" and sending the "DHCP Request".
2066d9a2f416SAras Vaichas		This fixes a problem with certain DHCP servers that don't
2067d9a2f416SAras Vaichas		respond 100% of the time to a "DHCP request". E.g. On an
2068d9a2f416SAras Vaichas		AT91RM9200 processor running at 180MHz, this delay needed
2069d9a2f416SAras Vaichas		to be *at least* 15,000 usec before a Windows Server 2003
2070d9a2f416SAras Vaichas		DHCP server would reply 100% of the time. I recommend at
2071d9a2f416SAras Vaichas		least 50,000 usec to be safe. The alternative is to hope
2072d9a2f416SAras Vaichas		that one of the retries will be successful but note that
2073d9a2f416SAras Vaichas		the DHCP timeout and retry process takes a longer than
2074d9a2f416SAras Vaichas		this delay.
2075d9a2f416SAras Vaichas
2076d22c338eSJoe Hershberger - Link-local IP address negotiation:
2077d22c338eSJoe Hershberger		Negotiate with other link-local clients on the local network
2078d22c338eSJoe Hershberger		for an address that doesn't require explicit configuration.
2079d22c338eSJoe Hershberger		This is especially useful if a DHCP server cannot be guaranteed
2080d22c338eSJoe Hershberger		to exist in all environments that the device must operate.
2081d22c338eSJoe Hershberger
2082d22c338eSJoe Hershberger		See doc/README.link-local for more information.
2083d22c338eSJoe Hershberger
2084a3d991bdSwdenk - CDP Options:
2085a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID
2086a3d991bdSwdenk
2087a3d991bdSwdenk		The device id used in CDP trigger frames.
2088a3d991bdSwdenk
2089a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID_PREFIX
2090a3d991bdSwdenk
2091a3d991bdSwdenk		A two character string which is prefixed to the MAC address
2092a3d991bdSwdenk		of the device.
2093a3d991bdSwdenk
2094a3d991bdSwdenk		CONFIG_CDP_PORT_ID
2095a3d991bdSwdenk
2096a3d991bdSwdenk		A printf format string which contains the ascii name of
2097a3d991bdSwdenk		the port. Normally is set to "eth%d" which sets
209811ccc33fSMarcel Ziswiler		eth0 for the first Ethernet, eth1 for the second etc.
2099a3d991bdSwdenk
2100a3d991bdSwdenk		CONFIG_CDP_CAPABILITIES
2101a3d991bdSwdenk
2102a3d991bdSwdenk		A 32bit integer which indicates the device capabilities;
2103a3d991bdSwdenk		0x00000010 for a normal host which does not forwards.
2104a3d991bdSwdenk
2105a3d991bdSwdenk		CONFIG_CDP_VERSION
2106a3d991bdSwdenk
2107a3d991bdSwdenk		An ascii string containing the version of the software.
2108a3d991bdSwdenk
2109a3d991bdSwdenk		CONFIG_CDP_PLATFORM
2110a3d991bdSwdenk
2111a3d991bdSwdenk		An ascii string containing the name of the platform.
2112a3d991bdSwdenk
2113a3d991bdSwdenk		CONFIG_CDP_TRIGGER
2114a3d991bdSwdenk
2115a3d991bdSwdenk		A 32bit integer sent on the trigger.
2116a3d991bdSwdenk
2117a3d991bdSwdenk		CONFIG_CDP_POWER_CONSUMPTION
2118a3d991bdSwdenk
2119a3d991bdSwdenk		A 16bit integer containing the power consumption of the
2120a3d991bdSwdenk		device in .1 of milliwatts.
2121a3d991bdSwdenk
2122a3d991bdSwdenk		CONFIG_CDP_APPLIANCE_VLAN_TYPE
2123a3d991bdSwdenk
2124a3d991bdSwdenk		A byte containing the id of the VLAN.
2125a3d991bdSwdenk
2126c609719bSwdenk- Status LED:	CONFIG_STATUS_LED
2127c609719bSwdenk
2128c609719bSwdenk		Several configurations allow to display the current
2129c609719bSwdenk		status using a LED. For instance, the LED will blink
2130c609719bSwdenk		fast while running U-Boot code, stop blinking as
2131c609719bSwdenk		soon as a reply to a BOOTP request was received, and
2132c609719bSwdenk		start blinking slow once the Linux kernel is running
2133c609719bSwdenk		(supported by a status LED driver in the Linux
2134c609719bSwdenk		kernel). Defining CONFIG_STATUS_LED enables this
2135c609719bSwdenk		feature in U-Boot.
2136c609719bSwdenk
21371df7bbbaSIgor Grinberg		Additional options:
21381df7bbbaSIgor Grinberg
21391df7bbbaSIgor Grinberg		CONFIG_GPIO_LED
21401df7bbbaSIgor Grinberg		The status LED can be connected to a GPIO pin.
21411df7bbbaSIgor Grinberg		In such cases, the gpio_led driver can be used as a
21421df7bbbaSIgor Grinberg		status LED backend implementation. Define CONFIG_GPIO_LED
21431df7bbbaSIgor Grinberg		to include the gpio_led driver in the U-Boot binary.
21441df7bbbaSIgor Grinberg
21459dfdcdfeSIgor Grinberg		CONFIG_GPIO_LED_INVERTED_TABLE
21469dfdcdfeSIgor Grinberg		Some GPIO connected LEDs may have inverted polarity in which
21479dfdcdfeSIgor Grinberg		case the GPIO high value corresponds to LED off state and
21489dfdcdfeSIgor Grinberg		GPIO low value corresponds to LED on state.
21499dfdcdfeSIgor Grinberg		In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
21509dfdcdfeSIgor Grinberg		with a list of GPIO LEDs that have inverted polarity.
21519dfdcdfeSIgor Grinberg
2152c609719bSwdenk- CAN Support:	CONFIG_CAN_DRIVER
2153c609719bSwdenk
2154c609719bSwdenk		Defining CONFIG_CAN_DRIVER enables CAN driver support
2155c609719bSwdenk		on those systems that support this (optional)
2156c609719bSwdenk		feature, like the TQM8xxL modules.
2157c609719bSwdenk
21583f4978c7SHeiko Schocher- I2C Support:	CONFIG_SYS_I2C
2159c609719bSwdenk
21603f4978c7SHeiko Schocher		This enable the NEW i2c subsystem, and will allow you to use
21613f4978c7SHeiko Schocher		i2c commands at the u-boot command line (as long as you set
21623f4978c7SHeiko Schocher		CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
21633f4978c7SHeiko Schocher		based realtime clock chips or other i2c devices. See
21643f4978c7SHeiko Schocher		common/cmd_i2c.c for a description of the command line
21653f4978c7SHeiko Schocher		interface.
21663f4978c7SHeiko Schocher
21673f4978c7SHeiko Schocher		ported i2c driver to the new framework:
2168ea818dbbSHeiko Schocher		- drivers/i2c/soft_i2c.c:
2169ea818dbbSHeiko Schocher		  - activate first bus with CONFIG_SYS_I2C_SOFT define
2170ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2171ea818dbbSHeiko Schocher		    for defining speed and slave address
2172ea818dbbSHeiko Schocher		  - activate second bus with I2C_SOFT_DECLARATIONS2 define
2173ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2174ea818dbbSHeiko Schocher		    for defining speed and slave address
2175ea818dbbSHeiko Schocher		  - activate third bus with I2C_SOFT_DECLARATIONS3 define
2176ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2177ea818dbbSHeiko Schocher		    for defining speed and slave address
2178ea818dbbSHeiko Schocher		  - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2179ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2180ea818dbbSHeiko Schocher		    for defining speed and slave address
21813f4978c7SHeiko Schocher
218200f792e0SHeiko Schocher		- drivers/i2c/fsl_i2c.c:
218300f792e0SHeiko Schocher		  - activate i2c driver with CONFIG_SYS_I2C_FSL
218400f792e0SHeiko Schocher		    define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
218500f792e0SHeiko Schocher		    offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
218600f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
218700f792e0SHeiko Schocher		    bus.
218800f792e0SHeiko Schocher		  - If your board supports a second fsl i2c bus, define
218900f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
219000f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_SPEED for the speed and
219100f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
219200f792e0SHeiko Schocher		    second bus.
219300f792e0SHeiko Schocher
21941f2ba722SSimon Glass		- drivers/i2c/tegra_i2c.c:
21951f2ba722SSimon Glass		  - activate this driver with CONFIG_SYS_I2C_TEGRA
21961f2ba722SSimon Glass		  - This driver adds 4 i2c buses with a fix speed from
21971f2ba722SSimon Glass		    100000 and the slave addr 0!
21981f2ba722SSimon Glass
2199880540deSDirk Eibach		- drivers/i2c/ppc4xx_i2c.c
2200880540deSDirk Eibach		  - activate this driver with CONFIG_SYS_I2C_PPC4XX
2201880540deSDirk Eibach		  - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2202880540deSDirk Eibach		  - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2203880540deSDirk Eibach
2204fac96408Strem		- drivers/i2c/i2c_mxc.c
2205fac96408Strem		  - activate this driver with CONFIG_SYS_I2C_MXC
2206fac96408Strem		  - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2207fac96408Strem		  - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2208fac96408Strem		  - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2209fac96408Strem		  - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2210fac96408Strem		  - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2211fac96408Strem		  - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
2212fac96408Strem		If thoses defines are not set, default value is 100000
2213fac96408Strem		for speed, and 0 for slave.
2214fac96408Strem
22151086bfa9SNobuhiro Iwamatsu		- drivers/i2c/rcar_i2c.c:
22161086bfa9SNobuhiro Iwamatsu		  - activate this driver with CONFIG_SYS_I2C_RCAR
22171086bfa9SNobuhiro Iwamatsu		  - This driver adds 4 i2c buses
22181086bfa9SNobuhiro Iwamatsu
22191086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
22201086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
22211086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
22221086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
22231086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
22241086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
22251086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
22261086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
22271086bfa9SNobuhiro Iwamatsu		  - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
22281086bfa9SNobuhiro Iwamatsu
22292035d77dSNobuhiro Iwamatsu		- drivers/i2c/sh_i2c.c:
22302035d77dSNobuhiro Iwamatsu		  - activate this driver with CONFIG_SYS_I2C_SH
22312035d77dSNobuhiro Iwamatsu		  - This driver adds from 2 to 5 i2c buses
22322035d77dSNobuhiro Iwamatsu
22332035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
22342035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
22352035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
22362035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
22372035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
22382035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
22392035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
22402035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
22412035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
22422035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
22432035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
22442035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
22452035d77dSNobuhiro Iwamatsu		  - CONFIF_SYS_I2C_SH_NUM_CONTROLLERS for nummber of i2c buses
22462035d77dSNobuhiro Iwamatsu
22476789e84eSHeiko Schocher		- drivers/i2c/omap24xx_i2c.c
22486789e84eSHeiko Schocher		  - activate this driver with CONFIG_SYS_I2C_OMAP24XX
22496789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
22506789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
22516789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
22526789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
22536789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
22546789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
22556789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
22566789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
22576789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
22586789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
22596789e84eSHeiko Schocher
22600bdffe71SHeiko Schocher		- drivers/i2c/zynq_i2c.c
22610bdffe71SHeiko Schocher		  - activate this driver with CONFIG_SYS_I2C_ZYNQ
22620bdffe71SHeiko Schocher		  - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
22630bdffe71SHeiko Schocher		  - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
22640bdffe71SHeiko Schocher
2265e717fc6dSNaveen Krishna Ch		- drivers/i2c/s3c24x0_i2c.c:
2266e717fc6dSNaveen Krishna Ch		  - activate this driver with CONFIG_SYS_I2C_S3C24X0
2267e717fc6dSNaveen Krishna Ch		  - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2268e717fc6dSNaveen Krishna Ch		    9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2269e717fc6dSNaveen Krishna Ch		    with a fix speed from 100000 and the slave addr 0!
2270e717fc6dSNaveen Krishna Ch
22713f4978c7SHeiko Schocher		additional defines:
22723f4978c7SHeiko Schocher
22733f4978c7SHeiko Schocher		CONFIG_SYS_NUM_I2C_BUSES
22743f4978c7SHeiko Schocher		Hold the number of i2c busses you want to use. If you
22753f4978c7SHeiko Schocher		don't use/have i2c muxes on your i2c bus, this
22763f4978c7SHeiko Schocher		is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
22773f4978c7SHeiko Schocher		omit this define.
22783f4978c7SHeiko Schocher
22793f4978c7SHeiko Schocher		CONFIG_SYS_I2C_DIRECT_BUS
22803f4978c7SHeiko Schocher		define this, if you don't use i2c muxes on your hardware.
22813f4978c7SHeiko Schocher		if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
22823f4978c7SHeiko Schocher		omit this define.
22833f4978c7SHeiko Schocher
22843f4978c7SHeiko Schocher		CONFIG_SYS_I2C_MAX_HOPS
22853f4978c7SHeiko Schocher		define how many muxes are maximal consecutively connected
22863f4978c7SHeiko Schocher		on one i2c bus. If you not use i2c muxes, omit this
22873f4978c7SHeiko Schocher		define.
22883f4978c7SHeiko Schocher
22893f4978c7SHeiko Schocher		CONFIG_SYS_I2C_BUSES
22903f4978c7SHeiko Schocher		hold a list of busses you want to use, only used if
22913f4978c7SHeiko Schocher		CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
22923f4978c7SHeiko Schocher		a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
22933f4978c7SHeiko Schocher		CONFIG_SYS_NUM_I2C_BUSES = 9:
22943f4978c7SHeiko Schocher
22953f4978c7SHeiko Schocher		 CONFIG_SYS_I2C_BUSES	{{0, {I2C_NULL_HOP}}, \
22963f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
22973f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
22983f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
22993f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
23003f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
23013f4978c7SHeiko Schocher					{1, {I2C_NULL_HOP}}, \
23023f4978c7SHeiko Schocher					{1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
23033f4978c7SHeiko Schocher					{1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
23043f4978c7SHeiko Schocher					}
23053f4978c7SHeiko Schocher
23063f4978c7SHeiko Schocher		which defines
23073f4978c7SHeiko Schocher			bus 0 on adapter 0 without a mux
2308ea818dbbSHeiko Schocher			bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2309ea818dbbSHeiko Schocher			bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2310ea818dbbSHeiko Schocher			bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2311ea818dbbSHeiko Schocher			bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2312ea818dbbSHeiko Schocher			bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
23133f4978c7SHeiko Schocher			bus 6 on adapter 1 without a mux
2314ea818dbbSHeiko Schocher			bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2315ea818dbbSHeiko Schocher			bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
23163f4978c7SHeiko Schocher
23173f4978c7SHeiko Schocher		If you do not have i2c muxes on your board, omit this define.
23183f4978c7SHeiko Schocher
2319ea818dbbSHeiko Schocher- Legacy I2C Support:	CONFIG_HARD_I2C
23203f4978c7SHeiko Schocher
23213f4978c7SHeiko Schocher		NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
23223f4978c7SHeiko Schocher		provides the following compelling advantages:
23233f4978c7SHeiko Schocher
23243f4978c7SHeiko Schocher		- more than one i2c adapter is usable
23253f4978c7SHeiko Schocher		- approved multibus support
23263f4978c7SHeiko Schocher		- better i2c mux support
23273f4978c7SHeiko Schocher
23283f4978c7SHeiko Schocher		** Please consider updating your I2C driver now. **
23293f4978c7SHeiko Schocher
2330ea818dbbSHeiko Schocher		These enable legacy I2C serial bus commands. Defining
2331ea818dbbSHeiko Schocher		CONFIG_HARD_I2C will include the appropriate I2C driver
2332ea818dbbSHeiko Schocher		for the selected CPU.
2333c609719bSwdenk
2334b37c7e5eSwdenk		This will allow you to use i2c commands at the u-boot
2335602ad3b3SJon Loeliger		command line (as long as you set CONFIG_CMD_I2C in
2336b37c7e5eSwdenk		CONFIG_COMMANDS) and communicate with i2c based realtime
2337b37c7e5eSwdenk		clock chips. See common/cmd_i2c.c for a description of the
2338c609719bSwdenk		command line interface.
2339c609719bSwdenk
2340bb99ad6dSBen Warren		CONFIG_HARD_I2C selects a hardware I2C controller.
2341c609719bSwdenk
2342b37c7e5eSwdenk		There are several other quantities that must also be
2343ea818dbbSHeiko Schocher		defined when you define CONFIG_HARD_I2C.
2344c609719bSwdenk
23456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		In both cases you will need to define CONFIG_SYS_I2C_SPEED
2346b37c7e5eSwdenk		to be the frequency (in Hz) at which you wish your i2c bus
23476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
234811ccc33fSMarcel Ziswiler		the CPU's i2c node address).
2349c609719bSwdenk
23508d321b81SPeter Tyser		Now, the u-boot i2c code for the mpc8xx
2351a47a12beSStefan Roese		(arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
23528d321b81SPeter Tyser		and so its address should therefore be cleared to 0 (See,
23538d321b81SPeter Tyser		eg, MPC823e User's Manual p.16-473). So, set
23548d321b81SPeter Tyser		CONFIG_SYS_I2C_SLAVE to 0.
2355b37c7e5eSwdenk
23565da71efaSEric Millbrandt		CONFIG_SYS_I2C_INIT_MPC5XXX
23575da71efaSEric Millbrandt
23585da71efaSEric Millbrandt		When a board is reset during an i2c bus transfer
23595da71efaSEric Millbrandt		chips might think that the current transfer is still
23605da71efaSEric Millbrandt		in progress.  Reset the slave devices by sending start
23615da71efaSEric Millbrandt		commands until the slave device responds.
23625da71efaSEric Millbrandt
2363b37c7e5eSwdenk		That's all that's required for CONFIG_HARD_I2C.
2364b37c7e5eSwdenk
2365ea818dbbSHeiko Schocher		If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
2366b37c7e5eSwdenk		then the following macros need to be defined (examples are
2367b37c7e5eSwdenk		from include/configs/lwmon.h):
2368c609719bSwdenk
2369c609719bSwdenk		I2C_INIT
2370c609719bSwdenk
2371b37c7e5eSwdenk		(Optional). Any commands necessary to enable the I2C
2372c609719bSwdenk		controller or configure ports.
2373c609719bSwdenk
2374b37c7e5eSwdenk		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
2375b37c7e5eSwdenk
2376c609719bSwdenk		I2C_PORT
2377c609719bSwdenk
2378c609719bSwdenk		(Only for MPC8260 CPU). The I/O port to use (the code
2379c609719bSwdenk		assumes both bits are on the same port). Valid values
2380c609719bSwdenk		are 0..3 for ports A..D.
2381c609719bSwdenk
2382c609719bSwdenk		I2C_ACTIVE
2383c609719bSwdenk
2384c609719bSwdenk		The code necessary to make the I2C data line active
2385c609719bSwdenk		(driven).  If the data line is open collector, this
2386c609719bSwdenk		define can be null.
2387c609719bSwdenk
2388b37c7e5eSwdenk		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
2389b37c7e5eSwdenk
2390c609719bSwdenk		I2C_TRISTATE
2391c609719bSwdenk
2392c609719bSwdenk		The code necessary to make the I2C data line tri-stated
2393c609719bSwdenk		(inactive).  If the data line is open collector, this
2394c609719bSwdenk		define can be null.
2395c609719bSwdenk
2396b37c7e5eSwdenk		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2397b37c7e5eSwdenk
2398c609719bSwdenk		I2C_READ
2399c609719bSwdenk
2400472d5460SYork Sun		Code that returns true if the I2C data line is high,
2401472d5460SYork Sun		false if it is low.
2402c609719bSwdenk
2403b37c7e5eSwdenk		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2404b37c7e5eSwdenk
2405c609719bSwdenk		I2C_SDA(bit)
2406c609719bSwdenk
2407472d5460SYork Sun		If <bit> is true, sets the I2C data line high. If it
2408472d5460SYork Sun		is false, it clears it (low).
2409c609719bSwdenk
2410b37c7e5eSwdenk		eg: #define I2C_SDA(bit) \
2411b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
2412b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
2413b37c7e5eSwdenk
2414c609719bSwdenk		I2C_SCL(bit)
2415c609719bSwdenk
2416472d5460SYork Sun		If <bit> is true, sets the I2C clock line high. If it
2417472d5460SYork Sun		is false, it clears it (low).
2418c609719bSwdenk
2419b37c7e5eSwdenk		eg: #define I2C_SCL(bit) \
2420b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
2421b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
2422b37c7e5eSwdenk
2423c609719bSwdenk		I2C_DELAY
2424c609719bSwdenk
2425c609719bSwdenk		This delay is invoked four times per clock cycle so this
2426c609719bSwdenk		controls the rate of data transfer.  The data rate thus
2427b37c7e5eSwdenk		is 1 / (I2C_DELAY * 4). Often defined to be something
2428b37c7e5eSwdenk		like:
2429b37c7e5eSwdenk
2430b37c7e5eSwdenk		#define I2C_DELAY  udelay(2)
2431c609719bSwdenk
2432793b5726SMike Frysinger		CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2433793b5726SMike Frysinger
2434793b5726SMike Frysinger		If your arch supports the generic GPIO framework (asm/gpio.h),
2435793b5726SMike Frysinger		then you may alternatively define the two GPIOs that are to be
2436793b5726SMike Frysinger		used as SCL / SDA.  Any of the previous I2C_xxx macros will
2437793b5726SMike Frysinger		have GPIO-based defaults assigned to them as appropriate.
2438793b5726SMike Frysinger
2439793b5726SMike Frysinger		You should define these to the GPIO value as given directly to
2440793b5726SMike Frysinger		the generic GPIO functions.
2441793b5726SMike Frysinger
24426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_INIT_BOARD
244347cd00faSwdenk
244447cd00faSwdenk		When a board is reset during an i2c bus transfer
244547cd00faSwdenk		chips might think that the current transfer is still
244647cd00faSwdenk		in progress. On some boards it is possible to access
244747cd00faSwdenk		the i2c SCLK line directly, either by using the
244847cd00faSwdenk		processor pin as a GPIO or by having a second pin
244947cd00faSwdenk		connected to the bus. If this option is defined a
245047cd00faSwdenk		custom i2c_init_board() routine in boards/xxx/board.c
245147cd00faSwdenk		is run early in the boot sequence.
245247cd00faSwdenk
245326a33504SRichard Retanubun		CONFIG_SYS_I2C_BOARD_LATE_INIT
245426a33504SRichard Retanubun
245526a33504SRichard Retanubun		An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
245626a33504SRichard Retanubun		defined a custom i2c_board_late_init() routine in
245726a33504SRichard Retanubun		boards/xxx/board.c is run AFTER the operations in i2c_init()
245826a33504SRichard Retanubun		is completed. This callpoint can be used to unreset i2c bus
245926a33504SRichard Retanubun		using CPU i2c controller register accesses for CPUs whose i2c
246026a33504SRichard Retanubun		controller provide such a method. It is called at the end of
246126a33504SRichard Retanubun		i2c_init() to allow i2c_init operations to setup the i2c bus
246226a33504SRichard Retanubun		controller on the CPU (e.g. setting bus speed & slave address).
246326a33504SRichard Retanubun
246417ea1177Swdenk		CONFIG_I2CFAST (PPC405GP|PPC405EP only)
246517ea1177Swdenk
246617ea1177Swdenk		This option enables configuration of bi_iic_fast[] flags
246717ea1177Swdenk		in u-boot bd_info structure based on u-boot environment
246817ea1177Swdenk		variable "i2cfast". (see also i2cfast)
246917ea1177Swdenk
2470bb99ad6dSBen Warren		CONFIG_I2C_MULTI_BUS
2471bb99ad6dSBen Warren
2472bb99ad6dSBen Warren		This option allows the use of multiple I2C buses, each of which
2473bb99ad6dSBen Warren		must have a controller.	 At any point in time, only one bus is
2474bb99ad6dSBen Warren		active.	 To switch to a different bus, use the 'i2c dev' command.
2475bb99ad6dSBen Warren		Note that bus numbering is zero-based.
2476bb99ad6dSBen Warren
24776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_NOPROBES
2478bb99ad6dSBen Warren
2479bb99ad6dSBen Warren		This option specifies a list of I2C devices that will be skipped
24800f89c54bSPeter Tyser		when the 'i2c probe' command is issued.	 If CONFIG_I2C_MULTI_BUS
24810f89c54bSPeter Tyser		is set, specify a list of bus-device pairs.  Otherwise, specify
24820f89c54bSPeter Tyser		a 1D array of device addresses
2483bb99ad6dSBen Warren
2484bb99ad6dSBen Warren		e.g.
2485bb99ad6dSBen Warren			#undef	CONFIG_I2C_MULTI_BUS
24866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
2487bb99ad6dSBen Warren
2488bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on a board with one I2C bus
2489bb99ad6dSBen Warren
2490bb99ad6dSBen Warren			#define CONFIG_I2C_MULTI_BUS
24916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_MULTI_NOPROBES	{{0,0x50},{0,0x68},{1,0x54}}
2492bb99ad6dSBen Warren
2493bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2494bb99ad6dSBen Warren
24956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SPD_BUS_NUM
2496be5e6181STimur Tabi
2497be5e6181STimur Tabi		If defined, then this indicates the I2C bus number for DDR SPD.
2498be5e6181STimur Tabi		If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2499be5e6181STimur Tabi
25006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_BUS_NUM
25010dc018ecSStefan Roese
25020dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the RTC.
25030dc018ecSStefan Roese		If not defined, then U-Boot assumes that RTC is on I2C bus 0.
25040dc018ecSStefan Roese
25056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_DTT_BUS_NUM
25060dc018ecSStefan Roese
25070dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the DTT.
25080dc018ecSStefan Roese		If not defined, then U-Boot assumes that DTT is on I2C bus 0.
25090dc018ecSStefan Roese
25106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_DTT_ADDR:
25119ebbb54fSVictor Gallardo
25129ebbb54fSVictor Gallardo		If defined, specifies the I2C address of the DTT device.
25139ebbb54fSVictor Gallardo		If not defined, then U-Boot uses predefined value for
25149ebbb54fSVictor Gallardo		specified DTT device.
25159ebbb54fSVictor Gallardo
25162ac6985aSAndrew Dyer		CONFIG_SOFT_I2C_READ_REPEATED_START
25172ac6985aSAndrew Dyer
25182ac6985aSAndrew Dyer		defining this will force the i2c_read() function in
25192ac6985aSAndrew Dyer		the soft_i2c driver to perform an I2C repeated start
25202ac6985aSAndrew Dyer		between writing the address pointer and reading the
25212ac6985aSAndrew Dyer		data.  If this define is omitted the default behaviour
25222ac6985aSAndrew Dyer		of doing a stop-start sequence will be used.  Most I2C
25232ac6985aSAndrew Dyer		devices can use either method, but some require one or
25242ac6985aSAndrew Dyer		the other.
2525be5e6181STimur Tabi
2526c609719bSwdenk- SPI Support:	CONFIG_SPI
2527c609719bSwdenk
2528c609719bSwdenk		Enables SPI driver (so far only tested with
2529c609719bSwdenk		SPI EEPROM, also an instance works with Crystal A/D and
2530c609719bSwdenk		D/As on the SACSng board)
2531c609719bSwdenk
25326639562eSYoshihiro Shimoda		CONFIG_SH_SPI
25336639562eSYoshihiro Shimoda
25346639562eSYoshihiro Shimoda		Enables the driver for SPI controller on SuperH. Currently
25356639562eSYoshihiro Shimoda		only SH7757 is supported.
25366639562eSYoshihiro Shimoda
2537c609719bSwdenk		CONFIG_SPI_X
2538c609719bSwdenk
2539c609719bSwdenk		Enables extended (16-bit) SPI EEPROM addressing.
2540c609719bSwdenk		(symmetrical to CONFIG_I2C_X)
2541c609719bSwdenk
2542c609719bSwdenk		CONFIG_SOFT_SPI
2543c609719bSwdenk
2544c609719bSwdenk		Enables a software (bit-bang) SPI driver rather than
2545c609719bSwdenk		using hardware support. This is a general purpose
2546c609719bSwdenk		driver that only requires three general I/O port pins
2547c609719bSwdenk		(two outputs, one input) to function. If this is
2548c609719bSwdenk		defined, the board configuration must define several
2549c609719bSwdenk		SPI configuration items (port pins to use, etc). For
2550c609719bSwdenk		an example, see include/configs/sacsng.h.
2551c609719bSwdenk
255204a9e118SBen Warren		CONFIG_HARD_SPI
255304a9e118SBen Warren
255404a9e118SBen Warren		Enables a hardware SPI driver for general-purpose reads
255504a9e118SBen Warren		and writes.  As with CONFIG_SOFT_SPI, the board configuration
255604a9e118SBen Warren		must define a list of chip-select function pointers.
255704a9e118SBen Warren		Currently supported on some MPC8xxx processors.	 For an
255804a9e118SBen Warren		example, see include/configs/mpc8349emds.h.
255904a9e118SBen Warren
256038254f45SGuennadi Liakhovetski		CONFIG_MXC_SPI
256138254f45SGuennadi Liakhovetski
256238254f45SGuennadi Liakhovetski		Enables the driver for the SPI controllers on i.MX and MXC
25632e3cd1cdSFabio Estevam		SoCs. Currently i.MX31/35/51 are supported.
256438254f45SGuennadi Liakhovetski
25650133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA
25660133502eSMatthias Fuchs
25670133502eSMatthias Fuchs		Enables FPGA subsystem.
25680133502eSMatthias Fuchs
25690133502eSMatthias Fuchs		CONFIG_FPGA_<vendor>
25700133502eSMatthias Fuchs
25710133502eSMatthias Fuchs		Enables support for specific chip vendors.
25720133502eSMatthias Fuchs		(ALTERA, XILINX)
25730133502eSMatthias Fuchs
25740133502eSMatthias Fuchs		CONFIG_FPGA_<family>
25750133502eSMatthias Fuchs
25760133502eSMatthias Fuchs		Enables support for FPGA family.
25770133502eSMatthias Fuchs		(SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
25780133502eSMatthias Fuchs
25790133502eSMatthias Fuchs		CONFIG_FPGA_COUNT
2580c609719bSwdenk
2581c609719bSwdenk		Specify the number of FPGA devices to support.
2582c609719bSwdenk
258364e809afSSiva Durga Prasad Paladugu		CONFIG_CMD_FPGA_LOADMK
258464e809afSSiva Durga Prasad Paladugu
258564e809afSSiva Durga Prasad Paladugu		Enable support for fpga loadmk command
258664e809afSSiva Durga Prasad Paladugu
258767193864SMichal Simek		CONFIG_CMD_FPGA_LOADP
258867193864SMichal Simek
258967193864SMichal Simek		Enable support for fpga loadp command - load partial bitstream
259067193864SMichal Simek
259167193864SMichal Simek		CONFIG_CMD_FPGA_LOADBP
259267193864SMichal Simek
259367193864SMichal Simek		Enable support for fpga loadbp command - load partial bitstream
259467193864SMichal Simek		(Xilinx only)
259567193864SMichal Simek
25966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_PROG_FEEDBACK
2597c609719bSwdenk
2598c609719bSwdenk		Enable printing of hash marks during FPGA configuration.
2599c609719bSwdenk
26006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_BUSY
2601c609719bSwdenk
2602c609719bSwdenk		Enable checks on FPGA configuration interface busy
2603c609719bSwdenk		status by the configuration function. This option
2604c609719bSwdenk		will require a board or device specific function to
2605c609719bSwdenk		be written.
2606c609719bSwdenk
2607c609719bSwdenk		CONFIG_FPGA_DELAY
2608c609719bSwdenk
2609c609719bSwdenk		If defined, a function that provides delays in the FPGA
2610c609719bSwdenk		configuration driver.
2611c609719bSwdenk
26126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_CTRLC
2613c609719bSwdenk		Allow Control-C to interrupt FPGA configuration
2614c609719bSwdenk
26156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_ERROR
2616c609719bSwdenk
2617c609719bSwdenk		Check for configuration errors during FPGA bitfile
2618c609719bSwdenk		loading. For example, abort during Virtex II
2619c609719bSwdenk		configuration if the INIT_B line goes low (which
2620c609719bSwdenk		indicated a CRC error).
2621c609719bSwdenk
26226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_INIT
2623c609719bSwdenk
2624c609719bSwdenk		Maximum time to wait for the INIT_B line to deassert
2625c609719bSwdenk		after PROB_B has been deasserted during a Virtex II
2626c609719bSwdenk		FPGA configuration sequence. The default time is 500
262711ccc33fSMarcel Ziswiler		ms.
2628c609719bSwdenk
26296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_BUSY
2630c609719bSwdenk
2631c609719bSwdenk		Maximum time to wait for BUSY to deassert during
263211ccc33fSMarcel Ziswiler		Virtex II FPGA configuration. The default is 5 ms.
2633c609719bSwdenk
26346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_CONFIG
2635c609719bSwdenk
2636c609719bSwdenk		Time to wait after FPGA configuration. The default is
263711ccc33fSMarcel Ziswiler		200 ms.
2638c609719bSwdenk
2639c609719bSwdenk- Configuration Management:
2640c609719bSwdenk		CONFIG_IDENT_STRING
2641c609719bSwdenk
2642c609719bSwdenk		If defined, this string will be added to the U-Boot
2643c609719bSwdenk		version information (U_BOOT_VERSION)
2644c609719bSwdenk
2645c609719bSwdenk- Vendor Parameter Protection:
2646c609719bSwdenk
2647c609719bSwdenk		U-Boot considers the values of the environment
2648c609719bSwdenk		variables "serial#" (Board Serial Number) and
26497152b1d0Swdenk		"ethaddr" (Ethernet Address) to be parameters that
2650c609719bSwdenk		are set once by the board vendor / manufacturer, and
2651c609719bSwdenk		protects these variables from casual modification by
2652c609719bSwdenk		the user. Once set, these variables are read-only,
2653c609719bSwdenk		and write or delete attempts are rejected. You can
265411ccc33fSMarcel Ziswiler		change this behaviour:
2655c609719bSwdenk
2656c609719bSwdenk		If CONFIG_ENV_OVERWRITE is #defined in your config
2657c609719bSwdenk		file, the write protection for vendor parameters is
265847cd00faSwdenk		completely disabled. Anybody can change or delete
2659c609719bSwdenk		these parameters.
2660c609719bSwdenk
2661c609719bSwdenk		Alternatively, if you #define _both_ CONFIG_ETHADDR
2662c609719bSwdenk		_and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
266311ccc33fSMarcel Ziswiler		Ethernet address is installed in the environment,
2664c609719bSwdenk		which can be changed exactly ONCE by the user. [The
2665c609719bSwdenk		serial# is unaffected by this, i. e. it remains
2666c609719bSwdenk		read-only.]
2667c609719bSwdenk
26682598090bSJoe Hershberger		The same can be accomplished in a more flexible way
26692598090bSJoe Hershberger		for any variable by configuring the type of access
26702598090bSJoe Hershberger		to allow for those variables in the ".flags" variable
26712598090bSJoe Hershberger		or define CONFIG_ENV_FLAGS_LIST_STATIC.
26722598090bSJoe Hershberger
2673c609719bSwdenk- Protected RAM:
2674c609719bSwdenk		CONFIG_PRAM
2675c609719bSwdenk
2676c609719bSwdenk		Define this variable to enable the reservation of
2677c609719bSwdenk		"protected RAM", i. e. RAM which is not overwritten
2678c609719bSwdenk		by U-Boot. Define CONFIG_PRAM to hold the number of
2679c609719bSwdenk		kB you want to reserve for pRAM. You can overwrite
2680c609719bSwdenk		this default value by defining an environment
2681c609719bSwdenk		variable "pram" to the number of kB you want to
2682c609719bSwdenk		reserve. Note that the board info structure will
2683c609719bSwdenk		still show the full amount of RAM. If pRAM is
2684c609719bSwdenk		reserved, a new environment variable "mem" will
2685c609719bSwdenk		automatically be defined to hold the amount of
2686c609719bSwdenk		remaining RAM in a form that can be passed as boot
2687c609719bSwdenk		argument to Linux, for instance like that:
2688c609719bSwdenk
2689fe126d8bSWolfgang Denk			setenv bootargs ... mem=\${mem}
2690c609719bSwdenk			saveenv
2691c609719bSwdenk
2692c609719bSwdenk		This way you can tell Linux not to use this memory,
2693c609719bSwdenk		either, which results in a memory region that will
2694c609719bSwdenk		not be affected by reboots.
2695c609719bSwdenk
2696c609719bSwdenk		*WARNING* If your board configuration uses automatic
2697c609719bSwdenk		detection of the RAM size, you must make sure that
2698c609719bSwdenk		this memory test is non-destructive. So far, the
2699c609719bSwdenk		following board configurations are known to be
2700c609719bSwdenk		"pRAM-clean":
2701c609719bSwdenk
27021b0757ecSWolfgang Denk			IVMS8, IVML24, SPD8xx, TQM8xxL,
27031b0757ecSWolfgang Denk			HERMES, IP860, RPXlite, LWMON,
2704544d97e9SWolfgang Denk			FLAGADM, TQM8260
2705c609719bSwdenk
270640fef049SGabe Black- Access to physical memory region (> 4GB)
270740fef049SGabe Black		Some basic support is provided for operations on memory not
270840fef049SGabe Black		normally accessible to U-Boot - e.g. some architectures
270940fef049SGabe Black		support access to more than 4GB of memory on 32-bit
271040fef049SGabe Black		machines using physical address extension or similar.
271140fef049SGabe Black		Define CONFIG_PHYSMEM to access this basic support, which
271240fef049SGabe Black		currently only supports clearing the memory.
271340fef049SGabe Black
2714c609719bSwdenk- Error Recovery:
2715c609719bSwdenk		CONFIG_PANIC_HANG
2716c609719bSwdenk
2717c609719bSwdenk		Define this variable to stop the system in case of a
2718c609719bSwdenk		fatal error, so that you have to reset it manually.
2719c609719bSwdenk		This is probably NOT a good idea for an embedded
272011ccc33fSMarcel Ziswiler		system where you want the system to reboot
2721c609719bSwdenk		automatically as fast as possible, but it may be
2722c609719bSwdenk		useful during development since you can try to debug
2723c609719bSwdenk		the conditions that lead to the situation.
2724c609719bSwdenk
2725c609719bSwdenk		CONFIG_NET_RETRY_COUNT
2726c609719bSwdenk
2727c609719bSwdenk		This variable defines the number of retries for
2728c609719bSwdenk		network operations like ARP, RARP, TFTP, or BOOTP
2729c609719bSwdenk		before giving up the operation. If not defined, a
2730c609719bSwdenk		default value of 5 is used.
2731c609719bSwdenk
273240cb90eeSGuennadi Liakhovetski		CONFIG_ARP_TIMEOUT
273340cb90eeSGuennadi Liakhovetski
273440cb90eeSGuennadi Liakhovetski		Timeout waiting for an ARP reply in milliseconds.
273540cb90eeSGuennadi Liakhovetski
273648a3e999STetsuyuki Kobayashi		CONFIG_NFS_TIMEOUT
273748a3e999STetsuyuki Kobayashi
273848a3e999STetsuyuki Kobayashi		Timeout in milliseconds used in NFS protocol.
273948a3e999STetsuyuki Kobayashi		If you encounter "ERROR: Cannot umount" in nfs command,
274048a3e999STetsuyuki Kobayashi		try longer timeout such as
274148a3e999STetsuyuki Kobayashi		#define CONFIG_NFS_TIMEOUT 10000UL
274248a3e999STetsuyuki Kobayashi
2743c609719bSwdenk- Command Interpreter:
27448078f1a5SWolfgang Denk		CONFIG_AUTO_COMPLETE
274504a85b3bSwdenk
274604a85b3bSwdenk		Enable auto completion of commands using TAB.
274704a85b3bSwdenk
27488078f1a5SWolfgang Denk		Note that this feature has NOT been implemented yet
27498078f1a5SWolfgang Denk		for the "hush" shell.
27508078f1a5SWolfgang Denk
27518078f1a5SWolfgang Denk
27526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_HUSH_PARSER
2753c609719bSwdenk
2754c609719bSwdenk		Define this variable to enable the "hush" shell (from
2755c609719bSwdenk		Busybox) as command line interpreter, thus enabling
2756c609719bSwdenk		powerful command line syntax like
2757c609719bSwdenk		if...then...else...fi conditionals or `&&' and '||'
2758c609719bSwdenk		constructs ("shell scripts").
2759c609719bSwdenk
2760c609719bSwdenk		If undefined, you get the old, much simpler behaviour
2761c609719bSwdenk		with a somewhat smaller memory footprint.
2762c609719bSwdenk
2763c609719bSwdenk
27646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_PROMPT_HUSH_PS2
2765c609719bSwdenk
2766c609719bSwdenk		This defines the secondary prompt string, which is
2767c609719bSwdenk		printed when the command interpreter needs more input
2768c609719bSwdenk		to complete a command. Usually "> ".
2769c609719bSwdenk
2770c609719bSwdenk	Note:
2771c609719bSwdenk
2772c609719bSwdenk		In the current implementation, the local variables
2773c609719bSwdenk		space and global environment variables space are
2774c609719bSwdenk		separated. Local variables are those you define by
27753b57fe0aSwdenk		simply typing `name=value'. To access a local
2776c609719bSwdenk		variable later on, you have write `$name' or
27773b57fe0aSwdenk		`${name}'; to execute the contents of a variable
27783b57fe0aSwdenk		directly type `$name' at the command prompt.
2779c609719bSwdenk
2780c609719bSwdenk		Global environment variables are those you use
2781c609719bSwdenk		setenv/printenv to work with. To run a command stored
2782c609719bSwdenk		in such a variable, you need to use the run command,
2783c609719bSwdenk		and you must not use the '$' sign to access them.
2784c609719bSwdenk
2785c609719bSwdenk		To store commands and special characters in a
2786c609719bSwdenk		variable, please use double quotation marks
2787c609719bSwdenk		surrounding the whole text of the variable, instead
2788c609719bSwdenk		of the backslashes before semicolons and special
2789c609719bSwdenk		symbols.
2790c609719bSwdenk
2791aa0c71acSWolfgang Denk- Commandline Editing and History:
2792aa0c71acSWolfgang Denk		CONFIG_CMDLINE_EDITING
2793aa0c71acSWolfgang Denk
279411ccc33fSMarcel Ziswiler		Enable editing and History functions for interactive
2795aa0c71acSWolfgang Denk		commandline input operations
2796aa0c71acSWolfgang Denk
2797a8c7c708Swdenk- Default Environment:
2798c609719bSwdenk		CONFIG_EXTRA_ENV_SETTINGS
2799c609719bSwdenk
2800c609719bSwdenk		Define this to contain any number of null terminated
2801c609719bSwdenk		strings (variable = value pairs) that will be part of
28027152b1d0Swdenk		the default environment compiled into the boot image.
28032262cfeeSwdenk
2804c609719bSwdenk		For example, place something like this in your
2805c609719bSwdenk		board's config file:
2806c609719bSwdenk
2807c609719bSwdenk		#define CONFIG_EXTRA_ENV_SETTINGS \
2808c609719bSwdenk			"myvar1=value1\0" \
2809c609719bSwdenk			"myvar2=value2\0"
2810c609719bSwdenk
2811c609719bSwdenk		Warning: This method is based on knowledge about the
2812c609719bSwdenk		internal format how the environment is stored by the
28132262cfeeSwdenk		U-Boot code. This is NOT an official, exported
2814c609719bSwdenk		interface! Although it is unlikely that this format
28157152b1d0Swdenk		will change soon, there is no guarantee either.
2816c609719bSwdenk		You better know what you are doing here.
2817c609719bSwdenk
2818c609719bSwdenk		Note: overly (ab)use of the default environment is
2819c609719bSwdenk		discouraged. Make sure to check other ways to preset
282074de7aefSWolfgang Denk		the environment like the "source" command or the
2821c609719bSwdenk		boot command first.
2822c609719bSwdenk
28235e724ca2SStephen Warren		CONFIG_ENV_VARS_UBOOT_CONFIG
28245e724ca2SStephen Warren
28255e724ca2SStephen Warren		Define this in order to add variables describing the
28265e724ca2SStephen Warren		U-Boot build configuration to the default environment.
28275e724ca2SStephen Warren		These will be named arch, cpu, board, vendor, and soc.
28285e724ca2SStephen Warren
28295e724ca2SStephen Warren		Enabling this option will cause the following to be defined:
28305e724ca2SStephen Warren
28315e724ca2SStephen Warren		- CONFIG_SYS_ARCH
28325e724ca2SStephen Warren		- CONFIG_SYS_CPU
28335e724ca2SStephen Warren		- CONFIG_SYS_BOARD
28345e724ca2SStephen Warren		- CONFIG_SYS_VENDOR
28355e724ca2SStephen Warren		- CONFIG_SYS_SOC
28365e724ca2SStephen Warren
28377e27f89fSTom Rini		CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
28387e27f89fSTom Rini
28397e27f89fSTom Rini		Define this in order to add variables describing certain
28407e27f89fSTom Rini		run-time determined information about the hardware to the
28417e27f89fSTom Rini		environment.  These will be named board_name, board_rev.
28427e27f89fSTom Rini
284306fd8538SSimon Glass		CONFIG_DELAY_ENVIRONMENT
284406fd8538SSimon Glass
284506fd8538SSimon Glass		Normally the environment is loaded when the board is
284606fd8538SSimon Glass		intialised so that it is available to U-Boot. This inhibits
284706fd8538SSimon Glass		that so that the environment is not available until
284806fd8538SSimon Glass		explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
284906fd8538SSimon Glass		this is instead controlled by the value of
285006fd8538SSimon Glass		/config/load-environment.
285106fd8538SSimon Glass
2852a8c7c708Swdenk- DataFlash Support:
28532abbe075Swdenk		CONFIG_HAS_DATAFLASH
28542abbe075Swdenk
28552abbe075Swdenk		Defining this option enables DataFlash features and
28562abbe075Swdenk		allows to read/write in Dataflash via the standard
28572abbe075Swdenk		commands cp, md...
28582abbe075Swdenk
2859f61ec45eSEric Nelson- Serial Flash support
2860f61ec45eSEric Nelson		CONFIG_CMD_SF
2861f61ec45eSEric Nelson
2862f61ec45eSEric Nelson		Defining this option enables SPI flash commands
2863f61ec45eSEric Nelson		'sf probe/read/write/erase/update'.
2864f61ec45eSEric Nelson
2865f61ec45eSEric Nelson		Usage requires an initial 'probe' to define the serial
2866f61ec45eSEric Nelson		flash parameters, followed by read/write/erase/update
2867f61ec45eSEric Nelson		commands.
2868f61ec45eSEric Nelson
2869f61ec45eSEric Nelson		The following defaults may be provided by the platform
2870f61ec45eSEric Nelson		to handle the common case when only a single serial
2871f61ec45eSEric Nelson		flash is present on the system.
2872f61ec45eSEric Nelson
2873f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_BUS		Bus identifier
2874f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_CS		Chip-select
2875f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_MODE 		(see include/spi.h)
2876f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_SPEED		in Hz
2877f61ec45eSEric Nelson
287824007273SSimon Glass		CONFIG_CMD_SF_TEST
287924007273SSimon Glass
288024007273SSimon Glass		Define this option to include a destructive SPI flash
288124007273SSimon Glass		test ('sf test').
288224007273SSimon Glass
28831dcd6d03SJagannadha Sutradharudu Teki		CONFIG_SPI_FLASH_BAR		Ban/Extended Addr Reg
28841dcd6d03SJagannadha Sutradharudu Teki
28851dcd6d03SJagannadha Sutradharudu Teki		Define this option to use the Bank addr/Extended addr
28861dcd6d03SJagannadha Sutradharudu Teki		support on SPI flashes which has size > 16Mbytes.
28871dcd6d03SJagannadha Sutradharudu Teki
2888b902e07cSJagannadha Sutradharudu Teki		CONFIG_SF_DUAL_FLASH		Dual flash memories
2889b902e07cSJagannadha Sutradharudu Teki
2890b902e07cSJagannadha Sutradharudu Teki		Define this option to use dual flash support where two flash
2891b902e07cSJagannadha Sutradharudu Teki		memories can be connected with a given cs line.
2892b902e07cSJagannadha Sutradharudu Teki		currently Xilinx Zynq qspi support these type of connections.
2893b902e07cSJagannadha Sutradharudu Teki
28943f85ce27Swdenk- SystemACE Support:
28953f85ce27Swdenk		CONFIG_SYSTEMACE
28963f85ce27Swdenk
28973f85ce27Swdenk		Adding this option adds support for Xilinx SystemACE
28983f85ce27Swdenk		chips attached via some sort of local bus. The address
289911ccc33fSMarcel Ziswiler		of the chip must also be defined in the
29006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SYSTEMACE_BASE macro. For example:
29013f85ce27Swdenk
29023f85ce27Swdenk		#define CONFIG_SYSTEMACE
29036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
29043f85ce27Swdenk
29053f85ce27Swdenk		When SystemACE support is added, the "ace" device type
29063f85ce27Swdenk		becomes available to the fat commands, i.e. fatls.
29073f85ce27Swdenk
2908ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port:
2909ecb0ccd9SWolfgang Denk		CONFIG_TFTP_PORT
2910ecb0ccd9SWolfgang Denk
291128cb9375SWolfgang Denk		If this is defined, the environment variable tftpsrcp
2912ecb0ccd9SWolfgang Denk		is used to supply the TFTP UDP source port value.
291328cb9375SWolfgang Denk		If tftpsrcp isn't defined, the normal pseudo-random port
2914ecb0ccd9SWolfgang Denk		number generator is used.
2915ecb0ccd9SWolfgang Denk
291628cb9375SWolfgang Denk		Also, the environment variable tftpdstp is used to supply
291728cb9375SWolfgang Denk		the TFTP UDP destination port value.  If tftpdstp isn't
291828cb9375SWolfgang Denk		defined, the normal port 69 is used.
291928cb9375SWolfgang Denk
292028cb9375SWolfgang Denk		The purpose for tftpsrcp is to allow a TFTP server to
2921ecb0ccd9SWolfgang Denk		blindly start the TFTP transfer using the pre-configured
2922ecb0ccd9SWolfgang Denk		target IP address and UDP port. This has the effect of
2923ecb0ccd9SWolfgang Denk		"punching through" the (Windows XP) firewall, allowing
2924ecb0ccd9SWolfgang Denk		the remainder of the TFTP transfer to proceed normally.
2925ecb0ccd9SWolfgang Denk		A better solution is to properly configure the firewall,
2926ecb0ccd9SWolfgang Denk		but sometimes that is not allowed.
2927ecb0ccd9SWolfgang Denk
2928bf36c5d5SSimon Glass- Hashing support:
2929bf36c5d5SSimon Glass		CONFIG_CMD_HASH
2930bf36c5d5SSimon Glass
2931bf36c5d5SSimon Glass		This enables a generic 'hash' command which can produce
2932bf36c5d5SSimon Glass		hashes / digests from a few algorithms (e.g. SHA1, SHA256).
2933bf36c5d5SSimon Glass
2934bf36c5d5SSimon Glass		CONFIG_HASH_VERIFY
2935bf36c5d5SSimon Glass
2936bf36c5d5SSimon Glass		Enable the hash verify command (hash -v). This adds to code
2937bf36c5d5SSimon Glass		size a little.
2938bf36c5d5SSimon Glass
2939bf36c5d5SSimon Glass		CONFIG_SHA1 - support SHA1 hashing
2940bf36c5d5SSimon Glass		CONFIG_SHA256 - support SHA256 hashing
2941bf36c5d5SSimon Glass
2942bf36c5d5SSimon Glass		Note: There is also a sha1sum command, which should perhaps
2943bf36c5d5SSimon Glass		be deprecated in favour of 'hash sha1'.
2944bf36c5d5SSimon Glass
2945a11f1873SRobert Winkler- Freescale i.MX specific commands:
2946a11f1873SRobert Winkler		CONFIG_CMD_HDMIDETECT
2947a11f1873SRobert Winkler		This enables 'hdmidet' command which returns true if an
2948a11f1873SRobert Winkler		HDMI monitor is detected.  This command is i.MX 6 specific.
2949a11f1873SRobert Winkler
2950a11f1873SRobert Winkler		CONFIG_CMD_BMODE
2951a11f1873SRobert Winkler		This enables the 'bmode' (bootmode) command for forcing
2952a11f1873SRobert Winkler		a boot from specific media.
2953a11f1873SRobert Winkler
2954a11f1873SRobert Winkler		This is useful for forcing the ROM's usb downloader to
2955a11f1873SRobert Winkler		activate upon a watchdog reset which is nice when iterating
2956a11f1873SRobert Winkler		on U-Boot.  Using the reset button or running bmode normal
2957a11f1873SRobert Winkler		will set it back to normal.  This command currently
2958a11f1873SRobert Winkler		supports i.MX53 and i.MX6.
2959a11f1873SRobert Winkler
296019c402afSSimon Glass- Signing support:
296119c402afSSimon Glass		CONFIG_RSA
296219c402afSSimon Glass
296319c402afSSimon Glass		This enables the RSA algorithm used for FIT image verification
29648bf2aad7SDetlev Zundel		in U-Boot. See doc/uImage.FIT/signature.txt for more information.
296519c402afSSimon Glass
296619c402afSSimon Glass		The signing part is build into mkimage regardless of this
296719c402afSSimon Glass		option.
296819c402afSSimon Glass
29699e50c406SHeiko Schocher- bootcount support:
29709e50c406SHeiko Schocher		CONFIG_BOOTCOUNT_LIMIT
29719e50c406SHeiko Schocher
29729e50c406SHeiko Schocher		This enables the bootcounter support, see:
29739e50c406SHeiko Schocher		http://www.denx.de/wiki/DULG/UBootBootCountLimit
29749e50c406SHeiko Schocher
29759e50c406SHeiko Schocher		CONFIG_AT91SAM9XE
29769e50c406SHeiko Schocher		enable special bootcounter support on at91sam9xe based boards.
29779e50c406SHeiko Schocher		CONFIG_BLACKFIN
29789e50c406SHeiko Schocher		enable special bootcounter support on blackfin based boards.
29799e50c406SHeiko Schocher		CONFIG_SOC_DA8XX
29809e50c406SHeiko Schocher		enable special bootcounter support on da850 based boards.
29819e50c406SHeiko Schocher		CONFIG_BOOTCOUNT_RAM
29829e50c406SHeiko Schocher		enable support for the bootcounter in RAM
29839e50c406SHeiko Schocher		CONFIG_BOOTCOUNT_I2C
29849e50c406SHeiko Schocher		enable support for the bootcounter on an i2c (like RTC) device.
29859e50c406SHeiko Schocher			CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
29869e50c406SHeiko Schocher			CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
29879e50c406SHeiko Schocher						    the bootcounter.
29889e50c406SHeiko Schocher			CONFIG_BOOTCOUNT_ALEN = address len
298919c402afSSimon Glass
2990a8c7c708Swdenk- Show boot progress:
2991c609719bSwdenk		CONFIG_SHOW_BOOT_PROGRESS
2992c609719bSwdenk
2993c609719bSwdenk		Defining this option allows to add some board-
2994c609719bSwdenk		specific code (calling a user-provided function
2995c609719bSwdenk		"show_boot_progress(int)") that enables you to show
2996c609719bSwdenk		the system's boot progress on some display (for
2997c609719bSwdenk		example, some LED's) on your board. At the moment,
2998c609719bSwdenk		the following checkpoints are implemented:
2999c609719bSwdenk
30003a608ca0SSimon Glass- Detailed boot stage timing
30013a608ca0SSimon Glass		CONFIG_BOOTSTAGE
30023a608ca0SSimon Glass		Define this option to get detailed timing of each stage
30033a608ca0SSimon Glass		of the boot process.
30043a608ca0SSimon Glass
30053a608ca0SSimon Glass		CONFIG_BOOTSTAGE_USER_COUNT
30063a608ca0SSimon Glass		This is the number of available user bootstage records.
30073a608ca0SSimon Glass		Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
30083a608ca0SSimon Glass		a new ID will be allocated from this stash. If you exceed
30093a608ca0SSimon Glass		the limit, recording will stop.
30103a608ca0SSimon Glass
30113a608ca0SSimon Glass		CONFIG_BOOTSTAGE_REPORT
30123a608ca0SSimon Glass		Define this to print a report before boot, similar to this:
30133a608ca0SSimon Glass
30143a608ca0SSimon Glass		Timer summary in microseconds:
30153a608ca0SSimon Glass		       Mark    Elapsed  Stage
30163a608ca0SSimon Glass			  0          0  reset
30173a608ca0SSimon Glass		  3,575,678  3,575,678  board_init_f start
30183a608ca0SSimon Glass		  3,575,695         17  arch_cpu_init A9
30193a608ca0SSimon Glass		  3,575,777         82  arch_cpu_init done
30203a608ca0SSimon Glass		  3,659,598     83,821  board_init_r start
30213a608ca0SSimon Glass		  3,910,375    250,777  main_loop
30223a608ca0SSimon Glass		 29,916,167 26,005,792  bootm_start
30233a608ca0SSimon Glass		 30,361,327    445,160  start_kernel
30243a608ca0SSimon Glass
30252eba38cfSSimon Glass		CONFIG_CMD_BOOTSTAGE
30262eba38cfSSimon Glass		Add a 'bootstage' command which supports printing a report
30272eba38cfSSimon Glass		and un/stashing of bootstage data.
30282eba38cfSSimon Glass
302994fd1316SSimon Glass		CONFIG_BOOTSTAGE_FDT
303094fd1316SSimon Glass		Stash the bootstage information in the FDT. A root 'bootstage'
303194fd1316SSimon Glass		node is created with each bootstage id as a child. Each child
303294fd1316SSimon Glass		has a 'name' property and either 'mark' containing the
303394fd1316SSimon Glass		mark time in microsecond, or 'accum' containing the
303494fd1316SSimon Glass		accumulated time for that bootstage id in microseconds.
303594fd1316SSimon Glass		For example:
303694fd1316SSimon Glass
303794fd1316SSimon Glass		bootstage {
303894fd1316SSimon Glass			154 {
303994fd1316SSimon Glass				name = "board_init_f";
304094fd1316SSimon Glass				mark = <3575678>;
304194fd1316SSimon Glass			};
304294fd1316SSimon Glass			170 {
304394fd1316SSimon Glass				name = "lcd";
304494fd1316SSimon Glass				accum = <33482>;
304594fd1316SSimon Glass			};
304694fd1316SSimon Glass		};
304794fd1316SSimon Glass
304894fd1316SSimon Glass		Code in the Linux kernel can find this in /proc/devicetree.
304994fd1316SSimon Glass
30501372cce2SMarian BalakowiczLegacy uImage format:
30511372cce2SMarian Balakowicz
3052c609719bSwdenk  Arg	Where			When
3053c609719bSwdenk    1	common/cmd_bootm.c	before attempting to boot an image
3054c609719bSwdenk   -1	common/cmd_bootm.c	Image header has bad	 magic number
3055c609719bSwdenk    2	common/cmd_bootm.c	Image header has correct magic number
3056c609719bSwdenk   -2	common/cmd_bootm.c	Image header has bad	 checksum
3057c609719bSwdenk    3	common/cmd_bootm.c	Image header has correct checksum
3058c609719bSwdenk   -3	common/cmd_bootm.c	Image data   has bad	 checksum
3059c609719bSwdenk    4	common/cmd_bootm.c	Image data   has correct checksum
3060c609719bSwdenk   -4	common/cmd_bootm.c	Image is for unsupported architecture
3061c609719bSwdenk    5	common/cmd_bootm.c	Architecture check OK
30621372cce2SMarian Balakowicz   -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi)
3063c609719bSwdenk    6	common/cmd_bootm.c	Image Type check OK
3064c609719bSwdenk   -6	common/cmd_bootm.c	gunzip uncompression error
3065c609719bSwdenk   -7	common/cmd_bootm.c	Unimplemented compression type
3066c609719bSwdenk    7	common/cmd_bootm.c	Uncompression OK
30671372cce2SMarian Balakowicz    8	common/cmd_bootm.c	No uncompress/copy overwrite error
3068c609719bSwdenk   -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
30691372cce2SMarian Balakowicz
30701372cce2SMarian Balakowicz    9	common/image.c		Start initial ramdisk verification
30711372cce2SMarian Balakowicz  -10	common/image.c		Ramdisk header has bad	   magic number
30721372cce2SMarian Balakowicz  -11	common/image.c		Ramdisk header has bad	   checksum
30731372cce2SMarian Balakowicz   10	common/image.c		Ramdisk header is OK
30741372cce2SMarian Balakowicz  -12	common/image.c		Ramdisk data   has bad	   checksum
30751372cce2SMarian Balakowicz   11	common/image.c		Ramdisk data   has correct checksum
30761372cce2SMarian Balakowicz   12	common/image.c		Ramdisk verification complete, start loading
307711ccc33fSMarcel Ziswiler  -13	common/image.c		Wrong Image Type (not PPC Linux ramdisk)
30781372cce2SMarian Balakowicz   13	common/image.c		Start multifile image verification
30791372cce2SMarian Balakowicz   14	common/image.c		No initial ramdisk, no multifile, continue.
30801372cce2SMarian Balakowicz
3081ea0364f1SPeter Tyser   15	arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
3082c609719bSwdenk
3083a47a12beSStefan Roese  -30	arch/powerpc/lib/board.c	Fatal error, hang the system
308463e73c9aSwdenk  -31	post/post.c		POST test failed, detected by post_output_backlog()
308563e73c9aSwdenk  -32	post/post.c		POST test failed, detected by post_run_single()
308663e73c9aSwdenk
3087566a494fSHeiko Schocher   34	common/cmd_doc.c	before loading a Image from a DOC device
3088566a494fSHeiko Schocher  -35	common/cmd_doc.c	Bad usage of "doc" command
3089566a494fSHeiko Schocher   35	common/cmd_doc.c	correct usage of "doc" command
3090566a494fSHeiko Schocher  -36	common/cmd_doc.c	No boot device
3091566a494fSHeiko Schocher   36	common/cmd_doc.c	correct boot device
3092566a494fSHeiko Schocher  -37	common/cmd_doc.c	Unknown Chip ID on boot device
3093566a494fSHeiko Schocher   37	common/cmd_doc.c	correct chip ID found, device available
3094566a494fSHeiko Schocher  -38	common/cmd_doc.c	Read Error on boot device
3095566a494fSHeiko Schocher   38	common/cmd_doc.c	reading Image header from DOC device OK
3096566a494fSHeiko Schocher  -39	common/cmd_doc.c	Image header has bad magic number
3097566a494fSHeiko Schocher   39	common/cmd_doc.c	Image header has correct magic number
3098566a494fSHeiko Schocher  -40	common/cmd_doc.c	Error reading Image from DOC device
3099566a494fSHeiko Schocher   40	common/cmd_doc.c	Image header has correct magic number
3100566a494fSHeiko Schocher   41	common/cmd_ide.c	before loading a Image from a IDE device
3101566a494fSHeiko Schocher  -42	common/cmd_ide.c	Bad usage of "ide" command
3102566a494fSHeiko Schocher   42	common/cmd_ide.c	correct usage of "ide" command
3103566a494fSHeiko Schocher  -43	common/cmd_ide.c	No boot device
3104566a494fSHeiko Schocher   43	common/cmd_ide.c	boot device found
3105566a494fSHeiko Schocher  -44	common/cmd_ide.c	Device not available
3106566a494fSHeiko Schocher   44	common/cmd_ide.c	Device available
3107566a494fSHeiko Schocher  -45	common/cmd_ide.c	wrong partition selected
3108566a494fSHeiko Schocher   45	common/cmd_ide.c	partition selected
3109566a494fSHeiko Schocher  -46	common/cmd_ide.c	Unknown partition table
3110566a494fSHeiko Schocher   46	common/cmd_ide.c	valid partition table found
3111566a494fSHeiko Schocher  -47	common/cmd_ide.c	Invalid partition type
3112566a494fSHeiko Schocher   47	common/cmd_ide.c	correct partition type
3113566a494fSHeiko Schocher  -48	common/cmd_ide.c	Error reading Image Header on boot device
3114566a494fSHeiko Schocher   48	common/cmd_ide.c	reading Image Header from IDE device OK
3115566a494fSHeiko Schocher  -49	common/cmd_ide.c	Image header has bad magic number
3116566a494fSHeiko Schocher   49	common/cmd_ide.c	Image header has correct magic number
3117566a494fSHeiko Schocher  -50	common/cmd_ide.c	Image header has bad	 checksum
3118566a494fSHeiko Schocher   50	common/cmd_ide.c	Image header has correct checksum
3119566a494fSHeiko Schocher  -51	common/cmd_ide.c	Error reading Image from IDE device
3120566a494fSHeiko Schocher   51	common/cmd_ide.c	reading Image from IDE device OK
3121566a494fSHeiko Schocher   52	common/cmd_nand.c	before loading a Image from a NAND device
3122566a494fSHeiko Schocher  -53	common/cmd_nand.c	Bad usage of "nand" command
3123566a494fSHeiko Schocher   53	common/cmd_nand.c	correct usage of "nand" command
3124566a494fSHeiko Schocher  -54	common/cmd_nand.c	No boot device
3125566a494fSHeiko Schocher   54	common/cmd_nand.c	boot device found
3126566a494fSHeiko Schocher  -55	common/cmd_nand.c	Unknown Chip ID on boot device
3127566a494fSHeiko Schocher   55	common/cmd_nand.c	correct chip ID found, device available
3128566a494fSHeiko Schocher  -56	common/cmd_nand.c	Error reading Image Header on boot device
3129566a494fSHeiko Schocher   56	common/cmd_nand.c	reading Image Header from NAND device OK
3130566a494fSHeiko Schocher  -57	common/cmd_nand.c	Image header has bad magic number
3131566a494fSHeiko Schocher   57	common/cmd_nand.c	Image header has correct magic number
3132566a494fSHeiko Schocher  -58	common/cmd_nand.c	Error reading Image from NAND device
3133566a494fSHeiko Schocher   58	common/cmd_nand.c	reading Image from NAND device OK
3134c609719bSwdenk
3135566a494fSHeiko Schocher  -60	common/env_common.c	Environment has a bad CRC, using default
3136c609719bSwdenk
3137566a494fSHeiko Schocher   64	net/eth.c		starting with Ethernet configuration.
3138566a494fSHeiko Schocher  -64	net/eth.c		no Ethernet found.
3139566a494fSHeiko Schocher   65	net/eth.c		Ethernet found.
3140206c60cbSwdenk
3141566a494fSHeiko Schocher  -80	common/cmd_net.c	usage wrong
3142566a494fSHeiko Schocher   80	common/cmd_net.c	before calling NetLoop()
314311ccc33fSMarcel Ziswiler  -81	common/cmd_net.c	some error in NetLoop() occurred
3144566a494fSHeiko Schocher   81	common/cmd_net.c	NetLoop() back without error
3145566a494fSHeiko Schocher  -82	common/cmd_net.c	size == 0 (File with size 0 loaded)
3146566a494fSHeiko Schocher   82	common/cmd_net.c	trying automatic boot
314774de7aefSWolfgang Denk   83	common/cmd_net.c	running "source" command
314874de7aefSWolfgang Denk  -83	common/cmd_net.c	some error in automatic boot or "source" command
3149566a494fSHeiko Schocher   84	common/cmd_net.c	end without errors
3150c609719bSwdenk
31511372cce2SMarian BalakowiczFIT uImage format:
31521372cce2SMarian Balakowicz
31531372cce2SMarian Balakowicz  Arg	Where			When
31541372cce2SMarian Balakowicz  100	common/cmd_bootm.c	Kernel FIT Image has correct format
31551372cce2SMarian Balakowicz -100	common/cmd_bootm.c	Kernel FIT Image has incorrect format
31561372cce2SMarian Balakowicz  101	common/cmd_bootm.c	No Kernel subimage unit name, using configuration
31571372cce2SMarian Balakowicz -101	common/cmd_bootm.c	Can't get configuration for kernel subimage
31581372cce2SMarian Balakowicz  102	common/cmd_bootm.c	Kernel unit name specified
31591372cce2SMarian Balakowicz -103	common/cmd_bootm.c	Can't get kernel subimage node offset
3160f773bea8SMarian Balakowicz  103	common/cmd_bootm.c	Found configuration node
31611372cce2SMarian Balakowicz  104	common/cmd_bootm.c	Got kernel subimage node offset
31621372cce2SMarian Balakowicz -104	common/cmd_bootm.c	Kernel subimage hash verification failed
31631372cce2SMarian Balakowicz  105	common/cmd_bootm.c	Kernel subimage hash verification OK
31641372cce2SMarian Balakowicz -105	common/cmd_bootm.c	Kernel subimage is for unsupported architecture
31651372cce2SMarian Balakowicz  106	common/cmd_bootm.c	Architecture check OK
316611ccc33fSMarcel Ziswiler -106	common/cmd_bootm.c	Kernel subimage has wrong type
316711ccc33fSMarcel Ziswiler  107	common/cmd_bootm.c	Kernel subimage type OK
31681372cce2SMarian Balakowicz -107	common/cmd_bootm.c	Can't get kernel subimage data/size
31691372cce2SMarian Balakowicz  108	common/cmd_bootm.c	Got kernel subimage data/size
31701372cce2SMarian Balakowicz -108	common/cmd_bootm.c	Wrong image type (not legacy, FIT)
31711372cce2SMarian Balakowicz -109	common/cmd_bootm.c	Can't get kernel subimage type
31721372cce2SMarian Balakowicz -110	common/cmd_bootm.c	Can't get kernel subimage comp
31731372cce2SMarian Balakowicz -111	common/cmd_bootm.c	Can't get kernel subimage os
31741372cce2SMarian Balakowicz -112	common/cmd_bootm.c	Can't get kernel subimage load address
31751372cce2SMarian Balakowicz -113	common/cmd_bootm.c	Image uncompress/copy overwrite error
31761372cce2SMarian Balakowicz
31771372cce2SMarian Balakowicz  120	common/image.c		Start initial ramdisk verification
31781372cce2SMarian Balakowicz -120	common/image.c		Ramdisk FIT image has incorrect format
31791372cce2SMarian Balakowicz  121	common/image.c		Ramdisk FIT image has correct format
318011ccc33fSMarcel Ziswiler  122	common/image.c		No ramdisk subimage unit name, using configuration
31811372cce2SMarian Balakowicz -122	common/image.c		Can't get configuration for ramdisk subimage
31821372cce2SMarian Balakowicz  123	common/image.c		Ramdisk unit name specified
31831372cce2SMarian Balakowicz -124	common/image.c		Can't get ramdisk subimage node offset
31841372cce2SMarian Balakowicz  125	common/image.c		Got ramdisk subimage node offset
31851372cce2SMarian Balakowicz -125	common/image.c		Ramdisk subimage hash verification failed
31861372cce2SMarian Balakowicz  126	common/image.c		Ramdisk subimage hash verification OK
31871372cce2SMarian Balakowicz -126	common/image.c		Ramdisk subimage for unsupported architecture
31881372cce2SMarian Balakowicz  127	common/image.c		Architecture check OK
31891372cce2SMarian Balakowicz -127	common/image.c		Can't get ramdisk subimage data/size
31901372cce2SMarian Balakowicz  128	common/image.c		Got ramdisk subimage data/size
31911372cce2SMarian Balakowicz  129	common/image.c		Can't get ramdisk load address
31921372cce2SMarian Balakowicz -129	common/image.c		Got ramdisk load address
31931372cce2SMarian Balakowicz
319411ccc33fSMarcel Ziswiler -130	common/cmd_doc.c	Incorrect FIT image format
31951372cce2SMarian Balakowicz  131	common/cmd_doc.c	FIT image format OK
31961372cce2SMarian Balakowicz
319711ccc33fSMarcel Ziswiler -140	common/cmd_ide.c	Incorrect FIT image format
31981372cce2SMarian Balakowicz  141	common/cmd_ide.c	FIT image format OK
31991372cce2SMarian Balakowicz
320011ccc33fSMarcel Ziswiler -150	common/cmd_nand.c	Incorrect FIT image format
32011372cce2SMarian Balakowicz  151	common/cmd_nand.c	FIT image format OK
32021372cce2SMarian Balakowicz
3203*21d29f7fSHeiko Schocher- legacy image format:
3204*21d29f7fSHeiko Schocher		CONFIG_IMAGE_FORMAT_LEGACY
3205*21d29f7fSHeiko Schocher		enables the legacy image format support in U-Boot.
3206*21d29f7fSHeiko Schocher
3207*21d29f7fSHeiko Schocher		Default:
3208*21d29f7fSHeiko Schocher		enabled if CONFIG_FIT_SIGNATURE is not defined.
3209*21d29f7fSHeiko Schocher
3210*21d29f7fSHeiko Schocher		CONFIG_DISABLE_IMAGE_LEGACY
3211*21d29f7fSHeiko Schocher		disable the legacy image format
3212*21d29f7fSHeiko Schocher
3213*21d29f7fSHeiko Schocher		This define is introduced, as the legacy image format is
3214*21d29f7fSHeiko Schocher		enabled per default for backward compatibility.
3215*21d29f7fSHeiko Schocher
3216d95f6ec7SGabe Black- FIT image support:
3217d95f6ec7SGabe Black		CONFIG_FIT
3218d95f6ec7SGabe Black		Enable support for the FIT uImage format.
3219d95f6ec7SGabe Black
3220d95f6ec7SGabe Black		CONFIG_FIT_BEST_MATCH
3221d95f6ec7SGabe Black		When no configuration is explicitly selected, default to the
3222d95f6ec7SGabe Black		one whose fdt's compatibility field best matches that of
3223d95f6ec7SGabe Black		U-Boot itself. A match is considered "best" if it matches the
3224d95f6ec7SGabe Black		most specific compatibility entry of U-Boot's fdt's root node.
3225d95f6ec7SGabe Black		The order of entries in the configuration's fdt is ignored.
3226d95f6ec7SGabe Black
32273e569a6bSSimon Glass		CONFIG_FIT_SIGNATURE
32283e569a6bSSimon Glass		This option enables signature verification of FIT uImages,
32293e569a6bSSimon Glass		using a hash signed and verified using RSA. See
32303e569a6bSSimon Glass		doc/uImage.FIT/signature.txt for more details.
32313e569a6bSSimon Glass
3232*21d29f7fSHeiko Schocher		WARNING: When relying on signed FIT images with required
3233*21d29f7fSHeiko Schocher		signature check the legacy image format is default
3234*21d29f7fSHeiko Schocher		disabled. If a board need legacy image format support
3235*21d29f7fSHeiko Schocher		enable this through CONFIG_IMAGE_FORMAT_LEGACY
3236*21d29f7fSHeiko Schocher
32374cf2609bSWolfgang Denk- Standalone program support:
32384cf2609bSWolfgang Denk		CONFIG_STANDALONE_LOAD_ADDR
32394cf2609bSWolfgang Denk
32406feff899SWolfgang Denk		This option defines a board specific value for the
32416feff899SWolfgang Denk		address where standalone program gets loaded, thus
32426feff899SWolfgang Denk		overwriting the architecture dependent default
32434cf2609bSWolfgang Denk		settings.
32444cf2609bSWolfgang Denk
32454cf2609bSWolfgang Denk- Frame Buffer Address:
32464cf2609bSWolfgang Denk		CONFIG_FB_ADDR
32474cf2609bSWolfgang Denk
32484cf2609bSWolfgang Denk		Define CONFIG_FB_ADDR if you want to use specific
324944a53b57SWolfgang Denk		address for frame buffer.  This is typically the case
325044a53b57SWolfgang Denk		when using a graphics controller has separate video
325144a53b57SWolfgang Denk		memory.  U-Boot will then place the frame buffer at
325244a53b57SWolfgang Denk		the given address instead of dynamically reserving it
325344a53b57SWolfgang Denk		in system RAM by calling lcd_setmem(), which grabs
325444a53b57SWolfgang Denk		the memory for the frame buffer depending on the
325544a53b57SWolfgang Denk		configured panel size.
32564cf2609bSWolfgang Denk
32574cf2609bSWolfgang Denk		Please see board_init_f function.
32584cf2609bSWolfgang Denk
3259cccfc2abSDetlev Zundel- Automatic software updates via TFTP server
3260cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP
3261cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_CNT_MAX
3262cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_MSEC_MAX
3263cccfc2abSDetlev Zundel
3264cccfc2abSDetlev Zundel		These options enable and control the auto-update feature;
3265cccfc2abSDetlev Zundel		for a more detailed description refer to doc/README.update.
3266cccfc2abSDetlev Zundel
3267cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support)
3268cccfc2abSDetlev Zundel		CONFIG_MTD_DEVICE
3269cccfc2abSDetlev Zundel
3270cccfc2abSDetlev Zundel		Adds the MTD device infrastructure from the Linux kernel.
3271cccfc2abSDetlev Zundel		Needed for mtdparts command support.
3272cccfc2abSDetlev Zundel
3273cccfc2abSDetlev Zundel		CONFIG_MTD_PARTITIONS
3274cccfc2abSDetlev Zundel
3275cccfc2abSDetlev Zundel		Adds the MTD partitioning infrastructure from the Linux
3276cccfc2abSDetlev Zundel		kernel. Needed for UBI support.
3277cccfc2abSDetlev Zundel
327870c219cdSJoe Hershberger- UBI support
327970c219cdSJoe Hershberger		CONFIG_CMD_UBI
328070c219cdSJoe Hershberger
328170c219cdSJoe Hershberger		Adds commands for interacting with MTD partitions formatted
328270c219cdSJoe Hershberger		with the UBI flash translation layer
328370c219cdSJoe Hershberger
328470c219cdSJoe Hershberger		Requires also defining CONFIG_RBTREE
328570c219cdSJoe Hershberger
3286147162daSJoe Hershberger		CONFIG_UBI_SILENCE_MSG
3287147162daSJoe Hershberger
3288147162daSJoe Hershberger		Make the verbose messages from UBI stop printing.  This leaves
3289147162daSJoe Hershberger		warnings and errors enabled.
3290147162daSJoe Hershberger
329170c219cdSJoe Hershberger- UBIFS support
329270c219cdSJoe Hershberger		CONFIG_CMD_UBIFS
329370c219cdSJoe Hershberger
329470c219cdSJoe Hershberger		Adds commands for interacting with UBI volumes formatted as
329570c219cdSJoe Hershberger		UBIFS.  UBIFS is read-only in u-boot.
329670c219cdSJoe Hershberger
329770c219cdSJoe Hershberger		Requires UBI support as well as CONFIG_LZO
329870c219cdSJoe Hershberger
3299147162daSJoe Hershberger		CONFIG_UBIFS_SILENCE_MSG
3300147162daSJoe Hershberger
3301147162daSJoe Hershberger		Make the verbose messages from UBIFS stop printing.  This leaves
3302147162daSJoe Hershberger		warnings and errors enabled.
3303147162daSJoe Hershberger
33046a11cf48SDaniel Schwierzeck- SPL framework
33056a11cf48SDaniel Schwierzeck		CONFIG_SPL
33066a11cf48SDaniel Schwierzeck		Enable building of SPL globally.
33076a11cf48SDaniel Schwierzeck
330895579793STom Rini		CONFIG_SPL_LDSCRIPT
330995579793STom Rini		LDSCRIPT for linking the SPL binary.
331095579793STom Rini
33116ebc3461SAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT
33126ebc3461SAlbert ARIBAUD		Maximum size in memory allocated to the SPL, BSS included.
33136ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual memory
33146ebc3461SAlbert ARIBAUD		used by SPL from _start to __bss_end does not exceed it.
33158960af8bSAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
33166ebc3461SAlbert ARIBAUD		must not be both defined at the same time.
33176ebc3461SAlbert ARIBAUD
331895579793STom Rini		CONFIG_SPL_MAX_SIZE
33196ebc3461SAlbert ARIBAUD		Maximum size of the SPL image (text, data, rodata, and
33206ebc3461SAlbert ARIBAUD		linker lists sections), BSS excluded.
33216ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual size does
33226ebc3461SAlbert ARIBAUD		not exceed it.
332395579793STom Rini
33246a11cf48SDaniel Schwierzeck		CONFIG_SPL_TEXT_BASE
33256a11cf48SDaniel Schwierzeck		TEXT_BASE for linking the SPL binary.
33266a11cf48SDaniel Schwierzeck
332794a45bb1SScott Wood		CONFIG_SPL_RELOC_TEXT_BASE
332894a45bb1SScott Wood		Address to relocate to.  If unspecified, this is equal to
332994a45bb1SScott Wood		CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
333094a45bb1SScott Wood
333195579793STom Rini		CONFIG_SPL_BSS_START_ADDR
333295579793STom Rini		Link address for the BSS within the SPL binary.
333395579793STom Rini
333495579793STom Rini		CONFIG_SPL_BSS_MAX_SIZE
33356ebc3461SAlbert ARIBAUD		Maximum size in memory allocated to the SPL BSS.
33366ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual memory used
33376ebc3461SAlbert ARIBAUD		by SPL from __bss_start to __bss_end does not exceed it.
33388960af8bSAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
33396ebc3461SAlbert ARIBAUD		must not be both defined at the same time.
334095579793STom Rini
334195579793STom Rini		CONFIG_SPL_STACK
334295579793STom Rini		Adress of the start of the stack SPL will use
334395579793STom Rini
334494a45bb1SScott Wood		CONFIG_SPL_RELOC_STACK
334594a45bb1SScott Wood		Adress of the start of the stack SPL will use after
334694a45bb1SScott Wood		relocation.  If unspecified, this is equal to
334794a45bb1SScott Wood		CONFIG_SPL_STACK.
334894a45bb1SScott Wood
334995579793STom Rini		CONFIG_SYS_SPL_MALLOC_START
335095579793STom Rini		Starting address of the malloc pool used in SPL.
335195579793STom Rini
335295579793STom Rini		CONFIG_SYS_SPL_MALLOC_SIZE
335395579793STom Rini		The size of the malloc pool used in SPL.
33546a11cf48SDaniel Schwierzeck
335547f7bcaeSTom Rini		CONFIG_SPL_FRAMEWORK
335647f7bcaeSTom Rini		Enable the SPL framework under common/.  This framework
335747f7bcaeSTom Rini		supports MMC, NAND and YMODEM loading of U-Boot and NAND
335847f7bcaeSTom Rini		NAND loading of the Linux Kernel.
335947f7bcaeSTom Rini
33609607faf2STom Rini		CONFIG_SPL_OS_BOOT
33619607faf2STom Rini		Enable booting directly to an OS from SPL.
33629607faf2STom Rini		See also: doc/README.falcon
33639607faf2STom Rini
3364861a86f4STom Rini		CONFIG_SPL_DISPLAY_PRINT
3365861a86f4STom Rini		For ARM, enable an optional function to print more information
3366861a86f4STom Rini		about the running system.
3367861a86f4STom Rini
33684b919725SScott Wood		CONFIG_SPL_INIT_MINIMAL
33694b919725SScott Wood		Arch init code should be built for a very small image
33704b919725SScott Wood
33716a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBCOMMON_SUPPORT
33726a11cf48SDaniel Schwierzeck		Support for common/libcommon.o in SPL binary
33736a11cf48SDaniel Schwierzeck
33746a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBDISK_SUPPORT
33756a11cf48SDaniel Schwierzeck		Support for disk/libdisk.o in SPL binary
33766a11cf48SDaniel Schwierzeck
33776a11cf48SDaniel Schwierzeck		CONFIG_SPL_I2C_SUPPORT
33786a11cf48SDaniel Schwierzeck		Support for drivers/i2c/libi2c.o in SPL binary
33796a11cf48SDaniel Schwierzeck
33806a11cf48SDaniel Schwierzeck		CONFIG_SPL_GPIO_SUPPORT
33816a11cf48SDaniel Schwierzeck		Support for drivers/gpio/libgpio.o in SPL binary
33826a11cf48SDaniel Schwierzeck
33836a11cf48SDaniel Schwierzeck		CONFIG_SPL_MMC_SUPPORT
33846a11cf48SDaniel Schwierzeck		Support for drivers/mmc/libmmc.o in SPL binary
33856a11cf48SDaniel Schwierzeck
338695579793STom Rini		CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
338795579793STom Rini		CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
338895579793STom Rini		CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION
338995579793STom Rini		Address, size and partition on the MMC to load U-Boot from
339095579793STom Rini		when the MMC is being used in raw mode.
339195579793STom Rini
33922b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
33932b75b0adSPeter Korsgaard		Sector to load kernel uImage from when MMC is being
33942b75b0adSPeter Korsgaard		used in raw mode (for Falcon mode)
33952b75b0adSPeter Korsgaard
33962b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
33972b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
33982b75b0adSPeter Korsgaard		Sector and number of sectors to load kernel argument
33992b75b0adSPeter Korsgaard		parameters from when MMC is being used in raw mode
34002b75b0adSPeter Korsgaard		(for falcon mode)
34012b75b0adSPeter Korsgaard
340295579793STom Rini		CONFIG_SPL_FAT_SUPPORT
340395579793STom Rini		Support for fs/fat/libfat.o in SPL binary
340495579793STom Rini
340595579793STom Rini		CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME
340695579793STom Rini		Filename to read to load U-Boot when reading from FAT
340795579793STom Rini
34087ad2cc79SPeter Korsgaard		CONFIG_SPL_FAT_LOAD_KERNEL_NAME
34097ad2cc79SPeter Korsgaard		Filename to read to load kernel uImage when reading
34107ad2cc79SPeter Korsgaard		from FAT (for Falcon mode)
34117ad2cc79SPeter Korsgaard
34127ad2cc79SPeter Korsgaard		CONFIG_SPL_FAT_LOAD_ARGS_NAME
34137ad2cc79SPeter Korsgaard		Filename to read to load kernel argument parameters
34147ad2cc79SPeter Korsgaard		when reading from FAT (for Falcon mode)
34157ad2cc79SPeter Korsgaard
341606f60ae3SScott Wood		CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
341706f60ae3SScott Wood		Set this for NAND SPL on PPC mpc83xx targets, so that
341806f60ae3SScott Wood		start.S waits for the rest of the SPL to load before
341906f60ae3SScott Wood		continuing (the hardware starts execution after just
342006f60ae3SScott Wood		loading the first page rather than the full 4K).
342106f60ae3SScott Wood
3422651fcf60SPrabhakar Kushwaha		CONFIG_SPL_SKIP_RELOCATE
3423651fcf60SPrabhakar Kushwaha		Avoid SPL relocation
3424651fcf60SPrabhakar Kushwaha
34256f2f01b9SScott Wood		CONFIG_SPL_NAND_BASE
34266f2f01b9SScott Wood		Include nand_base.c in the SPL.  Requires
34276f2f01b9SScott Wood		CONFIG_SPL_NAND_DRIVERS.
34286f2f01b9SScott Wood
34296f2f01b9SScott Wood		CONFIG_SPL_NAND_DRIVERS
34306f2f01b9SScott Wood		SPL uses normal NAND drivers, not minimal drivers.
34316f2f01b9SScott Wood
34326f2f01b9SScott Wood		CONFIG_SPL_NAND_ECC
34336f2f01b9SScott Wood		Include standard software ECC in the SPL
34346f2f01b9SScott Wood
343595579793STom Rini		CONFIG_SPL_NAND_SIMPLE
34367d4b7955SScott Wood		Support for NAND boot using simple NAND drivers that
34377d4b7955SScott Wood		expose the cmd_ctrl() interface.
343895579793STom Rini
34396dd3b566STom Rini		CONFIG_SPL_MTD_SUPPORT
34406dd3b566STom Rini		Support for the MTD subsystem within SPL.  Useful for
34416dd3b566STom Rini		environment on NAND support within SPL.
34426dd3b566STom Rini
3443bb0dc108SYing Zhang		CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT
3444bb0dc108SYing Zhang		Set for the SPL on PPC mpc8xxx targets, support for
34455614e71bSYork Sun		drivers/ddr/fsl/libddr.o in SPL binary.
3446bb0dc108SYing Zhang
34477c8eea59SYing Zhang		CONFIG_SPL_COMMON_INIT_DDR
34487c8eea59SYing Zhang		Set for common ddr init with serial presence detect in
34497c8eea59SYing Zhang		SPL binary.
34507c8eea59SYing Zhang
345195579793STom Rini		CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
345295579793STom Rini		CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
345395579793STom Rini		CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
345495579793STom Rini		CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
345595579793STom Rini		CONFIG_SYS_NAND_ECCBYTES
345695579793STom Rini		Defines the size and behavior of the NAND that SPL uses
34577d4b7955SScott Wood		to read U-Boot
345895579793STom Rini
3459fbe76ae4SPrabhakar Kushwaha		CONFIG_SPL_NAND_BOOT
3460fbe76ae4SPrabhakar Kushwaha		Add support NAND boot
3461fbe76ae4SPrabhakar Kushwaha
346295579793STom Rini		CONFIG_SYS_NAND_U_BOOT_OFFS
34637d4b7955SScott Wood		Location in NAND to read U-Boot from
34647d4b7955SScott Wood
34657d4b7955SScott Wood		CONFIG_SYS_NAND_U_BOOT_DST
34667d4b7955SScott Wood		Location in memory to load U-Boot to
34677d4b7955SScott Wood
34687d4b7955SScott Wood		CONFIG_SYS_NAND_U_BOOT_SIZE
34697d4b7955SScott Wood		Size of image to load
347095579793STom Rini
347195579793STom Rini		CONFIG_SYS_NAND_U_BOOT_START
34727d4b7955SScott Wood		Entry point in loaded image to jump to
347395579793STom Rini
347495579793STom Rini		CONFIG_SYS_NAND_HW_ECC_OOBFIRST
347595579793STom Rini		Define this if you need to first read the OOB and then the
347695579793STom Rini		data. This is used for example on davinci plattforms.
347795579793STom Rini
347895579793STom Rini		CONFIG_SPL_OMAP3_ID_NAND
347995579793STom Rini		Support for an OMAP3-specific set of functions to return the
348095579793STom Rini		ID and MFR of the first attached NAND chip, if present.
348195579793STom Rini
34826a11cf48SDaniel Schwierzeck		CONFIG_SPL_SERIAL_SUPPORT
34836a11cf48SDaniel Schwierzeck		Support for drivers/serial/libserial.o in SPL binary
34846a11cf48SDaniel Schwierzeck
34856a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_FLASH_SUPPORT
34866a11cf48SDaniel Schwierzeck		Support for drivers/mtd/spi/libspi_flash.o in SPL binary
34876a11cf48SDaniel Schwierzeck
34886a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_SUPPORT
34896a11cf48SDaniel Schwierzeck		Support for drivers/spi/libspi.o in SPL binary
34906a11cf48SDaniel Schwierzeck
3491c57b953dSPavel Machek		CONFIG_SPL_RAM_DEVICE
3492c57b953dSPavel Machek		Support for running image already present in ram, in SPL binary
3493c57b953dSPavel Machek
34946a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBGENERIC_SUPPORT
34956a11cf48SDaniel Schwierzeck		Support for lib/libgeneric.o in SPL binary
34961372cce2SMarian Balakowicz
3497ba1bee43SYing Zhang		CONFIG_SPL_ENV_SUPPORT
3498ba1bee43SYing Zhang		Support for the environment operating in SPL binary
3499ba1bee43SYing Zhang
3500ba1bee43SYing Zhang		CONFIG_SPL_NET_SUPPORT
3501ba1bee43SYing Zhang		Support for the net/libnet.o in SPL binary.
3502ba1bee43SYing Zhang		It conflicts with SPL env from storage medium specified by
3503ba1bee43SYing Zhang		CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3504ba1bee43SYing Zhang
350574752baaSScott Wood		CONFIG_SPL_PAD_TO
35066113d3f2SBenoît Thébaudeau		Image offset to which the SPL should be padded before appending
35076113d3f2SBenoît Thébaudeau		the SPL payload. By default, this is defined as
35086113d3f2SBenoît Thébaudeau		CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
35096113d3f2SBenoît Thébaudeau		CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
35106113d3f2SBenoît Thébaudeau		payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
351174752baaSScott Wood
3512ca2fca22SScott Wood		CONFIG_SPL_TARGET
3513ca2fca22SScott Wood		Final target image containing SPL and payload.  Some SPLs
3514ca2fca22SScott Wood		use an arch-specific makefile fragment instead, for
3515ca2fca22SScott Wood		example if more than one image needs to be produced.
3516ca2fca22SScott Wood
351787ebee39SSimon Glass		CONFIG_FIT_SPL_PRINT
351887ebee39SSimon Glass		Printing information about a FIT image adds quite a bit of
351987ebee39SSimon Glass		code to SPL. So this is normally disabled in SPL. Use this
352087ebee39SSimon Glass		option to re-enable it. This will affect the output of the
352187ebee39SSimon Glass		bootm command when booting a FIT image.
352287ebee39SSimon Glass
35233aa29de0SYing Zhang- TPL framework
35243aa29de0SYing Zhang		CONFIG_TPL
35253aa29de0SYing Zhang		Enable building of TPL globally.
35263aa29de0SYing Zhang
35273aa29de0SYing Zhang		CONFIG_TPL_PAD_TO
35283aa29de0SYing Zhang		Image offset to which the TPL should be padded before appending
35293aa29de0SYing Zhang		the TPL payload. By default, this is defined as
35303aa29de0SYing Zhang		CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
35313aa29de0SYing Zhang		CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
35323aa29de0SYing Zhang		payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
35333aa29de0SYing Zhang
3534c609719bSwdenkModem Support:
3535c609719bSwdenk--------------
3536c609719bSwdenk
3537566e5cf4SWolfgang Denk[so far only for SMDK2400 boards]
3538c609719bSwdenk
353911ccc33fSMarcel Ziswiler- Modem support enable:
3540c609719bSwdenk		CONFIG_MODEM_SUPPORT
3541c609719bSwdenk
3542c609719bSwdenk- RTS/CTS Flow control enable:
3543c609719bSwdenk		CONFIG_HWFLOW
3544c609719bSwdenk
3545c609719bSwdenk- Modem debug support:
3546c609719bSwdenk		CONFIG_MODEM_SUPPORT_DEBUG
3547c609719bSwdenk
3548c609719bSwdenk		Enables debugging stuff (char screen[1024], dbg())
3549c609719bSwdenk		for modem support. Useful only with BDI2000.
3550c609719bSwdenk
3551a8c7c708Swdenk- Interrupt support (PPC):
3552a8c7c708Swdenk
3553a8c7c708Swdenk		There are common interrupt_init() and timer_interrupt()
3554a8c7c708Swdenk		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
355511ccc33fSMarcel Ziswiler		for CPU specific initialization. interrupt_init_cpu()
3556a8c7c708Swdenk		should set decrementer_count to appropriate value. If
355711ccc33fSMarcel Ziswiler		CPU resets decrementer automatically after interrupt
3558a8c7c708Swdenk		(ppc4xx) it should set decrementer_count to zero.
355911ccc33fSMarcel Ziswiler		timer_interrupt() calls timer_interrupt_cpu() for CPU
3560a8c7c708Swdenk		specific handling. If board has watchdog / status_led
3561a8c7c708Swdenk		/ other_activity_monitor it works automatically from
3562a8c7c708Swdenk		general timer_interrupt().
3563a8c7c708Swdenk
3564c609719bSwdenk- General:
3565c609719bSwdenk
3566c609719bSwdenk		In the target system modem support is enabled when a
3567c609719bSwdenk		specific key (key combination) is pressed during
3568c609719bSwdenk		power-on. Otherwise U-Boot will boot normally
356911ccc33fSMarcel Ziswiler		(autoboot). The key_pressed() function is called from
3570c609719bSwdenk		board_init(). Currently key_pressed() is a dummy
3571c609719bSwdenk		function, returning 1 and thus enabling modem
3572c609719bSwdenk		initialization.
3573c609719bSwdenk
3574c609719bSwdenk		If there are no modem init strings in the
3575c609719bSwdenk		environment, U-Boot proceed to autoboot; the
3576c609719bSwdenk		previous output (banner, info printfs) will be
357711ccc33fSMarcel Ziswiler		suppressed, though.
3578c609719bSwdenk
3579c609719bSwdenk		See also: doc/README.Modem
3580c609719bSwdenk
35819660e442SHelmut RaigerBoard initialization settings:
35829660e442SHelmut Raiger------------------------------
35839660e442SHelmut Raiger
35849660e442SHelmut RaigerDuring Initialization u-boot calls a number of board specific functions
35859660e442SHelmut Raigerto allow the preparation of board specific prerequisites, e.g. pin setup
35869660e442SHelmut Raigerbefore drivers are initialized. To enable these callbacks the
35879660e442SHelmut Raigerfollowing configuration macros have to be defined. Currently this is
35889660e442SHelmut Raigerarchitecture specific, so please check arch/your_architecture/lib/board.c
35899660e442SHelmut Raigertypically in board_init_f() and board_init_r().
35909660e442SHelmut Raiger
35919660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
35929660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
35939660e442SHelmut Raiger- CONFIG_BOARD_LATE_INIT: Call board_late_init()
35949660e442SHelmut Raiger- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
3595c609719bSwdenk
3596c609719bSwdenkConfiguration Settings:
3597c609719bSwdenk-----------------------
3598c609719bSwdenk
35994d1fd7f1SYork Sun- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
36004d1fd7f1SYork Sun		Optionally it can be defined to support 64-bit memory commands.
36014d1fd7f1SYork Sun
36026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
3603c609719bSwdenk		undefine this when you're short of memory.
3604c609719bSwdenk
36052fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
36062fb2604dSPeter Tyser		width of the commands listed in the 'help' command output.
36072fb2604dSPeter Tyser
36086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT:	This is what U-Boot prints on the console to
3609c609719bSwdenk		prompt for user input.
3610c609719bSwdenk
36116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE:	Buffer size for input from the Console
3612c609719bSwdenk
36136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE:	Buffer size for Console output
3614c609719bSwdenk
36156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS:	max. Number of arguments accepted for monitor commands
3616c609719bSwdenk
36176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
3618c609719bSwdenk		the application (usually a Linux kernel) when it is
3619c609719bSwdenk		booted
3620c609719bSwdenk
36216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE:
3622c609719bSwdenk		List of legal baudrate settings for this board.
3623c609719bSwdenk
36246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_INFO_QUIET
3625c609719bSwdenk		Suppress display of console information at boot.
3626c609719bSwdenk
36276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_IS_IN_ENV
3628c609719bSwdenk		If the board specific function
3629c609719bSwdenk			extern int overwrite_console (void);
3630c609719bSwdenk		returns 1, the stdin, stderr and stdout are switched to the
3631c609719bSwdenk		serial port, else the settings in the environment are used.
3632c609719bSwdenk
36336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
3634c609719bSwdenk		Enable the call to overwrite_console().
3635c609719bSwdenk
36366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
3637c609719bSwdenk		Enable overwrite of previous console environment settings.
3638c609719bSwdenk
36396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
3640c609719bSwdenk		Begin and End addresses of the area used by the
3641c609719bSwdenk		simple memory test.
3642c609719bSwdenk
36436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST:
3644c609719bSwdenk		Enable an alternate, more extensive memory test.
3645c609719bSwdenk
36466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH:
36475f535fe1Swdenk		Scratch address used by the alternate memory test
36485f535fe1Swdenk		You only need to set this if address zero isn't writeable
36495f535fe1Swdenk
36506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
36516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
365214f73ca6SStefan Roese		this specified memory area will get subtracted from the top
365311ccc33fSMarcel Ziswiler		(end) of RAM and won't get "touched" at all by U-Boot. By
365414f73ca6SStefan Roese		fixing up gd->ram_size the Linux kernel should gets passed
365514f73ca6SStefan Roese		the now "corrected" memory size and won't touch it either.
365614f73ca6SStefan Roese		This should work for arch/ppc and arch/powerpc. Only Linux
36575e12e75dSStefan Roese		board ports in arch/powerpc with bootwrapper support that
365814f73ca6SStefan Roese		recalculate the memory size from the SDRAM controller setup
36595e12e75dSStefan Roese		will have to get fixed in Linux additionally.
366014f73ca6SStefan Roese
366114f73ca6SStefan Roese		This option can be used as a workaround for the 440EPx/GRx
366214f73ca6SStefan Roese		CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
366314f73ca6SStefan Roese		be touched.
366414f73ca6SStefan Roese
366514f73ca6SStefan Roese		WARNING: Please make sure that this value is a multiple of
366614f73ca6SStefan Roese		the Linux page size (normally 4k). If this is not the case,
366714f73ca6SStefan Roese		then the end address of the Linux memory will be located at a
366814f73ca6SStefan Roese		non page size aligned address and this could cause major
366914f73ca6SStefan Roese		problems.
367014f73ca6SStefan Roese
36716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE:
3672c609719bSwdenk		Enable temporary baudrate change while serial download
3673c609719bSwdenk
36746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE:
3675c609719bSwdenk		Physical start address of SDRAM. _Must_ be 0 here.
3676c609719bSwdenk
36776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MBIO_BASE:
3678c609719bSwdenk		Physical start address of Motherboard I/O (if using a
3679c609719bSwdenk		Cogent motherboard)
3680c609719bSwdenk
36816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE:
3682c609719bSwdenk		Physical start address of Flash memory.
3683c609719bSwdenk
36846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE:
3685c609719bSwdenk		Physical start address of boot monitor code (set by
3686c609719bSwdenk		make config files to be same as the text base address
368714d0a02aSWolfgang Denk		(CONFIG_SYS_TEXT_BASE) used when linking) - same as
36886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FLASH_BASE when booting from flash.
3689c609719bSwdenk
36906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN:
36913b57fe0aSwdenk		Size of memory reserved for monitor code, used to
36923b57fe0aSwdenk		determine _at_compile_time_ (!) if the environment is
36933b57fe0aSwdenk		embedded within the U-Boot image, or in a separate
36943b57fe0aSwdenk		flash sector.
3695c609719bSwdenk
36966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN:
3697c609719bSwdenk		Size of DRAM reserved for malloc() use.
3698c609719bSwdenk
36996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN:
370015940c9aSStefan Roese		Normally compressed uImages are limited to an
370115940c9aSStefan Roese		uncompressed size of 8 MBytes. If this is not enough,
37026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		you can define CONFIG_SYS_BOOTM_LEN in your board config file
370315940c9aSStefan Roese		to adjust this setting to your needs.
3704c609719bSwdenk
37056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ:
3706c609719bSwdenk		Maximum size of memory mapped by the startup code of
3707c609719bSwdenk		the Linux kernel; all data that must be processed by
37087d721e34SBartlomiej Sieka		the Linux kernel (bd_info, boot arguments, FDT blob if
37097d721e34SBartlomiej Sieka		used) must be put below this limit, unless "bootm_low"
37101bce2aebSRobert P. J. Day		environment variable is defined and non-zero. In such case
37117d721e34SBartlomiej Sieka		all data for the Linux kernel must be between "bootm_low"
3712c3624e6eSGrant Likely		and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.	 The environment
3713c3624e6eSGrant Likely		variable "bootm_mapsize" will override the value of
3714c3624e6eSGrant Likely		CONFIG_SYS_BOOTMAPSZ.  If CONFIG_SYS_BOOTMAPSZ is undefined,
3715c3624e6eSGrant Likely		then the value in "bootm_size" will be used instead.
3716c609719bSwdenk
3717fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3718fca43cc8SJohn Rigby		Enable initrd_high functionality.  If defined then the
3719fca43cc8SJohn Rigby		initrd_high feature is enabled and the bootm ramdisk subcommand
3720fca43cc8SJohn Rigby		is enabled.
3721fca43cc8SJohn Rigby
3722fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_CMDLINE:
3723fca43cc8SJohn Rigby		Enables allocating and saving kernel cmdline in space between
3724fca43cc8SJohn Rigby		"bootm_low" and "bootm_low" + BOOTMAPSZ.
3725fca43cc8SJohn Rigby
3726fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_KBD:
3727fca43cc8SJohn Rigby		Enables allocating and saving a kernel copy of the bd_info in
3728fca43cc8SJohn Rigby		space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3729fca43cc8SJohn Rigby
37306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS:
3731c609719bSwdenk		Max number of Flash memory banks
3732c609719bSwdenk
37336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT:
3734c609719bSwdenk		Max number of sectors on a Flash chip
3735c609719bSwdenk
37366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT:
3737c609719bSwdenk		Timeout for Flash erase operations (in ms)
3738c609719bSwdenk
37396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT:
3740c609719bSwdenk		Timeout for Flash write operations (in ms)
3741c609719bSwdenk
37426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT
37438564acf9Swdenk		Timeout for Flash set sector lock bit operation (in ms)
37448564acf9Swdenk
37456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT
37468564acf9Swdenk		Timeout for Flash clear lock bits operation (in ms)
37478564acf9Swdenk
37486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION
37498564acf9Swdenk		If defined, hardware flash sectors protection is used
37508564acf9Swdenk		instead of U-Boot software protection.
37518564acf9Swdenk
37526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP:
3753c609719bSwdenk
3754c609719bSwdenk		Enable TFTP transfers directly to flash memory;
3755c609719bSwdenk		without this option such a download has to be
3756c609719bSwdenk		performed in two steps: (1) download to RAM, and (2)
3757c609719bSwdenk		copy from RAM to flash.
3758c609719bSwdenk
3759c609719bSwdenk		The two-step approach is usually more reliable, since
3760c609719bSwdenk		you can check if the download worked before you erase
376111ccc33fSMarcel Ziswiler		the flash, but in some situations (when system RAM is
376211ccc33fSMarcel Ziswiler		too limited to allow for a temporary copy of the
3763c609719bSwdenk		downloaded image) this option may be very useful.
3764c609719bSwdenk
37656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI:
3766c609719bSwdenk		Define if the flash driver uses extra elements in the
37675653fc33Swdenk		common flash structure for storing flash geometry.
37685653fc33Swdenk
376900b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER
37705653fc33Swdenk		This option also enables the building of the cfi_flash driver
37715653fc33Swdenk		in the drivers directory
377253cf9435Sstroese
377391809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD
377491809ed5SPiotr Ziecik		This option enables the building of the cfi_mtd driver
377591809ed5SPiotr Ziecik		in the drivers directory. The driver exports CFI flash
377691809ed5SPiotr Ziecik		to the MTD layer.
377791809ed5SPiotr Ziecik
37786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
377996ef831fSGuennadi Liakhovetski		Use buffered writes to flash.
378096ef831fSGuennadi Liakhovetski
378196ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N
378296ef831fSGuennadi Liakhovetski		s29ws-n MirrorBit flash has non-standard addresses for buffered
378396ef831fSGuennadi Liakhovetski		write commands.
378496ef831fSGuennadi Liakhovetski
37856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST
37865568e613SStefan Roese		If this option is defined, the common CFI flash doesn't
37875568e613SStefan Roese		print it's warning upon not recognized FLASH banks. This
37885568e613SStefan Roese		is useful, if some of the configured banks are only
37895568e613SStefan Roese		optionally available.
37905568e613SStefan Roese
37919a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS
37929a042e9cSJerry Van Baren		If defined (must be an integer), print out countdown
37939a042e9cSJerry Van Baren		digits and dots.  Recommended value: 45 (9..1) for 80
37949a042e9cSJerry Van Baren		column displays, 15 (3..1) for 40 column displays.
37959a042e9cSJerry Van Baren
3796352ef3f1SStefan Roese- CONFIG_FLASH_VERIFY
3797352ef3f1SStefan Roese		If defined, the content of the flash (destination) is compared
3798352ef3f1SStefan Roese		against the source after the write operation. An error message
3799352ef3f1SStefan Roese		will be printed when the contents are not identical.
3800352ef3f1SStefan Roese		Please note that this option is useless in nearly all cases,
3801352ef3f1SStefan Roese		since such flash programming errors usually are detected earlier
3802352ef3f1SStefan Roese		while unprotecting/erasing/programming. Please only enable
3803352ef3f1SStefan Roese		this option if you really know what you are doing.
3804352ef3f1SStefan Roese
38056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER:
380611ccc33fSMarcel Ziswiler		Defines the number of Ethernet receive buffers. On some
380711ccc33fSMarcel Ziswiler		Ethernet controllers it is recommended to set this value
380853cf9435Sstroese		to 8 or even higher (EEPRO100 or 405 EMAC), since all
380953cf9435Sstroese		buffers can be full shortly after enabling the interface
381011ccc33fSMarcel Ziswiler		on high Ethernet traffic.
381153cf9435Sstroese		Defaults to 4 if not defined.
3812c609719bSwdenk
3813ea882bafSWolfgang Denk- CONFIG_ENV_MAX_ENTRIES
3814ea882bafSWolfgang Denk
3815ea882bafSWolfgang Denk	Maximum number of entries in the hash table that is used
3816ea882bafSWolfgang Denk	internally to store the environment settings. The default
3817ea882bafSWolfgang Denk	setting is supposed to be generous and should work in most
3818ea882bafSWolfgang Denk	cases. This setting can be used to tune behaviour; see
3819ea882bafSWolfgang Denk	lib/hashtable.c for details.
3820ea882bafSWolfgang Denk
38212598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_DEFAULT
38222598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_STATIC
38231bce2aebSRobert P. J. Day	Enable validation of the values given to environment variables when
38242598090bSJoe Hershberger	calling env set.  Variables can be restricted to only decimal,
38252598090bSJoe Hershberger	hexadecimal, or boolean.  If CONFIG_CMD_NET is also defined,
38262598090bSJoe Hershberger	the variables can also be restricted to IP address or MAC address.
38272598090bSJoe Hershberger
38282598090bSJoe Hershberger	The format of the list is:
38292598090bSJoe Hershberger		type_attribute = [s|d|x|b|i|m]
3830267541f7SJoe Hershberger		access_atribute = [a|r|o|c]
3831267541f7SJoe Hershberger		attributes = type_attribute[access_atribute]
38322598090bSJoe Hershberger		entry = variable_name[:attributes]
38332598090bSJoe Hershberger		list = entry[,list]
38342598090bSJoe Hershberger
38352598090bSJoe Hershberger	The type attributes are:
38362598090bSJoe Hershberger		s - String (default)
38372598090bSJoe Hershberger		d - Decimal
38382598090bSJoe Hershberger		x - Hexadecimal
38392598090bSJoe Hershberger		b - Boolean ([1yYtT|0nNfF])
38402598090bSJoe Hershberger		i - IP address
38412598090bSJoe Hershberger		m - MAC address
38422598090bSJoe Hershberger
3843267541f7SJoe Hershberger	The access attributes are:
3844267541f7SJoe Hershberger		a - Any (default)
3845267541f7SJoe Hershberger		r - Read-only
3846267541f7SJoe Hershberger		o - Write-once
3847267541f7SJoe Hershberger		c - Change-default
3848267541f7SJoe Hershberger
38492598090bSJoe Hershberger	- CONFIG_ENV_FLAGS_LIST_DEFAULT
38502598090bSJoe Hershberger		Define this to a list (string) to define the ".flags"
38512598090bSJoe Hershberger		envirnoment variable in the default or embedded environment.
38522598090bSJoe Hershberger
38532598090bSJoe Hershberger	- CONFIG_ENV_FLAGS_LIST_STATIC
38542598090bSJoe Hershberger		Define this to a list (string) to define validation that
38552598090bSJoe Hershberger		should be done if an entry is not found in the ".flags"
38562598090bSJoe Hershberger		environment variable.  To override a setting in the static
38572598090bSJoe Hershberger		list, simply add an entry for the same variable name to the
38582598090bSJoe Hershberger		".flags" variable.
38592598090bSJoe Hershberger
3860267541f7SJoe Hershberger- CONFIG_ENV_ACCESS_IGNORE_FORCE
3861267541f7SJoe Hershberger	If defined, don't allow the -f switch to env set override variable
3862267541f7SJoe Hershberger	access flags.
3863267541f7SJoe Hershberger
38645c1a7ea6SSimon Glass- CONFIG_SYS_GENERIC_BOARD
38655c1a7ea6SSimon Glass	This selects the architecture-generic board system instead of the
38665c1a7ea6SSimon Glass	architecture-specific board files. It is intended to move boards
38675c1a7ea6SSimon Glass	to this new framework over time. Defining this will disable the
38685c1a7ea6SSimon Glass	arch/foo/lib/board.c file and use common/board_f.c and
38695c1a7ea6SSimon Glass	common/board_r.c instead. To use this option your architecture
38705c1a7ea6SSimon Glass	must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in
38715c1a7ea6SSimon Glass	its config.mk file). If you find problems enabling this option on
38725c1a7ea6SSimon Glass	your board please report the problem and send patches!
38735c1a7ea6SSimon Glass
38740b1b60c7SLokesh Vutla- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
38750b1b60c7SLokesh Vutla	This is set by OMAP boards for the max time that reset should
38760b1b60c7SLokesh Vutla	be asserted. See doc/README.omap-reset-time for details on how
38770b1b60c7SLokesh Vutla	the value can be calulated on a given board.
3878632efa74SSimon Glass
3879c609719bSwdenkThe following definitions that deal with the placement and management
3880c609719bSwdenkof environment data (variable area); in general, we support the
3881c609719bSwdenkfollowing configurations:
3882c609719bSwdenk
3883c3eb3fe4SMike Frysinger- CONFIG_BUILD_ENVCRC:
3884c3eb3fe4SMike Frysinger
3885c3eb3fe4SMike Frysinger	Builds up envcrc with the target environment so that external utils
3886c3eb3fe4SMike Frysinger	may easily extract it and embed it in final U-Boot images.
3887c3eb3fe4SMike Frysinger
38885a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH:
3889c609719bSwdenk
3890c609719bSwdenk	Define this if the environment is in flash memory.
3891c609719bSwdenk
3892c609719bSwdenk	a) The environment occupies one whole flash sector, which is
3893c609719bSwdenk	   "embedded" in the text segment with the U-Boot code. This
3894c609719bSwdenk	   happens usually with "bottom boot sector" or "top boot
3895c609719bSwdenk	   sector" type flash chips, which have several smaller
3896c609719bSwdenk	   sectors at the start or the end. For instance, such a
3897c609719bSwdenk	   layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3898c609719bSwdenk	   such a case you would place the environment in one of the
3899c609719bSwdenk	   4 kB sectors - with U-Boot code before and after it. With
3900c609719bSwdenk	   "top boot sector" type flash chips, you would put the
3901c609719bSwdenk	   environment in one of the last sectors, leaving a gap
3902c609719bSwdenk	   between U-Boot and the environment.
3903c609719bSwdenk
39040e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
3905c609719bSwdenk
3906c609719bSwdenk	   Offset of environment data (variable area) to the
3907c609719bSwdenk	   beginning of flash memory; for instance, with bottom boot
3908c609719bSwdenk	   type flash chips the second sector can be used: the offset
3909c609719bSwdenk	   for this sector is given here.
3910c609719bSwdenk
39116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
3912c609719bSwdenk
39130e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
3914c609719bSwdenk
3915c609719bSwdenk	   This is just another way to specify the start address of
3916c609719bSwdenk	   the flash sector containing the environment (instead of
39170e8d1586SJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET).
3918c609719bSwdenk
39190e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SECT_SIZE:
3920c609719bSwdenk
3921c609719bSwdenk	   Size of the sector containing the environment.
3922c609719bSwdenk
3923c609719bSwdenk
3924c609719bSwdenk	b) Sometimes flash chips have few, equal sized, BIG sectors.
3925c609719bSwdenk	   In such a case you don't want to spend a whole sector for
3926c609719bSwdenk	   the environment.
3927c609719bSwdenk
39280e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3929c609719bSwdenk
39305a1aceb0SJean-Christophe PLAGNIOL-VILLARD	   If you use this in combination with CONFIG_ENV_IS_IN_FLASH
39310e8d1586SJean-Christophe PLAGNIOL-VILLARD	   and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
3932c609719bSwdenk	   of this flash sector for the environment. This saves
3933c609719bSwdenk	   memory for the RAM copy of the environment.
3934c609719bSwdenk
3935c609719bSwdenk	   It may also save flash memory if you decide to use this
3936c609719bSwdenk	   when your environment is "embedded" within U-Boot code,
3937c609719bSwdenk	   since then the remainder of the flash sector could be used
3938c609719bSwdenk	   for U-Boot code. It should be pointed out that this is
3939c609719bSwdenk	   STRONGLY DISCOURAGED from a robustness point of view:
3940c609719bSwdenk	   updating the environment in flash makes it always
3941c609719bSwdenk	   necessary to erase the WHOLE sector. If something goes
3942c609719bSwdenk	   wrong before the contents has been restored from a copy in
3943c609719bSwdenk	   RAM, your target system will be dead.
3944c609719bSwdenk
39450e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR_REDUND
39460e8d1586SJean-Christophe PLAGNIOL-VILLARD	  CONFIG_ENV_SIZE_REDUND
3947c609719bSwdenk
3948c609719bSwdenk	   These settings describe a second storage area used to hold
394911ccc33fSMarcel Ziswiler	   a redundant copy of the environment data, so that there is
39503e38691eSwdenk	   a valid backup copy in case there is a power failure during
3951c609719bSwdenk	   a "saveenv" operation.
3952c609719bSwdenk
3953c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the
3954c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds*
3955c609719bSwdenkaccordingly!
3956c609719bSwdenk
3957c609719bSwdenk
39589314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM:
3959c609719bSwdenk
3960c609719bSwdenk	Define this if you have some non-volatile memory device
3961c609719bSwdenk	(NVRAM, battery buffered SRAM) which you want to use for the
3962c609719bSwdenk	environment.
3963c609719bSwdenk
39640e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
39650e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3966c609719bSwdenk
396711ccc33fSMarcel Ziswiler	  These two #defines are used to determine the memory area you
3968c609719bSwdenk	  want to use for environment. It is assumed that this memory
3969c609719bSwdenk	  can just be read and written to, without any special
3970c609719bSwdenk	  provision.
3971c609719bSwdenk
3972c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early
3973c609719bSwdenkin U-Boot initalization (when we try to get the setting of for the
397411ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or
3975c609719bSwdenkU-Boot will hang.
3976c609719bSwdenk
3977c609719bSwdenkPlease note that even with NVRAM we still use a copy of the
3978c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to
3979c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv"
3980c609719bSwdenkto save the current settings.
3981c609719bSwdenk
3982c609719bSwdenk
3983bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM:
3984c609719bSwdenk
3985c609719bSwdenk	Use this if you have an EEPROM or similar serial access
3986c609719bSwdenk	device and a driver for it.
3987c609719bSwdenk
39880e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
39890e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3990c609719bSwdenk
3991c609719bSwdenk	  These two #defines specify the offset and size of the
3992c609719bSwdenk	  environment area within the total memory of your EEPROM.
3993c609719bSwdenk
39946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR:
3995c609719bSwdenk	  If defined, specified the chip address of the EEPROM device.
3996c609719bSwdenk	  The default address is zero.
3997c609719bSwdenk
39986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
3999c609719bSwdenk	  If defined, the number of bits used to address bytes in a
4000c609719bSwdenk	  single page in the EEPROM device.  A 64 byte page, for example
4001c609719bSwdenk	  would require six bits.
4002c609719bSwdenk
40036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
4004c609719bSwdenk	  If defined, the number of milliseconds to delay between
4005c609719bSwdenk	  page writes.	The default is zero milliseconds.
4006c609719bSwdenk
40076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
4008c609719bSwdenk	  The length in bytes of the EEPROM memory array address.  Note
4009c609719bSwdenk	  that this is NOT the chip address length!
4010c609719bSwdenk
40116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
40125cf91d6bSwdenk	  EEPROM chips that implement "address overflow" are ones
40135cf91d6bSwdenk	  like Catalyst 24WC04/08/16 which has 9/10/11 bits of
40145cf91d6bSwdenk	  address and the extra bits end up in the "chip address" bit
40155cf91d6bSwdenk	  slots. This makes a 24WC08 (1Kbyte) chip look like four 256
40165cf91d6bSwdenk	  byte chips.
40175cf91d6bSwdenk
40185cf91d6bSwdenk	  Note that we consider the length of the address field to
40195cf91d6bSwdenk	  still be one byte because the extra address bits are hidden
40205cf91d6bSwdenk	  in the chip address.
40215cf91d6bSwdenk
40226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_SIZE:
4023c609719bSwdenk	  The size in bytes of the EEPROM device.
4024c609719bSwdenk
4025548738b4SHeiko Schocher	- CONFIG_ENV_EEPROM_IS_ON_I2C
4026548738b4SHeiko Schocher	  define this, if you have I2C and SPI activated, and your
4027548738b4SHeiko Schocher	  EEPROM, which holds the environment, is on the I2C bus.
4028548738b4SHeiko Schocher
4029548738b4SHeiko Schocher	- CONFIG_I2C_ENV_EEPROM_BUS
4030548738b4SHeiko Schocher	  if you have an Environment on an EEPROM reached over
4031548738b4SHeiko Schocher	  I2C muxes, you can define here, how to reach this
4032548738b4SHeiko Schocher	  EEPROM. For example:
4033548738b4SHeiko Schocher
4034ea818dbbSHeiko Schocher	  #define CONFIG_I2C_ENV_EEPROM_BUS	  1
4035548738b4SHeiko Schocher
4036548738b4SHeiko Schocher	  EEPROM which holds the environment, is reached over
4037548738b4SHeiko Schocher	  a pca9547 i2c mux with address 0x70, channel 3.
4038c609719bSwdenk
4039057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH:
40405779d8d9Swdenk
40415779d8d9Swdenk	Define this if you have a DataFlash memory device which you
40425779d8d9Swdenk	want to use for the environment.
40435779d8d9Swdenk
40440e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
40450e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
40460e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
40475779d8d9Swdenk
40485779d8d9Swdenk	  These three #defines specify the offset and size of the
40495779d8d9Swdenk	  environment area within the total memory of your DataFlash placed
40505779d8d9Swdenk	  at the specified address.
40515779d8d9Swdenk
40520a85a9e7SLiu Gang- CONFIG_ENV_IS_IN_REMOTE:
40530a85a9e7SLiu Gang
40540a85a9e7SLiu Gang	Define this if you have a remote memory space which you
40550a85a9e7SLiu Gang	want to use for the local device's environment.
40560a85a9e7SLiu Gang
40570a85a9e7SLiu Gang	- CONFIG_ENV_ADDR:
40580a85a9e7SLiu Gang	- CONFIG_ENV_SIZE:
40590a85a9e7SLiu Gang
40600a85a9e7SLiu Gang	  These two #defines specify the address and size of the
40610a85a9e7SLiu Gang	  environment area within the remote memory space. The
40620a85a9e7SLiu Gang	  local device can get the environment from remote memory
4063fc54c7faSLiu Gang	  space by SRIO or PCIE links.
40640a85a9e7SLiu Gang
40650a85a9e7SLiu GangBE CAREFUL! For some special cases, the local device can not use
40660a85a9e7SLiu Gang"saveenv" command. For example, the local device will get the
4067fc54c7faSLiu Gangenvironment stored in a remote NOR flash by SRIO or PCIE link,
4068fc54c7faSLiu Gangbut it can not erase, write this NOR flash by SRIO or PCIE interface.
40690a85a9e7SLiu Gang
407051bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND:
407113a5695bSwdenk
407213a5695bSwdenk	Define this if you have a NAND device which you want to use
407313a5695bSwdenk	for the environment.
407413a5695bSwdenk
40750e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
40760e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
407713a5695bSwdenk
407813a5695bSwdenk	  These two #defines specify the offset and size of the environment
4079fdd813deSScott Wood	  area within the first NAND device.  CONFIG_ENV_OFFSET must be
4080fdd813deSScott Wood	  aligned to an erase block boundary.
40815779d8d9Swdenk
4082fdd813deSScott Wood	- CONFIG_ENV_OFFSET_REDUND (optional):
4083e443c944SMarkus Klotzbuecher
40840e8d1586SJean-Christophe PLAGNIOL-VILLARD	  This setting describes a second storage area of CONFIG_ENV_SIZE
4085fdd813deSScott Wood	  size used to hold a redundant copy of the environment data, so
4086fdd813deSScott Wood	  that there is a valid backup copy in case there is a power failure
4087fdd813deSScott Wood	  during a "saveenv" operation.	 CONFIG_ENV_OFFSET_RENDUND must be
4088fdd813deSScott Wood	  aligned to an erase block boundary.
4089e443c944SMarkus Klotzbuecher
4090fdd813deSScott Wood	- CONFIG_ENV_RANGE (optional):
4091fdd813deSScott Wood
4092fdd813deSScott Wood	  Specifies the length of the region in which the environment
4093fdd813deSScott Wood	  can be written.  This should be a multiple of the NAND device's
4094fdd813deSScott Wood	  block size.  Specifying a range with more erase blocks than
4095fdd813deSScott Wood	  are needed to hold CONFIG_ENV_SIZE allows bad blocks within
4096fdd813deSScott Wood	  the range to be avoided.
4097fdd813deSScott Wood
4098fdd813deSScott Wood	- CONFIG_ENV_OFFSET_OOB (optional):
4099fdd813deSScott Wood
4100fdd813deSScott Wood	  Enables support for dynamically retrieving the offset of the
4101fdd813deSScott Wood	  environment from block zero's out-of-band data.  The
4102fdd813deSScott Wood	  "nand env.oob" command can be used to record this offset.
4103fdd813deSScott Wood	  Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
4104fdd813deSScott Wood	  using CONFIG_ENV_OFFSET_OOB.
4105e443c944SMarkus Klotzbuecher
4106b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST
4107b74ab737SGuennadi Liakhovetski
4108b74ab737SGuennadi Liakhovetski	Defines address in RAM to which the nand_spl code should copy the
4109b74ab737SGuennadi Liakhovetski	environment. If redundant environment is used, it will be copied to
4110b74ab737SGuennadi Liakhovetski	CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
4111b74ab737SGuennadi Liakhovetski
41122b74433fSJoe Hershberger- CONFIG_ENV_IS_IN_UBI:
41132b74433fSJoe Hershberger
41142b74433fSJoe Hershberger	Define this if you have an UBI volume that you want to use for the
41152b74433fSJoe Hershberger	environment.  This has the benefit of wear-leveling the environment
41162b74433fSJoe Hershberger	accesses, which is important on NAND.
41172b74433fSJoe Hershberger
41182b74433fSJoe Hershberger	- CONFIG_ENV_UBI_PART:
41192b74433fSJoe Hershberger
41202b74433fSJoe Hershberger	  Define this to a string that is the mtd partition containing the UBI.
41212b74433fSJoe Hershberger
41222b74433fSJoe Hershberger	- CONFIG_ENV_UBI_VOLUME:
41232b74433fSJoe Hershberger
41242b74433fSJoe Hershberger	  Define this to the name of the volume that you want to store the
41252b74433fSJoe Hershberger	  environment in.
41262b74433fSJoe Hershberger
4127785881f7SJoe Hershberger	- CONFIG_ENV_UBI_VOLUME_REDUND:
4128785881f7SJoe Hershberger
4129785881f7SJoe Hershberger	  Define this to the name of another volume to store a second copy of
4130785881f7SJoe Hershberger	  the environment in.  This will enable redundant environments in UBI.
4131785881f7SJoe Hershberger	  It is assumed that both volumes are in the same MTD partition.
4132785881f7SJoe Hershberger
41332b74433fSJoe Hershberger	- CONFIG_UBI_SILENCE_MSG
41342b74433fSJoe Hershberger	- CONFIG_UBIFS_SILENCE_MSG
41352b74433fSJoe Hershberger
41362b74433fSJoe Hershberger	  You will probably want to define these to avoid a really noisy system
41372b74433fSJoe Hershberger	  when storing the env in UBI.
41382b74433fSJoe Hershberger
413906e4ae5fSStephen Warren- CONFIG_ENV_IS_IN_MMC:
414006e4ae5fSStephen Warren
414106e4ae5fSStephen Warren	Define this if you have an MMC device which you want to use for the
414206e4ae5fSStephen Warren	environment.
414306e4ae5fSStephen Warren
414406e4ae5fSStephen Warren	- CONFIG_SYS_MMC_ENV_DEV:
414506e4ae5fSStephen Warren
414606e4ae5fSStephen Warren	  Specifies which MMC device the environment is stored in.
414706e4ae5fSStephen Warren
414806e4ae5fSStephen Warren	- CONFIG_SYS_MMC_ENV_PART (optional):
414906e4ae5fSStephen Warren
415006e4ae5fSStephen Warren	  Specifies which MMC partition the environment is stored in. If not
415106e4ae5fSStephen Warren	  set, defaults to partition 0, the user area. Common values might be
415206e4ae5fSStephen Warren	  1 (first MMC boot partition), 2 (second MMC boot partition).
415306e4ae5fSStephen Warren
415406e4ae5fSStephen Warren	- CONFIG_ENV_OFFSET:
415506e4ae5fSStephen Warren	- CONFIG_ENV_SIZE:
415606e4ae5fSStephen Warren
415706e4ae5fSStephen Warren	  These two #defines specify the offset and size of the environment
415806e4ae5fSStephen Warren	  area within the specified MMC device.
415906e4ae5fSStephen Warren
41605c088ee8SStephen Warren	  If offset is positive (the usual case), it is treated as relative to
41615c088ee8SStephen Warren	  the start of the MMC partition. If offset is negative, it is treated
41625c088ee8SStephen Warren	  as relative to the end of the MMC partition. This can be useful if
41635c088ee8SStephen Warren	  your board may be fitted with different MMC devices, which have
41645c088ee8SStephen Warren	  different sizes for the MMC partitions, and you always want the
41655c088ee8SStephen Warren	  environment placed at the very end of the partition, to leave the
41665c088ee8SStephen Warren	  maximum possible space before it, to store other data.
41675c088ee8SStephen Warren
416806e4ae5fSStephen Warren	  These two values are in units of bytes, but must be aligned to an
416906e4ae5fSStephen Warren	  MMC sector boundary.
417006e4ae5fSStephen Warren
417106e4ae5fSStephen Warren	- CONFIG_ENV_OFFSET_REDUND (optional):
417206e4ae5fSStephen Warren
417306e4ae5fSStephen Warren	  Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
417406e4ae5fSStephen Warren	  hold a redundant copy of the environment data. This provides a
417506e4ae5fSStephen Warren	  valid backup copy in case the other copy is corrupted, e.g. due
417606e4ae5fSStephen Warren	  to a power failure during a "saveenv" operation.
417706e4ae5fSStephen Warren
41785c088ee8SStephen Warren	  This value may also be positive or negative; this is handled in the
41795c088ee8SStephen Warren	  same way as CONFIG_ENV_OFFSET.
41805c088ee8SStephen Warren
418106e4ae5fSStephen Warren	  This value is also in units of bytes, but must also be aligned to
418206e4ae5fSStephen Warren	  an MMC sector boundary.
418306e4ae5fSStephen Warren
418406e4ae5fSStephen Warren	- CONFIG_ENV_SIZE_REDUND (optional):
418506e4ae5fSStephen Warren
418606e4ae5fSStephen Warren	  This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
418706e4ae5fSStephen Warren	  set. If this value is set, it must be set to the same value as
418806e4ae5fSStephen Warren	  CONFIG_ENV_SIZE.
418906e4ae5fSStephen Warren
41906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET
4191c609719bSwdenk
4192c609719bSwdenk	Defines offset to the initial SPI buffer area in DPRAM. The
4193c609719bSwdenk	area is used at an early stage (ROM part) if the environment
4194c609719bSwdenk	is configured to reside in the SPI EEPROM: We need a 520 byte
4195c609719bSwdenk	scratch DPRAM area. It is used between the two initialization
4196c609719bSwdenk	calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4197c609719bSwdenk	to be a good choice since it makes it far enough from the
4198c609719bSwdenk	start of the data area as well as from the stack pointer.
4199c609719bSwdenk
4200e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor
4201c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been
4202cdb74977SWolfgang Denkcreated; also, when using EEPROM you will have to use getenv_f()
4203c609719bSwdenkuntil then to read environment variables.
4204c609719bSwdenk
420585ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor
420685ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working
420785ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is
420885ec0bccSwdenknecessary, because the first environment variable we need is the
420985ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't
421085ec0bccSwdenkhave any device yet where we could complain.]
4211c609719bSwdenk
4212c609719bSwdenkNote: once the monitor has been relocated, then it will complain if
4213c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you
421485ec0bccSwdenkuse the "saveenv" command to store a valid environment.
4215c609719bSwdenk
42166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
4217fc3e2165Swdenk		Echo the inverted Ethernet link state to the fault LED.
4218fc3e2165Swdenk
42196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
4220fc3e2165Swdenk		      also needs to be defined.
4221fc3e2165Swdenk
42226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR:
4223fc3e2165Swdenk		MII address of the PHY to check for the Ethernet link state.
4224c609719bSwdenk
4225f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS:
4226f5675aa5SRon Madrid		Define this if you desire to only have use of the NS16550_init
4227f5675aa5SRon Madrid		and NS16550_putc functions for the serial driver located at
4228f5675aa5SRon Madrid		drivers/serial/ns16550.c.  This option is useful for saving
4229f5675aa5SRon Madrid		space for already greatly restricted images, including but not
4230f5675aa5SRon Madrid		limited to NAND_SPL configurations.
4231f5675aa5SRon Madrid
4232b2b92f53SSimon Glass- CONFIG_DISPLAY_BOARDINFO
4233b2b92f53SSimon Glass		Display information about the board that U-Boot is running on
4234b2b92f53SSimon Glass		when U-Boot starts up. The board function checkboard() is called
4235b2b92f53SSimon Glass		to do this.
4236b2b92f53SSimon Glass
4237e2e3e2b1SSimon Glass- CONFIG_DISPLAY_BOARDINFO_LATE
4238e2e3e2b1SSimon Glass		Similar to the previous option, but display this information
4239e2e3e2b1SSimon Glass		later, once stdio is running and output goes to the LCD, if
4240e2e3e2b1SSimon Glass		present.
4241e2e3e2b1SSimon Glass
4242c609719bSwdenkLow Level (hardware related) configuration options:
4243dc7c9a1aSwdenk---------------------------------------------------
4244c609719bSwdenk
42456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE:
4246c609719bSwdenk		Cache Line Size of the CPU.
4247c609719bSwdenk
42486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR:
4249c609719bSwdenk		Default address of the IMMR after system reset.
42502535d602Swdenk
42512535d602Swdenk		Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
42522535d602Swdenk		and RPXsuper) to be able to adjust the position of
42532535d602Swdenk		the IMMR register after a reset.
4254c609719bSwdenk
4255e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_DEFAULT:
4256e46fedfeSTimur Tabi		Default (power-on reset) physical address of CCSR on Freescale
4257e46fedfeSTimur Tabi		PowerPC SOCs.
4258e46fedfeSTimur Tabi
4259e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR:
4260e46fedfeSTimur Tabi		Virtual address of CCSR.  On a 32-bit build, this is typically
4261e46fedfeSTimur Tabi		the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4262e46fedfeSTimur Tabi
4263e46fedfeSTimur Tabi		CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4264e46fedfeSTimur Tabi		for cross-platform code that uses that macro instead.
4265e46fedfeSTimur Tabi
4266e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS:
4267e46fedfeSTimur Tabi		Physical address of CCSR.  CCSR can be relocated to a new
4268e46fedfeSTimur Tabi		physical address, if desired.  In this case, this macro should
4269e46fedfeSTimur Tabi		be set to that address.	 Otherwise, it should be set to the
4270e46fedfeSTimur Tabi		same value as CONFIG_SYS_CCSRBAR_DEFAULT.  For example, CCSR
4271e46fedfeSTimur Tabi		is typically relocated on 36-bit builds.  It is recommended
4272e46fedfeSTimur Tabi		that this macro be defined via the _HIGH and _LOW macros:
4273e46fedfeSTimur Tabi
4274e46fedfeSTimur Tabi		#define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4275e46fedfeSTimur Tabi			* 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4276e46fedfeSTimur Tabi
4277e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
4278e46fedfeSTimur Tabi		Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS.	This value is typically
4279e46fedfeSTimur Tabi		either 0 (32-bit build) or 0xF (36-bit build).	This macro is
4280e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
4281e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
4282e46fedfeSTimur Tabi
4283e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4284e46fedfeSTimur Tabi		Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS.  This macro is
4285e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
4286e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
4287e46fedfeSTimur Tabi
4288e46fedfeSTimur Tabi- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4289e46fedfeSTimur Tabi		If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4290e46fedfeSTimur Tabi		forced to a value that ensures that CCSR is not relocated.
4291e46fedfeSTimur Tabi
42927f6c2cbcSwdenk- Floppy Disk Support:
42936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER
42947f6c2cbcSwdenk
42957f6c2cbcSwdenk		the default drive number (default value 0)
42967f6c2cbcSwdenk
42976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_STRIDE
42987f6c2cbcSwdenk
429911ccc33fSMarcel Ziswiler		defines the spacing between FDC chipset registers
43007f6c2cbcSwdenk		(default value 1)
43017f6c2cbcSwdenk
43026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_OFFSET
43037f6c2cbcSwdenk
43047f6c2cbcSwdenk		defines the offset of register from address. It
43057f6c2cbcSwdenk		depends on which part of the data bus is connected to
430611ccc33fSMarcel Ziswiler		the FDC chipset. (default value 0)
43077f6c2cbcSwdenk
43086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
43096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
43107f6c2cbcSwdenk		default value.
43117f6c2cbcSwdenk
43126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		if CONFIG_SYS_FDC_HW_INIT is defined, then the function
43137f6c2cbcSwdenk		fdc_hw_init() is called at the beginning of the FDC
43147f6c2cbcSwdenk		setup. fdc_hw_init() must be provided by the board
43157f6c2cbcSwdenk		source code. It is used to make hardware dependant
43167f6c2cbcSwdenk		initializations.
43177f6c2cbcSwdenk
43180abddf82SMacpaul Lin- CONFIG_IDE_AHB:
43190abddf82SMacpaul Lin		Most IDE controllers were designed to be connected with PCI
43200abddf82SMacpaul Lin		interface. Only few of them were designed for AHB interface.
43210abddf82SMacpaul Lin		When software is doing ATA command and data transfer to
43220abddf82SMacpaul Lin		IDE devices through IDE-AHB controller, some additional
43230abddf82SMacpaul Lin		registers accessing to these kind of IDE-AHB controller
43240abddf82SMacpaul Lin		is requierd.
43250abddf82SMacpaul Lin
43266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR:	Physical address of the Internal Memory.
432725d6712aSwdenk		DO NOT CHANGE unless you know exactly what you're
432825d6712aSwdenk		doing! (11-4) [MPC8xx/82xx systems only]
4329c609719bSwdenk
43306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR:
4331c609719bSwdenk
43327152b1d0Swdenk		Start address of memory area that can be used for
4333c609719bSwdenk		initial data and stack; please note that this must be
4334c609719bSwdenk		writable memory that is working WITHOUT special
4335c609719bSwdenk		initialization, i. e. you CANNOT use normal RAM which
4336c609719bSwdenk		will become available only after programming the
4337c609719bSwdenk		memory controller and running certain initialization
4338c609719bSwdenk		sequences.
4339c609719bSwdenk
4340c609719bSwdenk		U-Boot uses the following memory types:
4341c609719bSwdenk		- MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4342c609719bSwdenk		- MPC824X: data cache
4343c609719bSwdenk		- PPC4xx:  data cache
4344c609719bSwdenk
43456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET:
4346c609719bSwdenk
4347c609719bSwdenk		Offset of the initial data structure in the memory
43486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
43496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
4350c609719bSwdenk		data is located at the end of the available space
4351553f0982SWolfgang Denk		(sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
43526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
43536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
43546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET) downward.
4355c609719bSwdenk
4356c609719bSwdenk	Note:
4357c609719bSwdenk		On the MPC824X (or other systems that use the data
4358c609719bSwdenk		cache for initial memory) the address chosen for
43596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
4360c609719bSwdenk		point to an otherwise UNUSED address space between
4361c609719bSwdenk		the top of RAM and the start of the PCI space.
4362c609719bSwdenk
43636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR:	SIU Module Configuration (11-6)
4364c609719bSwdenk
43656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR:	System Protection Control (11-9)
4366c609719bSwdenk
43676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR:	Time Base Status and Control (11-26)
4368c609719bSwdenk
43696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR:	Periodic Interrupt Status and Control (11-31)
4370c609719bSwdenk
43716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR:	PLL, Low-Power, and Reset Control Register (15-30)
4372c609719bSwdenk
43736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR:	System Clock and reset Control Register (15-27)
4374c609719bSwdenk
43756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM:
4376c609719bSwdenk		SDRAM timing
4377c609719bSwdenk
43786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA:
4379c609719bSwdenk		periodic timer for refresh
4380c609719bSwdenk
43816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER:	Debug Event Register (37-47)
4382c609719bSwdenk
43836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
43846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
43856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
43866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_BR1_PRELIM:
4387c609719bSwdenk		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4388c609719bSwdenk
4389c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
43906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
43916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
4392c609719bSwdenk		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4393c609719bSwdenk
43946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
43956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
4396c609719bSwdenk		Machine Mode Register and Memory Periodic Timer
4397c609719bSwdenk		Prescaler definitions (SDRAM timing)
4398c609719bSwdenk
43996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
4400c609719bSwdenk		enable I2C microcode relocation patch (MPC8xx);
4401c609719bSwdenk		define relocation offset in DPRAM [DSP2]
4402c609719bSwdenk
44036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
4404b423d055SHeiko Schocher		enable SMC microcode relocation patch (MPC8xx);
4405b423d055SHeiko Schocher		define relocation offset in DPRAM [SMC1]
4406b423d055SHeiko Schocher
44076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
4408c609719bSwdenk		enable SPI microcode relocation patch (MPC8xx);
4409c609719bSwdenk		define relocation offset in DPRAM [SCC4]
4410c609719bSwdenk
44116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_USE_OSCCLK:
4412c609719bSwdenk		Use OSCM clock mode on MBX8xx board. Be careful,
4413c609719bSwdenk		wrong setting might damage your board. Read
4414c609719bSwdenk		doc/README.MBX before setting this variable!
4415c609719bSwdenk
44166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
4417ea909b76Swdenk		Offset of the bootmode word in DPRAM used by post
4418ea909b76Swdenk		(Power On Self Tests). This definition overrides
4419ea909b76Swdenk		#define'd default value in commproc.h resp.
4420ea909b76Swdenk		cpm_8260.h.
4421ea909b76Swdenk
44226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
44236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
44246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
44256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
44266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
44276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
44286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
44296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
4430a47a12beSStefan Roese		Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
44315d232d0eSwdenk
44329cacf4fcSDirk Eibach- CONFIG_PCI_DISABLE_PCIE:
44339cacf4fcSDirk Eibach		Disable PCI-Express on systems where it is supported but not
44349cacf4fcSDirk Eibach		required.
44359cacf4fcSDirk Eibach
443669fd2d3bSAndrew Sharp- CONFIG_PCI_ENUM_ONLY
443769fd2d3bSAndrew Sharp		Only scan through and get the devices on the busses.
443869fd2d3bSAndrew Sharp		Don't do any setup work, presumably because someone or
443969fd2d3bSAndrew Sharp		something has already done it, and we don't need to do it
444069fd2d3bSAndrew Sharp		a second time.	Useful for platforms that are pre-booted
444169fd2d3bSAndrew Sharp		by coreboot or similar.
444269fd2d3bSAndrew Sharp
4443842033e6SGabor Juhos- CONFIG_PCI_INDIRECT_BRIDGE:
4444842033e6SGabor Juhos		Enable support for indirect PCI bridges.
4445842033e6SGabor Juhos
4446a09b9b68SKumar Gala- CONFIG_SYS_SRIO:
4447a09b9b68SKumar Gala		Chip has SRIO or not
4448a09b9b68SKumar Gala
4449a09b9b68SKumar Gala- CONFIG_SRIO1:
4450a09b9b68SKumar Gala		Board has SRIO 1 port available
4451a09b9b68SKumar Gala
4452a09b9b68SKumar Gala- CONFIG_SRIO2:
4453a09b9b68SKumar Gala		Board has SRIO 2 port available
4454a09b9b68SKumar Gala
4455c8b28152SLiu Gang- CONFIG_SRIO_PCIE_BOOT_MASTER
4456c8b28152SLiu Gang		Board can support master function for Boot from SRIO and PCIE
4457c8b28152SLiu Gang
4458a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_VIRT:
4459a09b9b68SKumar Gala		Virtual Address of SRIO port 'n' memory region
4460a09b9b68SKumar Gala
4461a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_PHYS:
4462a09b9b68SKumar Gala		Physical Address of SRIO port 'n' memory region
4463a09b9b68SKumar Gala
4464a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_SIZE:
4465a09b9b68SKumar Gala		Size of SRIO port 'n' memory region
4466a09b9b68SKumar Gala
446766bd1846SFabio Estevam- CONFIG_SYS_NAND_BUSWIDTH_16BIT
446866bd1846SFabio Estevam		Defined to tell the NAND controller that the NAND chip is using
446966bd1846SFabio Estevam		a 16 bit bus.
447066bd1846SFabio Estevam		Not all NAND drivers use this symbol.
4471a430e916SFabio Estevam		Example of drivers that use it:
447266bd1846SFabio Estevam		- drivers/mtd/nand/ndfc.c
4473a430e916SFabio Estevam		- drivers/mtd/nand/mxc_nand.c
4474eced4626SAlex Waterman
4475eced4626SAlex Waterman- CONFIG_SYS_NDFC_EBC0_CFG
4476eced4626SAlex Waterman		Sets the EBC0_CFG register for the NDFC. If not defined
4477eced4626SAlex Waterman		a default value will be used.
4478eced4626SAlex Waterman
4479bb99ad6dSBen Warren- CONFIG_SPD_EEPROM
4480218ca724SWolfgang Denk		Get DDR timing information from an I2C EEPROM. Common
4481218ca724SWolfgang Denk		with pluggable memory modules such as SODIMMs
4482218ca724SWolfgang Denk
4483bb99ad6dSBen Warren  SPD_EEPROM_ADDRESS
4484bb99ad6dSBen Warren		I2C address of the SPD EEPROM
4485bb99ad6dSBen Warren
44866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM
4487218ca724SWolfgang Denk		If SPD EEPROM is on an I2C bus other than the first
4488218ca724SWolfgang Denk		one, specify here. Note that the value must resolve
4489218ca724SWolfgang Denk		to something your driver can deal with.
4490bb99ad6dSBen Warren
44911b3e3c4fSYork Sun- CONFIG_SYS_DDR_RAW_TIMING
44921b3e3c4fSYork Sun		Get DDR timing information from other than SPD. Common with
44931b3e3c4fSYork Sun		soldered DDR chips onboard without SPD. DDR raw timing
44941b3e3c4fSYork Sun		parameters are extracted from datasheet and hard-coded into
44951b3e3c4fSYork Sun		header files or board specific files.
44961b3e3c4fSYork Sun
44976f5e1dc5SYork Sun- CONFIG_FSL_DDR_INTERACTIVE
44986f5e1dc5SYork Sun		Enable interactive DDR debugging. See doc/README.fsl-ddr.
44996f5e1dc5SYork Sun
45006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0
4501218ca724SWolfgang Denk		Only for 83xx systems. If specified, then DDR should
4502218ca724SWolfgang Denk		be configured using CS0 and CS1 instead of CS2 and CS3.
45032ad6b513STimur Tabi
4504c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12]
4505c26e454dSwdenk		Define to enable FEC[12] on a 8xx series processor.
4506c26e454dSwdenk
4507c26e454dSwdenk- CONFIG_FEC[12]_PHY
4508c26e454dSwdenk		Define to the hardcoded PHY address which corresponds
45096e592385Swdenk		to the given FEC; i. e.
4510c26e454dSwdenk			#define CONFIG_FEC1_PHY 4
4511c26e454dSwdenk		means that the PHY with address 4 is connected to FEC1
4512c26e454dSwdenk
4513c26e454dSwdenk		When set to -1, means to probe for first available.
4514c26e454dSwdenk
4515c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR
4516c26e454dSwdenk		The PHY does not have a RXERR line (RMII only).
4517c26e454dSwdenk		(so program the FEC to ignore it).
4518c26e454dSwdenk
4519c26e454dSwdenk- CONFIG_RMII
4520c26e454dSwdenk		Enable RMII mode for all FECs.
4521c26e454dSwdenk		Note that this is a global option, we can't
4522c26e454dSwdenk		have one FEC in standard MII mode and another in RMII mode.
4523c26e454dSwdenk
45245cf91d6bSwdenk- CONFIG_CRC32_VERIFY
45255cf91d6bSwdenk		Add a verify option to the crc32 command.
45265cf91d6bSwdenk		The syntax is:
45275cf91d6bSwdenk
45285cf91d6bSwdenk		=> crc32 -v <address> <count> <crc32>
45295cf91d6bSwdenk
45305cf91d6bSwdenk		Where address/count indicate a memory area
45315cf91d6bSwdenk		and crc32 is the correct crc32 which the
45325cf91d6bSwdenk		area should have.
45335cf91d6bSwdenk
453456523f12Swdenk- CONFIG_LOOPW
453556523f12Swdenk		Add the "loopw" memory command. This only takes effect if
4536602ad3b3SJon Loeliger		the memory commands are activated globally (CONFIG_CMD_MEM).
453756523f12Swdenk
45387b466641Sstroese- CONFIG_MX_CYCLIC
45397b466641Sstroese		Add the "mdc" and "mwc" memory commands. These are cyclic
45407b466641Sstroese		"md/mw" commands.
45417b466641Sstroese		Examples:
45427b466641Sstroese
45437b466641Sstroese		=> mdc.b 10 4 500
45447b466641Sstroese		This command will print 4 bytes (10,11,12,13) each 500 ms.
45457b466641Sstroese
45467b466641Sstroese		=> mwc.l 100 12345678 10
45477b466641Sstroese		This command will write 12345678 to address 100 all 10 ms.
45487b466641Sstroese
45497b466641Sstroese		This only takes effect if the memory commands are activated
4550602ad3b3SJon Loeliger		globally (CONFIG_CMD_MEM).
45517b466641Sstroese
45528aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT
4553afc1ce82SMacpaul Lin		[ARM, NDS32, MIPS only] If this variable is defined, then certain
4554e03f3169SWolfgang Denk		low level initializations (like setting up the memory
4555e03f3169SWolfgang Denk		controller) are omitted and/or U-Boot does not
4556e03f3169SWolfgang Denk		relocate itself into RAM.
45578aa1a2d1Swdenk
4558e03f3169SWolfgang Denk		Normally this variable MUST NOT be defined. The only
4559e03f3169SWolfgang Denk		exception is when U-Boot is loaded (to RAM) by some
4560e03f3169SWolfgang Denk		other boot loader or by a debugger which performs
4561e03f3169SWolfgang Denk		these initializations itself.
45628aa1a2d1Swdenk
4563401bb30bSAneesh V- CONFIG_SPL_BUILD
4564df81238bSMagnus Lilja		Modifies the behaviour of start.S when compiling a loader
4565df81238bSMagnus Lilja		that is executed before the actual U-Boot. E.g. when
4566df81238bSMagnus Lilja		compiling a NAND SPL.
4567400558b5Swdenk
45683aa29de0SYing Zhang- CONFIG_TPL_BUILD
45693aa29de0SYing Zhang		Modifies the behaviour of start.S  when compiling a loader
45703aa29de0SYing Zhang		that is executed after the SPL and before the actual U-Boot.
45713aa29de0SYing Zhang		It is loaded by the SPL.
45723aa29de0SYing Zhang
45735df572f0SYing Zhang- CONFIG_SYS_MPC85XX_NO_RESETVEC
45745df572f0SYing Zhang		Only for 85xx systems. If this variable is specified, the section
45755df572f0SYing Zhang		.resetvec is not kept and the section .bootpg is placed in the
45765df572f0SYing Zhang		previous 4k of the .text section.
45775df572f0SYing Zhang
45784213fc29SSimon Glass- CONFIG_ARCH_MAP_SYSMEM
45794213fc29SSimon Glass		Generally U-Boot (and in particular the md command) uses
45804213fc29SSimon Glass		effective address. It is therefore not necessary to regard
45814213fc29SSimon Glass		U-Boot address as virtual addresses that need to be translated
45824213fc29SSimon Glass		to physical addresses. However, sandbox requires this, since
45834213fc29SSimon Glass		it maintains its own little RAM buffer which contains all
45844213fc29SSimon Glass		addressable memory. This option causes some memory accesses
45854213fc29SSimon Glass		to be mapped through map_sysmem() / unmap_sysmem().
45864213fc29SSimon Glass
4587d8834a13SMatthias Weisser- CONFIG_USE_ARCH_MEMCPY
4588d8834a13SMatthias Weisser  CONFIG_USE_ARCH_MEMSET
4589d8834a13SMatthias Weisser		If these options are used a optimized version of memcpy/memset will
4590d8834a13SMatthias Weisser		be used if available. These functions may be faster under some
4591d8834a13SMatthias Weisser		conditions but may increase the binary size.
4592d8834a13SMatthias Weisser
4593588a13f7SSimon Glass- CONFIG_X86_RESET_VECTOR
4594588a13f7SSimon Glass		If defined, the x86 reset vector code is included. This is not
4595588a13f7SSimon Glass		needed when U-Boot is running from Coreboot.
4596b16f521aSGabe Black
4597fc33705eSMark Jackson- CONFIG_SYS_MPUCLK
4598fc33705eSMark Jackson		Defines the MPU clock speed (in MHz).
4599fc33705eSMark Jackson
4600fc33705eSMark Jackson		NOTE : currently only supported on AM335x platforms.
46015b5ece9eSGabe Black
460216678eb4SHeiko Schocher- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
460316678eb4SHeiko Schocher		Enables the RTC32K OSC on AM33xx based plattforms
460416678eb4SHeiko Schocher
4605999d7d32SKaricheri, Muralidharan- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
4606999d7d32SKaricheri, Muralidharan		Option to disable subpage write in NAND driver
4607999d7d32SKaricheri, Muralidharan		driver that uses this:
4608999d7d32SKaricheri, Muralidharan		drivers/mtd/nand/davinci_nand.c
4609999d7d32SKaricheri, Muralidharan
4610f2717b47STimur TabiFreescale QE/FMAN Firmware Support:
4611f2717b47STimur Tabi-----------------------------------
4612f2717b47STimur Tabi
4613f2717b47STimur TabiThe Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4614f2717b47STimur Tabiloading of "firmware", which is encoded in the QE firmware binary format.
4615f2717b47STimur TabiThis firmware often needs to be loaded during U-Boot booting, so macros
4616f2717b47STimur Tabiare used to identify the storage device (NOR flash, SPI, etc) and the address
4617f2717b47STimur Tabiwithin that device.
4618f2717b47STimur Tabi
4619dcf1d774SZhao Qiang- CONFIG_SYS_FMAN_FW_ADDR
4620dcf1d774SZhao Qiang	The address in the storage device where the FMAN microcode is located.  The
4621dcf1d774SZhao Qiang	meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4622dcf1d774SZhao Qiang	is also specified.
4623dcf1d774SZhao Qiang
4624dcf1d774SZhao Qiang- CONFIG_SYS_QE_FW_ADDR
4625dcf1d774SZhao Qiang	The address in the storage device where the QE microcode is located.  The
4626f2717b47STimur Tabi	meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4627f2717b47STimur Tabi	is also specified.
4628f2717b47STimur Tabi
4629f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_LENGTH
4630f2717b47STimur Tabi	The maximum possible size of the firmware.  The firmware binary format
4631f2717b47STimur Tabi	has a field that specifies the actual size of the firmware, but it
4632f2717b47STimur Tabi	might not be possible to read any part of the firmware unless some
4633f2717b47STimur Tabi	local storage is allocated to hold the entire firmware first.
4634f2717b47STimur Tabi
4635f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4636f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4637f2717b47STimur Tabi	normal addressable memory via the LBC.  CONFIG_SYS_FMAN_FW_ADDR is the
4638f2717b47STimur Tabi	virtual address in NOR flash.
4639f2717b47STimur Tabi
4640f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4641f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NAND flash.
4642f2717b47STimur Tabi	CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4643f2717b47STimur Tabi
4644f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4645f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SD/MMC
4646f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4647f2717b47STimur Tabi
4648f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
4649f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SPI
4650f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4651f2717b47STimur Tabi
4652292dc6c5SLiu Gang- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4653292dc6c5SLiu Gang	Specifies that QE/FMAN firmware is located in the remote (master)
4654292dc6c5SLiu Gang	memory space.	CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
4655fc54c7faSLiu Gang	can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4656fc54c7faSLiu Gang	window->master inbound window->master LAW->the ucode address in
4657fc54c7faSLiu Gang	master's memory space.
4658f2717b47STimur Tabi
4659c609719bSwdenkBuilding the Software:
4660c609719bSwdenk======================
4661c609719bSwdenk
4662218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments
4663218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support
4664218ca724SWolfgang Denkall possibly existing versions of cross development tools in all
4665218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we
4666218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4667218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot.
4668c609719bSwdenk
4669218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you
4670218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case,
4671218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell.
4672218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are
4673218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter:
4674c609719bSwdenk
4675218ca724SWolfgang Denk	$ CROSS_COMPILE=ppc_4xx-
4676218ca724SWolfgang Denk	$ export CROSS_COMPILE
4677c609719bSwdenk
46782f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in
46792f8d396bSPeter Tyser      the tools directory you can use the MinGW toolchain
46802f8d396bSPeter Tyser      (http://www.mingw.org).  Set your HOST tools to the MinGW
46812f8d396bSPeter Tyser      toolchain and execute 'make tools'.  For example:
46822f8d396bSPeter Tyser
46832f8d396bSPeter Tyser       $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
46842f8d396bSPeter Tyser
46852f8d396bSPeter Tyser      Binaries such as tools/mkimage.exe will be created which can
46862f8d396bSPeter Tyser      be executed on computers running Windows.
46872f8d396bSPeter Tyser
4688c609719bSwdenkU-Boot is intended to be simple to build. After installing the
4689c609719bSwdenksources you must configure U-Boot for one specific board type. This
4690c609719bSwdenkis done by typing:
4691c609719bSwdenk
4692c609719bSwdenk	make NAME_config
4693c609719bSwdenk
4694218ca724SWolfgang Denkwhere "NAME_config" is the name of one of the existing configu-
46954d675ae6SMichael Jonesrations; see boards.cfg for supported names.
469654387ac9Swdenk
4697c609719bSwdenkNote: for some board special configuration names may exist; check if
4698c609719bSwdenk      additional information is available from the board vendor; for
46992729af9dSwdenk      instance, the TQM823L systems are available without (standard)
47002729af9dSwdenk      or with LCD support. You can select such additional "features"
470111ccc33fSMarcel Ziswiler      when choosing the configuration, i. e.
4702c609719bSwdenk
47032729af9dSwdenk      make TQM823L_config
47042729af9dSwdenk	- will configure for a plain TQM823L, i. e. no LCD support
4705c609719bSwdenk
4706c609719bSwdenk      make TQM823L_LCD_config
4707c609719bSwdenk	- will configure for a TQM823L with U-Boot console on LCD
4708c609719bSwdenk
4709c609719bSwdenk      etc.
4710c609719bSwdenk
4711c609719bSwdenk
4712c609719bSwdenkFinally, type "make all", and you should get some working U-Boot
47137152b1d0Swdenkimages ready for download to / installation on your system:
4714c609719bSwdenk
4715c609719bSwdenk- "u-boot.bin" is a raw binary image
4716c609719bSwdenk- "u-boot" is an image in ELF binary format
4717c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format
4718c609719bSwdenk
4719baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved
4720baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change
4721baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory:
4722baf31249SMarian Balakowicz
4723baf31249SMarian Balakowicz1. Add O= to the make command line invocations:
4724baf31249SMarian Balakowicz
4725baf31249SMarian Balakowicz	make O=/tmp/build distclean
4726baf31249SMarian Balakowicz	make O=/tmp/build NAME_config
4727baf31249SMarian Balakowicz	make O=/tmp/build all
4728baf31249SMarian Balakowicz
4729baf31249SMarian Balakowicz2. Set environment variable BUILD_DIR to point to the desired location:
4730baf31249SMarian Balakowicz
4731baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
4732baf31249SMarian Balakowicz	make distclean
4733baf31249SMarian Balakowicz	make NAME_config
4734baf31249SMarian Balakowicz	make all
4735baf31249SMarian Balakowicz
4736baf31249SMarian BalakowiczNote that the command line "O=" setting overrides the BUILD_DIR environment
4737baf31249SMarian Balakowiczvariable.
4738baf31249SMarian Balakowicz
4739c609719bSwdenk
4740c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so
4741c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of
4742c609719bSwdenknative "make".
4743c609719bSwdenk
4744c609719bSwdenk
4745c609719bSwdenkIf the system board that you have is not listed, then you will need
4746c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these
4747c609719bSwdenksteps:
4748c609719bSwdenk
4749c609719bSwdenk1.  Add a new configuration option for your board to the toplevel
47504d675ae6SMichael Jones    "boards.cfg" file, using the existing entries as examples.
47514d675ae6SMichael Jones    Follow the instructions there to keep the boards in order.
4752c609719bSwdenk2.  Create a new directory to hold your board specific code. Add any
475385ec0bccSwdenk    files you need. In your board directory, you will need at least
475485ec0bccSwdenk    the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
475585ec0bccSwdenk3.  Create a new configuration file "include/configs/<board>.h" for
475685ec0bccSwdenk    your board
4757c609719bSwdenk3.  If you're porting U-Boot to a new CPU, then also create a new
4758c609719bSwdenk    directory to hold your CPU specific code. Add any files you need.
475985ec0bccSwdenk4.  Run "make <board>_config" with your new name.
4760c609719bSwdenk5.  Type "make", and you should get a working "u-boot.srec" file
4761c609719bSwdenk    to be installed on your target system.
476285ec0bccSwdenk6.  Debug and solve any problems that might arise.
4763c609719bSwdenk    [Of course, this last step is much harder than it sounds.]
4764c609719bSwdenk
4765c609719bSwdenk
4766c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.:
4767c609719bSwdenk==============================================================
4768c609719bSwdenk
4769c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board
4770c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to
4771c609719bSwdenkprovide feedback to the other developers. The feedback normally takes
4772c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest
4773218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources.
4774c609719bSwdenk
4775c609719bSwdenkBut before you submit such a patch, please verify that your modifi-
4776c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of
4777c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so,
4778c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot
4779c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You can
47807152b1d0Swdenkselect which (cross) compiler to use by passing a `CROSS_COMPILE'
4781218ca724SWolfgang Denkenvironment variable to the script, i. e. to use the ELDK cross tools
4782218ca724SWolfgang Denkyou can type
4783c609719bSwdenk
4784c609719bSwdenk	CROSS_COMPILE=ppc_8xx- MAKEALL
4785c609719bSwdenk
4786c609719bSwdenkor to build on a native PowerPC system you can type
4787c609719bSwdenk
4788c609719bSwdenk	CROSS_COMPILE=' ' MAKEALL
4789c609719bSwdenk
4790218ca724SWolfgang DenkWhen using the MAKEALL script, the default behaviour is to build
4791218ca724SWolfgang DenkU-Boot in the source directory. This location can be changed by
4792218ca724SWolfgang Denksetting the BUILD_DIR environment variable. Also, for each target
4793218ca724SWolfgang Denkbuilt, the MAKEALL script saves two log files (<target>.ERR and
4794218ca724SWolfgang Denk<target>.MAKEALL) in the <source dir>/LOG directory. This default
4795218ca724SWolfgang Denklocation can be changed by setting the MAKEALL_LOGDIR environment
4796218ca724SWolfgang Denkvariable. For example:
4797baf31249SMarian Balakowicz
4798baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
4799baf31249SMarian Balakowicz	export MAKEALL_LOGDIR=/tmp/log
4800baf31249SMarian Balakowicz	CROSS_COMPILE=ppc_8xx- MAKEALL
4801baf31249SMarian Balakowicz
4802218ca724SWolfgang DenkWith the above settings build objects are saved in the /tmp/build,
4803218ca724SWolfgang Denklog files are saved in the /tmp/log and the source tree remains clean
4804218ca724SWolfgang Denkduring the whole build process.
4805baf31249SMarian Balakowicz
4806baf31249SMarian Balakowicz
4807c609719bSwdenkSee also "U-Boot Porting Guide" below.
4808c609719bSwdenk
4809c609719bSwdenk
4810c609719bSwdenkMonitor Commands - Overview:
4811c609719bSwdenk============================
4812c609719bSwdenk
4813c609719bSwdenkgo	- start application at address 'addr'
4814c609719bSwdenkrun	- run commands in an environment variable
4815c609719bSwdenkbootm	- boot application image from memory
4816c609719bSwdenkbootp	- boot image via network using BootP/TFTP protocol
481744f074c7SMarek Vasutbootz   - boot zImage from memory
4818c609719bSwdenktftpboot- boot image via network using TFTP protocol
4819c609719bSwdenk	       and env variables "ipaddr" and "serverip"
4820c609719bSwdenk	       (and eventually "gatewayip")
48211fb7cd49SSimon Glasstftpput - upload a file via network using TFTP protocol
4822c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol
4823c609719bSwdenkdiskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
4824c609719bSwdenkloads	- load S-Record file over serial line
4825c609719bSwdenkloadb	- load binary file over serial line (kermit mode)
4826c609719bSwdenkmd	- memory display
4827c609719bSwdenkmm	- memory modify (auto-incrementing)
4828c609719bSwdenknm	- memory modify (constant address)
4829c609719bSwdenkmw	- memory write (fill)
4830c609719bSwdenkcp	- memory copy
4831c609719bSwdenkcmp	- memory compare
4832c609719bSwdenkcrc32	- checksum calculation
48330f89c54bSPeter Tyseri2c	- I2C sub-system
4834c609719bSwdenksspi	- SPI utility commands
4835c609719bSwdenkbase	- print or set address offset
4836c609719bSwdenkprintenv- print environment variables
4837c609719bSwdenksetenv	- set environment variables
4838c609719bSwdenksaveenv - save environment variables to persistent storage
4839c609719bSwdenkprotect - enable or disable FLASH write protection
4840c609719bSwdenkerase	- erase FLASH memory
4841c609719bSwdenkflinfo	- print FLASH memory information
484210635afaSKarl O. Pincnand	- NAND memory operations (see doc/README.nand)
4843c609719bSwdenkbdinfo	- print Board Info structure
4844c609719bSwdenkiminfo	- print header information for application image
4845c609719bSwdenkconinfo - print console devices and informations
4846c609719bSwdenkide	- IDE sub-system
4847c609719bSwdenkloop	- infinite loop on address range
484856523f12Swdenkloopw	- infinite write loop on address range
4849c609719bSwdenkmtest	- simple RAM test
4850c609719bSwdenkicache	- enable or disable instruction cache
4851c609719bSwdenkdcache	- enable or disable data cache
4852c609719bSwdenkreset	- Perform RESET of the CPU
4853c609719bSwdenkecho	- echo args to console
4854c609719bSwdenkversion - print monitor version
4855c609719bSwdenkhelp	- print online help
4856c609719bSwdenk?	- alias for 'help'
4857c609719bSwdenk
4858c609719bSwdenk
4859c609719bSwdenkMonitor Commands - Detailed Description:
4860c609719bSwdenk========================================
4861c609719bSwdenk
4862c609719bSwdenkTODO.
4863c609719bSwdenk
4864c609719bSwdenkFor now: just type "help <command>".
4865c609719bSwdenk
4866c609719bSwdenk
4867c609719bSwdenkEnvironment Variables:
4868c609719bSwdenk======================
4869c609719bSwdenk
4870c609719bSwdenkU-Boot supports user configuration using Environment Variables which
4871c609719bSwdenkcan be made persistent by saving to Flash memory.
4872c609719bSwdenk
4873c609719bSwdenkEnvironment Variables are set using "setenv", printed using
4874c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv"
4875c609719bSwdenkwithout a value can be used to delete a variable from the
4876c609719bSwdenkenvironment. As long as you don't save the environment you are
4877c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the
4878c609719bSwdenkenvironment is erased by accident, a default environment is provided.
4879c609719bSwdenk
4880c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables.
4881c96f86eeSWolfgang Denk
4882c96f86eeSWolfgang DenkList of environment variables (most likely not complete):
4883c609719bSwdenk
4884c609719bSwdenk  baudrate	- see CONFIG_BAUDRATE
4885c609719bSwdenk
4886c609719bSwdenk  bootdelay	- see CONFIG_BOOTDELAY
4887c609719bSwdenk
4888c609719bSwdenk  bootcmd	- see CONFIG_BOOTCOMMAND
4889c609719bSwdenk
4890c609719bSwdenk  bootargs	- Boot arguments when booting an RTOS image
4891c609719bSwdenk
4892c609719bSwdenk  bootfile	- Name of the image to load with TFTP
4893c609719bSwdenk
48947d721e34SBartlomiej Sieka  bootm_low	- Memory range available for image processing in the bootm
48957d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
48967d721e34SBartlomiej Sieka		  a hexadecimal number and defines lowest address allowed
48977d721e34SBartlomiej Sieka		  for use by the bootm command. See also "bootm_size"
48987d721e34SBartlomiej Sieka		  environment variable. Address defined by "bootm_low" is
48997d721e34SBartlomiej Sieka		  also the base of the initial memory mapping for the Linux
4900c3624e6eSGrant Likely		  kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4901c3624e6eSGrant Likely		  bootm_mapsize.
4902c3624e6eSGrant Likely
4903c3624e6eSGrant Likely  bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
4904c3624e6eSGrant Likely		  This variable is given as a hexadecimal number and it
4905c3624e6eSGrant Likely		  defines the size of the memory region starting at base
4906c3624e6eSGrant Likely		  address bootm_low that is accessible by the Linux kernel
4907c3624e6eSGrant Likely		  during early boot.  If unset, CONFIG_SYS_BOOTMAPSZ is used
4908c3624e6eSGrant Likely		  as the default value if it is defined, and bootm_size is
4909c3624e6eSGrant Likely		  used otherwise.
49107d721e34SBartlomiej Sieka
49117d721e34SBartlomiej Sieka  bootm_size	- Memory range available for image processing in the bootm
49127d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
49137d721e34SBartlomiej Sieka		  a hexadecimal number and defines the size of the region
49147d721e34SBartlomiej Sieka		  allowed for use by the bootm command. See also "bootm_low"
49157d721e34SBartlomiej Sieka		  environment variable.
49167d721e34SBartlomiej Sieka
49174bae9090SBartlomiej Sieka  updatefile	- Location of the software update file on a TFTP server, used
49184bae9090SBartlomiej Sieka		  by the automatic software update feature. Please refer to
49194bae9090SBartlomiej Sieka		  documentation in doc/README.update for more details.
49204bae9090SBartlomiej Sieka
4921c609719bSwdenk  autoload	- if set to "no" (any string beginning with 'n'),
4922c609719bSwdenk		  "bootp" will just load perform a lookup of the
4923c609719bSwdenk		  configuration from the BOOTP server, but not try to
4924c609719bSwdenk		  load any image using TFTP
4925c609719bSwdenk
4926c609719bSwdenk  autostart	- if set to "yes", an image loaded using the "bootp",
4927c609719bSwdenk		  "rarpboot", "tftpboot" or "diskboot" commands will
4928c609719bSwdenk		  be automatically started (by internally calling
4929c609719bSwdenk		  "bootm")
4930c609719bSwdenk
49314a6fd34bSwdenk		  If set to "no", a standalone image passed to the
49324a6fd34bSwdenk		  "bootm" command will be copied to the load address
49334a6fd34bSwdenk		  (and eventually uncompressed), but NOT be started.
49344a6fd34bSwdenk		  This can be used to load and uncompress arbitrary
49354a6fd34bSwdenk		  data.
49364a6fd34bSwdenk
4937a28afca5SDavid A. Long  fdt_high	- if set this restricts the maximum address that the
4938a28afca5SDavid A. Long		  flattened device tree will be copied into upon boot.
4939fa34f6b2SShawn Guo		  For example, if you have a system with 1 GB memory
4940fa34f6b2SShawn Guo		  at physical address 0x10000000, while Linux kernel
4941fa34f6b2SShawn Guo		  only recognizes the first 704 MB as low memory, you
4942fa34f6b2SShawn Guo		  may need to set fdt_high as 0x3C000000 to have the
4943fa34f6b2SShawn Guo		  device tree blob be copied to the maximum address
4944fa34f6b2SShawn Guo		  of the 704 MB low memory, so that Linux kernel can
4945fa34f6b2SShawn Guo		  access it during the boot procedure.
4946fa34f6b2SShawn Guo
4947a28afca5SDavid A. Long		  If this is set to the special value 0xFFFFFFFF then
4948a28afca5SDavid A. Long		  the fdt will not be copied at all on boot.  For this
4949a28afca5SDavid A. Long		  to work it must reside in writable memory, have
4950a28afca5SDavid A. Long		  sufficient padding on the end of it for u-boot to
4951a28afca5SDavid A. Long		  add the information it needs into it, and the memory
4952a28afca5SDavid A. Long		  must be accessible by the kernel.
4953a28afca5SDavid A. Long
4954eea63e05SSimon Glass  fdtcontroladdr- if set this is the address of the control flattened
4955eea63e05SSimon Glass		  device tree used by U-Boot when CONFIG_OF_CONTROL is
4956eea63e05SSimon Glass		  defined.
4957eea63e05SSimon Glass
495817ea1177Swdenk  i2cfast	- (PPC405GP|PPC405EP only)
495917ea1177Swdenk		  if set to 'y' configures Linux I2C driver for fast
496017ea1177Swdenk		  mode (400kHZ). This environment variable is used in
496117ea1177Swdenk		  initialization code. So, for changes to be effective
496217ea1177Swdenk		  it must be saved and board must be reset.
496317ea1177Swdenk
4964c609719bSwdenk  initrd_high	- restrict positioning of initrd images:
4965c609719bSwdenk		  If this variable is not set, initrd images will be
4966c609719bSwdenk		  copied to the highest possible address in RAM; this
4967c609719bSwdenk		  is usually what you want since it allows for
4968c609719bSwdenk		  maximum initrd size. If for some reason you want to
4969c609719bSwdenk		  make sure that the initrd image is loaded below the
49706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		  CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
4971c609719bSwdenk		  variable to a value of "no" or "off" or "0".
4972c609719bSwdenk		  Alternatively, you can set it to a maximum upper
4973c609719bSwdenk		  address to use (U-Boot will still check that it
4974c609719bSwdenk		  does not overwrite the U-Boot stack and data).
4975c609719bSwdenk
4976c609719bSwdenk		  For instance, when you have a system with 16 MB
49777152b1d0Swdenk		  RAM, and want to reserve 4 MB from use by Linux,
4978c609719bSwdenk		  you can do this by adding "mem=12M" to the value of
4979c609719bSwdenk		  the "bootargs" variable. However, now you must make
49807152b1d0Swdenk		  sure that the initrd image is placed in the first
4981c609719bSwdenk		  12 MB as well - this can be done with
4982c609719bSwdenk
4983c609719bSwdenk		  setenv initrd_high 00c00000
4984c609719bSwdenk
498538b99261Swdenk		  If you set initrd_high to 0xFFFFFFFF, this is an
498638b99261Swdenk		  indication to U-Boot that all addresses are legal
498738b99261Swdenk		  for the Linux kernel, including addresses in flash
498838b99261Swdenk		  memory. In this case U-Boot will NOT COPY the
498938b99261Swdenk		  ramdisk at all. This may be useful to reduce the
499038b99261Swdenk		  boot time on your system, but requires that this
499138b99261Swdenk		  feature is supported by your Linux kernel.
499238b99261Swdenk
4993c609719bSwdenk  ipaddr	- IP address; needed for tftpboot command
4994c609719bSwdenk
4995c609719bSwdenk  loadaddr	- Default load address for commands like "bootp",
4996dc7c9a1aSwdenk		  "rarpboot", "tftpboot", "loadb" or "diskboot"
4997c609719bSwdenk
4998c609719bSwdenk  loads_echo	- see CONFIG_LOADS_ECHO
4999c609719bSwdenk
5000c609719bSwdenk  serverip	- TFTP server IP address; needed for tftpboot command
5001c609719bSwdenk
5002c609719bSwdenk  bootretry	- see CONFIG_BOOT_RETRY_TIME
5003c609719bSwdenk
5004c609719bSwdenk  bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
5005c609719bSwdenk
5006c609719bSwdenk  bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
5007c609719bSwdenk
5008e2a53458SMike Frysinger  ethprime	- controls which interface is used first.
5009a3d991bdSwdenk
5010e2a53458SMike Frysinger  ethact	- controls which interface is currently active.
5011e2a53458SMike Frysinger		  For example you can do the following
5012a3d991bdSwdenk
501348690d80SHeiko Schocher		  => setenv ethact FEC
501448690d80SHeiko Schocher		  => ping 192.168.0.1 # traffic sent on FEC
501548690d80SHeiko Schocher		  => setenv ethact SCC
501648690d80SHeiko Schocher		  => ping 10.0.0.1 # traffic sent on SCC
5017a3d991bdSwdenk
5018e1692577SMatthias Fuchs  ethrotate	- When set to "no" U-Boot does not go through all
5019e1692577SMatthias Fuchs		  available network interfaces.
5020e1692577SMatthias Fuchs		  It just stays at the currently selected interface.
5021e1692577SMatthias Fuchs
5022a3d991bdSwdenk  netretry	- When set to "no" each network operation will
5023a3d991bdSwdenk		  either succeed or fail without retrying.
50246e592385Swdenk		  When set to "once" the network operation will
50256e592385Swdenk		  fail when all the available network interfaces
50266e592385Swdenk		  are tried once without success.
5027a3d991bdSwdenk		  Useful on scripts which control the retry operation
5028a3d991bdSwdenk		  themselves.
5029a3d991bdSwdenk
5030b4e2f89dSJean-Christophe PLAGNIOL-VILLARD  npe_ucode	- set load address for the NPE microcode
5031a1cf027aSJean-Christophe PLAGNIOL-VILLARD
50328d51aacdSSimon Glass  silent_linux  - If set then linux will be told to boot silently, by
50338d51aacdSSimon Glass		  changing the console to be empty. If "yes" it will be
50348d51aacdSSimon Glass		  made silent. If "no" it will not be made silent. If
50358d51aacdSSimon Glass		  unset, then it will be made silent if the U-Boot console
50368d51aacdSSimon Glass		  is silent.
50378d51aacdSSimon Glass
503828cb9375SWolfgang Denk  tftpsrcport	- If this is set, the value is used for TFTP's
5039ecb0ccd9SWolfgang Denk		  UDP source port.
5040ecb0ccd9SWolfgang Denk
504128cb9375SWolfgang Denk  tftpdstport	- If this is set, the value is used for TFTP's UDP
504228cb9375SWolfgang Denk		  destination port instead of the Well Know Port 69.
504328cb9375SWolfgang Denk
5044c96f86eeSWolfgang Denk  tftpblocksize - Block size to use for TFTP transfers; if not set,
5045c96f86eeSWolfgang Denk		  we use the TFTP server's default block size
5046c96f86eeSWolfgang Denk
5047c96f86eeSWolfgang Denk  tftptimeout	- Retransmission timeout for TFTP packets (in milli-
5048c96f86eeSWolfgang Denk		  seconds, minimum value is 1000 = 1 second). Defines
5049c96f86eeSWolfgang Denk		  when a packet is considered to be lost so it has to
5050c96f86eeSWolfgang Denk		  be retransmitted. The default is 5000 = 5 seconds.
5051c96f86eeSWolfgang Denk		  Lowering this value may make downloads succeed
5052c96f86eeSWolfgang Denk		  faster in networks with high packet loss rates or
5053c96f86eeSWolfgang Denk		  with unreliable TFTP servers.
5054c96f86eeSWolfgang Denk
5055a3d991bdSwdenk  vlan		- When set to a value < 4095 the traffic over
505611ccc33fSMarcel Ziswiler		  Ethernet is encapsulated/received over 802.1q
5057a3d991bdSwdenk		  VLAN tagged frames.
5058c609719bSwdenk
5059dc0b7b0eSJason HobbsThe following image location variables contain the location of images
5060dc0b7b0eSJason Hobbsused in booting. The "Image" column gives the role of the image and is
5061dc0b7b0eSJason Hobbsnot an environment variable name. The other columns are environment
5062dc0b7b0eSJason Hobbsvariable names. "File Name" gives the name of the file on a TFTP
5063dc0b7b0eSJason Hobbsserver, "RAM Address" gives the location in RAM the image will be
5064dc0b7b0eSJason Hobbsloaded to, and "Flash Location" gives the image's address in NOR
5065dc0b7b0eSJason Hobbsflash or offset in NAND flash.
5066dc0b7b0eSJason Hobbs
5067dc0b7b0eSJason Hobbs*Note* - these variables don't have to be defined for all boards, some
5068dc0b7b0eSJason Hobbsboards currenlty use other variables for these purposes, and some
5069dc0b7b0eSJason Hobbsboards use these variables for other purposes.
5070dc0b7b0eSJason Hobbs
5071dc0b7b0eSJason HobbsImage		    File Name	     RAM Address       Flash Location
5072dc0b7b0eSJason Hobbs-----		    ---------	     -----------       --------------
5073dc0b7b0eSJason Hobbsu-boot		    u-boot	     u-boot_addr_r     u-boot_addr
5074dc0b7b0eSJason HobbsLinux kernel	    bootfile	     kernel_addr_r     kernel_addr
5075dc0b7b0eSJason Hobbsdevice tree blob    fdtfile	     fdt_addr_r	       fdt_addr
5076dc0b7b0eSJason Hobbsramdisk		    ramdiskfile	     ramdisk_addr_r    ramdisk_addr
5077dc0b7b0eSJason Hobbs
5078c609719bSwdenkThe following environment variables may be used and automatically
5079c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"),
5080c609719bSwdenkdepending the information provided by your boot server:
5081c609719bSwdenk
5082c609719bSwdenk  bootfile	- see above
5083c609719bSwdenk  dnsip		- IP address of your Domain Name Server
5084fe389a82Sstroese  dnsip2	- IP address of your secondary Domain Name Server
5085c609719bSwdenk  gatewayip	- IP address of the Gateway (Router) to use
5086c609719bSwdenk  hostname	- Target hostname
5087c609719bSwdenk  ipaddr	- see above
5088c609719bSwdenk  netmask	- Subnet Mask
5089c609719bSwdenk  rootpath	- Pathname of the root filesystem on the NFS server
5090c609719bSwdenk  serverip	- see above
5091c609719bSwdenk
5092c609719bSwdenk
5093c609719bSwdenkThere are two special Environment Variables:
5094c609719bSwdenk
5095c609719bSwdenk  serial#	- contains hardware identification information such
5096c609719bSwdenk		  as type string and/or serial number
5097c609719bSwdenk  ethaddr	- Ethernet address
5098c609719bSwdenk
5099c609719bSwdenkThese variables can be set only once (usually during manufacturing of
5100c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables
5101c609719bSwdenkonce they have been set once.
5102c609719bSwdenk
5103c609719bSwdenk
5104c1551ea8SstroeseFurther special Environment Variables:
5105c1551ea8Sstroese
5106c1551ea8Sstroese  ver		- Contains the U-Boot version string as printed
5107c1551ea8Sstroese		  with the "version" command. This variable is
5108c1551ea8Sstroese		  readonly (see CONFIG_VERSION_VARIABLE).
5109c1551ea8Sstroese
5110c1551ea8Sstroese
5111c609719bSwdenkPlease note that changes to some configuration parameters may take
5112c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-).
5113c609719bSwdenk
5114c609719bSwdenk
5115170ab110SJoe HershbergerCallback functions for environment variables:
5116170ab110SJoe Hershberger---------------------------------------------
5117170ab110SJoe Hershberger
5118170ab110SJoe HershbergerFor some environment variables, the behavior of u-boot needs to change
5119170ab110SJoe Hershbergerwhen their values are changed.  This functionailty allows functions to
5120170ab110SJoe Hershbergerbe associated with arbitrary variables.  On creation, overwrite, or
5121170ab110SJoe Hershbergerdeletion, the callback will provide the opportunity for some side
5122170ab110SJoe Hershbergereffect to happen or for the change to be rejected.
5123170ab110SJoe Hershberger
5124170ab110SJoe HershbergerThe callbacks are named and associated with a function using the
5125170ab110SJoe HershbergerU_BOOT_ENV_CALLBACK macro in your board or driver code.
5126170ab110SJoe Hershberger
5127170ab110SJoe HershbergerThese callbacks are associated with variables in one of two ways.  The
5128170ab110SJoe Hershbergerstatic list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
5129170ab110SJoe Hershbergerin the board configuration to a string that defines a list of
5130170ab110SJoe Hershbergerassociations.  The list must be in the following format:
5131170ab110SJoe Hershberger
5132170ab110SJoe Hershberger	entry = variable_name[:callback_name]
5133170ab110SJoe Hershberger	list = entry[,list]
5134170ab110SJoe Hershberger
5135170ab110SJoe HershbergerIf the callback name is not specified, then the callback is deleted.
5136170ab110SJoe HershbergerSpaces are also allowed anywhere in the list.
5137170ab110SJoe Hershberger
5138170ab110SJoe HershbergerCallbacks can also be associated by defining the ".callbacks" variable
5139170ab110SJoe Hershbergerwith the same list format above.  Any association in ".callbacks" will
5140170ab110SJoe Hershbergeroverride any association in the static list. You can define
5141170ab110SJoe HershbergerCONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
5142170ab110SJoe Hershberger".callbacks" envirnoment variable in the default or embedded environment.
5143170ab110SJoe Hershberger
5144170ab110SJoe Hershberger
5145f07771ccSwdenkCommand Line Parsing:
5146f07771ccSwdenk=====================
5147f07771ccSwdenk
5148f07771ccSwdenkThere are two different command line parsers available with U-Boot:
51497152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell:
5150f07771ccSwdenk
5151f07771ccSwdenkOld, simple command line parser:
5152f07771ccSwdenk--------------------------------
5153f07771ccSwdenk
5154f07771ccSwdenk- supports environment variables (through setenv / saveenv commands)
5155f07771ccSwdenk- several commands on one line, separated by ';'
5156fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax
5157f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\',
5158f07771ccSwdenk  for example:
5159fe126d8bSWolfgang Denk	setenv bootcmd bootm \${address}
5160f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example:
5161f07771ccSwdenk	setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
5162f07771ccSwdenk
5163f07771ccSwdenkHush shell:
5164f07771ccSwdenk-----------
5165f07771ccSwdenk
5166f07771ccSwdenk- similar to Bourne shell, with control structures like
5167f07771ccSwdenk  if...then...else...fi, for...do...done; while...do...done,
5168f07771ccSwdenk  until...do...done, ...
5169f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv
5170f07771ccSwdenk  commands) and local shell variables (through standard shell syntax
5171f07771ccSwdenk  "name=value"); only environment variables can be used with "run"
5172f07771ccSwdenk  command
5173f07771ccSwdenk
5174f07771ccSwdenkGeneral rules:
5175f07771ccSwdenk--------------
5176f07771ccSwdenk
5177f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run"
5178f07771ccSwdenk    command) contains several commands separated by semicolon, and
5179f07771ccSwdenk    one of these commands fails, then the remaining commands will be
5180f07771ccSwdenk    executed anyway.
5181f07771ccSwdenk
5182f07771ccSwdenk(2) If you execute several variables with one call to run (i. e.
518311ccc33fSMarcel Ziswiler    calling run with a list of variables as arguments), any failing
5184f07771ccSwdenk    command will cause "run" to terminate, i. e. the remaining
5185f07771ccSwdenk    variables are not executed.
5186f07771ccSwdenk
5187c609719bSwdenkNote for Redundant Ethernet Interfaces:
5188c609719bSwdenk=======================================
5189c609719bSwdenk
519011ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports
5191c609719bSwdenksuch configurations and is capable of automatic selection of a
51927152b1d0Swdenk"working" interface when needed. MAC assignment works as follows:
5193c609719bSwdenk
5194c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding
5195c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0),
5196c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ...
5197c609719bSwdenk
5198c609719bSwdenkIf the network interface stores some valid MAC address (for instance
5199c609719bSwdenkin SROM), this is used as default address if there is NO correspon-
5200c609719bSwdenkding setting in the environment; if the corresponding environment
5201c609719bSwdenkvariable is set, this overrides the settings in the card; that means:
5202c609719bSwdenk
5203c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the
5204c609719bSwdenk  environment, the SROM's address is used.
5205c609719bSwdenk
5206c609719bSwdenko If there is no valid address in the SROM, and a definition in the
5207c609719bSwdenk  environment exists, then the value from the environment variable is
5208c609719bSwdenk  used.
5209c609719bSwdenk
5210c609719bSwdenko If both the SROM and the environment contain a MAC address, and
5211c609719bSwdenk  both addresses are the same, this MAC address is used.
5212c609719bSwdenk
5213c609719bSwdenko If both the SROM and the environment contain a MAC address, and the
5214c609719bSwdenk  addresses differ, the value from the environment is used and a
5215c609719bSwdenk  warning is printed.
5216c609719bSwdenk
5217c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error
5218c609719bSwdenk  is raised.
5219c609719bSwdenk
5220ecee9324SBen WarrenIf Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
5221ecee9324SBen Warrenwill be programmed into hardware as part of the initialization process.	 This
5222ecee9324SBen Warrenmay be skipped by setting the appropriate 'ethmacskip' environment variable.
5223ecee9324SBen WarrenThe naming convention is as follows:
5224ecee9324SBen Warren"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
5225c609719bSwdenk
5226c609719bSwdenkImage Formats:
5227c609719bSwdenk==============
5228c609719bSwdenk
52293310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on)
52303310c549SMarian Balakowiczimages in two formats:
52313310c549SMarian Balakowicz
52323310c549SMarian BalakowiczNew uImage format (FIT)
52333310c549SMarian Balakowicz-----------------------
52343310c549SMarian Balakowicz
52353310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar
52363310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple
52373310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by
52383310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
52393310c549SMarian Balakowicz
52403310c549SMarian Balakowicz
52413310c549SMarian BalakowiczOld uImage format
52423310c549SMarian Balakowicz-----------------
52433310c549SMarian Balakowicz
52443310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything,
52453310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for
52463310c549SMarian Balakowiczdetails; basically, the header defines the following image properties:
5247c609719bSwdenk
5248c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5249c609719bSwdenk  4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
5250f5ed9e39SPeter Tyser  LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5251f5ed9e39SPeter Tyser  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5252f5ed9e39SPeter Tyser  INTEGRITY).
52537b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
5254afc1ce82SMacpaul Lin  IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5255afc1ce82SMacpaul Lin  Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
5256c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2)
5257c609719bSwdenk* Load Address
5258c609719bSwdenk* Entry Point
5259c609719bSwdenk* Image Name
5260c609719bSwdenk* Image Timestamp
5261c609719bSwdenk
5262c609719bSwdenkThe header is marked by a special Magic Number, and both the header
5263c609719bSwdenkand the data portions of the image are secured against corruption by
5264c609719bSwdenkCRC32 checksums.
5265c609719bSwdenk
5266c609719bSwdenk
5267c609719bSwdenkLinux Support:
5268c609719bSwdenk==============
5269c609719bSwdenk
5270c609719bSwdenkAlthough U-Boot should support any OS or standalone application
52717152b1d0Swdenkeasily, the main focus has always been on Linux during the design of
5272c609719bSwdenkU-Boot.
5273c609719bSwdenk
5274c609719bSwdenkU-Boot includes many features that so far have been part of some
5275c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any
5276c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image;
5277c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation
52787152b1d0Swdenkserves several purposes:
5279c609719bSwdenk
5280c609719bSwdenk- the same features can be used for other OS or standalone
5281c609719bSwdenk  applications (for instance: using compressed images to reduce the
5282c609719bSwdenk  Flash memory footprint)
5283c609719bSwdenk
5284c609719bSwdenk- it becomes much easier to port new Linux kernel versions because
52857152b1d0Swdenk  lots of low-level, hardware dependent stuff are done by U-Boot
5286c609719bSwdenk
5287c609719bSwdenk- the same Linux kernel image can now be used with different "initrd"
5288c609719bSwdenk  images; of course this also means that different kernel images can
5289c609719bSwdenk  be run with the same "initrd". This makes testing easier (you don't
5290c609719bSwdenk  have to build a new "zImage.initrd" Linux image when you just
5291c609719bSwdenk  change a file in your "initrd"). Also, a field-upgrade of the
5292c609719bSwdenk  software is easier now.
5293c609719bSwdenk
5294c609719bSwdenk
5295c609719bSwdenkLinux HOWTO:
5296c609719bSwdenk============
5297c609719bSwdenk
5298c609719bSwdenkPorting Linux to U-Boot based systems:
5299c609719bSwdenk---------------------------------------
5300c609719bSwdenk
5301c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to
5302c609719bSwdenkconfigure the Linux device drivers for use with your target hardware
5303c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to
5304c609719bSwdenkLinux :-).
5305c609719bSwdenk
5306a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
5307c609719bSwdenk
5308c609719bSwdenkJust make sure your machine specific header file (for instance
5309c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board
53101dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h,
53111dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value
53126d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR.
5313c609719bSwdenk
5314c609719bSwdenk
5315c609719bSwdenkConfiguring the Linux kernel:
5316c609719bSwdenk-----------------------------
5317c609719bSwdenk
5318c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root
5319c609719bSwdenkdevice (initial ramdisk, NFS) for your target system.
5320c609719bSwdenk
5321c609719bSwdenk
5322c609719bSwdenkBuilding a Linux Image:
5323c609719bSwdenk-----------------------
5324c609719bSwdenk
532524ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are
532624ee89b9Swdenknot used. If you use recent kernel source, a new build target
532724ee89b9Swdenk"uImage" will exist which automatically builds an image usable by
532824ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target,
532924ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a
533024ee89b9Swdenk100% compatible format.
5331c609719bSwdenk
5332c609719bSwdenkExample:
5333c609719bSwdenk
5334c609719bSwdenk	make TQM850L_config
5335c609719bSwdenk	make oldconfig
5336c609719bSwdenk	make dep
533724ee89b9Swdenk	make uImage
5338c609719bSwdenk
533924ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to
534024ee89b9Swdenkencapsulate a compressed Linux kernel image with header	 information,
534124ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing:
5342c609719bSwdenk
534324ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format):
534424ee89b9Swdenk
534524ee89b9Swdenk* convert the kernel into a raw binary image:
534624ee89b9Swdenk
534724ee89b9Swdenk	${CROSS_COMPILE}-objcopy -O binary \
534824ee89b9Swdenk				 -R .note -R .comment \
534924ee89b9Swdenk				 -S vmlinux linux.bin
535024ee89b9Swdenk
535124ee89b9Swdenk* compress the binary image:
535224ee89b9Swdenk
535324ee89b9Swdenk	gzip -9 linux.bin
535424ee89b9Swdenk
535524ee89b9Swdenk* package compressed binary image for U-Boot:
535624ee89b9Swdenk
535724ee89b9Swdenk	mkimage -A ppc -O linux -T kernel -C gzip \
535824ee89b9Swdenk		-a 0 -e 0 -n "Linux Kernel Image" \
535924ee89b9Swdenk		-d linux.bin.gz uImage
536024ee89b9Swdenk
536124ee89b9Swdenk
536224ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use
536324ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or
536424ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64
536524ee89b9Swdenkbyte header containing information about target architecture,
536624ee89b9Swdenkoperating system, image type, compression method, entry points, time
536724ee89b9Swdenkstamp, CRC32 checksums, etc.
536824ee89b9Swdenk
536924ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and
537024ee89b9Swdenkprint the header information, or to build new images.
5371c609719bSwdenk
5372c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information
5373c609719bSwdenkcontained in the header of an existing U-Boot image; this includes
5374c609719bSwdenkchecksum verification:
5375c609719bSwdenk
5376c609719bSwdenk	tools/mkimage -l image
5377c609719bSwdenk	  -l ==> list image header information
5378c609719bSwdenk
5379c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image
5380c609719bSwdenkfrom a "data file" which is used as image payload:
5381c609719bSwdenk
5382c609719bSwdenk	tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5383c609719bSwdenk		      -n name -d data_file image
5384c609719bSwdenk	  -A ==> set architecture to 'arch'
5385c609719bSwdenk	  -O ==> set operating system to 'os'
5386c609719bSwdenk	  -T ==> set image type to 'type'
5387c609719bSwdenk	  -C ==> set compression type 'comp'
5388c609719bSwdenk	  -a ==> set load address to 'addr' (hex)
5389c609719bSwdenk	  -e ==> set entry point to 'ep' (hex)
5390c609719bSwdenk	  -n ==> set image name to 'name'
5391c609719bSwdenk	  -d ==> use image data from 'datafile'
5392c609719bSwdenk
539369459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load
539469459791Swdenkaddress (0x00000000), but the entry point address depends on the
539569459791Swdenkkernel version:
5396c609719bSwdenk
5397c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C,
539824ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000.
5399c609719bSwdenk
5400c609719bSwdenkSo a typical call to build a U-Boot image would read:
5401c609719bSwdenk
540224ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
540324ee89b9Swdenk	> -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
5404a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
540524ee89b9Swdenk	> examples/uImage.TQM850L
540624ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5407c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5408c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
5409c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
5410c609719bSwdenk	Load Address: 0x00000000
541124ee89b9Swdenk	Entry Point:  0x00000000
5412c609719bSwdenk
5413c609719bSwdenkTo verify the contents of the image (or check for corruption):
5414c609719bSwdenk
541524ee89b9Swdenk	-> tools/mkimage -l examples/uImage.TQM850L
541624ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5417c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5418c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
5419c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
5420c609719bSwdenk	Load Address: 0x00000000
542124ee89b9Swdenk	Entry Point:  0x00000000
5422c609719bSwdenk
5423c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade
5424c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this
5425c609719bSwdenkneeds more space in Flash, but boots much faster since it does not
5426c609719bSwdenkneed to be uncompressed:
5427c609719bSwdenk
5428a47a12beSStefan Roese	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
542924ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
543024ee89b9Swdenk	> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
5431a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
543224ee89b9Swdenk	> examples/uImage.TQM850L-uncompressed
543324ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5434c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5435c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (uncompressed)
5436c609719bSwdenk	Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
5437c609719bSwdenk	Load Address: 0x00000000
543824ee89b9Swdenk	Entry Point:  0x00000000
5439c609719bSwdenk
5440c609719bSwdenk
5441c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file
5442c609719bSwdenkwhen your kernel is intended to use an initial ramdisk:
5443c609719bSwdenk
5444c609719bSwdenk	-> tools/mkimage -n 'Simple Ramdisk Image' \
5445c609719bSwdenk	> -A ppc -O linux -T ramdisk -C gzip \
5446c609719bSwdenk	> -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5447c609719bSwdenk	Image Name:   Simple Ramdisk Image
5448c609719bSwdenk	Created:      Wed Jan 12 14:01:50 2000
5449c609719bSwdenk	Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
5450c609719bSwdenk	Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
5451c609719bSwdenk	Load Address: 0x00000000
5452c609719bSwdenk	Entry Point:  0x00000000
5453c609719bSwdenk
5454a804b5ceSGuilherme Maciel FerreiraThe "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5455a804b5ceSGuilherme Maciel Ferreiraoption performs the converse operation of the mkimage's second form (the "-d"
5456a804b5ceSGuilherme Maciel Ferreiraoption). Given an image built by mkimage, the dumpimage extracts a "data file"
5457a804b5ceSGuilherme Maciel Ferreirafrom the image:
5458a804b5ceSGuilherme Maciel Ferreira
5459a804b5ceSGuilherme Maciel Ferreira	tools/dumpimage -i image -p position data_file
5460a804b5ceSGuilherme Maciel Ferreira	  -i ==> extract from the 'image' a specific 'data_file', \
5461a804b5ceSGuilherme Maciel Ferreira	   indexed by 'position'
5462a804b5ceSGuilherme Maciel Ferreira
5463c609719bSwdenk
5464c609719bSwdenkInstalling a Linux Image:
5465c609719bSwdenk-------------------------
5466c609719bSwdenk
5467c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface,
5468c609719bSwdenkyou must convert the image to S-Record format:
5469c609719bSwdenk
5470c609719bSwdenk	objcopy -I binary -O srec examples/image examples/image.srec
5471c609719bSwdenk
5472c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot
5473c609719bSwdenkimage header, so the resulting S-Record file will be relative to
5474c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to
5475c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads'
5476c609719bSwdenkcommand.
5477c609719bSwdenk
5478c609719bSwdenkExample: install the image to address 0x40100000 (which on the
5479c609719bSwdenkTQM8xxL is in the first Flash bank):
5480c609719bSwdenk
5481c609719bSwdenk	=> erase 40100000 401FFFFF
5482c609719bSwdenk
5483c609719bSwdenk	.......... done
5484c609719bSwdenk	Erased 8 sectors
5485c609719bSwdenk
5486c609719bSwdenk	=> loads 40100000
5487c609719bSwdenk	## Ready for S-Record download ...
5488c609719bSwdenk	~>examples/image.srec
5489c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5490c609719bSwdenk	...
5491c609719bSwdenk	15989 15990 15991 15992
5492c609719bSwdenk	[file transfer complete]
5493c609719bSwdenk	[connected]
5494c609719bSwdenk	## Start Addr = 0x00000000
5495c609719bSwdenk
5496c609719bSwdenk
5497c609719bSwdenkYou can check the success of the download using the 'iminfo' command;
5498c609719bSwdenkthis includes a checksum verification so you can be sure no data
5499c609719bSwdenkcorruption happened:
5500c609719bSwdenk
5501c609719bSwdenk	=> imi 40100000
5502c609719bSwdenk
5503c609719bSwdenk	## Checking Image at 40100000 ...
5504c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5505c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5506c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5507c609719bSwdenk	   Load Address: 00000000
5508c609719bSwdenk	   Entry Point:	 0000000c
5509c609719bSwdenk	   Verifying Checksum ... OK
5510c609719bSwdenk
5511c609719bSwdenk
5512c609719bSwdenkBoot Linux:
5513c609719bSwdenk-----------
5514c609719bSwdenk
5515c609719bSwdenkThe "bootm" command is used to boot an application that is stored in
5516c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents
5517c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as
5518c609719bSwdenkparameters. You can check and modify this variable using the
5519c609719bSwdenk"printenv" and "setenv" commands:
5520c609719bSwdenk
5521c609719bSwdenk
5522c609719bSwdenk	=> printenv bootargs
5523c609719bSwdenk	bootargs=root=/dev/ram
5524c609719bSwdenk
5525c609719bSwdenk	=> setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5526c609719bSwdenk
5527c609719bSwdenk	=> printenv bootargs
5528c609719bSwdenk	bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5529c609719bSwdenk
5530c609719bSwdenk	=> bootm 40020000
5531c609719bSwdenk	## Booting Linux kernel at 40020000 ...
5532c609719bSwdenk	   Image Name:	 2.2.13 for NFS on TQM850L
5533c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5534c609719bSwdenk	   Data Size:	 381681 Bytes = 372 kB = 0 MB
5535c609719bSwdenk	   Load Address: 00000000
5536c609719bSwdenk	   Entry Point:	 0000000c
5537c609719bSwdenk	   Verifying Checksum ... OK
5538c609719bSwdenk	   Uncompressing Kernel Image ... OK
5539c609719bSwdenk	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
5540c609719bSwdenk	Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5541c609719bSwdenk	time_init: decrementer frequency = 187500000/60
5542c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
5543c609719bSwdenk	Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5544c609719bSwdenk	...
5545c609719bSwdenk
554611ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass
55477152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT
5548c609719bSwdenkformat!) to the "bootm" command:
5549c609719bSwdenk
5550c609719bSwdenk	=> imi 40100000 40200000
5551c609719bSwdenk
5552c609719bSwdenk	## Checking Image at 40100000 ...
5553c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5554c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5555c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5556c609719bSwdenk	   Load Address: 00000000
5557c609719bSwdenk	   Entry Point:	 0000000c
5558c609719bSwdenk	   Verifying Checksum ... OK
5559c609719bSwdenk
5560c609719bSwdenk	## Checking Image at 40200000 ...
5561c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
5562c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
5563c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
5564c609719bSwdenk	   Load Address: 00000000
5565c609719bSwdenk	   Entry Point:	 00000000
5566c609719bSwdenk	   Verifying Checksum ... OK
5567c609719bSwdenk
5568c609719bSwdenk	=> bootm 40100000 40200000
5569c609719bSwdenk	## Booting Linux kernel at 40100000 ...
5570c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5571c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5572c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5573c609719bSwdenk	   Load Address: 00000000
5574c609719bSwdenk	   Entry Point:	 0000000c
5575c609719bSwdenk	   Verifying Checksum ... OK
5576c609719bSwdenk	   Uncompressing Kernel Image ... OK
5577c609719bSwdenk	## Loading RAMDisk Image at 40200000 ...
5578c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
5579c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
5580c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
5581c609719bSwdenk	   Load Address: 00000000
5582c609719bSwdenk	   Entry Point:	 00000000
5583c609719bSwdenk	   Verifying Checksum ... OK
5584c609719bSwdenk	   Loading Ramdisk ... OK
5585c609719bSwdenk	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
5586c609719bSwdenk	Boot arguments: root=/dev/ram
5587c609719bSwdenk	time_init: decrementer frequency = 187500000/60
5588c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
5589c609719bSwdenk	...
5590c609719bSwdenk	RAMDISK: Compressed image found at block 0
5591c609719bSwdenk	VFS: Mounted root (ext2 filesystem).
5592c609719bSwdenk
5593c609719bSwdenk	bash#
5594c609719bSwdenk
55950267768eSMatthew McClintockBoot Linux and pass a flat device tree:
55960267768eSMatthew McClintock-----------
55970267768eSMatthew McClintock
55980267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section
55990267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The
56000267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated
56010267768eSMatthew McClintockflat device tree:
56020267768eSMatthew McClintock
56030267768eSMatthew McClintock=> print oftaddr
56040267768eSMatthew McClintockoftaddr=0x300000
56050267768eSMatthew McClintock=> print oft
56060267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb
56070267768eSMatthew McClintock=> tftp $oftaddr $oft
56080267768eSMatthew McClintockSpeed: 1000, full duplex
56090267768eSMatthew McClintockUsing TSEC0 device
56100267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101
56110267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'.
56120267768eSMatthew McClintockLoad address: 0x300000
56130267768eSMatthew McClintockLoading: #
56140267768eSMatthew McClintockdone
56150267768eSMatthew McClintockBytes transferred = 4106 (100a hex)
56160267768eSMatthew McClintock=> tftp $loadaddr $bootfile
56170267768eSMatthew McClintockSpeed: 1000, full duplex
56180267768eSMatthew McClintockUsing TSEC0 device
56190267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2
56200267768eSMatthew McClintockFilename 'uImage'.
56210267768eSMatthew McClintockLoad address: 0x200000
56220267768eSMatthew McClintockLoading:############
56230267768eSMatthew McClintockdone
56240267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex)
56250267768eSMatthew McClintock=> print loadaddr
56260267768eSMatthew McClintockloadaddr=200000
56270267768eSMatthew McClintock=> print oftaddr
56280267768eSMatthew McClintockoftaddr=0x300000
56290267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr
56300267768eSMatthew McClintock## Booting image at 00200000 ...
56310267768eSMatthew McClintock   Image Name:	 Linux-2.6.17-dirty
56320267768eSMatthew McClintock   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
56330267768eSMatthew McClintock   Data Size:	 1029343 Bytes = 1005.2 kB
56340267768eSMatthew McClintock   Load Address: 00000000
56350267768eSMatthew McClintock   Entry Point:	 00000000
56360267768eSMatthew McClintock   Verifying Checksum ... OK
56370267768eSMatthew McClintock   Uncompressing Kernel Image ... OK
56380267768eSMatthew McClintockBooting using flat device tree at 0x300000
56390267768eSMatthew McClintockUsing MPC85xx ADS machine description
56400267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
56410267768eSMatthew McClintock[snip]
56420267768eSMatthew McClintock
56430267768eSMatthew McClintock
56446069ff26SwdenkMore About U-Boot Image Types:
56456069ff26Swdenk------------------------------
56466069ff26Swdenk
56476069ff26SwdenkU-Boot supports the following image types:
56486069ff26Swdenk
56496069ff26Swdenk   "Standalone Programs" are directly runnable in the environment
56506069ff26Swdenk	provided by U-Boot; it is expected that (if they behave
56516069ff26Swdenk	well) you can continue to work in U-Boot after return from
56526069ff26Swdenk	the Standalone Program.
56536069ff26Swdenk   "OS Kernel Images" are usually images of some Embedded OS which
56546069ff26Swdenk	will take over control completely. Usually these programs
56556069ff26Swdenk	will install their own set of exception handlers, device
56566069ff26Swdenk	drivers, set up the MMU, etc. - this means, that you cannot
56576069ff26Swdenk	expect to re-enter U-Boot except by resetting the CPU.
56586069ff26Swdenk   "RAMDisk Images" are more or less just data blocks, and their
56596069ff26Swdenk	parameters (address, size) are passed to an OS kernel that is
56606069ff26Swdenk	being started.
56616069ff26Swdenk   "Multi-File Images" contain several images, typically an OS
56626069ff26Swdenk	(Linux) kernel image and one or more data images like
56636069ff26Swdenk	RAMDisks. This construct is useful for instance when you want
56646069ff26Swdenk	to boot over the network using BOOTP etc., where the boot
56656069ff26Swdenk	server provides just a single image file, but you want to get
56666069ff26Swdenk	for instance an OS kernel and a RAMDisk image.
56676069ff26Swdenk
56686069ff26Swdenk	"Multi-File Images" start with a list of image sizes, each
56696069ff26Swdenk	image size (in bytes) specified by an "uint32_t" in network
56706069ff26Swdenk	byte order. This list is terminated by an "(uint32_t)0".
56716069ff26Swdenk	Immediately after the terminating 0 follow the images, one by
56726069ff26Swdenk	one, all aligned on "uint32_t" boundaries (size rounded up to
56736069ff26Swdenk	a multiple of 4 bytes).
56746069ff26Swdenk
56756069ff26Swdenk   "Firmware Images" are binary images containing firmware (like
56766069ff26Swdenk	U-Boot or FPGA images) which usually will be programmed to
56776069ff26Swdenk	flash memory.
56786069ff26Swdenk
56796069ff26Swdenk   "Script files" are command sequences that will be executed by
56806069ff26Swdenk	U-Boot's command interpreter; this feature is especially
56816069ff26Swdenk	useful when you configure U-Boot to use a real shell (hush)
56826069ff26Swdenk	as command interpreter.
56836069ff26Swdenk
568444f074c7SMarek VasutBooting the Linux zImage:
568544f074c7SMarek Vasut-------------------------
568644f074c7SMarek Vasut
568744f074c7SMarek VasutOn some platforms, it's possible to boot Linux zImage. This is done
568844f074c7SMarek Vasutusing the "bootz" command. The syntax of "bootz" command is the same
568944f074c7SMarek Vasutas the syntax of "bootm" command.
569044f074c7SMarek Vasut
56918ac28563STom RiniNote, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
5692017e1f3fSMarek Vasutkernel with raw initrd images. The syntax is slightly different, the
5693017e1f3fSMarek Vasutaddress of the initrd must be augmented by it's size, in the following
5694017e1f3fSMarek Vasutformat: "<initrd addres>:<initrd size>".
5695017e1f3fSMarek Vasut
5696c609719bSwdenk
5697c609719bSwdenkStandalone HOWTO:
5698c609719bSwdenk=================
5699c609719bSwdenk
5700c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and
5701c609719bSwdenkrun "standalone" applications, which can use some resources of
5702c609719bSwdenkU-Boot like console I/O functions or interrupt services.
5703c609719bSwdenk
5704c609719bSwdenkTwo simple examples are included with the sources:
5705c609719bSwdenk
5706c609719bSwdenk"Hello World" Demo:
5707c609719bSwdenk-------------------
5708c609719bSwdenk
5709c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo
5710c609719bSwdenkapplication; it is automatically compiled when you build U-Boot.
5711c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it
5712c609719bSwdenklike that:
5713c609719bSwdenk
5714c609719bSwdenk	=> loads
5715c609719bSwdenk	## Ready for S-Record download ...
5716c609719bSwdenk	~>examples/hello_world.srec
5717c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
5718c609719bSwdenk	[file transfer complete]
5719c609719bSwdenk	[connected]
5720c609719bSwdenk	## Start Addr = 0x00040004
5721c609719bSwdenk
5722c609719bSwdenk	=> go 40004 Hello World! This is a test.
5723c609719bSwdenk	## Starting application at 0x00040004 ...
5724c609719bSwdenk	Hello World
5725c609719bSwdenk	argc = 7
5726c609719bSwdenk	argv[0] = "40004"
5727c609719bSwdenk	argv[1] = "Hello"
5728c609719bSwdenk	argv[2] = "World!"
5729c609719bSwdenk	argv[3] = "This"
5730c609719bSwdenk	argv[4] = "is"
5731c609719bSwdenk	argv[5] = "a"
5732c609719bSwdenk	argv[6] = "test."
5733c609719bSwdenk	argv[7] = "<NULL>"
5734c609719bSwdenk	Hit any key to exit ...
5735c609719bSwdenk
5736c609719bSwdenk	## Application terminated, rc = 0x0
5737c609719bSwdenk
5738c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt
5739c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'.
5740c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second.
5741c609719bSwdenkThe interrupt service routine is trivial, just printing a '.'
5742c609719bSwdenkcharacter, but this is just a demo program. The application can be
5743c609719bSwdenkcontrolled by the following keys:
5744c609719bSwdenk
5745c609719bSwdenk	? - print current values og the CPM Timer registers
5746c609719bSwdenk	b - enable interrupts and start timer
5747c609719bSwdenk	e - stop timer and disable interrupts
5748c609719bSwdenk	q - quit application
5749c609719bSwdenk
5750c609719bSwdenk	=> loads
5751c609719bSwdenk	## Ready for S-Record download ...
5752c609719bSwdenk	~>examples/timer.srec
5753c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
5754c609719bSwdenk	[file transfer complete]
5755c609719bSwdenk	[connected]
5756c609719bSwdenk	## Start Addr = 0x00040004
5757c609719bSwdenk
5758c609719bSwdenk	=> go 40004
5759c609719bSwdenk	## Starting application at 0x00040004 ...
5760c609719bSwdenk	TIMERS=0xfff00980
5761c609719bSwdenk	Using timer 1
5762c609719bSwdenk	  tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
5763c609719bSwdenk
5764c609719bSwdenkHit 'b':
5765c609719bSwdenk	[q, b, e, ?] Set interval 1000000 us
5766c609719bSwdenk	Enabling timer
5767c609719bSwdenkHit '?':
5768c609719bSwdenk	[q, b, e, ?] ........
5769c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
5770c609719bSwdenkHit '?':
5771c609719bSwdenk	[q, b, e, ?] .
5772c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
5773c609719bSwdenkHit '?':
5774c609719bSwdenk	[q, b, e, ?] .
5775c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
5776c609719bSwdenkHit '?':
5777c609719bSwdenk	[q, b, e, ?] .
5778c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
5779c609719bSwdenkHit 'e':
5780c609719bSwdenk	[q, b, e, ?] ...Stopping timer
5781c609719bSwdenkHit 'q':
5782c609719bSwdenk	[q, b, e, ?] ## Application terminated, rc = 0x0
5783c609719bSwdenk
5784c609719bSwdenk
578585ec0bccSwdenkMinicom warning:
578685ec0bccSwdenk================
578785ec0bccSwdenk
57887152b1d0SwdenkOver time, many people have reported problems when trying to use the
578985ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd)
579085ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under
5791f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and
579285ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and
5793e53515a2SKarl O. Pincuse "cu" for S-Record download ("loads" command).  See
5794e53515a2SKarl O. Pinchttp://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
5795e53515a2SKarl O. Pincfor help with kermit.
5796e53515a2SKarl O. Pinc
579785ec0bccSwdenk
579852f52c14SwdenkNevertheless, if you absolutely want to use it try adding this
579952f52c14Swdenkconfiguration to your "File transfer protocols" section:
580052f52c14Swdenk
580152f52c14Swdenk	   Name	   Program			Name U/D FullScr IO-Red. Multi
580252f52c14Swdenk	X  kermit  /usr/bin/kermit -i -l %l -s	 Y    U	   Y	   N	  N
580352f52c14Swdenk	Y  kermit  /usr/bin/kermit -i -l %l -r	 N    D	   Y	   N	  N
580452f52c14Swdenk
580552f52c14Swdenk
5806c609719bSwdenkNetBSD Notes:
5807c609719bSwdenk=============
5808c609719bSwdenk
5809c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host
5810c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx).
5811c609719bSwdenk
5812c609719bSwdenkBuilding requires a cross environment; it is known to work on
5813c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5814c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make).
5815c609719bSwdenkNote that the cross-powerpc package does not install include files;
5816c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is
5817c609719bSwdenkmissing.  This file has to be installed and patched manually:
5818c609719bSwdenk
5819c609719bSwdenk	# cd /usr/pkg/cross/powerpc-netbsd/include
5820c609719bSwdenk	# mkdir powerpc
5821c609719bSwdenk	# ln -s powerpc machine
5822c609719bSwdenk	# cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
5823c609719bSwdenk	# ${EDIT} powerpc/ansi.h	## must remove __va_list, _BSD_VA_LIST
5824c609719bSwdenk
5825c609719bSwdenkNative builds *don't* work due to incompatibilities between native
5826c609719bSwdenkand U-Boot include files.
5827c609719bSwdenk
5828c609719bSwdenkBooting assumes that (the first part of) the image booted is a
5829c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel
5830c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source
5831c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
58322a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
5833c609719bSwdenk
5834c609719bSwdenk
5835c609719bSwdenkImplementation Internals:
5836c609719bSwdenk=========================
5837c609719bSwdenk
5838c609719bSwdenkThe following is not intended to be a complete description of every
5839c609719bSwdenkimplementation detail. However, it should help to understand the
5840c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom
5841c609719bSwdenkhardware.
5842c609719bSwdenk
5843c609719bSwdenk
5844c609719bSwdenkInitial Stack, Global Data:
5845c609719bSwdenk---------------------------
5846c609719bSwdenk
5847c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot
5848c609719bSwdenkstarts running out of ROM (flash memory), usually without access to
5849c609719bSwdenksystem RAM (because the memory controller is not initialized yet).
5850c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS
5851c609719bSwdenkis not initialized as zero. To be able to get a C environment working
5852c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation
5853c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU
5854c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and
5855c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be
5856c609719bSwdenklocked as (mis-) used as memory, etc.
5857c609719bSwdenk
58587152b1d0Swdenk	Chris Hallinan posted a good summary of these issues to the
58590668236bSWolfgang Denk	U-Boot mailing list:
586043d9616cSwdenk
586143d9616cSwdenk	Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
586243d9616cSwdenk	From: "Chris Hallinan" <clh@net1plus.com>
586343d9616cSwdenk	Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
586443d9616cSwdenk	...
586543d9616cSwdenk
586643d9616cSwdenk	Correct me if I'm wrong, folks, but the way I understand it
586743d9616cSwdenk	is this: Using DCACHE as initial RAM for Stack, etc, does not
586843d9616cSwdenk	require any physical RAM backing up the cache. The cleverness
586943d9616cSwdenk	is that the cache is being used as a temporary supply of
587043d9616cSwdenk	necessary storage before the SDRAM controller is setup. It's
587111ccc33fSMarcel Ziswiler	beyond the scope of this list to explain the details, but you
587243d9616cSwdenk	can see how this works by studying the cache architecture and
587343d9616cSwdenk	operation in the architecture and processor-specific manuals.
587443d9616cSwdenk
587543d9616cSwdenk	OCM is On Chip Memory, which I believe the 405GP has 4K. It
587643d9616cSwdenk	is another option for the system designer to use as an
587711ccc33fSMarcel Ziswiler	initial stack/RAM area prior to SDRAM being available. Either
587843d9616cSwdenk	option should work for you. Using CS 4 should be fine if your
587943d9616cSwdenk	board designers haven't used it for something that would
588043d9616cSwdenk	cause you grief during the initial boot! It is frequently not
588143d9616cSwdenk	used.
588243d9616cSwdenk
58836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
588443d9616cSwdenk	with your processor/board/system design. The default value
588543d9616cSwdenk	you will find in any recent u-boot distribution in
58868a316c9bSStefan Roese	walnut.h should work for you. I'd set it to a value larger
588743d9616cSwdenk	than your SDRAM module. If you have a 64MB SDRAM module, set
588843d9616cSwdenk	it above 400_0000. Just make sure your board has no resources
588943d9616cSwdenk	that are supposed to respond to that address! That code in
589043d9616cSwdenk	start.S has been around a while and should work as is when
589143d9616cSwdenk	you get the config right.
589243d9616cSwdenk
589343d9616cSwdenk	-Chris Hallinan
589443d9616cSwdenk	DS4.COM, Inc.
589543d9616cSwdenk
5896c609719bSwdenkIt is essential to remember this, since it has some impact on the C
5897c609719bSwdenkcode for the initialization procedures:
5898c609719bSwdenk
5899c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt
5900c609719bSwdenk  to write it.
5901c609719bSwdenk
590211ccc33fSMarcel Ziswiler* Do not use any uninitialized global data (or implicitely initialized
5903c609719bSwdenk  as zero data - BSS segment) at all - this is undefined, initiali-
59047152b1d0Swdenk  zation is performed later (when relocating to RAM).
5905c609719bSwdenk
5906c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like
5907c609719bSwdenk  that.
5908c609719bSwdenk
5909c609719bSwdenkHaving only the stack as writable memory limits means we cannot use
5910c609719bSwdenknormal global data to share information beween the code. But it
5911c609719bSwdenkturned out that the implementation of U-Boot can be greatly
5912c609719bSwdenksimplified by making a global data structure (gd_t) available to all
5913c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_
5914c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of
5915c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we
5916c609719bSwdenkplace a pointer (gd) to the global data into a register which we
5917c609719bSwdenkreserve for this purpose.
5918c609719bSwdenk
59197152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the
5920c609719bSwdenkrelevant  (E)ABI  specifications for the current architecture, and by
5921c609719bSwdenkGCC's implementation.
5922c609719bSwdenk
5923c609719bSwdenkFor PowerPC, the following registers have specific use:
5924c609719bSwdenk	R1:	stack pointer
5925e7670f6cSWolfgang Denk	R2:	reserved for system use
5926c609719bSwdenk	R3-R4:	parameter passing and return values
5927c609719bSwdenk	R5-R10: parameter passing
5928c609719bSwdenk	R13:	small data area pointer
5929c609719bSwdenk	R30:	GOT pointer
5930c609719bSwdenk	R31:	frame pointer
5931c609719bSwdenk
5932e6bee808SJoakim Tjernlund	(U-Boot also uses R12 as internal GOT pointer. r12
5933e6bee808SJoakim Tjernlund	is a volatile register so r12 needs to be reset when
5934e6bee808SJoakim Tjernlund	going back and forth between asm and C)
5935c609719bSwdenk
5936e7670f6cSWolfgang Denk    ==> U-Boot will use R2 to hold a pointer to the global data
5937c609719bSwdenk
5938c609719bSwdenk    Note: on PPC, we could use a static initializer (since the
5939c609719bSwdenk    address of the global data structure is known at compile time),
5940c609719bSwdenk    but it turned out that reserving a register results in somewhat
5941c609719bSwdenk    smaller code - although the code savings are not that big (on
5942c609719bSwdenk    average for all boards 752 bytes for the whole U-Boot image,
5943c609719bSwdenk    624 text + 127 data).
5944c609719bSwdenk
5945c4db335cSRobin GetzOn Blackfin, the normal C ABI (except for P3) is followed as documented here:
59464c58eb55SMike Frysinger	http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
59474c58eb55SMike Frysinger
5948c4db335cSRobin Getz    ==> U-Boot will use P3 to hold a pointer to the global data
59494c58eb55SMike Frysinger
5950c609719bSwdenkOn ARM, the following registers are used:
5951c609719bSwdenk
5952c609719bSwdenk	R0:	function argument word/integer result
5953c609719bSwdenk	R1-R3:	function argument word
595412eba1b4SJeroen Hofstee	R9:	platform specific
595512eba1b4SJeroen Hofstee	R10:	stack limit (used only if stack checking is enabled)
5956c609719bSwdenk	R11:	argument (frame) pointer
5957c609719bSwdenk	R12:	temporary workspace
5958c609719bSwdenk	R13:	stack pointer
5959c609719bSwdenk	R14:	link register
5960c609719bSwdenk	R15:	program counter
5961c609719bSwdenk
596212eba1b4SJeroen Hofstee    ==> U-Boot will use R9 to hold a pointer to the global data
596312eba1b4SJeroen Hofstee
596412eba1b4SJeroen Hofstee    Note: on ARM, only R_ARM_RELATIVE relocations are supported.
5965c609719bSwdenk
59660df01fd3SThomas ChouOn Nios II, the ABI is documented here:
59670df01fd3SThomas Chou	http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
59680df01fd3SThomas Chou
59690df01fd3SThomas Chou    ==> U-Boot will use gp to hold a pointer to the global data
59700df01fd3SThomas Chou
59710df01fd3SThomas Chou    Note: on Nios II, we give "-G0" option to gcc and don't use gp
59720df01fd3SThomas Chou    to access small data sections, so gp is free.
59730df01fd3SThomas Chou
5974afc1ce82SMacpaul LinOn NDS32, the following registers are used:
5975afc1ce82SMacpaul Lin
5976afc1ce82SMacpaul Lin	R0-R1:	argument/return
5977afc1ce82SMacpaul Lin	R2-R5:	argument
5978afc1ce82SMacpaul Lin	R15:	temporary register for assembler
5979afc1ce82SMacpaul Lin	R16:	trampoline register
5980afc1ce82SMacpaul Lin	R28:	frame pointer (FP)
5981afc1ce82SMacpaul Lin	R29:	global pointer (GP)
5982afc1ce82SMacpaul Lin	R30:	link register (LP)
5983afc1ce82SMacpaul Lin	R31:	stack pointer (SP)
5984afc1ce82SMacpaul Lin	PC:	program counter (PC)
5985afc1ce82SMacpaul Lin
5986afc1ce82SMacpaul Lin    ==> U-Boot will use R10 to hold a pointer to the global data
5987afc1ce82SMacpaul Lin
5988d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5989d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much.
5990c609719bSwdenk
5991c609719bSwdenkMemory Management:
5992c609719bSwdenk------------------
5993c609719bSwdenk
5994c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the
5995c609719bSwdenkMMU is not used either for address mapping nor for memory protection.
5996c609719bSwdenk
5997c609719bSwdenkThe available memory is mapped to fixed addresses using the memory
5998c609719bSwdenkcontroller. In this process, a contiguous block is formed for each
5999c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several
6000c609719bSwdenkphysical memory banks.
6001c609719bSwdenk
6002c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on
6003c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
6004c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself
6005c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some
60066d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
6007c609719bSwdenkconfiguration setting]. Below that, a structure with global Board
6008c609719bSwdenkInfo data is placed, followed by the stack (growing downward).
6009c609719bSwdenk
6010c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB
6011c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF).
6012c609719bSwdenk
6013c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like
6014c609719bSwdenkthis:
6015c609719bSwdenk
6016c609719bSwdenk	0x0000 0000	Exception Vector code
6017c609719bSwdenk	      :
6018c609719bSwdenk	0x0000 1FFF
6019c609719bSwdenk	0x0000 2000	Free for Application Use
6020c609719bSwdenk	      :
6021c609719bSwdenk	      :
6022c609719bSwdenk
6023c609719bSwdenk	      :
6024c609719bSwdenk	      :
6025c609719bSwdenk	0x00FB FF20	Monitor Stack (Growing downward)
6026c609719bSwdenk	0x00FB FFAC	Board Info Data and permanent copy of global data
6027c609719bSwdenk	0x00FC 0000	Malloc Arena
6028c609719bSwdenk	      :
6029c609719bSwdenk	0x00FD FFFF
6030c609719bSwdenk	0x00FE 0000	RAM Copy of Monitor Code
6031c609719bSwdenk	...		eventually: LCD or video framebuffer
6032c609719bSwdenk	...		eventually: pRAM (Protected RAM - unchanged by reset)
6033c609719bSwdenk	0x00FF FFFF	[End of RAM]
6034c609719bSwdenk
6035c609719bSwdenk
6036c609719bSwdenkSystem Initialization:
6037c609719bSwdenk----------------------
6038c609719bSwdenk
6039c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point
604011ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset
6041c609719bSwdenkconfiguration for CS0# this is a mirror of the onboard Flash memory.
60427152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address.
6043c609719bSwdenkTo be able to implement the initialization code in C, a (small!)
6044c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs
6045c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked
6046c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core,
6047c609719bSwdenkthe caches and the SIU.
6048c609719bSwdenk
6049c609719bSwdenkNext, all (potentially) available memory banks are mapped using a
6050c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries
6051c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
6052c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
6053c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a
6054c609719bSwdenksimple memory test is run that determines the size of the SDRAM
6055c609719bSwdenkbanks.
6056c609719bSwdenk
6057c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of
60587152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first
6059c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address
6060c609719bSwdenk0x00000000, with any additional banks following immediately to create
6061c609719bSwdenkcontiguous memory starting from 0.
6062c609719bSwdenk
6063c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area
6064c609719bSwdenkand allocates memory for use by malloc() and for the global Board
6065c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM
6066c609719bSwdenkpages, and the final stack is set up.
6067c609719bSwdenk
6068c609719bSwdenkOnly after this relocation will you have a "normal" C environment;
6069c609719bSwdenkuntil that you are restricted in several ways, mostly because you are
6070c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a
6071c609719bSwdenknew address in RAM.
6072c609719bSwdenk
6073c609719bSwdenk
6074c609719bSwdenkU-Boot Porting Guide:
6075c609719bSwdenk----------------------
6076c609719bSwdenk
6077c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
60786aff3115Swdenklist, October 2002]
6079c609719bSwdenk
6080c609719bSwdenk
6081c609719bSwdenkint main(int argc, char *argv[])
6082c609719bSwdenk{
6083c609719bSwdenk	sighandler_t no_more_time;
6084c609719bSwdenk
6085c609719bSwdenk	signal(SIGALRM, no_more_time);
6086c609719bSwdenk	alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
6087c609719bSwdenk
6088c609719bSwdenk	if (available_money > available_manpower) {
60896c3fef28SJerry Van Baren		Pay consultant to port U-Boot;
6090c609719bSwdenk		return 0;
6091c609719bSwdenk	}
6092c609719bSwdenk
6093c609719bSwdenk	Download latest U-Boot source;
6094c609719bSwdenk
60950668236bSWolfgang Denk	Subscribe to u-boot mailing list;
60966aff3115Swdenk
60976c3fef28SJerry Van Baren	if (clueless)
6098c609719bSwdenk		email("Hi, I am new to U-Boot, how do I get started?");
6099c609719bSwdenk
6100c609719bSwdenk	while (learning) {
6101c609719bSwdenk		Read the README file in the top level directory;
61027cb22f97Swdenk		Read http://www.denx.de/twiki/bin/view/DULG/Manual;
61036c3fef28SJerry Van Baren		Read applicable doc/*.README;
6104c609719bSwdenk		Read the source, Luke;
61056c3fef28SJerry Van Baren		/* find . -name "*.[chS]" | xargs grep -i <keyword> */
6106c609719bSwdenk	}
6107c609719bSwdenk
61086c3fef28SJerry Van Baren	if (available_money > toLocalCurrency ($2500))
61096c3fef28SJerry Van Baren		Buy a BDI3000;
61106c3fef28SJerry Van Baren	else
6111c609719bSwdenk		Add a lot of aggravation and time;
6112c609719bSwdenk
61136c3fef28SJerry Van Baren	if (a similar board exists) {	/* hopefully... */
61146c3fef28SJerry Van Baren		cp -a board/<similar> board/<myboard>
61156c3fef28SJerry Van Baren		cp include/configs/<similar>.h include/configs/<myboard>.h
61166c3fef28SJerry Van Baren	} else {
6117c609719bSwdenk		Create your own board support subdirectory;
61186c3fef28SJerry Van Baren		Create your own board include/configs/<myboard>.h file;
61196c3fef28SJerry Van Baren	}
61206c3fef28SJerry Van Baren	Edit new board/<myboard> files
61216c3fef28SJerry Van Baren	Edit new include/configs/<myboard>.h
6122c609719bSwdenk
61236c3fef28SJerry Van Baren	while (!accepted) {
6124c609719bSwdenk		while (!running) {
6125c609719bSwdenk			do {
6126c609719bSwdenk				Add / modify source code;
6127c609719bSwdenk			} until (compiles);
6128c609719bSwdenk			Debug;
6129c609719bSwdenk			if (clueless)
6130c609719bSwdenk				email("Hi, I am having problems...");
6131c609719bSwdenk		}
61326c3fef28SJerry Van Baren		Send patch file to the U-Boot email list;
61336c3fef28SJerry Van Baren		if (reasonable critiques)
61346c3fef28SJerry Van Baren			Incorporate improvements from email list code review;
61356c3fef28SJerry Van Baren		else
61366c3fef28SJerry Van Baren			Defend code as written;
61376c3fef28SJerry Van Baren	}
6138c609719bSwdenk
6139c609719bSwdenk	return 0;
6140c609719bSwdenk}
6141c609719bSwdenk
6142c609719bSwdenkvoid no_more_time (int sig)
6143c609719bSwdenk{
6144c609719bSwdenk      hire_a_guru();
6145c609719bSwdenk}
6146c609719bSwdenk
6147c609719bSwdenk
6148c609719bSwdenkCoding Standards:
6149c609719bSwdenk-----------------
6150c609719bSwdenk
6151c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel
61522c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script
61537ca9296eSWolfgang Denk"scripts/Lindent" in your Linux kernel source directory.
6154c609719bSwdenk
61552c051651SDetlev ZundelSource files originating from a different project (for example the
61562c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not
61572c051651SDetlev Zundelreformated to ease subsequent migration to newer versions of those
61582c051651SDetlev Zundelsources.
61592c051651SDetlev Zundel
61602c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in
61612c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//)
61622c051651SDetlev Zundelin your code.
6163c609719bSwdenk
6164c178d3daSwdenkPlease also stick to the following formatting rules:
6165180d3f74Swdenk- remove any trailing white space
61667ca9296eSWolfgang Denk- use TAB characters for indentation and vertical alignment, not spaces
6167180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds
61687ca9296eSWolfgang Denk- do not add more than 2 consecutive empty lines to source files
6169180d3f74Swdenk- do not add trailing empty lines to source files
6170180d3f74Swdenk
6171c609719bSwdenkSubmissions which do not conform to the standards may be returned
6172c609719bSwdenkwith a request to reformat the changes.
6173c609719bSwdenk
6174c609719bSwdenk
6175c609719bSwdenkSubmitting Patches:
6176c609719bSwdenk-------------------
6177c609719bSwdenk
6178c609719bSwdenkSince the number of patches for U-Boot is growing, we need to
6179c609719bSwdenkestablish some rules. Submissions which do not conform to these rules
6180c609719bSwdenkmay be rejected, even when they contain important and valuable stuff.
6181c609719bSwdenk
61820d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details.
6183218ca724SWolfgang Denk
61840668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
61850668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot
61860668236bSWolfgang Denk
6187c609719bSwdenkWhen you send a patch, please include the following information with
6188c609719bSwdenkit:
6189c609719bSwdenk
6190c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes
6191c609719bSwdenk  this bug. Please try to include a way of demonstrating that the
6192c609719bSwdenk  patch actually fixes something.
6193c609719bSwdenk
6194c609719bSwdenk* For new features: a description of the feature and your
6195c609719bSwdenk  implementation.
6196c609719bSwdenk
6197c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch)
6198c609719bSwdenk
6199c609719bSwdenk* For major contributions, your entry to the CREDITS file
6200c609719bSwdenk
620127af930eSAlbert ARIBAUD* When you add support for a new board, don't forget to add a
620227af930eSAlbert ARIBAUD  maintainer e-mail address to the boards.cfg file, too.
6203c609719bSwdenk
6204c609719bSwdenk* If your patch adds new configuration options, don't forget to
6205c609719bSwdenk  document these in the README file.
6206c609719bSwdenk
6207218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly*
6208218ca724SWolfgang Denk  recommended) you can easily generate the patch using the
62097ca9296eSWolfgang Denk  "git format-patch". If you then use "git send-email" to send it to
6210218ca724SWolfgang Denk  the U-Boot mailing list, you will avoid most of the common problems
6211218ca724SWolfgang Denk  with some other mail clients.
6212c609719bSwdenk
6213218ca724SWolfgang Denk  If you cannot use git, use "diff -purN OLD NEW". If your version of
6214218ca724SWolfgang Denk  diff does not support these options, then get the latest version of
6215218ca724SWolfgang Denk  GNU diff.
62166dff5529Swdenk
6217218ca724SWolfgang Denk  The current directory when running this command shall be the parent
6218218ca724SWolfgang Denk  directory of the U-Boot source tree (i. e. please make sure that
6219218ca724SWolfgang Denk  your patch includes sufficient directory information for the
6220218ca724SWolfgang Denk  affected files).
6221218ca724SWolfgang Denk
6222218ca724SWolfgang Denk  We prefer patches as plain text. MIME attachments are discouraged,
6223218ca724SWolfgang Denk  and compressed attachments must not be used.
6224c609719bSwdenk
622552f52c14Swdenk* If one logical set of modifications affects or creates several
622652f52c14Swdenk  files, all these changes shall be submitted in a SINGLE patch file.
622752f52c14Swdenk
622852f52c14Swdenk* Changesets that contain different, unrelated modifications shall be
622952f52c14Swdenk  submitted as SEPARATE patches, one patch per changeset.
623052f52c14Swdenk
623152f52c14Swdenk
6232c609719bSwdenkNotes:
6233c609719bSwdenk
6234c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched
6235c609719bSwdenk  source tree and make sure that no errors or warnings are reported
6236c609719bSwdenk  for any of the boards.
6237c609719bSwdenk
6238c609719bSwdenk* Keep your modifications to the necessary minimum: A patch
6239c609719bSwdenk  containing several unrelated changes or arbitrary reformats will be
6240c609719bSwdenk  returned with a request to re-formatting / split it.
6241c609719bSwdenk
6242c609719bSwdenk* If you modify existing code, make sure that your new code does not
6243c609719bSwdenk  add to the memory footprint of the code ;-) Small is beautiful!
6244c609719bSwdenk  When adding new features, these should compile conditionally only
6245c609719bSwdenk  (using #ifdef), and the resulting code with the new feature
6246c609719bSwdenk  disabled must not need more memory than the old code without your
6247c609719bSwdenk  modification.
624890dc6704Swdenk
62490668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the
62500668236bSWolfgang Denk  u-boot mailing list. Bigger patches will be moderated. If they are
62510668236bSWolfgang Denk  reasonable and not too big, they will be acknowledged. But patches
62520668236bSWolfgang Denk  bigger than the size limit should be avoided.
6253