xref: /openbmc/u-boot/README (revision 588a13f742b6d63ac7d5631af11baa01f3a9e80f)
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
4885da627a4Swdenk- Linux Kernel Interface:
489c609719bSwdenk		CONFIG_CLOCKS_IN_MHZ
490c609719bSwdenk
491c609719bSwdenk		U-Boot stores all clock information in Hz
492c609719bSwdenk		internally. For binary compatibility with older Linux
493c609719bSwdenk		kernels (which expect the clocks passed in the
494c609719bSwdenk		bd_info data to be in MHz) the environment variable
495c609719bSwdenk		"clocks_in_mhz" can be defined so that U-Boot
496c609719bSwdenk		converts clock data to MHZ before passing it to the
497c609719bSwdenk		Linux kernel.
498c609719bSwdenk		When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
499c609719bSwdenk		"clocks_in_mhz=1" is automatically included in the
500c609719bSwdenk		default environment.
501c609719bSwdenk
5025da627a4Swdenk		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]
5035da627a4Swdenk
50411ccc33fSMarcel Ziswiler		When transferring memsize parameter to linux, some versions
5055da627a4Swdenk		expect it to be in bytes, others in MB.
5065da627a4Swdenk		Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
5075da627a4Swdenk
508fec6d9eeSGerald Van Baren		CONFIG_OF_LIBFDT
509f57f70aaSWolfgang Denk
510f57f70aaSWolfgang Denk		New kernel versions are expecting firmware settings to be
511213bf8c8SGerald Van Baren		passed using flattened device trees (based on open firmware
512213bf8c8SGerald Van Baren		concepts).
513213bf8c8SGerald Van Baren
514213bf8c8SGerald Van Baren		CONFIG_OF_LIBFDT
515213bf8c8SGerald Van Baren		 * New libfdt-based support
516213bf8c8SGerald Van Baren		 * Adds the "fdt" command
5173bb342fcSKim Phillips		 * The bootm command automatically updates the fdt
518213bf8c8SGerald Van Baren
519b55ae402SMarcel Ziswiler		OF_CPU - The proper name of the cpus node (only required for
520b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
521b55ae402SMarcel Ziswiler		OF_SOC - The proper name of the soc node (only required for
522b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
523f57f70aaSWolfgang Denk		OF_TBCLK - The timebase frequency.
524c2871f03SKumar Gala		OF_STDOUT_PATH - The path to the console device
525f57f70aaSWolfgang Denk
52611ccc33fSMarcel Ziswiler		boards with QUICC Engines require OF_QE to set UCC MAC
52711ccc33fSMarcel Ziswiler		addresses
5283bb342fcSKim Phillips
5294e253137SKumar Gala		CONFIG_OF_BOARD_SETUP
5304e253137SKumar Gala
5314e253137SKumar Gala		Board code has addition modification that it wants to make
5324e253137SKumar Gala		to the flat device tree before handing it off to the kernel
5336705d81eSwdenk
5340267768eSMatthew McClintock		CONFIG_OF_BOOT_CPU
5350267768eSMatthew McClintock
53611ccc33fSMarcel Ziswiler		This define fills in the correct boot CPU in the boot
5370267768eSMatthew McClintock		param header, the default value is zero if undefined.
5380267768eSMatthew McClintock
5393887c3fbSHeiko Schocher		CONFIG_OF_IDE_FIXUP
5403887c3fbSHeiko Schocher
5413887c3fbSHeiko Schocher		U-Boot can detect if an IDE device is present or not.
5423887c3fbSHeiko Schocher		If not, and this new config option is activated, U-Boot
5433887c3fbSHeiko Schocher		removes the ATA node from the DTS before booting Linux,
5443887c3fbSHeiko Schocher		so the Linux IDE driver does not probe the device and
5453887c3fbSHeiko Schocher		crash. This is needed for buggy hardware (uc101) where
5463887c3fbSHeiko Schocher		no pull down resistor is connected to the signal IDE5V_DD7.
5473887c3fbSHeiko Schocher
5487eb29398SIgor Grinberg		CONFIG_MACH_TYPE	[relevant for ARM only][mandatory]
5497eb29398SIgor Grinberg
5507eb29398SIgor Grinberg		This setting is mandatory for all boards that have only one
5517eb29398SIgor Grinberg		machine type and must be used to specify the machine type
5527eb29398SIgor Grinberg		number as it appears in the ARM machine registry
5537eb29398SIgor Grinberg		(see http://www.arm.linux.org.uk/developer/machines/).
5547eb29398SIgor Grinberg		Only boards that have multiple machine types supported
5557eb29398SIgor Grinberg		in a single configuration file and the machine type is
5567eb29398SIgor Grinberg		runtime discoverable, do not have to use this setting.
5577eb29398SIgor Grinberg
5580b2f4ecaSNiklaus Giger- vxWorks boot parameters:
5590b2f4ecaSNiklaus Giger
5600b2f4ecaSNiklaus Giger		bootvx constructs a valid bootline using the following
5610b2f4ecaSNiklaus Giger		environments variables: bootfile, ipaddr, serverip, hostname.
5620b2f4ecaSNiklaus Giger		It loads the vxWorks image pointed bootfile.
5630b2f4ecaSNiklaus Giger
5640b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
5650b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
5660b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
5670b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
5680b2f4ecaSNiklaus Giger
5690b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_ADD_PARAMS
5700b2f4ecaSNiklaus Giger
5710b2f4ecaSNiklaus Giger		Add it at the end of the bootline. E.g "u=username pw=secret"
5720b2f4ecaSNiklaus Giger
5730b2f4ecaSNiklaus Giger		Note: If a "bootargs" environment is defined, it will overwride
5740b2f4ecaSNiklaus Giger		the defaults discussed just above.
5750b2f4ecaSNiklaus Giger
5762c451f78SAneesh V- Cache Configuration:
5772c451f78SAneesh V		CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
5782c451f78SAneesh V		CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
5792c451f78SAneesh V		CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
5802c451f78SAneesh V
58193bc2193SAneesh V- Cache Configuration for ARM:
58293bc2193SAneesh V		CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
58393bc2193SAneesh V				      controller
58493bc2193SAneesh V		CONFIG_SYS_PL310_BASE - Physical base address of PL310
58593bc2193SAneesh V					controller register space
58693bc2193SAneesh V
5876705d81eSwdenk- Serial Ports:
58848d0192fSAndreas Engel		CONFIG_PL010_SERIAL
5896705d81eSwdenk
5906705d81eSwdenk		Define this if you want support for Amba PrimeCell PL010 UARTs.
5916705d81eSwdenk
59248d0192fSAndreas Engel		CONFIG_PL011_SERIAL
5936705d81eSwdenk
5946705d81eSwdenk		Define this if you want support for Amba PrimeCell PL011 UARTs.
5956705d81eSwdenk
5966705d81eSwdenk		CONFIG_PL011_CLOCK
5976705d81eSwdenk
5986705d81eSwdenk		If you have Amba PrimeCell PL011 UARTs, set this variable to
5996705d81eSwdenk		the clock speed of the UARTs.
6006705d81eSwdenk
6016705d81eSwdenk		CONFIG_PL01x_PORTS
6026705d81eSwdenk
6036705d81eSwdenk		If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
6046705d81eSwdenk		define this to a list of base addresses for each (supported)
6056705d81eSwdenk		port. See e.g. include/configs/versatile.h
6066705d81eSwdenk
607910f1ae3SJohn Rigby		CONFIG_PL011_SERIAL_RLCR
608910f1ae3SJohn Rigby
609910f1ae3SJohn Rigby		Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
610910f1ae3SJohn Rigby		have separate receive and transmit line control registers.  Set
611910f1ae3SJohn Rigby		this variable to initialize the extra register.
612910f1ae3SJohn Rigby
613910f1ae3SJohn Rigby		CONFIG_PL011_SERIAL_FLUSH_ON_INIT
614910f1ae3SJohn Rigby
615910f1ae3SJohn Rigby		On some platforms (e.g. U8500) U-Boot is loaded by a second stage
616910f1ae3SJohn Rigby		boot loader that has already initialized the UART.  Define this
617910f1ae3SJohn Rigby		variable to flush the UART at init time.
618910f1ae3SJohn Rigby
6197de0fe1aSJavier Martinez Canillas		CONFIG_SYS_NS16550_BROKEN_TEMT
6207de0fe1aSJavier Martinez Canillas
6217de0fe1aSJavier Martinez Canillas		16550 UART set the Transmitter Empty (TEMT) Bit when all output
6227de0fe1aSJavier Martinez Canillas		has finished and the transmitter is totally empty. U-Boot waits
6237de0fe1aSJavier Martinez Canillas		for this bit to be set to initialize the serial console. On some
6247de0fe1aSJavier Martinez Canillas		broken platforms this bit is not set in SPL making U-Boot to
6257de0fe1aSJavier Martinez Canillas		hang while waiting for TEMT. Define this option to avoid it.
6267de0fe1aSJavier Martinez Canillas
6276705d81eSwdenk
628c609719bSwdenk- Console Interface:
629c609719bSwdenk		Depending on board, define exactly one serial port
630c609719bSwdenk		(like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
631c609719bSwdenk		CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
632c609719bSwdenk		console by defining CONFIG_8xx_CONS_NONE
633c609719bSwdenk
634c609719bSwdenk		Note: if CONFIG_8xx_CONS_NONE is defined, the serial
635c609719bSwdenk		port routines must be defined elsewhere
636c609719bSwdenk		(i.e. serial_init(), serial_getc(), ...)
637c609719bSwdenk
638c609719bSwdenk		CONFIG_CFB_CONSOLE
639c609719bSwdenk		Enables console device for a color framebuffer. Needs following
640c53043b7SWolfgang Denk		defines (cf. smiLynxEM, i8042)
641c609719bSwdenk			VIDEO_FB_LITTLE_ENDIAN	graphic memory organisation
642c609719bSwdenk						(default big endian)
643c609719bSwdenk			VIDEO_HW_RECTFILL	graphic chip supports
644c609719bSwdenk						rectangle fill
645c609719bSwdenk						(cf. smiLynxEM)
646c609719bSwdenk			VIDEO_HW_BITBLT		graphic chip supports
647c609719bSwdenk						bit-blit (cf. smiLynxEM)
648c609719bSwdenk			VIDEO_VISIBLE_COLS	visible pixel columns
649c609719bSwdenk						(cols=pitch)
650c609719bSwdenk			VIDEO_VISIBLE_ROWS	visible pixel rows
651c609719bSwdenk			VIDEO_PIXEL_SIZE	bytes per pixel
652c609719bSwdenk			VIDEO_DATA_FORMAT	graphic data format
653c609719bSwdenk						(0-5, cf. cfb_console.c)
654c609719bSwdenk			VIDEO_FB_ADRS		framebuffer address
655c609719bSwdenk			VIDEO_KBD_INIT_FCT	keyboard int fct
656c609719bSwdenk						(i.e. i8042_kbd_init())
657c609719bSwdenk			VIDEO_TSTC_FCT		test char fct
658c609719bSwdenk						(i.e. i8042_tstc)
659c609719bSwdenk			VIDEO_GETC_FCT		get char fct
660c609719bSwdenk						(i.e. i8042_getc)
661c609719bSwdenk			CONFIG_CONSOLE_CURSOR	cursor drawing on/off
662c609719bSwdenk						(requires blink timer
663c609719bSwdenk						cf. i8042.c)
6646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
665c609719bSwdenk			CONFIG_CONSOLE_TIME	display time/date info in
666c609719bSwdenk						upper right corner
667602ad3b3SJon Loeliger						(requires CONFIG_CMD_DATE)
668c609719bSwdenk			CONFIG_VIDEO_LOGO	display Linux logo in
669c609719bSwdenk						upper left corner
670a6c7ad2fSwdenk			CONFIG_VIDEO_BMP_LOGO	use bmp_logo.h instead of
671a6c7ad2fSwdenk						linux_logo.h for logo.
672a6c7ad2fSwdenk						Requires CONFIG_VIDEO_LOGO
673c609719bSwdenk			CONFIG_CONSOLE_EXTRA_INFO
67411ccc33fSMarcel Ziswiler						additional board info beside
675c609719bSwdenk						the logo
676c609719bSwdenk
67733a35bbbSPali Rohár		When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
67833a35bbbSPali Rohár		a limited number of ANSI escape sequences (cursor control,
67933a35bbbSPali Rohár		erase functions and limited graphics rendition control).
68033a35bbbSPali Rohár
681c609719bSwdenk		When CONFIG_CFB_CONSOLE is defined, video console is
682c609719bSwdenk		default i/o. Serial console can be forced with
683c609719bSwdenk		environment 'console=serial'.
684c609719bSwdenk
685a3ad8e26Swdenk		When CONFIG_SILENT_CONSOLE is defined, all console
686a3ad8e26Swdenk		messages (by U-Boot and Linux!) can be silenced with
687a3ad8e26Swdenk		the "silent" environment variable. See
688a3ad8e26Swdenk		doc/README.silent for more information.
689a3ad8e26Swdenk
690c609719bSwdenk- Console Baudrate:
691c609719bSwdenk		CONFIG_BAUDRATE - in bps
692c609719bSwdenk		Select one of the baudrates listed in
6936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
6946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
695c609719bSwdenk
696c92fac91SHeiko Schocher- Console Rx buffer length
697c92fac91SHeiko Schocher		With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
698c92fac91SHeiko Schocher		the maximum receive buffer length for the SMC.
6992b3f12c2SHeiko Schocher		This option is actual only for 82xx and 8xx possible.
700c92fac91SHeiko Schocher		If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
701c92fac91SHeiko Schocher		must be defined, to setup the maximum idle timeout for
702c92fac91SHeiko Schocher		the SMC.
703c92fac91SHeiko Schocher
7049558b48aSGraeme Russ- Pre-Console Buffer:
7059558b48aSGraeme Russ		Prior to the console being initialised (i.e. serial UART
7069558b48aSGraeme Russ		initialised etc) all console output is silently discarded.
7079558b48aSGraeme Russ		Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
7089558b48aSGraeme Russ		buffer any console messages prior to the console being
7099558b48aSGraeme Russ		initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
7109558b48aSGraeme Russ		bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
7119558b48aSGraeme Russ		a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
7129558b48aSGraeme Russ		bytes are output before the console is initialised, the
7139558b48aSGraeme Russ		earlier bytes are discarded.
7149558b48aSGraeme Russ
7159558b48aSGraeme Russ		'Sane' compilers will generate smaller code if
7169558b48aSGraeme Russ		CONFIG_PRE_CON_BUF_SZ is a power of 2
7179558b48aSGraeme Russ
718046a37bdSSonny Rao- Safe printf() functions
719046a37bdSSonny Rao		Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
720046a37bdSSonny Rao		the printf() functions. These are defined in
721046a37bdSSonny Rao		include/vsprintf.h and include snprintf(), vsnprintf() and
722046a37bdSSonny Rao		so on. Code size increase is approximately 300-500 bytes.
723046a37bdSSonny Rao		If this option is not given then these functions will
724046a37bdSSonny Rao		silently discard their buffer size argument - this means
725046a37bdSSonny Rao		you are not getting any overflow checking in this case.
726046a37bdSSonny Rao
727c609719bSwdenk- Boot Delay:	CONFIG_BOOTDELAY - in seconds
728c609719bSwdenk		Delay before automatically booting the default image;
729c609719bSwdenk		set to -1 to disable autoboot.
73093d7212fSJoe Hershberger		set to -2 to autoboot with no delay and not check for abort
73193d7212fSJoe Hershberger		(even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
732c609719bSwdenk
733c609719bSwdenk		See doc/README.autoboot for these options that
734c609719bSwdenk		work with CONFIG_BOOTDELAY. None are required.
735c609719bSwdenk		CONFIG_BOOT_RETRY_TIME
736c609719bSwdenk		CONFIG_BOOT_RETRY_MIN
737c609719bSwdenk		CONFIG_AUTOBOOT_KEYED
738c609719bSwdenk		CONFIG_AUTOBOOT_PROMPT
739c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR
740c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR
741c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR2
742c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR2
743c609719bSwdenk		CONFIG_ZERO_BOOTDELAY_CHECK
744c609719bSwdenk		CONFIG_RESET_TO_RETRY
745c609719bSwdenk
746c609719bSwdenk- Autoboot Command:
747c609719bSwdenk		CONFIG_BOOTCOMMAND
748c609719bSwdenk		Only needed when CONFIG_BOOTDELAY is enabled;
749c609719bSwdenk		define a command string that is automatically executed
750c609719bSwdenk		when no character is read on the console interface
751c609719bSwdenk		within "Boot Delay" after reset.
752c609719bSwdenk
753c609719bSwdenk		CONFIG_BOOTARGS
754c609719bSwdenk		This can be used to pass arguments to the bootm
755c609719bSwdenk		command. The value of CONFIG_BOOTARGS goes into the
756c609719bSwdenk		environment value "bootargs".
757c609719bSwdenk
758c609719bSwdenk		CONFIG_RAMBOOT and CONFIG_NFSBOOT
759c609719bSwdenk		The value of these goes into the environment as
760c609719bSwdenk		"ramboot" and "nfsboot" respectively, and can be used
761c609719bSwdenk		as a convenience, when switching between booting from
76211ccc33fSMarcel Ziswiler		RAM and NFS.
763c609719bSwdenk
764c609719bSwdenk- Pre-Boot Commands:
765c609719bSwdenk		CONFIG_PREBOOT
766c609719bSwdenk
767c609719bSwdenk		When this option is #defined, the existence of the
768c609719bSwdenk		environment variable "preboot" will be checked
769c609719bSwdenk		immediately before starting the CONFIG_BOOTDELAY
770c609719bSwdenk		countdown and/or running the auto-boot command resp.
771c609719bSwdenk		entering interactive mode.
772c609719bSwdenk
773c609719bSwdenk		This feature is especially useful when "preboot" is
774c609719bSwdenk		automatically generated or modified. For an example
775c609719bSwdenk		see the LWMON board specific code: here "preboot" is
776c609719bSwdenk		modified when the user holds down a certain
777c609719bSwdenk		combination of keys on the (special) keyboard when
778c609719bSwdenk		booting the systems
779c609719bSwdenk
780c609719bSwdenk- Serial Download Echo Mode:
781c609719bSwdenk		CONFIG_LOADS_ECHO
782c609719bSwdenk		If defined to 1, all characters received during a
783c609719bSwdenk		serial download (using the "loads" command) are
784c609719bSwdenk		echoed back. This might be needed by some terminal
785c609719bSwdenk		emulations (like "cu"), but may as well just take
786c609719bSwdenk		time on others. This setting #define's the initial
787c609719bSwdenk		value of the "loads_echo" environment variable.
788c609719bSwdenk
789602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
790c609719bSwdenk		CONFIG_KGDB_BAUDRATE
791c609719bSwdenk		Select one of the baudrates listed in
7926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
793c609719bSwdenk
794c609719bSwdenk- Monitor Functions:
795602ad3b3SJon Loeliger		Monitor commands can be included or excluded
796602ad3b3SJon Loeliger		from the build by using the #include files
797c6c621bdSStephen Warren		<config_cmd_all.h> and #undef'ing unwanted
798c6c621bdSStephen Warren		commands, or using <config_cmd_default.h>
799602ad3b3SJon Loeliger		and augmenting with additional #define's
800602ad3b3SJon Loeliger		for wanted commands.
801c609719bSwdenk
802602ad3b3SJon Loeliger		The default command configuration includes all commands
803602ad3b3SJon Loeliger		except those marked below with a "*".
804602ad3b3SJon Loeliger
805602ad3b3SJon Loeliger		CONFIG_CMD_ASKENV	* ask for env variable
806602ad3b3SJon Loeliger		CONFIG_CMD_BDI		  bdinfo
807602ad3b3SJon Loeliger		CONFIG_CMD_BEDBUG	* Include BedBug Debugger
808602ad3b3SJon Loeliger		CONFIG_CMD_BMP		* BMP support
809602ad3b3SJon Loeliger		CONFIG_CMD_BSP		* Board specific commands
810602ad3b3SJon Loeliger		CONFIG_CMD_BOOTD	  bootd
811602ad3b3SJon Loeliger		CONFIG_CMD_CACHE	* icache, dcache
812602ad3b3SJon Loeliger		CONFIG_CMD_CONSOLE	  coninfo
813710b9938SMike Frysinger		CONFIG_CMD_CRC32	* crc32
814602ad3b3SJon Loeliger		CONFIG_CMD_DATE		* support for RTC, date/time...
815602ad3b3SJon Loeliger		CONFIG_CMD_DHCP		* DHCP support
816602ad3b3SJon Loeliger		CONFIG_CMD_DIAG		* Diagnostics
817a7c93104SPeter Tyser		CONFIG_CMD_DS4510	* ds4510 I2C gpio commands
818a7c93104SPeter Tyser		CONFIG_CMD_DS4510_INFO	* ds4510 I2C info command
819a7c93104SPeter Tyser		CONFIG_CMD_DS4510_MEM	* ds4510 I2C eeprom/sram commansd
820a7c93104SPeter Tyser		CONFIG_CMD_DS4510_RST	* ds4510 I2C rst command
821602ad3b3SJon Loeliger		CONFIG_CMD_DTT		* Digital Therm and Thermostat
822602ad3b3SJon Loeliger		CONFIG_CMD_ECHO		  echo arguments
823246c6922SPeter Tyser		CONFIG_CMD_EDITENV	  edit env variable
824602ad3b3SJon Loeliger		CONFIG_CMD_EEPROM	* EEPROM read/write support
825602ad3b3SJon Loeliger		CONFIG_CMD_ELF		* bootelf, bootvx
8265e2b3e0cSJoe Hershberger		CONFIG_CMD_ENV_CALLBACK	* display details about env callbacks
827fffad71bSJoe Hershberger		CONFIG_CMD_ENV_FLAGS	* display details about env flags
8280c79cda0SMike Frysinger		CONFIG_CMD_EXPORTENV	* export the environment
82903e2ecf6SStephen Warren		CONFIG_CMD_EXT2		* ext2 command support
83003e2ecf6SStephen Warren		CONFIG_CMD_EXT4		* ext4 command support
831bdab39d3SMike Frysinger		CONFIG_CMD_SAVEENV	  saveenv
832602ad3b3SJon Loeliger		CONFIG_CMD_FDC		* Floppy Disk Support
83303e2ecf6SStephen Warren		CONFIG_CMD_FAT		* FAT command support
834602ad3b3SJon Loeliger		CONFIG_CMD_FDOS		* Dos diskette Support
835602ad3b3SJon Loeliger		CONFIG_CMD_FLASH	  flinfo, erase, protect
836602ad3b3SJon Loeliger		CONFIG_CMD_FPGA		  FPGA device initialization support
83753fdc7efSAnton Staaf		CONFIG_CMD_GETTIME	* Get time since boot
838a641b979SMike Frysinger		CONFIG_CMD_GO		* the 'go' command (exec code)
839a000b795SKim Phillips		CONFIG_CMD_GREPENV	* search environment
840bf36c5d5SSimon Glass		CONFIG_CMD_HASH		* calculate hash / digest
841602ad3b3SJon Loeliger		CONFIG_CMD_HWFLOW	* RTS/CTS hw flow control
842602ad3b3SJon Loeliger		CONFIG_CMD_I2C		* I2C serial bus support
843602ad3b3SJon Loeliger		CONFIG_CMD_IDE		* IDE harddisk support
844602ad3b3SJon Loeliger		CONFIG_CMD_IMI		  iminfo
845602ad3b3SJon Loeliger		CONFIG_CMD_IMLS		  List all found images
846602ad3b3SJon Loeliger		CONFIG_CMD_IMMAP	* IMMR dump support
8470c79cda0SMike Frysinger		CONFIG_CMD_IMPORTENV	* import an environment
848c167cc02SJoe Hershberger		CONFIG_CMD_INI		* import data from an ini file into the env
849602ad3b3SJon Loeliger		CONFIG_CMD_IRQ		* irqinfo
850602ad3b3SJon Loeliger		CONFIG_CMD_ITEST	  Integer/string test of 2 values
851602ad3b3SJon Loeliger		CONFIG_CMD_JFFS2	* JFFS2 Support
852602ad3b3SJon Loeliger		CONFIG_CMD_KGDB		* kgdb
8531ba7fd25SMike Frysinger		CONFIG_CMD_LDRINFO	  ldrinfo (display Blackfin loader)
854d22c338eSJoe Hershberger		CONFIG_CMD_LINK_LOCAL	* link-local IP address auto-configuration
855d22c338eSJoe Hershberger					  (169.254.*.*)
856602ad3b3SJon Loeliger		CONFIG_CMD_LOADB	  loadb
857602ad3b3SJon Loeliger		CONFIG_CMD_LOADS	  loads
85802c9aa1dSRobin Getz		CONFIG_CMD_MD5SUM	  print md5 message digest
85902c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
86015a33e49SSimon Glass		CONFIG_CMD_MEMINFO	* Display detailed memory information
861602ad3b3SJon Loeliger		CONFIG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
86256523f12Swdenk					  loop, loopw, mtest
863602ad3b3SJon Loeliger		CONFIG_CMD_MISC		  Misc functions like sleep etc
864602ad3b3SJon Loeliger		CONFIG_CMD_MMC		* MMC memory mapped support
865602ad3b3SJon Loeliger		CONFIG_CMD_MII		* MII utility commands
86668d7d651SStefan Roese		CONFIG_CMD_MTDPARTS	* MTD partition support
867602ad3b3SJon Loeliger		CONFIG_CMD_NAND		* NAND support
868602ad3b3SJon Loeliger		CONFIG_CMD_NET		  bootp, tftpboot, rarpboot
869e92739d3SPeter Tyser		CONFIG_CMD_PCA953X	* PCA953x I2C gpio commands
870e92739d3SPeter Tyser		CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
871602ad3b3SJon Loeliger		CONFIG_CMD_PCI		* pciinfo
872602ad3b3SJon Loeliger		CONFIG_CMD_PCMCIA		* PCMCIA support
873602ad3b3SJon Loeliger		CONFIG_CMD_PING		* send ICMP ECHO_REQUEST to network
874602ad3b3SJon Loeliger					  host
875602ad3b3SJon Loeliger		CONFIG_CMD_PORTIO	* Port I/O
876ff048ea9SKenneth Waters		CONFIG_CMD_READ		* Read raw data from partition
877602ad3b3SJon Loeliger		CONFIG_CMD_REGINFO	* Register dump
878602ad3b3SJon Loeliger		CONFIG_CMD_RUN		  run command in env variable
879602ad3b3SJon Loeliger		CONFIG_CMD_SAVES	* save S record dump
880602ad3b3SJon Loeliger		CONFIG_CMD_SCSI		* SCSI Support
881602ad3b3SJon Loeliger		CONFIG_CMD_SDRAM	* print SDRAM configuration information
882602ad3b3SJon Loeliger					  (requires CONFIG_CMD_I2C)
883602ad3b3SJon Loeliger		CONFIG_CMD_SETGETDCR	  Support for DCR Register access
884602ad3b3SJon Loeliger					  (4xx only)
885f61ec45eSEric Nelson		CONFIG_CMD_SF		* Read/write/erase SPI NOR flash
886c6b1ee66SAlexander Holler		CONFIG_CMD_SHA1SUM	  print sha1 memory digest
88702c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY)
88874de7aefSWolfgang Denk		CONFIG_CMD_SOURCE	  "source" command Support
889602ad3b3SJon Loeliger		CONFIG_CMD_SPI		* SPI serial bus support
8907a83af07SLuca Ceresoli		CONFIG_CMD_TFTPSRV	* TFTP transfer in server mode
8911fb7cd49SSimon Glass		CONFIG_CMD_TFTPPUT	* TFTP put command (upload)
892da83bcd7SJoe Hershberger		CONFIG_CMD_TIME		* run command and report execution time (ARM specific)
893da83bcd7SJoe Hershberger		CONFIG_CMD_TIMER	* access to the system tick timer
894602ad3b3SJon Loeliger		CONFIG_CMD_USB		* USB support
895602ad3b3SJon Loeliger		CONFIG_CMD_CDP		* Cisco Discover Protocol support
896c8339f51SMarek Vasut		CONFIG_CMD_MFSL		* Microblaze FSL support
897c609719bSwdenk
898c609719bSwdenk
899c609719bSwdenk		EXAMPLE: If you want all functions except of network
900c609719bSwdenk		support you can write:
901c609719bSwdenk
902602ad3b3SJon Loeliger		#include "config_cmd_all.h"
903602ad3b3SJon Loeliger		#undef CONFIG_CMD_NET
904c609719bSwdenk
905213bf8c8SGerald Van Baren	Other Commands:
906213bf8c8SGerald Van Baren		fdt (flattened device tree) command: CONFIG_OF_LIBFDT
907c609719bSwdenk
908c609719bSwdenk	Note:	Don't enable the "icache" and "dcache" commands
909602ad3b3SJon Loeliger		(configuration option CONFIG_CMD_CACHE) unless you know
910c609719bSwdenk		what you (and your U-Boot users) are doing. Data
911c609719bSwdenk		cache cannot be enabled on systems like the 8xx or
912c609719bSwdenk		8260 (where accesses to the IMMR region must be
913c609719bSwdenk		uncached), and it cannot be disabled on all other
914c609719bSwdenk		systems where we (mis-) use the data cache to hold an
915c609719bSwdenk		initial stack and some data.
916c609719bSwdenk
917c609719bSwdenk
918c609719bSwdenk		XXX - this list needs to get updated!
919c609719bSwdenk
92045ba8077SSimon Glass- Device tree:
92145ba8077SSimon Glass		CONFIG_OF_CONTROL
92245ba8077SSimon Glass		If this variable is defined, U-Boot will use a device tree
92345ba8077SSimon Glass		to configure its devices, instead of relying on statically
92445ba8077SSimon Glass		compiled #defines in the board file. This option is
92545ba8077SSimon Glass		experimental and only available on a few boards. The device
92645ba8077SSimon Glass		tree is available in the global data as gd->fdt_blob.
92745ba8077SSimon Glass
9282c0f79e4SSimon Glass		U-Boot needs to get its device tree from somewhere. This can
9292c0f79e4SSimon Glass		be done using one of the two options below:
930bbb0b128SSimon Glass
931bbb0b128SSimon Glass		CONFIG_OF_EMBED
932bbb0b128SSimon Glass		If this variable is defined, U-Boot will embed a device tree
933bbb0b128SSimon Glass		binary in its image. This device tree file should be in the
934bbb0b128SSimon Glass		board directory and called <soc>-<board>.dts. The binary file
935bbb0b128SSimon Glass		is then picked up in board_init_f() and made available through
936bbb0b128SSimon Glass		the global data structure as gd->blob.
93745ba8077SSimon Glass
9382c0f79e4SSimon Glass		CONFIG_OF_SEPARATE
9392c0f79e4SSimon Glass		If this variable is defined, U-Boot will build a device tree
9402c0f79e4SSimon Glass		binary. It will be called u-boot.dtb. Architecture-specific
9412c0f79e4SSimon Glass		code will locate it at run-time. Generally this works by:
9422c0f79e4SSimon Glass
9432c0f79e4SSimon Glass			cat u-boot.bin u-boot.dtb >image.bin
9442c0f79e4SSimon Glass
9452c0f79e4SSimon Glass		and in fact, U-Boot does this for you, creating a file called
9462c0f79e4SSimon Glass		u-boot-dtb.bin which is useful in the common case. You can
9472c0f79e4SSimon Glass		still use the individual files if you need something more
9482c0f79e4SSimon Glass		exotic.
9492c0f79e4SSimon Glass
950c609719bSwdenk- Watchdog:
951c609719bSwdenk		CONFIG_WATCHDOG
952c609719bSwdenk		If this variable is defined, it enables watchdog
9536abe6fb6SDetlev Zundel		support for the SoC. There must be support in the SoC
9546abe6fb6SDetlev Zundel		specific code for a watchdog. For the 8xx and 8260
9556abe6fb6SDetlev Zundel		CPUs, the SIU Watchdog feature is enabled in the SYPCR
9566abe6fb6SDetlev Zundel		register.  When supported for a specific SoC is
9576abe6fb6SDetlev Zundel		available, then no further board specific code should
9586abe6fb6SDetlev Zundel		be needed to use it.
9596abe6fb6SDetlev Zundel
9606abe6fb6SDetlev Zundel		CONFIG_HW_WATCHDOG
9616abe6fb6SDetlev Zundel		When using a watchdog circuitry external to the used
9626abe6fb6SDetlev Zundel		SoC, then define this variable and provide board
9636abe6fb6SDetlev Zundel		specific code for the "hw_watchdog_reset" function.
964c609719bSwdenk
965c1551ea8Sstroese- U-Boot Version:
966c1551ea8Sstroese		CONFIG_VERSION_VARIABLE
967c1551ea8Sstroese		If this variable is defined, an environment variable
968c1551ea8Sstroese		named "ver" is created by U-Boot showing the U-Boot
969c1551ea8Sstroese		version as printed by the "version" command.
970a1ea8e51SBenoît Thébaudeau		Any change to this variable will be reverted at the
971a1ea8e51SBenoît Thébaudeau		next reset.
972c1551ea8Sstroese
973c609719bSwdenk- Real-Time Clock:
974c609719bSwdenk
975602ad3b3SJon Loeliger		When CONFIG_CMD_DATE is selected, the type of the RTC
976c609719bSwdenk		has to be selected, too. Define exactly one of the
977c609719bSwdenk		following options:
978c609719bSwdenk
979c609719bSwdenk		CONFIG_RTC_MPC8xx	- use internal RTC of MPC8xx
980c609719bSwdenk		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
9814e8b7544SFabio Estevam		CONFIG_RTC_MC13XXX	- use MC13783 or MC13892 RTC
982c609719bSwdenk		CONFIG_RTC_MC146818	- use MC146818 RTC
9831cb8e980Swdenk		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
984c609719bSwdenk		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
9857f70e853Swdenk		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
9863bac3513Swdenk		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
9879536dfccSTor Krill		CONFIG_RTC_ISL1208	- use Intersil ISL1208 RTC
9884c0d4c3bSwdenk		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
9896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_DS1337_NOOSC	- Turn off the OSC output for DS1337
99071d19f30SHeiko Schocher		CONFIG_SYS_RV3029_TCR	- enable trickle charger on
99171d19f30SHeiko Schocher					  RV3029 RTC.
992c609719bSwdenk
993b37c7e5eSwdenk		Note that if the RTC uses I2C, then the I2C interface
994b37c7e5eSwdenk		must also be configured. See I2C Support, below.
995b37c7e5eSwdenk
996e92739d3SPeter Tyser- GPIO Support:
997e92739d3SPeter Tyser		CONFIG_PCA953X		- use NXP's PCA953X series I2C GPIO
998e92739d3SPeter Tyser		CONFIG_PCA953X_INFO	- enable pca953x info command
999e92739d3SPeter Tyser
10005dec49caSChris Packham		The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
10015dec49caSChris Packham		chip-ngpio pairs that tell the PCA953X driver the number of
10025dec49caSChris Packham		pins supported by a particular chip.
10035dec49caSChris Packham
1004e92739d3SPeter Tyser		Note that if the GPIO device uses I2C, then the I2C interface
1005e92739d3SPeter Tyser		must also be configured. See I2C Support, below.
1006e92739d3SPeter Tyser
1007c609719bSwdenk- Timestamp Support:
1008c609719bSwdenk
1009c609719bSwdenk		When CONFIG_TIMESTAMP is selected, the timestamp
1010c609719bSwdenk		(date and time) of an image is printed by image
1011c609719bSwdenk		commands like bootm or iminfo. This option is
1012602ad3b3SJon Loeliger		automatically enabled when you select CONFIG_CMD_DATE .
1013c609719bSwdenk
1014923c46f9SKarl O. Pinc- Partition Labels (disklabels) Supported:
1015923c46f9SKarl O. Pinc		Zero or more of the following:
1016923c46f9SKarl O. Pinc		CONFIG_MAC_PARTITION   Apple's MacOS partition table.
1017923c46f9SKarl O. Pinc		CONFIG_DOS_PARTITION   MS Dos partition table, traditional on the
1018923c46f9SKarl O. Pinc				       Intel architecture, USB sticks, etc.
1019923c46f9SKarl O. Pinc		CONFIG_ISO_PARTITION   ISO partition table, used on CDROM etc.
1020923c46f9SKarl O. Pinc		CONFIG_EFI_PARTITION   GPT partition table, common when EFI is the
1021923c46f9SKarl O. Pinc				       bootloader.  Note 2TB partition limit; see
1022923c46f9SKarl O. Pinc				       disk/part_efi.c
1023923c46f9SKarl O. Pinc		CONFIG_MTD_PARTITIONS  Memory Technology Device partition table.
1024c609719bSwdenk
1025602ad3b3SJon Loeliger		If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1026218ca724SWolfgang Denk		CONFIG_CMD_SCSI) you must configure support for at
1027923c46f9SKarl O. Pinc		least one non-MTD partition type as well.
1028c609719bSwdenk
1029c609719bSwdenk- IDE Reset method:
10304d13cbadSwdenk		CONFIG_IDE_RESET_ROUTINE - this is defined in several
10314d13cbadSwdenk		board configurations files but used nowhere!
1032c609719bSwdenk
10334d13cbadSwdenk		CONFIG_IDE_RESET - is this is defined, IDE Reset will
10344d13cbadSwdenk		be performed by calling the function
10354d13cbadSwdenk			ide_set_reset(int reset)
10364d13cbadSwdenk		which has to be defined in a board specific file
1037c609719bSwdenk
1038c609719bSwdenk- ATAPI Support:
1039c609719bSwdenk		CONFIG_ATAPI
1040c609719bSwdenk
1041c609719bSwdenk		Set this to enable ATAPI support.
1042c609719bSwdenk
1043c40b2956Swdenk- LBA48 Support
1044c40b2956Swdenk		CONFIG_LBA48
1045c40b2956Swdenk
1046c40b2956Swdenk		Set this to enable support for disks larger than 137GB
10474b142febSHeiko Schocher		Also look at CONFIG_SYS_64BIT_LBA.
1048c40b2956Swdenk		Whithout these , LBA48 support uses 32bit variables and will 'only'
1049c40b2956Swdenk		support disks up to 2.1TB.
1050c40b2956Swdenk
10516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_64BIT_LBA:
1052c40b2956Swdenk			When enabled, makes the IDE subsystem use 64bit sector addresses.
1053c40b2956Swdenk			Default is 32bit.
1054c40b2956Swdenk
1055c609719bSwdenk- SCSI Support:
1056c609719bSwdenk		At the moment only there is only support for the
1057c609719bSwdenk		SYM53C8XX SCSI controller; define
1058c609719bSwdenk		CONFIG_SCSI_SYM53C8XX to enable it.
1059c609719bSwdenk
10606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
10616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
10626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
1063c609719bSwdenk		maximum numbers of LUNs, SCSI ID's and target
1064c609719bSwdenk		devices.
10656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
1066c609719bSwdenk
1067447c031bSStefan Reinauer                The environment variable 'scsidevs' is set to the number of
1068447c031bSStefan Reinauer                SCSI devices found during the last scan.
1069447c031bSStefan Reinauer
1070c609719bSwdenk- NETWORK Support (PCI):
1071682011ffSwdenk		CONFIG_E1000
1072ce5207e1SKyle Moffett		Support for Intel 8254x/8257x gigabit chips.
1073ce5207e1SKyle Moffett
1074ce5207e1SKyle Moffett		CONFIG_E1000_SPI
1075ce5207e1SKyle Moffett		Utility code for direct access to the SPI bus on Intel 8257x.
1076ce5207e1SKyle Moffett		This does not do anything useful unless you set at least one
1077ce5207e1SKyle Moffett		of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1078ce5207e1SKyle Moffett
1079ce5207e1SKyle Moffett		CONFIG_E1000_SPI_GENERIC
1080ce5207e1SKyle Moffett		Allow generic access to the SPI bus on the Intel 8257x, for
1081ce5207e1SKyle Moffett		example with the "sspi" command.
1082ce5207e1SKyle Moffett
1083ce5207e1SKyle Moffett		CONFIG_CMD_E1000
1084ce5207e1SKyle Moffett		Management command for E1000 devices.  When used on devices
1085ce5207e1SKyle Moffett		with SPI support you can reprogram the EEPROM from U-Boot.
1086682011ffSwdenk
1087ac3315c2SAndre Schwarz		CONFIG_E1000_FALLBACK_MAC
108811ccc33fSMarcel Ziswiler		default MAC for empty EEPROM after production.
1089ac3315c2SAndre Schwarz
1090c609719bSwdenk		CONFIG_EEPRO100
1091c609719bSwdenk		Support for Intel 82557/82559/82559ER chips.
109211ccc33fSMarcel Ziswiler		Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
1093c609719bSwdenk		write routine for first time initialisation.
1094c609719bSwdenk
1095c609719bSwdenk		CONFIG_TULIP
1096c609719bSwdenk		Support for Digital 2114x chips.
1097c609719bSwdenk		Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1098c609719bSwdenk		modem chip initialisation (KS8761/QS6611).
1099c609719bSwdenk
1100c609719bSwdenk		CONFIG_NATSEMI
1101c609719bSwdenk		Support for National dp83815 chips.
1102c609719bSwdenk
1103c609719bSwdenk		CONFIG_NS8382X
1104c609719bSwdenk		Support for National dp8382[01] gigabit chips.
1105c609719bSwdenk
110645219c46Swdenk- NETWORK Support (other):
110745219c46Swdenk
1108c041e9d2SJens Scharsig		CONFIG_DRIVER_AT91EMAC
1109c041e9d2SJens Scharsig		Support for AT91RM9200 EMAC.
1110c041e9d2SJens Scharsig
1111c041e9d2SJens Scharsig			CONFIG_RMII
1112c041e9d2SJens Scharsig			Define this to use reduced MII inteface
1113c041e9d2SJens Scharsig
1114c041e9d2SJens Scharsig			CONFIG_DRIVER_AT91EMAC_QUIET
1115c041e9d2SJens Scharsig			If this defined, the driver is quiet.
1116c041e9d2SJens Scharsig			The driver doen't show link status messages.
1117c041e9d2SJens Scharsig
1118efdd7319SRob Herring		CONFIG_CALXEDA_XGMAC
1119efdd7319SRob Herring		Support for the Calxeda XGMAC device
1120efdd7319SRob Herring
11213bb46d23SAshok		CONFIG_LAN91C96
112245219c46Swdenk		Support for SMSC's LAN91C96 chips.
112345219c46Swdenk
112445219c46Swdenk			CONFIG_LAN91C96_BASE
112545219c46Swdenk			Define this to hold the physical address
112645219c46Swdenk			of the LAN91C96's I/O space
112745219c46Swdenk
112845219c46Swdenk			CONFIG_LAN91C96_USE_32_BIT
112945219c46Swdenk			Define this to enable 32 bit addressing
113045219c46Swdenk
11313bb46d23SAshok		CONFIG_SMC91111
1132f39748aeSwdenk		Support for SMSC's LAN91C111 chip
1133f39748aeSwdenk
1134f39748aeSwdenk			CONFIG_SMC91111_BASE
1135f39748aeSwdenk			Define this to hold the physical address
1136f39748aeSwdenk			of the device (I/O space)
1137f39748aeSwdenk
1138f39748aeSwdenk			CONFIG_SMC_USE_32_BIT
1139f39748aeSwdenk			Define this if data bus is 32 bits
1140f39748aeSwdenk
1141f39748aeSwdenk			CONFIG_SMC_USE_IOFUNCS
1142f39748aeSwdenk			Define this to use i/o functions instead of macros
1143f39748aeSwdenk			(some hardware wont work with macros)
1144f39748aeSwdenk
1145dc02badaSHeiko Schocher		CONFIG_DRIVER_TI_EMAC
1146dc02badaSHeiko Schocher		Support for davinci emac
1147dc02badaSHeiko Schocher
1148dc02badaSHeiko Schocher			CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1149dc02badaSHeiko Schocher			Define this if you have more then 3 PHYs.
1150dc02badaSHeiko Schocher
1151b3dbf4a5SMacpaul Lin		CONFIG_FTGMAC100
1152b3dbf4a5SMacpaul Lin		Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1153b3dbf4a5SMacpaul Lin
1154b3dbf4a5SMacpaul Lin			CONFIG_FTGMAC100_EGIGA
1155b3dbf4a5SMacpaul Lin			Define this to use GE link update with gigabit PHY.
1156b3dbf4a5SMacpaul Lin			Define this if FTGMAC100 is connected to gigabit PHY.
1157b3dbf4a5SMacpaul Lin			If your system has 10/100 PHY only, it might not occur
1158b3dbf4a5SMacpaul Lin			wrong behavior. Because PHY usually return timeout or
1159b3dbf4a5SMacpaul Lin			useless data when polling gigabit status and gigabit
1160b3dbf4a5SMacpaul Lin			control registers. This behavior won't affect the
1161b3dbf4a5SMacpaul Lin			correctnessof 10/100 link speed update.
1162b3dbf4a5SMacpaul Lin
1163c2fff331SMike Rapoport		CONFIG_SMC911X
1164557b377dSJens Gehrlein		Support for SMSC's LAN911x and LAN921x chips
1165557b377dSJens Gehrlein
1166c2fff331SMike Rapoport			CONFIG_SMC911X_BASE
1167557b377dSJens Gehrlein			Define this to hold the physical address
1168557b377dSJens Gehrlein			of the device (I/O space)
1169557b377dSJens Gehrlein
1170c2fff331SMike Rapoport			CONFIG_SMC911X_32_BIT
1171557b377dSJens Gehrlein			Define this if data bus is 32 bits
1172557b377dSJens Gehrlein
1173c2fff331SMike Rapoport			CONFIG_SMC911X_16_BIT
1174557b377dSJens Gehrlein			Define this if data bus is 16 bits. If your processor
1175557b377dSJens Gehrlein			automatically converts one 32 bit word to two 16 bit
1176c2fff331SMike Rapoport			words you may also try CONFIG_SMC911X_32_BIT.
1177557b377dSJens Gehrlein
11783d0075faSYoshihiro Shimoda		CONFIG_SH_ETHER
11793d0075faSYoshihiro Shimoda		Support for Renesas on-chip Ethernet controller
11803d0075faSYoshihiro Shimoda
11813d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_USE_PORT
11823d0075faSYoshihiro Shimoda			Define the number of ports to be used
11833d0075faSYoshihiro Shimoda
11843d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_PHY_ADDR
11853d0075faSYoshihiro Shimoda			Define the ETH PHY's address
11863d0075faSYoshihiro Shimoda
118768260aabSYoshihiro Shimoda			CONFIG_SH_ETHER_CACHE_WRITEBACK
118868260aabSYoshihiro Shimoda			If this option is set, the driver enables cache flush.
118968260aabSYoshihiro Shimoda
11905e124724SVadim Bendebury- TPM Support:
11915e124724SVadim Bendebury		CONFIG_GENERIC_LPC_TPM
11925e124724SVadim Bendebury		Support for generic parallel port TPM devices. Only one device
11935e124724SVadim Bendebury		per system is supported at this time.
11945e124724SVadim Bendebury
11955e124724SVadim Bendebury			CONFIG_TPM_TIS_BASE_ADDRESS
11965e124724SVadim Bendebury			Base address where the generic TPM device is mapped
11975e124724SVadim Bendebury			to. Contemporary x86 systems usually map it at
11985e124724SVadim Bendebury			0xfed40000.
11995e124724SVadim Bendebury
1200c609719bSwdenk- USB Support:
1201c609719bSwdenk		At the moment only the UHCI host controller is
12024d13cbadSwdenk		supported (PIP405, MIP405, MPC5200); define
1203c609719bSwdenk		CONFIG_USB_UHCI to enable it.
1204c609719bSwdenk		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
120530d56faeSwdenk		and define CONFIG_USB_STORAGE to enable the USB
1206c609719bSwdenk		storage devices.
1207c609719bSwdenk		Note:
1208c609719bSwdenk		Supported are USB Keyboards and USB Floppy drives
1209c609719bSwdenk		(TEAC FD-05PUB).
12104d13cbadSwdenk		MPC5200 USB requires additional defines:
12114d13cbadSwdenk			CONFIG_USB_CLOCK
12124d13cbadSwdenk				for 528 MHz Clock: 0x0001bbbb
1213307ecb6dSEric Millbrandt			CONFIG_PSC3_USB
1214307ecb6dSEric Millbrandt				for USB on PSC3
12154d13cbadSwdenk			CONFIG_USB_CONFIG
12164d13cbadSwdenk				for differential drivers: 0x00001000
12174d13cbadSwdenk				for single ended drivers: 0x00005000
1218307ecb6dSEric Millbrandt				for differential drivers on PSC3: 0x00000100
1219307ecb6dSEric Millbrandt				for single ended drivers on PSC3: 0x00004100
12206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_USB_EVENT_POLL
1221fdcfaa1bSZhang Wei				May be defined to allow interrupt polling
1222fdcfaa1bSZhang Wei				instead of using asynchronous interrupts
12234d13cbadSwdenk
12249ab4ce22SSimon Glass		CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
12259ab4ce22SSimon Glass		txfilltuning field in the EHCI controller on reset.
12269ab4ce22SSimon Glass
122716c8d5e7SWolfgang Denk- USB Device:
122816c8d5e7SWolfgang Denk		Define the below if you wish to use the USB console.
122916c8d5e7SWolfgang Denk		Once firmware is rebuilt from a serial console issue the
123016c8d5e7SWolfgang Denk		command "setenv stdin usbtty; setenv stdout usbtty" and
123111ccc33fSMarcel Ziswiler		attach your USB cable. The Unix command "dmesg" should print
123216c8d5e7SWolfgang Denk		it has found a new device. The environment variable usbtty
123316c8d5e7SWolfgang Denk		can be set to gserial or cdc_acm to enable your device to
123416c8d5e7SWolfgang Denk		appear to a USB host as a Linux gserial device or a
123516c8d5e7SWolfgang Denk		Common Device Class Abstract Control Model serial device.
123616c8d5e7SWolfgang Denk		If you select usbtty = gserial you should be able to enumerate
123716c8d5e7SWolfgang Denk		a Linux host by
123816c8d5e7SWolfgang Denk		# modprobe usbserial vendor=0xVendorID product=0xProductID
123916c8d5e7SWolfgang Denk		else if using cdc_acm, simply setting the environment
124016c8d5e7SWolfgang Denk		variable usbtty to be cdc_acm should suffice. The following
124116c8d5e7SWolfgang Denk		might be defined in YourBoardName.h
124216c8d5e7SWolfgang Denk
124316c8d5e7SWolfgang Denk			CONFIG_USB_DEVICE
124416c8d5e7SWolfgang Denk			Define this to build a UDC device
124516c8d5e7SWolfgang Denk
124616c8d5e7SWolfgang Denk			CONFIG_USB_TTY
124716c8d5e7SWolfgang Denk			Define this to have a tty type of device available to
124816c8d5e7SWolfgang Denk			talk to the UDC device
124916c8d5e7SWolfgang Denk
1250f9da0f89SVipin KUMAR			CONFIG_USBD_HS
1251f9da0f89SVipin KUMAR			Define this to enable the high speed support for usb
1252f9da0f89SVipin KUMAR			device and usbtty. If this feature is enabled, a routine
1253f9da0f89SVipin KUMAR			int is_usbd_high_speed(void)
1254f9da0f89SVipin KUMAR			also needs to be defined by the driver to dynamically poll
1255f9da0f89SVipin KUMAR			whether the enumeration has succeded at high speed or full
1256f9da0f89SVipin KUMAR			speed.
1257f9da0f89SVipin KUMAR
12586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_IS_IN_ENV
125916c8d5e7SWolfgang Denk			Define this if you want stdin, stdout &/or stderr to
126016c8d5e7SWolfgang Denk			be set to usbtty.
126116c8d5e7SWolfgang Denk
126216c8d5e7SWolfgang Denk			mpc8xx:
12636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_EXTC_CLK 0xBLAH
126416c8d5e7SWolfgang Denk				Derive USB clock from external clock "blah"
12656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_EXTC_CLK 0x02
126616c8d5e7SWolfgang Denk
12676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_BRG_CLK 0xBLAH
126816c8d5e7SWolfgang Denk				Derive USB clock from brgclk
12696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_BRG_CLK 0x04
127016c8d5e7SWolfgang Denk
127116c8d5e7SWolfgang Denk		If you have a USB-IF assigned VendorID then you may wish to
127216c8d5e7SWolfgang Denk		define your own vendor specific values either in BoardName.h
127316c8d5e7SWolfgang Denk		or directly in usbd_vendor_info.h. If you don't define
127416c8d5e7SWolfgang Denk		CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
127516c8d5e7SWolfgang Denk		CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
127616c8d5e7SWolfgang Denk		should pretend to be a Linux device to it's target host.
127716c8d5e7SWolfgang Denk
127816c8d5e7SWolfgang Denk			CONFIG_USBD_MANUFACTURER
127916c8d5e7SWolfgang Denk			Define this string as the name of your company for
128016c8d5e7SWolfgang Denk			- CONFIG_USBD_MANUFACTURER "my company"
128116c8d5e7SWolfgang Denk
128216c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCT_NAME
128316c8d5e7SWolfgang Denk			Define this string as the name of your product
128416c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCT_NAME "acme usb device"
128516c8d5e7SWolfgang Denk
128616c8d5e7SWolfgang Denk			CONFIG_USBD_VENDORID
128716c8d5e7SWolfgang Denk			Define this as your assigned Vendor ID from the USB
128816c8d5e7SWolfgang Denk			Implementors Forum. This *must* be a genuine Vendor ID
128916c8d5e7SWolfgang Denk			to avoid polluting the USB namespace.
129016c8d5e7SWolfgang Denk			- CONFIG_USBD_VENDORID 0xFFFF
129116c8d5e7SWolfgang Denk
129216c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCTID
129316c8d5e7SWolfgang Denk			Define this as the unique Product ID
129416c8d5e7SWolfgang Denk			for your device
129516c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCTID 0xFFFF
1296c609719bSwdenk
1297d70a560fSIgor Grinberg- ULPI Layer Support:
1298d70a560fSIgor Grinberg		The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1299d70a560fSIgor Grinberg		the generic ULPI layer. The generic layer accesses the ULPI PHY
1300d70a560fSIgor Grinberg		via the platform viewport, so you need both the genric layer and
1301d70a560fSIgor Grinberg		the viewport enabled. Currently only Chipidea/ARC based
1302d70a560fSIgor Grinberg		viewport is supported.
1303d70a560fSIgor Grinberg		To enable the ULPI layer support, define CONFIG_USB_ULPI and
1304d70a560fSIgor Grinberg		CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
13056d365ea0SLucas Stach		If your ULPI phy needs a different reference clock than the
13066d365ea0SLucas Stach		standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
13076d365ea0SLucas Stach		the appropriate value in Hz.
1308c609719bSwdenk
1309c609719bSwdenk- MMC Support:
1310c609719bSwdenk		The MMC controller on the Intel PXA is supported. To
1311c609719bSwdenk		enable this define CONFIG_MMC. The MMC can be
1312c609719bSwdenk		accessed from the boot prompt by mapping the device
1313c609719bSwdenk		to physical memory similar to flash. Command line is
1314602ad3b3SJon Loeliger		enabled with CONFIG_CMD_MMC. The MMC driver also works with
1315602ad3b3SJon Loeliger		the FAT fs. This is enabled with CONFIG_CMD_FAT.
1316c609719bSwdenk
1317afb35666SYoshihiro Shimoda		CONFIG_SH_MMCIF
1318afb35666SYoshihiro Shimoda		Support for Renesas on-chip MMCIF controller
1319afb35666SYoshihiro Shimoda
1320afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_ADDR
1321afb35666SYoshihiro Shimoda			Define the base address of MMCIF registers
1322afb35666SYoshihiro Shimoda
1323afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_CLK
1324afb35666SYoshihiro Shimoda			Define the clock frequency for MMCIF
1325afb35666SYoshihiro Shimoda
13266705d81eSwdenk- Journaling Flash filesystem support:
13276705d81eSwdenk		CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
13286705d81eSwdenk		CONFIG_JFFS2_NAND_DEV
13296705d81eSwdenk		Define these for a default partition on a NAND device
13306705d81eSwdenk
13316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_SECTOR,
13326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
13336705d81eSwdenk		Define these for a default partition on a NOR device
13346705d81eSwdenk
13356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS_CUSTOM_PART
13366705d81eSwdenk		Define this to create an own partition. You have to provide a
13376705d81eSwdenk		function struct part_info* jffs2_part_info(int part_num)
13386705d81eSwdenk
13396705d81eSwdenk		If you define only one JFFS2 partition you may also want to
13406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_JFFS_SINGLE_PART	1
13416705d81eSwdenk		to disable the command chpart. This is the default when you
13426705d81eSwdenk		have not defined a custom partition
13436705d81eSwdenk
1344c30a15e5SDonggeun Kim- FAT(File Allocation Table) filesystem write function support:
1345c30a15e5SDonggeun Kim		CONFIG_FAT_WRITE
1346656f4c65SDonggeun Kim
1347656f4c65SDonggeun Kim		Define this to enable support for saving memory data as a
1348656f4c65SDonggeun Kim		file in FAT formatted partition.
1349656f4c65SDonggeun Kim
1350656f4c65SDonggeun Kim		This will also enable the command "fatwrite" enabling the
1351656f4c65SDonggeun Kim		user to write files to FAT.
1352c30a15e5SDonggeun Kim
135384cd9327SGabe BlackCBFS (Coreboot Filesystem) support
135484cd9327SGabe Black		CONFIG_CMD_CBFS
135584cd9327SGabe Black
135684cd9327SGabe Black		Define this to enable support for reading from a Coreboot
135784cd9327SGabe Black		filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
135884cd9327SGabe Black		and cbfsload.
135984cd9327SGabe Black
1360c609719bSwdenk- Keyboard Support:
1361c609719bSwdenk		CONFIG_ISA_KEYBOARD
1362c609719bSwdenk
1363c609719bSwdenk		Define this to enable standard (PC-Style) keyboard
1364c609719bSwdenk		support
1365c609719bSwdenk
1366c609719bSwdenk		CONFIG_I8042_KBD
1367c609719bSwdenk		Standard PC keyboard driver with US (is default) and
1368c609719bSwdenk		GERMAN key layout (switch via environment 'keymap=de') support.
1369c609719bSwdenk		Export function i8042_kbd_init, i8042_tstc and i8042_getc
1370c609719bSwdenk		for cfb_console. Supports cursor blinking.
1371c609719bSwdenk
1372c609719bSwdenk- Video support:
1373c609719bSwdenk		CONFIG_VIDEO
1374c609719bSwdenk
1375c609719bSwdenk		Define this to enable video support (for output to
1376c609719bSwdenk		video).
1377c609719bSwdenk
1378c609719bSwdenk		CONFIG_VIDEO_CT69000
1379c609719bSwdenk
1380c609719bSwdenk		Enable Chips & Technologies 69000 Video chip
1381c609719bSwdenk
1382c609719bSwdenk		CONFIG_VIDEO_SMI_LYNXEM
1383eeb1b77bSwdenk		Enable Silicon Motion SMI 712/710/810 Video chip. The
1384eeb1b77bSwdenk		video output is selected via environment 'videoout'
1385eeb1b77bSwdenk		(1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1386eeb1b77bSwdenk		assumed.
1387c609719bSwdenk
1388eeb1b77bSwdenk		For the CT69000 and SMI_LYNXEM drivers, videomode is
138911ccc33fSMarcel Ziswiler		selected via environment 'videomode'. Two different ways
1390eeb1b77bSwdenk		are possible:
1391eeb1b77bSwdenk		- "videomode=num"   'num' is a standard LiLo mode numbers.
1392eeb1b77bSwdenk		Following standard modes are supported	(* is default):
1393eeb1b77bSwdenk
1394eeb1b77bSwdenk		      Colors	640x480 800x600 1024x768 1152x864 1280x1024
1395eeb1b77bSwdenk		-------------+---------------------------------------------
1396eeb1b77bSwdenk		      8 bits |	0x301*	0x303	 0x305	  0x161	    0x307
1397eeb1b77bSwdenk		     15 bits |	0x310	0x313	 0x316	  0x162	    0x319
1398eeb1b77bSwdenk		     16 bits |	0x311	0x314	 0x317	  0x163	    0x31A
1399eeb1b77bSwdenk		     24 bits |	0x312	0x315	 0x318	    ?	    0x31B
1400eeb1b77bSwdenk		-------------+---------------------------------------------
1401c609719bSwdenk		(i.e. setenv videomode 317; saveenv; reset;)
1402c609719bSwdenk
1403eeb1b77bSwdenk		- "videomode=bootargs" all the video parameters are parsed
14047817cb20SMarcel Ziswiler		from the bootargs. (See drivers/video/videomodes.c)
1405eeb1b77bSwdenk
1406eeb1b77bSwdenk
1407a6c7ad2fSwdenk		CONFIG_VIDEO_SED13806
1408a6c7ad2fSwdenk		Enable Epson SED13806 driver. This driver supports 8bpp
1409a6c7ad2fSwdenk		and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1410a6c7ad2fSwdenk		or CONFIG_VIDEO_SED13806_16BPP
1411a6c7ad2fSwdenk
14127d3053fbSTimur Tabi		CONFIG_FSL_DIU_FB
14137d3053fbSTimur Tabi		Enable the Freescale DIU video driver.	Reference boards for
14147d3053fbSTimur Tabi		SOCs that have a DIU should define this macro to enable DIU
14157d3053fbSTimur Tabi		support, and should also define these other macros:
14167d3053fbSTimur Tabi
14177d3053fbSTimur Tabi			CONFIG_SYS_DIU_ADDR
14187d3053fbSTimur Tabi			CONFIG_VIDEO
14197d3053fbSTimur Tabi			CONFIG_CMD_BMP
14207d3053fbSTimur Tabi			CONFIG_CFB_CONSOLE
14217d3053fbSTimur Tabi			CONFIG_VIDEO_SW_CURSOR
14227d3053fbSTimur Tabi			CONFIG_VGA_AS_SINGLE_DEVICE
14237d3053fbSTimur Tabi			CONFIG_VIDEO_LOGO
14247d3053fbSTimur Tabi			CONFIG_VIDEO_BMP_LOGO
14257d3053fbSTimur Tabi
1426ba8e76bdSTimur Tabi		The DIU driver will look for the 'video-mode' environment
1427ba8e76bdSTimur Tabi		variable, and if defined, enable the DIU as a console during
1428ba8e76bdSTimur Tabi		boot.  See the documentation file README.video for a
1429ba8e76bdSTimur Tabi		description of this variable.
14307d3053fbSTimur Tabi
1431058d59b0SSimon Glass		CONFIG_VIDEO_VGA
1432058d59b0SSimon Glass
1433058d59b0SSimon Glass		Enable the VGA video / BIOS for x86. The alternative if you
1434058d59b0SSimon Glass		are using coreboot is to use the coreboot frame buffer
1435058d59b0SSimon Glass		driver.
1436058d59b0SSimon Glass
1437058d59b0SSimon Glass
1438682011ffSwdenk- Keyboard Support:
1439682011ffSwdenk		CONFIG_KEYBOARD
1440682011ffSwdenk
1441682011ffSwdenk		Define this to enable a custom keyboard support.
1442682011ffSwdenk		This simply calls drv_keyboard_init() which must be
1443682011ffSwdenk		defined in your board-specific files.
1444682011ffSwdenk		The only board using this so far is RBC823.
1445a6c7ad2fSwdenk
1446c609719bSwdenk- LCD Support:	CONFIG_LCD
1447c609719bSwdenk
1448c609719bSwdenk		Define this to enable LCD support (for output to LCD
1449c609719bSwdenk		display); also select one of the supported displays
1450c609719bSwdenk		by defining one of these:
1451c609719bSwdenk
145239cf4804SStelian Pop		CONFIG_ATMEL_LCD:
145339cf4804SStelian Pop
145439cf4804SStelian Pop			HITACHI TX09D70VM1CCA, 3.5", 240x320.
145539cf4804SStelian Pop
1456fd3103bbSwdenk		CONFIG_NEC_NL6448AC33:
1457c609719bSwdenk
1458fd3103bbSwdenk			NEC NL6448AC33-18. Active, color, single scan.
1459c609719bSwdenk
1460fd3103bbSwdenk		CONFIG_NEC_NL6448BC20
1461c609719bSwdenk
1462fd3103bbSwdenk			NEC NL6448BC20-08. 6.5", 640x480.
1463fd3103bbSwdenk			Active, color, single scan.
1464fd3103bbSwdenk
1465fd3103bbSwdenk		CONFIG_NEC_NL6448BC33_54
1466fd3103bbSwdenk
1467fd3103bbSwdenk			NEC NL6448BC33-54. 10.4", 640x480.
1468c609719bSwdenk			Active, color, single scan.
1469c609719bSwdenk
1470c609719bSwdenk		CONFIG_SHARP_16x9
1471c609719bSwdenk
1472c609719bSwdenk			Sharp 320x240. Active, color, single scan.
1473c609719bSwdenk			It isn't 16x9, and I am not sure what it is.
1474c609719bSwdenk
1475c609719bSwdenk		CONFIG_SHARP_LQ64D341
1476c609719bSwdenk
1477c609719bSwdenk			Sharp LQ64D341 display, 640x480.
1478c609719bSwdenk			Active, color, single scan.
1479c609719bSwdenk
1480c609719bSwdenk		CONFIG_HLD1045
1481c609719bSwdenk
1482c609719bSwdenk			HLD1045 display, 640x480.
1483c609719bSwdenk			Active, color, single scan.
1484c609719bSwdenk
1485c609719bSwdenk		CONFIG_OPTREX_BW
1486c609719bSwdenk
1487c609719bSwdenk			Optrex	 CBL50840-2 NF-FW 99 22 M5
1488c609719bSwdenk			or
1489c609719bSwdenk			Hitachi	 LMG6912RPFC-00T
1490c609719bSwdenk			or
1491c609719bSwdenk			Hitachi	 SP14Q002
1492c609719bSwdenk
1493c609719bSwdenk			320x240. Black & white.
1494c609719bSwdenk
1495c609719bSwdenk		Normally display is black on white background; define
14966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
1497c609719bSwdenk
1498676d319eSSimon Glass		CONFIG_LCD_ALIGNMENT
1499676d319eSSimon Glass
1500676d319eSSimon Glass		Normally the LCD is page-aligned (tyically 4KB). If this is
1501676d319eSSimon Glass		defined then the LCD will be aligned to this value instead.
1502676d319eSSimon Glass		For ARM it is sometimes useful to use MMU_SECTION_SIZE
1503676d319eSSimon Glass		here, since it is cheaper to change data cache settings on
1504676d319eSSimon Glass		a per-section basis.
1505676d319eSSimon Glass
15060d89efefSSimon Glass		CONFIG_CONSOLE_SCROLL_LINES
15070d89efefSSimon Glass
15080d89efefSSimon Glass		When the console need to be scrolled, this is the number of
15090d89efefSSimon Glass		lines to scroll by. It defaults to 1. Increasing this makes
15100d89efefSSimon Glass		the console jump but can help speed up operation when scrolling
15110d89efefSSimon Glass		is slow.
1512676d319eSSimon Glass
151345d7f525STom Wai-Hong Tam		CONFIG_LCD_BMP_RLE8
151445d7f525STom Wai-Hong Tam
151545d7f525STom Wai-Hong Tam		Support drawing of RLE8-compressed bitmaps on the LCD.
151645d7f525STom Wai-Hong Tam
1517735987c5STom Wai-Hong Tam		CONFIG_I2C_EDID
1518735987c5STom Wai-Hong Tam
1519735987c5STom Wai-Hong Tam		Enables an 'i2c edid' command which can read EDID
1520735987c5STom Wai-Hong Tam		information over I2C from an attached LCD display.
1521735987c5STom Wai-Hong Tam
15227152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN
1523d791b1dcSwdenk
1524d791b1dcSwdenk		If this option is set, the environment is checked for
1525d791b1dcSwdenk		a variable "splashimage". If found, the usual display
1526d791b1dcSwdenk		of logo, copyright and system information on the LCD
1527e94d2cd9Swdenk		is suppressed and the BMP image at the address
1528d791b1dcSwdenk		specified in "splashimage" is loaded instead. The
1529d791b1dcSwdenk		console is redirected to the "nulldev", too. This
1530d791b1dcSwdenk		allows for a "silent" boot where a splash screen is
1531d791b1dcSwdenk		loaded very quickly after power-on.
1532d791b1dcSwdenk
15331ca298ceSMatthias Weisser		CONFIG_SPLASH_SCREEN_ALIGN
15341ca298ceSMatthias Weisser
15351ca298ceSMatthias Weisser		If this option is set the splash image can be freely positioned
15361ca298ceSMatthias Weisser		on the screen. Environment variable "splashpos" specifies the
15371ca298ceSMatthias Weisser		position as "x,y". If a positive number is given it is used as
15381ca298ceSMatthias Weisser		number of pixel from left/top. If a negative number is given it
15391ca298ceSMatthias Weisser		is used as number of pixel from right/bottom. You can also
15401ca298ceSMatthias Weisser		specify 'm' for centering the image.
15411ca298ceSMatthias Weisser
15421ca298ceSMatthias Weisser		Example:
15431ca298ceSMatthias Weisser		setenv splashpos m,m
15441ca298ceSMatthias Weisser			=> image at center of screen
15451ca298ceSMatthias Weisser
15461ca298ceSMatthias Weisser		setenv splashpos 30,20
15471ca298ceSMatthias Weisser			=> image at x = 30 and y = 20
15481ca298ceSMatthias Weisser
15491ca298ceSMatthias Weisser		setenv splashpos -10,m
15501ca298ceSMatthias Weisser			=> vertically centered image
15511ca298ceSMatthias Weisser			   at x = dspWidth - bmpWidth - 9
15521ca298ceSMatthias Weisser
155398f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
155498f4a3dfSStefan Roese
155598f4a3dfSStefan Roese		If this option is set, additionally to standard BMP
155698f4a3dfSStefan Roese		images, gzipped BMP images can be displayed via the
155798f4a3dfSStefan Roese		splashscreen support or the bmp command.
155898f4a3dfSStefan Roese
1559d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1560d5011762SAnatolij Gustschin
1561d5011762SAnatolij Gustschin		If this option is set, 8-bit RLE compressed BMP images
1562d5011762SAnatolij Gustschin		can be displayed via the splashscreen support or the
1563d5011762SAnatolij Gustschin		bmp command.
1564d5011762SAnatolij Gustschin
1565f2b96dfbSLei Wen- Do compresssing for memory range:
1566f2b96dfbSLei Wen		CONFIG_CMD_ZIP
1567f2b96dfbSLei Wen
1568f2b96dfbSLei Wen		If this option is set, it would use zlib deflate method
1569f2b96dfbSLei Wen		to compress the specified memory at its best effort.
1570f2b96dfbSLei Wen
1571c29fdfc1Swdenk- Compression support:
1572c29fdfc1Swdenk		CONFIG_BZIP2
1573c29fdfc1Swdenk
1574c29fdfc1Swdenk		If this option is set, support for bzip2 compressed
1575c29fdfc1Swdenk		images is included. If not, only uncompressed and gzip
1576c29fdfc1Swdenk		compressed images are supported.
1577c29fdfc1Swdenk
1578c29fdfc1Swdenk		NOTE: the bzip2 algorithm requires a lot of RAM, so
15796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
1580c29fdfc1Swdenk		be at least 4MB.
1581d791b1dcSwdenk
1582fc9c1727SLuigi 'Comio' Mantellini		CONFIG_LZMA
1583fc9c1727SLuigi 'Comio' Mantellini
1584fc9c1727SLuigi 'Comio' Mantellini		If this option is set, support for lzma compressed
1585fc9c1727SLuigi 'Comio' Mantellini		images is included.
1586fc9c1727SLuigi 'Comio' Mantellini
1587fc9c1727SLuigi 'Comio' Mantellini		Note: The LZMA algorithm adds between 2 and 4KB of code and it
1588fc9c1727SLuigi 'Comio' Mantellini		requires an amount of dynamic memory that is given by the
1589fc9c1727SLuigi 'Comio' Mantellini		formula:
1590fc9c1727SLuigi 'Comio' Mantellini
1591fc9c1727SLuigi 'Comio' Mantellini			(1846 + 768 << (lc + lp)) * sizeof(uint16)
1592fc9c1727SLuigi 'Comio' Mantellini
1593fc9c1727SLuigi 'Comio' Mantellini		Where lc and lp stand for, respectively, Literal context bits
1594fc9c1727SLuigi 'Comio' Mantellini		and Literal pos bits.
1595fc9c1727SLuigi 'Comio' Mantellini
1596fc9c1727SLuigi 'Comio' Mantellini		This value is upper-bounded by 14MB in the worst case. Anyway,
1597fc9c1727SLuigi 'Comio' Mantellini		for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1598fc9c1727SLuigi 'Comio' Mantellini		total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1599fc9c1727SLuigi 'Comio' Mantellini		a very small buffer.
1600fc9c1727SLuigi 'Comio' Mantellini
1601fc9c1727SLuigi 'Comio' Mantellini		Use the lzmainfo tool to determinate the lc and lp values and
1602fc9c1727SLuigi 'Comio' Mantellini		then calculate the amount of needed dynamic memory (ensuring
16036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the appropriate CONFIG_SYS_MALLOC_LEN value).
1604fc9c1727SLuigi 'Comio' Mantellini
160517ea1177Swdenk- MII/PHY support:
160617ea1177Swdenk		CONFIG_PHY_ADDR
160717ea1177Swdenk
160817ea1177Swdenk		The address of PHY on MII bus.
160917ea1177Swdenk
161017ea1177Swdenk		CONFIG_PHY_CLOCK_FREQ (ppc4xx)
161117ea1177Swdenk
161217ea1177Swdenk		The clock frequency of the MII bus
161317ea1177Swdenk
161417ea1177Swdenk		CONFIG_PHY_GIGE
161517ea1177Swdenk
161617ea1177Swdenk		If this option is set, support for speed/duplex
161711ccc33fSMarcel Ziswiler		detection of gigabit PHY is included.
161817ea1177Swdenk
161917ea1177Swdenk		CONFIG_PHY_RESET_DELAY
162017ea1177Swdenk
162117ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
162217ea1177Swdenk		reset before any MII register access is possible.
162317ea1177Swdenk		For such PHY, set this option to the usec delay
162417ea1177Swdenk		required. (minimum 300usec for LXT971A)
162517ea1177Swdenk
162617ea1177Swdenk		CONFIG_PHY_CMD_DELAY (ppc4xx)
162717ea1177Swdenk
162817ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
162917ea1177Swdenk		command issued before MII status register can be read
163017ea1177Swdenk
1631c609719bSwdenk- Ethernet address:
1632c609719bSwdenk		CONFIG_ETHADDR
1633c68a05feSrichardretanubun		CONFIG_ETH1ADDR
1634c609719bSwdenk		CONFIG_ETH2ADDR
1635c609719bSwdenk		CONFIG_ETH3ADDR
1636c68a05feSrichardretanubun		CONFIG_ETH4ADDR
1637c68a05feSrichardretanubun		CONFIG_ETH5ADDR
1638c609719bSwdenk
163911ccc33fSMarcel Ziswiler		Define a default value for Ethernet address to use
164011ccc33fSMarcel Ziswiler		for the respective Ethernet interface, in case this
1641c609719bSwdenk		is not determined automatically.
1642c609719bSwdenk
1643c609719bSwdenk- IP address:
1644c609719bSwdenk		CONFIG_IPADDR
1645c609719bSwdenk
1646c609719bSwdenk		Define a default value for the IP address to use for
164711ccc33fSMarcel Ziswiler		the default Ethernet interface, in case this is not
1648c609719bSwdenk		determined through e.g. bootp.
16491ebcd654SWolfgang Denk		(Environment variable "ipaddr")
1650c609719bSwdenk
1651c609719bSwdenk- Server IP address:
1652c609719bSwdenk		CONFIG_SERVERIP
1653c609719bSwdenk
1654c609719bSwdenk		Defines a default value for the IP address of a TFTP
1655c609719bSwdenk		server to contact when using the "tftboot" command.
16561ebcd654SWolfgang Denk		(Environment variable "serverip")
1657c609719bSwdenk
165897cfe861SRobin Getz		CONFIG_KEEP_SERVERADDR
165997cfe861SRobin Getz
166097cfe861SRobin Getz		Keeps the server's MAC address, in the env 'serveraddr'
166197cfe861SRobin Getz		for passing to bootargs (like Linux's netconsole option)
166297cfe861SRobin Getz
16631ebcd654SWolfgang Denk- Gateway IP address:
16641ebcd654SWolfgang Denk		CONFIG_GATEWAYIP
16651ebcd654SWolfgang Denk
16661ebcd654SWolfgang Denk		Defines a default value for the IP address of the
16671ebcd654SWolfgang Denk		default router where packets to other networks are
16681ebcd654SWolfgang Denk		sent to.
16691ebcd654SWolfgang Denk		(Environment variable "gatewayip")
16701ebcd654SWolfgang Denk
16711ebcd654SWolfgang Denk- Subnet mask:
16721ebcd654SWolfgang Denk		CONFIG_NETMASK
16731ebcd654SWolfgang Denk
16741ebcd654SWolfgang Denk		Defines a default value for the subnet mask (or
16751ebcd654SWolfgang Denk		routing prefix) which is used to determine if an IP
16761ebcd654SWolfgang Denk		address belongs to the local subnet or needs to be
16771ebcd654SWolfgang Denk		forwarded through a router.
16781ebcd654SWolfgang Denk		(Environment variable "netmask")
16791ebcd654SWolfgang Denk
168053a5c424SDavid Updegraff- Multicast TFTP Mode:
168153a5c424SDavid Updegraff		CONFIG_MCAST_TFTP
168253a5c424SDavid Updegraff
168353a5c424SDavid Updegraff		Defines whether you want to support multicast TFTP as per
168453a5c424SDavid Updegraff		rfc-2090; for example to work with atftp.  Lets lots of targets
168511ccc33fSMarcel Ziswiler		tftp down the same boot image concurrently.  Note: the Ethernet
168653a5c424SDavid Updegraff		driver in use must provide a function: mcast() to join/leave a
168753a5c424SDavid Updegraff		multicast group.
168853a5c424SDavid Updegraff
1689c609719bSwdenk- BOOTP Recovery Mode:
1690c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY
1691c609719bSwdenk
1692c609719bSwdenk		If you have many targets in a network that try to
1693c609719bSwdenk		boot using BOOTP, you may want to avoid that all
1694c609719bSwdenk		systems send out BOOTP requests at precisely the same
1695c609719bSwdenk		moment (which would happen for instance at recovery
1696c609719bSwdenk		from a power failure, when all systems will try to
1697c609719bSwdenk		boot, thus flooding the BOOTP server. Defining
1698c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1699c609719bSwdenk		inserted before sending out BOOTP requests. The
17006c33c785SWolfgang Denk		following delays are inserted then:
1701c609719bSwdenk
1702c609719bSwdenk		1st BOOTP request:	delay 0 ... 1 sec
1703c609719bSwdenk		2nd BOOTP request:	delay 0 ... 2 sec
1704c609719bSwdenk		3rd BOOTP request:	delay 0 ... 4 sec
1705c609719bSwdenk		4th and following
1706c609719bSwdenk		BOOTP requests:		delay 0 ... 8 sec
1707c609719bSwdenk
1708fe389a82Sstroese- DHCP Advanced Options:
17091fe80d79SJon Loeliger		You can fine tune the DHCP functionality by defining
17101fe80d79SJon Loeliger		CONFIG_BOOTP_* symbols:
1711fe389a82Sstroese
17121fe80d79SJon Loeliger		CONFIG_BOOTP_SUBNETMASK
17131fe80d79SJon Loeliger		CONFIG_BOOTP_GATEWAY
17141fe80d79SJon Loeliger		CONFIG_BOOTP_HOSTNAME
17151fe80d79SJon Loeliger		CONFIG_BOOTP_NISDOMAIN
17161fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTPATH
17171fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTFILESIZE
17181fe80d79SJon Loeliger		CONFIG_BOOTP_DNS
17191fe80d79SJon Loeliger		CONFIG_BOOTP_DNS2
17201fe80d79SJon Loeliger		CONFIG_BOOTP_SEND_HOSTNAME
17211fe80d79SJon Loeliger		CONFIG_BOOTP_NTPSERVER
17221fe80d79SJon Loeliger		CONFIG_BOOTP_TIMEOFFSET
17231fe80d79SJon Loeliger		CONFIG_BOOTP_VENDOREX
17242c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL
1725fe389a82Sstroese
17265d110f0aSWilson Callan		CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
17275d110f0aSWilson Callan		environment variable, not the BOOTP server.
1728fe389a82Sstroese
17292c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
17302c00e099SJoe Hershberger		after the configured retry count, the call will fail
17312c00e099SJoe Hershberger		instead of starting over.  This can be used to fail over
17322c00e099SJoe Hershberger		to Link-local IP address configuration if the DHCP server
17332c00e099SJoe Hershberger		is not available.
17342c00e099SJoe Hershberger
1735fe389a82Sstroese		CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1736fe389a82Sstroese		serverip from a DHCP server, it is possible that more
1737fe389a82Sstroese		than one DNS serverip is offered to the client.
1738fe389a82Sstroese		If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1739fe389a82Sstroese		serverip will be stored in the additional environment
1740fe389a82Sstroese		variable "dnsip2". The first DNS serverip is always
1741fe389a82Sstroese		stored in the variable "dnsip", when CONFIG_BOOTP_DNS
17421fe80d79SJon Loeliger		is defined.
1743fe389a82Sstroese
1744fe389a82Sstroese		CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1745fe389a82Sstroese		to do a dynamic update of a DNS server. To do this, they
1746fe389a82Sstroese		need the hostname of the DHCP requester.
17475d110f0aSWilson Callan		If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
17481fe80d79SJon Loeliger		of the "hostname" environment variable is passed as
17491fe80d79SJon Loeliger		option 12 to the DHCP server.
1750fe389a82Sstroese
1751d9a2f416SAras Vaichas		CONFIG_BOOTP_DHCP_REQUEST_DELAY
1752d9a2f416SAras Vaichas
1753d9a2f416SAras Vaichas		A 32bit value in microseconds for a delay between
1754d9a2f416SAras Vaichas		receiving a "DHCP Offer" and sending the "DHCP Request".
1755d9a2f416SAras Vaichas		This fixes a problem with certain DHCP servers that don't
1756d9a2f416SAras Vaichas		respond 100% of the time to a "DHCP request". E.g. On an
1757d9a2f416SAras Vaichas		AT91RM9200 processor running at 180MHz, this delay needed
1758d9a2f416SAras Vaichas		to be *at least* 15,000 usec before a Windows Server 2003
1759d9a2f416SAras Vaichas		DHCP server would reply 100% of the time. I recommend at
1760d9a2f416SAras Vaichas		least 50,000 usec to be safe. The alternative is to hope
1761d9a2f416SAras Vaichas		that one of the retries will be successful but note that
1762d9a2f416SAras Vaichas		the DHCP timeout and retry process takes a longer than
1763d9a2f416SAras Vaichas		this delay.
1764d9a2f416SAras Vaichas
1765d22c338eSJoe Hershberger - Link-local IP address negotiation:
1766d22c338eSJoe Hershberger		Negotiate with other link-local clients on the local network
1767d22c338eSJoe Hershberger		for an address that doesn't require explicit configuration.
1768d22c338eSJoe Hershberger		This is especially useful if a DHCP server cannot be guaranteed
1769d22c338eSJoe Hershberger		to exist in all environments that the device must operate.
1770d22c338eSJoe Hershberger
1771d22c338eSJoe Hershberger		See doc/README.link-local for more information.
1772d22c338eSJoe Hershberger
1773a3d991bdSwdenk - CDP Options:
1774a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID
1775a3d991bdSwdenk
1776a3d991bdSwdenk		The device id used in CDP trigger frames.
1777a3d991bdSwdenk
1778a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID_PREFIX
1779a3d991bdSwdenk
1780a3d991bdSwdenk		A two character string which is prefixed to the MAC address
1781a3d991bdSwdenk		of the device.
1782a3d991bdSwdenk
1783a3d991bdSwdenk		CONFIG_CDP_PORT_ID
1784a3d991bdSwdenk
1785a3d991bdSwdenk		A printf format string which contains the ascii name of
1786a3d991bdSwdenk		the port. Normally is set to "eth%d" which sets
178711ccc33fSMarcel Ziswiler		eth0 for the first Ethernet, eth1 for the second etc.
1788a3d991bdSwdenk
1789a3d991bdSwdenk		CONFIG_CDP_CAPABILITIES
1790a3d991bdSwdenk
1791a3d991bdSwdenk		A 32bit integer which indicates the device capabilities;
1792a3d991bdSwdenk		0x00000010 for a normal host which does not forwards.
1793a3d991bdSwdenk
1794a3d991bdSwdenk		CONFIG_CDP_VERSION
1795a3d991bdSwdenk
1796a3d991bdSwdenk		An ascii string containing the version of the software.
1797a3d991bdSwdenk
1798a3d991bdSwdenk		CONFIG_CDP_PLATFORM
1799a3d991bdSwdenk
1800a3d991bdSwdenk		An ascii string containing the name of the platform.
1801a3d991bdSwdenk
1802a3d991bdSwdenk		CONFIG_CDP_TRIGGER
1803a3d991bdSwdenk
1804a3d991bdSwdenk		A 32bit integer sent on the trigger.
1805a3d991bdSwdenk
1806a3d991bdSwdenk		CONFIG_CDP_POWER_CONSUMPTION
1807a3d991bdSwdenk
1808a3d991bdSwdenk		A 16bit integer containing the power consumption of the
1809a3d991bdSwdenk		device in .1 of milliwatts.
1810a3d991bdSwdenk
1811a3d991bdSwdenk		CONFIG_CDP_APPLIANCE_VLAN_TYPE
1812a3d991bdSwdenk
1813a3d991bdSwdenk		A byte containing the id of the VLAN.
1814a3d991bdSwdenk
1815c609719bSwdenk- Status LED:	CONFIG_STATUS_LED
1816c609719bSwdenk
1817c609719bSwdenk		Several configurations allow to display the current
1818c609719bSwdenk		status using a LED. For instance, the LED will blink
1819c609719bSwdenk		fast while running U-Boot code, stop blinking as
1820c609719bSwdenk		soon as a reply to a BOOTP request was received, and
1821c609719bSwdenk		start blinking slow once the Linux kernel is running
1822c609719bSwdenk		(supported by a status LED driver in the Linux
1823c609719bSwdenk		kernel). Defining CONFIG_STATUS_LED enables this
1824c609719bSwdenk		feature in U-Boot.
1825c609719bSwdenk
1826c609719bSwdenk- CAN Support:	CONFIG_CAN_DRIVER
1827c609719bSwdenk
1828c609719bSwdenk		Defining CONFIG_CAN_DRIVER enables CAN driver support
1829c609719bSwdenk		on those systems that support this (optional)
1830c609719bSwdenk		feature, like the TQM8xxL modules.
1831c609719bSwdenk
1832c609719bSwdenk- I2C Support:	CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1833c609719bSwdenk
1834b37c7e5eSwdenk		These enable I2C serial bus commands. Defining either of
1835b37c7e5eSwdenk		(but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
183611ccc33fSMarcel Ziswiler		include the appropriate I2C driver for the selected CPU.
1837c609719bSwdenk
1838b37c7e5eSwdenk		This will allow you to use i2c commands at the u-boot
1839602ad3b3SJon Loeliger		command line (as long as you set CONFIG_CMD_I2C in
1840b37c7e5eSwdenk		CONFIG_COMMANDS) and communicate with i2c based realtime
1841b37c7e5eSwdenk		clock chips. See common/cmd_i2c.c for a description of the
1842c609719bSwdenk		command line interface.
1843c609719bSwdenk
1844bb99ad6dSBen Warren		CONFIG_HARD_I2C selects a hardware I2C controller.
1845c609719bSwdenk
1846b37c7e5eSwdenk		CONFIG_SOFT_I2C configures u-boot to use a software (aka
1847b37c7e5eSwdenk		bit-banging) driver instead of CPM or similar hardware
1848b37c7e5eSwdenk		support for I2C.
1849c609719bSwdenk
1850b37c7e5eSwdenk		There are several other quantities that must also be
1851b37c7e5eSwdenk		defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
1852c609719bSwdenk
18536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		In both cases you will need to define CONFIG_SYS_I2C_SPEED
1854b37c7e5eSwdenk		to be the frequency (in Hz) at which you wish your i2c bus
18556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
185611ccc33fSMarcel Ziswiler		the CPU's i2c node address).
1857c609719bSwdenk
18588d321b81SPeter Tyser		Now, the u-boot i2c code for the mpc8xx
1859a47a12beSStefan Roese		(arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
18608d321b81SPeter Tyser		and so its address should therefore be cleared to 0 (See,
18618d321b81SPeter Tyser		eg, MPC823e User's Manual p.16-473). So, set
18628d321b81SPeter Tyser		CONFIG_SYS_I2C_SLAVE to 0.
1863b37c7e5eSwdenk
18645da71efaSEric Millbrandt		CONFIG_SYS_I2C_INIT_MPC5XXX
18655da71efaSEric Millbrandt
18665da71efaSEric Millbrandt		When a board is reset during an i2c bus transfer
18675da71efaSEric Millbrandt		chips might think that the current transfer is still
18685da71efaSEric Millbrandt		in progress.  Reset the slave devices by sending start
18695da71efaSEric Millbrandt		commands until the slave device responds.
18705da71efaSEric Millbrandt
1871b37c7e5eSwdenk		That's all that's required for CONFIG_HARD_I2C.
1872b37c7e5eSwdenk
1873b37c7e5eSwdenk		If you use the software i2c interface (CONFIG_SOFT_I2C)
1874b37c7e5eSwdenk		then the following macros need to be defined (examples are
1875b37c7e5eSwdenk		from include/configs/lwmon.h):
1876c609719bSwdenk
1877c609719bSwdenk		I2C_INIT
1878c609719bSwdenk
1879b37c7e5eSwdenk		(Optional). Any commands necessary to enable the I2C
1880c609719bSwdenk		controller or configure ports.
1881c609719bSwdenk
1882b37c7e5eSwdenk		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
1883b37c7e5eSwdenk
1884c609719bSwdenk		I2C_PORT
1885c609719bSwdenk
1886c609719bSwdenk		(Only for MPC8260 CPU). The I/O port to use (the code
1887c609719bSwdenk		assumes both bits are on the same port). Valid values
1888c609719bSwdenk		are 0..3 for ports A..D.
1889c609719bSwdenk
1890c609719bSwdenk		I2C_ACTIVE
1891c609719bSwdenk
1892c609719bSwdenk		The code necessary to make the I2C data line active
1893c609719bSwdenk		(driven).  If the data line is open collector, this
1894c609719bSwdenk		define can be null.
1895c609719bSwdenk
1896b37c7e5eSwdenk		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
1897b37c7e5eSwdenk
1898c609719bSwdenk		I2C_TRISTATE
1899c609719bSwdenk
1900c609719bSwdenk		The code necessary to make the I2C data line tri-stated
1901c609719bSwdenk		(inactive).  If the data line is open collector, this
1902c609719bSwdenk		define can be null.
1903c609719bSwdenk
1904b37c7e5eSwdenk		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1905b37c7e5eSwdenk
1906c609719bSwdenk		I2C_READ
1907c609719bSwdenk
1908c609719bSwdenk		Code that returns TRUE if the I2C data line is high,
1909c609719bSwdenk		FALSE if it is low.
1910c609719bSwdenk
1911b37c7e5eSwdenk		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1912b37c7e5eSwdenk
1913c609719bSwdenk		I2C_SDA(bit)
1914c609719bSwdenk
1915c609719bSwdenk		If <bit> is TRUE, sets the I2C data line high. If it
1916c609719bSwdenk		is FALSE, it clears it (low).
1917c609719bSwdenk
1918b37c7e5eSwdenk		eg: #define I2C_SDA(bit) \
1919b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
1920b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
1921b37c7e5eSwdenk
1922c609719bSwdenk		I2C_SCL(bit)
1923c609719bSwdenk
1924c609719bSwdenk		If <bit> is TRUE, sets the I2C clock line high. If it
1925c609719bSwdenk		is FALSE, it clears it (low).
1926c609719bSwdenk
1927b37c7e5eSwdenk		eg: #define I2C_SCL(bit) \
1928b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
1929b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
1930b37c7e5eSwdenk
1931c609719bSwdenk		I2C_DELAY
1932c609719bSwdenk
1933c609719bSwdenk		This delay is invoked four times per clock cycle so this
1934c609719bSwdenk		controls the rate of data transfer.  The data rate thus
1935b37c7e5eSwdenk		is 1 / (I2C_DELAY * 4). Often defined to be something
1936b37c7e5eSwdenk		like:
1937b37c7e5eSwdenk
1938b37c7e5eSwdenk		#define I2C_DELAY  udelay(2)
1939c609719bSwdenk
1940793b5726SMike Frysinger		CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1941793b5726SMike Frysinger
1942793b5726SMike Frysinger		If your arch supports the generic GPIO framework (asm/gpio.h),
1943793b5726SMike Frysinger		then you may alternatively define the two GPIOs that are to be
1944793b5726SMike Frysinger		used as SCL / SDA.  Any of the previous I2C_xxx macros will
1945793b5726SMike Frysinger		have GPIO-based defaults assigned to them as appropriate.
1946793b5726SMike Frysinger
1947793b5726SMike Frysinger		You should define these to the GPIO value as given directly to
1948793b5726SMike Frysinger		the generic GPIO functions.
1949793b5726SMike Frysinger
19506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_INIT_BOARD
195147cd00faSwdenk
195247cd00faSwdenk		When a board is reset during an i2c bus transfer
195347cd00faSwdenk		chips might think that the current transfer is still
195447cd00faSwdenk		in progress. On some boards it is possible to access
195547cd00faSwdenk		the i2c SCLK line directly, either by using the
195647cd00faSwdenk		processor pin as a GPIO or by having a second pin
195747cd00faSwdenk		connected to the bus. If this option is defined a
195847cd00faSwdenk		custom i2c_init_board() routine in boards/xxx/board.c
195947cd00faSwdenk		is run early in the boot sequence.
196047cd00faSwdenk
196126a33504SRichard Retanubun		CONFIG_SYS_I2C_BOARD_LATE_INIT
196226a33504SRichard Retanubun
196326a33504SRichard Retanubun		An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
196426a33504SRichard Retanubun		defined a custom i2c_board_late_init() routine in
196526a33504SRichard Retanubun		boards/xxx/board.c is run AFTER the operations in i2c_init()
196626a33504SRichard Retanubun		is completed. This callpoint can be used to unreset i2c bus
196726a33504SRichard Retanubun		using CPU i2c controller register accesses for CPUs whose i2c
196826a33504SRichard Retanubun		controller provide such a method. It is called at the end of
196926a33504SRichard Retanubun		i2c_init() to allow i2c_init operations to setup the i2c bus
197026a33504SRichard Retanubun		controller on the CPU (e.g. setting bus speed & slave address).
197126a33504SRichard Retanubun
197217ea1177Swdenk		CONFIG_I2CFAST (PPC405GP|PPC405EP only)
197317ea1177Swdenk
197417ea1177Swdenk		This option enables configuration of bi_iic_fast[] flags
197517ea1177Swdenk		in u-boot bd_info structure based on u-boot environment
197617ea1177Swdenk		variable "i2cfast". (see also i2cfast)
197717ea1177Swdenk
1978bb99ad6dSBen Warren		CONFIG_I2C_MULTI_BUS
1979bb99ad6dSBen Warren
1980bb99ad6dSBen Warren		This option allows the use of multiple I2C buses, each of which
1981bb99ad6dSBen Warren		must have a controller.	 At any point in time, only one bus is
1982bb99ad6dSBen Warren		active.	 To switch to a different bus, use the 'i2c dev' command.
1983bb99ad6dSBen Warren		Note that bus numbering is zero-based.
1984bb99ad6dSBen Warren
19856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_NOPROBES
1986bb99ad6dSBen Warren
1987bb99ad6dSBen Warren		This option specifies a list of I2C devices that will be skipped
19880f89c54bSPeter Tyser		when the 'i2c probe' command is issued.	 If CONFIG_I2C_MULTI_BUS
19890f89c54bSPeter Tyser		is set, specify a list of bus-device pairs.  Otherwise, specify
19900f89c54bSPeter Tyser		a 1D array of device addresses
1991bb99ad6dSBen Warren
1992bb99ad6dSBen Warren		e.g.
1993bb99ad6dSBen Warren			#undef	CONFIG_I2C_MULTI_BUS
19946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
1995bb99ad6dSBen Warren
1996bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on a board with one I2C bus
1997bb99ad6dSBen Warren
1998bb99ad6dSBen Warren			#define CONFIG_I2C_MULTI_BUS
19996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_MULTI_NOPROBES	{{0,0x50},{0,0x68},{1,0x54}}
2000bb99ad6dSBen Warren
2001bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2002bb99ad6dSBen Warren
20036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SPD_BUS_NUM
2004be5e6181STimur Tabi
2005be5e6181STimur Tabi		If defined, then this indicates the I2C bus number for DDR SPD.
2006be5e6181STimur Tabi		If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2007be5e6181STimur Tabi
20086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_BUS_NUM
20090dc018ecSStefan Roese
20100dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the RTC.
20110dc018ecSStefan Roese		If not defined, then U-Boot assumes that RTC is on I2C bus 0.
20120dc018ecSStefan Roese
20136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_DTT_BUS_NUM
20140dc018ecSStefan Roese
20150dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the DTT.
20160dc018ecSStefan Roese		If not defined, then U-Boot assumes that DTT is on I2C bus 0.
20170dc018ecSStefan Roese
20186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_DTT_ADDR:
20199ebbb54fSVictor Gallardo
20209ebbb54fSVictor Gallardo		If defined, specifies the I2C address of the DTT device.
20219ebbb54fSVictor Gallardo		If not defined, then U-Boot uses predefined value for
20229ebbb54fSVictor Gallardo		specified DTT device.
20239ebbb54fSVictor Gallardo
2024be5e6181STimur Tabi		CONFIG_FSL_I2C
2025be5e6181STimur Tabi
2026be5e6181STimur Tabi		Define this option if you want to use Freescale's I2C driver in
20277817cb20SMarcel Ziswiler		drivers/i2c/fsl_i2c.c.
2028be5e6181STimur Tabi
202967b23a32SHeiko Schocher		CONFIG_I2C_MUX
203067b23a32SHeiko Schocher
203167b23a32SHeiko Schocher		Define this option if you have I2C devices reached over 1 .. n
203267b23a32SHeiko Schocher		I2C Muxes like the pca9544a. This option addes a new I2C
203367b23a32SHeiko Schocher		Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
203467b23a32SHeiko Schocher		new I2C Bus to the existing I2C Busses. If you select the
203567b23a32SHeiko Schocher		new Bus with "i2c dev", u-bbot sends first the commandos for
203667b23a32SHeiko Schocher		the muxes to activate this new "bus".
203767b23a32SHeiko Schocher
203867b23a32SHeiko Schocher		CONFIG_I2C_MULTI_BUS must be also defined, to use this
203967b23a32SHeiko Schocher		feature!
204067b23a32SHeiko Schocher
204167b23a32SHeiko Schocher		Example:
204267b23a32SHeiko Schocher		Adding a new I2C Bus reached over 2 pca9544a muxes
204367b23a32SHeiko Schocher			The First mux with address 70 and channel 6
204467b23a32SHeiko Schocher			The Second mux with address 71 and channel 4
204567b23a32SHeiko Schocher
204667b23a32SHeiko Schocher		=> i2c bus pca9544a:70:6:pca9544a:71:4
204767b23a32SHeiko Schocher
204867b23a32SHeiko Schocher		Use the "i2c bus" command without parameter, to get a list
204967b23a32SHeiko Schocher		of I2C Busses with muxes:
205067b23a32SHeiko Schocher
205167b23a32SHeiko Schocher		=> i2c bus
205267b23a32SHeiko Schocher		Busses reached over muxes:
205367b23a32SHeiko Schocher		Bus ID: 2
205467b23a32SHeiko Schocher		  reached over Mux(es):
205567b23a32SHeiko Schocher		    pca9544a@70 ch: 4
205667b23a32SHeiko Schocher		Bus ID: 3
205767b23a32SHeiko Schocher		  reached over Mux(es):
205867b23a32SHeiko Schocher		    pca9544a@70 ch: 6
205967b23a32SHeiko Schocher		    pca9544a@71 ch: 4
206067b23a32SHeiko Schocher		=>
206167b23a32SHeiko Schocher
206267b23a32SHeiko Schocher		If you now switch to the new I2C Bus 3 with "i2c dev 3"
2063f9a78b8dSMichael Jones		u-boot first sends the command to the mux@70 to enable
2064f9a78b8dSMichael Jones		channel 6, and then the command to the mux@71 to enable
206567b23a32SHeiko Schocher		the channel 4.
206667b23a32SHeiko Schocher
206767b23a32SHeiko Schocher		After that, you can use the "normal" i2c commands as
2068f9a78b8dSMichael Jones		usual to communicate with your I2C devices behind
206967b23a32SHeiko Schocher		the 2 muxes.
207067b23a32SHeiko Schocher
207167b23a32SHeiko Schocher		This option is actually implemented for the bitbanging
207267b23a32SHeiko Schocher		algorithm in common/soft_i2c.c and for the Hardware I2C
207367b23a32SHeiko Schocher		Bus on the MPC8260. But it should be not so difficult
207467b23a32SHeiko Schocher		to add this option to other architectures.
207567b23a32SHeiko Schocher
20762ac6985aSAndrew Dyer		CONFIG_SOFT_I2C_READ_REPEATED_START
20772ac6985aSAndrew Dyer
20782ac6985aSAndrew Dyer		defining this will force the i2c_read() function in
20792ac6985aSAndrew Dyer		the soft_i2c driver to perform an I2C repeated start
20802ac6985aSAndrew Dyer		between writing the address pointer and reading the
20812ac6985aSAndrew Dyer		data.  If this define is omitted the default behaviour
20822ac6985aSAndrew Dyer		of doing a stop-start sequence will be used.  Most I2C
20832ac6985aSAndrew Dyer		devices can use either method, but some require one or
20842ac6985aSAndrew Dyer		the other.
2085be5e6181STimur Tabi
2086c609719bSwdenk- SPI Support:	CONFIG_SPI
2087c609719bSwdenk
2088c609719bSwdenk		Enables SPI driver (so far only tested with
2089c609719bSwdenk		SPI EEPROM, also an instance works with Crystal A/D and
2090c609719bSwdenk		D/As on the SACSng board)
2091c609719bSwdenk
20926639562eSYoshihiro Shimoda		CONFIG_SH_SPI
20936639562eSYoshihiro Shimoda
20946639562eSYoshihiro Shimoda		Enables the driver for SPI controller on SuperH. Currently
20956639562eSYoshihiro Shimoda		only SH7757 is supported.
20966639562eSYoshihiro Shimoda
2097c609719bSwdenk		CONFIG_SPI_X
2098c609719bSwdenk
2099c609719bSwdenk		Enables extended (16-bit) SPI EEPROM addressing.
2100c609719bSwdenk		(symmetrical to CONFIG_I2C_X)
2101c609719bSwdenk
2102c609719bSwdenk		CONFIG_SOFT_SPI
2103c609719bSwdenk
2104c609719bSwdenk		Enables a software (bit-bang) SPI driver rather than
2105c609719bSwdenk		using hardware support. This is a general purpose
2106c609719bSwdenk		driver that only requires three general I/O port pins
2107c609719bSwdenk		(two outputs, one input) to function. If this is
2108c609719bSwdenk		defined, the board configuration must define several
2109c609719bSwdenk		SPI configuration items (port pins to use, etc). For
2110c609719bSwdenk		an example, see include/configs/sacsng.h.
2111c609719bSwdenk
211204a9e118SBen Warren		CONFIG_HARD_SPI
211304a9e118SBen Warren
211404a9e118SBen Warren		Enables a hardware SPI driver for general-purpose reads
211504a9e118SBen Warren		and writes.  As with CONFIG_SOFT_SPI, the board configuration
211604a9e118SBen Warren		must define a list of chip-select function pointers.
211704a9e118SBen Warren		Currently supported on some MPC8xxx processors.	 For an
211804a9e118SBen Warren		example, see include/configs/mpc8349emds.h.
211904a9e118SBen Warren
212038254f45SGuennadi Liakhovetski		CONFIG_MXC_SPI
212138254f45SGuennadi Liakhovetski
212238254f45SGuennadi Liakhovetski		Enables the driver for the SPI controllers on i.MX and MXC
21232e3cd1cdSFabio Estevam		SoCs. Currently i.MX31/35/51 are supported.
212438254f45SGuennadi Liakhovetski
21250133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA
21260133502eSMatthias Fuchs
21270133502eSMatthias Fuchs		Enables FPGA subsystem.
21280133502eSMatthias Fuchs
21290133502eSMatthias Fuchs		CONFIG_FPGA_<vendor>
21300133502eSMatthias Fuchs
21310133502eSMatthias Fuchs		Enables support for specific chip vendors.
21320133502eSMatthias Fuchs		(ALTERA, XILINX)
21330133502eSMatthias Fuchs
21340133502eSMatthias Fuchs		CONFIG_FPGA_<family>
21350133502eSMatthias Fuchs
21360133502eSMatthias Fuchs		Enables support for FPGA family.
21370133502eSMatthias Fuchs		(SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
21380133502eSMatthias Fuchs
21390133502eSMatthias Fuchs		CONFIG_FPGA_COUNT
2140c609719bSwdenk
2141c609719bSwdenk		Specify the number of FPGA devices to support.
2142c609719bSwdenk
21436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_PROG_FEEDBACK
2144c609719bSwdenk
2145c609719bSwdenk		Enable printing of hash marks during FPGA configuration.
2146c609719bSwdenk
21476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_BUSY
2148c609719bSwdenk
2149c609719bSwdenk		Enable checks on FPGA configuration interface busy
2150c609719bSwdenk		status by the configuration function. This option
2151c609719bSwdenk		will require a board or device specific function to
2152c609719bSwdenk		be written.
2153c609719bSwdenk
2154c609719bSwdenk		CONFIG_FPGA_DELAY
2155c609719bSwdenk
2156c609719bSwdenk		If defined, a function that provides delays in the FPGA
2157c609719bSwdenk		configuration driver.
2158c609719bSwdenk
21596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_CTRLC
2160c609719bSwdenk		Allow Control-C to interrupt FPGA configuration
2161c609719bSwdenk
21626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_ERROR
2163c609719bSwdenk
2164c609719bSwdenk		Check for configuration errors during FPGA bitfile
2165c609719bSwdenk		loading. For example, abort during Virtex II
2166c609719bSwdenk		configuration if the INIT_B line goes low (which
2167c609719bSwdenk		indicated a CRC error).
2168c609719bSwdenk
21696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_INIT
2170c609719bSwdenk
2171c609719bSwdenk		Maximum time to wait for the INIT_B line to deassert
2172c609719bSwdenk		after PROB_B has been deasserted during a Virtex II
2173c609719bSwdenk		FPGA configuration sequence. The default time is 500
217411ccc33fSMarcel Ziswiler		ms.
2175c609719bSwdenk
21766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_BUSY
2177c609719bSwdenk
2178c609719bSwdenk		Maximum time to wait for BUSY to deassert during
217911ccc33fSMarcel Ziswiler		Virtex II FPGA configuration. The default is 5 ms.
2180c609719bSwdenk
21816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_CONFIG
2182c609719bSwdenk
2183c609719bSwdenk		Time to wait after FPGA configuration. The default is
218411ccc33fSMarcel Ziswiler		200 ms.
2185c609719bSwdenk
2186c609719bSwdenk- Configuration Management:
2187c609719bSwdenk		CONFIG_IDENT_STRING
2188c609719bSwdenk
2189c609719bSwdenk		If defined, this string will be added to the U-Boot
2190c609719bSwdenk		version information (U_BOOT_VERSION)
2191c609719bSwdenk
2192c609719bSwdenk- Vendor Parameter Protection:
2193c609719bSwdenk
2194c609719bSwdenk		U-Boot considers the values of the environment
2195c609719bSwdenk		variables "serial#" (Board Serial Number) and
21967152b1d0Swdenk		"ethaddr" (Ethernet Address) to be parameters that
2197c609719bSwdenk		are set once by the board vendor / manufacturer, and
2198c609719bSwdenk		protects these variables from casual modification by
2199c609719bSwdenk		the user. Once set, these variables are read-only,
2200c609719bSwdenk		and write or delete attempts are rejected. You can
220111ccc33fSMarcel Ziswiler		change this behaviour:
2202c609719bSwdenk
2203c609719bSwdenk		If CONFIG_ENV_OVERWRITE is #defined in your config
2204c609719bSwdenk		file, the write protection for vendor parameters is
220547cd00faSwdenk		completely disabled. Anybody can change or delete
2206c609719bSwdenk		these parameters.
2207c609719bSwdenk
2208c609719bSwdenk		Alternatively, if you #define _both_ CONFIG_ETHADDR
2209c609719bSwdenk		_and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
221011ccc33fSMarcel Ziswiler		Ethernet address is installed in the environment,
2211c609719bSwdenk		which can be changed exactly ONCE by the user. [The
2212c609719bSwdenk		serial# is unaffected by this, i. e. it remains
2213c609719bSwdenk		read-only.]
2214c609719bSwdenk
22152598090bSJoe Hershberger		The same can be accomplished in a more flexible way
22162598090bSJoe Hershberger		for any variable by configuring the type of access
22172598090bSJoe Hershberger		to allow for those variables in the ".flags" variable
22182598090bSJoe Hershberger		or define CONFIG_ENV_FLAGS_LIST_STATIC.
22192598090bSJoe Hershberger
2220c609719bSwdenk- Protected RAM:
2221c609719bSwdenk		CONFIG_PRAM
2222c609719bSwdenk
2223c609719bSwdenk		Define this variable to enable the reservation of
2224c609719bSwdenk		"protected RAM", i. e. RAM which is not overwritten
2225c609719bSwdenk		by U-Boot. Define CONFIG_PRAM to hold the number of
2226c609719bSwdenk		kB you want to reserve for pRAM. You can overwrite
2227c609719bSwdenk		this default value by defining an environment
2228c609719bSwdenk		variable "pram" to the number of kB you want to
2229c609719bSwdenk		reserve. Note that the board info structure will
2230c609719bSwdenk		still show the full amount of RAM. If pRAM is
2231c609719bSwdenk		reserved, a new environment variable "mem" will
2232c609719bSwdenk		automatically be defined to hold the amount of
2233c609719bSwdenk		remaining RAM in a form that can be passed as boot
2234c609719bSwdenk		argument to Linux, for instance like that:
2235c609719bSwdenk
2236fe126d8bSWolfgang Denk			setenv bootargs ... mem=\${mem}
2237c609719bSwdenk			saveenv
2238c609719bSwdenk
2239c609719bSwdenk		This way you can tell Linux not to use this memory,
2240c609719bSwdenk		either, which results in a memory region that will
2241c609719bSwdenk		not be affected by reboots.
2242c609719bSwdenk
2243c609719bSwdenk		*WARNING* If your board configuration uses automatic
2244c609719bSwdenk		detection of the RAM size, you must make sure that
2245c609719bSwdenk		this memory test is non-destructive. So far, the
2246c609719bSwdenk		following board configurations are known to be
2247c609719bSwdenk		"pRAM-clean":
2248c609719bSwdenk
22491b0757ecSWolfgang Denk			IVMS8, IVML24, SPD8xx, TQM8xxL,
22501b0757ecSWolfgang Denk			HERMES, IP860, RPXlite, LWMON,
2251544d97e9SWolfgang Denk			FLAGADM, TQM8260
2252c609719bSwdenk
225340fef049SGabe Black- Access to physical memory region (> 4GB)
225440fef049SGabe Black		Some basic support is provided for operations on memory not
225540fef049SGabe Black		normally accessible to U-Boot - e.g. some architectures
225640fef049SGabe Black		support access to more than 4GB of memory on 32-bit
225740fef049SGabe Black		machines using physical address extension or similar.
225840fef049SGabe Black		Define CONFIG_PHYSMEM to access this basic support, which
225940fef049SGabe Black		currently only supports clearing the memory.
226040fef049SGabe Black
2261c609719bSwdenk- Error Recovery:
2262c609719bSwdenk		CONFIG_PANIC_HANG
2263c609719bSwdenk
2264c609719bSwdenk		Define this variable to stop the system in case of a
2265c609719bSwdenk		fatal error, so that you have to reset it manually.
2266c609719bSwdenk		This is probably NOT a good idea for an embedded
226711ccc33fSMarcel Ziswiler		system where you want the system to reboot
2268c609719bSwdenk		automatically as fast as possible, but it may be
2269c609719bSwdenk		useful during development since you can try to debug
2270c609719bSwdenk		the conditions that lead to the situation.
2271c609719bSwdenk
2272c609719bSwdenk		CONFIG_NET_RETRY_COUNT
2273c609719bSwdenk
2274c609719bSwdenk		This variable defines the number of retries for
2275c609719bSwdenk		network operations like ARP, RARP, TFTP, or BOOTP
2276c609719bSwdenk		before giving up the operation. If not defined, a
2277c609719bSwdenk		default value of 5 is used.
2278c609719bSwdenk
227940cb90eeSGuennadi Liakhovetski		CONFIG_ARP_TIMEOUT
228040cb90eeSGuennadi Liakhovetski
228140cb90eeSGuennadi Liakhovetski		Timeout waiting for an ARP reply in milliseconds.
228240cb90eeSGuennadi Liakhovetski
228348a3e999STetsuyuki Kobayashi		CONFIG_NFS_TIMEOUT
228448a3e999STetsuyuki Kobayashi
228548a3e999STetsuyuki Kobayashi		Timeout in milliseconds used in NFS protocol.
228648a3e999STetsuyuki Kobayashi		If you encounter "ERROR: Cannot umount" in nfs command,
228748a3e999STetsuyuki Kobayashi		try longer timeout such as
228848a3e999STetsuyuki Kobayashi		#define CONFIG_NFS_TIMEOUT 10000UL
228948a3e999STetsuyuki Kobayashi
2290c609719bSwdenk- Command Interpreter:
22918078f1a5SWolfgang Denk		CONFIG_AUTO_COMPLETE
229204a85b3bSwdenk
229304a85b3bSwdenk		Enable auto completion of commands using TAB.
229404a85b3bSwdenk
22958078f1a5SWolfgang Denk		Note that this feature has NOT been implemented yet
22968078f1a5SWolfgang Denk		for the "hush" shell.
22978078f1a5SWolfgang Denk
22988078f1a5SWolfgang Denk
22996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_HUSH_PARSER
2300c609719bSwdenk
2301c609719bSwdenk		Define this variable to enable the "hush" shell (from
2302c609719bSwdenk		Busybox) as command line interpreter, thus enabling
2303c609719bSwdenk		powerful command line syntax like
2304c609719bSwdenk		if...then...else...fi conditionals or `&&' and '||'
2305c609719bSwdenk		constructs ("shell scripts").
2306c609719bSwdenk
2307c609719bSwdenk		If undefined, you get the old, much simpler behaviour
2308c609719bSwdenk		with a somewhat smaller memory footprint.
2309c609719bSwdenk
2310c609719bSwdenk
23116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_PROMPT_HUSH_PS2
2312c609719bSwdenk
2313c609719bSwdenk		This defines the secondary prompt string, which is
2314c609719bSwdenk		printed when the command interpreter needs more input
2315c609719bSwdenk		to complete a command. Usually "> ".
2316c609719bSwdenk
2317c609719bSwdenk	Note:
2318c609719bSwdenk
2319c609719bSwdenk		In the current implementation, the local variables
2320c609719bSwdenk		space and global environment variables space are
2321c609719bSwdenk		separated. Local variables are those you define by
23223b57fe0aSwdenk		simply typing `name=value'. To access a local
2323c609719bSwdenk		variable later on, you have write `$name' or
23243b57fe0aSwdenk		`${name}'; to execute the contents of a variable
23253b57fe0aSwdenk		directly type `$name' at the command prompt.
2326c609719bSwdenk
2327c609719bSwdenk		Global environment variables are those you use
2328c609719bSwdenk		setenv/printenv to work with. To run a command stored
2329c609719bSwdenk		in such a variable, you need to use the run command,
2330c609719bSwdenk		and you must not use the '$' sign to access them.
2331c609719bSwdenk
2332c609719bSwdenk		To store commands and special characters in a
2333c609719bSwdenk		variable, please use double quotation marks
2334c609719bSwdenk		surrounding the whole text of the variable, instead
2335c609719bSwdenk		of the backslashes before semicolons and special
2336c609719bSwdenk		symbols.
2337c609719bSwdenk
2338aa0c71acSWolfgang Denk- Commandline Editing and History:
2339aa0c71acSWolfgang Denk		CONFIG_CMDLINE_EDITING
2340aa0c71acSWolfgang Denk
234111ccc33fSMarcel Ziswiler		Enable editing and History functions for interactive
2342aa0c71acSWolfgang Denk		commandline input operations
2343aa0c71acSWolfgang Denk
2344a8c7c708Swdenk- Default Environment:
2345c609719bSwdenk		CONFIG_EXTRA_ENV_SETTINGS
2346c609719bSwdenk
2347c609719bSwdenk		Define this to contain any number of null terminated
2348c609719bSwdenk		strings (variable = value pairs) that will be part of
23497152b1d0Swdenk		the default environment compiled into the boot image.
23502262cfeeSwdenk
2351c609719bSwdenk		For example, place something like this in your
2352c609719bSwdenk		board's config file:
2353c609719bSwdenk
2354c609719bSwdenk		#define CONFIG_EXTRA_ENV_SETTINGS \
2355c609719bSwdenk			"myvar1=value1\0" \
2356c609719bSwdenk			"myvar2=value2\0"
2357c609719bSwdenk
2358c609719bSwdenk		Warning: This method is based on knowledge about the
2359c609719bSwdenk		internal format how the environment is stored by the
23602262cfeeSwdenk		U-Boot code. This is NOT an official, exported
2361c609719bSwdenk		interface! Although it is unlikely that this format
23627152b1d0Swdenk		will change soon, there is no guarantee either.
2363c609719bSwdenk		You better know what you are doing here.
2364c609719bSwdenk
2365c609719bSwdenk		Note: overly (ab)use of the default environment is
2366c609719bSwdenk		discouraged. Make sure to check other ways to preset
236774de7aefSWolfgang Denk		the environment like the "source" command or the
2368c609719bSwdenk		boot command first.
2369c609719bSwdenk
23705e724ca2SStephen Warren		CONFIG_ENV_VARS_UBOOT_CONFIG
23715e724ca2SStephen Warren
23725e724ca2SStephen Warren		Define this in order to add variables describing the
23735e724ca2SStephen Warren		U-Boot build configuration to the default environment.
23745e724ca2SStephen Warren		These will be named arch, cpu, board, vendor, and soc.
23755e724ca2SStephen Warren
23765e724ca2SStephen Warren		Enabling this option will cause the following to be defined:
23775e724ca2SStephen Warren
23785e724ca2SStephen Warren		- CONFIG_SYS_ARCH
23795e724ca2SStephen Warren		- CONFIG_SYS_CPU
23805e724ca2SStephen Warren		- CONFIG_SYS_BOARD
23815e724ca2SStephen Warren		- CONFIG_SYS_VENDOR
23825e724ca2SStephen Warren		- CONFIG_SYS_SOC
23835e724ca2SStephen Warren
23847e27f89fSTom Rini		CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
23857e27f89fSTom Rini
23867e27f89fSTom Rini		Define this in order to add variables describing certain
23877e27f89fSTom Rini		run-time determined information about the hardware to the
23887e27f89fSTom Rini		environment.  These will be named board_name, board_rev.
23897e27f89fSTom Rini
239006fd8538SSimon Glass		CONFIG_DELAY_ENVIRONMENT
239106fd8538SSimon Glass
239206fd8538SSimon Glass		Normally the environment is loaded when the board is
239306fd8538SSimon Glass		intialised so that it is available to U-Boot. This inhibits
239406fd8538SSimon Glass		that so that the environment is not available until
239506fd8538SSimon Glass		explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
239606fd8538SSimon Glass		this is instead controlled by the value of
239706fd8538SSimon Glass		/config/load-environment.
239806fd8538SSimon Glass
2399a8c7c708Swdenk- DataFlash Support:
24002abbe075Swdenk		CONFIG_HAS_DATAFLASH
24012abbe075Swdenk
24022abbe075Swdenk		Defining this option enables DataFlash features and
24032abbe075Swdenk		allows to read/write in Dataflash via the standard
24042abbe075Swdenk		commands cp, md...
24052abbe075Swdenk
2406f61ec45eSEric Nelson- Serial Flash support
2407f61ec45eSEric Nelson		CONFIG_CMD_SF
2408f61ec45eSEric Nelson
2409f61ec45eSEric Nelson		Defining this option enables SPI flash commands
2410f61ec45eSEric Nelson		'sf probe/read/write/erase/update'.
2411f61ec45eSEric Nelson
2412f61ec45eSEric Nelson		Usage requires an initial 'probe' to define the serial
2413f61ec45eSEric Nelson		flash parameters, followed by read/write/erase/update
2414f61ec45eSEric Nelson		commands.
2415f61ec45eSEric Nelson
2416f61ec45eSEric Nelson		The following defaults may be provided by the platform
2417f61ec45eSEric Nelson		to handle the common case when only a single serial
2418f61ec45eSEric Nelson		flash is present on the system.
2419f61ec45eSEric Nelson
2420f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_BUS		Bus identifier
2421f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_CS		Chip-select
2422f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_MODE 		(see include/spi.h)
2423f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_SPEED		in Hz
2424f61ec45eSEric Nelson
242524007273SSimon Glass		CONFIG_CMD_SF_TEST
242624007273SSimon Glass
242724007273SSimon Glass		Define this option to include a destructive SPI flash
242824007273SSimon Glass		test ('sf test').
242924007273SSimon Glass
24303f85ce27Swdenk- SystemACE Support:
24313f85ce27Swdenk		CONFIG_SYSTEMACE
24323f85ce27Swdenk
24333f85ce27Swdenk		Adding this option adds support for Xilinx SystemACE
24343f85ce27Swdenk		chips attached via some sort of local bus. The address
243511ccc33fSMarcel Ziswiler		of the chip must also be defined in the
24366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SYSTEMACE_BASE macro. For example:
24373f85ce27Swdenk
24383f85ce27Swdenk		#define CONFIG_SYSTEMACE
24396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
24403f85ce27Swdenk
24413f85ce27Swdenk		When SystemACE support is added, the "ace" device type
24423f85ce27Swdenk		becomes available to the fat commands, i.e. fatls.
24433f85ce27Swdenk
2444ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port:
2445ecb0ccd9SWolfgang Denk		CONFIG_TFTP_PORT
2446ecb0ccd9SWolfgang Denk
244728cb9375SWolfgang Denk		If this is defined, the environment variable tftpsrcp
2448ecb0ccd9SWolfgang Denk		is used to supply the TFTP UDP source port value.
244928cb9375SWolfgang Denk		If tftpsrcp isn't defined, the normal pseudo-random port
2450ecb0ccd9SWolfgang Denk		number generator is used.
2451ecb0ccd9SWolfgang Denk
245228cb9375SWolfgang Denk		Also, the environment variable tftpdstp is used to supply
245328cb9375SWolfgang Denk		the TFTP UDP destination port value.  If tftpdstp isn't
245428cb9375SWolfgang Denk		defined, the normal port 69 is used.
245528cb9375SWolfgang Denk
245628cb9375SWolfgang Denk		The purpose for tftpsrcp is to allow a TFTP server to
2457ecb0ccd9SWolfgang Denk		blindly start the TFTP transfer using the pre-configured
2458ecb0ccd9SWolfgang Denk		target IP address and UDP port. This has the effect of
2459ecb0ccd9SWolfgang Denk		"punching through" the (Windows XP) firewall, allowing
2460ecb0ccd9SWolfgang Denk		the remainder of the TFTP transfer to proceed normally.
2461ecb0ccd9SWolfgang Denk		A better solution is to properly configure the firewall,
2462ecb0ccd9SWolfgang Denk		but sometimes that is not allowed.
2463ecb0ccd9SWolfgang Denk
2464bf36c5d5SSimon Glass- Hashing support:
2465bf36c5d5SSimon Glass		CONFIG_CMD_HASH
2466bf36c5d5SSimon Glass
2467bf36c5d5SSimon Glass		This enables a generic 'hash' command which can produce
2468bf36c5d5SSimon Glass		hashes / digests from a few algorithms (e.g. SHA1, SHA256).
2469bf36c5d5SSimon Glass
2470bf36c5d5SSimon Glass		CONFIG_HASH_VERIFY
2471bf36c5d5SSimon Glass
2472bf36c5d5SSimon Glass		Enable the hash verify command (hash -v). This adds to code
2473bf36c5d5SSimon Glass		size a little.
2474bf36c5d5SSimon Glass
2475bf36c5d5SSimon Glass		CONFIG_SHA1 - support SHA1 hashing
2476bf36c5d5SSimon Glass		CONFIG_SHA256 - support SHA256 hashing
2477bf36c5d5SSimon Glass
2478bf36c5d5SSimon Glass		Note: There is also a sha1sum command, which should perhaps
2479bf36c5d5SSimon Glass		be deprecated in favour of 'hash sha1'.
2480bf36c5d5SSimon Glass
2481a8c7c708Swdenk- Show boot progress:
2482c609719bSwdenk		CONFIG_SHOW_BOOT_PROGRESS
2483c609719bSwdenk
2484c609719bSwdenk		Defining this option allows to add some board-
2485c609719bSwdenk		specific code (calling a user-provided function
2486c609719bSwdenk		"show_boot_progress(int)") that enables you to show
2487c609719bSwdenk		the system's boot progress on some display (for
2488c609719bSwdenk		example, some LED's) on your board. At the moment,
2489c609719bSwdenk		the following checkpoints are implemented:
2490c609719bSwdenk
24913a608ca0SSimon Glass- Detailed boot stage timing
24923a608ca0SSimon Glass		CONFIG_BOOTSTAGE
24933a608ca0SSimon Glass		Define this option to get detailed timing of each stage
24943a608ca0SSimon Glass		of the boot process.
24953a608ca0SSimon Glass
24963a608ca0SSimon Glass		CONFIG_BOOTSTAGE_USER_COUNT
24973a608ca0SSimon Glass		This is the number of available user bootstage records.
24983a608ca0SSimon Glass		Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
24993a608ca0SSimon Glass		a new ID will be allocated from this stash. If you exceed
25003a608ca0SSimon Glass		the limit, recording will stop.
25013a608ca0SSimon Glass
25023a608ca0SSimon Glass		CONFIG_BOOTSTAGE_REPORT
25033a608ca0SSimon Glass		Define this to print a report before boot, similar to this:
25043a608ca0SSimon Glass
25053a608ca0SSimon Glass		Timer summary in microseconds:
25063a608ca0SSimon Glass		       Mark    Elapsed  Stage
25073a608ca0SSimon Glass			  0          0  reset
25083a608ca0SSimon Glass		  3,575,678  3,575,678  board_init_f start
25093a608ca0SSimon Glass		  3,575,695         17  arch_cpu_init A9
25103a608ca0SSimon Glass		  3,575,777         82  arch_cpu_init done
25113a608ca0SSimon Glass		  3,659,598     83,821  board_init_r start
25123a608ca0SSimon Glass		  3,910,375    250,777  main_loop
25133a608ca0SSimon Glass		 29,916,167 26,005,792  bootm_start
25143a608ca0SSimon Glass		 30,361,327    445,160  start_kernel
25153a608ca0SSimon Glass
25162eba38cfSSimon Glass		CONFIG_CMD_BOOTSTAGE
25172eba38cfSSimon Glass		Add a 'bootstage' command which supports printing a report
25182eba38cfSSimon Glass		and un/stashing of bootstage data.
25192eba38cfSSimon Glass
252094fd1316SSimon Glass		CONFIG_BOOTSTAGE_FDT
252194fd1316SSimon Glass		Stash the bootstage information in the FDT. A root 'bootstage'
252294fd1316SSimon Glass		node is created with each bootstage id as a child. Each child
252394fd1316SSimon Glass		has a 'name' property and either 'mark' containing the
252494fd1316SSimon Glass		mark time in microsecond, or 'accum' containing the
252594fd1316SSimon Glass		accumulated time for that bootstage id in microseconds.
252694fd1316SSimon Glass		For example:
252794fd1316SSimon Glass
252894fd1316SSimon Glass		bootstage {
252994fd1316SSimon Glass			154 {
253094fd1316SSimon Glass				name = "board_init_f";
253194fd1316SSimon Glass				mark = <3575678>;
253294fd1316SSimon Glass			};
253394fd1316SSimon Glass			170 {
253494fd1316SSimon Glass				name = "lcd";
253594fd1316SSimon Glass				accum = <33482>;
253694fd1316SSimon Glass			};
253794fd1316SSimon Glass		};
253894fd1316SSimon Glass
253994fd1316SSimon Glass		Code in the Linux kernel can find this in /proc/devicetree.
254094fd1316SSimon Glass
25411372cce2SMarian BalakowiczLegacy uImage format:
25421372cce2SMarian Balakowicz
2543c609719bSwdenk  Arg	Where			When
2544c609719bSwdenk    1	common/cmd_bootm.c	before attempting to boot an image
2545c609719bSwdenk   -1	common/cmd_bootm.c	Image header has bad	 magic number
2546c609719bSwdenk    2	common/cmd_bootm.c	Image header has correct magic number
2547c609719bSwdenk   -2	common/cmd_bootm.c	Image header has bad	 checksum
2548c609719bSwdenk    3	common/cmd_bootm.c	Image header has correct checksum
2549c609719bSwdenk   -3	common/cmd_bootm.c	Image data   has bad	 checksum
2550c609719bSwdenk    4	common/cmd_bootm.c	Image data   has correct checksum
2551c609719bSwdenk   -4	common/cmd_bootm.c	Image is for unsupported architecture
2552c609719bSwdenk    5	common/cmd_bootm.c	Architecture check OK
25531372cce2SMarian Balakowicz   -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi)
2554c609719bSwdenk    6	common/cmd_bootm.c	Image Type check OK
2555c609719bSwdenk   -6	common/cmd_bootm.c	gunzip uncompression error
2556c609719bSwdenk   -7	common/cmd_bootm.c	Unimplemented compression type
2557c609719bSwdenk    7	common/cmd_bootm.c	Uncompression OK
25581372cce2SMarian Balakowicz    8	common/cmd_bootm.c	No uncompress/copy overwrite error
2559c609719bSwdenk   -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
25601372cce2SMarian Balakowicz
25611372cce2SMarian Balakowicz    9	common/image.c		Start initial ramdisk verification
25621372cce2SMarian Balakowicz  -10	common/image.c		Ramdisk header has bad	   magic number
25631372cce2SMarian Balakowicz  -11	common/image.c		Ramdisk header has bad	   checksum
25641372cce2SMarian Balakowicz   10	common/image.c		Ramdisk header is OK
25651372cce2SMarian Balakowicz  -12	common/image.c		Ramdisk data   has bad	   checksum
25661372cce2SMarian Balakowicz   11	common/image.c		Ramdisk data   has correct checksum
25671372cce2SMarian Balakowicz   12	common/image.c		Ramdisk verification complete, start loading
256811ccc33fSMarcel Ziswiler  -13	common/image.c		Wrong Image Type (not PPC Linux ramdisk)
25691372cce2SMarian Balakowicz   13	common/image.c		Start multifile image verification
25701372cce2SMarian Balakowicz   14	common/image.c		No initial ramdisk, no multifile, continue.
25711372cce2SMarian Balakowicz
2572ea0364f1SPeter Tyser   15	arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
2573c609719bSwdenk
2574a47a12beSStefan Roese  -30	arch/powerpc/lib/board.c	Fatal error, hang the system
257563e73c9aSwdenk  -31	post/post.c		POST test failed, detected by post_output_backlog()
257663e73c9aSwdenk  -32	post/post.c		POST test failed, detected by post_run_single()
257763e73c9aSwdenk
2578566a494fSHeiko Schocher   34	common/cmd_doc.c	before loading a Image from a DOC device
2579566a494fSHeiko Schocher  -35	common/cmd_doc.c	Bad usage of "doc" command
2580566a494fSHeiko Schocher   35	common/cmd_doc.c	correct usage of "doc" command
2581566a494fSHeiko Schocher  -36	common/cmd_doc.c	No boot device
2582566a494fSHeiko Schocher   36	common/cmd_doc.c	correct boot device
2583566a494fSHeiko Schocher  -37	common/cmd_doc.c	Unknown Chip ID on boot device
2584566a494fSHeiko Schocher   37	common/cmd_doc.c	correct chip ID found, device available
2585566a494fSHeiko Schocher  -38	common/cmd_doc.c	Read Error on boot device
2586566a494fSHeiko Schocher   38	common/cmd_doc.c	reading Image header from DOC device OK
2587566a494fSHeiko Schocher  -39	common/cmd_doc.c	Image header has bad magic number
2588566a494fSHeiko Schocher   39	common/cmd_doc.c	Image header has correct magic number
2589566a494fSHeiko Schocher  -40	common/cmd_doc.c	Error reading Image from DOC device
2590566a494fSHeiko Schocher   40	common/cmd_doc.c	Image header has correct magic number
2591566a494fSHeiko Schocher   41	common/cmd_ide.c	before loading a Image from a IDE device
2592566a494fSHeiko Schocher  -42	common/cmd_ide.c	Bad usage of "ide" command
2593566a494fSHeiko Schocher   42	common/cmd_ide.c	correct usage of "ide" command
2594566a494fSHeiko Schocher  -43	common/cmd_ide.c	No boot device
2595566a494fSHeiko Schocher   43	common/cmd_ide.c	boot device found
2596566a494fSHeiko Schocher  -44	common/cmd_ide.c	Device not available
2597566a494fSHeiko Schocher   44	common/cmd_ide.c	Device available
2598566a494fSHeiko Schocher  -45	common/cmd_ide.c	wrong partition selected
2599566a494fSHeiko Schocher   45	common/cmd_ide.c	partition selected
2600566a494fSHeiko Schocher  -46	common/cmd_ide.c	Unknown partition table
2601566a494fSHeiko Schocher   46	common/cmd_ide.c	valid partition table found
2602566a494fSHeiko Schocher  -47	common/cmd_ide.c	Invalid partition type
2603566a494fSHeiko Schocher   47	common/cmd_ide.c	correct partition type
2604566a494fSHeiko Schocher  -48	common/cmd_ide.c	Error reading Image Header on boot device
2605566a494fSHeiko Schocher   48	common/cmd_ide.c	reading Image Header from IDE device OK
2606566a494fSHeiko Schocher  -49	common/cmd_ide.c	Image header has bad magic number
2607566a494fSHeiko Schocher   49	common/cmd_ide.c	Image header has correct magic number
2608566a494fSHeiko Schocher  -50	common/cmd_ide.c	Image header has bad	 checksum
2609566a494fSHeiko Schocher   50	common/cmd_ide.c	Image header has correct checksum
2610566a494fSHeiko Schocher  -51	common/cmd_ide.c	Error reading Image from IDE device
2611566a494fSHeiko Schocher   51	common/cmd_ide.c	reading Image from IDE device OK
2612566a494fSHeiko Schocher   52	common/cmd_nand.c	before loading a Image from a NAND device
2613566a494fSHeiko Schocher  -53	common/cmd_nand.c	Bad usage of "nand" command
2614566a494fSHeiko Schocher   53	common/cmd_nand.c	correct usage of "nand" command
2615566a494fSHeiko Schocher  -54	common/cmd_nand.c	No boot device
2616566a494fSHeiko Schocher   54	common/cmd_nand.c	boot device found
2617566a494fSHeiko Schocher  -55	common/cmd_nand.c	Unknown Chip ID on boot device
2618566a494fSHeiko Schocher   55	common/cmd_nand.c	correct chip ID found, device available
2619566a494fSHeiko Schocher  -56	common/cmd_nand.c	Error reading Image Header on boot device
2620566a494fSHeiko Schocher   56	common/cmd_nand.c	reading Image Header from NAND device OK
2621566a494fSHeiko Schocher  -57	common/cmd_nand.c	Image header has bad magic number
2622566a494fSHeiko Schocher   57	common/cmd_nand.c	Image header has correct magic number
2623566a494fSHeiko Schocher  -58	common/cmd_nand.c	Error reading Image from NAND device
2624566a494fSHeiko Schocher   58	common/cmd_nand.c	reading Image from NAND device OK
2625c609719bSwdenk
2626566a494fSHeiko Schocher  -60	common/env_common.c	Environment has a bad CRC, using default
2627c609719bSwdenk
2628566a494fSHeiko Schocher   64	net/eth.c		starting with Ethernet configuration.
2629566a494fSHeiko Schocher  -64	net/eth.c		no Ethernet found.
2630566a494fSHeiko Schocher   65	net/eth.c		Ethernet found.
2631206c60cbSwdenk
2632566a494fSHeiko Schocher  -80	common/cmd_net.c	usage wrong
2633566a494fSHeiko Schocher   80	common/cmd_net.c	before calling NetLoop()
263411ccc33fSMarcel Ziswiler  -81	common/cmd_net.c	some error in NetLoop() occurred
2635566a494fSHeiko Schocher   81	common/cmd_net.c	NetLoop() back without error
2636566a494fSHeiko Schocher  -82	common/cmd_net.c	size == 0 (File with size 0 loaded)
2637566a494fSHeiko Schocher   82	common/cmd_net.c	trying automatic boot
263874de7aefSWolfgang Denk   83	common/cmd_net.c	running "source" command
263974de7aefSWolfgang Denk  -83	common/cmd_net.c	some error in automatic boot or "source" command
2640566a494fSHeiko Schocher   84	common/cmd_net.c	end without errors
2641c609719bSwdenk
26421372cce2SMarian BalakowiczFIT uImage format:
26431372cce2SMarian Balakowicz
26441372cce2SMarian Balakowicz  Arg	Where			When
26451372cce2SMarian Balakowicz  100	common/cmd_bootm.c	Kernel FIT Image has correct format
26461372cce2SMarian Balakowicz -100	common/cmd_bootm.c	Kernel FIT Image has incorrect format
26471372cce2SMarian Balakowicz  101	common/cmd_bootm.c	No Kernel subimage unit name, using configuration
26481372cce2SMarian Balakowicz -101	common/cmd_bootm.c	Can't get configuration for kernel subimage
26491372cce2SMarian Balakowicz  102	common/cmd_bootm.c	Kernel unit name specified
26501372cce2SMarian Balakowicz -103	common/cmd_bootm.c	Can't get kernel subimage node offset
2651f773bea8SMarian Balakowicz  103	common/cmd_bootm.c	Found configuration node
26521372cce2SMarian Balakowicz  104	common/cmd_bootm.c	Got kernel subimage node offset
26531372cce2SMarian Balakowicz -104	common/cmd_bootm.c	Kernel subimage hash verification failed
26541372cce2SMarian Balakowicz  105	common/cmd_bootm.c	Kernel subimage hash verification OK
26551372cce2SMarian Balakowicz -105	common/cmd_bootm.c	Kernel subimage is for unsupported architecture
26561372cce2SMarian Balakowicz  106	common/cmd_bootm.c	Architecture check OK
265711ccc33fSMarcel Ziswiler -106	common/cmd_bootm.c	Kernel subimage has wrong type
265811ccc33fSMarcel Ziswiler  107	common/cmd_bootm.c	Kernel subimage type OK
26591372cce2SMarian Balakowicz -107	common/cmd_bootm.c	Can't get kernel subimage data/size
26601372cce2SMarian Balakowicz  108	common/cmd_bootm.c	Got kernel subimage data/size
26611372cce2SMarian Balakowicz -108	common/cmd_bootm.c	Wrong image type (not legacy, FIT)
26621372cce2SMarian Balakowicz -109	common/cmd_bootm.c	Can't get kernel subimage type
26631372cce2SMarian Balakowicz -110	common/cmd_bootm.c	Can't get kernel subimage comp
26641372cce2SMarian Balakowicz -111	common/cmd_bootm.c	Can't get kernel subimage os
26651372cce2SMarian Balakowicz -112	common/cmd_bootm.c	Can't get kernel subimage load address
26661372cce2SMarian Balakowicz -113	common/cmd_bootm.c	Image uncompress/copy overwrite error
26671372cce2SMarian Balakowicz
26681372cce2SMarian Balakowicz  120	common/image.c		Start initial ramdisk verification
26691372cce2SMarian Balakowicz -120	common/image.c		Ramdisk FIT image has incorrect format
26701372cce2SMarian Balakowicz  121	common/image.c		Ramdisk FIT image has correct format
267111ccc33fSMarcel Ziswiler  122	common/image.c		No ramdisk subimage unit name, using configuration
26721372cce2SMarian Balakowicz -122	common/image.c		Can't get configuration for ramdisk subimage
26731372cce2SMarian Balakowicz  123	common/image.c		Ramdisk unit name specified
26741372cce2SMarian Balakowicz -124	common/image.c		Can't get ramdisk subimage node offset
26751372cce2SMarian Balakowicz  125	common/image.c		Got ramdisk subimage node offset
26761372cce2SMarian Balakowicz -125	common/image.c		Ramdisk subimage hash verification failed
26771372cce2SMarian Balakowicz  126	common/image.c		Ramdisk subimage hash verification OK
26781372cce2SMarian Balakowicz -126	common/image.c		Ramdisk subimage for unsupported architecture
26791372cce2SMarian Balakowicz  127	common/image.c		Architecture check OK
26801372cce2SMarian Balakowicz -127	common/image.c		Can't get ramdisk subimage data/size
26811372cce2SMarian Balakowicz  128	common/image.c		Got ramdisk subimage data/size
26821372cce2SMarian Balakowicz  129	common/image.c		Can't get ramdisk load address
26831372cce2SMarian Balakowicz -129	common/image.c		Got ramdisk load address
26841372cce2SMarian Balakowicz
268511ccc33fSMarcel Ziswiler -130	common/cmd_doc.c	Incorrect FIT image format
26861372cce2SMarian Balakowicz  131	common/cmd_doc.c	FIT image format OK
26871372cce2SMarian Balakowicz
268811ccc33fSMarcel Ziswiler -140	common/cmd_ide.c	Incorrect FIT image format
26891372cce2SMarian Balakowicz  141	common/cmd_ide.c	FIT image format OK
26901372cce2SMarian Balakowicz
269111ccc33fSMarcel Ziswiler -150	common/cmd_nand.c	Incorrect FIT image format
26921372cce2SMarian Balakowicz  151	common/cmd_nand.c	FIT image format OK
26931372cce2SMarian Balakowicz
2694d95f6ec7SGabe Black- FIT image support:
2695d95f6ec7SGabe Black		CONFIG_FIT
2696d95f6ec7SGabe Black		Enable support for the FIT uImage format.
2697d95f6ec7SGabe Black
2698d95f6ec7SGabe Black		CONFIG_FIT_BEST_MATCH
2699d95f6ec7SGabe Black		When no configuration is explicitly selected, default to the
2700d95f6ec7SGabe Black		one whose fdt's compatibility field best matches that of
2701d95f6ec7SGabe Black		U-Boot itself. A match is considered "best" if it matches the
2702d95f6ec7SGabe Black		most specific compatibility entry of U-Boot's fdt's root node.
2703d95f6ec7SGabe Black		The order of entries in the configuration's fdt is ignored.
2704d95f6ec7SGabe Black
27054cf2609bSWolfgang Denk- Standalone program support:
27064cf2609bSWolfgang Denk		CONFIG_STANDALONE_LOAD_ADDR
27074cf2609bSWolfgang Denk
27086feff899SWolfgang Denk		This option defines a board specific value for the
27096feff899SWolfgang Denk		address where standalone program gets loaded, thus
27106feff899SWolfgang Denk		overwriting the architecture dependent default
27114cf2609bSWolfgang Denk		settings.
27124cf2609bSWolfgang Denk
27134cf2609bSWolfgang Denk- Frame Buffer Address:
27144cf2609bSWolfgang Denk		CONFIG_FB_ADDR
27154cf2609bSWolfgang Denk
27164cf2609bSWolfgang Denk		Define CONFIG_FB_ADDR if you want to use specific
271744a53b57SWolfgang Denk		address for frame buffer.  This is typically the case
271844a53b57SWolfgang Denk		when using a graphics controller has separate video
271944a53b57SWolfgang Denk		memory.  U-Boot will then place the frame buffer at
272044a53b57SWolfgang Denk		the given address instead of dynamically reserving it
272144a53b57SWolfgang Denk		in system RAM by calling lcd_setmem(), which grabs
272244a53b57SWolfgang Denk		the memory for the frame buffer depending on the
272344a53b57SWolfgang Denk		configured panel size.
27244cf2609bSWolfgang Denk
27254cf2609bSWolfgang Denk		Please see board_init_f function.
27264cf2609bSWolfgang Denk
2727cccfc2abSDetlev Zundel- Automatic software updates via TFTP server
2728cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP
2729cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_CNT_MAX
2730cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_MSEC_MAX
2731cccfc2abSDetlev Zundel
2732cccfc2abSDetlev Zundel		These options enable and control the auto-update feature;
2733cccfc2abSDetlev Zundel		for a more detailed description refer to doc/README.update.
2734cccfc2abSDetlev Zundel
2735cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support)
2736cccfc2abSDetlev Zundel		CONFIG_MTD_DEVICE
2737cccfc2abSDetlev Zundel
2738cccfc2abSDetlev Zundel		Adds the MTD device infrastructure from the Linux kernel.
2739cccfc2abSDetlev Zundel		Needed for mtdparts command support.
2740cccfc2abSDetlev Zundel
2741cccfc2abSDetlev Zundel		CONFIG_MTD_PARTITIONS
2742cccfc2abSDetlev Zundel
2743cccfc2abSDetlev Zundel		Adds the MTD partitioning infrastructure from the Linux
2744cccfc2abSDetlev Zundel		kernel. Needed for UBI support.
2745cccfc2abSDetlev Zundel
27466a11cf48SDaniel Schwierzeck- SPL framework
27476a11cf48SDaniel Schwierzeck		CONFIG_SPL
27486a11cf48SDaniel Schwierzeck		Enable building of SPL globally.
27496a11cf48SDaniel Schwierzeck
275095579793STom Rini		CONFIG_SPL_LDSCRIPT
275195579793STom Rini		LDSCRIPT for linking the SPL binary.
275295579793STom Rini
275395579793STom Rini		CONFIG_SPL_MAX_SIZE
275495579793STom Rini		Maximum binary size (text, data and rodata) of the SPL binary.
275595579793STom Rini
27566a11cf48SDaniel Schwierzeck		CONFIG_SPL_TEXT_BASE
27576a11cf48SDaniel Schwierzeck		TEXT_BASE for linking the SPL binary.
27586a11cf48SDaniel Schwierzeck
275994a45bb1SScott Wood		CONFIG_SPL_RELOC_TEXT_BASE
276094a45bb1SScott Wood		Address to relocate to.  If unspecified, this is equal to
276194a45bb1SScott Wood		CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
276294a45bb1SScott Wood
276395579793STom Rini		CONFIG_SPL_BSS_START_ADDR
276495579793STom Rini		Link address for the BSS within the SPL binary.
276595579793STom Rini
276695579793STom Rini		CONFIG_SPL_BSS_MAX_SIZE
276795579793STom Rini		Maximum binary size of the BSS section of the SPL binary.
276895579793STom Rini
276995579793STom Rini		CONFIG_SPL_STACK
277095579793STom Rini		Adress of the start of the stack SPL will use
277195579793STom Rini
277294a45bb1SScott Wood		CONFIG_SPL_RELOC_STACK
277394a45bb1SScott Wood		Adress of the start of the stack SPL will use after
277494a45bb1SScott Wood		relocation.  If unspecified, this is equal to
277594a45bb1SScott Wood		CONFIG_SPL_STACK.
277694a45bb1SScott Wood
277795579793STom Rini		CONFIG_SYS_SPL_MALLOC_START
277895579793STom Rini		Starting address of the malloc pool used in SPL.
277995579793STom Rini
278095579793STom Rini		CONFIG_SYS_SPL_MALLOC_SIZE
278195579793STom Rini		The size of the malloc pool used in SPL.
27826a11cf48SDaniel Schwierzeck
278347f7bcaeSTom Rini		CONFIG_SPL_FRAMEWORK
278447f7bcaeSTom Rini		Enable the SPL framework under common/.  This framework
278547f7bcaeSTom Rini		supports MMC, NAND and YMODEM loading of U-Boot and NAND
278647f7bcaeSTom Rini		NAND loading of the Linux Kernel.
278747f7bcaeSTom Rini
2788861a86f4STom Rini		CONFIG_SPL_DISPLAY_PRINT
2789861a86f4STom Rini		For ARM, enable an optional function to print more information
2790861a86f4STom Rini		about the running system.
2791861a86f4STom Rini
27924b919725SScott Wood		CONFIG_SPL_INIT_MINIMAL
27934b919725SScott Wood		Arch init code should be built for a very small image
27944b919725SScott Wood
27956a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBCOMMON_SUPPORT
27966a11cf48SDaniel Schwierzeck		Support for common/libcommon.o in SPL binary
27976a11cf48SDaniel Schwierzeck
27986a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBDISK_SUPPORT
27996a11cf48SDaniel Schwierzeck		Support for disk/libdisk.o in SPL binary
28006a11cf48SDaniel Schwierzeck
28016a11cf48SDaniel Schwierzeck		CONFIG_SPL_I2C_SUPPORT
28026a11cf48SDaniel Schwierzeck		Support for drivers/i2c/libi2c.o in SPL binary
28036a11cf48SDaniel Schwierzeck
28046a11cf48SDaniel Schwierzeck		CONFIG_SPL_GPIO_SUPPORT
28056a11cf48SDaniel Schwierzeck		Support for drivers/gpio/libgpio.o in SPL binary
28066a11cf48SDaniel Schwierzeck
28076a11cf48SDaniel Schwierzeck		CONFIG_SPL_MMC_SUPPORT
28086a11cf48SDaniel Schwierzeck		Support for drivers/mmc/libmmc.o in SPL binary
28096a11cf48SDaniel Schwierzeck
281095579793STom Rini		CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
281195579793STom Rini		CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
281295579793STom Rini		CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION
281395579793STom Rini		Address, size and partition on the MMC to load U-Boot from
281495579793STom Rini		when the MMC is being used in raw mode.
281595579793STom Rini
281695579793STom Rini		CONFIG_SPL_FAT_SUPPORT
281795579793STom Rini		Support for fs/fat/libfat.o in SPL binary
281895579793STom Rini
281995579793STom Rini		CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME
282095579793STom Rini		Filename to read to load U-Boot when reading from FAT
282195579793STom Rini
282206f60ae3SScott Wood		CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
282306f60ae3SScott Wood		Set this for NAND SPL on PPC mpc83xx targets, so that
282406f60ae3SScott Wood		start.S waits for the rest of the SPL to load before
282506f60ae3SScott Wood		continuing (the hardware starts execution after just
282606f60ae3SScott Wood		loading the first page rather than the full 4K).
282706f60ae3SScott Wood
28286f2f01b9SScott Wood		CONFIG_SPL_NAND_BASE
28296f2f01b9SScott Wood		Include nand_base.c in the SPL.  Requires
28306f2f01b9SScott Wood		CONFIG_SPL_NAND_DRIVERS.
28316f2f01b9SScott Wood
28326f2f01b9SScott Wood		CONFIG_SPL_NAND_DRIVERS
28336f2f01b9SScott Wood		SPL uses normal NAND drivers, not minimal drivers.
28346f2f01b9SScott Wood
28356f2f01b9SScott Wood		CONFIG_SPL_NAND_ECC
28366f2f01b9SScott Wood		Include standard software ECC in the SPL
28376f2f01b9SScott Wood
283895579793STom Rini		CONFIG_SPL_NAND_SIMPLE
28397d4b7955SScott Wood		Support for NAND boot using simple NAND drivers that
28407d4b7955SScott Wood		expose the cmd_ctrl() interface.
284195579793STom Rini
284295579793STom Rini		CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
284395579793STom Rini		CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
284495579793STom Rini		CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
284595579793STom Rini		CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
284695579793STom Rini		CONFIG_SYS_NAND_ECCBYTES
284795579793STom Rini		Defines the size and behavior of the NAND that SPL uses
28487d4b7955SScott Wood		to read U-Boot
284995579793STom Rini
285095579793STom Rini		CONFIG_SYS_NAND_U_BOOT_OFFS
28517d4b7955SScott Wood		Location in NAND to read U-Boot from
28527d4b7955SScott Wood
28537d4b7955SScott Wood		CONFIG_SYS_NAND_U_BOOT_DST
28547d4b7955SScott Wood		Location in memory to load U-Boot to
28557d4b7955SScott Wood
28567d4b7955SScott Wood		CONFIG_SYS_NAND_U_BOOT_SIZE
28577d4b7955SScott Wood		Size of image to load
285895579793STom Rini
285995579793STom Rini		CONFIG_SYS_NAND_U_BOOT_START
28607d4b7955SScott Wood		Entry point in loaded image to jump to
286195579793STom Rini
286295579793STom Rini		CONFIG_SYS_NAND_HW_ECC_OOBFIRST
286395579793STom Rini		Define this if you need to first read the OOB and then the
286495579793STom Rini		data. This is used for example on davinci plattforms.
286595579793STom Rini
286695579793STom Rini		CONFIG_SPL_OMAP3_ID_NAND
286795579793STom Rini		Support for an OMAP3-specific set of functions to return the
286895579793STom Rini		ID and MFR of the first attached NAND chip, if present.
286995579793STom Rini
28706a11cf48SDaniel Schwierzeck		CONFIG_SPL_SERIAL_SUPPORT
28716a11cf48SDaniel Schwierzeck		Support for drivers/serial/libserial.o in SPL binary
28726a11cf48SDaniel Schwierzeck
28736a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_FLASH_SUPPORT
28746a11cf48SDaniel Schwierzeck		Support for drivers/mtd/spi/libspi_flash.o in SPL binary
28756a11cf48SDaniel Schwierzeck
28766a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_SUPPORT
28776a11cf48SDaniel Schwierzeck		Support for drivers/spi/libspi.o in SPL binary
28786a11cf48SDaniel Schwierzeck
2879c57b953dSPavel Machek		CONFIG_SPL_RAM_DEVICE
2880c57b953dSPavel Machek		Support for running image already present in ram, in SPL binary
2881c57b953dSPavel Machek
28826a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBGENERIC_SUPPORT
28836a11cf48SDaniel Schwierzeck		Support for lib/libgeneric.o in SPL binary
28841372cce2SMarian Balakowicz
288574752baaSScott Wood		CONFIG_SPL_PAD_TO
288674752baaSScott Wood		Linker address to which the SPL should be padded before
288774752baaSScott Wood		appending the SPL payload.
288874752baaSScott Wood
2889ca2fca22SScott Wood		CONFIG_SPL_TARGET
2890ca2fca22SScott Wood		Final target image containing SPL and payload.  Some SPLs
2891ca2fca22SScott Wood		use an arch-specific makefile fragment instead, for
2892ca2fca22SScott Wood		example if more than one image needs to be produced.
2893ca2fca22SScott Wood
2894c609719bSwdenkModem Support:
2895c609719bSwdenk--------------
2896c609719bSwdenk
2897566e5cf4SWolfgang Denk[so far only for SMDK2400 boards]
2898c609719bSwdenk
289911ccc33fSMarcel Ziswiler- Modem support enable:
2900c609719bSwdenk		CONFIG_MODEM_SUPPORT
2901c609719bSwdenk
2902c609719bSwdenk- RTS/CTS Flow control enable:
2903c609719bSwdenk		CONFIG_HWFLOW
2904c609719bSwdenk
2905c609719bSwdenk- Modem debug support:
2906c609719bSwdenk		CONFIG_MODEM_SUPPORT_DEBUG
2907c609719bSwdenk
2908c609719bSwdenk		Enables debugging stuff (char screen[1024], dbg())
2909c609719bSwdenk		for modem support. Useful only with BDI2000.
2910c609719bSwdenk
2911a8c7c708Swdenk- Interrupt support (PPC):
2912a8c7c708Swdenk
2913a8c7c708Swdenk		There are common interrupt_init() and timer_interrupt()
2914a8c7c708Swdenk		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
291511ccc33fSMarcel Ziswiler		for CPU specific initialization. interrupt_init_cpu()
2916a8c7c708Swdenk		should set decrementer_count to appropriate value. If
291711ccc33fSMarcel Ziswiler		CPU resets decrementer automatically after interrupt
2918a8c7c708Swdenk		(ppc4xx) it should set decrementer_count to zero.
291911ccc33fSMarcel Ziswiler		timer_interrupt() calls timer_interrupt_cpu() for CPU
2920a8c7c708Swdenk		specific handling. If board has watchdog / status_led
2921a8c7c708Swdenk		/ other_activity_monitor it works automatically from
2922a8c7c708Swdenk		general timer_interrupt().
2923a8c7c708Swdenk
2924c609719bSwdenk- General:
2925c609719bSwdenk
2926c609719bSwdenk		In the target system modem support is enabled when a
2927c609719bSwdenk		specific key (key combination) is pressed during
2928c609719bSwdenk		power-on. Otherwise U-Boot will boot normally
292911ccc33fSMarcel Ziswiler		(autoboot). The key_pressed() function is called from
2930c609719bSwdenk		board_init(). Currently key_pressed() is a dummy
2931c609719bSwdenk		function, returning 1 and thus enabling modem
2932c609719bSwdenk		initialization.
2933c609719bSwdenk
2934c609719bSwdenk		If there are no modem init strings in the
2935c609719bSwdenk		environment, U-Boot proceed to autoboot; the
2936c609719bSwdenk		previous output (banner, info printfs) will be
293711ccc33fSMarcel Ziswiler		suppressed, though.
2938c609719bSwdenk
2939c609719bSwdenk		See also: doc/README.Modem
2940c609719bSwdenk
29419660e442SHelmut RaigerBoard initialization settings:
29429660e442SHelmut Raiger------------------------------
29439660e442SHelmut Raiger
29449660e442SHelmut RaigerDuring Initialization u-boot calls a number of board specific functions
29459660e442SHelmut Raigerto allow the preparation of board specific prerequisites, e.g. pin setup
29469660e442SHelmut Raigerbefore drivers are initialized. To enable these callbacks the
29479660e442SHelmut Raigerfollowing configuration macros have to be defined. Currently this is
29489660e442SHelmut Raigerarchitecture specific, so please check arch/your_architecture/lib/board.c
29499660e442SHelmut Raigertypically in board_init_f() and board_init_r().
29509660e442SHelmut Raiger
29519660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
29529660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
29539660e442SHelmut Raiger- CONFIG_BOARD_LATE_INIT: Call board_late_init()
29549660e442SHelmut Raiger- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
2955c609719bSwdenk
2956c609719bSwdenkConfiguration Settings:
2957c609719bSwdenk-----------------------
2958c609719bSwdenk
29596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
2960c609719bSwdenk		undefine this when you're short of memory.
2961c609719bSwdenk
29622fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
29632fb2604dSPeter Tyser		width of the commands listed in the 'help' command output.
29642fb2604dSPeter Tyser
29656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT:	This is what U-Boot prints on the console to
2966c609719bSwdenk		prompt for user input.
2967c609719bSwdenk
29686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE:	Buffer size for input from the Console
2969c609719bSwdenk
29706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE:	Buffer size for Console output
2971c609719bSwdenk
29726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS:	max. Number of arguments accepted for monitor commands
2973c609719bSwdenk
29746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
2975c609719bSwdenk		the application (usually a Linux kernel) when it is
2976c609719bSwdenk		booted
2977c609719bSwdenk
29786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE:
2979c609719bSwdenk		List of legal baudrate settings for this board.
2980c609719bSwdenk
29816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_INFO_QUIET
2982c609719bSwdenk		Suppress display of console information at boot.
2983c609719bSwdenk
29846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_IS_IN_ENV
2985c609719bSwdenk		If the board specific function
2986c609719bSwdenk			extern int overwrite_console (void);
2987c609719bSwdenk		returns 1, the stdin, stderr and stdout are switched to the
2988c609719bSwdenk		serial port, else the settings in the environment are used.
2989c609719bSwdenk
29906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
2991c609719bSwdenk		Enable the call to overwrite_console().
2992c609719bSwdenk
29936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
2994c609719bSwdenk		Enable overwrite of previous console environment settings.
2995c609719bSwdenk
29966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
2997c609719bSwdenk		Begin and End addresses of the area used by the
2998c609719bSwdenk		simple memory test.
2999c609719bSwdenk
30006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST:
3001c609719bSwdenk		Enable an alternate, more extensive memory test.
3002c609719bSwdenk
30036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH:
30045f535fe1Swdenk		Scratch address used by the alternate memory test
30055f535fe1Swdenk		You only need to set this if address zero isn't writeable
30065f535fe1Swdenk
30076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
30086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
300914f73ca6SStefan Roese		this specified memory area will get subtracted from the top
301011ccc33fSMarcel Ziswiler		(end) of RAM and won't get "touched" at all by U-Boot. By
301114f73ca6SStefan Roese		fixing up gd->ram_size the Linux kernel should gets passed
301214f73ca6SStefan Roese		the now "corrected" memory size and won't touch it either.
301314f73ca6SStefan Roese		This should work for arch/ppc and arch/powerpc. Only Linux
30145e12e75dSStefan Roese		board ports in arch/powerpc with bootwrapper support that
301514f73ca6SStefan Roese		recalculate the memory size from the SDRAM controller setup
30165e12e75dSStefan Roese		will have to get fixed in Linux additionally.
301714f73ca6SStefan Roese
301814f73ca6SStefan Roese		This option can be used as a workaround for the 440EPx/GRx
301914f73ca6SStefan Roese		CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
302014f73ca6SStefan Roese		be touched.
302114f73ca6SStefan Roese
302214f73ca6SStefan Roese		WARNING: Please make sure that this value is a multiple of
302314f73ca6SStefan Roese		the Linux page size (normally 4k). If this is not the case,
302414f73ca6SStefan Roese		then the end address of the Linux memory will be located at a
302514f73ca6SStefan Roese		non page size aligned address and this could cause major
302614f73ca6SStefan Roese		problems.
302714f73ca6SStefan Roese
30286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE:
3029c609719bSwdenk		Enable temporary baudrate change while serial download
3030c609719bSwdenk
30316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE:
3032c609719bSwdenk		Physical start address of SDRAM. _Must_ be 0 here.
3033c609719bSwdenk
30346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MBIO_BASE:
3035c609719bSwdenk		Physical start address of Motherboard I/O (if using a
3036c609719bSwdenk		Cogent motherboard)
3037c609719bSwdenk
30386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE:
3039c609719bSwdenk		Physical start address of Flash memory.
3040c609719bSwdenk
30416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE:
3042c609719bSwdenk		Physical start address of boot monitor code (set by
3043c609719bSwdenk		make config files to be same as the text base address
304414d0a02aSWolfgang Denk		(CONFIG_SYS_TEXT_BASE) used when linking) - same as
30456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FLASH_BASE when booting from flash.
3046c609719bSwdenk
30476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN:
30483b57fe0aSwdenk		Size of memory reserved for monitor code, used to
30493b57fe0aSwdenk		determine _at_compile_time_ (!) if the environment is
30503b57fe0aSwdenk		embedded within the U-Boot image, or in a separate
30513b57fe0aSwdenk		flash sector.
3052c609719bSwdenk
30536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN:
3054c609719bSwdenk		Size of DRAM reserved for malloc() use.
3055c609719bSwdenk
30566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN:
305715940c9aSStefan Roese		Normally compressed uImages are limited to an
305815940c9aSStefan Roese		uncompressed size of 8 MBytes. If this is not enough,
30596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		you can define CONFIG_SYS_BOOTM_LEN in your board config file
306015940c9aSStefan Roese		to adjust this setting to your needs.
3061c609719bSwdenk
30626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ:
3063c609719bSwdenk		Maximum size of memory mapped by the startup code of
3064c609719bSwdenk		the Linux kernel; all data that must be processed by
30657d721e34SBartlomiej Sieka		the Linux kernel (bd_info, boot arguments, FDT blob if
30667d721e34SBartlomiej Sieka		used) must be put below this limit, unless "bootm_low"
30677d721e34SBartlomiej Sieka		enviroment variable is defined and non-zero. In such case
30687d721e34SBartlomiej Sieka		all data for the Linux kernel must be between "bootm_low"
3069c3624e6eSGrant Likely		and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.	 The environment
3070c3624e6eSGrant Likely		variable "bootm_mapsize" will override the value of
3071c3624e6eSGrant Likely		CONFIG_SYS_BOOTMAPSZ.  If CONFIG_SYS_BOOTMAPSZ is undefined,
3072c3624e6eSGrant Likely		then the value in "bootm_size" will be used instead.
3073c609719bSwdenk
3074fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3075fca43cc8SJohn Rigby		Enable initrd_high functionality.  If defined then the
3076fca43cc8SJohn Rigby		initrd_high feature is enabled and the bootm ramdisk subcommand
3077fca43cc8SJohn Rigby		is enabled.
3078fca43cc8SJohn Rigby
3079fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_CMDLINE:
3080fca43cc8SJohn Rigby		Enables allocating and saving kernel cmdline in space between
3081fca43cc8SJohn Rigby		"bootm_low" and "bootm_low" + BOOTMAPSZ.
3082fca43cc8SJohn Rigby
3083fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_KBD:
3084fca43cc8SJohn Rigby		Enables allocating and saving a kernel copy of the bd_info in
3085fca43cc8SJohn Rigby		space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3086fca43cc8SJohn Rigby
30876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS:
3088c609719bSwdenk		Max number of Flash memory banks
3089c609719bSwdenk
30906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT:
3091c609719bSwdenk		Max number of sectors on a Flash chip
3092c609719bSwdenk
30936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT:
3094c609719bSwdenk		Timeout for Flash erase operations (in ms)
3095c609719bSwdenk
30966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT:
3097c609719bSwdenk		Timeout for Flash write operations (in ms)
3098c609719bSwdenk
30996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT
31008564acf9Swdenk		Timeout for Flash set sector lock bit operation (in ms)
31018564acf9Swdenk
31026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT
31038564acf9Swdenk		Timeout for Flash clear lock bits operation (in ms)
31048564acf9Swdenk
31056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION
31068564acf9Swdenk		If defined, hardware flash sectors protection is used
31078564acf9Swdenk		instead of U-Boot software protection.
31088564acf9Swdenk
31096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP:
3110c609719bSwdenk
3111c609719bSwdenk		Enable TFTP transfers directly to flash memory;
3112c609719bSwdenk		without this option such a download has to be
3113c609719bSwdenk		performed in two steps: (1) download to RAM, and (2)
3114c609719bSwdenk		copy from RAM to flash.
3115c609719bSwdenk
3116c609719bSwdenk		The two-step approach is usually more reliable, since
3117c609719bSwdenk		you can check if the download worked before you erase
311811ccc33fSMarcel Ziswiler		the flash, but in some situations (when system RAM is
311911ccc33fSMarcel Ziswiler		too limited to allow for a temporary copy of the
3120c609719bSwdenk		downloaded image) this option may be very useful.
3121c609719bSwdenk
31226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI:
3123c609719bSwdenk		Define if the flash driver uses extra elements in the
31245653fc33Swdenk		common flash structure for storing flash geometry.
31255653fc33Swdenk
312600b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER
31275653fc33Swdenk		This option also enables the building of the cfi_flash driver
31285653fc33Swdenk		in the drivers directory
312953cf9435Sstroese
313091809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD
313191809ed5SPiotr Ziecik		This option enables the building of the cfi_mtd driver
313291809ed5SPiotr Ziecik		in the drivers directory. The driver exports CFI flash
313391809ed5SPiotr Ziecik		to the MTD layer.
313491809ed5SPiotr Ziecik
31356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
313696ef831fSGuennadi Liakhovetski		Use buffered writes to flash.
313796ef831fSGuennadi Liakhovetski
313896ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N
313996ef831fSGuennadi Liakhovetski		s29ws-n MirrorBit flash has non-standard addresses for buffered
314096ef831fSGuennadi Liakhovetski		write commands.
314196ef831fSGuennadi Liakhovetski
31426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST
31435568e613SStefan Roese		If this option is defined, the common CFI flash doesn't
31445568e613SStefan Roese		print it's warning upon not recognized FLASH banks. This
31455568e613SStefan Roese		is useful, if some of the configured banks are only
31465568e613SStefan Roese		optionally available.
31475568e613SStefan Roese
31489a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS
31499a042e9cSJerry Van Baren		If defined (must be an integer), print out countdown
31509a042e9cSJerry Van Baren		digits and dots.  Recommended value: 45 (9..1) for 80
31519a042e9cSJerry Van Baren		column displays, 15 (3..1) for 40 column displays.
31529a042e9cSJerry Van Baren
31536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER:
315411ccc33fSMarcel Ziswiler		Defines the number of Ethernet receive buffers. On some
315511ccc33fSMarcel Ziswiler		Ethernet controllers it is recommended to set this value
315653cf9435Sstroese		to 8 or even higher (EEPRO100 or 405 EMAC), since all
315753cf9435Sstroese		buffers can be full shortly after enabling the interface
315811ccc33fSMarcel Ziswiler		on high Ethernet traffic.
315953cf9435Sstroese		Defaults to 4 if not defined.
3160c609719bSwdenk
3161ea882bafSWolfgang Denk- CONFIG_ENV_MAX_ENTRIES
3162ea882bafSWolfgang Denk
3163ea882bafSWolfgang Denk	Maximum number of entries in the hash table that is used
3164ea882bafSWolfgang Denk	internally to store the environment settings. The default
3165ea882bafSWolfgang Denk	setting is supposed to be generous and should work in most
3166ea882bafSWolfgang Denk	cases. This setting can be used to tune behaviour; see
3167ea882bafSWolfgang Denk	lib/hashtable.c for details.
3168ea882bafSWolfgang Denk
31692598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_DEFAULT
31702598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_STATIC
31712598090bSJoe Hershberger	Enable validation of the values given to enviroment variables when
31722598090bSJoe Hershberger	calling env set.  Variables can be restricted to only decimal,
31732598090bSJoe Hershberger	hexadecimal, or boolean.  If CONFIG_CMD_NET is also defined,
31742598090bSJoe Hershberger	the variables can also be restricted to IP address or MAC address.
31752598090bSJoe Hershberger
31762598090bSJoe Hershberger	The format of the list is:
31772598090bSJoe Hershberger		type_attribute = [s|d|x|b|i|m]
3178267541f7SJoe Hershberger		access_atribute = [a|r|o|c]
3179267541f7SJoe Hershberger		attributes = type_attribute[access_atribute]
31802598090bSJoe Hershberger		entry = variable_name[:attributes]
31812598090bSJoe Hershberger		list = entry[,list]
31822598090bSJoe Hershberger
31832598090bSJoe Hershberger	The type attributes are:
31842598090bSJoe Hershberger		s - String (default)
31852598090bSJoe Hershberger		d - Decimal
31862598090bSJoe Hershberger		x - Hexadecimal
31872598090bSJoe Hershberger		b - Boolean ([1yYtT|0nNfF])
31882598090bSJoe Hershberger		i - IP address
31892598090bSJoe Hershberger		m - MAC address
31902598090bSJoe Hershberger
3191267541f7SJoe Hershberger	The access attributes are:
3192267541f7SJoe Hershberger		a - Any (default)
3193267541f7SJoe Hershberger		r - Read-only
3194267541f7SJoe Hershberger		o - Write-once
3195267541f7SJoe Hershberger		c - Change-default
3196267541f7SJoe Hershberger
31972598090bSJoe Hershberger	- CONFIG_ENV_FLAGS_LIST_DEFAULT
31982598090bSJoe Hershberger		Define this to a list (string) to define the ".flags"
31992598090bSJoe Hershberger		envirnoment variable in the default or embedded environment.
32002598090bSJoe Hershberger
32012598090bSJoe Hershberger	- CONFIG_ENV_FLAGS_LIST_STATIC
32022598090bSJoe Hershberger		Define this to a list (string) to define validation that
32032598090bSJoe Hershberger		should be done if an entry is not found in the ".flags"
32042598090bSJoe Hershberger		environment variable.  To override a setting in the static
32052598090bSJoe Hershberger		list, simply add an entry for the same variable name to the
32062598090bSJoe Hershberger		".flags" variable.
32072598090bSJoe Hershberger
3208267541f7SJoe Hershberger- CONFIG_ENV_ACCESS_IGNORE_FORCE
3209267541f7SJoe Hershberger	If defined, don't allow the -f switch to env set override variable
3210267541f7SJoe Hershberger	access flags.
3211267541f7SJoe Hershberger
3212c609719bSwdenkThe following definitions that deal with the placement and management
3213c609719bSwdenkof environment data (variable area); in general, we support the
3214c609719bSwdenkfollowing configurations:
3215c609719bSwdenk
3216c3eb3fe4SMike Frysinger- CONFIG_BUILD_ENVCRC:
3217c3eb3fe4SMike Frysinger
3218c3eb3fe4SMike Frysinger	Builds up envcrc with the target environment so that external utils
3219c3eb3fe4SMike Frysinger	may easily extract it and embed it in final U-Boot images.
3220c3eb3fe4SMike Frysinger
32215a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH:
3222c609719bSwdenk
3223c609719bSwdenk	Define this if the environment is in flash memory.
3224c609719bSwdenk
3225c609719bSwdenk	a) The environment occupies one whole flash sector, which is
3226c609719bSwdenk	   "embedded" in the text segment with the U-Boot code. This
3227c609719bSwdenk	   happens usually with "bottom boot sector" or "top boot
3228c609719bSwdenk	   sector" type flash chips, which have several smaller
3229c609719bSwdenk	   sectors at the start or the end. For instance, such a
3230c609719bSwdenk	   layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3231c609719bSwdenk	   such a case you would place the environment in one of the
3232c609719bSwdenk	   4 kB sectors - with U-Boot code before and after it. With
3233c609719bSwdenk	   "top boot sector" type flash chips, you would put the
3234c609719bSwdenk	   environment in one of the last sectors, leaving a gap
3235c609719bSwdenk	   between U-Boot and the environment.
3236c609719bSwdenk
32370e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
3238c609719bSwdenk
3239c609719bSwdenk	   Offset of environment data (variable area) to the
3240c609719bSwdenk	   beginning of flash memory; for instance, with bottom boot
3241c609719bSwdenk	   type flash chips the second sector can be used: the offset
3242c609719bSwdenk	   for this sector is given here.
3243c609719bSwdenk
32446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
3245c609719bSwdenk
32460e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
3247c609719bSwdenk
3248c609719bSwdenk	   This is just another way to specify the start address of
3249c609719bSwdenk	   the flash sector containing the environment (instead of
32500e8d1586SJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET).
3251c609719bSwdenk
32520e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SECT_SIZE:
3253c609719bSwdenk
3254c609719bSwdenk	   Size of the sector containing the environment.
3255c609719bSwdenk
3256c609719bSwdenk
3257c609719bSwdenk	b) Sometimes flash chips have few, equal sized, BIG sectors.
3258c609719bSwdenk	   In such a case you don't want to spend a whole sector for
3259c609719bSwdenk	   the environment.
3260c609719bSwdenk
32610e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3262c609719bSwdenk
32635a1aceb0SJean-Christophe PLAGNIOL-VILLARD	   If you use this in combination with CONFIG_ENV_IS_IN_FLASH
32640e8d1586SJean-Christophe PLAGNIOL-VILLARD	   and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
3265c609719bSwdenk	   of this flash sector for the environment. This saves
3266c609719bSwdenk	   memory for the RAM copy of the environment.
3267c609719bSwdenk
3268c609719bSwdenk	   It may also save flash memory if you decide to use this
3269c609719bSwdenk	   when your environment is "embedded" within U-Boot code,
3270c609719bSwdenk	   since then the remainder of the flash sector could be used
3271c609719bSwdenk	   for U-Boot code. It should be pointed out that this is
3272c609719bSwdenk	   STRONGLY DISCOURAGED from a robustness point of view:
3273c609719bSwdenk	   updating the environment in flash makes it always
3274c609719bSwdenk	   necessary to erase the WHOLE sector. If something goes
3275c609719bSwdenk	   wrong before the contents has been restored from a copy in
3276c609719bSwdenk	   RAM, your target system will be dead.
3277c609719bSwdenk
32780e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR_REDUND
32790e8d1586SJean-Christophe PLAGNIOL-VILLARD	  CONFIG_ENV_SIZE_REDUND
3280c609719bSwdenk
3281c609719bSwdenk	   These settings describe a second storage area used to hold
328211ccc33fSMarcel Ziswiler	   a redundant copy of the environment data, so that there is
32833e38691eSwdenk	   a valid backup copy in case there is a power failure during
3284c609719bSwdenk	   a "saveenv" operation.
3285c609719bSwdenk
3286c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the
3287c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds*
3288c609719bSwdenkaccordingly!
3289c609719bSwdenk
3290c609719bSwdenk
32919314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM:
3292c609719bSwdenk
3293c609719bSwdenk	Define this if you have some non-volatile memory device
3294c609719bSwdenk	(NVRAM, battery buffered SRAM) which you want to use for the
3295c609719bSwdenk	environment.
3296c609719bSwdenk
32970e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
32980e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3299c609719bSwdenk
330011ccc33fSMarcel Ziswiler	  These two #defines are used to determine the memory area you
3301c609719bSwdenk	  want to use for environment. It is assumed that this memory
3302c609719bSwdenk	  can just be read and written to, without any special
3303c609719bSwdenk	  provision.
3304c609719bSwdenk
3305c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early
3306c609719bSwdenkin U-Boot initalization (when we try to get the setting of for the
330711ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or
3308c609719bSwdenkU-Boot will hang.
3309c609719bSwdenk
3310c609719bSwdenkPlease note that even with NVRAM we still use a copy of the
3311c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to
3312c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv"
3313c609719bSwdenkto save the current settings.
3314c609719bSwdenk
3315c609719bSwdenk
3316bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM:
3317c609719bSwdenk
3318c609719bSwdenk	Use this if you have an EEPROM or similar serial access
3319c609719bSwdenk	device and a driver for it.
3320c609719bSwdenk
33210e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
33220e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3323c609719bSwdenk
3324c609719bSwdenk	  These two #defines specify the offset and size of the
3325c609719bSwdenk	  environment area within the total memory of your EEPROM.
3326c609719bSwdenk
33276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR:
3328c609719bSwdenk	  If defined, specified the chip address of the EEPROM device.
3329c609719bSwdenk	  The default address is zero.
3330c609719bSwdenk
33316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
3332c609719bSwdenk	  If defined, the number of bits used to address bytes in a
3333c609719bSwdenk	  single page in the EEPROM device.  A 64 byte page, for example
3334c609719bSwdenk	  would require six bits.
3335c609719bSwdenk
33366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
3337c609719bSwdenk	  If defined, the number of milliseconds to delay between
3338c609719bSwdenk	  page writes.	The default is zero milliseconds.
3339c609719bSwdenk
33406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
3341c609719bSwdenk	  The length in bytes of the EEPROM memory array address.  Note
3342c609719bSwdenk	  that this is NOT the chip address length!
3343c609719bSwdenk
33446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
33455cf91d6bSwdenk	  EEPROM chips that implement "address overflow" are ones
33465cf91d6bSwdenk	  like Catalyst 24WC04/08/16 which has 9/10/11 bits of
33475cf91d6bSwdenk	  address and the extra bits end up in the "chip address" bit
33485cf91d6bSwdenk	  slots. This makes a 24WC08 (1Kbyte) chip look like four 256
33495cf91d6bSwdenk	  byte chips.
33505cf91d6bSwdenk
33515cf91d6bSwdenk	  Note that we consider the length of the address field to
33525cf91d6bSwdenk	  still be one byte because the extra address bits are hidden
33535cf91d6bSwdenk	  in the chip address.
33545cf91d6bSwdenk
33556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_SIZE:
3356c609719bSwdenk	  The size in bytes of the EEPROM device.
3357c609719bSwdenk
3358548738b4SHeiko Schocher	- CONFIG_ENV_EEPROM_IS_ON_I2C
3359548738b4SHeiko Schocher	  define this, if you have I2C and SPI activated, and your
3360548738b4SHeiko Schocher	  EEPROM, which holds the environment, is on the I2C bus.
3361548738b4SHeiko Schocher
3362548738b4SHeiko Schocher	- CONFIG_I2C_ENV_EEPROM_BUS
3363548738b4SHeiko Schocher	  if you have an Environment on an EEPROM reached over
3364548738b4SHeiko Schocher	  I2C muxes, you can define here, how to reach this
3365548738b4SHeiko Schocher	  EEPROM. For example:
3366548738b4SHeiko Schocher
3367548738b4SHeiko Schocher	  #define CONFIG_I2C_ENV_EEPROM_BUS	  "pca9547:70:d\0"
3368548738b4SHeiko Schocher
3369548738b4SHeiko Schocher	  EEPROM which holds the environment, is reached over
3370548738b4SHeiko Schocher	  a pca9547 i2c mux with address 0x70, channel 3.
3371c609719bSwdenk
3372057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH:
33735779d8d9Swdenk
33745779d8d9Swdenk	Define this if you have a DataFlash memory device which you
33755779d8d9Swdenk	want to use for the environment.
33765779d8d9Swdenk
33770e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
33780e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
33790e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
33805779d8d9Swdenk
33815779d8d9Swdenk	  These three #defines specify the offset and size of the
33825779d8d9Swdenk	  environment area within the total memory of your DataFlash placed
33835779d8d9Swdenk	  at the specified address.
33845779d8d9Swdenk
33850a85a9e7SLiu Gang- CONFIG_ENV_IS_IN_REMOTE:
33860a85a9e7SLiu Gang
33870a85a9e7SLiu Gang	Define this if you have a remote memory space which you
33880a85a9e7SLiu Gang	want to use for the local device's environment.
33890a85a9e7SLiu Gang
33900a85a9e7SLiu Gang	- CONFIG_ENV_ADDR:
33910a85a9e7SLiu Gang	- CONFIG_ENV_SIZE:
33920a85a9e7SLiu Gang
33930a85a9e7SLiu Gang	  These two #defines specify the address and size of the
33940a85a9e7SLiu Gang	  environment area within the remote memory space. The
33950a85a9e7SLiu Gang	  local device can get the environment from remote memory
3396fc54c7faSLiu Gang	  space by SRIO or PCIE links.
33970a85a9e7SLiu Gang
33980a85a9e7SLiu GangBE CAREFUL! For some special cases, the local device can not use
33990a85a9e7SLiu Gang"saveenv" command. For example, the local device will get the
3400fc54c7faSLiu Gangenvironment stored in a remote NOR flash by SRIO or PCIE link,
3401fc54c7faSLiu Gangbut it can not erase, write this NOR flash by SRIO or PCIE interface.
34020a85a9e7SLiu Gang
340351bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND:
340413a5695bSwdenk
340513a5695bSwdenk	Define this if you have a NAND device which you want to use
340613a5695bSwdenk	for the environment.
340713a5695bSwdenk
34080e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
34090e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
341013a5695bSwdenk
341113a5695bSwdenk	  These two #defines specify the offset and size of the environment
3412fdd813deSScott Wood	  area within the first NAND device.  CONFIG_ENV_OFFSET must be
3413fdd813deSScott Wood	  aligned to an erase block boundary.
34145779d8d9Swdenk
3415fdd813deSScott Wood	- CONFIG_ENV_OFFSET_REDUND (optional):
3416e443c944SMarkus Klotzbuecher
34170e8d1586SJean-Christophe PLAGNIOL-VILLARD	  This setting describes a second storage area of CONFIG_ENV_SIZE
3418fdd813deSScott Wood	  size used to hold a redundant copy of the environment data, so
3419fdd813deSScott Wood	  that there is a valid backup copy in case there is a power failure
3420fdd813deSScott Wood	  during a "saveenv" operation.	 CONFIG_ENV_OFFSET_RENDUND must be
3421fdd813deSScott Wood	  aligned to an erase block boundary.
3422e443c944SMarkus Klotzbuecher
3423fdd813deSScott Wood	- CONFIG_ENV_RANGE (optional):
3424fdd813deSScott Wood
3425fdd813deSScott Wood	  Specifies the length of the region in which the environment
3426fdd813deSScott Wood	  can be written.  This should be a multiple of the NAND device's
3427fdd813deSScott Wood	  block size.  Specifying a range with more erase blocks than
3428fdd813deSScott Wood	  are needed to hold CONFIG_ENV_SIZE allows bad blocks within
3429fdd813deSScott Wood	  the range to be avoided.
3430fdd813deSScott Wood
3431fdd813deSScott Wood	- CONFIG_ENV_OFFSET_OOB (optional):
3432fdd813deSScott Wood
3433fdd813deSScott Wood	  Enables support for dynamically retrieving the offset of the
3434fdd813deSScott Wood	  environment from block zero's out-of-band data.  The
3435fdd813deSScott Wood	  "nand env.oob" command can be used to record this offset.
3436fdd813deSScott Wood	  Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
3437fdd813deSScott Wood	  using CONFIG_ENV_OFFSET_OOB.
3438e443c944SMarkus Klotzbuecher
3439b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST
3440b74ab737SGuennadi Liakhovetski
3441b74ab737SGuennadi Liakhovetski	Defines address in RAM to which the nand_spl code should copy the
3442b74ab737SGuennadi Liakhovetski	environment. If redundant environment is used, it will be copied to
3443b74ab737SGuennadi Liakhovetski	CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3444b74ab737SGuennadi Liakhovetski
34456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET
3446c609719bSwdenk
3447c609719bSwdenk	Defines offset to the initial SPI buffer area in DPRAM. The
3448c609719bSwdenk	area is used at an early stage (ROM part) if the environment
3449c609719bSwdenk	is configured to reside in the SPI EEPROM: We need a 520 byte
3450c609719bSwdenk	scratch DPRAM area. It is used between the two initialization
3451c609719bSwdenk	calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
3452c609719bSwdenk	to be a good choice since it makes it far enough from the
3453c609719bSwdenk	start of the data area as well as from the stack pointer.
3454c609719bSwdenk
3455e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor
3456c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been
3457cdb74977SWolfgang Denkcreated; also, when using EEPROM you will have to use getenv_f()
3458c609719bSwdenkuntil then to read environment variables.
3459c609719bSwdenk
346085ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor
346185ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working
346285ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is
346385ec0bccSwdenknecessary, because the first environment variable we need is the
346485ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't
346585ec0bccSwdenkhave any device yet where we could complain.]
3466c609719bSwdenk
3467c609719bSwdenkNote: once the monitor has been relocated, then it will complain if
3468c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you
346985ec0bccSwdenkuse the "saveenv" command to store a valid environment.
3470c609719bSwdenk
34716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
3472fc3e2165Swdenk		Echo the inverted Ethernet link state to the fault LED.
3473fc3e2165Swdenk
34746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
3475fc3e2165Swdenk		      also needs to be defined.
3476fc3e2165Swdenk
34776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR:
3478fc3e2165Swdenk		MII address of the PHY to check for the Ethernet link state.
3479c609719bSwdenk
3480f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS:
3481f5675aa5SRon Madrid		Define this if you desire to only have use of the NS16550_init
3482f5675aa5SRon Madrid		and NS16550_putc functions for the serial driver located at
3483f5675aa5SRon Madrid		drivers/serial/ns16550.c.  This option is useful for saving
3484f5675aa5SRon Madrid		space for already greatly restricted images, including but not
3485f5675aa5SRon Madrid		limited to NAND_SPL configurations.
3486f5675aa5SRon Madrid
3487b2b92f53SSimon Glass- CONFIG_DISPLAY_BOARDINFO
3488b2b92f53SSimon Glass		Display information about the board that U-Boot is running on
3489b2b92f53SSimon Glass		when U-Boot starts up. The board function checkboard() is called
3490b2b92f53SSimon Glass		to do this.
3491b2b92f53SSimon Glass
3492e2e3e2b1SSimon Glass- CONFIG_DISPLAY_BOARDINFO_LATE
3493e2e3e2b1SSimon Glass		Similar to the previous option, but display this information
3494e2e3e2b1SSimon Glass		later, once stdio is running and output goes to the LCD, if
3495e2e3e2b1SSimon Glass		present.
3496e2e3e2b1SSimon Glass
3497c609719bSwdenkLow Level (hardware related) configuration options:
3498dc7c9a1aSwdenk---------------------------------------------------
3499c609719bSwdenk
35006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE:
3501c609719bSwdenk		Cache Line Size of the CPU.
3502c609719bSwdenk
35036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR:
3504c609719bSwdenk		Default address of the IMMR after system reset.
35052535d602Swdenk
35062535d602Swdenk		Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
35072535d602Swdenk		and RPXsuper) to be able to adjust the position of
35082535d602Swdenk		the IMMR register after a reset.
3509c609719bSwdenk
3510e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_DEFAULT:
3511e46fedfeSTimur Tabi		Default (power-on reset) physical address of CCSR on Freescale
3512e46fedfeSTimur Tabi		PowerPC SOCs.
3513e46fedfeSTimur Tabi
3514e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR:
3515e46fedfeSTimur Tabi		Virtual address of CCSR.  On a 32-bit build, this is typically
3516e46fedfeSTimur Tabi		the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
3517e46fedfeSTimur Tabi
3518e46fedfeSTimur Tabi		CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
3519e46fedfeSTimur Tabi		for cross-platform code that uses that macro instead.
3520e46fedfeSTimur Tabi
3521e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS:
3522e46fedfeSTimur Tabi		Physical address of CCSR.  CCSR can be relocated to a new
3523e46fedfeSTimur Tabi		physical address, if desired.  In this case, this macro should
3524e46fedfeSTimur Tabi		be set to that address.	 Otherwise, it should be set to the
3525e46fedfeSTimur Tabi		same value as CONFIG_SYS_CCSRBAR_DEFAULT.  For example, CCSR
3526e46fedfeSTimur Tabi		is typically relocated on 36-bit builds.  It is recommended
3527e46fedfeSTimur Tabi		that this macro be defined via the _HIGH and _LOW macros:
3528e46fedfeSTimur Tabi
3529e46fedfeSTimur Tabi		#define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3530e46fedfeSTimur Tabi			* 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3531e46fedfeSTimur Tabi
3532e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
3533e46fedfeSTimur Tabi		Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS.	This value is typically
3534e46fedfeSTimur Tabi		either 0 (32-bit build) or 0xF (36-bit build).	This macro is
3535e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
3536e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
3537e46fedfeSTimur Tabi
3538e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_LOW:
3539e46fedfeSTimur Tabi		Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS.  This macro is
3540e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
3541e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
3542e46fedfeSTimur Tabi
3543e46fedfeSTimur Tabi- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
3544e46fedfeSTimur Tabi		If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
3545e46fedfeSTimur Tabi		forced to a value that ensures that CCSR is not relocated.
3546e46fedfeSTimur Tabi
35477f6c2cbcSwdenk- Floppy Disk Support:
35486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER
35497f6c2cbcSwdenk
35507f6c2cbcSwdenk		the default drive number (default value 0)
35517f6c2cbcSwdenk
35526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_STRIDE
35537f6c2cbcSwdenk
355411ccc33fSMarcel Ziswiler		defines the spacing between FDC chipset registers
35557f6c2cbcSwdenk		(default value 1)
35567f6c2cbcSwdenk
35576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_OFFSET
35587f6c2cbcSwdenk
35597f6c2cbcSwdenk		defines the offset of register from address. It
35607f6c2cbcSwdenk		depends on which part of the data bus is connected to
356111ccc33fSMarcel Ziswiler		the FDC chipset. (default value 0)
35627f6c2cbcSwdenk
35636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
35646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
35657f6c2cbcSwdenk		default value.
35667f6c2cbcSwdenk
35676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		if CONFIG_SYS_FDC_HW_INIT is defined, then the function
35687f6c2cbcSwdenk		fdc_hw_init() is called at the beginning of the FDC
35697f6c2cbcSwdenk		setup. fdc_hw_init() must be provided by the board
35707f6c2cbcSwdenk		source code. It is used to make hardware dependant
35717f6c2cbcSwdenk		initializations.
35727f6c2cbcSwdenk
35730abddf82SMacpaul Lin- CONFIG_IDE_AHB:
35740abddf82SMacpaul Lin		Most IDE controllers were designed to be connected with PCI
35750abddf82SMacpaul Lin		interface. Only few of them were designed for AHB interface.
35760abddf82SMacpaul Lin		When software is doing ATA command and data transfer to
35770abddf82SMacpaul Lin		IDE devices through IDE-AHB controller, some additional
35780abddf82SMacpaul Lin		registers accessing to these kind of IDE-AHB controller
35790abddf82SMacpaul Lin		is requierd.
35800abddf82SMacpaul Lin
35816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR:	Physical address of the Internal Memory.
358225d6712aSwdenk		DO NOT CHANGE unless you know exactly what you're
358325d6712aSwdenk		doing! (11-4) [MPC8xx/82xx systems only]
3584c609719bSwdenk
35856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR:
3586c609719bSwdenk
35877152b1d0Swdenk		Start address of memory area that can be used for
3588c609719bSwdenk		initial data and stack; please note that this must be
3589c609719bSwdenk		writable memory that is working WITHOUT special
3590c609719bSwdenk		initialization, i. e. you CANNOT use normal RAM which
3591c609719bSwdenk		will become available only after programming the
3592c609719bSwdenk		memory controller and running certain initialization
3593c609719bSwdenk		sequences.
3594c609719bSwdenk
3595c609719bSwdenk		U-Boot uses the following memory types:
3596c609719bSwdenk		- MPC8xx and MPC8260: IMMR (internal memory of the CPU)
3597c609719bSwdenk		- MPC824X: data cache
3598c609719bSwdenk		- PPC4xx:  data cache
3599c609719bSwdenk
36006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET:
3601c609719bSwdenk
3602c609719bSwdenk		Offset of the initial data structure in the memory
36036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
36046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
3605c609719bSwdenk		data is located at the end of the available space
3606553f0982SWolfgang Denk		(sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
36076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
36086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
36096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET) downward.
3610c609719bSwdenk
3611c609719bSwdenk	Note:
3612c609719bSwdenk		On the MPC824X (or other systems that use the data
3613c609719bSwdenk		cache for initial memory) the address chosen for
36146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
3615c609719bSwdenk		point to an otherwise UNUSED address space between
3616c609719bSwdenk		the top of RAM and the start of the PCI space.
3617c609719bSwdenk
36186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR:	SIU Module Configuration (11-6)
3619c609719bSwdenk
36206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR:	System Protection Control (11-9)
3621c609719bSwdenk
36226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR:	Time Base Status and Control (11-26)
3623c609719bSwdenk
36246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR:	Periodic Interrupt Status and Control (11-31)
3625c609719bSwdenk
36266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR:	PLL, Low-Power, and Reset Control Register (15-30)
3627c609719bSwdenk
36286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR:	System Clock and reset Control Register (15-27)
3629c609719bSwdenk
36306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM:
3631c609719bSwdenk		SDRAM timing
3632c609719bSwdenk
36336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA:
3634c609719bSwdenk		periodic timer for refresh
3635c609719bSwdenk
36366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER:	Debug Event Register (37-47)
3637c609719bSwdenk
36386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
36396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
36406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
36416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_BR1_PRELIM:
3642c609719bSwdenk		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
3643c609719bSwdenk
3644c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
36456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
36466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
3647c609719bSwdenk		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
3648c609719bSwdenk
36496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
36506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
3651c609719bSwdenk		Machine Mode Register and Memory Periodic Timer
3652c609719bSwdenk		Prescaler definitions (SDRAM timing)
3653c609719bSwdenk
36546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
3655c609719bSwdenk		enable I2C microcode relocation patch (MPC8xx);
3656c609719bSwdenk		define relocation offset in DPRAM [DSP2]
3657c609719bSwdenk
36586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
3659b423d055SHeiko Schocher		enable SMC microcode relocation patch (MPC8xx);
3660b423d055SHeiko Schocher		define relocation offset in DPRAM [SMC1]
3661b423d055SHeiko Schocher
36626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
3663c609719bSwdenk		enable SPI microcode relocation patch (MPC8xx);
3664c609719bSwdenk		define relocation offset in DPRAM [SCC4]
3665c609719bSwdenk
36666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_USE_OSCCLK:
3667c609719bSwdenk		Use OSCM clock mode on MBX8xx board. Be careful,
3668c609719bSwdenk		wrong setting might damage your board. Read
3669c609719bSwdenk		doc/README.MBX before setting this variable!
3670c609719bSwdenk
36716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
3672ea909b76Swdenk		Offset of the bootmode word in DPRAM used by post
3673ea909b76Swdenk		(Power On Self Tests). This definition overrides
3674ea909b76Swdenk		#define'd default value in commproc.h resp.
3675ea909b76Swdenk		cpm_8260.h.
3676ea909b76Swdenk
36776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
36786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
36796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
36806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
36816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
36826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
36836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
36846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
3685a47a12beSStefan Roese		Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
36865d232d0eSwdenk
36879cacf4fcSDirk Eibach- CONFIG_PCI_DISABLE_PCIE:
36889cacf4fcSDirk Eibach		Disable PCI-Express on systems where it is supported but not
36899cacf4fcSDirk Eibach		required.
36909cacf4fcSDirk Eibach
369169fd2d3bSAndrew Sharp- CONFIG_PCI_ENUM_ONLY
369269fd2d3bSAndrew Sharp		Only scan through and get the devices on the busses.
369369fd2d3bSAndrew Sharp		Don't do any setup work, presumably because someone or
369469fd2d3bSAndrew Sharp		something has already done it, and we don't need to do it
369569fd2d3bSAndrew Sharp		a second time.	Useful for platforms that are pre-booted
369669fd2d3bSAndrew Sharp		by coreboot or similar.
369769fd2d3bSAndrew Sharp
3698a09b9b68SKumar Gala- CONFIG_SYS_SRIO:
3699a09b9b68SKumar Gala		Chip has SRIO or not
3700a09b9b68SKumar Gala
3701a09b9b68SKumar Gala- CONFIG_SRIO1:
3702a09b9b68SKumar Gala		Board has SRIO 1 port available
3703a09b9b68SKumar Gala
3704a09b9b68SKumar Gala- CONFIG_SRIO2:
3705a09b9b68SKumar Gala		Board has SRIO 2 port available
3706a09b9b68SKumar Gala
3707a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_VIRT:
3708a09b9b68SKumar Gala		Virtual Address of SRIO port 'n' memory region
3709a09b9b68SKumar Gala
3710a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_PHYS:
3711a09b9b68SKumar Gala		Physical Address of SRIO port 'n' memory region
3712a09b9b68SKumar Gala
3713a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_SIZE:
3714a09b9b68SKumar Gala		Size of SRIO port 'n' memory region
3715a09b9b68SKumar Gala
3716eced4626SAlex Waterman- CONFIG_SYS_NDFC_16
3717eced4626SAlex Waterman		Defined to tell the NDFC that the NAND chip is using a
3718eced4626SAlex Waterman		16 bit bus.
3719eced4626SAlex Waterman
3720eced4626SAlex Waterman- CONFIG_SYS_NDFC_EBC0_CFG
3721eced4626SAlex Waterman		Sets the EBC0_CFG register for the NDFC. If not defined
3722eced4626SAlex Waterman		a default value will be used.
3723eced4626SAlex Waterman
3724bb99ad6dSBen Warren- CONFIG_SPD_EEPROM
3725218ca724SWolfgang Denk		Get DDR timing information from an I2C EEPROM. Common
3726218ca724SWolfgang Denk		with pluggable memory modules such as SODIMMs
3727218ca724SWolfgang Denk
3728bb99ad6dSBen Warren  SPD_EEPROM_ADDRESS
3729bb99ad6dSBen Warren		I2C address of the SPD EEPROM
3730bb99ad6dSBen Warren
37316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM
3732218ca724SWolfgang Denk		If SPD EEPROM is on an I2C bus other than the first
3733218ca724SWolfgang Denk		one, specify here. Note that the value must resolve
3734218ca724SWolfgang Denk		to something your driver can deal with.
3735bb99ad6dSBen Warren
37361b3e3c4fSYork Sun- CONFIG_SYS_DDR_RAW_TIMING
37371b3e3c4fSYork Sun		Get DDR timing information from other than SPD. Common with
37381b3e3c4fSYork Sun		soldered DDR chips onboard without SPD. DDR raw timing
37391b3e3c4fSYork Sun		parameters are extracted from datasheet and hard-coded into
37401b3e3c4fSYork Sun		header files or board specific files.
37411b3e3c4fSYork Sun
37426f5e1dc5SYork Sun- CONFIG_FSL_DDR_INTERACTIVE
37436f5e1dc5SYork Sun		Enable interactive DDR debugging. See doc/README.fsl-ddr.
37446f5e1dc5SYork Sun
37456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0
3746218ca724SWolfgang Denk		Only for 83xx systems. If specified, then DDR should
3747218ca724SWolfgang Denk		be configured using CS0 and CS1 instead of CS2 and CS3.
37482ad6b513STimur Tabi
3749c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12]
3750c26e454dSwdenk		Define to enable FEC[12] on a 8xx series processor.
3751c26e454dSwdenk
3752c26e454dSwdenk- CONFIG_FEC[12]_PHY
3753c26e454dSwdenk		Define to the hardcoded PHY address which corresponds
37546e592385Swdenk		to the given FEC; i. e.
3755c26e454dSwdenk			#define CONFIG_FEC1_PHY 4
3756c26e454dSwdenk		means that the PHY with address 4 is connected to FEC1
3757c26e454dSwdenk
3758c26e454dSwdenk		When set to -1, means to probe for first available.
3759c26e454dSwdenk
3760c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR
3761c26e454dSwdenk		The PHY does not have a RXERR line (RMII only).
3762c26e454dSwdenk		(so program the FEC to ignore it).
3763c26e454dSwdenk
3764c26e454dSwdenk- CONFIG_RMII
3765c26e454dSwdenk		Enable RMII mode for all FECs.
3766c26e454dSwdenk		Note that this is a global option, we can't
3767c26e454dSwdenk		have one FEC in standard MII mode and another in RMII mode.
3768c26e454dSwdenk
37695cf91d6bSwdenk- CONFIG_CRC32_VERIFY
37705cf91d6bSwdenk		Add a verify option to the crc32 command.
37715cf91d6bSwdenk		The syntax is:
37725cf91d6bSwdenk
37735cf91d6bSwdenk		=> crc32 -v <address> <count> <crc32>
37745cf91d6bSwdenk
37755cf91d6bSwdenk		Where address/count indicate a memory area
37765cf91d6bSwdenk		and crc32 is the correct crc32 which the
37775cf91d6bSwdenk		area should have.
37785cf91d6bSwdenk
377956523f12Swdenk- CONFIG_LOOPW
378056523f12Swdenk		Add the "loopw" memory command. This only takes effect if
3781602ad3b3SJon Loeliger		the memory commands are activated globally (CONFIG_CMD_MEM).
378256523f12Swdenk
37837b466641Sstroese- CONFIG_MX_CYCLIC
37847b466641Sstroese		Add the "mdc" and "mwc" memory commands. These are cyclic
37857b466641Sstroese		"md/mw" commands.
37867b466641Sstroese		Examples:
37877b466641Sstroese
37887b466641Sstroese		=> mdc.b 10 4 500
37897b466641Sstroese		This command will print 4 bytes (10,11,12,13) each 500 ms.
37907b466641Sstroese
37917b466641Sstroese		=> mwc.l 100 12345678 10
37927b466641Sstroese		This command will write 12345678 to address 100 all 10 ms.
37937b466641Sstroese
37947b466641Sstroese		This only takes effect if the memory commands are activated
3795602ad3b3SJon Loeliger		globally (CONFIG_CMD_MEM).
37967b466641Sstroese
37978aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT
3798afc1ce82SMacpaul Lin		[ARM, NDS32, MIPS only] If this variable is defined, then certain
3799e03f3169SWolfgang Denk		low level initializations (like setting up the memory
3800e03f3169SWolfgang Denk		controller) are omitted and/or U-Boot does not
3801e03f3169SWolfgang Denk		relocate itself into RAM.
38028aa1a2d1Swdenk
3803e03f3169SWolfgang Denk		Normally this variable MUST NOT be defined. The only
3804e03f3169SWolfgang Denk		exception is when U-Boot is loaded (to RAM) by some
3805e03f3169SWolfgang Denk		other boot loader or by a debugger which performs
3806e03f3169SWolfgang Denk		these initializations itself.
38078aa1a2d1Swdenk
3808401bb30bSAneesh V- CONFIG_SPL_BUILD
3809df81238bSMagnus Lilja		Modifies the behaviour of start.S when compiling a loader
3810df81238bSMagnus Lilja		that is executed before the actual U-Boot. E.g. when
3811df81238bSMagnus Lilja		compiling a NAND SPL.
3812400558b5Swdenk
3813d8834a13SMatthias Weisser- CONFIG_USE_ARCH_MEMCPY
3814d8834a13SMatthias Weisser  CONFIG_USE_ARCH_MEMSET
3815d8834a13SMatthias Weisser		If these options are used a optimized version of memcpy/memset will
3816d8834a13SMatthias Weisser		be used if available. These functions may be faster under some
3817d8834a13SMatthias Weisser		conditions but may increase the binary size.
3818d8834a13SMatthias Weisser
3819*588a13f7SSimon Glass- CONFIG_X86_RESET_VECTOR
3820*588a13f7SSimon Glass		If defined, the x86 reset vector code is included. This is not
3821*588a13f7SSimon Glass		needed when U-Boot is running from Coreboot.
3822b16f521aSGabe Black
38235b5ece9eSGabe Black- CONFIG_X86_NO_REAL_MODE
38245b5ece9eSGabe Black		If defined, x86 real mode code is omitted. This assumes a
38255b5ece9eSGabe Black		32-bit environment where such code is not needed. You will
38265b5ece9eSGabe Black		need to do this when U-Boot is running from Coreboot.
38275b5ece9eSGabe Black
38285b5ece9eSGabe Black
3829f2717b47STimur TabiFreescale QE/FMAN Firmware Support:
3830f2717b47STimur Tabi-----------------------------------
3831f2717b47STimur Tabi
3832f2717b47STimur TabiThe Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
3833f2717b47STimur Tabiloading of "firmware", which is encoded in the QE firmware binary format.
3834f2717b47STimur TabiThis firmware often needs to be loaded during U-Boot booting, so macros
3835f2717b47STimur Tabiare used to identify the storage device (NOR flash, SPI, etc) and the address
3836f2717b47STimur Tabiwithin that device.
3837f2717b47STimur Tabi
3838f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_ADDR
3839f2717b47STimur Tabi	The address in the storage device where the firmware is located.  The
3840f2717b47STimur Tabi	meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
3841f2717b47STimur Tabi	is also specified.
3842f2717b47STimur Tabi
3843f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_LENGTH
3844f2717b47STimur Tabi	The maximum possible size of the firmware.  The firmware binary format
3845f2717b47STimur Tabi	has a field that specifies the actual size of the firmware, but it
3846f2717b47STimur Tabi	might not be possible to read any part of the firmware unless some
3847f2717b47STimur Tabi	local storage is allocated to hold the entire firmware first.
3848f2717b47STimur Tabi
3849f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NOR
3850f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NOR flash, mapped as
3851f2717b47STimur Tabi	normal addressable memory via the LBC.  CONFIG_SYS_FMAN_FW_ADDR is the
3852f2717b47STimur Tabi	virtual address in NOR flash.
3853f2717b47STimur Tabi
3854f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NAND
3855f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NAND flash.
3856f2717b47STimur Tabi	CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
3857f2717b47STimur Tabi
3858f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_MMC
3859f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SD/MMC
3860f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3861f2717b47STimur Tabi
3862f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
3863f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SPI
3864f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3865f2717b47STimur Tabi
3866292dc6c5SLiu Gang- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
3867292dc6c5SLiu Gang	Specifies that QE/FMAN firmware is located in the remote (master)
3868292dc6c5SLiu Gang	memory space.	CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
3869fc54c7faSLiu Gang	can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
3870fc54c7faSLiu Gang	window->master inbound window->master LAW->the ucode address in
3871fc54c7faSLiu Gang	master's memory space.
3872f2717b47STimur Tabi
3873c609719bSwdenkBuilding the Software:
3874c609719bSwdenk======================
3875c609719bSwdenk
3876218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments
3877218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support
3878218ca724SWolfgang Denkall possibly existing versions of cross development tools in all
3879218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we
3880218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
3881218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot.
3882c609719bSwdenk
3883218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you
3884218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case,
3885218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell.
3886218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are
3887218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter:
3888c609719bSwdenk
3889218ca724SWolfgang Denk	$ CROSS_COMPILE=ppc_4xx-
3890218ca724SWolfgang Denk	$ export CROSS_COMPILE
3891c609719bSwdenk
38922f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in
38932f8d396bSPeter Tyser      the tools directory you can use the MinGW toolchain
38942f8d396bSPeter Tyser      (http://www.mingw.org).  Set your HOST tools to the MinGW
38952f8d396bSPeter Tyser      toolchain and execute 'make tools'.  For example:
38962f8d396bSPeter Tyser
38972f8d396bSPeter Tyser       $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
38982f8d396bSPeter Tyser
38992f8d396bSPeter Tyser      Binaries such as tools/mkimage.exe will be created which can
39002f8d396bSPeter Tyser      be executed on computers running Windows.
39012f8d396bSPeter Tyser
3902c609719bSwdenkU-Boot is intended to be simple to build. After installing the
3903c609719bSwdenksources you must configure U-Boot for one specific board type. This
3904c609719bSwdenkis done by typing:
3905c609719bSwdenk
3906c609719bSwdenk	make NAME_config
3907c609719bSwdenk
3908218ca724SWolfgang Denkwhere "NAME_config" is the name of one of the existing configu-
39094d675ae6SMichael Jonesrations; see boards.cfg for supported names.
391054387ac9Swdenk
3911c609719bSwdenkNote: for some board special configuration names may exist; check if
3912c609719bSwdenk      additional information is available from the board vendor; for
39132729af9dSwdenk      instance, the TQM823L systems are available without (standard)
39142729af9dSwdenk      or with LCD support. You can select such additional "features"
391511ccc33fSMarcel Ziswiler      when choosing the configuration, i. e.
3916c609719bSwdenk
39172729af9dSwdenk      make TQM823L_config
39182729af9dSwdenk	- will configure for a plain TQM823L, i. e. no LCD support
3919c609719bSwdenk
3920c609719bSwdenk      make TQM823L_LCD_config
3921c609719bSwdenk	- will configure for a TQM823L with U-Boot console on LCD
3922c609719bSwdenk
3923c609719bSwdenk      etc.
3924c609719bSwdenk
3925c609719bSwdenk
3926c609719bSwdenkFinally, type "make all", and you should get some working U-Boot
39277152b1d0Swdenkimages ready for download to / installation on your system:
3928c609719bSwdenk
3929c609719bSwdenk- "u-boot.bin" is a raw binary image
3930c609719bSwdenk- "u-boot" is an image in ELF binary format
3931c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format
3932c609719bSwdenk
3933baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved
3934baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change
3935baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory:
3936baf31249SMarian Balakowicz
3937baf31249SMarian Balakowicz1. Add O= to the make command line invocations:
3938baf31249SMarian Balakowicz
3939baf31249SMarian Balakowicz	make O=/tmp/build distclean
3940baf31249SMarian Balakowicz	make O=/tmp/build NAME_config
3941baf31249SMarian Balakowicz	make O=/tmp/build all
3942baf31249SMarian Balakowicz
3943baf31249SMarian Balakowicz2. Set environment variable BUILD_DIR to point to the desired location:
3944baf31249SMarian Balakowicz
3945baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
3946baf31249SMarian Balakowicz	make distclean
3947baf31249SMarian Balakowicz	make NAME_config
3948baf31249SMarian Balakowicz	make all
3949baf31249SMarian Balakowicz
3950baf31249SMarian BalakowiczNote that the command line "O=" setting overrides the BUILD_DIR environment
3951baf31249SMarian Balakowiczvariable.
3952baf31249SMarian Balakowicz
3953c609719bSwdenk
3954c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so
3955c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of
3956c609719bSwdenknative "make".
3957c609719bSwdenk
3958c609719bSwdenk
3959c609719bSwdenkIf the system board that you have is not listed, then you will need
3960c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these
3961c609719bSwdenksteps:
3962c609719bSwdenk
3963c609719bSwdenk1.  Add a new configuration option for your board to the toplevel
39644d675ae6SMichael Jones    "boards.cfg" file, using the existing entries as examples.
39654d675ae6SMichael Jones    Follow the instructions there to keep the boards in order.
3966c609719bSwdenk2.  Create a new directory to hold your board specific code. Add any
396785ec0bccSwdenk    files you need. In your board directory, you will need at least
396885ec0bccSwdenk    the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
396985ec0bccSwdenk3.  Create a new configuration file "include/configs/<board>.h" for
397085ec0bccSwdenk    your board
3971c609719bSwdenk3.  If you're porting U-Boot to a new CPU, then also create a new
3972c609719bSwdenk    directory to hold your CPU specific code. Add any files you need.
397385ec0bccSwdenk4.  Run "make <board>_config" with your new name.
3974c609719bSwdenk5.  Type "make", and you should get a working "u-boot.srec" file
3975c609719bSwdenk    to be installed on your target system.
397685ec0bccSwdenk6.  Debug and solve any problems that might arise.
3977c609719bSwdenk    [Of course, this last step is much harder than it sounds.]
3978c609719bSwdenk
3979c609719bSwdenk
3980c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.:
3981c609719bSwdenk==============================================================
3982c609719bSwdenk
3983c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board
3984c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to
3985c609719bSwdenkprovide feedback to the other developers. The feedback normally takes
3986c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest
3987218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources.
3988c609719bSwdenk
3989c609719bSwdenkBut before you submit such a patch, please verify that your modifi-
3990c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of
3991c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so,
3992c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot
3993c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You can
39947152b1d0Swdenkselect which (cross) compiler to use by passing a `CROSS_COMPILE'
3995218ca724SWolfgang Denkenvironment variable to the script, i. e. to use the ELDK cross tools
3996218ca724SWolfgang Denkyou can type
3997c609719bSwdenk
3998c609719bSwdenk	CROSS_COMPILE=ppc_8xx- MAKEALL
3999c609719bSwdenk
4000c609719bSwdenkor to build on a native PowerPC system you can type
4001c609719bSwdenk
4002c609719bSwdenk	CROSS_COMPILE=' ' MAKEALL
4003c609719bSwdenk
4004218ca724SWolfgang DenkWhen using the MAKEALL script, the default behaviour is to build
4005218ca724SWolfgang DenkU-Boot in the source directory. This location can be changed by
4006218ca724SWolfgang Denksetting the BUILD_DIR environment variable. Also, for each target
4007218ca724SWolfgang Denkbuilt, the MAKEALL script saves two log files (<target>.ERR and
4008218ca724SWolfgang Denk<target>.MAKEALL) in the <source dir>/LOG directory. This default
4009218ca724SWolfgang Denklocation can be changed by setting the MAKEALL_LOGDIR environment
4010218ca724SWolfgang Denkvariable. For example:
4011baf31249SMarian Balakowicz
4012baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
4013baf31249SMarian Balakowicz	export MAKEALL_LOGDIR=/tmp/log
4014baf31249SMarian Balakowicz	CROSS_COMPILE=ppc_8xx- MAKEALL
4015baf31249SMarian Balakowicz
4016218ca724SWolfgang DenkWith the above settings build objects are saved in the /tmp/build,
4017218ca724SWolfgang Denklog files are saved in the /tmp/log and the source tree remains clean
4018218ca724SWolfgang Denkduring the whole build process.
4019baf31249SMarian Balakowicz
4020baf31249SMarian Balakowicz
4021c609719bSwdenkSee also "U-Boot Porting Guide" below.
4022c609719bSwdenk
4023c609719bSwdenk
4024c609719bSwdenkMonitor Commands - Overview:
4025c609719bSwdenk============================
4026c609719bSwdenk
4027c609719bSwdenkgo	- start application at address 'addr'
4028c609719bSwdenkrun	- run commands in an environment variable
4029c609719bSwdenkbootm	- boot application image from memory
4030c609719bSwdenkbootp	- boot image via network using BootP/TFTP protocol
403144f074c7SMarek Vasutbootz   - boot zImage from memory
4032c609719bSwdenktftpboot- boot image via network using TFTP protocol
4033c609719bSwdenk	       and env variables "ipaddr" and "serverip"
4034c609719bSwdenk	       (and eventually "gatewayip")
40351fb7cd49SSimon Glasstftpput - upload a file via network using TFTP protocol
4036c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol
4037c609719bSwdenkdiskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
4038c609719bSwdenkloads	- load S-Record file over serial line
4039c609719bSwdenkloadb	- load binary file over serial line (kermit mode)
4040c609719bSwdenkmd	- memory display
4041c609719bSwdenkmm	- memory modify (auto-incrementing)
4042c609719bSwdenknm	- memory modify (constant address)
4043c609719bSwdenkmw	- memory write (fill)
4044c609719bSwdenkcp	- memory copy
4045c609719bSwdenkcmp	- memory compare
4046c609719bSwdenkcrc32	- checksum calculation
40470f89c54bSPeter Tyseri2c	- I2C sub-system
4048c609719bSwdenksspi	- SPI utility commands
4049c609719bSwdenkbase	- print or set address offset
4050c609719bSwdenkprintenv- print environment variables
4051c609719bSwdenksetenv	- set environment variables
4052c609719bSwdenksaveenv - save environment variables to persistent storage
4053c609719bSwdenkprotect - enable or disable FLASH write protection
4054c609719bSwdenkerase	- erase FLASH memory
4055c609719bSwdenkflinfo	- print FLASH memory information
405610635afaSKarl O. Pincnand	- NAND memory operations (see doc/README.nand)
4057c609719bSwdenkbdinfo	- print Board Info structure
4058c609719bSwdenkiminfo	- print header information for application image
4059c609719bSwdenkconinfo - print console devices and informations
4060c609719bSwdenkide	- IDE sub-system
4061c609719bSwdenkloop	- infinite loop on address range
406256523f12Swdenkloopw	- infinite write loop on address range
4063c609719bSwdenkmtest	- simple RAM test
4064c609719bSwdenkicache	- enable or disable instruction cache
4065c609719bSwdenkdcache	- enable or disable data cache
4066c609719bSwdenkreset	- Perform RESET of the CPU
4067c609719bSwdenkecho	- echo args to console
4068c609719bSwdenkversion - print monitor version
4069c609719bSwdenkhelp	- print online help
4070c609719bSwdenk?	- alias for 'help'
4071c609719bSwdenk
4072c609719bSwdenk
4073c609719bSwdenkMonitor Commands - Detailed Description:
4074c609719bSwdenk========================================
4075c609719bSwdenk
4076c609719bSwdenkTODO.
4077c609719bSwdenk
4078c609719bSwdenkFor now: just type "help <command>".
4079c609719bSwdenk
4080c609719bSwdenk
4081c609719bSwdenkEnvironment Variables:
4082c609719bSwdenk======================
4083c609719bSwdenk
4084c609719bSwdenkU-Boot supports user configuration using Environment Variables which
4085c609719bSwdenkcan be made persistent by saving to Flash memory.
4086c609719bSwdenk
4087c609719bSwdenkEnvironment Variables are set using "setenv", printed using
4088c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv"
4089c609719bSwdenkwithout a value can be used to delete a variable from the
4090c609719bSwdenkenvironment. As long as you don't save the environment you are
4091c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the
4092c609719bSwdenkenvironment is erased by accident, a default environment is provided.
4093c609719bSwdenk
4094c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables.
4095c96f86eeSWolfgang Denk
4096c96f86eeSWolfgang DenkList of environment variables (most likely not complete):
4097c609719bSwdenk
4098c609719bSwdenk  baudrate	- see CONFIG_BAUDRATE
4099c609719bSwdenk
4100c609719bSwdenk  bootdelay	- see CONFIG_BOOTDELAY
4101c609719bSwdenk
4102c609719bSwdenk  bootcmd	- see CONFIG_BOOTCOMMAND
4103c609719bSwdenk
4104c609719bSwdenk  bootargs	- Boot arguments when booting an RTOS image
4105c609719bSwdenk
4106c609719bSwdenk  bootfile	- Name of the image to load with TFTP
4107c609719bSwdenk
41087d721e34SBartlomiej Sieka  bootm_low	- Memory range available for image processing in the bootm
41097d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
41107d721e34SBartlomiej Sieka		  a hexadecimal number and defines lowest address allowed
41117d721e34SBartlomiej Sieka		  for use by the bootm command. See also "bootm_size"
41127d721e34SBartlomiej Sieka		  environment variable. Address defined by "bootm_low" is
41137d721e34SBartlomiej Sieka		  also the base of the initial memory mapping for the Linux
4114c3624e6eSGrant Likely		  kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4115c3624e6eSGrant Likely		  bootm_mapsize.
4116c3624e6eSGrant Likely
4117c3624e6eSGrant Likely  bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
4118c3624e6eSGrant Likely		  This variable is given as a hexadecimal number and it
4119c3624e6eSGrant Likely		  defines the size of the memory region starting at base
4120c3624e6eSGrant Likely		  address bootm_low that is accessible by the Linux kernel
4121c3624e6eSGrant Likely		  during early boot.  If unset, CONFIG_SYS_BOOTMAPSZ is used
4122c3624e6eSGrant Likely		  as the default value if it is defined, and bootm_size is
4123c3624e6eSGrant Likely		  used otherwise.
41247d721e34SBartlomiej Sieka
41257d721e34SBartlomiej Sieka  bootm_size	- Memory range available for image processing in the bootm
41267d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
41277d721e34SBartlomiej Sieka		  a hexadecimal number and defines the size of the region
41287d721e34SBartlomiej Sieka		  allowed for use by the bootm command. See also "bootm_low"
41297d721e34SBartlomiej Sieka		  environment variable.
41307d721e34SBartlomiej Sieka
41314bae9090SBartlomiej Sieka  updatefile	- Location of the software update file on a TFTP server, used
41324bae9090SBartlomiej Sieka		  by the automatic software update feature. Please refer to
41334bae9090SBartlomiej Sieka		  documentation in doc/README.update for more details.
41344bae9090SBartlomiej Sieka
4135c609719bSwdenk  autoload	- if set to "no" (any string beginning with 'n'),
4136c609719bSwdenk		  "bootp" will just load perform a lookup of the
4137c609719bSwdenk		  configuration from the BOOTP server, but not try to
4138c609719bSwdenk		  load any image using TFTP
4139c609719bSwdenk
4140c609719bSwdenk  autostart	- if set to "yes", an image loaded using the "bootp",
4141c609719bSwdenk		  "rarpboot", "tftpboot" or "diskboot" commands will
4142c609719bSwdenk		  be automatically started (by internally calling
4143c609719bSwdenk		  "bootm")
4144c609719bSwdenk
41454a6fd34bSwdenk		  If set to "no", a standalone image passed to the
41464a6fd34bSwdenk		  "bootm" command will be copied to the load address
41474a6fd34bSwdenk		  (and eventually uncompressed), but NOT be started.
41484a6fd34bSwdenk		  This can be used to load and uncompress arbitrary
41494a6fd34bSwdenk		  data.
41504a6fd34bSwdenk
4151a28afca5SDavid A. Long  fdt_high	- if set this restricts the maximum address that the
4152a28afca5SDavid A. Long		  flattened device tree will be copied into upon boot.
4153fa34f6b2SShawn Guo		  For example, if you have a system with 1 GB memory
4154fa34f6b2SShawn Guo		  at physical address 0x10000000, while Linux kernel
4155fa34f6b2SShawn Guo		  only recognizes the first 704 MB as low memory, you
4156fa34f6b2SShawn Guo		  may need to set fdt_high as 0x3C000000 to have the
4157fa34f6b2SShawn Guo		  device tree blob be copied to the maximum address
4158fa34f6b2SShawn Guo		  of the 704 MB low memory, so that Linux kernel can
4159fa34f6b2SShawn Guo		  access it during the boot procedure.
4160fa34f6b2SShawn Guo
4161a28afca5SDavid A. Long		  If this is set to the special value 0xFFFFFFFF then
4162a28afca5SDavid A. Long		  the fdt will not be copied at all on boot.  For this
4163a28afca5SDavid A. Long		  to work it must reside in writable memory, have
4164a28afca5SDavid A. Long		  sufficient padding on the end of it for u-boot to
4165a28afca5SDavid A. Long		  add the information it needs into it, and the memory
4166a28afca5SDavid A. Long		  must be accessible by the kernel.
4167a28afca5SDavid A. Long
4168eea63e05SSimon Glass  fdtcontroladdr- if set this is the address of the control flattened
4169eea63e05SSimon Glass		  device tree used by U-Boot when CONFIG_OF_CONTROL is
4170eea63e05SSimon Glass		  defined.
4171eea63e05SSimon Glass
417217ea1177Swdenk  i2cfast	- (PPC405GP|PPC405EP only)
417317ea1177Swdenk		  if set to 'y' configures Linux I2C driver for fast
417417ea1177Swdenk		  mode (400kHZ). This environment variable is used in
417517ea1177Swdenk		  initialization code. So, for changes to be effective
417617ea1177Swdenk		  it must be saved and board must be reset.
417717ea1177Swdenk
4178c609719bSwdenk  initrd_high	- restrict positioning of initrd images:
4179c609719bSwdenk		  If this variable is not set, initrd images will be
4180c609719bSwdenk		  copied to the highest possible address in RAM; this
4181c609719bSwdenk		  is usually what you want since it allows for
4182c609719bSwdenk		  maximum initrd size. If for some reason you want to
4183c609719bSwdenk		  make sure that the initrd image is loaded below the
41846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		  CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
4185c609719bSwdenk		  variable to a value of "no" or "off" or "0".
4186c609719bSwdenk		  Alternatively, you can set it to a maximum upper
4187c609719bSwdenk		  address to use (U-Boot will still check that it
4188c609719bSwdenk		  does not overwrite the U-Boot stack and data).
4189c609719bSwdenk
4190c609719bSwdenk		  For instance, when you have a system with 16 MB
41917152b1d0Swdenk		  RAM, and want to reserve 4 MB from use by Linux,
4192c609719bSwdenk		  you can do this by adding "mem=12M" to the value of
4193c609719bSwdenk		  the "bootargs" variable. However, now you must make
41947152b1d0Swdenk		  sure that the initrd image is placed in the first
4195c609719bSwdenk		  12 MB as well - this can be done with
4196c609719bSwdenk
4197c609719bSwdenk		  setenv initrd_high 00c00000
4198c609719bSwdenk
419938b99261Swdenk		  If you set initrd_high to 0xFFFFFFFF, this is an
420038b99261Swdenk		  indication to U-Boot that all addresses are legal
420138b99261Swdenk		  for the Linux kernel, including addresses in flash
420238b99261Swdenk		  memory. In this case U-Boot will NOT COPY the
420338b99261Swdenk		  ramdisk at all. This may be useful to reduce the
420438b99261Swdenk		  boot time on your system, but requires that this
420538b99261Swdenk		  feature is supported by your Linux kernel.
420638b99261Swdenk
4207c609719bSwdenk  ipaddr	- IP address; needed for tftpboot command
4208c609719bSwdenk
4209c609719bSwdenk  loadaddr	- Default load address for commands like "bootp",
4210dc7c9a1aSwdenk		  "rarpboot", "tftpboot", "loadb" or "diskboot"
4211c609719bSwdenk
4212c609719bSwdenk  loads_echo	- see CONFIG_LOADS_ECHO
4213c609719bSwdenk
4214c609719bSwdenk  serverip	- TFTP server IP address; needed for tftpboot command
4215c609719bSwdenk
4216c609719bSwdenk  bootretry	- see CONFIG_BOOT_RETRY_TIME
4217c609719bSwdenk
4218c609719bSwdenk  bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
4219c609719bSwdenk
4220c609719bSwdenk  bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
4221c609719bSwdenk
4222e2a53458SMike Frysinger  ethprime	- controls which interface is used first.
4223a3d991bdSwdenk
4224e2a53458SMike Frysinger  ethact	- controls which interface is currently active.
4225e2a53458SMike Frysinger		  For example you can do the following
4226a3d991bdSwdenk
422748690d80SHeiko Schocher		  => setenv ethact FEC
422848690d80SHeiko Schocher		  => ping 192.168.0.1 # traffic sent on FEC
422948690d80SHeiko Schocher		  => setenv ethact SCC
423048690d80SHeiko Schocher		  => ping 10.0.0.1 # traffic sent on SCC
4231a3d991bdSwdenk
4232e1692577SMatthias Fuchs  ethrotate	- When set to "no" U-Boot does not go through all
4233e1692577SMatthias Fuchs		  available network interfaces.
4234e1692577SMatthias Fuchs		  It just stays at the currently selected interface.
4235e1692577SMatthias Fuchs
4236a3d991bdSwdenk  netretry	- When set to "no" each network operation will
4237a3d991bdSwdenk		  either succeed or fail without retrying.
42386e592385Swdenk		  When set to "once" the network operation will
42396e592385Swdenk		  fail when all the available network interfaces
42406e592385Swdenk		  are tried once without success.
4241a3d991bdSwdenk		  Useful on scripts which control the retry operation
4242a3d991bdSwdenk		  themselves.
4243a3d991bdSwdenk
4244b4e2f89dSJean-Christophe PLAGNIOL-VILLARD  npe_ucode	- set load address for the NPE microcode
4245a1cf027aSJean-Christophe PLAGNIOL-VILLARD
424628cb9375SWolfgang Denk  tftpsrcport	- If this is set, the value is used for TFTP's
4247ecb0ccd9SWolfgang Denk		  UDP source port.
4248ecb0ccd9SWolfgang Denk
424928cb9375SWolfgang Denk  tftpdstport	- If this is set, the value is used for TFTP's UDP
425028cb9375SWolfgang Denk		  destination port instead of the Well Know Port 69.
425128cb9375SWolfgang Denk
4252c96f86eeSWolfgang Denk  tftpblocksize - Block size to use for TFTP transfers; if not set,
4253c96f86eeSWolfgang Denk		  we use the TFTP server's default block size
4254c96f86eeSWolfgang Denk
4255c96f86eeSWolfgang Denk  tftptimeout	- Retransmission timeout for TFTP packets (in milli-
4256c96f86eeSWolfgang Denk		  seconds, minimum value is 1000 = 1 second). Defines
4257c96f86eeSWolfgang Denk		  when a packet is considered to be lost so it has to
4258c96f86eeSWolfgang Denk		  be retransmitted. The default is 5000 = 5 seconds.
4259c96f86eeSWolfgang Denk		  Lowering this value may make downloads succeed
4260c96f86eeSWolfgang Denk		  faster in networks with high packet loss rates or
4261c96f86eeSWolfgang Denk		  with unreliable TFTP servers.
4262c96f86eeSWolfgang Denk
4263a3d991bdSwdenk  vlan		- When set to a value < 4095 the traffic over
426411ccc33fSMarcel Ziswiler		  Ethernet is encapsulated/received over 802.1q
4265a3d991bdSwdenk		  VLAN tagged frames.
4266c609719bSwdenk
4267dc0b7b0eSJason HobbsThe following image location variables contain the location of images
4268dc0b7b0eSJason Hobbsused in booting. The "Image" column gives the role of the image and is
4269dc0b7b0eSJason Hobbsnot an environment variable name. The other columns are environment
4270dc0b7b0eSJason Hobbsvariable names. "File Name" gives the name of the file on a TFTP
4271dc0b7b0eSJason Hobbsserver, "RAM Address" gives the location in RAM the image will be
4272dc0b7b0eSJason Hobbsloaded to, and "Flash Location" gives the image's address in NOR
4273dc0b7b0eSJason Hobbsflash or offset in NAND flash.
4274dc0b7b0eSJason Hobbs
4275dc0b7b0eSJason Hobbs*Note* - these variables don't have to be defined for all boards, some
4276dc0b7b0eSJason Hobbsboards currenlty use other variables for these purposes, and some
4277dc0b7b0eSJason Hobbsboards use these variables for other purposes.
4278dc0b7b0eSJason Hobbs
4279dc0b7b0eSJason HobbsImage		    File Name	     RAM Address       Flash Location
4280dc0b7b0eSJason Hobbs-----		    ---------	     -----------       --------------
4281dc0b7b0eSJason Hobbsu-boot		    u-boot	     u-boot_addr_r     u-boot_addr
4282dc0b7b0eSJason HobbsLinux kernel	    bootfile	     kernel_addr_r     kernel_addr
4283dc0b7b0eSJason Hobbsdevice tree blob    fdtfile	     fdt_addr_r	       fdt_addr
4284dc0b7b0eSJason Hobbsramdisk		    ramdiskfile	     ramdisk_addr_r    ramdisk_addr
4285dc0b7b0eSJason Hobbs
4286c609719bSwdenkThe following environment variables may be used and automatically
4287c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"),
4288c609719bSwdenkdepending the information provided by your boot server:
4289c609719bSwdenk
4290c609719bSwdenk  bootfile	- see above
4291c609719bSwdenk  dnsip		- IP address of your Domain Name Server
4292fe389a82Sstroese  dnsip2	- IP address of your secondary Domain Name Server
4293c609719bSwdenk  gatewayip	- IP address of the Gateway (Router) to use
4294c609719bSwdenk  hostname	- Target hostname
4295c609719bSwdenk  ipaddr	- see above
4296c609719bSwdenk  netmask	- Subnet Mask
4297c609719bSwdenk  rootpath	- Pathname of the root filesystem on the NFS server
4298c609719bSwdenk  serverip	- see above
4299c609719bSwdenk
4300c609719bSwdenk
4301c609719bSwdenkThere are two special Environment Variables:
4302c609719bSwdenk
4303c609719bSwdenk  serial#	- contains hardware identification information such
4304c609719bSwdenk		  as type string and/or serial number
4305c609719bSwdenk  ethaddr	- Ethernet address
4306c609719bSwdenk
4307c609719bSwdenkThese variables can be set only once (usually during manufacturing of
4308c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables
4309c609719bSwdenkonce they have been set once.
4310c609719bSwdenk
4311c609719bSwdenk
4312c1551ea8SstroeseFurther special Environment Variables:
4313c1551ea8Sstroese
4314c1551ea8Sstroese  ver		- Contains the U-Boot version string as printed
4315c1551ea8Sstroese		  with the "version" command. This variable is
4316c1551ea8Sstroese		  readonly (see CONFIG_VERSION_VARIABLE).
4317c1551ea8Sstroese
4318c1551ea8Sstroese
4319c609719bSwdenkPlease note that changes to some configuration parameters may take
4320c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-).
4321c609719bSwdenk
4322c609719bSwdenk
4323170ab110SJoe HershbergerCallback functions for environment variables:
4324170ab110SJoe Hershberger---------------------------------------------
4325170ab110SJoe Hershberger
4326170ab110SJoe HershbergerFor some environment variables, the behavior of u-boot needs to change
4327170ab110SJoe Hershbergerwhen their values are changed.  This functionailty allows functions to
4328170ab110SJoe Hershbergerbe associated with arbitrary variables.  On creation, overwrite, or
4329170ab110SJoe Hershbergerdeletion, the callback will provide the opportunity for some side
4330170ab110SJoe Hershbergereffect to happen or for the change to be rejected.
4331170ab110SJoe Hershberger
4332170ab110SJoe HershbergerThe callbacks are named and associated with a function using the
4333170ab110SJoe HershbergerU_BOOT_ENV_CALLBACK macro in your board or driver code.
4334170ab110SJoe Hershberger
4335170ab110SJoe HershbergerThese callbacks are associated with variables in one of two ways.  The
4336170ab110SJoe Hershbergerstatic list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
4337170ab110SJoe Hershbergerin the board configuration to a string that defines a list of
4338170ab110SJoe Hershbergerassociations.  The list must be in the following format:
4339170ab110SJoe Hershberger
4340170ab110SJoe Hershberger	entry = variable_name[:callback_name]
4341170ab110SJoe Hershberger	list = entry[,list]
4342170ab110SJoe Hershberger
4343170ab110SJoe HershbergerIf the callback name is not specified, then the callback is deleted.
4344170ab110SJoe HershbergerSpaces are also allowed anywhere in the list.
4345170ab110SJoe Hershberger
4346170ab110SJoe HershbergerCallbacks can also be associated by defining the ".callbacks" variable
4347170ab110SJoe Hershbergerwith the same list format above.  Any association in ".callbacks" will
4348170ab110SJoe Hershbergeroverride any association in the static list. You can define
4349170ab110SJoe HershbergerCONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
4350170ab110SJoe Hershberger".callbacks" envirnoment variable in the default or embedded environment.
4351170ab110SJoe Hershberger
4352170ab110SJoe Hershberger
4353f07771ccSwdenkCommand Line Parsing:
4354f07771ccSwdenk=====================
4355f07771ccSwdenk
4356f07771ccSwdenkThere are two different command line parsers available with U-Boot:
43577152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell:
4358f07771ccSwdenk
4359f07771ccSwdenkOld, simple command line parser:
4360f07771ccSwdenk--------------------------------
4361f07771ccSwdenk
4362f07771ccSwdenk- supports environment variables (through setenv / saveenv commands)
4363f07771ccSwdenk- several commands on one line, separated by ';'
4364fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax
4365f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\',
4366f07771ccSwdenk  for example:
4367fe126d8bSWolfgang Denk	setenv bootcmd bootm \${address}
4368f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example:
4369f07771ccSwdenk	setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
4370f07771ccSwdenk
4371f07771ccSwdenkHush shell:
4372f07771ccSwdenk-----------
4373f07771ccSwdenk
4374f07771ccSwdenk- similar to Bourne shell, with control structures like
4375f07771ccSwdenk  if...then...else...fi, for...do...done; while...do...done,
4376f07771ccSwdenk  until...do...done, ...
4377f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv
4378f07771ccSwdenk  commands) and local shell variables (through standard shell syntax
4379f07771ccSwdenk  "name=value"); only environment variables can be used with "run"
4380f07771ccSwdenk  command
4381f07771ccSwdenk
4382f07771ccSwdenkGeneral rules:
4383f07771ccSwdenk--------------
4384f07771ccSwdenk
4385f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run"
4386f07771ccSwdenk    command) contains several commands separated by semicolon, and
4387f07771ccSwdenk    one of these commands fails, then the remaining commands will be
4388f07771ccSwdenk    executed anyway.
4389f07771ccSwdenk
4390f07771ccSwdenk(2) If you execute several variables with one call to run (i. e.
439111ccc33fSMarcel Ziswiler    calling run with a list of variables as arguments), any failing
4392f07771ccSwdenk    command will cause "run" to terminate, i. e. the remaining
4393f07771ccSwdenk    variables are not executed.
4394f07771ccSwdenk
4395c609719bSwdenkNote for Redundant Ethernet Interfaces:
4396c609719bSwdenk=======================================
4397c609719bSwdenk
439811ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports
4399c609719bSwdenksuch configurations and is capable of automatic selection of a
44007152b1d0Swdenk"working" interface when needed. MAC assignment works as follows:
4401c609719bSwdenk
4402c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding
4403c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0),
4404c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ...
4405c609719bSwdenk
4406c609719bSwdenkIf the network interface stores some valid MAC address (for instance
4407c609719bSwdenkin SROM), this is used as default address if there is NO correspon-
4408c609719bSwdenkding setting in the environment; if the corresponding environment
4409c609719bSwdenkvariable is set, this overrides the settings in the card; that means:
4410c609719bSwdenk
4411c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the
4412c609719bSwdenk  environment, the SROM's address is used.
4413c609719bSwdenk
4414c609719bSwdenko If there is no valid address in the SROM, and a definition in the
4415c609719bSwdenk  environment exists, then the value from the environment variable is
4416c609719bSwdenk  used.
4417c609719bSwdenk
4418c609719bSwdenko If both the SROM and the environment contain a MAC address, and
4419c609719bSwdenk  both addresses are the same, this MAC address is used.
4420c609719bSwdenk
4421c609719bSwdenko If both the SROM and the environment contain a MAC address, and the
4422c609719bSwdenk  addresses differ, the value from the environment is used and a
4423c609719bSwdenk  warning is printed.
4424c609719bSwdenk
4425c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error
4426c609719bSwdenk  is raised.
4427c609719bSwdenk
4428ecee9324SBen WarrenIf Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
4429ecee9324SBen Warrenwill be programmed into hardware as part of the initialization process.	 This
4430ecee9324SBen Warrenmay be skipped by setting the appropriate 'ethmacskip' environment variable.
4431ecee9324SBen WarrenThe naming convention is as follows:
4432ecee9324SBen Warren"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
4433c609719bSwdenk
4434c609719bSwdenkImage Formats:
4435c609719bSwdenk==============
4436c609719bSwdenk
44373310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on)
44383310c549SMarian Balakowiczimages in two formats:
44393310c549SMarian Balakowicz
44403310c549SMarian BalakowiczNew uImage format (FIT)
44413310c549SMarian Balakowicz-----------------------
44423310c549SMarian Balakowicz
44433310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar
44443310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple
44453310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by
44463310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
44473310c549SMarian Balakowicz
44483310c549SMarian Balakowicz
44493310c549SMarian BalakowiczOld uImage format
44503310c549SMarian Balakowicz-----------------
44513310c549SMarian Balakowicz
44523310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything,
44533310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for
44543310c549SMarian Balakowiczdetails; basically, the header defines the following image properties:
4455c609719bSwdenk
4456c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
4457c609719bSwdenk  4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
4458f5ed9e39SPeter Tyser  LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
4459f5ed9e39SPeter Tyser  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
4460f5ed9e39SPeter Tyser  INTEGRITY).
44617b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
4462afc1ce82SMacpaul Lin  IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
4463afc1ce82SMacpaul Lin  Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
4464c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2)
4465c609719bSwdenk* Load Address
4466c609719bSwdenk* Entry Point
4467c609719bSwdenk* Image Name
4468c609719bSwdenk* Image Timestamp
4469c609719bSwdenk
4470c609719bSwdenkThe header is marked by a special Magic Number, and both the header
4471c609719bSwdenkand the data portions of the image are secured against corruption by
4472c609719bSwdenkCRC32 checksums.
4473c609719bSwdenk
4474c609719bSwdenk
4475c609719bSwdenkLinux Support:
4476c609719bSwdenk==============
4477c609719bSwdenk
4478c609719bSwdenkAlthough U-Boot should support any OS or standalone application
44797152b1d0Swdenkeasily, the main focus has always been on Linux during the design of
4480c609719bSwdenkU-Boot.
4481c609719bSwdenk
4482c609719bSwdenkU-Boot includes many features that so far have been part of some
4483c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any
4484c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image;
4485c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation
44867152b1d0Swdenkserves several purposes:
4487c609719bSwdenk
4488c609719bSwdenk- the same features can be used for other OS or standalone
4489c609719bSwdenk  applications (for instance: using compressed images to reduce the
4490c609719bSwdenk  Flash memory footprint)
4491c609719bSwdenk
4492c609719bSwdenk- it becomes much easier to port new Linux kernel versions because
44937152b1d0Swdenk  lots of low-level, hardware dependent stuff are done by U-Boot
4494c609719bSwdenk
4495c609719bSwdenk- the same Linux kernel image can now be used with different "initrd"
4496c609719bSwdenk  images; of course this also means that different kernel images can
4497c609719bSwdenk  be run with the same "initrd". This makes testing easier (you don't
4498c609719bSwdenk  have to build a new "zImage.initrd" Linux image when you just
4499c609719bSwdenk  change a file in your "initrd"). Also, a field-upgrade of the
4500c609719bSwdenk  software is easier now.
4501c609719bSwdenk
4502c609719bSwdenk
4503c609719bSwdenkLinux HOWTO:
4504c609719bSwdenk============
4505c609719bSwdenk
4506c609719bSwdenkPorting Linux to U-Boot based systems:
4507c609719bSwdenk---------------------------------------
4508c609719bSwdenk
4509c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to
4510c609719bSwdenkconfigure the Linux device drivers for use with your target hardware
4511c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to
4512c609719bSwdenkLinux :-).
4513c609719bSwdenk
4514a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
4515c609719bSwdenk
4516c609719bSwdenkJust make sure your machine specific header file (for instance
4517c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board
45181dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h,
45191dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value
45206d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR.
4521c609719bSwdenk
4522c609719bSwdenk
4523c609719bSwdenkConfiguring the Linux kernel:
4524c609719bSwdenk-----------------------------
4525c609719bSwdenk
4526c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root
4527c609719bSwdenkdevice (initial ramdisk, NFS) for your target system.
4528c609719bSwdenk
4529c609719bSwdenk
4530c609719bSwdenkBuilding a Linux Image:
4531c609719bSwdenk-----------------------
4532c609719bSwdenk
453324ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are
453424ee89b9Swdenknot used. If you use recent kernel source, a new build target
453524ee89b9Swdenk"uImage" will exist which automatically builds an image usable by
453624ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target,
453724ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a
453824ee89b9Swdenk100% compatible format.
4539c609719bSwdenk
4540c609719bSwdenkExample:
4541c609719bSwdenk
4542c609719bSwdenk	make TQM850L_config
4543c609719bSwdenk	make oldconfig
4544c609719bSwdenk	make dep
454524ee89b9Swdenk	make uImage
4546c609719bSwdenk
454724ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to
454824ee89b9Swdenkencapsulate a compressed Linux kernel image with header	 information,
454924ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing:
4550c609719bSwdenk
455124ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format):
455224ee89b9Swdenk
455324ee89b9Swdenk* convert the kernel into a raw binary image:
455424ee89b9Swdenk
455524ee89b9Swdenk	${CROSS_COMPILE}-objcopy -O binary \
455624ee89b9Swdenk				 -R .note -R .comment \
455724ee89b9Swdenk				 -S vmlinux linux.bin
455824ee89b9Swdenk
455924ee89b9Swdenk* compress the binary image:
456024ee89b9Swdenk
456124ee89b9Swdenk	gzip -9 linux.bin
456224ee89b9Swdenk
456324ee89b9Swdenk* package compressed binary image for U-Boot:
456424ee89b9Swdenk
456524ee89b9Swdenk	mkimage -A ppc -O linux -T kernel -C gzip \
456624ee89b9Swdenk		-a 0 -e 0 -n "Linux Kernel Image" \
456724ee89b9Swdenk		-d linux.bin.gz uImage
456824ee89b9Swdenk
456924ee89b9Swdenk
457024ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use
457124ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or
457224ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64
457324ee89b9Swdenkbyte header containing information about target architecture,
457424ee89b9Swdenkoperating system, image type, compression method, entry points, time
457524ee89b9Swdenkstamp, CRC32 checksums, etc.
457624ee89b9Swdenk
457724ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and
457824ee89b9Swdenkprint the header information, or to build new images.
4579c609719bSwdenk
4580c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information
4581c609719bSwdenkcontained in the header of an existing U-Boot image; this includes
4582c609719bSwdenkchecksum verification:
4583c609719bSwdenk
4584c609719bSwdenk	tools/mkimage -l image
4585c609719bSwdenk	  -l ==> list image header information
4586c609719bSwdenk
4587c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image
4588c609719bSwdenkfrom a "data file" which is used as image payload:
4589c609719bSwdenk
4590c609719bSwdenk	tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
4591c609719bSwdenk		      -n name -d data_file image
4592c609719bSwdenk	  -A ==> set architecture to 'arch'
4593c609719bSwdenk	  -O ==> set operating system to 'os'
4594c609719bSwdenk	  -T ==> set image type to 'type'
4595c609719bSwdenk	  -C ==> set compression type 'comp'
4596c609719bSwdenk	  -a ==> set load address to 'addr' (hex)
4597c609719bSwdenk	  -e ==> set entry point to 'ep' (hex)
4598c609719bSwdenk	  -n ==> set image name to 'name'
4599c609719bSwdenk	  -d ==> use image data from 'datafile'
4600c609719bSwdenk
460169459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load
460269459791Swdenkaddress (0x00000000), but the entry point address depends on the
460369459791Swdenkkernel version:
4604c609719bSwdenk
4605c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C,
460624ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000.
4607c609719bSwdenk
4608c609719bSwdenkSo a typical call to build a U-Boot image would read:
4609c609719bSwdenk
461024ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
461124ee89b9Swdenk	> -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
4612a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
461324ee89b9Swdenk	> examples/uImage.TQM850L
461424ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
4615c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
4616c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
4617c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
4618c609719bSwdenk	Load Address: 0x00000000
461924ee89b9Swdenk	Entry Point:  0x00000000
4620c609719bSwdenk
4621c609719bSwdenkTo verify the contents of the image (or check for corruption):
4622c609719bSwdenk
462324ee89b9Swdenk	-> tools/mkimage -l examples/uImage.TQM850L
462424ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
4625c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
4626c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
4627c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
4628c609719bSwdenk	Load Address: 0x00000000
462924ee89b9Swdenk	Entry Point:  0x00000000
4630c609719bSwdenk
4631c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade
4632c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this
4633c609719bSwdenkneeds more space in Flash, but boots much faster since it does not
4634c609719bSwdenkneed to be uncompressed:
4635c609719bSwdenk
4636a47a12beSStefan Roese	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
463724ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
463824ee89b9Swdenk	> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
4639a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
464024ee89b9Swdenk	> examples/uImage.TQM850L-uncompressed
464124ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
4642c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
4643c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (uncompressed)
4644c609719bSwdenk	Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
4645c609719bSwdenk	Load Address: 0x00000000
464624ee89b9Swdenk	Entry Point:  0x00000000
4647c609719bSwdenk
4648c609719bSwdenk
4649c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file
4650c609719bSwdenkwhen your kernel is intended to use an initial ramdisk:
4651c609719bSwdenk
4652c609719bSwdenk	-> tools/mkimage -n 'Simple Ramdisk Image' \
4653c609719bSwdenk	> -A ppc -O linux -T ramdisk -C gzip \
4654c609719bSwdenk	> -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
4655c609719bSwdenk	Image Name:   Simple Ramdisk Image
4656c609719bSwdenk	Created:      Wed Jan 12 14:01:50 2000
4657c609719bSwdenk	Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
4658c609719bSwdenk	Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
4659c609719bSwdenk	Load Address: 0x00000000
4660c609719bSwdenk	Entry Point:  0x00000000
4661c609719bSwdenk
4662c609719bSwdenk
4663c609719bSwdenkInstalling a Linux Image:
4664c609719bSwdenk-------------------------
4665c609719bSwdenk
4666c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface,
4667c609719bSwdenkyou must convert the image to S-Record format:
4668c609719bSwdenk
4669c609719bSwdenk	objcopy -I binary -O srec examples/image examples/image.srec
4670c609719bSwdenk
4671c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot
4672c609719bSwdenkimage header, so the resulting S-Record file will be relative to
4673c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to
4674c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads'
4675c609719bSwdenkcommand.
4676c609719bSwdenk
4677c609719bSwdenkExample: install the image to address 0x40100000 (which on the
4678c609719bSwdenkTQM8xxL is in the first Flash bank):
4679c609719bSwdenk
4680c609719bSwdenk	=> erase 40100000 401FFFFF
4681c609719bSwdenk
4682c609719bSwdenk	.......... done
4683c609719bSwdenk	Erased 8 sectors
4684c609719bSwdenk
4685c609719bSwdenk	=> loads 40100000
4686c609719bSwdenk	## Ready for S-Record download ...
4687c609719bSwdenk	~>examples/image.srec
4688c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 12 13 ...
4689c609719bSwdenk	...
4690c609719bSwdenk	15989 15990 15991 15992
4691c609719bSwdenk	[file transfer complete]
4692c609719bSwdenk	[connected]
4693c609719bSwdenk	## Start Addr = 0x00000000
4694c609719bSwdenk
4695c609719bSwdenk
4696c609719bSwdenkYou can check the success of the download using the 'iminfo' command;
4697c609719bSwdenkthis includes a checksum verification so you can be sure no data
4698c609719bSwdenkcorruption happened:
4699c609719bSwdenk
4700c609719bSwdenk	=> imi 40100000
4701c609719bSwdenk
4702c609719bSwdenk	## Checking Image at 40100000 ...
4703c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
4704c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
4705c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
4706c609719bSwdenk	   Load Address: 00000000
4707c609719bSwdenk	   Entry Point:	 0000000c
4708c609719bSwdenk	   Verifying Checksum ... OK
4709c609719bSwdenk
4710c609719bSwdenk
4711c609719bSwdenkBoot Linux:
4712c609719bSwdenk-----------
4713c609719bSwdenk
4714c609719bSwdenkThe "bootm" command is used to boot an application that is stored in
4715c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents
4716c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as
4717c609719bSwdenkparameters. You can check and modify this variable using the
4718c609719bSwdenk"printenv" and "setenv" commands:
4719c609719bSwdenk
4720c609719bSwdenk
4721c609719bSwdenk	=> printenv bootargs
4722c609719bSwdenk	bootargs=root=/dev/ram
4723c609719bSwdenk
4724c609719bSwdenk	=> setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4725c609719bSwdenk
4726c609719bSwdenk	=> printenv bootargs
4727c609719bSwdenk	bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4728c609719bSwdenk
4729c609719bSwdenk	=> bootm 40020000
4730c609719bSwdenk	## Booting Linux kernel at 40020000 ...
4731c609719bSwdenk	   Image Name:	 2.2.13 for NFS on TQM850L
4732c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
4733c609719bSwdenk	   Data Size:	 381681 Bytes = 372 kB = 0 MB
4734c609719bSwdenk	   Load Address: 00000000
4735c609719bSwdenk	   Entry Point:	 0000000c
4736c609719bSwdenk	   Verifying Checksum ... OK
4737c609719bSwdenk	   Uncompressing Kernel Image ... OK
4738c609719bSwdenk	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
4739c609719bSwdenk	Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4740c609719bSwdenk	time_init: decrementer frequency = 187500000/60
4741c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
4742c609719bSwdenk	Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
4743c609719bSwdenk	...
4744c609719bSwdenk
474511ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass
47467152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT
4747c609719bSwdenkformat!) to the "bootm" command:
4748c609719bSwdenk
4749c609719bSwdenk	=> imi 40100000 40200000
4750c609719bSwdenk
4751c609719bSwdenk	## Checking Image at 40100000 ...
4752c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
4753c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
4754c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
4755c609719bSwdenk	   Load Address: 00000000
4756c609719bSwdenk	   Entry Point:	 0000000c
4757c609719bSwdenk	   Verifying Checksum ... OK
4758c609719bSwdenk
4759c609719bSwdenk	## Checking Image at 40200000 ...
4760c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
4761c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
4762c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
4763c609719bSwdenk	   Load Address: 00000000
4764c609719bSwdenk	   Entry Point:	 00000000
4765c609719bSwdenk	   Verifying Checksum ... OK
4766c609719bSwdenk
4767c609719bSwdenk	=> bootm 40100000 40200000
4768c609719bSwdenk	## Booting Linux kernel at 40100000 ...
4769c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
4770c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
4771c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
4772c609719bSwdenk	   Load Address: 00000000
4773c609719bSwdenk	   Entry Point:	 0000000c
4774c609719bSwdenk	   Verifying Checksum ... OK
4775c609719bSwdenk	   Uncompressing Kernel Image ... OK
4776c609719bSwdenk	## Loading RAMDisk Image at 40200000 ...
4777c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
4778c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
4779c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
4780c609719bSwdenk	   Load Address: 00000000
4781c609719bSwdenk	   Entry Point:	 00000000
4782c609719bSwdenk	   Verifying Checksum ... OK
4783c609719bSwdenk	   Loading Ramdisk ... OK
4784c609719bSwdenk	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
4785c609719bSwdenk	Boot arguments: root=/dev/ram
4786c609719bSwdenk	time_init: decrementer frequency = 187500000/60
4787c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
4788c609719bSwdenk	...
4789c609719bSwdenk	RAMDISK: Compressed image found at block 0
4790c609719bSwdenk	VFS: Mounted root (ext2 filesystem).
4791c609719bSwdenk
4792c609719bSwdenk	bash#
4793c609719bSwdenk
47940267768eSMatthew McClintockBoot Linux and pass a flat device tree:
47950267768eSMatthew McClintock-----------
47960267768eSMatthew McClintock
47970267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section
47980267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The
47990267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated
48000267768eSMatthew McClintockflat device tree:
48010267768eSMatthew McClintock
48020267768eSMatthew McClintock=> print oftaddr
48030267768eSMatthew McClintockoftaddr=0x300000
48040267768eSMatthew McClintock=> print oft
48050267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb
48060267768eSMatthew McClintock=> tftp $oftaddr $oft
48070267768eSMatthew McClintockSpeed: 1000, full duplex
48080267768eSMatthew McClintockUsing TSEC0 device
48090267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101
48100267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'.
48110267768eSMatthew McClintockLoad address: 0x300000
48120267768eSMatthew McClintockLoading: #
48130267768eSMatthew McClintockdone
48140267768eSMatthew McClintockBytes transferred = 4106 (100a hex)
48150267768eSMatthew McClintock=> tftp $loadaddr $bootfile
48160267768eSMatthew McClintockSpeed: 1000, full duplex
48170267768eSMatthew McClintockUsing TSEC0 device
48180267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2
48190267768eSMatthew McClintockFilename 'uImage'.
48200267768eSMatthew McClintockLoad address: 0x200000
48210267768eSMatthew McClintockLoading:############
48220267768eSMatthew McClintockdone
48230267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex)
48240267768eSMatthew McClintock=> print loadaddr
48250267768eSMatthew McClintockloadaddr=200000
48260267768eSMatthew McClintock=> print oftaddr
48270267768eSMatthew McClintockoftaddr=0x300000
48280267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr
48290267768eSMatthew McClintock## Booting image at 00200000 ...
48300267768eSMatthew McClintock   Image Name:	 Linux-2.6.17-dirty
48310267768eSMatthew McClintock   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
48320267768eSMatthew McClintock   Data Size:	 1029343 Bytes = 1005.2 kB
48330267768eSMatthew McClintock   Load Address: 00000000
48340267768eSMatthew McClintock   Entry Point:	 00000000
48350267768eSMatthew McClintock   Verifying Checksum ... OK
48360267768eSMatthew McClintock   Uncompressing Kernel Image ... OK
48370267768eSMatthew McClintockBooting using flat device tree at 0x300000
48380267768eSMatthew McClintockUsing MPC85xx ADS machine description
48390267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
48400267768eSMatthew McClintock[snip]
48410267768eSMatthew McClintock
48420267768eSMatthew McClintock
48436069ff26SwdenkMore About U-Boot Image Types:
48446069ff26Swdenk------------------------------
48456069ff26Swdenk
48466069ff26SwdenkU-Boot supports the following image types:
48476069ff26Swdenk
48486069ff26Swdenk   "Standalone Programs" are directly runnable in the environment
48496069ff26Swdenk	provided by U-Boot; it is expected that (if they behave
48506069ff26Swdenk	well) you can continue to work in U-Boot after return from
48516069ff26Swdenk	the Standalone Program.
48526069ff26Swdenk   "OS Kernel Images" are usually images of some Embedded OS which
48536069ff26Swdenk	will take over control completely. Usually these programs
48546069ff26Swdenk	will install their own set of exception handlers, device
48556069ff26Swdenk	drivers, set up the MMU, etc. - this means, that you cannot
48566069ff26Swdenk	expect to re-enter U-Boot except by resetting the CPU.
48576069ff26Swdenk   "RAMDisk Images" are more or less just data blocks, and their
48586069ff26Swdenk	parameters (address, size) are passed to an OS kernel that is
48596069ff26Swdenk	being started.
48606069ff26Swdenk   "Multi-File Images" contain several images, typically an OS
48616069ff26Swdenk	(Linux) kernel image and one or more data images like
48626069ff26Swdenk	RAMDisks. This construct is useful for instance when you want
48636069ff26Swdenk	to boot over the network using BOOTP etc., where the boot
48646069ff26Swdenk	server provides just a single image file, but you want to get
48656069ff26Swdenk	for instance an OS kernel and a RAMDisk image.
48666069ff26Swdenk
48676069ff26Swdenk	"Multi-File Images" start with a list of image sizes, each
48686069ff26Swdenk	image size (in bytes) specified by an "uint32_t" in network
48696069ff26Swdenk	byte order. This list is terminated by an "(uint32_t)0".
48706069ff26Swdenk	Immediately after the terminating 0 follow the images, one by
48716069ff26Swdenk	one, all aligned on "uint32_t" boundaries (size rounded up to
48726069ff26Swdenk	a multiple of 4 bytes).
48736069ff26Swdenk
48746069ff26Swdenk   "Firmware Images" are binary images containing firmware (like
48756069ff26Swdenk	U-Boot or FPGA images) which usually will be programmed to
48766069ff26Swdenk	flash memory.
48776069ff26Swdenk
48786069ff26Swdenk   "Script files" are command sequences that will be executed by
48796069ff26Swdenk	U-Boot's command interpreter; this feature is especially
48806069ff26Swdenk	useful when you configure U-Boot to use a real shell (hush)
48816069ff26Swdenk	as command interpreter.
48826069ff26Swdenk
488344f074c7SMarek VasutBooting the Linux zImage:
488444f074c7SMarek Vasut-------------------------
488544f074c7SMarek Vasut
488644f074c7SMarek VasutOn some platforms, it's possible to boot Linux zImage. This is done
488744f074c7SMarek Vasutusing the "bootz" command. The syntax of "bootz" command is the same
488844f074c7SMarek Vasutas the syntax of "bootm" command.
488944f074c7SMarek Vasut
4890017e1f3fSMarek VasutNote, defining the CONFIG_SUPPORT_INITRD_RAW allows user to supply
4891017e1f3fSMarek Vasutkernel with raw initrd images. The syntax is slightly different, the
4892017e1f3fSMarek Vasutaddress of the initrd must be augmented by it's size, in the following
4893017e1f3fSMarek Vasutformat: "<initrd addres>:<initrd size>".
4894017e1f3fSMarek Vasut
4895c609719bSwdenk
4896c609719bSwdenkStandalone HOWTO:
4897c609719bSwdenk=================
4898c609719bSwdenk
4899c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and
4900c609719bSwdenkrun "standalone" applications, which can use some resources of
4901c609719bSwdenkU-Boot like console I/O functions or interrupt services.
4902c609719bSwdenk
4903c609719bSwdenkTwo simple examples are included with the sources:
4904c609719bSwdenk
4905c609719bSwdenk"Hello World" Demo:
4906c609719bSwdenk-------------------
4907c609719bSwdenk
4908c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo
4909c609719bSwdenkapplication; it is automatically compiled when you build U-Boot.
4910c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it
4911c609719bSwdenklike that:
4912c609719bSwdenk
4913c609719bSwdenk	=> loads
4914c609719bSwdenk	## Ready for S-Record download ...
4915c609719bSwdenk	~>examples/hello_world.srec
4916c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
4917c609719bSwdenk	[file transfer complete]
4918c609719bSwdenk	[connected]
4919c609719bSwdenk	## Start Addr = 0x00040004
4920c609719bSwdenk
4921c609719bSwdenk	=> go 40004 Hello World! This is a test.
4922c609719bSwdenk	## Starting application at 0x00040004 ...
4923c609719bSwdenk	Hello World
4924c609719bSwdenk	argc = 7
4925c609719bSwdenk	argv[0] = "40004"
4926c609719bSwdenk	argv[1] = "Hello"
4927c609719bSwdenk	argv[2] = "World!"
4928c609719bSwdenk	argv[3] = "This"
4929c609719bSwdenk	argv[4] = "is"
4930c609719bSwdenk	argv[5] = "a"
4931c609719bSwdenk	argv[6] = "test."
4932c609719bSwdenk	argv[7] = "<NULL>"
4933c609719bSwdenk	Hit any key to exit ...
4934c609719bSwdenk
4935c609719bSwdenk	## Application terminated, rc = 0x0
4936c609719bSwdenk
4937c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt
4938c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'.
4939c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second.
4940c609719bSwdenkThe interrupt service routine is trivial, just printing a '.'
4941c609719bSwdenkcharacter, but this is just a demo program. The application can be
4942c609719bSwdenkcontrolled by the following keys:
4943c609719bSwdenk
4944c609719bSwdenk	? - print current values og the CPM Timer registers
4945c609719bSwdenk	b - enable interrupts and start timer
4946c609719bSwdenk	e - stop timer and disable interrupts
4947c609719bSwdenk	q - quit application
4948c609719bSwdenk
4949c609719bSwdenk	=> loads
4950c609719bSwdenk	## Ready for S-Record download ...
4951c609719bSwdenk	~>examples/timer.srec
4952c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
4953c609719bSwdenk	[file transfer complete]
4954c609719bSwdenk	[connected]
4955c609719bSwdenk	## Start Addr = 0x00040004
4956c609719bSwdenk
4957c609719bSwdenk	=> go 40004
4958c609719bSwdenk	## Starting application at 0x00040004 ...
4959c609719bSwdenk	TIMERS=0xfff00980
4960c609719bSwdenk	Using timer 1
4961c609719bSwdenk	  tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
4962c609719bSwdenk
4963c609719bSwdenkHit 'b':
4964c609719bSwdenk	[q, b, e, ?] Set interval 1000000 us
4965c609719bSwdenk	Enabling timer
4966c609719bSwdenkHit '?':
4967c609719bSwdenk	[q, b, e, ?] ........
4968c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
4969c609719bSwdenkHit '?':
4970c609719bSwdenk	[q, b, e, ?] .
4971c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
4972c609719bSwdenkHit '?':
4973c609719bSwdenk	[q, b, e, ?] .
4974c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
4975c609719bSwdenkHit '?':
4976c609719bSwdenk	[q, b, e, ?] .
4977c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
4978c609719bSwdenkHit 'e':
4979c609719bSwdenk	[q, b, e, ?] ...Stopping timer
4980c609719bSwdenkHit 'q':
4981c609719bSwdenk	[q, b, e, ?] ## Application terminated, rc = 0x0
4982c609719bSwdenk
4983c609719bSwdenk
498485ec0bccSwdenkMinicom warning:
498585ec0bccSwdenk================
498685ec0bccSwdenk
49877152b1d0SwdenkOver time, many people have reported problems when trying to use the
498885ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd)
498985ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under
4990f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and
499185ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and
4992e53515a2SKarl O. Pincuse "cu" for S-Record download ("loads" command).  See
4993e53515a2SKarl O. Pinchttp://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
4994e53515a2SKarl O. Pincfor help with kermit.
4995e53515a2SKarl O. Pinc
499685ec0bccSwdenk
499752f52c14SwdenkNevertheless, if you absolutely want to use it try adding this
499852f52c14Swdenkconfiguration to your "File transfer protocols" section:
499952f52c14Swdenk
500052f52c14Swdenk	   Name	   Program			Name U/D FullScr IO-Red. Multi
500152f52c14Swdenk	X  kermit  /usr/bin/kermit -i -l %l -s	 Y    U	   Y	   N	  N
500252f52c14Swdenk	Y  kermit  /usr/bin/kermit -i -l %l -r	 N    D	   Y	   N	  N
500352f52c14Swdenk
500452f52c14Swdenk
5005c609719bSwdenkNetBSD Notes:
5006c609719bSwdenk=============
5007c609719bSwdenk
5008c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host
5009c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx).
5010c609719bSwdenk
5011c609719bSwdenkBuilding requires a cross environment; it is known to work on
5012c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5013c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make).
5014c609719bSwdenkNote that the cross-powerpc package does not install include files;
5015c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is
5016c609719bSwdenkmissing.  This file has to be installed and patched manually:
5017c609719bSwdenk
5018c609719bSwdenk	# cd /usr/pkg/cross/powerpc-netbsd/include
5019c609719bSwdenk	# mkdir powerpc
5020c609719bSwdenk	# ln -s powerpc machine
5021c609719bSwdenk	# cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
5022c609719bSwdenk	# ${EDIT} powerpc/ansi.h	## must remove __va_list, _BSD_VA_LIST
5023c609719bSwdenk
5024c609719bSwdenkNative builds *don't* work due to incompatibilities between native
5025c609719bSwdenkand U-Boot include files.
5026c609719bSwdenk
5027c609719bSwdenkBooting assumes that (the first part of) the image booted is a
5028c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel
5029c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source
5030c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
50312a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
5032c609719bSwdenk
5033c609719bSwdenk
5034c609719bSwdenkImplementation Internals:
5035c609719bSwdenk=========================
5036c609719bSwdenk
5037c609719bSwdenkThe following is not intended to be a complete description of every
5038c609719bSwdenkimplementation detail. However, it should help to understand the
5039c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom
5040c609719bSwdenkhardware.
5041c609719bSwdenk
5042c609719bSwdenk
5043c609719bSwdenkInitial Stack, Global Data:
5044c609719bSwdenk---------------------------
5045c609719bSwdenk
5046c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot
5047c609719bSwdenkstarts running out of ROM (flash memory), usually without access to
5048c609719bSwdenksystem RAM (because the memory controller is not initialized yet).
5049c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS
5050c609719bSwdenkis not initialized as zero. To be able to get a C environment working
5051c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation
5052c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU
5053c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and
5054c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be
5055c609719bSwdenklocked as (mis-) used as memory, etc.
5056c609719bSwdenk
50577152b1d0Swdenk	Chris Hallinan posted a good summary of these issues to the
50580668236bSWolfgang Denk	U-Boot mailing list:
505943d9616cSwdenk
506043d9616cSwdenk	Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
506143d9616cSwdenk	From: "Chris Hallinan" <clh@net1plus.com>
506243d9616cSwdenk	Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
506343d9616cSwdenk	...
506443d9616cSwdenk
506543d9616cSwdenk	Correct me if I'm wrong, folks, but the way I understand it
506643d9616cSwdenk	is this: Using DCACHE as initial RAM for Stack, etc, does not
506743d9616cSwdenk	require any physical RAM backing up the cache. The cleverness
506843d9616cSwdenk	is that the cache is being used as a temporary supply of
506943d9616cSwdenk	necessary storage before the SDRAM controller is setup. It's
507011ccc33fSMarcel Ziswiler	beyond the scope of this list to explain the details, but you
507143d9616cSwdenk	can see how this works by studying the cache architecture and
507243d9616cSwdenk	operation in the architecture and processor-specific manuals.
507343d9616cSwdenk
507443d9616cSwdenk	OCM is On Chip Memory, which I believe the 405GP has 4K. It
507543d9616cSwdenk	is another option for the system designer to use as an
507611ccc33fSMarcel Ziswiler	initial stack/RAM area prior to SDRAM being available. Either
507743d9616cSwdenk	option should work for you. Using CS 4 should be fine if your
507843d9616cSwdenk	board designers haven't used it for something that would
507943d9616cSwdenk	cause you grief during the initial boot! It is frequently not
508043d9616cSwdenk	used.
508143d9616cSwdenk
50826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
508343d9616cSwdenk	with your processor/board/system design. The default value
508443d9616cSwdenk	you will find in any recent u-boot distribution in
50858a316c9bSStefan Roese	walnut.h should work for you. I'd set it to a value larger
508643d9616cSwdenk	than your SDRAM module. If you have a 64MB SDRAM module, set
508743d9616cSwdenk	it above 400_0000. Just make sure your board has no resources
508843d9616cSwdenk	that are supposed to respond to that address! That code in
508943d9616cSwdenk	start.S has been around a while and should work as is when
509043d9616cSwdenk	you get the config right.
509143d9616cSwdenk
509243d9616cSwdenk	-Chris Hallinan
509343d9616cSwdenk	DS4.COM, Inc.
509443d9616cSwdenk
5095c609719bSwdenkIt is essential to remember this, since it has some impact on the C
5096c609719bSwdenkcode for the initialization procedures:
5097c609719bSwdenk
5098c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt
5099c609719bSwdenk  to write it.
5100c609719bSwdenk
510111ccc33fSMarcel Ziswiler* Do not use any uninitialized global data (or implicitely initialized
5102c609719bSwdenk  as zero data - BSS segment) at all - this is undefined, initiali-
51037152b1d0Swdenk  zation is performed later (when relocating to RAM).
5104c609719bSwdenk
5105c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like
5106c609719bSwdenk  that.
5107c609719bSwdenk
5108c609719bSwdenkHaving only the stack as writable memory limits means we cannot use
5109c609719bSwdenknormal global data to share information beween the code. But it
5110c609719bSwdenkturned out that the implementation of U-Boot can be greatly
5111c609719bSwdenksimplified by making a global data structure (gd_t) available to all
5112c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_
5113c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of
5114c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we
5115c609719bSwdenkplace a pointer (gd) to the global data into a register which we
5116c609719bSwdenkreserve for this purpose.
5117c609719bSwdenk
51187152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the
5119c609719bSwdenkrelevant  (E)ABI  specifications for the current architecture, and by
5120c609719bSwdenkGCC's implementation.
5121c609719bSwdenk
5122c609719bSwdenkFor PowerPC, the following registers have specific use:
5123c609719bSwdenk	R1:	stack pointer
5124e7670f6cSWolfgang Denk	R2:	reserved for system use
5125c609719bSwdenk	R3-R4:	parameter passing and return values
5126c609719bSwdenk	R5-R10: parameter passing
5127c609719bSwdenk	R13:	small data area pointer
5128c609719bSwdenk	R30:	GOT pointer
5129c609719bSwdenk	R31:	frame pointer
5130c609719bSwdenk
5131e6bee808SJoakim Tjernlund	(U-Boot also uses R12 as internal GOT pointer. r12
5132e6bee808SJoakim Tjernlund	is a volatile register so r12 needs to be reset when
5133e6bee808SJoakim Tjernlund	going back and forth between asm and C)
5134c609719bSwdenk
5135e7670f6cSWolfgang Denk    ==> U-Boot will use R2 to hold a pointer to the global data
5136c609719bSwdenk
5137c609719bSwdenk    Note: on PPC, we could use a static initializer (since the
5138c609719bSwdenk    address of the global data structure is known at compile time),
5139c609719bSwdenk    but it turned out that reserving a register results in somewhat
5140c609719bSwdenk    smaller code - although the code savings are not that big (on
5141c609719bSwdenk    average for all boards 752 bytes for the whole U-Boot image,
5142c609719bSwdenk    624 text + 127 data).
5143c609719bSwdenk
5144c4db335cSRobin GetzOn Blackfin, the normal C ABI (except for P3) is followed as documented here:
51454c58eb55SMike Frysinger	http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
51464c58eb55SMike Frysinger
5147c4db335cSRobin Getz    ==> U-Boot will use P3 to hold a pointer to the global data
51484c58eb55SMike Frysinger
5149c609719bSwdenkOn ARM, the following registers are used:
5150c609719bSwdenk
5151c609719bSwdenk	R0:	function argument word/integer result
5152c609719bSwdenk	R1-R3:	function argument word
5153c609719bSwdenk	R9:	GOT pointer
5154c609719bSwdenk	R10:	stack limit (used only if stack checking if enabled)
5155c609719bSwdenk	R11:	argument (frame) pointer
5156c609719bSwdenk	R12:	temporary workspace
5157c609719bSwdenk	R13:	stack pointer
5158c609719bSwdenk	R14:	link register
5159c609719bSwdenk	R15:	program counter
5160c609719bSwdenk
5161c609719bSwdenk    ==> U-Boot will use R8 to hold a pointer to the global data
5162c609719bSwdenk
51630df01fd3SThomas ChouOn Nios II, the ABI is documented here:
51640df01fd3SThomas Chou	http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
51650df01fd3SThomas Chou
51660df01fd3SThomas Chou    ==> U-Boot will use gp to hold a pointer to the global data
51670df01fd3SThomas Chou
51680df01fd3SThomas Chou    Note: on Nios II, we give "-G0" option to gcc and don't use gp
51690df01fd3SThomas Chou    to access small data sections, so gp is free.
51700df01fd3SThomas Chou
5171afc1ce82SMacpaul LinOn NDS32, the following registers are used:
5172afc1ce82SMacpaul Lin
5173afc1ce82SMacpaul Lin	R0-R1:	argument/return
5174afc1ce82SMacpaul Lin	R2-R5:	argument
5175afc1ce82SMacpaul Lin	R15:	temporary register for assembler
5176afc1ce82SMacpaul Lin	R16:	trampoline register
5177afc1ce82SMacpaul Lin	R28:	frame pointer (FP)
5178afc1ce82SMacpaul Lin	R29:	global pointer (GP)
5179afc1ce82SMacpaul Lin	R30:	link register (LP)
5180afc1ce82SMacpaul Lin	R31:	stack pointer (SP)
5181afc1ce82SMacpaul Lin	PC:	program counter (PC)
5182afc1ce82SMacpaul Lin
5183afc1ce82SMacpaul Lin    ==> U-Boot will use R10 to hold a pointer to the global data
5184afc1ce82SMacpaul Lin
5185d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5186d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much.
5187c609719bSwdenk
5188c609719bSwdenkMemory Management:
5189c609719bSwdenk------------------
5190c609719bSwdenk
5191c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the
5192c609719bSwdenkMMU is not used either for address mapping nor for memory protection.
5193c609719bSwdenk
5194c609719bSwdenkThe available memory is mapped to fixed addresses using the memory
5195c609719bSwdenkcontroller. In this process, a contiguous block is formed for each
5196c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several
5197c609719bSwdenkphysical memory banks.
5198c609719bSwdenk
5199c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on
5200c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5201c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself
5202c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some
52036d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
5204c609719bSwdenkconfiguration setting]. Below that, a structure with global Board
5205c609719bSwdenkInfo data is placed, followed by the stack (growing downward).
5206c609719bSwdenk
5207c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB
5208c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF).
5209c609719bSwdenk
5210c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like
5211c609719bSwdenkthis:
5212c609719bSwdenk
5213c609719bSwdenk	0x0000 0000	Exception Vector code
5214c609719bSwdenk	      :
5215c609719bSwdenk	0x0000 1FFF
5216c609719bSwdenk	0x0000 2000	Free for Application Use
5217c609719bSwdenk	      :
5218c609719bSwdenk	      :
5219c609719bSwdenk
5220c609719bSwdenk	      :
5221c609719bSwdenk	      :
5222c609719bSwdenk	0x00FB FF20	Monitor Stack (Growing downward)
5223c609719bSwdenk	0x00FB FFAC	Board Info Data and permanent copy of global data
5224c609719bSwdenk	0x00FC 0000	Malloc Arena
5225c609719bSwdenk	      :
5226c609719bSwdenk	0x00FD FFFF
5227c609719bSwdenk	0x00FE 0000	RAM Copy of Monitor Code
5228c609719bSwdenk	...		eventually: LCD or video framebuffer
5229c609719bSwdenk	...		eventually: pRAM (Protected RAM - unchanged by reset)
5230c609719bSwdenk	0x00FF FFFF	[End of RAM]
5231c609719bSwdenk
5232c609719bSwdenk
5233c609719bSwdenkSystem Initialization:
5234c609719bSwdenk----------------------
5235c609719bSwdenk
5236c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point
523711ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset
5238c609719bSwdenkconfiguration for CS0# this is a mirror of the onboard Flash memory.
52397152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address.
5240c609719bSwdenkTo be able to implement the initialization code in C, a (small!)
5241c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs
5242c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked
5243c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core,
5244c609719bSwdenkthe caches and the SIU.
5245c609719bSwdenk
5246c609719bSwdenkNext, all (potentially) available memory banks are mapped using a
5247c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries
5248c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5249c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5250c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a
5251c609719bSwdenksimple memory test is run that determines the size of the SDRAM
5252c609719bSwdenkbanks.
5253c609719bSwdenk
5254c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of
52557152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first
5256c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address
5257c609719bSwdenk0x00000000, with any additional banks following immediately to create
5258c609719bSwdenkcontiguous memory starting from 0.
5259c609719bSwdenk
5260c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area
5261c609719bSwdenkand allocates memory for use by malloc() and for the global Board
5262c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM
5263c609719bSwdenkpages, and the final stack is set up.
5264c609719bSwdenk
5265c609719bSwdenkOnly after this relocation will you have a "normal" C environment;
5266c609719bSwdenkuntil that you are restricted in several ways, mostly because you are
5267c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a
5268c609719bSwdenknew address in RAM.
5269c609719bSwdenk
5270c609719bSwdenk
5271c609719bSwdenkU-Boot Porting Guide:
5272c609719bSwdenk----------------------
5273c609719bSwdenk
5274c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
52756aff3115Swdenklist, October 2002]
5276c609719bSwdenk
5277c609719bSwdenk
5278c609719bSwdenkint main(int argc, char *argv[])
5279c609719bSwdenk{
5280c609719bSwdenk	sighandler_t no_more_time;
5281c609719bSwdenk
5282c609719bSwdenk	signal(SIGALRM, no_more_time);
5283c609719bSwdenk	alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
5284c609719bSwdenk
5285c609719bSwdenk	if (available_money > available_manpower) {
52866c3fef28SJerry Van Baren		Pay consultant to port U-Boot;
5287c609719bSwdenk		return 0;
5288c609719bSwdenk	}
5289c609719bSwdenk
5290c609719bSwdenk	Download latest U-Boot source;
5291c609719bSwdenk
52920668236bSWolfgang Denk	Subscribe to u-boot mailing list;
52936aff3115Swdenk
52946c3fef28SJerry Van Baren	if (clueless)
5295c609719bSwdenk		email("Hi, I am new to U-Boot, how do I get started?");
5296c609719bSwdenk
5297c609719bSwdenk	while (learning) {
5298c609719bSwdenk		Read the README file in the top level directory;
52997cb22f97Swdenk		Read http://www.denx.de/twiki/bin/view/DULG/Manual;
53006c3fef28SJerry Van Baren		Read applicable doc/*.README;
5301c609719bSwdenk		Read the source, Luke;
53026c3fef28SJerry Van Baren		/* find . -name "*.[chS]" | xargs grep -i <keyword> */
5303c609719bSwdenk	}
5304c609719bSwdenk
53056c3fef28SJerry Van Baren	if (available_money > toLocalCurrency ($2500))
53066c3fef28SJerry Van Baren		Buy a BDI3000;
53076c3fef28SJerry Van Baren	else
5308c609719bSwdenk		Add a lot of aggravation and time;
5309c609719bSwdenk
53106c3fef28SJerry Van Baren	if (a similar board exists) {	/* hopefully... */
53116c3fef28SJerry Van Baren		cp -a board/<similar> board/<myboard>
53126c3fef28SJerry Van Baren		cp include/configs/<similar>.h include/configs/<myboard>.h
53136c3fef28SJerry Van Baren	} else {
5314c609719bSwdenk		Create your own board support subdirectory;
53156c3fef28SJerry Van Baren		Create your own board include/configs/<myboard>.h file;
53166c3fef28SJerry Van Baren	}
53176c3fef28SJerry Van Baren	Edit new board/<myboard> files
53186c3fef28SJerry Van Baren	Edit new include/configs/<myboard>.h
5319c609719bSwdenk
53206c3fef28SJerry Van Baren	while (!accepted) {
5321c609719bSwdenk		while (!running) {
5322c609719bSwdenk			do {
5323c609719bSwdenk				Add / modify source code;
5324c609719bSwdenk			} until (compiles);
5325c609719bSwdenk			Debug;
5326c609719bSwdenk			if (clueless)
5327c609719bSwdenk				email("Hi, I am having problems...");
5328c609719bSwdenk		}
53296c3fef28SJerry Van Baren		Send patch file to the U-Boot email list;
53306c3fef28SJerry Van Baren		if (reasonable critiques)
53316c3fef28SJerry Van Baren			Incorporate improvements from email list code review;
53326c3fef28SJerry Van Baren		else
53336c3fef28SJerry Van Baren			Defend code as written;
53346c3fef28SJerry Van Baren	}
5335c609719bSwdenk
5336c609719bSwdenk	return 0;
5337c609719bSwdenk}
5338c609719bSwdenk
5339c609719bSwdenkvoid no_more_time (int sig)
5340c609719bSwdenk{
5341c609719bSwdenk      hire_a_guru();
5342c609719bSwdenk}
5343c609719bSwdenk
5344c609719bSwdenk
5345c609719bSwdenkCoding Standards:
5346c609719bSwdenk-----------------
5347c609719bSwdenk
5348c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel
53492c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script
53507ca9296eSWolfgang Denk"scripts/Lindent" in your Linux kernel source directory.
5351c609719bSwdenk
53522c051651SDetlev ZundelSource files originating from a different project (for example the
53532c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not
53542c051651SDetlev Zundelreformated to ease subsequent migration to newer versions of those
53552c051651SDetlev Zundelsources.
53562c051651SDetlev Zundel
53572c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in
53582c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//)
53592c051651SDetlev Zundelin your code.
5360c609719bSwdenk
5361c178d3daSwdenkPlease also stick to the following formatting rules:
5362180d3f74Swdenk- remove any trailing white space
53637ca9296eSWolfgang Denk- use TAB characters for indentation and vertical alignment, not spaces
5364180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds
53657ca9296eSWolfgang Denk- do not add more than 2 consecutive empty lines to source files
5366180d3f74Swdenk- do not add trailing empty lines to source files
5367180d3f74Swdenk
5368c609719bSwdenkSubmissions which do not conform to the standards may be returned
5369c609719bSwdenkwith a request to reformat the changes.
5370c609719bSwdenk
5371c609719bSwdenk
5372c609719bSwdenkSubmitting Patches:
5373c609719bSwdenk-------------------
5374c609719bSwdenk
5375c609719bSwdenkSince the number of patches for U-Boot is growing, we need to
5376c609719bSwdenkestablish some rules. Submissions which do not conform to these rules
5377c609719bSwdenkmay be rejected, even when they contain important and valuable stuff.
5378c609719bSwdenk
53790d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details.
5380218ca724SWolfgang Denk
53810668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
53820668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot
53830668236bSWolfgang Denk
5384c609719bSwdenkWhen you send a patch, please include the following information with
5385c609719bSwdenkit:
5386c609719bSwdenk
5387c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes
5388c609719bSwdenk  this bug. Please try to include a way of demonstrating that the
5389c609719bSwdenk  patch actually fixes something.
5390c609719bSwdenk
5391c609719bSwdenk* For new features: a description of the feature and your
5392c609719bSwdenk  implementation.
5393c609719bSwdenk
5394c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch)
5395c609719bSwdenk
5396c609719bSwdenk* For major contributions, your entry to the CREDITS file
5397c609719bSwdenk
5398c609719bSwdenk* When you add support for a new board, don't forget to add this
53997ca9296eSWolfgang Denk  board to the MAINTAINERS file, too.
5400c609719bSwdenk
5401c609719bSwdenk* If your patch adds new configuration options, don't forget to
5402c609719bSwdenk  document these in the README file.
5403c609719bSwdenk
5404218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly*
5405218ca724SWolfgang Denk  recommended) you can easily generate the patch using the
54067ca9296eSWolfgang Denk  "git format-patch". If you then use "git send-email" to send it to
5407218ca724SWolfgang Denk  the U-Boot mailing list, you will avoid most of the common problems
5408218ca724SWolfgang Denk  with some other mail clients.
5409c609719bSwdenk
5410218ca724SWolfgang Denk  If you cannot use git, use "diff -purN OLD NEW". If your version of
5411218ca724SWolfgang Denk  diff does not support these options, then get the latest version of
5412218ca724SWolfgang Denk  GNU diff.
54136dff5529Swdenk
5414218ca724SWolfgang Denk  The current directory when running this command shall be the parent
5415218ca724SWolfgang Denk  directory of the U-Boot source tree (i. e. please make sure that
5416218ca724SWolfgang Denk  your patch includes sufficient directory information for the
5417218ca724SWolfgang Denk  affected files).
5418218ca724SWolfgang Denk
5419218ca724SWolfgang Denk  We prefer patches as plain text. MIME attachments are discouraged,
5420218ca724SWolfgang Denk  and compressed attachments must not be used.
5421c609719bSwdenk
542252f52c14Swdenk* If one logical set of modifications affects or creates several
542352f52c14Swdenk  files, all these changes shall be submitted in a SINGLE patch file.
542452f52c14Swdenk
542552f52c14Swdenk* Changesets that contain different, unrelated modifications shall be
542652f52c14Swdenk  submitted as SEPARATE patches, one patch per changeset.
542752f52c14Swdenk
542852f52c14Swdenk
5429c609719bSwdenkNotes:
5430c609719bSwdenk
5431c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched
5432c609719bSwdenk  source tree and make sure that no errors or warnings are reported
5433c609719bSwdenk  for any of the boards.
5434c609719bSwdenk
5435c609719bSwdenk* Keep your modifications to the necessary minimum: A patch
5436c609719bSwdenk  containing several unrelated changes or arbitrary reformats will be
5437c609719bSwdenk  returned with a request to re-formatting / split it.
5438c609719bSwdenk
5439c609719bSwdenk* If you modify existing code, make sure that your new code does not
5440c609719bSwdenk  add to the memory footprint of the code ;-) Small is beautiful!
5441c609719bSwdenk  When adding new features, these should compile conditionally only
5442c609719bSwdenk  (using #ifdef), and the resulting code with the new feature
5443c609719bSwdenk  disabled must not need more memory than the old code without your
5444c609719bSwdenk  modification.
544590dc6704Swdenk
54460668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the
54470668236bSWolfgang Denk  u-boot mailing list. Bigger patches will be moderated. If they are
54480668236bSWolfgang Denk  reasonable and not too big, they will be acknowledged. But patches
54490668236bSWolfgang Denk  bigger than the size limit should be avoided.
5450