xref: /openbmc/u-boot/README (revision 267541f776f1e2bec21681c6e39a4c93af9621cf)
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
6196705d81eSwdenk
620c609719bSwdenk- Console Interface:
621c609719bSwdenk		Depending on board, define exactly one serial port
622c609719bSwdenk		(like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
623c609719bSwdenk		CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
624c609719bSwdenk		console by defining CONFIG_8xx_CONS_NONE
625c609719bSwdenk
626c609719bSwdenk		Note: if CONFIG_8xx_CONS_NONE is defined, the serial
627c609719bSwdenk		port routines must be defined elsewhere
628c609719bSwdenk		(i.e. serial_init(), serial_getc(), ...)
629c609719bSwdenk
630c609719bSwdenk		CONFIG_CFB_CONSOLE
631c609719bSwdenk		Enables console device for a color framebuffer. Needs following
632c53043b7SWolfgang Denk		defines (cf. smiLynxEM, i8042)
633c609719bSwdenk			VIDEO_FB_LITTLE_ENDIAN	graphic memory organisation
634c609719bSwdenk						(default big endian)
635c609719bSwdenk			VIDEO_HW_RECTFILL	graphic chip supports
636c609719bSwdenk						rectangle fill
637c609719bSwdenk						(cf. smiLynxEM)
638c609719bSwdenk			VIDEO_HW_BITBLT		graphic chip supports
639c609719bSwdenk						bit-blit (cf. smiLynxEM)
640c609719bSwdenk			VIDEO_VISIBLE_COLS	visible pixel columns
641c609719bSwdenk						(cols=pitch)
642c609719bSwdenk			VIDEO_VISIBLE_ROWS	visible pixel rows
643c609719bSwdenk			VIDEO_PIXEL_SIZE	bytes per pixel
644c609719bSwdenk			VIDEO_DATA_FORMAT	graphic data format
645c609719bSwdenk						(0-5, cf. cfb_console.c)
646c609719bSwdenk			VIDEO_FB_ADRS		framebuffer address
647c609719bSwdenk			VIDEO_KBD_INIT_FCT	keyboard int fct
648c609719bSwdenk						(i.e. i8042_kbd_init())
649c609719bSwdenk			VIDEO_TSTC_FCT		test char fct
650c609719bSwdenk						(i.e. i8042_tstc)
651c609719bSwdenk			VIDEO_GETC_FCT		get char fct
652c609719bSwdenk						(i.e. i8042_getc)
653c609719bSwdenk			CONFIG_CONSOLE_CURSOR	cursor drawing on/off
654c609719bSwdenk						(requires blink timer
655c609719bSwdenk						cf. i8042.c)
6566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
657c609719bSwdenk			CONFIG_CONSOLE_TIME	display time/date info in
658c609719bSwdenk						upper right corner
659602ad3b3SJon Loeliger						(requires CONFIG_CMD_DATE)
660c609719bSwdenk			CONFIG_VIDEO_LOGO	display Linux logo in
661c609719bSwdenk						upper left corner
662a6c7ad2fSwdenk			CONFIG_VIDEO_BMP_LOGO	use bmp_logo.h instead of
663a6c7ad2fSwdenk						linux_logo.h for logo.
664a6c7ad2fSwdenk						Requires CONFIG_VIDEO_LOGO
665c609719bSwdenk			CONFIG_CONSOLE_EXTRA_INFO
66611ccc33fSMarcel Ziswiler						additional board info beside
667c609719bSwdenk						the logo
668c609719bSwdenk
66933a35bbbSPali Rohár		When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
67033a35bbbSPali Rohár		a limited number of ANSI escape sequences (cursor control,
67133a35bbbSPali Rohár		erase functions and limited graphics rendition control).
67233a35bbbSPali Rohár
673c609719bSwdenk		When CONFIG_CFB_CONSOLE is defined, video console is
674c609719bSwdenk		default i/o. Serial console can be forced with
675c609719bSwdenk		environment 'console=serial'.
676c609719bSwdenk
677a3ad8e26Swdenk		When CONFIG_SILENT_CONSOLE is defined, all console
678a3ad8e26Swdenk		messages (by U-Boot and Linux!) can be silenced with
679a3ad8e26Swdenk		the "silent" environment variable. See
680a3ad8e26Swdenk		doc/README.silent for more information.
681a3ad8e26Swdenk
682c609719bSwdenk- Console Baudrate:
683c609719bSwdenk		CONFIG_BAUDRATE - in bps
684c609719bSwdenk		Select one of the baudrates listed in
6856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
6866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
687c609719bSwdenk
688c92fac91SHeiko Schocher- Console Rx buffer length
689c92fac91SHeiko Schocher		With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
690c92fac91SHeiko Schocher		the maximum receive buffer length for the SMC.
6912b3f12c2SHeiko Schocher		This option is actual only for 82xx and 8xx possible.
692c92fac91SHeiko Schocher		If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
693c92fac91SHeiko Schocher		must be defined, to setup the maximum idle timeout for
694c92fac91SHeiko Schocher		the SMC.
695c92fac91SHeiko Schocher
6969558b48aSGraeme Russ- Pre-Console Buffer:
6979558b48aSGraeme Russ		Prior to the console being initialised (i.e. serial UART
6989558b48aSGraeme Russ		initialised etc) all console output is silently discarded.
6999558b48aSGraeme Russ		Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
7009558b48aSGraeme Russ		buffer any console messages prior to the console being
7019558b48aSGraeme Russ		initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
7029558b48aSGraeme Russ		bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
7039558b48aSGraeme Russ		a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
7049558b48aSGraeme Russ		bytes are output before the console is initialised, the
7059558b48aSGraeme Russ		earlier bytes are discarded.
7069558b48aSGraeme Russ
7079558b48aSGraeme Russ		'Sane' compilers will generate smaller code if
7089558b48aSGraeme Russ		CONFIG_PRE_CON_BUF_SZ is a power of 2
7099558b48aSGraeme Russ
710046a37bdSSonny Rao- Safe printf() functions
711046a37bdSSonny Rao		Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
712046a37bdSSonny Rao		the printf() functions. These are defined in
713046a37bdSSonny Rao		include/vsprintf.h and include snprintf(), vsnprintf() and
714046a37bdSSonny Rao		so on. Code size increase is approximately 300-500 bytes.
715046a37bdSSonny Rao		If this option is not given then these functions will
716046a37bdSSonny Rao		silently discard their buffer size argument - this means
717046a37bdSSonny Rao		you are not getting any overflow checking in this case.
718046a37bdSSonny Rao
719c609719bSwdenk- Boot Delay:	CONFIG_BOOTDELAY - in seconds
720c609719bSwdenk		Delay before automatically booting the default image;
721c609719bSwdenk		set to -1 to disable autoboot.
72293d7212fSJoe Hershberger		set to -2 to autoboot with no delay and not check for abort
72393d7212fSJoe Hershberger		(even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
724c609719bSwdenk
725c609719bSwdenk		See doc/README.autoboot for these options that
726c609719bSwdenk		work with CONFIG_BOOTDELAY. None are required.
727c609719bSwdenk		CONFIG_BOOT_RETRY_TIME
728c609719bSwdenk		CONFIG_BOOT_RETRY_MIN
729c609719bSwdenk		CONFIG_AUTOBOOT_KEYED
730c609719bSwdenk		CONFIG_AUTOBOOT_PROMPT
731c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR
732c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR
733c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR2
734c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR2
735c609719bSwdenk		CONFIG_ZERO_BOOTDELAY_CHECK
736c609719bSwdenk		CONFIG_RESET_TO_RETRY
737c609719bSwdenk
738c609719bSwdenk- Autoboot Command:
739c609719bSwdenk		CONFIG_BOOTCOMMAND
740c609719bSwdenk		Only needed when CONFIG_BOOTDELAY is enabled;
741c609719bSwdenk		define a command string that is automatically executed
742c609719bSwdenk		when no character is read on the console interface
743c609719bSwdenk		within "Boot Delay" after reset.
744c609719bSwdenk
745c609719bSwdenk		CONFIG_BOOTARGS
746c609719bSwdenk		This can be used to pass arguments to the bootm
747c609719bSwdenk		command. The value of CONFIG_BOOTARGS goes into the
748c609719bSwdenk		environment value "bootargs".
749c609719bSwdenk
750c609719bSwdenk		CONFIG_RAMBOOT and CONFIG_NFSBOOT
751c609719bSwdenk		The value of these goes into the environment as
752c609719bSwdenk		"ramboot" and "nfsboot" respectively, and can be used
753c609719bSwdenk		as a convenience, when switching between booting from
75411ccc33fSMarcel Ziswiler		RAM and NFS.
755c609719bSwdenk
756c609719bSwdenk- Pre-Boot Commands:
757c609719bSwdenk		CONFIG_PREBOOT
758c609719bSwdenk
759c609719bSwdenk		When this option is #defined, the existence of the
760c609719bSwdenk		environment variable "preboot" will be checked
761c609719bSwdenk		immediately before starting the CONFIG_BOOTDELAY
762c609719bSwdenk		countdown and/or running the auto-boot command resp.
763c609719bSwdenk		entering interactive mode.
764c609719bSwdenk
765c609719bSwdenk		This feature is especially useful when "preboot" is
766c609719bSwdenk		automatically generated or modified. For an example
767c609719bSwdenk		see the LWMON board specific code: here "preboot" is
768c609719bSwdenk		modified when the user holds down a certain
769c609719bSwdenk		combination of keys on the (special) keyboard when
770c609719bSwdenk		booting the systems
771c609719bSwdenk
772c609719bSwdenk- Serial Download Echo Mode:
773c609719bSwdenk		CONFIG_LOADS_ECHO
774c609719bSwdenk		If defined to 1, all characters received during a
775c609719bSwdenk		serial download (using the "loads" command) are
776c609719bSwdenk		echoed back. This might be needed by some terminal
777c609719bSwdenk		emulations (like "cu"), but may as well just take
778c609719bSwdenk		time on others. This setting #define's the initial
779c609719bSwdenk		value of the "loads_echo" environment variable.
780c609719bSwdenk
781602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
782c609719bSwdenk		CONFIG_KGDB_BAUDRATE
783c609719bSwdenk		Select one of the baudrates listed in
7846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
785c609719bSwdenk
786c609719bSwdenk- Monitor Functions:
787602ad3b3SJon Loeliger		Monitor commands can be included or excluded
788602ad3b3SJon Loeliger		from the build by using the #include files
789c6c621bdSStephen Warren		<config_cmd_all.h> and #undef'ing unwanted
790c6c621bdSStephen Warren		commands, or using <config_cmd_default.h>
791602ad3b3SJon Loeliger		and augmenting with additional #define's
792602ad3b3SJon Loeliger		for wanted commands.
793c609719bSwdenk
794602ad3b3SJon Loeliger		The default command configuration includes all commands
795602ad3b3SJon Loeliger		except those marked below with a "*".
796602ad3b3SJon Loeliger
797602ad3b3SJon Loeliger		CONFIG_CMD_ASKENV	* ask for env variable
798602ad3b3SJon Loeliger		CONFIG_CMD_BDI		  bdinfo
799602ad3b3SJon Loeliger		CONFIG_CMD_BEDBUG	* Include BedBug Debugger
800602ad3b3SJon Loeliger		CONFIG_CMD_BMP		* BMP support
801602ad3b3SJon Loeliger		CONFIG_CMD_BSP		* Board specific commands
802602ad3b3SJon Loeliger		CONFIG_CMD_BOOTD	  bootd
803602ad3b3SJon Loeliger		CONFIG_CMD_CACHE	* icache, dcache
804602ad3b3SJon Loeliger		CONFIG_CMD_CONSOLE	  coninfo
805710b9938SMike Frysinger		CONFIG_CMD_CRC32	* crc32
806602ad3b3SJon Loeliger		CONFIG_CMD_DATE		* support for RTC, date/time...
807602ad3b3SJon Loeliger		CONFIG_CMD_DHCP		* DHCP support
808602ad3b3SJon Loeliger		CONFIG_CMD_DIAG		* Diagnostics
809a7c93104SPeter Tyser		CONFIG_CMD_DS4510	* ds4510 I2C gpio commands
810a7c93104SPeter Tyser		CONFIG_CMD_DS4510_INFO	* ds4510 I2C info command
811a7c93104SPeter Tyser		CONFIG_CMD_DS4510_MEM	* ds4510 I2C eeprom/sram commansd
812a7c93104SPeter Tyser		CONFIG_CMD_DS4510_RST	* ds4510 I2C rst command
813602ad3b3SJon Loeliger		CONFIG_CMD_DTT		* Digital Therm and Thermostat
814602ad3b3SJon Loeliger		CONFIG_CMD_ECHO		  echo arguments
815246c6922SPeter Tyser		CONFIG_CMD_EDITENV	  edit env variable
816602ad3b3SJon Loeliger		CONFIG_CMD_EEPROM	* EEPROM read/write support
817602ad3b3SJon Loeliger		CONFIG_CMD_ELF		* bootelf, bootvx
8185e2b3e0cSJoe Hershberger		CONFIG_CMD_ENV_CALLBACK	* display details about env callbacks
819fffad71bSJoe Hershberger		CONFIG_CMD_ENV_FLAGS	* display details about env flags
8200c79cda0SMike Frysinger		CONFIG_CMD_EXPORTENV	* export the environment
82103e2ecf6SStephen Warren		CONFIG_CMD_EXT2		* ext2 command support
82203e2ecf6SStephen Warren		CONFIG_CMD_EXT4		* ext4 command support
823bdab39d3SMike Frysinger		CONFIG_CMD_SAVEENV	  saveenv
824602ad3b3SJon Loeliger		CONFIG_CMD_FDC		* Floppy Disk Support
82503e2ecf6SStephen Warren		CONFIG_CMD_FAT		* FAT command support
826602ad3b3SJon Loeliger		CONFIG_CMD_FDOS		* Dos diskette Support
827602ad3b3SJon Loeliger		CONFIG_CMD_FLASH	  flinfo, erase, protect
828602ad3b3SJon Loeliger		CONFIG_CMD_FPGA		  FPGA device initialization support
82953fdc7efSAnton Staaf		CONFIG_CMD_GETTIME	* Get time since boot
830a641b979SMike Frysinger		CONFIG_CMD_GO		* the 'go' command (exec code)
831a000b795SKim Phillips		CONFIG_CMD_GREPENV	* search environment
832bf36c5d5SSimon Glass		CONFIG_CMD_HASH		* calculate hash / digest
833602ad3b3SJon Loeliger		CONFIG_CMD_HWFLOW	* RTS/CTS hw flow control
834602ad3b3SJon Loeliger		CONFIG_CMD_I2C		* I2C serial bus support
835602ad3b3SJon Loeliger		CONFIG_CMD_IDE		* IDE harddisk support
836602ad3b3SJon Loeliger		CONFIG_CMD_IMI		  iminfo
837602ad3b3SJon Loeliger		CONFIG_CMD_IMLS		  List all found images
838602ad3b3SJon Loeliger		CONFIG_CMD_IMMAP	* IMMR dump support
8390c79cda0SMike Frysinger		CONFIG_CMD_IMPORTENV	* import an environment
840c167cc02SJoe Hershberger		CONFIG_CMD_INI		* import data from an ini file into the env
841602ad3b3SJon Loeliger		CONFIG_CMD_IRQ		* irqinfo
842602ad3b3SJon Loeliger		CONFIG_CMD_ITEST	  Integer/string test of 2 values
843602ad3b3SJon Loeliger		CONFIG_CMD_JFFS2	* JFFS2 Support
844602ad3b3SJon Loeliger		CONFIG_CMD_KGDB		* kgdb
8451ba7fd25SMike Frysinger		CONFIG_CMD_LDRINFO	  ldrinfo (display Blackfin loader)
846d22c338eSJoe Hershberger		CONFIG_CMD_LINK_LOCAL	* link-local IP address auto-configuration
847d22c338eSJoe Hershberger					  (169.254.*.*)
848602ad3b3SJon Loeliger		CONFIG_CMD_LOADB	  loadb
849602ad3b3SJon Loeliger		CONFIG_CMD_LOADS	  loads
85002c9aa1dSRobin Getz		CONFIG_CMD_MD5SUM	  print md5 message digest
85102c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
852602ad3b3SJon Loeliger		CONFIG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
85356523f12Swdenk					  loop, loopw, mtest
854602ad3b3SJon Loeliger		CONFIG_CMD_MISC		  Misc functions like sleep etc
855602ad3b3SJon Loeliger		CONFIG_CMD_MMC		* MMC memory mapped support
856602ad3b3SJon Loeliger		CONFIG_CMD_MII		* MII utility commands
85768d7d651SStefan Roese		CONFIG_CMD_MTDPARTS	* MTD partition support
858602ad3b3SJon Loeliger		CONFIG_CMD_NAND		* NAND support
859602ad3b3SJon Loeliger		CONFIG_CMD_NET		  bootp, tftpboot, rarpboot
860e92739d3SPeter Tyser		CONFIG_CMD_PCA953X	* PCA953x I2C gpio commands
861e92739d3SPeter Tyser		CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
862602ad3b3SJon Loeliger		CONFIG_CMD_PCI		* pciinfo
863602ad3b3SJon Loeliger		CONFIG_CMD_PCMCIA		* PCMCIA support
864602ad3b3SJon Loeliger		CONFIG_CMD_PING		* send ICMP ECHO_REQUEST to network
865602ad3b3SJon Loeliger					  host
866602ad3b3SJon Loeliger		CONFIG_CMD_PORTIO	* Port I/O
867ff048ea9SKenneth Waters		CONFIG_CMD_READ		* Read raw data from partition
868602ad3b3SJon Loeliger		CONFIG_CMD_REGINFO	* Register dump
869602ad3b3SJon Loeliger		CONFIG_CMD_RUN		  run command in env variable
870602ad3b3SJon Loeliger		CONFIG_CMD_SAVES	* save S record dump
871602ad3b3SJon Loeliger		CONFIG_CMD_SCSI		* SCSI Support
872602ad3b3SJon Loeliger		CONFIG_CMD_SDRAM	* print SDRAM configuration information
873602ad3b3SJon Loeliger					  (requires CONFIG_CMD_I2C)
874602ad3b3SJon Loeliger		CONFIG_CMD_SETGETDCR	  Support for DCR Register access
875602ad3b3SJon Loeliger					  (4xx only)
876f61ec45eSEric Nelson		CONFIG_CMD_SF		* Read/write/erase SPI NOR flash
877c6b1ee66SAlexander Holler		CONFIG_CMD_SHA1SUM	  print sha1 memory digest
87802c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY)
87974de7aefSWolfgang Denk		CONFIG_CMD_SOURCE	  "source" command Support
880602ad3b3SJon Loeliger		CONFIG_CMD_SPI		* SPI serial bus support
8817a83af07SLuca Ceresoli		CONFIG_CMD_TFTPSRV	* TFTP transfer in server mode
8821fb7cd49SSimon Glass		CONFIG_CMD_TFTPPUT	* TFTP put command (upload)
883da83bcd7SJoe Hershberger		CONFIG_CMD_TIME		* run command and report execution time (ARM specific)
884da83bcd7SJoe Hershberger		CONFIG_CMD_TIMER	* access to the system tick timer
885602ad3b3SJon Loeliger		CONFIG_CMD_USB		* USB support
886602ad3b3SJon Loeliger		CONFIG_CMD_CDP		* Cisco Discover Protocol support
887c8339f51SMarek Vasut		CONFIG_CMD_MFSL		* Microblaze FSL support
888c609719bSwdenk
889c609719bSwdenk
890c609719bSwdenk		EXAMPLE: If you want all functions except of network
891c609719bSwdenk		support you can write:
892c609719bSwdenk
893602ad3b3SJon Loeliger		#include "config_cmd_all.h"
894602ad3b3SJon Loeliger		#undef CONFIG_CMD_NET
895c609719bSwdenk
896213bf8c8SGerald Van Baren	Other Commands:
897213bf8c8SGerald Van Baren		fdt (flattened device tree) command: CONFIG_OF_LIBFDT
898c609719bSwdenk
899c609719bSwdenk	Note:	Don't enable the "icache" and "dcache" commands
900602ad3b3SJon Loeliger		(configuration option CONFIG_CMD_CACHE) unless you know
901c609719bSwdenk		what you (and your U-Boot users) are doing. Data
902c609719bSwdenk		cache cannot be enabled on systems like the 8xx or
903c609719bSwdenk		8260 (where accesses to the IMMR region must be
904c609719bSwdenk		uncached), and it cannot be disabled on all other
905c609719bSwdenk		systems where we (mis-) use the data cache to hold an
906c609719bSwdenk		initial stack and some data.
907c609719bSwdenk
908c609719bSwdenk
909c609719bSwdenk		XXX - this list needs to get updated!
910c609719bSwdenk
91145ba8077SSimon Glass- Device tree:
91245ba8077SSimon Glass		CONFIG_OF_CONTROL
91345ba8077SSimon Glass		If this variable is defined, U-Boot will use a device tree
91445ba8077SSimon Glass		to configure its devices, instead of relying on statically
91545ba8077SSimon Glass		compiled #defines in the board file. This option is
91645ba8077SSimon Glass		experimental and only available on a few boards. The device
91745ba8077SSimon Glass		tree is available in the global data as gd->fdt_blob.
91845ba8077SSimon Glass
9192c0f79e4SSimon Glass		U-Boot needs to get its device tree from somewhere. This can
9202c0f79e4SSimon Glass		be done using one of the two options below:
921bbb0b128SSimon Glass
922bbb0b128SSimon Glass		CONFIG_OF_EMBED
923bbb0b128SSimon Glass		If this variable is defined, U-Boot will embed a device tree
924bbb0b128SSimon Glass		binary in its image. This device tree file should be in the
925bbb0b128SSimon Glass		board directory and called <soc>-<board>.dts. The binary file
926bbb0b128SSimon Glass		is then picked up in board_init_f() and made available through
927bbb0b128SSimon Glass		the global data structure as gd->blob.
92845ba8077SSimon Glass
9292c0f79e4SSimon Glass		CONFIG_OF_SEPARATE
9302c0f79e4SSimon Glass		If this variable is defined, U-Boot will build a device tree
9312c0f79e4SSimon Glass		binary. It will be called u-boot.dtb. Architecture-specific
9322c0f79e4SSimon Glass		code will locate it at run-time. Generally this works by:
9332c0f79e4SSimon Glass
9342c0f79e4SSimon Glass			cat u-boot.bin u-boot.dtb >image.bin
9352c0f79e4SSimon Glass
9362c0f79e4SSimon Glass		and in fact, U-Boot does this for you, creating a file called
9372c0f79e4SSimon Glass		u-boot-dtb.bin which is useful in the common case. You can
9382c0f79e4SSimon Glass		still use the individual files if you need something more
9392c0f79e4SSimon Glass		exotic.
9402c0f79e4SSimon Glass
941c609719bSwdenk- Watchdog:
942c609719bSwdenk		CONFIG_WATCHDOG
943c609719bSwdenk		If this variable is defined, it enables watchdog
9446abe6fb6SDetlev Zundel		support for the SoC. There must be support in the SoC
9456abe6fb6SDetlev Zundel		specific code for a watchdog. For the 8xx and 8260
9466abe6fb6SDetlev Zundel		CPUs, the SIU Watchdog feature is enabled in the SYPCR
9476abe6fb6SDetlev Zundel		register.  When supported for a specific SoC is
9486abe6fb6SDetlev Zundel		available, then no further board specific code should
9496abe6fb6SDetlev Zundel		be needed to use it.
9506abe6fb6SDetlev Zundel
9516abe6fb6SDetlev Zundel		CONFIG_HW_WATCHDOG
9526abe6fb6SDetlev Zundel		When using a watchdog circuitry external to the used
9536abe6fb6SDetlev Zundel		SoC, then define this variable and provide board
9546abe6fb6SDetlev Zundel		specific code for the "hw_watchdog_reset" function.
955c609719bSwdenk
956c1551ea8Sstroese- U-Boot Version:
957c1551ea8Sstroese		CONFIG_VERSION_VARIABLE
958c1551ea8Sstroese		If this variable is defined, an environment variable
959c1551ea8Sstroese		named "ver" is created by U-Boot showing the U-Boot
960c1551ea8Sstroese		version as printed by the "version" command.
961a1ea8e51SBenoît Thébaudeau		Any change to this variable will be reverted at the
962a1ea8e51SBenoît Thébaudeau		next reset.
963c1551ea8Sstroese
964c609719bSwdenk- Real-Time Clock:
965c609719bSwdenk
966602ad3b3SJon Loeliger		When CONFIG_CMD_DATE is selected, the type of the RTC
967c609719bSwdenk		has to be selected, too. Define exactly one of the
968c609719bSwdenk		following options:
969c609719bSwdenk
970c609719bSwdenk		CONFIG_RTC_MPC8xx	- use internal RTC of MPC8xx
971c609719bSwdenk		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
9724e8b7544SFabio Estevam		CONFIG_RTC_MC13XXX	- use MC13783 or MC13892 RTC
973c609719bSwdenk		CONFIG_RTC_MC146818	- use MC146818 RTC
9741cb8e980Swdenk		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
975c609719bSwdenk		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
9767f70e853Swdenk		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
9773bac3513Swdenk		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
9789536dfccSTor Krill		CONFIG_RTC_ISL1208	- use Intersil ISL1208 RTC
9794c0d4c3bSwdenk		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
9806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_DS1337_NOOSC	- Turn off the OSC output for DS1337
98171d19f30SHeiko Schocher		CONFIG_SYS_RV3029_TCR	- enable trickle charger on
98271d19f30SHeiko Schocher					  RV3029 RTC.
983c609719bSwdenk
984b37c7e5eSwdenk		Note that if the RTC uses I2C, then the I2C interface
985b37c7e5eSwdenk		must also be configured. See I2C Support, below.
986b37c7e5eSwdenk
987e92739d3SPeter Tyser- GPIO Support:
988e92739d3SPeter Tyser		CONFIG_PCA953X		- use NXP's PCA953X series I2C GPIO
989e92739d3SPeter Tyser		CONFIG_PCA953X_INFO	- enable pca953x info command
990e92739d3SPeter Tyser
9915dec49caSChris Packham		The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
9925dec49caSChris Packham		chip-ngpio pairs that tell the PCA953X driver the number of
9935dec49caSChris Packham		pins supported by a particular chip.
9945dec49caSChris Packham
995e92739d3SPeter Tyser		Note that if the GPIO device uses I2C, then the I2C interface
996e92739d3SPeter Tyser		must also be configured. See I2C Support, below.
997e92739d3SPeter Tyser
998c609719bSwdenk- Timestamp Support:
999c609719bSwdenk
1000c609719bSwdenk		When CONFIG_TIMESTAMP is selected, the timestamp
1001c609719bSwdenk		(date and time) of an image is printed by image
1002c609719bSwdenk		commands like bootm or iminfo. This option is
1003602ad3b3SJon Loeliger		automatically enabled when you select CONFIG_CMD_DATE .
1004c609719bSwdenk
1005923c46f9SKarl O. Pinc- Partition Labels (disklabels) Supported:
1006923c46f9SKarl O. Pinc		Zero or more of the following:
1007923c46f9SKarl O. Pinc		CONFIG_MAC_PARTITION   Apple's MacOS partition table.
1008923c46f9SKarl O. Pinc		CONFIG_DOS_PARTITION   MS Dos partition table, traditional on the
1009923c46f9SKarl O. Pinc				       Intel architecture, USB sticks, etc.
1010923c46f9SKarl O. Pinc		CONFIG_ISO_PARTITION   ISO partition table, used on CDROM etc.
1011923c46f9SKarl O. Pinc		CONFIG_EFI_PARTITION   GPT partition table, common when EFI is the
1012923c46f9SKarl O. Pinc				       bootloader.  Note 2TB partition limit; see
1013923c46f9SKarl O. Pinc				       disk/part_efi.c
1014923c46f9SKarl O. Pinc		CONFIG_MTD_PARTITIONS  Memory Technology Device partition table.
1015c609719bSwdenk
1016602ad3b3SJon Loeliger		If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1017218ca724SWolfgang Denk		CONFIG_CMD_SCSI) you must configure support for at
1018923c46f9SKarl O. Pinc		least one non-MTD partition type as well.
1019c609719bSwdenk
1020c609719bSwdenk- IDE Reset method:
10214d13cbadSwdenk		CONFIG_IDE_RESET_ROUTINE - this is defined in several
10224d13cbadSwdenk		board configurations files but used nowhere!
1023c609719bSwdenk
10244d13cbadSwdenk		CONFIG_IDE_RESET - is this is defined, IDE Reset will
10254d13cbadSwdenk		be performed by calling the function
10264d13cbadSwdenk			ide_set_reset(int reset)
10274d13cbadSwdenk		which has to be defined in a board specific file
1028c609719bSwdenk
1029c609719bSwdenk- ATAPI Support:
1030c609719bSwdenk		CONFIG_ATAPI
1031c609719bSwdenk
1032c609719bSwdenk		Set this to enable ATAPI support.
1033c609719bSwdenk
1034c40b2956Swdenk- LBA48 Support
1035c40b2956Swdenk		CONFIG_LBA48
1036c40b2956Swdenk
1037c40b2956Swdenk		Set this to enable support for disks larger than 137GB
10384b142febSHeiko Schocher		Also look at CONFIG_SYS_64BIT_LBA.
1039c40b2956Swdenk		Whithout these , LBA48 support uses 32bit variables and will 'only'
1040c40b2956Swdenk		support disks up to 2.1TB.
1041c40b2956Swdenk
10426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_64BIT_LBA:
1043c40b2956Swdenk			When enabled, makes the IDE subsystem use 64bit sector addresses.
1044c40b2956Swdenk			Default is 32bit.
1045c40b2956Swdenk
1046c609719bSwdenk- SCSI Support:
1047c609719bSwdenk		At the moment only there is only support for the
1048c609719bSwdenk		SYM53C8XX SCSI controller; define
1049c609719bSwdenk		CONFIG_SCSI_SYM53C8XX to enable it.
1050c609719bSwdenk
10516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
10526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
10536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
1054c609719bSwdenk		maximum numbers of LUNs, SCSI ID's and target
1055c609719bSwdenk		devices.
10566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
1057c609719bSwdenk
1058447c031bSStefan Reinauer                The environment variable 'scsidevs' is set to the number of
1059447c031bSStefan Reinauer                SCSI devices found during the last scan.
1060447c031bSStefan Reinauer
1061c609719bSwdenk- NETWORK Support (PCI):
1062682011ffSwdenk		CONFIG_E1000
1063ce5207e1SKyle Moffett		Support for Intel 8254x/8257x gigabit chips.
1064ce5207e1SKyle Moffett
1065ce5207e1SKyle Moffett		CONFIG_E1000_SPI
1066ce5207e1SKyle Moffett		Utility code for direct access to the SPI bus on Intel 8257x.
1067ce5207e1SKyle Moffett		This does not do anything useful unless you set at least one
1068ce5207e1SKyle Moffett		of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1069ce5207e1SKyle Moffett
1070ce5207e1SKyle Moffett		CONFIG_E1000_SPI_GENERIC
1071ce5207e1SKyle Moffett		Allow generic access to the SPI bus on the Intel 8257x, for
1072ce5207e1SKyle Moffett		example with the "sspi" command.
1073ce5207e1SKyle Moffett
1074ce5207e1SKyle Moffett		CONFIG_CMD_E1000
1075ce5207e1SKyle Moffett		Management command for E1000 devices.  When used on devices
1076ce5207e1SKyle Moffett		with SPI support you can reprogram the EEPROM from U-Boot.
1077682011ffSwdenk
1078ac3315c2SAndre Schwarz		CONFIG_E1000_FALLBACK_MAC
107911ccc33fSMarcel Ziswiler		default MAC for empty EEPROM after production.
1080ac3315c2SAndre Schwarz
1081c609719bSwdenk		CONFIG_EEPRO100
1082c609719bSwdenk		Support for Intel 82557/82559/82559ER chips.
108311ccc33fSMarcel Ziswiler		Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
1084c609719bSwdenk		write routine for first time initialisation.
1085c609719bSwdenk
1086c609719bSwdenk		CONFIG_TULIP
1087c609719bSwdenk		Support for Digital 2114x chips.
1088c609719bSwdenk		Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1089c609719bSwdenk		modem chip initialisation (KS8761/QS6611).
1090c609719bSwdenk
1091c609719bSwdenk		CONFIG_NATSEMI
1092c609719bSwdenk		Support for National dp83815 chips.
1093c609719bSwdenk
1094c609719bSwdenk		CONFIG_NS8382X
1095c609719bSwdenk		Support for National dp8382[01] gigabit chips.
1096c609719bSwdenk
109745219c46Swdenk- NETWORK Support (other):
109845219c46Swdenk
1099c041e9d2SJens Scharsig		CONFIG_DRIVER_AT91EMAC
1100c041e9d2SJens Scharsig		Support for AT91RM9200 EMAC.
1101c041e9d2SJens Scharsig
1102c041e9d2SJens Scharsig			CONFIG_RMII
1103c041e9d2SJens Scharsig			Define this to use reduced MII inteface
1104c041e9d2SJens Scharsig
1105c041e9d2SJens Scharsig			CONFIG_DRIVER_AT91EMAC_QUIET
1106c041e9d2SJens Scharsig			If this defined, the driver is quiet.
1107c041e9d2SJens Scharsig			The driver doen't show link status messages.
1108c041e9d2SJens Scharsig
1109efdd7319SRob Herring		CONFIG_CALXEDA_XGMAC
1110efdd7319SRob Herring		Support for the Calxeda XGMAC device
1111efdd7319SRob Herring
11123bb46d23SAshok		CONFIG_LAN91C96
111345219c46Swdenk		Support for SMSC's LAN91C96 chips.
111445219c46Swdenk
111545219c46Swdenk			CONFIG_LAN91C96_BASE
111645219c46Swdenk			Define this to hold the physical address
111745219c46Swdenk			of the LAN91C96's I/O space
111845219c46Swdenk
111945219c46Swdenk			CONFIG_LAN91C96_USE_32_BIT
112045219c46Swdenk			Define this to enable 32 bit addressing
112145219c46Swdenk
11223bb46d23SAshok		CONFIG_SMC91111
1123f39748aeSwdenk		Support for SMSC's LAN91C111 chip
1124f39748aeSwdenk
1125f39748aeSwdenk			CONFIG_SMC91111_BASE
1126f39748aeSwdenk			Define this to hold the physical address
1127f39748aeSwdenk			of the device (I/O space)
1128f39748aeSwdenk
1129f39748aeSwdenk			CONFIG_SMC_USE_32_BIT
1130f39748aeSwdenk			Define this if data bus is 32 bits
1131f39748aeSwdenk
1132f39748aeSwdenk			CONFIG_SMC_USE_IOFUNCS
1133f39748aeSwdenk			Define this to use i/o functions instead of macros
1134f39748aeSwdenk			(some hardware wont work with macros)
1135f39748aeSwdenk
1136dc02badaSHeiko Schocher		CONFIG_DRIVER_TI_EMAC
1137dc02badaSHeiko Schocher		Support for davinci emac
1138dc02badaSHeiko Schocher
1139dc02badaSHeiko Schocher			CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1140dc02badaSHeiko Schocher			Define this if you have more then 3 PHYs.
1141dc02badaSHeiko Schocher
1142b3dbf4a5SMacpaul Lin		CONFIG_FTGMAC100
1143b3dbf4a5SMacpaul Lin		Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1144b3dbf4a5SMacpaul Lin
1145b3dbf4a5SMacpaul Lin			CONFIG_FTGMAC100_EGIGA
1146b3dbf4a5SMacpaul Lin			Define this to use GE link update with gigabit PHY.
1147b3dbf4a5SMacpaul Lin			Define this if FTGMAC100 is connected to gigabit PHY.
1148b3dbf4a5SMacpaul Lin			If your system has 10/100 PHY only, it might not occur
1149b3dbf4a5SMacpaul Lin			wrong behavior. Because PHY usually return timeout or
1150b3dbf4a5SMacpaul Lin			useless data when polling gigabit status and gigabit
1151b3dbf4a5SMacpaul Lin			control registers. This behavior won't affect the
1152b3dbf4a5SMacpaul Lin			correctnessof 10/100 link speed update.
1153b3dbf4a5SMacpaul Lin
1154c2fff331SMike Rapoport		CONFIG_SMC911X
1155557b377dSJens Gehrlein		Support for SMSC's LAN911x and LAN921x chips
1156557b377dSJens Gehrlein
1157c2fff331SMike Rapoport			CONFIG_SMC911X_BASE
1158557b377dSJens Gehrlein			Define this to hold the physical address
1159557b377dSJens Gehrlein			of the device (I/O space)
1160557b377dSJens Gehrlein
1161c2fff331SMike Rapoport			CONFIG_SMC911X_32_BIT
1162557b377dSJens Gehrlein			Define this if data bus is 32 bits
1163557b377dSJens Gehrlein
1164c2fff331SMike Rapoport			CONFIG_SMC911X_16_BIT
1165557b377dSJens Gehrlein			Define this if data bus is 16 bits. If your processor
1166557b377dSJens Gehrlein			automatically converts one 32 bit word to two 16 bit
1167c2fff331SMike Rapoport			words you may also try CONFIG_SMC911X_32_BIT.
1168557b377dSJens Gehrlein
11693d0075faSYoshihiro Shimoda		CONFIG_SH_ETHER
11703d0075faSYoshihiro Shimoda		Support for Renesas on-chip Ethernet controller
11713d0075faSYoshihiro Shimoda
11723d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_USE_PORT
11733d0075faSYoshihiro Shimoda			Define the number of ports to be used
11743d0075faSYoshihiro Shimoda
11753d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_PHY_ADDR
11763d0075faSYoshihiro Shimoda			Define the ETH PHY's address
11773d0075faSYoshihiro Shimoda
117868260aabSYoshihiro Shimoda			CONFIG_SH_ETHER_CACHE_WRITEBACK
117968260aabSYoshihiro Shimoda			If this option is set, the driver enables cache flush.
118068260aabSYoshihiro Shimoda
11815e124724SVadim Bendebury- TPM Support:
11825e124724SVadim Bendebury		CONFIG_GENERIC_LPC_TPM
11835e124724SVadim Bendebury		Support for generic parallel port TPM devices. Only one device
11845e124724SVadim Bendebury		per system is supported at this time.
11855e124724SVadim Bendebury
11865e124724SVadim Bendebury			CONFIG_TPM_TIS_BASE_ADDRESS
11875e124724SVadim Bendebury			Base address where the generic TPM device is mapped
11885e124724SVadim Bendebury			to. Contemporary x86 systems usually map it at
11895e124724SVadim Bendebury			0xfed40000.
11905e124724SVadim Bendebury
1191c609719bSwdenk- USB Support:
1192c609719bSwdenk		At the moment only the UHCI host controller is
11934d13cbadSwdenk		supported (PIP405, MIP405, MPC5200); define
1194c609719bSwdenk		CONFIG_USB_UHCI to enable it.
1195c609719bSwdenk		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
119630d56faeSwdenk		and define CONFIG_USB_STORAGE to enable the USB
1197c609719bSwdenk		storage devices.
1198c609719bSwdenk		Note:
1199c609719bSwdenk		Supported are USB Keyboards and USB Floppy drives
1200c609719bSwdenk		(TEAC FD-05PUB).
12014d13cbadSwdenk		MPC5200 USB requires additional defines:
12024d13cbadSwdenk			CONFIG_USB_CLOCK
12034d13cbadSwdenk				for 528 MHz Clock: 0x0001bbbb
1204307ecb6dSEric Millbrandt			CONFIG_PSC3_USB
1205307ecb6dSEric Millbrandt				for USB on PSC3
12064d13cbadSwdenk			CONFIG_USB_CONFIG
12074d13cbadSwdenk				for differential drivers: 0x00001000
12084d13cbadSwdenk				for single ended drivers: 0x00005000
1209307ecb6dSEric Millbrandt				for differential drivers on PSC3: 0x00000100
1210307ecb6dSEric Millbrandt				for single ended drivers on PSC3: 0x00004100
12116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_USB_EVENT_POLL
1212fdcfaa1bSZhang Wei				May be defined to allow interrupt polling
1213fdcfaa1bSZhang Wei				instead of using asynchronous interrupts
12144d13cbadSwdenk
12159ab4ce22SSimon Glass		CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
12169ab4ce22SSimon Glass		txfilltuning field in the EHCI controller on reset.
12179ab4ce22SSimon Glass
121816c8d5e7SWolfgang Denk- USB Device:
121916c8d5e7SWolfgang Denk		Define the below if you wish to use the USB console.
122016c8d5e7SWolfgang Denk		Once firmware is rebuilt from a serial console issue the
122116c8d5e7SWolfgang Denk		command "setenv stdin usbtty; setenv stdout usbtty" and
122211ccc33fSMarcel Ziswiler		attach your USB cable. The Unix command "dmesg" should print
122316c8d5e7SWolfgang Denk		it has found a new device. The environment variable usbtty
122416c8d5e7SWolfgang Denk		can be set to gserial or cdc_acm to enable your device to
122516c8d5e7SWolfgang Denk		appear to a USB host as a Linux gserial device or a
122616c8d5e7SWolfgang Denk		Common Device Class Abstract Control Model serial device.
122716c8d5e7SWolfgang Denk		If you select usbtty = gserial you should be able to enumerate
122816c8d5e7SWolfgang Denk		a Linux host by
122916c8d5e7SWolfgang Denk		# modprobe usbserial vendor=0xVendorID product=0xProductID
123016c8d5e7SWolfgang Denk		else if using cdc_acm, simply setting the environment
123116c8d5e7SWolfgang Denk		variable usbtty to be cdc_acm should suffice. The following
123216c8d5e7SWolfgang Denk		might be defined in YourBoardName.h
123316c8d5e7SWolfgang Denk
123416c8d5e7SWolfgang Denk			CONFIG_USB_DEVICE
123516c8d5e7SWolfgang Denk			Define this to build a UDC device
123616c8d5e7SWolfgang Denk
123716c8d5e7SWolfgang Denk			CONFIG_USB_TTY
123816c8d5e7SWolfgang Denk			Define this to have a tty type of device available to
123916c8d5e7SWolfgang Denk			talk to the UDC device
124016c8d5e7SWolfgang Denk
1241f9da0f89SVipin KUMAR			CONFIG_USBD_HS
1242f9da0f89SVipin KUMAR			Define this to enable the high speed support for usb
1243f9da0f89SVipin KUMAR			device and usbtty. If this feature is enabled, a routine
1244f9da0f89SVipin KUMAR			int is_usbd_high_speed(void)
1245f9da0f89SVipin KUMAR			also needs to be defined by the driver to dynamically poll
1246f9da0f89SVipin KUMAR			whether the enumeration has succeded at high speed or full
1247f9da0f89SVipin KUMAR			speed.
1248f9da0f89SVipin KUMAR
12496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_IS_IN_ENV
125016c8d5e7SWolfgang Denk			Define this if you want stdin, stdout &/or stderr to
125116c8d5e7SWolfgang Denk			be set to usbtty.
125216c8d5e7SWolfgang Denk
125316c8d5e7SWolfgang Denk			mpc8xx:
12546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_EXTC_CLK 0xBLAH
125516c8d5e7SWolfgang Denk				Derive USB clock from external clock "blah"
12566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_EXTC_CLK 0x02
125716c8d5e7SWolfgang Denk
12586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_BRG_CLK 0xBLAH
125916c8d5e7SWolfgang Denk				Derive USB clock from brgclk
12606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_BRG_CLK 0x04
126116c8d5e7SWolfgang Denk
126216c8d5e7SWolfgang Denk		If you have a USB-IF assigned VendorID then you may wish to
126316c8d5e7SWolfgang Denk		define your own vendor specific values either in BoardName.h
126416c8d5e7SWolfgang Denk		or directly in usbd_vendor_info.h. If you don't define
126516c8d5e7SWolfgang Denk		CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
126616c8d5e7SWolfgang Denk		CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
126716c8d5e7SWolfgang Denk		should pretend to be a Linux device to it's target host.
126816c8d5e7SWolfgang Denk
126916c8d5e7SWolfgang Denk			CONFIG_USBD_MANUFACTURER
127016c8d5e7SWolfgang Denk			Define this string as the name of your company for
127116c8d5e7SWolfgang Denk			- CONFIG_USBD_MANUFACTURER "my company"
127216c8d5e7SWolfgang Denk
127316c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCT_NAME
127416c8d5e7SWolfgang Denk			Define this string as the name of your product
127516c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCT_NAME "acme usb device"
127616c8d5e7SWolfgang Denk
127716c8d5e7SWolfgang Denk			CONFIG_USBD_VENDORID
127816c8d5e7SWolfgang Denk			Define this as your assigned Vendor ID from the USB
127916c8d5e7SWolfgang Denk			Implementors Forum. This *must* be a genuine Vendor ID
128016c8d5e7SWolfgang Denk			to avoid polluting the USB namespace.
128116c8d5e7SWolfgang Denk			- CONFIG_USBD_VENDORID 0xFFFF
128216c8d5e7SWolfgang Denk
128316c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCTID
128416c8d5e7SWolfgang Denk			Define this as the unique Product ID
128516c8d5e7SWolfgang Denk			for your device
128616c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCTID 0xFFFF
1287c609719bSwdenk
1288d70a560fSIgor Grinberg- ULPI Layer Support:
1289d70a560fSIgor Grinberg		The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1290d70a560fSIgor Grinberg		the generic ULPI layer. The generic layer accesses the ULPI PHY
1291d70a560fSIgor Grinberg		via the platform viewport, so you need both the genric layer and
1292d70a560fSIgor Grinberg		the viewport enabled. Currently only Chipidea/ARC based
1293d70a560fSIgor Grinberg		viewport is supported.
1294d70a560fSIgor Grinberg		To enable the ULPI layer support, define CONFIG_USB_ULPI and
1295d70a560fSIgor Grinberg		CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
12966d365ea0SLucas Stach		If your ULPI phy needs a different reference clock than the
12976d365ea0SLucas Stach		standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
12986d365ea0SLucas Stach		the appropriate value in Hz.
1299c609719bSwdenk
1300c609719bSwdenk- MMC Support:
1301c609719bSwdenk		The MMC controller on the Intel PXA is supported. To
1302c609719bSwdenk		enable this define CONFIG_MMC. The MMC can be
1303c609719bSwdenk		accessed from the boot prompt by mapping the device
1304c609719bSwdenk		to physical memory similar to flash. Command line is
1305602ad3b3SJon Loeliger		enabled with CONFIG_CMD_MMC. The MMC driver also works with
1306602ad3b3SJon Loeliger		the FAT fs. This is enabled with CONFIG_CMD_FAT.
1307c609719bSwdenk
1308afb35666SYoshihiro Shimoda		CONFIG_SH_MMCIF
1309afb35666SYoshihiro Shimoda		Support for Renesas on-chip MMCIF controller
1310afb35666SYoshihiro Shimoda
1311afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_ADDR
1312afb35666SYoshihiro Shimoda			Define the base address of MMCIF registers
1313afb35666SYoshihiro Shimoda
1314afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_CLK
1315afb35666SYoshihiro Shimoda			Define the clock frequency for MMCIF
1316afb35666SYoshihiro Shimoda
13176705d81eSwdenk- Journaling Flash filesystem support:
13186705d81eSwdenk		CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
13196705d81eSwdenk		CONFIG_JFFS2_NAND_DEV
13206705d81eSwdenk		Define these for a default partition on a NAND device
13216705d81eSwdenk
13226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_SECTOR,
13236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
13246705d81eSwdenk		Define these for a default partition on a NOR device
13256705d81eSwdenk
13266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS_CUSTOM_PART
13276705d81eSwdenk		Define this to create an own partition. You have to provide a
13286705d81eSwdenk		function struct part_info* jffs2_part_info(int part_num)
13296705d81eSwdenk
13306705d81eSwdenk		If you define only one JFFS2 partition you may also want to
13316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_JFFS_SINGLE_PART	1
13326705d81eSwdenk		to disable the command chpart. This is the default when you
13336705d81eSwdenk		have not defined a custom partition
13346705d81eSwdenk
1335c30a15e5SDonggeun Kim- FAT(File Allocation Table) filesystem write function support:
1336c30a15e5SDonggeun Kim		CONFIG_FAT_WRITE
1337656f4c65SDonggeun Kim
1338656f4c65SDonggeun Kim		Define this to enable support for saving memory data as a
1339656f4c65SDonggeun Kim		file in FAT formatted partition.
1340656f4c65SDonggeun Kim
1341656f4c65SDonggeun Kim		This will also enable the command "fatwrite" enabling the
1342656f4c65SDonggeun Kim		user to write files to FAT.
1343c30a15e5SDonggeun Kim
134484cd9327SGabe BlackCBFS (Coreboot Filesystem) support
134584cd9327SGabe Black		CONFIG_CMD_CBFS
134684cd9327SGabe Black
134784cd9327SGabe Black		Define this to enable support for reading from a Coreboot
134884cd9327SGabe Black		filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
134984cd9327SGabe Black		and cbfsload.
135084cd9327SGabe Black
1351c609719bSwdenk- Keyboard Support:
1352c609719bSwdenk		CONFIG_ISA_KEYBOARD
1353c609719bSwdenk
1354c609719bSwdenk		Define this to enable standard (PC-Style) keyboard
1355c609719bSwdenk		support
1356c609719bSwdenk
1357c609719bSwdenk		CONFIG_I8042_KBD
1358c609719bSwdenk		Standard PC keyboard driver with US (is default) and
1359c609719bSwdenk		GERMAN key layout (switch via environment 'keymap=de') support.
1360c609719bSwdenk		Export function i8042_kbd_init, i8042_tstc and i8042_getc
1361c609719bSwdenk		for cfb_console. Supports cursor blinking.
1362c609719bSwdenk
1363c609719bSwdenk- Video support:
1364c609719bSwdenk		CONFIG_VIDEO
1365c609719bSwdenk
1366c609719bSwdenk		Define this to enable video support (for output to
1367c609719bSwdenk		video).
1368c609719bSwdenk
1369c609719bSwdenk		CONFIG_VIDEO_CT69000
1370c609719bSwdenk
1371c609719bSwdenk		Enable Chips & Technologies 69000 Video chip
1372c609719bSwdenk
1373c609719bSwdenk		CONFIG_VIDEO_SMI_LYNXEM
1374eeb1b77bSwdenk		Enable Silicon Motion SMI 712/710/810 Video chip. The
1375eeb1b77bSwdenk		video output is selected via environment 'videoout'
1376eeb1b77bSwdenk		(1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1377eeb1b77bSwdenk		assumed.
1378c609719bSwdenk
1379eeb1b77bSwdenk		For the CT69000 and SMI_LYNXEM drivers, videomode is
138011ccc33fSMarcel Ziswiler		selected via environment 'videomode'. Two different ways
1381eeb1b77bSwdenk		are possible:
1382eeb1b77bSwdenk		- "videomode=num"   'num' is a standard LiLo mode numbers.
1383eeb1b77bSwdenk		Following standard modes are supported	(* is default):
1384eeb1b77bSwdenk
1385eeb1b77bSwdenk		      Colors	640x480 800x600 1024x768 1152x864 1280x1024
1386eeb1b77bSwdenk		-------------+---------------------------------------------
1387eeb1b77bSwdenk		      8 bits |	0x301*	0x303	 0x305	  0x161	    0x307
1388eeb1b77bSwdenk		     15 bits |	0x310	0x313	 0x316	  0x162	    0x319
1389eeb1b77bSwdenk		     16 bits |	0x311	0x314	 0x317	  0x163	    0x31A
1390eeb1b77bSwdenk		     24 bits |	0x312	0x315	 0x318	    ?	    0x31B
1391eeb1b77bSwdenk		-------------+---------------------------------------------
1392c609719bSwdenk		(i.e. setenv videomode 317; saveenv; reset;)
1393c609719bSwdenk
1394eeb1b77bSwdenk		- "videomode=bootargs" all the video parameters are parsed
13957817cb20SMarcel Ziswiler		from the bootargs. (See drivers/video/videomodes.c)
1396eeb1b77bSwdenk
1397eeb1b77bSwdenk
1398a6c7ad2fSwdenk		CONFIG_VIDEO_SED13806
1399a6c7ad2fSwdenk		Enable Epson SED13806 driver. This driver supports 8bpp
1400a6c7ad2fSwdenk		and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1401a6c7ad2fSwdenk		or CONFIG_VIDEO_SED13806_16BPP
1402a6c7ad2fSwdenk
14037d3053fbSTimur Tabi		CONFIG_FSL_DIU_FB
14047d3053fbSTimur Tabi		Enable the Freescale DIU video driver.	Reference boards for
14057d3053fbSTimur Tabi		SOCs that have a DIU should define this macro to enable DIU
14067d3053fbSTimur Tabi		support, and should also define these other macros:
14077d3053fbSTimur Tabi
14087d3053fbSTimur Tabi			CONFIG_SYS_DIU_ADDR
14097d3053fbSTimur Tabi			CONFIG_VIDEO
14107d3053fbSTimur Tabi			CONFIG_CMD_BMP
14117d3053fbSTimur Tabi			CONFIG_CFB_CONSOLE
14127d3053fbSTimur Tabi			CONFIG_VIDEO_SW_CURSOR
14137d3053fbSTimur Tabi			CONFIG_VGA_AS_SINGLE_DEVICE
14147d3053fbSTimur Tabi			CONFIG_VIDEO_LOGO
14157d3053fbSTimur Tabi			CONFIG_VIDEO_BMP_LOGO
14167d3053fbSTimur Tabi
1417ba8e76bdSTimur Tabi		The DIU driver will look for the 'video-mode' environment
1418ba8e76bdSTimur Tabi		variable, and if defined, enable the DIU as a console during
1419ba8e76bdSTimur Tabi		boot.  See the documentation file README.video for a
1420ba8e76bdSTimur Tabi		description of this variable.
14217d3053fbSTimur Tabi
1422058d59b0SSimon Glass		CONFIG_VIDEO_VGA
1423058d59b0SSimon Glass
1424058d59b0SSimon Glass		Enable the VGA video / BIOS for x86. The alternative if you
1425058d59b0SSimon Glass		are using coreboot is to use the coreboot frame buffer
1426058d59b0SSimon Glass		driver.
1427058d59b0SSimon Glass
1428058d59b0SSimon Glass
1429682011ffSwdenk- Keyboard Support:
1430682011ffSwdenk		CONFIG_KEYBOARD
1431682011ffSwdenk
1432682011ffSwdenk		Define this to enable a custom keyboard support.
1433682011ffSwdenk		This simply calls drv_keyboard_init() which must be
1434682011ffSwdenk		defined in your board-specific files.
1435682011ffSwdenk		The only board using this so far is RBC823.
1436a6c7ad2fSwdenk
1437c609719bSwdenk- LCD Support:	CONFIG_LCD
1438c609719bSwdenk
1439c609719bSwdenk		Define this to enable LCD support (for output to LCD
1440c609719bSwdenk		display); also select one of the supported displays
1441c609719bSwdenk		by defining one of these:
1442c609719bSwdenk
144339cf4804SStelian Pop		CONFIG_ATMEL_LCD:
144439cf4804SStelian Pop
144539cf4804SStelian Pop			HITACHI TX09D70VM1CCA, 3.5", 240x320.
144639cf4804SStelian Pop
1447fd3103bbSwdenk		CONFIG_NEC_NL6448AC33:
1448c609719bSwdenk
1449fd3103bbSwdenk			NEC NL6448AC33-18. Active, color, single scan.
1450c609719bSwdenk
1451fd3103bbSwdenk		CONFIG_NEC_NL6448BC20
1452c609719bSwdenk
1453fd3103bbSwdenk			NEC NL6448BC20-08. 6.5", 640x480.
1454fd3103bbSwdenk			Active, color, single scan.
1455fd3103bbSwdenk
1456fd3103bbSwdenk		CONFIG_NEC_NL6448BC33_54
1457fd3103bbSwdenk
1458fd3103bbSwdenk			NEC NL6448BC33-54. 10.4", 640x480.
1459c609719bSwdenk			Active, color, single scan.
1460c609719bSwdenk
1461c609719bSwdenk		CONFIG_SHARP_16x9
1462c609719bSwdenk
1463c609719bSwdenk			Sharp 320x240. Active, color, single scan.
1464c609719bSwdenk			It isn't 16x9, and I am not sure what it is.
1465c609719bSwdenk
1466c609719bSwdenk		CONFIG_SHARP_LQ64D341
1467c609719bSwdenk
1468c609719bSwdenk			Sharp LQ64D341 display, 640x480.
1469c609719bSwdenk			Active, color, single scan.
1470c609719bSwdenk
1471c609719bSwdenk		CONFIG_HLD1045
1472c609719bSwdenk
1473c609719bSwdenk			HLD1045 display, 640x480.
1474c609719bSwdenk			Active, color, single scan.
1475c609719bSwdenk
1476c609719bSwdenk		CONFIG_OPTREX_BW
1477c609719bSwdenk
1478c609719bSwdenk			Optrex	 CBL50840-2 NF-FW 99 22 M5
1479c609719bSwdenk			or
1480c609719bSwdenk			Hitachi	 LMG6912RPFC-00T
1481c609719bSwdenk			or
1482c609719bSwdenk			Hitachi	 SP14Q002
1483c609719bSwdenk
1484c609719bSwdenk			320x240. Black & white.
1485c609719bSwdenk
1486c609719bSwdenk		Normally display is black on white background; define
14876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
1488c609719bSwdenk
148945d7f525STom Wai-Hong Tam		CONFIG_LCD_BMP_RLE8
149045d7f525STom Wai-Hong Tam
149145d7f525STom Wai-Hong Tam		Support drawing of RLE8-compressed bitmaps on the LCD.
149245d7f525STom Wai-Hong Tam
1493735987c5STom Wai-Hong Tam		CONFIG_I2C_EDID
1494735987c5STom Wai-Hong Tam
1495735987c5STom Wai-Hong Tam		Enables an 'i2c edid' command which can read EDID
1496735987c5STom Wai-Hong Tam		information over I2C from an attached LCD display.
1497735987c5STom Wai-Hong Tam
149845d7f525STom Wai-Hong Tam
14997152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN
1500d791b1dcSwdenk
1501d791b1dcSwdenk		If this option is set, the environment is checked for
1502d791b1dcSwdenk		a variable "splashimage". If found, the usual display
1503d791b1dcSwdenk		of logo, copyright and system information on the LCD
1504e94d2cd9Swdenk		is suppressed and the BMP image at the address
1505d791b1dcSwdenk		specified in "splashimage" is loaded instead. The
1506d791b1dcSwdenk		console is redirected to the "nulldev", too. This
1507d791b1dcSwdenk		allows for a "silent" boot where a splash screen is
1508d791b1dcSwdenk		loaded very quickly after power-on.
1509d791b1dcSwdenk
15101ca298ceSMatthias Weisser		CONFIG_SPLASH_SCREEN_ALIGN
15111ca298ceSMatthias Weisser
15121ca298ceSMatthias Weisser		If this option is set the splash image can be freely positioned
15131ca298ceSMatthias Weisser		on the screen. Environment variable "splashpos" specifies the
15141ca298ceSMatthias Weisser		position as "x,y". If a positive number is given it is used as
15151ca298ceSMatthias Weisser		number of pixel from left/top. If a negative number is given it
15161ca298ceSMatthias Weisser		is used as number of pixel from right/bottom. You can also
15171ca298ceSMatthias Weisser		specify 'm' for centering the image.
15181ca298ceSMatthias Weisser
15191ca298ceSMatthias Weisser		Example:
15201ca298ceSMatthias Weisser		setenv splashpos m,m
15211ca298ceSMatthias Weisser			=> image at center of screen
15221ca298ceSMatthias Weisser
15231ca298ceSMatthias Weisser		setenv splashpos 30,20
15241ca298ceSMatthias Weisser			=> image at x = 30 and y = 20
15251ca298ceSMatthias Weisser
15261ca298ceSMatthias Weisser		setenv splashpos -10,m
15271ca298ceSMatthias Weisser			=> vertically centered image
15281ca298ceSMatthias Weisser			   at x = dspWidth - bmpWidth - 9
15291ca298ceSMatthias Weisser
153098f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
153198f4a3dfSStefan Roese
153298f4a3dfSStefan Roese		If this option is set, additionally to standard BMP
153398f4a3dfSStefan Roese		images, gzipped BMP images can be displayed via the
153498f4a3dfSStefan Roese		splashscreen support or the bmp command.
153598f4a3dfSStefan Roese
1536d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1537d5011762SAnatolij Gustschin
1538d5011762SAnatolij Gustschin		If this option is set, 8-bit RLE compressed BMP images
1539d5011762SAnatolij Gustschin		can be displayed via the splashscreen support or the
1540d5011762SAnatolij Gustschin		bmp command.
1541d5011762SAnatolij Gustschin
1542f2b96dfbSLei Wen- Do compresssing for memory range:
1543f2b96dfbSLei Wen		CONFIG_CMD_ZIP
1544f2b96dfbSLei Wen
1545f2b96dfbSLei Wen		If this option is set, it would use zlib deflate method
1546f2b96dfbSLei Wen		to compress the specified memory at its best effort.
1547f2b96dfbSLei Wen
1548c29fdfc1Swdenk- Compression support:
1549c29fdfc1Swdenk		CONFIG_BZIP2
1550c29fdfc1Swdenk
1551c29fdfc1Swdenk		If this option is set, support for bzip2 compressed
1552c29fdfc1Swdenk		images is included. If not, only uncompressed and gzip
1553c29fdfc1Swdenk		compressed images are supported.
1554c29fdfc1Swdenk
1555c29fdfc1Swdenk		NOTE: the bzip2 algorithm requires a lot of RAM, so
15566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
1557c29fdfc1Swdenk		be at least 4MB.
1558d791b1dcSwdenk
1559fc9c1727SLuigi 'Comio' Mantellini		CONFIG_LZMA
1560fc9c1727SLuigi 'Comio' Mantellini
1561fc9c1727SLuigi 'Comio' Mantellini		If this option is set, support for lzma compressed
1562fc9c1727SLuigi 'Comio' Mantellini		images is included.
1563fc9c1727SLuigi 'Comio' Mantellini
1564fc9c1727SLuigi 'Comio' Mantellini		Note: The LZMA algorithm adds between 2 and 4KB of code and it
1565fc9c1727SLuigi 'Comio' Mantellini		requires an amount of dynamic memory that is given by the
1566fc9c1727SLuigi 'Comio' Mantellini		formula:
1567fc9c1727SLuigi 'Comio' Mantellini
1568fc9c1727SLuigi 'Comio' Mantellini			(1846 + 768 << (lc + lp)) * sizeof(uint16)
1569fc9c1727SLuigi 'Comio' Mantellini
1570fc9c1727SLuigi 'Comio' Mantellini		Where lc and lp stand for, respectively, Literal context bits
1571fc9c1727SLuigi 'Comio' Mantellini		and Literal pos bits.
1572fc9c1727SLuigi 'Comio' Mantellini
1573fc9c1727SLuigi 'Comio' Mantellini		This value is upper-bounded by 14MB in the worst case. Anyway,
1574fc9c1727SLuigi 'Comio' Mantellini		for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1575fc9c1727SLuigi 'Comio' Mantellini		total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1576fc9c1727SLuigi 'Comio' Mantellini		a very small buffer.
1577fc9c1727SLuigi 'Comio' Mantellini
1578fc9c1727SLuigi 'Comio' Mantellini		Use the lzmainfo tool to determinate the lc and lp values and
1579fc9c1727SLuigi 'Comio' Mantellini		then calculate the amount of needed dynamic memory (ensuring
15806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the appropriate CONFIG_SYS_MALLOC_LEN value).
1581fc9c1727SLuigi 'Comio' Mantellini
158217ea1177Swdenk- MII/PHY support:
158317ea1177Swdenk		CONFIG_PHY_ADDR
158417ea1177Swdenk
158517ea1177Swdenk		The address of PHY on MII bus.
158617ea1177Swdenk
158717ea1177Swdenk		CONFIG_PHY_CLOCK_FREQ (ppc4xx)
158817ea1177Swdenk
158917ea1177Swdenk		The clock frequency of the MII bus
159017ea1177Swdenk
159117ea1177Swdenk		CONFIG_PHY_GIGE
159217ea1177Swdenk
159317ea1177Swdenk		If this option is set, support for speed/duplex
159411ccc33fSMarcel Ziswiler		detection of gigabit PHY is included.
159517ea1177Swdenk
159617ea1177Swdenk		CONFIG_PHY_RESET_DELAY
159717ea1177Swdenk
159817ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
159917ea1177Swdenk		reset before any MII register access is possible.
160017ea1177Swdenk		For such PHY, set this option to the usec delay
160117ea1177Swdenk		required. (minimum 300usec for LXT971A)
160217ea1177Swdenk
160317ea1177Swdenk		CONFIG_PHY_CMD_DELAY (ppc4xx)
160417ea1177Swdenk
160517ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
160617ea1177Swdenk		command issued before MII status register can be read
160717ea1177Swdenk
1608c609719bSwdenk- Ethernet address:
1609c609719bSwdenk		CONFIG_ETHADDR
1610c68a05feSrichardretanubun		CONFIG_ETH1ADDR
1611c609719bSwdenk		CONFIG_ETH2ADDR
1612c609719bSwdenk		CONFIG_ETH3ADDR
1613c68a05feSrichardretanubun		CONFIG_ETH4ADDR
1614c68a05feSrichardretanubun		CONFIG_ETH5ADDR
1615c609719bSwdenk
161611ccc33fSMarcel Ziswiler		Define a default value for Ethernet address to use
161711ccc33fSMarcel Ziswiler		for the respective Ethernet interface, in case this
1618c609719bSwdenk		is not determined automatically.
1619c609719bSwdenk
1620c609719bSwdenk- IP address:
1621c609719bSwdenk		CONFIG_IPADDR
1622c609719bSwdenk
1623c609719bSwdenk		Define a default value for the IP address to use for
162411ccc33fSMarcel Ziswiler		the default Ethernet interface, in case this is not
1625c609719bSwdenk		determined through e.g. bootp.
16261ebcd654SWolfgang Denk		(Environment variable "ipaddr")
1627c609719bSwdenk
1628c609719bSwdenk- Server IP address:
1629c609719bSwdenk		CONFIG_SERVERIP
1630c609719bSwdenk
1631c609719bSwdenk		Defines a default value for the IP address of a TFTP
1632c609719bSwdenk		server to contact when using the "tftboot" command.
16331ebcd654SWolfgang Denk		(Environment variable "serverip")
1634c609719bSwdenk
163597cfe861SRobin Getz		CONFIG_KEEP_SERVERADDR
163697cfe861SRobin Getz
163797cfe861SRobin Getz		Keeps the server's MAC address, in the env 'serveraddr'
163897cfe861SRobin Getz		for passing to bootargs (like Linux's netconsole option)
163997cfe861SRobin Getz
16401ebcd654SWolfgang Denk- Gateway IP address:
16411ebcd654SWolfgang Denk		CONFIG_GATEWAYIP
16421ebcd654SWolfgang Denk
16431ebcd654SWolfgang Denk		Defines a default value for the IP address of the
16441ebcd654SWolfgang Denk		default router where packets to other networks are
16451ebcd654SWolfgang Denk		sent to.
16461ebcd654SWolfgang Denk		(Environment variable "gatewayip")
16471ebcd654SWolfgang Denk
16481ebcd654SWolfgang Denk- Subnet mask:
16491ebcd654SWolfgang Denk		CONFIG_NETMASK
16501ebcd654SWolfgang Denk
16511ebcd654SWolfgang Denk		Defines a default value for the subnet mask (or
16521ebcd654SWolfgang Denk		routing prefix) which is used to determine if an IP
16531ebcd654SWolfgang Denk		address belongs to the local subnet or needs to be
16541ebcd654SWolfgang Denk		forwarded through a router.
16551ebcd654SWolfgang Denk		(Environment variable "netmask")
16561ebcd654SWolfgang Denk
165753a5c424SDavid Updegraff- Multicast TFTP Mode:
165853a5c424SDavid Updegraff		CONFIG_MCAST_TFTP
165953a5c424SDavid Updegraff
166053a5c424SDavid Updegraff		Defines whether you want to support multicast TFTP as per
166153a5c424SDavid Updegraff		rfc-2090; for example to work with atftp.  Lets lots of targets
166211ccc33fSMarcel Ziswiler		tftp down the same boot image concurrently.  Note: the Ethernet
166353a5c424SDavid Updegraff		driver in use must provide a function: mcast() to join/leave a
166453a5c424SDavid Updegraff		multicast group.
166553a5c424SDavid Updegraff
1666c609719bSwdenk- BOOTP Recovery Mode:
1667c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY
1668c609719bSwdenk
1669c609719bSwdenk		If you have many targets in a network that try to
1670c609719bSwdenk		boot using BOOTP, you may want to avoid that all
1671c609719bSwdenk		systems send out BOOTP requests at precisely the same
1672c609719bSwdenk		moment (which would happen for instance at recovery
1673c609719bSwdenk		from a power failure, when all systems will try to
1674c609719bSwdenk		boot, thus flooding the BOOTP server. Defining
1675c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1676c609719bSwdenk		inserted before sending out BOOTP requests. The
16776c33c785SWolfgang Denk		following delays are inserted then:
1678c609719bSwdenk
1679c609719bSwdenk		1st BOOTP request:	delay 0 ... 1 sec
1680c609719bSwdenk		2nd BOOTP request:	delay 0 ... 2 sec
1681c609719bSwdenk		3rd BOOTP request:	delay 0 ... 4 sec
1682c609719bSwdenk		4th and following
1683c609719bSwdenk		BOOTP requests:		delay 0 ... 8 sec
1684c609719bSwdenk
1685fe389a82Sstroese- DHCP Advanced Options:
16861fe80d79SJon Loeliger		You can fine tune the DHCP functionality by defining
16871fe80d79SJon Loeliger		CONFIG_BOOTP_* symbols:
1688fe389a82Sstroese
16891fe80d79SJon Loeliger		CONFIG_BOOTP_SUBNETMASK
16901fe80d79SJon Loeliger		CONFIG_BOOTP_GATEWAY
16911fe80d79SJon Loeliger		CONFIG_BOOTP_HOSTNAME
16921fe80d79SJon Loeliger		CONFIG_BOOTP_NISDOMAIN
16931fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTPATH
16941fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTFILESIZE
16951fe80d79SJon Loeliger		CONFIG_BOOTP_DNS
16961fe80d79SJon Loeliger		CONFIG_BOOTP_DNS2
16971fe80d79SJon Loeliger		CONFIG_BOOTP_SEND_HOSTNAME
16981fe80d79SJon Loeliger		CONFIG_BOOTP_NTPSERVER
16991fe80d79SJon Loeliger		CONFIG_BOOTP_TIMEOFFSET
17001fe80d79SJon Loeliger		CONFIG_BOOTP_VENDOREX
17012c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL
1702fe389a82Sstroese
17035d110f0aSWilson Callan		CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
17045d110f0aSWilson Callan		environment variable, not the BOOTP server.
1705fe389a82Sstroese
17062c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
17072c00e099SJoe Hershberger		after the configured retry count, the call will fail
17082c00e099SJoe Hershberger		instead of starting over.  This can be used to fail over
17092c00e099SJoe Hershberger		to Link-local IP address configuration if the DHCP server
17102c00e099SJoe Hershberger		is not available.
17112c00e099SJoe Hershberger
1712fe389a82Sstroese		CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1713fe389a82Sstroese		serverip from a DHCP server, it is possible that more
1714fe389a82Sstroese		than one DNS serverip is offered to the client.
1715fe389a82Sstroese		If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1716fe389a82Sstroese		serverip will be stored in the additional environment
1717fe389a82Sstroese		variable "dnsip2". The first DNS serverip is always
1718fe389a82Sstroese		stored in the variable "dnsip", when CONFIG_BOOTP_DNS
17191fe80d79SJon Loeliger		is defined.
1720fe389a82Sstroese
1721fe389a82Sstroese		CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1722fe389a82Sstroese		to do a dynamic update of a DNS server. To do this, they
1723fe389a82Sstroese		need the hostname of the DHCP requester.
17245d110f0aSWilson Callan		If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
17251fe80d79SJon Loeliger		of the "hostname" environment variable is passed as
17261fe80d79SJon Loeliger		option 12 to the DHCP server.
1727fe389a82Sstroese
1728d9a2f416SAras Vaichas		CONFIG_BOOTP_DHCP_REQUEST_DELAY
1729d9a2f416SAras Vaichas
1730d9a2f416SAras Vaichas		A 32bit value in microseconds for a delay between
1731d9a2f416SAras Vaichas		receiving a "DHCP Offer" and sending the "DHCP Request".
1732d9a2f416SAras Vaichas		This fixes a problem with certain DHCP servers that don't
1733d9a2f416SAras Vaichas		respond 100% of the time to a "DHCP request". E.g. On an
1734d9a2f416SAras Vaichas		AT91RM9200 processor running at 180MHz, this delay needed
1735d9a2f416SAras Vaichas		to be *at least* 15,000 usec before a Windows Server 2003
1736d9a2f416SAras Vaichas		DHCP server would reply 100% of the time. I recommend at
1737d9a2f416SAras Vaichas		least 50,000 usec to be safe. The alternative is to hope
1738d9a2f416SAras Vaichas		that one of the retries will be successful but note that
1739d9a2f416SAras Vaichas		the DHCP timeout and retry process takes a longer than
1740d9a2f416SAras Vaichas		this delay.
1741d9a2f416SAras Vaichas
1742d22c338eSJoe Hershberger - Link-local IP address negotiation:
1743d22c338eSJoe Hershberger		Negotiate with other link-local clients on the local network
1744d22c338eSJoe Hershberger		for an address that doesn't require explicit configuration.
1745d22c338eSJoe Hershberger		This is especially useful if a DHCP server cannot be guaranteed
1746d22c338eSJoe Hershberger		to exist in all environments that the device must operate.
1747d22c338eSJoe Hershberger
1748d22c338eSJoe Hershberger		See doc/README.link-local for more information.
1749d22c338eSJoe Hershberger
1750a3d991bdSwdenk - CDP Options:
1751a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID
1752a3d991bdSwdenk
1753a3d991bdSwdenk		The device id used in CDP trigger frames.
1754a3d991bdSwdenk
1755a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID_PREFIX
1756a3d991bdSwdenk
1757a3d991bdSwdenk		A two character string which is prefixed to the MAC address
1758a3d991bdSwdenk		of the device.
1759a3d991bdSwdenk
1760a3d991bdSwdenk		CONFIG_CDP_PORT_ID
1761a3d991bdSwdenk
1762a3d991bdSwdenk		A printf format string which contains the ascii name of
1763a3d991bdSwdenk		the port. Normally is set to "eth%d" which sets
176411ccc33fSMarcel Ziswiler		eth0 for the first Ethernet, eth1 for the second etc.
1765a3d991bdSwdenk
1766a3d991bdSwdenk		CONFIG_CDP_CAPABILITIES
1767a3d991bdSwdenk
1768a3d991bdSwdenk		A 32bit integer which indicates the device capabilities;
1769a3d991bdSwdenk		0x00000010 for a normal host which does not forwards.
1770a3d991bdSwdenk
1771a3d991bdSwdenk		CONFIG_CDP_VERSION
1772a3d991bdSwdenk
1773a3d991bdSwdenk		An ascii string containing the version of the software.
1774a3d991bdSwdenk
1775a3d991bdSwdenk		CONFIG_CDP_PLATFORM
1776a3d991bdSwdenk
1777a3d991bdSwdenk		An ascii string containing the name of the platform.
1778a3d991bdSwdenk
1779a3d991bdSwdenk		CONFIG_CDP_TRIGGER
1780a3d991bdSwdenk
1781a3d991bdSwdenk		A 32bit integer sent on the trigger.
1782a3d991bdSwdenk
1783a3d991bdSwdenk		CONFIG_CDP_POWER_CONSUMPTION
1784a3d991bdSwdenk
1785a3d991bdSwdenk		A 16bit integer containing the power consumption of the
1786a3d991bdSwdenk		device in .1 of milliwatts.
1787a3d991bdSwdenk
1788a3d991bdSwdenk		CONFIG_CDP_APPLIANCE_VLAN_TYPE
1789a3d991bdSwdenk
1790a3d991bdSwdenk		A byte containing the id of the VLAN.
1791a3d991bdSwdenk
1792c609719bSwdenk- Status LED:	CONFIG_STATUS_LED
1793c609719bSwdenk
1794c609719bSwdenk		Several configurations allow to display the current
1795c609719bSwdenk		status using a LED. For instance, the LED will blink
1796c609719bSwdenk		fast while running U-Boot code, stop blinking as
1797c609719bSwdenk		soon as a reply to a BOOTP request was received, and
1798c609719bSwdenk		start blinking slow once the Linux kernel is running
1799c609719bSwdenk		(supported by a status LED driver in the Linux
1800c609719bSwdenk		kernel). Defining CONFIG_STATUS_LED enables this
1801c609719bSwdenk		feature in U-Boot.
1802c609719bSwdenk
1803c609719bSwdenk- CAN Support:	CONFIG_CAN_DRIVER
1804c609719bSwdenk
1805c609719bSwdenk		Defining CONFIG_CAN_DRIVER enables CAN driver support
1806c609719bSwdenk		on those systems that support this (optional)
1807c609719bSwdenk		feature, like the TQM8xxL modules.
1808c609719bSwdenk
1809c609719bSwdenk- I2C Support:	CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1810c609719bSwdenk
1811b37c7e5eSwdenk		These enable I2C serial bus commands. Defining either of
1812b37c7e5eSwdenk		(but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
181311ccc33fSMarcel Ziswiler		include the appropriate I2C driver for the selected CPU.
1814c609719bSwdenk
1815b37c7e5eSwdenk		This will allow you to use i2c commands at the u-boot
1816602ad3b3SJon Loeliger		command line (as long as you set CONFIG_CMD_I2C in
1817b37c7e5eSwdenk		CONFIG_COMMANDS) and communicate with i2c based realtime
1818b37c7e5eSwdenk		clock chips. See common/cmd_i2c.c for a description of the
1819c609719bSwdenk		command line interface.
1820c609719bSwdenk
1821bb99ad6dSBen Warren		CONFIG_HARD_I2C selects a hardware I2C controller.
1822c609719bSwdenk
1823b37c7e5eSwdenk		CONFIG_SOFT_I2C configures u-boot to use a software (aka
1824b37c7e5eSwdenk		bit-banging) driver instead of CPM or similar hardware
1825b37c7e5eSwdenk		support for I2C.
1826c609719bSwdenk
1827b37c7e5eSwdenk		There are several other quantities that must also be
1828b37c7e5eSwdenk		defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
1829c609719bSwdenk
18306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		In both cases you will need to define CONFIG_SYS_I2C_SPEED
1831b37c7e5eSwdenk		to be the frequency (in Hz) at which you wish your i2c bus
18326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
183311ccc33fSMarcel Ziswiler		the CPU's i2c node address).
1834c609719bSwdenk
18358d321b81SPeter Tyser		Now, the u-boot i2c code for the mpc8xx
1836a47a12beSStefan Roese		(arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
18378d321b81SPeter Tyser		and so its address should therefore be cleared to 0 (See,
18388d321b81SPeter Tyser		eg, MPC823e User's Manual p.16-473). So, set
18398d321b81SPeter Tyser		CONFIG_SYS_I2C_SLAVE to 0.
1840b37c7e5eSwdenk
18415da71efaSEric Millbrandt		CONFIG_SYS_I2C_INIT_MPC5XXX
18425da71efaSEric Millbrandt
18435da71efaSEric Millbrandt		When a board is reset during an i2c bus transfer
18445da71efaSEric Millbrandt		chips might think that the current transfer is still
18455da71efaSEric Millbrandt		in progress.  Reset the slave devices by sending start
18465da71efaSEric Millbrandt		commands until the slave device responds.
18475da71efaSEric Millbrandt
1848b37c7e5eSwdenk		That's all that's required for CONFIG_HARD_I2C.
1849b37c7e5eSwdenk
1850b37c7e5eSwdenk		If you use the software i2c interface (CONFIG_SOFT_I2C)
1851b37c7e5eSwdenk		then the following macros need to be defined (examples are
1852b37c7e5eSwdenk		from include/configs/lwmon.h):
1853c609719bSwdenk
1854c609719bSwdenk		I2C_INIT
1855c609719bSwdenk
1856b37c7e5eSwdenk		(Optional). Any commands necessary to enable the I2C
1857c609719bSwdenk		controller or configure ports.
1858c609719bSwdenk
1859b37c7e5eSwdenk		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
1860b37c7e5eSwdenk
1861c609719bSwdenk		I2C_PORT
1862c609719bSwdenk
1863c609719bSwdenk		(Only for MPC8260 CPU). The I/O port to use (the code
1864c609719bSwdenk		assumes both bits are on the same port). Valid values
1865c609719bSwdenk		are 0..3 for ports A..D.
1866c609719bSwdenk
1867c609719bSwdenk		I2C_ACTIVE
1868c609719bSwdenk
1869c609719bSwdenk		The code necessary to make the I2C data line active
1870c609719bSwdenk		(driven).  If the data line is open collector, this
1871c609719bSwdenk		define can be null.
1872c609719bSwdenk
1873b37c7e5eSwdenk		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
1874b37c7e5eSwdenk
1875c609719bSwdenk		I2C_TRISTATE
1876c609719bSwdenk
1877c609719bSwdenk		The code necessary to make the I2C data line tri-stated
1878c609719bSwdenk		(inactive).  If the data line is open collector, this
1879c609719bSwdenk		define can be null.
1880c609719bSwdenk
1881b37c7e5eSwdenk		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1882b37c7e5eSwdenk
1883c609719bSwdenk		I2C_READ
1884c609719bSwdenk
1885c609719bSwdenk		Code that returns TRUE if the I2C data line is high,
1886c609719bSwdenk		FALSE if it is low.
1887c609719bSwdenk
1888b37c7e5eSwdenk		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1889b37c7e5eSwdenk
1890c609719bSwdenk		I2C_SDA(bit)
1891c609719bSwdenk
1892c609719bSwdenk		If <bit> is TRUE, sets the I2C data line high. If it
1893c609719bSwdenk		is FALSE, it clears it (low).
1894c609719bSwdenk
1895b37c7e5eSwdenk		eg: #define I2C_SDA(bit) \
1896b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
1897b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
1898b37c7e5eSwdenk
1899c609719bSwdenk		I2C_SCL(bit)
1900c609719bSwdenk
1901c609719bSwdenk		If <bit> is TRUE, sets the I2C clock line high. If it
1902c609719bSwdenk		is FALSE, it clears it (low).
1903c609719bSwdenk
1904b37c7e5eSwdenk		eg: #define I2C_SCL(bit) \
1905b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
1906b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
1907b37c7e5eSwdenk
1908c609719bSwdenk		I2C_DELAY
1909c609719bSwdenk
1910c609719bSwdenk		This delay is invoked four times per clock cycle so this
1911c609719bSwdenk		controls the rate of data transfer.  The data rate thus
1912b37c7e5eSwdenk		is 1 / (I2C_DELAY * 4). Often defined to be something
1913b37c7e5eSwdenk		like:
1914b37c7e5eSwdenk
1915b37c7e5eSwdenk		#define I2C_DELAY  udelay(2)
1916c609719bSwdenk
1917793b5726SMike Frysinger		CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1918793b5726SMike Frysinger
1919793b5726SMike Frysinger		If your arch supports the generic GPIO framework (asm/gpio.h),
1920793b5726SMike Frysinger		then you may alternatively define the two GPIOs that are to be
1921793b5726SMike Frysinger		used as SCL / SDA.  Any of the previous I2C_xxx macros will
1922793b5726SMike Frysinger		have GPIO-based defaults assigned to them as appropriate.
1923793b5726SMike Frysinger
1924793b5726SMike Frysinger		You should define these to the GPIO value as given directly to
1925793b5726SMike Frysinger		the generic GPIO functions.
1926793b5726SMike Frysinger
19276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_INIT_BOARD
192847cd00faSwdenk
192947cd00faSwdenk		When a board is reset during an i2c bus transfer
193047cd00faSwdenk		chips might think that the current transfer is still
193147cd00faSwdenk		in progress. On some boards it is possible to access
193247cd00faSwdenk		the i2c SCLK line directly, either by using the
193347cd00faSwdenk		processor pin as a GPIO or by having a second pin
193447cd00faSwdenk		connected to the bus. If this option is defined a
193547cd00faSwdenk		custom i2c_init_board() routine in boards/xxx/board.c
193647cd00faSwdenk		is run early in the boot sequence.
193747cd00faSwdenk
193826a33504SRichard Retanubun		CONFIG_SYS_I2C_BOARD_LATE_INIT
193926a33504SRichard Retanubun
194026a33504SRichard Retanubun		An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
194126a33504SRichard Retanubun		defined a custom i2c_board_late_init() routine in
194226a33504SRichard Retanubun		boards/xxx/board.c is run AFTER the operations in i2c_init()
194326a33504SRichard Retanubun		is completed. This callpoint can be used to unreset i2c bus
194426a33504SRichard Retanubun		using CPU i2c controller register accesses for CPUs whose i2c
194526a33504SRichard Retanubun		controller provide such a method. It is called at the end of
194626a33504SRichard Retanubun		i2c_init() to allow i2c_init operations to setup the i2c bus
194726a33504SRichard Retanubun		controller on the CPU (e.g. setting bus speed & slave address).
194826a33504SRichard Retanubun
194917ea1177Swdenk		CONFIG_I2CFAST (PPC405GP|PPC405EP only)
195017ea1177Swdenk
195117ea1177Swdenk		This option enables configuration of bi_iic_fast[] flags
195217ea1177Swdenk		in u-boot bd_info structure based on u-boot environment
195317ea1177Swdenk		variable "i2cfast". (see also i2cfast)
195417ea1177Swdenk
1955bb99ad6dSBen Warren		CONFIG_I2C_MULTI_BUS
1956bb99ad6dSBen Warren
1957bb99ad6dSBen Warren		This option allows the use of multiple I2C buses, each of which
1958bb99ad6dSBen Warren		must have a controller.	 At any point in time, only one bus is
1959bb99ad6dSBen Warren		active.	 To switch to a different bus, use the 'i2c dev' command.
1960bb99ad6dSBen Warren		Note that bus numbering is zero-based.
1961bb99ad6dSBen Warren
19626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_NOPROBES
1963bb99ad6dSBen Warren
1964bb99ad6dSBen Warren		This option specifies a list of I2C devices that will be skipped
19650f89c54bSPeter Tyser		when the 'i2c probe' command is issued.	 If CONFIG_I2C_MULTI_BUS
19660f89c54bSPeter Tyser		is set, specify a list of bus-device pairs.  Otherwise, specify
19670f89c54bSPeter Tyser		a 1D array of device addresses
1968bb99ad6dSBen Warren
1969bb99ad6dSBen Warren		e.g.
1970bb99ad6dSBen Warren			#undef	CONFIG_I2C_MULTI_BUS
19716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
1972bb99ad6dSBen Warren
1973bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on a board with one I2C bus
1974bb99ad6dSBen Warren
1975bb99ad6dSBen Warren			#define CONFIG_I2C_MULTI_BUS
19766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_MULTI_NOPROBES	{{0,0x50},{0,0x68},{1,0x54}}
1977bb99ad6dSBen Warren
1978bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1979bb99ad6dSBen Warren
19806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SPD_BUS_NUM
1981be5e6181STimur Tabi
1982be5e6181STimur Tabi		If defined, then this indicates the I2C bus number for DDR SPD.
1983be5e6181STimur Tabi		If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1984be5e6181STimur Tabi
19856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_BUS_NUM
19860dc018ecSStefan Roese
19870dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the RTC.
19880dc018ecSStefan Roese		If not defined, then U-Boot assumes that RTC is on I2C bus 0.
19890dc018ecSStefan Roese
19906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_DTT_BUS_NUM
19910dc018ecSStefan Roese
19920dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the DTT.
19930dc018ecSStefan Roese		If not defined, then U-Boot assumes that DTT is on I2C bus 0.
19940dc018ecSStefan Roese
19956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_DTT_ADDR:
19969ebbb54fSVictor Gallardo
19979ebbb54fSVictor Gallardo		If defined, specifies the I2C address of the DTT device.
19989ebbb54fSVictor Gallardo		If not defined, then U-Boot uses predefined value for
19999ebbb54fSVictor Gallardo		specified DTT device.
20009ebbb54fSVictor Gallardo
2001be5e6181STimur Tabi		CONFIG_FSL_I2C
2002be5e6181STimur Tabi
2003be5e6181STimur Tabi		Define this option if you want to use Freescale's I2C driver in
20047817cb20SMarcel Ziswiler		drivers/i2c/fsl_i2c.c.
2005be5e6181STimur Tabi
200667b23a32SHeiko Schocher		CONFIG_I2C_MUX
200767b23a32SHeiko Schocher
200867b23a32SHeiko Schocher		Define this option if you have I2C devices reached over 1 .. n
200967b23a32SHeiko Schocher		I2C Muxes like the pca9544a. This option addes a new I2C
201067b23a32SHeiko Schocher		Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
201167b23a32SHeiko Schocher		new I2C Bus to the existing I2C Busses. If you select the
201267b23a32SHeiko Schocher		new Bus with "i2c dev", u-bbot sends first the commandos for
201367b23a32SHeiko Schocher		the muxes to activate this new "bus".
201467b23a32SHeiko Schocher
201567b23a32SHeiko Schocher		CONFIG_I2C_MULTI_BUS must be also defined, to use this
201667b23a32SHeiko Schocher		feature!
201767b23a32SHeiko Schocher
201867b23a32SHeiko Schocher		Example:
201967b23a32SHeiko Schocher		Adding a new I2C Bus reached over 2 pca9544a muxes
202067b23a32SHeiko Schocher			The First mux with address 70 and channel 6
202167b23a32SHeiko Schocher			The Second mux with address 71 and channel 4
202267b23a32SHeiko Schocher
202367b23a32SHeiko Schocher		=> i2c bus pca9544a:70:6:pca9544a:71:4
202467b23a32SHeiko Schocher
202567b23a32SHeiko Schocher		Use the "i2c bus" command without parameter, to get a list
202667b23a32SHeiko Schocher		of I2C Busses with muxes:
202767b23a32SHeiko Schocher
202867b23a32SHeiko Schocher		=> i2c bus
202967b23a32SHeiko Schocher		Busses reached over muxes:
203067b23a32SHeiko Schocher		Bus ID: 2
203167b23a32SHeiko Schocher		  reached over Mux(es):
203267b23a32SHeiko Schocher		    pca9544a@70 ch: 4
203367b23a32SHeiko Schocher		Bus ID: 3
203467b23a32SHeiko Schocher		  reached over Mux(es):
203567b23a32SHeiko Schocher		    pca9544a@70 ch: 6
203667b23a32SHeiko Schocher		    pca9544a@71 ch: 4
203767b23a32SHeiko Schocher		=>
203867b23a32SHeiko Schocher
203967b23a32SHeiko Schocher		If you now switch to the new I2C Bus 3 with "i2c dev 3"
2040f9a78b8dSMichael Jones		u-boot first sends the command to the mux@70 to enable
2041f9a78b8dSMichael Jones		channel 6, and then the command to the mux@71 to enable
204267b23a32SHeiko Schocher		the channel 4.
204367b23a32SHeiko Schocher
204467b23a32SHeiko Schocher		After that, you can use the "normal" i2c commands as
2045f9a78b8dSMichael Jones		usual to communicate with your I2C devices behind
204667b23a32SHeiko Schocher		the 2 muxes.
204767b23a32SHeiko Schocher
204867b23a32SHeiko Schocher		This option is actually implemented for the bitbanging
204967b23a32SHeiko Schocher		algorithm in common/soft_i2c.c and for the Hardware I2C
205067b23a32SHeiko Schocher		Bus on the MPC8260. But it should be not so difficult
205167b23a32SHeiko Schocher		to add this option to other architectures.
205267b23a32SHeiko Schocher
20532ac6985aSAndrew Dyer		CONFIG_SOFT_I2C_READ_REPEATED_START
20542ac6985aSAndrew Dyer
20552ac6985aSAndrew Dyer		defining this will force the i2c_read() function in
20562ac6985aSAndrew Dyer		the soft_i2c driver to perform an I2C repeated start
20572ac6985aSAndrew Dyer		between writing the address pointer and reading the
20582ac6985aSAndrew Dyer		data.  If this define is omitted the default behaviour
20592ac6985aSAndrew Dyer		of doing a stop-start sequence will be used.  Most I2C
20602ac6985aSAndrew Dyer		devices can use either method, but some require one or
20612ac6985aSAndrew Dyer		the other.
2062be5e6181STimur Tabi
2063c609719bSwdenk- SPI Support:	CONFIG_SPI
2064c609719bSwdenk
2065c609719bSwdenk		Enables SPI driver (so far only tested with
2066c609719bSwdenk		SPI EEPROM, also an instance works with Crystal A/D and
2067c609719bSwdenk		D/As on the SACSng board)
2068c609719bSwdenk
20696639562eSYoshihiro Shimoda		CONFIG_SH_SPI
20706639562eSYoshihiro Shimoda
20716639562eSYoshihiro Shimoda		Enables the driver for SPI controller on SuperH. Currently
20726639562eSYoshihiro Shimoda		only SH7757 is supported.
20736639562eSYoshihiro Shimoda
2074c609719bSwdenk		CONFIG_SPI_X
2075c609719bSwdenk
2076c609719bSwdenk		Enables extended (16-bit) SPI EEPROM addressing.
2077c609719bSwdenk		(symmetrical to CONFIG_I2C_X)
2078c609719bSwdenk
2079c609719bSwdenk		CONFIG_SOFT_SPI
2080c609719bSwdenk
2081c609719bSwdenk		Enables a software (bit-bang) SPI driver rather than
2082c609719bSwdenk		using hardware support. This is a general purpose
2083c609719bSwdenk		driver that only requires three general I/O port pins
2084c609719bSwdenk		(two outputs, one input) to function. If this is
2085c609719bSwdenk		defined, the board configuration must define several
2086c609719bSwdenk		SPI configuration items (port pins to use, etc). For
2087c609719bSwdenk		an example, see include/configs/sacsng.h.
2088c609719bSwdenk
208904a9e118SBen Warren		CONFIG_HARD_SPI
209004a9e118SBen Warren
209104a9e118SBen Warren		Enables a hardware SPI driver for general-purpose reads
209204a9e118SBen Warren		and writes.  As with CONFIG_SOFT_SPI, the board configuration
209304a9e118SBen Warren		must define a list of chip-select function pointers.
209404a9e118SBen Warren		Currently supported on some MPC8xxx processors.	 For an
209504a9e118SBen Warren		example, see include/configs/mpc8349emds.h.
209604a9e118SBen Warren
209738254f45SGuennadi Liakhovetski		CONFIG_MXC_SPI
209838254f45SGuennadi Liakhovetski
209938254f45SGuennadi Liakhovetski		Enables the driver for the SPI controllers on i.MX and MXC
21002e3cd1cdSFabio Estevam		SoCs. Currently i.MX31/35/51 are supported.
210138254f45SGuennadi Liakhovetski
21020133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA
21030133502eSMatthias Fuchs
21040133502eSMatthias Fuchs		Enables FPGA subsystem.
21050133502eSMatthias Fuchs
21060133502eSMatthias Fuchs		CONFIG_FPGA_<vendor>
21070133502eSMatthias Fuchs
21080133502eSMatthias Fuchs		Enables support for specific chip vendors.
21090133502eSMatthias Fuchs		(ALTERA, XILINX)
21100133502eSMatthias Fuchs
21110133502eSMatthias Fuchs		CONFIG_FPGA_<family>
21120133502eSMatthias Fuchs
21130133502eSMatthias Fuchs		Enables support for FPGA family.
21140133502eSMatthias Fuchs		(SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
21150133502eSMatthias Fuchs
21160133502eSMatthias Fuchs		CONFIG_FPGA_COUNT
2117c609719bSwdenk
2118c609719bSwdenk		Specify the number of FPGA devices to support.
2119c609719bSwdenk
21206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_PROG_FEEDBACK
2121c609719bSwdenk
2122c609719bSwdenk		Enable printing of hash marks during FPGA configuration.
2123c609719bSwdenk
21246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_BUSY
2125c609719bSwdenk
2126c609719bSwdenk		Enable checks on FPGA configuration interface busy
2127c609719bSwdenk		status by the configuration function. This option
2128c609719bSwdenk		will require a board or device specific function to
2129c609719bSwdenk		be written.
2130c609719bSwdenk
2131c609719bSwdenk		CONFIG_FPGA_DELAY
2132c609719bSwdenk
2133c609719bSwdenk		If defined, a function that provides delays in the FPGA
2134c609719bSwdenk		configuration driver.
2135c609719bSwdenk
21366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_CTRLC
2137c609719bSwdenk		Allow Control-C to interrupt FPGA configuration
2138c609719bSwdenk
21396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_ERROR
2140c609719bSwdenk
2141c609719bSwdenk		Check for configuration errors during FPGA bitfile
2142c609719bSwdenk		loading. For example, abort during Virtex II
2143c609719bSwdenk		configuration if the INIT_B line goes low (which
2144c609719bSwdenk		indicated a CRC error).
2145c609719bSwdenk
21466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_INIT
2147c609719bSwdenk
2148c609719bSwdenk		Maximum time to wait for the INIT_B line to deassert
2149c609719bSwdenk		after PROB_B has been deasserted during a Virtex II
2150c609719bSwdenk		FPGA configuration sequence. The default time is 500
215111ccc33fSMarcel Ziswiler		ms.
2152c609719bSwdenk
21536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_BUSY
2154c609719bSwdenk
2155c609719bSwdenk		Maximum time to wait for BUSY to deassert during
215611ccc33fSMarcel Ziswiler		Virtex II FPGA configuration. The default is 5 ms.
2157c609719bSwdenk
21586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_CONFIG
2159c609719bSwdenk
2160c609719bSwdenk		Time to wait after FPGA configuration. The default is
216111ccc33fSMarcel Ziswiler		200 ms.
2162c609719bSwdenk
2163c609719bSwdenk- Configuration Management:
2164c609719bSwdenk		CONFIG_IDENT_STRING
2165c609719bSwdenk
2166c609719bSwdenk		If defined, this string will be added to the U-Boot
2167c609719bSwdenk		version information (U_BOOT_VERSION)
2168c609719bSwdenk
2169c609719bSwdenk- Vendor Parameter Protection:
2170c609719bSwdenk
2171c609719bSwdenk		U-Boot considers the values of the environment
2172c609719bSwdenk		variables "serial#" (Board Serial Number) and
21737152b1d0Swdenk		"ethaddr" (Ethernet Address) to be parameters that
2174c609719bSwdenk		are set once by the board vendor / manufacturer, and
2175c609719bSwdenk		protects these variables from casual modification by
2176c609719bSwdenk		the user. Once set, these variables are read-only,
2177c609719bSwdenk		and write or delete attempts are rejected. You can
217811ccc33fSMarcel Ziswiler		change this behaviour:
2179c609719bSwdenk
2180c609719bSwdenk		If CONFIG_ENV_OVERWRITE is #defined in your config
2181c609719bSwdenk		file, the write protection for vendor parameters is
218247cd00faSwdenk		completely disabled. Anybody can change or delete
2183c609719bSwdenk		these parameters.
2184c609719bSwdenk
2185c609719bSwdenk		Alternatively, if you #define _both_ CONFIG_ETHADDR
2186c609719bSwdenk		_and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
218711ccc33fSMarcel Ziswiler		Ethernet address is installed in the environment,
2188c609719bSwdenk		which can be changed exactly ONCE by the user. [The
2189c609719bSwdenk		serial# is unaffected by this, i. e. it remains
2190c609719bSwdenk		read-only.]
2191c609719bSwdenk
21922598090bSJoe Hershberger		The same can be accomplished in a more flexible way
21932598090bSJoe Hershberger		for any variable by configuring the type of access
21942598090bSJoe Hershberger		to allow for those variables in the ".flags" variable
21952598090bSJoe Hershberger		or define CONFIG_ENV_FLAGS_LIST_STATIC.
21962598090bSJoe Hershberger
2197c609719bSwdenk- Protected RAM:
2198c609719bSwdenk		CONFIG_PRAM
2199c609719bSwdenk
2200c609719bSwdenk		Define this variable to enable the reservation of
2201c609719bSwdenk		"protected RAM", i. e. RAM which is not overwritten
2202c609719bSwdenk		by U-Boot. Define CONFIG_PRAM to hold the number of
2203c609719bSwdenk		kB you want to reserve for pRAM. You can overwrite
2204c609719bSwdenk		this default value by defining an environment
2205c609719bSwdenk		variable "pram" to the number of kB you want to
2206c609719bSwdenk		reserve. Note that the board info structure will
2207c609719bSwdenk		still show the full amount of RAM. If pRAM is
2208c609719bSwdenk		reserved, a new environment variable "mem" will
2209c609719bSwdenk		automatically be defined to hold the amount of
2210c609719bSwdenk		remaining RAM in a form that can be passed as boot
2211c609719bSwdenk		argument to Linux, for instance like that:
2212c609719bSwdenk
2213fe126d8bSWolfgang Denk			setenv bootargs ... mem=\${mem}
2214c609719bSwdenk			saveenv
2215c609719bSwdenk
2216c609719bSwdenk		This way you can tell Linux not to use this memory,
2217c609719bSwdenk		either, which results in a memory region that will
2218c609719bSwdenk		not be affected by reboots.
2219c609719bSwdenk
2220c609719bSwdenk		*WARNING* If your board configuration uses automatic
2221c609719bSwdenk		detection of the RAM size, you must make sure that
2222c609719bSwdenk		this memory test is non-destructive. So far, the
2223c609719bSwdenk		following board configurations are known to be
2224c609719bSwdenk		"pRAM-clean":
2225c609719bSwdenk
22261b0757ecSWolfgang Denk			IVMS8, IVML24, SPD8xx, TQM8xxL,
22271b0757ecSWolfgang Denk			HERMES, IP860, RPXlite, LWMON,
2228544d97e9SWolfgang Denk			FLAGADM, TQM8260
2229c609719bSwdenk
223040fef049SGabe Black- Access to physical memory region (> 4GB)
223140fef049SGabe Black		Some basic support is provided for operations on memory not
223240fef049SGabe Black		normally accessible to U-Boot - e.g. some architectures
223340fef049SGabe Black		support access to more than 4GB of memory on 32-bit
223440fef049SGabe Black		machines using physical address extension or similar.
223540fef049SGabe Black		Define CONFIG_PHYSMEM to access this basic support, which
223640fef049SGabe Black		currently only supports clearing the memory.
223740fef049SGabe Black
2238c609719bSwdenk- Error Recovery:
2239c609719bSwdenk		CONFIG_PANIC_HANG
2240c609719bSwdenk
2241c609719bSwdenk		Define this variable to stop the system in case of a
2242c609719bSwdenk		fatal error, so that you have to reset it manually.
2243c609719bSwdenk		This is probably NOT a good idea for an embedded
224411ccc33fSMarcel Ziswiler		system where you want the system to reboot
2245c609719bSwdenk		automatically as fast as possible, but it may be
2246c609719bSwdenk		useful during development since you can try to debug
2247c609719bSwdenk		the conditions that lead to the situation.
2248c609719bSwdenk
2249c609719bSwdenk		CONFIG_NET_RETRY_COUNT
2250c609719bSwdenk
2251c609719bSwdenk		This variable defines the number of retries for
2252c609719bSwdenk		network operations like ARP, RARP, TFTP, or BOOTP
2253c609719bSwdenk		before giving up the operation. If not defined, a
2254c609719bSwdenk		default value of 5 is used.
2255c609719bSwdenk
225640cb90eeSGuennadi Liakhovetski		CONFIG_ARP_TIMEOUT
225740cb90eeSGuennadi Liakhovetski
225840cb90eeSGuennadi Liakhovetski		Timeout waiting for an ARP reply in milliseconds.
225940cb90eeSGuennadi Liakhovetski
226048a3e999STetsuyuki Kobayashi		CONFIG_NFS_TIMEOUT
226148a3e999STetsuyuki Kobayashi
226248a3e999STetsuyuki Kobayashi		Timeout in milliseconds used in NFS protocol.
226348a3e999STetsuyuki Kobayashi		If you encounter "ERROR: Cannot umount" in nfs command,
226448a3e999STetsuyuki Kobayashi		try longer timeout such as
226548a3e999STetsuyuki Kobayashi		#define CONFIG_NFS_TIMEOUT 10000UL
226648a3e999STetsuyuki Kobayashi
2267c609719bSwdenk- Command Interpreter:
22688078f1a5SWolfgang Denk		CONFIG_AUTO_COMPLETE
226904a85b3bSwdenk
227004a85b3bSwdenk		Enable auto completion of commands using TAB.
227104a85b3bSwdenk
22728078f1a5SWolfgang Denk		Note that this feature has NOT been implemented yet
22738078f1a5SWolfgang Denk		for the "hush" shell.
22748078f1a5SWolfgang Denk
22758078f1a5SWolfgang Denk
22766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_HUSH_PARSER
2277c609719bSwdenk
2278c609719bSwdenk		Define this variable to enable the "hush" shell (from
2279c609719bSwdenk		Busybox) as command line interpreter, thus enabling
2280c609719bSwdenk		powerful command line syntax like
2281c609719bSwdenk		if...then...else...fi conditionals or `&&' and '||'
2282c609719bSwdenk		constructs ("shell scripts").
2283c609719bSwdenk
2284c609719bSwdenk		If undefined, you get the old, much simpler behaviour
2285c609719bSwdenk		with a somewhat smaller memory footprint.
2286c609719bSwdenk
2287c609719bSwdenk
22886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_PROMPT_HUSH_PS2
2289c609719bSwdenk
2290c609719bSwdenk		This defines the secondary prompt string, which is
2291c609719bSwdenk		printed when the command interpreter needs more input
2292c609719bSwdenk		to complete a command. Usually "> ".
2293c609719bSwdenk
2294c609719bSwdenk	Note:
2295c609719bSwdenk
2296c609719bSwdenk		In the current implementation, the local variables
2297c609719bSwdenk		space and global environment variables space are
2298c609719bSwdenk		separated. Local variables are those you define by
22993b57fe0aSwdenk		simply typing `name=value'. To access a local
2300c609719bSwdenk		variable later on, you have write `$name' or
23013b57fe0aSwdenk		`${name}'; to execute the contents of a variable
23023b57fe0aSwdenk		directly type `$name' at the command prompt.
2303c609719bSwdenk
2304c609719bSwdenk		Global environment variables are those you use
2305c609719bSwdenk		setenv/printenv to work with. To run a command stored
2306c609719bSwdenk		in such a variable, you need to use the run command,
2307c609719bSwdenk		and you must not use the '$' sign to access them.
2308c609719bSwdenk
2309c609719bSwdenk		To store commands and special characters in a
2310c609719bSwdenk		variable, please use double quotation marks
2311c609719bSwdenk		surrounding the whole text of the variable, instead
2312c609719bSwdenk		of the backslashes before semicolons and special
2313c609719bSwdenk		symbols.
2314c609719bSwdenk
2315aa0c71acSWolfgang Denk- Commandline Editing and History:
2316aa0c71acSWolfgang Denk		CONFIG_CMDLINE_EDITING
2317aa0c71acSWolfgang Denk
231811ccc33fSMarcel Ziswiler		Enable editing and History functions for interactive
2319aa0c71acSWolfgang Denk		commandline input operations
2320aa0c71acSWolfgang Denk
2321a8c7c708Swdenk- Default Environment:
2322c609719bSwdenk		CONFIG_EXTRA_ENV_SETTINGS
2323c609719bSwdenk
2324c609719bSwdenk		Define this to contain any number of null terminated
2325c609719bSwdenk		strings (variable = value pairs) that will be part of
23267152b1d0Swdenk		the default environment compiled into the boot image.
23272262cfeeSwdenk
2328c609719bSwdenk		For example, place something like this in your
2329c609719bSwdenk		board's config file:
2330c609719bSwdenk
2331c609719bSwdenk		#define CONFIG_EXTRA_ENV_SETTINGS \
2332c609719bSwdenk			"myvar1=value1\0" \
2333c609719bSwdenk			"myvar2=value2\0"
2334c609719bSwdenk
2335c609719bSwdenk		Warning: This method is based on knowledge about the
2336c609719bSwdenk		internal format how the environment is stored by the
23372262cfeeSwdenk		U-Boot code. This is NOT an official, exported
2338c609719bSwdenk		interface! Although it is unlikely that this format
23397152b1d0Swdenk		will change soon, there is no guarantee either.
2340c609719bSwdenk		You better know what you are doing here.
2341c609719bSwdenk
2342c609719bSwdenk		Note: overly (ab)use of the default environment is
2343c609719bSwdenk		discouraged. Make sure to check other ways to preset
234474de7aefSWolfgang Denk		the environment like the "source" command or the
2345c609719bSwdenk		boot command first.
2346c609719bSwdenk
23475e724ca2SStephen Warren		CONFIG_ENV_VARS_UBOOT_CONFIG
23485e724ca2SStephen Warren
23495e724ca2SStephen Warren		Define this in order to add variables describing the
23505e724ca2SStephen Warren		U-Boot build configuration to the default environment.
23515e724ca2SStephen Warren		These will be named arch, cpu, board, vendor, and soc.
23525e724ca2SStephen Warren
23535e724ca2SStephen Warren		Enabling this option will cause the following to be defined:
23545e724ca2SStephen Warren
23555e724ca2SStephen Warren		- CONFIG_SYS_ARCH
23565e724ca2SStephen Warren		- CONFIG_SYS_CPU
23575e724ca2SStephen Warren		- CONFIG_SYS_BOARD
23585e724ca2SStephen Warren		- CONFIG_SYS_VENDOR
23595e724ca2SStephen Warren		- CONFIG_SYS_SOC
23605e724ca2SStephen Warren
23617e27f89fSTom Rini		CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
23627e27f89fSTom Rini
23637e27f89fSTom Rini		Define this in order to add variables describing certain
23647e27f89fSTom Rini		run-time determined information about the hardware to the
23657e27f89fSTom Rini		environment.  These will be named board_name, board_rev.
23667e27f89fSTom Rini
2367a8c7c708Swdenk- DataFlash Support:
23682abbe075Swdenk		CONFIG_HAS_DATAFLASH
23692abbe075Swdenk
23702abbe075Swdenk		Defining this option enables DataFlash features and
23712abbe075Swdenk		allows to read/write in Dataflash via the standard
23722abbe075Swdenk		commands cp, md...
23732abbe075Swdenk
2374f61ec45eSEric Nelson- Serial Flash support
2375f61ec45eSEric Nelson		CONFIG_CMD_SF
2376f61ec45eSEric Nelson
2377f61ec45eSEric Nelson		Defining this option enables SPI flash commands
2378f61ec45eSEric Nelson		'sf probe/read/write/erase/update'.
2379f61ec45eSEric Nelson
2380f61ec45eSEric Nelson		Usage requires an initial 'probe' to define the serial
2381f61ec45eSEric Nelson		flash parameters, followed by read/write/erase/update
2382f61ec45eSEric Nelson		commands.
2383f61ec45eSEric Nelson
2384f61ec45eSEric Nelson		The following defaults may be provided by the platform
2385f61ec45eSEric Nelson		to handle the common case when only a single serial
2386f61ec45eSEric Nelson		flash is present on the system.
2387f61ec45eSEric Nelson
2388f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_BUS		Bus identifier
2389f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_CS		Chip-select
2390f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_MODE 		(see include/spi.h)
2391f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_SPEED		in Hz
2392f61ec45eSEric Nelson
23933f85ce27Swdenk- SystemACE Support:
23943f85ce27Swdenk		CONFIG_SYSTEMACE
23953f85ce27Swdenk
23963f85ce27Swdenk		Adding this option adds support for Xilinx SystemACE
23973f85ce27Swdenk		chips attached via some sort of local bus. The address
239811ccc33fSMarcel Ziswiler		of the chip must also be defined in the
23996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SYSTEMACE_BASE macro. For example:
24003f85ce27Swdenk
24013f85ce27Swdenk		#define CONFIG_SYSTEMACE
24026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
24033f85ce27Swdenk
24043f85ce27Swdenk		When SystemACE support is added, the "ace" device type
24053f85ce27Swdenk		becomes available to the fat commands, i.e. fatls.
24063f85ce27Swdenk
2407ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port:
2408ecb0ccd9SWolfgang Denk		CONFIG_TFTP_PORT
2409ecb0ccd9SWolfgang Denk
241028cb9375SWolfgang Denk		If this is defined, the environment variable tftpsrcp
2411ecb0ccd9SWolfgang Denk		is used to supply the TFTP UDP source port value.
241228cb9375SWolfgang Denk		If tftpsrcp isn't defined, the normal pseudo-random port
2413ecb0ccd9SWolfgang Denk		number generator is used.
2414ecb0ccd9SWolfgang Denk
241528cb9375SWolfgang Denk		Also, the environment variable tftpdstp is used to supply
241628cb9375SWolfgang Denk		the TFTP UDP destination port value.  If tftpdstp isn't
241728cb9375SWolfgang Denk		defined, the normal port 69 is used.
241828cb9375SWolfgang Denk
241928cb9375SWolfgang Denk		The purpose for tftpsrcp is to allow a TFTP server to
2420ecb0ccd9SWolfgang Denk		blindly start the TFTP transfer using the pre-configured
2421ecb0ccd9SWolfgang Denk		target IP address and UDP port. This has the effect of
2422ecb0ccd9SWolfgang Denk		"punching through" the (Windows XP) firewall, allowing
2423ecb0ccd9SWolfgang Denk		the remainder of the TFTP transfer to proceed normally.
2424ecb0ccd9SWolfgang Denk		A better solution is to properly configure the firewall,
2425ecb0ccd9SWolfgang Denk		but sometimes that is not allowed.
2426ecb0ccd9SWolfgang Denk
2427bf36c5d5SSimon Glass- Hashing support:
2428bf36c5d5SSimon Glass		CONFIG_CMD_HASH
2429bf36c5d5SSimon Glass
2430bf36c5d5SSimon Glass		This enables a generic 'hash' command which can produce
2431bf36c5d5SSimon Glass		hashes / digests from a few algorithms (e.g. SHA1, SHA256).
2432bf36c5d5SSimon Glass
2433bf36c5d5SSimon Glass		CONFIG_HASH_VERIFY
2434bf36c5d5SSimon Glass
2435bf36c5d5SSimon Glass		Enable the hash verify command (hash -v). This adds to code
2436bf36c5d5SSimon Glass		size a little.
2437bf36c5d5SSimon Glass
2438bf36c5d5SSimon Glass		CONFIG_SHA1 - support SHA1 hashing
2439bf36c5d5SSimon Glass		CONFIG_SHA256 - support SHA256 hashing
2440bf36c5d5SSimon Glass
2441bf36c5d5SSimon Glass		Note: There is also a sha1sum command, which should perhaps
2442bf36c5d5SSimon Glass		be deprecated in favour of 'hash sha1'.
2443bf36c5d5SSimon Glass
2444a8c7c708Swdenk- Show boot progress:
2445c609719bSwdenk		CONFIG_SHOW_BOOT_PROGRESS
2446c609719bSwdenk
2447c609719bSwdenk		Defining this option allows to add some board-
2448c609719bSwdenk		specific code (calling a user-provided function
2449c609719bSwdenk		"show_boot_progress(int)") that enables you to show
2450c609719bSwdenk		the system's boot progress on some display (for
2451c609719bSwdenk		example, some LED's) on your board. At the moment,
2452c609719bSwdenk		the following checkpoints are implemented:
2453c609719bSwdenk
24543a608ca0SSimon Glass- Detailed boot stage timing
24553a608ca0SSimon Glass		CONFIG_BOOTSTAGE
24563a608ca0SSimon Glass		Define this option to get detailed timing of each stage
24573a608ca0SSimon Glass		of the boot process.
24583a608ca0SSimon Glass
24593a608ca0SSimon Glass		CONFIG_BOOTSTAGE_USER_COUNT
24603a608ca0SSimon Glass		This is the number of available user bootstage records.
24613a608ca0SSimon Glass		Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
24623a608ca0SSimon Glass		a new ID will be allocated from this stash. If you exceed
24633a608ca0SSimon Glass		the limit, recording will stop.
24643a608ca0SSimon Glass
24653a608ca0SSimon Glass		CONFIG_BOOTSTAGE_REPORT
24663a608ca0SSimon Glass		Define this to print a report before boot, similar to this:
24673a608ca0SSimon Glass
24683a608ca0SSimon Glass		Timer summary in microseconds:
24693a608ca0SSimon Glass		       Mark    Elapsed  Stage
24703a608ca0SSimon Glass			  0          0  reset
24713a608ca0SSimon Glass		  3,575,678  3,575,678  board_init_f start
24723a608ca0SSimon Glass		  3,575,695         17  arch_cpu_init A9
24733a608ca0SSimon Glass		  3,575,777         82  arch_cpu_init done
24743a608ca0SSimon Glass		  3,659,598     83,821  board_init_r start
24753a608ca0SSimon Glass		  3,910,375    250,777  main_loop
24763a608ca0SSimon Glass		 29,916,167 26,005,792  bootm_start
24773a608ca0SSimon Glass		 30,361,327    445,160  start_kernel
24783a608ca0SSimon Glass
24792eba38cfSSimon Glass		CONFIG_CMD_BOOTSTAGE
24802eba38cfSSimon Glass		Add a 'bootstage' command which supports printing a report
24812eba38cfSSimon Glass		and un/stashing of bootstage data.
24822eba38cfSSimon Glass
248394fd1316SSimon Glass		CONFIG_BOOTSTAGE_FDT
248494fd1316SSimon Glass		Stash the bootstage information in the FDT. A root 'bootstage'
248594fd1316SSimon Glass		node is created with each bootstage id as a child. Each child
248694fd1316SSimon Glass		has a 'name' property and either 'mark' containing the
248794fd1316SSimon Glass		mark time in microsecond, or 'accum' containing the
248894fd1316SSimon Glass		accumulated time for that bootstage id in microseconds.
248994fd1316SSimon Glass		For example:
249094fd1316SSimon Glass
249194fd1316SSimon Glass		bootstage {
249294fd1316SSimon Glass			154 {
249394fd1316SSimon Glass				name = "board_init_f";
249494fd1316SSimon Glass				mark = <3575678>;
249594fd1316SSimon Glass			};
249694fd1316SSimon Glass			170 {
249794fd1316SSimon Glass				name = "lcd";
249894fd1316SSimon Glass				accum = <33482>;
249994fd1316SSimon Glass			};
250094fd1316SSimon Glass		};
250194fd1316SSimon Glass
250294fd1316SSimon Glass		Code in the Linux kernel can find this in /proc/devicetree.
250394fd1316SSimon Glass
25041372cce2SMarian BalakowiczLegacy uImage format:
25051372cce2SMarian Balakowicz
2506c609719bSwdenk  Arg	Where			When
2507c609719bSwdenk    1	common/cmd_bootm.c	before attempting to boot an image
2508c609719bSwdenk   -1	common/cmd_bootm.c	Image header has bad	 magic number
2509c609719bSwdenk    2	common/cmd_bootm.c	Image header has correct magic number
2510c609719bSwdenk   -2	common/cmd_bootm.c	Image header has bad	 checksum
2511c609719bSwdenk    3	common/cmd_bootm.c	Image header has correct checksum
2512c609719bSwdenk   -3	common/cmd_bootm.c	Image data   has bad	 checksum
2513c609719bSwdenk    4	common/cmd_bootm.c	Image data   has correct checksum
2514c609719bSwdenk   -4	common/cmd_bootm.c	Image is for unsupported architecture
2515c609719bSwdenk    5	common/cmd_bootm.c	Architecture check OK
25161372cce2SMarian Balakowicz   -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi)
2517c609719bSwdenk    6	common/cmd_bootm.c	Image Type check OK
2518c609719bSwdenk   -6	common/cmd_bootm.c	gunzip uncompression error
2519c609719bSwdenk   -7	common/cmd_bootm.c	Unimplemented compression type
2520c609719bSwdenk    7	common/cmd_bootm.c	Uncompression OK
25211372cce2SMarian Balakowicz    8	common/cmd_bootm.c	No uncompress/copy overwrite error
2522c609719bSwdenk   -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
25231372cce2SMarian Balakowicz
25241372cce2SMarian Balakowicz    9	common/image.c		Start initial ramdisk verification
25251372cce2SMarian Balakowicz  -10	common/image.c		Ramdisk header has bad	   magic number
25261372cce2SMarian Balakowicz  -11	common/image.c		Ramdisk header has bad	   checksum
25271372cce2SMarian Balakowicz   10	common/image.c		Ramdisk header is OK
25281372cce2SMarian Balakowicz  -12	common/image.c		Ramdisk data   has bad	   checksum
25291372cce2SMarian Balakowicz   11	common/image.c		Ramdisk data   has correct checksum
25301372cce2SMarian Balakowicz   12	common/image.c		Ramdisk verification complete, start loading
253111ccc33fSMarcel Ziswiler  -13	common/image.c		Wrong Image Type (not PPC Linux ramdisk)
25321372cce2SMarian Balakowicz   13	common/image.c		Start multifile image verification
25331372cce2SMarian Balakowicz   14	common/image.c		No initial ramdisk, no multifile, continue.
25341372cce2SMarian Balakowicz
2535ea0364f1SPeter Tyser   15	arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
2536c609719bSwdenk
2537a47a12beSStefan Roese  -30	arch/powerpc/lib/board.c	Fatal error, hang the system
253863e73c9aSwdenk  -31	post/post.c		POST test failed, detected by post_output_backlog()
253963e73c9aSwdenk  -32	post/post.c		POST test failed, detected by post_run_single()
254063e73c9aSwdenk
2541566a494fSHeiko Schocher   34	common/cmd_doc.c	before loading a Image from a DOC device
2542566a494fSHeiko Schocher  -35	common/cmd_doc.c	Bad usage of "doc" command
2543566a494fSHeiko Schocher   35	common/cmd_doc.c	correct usage of "doc" command
2544566a494fSHeiko Schocher  -36	common/cmd_doc.c	No boot device
2545566a494fSHeiko Schocher   36	common/cmd_doc.c	correct boot device
2546566a494fSHeiko Schocher  -37	common/cmd_doc.c	Unknown Chip ID on boot device
2547566a494fSHeiko Schocher   37	common/cmd_doc.c	correct chip ID found, device available
2548566a494fSHeiko Schocher  -38	common/cmd_doc.c	Read Error on boot device
2549566a494fSHeiko Schocher   38	common/cmd_doc.c	reading Image header from DOC device OK
2550566a494fSHeiko Schocher  -39	common/cmd_doc.c	Image header has bad magic number
2551566a494fSHeiko Schocher   39	common/cmd_doc.c	Image header has correct magic number
2552566a494fSHeiko Schocher  -40	common/cmd_doc.c	Error reading Image from DOC device
2553566a494fSHeiko Schocher   40	common/cmd_doc.c	Image header has correct magic number
2554566a494fSHeiko Schocher   41	common/cmd_ide.c	before loading a Image from a IDE device
2555566a494fSHeiko Schocher  -42	common/cmd_ide.c	Bad usage of "ide" command
2556566a494fSHeiko Schocher   42	common/cmd_ide.c	correct usage of "ide" command
2557566a494fSHeiko Schocher  -43	common/cmd_ide.c	No boot device
2558566a494fSHeiko Schocher   43	common/cmd_ide.c	boot device found
2559566a494fSHeiko Schocher  -44	common/cmd_ide.c	Device not available
2560566a494fSHeiko Schocher   44	common/cmd_ide.c	Device available
2561566a494fSHeiko Schocher  -45	common/cmd_ide.c	wrong partition selected
2562566a494fSHeiko Schocher   45	common/cmd_ide.c	partition selected
2563566a494fSHeiko Schocher  -46	common/cmd_ide.c	Unknown partition table
2564566a494fSHeiko Schocher   46	common/cmd_ide.c	valid partition table found
2565566a494fSHeiko Schocher  -47	common/cmd_ide.c	Invalid partition type
2566566a494fSHeiko Schocher   47	common/cmd_ide.c	correct partition type
2567566a494fSHeiko Schocher  -48	common/cmd_ide.c	Error reading Image Header on boot device
2568566a494fSHeiko Schocher   48	common/cmd_ide.c	reading Image Header from IDE device OK
2569566a494fSHeiko Schocher  -49	common/cmd_ide.c	Image header has bad magic number
2570566a494fSHeiko Schocher   49	common/cmd_ide.c	Image header has correct magic number
2571566a494fSHeiko Schocher  -50	common/cmd_ide.c	Image header has bad	 checksum
2572566a494fSHeiko Schocher   50	common/cmd_ide.c	Image header has correct checksum
2573566a494fSHeiko Schocher  -51	common/cmd_ide.c	Error reading Image from IDE device
2574566a494fSHeiko Schocher   51	common/cmd_ide.c	reading Image from IDE device OK
2575566a494fSHeiko Schocher   52	common/cmd_nand.c	before loading a Image from a NAND device
2576566a494fSHeiko Schocher  -53	common/cmd_nand.c	Bad usage of "nand" command
2577566a494fSHeiko Schocher   53	common/cmd_nand.c	correct usage of "nand" command
2578566a494fSHeiko Schocher  -54	common/cmd_nand.c	No boot device
2579566a494fSHeiko Schocher   54	common/cmd_nand.c	boot device found
2580566a494fSHeiko Schocher  -55	common/cmd_nand.c	Unknown Chip ID on boot device
2581566a494fSHeiko Schocher   55	common/cmd_nand.c	correct chip ID found, device available
2582566a494fSHeiko Schocher  -56	common/cmd_nand.c	Error reading Image Header on boot device
2583566a494fSHeiko Schocher   56	common/cmd_nand.c	reading Image Header from NAND device OK
2584566a494fSHeiko Schocher  -57	common/cmd_nand.c	Image header has bad magic number
2585566a494fSHeiko Schocher   57	common/cmd_nand.c	Image header has correct magic number
2586566a494fSHeiko Schocher  -58	common/cmd_nand.c	Error reading Image from NAND device
2587566a494fSHeiko Schocher   58	common/cmd_nand.c	reading Image from NAND device OK
2588c609719bSwdenk
2589566a494fSHeiko Schocher  -60	common/env_common.c	Environment has a bad CRC, using default
2590c609719bSwdenk
2591566a494fSHeiko Schocher   64	net/eth.c		starting with Ethernet configuration.
2592566a494fSHeiko Schocher  -64	net/eth.c		no Ethernet found.
2593566a494fSHeiko Schocher   65	net/eth.c		Ethernet found.
2594206c60cbSwdenk
2595566a494fSHeiko Schocher  -80	common/cmd_net.c	usage wrong
2596566a494fSHeiko Schocher   80	common/cmd_net.c	before calling NetLoop()
259711ccc33fSMarcel Ziswiler  -81	common/cmd_net.c	some error in NetLoop() occurred
2598566a494fSHeiko Schocher   81	common/cmd_net.c	NetLoop() back without error
2599566a494fSHeiko Schocher  -82	common/cmd_net.c	size == 0 (File with size 0 loaded)
2600566a494fSHeiko Schocher   82	common/cmd_net.c	trying automatic boot
260174de7aefSWolfgang Denk   83	common/cmd_net.c	running "source" command
260274de7aefSWolfgang Denk  -83	common/cmd_net.c	some error in automatic boot or "source" command
2603566a494fSHeiko Schocher   84	common/cmd_net.c	end without errors
2604c609719bSwdenk
26051372cce2SMarian BalakowiczFIT uImage format:
26061372cce2SMarian Balakowicz
26071372cce2SMarian Balakowicz  Arg	Where			When
26081372cce2SMarian Balakowicz  100	common/cmd_bootm.c	Kernel FIT Image has correct format
26091372cce2SMarian Balakowicz -100	common/cmd_bootm.c	Kernel FIT Image has incorrect format
26101372cce2SMarian Balakowicz  101	common/cmd_bootm.c	No Kernel subimage unit name, using configuration
26111372cce2SMarian Balakowicz -101	common/cmd_bootm.c	Can't get configuration for kernel subimage
26121372cce2SMarian Balakowicz  102	common/cmd_bootm.c	Kernel unit name specified
26131372cce2SMarian Balakowicz -103	common/cmd_bootm.c	Can't get kernel subimage node offset
2614f773bea8SMarian Balakowicz  103	common/cmd_bootm.c	Found configuration node
26151372cce2SMarian Balakowicz  104	common/cmd_bootm.c	Got kernel subimage node offset
26161372cce2SMarian Balakowicz -104	common/cmd_bootm.c	Kernel subimage hash verification failed
26171372cce2SMarian Balakowicz  105	common/cmd_bootm.c	Kernel subimage hash verification OK
26181372cce2SMarian Balakowicz -105	common/cmd_bootm.c	Kernel subimage is for unsupported architecture
26191372cce2SMarian Balakowicz  106	common/cmd_bootm.c	Architecture check OK
262011ccc33fSMarcel Ziswiler -106	common/cmd_bootm.c	Kernel subimage has wrong type
262111ccc33fSMarcel Ziswiler  107	common/cmd_bootm.c	Kernel subimage type OK
26221372cce2SMarian Balakowicz -107	common/cmd_bootm.c	Can't get kernel subimage data/size
26231372cce2SMarian Balakowicz  108	common/cmd_bootm.c	Got kernel subimage data/size
26241372cce2SMarian Balakowicz -108	common/cmd_bootm.c	Wrong image type (not legacy, FIT)
26251372cce2SMarian Balakowicz -109	common/cmd_bootm.c	Can't get kernel subimage type
26261372cce2SMarian Balakowicz -110	common/cmd_bootm.c	Can't get kernel subimage comp
26271372cce2SMarian Balakowicz -111	common/cmd_bootm.c	Can't get kernel subimage os
26281372cce2SMarian Balakowicz -112	common/cmd_bootm.c	Can't get kernel subimage load address
26291372cce2SMarian Balakowicz -113	common/cmd_bootm.c	Image uncompress/copy overwrite error
26301372cce2SMarian Balakowicz
26311372cce2SMarian Balakowicz  120	common/image.c		Start initial ramdisk verification
26321372cce2SMarian Balakowicz -120	common/image.c		Ramdisk FIT image has incorrect format
26331372cce2SMarian Balakowicz  121	common/image.c		Ramdisk FIT image has correct format
263411ccc33fSMarcel Ziswiler  122	common/image.c		No ramdisk subimage unit name, using configuration
26351372cce2SMarian Balakowicz -122	common/image.c		Can't get configuration for ramdisk subimage
26361372cce2SMarian Balakowicz  123	common/image.c		Ramdisk unit name specified
26371372cce2SMarian Balakowicz -124	common/image.c		Can't get ramdisk subimage node offset
26381372cce2SMarian Balakowicz  125	common/image.c		Got ramdisk subimage node offset
26391372cce2SMarian Balakowicz -125	common/image.c		Ramdisk subimage hash verification failed
26401372cce2SMarian Balakowicz  126	common/image.c		Ramdisk subimage hash verification OK
26411372cce2SMarian Balakowicz -126	common/image.c		Ramdisk subimage for unsupported architecture
26421372cce2SMarian Balakowicz  127	common/image.c		Architecture check OK
26431372cce2SMarian Balakowicz -127	common/image.c		Can't get ramdisk subimage data/size
26441372cce2SMarian Balakowicz  128	common/image.c		Got ramdisk subimage data/size
26451372cce2SMarian Balakowicz  129	common/image.c		Can't get ramdisk load address
26461372cce2SMarian Balakowicz -129	common/image.c		Got ramdisk load address
26471372cce2SMarian Balakowicz
264811ccc33fSMarcel Ziswiler -130	common/cmd_doc.c	Incorrect FIT image format
26491372cce2SMarian Balakowicz  131	common/cmd_doc.c	FIT image format OK
26501372cce2SMarian Balakowicz
265111ccc33fSMarcel Ziswiler -140	common/cmd_ide.c	Incorrect FIT image format
26521372cce2SMarian Balakowicz  141	common/cmd_ide.c	FIT image format OK
26531372cce2SMarian Balakowicz
265411ccc33fSMarcel Ziswiler -150	common/cmd_nand.c	Incorrect FIT image format
26551372cce2SMarian Balakowicz  151	common/cmd_nand.c	FIT image format OK
26561372cce2SMarian Balakowicz
2657d95f6ec7SGabe Black- FIT image support:
2658d95f6ec7SGabe Black		CONFIG_FIT
2659d95f6ec7SGabe Black		Enable support for the FIT uImage format.
2660d95f6ec7SGabe Black
2661d95f6ec7SGabe Black		CONFIG_FIT_BEST_MATCH
2662d95f6ec7SGabe Black		When no configuration is explicitly selected, default to the
2663d95f6ec7SGabe Black		one whose fdt's compatibility field best matches that of
2664d95f6ec7SGabe Black		U-Boot itself. A match is considered "best" if it matches the
2665d95f6ec7SGabe Black		most specific compatibility entry of U-Boot's fdt's root node.
2666d95f6ec7SGabe Black		The order of entries in the configuration's fdt is ignored.
2667d95f6ec7SGabe Black
26684cf2609bSWolfgang Denk- Standalone program support:
26694cf2609bSWolfgang Denk		CONFIG_STANDALONE_LOAD_ADDR
26704cf2609bSWolfgang Denk
26716feff899SWolfgang Denk		This option defines a board specific value for the
26726feff899SWolfgang Denk		address where standalone program gets loaded, thus
26736feff899SWolfgang Denk		overwriting the architecture dependent default
26744cf2609bSWolfgang Denk		settings.
26754cf2609bSWolfgang Denk
26764cf2609bSWolfgang Denk- Frame Buffer Address:
26774cf2609bSWolfgang Denk		CONFIG_FB_ADDR
26784cf2609bSWolfgang Denk
26794cf2609bSWolfgang Denk		Define CONFIG_FB_ADDR if you want to use specific
26804cf2609bSWolfgang Denk		address for frame buffer.
26814cf2609bSWolfgang Denk		Then system will reserve the frame buffer address to
26824cf2609bSWolfgang Denk		defined address instead of lcd_setmem (this function
26836feff899SWolfgang Denk		grabs the memory for frame buffer by panel's size).
26844cf2609bSWolfgang Denk
26854cf2609bSWolfgang Denk		Please see board_init_f function.
26864cf2609bSWolfgang Denk
2687cccfc2abSDetlev Zundel- Automatic software updates via TFTP server
2688cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP
2689cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_CNT_MAX
2690cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_MSEC_MAX
2691cccfc2abSDetlev Zundel
2692cccfc2abSDetlev Zundel		These options enable and control the auto-update feature;
2693cccfc2abSDetlev Zundel		for a more detailed description refer to doc/README.update.
2694cccfc2abSDetlev Zundel
2695cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support)
2696cccfc2abSDetlev Zundel		CONFIG_MTD_DEVICE
2697cccfc2abSDetlev Zundel
2698cccfc2abSDetlev Zundel		Adds the MTD device infrastructure from the Linux kernel.
2699cccfc2abSDetlev Zundel		Needed for mtdparts command support.
2700cccfc2abSDetlev Zundel
2701cccfc2abSDetlev Zundel		CONFIG_MTD_PARTITIONS
2702cccfc2abSDetlev Zundel
2703cccfc2abSDetlev Zundel		Adds the MTD partitioning infrastructure from the Linux
2704cccfc2abSDetlev Zundel		kernel. Needed for UBI support.
2705cccfc2abSDetlev Zundel
27066a11cf48SDaniel Schwierzeck- SPL framework
27076a11cf48SDaniel Schwierzeck		CONFIG_SPL
27086a11cf48SDaniel Schwierzeck		Enable building of SPL globally.
27096a11cf48SDaniel Schwierzeck
271095579793STom Rini		CONFIG_SPL_LDSCRIPT
271195579793STom Rini		LDSCRIPT for linking the SPL binary.
271295579793STom Rini
271395579793STom Rini		CONFIG_SPL_MAX_SIZE
271495579793STom Rini		Maximum binary size (text, data and rodata) of the SPL binary.
271595579793STom Rini
27166a11cf48SDaniel Schwierzeck		CONFIG_SPL_TEXT_BASE
27176a11cf48SDaniel Schwierzeck		TEXT_BASE for linking the SPL binary.
27186a11cf48SDaniel Schwierzeck
271994a45bb1SScott Wood		CONFIG_SPL_RELOC_TEXT_BASE
272094a45bb1SScott Wood		Address to relocate to.  If unspecified, this is equal to
272194a45bb1SScott Wood		CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
272294a45bb1SScott Wood
272395579793STom Rini		CONFIG_SPL_BSS_START_ADDR
272495579793STom Rini		Link address for the BSS within the SPL binary.
272595579793STom Rini
272695579793STom Rini		CONFIG_SPL_BSS_MAX_SIZE
272795579793STom Rini		Maximum binary size of the BSS section of the SPL binary.
272895579793STom Rini
272995579793STom Rini		CONFIG_SPL_STACK
273095579793STom Rini		Adress of the start of the stack SPL will use
273195579793STom Rini
273294a45bb1SScott Wood		CONFIG_SPL_RELOC_STACK
273394a45bb1SScott Wood		Adress of the start of the stack SPL will use after
273494a45bb1SScott Wood		relocation.  If unspecified, this is equal to
273594a45bb1SScott Wood		CONFIG_SPL_STACK.
273694a45bb1SScott Wood
273795579793STom Rini		CONFIG_SYS_SPL_MALLOC_START
273895579793STom Rini		Starting address of the malloc pool used in SPL.
273995579793STom Rini
274095579793STom Rini		CONFIG_SYS_SPL_MALLOC_SIZE
274195579793STom Rini		The size of the malloc pool used in SPL.
27426a11cf48SDaniel Schwierzeck
274347f7bcaeSTom Rini		CONFIG_SPL_FRAMEWORK
274447f7bcaeSTom Rini		Enable the SPL framework under common/.  This framework
274547f7bcaeSTom Rini		supports MMC, NAND and YMODEM loading of U-Boot and NAND
274647f7bcaeSTom Rini		NAND loading of the Linux Kernel.
274747f7bcaeSTom Rini
2748861a86f4STom Rini		CONFIG_SPL_DISPLAY_PRINT
2749861a86f4STom Rini		For ARM, enable an optional function to print more information
2750861a86f4STom Rini		about the running system.
2751861a86f4STom Rini
27524b919725SScott Wood		CONFIG_SPL_INIT_MINIMAL
27534b919725SScott Wood		Arch init code should be built for a very small image
27544b919725SScott Wood
27556a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBCOMMON_SUPPORT
27566a11cf48SDaniel Schwierzeck		Support for common/libcommon.o in SPL binary
27576a11cf48SDaniel Schwierzeck
27586a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBDISK_SUPPORT
27596a11cf48SDaniel Schwierzeck		Support for disk/libdisk.o in SPL binary
27606a11cf48SDaniel Schwierzeck
27616a11cf48SDaniel Schwierzeck		CONFIG_SPL_I2C_SUPPORT
27626a11cf48SDaniel Schwierzeck		Support for drivers/i2c/libi2c.o in SPL binary
27636a11cf48SDaniel Schwierzeck
27646a11cf48SDaniel Schwierzeck		CONFIG_SPL_GPIO_SUPPORT
27656a11cf48SDaniel Schwierzeck		Support for drivers/gpio/libgpio.o in SPL binary
27666a11cf48SDaniel Schwierzeck
27676a11cf48SDaniel Schwierzeck		CONFIG_SPL_MMC_SUPPORT
27686a11cf48SDaniel Schwierzeck		Support for drivers/mmc/libmmc.o in SPL binary
27696a11cf48SDaniel Schwierzeck
277095579793STom Rini		CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
277195579793STom Rini		CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
277295579793STom Rini		CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION
277395579793STom Rini		Address, size and partition on the MMC to load U-Boot from
277495579793STom Rini		when the MMC is being used in raw mode.
277595579793STom Rini
277695579793STom Rini		CONFIG_SPL_FAT_SUPPORT
277795579793STom Rini		Support for fs/fat/libfat.o in SPL binary
277895579793STom Rini
277995579793STom Rini		CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME
278095579793STom Rini		Filename to read to load U-Boot when reading from FAT
278195579793STom Rini
27826f2f01b9SScott Wood		CONFIG_SPL_NAND_BASE
27836f2f01b9SScott Wood		Include nand_base.c in the SPL.  Requires
27846f2f01b9SScott Wood		CONFIG_SPL_NAND_DRIVERS.
27856f2f01b9SScott Wood
27866f2f01b9SScott Wood		CONFIG_SPL_NAND_DRIVERS
27876f2f01b9SScott Wood		SPL uses normal NAND drivers, not minimal drivers.
27886f2f01b9SScott Wood
27896f2f01b9SScott Wood		CONFIG_SPL_NAND_ECC
27906f2f01b9SScott Wood		Include standard software ECC in the SPL
27916f2f01b9SScott Wood
279295579793STom Rini		CONFIG_SPL_NAND_SIMPLE
27937d4b7955SScott Wood		Support for NAND boot using simple NAND drivers that
27947d4b7955SScott Wood		expose the cmd_ctrl() interface.
279595579793STom Rini
279695579793STom Rini		CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
279795579793STom Rini		CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
279895579793STom Rini		CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
279995579793STom Rini		CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
280095579793STom Rini		CONFIG_SYS_NAND_ECCBYTES
280195579793STom Rini		Defines the size and behavior of the NAND that SPL uses
28027d4b7955SScott Wood		to read U-Boot
280395579793STom Rini
280495579793STom Rini		CONFIG_SYS_NAND_U_BOOT_OFFS
28057d4b7955SScott Wood		Location in NAND to read U-Boot from
28067d4b7955SScott Wood
28077d4b7955SScott Wood		CONFIG_SYS_NAND_U_BOOT_DST
28087d4b7955SScott Wood		Location in memory to load U-Boot to
28097d4b7955SScott Wood
28107d4b7955SScott Wood		CONFIG_SYS_NAND_U_BOOT_SIZE
28117d4b7955SScott Wood		Size of image to load
281295579793STom Rini
281395579793STom Rini		CONFIG_SYS_NAND_U_BOOT_START
28147d4b7955SScott Wood		Entry point in loaded image to jump to
281595579793STom Rini
281695579793STom Rini		CONFIG_SYS_NAND_HW_ECC_OOBFIRST
281795579793STom Rini		Define this if you need to first read the OOB and then the
281895579793STom Rini		data. This is used for example on davinci plattforms.
281995579793STom Rini
282095579793STom Rini		CONFIG_SPL_OMAP3_ID_NAND
282195579793STom Rini		Support for an OMAP3-specific set of functions to return the
282295579793STom Rini		ID and MFR of the first attached NAND chip, if present.
282395579793STom Rini
28246a11cf48SDaniel Schwierzeck		CONFIG_SPL_SERIAL_SUPPORT
28256a11cf48SDaniel Schwierzeck		Support for drivers/serial/libserial.o in SPL binary
28266a11cf48SDaniel Schwierzeck
28276a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_FLASH_SUPPORT
28286a11cf48SDaniel Schwierzeck		Support for drivers/mtd/spi/libspi_flash.o in SPL binary
28296a11cf48SDaniel Schwierzeck
28306a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_SUPPORT
28316a11cf48SDaniel Schwierzeck		Support for drivers/spi/libspi.o in SPL binary
28326a11cf48SDaniel Schwierzeck
2833c57b953dSPavel Machek		CONFIG_SPL_RAM_DEVICE
2834c57b953dSPavel Machek		Support for running image already present in ram, in SPL binary
2835c57b953dSPavel Machek
28366a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBGENERIC_SUPPORT
28376a11cf48SDaniel Schwierzeck		Support for lib/libgeneric.o in SPL binary
28381372cce2SMarian Balakowicz
2839ca2fca22SScott Wood		CONFIG_SPL_TARGET
2840ca2fca22SScott Wood		Final target image containing SPL and payload.  Some SPLs
2841ca2fca22SScott Wood		use an arch-specific makefile fragment instead, for
2842ca2fca22SScott Wood		example if more than one image needs to be produced.
2843ca2fca22SScott Wood
2844c609719bSwdenkModem Support:
2845c609719bSwdenk--------------
2846c609719bSwdenk
2847566e5cf4SWolfgang Denk[so far only for SMDK2400 boards]
2848c609719bSwdenk
284911ccc33fSMarcel Ziswiler- Modem support enable:
2850c609719bSwdenk		CONFIG_MODEM_SUPPORT
2851c609719bSwdenk
2852c609719bSwdenk- RTS/CTS Flow control enable:
2853c609719bSwdenk		CONFIG_HWFLOW
2854c609719bSwdenk
2855c609719bSwdenk- Modem debug support:
2856c609719bSwdenk		CONFIG_MODEM_SUPPORT_DEBUG
2857c609719bSwdenk
2858c609719bSwdenk		Enables debugging stuff (char screen[1024], dbg())
2859c609719bSwdenk		for modem support. Useful only with BDI2000.
2860c609719bSwdenk
2861a8c7c708Swdenk- Interrupt support (PPC):
2862a8c7c708Swdenk
2863a8c7c708Swdenk		There are common interrupt_init() and timer_interrupt()
2864a8c7c708Swdenk		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
286511ccc33fSMarcel Ziswiler		for CPU specific initialization. interrupt_init_cpu()
2866a8c7c708Swdenk		should set decrementer_count to appropriate value. If
286711ccc33fSMarcel Ziswiler		CPU resets decrementer automatically after interrupt
2868a8c7c708Swdenk		(ppc4xx) it should set decrementer_count to zero.
286911ccc33fSMarcel Ziswiler		timer_interrupt() calls timer_interrupt_cpu() for CPU
2870a8c7c708Swdenk		specific handling. If board has watchdog / status_led
2871a8c7c708Swdenk		/ other_activity_monitor it works automatically from
2872a8c7c708Swdenk		general timer_interrupt().
2873a8c7c708Swdenk
2874c609719bSwdenk- General:
2875c609719bSwdenk
2876c609719bSwdenk		In the target system modem support is enabled when a
2877c609719bSwdenk		specific key (key combination) is pressed during
2878c609719bSwdenk		power-on. Otherwise U-Boot will boot normally
287911ccc33fSMarcel Ziswiler		(autoboot). The key_pressed() function is called from
2880c609719bSwdenk		board_init(). Currently key_pressed() is a dummy
2881c609719bSwdenk		function, returning 1 and thus enabling modem
2882c609719bSwdenk		initialization.
2883c609719bSwdenk
2884c609719bSwdenk		If there are no modem init strings in the
2885c609719bSwdenk		environment, U-Boot proceed to autoboot; the
2886c609719bSwdenk		previous output (banner, info printfs) will be
288711ccc33fSMarcel Ziswiler		suppressed, though.
2888c609719bSwdenk
2889c609719bSwdenk		See also: doc/README.Modem
2890c609719bSwdenk
28919660e442SHelmut RaigerBoard initialization settings:
28929660e442SHelmut Raiger------------------------------
28939660e442SHelmut Raiger
28949660e442SHelmut RaigerDuring Initialization u-boot calls a number of board specific functions
28959660e442SHelmut Raigerto allow the preparation of board specific prerequisites, e.g. pin setup
28969660e442SHelmut Raigerbefore drivers are initialized. To enable these callbacks the
28979660e442SHelmut Raigerfollowing configuration macros have to be defined. Currently this is
28989660e442SHelmut Raigerarchitecture specific, so please check arch/your_architecture/lib/board.c
28999660e442SHelmut Raigertypically in board_init_f() and board_init_r().
29009660e442SHelmut Raiger
29019660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
29029660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
29039660e442SHelmut Raiger- CONFIG_BOARD_LATE_INIT: Call board_late_init()
29049660e442SHelmut Raiger- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
2905c609719bSwdenk
2906c609719bSwdenkConfiguration Settings:
2907c609719bSwdenk-----------------------
2908c609719bSwdenk
29096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
2910c609719bSwdenk		undefine this when you're short of memory.
2911c609719bSwdenk
29122fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
29132fb2604dSPeter Tyser		width of the commands listed in the 'help' command output.
29142fb2604dSPeter Tyser
29156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT:	This is what U-Boot prints on the console to
2916c609719bSwdenk		prompt for user input.
2917c609719bSwdenk
29186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE:	Buffer size for input from the Console
2919c609719bSwdenk
29206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE:	Buffer size for Console output
2921c609719bSwdenk
29226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS:	max. Number of arguments accepted for monitor commands
2923c609719bSwdenk
29246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
2925c609719bSwdenk		the application (usually a Linux kernel) when it is
2926c609719bSwdenk		booted
2927c609719bSwdenk
29286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE:
2929c609719bSwdenk		List of legal baudrate settings for this board.
2930c609719bSwdenk
29316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_INFO_QUIET
2932c609719bSwdenk		Suppress display of console information at boot.
2933c609719bSwdenk
29346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_IS_IN_ENV
2935c609719bSwdenk		If the board specific function
2936c609719bSwdenk			extern int overwrite_console (void);
2937c609719bSwdenk		returns 1, the stdin, stderr and stdout are switched to the
2938c609719bSwdenk		serial port, else the settings in the environment are used.
2939c609719bSwdenk
29406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
2941c609719bSwdenk		Enable the call to overwrite_console().
2942c609719bSwdenk
29436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
2944c609719bSwdenk		Enable overwrite of previous console environment settings.
2945c609719bSwdenk
29466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
2947c609719bSwdenk		Begin and End addresses of the area used by the
2948c609719bSwdenk		simple memory test.
2949c609719bSwdenk
29506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST:
2951c609719bSwdenk		Enable an alternate, more extensive memory test.
2952c609719bSwdenk
29536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH:
29545f535fe1Swdenk		Scratch address used by the alternate memory test
29555f535fe1Swdenk		You only need to set this if address zero isn't writeable
29565f535fe1Swdenk
29576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
29586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
295914f73ca6SStefan Roese		this specified memory area will get subtracted from the top
296011ccc33fSMarcel Ziswiler		(end) of RAM and won't get "touched" at all by U-Boot. By
296114f73ca6SStefan Roese		fixing up gd->ram_size the Linux kernel should gets passed
296214f73ca6SStefan Roese		the now "corrected" memory size and won't touch it either.
296314f73ca6SStefan Roese		This should work for arch/ppc and arch/powerpc. Only Linux
29645e12e75dSStefan Roese		board ports in arch/powerpc with bootwrapper support that
296514f73ca6SStefan Roese		recalculate the memory size from the SDRAM controller setup
29665e12e75dSStefan Roese		will have to get fixed in Linux additionally.
296714f73ca6SStefan Roese
296814f73ca6SStefan Roese		This option can be used as a workaround for the 440EPx/GRx
296914f73ca6SStefan Roese		CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
297014f73ca6SStefan Roese		be touched.
297114f73ca6SStefan Roese
297214f73ca6SStefan Roese		WARNING: Please make sure that this value is a multiple of
297314f73ca6SStefan Roese		the Linux page size (normally 4k). If this is not the case,
297414f73ca6SStefan Roese		then the end address of the Linux memory will be located at a
297514f73ca6SStefan Roese		non page size aligned address and this could cause major
297614f73ca6SStefan Roese		problems.
297714f73ca6SStefan Roese
29786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TFTP_LOADADDR:
2979c609719bSwdenk		Default load address for network file downloads
2980c609719bSwdenk
29816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE:
2982c609719bSwdenk		Enable temporary baudrate change while serial download
2983c609719bSwdenk
29846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE:
2985c609719bSwdenk		Physical start address of SDRAM. _Must_ be 0 here.
2986c609719bSwdenk
29876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MBIO_BASE:
2988c609719bSwdenk		Physical start address of Motherboard I/O (if using a
2989c609719bSwdenk		Cogent motherboard)
2990c609719bSwdenk
29916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE:
2992c609719bSwdenk		Physical start address of Flash memory.
2993c609719bSwdenk
29946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE:
2995c609719bSwdenk		Physical start address of boot monitor code (set by
2996c609719bSwdenk		make config files to be same as the text base address
299714d0a02aSWolfgang Denk		(CONFIG_SYS_TEXT_BASE) used when linking) - same as
29986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FLASH_BASE when booting from flash.
2999c609719bSwdenk
30006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN:
30013b57fe0aSwdenk		Size of memory reserved for monitor code, used to
30023b57fe0aSwdenk		determine _at_compile_time_ (!) if the environment is
30033b57fe0aSwdenk		embedded within the U-Boot image, or in a separate
30043b57fe0aSwdenk		flash sector.
3005c609719bSwdenk
30066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN:
3007c609719bSwdenk		Size of DRAM reserved for malloc() use.
3008c609719bSwdenk
30096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN:
301015940c9aSStefan Roese		Normally compressed uImages are limited to an
301115940c9aSStefan Roese		uncompressed size of 8 MBytes. If this is not enough,
30126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		you can define CONFIG_SYS_BOOTM_LEN in your board config file
301315940c9aSStefan Roese		to adjust this setting to your needs.
3014c609719bSwdenk
30156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ:
3016c609719bSwdenk		Maximum size of memory mapped by the startup code of
3017c609719bSwdenk		the Linux kernel; all data that must be processed by
30187d721e34SBartlomiej Sieka		the Linux kernel (bd_info, boot arguments, FDT blob if
30197d721e34SBartlomiej Sieka		used) must be put below this limit, unless "bootm_low"
30207d721e34SBartlomiej Sieka		enviroment variable is defined and non-zero. In such case
30217d721e34SBartlomiej Sieka		all data for the Linux kernel must be between "bootm_low"
3022c3624e6eSGrant Likely		and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.	 The environment
3023c3624e6eSGrant Likely		variable "bootm_mapsize" will override the value of
3024c3624e6eSGrant Likely		CONFIG_SYS_BOOTMAPSZ.  If CONFIG_SYS_BOOTMAPSZ is undefined,
3025c3624e6eSGrant Likely		then the value in "bootm_size" will be used instead.
3026c609719bSwdenk
3027fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3028fca43cc8SJohn Rigby		Enable initrd_high functionality.  If defined then the
3029fca43cc8SJohn Rigby		initrd_high feature is enabled and the bootm ramdisk subcommand
3030fca43cc8SJohn Rigby		is enabled.
3031fca43cc8SJohn Rigby
3032fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_CMDLINE:
3033fca43cc8SJohn Rigby		Enables allocating and saving kernel cmdline in space between
3034fca43cc8SJohn Rigby		"bootm_low" and "bootm_low" + BOOTMAPSZ.
3035fca43cc8SJohn Rigby
3036fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_KBD:
3037fca43cc8SJohn Rigby		Enables allocating and saving a kernel copy of the bd_info in
3038fca43cc8SJohn Rigby		space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3039fca43cc8SJohn Rigby
30406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS:
3041c609719bSwdenk		Max number of Flash memory banks
3042c609719bSwdenk
30436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT:
3044c609719bSwdenk		Max number of sectors on a Flash chip
3045c609719bSwdenk
30466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT:
3047c609719bSwdenk		Timeout for Flash erase operations (in ms)
3048c609719bSwdenk
30496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT:
3050c609719bSwdenk		Timeout for Flash write operations (in ms)
3051c609719bSwdenk
30526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT
30538564acf9Swdenk		Timeout for Flash set sector lock bit operation (in ms)
30548564acf9Swdenk
30556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT
30568564acf9Swdenk		Timeout for Flash clear lock bits operation (in ms)
30578564acf9Swdenk
30586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION
30598564acf9Swdenk		If defined, hardware flash sectors protection is used
30608564acf9Swdenk		instead of U-Boot software protection.
30618564acf9Swdenk
30626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP:
3063c609719bSwdenk
3064c609719bSwdenk		Enable TFTP transfers directly to flash memory;
3065c609719bSwdenk		without this option such a download has to be
3066c609719bSwdenk		performed in two steps: (1) download to RAM, and (2)
3067c609719bSwdenk		copy from RAM to flash.
3068c609719bSwdenk
3069c609719bSwdenk		The two-step approach is usually more reliable, since
3070c609719bSwdenk		you can check if the download worked before you erase
307111ccc33fSMarcel Ziswiler		the flash, but in some situations (when system RAM is
307211ccc33fSMarcel Ziswiler		too limited to allow for a temporary copy of the
3073c609719bSwdenk		downloaded image) this option may be very useful.
3074c609719bSwdenk
30756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI:
3076c609719bSwdenk		Define if the flash driver uses extra elements in the
30775653fc33Swdenk		common flash structure for storing flash geometry.
30785653fc33Swdenk
307900b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER
30805653fc33Swdenk		This option also enables the building of the cfi_flash driver
30815653fc33Swdenk		in the drivers directory
308253cf9435Sstroese
308391809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD
308491809ed5SPiotr Ziecik		This option enables the building of the cfi_mtd driver
308591809ed5SPiotr Ziecik		in the drivers directory. The driver exports CFI flash
308691809ed5SPiotr Ziecik		to the MTD layer.
308791809ed5SPiotr Ziecik
30886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
308996ef831fSGuennadi Liakhovetski		Use buffered writes to flash.
309096ef831fSGuennadi Liakhovetski
309196ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N
309296ef831fSGuennadi Liakhovetski		s29ws-n MirrorBit flash has non-standard addresses for buffered
309396ef831fSGuennadi Liakhovetski		write commands.
309496ef831fSGuennadi Liakhovetski
30956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST
30965568e613SStefan Roese		If this option is defined, the common CFI flash doesn't
30975568e613SStefan Roese		print it's warning upon not recognized FLASH banks. This
30985568e613SStefan Roese		is useful, if some of the configured banks are only
30995568e613SStefan Roese		optionally available.
31005568e613SStefan Roese
31019a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS
31029a042e9cSJerry Van Baren		If defined (must be an integer), print out countdown
31039a042e9cSJerry Van Baren		digits and dots.  Recommended value: 45 (9..1) for 80
31049a042e9cSJerry Van Baren		column displays, 15 (3..1) for 40 column displays.
31059a042e9cSJerry Van Baren
31066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER:
310711ccc33fSMarcel Ziswiler		Defines the number of Ethernet receive buffers. On some
310811ccc33fSMarcel Ziswiler		Ethernet controllers it is recommended to set this value
310953cf9435Sstroese		to 8 or even higher (EEPRO100 or 405 EMAC), since all
311053cf9435Sstroese		buffers can be full shortly after enabling the interface
311111ccc33fSMarcel Ziswiler		on high Ethernet traffic.
311253cf9435Sstroese		Defaults to 4 if not defined.
3113c609719bSwdenk
3114ea882bafSWolfgang Denk- CONFIG_ENV_MAX_ENTRIES
3115ea882bafSWolfgang Denk
3116ea882bafSWolfgang Denk	Maximum number of entries in the hash table that is used
3117ea882bafSWolfgang Denk	internally to store the environment settings. The default
3118ea882bafSWolfgang Denk	setting is supposed to be generous and should work in most
3119ea882bafSWolfgang Denk	cases. This setting can be used to tune behaviour; see
3120ea882bafSWolfgang Denk	lib/hashtable.c for details.
3121ea882bafSWolfgang Denk
31222598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_DEFAULT
31232598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_STATIC
31242598090bSJoe Hershberger	Enable validation of the values given to enviroment variables when
31252598090bSJoe Hershberger	calling env set.  Variables can be restricted to only decimal,
31262598090bSJoe Hershberger	hexadecimal, or boolean.  If CONFIG_CMD_NET is also defined,
31272598090bSJoe Hershberger	the variables can also be restricted to IP address or MAC address.
31282598090bSJoe Hershberger
31292598090bSJoe Hershberger	The format of the list is:
31302598090bSJoe Hershberger		type_attribute = [s|d|x|b|i|m]
3131*267541f7SJoe Hershberger		access_atribute = [a|r|o|c]
3132*267541f7SJoe Hershberger		attributes = type_attribute[access_atribute]
31332598090bSJoe Hershberger		entry = variable_name[:attributes]
31342598090bSJoe Hershberger		list = entry[,list]
31352598090bSJoe Hershberger
31362598090bSJoe Hershberger	The type attributes are:
31372598090bSJoe Hershberger		s - String (default)
31382598090bSJoe Hershberger		d - Decimal
31392598090bSJoe Hershberger		x - Hexadecimal
31402598090bSJoe Hershberger		b - Boolean ([1yYtT|0nNfF])
31412598090bSJoe Hershberger		i - IP address
31422598090bSJoe Hershberger		m - MAC address
31432598090bSJoe Hershberger
3144*267541f7SJoe Hershberger	The access attributes are:
3145*267541f7SJoe Hershberger		a - Any (default)
3146*267541f7SJoe Hershberger		r - Read-only
3147*267541f7SJoe Hershberger		o - Write-once
3148*267541f7SJoe Hershberger		c - Change-default
3149*267541f7SJoe Hershberger
31502598090bSJoe Hershberger	- CONFIG_ENV_FLAGS_LIST_DEFAULT
31512598090bSJoe Hershberger		Define this to a list (string) to define the ".flags"
31522598090bSJoe Hershberger		envirnoment variable in the default or embedded environment.
31532598090bSJoe Hershberger
31542598090bSJoe Hershberger	- CONFIG_ENV_FLAGS_LIST_STATIC
31552598090bSJoe Hershberger		Define this to a list (string) to define validation that
31562598090bSJoe Hershberger		should be done if an entry is not found in the ".flags"
31572598090bSJoe Hershberger		environment variable.  To override a setting in the static
31582598090bSJoe Hershberger		list, simply add an entry for the same variable name to the
31592598090bSJoe Hershberger		".flags" variable.
31602598090bSJoe Hershberger
3161*267541f7SJoe Hershberger- CONFIG_ENV_ACCESS_IGNORE_FORCE
3162*267541f7SJoe Hershberger	If defined, don't allow the -f switch to env set override variable
3163*267541f7SJoe Hershberger	access flags.
3164*267541f7SJoe Hershberger
3165c609719bSwdenkThe following definitions that deal with the placement and management
3166c609719bSwdenkof environment data (variable area); in general, we support the
3167c609719bSwdenkfollowing configurations:
3168c609719bSwdenk
3169c3eb3fe4SMike Frysinger- CONFIG_BUILD_ENVCRC:
3170c3eb3fe4SMike Frysinger
3171c3eb3fe4SMike Frysinger	Builds up envcrc with the target environment so that external utils
3172c3eb3fe4SMike Frysinger	may easily extract it and embed it in final U-Boot images.
3173c3eb3fe4SMike Frysinger
31745a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH:
3175c609719bSwdenk
3176c609719bSwdenk	Define this if the environment is in flash memory.
3177c609719bSwdenk
3178c609719bSwdenk	a) The environment occupies one whole flash sector, which is
3179c609719bSwdenk	   "embedded" in the text segment with the U-Boot code. This
3180c609719bSwdenk	   happens usually with "bottom boot sector" or "top boot
3181c609719bSwdenk	   sector" type flash chips, which have several smaller
3182c609719bSwdenk	   sectors at the start or the end. For instance, such a
3183c609719bSwdenk	   layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3184c609719bSwdenk	   such a case you would place the environment in one of the
3185c609719bSwdenk	   4 kB sectors - with U-Boot code before and after it. With
3186c609719bSwdenk	   "top boot sector" type flash chips, you would put the
3187c609719bSwdenk	   environment in one of the last sectors, leaving a gap
3188c609719bSwdenk	   between U-Boot and the environment.
3189c609719bSwdenk
31900e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
3191c609719bSwdenk
3192c609719bSwdenk	   Offset of environment data (variable area) to the
3193c609719bSwdenk	   beginning of flash memory; for instance, with bottom boot
3194c609719bSwdenk	   type flash chips the second sector can be used: the offset
3195c609719bSwdenk	   for this sector is given here.
3196c609719bSwdenk
31976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
3198c609719bSwdenk
31990e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
3200c609719bSwdenk
3201c609719bSwdenk	   This is just another way to specify the start address of
3202c609719bSwdenk	   the flash sector containing the environment (instead of
32030e8d1586SJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET).
3204c609719bSwdenk
32050e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SECT_SIZE:
3206c609719bSwdenk
3207c609719bSwdenk	   Size of the sector containing the environment.
3208c609719bSwdenk
3209c609719bSwdenk
3210c609719bSwdenk	b) Sometimes flash chips have few, equal sized, BIG sectors.
3211c609719bSwdenk	   In such a case you don't want to spend a whole sector for
3212c609719bSwdenk	   the environment.
3213c609719bSwdenk
32140e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3215c609719bSwdenk
32165a1aceb0SJean-Christophe PLAGNIOL-VILLARD	   If you use this in combination with CONFIG_ENV_IS_IN_FLASH
32170e8d1586SJean-Christophe PLAGNIOL-VILLARD	   and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
3218c609719bSwdenk	   of this flash sector for the environment. This saves
3219c609719bSwdenk	   memory for the RAM copy of the environment.
3220c609719bSwdenk
3221c609719bSwdenk	   It may also save flash memory if you decide to use this
3222c609719bSwdenk	   when your environment is "embedded" within U-Boot code,
3223c609719bSwdenk	   since then the remainder of the flash sector could be used
3224c609719bSwdenk	   for U-Boot code. It should be pointed out that this is
3225c609719bSwdenk	   STRONGLY DISCOURAGED from a robustness point of view:
3226c609719bSwdenk	   updating the environment in flash makes it always
3227c609719bSwdenk	   necessary to erase the WHOLE sector. If something goes
3228c609719bSwdenk	   wrong before the contents has been restored from a copy in
3229c609719bSwdenk	   RAM, your target system will be dead.
3230c609719bSwdenk
32310e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR_REDUND
32320e8d1586SJean-Christophe PLAGNIOL-VILLARD	  CONFIG_ENV_SIZE_REDUND
3233c609719bSwdenk
3234c609719bSwdenk	   These settings describe a second storage area used to hold
323511ccc33fSMarcel Ziswiler	   a redundant copy of the environment data, so that there is
32363e38691eSwdenk	   a valid backup copy in case there is a power failure during
3237c609719bSwdenk	   a "saveenv" operation.
3238c609719bSwdenk
3239c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the
3240c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds*
3241c609719bSwdenkaccordingly!
3242c609719bSwdenk
3243c609719bSwdenk
32449314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM:
3245c609719bSwdenk
3246c609719bSwdenk	Define this if you have some non-volatile memory device
3247c609719bSwdenk	(NVRAM, battery buffered SRAM) which you want to use for the
3248c609719bSwdenk	environment.
3249c609719bSwdenk
32500e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
32510e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3252c609719bSwdenk
325311ccc33fSMarcel Ziswiler	  These two #defines are used to determine the memory area you
3254c609719bSwdenk	  want to use for environment. It is assumed that this memory
3255c609719bSwdenk	  can just be read and written to, without any special
3256c609719bSwdenk	  provision.
3257c609719bSwdenk
3258c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early
3259c609719bSwdenkin U-Boot initalization (when we try to get the setting of for the
326011ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or
3261c609719bSwdenkU-Boot will hang.
3262c609719bSwdenk
3263c609719bSwdenkPlease note that even with NVRAM we still use a copy of the
3264c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to
3265c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv"
3266c609719bSwdenkto save the current settings.
3267c609719bSwdenk
3268c609719bSwdenk
3269bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM:
3270c609719bSwdenk
3271c609719bSwdenk	Use this if you have an EEPROM or similar serial access
3272c609719bSwdenk	device and a driver for it.
3273c609719bSwdenk
32740e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
32750e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3276c609719bSwdenk
3277c609719bSwdenk	  These two #defines specify the offset and size of the
3278c609719bSwdenk	  environment area within the total memory of your EEPROM.
3279c609719bSwdenk
32806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR:
3281c609719bSwdenk	  If defined, specified the chip address of the EEPROM device.
3282c609719bSwdenk	  The default address is zero.
3283c609719bSwdenk
32846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
3285c609719bSwdenk	  If defined, the number of bits used to address bytes in a
3286c609719bSwdenk	  single page in the EEPROM device.  A 64 byte page, for example
3287c609719bSwdenk	  would require six bits.
3288c609719bSwdenk
32896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
3290c609719bSwdenk	  If defined, the number of milliseconds to delay between
3291c609719bSwdenk	  page writes.	The default is zero milliseconds.
3292c609719bSwdenk
32936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
3294c609719bSwdenk	  The length in bytes of the EEPROM memory array address.  Note
3295c609719bSwdenk	  that this is NOT the chip address length!
3296c609719bSwdenk
32976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
32985cf91d6bSwdenk	  EEPROM chips that implement "address overflow" are ones
32995cf91d6bSwdenk	  like Catalyst 24WC04/08/16 which has 9/10/11 bits of
33005cf91d6bSwdenk	  address and the extra bits end up in the "chip address" bit
33015cf91d6bSwdenk	  slots. This makes a 24WC08 (1Kbyte) chip look like four 256
33025cf91d6bSwdenk	  byte chips.
33035cf91d6bSwdenk
33045cf91d6bSwdenk	  Note that we consider the length of the address field to
33055cf91d6bSwdenk	  still be one byte because the extra address bits are hidden
33065cf91d6bSwdenk	  in the chip address.
33075cf91d6bSwdenk
33086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_SIZE:
3309c609719bSwdenk	  The size in bytes of the EEPROM device.
3310c609719bSwdenk
3311548738b4SHeiko Schocher	- CONFIG_ENV_EEPROM_IS_ON_I2C
3312548738b4SHeiko Schocher	  define this, if you have I2C and SPI activated, and your
3313548738b4SHeiko Schocher	  EEPROM, which holds the environment, is on the I2C bus.
3314548738b4SHeiko Schocher
3315548738b4SHeiko Schocher	- CONFIG_I2C_ENV_EEPROM_BUS
3316548738b4SHeiko Schocher	  if you have an Environment on an EEPROM reached over
3317548738b4SHeiko Schocher	  I2C muxes, you can define here, how to reach this
3318548738b4SHeiko Schocher	  EEPROM. For example:
3319548738b4SHeiko Schocher
3320548738b4SHeiko Schocher	  #define CONFIG_I2C_ENV_EEPROM_BUS	  "pca9547:70:d\0"
3321548738b4SHeiko Schocher
3322548738b4SHeiko Schocher	  EEPROM which holds the environment, is reached over
3323548738b4SHeiko Schocher	  a pca9547 i2c mux with address 0x70, channel 3.
3324c609719bSwdenk
3325057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH:
33265779d8d9Swdenk
33275779d8d9Swdenk	Define this if you have a DataFlash memory device which you
33285779d8d9Swdenk	want to use for the environment.
33295779d8d9Swdenk
33300e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
33310e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
33320e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
33335779d8d9Swdenk
33345779d8d9Swdenk	  These three #defines specify the offset and size of the
33355779d8d9Swdenk	  environment area within the total memory of your DataFlash placed
33365779d8d9Swdenk	  at the specified address.
33375779d8d9Swdenk
33380a85a9e7SLiu Gang- CONFIG_ENV_IS_IN_REMOTE:
33390a85a9e7SLiu Gang
33400a85a9e7SLiu Gang	Define this if you have a remote memory space which you
33410a85a9e7SLiu Gang	want to use for the local device's environment.
33420a85a9e7SLiu Gang
33430a85a9e7SLiu Gang	- CONFIG_ENV_ADDR:
33440a85a9e7SLiu Gang	- CONFIG_ENV_SIZE:
33450a85a9e7SLiu Gang
33460a85a9e7SLiu Gang	  These two #defines specify the address and size of the
33470a85a9e7SLiu Gang	  environment area within the remote memory space. The
33480a85a9e7SLiu Gang	  local device can get the environment from remote memory
3349fc54c7faSLiu Gang	  space by SRIO or PCIE links.
33500a85a9e7SLiu Gang
33510a85a9e7SLiu GangBE CAREFUL! For some special cases, the local device can not use
33520a85a9e7SLiu Gang"saveenv" command. For example, the local device will get the
3353fc54c7faSLiu Gangenvironment stored in a remote NOR flash by SRIO or PCIE link,
3354fc54c7faSLiu Gangbut it can not erase, write this NOR flash by SRIO or PCIE interface.
33550a85a9e7SLiu Gang
335651bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND:
335713a5695bSwdenk
335813a5695bSwdenk	Define this if you have a NAND device which you want to use
335913a5695bSwdenk	for the environment.
336013a5695bSwdenk
33610e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
33620e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
336313a5695bSwdenk
336413a5695bSwdenk	  These two #defines specify the offset and size of the environment
3365fdd813deSScott Wood	  area within the first NAND device.  CONFIG_ENV_OFFSET must be
3366fdd813deSScott Wood	  aligned to an erase block boundary.
33675779d8d9Swdenk
3368fdd813deSScott Wood	- CONFIG_ENV_OFFSET_REDUND (optional):
3369e443c944SMarkus Klotzbuecher
33700e8d1586SJean-Christophe PLAGNIOL-VILLARD	  This setting describes a second storage area of CONFIG_ENV_SIZE
3371fdd813deSScott Wood	  size used to hold a redundant copy of the environment data, so
3372fdd813deSScott Wood	  that there is a valid backup copy in case there is a power failure
3373fdd813deSScott Wood	  during a "saveenv" operation.	 CONFIG_ENV_OFFSET_RENDUND must be
3374fdd813deSScott Wood	  aligned to an erase block boundary.
3375e443c944SMarkus Klotzbuecher
3376fdd813deSScott Wood	- CONFIG_ENV_RANGE (optional):
3377fdd813deSScott Wood
3378fdd813deSScott Wood	  Specifies the length of the region in which the environment
3379fdd813deSScott Wood	  can be written.  This should be a multiple of the NAND device's
3380fdd813deSScott Wood	  block size.  Specifying a range with more erase blocks than
3381fdd813deSScott Wood	  are needed to hold CONFIG_ENV_SIZE allows bad blocks within
3382fdd813deSScott Wood	  the range to be avoided.
3383fdd813deSScott Wood
3384fdd813deSScott Wood	- CONFIG_ENV_OFFSET_OOB (optional):
3385fdd813deSScott Wood
3386fdd813deSScott Wood	  Enables support for dynamically retrieving the offset of the
3387fdd813deSScott Wood	  environment from block zero's out-of-band data.  The
3388fdd813deSScott Wood	  "nand env.oob" command can be used to record this offset.
3389fdd813deSScott Wood	  Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
3390fdd813deSScott Wood	  using CONFIG_ENV_OFFSET_OOB.
3391e443c944SMarkus Klotzbuecher
3392b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST
3393b74ab737SGuennadi Liakhovetski
3394b74ab737SGuennadi Liakhovetski	Defines address in RAM to which the nand_spl code should copy the
3395b74ab737SGuennadi Liakhovetski	environment. If redundant environment is used, it will be copied to
3396b74ab737SGuennadi Liakhovetski	CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3397b74ab737SGuennadi Liakhovetski
33986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET
3399c609719bSwdenk
3400c609719bSwdenk	Defines offset to the initial SPI buffer area in DPRAM. The
3401c609719bSwdenk	area is used at an early stage (ROM part) if the environment
3402c609719bSwdenk	is configured to reside in the SPI EEPROM: We need a 520 byte
3403c609719bSwdenk	scratch DPRAM area. It is used between the two initialization
3404c609719bSwdenk	calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
3405c609719bSwdenk	to be a good choice since it makes it far enough from the
3406c609719bSwdenk	start of the data area as well as from the stack pointer.
3407c609719bSwdenk
3408e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor
3409c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been
3410cdb74977SWolfgang Denkcreated; also, when using EEPROM you will have to use getenv_f()
3411c609719bSwdenkuntil then to read environment variables.
3412c609719bSwdenk
341385ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor
341485ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working
341585ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is
341685ec0bccSwdenknecessary, because the first environment variable we need is the
341785ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't
341885ec0bccSwdenkhave any device yet where we could complain.]
3419c609719bSwdenk
3420c609719bSwdenkNote: once the monitor has been relocated, then it will complain if
3421c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you
342285ec0bccSwdenkuse the "saveenv" command to store a valid environment.
3423c609719bSwdenk
34246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
3425fc3e2165Swdenk		Echo the inverted Ethernet link state to the fault LED.
3426fc3e2165Swdenk
34276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
3428fc3e2165Swdenk		      also needs to be defined.
3429fc3e2165Swdenk
34306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR:
3431fc3e2165Swdenk		MII address of the PHY to check for the Ethernet link state.
3432c609719bSwdenk
3433f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS:
3434f5675aa5SRon Madrid		Define this if you desire to only have use of the NS16550_init
3435f5675aa5SRon Madrid		and NS16550_putc functions for the serial driver located at
3436f5675aa5SRon Madrid		drivers/serial/ns16550.c.  This option is useful for saving
3437f5675aa5SRon Madrid		space for already greatly restricted images, including but not
3438f5675aa5SRon Madrid		limited to NAND_SPL configurations.
3439f5675aa5SRon Madrid
3440c609719bSwdenkLow Level (hardware related) configuration options:
3441dc7c9a1aSwdenk---------------------------------------------------
3442c609719bSwdenk
34436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE:
3444c609719bSwdenk		Cache Line Size of the CPU.
3445c609719bSwdenk
34466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR:
3447c609719bSwdenk		Default address of the IMMR after system reset.
34482535d602Swdenk
34492535d602Swdenk		Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
34502535d602Swdenk		and RPXsuper) to be able to adjust the position of
34512535d602Swdenk		the IMMR register after a reset.
3452c609719bSwdenk
3453e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_DEFAULT:
3454e46fedfeSTimur Tabi		Default (power-on reset) physical address of CCSR on Freescale
3455e46fedfeSTimur Tabi		PowerPC SOCs.
3456e46fedfeSTimur Tabi
3457e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR:
3458e46fedfeSTimur Tabi		Virtual address of CCSR.  On a 32-bit build, this is typically
3459e46fedfeSTimur Tabi		the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
3460e46fedfeSTimur Tabi
3461e46fedfeSTimur Tabi		CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
3462e46fedfeSTimur Tabi		for cross-platform code that uses that macro instead.
3463e46fedfeSTimur Tabi
3464e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS:
3465e46fedfeSTimur Tabi		Physical address of CCSR.  CCSR can be relocated to a new
3466e46fedfeSTimur Tabi		physical address, if desired.  In this case, this macro should
3467e46fedfeSTimur Tabi		be set to that address.	 Otherwise, it should be set to the
3468e46fedfeSTimur Tabi		same value as CONFIG_SYS_CCSRBAR_DEFAULT.  For example, CCSR
3469e46fedfeSTimur Tabi		is typically relocated on 36-bit builds.  It is recommended
3470e46fedfeSTimur Tabi		that this macro be defined via the _HIGH and _LOW macros:
3471e46fedfeSTimur Tabi
3472e46fedfeSTimur Tabi		#define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3473e46fedfeSTimur Tabi			* 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3474e46fedfeSTimur Tabi
3475e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
3476e46fedfeSTimur Tabi		Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS.	This value is typically
3477e46fedfeSTimur Tabi		either 0 (32-bit build) or 0xF (36-bit build).	This macro is
3478e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
3479e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
3480e46fedfeSTimur Tabi
3481e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_LOW:
3482e46fedfeSTimur Tabi		Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS.  This macro is
3483e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
3484e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
3485e46fedfeSTimur Tabi
3486e46fedfeSTimur Tabi- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
3487e46fedfeSTimur Tabi		If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
3488e46fedfeSTimur Tabi		forced to a value that ensures that CCSR is not relocated.
3489e46fedfeSTimur Tabi
34907f6c2cbcSwdenk- Floppy Disk Support:
34916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER
34927f6c2cbcSwdenk
34937f6c2cbcSwdenk		the default drive number (default value 0)
34947f6c2cbcSwdenk
34956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_STRIDE
34967f6c2cbcSwdenk
349711ccc33fSMarcel Ziswiler		defines the spacing between FDC chipset registers
34987f6c2cbcSwdenk		(default value 1)
34997f6c2cbcSwdenk
35006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_OFFSET
35017f6c2cbcSwdenk
35027f6c2cbcSwdenk		defines the offset of register from address. It
35037f6c2cbcSwdenk		depends on which part of the data bus is connected to
350411ccc33fSMarcel Ziswiler		the FDC chipset. (default value 0)
35057f6c2cbcSwdenk
35066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
35076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
35087f6c2cbcSwdenk		default value.
35097f6c2cbcSwdenk
35106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		if CONFIG_SYS_FDC_HW_INIT is defined, then the function
35117f6c2cbcSwdenk		fdc_hw_init() is called at the beginning of the FDC
35127f6c2cbcSwdenk		setup. fdc_hw_init() must be provided by the board
35137f6c2cbcSwdenk		source code. It is used to make hardware dependant
35147f6c2cbcSwdenk		initializations.
35157f6c2cbcSwdenk
35160abddf82SMacpaul Lin- CONFIG_IDE_AHB:
35170abddf82SMacpaul Lin		Most IDE controllers were designed to be connected with PCI
35180abddf82SMacpaul Lin		interface. Only few of them were designed for AHB interface.
35190abddf82SMacpaul Lin		When software is doing ATA command and data transfer to
35200abddf82SMacpaul Lin		IDE devices through IDE-AHB controller, some additional
35210abddf82SMacpaul Lin		registers accessing to these kind of IDE-AHB controller
35220abddf82SMacpaul Lin		is requierd.
35230abddf82SMacpaul Lin
35246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR:	Physical address of the Internal Memory.
352525d6712aSwdenk		DO NOT CHANGE unless you know exactly what you're
352625d6712aSwdenk		doing! (11-4) [MPC8xx/82xx systems only]
3527c609719bSwdenk
35286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR:
3529c609719bSwdenk
35307152b1d0Swdenk		Start address of memory area that can be used for
3531c609719bSwdenk		initial data and stack; please note that this must be
3532c609719bSwdenk		writable memory that is working WITHOUT special
3533c609719bSwdenk		initialization, i. e. you CANNOT use normal RAM which
3534c609719bSwdenk		will become available only after programming the
3535c609719bSwdenk		memory controller and running certain initialization
3536c609719bSwdenk		sequences.
3537c609719bSwdenk
3538c609719bSwdenk		U-Boot uses the following memory types:
3539c609719bSwdenk		- MPC8xx and MPC8260: IMMR (internal memory of the CPU)
3540c609719bSwdenk		- MPC824X: data cache
3541c609719bSwdenk		- PPC4xx:  data cache
3542c609719bSwdenk
35436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET:
3544c609719bSwdenk
3545c609719bSwdenk		Offset of the initial data structure in the memory
35466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
35476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
3548c609719bSwdenk		data is located at the end of the available space
3549553f0982SWolfgang Denk		(sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
35506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
35516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
35526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET) downward.
3553c609719bSwdenk
3554c609719bSwdenk	Note:
3555c609719bSwdenk		On the MPC824X (or other systems that use the data
3556c609719bSwdenk		cache for initial memory) the address chosen for
35576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
3558c609719bSwdenk		point to an otherwise UNUSED address space between
3559c609719bSwdenk		the top of RAM and the start of the PCI space.
3560c609719bSwdenk
35616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR:	SIU Module Configuration (11-6)
3562c609719bSwdenk
35636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR:	System Protection Control (11-9)
3564c609719bSwdenk
35656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR:	Time Base Status and Control (11-26)
3566c609719bSwdenk
35676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR:	Periodic Interrupt Status and Control (11-31)
3568c609719bSwdenk
35696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR:	PLL, Low-Power, and Reset Control Register (15-30)
3570c609719bSwdenk
35716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR:	System Clock and reset Control Register (15-27)
3572c609719bSwdenk
35736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM:
3574c609719bSwdenk		SDRAM timing
3575c609719bSwdenk
35766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA:
3577c609719bSwdenk		periodic timer for refresh
3578c609719bSwdenk
35796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER:	Debug Event Register (37-47)
3580c609719bSwdenk
35816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
35826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
35836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
35846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_BR1_PRELIM:
3585c609719bSwdenk		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
3586c609719bSwdenk
3587c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
35886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
35896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
3590c609719bSwdenk		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
3591c609719bSwdenk
35926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
35936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
3594c609719bSwdenk		Machine Mode Register and Memory Periodic Timer
3595c609719bSwdenk		Prescaler definitions (SDRAM timing)
3596c609719bSwdenk
35976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
3598c609719bSwdenk		enable I2C microcode relocation patch (MPC8xx);
3599c609719bSwdenk		define relocation offset in DPRAM [DSP2]
3600c609719bSwdenk
36016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
3602b423d055SHeiko Schocher		enable SMC microcode relocation patch (MPC8xx);
3603b423d055SHeiko Schocher		define relocation offset in DPRAM [SMC1]
3604b423d055SHeiko Schocher
36056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
3606c609719bSwdenk		enable SPI microcode relocation patch (MPC8xx);
3607c609719bSwdenk		define relocation offset in DPRAM [SCC4]
3608c609719bSwdenk
36096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_USE_OSCCLK:
3610c609719bSwdenk		Use OSCM clock mode on MBX8xx board. Be careful,
3611c609719bSwdenk		wrong setting might damage your board. Read
3612c609719bSwdenk		doc/README.MBX before setting this variable!
3613c609719bSwdenk
36146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
3615ea909b76Swdenk		Offset of the bootmode word in DPRAM used by post
3616ea909b76Swdenk		(Power On Self Tests). This definition overrides
3617ea909b76Swdenk		#define'd default value in commproc.h resp.
3618ea909b76Swdenk		cpm_8260.h.
3619ea909b76Swdenk
36206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
36216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
36226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
36236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
36246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
36256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
36266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
36276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
3628a47a12beSStefan Roese		Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
36295d232d0eSwdenk
36309cacf4fcSDirk Eibach- CONFIG_PCI_DISABLE_PCIE:
36319cacf4fcSDirk Eibach		Disable PCI-Express on systems where it is supported but not
36329cacf4fcSDirk Eibach		required.
36339cacf4fcSDirk Eibach
363469fd2d3bSAndrew Sharp- CONFIG_PCI_ENUM_ONLY
363569fd2d3bSAndrew Sharp		Only scan through and get the devices on the busses.
363669fd2d3bSAndrew Sharp		Don't do any setup work, presumably because someone or
363769fd2d3bSAndrew Sharp		something has already done it, and we don't need to do it
363869fd2d3bSAndrew Sharp		a second time.	Useful for platforms that are pre-booted
363969fd2d3bSAndrew Sharp		by coreboot or similar.
364069fd2d3bSAndrew Sharp
3641a09b9b68SKumar Gala- CONFIG_SYS_SRIO:
3642a09b9b68SKumar Gala		Chip has SRIO or not
3643a09b9b68SKumar Gala
3644a09b9b68SKumar Gala- CONFIG_SRIO1:
3645a09b9b68SKumar Gala		Board has SRIO 1 port available
3646a09b9b68SKumar Gala
3647a09b9b68SKumar Gala- CONFIG_SRIO2:
3648a09b9b68SKumar Gala		Board has SRIO 2 port available
3649a09b9b68SKumar Gala
3650a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_VIRT:
3651a09b9b68SKumar Gala		Virtual Address of SRIO port 'n' memory region
3652a09b9b68SKumar Gala
3653a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_PHYS:
3654a09b9b68SKumar Gala		Physical Address of SRIO port 'n' memory region
3655a09b9b68SKumar Gala
3656a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_SIZE:
3657a09b9b68SKumar Gala		Size of SRIO port 'n' memory region
3658a09b9b68SKumar Gala
3659eced4626SAlex Waterman- CONFIG_SYS_NDFC_16
3660eced4626SAlex Waterman		Defined to tell the NDFC that the NAND chip is using a
3661eced4626SAlex Waterman		16 bit bus.
3662eced4626SAlex Waterman
3663eced4626SAlex Waterman- CONFIG_SYS_NDFC_EBC0_CFG
3664eced4626SAlex Waterman		Sets the EBC0_CFG register for the NDFC. If not defined
3665eced4626SAlex Waterman		a default value will be used.
3666eced4626SAlex Waterman
3667bb99ad6dSBen Warren- CONFIG_SPD_EEPROM
3668218ca724SWolfgang Denk		Get DDR timing information from an I2C EEPROM. Common
3669218ca724SWolfgang Denk		with pluggable memory modules such as SODIMMs
3670218ca724SWolfgang Denk
3671bb99ad6dSBen Warren  SPD_EEPROM_ADDRESS
3672bb99ad6dSBen Warren		I2C address of the SPD EEPROM
3673bb99ad6dSBen Warren
36746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM
3675218ca724SWolfgang Denk		If SPD EEPROM is on an I2C bus other than the first
3676218ca724SWolfgang Denk		one, specify here. Note that the value must resolve
3677218ca724SWolfgang Denk		to something your driver can deal with.
3678bb99ad6dSBen Warren
36791b3e3c4fSYork Sun- CONFIG_SYS_DDR_RAW_TIMING
36801b3e3c4fSYork Sun		Get DDR timing information from other than SPD. Common with
36811b3e3c4fSYork Sun		soldered DDR chips onboard without SPD. DDR raw timing
36821b3e3c4fSYork Sun		parameters are extracted from datasheet and hard-coded into
36831b3e3c4fSYork Sun		header files or board specific files.
36841b3e3c4fSYork Sun
36856f5e1dc5SYork Sun- CONFIG_FSL_DDR_INTERACTIVE
36866f5e1dc5SYork Sun		Enable interactive DDR debugging. See doc/README.fsl-ddr.
36876f5e1dc5SYork Sun
36886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0
3689218ca724SWolfgang Denk		Only for 83xx systems. If specified, then DDR should
3690218ca724SWolfgang Denk		be configured using CS0 and CS1 instead of CS2 and CS3.
36912ad6b513STimur Tabi
3692c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12]
3693c26e454dSwdenk		Define to enable FEC[12] on a 8xx series processor.
3694c26e454dSwdenk
3695c26e454dSwdenk- CONFIG_FEC[12]_PHY
3696c26e454dSwdenk		Define to the hardcoded PHY address which corresponds
36976e592385Swdenk		to the given FEC; i. e.
3698c26e454dSwdenk			#define CONFIG_FEC1_PHY 4
3699c26e454dSwdenk		means that the PHY with address 4 is connected to FEC1
3700c26e454dSwdenk
3701c26e454dSwdenk		When set to -1, means to probe for first available.
3702c26e454dSwdenk
3703c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR
3704c26e454dSwdenk		The PHY does not have a RXERR line (RMII only).
3705c26e454dSwdenk		(so program the FEC to ignore it).
3706c26e454dSwdenk
3707c26e454dSwdenk- CONFIG_RMII
3708c26e454dSwdenk		Enable RMII mode for all FECs.
3709c26e454dSwdenk		Note that this is a global option, we can't
3710c26e454dSwdenk		have one FEC in standard MII mode and another in RMII mode.
3711c26e454dSwdenk
37125cf91d6bSwdenk- CONFIG_CRC32_VERIFY
37135cf91d6bSwdenk		Add a verify option to the crc32 command.
37145cf91d6bSwdenk		The syntax is:
37155cf91d6bSwdenk
37165cf91d6bSwdenk		=> crc32 -v <address> <count> <crc32>
37175cf91d6bSwdenk
37185cf91d6bSwdenk		Where address/count indicate a memory area
37195cf91d6bSwdenk		and crc32 is the correct crc32 which the
37205cf91d6bSwdenk		area should have.
37215cf91d6bSwdenk
372256523f12Swdenk- CONFIG_LOOPW
372356523f12Swdenk		Add the "loopw" memory command. This only takes effect if
3724602ad3b3SJon Loeliger		the memory commands are activated globally (CONFIG_CMD_MEM).
372556523f12Swdenk
37267b466641Sstroese- CONFIG_MX_CYCLIC
37277b466641Sstroese		Add the "mdc" and "mwc" memory commands. These are cyclic
37287b466641Sstroese		"md/mw" commands.
37297b466641Sstroese		Examples:
37307b466641Sstroese
37317b466641Sstroese		=> mdc.b 10 4 500
37327b466641Sstroese		This command will print 4 bytes (10,11,12,13) each 500 ms.
37337b466641Sstroese
37347b466641Sstroese		=> mwc.l 100 12345678 10
37357b466641Sstroese		This command will write 12345678 to address 100 all 10 ms.
37367b466641Sstroese
37377b466641Sstroese		This only takes effect if the memory commands are activated
3738602ad3b3SJon Loeliger		globally (CONFIG_CMD_MEM).
37397b466641Sstroese
37408aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT
3741afc1ce82SMacpaul Lin		[ARM, NDS32, MIPS only] If this variable is defined, then certain
3742e03f3169SWolfgang Denk		low level initializations (like setting up the memory
3743e03f3169SWolfgang Denk		controller) are omitted and/or U-Boot does not
3744e03f3169SWolfgang Denk		relocate itself into RAM.
37458aa1a2d1Swdenk
3746e03f3169SWolfgang Denk		Normally this variable MUST NOT be defined. The only
3747e03f3169SWolfgang Denk		exception is when U-Boot is loaded (to RAM) by some
3748e03f3169SWolfgang Denk		other boot loader or by a debugger which performs
3749e03f3169SWolfgang Denk		these initializations itself.
37508aa1a2d1Swdenk
3751401bb30bSAneesh V- CONFIG_SPL_BUILD
3752df81238bSMagnus Lilja		Modifies the behaviour of start.S when compiling a loader
3753df81238bSMagnus Lilja		that is executed before the actual U-Boot. E.g. when
3754df81238bSMagnus Lilja		compiling a NAND SPL.
3755400558b5Swdenk
3756d8834a13SMatthias Weisser- CONFIG_USE_ARCH_MEMCPY
3757d8834a13SMatthias Weisser  CONFIG_USE_ARCH_MEMSET
3758d8834a13SMatthias Weisser		If these options are used a optimized version of memcpy/memset will
3759d8834a13SMatthias Weisser		be used if available. These functions may be faster under some
3760d8834a13SMatthias Weisser		conditions but may increase the binary size.
3761d8834a13SMatthias Weisser
3762b16f521aSGabe Black- CONFIG_X86_NO_RESET_VECTOR
3763b16f521aSGabe Black		If defined, the x86 reset vector code is excluded. You will need
3764b16f521aSGabe Black		to do this when U-Boot is running from Coreboot.
3765b16f521aSGabe Black
37665b5ece9eSGabe Black- CONFIG_X86_NO_REAL_MODE
37675b5ece9eSGabe Black		If defined, x86 real mode code is omitted. This assumes a
37685b5ece9eSGabe Black		32-bit environment where such code is not needed. You will
37695b5ece9eSGabe Black		need to do this when U-Boot is running from Coreboot.
37705b5ece9eSGabe Black
37715b5ece9eSGabe Black
3772f2717b47STimur TabiFreescale QE/FMAN Firmware Support:
3773f2717b47STimur Tabi-----------------------------------
3774f2717b47STimur Tabi
3775f2717b47STimur TabiThe Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
3776f2717b47STimur Tabiloading of "firmware", which is encoded in the QE firmware binary format.
3777f2717b47STimur TabiThis firmware often needs to be loaded during U-Boot booting, so macros
3778f2717b47STimur Tabiare used to identify the storage device (NOR flash, SPI, etc) and the address
3779f2717b47STimur Tabiwithin that device.
3780f2717b47STimur Tabi
3781f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_ADDR
3782f2717b47STimur Tabi	The address in the storage device where the firmware is located.  The
3783f2717b47STimur Tabi	meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
3784f2717b47STimur Tabi	is also specified.
3785f2717b47STimur Tabi
3786f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_LENGTH
3787f2717b47STimur Tabi	The maximum possible size of the firmware.  The firmware binary format
3788f2717b47STimur Tabi	has a field that specifies the actual size of the firmware, but it
3789f2717b47STimur Tabi	might not be possible to read any part of the firmware unless some
3790f2717b47STimur Tabi	local storage is allocated to hold the entire firmware first.
3791f2717b47STimur Tabi
3792f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NOR
3793f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NOR flash, mapped as
3794f2717b47STimur Tabi	normal addressable memory via the LBC.  CONFIG_SYS_FMAN_FW_ADDR is the
3795f2717b47STimur Tabi	virtual address in NOR flash.
3796f2717b47STimur Tabi
3797f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NAND
3798f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NAND flash.
3799f2717b47STimur Tabi	CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
3800f2717b47STimur Tabi
3801f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_MMC
3802f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SD/MMC
3803f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3804f2717b47STimur Tabi
3805f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
3806f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SPI
3807f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3808f2717b47STimur Tabi
3809292dc6c5SLiu Gang- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
3810292dc6c5SLiu Gang	Specifies that QE/FMAN firmware is located in the remote (master)
3811292dc6c5SLiu Gang	memory space.	CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
3812fc54c7faSLiu Gang	can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
3813fc54c7faSLiu Gang	window->master inbound window->master LAW->the ucode address in
3814fc54c7faSLiu Gang	master's memory space.
3815f2717b47STimur Tabi
3816c609719bSwdenkBuilding the Software:
3817c609719bSwdenk======================
3818c609719bSwdenk
3819218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments
3820218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support
3821218ca724SWolfgang Denkall possibly existing versions of cross development tools in all
3822218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we
3823218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
3824218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot.
3825c609719bSwdenk
3826218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you
3827218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case,
3828218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell.
3829218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are
3830218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter:
3831c609719bSwdenk
3832218ca724SWolfgang Denk	$ CROSS_COMPILE=ppc_4xx-
3833218ca724SWolfgang Denk	$ export CROSS_COMPILE
3834c609719bSwdenk
38352f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in
38362f8d396bSPeter Tyser      the tools directory you can use the MinGW toolchain
38372f8d396bSPeter Tyser      (http://www.mingw.org).  Set your HOST tools to the MinGW
38382f8d396bSPeter Tyser      toolchain and execute 'make tools'.  For example:
38392f8d396bSPeter Tyser
38402f8d396bSPeter Tyser       $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
38412f8d396bSPeter Tyser
38422f8d396bSPeter Tyser      Binaries such as tools/mkimage.exe will be created which can
38432f8d396bSPeter Tyser      be executed on computers running Windows.
38442f8d396bSPeter Tyser
3845c609719bSwdenkU-Boot is intended to be simple to build. After installing the
3846c609719bSwdenksources you must configure U-Boot for one specific board type. This
3847c609719bSwdenkis done by typing:
3848c609719bSwdenk
3849c609719bSwdenk	make NAME_config
3850c609719bSwdenk
3851218ca724SWolfgang Denkwhere "NAME_config" is the name of one of the existing configu-
38524d675ae6SMichael Jonesrations; see boards.cfg for supported names.
385354387ac9Swdenk
3854c609719bSwdenkNote: for some board special configuration names may exist; check if
3855c609719bSwdenk      additional information is available from the board vendor; for
38562729af9dSwdenk      instance, the TQM823L systems are available without (standard)
38572729af9dSwdenk      or with LCD support. You can select such additional "features"
385811ccc33fSMarcel Ziswiler      when choosing the configuration, i. e.
3859c609719bSwdenk
38602729af9dSwdenk      make TQM823L_config
38612729af9dSwdenk	- will configure for a plain TQM823L, i. e. no LCD support
3862c609719bSwdenk
3863c609719bSwdenk      make TQM823L_LCD_config
3864c609719bSwdenk	- will configure for a TQM823L with U-Boot console on LCD
3865c609719bSwdenk
3866c609719bSwdenk      etc.
3867c609719bSwdenk
3868c609719bSwdenk
3869c609719bSwdenkFinally, type "make all", and you should get some working U-Boot
38707152b1d0Swdenkimages ready for download to / installation on your system:
3871c609719bSwdenk
3872c609719bSwdenk- "u-boot.bin" is a raw binary image
3873c609719bSwdenk- "u-boot" is an image in ELF binary format
3874c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format
3875c609719bSwdenk
3876baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved
3877baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change
3878baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory:
3879baf31249SMarian Balakowicz
3880baf31249SMarian Balakowicz1. Add O= to the make command line invocations:
3881baf31249SMarian Balakowicz
3882baf31249SMarian Balakowicz	make O=/tmp/build distclean
3883baf31249SMarian Balakowicz	make O=/tmp/build NAME_config
3884baf31249SMarian Balakowicz	make O=/tmp/build all
3885baf31249SMarian Balakowicz
3886baf31249SMarian Balakowicz2. Set environment variable BUILD_DIR to point to the desired location:
3887baf31249SMarian Balakowicz
3888baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
3889baf31249SMarian Balakowicz	make distclean
3890baf31249SMarian Balakowicz	make NAME_config
3891baf31249SMarian Balakowicz	make all
3892baf31249SMarian Balakowicz
3893baf31249SMarian BalakowiczNote that the command line "O=" setting overrides the BUILD_DIR environment
3894baf31249SMarian Balakowiczvariable.
3895baf31249SMarian Balakowicz
3896c609719bSwdenk
3897c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so
3898c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of
3899c609719bSwdenknative "make".
3900c609719bSwdenk
3901c609719bSwdenk
3902c609719bSwdenkIf the system board that you have is not listed, then you will need
3903c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these
3904c609719bSwdenksteps:
3905c609719bSwdenk
3906c609719bSwdenk1.  Add a new configuration option for your board to the toplevel
39074d675ae6SMichael Jones    "boards.cfg" file, using the existing entries as examples.
39084d675ae6SMichael Jones    Follow the instructions there to keep the boards in order.
3909c609719bSwdenk2.  Create a new directory to hold your board specific code. Add any
391085ec0bccSwdenk    files you need. In your board directory, you will need at least
391185ec0bccSwdenk    the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
391285ec0bccSwdenk3.  Create a new configuration file "include/configs/<board>.h" for
391385ec0bccSwdenk    your board
3914c609719bSwdenk3.  If you're porting U-Boot to a new CPU, then also create a new
3915c609719bSwdenk    directory to hold your CPU specific code. Add any files you need.
391685ec0bccSwdenk4.  Run "make <board>_config" with your new name.
3917c609719bSwdenk5.  Type "make", and you should get a working "u-boot.srec" file
3918c609719bSwdenk    to be installed on your target system.
391985ec0bccSwdenk6.  Debug and solve any problems that might arise.
3920c609719bSwdenk    [Of course, this last step is much harder than it sounds.]
3921c609719bSwdenk
3922c609719bSwdenk
3923c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.:
3924c609719bSwdenk==============================================================
3925c609719bSwdenk
3926c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board
3927c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to
3928c609719bSwdenkprovide feedback to the other developers. The feedback normally takes
3929c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest
3930218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources.
3931c609719bSwdenk
3932c609719bSwdenkBut before you submit such a patch, please verify that your modifi-
3933c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of
3934c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so,
3935c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot
3936c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You can
39377152b1d0Swdenkselect which (cross) compiler to use by passing a `CROSS_COMPILE'
3938218ca724SWolfgang Denkenvironment variable to the script, i. e. to use the ELDK cross tools
3939218ca724SWolfgang Denkyou can type
3940c609719bSwdenk
3941c609719bSwdenk	CROSS_COMPILE=ppc_8xx- MAKEALL
3942c609719bSwdenk
3943c609719bSwdenkor to build on a native PowerPC system you can type
3944c609719bSwdenk
3945c609719bSwdenk	CROSS_COMPILE=' ' MAKEALL
3946c609719bSwdenk
3947218ca724SWolfgang DenkWhen using the MAKEALL script, the default behaviour is to build
3948218ca724SWolfgang DenkU-Boot in the source directory. This location can be changed by
3949218ca724SWolfgang Denksetting the BUILD_DIR environment variable. Also, for each target
3950218ca724SWolfgang Denkbuilt, the MAKEALL script saves two log files (<target>.ERR and
3951218ca724SWolfgang Denk<target>.MAKEALL) in the <source dir>/LOG directory. This default
3952218ca724SWolfgang Denklocation can be changed by setting the MAKEALL_LOGDIR environment
3953218ca724SWolfgang Denkvariable. For example:
3954baf31249SMarian Balakowicz
3955baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
3956baf31249SMarian Balakowicz	export MAKEALL_LOGDIR=/tmp/log
3957baf31249SMarian Balakowicz	CROSS_COMPILE=ppc_8xx- MAKEALL
3958baf31249SMarian Balakowicz
3959218ca724SWolfgang DenkWith the above settings build objects are saved in the /tmp/build,
3960218ca724SWolfgang Denklog files are saved in the /tmp/log and the source tree remains clean
3961218ca724SWolfgang Denkduring the whole build process.
3962baf31249SMarian Balakowicz
3963baf31249SMarian Balakowicz
3964c609719bSwdenkSee also "U-Boot Porting Guide" below.
3965c609719bSwdenk
3966c609719bSwdenk
3967c609719bSwdenkMonitor Commands - Overview:
3968c609719bSwdenk============================
3969c609719bSwdenk
3970c609719bSwdenkgo	- start application at address 'addr'
3971c609719bSwdenkrun	- run commands in an environment variable
3972c609719bSwdenkbootm	- boot application image from memory
3973c609719bSwdenkbootp	- boot image via network using BootP/TFTP protocol
397444f074c7SMarek Vasutbootz   - boot zImage from memory
3975c609719bSwdenktftpboot- boot image via network using TFTP protocol
3976c609719bSwdenk	       and env variables "ipaddr" and "serverip"
3977c609719bSwdenk	       (and eventually "gatewayip")
39781fb7cd49SSimon Glasstftpput - upload a file via network using TFTP protocol
3979c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol
3980c609719bSwdenkdiskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
3981c609719bSwdenkloads	- load S-Record file over serial line
3982c609719bSwdenkloadb	- load binary file over serial line (kermit mode)
3983c609719bSwdenkmd	- memory display
3984c609719bSwdenkmm	- memory modify (auto-incrementing)
3985c609719bSwdenknm	- memory modify (constant address)
3986c609719bSwdenkmw	- memory write (fill)
3987c609719bSwdenkcp	- memory copy
3988c609719bSwdenkcmp	- memory compare
3989c609719bSwdenkcrc32	- checksum calculation
39900f89c54bSPeter Tyseri2c	- I2C sub-system
3991c609719bSwdenksspi	- SPI utility commands
3992c609719bSwdenkbase	- print or set address offset
3993c609719bSwdenkprintenv- print environment variables
3994c609719bSwdenksetenv	- set environment variables
3995c609719bSwdenksaveenv - save environment variables to persistent storage
3996c609719bSwdenkprotect - enable or disable FLASH write protection
3997c609719bSwdenkerase	- erase FLASH memory
3998c609719bSwdenkflinfo	- print FLASH memory information
399910635afaSKarl O. Pincnand	- NAND memory operations (see doc/README.nand)
4000c609719bSwdenkbdinfo	- print Board Info structure
4001c609719bSwdenkiminfo	- print header information for application image
4002c609719bSwdenkconinfo - print console devices and informations
4003c609719bSwdenkide	- IDE sub-system
4004c609719bSwdenkloop	- infinite loop on address range
400556523f12Swdenkloopw	- infinite write loop on address range
4006c609719bSwdenkmtest	- simple RAM test
4007c609719bSwdenkicache	- enable or disable instruction cache
4008c609719bSwdenkdcache	- enable or disable data cache
4009c609719bSwdenkreset	- Perform RESET of the CPU
4010c609719bSwdenkecho	- echo args to console
4011c609719bSwdenkversion - print monitor version
4012c609719bSwdenkhelp	- print online help
4013c609719bSwdenk?	- alias for 'help'
4014c609719bSwdenk
4015c609719bSwdenk
4016c609719bSwdenkMonitor Commands - Detailed Description:
4017c609719bSwdenk========================================
4018c609719bSwdenk
4019c609719bSwdenkTODO.
4020c609719bSwdenk
4021c609719bSwdenkFor now: just type "help <command>".
4022c609719bSwdenk
4023c609719bSwdenk
4024c609719bSwdenkEnvironment Variables:
4025c609719bSwdenk======================
4026c609719bSwdenk
4027c609719bSwdenkU-Boot supports user configuration using Environment Variables which
4028c609719bSwdenkcan be made persistent by saving to Flash memory.
4029c609719bSwdenk
4030c609719bSwdenkEnvironment Variables are set using "setenv", printed using
4031c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv"
4032c609719bSwdenkwithout a value can be used to delete a variable from the
4033c609719bSwdenkenvironment. As long as you don't save the environment you are
4034c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the
4035c609719bSwdenkenvironment is erased by accident, a default environment is provided.
4036c609719bSwdenk
4037c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables.
4038c96f86eeSWolfgang Denk
4039c96f86eeSWolfgang DenkList of environment variables (most likely not complete):
4040c609719bSwdenk
4041c609719bSwdenk  baudrate	- see CONFIG_BAUDRATE
4042c609719bSwdenk
4043c609719bSwdenk  bootdelay	- see CONFIG_BOOTDELAY
4044c609719bSwdenk
4045c609719bSwdenk  bootcmd	- see CONFIG_BOOTCOMMAND
4046c609719bSwdenk
4047c609719bSwdenk  bootargs	- Boot arguments when booting an RTOS image
4048c609719bSwdenk
4049c609719bSwdenk  bootfile	- Name of the image to load with TFTP
4050c609719bSwdenk
40517d721e34SBartlomiej Sieka  bootm_low	- Memory range available for image processing in the bootm
40527d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
40537d721e34SBartlomiej Sieka		  a hexadecimal number and defines lowest address allowed
40547d721e34SBartlomiej Sieka		  for use by the bootm command. See also "bootm_size"
40557d721e34SBartlomiej Sieka		  environment variable. Address defined by "bootm_low" is
40567d721e34SBartlomiej Sieka		  also the base of the initial memory mapping for the Linux
4057c3624e6eSGrant Likely		  kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4058c3624e6eSGrant Likely		  bootm_mapsize.
4059c3624e6eSGrant Likely
4060c3624e6eSGrant Likely  bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
4061c3624e6eSGrant Likely		  This variable is given as a hexadecimal number and it
4062c3624e6eSGrant Likely		  defines the size of the memory region starting at base
4063c3624e6eSGrant Likely		  address bootm_low that is accessible by the Linux kernel
4064c3624e6eSGrant Likely		  during early boot.  If unset, CONFIG_SYS_BOOTMAPSZ is used
4065c3624e6eSGrant Likely		  as the default value if it is defined, and bootm_size is
4066c3624e6eSGrant Likely		  used otherwise.
40677d721e34SBartlomiej Sieka
40687d721e34SBartlomiej Sieka  bootm_size	- Memory range available for image processing in the bootm
40697d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
40707d721e34SBartlomiej Sieka		  a hexadecimal number and defines the size of the region
40717d721e34SBartlomiej Sieka		  allowed for use by the bootm command. See also "bootm_low"
40727d721e34SBartlomiej Sieka		  environment variable.
40737d721e34SBartlomiej Sieka
40744bae9090SBartlomiej Sieka  updatefile	- Location of the software update file on a TFTP server, used
40754bae9090SBartlomiej Sieka		  by the automatic software update feature. Please refer to
40764bae9090SBartlomiej Sieka		  documentation in doc/README.update for more details.
40774bae9090SBartlomiej Sieka
4078c609719bSwdenk  autoload	- if set to "no" (any string beginning with 'n'),
4079c609719bSwdenk		  "bootp" will just load perform a lookup of the
4080c609719bSwdenk		  configuration from the BOOTP server, but not try to
4081c609719bSwdenk		  load any image using TFTP
4082c609719bSwdenk
4083c609719bSwdenk  autostart	- if set to "yes", an image loaded using the "bootp",
4084c609719bSwdenk		  "rarpboot", "tftpboot" or "diskboot" commands will
4085c609719bSwdenk		  be automatically started (by internally calling
4086c609719bSwdenk		  "bootm")
4087c609719bSwdenk
40884a6fd34bSwdenk		  If set to "no", a standalone image passed to the
40894a6fd34bSwdenk		  "bootm" command will be copied to the load address
40904a6fd34bSwdenk		  (and eventually uncompressed), but NOT be started.
40914a6fd34bSwdenk		  This can be used to load and uncompress arbitrary
40924a6fd34bSwdenk		  data.
40934a6fd34bSwdenk
4094a28afca5SDavid A. Long  fdt_high	- if set this restricts the maximum address that the
4095a28afca5SDavid A. Long		  flattened device tree will be copied into upon boot.
4096fa34f6b2SShawn Guo		  For example, if you have a system with 1 GB memory
4097fa34f6b2SShawn Guo		  at physical address 0x10000000, while Linux kernel
4098fa34f6b2SShawn Guo		  only recognizes the first 704 MB as low memory, you
4099fa34f6b2SShawn Guo		  may need to set fdt_high as 0x3C000000 to have the
4100fa34f6b2SShawn Guo		  device tree blob be copied to the maximum address
4101fa34f6b2SShawn Guo		  of the 704 MB low memory, so that Linux kernel can
4102fa34f6b2SShawn Guo		  access it during the boot procedure.
4103fa34f6b2SShawn Guo
4104a28afca5SDavid A. Long		  If this is set to the special value 0xFFFFFFFF then
4105a28afca5SDavid A. Long		  the fdt will not be copied at all on boot.  For this
4106a28afca5SDavid A. Long		  to work it must reside in writable memory, have
4107a28afca5SDavid A. Long		  sufficient padding on the end of it for u-boot to
4108a28afca5SDavid A. Long		  add the information it needs into it, and the memory
4109a28afca5SDavid A. Long		  must be accessible by the kernel.
4110a28afca5SDavid A. Long
4111eea63e05SSimon Glass  fdtcontroladdr- if set this is the address of the control flattened
4112eea63e05SSimon Glass		  device tree used by U-Boot when CONFIG_OF_CONTROL is
4113eea63e05SSimon Glass		  defined.
4114eea63e05SSimon Glass
411517ea1177Swdenk  i2cfast	- (PPC405GP|PPC405EP only)
411617ea1177Swdenk		  if set to 'y' configures Linux I2C driver for fast
411717ea1177Swdenk		  mode (400kHZ). This environment variable is used in
411817ea1177Swdenk		  initialization code. So, for changes to be effective
411917ea1177Swdenk		  it must be saved and board must be reset.
412017ea1177Swdenk
4121c609719bSwdenk  initrd_high	- restrict positioning of initrd images:
4122c609719bSwdenk		  If this variable is not set, initrd images will be
4123c609719bSwdenk		  copied to the highest possible address in RAM; this
4124c609719bSwdenk		  is usually what you want since it allows for
4125c609719bSwdenk		  maximum initrd size. If for some reason you want to
4126c609719bSwdenk		  make sure that the initrd image is loaded below the
41276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		  CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
4128c609719bSwdenk		  variable to a value of "no" or "off" or "0".
4129c609719bSwdenk		  Alternatively, you can set it to a maximum upper
4130c609719bSwdenk		  address to use (U-Boot will still check that it
4131c609719bSwdenk		  does not overwrite the U-Boot stack and data).
4132c609719bSwdenk
4133c609719bSwdenk		  For instance, when you have a system with 16 MB
41347152b1d0Swdenk		  RAM, and want to reserve 4 MB from use by Linux,
4135c609719bSwdenk		  you can do this by adding "mem=12M" to the value of
4136c609719bSwdenk		  the "bootargs" variable. However, now you must make
41377152b1d0Swdenk		  sure that the initrd image is placed in the first
4138c609719bSwdenk		  12 MB as well - this can be done with
4139c609719bSwdenk
4140c609719bSwdenk		  setenv initrd_high 00c00000
4141c609719bSwdenk
414238b99261Swdenk		  If you set initrd_high to 0xFFFFFFFF, this is an
414338b99261Swdenk		  indication to U-Boot that all addresses are legal
414438b99261Swdenk		  for the Linux kernel, including addresses in flash
414538b99261Swdenk		  memory. In this case U-Boot will NOT COPY the
414638b99261Swdenk		  ramdisk at all. This may be useful to reduce the
414738b99261Swdenk		  boot time on your system, but requires that this
414838b99261Swdenk		  feature is supported by your Linux kernel.
414938b99261Swdenk
4150c609719bSwdenk  ipaddr	- IP address; needed for tftpboot command
4151c609719bSwdenk
4152c609719bSwdenk  loadaddr	- Default load address for commands like "bootp",
4153dc7c9a1aSwdenk		  "rarpboot", "tftpboot", "loadb" or "diskboot"
4154c609719bSwdenk
4155c609719bSwdenk  loads_echo	- see CONFIG_LOADS_ECHO
4156c609719bSwdenk
4157c609719bSwdenk  serverip	- TFTP server IP address; needed for tftpboot command
4158c609719bSwdenk
4159c609719bSwdenk  bootretry	- see CONFIG_BOOT_RETRY_TIME
4160c609719bSwdenk
4161c609719bSwdenk  bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
4162c609719bSwdenk
4163c609719bSwdenk  bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
4164c609719bSwdenk
4165e2a53458SMike Frysinger  ethprime	- controls which interface is used first.
4166a3d991bdSwdenk
4167e2a53458SMike Frysinger  ethact	- controls which interface is currently active.
4168e2a53458SMike Frysinger		  For example you can do the following
4169a3d991bdSwdenk
417048690d80SHeiko Schocher		  => setenv ethact FEC
417148690d80SHeiko Schocher		  => ping 192.168.0.1 # traffic sent on FEC
417248690d80SHeiko Schocher		  => setenv ethact SCC
417348690d80SHeiko Schocher		  => ping 10.0.0.1 # traffic sent on SCC
4174a3d991bdSwdenk
4175e1692577SMatthias Fuchs  ethrotate	- When set to "no" U-Boot does not go through all
4176e1692577SMatthias Fuchs		  available network interfaces.
4177e1692577SMatthias Fuchs		  It just stays at the currently selected interface.
4178e1692577SMatthias Fuchs
4179a3d991bdSwdenk  netretry	- When set to "no" each network operation will
4180a3d991bdSwdenk		  either succeed or fail without retrying.
41816e592385Swdenk		  When set to "once" the network operation will
41826e592385Swdenk		  fail when all the available network interfaces
41836e592385Swdenk		  are tried once without success.
4184a3d991bdSwdenk		  Useful on scripts which control the retry operation
4185a3d991bdSwdenk		  themselves.
4186a3d991bdSwdenk
4187b4e2f89dSJean-Christophe PLAGNIOL-VILLARD  npe_ucode	- set load address for the NPE microcode
4188a1cf027aSJean-Christophe PLAGNIOL-VILLARD
418928cb9375SWolfgang Denk  tftpsrcport	- If this is set, the value is used for TFTP's
4190ecb0ccd9SWolfgang Denk		  UDP source port.
4191ecb0ccd9SWolfgang Denk
419228cb9375SWolfgang Denk  tftpdstport	- If this is set, the value is used for TFTP's UDP
419328cb9375SWolfgang Denk		  destination port instead of the Well Know Port 69.
419428cb9375SWolfgang Denk
4195c96f86eeSWolfgang Denk  tftpblocksize - Block size to use for TFTP transfers; if not set,
4196c96f86eeSWolfgang Denk		  we use the TFTP server's default block size
4197c96f86eeSWolfgang Denk
4198c96f86eeSWolfgang Denk  tftptimeout	- Retransmission timeout for TFTP packets (in milli-
4199c96f86eeSWolfgang Denk		  seconds, minimum value is 1000 = 1 second). Defines
4200c96f86eeSWolfgang Denk		  when a packet is considered to be lost so it has to
4201c96f86eeSWolfgang Denk		  be retransmitted. The default is 5000 = 5 seconds.
4202c96f86eeSWolfgang Denk		  Lowering this value may make downloads succeed
4203c96f86eeSWolfgang Denk		  faster in networks with high packet loss rates or
4204c96f86eeSWolfgang Denk		  with unreliable TFTP servers.
4205c96f86eeSWolfgang Denk
4206a3d991bdSwdenk  vlan		- When set to a value < 4095 the traffic over
420711ccc33fSMarcel Ziswiler		  Ethernet is encapsulated/received over 802.1q
4208a3d991bdSwdenk		  VLAN tagged frames.
4209c609719bSwdenk
4210dc0b7b0eSJason HobbsThe following image location variables contain the location of images
4211dc0b7b0eSJason Hobbsused in booting. The "Image" column gives the role of the image and is
4212dc0b7b0eSJason Hobbsnot an environment variable name. The other columns are environment
4213dc0b7b0eSJason Hobbsvariable names. "File Name" gives the name of the file on a TFTP
4214dc0b7b0eSJason Hobbsserver, "RAM Address" gives the location in RAM the image will be
4215dc0b7b0eSJason Hobbsloaded to, and "Flash Location" gives the image's address in NOR
4216dc0b7b0eSJason Hobbsflash or offset in NAND flash.
4217dc0b7b0eSJason Hobbs
4218dc0b7b0eSJason Hobbs*Note* - these variables don't have to be defined for all boards, some
4219dc0b7b0eSJason Hobbsboards currenlty use other variables for these purposes, and some
4220dc0b7b0eSJason Hobbsboards use these variables for other purposes.
4221dc0b7b0eSJason Hobbs
4222dc0b7b0eSJason HobbsImage		    File Name	     RAM Address       Flash Location
4223dc0b7b0eSJason Hobbs-----		    ---------	     -----------       --------------
4224dc0b7b0eSJason Hobbsu-boot		    u-boot	     u-boot_addr_r     u-boot_addr
4225dc0b7b0eSJason HobbsLinux kernel	    bootfile	     kernel_addr_r     kernel_addr
4226dc0b7b0eSJason Hobbsdevice tree blob    fdtfile	     fdt_addr_r	       fdt_addr
4227dc0b7b0eSJason Hobbsramdisk		    ramdiskfile	     ramdisk_addr_r    ramdisk_addr
4228dc0b7b0eSJason Hobbs
4229c609719bSwdenkThe following environment variables may be used and automatically
4230c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"),
4231c609719bSwdenkdepending the information provided by your boot server:
4232c609719bSwdenk
4233c609719bSwdenk  bootfile	- see above
4234c609719bSwdenk  dnsip		- IP address of your Domain Name Server
4235fe389a82Sstroese  dnsip2	- IP address of your secondary Domain Name Server
4236c609719bSwdenk  gatewayip	- IP address of the Gateway (Router) to use
4237c609719bSwdenk  hostname	- Target hostname
4238c609719bSwdenk  ipaddr	- see above
4239c609719bSwdenk  netmask	- Subnet Mask
4240c609719bSwdenk  rootpath	- Pathname of the root filesystem on the NFS server
4241c609719bSwdenk  serverip	- see above
4242c609719bSwdenk
4243c609719bSwdenk
4244c609719bSwdenkThere are two special Environment Variables:
4245c609719bSwdenk
4246c609719bSwdenk  serial#	- contains hardware identification information such
4247c609719bSwdenk		  as type string and/or serial number
4248c609719bSwdenk  ethaddr	- Ethernet address
4249c609719bSwdenk
4250c609719bSwdenkThese variables can be set only once (usually during manufacturing of
4251c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables
4252c609719bSwdenkonce they have been set once.
4253c609719bSwdenk
4254c609719bSwdenk
4255c1551ea8SstroeseFurther special Environment Variables:
4256c1551ea8Sstroese
4257c1551ea8Sstroese  ver		- Contains the U-Boot version string as printed
4258c1551ea8Sstroese		  with the "version" command. This variable is
4259c1551ea8Sstroese		  readonly (see CONFIG_VERSION_VARIABLE).
4260c1551ea8Sstroese
4261c1551ea8Sstroese
4262c609719bSwdenkPlease note that changes to some configuration parameters may take
4263c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-).
4264c609719bSwdenk
4265c609719bSwdenk
4266170ab110SJoe HershbergerCallback functions for environment variables:
4267170ab110SJoe Hershberger---------------------------------------------
4268170ab110SJoe Hershberger
4269170ab110SJoe HershbergerFor some environment variables, the behavior of u-boot needs to change
4270170ab110SJoe Hershbergerwhen their values are changed.  This functionailty allows functions to
4271170ab110SJoe Hershbergerbe associated with arbitrary variables.  On creation, overwrite, or
4272170ab110SJoe Hershbergerdeletion, the callback will provide the opportunity for some side
4273170ab110SJoe Hershbergereffect to happen or for the change to be rejected.
4274170ab110SJoe Hershberger
4275170ab110SJoe HershbergerThe callbacks are named and associated with a function using the
4276170ab110SJoe HershbergerU_BOOT_ENV_CALLBACK macro in your board or driver code.
4277170ab110SJoe Hershberger
4278170ab110SJoe HershbergerThese callbacks are associated with variables in one of two ways.  The
4279170ab110SJoe Hershbergerstatic list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
4280170ab110SJoe Hershbergerin the board configuration to a string that defines a list of
4281170ab110SJoe Hershbergerassociations.  The list must be in the following format:
4282170ab110SJoe Hershberger
4283170ab110SJoe Hershberger	entry = variable_name[:callback_name]
4284170ab110SJoe Hershberger	list = entry[,list]
4285170ab110SJoe Hershberger
4286170ab110SJoe HershbergerIf the callback name is not specified, then the callback is deleted.
4287170ab110SJoe HershbergerSpaces are also allowed anywhere in the list.
4288170ab110SJoe Hershberger
4289170ab110SJoe HershbergerCallbacks can also be associated by defining the ".callbacks" variable
4290170ab110SJoe Hershbergerwith the same list format above.  Any association in ".callbacks" will
4291170ab110SJoe Hershbergeroverride any association in the static list. You can define
4292170ab110SJoe HershbergerCONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
4293170ab110SJoe Hershberger".callbacks" envirnoment variable in the default or embedded environment.
4294170ab110SJoe Hershberger
4295170ab110SJoe Hershberger
4296f07771ccSwdenkCommand Line Parsing:
4297f07771ccSwdenk=====================
4298f07771ccSwdenk
4299f07771ccSwdenkThere are two different command line parsers available with U-Boot:
43007152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell:
4301f07771ccSwdenk
4302f07771ccSwdenkOld, simple command line parser:
4303f07771ccSwdenk--------------------------------
4304f07771ccSwdenk
4305f07771ccSwdenk- supports environment variables (through setenv / saveenv commands)
4306f07771ccSwdenk- several commands on one line, separated by ';'
4307fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax
4308f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\',
4309f07771ccSwdenk  for example:
4310fe126d8bSWolfgang Denk	setenv bootcmd bootm \${address}
4311f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example:
4312f07771ccSwdenk	setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
4313f07771ccSwdenk
4314f07771ccSwdenkHush shell:
4315f07771ccSwdenk-----------
4316f07771ccSwdenk
4317f07771ccSwdenk- similar to Bourne shell, with control structures like
4318f07771ccSwdenk  if...then...else...fi, for...do...done; while...do...done,
4319f07771ccSwdenk  until...do...done, ...
4320f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv
4321f07771ccSwdenk  commands) and local shell variables (through standard shell syntax
4322f07771ccSwdenk  "name=value"); only environment variables can be used with "run"
4323f07771ccSwdenk  command
4324f07771ccSwdenk
4325f07771ccSwdenkGeneral rules:
4326f07771ccSwdenk--------------
4327f07771ccSwdenk
4328f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run"
4329f07771ccSwdenk    command) contains several commands separated by semicolon, and
4330f07771ccSwdenk    one of these commands fails, then the remaining commands will be
4331f07771ccSwdenk    executed anyway.
4332f07771ccSwdenk
4333f07771ccSwdenk(2) If you execute several variables with one call to run (i. e.
433411ccc33fSMarcel Ziswiler    calling run with a list of variables as arguments), any failing
4335f07771ccSwdenk    command will cause "run" to terminate, i. e. the remaining
4336f07771ccSwdenk    variables are not executed.
4337f07771ccSwdenk
4338c609719bSwdenkNote for Redundant Ethernet Interfaces:
4339c609719bSwdenk=======================================
4340c609719bSwdenk
434111ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports
4342c609719bSwdenksuch configurations and is capable of automatic selection of a
43437152b1d0Swdenk"working" interface when needed. MAC assignment works as follows:
4344c609719bSwdenk
4345c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding
4346c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0),
4347c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ...
4348c609719bSwdenk
4349c609719bSwdenkIf the network interface stores some valid MAC address (for instance
4350c609719bSwdenkin SROM), this is used as default address if there is NO correspon-
4351c609719bSwdenkding setting in the environment; if the corresponding environment
4352c609719bSwdenkvariable is set, this overrides the settings in the card; that means:
4353c609719bSwdenk
4354c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the
4355c609719bSwdenk  environment, the SROM's address is used.
4356c609719bSwdenk
4357c609719bSwdenko If there is no valid address in the SROM, and a definition in the
4358c609719bSwdenk  environment exists, then the value from the environment variable is
4359c609719bSwdenk  used.
4360c609719bSwdenk
4361c609719bSwdenko If both the SROM and the environment contain a MAC address, and
4362c609719bSwdenk  both addresses are the same, this MAC address is used.
4363c609719bSwdenk
4364c609719bSwdenko If both the SROM and the environment contain a MAC address, and the
4365c609719bSwdenk  addresses differ, the value from the environment is used and a
4366c609719bSwdenk  warning is printed.
4367c609719bSwdenk
4368c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error
4369c609719bSwdenk  is raised.
4370c609719bSwdenk
4371ecee9324SBen WarrenIf Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
4372ecee9324SBen Warrenwill be programmed into hardware as part of the initialization process.	 This
4373ecee9324SBen Warrenmay be skipped by setting the appropriate 'ethmacskip' environment variable.
4374ecee9324SBen WarrenThe naming convention is as follows:
4375ecee9324SBen Warren"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
4376c609719bSwdenk
4377c609719bSwdenkImage Formats:
4378c609719bSwdenk==============
4379c609719bSwdenk
43803310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on)
43813310c549SMarian Balakowiczimages in two formats:
43823310c549SMarian Balakowicz
43833310c549SMarian BalakowiczNew uImage format (FIT)
43843310c549SMarian Balakowicz-----------------------
43853310c549SMarian Balakowicz
43863310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar
43873310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple
43883310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by
43893310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
43903310c549SMarian Balakowicz
43913310c549SMarian Balakowicz
43923310c549SMarian BalakowiczOld uImage format
43933310c549SMarian Balakowicz-----------------
43943310c549SMarian Balakowicz
43953310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything,
43963310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for
43973310c549SMarian Balakowiczdetails; basically, the header defines the following image properties:
4398c609719bSwdenk
4399c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
4400c609719bSwdenk  4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
4401f5ed9e39SPeter Tyser  LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
4402f5ed9e39SPeter Tyser  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
4403f5ed9e39SPeter Tyser  INTEGRITY).
44047b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
4405afc1ce82SMacpaul Lin  IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
4406afc1ce82SMacpaul Lin  Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
4407c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2)
4408c609719bSwdenk* Load Address
4409c609719bSwdenk* Entry Point
4410c609719bSwdenk* Image Name
4411c609719bSwdenk* Image Timestamp
4412c609719bSwdenk
4413c609719bSwdenkThe header is marked by a special Magic Number, and both the header
4414c609719bSwdenkand the data portions of the image are secured against corruption by
4415c609719bSwdenkCRC32 checksums.
4416c609719bSwdenk
4417c609719bSwdenk
4418c609719bSwdenkLinux Support:
4419c609719bSwdenk==============
4420c609719bSwdenk
4421c609719bSwdenkAlthough U-Boot should support any OS or standalone application
44227152b1d0Swdenkeasily, the main focus has always been on Linux during the design of
4423c609719bSwdenkU-Boot.
4424c609719bSwdenk
4425c609719bSwdenkU-Boot includes many features that so far have been part of some
4426c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any
4427c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image;
4428c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation
44297152b1d0Swdenkserves several purposes:
4430c609719bSwdenk
4431c609719bSwdenk- the same features can be used for other OS or standalone
4432c609719bSwdenk  applications (for instance: using compressed images to reduce the
4433c609719bSwdenk  Flash memory footprint)
4434c609719bSwdenk
4435c609719bSwdenk- it becomes much easier to port new Linux kernel versions because
44367152b1d0Swdenk  lots of low-level, hardware dependent stuff are done by U-Boot
4437c609719bSwdenk
4438c609719bSwdenk- the same Linux kernel image can now be used with different "initrd"
4439c609719bSwdenk  images; of course this also means that different kernel images can
4440c609719bSwdenk  be run with the same "initrd". This makes testing easier (you don't
4441c609719bSwdenk  have to build a new "zImage.initrd" Linux image when you just
4442c609719bSwdenk  change a file in your "initrd"). Also, a field-upgrade of the
4443c609719bSwdenk  software is easier now.
4444c609719bSwdenk
4445c609719bSwdenk
4446c609719bSwdenkLinux HOWTO:
4447c609719bSwdenk============
4448c609719bSwdenk
4449c609719bSwdenkPorting Linux to U-Boot based systems:
4450c609719bSwdenk---------------------------------------
4451c609719bSwdenk
4452c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to
4453c609719bSwdenkconfigure the Linux device drivers for use with your target hardware
4454c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to
4455c609719bSwdenkLinux :-).
4456c609719bSwdenk
4457a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
4458c609719bSwdenk
4459c609719bSwdenkJust make sure your machine specific header file (for instance
4460c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board
44611dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h,
44621dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value
44636d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR.
4464c609719bSwdenk
4465c609719bSwdenk
4466c609719bSwdenkConfiguring the Linux kernel:
4467c609719bSwdenk-----------------------------
4468c609719bSwdenk
4469c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root
4470c609719bSwdenkdevice (initial ramdisk, NFS) for your target system.
4471c609719bSwdenk
4472c609719bSwdenk
4473c609719bSwdenkBuilding a Linux Image:
4474c609719bSwdenk-----------------------
4475c609719bSwdenk
447624ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are
447724ee89b9Swdenknot used. If you use recent kernel source, a new build target
447824ee89b9Swdenk"uImage" will exist which automatically builds an image usable by
447924ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target,
448024ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a
448124ee89b9Swdenk100% compatible format.
4482c609719bSwdenk
4483c609719bSwdenkExample:
4484c609719bSwdenk
4485c609719bSwdenk	make TQM850L_config
4486c609719bSwdenk	make oldconfig
4487c609719bSwdenk	make dep
448824ee89b9Swdenk	make uImage
4489c609719bSwdenk
449024ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to
449124ee89b9Swdenkencapsulate a compressed Linux kernel image with header	 information,
449224ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing:
4493c609719bSwdenk
449424ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format):
449524ee89b9Swdenk
449624ee89b9Swdenk* convert the kernel into a raw binary image:
449724ee89b9Swdenk
449824ee89b9Swdenk	${CROSS_COMPILE}-objcopy -O binary \
449924ee89b9Swdenk				 -R .note -R .comment \
450024ee89b9Swdenk				 -S vmlinux linux.bin
450124ee89b9Swdenk
450224ee89b9Swdenk* compress the binary image:
450324ee89b9Swdenk
450424ee89b9Swdenk	gzip -9 linux.bin
450524ee89b9Swdenk
450624ee89b9Swdenk* package compressed binary image for U-Boot:
450724ee89b9Swdenk
450824ee89b9Swdenk	mkimage -A ppc -O linux -T kernel -C gzip \
450924ee89b9Swdenk		-a 0 -e 0 -n "Linux Kernel Image" \
451024ee89b9Swdenk		-d linux.bin.gz uImage
451124ee89b9Swdenk
451224ee89b9Swdenk
451324ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use
451424ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or
451524ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64
451624ee89b9Swdenkbyte header containing information about target architecture,
451724ee89b9Swdenkoperating system, image type, compression method, entry points, time
451824ee89b9Swdenkstamp, CRC32 checksums, etc.
451924ee89b9Swdenk
452024ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and
452124ee89b9Swdenkprint the header information, or to build new images.
4522c609719bSwdenk
4523c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information
4524c609719bSwdenkcontained in the header of an existing U-Boot image; this includes
4525c609719bSwdenkchecksum verification:
4526c609719bSwdenk
4527c609719bSwdenk	tools/mkimage -l image
4528c609719bSwdenk	  -l ==> list image header information
4529c609719bSwdenk
4530c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image
4531c609719bSwdenkfrom a "data file" which is used as image payload:
4532c609719bSwdenk
4533c609719bSwdenk	tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
4534c609719bSwdenk		      -n name -d data_file image
4535c609719bSwdenk	  -A ==> set architecture to 'arch'
4536c609719bSwdenk	  -O ==> set operating system to 'os'
4537c609719bSwdenk	  -T ==> set image type to 'type'
4538c609719bSwdenk	  -C ==> set compression type 'comp'
4539c609719bSwdenk	  -a ==> set load address to 'addr' (hex)
4540c609719bSwdenk	  -e ==> set entry point to 'ep' (hex)
4541c609719bSwdenk	  -n ==> set image name to 'name'
4542c609719bSwdenk	  -d ==> use image data from 'datafile'
4543c609719bSwdenk
454469459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load
454569459791Swdenkaddress (0x00000000), but the entry point address depends on the
454669459791Swdenkkernel version:
4547c609719bSwdenk
4548c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C,
454924ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000.
4550c609719bSwdenk
4551c609719bSwdenkSo a typical call to build a U-Boot image would read:
4552c609719bSwdenk
455324ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
455424ee89b9Swdenk	> -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
4555a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
455624ee89b9Swdenk	> examples/uImage.TQM850L
455724ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
4558c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
4559c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
4560c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
4561c609719bSwdenk	Load Address: 0x00000000
456224ee89b9Swdenk	Entry Point:  0x00000000
4563c609719bSwdenk
4564c609719bSwdenkTo verify the contents of the image (or check for corruption):
4565c609719bSwdenk
456624ee89b9Swdenk	-> tools/mkimage -l examples/uImage.TQM850L
456724ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
4568c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
4569c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
4570c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
4571c609719bSwdenk	Load Address: 0x00000000
457224ee89b9Swdenk	Entry Point:  0x00000000
4573c609719bSwdenk
4574c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade
4575c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this
4576c609719bSwdenkneeds more space in Flash, but boots much faster since it does not
4577c609719bSwdenkneed to be uncompressed:
4578c609719bSwdenk
4579a47a12beSStefan Roese	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
458024ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
458124ee89b9Swdenk	> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
4582a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
458324ee89b9Swdenk	> examples/uImage.TQM850L-uncompressed
458424ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
4585c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
4586c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (uncompressed)
4587c609719bSwdenk	Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
4588c609719bSwdenk	Load Address: 0x00000000
458924ee89b9Swdenk	Entry Point:  0x00000000
4590c609719bSwdenk
4591c609719bSwdenk
4592c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file
4593c609719bSwdenkwhen your kernel is intended to use an initial ramdisk:
4594c609719bSwdenk
4595c609719bSwdenk	-> tools/mkimage -n 'Simple Ramdisk Image' \
4596c609719bSwdenk	> -A ppc -O linux -T ramdisk -C gzip \
4597c609719bSwdenk	> -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
4598c609719bSwdenk	Image Name:   Simple Ramdisk Image
4599c609719bSwdenk	Created:      Wed Jan 12 14:01:50 2000
4600c609719bSwdenk	Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
4601c609719bSwdenk	Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
4602c609719bSwdenk	Load Address: 0x00000000
4603c609719bSwdenk	Entry Point:  0x00000000
4604c609719bSwdenk
4605c609719bSwdenk
4606c609719bSwdenkInstalling a Linux Image:
4607c609719bSwdenk-------------------------
4608c609719bSwdenk
4609c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface,
4610c609719bSwdenkyou must convert the image to S-Record format:
4611c609719bSwdenk
4612c609719bSwdenk	objcopy -I binary -O srec examples/image examples/image.srec
4613c609719bSwdenk
4614c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot
4615c609719bSwdenkimage header, so the resulting S-Record file will be relative to
4616c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to
4617c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads'
4618c609719bSwdenkcommand.
4619c609719bSwdenk
4620c609719bSwdenkExample: install the image to address 0x40100000 (which on the
4621c609719bSwdenkTQM8xxL is in the first Flash bank):
4622c609719bSwdenk
4623c609719bSwdenk	=> erase 40100000 401FFFFF
4624c609719bSwdenk
4625c609719bSwdenk	.......... done
4626c609719bSwdenk	Erased 8 sectors
4627c609719bSwdenk
4628c609719bSwdenk	=> loads 40100000
4629c609719bSwdenk	## Ready for S-Record download ...
4630c609719bSwdenk	~>examples/image.srec
4631c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 12 13 ...
4632c609719bSwdenk	...
4633c609719bSwdenk	15989 15990 15991 15992
4634c609719bSwdenk	[file transfer complete]
4635c609719bSwdenk	[connected]
4636c609719bSwdenk	## Start Addr = 0x00000000
4637c609719bSwdenk
4638c609719bSwdenk
4639c609719bSwdenkYou can check the success of the download using the 'iminfo' command;
4640c609719bSwdenkthis includes a checksum verification so you can be sure no data
4641c609719bSwdenkcorruption happened:
4642c609719bSwdenk
4643c609719bSwdenk	=> imi 40100000
4644c609719bSwdenk
4645c609719bSwdenk	## Checking Image at 40100000 ...
4646c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
4647c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
4648c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
4649c609719bSwdenk	   Load Address: 00000000
4650c609719bSwdenk	   Entry Point:	 0000000c
4651c609719bSwdenk	   Verifying Checksum ... OK
4652c609719bSwdenk
4653c609719bSwdenk
4654c609719bSwdenkBoot Linux:
4655c609719bSwdenk-----------
4656c609719bSwdenk
4657c609719bSwdenkThe "bootm" command is used to boot an application that is stored in
4658c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents
4659c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as
4660c609719bSwdenkparameters. You can check and modify this variable using the
4661c609719bSwdenk"printenv" and "setenv" commands:
4662c609719bSwdenk
4663c609719bSwdenk
4664c609719bSwdenk	=> printenv bootargs
4665c609719bSwdenk	bootargs=root=/dev/ram
4666c609719bSwdenk
4667c609719bSwdenk	=> setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4668c609719bSwdenk
4669c609719bSwdenk	=> printenv bootargs
4670c609719bSwdenk	bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4671c609719bSwdenk
4672c609719bSwdenk	=> bootm 40020000
4673c609719bSwdenk	## Booting Linux kernel at 40020000 ...
4674c609719bSwdenk	   Image Name:	 2.2.13 for NFS on TQM850L
4675c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
4676c609719bSwdenk	   Data Size:	 381681 Bytes = 372 kB = 0 MB
4677c609719bSwdenk	   Load Address: 00000000
4678c609719bSwdenk	   Entry Point:	 0000000c
4679c609719bSwdenk	   Verifying Checksum ... OK
4680c609719bSwdenk	   Uncompressing Kernel Image ... OK
4681c609719bSwdenk	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
4682c609719bSwdenk	Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4683c609719bSwdenk	time_init: decrementer frequency = 187500000/60
4684c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
4685c609719bSwdenk	Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
4686c609719bSwdenk	...
4687c609719bSwdenk
468811ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass
46897152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT
4690c609719bSwdenkformat!) to the "bootm" command:
4691c609719bSwdenk
4692c609719bSwdenk	=> imi 40100000 40200000
4693c609719bSwdenk
4694c609719bSwdenk	## Checking Image at 40100000 ...
4695c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
4696c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
4697c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
4698c609719bSwdenk	   Load Address: 00000000
4699c609719bSwdenk	   Entry Point:	 0000000c
4700c609719bSwdenk	   Verifying Checksum ... OK
4701c609719bSwdenk
4702c609719bSwdenk	## Checking Image at 40200000 ...
4703c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
4704c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
4705c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
4706c609719bSwdenk	   Load Address: 00000000
4707c609719bSwdenk	   Entry Point:	 00000000
4708c609719bSwdenk	   Verifying Checksum ... OK
4709c609719bSwdenk
4710c609719bSwdenk	=> bootm 40100000 40200000
4711c609719bSwdenk	## Booting Linux kernel at 40100000 ...
4712c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
4713c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
4714c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
4715c609719bSwdenk	   Load Address: 00000000
4716c609719bSwdenk	   Entry Point:	 0000000c
4717c609719bSwdenk	   Verifying Checksum ... OK
4718c609719bSwdenk	   Uncompressing Kernel Image ... OK
4719c609719bSwdenk	## Loading RAMDisk Image at 40200000 ...
4720c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
4721c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
4722c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
4723c609719bSwdenk	   Load Address: 00000000
4724c609719bSwdenk	   Entry Point:	 00000000
4725c609719bSwdenk	   Verifying Checksum ... OK
4726c609719bSwdenk	   Loading Ramdisk ... OK
4727c609719bSwdenk	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
4728c609719bSwdenk	Boot arguments: root=/dev/ram
4729c609719bSwdenk	time_init: decrementer frequency = 187500000/60
4730c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
4731c609719bSwdenk	...
4732c609719bSwdenk	RAMDISK: Compressed image found at block 0
4733c609719bSwdenk	VFS: Mounted root (ext2 filesystem).
4734c609719bSwdenk
4735c609719bSwdenk	bash#
4736c609719bSwdenk
47370267768eSMatthew McClintockBoot Linux and pass a flat device tree:
47380267768eSMatthew McClintock-----------
47390267768eSMatthew McClintock
47400267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section
47410267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The
47420267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated
47430267768eSMatthew McClintockflat device tree:
47440267768eSMatthew McClintock
47450267768eSMatthew McClintock=> print oftaddr
47460267768eSMatthew McClintockoftaddr=0x300000
47470267768eSMatthew McClintock=> print oft
47480267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb
47490267768eSMatthew McClintock=> tftp $oftaddr $oft
47500267768eSMatthew McClintockSpeed: 1000, full duplex
47510267768eSMatthew McClintockUsing TSEC0 device
47520267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101
47530267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'.
47540267768eSMatthew McClintockLoad address: 0x300000
47550267768eSMatthew McClintockLoading: #
47560267768eSMatthew McClintockdone
47570267768eSMatthew McClintockBytes transferred = 4106 (100a hex)
47580267768eSMatthew McClintock=> tftp $loadaddr $bootfile
47590267768eSMatthew McClintockSpeed: 1000, full duplex
47600267768eSMatthew McClintockUsing TSEC0 device
47610267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2
47620267768eSMatthew McClintockFilename 'uImage'.
47630267768eSMatthew McClintockLoad address: 0x200000
47640267768eSMatthew McClintockLoading:############
47650267768eSMatthew McClintockdone
47660267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex)
47670267768eSMatthew McClintock=> print loadaddr
47680267768eSMatthew McClintockloadaddr=200000
47690267768eSMatthew McClintock=> print oftaddr
47700267768eSMatthew McClintockoftaddr=0x300000
47710267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr
47720267768eSMatthew McClintock## Booting image at 00200000 ...
47730267768eSMatthew McClintock   Image Name:	 Linux-2.6.17-dirty
47740267768eSMatthew McClintock   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
47750267768eSMatthew McClintock   Data Size:	 1029343 Bytes = 1005.2 kB
47760267768eSMatthew McClintock   Load Address: 00000000
47770267768eSMatthew McClintock   Entry Point:	 00000000
47780267768eSMatthew McClintock   Verifying Checksum ... OK
47790267768eSMatthew McClintock   Uncompressing Kernel Image ... OK
47800267768eSMatthew McClintockBooting using flat device tree at 0x300000
47810267768eSMatthew McClintockUsing MPC85xx ADS machine description
47820267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
47830267768eSMatthew McClintock[snip]
47840267768eSMatthew McClintock
47850267768eSMatthew McClintock
47866069ff26SwdenkMore About U-Boot Image Types:
47876069ff26Swdenk------------------------------
47886069ff26Swdenk
47896069ff26SwdenkU-Boot supports the following image types:
47906069ff26Swdenk
47916069ff26Swdenk   "Standalone Programs" are directly runnable in the environment
47926069ff26Swdenk	provided by U-Boot; it is expected that (if they behave
47936069ff26Swdenk	well) you can continue to work in U-Boot after return from
47946069ff26Swdenk	the Standalone Program.
47956069ff26Swdenk   "OS Kernel Images" are usually images of some Embedded OS which
47966069ff26Swdenk	will take over control completely. Usually these programs
47976069ff26Swdenk	will install their own set of exception handlers, device
47986069ff26Swdenk	drivers, set up the MMU, etc. - this means, that you cannot
47996069ff26Swdenk	expect to re-enter U-Boot except by resetting the CPU.
48006069ff26Swdenk   "RAMDisk Images" are more or less just data blocks, and their
48016069ff26Swdenk	parameters (address, size) are passed to an OS kernel that is
48026069ff26Swdenk	being started.
48036069ff26Swdenk   "Multi-File Images" contain several images, typically an OS
48046069ff26Swdenk	(Linux) kernel image and one or more data images like
48056069ff26Swdenk	RAMDisks. This construct is useful for instance when you want
48066069ff26Swdenk	to boot over the network using BOOTP etc., where the boot
48076069ff26Swdenk	server provides just a single image file, but you want to get
48086069ff26Swdenk	for instance an OS kernel and a RAMDisk image.
48096069ff26Swdenk
48106069ff26Swdenk	"Multi-File Images" start with a list of image sizes, each
48116069ff26Swdenk	image size (in bytes) specified by an "uint32_t" in network
48126069ff26Swdenk	byte order. This list is terminated by an "(uint32_t)0".
48136069ff26Swdenk	Immediately after the terminating 0 follow the images, one by
48146069ff26Swdenk	one, all aligned on "uint32_t" boundaries (size rounded up to
48156069ff26Swdenk	a multiple of 4 bytes).
48166069ff26Swdenk
48176069ff26Swdenk   "Firmware Images" are binary images containing firmware (like
48186069ff26Swdenk	U-Boot or FPGA images) which usually will be programmed to
48196069ff26Swdenk	flash memory.
48206069ff26Swdenk
48216069ff26Swdenk   "Script files" are command sequences that will be executed by
48226069ff26Swdenk	U-Boot's command interpreter; this feature is especially
48236069ff26Swdenk	useful when you configure U-Boot to use a real shell (hush)
48246069ff26Swdenk	as command interpreter.
48256069ff26Swdenk
482644f074c7SMarek VasutBooting the Linux zImage:
482744f074c7SMarek Vasut-------------------------
482844f074c7SMarek Vasut
482944f074c7SMarek VasutOn some platforms, it's possible to boot Linux zImage. This is done
483044f074c7SMarek Vasutusing the "bootz" command. The syntax of "bootz" command is the same
483144f074c7SMarek Vasutas the syntax of "bootm" command.
483244f074c7SMarek Vasut
4833017e1f3fSMarek VasutNote, defining the CONFIG_SUPPORT_INITRD_RAW allows user to supply
4834017e1f3fSMarek Vasutkernel with raw initrd images. The syntax is slightly different, the
4835017e1f3fSMarek Vasutaddress of the initrd must be augmented by it's size, in the following
4836017e1f3fSMarek Vasutformat: "<initrd addres>:<initrd size>".
4837017e1f3fSMarek Vasut
4838c609719bSwdenk
4839c609719bSwdenkStandalone HOWTO:
4840c609719bSwdenk=================
4841c609719bSwdenk
4842c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and
4843c609719bSwdenkrun "standalone" applications, which can use some resources of
4844c609719bSwdenkU-Boot like console I/O functions or interrupt services.
4845c609719bSwdenk
4846c609719bSwdenkTwo simple examples are included with the sources:
4847c609719bSwdenk
4848c609719bSwdenk"Hello World" Demo:
4849c609719bSwdenk-------------------
4850c609719bSwdenk
4851c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo
4852c609719bSwdenkapplication; it is automatically compiled when you build U-Boot.
4853c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it
4854c609719bSwdenklike that:
4855c609719bSwdenk
4856c609719bSwdenk	=> loads
4857c609719bSwdenk	## Ready for S-Record download ...
4858c609719bSwdenk	~>examples/hello_world.srec
4859c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
4860c609719bSwdenk	[file transfer complete]
4861c609719bSwdenk	[connected]
4862c609719bSwdenk	## Start Addr = 0x00040004
4863c609719bSwdenk
4864c609719bSwdenk	=> go 40004 Hello World! This is a test.
4865c609719bSwdenk	## Starting application at 0x00040004 ...
4866c609719bSwdenk	Hello World
4867c609719bSwdenk	argc = 7
4868c609719bSwdenk	argv[0] = "40004"
4869c609719bSwdenk	argv[1] = "Hello"
4870c609719bSwdenk	argv[2] = "World!"
4871c609719bSwdenk	argv[3] = "This"
4872c609719bSwdenk	argv[4] = "is"
4873c609719bSwdenk	argv[5] = "a"
4874c609719bSwdenk	argv[6] = "test."
4875c609719bSwdenk	argv[7] = "<NULL>"
4876c609719bSwdenk	Hit any key to exit ...
4877c609719bSwdenk
4878c609719bSwdenk	## Application terminated, rc = 0x0
4879c609719bSwdenk
4880c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt
4881c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'.
4882c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second.
4883c609719bSwdenkThe interrupt service routine is trivial, just printing a '.'
4884c609719bSwdenkcharacter, but this is just a demo program. The application can be
4885c609719bSwdenkcontrolled by the following keys:
4886c609719bSwdenk
4887c609719bSwdenk	? - print current values og the CPM Timer registers
4888c609719bSwdenk	b - enable interrupts and start timer
4889c609719bSwdenk	e - stop timer and disable interrupts
4890c609719bSwdenk	q - quit application
4891c609719bSwdenk
4892c609719bSwdenk	=> loads
4893c609719bSwdenk	## Ready for S-Record download ...
4894c609719bSwdenk	~>examples/timer.srec
4895c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
4896c609719bSwdenk	[file transfer complete]
4897c609719bSwdenk	[connected]
4898c609719bSwdenk	## Start Addr = 0x00040004
4899c609719bSwdenk
4900c609719bSwdenk	=> go 40004
4901c609719bSwdenk	## Starting application at 0x00040004 ...
4902c609719bSwdenk	TIMERS=0xfff00980
4903c609719bSwdenk	Using timer 1
4904c609719bSwdenk	  tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
4905c609719bSwdenk
4906c609719bSwdenkHit 'b':
4907c609719bSwdenk	[q, b, e, ?] Set interval 1000000 us
4908c609719bSwdenk	Enabling timer
4909c609719bSwdenkHit '?':
4910c609719bSwdenk	[q, b, e, ?] ........
4911c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
4912c609719bSwdenkHit '?':
4913c609719bSwdenk	[q, b, e, ?] .
4914c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
4915c609719bSwdenkHit '?':
4916c609719bSwdenk	[q, b, e, ?] .
4917c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
4918c609719bSwdenkHit '?':
4919c609719bSwdenk	[q, b, e, ?] .
4920c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
4921c609719bSwdenkHit 'e':
4922c609719bSwdenk	[q, b, e, ?] ...Stopping timer
4923c609719bSwdenkHit 'q':
4924c609719bSwdenk	[q, b, e, ?] ## Application terminated, rc = 0x0
4925c609719bSwdenk
4926c609719bSwdenk
492785ec0bccSwdenkMinicom warning:
492885ec0bccSwdenk================
492985ec0bccSwdenk
49307152b1d0SwdenkOver time, many people have reported problems when trying to use the
493185ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd)
493285ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under
4933f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and
493485ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and
4935e53515a2SKarl O. Pincuse "cu" for S-Record download ("loads" command).  See
4936e53515a2SKarl O. Pinchttp://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
4937e53515a2SKarl O. Pincfor help with kermit.
4938e53515a2SKarl O. Pinc
493985ec0bccSwdenk
494052f52c14SwdenkNevertheless, if you absolutely want to use it try adding this
494152f52c14Swdenkconfiguration to your "File transfer protocols" section:
494252f52c14Swdenk
494352f52c14Swdenk	   Name	   Program			Name U/D FullScr IO-Red. Multi
494452f52c14Swdenk	X  kermit  /usr/bin/kermit -i -l %l -s	 Y    U	   Y	   N	  N
494552f52c14Swdenk	Y  kermit  /usr/bin/kermit -i -l %l -r	 N    D	   Y	   N	  N
494652f52c14Swdenk
494752f52c14Swdenk
4948c609719bSwdenkNetBSD Notes:
4949c609719bSwdenk=============
4950c609719bSwdenk
4951c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host
4952c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx).
4953c609719bSwdenk
4954c609719bSwdenkBuilding requires a cross environment; it is known to work on
4955c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
4956c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make).
4957c609719bSwdenkNote that the cross-powerpc package does not install include files;
4958c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is
4959c609719bSwdenkmissing.  This file has to be installed and patched manually:
4960c609719bSwdenk
4961c609719bSwdenk	# cd /usr/pkg/cross/powerpc-netbsd/include
4962c609719bSwdenk	# mkdir powerpc
4963c609719bSwdenk	# ln -s powerpc machine
4964c609719bSwdenk	# cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
4965c609719bSwdenk	# ${EDIT} powerpc/ansi.h	## must remove __va_list, _BSD_VA_LIST
4966c609719bSwdenk
4967c609719bSwdenkNative builds *don't* work due to incompatibilities between native
4968c609719bSwdenkand U-Boot include files.
4969c609719bSwdenk
4970c609719bSwdenkBooting assumes that (the first part of) the image booted is a
4971c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel
4972c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source
4973c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
49742a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
4975c609719bSwdenk
4976c609719bSwdenk
4977c609719bSwdenkImplementation Internals:
4978c609719bSwdenk=========================
4979c609719bSwdenk
4980c609719bSwdenkThe following is not intended to be a complete description of every
4981c609719bSwdenkimplementation detail. However, it should help to understand the
4982c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom
4983c609719bSwdenkhardware.
4984c609719bSwdenk
4985c609719bSwdenk
4986c609719bSwdenkInitial Stack, Global Data:
4987c609719bSwdenk---------------------------
4988c609719bSwdenk
4989c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot
4990c609719bSwdenkstarts running out of ROM (flash memory), usually without access to
4991c609719bSwdenksystem RAM (because the memory controller is not initialized yet).
4992c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS
4993c609719bSwdenkis not initialized as zero. To be able to get a C environment working
4994c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation
4995c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU
4996c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and
4997c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be
4998c609719bSwdenklocked as (mis-) used as memory, etc.
4999c609719bSwdenk
50007152b1d0Swdenk	Chris Hallinan posted a good summary of these issues to the
50010668236bSWolfgang Denk	U-Boot mailing list:
500243d9616cSwdenk
500343d9616cSwdenk	Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
500443d9616cSwdenk	From: "Chris Hallinan" <clh@net1plus.com>
500543d9616cSwdenk	Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
500643d9616cSwdenk	...
500743d9616cSwdenk
500843d9616cSwdenk	Correct me if I'm wrong, folks, but the way I understand it
500943d9616cSwdenk	is this: Using DCACHE as initial RAM for Stack, etc, does not
501043d9616cSwdenk	require any physical RAM backing up the cache. The cleverness
501143d9616cSwdenk	is that the cache is being used as a temporary supply of
501243d9616cSwdenk	necessary storage before the SDRAM controller is setup. It's
501311ccc33fSMarcel Ziswiler	beyond the scope of this list to explain the details, but you
501443d9616cSwdenk	can see how this works by studying the cache architecture and
501543d9616cSwdenk	operation in the architecture and processor-specific manuals.
501643d9616cSwdenk
501743d9616cSwdenk	OCM is On Chip Memory, which I believe the 405GP has 4K. It
501843d9616cSwdenk	is another option for the system designer to use as an
501911ccc33fSMarcel Ziswiler	initial stack/RAM area prior to SDRAM being available. Either
502043d9616cSwdenk	option should work for you. Using CS 4 should be fine if your
502143d9616cSwdenk	board designers haven't used it for something that would
502243d9616cSwdenk	cause you grief during the initial boot! It is frequently not
502343d9616cSwdenk	used.
502443d9616cSwdenk
50256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
502643d9616cSwdenk	with your processor/board/system design. The default value
502743d9616cSwdenk	you will find in any recent u-boot distribution in
50288a316c9bSStefan Roese	walnut.h should work for you. I'd set it to a value larger
502943d9616cSwdenk	than your SDRAM module. If you have a 64MB SDRAM module, set
503043d9616cSwdenk	it above 400_0000. Just make sure your board has no resources
503143d9616cSwdenk	that are supposed to respond to that address! That code in
503243d9616cSwdenk	start.S has been around a while and should work as is when
503343d9616cSwdenk	you get the config right.
503443d9616cSwdenk
503543d9616cSwdenk	-Chris Hallinan
503643d9616cSwdenk	DS4.COM, Inc.
503743d9616cSwdenk
5038c609719bSwdenkIt is essential to remember this, since it has some impact on the C
5039c609719bSwdenkcode for the initialization procedures:
5040c609719bSwdenk
5041c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt
5042c609719bSwdenk  to write it.
5043c609719bSwdenk
504411ccc33fSMarcel Ziswiler* Do not use any uninitialized global data (or implicitely initialized
5045c609719bSwdenk  as zero data - BSS segment) at all - this is undefined, initiali-
50467152b1d0Swdenk  zation is performed later (when relocating to RAM).
5047c609719bSwdenk
5048c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like
5049c609719bSwdenk  that.
5050c609719bSwdenk
5051c609719bSwdenkHaving only the stack as writable memory limits means we cannot use
5052c609719bSwdenknormal global data to share information beween the code. But it
5053c609719bSwdenkturned out that the implementation of U-Boot can be greatly
5054c609719bSwdenksimplified by making a global data structure (gd_t) available to all
5055c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_
5056c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of
5057c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we
5058c609719bSwdenkplace a pointer (gd) to the global data into a register which we
5059c609719bSwdenkreserve for this purpose.
5060c609719bSwdenk
50617152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the
5062c609719bSwdenkrelevant  (E)ABI  specifications for the current architecture, and by
5063c609719bSwdenkGCC's implementation.
5064c609719bSwdenk
5065c609719bSwdenkFor PowerPC, the following registers have specific use:
5066c609719bSwdenk	R1:	stack pointer
5067e7670f6cSWolfgang Denk	R2:	reserved for system use
5068c609719bSwdenk	R3-R4:	parameter passing and return values
5069c609719bSwdenk	R5-R10: parameter passing
5070c609719bSwdenk	R13:	small data area pointer
5071c609719bSwdenk	R30:	GOT pointer
5072c609719bSwdenk	R31:	frame pointer
5073c609719bSwdenk
5074e6bee808SJoakim Tjernlund	(U-Boot also uses R12 as internal GOT pointer. r12
5075e6bee808SJoakim Tjernlund	is a volatile register so r12 needs to be reset when
5076e6bee808SJoakim Tjernlund	going back and forth between asm and C)
5077c609719bSwdenk
5078e7670f6cSWolfgang Denk    ==> U-Boot will use R2 to hold a pointer to the global data
5079c609719bSwdenk
5080c609719bSwdenk    Note: on PPC, we could use a static initializer (since the
5081c609719bSwdenk    address of the global data structure is known at compile time),
5082c609719bSwdenk    but it turned out that reserving a register results in somewhat
5083c609719bSwdenk    smaller code - although the code savings are not that big (on
5084c609719bSwdenk    average for all boards 752 bytes for the whole U-Boot image,
5085c609719bSwdenk    624 text + 127 data).
5086c609719bSwdenk
5087c4db335cSRobin GetzOn Blackfin, the normal C ABI (except for P3) is followed as documented here:
50884c58eb55SMike Frysinger	http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
50894c58eb55SMike Frysinger
5090c4db335cSRobin Getz    ==> U-Boot will use P3 to hold a pointer to the global data
50914c58eb55SMike Frysinger
5092c609719bSwdenkOn ARM, the following registers are used:
5093c609719bSwdenk
5094c609719bSwdenk	R0:	function argument word/integer result
5095c609719bSwdenk	R1-R3:	function argument word
5096c609719bSwdenk	R9:	GOT pointer
5097c609719bSwdenk	R10:	stack limit (used only if stack checking if enabled)
5098c609719bSwdenk	R11:	argument (frame) pointer
5099c609719bSwdenk	R12:	temporary workspace
5100c609719bSwdenk	R13:	stack pointer
5101c609719bSwdenk	R14:	link register
5102c609719bSwdenk	R15:	program counter
5103c609719bSwdenk
5104c609719bSwdenk    ==> U-Boot will use R8 to hold a pointer to the global data
5105c609719bSwdenk
51060df01fd3SThomas ChouOn Nios II, the ABI is documented here:
51070df01fd3SThomas Chou	http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
51080df01fd3SThomas Chou
51090df01fd3SThomas Chou    ==> U-Boot will use gp to hold a pointer to the global data
51100df01fd3SThomas Chou
51110df01fd3SThomas Chou    Note: on Nios II, we give "-G0" option to gcc and don't use gp
51120df01fd3SThomas Chou    to access small data sections, so gp is free.
51130df01fd3SThomas Chou
5114afc1ce82SMacpaul LinOn NDS32, the following registers are used:
5115afc1ce82SMacpaul Lin
5116afc1ce82SMacpaul Lin	R0-R1:	argument/return
5117afc1ce82SMacpaul Lin	R2-R5:	argument
5118afc1ce82SMacpaul Lin	R15:	temporary register for assembler
5119afc1ce82SMacpaul Lin	R16:	trampoline register
5120afc1ce82SMacpaul Lin	R28:	frame pointer (FP)
5121afc1ce82SMacpaul Lin	R29:	global pointer (GP)
5122afc1ce82SMacpaul Lin	R30:	link register (LP)
5123afc1ce82SMacpaul Lin	R31:	stack pointer (SP)
5124afc1ce82SMacpaul Lin	PC:	program counter (PC)
5125afc1ce82SMacpaul Lin
5126afc1ce82SMacpaul Lin    ==> U-Boot will use R10 to hold a pointer to the global data
5127afc1ce82SMacpaul Lin
5128d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5129d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much.
5130c609719bSwdenk
5131c609719bSwdenkMemory Management:
5132c609719bSwdenk------------------
5133c609719bSwdenk
5134c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the
5135c609719bSwdenkMMU is not used either for address mapping nor for memory protection.
5136c609719bSwdenk
5137c609719bSwdenkThe available memory is mapped to fixed addresses using the memory
5138c609719bSwdenkcontroller. In this process, a contiguous block is formed for each
5139c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several
5140c609719bSwdenkphysical memory banks.
5141c609719bSwdenk
5142c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on
5143c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5144c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself
5145c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some
51466d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
5147c609719bSwdenkconfiguration setting]. Below that, a structure with global Board
5148c609719bSwdenkInfo data is placed, followed by the stack (growing downward).
5149c609719bSwdenk
5150c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB
5151c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF).
5152c609719bSwdenk
5153c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like
5154c609719bSwdenkthis:
5155c609719bSwdenk
5156c609719bSwdenk	0x0000 0000	Exception Vector code
5157c609719bSwdenk	      :
5158c609719bSwdenk	0x0000 1FFF
5159c609719bSwdenk	0x0000 2000	Free for Application Use
5160c609719bSwdenk	      :
5161c609719bSwdenk	      :
5162c609719bSwdenk
5163c609719bSwdenk	      :
5164c609719bSwdenk	      :
5165c609719bSwdenk	0x00FB FF20	Monitor Stack (Growing downward)
5166c609719bSwdenk	0x00FB FFAC	Board Info Data and permanent copy of global data
5167c609719bSwdenk	0x00FC 0000	Malloc Arena
5168c609719bSwdenk	      :
5169c609719bSwdenk	0x00FD FFFF
5170c609719bSwdenk	0x00FE 0000	RAM Copy of Monitor Code
5171c609719bSwdenk	...		eventually: LCD or video framebuffer
5172c609719bSwdenk	...		eventually: pRAM (Protected RAM - unchanged by reset)
5173c609719bSwdenk	0x00FF FFFF	[End of RAM]
5174c609719bSwdenk
5175c609719bSwdenk
5176c609719bSwdenkSystem Initialization:
5177c609719bSwdenk----------------------
5178c609719bSwdenk
5179c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point
518011ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset
5181c609719bSwdenkconfiguration for CS0# this is a mirror of the onboard Flash memory.
51827152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address.
5183c609719bSwdenkTo be able to implement the initialization code in C, a (small!)
5184c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs
5185c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked
5186c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core,
5187c609719bSwdenkthe caches and the SIU.
5188c609719bSwdenk
5189c609719bSwdenkNext, all (potentially) available memory banks are mapped using a
5190c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries
5191c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5192c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5193c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a
5194c609719bSwdenksimple memory test is run that determines the size of the SDRAM
5195c609719bSwdenkbanks.
5196c609719bSwdenk
5197c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of
51987152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first
5199c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address
5200c609719bSwdenk0x00000000, with any additional banks following immediately to create
5201c609719bSwdenkcontiguous memory starting from 0.
5202c609719bSwdenk
5203c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area
5204c609719bSwdenkand allocates memory for use by malloc() and for the global Board
5205c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM
5206c609719bSwdenkpages, and the final stack is set up.
5207c609719bSwdenk
5208c609719bSwdenkOnly after this relocation will you have a "normal" C environment;
5209c609719bSwdenkuntil that you are restricted in several ways, mostly because you are
5210c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a
5211c609719bSwdenknew address in RAM.
5212c609719bSwdenk
5213c609719bSwdenk
5214c609719bSwdenkU-Boot Porting Guide:
5215c609719bSwdenk----------------------
5216c609719bSwdenk
5217c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
52186aff3115Swdenklist, October 2002]
5219c609719bSwdenk
5220c609719bSwdenk
5221c609719bSwdenkint main(int argc, char *argv[])
5222c609719bSwdenk{
5223c609719bSwdenk	sighandler_t no_more_time;
5224c609719bSwdenk
5225c609719bSwdenk	signal(SIGALRM, no_more_time);
5226c609719bSwdenk	alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
5227c609719bSwdenk
5228c609719bSwdenk	if (available_money > available_manpower) {
52296c3fef28SJerry Van Baren		Pay consultant to port U-Boot;
5230c609719bSwdenk		return 0;
5231c609719bSwdenk	}
5232c609719bSwdenk
5233c609719bSwdenk	Download latest U-Boot source;
5234c609719bSwdenk
52350668236bSWolfgang Denk	Subscribe to u-boot mailing list;
52366aff3115Swdenk
52376c3fef28SJerry Van Baren	if (clueless)
5238c609719bSwdenk		email("Hi, I am new to U-Boot, how do I get started?");
5239c609719bSwdenk
5240c609719bSwdenk	while (learning) {
5241c609719bSwdenk		Read the README file in the top level directory;
52427cb22f97Swdenk		Read http://www.denx.de/twiki/bin/view/DULG/Manual;
52436c3fef28SJerry Van Baren		Read applicable doc/*.README;
5244c609719bSwdenk		Read the source, Luke;
52456c3fef28SJerry Van Baren		/* find . -name "*.[chS]" | xargs grep -i <keyword> */
5246c609719bSwdenk	}
5247c609719bSwdenk
52486c3fef28SJerry Van Baren	if (available_money > toLocalCurrency ($2500))
52496c3fef28SJerry Van Baren		Buy a BDI3000;
52506c3fef28SJerry Van Baren	else
5251c609719bSwdenk		Add a lot of aggravation and time;
5252c609719bSwdenk
52536c3fef28SJerry Van Baren	if (a similar board exists) {	/* hopefully... */
52546c3fef28SJerry Van Baren		cp -a board/<similar> board/<myboard>
52556c3fef28SJerry Van Baren		cp include/configs/<similar>.h include/configs/<myboard>.h
52566c3fef28SJerry Van Baren	} else {
5257c609719bSwdenk		Create your own board support subdirectory;
52586c3fef28SJerry Van Baren		Create your own board include/configs/<myboard>.h file;
52596c3fef28SJerry Van Baren	}
52606c3fef28SJerry Van Baren	Edit new board/<myboard> files
52616c3fef28SJerry Van Baren	Edit new include/configs/<myboard>.h
5262c609719bSwdenk
52636c3fef28SJerry Van Baren	while (!accepted) {
5264c609719bSwdenk		while (!running) {
5265c609719bSwdenk			do {
5266c609719bSwdenk				Add / modify source code;
5267c609719bSwdenk			} until (compiles);
5268c609719bSwdenk			Debug;
5269c609719bSwdenk			if (clueless)
5270c609719bSwdenk				email("Hi, I am having problems...");
5271c609719bSwdenk		}
52726c3fef28SJerry Van Baren		Send patch file to the U-Boot email list;
52736c3fef28SJerry Van Baren		if (reasonable critiques)
52746c3fef28SJerry Van Baren			Incorporate improvements from email list code review;
52756c3fef28SJerry Van Baren		else
52766c3fef28SJerry Van Baren			Defend code as written;
52776c3fef28SJerry Van Baren	}
5278c609719bSwdenk
5279c609719bSwdenk	return 0;
5280c609719bSwdenk}
5281c609719bSwdenk
5282c609719bSwdenkvoid no_more_time (int sig)
5283c609719bSwdenk{
5284c609719bSwdenk      hire_a_guru();
5285c609719bSwdenk}
5286c609719bSwdenk
5287c609719bSwdenk
5288c609719bSwdenkCoding Standards:
5289c609719bSwdenk-----------------
5290c609719bSwdenk
5291c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel
52922c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script
52937ca9296eSWolfgang Denk"scripts/Lindent" in your Linux kernel source directory.
5294c609719bSwdenk
52952c051651SDetlev ZundelSource files originating from a different project (for example the
52962c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not
52972c051651SDetlev Zundelreformated to ease subsequent migration to newer versions of those
52982c051651SDetlev Zundelsources.
52992c051651SDetlev Zundel
53002c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in
53012c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//)
53022c051651SDetlev Zundelin your code.
5303c609719bSwdenk
5304c178d3daSwdenkPlease also stick to the following formatting rules:
5305180d3f74Swdenk- remove any trailing white space
53067ca9296eSWolfgang Denk- use TAB characters for indentation and vertical alignment, not spaces
5307180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds
53087ca9296eSWolfgang Denk- do not add more than 2 consecutive empty lines to source files
5309180d3f74Swdenk- do not add trailing empty lines to source files
5310180d3f74Swdenk
5311c609719bSwdenkSubmissions which do not conform to the standards may be returned
5312c609719bSwdenkwith a request to reformat the changes.
5313c609719bSwdenk
5314c609719bSwdenk
5315c609719bSwdenkSubmitting Patches:
5316c609719bSwdenk-------------------
5317c609719bSwdenk
5318c609719bSwdenkSince the number of patches for U-Boot is growing, we need to
5319c609719bSwdenkestablish some rules. Submissions which do not conform to these rules
5320c609719bSwdenkmay be rejected, even when they contain important and valuable stuff.
5321c609719bSwdenk
53220d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details.
5323218ca724SWolfgang Denk
53240668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
53250668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot
53260668236bSWolfgang Denk
5327c609719bSwdenkWhen you send a patch, please include the following information with
5328c609719bSwdenkit:
5329c609719bSwdenk
5330c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes
5331c609719bSwdenk  this bug. Please try to include a way of demonstrating that the
5332c609719bSwdenk  patch actually fixes something.
5333c609719bSwdenk
5334c609719bSwdenk* For new features: a description of the feature and your
5335c609719bSwdenk  implementation.
5336c609719bSwdenk
5337c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch)
5338c609719bSwdenk
5339c609719bSwdenk* For major contributions, your entry to the CREDITS file
5340c609719bSwdenk
5341c609719bSwdenk* When you add support for a new board, don't forget to add this
53427ca9296eSWolfgang Denk  board to the MAINTAINERS file, too.
5343c609719bSwdenk
5344c609719bSwdenk* If your patch adds new configuration options, don't forget to
5345c609719bSwdenk  document these in the README file.
5346c609719bSwdenk
5347218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly*
5348218ca724SWolfgang Denk  recommended) you can easily generate the patch using the
53497ca9296eSWolfgang Denk  "git format-patch". If you then use "git send-email" to send it to
5350218ca724SWolfgang Denk  the U-Boot mailing list, you will avoid most of the common problems
5351218ca724SWolfgang Denk  with some other mail clients.
5352c609719bSwdenk
5353218ca724SWolfgang Denk  If you cannot use git, use "diff -purN OLD NEW". If your version of
5354218ca724SWolfgang Denk  diff does not support these options, then get the latest version of
5355218ca724SWolfgang Denk  GNU diff.
53566dff5529Swdenk
5357218ca724SWolfgang Denk  The current directory when running this command shall be the parent
5358218ca724SWolfgang Denk  directory of the U-Boot source tree (i. e. please make sure that
5359218ca724SWolfgang Denk  your patch includes sufficient directory information for the
5360218ca724SWolfgang Denk  affected files).
5361218ca724SWolfgang Denk
5362218ca724SWolfgang Denk  We prefer patches as plain text. MIME attachments are discouraged,
5363218ca724SWolfgang Denk  and compressed attachments must not be used.
5364c609719bSwdenk
536552f52c14Swdenk* If one logical set of modifications affects or creates several
536652f52c14Swdenk  files, all these changes shall be submitted in a SINGLE patch file.
536752f52c14Swdenk
536852f52c14Swdenk* Changesets that contain different, unrelated modifications shall be
536952f52c14Swdenk  submitted as SEPARATE patches, one patch per changeset.
537052f52c14Swdenk
537152f52c14Swdenk
5372c609719bSwdenkNotes:
5373c609719bSwdenk
5374c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched
5375c609719bSwdenk  source tree and make sure that no errors or warnings are reported
5376c609719bSwdenk  for any of the boards.
5377c609719bSwdenk
5378c609719bSwdenk* Keep your modifications to the necessary minimum: A patch
5379c609719bSwdenk  containing several unrelated changes or arbitrary reformats will be
5380c609719bSwdenk  returned with a request to re-formatting / split it.
5381c609719bSwdenk
5382c609719bSwdenk* If you modify existing code, make sure that your new code does not
5383c609719bSwdenk  add to the memory footprint of the code ;-) Small is beautiful!
5384c609719bSwdenk  When adding new features, these should compile conditionally only
5385c609719bSwdenk  (using #ifdef), and the resulting code with the new feature
5386c609719bSwdenk  disabled must not need more memory than the old code without your
5387c609719bSwdenk  modification.
538890dc6704Swdenk
53890668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the
53900668236bSWolfgang Denk  u-boot mailing list. Bigger patches will be moderated. If they are
53910668236bSWolfgang Denk  reasonable and not too big, they will be acknowledged. But patches
53920668236bSWolfgang Denk  bigger than the size limit should be avoided.
5393