xref: /openbmc/u-boot/README (revision b3ba6e94)
1c609719bSwdenk#
2b75190deSWolfgang Denk# (C) Copyright 2000 - 2012
3c609719bSwdenk# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4c609719bSwdenk#
5c609719bSwdenk# See file CREDITS for list of people who contributed to this
6c609719bSwdenk# project.
7c609719bSwdenk#
8c609719bSwdenk# This program is free software; you can redistribute it and/or
9c609719bSwdenk# modify it under the terms of the GNU General Public License as
10c609719bSwdenk# published by the Free Software Foundation; either version 2 of
11c609719bSwdenk# the License, or (at your option) any later version.
12c609719bSwdenk#
13c609719bSwdenk# This program is distributed in the hope that it will be useful,
14c609719bSwdenk# but WITHOUT ANY WARRANTY; without even the implied warranty of
15c609719bSwdenk# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	See the
16c609719bSwdenk# GNU General Public License for more details.
17c609719bSwdenk#
18c609719bSwdenk# You should have received a copy of the GNU General Public License
19c609719bSwdenk# along with this program; if not, write to the Free Software
20c609719bSwdenk# Foundation, Inc., 59 Temple Place, Suite 330, Boston,
21c609719bSwdenk# MA 02111-1307 USA
22c609719bSwdenk#
23c609719bSwdenk
24c609719bSwdenkSummary:
25c609719bSwdenk========
26c609719bSwdenk
2724ee89b9SwdenkThis directory contains the source code for U-Boot, a boot loader for
28e86e5a07SwdenkEmbedded boards based on PowerPC, ARM, MIPS and several other
29e86e5a07Swdenkprocessors, which can be installed in a boot ROM and used to
30e86e5a07Swdenkinitialize and test the hardware or to download and run application
31e86e5a07Swdenkcode.
32c609719bSwdenk
33c609719bSwdenkThe development of U-Boot is closely related to Linux: some parts of
3424ee89b9Swdenkthe source code originate in the Linux source tree, we have some
3524ee89b9Swdenkheader files in common, and special provision has been made to
36c609719bSwdenksupport booting of Linux images.
37c609719bSwdenk
38c609719bSwdenkSome attention has been paid to make this software easily
39c609719bSwdenkconfigurable and extendable. For instance, all monitor commands are
40c609719bSwdenkimplemented with the same call interface, so that it's very easy to
41c609719bSwdenkadd new commands. Also, instead of permanently adding rarely used
42c609719bSwdenkcode (for instance hardware test utilities) to the monitor, you can
43c609719bSwdenkload and run it dynamically.
44c609719bSwdenk
45c609719bSwdenk
46c609719bSwdenkStatus:
47c609719bSwdenk=======
48c609719bSwdenk
49c609719bSwdenkIn general, all boards for which a configuration option exists in the
50c609719bSwdenkMakefile have been tested to some extent and can be considered
51c609719bSwdenk"working". In fact, many of them are used in production systems.
52c609719bSwdenk
53c609719bSwdenkIn case of problems see the CHANGELOG and CREDITS files to find out
54218ca724SWolfgang Denkwho contributed the specific port. The MAINTAINERS file lists board
55218ca724SWolfgang Denkmaintainers.
56c609719bSwdenk
57adb9d851SRobert P. J. DayNote: There is no CHANGELOG file in the actual U-Boot source tree;
58adb9d851SRobert P. J. Dayit can be created dynamically from the Git log using:
59adb9d851SRobert P. J. Day
60adb9d851SRobert P. J. Day	make CHANGELOG
61adb9d851SRobert P. J. Day
62c609719bSwdenk
63c609719bSwdenkWhere to get help:
64c609719bSwdenk==================
65c609719bSwdenk
66c609719bSwdenkIn case you have questions about, problems with or contributions for
67c609719bSwdenkU-Boot you should send a message to the U-Boot mailing list at
680c32565fSPeter Tyser<u-boot@lists.denx.de>. There is also an archive of previous traffic
690c32565fSPeter Tyseron the mailing list - please search the archive before asking FAQ's.
700c32565fSPeter TyserPlease see http://lists.denx.de/pipermail/u-boot and
710c32565fSPeter Tyserhttp://dir.gmane.org/gmane.comp.boot-loaders.u-boot
72c609719bSwdenk
73c609719bSwdenk
74218ca724SWolfgang DenkWhere to get source code:
75218ca724SWolfgang Denk=========================
76218ca724SWolfgang Denk
77218ca724SWolfgang DenkThe U-Boot source code is maintained in the git repository at
78218ca724SWolfgang Denkgit://www.denx.de/git/u-boot.git ; you can browse it online at
79218ca724SWolfgang Denkhttp://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
80218ca724SWolfgang Denk
81218ca724SWolfgang DenkThe "snapshot" links on this page allow you to download tarballs of
8211ccc33fSMarcel Ziswilerany version you might be interested in. Official releases are also
83218ca724SWolfgang Denkavailable for FTP download from the ftp://ftp.denx.de/pub/u-boot/
84218ca724SWolfgang Denkdirectory.
85218ca724SWolfgang Denk
86d4ee711dSAnatolij GustschinPre-built (and tested) images are available from
87218ca724SWolfgang Denkftp://ftp.denx.de/pub/u-boot/images/
88218ca724SWolfgang Denk
89218ca724SWolfgang Denk
90c609719bSwdenkWhere we come from:
91c609719bSwdenk===================
92c609719bSwdenk
93c609719bSwdenk- start from 8xxrom sources
9424ee89b9Swdenk- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
95c609719bSwdenk- clean up code
96c609719bSwdenk- make it easier to add custom boards
97c609719bSwdenk- make it possible to add other [PowerPC] CPUs
98c609719bSwdenk- extend functions, especially:
99c609719bSwdenk  * Provide extended interface to Linux boot loader
100c609719bSwdenk  * S-Record download
101c609719bSwdenk  * network boot
10211ccc33fSMarcel Ziswiler  * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
10324ee89b9Swdenk- create ARMBoot project (http://sourceforge.net/projects/armboot)
104c609719bSwdenk- add other CPU families (starting with ARM)
10524ee89b9Swdenk- create U-Boot project (http://sourceforge.net/projects/u-boot)
1060d28f34bSMagnus Lilja- current project page: see http://www.denx.de/wiki/U-Boot
10724ee89b9Swdenk
10824ee89b9Swdenk
10924ee89b9SwdenkNames and Spelling:
11024ee89b9Swdenk===================
11124ee89b9Swdenk
11224ee89b9SwdenkThe "official" name of this project is "Das U-Boot". The spelling
11324ee89b9Swdenk"U-Boot" shall be used in all written text (documentation, comments
11424ee89b9Swdenkin source files etc.). Example:
11524ee89b9Swdenk
11624ee89b9Swdenk	This is the README file for the U-Boot project.
11724ee89b9Swdenk
11824ee89b9SwdenkFile names etc. shall be based on the string "u-boot". Examples:
11924ee89b9Swdenk
12024ee89b9Swdenk	include/asm-ppc/u-boot.h
12124ee89b9Swdenk
12224ee89b9Swdenk	#include <asm/u-boot.h>
12324ee89b9Swdenk
12424ee89b9SwdenkVariable names, preprocessor constants etc. shall be either based on
12524ee89b9Swdenkthe string "u_boot" or on "U_BOOT". Example:
12624ee89b9Swdenk
12724ee89b9Swdenk	U_BOOT_VERSION		u_boot_logo
12824ee89b9Swdenk	IH_OS_U_BOOT		u_boot_hush_start
129c609719bSwdenk
130c609719bSwdenk
13193f19cc0SwdenkVersioning:
13293f19cc0Swdenk===========
13393f19cc0Swdenk
134360d883aSThomas WeberStarting with the release in October 2008, the names of the releases
135360d883aSThomas Weberwere changed from numerical release numbers without deeper meaning
136360d883aSThomas Weberinto a time stamp based numbering. Regular releases are identified by
137360d883aSThomas Webernames consisting of the calendar year and month of the release date.
138360d883aSThomas WeberAdditional fields (if present) indicate release candidates or bug fix
139360d883aSThomas Weberreleases in "stable" maintenance trees.
14093f19cc0Swdenk
141360d883aSThomas WeberExamples:
142360d883aSThomas Weber	U-Boot v2009.11	    - Release November 2009
143360d883aSThomas Weber	U-Boot v2009.11.1   - Release 1 in version November 2009 stable tree
144360d883aSThomas Weber	U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release
14593f19cc0Swdenk
14693f19cc0Swdenk
147c609719bSwdenkDirectory Hierarchy:
148c609719bSwdenk====================
149c609719bSwdenk
1508d321b81SPeter Tyser/arch			Architecture specific files
1518d321b81SPeter Tyser  /arm			Files generic to ARM architecture
1528d321b81SPeter Tyser    /cpu		CPU specific files
1538d321b81SPeter Tyser      /arm720t		Files specific to ARM 720 CPUs
1548d321b81SPeter Tyser      /arm920t		Files specific to ARM 920 CPUs
1556eb0921aSAndreas Bießmann	/at91		Files specific to Atmel AT91RM9200 CPU
1568d321b81SPeter Tyser	/imx		Files specific to Freescale MC9328 i.MX CPUs
1578d321b81SPeter Tyser	/s3c24x0	Files specific to Samsung S3C24X0 CPUs
1588d321b81SPeter Tyser      /arm925t		Files specific to ARM 925 CPUs
1598d321b81SPeter Tyser      /arm926ejs	Files specific to ARM 926 CPUs
1608d321b81SPeter Tyser      /arm1136		Files specific to ARM 1136 CPUs
1618d321b81SPeter Tyser      /ixp		Files specific to Intel XScale IXP CPUs
1628d321b81SPeter Tyser      /pxa		Files specific to Intel XScale PXA CPUs
1638d321b81SPeter Tyser      /s3c44b0		Files specific to Samsung S3C44B0 CPUs
1648d321b81SPeter Tyser      /sa1100		Files specific to Intel StrongARM SA1100 CPUs
1658d321b81SPeter Tyser    /lib		Architecture specific library files
1668d321b81SPeter Tyser  /avr32		Files generic to AVR32 architecture
1678d321b81SPeter Tyser    /cpu		CPU specific files
1688d321b81SPeter Tyser    /lib		Architecture specific library files
1698d321b81SPeter Tyser  /blackfin		Files generic to Analog Devices Blackfin architecture
1708d321b81SPeter Tyser    /cpu		CPU specific files
1718d321b81SPeter Tyser    /lib		Architecture specific library files
172fea25720SGraeme Russ  /x86			Files generic to x86 architecture
1738d321b81SPeter Tyser    /cpu		CPU specific files
1748d321b81SPeter Tyser    /lib		Architecture specific library files
1758d321b81SPeter Tyser  /m68k			Files generic to m68k architecture
1768d321b81SPeter Tyser    /cpu		CPU specific files
1778d321b81SPeter Tyser      /mcf52x2		Files specific to Freescale ColdFire MCF52x2 CPUs
1788d321b81SPeter Tyser      /mcf5227x		Files specific to Freescale ColdFire MCF5227x CPUs
1798d321b81SPeter Tyser      /mcf532x		Files specific to Freescale ColdFire MCF5329 CPUs
1808d321b81SPeter Tyser      /mcf5445x		Files specific to Freescale ColdFire MCF5445x CPUs
1818d321b81SPeter Tyser      /mcf547x_8x	Files specific to Freescale ColdFire MCF547x_8x CPUs
1828d321b81SPeter Tyser    /lib		Architecture specific library files
1838d321b81SPeter Tyser  /microblaze		Files generic to microblaze architecture
1848d321b81SPeter Tyser    /cpu		CPU specific files
1858d321b81SPeter Tyser    /lib		Architecture specific library files
1868d321b81SPeter Tyser  /mips			Files generic to MIPS architecture
1878d321b81SPeter Tyser    /cpu		CPU specific files
18892bbd64eSDaniel Schwierzeck      /mips32		Files specific to MIPS32 CPUs
18980421fccSXiangfu Liu      /xburst		Files specific to Ingenic XBurst CPUs
1908d321b81SPeter Tyser    /lib		Architecture specific library files
191afc1ce82SMacpaul Lin  /nds32		Files generic to NDS32 architecture
192afc1ce82SMacpaul Lin    /cpu		CPU specific files
193afc1ce82SMacpaul Lin      /n1213		Files specific to Andes Technology N1213 CPUs
194afc1ce82SMacpaul Lin    /lib		Architecture specific library files
1958d321b81SPeter Tyser  /nios2		Files generic to Altera NIOS2 architecture
1968d321b81SPeter Tyser    /cpu		CPU specific files
1978d321b81SPeter Tyser    /lib		Architecture specific library files
198a47a12beSStefan Roese  /powerpc		Files generic to PowerPC architecture
1998d321b81SPeter Tyser    /cpu		CPU specific files
2008d321b81SPeter Tyser      /74xx_7xx		Files specific to Freescale MPC74xx and 7xx CPUs
2018d321b81SPeter Tyser      /mpc5xx		Files specific to Freescale MPC5xx CPUs
2028d321b81SPeter Tyser      /mpc5xxx		Files specific to Freescale MPC5xxx CPUs
2038d321b81SPeter Tyser      /mpc8xx		Files specific to Freescale MPC8xx CPUs
2048d321b81SPeter Tyser      /mpc8220		Files specific to Freescale MPC8220 CPUs
2058d321b81SPeter Tyser      /mpc824x		Files specific to Freescale MPC824x CPUs
2068d321b81SPeter Tyser      /mpc8260		Files specific to Freescale MPC8260 CPUs
2078d321b81SPeter Tyser      /mpc85xx		Files specific to Freescale MPC85xx CPUs
2088d321b81SPeter Tyser      /ppc4xx		Files specific to AMCC PowerPC 4xx CPUs
2098d321b81SPeter Tyser    /lib		Architecture specific library files
2108d321b81SPeter Tyser  /sh			Files generic to SH architecture
2118d321b81SPeter Tyser    /cpu		CPU specific files
2128d321b81SPeter Tyser      /sh2		Files specific to sh2 CPUs
2138d321b81SPeter Tyser      /sh3		Files specific to sh3 CPUs
2148d321b81SPeter Tyser      /sh4		Files specific to sh4 CPUs
2158d321b81SPeter Tyser    /lib		Architecture specific library files
2168d321b81SPeter Tyser  /sparc		Files generic to SPARC architecture
2178d321b81SPeter Tyser    /cpu		CPU specific files
2188d321b81SPeter Tyser      /leon2		Files specific to Gaisler LEON2 SPARC CPU
2198d321b81SPeter Tyser      /leon3		Files specific to Gaisler LEON3 SPARC CPU
2208d321b81SPeter Tyser    /lib		Architecture specific library files
2218d321b81SPeter Tyser/api			Machine/arch independent API for external apps
2228d321b81SPeter Tyser/board			Board dependent files
2238d321b81SPeter Tyser/common			Misc architecture independent functions
2248d321b81SPeter Tyser/disk			Code for disk drive partition handling
2258d321b81SPeter Tyser/doc			Documentation (don't expect too much)
2268d321b81SPeter Tyser/drivers		Commonly used device drivers
2278d321b81SPeter Tyser/examples		Example code for standalone applications, etc.
2288d321b81SPeter Tyser/fs			Filesystem code (cramfs, ext2, jffs2, etc.)
2298d321b81SPeter Tyser/include		Header Files
2308d321b81SPeter Tyser/lib			Files generic to all architectures
2318d321b81SPeter Tyser  /libfdt		Library files to support flattened device trees
2328d321b81SPeter Tyser  /lzma			Library files to support LZMA decompression
2338d321b81SPeter Tyser  /lzo			Library files to support LZO decompression
2348d321b81SPeter Tyser/net			Networking code
2358d321b81SPeter Tyser/post			Power On Self Test
2368d321b81SPeter Tyser/rtc			Real Time Clock drivers
2378d321b81SPeter Tyser/tools			Tools to build S-Record or U-Boot images, etc.
238c609719bSwdenk
239c609719bSwdenkSoftware Configuration:
240c609719bSwdenk=======================
241c609719bSwdenk
242c609719bSwdenkConfiguration is usually done using C preprocessor defines; the
243c609719bSwdenkrationale behind that is to avoid dead code whenever possible.
244c609719bSwdenk
245c609719bSwdenkThere are two classes of configuration variables:
246c609719bSwdenk
247c609719bSwdenk* Configuration _OPTIONS_:
248c609719bSwdenk  These are selectable by the user and have names beginning with
249c609719bSwdenk  "CONFIG_".
250c609719bSwdenk
251c609719bSwdenk* Configuration _SETTINGS_:
252c609719bSwdenk  These depend on the hardware etc. and should not be meddled with if
253c609719bSwdenk  you don't know what you're doing; they have names beginning with
2546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  "CONFIG_SYS_".
255c609719bSwdenk
256c609719bSwdenkLater we will add a configuration tool - probably similar to or even
257c609719bSwdenkidentical to what's used for the Linux kernel. Right now, we have to
258c609719bSwdenkdo the configuration by hand, which means creating some symbolic
259c609719bSwdenklinks and editing some configuration files. We use the TQM8xxL boards
260c609719bSwdenkas an example here.
261c609719bSwdenk
262c609719bSwdenk
263c609719bSwdenkSelection of Processor Architecture and Board Type:
264c609719bSwdenk---------------------------------------------------
265c609719bSwdenk
266c609719bSwdenkFor all supported boards there are ready-to-use default
267c609719bSwdenkconfigurations available; just type "make <board_name>_config".
268c609719bSwdenk
269c609719bSwdenkExample: For a TQM823L module type:
270c609719bSwdenk
271c609719bSwdenk	cd u-boot
272c609719bSwdenk	make TQM823L_config
273c609719bSwdenk
27411ccc33fSMarcel ZiswilerFor the Cogent platform, you need to specify the CPU type as well;
275c609719bSwdenke.g. "make cogent_mpc8xx_config". And also configure the cogent
276c609719bSwdenkdirectory according to the instructions in cogent/README.
277c609719bSwdenk
278c609719bSwdenk
279c609719bSwdenkConfiguration Options:
280c609719bSwdenk----------------------
281c609719bSwdenk
282c609719bSwdenkConfiguration depends on the combination of board and CPU type; all
283c609719bSwdenksuch information is kept in a configuration file
284c609719bSwdenk"include/configs/<board_name>.h".
285c609719bSwdenk
286c609719bSwdenkExample: For a TQM823L module, all configuration settings are in
287c609719bSwdenk"include/configs/TQM823L.h".
288c609719bSwdenk
289c609719bSwdenk
2907f6c2cbcSwdenkMany of the options are named exactly as the corresponding Linux
2917f6c2cbcSwdenkkernel configuration options. The intention is to make it easier to
2927f6c2cbcSwdenkbuild a config tool - later.
2937f6c2cbcSwdenk
2947f6c2cbcSwdenk
295c609719bSwdenkThe following options need to be configured:
296c609719bSwdenk
2972628114eSKim Phillips- CPU Type:	Define exactly one, e.g. CONFIG_MPC85XX.
298c609719bSwdenk
2992628114eSKim Phillips- Board Type:	Define exactly one, e.g. CONFIG_MPC8540ADS.
3006ccec449SWolfgang Denk
3016ccec449SWolfgang Denk- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
30209ea0de0SHaavard Skinnemoen		Define exactly one, e.g. CONFIG_ATSTK1002
303c609719bSwdenk
304c609719bSwdenk- CPU Module Type: (if CONFIG_COGENT is defined)
305c609719bSwdenk		Define exactly one of
306c609719bSwdenk		CONFIG_CMA286_60_OLD
307c609719bSwdenk--- FIXME --- not tested yet:
308c609719bSwdenk		CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
309c609719bSwdenk		CONFIG_CMA287_23, CONFIG_CMA287_50
310c609719bSwdenk
311c609719bSwdenk- Motherboard Type: (if CONFIG_COGENT is defined)
312c609719bSwdenk		Define exactly one of
313c609719bSwdenk		CONFIG_CMA101, CONFIG_CMA102
314c609719bSwdenk
315c609719bSwdenk- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
316c609719bSwdenk		Define one or more of
317c609719bSwdenk		CONFIG_CMA302
318c609719bSwdenk
319c609719bSwdenk- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
320c609719bSwdenk		Define one or more of
321c609719bSwdenk		CONFIG_LCD_HEARTBEAT	- update a character position on
32211ccc33fSMarcel Ziswiler					  the LCD display every second with
323c609719bSwdenk					  a "rotator" |\-/|\-/
324c609719bSwdenk
3252535d602Swdenk- Board flavour: (if CONFIG_MPC8260ADS is defined)
3262535d602Swdenk		CONFIG_ADSTYPE
3272535d602Swdenk		Possible values are:
3286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8260ADS	- original MPC8260ADS
3296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8266ADS	- MPC8266ADS
3306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_PQ2FADS	- PQ2FADS-ZU or PQ2FADS-VR
3316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8272ADS	- MPC8272ADS
3322535d602Swdenk
333cf946c6dSLei Wen- Marvell Family Member
334cf946c6dSLei Wen		CONFIG_SYS_MVFS		- define it if you want to enable
335cf946c6dSLei Wen					  multiple fs option at one time
336cf946c6dSLei Wen					  for marvell soc family
337cf946c6dSLei Wen
338c609719bSwdenk- MPC824X Family Member (if CONFIG_MPC824X is defined)
339c609719bSwdenk		Define exactly one of
340c609719bSwdenk		CONFIG_MPC8240, CONFIG_MPC8245
341c609719bSwdenk
34211ccc33fSMarcel Ziswiler- 8xx CPU Options: (if using an MPC8xx CPU)
34366ca92a5Swdenk		CONFIG_8xx_GCLK_FREQ	- deprecated: CPU clock if
34466ca92a5Swdenk					  get_gclk_freq() cannot work
3455da627a4Swdenk					  e.g. if there is no 32KHz
3465da627a4Swdenk					  reference PIT/RTC clock
34766ca92a5Swdenk		CONFIG_8xx_OSCLK	- PLL input clock (either EXTCLK
34866ca92a5Swdenk					  or XTAL/EXTAL)
349c609719bSwdenk
35066ca92a5Swdenk- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
3516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MIN
3526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MAX
35366ca92a5Swdenk		CONFIG_8xx_CPUCLK_DEFAULT
35475d1ea7fSwdenk			See doc/README.MPC866
35575d1ea7fSwdenk
3566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MEASURE_CPUCLK
35775d1ea7fSwdenk
35875d1ea7fSwdenk		Define this to measure the actual CPU clock instead
35975d1ea7fSwdenk		of relying on the correctness of the configured
36075d1ea7fSwdenk		values. Mostly useful for board bringup to make sure
36175d1ea7fSwdenk		the PLL is locked at the intended frequency. Note
36275d1ea7fSwdenk		that this requires a (stable) reference clock (32 kHz
3636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		RTC clock or CONFIG_SYS_8XX_XIN)
36475d1ea7fSwdenk
365506f3918SHeiko Schocher		CONFIG_SYS_DELAYED_ICACHE
366506f3918SHeiko Schocher
367506f3918SHeiko Schocher		Define this option if you want to enable the
368506f3918SHeiko Schocher		ICache only when Code runs from RAM.
369506f3918SHeiko Schocher
37066412c63SKumar Gala- 85xx CPU Options:
371ffd06e02SYork Sun		CONFIG_SYS_PPC64
372ffd06e02SYork Sun
373ffd06e02SYork Sun		Specifies that the core is a 64-bit PowerPC implementation (implements
374ffd06e02SYork Sun		the "64" category of the Power ISA). This is necessary for ePAPR
375ffd06e02SYork Sun		compliance, among other possible reasons.
376ffd06e02SYork Sun
37766412c63SKumar Gala		CONFIG_SYS_FSL_TBCLK_DIV
37866412c63SKumar Gala
37966412c63SKumar Gala		Defines the core time base clock divider ratio compared to the
38066412c63SKumar Gala		system clock.  On most PQ3 devices this is 8, on newer QorIQ
38166412c63SKumar Gala		devices it can be 16 or 32.  The ratio varies from SoC to Soc.
38266412c63SKumar Gala
3838f29084aSKumar Gala		CONFIG_SYS_FSL_PCIE_COMPAT
3848f29084aSKumar Gala
3858f29084aSKumar Gala		Defines the string to utilize when trying to match PCIe device
3868f29084aSKumar Gala		tree nodes for the given platform.
3878f29084aSKumar Gala
388afa6b551SPrabhakar Kushwaha		CONFIG_SYS_PPC_E500_DEBUG_TLB
389afa6b551SPrabhakar Kushwaha
390afa6b551SPrabhakar Kushwaha		Enables a temporary TLB entry to be used during boot to work
391afa6b551SPrabhakar Kushwaha		around limitations in e500v1 and e500v2 external debugger
392afa6b551SPrabhakar Kushwaha		support. This reduces the portions of the boot code where
393afa6b551SPrabhakar Kushwaha		breakpoints and single stepping do not work.  The value of this
394afa6b551SPrabhakar Kushwaha		symbol should be set to the TLB1 entry to be used for this
395afa6b551SPrabhakar Kushwaha		purpose.
396afa6b551SPrabhakar Kushwaha
39733eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510
39833eee330SScott Wood
39933eee330SScott Wood		Enables a workaround for erratum A004510.  If set,
40033eee330SScott Wood		then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
40133eee330SScott Wood		CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
40233eee330SScott Wood
40333eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
40433eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
40533eee330SScott Wood
40633eee330SScott Wood		Defines one or two SoC revisions (low 8 bits of SVR)
40733eee330SScott Wood		for which the A004510 workaround should be applied.
40833eee330SScott Wood
40933eee330SScott Wood		The rest of SVR is either not relevant to the decision
41033eee330SScott Wood		of whether the erratum is present (e.g. p2040 versus
41133eee330SScott Wood		p2041) or is implied by the build target, which controls
41233eee330SScott Wood		whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
41333eee330SScott Wood
41433eee330SScott Wood		See Freescale App Note 4493 for more information about
41533eee330SScott Wood		this erratum.
41633eee330SScott Wood
41733eee330SScott Wood		CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
41833eee330SScott Wood
41933eee330SScott Wood		This is the value to write into CCSR offset 0x18600
42033eee330SScott Wood		according to the A004510 workaround.
42133eee330SScott Wood
4226cb461b4SDaniel Schwierzeck- Generic CPU options:
4236cb461b4SDaniel Schwierzeck		CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
4246cb461b4SDaniel Schwierzeck
4256cb461b4SDaniel Schwierzeck		Defines the endianess of the CPU. Implementation of those
4266cb461b4SDaniel Schwierzeck		values is arch specific.
4276cb461b4SDaniel Schwierzeck
4280b953ffcSMarkus Klotzbuecher- Intel Monahans options:
4296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
4300b953ffcSMarkus Klotzbuecher
4310b953ffcSMarkus Klotzbuecher		Defines the Monahans run mode to oscillator
4320b953ffcSMarkus Klotzbuecher		ratio. Valid values are 8, 16, 24, 31. The core
4330b953ffcSMarkus Klotzbuecher		frequency is this value multiplied by 13 MHz.
4340b953ffcSMarkus Klotzbuecher
4356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
4360b953ffcSMarkus Klotzbuecher
4370b953ffcSMarkus Klotzbuecher		Defines the Monahans turbo mode to oscillator
4380b953ffcSMarkus Klotzbuecher		ratio. Valid values are 1 (default if undefined) and
4390b953ffcSMarkus Klotzbuecher		2. The core frequency as calculated above is multiplied
4400b953ffcSMarkus Klotzbuecher		by this value.
4410b953ffcSMarkus Klotzbuecher
44292bbd64eSDaniel Schwierzeck- MIPS CPU options:
44392bbd64eSDaniel Schwierzeck		CONFIG_SYS_INIT_SP_OFFSET
44492bbd64eSDaniel Schwierzeck
44592bbd64eSDaniel Schwierzeck		Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
44692bbd64eSDaniel Schwierzeck		pointer. This is needed for the temporary stack before
44792bbd64eSDaniel Schwierzeck		relocation.
44892bbd64eSDaniel Schwierzeck
44992bbd64eSDaniel Schwierzeck		CONFIG_SYS_MIPS_CACHE_MODE
45092bbd64eSDaniel Schwierzeck
45192bbd64eSDaniel Schwierzeck		Cache operation mode for the MIPS CPU.
45292bbd64eSDaniel Schwierzeck		See also arch/mips/include/asm/mipsregs.h.
45392bbd64eSDaniel Schwierzeck		Possible values are:
45492bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_NO_WA
45592bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_WA
45692bbd64eSDaniel Schwierzeck			CONF_CM_UNCACHED
45792bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_NONCOHERENT
45892bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_CE
45992bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_COW
46092bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_CUW
46192bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_ACCELERATED
46292bbd64eSDaniel Schwierzeck
46392bbd64eSDaniel Schwierzeck		CONFIG_SYS_XWAY_EBU_BOOTCFG
46492bbd64eSDaniel Schwierzeck
46592bbd64eSDaniel Schwierzeck		Special option for Lantiq XWAY SoCs for booting from NOR flash.
46692bbd64eSDaniel Schwierzeck		See also arch/mips/cpu/mips32/start.S.
46792bbd64eSDaniel Schwierzeck
46892bbd64eSDaniel Schwierzeck		CONFIG_XWAY_SWAP_BYTES
46992bbd64eSDaniel Schwierzeck
47092bbd64eSDaniel Schwierzeck		Enable compilation of tools/xway-swap-bytes needed for Lantiq
47192bbd64eSDaniel Schwierzeck		XWAY SoCs for booting from NOR flash. The U-Boot image needs to
47292bbd64eSDaniel Schwierzeck		be swapped if a flash programmer is used.
47392bbd64eSDaniel Schwierzeck
474b67d8816SChristian Riesch- ARM options:
475b67d8816SChristian Riesch		CONFIG_SYS_EXCEPTION_VECTORS_HIGH
476b67d8816SChristian Riesch
477b67d8816SChristian Riesch		Select high exception vectors of the ARM core, e.g., do not
478b67d8816SChristian Riesch		clear the V bit of the c1 register of CP15.
479b67d8816SChristian Riesch
4805356f545SAneesh V		CONFIG_SYS_THUMB_BUILD
4815356f545SAneesh V
4825356f545SAneesh V		Use this flag to build U-Boot using the Thumb instruction
4835356f545SAneesh V		set for ARM architectures. Thumb instruction set provides
4845356f545SAneesh V		better code density. For ARM architectures that support
4855356f545SAneesh V		Thumb2 this flag will result in Thumb2 code generated by
4865356f545SAneesh V		GCC.
4875356f545SAneesh V
488c5d4752cSStephen Warren		CONFIG_ARM_ERRATA_716044
4890678587fSStephen Warren		CONFIG_ARM_ERRATA_742230
4900678587fSStephen Warren		CONFIG_ARM_ERRATA_743622
4910678587fSStephen Warren		CONFIG_ARM_ERRATA_751472
4920678587fSStephen Warren
4930678587fSStephen Warren		If set, the workarounds for these ARM errata are applied early
4940678587fSStephen Warren		during U-Boot startup. Note that these options force the
4950678587fSStephen Warren		workarounds to be applied; no CPU-type/version detection
4960678587fSStephen Warren		exists, unlike the similar options in the Linux kernel. Do not
4970678587fSStephen Warren		set these options unless they apply!
4980678587fSStephen Warren
499795659dcSStephen Warren- CPU timer options:
500795659dcSStephen Warren		CONFIG_SYS_HZ
501795659dcSStephen Warren
502795659dcSStephen Warren		The frequency of the timer returned by get_timer().
503795659dcSStephen Warren		get_timer() must operate in milliseconds and this CONFIG
504795659dcSStephen Warren		option must be set to 1000.
505795659dcSStephen Warren
5065da627a4Swdenk- Linux Kernel Interface:
507c609719bSwdenk		CONFIG_CLOCKS_IN_MHZ
508c609719bSwdenk
509c609719bSwdenk		U-Boot stores all clock information in Hz
510c609719bSwdenk		internally. For binary compatibility with older Linux
511c609719bSwdenk		kernels (which expect the clocks passed in the
512c609719bSwdenk		bd_info data to be in MHz) the environment variable
513c609719bSwdenk		"clocks_in_mhz" can be defined so that U-Boot
514c609719bSwdenk		converts clock data to MHZ before passing it to the
515c609719bSwdenk		Linux kernel.
516c609719bSwdenk		When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
517c609719bSwdenk		"clocks_in_mhz=1" is automatically included in the
518c609719bSwdenk		default environment.
519c609719bSwdenk
5205da627a4Swdenk		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]
5215da627a4Swdenk
52211ccc33fSMarcel Ziswiler		When transferring memsize parameter to linux, some versions
5235da627a4Swdenk		expect it to be in bytes, others in MB.
5245da627a4Swdenk		Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
5255da627a4Swdenk
526fec6d9eeSGerald Van Baren		CONFIG_OF_LIBFDT
527f57f70aaSWolfgang Denk
528f57f70aaSWolfgang Denk		New kernel versions are expecting firmware settings to be
529213bf8c8SGerald Van Baren		passed using flattened device trees (based on open firmware
530213bf8c8SGerald Van Baren		concepts).
531213bf8c8SGerald Van Baren
532213bf8c8SGerald Van Baren		CONFIG_OF_LIBFDT
533213bf8c8SGerald Van Baren		 * New libfdt-based support
534213bf8c8SGerald Van Baren		 * Adds the "fdt" command
5353bb342fcSKim Phillips		 * The bootm command automatically updates the fdt
536213bf8c8SGerald Van Baren
537b55ae402SMarcel Ziswiler		OF_CPU - The proper name of the cpus node (only required for
538b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
539b55ae402SMarcel Ziswiler		OF_SOC - The proper name of the soc node (only required for
540b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
541f57f70aaSWolfgang Denk		OF_TBCLK - The timebase frequency.
542c2871f03SKumar Gala		OF_STDOUT_PATH - The path to the console device
543f57f70aaSWolfgang Denk
54411ccc33fSMarcel Ziswiler		boards with QUICC Engines require OF_QE to set UCC MAC
54511ccc33fSMarcel Ziswiler		addresses
5463bb342fcSKim Phillips
5474e253137SKumar Gala		CONFIG_OF_BOARD_SETUP
5484e253137SKumar Gala
5494e253137SKumar Gala		Board code has addition modification that it wants to make
5504e253137SKumar Gala		to the flat device tree before handing it off to the kernel
5516705d81eSwdenk
5520267768eSMatthew McClintock		CONFIG_OF_BOOT_CPU
5530267768eSMatthew McClintock
55411ccc33fSMarcel Ziswiler		This define fills in the correct boot CPU in the boot
5550267768eSMatthew McClintock		param header, the default value is zero if undefined.
5560267768eSMatthew McClintock
5573887c3fbSHeiko Schocher		CONFIG_OF_IDE_FIXUP
5583887c3fbSHeiko Schocher
5593887c3fbSHeiko Schocher		U-Boot can detect if an IDE device is present or not.
5603887c3fbSHeiko Schocher		If not, and this new config option is activated, U-Boot
5613887c3fbSHeiko Schocher		removes the ATA node from the DTS before booting Linux,
5623887c3fbSHeiko Schocher		so the Linux IDE driver does not probe the device and
5633887c3fbSHeiko Schocher		crash. This is needed for buggy hardware (uc101) where
5643887c3fbSHeiko Schocher		no pull down resistor is connected to the signal IDE5V_DD7.
5653887c3fbSHeiko Schocher
5667eb29398SIgor Grinberg		CONFIG_MACH_TYPE	[relevant for ARM only][mandatory]
5677eb29398SIgor Grinberg
5687eb29398SIgor Grinberg		This setting is mandatory for all boards that have only one
5697eb29398SIgor Grinberg		machine type and must be used to specify the machine type
5707eb29398SIgor Grinberg		number as it appears in the ARM machine registry
5717eb29398SIgor Grinberg		(see http://www.arm.linux.org.uk/developer/machines/).
5727eb29398SIgor Grinberg		Only boards that have multiple machine types supported
5737eb29398SIgor Grinberg		in a single configuration file and the machine type is
5747eb29398SIgor Grinberg		runtime discoverable, do not have to use this setting.
5757eb29398SIgor Grinberg
5760b2f4ecaSNiklaus Giger- vxWorks boot parameters:
5770b2f4ecaSNiklaus Giger
5780b2f4ecaSNiklaus Giger		bootvx constructs a valid bootline using the following
5790b2f4ecaSNiklaus Giger		environments variables: bootfile, ipaddr, serverip, hostname.
5800b2f4ecaSNiklaus Giger		It loads the vxWorks image pointed bootfile.
5810b2f4ecaSNiklaus Giger
5820b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
5830b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
5840b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
5850b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
5860b2f4ecaSNiklaus Giger
5870b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_ADD_PARAMS
5880b2f4ecaSNiklaus Giger
5890b2f4ecaSNiklaus Giger		Add it at the end of the bootline. E.g "u=username pw=secret"
5900b2f4ecaSNiklaus Giger
5910b2f4ecaSNiklaus Giger		Note: If a "bootargs" environment is defined, it will overwride
5920b2f4ecaSNiklaus Giger		the defaults discussed just above.
5930b2f4ecaSNiklaus Giger
5942c451f78SAneesh V- Cache Configuration:
5952c451f78SAneesh V		CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
5962c451f78SAneesh V		CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
5972c451f78SAneesh V		CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
5982c451f78SAneesh V
59993bc2193SAneesh V- Cache Configuration for ARM:
60093bc2193SAneesh V		CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
60193bc2193SAneesh V				      controller
60293bc2193SAneesh V		CONFIG_SYS_PL310_BASE - Physical base address of PL310
60393bc2193SAneesh V					controller register space
60493bc2193SAneesh V
6056705d81eSwdenk- Serial Ports:
60648d0192fSAndreas Engel		CONFIG_PL010_SERIAL
6076705d81eSwdenk
6086705d81eSwdenk		Define this if you want support for Amba PrimeCell PL010 UARTs.
6096705d81eSwdenk
61048d0192fSAndreas Engel		CONFIG_PL011_SERIAL
6116705d81eSwdenk
6126705d81eSwdenk		Define this if you want support for Amba PrimeCell PL011 UARTs.
6136705d81eSwdenk
6146705d81eSwdenk		CONFIG_PL011_CLOCK
6156705d81eSwdenk
6166705d81eSwdenk		If you have Amba PrimeCell PL011 UARTs, set this variable to
6176705d81eSwdenk		the clock speed of the UARTs.
6186705d81eSwdenk
6196705d81eSwdenk		CONFIG_PL01x_PORTS
6206705d81eSwdenk
6216705d81eSwdenk		If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
6226705d81eSwdenk		define this to a list of base addresses for each (supported)
6236705d81eSwdenk		port. See e.g. include/configs/versatile.h
6246705d81eSwdenk
625910f1ae3SJohn Rigby		CONFIG_PL011_SERIAL_RLCR
626910f1ae3SJohn Rigby
627910f1ae3SJohn Rigby		Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
628910f1ae3SJohn Rigby		have separate receive and transmit line control registers.  Set
629910f1ae3SJohn Rigby		this variable to initialize the extra register.
630910f1ae3SJohn Rigby
631910f1ae3SJohn Rigby		CONFIG_PL011_SERIAL_FLUSH_ON_INIT
632910f1ae3SJohn Rigby
633910f1ae3SJohn Rigby		On some platforms (e.g. U8500) U-Boot is loaded by a second stage
634910f1ae3SJohn Rigby		boot loader that has already initialized the UART.  Define this
635910f1ae3SJohn Rigby		variable to flush the UART at init time.
636910f1ae3SJohn Rigby
6377de0fe1aSJavier Martinez Canillas		CONFIG_SYS_NS16550_BROKEN_TEMT
6387de0fe1aSJavier Martinez Canillas
6397de0fe1aSJavier Martinez Canillas		16550 UART set the Transmitter Empty (TEMT) Bit when all output
6407de0fe1aSJavier Martinez Canillas		has finished and the transmitter is totally empty. U-Boot waits
6417de0fe1aSJavier Martinez Canillas		for this bit to be set to initialize the serial console. On some
6427de0fe1aSJavier Martinez Canillas		broken platforms this bit is not set in SPL making U-Boot to
6437de0fe1aSJavier Martinez Canillas		hang while waiting for TEMT. Define this option to avoid it.
6447de0fe1aSJavier Martinez Canillas
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
708c609719bSwdenk- Console Baudrate:
709c609719bSwdenk		CONFIG_BAUDRATE - in bps
710c609719bSwdenk		Select one of the baudrates listed in
7116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
7126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
713c609719bSwdenk
714c92fac91SHeiko Schocher- Console Rx buffer length
715c92fac91SHeiko Schocher		With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
716c92fac91SHeiko Schocher		the maximum receive buffer length for the SMC.
7172b3f12c2SHeiko Schocher		This option is actual only for 82xx and 8xx possible.
718c92fac91SHeiko Schocher		If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
719c92fac91SHeiko Schocher		must be defined, to setup the maximum idle timeout for
720c92fac91SHeiko Schocher		the SMC.
721c92fac91SHeiko Schocher
7229558b48aSGraeme Russ- Pre-Console Buffer:
7239558b48aSGraeme Russ		Prior to the console being initialised (i.e. serial UART
7249558b48aSGraeme Russ		initialised etc) all console output is silently discarded.
7259558b48aSGraeme Russ		Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
7269558b48aSGraeme Russ		buffer any console messages prior to the console being
7279558b48aSGraeme Russ		initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
7289558b48aSGraeme Russ		bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
7299558b48aSGraeme Russ		a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
7309558b48aSGraeme Russ		bytes are output before the console is initialised, the
7319558b48aSGraeme Russ		earlier bytes are discarded.
7329558b48aSGraeme Russ
7339558b48aSGraeme Russ		'Sane' compilers will generate smaller code if
7349558b48aSGraeme Russ		CONFIG_PRE_CON_BUF_SZ is a power of 2
7359558b48aSGraeme Russ
736046a37bdSSonny Rao- Safe printf() functions
737046a37bdSSonny Rao		Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
738046a37bdSSonny Rao		the printf() functions. These are defined in
739046a37bdSSonny Rao		include/vsprintf.h and include snprintf(), vsnprintf() and
740046a37bdSSonny Rao		so on. Code size increase is approximately 300-500 bytes.
741046a37bdSSonny Rao		If this option is not given then these functions will
742046a37bdSSonny Rao		silently discard their buffer size argument - this means
743046a37bdSSonny Rao		you are not getting any overflow checking in this case.
744046a37bdSSonny Rao
745c609719bSwdenk- Boot Delay:	CONFIG_BOOTDELAY - in seconds
746c609719bSwdenk		Delay before automatically booting the default image;
747c609719bSwdenk		set to -1 to disable autoboot.
74893d7212fSJoe Hershberger		set to -2 to autoboot with no delay and not check for abort
74993d7212fSJoe Hershberger		(even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
750c609719bSwdenk
751c609719bSwdenk		See doc/README.autoboot for these options that
752c609719bSwdenk		work with CONFIG_BOOTDELAY. None are required.
753c609719bSwdenk		CONFIG_BOOT_RETRY_TIME
754c609719bSwdenk		CONFIG_BOOT_RETRY_MIN
755c609719bSwdenk		CONFIG_AUTOBOOT_KEYED
756c609719bSwdenk		CONFIG_AUTOBOOT_PROMPT
757c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR
758c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR
759c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR2
760c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR2
761c609719bSwdenk		CONFIG_ZERO_BOOTDELAY_CHECK
762c609719bSwdenk		CONFIG_RESET_TO_RETRY
763c609719bSwdenk
764c609719bSwdenk- Autoboot Command:
765c609719bSwdenk		CONFIG_BOOTCOMMAND
766c609719bSwdenk		Only needed when CONFIG_BOOTDELAY is enabled;
767c609719bSwdenk		define a command string that is automatically executed
768c609719bSwdenk		when no character is read on the console interface
769c609719bSwdenk		within "Boot Delay" after reset.
770c609719bSwdenk
771c609719bSwdenk		CONFIG_BOOTARGS
772c609719bSwdenk		This can be used to pass arguments to the bootm
773c609719bSwdenk		command. The value of CONFIG_BOOTARGS goes into the
774c609719bSwdenk		environment value "bootargs".
775c609719bSwdenk
776c609719bSwdenk		CONFIG_RAMBOOT and CONFIG_NFSBOOT
777c609719bSwdenk		The value of these goes into the environment as
778c609719bSwdenk		"ramboot" and "nfsboot" respectively, and can be used
779c609719bSwdenk		as a convenience, when switching between booting from
78011ccc33fSMarcel Ziswiler		RAM and NFS.
781c609719bSwdenk
782c609719bSwdenk- Pre-Boot Commands:
783c609719bSwdenk		CONFIG_PREBOOT
784c609719bSwdenk
785c609719bSwdenk		When this option is #defined, the existence of the
786c609719bSwdenk		environment variable "preboot" will be checked
787c609719bSwdenk		immediately before starting the CONFIG_BOOTDELAY
788c609719bSwdenk		countdown and/or running the auto-boot command resp.
789c609719bSwdenk		entering interactive mode.
790c609719bSwdenk
791c609719bSwdenk		This feature is especially useful when "preboot" is
792c609719bSwdenk		automatically generated or modified. For an example
793c609719bSwdenk		see the LWMON board specific code: here "preboot" is
794c609719bSwdenk		modified when the user holds down a certain
795c609719bSwdenk		combination of keys on the (special) keyboard when
796c609719bSwdenk		booting the systems
797c609719bSwdenk
798c609719bSwdenk- Serial Download Echo Mode:
799c609719bSwdenk		CONFIG_LOADS_ECHO
800c609719bSwdenk		If defined to 1, all characters received during a
801c609719bSwdenk		serial download (using the "loads" command) are
802c609719bSwdenk		echoed back. This might be needed by some terminal
803c609719bSwdenk		emulations (like "cu"), but may as well just take
804c609719bSwdenk		time on others. This setting #define's the initial
805c609719bSwdenk		value of the "loads_echo" environment variable.
806c609719bSwdenk
807602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
808c609719bSwdenk		CONFIG_KGDB_BAUDRATE
809c609719bSwdenk		Select one of the baudrates listed in
8106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
811c609719bSwdenk
812c609719bSwdenk- Monitor Functions:
813602ad3b3SJon Loeliger		Monitor commands can be included or excluded
814602ad3b3SJon Loeliger		from the build by using the #include files
815c6c621bdSStephen Warren		<config_cmd_all.h> and #undef'ing unwanted
816c6c621bdSStephen Warren		commands, or using <config_cmd_default.h>
817602ad3b3SJon Loeliger		and augmenting with additional #define's
818602ad3b3SJon Loeliger		for wanted commands.
819c609719bSwdenk
820602ad3b3SJon Loeliger		The default command configuration includes all commands
821602ad3b3SJon Loeliger		except those marked below with a "*".
822602ad3b3SJon Loeliger
823602ad3b3SJon Loeliger		CONFIG_CMD_ASKENV	* ask for env variable
824602ad3b3SJon Loeliger		CONFIG_CMD_BDI		  bdinfo
825602ad3b3SJon Loeliger		CONFIG_CMD_BEDBUG	* Include BedBug Debugger
826602ad3b3SJon Loeliger		CONFIG_CMD_BMP		* BMP support
827602ad3b3SJon Loeliger		CONFIG_CMD_BSP		* Board specific commands
828602ad3b3SJon Loeliger		CONFIG_CMD_BOOTD	  bootd
829602ad3b3SJon Loeliger		CONFIG_CMD_CACHE	* icache, dcache
830602ad3b3SJon Loeliger		CONFIG_CMD_CONSOLE	  coninfo
831710b9938SMike Frysinger		CONFIG_CMD_CRC32	* crc32
832602ad3b3SJon Loeliger		CONFIG_CMD_DATE		* support for RTC, date/time...
833602ad3b3SJon Loeliger		CONFIG_CMD_DHCP		* DHCP support
834602ad3b3SJon Loeliger		CONFIG_CMD_DIAG		* Diagnostics
835a7c93104SPeter Tyser		CONFIG_CMD_DS4510	* ds4510 I2C gpio commands
836a7c93104SPeter Tyser		CONFIG_CMD_DS4510_INFO	* ds4510 I2C info command
837a7c93104SPeter Tyser		CONFIG_CMD_DS4510_MEM	* ds4510 I2C eeprom/sram commansd
838a7c93104SPeter Tyser		CONFIG_CMD_DS4510_RST	* ds4510 I2C rst command
839602ad3b3SJon Loeliger		CONFIG_CMD_DTT		* Digital Therm and Thermostat
840602ad3b3SJon Loeliger		CONFIG_CMD_ECHO		  echo arguments
841246c6922SPeter Tyser		CONFIG_CMD_EDITENV	  edit env variable
842602ad3b3SJon Loeliger		CONFIG_CMD_EEPROM	* EEPROM read/write support
843602ad3b3SJon Loeliger		CONFIG_CMD_ELF		* bootelf, bootvx
8445e2b3e0cSJoe Hershberger		CONFIG_CMD_ENV_CALLBACK	* display details about env callbacks
845fffad71bSJoe Hershberger		CONFIG_CMD_ENV_FLAGS	* display details about env flags
8460c79cda0SMike Frysinger		CONFIG_CMD_EXPORTENV	* export the environment
84703e2ecf6SStephen Warren		CONFIG_CMD_EXT2		* ext2 command support
84803e2ecf6SStephen Warren		CONFIG_CMD_EXT4		* ext4 command support
849bdab39d3SMike Frysinger		CONFIG_CMD_SAVEENV	  saveenv
850602ad3b3SJon Loeliger		CONFIG_CMD_FDC		* Floppy Disk Support
85103e2ecf6SStephen Warren		CONFIG_CMD_FAT		* FAT command support
852602ad3b3SJon Loeliger		CONFIG_CMD_FDOS		* Dos diskette Support
853602ad3b3SJon Loeliger		CONFIG_CMD_FLASH	  flinfo, erase, protect
854602ad3b3SJon Loeliger		CONFIG_CMD_FPGA		  FPGA device initialization support
85553fdc7efSAnton Staaf		CONFIG_CMD_GETTIME	* Get time since boot
856a641b979SMike Frysinger		CONFIG_CMD_GO		* the 'go' command (exec code)
857a000b795SKim Phillips		CONFIG_CMD_GREPENV	* search environment
858bf36c5d5SSimon Glass		CONFIG_CMD_HASH		* calculate hash / digest
859602ad3b3SJon Loeliger		CONFIG_CMD_HWFLOW	* RTS/CTS hw flow control
860602ad3b3SJon Loeliger		CONFIG_CMD_I2C		* I2C serial bus support
861602ad3b3SJon Loeliger		CONFIG_CMD_IDE		* IDE harddisk support
862602ad3b3SJon Loeliger		CONFIG_CMD_IMI		  iminfo
8638fdf1e0fSVipin Kumar		CONFIG_CMD_IMLS		  List all images found in NOR flash
8648fdf1e0fSVipin Kumar		CONFIG_CMD_IMLS_NAND	  List all images found in NAND flash
865602ad3b3SJon Loeliger		CONFIG_CMD_IMMAP	* IMMR dump support
8660c79cda0SMike Frysinger		CONFIG_CMD_IMPORTENV	* import an environment
867c167cc02SJoe Hershberger		CONFIG_CMD_INI		* import data from an ini file into the env
868602ad3b3SJon Loeliger		CONFIG_CMD_IRQ		* irqinfo
869602ad3b3SJon Loeliger		CONFIG_CMD_ITEST	  Integer/string test of 2 values
870602ad3b3SJon Loeliger		CONFIG_CMD_JFFS2	* JFFS2 Support
871602ad3b3SJon Loeliger		CONFIG_CMD_KGDB		* kgdb
8721ba7fd25SMike Frysinger		CONFIG_CMD_LDRINFO	  ldrinfo (display Blackfin loader)
873d22c338eSJoe Hershberger		CONFIG_CMD_LINK_LOCAL	* link-local IP address auto-configuration
874d22c338eSJoe Hershberger					  (169.254.*.*)
875602ad3b3SJon Loeliger		CONFIG_CMD_LOADB	  loadb
876602ad3b3SJon Loeliger		CONFIG_CMD_LOADS	  loads
87702c9aa1dSRobin Getz		CONFIG_CMD_MD5SUM	  print md5 message digest
87802c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
87915a33e49SSimon Glass		CONFIG_CMD_MEMINFO	* Display detailed memory information
880602ad3b3SJon Loeliger		CONFIG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
881a2681707SWolfgang Denk					  loop, loopw
882a2681707SWolfgang Denk		CONFIG_CMD_MEMTEST	  mtest
883602ad3b3SJon Loeliger		CONFIG_CMD_MISC		  Misc functions like sleep etc
884602ad3b3SJon Loeliger		CONFIG_CMD_MMC		* MMC memory mapped support
885602ad3b3SJon Loeliger		CONFIG_CMD_MII		* MII utility commands
88668d7d651SStefan Roese		CONFIG_CMD_MTDPARTS	* MTD partition support
887602ad3b3SJon Loeliger		CONFIG_CMD_NAND		* NAND support
888602ad3b3SJon Loeliger		CONFIG_CMD_NET		  bootp, tftpboot, rarpboot
889e92739d3SPeter Tyser		CONFIG_CMD_PCA953X	* PCA953x I2C gpio commands
890e92739d3SPeter Tyser		CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
891602ad3b3SJon Loeliger		CONFIG_CMD_PCI		* pciinfo
892602ad3b3SJon Loeliger		CONFIG_CMD_PCMCIA		* PCMCIA support
893602ad3b3SJon Loeliger		CONFIG_CMD_PING		* send ICMP ECHO_REQUEST to network
894602ad3b3SJon Loeliger					  host
895602ad3b3SJon Loeliger		CONFIG_CMD_PORTIO	* Port I/O
896ff048ea9SKenneth Waters		CONFIG_CMD_READ		* Read raw data from partition
897602ad3b3SJon Loeliger		CONFIG_CMD_REGINFO	* Register dump
898602ad3b3SJon Loeliger		CONFIG_CMD_RUN		  run command in env variable
899d304931fSSimon Glass		CONFIG_CMD_SANDBOX	* sb command to access sandbox features
900602ad3b3SJon Loeliger		CONFIG_CMD_SAVES	* save S record dump
901602ad3b3SJon Loeliger		CONFIG_CMD_SCSI		* SCSI Support
902602ad3b3SJon Loeliger		CONFIG_CMD_SDRAM	* print SDRAM configuration information
903602ad3b3SJon Loeliger					  (requires CONFIG_CMD_I2C)
904602ad3b3SJon Loeliger		CONFIG_CMD_SETGETDCR	  Support for DCR Register access
905602ad3b3SJon Loeliger					  (4xx only)
906f61ec45eSEric Nelson		CONFIG_CMD_SF		* Read/write/erase SPI NOR flash
907c6b1ee66SAlexander Holler		CONFIG_CMD_SHA1SUM	  print sha1 memory digest
90802c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY)
90974de7aefSWolfgang Denk		CONFIG_CMD_SOURCE	  "source" command Support
910602ad3b3SJon Loeliger		CONFIG_CMD_SPI		* SPI serial bus support
9117a83af07SLuca Ceresoli		CONFIG_CMD_TFTPSRV	* TFTP transfer in server mode
9121fb7cd49SSimon Glass		CONFIG_CMD_TFTPPUT	* TFTP put command (upload)
913da83bcd7SJoe Hershberger		CONFIG_CMD_TIME		* run command and report execution time (ARM specific)
914da83bcd7SJoe Hershberger		CONFIG_CMD_TIMER	* access to the system tick timer
915602ad3b3SJon Loeliger		CONFIG_CMD_USB		* USB support
916602ad3b3SJon Loeliger		CONFIG_CMD_CDP		* Cisco Discover Protocol support
917c8339f51SMarek Vasut		CONFIG_CMD_MFSL		* Microblaze FSL support
918c609719bSwdenk
919c609719bSwdenk
920c609719bSwdenk		EXAMPLE: If you want all functions except of network
921c609719bSwdenk		support you can write:
922c609719bSwdenk
923602ad3b3SJon Loeliger		#include "config_cmd_all.h"
924602ad3b3SJon Loeliger		#undef CONFIG_CMD_NET
925c609719bSwdenk
926213bf8c8SGerald Van Baren	Other Commands:
927213bf8c8SGerald Van Baren		fdt (flattened device tree) command: CONFIG_OF_LIBFDT
928c609719bSwdenk
929c609719bSwdenk	Note:	Don't enable the "icache" and "dcache" commands
930602ad3b3SJon Loeliger		(configuration option CONFIG_CMD_CACHE) unless you know
931c609719bSwdenk		what you (and your U-Boot users) are doing. Data
932c609719bSwdenk		cache cannot be enabled on systems like the 8xx or
933c609719bSwdenk		8260 (where accesses to the IMMR region must be
934c609719bSwdenk		uncached), and it cannot be disabled on all other
935c609719bSwdenk		systems where we (mis-) use the data cache to hold an
936c609719bSwdenk		initial stack and some data.
937c609719bSwdenk
938c609719bSwdenk
939c609719bSwdenk		XXX - this list needs to get updated!
940c609719bSwdenk
94145ba8077SSimon Glass- Device tree:
94245ba8077SSimon Glass		CONFIG_OF_CONTROL
94345ba8077SSimon Glass		If this variable is defined, U-Boot will use a device tree
94445ba8077SSimon Glass		to configure its devices, instead of relying on statically
94545ba8077SSimon Glass		compiled #defines in the board file. This option is
94645ba8077SSimon Glass		experimental and only available on a few boards. The device
94745ba8077SSimon Glass		tree is available in the global data as gd->fdt_blob.
94845ba8077SSimon Glass
9492c0f79e4SSimon Glass		U-Boot needs to get its device tree from somewhere. This can
9502c0f79e4SSimon Glass		be done using one of the two options below:
951bbb0b128SSimon Glass
952bbb0b128SSimon Glass		CONFIG_OF_EMBED
953bbb0b128SSimon Glass		If this variable is defined, U-Boot will embed a device tree
954bbb0b128SSimon Glass		binary in its image. This device tree file should be in the
955bbb0b128SSimon Glass		board directory and called <soc>-<board>.dts. The binary file
956bbb0b128SSimon Glass		is then picked up in board_init_f() and made available through
957bbb0b128SSimon Glass		the global data structure as gd->blob.
95845ba8077SSimon Glass
9592c0f79e4SSimon Glass		CONFIG_OF_SEPARATE
9602c0f79e4SSimon Glass		If this variable is defined, U-Boot will build a device tree
9612c0f79e4SSimon Glass		binary. It will be called u-boot.dtb. Architecture-specific
9622c0f79e4SSimon Glass		code will locate it at run-time. Generally this works by:
9632c0f79e4SSimon Glass
9642c0f79e4SSimon Glass			cat u-boot.bin u-boot.dtb >image.bin
9652c0f79e4SSimon Glass
9662c0f79e4SSimon Glass		and in fact, U-Boot does this for you, creating a file called
9672c0f79e4SSimon Glass		u-boot-dtb.bin which is useful in the common case. You can
9682c0f79e4SSimon Glass		still use the individual files if you need something more
9692c0f79e4SSimon Glass		exotic.
9702c0f79e4SSimon Glass
971c609719bSwdenk- Watchdog:
972c609719bSwdenk		CONFIG_WATCHDOG
973c609719bSwdenk		If this variable is defined, it enables watchdog
9746abe6fb6SDetlev Zundel		support for the SoC. There must be support in the SoC
9756abe6fb6SDetlev Zundel		specific code for a watchdog. For the 8xx and 8260
9766abe6fb6SDetlev Zundel		CPUs, the SIU Watchdog feature is enabled in the SYPCR
9776abe6fb6SDetlev Zundel		register.  When supported for a specific SoC is
9786abe6fb6SDetlev Zundel		available, then no further board specific code should
9796abe6fb6SDetlev Zundel		be needed to use it.
9806abe6fb6SDetlev Zundel
9816abe6fb6SDetlev Zundel		CONFIG_HW_WATCHDOG
9826abe6fb6SDetlev Zundel		When using a watchdog circuitry external to the used
9836abe6fb6SDetlev Zundel		SoC, then define this variable and provide board
9846abe6fb6SDetlev Zundel		specific code for the "hw_watchdog_reset" function.
985c609719bSwdenk
986c1551ea8Sstroese- U-Boot Version:
987c1551ea8Sstroese		CONFIG_VERSION_VARIABLE
988c1551ea8Sstroese		If this variable is defined, an environment variable
989c1551ea8Sstroese		named "ver" is created by U-Boot showing the U-Boot
990c1551ea8Sstroese		version as printed by the "version" command.
991a1ea8e51SBenoît Thébaudeau		Any change to this variable will be reverted at the
992a1ea8e51SBenoît Thébaudeau		next reset.
993c1551ea8Sstroese
994c609719bSwdenk- Real-Time Clock:
995c609719bSwdenk
996602ad3b3SJon Loeliger		When CONFIG_CMD_DATE is selected, the type of the RTC
997c609719bSwdenk		has to be selected, too. Define exactly one of the
998c609719bSwdenk		following options:
999c609719bSwdenk
1000c609719bSwdenk		CONFIG_RTC_MPC8xx	- use internal RTC of MPC8xx
1001c609719bSwdenk		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
10024e8b7544SFabio Estevam		CONFIG_RTC_MC13XXX	- use MC13783 or MC13892 RTC
1003c609719bSwdenk		CONFIG_RTC_MC146818	- use MC146818 RTC
10041cb8e980Swdenk		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
1005c609719bSwdenk		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
10067f70e853Swdenk		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
10073bac3513Swdenk		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
10089536dfccSTor Krill		CONFIG_RTC_ISL1208	- use Intersil ISL1208 RTC
10094c0d4c3bSwdenk		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
10106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_DS1337_NOOSC	- Turn off the OSC output for DS1337
101171d19f30SHeiko Schocher		CONFIG_SYS_RV3029_TCR	- enable trickle charger on
101271d19f30SHeiko Schocher					  RV3029 RTC.
1013c609719bSwdenk
1014b37c7e5eSwdenk		Note that if the RTC uses I2C, then the I2C interface
1015b37c7e5eSwdenk		must also be configured. See I2C Support, below.
1016b37c7e5eSwdenk
1017e92739d3SPeter Tyser- GPIO Support:
1018e92739d3SPeter Tyser		CONFIG_PCA953X		- use NXP's PCA953X series I2C GPIO
1019e92739d3SPeter Tyser		CONFIG_PCA953X_INFO	- enable pca953x info command
1020e92739d3SPeter Tyser
10215dec49caSChris Packham		The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
10225dec49caSChris Packham		chip-ngpio pairs that tell the PCA953X driver the number of
10235dec49caSChris Packham		pins supported by a particular chip.
10245dec49caSChris Packham
1025e92739d3SPeter Tyser		Note that if the GPIO device uses I2C, then the I2C interface
1026e92739d3SPeter Tyser		must also be configured. See I2C Support, below.
1027e92739d3SPeter Tyser
1028c609719bSwdenk- Timestamp Support:
1029c609719bSwdenk
1030c609719bSwdenk		When CONFIG_TIMESTAMP is selected, the timestamp
1031c609719bSwdenk		(date and time) of an image is printed by image
1032c609719bSwdenk		commands like bootm or iminfo. This option is
1033602ad3b3SJon Loeliger		automatically enabled when you select CONFIG_CMD_DATE .
1034c609719bSwdenk
1035923c46f9SKarl O. Pinc- Partition Labels (disklabels) Supported:
1036923c46f9SKarl O. Pinc		Zero or more of the following:
1037923c46f9SKarl O. Pinc		CONFIG_MAC_PARTITION   Apple's MacOS partition table.
1038923c46f9SKarl O. Pinc		CONFIG_DOS_PARTITION   MS Dos partition table, traditional on the
1039923c46f9SKarl O. Pinc				       Intel architecture, USB sticks, etc.
1040923c46f9SKarl O. Pinc		CONFIG_ISO_PARTITION   ISO partition table, used on CDROM etc.
1041923c46f9SKarl O. Pinc		CONFIG_EFI_PARTITION   GPT partition table, common when EFI is the
1042923c46f9SKarl O. Pinc				       bootloader.  Note 2TB partition limit; see
1043923c46f9SKarl O. Pinc				       disk/part_efi.c
1044923c46f9SKarl O. Pinc		CONFIG_MTD_PARTITIONS  Memory Technology Device partition table.
1045c609719bSwdenk
1046602ad3b3SJon Loeliger		If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1047218ca724SWolfgang Denk		CONFIG_CMD_SCSI) you must configure support for at
1048923c46f9SKarl O. Pinc		least one non-MTD partition type as well.
1049c609719bSwdenk
1050c609719bSwdenk- IDE Reset method:
10514d13cbadSwdenk		CONFIG_IDE_RESET_ROUTINE - this is defined in several
10524d13cbadSwdenk		board configurations files but used nowhere!
1053c609719bSwdenk
10544d13cbadSwdenk		CONFIG_IDE_RESET - is this is defined, IDE Reset will
10554d13cbadSwdenk		be performed by calling the function
10564d13cbadSwdenk			ide_set_reset(int reset)
10574d13cbadSwdenk		which has to be defined in a board specific file
1058c609719bSwdenk
1059c609719bSwdenk- ATAPI Support:
1060c609719bSwdenk		CONFIG_ATAPI
1061c609719bSwdenk
1062c609719bSwdenk		Set this to enable ATAPI support.
1063c609719bSwdenk
1064c40b2956Swdenk- LBA48 Support
1065c40b2956Swdenk		CONFIG_LBA48
1066c40b2956Swdenk
1067c40b2956Swdenk		Set this to enable support for disks larger than 137GB
10684b142febSHeiko Schocher		Also look at CONFIG_SYS_64BIT_LBA.
1069c40b2956Swdenk		Whithout these , LBA48 support uses 32bit variables and will 'only'
1070c40b2956Swdenk		support disks up to 2.1TB.
1071c40b2956Swdenk
10726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_64BIT_LBA:
1073c40b2956Swdenk			When enabled, makes the IDE subsystem use 64bit sector addresses.
1074c40b2956Swdenk			Default is 32bit.
1075c40b2956Swdenk
1076c609719bSwdenk- SCSI Support:
1077c609719bSwdenk		At the moment only there is only support for the
1078c609719bSwdenk		SYM53C8XX SCSI controller; define
1079c609719bSwdenk		CONFIG_SCSI_SYM53C8XX to enable it.
1080c609719bSwdenk
10816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
10826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
10836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
1084c609719bSwdenk		maximum numbers of LUNs, SCSI ID's and target
1085c609719bSwdenk		devices.
10866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
1087c609719bSwdenk
1088447c031bSStefan Reinauer                The environment variable 'scsidevs' is set to the number of
1089447c031bSStefan Reinauer                SCSI devices found during the last scan.
1090447c031bSStefan Reinauer
1091c609719bSwdenk- NETWORK Support (PCI):
1092682011ffSwdenk		CONFIG_E1000
1093ce5207e1SKyle Moffett		Support for Intel 8254x/8257x gigabit chips.
1094ce5207e1SKyle Moffett
1095ce5207e1SKyle Moffett		CONFIG_E1000_SPI
1096ce5207e1SKyle Moffett		Utility code for direct access to the SPI bus on Intel 8257x.
1097ce5207e1SKyle Moffett		This does not do anything useful unless you set at least one
1098ce5207e1SKyle Moffett		of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1099ce5207e1SKyle Moffett
1100ce5207e1SKyle Moffett		CONFIG_E1000_SPI_GENERIC
1101ce5207e1SKyle Moffett		Allow generic access to the SPI bus on the Intel 8257x, for
1102ce5207e1SKyle Moffett		example with the "sspi" command.
1103ce5207e1SKyle Moffett
1104ce5207e1SKyle Moffett		CONFIG_CMD_E1000
1105ce5207e1SKyle Moffett		Management command for E1000 devices.  When used on devices
1106ce5207e1SKyle Moffett		with SPI support you can reprogram the EEPROM from U-Boot.
1107682011ffSwdenk
1108ac3315c2SAndre Schwarz		CONFIG_E1000_FALLBACK_MAC
110911ccc33fSMarcel Ziswiler		default MAC for empty EEPROM after production.
1110ac3315c2SAndre Schwarz
1111c609719bSwdenk		CONFIG_EEPRO100
1112c609719bSwdenk		Support for Intel 82557/82559/82559ER chips.
111311ccc33fSMarcel Ziswiler		Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
1114c609719bSwdenk		write routine for first time initialisation.
1115c609719bSwdenk
1116c609719bSwdenk		CONFIG_TULIP
1117c609719bSwdenk		Support for Digital 2114x chips.
1118c609719bSwdenk		Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1119c609719bSwdenk		modem chip initialisation (KS8761/QS6611).
1120c609719bSwdenk
1121c609719bSwdenk		CONFIG_NATSEMI
1122c609719bSwdenk		Support for National dp83815 chips.
1123c609719bSwdenk
1124c609719bSwdenk		CONFIG_NS8382X
1125c609719bSwdenk		Support for National dp8382[01] gigabit chips.
1126c609719bSwdenk
112745219c46Swdenk- NETWORK Support (other):
112845219c46Swdenk
1129c041e9d2SJens Scharsig		CONFIG_DRIVER_AT91EMAC
1130c041e9d2SJens Scharsig		Support for AT91RM9200 EMAC.
1131c041e9d2SJens Scharsig
1132c041e9d2SJens Scharsig			CONFIG_RMII
1133c041e9d2SJens Scharsig			Define this to use reduced MII inteface
1134c041e9d2SJens Scharsig
1135c041e9d2SJens Scharsig			CONFIG_DRIVER_AT91EMAC_QUIET
1136c041e9d2SJens Scharsig			If this defined, the driver is quiet.
1137c041e9d2SJens Scharsig			The driver doen't show link status messages.
1138c041e9d2SJens Scharsig
1139efdd7319SRob Herring		CONFIG_CALXEDA_XGMAC
1140efdd7319SRob Herring		Support for the Calxeda XGMAC device
1141efdd7319SRob Herring
11423bb46d23SAshok		CONFIG_LAN91C96
114345219c46Swdenk		Support for SMSC's LAN91C96 chips.
114445219c46Swdenk
114545219c46Swdenk			CONFIG_LAN91C96_BASE
114645219c46Swdenk			Define this to hold the physical address
114745219c46Swdenk			of the LAN91C96's I/O space
114845219c46Swdenk
114945219c46Swdenk			CONFIG_LAN91C96_USE_32_BIT
115045219c46Swdenk			Define this to enable 32 bit addressing
115145219c46Swdenk
11523bb46d23SAshok		CONFIG_SMC91111
1153f39748aeSwdenk		Support for SMSC's LAN91C111 chip
1154f39748aeSwdenk
1155f39748aeSwdenk			CONFIG_SMC91111_BASE
1156f39748aeSwdenk			Define this to hold the physical address
1157f39748aeSwdenk			of the device (I/O space)
1158f39748aeSwdenk
1159f39748aeSwdenk			CONFIG_SMC_USE_32_BIT
1160f39748aeSwdenk			Define this if data bus is 32 bits
1161f39748aeSwdenk
1162f39748aeSwdenk			CONFIG_SMC_USE_IOFUNCS
1163f39748aeSwdenk			Define this to use i/o functions instead of macros
1164f39748aeSwdenk			(some hardware wont work with macros)
1165f39748aeSwdenk
1166dc02badaSHeiko Schocher		CONFIG_DRIVER_TI_EMAC
1167dc02badaSHeiko Schocher		Support for davinci emac
1168dc02badaSHeiko Schocher
1169dc02badaSHeiko Schocher			CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1170dc02badaSHeiko Schocher			Define this if you have more then 3 PHYs.
1171dc02badaSHeiko Schocher
1172b3dbf4a5SMacpaul Lin		CONFIG_FTGMAC100
1173b3dbf4a5SMacpaul Lin		Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1174b3dbf4a5SMacpaul Lin
1175b3dbf4a5SMacpaul Lin			CONFIG_FTGMAC100_EGIGA
1176b3dbf4a5SMacpaul Lin			Define this to use GE link update with gigabit PHY.
1177b3dbf4a5SMacpaul Lin			Define this if FTGMAC100 is connected to gigabit PHY.
1178b3dbf4a5SMacpaul Lin			If your system has 10/100 PHY only, it might not occur
1179b3dbf4a5SMacpaul Lin			wrong behavior. Because PHY usually return timeout or
1180b3dbf4a5SMacpaul Lin			useless data when polling gigabit status and gigabit
1181b3dbf4a5SMacpaul Lin			control registers. This behavior won't affect the
1182b3dbf4a5SMacpaul Lin			correctnessof 10/100 link speed update.
1183b3dbf4a5SMacpaul Lin
1184c2fff331SMike Rapoport		CONFIG_SMC911X
1185557b377dSJens Gehrlein		Support for SMSC's LAN911x and LAN921x chips
1186557b377dSJens Gehrlein
1187c2fff331SMike Rapoport			CONFIG_SMC911X_BASE
1188557b377dSJens Gehrlein			Define this to hold the physical address
1189557b377dSJens Gehrlein			of the device (I/O space)
1190557b377dSJens Gehrlein
1191c2fff331SMike Rapoport			CONFIG_SMC911X_32_BIT
1192557b377dSJens Gehrlein			Define this if data bus is 32 bits
1193557b377dSJens Gehrlein
1194c2fff331SMike Rapoport			CONFIG_SMC911X_16_BIT
1195557b377dSJens Gehrlein			Define this if data bus is 16 bits. If your processor
1196557b377dSJens Gehrlein			automatically converts one 32 bit word to two 16 bit
1197c2fff331SMike Rapoport			words you may also try CONFIG_SMC911X_32_BIT.
1198557b377dSJens Gehrlein
11993d0075faSYoshihiro Shimoda		CONFIG_SH_ETHER
12003d0075faSYoshihiro Shimoda		Support for Renesas on-chip Ethernet controller
12013d0075faSYoshihiro Shimoda
12023d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_USE_PORT
12033d0075faSYoshihiro Shimoda			Define the number of ports to be used
12043d0075faSYoshihiro Shimoda
12053d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_PHY_ADDR
12063d0075faSYoshihiro Shimoda			Define the ETH PHY's address
12073d0075faSYoshihiro Shimoda
120868260aabSYoshihiro Shimoda			CONFIG_SH_ETHER_CACHE_WRITEBACK
120968260aabSYoshihiro Shimoda			If this option is set, the driver enables cache flush.
121068260aabSYoshihiro Shimoda
12115e124724SVadim Bendebury- TPM Support:
12125e124724SVadim Bendebury		CONFIG_GENERIC_LPC_TPM
12135e124724SVadim Bendebury		Support for generic parallel port TPM devices. Only one device
12145e124724SVadim Bendebury		per system is supported at this time.
12155e124724SVadim Bendebury
12165e124724SVadim Bendebury			CONFIG_TPM_TIS_BASE_ADDRESS
12175e124724SVadim Bendebury			Base address where the generic TPM device is mapped
12185e124724SVadim Bendebury			to. Contemporary x86 systems usually map it at
12195e124724SVadim Bendebury			0xfed40000.
12205e124724SVadim Bendebury
1221c609719bSwdenk- USB Support:
1222c609719bSwdenk		At the moment only the UHCI host controller is
12234d13cbadSwdenk		supported (PIP405, MIP405, MPC5200); define
1224c609719bSwdenk		CONFIG_USB_UHCI to enable it.
1225c609719bSwdenk		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
122630d56faeSwdenk		and define CONFIG_USB_STORAGE to enable the USB
1227c609719bSwdenk		storage devices.
1228c609719bSwdenk		Note:
1229c609719bSwdenk		Supported are USB Keyboards and USB Floppy drives
1230c609719bSwdenk		(TEAC FD-05PUB).
12314d13cbadSwdenk		MPC5200 USB requires additional defines:
12324d13cbadSwdenk			CONFIG_USB_CLOCK
12334d13cbadSwdenk				for 528 MHz Clock: 0x0001bbbb
1234307ecb6dSEric Millbrandt			CONFIG_PSC3_USB
1235307ecb6dSEric Millbrandt				for USB on PSC3
12364d13cbadSwdenk			CONFIG_USB_CONFIG
12374d13cbadSwdenk				for differential drivers: 0x00001000
12384d13cbadSwdenk				for single ended drivers: 0x00005000
1239307ecb6dSEric Millbrandt				for differential drivers on PSC3: 0x00000100
1240307ecb6dSEric Millbrandt				for single ended drivers on PSC3: 0x00004100
12416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_USB_EVENT_POLL
1242fdcfaa1bSZhang Wei				May be defined to allow interrupt polling
1243fdcfaa1bSZhang Wei				instead of using asynchronous interrupts
12444d13cbadSwdenk
12459ab4ce22SSimon Glass		CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
12469ab4ce22SSimon Glass		txfilltuning field in the EHCI controller on reset.
12479ab4ce22SSimon Glass
124816c8d5e7SWolfgang Denk- USB Device:
124916c8d5e7SWolfgang Denk		Define the below if you wish to use the USB console.
125016c8d5e7SWolfgang Denk		Once firmware is rebuilt from a serial console issue the
125116c8d5e7SWolfgang Denk		command "setenv stdin usbtty; setenv stdout usbtty" and
125211ccc33fSMarcel Ziswiler		attach your USB cable. The Unix command "dmesg" should print
125316c8d5e7SWolfgang Denk		it has found a new device. The environment variable usbtty
125416c8d5e7SWolfgang Denk		can be set to gserial or cdc_acm to enable your device to
125516c8d5e7SWolfgang Denk		appear to a USB host as a Linux gserial device or a
125616c8d5e7SWolfgang Denk		Common Device Class Abstract Control Model serial device.
125716c8d5e7SWolfgang Denk		If you select usbtty = gserial you should be able to enumerate
125816c8d5e7SWolfgang Denk		a Linux host by
125916c8d5e7SWolfgang Denk		# modprobe usbserial vendor=0xVendorID product=0xProductID
126016c8d5e7SWolfgang Denk		else if using cdc_acm, simply setting the environment
126116c8d5e7SWolfgang Denk		variable usbtty to be cdc_acm should suffice. The following
126216c8d5e7SWolfgang Denk		might be defined in YourBoardName.h
126316c8d5e7SWolfgang Denk
126416c8d5e7SWolfgang Denk			CONFIG_USB_DEVICE
126516c8d5e7SWolfgang Denk			Define this to build a UDC device
126616c8d5e7SWolfgang Denk
126716c8d5e7SWolfgang Denk			CONFIG_USB_TTY
126816c8d5e7SWolfgang Denk			Define this to have a tty type of device available to
126916c8d5e7SWolfgang Denk			talk to the UDC device
127016c8d5e7SWolfgang Denk
1271f9da0f89SVipin KUMAR			CONFIG_USBD_HS
1272f9da0f89SVipin KUMAR			Define this to enable the high speed support for usb
1273f9da0f89SVipin KUMAR			device and usbtty. If this feature is enabled, a routine
1274f9da0f89SVipin KUMAR			int is_usbd_high_speed(void)
1275f9da0f89SVipin KUMAR			also needs to be defined by the driver to dynamically poll
1276f9da0f89SVipin KUMAR			whether the enumeration has succeded at high speed or full
1277f9da0f89SVipin KUMAR			speed.
1278f9da0f89SVipin KUMAR
12796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_IS_IN_ENV
128016c8d5e7SWolfgang Denk			Define this if you want stdin, stdout &/or stderr to
128116c8d5e7SWolfgang Denk			be set to usbtty.
128216c8d5e7SWolfgang Denk
128316c8d5e7SWolfgang Denk			mpc8xx:
12846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_EXTC_CLK 0xBLAH
128516c8d5e7SWolfgang Denk				Derive USB clock from external clock "blah"
12866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_EXTC_CLK 0x02
128716c8d5e7SWolfgang Denk
12886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_BRG_CLK 0xBLAH
128916c8d5e7SWolfgang Denk				Derive USB clock from brgclk
12906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_BRG_CLK 0x04
129116c8d5e7SWolfgang Denk
129216c8d5e7SWolfgang Denk		If you have a USB-IF assigned VendorID then you may wish to
129316c8d5e7SWolfgang Denk		define your own vendor specific values either in BoardName.h
129416c8d5e7SWolfgang Denk		or directly in usbd_vendor_info.h. If you don't define
129516c8d5e7SWolfgang Denk		CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
129616c8d5e7SWolfgang Denk		CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
129716c8d5e7SWolfgang Denk		should pretend to be a Linux device to it's target host.
129816c8d5e7SWolfgang Denk
129916c8d5e7SWolfgang Denk			CONFIG_USBD_MANUFACTURER
130016c8d5e7SWolfgang Denk			Define this string as the name of your company for
130116c8d5e7SWolfgang Denk			- CONFIG_USBD_MANUFACTURER "my company"
130216c8d5e7SWolfgang Denk
130316c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCT_NAME
130416c8d5e7SWolfgang Denk			Define this string as the name of your product
130516c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCT_NAME "acme usb device"
130616c8d5e7SWolfgang Denk
130716c8d5e7SWolfgang Denk			CONFIG_USBD_VENDORID
130816c8d5e7SWolfgang Denk			Define this as your assigned Vendor ID from the USB
130916c8d5e7SWolfgang Denk			Implementors Forum. This *must* be a genuine Vendor ID
131016c8d5e7SWolfgang Denk			to avoid polluting the USB namespace.
131116c8d5e7SWolfgang Denk			- CONFIG_USBD_VENDORID 0xFFFF
131216c8d5e7SWolfgang Denk
131316c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCTID
131416c8d5e7SWolfgang Denk			Define this as the unique Product ID
131516c8d5e7SWolfgang Denk			for your device
131616c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCTID 0xFFFF
1317c609719bSwdenk
1318d70a560fSIgor Grinberg- ULPI Layer Support:
1319d70a560fSIgor Grinberg		The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1320d70a560fSIgor Grinberg		the generic ULPI layer. The generic layer accesses the ULPI PHY
1321d70a560fSIgor Grinberg		via the platform viewport, so you need both the genric layer and
1322d70a560fSIgor Grinberg		the viewport enabled. Currently only Chipidea/ARC based
1323d70a560fSIgor Grinberg		viewport is supported.
1324d70a560fSIgor Grinberg		To enable the ULPI layer support, define CONFIG_USB_ULPI and
1325d70a560fSIgor Grinberg		CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
13266d365ea0SLucas Stach		If your ULPI phy needs a different reference clock than the
13276d365ea0SLucas Stach		standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
13286d365ea0SLucas Stach		the appropriate value in Hz.
1329c609719bSwdenk
1330c609719bSwdenk- MMC Support:
1331c609719bSwdenk		The MMC controller on the Intel PXA is supported. To
1332c609719bSwdenk		enable this define CONFIG_MMC. The MMC can be
1333c609719bSwdenk		accessed from the boot prompt by mapping the device
1334c609719bSwdenk		to physical memory similar to flash. Command line is
1335602ad3b3SJon Loeliger		enabled with CONFIG_CMD_MMC. The MMC driver also works with
1336602ad3b3SJon Loeliger		the FAT fs. This is enabled with CONFIG_CMD_FAT.
1337c609719bSwdenk
1338afb35666SYoshihiro Shimoda		CONFIG_SH_MMCIF
1339afb35666SYoshihiro Shimoda		Support for Renesas on-chip MMCIF controller
1340afb35666SYoshihiro Shimoda
1341afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_ADDR
1342afb35666SYoshihiro Shimoda			Define the base address of MMCIF registers
1343afb35666SYoshihiro Shimoda
1344afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_CLK
1345afb35666SYoshihiro Shimoda			Define the clock frequency for MMCIF
1346afb35666SYoshihiro Shimoda
1347*b3ba6e94STom Rini- USB Device Firmware Update (DFU) class support:
1348*b3ba6e94STom Rini		CONFIG_DFU_FUNCTION
1349*b3ba6e94STom Rini		This enables the USB portion of the DFU USB class
1350*b3ba6e94STom Rini
1351*b3ba6e94STom Rini		CONFIG_CMD_DFU
1352*b3ba6e94STom Rini		This enables the command "dfu" which is used to have
1353*b3ba6e94STom Rini		U-Boot create a DFU class device via USB.  This command
1354*b3ba6e94STom Rini		requires that the "dfu_alt_info" environment variable be
1355*b3ba6e94STom Rini		set and define the alt settings to expose to the host.
1356*b3ba6e94STom Rini
1357*b3ba6e94STom Rini		CONFIG_DFU_MMC
1358*b3ba6e94STom Rini		This enables support for exposing (e)MMC devices via DFU.
1359*b3ba6e94STom Rini
13606705d81eSwdenk- Journaling Flash filesystem support:
13616705d81eSwdenk		CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
13626705d81eSwdenk		CONFIG_JFFS2_NAND_DEV
13636705d81eSwdenk		Define these for a default partition on a NAND device
13646705d81eSwdenk
13656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_SECTOR,
13666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
13676705d81eSwdenk		Define these for a default partition on a NOR device
13686705d81eSwdenk
13696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS_CUSTOM_PART
13706705d81eSwdenk		Define this to create an own partition. You have to provide a
13716705d81eSwdenk		function struct part_info* jffs2_part_info(int part_num)
13726705d81eSwdenk
13736705d81eSwdenk		If you define only one JFFS2 partition you may also want to
13746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_JFFS_SINGLE_PART	1
13756705d81eSwdenk		to disable the command chpart. This is the default when you
13766705d81eSwdenk		have not defined a custom partition
13776705d81eSwdenk
1378c30a15e5SDonggeun Kim- FAT(File Allocation Table) filesystem write function support:
1379c30a15e5SDonggeun Kim		CONFIG_FAT_WRITE
1380656f4c65SDonggeun Kim
1381656f4c65SDonggeun Kim		Define this to enable support for saving memory data as a
1382656f4c65SDonggeun Kim		file in FAT formatted partition.
1383656f4c65SDonggeun Kim
1384656f4c65SDonggeun Kim		This will also enable the command "fatwrite" enabling the
1385656f4c65SDonggeun Kim		user to write files to FAT.
1386c30a15e5SDonggeun Kim
138784cd9327SGabe BlackCBFS (Coreboot Filesystem) support
138884cd9327SGabe Black		CONFIG_CMD_CBFS
138984cd9327SGabe Black
139084cd9327SGabe Black		Define this to enable support for reading from a Coreboot
139184cd9327SGabe Black		filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
139284cd9327SGabe Black		and cbfsload.
139384cd9327SGabe Black
1394c609719bSwdenk- Keyboard Support:
1395c609719bSwdenk		CONFIG_ISA_KEYBOARD
1396c609719bSwdenk
1397c609719bSwdenk		Define this to enable standard (PC-Style) keyboard
1398c609719bSwdenk		support
1399c609719bSwdenk
1400c609719bSwdenk		CONFIG_I8042_KBD
1401c609719bSwdenk		Standard PC keyboard driver with US (is default) and
1402c609719bSwdenk		GERMAN key layout (switch via environment 'keymap=de') support.
1403c609719bSwdenk		Export function i8042_kbd_init, i8042_tstc and i8042_getc
1404c609719bSwdenk		for cfb_console. Supports cursor blinking.
1405c609719bSwdenk
1406c609719bSwdenk- Video support:
1407c609719bSwdenk		CONFIG_VIDEO
1408c609719bSwdenk
1409c609719bSwdenk		Define this to enable video support (for output to
1410c609719bSwdenk		video).
1411c609719bSwdenk
1412c609719bSwdenk		CONFIG_VIDEO_CT69000
1413c609719bSwdenk
1414c609719bSwdenk		Enable Chips & Technologies 69000 Video chip
1415c609719bSwdenk
1416c609719bSwdenk		CONFIG_VIDEO_SMI_LYNXEM
1417eeb1b77bSwdenk		Enable Silicon Motion SMI 712/710/810 Video chip. The
1418eeb1b77bSwdenk		video output is selected via environment 'videoout'
1419eeb1b77bSwdenk		(1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1420eeb1b77bSwdenk		assumed.
1421c609719bSwdenk
1422eeb1b77bSwdenk		For the CT69000 and SMI_LYNXEM drivers, videomode is
142311ccc33fSMarcel Ziswiler		selected via environment 'videomode'. Two different ways
1424eeb1b77bSwdenk		are possible:
1425eeb1b77bSwdenk		- "videomode=num"   'num' is a standard LiLo mode numbers.
1426eeb1b77bSwdenk		Following standard modes are supported	(* is default):
1427eeb1b77bSwdenk
1428eeb1b77bSwdenk		      Colors	640x480 800x600 1024x768 1152x864 1280x1024
1429eeb1b77bSwdenk		-------------+---------------------------------------------
1430eeb1b77bSwdenk		      8 bits |	0x301*	0x303	 0x305	  0x161	    0x307
1431eeb1b77bSwdenk		     15 bits |	0x310	0x313	 0x316	  0x162	    0x319
1432eeb1b77bSwdenk		     16 bits |	0x311	0x314	 0x317	  0x163	    0x31A
1433eeb1b77bSwdenk		     24 bits |	0x312	0x315	 0x318	    ?	    0x31B
1434eeb1b77bSwdenk		-------------+---------------------------------------------
1435c609719bSwdenk		(i.e. setenv videomode 317; saveenv; reset;)
1436c609719bSwdenk
1437eeb1b77bSwdenk		- "videomode=bootargs" all the video parameters are parsed
14387817cb20SMarcel Ziswiler		from the bootargs. (See drivers/video/videomodes.c)
1439eeb1b77bSwdenk
1440eeb1b77bSwdenk
1441a6c7ad2fSwdenk		CONFIG_VIDEO_SED13806
1442a6c7ad2fSwdenk		Enable Epson SED13806 driver. This driver supports 8bpp
1443a6c7ad2fSwdenk		and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1444a6c7ad2fSwdenk		or CONFIG_VIDEO_SED13806_16BPP
1445a6c7ad2fSwdenk
14467d3053fbSTimur Tabi		CONFIG_FSL_DIU_FB
14477d3053fbSTimur Tabi		Enable the Freescale DIU video driver.	Reference boards for
14487d3053fbSTimur Tabi		SOCs that have a DIU should define this macro to enable DIU
14497d3053fbSTimur Tabi		support, and should also define these other macros:
14507d3053fbSTimur Tabi
14517d3053fbSTimur Tabi			CONFIG_SYS_DIU_ADDR
14527d3053fbSTimur Tabi			CONFIG_VIDEO
14537d3053fbSTimur Tabi			CONFIG_CMD_BMP
14547d3053fbSTimur Tabi			CONFIG_CFB_CONSOLE
14557d3053fbSTimur Tabi			CONFIG_VIDEO_SW_CURSOR
14567d3053fbSTimur Tabi			CONFIG_VGA_AS_SINGLE_DEVICE
14577d3053fbSTimur Tabi			CONFIG_VIDEO_LOGO
14587d3053fbSTimur Tabi			CONFIG_VIDEO_BMP_LOGO
14597d3053fbSTimur Tabi
1460ba8e76bdSTimur Tabi		The DIU driver will look for the 'video-mode' environment
1461ba8e76bdSTimur Tabi		variable, and if defined, enable the DIU as a console during
1462ba8e76bdSTimur Tabi		boot.  See the documentation file README.video for a
1463ba8e76bdSTimur Tabi		description of this variable.
14647d3053fbSTimur Tabi
1465058d59b0SSimon Glass		CONFIG_VIDEO_VGA
1466058d59b0SSimon Glass
1467058d59b0SSimon Glass		Enable the VGA video / BIOS for x86. The alternative if you
1468058d59b0SSimon Glass		are using coreboot is to use the coreboot frame buffer
1469058d59b0SSimon Glass		driver.
1470058d59b0SSimon Glass
1471058d59b0SSimon Glass
1472682011ffSwdenk- Keyboard Support:
1473682011ffSwdenk		CONFIG_KEYBOARD
1474682011ffSwdenk
1475682011ffSwdenk		Define this to enable a custom keyboard support.
1476682011ffSwdenk		This simply calls drv_keyboard_init() which must be
1477682011ffSwdenk		defined in your board-specific files.
1478682011ffSwdenk		The only board using this so far is RBC823.
1479a6c7ad2fSwdenk
1480c609719bSwdenk- LCD Support:	CONFIG_LCD
1481c609719bSwdenk
1482c609719bSwdenk		Define this to enable LCD support (for output to LCD
1483c609719bSwdenk		display); also select one of the supported displays
1484c609719bSwdenk		by defining one of these:
1485c609719bSwdenk
148639cf4804SStelian Pop		CONFIG_ATMEL_LCD:
148739cf4804SStelian Pop
148839cf4804SStelian Pop			HITACHI TX09D70VM1CCA, 3.5", 240x320.
148939cf4804SStelian Pop
1490fd3103bbSwdenk		CONFIG_NEC_NL6448AC33:
1491c609719bSwdenk
1492fd3103bbSwdenk			NEC NL6448AC33-18. Active, color, single scan.
1493c609719bSwdenk
1494fd3103bbSwdenk		CONFIG_NEC_NL6448BC20
1495c609719bSwdenk
1496fd3103bbSwdenk			NEC NL6448BC20-08. 6.5", 640x480.
1497fd3103bbSwdenk			Active, color, single scan.
1498fd3103bbSwdenk
1499fd3103bbSwdenk		CONFIG_NEC_NL6448BC33_54
1500fd3103bbSwdenk
1501fd3103bbSwdenk			NEC NL6448BC33-54. 10.4", 640x480.
1502c609719bSwdenk			Active, color, single scan.
1503c609719bSwdenk
1504c609719bSwdenk		CONFIG_SHARP_16x9
1505c609719bSwdenk
1506c609719bSwdenk			Sharp 320x240. Active, color, single scan.
1507c609719bSwdenk			It isn't 16x9, and I am not sure what it is.
1508c609719bSwdenk
1509c609719bSwdenk		CONFIG_SHARP_LQ64D341
1510c609719bSwdenk
1511c609719bSwdenk			Sharp LQ64D341 display, 640x480.
1512c609719bSwdenk			Active, color, single scan.
1513c609719bSwdenk
1514c609719bSwdenk		CONFIG_HLD1045
1515c609719bSwdenk
1516c609719bSwdenk			HLD1045 display, 640x480.
1517c609719bSwdenk			Active, color, single scan.
1518c609719bSwdenk
1519c609719bSwdenk		CONFIG_OPTREX_BW
1520c609719bSwdenk
1521c609719bSwdenk			Optrex	 CBL50840-2 NF-FW 99 22 M5
1522c609719bSwdenk			or
1523c609719bSwdenk			Hitachi	 LMG6912RPFC-00T
1524c609719bSwdenk			or
1525c609719bSwdenk			Hitachi	 SP14Q002
1526c609719bSwdenk
1527c609719bSwdenk			320x240. Black & white.
1528c609719bSwdenk
1529c609719bSwdenk		Normally display is black on white background; define
15306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
1531c609719bSwdenk
1532676d319eSSimon Glass		CONFIG_LCD_ALIGNMENT
1533676d319eSSimon Glass
1534676d319eSSimon Glass		Normally the LCD is page-aligned (tyically 4KB). If this is
1535676d319eSSimon Glass		defined then the LCD will be aligned to this value instead.
1536676d319eSSimon Glass		For ARM it is sometimes useful to use MMU_SECTION_SIZE
1537676d319eSSimon Glass		here, since it is cheaper to change data cache settings on
1538676d319eSSimon Glass		a per-section basis.
1539676d319eSSimon Glass
15400d89efefSSimon Glass		CONFIG_CONSOLE_SCROLL_LINES
15410d89efefSSimon Glass
15420d89efefSSimon Glass		When the console need to be scrolled, this is the number of
15430d89efefSSimon Glass		lines to scroll by. It defaults to 1. Increasing this makes
15440d89efefSSimon Glass		the console jump but can help speed up operation when scrolling
15450d89efefSSimon Glass		is slow.
1546676d319eSSimon Glass
154745d7f525STom Wai-Hong Tam		CONFIG_LCD_BMP_RLE8
154845d7f525STom Wai-Hong Tam
154945d7f525STom Wai-Hong Tam		Support drawing of RLE8-compressed bitmaps on the LCD.
155045d7f525STom Wai-Hong Tam
1551735987c5STom Wai-Hong Tam		CONFIG_I2C_EDID
1552735987c5STom Wai-Hong Tam
1553735987c5STom Wai-Hong Tam		Enables an 'i2c edid' command which can read EDID
1554735987c5STom Wai-Hong Tam		information over I2C from an attached LCD display.
1555735987c5STom Wai-Hong Tam
15567152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN
1557d791b1dcSwdenk
1558d791b1dcSwdenk		If this option is set, the environment is checked for
1559d791b1dcSwdenk		a variable "splashimage". If found, the usual display
1560d791b1dcSwdenk		of logo, copyright and system information on the LCD
1561e94d2cd9Swdenk		is suppressed and the BMP image at the address
1562d791b1dcSwdenk		specified in "splashimage" is loaded instead. The
1563d791b1dcSwdenk		console is redirected to the "nulldev", too. This
1564d791b1dcSwdenk		allows for a "silent" boot where a splash screen is
1565d791b1dcSwdenk		loaded very quickly after power-on.
1566d791b1dcSwdenk
1567c0880485SNikita Kiryanov		CONFIG_SPLASHIMAGE_GUARD
1568c0880485SNikita Kiryanov
1569c0880485SNikita Kiryanov		If this option is set, then U-Boot will prevent the environment
1570c0880485SNikita Kiryanov		variable "splashimage" from being set to a problematic address
1571c0880485SNikita Kiryanov		(see README.displaying-bmps and README.arm-unaligned-accesses).
1572c0880485SNikita Kiryanov		This option is useful for targets where, due to alignment
1573c0880485SNikita Kiryanov		restrictions, an improperly aligned BMP image will cause a data
1574c0880485SNikita Kiryanov		abort. If you think you will not have problems with unaligned
1575c0880485SNikita Kiryanov		accesses (for example because your toolchain prevents them)
1576c0880485SNikita Kiryanov		there is no need to set this option.
1577c0880485SNikita Kiryanov
15781ca298ceSMatthias Weisser		CONFIG_SPLASH_SCREEN_ALIGN
15791ca298ceSMatthias Weisser
15801ca298ceSMatthias Weisser		If this option is set the splash image can be freely positioned
15811ca298ceSMatthias Weisser		on the screen. Environment variable "splashpos" specifies the
15821ca298ceSMatthias Weisser		position as "x,y". If a positive number is given it is used as
15831ca298ceSMatthias Weisser		number of pixel from left/top. If a negative number is given it
15841ca298ceSMatthias Weisser		is used as number of pixel from right/bottom. You can also
15851ca298ceSMatthias Weisser		specify 'm' for centering the image.
15861ca298ceSMatthias Weisser
15871ca298ceSMatthias Weisser		Example:
15881ca298ceSMatthias Weisser		setenv splashpos m,m
15891ca298ceSMatthias Weisser			=> image at center of screen
15901ca298ceSMatthias Weisser
15911ca298ceSMatthias Weisser		setenv splashpos 30,20
15921ca298ceSMatthias Weisser			=> image at x = 30 and y = 20
15931ca298ceSMatthias Weisser
15941ca298ceSMatthias Weisser		setenv splashpos -10,m
15951ca298ceSMatthias Weisser			=> vertically centered image
15961ca298ceSMatthias Weisser			   at x = dspWidth - bmpWidth - 9
15971ca298ceSMatthias Weisser
1598581bb419SNikita Kiryanov		CONFIG_SPLASH_SCREEN_PREPARE
1599581bb419SNikita Kiryanov
1600581bb419SNikita Kiryanov		If this option is set then the board_splash_screen_prepare()
1601581bb419SNikita Kiryanov		function, which must be defined in your code, is called as part
1602581bb419SNikita Kiryanov		of the splash screen display sequence. It gives the board an
1603581bb419SNikita Kiryanov		opportunity to prepare the splash image data before it is
1604581bb419SNikita Kiryanov		processed and sent to the frame buffer by U-Boot.
1605581bb419SNikita Kiryanov
160698f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
160798f4a3dfSStefan Roese
160898f4a3dfSStefan Roese		If this option is set, additionally to standard BMP
160998f4a3dfSStefan Roese		images, gzipped BMP images can be displayed via the
161098f4a3dfSStefan Roese		splashscreen support or the bmp command.
161198f4a3dfSStefan Roese
1612d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1613d5011762SAnatolij Gustschin
1614d5011762SAnatolij Gustschin		If this option is set, 8-bit RLE compressed BMP images
1615d5011762SAnatolij Gustschin		can be displayed via the splashscreen support or the
1616d5011762SAnatolij Gustschin		bmp command.
1617d5011762SAnatolij Gustschin
1618f2b96dfbSLei Wen- Do compresssing for memory range:
1619f2b96dfbSLei Wen		CONFIG_CMD_ZIP
1620f2b96dfbSLei Wen
1621f2b96dfbSLei Wen		If this option is set, it would use zlib deflate method
1622f2b96dfbSLei Wen		to compress the specified memory at its best effort.
1623f2b96dfbSLei Wen
1624c29fdfc1Swdenk- Compression support:
1625c29fdfc1Swdenk		CONFIG_BZIP2
1626c29fdfc1Swdenk
1627c29fdfc1Swdenk		If this option is set, support for bzip2 compressed
1628c29fdfc1Swdenk		images is included. If not, only uncompressed and gzip
1629c29fdfc1Swdenk		compressed images are supported.
1630c29fdfc1Swdenk
1631c29fdfc1Swdenk		NOTE: the bzip2 algorithm requires a lot of RAM, so
16326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
1633c29fdfc1Swdenk		be at least 4MB.
1634d791b1dcSwdenk
1635fc9c1727SLuigi 'Comio' Mantellini		CONFIG_LZMA
1636fc9c1727SLuigi 'Comio' Mantellini
1637fc9c1727SLuigi 'Comio' Mantellini		If this option is set, support for lzma compressed
1638fc9c1727SLuigi 'Comio' Mantellini		images is included.
1639fc9c1727SLuigi 'Comio' Mantellini
1640fc9c1727SLuigi 'Comio' Mantellini		Note: The LZMA algorithm adds between 2 and 4KB of code and it
1641fc9c1727SLuigi 'Comio' Mantellini		requires an amount of dynamic memory that is given by the
1642fc9c1727SLuigi 'Comio' Mantellini		formula:
1643fc9c1727SLuigi 'Comio' Mantellini
1644fc9c1727SLuigi 'Comio' Mantellini			(1846 + 768 << (lc + lp)) * sizeof(uint16)
1645fc9c1727SLuigi 'Comio' Mantellini
1646fc9c1727SLuigi 'Comio' Mantellini		Where lc and lp stand for, respectively, Literal context bits
1647fc9c1727SLuigi 'Comio' Mantellini		and Literal pos bits.
1648fc9c1727SLuigi 'Comio' Mantellini
1649fc9c1727SLuigi 'Comio' Mantellini		This value is upper-bounded by 14MB in the worst case. Anyway,
1650fc9c1727SLuigi 'Comio' Mantellini		for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1651fc9c1727SLuigi 'Comio' Mantellini		total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1652fc9c1727SLuigi 'Comio' Mantellini		a very small buffer.
1653fc9c1727SLuigi 'Comio' Mantellini
1654fc9c1727SLuigi 'Comio' Mantellini		Use the lzmainfo tool to determinate the lc and lp values and
1655fc9c1727SLuigi 'Comio' Mantellini		then calculate the amount of needed dynamic memory (ensuring
16566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the appropriate CONFIG_SYS_MALLOC_LEN value).
1657fc9c1727SLuigi 'Comio' Mantellini
165817ea1177Swdenk- MII/PHY support:
165917ea1177Swdenk		CONFIG_PHY_ADDR
166017ea1177Swdenk
166117ea1177Swdenk		The address of PHY on MII bus.
166217ea1177Swdenk
166317ea1177Swdenk		CONFIG_PHY_CLOCK_FREQ (ppc4xx)
166417ea1177Swdenk
166517ea1177Swdenk		The clock frequency of the MII bus
166617ea1177Swdenk
166717ea1177Swdenk		CONFIG_PHY_GIGE
166817ea1177Swdenk
166917ea1177Swdenk		If this option is set, support for speed/duplex
167011ccc33fSMarcel Ziswiler		detection of gigabit PHY is included.
167117ea1177Swdenk
167217ea1177Swdenk		CONFIG_PHY_RESET_DELAY
167317ea1177Swdenk
167417ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
167517ea1177Swdenk		reset before any MII register access is possible.
167617ea1177Swdenk		For such PHY, set this option to the usec delay
167717ea1177Swdenk		required. (minimum 300usec for LXT971A)
167817ea1177Swdenk
167917ea1177Swdenk		CONFIG_PHY_CMD_DELAY (ppc4xx)
168017ea1177Swdenk
168117ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
168217ea1177Swdenk		command issued before MII status register can be read
168317ea1177Swdenk
1684c609719bSwdenk- Ethernet address:
1685c609719bSwdenk		CONFIG_ETHADDR
1686c68a05feSrichardretanubun		CONFIG_ETH1ADDR
1687c609719bSwdenk		CONFIG_ETH2ADDR
1688c609719bSwdenk		CONFIG_ETH3ADDR
1689c68a05feSrichardretanubun		CONFIG_ETH4ADDR
1690c68a05feSrichardretanubun		CONFIG_ETH5ADDR
1691c609719bSwdenk
169211ccc33fSMarcel Ziswiler		Define a default value for Ethernet address to use
169311ccc33fSMarcel Ziswiler		for the respective Ethernet interface, in case this
1694c609719bSwdenk		is not determined automatically.
1695c609719bSwdenk
1696c609719bSwdenk- IP address:
1697c609719bSwdenk		CONFIG_IPADDR
1698c609719bSwdenk
1699c609719bSwdenk		Define a default value for the IP address to use for
170011ccc33fSMarcel Ziswiler		the default Ethernet interface, in case this is not
1701c609719bSwdenk		determined through e.g. bootp.
17021ebcd654SWolfgang Denk		(Environment variable "ipaddr")
1703c609719bSwdenk
1704c609719bSwdenk- Server IP address:
1705c609719bSwdenk		CONFIG_SERVERIP
1706c609719bSwdenk
1707c609719bSwdenk		Defines a default value for the IP address of a TFTP
1708c609719bSwdenk		server to contact when using the "tftboot" command.
17091ebcd654SWolfgang Denk		(Environment variable "serverip")
1710c609719bSwdenk
171197cfe861SRobin Getz		CONFIG_KEEP_SERVERADDR
171297cfe861SRobin Getz
171397cfe861SRobin Getz		Keeps the server's MAC address, in the env 'serveraddr'
171497cfe861SRobin Getz		for passing to bootargs (like Linux's netconsole option)
171597cfe861SRobin Getz
17161ebcd654SWolfgang Denk- Gateway IP address:
17171ebcd654SWolfgang Denk		CONFIG_GATEWAYIP
17181ebcd654SWolfgang Denk
17191ebcd654SWolfgang Denk		Defines a default value for the IP address of the
17201ebcd654SWolfgang Denk		default router where packets to other networks are
17211ebcd654SWolfgang Denk		sent to.
17221ebcd654SWolfgang Denk		(Environment variable "gatewayip")
17231ebcd654SWolfgang Denk
17241ebcd654SWolfgang Denk- Subnet mask:
17251ebcd654SWolfgang Denk		CONFIG_NETMASK
17261ebcd654SWolfgang Denk
17271ebcd654SWolfgang Denk		Defines a default value for the subnet mask (or
17281ebcd654SWolfgang Denk		routing prefix) which is used to determine if an IP
17291ebcd654SWolfgang Denk		address belongs to the local subnet or needs to be
17301ebcd654SWolfgang Denk		forwarded through a router.
17311ebcd654SWolfgang Denk		(Environment variable "netmask")
17321ebcd654SWolfgang Denk
173353a5c424SDavid Updegraff- Multicast TFTP Mode:
173453a5c424SDavid Updegraff		CONFIG_MCAST_TFTP
173553a5c424SDavid Updegraff
173653a5c424SDavid Updegraff		Defines whether you want to support multicast TFTP as per
173753a5c424SDavid Updegraff		rfc-2090; for example to work with atftp.  Lets lots of targets
173811ccc33fSMarcel Ziswiler		tftp down the same boot image concurrently.  Note: the Ethernet
173953a5c424SDavid Updegraff		driver in use must provide a function: mcast() to join/leave a
174053a5c424SDavid Updegraff		multicast group.
174153a5c424SDavid Updegraff
1742c609719bSwdenk- BOOTP Recovery Mode:
1743c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY
1744c609719bSwdenk
1745c609719bSwdenk		If you have many targets in a network that try to
1746c609719bSwdenk		boot using BOOTP, you may want to avoid that all
1747c609719bSwdenk		systems send out BOOTP requests at precisely the same
1748c609719bSwdenk		moment (which would happen for instance at recovery
1749c609719bSwdenk		from a power failure, when all systems will try to
1750c609719bSwdenk		boot, thus flooding the BOOTP server. Defining
1751c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1752c609719bSwdenk		inserted before sending out BOOTP requests. The
17536c33c785SWolfgang Denk		following delays are inserted then:
1754c609719bSwdenk
1755c609719bSwdenk		1st BOOTP request:	delay 0 ... 1 sec
1756c609719bSwdenk		2nd BOOTP request:	delay 0 ... 2 sec
1757c609719bSwdenk		3rd BOOTP request:	delay 0 ... 4 sec
1758c609719bSwdenk		4th and following
1759c609719bSwdenk		BOOTP requests:		delay 0 ... 8 sec
1760c609719bSwdenk
1761fe389a82Sstroese- DHCP Advanced Options:
17621fe80d79SJon Loeliger		You can fine tune the DHCP functionality by defining
17631fe80d79SJon Loeliger		CONFIG_BOOTP_* symbols:
1764fe389a82Sstroese
17651fe80d79SJon Loeliger		CONFIG_BOOTP_SUBNETMASK
17661fe80d79SJon Loeliger		CONFIG_BOOTP_GATEWAY
17671fe80d79SJon Loeliger		CONFIG_BOOTP_HOSTNAME
17681fe80d79SJon Loeliger		CONFIG_BOOTP_NISDOMAIN
17691fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTPATH
17701fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTFILESIZE
17711fe80d79SJon Loeliger		CONFIG_BOOTP_DNS
17721fe80d79SJon Loeliger		CONFIG_BOOTP_DNS2
17731fe80d79SJon Loeliger		CONFIG_BOOTP_SEND_HOSTNAME
17741fe80d79SJon Loeliger		CONFIG_BOOTP_NTPSERVER
17751fe80d79SJon Loeliger		CONFIG_BOOTP_TIMEOFFSET
17761fe80d79SJon Loeliger		CONFIG_BOOTP_VENDOREX
17772c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL
1778fe389a82Sstroese
17795d110f0aSWilson Callan		CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
17805d110f0aSWilson Callan		environment variable, not the BOOTP server.
1781fe389a82Sstroese
17822c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
17832c00e099SJoe Hershberger		after the configured retry count, the call will fail
17842c00e099SJoe Hershberger		instead of starting over.  This can be used to fail over
17852c00e099SJoe Hershberger		to Link-local IP address configuration if the DHCP server
17862c00e099SJoe Hershberger		is not available.
17872c00e099SJoe Hershberger
1788fe389a82Sstroese		CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1789fe389a82Sstroese		serverip from a DHCP server, it is possible that more
1790fe389a82Sstroese		than one DNS serverip is offered to the client.
1791fe389a82Sstroese		If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1792fe389a82Sstroese		serverip will be stored in the additional environment
1793fe389a82Sstroese		variable "dnsip2". The first DNS serverip is always
1794fe389a82Sstroese		stored in the variable "dnsip", when CONFIG_BOOTP_DNS
17951fe80d79SJon Loeliger		is defined.
1796fe389a82Sstroese
1797fe389a82Sstroese		CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1798fe389a82Sstroese		to do a dynamic update of a DNS server. To do this, they
1799fe389a82Sstroese		need the hostname of the DHCP requester.
18005d110f0aSWilson Callan		If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
18011fe80d79SJon Loeliger		of the "hostname" environment variable is passed as
18021fe80d79SJon Loeliger		option 12 to the DHCP server.
1803fe389a82Sstroese
1804d9a2f416SAras Vaichas		CONFIG_BOOTP_DHCP_REQUEST_DELAY
1805d9a2f416SAras Vaichas
1806d9a2f416SAras Vaichas		A 32bit value in microseconds for a delay between
1807d9a2f416SAras Vaichas		receiving a "DHCP Offer" and sending the "DHCP Request".
1808d9a2f416SAras Vaichas		This fixes a problem with certain DHCP servers that don't
1809d9a2f416SAras Vaichas		respond 100% of the time to a "DHCP request". E.g. On an
1810d9a2f416SAras Vaichas		AT91RM9200 processor running at 180MHz, this delay needed
1811d9a2f416SAras Vaichas		to be *at least* 15,000 usec before a Windows Server 2003
1812d9a2f416SAras Vaichas		DHCP server would reply 100% of the time. I recommend at
1813d9a2f416SAras Vaichas		least 50,000 usec to be safe. The alternative is to hope
1814d9a2f416SAras Vaichas		that one of the retries will be successful but note that
1815d9a2f416SAras Vaichas		the DHCP timeout and retry process takes a longer than
1816d9a2f416SAras Vaichas		this delay.
1817d9a2f416SAras Vaichas
1818d22c338eSJoe Hershberger - Link-local IP address negotiation:
1819d22c338eSJoe Hershberger		Negotiate with other link-local clients on the local network
1820d22c338eSJoe Hershberger		for an address that doesn't require explicit configuration.
1821d22c338eSJoe Hershberger		This is especially useful if a DHCP server cannot be guaranteed
1822d22c338eSJoe Hershberger		to exist in all environments that the device must operate.
1823d22c338eSJoe Hershberger
1824d22c338eSJoe Hershberger		See doc/README.link-local for more information.
1825d22c338eSJoe Hershberger
1826a3d991bdSwdenk - CDP Options:
1827a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID
1828a3d991bdSwdenk
1829a3d991bdSwdenk		The device id used in CDP trigger frames.
1830a3d991bdSwdenk
1831a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID_PREFIX
1832a3d991bdSwdenk
1833a3d991bdSwdenk		A two character string which is prefixed to the MAC address
1834a3d991bdSwdenk		of the device.
1835a3d991bdSwdenk
1836a3d991bdSwdenk		CONFIG_CDP_PORT_ID
1837a3d991bdSwdenk
1838a3d991bdSwdenk		A printf format string which contains the ascii name of
1839a3d991bdSwdenk		the port. Normally is set to "eth%d" which sets
184011ccc33fSMarcel Ziswiler		eth0 for the first Ethernet, eth1 for the second etc.
1841a3d991bdSwdenk
1842a3d991bdSwdenk		CONFIG_CDP_CAPABILITIES
1843a3d991bdSwdenk
1844a3d991bdSwdenk		A 32bit integer which indicates the device capabilities;
1845a3d991bdSwdenk		0x00000010 for a normal host which does not forwards.
1846a3d991bdSwdenk
1847a3d991bdSwdenk		CONFIG_CDP_VERSION
1848a3d991bdSwdenk
1849a3d991bdSwdenk		An ascii string containing the version of the software.
1850a3d991bdSwdenk
1851a3d991bdSwdenk		CONFIG_CDP_PLATFORM
1852a3d991bdSwdenk
1853a3d991bdSwdenk		An ascii string containing the name of the platform.
1854a3d991bdSwdenk
1855a3d991bdSwdenk		CONFIG_CDP_TRIGGER
1856a3d991bdSwdenk
1857a3d991bdSwdenk		A 32bit integer sent on the trigger.
1858a3d991bdSwdenk
1859a3d991bdSwdenk		CONFIG_CDP_POWER_CONSUMPTION
1860a3d991bdSwdenk
1861a3d991bdSwdenk		A 16bit integer containing the power consumption of the
1862a3d991bdSwdenk		device in .1 of milliwatts.
1863a3d991bdSwdenk
1864a3d991bdSwdenk		CONFIG_CDP_APPLIANCE_VLAN_TYPE
1865a3d991bdSwdenk
1866a3d991bdSwdenk		A byte containing the id of the VLAN.
1867a3d991bdSwdenk
1868c609719bSwdenk- Status LED:	CONFIG_STATUS_LED
1869c609719bSwdenk
1870c609719bSwdenk		Several configurations allow to display the current
1871c609719bSwdenk		status using a LED. For instance, the LED will blink
1872c609719bSwdenk		fast while running U-Boot code, stop blinking as
1873c609719bSwdenk		soon as a reply to a BOOTP request was received, and
1874c609719bSwdenk		start blinking slow once the Linux kernel is running
1875c609719bSwdenk		(supported by a status LED driver in the Linux
1876c609719bSwdenk		kernel). Defining CONFIG_STATUS_LED enables this
1877c609719bSwdenk		feature in U-Boot.
1878c609719bSwdenk
1879c609719bSwdenk- CAN Support:	CONFIG_CAN_DRIVER
1880c609719bSwdenk
1881c609719bSwdenk		Defining CONFIG_CAN_DRIVER enables CAN driver support
1882c609719bSwdenk		on those systems that support this (optional)
1883c609719bSwdenk		feature, like the TQM8xxL modules.
1884c609719bSwdenk
1885c609719bSwdenk- I2C Support:	CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1886c609719bSwdenk
1887b37c7e5eSwdenk		These enable I2C serial bus commands. Defining either of
1888b37c7e5eSwdenk		(but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
188911ccc33fSMarcel Ziswiler		include the appropriate I2C driver for the selected CPU.
1890c609719bSwdenk
1891b37c7e5eSwdenk		This will allow you to use i2c commands at the u-boot
1892602ad3b3SJon Loeliger		command line (as long as you set CONFIG_CMD_I2C in
1893b37c7e5eSwdenk		CONFIG_COMMANDS) and communicate with i2c based realtime
1894b37c7e5eSwdenk		clock chips. See common/cmd_i2c.c for a description of the
1895c609719bSwdenk		command line interface.
1896c609719bSwdenk
1897bb99ad6dSBen Warren		CONFIG_HARD_I2C selects a hardware I2C controller.
1898c609719bSwdenk
1899b37c7e5eSwdenk		CONFIG_SOFT_I2C configures u-boot to use a software (aka
1900b37c7e5eSwdenk		bit-banging) driver instead of CPM or similar hardware
1901b37c7e5eSwdenk		support for I2C.
1902c609719bSwdenk
1903b37c7e5eSwdenk		There are several other quantities that must also be
1904b37c7e5eSwdenk		defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
1905c609719bSwdenk
19066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		In both cases you will need to define CONFIG_SYS_I2C_SPEED
1907b37c7e5eSwdenk		to be the frequency (in Hz) at which you wish your i2c bus
19086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
190911ccc33fSMarcel Ziswiler		the CPU's i2c node address).
1910c609719bSwdenk
19118d321b81SPeter Tyser		Now, the u-boot i2c code for the mpc8xx
1912a47a12beSStefan Roese		(arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
19138d321b81SPeter Tyser		and so its address should therefore be cleared to 0 (See,
19148d321b81SPeter Tyser		eg, MPC823e User's Manual p.16-473). So, set
19158d321b81SPeter Tyser		CONFIG_SYS_I2C_SLAVE to 0.
1916b37c7e5eSwdenk
19175da71efaSEric Millbrandt		CONFIG_SYS_I2C_INIT_MPC5XXX
19185da71efaSEric Millbrandt
19195da71efaSEric Millbrandt		When a board is reset during an i2c bus transfer
19205da71efaSEric Millbrandt		chips might think that the current transfer is still
19215da71efaSEric Millbrandt		in progress.  Reset the slave devices by sending start
19225da71efaSEric Millbrandt		commands until the slave device responds.
19235da71efaSEric Millbrandt
1924b37c7e5eSwdenk		That's all that's required for CONFIG_HARD_I2C.
1925b37c7e5eSwdenk
1926b37c7e5eSwdenk		If you use the software i2c interface (CONFIG_SOFT_I2C)
1927b37c7e5eSwdenk		then the following macros need to be defined (examples are
1928b37c7e5eSwdenk		from include/configs/lwmon.h):
1929c609719bSwdenk
1930c609719bSwdenk		I2C_INIT
1931c609719bSwdenk
1932b37c7e5eSwdenk		(Optional). Any commands necessary to enable the I2C
1933c609719bSwdenk		controller or configure ports.
1934c609719bSwdenk
1935b37c7e5eSwdenk		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
1936b37c7e5eSwdenk
1937c609719bSwdenk		I2C_PORT
1938c609719bSwdenk
1939c609719bSwdenk		(Only for MPC8260 CPU). The I/O port to use (the code
1940c609719bSwdenk		assumes both bits are on the same port). Valid values
1941c609719bSwdenk		are 0..3 for ports A..D.
1942c609719bSwdenk
1943c609719bSwdenk		I2C_ACTIVE
1944c609719bSwdenk
1945c609719bSwdenk		The code necessary to make the I2C data line active
1946c609719bSwdenk		(driven).  If the data line is open collector, this
1947c609719bSwdenk		define can be null.
1948c609719bSwdenk
1949b37c7e5eSwdenk		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
1950b37c7e5eSwdenk
1951c609719bSwdenk		I2C_TRISTATE
1952c609719bSwdenk
1953c609719bSwdenk		The code necessary to make the I2C data line tri-stated
1954c609719bSwdenk		(inactive).  If the data line is open collector, this
1955c609719bSwdenk		define can be null.
1956c609719bSwdenk
1957b37c7e5eSwdenk		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1958b37c7e5eSwdenk
1959c609719bSwdenk		I2C_READ
1960c609719bSwdenk
1961472d5460SYork Sun		Code that returns true if the I2C data line is high,
1962472d5460SYork Sun		false if it is low.
1963c609719bSwdenk
1964b37c7e5eSwdenk		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1965b37c7e5eSwdenk
1966c609719bSwdenk		I2C_SDA(bit)
1967c609719bSwdenk
1968472d5460SYork Sun		If <bit> is true, sets the I2C data line high. If it
1969472d5460SYork Sun		is false, it clears it (low).
1970c609719bSwdenk
1971b37c7e5eSwdenk		eg: #define I2C_SDA(bit) \
1972b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
1973b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
1974b37c7e5eSwdenk
1975c609719bSwdenk		I2C_SCL(bit)
1976c609719bSwdenk
1977472d5460SYork Sun		If <bit> is true, sets the I2C clock line high. If it
1978472d5460SYork Sun		is false, it clears it (low).
1979c609719bSwdenk
1980b37c7e5eSwdenk		eg: #define I2C_SCL(bit) \
1981b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
1982b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
1983b37c7e5eSwdenk
1984c609719bSwdenk		I2C_DELAY
1985c609719bSwdenk
1986c609719bSwdenk		This delay is invoked four times per clock cycle so this
1987c609719bSwdenk		controls the rate of data transfer.  The data rate thus
1988b37c7e5eSwdenk		is 1 / (I2C_DELAY * 4). Often defined to be something
1989b37c7e5eSwdenk		like:
1990b37c7e5eSwdenk
1991b37c7e5eSwdenk		#define I2C_DELAY  udelay(2)
1992c609719bSwdenk
1993793b5726SMike Frysinger		CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1994793b5726SMike Frysinger
1995793b5726SMike Frysinger		If your arch supports the generic GPIO framework (asm/gpio.h),
1996793b5726SMike Frysinger		then you may alternatively define the two GPIOs that are to be
1997793b5726SMike Frysinger		used as SCL / SDA.  Any of the previous I2C_xxx macros will
1998793b5726SMike Frysinger		have GPIO-based defaults assigned to them as appropriate.
1999793b5726SMike Frysinger
2000793b5726SMike Frysinger		You should define these to the GPIO value as given directly to
2001793b5726SMike Frysinger		the generic GPIO functions.
2002793b5726SMike Frysinger
20036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_INIT_BOARD
200447cd00faSwdenk
200547cd00faSwdenk		When a board is reset during an i2c bus transfer
200647cd00faSwdenk		chips might think that the current transfer is still
200747cd00faSwdenk		in progress. On some boards it is possible to access
200847cd00faSwdenk		the i2c SCLK line directly, either by using the
200947cd00faSwdenk		processor pin as a GPIO or by having a second pin
201047cd00faSwdenk		connected to the bus. If this option is defined a
201147cd00faSwdenk		custom i2c_init_board() routine in boards/xxx/board.c
201247cd00faSwdenk		is run early in the boot sequence.
201347cd00faSwdenk
201426a33504SRichard Retanubun		CONFIG_SYS_I2C_BOARD_LATE_INIT
201526a33504SRichard Retanubun
201626a33504SRichard Retanubun		An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
201726a33504SRichard Retanubun		defined a custom i2c_board_late_init() routine in
201826a33504SRichard Retanubun		boards/xxx/board.c is run AFTER the operations in i2c_init()
201926a33504SRichard Retanubun		is completed. This callpoint can be used to unreset i2c bus
202026a33504SRichard Retanubun		using CPU i2c controller register accesses for CPUs whose i2c
202126a33504SRichard Retanubun		controller provide such a method. It is called at the end of
202226a33504SRichard Retanubun		i2c_init() to allow i2c_init operations to setup the i2c bus
202326a33504SRichard Retanubun		controller on the CPU (e.g. setting bus speed & slave address).
202426a33504SRichard Retanubun
202517ea1177Swdenk		CONFIG_I2CFAST (PPC405GP|PPC405EP only)
202617ea1177Swdenk
202717ea1177Swdenk		This option enables configuration of bi_iic_fast[] flags
202817ea1177Swdenk		in u-boot bd_info structure based on u-boot environment
202917ea1177Swdenk		variable "i2cfast". (see also i2cfast)
203017ea1177Swdenk
2031bb99ad6dSBen Warren		CONFIG_I2C_MULTI_BUS
2032bb99ad6dSBen Warren
2033bb99ad6dSBen Warren		This option allows the use of multiple I2C buses, each of which
2034bb99ad6dSBen Warren		must have a controller.	 At any point in time, only one bus is
2035bb99ad6dSBen Warren		active.	 To switch to a different bus, use the 'i2c dev' command.
2036bb99ad6dSBen Warren		Note that bus numbering is zero-based.
2037bb99ad6dSBen Warren
20386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_NOPROBES
2039bb99ad6dSBen Warren
2040bb99ad6dSBen Warren		This option specifies a list of I2C devices that will be skipped
20410f89c54bSPeter Tyser		when the 'i2c probe' command is issued.	 If CONFIG_I2C_MULTI_BUS
20420f89c54bSPeter Tyser		is set, specify a list of bus-device pairs.  Otherwise, specify
20430f89c54bSPeter Tyser		a 1D array of device addresses
2044bb99ad6dSBen Warren
2045bb99ad6dSBen Warren		e.g.
2046bb99ad6dSBen Warren			#undef	CONFIG_I2C_MULTI_BUS
20476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
2048bb99ad6dSBen Warren
2049bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on a board with one I2C bus
2050bb99ad6dSBen Warren
2051bb99ad6dSBen Warren			#define CONFIG_I2C_MULTI_BUS
20526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_MULTI_NOPROBES	{{0,0x50},{0,0x68},{1,0x54}}
2053bb99ad6dSBen Warren
2054bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2055bb99ad6dSBen Warren
20566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SPD_BUS_NUM
2057be5e6181STimur Tabi
2058be5e6181STimur Tabi		If defined, then this indicates the I2C bus number for DDR SPD.
2059be5e6181STimur Tabi		If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2060be5e6181STimur Tabi
20616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_BUS_NUM
20620dc018ecSStefan Roese
20630dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the RTC.
20640dc018ecSStefan Roese		If not defined, then U-Boot assumes that RTC is on I2C bus 0.
20650dc018ecSStefan Roese
20666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_DTT_BUS_NUM
20670dc018ecSStefan Roese
20680dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the DTT.
20690dc018ecSStefan Roese		If not defined, then U-Boot assumes that DTT is on I2C bus 0.
20700dc018ecSStefan Roese
20716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_DTT_ADDR:
20729ebbb54fSVictor Gallardo
20739ebbb54fSVictor Gallardo		If defined, specifies the I2C address of the DTT device.
20749ebbb54fSVictor Gallardo		If not defined, then U-Boot uses predefined value for
20759ebbb54fSVictor Gallardo		specified DTT device.
20769ebbb54fSVictor Gallardo
2077be5e6181STimur Tabi		CONFIG_FSL_I2C
2078be5e6181STimur Tabi
2079be5e6181STimur Tabi		Define this option if you want to use Freescale's I2C driver in
20807817cb20SMarcel Ziswiler		drivers/i2c/fsl_i2c.c.
2081be5e6181STimur Tabi
208267b23a32SHeiko Schocher		CONFIG_I2C_MUX
208367b23a32SHeiko Schocher
208467b23a32SHeiko Schocher		Define this option if you have I2C devices reached over 1 .. n
208567b23a32SHeiko Schocher		I2C Muxes like the pca9544a. This option addes a new I2C
208667b23a32SHeiko Schocher		Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
208767b23a32SHeiko Schocher		new I2C Bus to the existing I2C Busses. If you select the
208867b23a32SHeiko Schocher		new Bus with "i2c dev", u-bbot sends first the commandos for
208967b23a32SHeiko Schocher		the muxes to activate this new "bus".
209067b23a32SHeiko Schocher
209167b23a32SHeiko Schocher		CONFIG_I2C_MULTI_BUS must be also defined, to use this
209267b23a32SHeiko Schocher		feature!
209367b23a32SHeiko Schocher
209467b23a32SHeiko Schocher		Example:
209567b23a32SHeiko Schocher		Adding a new I2C Bus reached over 2 pca9544a muxes
209667b23a32SHeiko Schocher			The First mux with address 70 and channel 6
209767b23a32SHeiko Schocher			The Second mux with address 71 and channel 4
209867b23a32SHeiko Schocher
209967b23a32SHeiko Schocher		=> i2c bus pca9544a:70:6:pca9544a:71:4
210067b23a32SHeiko Schocher
210167b23a32SHeiko Schocher		Use the "i2c bus" command without parameter, to get a list
210267b23a32SHeiko Schocher		of I2C Busses with muxes:
210367b23a32SHeiko Schocher
210467b23a32SHeiko Schocher		=> i2c bus
210567b23a32SHeiko Schocher		Busses reached over muxes:
210667b23a32SHeiko Schocher		Bus ID: 2
210767b23a32SHeiko Schocher		  reached over Mux(es):
210867b23a32SHeiko Schocher		    pca9544a@70 ch: 4
210967b23a32SHeiko Schocher		Bus ID: 3
211067b23a32SHeiko Schocher		  reached over Mux(es):
211167b23a32SHeiko Schocher		    pca9544a@70 ch: 6
211267b23a32SHeiko Schocher		    pca9544a@71 ch: 4
211367b23a32SHeiko Schocher		=>
211467b23a32SHeiko Schocher
211567b23a32SHeiko Schocher		If you now switch to the new I2C Bus 3 with "i2c dev 3"
2116f9a78b8dSMichael Jones		u-boot first sends the command to the mux@70 to enable
2117f9a78b8dSMichael Jones		channel 6, and then the command to the mux@71 to enable
211867b23a32SHeiko Schocher		the channel 4.
211967b23a32SHeiko Schocher
212067b23a32SHeiko Schocher		After that, you can use the "normal" i2c commands as
2121f9a78b8dSMichael Jones		usual to communicate with your I2C devices behind
212267b23a32SHeiko Schocher		the 2 muxes.
212367b23a32SHeiko Schocher
212467b23a32SHeiko Schocher		This option is actually implemented for the bitbanging
212567b23a32SHeiko Schocher		algorithm in common/soft_i2c.c and for the Hardware I2C
212667b23a32SHeiko Schocher		Bus on the MPC8260. But it should be not so difficult
212767b23a32SHeiko Schocher		to add this option to other architectures.
212867b23a32SHeiko Schocher
21292ac6985aSAndrew Dyer		CONFIG_SOFT_I2C_READ_REPEATED_START
21302ac6985aSAndrew Dyer
21312ac6985aSAndrew Dyer		defining this will force the i2c_read() function in
21322ac6985aSAndrew Dyer		the soft_i2c driver to perform an I2C repeated start
21332ac6985aSAndrew Dyer		between writing the address pointer and reading the
21342ac6985aSAndrew Dyer		data.  If this define is omitted the default behaviour
21352ac6985aSAndrew Dyer		of doing a stop-start sequence will be used.  Most I2C
21362ac6985aSAndrew Dyer		devices can use either method, but some require one or
21372ac6985aSAndrew Dyer		the other.
2138be5e6181STimur Tabi
2139c609719bSwdenk- SPI Support:	CONFIG_SPI
2140c609719bSwdenk
2141c609719bSwdenk		Enables SPI driver (so far only tested with
2142c609719bSwdenk		SPI EEPROM, also an instance works with Crystal A/D and
2143c609719bSwdenk		D/As on the SACSng board)
2144c609719bSwdenk
21456639562eSYoshihiro Shimoda		CONFIG_SH_SPI
21466639562eSYoshihiro Shimoda
21476639562eSYoshihiro Shimoda		Enables the driver for SPI controller on SuperH. Currently
21486639562eSYoshihiro Shimoda		only SH7757 is supported.
21496639562eSYoshihiro Shimoda
2150c609719bSwdenk		CONFIG_SPI_X
2151c609719bSwdenk
2152c609719bSwdenk		Enables extended (16-bit) SPI EEPROM addressing.
2153c609719bSwdenk		(symmetrical to CONFIG_I2C_X)
2154c609719bSwdenk
2155c609719bSwdenk		CONFIG_SOFT_SPI
2156c609719bSwdenk
2157c609719bSwdenk		Enables a software (bit-bang) SPI driver rather than
2158c609719bSwdenk		using hardware support. This is a general purpose
2159c609719bSwdenk		driver that only requires three general I/O port pins
2160c609719bSwdenk		(two outputs, one input) to function. If this is
2161c609719bSwdenk		defined, the board configuration must define several
2162c609719bSwdenk		SPI configuration items (port pins to use, etc). For
2163c609719bSwdenk		an example, see include/configs/sacsng.h.
2164c609719bSwdenk
216504a9e118SBen Warren		CONFIG_HARD_SPI
216604a9e118SBen Warren
216704a9e118SBen Warren		Enables a hardware SPI driver for general-purpose reads
216804a9e118SBen Warren		and writes.  As with CONFIG_SOFT_SPI, the board configuration
216904a9e118SBen Warren		must define a list of chip-select function pointers.
217004a9e118SBen Warren		Currently supported on some MPC8xxx processors.	 For an
217104a9e118SBen Warren		example, see include/configs/mpc8349emds.h.
217204a9e118SBen Warren
217338254f45SGuennadi Liakhovetski		CONFIG_MXC_SPI
217438254f45SGuennadi Liakhovetski
217538254f45SGuennadi Liakhovetski		Enables the driver for the SPI controllers on i.MX and MXC
21762e3cd1cdSFabio Estevam		SoCs. Currently i.MX31/35/51 are supported.
217738254f45SGuennadi Liakhovetski
21780133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA
21790133502eSMatthias Fuchs
21800133502eSMatthias Fuchs		Enables FPGA subsystem.
21810133502eSMatthias Fuchs
21820133502eSMatthias Fuchs		CONFIG_FPGA_<vendor>
21830133502eSMatthias Fuchs
21840133502eSMatthias Fuchs		Enables support for specific chip vendors.
21850133502eSMatthias Fuchs		(ALTERA, XILINX)
21860133502eSMatthias Fuchs
21870133502eSMatthias Fuchs		CONFIG_FPGA_<family>
21880133502eSMatthias Fuchs
21890133502eSMatthias Fuchs		Enables support for FPGA family.
21900133502eSMatthias Fuchs		(SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
21910133502eSMatthias Fuchs
21920133502eSMatthias Fuchs		CONFIG_FPGA_COUNT
2193c609719bSwdenk
2194c609719bSwdenk		Specify the number of FPGA devices to support.
2195c609719bSwdenk
21966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_PROG_FEEDBACK
2197c609719bSwdenk
2198c609719bSwdenk		Enable printing of hash marks during FPGA configuration.
2199c609719bSwdenk
22006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_BUSY
2201c609719bSwdenk
2202c609719bSwdenk		Enable checks on FPGA configuration interface busy
2203c609719bSwdenk		status by the configuration function. This option
2204c609719bSwdenk		will require a board or device specific function to
2205c609719bSwdenk		be written.
2206c609719bSwdenk
2207c609719bSwdenk		CONFIG_FPGA_DELAY
2208c609719bSwdenk
2209c609719bSwdenk		If defined, a function that provides delays in the FPGA
2210c609719bSwdenk		configuration driver.
2211c609719bSwdenk
22126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_CTRLC
2213c609719bSwdenk		Allow Control-C to interrupt FPGA configuration
2214c609719bSwdenk
22156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_ERROR
2216c609719bSwdenk
2217c609719bSwdenk		Check for configuration errors during FPGA bitfile
2218c609719bSwdenk		loading. For example, abort during Virtex II
2219c609719bSwdenk		configuration if the INIT_B line goes low (which
2220c609719bSwdenk		indicated a CRC error).
2221c609719bSwdenk
22226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_INIT
2223c609719bSwdenk
2224c609719bSwdenk		Maximum time to wait for the INIT_B line to deassert
2225c609719bSwdenk		after PROB_B has been deasserted during a Virtex II
2226c609719bSwdenk		FPGA configuration sequence. The default time is 500
222711ccc33fSMarcel Ziswiler		ms.
2228c609719bSwdenk
22296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_BUSY
2230c609719bSwdenk
2231c609719bSwdenk		Maximum time to wait for BUSY to deassert during
223211ccc33fSMarcel Ziswiler		Virtex II FPGA configuration. The default is 5 ms.
2233c609719bSwdenk
22346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_CONFIG
2235c609719bSwdenk
2236c609719bSwdenk		Time to wait after FPGA configuration. The default is
223711ccc33fSMarcel Ziswiler		200 ms.
2238c609719bSwdenk
2239c609719bSwdenk- Configuration Management:
2240c609719bSwdenk		CONFIG_IDENT_STRING
2241c609719bSwdenk
2242c609719bSwdenk		If defined, this string will be added to the U-Boot
2243c609719bSwdenk		version information (U_BOOT_VERSION)
2244c609719bSwdenk
2245c609719bSwdenk- Vendor Parameter Protection:
2246c609719bSwdenk
2247c609719bSwdenk		U-Boot considers the values of the environment
2248c609719bSwdenk		variables "serial#" (Board Serial Number) and
22497152b1d0Swdenk		"ethaddr" (Ethernet Address) to be parameters that
2250c609719bSwdenk		are set once by the board vendor / manufacturer, and
2251c609719bSwdenk		protects these variables from casual modification by
2252c609719bSwdenk		the user. Once set, these variables are read-only,
2253c609719bSwdenk		and write or delete attempts are rejected. You can
225411ccc33fSMarcel Ziswiler		change this behaviour:
2255c609719bSwdenk
2256c609719bSwdenk		If CONFIG_ENV_OVERWRITE is #defined in your config
2257c609719bSwdenk		file, the write protection for vendor parameters is
225847cd00faSwdenk		completely disabled. Anybody can change or delete
2259c609719bSwdenk		these parameters.
2260c609719bSwdenk
2261c609719bSwdenk		Alternatively, if you #define _both_ CONFIG_ETHADDR
2262c609719bSwdenk		_and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
226311ccc33fSMarcel Ziswiler		Ethernet address is installed in the environment,
2264c609719bSwdenk		which can be changed exactly ONCE by the user. [The
2265c609719bSwdenk		serial# is unaffected by this, i. e. it remains
2266c609719bSwdenk		read-only.]
2267c609719bSwdenk
22682598090bSJoe Hershberger		The same can be accomplished in a more flexible way
22692598090bSJoe Hershberger		for any variable by configuring the type of access
22702598090bSJoe Hershberger		to allow for those variables in the ".flags" variable
22712598090bSJoe Hershberger		or define CONFIG_ENV_FLAGS_LIST_STATIC.
22722598090bSJoe Hershberger
2273c609719bSwdenk- Protected RAM:
2274c609719bSwdenk		CONFIG_PRAM
2275c609719bSwdenk
2276c609719bSwdenk		Define this variable to enable the reservation of
2277c609719bSwdenk		"protected RAM", i. e. RAM which is not overwritten
2278c609719bSwdenk		by U-Boot. Define CONFIG_PRAM to hold the number of
2279c609719bSwdenk		kB you want to reserve for pRAM. You can overwrite
2280c609719bSwdenk		this default value by defining an environment
2281c609719bSwdenk		variable "pram" to the number of kB you want to
2282c609719bSwdenk		reserve. Note that the board info structure will
2283c609719bSwdenk		still show the full amount of RAM. If pRAM is
2284c609719bSwdenk		reserved, a new environment variable "mem" will
2285c609719bSwdenk		automatically be defined to hold the amount of
2286c609719bSwdenk		remaining RAM in a form that can be passed as boot
2287c609719bSwdenk		argument to Linux, for instance like that:
2288c609719bSwdenk
2289fe126d8bSWolfgang Denk			setenv bootargs ... mem=\${mem}
2290c609719bSwdenk			saveenv
2291c609719bSwdenk
2292c609719bSwdenk		This way you can tell Linux not to use this memory,
2293c609719bSwdenk		either, which results in a memory region that will
2294c609719bSwdenk		not be affected by reboots.
2295c609719bSwdenk
2296c609719bSwdenk		*WARNING* If your board configuration uses automatic
2297c609719bSwdenk		detection of the RAM size, you must make sure that
2298c609719bSwdenk		this memory test is non-destructive. So far, the
2299c609719bSwdenk		following board configurations are known to be
2300c609719bSwdenk		"pRAM-clean":
2301c609719bSwdenk
23021b0757ecSWolfgang Denk			IVMS8, IVML24, SPD8xx, TQM8xxL,
23031b0757ecSWolfgang Denk			HERMES, IP860, RPXlite, LWMON,
2304544d97e9SWolfgang Denk			FLAGADM, TQM8260
2305c609719bSwdenk
230640fef049SGabe Black- Access to physical memory region (> 4GB)
230740fef049SGabe Black		Some basic support is provided for operations on memory not
230840fef049SGabe Black		normally accessible to U-Boot - e.g. some architectures
230940fef049SGabe Black		support access to more than 4GB of memory on 32-bit
231040fef049SGabe Black		machines using physical address extension or similar.
231140fef049SGabe Black		Define CONFIG_PHYSMEM to access this basic support, which
231240fef049SGabe Black		currently only supports clearing the memory.
231340fef049SGabe Black
2314c609719bSwdenk- Error Recovery:
2315c609719bSwdenk		CONFIG_PANIC_HANG
2316c609719bSwdenk
2317c609719bSwdenk		Define this variable to stop the system in case of a
2318c609719bSwdenk		fatal error, so that you have to reset it manually.
2319c609719bSwdenk		This is probably NOT a good idea for an embedded
232011ccc33fSMarcel Ziswiler		system where you want the system to reboot
2321c609719bSwdenk		automatically as fast as possible, but it may be
2322c609719bSwdenk		useful during development since you can try to debug
2323c609719bSwdenk		the conditions that lead to the situation.
2324c609719bSwdenk
2325c609719bSwdenk		CONFIG_NET_RETRY_COUNT
2326c609719bSwdenk
2327c609719bSwdenk		This variable defines the number of retries for
2328c609719bSwdenk		network operations like ARP, RARP, TFTP, or BOOTP
2329c609719bSwdenk		before giving up the operation. If not defined, a
2330c609719bSwdenk		default value of 5 is used.
2331c609719bSwdenk
233240cb90eeSGuennadi Liakhovetski		CONFIG_ARP_TIMEOUT
233340cb90eeSGuennadi Liakhovetski
233440cb90eeSGuennadi Liakhovetski		Timeout waiting for an ARP reply in milliseconds.
233540cb90eeSGuennadi Liakhovetski
233648a3e999STetsuyuki Kobayashi		CONFIG_NFS_TIMEOUT
233748a3e999STetsuyuki Kobayashi
233848a3e999STetsuyuki Kobayashi		Timeout in milliseconds used in NFS protocol.
233948a3e999STetsuyuki Kobayashi		If you encounter "ERROR: Cannot umount" in nfs command,
234048a3e999STetsuyuki Kobayashi		try longer timeout such as
234148a3e999STetsuyuki Kobayashi		#define CONFIG_NFS_TIMEOUT 10000UL
234248a3e999STetsuyuki Kobayashi
2343c609719bSwdenk- Command Interpreter:
23448078f1a5SWolfgang Denk		CONFIG_AUTO_COMPLETE
234504a85b3bSwdenk
234604a85b3bSwdenk		Enable auto completion of commands using TAB.
234704a85b3bSwdenk
23488078f1a5SWolfgang Denk		Note that this feature has NOT been implemented yet
23498078f1a5SWolfgang Denk		for the "hush" shell.
23508078f1a5SWolfgang Denk
23518078f1a5SWolfgang Denk
23526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_HUSH_PARSER
2353c609719bSwdenk
2354c609719bSwdenk		Define this variable to enable the "hush" shell (from
2355c609719bSwdenk		Busybox) as command line interpreter, thus enabling
2356c609719bSwdenk		powerful command line syntax like
2357c609719bSwdenk		if...then...else...fi conditionals or `&&' and '||'
2358c609719bSwdenk		constructs ("shell scripts").
2359c609719bSwdenk
2360c609719bSwdenk		If undefined, you get the old, much simpler behaviour
2361c609719bSwdenk		with a somewhat smaller memory footprint.
2362c609719bSwdenk
2363c609719bSwdenk
23646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_PROMPT_HUSH_PS2
2365c609719bSwdenk
2366c609719bSwdenk		This defines the secondary prompt string, which is
2367c609719bSwdenk		printed when the command interpreter needs more input
2368c609719bSwdenk		to complete a command. Usually "> ".
2369c609719bSwdenk
2370c609719bSwdenk	Note:
2371c609719bSwdenk
2372c609719bSwdenk		In the current implementation, the local variables
2373c609719bSwdenk		space and global environment variables space are
2374c609719bSwdenk		separated. Local variables are those you define by
23753b57fe0aSwdenk		simply typing `name=value'. To access a local
2376c609719bSwdenk		variable later on, you have write `$name' or
23773b57fe0aSwdenk		`${name}'; to execute the contents of a variable
23783b57fe0aSwdenk		directly type `$name' at the command prompt.
2379c609719bSwdenk
2380c609719bSwdenk		Global environment variables are those you use
2381c609719bSwdenk		setenv/printenv to work with. To run a command stored
2382c609719bSwdenk		in such a variable, you need to use the run command,
2383c609719bSwdenk		and you must not use the '$' sign to access them.
2384c609719bSwdenk
2385c609719bSwdenk		To store commands and special characters in a
2386c609719bSwdenk		variable, please use double quotation marks
2387c609719bSwdenk		surrounding the whole text of the variable, instead
2388c609719bSwdenk		of the backslashes before semicolons and special
2389c609719bSwdenk		symbols.
2390c609719bSwdenk
2391aa0c71acSWolfgang Denk- Commandline Editing and History:
2392aa0c71acSWolfgang Denk		CONFIG_CMDLINE_EDITING
2393aa0c71acSWolfgang Denk
239411ccc33fSMarcel Ziswiler		Enable editing and History functions for interactive
2395aa0c71acSWolfgang Denk		commandline input operations
2396aa0c71acSWolfgang Denk
2397a8c7c708Swdenk- Default Environment:
2398c609719bSwdenk		CONFIG_EXTRA_ENV_SETTINGS
2399c609719bSwdenk
2400c609719bSwdenk		Define this to contain any number of null terminated
2401c609719bSwdenk		strings (variable = value pairs) that will be part of
24027152b1d0Swdenk		the default environment compiled into the boot image.
24032262cfeeSwdenk
2404c609719bSwdenk		For example, place something like this in your
2405c609719bSwdenk		board's config file:
2406c609719bSwdenk
2407c609719bSwdenk		#define CONFIG_EXTRA_ENV_SETTINGS \
2408c609719bSwdenk			"myvar1=value1\0" \
2409c609719bSwdenk			"myvar2=value2\0"
2410c609719bSwdenk
2411c609719bSwdenk		Warning: This method is based on knowledge about the
2412c609719bSwdenk		internal format how the environment is stored by the
24132262cfeeSwdenk		U-Boot code. This is NOT an official, exported
2414c609719bSwdenk		interface! Although it is unlikely that this format
24157152b1d0Swdenk		will change soon, there is no guarantee either.
2416c609719bSwdenk		You better know what you are doing here.
2417c609719bSwdenk
2418c609719bSwdenk		Note: overly (ab)use of the default environment is
2419c609719bSwdenk		discouraged. Make sure to check other ways to preset
242074de7aefSWolfgang Denk		the environment like the "source" command or the
2421c609719bSwdenk		boot command first.
2422c609719bSwdenk
24235e724ca2SStephen Warren		CONFIG_ENV_VARS_UBOOT_CONFIG
24245e724ca2SStephen Warren
24255e724ca2SStephen Warren		Define this in order to add variables describing the
24265e724ca2SStephen Warren		U-Boot build configuration to the default environment.
24275e724ca2SStephen Warren		These will be named arch, cpu, board, vendor, and soc.
24285e724ca2SStephen Warren
24295e724ca2SStephen Warren		Enabling this option will cause the following to be defined:
24305e724ca2SStephen Warren
24315e724ca2SStephen Warren		- CONFIG_SYS_ARCH
24325e724ca2SStephen Warren		- CONFIG_SYS_CPU
24335e724ca2SStephen Warren		- CONFIG_SYS_BOARD
24345e724ca2SStephen Warren		- CONFIG_SYS_VENDOR
24355e724ca2SStephen Warren		- CONFIG_SYS_SOC
24365e724ca2SStephen Warren
24377e27f89fSTom Rini		CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
24387e27f89fSTom Rini
24397e27f89fSTom Rini		Define this in order to add variables describing certain
24407e27f89fSTom Rini		run-time determined information about the hardware to the
24417e27f89fSTom Rini		environment.  These will be named board_name, board_rev.
24427e27f89fSTom Rini
244306fd8538SSimon Glass		CONFIG_DELAY_ENVIRONMENT
244406fd8538SSimon Glass
244506fd8538SSimon Glass		Normally the environment is loaded when the board is
244606fd8538SSimon Glass		intialised so that it is available to U-Boot. This inhibits
244706fd8538SSimon Glass		that so that the environment is not available until
244806fd8538SSimon Glass		explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
244906fd8538SSimon Glass		this is instead controlled by the value of
245006fd8538SSimon Glass		/config/load-environment.
245106fd8538SSimon Glass
2452a8c7c708Swdenk- DataFlash Support:
24532abbe075Swdenk		CONFIG_HAS_DATAFLASH
24542abbe075Swdenk
24552abbe075Swdenk		Defining this option enables DataFlash features and
24562abbe075Swdenk		allows to read/write in Dataflash via the standard
24572abbe075Swdenk		commands cp, md...
24582abbe075Swdenk
2459f61ec45eSEric Nelson- Serial Flash support
2460f61ec45eSEric Nelson		CONFIG_CMD_SF
2461f61ec45eSEric Nelson
2462f61ec45eSEric Nelson		Defining this option enables SPI flash commands
2463f61ec45eSEric Nelson		'sf probe/read/write/erase/update'.
2464f61ec45eSEric Nelson
2465f61ec45eSEric Nelson		Usage requires an initial 'probe' to define the serial
2466f61ec45eSEric Nelson		flash parameters, followed by read/write/erase/update
2467f61ec45eSEric Nelson		commands.
2468f61ec45eSEric Nelson
2469f61ec45eSEric Nelson		The following defaults may be provided by the platform
2470f61ec45eSEric Nelson		to handle the common case when only a single serial
2471f61ec45eSEric Nelson		flash is present on the system.
2472f61ec45eSEric Nelson
2473f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_BUS		Bus identifier
2474f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_CS		Chip-select
2475f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_MODE 		(see include/spi.h)
2476f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_SPEED		in Hz
2477f61ec45eSEric Nelson
247824007273SSimon Glass		CONFIG_CMD_SF_TEST
247924007273SSimon Glass
248024007273SSimon Glass		Define this option to include a destructive SPI flash
248124007273SSimon Glass		test ('sf test').
248224007273SSimon Glass
24833f85ce27Swdenk- SystemACE Support:
24843f85ce27Swdenk		CONFIG_SYSTEMACE
24853f85ce27Swdenk
24863f85ce27Swdenk		Adding this option adds support for Xilinx SystemACE
24873f85ce27Swdenk		chips attached via some sort of local bus. The address
248811ccc33fSMarcel Ziswiler		of the chip must also be defined in the
24896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SYSTEMACE_BASE macro. For example:
24903f85ce27Swdenk
24913f85ce27Swdenk		#define CONFIG_SYSTEMACE
24926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
24933f85ce27Swdenk
24943f85ce27Swdenk		When SystemACE support is added, the "ace" device type
24953f85ce27Swdenk		becomes available to the fat commands, i.e. fatls.
24963f85ce27Swdenk
2497ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port:
2498ecb0ccd9SWolfgang Denk		CONFIG_TFTP_PORT
2499ecb0ccd9SWolfgang Denk
250028cb9375SWolfgang Denk		If this is defined, the environment variable tftpsrcp
2501ecb0ccd9SWolfgang Denk		is used to supply the TFTP UDP source port value.
250228cb9375SWolfgang Denk		If tftpsrcp isn't defined, the normal pseudo-random port
2503ecb0ccd9SWolfgang Denk		number generator is used.
2504ecb0ccd9SWolfgang Denk
250528cb9375SWolfgang Denk		Also, the environment variable tftpdstp is used to supply
250628cb9375SWolfgang Denk		the TFTP UDP destination port value.  If tftpdstp isn't
250728cb9375SWolfgang Denk		defined, the normal port 69 is used.
250828cb9375SWolfgang Denk
250928cb9375SWolfgang Denk		The purpose for tftpsrcp is to allow a TFTP server to
2510ecb0ccd9SWolfgang Denk		blindly start the TFTP transfer using the pre-configured
2511ecb0ccd9SWolfgang Denk		target IP address and UDP port. This has the effect of
2512ecb0ccd9SWolfgang Denk		"punching through" the (Windows XP) firewall, allowing
2513ecb0ccd9SWolfgang Denk		the remainder of the TFTP transfer to proceed normally.
2514ecb0ccd9SWolfgang Denk		A better solution is to properly configure the firewall,
2515ecb0ccd9SWolfgang Denk		but sometimes that is not allowed.
2516ecb0ccd9SWolfgang Denk
2517bf36c5d5SSimon Glass- Hashing support:
2518bf36c5d5SSimon Glass		CONFIG_CMD_HASH
2519bf36c5d5SSimon Glass
2520bf36c5d5SSimon Glass		This enables a generic 'hash' command which can produce
2521bf36c5d5SSimon Glass		hashes / digests from a few algorithms (e.g. SHA1, SHA256).
2522bf36c5d5SSimon Glass
2523bf36c5d5SSimon Glass		CONFIG_HASH_VERIFY
2524bf36c5d5SSimon Glass
2525bf36c5d5SSimon Glass		Enable the hash verify command (hash -v). This adds to code
2526bf36c5d5SSimon Glass		size a little.
2527bf36c5d5SSimon Glass
2528bf36c5d5SSimon Glass		CONFIG_SHA1 - support SHA1 hashing
2529bf36c5d5SSimon Glass		CONFIG_SHA256 - support SHA256 hashing
2530bf36c5d5SSimon Glass
2531bf36c5d5SSimon Glass		Note: There is also a sha1sum command, which should perhaps
2532bf36c5d5SSimon Glass		be deprecated in favour of 'hash sha1'.
2533bf36c5d5SSimon Glass
2534a8c7c708Swdenk- Show boot progress:
2535c609719bSwdenk		CONFIG_SHOW_BOOT_PROGRESS
2536c609719bSwdenk
2537c609719bSwdenk		Defining this option allows to add some board-
2538c609719bSwdenk		specific code (calling a user-provided function
2539c609719bSwdenk		"show_boot_progress(int)") that enables you to show
2540c609719bSwdenk		the system's boot progress on some display (for
2541c609719bSwdenk		example, some LED's) on your board. At the moment,
2542c609719bSwdenk		the following checkpoints are implemented:
2543c609719bSwdenk
25443a608ca0SSimon Glass- Detailed boot stage timing
25453a608ca0SSimon Glass		CONFIG_BOOTSTAGE
25463a608ca0SSimon Glass		Define this option to get detailed timing of each stage
25473a608ca0SSimon Glass		of the boot process.
25483a608ca0SSimon Glass
25493a608ca0SSimon Glass		CONFIG_BOOTSTAGE_USER_COUNT
25503a608ca0SSimon Glass		This is the number of available user bootstage records.
25513a608ca0SSimon Glass		Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
25523a608ca0SSimon Glass		a new ID will be allocated from this stash. If you exceed
25533a608ca0SSimon Glass		the limit, recording will stop.
25543a608ca0SSimon Glass
25553a608ca0SSimon Glass		CONFIG_BOOTSTAGE_REPORT
25563a608ca0SSimon Glass		Define this to print a report before boot, similar to this:
25573a608ca0SSimon Glass
25583a608ca0SSimon Glass		Timer summary in microseconds:
25593a608ca0SSimon Glass		       Mark    Elapsed  Stage
25603a608ca0SSimon Glass			  0          0  reset
25613a608ca0SSimon Glass		  3,575,678  3,575,678  board_init_f start
25623a608ca0SSimon Glass		  3,575,695         17  arch_cpu_init A9
25633a608ca0SSimon Glass		  3,575,777         82  arch_cpu_init done
25643a608ca0SSimon Glass		  3,659,598     83,821  board_init_r start
25653a608ca0SSimon Glass		  3,910,375    250,777  main_loop
25663a608ca0SSimon Glass		 29,916,167 26,005,792  bootm_start
25673a608ca0SSimon Glass		 30,361,327    445,160  start_kernel
25683a608ca0SSimon Glass
25692eba38cfSSimon Glass		CONFIG_CMD_BOOTSTAGE
25702eba38cfSSimon Glass		Add a 'bootstage' command which supports printing a report
25712eba38cfSSimon Glass		and un/stashing of bootstage data.
25722eba38cfSSimon Glass
257394fd1316SSimon Glass		CONFIG_BOOTSTAGE_FDT
257494fd1316SSimon Glass		Stash the bootstage information in the FDT. A root 'bootstage'
257594fd1316SSimon Glass		node is created with each bootstage id as a child. Each child
257694fd1316SSimon Glass		has a 'name' property and either 'mark' containing the
257794fd1316SSimon Glass		mark time in microsecond, or 'accum' containing the
257894fd1316SSimon Glass		accumulated time for that bootstage id in microseconds.
257994fd1316SSimon Glass		For example:
258094fd1316SSimon Glass
258194fd1316SSimon Glass		bootstage {
258294fd1316SSimon Glass			154 {
258394fd1316SSimon Glass				name = "board_init_f";
258494fd1316SSimon Glass				mark = <3575678>;
258594fd1316SSimon Glass			};
258694fd1316SSimon Glass			170 {
258794fd1316SSimon Glass				name = "lcd";
258894fd1316SSimon Glass				accum = <33482>;
258994fd1316SSimon Glass			};
259094fd1316SSimon Glass		};
259194fd1316SSimon Glass
259294fd1316SSimon Glass		Code in the Linux kernel can find this in /proc/devicetree.
259394fd1316SSimon Glass
25941372cce2SMarian BalakowiczLegacy uImage format:
25951372cce2SMarian Balakowicz
2596c609719bSwdenk  Arg	Where			When
2597c609719bSwdenk    1	common/cmd_bootm.c	before attempting to boot an image
2598c609719bSwdenk   -1	common/cmd_bootm.c	Image header has bad	 magic number
2599c609719bSwdenk    2	common/cmd_bootm.c	Image header has correct magic number
2600c609719bSwdenk   -2	common/cmd_bootm.c	Image header has bad	 checksum
2601c609719bSwdenk    3	common/cmd_bootm.c	Image header has correct checksum
2602c609719bSwdenk   -3	common/cmd_bootm.c	Image data   has bad	 checksum
2603c609719bSwdenk    4	common/cmd_bootm.c	Image data   has correct checksum
2604c609719bSwdenk   -4	common/cmd_bootm.c	Image is for unsupported architecture
2605c609719bSwdenk    5	common/cmd_bootm.c	Architecture check OK
26061372cce2SMarian Balakowicz   -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi)
2607c609719bSwdenk    6	common/cmd_bootm.c	Image Type check OK
2608c609719bSwdenk   -6	common/cmd_bootm.c	gunzip uncompression error
2609c609719bSwdenk   -7	common/cmd_bootm.c	Unimplemented compression type
2610c609719bSwdenk    7	common/cmd_bootm.c	Uncompression OK
26111372cce2SMarian Balakowicz    8	common/cmd_bootm.c	No uncompress/copy overwrite error
2612c609719bSwdenk   -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
26131372cce2SMarian Balakowicz
26141372cce2SMarian Balakowicz    9	common/image.c		Start initial ramdisk verification
26151372cce2SMarian Balakowicz  -10	common/image.c		Ramdisk header has bad	   magic number
26161372cce2SMarian Balakowicz  -11	common/image.c		Ramdisk header has bad	   checksum
26171372cce2SMarian Balakowicz   10	common/image.c		Ramdisk header is OK
26181372cce2SMarian Balakowicz  -12	common/image.c		Ramdisk data   has bad	   checksum
26191372cce2SMarian Balakowicz   11	common/image.c		Ramdisk data   has correct checksum
26201372cce2SMarian Balakowicz   12	common/image.c		Ramdisk verification complete, start loading
262111ccc33fSMarcel Ziswiler  -13	common/image.c		Wrong Image Type (not PPC Linux ramdisk)
26221372cce2SMarian Balakowicz   13	common/image.c		Start multifile image verification
26231372cce2SMarian Balakowicz   14	common/image.c		No initial ramdisk, no multifile, continue.
26241372cce2SMarian Balakowicz
2625ea0364f1SPeter Tyser   15	arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
2626c609719bSwdenk
2627a47a12beSStefan Roese  -30	arch/powerpc/lib/board.c	Fatal error, hang the system
262863e73c9aSwdenk  -31	post/post.c		POST test failed, detected by post_output_backlog()
262963e73c9aSwdenk  -32	post/post.c		POST test failed, detected by post_run_single()
263063e73c9aSwdenk
2631566a494fSHeiko Schocher   34	common/cmd_doc.c	before loading a Image from a DOC device
2632566a494fSHeiko Schocher  -35	common/cmd_doc.c	Bad usage of "doc" command
2633566a494fSHeiko Schocher   35	common/cmd_doc.c	correct usage of "doc" command
2634566a494fSHeiko Schocher  -36	common/cmd_doc.c	No boot device
2635566a494fSHeiko Schocher   36	common/cmd_doc.c	correct boot device
2636566a494fSHeiko Schocher  -37	common/cmd_doc.c	Unknown Chip ID on boot device
2637566a494fSHeiko Schocher   37	common/cmd_doc.c	correct chip ID found, device available
2638566a494fSHeiko Schocher  -38	common/cmd_doc.c	Read Error on boot device
2639566a494fSHeiko Schocher   38	common/cmd_doc.c	reading Image header from DOC device OK
2640566a494fSHeiko Schocher  -39	common/cmd_doc.c	Image header has bad magic number
2641566a494fSHeiko Schocher   39	common/cmd_doc.c	Image header has correct magic number
2642566a494fSHeiko Schocher  -40	common/cmd_doc.c	Error reading Image from DOC device
2643566a494fSHeiko Schocher   40	common/cmd_doc.c	Image header has correct magic number
2644566a494fSHeiko Schocher   41	common/cmd_ide.c	before loading a Image from a IDE device
2645566a494fSHeiko Schocher  -42	common/cmd_ide.c	Bad usage of "ide" command
2646566a494fSHeiko Schocher   42	common/cmd_ide.c	correct usage of "ide" command
2647566a494fSHeiko Schocher  -43	common/cmd_ide.c	No boot device
2648566a494fSHeiko Schocher   43	common/cmd_ide.c	boot device found
2649566a494fSHeiko Schocher  -44	common/cmd_ide.c	Device not available
2650566a494fSHeiko Schocher   44	common/cmd_ide.c	Device available
2651566a494fSHeiko Schocher  -45	common/cmd_ide.c	wrong partition selected
2652566a494fSHeiko Schocher   45	common/cmd_ide.c	partition selected
2653566a494fSHeiko Schocher  -46	common/cmd_ide.c	Unknown partition table
2654566a494fSHeiko Schocher   46	common/cmd_ide.c	valid partition table found
2655566a494fSHeiko Schocher  -47	common/cmd_ide.c	Invalid partition type
2656566a494fSHeiko Schocher   47	common/cmd_ide.c	correct partition type
2657566a494fSHeiko Schocher  -48	common/cmd_ide.c	Error reading Image Header on boot device
2658566a494fSHeiko Schocher   48	common/cmd_ide.c	reading Image Header from IDE device OK
2659566a494fSHeiko Schocher  -49	common/cmd_ide.c	Image header has bad magic number
2660566a494fSHeiko Schocher   49	common/cmd_ide.c	Image header has correct magic number
2661566a494fSHeiko Schocher  -50	common/cmd_ide.c	Image header has bad	 checksum
2662566a494fSHeiko Schocher   50	common/cmd_ide.c	Image header has correct checksum
2663566a494fSHeiko Schocher  -51	common/cmd_ide.c	Error reading Image from IDE device
2664566a494fSHeiko Schocher   51	common/cmd_ide.c	reading Image from IDE device OK
2665566a494fSHeiko Schocher   52	common/cmd_nand.c	before loading a Image from a NAND device
2666566a494fSHeiko Schocher  -53	common/cmd_nand.c	Bad usage of "nand" command
2667566a494fSHeiko Schocher   53	common/cmd_nand.c	correct usage of "nand" command
2668566a494fSHeiko Schocher  -54	common/cmd_nand.c	No boot device
2669566a494fSHeiko Schocher   54	common/cmd_nand.c	boot device found
2670566a494fSHeiko Schocher  -55	common/cmd_nand.c	Unknown Chip ID on boot device
2671566a494fSHeiko Schocher   55	common/cmd_nand.c	correct chip ID found, device available
2672566a494fSHeiko Schocher  -56	common/cmd_nand.c	Error reading Image Header on boot device
2673566a494fSHeiko Schocher   56	common/cmd_nand.c	reading Image Header from NAND device OK
2674566a494fSHeiko Schocher  -57	common/cmd_nand.c	Image header has bad magic number
2675566a494fSHeiko Schocher   57	common/cmd_nand.c	Image header has correct magic number
2676566a494fSHeiko Schocher  -58	common/cmd_nand.c	Error reading Image from NAND device
2677566a494fSHeiko Schocher   58	common/cmd_nand.c	reading Image from NAND device OK
2678c609719bSwdenk
2679566a494fSHeiko Schocher  -60	common/env_common.c	Environment has a bad CRC, using default
2680c609719bSwdenk
2681566a494fSHeiko Schocher   64	net/eth.c		starting with Ethernet configuration.
2682566a494fSHeiko Schocher  -64	net/eth.c		no Ethernet found.
2683566a494fSHeiko Schocher   65	net/eth.c		Ethernet found.
2684206c60cbSwdenk
2685566a494fSHeiko Schocher  -80	common/cmd_net.c	usage wrong
2686566a494fSHeiko Schocher   80	common/cmd_net.c	before calling NetLoop()
268711ccc33fSMarcel Ziswiler  -81	common/cmd_net.c	some error in NetLoop() occurred
2688566a494fSHeiko Schocher   81	common/cmd_net.c	NetLoop() back without error
2689566a494fSHeiko Schocher  -82	common/cmd_net.c	size == 0 (File with size 0 loaded)
2690566a494fSHeiko Schocher   82	common/cmd_net.c	trying automatic boot
269174de7aefSWolfgang Denk   83	common/cmd_net.c	running "source" command
269274de7aefSWolfgang Denk  -83	common/cmd_net.c	some error in automatic boot or "source" command
2693566a494fSHeiko Schocher   84	common/cmd_net.c	end without errors
2694c609719bSwdenk
26951372cce2SMarian BalakowiczFIT uImage format:
26961372cce2SMarian Balakowicz
26971372cce2SMarian Balakowicz  Arg	Where			When
26981372cce2SMarian Balakowicz  100	common/cmd_bootm.c	Kernel FIT Image has correct format
26991372cce2SMarian Balakowicz -100	common/cmd_bootm.c	Kernel FIT Image has incorrect format
27001372cce2SMarian Balakowicz  101	common/cmd_bootm.c	No Kernel subimage unit name, using configuration
27011372cce2SMarian Balakowicz -101	common/cmd_bootm.c	Can't get configuration for kernel subimage
27021372cce2SMarian Balakowicz  102	common/cmd_bootm.c	Kernel unit name specified
27031372cce2SMarian Balakowicz -103	common/cmd_bootm.c	Can't get kernel subimage node offset
2704f773bea8SMarian Balakowicz  103	common/cmd_bootm.c	Found configuration node
27051372cce2SMarian Balakowicz  104	common/cmd_bootm.c	Got kernel subimage node offset
27061372cce2SMarian Balakowicz -104	common/cmd_bootm.c	Kernel subimage hash verification failed
27071372cce2SMarian Balakowicz  105	common/cmd_bootm.c	Kernel subimage hash verification OK
27081372cce2SMarian Balakowicz -105	common/cmd_bootm.c	Kernel subimage is for unsupported architecture
27091372cce2SMarian Balakowicz  106	common/cmd_bootm.c	Architecture check OK
271011ccc33fSMarcel Ziswiler -106	common/cmd_bootm.c	Kernel subimage has wrong type
271111ccc33fSMarcel Ziswiler  107	common/cmd_bootm.c	Kernel subimage type OK
27121372cce2SMarian Balakowicz -107	common/cmd_bootm.c	Can't get kernel subimage data/size
27131372cce2SMarian Balakowicz  108	common/cmd_bootm.c	Got kernel subimage data/size
27141372cce2SMarian Balakowicz -108	common/cmd_bootm.c	Wrong image type (not legacy, FIT)
27151372cce2SMarian Balakowicz -109	common/cmd_bootm.c	Can't get kernel subimage type
27161372cce2SMarian Balakowicz -110	common/cmd_bootm.c	Can't get kernel subimage comp
27171372cce2SMarian Balakowicz -111	common/cmd_bootm.c	Can't get kernel subimage os
27181372cce2SMarian Balakowicz -112	common/cmd_bootm.c	Can't get kernel subimage load address
27191372cce2SMarian Balakowicz -113	common/cmd_bootm.c	Image uncompress/copy overwrite error
27201372cce2SMarian Balakowicz
27211372cce2SMarian Balakowicz  120	common/image.c		Start initial ramdisk verification
27221372cce2SMarian Balakowicz -120	common/image.c		Ramdisk FIT image has incorrect format
27231372cce2SMarian Balakowicz  121	common/image.c		Ramdisk FIT image has correct format
272411ccc33fSMarcel Ziswiler  122	common/image.c		No ramdisk subimage unit name, using configuration
27251372cce2SMarian Balakowicz -122	common/image.c		Can't get configuration for ramdisk subimage
27261372cce2SMarian Balakowicz  123	common/image.c		Ramdisk unit name specified
27271372cce2SMarian Balakowicz -124	common/image.c		Can't get ramdisk subimage node offset
27281372cce2SMarian Balakowicz  125	common/image.c		Got ramdisk subimage node offset
27291372cce2SMarian Balakowicz -125	common/image.c		Ramdisk subimage hash verification failed
27301372cce2SMarian Balakowicz  126	common/image.c		Ramdisk subimage hash verification OK
27311372cce2SMarian Balakowicz -126	common/image.c		Ramdisk subimage for unsupported architecture
27321372cce2SMarian Balakowicz  127	common/image.c		Architecture check OK
27331372cce2SMarian Balakowicz -127	common/image.c		Can't get ramdisk subimage data/size
27341372cce2SMarian Balakowicz  128	common/image.c		Got ramdisk subimage data/size
27351372cce2SMarian Balakowicz  129	common/image.c		Can't get ramdisk load address
27361372cce2SMarian Balakowicz -129	common/image.c		Got ramdisk load address
27371372cce2SMarian Balakowicz
273811ccc33fSMarcel Ziswiler -130	common/cmd_doc.c	Incorrect FIT image format
27391372cce2SMarian Balakowicz  131	common/cmd_doc.c	FIT image format OK
27401372cce2SMarian Balakowicz
274111ccc33fSMarcel Ziswiler -140	common/cmd_ide.c	Incorrect FIT image format
27421372cce2SMarian Balakowicz  141	common/cmd_ide.c	FIT image format OK
27431372cce2SMarian Balakowicz
274411ccc33fSMarcel Ziswiler -150	common/cmd_nand.c	Incorrect FIT image format
27451372cce2SMarian Balakowicz  151	common/cmd_nand.c	FIT image format OK
27461372cce2SMarian Balakowicz
2747d95f6ec7SGabe Black- FIT image support:
2748d95f6ec7SGabe Black		CONFIG_FIT
2749d95f6ec7SGabe Black		Enable support for the FIT uImage format.
2750d95f6ec7SGabe Black
2751d95f6ec7SGabe Black		CONFIG_FIT_BEST_MATCH
2752d95f6ec7SGabe Black		When no configuration is explicitly selected, default to the
2753d95f6ec7SGabe Black		one whose fdt's compatibility field best matches that of
2754d95f6ec7SGabe Black		U-Boot itself. A match is considered "best" if it matches the
2755d95f6ec7SGabe Black		most specific compatibility entry of U-Boot's fdt's root node.
2756d95f6ec7SGabe Black		The order of entries in the configuration's fdt is ignored.
2757d95f6ec7SGabe Black
27584cf2609bSWolfgang Denk- Standalone program support:
27594cf2609bSWolfgang Denk		CONFIG_STANDALONE_LOAD_ADDR
27604cf2609bSWolfgang Denk
27616feff899SWolfgang Denk		This option defines a board specific value for the
27626feff899SWolfgang Denk		address where standalone program gets loaded, thus
27636feff899SWolfgang Denk		overwriting the architecture dependent default
27644cf2609bSWolfgang Denk		settings.
27654cf2609bSWolfgang Denk
27664cf2609bSWolfgang Denk- Frame Buffer Address:
27674cf2609bSWolfgang Denk		CONFIG_FB_ADDR
27684cf2609bSWolfgang Denk
27694cf2609bSWolfgang Denk		Define CONFIG_FB_ADDR if you want to use specific
277044a53b57SWolfgang Denk		address for frame buffer.  This is typically the case
277144a53b57SWolfgang Denk		when using a graphics controller has separate video
277244a53b57SWolfgang Denk		memory.  U-Boot will then place the frame buffer at
277344a53b57SWolfgang Denk		the given address instead of dynamically reserving it
277444a53b57SWolfgang Denk		in system RAM by calling lcd_setmem(), which grabs
277544a53b57SWolfgang Denk		the memory for the frame buffer depending on the
277644a53b57SWolfgang Denk		configured panel size.
27774cf2609bSWolfgang Denk
27784cf2609bSWolfgang Denk		Please see board_init_f function.
27794cf2609bSWolfgang Denk
2780cccfc2abSDetlev Zundel- Automatic software updates via TFTP server
2781cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP
2782cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_CNT_MAX
2783cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_MSEC_MAX
2784cccfc2abSDetlev Zundel
2785cccfc2abSDetlev Zundel		These options enable and control the auto-update feature;
2786cccfc2abSDetlev Zundel		for a more detailed description refer to doc/README.update.
2787cccfc2abSDetlev Zundel
2788cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support)
2789cccfc2abSDetlev Zundel		CONFIG_MTD_DEVICE
2790cccfc2abSDetlev Zundel
2791cccfc2abSDetlev Zundel		Adds the MTD device infrastructure from the Linux kernel.
2792cccfc2abSDetlev Zundel		Needed for mtdparts command support.
2793cccfc2abSDetlev Zundel
2794cccfc2abSDetlev Zundel		CONFIG_MTD_PARTITIONS
2795cccfc2abSDetlev Zundel
2796cccfc2abSDetlev Zundel		Adds the MTD partitioning infrastructure from the Linux
2797cccfc2abSDetlev Zundel		kernel. Needed for UBI support.
2798cccfc2abSDetlev Zundel
27996a11cf48SDaniel Schwierzeck- SPL framework
28006a11cf48SDaniel Schwierzeck		CONFIG_SPL
28016a11cf48SDaniel Schwierzeck		Enable building of SPL globally.
28026a11cf48SDaniel Schwierzeck
280395579793STom Rini		CONFIG_SPL_LDSCRIPT
280495579793STom Rini		LDSCRIPT for linking the SPL binary.
280595579793STom Rini
280695579793STom Rini		CONFIG_SPL_MAX_SIZE
280795579793STom Rini		Maximum binary size (text, data and rodata) of the SPL binary.
280895579793STom Rini
28096a11cf48SDaniel Schwierzeck		CONFIG_SPL_TEXT_BASE
28106a11cf48SDaniel Schwierzeck		TEXT_BASE for linking the SPL binary.
28116a11cf48SDaniel Schwierzeck
281294a45bb1SScott Wood		CONFIG_SPL_RELOC_TEXT_BASE
281394a45bb1SScott Wood		Address to relocate to.  If unspecified, this is equal to
281494a45bb1SScott Wood		CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
281594a45bb1SScott Wood
281695579793STom Rini		CONFIG_SPL_BSS_START_ADDR
281795579793STom Rini		Link address for the BSS within the SPL binary.
281895579793STom Rini
281995579793STom Rini		CONFIG_SPL_BSS_MAX_SIZE
282095579793STom Rini		Maximum binary size of the BSS section of the SPL binary.
282195579793STom Rini
282295579793STom Rini		CONFIG_SPL_STACK
282395579793STom Rini		Adress of the start of the stack SPL will use
282495579793STom Rini
282594a45bb1SScott Wood		CONFIG_SPL_RELOC_STACK
282694a45bb1SScott Wood		Adress of the start of the stack SPL will use after
282794a45bb1SScott Wood		relocation.  If unspecified, this is equal to
282894a45bb1SScott Wood		CONFIG_SPL_STACK.
282994a45bb1SScott Wood
283095579793STom Rini		CONFIG_SYS_SPL_MALLOC_START
283195579793STom Rini		Starting address of the malloc pool used in SPL.
283295579793STom Rini
283395579793STom Rini		CONFIG_SYS_SPL_MALLOC_SIZE
283495579793STom Rini		The size of the malloc pool used in SPL.
28356a11cf48SDaniel Schwierzeck
283647f7bcaeSTom Rini		CONFIG_SPL_FRAMEWORK
283747f7bcaeSTom Rini		Enable the SPL framework under common/.  This framework
283847f7bcaeSTom Rini		supports MMC, NAND and YMODEM loading of U-Boot and NAND
283947f7bcaeSTom Rini		NAND loading of the Linux Kernel.
284047f7bcaeSTom Rini
2841861a86f4STom Rini		CONFIG_SPL_DISPLAY_PRINT
2842861a86f4STom Rini		For ARM, enable an optional function to print more information
2843861a86f4STom Rini		about the running system.
2844861a86f4STom Rini
28454b919725SScott Wood		CONFIG_SPL_INIT_MINIMAL
28464b919725SScott Wood		Arch init code should be built for a very small image
28474b919725SScott Wood
28486a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBCOMMON_SUPPORT
28496a11cf48SDaniel Schwierzeck		Support for common/libcommon.o in SPL binary
28506a11cf48SDaniel Schwierzeck
28516a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBDISK_SUPPORT
28526a11cf48SDaniel Schwierzeck		Support for disk/libdisk.o in SPL binary
28536a11cf48SDaniel Schwierzeck
28546a11cf48SDaniel Schwierzeck		CONFIG_SPL_I2C_SUPPORT
28556a11cf48SDaniel Schwierzeck		Support for drivers/i2c/libi2c.o in SPL binary
28566a11cf48SDaniel Schwierzeck
28576a11cf48SDaniel Schwierzeck		CONFIG_SPL_GPIO_SUPPORT
28586a11cf48SDaniel Schwierzeck		Support for drivers/gpio/libgpio.o in SPL binary
28596a11cf48SDaniel Schwierzeck
28606a11cf48SDaniel Schwierzeck		CONFIG_SPL_MMC_SUPPORT
28616a11cf48SDaniel Schwierzeck		Support for drivers/mmc/libmmc.o in SPL binary
28626a11cf48SDaniel Schwierzeck
286395579793STom Rini		CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
286495579793STom Rini		CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
286595579793STom Rini		CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION
286695579793STom Rini		Address, size and partition on the MMC to load U-Boot from
286795579793STom Rini		when the MMC is being used in raw mode.
286895579793STom Rini
286995579793STom Rini		CONFIG_SPL_FAT_SUPPORT
287095579793STom Rini		Support for fs/fat/libfat.o in SPL binary
287195579793STom Rini
287295579793STom Rini		CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME
287395579793STom Rini		Filename to read to load U-Boot when reading from FAT
287495579793STom Rini
287506f60ae3SScott Wood		CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
287606f60ae3SScott Wood		Set this for NAND SPL on PPC mpc83xx targets, so that
287706f60ae3SScott Wood		start.S waits for the rest of the SPL to load before
287806f60ae3SScott Wood		continuing (the hardware starts execution after just
287906f60ae3SScott Wood		loading the first page rather than the full 4K).
288006f60ae3SScott Wood
28816f2f01b9SScott Wood		CONFIG_SPL_NAND_BASE
28826f2f01b9SScott Wood		Include nand_base.c in the SPL.  Requires
28836f2f01b9SScott Wood		CONFIG_SPL_NAND_DRIVERS.
28846f2f01b9SScott Wood
28856f2f01b9SScott Wood		CONFIG_SPL_NAND_DRIVERS
28866f2f01b9SScott Wood		SPL uses normal NAND drivers, not minimal drivers.
28876f2f01b9SScott Wood
28886f2f01b9SScott Wood		CONFIG_SPL_NAND_ECC
28896f2f01b9SScott Wood		Include standard software ECC in the SPL
28906f2f01b9SScott Wood
289195579793STom Rini		CONFIG_SPL_NAND_SIMPLE
28927d4b7955SScott Wood		Support for NAND boot using simple NAND drivers that
28937d4b7955SScott Wood		expose the cmd_ctrl() interface.
289495579793STom Rini
289595579793STom Rini		CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
289695579793STom Rini		CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
289795579793STom Rini		CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
289895579793STom Rini		CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
289995579793STom Rini		CONFIG_SYS_NAND_ECCBYTES
290095579793STom Rini		Defines the size and behavior of the NAND that SPL uses
29017d4b7955SScott Wood		to read U-Boot
290295579793STom Rini
290395579793STom Rini		CONFIG_SYS_NAND_U_BOOT_OFFS
29047d4b7955SScott Wood		Location in NAND to read U-Boot from
29057d4b7955SScott Wood
29067d4b7955SScott Wood		CONFIG_SYS_NAND_U_BOOT_DST
29077d4b7955SScott Wood		Location in memory to load U-Boot to
29087d4b7955SScott Wood
29097d4b7955SScott Wood		CONFIG_SYS_NAND_U_BOOT_SIZE
29107d4b7955SScott Wood		Size of image to load
291195579793STom Rini
291295579793STom Rini		CONFIG_SYS_NAND_U_BOOT_START
29137d4b7955SScott Wood		Entry point in loaded image to jump to
291495579793STom Rini
291595579793STom Rini		CONFIG_SYS_NAND_HW_ECC_OOBFIRST
291695579793STom Rini		Define this if you need to first read the OOB and then the
291795579793STom Rini		data. This is used for example on davinci plattforms.
291895579793STom Rini
291995579793STom Rini		CONFIG_SPL_OMAP3_ID_NAND
292095579793STom Rini		Support for an OMAP3-specific set of functions to return the
292195579793STom Rini		ID and MFR of the first attached NAND chip, if present.
292295579793STom Rini
29236a11cf48SDaniel Schwierzeck		CONFIG_SPL_SERIAL_SUPPORT
29246a11cf48SDaniel Schwierzeck		Support for drivers/serial/libserial.o in SPL binary
29256a11cf48SDaniel Schwierzeck
29266a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_FLASH_SUPPORT
29276a11cf48SDaniel Schwierzeck		Support for drivers/mtd/spi/libspi_flash.o in SPL binary
29286a11cf48SDaniel Schwierzeck
29296a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_SUPPORT
29306a11cf48SDaniel Schwierzeck		Support for drivers/spi/libspi.o in SPL binary
29316a11cf48SDaniel Schwierzeck
2932c57b953dSPavel Machek		CONFIG_SPL_RAM_DEVICE
2933c57b953dSPavel Machek		Support for running image already present in ram, in SPL binary
2934c57b953dSPavel Machek
29356a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBGENERIC_SUPPORT
29366a11cf48SDaniel Schwierzeck		Support for lib/libgeneric.o in SPL binary
29371372cce2SMarian Balakowicz
293874752baaSScott Wood		CONFIG_SPL_PAD_TO
293974752baaSScott Wood		Linker address to which the SPL should be padded before
294074752baaSScott Wood		appending the SPL payload.
294174752baaSScott Wood
2942ca2fca22SScott Wood		CONFIG_SPL_TARGET
2943ca2fca22SScott Wood		Final target image containing SPL and payload.  Some SPLs
2944ca2fca22SScott Wood		use an arch-specific makefile fragment instead, for
2945ca2fca22SScott Wood		example if more than one image needs to be produced.
2946ca2fca22SScott Wood
2947c609719bSwdenkModem Support:
2948c609719bSwdenk--------------
2949c609719bSwdenk
2950566e5cf4SWolfgang Denk[so far only for SMDK2400 boards]
2951c609719bSwdenk
295211ccc33fSMarcel Ziswiler- Modem support enable:
2953c609719bSwdenk		CONFIG_MODEM_SUPPORT
2954c609719bSwdenk
2955c609719bSwdenk- RTS/CTS Flow control enable:
2956c609719bSwdenk		CONFIG_HWFLOW
2957c609719bSwdenk
2958c609719bSwdenk- Modem debug support:
2959c609719bSwdenk		CONFIG_MODEM_SUPPORT_DEBUG
2960c609719bSwdenk
2961c609719bSwdenk		Enables debugging stuff (char screen[1024], dbg())
2962c609719bSwdenk		for modem support. Useful only with BDI2000.
2963c609719bSwdenk
2964a8c7c708Swdenk- Interrupt support (PPC):
2965a8c7c708Swdenk
2966a8c7c708Swdenk		There are common interrupt_init() and timer_interrupt()
2967a8c7c708Swdenk		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
296811ccc33fSMarcel Ziswiler		for CPU specific initialization. interrupt_init_cpu()
2969a8c7c708Swdenk		should set decrementer_count to appropriate value. If
297011ccc33fSMarcel Ziswiler		CPU resets decrementer automatically after interrupt
2971a8c7c708Swdenk		(ppc4xx) it should set decrementer_count to zero.
297211ccc33fSMarcel Ziswiler		timer_interrupt() calls timer_interrupt_cpu() for CPU
2973a8c7c708Swdenk		specific handling. If board has watchdog / status_led
2974a8c7c708Swdenk		/ other_activity_monitor it works automatically from
2975a8c7c708Swdenk		general timer_interrupt().
2976a8c7c708Swdenk
2977c609719bSwdenk- General:
2978c609719bSwdenk
2979c609719bSwdenk		In the target system modem support is enabled when a
2980c609719bSwdenk		specific key (key combination) is pressed during
2981c609719bSwdenk		power-on. Otherwise U-Boot will boot normally
298211ccc33fSMarcel Ziswiler		(autoboot). The key_pressed() function is called from
2983c609719bSwdenk		board_init(). Currently key_pressed() is a dummy
2984c609719bSwdenk		function, returning 1 and thus enabling modem
2985c609719bSwdenk		initialization.
2986c609719bSwdenk
2987c609719bSwdenk		If there are no modem init strings in the
2988c609719bSwdenk		environment, U-Boot proceed to autoboot; the
2989c609719bSwdenk		previous output (banner, info printfs) will be
299011ccc33fSMarcel Ziswiler		suppressed, though.
2991c609719bSwdenk
2992c609719bSwdenk		See also: doc/README.Modem
2993c609719bSwdenk
29949660e442SHelmut RaigerBoard initialization settings:
29959660e442SHelmut Raiger------------------------------
29969660e442SHelmut Raiger
29979660e442SHelmut RaigerDuring Initialization u-boot calls a number of board specific functions
29989660e442SHelmut Raigerto allow the preparation of board specific prerequisites, e.g. pin setup
29999660e442SHelmut Raigerbefore drivers are initialized. To enable these callbacks the
30009660e442SHelmut Raigerfollowing configuration macros have to be defined. Currently this is
30019660e442SHelmut Raigerarchitecture specific, so please check arch/your_architecture/lib/board.c
30029660e442SHelmut Raigertypically in board_init_f() and board_init_r().
30039660e442SHelmut Raiger
30049660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
30059660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
30069660e442SHelmut Raiger- CONFIG_BOARD_LATE_INIT: Call board_late_init()
30079660e442SHelmut Raiger- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
3008c609719bSwdenk
3009c609719bSwdenkConfiguration Settings:
3010c609719bSwdenk-----------------------
3011c609719bSwdenk
30126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
3013c609719bSwdenk		undefine this when you're short of memory.
3014c609719bSwdenk
30152fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
30162fb2604dSPeter Tyser		width of the commands listed in the 'help' command output.
30172fb2604dSPeter Tyser
30186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT:	This is what U-Boot prints on the console to
3019c609719bSwdenk		prompt for user input.
3020c609719bSwdenk
30216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE:	Buffer size for input from the Console
3022c609719bSwdenk
30236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE:	Buffer size for Console output
3024c609719bSwdenk
30256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS:	max. Number of arguments accepted for monitor commands
3026c609719bSwdenk
30276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
3028c609719bSwdenk		the application (usually a Linux kernel) when it is
3029c609719bSwdenk		booted
3030c609719bSwdenk
30316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE:
3032c609719bSwdenk		List of legal baudrate settings for this board.
3033c609719bSwdenk
30346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_INFO_QUIET
3035c609719bSwdenk		Suppress display of console information at boot.
3036c609719bSwdenk
30376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_IS_IN_ENV
3038c609719bSwdenk		If the board specific function
3039c609719bSwdenk			extern int overwrite_console (void);
3040c609719bSwdenk		returns 1, the stdin, stderr and stdout are switched to the
3041c609719bSwdenk		serial port, else the settings in the environment are used.
3042c609719bSwdenk
30436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
3044c609719bSwdenk		Enable the call to overwrite_console().
3045c609719bSwdenk
30466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
3047c609719bSwdenk		Enable overwrite of previous console environment settings.
3048c609719bSwdenk
30496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
3050c609719bSwdenk		Begin and End addresses of the area used by the
3051c609719bSwdenk		simple memory test.
3052c609719bSwdenk
30536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST:
3054c609719bSwdenk		Enable an alternate, more extensive memory test.
3055c609719bSwdenk
30566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH:
30575f535fe1Swdenk		Scratch address used by the alternate memory test
30585f535fe1Swdenk		You only need to set this if address zero isn't writeable
30595f535fe1Swdenk
30606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
30616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
306214f73ca6SStefan Roese		this specified memory area will get subtracted from the top
306311ccc33fSMarcel Ziswiler		(end) of RAM and won't get "touched" at all by U-Boot. By
306414f73ca6SStefan Roese		fixing up gd->ram_size the Linux kernel should gets passed
306514f73ca6SStefan Roese		the now "corrected" memory size and won't touch it either.
306614f73ca6SStefan Roese		This should work for arch/ppc and arch/powerpc. Only Linux
30675e12e75dSStefan Roese		board ports in arch/powerpc with bootwrapper support that
306814f73ca6SStefan Roese		recalculate the memory size from the SDRAM controller setup
30695e12e75dSStefan Roese		will have to get fixed in Linux additionally.
307014f73ca6SStefan Roese
307114f73ca6SStefan Roese		This option can be used as a workaround for the 440EPx/GRx
307214f73ca6SStefan Roese		CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
307314f73ca6SStefan Roese		be touched.
307414f73ca6SStefan Roese
307514f73ca6SStefan Roese		WARNING: Please make sure that this value is a multiple of
307614f73ca6SStefan Roese		the Linux page size (normally 4k). If this is not the case,
307714f73ca6SStefan Roese		then the end address of the Linux memory will be located at a
307814f73ca6SStefan Roese		non page size aligned address and this could cause major
307914f73ca6SStefan Roese		problems.
308014f73ca6SStefan Roese
30816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE:
3082c609719bSwdenk		Enable temporary baudrate change while serial download
3083c609719bSwdenk
30846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE:
3085c609719bSwdenk		Physical start address of SDRAM. _Must_ be 0 here.
3086c609719bSwdenk
30876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MBIO_BASE:
3088c609719bSwdenk		Physical start address of Motherboard I/O (if using a
3089c609719bSwdenk		Cogent motherboard)
3090c609719bSwdenk
30916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE:
3092c609719bSwdenk		Physical start address of Flash memory.
3093c609719bSwdenk
30946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE:
3095c609719bSwdenk		Physical start address of boot monitor code (set by
3096c609719bSwdenk		make config files to be same as the text base address
309714d0a02aSWolfgang Denk		(CONFIG_SYS_TEXT_BASE) used when linking) - same as
30986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FLASH_BASE when booting from flash.
3099c609719bSwdenk
31006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN:
31013b57fe0aSwdenk		Size of memory reserved for monitor code, used to
31023b57fe0aSwdenk		determine _at_compile_time_ (!) if the environment is
31033b57fe0aSwdenk		embedded within the U-Boot image, or in a separate
31043b57fe0aSwdenk		flash sector.
3105c609719bSwdenk
31066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN:
3107c609719bSwdenk		Size of DRAM reserved for malloc() use.
3108c609719bSwdenk
31096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN:
311015940c9aSStefan Roese		Normally compressed uImages are limited to an
311115940c9aSStefan Roese		uncompressed size of 8 MBytes. If this is not enough,
31126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		you can define CONFIG_SYS_BOOTM_LEN in your board config file
311315940c9aSStefan Roese		to adjust this setting to your needs.
3114c609719bSwdenk
31156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ:
3116c609719bSwdenk		Maximum size of memory mapped by the startup code of
3117c609719bSwdenk		the Linux kernel; all data that must be processed by
31187d721e34SBartlomiej Sieka		the Linux kernel (bd_info, boot arguments, FDT blob if
31197d721e34SBartlomiej Sieka		used) must be put below this limit, unless "bootm_low"
31207d721e34SBartlomiej Sieka		enviroment variable is defined and non-zero. In such case
31217d721e34SBartlomiej Sieka		all data for the Linux kernel must be between "bootm_low"
3122c3624e6eSGrant Likely		and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.	 The environment
3123c3624e6eSGrant Likely		variable "bootm_mapsize" will override the value of
3124c3624e6eSGrant Likely		CONFIG_SYS_BOOTMAPSZ.  If CONFIG_SYS_BOOTMAPSZ is undefined,
3125c3624e6eSGrant Likely		then the value in "bootm_size" will be used instead.
3126c609719bSwdenk
3127fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3128fca43cc8SJohn Rigby		Enable initrd_high functionality.  If defined then the
3129fca43cc8SJohn Rigby		initrd_high feature is enabled and the bootm ramdisk subcommand
3130fca43cc8SJohn Rigby		is enabled.
3131fca43cc8SJohn Rigby
3132fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_CMDLINE:
3133fca43cc8SJohn Rigby		Enables allocating and saving kernel cmdline in space between
3134fca43cc8SJohn Rigby		"bootm_low" and "bootm_low" + BOOTMAPSZ.
3135fca43cc8SJohn Rigby
3136fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_KBD:
3137fca43cc8SJohn Rigby		Enables allocating and saving a kernel copy of the bd_info in
3138fca43cc8SJohn Rigby		space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3139fca43cc8SJohn Rigby
31406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS:
3141c609719bSwdenk		Max number of Flash memory banks
3142c609719bSwdenk
31436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT:
3144c609719bSwdenk		Max number of sectors on a Flash chip
3145c609719bSwdenk
31466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT:
3147c609719bSwdenk		Timeout for Flash erase operations (in ms)
3148c609719bSwdenk
31496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT:
3150c609719bSwdenk		Timeout for Flash write operations (in ms)
3151c609719bSwdenk
31526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT
31538564acf9Swdenk		Timeout for Flash set sector lock bit operation (in ms)
31548564acf9Swdenk
31556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT
31568564acf9Swdenk		Timeout for Flash clear lock bits operation (in ms)
31578564acf9Swdenk
31586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION
31598564acf9Swdenk		If defined, hardware flash sectors protection is used
31608564acf9Swdenk		instead of U-Boot software protection.
31618564acf9Swdenk
31626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP:
3163c609719bSwdenk
3164c609719bSwdenk		Enable TFTP transfers directly to flash memory;
3165c609719bSwdenk		without this option such a download has to be
3166c609719bSwdenk		performed in two steps: (1) download to RAM, and (2)
3167c609719bSwdenk		copy from RAM to flash.
3168c609719bSwdenk
3169c609719bSwdenk		The two-step approach is usually more reliable, since
3170c609719bSwdenk		you can check if the download worked before you erase
317111ccc33fSMarcel Ziswiler		the flash, but in some situations (when system RAM is
317211ccc33fSMarcel Ziswiler		too limited to allow for a temporary copy of the
3173c609719bSwdenk		downloaded image) this option may be very useful.
3174c609719bSwdenk
31756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI:
3176c609719bSwdenk		Define if the flash driver uses extra elements in the
31775653fc33Swdenk		common flash structure for storing flash geometry.
31785653fc33Swdenk
317900b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER
31805653fc33Swdenk		This option also enables the building of the cfi_flash driver
31815653fc33Swdenk		in the drivers directory
318253cf9435Sstroese
318391809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD
318491809ed5SPiotr Ziecik		This option enables the building of the cfi_mtd driver
318591809ed5SPiotr Ziecik		in the drivers directory. The driver exports CFI flash
318691809ed5SPiotr Ziecik		to the MTD layer.
318791809ed5SPiotr Ziecik
31886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
318996ef831fSGuennadi Liakhovetski		Use buffered writes to flash.
319096ef831fSGuennadi Liakhovetski
319196ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N
319296ef831fSGuennadi Liakhovetski		s29ws-n MirrorBit flash has non-standard addresses for buffered
319396ef831fSGuennadi Liakhovetski		write commands.
319496ef831fSGuennadi Liakhovetski
31956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST
31965568e613SStefan Roese		If this option is defined, the common CFI flash doesn't
31975568e613SStefan Roese		print it's warning upon not recognized FLASH banks. This
31985568e613SStefan Roese		is useful, if some of the configured banks are only
31995568e613SStefan Roese		optionally available.
32005568e613SStefan Roese
32019a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS
32029a042e9cSJerry Van Baren		If defined (must be an integer), print out countdown
32039a042e9cSJerry Van Baren		digits and dots.  Recommended value: 45 (9..1) for 80
32049a042e9cSJerry Van Baren		column displays, 15 (3..1) for 40 column displays.
32059a042e9cSJerry Van Baren
32066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER:
320711ccc33fSMarcel Ziswiler		Defines the number of Ethernet receive buffers. On some
320811ccc33fSMarcel Ziswiler		Ethernet controllers it is recommended to set this value
320953cf9435Sstroese		to 8 or even higher (EEPRO100 or 405 EMAC), since all
321053cf9435Sstroese		buffers can be full shortly after enabling the interface
321111ccc33fSMarcel Ziswiler		on high Ethernet traffic.
321253cf9435Sstroese		Defaults to 4 if not defined.
3213c609719bSwdenk
3214ea882bafSWolfgang Denk- CONFIG_ENV_MAX_ENTRIES
3215ea882bafSWolfgang Denk
3216ea882bafSWolfgang Denk	Maximum number of entries in the hash table that is used
3217ea882bafSWolfgang Denk	internally to store the environment settings. The default
3218ea882bafSWolfgang Denk	setting is supposed to be generous and should work in most
3219ea882bafSWolfgang Denk	cases. This setting can be used to tune behaviour; see
3220ea882bafSWolfgang Denk	lib/hashtable.c for details.
3221ea882bafSWolfgang Denk
32222598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_DEFAULT
32232598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_STATIC
32242598090bSJoe Hershberger	Enable validation of the values given to enviroment variables when
32252598090bSJoe Hershberger	calling env set.  Variables can be restricted to only decimal,
32262598090bSJoe Hershberger	hexadecimal, or boolean.  If CONFIG_CMD_NET is also defined,
32272598090bSJoe Hershberger	the variables can also be restricted to IP address or MAC address.
32282598090bSJoe Hershberger
32292598090bSJoe Hershberger	The format of the list is:
32302598090bSJoe Hershberger		type_attribute = [s|d|x|b|i|m]
3231267541f7SJoe Hershberger		access_atribute = [a|r|o|c]
3232267541f7SJoe Hershberger		attributes = type_attribute[access_atribute]
32332598090bSJoe Hershberger		entry = variable_name[:attributes]
32342598090bSJoe Hershberger		list = entry[,list]
32352598090bSJoe Hershberger
32362598090bSJoe Hershberger	The type attributes are:
32372598090bSJoe Hershberger		s - String (default)
32382598090bSJoe Hershberger		d - Decimal
32392598090bSJoe Hershberger		x - Hexadecimal
32402598090bSJoe Hershberger		b - Boolean ([1yYtT|0nNfF])
32412598090bSJoe Hershberger		i - IP address
32422598090bSJoe Hershberger		m - MAC address
32432598090bSJoe Hershberger
3244267541f7SJoe Hershberger	The access attributes are:
3245267541f7SJoe Hershberger		a - Any (default)
3246267541f7SJoe Hershberger		r - Read-only
3247267541f7SJoe Hershberger		o - Write-once
3248267541f7SJoe Hershberger		c - Change-default
3249267541f7SJoe Hershberger
32502598090bSJoe Hershberger	- CONFIG_ENV_FLAGS_LIST_DEFAULT
32512598090bSJoe Hershberger		Define this to a list (string) to define the ".flags"
32522598090bSJoe Hershberger		envirnoment variable in the default or embedded environment.
32532598090bSJoe Hershberger
32542598090bSJoe Hershberger	- CONFIG_ENV_FLAGS_LIST_STATIC
32552598090bSJoe Hershberger		Define this to a list (string) to define validation that
32562598090bSJoe Hershberger		should be done if an entry is not found in the ".flags"
32572598090bSJoe Hershberger		environment variable.  To override a setting in the static
32582598090bSJoe Hershberger		list, simply add an entry for the same variable name to the
32592598090bSJoe Hershberger		".flags" variable.
32602598090bSJoe Hershberger
3261267541f7SJoe Hershberger- CONFIG_ENV_ACCESS_IGNORE_FORCE
3262267541f7SJoe Hershberger	If defined, don't allow the -f switch to env set override variable
3263267541f7SJoe Hershberger	access flags.
3264267541f7SJoe Hershberger
32655c1a7ea6SSimon Glass- CONFIG_SYS_GENERIC_BOARD
32665c1a7ea6SSimon Glass	This selects the architecture-generic board system instead of the
32675c1a7ea6SSimon Glass	architecture-specific board files. It is intended to move boards
32685c1a7ea6SSimon Glass	to this new framework over time. Defining this will disable the
32695c1a7ea6SSimon Glass	arch/foo/lib/board.c file and use common/board_f.c and
32705c1a7ea6SSimon Glass	common/board_r.c instead. To use this option your architecture
32715c1a7ea6SSimon Glass	must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in
32725c1a7ea6SSimon Glass	its config.mk file). If you find problems enabling this option on
32735c1a7ea6SSimon Glass	your board please report the problem and send patches!
32745c1a7ea6SSimon Glass
3275632efa74SSimon Glass- CONFIG_SYS_SYM_OFFSETS
3276632efa74SSimon Glass	This is set by architectures that use offsets for link symbols
3277632efa74SSimon Glass	instead of absolute values. So bss_start is obtained using an
3278632efa74SSimon Glass	offset _bss_start_ofs from CONFIG_SYS_TEXT_BASE, rather than
3279632efa74SSimon Glass	directly. You should not need to touch this setting.
3280632efa74SSimon Glass
3281632efa74SSimon Glass
3282c609719bSwdenkThe following definitions that deal with the placement and management
3283c609719bSwdenkof environment data (variable area); in general, we support the
3284c609719bSwdenkfollowing configurations:
3285c609719bSwdenk
3286c3eb3fe4SMike Frysinger- CONFIG_BUILD_ENVCRC:
3287c3eb3fe4SMike Frysinger
3288c3eb3fe4SMike Frysinger	Builds up envcrc with the target environment so that external utils
3289c3eb3fe4SMike Frysinger	may easily extract it and embed it in final U-Boot images.
3290c3eb3fe4SMike Frysinger
32915a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH:
3292c609719bSwdenk
3293c609719bSwdenk	Define this if the environment is in flash memory.
3294c609719bSwdenk
3295c609719bSwdenk	a) The environment occupies one whole flash sector, which is
3296c609719bSwdenk	   "embedded" in the text segment with the U-Boot code. This
3297c609719bSwdenk	   happens usually with "bottom boot sector" or "top boot
3298c609719bSwdenk	   sector" type flash chips, which have several smaller
3299c609719bSwdenk	   sectors at the start or the end. For instance, such a
3300c609719bSwdenk	   layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3301c609719bSwdenk	   such a case you would place the environment in one of the
3302c609719bSwdenk	   4 kB sectors - with U-Boot code before and after it. With
3303c609719bSwdenk	   "top boot sector" type flash chips, you would put the
3304c609719bSwdenk	   environment in one of the last sectors, leaving a gap
3305c609719bSwdenk	   between U-Boot and the environment.
3306c609719bSwdenk
33070e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
3308c609719bSwdenk
3309c609719bSwdenk	   Offset of environment data (variable area) to the
3310c609719bSwdenk	   beginning of flash memory; for instance, with bottom boot
3311c609719bSwdenk	   type flash chips the second sector can be used: the offset
3312c609719bSwdenk	   for this sector is given here.
3313c609719bSwdenk
33146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
3315c609719bSwdenk
33160e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
3317c609719bSwdenk
3318c609719bSwdenk	   This is just another way to specify the start address of
3319c609719bSwdenk	   the flash sector containing the environment (instead of
33200e8d1586SJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET).
3321c609719bSwdenk
33220e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SECT_SIZE:
3323c609719bSwdenk
3324c609719bSwdenk	   Size of the sector containing the environment.
3325c609719bSwdenk
3326c609719bSwdenk
3327c609719bSwdenk	b) Sometimes flash chips have few, equal sized, BIG sectors.
3328c609719bSwdenk	   In such a case you don't want to spend a whole sector for
3329c609719bSwdenk	   the environment.
3330c609719bSwdenk
33310e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3332c609719bSwdenk
33335a1aceb0SJean-Christophe PLAGNIOL-VILLARD	   If you use this in combination with CONFIG_ENV_IS_IN_FLASH
33340e8d1586SJean-Christophe PLAGNIOL-VILLARD	   and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
3335c609719bSwdenk	   of this flash sector for the environment. This saves
3336c609719bSwdenk	   memory for the RAM copy of the environment.
3337c609719bSwdenk
3338c609719bSwdenk	   It may also save flash memory if you decide to use this
3339c609719bSwdenk	   when your environment is "embedded" within U-Boot code,
3340c609719bSwdenk	   since then the remainder of the flash sector could be used
3341c609719bSwdenk	   for U-Boot code. It should be pointed out that this is
3342c609719bSwdenk	   STRONGLY DISCOURAGED from a robustness point of view:
3343c609719bSwdenk	   updating the environment in flash makes it always
3344c609719bSwdenk	   necessary to erase the WHOLE sector. If something goes
3345c609719bSwdenk	   wrong before the contents has been restored from a copy in
3346c609719bSwdenk	   RAM, your target system will be dead.
3347c609719bSwdenk
33480e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR_REDUND
33490e8d1586SJean-Christophe PLAGNIOL-VILLARD	  CONFIG_ENV_SIZE_REDUND
3350c609719bSwdenk
3351c609719bSwdenk	   These settings describe a second storage area used to hold
335211ccc33fSMarcel Ziswiler	   a redundant copy of the environment data, so that there is
33533e38691eSwdenk	   a valid backup copy in case there is a power failure during
3354c609719bSwdenk	   a "saveenv" operation.
3355c609719bSwdenk
3356c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the
3357c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds*
3358c609719bSwdenkaccordingly!
3359c609719bSwdenk
3360c609719bSwdenk
33619314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM:
3362c609719bSwdenk
3363c609719bSwdenk	Define this if you have some non-volatile memory device
3364c609719bSwdenk	(NVRAM, battery buffered SRAM) which you want to use for the
3365c609719bSwdenk	environment.
3366c609719bSwdenk
33670e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
33680e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3369c609719bSwdenk
337011ccc33fSMarcel Ziswiler	  These two #defines are used to determine the memory area you
3371c609719bSwdenk	  want to use for environment. It is assumed that this memory
3372c609719bSwdenk	  can just be read and written to, without any special
3373c609719bSwdenk	  provision.
3374c609719bSwdenk
3375c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early
3376c609719bSwdenkin U-Boot initalization (when we try to get the setting of for the
337711ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or
3378c609719bSwdenkU-Boot will hang.
3379c609719bSwdenk
3380c609719bSwdenkPlease note that even with NVRAM we still use a copy of the
3381c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to
3382c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv"
3383c609719bSwdenkto save the current settings.
3384c609719bSwdenk
3385c609719bSwdenk
3386bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM:
3387c609719bSwdenk
3388c609719bSwdenk	Use this if you have an EEPROM or similar serial access
3389c609719bSwdenk	device and a driver for it.
3390c609719bSwdenk
33910e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
33920e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3393c609719bSwdenk
3394c609719bSwdenk	  These two #defines specify the offset and size of the
3395c609719bSwdenk	  environment area within the total memory of your EEPROM.
3396c609719bSwdenk
33976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR:
3398c609719bSwdenk	  If defined, specified the chip address of the EEPROM device.
3399c609719bSwdenk	  The default address is zero.
3400c609719bSwdenk
34016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
3402c609719bSwdenk	  If defined, the number of bits used to address bytes in a
3403c609719bSwdenk	  single page in the EEPROM device.  A 64 byte page, for example
3404c609719bSwdenk	  would require six bits.
3405c609719bSwdenk
34066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
3407c609719bSwdenk	  If defined, the number of milliseconds to delay between
3408c609719bSwdenk	  page writes.	The default is zero milliseconds.
3409c609719bSwdenk
34106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
3411c609719bSwdenk	  The length in bytes of the EEPROM memory array address.  Note
3412c609719bSwdenk	  that this is NOT the chip address length!
3413c609719bSwdenk
34146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
34155cf91d6bSwdenk	  EEPROM chips that implement "address overflow" are ones
34165cf91d6bSwdenk	  like Catalyst 24WC04/08/16 which has 9/10/11 bits of
34175cf91d6bSwdenk	  address and the extra bits end up in the "chip address" bit
34185cf91d6bSwdenk	  slots. This makes a 24WC08 (1Kbyte) chip look like four 256
34195cf91d6bSwdenk	  byte chips.
34205cf91d6bSwdenk
34215cf91d6bSwdenk	  Note that we consider the length of the address field to
34225cf91d6bSwdenk	  still be one byte because the extra address bits are hidden
34235cf91d6bSwdenk	  in the chip address.
34245cf91d6bSwdenk
34256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_SIZE:
3426c609719bSwdenk	  The size in bytes of the EEPROM device.
3427c609719bSwdenk
3428548738b4SHeiko Schocher	- CONFIG_ENV_EEPROM_IS_ON_I2C
3429548738b4SHeiko Schocher	  define this, if you have I2C and SPI activated, and your
3430548738b4SHeiko Schocher	  EEPROM, which holds the environment, is on the I2C bus.
3431548738b4SHeiko Schocher
3432548738b4SHeiko Schocher	- CONFIG_I2C_ENV_EEPROM_BUS
3433548738b4SHeiko Schocher	  if you have an Environment on an EEPROM reached over
3434548738b4SHeiko Schocher	  I2C muxes, you can define here, how to reach this
3435548738b4SHeiko Schocher	  EEPROM. For example:
3436548738b4SHeiko Schocher
3437548738b4SHeiko Schocher	  #define CONFIG_I2C_ENV_EEPROM_BUS	  "pca9547:70:d\0"
3438548738b4SHeiko Schocher
3439548738b4SHeiko Schocher	  EEPROM which holds the environment, is reached over
3440548738b4SHeiko Schocher	  a pca9547 i2c mux with address 0x70, channel 3.
3441c609719bSwdenk
3442057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH:
34435779d8d9Swdenk
34445779d8d9Swdenk	Define this if you have a DataFlash memory device which you
34455779d8d9Swdenk	want to use for the environment.
34465779d8d9Swdenk
34470e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
34480e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
34490e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
34505779d8d9Swdenk
34515779d8d9Swdenk	  These three #defines specify the offset and size of the
34525779d8d9Swdenk	  environment area within the total memory of your DataFlash placed
34535779d8d9Swdenk	  at the specified address.
34545779d8d9Swdenk
34550a85a9e7SLiu Gang- CONFIG_ENV_IS_IN_REMOTE:
34560a85a9e7SLiu Gang
34570a85a9e7SLiu Gang	Define this if you have a remote memory space which you
34580a85a9e7SLiu Gang	want to use for the local device's environment.
34590a85a9e7SLiu Gang
34600a85a9e7SLiu Gang	- CONFIG_ENV_ADDR:
34610a85a9e7SLiu Gang	- CONFIG_ENV_SIZE:
34620a85a9e7SLiu Gang
34630a85a9e7SLiu Gang	  These two #defines specify the address and size of the
34640a85a9e7SLiu Gang	  environment area within the remote memory space. The
34650a85a9e7SLiu Gang	  local device can get the environment from remote memory
3466fc54c7faSLiu Gang	  space by SRIO or PCIE links.
34670a85a9e7SLiu Gang
34680a85a9e7SLiu GangBE CAREFUL! For some special cases, the local device can not use
34690a85a9e7SLiu Gang"saveenv" command. For example, the local device will get the
3470fc54c7faSLiu Gangenvironment stored in a remote NOR flash by SRIO or PCIE link,
3471fc54c7faSLiu Gangbut it can not erase, write this NOR flash by SRIO or PCIE interface.
34720a85a9e7SLiu Gang
347351bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND:
347413a5695bSwdenk
347513a5695bSwdenk	Define this if you have a NAND device which you want to use
347613a5695bSwdenk	for the environment.
347713a5695bSwdenk
34780e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
34790e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
348013a5695bSwdenk
348113a5695bSwdenk	  These two #defines specify the offset and size of the environment
3482fdd813deSScott Wood	  area within the first NAND device.  CONFIG_ENV_OFFSET must be
3483fdd813deSScott Wood	  aligned to an erase block boundary.
34845779d8d9Swdenk
3485fdd813deSScott Wood	- CONFIG_ENV_OFFSET_REDUND (optional):
3486e443c944SMarkus Klotzbuecher
34870e8d1586SJean-Christophe PLAGNIOL-VILLARD	  This setting describes a second storage area of CONFIG_ENV_SIZE
3488fdd813deSScott Wood	  size used to hold a redundant copy of the environment data, so
3489fdd813deSScott Wood	  that there is a valid backup copy in case there is a power failure
3490fdd813deSScott Wood	  during a "saveenv" operation.	 CONFIG_ENV_OFFSET_RENDUND must be
3491fdd813deSScott Wood	  aligned to an erase block boundary.
3492e443c944SMarkus Klotzbuecher
3493fdd813deSScott Wood	- CONFIG_ENV_RANGE (optional):
3494fdd813deSScott Wood
3495fdd813deSScott Wood	  Specifies the length of the region in which the environment
3496fdd813deSScott Wood	  can be written.  This should be a multiple of the NAND device's
3497fdd813deSScott Wood	  block size.  Specifying a range with more erase blocks than
3498fdd813deSScott Wood	  are needed to hold CONFIG_ENV_SIZE allows bad blocks within
3499fdd813deSScott Wood	  the range to be avoided.
3500fdd813deSScott Wood
3501fdd813deSScott Wood	- CONFIG_ENV_OFFSET_OOB (optional):
3502fdd813deSScott Wood
3503fdd813deSScott Wood	  Enables support for dynamically retrieving the offset of the
3504fdd813deSScott Wood	  environment from block zero's out-of-band data.  The
3505fdd813deSScott Wood	  "nand env.oob" command can be used to record this offset.
3506fdd813deSScott Wood	  Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
3507fdd813deSScott Wood	  using CONFIG_ENV_OFFSET_OOB.
3508e443c944SMarkus Klotzbuecher
3509b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST
3510b74ab737SGuennadi Liakhovetski
3511b74ab737SGuennadi Liakhovetski	Defines address in RAM to which the nand_spl code should copy the
3512b74ab737SGuennadi Liakhovetski	environment. If redundant environment is used, it will be copied to
3513b74ab737SGuennadi Liakhovetski	CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3514b74ab737SGuennadi Liakhovetski
35156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET
3516c609719bSwdenk
3517c609719bSwdenk	Defines offset to the initial SPI buffer area in DPRAM. The
3518c609719bSwdenk	area is used at an early stage (ROM part) if the environment
3519c609719bSwdenk	is configured to reside in the SPI EEPROM: We need a 520 byte
3520c609719bSwdenk	scratch DPRAM area. It is used between the two initialization
3521c609719bSwdenk	calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
3522c609719bSwdenk	to be a good choice since it makes it far enough from the
3523c609719bSwdenk	start of the data area as well as from the stack pointer.
3524c609719bSwdenk
3525e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor
3526c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been
3527cdb74977SWolfgang Denkcreated; also, when using EEPROM you will have to use getenv_f()
3528c609719bSwdenkuntil then to read environment variables.
3529c609719bSwdenk
353085ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor
353185ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working
353285ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is
353385ec0bccSwdenknecessary, because the first environment variable we need is the
353485ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't
353585ec0bccSwdenkhave any device yet where we could complain.]
3536c609719bSwdenk
3537c609719bSwdenkNote: once the monitor has been relocated, then it will complain if
3538c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you
353985ec0bccSwdenkuse the "saveenv" command to store a valid environment.
3540c609719bSwdenk
35416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
3542fc3e2165Swdenk		Echo the inverted Ethernet link state to the fault LED.
3543fc3e2165Swdenk
35446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
3545fc3e2165Swdenk		      also needs to be defined.
3546fc3e2165Swdenk
35476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR:
3548fc3e2165Swdenk		MII address of the PHY to check for the Ethernet link state.
3549c609719bSwdenk
3550f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS:
3551f5675aa5SRon Madrid		Define this if you desire to only have use of the NS16550_init
3552f5675aa5SRon Madrid		and NS16550_putc functions for the serial driver located at
3553f5675aa5SRon Madrid		drivers/serial/ns16550.c.  This option is useful for saving
3554f5675aa5SRon Madrid		space for already greatly restricted images, including but not
3555f5675aa5SRon Madrid		limited to NAND_SPL configurations.
3556f5675aa5SRon Madrid
3557b2b92f53SSimon Glass- CONFIG_DISPLAY_BOARDINFO
3558b2b92f53SSimon Glass		Display information about the board that U-Boot is running on
3559b2b92f53SSimon Glass		when U-Boot starts up. The board function checkboard() is called
3560b2b92f53SSimon Glass		to do this.
3561b2b92f53SSimon Glass
3562e2e3e2b1SSimon Glass- CONFIG_DISPLAY_BOARDINFO_LATE
3563e2e3e2b1SSimon Glass		Similar to the previous option, but display this information
3564e2e3e2b1SSimon Glass		later, once stdio is running and output goes to the LCD, if
3565e2e3e2b1SSimon Glass		present.
3566e2e3e2b1SSimon Glass
3567c609719bSwdenkLow Level (hardware related) configuration options:
3568dc7c9a1aSwdenk---------------------------------------------------
3569c609719bSwdenk
35706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE:
3571c609719bSwdenk		Cache Line Size of the CPU.
3572c609719bSwdenk
35736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR:
3574c609719bSwdenk		Default address of the IMMR after system reset.
35752535d602Swdenk
35762535d602Swdenk		Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
35772535d602Swdenk		and RPXsuper) to be able to adjust the position of
35782535d602Swdenk		the IMMR register after a reset.
3579c609719bSwdenk
3580e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_DEFAULT:
3581e46fedfeSTimur Tabi		Default (power-on reset) physical address of CCSR on Freescale
3582e46fedfeSTimur Tabi		PowerPC SOCs.
3583e46fedfeSTimur Tabi
3584e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR:
3585e46fedfeSTimur Tabi		Virtual address of CCSR.  On a 32-bit build, this is typically
3586e46fedfeSTimur Tabi		the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
3587e46fedfeSTimur Tabi
3588e46fedfeSTimur Tabi		CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
3589e46fedfeSTimur Tabi		for cross-platform code that uses that macro instead.
3590e46fedfeSTimur Tabi
3591e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS:
3592e46fedfeSTimur Tabi		Physical address of CCSR.  CCSR can be relocated to a new
3593e46fedfeSTimur Tabi		physical address, if desired.  In this case, this macro should
3594e46fedfeSTimur Tabi		be set to that address.	 Otherwise, it should be set to the
3595e46fedfeSTimur Tabi		same value as CONFIG_SYS_CCSRBAR_DEFAULT.  For example, CCSR
3596e46fedfeSTimur Tabi		is typically relocated on 36-bit builds.  It is recommended
3597e46fedfeSTimur Tabi		that this macro be defined via the _HIGH and _LOW macros:
3598e46fedfeSTimur Tabi
3599e46fedfeSTimur Tabi		#define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3600e46fedfeSTimur Tabi			* 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3601e46fedfeSTimur Tabi
3602e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
3603e46fedfeSTimur Tabi		Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS.	This value is typically
3604e46fedfeSTimur Tabi		either 0 (32-bit build) or 0xF (36-bit build).	This macro is
3605e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
3606e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
3607e46fedfeSTimur Tabi
3608e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_LOW:
3609e46fedfeSTimur Tabi		Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS.  This macro is
3610e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
3611e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
3612e46fedfeSTimur Tabi
3613e46fedfeSTimur Tabi- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
3614e46fedfeSTimur Tabi		If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
3615e46fedfeSTimur Tabi		forced to a value that ensures that CCSR is not relocated.
3616e46fedfeSTimur Tabi
36177f6c2cbcSwdenk- Floppy Disk Support:
36186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER
36197f6c2cbcSwdenk
36207f6c2cbcSwdenk		the default drive number (default value 0)
36217f6c2cbcSwdenk
36226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_STRIDE
36237f6c2cbcSwdenk
362411ccc33fSMarcel Ziswiler		defines the spacing between FDC chipset registers
36257f6c2cbcSwdenk		(default value 1)
36267f6c2cbcSwdenk
36276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_OFFSET
36287f6c2cbcSwdenk
36297f6c2cbcSwdenk		defines the offset of register from address. It
36307f6c2cbcSwdenk		depends on which part of the data bus is connected to
363111ccc33fSMarcel Ziswiler		the FDC chipset. (default value 0)
36327f6c2cbcSwdenk
36336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
36346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
36357f6c2cbcSwdenk		default value.
36367f6c2cbcSwdenk
36376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		if CONFIG_SYS_FDC_HW_INIT is defined, then the function
36387f6c2cbcSwdenk		fdc_hw_init() is called at the beginning of the FDC
36397f6c2cbcSwdenk		setup. fdc_hw_init() must be provided by the board
36407f6c2cbcSwdenk		source code. It is used to make hardware dependant
36417f6c2cbcSwdenk		initializations.
36427f6c2cbcSwdenk
36430abddf82SMacpaul Lin- CONFIG_IDE_AHB:
36440abddf82SMacpaul Lin		Most IDE controllers were designed to be connected with PCI
36450abddf82SMacpaul Lin		interface. Only few of them were designed for AHB interface.
36460abddf82SMacpaul Lin		When software is doing ATA command and data transfer to
36470abddf82SMacpaul Lin		IDE devices through IDE-AHB controller, some additional
36480abddf82SMacpaul Lin		registers accessing to these kind of IDE-AHB controller
36490abddf82SMacpaul Lin		is requierd.
36500abddf82SMacpaul Lin
36516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR:	Physical address of the Internal Memory.
365225d6712aSwdenk		DO NOT CHANGE unless you know exactly what you're
365325d6712aSwdenk		doing! (11-4) [MPC8xx/82xx systems only]
3654c609719bSwdenk
36556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR:
3656c609719bSwdenk
36577152b1d0Swdenk		Start address of memory area that can be used for
3658c609719bSwdenk		initial data and stack; please note that this must be
3659c609719bSwdenk		writable memory that is working WITHOUT special
3660c609719bSwdenk		initialization, i. e. you CANNOT use normal RAM which
3661c609719bSwdenk		will become available only after programming the
3662c609719bSwdenk		memory controller and running certain initialization
3663c609719bSwdenk		sequences.
3664c609719bSwdenk
3665c609719bSwdenk		U-Boot uses the following memory types:
3666c609719bSwdenk		- MPC8xx and MPC8260: IMMR (internal memory of the CPU)
3667c609719bSwdenk		- MPC824X: data cache
3668c609719bSwdenk		- PPC4xx:  data cache
3669c609719bSwdenk
36706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET:
3671c609719bSwdenk
3672c609719bSwdenk		Offset of the initial data structure in the memory
36736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
36746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
3675c609719bSwdenk		data is located at the end of the available space
3676553f0982SWolfgang Denk		(sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
36776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
36786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
36796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET) downward.
3680c609719bSwdenk
3681c609719bSwdenk	Note:
3682c609719bSwdenk		On the MPC824X (or other systems that use the data
3683c609719bSwdenk		cache for initial memory) the address chosen for
36846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
3685c609719bSwdenk		point to an otherwise UNUSED address space between
3686c609719bSwdenk		the top of RAM and the start of the PCI space.
3687c609719bSwdenk
36886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR:	SIU Module Configuration (11-6)
3689c609719bSwdenk
36906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR:	System Protection Control (11-9)
3691c609719bSwdenk
36926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR:	Time Base Status and Control (11-26)
3693c609719bSwdenk
36946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR:	Periodic Interrupt Status and Control (11-31)
3695c609719bSwdenk
36966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR:	PLL, Low-Power, and Reset Control Register (15-30)
3697c609719bSwdenk
36986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR:	System Clock and reset Control Register (15-27)
3699c609719bSwdenk
37006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM:
3701c609719bSwdenk		SDRAM timing
3702c609719bSwdenk
37036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA:
3704c609719bSwdenk		periodic timer for refresh
3705c609719bSwdenk
37066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER:	Debug Event Register (37-47)
3707c609719bSwdenk
37086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
37096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
37106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
37116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_BR1_PRELIM:
3712c609719bSwdenk		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
3713c609719bSwdenk
3714c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
37156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
37166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
3717c609719bSwdenk		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
3718c609719bSwdenk
37196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
37206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
3721c609719bSwdenk		Machine Mode Register and Memory Periodic Timer
3722c609719bSwdenk		Prescaler definitions (SDRAM timing)
3723c609719bSwdenk
37246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
3725c609719bSwdenk		enable I2C microcode relocation patch (MPC8xx);
3726c609719bSwdenk		define relocation offset in DPRAM [DSP2]
3727c609719bSwdenk
37286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
3729b423d055SHeiko Schocher		enable SMC microcode relocation patch (MPC8xx);
3730b423d055SHeiko Schocher		define relocation offset in DPRAM [SMC1]
3731b423d055SHeiko Schocher
37326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
3733c609719bSwdenk		enable SPI microcode relocation patch (MPC8xx);
3734c609719bSwdenk		define relocation offset in DPRAM [SCC4]
3735c609719bSwdenk
37366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_USE_OSCCLK:
3737c609719bSwdenk		Use OSCM clock mode on MBX8xx board. Be careful,
3738c609719bSwdenk		wrong setting might damage your board. Read
3739c609719bSwdenk		doc/README.MBX before setting this variable!
3740c609719bSwdenk
37416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
3742ea909b76Swdenk		Offset of the bootmode word in DPRAM used by post
3743ea909b76Swdenk		(Power On Self Tests). This definition overrides
3744ea909b76Swdenk		#define'd default value in commproc.h resp.
3745ea909b76Swdenk		cpm_8260.h.
3746ea909b76Swdenk
37476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
37486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
37496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
37506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
37516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
37526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
37536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
37546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
3755a47a12beSStefan Roese		Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
37565d232d0eSwdenk
37579cacf4fcSDirk Eibach- CONFIG_PCI_DISABLE_PCIE:
37589cacf4fcSDirk Eibach		Disable PCI-Express on systems where it is supported but not
37599cacf4fcSDirk Eibach		required.
37609cacf4fcSDirk Eibach
376169fd2d3bSAndrew Sharp- CONFIG_PCI_ENUM_ONLY
376269fd2d3bSAndrew Sharp		Only scan through and get the devices on the busses.
376369fd2d3bSAndrew Sharp		Don't do any setup work, presumably because someone or
376469fd2d3bSAndrew Sharp		something has already done it, and we don't need to do it
376569fd2d3bSAndrew Sharp		a second time.	Useful for platforms that are pre-booted
376669fd2d3bSAndrew Sharp		by coreboot or similar.
376769fd2d3bSAndrew Sharp
3768a09b9b68SKumar Gala- CONFIG_SYS_SRIO:
3769a09b9b68SKumar Gala		Chip has SRIO or not
3770a09b9b68SKumar Gala
3771a09b9b68SKumar Gala- CONFIG_SRIO1:
3772a09b9b68SKumar Gala		Board has SRIO 1 port available
3773a09b9b68SKumar Gala
3774a09b9b68SKumar Gala- CONFIG_SRIO2:
3775a09b9b68SKumar Gala		Board has SRIO 2 port available
3776a09b9b68SKumar Gala
3777a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_VIRT:
3778a09b9b68SKumar Gala		Virtual Address of SRIO port 'n' memory region
3779a09b9b68SKumar Gala
3780a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_PHYS:
3781a09b9b68SKumar Gala		Physical Address of SRIO port 'n' memory region
3782a09b9b68SKumar Gala
3783a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_SIZE:
3784a09b9b68SKumar Gala		Size of SRIO port 'n' memory region
3785a09b9b68SKumar Gala
3786eced4626SAlex Waterman- CONFIG_SYS_NDFC_16
3787eced4626SAlex Waterman		Defined to tell the NDFC that the NAND chip is using a
3788eced4626SAlex Waterman		16 bit bus.
3789eced4626SAlex Waterman
3790eced4626SAlex Waterman- CONFIG_SYS_NDFC_EBC0_CFG
3791eced4626SAlex Waterman		Sets the EBC0_CFG register for the NDFC. If not defined
3792eced4626SAlex Waterman		a default value will be used.
3793eced4626SAlex Waterman
3794bb99ad6dSBen Warren- CONFIG_SPD_EEPROM
3795218ca724SWolfgang Denk		Get DDR timing information from an I2C EEPROM. Common
3796218ca724SWolfgang Denk		with pluggable memory modules such as SODIMMs
3797218ca724SWolfgang Denk
3798bb99ad6dSBen Warren  SPD_EEPROM_ADDRESS
3799bb99ad6dSBen Warren		I2C address of the SPD EEPROM
3800bb99ad6dSBen Warren
38016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM
3802218ca724SWolfgang Denk		If SPD EEPROM is on an I2C bus other than the first
3803218ca724SWolfgang Denk		one, specify here. Note that the value must resolve
3804218ca724SWolfgang Denk		to something your driver can deal with.
3805bb99ad6dSBen Warren
38061b3e3c4fSYork Sun- CONFIG_SYS_DDR_RAW_TIMING
38071b3e3c4fSYork Sun		Get DDR timing information from other than SPD. Common with
38081b3e3c4fSYork Sun		soldered DDR chips onboard without SPD. DDR raw timing
38091b3e3c4fSYork Sun		parameters are extracted from datasheet and hard-coded into
38101b3e3c4fSYork Sun		header files or board specific files.
38111b3e3c4fSYork Sun
38126f5e1dc5SYork Sun- CONFIG_FSL_DDR_INTERACTIVE
38136f5e1dc5SYork Sun		Enable interactive DDR debugging. See doc/README.fsl-ddr.
38146f5e1dc5SYork Sun
38156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0
3816218ca724SWolfgang Denk		Only for 83xx systems. If specified, then DDR should
3817218ca724SWolfgang Denk		be configured using CS0 and CS1 instead of CS2 and CS3.
38182ad6b513STimur Tabi
3819c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12]
3820c26e454dSwdenk		Define to enable FEC[12] on a 8xx series processor.
3821c26e454dSwdenk
3822c26e454dSwdenk- CONFIG_FEC[12]_PHY
3823c26e454dSwdenk		Define to the hardcoded PHY address which corresponds
38246e592385Swdenk		to the given FEC; i. e.
3825c26e454dSwdenk			#define CONFIG_FEC1_PHY 4
3826c26e454dSwdenk		means that the PHY with address 4 is connected to FEC1
3827c26e454dSwdenk
3828c26e454dSwdenk		When set to -1, means to probe for first available.
3829c26e454dSwdenk
3830c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR
3831c26e454dSwdenk		The PHY does not have a RXERR line (RMII only).
3832c26e454dSwdenk		(so program the FEC to ignore it).
3833c26e454dSwdenk
3834c26e454dSwdenk- CONFIG_RMII
3835c26e454dSwdenk		Enable RMII mode for all FECs.
3836c26e454dSwdenk		Note that this is a global option, we can't
3837c26e454dSwdenk		have one FEC in standard MII mode and another in RMII mode.
3838c26e454dSwdenk
38395cf91d6bSwdenk- CONFIG_CRC32_VERIFY
38405cf91d6bSwdenk		Add a verify option to the crc32 command.
38415cf91d6bSwdenk		The syntax is:
38425cf91d6bSwdenk
38435cf91d6bSwdenk		=> crc32 -v <address> <count> <crc32>
38445cf91d6bSwdenk
38455cf91d6bSwdenk		Where address/count indicate a memory area
38465cf91d6bSwdenk		and crc32 is the correct crc32 which the
38475cf91d6bSwdenk		area should have.
38485cf91d6bSwdenk
384956523f12Swdenk- CONFIG_LOOPW
385056523f12Swdenk		Add the "loopw" memory command. This only takes effect if
3851602ad3b3SJon Loeliger		the memory commands are activated globally (CONFIG_CMD_MEM).
385256523f12Swdenk
38537b466641Sstroese- CONFIG_MX_CYCLIC
38547b466641Sstroese		Add the "mdc" and "mwc" memory commands. These are cyclic
38557b466641Sstroese		"md/mw" commands.
38567b466641Sstroese		Examples:
38577b466641Sstroese
38587b466641Sstroese		=> mdc.b 10 4 500
38597b466641Sstroese		This command will print 4 bytes (10,11,12,13) each 500 ms.
38607b466641Sstroese
38617b466641Sstroese		=> mwc.l 100 12345678 10
38627b466641Sstroese		This command will write 12345678 to address 100 all 10 ms.
38637b466641Sstroese
38647b466641Sstroese		This only takes effect if the memory commands are activated
3865602ad3b3SJon Loeliger		globally (CONFIG_CMD_MEM).
38667b466641Sstroese
38678aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT
3868afc1ce82SMacpaul Lin		[ARM, NDS32, MIPS only] If this variable is defined, then certain
3869e03f3169SWolfgang Denk		low level initializations (like setting up the memory
3870e03f3169SWolfgang Denk		controller) are omitted and/or U-Boot does not
3871e03f3169SWolfgang Denk		relocate itself into RAM.
38728aa1a2d1Swdenk
3873e03f3169SWolfgang Denk		Normally this variable MUST NOT be defined. The only
3874e03f3169SWolfgang Denk		exception is when U-Boot is loaded (to RAM) by some
3875e03f3169SWolfgang Denk		other boot loader or by a debugger which performs
3876e03f3169SWolfgang Denk		these initializations itself.
38778aa1a2d1Swdenk
3878401bb30bSAneesh V- CONFIG_SPL_BUILD
3879df81238bSMagnus Lilja		Modifies the behaviour of start.S when compiling a loader
3880df81238bSMagnus Lilja		that is executed before the actual U-Boot. E.g. when
3881df81238bSMagnus Lilja		compiling a NAND SPL.
3882400558b5Swdenk
38834213fc29SSimon Glass- CONFIG_ARCH_MAP_SYSMEM
38844213fc29SSimon Glass		Generally U-Boot (and in particular the md command) uses
38854213fc29SSimon Glass		effective address. It is therefore not necessary to regard
38864213fc29SSimon Glass		U-Boot address as virtual addresses that need to be translated
38874213fc29SSimon Glass		to physical addresses. However, sandbox requires this, since
38884213fc29SSimon Glass		it maintains its own little RAM buffer which contains all
38894213fc29SSimon Glass		addressable memory. This option causes some memory accesses
38904213fc29SSimon Glass		to be mapped through map_sysmem() / unmap_sysmem().
38914213fc29SSimon Glass
3892d8834a13SMatthias Weisser- CONFIG_USE_ARCH_MEMCPY
3893d8834a13SMatthias Weisser  CONFIG_USE_ARCH_MEMSET
3894d8834a13SMatthias Weisser		If these options are used a optimized version of memcpy/memset will
3895d8834a13SMatthias Weisser		be used if available. These functions may be faster under some
3896d8834a13SMatthias Weisser		conditions but may increase the binary size.
3897d8834a13SMatthias Weisser
3898588a13f7SSimon Glass- CONFIG_X86_RESET_VECTOR
3899588a13f7SSimon Glass		If defined, the x86 reset vector code is included. This is not
3900588a13f7SSimon Glass		needed when U-Boot is running from Coreboot.
3901b16f521aSGabe Black
3902fc33705eSMark Jackson- CONFIG_SYS_MPUCLK
3903fc33705eSMark Jackson		Defines the MPU clock speed (in MHz).
3904fc33705eSMark Jackson
3905fc33705eSMark Jackson		NOTE : currently only supported on AM335x platforms.
39065b5ece9eSGabe Black
3907f2717b47STimur TabiFreescale QE/FMAN Firmware Support:
3908f2717b47STimur Tabi-----------------------------------
3909f2717b47STimur Tabi
3910f2717b47STimur TabiThe Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
3911f2717b47STimur Tabiloading of "firmware", which is encoded in the QE firmware binary format.
3912f2717b47STimur TabiThis firmware often needs to be loaded during U-Boot booting, so macros
3913f2717b47STimur Tabiare used to identify the storage device (NOR flash, SPI, etc) and the address
3914f2717b47STimur Tabiwithin that device.
3915f2717b47STimur Tabi
3916f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_ADDR
3917f2717b47STimur Tabi	The address in the storage device where the firmware is located.  The
3918f2717b47STimur Tabi	meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
3919f2717b47STimur Tabi	is also specified.
3920f2717b47STimur Tabi
3921f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_LENGTH
3922f2717b47STimur Tabi	The maximum possible size of the firmware.  The firmware binary format
3923f2717b47STimur Tabi	has a field that specifies the actual size of the firmware, but it
3924f2717b47STimur Tabi	might not be possible to read any part of the firmware unless some
3925f2717b47STimur Tabi	local storage is allocated to hold the entire firmware first.
3926f2717b47STimur Tabi
3927f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NOR
3928f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NOR flash, mapped as
3929f2717b47STimur Tabi	normal addressable memory via the LBC.  CONFIG_SYS_FMAN_FW_ADDR is the
3930f2717b47STimur Tabi	virtual address in NOR flash.
3931f2717b47STimur Tabi
3932f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NAND
3933f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NAND flash.
3934f2717b47STimur Tabi	CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
3935f2717b47STimur Tabi
3936f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_MMC
3937f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SD/MMC
3938f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3939f2717b47STimur Tabi
3940f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
3941f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SPI
3942f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3943f2717b47STimur Tabi
3944292dc6c5SLiu Gang- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
3945292dc6c5SLiu Gang	Specifies that QE/FMAN firmware is located in the remote (master)
3946292dc6c5SLiu Gang	memory space.	CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
3947fc54c7faSLiu Gang	can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
3948fc54c7faSLiu Gang	window->master inbound window->master LAW->the ucode address in
3949fc54c7faSLiu Gang	master's memory space.
3950f2717b47STimur Tabi
3951c609719bSwdenkBuilding the Software:
3952c609719bSwdenk======================
3953c609719bSwdenk
3954218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments
3955218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support
3956218ca724SWolfgang Denkall possibly existing versions of cross development tools in all
3957218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we
3958218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
3959218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot.
3960c609719bSwdenk
3961218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you
3962218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case,
3963218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell.
3964218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are
3965218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter:
3966c609719bSwdenk
3967218ca724SWolfgang Denk	$ CROSS_COMPILE=ppc_4xx-
3968218ca724SWolfgang Denk	$ export CROSS_COMPILE
3969c609719bSwdenk
39702f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in
39712f8d396bSPeter Tyser      the tools directory you can use the MinGW toolchain
39722f8d396bSPeter Tyser      (http://www.mingw.org).  Set your HOST tools to the MinGW
39732f8d396bSPeter Tyser      toolchain and execute 'make tools'.  For example:
39742f8d396bSPeter Tyser
39752f8d396bSPeter Tyser       $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
39762f8d396bSPeter Tyser
39772f8d396bSPeter Tyser      Binaries such as tools/mkimage.exe will be created which can
39782f8d396bSPeter Tyser      be executed on computers running Windows.
39792f8d396bSPeter Tyser
3980c609719bSwdenkU-Boot is intended to be simple to build. After installing the
3981c609719bSwdenksources you must configure U-Boot for one specific board type. This
3982c609719bSwdenkis done by typing:
3983c609719bSwdenk
3984c609719bSwdenk	make NAME_config
3985c609719bSwdenk
3986218ca724SWolfgang Denkwhere "NAME_config" is the name of one of the existing configu-
39874d675ae6SMichael Jonesrations; see boards.cfg for supported names.
398854387ac9Swdenk
3989c609719bSwdenkNote: for some board special configuration names may exist; check if
3990c609719bSwdenk      additional information is available from the board vendor; for
39912729af9dSwdenk      instance, the TQM823L systems are available without (standard)
39922729af9dSwdenk      or with LCD support. You can select such additional "features"
399311ccc33fSMarcel Ziswiler      when choosing the configuration, i. e.
3994c609719bSwdenk
39952729af9dSwdenk      make TQM823L_config
39962729af9dSwdenk	- will configure for a plain TQM823L, i. e. no LCD support
3997c609719bSwdenk
3998c609719bSwdenk      make TQM823L_LCD_config
3999c609719bSwdenk	- will configure for a TQM823L with U-Boot console on LCD
4000c609719bSwdenk
4001c609719bSwdenk      etc.
4002c609719bSwdenk
4003c609719bSwdenk
4004c609719bSwdenkFinally, type "make all", and you should get some working U-Boot
40057152b1d0Swdenkimages ready for download to / installation on your system:
4006c609719bSwdenk
4007c609719bSwdenk- "u-boot.bin" is a raw binary image
4008c609719bSwdenk- "u-boot" is an image in ELF binary format
4009c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format
4010c609719bSwdenk
4011baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved
4012baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change
4013baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory:
4014baf31249SMarian Balakowicz
4015baf31249SMarian Balakowicz1. Add O= to the make command line invocations:
4016baf31249SMarian Balakowicz
4017baf31249SMarian Balakowicz	make O=/tmp/build distclean
4018baf31249SMarian Balakowicz	make O=/tmp/build NAME_config
4019baf31249SMarian Balakowicz	make O=/tmp/build all
4020baf31249SMarian Balakowicz
4021baf31249SMarian Balakowicz2. Set environment variable BUILD_DIR to point to the desired location:
4022baf31249SMarian Balakowicz
4023baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
4024baf31249SMarian Balakowicz	make distclean
4025baf31249SMarian Balakowicz	make NAME_config
4026baf31249SMarian Balakowicz	make all
4027baf31249SMarian Balakowicz
4028baf31249SMarian BalakowiczNote that the command line "O=" setting overrides the BUILD_DIR environment
4029baf31249SMarian Balakowiczvariable.
4030baf31249SMarian Balakowicz
4031c609719bSwdenk
4032c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so
4033c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of
4034c609719bSwdenknative "make".
4035c609719bSwdenk
4036c609719bSwdenk
4037c609719bSwdenkIf the system board that you have is not listed, then you will need
4038c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these
4039c609719bSwdenksteps:
4040c609719bSwdenk
4041c609719bSwdenk1.  Add a new configuration option for your board to the toplevel
40424d675ae6SMichael Jones    "boards.cfg" file, using the existing entries as examples.
40434d675ae6SMichael Jones    Follow the instructions there to keep the boards in order.
4044c609719bSwdenk2.  Create a new directory to hold your board specific code. Add any
404585ec0bccSwdenk    files you need. In your board directory, you will need at least
404685ec0bccSwdenk    the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
404785ec0bccSwdenk3.  Create a new configuration file "include/configs/<board>.h" for
404885ec0bccSwdenk    your board
4049c609719bSwdenk3.  If you're porting U-Boot to a new CPU, then also create a new
4050c609719bSwdenk    directory to hold your CPU specific code. Add any files you need.
405185ec0bccSwdenk4.  Run "make <board>_config" with your new name.
4052c609719bSwdenk5.  Type "make", and you should get a working "u-boot.srec" file
4053c609719bSwdenk    to be installed on your target system.
405485ec0bccSwdenk6.  Debug and solve any problems that might arise.
4055c609719bSwdenk    [Of course, this last step is much harder than it sounds.]
4056c609719bSwdenk
4057c609719bSwdenk
4058c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.:
4059c609719bSwdenk==============================================================
4060c609719bSwdenk
4061c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board
4062c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to
4063c609719bSwdenkprovide feedback to the other developers. The feedback normally takes
4064c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest
4065218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources.
4066c609719bSwdenk
4067c609719bSwdenkBut before you submit such a patch, please verify that your modifi-
4068c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of
4069c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so,
4070c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot
4071c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You can
40727152b1d0Swdenkselect which (cross) compiler to use by passing a `CROSS_COMPILE'
4073218ca724SWolfgang Denkenvironment variable to the script, i. e. to use the ELDK cross tools
4074218ca724SWolfgang Denkyou can type
4075c609719bSwdenk
4076c609719bSwdenk	CROSS_COMPILE=ppc_8xx- MAKEALL
4077c609719bSwdenk
4078c609719bSwdenkor to build on a native PowerPC system you can type
4079c609719bSwdenk
4080c609719bSwdenk	CROSS_COMPILE=' ' MAKEALL
4081c609719bSwdenk
4082218ca724SWolfgang DenkWhen using the MAKEALL script, the default behaviour is to build
4083218ca724SWolfgang DenkU-Boot in the source directory. This location can be changed by
4084218ca724SWolfgang Denksetting the BUILD_DIR environment variable. Also, for each target
4085218ca724SWolfgang Denkbuilt, the MAKEALL script saves two log files (<target>.ERR and
4086218ca724SWolfgang Denk<target>.MAKEALL) in the <source dir>/LOG directory. This default
4087218ca724SWolfgang Denklocation can be changed by setting the MAKEALL_LOGDIR environment
4088218ca724SWolfgang Denkvariable. For example:
4089baf31249SMarian Balakowicz
4090baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
4091baf31249SMarian Balakowicz	export MAKEALL_LOGDIR=/tmp/log
4092baf31249SMarian Balakowicz	CROSS_COMPILE=ppc_8xx- MAKEALL
4093baf31249SMarian Balakowicz
4094218ca724SWolfgang DenkWith the above settings build objects are saved in the /tmp/build,
4095218ca724SWolfgang Denklog files are saved in the /tmp/log and the source tree remains clean
4096218ca724SWolfgang Denkduring the whole build process.
4097baf31249SMarian Balakowicz
4098baf31249SMarian Balakowicz
4099c609719bSwdenkSee also "U-Boot Porting Guide" below.
4100c609719bSwdenk
4101c609719bSwdenk
4102c609719bSwdenkMonitor Commands - Overview:
4103c609719bSwdenk============================
4104c609719bSwdenk
4105c609719bSwdenkgo	- start application at address 'addr'
4106c609719bSwdenkrun	- run commands in an environment variable
4107c609719bSwdenkbootm	- boot application image from memory
4108c609719bSwdenkbootp	- boot image via network using BootP/TFTP protocol
410944f074c7SMarek Vasutbootz   - boot zImage from memory
4110c609719bSwdenktftpboot- boot image via network using TFTP protocol
4111c609719bSwdenk	       and env variables "ipaddr" and "serverip"
4112c609719bSwdenk	       (and eventually "gatewayip")
41131fb7cd49SSimon Glasstftpput - upload a file via network using TFTP protocol
4114c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol
4115c609719bSwdenkdiskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
4116c609719bSwdenkloads	- load S-Record file over serial line
4117c609719bSwdenkloadb	- load binary file over serial line (kermit mode)
4118c609719bSwdenkmd	- memory display
4119c609719bSwdenkmm	- memory modify (auto-incrementing)
4120c609719bSwdenknm	- memory modify (constant address)
4121c609719bSwdenkmw	- memory write (fill)
4122c609719bSwdenkcp	- memory copy
4123c609719bSwdenkcmp	- memory compare
4124c609719bSwdenkcrc32	- checksum calculation
41250f89c54bSPeter Tyseri2c	- I2C sub-system
4126c609719bSwdenksspi	- SPI utility commands
4127c609719bSwdenkbase	- print or set address offset
4128c609719bSwdenkprintenv- print environment variables
4129c609719bSwdenksetenv	- set environment variables
4130c609719bSwdenksaveenv - save environment variables to persistent storage
4131c609719bSwdenkprotect - enable or disable FLASH write protection
4132c609719bSwdenkerase	- erase FLASH memory
4133c609719bSwdenkflinfo	- print FLASH memory information
413410635afaSKarl O. Pincnand	- NAND memory operations (see doc/README.nand)
4135c609719bSwdenkbdinfo	- print Board Info structure
4136c609719bSwdenkiminfo	- print header information for application image
4137c609719bSwdenkconinfo - print console devices and informations
4138c609719bSwdenkide	- IDE sub-system
4139c609719bSwdenkloop	- infinite loop on address range
414056523f12Swdenkloopw	- infinite write loop on address range
4141c609719bSwdenkmtest	- simple RAM test
4142c609719bSwdenkicache	- enable or disable instruction cache
4143c609719bSwdenkdcache	- enable or disable data cache
4144c609719bSwdenkreset	- Perform RESET of the CPU
4145c609719bSwdenkecho	- echo args to console
4146c609719bSwdenkversion - print monitor version
4147c609719bSwdenkhelp	- print online help
4148c609719bSwdenk?	- alias for 'help'
4149c609719bSwdenk
4150c609719bSwdenk
4151c609719bSwdenkMonitor Commands - Detailed Description:
4152c609719bSwdenk========================================
4153c609719bSwdenk
4154c609719bSwdenkTODO.
4155c609719bSwdenk
4156c609719bSwdenkFor now: just type "help <command>".
4157c609719bSwdenk
4158c609719bSwdenk
4159c609719bSwdenkEnvironment Variables:
4160c609719bSwdenk======================
4161c609719bSwdenk
4162c609719bSwdenkU-Boot supports user configuration using Environment Variables which
4163c609719bSwdenkcan be made persistent by saving to Flash memory.
4164c609719bSwdenk
4165c609719bSwdenkEnvironment Variables are set using "setenv", printed using
4166c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv"
4167c609719bSwdenkwithout a value can be used to delete a variable from the
4168c609719bSwdenkenvironment. As long as you don't save the environment you are
4169c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the
4170c609719bSwdenkenvironment is erased by accident, a default environment is provided.
4171c609719bSwdenk
4172c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables.
4173c96f86eeSWolfgang Denk
4174c96f86eeSWolfgang DenkList of environment variables (most likely not complete):
4175c609719bSwdenk
4176c609719bSwdenk  baudrate	- see CONFIG_BAUDRATE
4177c609719bSwdenk
4178c609719bSwdenk  bootdelay	- see CONFIG_BOOTDELAY
4179c609719bSwdenk
4180c609719bSwdenk  bootcmd	- see CONFIG_BOOTCOMMAND
4181c609719bSwdenk
4182c609719bSwdenk  bootargs	- Boot arguments when booting an RTOS image
4183c609719bSwdenk
4184c609719bSwdenk  bootfile	- Name of the image to load with TFTP
4185c609719bSwdenk
41867d721e34SBartlomiej Sieka  bootm_low	- Memory range available for image processing in the bootm
41877d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
41887d721e34SBartlomiej Sieka		  a hexadecimal number and defines lowest address allowed
41897d721e34SBartlomiej Sieka		  for use by the bootm command. See also "bootm_size"
41907d721e34SBartlomiej Sieka		  environment variable. Address defined by "bootm_low" is
41917d721e34SBartlomiej Sieka		  also the base of the initial memory mapping for the Linux
4192c3624e6eSGrant Likely		  kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4193c3624e6eSGrant Likely		  bootm_mapsize.
4194c3624e6eSGrant Likely
4195c3624e6eSGrant Likely  bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
4196c3624e6eSGrant Likely		  This variable is given as a hexadecimal number and it
4197c3624e6eSGrant Likely		  defines the size of the memory region starting at base
4198c3624e6eSGrant Likely		  address bootm_low that is accessible by the Linux kernel
4199c3624e6eSGrant Likely		  during early boot.  If unset, CONFIG_SYS_BOOTMAPSZ is used
4200c3624e6eSGrant Likely		  as the default value if it is defined, and bootm_size is
4201c3624e6eSGrant Likely		  used otherwise.
42027d721e34SBartlomiej Sieka
42037d721e34SBartlomiej Sieka  bootm_size	- Memory range available for image processing in the bootm
42047d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
42057d721e34SBartlomiej Sieka		  a hexadecimal number and defines the size of the region
42067d721e34SBartlomiej Sieka		  allowed for use by the bootm command. See also "bootm_low"
42077d721e34SBartlomiej Sieka		  environment variable.
42087d721e34SBartlomiej Sieka
42094bae9090SBartlomiej Sieka  updatefile	- Location of the software update file on a TFTP server, used
42104bae9090SBartlomiej Sieka		  by the automatic software update feature. Please refer to
42114bae9090SBartlomiej Sieka		  documentation in doc/README.update for more details.
42124bae9090SBartlomiej Sieka
4213c609719bSwdenk  autoload	- if set to "no" (any string beginning with 'n'),
4214c609719bSwdenk		  "bootp" will just load perform a lookup of the
4215c609719bSwdenk		  configuration from the BOOTP server, but not try to
4216c609719bSwdenk		  load any image using TFTP
4217c609719bSwdenk
4218c609719bSwdenk  autostart	- if set to "yes", an image loaded using the "bootp",
4219c609719bSwdenk		  "rarpboot", "tftpboot" or "diskboot" commands will
4220c609719bSwdenk		  be automatically started (by internally calling
4221c609719bSwdenk		  "bootm")
4222c609719bSwdenk
42234a6fd34bSwdenk		  If set to "no", a standalone image passed to the
42244a6fd34bSwdenk		  "bootm" command will be copied to the load address
42254a6fd34bSwdenk		  (and eventually uncompressed), but NOT be started.
42264a6fd34bSwdenk		  This can be used to load and uncompress arbitrary
42274a6fd34bSwdenk		  data.
42284a6fd34bSwdenk
4229a28afca5SDavid A. Long  fdt_high	- if set this restricts the maximum address that the
4230a28afca5SDavid A. Long		  flattened device tree will be copied into upon boot.
4231fa34f6b2SShawn Guo		  For example, if you have a system with 1 GB memory
4232fa34f6b2SShawn Guo		  at physical address 0x10000000, while Linux kernel
4233fa34f6b2SShawn Guo		  only recognizes the first 704 MB as low memory, you
4234fa34f6b2SShawn Guo		  may need to set fdt_high as 0x3C000000 to have the
4235fa34f6b2SShawn Guo		  device tree blob be copied to the maximum address
4236fa34f6b2SShawn Guo		  of the 704 MB low memory, so that Linux kernel can
4237fa34f6b2SShawn Guo		  access it during the boot procedure.
4238fa34f6b2SShawn Guo
4239a28afca5SDavid A. Long		  If this is set to the special value 0xFFFFFFFF then
4240a28afca5SDavid A. Long		  the fdt will not be copied at all on boot.  For this
4241a28afca5SDavid A. Long		  to work it must reside in writable memory, have
4242a28afca5SDavid A. Long		  sufficient padding on the end of it for u-boot to
4243a28afca5SDavid A. Long		  add the information it needs into it, and the memory
4244a28afca5SDavid A. Long		  must be accessible by the kernel.
4245a28afca5SDavid A. Long
4246eea63e05SSimon Glass  fdtcontroladdr- if set this is the address of the control flattened
4247eea63e05SSimon Glass		  device tree used by U-Boot when CONFIG_OF_CONTROL is
4248eea63e05SSimon Glass		  defined.
4249eea63e05SSimon Glass
425017ea1177Swdenk  i2cfast	- (PPC405GP|PPC405EP only)
425117ea1177Swdenk		  if set to 'y' configures Linux I2C driver for fast
425217ea1177Swdenk		  mode (400kHZ). This environment variable is used in
425317ea1177Swdenk		  initialization code. So, for changes to be effective
425417ea1177Swdenk		  it must be saved and board must be reset.
425517ea1177Swdenk
4256c609719bSwdenk  initrd_high	- restrict positioning of initrd images:
4257c609719bSwdenk		  If this variable is not set, initrd images will be
4258c609719bSwdenk		  copied to the highest possible address in RAM; this
4259c609719bSwdenk		  is usually what you want since it allows for
4260c609719bSwdenk		  maximum initrd size. If for some reason you want to
4261c609719bSwdenk		  make sure that the initrd image is loaded below the
42626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		  CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
4263c609719bSwdenk		  variable to a value of "no" or "off" or "0".
4264c609719bSwdenk		  Alternatively, you can set it to a maximum upper
4265c609719bSwdenk		  address to use (U-Boot will still check that it
4266c609719bSwdenk		  does not overwrite the U-Boot stack and data).
4267c609719bSwdenk
4268c609719bSwdenk		  For instance, when you have a system with 16 MB
42697152b1d0Swdenk		  RAM, and want to reserve 4 MB from use by Linux,
4270c609719bSwdenk		  you can do this by adding "mem=12M" to the value of
4271c609719bSwdenk		  the "bootargs" variable. However, now you must make
42727152b1d0Swdenk		  sure that the initrd image is placed in the first
4273c609719bSwdenk		  12 MB as well - this can be done with
4274c609719bSwdenk
4275c609719bSwdenk		  setenv initrd_high 00c00000
4276c609719bSwdenk
427738b99261Swdenk		  If you set initrd_high to 0xFFFFFFFF, this is an
427838b99261Swdenk		  indication to U-Boot that all addresses are legal
427938b99261Swdenk		  for the Linux kernel, including addresses in flash
428038b99261Swdenk		  memory. In this case U-Boot will NOT COPY the
428138b99261Swdenk		  ramdisk at all. This may be useful to reduce the
428238b99261Swdenk		  boot time on your system, but requires that this
428338b99261Swdenk		  feature is supported by your Linux kernel.
428438b99261Swdenk
4285c609719bSwdenk  ipaddr	- IP address; needed for tftpboot command
4286c609719bSwdenk
4287c609719bSwdenk  loadaddr	- Default load address for commands like "bootp",
4288dc7c9a1aSwdenk		  "rarpboot", "tftpboot", "loadb" or "diskboot"
4289c609719bSwdenk
4290c609719bSwdenk  loads_echo	- see CONFIG_LOADS_ECHO
4291c609719bSwdenk
4292c609719bSwdenk  serverip	- TFTP server IP address; needed for tftpboot command
4293c609719bSwdenk
4294c609719bSwdenk  bootretry	- see CONFIG_BOOT_RETRY_TIME
4295c609719bSwdenk
4296c609719bSwdenk  bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
4297c609719bSwdenk
4298c609719bSwdenk  bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
4299c609719bSwdenk
4300e2a53458SMike Frysinger  ethprime	- controls which interface is used first.
4301a3d991bdSwdenk
4302e2a53458SMike Frysinger  ethact	- controls which interface is currently active.
4303e2a53458SMike Frysinger		  For example you can do the following
4304a3d991bdSwdenk
430548690d80SHeiko Schocher		  => setenv ethact FEC
430648690d80SHeiko Schocher		  => ping 192.168.0.1 # traffic sent on FEC
430748690d80SHeiko Schocher		  => setenv ethact SCC
430848690d80SHeiko Schocher		  => ping 10.0.0.1 # traffic sent on SCC
4309a3d991bdSwdenk
4310e1692577SMatthias Fuchs  ethrotate	- When set to "no" U-Boot does not go through all
4311e1692577SMatthias Fuchs		  available network interfaces.
4312e1692577SMatthias Fuchs		  It just stays at the currently selected interface.
4313e1692577SMatthias Fuchs
4314a3d991bdSwdenk  netretry	- When set to "no" each network operation will
4315a3d991bdSwdenk		  either succeed or fail without retrying.
43166e592385Swdenk		  When set to "once" the network operation will
43176e592385Swdenk		  fail when all the available network interfaces
43186e592385Swdenk		  are tried once without success.
4319a3d991bdSwdenk		  Useful on scripts which control the retry operation
4320a3d991bdSwdenk		  themselves.
4321a3d991bdSwdenk
4322b4e2f89dSJean-Christophe PLAGNIOL-VILLARD  npe_ucode	- set load address for the NPE microcode
4323a1cf027aSJean-Christophe PLAGNIOL-VILLARD
432428cb9375SWolfgang Denk  tftpsrcport	- If this is set, the value is used for TFTP's
4325ecb0ccd9SWolfgang Denk		  UDP source port.
4326ecb0ccd9SWolfgang Denk
432728cb9375SWolfgang Denk  tftpdstport	- If this is set, the value is used for TFTP's UDP
432828cb9375SWolfgang Denk		  destination port instead of the Well Know Port 69.
432928cb9375SWolfgang Denk
4330c96f86eeSWolfgang Denk  tftpblocksize - Block size to use for TFTP transfers; if not set,
4331c96f86eeSWolfgang Denk		  we use the TFTP server's default block size
4332c96f86eeSWolfgang Denk
4333c96f86eeSWolfgang Denk  tftptimeout	- Retransmission timeout for TFTP packets (in milli-
4334c96f86eeSWolfgang Denk		  seconds, minimum value is 1000 = 1 second). Defines
4335c96f86eeSWolfgang Denk		  when a packet is considered to be lost so it has to
4336c96f86eeSWolfgang Denk		  be retransmitted. The default is 5000 = 5 seconds.
4337c96f86eeSWolfgang Denk		  Lowering this value may make downloads succeed
4338c96f86eeSWolfgang Denk		  faster in networks with high packet loss rates or
4339c96f86eeSWolfgang Denk		  with unreliable TFTP servers.
4340c96f86eeSWolfgang Denk
4341a3d991bdSwdenk  vlan		- When set to a value < 4095 the traffic over
434211ccc33fSMarcel Ziswiler		  Ethernet is encapsulated/received over 802.1q
4343a3d991bdSwdenk		  VLAN tagged frames.
4344c609719bSwdenk
4345dc0b7b0eSJason HobbsThe following image location variables contain the location of images
4346dc0b7b0eSJason Hobbsused in booting. The "Image" column gives the role of the image and is
4347dc0b7b0eSJason Hobbsnot an environment variable name. The other columns are environment
4348dc0b7b0eSJason Hobbsvariable names. "File Name" gives the name of the file on a TFTP
4349dc0b7b0eSJason Hobbsserver, "RAM Address" gives the location in RAM the image will be
4350dc0b7b0eSJason Hobbsloaded to, and "Flash Location" gives the image's address in NOR
4351dc0b7b0eSJason Hobbsflash or offset in NAND flash.
4352dc0b7b0eSJason Hobbs
4353dc0b7b0eSJason Hobbs*Note* - these variables don't have to be defined for all boards, some
4354dc0b7b0eSJason Hobbsboards currenlty use other variables for these purposes, and some
4355dc0b7b0eSJason Hobbsboards use these variables for other purposes.
4356dc0b7b0eSJason Hobbs
4357dc0b7b0eSJason HobbsImage		    File Name	     RAM Address       Flash Location
4358dc0b7b0eSJason Hobbs-----		    ---------	     -----------       --------------
4359dc0b7b0eSJason Hobbsu-boot		    u-boot	     u-boot_addr_r     u-boot_addr
4360dc0b7b0eSJason HobbsLinux kernel	    bootfile	     kernel_addr_r     kernel_addr
4361dc0b7b0eSJason Hobbsdevice tree blob    fdtfile	     fdt_addr_r	       fdt_addr
4362dc0b7b0eSJason Hobbsramdisk		    ramdiskfile	     ramdisk_addr_r    ramdisk_addr
4363dc0b7b0eSJason Hobbs
4364c609719bSwdenkThe following environment variables may be used and automatically
4365c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"),
4366c609719bSwdenkdepending the information provided by your boot server:
4367c609719bSwdenk
4368c609719bSwdenk  bootfile	- see above
4369c609719bSwdenk  dnsip		- IP address of your Domain Name Server
4370fe389a82Sstroese  dnsip2	- IP address of your secondary Domain Name Server
4371c609719bSwdenk  gatewayip	- IP address of the Gateway (Router) to use
4372c609719bSwdenk  hostname	- Target hostname
4373c609719bSwdenk  ipaddr	- see above
4374c609719bSwdenk  netmask	- Subnet Mask
4375c609719bSwdenk  rootpath	- Pathname of the root filesystem on the NFS server
4376c609719bSwdenk  serverip	- see above
4377c609719bSwdenk
4378c609719bSwdenk
4379c609719bSwdenkThere are two special Environment Variables:
4380c609719bSwdenk
4381c609719bSwdenk  serial#	- contains hardware identification information such
4382c609719bSwdenk		  as type string and/or serial number
4383c609719bSwdenk  ethaddr	- Ethernet address
4384c609719bSwdenk
4385c609719bSwdenkThese variables can be set only once (usually during manufacturing of
4386c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables
4387c609719bSwdenkonce they have been set once.
4388c609719bSwdenk
4389c609719bSwdenk
4390c1551ea8SstroeseFurther special Environment Variables:
4391c1551ea8Sstroese
4392c1551ea8Sstroese  ver		- Contains the U-Boot version string as printed
4393c1551ea8Sstroese		  with the "version" command. This variable is
4394c1551ea8Sstroese		  readonly (see CONFIG_VERSION_VARIABLE).
4395c1551ea8Sstroese
4396c1551ea8Sstroese
4397c609719bSwdenkPlease note that changes to some configuration parameters may take
4398c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-).
4399c609719bSwdenk
4400c609719bSwdenk
4401170ab110SJoe HershbergerCallback functions for environment variables:
4402170ab110SJoe Hershberger---------------------------------------------
4403170ab110SJoe Hershberger
4404170ab110SJoe HershbergerFor some environment variables, the behavior of u-boot needs to change
4405170ab110SJoe Hershbergerwhen their values are changed.  This functionailty allows functions to
4406170ab110SJoe Hershbergerbe associated with arbitrary variables.  On creation, overwrite, or
4407170ab110SJoe Hershbergerdeletion, the callback will provide the opportunity for some side
4408170ab110SJoe Hershbergereffect to happen or for the change to be rejected.
4409170ab110SJoe Hershberger
4410170ab110SJoe HershbergerThe callbacks are named and associated with a function using the
4411170ab110SJoe HershbergerU_BOOT_ENV_CALLBACK macro in your board or driver code.
4412170ab110SJoe Hershberger
4413170ab110SJoe HershbergerThese callbacks are associated with variables in one of two ways.  The
4414170ab110SJoe Hershbergerstatic list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
4415170ab110SJoe Hershbergerin the board configuration to a string that defines a list of
4416170ab110SJoe Hershbergerassociations.  The list must be in the following format:
4417170ab110SJoe Hershberger
4418170ab110SJoe Hershberger	entry = variable_name[:callback_name]
4419170ab110SJoe Hershberger	list = entry[,list]
4420170ab110SJoe Hershberger
4421170ab110SJoe HershbergerIf the callback name is not specified, then the callback is deleted.
4422170ab110SJoe HershbergerSpaces are also allowed anywhere in the list.
4423170ab110SJoe Hershberger
4424170ab110SJoe HershbergerCallbacks can also be associated by defining the ".callbacks" variable
4425170ab110SJoe Hershbergerwith the same list format above.  Any association in ".callbacks" will
4426170ab110SJoe Hershbergeroverride any association in the static list. You can define
4427170ab110SJoe HershbergerCONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
4428170ab110SJoe Hershberger".callbacks" envirnoment variable in the default or embedded environment.
4429170ab110SJoe Hershberger
4430170ab110SJoe Hershberger
4431f07771ccSwdenkCommand Line Parsing:
4432f07771ccSwdenk=====================
4433f07771ccSwdenk
4434f07771ccSwdenkThere are two different command line parsers available with U-Boot:
44357152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell:
4436f07771ccSwdenk
4437f07771ccSwdenkOld, simple command line parser:
4438f07771ccSwdenk--------------------------------
4439f07771ccSwdenk
4440f07771ccSwdenk- supports environment variables (through setenv / saveenv commands)
4441f07771ccSwdenk- several commands on one line, separated by ';'
4442fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax
4443f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\',
4444f07771ccSwdenk  for example:
4445fe126d8bSWolfgang Denk	setenv bootcmd bootm \${address}
4446f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example:
4447f07771ccSwdenk	setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
4448f07771ccSwdenk
4449f07771ccSwdenkHush shell:
4450f07771ccSwdenk-----------
4451f07771ccSwdenk
4452f07771ccSwdenk- similar to Bourne shell, with control structures like
4453f07771ccSwdenk  if...then...else...fi, for...do...done; while...do...done,
4454f07771ccSwdenk  until...do...done, ...
4455f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv
4456f07771ccSwdenk  commands) and local shell variables (through standard shell syntax
4457f07771ccSwdenk  "name=value"); only environment variables can be used with "run"
4458f07771ccSwdenk  command
4459f07771ccSwdenk
4460f07771ccSwdenkGeneral rules:
4461f07771ccSwdenk--------------
4462f07771ccSwdenk
4463f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run"
4464f07771ccSwdenk    command) contains several commands separated by semicolon, and
4465f07771ccSwdenk    one of these commands fails, then the remaining commands will be
4466f07771ccSwdenk    executed anyway.
4467f07771ccSwdenk
4468f07771ccSwdenk(2) If you execute several variables with one call to run (i. e.
446911ccc33fSMarcel Ziswiler    calling run with a list of variables as arguments), any failing
4470f07771ccSwdenk    command will cause "run" to terminate, i. e. the remaining
4471f07771ccSwdenk    variables are not executed.
4472f07771ccSwdenk
4473c609719bSwdenkNote for Redundant Ethernet Interfaces:
4474c609719bSwdenk=======================================
4475c609719bSwdenk
447611ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports
4477c609719bSwdenksuch configurations and is capable of automatic selection of a
44787152b1d0Swdenk"working" interface when needed. MAC assignment works as follows:
4479c609719bSwdenk
4480c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding
4481c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0),
4482c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ...
4483c609719bSwdenk
4484c609719bSwdenkIf the network interface stores some valid MAC address (for instance
4485c609719bSwdenkin SROM), this is used as default address if there is NO correspon-
4486c609719bSwdenkding setting in the environment; if the corresponding environment
4487c609719bSwdenkvariable is set, this overrides the settings in the card; that means:
4488c609719bSwdenk
4489c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the
4490c609719bSwdenk  environment, the SROM's address is used.
4491c609719bSwdenk
4492c609719bSwdenko If there is no valid address in the SROM, and a definition in the
4493c609719bSwdenk  environment exists, then the value from the environment variable is
4494c609719bSwdenk  used.
4495c609719bSwdenk
4496c609719bSwdenko If both the SROM and the environment contain a MAC address, and
4497c609719bSwdenk  both addresses are the same, this MAC address is used.
4498c609719bSwdenk
4499c609719bSwdenko If both the SROM and the environment contain a MAC address, and the
4500c609719bSwdenk  addresses differ, the value from the environment is used and a
4501c609719bSwdenk  warning is printed.
4502c609719bSwdenk
4503c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error
4504c609719bSwdenk  is raised.
4505c609719bSwdenk
4506ecee9324SBen WarrenIf Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
4507ecee9324SBen Warrenwill be programmed into hardware as part of the initialization process.	 This
4508ecee9324SBen Warrenmay be skipped by setting the appropriate 'ethmacskip' environment variable.
4509ecee9324SBen WarrenThe naming convention is as follows:
4510ecee9324SBen Warren"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
4511c609719bSwdenk
4512c609719bSwdenkImage Formats:
4513c609719bSwdenk==============
4514c609719bSwdenk
45153310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on)
45163310c549SMarian Balakowiczimages in two formats:
45173310c549SMarian Balakowicz
45183310c549SMarian BalakowiczNew uImage format (FIT)
45193310c549SMarian Balakowicz-----------------------
45203310c549SMarian Balakowicz
45213310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar
45223310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple
45233310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by
45243310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
45253310c549SMarian Balakowicz
45263310c549SMarian Balakowicz
45273310c549SMarian BalakowiczOld uImage format
45283310c549SMarian Balakowicz-----------------
45293310c549SMarian Balakowicz
45303310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything,
45313310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for
45323310c549SMarian Balakowiczdetails; basically, the header defines the following image properties:
4533c609719bSwdenk
4534c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
4535c609719bSwdenk  4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
4536f5ed9e39SPeter Tyser  LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
4537f5ed9e39SPeter Tyser  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
4538f5ed9e39SPeter Tyser  INTEGRITY).
45397b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
4540afc1ce82SMacpaul Lin  IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
4541afc1ce82SMacpaul Lin  Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
4542c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2)
4543c609719bSwdenk* Load Address
4544c609719bSwdenk* Entry Point
4545c609719bSwdenk* Image Name
4546c609719bSwdenk* Image Timestamp
4547c609719bSwdenk
4548c609719bSwdenkThe header is marked by a special Magic Number, and both the header
4549c609719bSwdenkand the data portions of the image are secured against corruption by
4550c609719bSwdenkCRC32 checksums.
4551c609719bSwdenk
4552c609719bSwdenk
4553c609719bSwdenkLinux Support:
4554c609719bSwdenk==============
4555c609719bSwdenk
4556c609719bSwdenkAlthough U-Boot should support any OS or standalone application
45577152b1d0Swdenkeasily, the main focus has always been on Linux during the design of
4558c609719bSwdenkU-Boot.
4559c609719bSwdenk
4560c609719bSwdenkU-Boot includes many features that so far have been part of some
4561c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any
4562c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image;
4563c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation
45647152b1d0Swdenkserves several purposes:
4565c609719bSwdenk
4566c609719bSwdenk- the same features can be used for other OS or standalone
4567c609719bSwdenk  applications (for instance: using compressed images to reduce the
4568c609719bSwdenk  Flash memory footprint)
4569c609719bSwdenk
4570c609719bSwdenk- it becomes much easier to port new Linux kernel versions because
45717152b1d0Swdenk  lots of low-level, hardware dependent stuff are done by U-Boot
4572c609719bSwdenk
4573c609719bSwdenk- the same Linux kernel image can now be used with different "initrd"
4574c609719bSwdenk  images; of course this also means that different kernel images can
4575c609719bSwdenk  be run with the same "initrd". This makes testing easier (you don't
4576c609719bSwdenk  have to build a new "zImage.initrd" Linux image when you just
4577c609719bSwdenk  change a file in your "initrd"). Also, a field-upgrade of the
4578c609719bSwdenk  software is easier now.
4579c609719bSwdenk
4580c609719bSwdenk
4581c609719bSwdenkLinux HOWTO:
4582c609719bSwdenk============
4583c609719bSwdenk
4584c609719bSwdenkPorting Linux to U-Boot based systems:
4585c609719bSwdenk---------------------------------------
4586c609719bSwdenk
4587c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to
4588c609719bSwdenkconfigure the Linux device drivers for use with your target hardware
4589c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to
4590c609719bSwdenkLinux :-).
4591c609719bSwdenk
4592a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
4593c609719bSwdenk
4594c609719bSwdenkJust make sure your machine specific header file (for instance
4595c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board
45961dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h,
45971dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value
45986d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR.
4599c609719bSwdenk
4600c609719bSwdenk
4601c609719bSwdenkConfiguring the Linux kernel:
4602c609719bSwdenk-----------------------------
4603c609719bSwdenk
4604c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root
4605c609719bSwdenkdevice (initial ramdisk, NFS) for your target system.
4606c609719bSwdenk
4607c609719bSwdenk
4608c609719bSwdenkBuilding a Linux Image:
4609c609719bSwdenk-----------------------
4610c609719bSwdenk
461124ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are
461224ee89b9Swdenknot used. If you use recent kernel source, a new build target
461324ee89b9Swdenk"uImage" will exist which automatically builds an image usable by
461424ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target,
461524ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a
461624ee89b9Swdenk100% compatible format.
4617c609719bSwdenk
4618c609719bSwdenkExample:
4619c609719bSwdenk
4620c609719bSwdenk	make TQM850L_config
4621c609719bSwdenk	make oldconfig
4622c609719bSwdenk	make dep
462324ee89b9Swdenk	make uImage
4624c609719bSwdenk
462524ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to
462624ee89b9Swdenkencapsulate a compressed Linux kernel image with header	 information,
462724ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing:
4628c609719bSwdenk
462924ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format):
463024ee89b9Swdenk
463124ee89b9Swdenk* convert the kernel into a raw binary image:
463224ee89b9Swdenk
463324ee89b9Swdenk	${CROSS_COMPILE}-objcopy -O binary \
463424ee89b9Swdenk				 -R .note -R .comment \
463524ee89b9Swdenk				 -S vmlinux linux.bin
463624ee89b9Swdenk
463724ee89b9Swdenk* compress the binary image:
463824ee89b9Swdenk
463924ee89b9Swdenk	gzip -9 linux.bin
464024ee89b9Swdenk
464124ee89b9Swdenk* package compressed binary image for U-Boot:
464224ee89b9Swdenk
464324ee89b9Swdenk	mkimage -A ppc -O linux -T kernel -C gzip \
464424ee89b9Swdenk		-a 0 -e 0 -n "Linux Kernel Image" \
464524ee89b9Swdenk		-d linux.bin.gz uImage
464624ee89b9Swdenk
464724ee89b9Swdenk
464824ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use
464924ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or
465024ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64
465124ee89b9Swdenkbyte header containing information about target architecture,
465224ee89b9Swdenkoperating system, image type, compression method, entry points, time
465324ee89b9Swdenkstamp, CRC32 checksums, etc.
465424ee89b9Swdenk
465524ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and
465624ee89b9Swdenkprint the header information, or to build new images.
4657c609719bSwdenk
4658c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information
4659c609719bSwdenkcontained in the header of an existing U-Boot image; this includes
4660c609719bSwdenkchecksum verification:
4661c609719bSwdenk
4662c609719bSwdenk	tools/mkimage -l image
4663c609719bSwdenk	  -l ==> list image header information
4664c609719bSwdenk
4665c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image
4666c609719bSwdenkfrom a "data file" which is used as image payload:
4667c609719bSwdenk
4668c609719bSwdenk	tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
4669c609719bSwdenk		      -n name -d data_file image
4670c609719bSwdenk	  -A ==> set architecture to 'arch'
4671c609719bSwdenk	  -O ==> set operating system to 'os'
4672c609719bSwdenk	  -T ==> set image type to 'type'
4673c609719bSwdenk	  -C ==> set compression type 'comp'
4674c609719bSwdenk	  -a ==> set load address to 'addr' (hex)
4675c609719bSwdenk	  -e ==> set entry point to 'ep' (hex)
4676c609719bSwdenk	  -n ==> set image name to 'name'
4677c609719bSwdenk	  -d ==> use image data from 'datafile'
4678c609719bSwdenk
467969459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load
468069459791Swdenkaddress (0x00000000), but the entry point address depends on the
468169459791Swdenkkernel version:
4682c609719bSwdenk
4683c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C,
468424ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000.
4685c609719bSwdenk
4686c609719bSwdenkSo a typical call to build a U-Boot image would read:
4687c609719bSwdenk
468824ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
468924ee89b9Swdenk	> -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
4690a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
469124ee89b9Swdenk	> examples/uImage.TQM850L
469224ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
4693c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
4694c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
4695c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
4696c609719bSwdenk	Load Address: 0x00000000
469724ee89b9Swdenk	Entry Point:  0x00000000
4698c609719bSwdenk
4699c609719bSwdenkTo verify the contents of the image (or check for corruption):
4700c609719bSwdenk
470124ee89b9Swdenk	-> tools/mkimage -l examples/uImage.TQM850L
470224ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
4703c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
4704c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
4705c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
4706c609719bSwdenk	Load Address: 0x00000000
470724ee89b9Swdenk	Entry Point:  0x00000000
4708c609719bSwdenk
4709c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade
4710c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this
4711c609719bSwdenkneeds more space in Flash, but boots much faster since it does not
4712c609719bSwdenkneed to be uncompressed:
4713c609719bSwdenk
4714a47a12beSStefan Roese	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
471524ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
471624ee89b9Swdenk	> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
4717a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
471824ee89b9Swdenk	> examples/uImage.TQM850L-uncompressed
471924ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
4720c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
4721c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (uncompressed)
4722c609719bSwdenk	Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
4723c609719bSwdenk	Load Address: 0x00000000
472424ee89b9Swdenk	Entry Point:  0x00000000
4725c609719bSwdenk
4726c609719bSwdenk
4727c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file
4728c609719bSwdenkwhen your kernel is intended to use an initial ramdisk:
4729c609719bSwdenk
4730c609719bSwdenk	-> tools/mkimage -n 'Simple Ramdisk Image' \
4731c609719bSwdenk	> -A ppc -O linux -T ramdisk -C gzip \
4732c609719bSwdenk	> -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
4733c609719bSwdenk	Image Name:   Simple Ramdisk Image
4734c609719bSwdenk	Created:      Wed Jan 12 14:01:50 2000
4735c609719bSwdenk	Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
4736c609719bSwdenk	Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
4737c609719bSwdenk	Load Address: 0x00000000
4738c609719bSwdenk	Entry Point:  0x00000000
4739c609719bSwdenk
4740c609719bSwdenk
4741c609719bSwdenkInstalling a Linux Image:
4742c609719bSwdenk-------------------------
4743c609719bSwdenk
4744c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface,
4745c609719bSwdenkyou must convert the image to S-Record format:
4746c609719bSwdenk
4747c609719bSwdenk	objcopy -I binary -O srec examples/image examples/image.srec
4748c609719bSwdenk
4749c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot
4750c609719bSwdenkimage header, so the resulting S-Record file will be relative to
4751c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to
4752c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads'
4753c609719bSwdenkcommand.
4754c609719bSwdenk
4755c609719bSwdenkExample: install the image to address 0x40100000 (which on the
4756c609719bSwdenkTQM8xxL is in the first Flash bank):
4757c609719bSwdenk
4758c609719bSwdenk	=> erase 40100000 401FFFFF
4759c609719bSwdenk
4760c609719bSwdenk	.......... done
4761c609719bSwdenk	Erased 8 sectors
4762c609719bSwdenk
4763c609719bSwdenk	=> loads 40100000
4764c609719bSwdenk	## Ready for S-Record download ...
4765c609719bSwdenk	~>examples/image.srec
4766c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 12 13 ...
4767c609719bSwdenk	...
4768c609719bSwdenk	15989 15990 15991 15992
4769c609719bSwdenk	[file transfer complete]
4770c609719bSwdenk	[connected]
4771c609719bSwdenk	## Start Addr = 0x00000000
4772c609719bSwdenk
4773c609719bSwdenk
4774c609719bSwdenkYou can check the success of the download using the 'iminfo' command;
4775c609719bSwdenkthis includes a checksum verification so you can be sure no data
4776c609719bSwdenkcorruption happened:
4777c609719bSwdenk
4778c609719bSwdenk	=> imi 40100000
4779c609719bSwdenk
4780c609719bSwdenk	## Checking Image at 40100000 ...
4781c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
4782c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
4783c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
4784c609719bSwdenk	   Load Address: 00000000
4785c609719bSwdenk	   Entry Point:	 0000000c
4786c609719bSwdenk	   Verifying Checksum ... OK
4787c609719bSwdenk
4788c609719bSwdenk
4789c609719bSwdenkBoot Linux:
4790c609719bSwdenk-----------
4791c609719bSwdenk
4792c609719bSwdenkThe "bootm" command is used to boot an application that is stored in
4793c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents
4794c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as
4795c609719bSwdenkparameters. You can check and modify this variable using the
4796c609719bSwdenk"printenv" and "setenv" commands:
4797c609719bSwdenk
4798c609719bSwdenk
4799c609719bSwdenk	=> printenv bootargs
4800c609719bSwdenk	bootargs=root=/dev/ram
4801c609719bSwdenk
4802c609719bSwdenk	=> setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4803c609719bSwdenk
4804c609719bSwdenk	=> printenv bootargs
4805c609719bSwdenk	bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4806c609719bSwdenk
4807c609719bSwdenk	=> bootm 40020000
4808c609719bSwdenk	## Booting Linux kernel at 40020000 ...
4809c609719bSwdenk	   Image Name:	 2.2.13 for NFS on TQM850L
4810c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
4811c609719bSwdenk	   Data Size:	 381681 Bytes = 372 kB = 0 MB
4812c609719bSwdenk	   Load Address: 00000000
4813c609719bSwdenk	   Entry Point:	 0000000c
4814c609719bSwdenk	   Verifying Checksum ... OK
4815c609719bSwdenk	   Uncompressing Kernel Image ... OK
4816c609719bSwdenk	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
4817c609719bSwdenk	Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4818c609719bSwdenk	time_init: decrementer frequency = 187500000/60
4819c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
4820c609719bSwdenk	Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
4821c609719bSwdenk	...
4822c609719bSwdenk
482311ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass
48247152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT
4825c609719bSwdenkformat!) to the "bootm" command:
4826c609719bSwdenk
4827c609719bSwdenk	=> imi 40100000 40200000
4828c609719bSwdenk
4829c609719bSwdenk	## Checking Image at 40100000 ...
4830c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
4831c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
4832c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
4833c609719bSwdenk	   Load Address: 00000000
4834c609719bSwdenk	   Entry Point:	 0000000c
4835c609719bSwdenk	   Verifying Checksum ... OK
4836c609719bSwdenk
4837c609719bSwdenk	## Checking Image at 40200000 ...
4838c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
4839c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
4840c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
4841c609719bSwdenk	   Load Address: 00000000
4842c609719bSwdenk	   Entry Point:	 00000000
4843c609719bSwdenk	   Verifying Checksum ... OK
4844c609719bSwdenk
4845c609719bSwdenk	=> bootm 40100000 40200000
4846c609719bSwdenk	## Booting Linux kernel at 40100000 ...
4847c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
4848c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
4849c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
4850c609719bSwdenk	   Load Address: 00000000
4851c609719bSwdenk	   Entry Point:	 0000000c
4852c609719bSwdenk	   Verifying Checksum ... OK
4853c609719bSwdenk	   Uncompressing Kernel Image ... OK
4854c609719bSwdenk	## Loading RAMDisk Image at 40200000 ...
4855c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
4856c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
4857c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
4858c609719bSwdenk	   Load Address: 00000000
4859c609719bSwdenk	   Entry Point:	 00000000
4860c609719bSwdenk	   Verifying Checksum ... OK
4861c609719bSwdenk	   Loading Ramdisk ... OK
4862c609719bSwdenk	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
4863c609719bSwdenk	Boot arguments: root=/dev/ram
4864c609719bSwdenk	time_init: decrementer frequency = 187500000/60
4865c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
4866c609719bSwdenk	...
4867c609719bSwdenk	RAMDISK: Compressed image found at block 0
4868c609719bSwdenk	VFS: Mounted root (ext2 filesystem).
4869c609719bSwdenk
4870c609719bSwdenk	bash#
4871c609719bSwdenk
48720267768eSMatthew McClintockBoot Linux and pass a flat device tree:
48730267768eSMatthew McClintock-----------
48740267768eSMatthew McClintock
48750267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section
48760267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The
48770267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated
48780267768eSMatthew McClintockflat device tree:
48790267768eSMatthew McClintock
48800267768eSMatthew McClintock=> print oftaddr
48810267768eSMatthew McClintockoftaddr=0x300000
48820267768eSMatthew McClintock=> print oft
48830267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb
48840267768eSMatthew McClintock=> tftp $oftaddr $oft
48850267768eSMatthew McClintockSpeed: 1000, full duplex
48860267768eSMatthew McClintockUsing TSEC0 device
48870267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101
48880267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'.
48890267768eSMatthew McClintockLoad address: 0x300000
48900267768eSMatthew McClintockLoading: #
48910267768eSMatthew McClintockdone
48920267768eSMatthew McClintockBytes transferred = 4106 (100a hex)
48930267768eSMatthew McClintock=> tftp $loadaddr $bootfile
48940267768eSMatthew McClintockSpeed: 1000, full duplex
48950267768eSMatthew McClintockUsing TSEC0 device
48960267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2
48970267768eSMatthew McClintockFilename 'uImage'.
48980267768eSMatthew McClintockLoad address: 0x200000
48990267768eSMatthew McClintockLoading:############
49000267768eSMatthew McClintockdone
49010267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex)
49020267768eSMatthew McClintock=> print loadaddr
49030267768eSMatthew McClintockloadaddr=200000
49040267768eSMatthew McClintock=> print oftaddr
49050267768eSMatthew McClintockoftaddr=0x300000
49060267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr
49070267768eSMatthew McClintock## Booting image at 00200000 ...
49080267768eSMatthew McClintock   Image Name:	 Linux-2.6.17-dirty
49090267768eSMatthew McClintock   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
49100267768eSMatthew McClintock   Data Size:	 1029343 Bytes = 1005.2 kB
49110267768eSMatthew McClintock   Load Address: 00000000
49120267768eSMatthew McClintock   Entry Point:	 00000000
49130267768eSMatthew McClintock   Verifying Checksum ... OK
49140267768eSMatthew McClintock   Uncompressing Kernel Image ... OK
49150267768eSMatthew McClintockBooting using flat device tree at 0x300000
49160267768eSMatthew McClintockUsing MPC85xx ADS machine description
49170267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
49180267768eSMatthew McClintock[snip]
49190267768eSMatthew McClintock
49200267768eSMatthew McClintock
49216069ff26SwdenkMore About U-Boot Image Types:
49226069ff26Swdenk------------------------------
49236069ff26Swdenk
49246069ff26SwdenkU-Boot supports the following image types:
49256069ff26Swdenk
49266069ff26Swdenk   "Standalone Programs" are directly runnable in the environment
49276069ff26Swdenk	provided by U-Boot; it is expected that (if they behave
49286069ff26Swdenk	well) you can continue to work in U-Boot after return from
49296069ff26Swdenk	the Standalone Program.
49306069ff26Swdenk   "OS Kernel Images" are usually images of some Embedded OS which
49316069ff26Swdenk	will take over control completely. Usually these programs
49326069ff26Swdenk	will install their own set of exception handlers, device
49336069ff26Swdenk	drivers, set up the MMU, etc. - this means, that you cannot
49346069ff26Swdenk	expect to re-enter U-Boot except by resetting the CPU.
49356069ff26Swdenk   "RAMDisk Images" are more or less just data blocks, and their
49366069ff26Swdenk	parameters (address, size) are passed to an OS kernel that is
49376069ff26Swdenk	being started.
49386069ff26Swdenk   "Multi-File Images" contain several images, typically an OS
49396069ff26Swdenk	(Linux) kernel image and one or more data images like
49406069ff26Swdenk	RAMDisks. This construct is useful for instance when you want
49416069ff26Swdenk	to boot over the network using BOOTP etc., where the boot
49426069ff26Swdenk	server provides just a single image file, but you want to get
49436069ff26Swdenk	for instance an OS kernel and a RAMDisk image.
49446069ff26Swdenk
49456069ff26Swdenk	"Multi-File Images" start with a list of image sizes, each
49466069ff26Swdenk	image size (in bytes) specified by an "uint32_t" in network
49476069ff26Swdenk	byte order. This list is terminated by an "(uint32_t)0".
49486069ff26Swdenk	Immediately after the terminating 0 follow the images, one by
49496069ff26Swdenk	one, all aligned on "uint32_t" boundaries (size rounded up to
49506069ff26Swdenk	a multiple of 4 bytes).
49516069ff26Swdenk
49526069ff26Swdenk   "Firmware Images" are binary images containing firmware (like
49536069ff26Swdenk	U-Boot or FPGA images) which usually will be programmed to
49546069ff26Swdenk	flash memory.
49556069ff26Swdenk
49566069ff26Swdenk   "Script files" are command sequences that will be executed by
49576069ff26Swdenk	U-Boot's command interpreter; this feature is especially
49586069ff26Swdenk	useful when you configure U-Boot to use a real shell (hush)
49596069ff26Swdenk	as command interpreter.
49606069ff26Swdenk
496144f074c7SMarek VasutBooting the Linux zImage:
496244f074c7SMarek Vasut-------------------------
496344f074c7SMarek Vasut
496444f074c7SMarek VasutOn some platforms, it's possible to boot Linux zImage. This is done
496544f074c7SMarek Vasutusing the "bootz" command. The syntax of "bootz" command is the same
496644f074c7SMarek Vasutas the syntax of "bootm" command.
496744f074c7SMarek Vasut
4968017e1f3fSMarek VasutNote, defining the CONFIG_SUPPORT_INITRD_RAW allows user to supply
4969017e1f3fSMarek Vasutkernel with raw initrd images. The syntax is slightly different, the
4970017e1f3fSMarek Vasutaddress of the initrd must be augmented by it's size, in the following
4971017e1f3fSMarek Vasutformat: "<initrd addres>:<initrd size>".
4972017e1f3fSMarek Vasut
4973c609719bSwdenk
4974c609719bSwdenkStandalone HOWTO:
4975c609719bSwdenk=================
4976c609719bSwdenk
4977c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and
4978c609719bSwdenkrun "standalone" applications, which can use some resources of
4979c609719bSwdenkU-Boot like console I/O functions or interrupt services.
4980c609719bSwdenk
4981c609719bSwdenkTwo simple examples are included with the sources:
4982c609719bSwdenk
4983c609719bSwdenk"Hello World" Demo:
4984c609719bSwdenk-------------------
4985c609719bSwdenk
4986c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo
4987c609719bSwdenkapplication; it is automatically compiled when you build U-Boot.
4988c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it
4989c609719bSwdenklike that:
4990c609719bSwdenk
4991c609719bSwdenk	=> loads
4992c609719bSwdenk	## Ready for S-Record download ...
4993c609719bSwdenk	~>examples/hello_world.srec
4994c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
4995c609719bSwdenk	[file transfer complete]
4996c609719bSwdenk	[connected]
4997c609719bSwdenk	## Start Addr = 0x00040004
4998c609719bSwdenk
4999c609719bSwdenk	=> go 40004 Hello World! This is a test.
5000c609719bSwdenk	## Starting application at 0x00040004 ...
5001c609719bSwdenk	Hello World
5002c609719bSwdenk	argc = 7
5003c609719bSwdenk	argv[0] = "40004"
5004c609719bSwdenk	argv[1] = "Hello"
5005c609719bSwdenk	argv[2] = "World!"
5006c609719bSwdenk	argv[3] = "This"
5007c609719bSwdenk	argv[4] = "is"
5008c609719bSwdenk	argv[5] = "a"
5009c609719bSwdenk	argv[6] = "test."
5010c609719bSwdenk	argv[7] = "<NULL>"
5011c609719bSwdenk	Hit any key to exit ...
5012c609719bSwdenk
5013c609719bSwdenk	## Application terminated, rc = 0x0
5014c609719bSwdenk
5015c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt
5016c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'.
5017c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second.
5018c609719bSwdenkThe interrupt service routine is trivial, just printing a '.'
5019c609719bSwdenkcharacter, but this is just a demo program. The application can be
5020c609719bSwdenkcontrolled by the following keys:
5021c609719bSwdenk
5022c609719bSwdenk	? - print current values og the CPM Timer registers
5023c609719bSwdenk	b - enable interrupts and start timer
5024c609719bSwdenk	e - stop timer and disable interrupts
5025c609719bSwdenk	q - quit application
5026c609719bSwdenk
5027c609719bSwdenk	=> loads
5028c609719bSwdenk	## Ready for S-Record download ...
5029c609719bSwdenk	~>examples/timer.srec
5030c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
5031c609719bSwdenk	[file transfer complete]
5032c609719bSwdenk	[connected]
5033c609719bSwdenk	## Start Addr = 0x00040004
5034c609719bSwdenk
5035c609719bSwdenk	=> go 40004
5036c609719bSwdenk	## Starting application at 0x00040004 ...
5037c609719bSwdenk	TIMERS=0xfff00980
5038c609719bSwdenk	Using timer 1
5039c609719bSwdenk	  tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
5040c609719bSwdenk
5041c609719bSwdenkHit 'b':
5042c609719bSwdenk	[q, b, e, ?] Set interval 1000000 us
5043c609719bSwdenk	Enabling timer
5044c609719bSwdenkHit '?':
5045c609719bSwdenk	[q, b, e, ?] ........
5046c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
5047c609719bSwdenkHit '?':
5048c609719bSwdenk	[q, b, e, ?] .
5049c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
5050c609719bSwdenkHit '?':
5051c609719bSwdenk	[q, b, e, ?] .
5052c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
5053c609719bSwdenkHit '?':
5054c609719bSwdenk	[q, b, e, ?] .
5055c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
5056c609719bSwdenkHit 'e':
5057c609719bSwdenk	[q, b, e, ?] ...Stopping timer
5058c609719bSwdenkHit 'q':
5059c609719bSwdenk	[q, b, e, ?] ## Application terminated, rc = 0x0
5060c609719bSwdenk
5061c609719bSwdenk
506285ec0bccSwdenkMinicom warning:
506385ec0bccSwdenk================
506485ec0bccSwdenk
50657152b1d0SwdenkOver time, many people have reported problems when trying to use the
506685ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd)
506785ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under
5068f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and
506985ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and
5070e53515a2SKarl O. Pincuse "cu" for S-Record download ("loads" command).  See
5071e53515a2SKarl O. Pinchttp://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
5072e53515a2SKarl O. Pincfor help with kermit.
5073e53515a2SKarl O. Pinc
507485ec0bccSwdenk
507552f52c14SwdenkNevertheless, if you absolutely want to use it try adding this
507652f52c14Swdenkconfiguration to your "File transfer protocols" section:
507752f52c14Swdenk
507852f52c14Swdenk	   Name	   Program			Name U/D FullScr IO-Red. Multi
507952f52c14Swdenk	X  kermit  /usr/bin/kermit -i -l %l -s	 Y    U	   Y	   N	  N
508052f52c14Swdenk	Y  kermit  /usr/bin/kermit -i -l %l -r	 N    D	   Y	   N	  N
508152f52c14Swdenk
508252f52c14Swdenk
5083c609719bSwdenkNetBSD Notes:
5084c609719bSwdenk=============
5085c609719bSwdenk
5086c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host
5087c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx).
5088c609719bSwdenk
5089c609719bSwdenkBuilding requires a cross environment; it is known to work on
5090c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5091c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make).
5092c609719bSwdenkNote that the cross-powerpc package does not install include files;
5093c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is
5094c609719bSwdenkmissing.  This file has to be installed and patched manually:
5095c609719bSwdenk
5096c609719bSwdenk	# cd /usr/pkg/cross/powerpc-netbsd/include
5097c609719bSwdenk	# mkdir powerpc
5098c609719bSwdenk	# ln -s powerpc machine
5099c609719bSwdenk	# cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
5100c609719bSwdenk	# ${EDIT} powerpc/ansi.h	## must remove __va_list, _BSD_VA_LIST
5101c609719bSwdenk
5102c609719bSwdenkNative builds *don't* work due to incompatibilities between native
5103c609719bSwdenkand U-Boot include files.
5104c609719bSwdenk
5105c609719bSwdenkBooting assumes that (the first part of) the image booted is a
5106c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel
5107c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source
5108c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
51092a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
5110c609719bSwdenk
5111c609719bSwdenk
5112c609719bSwdenkImplementation Internals:
5113c609719bSwdenk=========================
5114c609719bSwdenk
5115c609719bSwdenkThe following is not intended to be a complete description of every
5116c609719bSwdenkimplementation detail. However, it should help to understand the
5117c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom
5118c609719bSwdenkhardware.
5119c609719bSwdenk
5120c609719bSwdenk
5121c609719bSwdenkInitial Stack, Global Data:
5122c609719bSwdenk---------------------------
5123c609719bSwdenk
5124c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot
5125c609719bSwdenkstarts running out of ROM (flash memory), usually without access to
5126c609719bSwdenksystem RAM (because the memory controller is not initialized yet).
5127c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS
5128c609719bSwdenkis not initialized as zero. To be able to get a C environment working
5129c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation
5130c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU
5131c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and
5132c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be
5133c609719bSwdenklocked as (mis-) used as memory, etc.
5134c609719bSwdenk
51357152b1d0Swdenk	Chris Hallinan posted a good summary of these issues to the
51360668236bSWolfgang Denk	U-Boot mailing list:
513743d9616cSwdenk
513843d9616cSwdenk	Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
513943d9616cSwdenk	From: "Chris Hallinan" <clh@net1plus.com>
514043d9616cSwdenk	Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
514143d9616cSwdenk	...
514243d9616cSwdenk
514343d9616cSwdenk	Correct me if I'm wrong, folks, but the way I understand it
514443d9616cSwdenk	is this: Using DCACHE as initial RAM for Stack, etc, does not
514543d9616cSwdenk	require any physical RAM backing up the cache. The cleverness
514643d9616cSwdenk	is that the cache is being used as a temporary supply of
514743d9616cSwdenk	necessary storage before the SDRAM controller is setup. It's
514811ccc33fSMarcel Ziswiler	beyond the scope of this list to explain the details, but you
514943d9616cSwdenk	can see how this works by studying the cache architecture and
515043d9616cSwdenk	operation in the architecture and processor-specific manuals.
515143d9616cSwdenk
515243d9616cSwdenk	OCM is On Chip Memory, which I believe the 405GP has 4K. It
515343d9616cSwdenk	is another option for the system designer to use as an
515411ccc33fSMarcel Ziswiler	initial stack/RAM area prior to SDRAM being available. Either
515543d9616cSwdenk	option should work for you. Using CS 4 should be fine if your
515643d9616cSwdenk	board designers haven't used it for something that would
515743d9616cSwdenk	cause you grief during the initial boot! It is frequently not
515843d9616cSwdenk	used.
515943d9616cSwdenk
51606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
516143d9616cSwdenk	with your processor/board/system design. The default value
516243d9616cSwdenk	you will find in any recent u-boot distribution in
51638a316c9bSStefan Roese	walnut.h should work for you. I'd set it to a value larger
516443d9616cSwdenk	than your SDRAM module. If you have a 64MB SDRAM module, set
516543d9616cSwdenk	it above 400_0000. Just make sure your board has no resources
516643d9616cSwdenk	that are supposed to respond to that address! That code in
516743d9616cSwdenk	start.S has been around a while and should work as is when
516843d9616cSwdenk	you get the config right.
516943d9616cSwdenk
517043d9616cSwdenk	-Chris Hallinan
517143d9616cSwdenk	DS4.COM, Inc.
517243d9616cSwdenk
5173c609719bSwdenkIt is essential to remember this, since it has some impact on the C
5174c609719bSwdenkcode for the initialization procedures:
5175c609719bSwdenk
5176c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt
5177c609719bSwdenk  to write it.
5178c609719bSwdenk
517911ccc33fSMarcel Ziswiler* Do not use any uninitialized global data (or implicitely initialized
5180c609719bSwdenk  as zero data - BSS segment) at all - this is undefined, initiali-
51817152b1d0Swdenk  zation is performed later (when relocating to RAM).
5182c609719bSwdenk
5183c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like
5184c609719bSwdenk  that.
5185c609719bSwdenk
5186c609719bSwdenkHaving only the stack as writable memory limits means we cannot use
5187c609719bSwdenknormal global data to share information beween the code. But it
5188c609719bSwdenkturned out that the implementation of U-Boot can be greatly
5189c609719bSwdenksimplified by making a global data structure (gd_t) available to all
5190c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_
5191c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of
5192c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we
5193c609719bSwdenkplace a pointer (gd) to the global data into a register which we
5194c609719bSwdenkreserve for this purpose.
5195c609719bSwdenk
51967152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the
5197c609719bSwdenkrelevant  (E)ABI  specifications for the current architecture, and by
5198c609719bSwdenkGCC's implementation.
5199c609719bSwdenk
5200c609719bSwdenkFor PowerPC, the following registers have specific use:
5201c609719bSwdenk	R1:	stack pointer
5202e7670f6cSWolfgang Denk	R2:	reserved for system use
5203c609719bSwdenk	R3-R4:	parameter passing and return values
5204c609719bSwdenk	R5-R10: parameter passing
5205c609719bSwdenk	R13:	small data area pointer
5206c609719bSwdenk	R30:	GOT pointer
5207c609719bSwdenk	R31:	frame pointer
5208c609719bSwdenk
5209e6bee808SJoakim Tjernlund	(U-Boot also uses R12 as internal GOT pointer. r12
5210e6bee808SJoakim Tjernlund	is a volatile register so r12 needs to be reset when
5211e6bee808SJoakim Tjernlund	going back and forth between asm and C)
5212c609719bSwdenk
5213e7670f6cSWolfgang Denk    ==> U-Boot will use R2 to hold a pointer to the global data
5214c609719bSwdenk
5215c609719bSwdenk    Note: on PPC, we could use a static initializer (since the
5216c609719bSwdenk    address of the global data structure is known at compile time),
5217c609719bSwdenk    but it turned out that reserving a register results in somewhat
5218c609719bSwdenk    smaller code - although the code savings are not that big (on
5219c609719bSwdenk    average for all boards 752 bytes for the whole U-Boot image,
5220c609719bSwdenk    624 text + 127 data).
5221c609719bSwdenk
5222c4db335cSRobin GetzOn Blackfin, the normal C ABI (except for P3) is followed as documented here:
52234c58eb55SMike Frysinger	http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
52244c58eb55SMike Frysinger
5225c4db335cSRobin Getz    ==> U-Boot will use P3 to hold a pointer to the global data
52264c58eb55SMike Frysinger
5227c609719bSwdenkOn ARM, the following registers are used:
5228c609719bSwdenk
5229c609719bSwdenk	R0:	function argument word/integer result
5230c609719bSwdenk	R1-R3:	function argument word
5231c609719bSwdenk	R9:	GOT pointer
5232c609719bSwdenk	R10:	stack limit (used only if stack checking if enabled)
5233c609719bSwdenk	R11:	argument (frame) pointer
5234c609719bSwdenk	R12:	temporary workspace
5235c609719bSwdenk	R13:	stack pointer
5236c609719bSwdenk	R14:	link register
5237c609719bSwdenk	R15:	program counter
5238c609719bSwdenk
5239c609719bSwdenk    ==> U-Boot will use R8 to hold a pointer to the global data
5240c609719bSwdenk
52410df01fd3SThomas ChouOn Nios II, the ABI is documented here:
52420df01fd3SThomas Chou	http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
52430df01fd3SThomas Chou
52440df01fd3SThomas Chou    ==> U-Boot will use gp to hold a pointer to the global data
52450df01fd3SThomas Chou
52460df01fd3SThomas Chou    Note: on Nios II, we give "-G0" option to gcc and don't use gp
52470df01fd3SThomas Chou    to access small data sections, so gp is free.
52480df01fd3SThomas Chou
5249afc1ce82SMacpaul LinOn NDS32, the following registers are used:
5250afc1ce82SMacpaul Lin
5251afc1ce82SMacpaul Lin	R0-R1:	argument/return
5252afc1ce82SMacpaul Lin	R2-R5:	argument
5253afc1ce82SMacpaul Lin	R15:	temporary register for assembler
5254afc1ce82SMacpaul Lin	R16:	trampoline register
5255afc1ce82SMacpaul Lin	R28:	frame pointer (FP)
5256afc1ce82SMacpaul Lin	R29:	global pointer (GP)
5257afc1ce82SMacpaul Lin	R30:	link register (LP)
5258afc1ce82SMacpaul Lin	R31:	stack pointer (SP)
5259afc1ce82SMacpaul Lin	PC:	program counter (PC)
5260afc1ce82SMacpaul Lin
5261afc1ce82SMacpaul Lin    ==> U-Boot will use R10 to hold a pointer to the global data
5262afc1ce82SMacpaul Lin
5263d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5264d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much.
5265c609719bSwdenk
5266c609719bSwdenkMemory Management:
5267c609719bSwdenk------------------
5268c609719bSwdenk
5269c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the
5270c609719bSwdenkMMU is not used either for address mapping nor for memory protection.
5271c609719bSwdenk
5272c609719bSwdenkThe available memory is mapped to fixed addresses using the memory
5273c609719bSwdenkcontroller. In this process, a contiguous block is formed for each
5274c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several
5275c609719bSwdenkphysical memory banks.
5276c609719bSwdenk
5277c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on
5278c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5279c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself
5280c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some
52816d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
5282c609719bSwdenkconfiguration setting]. Below that, a structure with global Board
5283c609719bSwdenkInfo data is placed, followed by the stack (growing downward).
5284c609719bSwdenk
5285c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB
5286c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF).
5287c609719bSwdenk
5288c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like
5289c609719bSwdenkthis:
5290c609719bSwdenk
5291c609719bSwdenk	0x0000 0000	Exception Vector code
5292c609719bSwdenk	      :
5293c609719bSwdenk	0x0000 1FFF
5294c609719bSwdenk	0x0000 2000	Free for Application Use
5295c609719bSwdenk	      :
5296c609719bSwdenk	      :
5297c609719bSwdenk
5298c609719bSwdenk	      :
5299c609719bSwdenk	      :
5300c609719bSwdenk	0x00FB FF20	Monitor Stack (Growing downward)
5301c609719bSwdenk	0x00FB FFAC	Board Info Data and permanent copy of global data
5302c609719bSwdenk	0x00FC 0000	Malloc Arena
5303c609719bSwdenk	      :
5304c609719bSwdenk	0x00FD FFFF
5305c609719bSwdenk	0x00FE 0000	RAM Copy of Monitor Code
5306c609719bSwdenk	...		eventually: LCD or video framebuffer
5307c609719bSwdenk	...		eventually: pRAM (Protected RAM - unchanged by reset)
5308c609719bSwdenk	0x00FF FFFF	[End of RAM]
5309c609719bSwdenk
5310c609719bSwdenk
5311c609719bSwdenkSystem Initialization:
5312c609719bSwdenk----------------------
5313c609719bSwdenk
5314c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point
531511ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset
5316c609719bSwdenkconfiguration for CS0# this is a mirror of the onboard Flash memory.
53177152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address.
5318c609719bSwdenkTo be able to implement the initialization code in C, a (small!)
5319c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs
5320c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked
5321c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core,
5322c609719bSwdenkthe caches and the SIU.
5323c609719bSwdenk
5324c609719bSwdenkNext, all (potentially) available memory banks are mapped using a
5325c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries
5326c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5327c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5328c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a
5329c609719bSwdenksimple memory test is run that determines the size of the SDRAM
5330c609719bSwdenkbanks.
5331c609719bSwdenk
5332c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of
53337152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first
5334c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address
5335c609719bSwdenk0x00000000, with any additional banks following immediately to create
5336c609719bSwdenkcontiguous memory starting from 0.
5337c609719bSwdenk
5338c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area
5339c609719bSwdenkand allocates memory for use by malloc() and for the global Board
5340c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM
5341c609719bSwdenkpages, and the final stack is set up.
5342c609719bSwdenk
5343c609719bSwdenkOnly after this relocation will you have a "normal" C environment;
5344c609719bSwdenkuntil that you are restricted in several ways, mostly because you are
5345c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a
5346c609719bSwdenknew address in RAM.
5347c609719bSwdenk
5348c609719bSwdenk
5349c609719bSwdenkU-Boot Porting Guide:
5350c609719bSwdenk----------------------
5351c609719bSwdenk
5352c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
53536aff3115Swdenklist, October 2002]
5354c609719bSwdenk
5355c609719bSwdenk
5356c609719bSwdenkint main(int argc, char *argv[])
5357c609719bSwdenk{
5358c609719bSwdenk	sighandler_t no_more_time;
5359c609719bSwdenk
5360c609719bSwdenk	signal(SIGALRM, no_more_time);
5361c609719bSwdenk	alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
5362c609719bSwdenk
5363c609719bSwdenk	if (available_money > available_manpower) {
53646c3fef28SJerry Van Baren		Pay consultant to port U-Boot;
5365c609719bSwdenk		return 0;
5366c609719bSwdenk	}
5367c609719bSwdenk
5368c609719bSwdenk	Download latest U-Boot source;
5369c609719bSwdenk
53700668236bSWolfgang Denk	Subscribe to u-boot mailing list;
53716aff3115Swdenk
53726c3fef28SJerry Van Baren	if (clueless)
5373c609719bSwdenk		email("Hi, I am new to U-Boot, how do I get started?");
5374c609719bSwdenk
5375c609719bSwdenk	while (learning) {
5376c609719bSwdenk		Read the README file in the top level directory;
53777cb22f97Swdenk		Read http://www.denx.de/twiki/bin/view/DULG/Manual;
53786c3fef28SJerry Van Baren		Read applicable doc/*.README;
5379c609719bSwdenk		Read the source, Luke;
53806c3fef28SJerry Van Baren		/* find . -name "*.[chS]" | xargs grep -i <keyword> */
5381c609719bSwdenk	}
5382c609719bSwdenk
53836c3fef28SJerry Van Baren	if (available_money > toLocalCurrency ($2500))
53846c3fef28SJerry Van Baren		Buy a BDI3000;
53856c3fef28SJerry Van Baren	else
5386c609719bSwdenk		Add a lot of aggravation and time;
5387c609719bSwdenk
53886c3fef28SJerry Van Baren	if (a similar board exists) {	/* hopefully... */
53896c3fef28SJerry Van Baren		cp -a board/<similar> board/<myboard>
53906c3fef28SJerry Van Baren		cp include/configs/<similar>.h include/configs/<myboard>.h
53916c3fef28SJerry Van Baren	} else {
5392c609719bSwdenk		Create your own board support subdirectory;
53936c3fef28SJerry Van Baren		Create your own board include/configs/<myboard>.h file;
53946c3fef28SJerry Van Baren	}
53956c3fef28SJerry Van Baren	Edit new board/<myboard> files
53966c3fef28SJerry Van Baren	Edit new include/configs/<myboard>.h
5397c609719bSwdenk
53986c3fef28SJerry Van Baren	while (!accepted) {
5399c609719bSwdenk		while (!running) {
5400c609719bSwdenk			do {
5401c609719bSwdenk				Add / modify source code;
5402c609719bSwdenk			} until (compiles);
5403c609719bSwdenk			Debug;
5404c609719bSwdenk			if (clueless)
5405c609719bSwdenk				email("Hi, I am having problems...");
5406c609719bSwdenk		}
54076c3fef28SJerry Van Baren		Send patch file to the U-Boot email list;
54086c3fef28SJerry Van Baren		if (reasonable critiques)
54096c3fef28SJerry Van Baren			Incorporate improvements from email list code review;
54106c3fef28SJerry Van Baren		else
54116c3fef28SJerry Van Baren			Defend code as written;
54126c3fef28SJerry Van Baren	}
5413c609719bSwdenk
5414c609719bSwdenk	return 0;
5415c609719bSwdenk}
5416c609719bSwdenk
5417c609719bSwdenkvoid no_more_time (int sig)
5418c609719bSwdenk{
5419c609719bSwdenk      hire_a_guru();
5420c609719bSwdenk}
5421c609719bSwdenk
5422c609719bSwdenk
5423c609719bSwdenkCoding Standards:
5424c609719bSwdenk-----------------
5425c609719bSwdenk
5426c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel
54272c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script
54287ca9296eSWolfgang Denk"scripts/Lindent" in your Linux kernel source directory.
5429c609719bSwdenk
54302c051651SDetlev ZundelSource files originating from a different project (for example the
54312c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not
54322c051651SDetlev Zundelreformated to ease subsequent migration to newer versions of those
54332c051651SDetlev Zundelsources.
54342c051651SDetlev Zundel
54352c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in
54362c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//)
54372c051651SDetlev Zundelin your code.
5438c609719bSwdenk
5439c178d3daSwdenkPlease also stick to the following formatting rules:
5440180d3f74Swdenk- remove any trailing white space
54417ca9296eSWolfgang Denk- use TAB characters for indentation and vertical alignment, not spaces
5442180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds
54437ca9296eSWolfgang Denk- do not add more than 2 consecutive empty lines to source files
5444180d3f74Swdenk- do not add trailing empty lines to source files
5445180d3f74Swdenk
5446c609719bSwdenkSubmissions which do not conform to the standards may be returned
5447c609719bSwdenkwith a request to reformat the changes.
5448c609719bSwdenk
5449c609719bSwdenk
5450c609719bSwdenkSubmitting Patches:
5451c609719bSwdenk-------------------
5452c609719bSwdenk
5453c609719bSwdenkSince the number of patches for U-Boot is growing, we need to
5454c609719bSwdenkestablish some rules. Submissions which do not conform to these rules
5455c609719bSwdenkmay be rejected, even when they contain important and valuable stuff.
5456c609719bSwdenk
54570d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details.
5458218ca724SWolfgang Denk
54590668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
54600668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot
54610668236bSWolfgang Denk
5462c609719bSwdenkWhen you send a patch, please include the following information with
5463c609719bSwdenkit:
5464c609719bSwdenk
5465c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes
5466c609719bSwdenk  this bug. Please try to include a way of demonstrating that the
5467c609719bSwdenk  patch actually fixes something.
5468c609719bSwdenk
5469c609719bSwdenk* For new features: a description of the feature and your
5470c609719bSwdenk  implementation.
5471c609719bSwdenk
5472c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch)
5473c609719bSwdenk
5474c609719bSwdenk* For major contributions, your entry to the CREDITS file
5475c609719bSwdenk
5476c609719bSwdenk* When you add support for a new board, don't forget to add this
54777ca9296eSWolfgang Denk  board to the MAINTAINERS file, too.
5478c609719bSwdenk
5479c609719bSwdenk* If your patch adds new configuration options, don't forget to
5480c609719bSwdenk  document these in the README file.
5481c609719bSwdenk
5482218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly*
5483218ca724SWolfgang Denk  recommended) you can easily generate the patch using the
54847ca9296eSWolfgang Denk  "git format-patch". If you then use "git send-email" to send it to
5485218ca724SWolfgang Denk  the U-Boot mailing list, you will avoid most of the common problems
5486218ca724SWolfgang Denk  with some other mail clients.
5487c609719bSwdenk
5488218ca724SWolfgang Denk  If you cannot use git, use "diff -purN OLD NEW". If your version of
5489218ca724SWolfgang Denk  diff does not support these options, then get the latest version of
5490218ca724SWolfgang Denk  GNU diff.
54916dff5529Swdenk
5492218ca724SWolfgang Denk  The current directory when running this command shall be the parent
5493218ca724SWolfgang Denk  directory of the U-Boot source tree (i. e. please make sure that
5494218ca724SWolfgang Denk  your patch includes sufficient directory information for the
5495218ca724SWolfgang Denk  affected files).
5496218ca724SWolfgang Denk
5497218ca724SWolfgang Denk  We prefer patches as plain text. MIME attachments are discouraged,
5498218ca724SWolfgang Denk  and compressed attachments must not be used.
5499c609719bSwdenk
550052f52c14Swdenk* If one logical set of modifications affects or creates several
550152f52c14Swdenk  files, all these changes shall be submitted in a SINGLE patch file.
550252f52c14Swdenk
550352f52c14Swdenk* Changesets that contain different, unrelated modifications shall be
550452f52c14Swdenk  submitted as SEPARATE patches, one patch per changeset.
550552f52c14Swdenk
550652f52c14Swdenk
5507c609719bSwdenkNotes:
5508c609719bSwdenk
5509c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched
5510c609719bSwdenk  source tree and make sure that no errors or warnings are reported
5511c609719bSwdenk  for any of the boards.
5512c609719bSwdenk
5513c609719bSwdenk* Keep your modifications to the necessary minimum: A patch
5514c609719bSwdenk  containing several unrelated changes or arbitrary reformats will be
5515c609719bSwdenk  returned with a request to re-formatting / split it.
5516c609719bSwdenk
5517c609719bSwdenk* If you modify existing code, make sure that your new code does not
5518c609719bSwdenk  add to the memory footprint of the code ;-) Small is beautiful!
5519c609719bSwdenk  When adding new features, these should compile conditionally only
5520c609719bSwdenk  (using #ifdef), and the resulting code with the new feature
5521c609719bSwdenk  disabled must not need more memory than the old code without your
5522c609719bSwdenk  modification.
552390dc6704Swdenk
55240668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the
55250668236bSWolfgang Denk  u-boot mailing list. Bigger patches will be moderated. If they are
55260668236bSWolfgang Denk  reasonable and not too big, they will be acknowledged. But patches
55270668236bSWolfgang Denk  bigger than the size limit should be avoided.
5528