xref: /openbmc/u-boot/README (revision 0bdffe71fddeaa46768a39305797e4512dee0f15)
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
1358d321b81SPeter Tyser  /arm			Files generic to ARM architecture
1368d321b81SPeter Tyser    /cpu		CPU specific files
1378d321b81SPeter Tyser      /arm720t		Files specific to ARM 720 CPUs
1388d321b81SPeter Tyser      /arm920t		Files specific to ARM 920 CPUs
1396eb0921aSAndreas Bießmann	/at91		Files specific to Atmel AT91RM9200 CPU
1408d321b81SPeter Tyser	/imx		Files specific to Freescale MC9328 i.MX CPUs
1418d321b81SPeter Tyser	/s3c24x0	Files specific to Samsung S3C24X0 CPUs
1428d321b81SPeter Tyser      /arm926ejs	Files specific to ARM 926 CPUs
1438d321b81SPeter Tyser      /arm1136		Files specific to ARM 1136 CPUs
1448d321b81SPeter Tyser      /ixp		Files specific to Intel XScale IXP CPUs
1458d321b81SPeter Tyser      /pxa		Files specific to Intel XScale PXA CPUs
1468d321b81SPeter Tyser      /sa1100		Files specific to Intel StrongARM SA1100 CPUs
1478d321b81SPeter Tyser    /lib		Architecture specific library files
1488d321b81SPeter Tyser  /avr32		Files generic to AVR32 architecture
1498d321b81SPeter Tyser    /cpu		CPU specific files
1508d321b81SPeter Tyser    /lib		Architecture specific library files
1518d321b81SPeter Tyser  /blackfin		Files generic to Analog Devices Blackfin architecture
1528d321b81SPeter Tyser    /cpu		CPU specific files
1538d321b81SPeter Tyser    /lib		Architecture specific library files
1548d321b81SPeter Tyser  /m68k			Files generic to m68k architecture
1558d321b81SPeter Tyser    /cpu		CPU specific files
1568d321b81SPeter Tyser      /mcf52x2		Files specific to Freescale ColdFire MCF52x2 CPUs
1578d321b81SPeter Tyser      /mcf5227x		Files specific to Freescale ColdFire MCF5227x CPUs
1588d321b81SPeter Tyser      /mcf532x		Files specific to Freescale ColdFire MCF5329 CPUs
1598d321b81SPeter Tyser      /mcf5445x		Files specific to Freescale ColdFire MCF5445x CPUs
1608d321b81SPeter Tyser      /mcf547x_8x	Files specific to Freescale ColdFire MCF547x_8x CPUs
1618d321b81SPeter Tyser    /lib		Architecture specific library files
1628d321b81SPeter Tyser  /microblaze		Files generic to microblaze architecture
1638d321b81SPeter Tyser    /cpu		CPU specific files
1648d321b81SPeter Tyser    /lib		Architecture specific library files
1658d321b81SPeter Tyser  /mips			Files generic to MIPS architecture
1668d321b81SPeter Tyser    /cpu		CPU specific files
16792bbd64eSDaniel Schwierzeck      /mips32		Files specific to MIPS32 CPUs
16880421fccSXiangfu Liu      /xburst		Files specific to Ingenic XBurst CPUs
1698d321b81SPeter Tyser    /lib		Architecture specific library files
170afc1ce82SMacpaul Lin  /nds32		Files generic to NDS32 architecture
171afc1ce82SMacpaul Lin    /cpu		CPU specific files
172afc1ce82SMacpaul Lin      /n1213		Files specific to Andes Technology N1213 CPUs
173afc1ce82SMacpaul Lin    /lib		Architecture specific library files
1748d321b81SPeter Tyser  /nios2		Files generic to Altera NIOS2 architecture
1758d321b81SPeter Tyser    /cpu		CPU specific files
1768d321b81SPeter Tyser    /lib		Architecture specific library files
17733c7731bSRobert P. J. Day  /openrisc		Files generic to OpenRISC architecture
17833c7731bSRobert P. J. Day    /cpu		CPU specific files
17933c7731bSRobert P. J. Day    /lib		Architecture specific library files
180a47a12beSStefan Roese  /powerpc		Files generic to PowerPC architecture
1818d321b81SPeter Tyser    /cpu		CPU specific files
1828d321b81SPeter Tyser      /74xx_7xx		Files specific to Freescale MPC74xx and 7xx CPUs
1838d321b81SPeter Tyser      /mpc5xx		Files specific to Freescale MPC5xx CPUs
1848d321b81SPeter Tyser      /mpc5xxx		Files specific to Freescale MPC5xxx CPUs
1858d321b81SPeter Tyser      /mpc8xx		Files specific to Freescale MPC8xx CPUs
1868d321b81SPeter Tyser      /mpc824x		Files specific to Freescale MPC824x CPUs
1878d321b81SPeter Tyser      /mpc8260		Files specific to Freescale MPC8260 CPUs
1888d321b81SPeter Tyser      /mpc85xx		Files specific to Freescale MPC85xx CPUs
1898d321b81SPeter Tyser      /ppc4xx		Files specific to AMCC PowerPC 4xx CPUs
1908d321b81SPeter Tyser    /lib		Architecture specific library files
1918d321b81SPeter Tyser  /sh			Files generic to SH architecture
1928d321b81SPeter Tyser    /cpu		CPU specific files
1938d321b81SPeter Tyser      /sh2		Files specific to sh2 CPUs
1948d321b81SPeter Tyser      /sh3		Files specific to sh3 CPUs
1958d321b81SPeter Tyser      /sh4		Files specific to sh4 CPUs
1968d321b81SPeter Tyser    /lib		Architecture specific library files
1978d321b81SPeter Tyser  /sparc		Files generic to SPARC architecture
1988d321b81SPeter Tyser    /cpu		CPU specific files
1998d321b81SPeter Tyser      /leon2		Files specific to Gaisler LEON2 SPARC CPU
2008d321b81SPeter Tyser      /leon3		Files specific to Gaisler LEON3 SPARC CPU
2018d321b81SPeter Tyser    /lib		Architecture specific library files
20233c7731bSRobert P. J. Day  /x86			Files generic to x86 architecture
20333c7731bSRobert P. J. Day    /cpu		CPU specific files
20433c7731bSRobert P. J. Day    /lib		Architecture specific library files
2058d321b81SPeter Tyser/api			Machine/arch independent API for external apps
2068d321b81SPeter Tyser/board			Board dependent files
2078d321b81SPeter Tyser/common			Misc architecture independent functions
2088d321b81SPeter Tyser/disk			Code for disk drive partition handling
2098d321b81SPeter Tyser/doc			Documentation (don't expect too much)
2108d321b81SPeter Tyser/drivers		Commonly used device drivers
21133c7731bSRobert P. J. Day/dts			Contains Makefile for building internal U-Boot fdt.
2128d321b81SPeter Tyser/examples		Example code for standalone applications, etc.
2138d321b81SPeter Tyser/fs			Filesystem code (cramfs, ext2, jffs2, etc.)
2148d321b81SPeter Tyser/include		Header Files
2158d321b81SPeter Tyser/lib			Files generic to all architectures
2168d321b81SPeter Tyser  /libfdt		Library files to support flattened device trees
2178d321b81SPeter Tyser  /lzma			Library files to support LZMA decompression
2188d321b81SPeter Tyser  /lzo			Library files to support LZO decompression
2198d321b81SPeter Tyser/net			Networking code
2208d321b81SPeter Tyser/post			Power On Self Test
22133c7731bSRobert P. J. Day/spl			Secondary Program Loader framework
2228d321b81SPeter Tyser/tools			Tools to build S-Record or U-Boot images, etc.
223c609719bSwdenk
224c609719bSwdenkSoftware Configuration:
225c609719bSwdenk=======================
226c609719bSwdenk
227c609719bSwdenkConfiguration is usually done using C preprocessor defines; the
228c609719bSwdenkrationale behind that is to avoid dead code whenever possible.
229c609719bSwdenk
230c609719bSwdenkThere are two classes of configuration variables:
231c609719bSwdenk
232c609719bSwdenk* Configuration _OPTIONS_:
233c609719bSwdenk  These are selectable by the user and have names beginning with
234c609719bSwdenk  "CONFIG_".
235c609719bSwdenk
236c609719bSwdenk* Configuration _SETTINGS_:
237c609719bSwdenk  These depend on the hardware etc. and should not be meddled with if
238c609719bSwdenk  you don't know what you're doing; they have names beginning with
2396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  "CONFIG_SYS_".
240c609719bSwdenk
241c609719bSwdenkLater we will add a configuration tool - probably similar to or even
242c609719bSwdenkidentical to what's used for the Linux kernel. Right now, we have to
243c609719bSwdenkdo the configuration by hand, which means creating some symbolic
244c609719bSwdenklinks and editing some configuration files. We use the TQM8xxL boards
245c609719bSwdenkas an example here.
246c609719bSwdenk
247c609719bSwdenk
248c609719bSwdenkSelection of Processor Architecture and Board Type:
249c609719bSwdenk---------------------------------------------------
250c609719bSwdenk
251c609719bSwdenkFor all supported boards there are ready-to-use default
252c609719bSwdenkconfigurations available; just type "make <board_name>_config".
253c609719bSwdenk
254c609719bSwdenkExample: For a TQM823L module type:
255c609719bSwdenk
256c609719bSwdenk	cd u-boot
257c609719bSwdenk	make TQM823L_config
258c609719bSwdenk
25911ccc33fSMarcel ZiswilerFor the Cogent platform, you need to specify the CPU type as well;
260c609719bSwdenke.g. "make cogent_mpc8xx_config". And also configure the cogent
261c609719bSwdenkdirectory according to the instructions in cogent/README.
262c609719bSwdenk
263c609719bSwdenk
264c609719bSwdenkConfiguration Options:
265c609719bSwdenk----------------------
266c609719bSwdenk
267c609719bSwdenkConfiguration depends on the combination of board and CPU type; all
268c609719bSwdenksuch information is kept in a configuration file
269c609719bSwdenk"include/configs/<board_name>.h".
270c609719bSwdenk
271c609719bSwdenkExample: For a TQM823L module, all configuration settings are in
272c609719bSwdenk"include/configs/TQM823L.h".
273c609719bSwdenk
274c609719bSwdenk
2757f6c2cbcSwdenkMany of the options are named exactly as the corresponding Linux
2767f6c2cbcSwdenkkernel configuration options. The intention is to make it easier to
2777f6c2cbcSwdenkbuild a config tool - later.
2787f6c2cbcSwdenk
2797f6c2cbcSwdenk
280c609719bSwdenkThe following options need to be configured:
281c609719bSwdenk
2822628114eSKim Phillips- CPU Type:	Define exactly one, e.g. CONFIG_MPC85XX.
283c609719bSwdenk
2842628114eSKim Phillips- Board Type:	Define exactly one, e.g. CONFIG_MPC8540ADS.
2856ccec449SWolfgang Denk
2866ccec449SWolfgang Denk- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
28709ea0de0SHaavard Skinnemoen		Define exactly one, e.g. CONFIG_ATSTK1002
288c609719bSwdenk
289c609719bSwdenk- CPU Module Type: (if CONFIG_COGENT is defined)
290c609719bSwdenk		Define exactly one of
291c609719bSwdenk		CONFIG_CMA286_60_OLD
292c609719bSwdenk--- FIXME --- not tested yet:
293c609719bSwdenk		CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
294c609719bSwdenk		CONFIG_CMA287_23, CONFIG_CMA287_50
295c609719bSwdenk
296c609719bSwdenk- Motherboard Type: (if CONFIG_COGENT is defined)
297c609719bSwdenk		Define exactly one of
298c609719bSwdenk		CONFIG_CMA101, CONFIG_CMA102
299c609719bSwdenk
300c609719bSwdenk- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
301c609719bSwdenk		Define one or more of
302c609719bSwdenk		CONFIG_CMA302
303c609719bSwdenk
304c609719bSwdenk- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
305c609719bSwdenk		Define one or more of
306c609719bSwdenk		CONFIG_LCD_HEARTBEAT	- update a character position on
30711ccc33fSMarcel Ziswiler					  the LCD display every second with
308c609719bSwdenk					  a "rotator" |\-/|\-/
309c609719bSwdenk
3102535d602Swdenk- Board flavour: (if CONFIG_MPC8260ADS is defined)
3112535d602Swdenk		CONFIG_ADSTYPE
3122535d602Swdenk		Possible values are:
3136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8260ADS	- original MPC8260ADS
3146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8266ADS	- MPC8266ADS
3156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_PQ2FADS	- PQ2FADS-ZU or PQ2FADS-VR
3166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8272ADS	- MPC8272ADS
3172535d602Swdenk
318cf946c6dSLei Wen- Marvell Family Member
319cf946c6dSLei Wen		CONFIG_SYS_MVFS		- define it if you want to enable
320cf946c6dSLei Wen					  multiple fs option at one time
321cf946c6dSLei Wen					  for marvell soc family
322cf946c6dSLei Wen
323c609719bSwdenk- MPC824X Family Member (if CONFIG_MPC824X is defined)
324c609719bSwdenk		Define exactly one of
325c609719bSwdenk		CONFIG_MPC8240, CONFIG_MPC8245
326c609719bSwdenk
32711ccc33fSMarcel Ziswiler- 8xx CPU Options: (if using an MPC8xx CPU)
32866ca92a5Swdenk		CONFIG_8xx_GCLK_FREQ	- deprecated: CPU clock if
32966ca92a5Swdenk					  get_gclk_freq() cannot work
3305da627a4Swdenk					  e.g. if there is no 32KHz
3315da627a4Swdenk					  reference PIT/RTC clock
33266ca92a5Swdenk		CONFIG_8xx_OSCLK	- PLL input clock (either EXTCLK
33366ca92a5Swdenk					  or XTAL/EXTAL)
334c609719bSwdenk
33566ca92a5Swdenk- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
3366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MIN
3376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MAX
33866ca92a5Swdenk		CONFIG_8xx_CPUCLK_DEFAULT
33975d1ea7fSwdenk			See doc/README.MPC866
34075d1ea7fSwdenk
3416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MEASURE_CPUCLK
34275d1ea7fSwdenk
34375d1ea7fSwdenk		Define this to measure the actual CPU clock instead
34475d1ea7fSwdenk		of relying on the correctness of the configured
34575d1ea7fSwdenk		values. Mostly useful for board bringup to make sure
34675d1ea7fSwdenk		the PLL is locked at the intended frequency. Note
34775d1ea7fSwdenk		that this requires a (stable) reference clock (32 kHz
3486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		RTC clock or CONFIG_SYS_8XX_XIN)
34975d1ea7fSwdenk
350506f3918SHeiko Schocher		CONFIG_SYS_DELAYED_ICACHE
351506f3918SHeiko Schocher
352506f3918SHeiko Schocher		Define this option if you want to enable the
353506f3918SHeiko Schocher		ICache only when Code runs from RAM.
354506f3918SHeiko Schocher
35566412c63SKumar Gala- 85xx CPU Options:
356ffd06e02SYork Sun		CONFIG_SYS_PPC64
357ffd06e02SYork Sun
358ffd06e02SYork Sun		Specifies that the core is a 64-bit PowerPC implementation (implements
359ffd06e02SYork Sun		the "64" category of the Power ISA). This is necessary for ePAPR
360ffd06e02SYork Sun		compliance, among other possible reasons.
361ffd06e02SYork Sun
36266412c63SKumar Gala		CONFIG_SYS_FSL_TBCLK_DIV
36366412c63SKumar Gala
36466412c63SKumar Gala		Defines the core time base clock divider ratio compared to the
36566412c63SKumar Gala		system clock.  On most PQ3 devices this is 8, on newer QorIQ
36666412c63SKumar Gala		devices it can be 16 or 32.  The ratio varies from SoC to Soc.
36766412c63SKumar Gala
3688f29084aSKumar Gala		CONFIG_SYS_FSL_PCIE_COMPAT
3698f29084aSKumar Gala
3708f29084aSKumar Gala		Defines the string to utilize when trying to match PCIe device
3718f29084aSKumar Gala		tree nodes for the given platform.
3728f29084aSKumar Gala
373afa6b551SPrabhakar Kushwaha		CONFIG_SYS_PPC_E500_DEBUG_TLB
374afa6b551SPrabhakar Kushwaha
375afa6b551SPrabhakar Kushwaha		Enables a temporary TLB entry to be used during boot to work
376afa6b551SPrabhakar Kushwaha		around limitations in e500v1 and e500v2 external debugger
377afa6b551SPrabhakar Kushwaha		support. This reduces the portions of the boot code where
378afa6b551SPrabhakar Kushwaha		breakpoints and single stepping do not work.  The value of this
379afa6b551SPrabhakar Kushwaha		symbol should be set to the TLB1 entry to be used for this
380afa6b551SPrabhakar Kushwaha		purpose.
381afa6b551SPrabhakar Kushwaha
38233eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510
38333eee330SScott Wood
38433eee330SScott Wood		Enables a workaround for erratum A004510.  If set,
38533eee330SScott Wood		then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
38633eee330SScott Wood		CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
38733eee330SScott Wood
38833eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
38933eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
39033eee330SScott Wood
39133eee330SScott Wood		Defines one or two SoC revisions (low 8 bits of SVR)
39233eee330SScott Wood		for which the A004510 workaround should be applied.
39333eee330SScott Wood
39433eee330SScott Wood		The rest of SVR is either not relevant to the decision
39533eee330SScott Wood		of whether the erratum is present (e.g. p2040 versus
39633eee330SScott Wood		p2041) or is implied by the build target, which controls
39733eee330SScott Wood		whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
39833eee330SScott Wood
39933eee330SScott Wood		See Freescale App Note 4493 for more information about
40033eee330SScott Wood		this erratum.
40133eee330SScott Wood
40274fa22edSPrabhakar Kushwaha		CONFIG_A003399_NOR_WORKAROUND
40374fa22edSPrabhakar Kushwaha		Enables a workaround for IFC erratum A003399. It is only
40474fa22edSPrabhakar Kushwaha		requred during NOR boot.
40574fa22edSPrabhakar Kushwaha
40633eee330SScott Wood		CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
40733eee330SScott Wood
40833eee330SScott Wood		This is the value to write into CCSR offset 0x18600
40933eee330SScott Wood		according to the A004510 workaround.
41033eee330SScott Wood
41164501c66SPriyanka Jain		CONFIG_SYS_FSL_DSP_DDR_ADDR
41264501c66SPriyanka Jain		This value denotes start offset of DDR memory which is
41364501c66SPriyanka Jain		connected exclusively to the DSP cores.
41464501c66SPriyanka Jain
415765b0bdbSPriyanka Jain		CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
416765b0bdbSPriyanka Jain		This value denotes start offset of M2 memory
417765b0bdbSPriyanka Jain		which is directly connected to the DSP core.
418765b0bdbSPriyanka Jain
41964501c66SPriyanka Jain		CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
42064501c66SPriyanka Jain		This value denotes start offset of M3 memory which is directly
42164501c66SPriyanka Jain		connected to the DSP core.
42264501c66SPriyanka Jain
423765b0bdbSPriyanka Jain		CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
424765b0bdbSPriyanka Jain		This value denotes start offset of DSP CCSR space.
425765b0bdbSPriyanka Jain
426cb93071bSYork Sun		CONFIG_SYS_FSL_DDR_EMU
427cb93071bSYork Sun		Specify emulator support for DDR. Some DDR features such as
428cb93071bSYork Sun		deskew training are not available.
429cb93071bSYork Sun
4306cb461b4SDaniel Schwierzeck- Generic CPU options:
4316cb461b4SDaniel Schwierzeck		CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
4326cb461b4SDaniel Schwierzeck
4336cb461b4SDaniel Schwierzeck		Defines the endianess of the CPU. Implementation of those
4346cb461b4SDaniel Schwierzeck		values is arch specific.
4356cb461b4SDaniel Schwierzeck
4360b953ffcSMarkus Klotzbuecher- Intel Monahans options:
4376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
4380b953ffcSMarkus Klotzbuecher
4390b953ffcSMarkus Klotzbuecher		Defines the Monahans run mode to oscillator
4400b953ffcSMarkus Klotzbuecher		ratio. Valid values are 8, 16, 24, 31. The core
4410b953ffcSMarkus Klotzbuecher		frequency is this value multiplied by 13 MHz.
4420b953ffcSMarkus Klotzbuecher
4436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
4440b953ffcSMarkus Klotzbuecher
4450b953ffcSMarkus Klotzbuecher		Defines the Monahans turbo mode to oscillator
4460b953ffcSMarkus Klotzbuecher		ratio. Valid values are 1 (default if undefined) and
4470b953ffcSMarkus Klotzbuecher		2. The core frequency as calculated above is multiplied
4480b953ffcSMarkus Klotzbuecher		by this value.
4490b953ffcSMarkus Klotzbuecher
45092bbd64eSDaniel Schwierzeck- MIPS CPU options:
45192bbd64eSDaniel Schwierzeck		CONFIG_SYS_INIT_SP_OFFSET
45292bbd64eSDaniel Schwierzeck
45392bbd64eSDaniel Schwierzeck		Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
45492bbd64eSDaniel Schwierzeck		pointer. This is needed for the temporary stack before
45592bbd64eSDaniel Schwierzeck		relocation.
45692bbd64eSDaniel Schwierzeck
45792bbd64eSDaniel Schwierzeck		CONFIG_SYS_MIPS_CACHE_MODE
45892bbd64eSDaniel Schwierzeck
45992bbd64eSDaniel Schwierzeck		Cache operation mode for the MIPS CPU.
46092bbd64eSDaniel Schwierzeck		See also arch/mips/include/asm/mipsregs.h.
46192bbd64eSDaniel Schwierzeck		Possible values are:
46292bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_NO_WA
46392bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_WA
46492bbd64eSDaniel Schwierzeck			CONF_CM_UNCACHED
46592bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_NONCOHERENT
46692bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_CE
46792bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_COW
46892bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_CUW
46992bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_ACCELERATED
47092bbd64eSDaniel Schwierzeck
47192bbd64eSDaniel Schwierzeck		CONFIG_SYS_XWAY_EBU_BOOTCFG
47292bbd64eSDaniel Schwierzeck
47392bbd64eSDaniel Schwierzeck		Special option for Lantiq XWAY SoCs for booting from NOR flash.
47492bbd64eSDaniel Schwierzeck		See also arch/mips/cpu/mips32/start.S.
47592bbd64eSDaniel Schwierzeck
47692bbd64eSDaniel Schwierzeck		CONFIG_XWAY_SWAP_BYTES
47792bbd64eSDaniel Schwierzeck
47892bbd64eSDaniel Schwierzeck		Enable compilation of tools/xway-swap-bytes needed for Lantiq
47992bbd64eSDaniel Schwierzeck		XWAY SoCs for booting from NOR flash. The U-Boot image needs to
48092bbd64eSDaniel Schwierzeck		be swapped if a flash programmer is used.
48192bbd64eSDaniel Schwierzeck
482b67d8816SChristian Riesch- ARM options:
483b67d8816SChristian Riesch		CONFIG_SYS_EXCEPTION_VECTORS_HIGH
484b67d8816SChristian Riesch
485b67d8816SChristian Riesch		Select high exception vectors of the ARM core, e.g., do not
486b67d8816SChristian Riesch		clear the V bit of the c1 register of CP15.
487b67d8816SChristian Riesch
4885356f545SAneesh V		CONFIG_SYS_THUMB_BUILD
4895356f545SAneesh V
4905356f545SAneesh V		Use this flag to build U-Boot using the Thumb instruction
4915356f545SAneesh V		set for ARM architectures. Thumb instruction set provides
4925356f545SAneesh V		better code density. For ARM architectures that support
4935356f545SAneesh V		Thumb2 this flag will result in Thumb2 code generated by
4945356f545SAneesh V		GCC.
4955356f545SAneesh V
496c5d4752cSStephen Warren		CONFIG_ARM_ERRATA_716044
4970678587fSStephen Warren		CONFIG_ARM_ERRATA_742230
4980678587fSStephen Warren		CONFIG_ARM_ERRATA_743622
4990678587fSStephen Warren		CONFIG_ARM_ERRATA_751472
5000678587fSStephen Warren
5010678587fSStephen Warren		If set, the workarounds for these ARM errata are applied early
5020678587fSStephen Warren		during U-Boot startup. Note that these options force the
5030678587fSStephen Warren		workarounds to be applied; no CPU-type/version detection
5040678587fSStephen Warren		exists, unlike the similar options in the Linux kernel. Do not
5050678587fSStephen Warren		set these options unless they apply!
5060678587fSStephen Warren
507795659dcSStephen Warren- CPU timer options:
508795659dcSStephen Warren		CONFIG_SYS_HZ
509795659dcSStephen Warren
510795659dcSStephen Warren		The frequency of the timer returned by get_timer().
511795659dcSStephen Warren		get_timer() must operate in milliseconds and this CONFIG
512795659dcSStephen Warren		option must be set to 1000.
513795659dcSStephen Warren
5145da627a4Swdenk- Linux Kernel Interface:
515c609719bSwdenk		CONFIG_CLOCKS_IN_MHZ
516c609719bSwdenk
517c609719bSwdenk		U-Boot stores all clock information in Hz
518c609719bSwdenk		internally. For binary compatibility with older Linux
519c609719bSwdenk		kernels (which expect the clocks passed in the
520c609719bSwdenk		bd_info data to be in MHz) the environment variable
521c609719bSwdenk		"clocks_in_mhz" can be defined so that U-Boot
522c609719bSwdenk		converts clock data to MHZ before passing it to the
523c609719bSwdenk		Linux kernel.
524c609719bSwdenk		When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
525c609719bSwdenk		"clocks_in_mhz=1" is automatically included in the
526c609719bSwdenk		default environment.
527c609719bSwdenk
5285da627a4Swdenk		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]
5295da627a4Swdenk
53011ccc33fSMarcel Ziswiler		When transferring memsize parameter to linux, some versions
5315da627a4Swdenk		expect it to be in bytes, others in MB.
5325da627a4Swdenk		Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
5335da627a4Swdenk
534fec6d9eeSGerald Van Baren		CONFIG_OF_LIBFDT
535f57f70aaSWolfgang Denk
536f57f70aaSWolfgang Denk		New kernel versions are expecting firmware settings to be
537213bf8c8SGerald Van Baren		passed using flattened device trees (based on open firmware
538213bf8c8SGerald Van Baren		concepts).
539213bf8c8SGerald Van Baren
540213bf8c8SGerald Van Baren		CONFIG_OF_LIBFDT
541213bf8c8SGerald Van Baren		 * New libfdt-based support
542213bf8c8SGerald Van Baren		 * Adds the "fdt" command
5433bb342fcSKim Phillips		 * The bootm command automatically updates the fdt
544213bf8c8SGerald Van Baren
545b55ae402SMarcel Ziswiler		OF_CPU - The proper name of the cpus node (only required for
546b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
547b55ae402SMarcel Ziswiler		OF_SOC - The proper name of the soc node (only required for
548b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
549f57f70aaSWolfgang Denk		OF_TBCLK - The timebase frequency.
550c2871f03SKumar Gala		OF_STDOUT_PATH - The path to the console device
551f57f70aaSWolfgang Denk
55211ccc33fSMarcel Ziswiler		boards with QUICC Engines require OF_QE to set UCC MAC
55311ccc33fSMarcel Ziswiler		addresses
5543bb342fcSKim Phillips
5554e253137SKumar Gala		CONFIG_OF_BOARD_SETUP
5564e253137SKumar Gala
5574e253137SKumar Gala		Board code has addition modification that it wants to make
5584e253137SKumar Gala		to the flat device tree before handing it off to the kernel
5596705d81eSwdenk
5600267768eSMatthew McClintock		CONFIG_OF_BOOT_CPU
5610267768eSMatthew McClintock
56211ccc33fSMarcel Ziswiler		This define fills in the correct boot CPU in the boot
5630267768eSMatthew McClintock		param header, the default value is zero if undefined.
5640267768eSMatthew McClintock
5653887c3fbSHeiko Schocher		CONFIG_OF_IDE_FIXUP
5663887c3fbSHeiko Schocher
5673887c3fbSHeiko Schocher		U-Boot can detect if an IDE device is present or not.
5683887c3fbSHeiko Schocher		If not, and this new config option is activated, U-Boot
5693887c3fbSHeiko Schocher		removes the ATA node from the DTS before booting Linux,
5703887c3fbSHeiko Schocher		so the Linux IDE driver does not probe the device and
5713887c3fbSHeiko Schocher		crash. This is needed for buggy hardware (uc101) where
5723887c3fbSHeiko Schocher		no pull down resistor is connected to the signal IDE5V_DD7.
5733887c3fbSHeiko Schocher
5747eb29398SIgor Grinberg		CONFIG_MACH_TYPE	[relevant for ARM only][mandatory]
5757eb29398SIgor Grinberg
5767eb29398SIgor Grinberg		This setting is mandatory for all boards that have only one
5777eb29398SIgor Grinberg		machine type and must be used to specify the machine type
5787eb29398SIgor Grinberg		number as it appears in the ARM machine registry
5797eb29398SIgor Grinberg		(see http://www.arm.linux.org.uk/developer/machines/).
5807eb29398SIgor Grinberg		Only boards that have multiple machine types supported
5817eb29398SIgor Grinberg		in a single configuration file and the machine type is
5827eb29398SIgor Grinberg		runtime discoverable, do not have to use this setting.
5837eb29398SIgor Grinberg
5840b2f4ecaSNiklaus Giger- vxWorks boot parameters:
5850b2f4ecaSNiklaus Giger
5860b2f4ecaSNiklaus Giger		bootvx constructs a valid bootline using the following
5870b2f4ecaSNiklaus Giger		environments variables: bootfile, ipaddr, serverip, hostname.
5880b2f4ecaSNiklaus Giger		It loads the vxWorks image pointed bootfile.
5890b2f4ecaSNiklaus Giger
5900b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
5910b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
5920b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
5930b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
5940b2f4ecaSNiklaus Giger
5950b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_ADD_PARAMS
5960b2f4ecaSNiklaus Giger
5970b2f4ecaSNiklaus Giger		Add it at the end of the bootline. E.g "u=username pw=secret"
5980b2f4ecaSNiklaus Giger
5990b2f4ecaSNiklaus Giger		Note: If a "bootargs" environment is defined, it will overwride
6000b2f4ecaSNiklaus Giger		the defaults discussed just above.
6010b2f4ecaSNiklaus Giger
6022c451f78SAneesh V- Cache Configuration:
6032c451f78SAneesh V		CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
6042c451f78SAneesh V		CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
6052c451f78SAneesh V		CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
6062c451f78SAneesh V
60793bc2193SAneesh V- Cache Configuration for ARM:
60893bc2193SAneesh V		CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
60993bc2193SAneesh V				      controller
61093bc2193SAneesh V		CONFIG_SYS_PL310_BASE - Physical base address of PL310
61193bc2193SAneesh V					controller register space
61293bc2193SAneesh V
6136705d81eSwdenk- Serial Ports:
61448d0192fSAndreas Engel		CONFIG_PL010_SERIAL
6156705d81eSwdenk
6166705d81eSwdenk		Define this if you want support for Amba PrimeCell PL010 UARTs.
6176705d81eSwdenk
61848d0192fSAndreas Engel		CONFIG_PL011_SERIAL
6196705d81eSwdenk
6206705d81eSwdenk		Define this if you want support for Amba PrimeCell PL011 UARTs.
6216705d81eSwdenk
6226705d81eSwdenk		CONFIG_PL011_CLOCK
6236705d81eSwdenk
6246705d81eSwdenk		If you have Amba PrimeCell PL011 UARTs, set this variable to
6256705d81eSwdenk		the clock speed of the UARTs.
6266705d81eSwdenk
6276705d81eSwdenk		CONFIG_PL01x_PORTS
6286705d81eSwdenk
6296705d81eSwdenk		If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
6306705d81eSwdenk		define this to a list of base addresses for each (supported)
6316705d81eSwdenk		port. See e.g. include/configs/versatile.h
6326705d81eSwdenk
633910f1ae3SJohn Rigby		CONFIG_PL011_SERIAL_RLCR
634910f1ae3SJohn Rigby
635910f1ae3SJohn Rigby		Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
636910f1ae3SJohn Rigby		have separate receive and transmit line control registers.  Set
637910f1ae3SJohn Rigby		this variable to initialize the extra register.
638910f1ae3SJohn Rigby
639910f1ae3SJohn Rigby		CONFIG_PL011_SERIAL_FLUSH_ON_INIT
640910f1ae3SJohn Rigby
641910f1ae3SJohn Rigby		On some platforms (e.g. U8500) U-Boot is loaded by a second stage
642910f1ae3SJohn Rigby		boot loader that has already initialized the UART.  Define this
643910f1ae3SJohn Rigby		variable to flush the UART at init time.
644910f1ae3SJohn Rigby
6456705d81eSwdenk
646c609719bSwdenk- Console Interface:
647c609719bSwdenk		Depending on board, define exactly one serial port
648c609719bSwdenk		(like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
649c609719bSwdenk		CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
650c609719bSwdenk		console by defining CONFIG_8xx_CONS_NONE
651c609719bSwdenk
652c609719bSwdenk		Note: if CONFIG_8xx_CONS_NONE is defined, the serial
653c609719bSwdenk		port routines must be defined elsewhere
654c609719bSwdenk		(i.e. serial_init(), serial_getc(), ...)
655c609719bSwdenk
656c609719bSwdenk		CONFIG_CFB_CONSOLE
657c609719bSwdenk		Enables console device for a color framebuffer. Needs following
658c53043b7SWolfgang Denk		defines (cf. smiLynxEM, i8042)
659c609719bSwdenk			VIDEO_FB_LITTLE_ENDIAN	graphic memory organisation
660c609719bSwdenk						(default big endian)
661c609719bSwdenk			VIDEO_HW_RECTFILL	graphic chip supports
662c609719bSwdenk						rectangle fill
663c609719bSwdenk						(cf. smiLynxEM)
664c609719bSwdenk			VIDEO_HW_BITBLT		graphic chip supports
665c609719bSwdenk						bit-blit (cf. smiLynxEM)
666c609719bSwdenk			VIDEO_VISIBLE_COLS	visible pixel columns
667c609719bSwdenk						(cols=pitch)
668c609719bSwdenk			VIDEO_VISIBLE_ROWS	visible pixel rows
669c609719bSwdenk			VIDEO_PIXEL_SIZE	bytes per pixel
670c609719bSwdenk			VIDEO_DATA_FORMAT	graphic data format
671c609719bSwdenk						(0-5, cf. cfb_console.c)
672c609719bSwdenk			VIDEO_FB_ADRS		framebuffer address
673c609719bSwdenk			VIDEO_KBD_INIT_FCT	keyboard int fct
674c609719bSwdenk						(i.e. i8042_kbd_init())
675c609719bSwdenk			VIDEO_TSTC_FCT		test char fct
676c609719bSwdenk						(i.e. i8042_tstc)
677c609719bSwdenk			VIDEO_GETC_FCT		get char fct
678c609719bSwdenk						(i.e. i8042_getc)
679c609719bSwdenk			CONFIG_CONSOLE_CURSOR	cursor drawing on/off
680c609719bSwdenk						(requires blink timer
681c609719bSwdenk						cf. i8042.c)
6826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
683c609719bSwdenk			CONFIG_CONSOLE_TIME	display time/date info in
684c609719bSwdenk						upper right corner
685602ad3b3SJon Loeliger						(requires CONFIG_CMD_DATE)
686c609719bSwdenk			CONFIG_VIDEO_LOGO	display Linux logo in
687c609719bSwdenk						upper left corner
688a6c7ad2fSwdenk			CONFIG_VIDEO_BMP_LOGO	use bmp_logo.h instead of
689a6c7ad2fSwdenk						linux_logo.h for logo.
690a6c7ad2fSwdenk						Requires CONFIG_VIDEO_LOGO
691c609719bSwdenk			CONFIG_CONSOLE_EXTRA_INFO
69211ccc33fSMarcel Ziswiler						additional board info beside
693c609719bSwdenk						the logo
694c609719bSwdenk
69533a35bbbSPali Rohár		When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
69633a35bbbSPali Rohár		a limited number of ANSI escape sequences (cursor control,
69733a35bbbSPali Rohár		erase functions and limited graphics rendition control).
69833a35bbbSPali Rohár
699c609719bSwdenk		When CONFIG_CFB_CONSOLE is defined, video console is
700c609719bSwdenk		default i/o. Serial console can be forced with
701c609719bSwdenk		environment 'console=serial'.
702c609719bSwdenk
703a3ad8e26Swdenk		When CONFIG_SILENT_CONSOLE is defined, all console
704a3ad8e26Swdenk		messages (by U-Boot and Linux!) can be silenced with
705a3ad8e26Swdenk		the "silent" environment variable. See
706a3ad8e26Swdenk		doc/README.silent for more information.
707a3ad8e26Swdenk
70845ae2546SHeiko Schocher		CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default
70945ae2546SHeiko Schocher			is 0x00.
71045ae2546SHeiko Schocher		CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default
71145ae2546SHeiko Schocher			is 0xa0.
71245ae2546SHeiko Schocher
713c609719bSwdenk- Console Baudrate:
714c609719bSwdenk		CONFIG_BAUDRATE - in bps
715c609719bSwdenk		Select one of the baudrates listed in
7166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
7176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
718c609719bSwdenk
719c92fac91SHeiko Schocher- Console Rx buffer length
720c92fac91SHeiko Schocher		With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
721c92fac91SHeiko Schocher		the maximum receive buffer length for the SMC.
7222b3f12c2SHeiko Schocher		This option is actual only for 82xx and 8xx possible.
723c92fac91SHeiko Schocher		If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
724c92fac91SHeiko Schocher		must be defined, to setup the maximum idle timeout for
725c92fac91SHeiko Schocher		the SMC.
726c92fac91SHeiko Schocher
7279558b48aSGraeme Russ- Pre-Console Buffer:
7289558b48aSGraeme Russ		Prior to the console being initialised (i.e. serial UART
7299558b48aSGraeme Russ		initialised etc) all console output is silently discarded.
7309558b48aSGraeme Russ		Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
7319558b48aSGraeme Russ		buffer any console messages prior to the console being
7329558b48aSGraeme Russ		initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
7339558b48aSGraeme Russ		bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
7349558b48aSGraeme Russ		a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
7359558b48aSGraeme Russ		bytes are output before the console is initialised, the
7369558b48aSGraeme Russ		earlier bytes are discarded.
7379558b48aSGraeme Russ
7389558b48aSGraeme Russ		'Sane' compilers will generate smaller code if
7399558b48aSGraeme Russ		CONFIG_PRE_CON_BUF_SZ is a power of 2
7409558b48aSGraeme Russ
741046a37bdSSonny Rao- Safe printf() functions
742046a37bdSSonny Rao		Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
743046a37bdSSonny Rao		the printf() functions. These are defined in
744046a37bdSSonny Rao		include/vsprintf.h and include snprintf(), vsnprintf() and
745046a37bdSSonny Rao		so on. Code size increase is approximately 300-500 bytes.
746046a37bdSSonny Rao		If this option is not given then these functions will
747046a37bdSSonny Rao		silently discard their buffer size argument - this means
748046a37bdSSonny Rao		you are not getting any overflow checking in this case.
749046a37bdSSonny Rao
750c609719bSwdenk- Boot Delay:	CONFIG_BOOTDELAY - in seconds
751c609719bSwdenk		Delay before automatically booting the default image;
752c609719bSwdenk		set to -1 to disable autoboot.
75393d7212fSJoe Hershberger		set to -2 to autoboot with no delay and not check for abort
75493d7212fSJoe Hershberger		(even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
755c609719bSwdenk
756c609719bSwdenk		See doc/README.autoboot for these options that
757c609719bSwdenk		work with CONFIG_BOOTDELAY. None are required.
758c609719bSwdenk		CONFIG_BOOT_RETRY_TIME
759c609719bSwdenk		CONFIG_BOOT_RETRY_MIN
760c609719bSwdenk		CONFIG_AUTOBOOT_KEYED
761c609719bSwdenk		CONFIG_AUTOBOOT_PROMPT
762c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR
763c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR
764c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR2
765c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR2
766c609719bSwdenk		CONFIG_ZERO_BOOTDELAY_CHECK
767c609719bSwdenk		CONFIG_RESET_TO_RETRY
768c609719bSwdenk
769c609719bSwdenk- Autoboot Command:
770c609719bSwdenk		CONFIG_BOOTCOMMAND
771c609719bSwdenk		Only needed when CONFIG_BOOTDELAY is enabled;
772c609719bSwdenk		define a command string that is automatically executed
773c609719bSwdenk		when no character is read on the console interface
774c609719bSwdenk		within "Boot Delay" after reset.
775c609719bSwdenk
776c609719bSwdenk		CONFIG_BOOTARGS
777c609719bSwdenk		This can be used to pass arguments to the bootm
778c609719bSwdenk		command. The value of CONFIG_BOOTARGS goes into the
779c609719bSwdenk		environment value "bootargs".
780c609719bSwdenk
781c609719bSwdenk		CONFIG_RAMBOOT and CONFIG_NFSBOOT
782c609719bSwdenk		The value of these goes into the environment as
783c609719bSwdenk		"ramboot" and "nfsboot" respectively, and can be used
784c609719bSwdenk		as a convenience, when switching between booting from
78511ccc33fSMarcel Ziswiler		RAM and NFS.
786c609719bSwdenk
787c609719bSwdenk- Pre-Boot Commands:
788c609719bSwdenk		CONFIG_PREBOOT
789c609719bSwdenk
790c609719bSwdenk		When this option is #defined, the existence of the
791c609719bSwdenk		environment variable "preboot" will be checked
792c609719bSwdenk		immediately before starting the CONFIG_BOOTDELAY
793c609719bSwdenk		countdown and/or running the auto-boot command resp.
794c609719bSwdenk		entering interactive mode.
795c609719bSwdenk
796c609719bSwdenk		This feature is especially useful when "preboot" is
797c609719bSwdenk		automatically generated or modified. For an example
798c609719bSwdenk		see the LWMON board specific code: here "preboot" is
799c609719bSwdenk		modified when the user holds down a certain
800c609719bSwdenk		combination of keys on the (special) keyboard when
801c609719bSwdenk		booting the systems
802c609719bSwdenk
803c609719bSwdenk- Serial Download Echo Mode:
804c609719bSwdenk		CONFIG_LOADS_ECHO
805c609719bSwdenk		If defined to 1, all characters received during a
806c609719bSwdenk		serial download (using the "loads" command) are
807c609719bSwdenk		echoed back. This might be needed by some terminal
808c609719bSwdenk		emulations (like "cu"), but may as well just take
809c609719bSwdenk		time on others. This setting #define's the initial
810c609719bSwdenk		value of the "loads_echo" environment variable.
811c609719bSwdenk
812602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
813c609719bSwdenk		CONFIG_KGDB_BAUDRATE
814c609719bSwdenk		Select one of the baudrates listed in
8156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
816c609719bSwdenk
817c609719bSwdenk- Monitor Functions:
818602ad3b3SJon Loeliger		Monitor commands can be included or excluded
819602ad3b3SJon Loeliger		from the build by using the #include files
820c6c621bdSStephen Warren		<config_cmd_all.h> and #undef'ing unwanted
821c6c621bdSStephen Warren		commands, or using <config_cmd_default.h>
822602ad3b3SJon Loeliger		and augmenting with additional #define's
823602ad3b3SJon Loeliger		for wanted commands.
824c609719bSwdenk
825602ad3b3SJon Loeliger		The default command configuration includes all commands
826602ad3b3SJon Loeliger		except those marked below with a "*".
827602ad3b3SJon Loeliger
828602ad3b3SJon Loeliger		CONFIG_CMD_ASKENV	* ask for env variable
829602ad3b3SJon Loeliger		CONFIG_CMD_BDI		  bdinfo
830602ad3b3SJon Loeliger		CONFIG_CMD_BEDBUG	* Include BedBug Debugger
831602ad3b3SJon Loeliger		CONFIG_CMD_BMP		* BMP support
832602ad3b3SJon Loeliger		CONFIG_CMD_BSP		* Board specific commands
833602ad3b3SJon Loeliger		CONFIG_CMD_BOOTD	  bootd
834602ad3b3SJon Loeliger		CONFIG_CMD_CACHE	* icache, dcache
835602ad3b3SJon Loeliger		CONFIG_CMD_CONSOLE	  coninfo
836710b9938SMike Frysinger		CONFIG_CMD_CRC32	* crc32
837602ad3b3SJon Loeliger		CONFIG_CMD_DATE		* support for RTC, date/time...
838602ad3b3SJon Loeliger		CONFIG_CMD_DHCP		* DHCP support
839602ad3b3SJon Loeliger		CONFIG_CMD_DIAG		* Diagnostics
840a7c93104SPeter Tyser		CONFIG_CMD_DS4510	* ds4510 I2C gpio commands
841a7c93104SPeter Tyser		CONFIG_CMD_DS4510_INFO	* ds4510 I2C info command
842a7c93104SPeter Tyser		CONFIG_CMD_DS4510_MEM	* ds4510 I2C eeprom/sram commansd
843a7c93104SPeter Tyser		CONFIG_CMD_DS4510_RST	* ds4510 I2C rst command
844602ad3b3SJon Loeliger		CONFIG_CMD_DTT		* Digital Therm and Thermostat
845602ad3b3SJon Loeliger		CONFIG_CMD_ECHO		  echo arguments
846246c6922SPeter Tyser		CONFIG_CMD_EDITENV	  edit env variable
847602ad3b3SJon Loeliger		CONFIG_CMD_EEPROM	* EEPROM read/write support
848602ad3b3SJon Loeliger		CONFIG_CMD_ELF		* bootelf, bootvx
8495e2b3e0cSJoe Hershberger		CONFIG_CMD_ENV_CALLBACK	* display details about env callbacks
850fffad71bSJoe Hershberger		CONFIG_CMD_ENV_FLAGS	* display details about env flags
85188733e2cSAndrew Ruder		CONFIG_CMD_ENV_EXISTS	* check existence of env variable
8520c79cda0SMike Frysinger		CONFIG_CMD_EXPORTENV	* export the environment
85303e2ecf6SStephen Warren		CONFIG_CMD_EXT2		* ext2 command support
85403e2ecf6SStephen Warren		CONFIG_CMD_EXT4		* ext4 command support
855bdab39d3SMike Frysinger		CONFIG_CMD_SAVEENV	  saveenv
856602ad3b3SJon Loeliger		CONFIG_CMD_FDC		* Floppy Disk Support
85703e2ecf6SStephen Warren		CONFIG_CMD_FAT		* FAT command support
858602ad3b3SJon Loeliger		CONFIG_CMD_FDOS		* Dos diskette Support
859602ad3b3SJon Loeliger		CONFIG_CMD_FLASH	  flinfo, erase, protect
860602ad3b3SJon Loeliger		CONFIG_CMD_FPGA		  FPGA device initialization support
8614d98b5c8SVincent Stehlé		CONFIG_CMD_FUSE		* Device fuse support
86253fdc7efSAnton Staaf		CONFIG_CMD_GETTIME	* Get time since boot
863a641b979SMike Frysinger		CONFIG_CMD_GO		* the 'go' command (exec code)
864a000b795SKim Phillips		CONFIG_CMD_GREPENV	* search environment
865bf36c5d5SSimon Glass		CONFIG_CMD_HASH		* calculate hash / digest
866602ad3b3SJon Loeliger		CONFIG_CMD_HWFLOW	* RTS/CTS hw flow control
867602ad3b3SJon Loeliger		CONFIG_CMD_I2C		* I2C serial bus support
868602ad3b3SJon Loeliger		CONFIG_CMD_IDE		* IDE harddisk support
869602ad3b3SJon Loeliger		CONFIG_CMD_IMI		  iminfo
8708fdf1e0fSVipin Kumar		CONFIG_CMD_IMLS		  List all images found in NOR flash
8714d98b5c8SVincent Stehlé		CONFIG_CMD_IMLS_NAND	* List all images found in NAND flash
872602ad3b3SJon Loeliger		CONFIG_CMD_IMMAP	* IMMR dump support
8730c79cda0SMike Frysinger		CONFIG_CMD_IMPORTENV	* import an environment
874c167cc02SJoe Hershberger		CONFIG_CMD_INI		* import data from an ini file into the env
875602ad3b3SJon Loeliger		CONFIG_CMD_IRQ		* irqinfo
876602ad3b3SJon Loeliger		CONFIG_CMD_ITEST	  Integer/string test of 2 values
877602ad3b3SJon Loeliger		CONFIG_CMD_JFFS2	* JFFS2 Support
878602ad3b3SJon Loeliger		CONFIG_CMD_KGDB		* kgdb
8794d98b5c8SVincent Stehlé		CONFIG_CMD_LDRINFO	* ldrinfo (display Blackfin loader)
880d22c338eSJoe Hershberger		CONFIG_CMD_LINK_LOCAL	* link-local IP address auto-configuration
881d22c338eSJoe Hershberger					  (169.254.*.*)
882602ad3b3SJon Loeliger		CONFIG_CMD_LOADB	  loadb
883602ad3b3SJon Loeliger		CONFIG_CMD_LOADS	  loads
8844d98b5c8SVincent Stehlé		CONFIG_CMD_MD5SUM	* print md5 message digest
88502c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
88615a33e49SSimon Glass		CONFIG_CMD_MEMINFO	* Display detailed memory information
887602ad3b3SJon Loeliger		CONFIG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
888a2681707SWolfgang Denk					  loop, loopw
8894d98b5c8SVincent Stehlé		CONFIG_CMD_MEMTEST	* mtest
890602ad3b3SJon Loeliger		CONFIG_CMD_MISC		  Misc functions like sleep etc
891602ad3b3SJon Loeliger		CONFIG_CMD_MMC		* MMC memory mapped support
892602ad3b3SJon Loeliger		CONFIG_CMD_MII		* MII utility commands
89368d7d651SStefan Roese		CONFIG_CMD_MTDPARTS	* MTD partition support
894602ad3b3SJon Loeliger		CONFIG_CMD_NAND		* NAND support
895602ad3b3SJon Loeliger		CONFIG_CMD_NET		  bootp, tftpboot, rarpboot
8964d98b5c8SVincent Stehlé		CONFIG_CMD_NFS		  NFS support
897e92739d3SPeter Tyser		CONFIG_CMD_PCA953X	* PCA953x I2C gpio commands
898e92739d3SPeter Tyser		CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
899602ad3b3SJon Loeliger		CONFIG_CMD_PCI		* pciinfo
900602ad3b3SJon Loeliger		CONFIG_CMD_PCMCIA		* PCMCIA support
901602ad3b3SJon Loeliger		CONFIG_CMD_PING		* send ICMP ECHO_REQUEST to network
902602ad3b3SJon Loeliger					  host
903602ad3b3SJon Loeliger		CONFIG_CMD_PORTIO	* Port I/O
904ff048ea9SKenneth Waters		CONFIG_CMD_READ		* Read raw data from partition
905602ad3b3SJon Loeliger		CONFIG_CMD_REGINFO	* Register dump
906602ad3b3SJon Loeliger		CONFIG_CMD_RUN		  run command in env variable
907d304931fSSimon Glass		CONFIG_CMD_SANDBOX	* sb command to access sandbox features
908602ad3b3SJon Loeliger		CONFIG_CMD_SAVES	* save S record dump
909602ad3b3SJon Loeliger		CONFIG_CMD_SCSI		* SCSI Support
910602ad3b3SJon Loeliger		CONFIG_CMD_SDRAM	* print SDRAM configuration information
911602ad3b3SJon Loeliger					  (requires CONFIG_CMD_I2C)
912602ad3b3SJon Loeliger		CONFIG_CMD_SETGETDCR	  Support for DCR Register access
913602ad3b3SJon Loeliger					  (4xx only)
914f61ec45eSEric Nelson		CONFIG_CMD_SF		* Read/write/erase SPI NOR flash
9154d98b5c8SVincent Stehlé		CONFIG_CMD_SHA1SUM	* print sha1 memory digest
91602c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY)
9177d861d95SBob Liu		CONFIG_CMD_SOFTSWITCH	* Soft switch setting command for BF60x
91874de7aefSWolfgang Denk		CONFIG_CMD_SOURCE	  "source" command Support
919602ad3b3SJon Loeliger		CONFIG_CMD_SPI		* SPI serial bus support
9207a83af07SLuca Ceresoli		CONFIG_CMD_TFTPSRV	* TFTP transfer in server mode
9211fb7cd49SSimon Glass		CONFIG_CMD_TFTPPUT	* TFTP put command (upload)
922da83bcd7SJoe Hershberger		CONFIG_CMD_TIME		* run command and report execution time (ARM specific)
923da83bcd7SJoe Hershberger		CONFIG_CMD_TIMER	* access to the system tick timer
924602ad3b3SJon Loeliger		CONFIG_CMD_USB		* USB support
925602ad3b3SJon Loeliger		CONFIG_CMD_CDP		* Cisco Discover Protocol support
926c8339f51SMarek Vasut		CONFIG_CMD_MFSL		* Microblaze FSL support
9274d98b5c8SVincent Stehlé		CONFIG_CMD_XIMG		  Load part of Multi Image
928c609719bSwdenk
929c609719bSwdenk
930c609719bSwdenk		EXAMPLE: If you want all functions except of network
931c609719bSwdenk		support you can write:
932c609719bSwdenk
933602ad3b3SJon Loeliger		#include "config_cmd_all.h"
934602ad3b3SJon Loeliger		#undef CONFIG_CMD_NET
935c609719bSwdenk
936213bf8c8SGerald Van Baren	Other Commands:
937213bf8c8SGerald Van Baren		fdt (flattened device tree) command: CONFIG_OF_LIBFDT
938c609719bSwdenk
939c609719bSwdenk	Note:	Don't enable the "icache" and "dcache" commands
940602ad3b3SJon Loeliger		(configuration option CONFIG_CMD_CACHE) unless you know
941c609719bSwdenk		what you (and your U-Boot users) are doing. Data
942c609719bSwdenk		cache cannot be enabled on systems like the 8xx or
943c609719bSwdenk		8260 (where accesses to the IMMR region must be
944c609719bSwdenk		uncached), and it cannot be disabled on all other
945c609719bSwdenk		systems where we (mis-) use the data cache to hold an
946c609719bSwdenk		initial stack and some data.
947c609719bSwdenk
948c609719bSwdenk
949c609719bSwdenk		XXX - this list needs to get updated!
950c609719bSwdenk
951a5ecbe62SWolfgang Denk- Regular expression support:
952a5ecbe62SWolfgang Denk		CONFIG_REGEX
953a5ecbe62SWolfgang Denk		If this variable is defined, U-Boot is linked against
954a5ecbe62SWolfgang Denk		the SLRE (Super Light Regular Expression) library,
955a5ecbe62SWolfgang Denk		which adds regex support to some commands, as for
956a5ecbe62SWolfgang Denk		example "env grep" and "setexpr".
957a5ecbe62SWolfgang Denk
95845ba8077SSimon Glass- Device tree:
95945ba8077SSimon Glass		CONFIG_OF_CONTROL
96045ba8077SSimon Glass		If this variable is defined, U-Boot will use a device tree
96145ba8077SSimon Glass		to configure its devices, instead of relying on statically
96245ba8077SSimon Glass		compiled #defines in the board file. This option is
96345ba8077SSimon Glass		experimental and only available on a few boards. The device
96445ba8077SSimon Glass		tree is available in the global data as gd->fdt_blob.
96545ba8077SSimon Glass
9662c0f79e4SSimon Glass		U-Boot needs to get its device tree from somewhere. This can
9672c0f79e4SSimon Glass		be done using one of the two options below:
968bbb0b128SSimon Glass
969bbb0b128SSimon Glass		CONFIG_OF_EMBED
970bbb0b128SSimon Glass		If this variable is defined, U-Boot will embed a device tree
971bbb0b128SSimon Glass		binary in its image. This device tree file should be in the
972bbb0b128SSimon Glass		board directory and called <soc>-<board>.dts. The binary file
973bbb0b128SSimon Glass		is then picked up in board_init_f() and made available through
974bbb0b128SSimon Glass		the global data structure as gd->blob.
97545ba8077SSimon Glass
9762c0f79e4SSimon Glass		CONFIG_OF_SEPARATE
9772c0f79e4SSimon Glass		If this variable is defined, U-Boot will build a device tree
9782c0f79e4SSimon Glass		binary. It will be called u-boot.dtb. Architecture-specific
9792c0f79e4SSimon Glass		code will locate it at run-time. Generally this works by:
9802c0f79e4SSimon Glass
9812c0f79e4SSimon Glass			cat u-boot.bin u-boot.dtb >image.bin
9822c0f79e4SSimon Glass
9832c0f79e4SSimon Glass		and in fact, U-Boot does this for you, creating a file called
9842c0f79e4SSimon Glass		u-boot-dtb.bin which is useful in the common case. You can
9852c0f79e4SSimon Glass		still use the individual files if you need something more
9862c0f79e4SSimon Glass		exotic.
9872c0f79e4SSimon Glass
988c609719bSwdenk- Watchdog:
989c609719bSwdenk		CONFIG_WATCHDOG
990c609719bSwdenk		If this variable is defined, it enables watchdog
9916abe6fb6SDetlev Zundel		support for the SoC. There must be support in the SoC
9926abe6fb6SDetlev Zundel		specific code for a watchdog. For the 8xx and 8260
9936abe6fb6SDetlev Zundel		CPUs, the SIU Watchdog feature is enabled in the SYPCR
9946abe6fb6SDetlev Zundel		register.  When supported for a specific SoC is
9956abe6fb6SDetlev Zundel		available, then no further board specific code should
9966abe6fb6SDetlev Zundel		be needed to use it.
9976abe6fb6SDetlev Zundel
9986abe6fb6SDetlev Zundel		CONFIG_HW_WATCHDOG
9996abe6fb6SDetlev Zundel		When using a watchdog circuitry external to the used
10006abe6fb6SDetlev Zundel		SoC, then define this variable and provide board
10016abe6fb6SDetlev Zundel		specific code for the "hw_watchdog_reset" function.
1002c609719bSwdenk
1003c1551ea8Sstroese- U-Boot Version:
1004c1551ea8Sstroese		CONFIG_VERSION_VARIABLE
1005c1551ea8Sstroese		If this variable is defined, an environment variable
1006c1551ea8Sstroese		named "ver" is created by U-Boot showing the U-Boot
1007c1551ea8Sstroese		version as printed by the "version" command.
1008a1ea8e51SBenoît Thébaudeau		Any change to this variable will be reverted at the
1009a1ea8e51SBenoît Thébaudeau		next reset.
1010c1551ea8Sstroese
1011c609719bSwdenk- Real-Time Clock:
1012c609719bSwdenk
1013602ad3b3SJon Loeliger		When CONFIG_CMD_DATE is selected, the type of the RTC
1014c609719bSwdenk		has to be selected, too. Define exactly one of the
1015c609719bSwdenk		following options:
1016c609719bSwdenk
1017c609719bSwdenk		CONFIG_RTC_MPC8xx	- use internal RTC of MPC8xx
1018c609719bSwdenk		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
10194e8b7544SFabio Estevam		CONFIG_RTC_MC13XXX	- use MC13783 or MC13892 RTC
1020c609719bSwdenk		CONFIG_RTC_MC146818	- use MC146818 RTC
10211cb8e980Swdenk		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
1022c609719bSwdenk		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
10237f70e853Swdenk		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
10243bac3513Swdenk		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
10259536dfccSTor Krill		CONFIG_RTC_ISL1208	- use Intersil ISL1208 RTC
10264c0d4c3bSwdenk		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
10276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_DS1337_NOOSC	- Turn off the OSC output for DS1337
102871d19f30SHeiko Schocher		CONFIG_SYS_RV3029_TCR	- enable trickle charger on
102971d19f30SHeiko Schocher					  RV3029 RTC.
1030c609719bSwdenk
1031b37c7e5eSwdenk		Note that if the RTC uses I2C, then the I2C interface
1032b37c7e5eSwdenk		must also be configured. See I2C Support, below.
1033b37c7e5eSwdenk
1034e92739d3SPeter Tyser- GPIO Support:
1035e92739d3SPeter Tyser		CONFIG_PCA953X		- use NXP's PCA953X series I2C GPIO
1036e92739d3SPeter Tyser
10375dec49caSChris Packham		The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
10385dec49caSChris Packham		chip-ngpio pairs that tell the PCA953X driver the number of
10395dec49caSChris Packham		pins supported by a particular chip.
10405dec49caSChris Packham
1041e92739d3SPeter Tyser		Note that if the GPIO device uses I2C, then the I2C interface
1042e92739d3SPeter Tyser		must also be configured. See I2C Support, below.
1043e92739d3SPeter Tyser
1044c609719bSwdenk- Timestamp Support:
1045c609719bSwdenk
1046c609719bSwdenk		When CONFIG_TIMESTAMP is selected, the timestamp
1047c609719bSwdenk		(date and time) of an image is printed by image
1048c609719bSwdenk		commands like bootm or iminfo. This option is
1049602ad3b3SJon Loeliger		automatically enabled when you select CONFIG_CMD_DATE .
1050c609719bSwdenk
1051923c46f9SKarl O. Pinc- Partition Labels (disklabels) Supported:
1052923c46f9SKarl O. Pinc		Zero or more of the following:
1053923c46f9SKarl O. Pinc		CONFIG_MAC_PARTITION   Apple's MacOS partition table.
1054923c46f9SKarl O. Pinc		CONFIG_DOS_PARTITION   MS Dos partition table, traditional on the
1055923c46f9SKarl O. Pinc				       Intel architecture, USB sticks, etc.
1056923c46f9SKarl O. Pinc		CONFIG_ISO_PARTITION   ISO partition table, used on CDROM etc.
1057923c46f9SKarl O. Pinc		CONFIG_EFI_PARTITION   GPT partition table, common when EFI is the
1058923c46f9SKarl O. Pinc				       bootloader.  Note 2TB partition limit; see
1059923c46f9SKarl O. Pinc				       disk/part_efi.c
1060923c46f9SKarl O. Pinc		CONFIG_MTD_PARTITIONS  Memory Technology Device partition table.
1061c609719bSwdenk
1062602ad3b3SJon Loeliger		If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1063218ca724SWolfgang Denk		CONFIG_CMD_SCSI) you must configure support for at
1064923c46f9SKarl O. Pinc		least one non-MTD partition type as well.
1065c609719bSwdenk
1066c609719bSwdenk- IDE Reset method:
10674d13cbadSwdenk		CONFIG_IDE_RESET_ROUTINE - this is defined in several
10684d13cbadSwdenk		board configurations files but used nowhere!
1069c609719bSwdenk
10704d13cbadSwdenk		CONFIG_IDE_RESET - is this is defined, IDE Reset will
10714d13cbadSwdenk		be performed by calling the function
10724d13cbadSwdenk			ide_set_reset(int reset)
10734d13cbadSwdenk		which has to be defined in a board specific file
1074c609719bSwdenk
1075c609719bSwdenk- ATAPI Support:
1076c609719bSwdenk		CONFIG_ATAPI
1077c609719bSwdenk
1078c609719bSwdenk		Set this to enable ATAPI support.
1079c609719bSwdenk
1080c40b2956Swdenk- LBA48 Support
1081c40b2956Swdenk		CONFIG_LBA48
1082c40b2956Swdenk
1083c40b2956Swdenk		Set this to enable support for disks larger than 137GB
10844b142febSHeiko Schocher		Also look at CONFIG_SYS_64BIT_LBA.
1085c40b2956Swdenk		Whithout these , LBA48 support uses 32bit variables and will 'only'
1086c40b2956Swdenk		support disks up to 2.1TB.
1087c40b2956Swdenk
10886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_64BIT_LBA:
1089c40b2956Swdenk			When enabled, makes the IDE subsystem use 64bit sector addresses.
1090c40b2956Swdenk			Default is 32bit.
1091c40b2956Swdenk
1092c609719bSwdenk- SCSI Support:
1093c609719bSwdenk		At the moment only there is only support for the
1094c609719bSwdenk		SYM53C8XX SCSI controller; define
1095c609719bSwdenk		CONFIG_SCSI_SYM53C8XX to enable it.
1096c609719bSwdenk
10976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
10986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
10996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
1100c609719bSwdenk		maximum numbers of LUNs, SCSI ID's and target
1101c609719bSwdenk		devices.
11026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
1103c609719bSwdenk
1104447c031bSStefan Reinauer		The environment variable 'scsidevs' is set to the number of
1105447c031bSStefan Reinauer		SCSI devices found during the last scan.
1106447c031bSStefan Reinauer
1107c609719bSwdenk- NETWORK Support (PCI):
1108682011ffSwdenk		CONFIG_E1000
1109ce5207e1SKyle Moffett		Support for Intel 8254x/8257x gigabit chips.
1110ce5207e1SKyle Moffett
1111ce5207e1SKyle Moffett		CONFIG_E1000_SPI
1112ce5207e1SKyle Moffett		Utility code for direct access to the SPI bus on Intel 8257x.
1113ce5207e1SKyle Moffett		This does not do anything useful unless you set at least one
1114ce5207e1SKyle Moffett		of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1115ce5207e1SKyle Moffett
1116ce5207e1SKyle Moffett		CONFIG_E1000_SPI_GENERIC
1117ce5207e1SKyle Moffett		Allow generic access to the SPI bus on the Intel 8257x, for
1118ce5207e1SKyle Moffett		example with the "sspi" command.
1119ce5207e1SKyle Moffett
1120ce5207e1SKyle Moffett		CONFIG_CMD_E1000
1121ce5207e1SKyle Moffett		Management command for E1000 devices.  When used on devices
1122ce5207e1SKyle Moffett		with SPI support you can reprogram the EEPROM from U-Boot.
1123682011ffSwdenk
1124ac3315c2SAndre Schwarz		CONFIG_E1000_FALLBACK_MAC
112511ccc33fSMarcel Ziswiler		default MAC for empty EEPROM after production.
1126ac3315c2SAndre Schwarz
1127c609719bSwdenk		CONFIG_EEPRO100
1128c609719bSwdenk		Support for Intel 82557/82559/82559ER chips.
112911ccc33fSMarcel Ziswiler		Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
1130c609719bSwdenk		write routine for first time initialisation.
1131c609719bSwdenk
1132c609719bSwdenk		CONFIG_TULIP
1133c609719bSwdenk		Support for Digital 2114x chips.
1134c609719bSwdenk		Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1135c609719bSwdenk		modem chip initialisation (KS8761/QS6611).
1136c609719bSwdenk
1137c609719bSwdenk		CONFIG_NATSEMI
1138c609719bSwdenk		Support for National dp83815 chips.
1139c609719bSwdenk
1140c609719bSwdenk		CONFIG_NS8382X
1141c609719bSwdenk		Support for National dp8382[01] gigabit chips.
1142c609719bSwdenk
114345219c46Swdenk- NETWORK Support (other):
114445219c46Swdenk
1145c041e9d2SJens Scharsig		CONFIG_DRIVER_AT91EMAC
1146c041e9d2SJens Scharsig		Support for AT91RM9200 EMAC.
1147c041e9d2SJens Scharsig
1148c041e9d2SJens Scharsig			CONFIG_RMII
1149c041e9d2SJens Scharsig			Define this to use reduced MII inteface
1150c041e9d2SJens Scharsig
1151c041e9d2SJens Scharsig			CONFIG_DRIVER_AT91EMAC_QUIET
1152c041e9d2SJens Scharsig			If this defined, the driver is quiet.
1153c041e9d2SJens Scharsig			The driver doen't show link status messages.
1154c041e9d2SJens Scharsig
1155efdd7319SRob Herring		CONFIG_CALXEDA_XGMAC
1156efdd7319SRob Herring		Support for the Calxeda XGMAC device
1157efdd7319SRob Herring
11583bb46d23SAshok		CONFIG_LAN91C96
115945219c46Swdenk		Support for SMSC's LAN91C96 chips.
116045219c46Swdenk
116145219c46Swdenk			CONFIG_LAN91C96_BASE
116245219c46Swdenk			Define this to hold the physical address
116345219c46Swdenk			of the LAN91C96's I/O space
116445219c46Swdenk
116545219c46Swdenk			CONFIG_LAN91C96_USE_32_BIT
116645219c46Swdenk			Define this to enable 32 bit addressing
116745219c46Swdenk
11683bb46d23SAshok		CONFIG_SMC91111
1169f39748aeSwdenk		Support for SMSC's LAN91C111 chip
1170f39748aeSwdenk
1171f39748aeSwdenk			CONFIG_SMC91111_BASE
1172f39748aeSwdenk			Define this to hold the physical address
1173f39748aeSwdenk			of the device (I/O space)
1174f39748aeSwdenk
1175f39748aeSwdenk			CONFIG_SMC_USE_32_BIT
1176f39748aeSwdenk			Define this if data bus is 32 bits
1177f39748aeSwdenk
1178f39748aeSwdenk			CONFIG_SMC_USE_IOFUNCS
1179f39748aeSwdenk			Define this to use i/o functions instead of macros
1180f39748aeSwdenk			(some hardware wont work with macros)
1181f39748aeSwdenk
1182dc02badaSHeiko Schocher		CONFIG_DRIVER_TI_EMAC
1183dc02badaSHeiko Schocher		Support for davinci emac
1184dc02badaSHeiko Schocher
1185dc02badaSHeiko Schocher			CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1186dc02badaSHeiko Schocher			Define this if you have more then 3 PHYs.
1187dc02badaSHeiko Schocher
1188b3dbf4a5SMacpaul Lin		CONFIG_FTGMAC100
1189b3dbf4a5SMacpaul Lin		Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1190b3dbf4a5SMacpaul Lin
1191b3dbf4a5SMacpaul Lin			CONFIG_FTGMAC100_EGIGA
1192b3dbf4a5SMacpaul Lin			Define this to use GE link update with gigabit PHY.
1193b3dbf4a5SMacpaul Lin			Define this if FTGMAC100 is connected to gigabit PHY.
1194b3dbf4a5SMacpaul Lin			If your system has 10/100 PHY only, it might not occur
1195b3dbf4a5SMacpaul Lin			wrong behavior. Because PHY usually return timeout or
1196b3dbf4a5SMacpaul Lin			useless data when polling gigabit status and gigabit
1197b3dbf4a5SMacpaul Lin			control registers. This behavior won't affect the
1198b3dbf4a5SMacpaul Lin			correctnessof 10/100 link speed update.
1199b3dbf4a5SMacpaul Lin
1200c2fff331SMike Rapoport		CONFIG_SMC911X
1201557b377dSJens Gehrlein		Support for SMSC's LAN911x and LAN921x chips
1202557b377dSJens Gehrlein
1203c2fff331SMike Rapoport			CONFIG_SMC911X_BASE
1204557b377dSJens Gehrlein			Define this to hold the physical address
1205557b377dSJens Gehrlein			of the device (I/O space)
1206557b377dSJens Gehrlein
1207c2fff331SMike Rapoport			CONFIG_SMC911X_32_BIT
1208557b377dSJens Gehrlein			Define this if data bus is 32 bits
1209557b377dSJens Gehrlein
1210c2fff331SMike Rapoport			CONFIG_SMC911X_16_BIT
1211557b377dSJens Gehrlein			Define this if data bus is 16 bits. If your processor
1212557b377dSJens Gehrlein			automatically converts one 32 bit word to two 16 bit
1213c2fff331SMike Rapoport			words you may also try CONFIG_SMC911X_32_BIT.
1214557b377dSJens Gehrlein
12153d0075faSYoshihiro Shimoda		CONFIG_SH_ETHER
12163d0075faSYoshihiro Shimoda		Support for Renesas on-chip Ethernet controller
12173d0075faSYoshihiro Shimoda
12183d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_USE_PORT
12193d0075faSYoshihiro Shimoda			Define the number of ports to be used
12203d0075faSYoshihiro Shimoda
12213d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_PHY_ADDR
12223d0075faSYoshihiro Shimoda			Define the ETH PHY's address
12233d0075faSYoshihiro Shimoda
122468260aabSYoshihiro Shimoda			CONFIG_SH_ETHER_CACHE_WRITEBACK
122568260aabSYoshihiro Shimoda			If this option is set, the driver enables cache flush.
122668260aabSYoshihiro Shimoda
12275e124724SVadim Bendebury- TPM Support:
122890899cc0SChe-liang Chiou		CONFIG_TPM
122990899cc0SChe-liang Chiou		Support TPM devices.
123090899cc0SChe-liang Chiou
12311b393db5STom Wai-Hong Tam		CONFIG_TPM_TIS_I2C
12321b393db5STom Wai-Hong Tam		Support for i2c bus TPM devices. Only one device
12331b393db5STom Wai-Hong Tam		per system is supported at this time.
12341b393db5STom Wai-Hong Tam
12351b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_BUS_NUMBER
12361b393db5STom Wai-Hong Tam			Define the the i2c bus number for the TPM device
12371b393db5STom Wai-Hong Tam
12381b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS
12391b393db5STom Wai-Hong Tam			Define the TPM's address on the i2c bus
12401b393db5STom Wai-Hong Tam
12411b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_BURST_LIMITATION
12421b393db5STom Wai-Hong Tam			Define the burst count bytes upper limit
12431b393db5STom Wai-Hong Tam
1244c01939c7SDirk Eibach		CONFIG_TPM_ATMEL_TWI
1245c01939c7SDirk Eibach		Support for Atmel TWI TPM device. Requires I2C support.
1246c01939c7SDirk Eibach
124790899cc0SChe-liang Chiou		CONFIG_TPM_TIS_LPC
12485e124724SVadim Bendebury		Support for generic parallel port TPM devices. Only one device
12495e124724SVadim Bendebury		per system is supported at this time.
12505e124724SVadim Bendebury
12515e124724SVadim Bendebury			CONFIG_TPM_TIS_BASE_ADDRESS
12525e124724SVadim Bendebury			Base address where the generic TPM device is mapped
12535e124724SVadim Bendebury			to. Contemporary x86 systems usually map it at
12545e124724SVadim Bendebury			0xfed40000.
12555e124724SVadim Bendebury
1256be6c1529SReinhard Pfau		CONFIG_CMD_TPM
1257be6c1529SReinhard Pfau		Add tpm monitor functions.
1258be6c1529SReinhard Pfau		Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1259be6c1529SReinhard Pfau		provides monitor access to authorized functions.
1260be6c1529SReinhard Pfau
1261be6c1529SReinhard Pfau		CONFIG_TPM
1262be6c1529SReinhard Pfau		Define this to enable the TPM support library which provides
1263be6c1529SReinhard Pfau		functional interfaces to some TPM commands.
1264be6c1529SReinhard Pfau		Requires support for a TPM device.
1265be6c1529SReinhard Pfau
1266be6c1529SReinhard Pfau		CONFIG_TPM_AUTH_SESSIONS
1267be6c1529SReinhard Pfau		Define this to enable authorized functions in the TPM library.
1268be6c1529SReinhard Pfau		Requires CONFIG_TPM and CONFIG_SHA1.
1269be6c1529SReinhard Pfau
1270c609719bSwdenk- USB Support:
1271c609719bSwdenk		At the moment only the UHCI host controller is
12724d13cbadSwdenk		supported (PIP405, MIP405, MPC5200); define
1273c609719bSwdenk		CONFIG_USB_UHCI to enable it.
1274c609719bSwdenk		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
127530d56faeSwdenk		and define CONFIG_USB_STORAGE to enable the USB
1276c609719bSwdenk		storage devices.
1277c609719bSwdenk		Note:
1278c609719bSwdenk		Supported are USB Keyboards and USB Floppy drives
1279c609719bSwdenk		(TEAC FD-05PUB).
12804d13cbadSwdenk		MPC5200 USB requires additional defines:
12814d13cbadSwdenk			CONFIG_USB_CLOCK
12824d13cbadSwdenk				for 528 MHz Clock: 0x0001bbbb
1283307ecb6dSEric Millbrandt			CONFIG_PSC3_USB
1284307ecb6dSEric Millbrandt				for USB on PSC3
12854d13cbadSwdenk			CONFIG_USB_CONFIG
12864d13cbadSwdenk				for differential drivers: 0x00001000
12874d13cbadSwdenk				for single ended drivers: 0x00005000
1288307ecb6dSEric Millbrandt				for differential drivers on PSC3: 0x00000100
1289307ecb6dSEric Millbrandt				for single ended drivers on PSC3: 0x00004100
12906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_USB_EVENT_POLL
1291fdcfaa1bSZhang Wei				May be defined to allow interrupt polling
1292fdcfaa1bSZhang Wei				instead of using asynchronous interrupts
12934d13cbadSwdenk
12949ab4ce22SSimon Glass		CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
12959ab4ce22SSimon Glass		txfilltuning field in the EHCI controller on reset.
12969ab4ce22SSimon Glass
1297aa155058SKuo-Jung Su		CONFIG_USB_HUB_MIN_POWER_ON_DELAY defines the minimum
1298aa155058SKuo-Jung Su		interval for usb hub power-on delay.(minimum 100msec)
1299aa155058SKuo-Jung Su
130016c8d5e7SWolfgang Denk- USB Device:
130116c8d5e7SWolfgang Denk		Define the below if you wish to use the USB console.
130216c8d5e7SWolfgang Denk		Once firmware is rebuilt from a serial console issue the
130316c8d5e7SWolfgang Denk		command "setenv stdin usbtty; setenv stdout usbtty" and
130411ccc33fSMarcel Ziswiler		attach your USB cable. The Unix command "dmesg" should print
130516c8d5e7SWolfgang Denk		it has found a new device. The environment variable usbtty
130616c8d5e7SWolfgang Denk		can be set to gserial or cdc_acm to enable your device to
130716c8d5e7SWolfgang Denk		appear to a USB host as a Linux gserial device or a
130816c8d5e7SWolfgang Denk		Common Device Class Abstract Control Model serial device.
130916c8d5e7SWolfgang Denk		If you select usbtty = gserial you should be able to enumerate
131016c8d5e7SWolfgang Denk		a Linux host by
131116c8d5e7SWolfgang Denk		# modprobe usbserial vendor=0xVendorID product=0xProductID
131216c8d5e7SWolfgang Denk		else if using cdc_acm, simply setting the environment
131316c8d5e7SWolfgang Denk		variable usbtty to be cdc_acm should suffice. The following
131416c8d5e7SWolfgang Denk		might be defined in YourBoardName.h
131516c8d5e7SWolfgang Denk
131616c8d5e7SWolfgang Denk			CONFIG_USB_DEVICE
131716c8d5e7SWolfgang Denk			Define this to build a UDC device
131816c8d5e7SWolfgang Denk
131916c8d5e7SWolfgang Denk			CONFIG_USB_TTY
132016c8d5e7SWolfgang Denk			Define this to have a tty type of device available to
132116c8d5e7SWolfgang Denk			talk to the UDC device
132216c8d5e7SWolfgang Denk
1323f9da0f89SVipin KUMAR			CONFIG_USBD_HS
1324f9da0f89SVipin KUMAR			Define this to enable the high speed support for usb
1325f9da0f89SVipin KUMAR			device and usbtty. If this feature is enabled, a routine
1326f9da0f89SVipin KUMAR			int is_usbd_high_speed(void)
1327f9da0f89SVipin KUMAR			also needs to be defined by the driver to dynamically poll
1328f9da0f89SVipin KUMAR			whether the enumeration has succeded at high speed or full
1329f9da0f89SVipin KUMAR			speed.
1330f9da0f89SVipin KUMAR
13316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_IS_IN_ENV
133216c8d5e7SWolfgang Denk			Define this if you want stdin, stdout &/or stderr to
133316c8d5e7SWolfgang Denk			be set to usbtty.
133416c8d5e7SWolfgang Denk
133516c8d5e7SWolfgang Denk			mpc8xx:
13366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_EXTC_CLK 0xBLAH
133716c8d5e7SWolfgang Denk				Derive USB clock from external clock "blah"
13386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_EXTC_CLK 0x02
133916c8d5e7SWolfgang Denk
13406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_BRG_CLK 0xBLAH
134116c8d5e7SWolfgang Denk				Derive USB clock from brgclk
13426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_BRG_CLK 0x04
134316c8d5e7SWolfgang Denk
134416c8d5e7SWolfgang Denk		If you have a USB-IF assigned VendorID then you may wish to
134516c8d5e7SWolfgang Denk		define your own vendor specific values either in BoardName.h
134616c8d5e7SWolfgang Denk		or directly in usbd_vendor_info.h. If you don't define
134716c8d5e7SWolfgang Denk		CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
134816c8d5e7SWolfgang Denk		CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
134916c8d5e7SWolfgang Denk		should pretend to be a Linux device to it's target host.
135016c8d5e7SWolfgang Denk
135116c8d5e7SWolfgang Denk			CONFIG_USBD_MANUFACTURER
135216c8d5e7SWolfgang Denk			Define this string as the name of your company for
135316c8d5e7SWolfgang Denk			- CONFIG_USBD_MANUFACTURER "my company"
135416c8d5e7SWolfgang Denk
135516c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCT_NAME
135616c8d5e7SWolfgang Denk			Define this string as the name of your product
135716c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCT_NAME "acme usb device"
135816c8d5e7SWolfgang Denk
135916c8d5e7SWolfgang Denk			CONFIG_USBD_VENDORID
136016c8d5e7SWolfgang Denk			Define this as your assigned Vendor ID from the USB
136116c8d5e7SWolfgang Denk			Implementors Forum. This *must* be a genuine Vendor ID
136216c8d5e7SWolfgang Denk			to avoid polluting the USB namespace.
136316c8d5e7SWolfgang Denk			- CONFIG_USBD_VENDORID 0xFFFF
136416c8d5e7SWolfgang Denk
136516c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCTID
136616c8d5e7SWolfgang Denk			Define this as the unique Product ID
136716c8d5e7SWolfgang Denk			for your device
136816c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCTID 0xFFFF
1369c609719bSwdenk
1370351e9b20SPrzemyslaw Marczak		Some USB device drivers may need to check USB cable attachment.
1371351e9b20SPrzemyslaw Marczak		In this case you can enable following config in BoardName.h:
1372351e9b20SPrzemyslaw Marczak			CONFIG_USB_CABLE_CHECK
1373351e9b20SPrzemyslaw Marczak			This enables function definition:
1374351e9b20SPrzemyslaw Marczak			- usb_cable_connected() in include/usb.h
1375351e9b20SPrzemyslaw Marczak			Implementation of this function is board-specific.
1376351e9b20SPrzemyslaw Marczak
1377d70a560fSIgor Grinberg- ULPI Layer Support:
1378d70a560fSIgor Grinberg		The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1379d70a560fSIgor Grinberg		the generic ULPI layer. The generic layer accesses the ULPI PHY
1380d70a560fSIgor Grinberg		via the platform viewport, so you need both the genric layer and
1381d70a560fSIgor Grinberg		the viewport enabled. Currently only Chipidea/ARC based
1382d70a560fSIgor Grinberg		viewport is supported.
1383d70a560fSIgor Grinberg		To enable the ULPI layer support, define CONFIG_USB_ULPI and
1384d70a560fSIgor Grinberg		CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
13856d365ea0SLucas Stach		If your ULPI phy needs a different reference clock than the
13866d365ea0SLucas Stach		standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
13876d365ea0SLucas Stach		the appropriate value in Hz.
1388c609719bSwdenk
1389c609719bSwdenk- MMC Support:
1390c609719bSwdenk		The MMC controller on the Intel PXA is supported. To
1391c609719bSwdenk		enable this define CONFIG_MMC. The MMC can be
1392c609719bSwdenk		accessed from the boot prompt by mapping the device
1393c609719bSwdenk		to physical memory similar to flash. Command line is
1394602ad3b3SJon Loeliger		enabled with CONFIG_CMD_MMC. The MMC driver also works with
1395602ad3b3SJon Loeliger		the FAT fs. This is enabled with CONFIG_CMD_FAT.
1396c609719bSwdenk
1397afb35666SYoshihiro Shimoda		CONFIG_SH_MMCIF
1398afb35666SYoshihiro Shimoda		Support for Renesas on-chip MMCIF controller
1399afb35666SYoshihiro Shimoda
1400afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_ADDR
1401afb35666SYoshihiro Shimoda			Define the base address of MMCIF registers
1402afb35666SYoshihiro Shimoda
1403afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_CLK
1404afb35666SYoshihiro Shimoda			Define the clock frequency for MMCIF
1405afb35666SYoshihiro Shimoda
1406b3ba6e94STom Rini- USB Device Firmware Update (DFU) class support:
1407b3ba6e94STom Rini		CONFIG_DFU_FUNCTION
1408b3ba6e94STom Rini		This enables the USB portion of the DFU USB class
1409b3ba6e94STom Rini
1410b3ba6e94STom Rini		CONFIG_CMD_DFU
1411b3ba6e94STom Rini		This enables the command "dfu" which is used to have
1412b3ba6e94STom Rini		U-Boot create a DFU class device via USB.  This command
1413b3ba6e94STom Rini		requires that the "dfu_alt_info" environment variable be
1414b3ba6e94STom Rini		set and define the alt settings to expose to the host.
1415b3ba6e94STom Rini
1416b3ba6e94STom Rini		CONFIG_DFU_MMC
1417b3ba6e94STom Rini		This enables support for exposing (e)MMC devices via DFU.
1418b3ba6e94STom Rini
1419c6631764SPantelis Antoniou		CONFIG_DFU_NAND
1420c6631764SPantelis Antoniou		This enables support for exposing NAND devices via DFU.
1421c6631764SPantelis Antoniou
1422a9479f04SAfzal Mohammed		CONFIG_DFU_RAM
1423a9479f04SAfzal Mohammed		This enables support for exposing RAM via DFU.
1424a9479f04SAfzal Mohammed		Note: DFU spec refer to non-volatile memory usage, but
1425a9479f04SAfzal Mohammed		allow usages beyond the scope of spec - here RAM usage,
1426a9479f04SAfzal Mohammed		one that would help mostly the developer.
1427a9479f04SAfzal Mohammed
1428e7e75c70SHeiko Schocher		CONFIG_SYS_DFU_DATA_BUF_SIZE
1429e7e75c70SHeiko Schocher		Dfu transfer uses a buffer before writing data to the
1430e7e75c70SHeiko Schocher		raw storage device. Make the size (in bytes) of this buffer
1431e7e75c70SHeiko Schocher		configurable. The size of this buffer is also configurable
1432e7e75c70SHeiko Schocher		through the "dfu_bufsiz" environment variable.
1433e7e75c70SHeiko Schocher
1434ea2453d5SPantelis Antoniou		CONFIG_SYS_DFU_MAX_FILE_SIZE
1435ea2453d5SPantelis Antoniou		When updating files rather than the raw storage device,
1436ea2453d5SPantelis Antoniou		we use a static buffer to copy the file into and then write
1437ea2453d5SPantelis Antoniou		the buffer once we've been given the whole file.  Define
1438ea2453d5SPantelis Antoniou		this to the maximum filesize (in bytes) for the buffer.
1439ea2453d5SPantelis Antoniou		Default is 4 MiB if undefined.
1440ea2453d5SPantelis Antoniou
14416705d81eSwdenk- Journaling Flash filesystem support:
14426705d81eSwdenk		CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
14436705d81eSwdenk		CONFIG_JFFS2_NAND_DEV
14446705d81eSwdenk		Define these for a default partition on a NAND device
14456705d81eSwdenk
14466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_SECTOR,
14476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
14486705d81eSwdenk		Define these for a default partition on a NOR device
14496705d81eSwdenk
14506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS_CUSTOM_PART
14516705d81eSwdenk		Define this to create an own partition. You have to provide a
14526705d81eSwdenk		function struct part_info* jffs2_part_info(int part_num)
14536705d81eSwdenk
14546705d81eSwdenk		If you define only one JFFS2 partition you may also want to
14556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_JFFS_SINGLE_PART	1
14566705d81eSwdenk		to disable the command chpart. This is the default when you
14576705d81eSwdenk		have not defined a custom partition
14586705d81eSwdenk
1459c30a15e5SDonggeun Kim- FAT(File Allocation Table) filesystem write function support:
1460c30a15e5SDonggeun Kim		CONFIG_FAT_WRITE
1461656f4c65SDonggeun Kim
1462656f4c65SDonggeun Kim		Define this to enable support for saving memory data as a
1463656f4c65SDonggeun Kim		file in FAT formatted partition.
1464656f4c65SDonggeun Kim
1465656f4c65SDonggeun Kim		This will also enable the command "fatwrite" enabling the
1466656f4c65SDonggeun Kim		user to write files to FAT.
1467c30a15e5SDonggeun Kim
146884cd9327SGabe BlackCBFS (Coreboot Filesystem) support
146984cd9327SGabe Black		CONFIG_CMD_CBFS
147084cd9327SGabe Black
147184cd9327SGabe Black		Define this to enable support for reading from a Coreboot
147284cd9327SGabe Black		filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
147384cd9327SGabe Black		and cbfsload.
147484cd9327SGabe Black
1475c609719bSwdenk- Keyboard Support:
1476c609719bSwdenk		CONFIG_ISA_KEYBOARD
1477c609719bSwdenk
1478c609719bSwdenk		Define this to enable standard (PC-Style) keyboard
1479c609719bSwdenk		support
1480c609719bSwdenk
1481c609719bSwdenk		CONFIG_I8042_KBD
1482c609719bSwdenk		Standard PC keyboard driver with US (is default) and
1483c609719bSwdenk		GERMAN key layout (switch via environment 'keymap=de') support.
1484c609719bSwdenk		Export function i8042_kbd_init, i8042_tstc and i8042_getc
1485c609719bSwdenk		for cfb_console. Supports cursor blinking.
1486c609719bSwdenk
1487713cb680SHung-ying Tyan		CONFIG_CROS_EC_KEYB
1488713cb680SHung-ying Tyan		Enables a Chrome OS keyboard using the CROS_EC interface.
1489713cb680SHung-ying Tyan		This uses CROS_EC to communicate with a second microcontroller
1490713cb680SHung-ying Tyan		which provides key scans on request.
1491713cb680SHung-ying Tyan
1492c609719bSwdenk- Video support:
1493c609719bSwdenk		CONFIG_VIDEO
1494c609719bSwdenk
1495c609719bSwdenk		Define this to enable video support (for output to
1496c609719bSwdenk		video).
1497c609719bSwdenk
1498c609719bSwdenk		CONFIG_VIDEO_CT69000
1499c609719bSwdenk
1500c609719bSwdenk		Enable Chips & Technologies 69000 Video chip
1501c609719bSwdenk
1502c609719bSwdenk		CONFIG_VIDEO_SMI_LYNXEM
1503eeb1b77bSwdenk		Enable Silicon Motion SMI 712/710/810 Video chip. The
1504eeb1b77bSwdenk		video output is selected via environment 'videoout'
1505eeb1b77bSwdenk		(1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1506eeb1b77bSwdenk		assumed.
1507c609719bSwdenk
1508eeb1b77bSwdenk		For the CT69000 and SMI_LYNXEM drivers, videomode is
150911ccc33fSMarcel Ziswiler		selected via environment 'videomode'. Two different ways
1510eeb1b77bSwdenk		are possible:
1511eeb1b77bSwdenk		- "videomode=num"   'num' is a standard LiLo mode numbers.
1512eeb1b77bSwdenk		Following standard modes are supported	(* is default):
1513eeb1b77bSwdenk
1514eeb1b77bSwdenk		      Colors	640x480 800x600 1024x768 1152x864 1280x1024
1515eeb1b77bSwdenk		-------------+---------------------------------------------
1516eeb1b77bSwdenk		      8 bits |	0x301*	0x303	 0x305	  0x161	    0x307
1517eeb1b77bSwdenk		     15 bits |	0x310	0x313	 0x316	  0x162	    0x319
1518eeb1b77bSwdenk		     16 bits |	0x311	0x314	 0x317	  0x163	    0x31A
1519eeb1b77bSwdenk		     24 bits |	0x312	0x315	 0x318	    ?	    0x31B
1520eeb1b77bSwdenk		-------------+---------------------------------------------
1521c609719bSwdenk		(i.e. setenv videomode 317; saveenv; reset;)
1522c609719bSwdenk
1523eeb1b77bSwdenk		- "videomode=bootargs" all the video parameters are parsed
15247817cb20SMarcel Ziswiler		from the bootargs. (See drivers/video/videomodes.c)
1525eeb1b77bSwdenk
1526eeb1b77bSwdenk
1527a6c7ad2fSwdenk		CONFIG_VIDEO_SED13806
1528a6c7ad2fSwdenk		Enable Epson SED13806 driver. This driver supports 8bpp
1529a6c7ad2fSwdenk		and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1530a6c7ad2fSwdenk		or CONFIG_VIDEO_SED13806_16BPP
1531a6c7ad2fSwdenk
15327d3053fbSTimur Tabi		CONFIG_FSL_DIU_FB
15337d3053fbSTimur Tabi		Enable the Freescale DIU video driver.	Reference boards for
15347d3053fbSTimur Tabi		SOCs that have a DIU should define this macro to enable DIU
15357d3053fbSTimur Tabi		support, and should also define these other macros:
15367d3053fbSTimur Tabi
15377d3053fbSTimur Tabi			CONFIG_SYS_DIU_ADDR
15387d3053fbSTimur Tabi			CONFIG_VIDEO
15397d3053fbSTimur Tabi			CONFIG_CMD_BMP
15407d3053fbSTimur Tabi			CONFIG_CFB_CONSOLE
15417d3053fbSTimur Tabi			CONFIG_VIDEO_SW_CURSOR
15427d3053fbSTimur Tabi			CONFIG_VGA_AS_SINGLE_DEVICE
15437d3053fbSTimur Tabi			CONFIG_VIDEO_LOGO
15447d3053fbSTimur Tabi			CONFIG_VIDEO_BMP_LOGO
15457d3053fbSTimur Tabi
1546ba8e76bdSTimur Tabi		The DIU driver will look for the 'video-mode' environment
1547ba8e76bdSTimur Tabi		variable, and if defined, enable the DIU as a console during
1548ba8e76bdSTimur Tabi		boot.  See the documentation file README.video for a
1549ba8e76bdSTimur Tabi		description of this variable.
15507d3053fbSTimur Tabi
1551058d59b0SSimon Glass		CONFIG_VIDEO_VGA
1552058d59b0SSimon Glass
1553058d59b0SSimon Glass		Enable the VGA video / BIOS for x86. The alternative if you
1554058d59b0SSimon Glass		are using coreboot is to use the coreboot frame buffer
1555058d59b0SSimon Glass		driver.
1556058d59b0SSimon Glass
1557058d59b0SSimon Glass
1558682011ffSwdenk- Keyboard Support:
1559682011ffSwdenk		CONFIG_KEYBOARD
1560682011ffSwdenk
1561682011ffSwdenk		Define this to enable a custom keyboard support.
1562682011ffSwdenk		This simply calls drv_keyboard_init() which must be
1563682011ffSwdenk		defined in your board-specific files.
1564682011ffSwdenk		The only board using this so far is RBC823.
1565a6c7ad2fSwdenk
1566c609719bSwdenk- LCD Support:	CONFIG_LCD
1567c609719bSwdenk
1568c609719bSwdenk		Define this to enable LCD support (for output to LCD
1569c609719bSwdenk		display); also select one of the supported displays
1570c609719bSwdenk		by defining one of these:
1571c609719bSwdenk
157239cf4804SStelian Pop		CONFIG_ATMEL_LCD:
157339cf4804SStelian Pop
157439cf4804SStelian Pop			HITACHI TX09D70VM1CCA, 3.5", 240x320.
157539cf4804SStelian Pop
1576fd3103bbSwdenk		CONFIG_NEC_NL6448AC33:
1577c609719bSwdenk
1578fd3103bbSwdenk			NEC NL6448AC33-18. Active, color, single scan.
1579c609719bSwdenk
1580fd3103bbSwdenk		CONFIG_NEC_NL6448BC20
1581c609719bSwdenk
1582fd3103bbSwdenk			NEC NL6448BC20-08. 6.5", 640x480.
1583fd3103bbSwdenk			Active, color, single scan.
1584fd3103bbSwdenk
1585fd3103bbSwdenk		CONFIG_NEC_NL6448BC33_54
1586fd3103bbSwdenk
1587fd3103bbSwdenk			NEC NL6448BC33-54. 10.4", 640x480.
1588c609719bSwdenk			Active, color, single scan.
1589c609719bSwdenk
1590c609719bSwdenk		CONFIG_SHARP_16x9
1591c609719bSwdenk
1592c609719bSwdenk			Sharp 320x240. Active, color, single scan.
1593c609719bSwdenk			It isn't 16x9, and I am not sure what it is.
1594c609719bSwdenk
1595c609719bSwdenk		CONFIG_SHARP_LQ64D341
1596c609719bSwdenk
1597c609719bSwdenk			Sharp LQ64D341 display, 640x480.
1598c609719bSwdenk			Active, color, single scan.
1599c609719bSwdenk
1600c609719bSwdenk		CONFIG_HLD1045
1601c609719bSwdenk
1602c609719bSwdenk			HLD1045 display, 640x480.
1603c609719bSwdenk			Active, color, single scan.
1604c609719bSwdenk
1605c609719bSwdenk		CONFIG_OPTREX_BW
1606c609719bSwdenk
1607c609719bSwdenk			Optrex	 CBL50840-2 NF-FW 99 22 M5
1608c609719bSwdenk			or
1609c609719bSwdenk			Hitachi	 LMG6912RPFC-00T
1610c609719bSwdenk			or
1611c609719bSwdenk			Hitachi	 SP14Q002
1612c609719bSwdenk
1613c609719bSwdenk			320x240. Black & white.
1614c609719bSwdenk
1615c609719bSwdenk		Normally display is black on white background; define
16166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
1617c609719bSwdenk
1618676d319eSSimon Glass		CONFIG_LCD_ALIGNMENT
1619676d319eSSimon Glass
1620676d319eSSimon Glass		Normally the LCD is page-aligned (tyically 4KB). If this is
1621676d319eSSimon Glass		defined then the LCD will be aligned to this value instead.
1622676d319eSSimon Glass		For ARM it is sometimes useful to use MMU_SECTION_SIZE
1623676d319eSSimon Glass		here, since it is cheaper to change data cache settings on
1624676d319eSSimon Glass		a per-section basis.
1625676d319eSSimon Glass
16260d89efefSSimon Glass		CONFIG_CONSOLE_SCROLL_LINES
16270d89efefSSimon Glass
16280d89efefSSimon Glass		When the console need to be scrolled, this is the number of
16290d89efefSSimon Glass		lines to scroll by. It defaults to 1. Increasing this makes
16300d89efefSSimon Glass		the console jump but can help speed up operation when scrolling
16310d89efefSSimon Glass		is slow.
1632676d319eSSimon Glass
163345d7f525STom Wai-Hong Tam		CONFIG_LCD_BMP_RLE8
163445d7f525STom Wai-Hong Tam
163545d7f525STom Wai-Hong Tam		Support drawing of RLE8-compressed bitmaps on the LCD.
163645d7f525STom Wai-Hong Tam
1637735987c5STom Wai-Hong Tam		CONFIG_I2C_EDID
1638735987c5STom Wai-Hong Tam
1639735987c5STom Wai-Hong Tam		Enables an 'i2c edid' command which can read EDID
1640735987c5STom Wai-Hong Tam		information over I2C from an attached LCD display.
1641735987c5STom Wai-Hong Tam
16427152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN
1643d791b1dcSwdenk
1644d791b1dcSwdenk		If this option is set, the environment is checked for
1645d791b1dcSwdenk		a variable "splashimage". If found, the usual display
1646d791b1dcSwdenk		of logo, copyright and system information on the LCD
1647e94d2cd9Swdenk		is suppressed and the BMP image at the address
1648d791b1dcSwdenk		specified in "splashimage" is loaded instead. The
1649d791b1dcSwdenk		console is redirected to the "nulldev", too. This
1650d791b1dcSwdenk		allows for a "silent" boot where a splash screen is
1651d791b1dcSwdenk		loaded very quickly after power-on.
1652d791b1dcSwdenk
1653c0880485SNikita Kiryanov		CONFIG_SPLASHIMAGE_GUARD
1654c0880485SNikita Kiryanov
1655c0880485SNikita Kiryanov		If this option is set, then U-Boot will prevent the environment
1656c0880485SNikita Kiryanov		variable "splashimage" from being set to a problematic address
1657c0880485SNikita Kiryanov		(see README.displaying-bmps and README.arm-unaligned-accesses).
1658c0880485SNikita Kiryanov		This option is useful for targets where, due to alignment
1659c0880485SNikita Kiryanov		restrictions, an improperly aligned BMP image will cause a data
1660c0880485SNikita Kiryanov		abort. If you think you will not have problems with unaligned
1661c0880485SNikita Kiryanov		accesses (for example because your toolchain prevents them)
1662c0880485SNikita Kiryanov		there is no need to set this option.
1663c0880485SNikita Kiryanov
16641ca298ceSMatthias Weisser		CONFIG_SPLASH_SCREEN_ALIGN
16651ca298ceSMatthias Weisser
16661ca298ceSMatthias Weisser		If this option is set the splash image can be freely positioned
16671ca298ceSMatthias Weisser		on the screen. Environment variable "splashpos" specifies the
16681ca298ceSMatthias Weisser		position as "x,y". If a positive number is given it is used as
16691ca298ceSMatthias Weisser		number of pixel from left/top. If a negative number is given it
16701ca298ceSMatthias Weisser		is used as number of pixel from right/bottom. You can also
16711ca298ceSMatthias Weisser		specify 'm' for centering the image.
16721ca298ceSMatthias Weisser
16731ca298ceSMatthias Weisser		Example:
16741ca298ceSMatthias Weisser		setenv splashpos m,m
16751ca298ceSMatthias Weisser			=> image at center of screen
16761ca298ceSMatthias Weisser
16771ca298ceSMatthias Weisser		setenv splashpos 30,20
16781ca298ceSMatthias Weisser			=> image at x = 30 and y = 20
16791ca298ceSMatthias Weisser
16801ca298ceSMatthias Weisser		setenv splashpos -10,m
16811ca298ceSMatthias Weisser			=> vertically centered image
16821ca298ceSMatthias Weisser			   at x = dspWidth - bmpWidth - 9
16831ca298ceSMatthias Weisser
168498f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
168598f4a3dfSStefan Roese
168698f4a3dfSStefan Roese		If this option is set, additionally to standard BMP
168798f4a3dfSStefan Roese		images, gzipped BMP images can be displayed via the
168898f4a3dfSStefan Roese		splashscreen support or the bmp command.
168998f4a3dfSStefan Roese
1690d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1691d5011762SAnatolij Gustschin
1692d5011762SAnatolij Gustschin		If this option is set, 8-bit RLE compressed BMP images
1693d5011762SAnatolij Gustschin		can be displayed via the splashscreen support or the
1694d5011762SAnatolij Gustschin		bmp command.
1695d5011762SAnatolij Gustschin
1696f2b96dfbSLei Wen- Do compresssing for memory range:
1697f2b96dfbSLei Wen		CONFIG_CMD_ZIP
1698f2b96dfbSLei Wen
1699f2b96dfbSLei Wen		If this option is set, it would use zlib deflate method
1700f2b96dfbSLei Wen		to compress the specified memory at its best effort.
1701f2b96dfbSLei Wen
1702c29fdfc1Swdenk- Compression support:
17038ef70478SKees Cook		CONFIG_GZIP
17048ef70478SKees Cook
17058ef70478SKees Cook		Enabled by default to support gzip compressed images.
17068ef70478SKees Cook
1707c29fdfc1Swdenk		CONFIG_BZIP2
1708c29fdfc1Swdenk
1709c29fdfc1Swdenk		If this option is set, support for bzip2 compressed
1710c29fdfc1Swdenk		images is included. If not, only uncompressed and gzip
1711c29fdfc1Swdenk		compressed images are supported.
1712c29fdfc1Swdenk
1713c29fdfc1Swdenk		NOTE: the bzip2 algorithm requires a lot of RAM, so
17146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
1715c29fdfc1Swdenk		be at least 4MB.
1716d791b1dcSwdenk
1717fc9c1727SLuigi 'Comio' Mantellini		CONFIG_LZMA
1718fc9c1727SLuigi 'Comio' Mantellini
1719fc9c1727SLuigi 'Comio' Mantellini		If this option is set, support for lzma compressed
1720fc9c1727SLuigi 'Comio' Mantellini		images is included.
1721fc9c1727SLuigi 'Comio' Mantellini
1722fc9c1727SLuigi 'Comio' Mantellini		Note: The LZMA algorithm adds between 2 and 4KB of code and it
1723fc9c1727SLuigi 'Comio' Mantellini		requires an amount of dynamic memory that is given by the
1724fc9c1727SLuigi 'Comio' Mantellini		formula:
1725fc9c1727SLuigi 'Comio' Mantellini
1726fc9c1727SLuigi 'Comio' Mantellini			(1846 + 768 << (lc + lp)) * sizeof(uint16)
1727fc9c1727SLuigi 'Comio' Mantellini
1728fc9c1727SLuigi 'Comio' Mantellini		Where lc and lp stand for, respectively, Literal context bits
1729fc9c1727SLuigi 'Comio' Mantellini		and Literal pos bits.
1730fc9c1727SLuigi 'Comio' Mantellini
1731fc9c1727SLuigi 'Comio' Mantellini		This value is upper-bounded by 14MB in the worst case. Anyway,
1732fc9c1727SLuigi 'Comio' Mantellini		for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1733fc9c1727SLuigi 'Comio' Mantellini		total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1734fc9c1727SLuigi 'Comio' Mantellini		a very small buffer.
1735fc9c1727SLuigi 'Comio' Mantellini
1736fc9c1727SLuigi 'Comio' Mantellini		Use the lzmainfo tool to determinate the lc and lp values and
1737fc9c1727SLuigi 'Comio' Mantellini		then calculate the amount of needed dynamic memory (ensuring
17386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the appropriate CONFIG_SYS_MALLOC_LEN value).
1739fc9c1727SLuigi 'Comio' Mantellini
17408ef70478SKees Cook		CONFIG_LZO
17418ef70478SKees Cook
17428ef70478SKees Cook		If this option is set, support for LZO compressed images
17438ef70478SKees Cook		is included.
17448ef70478SKees Cook
174517ea1177Swdenk- MII/PHY support:
174617ea1177Swdenk		CONFIG_PHY_ADDR
174717ea1177Swdenk
174817ea1177Swdenk		The address of PHY on MII bus.
174917ea1177Swdenk
175017ea1177Swdenk		CONFIG_PHY_CLOCK_FREQ (ppc4xx)
175117ea1177Swdenk
175217ea1177Swdenk		The clock frequency of the MII bus
175317ea1177Swdenk
175417ea1177Swdenk		CONFIG_PHY_GIGE
175517ea1177Swdenk
175617ea1177Swdenk		If this option is set, support for speed/duplex
175711ccc33fSMarcel Ziswiler		detection of gigabit PHY is included.
175817ea1177Swdenk
175917ea1177Swdenk		CONFIG_PHY_RESET_DELAY
176017ea1177Swdenk
176117ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
176217ea1177Swdenk		reset before any MII register access is possible.
176317ea1177Swdenk		For such PHY, set this option to the usec delay
176417ea1177Swdenk		required. (minimum 300usec for LXT971A)
176517ea1177Swdenk
176617ea1177Swdenk		CONFIG_PHY_CMD_DELAY (ppc4xx)
176717ea1177Swdenk
176817ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
176917ea1177Swdenk		command issued before MII status register can be read
177017ea1177Swdenk
1771c609719bSwdenk- Ethernet address:
1772c609719bSwdenk		CONFIG_ETHADDR
1773c68a05feSrichardretanubun		CONFIG_ETH1ADDR
1774c609719bSwdenk		CONFIG_ETH2ADDR
1775c609719bSwdenk		CONFIG_ETH3ADDR
1776c68a05feSrichardretanubun		CONFIG_ETH4ADDR
1777c68a05feSrichardretanubun		CONFIG_ETH5ADDR
1778c609719bSwdenk
177911ccc33fSMarcel Ziswiler		Define a default value for Ethernet address to use
178011ccc33fSMarcel Ziswiler		for the respective Ethernet interface, in case this
1781c609719bSwdenk		is not determined automatically.
1782c609719bSwdenk
1783c609719bSwdenk- IP address:
1784c609719bSwdenk		CONFIG_IPADDR
1785c609719bSwdenk
1786c609719bSwdenk		Define a default value for the IP address to use for
178711ccc33fSMarcel Ziswiler		the default Ethernet interface, in case this is not
1788c609719bSwdenk		determined through e.g. bootp.
17891ebcd654SWolfgang Denk		(Environment variable "ipaddr")
1790c609719bSwdenk
1791c609719bSwdenk- Server IP address:
1792c609719bSwdenk		CONFIG_SERVERIP
1793c609719bSwdenk
1794c609719bSwdenk		Defines a default value for the IP address of a TFTP
1795c609719bSwdenk		server to contact when using the "tftboot" command.
17961ebcd654SWolfgang Denk		(Environment variable "serverip")
1797c609719bSwdenk
179897cfe861SRobin Getz		CONFIG_KEEP_SERVERADDR
179997cfe861SRobin Getz
180097cfe861SRobin Getz		Keeps the server's MAC address, in the env 'serveraddr'
180197cfe861SRobin Getz		for passing to bootargs (like Linux's netconsole option)
180297cfe861SRobin Getz
18031ebcd654SWolfgang Denk- Gateway IP address:
18041ebcd654SWolfgang Denk		CONFIG_GATEWAYIP
18051ebcd654SWolfgang Denk
18061ebcd654SWolfgang Denk		Defines a default value for the IP address of the
18071ebcd654SWolfgang Denk		default router where packets to other networks are
18081ebcd654SWolfgang Denk		sent to.
18091ebcd654SWolfgang Denk		(Environment variable "gatewayip")
18101ebcd654SWolfgang Denk
18111ebcd654SWolfgang Denk- Subnet mask:
18121ebcd654SWolfgang Denk		CONFIG_NETMASK
18131ebcd654SWolfgang Denk
18141ebcd654SWolfgang Denk		Defines a default value for the subnet mask (or
18151ebcd654SWolfgang Denk		routing prefix) which is used to determine if an IP
18161ebcd654SWolfgang Denk		address belongs to the local subnet or needs to be
18171ebcd654SWolfgang Denk		forwarded through a router.
18181ebcd654SWolfgang Denk		(Environment variable "netmask")
18191ebcd654SWolfgang Denk
182053a5c424SDavid Updegraff- Multicast TFTP Mode:
182153a5c424SDavid Updegraff		CONFIG_MCAST_TFTP
182253a5c424SDavid Updegraff
182353a5c424SDavid Updegraff		Defines whether you want to support multicast TFTP as per
182453a5c424SDavid Updegraff		rfc-2090; for example to work with atftp.  Lets lots of targets
182511ccc33fSMarcel Ziswiler		tftp down the same boot image concurrently.  Note: the Ethernet
182653a5c424SDavid Updegraff		driver in use must provide a function: mcast() to join/leave a
182753a5c424SDavid Updegraff		multicast group.
182853a5c424SDavid Updegraff
1829c609719bSwdenk- BOOTP Recovery Mode:
1830c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY
1831c609719bSwdenk
1832c609719bSwdenk		If you have many targets in a network that try to
1833c609719bSwdenk		boot using BOOTP, you may want to avoid that all
1834c609719bSwdenk		systems send out BOOTP requests at precisely the same
1835c609719bSwdenk		moment (which would happen for instance at recovery
1836c609719bSwdenk		from a power failure, when all systems will try to
1837c609719bSwdenk		boot, thus flooding the BOOTP server. Defining
1838c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1839c609719bSwdenk		inserted before sending out BOOTP requests. The
18406c33c785SWolfgang Denk		following delays are inserted then:
1841c609719bSwdenk
1842c609719bSwdenk		1st BOOTP request:	delay 0 ... 1 sec
1843c609719bSwdenk		2nd BOOTP request:	delay 0 ... 2 sec
1844c609719bSwdenk		3rd BOOTP request:	delay 0 ... 4 sec
1845c609719bSwdenk		4th and following
1846c609719bSwdenk		BOOTP requests:		delay 0 ... 8 sec
1847c609719bSwdenk
1848fe389a82Sstroese- DHCP Advanced Options:
18491fe80d79SJon Loeliger		You can fine tune the DHCP functionality by defining
18501fe80d79SJon Loeliger		CONFIG_BOOTP_* symbols:
1851fe389a82Sstroese
18521fe80d79SJon Loeliger		CONFIG_BOOTP_SUBNETMASK
18531fe80d79SJon Loeliger		CONFIG_BOOTP_GATEWAY
18541fe80d79SJon Loeliger		CONFIG_BOOTP_HOSTNAME
18551fe80d79SJon Loeliger		CONFIG_BOOTP_NISDOMAIN
18561fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTPATH
18571fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTFILESIZE
18581fe80d79SJon Loeliger		CONFIG_BOOTP_DNS
18591fe80d79SJon Loeliger		CONFIG_BOOTP_DNS2
18601fe80d79SJon Loeliger		CONFIG_BOOTP_SEND_HOSTNAME
18611fe80d79SJon Loeliger		CONFIG_BOOTP_NTPSERVER
18621fe80d79SJon Loeliger		CONFIG_BOOTP_TIMEOFFSET
18631fe80d79SJon Loeliger		CONFIG_BOOTP_VENDOREX
18642c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL
1865fe389a82Sstroese
18665d110f0aSWilson Callan		CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
18675d110f0aSWilson Callan		environment variable, not the BOOTP server.
1868fe389a82Sstroese
18692c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
18702c00e099SJoe Hershberger		after the configured retry count, the call will fail
18712c00e099SJoe Hershberger		instead of starting over.  This can be used to fail over
18722c00e099SJoe Hershberger		to Link-local IP address configuration if the DHCP server
18732c00e099SJoe Hershberger		is not available.
18742c00e099SJoe Hershberger
1875fe389a82Sstroese		CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1876fe389a82Sstroese		serverip from a DHCP server, it is possible that more
1877fe389a82Sstroese		than one DNS serverip is offered to the client.
1878fe389a82Sstroese		If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1879fe389a82Sstroese		serverip will be stored in the additional environment
1880fe389a82Sstroese		variable "dnsip2". The first DNS serverip is always
1881fe389a82Sstroese		stored in the variable "dnsip", when CONFIG_BOOTP_DNS
18821fe80d79SJon Loeliger		is defined.
1883fe389a82Sstroese
1884fe389a82Sstroese		CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1885fe389a82Sstroese		to do a dynamic update of a DNS server. To do this, they
1886fe389a82Sstroese		need the hostname of the DHCP requester.
18875d110f0aSWilson Callan		If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
18881fe80d79SJon Loeliger		of the "hostname" environment variable is passed as
18891fe80d79SJon Loeliger		option 12 to the DHCP server.
1890fe389a82Sstroese
1891d9a2f416SAras Vaichas		CONFIG_BOOTP_DHCP_REQUEST_DELAY
1892d9a2f416SAras Vaichas
1893d9a2f416SAras Vaichas		A 32bit value in microseconds for a delay between
1894d9a2f416SAras Vaichas		receiving a "DHCP Offer" and sending the "DHCP Request".
1895d9a2f416SAras Vaichas		This fixes a problem with certain DHCP servers that don't
1896d9a2f416SAras Vaichas		respond 100% of the time to a "DHCP request". E.g. On an
1897d9a2f416SAras Vaichas		AT91RM9200 processor running at 180MHz, this delay needed
1898d9a2f416SAras Vaichas		to be *at least* 15,000 usec before a Windows Server 2003
1899d9a2f416SAras Vaichas		DHCP server would reply 100% of the time. I recommend at
1900d9a2f416SAras Vaichas		least 50,000 usec to be safe. The alternative is to hope
1901d9a2f416SAras Vaichas		that one of the retries will be successful but note that
1902d9a2f416SAras Vaichas		the DHCP timeout and retry process takes a longer than
1903d9a2f416SAras Vaichas		this delay.
1904d9a2f416SAras Vaichas
1905d22c338eSJoe Hershberger - Link-local IP address negotiation:
1906d22c338eSJoe Hershberger		Negotiate with other link-local clients on the local network
1907d22c338eSJoe Hershberger		for an address that doesn't require explicit configuration.
1908d22c338eSJoe Hershberger		This is especially useful if a DHCP server cannot be guaranteed
1909d22c338eSJoe Hershberger		to exist in all environments that the device must operate.
1910d22c338eSJoe Hershberger
1911d22c338eSJoe Hershberger		See doc/README.link-local for more information.
1912d22c338eSJoe Hershberger
1913a3d991bdSwdenk - CDP Options:
1914a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID
1915a3d991bdSwdenk
1916a3d991bdSwdenk		The device id used in CDP trigger frames.
1917a3d991bdSwdenk
1918a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID_PREFIX
1919a3d991bdSwdenk
1920a3d991bdSwdenk		A two character string which is prefixed to the MAC address
1921a3d991bdSwdenk		of the device.
1922a3d991bdSwdenk
1923a3d991bdSwdenk		CONFIG_CDP_PORT_ID
1924a3d991bdSwdenk
1925a3d991bdSwdenk		A printf format string which contains the ascii name of
1926a3d991bdSwdenk		the port. Normally is set to "eth%d" which sets
192711ccc33fSMarcel Ziswiler		eth0 for the first Ethernet, eth1 for the second etc.
1928a3d991bdSwdenk
1929a3d991bdSwdenk		CONFIG_CDP_CAPABILITIES
1930a3d991bdSwdenk
1931a3d991bdSwdenk		A 32bit integer which indicates the device capabilities;
1932a3d991bdSwdenk		0x00000010 for a normal host which does not forwards.
1933a3d991bdSwdenk
1934a3d991bdSwdenk		CONFIG_CDP_VERSION
1935a3d991bdSwdenk
1936a3d991bdSwdenk		An ascii string containing the version of the software.
1937a3d991bdSwdenk
1938a3d991bdSwdenk		CONFIG_CDP_PLATFORM
1939a3d991bdSwdenk
1940a3d991bdSwdenk		An ascii string containing the name of the platform.
1941a3d991bdSwdenk
1942a3d991bdSwdenk		CONFIG_CDP_TRIGGER
1943a3d991bdSwdenk
1944a3d991bdSwdenk		A 32bit integer sent on the trigger.
1945a3d991bdSwdenk
1946a3d991bdSwdenk		CONFIG_CDP_POWER_CONSUMPTION
1947a3d991bdSwdenk
1948a3d991bdSwdenk		A 16bit integer containing the power consumption of the
1949a3d991bdSwdenk		device in .1 of milliwatts.
1950a3d991bdSwdenk
1951a3d991bdSwdenk		CONFIG_CDP_APPLIANCE_VLAN_TYPE
1952a3d991bdSwdenk
1953a3d991bdSwdenk		A byte containing the id of the VLAN.
1954a3d991bdSwdenk
1955c609719bSwdenk- Status LED:	CONFIG_STATUS_LED
1956c609719bSwdenk
1957c609719bSwdenk		Several configurations allow to display the current
1958c609719bSwdenk		status using a LED. For instance, the LED will blink
1959c609719bSwdenk		fast while running U-Boot code, stop blinking as
1960c609719bSwdenk		soon as a reply to a BOOTP request was received, and
1961c609719bSwdenk		start blinking slow once the Linux kernel is running
1962c609719bSwdenk		(supported by a status LED driver in the Linux
1963c609719bSwdenk		kernel). Defining CONFIG_STATUS_LED enables this
1964c609719bSwdenk		feature in U-Boot.
1965c609719bSwdenk
1966c609719bSwdenk- CAN Support:	CONFIG_CAN_DRIVER
1967c609719bSwdenk
1968c609719bSwdenk		Defining CONFIG_CAN_DRIVER enables CAN driver support
1969c609719bSwdenk		on those systems that support this (optional)
1970c609719bSwdenk		feature, like the TQM8xxL modules.
1971c609719bSwdenk
19723f4978c7SHeiko Schocher- I2C Support:	CONFIG_SYS_I2C
1973c609719bSwdenk
19743f4978c7SHeiko Schocher		This enable the NEW i2c subsystem, and will allow you to use
19753f4978c7SHeiko Schocher		i2c commands at the u-boot command line (as long as you set
19763f4978c7SHeiko Schocher		CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
19773f4978c7SHeiko Schocher		based realtime clock chips or other i2c devices. See
19783f4978c7SHeiko Schocher		common/cmd_i2c.c for a description of the command line
19793f4978c7SHeiko Schocher		interface.
19803f4978c7SHeiko Schocher
19813f4978c7SHeiko Schocher		ported i2c driver to the new framework:
1982ea818dbbSHeiko Schocher		- drivers/i2c/soft_i2c.c:
1983ea818dbbSHeiko Schocher		  - activate first bus with CONFIG_SYS_I2C_SOFT define
1984ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
1985ea818dbbSHeiko Schocher		    for defining speed and slave address
1986ea818dbbSHeiko Schocher		  - activate second bus with I2C_SOFT_DECLARATIONS2 define
1987ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
1988ea818dbbSHeiko Schocher		    for defining speed and slave address
1989ea818dbbSHeiko Schocher		  - activate third bus with I2C_SOFT_DECLARATIONS3 define
1990ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
1991ea818dbbSHeiko Schocher		    for defining speed and slave address
1992ea818dbbSHeiko Schocher		  - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
1993ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
1994ea818dbbSHeiko Schocher		    for defining speed and slave address
19953f4978c7SHeiko Schocher
199600f792e0SHeiko Schocher		- drivers/i2c/fsl_i2c.c:
199700f792e0SHeiko Schocher		  - activate i2c driver with CONFIG_SYS_I2C_FSL
199800f792e0SHeiko Schocher		    define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
199900f792e0SHeiko Schocher		    offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
200000f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
200100f792e0SHeiko Schocher		    bus.
200200f792e0SHeiko Schocher		  - If your board supports a second fsl i2c bus, define
200300f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
200400f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_SPEED for the speed and
200500f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
200600f792e0SHeiko Schocher		    second bus.
200700f792e0SHeiko Schocher
20081f2ba722SSimon Glass		- drivers/i2c/tegra_i2c.c:
20091f2ba722SSimon Glass		  - activate this driver with CONFIG_SYS_I2C_TEGRA
20101f2ba722SSimon Glass		  - This driver adds 4 i2c buses with a fix speed from
20111f2ba722SSimon Glass		    100000 and the slave addr 0!
20121f2ba722SSimon Glass
2013880540deSDirk Eibach		- drivers/i2c/ppc4xx_i2c.c
2014880540deSDirk Eibach		  - activate this driver with CONFIG_SYS_I2C_PPC4XX
2015880540deSDirk Eibach		  - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2016880540deSDirk Eibach		  - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2017880540deSDirk Eibach
2018fac96408Strem		- drivers/i2c/i2c_mxc.c
2019fac96408Strem		  - activate this driver with CONFIG_SYS_I2C_MXC
2020fac96408Strem		  - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2021fac96408Strem		  - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2022fac96408Strem		  - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2023fac96408Strem		  - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2024fac96408Strem		  - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2025fac96408Strem		  - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
2026fac96408Strem		If thoses defines are not set, default value is 100000
2027fac96408Strem		for speed, and 0 for slave.
2028fac96408Strem
20291086bfa9SNobuhiro Iwamatsu		- drivers/i2c/rcar_i2c.c:
20301086bfa9SNobuhiro Iwamatsu		  - activate this driver with CONFIG_SYS_I2C_RCAR
20311086bfa9SNobuhiro Iwamatsu		  - This driver adds 4 i2c buses
20321086bfa9SNobuhiro Iwamatsu
20331086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
20341086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
20351086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
20361086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
20371086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
20381086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
20391086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
20401086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
20411086bfa9SNobuhiro Iwamatsu		  - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
20421086bfa9SNobuhiro Iwamatsu
20432035d77dSNobuhiro Iwamatsu		- drivers/i2c/sh_i2c.c:
20442035d77dSNobuhiro Iwamatsu		  - activate this driver with CONFIG_SYS_I2C_SH
20452035d77dSNobuhiro Iwamatsu		  - This driver adds from 2 to 5 i2c buses
20462035d77dSNobuhiro Iwamatsu
20472035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
20482035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
20492035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
20502035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
20512035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
20522035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
20532035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
20542035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
20552035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
20562035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
20572035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
20582035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
20592035d77dSNobuhiro Iwamatsu		  - CONFIF_SYS_I2C_SH_NUM_CONTROLLERS for nummber of i2c buses
20602035d77dSNobuhiro Iwamatsu
20616789e84eSHeiko Schocher		- drivers/i2c/omap24xx_i2c.c
20626789e84eSHeiko Schocher		  - activate this driver with CONFIG_SYS_I2C_OMAP24XX
20636789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
20646789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
20656789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
20666789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
20676789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
20686789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
20696789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
20706789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
20716789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
20726789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
20736789e84eSHeiko Schocher
2074*0bdffe71SHeiko Schocher		- drivers/i2c/zynq_i2c.c
2075*0bdffe71SHeiko Schocher		  - activate this driver with CONFIG_SYS_I2C_ZYNQ
2076*0bdffe71SHeiko Schocher		  - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
2077*0bdffe71SHeiko Schocher		  - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
2078*0bdffe71SHeiko Schocher
20793f4978c7SHeiko Schocher		additional defines:
20803f4978c7SHeiko Schocher
20813f4978c7SHeiko Schocher		CONFIG_SYS_NUM_I2C_BUSES
20823f4978c7SHeiko Schocher		Hold the number of i2c busses you want to use. If you
20833f4978c7SHeiko Schocher		don't use/have i2c muxes on your i2c bus, this
20843f4978c7SHeiko Schocher		is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
20853f4978c7SHeiko Schocher		omit this define.
20863f4978c7SHeiko Schocher
20873f4978c7SHeiko Schocher		CONFIG_SYS_I2C_DIRECT_BUS
20883f4978c7SHeiko Schocher		define this, if you don't use i2c muxes on your hardware.
20893f4978c7SHeiko Schocher		if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
20903f4978c7SHeiko Schocher		omit this define.
20913f4978c7SHeiko Schocher
20923f4978c7SHeiko Schocher		CONFIG_SYS_I2C_MAX_HOPS
20933f4978c7SHeiko Schocher		define how many muxes are maximal consecutively connected
20943f4978c7SHeiko Schocher		on one i2c bus. If you not use i2c muxes, omit this
20953f4978c7SHeiko Schocher		define.
20963f4978c7SHeiko Schocher
20973f4978c7SHeiko Schocher		CONFIG_SYS_I2C_BUSES
20983f4978c7SHeiko Schocher		hold a list of busses you want to use, only used if
20993f4978c7SHeiko Schocher		CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
21003f4978c7SHeiko Schocher		a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
21013f4978c7SHeiko Schocher		CONFIG_SYS_NUM_I2C_BUSES = 9:
21023f4978c7SHeiko Schocher
21033f4978c7SHeiko Schocher		 CONFIG_SYS_I2C_BUSES	{{0, {I2C_NULL_HOP}}, \
21043f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
21053f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
21063f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
21073f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
21083f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
21093f4978c7SHeiko Schocher					{1, {I2C_NULL_HOP}}, \
21103f4978c7SHeiko Schocher					{1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
21113f4978c7SHeiko Schocher					{1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
21123f4978c7SHeiko Schocher					}
21133f4978c7SHeiko Schocher
21143f4978c7SHeiko Schocher		which defines
21153f4978c7SHeiko Schocher			bus 0 on adapter 0 without a mux
2116ea818dbbSHeiko Schocher			bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2117ea818dbbSHeiko Schocher			bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2118ea818dbbSHeiko Schocher			bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2119ea818dbbSHeiko Schocher			bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2120ea818dbbSHeiko Schocher			bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
21213f4978c7SHeiko Schocher			bus 6 on adapter 1 without a mux
2122ea818dbbSHeiko Schocher			bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2123ea818dbbSHeiko Schocher			bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
21243f4978c7SHeiko Schocher
21253f4978c7SHeiko Schocher		If you do not have i2c muxes on your board, omit this define.
21263f4978c7SHeiko Schocher
2127ea818dbbSHeiko Schocher- Legacy I2C Support:	CONFIG_HARD_I2C
21283f4978c7SHeiko Schocher
21293f4978c7SHeiko Schocher		NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
21303f4978c7SHeiko Schocher		provides the following compelling advantages:
21313f4978c7SHeiko Schocher
21323f4978c7SHeiko Schocher		- more than one i2c adapter is usable
21333f4978c7SHeiko Schocher		- approved multibus support
21343f4978c7SHeiko Schocher		- better i2c mux support
21353f4978c7SHeiko Schocher
21363f4978c7SHeiko Schocher		** Please consider updating your I2C driver now. **
21373f4978c7SHeiko Schocher
2138ea818dbbSHeiko Schocher		These enable legacy I2C serial bus commands. Defining
2139ea818dbbSHeiko Schocher		CONFIG_HARD_I2C will include the appropriate I2C driver
2140ea818dbbSHeiko Schocher		for the selected CPU.
2141c609719bSwdenk
2142b37c7e5eSwdenk		This will allow you to use i2c commands at the u-boot
2143602ad3b3SJon Loeliger		command line (as long as you set CONFIG_CMD_I2C in
2144b37c7e5eSwdenk		CONFIG_COMMANDS) and communicate with i2c based realtime
2145b37c7e5eSwdenk		clock chips. See common/cmd_i2c.c for a description of the
2146c609719bSwdenk		command line interface.
2147c609719bSwdenk
2148bb99ad6dSBen Warren		CONFIG_HARD_I2C selects a hardware I2C controller.
2149c609719bSwdenk
2150b37c7e5eSwdenk		There are several other quantities that must also be
2151ea818dbbSHeiko Schocher		defined when you define CONFIG_HARD_I2C.
2152c609719bSwdenk
21536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		In both cases you will need to define CONFIG_SYS_I2C_SPEED
2154b37c7e5eSwdenk		to be the frequency (in Hz) at which you wish your i2c bus
21556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
215611ccc33fSMarcel Ziswiler		the CPU's i2c node address).
2157c609719bSwdenk
21588d321b81SPeter Tyser		Now, the u-boot i2c code for the mpc8xx
2159a47a12beSStefan Roese		(arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
21608d321b81SPeter Tyser		and so its address should therefore be cleared to 0 (See,
21618d321b81SPeter Tyser		eg, MPC823e User's Manual p.16-473). So, set
21628d321b81SPeter Tyser		CONFIG_SYS_I2C_SLAVE to 0.
2163b37c7e5eSwdenk
21645da71efaSEric Millbrandt		CONFIG_SYS_I2C_INIT_MPC5XXX
21655da71efaSEric Millbrandt
21665da71efaSEric Millbrandt		When a board is reset during an i2c bus transfer
21675da71efaSEric Millbrandt		chips might think that the current transfer is still
21685da71efaSEric Millbrandt		in progress.  Reset the slave devices by sending start
21695da71efaSEric Millbrandt		commands until the slave device responds.
21705da71efaSEric Millbrandt
2171b37c7e5eSwdenk		That's all that's required for CONFIG_HARD_I2C.
2172b37c7e5eSwdenk
2173ea818dbbSHeiko Schocher		If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
2174b37c7e5eSwdenk		then the following macros need to be defined (examples are
2175b37c7e5eSwdenk		from include/configs/lwmon.h):
2176c609719bSwdenk
2177c609719bSwdenk		I2C_INIT
2178c609719bSwdenk
2179b37c7e5eSwdenk		(Optional). Any commands necessary to enable the I2C
2180c609719bSwdenk		controller or configure ports.
2181c609719bSwdenk
2182b37c7e5eSwdenk		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
2183b37c7e5eSwdenk
2184c609719bSwdenk		I2C_PORT
2185c609719bSwdenk
2186c609719bSwdenk		(Only for MPC8260 CPU). The I/O port to use (the code
2187c609719bSwdenk		assumes both bits are on the same port). Valid values
2188c609719bSwdenk		are 0..3 for ports A..D.
2189c609719bSwdenk
2190c609719bSwdenk		I2C_ACTIVE
2191c609719bSwdenk
2192c609719bSwdenk		The code necessary to make the I2C data line active
2193c609719bSwdenk		(driven).  If the data line is open collector, this
2194c609719bSwdenk		define can be null.
2195c609719bSwdenk
2196b37c7e5eSwdenk		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
2197b37c7e5eSwdenk
2198c609719bSwdenk		I2C_TRISTATE
2199c609719bSwdenk
2200c609719bSwdenk		The code necessary to make the I2C data line tri-stated
2201c609719bSwdenk		(inactive).  If the data line is open collector, this
2202c609719bSwdenk		define can be null.
2203c609719bSwdenk
2204b37c7e5eSwdenk		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2205b37c7e5eSwdenk
2206c609719bSwdenk		I2C_READ
2207c609719bSwdenk
2208472d5460SYork Sun		Code that returns true if the I2C data line is high,
2209472d5460SYork Sun		false if it is low.
2210c609719bSwdenk
2211b37c7e5eSwdenk		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2212b37c7e5eSwdenk
2213c609719bSwdenk		I2C_SDA(bit)
2214c609719bSwdenk
2215472d5460SYork Sun		If <bit> is true, sets the I2C data line high. If it
2216472d5460SYork Sun		is false, it clears it (low).
2217c609719bSwdenk
2218b37c7e5eSwdenk		eg: #define I2C_SDA(bit) \
2219b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
2220b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
2221b37c7e5eSwdenk
2222c609719bSwdenk		I2C_SCL(bit)
2223c609719bSwdenk
2224472d5460SYork Sun		If <bit> is true, sets the I2C clock line high. If it
2225472d5460SYork Sun		is false, it clears it (low).
2226c609719bSwdenk
2227b37c7e5eSwdenk		eg: #define I2C_SCL(bit) \
2228b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
2229b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
2230b37c7e5eSwdenk
2231c609719bSwdenk		I2C_DELAY
2232c609719bSwdenk
2233c609719bSwdenk		This delay is invoked four times per clock cycle so this
2234c609719bSwdenk		controls the rate of data transfer.  The data rate thus
2235b37c7e5eSwdenk		is 1 / (I2C_DELAY * 4). Often defined to be something
2236b37c7e5eSwdenk		like:
2237b37c7e5eSwdenk
2238b37c7e5eSwdenk		#define I2C_DELAY  udelay(2)
2239c609719bSwdenk
2240793b5726SMike Frysinger		CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2241793b5726SMike Frysinger
2242793b5726SMike Frysinger		If your arch supports the generic GPIO framework (asm/gpio.h),
2243793b5726SMike Frysinger		then you may alternatively define the two GPIOs that are to be
2244793b5726SMike Frysinger		used as SCL / SDA.  Any of the previous I2C_xxx macros will
2245793b5726SMike Frysinger		have GPIO-based defaults assigned to them as appropriate.
2246793b5726SMike Frysinger
2247793b5726SMike Frysinger		You should define these to the GPIO value as given directly to
2248793b5726SMike Frysinger		the generic GPIO functions.
2249793b5726SMike Frysinger
22506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_INIT_BOARD
225147cd00faSwdenk
225247cd00faSwdenk		When a board is reset during an i2c bus transfer
225347cd00faSwdenk		chips might think that the current transfer is still
225447cd00faSwdenk		in progress. On some boards it is possible to access
225547cd00faSwdenk		the i2c SCLK line directly, either by using the
225647cd00faSwdenk		processor pin as a GPIO or by having a second pin
225747cd00faSwdenk		connected to the bus. If this option is defined a
225847cd00faSwdenk		custom i2c_init_board() routine in boards/xxx/board.c
225947cd00faSwdenk		is run early in the boot sequence.
226047cd00faSwdenk
226126a33504SRichard Retanubun		CONFIG_SYS_I2C_BOARD_LATE_INIT
226226a33504SRichard Retanubun
226326a33504SRichard Retanubun		An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
226426a33504SRichard Retanubun		defined a custom i2c_board_late_init() routine in
226526a33504SRichard Retanubun		boards/xxx/board.c is run AFTER the operations in i2c_init()
226626a33504SRichard Retanubun		is completed. This callpoint can be used to unreset i2c bus
226726a33504SRichard Retanubun		using CPU i2c controller register accesses for CPUs whose i2c
226826a33504SRichard Retanubun		controller provide such a method. It is called at the end of
226926a33504SRichard Retanubun		i2c_init() to allow i2c_init operations to setup the i2c bus
227026a33504SRichard Retanubun		controller on the CPU (e.g. setting bus speed & slave address).
227126a33504SRichard Retanubun
227217ea1177Swdenk		CONFIG_I2CFAST (PPC405GP|PPC405EP only)
227317ea1177Swdenk
227417ea1177Swdenk		This option enables configuration of bi_iic_fast[] flags
227517ea1177Swdenk		in u-boot bd_info structure based on u-boot environment
227617ea1177Swdenk		variable "i2cfast". (see also i2cfast)
227717ea1177Swdenk
2278bb99ad6dSBen Warren		CONFIG_I2C_MULTI_BUS
2279bb99ad6dSBen Warren
2280bb99ad6dSBen Warren		This option allows the use of multiple I2C buses, each of which
2281bb99ad6dSBen Warren		must have a controller.	 At any point in time, only one bus is
2282bb99ad6dSBen Warren		active.	 To switch to a different bus, use the 'i2c dev' command.
2283bb99ad6dSBen Warren		Note that bus numbering is zero-based.
2284bb99ad6dSBen Warren
22856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_NOPROBES
2286bb99ad6dSBen Warren
2287bb99ad6dSBen Warren		This option specifies a list of I2C devices that will be skipped
22880f89c54bSPeter Tyser		when the 'i2c probe' command is issued.	 If CONFIG_I2C_MULTI_BUS
22890f89c54bSPeter Tyser		is set, specify a list of bus-device pairs.  Otherwise, specify
22900f89c54bSPeter Tyser		a 1D array of device addresses
2291bb99ad6dSBen Warren
2292bb99ad6dSBen Warren		e.g.
2293bb99ad6dSBen Warren			#undef	CONFIG_I2C_MULTI_BUS
22946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
2295bb99ad6dSBen Warren
2296bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on a board with one I2C bus
2297bb99ad6dSBen Warren
2298bb99ad6dSBen Warren			#define CONFIG_I2C_MULTI_BUS
22996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_MULTI_NOPROBES	{{0,0x50},{0,0x68},{1,0x54}}
2300bb99ad6dSBen Warren
2301bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2302bb99ad6dSBen Warren
23036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SPD_BUS_NUM
2304be5e6181STimur Tabi
2305be5e6181STimur Tabi		If defined, then this indicates the I2C bus number for DDR SPD.
2306be5e6181STimur Tabi		If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2307be5e6181STimur Tabi
23086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_BUS_NUM
23090dc018ecSStefan Roese
23100dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the RTC.
23110dc018ecSStefan Roese		If not defined, then U-Boot assumes that RTC is on I2C bus 0.
23120dc018ecSStefan Roese
23136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_DTT_BUS_NUM
23140dc018ecSStefan Roese
23150dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the DTT.
23160dc018ecSStefan Roese		If not defined, then U-Boot assumes that DTT is on I2C bus 0.
23170dc018ecSStefan Roese
23186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_DTT_ADDR:
23199ebbb54fSVictor Gallardo
23209ebbb54fSVictor Gallardo		If defined, specifies the I2C address of the DTT device.
23219ebbb54fSVictor Gallardo		If not defined, then U-Boot uses predefined value for
23229ebbb54fSVictor Gallardo		specified DTT device.
23239ebbb54fSVictor Gallardo
23242ac6985aSAndrew Dyer		CONFIG_SOFT_I2C_READ_REPEATED_START
23252ac6985aSAndrew Dyer
23262ac6985aSAndrew Dyer		defining this will force the i2c_read() function in
23272ac6985aSAndrew Dyer		the soft_i2c driver to perform an I2C repeated start
23282ac6985aSAndrew Dyer		between writing the address pointer and reading the
23292ac6985aSAndrew Dyer		data.  If this define is omitted the default behaviour
23302ac6985aSAndrew Dyer		of doing a stop-start sequence will be used.  Most I2C
23312ac6985aSAndrew Dyer		devices can use either method, but some require one or
23322ac6985aSAndrew Dyer		the other.
2333be5e6181STimur Tabi
2334c609719bSwdenk- SPI Support:	CONFIG_SPI
2335c609719bSwdenk
2336c609719bSwdenk		Enables SPI driver (so far only tested with
2337c609719bSwdenk		SPI EEPROM, also an instance works with Crystal A/D and
2338c609719bSwdenk		D/As on the SACSng board)
2339c609719bSwdenk
23406639562eSYoshihiro Shimoda		CONFIG_SH_SPI
23416639562eSYoshihiro Shimoda
23426639562eSYoshihiro Shimoda		Enables the driver for SPI controller on SuperH. Currently
23436639562eSYoshihiro Shimoda		only SH7757 is supported.
23446639562eSYoshihiro Shimoda
2345c609719bSwdenk		CONFIG_SPI_X
2346c609719bSwdenk
2347c609719bSwdenk		Enables extended (16-bit) SPI EEPROM addressing.
2348c609719bSwdenk		(symmetrical to CONFIG_I2C_X)
2349c609719bSwdenk
2350c609719bSwdenk		CONFIG_SOFT_SPI
2351c609719bSwdenk
2352c609719bSwdenk		Enables a software (bit-bang) SPI driver rather than
2353c609719bSwdenk		using hardware support. This is a general purpose
2354c609719bSwdenk		driver that only requires three general I/O port pins
2355c609719bSwdenk		(two outputs, one input) to function. If this is
2356c609719bSwdenk		defined, the board configuration must define several
2357c609719bSwdenk		SPI configuration items (port pins to use, etc). For
2358c609719bSwdenk		an example, see include/configs/sacsng.h.
2359c609719bSwdenk
236004a9e118SBen Warren		CONFIG_HARD_SPI
236104a9e118SBen Warren
236204a9e118SBen Warren		Enables a hardware SPI driver for general-purpose reads
236304a9e118SBen Warren		and writes.  As with CONFIG_SOFT_SPI, the board configuration
236404a9e118SBen Warren		must define a list of chip-select function pointers.
236504a9e118SBen Warren		Currently supported on some MPC8xxx processors.	 For an
236604a9e118SBen Warren		example, see include/configs/mpc8349emds.h.
236704a9e118SBen Warren
236838254f45SGuennadi Liakhovetski		CONFIG_MXC_SPI
236938254f45SGuennadi Liakhovetski
237038254f45SGuennadi Liakhovetski		Enables the driver for the SPI controllers on i.MX and MXC
23712e3cd1cdSFabio Estevam		SoCs. Currently i.MX31/35/51 are supported.
237238254f45SGuennadi Liakhovetski
23730133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA
23740133502eSMatthias Fuchs
23750133502eSMatthias Fuchs		Enables FPGA subsystem.
23760133502eSMatthias Fuchs
23770133502eSMatthias Fuchs		CONFIG_FPGA_<vendor>
23780133502eSMatthias Fuchs
23790133502eSMatthias Fuchs		Enables support for specific chip vendors.
23800133502eSMatthias Fuchs		(ALTERA, XILINX)
23810133502eSMatthias Fuchs
23820133502eSMatthias Fuchs		CONFIG_FPGA_<family>
23830133502eSMatthias Fuchs
23840133502eSMatthias Fuchs		Enables support for FPGA family.
23850133502eSMatthias Fuchs		(SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
23860133502eSMatthias Fuchs
23870133502eSMatthias Fuchs		CONFIG_FPGA_COUNT
2388c609719bSwdenk
2389c609719bSwdenk		Specify the number of FPGA devices to support.
2390c609719bSwdenk
23916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_PROG_FEEDBACK
2392c609719bSwdenk
2393c609719bSwdenk		Enable printing of hash marks during FPGA configuration.
2394c609719bSwdenk
23956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_BUSY
2396c609719bSwdenk
2397c609719bSwdenk		Enable checks on FPGA configuration interface busy
2398c609719bSwdenk		status by the configuration function. This option
2399c609719bSwdenk		will require a board or device specific function to
2400c609719bSwdenk		be written.
2401c609719bSwdenk
2402c609719bSwdenk		CONFIG_FPGA_DELAY
2403c609719bSwdenk
2404c609719bSwdenk		If defined, a function that provides delays in the FPGA
2405c609719bSwdenk		configuration driver.
2406c609719bSwdenk
24076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_CTRLC
2408c609719bSwdenk		Allow Control-C to interrupt FPGA configuration
2409c609719bSwdenk
24106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_ERROR
2411c609719bSwdenk
2412c609719bSwdenk		Check for configuration errors during FPGA bitfile
2413c609719bSwdenk		loading. For example, abort during Virtex II
2414c609719bSwdenk		configuration if the INIT_B line goes low (which
2415c609719bSwdenk		indicated a CRC error).
2416c609719bSwdenk
24176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_INIT
2418c609719bSwdenk
2419c609719bSwdenk		Maximum time to wait for the INIT_B line to deassert
2420c609719bSwdenk		after PROB_B has been deasserted during a Virtex II
2421c609719bSwdenk		FPGA configuration sequence. The default time is 500
242211ccc33fSMarcel Ziswiler		ms.
2423c609719bSwdenk
24246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_BUSY
2425c609719bSwdenk
2426c609719bSwdenk		Maximum time to wait for BUSY to deassert during
242711ccc33fSMarcel Ziswiler		Virtex II FPGA configuration. The default is 5 ms.
2428c609719bSwdenk
24296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_CONFIG
2430c609719bSwdenk
2431c609719bSwdenk		Time to wait after FPGA configuration. The default is
243211ccc33fSMarcel Ziswiler		200 ms.
2433c609719bSwdenk
2434c609719bSwdenk- Configuration Management:
2435c609719bSwdenk		CONFIG_IDENT_STRING
2436c609719bSwdenk
2437c609719bSwdenk		If defined, this string will be added to the U-Boot
2438c609719bSwdenk		version information (U_BOOT_VERSION)
2439c609719bSwdenk
2440c609719bSwdenk- Vendor Parameter Protection:
2441c609719bSwdenk
2442c609719bSwdenk		U-Boot considers the values of the environment
2443c609719bSwdenk		variables "serial#" (Board Serial Number) and
24447152b1d0Swdenk		"ethaddr" (Ethernet Address) to be parameters that
2445c609719bSwdenk		are set once by the board vendor / manufacturer, and
2446c609719bSwdenk		protects these variables from casual modification by
2447c609719bSwdenk		the user. Once set, these variables are read-only,
2448c609719bSwdenk		and write or delete attempts are rejected. You can
244911ccc33fSMarcel Ziswiler		change this behaviour:
2450c609719bSwdenk
2451c609719bSwdenk		If CONFIG_ENV_OVERWRITE is #defined in your config
2452c609719bSwdenk		file, the write protection for vendor parameters is
245347cd00faSwdenk		completely disabled. Anybody can change or delete
2454c609719bSwdenk		these parameters.
2455c609719bSwdenk
2456c609719bSwdenk		Alternatively, if you #define _both_ CONFIG_ETHADDR
2457c609719bSwdenk		_and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
245811ccc33fSMarcel Ziswiler		Ethernet address is installed in the environment,
2459c609719bSwdenk		which can be changed exactly ONCE by the user. [The
2460c609719bSwdenk		serial# is unaffected by this, i. e. it remains
2461c609719bSwdenk		read-only.]
2462c609719bSwdenk
24632598090bSJoe Hershberger		The same can be accomplished in a more flexible way
24642598090bSJoe Hershberger		for any variable by configuring the type of access
24652598090bSJoe Hershberger		to allow for those variables in the ".flags" variable
24662598090bSJoe Hershberger		or define CONFIG_ENV_FLAGS_LIST_STATIC.
24672598090bSJoe Hershberger
2468c609719bSwdenk- Protected RAM:
2469c609719bSwdenk		CONFIG_PRAM
2470c609719bSwdenk
2471c609719bSwdenk		Define this variable to enable the reservation of
2472c609719bSwdenk		"protected RAM", i. e. RAM which is not overwritten
2473c609719bSwdenk		by U-Boot. Define CONFIG_PRAM to hold the number of
2474c609719bSwdenk		kB you want to reserve for pRAM. You can overwrite
2475c609719bSwdenk		this default value by defining an environment
2476c609719bSwdenk		variable "pram" to the number of kB you want to
2477c609719bSwdenk		reserve. Note that the board info structure will
2478c609719bSwdenk		still show the full amount of RAM. If pRAM is
2479c609719bSwdenk		reserved, a new environment variable "mem" will
2480c609719bSwdenk		automatically be defined to hold the amount of
2481c609719bSwdenk		remaining RAM in a form that can be passed as boot
2482c609719bSwdenk		argument to Linux, for instance like that:
2483c609719bSwdenk
2484fe126d8bSWolfgang Denk			setenv bootargs ... mem=\${mem}
2485c609719bSwdenk			saveenv
2486c609719bSwdenk
2487c609719bSwdenk		This way you can tell Linux not to use this memory,
2488c609719bSwdenk		either, which results in a memory region that will
2489c609719bSwdenk		not be affected by reboots.
2490c609719bSwdenk
2491c609719bSwdenk		*WARNING* If your board configuration uses automatic
2492c609719bSwdenk		detection of the RAM size, you must make sure that
2493c609719bSwdenk		this memory test is non-destructive. So far, the
2494c609719bSwdenk		following board configurations are known to be
2495c609719bSwdenk		"pRAM-clean":
2496c609719bSwdenk
24971b0757ecSWolfgang Denk			IVMS8, IVML24, SPD8xx, TQM8xxL,
24981b0757ecSWolfgang Denk			HERMES, IP860, RPXlite, LWMON,
2499544d97e9SWolfgang Denk			FLAGADM, TQM8260
2500c609719bSwdenk
250140fef049SGabe Black- Access to physical memory region (> 4GB)
250240fef049SGabe Black		Some basic support is provided for operations on memory not
250340fef049SGabe Black		normally accessible to U-Boot - e.g. some architectures
250440fef049SGabe Black		support access to more than 4GB of memory on 32-bit
250540fef049SGabe Black		machines using physical address extension or similar.
250640fef049SGabe Black		Define CONFIG_PHYSMEM to access this basic support, which
250740fef049SGabe Black		currently only supports clearing the memory.
250840fef049SGabe Black
2509c609719bSwdenk- Error Recovery:
2510c609719bSwdenk		CONFIG_PANIC_HANG
2511c609719bSwdenk
2512c609719bSwdenk		Define this variable to stop the system in case of a
2513c609719bSwdenk		fatal error, so that you have to reset it manually.
2514c609719bSwdenk		This is probably NOT a good idea for an embedded
251511ccc33fSMarcel Ziswiler		system where you want the system to reboot
2516c609719bSwdenk		automatically as fast as possible, but it may be
2517c609719bSwdenk		useful during development since you can try to debug
2518c609719bSwdenk		the conditions that lead to the situation.
2519c609719bSwdenk
2520c609719bSwdenk		CONFIG_NET_RETRY_COUNT
2521c609719bSwdenk
2522c609719bSwdenk		This variable defines the number of retries for
2523c609719bSwdenk		network operations like ARP, RARP, TFTP, or BOOTP
2524c609719bSwdenk		before giving up the operation. If not defined, a
2525c609719bSwdenk		default value of 5 is used.
2526c609719bSwdenk
252740cb90eeSGuennadi Liakhovetski		CONFIG_ARP_TIMEOUT
252840cb90eeSGuennadi Liakhovetski
252940cb90eeSGuennadi Liakhovetski		Timeout waiting for an ARP reply in milliseconds.
253040cb90eeSGuennadi Liakhovetski
253148a3e999STetsuyuki Kobayashi		CONFIG_NFS_TIMEOUT
253248a3e999STetsuyuki Kobayashi
253348a3e999STetsuyuki Kobayashi		Timeout in milliseconds used in NFS protocol.
253448a3e999STetsuyuki Kobayashi		If you encounter "ERROR: Cannot umount" in nfs command,
253548a3e999STetsuyuki Kobayashi		try longer timeout such as
253648a3e999STetsuyuki Kobayashi		#define CONFIG_NFS_TIMEOUT 10000UL
253748a3e999STetsuyuki Kobayashi
2538c609719bSwdenk- Command Interpreter:
25398078f1a5SWolfgang Denk		CONFIG_AUTO_COMPLETE
254004a85b3bSwdenk
254104a85b3bSwdenk		Enable auto completion of commands using TAB.
254204a85b3bSwdenk
25438078f1a5SWolfgang Denk		Note that this feature has NOT been implemented yet
25448078f1a5SWolfgang Denk		for the "hush" shell.
25458078f1a5SWolfgang Denk
25468078f1a5SWolfgang Denk
25476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_HUSH_PARSER
2548c609719bSwdenk
2549c609719bSwdenk		Define this variable to enable the "hush" shell (from
2550c609719bSwdenk		Busybox) as command line interpreter, thus enabling
2551c609719bSwdenk		powerful command line syntax like
2552c609719bSwdenk		if...then...else...fi conditionals or `&&' and '||'
2553c609719bSwdenk		constructs ("shell scripts").
2554c609719bSwdenk
2555c609719bSwdenk		If undefined, you get the old, much simpler behaviour
2556c609719bSwdenk		with a somewhat smaller memory footprint.
2557c609719bSwdenk
2558c609719bSwdenk
25596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_PROMPT_HUSH_PS2
2560c609719bSwdenk
2561c609719bSwdenk		This defines the secondary prompt string, which is
2562c609719bSwdenk		printed when the command interpreter needs more input
2563c609719bSwdenk		to complete a command. Usually "> ".
2564c609719bSwdenk
2565c609719bSwdenk	Note:
2566c609719bSwdenk
2567c609719bSwdenk		In the current implementation, the local variables
2568c609719bSwdenk		space and global environment variables space are
2569c609719bSwdenk		separated. Local variables are those you define by
25703b57fe0aSwdenk		simply typing `name=value'. To access a local
2571c609719bSwdenk		variable later on, you have write `$name' or
25723b57fe0aSwdenk		`${name}'; to execute the contents of a variable
25733b57fe0aSwdenk		directly type `$name' at the command prompt.
2574c609719bSwdenk
2575c609719bSwdenk		Global environment variables are those you use
2576c609719bSwdenk		setenv/printenv to work with. To run a command stored
2577c609719bSwdenk		in such a variable, you need to use the run command,
2578c609719bSwdenk		and you must not use the '$' sign to access them.
2579c609719bSwdenk
2580c609719bSwdenk		To store commands and special characters in a
2581c609719bSwdenk		variable, please use double quotation marks
2582c609719bSwdenk		surrounding the whole text of the variable, instead
2583c609719bSwdenk		of the backslashes before semicolons and special
2584c609719bSwdenk		symbols.
2585c609719bSwdenk
2586aa0c71acSWolfgang Denk- Commandline Editing and History:
2587aa0c71acSWolfgang Denk		CONFIG_CMDLINE_EDITING
2588aa0c71acSWolfgang Denk
258911ccc33fSMarcel Ziswiler		Enable editing and History functions for interactive
2590aa0c71acSWolfgang Denk		commandline input operations
2591aa0c71acSWolfgang Denk
2592a8c7c708Swdenk- Default Environment:
2593c609719bSwdenk		CONFIG_EXTRA_ENV_SETTINGS
2594c609719bSwdenk
2595c609719bSwdenk		Define this to contain any number of null terminated
2596c609719bSwdenk		strings (variable = value pairs) that will be part of
25977152b1d0Swdenk		the default environment compiled into the boot image.
25982262cfeeSwdenk
2599c609719bSwdenk		For example, place something like this in your
2600c609719bSwdenk		board's config file:
2601c609719bSwdenk
2602c609719bSwdenk		#define CONFIG_EXTRA_ENV_SETTINGS \
2603c609719bSwdenk			"myvar1=value1\0" \
2604c609719bSwdenk			"myvar2=value2\0"
2605c609719bSwdenk
2606c609719bSwdenk		Warning: This method is based on knowledge about the
2607c609719bSwdenk		internal format how the environment is stored by the
26082262cfeeSwdenk		U-Boot code. This is NOT an official, exported
2609c609719bSwdenk		interface! Although it is unlikely that this format
26107152b1d0Swdenk		will change soon, there is no guarantee either.
2611c609719bSwdenk		You better know what you are doing here.
2612c609719bSwdenk
2613c609719bSwdenk		Note: overly (ab)use of the default environment is
2614c609719bSwdenk		discouraged. Make sure to check other ways to preset
261574de7aefSWolfgang Denk		the environment like the "source" command or the
2616c609719bSwdenk		boot command first.
2617c609719bSwdenk
26185e724ca2SStephen Warren		CONFIG_ENV_VARS_UBOOT_CONFIG
26195e724ca2SStephen Warren
26205e724ca2SStephen Warren		Define this in order to add variables describing the
26215e724ca2SStephen Warren		U-Boot build configuration to the default environment.
26225e724ca2SStephen Warren		These will be named arch, cpu, board, vendor, and soc.
26235e724ca2SStephen Warren
26245e724ca2SStephen Warren		Enabling this option will cause the following to be defined:
26255e724ca2SStephen Warren
26265e724ca2SStephen Warren		- CONFIG_SYS_ARCH
26275e724ca2SStephen Warren		- CONFIG_SYS_CPU
26285e724ca2SStephen Warren		- CONFIG_SYS_BOARD
26295e724ca2SStephen Warren		- CONFIG_SYS_VENDOR
26305e724ca2SStephen Warren		- CONFIG_SYS_SOC
26315e724ca2SStephen Warren
26327e27f89fSTom Rini		CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
26337e27f89fSTom Rini
26347e27f89fSTom Rini		Define this in order to add variables describing certain
26357e27f89fSTom Rini		run-time determined information about the hardware to the
26367e27f89fSTom Rini		environment.  These will be named board_name, board_rev.
26377e27f89fSTom Rini
263806fd8538SSimon Glass		CONFIG_DELAY_ENVIRONMENT
263906fd8538SSimon Glass
264006fd8538SSimon Glass		Normally the environment is loaded when the board is
264106fd8538SSimon Glass		intialised so that it is available to U-Boot. This inhibits
264206fd8538SSimon Glass		that so that the environment is not available until
264306fd8538SSimon Glass		explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
264406fd8538SSimon Glass		this is instead controlled by the value of
264506fd8538SSimon Glass		/config/load-environment.
264606fd8538SSimon Glass
2647a8c7c708Swdenk- DataFlash Support:
26482abbe075Swdenk		CONFIG_HAS_DATAFLASH
26492abbe075Swdenk
26502abbe075Swdenk		Defining this option enables DataFlash features and
26512abbe075Swdenk		allows to read/write in Dataflash via the standard
26522abbe075Swdenk		commands cp, md...
26532abbe075Swdenk
2654f61ec45eSEric Nelson- Serial Flash support
2655f61ec45eSEric Nelson		CONFIG_CMD_SF
2656f61ec45eSEric Nelson
2657f61ec45eSEric Nelson		Defining this option enables SPI flash commands
2658f61ec45eSEric Nelson		'sf probe/read/write/erase/update'.
2659f61ec45eSEric Nelson
2660f61ec45eSEric Nelson		Usage requires an initial 'probe' to define the serial
2661f61ec45eSEric Nelson		flash parameters, followed by read/write/erase/update
2662f61ec45eSEric Nelson		commands.
2663f61ec45eSEric Nelson
2664f61ec45eSEric Nelson		The following defaults may be provided by the platform
2665f61ec45eSEric Nelson		to handle the common case when only a single serial
2666f61ec45eSEric Nelson		flash is present on the system.
2667f61ec45eSEric Nelson
2668f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_BUS		Bus identifier
2669f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_CS		Chip-select
2670f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_MODE 		(see include/spi.h)
2671f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_SPEED		in Hz
2672f61ec45eSEric Nelson
267324007273SSimon Glass		CONFIG_CMD_SF_TEST
267424007273SSimon Glass
267524007273SSimon Glass		Define this option to include a destructive SPI flash
267624007273SSimon Glass		test ('sf test').
267724007273SSimon Glass
26781dcd6d03SJagannadha Sutradharudu Teki		CONFIG_SPI_FLASH_BAR		Ban/Extended Addr Reg
26791dcd6d03SJagannadha Sutradharudu Teki
26801dcd6d03SJagannadha Sutradharudu Teki		Define this option to use the Bank addr/Extended addr
26811dcd6d03SJagannadha Sutradharudu Teki		support on SPI flashes which has size > 16Mbytes.
26821dcd6d03SJagannadha Sutradharudu Teki
26833f85ce27Swdenk- SystemACE Support:
26843f85ce27Swdenk		CONFIG_SYSTEMACE
26853f85ce27Swdenk
26863f85ce27Swdenk		Adding this option adds support for Xilinx SystemACE
26873f85ce27Swdenk		chips attached via some sort of local bus. The address
268811ccc33fSMarcel Ziswiler		of the chip must also be defined in the
26896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SYSTEMACE_BASE macro. For example:
26903f85ce27Swdenk
26913f85ce27Swdenk		#define CONFIG_SYSTEMACE
26926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
26933f85ce27Swdenk
26943f85ce27Swdenk		When SystemACE support is added, the "ace" device type
26953f85ce27Swdenk		becomes available to the fat commands, i.e. fatls.
26963f85ce27Swdenk
2697ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port:
2698ecb0ccd9SWolfgang Denk		CONFIG_TFTP_PORT
2699ecb0ccd9SWolfgang Denk
270028cb9375SWolfgang Denk		If this is defined, the environment variable tftpsrcp
2701ecb0ccd9SWolfgang Denk		is used to supply the TFTP UDP source port value.
270228cb9375SWolfgang Denk		If tftpsrcp isn't defined, the normal pseudo-random port
2703ecb0ccd9SWolfgang Denk		number generator is used.
2704ecb0ccd9SWolfgang Denk
270528cb9375SWolfgang Denk		Also, the environment variable tftpdstp is used to supply
270628cb9375SWolfgang Denk		the TFTP UDP destination port value.  If tftpdstp isn't
270728cb9375SWolfgang Denk		defined, the normal port 69 is used.
270828cb9375SWolfgang Denk
270928cb9375SWolfgang Denk		The purpose for tftpsrcp is to allow a TFTP server to
2710ecb0ccd9SWolfgang Denk		blindly start the TFTP transfer using the pre-configured
2711ecb0ccd9SWolfgang Denk		target IP address and UDP port. This has the effect of
2712ecb0ccd9SWolfgang Denk		"punching through" the (Windows XP) firewall, allowing
2713ecb0ccd9SWolfgang Denk		the remainder of the TFTP transfer to proceed normally.
2714ecb0ccd9SWolfgang Denk		A better solution is to properly configure the firewall,
2715ecb0ccd9SWolfgang Denk		but sometimes that is not allowed.
2716ecb0ccd9SWolfgang Denk
2717bf36c5d5SSimon Glass- Hashing support:
2718bf36c5d5SSimon Glass		CONFIG_CMD_HASH
2719bf36c5d5SSimon Glass
2720bf36c5d5SSimon Glass		This enables a generic 'hash' command which can produce
2721bf36c5d5SSimon Glass		hashes / digests from a few algorithms (e.g. SHA1, SHA256).
2722bf36c5d5SSimon Glass
2723bf36c5d5SSimon Glass		CONFIG_HASH_VERIFY
2724bf36c5d5SSimon Glass
2725bf36c5d5SSimon Glass		Enable the hash verify command (hash -v). This adds to code
2726bf36c5d5SSimon Glass		size a little.
2727bf36c5d5SSimon Glass
2728bf36c5d5SSimon Glass		CONFIG_SHA1 - support SHA1 hashing
2729bf36c5d5SSimon Glass		CONFIG_SHA256 - support SHA256 hashing
2730bf36c5d5SSimon Glass
2731bf36c5d5SSimon Glass		Note: There is also a sha1sum command, which should perhaps
2732bf36c5d5SSimon Glass		be deprecated in favour of 'hash sha1'.
2733bf36c5d5SSimon Glass
2734a11f1873SRobert Winkler- Freescale i.MX specific commands:
2735a11f1873SRobert Winkler		CONFIG_CMD_HDMIDETECT
2736a11f1873SRobert Winkler		This enables 'hdmidet' command which returns true if an
2737a11f1873SRobert Winkler		HDMI monitor is detected.  This command is i.MX 6 specific.
2738a11f1873SRobert Winkler
2739a11f1873SRobert Winkler		CONFIG_CMD_BMODE
2740a11f1873SRobert Winkler		This enables the 'bmode' (bootmode) command for forcing
2741a11f1873SRobert Winkler		a boot from specific media.
2742a11f1873SRobert Winkler
2743a11f1873SRobert Winkler		This is useful for forcing the ROM's usb downloader to
2744a11f1873SRobert Winkler		activate upon a watchdog reset which is nice when iterating
2745a11f1873SRobert Winkler		on U-Boot.  Using the reset button or running bmode normal
2746a11f1873SRobert Winkler		will set it back to normal.  This command currently
2747a11f1873SRobert Winkler		supports i.MX53 and i.MX6.
2748a11f1873SRobert Winkler
274919c402afSSimon Glass- Signing support:
275019c402afSSimon Glass		CONFIG_RSA
275119c402afSSimon Glass
275219c402afSSimon Glass		This enables the RSA algorithm used for FIT image verification
275319c402afSSimon Glass		in U-Boot. See doc/uImage/signature for more information.
275419c402afSSimon Glass
275519c402afSSimon Glass		The signing part is build into mkimage regardless of this
275619c402afSSimon Glass		option.
275719c402afSSimon Glass
275819c402afSSimon Glass
2759a8c7c708Swdenk- Show boot progress:
2760c609719bSwdenk		CONFIG_SHOW_BOOT_PROGRESS
2761c609719bSwdenk
2762c609719bSwdenk		Defining this option allows to add some board-
2763c609719bSwdenk		specific code (calling a user-provided function
2764c609719bSwdenk		"show_boot_progress(int)") that enables you to show
2765c609719bSwdenk		the system's boot progress on some display (for
2766c609719bSwdenk		example, some LED's) on your board. At the moment,
2767c609719bSwdenk		the following checkpoints are implemented:
2768c609719bSwdenk
27693a608ca0SSimon Glass- Detailed boot stage timing
27703a608ca0SSimon Glass		CONFIG_BOOTSTAGE
27713a608ca0SSimon Glass		Define this option to get detailed timing of each stage
27723a608ca0SSimon Glass		of the boot process.
27733a608ca0SSimon Glass
27743a608ca0SSimon Glass		CONFIG_BOOTSTAGE_USER_COUNT
27753a608ca0SSimon Glass		This is the number of available user bootstage records.
27763a608ca0SSimon Glass		Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
27773a608ca0SSimon Glass		a new ID will be allocated from this stash. If you exceed
27783a608ca0SSimon Glass		the limit, recording will stop.
27793a608ca0SSimon Glass
27803a608ca0SSimon Glass		CONFIG_BOOTSTAGE_REPORT
27813a608ca0SSimon Glass		Define this to print a report before boot, similar to this:
27823a608ca0SSimon Glass
27833a608ca0SSimon Glass		Timer summary in microseconds:
27843a608ca0SSimon Glass		       Mark    Elapsed  Stage
27853a608ca0SSimon Glass			  0          0  reset
27863a608ca0SSimon Glass		  3,575,678  3,575,678  board_init_f start
27873a608ca0SSimon Glass		  3,575,695         17  arch_cpu_init A9
27883a608ca0SSimon Glass		  3,575,777         82  arch_cpu_init done
27893a608ca0SSimon Glass		  3,659,598     83,821  board_init_r start
27903a608ca0SSimon Glass		  3,910,375    250,777  main_loop
27913a608ca0SSimon Glass		 29,916,167 26,005,792  bootm_start
27923a608ca0SSimon Glass		 30,361,327    445,160  start_kernel
27933a608ca0SSimon Glass
27942eba38cfSSimon Glass		CONFIG_CMD_BOOTSTAGE
27952eba38cfSSimon Glass		Add a 'bootstage' command which supports printing a report
27962eba38cfSSimon Glass		and un/stashing of bootstage data.
27972eba38cfSSimon Glass
279894fd1316SSimon Glass		CONFIG_BOOTSTAGE_FDT
279994fd1316SSimon Glass		Stash the bootstage information in the FDT. A root 'bootstage'
280094fd1316SSimon Glass		node is created with each bootstage id as a child. Each child
280194fd1316SSimon Glass		has a 'name' property and either 'mark' containing the
280294fd1316SSimon Glass		mark time in microsecond, or 'accum' containing the
280394fd1316SSimon Glass		accumulated time for that bootstage id in microseconds.
280494fd1316SSimon Glass		For example:
280594fd1316SSimon Glass
280694fd1316SSimon Glass		bootstage {
280794fd1316SSimon Glass			154 {
280894fd1316SSimon Glass				name = "board_init_f";
280994fd1316SSimon Glass				mark = <3575678>;
281094fd1316SSimon Glass			};
281194fd1316SSimon Glass			170 {
281294fd1316SSimon Glass				name = "lcd";
281394fd1316SSimon Glass				accum = <33482>;
281494fd1316SSimon Glass			};
281594fd1316SSimon Glass		};
281694fd1316SSimon Glass
281794fd1316SSimon Glass		Code in the Linux kernel can find this in /proc/devicetree.
281894fd1316SSimon Glass
28191372cce2SMarian BalakowiczLegacy uImage format:
28201372cce2SMarian Balakowicz
2821c609719bSwdenk  Arg	Where			When
2822c609719bSwdenk    1	common/cmd_bootm.c	before attempting to boot an image
2823c609719bSwdenk   -1	common/cmd_bootm.c	Image header has bad	 magic number
2824c609719bSwdenk    2	common/cmd_bootm.c	Image header has correct magic number
2825c609719bSwdenk   -2	common/cmd_bootm.c	Image header has bad	 checksum
2826c609719bSwdenk    3	common/cmd_bootm.c	Image header has correct checksum
2827c609719bSwdenk   -3	common/cmd_bootm.c	Image data   has bad	 checksum
2828c609719bSwdenk    4	common/cmd_bootm.c	Image data   has correct checksum
2829c609719bSwdenk   -4	common/cmd_bootm.c	Image is for unsupported architecture
2830c609719bSwdenk    5	common/cmd_bootm.c	Architecture check OK
28311372cce2SMarian Balakowicz   -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi)
2832c609719bSwdenk    6	common/cmd_bootm.c	Image Type check OK
2833c609719bSwdenk   -6	common/cmd_bootm.c	gunzip uncompression error
2834c609719bSwdenk   -7	common/cmd_bootm.c	Unimplemented compression type
2835c609719bSwdenk    7	common/cmd_bootm.c	Uncompression OK
28361372cce2SMarian Balakowicz    8	common/cmd_bootm.c	No uncompress/copy overwrite error
2837c609719bSwdenk   -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
28381372cce2SMarian Balakowicz
28391372cce2SMarian Balakowicz    9	common/image.c		Start initial ramdisk verification
28401372cce2SMarian Balakowicz  -10	common/image.c		Ramdisk header has bad	   magic number
28411372cce2SMarian Balakowicz  -11	common/image.c		Ramdisk header has bad	   checksum
28421372cce2SMarian Balakowicz   10	common/image.c		Ramdisk header is OK
28431372cce2SMarian Balakowicz  -12	common/image.c		Ramdisk data   has bad	   checksum
28441372cce2SMarian Balakowicz   11	common/image.c		Ramdisk data   has correct checksum
28451372cce2SMarian Balakowicz   12	common/image.c		Ramdisk verification complete, start loading
284611ccc33fSMarcel Ziswiler  -13	common/image.c		Wrong Image Type (not PPC Linux ramdisk)
28471372cce2SMarian Balakowicz   13	common/image.c		Start multifile image verification
28481372cce2SMarian Balakowicz   14	common/image.c		No initial ramdisk, no multifile, continue.
28491372cce2SMarian Balakowicz
2850ea0364f1SPeter Tyser   15	arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
2851c609719bSwdenk
2852a47a12beSStefan Roese  -30	arch/powerpc/lib/board.c	Fatal error, hang the system
285363e73c9aSwdenk  -31	post/post.c		POST test failed, detected by post_output_backlog()
285463e73c9aSwdenk  -32	post/post.c		POST test failed, detected by post_run_single()
285563e73c9aSwdenk
2856566a494fSHeiko Schocher   34	common/cmd_doc.c	before loading a Image from a DOC device
2857566a494fSHeiko Schocher  -35	common/cmd_doc.c	Bad usage of "doc" command
2858566a494fSHeiko Schocher   35	common/cmd_doc.c	correct usage of "doc" command
2859566a494fSHeiko Schocher  -36	common/cmd_doc.c	No boot device
2860566a494fSHeiko Schocher   36	common/cmd_doc.c	correct boot device
2861566a494fSHeiko Schocher  -37	common/cmd_doc.c	Unknown Chip ID on boot device
2862566a494fSHeiko Schocher   37	common/cmd_doc.c	correct chip ID found, device available
2863566a494fSHeiko Schocher  -38	common/cmd_doc.c	Read Error on boot device
2864566a494fSHeiko Schocher   38	common/cmd_doc.c	reading Image header from DOC device OK
2865566a494fSHeiko Schocher  -39	common/cmd_doc.c	Image header has bad magic number
2866566a494fSHeiko Schocher   39	common/cmd_doc.c	Image header has correct magic number
2867566a494fSHeiko Schocher  -40	common/cmd_doc.c	Error reading Image from DOC device
2868566a494fSHeiko Schocher   40	common/cmd_doc.c	Image header has correct magic number
2869566a494fSHeiko Schocher   41	common/cmd_ide.c	before loading a Image from a IDE device
2870566a494fSHeiko Schocher  -42	common/cmd_ide.c	Bad usage of "ide" command
2871566a494fSHeiko Schocher   42	common/cmd_ide.c	correct usage of "ide" command
2872566a494fSHeiko Schocher  -43	common/cmd_ide.c	No boot device
2873566a494fSHeiko Schocher   43	common/cmd_ide.c	boot device found
2874566a494fSHeiko Schocher  -44	common/cmd_ide.c	Device not available
2875566a494fSHeiko Schocher   44	common/cmd_ide.c	Device available
2876566a494fSHeiko Schocher  -45	common/cmd_ide.c	wrong partition selected
2877566a494fSHeiko Schocher   45	common/cmd_ide.c	partition selected
2878566a494fSHeiko Schocher  -46	common/cmd_ide.c	Unknown partition table
2879566a494fSHeiko Schocher   46	common/cmd_ide.c	valid partition table found
2880566a494fSHeiko Schocher  -47	common/cmd_ide.c	Invalid partition type
2881566a494fSHeiko Schocher   47	common/cmd_ide.c	correct partition type
2882566a494fSHeiko Schocher  -48	common/cmd_ide.c	Error reading Image Header on boot device
2883566a494fSHeiko Schocher   48	common/cmd_ide.c	reading Image Header from IDE device OK
2884566a494fSHeiko Schocher  -49	common/cmd_ide.c	Image header has bad magic number
2885566a494fSHeiko Schocher   49	common/cmd_ide.c	Image header has correct magic number
2886566a494fSHeiko Schocher  -50	common/cmd_ide.c	Image header has bad	 checksum
2887566a494fSHeiko Schocher   50	common/cmd_ide.c	Image header has correct checksum
2888566a494fSHeiko Schocher  -51	common/cmd_ide.c	Error reading Image from IDE device
2889566a494fSHeiko Schocher   51	common/cmd_ide.c	reading Image from IDE device OK
2890566a494fSHeiko Schocher   52	common/cmd_nand.c	before loading a Image from a NAND device
2891566a494fSHeiko Schocher  -53	common/cmd_nand.c	Bad usage of "nand" command
2892566a494fSHeiko Schocher   53	common/cmd_nand.c	correct usage of "nand" command
2893566a494fSHeiko Schocher  -54	common/cmd_nand.c	No boot device
2894566a494fSHeiko Schocher   54	common/cmd_nand.c	boot device found
2895566a494fSHeiko Schocher  -55	common/cmd_nand.c	Unknown Chip ID on boot device
2896566a494fSHeiko Schocher   55	common/cmd_nand.c	correct chip ID found, device available
2897566a494fSHeiko Schocher  -56	common/cmd_nand.c	Error reading Image Header on boot device
2898566a494fSHeiko Schocher   56	common/cmd_nand.c	reading Image Header from NAND device OK
2899566a494fSHeiko Schocher  -57	common/cmd_nand.c	Image header has bad magic number
2900566a494fSHeiko Schocher   57	common/cmd_nand.c	Image header has correct magic number
2901566a494fSHeiko Schocher  -58	common/cmd_nand.c	Error reading Image from NAND device
2902566a494fSHeiko Schocher   58	common/cmd_nand.c	reading Image from NAND device OK
2903c609719bSwdenk
2904566a494fSHeiko Schocher  -60	common/env_common.c	Environment has a bad CRC, using default
2905c609719bSwdenk
2906566a494fSHeiko Schocher   64	net/eth.c		starting with Ethernet configuration.
2907566a494fSHeiko Schocher  -64	net/eth.c		no Ethernet found.
2908566a494fSHeiko Schocher   65	net/eth.c		Ethernet found.
2909206c60cbSwdenk
2910566a494fSHeiko Schocher  -80	common/cmd_net.c	usage wrong
2911566a494fSHeiko Schocher   80	common/cmd_net.c	before calling NetLoop()
291211ccc33fSMarcel Ziswiler  -81	common/cmd_net.c	some error in NetLoop() occurred
2913566a494fSHeiko Schocher   81	common/cmd_net.c	NetLoop() back without error
2914566a494fSHeiko Schocher  -82	common/cmd_net.c	size == 0 (File with size 0 loaded)
2915566a494fSHeiko Schocher   82	common/cmd_net.c	trying automatic boot
291674de7aefSWolfgang Denk   83	common/cmd_net.c	running "source" command
291774de7aefSWolfgang Denk  -83	common/cmd_net.c	some error in automatic boot or "source" command
2918566a494fSHeiko Schocher   84	common/cmd_net.c	end without errors
2919c609719bSwdenk
29201372cce2SMarian BalakowiczFIT uImage format:
29211372cce2SMarian Balakowicz
29221372cce2SMarian Balakowicz  Arg	Where			When
29231372cce2SMarian Balakowicz  100	common/cmd_bootm.c	Kernel FIT Image has correct format
29241372cce2SMarian Balakowicz -100	common/cmd_bootm.c	Kernel FIT Image has incorrect format
29251372cce2SMarian Balakowicz  101	common/cmd_bootm.c	No Kernel subimage unit name, using configuration
29261372cce2SMarian Balakowicz -101	common/cmd_bootm.c	Can't get configuration for kernel subimage
29271372cce2SMarian Balakowicz  102	common/cmd_bootm.c	Kernel unit name specified
29281372cce2SMarian Balakowicz -103	common/cmd_bootm.c	Can't get kernel subimage node offset
2929f773bea8SMarian Balakowicz  103	common/cmd_bootm.c	Found configuration node
29301372cce2SMarian Balakowicz  104	common/cmd_bootm.c	Got kernel subimage node offset
29311372cce2SMarian Balakowicz -104	common/cmd_bootm.c	Kernel subimage hash verification failed
29321372cce2SMarian Balakowicz  105	common/cmd_bootm.c	Kernel subimage hash verification OK
29331372cce2SMarian Balakowicz -105	common/cmd_bootm.c	Kernel subimage is for unsupported architecture
29341372cce2SMarian Balakowicz  106	common/cmd_bootm.c	Architecture check OK
293511ccc33fSMarcel Ziswiler -106	common/cmd_bootm.c	Kernel subimage has wrong type
293611ccc33fSMarcel Ziswiler  107	common/cmd_bootm.c	Kernel subimage type OK
29371372cce2SMarian Balakowicz -107	common/cmd_bootm.c	Can't get kernel subimage data/size
29381372cce2SMarian Balakowicz  108	common/cmd_bootm.c	Got kernel subimage data/size
29391372cce2SMarian Balakowicz -108	common/cmd_bootm.c	Wrong image type (not legacy, FIT)
29401372cce2SMarian Balakowicz -109	common/cmd_bootm.c	Can't get kernel subimage type
29411372cce2SMarian Balakowicz -110	common/cmd_bootm.c	Can't get kernel subimage comp
29421372cce2SMarian Balakowicz -111	common/cmd_bootm.c	Can't get kernel subimage os
29431372cce2SMarian Balakowicz -112	common/cmd_bootm.c	Can't get kernel subimage load address
29441372cce2SMarian Balakowicz -113	common/cmd_bootm.c	Image uncompress/copy overwrite error
29451372cce2SMarian Balakowicz
29461372cce2SMarian Balakowicz  120	common/image.c		Start initial ramdisk verification
29471372cce2SMarian Balakowicz -120	common/image.c		Ramdisk FIT image has incorrect format
29481372cce2SMarian Balakowicz  121	common/image.c		Ramdisk FIT image has correct format
294911ccc33fSMarcel Ziswiler  122	common/image.c		No ramdisk subimage unit name, using configuration
29501372cce2SMarian Balakowicz -122	common/image.c		Can't get configuration for ramdisk subimage
29511372cce2SMarian Balakowicz  123	common/image.c		Ramdisk unit name specified
29521372cce2SMarian Balakowicz -124	common/image.c		Can't get ramdisk subimage node offset
29531372cce2SMarian Balakowicz  125	common/image.c		Got ramdisk subimage node offset
29541372cce2SMarian Balakowicz -125	common/image.c		Ramdisk subimage hash verification failed
29551372cce2SMarian Balakowicz  126	common/image.c		Ramdisk subimage hash verification OK
29561372cce2SMarian Balakowicz -126	common/image.c		Ramdisk subimage for unsupported architecture
29571372cce2SMarian Balakowicz  127	common/image.c		Architecture check OK
29581372cce2SMarian Balakowicz -127	common/image.c		Can't get ramdisk subimage data/size
29591372cce2SMarian Balakowicz  128	common/image.c		Got ramdisk subimage data/size
29601372cce2SMarian Balakowicz  129	common/image.c		Can't get ramdisk load address
29611372cce2SMarian Balakowicz -129	common/image.c		Got ramdisk load address
29621372cce2SMarian Balakowicz
296311ccc33fSMarcel Ziswiler -130	common/cmd_doc.c	Incorrect FIT image format
29641372cce2SMarian Balakowicz  131	common/cmd_doc.c	FIT image format OK
29651372cce2SMarian Balakowicz
296611ccc33fSMarcel Ziswiler -140	common/cmd_ide.c	Incorrect FIT image format
29671372cce2SMarian Balakowicz  141	common/cmd_ide.c	FIT image format OK
29681372cce2SMarian Balakowicz
296911ccc33fSMarcel Ziswiler -150	common/cmd_nand.c	Incorrect FIT image format
29701372cce2SMarian Balakowicz  151	common/cmd_nand.c	FIT image format OK
29711372cce2SMarian Balakowicz
2972d95f6ec7SGabe Black- FIT image support:
2973d95f6ec7SGabe Black		CONFIG_FIT
2974d95f6ec7SGabe Black		Enable support for the FIT uImage format.
2975d95f6ec7SGabe Black
2976d95f6ec7SGabe Black		CONFIG_FIT_BEST_MATCH
2977d95f6ec7SGabe Black		When no configuration is explicitly selected, default to the
2978d95f6ec7SGabe Black		one whose fdt's compatibility field best matches that of
2979d95f6ec7SGabe Black		U-Boot itself. A match is considered "best" if it matches the
2980d95f6ec7SGabe Black		most specific compatibility entry of U-Boot's fdt's root node.
2981d95f6ec7SGabe Black		The order of entries in the configuration's fdt is ignored.
2982d95f6ec7SGabe Black
29833e569a6bSSimon Glass		CONFIG_FIT_SIGNATURE
29843e569a6bSSimon Glass		This option enables signature verification of FIT uImages,
29853e569a6bSSimon Glass		using a hash signed and verified using RSA. See
29863e569a6bSSimon Glass		doc/uImage.FIT/signature.txt for more details.
29873e569a6bSSimon Glass
29884cf2609bSWolfgang Denk- Standalone program support:
29894cf2609bSWolfgang Denk		CONFIG_STANDALONE_LOAD_ADDR
29904cf2609bSWolfgang Denk
29916feff899SWolfgang Denk		This option defines a board specific value for the
29926feff899SWolfgang Denk		address where standalone program gets loaded, thus
29936feff899SWolfgang Denk		overwriting the architecture dependent default
29944cf2609bSWolfgang Denk		settings.
29954cf2609bSWolfgang Denk
29964cf2609bSWolfgang Denk- Frame Buffer Address:
29974cf2609bSWolfgang Denk		CONFIG_FB_ADDR
29984cf2609bSWolfgang Denk
29994cf2609bSWolfgang Denk		Define CONFIG_FB_ADDR if you want to use specific
300044a53b57SWolfgang Denk		address for frame buffer.  This is typically the case
300144a53b57SWolfgang Denk		when using a graphics controller has separate video
300244a53b57SWolfgang Denk		memory.  U-Boot will then place the frame buffer at
300344a53b57SWolfgang Denk		the given address instead of dynamically reserving it
300444a53b57SWolfgang Denk		in system RAM by calling lcd_setmem(), which grabs
300544a53b57SWolfgang Denk		the memory for the frame buffer depending on the
300644a53b57SWolfgang Denk		configured panel size.
30074cf2609bSWolfgang Denk
30084cf2609bSWolfgang Denk		Please see board_init_f function.
30094cf2609bSWolfgang Denk
3010cccfc2abSDetlev Zundel- Automatic software updates via TFTP server
3011cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP
3012cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_CNT_MAX
3013cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_MSEC_MAX
3014cccfc2abSDetlev Zundel
3015cccfc2abSDetlev Zundel		These options enable and control the auto-update feature;
3016cccfc2abSDetlev Zundel		for a more detailed description refer to doc/README.update.
3017cccfc2abSDetlev Zundel
3018cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support)
3019cccfc2abSDetlev Zundel		CONFIG_MTD_DEVICE
3020cccfc2abSDetlev Zundel
3021cccfc2abSDetlev Zundel		Adds the MTD device infrastructure from the Linux kernel.
3022cccfc2abSDetlev Zundel		Needed for mtdparts command support.
3023cccfc2abSDetlev Zundel
3024cccfc2abSDetlev Zundel		CONFIG_MTD_PARTITIONS
3025cccfc2abSDetlev Zundel
3026cccfc2abSDetlev Zundel		Adds the MTD partitioning infrastructure from the Linux
3027cccfc2abSDetlev Zundel		kernel. Needed for UBI support.
3028cccfc2abSDetlev Zundel
302970c219cdSJoe Hershberger- UBI support
303070c219cdSJoe Hershberger		CONFIG_CMD_UBI
303170c219cdSJoe Hershberger
303270c219cdSJoe Hershberger		Adds commands for interacting with MTD partitions formatted
303370c219cdSJoe Hershberger		with the UBI flash translation layer
303470c219cdSJoe Hershberger
303570c219cdSJoe Hershberger		Requires also defining CONFIG_RBTREE
303670c219cdSJoe Hershberger
3037147162daSJoe Hershberger		CONFIG_UBI_SILENCE_MSG
3038147162daSJoe Hershberger
3039147162daSJoe Hershberger		Make the verbose messages from UBI stop printing.  This leaves
3040147162daSJoe Hershberger		warnings and errors enabled.
3041147162daSJoe Hershberger
304270c219cdSJoe Hershberger- UBIFS support
304370c219cdSJoe Hershberger		CONFIG_CMD_UBIFS
304470c219cdSJoe Hershberger
304570c219cdSJoe Hershberger		Adds commands for interacting with UBI volumes formatted as
304670c219cdSJoe Hershberger		UBIFS.  UBIFS is read-only in u-boot.
304770c219cdSJoe Hershberger
304870c219cdSJoe Hershberger		Requires UBI support as well as CONFIG_LZO
304970c219cdSJoe Hershberger
3050147162daSJoe Hershberger		CONFIG_UBIFS_SILENCE_MSG
3051147162daSJoe Hershberger
3052147162daSJoe Hershberger		Make the verbose messages from UBIFS stop printing.  This leaves
3053147162daSJoe Hershberger		warnings and errors enabled.
3054147162daSJoe Hershberger
30556a11cf48SDaniel Schwierzeck- SPL framework
30566a11cf48SDaniel Schwierzeck		CONFIG_SPL
30576a11cf48SDaniel Schwierzeck		Enable building of SPL globally.
30586a11cf48SDaniel Schwierzeck
305995579793STom Rini		CONFIG_SPL_LDSCRIPT
306095579793STom Rini		LDSCRIPT for linking the SPL binary.
306195579793STom Rini
30626ebc3461SAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT
30636ebc3461SAlbert ARIBAUD		Maximum size in memory allocated to the SPL, BSS included.
30646ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual memory
30656ebc3461SAlbert ARIBAUD		used by SPL from _start to __bss_end does not exceed it.
30668960af8bSAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
30676ebc3461SAlbert ARIBAUD		must not be both defined at the same time.
30686ebc3461SAlbert ARIBAUD
306995579793STom Rini		CONFIG_SPL_MAX_SIZE
30706ebc3461SAlbert ARIBAUD		Maximum size of the SPL image (text, data, rodata, and
30716ebc3461SAlbert ARIBAUD		linker lists sections), BSS excluded.
30726ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual size does
30736ebc3461SAlbert ARIBAUD		not exceed it.
307495579793STom Rini
30756a11cf48SDaniel Schwierzeck		CONFIG_SPL_TEXT_BASE
30766a11cf48SDaniel Schwierzeck		TEXT_BASE for linking the SPL binary.
30776a11cf48SDaniel Schwierzeck
307894a45bb1SScott Wood		CONFIG_SPL_RELOC_TEXT_BASE
307994a45bb1SScott Wood		Address to relocate to.  If unspecified, this is equal to
308094a45bb1SScott Wood		CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
308194a45bb1SScott Wood
308295579793STom Rini		CONFIG_SPL_BSS_START_ADDR
308395579793STom Rini		Link address for the BSS within the SPL binary.
308495579793STom Rini
308595579793STom Rini		CONFIG_SPL_BSS_MAX_SIZE
30866ebc3461SAlbert ARIBAUD		Maximum size in memory allocated to the SPL BSS.
30876ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual memory used
30886ebc3461SAlbert ARIBAUD		by SPL from __bss_start to __bss_end does not exceed it.
30898960af8bSAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
30906ebc3461SAlbert ARIBAUD		must not be both defined at the same time.
309195579793STom Rini
309295579793STom Rini		CONFIG_SPL_STACK
309395579793STom Rini		Adress of the start of the stack SPL will use
309495579793STom Rini
309594a45bb1SScott Wood		CONFIG_SPL_RELOC_STACK
309694a45bb1SScott Wood		Adress of the start of the stack SPL will use after
309794a45bb1SScott Wood		relocation.  If unspecified, this is equal to
309894a45bb1SScott Wood		CONFIG_SPL_STACK.
309994a45bb1SScott Wood
310095579793STom Rini		CONFIG_SYS_SPL_MALLOC_START
310195579793STom Rini		Starting address of the malloc pool used in SPL.
310295579793STom Rini
310395579793STom Rini		CONFIG_SYS_SPL_MALLOC_SIZE
310495579793STom Rini		The size of the malloc pool used in SPL.
31056a11cf48SDaniel Schwierzeck
310647f7bcaeSTom Rini		CONFIG_SPL_FRAMEWORK
310747f7bcaeSTom Rini		Enable the SPL framework under common/.  This framework
310847f7bcaeSTom Rini		supports MMC, NAND and YMODEM loading of U-Boot and NAND
310947f7bcaeSTom Rini		NAND loading of the Linux Kernel.
311047f7bcaeSTom Rini
3111861a86f4STom Rini		CONFIG_SPL_DISPLAY_PRINT
3112861a86f4STom Rini		For ARM, enable an optional function to print more information
3113861a86f4STom Rini		about the running system.
3114861a86f4STom Rini
31154b919725SScott Wood		CONFIG_SPL_INIT_MINIMAL
31164b919725SScott Wood		Arch init code should be built for a very small image
31174b919725SScott Wood
31186a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBCOMMON_SUPPORT
31196a11cf48SDaniel Schwierzeck		Support for common/libcommon.o in SPL binary
31206a11cf48SDaniel Schwierzeck
31216a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBDISK_SUPPORT
31226a11cf48SDaniel Schwierzeck		Support for disk/libdisk.o in SPL binary
31236a11cf48SDaniel Schwierzeck
31246a11cf48SDaniel Schwierzeck		CONFIG_SPL_I2C_SUPPORT
31256a11cf48SDaniel Schwierzeck		Support for drivers/i2c/libi2c.o in SPL binary
31266a11cf48SDaniel Schwierzeck
31276a11cf48SDaniel Schwierzeck		CONFIG_SPL_GPIO_SUPPORT
31286a11cf48SDaniel Schwierzeck		Support for drivers/gpio/libgpio.o in SPL binary
31296a11cf48SDaniel Schwierzeck
31306a11cf48SDaniel Schwierzeck		CONFIG_SPL_MMC_SUPPORT
31316a11cf48SDaniel Schwierzeck		Support for drivers/mmc/libmmc.o in SPL binary
31326a11cf48SDaniel Schwierzeck
313395579793STom Rini		CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
313495579793STom Rini		CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
313595579793STom Rini		CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION
313695579793STom Rini		Address, size and partition on the MMC to load U-Boot from
313795579793STom Rini		when the MMC is being used in raw mode.
313895579793STom Rini
31392b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
31402b75b0adSPeter Korsgaard		Sector to load kernel uImage from when MMC is being
31412b75b0adSPeter Korsgaard		used in raw mode (for Falcon mode)
31422b75b0adSPeter Korsgaard
31432b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
31442b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
31452b75b0adSPeter Korsgaard		Sector and number of sectors to load kernel argument
31462b75b0adSPeter Korsgaard		parameters from when MMC is being used in raw mode
31472b75b0adSPeter Korsgaard		(for falcon mode)
31482b75b0adSPeter Korsgaard
314995579793STom Rini		CONFIG_SPL_FAT_SUPPORT
315095579793STom Rini		Support for fs/fat/libfat.o in SPL binary
315195579793STom Rini
315295579793STom Rini		CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME
315395579793STom Rini		Filename to read to load U-Boot when reading from FAT
315495579793STom Rini
31557ad2cc79SPeter Korsgaard		CONFIG_SPL_FAT_LOAD_KERNEL_NAME
31567ad2cc79SPeter Korsgaard		Filename to read to load kernel uImage when reading
31577ad2cc79SPeter Korsgaard		from FAT (for Falcon mode)
31587ad2cc79SPeter Korsgaard
31597ad2cc79SPeter Korsgaard		CONFIG_SPL_FAT_LOAD_ARGS_NAME
31607ad2cc79SPeter Korsgaard		Filename to read to load kernel argument parameters
31617ad2cc79SPeter Korsgaard		when reading from FAT (for Falcon mode)
31627ad2cc79SPeter Korsgaard
316306f60ae3SScott Wood		CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
316406f60ae3SScott Wood		Set this for NAND SPL on PPC mpc83xx targets, so that
316506f60ae3SScott Wood		start.S waits for the rest of the SPL to load before
316606f60ae3SScott Wood		continuing (the hardware starts execution after just
316706f60ae3SScott Wood		loading the first page rather than the full 4K).
316806f60ae3SScott Wood
31696f2f01b9SScott Wood		CONFIG_SPL_NAND_BASE
31706f2f01b9SScott Wood		Include nand_base.c in the SPL.  Requires
31716f2f01b9SScott Wood		CONFIG_SPL_NAND_DRIVERS.
31726f2f01b9SScott Wood
31736f2f01b9SScott Wood		CONFIG_SPL_NAND_DRIVERS
31746f2f01b9SScott Wood		SPL uses normal NAND drivers, not minimal drivers.
31756f2f01b9SScott Wood
31766f2f01b9SScott Wood		CONFIG_SPL_NAND_ECC
31776f2f01b9SScott Wood		Include standard software ECC in the SPL
31786f2f01b9SScott Wood
317995579793STom Rini		CONFIG_SPL_NAND_SIMPLE
31807d4b7955SScott Wood		Support for NAND boot using simple NAND drivers that
31817d4b7955SScott Wood		expose the cmd_ctrl() interface.
318295579793STom Rini
3183bb0dc108SYing Zhang		CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT
3184bb0dc108SYing Zhang		Set for the SPL on PPC mpc8xxx targets, support for
3185bb0dc108SYing Zhang		arch/powerpc/cpu/mpc8xxx/ddr/libddr.o in SPL binary.
3186bb0dc108SYing Zhang
31877c8eea59SYing Zhang		CONFIG_SPL_COMMON_INIT_DDR
31887c8eea59SYing Zhang		Set for common ddr init with serial presence detect in
31897c8eea59SYing Zhang		SPL binary.
31907c8eea59SYing Zhang
319195579793STom Rini		CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
319295579793STom Rini		CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
319395579793STom Rini		CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
319495579793STom Rini		CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
319595579793STom Rini		CONFIG_SYS_NAND_ECCBYTES
319695579793STom Rini		Defines the size and behavior of the NAND that SPL uses
31977d4b7955SScott Wood		to read U-Boot
319895579793STom Rini
319995579793STom Rini		CONFIG_SYS_NAND_U_BOOT_OFFS
32007d4b7955SScott Wood		Location in NAND to read U-Boot from
32017d4b7955SScott Wood
32027d4b7955SScott Wood		CONFIG_SYS_NAND_U_BOOT_DST
32037d4b7955SScott Wood		Location in memory to load U-Boot to
32047d4b7955SScott Wood
32057d4b7955SScott Wood		CONFIG_SYS_NAND_U_BOOT_SIZE
32067d4b7955SScott Wood		Size of image to load
320795579793STom Rini
320895579793STom Rini		CONFIG_SYS_NAND_U_BOOT_START
32097d4b7955SScott Wood		Entry point in loaded image to jump to
321095579793STom Rini
321195579793STom Rini		CONFIG_SYS_NAND_HW_ECC_OOBFIRST
321295579793STom Rini		Define this if you need to first read the OOB and then the
321395579793STom Rini		data. This is used for example on davinci plattforms.
321495579793STom Rini
321595579793STom Rini		CONFIG_SPL_OMAP3_ID_NAND
321695579793STom Rini		Support for an OMAP3-specific set of functions to return the
321795579793STom Rini		ID and MFR of the first attached NAND chip, if present.
321895579793STom Rini
32196a11cf48SDaniel Schwierzeck		CONFIG_SPL_SERIAL_SUPPORT
32206a11cf48SDaniel Schwierzeck		Support for drivers/serial/libserial.o in SPL binary
32216a11cf48SDaniel Schwierzeck
32226a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_FLASH_SUPPORT
32236a11cf48SDaniel Schwierzeck		Support for drivers/mtd/spi/libspi_flash.o in SPL binary
32246a11cf48SDaniel Schwierzeck
32256a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_SUPPORT
32266a11cf48SDaniel Schwierzeck		Support for drivers/spi/libspi.o in SPL binary
32276a11cf48SDaniel Schwierzeck
3228c57b953dSPavel Machek		CONFIG_SPL_RAM_DEVICE
3229c57b953dSPavel Machek		Support for running image already present in ram, in SPL binary
3230c57b953dSPavel Machek
32316a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBGENERIC_SUPPORT
32326a11cf48SDaniel Schwierzeck		Support for lib/libgeneric.o in SPL binary
32331372cce2SMarian Balakowicz
3234ba1bee43SYing Zhang		CONFIG_SPL_ENV_SUPPORT
3235ba1bee43SYing Zhang		Support for the environment operating in SPL binary
3236ba1bee43SYing Zhang
3237ba1bee43SYing Zhang		CONFIG_SPL_NET_SUPPORT
3238ba1bee43SYing Zhang		Support for the net/libnet.o in SPL binary.
3239ba1bee43SYing Zhang		It conflicts with SPL env from storage medium specified by
3240ba1bee43SYing Zhang		CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3241ba1bee43SYing Zhang
324274752baaSScott Wood		CONFIG_SPL_PAD_TO
32436113d3f2SBenoît Thébaudeau		Image offset to which the SPL should be padded before appending
32446113d3f2SBenoît Thébaudeau		the SPL payload. By default, this is defined as
32456113d3f2SBenoît Thébaudeau		CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
32466113d3f2SBenoît Thébaudeau		CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
32476113d3f2SBenoît Thébaudeau		payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
324874752baaSScott Wood
3249ca2fca22SScott Wood		CONFIG_SPL_TARGET
3250ca2fca22SScott Wood		Final target image containing SPL and payload.  Some SPLs
3251ca2fca22SScott Wood		use an arch-specific makefile fragment instead, for
3252ca2fca22SScott Wood		example if more than one image needs to be produced.
3253ca2fca22SScott Wood
325487ebee39SSimon Glass		CONFIG_FIT_SPL_PRINT
325587ebee39SSimon Glass		Printing information about a FIT image adds quite a bit of
325687ebee39SSimon Glass		code to SPL. So this is normally disabled in SPL. Use this
325787ebee39SSimon Glass		option to re-enable it. This will affect the output of the
325887ebee39SSimon Glass		bootm command when booting a FIT image.
325987ebee39SSimon Glass
32603aa29de0SYing Zhang- TPL framework
32613aa29de0SYing Zhang		CONFIG_TPL
32623aa29de0SYing Zhang		Enable building of TPL globally.
32633aa29de0SYing Zhang
32643aa29de0SYing Zhang		CONFIG_TPL_PAD_TO
32653aa29de0SYing Zhang		Image offset to which the TPL should be padded before appending
32663aa29de0SYing Zhang		the TPL payload. By default, this is defined as
32673aa29de0SYing Zhang		CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
32683aa29de0SYing Zhang		CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
32693aa29de0SYing Zhang		payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
32703aa29de0SYing Zhang
3271c609719bSwdenkModem Support:
3272c609719bSwdenk--------------
3273c609719bSwdenk
3274566e5cf4SWolfgang Denk[so far only for SMDK2400 boards]
3275c609719bSwdenk
327611ccc33fSMarcel Ziswiler- Modem support enable:
3277c609719bSwdenk		CONFIG_MODEM_SUPPORT
3278c609719bSwdenk
3279c609719bSwdenk- RTS/CTS Flow control enable:
3280c609719bSwdenk		CONFIG_HWFLOW
3281c609719bSwdenk
3282c609719bSwdenk- Modem debug support:
3283c609719bSwdenk		CONFIG_MODEM_SUPPORT_DEBUG
3284c609719bSwdenk
3285c609719bSwdenk		Enables debugging stuff (char screen[1024], dbg())
3286c609719bSwdenk		for modem support. Useful only with BDI2000.
3287c609719bSwdenk
3288a8c7c708Swdenk- Interrupt support (PPC):
3289a8c7c708Swdenk
3290a8c7c708Swdenk		There are common interrupt_init() and timer_interrupt()
3291a8c7c708Swdenk		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
329211ccc33fSMarcel Ziswiler		for CPU specific initialization. interrupt_init_cpu()
3293a8c7c708Swdenk		should set decrementer_count to appropriate value. If
329411ccc33fSMarcel Ziswiler		CPU resets decrementer automatically after interrupt
3295a8c7c708Swdenk		(ppc4xx) it should set decrementer_count to zero.
329611ccc33fSMarcel Ziswiler		timer_interrupt() calls timer_interrupt_cpu() for CPU
3297a8c7c708Swdenk		specific handling. If board has watchdog / status_led
3298a8c7c708Swdenk		/ other_activity_monitor it works automatically from
3299a8c7c708Swdenk		general timer_interrupt().
3300a8c7c708Swdenk
3301c609719bSwdenk- General:
3302c609719bSwdenk
3303c609719bSwdenk		In the target system modem support is enabled when a
3304c609719bSwdenk		specific key (key combination) is pressed during
3305c609719bSwdenk		power-on. Otherwise U-Boot will boot normally
330611ccc33fSMarcel Ziswiler		(autoboot). The key_pressed() function is called from
3307c609719bSwdenk		board_init(). Currently key_pressed() is a dummy
3308c609719bSwdenk		function, returning 1 and thus enabling modem
3309c609719bSwdenk		initialization.
3310c609719bSwdenk
3311c609719bSwdenk		If there are no modem init strings in the
3312c609719bSwdenk		environment, U-Boot proceed to autoboot; the
3313c609719bSwdenk		previous output (banner, info printfs) will be
331411ccc33fSMarcel Ziswiler		suppressed, though.
3315c609719bSwdenk
3316c609719bSwdenk		See also: doc/README.Modem
3317c609719bSwdenk
33189660e442SHelmut RaigerBoard initialization settings:
33199660e442SHelmut Raiger------------------------------
33209660e442SHelmut Raiger
33219660e442SHelmut RaigerDuring Initialization u-boot calls a number of board specific functions
33229660e442SHelmut Raigerto allow the preparation of board specific prerequisites, e.g. pin setup
33239660e442SHelmut Raigerbefore drivers are initialized. To enable these callbacks the
33249660e442SHelmut Raigerfollowing configuration macros have to be defined. Currently this is
33259660e442SHelmut Raigerarchitecture specific, so please check arch/your_architecture/lib/board.c
33269660e442SHelmut Raigertypically in board_init_f() and board_init_r().
33279660e442SHelmut Raiger
33289660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
33299660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
33309660e442SHelmut Raiger- CONFIG_BOARD_LATE_INIT: Call board_late_init()
33319660e442SHelmut Raiger- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
3332c609719bSwdenk
3333c609719bSwdenkConfiguration Settings:
3334c609719bSwdenk-----------------------
3335c609719bSwdenk
33366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
3337c609719bSwdenk		undefine this when you're short of memory.
3338c609719bSwdenk
33392fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
33402fb2604dSPeter Tyser		width of the commands listed in the 'help' command output.
33412fb2604dSPeter Tyser
33426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT:	This is what U-Boot prints on the console to
3343c609719bSwdenk		prompt for user input.
3344c609719bSwdenk
33456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE:	Buffer size for input from the Console
3346c609719bSwdenk
33476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE:	Buffer size for Console output
3348c609719bSwdenk
33496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS:	max. Number of arguments accepted for monitor commands
3350c609719bSwdenk
33516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
3352c609719bSwdenk		the application (usually a Linux kernel) when it is
3353c609719bSwdenk		booted
3354c609719bSwdenk
33556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE:
3356c609719bSwdenk		List of legal baudrate settings for this board.
3357c609719bSwdenk
33586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_INFO_QUIET
3359c609719bSwdenk		Suppress display of console information at boot.
3360c609719bSwdenk
33616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_IS_IN_ENV
3362c609719bSwdenk		If the board specific function
3363c609719bSwdenk			extern int overwrite_console (void);
3364c609719bSwdenk		returns 1, the stdin, stderr and stdout are switched to the
3365c609719bSwdenk		serial port, else the settings in the environment are used.
3366c609719bSwdenk
33676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
3368c609719bSwdenk		Enable the call to overwrite_console().
3369c609719bSwdenk
33706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
3371c609719bSwdenk		Enable overwrite of previous console environment settings.
3372c609719bSwdenk
33736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
3374c609719bSwdenk		Begin and End addresses of the area used by the
3375c609719bSwdenk		simple memory test.
3376c609719bSwdenk
33776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST:
3378c609719bSwdenk		Enable an alternate, more extensive memory test.
3379c609719bSwdenk
33806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH:
33815f535fe1Swdenk		Scratch address used by the alternate memory test
33825f535fe1Swdenk		You only need to set this if address zero isn't writeable
33835f535fe1Swdenk
33846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
33856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
338614f73ca6SStefan Roese		this specified memory area will get subtracted from the top
338711ccc33fSMarcel Ziswiler		(end) of RAM and won't get "touched" at all by U-Boot. By
338814f73ca6SStefan Roese		fixing up gd->ram_size the Linux kernel should gets passed
338914f73ca6SStefan Roese		the now "corrected" memory size and won't touch it either.
339014f73ca6SStefan Roese		This should work for arch/ppc and arch/powerpc. Only Linux
33915e12e75dSStefan Roese		board ports in arch/powerpc with bootwrapper support that
339214f73ca6SStefan Roese		recalculate the memory size from the SDRAM controller setup
33935e12e75dSStefan Roese		will have to get fixed in Linux additionally.
339414f73ca6SStefan Roese
339514f73ca6SStefan Roese		This option can be used as a workaround for the 440EPx/GRx
339614f73ca6SStefan Roese		CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
339714f73ca6SStefan Roese		be touched.
339814f73ca6SStefan Roese
339914f73ca6SStefan Roese		WARNING: Please make sure that this value is a multiple of
340014f73ca6SStefan Roese		the Linux page size (normally 4k). If this is not the case,
340114f73ca6SStefan Roese		then the end address of the Linux memory will be located at a
340214f73ca6SStefan Roese		non page size aligned address and this could cause major
340314f73ca6SStefan Roese		problems.
340414f73ca6SStefan Roese
34056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE:
3406c609719bSwdenk		Enable temporary baudrate change while serial download
3407c609719bSwdenk
34086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE:
3409c609719bSwdenk		Physical start address of SDRAM. _Must_ be 0 here.
3410c609719bSwdenk
34116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MBIO_BASE:
3412c609719bSwdenk		Physical start address of Motherboard I/O (if using a
3413c609719bSwdenk		Cogent motherboard)
3414c609719bSwdenk
34156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE:
3416c609719bSwdenk		Physical start address of Flash memory.
3417c609719bSwdenk
34186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE:
3419c609719bSwdenk		Physical start address of boot monitor code (set by
3420c609719bSwdenk		make config files to be same as the text base address
342114d0a02aSWolfgang Denk		(CONFIG_SYS_TEXT_BASE) used when linking) - same as
34226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FLASH_BASE when booting from flash.
3423c609719bSwdenk
34246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN:
34253b57fe0aSwdenk		Size of memory reserved for monitor code, used to
34263b57fe0aSwdenk		determine _at_compile_time_ (!) if the environment is
34273b57fe0aSwdenk		embedded within the U-Boot image, or in a separate
34283b57fe0aSwdenk		flash sector.
3429c609719bSwdenk
34306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN:
3431c609719bSwdenk		Size of DRAM reserved for malloc() use.
3432c609719bSwdenk
34336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN:
343415940c9aSStefan Roese		Normally compressed uImages are limited to an
343515940c9aSStefan Roese		uncompressed size of 8 MBytes. If this is not enough,
34366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		you can define CONFIG_SYS_BOOTM_LEN in your board config file
343715940c9aSStefan Roese		to adjust this setting to your needs.
3438c609719bSwdenk
34396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ:
3440c609719bSwdenk		Maximum size of memory mapped by the startup code of
3441c609719bSwdenk		the Linux kernel; all data that must be processed by
34427d721e34SBartlomiej Sieka		the Linux kernel (bd_info, boot arguments, FDT blob if
34437d721e34SBartlomiej Sieka		used) must be put below this limit, unless "bootm_low"
34441bce2aebSRobert P. J. Day		environment variable is defined and non-zero. In such case
34457d721e34SBartlomiej Sieka		all data for the Linux kernel must be between "bootm_low"
3446c3624e6eSGrant Likely		and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.	 The environment
3447c3624e6eSGrant Likely		variable "bootm_mapsize" will override the value of
3448c3624e6eSGrant Likely		CONFIG_SYS_BOOTMAPSZ.  If CONFIG_SYS_BOOTMAPSZ is undefined,
3449c3624e6eSGrant Likely		then the value in "bootm_size" will be used instead.
3450c609719bSwdenk
3451fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3452fca43cc8SJohn Rigby		Enable initrd_high functionality.  If defined then the
3453fca43cc8SJohn Rigby		initrd_high feature is enabled and the bootm ramdisk subcommand
3454fca43cc8SJohn Rigby		is enabled.
3455fca43cc8SJohn Rigby
3456fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_CMDLINE:
3457fca43cc8SJohn Rigby		Enables allocating and saving kernel cmdline in space between
3458fca43cc8SJohn Rigby		"bootm_low" and "bootm_low" + BOOTMAPSZ.
3459fca43cc8SJohn Rigby
3460fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_KBD:
3461fca43cc8SJohn Rigby		Enables allocating and saving a kernel copy of the bd_info in
3462fca43cc8SJohn Rigby		space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3463fca43cc8SJohn Rigby
34646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS:
3465c609719bSwdenk		Max number of Flash memory banks
3466c609719bSwdenk
34676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT:
3468c609719bSwdenk		Max number of sectors on a Flash chip
3469c609719bSwdenk
34706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT:
3471c609719bSwdenk		Timeout for Flash erase operations (in ms)
3472c609719bSwdenk
34736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT:
3474c609719bSwdenk		Timeout for Flash write operations (in ms)
3475c609719bSwdenk
34766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT
34778564acf9Swdenk		Timeout for Flash set sector lock bit operation (in ms)
34788564acf9Swdenk
34796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT
34808564acf9Swdenk		Timeout for Flash clear lock bits operation (in ms)
34818564acf9Swdenk
34826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION
34838564acf9Swdenk		If defined, hardware flash sectors protection is used
34848564acf9Swdenk		instead of U-Boot software protection.
34858564acf9Swdenk
34866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP:
3487c609719bSwdenk
3488c609719bSwdenk		Enable TFTP transfers directly to flash memory;
3489c609719bSwdenk		without this option such a download has to be
3490c609719bSwdenk		performed in two steps: (1) download to RAM, and (2)
3491c609719bSwdenk		copy from RAM to flash.
3492c609719bSwdenk
3493c609719bSwdenk		The two-step approach is usually more reliable, since
3494c609719bSwdenk		you can check if the download worked before you erase
349511ccc33fSMarcel Ziswiler		the flash, but in some situations (when system RAM is
349611ccc33fSMarcel Ziswiler		too limited to allow for a temporary copy of the
3497c609719bSwdenk		downloaded image) this option may be very useful.
3498c609719bSwdenk
34996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI:
3500c609719bSwdenk		Define if the flash driver uses extra elements in the
35015653fc33Swdenk		common flash structure for storing flash geometry.
35025653fc33Swdenk
350300b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER
35045653fc33Swdenk		This option also enables the building of the cfi_flash driver
35055653fc33Swdenk		in the drivers directory
350653cf9435Sstroese
350791809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD
350891809ed5SPiotr Ziecik		This option enables the building of the cfi_mtd driver
350991809ed5SPiotr Ziecik		in the drivers directory. The driver exports CFI flash
351091809ed5SPiotr Ziecik		to the MTD layer.
351191809ed5SPiotr Ziecik
35126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
351396ef831fSGuennadi Liakhovetski		Use buffered writes to flash.
351496ef831fSGuennadi Liakhovetski
351596ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N
351696ef831fSGuennadi Liakhovetski		s29ws-n MirrorBit flash has non-standard addresses for buffered
351796ef831fSGuennadi Liakhovetski		write commands.
351896ef831fSGuennadi Liakhovetski
35196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST
35205568e613SStefan Roese		If this option is defined, the common CFI flash doesn't
35215568e613SStefan Roese		print it's warning upon not recognized FLASH banks. This
35225568e613SStefan Roese		is useful, if some of the configured banks are only
35235568e613SStefan Roese		optionally available.
35245568e613SStefan Roese
35259a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS
35269a042e9cSJerry Van Baren		If defined (must be an integer), print out countdown
35279a042e9cSJerry Van Baren		digits and dots.  Recommended value: 45 (9..1) for 80
35289a042e9cSJerry Van Baren		column displays, 15 (3..1) for 40 column displays.
35299a042e9cSJerry Van Baren
3530352ef3f1SStefan Roese- CONFIG_FLASH_VERIFY
3531352ef3f1SStefan Roese		If defined, the content of the flash (destination) is compared
3532352ef3f1SStefan Roese		against the source after the write operation. An error message
3533352ef3f1SStefan Roese		will be printed when the contents are not identical.
3534352ef3f1SStefan Roese		Please note that this option is useless in nearly all cases,
3535352ef3f1SStefan Roese		since such flash programming errors usually are detected earlier
3536352ef3f1SStefan Roese		while unprotecting/erasing/programming. Please only enable
3537352ef3f1SStefan Roese		this option if you really know what you are doing.
3538352ef3f1SStefan Roese
35396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER:
354011ccc33fSMarcel Ziswiler		Defines the number of Ethernet receive buffers. On some
354111ccc33fSMarcel Ziswiler		Ethernet controllers it is recommended to set this value
354253cf9435Sstroese		to 8 or even higher (EEPRO100 or 405 EMAC), since all
354353cf9435Sstroese		buffers can be full shortly after enabling the interface
354411ccc33fSMarcel Ziswiler		on high Ethernet traffic.
354553cf9435Sstroese		Defaults to 4 if not defined.
3546c609719bSwdenk
3547ea882bafSWolfgang Denk- CONFIG_ENV_MAX_ENTRIES
3548ea882bafSWolfgang Denk
3549ea882bafSWolfgang Denk	Maximum number of entries in the hash table that is used
3550ea882bafSWolfgang Denk	internally to store the environment settings. The default
3551ea882bafSWolfgang Denk	setting is supposed to be generous and should work in most
3552ea882bafSWolfgang Denk	cases. This setting can be used to tune behaviour; see
3553ea882bafSWolfgang Denk	lib/hashtable.c for details.
3554ea882bafSWolfgang Denk
35552598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_DEFAULT
35562598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_STATIC
35571bce2aebSRobert P. J. Day	Enable validation of the values given to environment variables when
35582598090bSJoe Hershberger	calling env set.  Variables can be restricted to only decimal,
35592598090bSJoe Hershberger	hexadecimal, or boolean.  If CONFIG_CMD_NET is also defined,
35602598090bSJoe Hershberger	the variables can also be restricted to IP address or MAC address.
35612598090bSJoe Hershberger
35622598090bSJoe Hershberger	The format of the list is:
35632598090bSJoe Hershberger		type_attribute = [s|d|x|b|i|m]
3564267541f7SJoe Hershberger		access_atribute = [a|r|o|c]
3565267541f7SJoe Hershberger		attributes = type_attribute[access_atribute]
35662598090bSJoe Hershberger		entry = variable_name[:attributes]
35672598090bSJoe Hershberger		list = entry[,list]
35682598090bSJoe Hershberger
35692598090bSJoe Hershberger	The type attributes are:
35702598090bSJoe Hershberger		s - String (default)
35712598090bSJoe Hershberger		d - Decimal
35722598090bSJoe Hershberger		x - Hexadecimal
35732598090bSJoe Hershberger		b - Boolean ([1yYtT|0nNfF])
35742598090bSJoe Hershberger		i - IP address
35752598090bSJoe Hershberger		m - MAC address
35762598090bSJoe Hershberger
3577267541f7SJoe Hershberger	The access attributes are:
3578267541f7SJoe Hershberger		a - Any (default)
3579267541f7SJoe Hershberger		r - Read-only
3580267541f7SJoe Hershberger		o - Write-once
3581267541f7SJoe Hershberger		c - Change-default
3582267541f7SJoe Hershberger
35832598090bSJoe Hershberger	- CONFIG_ENV_FLAGS_LIST_DEFAULT
35842598090bSJoe Hershberger		Define this to a list (string) to define the ".flags"
35852598090bSJoe Hershberger		envirnoment variable in the default or embedded environment.
35862598090bSJoe Hershberger
35872598090bSJoe Hershberger	- CONFIG_ENV_FLAGS_LIST_STATIC
35882598090bSJoe Hershberger		Define this to a list (string) to define validation that
35892598090bSJoe Hershberger		should be done if an entry is not found in the ".flags"
35902598090bSJoe Hershberger		environment variable.  To override a setting in the static
35912598090bSJoe Hershberger		list, simply add an entry for the same variable name to the
35922598090bSJoe Hershberger		".flags" variable.
35932598090bSJoe Hershberger
3594267541f7SJoe Hershberger- CONFIG_ENV_ACCESS_IGNORE_FORCE
3595267541f7SJoe Hershberger	If defined, don't allow the -f switch to env set override variable
3596267541f7SJoe Hershberger	access flags.
3597267541f7SJoe Hershberger
35985c1a7ea6SSimon Glass- CONFIG_SYS_GENERIC_BOARD
35995c1a7ea6SSimon Glass	This selects the architecture-generic board system instead of the
36005c1a7ea6SSimon Glass	architecture-specific board files. It is intended to move boards
36015c1a7ea6SSimon Glass	to this new framework over time. Defining this will disable the
36025c1a7ea6SSimon Glass	arch/foo/lib/board.c file and use common/board_f.c and
36035c1a7ea6SSimon Glass	common/board_r.c instead. To use this option your architecture
36045c1a7ea6SSimon Glass	must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in
36055c1a7ea6SSimon Glass	its config.mk file). If you find problems enabling this option on
36065c1a7ea6SSimon Glass	your board please report the problem and send patches!
36075c1a7ea6SSimon Glass
3608632efa74SSimon Glass- CONFIG_SYS_SYM_OFFSETS
3609632efa74SSimon Glass	This is set by architectures that use offsets for link symbols
3610632efa74SSimon Glass	instead of absolute values. So bss_start is obtained using an
3611632efa74SSimon Glass	offset _bss_start_ofs from CONFIG_SYS_TEXT_BASE, rather than
3612632efa74SSimon Glass	directly. You should not need to touch this setting.
3613632efa74SSimon Glass
36140b1b60c7SLokesh Vutla- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
36150b1b60c7SLokesh Vutla	This is set by OMAP boards for the max time that reset should
36160b1b60c7SLokesh Vutla	be asserted. See doc/README.omap-reset-time for details on how
36170b1b60c7SLokesh Vutla	the value can be calulated on a given board.
3618632efa74SSimon Glass
3619c609719bSwdenkThe following definitions that deal with the placement and management
3620c609719bSwdenkof environment data (variable area); in general, we support the
3621c609719bSwdenkfollowing configurations:
3622c609719bSwdenk
3623c3eb3fe4SMike Frysinger- CONFIG_BUILD_ENVCRC:
3624c3eb3fe4SMike Frysinger
3625c3eb3fe4SMike Frysinger	Builds up envcrc with the target environment so that external utils
3626c3eb3fe4SMike Frysinger	may easily extract it and embed it in final U-Boot images.
3627c3eb3fe4SMike Frysinger
36285a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH:
3629c609719bSwdenk
3630c609719bSwdenk	Define this if the environment is in flash memory.
3631c609719bSwdenk
3632c609719bSwdenk	a) The environment occupies one whole flash sector, which is
3633c609719bSwdenk	   "embedded" in the text segment with the U-Boot code. This
3634c609719bSwdenk	   happens usually with "bottom boot sector" or "top boot
3635c609719bSwdenk	   sector" type flash chips, which have several smaller
3636c609719bSwdenk	   sectors at the start or the end. For instance, such a
3637c609719bSwdenk	   layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3638c609719bSwdenk	   such a case you would place the environment in one of the
3639c609719bSwdenk	   4 kB sectors - with U-Boot code before and after it. With
3640c609719bSwdenk	   "top boot sector" type flash chips, you would put the
3641c609719bSwdenk	   environment in one of the last sectors, leaving a gap
3642c609719bSwdenk	   between U-Boot and the environment.
3643c609719bSwdenk
36440e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
3645c609719bSwdenk
3646c609719bSwdenk	   Offset of environment data (variable area) to the
3647c609719bSwdenk	   beginning of flash memory; for instance, with bottom boot
3648c609719bSwdenk	   type flash chips the second sector can be used: the offset
3649c609719bSwdenk	   for this sector is given here.
3650c609719bSwdenk
36516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
3652c609719bSwdenk
36530e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
3654c609719bSwdenk
3655c609719bSwdenk	   This is just another way to specify the start address of
3656c609719bSwdenk	   the flash sector containing the environment (instead of
36570e8d1586SJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET).
3658c609719bSwdenk
36590e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SECT_SIZE:
3660c609719bSwdenk
3661c609719bSwdenk	   Size of the sector containing the environment.
3662c609719bSwdenk
3663c609719bSwdenk
3664c609719bSwdenk	b) Sometimes flash chips have few, equal sized, BIG sectors.
3665c609719bSwdenk	   In such a case you don't want to spend a whole sector for
3666c609719bSwdenk	   the environment.
3667c609719bSwdenk
36680e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3669c609719bSwdenk
36705a1aceb0SJean-Christophe PLAGNIOL-VILLARD	   If you use this in combination with CONFIG_ENV_IS_IN_FLASH
36710e8d1586SJean-Christophe PLAGNIOL-VILLARD	   and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
3672c609719bSwdenk	   of this flash sector for the environment. This saves
3673c609719bSwdenk	   memory for the RAM copy of the environment.
3674c609719bSwdenk
3675c609719bSwdenk	   It may also save flash memory if you decide to use this
3676c609719bSwdenk	   when your environment is "embedded" within U-Boot code,
3677c609719bSwdenk	   since then the remainder of the flash sector could be used
3678c609719bSwdenk	   for U-Boot code. It should be pointed out that this is
3679c609719bSwdenk	   STRONGLY DISCOURAGED from a robustness point of view:
3680c609719bSwdenk	   updating the environment in flash makes it always
3681c609719bSwdenk	   necessary to erase the WHOLE sector. If something goes
3682c609719bSwdenk	   wrong before the contents has been restored from a copy in
3683c609719bSwdenk	   RAM, your target system will be dead.
3684c609719bSwdenk
36850e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR_REDUND
36860e8d1586SJean-Christophe PLAGNIOL-VILLARD	  CONFIG_ENV_SIZE_REDUND
3687c609719bSwdenk
3688c609719bSwdenk	   These settings describe a second storage area used to hold
368911ccc33fSMarcel Ziswiler	   a redundant copy of the environment data, so that there is
36903e38691eSwdenk	   a valid backup copy in case there is a power failure during
3691c609719bSwdenk	   a "saveenv" operation.
3692c609719bSwdenk
3693c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the
3694c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds*
3695c609719bSwdenkaccordingly!
3696c609719bSwdenk
3697c609719bSwdenk
36989314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM:
3699c609719bSwdenk
3700c609719bSwdenk	Define this if you have some non-volatile memory device
3701c609719bSwdenk	(NVRAM, battery buffered SRAM) which you want to use for the
3702c609719bSwdenk	environment.
3703c609719bSwdenk
37040e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
37050e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3706c609719bSwdenk
370711ccc33fSMarcel Ziswiler	  These two #defines are used to determine the memory area you
3708c609719bSwdenk	  want to use for environment. It is assumed that this memory
3709c609719bSwdenk	  can just be read and written to, without any special
3710c609719bSwdenk	  provision.
3711c609719bSwdenk
3712c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early
3713c609719bSwdenkin U-Boot initalization (when we try to get the setting of for the
371411ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or
3715c609719bSwdenkU-Boot will hang.
3716c609719bSwdenk
3717c609719bSwdenkPlease note that even with NVRAM we still use a copy of the
3718c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to
3719c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv"
3720c609719bSwdenkto save the current settings.
3721c609719bSwdenk
3722c609719bSwdenk
3723bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM:
3724c609719bSwdenk
3725c609719bSwdenk	Use this if you have an EEPROM or similar serial access
3726c609719bSwdenk	device and a driver for it.
3727c609719bSwdenk
37280e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
37290e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3730c609719bSwdenk
3731c609719bSwdenk	  These two #defines specify the offset and size of the
3732c609719bSwdenk	  environment area within the total memory of your EEPROM.
3733c609719bSwdenk
37346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR:
3735c609719bSwdenk	  If defined, specified the chip address of the EEPROM device.
3736c609719bSwdenk	  The default address is zero.
3737c609719bSwdenk
37386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
3739c609719bSwdenk	  If defined, the number of bits used to address bytes in a
3740c609719bSwdenk	  single page in the EEPROM device.  A 64 byte page, for example
3741c609719bSwdenk	  would require six bits.
3742c609719bSwdenk
37436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
3744c609719bSwdenk	  If defined, the number of milliseconds to delay between
3745c609719bSwdenk	  page writes.	The default is zero milliseconds.
3746c609719bSwdenk
37476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
3748c609719bSwdenk	  The length in bytes of the EEPROM memory array address.  Note
3749c609719bSwdenk	  that this is NOT the chip address length!
3750c609719bSwdenk
37516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
37525cf91d6bSwdenk	  EEPROM chips that implement "address overflow" are ones
37535cf91d6bSwdenk	  like Catalyst 24WC04/08/16 which has 9/10/11 bits of
37545cf91d6bSwdenk	  address and the extra bits end up in the "chip address" bit
37555cf91d6bSwdenk	  slots. This makes a 24WC08 (1Kbyte) chip look like four 256
37565cf91d6bSwdenk	  byte chips.
37575cf91d6bSwdenk
37585cf91d6bSwdenk	  Note that we consider the length of the address field to
37595cf91d6bSwdenk	  still be one byte because the extra address bits are hidden
37605cf91d6bSwdenk	  in the chip address.
37615cf91d6bSwdenk
37626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_SIZE:
3763c609719bSwdenk	  The size in bytes of the EEPROM device.
3764c609719bSwdenk
3765548738b4SHeiko Schocher	- CONFIG_ENV_EEPROM_IS_ON_I2C
3766548738b4SHeiko Schocher	  define this, if you have I2C and SPI activated, and your
3767548738b4SHeiko Schocher	  EEPROM, which holds the environment, is on the I2C bus.
3768548738b4SHeiko Schocher
3769548738b4SHeiko Schocher	- CONFIG_I2C_ENV_EEPROM_BUS
3770548738b4SHeiko Schocher	  if you have an Environment on an EEPROM reached over
3771548738b4SHeiko Schocher	  I2C muxes, you can define here, how to reach this
3772548738b4SHeiko Schocher	  EEPROM. For example:
3773548738b4SHeiko Schocher
3774ea818dbbSHeiko Schocher	  #define CONFIG_I2C_ENV_EEPROM_BUS	  1
3775548738b4SHeiko Schocher
3776548738b4SHeiko Schocher	  EEPROM which holds the environment, is reached over
3777548738b4SHeiko Schocher	  a pca9547 i2c mux with address 0x70, channel 3.
3778c609719bSwdenk
3779057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH:
37805779d8d9Swdenk
37815779d8d9Swdenk	Define this if you have a DataFlash memory device which you
37825779d8d9Swdenk	want to use for the environment.
37835779d8d9Swdenk
37840e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
37850e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
37860e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
37875779d8d9Swdenk
37885779d8d9Swdenk	  These three #defines specify the offset and size of the
37895779d8d9Swdenk	  environment area within the total memory of your DataFlash placed
37905779d8d9Swdenk	  at the specified address.
37915779d8d9Swdenk
37920a85a9e7SLiu Gang- CONFIG_ENV_IS_IN_REMOTE:
37930a85a9e7SLiu Gang
37940a85a9e7SLiu Gang	Define this if you have a remote memory space which you
37950a85a9e7SLiu Gang	want to use for the local device's environment.
37960a85a9e7SLiu Gang
37970a85a9e7SLiu Gang	- CONFIG_ENV_ADDR:
37980a85a9e7SLiu Gang	- CONFIG_ENV_SIZE:
37990a85a9e7SLiu Gang
38000a85a9e7SLiu Gang	  These two #defines specify the address and size of the
38010a85a9e7SLiu Gang	  environment area within the remote memory space. The
38020a85a9e7SLiu Gang	  local device can get the environment from remote memory
3803fc54c7faSLiu Gang	  space by SRIO or PCIE links.
38040a85a9e7SLiu Gang
38050a85a9e7SLiu GangBE CAREFUL! For some special cases, the local device can not use
38060a85a9e7SLiu Gang"saveenv" command. For example, the local device will get the
3807fc54c7faSLiu Gangenvironment stored in a remote NOR flash by SRIO or PCIE link,
3808fc54c7faSLiu Gangbut it can not erase, write this NOR flash by SRIO or PCIE interface.
38090a85a9e7SLiu Gang
381051bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND:
381113a5695bSwdenk
381213a5695bSwdenk	Define this if you have a NAND device which you want to use
381313a5695bSwdenk	for the environment.
381413a5695bSwdenk
38150e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
38160e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
381713a5695bSwdenk
381813a5695bSwdenk	  These two #defines specify the offset and size of the environment
3819fdd813deSScott Wood	  area within the first NAND device.  CONFIG_ENV_OFFSET must be
3820fdd813deSScott Wood	  aligned to an erase block boundary.
38215779d8d9Swdenk
3822fdd813deSScott Wood	- CONFIG_ENV_OFFSET_REDUND (optional):
3823e443c944SMarkus Klotzbuecher
38240e8d1586SJean-Christophe PLAGNIOL-VILLARD	  This setting describes a second storage area of CONFIG_ENV_SIZE
3825fdd813deSScott Wood	  size used to hold a redundant copy of the environment data, so
3826fdd813deSScott Wood	  that there is a valid backup copy in case there is a power failure
3827fdd813deSScott Wood	  during a "saveenv" operation.	 CONFIG_ENV_OFFSET_RENDUND must be
3828fdd813deSScott Wood	  aligned to an erase block boundary.
3829e443c944SMarkus Klotzbuecher
3830fdd813deSScott Wood	- CONFIG_ENV_RANGE (optional):
3831fdd813deSScott Wood
3832fdd813deSScott Wood	  Specifies the length of the region in which the environment
3833fdd813deSScott Wood	  can be written.  This should be a multiple of the NAND device's
3834fdd813deSScott Wood	  block size.  Specifying a range with more erase blocks than
3835fdd813deSScott Wood	  are needed to hold CONFIG_ENV_SIZE allows bad blocks within
3836fdd813deSScott Wood	  the range to be avoided.
3837fdd813deSScott Wood
3838fdd813deSScott Wood	- CONFIG_ENV_OFFSET_OOB (optional):
3839fdd813deSScott Wood
3840fdd813deSScott Wood	  Enables support for dynamically retrieving the offset of the
3841fdd813deSScott Wood	  environment from block zero's out-of-band data.  The
3842fdd813deSScott Wood	  "nand env.oob" command can be used to record this offset.
3843fdd813deSScott Wood	  Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
3844fdd813deSScott Wood	  using CONFIG_ENV_OFFSET_OOB.
3845e443c944SMarkus Klotzbuecher
3846b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST
3847b74ab737SGuennadi Liakhovetski
3848b74ab737SGuennadi Liakhovetski	Defines address in RAM to which the nand_spl code should copy the
3849b74ab737SGuennadi Liakhovetski	environment. If redundant environment is used, it will be copied to
3850b74ab737SGuennadi Liakhovetski	CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3851b74ab737SGuennadi Liakhovetski
38522b74433fSJoe Hershberger- CONFIG_ENV_IS_IN_UBI:
38532b74433fSJoe Hershberger
38542b74433fSJoe Hershberger	Define this if you have an UBI volume that you want to use for the
38552b74433fSJoe Hershberger	environment.  This has the benefit of wear-leveling the environment
38562b74433fSJoe Hershberger	accesses, which is important on NAND.
38572b74433fSJoe Hershberger
38582b74433fSJoe Hershberger	- CONFIG_ENV_UBI_PART:
38592b74433fSJoe Hershberger
38602b74433fSJoe Hershberger	  Define this to a string that is the mtd partition containing the UBI.
38612b74433fSJoe Hershberger
38622b74433fSJoe Hershberger	- CONFIG_ENV_UBI_VOLUME:
38632b74433fSJoe Hershberger
38642b74433fSJoe Hershberger	  Define this to the name of the volume that you want to store the
38652b74433fSJoe Hershberger	  environment in.
38662b74433fSJoe Hershberger
3867785881f7SJoe Hershberger	- CONFIG_ENV_UBI_VOLUME_REDUND:
3868785881f7SJoe Hershberger
3869785881f7SJoe Hershberger	  Define this to the name of another volume to store a second copy of
3870785881f7SJoe Hershberger	  the environment in.  This will enable redundant environments in UBI.
3871785881f7SJoe Hershberger	  It is assumed that both volumes are in the same MTD partition.
3872785881f7SJoe Hershberger
38732b74433fSJoe Hershberger	- CONFIG_UBI_SILENCE_MSG
38742b74433fSJoe Hershberger	- CONFIG_UBIFS_SILENCE_MSG
38752b74433fSJoe Hershberger
38762b74433fSJoe Hershberger	  You will probably want to define these to avoid a really noisy system
38772b74433fSJoe Hershberger	  when storing the env in UBI.
38782b74433fSJoe Hershberger
387906e4ae5fSStephen Warren- CONFIG_ENV_IS_IN_MMC:
388006e4ae5fSStephen Warren
388106e4ae5fSStephen Warren	Define this if you have an MMC device which you want to use for the
388206e4ae5fSStephen Warren	environment.
388306e4ae5fSStephen Warren
388406e4ae5fSStephen Warren	- CONFIG_SYS_MMC_ENV_DEV:
388506e4ae5fSStephen Warren
388606e4ae5fSStephen Warren	  Specifies which MMC device the environment is stored in.
388706e4ae5fSStephen Warren
388806e4ae5fSStephen Warren	- CONFIG_SYS_MMC_ENV_PART (optional):
388906e4ae5fSStephen Warren
389006e4ae5fSStephen Warren	  Specifies which MMC partition the environment is stored in. If not
389106e4ae5fSStephen Warren	  set, defaults to partition 0, the user area. Common values might be
389206e4ae5fSStephen Warren	  1 (first MMC boot partition), 2 (second MMC boot partition).
389306e4ae5fSStephen Warren
389406e4ae5fSStephen Warren	- CONFIG_ENV_OFFSET:
389506e4ae5fSStephen Warren	- CONFIG_ENV_SIZE:
389606e4ae5fSStephen Warren
389706e4ae5fSStephen Warren	  These two #defines specify the offset and size of the environment
389806e4ae5fSStephen Warren	  area within the specified MMC device.
389906e4ae5fSStephen Warren
39005c088ee8SStephen Warren	  If offset is positive (the usual case), it is treated as relative to
39015c088ee8SStephen Warren	  the start of the MMC partition. If offset is negative, it is treated
39025c088ee8SStephen Warren	  as relative to the end of the MMC partition. This can be useful if
39035c088ee8SStephen Warren	  your board may be fitted with different MMC devices, which have
39045c088ee8SStephen Warren	  different sizes for the MMC partitions, and you always want the
39055c088ee8SStephen Warren	  environment placed at the very end of the partition, to leave the
39065c088ee8SStephen Warren	  maximum possible space before it, to store other data.
39075c088ee8SStephen Warren
390806e4ae5fSStephen Warren	  These two values are in units of bytes, but must be aligned to an
390906e4ae5fSStephen Warren	  MMC sector boundary.
391006e4ae5fSStephen Warren
391106e4ae5fSStephen Warren	- CONFIG_ENV_OFFSET_REDUND (optional):
391206e4ae5fSStephen Warren
391306e4ae5fSStephen Warren	  Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
391406e4ae5fSStephen Warren	  hold a redundant copy of the environment data. This provides a
391506e4ae5fSStephen Warren	  valid backup copy in case the other copy is corrupted, e.g. due
391606e4ae5fSStephen Warren	  to a power failure during a "saveenv" operation.
391706e4ae5fSStephen Warren
39185c088ee8SStephen Warren	  This value may also be positive or negative; this is handled in the
39195c088ee8SStephen Warren	  same way as CONFIG_ENV_OFFSET.
39205c088ee8SStephen Warren
392106e4ae5fSStephen Warren	  This value is also in units of bytes, but must also be aligned to
392206e4ae5fSStephen Warren	  an MMC sector boundary.
392306e4ae5fSStephen Warren
392406e4ae5fSStephen Warren	- CONFIG_ENV_SIZE_REDUND (optional):
392506e4ae5fSStephen Warren
392606e4ae5fSStephen Warren	  This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
392706e4ae5fSStephen Warren	  set. If this value is set, it must be set to the same value as
392806e4ae5fSStephen Warren	  CONFIG_ENV_SIZE.
392906e4ae5fSStephen Warren
39306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET
3931c609719bSwdenk
3932c609719bSwdenk	Defines offset to the initial SPI buffer area in DPRAM. The
3933c609719bSwdenk	area is used at an early stage (ROM part) if the environment
3934c609719bSwdenk	is configured to reside in the SPI EEPROM: We need a 520 byte
3935c609719bSwdenk	scratch DPRAM area. It is used between the two initialization
3936c609719bSwdenk	calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
3937c609719bSwdenk	to be a good choice since it makes it far enough from the
3938c609719bSwdenk	start of the data area as well as from the stack pointer.
3939c609719bSwdenk
3940e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor
3941c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been
3942cdb74977SWolfgang Denkcreated; also, when using EEPROM you will have to use getenv_f()
3943c609719bSwdenkuntil then to read environment variables.
3944c609719bSwdenk
394585ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor
394685ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working
394785ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is
394885ec0bccSwdenknecessary, because the first environment variable we need is the
394985ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't
395085ec0bccSwdenkhave any device yet where we could complain.]
3951c609719bSwdenk
3952c609719bSwdenkNote: once the monitor has been relocated, then it will complain if
3953c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you
395485ec0bccSwdenkuse the "saveenv" command to store a valid environment.
3955c609719bSwdenk
39566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
3957fc3e2165Swdenk		Echo the inverted Ethernet link state to the fault LED.
3958fc3e2165Swdenk
39596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
3960fc3e2165Swdenk		      also needs to be defined.
3961fc3e2165Swdenk
39626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR:
3963fc3e2165Swdenk		MII address of the PHY to check for the Ethernet link state.
3964c609719bSwdenk
3965f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS:
3966f5675aa5SRon Madrid		Define this if you desire to only have use of the NS16550_init
3967f5675aa5SRon Madrid		and NS16550_putc functions for the serial driver located at
3968f5675aa5SRon Madrid		drivers/serial/ns16550.c.  This option is useful for saving
3969f5675aa5SRon Madrid		space for already greatly restricted images, including but not
3970f5675aa5SRon Madrid		limited to NAND_SPL configurations.
3971f5675aa5SRon Madrid
3972b2b92f53SSimon Glass- CONFIG_DISPLAY_BOARDINFO
3973b2b92f53SSimon Glass		Display information about the board that U-Boot is running on
3974b2b92f53SSimon Glass		when U-Boot starts up. The board function checkboard() is called
3975b2b92f53SSimon Glass		to do this.
3976b2b92f53SSimon Glass
3977e2e3e2b1SSimon Glass- CONFIG_DISPLAY_BOARDINFO_LATE
3978e2e3e2b1SSimon Glass		Similar to the previous option, but display this information
3979e2e3e2b1SSimon Glass		later, once stdio is running and output goes to the LCD, if
3980e2e3e2b1SSimon Glass		present.
3981e2e3e2b1SSimon Glass
3982c609719bSwdenkLow Level (hardware related) configuration options:
3983dc7c9a1aSwdenk---------------------------------------------------
3984c609719bSwdenk
39856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE:
3986c609719bSwdenk		Cache Line Size of the CPU.
3987c609719bSwdenk
39886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR:
3989c609719bSwdenk		Default address of the IMMR after system reset.
39902535d602Swdenk
39912535d602Swdenk		Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
39922535d602Swdenk		and RPXsuper) to be able to adjust the position of
39932535d602Swdenk		the IMMR register after a reset.
3994c609719bSwdenk
3995e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_DEFAULT:
3996e46fedfeSTimur Tabi		Default (power-on reset) physical address of CCSR on Freescale
3997e46fedfeSTimur Tabi		PowerPC SOCs.
3998e46fedfeSTimur Tabi
3999e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR:
4000e46fedfeSTimur Tabi		Virtual address of CCSR.  On a 32-bit build, this is typically
4001e46fedfeSTimur Tabi		the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4002e46fedfeSTimur Tabi
4003e46fedfeSTimur Tabi		CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4004e46fedfeSTimur Tabi		for cross-platform code that uses that macro instead.
4005e46fedfeSTimur Tabi
4006e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS:
4007e46fedfeSTimur Tabi		Physical address of CCSR.  CCSR can be relocated to a new
4008e46fedfeSTimur Tabi		physical address, if desired.  In this case, this macro should
4009e46fedfeSTimur Tabi		be set to that address.	 Otherwise, it should be set to the
4010e46fedfeSTimur Tabi		same value as CONFIG_SYS_CCSRBAR_DEFAULT.  For example, CCSR
4011e46fedfeSTimur Tabi		is typically relocated on 36-bit builds.  It is recommended
4012e46fedfeSTimur Tabi		that this macro be defined via the _HIGH and _LOW macros:
4013e46fedfeSTimur Tabi
4014e46fedfeSTimur Tabi		#define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4015e46fedfeSTimur Tabi			* 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4016e46fedfeSTimur Tabi
4017e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
4018e46fedfeSTimur Tabi		Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS.	This value is typically
4019e46fedfeSTimur Tabi		either 0 (32-bit build) or 0xF (36-bit build).	This macro is
4020e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
4021e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
4022e46fedfeSTimur Tabi
4023e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4024e46fedfeSTimur Tabi		Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS.  This macro is
4025e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
4026e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
4027e46fedfeSTimur Tabi
4028e46fedfeSTimur Tabi- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4029e46fedfeSTimur Tabi		If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4030e46fedfeSTimur Tabi		forced to a value that ensures that CCSR is not relocated.
4031e46fedfeSTimur Tabi
40327f6c2cbcSwdenk- Floppy Disk Support:
40336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER
40347f6c2cbcSwdenk
40357f6c2cbcSwdenk		the default drive number (default value 0)
40367f6c2cbcSwdenk
40376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_STRIDE
40387f6c2cbcSwdenk
403911ccc33fSMarcel Ziswiler		defines the spacing between FDC chipset registers
40407f6c2cbcSwdenk		(default value 1)
40417f6c2cbcSwdenk
40426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_OFFSET
40437f6c2cbcSwdenk
40447f6c2cbcSwdenk		defines the offset of register from address. It
40457f6c2cbcSwdenk		depends on which part of the data bus is connected to
404611ccc33fSMarcel Ziswiler		the FDC chipset. (default value 0)
40477f6c2cbcSwdenk
40486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
40496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
40507f6c2cbcSwdenk		default value.
40517f6c2cbcSwdenk
40526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		if CONFIG_SYS_FDC_HW_INIT is defined, then the function
40537f6c2cbcSwdenk		fdc_hw_init() is called at the beginning of the FDC
40547f6c2cbcSwdenk		setup. fdc_hw_init() must be provided by the board
40557f6c2cbcSwdenk		source code. It is used to make hardware dependant
40567f6c2cbcSwdenk		initializations.
40577f6c2cbcSwdenk
40580abddf82SMacpaul Lin- CONFIG_IDE_AHB:
40590abddf82SMacpaul Lin		Most IDE controllers were designed to be connected with PCI
40600abddf82SMacpaul Lin		interface. Only few of them were designed for AHB interface.
40610abddf82SMacpaul Lin		When software is doing ATA command and data transfer to
40620abddf82SMacpaul Lin		IDE devices through IDE-AHB controller, some additional
40630abddf82SMacpaul Lin		registers accessing to these kind of IDE-AHB controller
40640abddf82SMacpaul Lin		is requierd.
40650abddf82SMacpaul Lin
40666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR:	Physical address of the Internal Memory.
406725d6712aSwdenk		DO NOT CHANGE unless you know exactly what you're
406825d6712aSwdenk		doing! (11-4) [MPC8xx/82xx systems only]
4069c609719bSwdenk
40706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR:
4071c609719bSwdenk
40727152b1d0Swdenk		Start address of memory area that can be used for
4073c609719bSwdenk		initial data and stack; please note that this must be
4074c609719bSwdenk		writable memory that is working WITHOUT special
4075c609719bSwdenk		initialization, i. e. you CANNOT use normal RAM which
4076c609719bSwdenk		will become available only after programming the
4077c609719bSwdenk		memory controller and running certain initialization
4078c609719bSwdenk		sequences.
4079c609719bSwdenk
4080c609719bSwdenk		U-Boot uses the following memory types:
4081c609719bSwdenk		- MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4082c609719bSwdenk		- MPC824X: data cache
4083c609719bSwdenk		- PPC4xx:  data cache
4084c609719bSwdenk
40856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET:
4086c609719bSwdenk
4087c609719bSwdenk		Offset of the initial data structure in the memory
40886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
40896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
4090c609719bSwdenk		data is located at the end of the available space
4091553f0982SWolfgang Denk		(sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
40926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
40936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
40946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET) downward.
4095c609719bSwdenk
4096c609719bSwdenk	Note:
4097c609719bSwdenk		On the MPC824X (or other systems that use the data
4098c609719bSwdenk		cache for initial memory) the address chosen for
40996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
4100c609719bSwdenk		point to an otherwise UNUSED address space between
4101c609719bSwdenk		the top of RAM and the start of the PCI space.
4102c609719bSwdenk
41036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR:	SIU Module Configuration (11-6)
4104c609719bSwdenk
41056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR:	System Protection Control (11-9)
4106c609719bSwdenk
41076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR:	Time Base Status and Control (11-26)
4108c609719bSwdenk
41096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR:	Periodic Interrupt Status and Control (11-31)
4110c609719bSwdenk
41116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR:	PLL, Low-Power, and Reset Control Register (15-30)
4112c609719bSwdenk
41136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR:	System Clock and reset Control Register (15-27)
4114c609719bSwdenk
41156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM:
4116c609719bSwdenk		SDRAM timing
4117c609719bSwdenk
41186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA:
4119c609719bSwdenk		periodic timer for refresh
4120c609719bSwdenk
41216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER:	Debug Event Register (37-47)
4122c609719bSwdenk
41236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
41246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
41256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
41266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_BR1_PRELIM:
4127c609719bSwdenk		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4128c609719bSwdenk
4129c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
41306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
41316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
4132c609719bSwdenk		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4133c609719bSwdenk
41346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
41356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
4136c609719bSwdenk		Machine Mode Register and Memory Periodic Timer
4137c609719bSwdenk		Prescaler definitions (SDRAM timing)
4138c609719bSwdenk
41396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
4140c609719bSwdenk		enable I2C microcode relocation patch (MPC8xx);
4141c609719bSwdenk		define relocation offset in DPRAM [DSP2]
4142c609719bSwdenk
41436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
4144b423d055SHeiko Schocher		enable SMC microcode relocation patch (MPC8xx);
4145b423d055SHeiko Schocher		define relocation offset in DPRAM [SMC1]
4146b423d055SHeiko Schocher
41476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
4148c609719bSwdenk		enable SPI microcode relocation patch (MPC8xx);
4149c609719bSwdenk		define relocation offset in DPRAM [SCC4]
4150c609719bSwdenk
41516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_USE_OSCCLK:
4152c609719bSwdenk		Use OSCM clock mode on MBX8xx board. Be careful,
4153c609719bSwdenk		wrong setting might damage your board. Read
4154c609719bSwdenk		doc/README.MBX before setting this variable!
4155c609719bSwdenk
41566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
4157ea909b76Swdenk		Offset of the bootmode word in DPRAM used by post
4158ea909b76Swdenk		(Power On Self Tests). This definition overrides
4159ea909b76Swdenk		#define'd default value in commproc.h resp.
4160ea909b76Swdenk		cpm_8260.h.
4161ea909b76Swdenk
41626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
41636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
41646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
41656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
41666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
41676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
41686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
41696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
4170a47a12beSStefan Roese		Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
41715d232d0eSwdenk
41729cacf4fcSDirk Eibach- CONFIG_PCI_DISABLE_PCIE:
41739cacf4fcSDirk Eibach		Disable PCI-Express on systems where it is supported but not
41749cacf4fcSDirk Eibach		required.
41759cacf4fcSDirk Eibach
417669fd2d3bSAndrew Sharp- CONFIG_PCI_ENUM_ONLY
417769fd2d3bSAndrew Sharp		Only scan through and get the devices on the busses.
417869fd2d3bSAndrew Sharp		Don't do any setup work, presumably because someone or
417969fd2d3bSAndrew Sharp		something has already done it, and we don't need to do it
418069fd2d3bSAndrew Sharp		a second time.	Useful for platforms that are pre-booted
418169fd2d3bSAndrew Sharp		by coreboot or similar.
418269fd2d3bSAndrew Sharp
4183842033e6SGabor Juhos- CONFIG_PCI_INDIRECT_BRIDGE:
4184842033e6SGabor Juhos		Enable support for indirect PCI bridges.
4185842033e6SGabor Juhos
4186a09b9b68SKumar Gala- CONFIG_SYS_SRIO:
4187a09b9b68SKumar Gala		Chip has SRIO or not
4188a09b9b68SKumar Gala
4189a09b9b68SKumar Gala- CONFIG_SRIO1:
4190a09b9b68SKumar Gala		Board has SRIO 1 port available
4191a09b9b68SKumar Gala
4192a09b9b68SKumar Gala- CONFIG_SRIO2:
4193a09b9b68SKumar Gala		Board has SRIO 2 port available
4194a09b9b68SKumar Gala
4195c8b28152SLiu Gang- CONFIG_SRIO_PCIE_BOOT_MASTER
4196c8b28152SLiu Gang		Board can support master function for Boot from SRIO and PCIE
4197c8b28152SLiu Gang
4198a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_VIRT:
4199a09b9b68SKumar Gala		Virtual Address of SRIO port 'n' memory region
4200a09b9b68SKumar Gala
4201a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_PHYS:
4202a09b9b68SKumar Gala		Physical Address of SRIO port 'n' memory region
4203a09b9b68SKumar Gala
4204a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_SIZE:
4205a09b9b68SKumar Gala		Size of SRIO port 'n' memory region
4206a09b9b68SKumar Gala
420766bd1846SFabio Estevam- CONFIG_SYS_NAND_BUSWIDTH_16BIT
420866bd1846SFabio Estevam		Defined to tell the NAND controller that the NAND chip is using
420966bd1846SFabio Estevam		a 16 bit bus.
421066bd1846SFabio Estevam		Not all NAND drivers use this symbol.
4211a430e916SFabio Estevam		Example of drivers that use it:
421266bd1846SFabio Estevam		- drivers/mtd/nand/ndfc.c
4213a430e916SFabio Estevam		- drivers/mtd/nand/mxc_nand.c
4214eced4626SAlex Waterman
4215eced4626SAlex Waterman- CONFIG_SYS_NDFC_EBC0_CFG
4216eced4626SAlex Waterman		Sets the EBC0_CFG register for the NDFC. If not defined
4217eced4626SAlex Waterman		a default value will be used.
4218eced4626SAlex Waterman
4219bb99ad6dSBen Warren- CONFIG_SPD_EEPROM
4220218ca724SWolfgang Denk		Get DDR timing information from an I2C EEPROM. Common
4221218ca724SWolfgang Denk		with pluggable memory modules such as SODIMMs
4222218ca724SWolfgang Denk
4223bb99ad6dSBen Warren  SPD_EEPROM_ADDRESS
4224bb99ad6dSBen Warren		I2C address of the SPD EEPROM
4225bb99ad6dSBen Warren
42266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM
4227218ca724SWolfgang Denk		If SPD EEPROM is on an I2C bus other than the first
4228218ca724SWolfgang Denk		one, specify here. Note that the value must resolve
4229218ca724SWolfgang Denk		to something your driver can deal with.
4230bb99ad6dSBen Warren
42311b3e3c4fSYork Sun- CONFIG_SYS_DDR_RAW_TIMING
42321b3e3c4fSYork Sun		Get DDR timing information from other than SPD. Common with
42331b3e3c4fSYork Sun		soldered DDR chips onboard without SPD. DDR raw timing
42341b3e3c4fSYork Sun		parameters are extracted from datasheet and hard-coded into
42351b3e3c4fSYork Sun		header files or board specific files.
42361b3e3c4fSYork Sun
42376f5e1dc5SYork Sun- CONFIG_FSL_DDR_INTERACTIVE
42386f5e1dc5SYork Sun		Enable interactive DDR debugging. See doc/README.fsl-ddr.
42396f5e1dc5SYork Sun
42406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0
4241218ca724SWolfgang Denk		Only for 83xx systems. If specified, then DDR should
4242218ca724SWolfgang Denk		be configured using CS0 and CS1 instead of CS2 and CS3.
42432ad6b513STimur Tabi
4244c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12]
4245c26e454dSwdenk		Define to enable FEC[12] on a 8xx series processor.
4246c26e454dSwdenk
4247c26e454dSwdenk- CONFIG_FEC[12]_PHY
4248c26e454dSwdenk		Define to the hardcoded PHY address which corresponds
42496e592385Swdenk		to the given FEC; i. e.
4250c26e454dSwdenk			#define CONFIG_FEC1_PHY 4
4251c26e454dSwdenk		means that the PHY with address 4 is connected to FEC1
4252c26e454dSwdenk
4253c26e454dSwdenk		When set to -1, means to probe for first available.
4254c26e454dSwdenk
4255c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR
4256c26e454dSwdenk		The PHY does not have a RXERR line (RMII only).
4257c26e454dSwdenk		(so program the FEC to ignore it).
4258c26e454dSwdenk
4259c26e454dSwdenk- CONFIG_RMII
4260c26e454dSwdenk		Enable RMII mode for all FECs.
4261c26e454dSwdenk		Note that this is a global option, we can't
4262c26e454dSwdenk		have one FEC in standard MII mode and another in RMII mode.
4263c26e454dSwdenk
42645cf91d6bSwdenk- CONFIG_CRC32_VERIFY
42655cf91d6bSwdenk		Add a verify option to the crc32 command.
42665cf91d6bSwdenk		The syntax is:
42675cf91d6bSwdenk
42685cf91d6bSwdenk		=> crc32 -v <address> <count> <crc32>
42695cf91d6bSwdenk
42705cf91d6bSwdenk		Where address/count indicate a memory area
42715cf91d6bSwdenk		and crc32 is the correct crc32 which the
42725cf91d6bSwdenk		area should have.
42735cf91d6bSwdenk
427456523f12Swdenk- CONFIG_LOOPW
427556523f12Swdenk		Add the "loopw" memory command. This only takes effect if
4276602ad3b3SJon Loeliger		the memory commands are activated globally (CONFIG_CMD_MEM).
427756523f12Swdenk
42787b466641Sstroese- CONFIG_MX_CYCLIC
42797b466641Sstroese		Add the "mdc" and "mwc" memory commands. These are cyclic
42807b466641Sstroese		"md/mw" commands.
42817b466641Sstroese		Examples:
42827b466641Sstroese
42837b466641Sstroese		=> mdc.b 10 4 500
42847b466641Sstroese		This command will print 4 bytes (10,11,12,13) each 500 ms.
42857b466641Sstroese
42867b466641Sstroese		=> mwc.l 100 12345678 10
42877b466641Sstroese		This command will write 12345678 to address 100 all 10 ms.
42887b466641Sstroese
42897b466641Sstroese		This only takes effect if the memory commands are activated
4290602ad3b3SJon Loeliger		globally (CONFIG_CMD_MEM).
42917b466641Sstroese
42928aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT
4293afc1ce82SMacpaul Lin		[ARM, NDS32, MIPS only] If this variable is defined, then certain
4294e03f3169SWolfgang Denk		low level initializations (like setting up the memory
4295e03f3169SWolfgang Denk		controller) are omitted and/or U-Boot does not
4296e03f3169SWolfgang Denk		relocate itself into RAM.
42978aa1a2d1Swdenk
4298e03f3169SWolfgang Denk		Normally this variable MUST NOT be defined. The only
4299e03f3169SWolfgang Denk		exception is when U-Boot is loaded (to RAM) by some
4300e03f3169SWolfgang Denk		other boot loader or by a debugger which performs
4301e03f3169SWolfgang Denk		these initializations itself.
43028aa1a2d1Swdenk
4303401bb30bSAneesh V- CONFIG_SPL_BUILD
4304df81238bSMagnus Lilja		Modifies the behaviour of start.S when compiling a loader
4305df81238bSMagnus Lilja		that is executed before the actual U-Boot. E.g. when
4306df81238bSMagnus Lilja		compiling a NAND SPL.
4307400558b5Swdenk
43083aa29de0SYing Zhang- CONFIG_TPL_BUILD
43093aa29de0SYing Zhang		Modifies the behaviour of start.S  when compiling a loader
43103aa29de0SYing Zhang		that is executed after the SPL and before the actual U-Boot.
43113aa29de0SYing Zhang		It is loaded by the SPL.
43123aa29de0SYing Zhang
43135df572f0SYing Zhang- CONFIG_SYS_MPC85XX_NO_RESETVEC
43145df572f0SYing Zhang		Only for 85xx systems. If this variable is specified, the section
43155df572f0SYing Zhang		.resetvec is not kept and the section .bootpg is placed in the
43165df572f0SYing Zhang		previous 4k of the .text section.
43175df572f0SYing Zhang
43184213fc29SSimon Glass- CONFIG_ARCH_MAP_SYSMEM
43194213fc29SSimon Glass		Generally U-Boot (and in particular the md command) uses
43204213fc29SSimon Glass		effective address. It is therefore not necessary to regard
43214213fc29SSimon Glass		U-Boot address as virtual addresses that need to be translated
43224213fc29SSimon Glass		to physical addresses. However, sandbox requires this, since
43234213fc29SSimon Glass		it maintains its own little RAM buffer which contains all
43244213fc29SSimon Glass		addressable memory. This option causes some memory accesses
43254213fc29SSimon Glass		to be mapped through map_sysmem() / unmap_sysmem().
43264213fc29SSimon Glass
4327d8834a13SMatthias Weisser- CONFIG_USE_ARCH_MEMCPY
4328d8834a13SMatthias Weisser  CONFIG_USE_ARCH_MEMSET
4329d8834a13SMatthias Weisser		If these options are used a optimized version of memcpy/memset will
4330d8834a13SMatthias Weisser		be used if available. These functions may be faster under some
4331d8834a13SMatthias Weisser		conditions but may increase the binary size.
4332d8834a13SMatthias Weisser
4333588a13f7SSimon Glass- CONFIG_X86_RESET_VECTOR
4334588a13f7SSimon Glass		If defined, the x86 reset vector code is included. This is not
4335588a13f7SSimon Glass		needed when U-Boot is running from Coreboot.
4336b16f521aSGabe Black
4337fc33705eSMark Jackson- CONFIG_SYS_MPUCLK
4338fc33705eSMark Jackson		Defines the MPU clock speed (in MHz).
4339fc33705eSMark Jackson
4340fc33705eSMark Jackson		NOTE : currently only supported on AM335x platforms.
43415b5ece9eSGabe Black
4342f2717b47STimur TabiFreescale QE/FMAN Firmware Support:
4343f2717b47STimur Tabi-----------------------------------
4344f2717b47STimur Tabi
4345f2717b47STimur TabiThe Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4346f2717b47STimur Tabiloading of "firmware", which is encoded in the QE firmware binary format.
4347f2717b47STimur TabiThis firmware often needs to be loaded during U-Boot booting, so macros
4348f2717b47STimur Tabiare used to identify the storage device (NOR flash, SPI, etc) and the address
4349f2717b47STimur Tabiwithin that device.
4350f2717b47STimur Tabi
4351f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_ADDR
4352f2717b47STimur Tabi	The address in the storage device where the firmware is located.  The
4353f2717b47STimur Tabi	meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4354f2717b47STimur Tabi	is also specified.
4355f2717b47STimur Tabi
4356f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_LENGTH
4357f2717b47STimur Tabi	The maximum possible size of the firmware.  The firmware binary format
4358f2717b47STimur Tabi	has a field that specifies the actual size of the firmware, but it
4359f2717b47STimur Tabi	might not be possible to read any part of the firmware unless some
4360f2717b47STimur Tabi	local storage is allocated to hold the entire firmware first.
4361f2717b47STimur Tabi
4362f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4363f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4364f2717b47STimur Tabi	normal addressable memory via the LBC.  CONFIG_SYS_FMAN_FW_ADDR is the
4365f2717b47STimur Tabi	virtual address in NOR flash.
4366f2717b47STimur Tabi
4367f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4368f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NAND flash.
4369f2717b47STimur Tabi	CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4370f2717b47STimur Tabi
4371f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4372f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SD/MMC
4373f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4374f2717b47STimur Tabi
4375f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
4376f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SPI
4377f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4378f2717b47STimur Tabi
4379292dc6c5SLiu Gang- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4380292dc6c5SLiu Gang	Specifies that QE/FMAN firmware is located in the remote (master)
4381292dc6c5SLiu Gang	memory space.	CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
4382fc54c7faSLiu Gang	can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4383fc54c7faSLiu Gang	window->master inbound window->master LAW->the ucode address in
4384fc54c7faSLiu Gang	master's memory space.
4385f2717b47STimur Tabi
4386c609719bSwdenkBuilding the Software:
4387c609719bSwdenk======================
4388c609719bSwdenk
4389218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments
4390218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support
4391218ca724SWolfgang Denkall possibly existing versions of cross development tools in all
4392218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we
4393218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4394218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot.
4395c609719bSwdenk
4396218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you
4397218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case,
4398218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell.
4399218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are
4400218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter:
4401c609719bSwdenk
4402218ca724SWolfgang Denk	$ CROSS_COMPILE=ppc_4xx-
4403218ca724SWolfgang Denk	$ export CROSS_COMPILE
4404c609719bSwdenk
44052f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in
44062f8d396bSPeter Tyser      the tools directory you can use the MinGW toolchain
44072f8d396bSPeter Tyser      (http://www.mingw.org).  Set your HOST tools to the MinGW
44082f8d396bSPeter Tyser      toolchain and execute 'make tools'.  For example:
44092f8d396bSPeter Tyser
44102f8d396bSPeter Tyser       $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
44112f8d396bSPeter Tyser
44122f8d396bSPeter Tyser      Binaries such as tools/mkimage.exe will be created which can
44132f8d396bSPeter Tyser      be executed on computers running Windows.
44142f8d396bSPeter Tyser
4415c609719bSwdenkU-Boot is intended to be simple to build. After installing the
4416c609719bSwdenksources you must configure U-Boot for one specific board type. This
4417c609719bSwdenkis done by typing:
4418c609719bSwdenk
4419c609719bSwdenk	make NAME_config
4420c609719bSwdenk
4421218ca724SWolfgang Denkwhere "NAME_config" is the name of one of the existing configu-
44224d675ae6SMichael Jonesrations; see boards.cfg for supported names.
442354387ac9Swdenk
4424c609719bSwdenkNote: for some board special configuration names may exist; check if
4425c609719bSwdenk      additional information is available from the board vendor; for
44262729af9dSwdenk      instance, the TQM823L systems are available without (standard)
44272729af9dSwdenk      or with LCD support. You can select such additional "features"
442811ccc33fSMarcel Ziswiler      when choosing the configuration, i. e.
4429c609719bSwdenk
44302729af9dSwdenk      make TQM823L_config
44312729af9dSwdenk	- will configure for a plain TQM823L, i. e. no LCD support
4432c609719bSwdenk
4433c609719bSwdenk      make TQM823L_LCD_config
4434c609719bSwdenk	- will configure for a TQM823L with U-Boot console on LCD
4435c609719bSwdenk
4436c609719bSwdenk      etc.
4437c609719bSwdenk
4438c609719bSwdenk
4439c609719bSwdenkFinally, type "make all", and you should get some working U-Boot
44407152b1d0Swdenkimages ready for download to / installation on your system:
4441c609719bSwdenk
4442c609719bSwdenk- "u-boot.bin" is a raw binary image
4443c609719bSwdenk- "u-boot" is an image in ELF binary format
4444c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format
4445c609719bSwdenk
4446baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved
4447baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change
4448baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory:
4449baf31249SMarian Balakowicz
4450baf31249SMarian Balakowicz1. Add O= to the make command line invocations:
4451baf31249SMarian Balakowicz
4452baf31249SMarian Balakowicz	make O=/tmp/build distclean
4453baf31249SMarian Balakowicz	make O=/tmp/build NAME_config
4454baf31249SMarian Balakowicz	make O=/tmp/build all
4455baf31249SMarian Balakowicz
4456baf31249SMarian Balakowicz2. Set environment variable BUILD_DIR to point to the desired location:
4457baf31249SMarian Balakowicz
4458baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
4459baf31249SMarian Balakowicz	make distclean
4460baf31249SMarian Balakowicz	make NAME_config
4461baf31249SMarian Balakowicz	make all
4462baf31249SMarian Balakowicz
4463baf31249SMarian BalakowiczNote that the command line "O=" setting overrides the BUILD_DIR environment
4464baf31249SMarian Balakowiczvariable.
4465baf31249SMarian Balakowicz
4466c609719bSwdenk
4467c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so
4468c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of
4469c609719bSwdenknative "make".
4470c609719bSwdenk
4471c609719bSwdenk
4472c609719bSwdenkIf the system board that you have is not listed, then you will need
4473c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these
4474c609719bSwdenksteps:
4475c609719bSwdenk
4476c609719bSwdenk1.  Add a new configuration option for your board to the toplevel
44774d675ae6SMichael Jones    "boards.cfg" file, using the existing entries as examples.
44784d675ae6SMichael Jones    Follow the instructions there to keep the boards in order.
4479c609719bSwdenk2.  Create a new directory to hold your board specific code. Add any
448085ec0bccSwdenk    files you need. In your board directory, you will need at least
448185ec0bccSwdenk    the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
448285ec0bccSwdenk3.  Create a new configuration file "include/configs/<board>.h" for
448385ec0bccSwdenk    your board
4484c609719bSwdenk3.  If you're porting U-Boot to a new CPU, then also create a new
4485c609719bSwdenk    directory to hold your CPU specific code. Add any files you need.
448685ec0bccSwdenk4.  Run "make <board>_config" with your new name.
4487c609719bSwdenk5.  Type "make", and you should get a working "u-boot.srec" file
4488c609719bSwdenk    to be installed on your target system.
448985ec0bccSwdenk6.  Debug and solve any problems that might arise.
4490c609719bSwdenk    [Of course, this last step is much harder than it sounds.]
4491c609719bSwdenk
4492c609719bSwdenk
4493c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.:
4494c609719bSwdenk==============================================================
4495c609719bSwdenk
4496c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board
4497c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to
4498c609719bSwdenkprovide feedback to the other developers. The feedback normally takes
4499c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest
4500218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources.
4501c609719bSwdenk
4502c609719bSwdenkBut before you submit such a patch, please verify that your modifi-
4503c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of
4504c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so,
4505c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot
4506c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You can
45077152b1d0Swdenkselect which (cross) compiler to use by passing a `CROSS_COMPILE'
4508218ca724SWolfgang Denkenvironment variable to the script, i. e. to use the ELDK cross tools
4509218ca724SWolfgang Denkyou can type
4510c609719bSwdenk
4511c609719bSwdenk	CROSS_COMPILE=ppc_8xx- MAKEALL
4512c609719bSwdenk
4513c609719bSwdenkor to build on a native PowerPC system you can type
4514c609719bSwdenk
4515c609719bSwdenk	CROSS_COMPILE=' ' MAKEALL
4516c609719bSwdenk
4517218ca724SWolfgang DenkWhen using the MAKEALL script, the default behaviour is to build
4518218ca724SWolfgang DenkU-Boot in the source directory. This location can be changed by
4519218ca724SWolfgang Denksetting the BUILD_DIR environment variable. Also, for each target
4520218ca724SWolfgang Denkbuilt, the MAKEALL script saves two log files (<target>.ERR and
4521218ca724SWolfgang Denk<target>.MAKEALL) in the <source dir>/LOG directory. This default
4522218ca724SWolfgang Denklocation can be changed by setting the MAKEALL_LOGDIR environment
4523218ca724SWolfgang Denkvariable. For example:
4524baf31249SMarian Balakowicz
4525baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
4526baf31249SMarian Balakowicz	export MAKEALL_LOGDIR=/tmp/log
4527baf31249SMarian Balakowicz	CROSS_COMPILE=ppc_8xx- MAKEALL
4528baf31249SMarian Balakowicz
4529218ca724SWolfgang DenkWith the above settings build objects are saved in the /tmp/build,
4530218ca724SWolfgang Denklog files are saved in the /tmp/log and the source tree remains clean
4531218ca724SWolfgang Denkduring the whole build process.
4532baf31249SMarian Balakowicz
4533baf31249SMarian Balakowicz
4534c609719bSwdenkSee also "U-Boot Porting Guide" below.
4535c609719bSwdenk
4536c609719bSwdenk
4537c609719bSwdenkMonitor Commands - Overview:
4538c609719bSwdenk============================
4539c609719bSwdenk
4540c609719bSwdenkgo	- start application at address 'addr'
4541c609719bSwdenkrun	- run commands in an environment variable
4542c609719bSwdenkbootm	- boot application image from memory
4543c609719bSwdenkbootp	- boot image via network using BootP/TFTP protocol
454444f074c7SMarek Vasutbootz   - boot zImage from memory
4545c609719bSwdenktftpboot- boot image via network using TFTP protocol
4546c609719bSwdenk	       and env variables "ipaddr" and "serverip"
4547c609719bSwdenk	       (and eventually "gatewayip")
45481fb7cd49SSimon Glasstftpput - upload a file via network using TFTP protocol
4549c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol
4550c609719bSwdenkdiskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
4551c609719bSwdenkloads	- load S-Record file over serial line
4552c609719bSwdenkloadb	- load binary file over serial line (kermit mode)
4553c609719bSwdenkmd	- memory display
4554c609719bSwdenkmm	- memory modify (auto-incrementing)
4555c609719bSwdenknm	- memory modify (constant address)
4556c609719bSwdenkmw	- memory write (fill)
4557c609719bSwdenkcp	- memory copy
4558c609719bSwdenkcmp	- memory compare
4559c609719bSwdenkcrc32	- checksum calculation
45600f89c54bSPeter Tyseri2c	- I2C sub-system
4561c609719bSwdenksspi	- SPI utility commands
4562c609719bSwdenkbase	- print or set address offset
4563c609719bSwdenkprintenv- print environment variables
4564c609719bSwdenksetenv	- set environment variables
4565c609719bSwdenksaveenv - save environment variables to persistent storage
4566c609719bSwdenkprotect - enable or disable FLASH write protection
4567c609719bSwdenkerase	- erase FLASH memory
4568c609719bSwdenkflinfo	- print FLASH memory information
456910635afaSKarl O. Pincnand	- NAND memory operations (see doc/README.nand)
4570c609719bSwdenkbdinfo	- print Board Info structure
4571c609719bSwdenkiminfo	- print header information for application image
4572c609719bSwdenkconinfo - print console devices and informations
4573c609719bSwdenkide	- IDE sub-system
4574c609719bSwdenkloop	- infinite loop on address range
457556523f12Swdenkloopw	- infinite write loop on address range
4576c609719bSwdenkmtest	- simple RAM test
4577c609719bSwdenkicache	- enable or disable instruction cache
4578c609719bSwdenkdcache	- enable or disable data cache
4579c609719bSwdenkreset	- Perform RESET of the CPU
4580c609719bSwdenkecho	- echo args to console
4581c609719bSwdenkversion - print monitor version
4582c609719bSwdenkhelp	- print online help
4583c609719bSwdenk?	- alias for 'help'
4584c609719bSwdenk
4585c609719bSwdenk
4586c609719bSwdenkMonitor Commands - Detailed Description:
4587c609719bSwdenk========================================
4588c609719bSwdenk
4589c609719bSwdenkTODO.
4590c609719bSwdenk
4591c609719bSwdenkFor now: just type "help <command>".
4592c609719bSwdenk
4593c609719bSwdenk
4594c609719bSwdenkEnvironment Variables:
4595c609719bSwdenk======================
4596c609719bSwdenk
4597c609719bSwdenkU-Boot supports user configuration using Environment Variables which
4598c609719bSwdenkcan be made persistent by saving to Flash memory.
4599c609719bSwdenk
4600c609719bSwdenkEnvironment Variables are set using "setenv", printed using
4601c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv"
4602c609719bSwdenkwithout a value can be used to delete a variable from the
4603c609719bSwdenkenvironment. As long as you don't save the environment you are
4604c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the
4605c609719bSwdenkenvironment is erased by accident, a default environment is provided.
4606c609719bSwdenk
4607c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables.
4608c96f86eeSWolfgang Denk
4609c96f86eeSWolfgang DenkList of environment variables (most likely not complete):
4610c609719bSwdenk
4611c609719bSwdenk  baudrate	- see CONFIG_BAUDRATE
4612c609719bSwdenk
4613c609719bSwdenk  bootdelay	- see CONFIG_BOOTDELAY
4614c609719bSwdenk
4615c609719bSwdenk  bootcmd	- see CONFIG_BOOTCOMMAND
4616c609719bSwdenk
4617c609719bSwdenk  bootargs	- Boot arguments when booting an RTOS image
4618c609719bSwdenk
4619c609719bSwdenk  bootfile	- Name of the image to load with TFTP
4620c609719bSwdenk
46217d721e34SBartlomiej Sieka  bootm_low	- Memory range available for image processing in the bootm
46227d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
46237d721e34SBartlomiej Sieka		  a hexadecimal number and defines lowest address allowed
46247d721e34SBartlomiej Sieka		  for use by the bootm command. See also "bootm_size"
46257d721e34SBartlomiej Sieka		  environment variable. Address defined by "bootm_low" is
46267d721e34SBartlomiej Sieka		  also the base of the initial memory mapping for the Linux
4627c3624e6eSGrant Likely		  kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4628c3624e6eSGrant Likely		  bootm_mapsize.
4629c3624e6eSGrant Likely
4630c3624e6eSGrant Likely  bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
4631c3624e6eSGrant Likely		  This variable is given as a hexadecimal number and it
4632c3624e6eSGrant Likely		  defines the size of the memory region starting at base
4633c3624e6eSGrant Likely		  address bootm_low that is accessible by the Linux kernel
4634c3624e6eSGrant Likely		  during early boot.  If unset, CONFIG_SYS_BOOTMAPSZ is used
4635c3624e6eSGrant Likely		  as the default value if it is defined, and bootm_size is
4636c3624e6eSGrant Likely		  used otherwise.
46377d721e34SBartlomiej Sieka
46387d721e34SBartlomiej Sieka  bootm_size	- Memory range available for image processing in the bootm
46397d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
46407d721e34SBartlomiej Sieka		  a hexadecimal number and defines the size of the region
46417d721e34SBartlomiej Sieka		  allowed for use by the bootm command. See also "bootm_low"
46427d721e34SBartlomiej Sieka		  environment variable.
46437d721e34SBartlomiej Sieka
46444bae9090SBartlomiej Sieka  updatefile	- Location of the software update file on a TFTP server, used
46454bae9090SBartlomiej Sieka		  by the automatic software update feature. Please refer to
46464bae9090SBartlomiej Sieka		  documentation in doc/README.update for more details.
46474bae9090SBartlomiej Sieka
4648c609719bSwdenk  autoload	- if set to "no" (any string beginning with 'n'),
4649c609719bSwdenk		  "bootp" will just load perform a lookup of the
4650c609719bSwdenk		  configuration from the BOOTP server, but not try to
4651c609719bSwdenk		  load any image using TFTP
4652c609719bSwdenk
4653c609719bSwdenk  autostart	- if set to "yes", an image loaded using the "bootp",
4654c609719bSwdenk		  "rarpboot", "tftpboot" or "diskboot" commands will
4655c609719bSwdenk		  be automatically started (by internally calling
4656c609719bSwdenk		  "bootm")
4657c609719bSwdenk
46584a6fd34bSwdenk		  If set to "no", a standalone image passed to the
46594a6fd34bSwdenk		  "bootm" command will be copied to the load address
46604a6fd34bSwdenk		  (and eventually uncompressed), but NOT be started.
46614a6fd34bSwdenk		  This can be used to load and uncompress arbitrary
46624a6fd34bSwdenk		  data.
46634a6fd34bSwdenk
4664a28afca5SDavid A. Long  fdt_high	- if set this restricts the maximum address that the
4665a28afca5SDavid A. Long		  flattened device tree will be copied into upon boot.
4666fa34f6b2SShawn Guo		  For example, if you have a system with 1 GB memory
4667fa34f6b2SShawn Guo		  at physical address 0x10000000, while Linux kernel
4668fa34f6b2SShawn Guo		  only recognizes the first 704 MB as low memory, you
4669fa34f6b2SShawn Guo		  may need to set fdt_high as 0x3C000000 to have the
4670fa34f6b2SShawn Guo		  device tree blob be copied to the maximum address
4671fa34f6b2SShawn Guo		  of the 704 MB low memory, so that Linux kernel can
4672fa34f6b2SShawn Guo		  access it during the boot procedure.
4673fa34f6b2SShawn Guo
4674a28afca5SDavid A. Long		  If this is set to the special value 0xFFFFFFFF then
4675a28afca5SDavid A. Long		  the fdt will not be copied at all on boot.  For this
4676a28afca5SDavid A. Long		  to work it must reside in writable memory, have
4677a28afca5SDavid A. Long		  sufficient padding on the end of it for u-boot to
4678a28afca5SDavid A. Long		  add the information it needs into it, and the memory
4679a28afca5SDavid A. Long		  must be accessible by the kernel.
4680a28afca5SDavid A. Long
4681eea63e05SSimon Glass  fdtcontroladdr- if set this is the address of the control flattened
4682eea63e05SSimon Glass		  device tree used by U-Boot when CONFIG_OF_CONTROL is
4683eea63e05SSimon Glass		  defined.
4684eea63e05SSimon Glass
468517ea1177Swdenk  i2cfast	- (PPC405GP|PPC405EP only)
468617ea1177Swdenk		  if set to 'y' configures Linux I2C driver for fast
468717ea1177Swdenk		  mode (400kHZ). This environment variable is used in
468817ea1177Swdenk		  initialization code. So, for changes to be effective
468917ea1177Swdenk		  it must be saved and board must be reset.
469017ea1177Swdenk
4691c609719bSwdenk  initrd_high	- restrict positioning of initrd images:
4692c609719bSwdenk		  If this variable is not set, initrd images will be
4693c609719bSwdenk		  copied to the highest possible address in RAM; this
4694c609719bSwdenk		  is usually what you want since it allows for
4695c609719bSwdenk		  maximum initrd size. If for some reason you want to
4696c609719bSwdenk		  make sure that the initrd image is loaded below the
46976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		  CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
4698c609719bSwdenk		  variable to a value of "no" or "off" or "0".
4699c609719bSwdenk		  Alternatively, you can set it to a maximum upper
4700c609719bSwdenk		  address to use (U-Boot will still check that it
4701c609719bSwdenk		  does not overwrite the U-Boot stack and data).
4702c609719bSwdenk
4703c609719bSwdenk		  For instance, when you have a system with 16 MB
47047152b1d0Swdenk		  RAM, and want to reserve 4 MB from use by Linux,
4705c609719bSwdenk		  you can do this by adding "mem=12M" to the value of
4706c609719bSwdenk		  the "bootargs" variable. However, now you must make
47077152b1d0Swdenk		  sure that the initrd image is placed in the first
4708c609719bSwdenk		  12 MB as well - this can be done with
4709c609719bSwdenk
4710c609719bSwdenk		  setenv initrd_high 00c00000
4711c609719bSwdenk
471238b99261Swdenk		  If you set initrd_high to 0xFFFFFFFF, this is an
471338b99261Swdenk		  indication to U-Boot that all addresses are legal
471438b99261Swdenk		  for the Linux kernel, including addresses in flash
471538b99261Swdenk		  memory. In this case U-Boot will NOT COPY the
471638b99261Swdenk		  ramdisk at all. This may be useful to reduce the
471738b99261Swdenk		  boot time on your system, but requires that this
471838b99261Swdenk		  feature is supported by your Linux kernel.
471938b99261Swdenk
4720c609719bSwdenk  ipaddr	- IP address; needed for tftpboot command
4721c609719bSwdenk
4722c609719bSwdenk  loadaddr	- Default load address for commands like "bootp",
4723dc7c9a1aSwdenk		  "rarpboot", "tftpboot", "loadb" or "diskboot"
4724c609719bSwdenk
4725c609719bSwdenk  loads_echo	- see CONFIG_LOADS_ECHO
4726c609719bSwdenk
4727c609719bSwdenk  serverip	- TFTP server IP address; needed for tftpboot command
4728c609719bSwdenk
4729c609719bSwdenk  bootretry	- see CONFIG_BOOT_RETRY_TIME
4730c609719bSwdenk
4731c609719bSwdenk  bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
4732c609719bSwdenk
4733c609719bSwdenk  bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
4734c609719bSwdenk
4735e2a53458SMike Frysinger  ethprime	- controls which interface is used first.
4736a3d991bdSwdenk
4737e2a53458SMike Frysinger  ethact	- controls which interface is currently active.
4738e2a53458SMike Frysinger		  For example you can do the following
4739a3d991bdSwdenk
474048690d80SHeiko Schocher		  => setenv ethact FEC
474148690d80SHeiko Schocher		  => ping 192.168.0.1 # traffic sent on FEC
474248690d80SHeiko Schocher		  => setenv ethact SCC
474348690d80SHeiko Schocher		  => ping 10.0.0.1 # traffic sent on SCC
4744a3d991bdSwdenk
4745e1692577SMatthias Fuchs  ethrotate	- When set to "no" U-Boot does not go through all
4746e1692577SMatthias Fuchs		  available network interfaces.
4747e1692577SMatthias Fuchs		  It just stays at the currently selected interface.
4748e1692577SMatthias Fuchs
4749a3d991bdSwdenk  netretry	- When set to "no" each network operation will
4750a3d991bdSwdenk		  either succeed or fail without retrying.
47516e592385Swdenk		  When set to "once" the network operation will
47526e592385Swdenk		  fail when all the available network interfaces
47536e592385Swdenk		  are tried once without success.
4754a3d991bdSwdenk		  Useful on scripts which control the retry operation
4755a3d991bdSwdenk		  themselves.
4756a3d991bdSwdenk
4757b4e2f89dSJean-Christophe PLAGNIOL-VILLARD  npe_ucode	- set load address for the NPE microcode
4758a1cf027aSJean-Christophe PLAGNIOL-VILLARD
47598d51aacdSSimon Glass  silent_linux  - If set then linux will be told to boot silently, by
47608d51aacdSSimon Glass		  changing the console to be empty. If "yes" it will be
47618d51aacdSSimon Glass		  made silent. If "no" it will not be made silent. If
47628d51aacdSSimon Glass		  unset, then it will be made silent if the U-Boot console
47638d51aacdSSimon Glass		  is silent.
47648d51aacdSSimon Glass
476528cb9375SWolfgang Denk  tftpsrcport	- If this is set, the value is used for TFTP's
4766ecb0ccd9SWolfgang Denk		  UDP source port.
4767ecb0ccd9SWolfgang Denk
476828cb9375SWolfgang Denk  tftpdstport	- If this is set, the value is used for TFTP's UDP
476928cb9375SWolfgang Denk		  destination port instead of the Well Know Port 69.
477028cb9375SWolfgang Denk
4771c96f86eeSWolfgang Denk  tftpblocksize - Block size to use for TFTP transfers; if not set,
4772c96f86eeSWolfgang Denk		  we use the TFTP server's default block size
4773c96f86eeSWolfgang Denk
4774c96f86eeSWolfgang Denk  tftptimeout	- Retransmission timeout for TFTP packets (in milli-
4775c96f86eeSWolfgang Denk		  seconds, minimum value is 1000 = 1 second). Defines
4776c96f86eeSWolfgang Denk		  when a packet is considered to be lost so it has to
4777c96f86eeSWolfgang Denk		  be retransmitted. The default is 5000 = 5 seconds.
4778c96f86eeSWolfgang Denk		  Lowering this value may make downloads succeed
4779c96f86eeSWolfgang Denk		  faster in networks with high packet loss rates or
4780c96f86eeSWolfgang Denk		  with unreliable TFTP servers.
4781c96f86eeSWolfgang Denk
4782a3d991bdSwdenk  vlan		- When set to a value < 4095 the traffic over
478311ccc33fSMarcel Ziswiler		  Ethernet is encapsulated/received over 802.1q
4784a3d991bdSwdenk		  VLAN tagged frames.
4785c609719bSwdenk
4786dc0b7b0eSJason HobbsThe following image location variables contain the location of images
4787dc0b7b0eSJason Hobbsused in booting. The "Image" column gives the role of the image and is
4788dc0b7b0eSJason Hobbsnot an environment variable name. The other columns are environment
4789dc0b7b0eSJason Hobbsvariable names. "File Name" gives the name of the file on a TFTP
4790dc0b7b0eSJason Hobbsserver, "RAM Address" gives the location in RAM the image will be
4791dc0b7b0eSJason Hobbsloaded to, and "Flash Location" gives the image's address in NOR
4792dc0b7b0eSJason Hobbsflash or offset in NAND flash.
4793dc0b7b0eSJason Hobbs
4794dc0b7b0eSJason Hobbs*Note* - these variables don't have to be defined for all boards, some
4795dc0b7b0eSJason Hobbsboards currenlty use other variables for these purposes, and some
4796dc0b7b0eSJason Hobbsboards use these variables for other purposes.
4797dc0b7b0eSJason Hobbs
4798dc0b7b0eSJason HobbsImage		    File Name	     RAM Address       Flash Location
4799dc0b7b0eSJason Hobbs-----		    ---------	     -----------       --------------
4800dc0b7b0eSJason Hobbsu-boot		    u-boot	     u-boot_addr_r     u-boot_addr
4801dc0b7b0eSJason HobbsLinux kernel	    bootfile	     kernel_addr_r     kernel_addr
4802dc0b7b0eSJason Hobbsdevice tree blob    fdtfile	     fdt_addr_r	       fdt_addr
4803dc0b7b0eSJason Hobbsramdisk		    ramdiskfile	     ramdisk_addr_r    ramdisk_addr
4804dc0b7b0eSJason Hobbs
4805c609719bSwdenkThe following environment variables may be used and automatically
4806c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"),
4807c609719bSwdenkdepending the information provided by your boot server:
4808c609719bSwdenk
4809c609719bSwdenk  bootfile	- see above
4810c609719bSwdenk  dnsip		- IP address of your Domain Name Server
4811fe389a82Sstroese  dnsip2	- IP address of your secondary Domain Name Server
4812c609719bSwdenk  gatewayip	- IP address of the Gateway (Router) to use
4813c609719bSwdenk  hostname	- Target hostname
4814c609719bSwdenk  ipaddr	- see above
4815c609719bSwdenk  netmask	- Subnet Mask
4816c609719bSwdenk  rootpath	- Pathname of the root filesystem on the NFS server
4817c609719bSwdenk  serverip	- see above
4818c609719bSwdenk
4819c609719bSwdenk
4820c609719bSwdenkThere are two special Environment Variables:
4821c609719bSwdenk
4822c609719bSwdenk  serial#	- contains hardware identification information such
4823c609719bSwdenk		  as type string and/or serial number
4824c609719bSwdenk  ethaddr	- Ethernet address
4825c609719bSwdenk
4826c609719bSwdenkThese variables can be set only once (usually during manufacturing of
4827c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables
4828c609719bSwdenkonce they have been set once.
4829c609719bSwdenk
4830c609719bSwdenk
4831c1551ea8SstroeseFurther special Environment Variables:
4832c1551ea8Sstroese
4833c1551ea8Sstroese  ver		- Contains the U-Boot version string as printed
4834c1551ea8Sstroese		  with the "version" command. This variable is
4835c1551ea8Sstroese		  readonly (see CONFIG_VERSION_VARIABLE).
4836c1551ea8Sstroese
4837c1551ea8Sstroese
4838c609719bSwdenkPlease note that changes to some configuration parameters may take
4839c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-).
4840c609719bSwdenk
4841c609719bSwdenk
4842170ab110SJoe HershbergerCallback functions for environment variables:
4843170ab110SJoe Hershberger---------------------------------------------
4844170ab110SJoe Hershberger
4845170ab110SJoe HershbergerFor some environment variables, the behavior of u-boot needs to change
4846170ab110SJoe Hershbergerwhen their values are changed.  This functionailty allows functions to
4847170ab110SJoe Hershbergerbe associated with arbitrary variables.  On creation, overwrite, or
4848170ab110SJoe Hershbergerdeletion, the callback will provide the opportunity for some side
4849170ab110SJoe Hershbergereffect to happen or for the change to be rejected.
4850170ab110SJoe Hershberger
4851170ab110SJoe HershbergerThe callbacks are named and associated with a function using the
4852170ab110SJoe HershbergerU_BOOT_ENV_CALLBACK macro in your board or driver code.
4853170ab110SJoe Hershberger
4854170ab110SJoe HershbergerThese callbacks are associated with variables in one of two ways.  The
4855170ab110SJoe Hershbergerstatic list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
4856170ab110SJoe Hershbergerin the board configuration to a string that defines a list of
4857170ab110SJoe Hershbergerassociations.  The list must be in the following format:
4858170ab110SJoe Hershberger
4859170ab110SJoe Hershberger	entry = variable_name[:callback_name]
4860170ab110SJoe Hershberger	list = entry[,list]
4861170ab110SJoe Hershberger
4862170ab110SJoe HershbergerIf the callback name is not specified, then the callback is deleted.
4863170ab110SJoe HershbergerSpaces are also allowed anywhere in the list.
4864170ab110SJoe Hershberger
4865170ab110SJoe HershbergerCallbacks can also be associated by defining the ".callbacks" variable
4866170ab110SJoe Hershbergerwith the same list format above.  Any association in ".callbacks" will
4867170ab110SJoe Hershbergeroverride any association in the static list. You can define
4868170ab110SJoe HershbergerCONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
4869170ab110SJoe Hershberger".callbacks" envirnoment variable in the default or embedded environment.
4870170ab110SJoe Hershberger
4871170ab110SJoe Hershberger
4872f07771ccSwdenkCommand Line Parsing:
4873f07771ccSwdenk=====================
4874f07771ccSwdenk
4875f07771ccSwdenkThere are two different command line parsers available with U-Boot:
48767152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell:
4877f07771ccSwdenk
4878f07771ccSwdenkOld, simple command line parser:
4879f07771ccSwdenk--------------------------------
4880f07771ccSwdenk
4881f07771ccSwdenk- supports environment variables (through setenv / saveenv commands)
4882f07771ccSwdenk- several commands on one line, separated by ';'
4883fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax
4884f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\',
4885f07771ccSwdenk  for example:
4886fe126d8bSWolfgang Denk	setenv bootcmd bootm \${address}
4887f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example:
4888f07771ccSwdenk	setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
4889f07771ccSwdenk
4890f07771ccSwdenkHush shell:
4891f07771ccSwdenk-----------
4892f07771ccSwdenk
4893f07771ccSwdenk- similar to Bourne shell, with control structures like
4894f07771ccSwdenk  if...then...else...fi, for...do...done; while...do...done,
4895f07771ccSwdenk  until...do...done, ...
4896f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv
4897f07771ccSwdenk  commands) and local shell variables (through standard shell syntax
4898f07771ccSwdenk  "name=value"); only environment variables can be used with "run"
4899f07771ccSwdenk  command
4900f07771ccSwdenk
4901f07771ccSwdenkGeneral rules:
4902f07771ccSwdenk--------------
4903f07771ccSwdenk
4904f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run"
4905f07771ccSwdenk    command) contains several commands separated by semicolon, and
4906f07771ccSwdenk    one of these commands fails, then the remaining commands will be
4907f07771ccSwdenk    executed anyway.
4908f07771ccSwdenk
4909f07771ccSwdenk(2) If you execute several variables with one call to run (i. e.
491011ccc33fSMarcel Ziswiler    calling run with a list of variables as arguments), any failing
4911f07771ccSwdenk    command will cause "run" to terminate, i. e. the remaining
4912f07771ccSwdenk    variables are not executed.
4913f07771ccSwdenk
4914c609719bSwdenkNote for Redundant Ethernet Interfaces:
4915c609719bSwdenk=======================================
4916c609719bSwdenk
491711ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports
4918c609719bSwdenksuch configurations and is capable of automatic selection of a
49197152b1d0Swdenk"working" interface when needed. MAC assignment works as follows:
4920c609719bSwdenk
4921c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding
4922c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0),
4923c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ...
4924c609719bSwdenk
4925c609719bSwdenkIf the network interface stores some valid MAC address (for instance
4926c609719bSwdenkin SROM), this is used as default address if there is NO correspon-
4927c609719bSwdenkding setting in the environment; if the corresponding environment
4928c609719bSwdenkvariable is set, this overrides the settings in the card; that means:
4929c609719bSwdenk
4930c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the
4931c609719bSwdenk  environment, the SROM's address is used.
4932c609719bSwdenk
4933c609719bSwdenko If there is no valid address in the SROM, and a definition in the
4934c609719bSwdenk  environment exists, then the value from the environment variable is
4935c609719bSwdenk  used.
4936c609719bSwdenk
4937c609719bSwdenko If both the SROM and the environment contain a MAC address, and
4938c609719bSwdenk  both addresses are the same, this MAC address is used.
4939c609719bSwdenk
4940c609719bSwdenko If both the SROM and the environment contain a MAC address, and the
4941c609719bSwdenk  addresses differ, the value from the environment is used and a
4942c609719bSwdenk  warning is printed.
4943c609719bSwdenk
4944c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error
4945c609719bSwdenk  is raised.
4946c609719bSwdenk
4947ecee9324SBen WarrenIf Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
4948ecee9324SBen Warrenwill be programmed into hardware as part of the initialization process.	 This
4949ecee9324SBen Warrenmay be skipped by setting the appropriate 'ethmacskip' environment variable.
4950ecee9324SBen WarrenThe naming convention is as follows:
4951ecee9324SBen Warren"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
4952c609719bSwdenk
4953c609719bSwdenkImage Formats:
4954c609719bSwdenk==============
4955c609719bSwdenk
49563310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on)
49573310c549SMarian Balakowiczimages in two formats:
49583310c549SMarian Balakowicz
49593310c549SMarian BalakowiczNew uImage format (FIT)
49603310c549SMarian Balakowicz-----------------------
49613310c549SMarian Balakowicz
49623310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar
49633310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple
49643310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by
49653310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
49663310c549SMarian Balakowicz
49673310c549SMarian Balakowicz
49683310c549SMarian BalakowiczOld uImage format
49693310c549SMarian Balakowicz-----------------
49703310c549SMarian Balakowicz
49713310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything,
49723310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for
49733310c549SMarian Balakowiczdetails; basically, the header defines the following image properties:
4974c609719bSwdenk
4975c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
4976c609719bSwdenk  4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
4977f5ed9e39SPeter Tyser  LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
4978f5ed9e39SPeter Tyser  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
4979f5ed9e39SPeter Tyser  INTEGRITY).
49807b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
4981afc1ce82SMacpaul Lin  IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
4982afc1ce82SMacpaul Lin  Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
4983c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2)
4984c609719bSwdenk* Load Address
4985c609719bSwdenk* Entry Point
4986c609719bSwdenk* Image Name
4987c609719bSwdenk* Image Timestamp
4988c609719bSwdenk
4989c609719bSwdenkThe header is marked by a special Magic Number, and both the header
4990c609719bSwdenkand the data portions of the image are secured against corruption by
4991c609719bSwdenkCRC32 checksums.
4992c609719bSwdenk
4993c609719bSwdenk
4994c609719bSwdenkLinux Support:
4995c609719bSwdenk==============
4996c609719bSwdenk
4997c609719bSwdenkAlthough U-Boot should support any OS or standalone application
49987152b1d0Swdenkeasily, the main focus has always been on Linux during the design of
4999c609719bSwdenkU-Boot.
5000c609719bSwdenk
5001c609719bSwdenkU-Boot includes many features that so far have been part of some
5002c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any
5003c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image;
5004c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation
50057152b1d0Swdenkserves several purposes:
5006c609719bSwdenk
5007c609719bSwdenk- the same features can be used for other OS or standalone
5008c609719bSwdenk  applications (for instance: using compressed images to reduce the
5009c609719bSwdenk  Flash memory footprint)
5010c609719bSwdenk
5011c609719bSwdenk- it becomes much easier to port new Linux kernel versions because
50127152b1d0Swdenk  lots of low-level, hardware dependent stuff are done by U-Boot
5013c609719bSwdenk
5014c609719bSwdenk- the same Linux kernel image can now be used with different "initrd"
5015c609719bSwdenk  images; of course this also means that different kernel images can
5016c609719bSwdenk  be run with the same "initrd". This makes testing easier (you don't
5017c609719bSwdenk  have to build a new "zImage.initrd" Linux image when you just
5018c609719bSwdenk  change a file in your "initrd"). Also, a field-upgrade of the
5019c609719bSwdenk  software is easier now.
5020c609719bSwdenk
5021c609719bSwdenk
5022c609719bSwdenkLinux HOWTO:
5023c609719bSwdenk============
5024c609719bSwdenk
5025c609719bSwdenkPorting Linux to U-Boot based systems:
5026c609719bSwdenk---------------------------------------
5027c609719bSwdenk
5028c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to
5029c609719bSwdenkconfigure the Linux device drivers for use with your target hardware
5030c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to
5031c609719bSwdenkLinux :-).
5032c609719bSwdenk
5033a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
5034c609719bSwdenk
5035c609719bSwdenkJust make sure your machine specific header file (for instance
5036c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board
50371dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h,
50381dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value
50396d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR.
5040c609719bSwdenk
5041c609719bSwdenk
5042c609719bSwdenkConfiguring the Linux kernel:
5043c609719bSwdenk-----------------------------
5044c609719bSwdenk
5045c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root
5046c609719bSwdenkdevice (initial ramdisk, NFS) for your target system.
5047c609719bSwdenk
5048c609719bSwdenk
5049c609719bSwdenkBuilding a Linux Image:
5050c609719bSwdenk-----------------------
5051c609719bSwdenk
505224ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are
505324ee89b9Swdenknot used. If you use recent kernel source, a new build target
505424ee89b9Swdenk"uImage" will exist which automatically builds an image usable by
505524ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target,
505624ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a
505724ee89b9Swdenk100% compatible format.
5058c609719bSwdenk
5059c609719bSwdenkExample:
5060c609719bSwdenk
5061c609719bSwdenk	make TQM850L_config
5062c609719bSwdenk	make oldconfig
5063c609719bSwdenk	make dep
506424ee89b9Swdenk	make uImage
5065c609719bSwdenk
506624ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to
506724ee89b9Swdenkencapsulate a compressed Linux kernel image with header	 information,
506824ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing:
5069c609719bSwdenk
507024ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format):
507124ee89b9Swdenk
507224ee89b9Swdenk* convert the kernel into a raw binary image:
507324ee89b9Swdenk
507424ee89b9Swdenk	${CROSS_COMPILE}-objcopy -O binary \
507524ee89b9Swdenk				 -R .note -R .comment \
507624ee89b9Swdenk				 -S vmlinux linux.bin
507724ee89b9Swdenk
507824ee89b9Swdenk* compress the binary image:
507924ee89b9Swdenk
508024ee89b9Swdenk	gzip -9 linux.bin
508124ee89b9Swdenk
508224ee89b9Swdenk* package compressed binary image for U-Boot:
508324ee89b9Swdenk
508424ee89b9Swdenk	mkimage -A ppc -O linux -T kernel -C gzip \
508524ee89b9Swdenk		-a 0 -e 0 -n "Linux Kernel Image" \
508624ee89b9Swdenk		-d linux.bin.gz uImage
508724ee89b9Swdenk
508824ee89b9Swdenk
508924ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use
509024ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or
509124ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64
509224ee89b9Swdenkbyte header containing information about target architecture,
509324ee89b9Swdenkoperating system, image type, compression method, entry points, time
509424ee89b9Swdenkstamp, CRC32 checksums, etc.
509524ee89b9Swdenk
509624ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and
509724ee89b9Swdenkprint the header information, or to build new images.
5098c609719bSwdenk
5099c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information
5100c609719bSwdenkcontained in the header of an existing U-Boot image; this includes
5101c609719bSwdenkchecksum verification:
5102c609719bSwdenk
5103c609719bSwdenk	tools/mkimage -l image
5104c609719bSwdenk	  -l ==> list image header information
5105c609719bSwdenk
5106c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image
5107c609719bSwdenkfrom a "data file" which is used as image payload:
5108c609719bSwdenk
5109c609719bSwdenk	tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5110c609719bSwdenk		      -n name -d data_file image
5111c609719bSwdenk	  -A ==> set architecture to 'arch'
5112c609719bSwdenk	  -O ==> set operating system to 'os'
5113c609719bSwdenk	  -T ==> set image type to 'type'
5114c609719bSwdenk	  -C ==> set compression type 'comp'
5115c609719bSwdenk	  -a ==> set load address to 'addr' (hex)
5116c609719bSwdenk	  -e ==> set entry point to 'ep' (hex)
5117c609719bSwdenk	  -n ==> set image name to 'name'
5118c609719bSwdenk	  -d ==> use image data from 'datafile'
5119c609719bSwdenk
512069459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load
512169459791Swdenkaddress (0x00000000), but the entry point address depends on the
512269459791Swdenkkernel version:
5123c609719bSwdenk
5124c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C,
512524ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000.
5126c609719bSwdenk
5127c609719bSwdenkSo a typical call to build a U-Boot image would read:
5128c609719bSwdenk
512924ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
513024ee89b9Swdenk	> -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
5131a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
513224ee89b9Swdenk	> examples/uImage.TQM850L
513324ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5134c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5135c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
5136c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
5137c609719bSwdenk	Load Address: 0x00000000
513824ee89b9Swdenk	Entry Point:  0x00000000
5139c609719bSwdenk
5140c609719bSwdenkTo verify the contents of the image (or check for corruption):
5141c609719bSwdenk
514224ee89b9Swdenk	-> tools/mkimage -l examples/uImage.TQM850L
514324ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5144c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5145c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
5146c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
5147c609719bSwdenk	Load Address: 0x00000000
514824ee89b9Swdenk	Entry Point:  0x00000000
5149c609719bSwdenk
5150c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade
5151c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this
5152c609719bSwdenkneeds more space in Flash, but boots much faster since it does not
5153c609719bSwdenkneed to be uncompressed:
5154c609719bSwdenk
5155a47a12beSStefan Roese	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
515624ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
515724ee89b9Swdenk	> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
5158a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
515924ee89b9Swdenk	> examples/uImage.TQM850L-uncompressed
516024ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5161c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5162c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (uncompressed)
5163c609719bSwdenk	Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
5164c609719bSwdenk	Load Address: 0x00000000
516524ee89b9Swdenk	Entry Point:  0x00000000
5166c609719bSwdenk
5167c609719bSwdenk
5168c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file
5169c609719bSwdenkwhen your kernel is intended to use an initial ramdisk:
5170c609719bSwdenk
5171c609719bSwdenk	-> tools/mkimage -n 'Simple Ramdisk Image' \
5172c609719bSwdenk	> -A ppc -O linux -T ramdisk -C gzip \
5173c609719bSwdenk	> -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5174c609719bSwdenk	Image Name:   Simple Ramdisk Image
5175c609719bSwdenk	Created:      Wed Jan 12 14:01:50 2000
5176c609719bSwdenk	Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
5177c609719bSwdenk	Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
5178c609719bSwdenk	Load Address: 0x00000000
5179c609719bSwdenk	Entry Point:  0x00000000
5180c609719bSwdenk
5181c609719bSwdenk
5182c609719bSwdenkInstalling a Linux Image:
5183c609719bSwdenk-------------------------
5184c609719bSwdenk
5185c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface,
5186c609719bSwdenkyou must convert the image to S-Record format:
5187c609719bSwdenk
5188c609719bSwdenk	objcopy -I binary -O srec examples/image examples/image.srec
5189c609719bSwdenk
5190c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot
5191c609719bSwdenkimage header, so the resulting S-Record file will be relative to
5192c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to
5193c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads'
5194c609719bSwdenkcommand.
5195c609719bSwdenk
5196c609719bSwdenkExample: install the image to address 0x40100000 (which on the
5197c609719bSwdenkTQM8xxL is in the first Flash bank):
5198c609719bSwdenk
5199c609719bSwdenk	=> erase 40100000 401FFFFF
5200c609719bSwdenk
5201c609719bSwdenk	.......... done
5202c609719bSwdenk	Erased 8 sectors
5203c609719bSwdenk
5204c609719bSwdenk	=> loads 40100000
5205c609719bSwdenk	## Ready for S-Record download ...
5206c609719bSwdenk	~>examples/image.srec
5207c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5208c609719bSwdenk	...
5209c609719bSwdenk	15989 15990 15991 15992
5210c609719bSwdenk	[file transfer complete]
5211c609719bSwdenk	[connected]
5212c609719bSwdenk	## Start Addr = 0x00000000
5213c609719bSwdenk
5214c609719bSwdenk
5215c609719bSwdenkYou can check the success of the download using the 'iminfo' command;
5216c609719bSwdenkthis includes a checksum verification so you can be sure no data
5217c609719bSwdenkcorruption happened:
5218c609719bSwdenk
5219c609719bSwdenk	=> imi 40100000
5220c609719bSwdenk
5221c609719bSwdenk	## Checking Image at 40100000 ...
5222c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5223c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5224c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5225c609719bSwdenk	   Load Address: 00000000
5226c609719bSwdenk	   Entry Point:	 0000000c
5227c609719bSwdenk	   Verifying Checksum ... OK
5228c609719bSwdenk
5229c609719bSwdenk
5230c609719bSwdenkBoot Linux:
5231c609719bSwdenk-----------
5232c609719bSwdenk
5233c609719bSwdenkThe "bootm" command is used to boot an application that is stored in
5234c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents
5235c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as
5236c609719bSwdenkparameters. You can check and modify this variable using the
5237c609719bSwdenk"printenv" and "setenv" commands:
5238c609719bSwdenk
5239c609719bSwdenk
5240c609719bSwdenk	=> printenv bootargs
5241c609719bSwdenk	bootargs=root=/dev/ram
5242c609719bSwdenk
5243c609719bSwdenk	=> setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5244c609719bSwdenk
5245c609719bSwdenk	=> printenv bootargs
5246c609719bSwdenk	bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5247c609719bSwdenk
5248c609719bSwdenk	=> bootm 40020000
5249c609719bSwdenk	## Booting Linux kernel at 40020000 ...
5250c609719bSwdenk	   Image Name:	 2.2.13 for NFS on TQM850L
5251c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5252c609719bSwdenk	   Data Size:	 381681 Bytes = 372 kB = 0 MB
5253c609719bSwdenk	   Load Address: 00000000
5254c609719bSwdenk	   Entry Point:	 0000000c
5255c609719bSwdenk	   Verifying Checksum ... OK
5256c609719bSwdenk	   Uncompressing Kernel Image ... OK
5257c609719bSwdenk	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
5258c609719bSwdenk	Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5259c609719bSwdenk	time_init: decrementer frequency = 187500000/60
5260c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
5261c609719bSwdenk	Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5262c609719bSwdenk	...
5263c609719bSwdenk
526411ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass
52657152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT
5266c609719bSwdenkformat!) to the "bootm" command:
5267c609719bSwdenk
5268c609719bSwdenk	=> imi 40100000 40200000
5269c609719bSwdenk
5270c609719bSwdenk	## Checking Image at 40100000 ...
5271c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5272c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5273c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5274c609719bSwdenk	   Load Address: 00000000
5275c609719bSwdenk	   Entry Point:	 0000000c
5276c609719bSwdenk	   Verifying Checksum ... OK
5277c609719bSwdenk
5278c609719bSwdenk	## Checking Image at 40200000 ...
5279c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
5280c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
5281c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
5282c609719bSwdenk	   Load Address: 00000000
5283c609719bSwdenk	   Entry Point:	 00000000
5284c609719bSwdenk	   Verifying Checksum ... OK
5285c609719bSwdenk
5286c609719bSwdenk	=> bootm 40100000 40200000
5287c609719bSwdenk	## Booting Linux kernel at 40100000 ...
5288c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5289c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5290c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5291c609719bSwdenk	   Load Address: 00000000
5292c609719bSwdenk	   Entry Point:	 0000000c
5293c609719bSwdenk	   Verifying Checksum ... OK
5294c609719bSwdenk	   Uncompressing Kernel Image ... OK
5295c609719bSwdenk	## Loading RAMDisk Image at 40200000 ...
5296c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
5297c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
5298c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
5299c609719bSwdenk	   Load Address: 00000000
5300c609719bSwdenk	   Entry Point:	 00000000
5301c609719bSwdenk	   Verifying Checksum ... OK
5302c609719bSwdenk	   Loading Ramdisk ... OK
5303c609719bSwdenk	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
5304c609719bSwdenk	Boot arguments: root=/dev/ram
5305c609719bSwdenk	time_init: decrementer frequency = 187500000/60
5306c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
5307c609719bSwdenk	...
5308c609719bSwdenk	RAMDISK: Compressed image found at block 0
5309c609719bSwdenk	VFS: Mounted root (ext2 filesystem).
5310c609719bSwdenk
5311c609719bSwdenk	bash#
5312c609719bSwdenk
53130267768eSMatthew McClintockBoot Linux and pass a flat device tree:
53140267768eSMatthew McClintock-----------
53150267768eSMatthew McClintock
53160267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section
53170267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The
53180267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated
53190267768eSMatthew McClintockflat device tree:
53200267768eSMatthew McClintock
53210267768eSMatthew McClintock=> print oftaddr
53220267768eSMatthew McClintockoftaddr=0x300000
53230267768eSMatthew McClintock=> print oft
53240267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb
53250267768eSMatthew McClintock=> tftp $oftaddr $oft
53260267768eSMatthew McClintockSpeed: 1000, full duplex
53270267768eSMatthew McClintockUsing TSEC0 device
53280267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101
53290267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'.
53300267768eSMatthew McClintockLoad address: 0x300000
53310267768eSMatthew McClintockLoading: #
53320267768eSMatthew McClintockdone
53330267768eSMatthew McClintockBytes transferred = 4106 (100a hex)
53340267768eSMatthew McClintock=> tftp $loadaddr $bootfile
53350267768eSMatthew McClintockSpeed: 1000, full duplex
53360267768eSMatthew McClintockUsing TSEC0 device
53370267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2
53380267768eSMatthew McClintockFilename 'uImage'.
53390267768eSMatthew McClintockLoad address: 0x200000
53400267768eSMatthew McClintockLoading:############
53410267768eSMatthew McClintockdone
53420267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex)
53430267768eSMatthew McClintock=> print loadaddr
53440267768eSMatthew McClintockloadaddr=200000
53450267768eSMatthew McClintock=> print oftaddr
53460267768eSMatthew McClintockoftaddr=0x300000
53470267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr
53480267768eSMatthew McClintock## Booting image at 00200000 ...
53490267768eSMatthew McClintock   Image Name:	 Linux-2.6.17-dirty
53500267768eSMatthew McClintock   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
53510267768eSMatthew McClintock   Data Size:	 1029343 Bytes = 1005.2 kB
53520267768eSMatthew McClintock   Load Address: 00000000
53530267768eSMatthew McClintock   Entry Point:	 00000000
53540267768eSMatthew McClintock   Verifying Checksum ... OK
53550267768eSMatthew McClintock   Uncompressing Kernel Image ... OK
53560267768eSMatthew McClintockBooting using flat device tree at 0x300000
53570267768eSMatthew McClintockUsing MPC85xx ADS machine description
53580267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
53590267768eSMatthew McClintock[snip]
53600267768eSMatthew McClintock
53610267768eSMatthew McClintock
53626069ff26SwdenkMore About U-Boot Image Types:
53636069ff26Swdenk------------------------------
53646069ff26Swdenk
53656069ff26SwdenkU-Boot supports the following image types:
53666069ff26Swdenk
53676069ff26Swdenk   "Standalone Programs" are directly runnable in the environment
53686069ff26Swdenk	provided by U-Boot; it is expected that (if they behave
53696069ff26Swdenk	well) you can continue to work in U-Boot after return from
53706069ff26Swdenk	the Standalone Program.
53716069ff26Swdenk   "OS Kernel Images" are usually images of some Embedded OS which
53726069ff26Swdenk	will take over control completely. Usually these programs
53736069ff26Swdenk	will install their own set of exception handlers, device
53746069ff26Swdenk	drivers, set up the MMU, etc. - this means, that you cannot
53756069ff26Swdenk	expect to re-enter U-Boot except by resetting the CPU.
53766069ff26Swdenk   "RAMDisk Images" are more or less just data blocks, and their
53776069ff26Swdenk	parameters (address, size) are passed to an OS kernel that is
53786069ff26Swdenk	being started.
53796069ff26Swdenk   "Multi-File Images" contain several images, typically an OS
53806069ff26Swdenk	(Linux) kernel image and one or more data images like
53816069ff26Swdenk	RAMDisks. This construct is useful for instance when you want
53826069ff26Swdenk	to boot over the network using BOOTP etc., where the boot
53836069ff26Swdenk	server provides just a single image file, but you want to get
53846069ff26Swdenk	for instance an OS kernel and a RAMDisk image.
53856069ff26Swdenk
53866069ff26Swdenk	"Multi-File Images" start with a list of image sizes, each
53876069ff26Swdenk	image size (in bytes) specified by an "uint32_t" in network
53886069ff26Swdenk	byte order. This list is terminated by an "(uint32_t)0".
53896069ff26Swdenk	Immediately after the terminating 0 follow the images, one by
53906069ff26Swdenk	one, all aligned on "uint32_t" boundaries (size rounded up to
53916069ff26Swdenk	a multiple of 4 bytes).
53926069ff26Swdenk
53936069ff26Swdenk   "Firmware Images" are binary images containing firmware (like
53946069ff26Swdenk	U-Boot or FPGA images) which usually will be programmed to
53956069ff26Swdenk	flash memory.
53966069ff26Swdenk
53976069ff26Swdenk   "Script files" are command sequences that will be executed by
53986069ff26Swdenk	U-Boot's command interpreter; this feature is especially
53996069ff26Swdenk	useful when you configure U-Boot to use a real shell (hush)
54006069ff26Swdenk	as command interpreter.
54016069ff26Swdenk
540244f074c7SMarek VasutBooting the Linux zImage:
540344f074c7SMarek Vasut-------------------------
540444f074c7SMarek Vasut
540544f074c7SMarek VasutOn some platforms, it's possible to boot Linux zImage. This is done
540644f074c7SMarek Vasutusing the "bootz" command. The syntax of "bootz" command is the same
540744f074c7SMarek Vasutas the syntax of "bootm" command.
540844f074c7SMarek Vasut
54098ac28563STom RiniNote, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
5410017e1f3fSMarek Vasutkernel with raw initrd images. The syntax is slightly different, the
5411017e1f3fSMarek Vasutaddress of the initrd must be augmented by it's size, in the following
5412017e1f3fSMarek Vasutformat: "<initrd addres>:<initrd size>".
5413017e1f3fSMarek Vasut
5414c609719bSwdenk
5415c609719bSwdenkStandalone HOWTO:
5416c609719bSwdenk=================
5417c609719bSwdenk
5418c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and
5419c609719bSwdenkrun "standalone" applications, which can use some resources of
5420c609719bSwdenkU-Boot like console I/O functions or interrupt services.
5421c609719bSwdenk
5422c609719bSwdenkTwo simple examples are included with the sources:
5423c609719bSwdenk
5424c609719bSwdenk"Hello World" Demo:
5425c609719bSwdenk-------------------
5426c609719bSwdenk
5427c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo
5428c609719bSwdenkapplication; it is automatically compiled when you build U-Boot.
5429c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it
5430c609719bSwdenklike that:
5431c609719bSwdenk
5432c609719bSwdenk	=> loads
5433c609719bSwdenk	## Ready for S-Record download ...
5434c609719bSwdenk	~>examples/hello_world.srec
5435c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
5436c609719bSwdenk	[file transfer complete]
5437c609719bSwdenk	[connected]
5438c609719bSwdenk	## Start Addr = 0x00040004
5439c609719bSwdenk
5440c609719bSwdenk	=> go 40004 Hello World! This is a test.
5441c609719bSwdenk	## Starting application at 0x00040004 ...
5442c609719bSwdenk	Hello World
5443c609719bSwdenk	argc = 7
5444c609719bSwdenk	argv[0] = "40004"
5445c609719bSwdenk	argv[1] = "Hello"
5446c609719bSwdenk	argv[2] = "World!"
5447c609719bSwdenk	argv[3] = "This"
5448c609719bSwdenk	argv[4] = "is"
5449c609719bSwdenk	argv[5] = "a"
5450c609719bSwdenk	argv[6] = "test."
5451c609719bSwdenk	argv[7] = "<NULL>"
5452c609719bSwdenk	Hit any key to exit ...
5453c609719bSwdenk
5454c609719bSwdenk	## Application terminated, rc = 0x0
5455c609719bSwdenk
5456c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt
5457c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'.
5458c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second.
5459c609719bSwdenkThe interrupt service routine is trivial, just printing a '.'
5460c609719bSwdenkcharacter, but this is just a demo program. The application can be
5461c609719bSwdenkcontrolled by the following keys:
5462c609719bSwdenk
5463c609719bSwdenk	? - print current values og the CPM Timer registers
5464c609719bSwdenk	b - enable interrupts and start timer
5465c609719bSwdenk	e - stop timer and disable interrupts
5466c609719bSwdenk	q - quit application
5467c609719bSwdenk
5468c609719bSwdenk	=> loads
5469c609719bSwdenk	## Ready for S-Record download ...
5470c609719bSwdenk	~>examples/timer.srec
5471c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
5472c609719bSwdenk	[file transfer complete]
5473c609719bSwdenk	[connected]
5474c609719bSwdenk	## Start Addr = 0x00040004
5475c609719bSwdenk
5476c609719bSwdenk	=> go 40004
5477c609719bSwdenk	## Starting application at 0x00040004 ...
5478c609719bSwdenk	TIMERS=0xfff00980
5479c609719bSwdenk	Using timer 1
5480c609719bSwdenk	  tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
5481c609719bSwdenk
5482c609719bSwdenkHit 'b':
5483c609719bSwdenk	[q, b, e, ?] Set interval 1000000 us
5484c609719bSwdenk	Enabling timer
5485c609719bSwdenkHit '?':
5486c609719bSwdenk	[q, b, e, ?] ........
5487c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
5488c609719bSwdenkHit '?':
5489c609719bSwdenk	[q, b, e, ?] .
5490c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
5491c609719bSwdenkHit '?':
5492c609719bSwdenk	[q, b, e, ?] .
5493c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
5494c609719bSwdenkHit '?':
5495c609719bSwdenk	[q, b, e, ?] .
5496c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
5497c609719bSwdenkHit 'e':
5498c609719bSwdenk	[q, b, e, ?] ...Stopping timer
5499c609719bSwdenkHit 'q':
5500c609719bSwdenk	[q, b, e, ?] ## Application terminated, rc = 0x0
5501c609719bSwdenk
5502c609719bSwdenk
550385ec0bccSwdenkMinicom warning:
550485ec0bccSwdenk================
550585ec0bccSwdenk
55067152b1d0SwdenkOver time, many people have reported problems when trying to use the
550785ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd)
550885ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under
5509f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and
551085ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and
5511e53515a2SKarl O. Pincuse "cu" for S-Record download ("loads" command).  See
5512e53515a2SKarl O. Pinchttp://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
5513e53515a2SKarl O. Pincfor help with kermit.
5514e53515a2SKarl O. Pinc
551585ec0bccSwdenk
551652f52c14SwdenkNevertheless, if you absolutely want to use it try adding this
551752f52c14Swdenkconfiguration to your "File transfer protocols" section:
551852f52c14Swdenk
551952f52c14Swdenk	   Name	   Program			Name U/D FullScr IO-Red. Multi
552052f52c14Swdenk	X  kermit  /usr/bin/kermit -i -l %l -s	 Y    U	   Y	   N	  N
552152f52c14Swdenk	Y  kermit  /usr/bin/kermit -i -l %l -r	 N    D	   Y	   N	  N
552252f52c14Swdenk
552352f52c14Swdenk
5524c609719bSwdenkNetBSD Notes:
5525c609719bSwdenk=============
5526c609719bSwdenk
5527c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host
5528c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx).
5529c609719bSwdenk
5530c609719bSwdenkBuilding requires a cross environment; it is known to work on
5531c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5532c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make).
5533c609719bSwdenkNote that the cross-powerpc package does not install include files;
5534c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is
5535c609719bSwdenkmissing.  This file has to be installed and patched manually:
5536c609719bSwdenk
5537c609719bSwdenk	# cd /usr/pkg/cross/powerpc-netbsd/include
5538c609719bSwdenk	# mkdir powerpc
5539c609719bSwdenk	# ln -s powerpc machine
5540c609719bSwdenk	# cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
5541c609719bSwdenk	# ${EDIT} powerpc/ansi.h	## must remove __va_list, _BSD_VA_LIST
5542c609719bSwdenk
5543c609719bSwdenkNative builds *don't* work due to incompatibilities between native
5544c609719bSwdenkand U-Boot include files.
5545c609719bSwdenk
5546c609719bSwdenkBooting assumes that (the first part of) the image booted is a
5547c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel
5548c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source
5549c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
55502a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
5551c609719bSwdenk
5552c609719bSwdenk
5553c609719bSwdenkImplementation Internals:
5554c609719bSwdenk=========================
5555c609719bSwdenk
5556c609719bSwdenkThe following is not intended to be a complete description of every
5557c609719bSwdenkimplementation detail. However, it should help to understand the
5558c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom
5559c609719bSwdenkhardware.
5560c609719bSwdenk
5561c609719bSwdenk
5562c609719bSwdenkInitial Stack, Global Data:
5563c609719bSwdenk---------------------------
5564c609719bSwdenk
5565c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot
5566c609719bSwdenkstarts running out of ROM (flash memory), usually without access to
5567c609719bSwdenksystem RAM (because the memory controller is not initialized yet).
5568c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS
5569c609719bSwdenkis not initialized as zero. To be able to get a C environment working
5570c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation
5571c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU
5572c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and
5573c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be
5574c609719bSwdenklocked as (mis-) used as memory, etc.
5575c609719bSwdenk
55767152b1d0Swdenk	Chris Hallinan posted a good summary of these issues to the
55770668236bSWolfgang Denk	U-Boot mailing list:
557843d9616cSwdenk
557943d9616cSwdenk	Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
558043d9616cSwdenk	From: "Chris Hallinan" <clh@net1plus.com>
558143d9616cSwdenk	Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
558243d9616cSwdenk	...
558343d9616cSwdenk
558443d9616cSwdenk	Correct me if I'm wrong, folks, but the way I understand it
558543d9616cSwdenk	is this: Using DCACHE as initial RAM for Stack, etc, does not
558643d9616cSwdenk	require any physical RAM backing up the cache. The cleverness
558743d9616cSwdenk	is that the cache is being used as a temporary supply of
558843d9616cSwdenk	necessary storage before the SDRAM controller is setup. It's
558911ccc33fSMarcel Ziswiler	beyond the scope of this list to explain the details, but you
559043d9616cSwdenk	can see how this works by studying the cache architecture and
559143d9616cSwdenk	operation in the architecture and processor-specific manuals.
559243d9616cSwdenk
559343d9616cSwdenk	OCM is On Chip Memory, which I believe the 405GP has 4K. It
559443d9616cSwdenk	is another option for the system designer to use as an
559511ccc33fSMarcel Ziswiler	initial stack/RAM area prior to SDRAM being available. Either
559643d9616cSwdenk	option should work for you. Using CS 4 should be fine if your
559743d9616cSwdenk	board designers haven't used it for something that would
559843d9616cSwdenk	cause you grief during the initial boot! It is frequently not
559943d9616cSwdenk	used.
560043d9616cSwdenk
56016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
560243d9616cSwdenk	with your processor/board/system design. The default value
560343d9616cSwdenk	you will find in any recent u-boot distribution in
56048a316c9bSStefan Roese	walnut.h should work for you. I'd set it to a value larger
560543d9616cSwdenk	than your SDRAM module. If you have a 64MB SDRAM module, set
560643d9616cSwdenk	it above 400_0000. Just make sure your board has no resources
560743d9616cSwdenk	that are supposed to respond to that address! That code in
560843d9616cSwdenk	start.S has been around a while and should work as is when
560943d9616cSwdenk	you get the config right.
561043d9616cSwdenk
561143d9616cSwdenk	-Chris Hallinan
561243d9616cSwdenk	DS4.COM, Inc.
561343d9616cSwdenk
5614c609719bSwdenkIt is essential to remember this, since it has some impact on the C
5615c609719bSwdenkcode for the initialization procedures:
5616c609719bSwdenk
5617c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt
5618c609719bSwdenk  to write it.
5619c609719bSwdenk
562011ccc33fSMarcel Ziswiler* Do not use any uninitialized global data (or implicitely initialized
5621c609719bSwdenk  as zero data - BSS segment) at all - this is undefined, initiali-
56227152b1d0Swdenk  zation is performed later (when relocating to RAM).
5623c609719bSwdenk
5624c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like
5625c609719bSwdenk  that.
5626c609719bSwdenk
5627c609719bSwdenkHaving only the stack as writable memory limits means we cannot use
5628c609719bSwdenknormal global data to share information beween the code. But it
5629c609719bSwdenkturned out that the implementation of U-Boot can be greatly
5630c609719bSwdenksimplified by making a global data structure (gd_t) available to all
5631c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_
5632c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of
5633c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we
5634c609719bSwdenkplace a pointer (gd) to the global data into a register which we
5635c609719bSwdenkreserve for this purpose.
5636c609719bSwdenk
56377152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the
5638c609719bSwdenkrelevant  (E)ABI  specifications for the current architecture, and by
5639c609719bSwdenkGCC's implementation.
5640c609719bSwdenk
5641c609719bSwdenkFor PowerPC, the following registers have specific use:
5642c609719bSwdenk	R1:	stack pointer
5643e7670f6cSWolfgang Denk	R2:	reserved for system use
5644c609719bSwdenk	R3-R4:	parameter passing and return values
5645c609719bSwdenk	R5-R10: parameter passing
5646c609719bSwdenk	R13:	small data area pointer
5647c609719bSwdenk	R30:	GOT pointer
5648c609719bSwdenk	R31:	frame pointer
5649c609719bSwdenk
5650e6bee808SJoakim Tjernlund	(U-Boot also uses R12 as internal GOT pointer. r12
5651e6bee808SJoakim Tjernlund	is a volatile register so r12 needs to be reset when
5652e6bee808SJoakim Tjernlund	going back and forth between asm and C)
5653c609719bSwdenk
5654e7670f6cSWolfgang Denk    ==> U-Boot will use R2 to hold a pointer to the global data
5655c609719bSwdenk
5656c609719bSwdenk    Note: on PPC, we could use a static initializer (since the
5657c609719bSwdenk    address of the global data structure is known at compile time),
5658c609719bSwdenk    but it turned out that reserving a register results in somewhat
5659c609719bSwdenk    smaller code - although the code savings are not that big (on
5660c609719bSwdenk    average for all boards 752 bytes for the whole U-Boot image,
5661c609719bSwdenk    624 text + 127 data).
5662c609719bSwdenk
5663c4db335cSRobin GetzOn Blackfin, the normal C ABI (except for P3) is followed as documented here:
56644c58eb55SMike Frysinger	http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
56654c58eb55SMike Frysinger
5666c4db335cSRobin Getz    ==> U-Boot will use P3 to hold a pointer to the global data
56674c58eb55SMike Frysinger
5668c609719bSwdenkOn ARM, the following registers are used:
5669c609719bSwdenk
5670c609719bSwdenk	R0:	function argument word/integer result
5671c609719bSwdenk	R1-R3:	function argument word
567212eba1b4SJeroen Hofstee	R9:	platform specific
567312eba1b4SJeroen Hofstee	R10:	stack limit (used only if stack checking is enabled)
5674c609719bSwdenk	R11:	argument (frame) pointer
5675c609719bSwdenk	R12:	temporary workspace
5676c609719bSwdenk	R13:	stack pointer
5677c609719bSwdenk	R14:	link register
5678c609719bSwdenk	R15:	program counter
5679c609719bSwdenk
568012eba1b4SJeroen Hofstee    ==> U-Boot will use R9 to hold a pointer to the global data
568112eba1b4SJeroen Hofstee
568212eba1b4SJeroen Hofstee    Note: on ARM, only R_ARM_RELATIVE relocations are supported.
5683c609719bSwdenk
56840df01fd3SThomas ChouOn Nios II, the ABI is documented here:
56850df01fd3SThomas Chou	http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
56860df01fd3SThomas Chou
56870df01fd3SThomas Chou    ==> U-Boot will use gp to hold a pointer to the global data
56880df01fd3SThomas Chou
56890df01fd3SThomas Chou    Note: on Nios II, we give "-G0" option to gcc and don't use gp
56900df01fd3SThomas Chou    to access small data sections, so gp is free.
56910df01fd3SThomas Chou
5692afc1ce82SMacpaul LinOn NDS32, the following registers are used:
5693afc1ce82SMacpaul Lin
5694afc1ce82SMacpaul Lin	R0-R1:	argument/return
5695afc1ce82SMacpaul Lin	R2-R5:	argument
5696afc1ce82SMacpaul Lin	R15:	temporary register for assembler
5697afc1ce82SMacpaul Lin	R16:	trampoline register
5698afc1ce82SMacpaul Lin	R28:	frame pointer (FP)
5699afc1ce82SMacpaul Lin	R29:	global pointer (GP)
5700afc1ce82SMacpaul Lin	R30:	link register (LP)
5701afc1ce82SMacpaul Lin	R31:	stack pointer (SP)
5702afc1ce82SMacpaul Lin	PC:	program counter (PC)
5703afc1ce82SMacpaul Lin
5704afc1ce82SMacpaul Lin    ==> U-Boot will use R10 to hold a pointer to the global data
5705afc1ce82SMacpaul Lin
5706d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5707d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much.
5708c609719bSwdenk
5709c609719bSwdenkMemory Management:
5710c609719bSwdenk------------------
5711c609719bSwdenk
5712c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the
5713c609719bSwdenkMMU is not used either for address mapping nor for memory protection.
5714c609719bSwdenk
5715c609719bSwdenkThe available memory is mapped to fixed addresses using the memory
5716c609719bSwdenkcontroller. In this process, a contiguous block is formed for each
5717c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several
5718c609719bSwdenkphysical memory banks.
5719c609719bSwdenk
5720c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on
5721c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5722c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself
5723c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some
57246d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
5725c609719bSwdenkconfiguration setting]. Below that, a structure with global Board
5726c609719bSwdenkInfo data is placed, followed by the stack (growing downward).
5727c609719bSwdenk
5728c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB
5729c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF).
5730c609719bSwdenk
5731c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like
5732c609719bSwdenkthis:
5733c609719bSwdenk
5734c609719bSwdenk	0x0000 0000	Exception Vector code
5735c609719bSwdenk	      :
5736c609719bSwdenk	0x0000 1FFF
5737c609719bSwdenk	0x0000 2000	Free for Application Use
5738c609719bSwdenk	      :
5739c609719bSwdenk	      :
5740c609719bSwdenk
5741c609719bSwdenk	      :
5742c609719bSwdenk	      :
5743c609719bSwdenk	0x00FB FF20	Monitor Stack (Growing downward)
5744c609719bSwdenk	0x00FB FFAC	Board Info Data and permanent copy of global data
5745c609719bSwdenk	0x00FC 0000	Malloc Arena
5746c609719bSwdenk	      :
5747c609719bSwdenk	0x00FD FFFF
5748c609719bSwdenk	0x00FE 0000	RAM Copy of Monitor Code
5749c609719bSwdenk	...		eventually: LCD or video framebuffer
5750c609719bSwdenk	...		eventually: pRAM (Protected RAM - unchanged by reset)
5751c609719bSwdenk	0x00FF FFFF	[End of RAM]
5752c609719bSwdenk
5753c609719bSwdenk
5754c609719bSwdenkSystem Initialization:
5755c609719bSwdenk----------------------
5756c609719bSwdenk
5757c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point
575811ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset
5759c609719bSwdenkconfiguration for CS0# this is a mirror of the onboard Flash memory.
57607152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address.
5761c609719bSwdenkTo be able to implement the initialization code in C, a (small!)
5762c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs
5763c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked
5764c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core,
5765c609719bSwdenkthe caches and the SIU.
5766c609719bSwdenk
5767c609719bSwdenkNext, all (potentially) available memory banks are mapped using a
5768c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries
5769c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5770c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5771c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a
5772c609719bSwdenksimple memory test is run that determines the size of the SDRAM
5773c609719bSwdenkbanks.
5774c609719bSwdenk
5775c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of
57767152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first
5777c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address
5778c609719bSwdenk0x00000000, with any additional banks following immediately to create
5779c609719bSwdenkcontiguous memory starting from 0.
5780c609719bSwdenk
5781c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area
5782c609719bSwdenkand allocates memory for use by malloc() and for the global Board
5783c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM
5784c609719bSwdenkpages, and the final stack is set up.
5785c609719bSwdenk
5786c609719bSwdenkOnly after this relocation will you have a "normal" C environment;
5787c609719bSwdenkuntil that you are restricted in several ways, mostly because you are
5788c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a
5789c609719bSwdenknew address in RAM.
5790c609719bSwdenk
5791c609719bSwdenk
5792c609719bSwdenkU-Boot Porting Guide:
5793c609719bSwdenk----------------------
5794c609719bSwdenk
5795c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
57966aff3115Swdenklist, October 2002]
5797c609719bSwdenk
5798c609719bSwdenk
5799c609719bSwdenkint main(int argc, char *argv[])
5800c609719bSwdenk{
5801c609719bSwdenk	sighandler_t no_more_time;
5802c609719bSwdenk
5803c609719bSwdenk	signal(SIGALRM, no_more_time);
5804c609719bSwdenk	alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
5805c609719bSwdenk
5806c609719bSwdenk	if (available_money > available_manpower) {
58076c3fef28SJerry Van Baren		Pay consultant to port U-Boot;
5808c609719bSwdenk		return 0;
5809c609719bSwdenk	}
5810c609719bSwdenk
5811c609719bSwdenk	Download latest U-Boot source;
5812c609719bSwdenk
58130668236bSWolfgang Denk	Subscribe to u-boot mailing list;
58146aff3115Swdenk
58156c3fef28SJerry Van Baren	if (clueless)
5816c609719bSwdenk		email("Hi, I am new to U-Boot, how do I get started?");
5817c609719bSwdenk
5818c609719bSwdenk	while (learning) {
5819c609719bSwdenk		Read the README file in the top level directory;
58207cb22f97Swdenk		Read http://www.denx.de/twiki/bin/view/DULG/Manual;
58216c3fef28SJerry Van Baren		Read applicable doc/*.README;
5822c609719bSwdenk		Read the source, Luke;
58236c3fef28SJerry Van Baren		/* find . -name "*.[chS]" | xargs grep -i <keyword> */
5824c609719bSwdenk	}
5825c609719bSwdenk
58266c3fef28SJerry Van Baren	if (available_money > toLocalCurrency ($2500))
58276c3fef28SJerry Van Baren		Buy a BDI3000;
58286c3fef28SJerry Van Baren	else
5829c609719bSwdenk		Add a lot of aggravation and time;
5830c609719bSwdenk
58316c3fef28SJerry Van Baren	if (a similar board exists) {	/* hopefully... */
58326c3fef28SJerry Van Baren		cp -a board/<similar> board/<myboard>
58336c3fef28SJerry Van Baren		cp include/configs/<similar>.h include/configs/<myboard>.h
58346c3fef28SJerry Van Baren	} else {
5835c609719bSwdenk		Create your own board support subdirectory;
58366c3fef28SJerry Van Baren		Create your own board include/configs/<myboard>.h file;
58376c3fef28SJerry Van Baren	}
58386c3fef28SJerry Van Baren	Edit new board/<myboard> files
58396c3fef28SJerry Van Baren	Edit new include/configs/<myboard>.h
5840c609719bSwdenk
58416c3fef28SJerry Van Baren	while (!accepted) {
5842c609719bSwdenk		while (!running) {
5843c609719bSwdenk			do {
5844c609719bSwdenk				Add / modify source code;
5845c609719bSwdenk			} until (compiles);
5846c609719bSwdenk			Debug;
5847c609719bSwdenk			if (clueless)
5848c609719bSwdenk				email("Hi, I am having problems...");
5849c609719bSwdenk		}
58506c3fef28SJerry Van Baren		Send patch file to the U-Boot email list;
58516c3fef28SJerry Van Baren		if (reasonable critiques)
58526c3fef28SJerry Van Baren			Incorporate improvements from email list code review;
58536c3fef28SJerry Van Baren		else
58546c3fef28SJerry Van Baren			Defend code as written;
58556c3fef28SJerry Van Baren	}
5856c609719bSwdenk
5857c609719bSwdenk	return 0;
5858c609719bSwdenk}
5859c609719bSwdenk
5860c609719bSwdenkvoid no_more_time (int sig)
5861c609719bSwdenk{
5862c609719bSwdenk      hire_a_guru();
5863c609719bSwdenk}
5864c609719bSwdenk
5865c609719bSwdenk
5866c609719bSwdenkCoding Standards:
5867c609719bSwdenk-----------------
5868c609719bSwdenk
5869c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel
58702c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script
58717ca9296eSWolfgang Denk"scripts/Lindent" in your Linux kernel source directory.
5872c609719bSwdenk
58732c051651SDetlev ZundelSource files originating from a different project (for example the
58742c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not
58752c051651SDetlev Zundelreformated to ease subsequent migration to newer versions of those
58762c051651SDetlev Zundelsources.
58772c051651SDetlev Zundel
58782c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in
58792c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//)
58802c051651SDetlev Zundelin your code.
5881c609719bSwdenk
5882c178d3daSwdenkPlease also stick to the following formatting rules:
5883180d3f74Swdenk- remove any trailing white space
58847ca9296eSWolfgang Denk- use TAB characters for indentation and vertical alignment, not spaces
5885180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds
58867ca9296eSWolfgang Denk- do not add more than 2 consecutive empty lines to source files
5887180d3f74Swdenk- do not add trailing empty lines to source files
5888180d3f74Swdenk
5889c609719bSwdenkSubmissions which do not conform to the standards may be returned
5890c609719bSwdenkwith a request to reformat the changes.
5891c609719bSwdenk
5892c609719bSwdenk
5893c609719bSwdenkSubmitting Patches:
5894c609719bSwdenk-------------------
5895c609719bSwdenk
5896c609719bSwdenkSince the number of patches for U-Boot is growing, we need to
5897c609719bSwdenkestablish some rules. Submissions which do not conform to these rules
5898c609719bSwdenkmay be rejected, even when they contain important and valuable stuff.
5899c609719bSwdenk
59000d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details.
5901218ca724SWolfgang Denk
59020668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
59030668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot
59040668236bSWolfgang Denk
5905c609719bSwdenkWhen you send a patch, please include the following information with
5906c609719bSwdenkit:
5907c609719bSwdenk
5908c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes
5909c609719bSwdenk  this bug. Please try to include a way of demonstrating that the
5910c609719bSwdenk  patch actually fixes something.
5911c609719bSwdenk
5912c609719bSwdenk* For new features: a description of the feature and your
5913c609719bSwdenk  implementation.
5914c609719bSwdenk
5915c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch)
5916c609719bSwdenk
5917c609719bSwdenk* For major contributions, your entry to the CREDITS file
5918c609719bSwdenk
591927af930eSAlbert ARIBAUD* When you add support for a new board, don't forget to add a
592027af930eSAlbert ARIBAUD  maintainer e-mail address to the boards.cfg file, too.
5921c609719bSwdenk
5922c609719bSwdenk* If your patch adds new configuration options, don't forget to
5923c609719bSwdenk  document these in the README file.
5924c609719bSwdenk
5925218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly*
5926218ca724SWolfgang Denk  recommended) you can easily generate the patch using the
59277ca9296eSWolfgang Denk  "git format-patch". If you then use "git send-email" to send it to
5928218ca724SWolfgang Denk  the U-Boot mailing list, you will avoid most of the common problems
5929218ca724SWolfgang Denk  with some other mail clients.
5930c609719bSwdenk
5931218ca724SWolfgang Denk  If you cannot use git, use "diff -purN OLD NEW". If your version of
5932218ca724SWolfgang Denk  diff does not support these options, then get the latest version of
5933218ca724SWolfgang Denk  GNU diff.
59346dff5529Swdenk
5935218ca724SWolfgang Denk  The current directory when running this command shall be the parent
5936218ca724SWolfgang Denk  directory of the U-Boot source tree (i. e. please make sure that
5937218ca724SWolfgang Denk  your patch includes sufficient directory information for the
5938218ca724SWolfgang Denk  affected files).
5939218ca724SWolfgang Denk
5940218ca724SWolfgang Denk  We prefer patches as plain text. MIME attachments are discouraged,
5941218ca724SWolfgang Denk  and compressed attachments must not be used.
5942c609719bSwdenk
594352f52c14Swdenk* If one logical set of modifications affects or creates several
594452f52c14Swdenk  files, all these changes shall be submitted in a SINGLE patch file.
594552f52c14Swdenk
594652f52c14Swdenk* Changesets that contain different, unrelated modifications shall be
594752f52c14Swdenk  submitted as SEPARATE patches, one patch per changeset.
594852f52c14Swdenk
594952f52c14Swdenk
5950c609719bSwdenkNotes:
5951c609719bSwdenk
5952c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched
5953c609719bSwdenk  source tree and make sure that no errors or warnings are reported
5954c609719bSwdenk  for any of the boards.
5955c609719bSwdenk
5956c609719bSwdenk* Keep your modifications to the necessary minimum: A patch
5957c609719bSwdenk  containing several unrelated changes or arbitrary reformats will be
5958c609719bSwdenk  returned with a request to re-formatting / split it.
5959c609719bSwdenk
5960c609719bSwdenk* If you modify existing code, make sure that your new code does not
5961c609719bSwdenk  add to the memory footprint of the code ;-) Small is beautiful!
5962c609719bSwdenk  When adding new features, these should compile conditionally only
5963c609719bSwdenk  (using #ifdef), and the resulting code with the new feature
5964c609719bSwdenk  disabled must not need more memory than the old code without your
5965c609719bSwdenk  modification.
596690dc6704Swdenk
59670668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the
59680668236bSWolfgang Denk  u-boot mailing list. Bigger patches will be moderated. If they are
59690668236bSWolfgang Denk  reasonable and not too big, they will be acknowledged. But patches
59700668236bSWolfgang Denk  bigger than the size limit should be avoided.
5971