xref: /openbmc/u-boot/README (revision cb93071bb6da21d17dd7d7d414a389b380f959b2)
1c609719bSwdenk#
2eca3aeb3SWolfgang Denk# (C) Copyright 2000 - 2013
3c609719bSwdenk# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4c609719bSwdenk#
5eca3aeb3SWolfgang Denk# SPDX-License-Identifier:	GPL-2.0+
6c609719bSwdenk#
7c609719bSwdenk
8c609719bSwdenkSummary:
9c609719bSwdenk========
10c609719bSwdenk
1124ee89b9SwdenkThis directory contains the source code for U-Boot, a boot loader for
12e86e5a07SwdenkEmbedded boards based on PowerPC, ARM, MIPS and several other
13e86e5a07Swdenkprocessors, which can be installed in a boot ROM and used to
14e86e5a07Swdenkinitialize and test the hardware or to download and run application
15e86e5a07Swdenkcode.
16c609719bSwdenk
17c609719bSwdenkThe development of U-Boot is closely related to Linux: some parts of
1824ee89b9Swdenkthe source code originate in the Linux source tree, we have some
1924ee89b9Swdenkheader files in common, and special provision has been made to
20c609719bSwdenksupport booting of Linux images.
21c609719bSwdenk
22c609719bSwdenkSome attention has been paid to make this software easily
23c609719bSwdenkconfigurable and extendable. For instance, all monitor commands are
24c609719bSwdenkimplemented with the same call interface, so that it's very easy to
25c609719bSwdenkadd new commands. Also, instead of permanently adding rarely used
26c609719bSwdenkcode (for instance hardware test utilities) to the monitor, you can
27c609719bSwdenkload and run it dynamically.
28c609719bSwdenk
29c609719bSwdenk
30c609719bSwdenkStatus:
31c609719bSwdenk=======
32c609719bSwdenk
33c609719bSwdenkIn general, all boards for which a configuration option exists in the
34c609719bSwdenkMakefile have been tested to some extent and can be considered
35c609719bSwdenk"working". In fact, many of them are used in production systems.
36c609719bSwdenk
37c609719bSwdenkIn case of problems see the CHANGELOG and CREDITS files to find out
38218ca724SWolfgang Denkwho contributed the specific port. The MAINTAINERS file lists board
39218ca724SWolfgang Denkmaintainers.
40c609719bSwdenk
41adb9d851SRobert P. J. DayNote: There is no CHANGELOG file in the actual U-Boot source tree;
42adb9d851SRobert P. J. Dayit can be created dynamically from the Git log using:
43adb9d851SRobert P. J. Day
44adb9d851SRobert P. J. Day	make CHANGELOG
45adb9d851SRobert P. J. Day
46c609719bSwdenk
47c609719bSwdenkWhere to get help:
48c609719bSwdenk==================
49c609719bSwdenk
50c609719bSwdenkIn case you have questions about, problems with or contributions for
51c609719bSwdenkU-Boot you should send a message to the U-Boot mailing list at
520c32565fSPeter Tyser<u-boot@lists.denx.de>. There is also an archive of previous traffic
530c32565fSPeter Tyseron the mailing list - please search the archive before asking FAQ's.
540c32565fSPeter TyserPlease see http://lists.denx.de/pipermail/u-boot and
550c32565fSPeter Tyserhttp://dir.gmane.org/gmane.comp.boot-loaders.u-boot
56c609719bSwdenk
57c609719bSwdenk
58218ca724SWolfgang DenkWhere to get source code:
59218ca724SWolfgang Denk=========================
60218ca724SWolfgang Denk
61218ca724SWolfgang DenkThe U-Boot source code is maintained in the git repository at
62218ca724SWolfgang Denkgit://www.denx.de/git/u-boot.git ; you can browse it online at
63218ca724SWolfgang Denkhttp://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
64218ca724SWolfgang Denk
65218ca724SWolfgang DenkThe "snapshot" links on this page allow you to download tarballs of
6611ccc33fSMarcel Ziswilerany version you might be interested in. Official releases are also
67218ca724SWolfgang Denkavailable for FTP download from the ftp://ftp.denx.de/pub/u-boot/
68218ca724SWolfgang Denkdirectory.
69218ca724SWolfgang Denk
70d4ee711dSAnatolij GustschinPre-built (and tested) images are available from
71218ca724SWolfgang Denkftp://ftp.denx.de/pub/u-boot/images/
72218ca724SWolfgang Denk
73218ca724SWolfgang Denk
74c609719bSwdenkWhere we come from:
75c609719bSwdenk===================
76c609719bSwdenk
77c609719bSwdenk- start from 8xxrom sources
7824ee89b9Swdenk- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
79c609719bSwdenk- clean up code
80c609719bSwdenk- make it easier to add custom boards
81c609719bSwdenk- make it possible to add other [PowerPC] CPUs
82c609719bSwdenk- extend functions, especially:
83c609719bSwdenk  * Provide extended interface to Linux boot loader
84c609719bSwdenk  * S-Record download
85c609719bSwdenk  * network boot
8611ccc33fSMarcel Ziswiler  * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
8724ee89b9Swdenk- create ARMBoot project (http://sourceforge.net/projects/armboot)
88c609719bSwdenk- add other CPU families (starting with ARM)
8924ee89b9Swdenk- create U-Boot project (http://sourceforge.net/projects/u-boot)
900d28f34bSMagnus Lilja- current project page: see http://www.denx.de/wiki/U-Boot
9124ee89b9Swdenk
9224ee89b9Swdenk
9324ee89b9SwdenkNames and Spelling:
9424ee89b9Swdenk===================
9524ee89b9Swdenk
9624ee89b9SwdenkThe "official" name of this project is "Das U-Boot". The spelling
9724ee89b9Swdenk"U-Boot" shall be used in all written text (documentation, comments
9824ee89b9Swdenkin source files etc.). Example:
9924ee89b9Swdenk
10024ee89b9Swdenk	This is the README file for the U-Boot project.
10124ee89b9Swdenk
10224ee89b9SwdenkFile names etc. shall be based on the string "u-boot". Examples:
10324ee89b9Swdenk
10424ee89b9Swdenk	include/asm-ppc/u-boot.h
10524ee89b9Swdenk
10624ee89b9Swdenk	#include <asm/u-boot.h>
10724ee89b9Swdenk
10824ee89b9SwdenkVariable names, preprocessor constants etc. shall be either based on
10924ee89b9Swdenkthe string "u_boot" or on "U_BOOT". Example:
11024ee89b9Swdenk
11124ee89b9Swdenk	U_BOOT_VERSION		u_boot_logo
11224ee89b9Swdenk	IH_OS_U_BOOT		u_boot_hush_start
113c609719bSwdenk
114c609719bSwdenk
11593f19cc0SwdenkVersioning:
11693f19cc0Swdenk===========
11793f19cc0Swdenk
118360d883aSThomas WeberStarting with the release in October 2008, the names of the releases
119360d883aSThomas Weberwere changed from numerical release numbers without deeper meaning
120360d883aSThomas Weberinto a time stamp based numbering. Regular releases are identified by
121360d883aSThomas Webernames consisting of the calendar year and month of the release date.
122360d883aSThomas WeberAdditional fields (if present) indicate release candidates or bug fix
123360d883aSThomas Weberreleases in "stable" maintenance trees.
12493f19cc0Swdenk
125360d883aSThomas WeberExamples:
126360d883aSThomas Weber	U-Boot v2009.11	    - Release November 2009
127360d883aSThomas Weber	U-Boot v2009.11.1   - Release 1 in version November 2009 stable tree
128360d883aSThomas Weber	U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release
12993f19cc0Swdenk
13093f19cc0Swdenk
131c609719bSwdenkDirectory Hierarchy:
132c609719bSwdenk====================
133c609719bSwdenk
1348d321b81SPeter Tyser/arch			Architecture specific files
1358d321b81SPeter Tyser  /arm			Files generic to ARM architecture
1368d321b81SPeter Tyser    /cpu		CPU specific files
1378d321b81SPeter Tyser      /arm720t		Files specific to ARM 720 CPUs
1388d321b81SPeter Tyser      /arm920t		Files specific to ARM 920 CPUs
1396eb0921aSAndreas Bießmann	/at91		Files specific to Atmel AT91RM9200 CPU
1408d321b81SPeter Tyser	/imx		Files specific to Freescale MC9328 i.MX CPUs
1418d321b81SPeter Tyser	/s3c24x0	Files specific to Samsung S3C24X0 CPUs
1428d321b81SPeter Tyser      /arm925t		Files specific to ARM 925 CPUs
1438d321b81SPeter Tyser      /arm926ejs	Files specific to ARM 926 CPUs
1448d321b81SPeter Tyser      /arm1136		Files specific to ARM 1136 CPUs
1458d321b81SPeter Tyser      /ixp		Files specific to Intel XScale IXP CPUs
1468d321b81SPeter Tyser      /pxa		Files specific to Intel XScale PXA CPUs
1478d321b81SPeter Tyser      /s3c44b0		Files specific to Samsung S3C44B0 CPUs
1488d321b81SPeter Tyser      /sa1100		Files specific to Intel StrongARM SA1100 CPUs
1498d321b81SPeter Tyser    /lib		Architecture specific library files
1508d321b81SPeter Tyser  /avr32		Files generic to AVR32 architecture
1518d321b81SPeter Tyser    /cpu		CPU specific files
1528d321b81SPeter Tyser    /lib		Architecture specific library files
1538d321b81SPeter Tyser  /blackfin		Files generic to Analog Devices Blackfin architecture
1548d321b81SPeter Tyser    /cpu		CPU specific files
1558d321b81SPeter Tyser    /lib		Architecture specific library files
156fea25720SGraeme Russ  /x86			Files generic to x86 architecture
1578d321b81SPeter Tyser    /cpu		CPU specific files
1588d321b81SPeter Tyser    /lib		Architecture specific library files
1598d321b81SPeter Tyser  /m68k			Files generic to m68k architecture
1608d321b81SPeter Tyser    /cpu		CPU specific files
1618d321b81SPeter Tyser      /mcf52x2		Files specific to Freescale ColdFire MCF52x2 CPUs
1628d321b81SPeter Tyser      /mcf5227x		Files specific to Freescale ColdFire MCF5227x CPUs
1638d321b81SPeter Tyser      /mcf532x		Files specific to Freescale ColdFire MCF5329 CPUs
1648d321b81SPeter Tyser      /mcf5445x		Files specific to Freescale ColdFire MCF5445x CPUs
1658d321b81SPeter Tyser      /mcf547x_8x	Files specific to Freescale ColdFire MCF547x_8x CPUs
1668d321b81SPeter Tyser    /lib		Architecture specific library files
1678d321b81SPeter Tyser  /microblaze		Files generic to microblaze architecture
1688d321b81SPeter Tyser    /cpu		CPU specific files
1698d321b81SPeter Tyser    /lib		Architecture specific library files
1708d321b81SPeter Tyser  /mips			Files generic to MIPS architecture
1718d321b81SPeter Tyser    /cpu		CPU specific files
17292bbd64eSDaniel Schwierzeck      /mips32		Files specific to MIPS32 CPUs
17380421fccSXiangfu Liu      /xburst		Files specific to Ingenic XBurst CPUs
1748d321b81SPeter Tyser    /lib		Architecture specific library files
175afc1ce82SMacpaul Lin  /nds32		Files generic to NDS32 architecture
176afc1ce82SMacpaul Lin    /cpu		CPU specific files
177afc1ce82SMacpaul Lin      /n1213		Files specific to Andes Technology N1213 CPUs
178afc1ce82SMacpaul Lin    /lib		Architecture specific library files
1798d321b81SPeter Tyser  /nios2		Files generic to Altera NIOS2 architecture
1808d321b81SPeter Tyser    /cpu		CPU specific files
1818d321b81SPeter Tyser    /lib		Architecture specific library files
182a47a12beSStefan Roese  /powerpc		Files generic to PowerPC architecture
1838d321b81SPeter Tyser    /cpu		CPU specific files
1848d321b81SPeter Tyser      /74xx_7xx		Files specific to Freescale MPC74xx and 7xx CPUs
1858d321b81SPeter Tyser      /mpc5xx		Files specific to Freescale MPC5xx CPUs
1868d321b81SPeter Tyser      /mpc5xxx		Files specific to Freescale MPC5xxx CPUs
1878d321b81SPeter Tyser      /mpc8xx		Files specific to Freescale MPC8xx CPUs
1888d321b81SPeter Tyser      /mpc824x		Files specific to Freescale MPC824x CPUs
1898d321b81SPeter Tyser      /mpc8260		Files specific to Freescale MPC8260 CPUs
1908d321b81SPeter Tyser      /mpc85xx		Files specific to Freescale MPC85xx CPUs
1918d321b81SPeter Tyser      /ppc4xx		Files specific to AMCC PowerPC 4xx CPUs
1928d321b81SPeter Tyser    /lib		Architecture specific library files
1938d321b81SPeter Tyser  /sh			Files generic to SH architecture
1948d321b81SPeter Tyser    /cpu		CPU specific files
1958d321b81SPeter Tyser      /sh2		Files specific to sh2 CPUs
1968d321b81SPeter Tyser      /sh3		Files specific to sh3 CPUs
1978d321b81SPeter Tyser      /sh4		Files specific to sh4 CPUs
1988d321b81SPeter Tyser    /lib		Architecture specific library files
1998d321b81SPeter Tyser  /sparc		Files generic to SPARC architecture
2008d321b81SPeter Tyser    /cpu		CPU specific files
2018d321b81SPeter Tyser      /leon2		Files specific to Gaisler LEON2 SPARC CPU
2028d321b81SPeter Tyser      /leon3		Files specific to Gaisler LEON3 SPARC CPU
2038d321b81SPeter Tyser    /lib		Architecture specific library files
2048d321b81SPeter Tyser/api			Machine/arch independent API for external apps
2058d321b81SPeter Tyser/board			Board dependent files
2068d321b81SPeter Tyser/common			Misc architecture independent functions
2078d321b81SPeter Tyser/disk			Code for disk drive partition handling
2088d321b81SPeter Tyser/doc			Documentation (don't expect too much)
2098d321b81SPeter Tyser/drivers		Commonly used device drivers
2108d321b81SPeter Tyser/examples		Example code for standalone applications, etc.
2118d321b81SPeter Tyser/fs			Filesystem code (cramfs, ext2, jffs2, etc.)
2128d321b81SPeter Tyser/include		Header Files
2138d321b81SPeter Tyser/lib			Files generic to all architectures
2148d321b81SPeter Tyser  /libfdt		Library files to support flattened device trees
2158d321b81SPeter Tyser  /lzma			Library files to support LZMA decompression
2168d321b81SPeter Tyser  /lzo			Library files to support LZO decompression
2178d321b81SPeter Tyser/net			Networking code
2188d321b81SPeter Tyser/post			Power On Self Test
2198d321b81SPeter Tyser/rtc			Real Time Clock drivers
2208d321b81SPeter Tyser/tools			Tools to build S-Record or U-Boot images, etc.
221c609719bSwdenk
222c609719bSwdenkSoftware Configuration:
223c609719bSwdenk=======================
224c609719bSwdenk
225c609719bSwdenkConfiguration is usually done using C preprocessor defines; the
226c609719bSwdenkrationale behind that is to avoid dead code whenever possible.
227c609719bSwdenk
228c609719bSwdenkThere are two classes of configuration variables:
229c609719bSwdenk
230c609719bSwdenk* Configuration _OPTIONS_:
231c609719bSwdenk  These are selectable by the user and have names beginning with
232c609719bSwdenk  "CONFIG_".
233c609719bSwdenk
234c609719bSwdenk* Configuration _SETTINGS_:
235c609719bSwdenk  These depend on the hardware etc. and should not be meddled with if
236c609719bSwdenk  you don't know what you're doing; they have names beginning with
2376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  "CONFIG_SYS_".
238c609719bSwdenk
239c609719bSwdenkLater we will add a configuration tool - probably similar to or even
240c609719bSwdenkidentical to what's used for the Linux kernel. Right now, we have to
241c609719bSwdenkdo the configuration by hand, which means creating some symbolic
242c609719bSwdenklinks and editing some configuration files. We use the TQM8xxL boards
243c609719bSwdenkas an example here.
244c609719bSwdenk
245c609719bSwdenk
246c609719bSwdenkSelection of Processor Architecture and Board Type:
247c609719bSwdenk---------------------------------------------------
248c609719bSwdenk
249c609719bSwdenkFor all supported boards there are ready-to-use default
250c609719bSwdenkconfigurations available; just type "make <board_name>_config".
251c609719bSwdenk
252c609719bSwdenkExample: For a TQM823L module type:
253c609719bSwdenk
254c609719bSwdenk	cd u-boot
255c609719bSwdenk	make TQM823L_config
256c609719bSwdenk
25711ccc33fSMarcel ZiswilerFor the Cogent platform, you need to specify the CPU type as well;
258c609719bSwdenke.g. "make cogent_mpc8xx_config". And also configure the cogent
259c609719bSwdenkdirectory according to the instructions in cogent/README.
260c609719bSwdenk
261c609719bSwdenk
262c609719bSwdenkConfiguration Options:
263c609719bSwdenk----------------------
264c609719bSwdenk
265c609719bSwdenkConfiguration depends on the combination of board and CPU type; all
266c609719bSwdenksuch information is kept in a configuration file
267c609719bSwdenk"include/configs/<board_name>.h".
268c609719bSwdenk
269c609719bSwdenkExample: For a TQM823L module, all configuration settings are in
270c609719bSwdenk"include/configs/TQM823L.h".
271c609719bSwdenk
272c609719bSwdenk
2737f6c2cbcSwdenkMany of the options are named exactly as the corresponding Linux
2747f6c2cbcSwdenkkernel configuration options. The intention is to make it easier to
2757f6c2cbcSwdenkbuild a config tool - later.
2767f6c2cbcSwdenk
2777f6c2cbcSwdenk
278c609719bSwdenkThe following options need to be configured:
279c609719bSwdenk
2802628114eSKim Phillips- CPU Type:	Define exactly one, e.g. CONFIG_MPC85XX.
281c609719bSwdenk
2822628114eSKim Phillips- Board Type:	Define exactly one, e.g. CONFIG_MPC8540ADS.
2836ccec449SWolfgang Denk
2846ccec449SWolfgang Denk- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
28509ea0de0SHaavard Skinnemoen		Define exactly one, e.g. CONFIG_ATSTK1002
286c609719bSwdenk
287c609719bSwdenk- CPU Module Type: (if CONFIG_COGENT is defined)
288c609719bSwdenk		Define exactly one of
289c609719bSwdenk		CONFIG_CMA286_60_OLD
290c609719bSwdenk--- FIXME --- not tested yet:
291c609719bSwdenk		CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
292c609719bSwdenk		CONFIG_CMA287_23, CONFIG_CMA287_50
293c609719bSwdenk
294c609719bSwdenk- Motherboard Type: (if CONFIG_COGENT is defined)
295c609719bSwdenk		Define exactly one of
296c609719bSwdenk		CONFIG_CMA101, CONFIG_CMA102
297c609719bSwdenk
298c609719bSwdenk- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
299c609719bSwdenk		Define one or more of
300c609719bSwdenk		CONFIG_CMA302
301c609719bSwdenk
302c609719bSwdenk- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
303c609719bSwdenk		Define one or more of
304c609719bSwdenk		CONFIG_LCD_HEARTBEAT	- update a character position on
30511ccc33fSMarcel Ziswiler					  the LCD display every second with
306c609719bSwdenk					  a "rotator" |\-/|\-/
307c609719bSwdenk
3082535d602Swdenk- Board flavour: (if CONFIG_MPC8260ADS is defined)
3092535d602Swdenk		CONFIG_ADSTYPE
3102535d602Swdenk		Possible values are:
3116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8260ADS	- original MPC8260ADS
3126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8266ADS	- MPC8266ADS
3136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_PQ2FADS	- PQ2FADS-ZU or PQ2FADS-VR
3146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8272ADS	- MPC8272ADS
3152535d602Swdenk
316cf946c6dSLei Wen- Marvell Family Member
317cf946c6dSLei Wen		CONFIG_SYS_MVFS		- define it if you want to enable
318cf946c6dSLei Wen					  multiple fs option at one time
319cf946c6dSLei Wen					  for marvell soc family
320cf946c6dSLei Wen
321c609719bSwdenk- MPC824X Family Member (if CONFIG_MPC824X is defined)
322c609719bSwdenk		Define exactly one of
323c609719bSwdenk		CONFIG_MPC8240, CONFIG_MPC8245
324c609719bSwdenk
32511ccc33fSMarcel Ziswiler- 8xx CPU Options: (if using an MPC8xx CPU)
32666ca92a5Swdenk		CONFIG_8xx_GCLK_FREQ	- deprecated: CPU clock if
32766ca92a5Swdenk					  get_gclk_freq() cannot work
3285da627a4Swdenk					  e.g. if there is no 32KHz
3295da627a4Swdenk					  reference PIT/RTC clock
33066ca92a5Swdenk		CONFIG_8xx_OSCLK	- PLL input clock (either EXTCLK
33166ca92a5Swdenk					  or XTAL/EXTAL)
332c609719bSwdenk
33366ca92a5Swdenk- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
3346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MIN
3356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MAX
33666ca92a5Swdenk		CONFIG_8xx_CPUCLK_DEFAULT
33775d1ea7fSwdenk			See doc/README.MPC866
33875d1ea7fSwdenk
3396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MEASURE_CPUCLK
34075d1ea7fSwdenk
34175d1ea7fSwdenk		Define this to measure the actual CPU clock instead
34275d1ea7fSwdenk		of relying on the correctness of the configured
34375d1ea7fSwdenk		values. Mostly useful for board bringup to make sure
34475d1ea7fSwdenk		the PLL is locked at the intended frequency. Note
34575d1ea7fSwdenk		that this requires a (stable) reference clock (32 kHz
3466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		RTC clock or CONFIG_SYS_8XX_XIN)
34775d1ea7fSwdenk
348506f3918SHeiko Schocher		CONFIG_SYS_DELAYED_ICACHE
349506f3918SHeiko Schocher
350506f3918SHeiko Schocher		Define this option if you want to enable the
351506f3918SHeiko Schocher		ICache only when Code runs from RAM.
352506f3918SHeiko Schocher
35366412c63SKumar Gala- 85xx CPU Options:
354ffd06e02SYork Sun		CONFIG_SYS_PPC64
355ffd06e02SYork Sun
356ffd06e02SYork Sun		Specifies that the core is a 64-bit PowerPC implementation (implements
357ffd06e02SYork Sun		the "64" category of the Power ISA). This is necessary for ePAPR
358ffd06e02SYork Sun		compliance, among other possible reasons.
359ffd06e02SYork Sun
36066412c63SKumar Gala		CONFIG_SYS_FSL_TBCLK_DIV
36166412c63SKumar Gala
36266412c63SKumar Gala		Defines the core time base clock divider ratio compared to the
36366412c63SKumar Gala		system clock.  On most PQ3 devices this is 8, on newer QorIQ
36466412c63SKumar Gala		devices it can be 16 or 32.  The ratio varies from SoC to Soc.
36566412c63SKumar Gala
3668f29084aSKumar Gala		CONFIG_SYS_FSL_PCIE_COMPAT
3678f29084aSKumar Gala
3688f29084aSKumar Gala		Defines the string to utilize when trying to match PCIe device
3698f29084aSKumar Gala		tree nodes for the given platform.
3708f29084aSKumar Gala
371afa6b551SPrabhakar Kushwaha		CONFIG_SYS_PPC_E500_DEBUG_TLB
372afa6b551SPrabhakar Kushwaha
373afa6b551SPrabhakar Kushwaha		Enables a temporary TLB entry to be used during boot to work
374afa6b551SPrabhakar Kushwaha		around limitations in e500v1 and e500v2 external debugger
375afa6b551SPrabhakar Kushwaha		support. This reduces the portions of the boot code where
376afa6b551SPrabhakar Kushwaha		breakpoints and single stepping do not work.  The value of this
377afa6b551SPrabhakar Kushwaha		symbol should be set to the TLB1 entry to be used for this
378afa6b551SPrabhakar Kushwaha		purpose.
379afa6b551SPrabhakar Kushwaha
38033eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510
38133eee330SScott Wood
38233eee330SScott Wood		Enables a workaround for erratum A004510.  If set,
38333eee330SScott Wood		then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
38433eee330SScott Wood		CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
38533eee330SScott Wood
38633eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
38733eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
38833eee330SScott Wood
38933eee330SScott Wood		Defines one or two SoC revisions (low 8 bits of SVR)
39033eee330SScott Wood		for which the A004510 workaround should be applied.
39133eee330SScott Wood
39233eee330SScott Wood		The rest of SVR is either not relevant to the decision
39333eee330SScott Wood		of whether the erratum is present (e.g. p2040 versus
39433eee330SScott Wood		p2041) or is implied by the build target, which controls
39533eee330SScott Wood		whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
39633eee330SScott Wood
39733eee330SScott Wood		See Freescale App Note 4493 for more information about
39833eee330SScott Wood		this erratum.
39933eee330SScott Wood
40074fa22edSPrabhakar Kushwaha		CONFIG_A003399_NOR_WORKAROUND
40174fa22edSPrabhakar Kushwaha		Enables a workaround for IFC erratum A003399. It is only
40274fa22edSPrabhakar Kushwaha		requred during NOR boot.
40374fa22edSPrabhakar Kushwaha
40433eee330SScott Wood		CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
40533eee330SScott Wood
40633eee330SScott Wood		This is the value to write into CCSR offset 0x18600
40733eee330SScott Wood		according to the A004510 workaround.
40833eee330SScott Wood
409765b0bdbSPriyanka Jain		CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
410765b0bdbSPriyanka Jain		This value denotes start offset of M2 memory
411765b0bdbSPriyanka Jain		which is directly connected to the DSP core.
412765b0bdbSPriyanka Jain
413765b0bdbSPriyanka Jain		CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
414765b0bdbSPriyanka Jain		This value denotes start offset of DSP CCSR space.
415765b0bdbSPriyanka Jain
416*cb93071bSYork Sun		CONFIG_SYS_FSL_DDR_EMU
417*cb93071bSYork Sun		Specify emulator support for DDR. Some DDR features such as
418*cb93071bSYork Sun		deskew training are not available.
419*cb93071bSYork Sun
4206cb461b4SDaniel Schwierzeck- Generic CPU options:
4216cb461b4SDaniel Schwierzeck		CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
4226cb461b4SDaniel Schwierzeck
4236cb461b4SDaniel Schwierzeck		Defines the endianess of the CPU. Implementation of those
4246cb461b4SDaniel Schwierzeck		values is arch specific.
4256cb461b4SDaniel Schwierzeck
4260b953ffcSMarkus Klotzbuecher- Intel Monahans options:
4276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
4280b953ffcSMarkus Klotzbuecher
4290b953ffcSMarkus Klotzbuecher		Defines the Monahans run mode to oscillator
4300b953ffcSMarkus Klotzbuecher		ratio. Valid values are 8, 16, 24, 31. The core
4310b953ffcSMarkus Klotzbuecher		frequency is this value multiplied by 13 MHz.
4320b953ffcSMarkus Klotzbuecher
4336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
4340b953ffcSMarkus Klotzbuecher
4350b953ffcSMarkus Klotzbuecher		Defines the Monahans turbo mode to oscillator
4360b953ffcSMarkus Klotzbuecher		ratio. Valid values are 1 (default if undefined) and
4370b953ffcSMarkus Klotzbuecher		2. The core frequency as calculated above is multiplied
4380b953ffcSMarkus Klotzbuecher		by this value.
4390b953ffcSMarkus Klotzbuecher
44092bbd64eSDaniel Schwierzeck- MIPS CPU options:
44192bbd64eSDaniel Schwierzeck		CONFIG_SYS_INIT_SP_OFFSET
44292bbd64eSDaniel Schwierzeck
44392bbd64eSDaniel Schwierzeck		Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
44492bbd64eSDaniel Schwierzeck		pointer. This is needed for the temporary stack before
44592bbd64eSDaniel Schwierzeck		relocation.
44692bbd64eSDaniel Schwierzeck
44792bbd64eSDaniel Schwierzeck		CONFIG_SYS_MIPS_CACHE_MODE
44892bbd64eSDaniel Schwierzeck
44992bbd64eSDaniel Schwierzeck		Cache operation mode for the MIPS CPU.
45092bbd64eSDaniel Schwierzeck		See also arch/mips/include/asm/mipsregs.h.
45192bbd64eSDaniel Schwierzeck		Possible values are:
45292bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_NO_WA
45392bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_WA
45492bbd64eSDaniel Schwierzeck			CONF_CM_UNCACHED
45592bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_NONCOHERENT
45692bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_CE
45792bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_COW
45892bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_CUW
45992bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_ACCELERATED
46092bbd64eSDaniel Schwierzeck
46192bbd64eSDaniel Schwierzeck		CONFIG_SYS_XWAY_EBU_BOOTCFG
46292bbd64eSDaniel Schwierzeck
46392bbd64eSDaniel Schwierzeck		Special option for Lantiq XWAY SoCs for booting from NOR flash.
46492bbd64eSDaniel Schwierzeck		See also arch/mips/cpu/mips32/start.S.
46592bbd64eSDaniel Schwierzeck
46692bbd64eSDaniel Schwierzeck		CONFIG_XWAY_SWAP_BYTES
46792bbd64eSDaniel Schwierzeck
46892bbd64eSDaniel Schwierzeck		Enable compilation of tools/xway-swap-bytes needed for Lantiq
46992bbd64eSDaniel Schwierzeck		XWAY SoCs for booting from NOR flash. The U-Boot image needs to
47092bbd64eSDaniel Schwierzeck		be swapped if a flash programmer is used.
47192bbd64eSDaniel Schwierzeck
472b67d8816SChristian Riesch- ARM options:
473b67d8816SChristian Riesch		CONFIG_SYS_EXCEPTION_VECTORS_HIGH
474b67d8816SChristian Riesch
475b67d8816SChristian Riesch		Select high exception vectors of the ARM core, e.g., do not
476b67d8816SChristian Riesch		clear the V bit of the c1 register of CP15.
477b67d8816SChristian Riesch
4785356f545SAneesh V		CONFIG_SYS_THUMB_BUILD
4795356f545SAneesh V
4805356f545SAneesh V		Use this flag to build U-Boot using the Thumb instruction
4815356f545SAneesh V		set for ARM architectures. Thumb instruction set provides
4825356f545SAneesh V		better code density. For ARM architectures that support
4835356f545SAneesh V		Thumb2 this flag will result in Thumb2 code generated by
4845356f545SAneesh V		GCC.
4855356f545SAneesh V
486c5d4752cSStephen Warren		CONFIG_ARM_ERRATA_716044
4870678587fSStephen Warren		CONFIG_ARM_ERRATA_742230
4880678587fSStephen Warren		CONFIG_ARM_ERRATA_743622
4890678587fSStephen Warren		CONFIG_ARM_ERRATA_751472
4900678587fSStephen Warren
4910678587fSStephen Warren		If set, the workarounds for these ARM errata are applied early
4920678587fSStephen Warren		during U-Boot startup. Note that these options force the
4930678587fSStephen Warren		workarounds to be applied; no CPU-type/version detection
4940678587fSStephen Warren		exists, unlike the similar options in the Linux kernel. Do not
4950678587fSStephen Warren		set these options unless they apply!
4960678587fSStephen Warren
497795659dcSStephen Warren- CPU timer options:
498795659dcSStephen Warren		CONFIG_SYS_HZ
499795659dcSStephen Warren
500795659dcSStephen Warren		The frequency of the timer returned by get_timer().
501795659dcSStephen Warren		get_timer() must operate in milliseconds and this CONFIG
502795659dcSStephen Warren		option must be set to 1000.
503795659dcSStephen Warren
5045da627a4Swdenk- Linux Kernel Interface:
505c609719bSwdenk		CONFIG_CLOCKS_IN_MHZ
506c609719bSwdenk
507c609719bSwdenk		U-Boot stores all clock information in Hz
508c609719bSwdenk		internally. For binary compatibility with older Linux
509c609719bSwdenk		kernels (which expect the clocks passed in the
510c609719bSwdenk		bd_info data to be in MHz) the environment variable
511c609719bSwdenk		"clocks_in_mhz" can be defined so that U-Boot
512c609719bSwdenk		converts clock data to MHZ before passing it to the
513c609719bSwdenk		Linux kernel.
514c609719bSwdenk		When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
515c609719bSwdenk		"clocks_in_mhz=1" is automatically included in the
516c609719bSwdenk		default environment.
517c609719bSwdenk
5185da627a4Swdenk		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]
5195da627a4Swdenk
52011ccc33fSMarcel Ziswiler		When transferring memsize parameter to linux, some versions
5215da627a4Swdenk		expect it to be in bytes, others in MB.
5225da627a4Swdenk		Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
5235da627a4Swdenk
524fec6d9eeSGerald Van Baren		CONFIG_OF_LIBFDT
525f57f70aaSWolfgang Denk
526f57f70aaSWolfgang Denk		New kernel versions are expecting firmware settings to be
527213bf8c8SGerald Van Baren		passed using flattened device trees (based on open firmware
528213bf8c8SGerald Van Baren		concepts).
529213bf8c8SGerald Van Baren
530213bf8c8SGerald Van Baren		CONFIG_OF_LIBFDT
531213bf8c8SGerald Van Baren		 * New libfdt-based support
532213bf8c8SGerald Van Baren		 * Adds the "fdt" command
5333bb342fcSKim Phillips		 * The bootm command automatically updates the fdt
534213bf8c8SGerald Van Baren
535b55ae402SMarcel Ziswiler		OF_CPU - The proper name of the cpus node (only required for
536b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
537b55ae402SMarcel Ziswiler		OF_SOC - The proper name of the soc node (only required for
538b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
539f57f70aaSWolfgang Denk		OF_TBCLK - The timebase frequency.
540c2871f03SKumar Gala		OF_STDOUT_PATH - The path to the console device
541f57f70aaSWolfgang Denk
54211ccc33fSMarcel Ziswiler		boards with QUICC Engines require OF_QE to set UCC MAC
54311ccc33fSMarcel Ziswiler		addresses
5443bb342fcSKim Phillips
5454e253137SKumar Gala		CONFIG_OF_BOARD_SETUP
5464e253137SKumar Gala
5474e253137SKumar Gala		Board code has addition modification that it wants to make
5484e253137SKumar Gala		to the flat device tree before handing it off to the kernel
5496705d81eSwdenk
5500267768eSMatthew McClintock		CONFIG_OF_BOOT_CPU
5510267768eSMatthew McClintock
55211ccc33fSMarcel Ziswiler		This define fills in the correct boot CPU in the boot
5530267768eSMatthew McClintock		param header, the default value is zero if undefined.
5540267768eSMatthew McClintock
5553887c3fbSHeiko Schocher		CONFIG_OF_IDE_FIXUP
5563887c3fbSHeiko Schocher
5573887c3fbSHeiko Schocher		U-Boot can detect if an IDE device is present or not.
5583887c3fbSHeiko Schocher		If not, and this new config option is activated, U-Boot
5593887c3fbSHeiko Schocher		removes the ATA node from the DTS before booting Linux,
5603887c3fbSHeiko Schocher		so the Linux IDE driver does not probe the device and
5613887c3fbSHeiko Schocher		crash. This is needed for buggy hardware (uc101) where
5623887c3fbSHeiko Schocher		no pull down resistor is connected to the signal IDE5V_DD7.
5633887c3fbSHeiko Schocher
5647eb29398SIgor Grinberg		CONFIG_MACH_TYPE	[relevant for ARM only][mandatory]
5657eb29398SIgor Grinberg
5667eb29398SIgor Grinberg		This setting is mandatory for all boards that have only one
5677eb29398SIgor Grinberg		machine type and must be used to specify the machine type
5687eb29398SIgor Grinberg		number as it appears in the ARM machine registry
5697eb29398SIgor Grinberg		(see http://www.arm.linux.org.uk/developer/machines/).
5707eb29398SIgor Grinberg		Only boards that have multiple machine types supported
5717eb29398SIgor Grinberg		in a single configuration file and the machine type is
5727eb29398SIgor Grinberg		runtime discoverable, do not have to use this setting.
5737eb29398SIgor Grinberg
5740b2f4ecaSNiklaus Giger- vxWorks boot parameters:
5750b2f4ecaSNiklaus Giger
5760b2f4ecaSNiklaus Giger		bootvx constructs a valid bootline using the following
5770b2f4ecaSNiklaus Giger		environments variables: bootfile, ipaddr, serverip, hostname.
5780b2f4ecaSNiklaus Giger		It loads the vxWorks image pointed bootfile.
5790b2f4ecaSNiklaus Giger
5800b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
5810b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
5820b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
5830b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
5840b2f4ecaSNiklaus Giger
5850b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_ADD_PARAMS
5860b2f4ecaSNiklaus Giger
5870b2f4ecaSNiklaus Giger		Add it at the end of the bootline. E.g "u=username pw=secret"
5880b2f4ecaSNiklaus Giger
5890b2f4ecaSNiklaus Giger		Note: If a "bootargs" environment is defined, it will overwride
5900b2f4ecaSNiklaus Giger		the defaults discussed just above.
5910b2f4ecaSNiklaus Giger
5922c451f78SAneesh V- Cache Configuration:
5932c451f78SAneesh V		CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
5942c451f78SAneesh V		CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
5952c451f78SAneesh V		CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
5962c451f78SAneesh V
59793bc2193SAneesh V- Cache Configuration for ARM:
59893bc2193SAneesh V		CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
59993bc2193SAneesh V				      controller
60093bc2193SAneesh V		CONFIG_SYS_PL310_BASE - Physical base address of PL310
60193bc2193SAneesh V					controller register space
60293bc2193SAneesh V
6036705d81eSwdenk- Serial Ports:
60448d0192fSAndreas Engel		CONFIG_PL010_SERIAL
6056705d81eSwdenk
6066705d81eSwdenk		Define this if you want support for Amba PrimeCell PL010 UARTs.
6076705d81eSwdenk
60848d0192fSAndreas Engel		CONFIG_PL011_SERIAL
6096705d81eSwdenk
6106705d81eSwdenk		Define this if you want support for Amba PrimeCell PL011 UARTs.
6116705d81eSwdenk
6126705d81eSwdenk		CONFIG_PL011_CLOCK
6136705d81eSwdenk
6146705d81eSwdenk		If you have Amba PrimeCell PL011 UARTs, set this variable to
6156705d81eSwdenk		the clock speed of the UARTs.
6166705d81eSwdenk
6176705d81eSwdenk		CONFIG_PL01x_PORTS
6186705d81eSwdenk
6196705d81eSwdenk		If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
6206705d81eSwdenk		define this to a list of base addresses for each (supported)
6216705d81eSwdenk		port. See e.g. include/configs/versatile.h
6226705d81eSwdenk
623910f1ae3SJohn Rigby		CONFIG_PL011_SERIAL_RLCR
624910f1ae3SJohn Rigby
625910f1ae3SJohn Rigby		Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
626910f1ae3SJohn Rigby		have separate receive and transmit line control registers.  Set
627910f1ae3SJohn Rigby		this variable to initialize the extra register.
628910f1ae3SJohn Rigby
629910f1ae3SJohn Rigby		CONFIG_PL011_SERIAL_FLUSH_ON_INIT
630910f1ae3SJohn Rigby
631910f1ae3SJohn Rigby		On some platforms (e.g. U8500) U-Boot is loaded by a second stage
632910f1ae3SJohn Rigby		boot loader that has already initialized the UART.  Define this
633910f1ae3SJohn Rigby		variable to flush the UART at init time.
634910f1ae3SJohn Rigby
6356705d81eSwdenk
636c609719bSwdenk- Console Interface:
637c609719bSwdenk		Depending on board, define exactly one serial port
638c609719bSwdenk		(like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
639c609719bSwdenk		CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
640c609719bSwdenk		console by defining CONFIG_8xx_CONS_NONE
641c609719bSwdenk
642c609719bSwdenk		Note: if CONFIG_8xx_CONS_NONE is defined, the serial
643c609719bSwdenk		port routines must be defined elsewhere
644c609719bSwdenk		(i.e. serial_init(), serial_getc(), ...)
645c609719bSwdenk
646c609719bSwdenk		CONFIG_CFB_CONSOLE
647c609719bSwdenk		Enables console device for a color framebuffer. Needs following
648c53043b7SWolfgang Denk		defines (cf. smiLynxEM, i8042)
649c609719bSwdenk			VIDEO_FB_LITTLE_ENDIAN	graphic memory organisation
650c609719bSwdenk						(default big endian)
651c609719bSwdenk			VIDEO_HW_RECTFILL	graphic chip supports
652c609719bSwdenk						rectangle fill
653c609719bSwdenk						(cf. smiLynxEM)
654c609719bSwdenk			VIDEO_HW_BITBLT		graphic chip supports
655c609719bSwdenk						bit-blit (cf. smiLynxEM)
656c609719bSwdenk			VIDEO_VISIBLE_COLS	visible pixel columns
657c609719bSwdenk						(cols=pitch)
658c609719bSwdenk			VIDEO_VISIBLE_ROWS	visible pixel rows
659c609719bSwdenk			VIDEO_PIXEL_SIZE	bytes per pixel
660c609719bSwdenk			VIDEO_DATA_FORMAT	graphic data format
661c609719bSwdenk						(0-5, cf. cfb_console.c)
662c609719bSwdenk			VIDEO_FB_ADRS		framebuffer address
663c609719bSwdenk			VIDEO_KBD_INIT_FCT	keyboard int fct
664c609719bSwdenk						(i.e. i8042_kbd_init())
665c609719bSwdenk			VIDEO_TSTC_FCT		test char fct
666c609719bSwdenk						(i.e. i8042_tstc)
667c609719bSwdenk			VIDEO_GETC_FCT		get char fct
668c609719bSwdenk						(i.e. i8042_getc)
669c609719bSwdenk			CONFIG_CONSOLE_CURSOR	cursor drawing on/off
670c609719bSwdenk						(requires blink timer
671c609719bSwdenk						cf. i8042.c)
6726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
673c609719bSwdenk			CONFIG_CONSOLE_TIME	display time/date info in
674c609719bSwdenk						upper right corner
675602ad3b3SJon Loeliger						(requires CONFIG_CMD_DATE)
676c609719bSwdenk			CONFIG_VIDEO_LOGO	display Linux logo in
677c609719bSwdenk						upper left corner
678a6c7ad2fSwdenk			CONFIG_VIDEO_BMP_LOGO	use bmp_logo.h instead of
679a6c7ad2fSwdenk						linux_logo.h for logo.
680a6c7ad2fSwdenk						Requires CONFIG_VIDEO_LOGO
681c609719bSwdenk			CONFIG_CONSOLE_EXTRA_INFO
68211ccc33fSMarcel Ziswiler						additional board info beside
683c609719bSwdenk						the logo
684c609719bSwdenk
68533a35bbbSPali Rohár		When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
68633a35bbbSPali Rohár		a limited number of ANSI escape sequences (cursor control,
68733a35bbbSPali Rohár		erase functions and limited graphics rendition control).
68833a35bbbSPali Rohár
689c609719bSwdenk		When CONFIG_CFB_CONSOLE is defined, video console is
690c609719bSwdenk		default i/o. Serial console can be forced with
691c609719bSwdenk		environment 'console=serial'.
692c609719bSwdenk
693a3ad8e26Swdenk		When CONFIG_SILENT_CONSOLE is defined, all console
694a3ad8e26Swdenk		messages (by U-Boot and Linux!) can be silenced with
695a3ad8e26Swdenk		the "silent" environment variable. See
696a3ad8e26Swdenk		doc/README.silent for more information.
697a3ad8e26Swdenk
698c609719bSwdenk- Console Baudrate:
699c609719bSwdenk		CONFIG_BAUDRATE - in bps
700c609719bSwdenk		Select one of the baudrates listed in
7016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
7026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
703c609719bSwdenk
704c92fac91SHeiko Schocher- Console Rx buffer length
705c92fac91SHeiko Schocher		With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
706c92fac91SHeiko Schocher		the maximum receive buffer length for the SMC.
7072b3f12c2SHeiko Schocher		This option is actual only for 82xx and 8xx possible.
708c92fac91SHeiko Schocher		If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
709c92fac91SHeiko Schocher		must be defined, to setup the maximum idle timeout for
710c92fac91SHeiko Schocher		the SMC.
711c92fac91SHeiko Schocher
7129558b48aSGraeme Russ- Pre-Console Buffer:
7139558b48aSGraeme Russ		Prior to the console being initialised (i.e. serial UART
7149558b48aSGraeme Russ		initialised etc) all console output is silently discarded.
7159558b48aSGraeme Russ		Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
7169558b48aSGraeme Russ		buffer any console messages prior to the console being
7179558b48aSGraeme Russ		initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
7189558b48aSGraeme Russ		bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
7199558b48aSGraeme Russ		a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
7209558b48aSGraeme Russ		bytes are output before the console is initialised, the
7219558b48aSGraeme Russ		earlier bytes are discarded.
7229558b48aSGraeme Russ
7239558b48aSGraeme Russ		'Sane' compilers will generate smaller code if
7249558b48aSGraeme Russ		CONFIG_PRE_CON_BUF_SZ is a power of 2
7259558b48aSGraeme Russ
726046a37bdSSonny Rao- Safe printf() functions
727046a37bdSSonny Rao		Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
728046a37bdSSonny Rao		the printf() functions. These are defined in
729046a37bdSSonny Rao		include/vsprintf.h and include snprintf(), vsnprintf() and
730046a37bdSSonny Rao		so on. Code size increase is approximately 300-500 bytes.
731046a37bdSSonny Rao		If this option is not given then these functions will
732046a37bdSSonny Rao		silently discard their buffer size argument - this means
733046a37bdSSonny Rao		you are not getting any overflow checking in this case.
734046a37bdSSonny Rao
735c609719bSwdenk- Boot Delay:	CONFIG_BOOTDELAY - in seconds
736c609719bSwdenk		Delay before automatically booting the default image;
737c609719bSwdenk		set to -1 to disable autoboot.
73893d7212fSJoe Hershberger		set to -2 to autoboot with no delay and not check for abort
73993d7212fSJoe Hershberger		(even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
740c609719bSwdenk
741c609719bSwdenk		See doc/README.autoboot for these options that
742c609719bSwdenk		work with CONFIG_BOOTDELAY. None are required.
743c609719bSwdenk		CONFIG_BOOT_RETRY_TIME
744c609719bSwdenk		CONFIG_BOOT_RETRY_MIN
745c609719bSwdenk		CONFIG_AUTOBOOT_KEYED
746c609719bSwdenk		CONFIG_AUTOBOOT_PROMPT
747c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR
748c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR
749c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR2
750c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR2
751c609719bSwdenk		CONFIG_ZERO_BOOTDELAY_CHECK
752c609719bSwdenk		CONFIG_RESET_TO_RETRY
753c609719bSwdenk
754c609719bSwdenk- Autoboot Command:
755c609719bSwdenk		CONFIG_BOOTCOMMAND
756c609719bSwdenk		Only needed when CONFIG_BOOTDELAY is enabled;
757c609719bSwdenk		define a command string that is automatically executed
758c609719bSwdenk		when no character is read on the console interface
759c609719bSwdenk		within "Boot Delay" after reset.
760c609719bSwdenk
761c609719bSwdenk		CONFIG_BOOTARGS
762c609719bSwdenk		This can be used to pass arguments to the bootm
763c609719bSwdenk		command. The value of CONFIG_BOOTARGS goes into the
764c609719bSwdenk		environment value "bootargs".
765c609719bSwdenk
766c609719bSwdenk		CONFIG_RAMBOOT and CONFIG_NFSBOOT
767c609719bSwdenk		The value of these goes into the environment as
768c609719bSwdenk		"ramboot" and "nfsboot" respectively, and can be used
769c609719bSwdenk		as a convenience, when switching between booting from
77011ccc33fSMarcel Ziswiler		RAM and NFS.
771c609719bSwdenk
772c609719bSwdenk- Pre-Boot Commands:
773c609719bSwdenk		CONFIG_PREBOOT
774c609719bSwdenk
775c609719bSwdenk		When this option is #defined, the existence of the
776c609719bSwdenk		environment variable "preboot" will be checked
777c609719bSwdenk		immediately before starting the CONFIG_BOOTDELAY
778c609719bSwdenk		countdown and/or running the auto-boot command resp.
779c609719bSwdenk		entering interactive mode.
780c609719bSwdenk
781c609719bSwdenk		This feature is especially useful when "preboot" is
782c609719bSwdenk		automatically generated or modified. For an example
783c609719bSwdenk		see the LWMON board specific code: here "preboot" is
784c609719bSwdenk		modified when the user holds down a certain
785c609719bSwdenk		combination of keys on the (special) keyboard when
786c609719bSwdenk		booting the systems
787c609719bSwdenk
788c609719bSwdenk- Serial Download Echo Mode:
789c609719bSwdenk		CONFIG_LOADS_ECHO
790c609719bSwdenk		If defined to 1, all characters received during a
791c609719bSwdenk		serial download (using the "loads" command) are
792c609719bSwdenk		echoed back. This might be needed by some terminal
793c609719bSwdenk		emulations (like "cu"), but may as well just take
794c609719bSwdenk		time on others. This setting #define's the initial
795c609719bSwdenk		value of the "loads_echo" environment variable.
796c609719bSwdenk
797602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
798c609719bSwdenk		CONFIG_KGDB_BAUDRATE
799c609719bSwdenk		Select one of the baudrates listed in
8006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
801c609719bSwdenk
802c609719bSwdenk- Monitor Functions:
803602ad3b3SJon Loeliger		Monitor commands can be included or excluded
804602ad3b3SJon Loeliger		from the build by using the #include files
805c6c621bdSStephen Warren		<config_cmd_all.h> and #undef'ing unwanted
806c6c621bdSStephen Warren		commands, or using <config_cmd_default.h>
807602ad3b3SJon Loeliger		and augmenting with additional #define's
808602ad3b3SJon Loeliger		for wanted commands.
809c609719bSwdenk
810602ad3b3SJon Loeliger		The default command configuration includes all commands
811602ad3b3SJon Loeliger		except those marked below with a "*".
812602ad3b3SJon Loeliger
813602ad3b3SJon Loeliger		CONFIG_CMD_ASKENV	* ask for env variable
814602ad3b3SJon Loeliger		CONFIG_CMD_BDI		  bdinfo
815602ad3b3SJon Loeliger		CONFIG_CMD_BEDBUG	* Include BedBug Debugger
816602ad3b3SJon Loeliger		CONFIG_CMD_BMP		* BMP support
817602ad3b3SJon Loeliger		CONFIG_CMD_BSP		* Board specific commands
818602ad3b3SJon Loeliger		CONFIG_CMD_BOOTD	  bootd
819602ad3b3SJon Loeliger		CONFIG_CMD_CACHE	* icache, dcache
820602ad3b3SJon Loeliger		CONFIG_CMD_CONSOLE	  coninfo
821710b9938SMike Frysinger		CONFIG_CMD_CRC32	* crc32
822602ad3b3SJon Loeliger		CONFIG_CMD_DATE		* support for RTC, date/time...
823602ad3b3SJon Loeliger		CONFIG_CMD_DHCP		* DHCP support
824602ad3b3SJon Loeliger		CONFIG_CMD_DIAG		* Diagnostics
825a7c93104SPeter Tyser		CONFIG_CMD_DS4510	* ds4510 I2C gpio commands
826a7c93104SPeter Tyser		CONFIG_CMD_DS4510_INFO	* ds4510 I2C info command
827a7c93104SPeter Tyser		CONFIG_CMD_DS4510_MEM	* ds4510 I2C eeprom/sram commansd
828a7c93104SPeter Tyser		CONFIG_CMD_DS4510_RST	* ds4510 I2C rst command
829602ad3b3SJon Loeliger		CONFIG_CMD_DTT		* Digital Therm and Thermostat
830602ad3b3SJon Loeliger		CONFIG_CMD_ECHO		  echo arguments
831246c6922SPeter Tyser		CONFIG_CMD_EDITENV	  edit env variable
832602ad3b3SJon Loeliger		CONFIG_CMD_EEPROM	* EEPROM read/write support
833602ad3b3SJon Loeliger		CONFIG_CMD_ELF		* bootelf, bootvx
8345e2b3e0cSJoe Hershberger		CONFIG_CMD_ENV_CALLBACK	* display details about env callbacks
835fffad71bSJoe Hershberger		CONFIG_CMD_ENV_FLAGS	* display details about env flags
8360c79cda0SMike Frysinger		CONFIG_CMD_EXPORTENV	* export the environment
83703e2ecf6SStephen Warren		CONFIG_CMD_EXT2		* ext2 command support
83803e2ecf6SStephen Warren		CONFIG_CMD_EXT4		* ext4 command support
839bdab39d3SMike Frysinger		CONFIG_CMD_SAVEENV	  saveenv
840602ad3b3SJon Loeliger		CONFIG_CMD_FDC		* Floppy Disk Support
84103e2ecf6SStephen Warren		CONFIG_CMD_FAT		* FAT command support
842602ad3b3SJon Loeliger		CONFIG_CMD_FDOS		* Dos diskette Support
843602ad3b3SJon Loeliger		CONFIG_CMD_FLASH	  flinfo, erase, protect
844602ad3b3SJon Loeliger		CONFIG_CMD_FPGA		  FPGA device initialization support
8454d98b5c8SVincent Stehlé		CONFIG_CMD_FUSE		* Device fuse support
84653fdc7efSAnton Staaf		CONFIG_CMD_GETTIME	* Get time since boot
847a641b979SMike Frysinger		CONFIG_CMD_GO		* the 'go' command (exec code)
848a000b795SKim Phillips		CONFIG_CMD_GREPENV	* search environment
849bf36c5d5SSimon Glass		CONFIG_CMD_HASH		* calculate hash / digest
850602ad3b3SJon Loeliger		CONFIG_CMD_HWFLOW	* RTS/CTS hw flow control
851602ad3b3SJon Loeliger		CONFIG_CMD_I2C		* I2C serial bus support
852602ad3b3SJon Loeliger		CONFIG_CMD_IDE		* IDE harddisk support
853602ad3b3SJon Loeliger		CONFIG_CMD_IMI		  iminfo
8548fdf1e0fSVipin Kumar		CONFIG_CMD_IMLS		  List all images found in NOR flash
8554d98b5c8SVincent Stehlé		CONFIG_CMD_IMLS_NAND	* List all images found in NAND flash
856602ad3b3SJon Loeliger		CONFIG_CMD_IMMAP	* IMMR dump support
8570c79cda0SMike Frysinger		CONFIG_CMD_IMPORTENV	* import an environment
858c167cc02SJoe Hershberger		CONFIG_CMD_INI		* import data from an ini file into the env
859602ad3b3SJon Loeliger		CONFIG_CMD_IRQ		* irqinfo
860602ad3b3SJon Loeliger		CONFIG_CMD_ITEST	  Integer/string test of 2 values
861602ad3b3SJon Loeliger		CONFIG_CMD_JFFS2	* JFFS2 Support
862602ad3b3SJon Loeliger		CONFIG_CMD_KGDB		* kgdb
8634d98b5c8SVincent Stehlé		CONFIG_CMD_LDRINFO	* ldrinfo (display Blackfin loader)
864d22c338eSJoe Hershberger		CONFIG_CMD_LINK_LOCAL	* link-local IP address auto-configuration
865d22c338eSJoe Hershberger					  (169.254.*.*)
866602ad3b3SJon Loeliger		CONFIG_CMD_LOADB	  loadb
867602ad3b3SJon Loeliger		CONFIG_CMD_LOADS	  loads
8684d98b5c8SVincent Stehlé		CONFIG_CMD_MD5SUM	* print md5 message digest
86902c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
87015a33e49SSimon Glass		CONFIG_CMD_MEMINFO	* Display detailed memory information
871602ad3b3SJon Loeliger		CONFIG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
872a2681707SWolfgang Denk					  loop, loopw
8734d98b5c8SVincent Stehlé		CONFIG_CMD_MEMTEST	* mtest
874602ad3b3SJon Loeliger		CONFIG_CMD_MISC		  Misc functions like sleep etc
875602ad3b3SJon Loeliger		CONFIG_CMD_MMC		* MMC memory mapped support
876602ad3b3SJon Loeliger		CONFIG_CMD_MII		* MII utility commands
87768d7d651SStefan Roese		CONFIG_CMD_MTDPARTS	* MTD partition support
878602ad3b3SJon Loeliger		CONFIG_CMD_NAND		* NAND support
879602ad3b3SJon Loeliger		CONFIG_CMD_NET		  bootp, tftpboot, rarpboot
8804d98b5c8SVincent Stehlé		CONFIG_CMD_NFS		  NFS support
881e92739d3SPeter Tyser		CONFIG_CMD_PCA953X	* PCA953x I2C gpio commands
882e92739d3SPeter Tyser		CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
883602ad3b3SJon Loeliger		CONFIG_CMD_PCI		* pciinfo
884602ad3b3SJon Loeliger		CONFIG_CMD_PCMCIA		* PCMCIA support
885602ad3b3SJon Loeliger		CONFIG_CMD_PING		* send ICMP ECHO_REQUEST to network
886602ad3b3SJon Loeliger					  host
887602ad3b3SJon Loeliger		CONFIG_CMD_PORTIO	* Port I/O
888ff048ea9SKenneth Waters		CONFIG_CMD_READ		* Read raw data from partition
889602ad3b3SJon Loeliger		CONFIG_CMD_REGINFO	* Register dump
890602ad3b3SJon Loeliger		CONFIG_CMD_RUN		  run command in env variable
891d304931fSSimon Glass		CONFIG_CMD_SANDBOX	* sb command to access sandbox features
892602ad3b3SJon Loeliger		CONFIG_CMD_SAVES	* save S record dump
893602ad3b3SJon Loeliger		CONFIG_CMD_SCSI		* SCSI Support
894602ad3b3SJon Loeliger		CONFIG_CMD_SDRAM	* print SDRAM configuration information
895602ad3b3SJon Loeliger					  (requires CONFIG_CMD_I2C)
896602ad3b3SJon Loeliger		CONFIG_CMD_SETGETDCR	  Support for DCR Register access
897602ad3b3SJon Loeliger					  (4xx only)
898f61ec45eSEric Nelson		CONFIG_CMD_SF		* Read/write/erase SPI NOR flash
8994d98b5c8SVincent Stehlé		CONFIG_CMD_SHA1SUM	* print sha1 memory digest
90002c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY)
9017d861d95SBob Liu		CONFIG_CMD_SOFTSWITCH	* Soft switch setting command for BF60x
90274de7aefSWolfgang Denk		CONFIG_CMD_SOURCE	  "source" command Support
903602ad3b3SJon Loeliger		CONFIG_CMD_SPI		* SPI serial bus support
9047a83af07SLuca Ceresoli		CONFIG_CMD_TFTPSRV	* TFTP transfer in server mode
9051fb7cd49SSimon Glass		CONFIG_CMD_TFTPPUT	* TFTP put command (upload)
906da83bcd7SJoe Hershberger		CONFIG_CMD_TIME		* run command and report execution time (ARM specific)
907da83bcd7SJoe Hershberger		CONFIG_CMD_TIMER	* access to the system tick timer
908602ad3b3SJon Loeliger		CONFIG_CMD_USB		* USB support
909602ad3b3SJon Loeliger		CONFIG_CMD_CDP		* Cisco Discover Protocol support
910c8339f51SMarek Vasut		CONFIG_CMD_MFSL		* Microblaze FSL support
9114d98b5c8SVincent Stehlé		CONFIG_CMD_XIMG		  Load part of Multi Image
912c609719bSwdenk
913c609719bSwdenk
914c609719bSwdenk		EXAMPLE: If you want all functions except of network
915c609719bSwdenk		support you can write:
916c609719bSwdenk
917602ad3b3SJon Loeliger		#include "config_cmd_all.h"
918602ad3b3SJon Loeliger		#undef CONFIG_CMD_NET
919c609719bSwdenk
920213bf8c8SGerald Van Baren	Other Commands:
921213bf8c8SGerald Van Baren		fdt (flattened device tree) command: CONFIG_OF_LIBFDT
922c609719bSwdenk
923c609719bSwdenk	Note:	Don't enable the "icache" and "dcache" commands
924602ad3b3SJon Loeliger		(configuration option CONFIG_CMD_CACHE) unless you know
925c609719bSwdenk		what you (and your U-Boot users) are doing. Data
926c609719bSwdenk		cache cannot be enabled on systems like the 8xx or
927c609719bSwdenk		8260 (where accesses to the IMMR region must be
928c609719bSwdenk		uncached), and it cannot be disabled on all other
929c609719bSwdenk		systems where we (mis-) use the data cache to hold an
930c609719bSwdenk		initial stack and some data.
931c609719bSwdenk
932c609719bSwdenk
933c609719bSwdenk		XXX - this list needs to get updated!
934c609719bSwdenk
935a5ecbe62SWolfgang Denk- Regular expression support:
936a5ecbe62SWolfgang Denk		CONFIG_REGEX
937a5ecbe62SWolfgang Denk                If this variable is defined, U-Boot is linked against
938a5ecbe62SWolfgang Denk                the SLRE (Super Light Regular Expression) library,
939a5ecbe62SWolfgang Denk                which adds regex support to some commands, as for
940a5ecbe62SWolfgang Denk                example "env grep" and "setexpr".
941a5ecbe62SWolfgang Denk
94245ba8077SSimon Glass- Device tree:
94345ba8077SSimon Glass		CONFIG_OF_CONTROL
94445ba8077SSimon Glass		If this variable is defined, U-Boot will use a device tree
94545ba8077SSimon Glass		to configure its devices, instead of relying on statically
94645ba8077SSimon Glass		compiled #defines in the board file. This option is
94745ba8077SSimon Glass		experimental and only available on a few boards. The device
94845ba8077SSimon Glass		tree is available in the global data as gd->fdt_blob.
94945ba8077SSimon Glass
9502c0f79e4SSimon Glass		U-Boot needs to get its device tree from somewhere. This can
9512c0f79e4SSimon Glass		be done using one of the two options below:
952bbb0b128SSimon Glass
953bbb0b128SSimon Glass		CONFIG_OF_EMBED
954bbb0b128SSimon Glass		If this variable is defined, U-Boot will embed a device tree
955bbb0b128SSimon Glass		binary in its image. This device tree file should be in the
956bbb0b128SSimon Glass		board directory and called <soc>-<board>.dts. The binary file
957bbb0b128SSimon Glass		is then picked up in board_init_f() and made available through
958bbb0b128SSimon Glass		the global data structure as gd->blob.
95945ba8077SSimon Glass
9602c0f79e4SSimon Glass		CONFIG_OF_SEPARATE
9612c0f79e4SSimon Glass		If this variable is defined, U-Boot will build a device tree
9622c0f79e4SSimon Glass		binary. It will be called u-boot.dtb. Architecture-specific
9632c0f79e4SSimon Glass		code will locate it at run-time. Generally this works by:
9642c0f79e4SSimon Glass
9652c0f79e4SSimon Glass			cat u-boot.bin u-boot.dtb >image.bin
9662c0f79e4SSimon Glass
9672c0f79e4SSimon Glass		and in fact, U-Boot does this for you, creating a file called
9682c0f79e4SSimon Glass		u-boot-dtb.bin which is useful in the common case. You can
9692c0f79e4SSimon Glass		still use the individual files if you need something more
9702c0f79e4SSimon Glass		exotic.
9712c0f79e4SSimon Glass
972c609719bSwdenk- Watchdog:
973c609719bSwdenk		CONFIG_WATCHDOG
974c609719bSwdenk		If this variable is defined, it enables watchdog
9756abe6fb6SDetlev Zundel		support for the SoC. There must be support in the SoC
9766abe6fb6SDetlev Zundel		specific code for a watchdog. For the 8xx and 8260
9776abe6fb6SDetlev Zundel		CPUs, the SIU Watchdog feature is enabled in the SYPCR
9786abe6fb6SDetlev Zundel		register.  When supported for a specific SoC is
9796abe6fb6SDetlev Zundel		available, then no further board specific code should
9806abe6fb6SDetlev Zundel		be needed to use it.
9816abe6fb6SDetlev Zundel
9826abe6fb6SDetlev Zundel		CONFIG_HW_WATCHDOG
9836abe6fb6SDetlev Zundel		When using a watchdog circuitry external to the used
9846abe6fb6SDetlev Zundel		SoC, then define this variable and provide board
9856abe6fb6SDetlev Zundel		specific code for the "hw_watchdog_reset" function.
986c609719bSwdenk
987c1551ea8Sstroese- U-Boot Version:
988c1551ea8Sstroese		CONFIG_VERSION_VARIABLE
989c1551ea8Sstroese		If this variable is defined, an environment variable
990c1551ea8Sstroese		named "ver" is created by U-Boot showing the U-Boot
991c1551ea8Sstroese		version as printed by the "version" command.
992a1ea8e51SBenoît Thébaudeau		Any change to this variable will be reverted at the
993a1ea8e51SBenoît Thébaudeau		next reset.
994c1551ea8Sstroese
995c609719bSwdenk- Real-Time Clock:
996c609719bSwdenk
997602ad3b3SJon Loeliger		When CONFIG_CMD_DATE is selected, the type of the RTC
998c609719bSwdenk		has to be selected, too. Define exactly one of the
999c609719bSwdenk		following options:
1000c609719bSwdenk
1001c609719bSwdenk		CONFIG_RTC_MPC8xx	- use internal RTC of MPC8xx
1002c609719bSwdenk		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
10034e8b7544SFabio Estevam		CONFIG_RTC_MC13XXX	- use MC13783 or MC13892 RTC
1004c609719bSwdenk		CONFIG_RTC_MC146818	- use MC146818 RTC
10051cb8e980Swdenk		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
1006c609719bSwdenk		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
10077f70e853Swdenk		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
10083bac3513Swdenk		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
10099536dfccSTor Krill		CONFIG_RTC_ISL1208	- use Intersil ISL1208 RTC
10104c0d4c3bSwdenk		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
10116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_DS1337_NOOSC	- Turn off the OSC output for DS1337
101271d19f30SHeiko Schocher		CONFIG_SYS_RV3029_TCR	- enable trickle charger on
101371d19f30SHeiko Schocher					  RV3029 RTC.
1014c609719bSwdenk
1015b37c7e5eSwdenk		Note that if the RTC uses I2C, then the I2C interface
1016b37c7e5eSwdenk		must also be configured. See I2C Support, below.
1017b37c7e5eSwdenk
1018e92739d3SPeter Tyser- GPIO Support:
1019e92739d3SPeter Tyser		CONFIG_PCA953X		- use NXP's PCA953X series I2C GPIO
1020e92739d3SPeter Tyser		CONFIG_PCA953X_INFO	- enable pca953x info command
1021e92739d3SPeter Tyser
10225dec49caSChris Packham		The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
10235dec49caSChris Packham		chip-ngpio pairs that tell the PCA953X driver the number of
10245dec49caSChris Packham		pins supported by a particular chip.
10255dec49caSChris Packham
1026e92739d3SPeter Tyser		Note that if the GPIO device uses I2C, then the I2C interface
1027e92739d3SPeter Tyser		must also be configured. See I2C Support, below.
1028e92739d3SPeter Tyser
1029c609719bSwdenk- Timestamp Support:
1030c609719bSwdenk
1031c609719bSwdenk		When CONFIG_TIMESTAMP is selected, the timestamp
1032c609719bSwdenk		(date and time) of an image is printed by image
1033c609719bSwdenk		commands like bootm or iminfo. This option is
1034602ad3b3SJon Loeliger		automatically enabled when you select CONFIG_CMD_DATE .
1035c609719bSwdenk
1036923c46f9SKarl O. Pinc- Partition Labels (disklabels) Supported:
1037923c46f9SKarl O. Pinc		Zero or more of the following:
1038923c46f9SKarl O. Pinc		CONFIG_MAC_PARTITION   Apple's MacOS partition table.
1039923c46f9SKarl O. Pinc		CONFIG_DOS_PARTITION   MS Dos partition table, traditional on the
1040923c46f9SKarl O. Pinc				       Intel architecture, USB sticks, etc.
1041923c46f9SKarl O. Pinc		CONFIG_ISO_PARTITION   ISO partition table, used on CDROM etc.
1042923c46f9SKarl O. Pinc		CONFIG_EFI_PARTITION   GPT partition table, common when EFI is the
1043923c46f9SKarl O. Pinc				       bootloader.  Note 2TB partition limit; see
1044923c46f9SKarl O. Pinc				       disk/part_efi.c
1045923c46f9SKarl O. Pinc		CONFIG_MTD_PARTITIONS  Memory Technology Device partition table.
1046c609719bSwdenk
1047602ad3b3SJon Loeliger		If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1048218ca724SWolfgang Denk		CONFIG_CMD_SCSI) you must configure support for at
1049923c46f9SKarl O. Pinc		least one non-MTD partition type as well.
1050c609719bSwdenk
1051c609719bSwdenk- IDE Reset method:
10524d13cbadSwdenk		CONFIG_IDE_RESET_ROUTINE - this is defined in several
10534d13cbadSwdenk		board configurations files but used nowhere!
1054c609719bSwdenk
10554d13cbadSwdenk		CONFIG_IDE_RESET - is this is defined, IDE Reset will
10564d13cbadSwdenk		be performed by calling the function
10574d13cbadSwdenk			ide_set_reset(int reset)
10584d13cbadSwdenk		which has to be defined in a board specific file
1059c609719bSwdenk
1060c609719bSwdenk- ATAPI Support:
1061c609719bSwdenk		CONFIG_ATAPI
1062c609719bSwdenk
1063c609719bSwdenk		Set this to enable ATAPI support.
1064c609719bSwdenk
1065c40b2956Swdenk- LBA48 Support
1066c40b2956Swdenk		CONFIG_LBA48
1067c40b2956Swdenk
1068c40b2956Swdenk		Set this to enable support for disks larger than 137GB
10694b142febSHeiko Schocher		Also look at CONFIG_SYS_64BIT_LBA.
1070c40b2956Swdenk		Whithout these , LBA48 support uses 32bit variables and will 'only'
1071c40b2956Swdenk		support disks up to 2.1TB.
1072c40b2956Swdenk
10736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_64BIT_LBA:
1074c40b2956Swdenk			When enabled, makes the IDE subsystem use 64bit sector addresses.
1075c40b2956Swdenk			Default is 32bit.
1076c40b2956Swdenk
1077c609719bSwdenk- SCSI Support:
1078c609719bSwdenk		At the moment only there is only support for the
1079c609719bSwdenk		SYM53C8XX SCSI controller; define
1080c609719bSwdenk		CONFIG_SCSI_SYM53C8XX to enable it.
1081c609719bSwdenk
10826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
10836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
10846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
1085c609719bSwdenk		maximum numbers of LUNs, SCSI ID's and target
1086c609719bSwdenk		devices.
10876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
1088c609719bSwdenk
1089447c031bSStefan Reinauer                The environment variable 'scsidevs' is set to the number of
1090447c031bSStefan Reinauer                SCSI devices found during the last scan.
1091447c031bSStefan Reinauer
1092c609719bSwdenk- NETWORK Support (PCI):
1093682011ffSwdenk		CONFIG_E1000
1094ce5207e1SKyle Moffett		Support for Intel 8254x/8257x gigabit chips.
1095ce5207e1SKyle Moffett
1096ce5207e1SKyle Moffett		CONFIG_E1000_SPI
1097ce5207e1SKyle Moffett		Utility code for direct access to the SPI bus on Intel 8257x.
1098ce5207e1SKyle Moffett		This does not do anything useful unless you set at least one
1099ce5207e1SKyle Moffett		of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1100ce5207e1SKyle Moffett
1101ce5207e1SKyle Moffett		CONFIG_E1000_SPI_GENERIC
1102ce5207e1SKyle Moffett		Allow generic access to the SPI bus on the Intel 8257x, for
1103ce5207e1SKyle Moffett		example with the "sspi" command.
1104ce5207e1SKyle Moffett
1105ce5207e1SKyle Moffett		CONFIG_CMD_E1000
1106ce5207e1SKyle Moffett		Management command for E1000 devices.  When used on devices
1107ce5207e1SKyle Moffett		with SPI support you can reprogram the EEPROM from U-Boot.
1108682011ffSwdenk
1109ac3315c2SAndre Schwarz		CONFIG_E1000_FALLBACK_MAC
111011ccc33fSMarcel Ziswiler		default MAC for empty EEPROM after production.
1111ac3315c2SAndre Schwarz
1112c609719bSwdenk		CONFIG_EEPRO100
1113c609719bSwdenk		Support for Intel 82557/82559/82559ER chips.
111411ccc33fSMarcel Ziswiler		Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
1115c609719bSwdenk		write routine for first time initialisation.
1116c609719bSwdenk
1117c609719bSwdenk		CONFIG_TULIP
1118c609719bSwdenk		Support for Digital 2114x chips.
1119c609719bSwdenk		Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1120c609719bSwdenk		modem chip initialisation (KS8761/QS6611).
1121c609719bSwdenk
1122c609719bSwdenk		CONFIG_NATSEMI
1123c609719bSwdenk		Support for National dp83815 chips.
1124c609719bSwdenk
1125c609719bSwdenk		CONFIG_NS8382X
1126c609719bSwdenk		Support for National dp8382[01] gigabit chips.
1127c609719bSwdenk
112845219c46Swdenk- NETWORK Support (other):
112945219c46Swdenk
1130c041e9d2SJens Scharsig		CONFIG_DRIVER_AT91EMAC
1131c041e9d2SJens Scharsig		Support for AT91RM9200 EMAC.
1132c041e9d2SJens Scharsig
1133c041e9d2SJens Scharsig			CONFIG_RMII
1134c041e9d2SJens Scharsig			Define this to use reduced MII inteface
1135c041e9d2SJens Scharsig
1136c041e9d2SJens Scharsig			CONFIG_DRIVER_AT91EMAC_QUIET
1137c041e9d2SJens Scharsig			If this defined, the driver is quiet.
1138c041e9d2SJens Scharsig			The driver doen't show link status messages.
1139c041e9d2SJens Scharsig
1140efdd7319SRob Herring		CONFIG_CALXEDA_XGMAC
1141efdd7319SRob Herring		Support for the Calxeda XGMAC device
1142efdd7319SRob Herring
11433bb46d23SAshok		CONFIG_LAN91C96
114445219c46Swdenk		Support for SMSC's LAN91C96 chips.
114545219c46Swdenk
114645219c46Swdenk			CONFIG_LAN91C96_BASE
114745219c46Swdenk			Define this to hold the physical address
114845219c46Swdenk			of the LAN91C96's I/O space
114945219c46Swdenk
115045219c46Swdenk			CONFIG_LAN91C96_USE_32_BIT
115145219c46Swdenk			Define this to enable 32 bit addressing
115245219c46Swdenk
11533bb46d23SAshok		CONFIG_SMC91111
1154f39748aeSwdenk		Support for SMSC's LAN91C111 chip
1155f39748aeSwdenk
1156f39748aeSwdenk			CONFIG_SMC91111_BASE
1157f39748aeSwdenk			Define this to hold the physical address
1158f39748aeSwdenk			of the device (I/O space)
1159f39748aeSwdenk
1160f39748aeSwdenk			CONFIG_SMC_USE_32_BIT
1161f39748aeSwdenk			Define this if data bus is 32 bits
1162f39748aeSwdenk
1163f39748aeSwdenk			CONFIG_SMC_USE_IOFUNCS
1164f39748aeSwdenk			Define this to use i/o functions instead of macros
1165f39748aeSwdenk			(some hardware wont work with macros)
1166f39748aeSwdenk
1167dc02badaSHeiko Schocher		CONFIG_DRIVER_TI_EMAC
1168dc02badaSHeiko Schocher		Support for davinci emac
1169dc02badaSHeiko Schocher
1170dc02badaSHeiko Schocher			CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1171dc02badaSHeiko Schocher			Define this if you have more then 3 PHYs.
1172dc02badaSHeiko Schocher
1173b3dbf4a5SMacpaul Lin		CONFIG_FTGMAC100
1174b3dbf4a5SMacpaul Lin		Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1175b3dbf4a5SMacpaul Lin
1176b3dbf4a5SMacpaul Lin			CONFIG_FTGMAC100_EGIGA
1177b3dbf4a5SMacpaul Lin			Define this to use GE link update with gigabit PHY.
1178b3dbf4a5SMacpaul Lin			Define this if FTGMAC100 is connected to gigabit PHY.
1179b3dbf4a5SMacpaul Lin			If your system has 10/100 PHY only, it might not occur
1180b3dbf4a5SMacpaul Lin			wrong behavior. Because PHY usually return timeout or
1181b3dbf4a5SMacpaul Lin			useless data when polling gigabit status and gigabit
1182b3dbf4a5SMacpaul Lin			control registers. This behavior won't affect the
1183b3dbf4a5SMacpaul Lin			correctnessof 10/100 link speed update.
1184b3dbf4a5SMacpaul Lin
1185c2fff331SMike Rapoport		CONFIG_SMC911X
1186557b377dSJens Gehrlein		Support for SMSC's LAN911x and LAN921x chips
1187557b377dSJens Gehrlein
1188c2fff331SMike Rapoport			CONFIG_SMC911X_BASE
1189557b377dSJens Gehrlein			Define this to hold the physical address
1190557b377dSJens Gehrlein			of the device (I/O space)
1191557b377dSJens Gehrlein
1192c2fff331SMike Rapoport			CONFIG_SMC911X_32_BIT
1193557b377dSJens Gehrlein			Define this if data bus is 32 bits
1194557b377dSJens Gehrlein
1195c2fff331SMike Rapoport			CONFIG_SMC911X_16_BIT
1196557b377dSJens Gehrlein			Define this if data bus is 16 bits. If your processor
1197557b377dSJens Gehrlein			automatically converts one 32 bit word to two 16 bit
1198c2fff331SMike Rapoport			words you may also try CONFIG_SMC911X_32_BIT.
1199557b377dSJens Gehrlein
12003d0075faSYoshihiro Shimoda		CONFIG_SH_ETHER
12013d0075faSYoshihiro Shimoda		Support for Renesas on-chip Ethernet controller
12023d0075faSYoshihiro Shimoda
12033d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_USE_PORT
12043d0075faSYoshihiro Shimoda			Define the number of ports to be used
12053d0075faSYoshihiro Shimoda
12063d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_PHY_ADDR
12073d0075faSYoshihiro Shimoda			Define the ETH PHY's address
12083d0075faSYoshihiro Shimoda
120968260aabSYoshihiro Shimoda			CONFIG_SH_ETHER_CACHE_WRITEBACK
121068260aabSYoshihiro Shimoda			If this option is set, the driver enables cache flush.
121168260aabSYoshihiro Shimoda
12125e124724SVadim Bendebury- TPM Support:
121390899cc0SChe-liang Chiou		CONFIG_TPM
121490899cc0SChe-liang Chiou		Support TPM devices.
121590899cc0SChe-liang Chiou
12161b393db5STom Wai-Hong Tam		CONFIG_TPM_TIS_I2C
12171b393db5STom Wai-Hong Tam		Support for i2c bus TPM devices. Only one device
12181b393db5STom Wai-Hong Tam		per system is supported at this time.
12191b393db5STom Wai-Hong Tam
12201b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_BUS_NUMBER
12211b393db5STom Wai-Hong Tam			Define the the i2c bus number for the TPM device
12221b393db5STom Wai-Hong Tam
12231b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS
12241b393db5STom Wai-Hong Tam			Define the TPM's address on the i2c bus
12251b393db5STom Wai-Hong Tam
12261b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_BURST_LIMITATION
12271b393db5STom Wai-Hong Tam			Define the burst count bytes upper limit
12281b393db5STom Wai-Hong Tam
1229c01939c7SDirk Eibach		CONFIG_TPM_ATMEL_TWI
1230c01939c7SDirk Eibach		Support for Atmel TWI TPM device. Requires I2C support.
1231c01939c7SDirk Eibach
123290899cc0SChe-liang Chiou		CONFIG_TPM_TIS_LPC
12335e124724SVadim Bendebury		Support for generic parallel port TPM devices. Only one device
12345e124724SVadim Bendebury		per system is supported at this time.
12355e124724SVadim Bendebury
12365e124724SVadim Bendebury			CONFIG_TPM_TIS_BASE_ADDRESS
12375e124724SVadim Bendebury			Base address where the generic TPM device is mapped
12385e124724SVadim Bendebury			to. Contemporary x86 systems usually map it at
12395e124724SVadim Bendebury			0xfed40000.
12405e124724SVadim Bendebury
1241be6c1529SReinhard Pfau		CONFIG_CMD_TPM
1242be6c1529SReinhard Pfau		Add tpm monitor functions.
1243be6c1529SReinhard Pfau		Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1244be6c1529SReinhard Pfau		provides monitor access to authorized functions.
1245be6c1529SReinhard Pfau
1246be6c1529SReinhard Pfau		CONFIG_TPM
1247be6c1529SReinhard Pfau		Define this to enable the TPM support library which provides
1248be6c1529SReinhard Pfau		functional interfaces to some TPM commands.
1249be6c1529SReinhard Pfau		Requires support for a TPM device.
1250be6c1529SReinhard Pfau
1251be6c1529SReinhard Pfau		CONFIG_TPM_AUTH_SESSIONS
1252be6c1529SReinhard Pfau		Define this to enable authorized functions in the TPM library.
1253be6c1529SReinhard Pfau		Requires CONFIG_TPM and CONFIG_SHA1.
1254be6c1529SReinhard Pfau
1255c609719bSwdenk- USB Support:
1256c609719bSwdenk		At the moment only the UHCI host controller is
12574d13cbadSwdenk		supported (PIP405, MIP405, MPC5200); define
1258c609719bSwdenk		CONFIG_USB_UHCI to enable it.
1259c609719bSwdenk		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
126030d56faeSwdenk		and define CONFIG_USB_STORAGE to enable the USB
1261c609719bSwdenk		storage devices.
1262c609719bSwdenk		Note:
1263c609719bSwdenk		Supported are USB Keyboards and USB Floppy drives
1264c609719bSwdenk		(TEAC FD-05PUB).
12654d13cbadSwdenk		MPC5200 USB requires additional defines:
12664d13cbadSwdenk			CONFIG_USB_CLOCK
12674d13cbadSwdenk				for 528 MHz Clock: 0x0001bbbb
1268307ecb6dSEric Millbrandt			CONFIG_PSC3_USB
1269307ecb6dSEric Millbrandt				for USB on PSC3
12704d13cbadSwdenk			CONFIG_USB_CONFIG
12714d13cbadSwdenk				for differential drivers: 0x00001000
12724d13cbadSwdenk				for single ended drivers: 0x00005000
1273307ecb6dSEric Millbrandt				for differential drivers on PSC3: 0x00000100
1274307ecb6dSEric Millbrandt				for single ended drivers on PSC3: 0x00004100
12756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_USB_EVENT_POLL
1276fdcfaa1bSZhang Wei				May be defined to allow interrupt polling
1277fdcfaa1bSZhang Wei				instead of using asynchronous interrupts
12784d13cbadSwdenk
12799ab4ce22SSimon Glass		CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
12809ab4ce22SSimon Glass		txfilltuning field in the EHCI controller on reset.
12819ab4ce22SSimon Glass
1282aa155058SKuo-Jung Su		CONFIG_USB_HUB_MIN_POWER_ON_DELAY defines the minimum
1283aa155058SKuo-Jung Su		interval for usb hub power-on delay.(minimum 100msec)
1284aa155058SKuo-Jung Su
128516c8d5e7SWolfgang Denk- USB Device:
128616c8d5e7SWolfgang Denk		Define the below if you wish to use the USB console.
128716c8d5e7SWolfgang Denk		Once firmware is rebuilt from a serial console issue the
128816c8d5e7SWolfgang Denk		command "setenv stdin usbtty; setenv stdout usbtty" and
128911ccc33fSMarcel Ziswiler		attach your USB cable. The Unix command "dmesg" should print
129016c8d5e7SWolfgang Denk		it has found a new device. The environment variable usbtty
129116c8d5e7SWolfgang Denk		can be set to gserial or cdc_acm to enable your device to
129216c8d5e7SWolfgang Denk		appear to a USB host as a Linux gserial device or a
129316c8d5e7SWolfgang Denk		Common Device Class Abstract Control Model serial device.
129416c8d5e7SWolfgang Denk		If you select usbtty = gserial you should be able to enumerate
129516c8d5e7SWolfgang Denk		a Linux host by
129616c8d5e7SWolfgang Denk		# modprobe usbserial vendor=0xVendorID product=0xProductID
129716c8d5e7SWolfgang Denk		else if using cdc_acm, simply setting the environment
129816c8d5e7SWolfgang Denk		variable usbtty to be cdc_acm should suffice. The following
129916c8d5e7SWolfgang Denk		might be defined in YourBoardName.h
130016c8d5e7SWolfgang Denk
130116c8d5e7SWolfgang Denk			CONFIG_USB_DEVICE
130216c8d5e7SWolfgang Denk			Define this to build a UDC device
130316c8d5e7SWolfgang Denk
130416c8d5e7SWolfgang Denk			CONFIG_USB_TTY
130516c8d5e7SWolfgang Denk			Define this to have a tty type of device available to
130616c8d5e7SWolfgang Denk			talk to the UDC device
130716c8d5e7SWolfgang Denk
1308f9da0f89SVipin KUMAR			CONFIG_USBD_HS
1309f9da0f89SVipin KUMAR			Define this to enable the high speed support for usb
1310f9da0f89SVipin KUMAR			device and usbtty. If this feature is enabled, a routine
1311f9da0f89SVipin KUMAR			int is_usbd_high_speed(void)
1312f9da0f89SVipin KUMAR			also needs to be defined by the driver to dynamically poll
1313f9da0f89SVipin KUMAR			whether the enumeration has succeded at high speed or full
1314f9da0f89SVipin KUMAR			speed.
1315f9da0f89SVipin KUMAR
13166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_IS_IN_ENV
131716c8d5e7SWolfgang Denk			Define this if you want stdin, stdout &/or stderr to
131816c8d5e7SWolfgang Denk			be set to usbtty.
131916c8d5e7SWolfgang Denk
132016c8d5e7SWolfgang Denk			mpc8xx:
13216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_EXTC_CLK 0xBLAH
132216c8d5e7SWolfgang Denk				Derive USB clock from external clock "blah"
13236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_EXTC_CLK 0x02
132416c8d5e7SWolfgang Denk
13256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_BRG_CLK 0xBLAH
132616c8d5e7SWolfgang Denk				Derive USB clock from brgclk
13276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_BRG_CLK 0x04
132816c8d5e7SWolfgang Denk
132916c8d5e7SWolfgang Denk		If you have a USB-IF assigned VendorID then you may wish to
133016c8d5e7SWolfgang Denk		define your own vendor specific values either in BoardName.h
133116c8d5e7SWolfgang Denk		or directly in usbd_vendor_info.h. If you don't define
133216c8d5e7SWolfgang Denk		CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
133316c8d5e7SWolfgang Denk		CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
133416c8d5e7SWolfgang Denk		should pretend to be a Linux device to it's target host.
133516c8d5e7SWolfgang Denk
133616c8d5e7SWolfgang Denk			CONFIG_USBD_MANUFACTURER
133716c8d5e7SWolfgang Denk			Define this string as the name of your company for
133816c8d5e7SWolfgang Denk			- CONFIG_USBD_MANUFACTURER "my company"
133916c8d5e7SWolfgang Denk
134016c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCT_NAME
134116c8d5e7SWolfgang Denk			Define this string as the name of your product
134216c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCT_NAME "acme usb device"
134316c8d5e7SWolfgang Denk
134416c8d5e7SWolfgang Denk			CONFIG_USBD_VENDORID
134516c8d5e7SWolfgang Denk			Define this as your assigned Vendor ID from the USB
134616c8d5e7SWolfgang Denk			Implementors Forum. This *must* be a genuine Vendor ID
134716c8d5e7SWolfgang Denk			to avoid polluting the USB namespace.
134816c8d5e7SWolfgang Denk			- CONFIG_USBD_VENDORID 0xFFFF
134916c8d5e7SWolfgang Denk
135016c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCTID
135116c8d5e7SWolfgang Denk			Define this as the unique Product ID
135216c8d5e7SWolfgang Denk			for your device
135316c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCTID 0xFFFF
1354c609719bSwdenk
1355d70a560fSIgor Grinberg- ULPI Layer Support:
1356d70a560fSIgor Grinberg		The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1357d70a560fSIgor Grinberg		the generic ULPI layer. The generic layer accesses the ULPI PHY
1358d70a560fSIgor Grinberg		via the platform viewport, so you need both the genric layer and
1359d70a560fSIgor Grinberg		the viewport enabled. Currently only Chipidea/ARC based
1360d70a560fSIgor Grinberg		viewport is supported.
1361d70a560fSIgor Grinberg		To enable the ULPI layer support, define CONFIG_USB_ULPI and
1362d70a560fSIgor Grinberg		CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
13636d365ea0SLucas Stach		If your ULPI phy needs a different reference clock than the
13646d365ea0SLucas Stach		standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
13656d365ea0SLucas Stach		the appropriate value in Hz.
1366c609719bSwdenk
1367c609719bSwdenk- MMC Support:
1368c609719bSwdenk		The MMC controller on the Intel PXA is supported. To
1369c609719bSwdenk		enable this define CONFIG_MMC. The MMC can be
1370c609719bSwdenk		accessed from the boot prompt by mapping the device
1371c609719bSwdenk		to physical memory similar to flash. Command line is
1372602ad3b3SJon Loeliger		enabled with CONFIG_CMD_MMC. The MMC driver also works with
1373602ad3b3SJon Loeliger		the FAT fs. This is enabled with CONFIG_CMD_FAT.
1374c609719bSwdenk
1375afb35666SYoshihiro Shimoda		CONFIG_SH_MMCIF
1376afb35666SYoshihiro Shimoda		Support for Renesas on-chip MMCIF controller
1377afb35666SYoshihiro Shimoda
1378afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_ADDR
1379afb35666SYoshihiro Shimoda			Define the base address of MMCIF registers
1380afb35666SYoshihiro Shimoda
1381afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_CLK
1382afb35666SYoshihiro Shimoda			Define the clock frequency for MMCIF
1383afb35666SYoshihiro Shimoda
1384b3ba6e94STom Rini- USB Device Firmware Update (DFU) class support:
1385b3ba6e94STom Rini		CONFIG_DFU_FUNCTION
1386b3ba6e94STom Rini		This enables the USB portion of the DFU USB class
1387b3ba6e94STom Rini
1388b3ba6e94STom Rini		CONFIG_CMD_DFU
1389b3ba6e94STom Rini		This enables the command "dfu" which is used to have
1390b3ba6e94STom Rini		U-Boot create a DFU class device via USB.  This command
1391b3ba6e94STom Rini		requires that the "dfu_alt_info" environment variable be
1392b3ba6e94STom Rini		set and define the alt settings to expose to the host.
1393b3ba6e94STom Rini
1394b3ba6e94STom Rini		CONFIG_DFU_MMC
1395b3ba6e94STom Rini		This enables support for exposing (e)MMC devices via DFU.
1396b3ba6e94STom Rini
1397c6631764SPantelis Antoniou		CONFIG_DFU_NAND
1398c6631764SPantelis Antoniou		This enables support for exposing NAND devices via DFU.
1399c6631764SPantelis Antoniou
1400e7e75c70SHeiko Schocher		CONFIG_SYS_DFU_DATA_BUF_SIZE
1401e7e75c70SHeiko Schocher		Dfu transfer uses a buffer before writing data to the
1402e7e75c70SHeiko Schocher		raw storage device. Make the size (in bytes) of this buffer
1403e7e75c70SHeiko Schocher		configurable. The size of this buffer is also configurable
1404e7e75c70SHeiko Schocher		through the "dfu_bufsiz" environment variable.
1405e7e75c70SHeiko Schocher
1406ea2453d5SPantelis Antoniou		CONFIG_SYS_DFU_MAX_FILE_SIZE
1407ea2453d5SPantelis Antoniou		When updating files rather than the raw storage device,
1408ea2453d5SPantelis Antoniou		we use a static buffer to copy the file into and then write
1409ea2453d5SPantelis Antoniou		the buffer once we've been given the whole file.  Define
1410ea2453d5SPantelis Antoniou		this to the maximum filesize (in bytes) for the buffer.
1411ea2453d5SPantelis Antoniou		Default is 4 MiB if undefined.
1412ea2453d5SPantelis Antoniou
14136705d81eSwdenk- Journaling Flash filesystem support:
14146705d81eSwdenk		CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
14156705d81eSwdenk		CONFIG_JFFS2_NAND_DEV
14166705d81eSwdenk		Define these for a default partition on a NAND device
14176705d81eSwdenk
14186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_SECTOR,
14196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
14206705d81eSwdenk		Define these for a default partition on a NOR device
14216705d81eSwdenk
14226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS_CUSTOM_PART
14236705d81eSwdenk		Define this to create an own partition. You have to provide a
14246705d81eSwdenk		function struct part_info* jffs2_part_info(int part_num)
14256705d81eSwdenk
14266705d81eSwdenk		If you define only one JFFS2 partition you may also want to
14276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_JFFS_SINGLE_PART	1
14286705d81eSwdenk		to disable the command chpart. This is the default when you
14296705d81eSwdenk		have not defined a custom partition
14306705d81eSwdenk
1431c30a15e5SDonggeun Kim- FAT(File Allocation Table) filesystem write function support:
1432c30a15e5SDonggeun Kim		CONFIG_FAT_WRITE
1433656f4c65SDonggeun Kim
1434656f4c65SDonggeun Kim		Define this to enable support for saving memory data as a
1435656f4c65SDonggeun Kim		file in FAT formatted partition.
1436656f4c65SDonggeun Kim
1437656f4c65SDonggeun Kim		This will also enable the command "fatwrite" enabling the
1438656f4c65SDonggeun Kim		user to write files to FAT.
1439c30a15e5SDonggeun Kim
144084cd9327SGabe BlackCBFS (Coreboot Filesystem) support
144184cd9327SGabe Black		CONFIG_CMD_CBFS
144284cd9327SGabe Black
144384cd9327SGabe Black		Define this to enable support for reading from a Coreboot
144484cd9327SGabe Black		filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
144584cd9327SGabe Black		and cbfsload.
144684cd9327SGabe Black
1447c609719bSwdenk- Keyboard Support:
1448c609719bSwdenk		CONFIG_ISA_KEYBOARD
1449c609719bSwdenk
1450c609719bSwdenk		Define this to enable standard (PC-Style) keyboard
1451c609719bSwdenk		support
1452c609719bSwdenk
1453c609719bSwdenk		CONFIG_I8042_KBD
1454c609719bSwdenk		Standard PC keyboard driver with US (is default) and
1455c609719bSwdenk		GERMAN key layout (switch via environment 'keymap=de') support.
1456c609719bSwdenk		Export function i8042_kbd_init, i8042_tstc and i8042_getc
1457c609719bSwdenk		for cfb_console. Supports cursor blinking.
1458c609719bSwdenk
1459713cb680SHung-ying Tyan		CONFIG_CROS_EC_KEYB
1460713cb680SHung-ying Tyan		Enables a Chrome OS keyboard using the CROS_EC interface.
1461713cb680SHung-ying Tyan		This uses CROS_EC to communicate with a second microcontroller
1462713cb680SHung-ying Tyan		which provides key scans on request.
1463713cb680SHung-ying Tyan
1464c609719bSwdenk- Video support:
1465c609719bSwdenk		CONFIG_VIDEO
1466c609719bSwdenk
1467c609719bSwdenk		Define this to enable video support (for output to
1468c609719bSwdenk		video).
1469c609719bSwdenk
1470c609719bSwdenk		CONFIG_VIDEO_CT69000
1471c609719bSwdenk
1472c609719bSwdenk		Enable Chips & Technologies 69000 Video chip
1473c609719bSwdenk
1474c609719bSwdenk		CONFIG_VIDEO_SMI_LYNXEM
1475eeb1b77bSwdenk		Enable Silicon Motion SMI 712/710/810 Video chip. The
1476eeb1b77bSwdenk		video output is selected via environment 'videoout'
1477eeb1b77bSwdenk		(1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1478eeb1b77bSwdenk		assumed.
1479c609719bSwdenk
1480eeb1b77bSwdenk		For the CT69000 and SMI_LYNXEM drivers, videomode is
148111ccc33fSMarcel Ziswiler		selected via environment 'videomode'. Two different ways
1482eeb1b77bSwdenk		are possible:
1483eeb1b77bSwdenk		- "videomode=num"   'num' is a standard LiLo mode numbers.
1484eeb1b77bSwdenk		Following standard modes are supported	(* is default):
1485eeb1b77bSwdenk
1486eeb1b77bSwdenk		      Colors	640x480 800x600 1024x768 1152x864 1280x1024
1487eeb1b77bSwdenk		-------------+---------------------------------------------
1488eeb1b77bSwdenk		      8 bits |	0x301*	0x303	 0x305	  0x161	    0x307
1489eeb1b77bSwdenk		     15 bits |	0x310	0x313	 0x316	  0x162	    0x319
1490eeb1b77bSwdenk		     16 bits |	0x311	0x314	 0x317	  0x163	    0x31A
1491eeb1b77bSwdenk		     24 bits |	0x312	0x315	 0x318	    ?	    0x31B
1492eeb1b77bSwdenk		-------------+---------------------------------------------
1493c609719bSwdenk		(i.e. setenv videomode 317; saveenv; reset;)
1494c609719bSwdenk
1495eeb1b77bSwdenk		- "videomode=bootargs" all the video parameters are parsed
14967817cb20SMarcel Ziswiler		from the bootargs. (See drivers/video/videomodes.c)
1497eeb1b77bSwdenk
1498eeb1b77bSwdenk
1499a6c7ad2fSwdenk		CONFIG_VIDEO_SED13806
1500a6c7ad2fSwdenk		Enable Epson SED13806 driver. This driver supports 8bpp
1501a6c7ad2fSwdenk		and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1502a6c7ad2fSwdenk		or CONFIG_VIDEO_SED13806_16BPP
1503a6c7ad2fSwdenk
15047d3053fbSTimur Tabi		CONFIG_FSL_DIU_FB
15057d3053fbSTimur Tabi		Enable the Freescale DIU video driver.	Reference boards for
15067d3053fbSTimur Tabi		SOCs that have a DIU should define this macro to enable DIU
15077d3053fbSTimur Tabi		support, and should also define these other macros:
15087d3053fbSTimur Tabi
15097d3053fbSTimur Tabi			CONFIG_SYS_DIU_ADDR
15107d3053fbSTimur Tabi			CONFIG_VIDEO
15117d3053fbSTimur Tabi			CONFIG_CMD_BMP
15127d3053fbSTimur Tabi			CONFIG_CFB_CONSOLE
15137d3053fbSTimur Tabi			CONFIG_VIDEO_SW_CURSOR
15147d3053fbSTimur Tabi			CONFIG_VGA_AS_SINGLE_DEVICE
15157d3053fbSTimur Tabi			CONFIG_VIDEO_LOGO
15167d3053fbSTimur Tabi			CONFIG_VIDEO_BMP_LOGO
15177d3053fbSTimur Tabi
1518ba8e76bdSTimur Tabi		The DIU driver will look for the 'video-mode' environment
1519ba8e76bdSTimur Tabi		variable, and if defined, enable the DIU as a console during
1520ba8e76bdSTimur Tabi		boot.  See the documentation file README.video for a
1521ba8e76bdSTimur Tabi		description of this variable.
15227d3053fbSTimur Tabi
1523058d59b0SSimon Glass		CONFIG_VIDEO_VGA
1524058d59b0SSimon Glass
1525058d59b0SSimon Glass		Enable the VGA video / BIOS for x86. The alternative if you
1526058d59b0SSimon Glass		are using coreboot is to use the coreboot frame buffer
1527058d59b0SSimon Glass		driver.
1528058d59b0SSimon Glass
1529058d59b0SSimon Glass
1530682011ffSwdenk- Keyboard Support:
1531682011ffSwdenk		CONFIG_KEYBOARD
1532682011ffSwdenk
1533682011ffSwdenk		Define this to enable a custom keyboard support.
1534682011ffSwdenk		This simply calls drv_keyboard_init() which must be
1535682011ffSwdenk		defined in your board-specific files.
1536682011ffSwdenk		The only board using this so far is RBC823.
1537a6c7ad2fSwdenk
1538c609719bSwdenk- LCD Support:	CONFIG_LCD
1539c609719bSwdenk
1540c609719bSwdenk		Define this to enable LCD support (for output to LCD
1541c609719bSwdenk		display); also select one of the supported displays
1542c609719bSwdenk		by defining one of these:
1543c609719bSwdenk
154439cf4804SStelian Pop		CONFIG_ATMEL_LCD:
154539cf4804SStelian Pop
154639cf4804SStelian Pop			HITACHI TX09D70VM1CCA, 3.5", 240x320.
154739cf4804SStelian Pop
1548fd3103bbSwdenk		CONFIG_NEC_NL6448AC33:
1549c609719bSwdenk
1550fd3103bbSwdenk			NEC NL6448AC33-18. Active, color, single scan.
1551c609719bSwdenk
1552fd3103bbSwdenk		CONFIG_NEC_NL6448BC20
1553c609719bSwdenk
1554fd3103bbSwdenk			NEC NL6448BC20-08. 6.5", 640x480.
1555fd3103bbSwdenk			Active, color, single scan.
1556fd3103bbSwdenk
1557fd3103bbSwdenk		CONFIG_NEC_NL6448BC33_54
1558fd3103bbSwdenk
1559fd3103bbSwdenk			NEC NL6448BC33-54. 10.4", 640x480.
1560c609719bSwdenk			Active, color, single scan.
1561c609719bSwdenk
1562c609719bSwdenk		CONFIG_SHARP_16x9
1563c609719bSwdenk
1564c609719bSwdenk			Sharp 320x240. Active, color, single scan.
1565c609719bSwdenk			It isn't 16x9, and I am not sure what it is.
1566c609719bSwdenk
1567c609719bSwdenk		CONFIG_SHARP_LQ64D341
1568c609719bSwdenk
1569c609719bSwdenk			Sharp LQ64D341 display, 640x480.
1570c609719bSwdenk			Active, color, single scan.
1571c609719bSwdenk
1572c609719bSwdenk		CONFIG_HLD1045
1573c609719bSwdenk
1574c609719bSwdenk			HLD1045 display, 640x480.
1575c609719bSwdenk			Active, color, single scan.
1576c609719bSwdenk
1577c609719bSwdenk		CONFIG_OPTREX_BW
1578c609719bSwdenk
1579c609719bSwdenk			Optrex	 CBL50840-2 NF-FW 99 22 M5
1580c609719bSwdenk			or
1581c609719bSwdenk			Hitachi	 LMG6912RPFC-00T
1582c609719bSwdenk			or
1583c609719bSwdenk			Hitachi	 SP14Q002
1584c609719bSwdenk
1585c609719bSwdenk			320x240. Black & white.
1586c609719bSwdenk
1587c609719bSwdenk		Normally display is black on white background; define
15886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
1589c609719bSwdenk
1590676d319eSSimon Glass		CONFIG_LCD_ALIGNMENT
1591676d319eSSimon Glass
1592676d319eSSimon Glass		Normally the LCD is page-aligned (tyically 4KB). If this is
1593676d319eSSimon Glass		defined then the LCD will be aligned to this value instead.
1594676d319eSSimon Glass		For ARM it is sometimes useful to use MMU_SECTION_SIZE
1595676d319eSSimon Glass		here, since it is cheaper to change data cache settings on
1596676d319eSSimon Glass		a per-section basis.
1597676d319eSSimon Glass
15980d89efefSSimon Glass		CONFIG_CONSOLE_SCROLL_LINES
15990d89efefSSimon Glass
16000d89efefSSimon Glass		When the console need to be scrolled, this is the number of
16010d89efefSSimon Glass		lines to scroll by. It defaults to 1. Increasing this makes
16020d89efefSSimon Glass		the console jump but can help speed up operation when scrolling
16030d89efefSSimon Glass		is slow.
1604676d319eSSimon Glass
160545d7f525STom Wai-Hong Tam		CONFIG_LCD_BMP_RLE8
160645d7f525STom Wai-Hong Tam
160745d7f525STom Wai-Hong Tam		Support drawing of RLE8-compressed bitmaps on the LCD.
160845d7f525STom Wai-Hong Tam
1609735987c5STom Wai-Hong Tam		CONFIG_I2C_EDID
1610735987c5STom Wai-Hong Tam
1611735987c5STom Wai-Hong Tam		Enables an 'i2c edid' command which can read EDID
1612735987c5STom Wai-Hong Tam		information over I2C from an attached LCD display.
1613735987c5STom Wai-Hong Tam
16147152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN
1615d791b1dcSwdenk
1616d791b1dcSwdenk		If this option is set, the environment is checked for
1617d791b1dcSwdenk		a variable "splashimage". If found, the usual display
1618d791b1dcSwdenk		of logo, copyright and system information on the LCD
1619e94d2cd9Swdenk		is suppressed and the BMP image at the address
1620d791b1dcSwdenk		specified in "splashimage" is loaded instead. The
1621d791b1dcSwdenk		console is redirected to the "nulldev", too. This
1622d791b1dcSwdenk		allows for a "silent" boot where a splash screen is
1623d791b1dcSwdenk		loaded very quickly after power-on.
1624d791b1dcSwdenk
1625c0880485SNikita Kiryanov		CONFIG_SPLASHIMAGE_GUARD
1626c0880485SNikita Kiryanov
1627c0880485SNikita Kiryanov		If this option is set, then U-Boot will prevent the environment
1628c0880485SNikita Kiryanov		variable "splashimage" from being set to a problematic address
1629c0880485SNikita Kiryanov		(see README.displaying-bmps and README.arm-unaligned-accesses).
1630c0880485SNikita Kiryanov		This option is useful for targets where, due to alignment
1631c0880485SNikita Kiryanov		restrictions, an improperly aligned BMP image will cause a data
1632c0880485SNikita Kiryanov		abort. If you think you will not have problems with unaligned
1633c0880485SNikita Kiryanov		accesses (for example because your toolchain prevents them)
1634c0880485SNikita Kiryanov		there is no need to set this option.
1635c0880485SNikita Kiryanov
16361ca298ceSMatthias Weisser		CONFIG_SPLASH_SCREEN_ALIGN
16371ca298ceSMatthias Weisser
16381ca298ceSMatthias Weisser		If this option is set the splash image can be freely positioned
16391ca298ceSMatthias Weisser		on the screen. Environment variable "splashpos" specifies the
16401ca298ceSMatthias Weisser		position as "x,y". If a positive number is given it is used as
16411ca298ceSMatthias Weisser		number of pixel from left/top. If a negative number is given it
16421ca298ceSMatthias Weisser		is used as number of pixel from right/bottom. You can also
16431ca298ceSMatthias Weisser		specify 'm' for centering the image.
16441ca298ceSMatthias Weisser
16451ca298ceSMatthias Weisser		Example:
16461ca298ceSMatthias Weisser		setenv splashpos m,m
16471ca298ceSMatthias Weisser			=> image at center of screen
16481ca298ceSMatthias Weisser
16491ca298ceSMatthias Weisser		setenv splashpos 30,20
16501ca298ceSMatthias Weisser			=> image at x = 30 and y = 20
16511ca298ceSMatthias Weisser
16521ca298ceSMatthias Weisser		setenv splashpos -10,m
16531ca298ceSMatthias Weisser			=> vertically centered image
16541ca298ceSMatthias Weisser			   at x = dspWidth - bmpWidth - 9
16551ca298ceSMatthias Weisser
165698f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
165798f4a3dfSStefan Roese
165898f4a3dfSStefan Roese		If this option is set, additionally to standard BMP
165998f4a3dfSStefan Roese		images, gzipped BMP images can be displayed via the
166098f4a3dfSStefan Roese		splashscreen support or the bmp command.
166198f4a3dfSStefan Roese
1662d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1663d5011762SAnatolij Gustschin
1664d5011762SAnatolij Gustschin		If this option is set, 8-bit RLE compressed BMP images
1665d5011762SAnatolij Gustschin		can be displayed via the splashscreen support or the
1666d5011762SAnatolij Gustschin		bmp command.
1667d5011762SAnatolij Gustschin
1668f2b96dfbSLei Wen- Do compresssing for memory range:
1669f2b96dfbSLei Wen		CONFIG_CMD_ZIP
1670f2b96dfbSLei Wen
1671f2b96dfbSLei Wen		If this option is set, it would use zlib deflate method
1672f2b96dfbSLei Wen		to compress the specified memory at its best effort.
1673f2b96dfbSLei Wen
1674c29fdfc1Swdenk- Compression support:
1675c29fdfc1Swdenk		CONFIG_BZIP2
1676c29fdfc1Swdenk
1677c29fdfc1Swdenk		If this option is set, support for bzip2 compressed
1678c29fdfc1Swdenk		images is included. If not, only uncompressed and gzip
1679c29fdfc1Swdenk		compressed images are supported.
1680c29fdfc1Swdenk
1681c29fdfc1Swdenk		NOTE: the bzip2 algorithm requires a lot of RAM, so
16826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
1683c29fdfc1Swdenk		be at least 4MB.
1684d791b1dcSwdenk
1685fc9c1727SLuigi 'Comio' Mantellini		CONFIG_LZMA
1686fc9c1727SLuigi 'Comio' Mantellini
1687fc9c1727SLuigi 'Comio' Mantellini		If this option is set, support for lzma compressed
1688fc9c1727SLuigi 'Comio' Mantellini		images is included.
1689fc9c1727SLuigi 'Comio' Mantellini
1690fc9c1727SLuigi 'Comio' Mantellini		Note: The LZMA algorithm adds between 2 and 4KB of code and it
1691fc9c1727SLuigi 'Comio' Mantellini		requires an amount of dynamic memory that is given by the
1692fc9c1727SLuigi 'Comio' Mantellini		formula:
1693fc9c1727SLuigi 'Comio' Mantellini
1694fc9c1727SLuigi 'Comio' Mantellini			(1846 + 768 << (lc + lp)) * sizeof(uint16)
1695fc9c1727SLuigi 'Comio' Mantellini
1696fc9c1727SLuigi 'Comio' Mantellini		Where lc and lp stand for, respectively, Literal context bits
1697fc9c1727SLuigi 'Comio' Mantellini		and Literal pos bits.
1698fc9c1727SLuigi 'Comio' Mantellini
1699fc9c1727SLuigi 'Comio' Mantellini		This value is upper-bounded by 14MB in the worst case. Anyway,
1700fc9c1727SLuigi 'Comio' Mantellini		for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1701fc9c1727SLuigi 'Comio' Mantellini		total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1702fc9c1727SLuigi 'Comio' Mantellini		a very small buffer.
1703fc9c1727SLuigi 'Comio' Mantellini
1704fc9c1727SLuigi 'Comio' Mantellini		Use the lzmainfo tool to determinate the lc and lp values and
1705fc9c1727SLuigi 'Comio' Mantellini		then calculate the amount of needed dynamic memory (ensuring
17066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the appropriate CONFIG_SYS_MALLOC_LEN value).
1707fc9c1727SLuigi 'Comio' Mantellini
170817ea1177Swdenk- MII/PHY support:
170917ea1177Swdenk		CONFIG_PHY_ADDR
171017ea1177Swdenk
171117ea1177Swdenk		The address of PHY on MII bus.
171217ea1177Swdenk
171317ea1177Swdenk		CONFIG_PHY_CLOCK_FREQ (ppc4xx)
171417ea1177Swdenk
171517ea1177Swdenk		The clock frequency of the MII bus
171617ea1177Swdenk
171717ea1177Swdenk		CONFIG_PHY_GIGE
171817ea1177Swdenk
171917ea1177Swdenk		If this option is set, support for speed/duplex
172011ccc33fSMarcel Ziswiler		detection of gigabit PHY is included.
172117ea1177Swdenk
172217ea1177Swdenk		CONFIG_PHY_RESET_DELAY
172317ea1177Swdenk
172417ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
172517ea1177Swdenk		reset before any MII register access is possible.
172617ea1177Swdenk		For such PHY, set this option to the usec delay
172717ea1177Swdenk		required. (minimum 300usec for LXT971A)
172817ea1177Swdenk
172917ea1177Swdenk		CONFIG_PHY_CMD_DELAY (ppc4xx)
173017ea1177Swdenk
173117ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
173217ea1177Swdenk		command issued before MII status register can be read
173317ea1177Swdenk
1734c609719bSwdenk- Ethernet address:
1735c609719bSwdenk		CONFIG_ETHADDR
1736c68a05feSrichardretanubun		CONFIG_ETH1ADDR
1737c609719bSwdenk		CONFIG_ETH2ADDR
1738c609719bSwdenk		CONFIG_ETH3ADDR
1739c68a05feSrichardretanubun		CONFIG_ETH4ADDR
1740c68a05feSrichardretanubun		CONFIG_ETH5ADDR
1741c609719bSwdenk
174211ccc33fSMarcel Ziswiler		Define a default value for Ethernet address to use
174311ccc33fSMarcel Ziswiler		for the respective Ethernet interface, in case this
1744c609719bSwdenk		is not determined automatically.
1745c609719bSwdenk
1746c609719bSwdenk- IP address:
1747c609719bSwdenk		CONFIG_IPADDR
1748c609719bSwdenk
1749c609719bSwdenk		Define a default value for the IP address to use for
175011ccc33fSMarcel Ziswiler		the default Ethernet interface, in case this is not
1751c609719bSwdenk		determined through e.g. bootp.
17521ebcd654SWolfgang Denk		(Environment variable "ipaddr")
1753c609719bSwdenk
1754c609719bSwdenk- Server IP address:
1755c609719bSwdenk		CONFIG_SERVERIP
1756c609719bSwdenk
1757c609719bSwdenk		Defines a default value for the IP address of a TFTP
1758c609719bSwdenk		server to contact when using the "tftboot" command.
17591ebcd654SWolfgang Denk		(Environment variable "serverip")
1760c609719bSwdenk
176197cfe861SRobin Getz		CONFIG_KEEP_SERVERADDR
176297cfe861SRobin Getz
176397cfe861SRobin Getz		Keeps the server's MAC address, in the env 'serveraddr'
176497cfe861SRobin Getz		for passing to bootargs (like Linux's netconsole option)
176597cfe861SRobin Getz
17661ebcd654SWolfgang Denk- Gateway IP address:
17671ebcd654SWolfgang Denk		CONFIG_GATEWAYIP
17681ebcd654SWolfgang Denk
17691ebcd654SWolfgang Denk		Defines a default value for the IP address of the
17701ebcd654SWolfgang Denk		default router where packets to other networks are
17711ebcd654SWolfgang Denk		sent to.
17721ebcd654SWolfgang Denk		(Environment variable "gatewayip")
17731ebcd654SWolfgang Denk
17741ebcd654SWolfgang Denk- Subnet mask:
17751ebcd654SWolfgang Denk		CONFIG_NETMASK
17761ebcd654SWolfgang Denk
17771ebcd654SWolfgang Denk		Defines a default value for the subnet mask (or
17781ebcd654SWolfgang Denk		routing prefix) which is used to determine if an IP
17791ebcd654SWolfgang Denk		address belongs to the local subnet or needs to be
17801ebcd654SWolfgang Denk		forwarded through a router.
17811ebcd654SWolfgang Denk		(Environment variable "netmask")
17821ebcd654SWolfgang Denk
178353a5c424SDavid Updegraff- Multicast TFTP Mode:
178453a5c424SDavid Updegraff		CONFIG_MCAST_TFTP
178553a5c424SDavid Updegraff
178653a5c424SDavid Updegraff		Defines whether you want to support multicast TFTP as per
178753a5c424SDavid Updegraff		rfc-2090; for example to work with atftp.  Lets lots of targets
178811ccc33fSMarcel Ziswiler		tftp down the same boot image concurrently.  Note: the Ethernet
178953a5c424SDavid Updegraff		driver in use must provide a function: mcast() to join/leave a
179053a5c424SDavid Updegraff		multicast group.
179153a5c424SDavid Updegraff
1792c609719bSwdenk- BOOTP Recovery Mode:
1793c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY
1794c609719bSwdenk
1795c609719bSwdenk		If you have many targets in a network that try to
1796c609719bSwdenk		boot using BOOTP, you may want to avoid that all
1797c609719bSwdenk		systems send out BOOTP requests at precisely the same
1798c609719bSwdenk		moment (which would happen for instance at recovery
1799c609719bSwdenk		from a power failure, when all systems will try to
1800c609719bSwdenk		boot, thus flooding the BOOTP server. Defining
1801c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1802c609719bSwdenk		inserted before sending out BOOTP requests. The
18036c33c785SWolfgang Denk		following delays are inserted then:
1804c609719bSwdenk
1805c609719bSwdenk		1st BOOTP request:	delay 0 ... 1 sec
1806c609719bSwdenk		2nd BOOTP request:	delay 0 ... 2 sec
1807c609719bSwdenk		3rd BOOTP request:	delay 0 ... 4 sec
1808c609719bSwdenk		4th and following
1809c609719bSwdenk		BOOTP requests:		delay 0 ... 8 sec
1810c609719bSwdenk
1811fe389a82Sstroese- DHCP Advanced Options:
18121fe80d79SJon Loeliger		You can fine tune the DHCP functionality by defining
18131fe80d79SJon Loeliger		CONFIG_BOOTP_* symbols:
1814fe389a82Sstroese
18151fe80d79SJon Loeliger		CONFIG_BOOTP_SUBNETMASK
18161fe80d79SJon Loeliger		CONFIG_BOOTP_GATEWAY
18171fe80d79SJon Loeliger		CONFIG_BOOTP_HOSTNAME
18181fe80d79SJon Loeliger		CONFIG_BOOTP_NISDOMAIN
18191fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTPATH
18201fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTFILESIZE
18211fe80d79SJon Loeliger		CONFIG_BOOTP_DNS
18221fe80d79SJon Loeliger		CONFIG_BOOTP_DNS2
18231fe80d79SJon Loeliger		CONFIG_BOOTP_SEND_HOSTNAME
18241fe80d79SJon Loeliger		CONFIG_BOOTP_NTPSERVER
18251fe80d79SJon Loeliger		CONFIG_BOOTP_TIMEOFFSET
18261fe80d79SJon Loeliger		CONFIG_BOOTP_VENDOREX
18272c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL
1828fe389a82Sstroese
18295d110f0aSWilson Callan		CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
18305d110f0aSWilson Callan		environment variable, not the BOOTP server.
1831fe389a82Sstroese
18322c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
18332c00e099SJoe Hershberger		after the configured retry count, the call will fail
18342c00e099SJoe Hershberger		instead of starting over.  This can be used to fail over
18352c00e099SJoe Hershberger		to Link-local IP address configuration if the DHCP server
18362c00e099SJoe Hershberger		is not available.
18372c00e099SJoe Hershberger
1838fe389a82Sstroese		CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1839fe389a82Sstroese		serverip from a DHCP server, it is possible that more
1840fe389a82Sstroese		than one DNS serverip is offered to the client.
1841fe389a82Sstroese		If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1842fe389a82Sstroese		serverip will be stored in the additional environment
1843fe389a82Sstroese		variable "dnsip2". The first DNS serverip is always
1844fe389a82Sstroese		stored in the variable "dnsip", when CONFIG_BOOTP_DNS
18451fe80d79SJon Loeliger		is defined.
1846fe389a82Sstroese
1847fe389a82Sstroese		CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1848fe389a82Sstroese		to do a dynamic update of a DNS server. To do this, they
1849fe389a82Sstroese		need the hostname of the DHCP requester.
18505d110f0aSWilson Callan		If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
18511fe80d79SJon Loeliger		of the "hostname" environment variable is passed as
18521fe80d79SJon Loeliger		option 12 to the DHCP server.
1853fe389a82Sstroese
1854d9a2f416SAras Vaichas		CONFIG_BOOTP_DHCP_REQUEST_DELAY
1855d9a2f416SAras Vaichas
1856d9a2f416SAras Vaichas		A 32bit value in microseconds for a delay between
1857d9a2f416SAras Vaichas		receiving a "DHCP Offer" and sending the "DHCP Request".
1858d9a2f416SAras Vaichas		This fixes a problem with certain DHCP servers that don't
1859d9a2f416SAras Vaichas		respond 100% of the time to a "DHCP request". E.g. On an
1860d9a2f416SAras Vaichas		AT91RM9200 processor running at 180MHz, this delay needed
1861d9a2f416SAras Vaichas		to be *at least* 15,000 usec before a Windows Server 2003
1862d9a2f416SAras Vaichas		DHCP server would reply 100% of the time. I recommend at
1863d9a2f416SAras Vaichas		least 50,000 usec to be safe. The alternative is to hope
1864d9a2f416SAras Vaichas		that one of the retries will be successful but note that
1865d9a2f416SAras Vaichas		the DHCP timeout and retry process takes a longer than
1866d9a2f416SAras Vaichas		this delay.
1867d9a2f416SAras Vaichas
1868d22c338eSJoe Hershberger - Link-local IP address negotiation:
1869d22c338eSJoe Hershberger		Negotiate with other link-local clients on the local network
1870d22c338eSJoe Hershberger		for an address that doesn't require explicit configuration.
1871d22c338eSJoe Hershberger		This is especially useful if a DHCP server cannot be guaranteed
1872d22c338eSJoe Hershberger		to exist in all environments that the device must operate.
1873d22c338eSJoe Hershberger
1874d22c338eSJoe Hershberger		See doc/README.link-local for more information.
1875d22c338eSJoe Hershberger
1876a3d991bdSwdenk - CDP Options:
1877a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID
1878a3d991bdSwdenk
1879a3d991bdSwdenk		The device id used in CDP trigger frames.
1880a3d991bdSwdenk
1881a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID_PREFIX
1882a3d991bdSwdenk
1883a3d991bdSwdenk		A two character string which is prefixed to the MAC address
1884a3d991bdSwdenk		of the device.
1885a3d991bdSwdenk
1886a3d991bdSwdenk		CONFIG_CDP_PORT_ID
1887a3d991bdSwdenk
1888a3d991bdSwdenk		A printf format string which contains the ascii name of
1889a3d991bdSwdenk		the port. Normally is set to "eth%d" which sets
189011ccc33fSMarcel Ziswiler		eth0 for the first Ethernet, eth1 for the second etc.
1891a3d991bdSwdenk
1892a3d991bdSwdenk		CONFIG_CDP_CAPABILITIES
1893a3d991bdSwdenk
1894a3d991bdSwdenk		A 32bit integer which indicates the device capabilities;
1895a3d991bdSwdenk		0x00000010 for a normal host which does not forwards.
1896a3d991bdSwdenk
1897a3d991bdSwdenk		CONFIG_CDP_VERSION
1898a3d991bdSwdenk
1899a3d991bdSwdenk		An ascii string containing the version of the software.
1900a3d991bdSwdenk
1901a3d991bdSwdenk		CONFIG_CDP_PLATFORM
1902a3d991bdSwdenk
1903a3d991bdSwdenk		An ascii string containing the name of the platform.
1904a3d991bdSwdenk
1905a3d991bdSwdenk		CONFIG_CDP_TRIGGER
1906a3d991bdSwdenk
1907a3d991bdSwdenk		A 32bit integer sent on the trigger.
1908a3d991bdSwdenk
1909a3d991bdSwdenk		CONFIG_CDP_POWER_CONSUMPTION
1910a3d991bdSwdenk
1911a3d991bdSwdenk		A 16bit integer containing the power consumption of the
1912a3d991bdSwdenk		device in .1 of milliwatts.
1913a3d991bdSwdenk
1914a3d991bdSwdenk		CONFIG_CDP_APPLIANCE_VLAN_TYPE
1915a3d991bdSwdenk
1916a3d991bdSwdenk		A byte containing the id of the VLAN.
1917a3d991bdSwdenk
1918c609719bSwdenk- Status LED:	CONFIG_STATUS_LED
1919c609719bSwdenk
1920c609719bSwdenk		Several configurations allow to display the current
1921c609719bSwdenk		status using a LED. For instance, the LED will blink
1922c609719bSwdenk		fast while running U-Boot code, stop blinking as
1923c609719bSwdenk		soon as a reply to a BOOTP request was received, and
1924c609719bSwdenk		start blinking slow once the Linux kernel is running
1925c609719bSwdenk		(supported by a status LED driver in the Linux
1926c609719bSwdenk		kernel). Defining CONFIG_STATUS_LED enables this
1927c609719bSwdenk		feature in U-Boot.
1928c609719bSwdenk
1929c609719bSwdenk- CAN Support:	CONFIG_CAN_DRIVER
1930c609719bSwdenk
1931c609719bSwdenk		Defining CONFIG_CAN_DRIVER enables CAN driver support
1932c609719bSwdenk		on those systems that support this (optional)
1933c609719bSwdenk		feature, like the TQM8xxL modules.
1934c609719bSwdenk
19353f4978c7SHeiko Schocher- I2C Support:	CONFIG_SYS_I2C
1936c609719bSwdenk
19373f4978c7SHeiko Schocher		This enable the NEW i2c subsystem, and will allow you to use
19383f4978c7SHeiko Schocher		i2c commands at the u-boot command line (as long as you set
19393f4978c7SHeiko Schocher		CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
19403f4978c7SHeiko Schocher		based realtime clock chips or other i2c devices. See
19413f4978c7SHeiko Schocher		common/cmd_i2c.c for a description of the command line
19423f4978c7SHeiko Schocher		interface.
19433f4978c7SHeiko Schocher
19443f4978c7SHeiko Schocher		ported i2c driver to the new framework:
1945ea818dbbSHeiko Schocher		- drivers/i2c/soft_i2c.c:
1946ea818dbbSHeiko Schocher		  - activate first bus with CONFIG_SYS_I2C_SOFT define
1947ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
1948ea818dbbSHeiko Schocher		    for defining speed and slave address
1949ea818dbbSHeiko Schocher		  - activate second bus with I2C_SOFT_DECLARATIONS2 define
1950ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
1951ea818dbbSHeiko Schocher		    for defining speed and slave address
1952ea818dbbSHeiko Schocher		  - activate third bus with I2C_SOFT_DECLARATIONS3 define
1953ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
1954ea818dbbSHeiko Schocher		    for defining speed and slave address
1955ea818dbbSHeiko Schocher		  - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
1956ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
1957ea818dbbSHeiko Schocher		    for defining speed and slave address
19583f4978c7SHeiko Schocher
195900f792e0SHeiko Schocher		- drivers/i2c/fsl_i2c.c:
196000f792e0SHeiko Schocher		  - activate i2c driver with CONFIG_SYS_I2C_FSL
196100f792e0SHeiko Schocher		    define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
196200f792e0SHeiko Schocher		    offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
196300f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
196400f792e0SHeiko Schocher		    bus.
196500f792e0SHeiko Schocher                  - If your board supports a second fsl i2c bus, define
196600f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
196700f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_SPEED for the speed and
196800f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
196900f792e0SHeiko Schocher		    second bus.
197000f792e0SHeiko Schocher
19711f2ba722SSimon Glass		- drivers/i2c/tegra_i2c.c:
19721f2ba722SSimon Glass		 - activate this driver with CONFIG_SYS_I2C_TEGRA
19731f2ba722SSimon Glass		 - This driver adds 4 i2c buses with a fix speed from
19741f2ba722SSimon Glass		   100000 and the slave addr 0!
19751f2ba722SSimon Glass
1976880540deSDirk Eibach		- drivers/i2c/ppc4xx_i2c.c
1977880540deSDirk Eibach		  - activate this driver with CONFIG_SYS_I2C_PPC4XX
1978880540deSDirk Eibach		  - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
1979880540deSDirk Eibach		  - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
1980880540deSDirk Eibach
19813f4978c7SHeiko Schocher		additional defines:
19823f4978c7SHeiko Schocher
19833f4978c7SHeiko Schocher		CONFIG_SYS_NUM_I2C_BUSES
19843f4978c7SHeiko Schocher		Hold the number of i2c busses you want to use. If you
19853f4978c7SHeiko Schocher		don't use/have i2c muxes on your i2c bus, this
19863f4978c7SHeiko Schocher		is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
19873f4978c7SHeiko Schocher		omit this define.
19883f4978c7SHeiko Schocher
19893f4978c7SHeiko Schocher		CONFIG_SYS_I2C_DIRECT_BUS
19903f4978c7SHeiko Schocher		define this, if you don't use i2c muxes on your hardware.
19913f4978c7SHeiko Schocher		if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
19923f4978c7SHeiko Schocher		omit this define.
19933f4978c7SHeiko Schocher
19943f4978c7SHeiko Schocher		CONFIG_SYS_I2C_MAX_HOPS
19953f4978c7SHeiko Schocher		define how many muxes are maximal consecutively connected
19963f4978c7SHeiko Schocher		on one i2c bus. If you not use i2c muxes, omit this
19973f4978c7SHeiko Schocher		define.
19983f4978c7SHeiko Schocher
19993f4978c7SHeiko Schocher		CONFIG_SYS_I2C_BUSES
20003f4978c7SHeiko Schocher		hold a list of busses you want to use, only used if
20013f4978c7SHeiko Schocher		CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
20023f4978c7SHeiko Schocher		a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
20033f4978c7SHeiko Schocher		CONFIG_SYS_NUM_I2C_BUSES = 9:
20043f4978c7SHeiko Schocher
20053f4978c7SHeiko Schocher		 CONFIG_SYS_I2C_BUSES	{{0, {I2C_NULL_HOP}}, \
20063f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
20073f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
20083f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
20093f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
20103f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
20113f4978c7SHeiko Schocher					{1, {I2C_NULL_HOP}}, \
20123f4978c7SHeiko Schocher					{1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
20133f4978c7SHeiko Schocher					{1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
20143f4978c7SHeiko Schocher					}
20153f4978c7SHeiko Schocher
20163f4978c7SHeiko Schocher		which defines
20173f4978c7SHeiko Schocher			bus 0 on adapter 0 without a mux
2018ea818dbbSHeiko Schocher			bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2019ea818dbbSHeiko Schocher			bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2020ea818dbbSHeiko Schocher			bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2021ea818dbbSHeiko Schocher			bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2022ea818dbbSHeiko Schocher			bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
20233f4978c7SHeiko Schocher			bus 6 on adapter 1 without a mux
2024ea818dbbSHeiko Schocher			bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2025ea818dbbSHeiko Schocher			bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
20263f4978c7SHeiko Schocher
20273f4978c7SHeiko Schocher		If you do not have i2c muxes on your board, omit this define.
20283f4978c7SHeiko Schocher
2029ea818dbbSHeiko Schocher- Legacy I2C Support:	CONFIG_HARD_I2C
20303f4978c7SHeiko Schocher
20313f4978c7SHeiko Schocher		NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
20323f4978c7SHeiko Schocher		provides the following compelling advantages:
20333f4978c7SHeiko Schocher
20343f4978c7SHeiko Schocher		- more than one i2c adapter is usable
20353f4978c7SHeiko Schocher		- approved multibus support
20363f4978c7SHeiko Schocher		- better i2c mux support
20373f4978c7SHeiko Schocher
20383f4978c7SHeiko Schocher		** Please consider updating your I2C driver now. **
20393f4978c7SHeiko Schocher
2040ea818dbbSHeiko Schocher		These enable legacy I2C serial bus commands. Defining
2041ea818dbbSHeiko Schocher		CONFIG_HARD_I2C will include the appropriate I2C driver
2042ea818dbbSHeiko Schocher		for the selected CPU.
2043c609719bSwdenk
2044b37c7e5eSwdenk		This will allow you to use i2c commands at the u-boot
2045602ad3b3SJon Loeliger		command line (as long as you set CONFIG_CMD_I2C in
2046b37c7e5eSwdenk		CONFIG_COMMANDS) and communicate with i2c based realtime
2047b37c7e5eSwdenk		clock chips. See common/cmd_i2c.c for a description of the
2048c609719bSwdenk		command line interface.
2049c609719bSwdenk
2050bb99ad6dSBen Warren		CONFIG_HARD_I2C selects a hardware I2C controller.
2051c609719bSwdenk
2052b37c7e5eSwdenk		There are several other quantities that must also be
2053ea818dbbSHeiko Schocher		defined when you define CONFIG_HARD_I2C.
2054c609719bSwdenk
20556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		In both cases you will need to define CONFIG_SYS_I2C_SPEED
2056b37c7e5eSwdenk		to be the frequency (in Hz) at which you wish your i2c bus
20576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
205811ccc33fSMarcel Ziswiler		the CPU's i2c node address).
2059c609719bSwdenk
20608d321b81SPeter Tyser		Now, the u-boot i2c code for the mpc8xx
2061a47a12beSStefan Roese		(arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
20628d321b81SPeter Tyser		and so its address should therefore be cleared to 0 (See,
20638d321b81SPeter Tyser		eg, MPC823e User's Manual p.16-473). So, set
20648d321b81SPeter Tyser		CONFIG_SYS_I2C_SLAVE to 0.
2065b37c7e5eSwdenk
20665da71efaSEric Millbrandt		CONFIG_SYS_I2C_INIT_MPC5XXX
20675da71efaSEric Millbrandt
20685da71efaSEric Millbrandt		When a board is reset during an i2c bus transfer
20695da71efaSEric Millbrandt		chips might think that the current transfer is still
20705da71efaSEric Millbrandt		in progress.  Reset the slave devices by sending start
20715da71efaSEric Millbrandt		commands until the slave device responds.
20725da71efaSEric Millbrandt
2073b37c7e5eSwdenk		That's all that's required for CONFIG_HARD_I2C.
2074b37c7e5eSwdenk
2075ea818dbbSHeiko Schocher		If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
2076b37c7e5eSwdenk		then the following macros need to be defined (examples are
2077b37c7e5eSwdenk		from include/configs/lwmon.h):
2078c609719bSwdenk
2079c609719bSwdenk		I2C_INIT
2080c609719bSwdenk
2081b37c7e5eSwdenk		(Optional). Any commands necessary to enable the I2C
2082c609719bSwdenk		controller or configure ports.
2083c609719bSwdenk
2084b37c7e5eSwdenk		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
2085b37c7e5eSwdenk
2086c609719bSwdenk		I2C_PORT
2087c609719bSwdenk
2088c609719bSwdenk		(Only for MPC8260 CPU). The I/O port to use (the code
2089c609719bSwdenk		assumes both bits are on the same port). Valid values
2090c609719bSwdenk		are 0..3 for ports A..D.
2091c609719bSwdenk
2092c609719bSwdenk		I2C_ACTIVE
2093c609719bSwdenk
2094c609719bSwdenk		The code necessary to make the I2C data line active
2095c609719bSwdenk		(driven).  If the data line is open collector, this
2096c609719bSwdenk		define can be null.
2097c609719bSwdenk
2098b37c7e5eSwdenk		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
2099b37c7e5eSwdenk
2100c609719bSwdenk		I2C_TRISTATE
2101c609719bSwdenk
2102c609719bSwdenk		The code necessary to make the I2C data line tri-stated
2103c609719bSwdenk		(inactive).  If the data line is open collector, this
2104c609719bSwdenk		define can be null.
2105c609719bSwdenk
2106b37c7e5eSwdenk		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2107b37c7e5eSwdenk
2108c609719bSwdenk		I2C_READ
2109c609719bSwdenk
2110472d5460SYork Sun		Code that returns true if the I2C data line is high,
2111472d5460SYork Sun		false if it is low.
2112c609719bSwdenk
2113b37c7e5eSwdenk		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2114b37c7e5eSwdenk
2115c609719bSwdenk		I2C_SDA(bit)
2116c609719bSwdenk
2117472d5460SYork Sun		If <bit> is true, sets the I2C data line high. If it
2118472d5460SYork Sun		is false, it clears it (low).
2119c609719bSwdenk
2120b37c7e5eSwdenk		eg: #define I2C_SDA(bit) \
2121b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
2122b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
2123b37c7e5eSwdenk
2124c609719bSwdenk		I2C_SCL(bit)
2125c609719bSwdenk
2126472d5460SYork Sun		If <bit> is true, sets the I2C clock line high. If it
2127472d5460SYork Sun		is false, it clears it (low).
2128c609719bSwdenk
2129b37c7e5eSwdenk		eg: #define I2C_SCL(bit) \
2130b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
2131b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
2132b37c7e5eSwdenk
2133c609719bSwdenk		I2C_DELAY
2134c609719bSwdenk
2135c609719bSwdenk		This delay is invoked four times per clock cycle so this
2136c609719bSwdenk		controls the rate of data transfer.  The data rate thus
2137b37c7e5eSwdenk		is 1 / (I2C_DELAY * 4). Often defined to be something
2138b37c7e5eSwdenk		like:
2139b37c7e5eSwdenk
2140b37c7e5eSwdenk		#define I2C_DELAY  udelay(2)
2141c609719bSwdenk
2142793b5726SMike Frysinger		CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2143793b5726SMike Frysinger
2144793b5726SMike Frysinger		If your arch supports the generic GPIO framework (asm/gpio.h),
2145793b5726SMike Frysinger		then you may alternatively define the two GPIOs that are to be
2146793b5726SMike Frysinger		used as SCL / SDA.  Any of the previous I2C_xxx macros will
2147793b5726SMike Frysinger		have GPIO-based defaults assigned to them as appropriate.
2148793b5726SMike Frysinger
2149793b5726SMike Frysinger		You should define these to the GPIO value as given directly to
2150793b5726SMike Frysinger		the generic GPIO functions.
2151793b5726SMike Frysinger
21526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_INIT_BOARD
215347cd00faSwdenk
215447cd00faSwdenk		When a board is reset during an i2c bus transfer
215547cd00faSwdenk		chips might think that the current transfer is still
215647cd00faSwdenk		in progress. On some boards it is possible to access
215747cd00faSwdenk		the i2c SCLK line directly, either by using the
215847cd00faSwdenk		processor pin as a GPIO or by having a second pin
215947cd00faSwdenk		connected to the bus. If this option is defined a
216047cd00faSwdenk		custom i2c_init_board() routine in boards/xxx/board.c
216147cd00faSwdenk		is run early in the boot sequence.
216247cd00faSwdenk
216326a33504SRichard Retanubun		CONFIG_SYS_I2C_BOARD_LATE_INIT
216426a33504SRichard Retanubun
216526a33504SRichard Retanubun		An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
216626a33504SRichard Retanubun		defined a custom i2c_board_late_init() routine in
216726a33504SRichard Retanubun		boards/xxx/board.c is run AFTER the operations in i2c_init()
216826a33504SRichard Retanubun		is completed. This callpoint can be used to unreset i2c bus
216926a33504SRichard Retanubun		using CPU i2c controller register accesses for CPUs whose i2c
217026a33504SRichard Retanubun		controller provide such a method. It is called at the end of
217126a33504SRichard Retanubun		i2c_init() to allow i2c_init operations to setup the i2c bus
217226a33504SRichard Retanubun		controller on the CPU (e.g. setting bus speed & slave address).
217326a33504SRichard Retanubun
217417ea1177Swdenk		CONFIG_I2CFAST (PPC405GP|PPC405EP only)
217517ea1177Swdenk
217617ea1177Swdenk		This option enables configuration of bi_iic_fast[] flags
217717ea1177Swdenk		in u-boot bd_info structure based on u-boot environment
217817ea1177Swdenk		variable "i2cfast". (see also i2cfast)
217917ea1177Swdenk
2180bb99ad6dSBen Warren		CONFIG_I2C_MULTI_BUS
2181bb99ad6dSBen Warren
2182bb99ad6dSBen Warren		This option allows the use of multiple I2C buses, each of which
2183bb99ad6dSBen Warren		must have a controller.	 At any point in time, only one bus is
2184bb99ad6dSBen Warren		active.	 To switch to a different bus, use the 'i2c dev' command.
2185bb99ad6dSBen Warren		Note that bus numbering is zero-based.
2186bb99ad6dSBen Warren
21876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_NOPROBES
2188bb99ad6dSBen Warren
2189bb99ad6dSBen Warren		This option specifies a list of I2C devices that will be skipped
21900f89c54bSPeter Tyser		when the 'i2c probe' command is issued.	 If CONFIG_I2C_MULTI_BUS
21910f89c54bSPeter Tyser		is set, specify a list of bus-device pairs.  Otherwise, specify
21920f89c54bSPeter Tyser		a 1D array of device addresses
2193bb99ad6dSBen Warren
2194bb99ad6dSBen Warren		e.g.
2195bb99ad6dSBen Warren			#undef	CONFIG_I2C_MULTI_BUS
21966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
2197bb99ad6dSBen Warren
2198bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on a board with one I2C bus
2199bb99ad6dSBen Warren
2200bb99ad6dSBen Warren			#define CONFIG_I2C_MULTI_BUS
22016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_MULTI_NOPROBES	{{0,0x50},{0,0x68},{1,0x54}}
2202bb99ad6dSBen Warren
2203bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2204bb99ad6dSBen Warren
22056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SPD_BUS_NUM
2206be5e6181STimur Tabi
2207be5e6181STimur Tabi		If defined, then this indicates the I2C bus number for DDR SPD.
2208be5e6181STimur Tabi		If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2209be5e6181STimur Tabi
22106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_BUS_NUM
22110dc018ecSStefan Roese
22120dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the RTC.
22130dc018ecSStefan Roese		If not defined, then U-Boot assumes that RTC is on I2C bus 0.
22140dc018ecSStefan Roese
22156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_DTT_BUS_NUM
22160dc018ecSStefan Roese
22170dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the DTT.
22180dc018ecSStefan Roese		If not defined, then U-Boot assumes that DTT is on I2C bus 0.
22190dc018ecSStefan Roese
22206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_DTT_ADDR:
22219ebbb54fSVictor Gallardo
22229ebbb54fSVictor Gallardo		If defined, specifies the I2C address of the DTT device.
22239ebbb54fSVictor Gallardo		If not defined, then U-Boot uses predefined value for
22249ebbb54fSVictor Gallardo		specified DTT device.
22259ebbb54fSVictor Gallardo
22262ac6985aSAndrew Dyer		CONFIG_SOFT_I2C_READ_REPEATED_START
22272ac6985aSAndrew Dyer
22282ac6985aSAndrew Dyer		defining this will force the i2c_read() function in
22292ac6985aSAndrew Dyer		the soft_i2c driver to perform an I2C repeated start
22302ac6985aSAndrew Dyer		between writing the address pointer and reading the
22312ac6985aSAndrew Dyer		data.  If this define is omitted the default behaviour
22322ac6985aSAndrew Dyer		of doing a stop-start sequence will be used.  Most I2C
22332ac6985aSAndrew Dyer		devices can use either method, but some require one or
22342ac6985aSAndrew Dyer		the other.
2235be5e6181STimur Tabi
2236c609719bSwdenk- SPI Support:	CONFIG_SPI
2237c609719bSwdenk
2238c609719bSwdenk		Enables SPI driver (so far only tested with
2239c609719bSwdenk		SPI EEPROM, also an instance works with Crystal A/D and
2240c609719bSwdenk		D/As on the SACSng board)
2241c609719bSwdenk
22426639562eSYoshihiro Shimoda		CONFIG_SH_SPI
22436639562eSYoshihiro Shimoda
22446639562eSYoshihiro Shimoda		Enables the driver for SPI controller on SuperH. Currently
22456639562eSYoshihiro Shimoda		only SH7757 is supported.
22466639562eSYoshihiro Shimoda
2247c609719bSwdenk		CONFIG_SPI_X
2248c609719bSwdenk
2249c609719bSwdenk		Enables extended (16-bit) SPI EEPROM addressing.
2250c609719bSwdenk		(symmetrical to CONFIG_I2C_X)
2251c609719bSwdenk
2252c609719bSwdenk		CONFIG_SOFT_SPI
2253c609719bSwdenk
2254c609719bSwdenk		Enables a software (bit-bang) SPI driver rather than
2255c609719bSwdenk		using hardware support. This is a general purpose
2256c609719bSwdenk		driver that only requires three general I/O port pins
2257c609719bSwdenk		(two outputs, one input) to function. If this is
2258c609719bSwdenk		defined, the board configuration must define several
2259c609719bSwdenk		SPI configuration items (port pins to use, etc). For
2260c609719bSwdenk		an example, see include/configs/sacsng.h.
2261c609719bSwdenk
226204a9e118SBen Warren		CONFIG_HARD_SPI
226304a9e118SBen Warren
226404a9e118SBen Warren		Enables a hardware SPI driver for general-purpose reads
226504a9e118SBen Warren		and writes.  As with CONFIG_SOFT_SPI, the board configuration
226604a9e118SBen Warren		must define a list of chip-select function pointers.
226704a9e118SBen Warren		Currently supported on some MPC8xxx processors.	 For an
226804a9e118SBen Warren		example, see include/configs/mpc8349emds.h.
226904a9e118SBen Warren
227038254f45SGuennadi Liakhovetski		CONFIG_MXC_SPI
227138254f45SGuennadi Liakhovetski
227238254f45SGuennadi Liakhovetski		Enables the driver for the SPI controllers on i.MX and MXC
22732e3cd1cdSFabio Estevam		SoCs. Currently i.MX31/35/51 are supported.
227438254f45SGuennadi Liakhovetski
22750133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA
22760133502eSMatthias Fuchs
22770133502eSMatthias Fuchs		Enables FPGA subsystem.
22780133502eSMatthias Fuchs
22790133502eSMatthias Fuchs		CONFIG_FPGA_<vendor>
22800133502eSMatthias Fuchs
22810133502eSMatthias Fuchs		Enables support for specific chip vendors.
22820133502eSMatthias Fuchs		(ALTERA, XILINX)
22830133502eSMatthias Fuchs
22840133502eSMatthias Fuchs		CONFIG_FPGA_<family>
22850133502eSMatthias Fuchs
22860133502eSMatthias Fuchs		Enables support for FPGA family.
22870133502eSMatthias Fuchs		(SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
22880133502eSMatthias Fuchs
22890133502eSMatthias Fuchs		CONFIG_FPGA_COUNT
2290c609719bSwdenk
2291c609719bSwdenk		Specify the number of FPGA devices to support.
2292c609719bSwdenk
22936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_PROG_FEEDBACK
2294c609719bSwdenk
2295c609719bSwdenk		Enable printing of hash marks during FPGA configuration.
2296c609719bSwdenk
22976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_BUSY
2298c609719bSwdenk
2299c609719bSwdenk		Enable checks on FPGA configuration interface busy
2300c609719bSwdenk		status by the configuration function. This option
2301c609719bSwdenk		will require a board or device specific function to
2302c609719bSwdenk		be written.
2303c609719bSwdenk
2304c609719bSwdenk		CONFIG_FPGA_DELAY
2305c609719bSwdenk
2306c609719bSwdenk		If defined, a function that provides delays in the FPGA
2307c609719bSwdenk		configuration driver.
2308c609719bSwdenk
23096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_CTRLC
2310c609719bSwdenk		Allow Control-C to interrupt FPGA configuration
2311c609719bSwdenk
23126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_ERROR
2313c609719bSwdenk
2314c609719bSwdenk		Check for configuration errors during FPGA bitfile
2315c609719bSwdenk		loading. For example, abort during Virtex II
2316c609719bSwdenk		configuration if the INIT_B line goes low (which
2317c609719bSwdenk		indicated a CRC error).
2318c609719bSwdenk
23196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_INIT
2320c609719bSwdenk
2321c609719bSwdenk		Maximum time to wait for the INIT_B line to deassert
2322c609719bSwdenk		after PROB_B has been deasserted during a Virtex II
2323c609719bSwdenk		FPGA configuration sequence. The default time is 500
232411ccc33fSMarcel Ziswiler		ms.
2325c609719bSwdenk
23266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_BUSY
2327c609719bSwdenk
2328c609719bSwdenk		Maximum time to wait for BUSY to deassert during
232911ccc33fSMarcel Ziswiler		Virtex II FPGA configuration. The default is 5 ms.
2330c609719bSwdenk
23316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_CONFIG
2332c609719bSwdenk
2333c609719bSwdenk		Time to wait after FPGA configuration. The default is
233411ccc33fSMarcel Ziswiler		200 ms.
2335c609719bSwdenk
2336c609719bSwdenk- Configuration Management:
2337c609719bSwdenk		CONFIG_IDENT_STRING
2338c609719bSwdenk
2339c609719bSwdenk		If defined, this string will be added to the U-Boot
2340c609719bSwdenk		version information (U_BOOT_VERSION)
2341c609719bSwdenk
2342c609719bSwdenk- Vendor Parameter Protection:
2343c609719bSwdenk
2344c609719bSwdenk		U-Boot considers the values of the environment
2345c609719bSwdenk		variables "serial#" (Board Serial Number) and
23467152b1d0Swdenk		"ethaddr" (Ethernet Address) to be parameters that
2347c609719bSwdenk		are set once by the board vendor / manufacturer, and
2348c609719bSwdenk		protects these variables from casual modification by
2349c609719bSwdenk		the user. Once set, these variables are read-only,
2350c609719bSwdenk		and write or delete attempts are rejected. You can
235111ccc33fSMarcel Ziswiler		change this behaviour:
2352c609719bSwdenk
2353c609719bSwdenk		If CONFIG_ENV_OVERWRITE is #defined in your config
2354c609719bSwdenk		file, the write protection for vendor parameters is
235547cd00faSwdenk		completely disabled. Anybody can change or delete
2356c609719bSwdenk		these parameters.
2357c609719bSwdenk
2358c609719bSwdenk		Alternatively, if you #define _both_ CONFIG_ETHADDR
2359c609719bSwdenk		_and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
236011ccc33fSMarcel Ziswiler		Ethernet address is installed in the environment,
2361c609719bSwdenk		which can be changed exactly ONCE by the user. [The
2362c609719bSwdenk		serial# is unaffected by this, i. e. it remains
2363c609719bSwdenk		read-only.]
2364c609719bSwdenk
23652598090bSJoe Hershberger		The same can be accomplished in a more flexible way
23662598090bSJoe Hershberger		for any variable by configuring the type of access
23672598090bSJoe Hershberger		to allow for those variables in the ".flags" variable
23682598090bSJoe Hershberger		or define CONFIG_ENV_FLAGS_LIST_STATIC.
23692598090bSJoe Hershberger
2370c609719bSwdenk- Protected RAM:
2371c609719bSwdenk		CONFIG_PRAM
2372c609719bSwdenk
2373c609719bSwdenk		Define this variable to enable the reservation of
2374c609719bSwdenk		"protected RAM", i. e. RAM which is not overwritten
2375c609719bSwdenk		by U-Boot. Define CONFIG_PRAM to hold the number of
2376c609719bSwdenk		kB you want to reserve for pRAM. You can overwrite
2377c609719bSwdenk		this default value by defining an environment
2378c609719bSwdenk		variable "pram" to the number of kB you want to
2379c609719bSwdenk		reserve. Note that the board info structure will
2380c609719bSwdenk		still show the full amount of RAM. If pRAM is
2381c609719bSwdenk		reserved, a new environment variable "mem" will
2382c609719bSwdenk		automatically be defined to hold the amount of
2383c609719bSwdenk		remaining RAM in a form that can be passed as boot
2384c609719bSwdenk		argument to Linux, for instance like that:
2385c609719bSwdenk
2386fe126d8bSWolfgang Denk			setenv bootargs ... mem=\${mem}
2387c609719bSwdenk			saveenv
2388c609719bSwdenk
2389c609719bSwdenk		This way you can tell Linux not to use this memory,
2390c609719bSwdenk		either, which results in a memory region that will
2391c609719bSwdenk		not be affected by reboots.
2392c609719bSwdenk
2393c609719bSwdenk		*WARNING* If your board configuration uses automatic
2394c609719bSwdenk		detection of the RAM size, you must make sure that
2395c609719bSwdenk		this memory test is non-destructive. So far, the
2396c609719bSwdenk		following board configurations are known to be
2397c609719bSwdenk		"pRAM-clean":
2398c609719bSwdenk
23991b0757ecSWolfgang Denk			IVMS8, IVML24, SPD8xx, TQM8xxL,
24001b0757ecSWolfgang Denk			HERMES, IP860, RPXlite, LWMON,
2401544d97e9SWolfgang Denk			FLAGADM, TQM8260
2402c609719bSwdenk
240340fef049SGabe Black- Access to physical memory region (> 4GB)
240440fef049SGabe Black		Some basic support is provided for operations on memory not
240540fef049SGabe Black		normally accessible to U-Boot - e.g. some architectures
240640fef049SGabe Black		support access to more than 4GB of memory on 32-bit
240740fef049SGabe Black		machines using physical address extension or similar.
240840fef049SGabe Black		Define CONFIG_PHYSMEM to access this basic support, which
240940fef049SGabe Black		currently only supports clearing the memory.
241040fef049SGabe Black
2411c609719bSwdenk- Error Recovery:
2412c609719bSwdenk		CONFIG_PANIC_HANG
2413c609719bSwdenk
2414c609719bSwdenk		Define this variable to stop the system in case of a
2415c609719bSwdenk		fatal error, so that you have to reset it manually.
2416c609719bSwdenk		This is probably NOT a good idea for an embedded
241711ccc33fSMarcel Ziswiler		system where you want the system to reboot
2418c609719bSwdenk		automatically as fast as possible, but it may be
2419c609719bSwdenk		useful during development since you can try to debug
2420c609719bSwdenk		the conditions that lead to the situation.
2421c609719bSwdenk
2422c609719bSwdenk		CONFIG_NET_RETRY_COUNT
2423c609719bSwdenk
2424c609719bSwdenk		This variable defines the number of retries for
2425c609719bSwdenk		network operations like ARP, RARP, TFTP, or BOOTP
2426c609719bSwdenk		before giving up the operation. If not defined, a
2427c609719bSwdenk		default value of 5 is used.
2428c609719bSwdenk
242940cb90eeSGuennadi Liakhovetski		CONFIG_ARP_TIMEOUT
243040cb90eeSGuennadi Liakhovetski
243140cb90eeSGuennadi Liakhovetski		Timeout waiting for an ARP reply in milliseconds.
243240cb90eeSGuennadi Liakhovetski
243348a3e999STetsuyuki Kobayashi		CONFIG_NFS_TIMEOUT
243448a3e999STetsuyuki Kobayashi
243548a3e999STetsuyuki Kobayashi		Timeout in milliseconds used in NFS protocol.
243648a3e999STetsuyuki Kobayashi		If you encounter "ERROR: Cannot umount" in nfs command,
243748a3e999STetsuyuki Kobayashi		try longer timeout such as
243848a3e999STetsuyuki Kobayashi		#define CONFIG_NFS_TIMEOUT 10000UL
243948a3e999STetsuyuki Kobayashi
2440c609719bSwdenk- Command Interpreter:
24418078f1a5SWolfgang Denk		CONFIG_AUTO_COMPLETE
244204a85b3bSwdenk
244304a85b3bSwdenk		Enable auto completion of commands using TAB.
244404a85b3bSwdenk
24458078f1a5SWolfgang Denk		Note that this feature has NOT been implemented yet
24468078f1a5SWolfgang Denk		for the "hush" shell.
24478078f1a5SWolfgang Denk
24488078f1a5SWolfgang Denk
24496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_HUSH_PARSER
2450c609719bSwdenk
2451c609719bSwdenk		Define this variable to enable the "hush" shell (from
2452c609719bSwdenk		Busybox) as command line interpreter, thus enabling
2453c609719bSwdenk		powerful command line syntax like
2454c609719bSwdenk		if...then...else...fi conditionals or `&&' and '||'
2455c609719bSwdenk		constructs ("shell scripts").
2456c609719bSwdenk
2457c609719bSwdenk		If undefined, you get the old, much simpler behaviour
2458c609719bSwdenk		with a somewhat smaller memory footprint.
2459c609719bSwdenk
2460c609719bSwdenk
24616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_PROMPT_HUSH_PS2
2462c609719bSwdenk
2463c609719bSwdenk		This defines the secondary prompt string, which is
2464c609719bSwdenk		printed when the command interpreter needs more input
2465c609719bSwdenk		to complete a command. Usually "> ".
2466c609719bSwdenk
2467c609719bSwdenk	Note:
2468c609719bSwdenk
2469c609719bSwdenk		In the current implementation, the local variables
2470c609719bSwdenk		space and global environment variables space are
2471c609719bSwdenk		separated. Local variables are those you define by
24723b57fe0aSwdenk		simply typing `name=value'. To access a local
2473c609719bSwdenk		variable later on, you have write `$name' or
24743b57fe0aSwdenk		`${name}'; to execute the contents of a variable
24753b57fe0aSwdenk		directly type `$name' at the command prompt.
2476c609719bSwdenk
2477c609719bSwdenk		Global environment variables are those you use
2478c609719bSwdenk		setenv/printenv to work with. To run a command stored
2479c609719bSwdenk		in such a variable, you need to use the run command,
2480c609719bSwdenk		and you must not use the '$' sign to access them.
2481c609719bSwdenk
2482c609719bSwdenk		To store commands and special characters in a
2483c609719bSwdenk		variable, please use double quotation marks
2484c609719bSwdenk		surrounding the whole text of the variable, instead
2485c609719bSwdenk		of the backslashes before semicolons and special
2486c609719bSwdenk		symbols.
2487c609719bSwdenk
2488aa0c71acSWolfgang Denk- Commandline Editing and History:
2489aa0c71acSWolfgang Denk		CONFIG_CMDLINE_EDITING
2490aa0c71acSWolfgang Denk
249111ccc33fSMarcel Ziswiler		Enable editing and History functions for interactive
2492aa0c71acSWolfgang Denk		commandline input operations
2493aa0c71acSWolfgang Denk
2494a8c7c708Swdenk- Default Environment:
2495c609719bSwdenk		CONFIG_EXTRA_ENV_SETTINGS
2496c609719bSwdenk
2497c609719bSwdenk		Define this to contain any number of null terminated
2498c609719bSwdenk		strings (variable = value pairs) that will be part of
24997152b1d0Swdenk		the default environment compiled into the boot image.
25002262cfeeSwdenk
2501c609719bSwdenk		For example, place something like this in your
2502c609719bSwdenk		board's config file:
2503c609719bSwdenk
2504c609719bSwdenk		#define CONFIG_EXTRA_ENV_SETTINGS \
2505c609719bSwdenk			"myvar1=value1\0" \
2506c609719bSwdenk			"myvar2=value2\0"
2507c609719bSwdenk
2508c609719bSwdenk		Warning: This method is based on knowledge about the
2509c609719bSwdenk		internal format how the environment is stored by the
25102262cfeeSwdenk		U-Boot code. This is NOT an official, exported
2511c609719bSwdenk		interface! Although it is unlikely that this format
25127152b1d0Swdenk		will change soon, there is no guarantee either.
2513c609719bSwdenk		You better know what you are doing here.
2514c609719bSwdenk
2515c609719bSwdenk		Note: overly (ab)use of the default environment is
2516c609719bSwdenk		discouraged. Make sure to check other ways to preset
251774de7aefSWolfgang Denk		the environment like the "source" command or the
2518c609719bSwdenk		boot command first.
2519c609719bSwdenk
25205e724ca2SStephen Warren		CONFIG_ENV_VARS_UBOOT_CONFIG
25215e724ca2SStephen Warren
25225e724ca2SStephen Warren		Define this in order to add variables describing the
25235e724ca2SStephen Warren		U-Boot build configuration to the default environment.
25245e724ca2SStephen Warren		These will be named arch, cpu, board, vendor, and soc.
25255e724ca2SStephen Warren
25265e724ca2SStephen Warren		Enabling this option will cause the following to be defined:
25275e724ca2SStephen Warren
25285e724ca2SStephen Warren		- CONFIG_SYS_ARCH
25295e724ca2SStephen Warren		- CONFIG_SYS_CPU
25305e724ca2SStephen Warren		- CONFIG_SYS_BOARD
25315e724ca2SStephen Warren		- CONFIG_SYS_VENDOR
25325e724ca2SStephen Warren		- CONFIG_SYS_SOC
25335e724ca2SStephen Warren
25347e27f89fSTom Rini		CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
25357e27f89fSTom Rini
25367e27f89fSTom Rini		Define this in order to add variables describing certain
25377e27f89fSTom Rini		run-time determined information about the hardware to the
25387e27f89fSTom Rini		environment.  These will be named board_name, board_rev.
25397e27f89fSTom Rini
254006fd8538SSimon Glass		CONFIG_DELAY_ENVIRONMENT
254106fd8538SSimon Glass
254206fd8538SSimon Glass		Normally the environment is loaded when the board is
254306fd8538SSimon Glass		intialised so that it is available to U-Boot. This inhibits
254406fd8538SSimon Glass		that so that the environment is not available until
254506fd8538SSimon Glass		explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
254606fd8538SSimon Glass		this is instead controlled by the value of
254706fd8538SSimon Glass		/config/load-environment.
254806fd8538SSimon Glass
2549a8c7c708Swdenk- DataFlash Support:
25502abbe075Swdenk		CONFIG_HAS_DATAFLASH
25512abbe075Swdenk
25522abbe075Swdenk		Defining this option enables DataFlash features and
25532abbe075Swdenk		allows to read/write in Dataflash via the standard
25542abbe075Swdenk		commands cp, md...
25552abbe075Swdenk
2556f61ec45eSEric Nelson- Serial Flash support
2557f61ec45eSEric Nelson		CONFIG_CMD_SF
2558f61ec45eSEric Nelson
2559f61ec45eSEric Nelson		Defining this option enables SPI flash commands
2560f61ec45eSEric Nelson		'sf probe/read/write/erase/update'.
2561f61ec45eSEric Nelson
2562f61ec45eSEric Nelson		Usage requires an initial 'probe' to define the serial
2563f61ec45eSEric Nelson		flash parameters, followed by read/write/erase/update
2564f61ec45eSEric Nelson		commands.
2565f61ec45eSEric Nelson
2566f61ec45eSEric Nelson		The following defaults may be provided by the platform
2567f61ec45eSEric Nelson		to handle the common case when only a single serial
2568f61ec45eSEric Nelson		flash is present on the system.
2569f61ec45eSEric Nelson
2570f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_BUS		Bus identifier
2571f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_CS		Chip-select
2572f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_MODE 		(see include/spi.h)
2573f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_SPEED		in Hz
2574f61ec45eSEric Nelson
257524007273SSimon Glass		CONFIG_CMD_SF_TEST
257624007273SSimon Glass
257724007273SSimon Glass		Define this option to include a destructive SPI flash
257824007273SSimon Glass		test ('sf test').
257924007273SSimon Glass
25801dcd6d03SJagannadha Sutradharudu Teki		CONFIG_SPI_FLASH_BAR		Ban/Extended Addr Reg
25811dcd6d03SJagannadha Sutradharudu Teki
25821dcd6d03SJagannadha Sutradharudu Teki		Define this option to use the Bank addr/Extended addr
25831dcd6d03SJagannadha Sutradharudu Teki		support on SPI flashes which has size > 16Mbytes.
25841dcd6d03SJagannadha Sutradharudu Teki
25853f85ce27Swdenk- SystemACE Support:
25863f85ce27Swdenk		CONFIG_SYSTEMACE
25873f85ce27Swdenk
25883f85ce27Swdenk		Adding this option adds support for Xilinx SystemACE
25893f85ce27Swdenk		chips attached via some sort of local bus. The address
259011ccc33fSMarcel Ziswiler		of the chip must also be defined in the
25916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SYSTEMACE_BASE macro. For example:
25923f85ce27Swdenk
25933f85ce27Swdenk		#define CONFIG_SYSTEMACE
25946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
25953f85ce27Swdenk
25963f85ce27Swdenk		When SystemACE support is added, the "ace" device type
25973f85ce27Swdenk		becomes available to the fat commands, i.e. fatls.
25983f85ce27Swdenk
2599ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port:
2600ecb0ccd9SWolfgang Denk		CONFIG_TFTP_PORT
2601ecb0ccd9SWolfgang Denk
260228cb9375SWolfgang Denk		If this is defined, the environment variable tftpsrcp
2603ecb0ccd9SWolfgang Denk		is used to supply the TFTP UDP source port value.
260428cb9375SWolfgang Denk		If tftpsrcp isn't defined, the normal pseudo-random port
2605ecb0ccd9SWolfgang Denk		number generator is used.
2606ecb0ccd9SWolfgang Denk
260728cb9375SWolfgang Denk		Also, the environment variable tftpdstp is used to supply
260828cb9375SWolfgang Denk		the TFTP UDP destination port value.  If tftpdstp isn't
260928cb9375SWolfgang Denk		defined, the normal port 69 is used.
261028cb9375SWolfgang Denk
261128cb9375SWolfgang Denk		The purpose for tftpsrcp is to allow a TFTP server to
2612ecb0ccd9SWolfgang Denk		blindly start the TFTP transfer using the pre-configured
2613ecb0ccd9SWolfgang Denk		target IP address and UDP port. This has the effect of
2614ecb0ccd9SWolfgang Denk		"punching through" the (Windows XP) firewall, allowing
2615ecb0ccd9SWolfgang Denk		the remainder of the TFTP transfer to proceed normally.
2616ecb0ccd9SWolfgang Denk		A better solution is to properly configure the firewall,
2617ecb0ccd9SWolfgang Denk		but sometimes that is not allowed.
2618ecb0ccd9SWolfgang Denk
2619bf36c5d5SSimon Glass- Hashing support:
2620bf36c5d5SSimon Glass		CONFIG_CMD_HASH
2621bf36c5d5SSimon Glass
2622bf36c5d5SSimon Glass		This enables a generic 'hash' command which can produce
2623bf36c5d5SSimon Glass		hashes / digests from a few algorithms (e.g. SHA1, SHA256).
2624bf36c5d5SSimon Glass
2625bf36c5d5SSimon Glass		CONFIG_HASH_VERIFY
2626bf36c5d5SSimon Glass
2627bf36c5d5SSimon Glass		Enable the hash verify command (hash -v). This adds to code
2628bf36c5d5SSimon Glass		size a little.
2629bf36c5d5SSimon Glass
2630bf36c5d5SSimon Glass		CONFIG_SHA1 - support SHA1 hashing
2631bf36c5d5SSimon Glass		CONFIG_SHA256 - support SHA256 hashing
2632bf36c5d5SSimon Glass
2633bf36c5d5SSimon Glass		Note: There is also a sha1sum command, which should perhaps
2634bf36c5d5SSimon Glass		be deprecated in favour of 'hash sha1'.
2635bf36c5d5SSimon Glass
263619c402afSSimon Glass- Signing support:
263719c402afSSimon Glass		CONFIG_RSA
263819c402afSSimon Glass
263919c402afSSimon Glass		This enables the RSA algorithm used for FIT image verification
264019c402afSSimon Glass		in U-Boot. See doc/uImage/signature for more information.
264119c402afSSimon Glass
264219c402afSSimon Glass		The signing part is build into mkimage regardless of this
264319c402afSSimon Glass		option.
264419c402afSSimon Glass
264519c402afSSimon Glass
2646a8c7c708Swdenk- Show boot progress:
2647c609719bSwdenk		CONFIG_SHOW_BOOT_PROGRESS
2648c609719bSwdenk
2649c609719bSwdenk		Defining this option allows to add some board-
2650c609719bSwdenk		specific code (calling a user-provided function
2651c609719bSwdenk		"show_boot_progress(int)") that enables you to show
2652c609719bSwdenk		the system's boot progress on some display (for
2653c609719bSwdenk		example, some LED's) on your board. At the moment,
2654c609719bSwdenk		the following checkpoints are implemented:
2655c609719bSwdenk
26563a608ca0SSimon Glass- Detailed boot stage timing
26573a608ca0SSimon Glass		CONFIG_BOOTSTAGE
26583a608ca0SSimon Glass		Define this option to get detailed timing of each stage
26593a608ca0SSimon Glass		of the boot process.
26603a608ca0SSimon Glass
26613a608ca0SSimon Glass		CONFIG_BOOTSTAGE_USER_COUNT
26623a608ca0SSimon Glass		This is the number of available user bootstage records.
26633a608ca0SSimon Glass		Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
26643a608ca0SSimon Glass		a new ID will be allocated from this stash. If you exceed
26653a608ca0SSimon Glass		the limit, recording will stop.
26663a608ca0SSimon Glass
26673a608ca0SSimon Glass		CONFIG_BOOTSTAGE_REPORT
26683a608ca0SSimon Glass		Define this to print a report before boot, similar to this:
26693a608ca0SSimon Glass
26703a608ca0SSimon Glass		Timer summary in microseconds:
26713a608ca0SSimon Glass		       Mark    Elapsed  Stage
26723a608ca0SSimon Glass			  0          0  reset
26733a608ca0SSimon Glass		  3,575,678  3,575,678  board_init_f start
26743a608ca0SSimon Glass		  3,575,695         17  arch_cpu_init A9
26753a608ca0SSimon Glass		  3,575,777         82  arch_cpu_init done
26763a608ca0SSimon Glass		  3,659,598     83,821  board_init_r start
26773a608ca0SSimon Glass		  3,910,375    250,777  main_loop
26783a608ca0SSimon Glass		 29,916,167 26,005,792  bootm_start
26793a608ca0SSimon Glass		 30,361,327    445,160  start_kernel
26803a608ca0SSimon Glass
26812eba38cfSSimon Glass		CONFIG_CMD_BOOTSTAGE
26822eba38cfSSimon Glass		Add a 'bootstage' command which supports printing a report
26832eba38cfSSimon Glass		and un/stashing of bootstage data.
26842eba38cfSSimon Glass
268594fd1316SSimon Glass		CONFIG_BOOTSTAGE_FDT
268694fd1316SSimon Glass		Stash the bootstage information in the FDT. A root 'bootstage'
268794fd1316SSimon Glass		node is created with each bootstage id as a child. Each child
268894fd1316SSimon Glass		has a 'name' property and either 'mark' containing the
268994fd1316SSimon Glass		mark time in microsecond, or 'accum' containing the
269094fd1316SSimon Glass		accumulated time for that bootstage id in microseconds.
269194fd1316SSimon Glass		For example:
269294fd1316SSimon Glass
269394fd1316SSimon Glass		bootstage {
269494fd1316SSimon Glass			154 {
269594fd1316SSimon Glass				name = "board_init_f";
269694fd1316SSimon Glass				mark = <3575678>;
269794fd1316SSimon Glass			};
269894fd1316SSimon Glass			170 {
269994fd1316SSimon Glass				name = "lcd";
270094fd1316SSimon Glass				accum = <33482>;
270194fd1316SSimon Glass			};
270294fd1316SSimon Glass		};
270394fd1316SSimon Glass
270494fd1316SSimon Glass		Code in the Linux kernel can find this in /proc/devicetree.
270594fd1316SSimon Glass
27061372cce2SMarian BalakowiczLegacy uImage format:
27071372cce2SMarian Balakowicz
2708c609719bSwdenk  Arg	Where			When
2709c609719bSwdenk    1	common/cmd_bootm.c	before attempting to boot an image
2710c609719bSwdenk   -1	common/cmd_bootm.c	Image header has bad	 magic number
2711c609719bSwdenk    2	common/cmd_bootm.c	Image header has correct magic number
2712c609719bSwdenk   -2	common/cmd_bootm.c	Image header has bad	 checksum
2713c609719bSwdenk    3	common/cmd_bootm.c	Image header has correct checksum
2714c609719bSwdenk   -3	common/cmd_bootm.c	Image data   has bad	 checksum
2715c609719bSwdenk    4	common/cmd_bootm.c	Image data   has correct checksum
2716c609719bSwdenk   -4	common/cmd_bootm.c	Image is for unsupported architecture
2717c609719bSwdenk    5	common/cmd_bootm.c	Architecture check OK
27181372cce2SMarian Balakowicz   -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi)
2719c609719bSwdenk    6	common/cmd_bootm.c	Image Type check OK
2720c609719bSwdenk   -6	common/cmd_bootm.c	gunzip uncompression error
2721c609719bSwdenk   -7	common/cmd_bootm.c	Unimplemented compression type
2722c609719bSwdenk    7	common/cmd_bootm.c	Uncompression OK
27231372cce2SMarian Balakowicz    8	common/cmd_bootm.c	No uncompress/copy overwrite error
2724c609719bSwdenk   -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
27251372cce2SMarian Balakowicz
27261372cce2SMarian Balakowicz    9	common/image.c		Start initial ramdisk verification
27271372cce2SMarian Balakowicz  -10	common/image.c		Ramdisk header has bad	   magic number
27281372cce2SMarian Balakowicz  -11	common/image.c		Ramdisk header has bad	   checksum
27291372cce2SMarian Balakowicz   10	common/image.c		Ramdisk header is OK
27301372cce2SMarian Balakowicz  -12	common/image.c		Ramdisk data   has bad	   checksum
27311372cce2SMarian Balakowicz   11	common/image.c		Ramdisk data   has correct checksum
27321372cce2SMarian Balakowicz   12	common/image.c		Ramdisk verification complete, start loading
273311ccc33fSMarcel Ziswiler  -13	common/image.c		Wrong Image Type (not PPC Linux ramdisk)
27341372cce2SMarian Balakowicz   13	common/image.c		Start multifile image verification
27351372cce2SMarian Balakowicz   14	common/image.c		No initial ramdisk, no multifile, continue.
27361372cce2SMarian Balakowicz
2737ea0364f1SPeter Tyser   15	arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
2738c609719bSwdenk
2739a47a12beSStefan Roese  -30	arch/powerpc/lib/board.c	Fatal error, hang the system
274063e73c9aSwdenk  -31	post/post.c		POST test failed, detected by post_output_backlog()
274163e73c9aSwdenk  -32	post/post.c		POST test failed, detected by post_run_single()
274263e73c9aSwdenk
2743566a494fSHeiko Schocher   34	common/cmd_doc.c	before loading a Image from a DOC device
2744566a494fSHeiko Schocher  -35	common/cmd_doc.c	Bad usage of "doc" command
2745566a494fSHeiko Schocher   35	common/cmd_doc.c	correct usage of "doc" command
2746566a494fSHeiko Schocher  -36	common/cmd_doc.c	No boot device
2747566a494fSHeiko Schocher   36	common/cmd_doc.c	correct boot device
2748566a494fSHeiko Schocher  -37	common/cmd_doc.c	Unknown Chip ID on boot device
2749566a494fSHeiko Schocher   37	common/cmd_doc.c	correct chip ID found, device available
2750566a494fSHeiko Schocher  -38	common/cmd_doc.c	Read Error on boot device
2751566a494fSHeiko Schocher   38	common/cmd_doc.c	reading Image header from DOC device OK
2752566a494fSHeiko Schocher  -39	common/cmd_doc.c	Image header has bad magic number
2753566a494fSHeiko Schocher   39	common/cmd_doc.c	Image header has correct magic number
2754566a494fSHeiko Schocher  -40	common/cmd_doc.c	Error reading Image from DOC device
2755566a494fSHeiko Schocher   40	common/cmd_doc.c	Image header has correct magic number
2756566a494fSHeiko Schocher   41	common/cmd_ide.c	before loading a Image from a IDE device
2757566a494fSHeiko Schocher  -42	common/cmd_ide.c	Bad usage of "ide" command
2758566a494fSHeiko Schocher   42	common/cmd_ide.c	correct usage of "ide" command
2759566a494fSHeiko Schocher  -43	common/cmd_ide.c	No boot device
2760566a494fSHeiko Schocher   43	common/cmd_ide.c	boot device found
2761566a494fSHeiko Schocher  -44	common/cmd_ide.c	Device not available
2762566a494fSHeiko Schocher   44	common/cmd_ide.c	Device available
2763566a494fSHeiko Schocher  -45	common/cmd_ide.c	wrong partition selected
2764566a494fSHeiko Schocher   45	common/cmd_ide.c	partition selected
2765566a494fSHeiko Schocher  -46	common/cmd_ide.c	Unknown partition table
2766566a494fSHeiko Schocher   46	common/cmd_ide.c	valid partition table found
2767566a494fSHeiko Schocher  -47	common/cmd_ide.c	Invalid partition type
2768566a494fSHeiko Schocher   47	common/cmd_ide.c	correct partition type
2769566a494fSHeiko Schocher  -48	common/cmd_ide.c	Error reading Image Header on boot device
2770566a494fSHeiko Schocher   48	common/cmd_ide.c	reading Image Header from IDE device OK
2771566a494fSHeiko Schocher  -49	common/cmd_ide.c	Image header has bad magic number
2772566a494fSHeiko Schocher   49	common/cmd_ide.c	Image header has correct magic number
2773566a494fSHeiko Schocher  -50	common/cmd_ide.c	Image header has bad	 checksum
2774566a494fSHeiko Schocher   50	common/cmd_ide.c	Image header has correct checksum
2775566a494fSHeiko Schocher  -51	common/cmd_ide.c	Error reading Image from IDE device
2776566a494fSHeiko Schocher   51	common/cmd_ide.c	reading Image from IDE device OK
2777566a494fSHeiko Schocher   52	common/cmd_nand.c	before loading a Image from a NAND device
2778566a494fSHeiko Schocher  -53	common/cmd_nand.c	Bad usage of "nand" command
2779566a494fSHeiko Schocher   53	common/cmd_nand.c	correct usage of "nand" command
2780566a494fSHeiko Schocher  -54	common/cmd_nand.c	No boot device
2781566a494fSHeiko Schocher   54	common/cmd_nand.c	boot device found
2782566a494fSHeiko Schocher  -55	common/cmd_nand.c	Unknown Chip ID on boot device
2783566a494fSHeiko Schocher   55	common/cmd_nand.c	correct chip ID found, device available
2784566a494fSHeiko Schocher  -56	common/cmd_nand.c	Error reading Image Header on boot device
2785566a494fSHeiko Schocher   56	common/cmd_nand.c	reading Image Header from NAND device OK
2786566a494fSHeiko Schocher  -57	common/cmd_nand.c	Image header has bad magic number
2787566a494fSHeiko Schocher   57	common/cmd_nand.c	Image header has correct magic number
2788566a494fSHeiko Schocher  -58	common/cmd_nand.c	Error reading Image from NAND device
2789566a494fSHeiko Schocher   58	common/cmd_nand.c	reading Image from NAND device OK
2790c609719bSwdenk
2791566a494fSHeiko Schocher  -60	common/env_common.c	Environment has a bad CRC, using default
2792c609719bSwdenk
2793566a494fSHeiko Schocher   64	net/eth.c		starting with Ethernet configuration.
2794566a494fSHeiko Schocher  -64	net/eth.c		no Ethernet found.
2795566a494fSHeiko Schocher   65	net/eth.c		Ethernet found.
2796206c60cbSwdenk
2797566a494fSHeiko Schocher  -80	common/cmd_net.c	usage wrong
2798566a494fSHeiko Schocher   80	common/cmd_net.c	before calling NetLoop()
279911ccc33fSMarcel Ziswiler  -81	common/cmd_net.c	some error in NetLoop() occurred
2800566a494fSHeiko Schocher   81	common/cmd_net.c	NetLoop() back without error
2801566a494fSHeiko Schocher  -82	common/cmd_net.c	size == 0 (File with size 0 loaded)
2802566a494fSHeiko Schocher   82	common/cmd_net.c	trying automatic boot
280374de7aefSWolfgang Denk   83	common/cmd_net.c	running "source" command
280474de7aefSWolfgang Denk  -83	common/cmd_net.c	some error in automatic boot or "source" command
2805566a494fSHeiko Schocher   84	common/cmd_net.c	end without errors
2806c609719bSwdenk
28071372cce2SMarian BalakowiczFIT uImage format:
28081372cce2SMarian Balakowicz
28091372cce2SMarian Balakowicz  Arg	Where			When
28101372cce2SMarian Balakowicz  100	common/cmd_bootm.c	Kernel FIT Image has correct format
28111372cce2SMarian Balakowicz -100	common/cmd_bootm.c	Kernel FIT Image has incorrect format
28121372cce2SMarian Balakowicz  101	common/cmd_bootm.c	No Kernel subimage unit name, using configuration
28131372cce2SMarian Balakowicz -101	common/cmd_bootm.c	Can't get configuration for kernel subimage
28141372cce2SMarian Balakowicz  102	common/cmd_bootm.c	Kernel unit name specified
28151372cce2SMarian Balakowicz -103	common/cmd_bootm.c	Can't get kernel subimage node offset
2816f773bea8SMarian Balakowicz  103	common/cmd_bootm.c	Found configuration node
28171372cce2SMarian Balakowicz  104	common/cmd_bootm.c	Got kernel subimage node offset
28181372cce2SMarian Balakowicz -104	common/cmd_bootm.c	Kernel subimage hash verification failed
28191372cce2SMarian Balakowicz  105	common/cmd_bootm.c	Kernel subimage hash verification OK
28201372cce2SMarian Balakowicz -105	common/cmd_bootm.c	Kernel subimage is for unsupported architecture
28211372cce2SMarian Balakowicz  106	common/cmd_bootm.c	Architecture check OK
282211ccc33fSMarcel Ziswiler -106	common/cmd_bootm.c	Kernel subimage has wrong type
282311ccc33fSMarcel Ziswiler  107	common/cmd_bootm.c	Kernel subimage type OK
28241372cce2SMarian Balakowicz -107	common/cmd_bootm.c	Can't get kernel subimage data/size
28251372cce2SMarian Balakowicz  108	common/cmd_bootm.c	Got kernel subimage data/size
28261372cce2SMarian Balakowicz -108	common/cmd_bootm.c	Wrong image type (not legacy, FIT)
28271372cce2SMarian Balakowicz -109	common/cmd_bootm.c	Can't get kernel subimage type
28281372cce2SMarian Balakowicz -110	common/cmd_bootm.c	Can't get kernel subimage comp
28291372cce2SMarian Balakowicz -111	common/cmd_bootm.c	Can't get kernel subimage os
28301372cce2SMarian Balakowicz -112	common/cmd_bootm.c	Can't get kernel subimage load address
28311372cce2SMarian Balakowicz -113	common/cmd_bootm.c	Image uncompress/copy overwrite error
28321372cce2SMarian Balakowicz
28331372cce2SMarian Balakowicz  120	common/image.c		Start initial ramdisk verification
28341372cce2SMarian Balakowicz -120	common/image.c		Ramdisk FIT image has incorrect format
28351372cce2SMarian Balakowicz  121	common/image.c		Ramdisk FIT image has correct format
283611ccc33fSMarcel Ziswiler  122	common/image.c		No ramdisk subimage unit name, using configuration
28371372cce2SMarian Balakowicz -122	common/image.c		Can't get configuration for ramdisk subimage
28381372cce2SMarian Balakowicz  123	common/image.c		Ramdisk unit name specified
28391372cce2SMarian Balakowicz -124	common/image.c		Can't get ramdisk subimage node offset
28401372cce2SMarian Balakowicz  125	common/image.c		Got ramdisk subimage node offset
28411372cce2SMarian Balakowicz -125	common/image.c		Ramdisk subimage hash verification failed
28421372cce2SMarian Balakowicz  126	common/image.c		Ramdisk subimage hash verification OK
28431372cce2SMarian Balakowicz -126	common/image.c		Ramdisk subimage for unsupported architecture
28441372cce2SMarian Balakowicz  127	common/image.c		Architecture check OK
28451372cce2SMarian Balakowicz -127	common/image.c		Can't get ramdisk subimage data/size
28461372cce2SMarian Balakowicz  128	common/image.c		Got ramdisk subimage data/size
28471372cce2SMarian Balakowicz  129	common/image.c		Can't get ramdisk load address
28481372cce2SMarian Balakowicz -129	common/image.c		Got ramdisk load address
28491372cce2SMarian Balakowicz
285011ccc33fSMarcel Ziswiler -130	common/cmd_doc.c	Incorrect FIT image format
28511372cce2SMarian Balakowicz  131	common/cmd_doc.c	FIT image format OK
28521372cce2SMarian Balakowicz
285311ccc33fSMarcel Ziswiler -140	common/cmd_ide.c	Incorrect FIT image format
28541372cce2SMarian Balakowicz  141	common/cmd_ide.c	FIT image format OK
28551372cce2SMarian Balakowicz
285611ccc33fSMarcel Ziswiler -150	common/cmd_nand.c	Incorrect FIT image format
28571372cce2SMarian Balakowicz  151	common/cmd_nand.c	FIT image format OK
28581372cce2SMarian Balakowicz
2859d95f6ec7SGabe Black- FIT image support:
2860d95f6ec7SGabe Black		CONFIG_FIT
2861d95f6ec7SGabe Black		Enable support for the FIT uImage format.
2862d95f6ec7SGabe Black
2863d95f6ec7SGabe Black		CONFIG_FIT_BEST_MATCH
2864d95f6ec7SGabe Black		When no configuration is explicitly selected, default to the
2865d95f6ec7SGabe Black		one whose fdt's compatibility field best matches that of
2866d95f6ec7SGabe Black		U-Boot itself. A match is considered "best" if it matches the
2867d95f6ec7SGabe Black		most specific compatibility entry of U-Boot's fdt's root node.
2868d95f6ec7SGabe Black		The order of entries in the configuration's fdt is ignored.
2869d95f6ec7SGabe Black
28703e569a6bSSimon Glass		CONFIG_FIT_SIGNATURE
28713e569a6bSSimon Glass		This option enables signature verification of FIT uImages,
28723e569a6bSSimon Glass		using a hash signed and verified using RSA. See
28733e569a6bSSimon Glass		doc/uImage.FIT/signature.txt for more details.
28743e569a6bSSimon Glass
28754cf2609bSWolfgang Denk- Standalone program support:
28764cf2609bSWolfgang Denk		CONFIG_STANDALONE_LOAD_ADDR
28774cf2609bSWolfgang Denk
28786feff899SWolfgang Denk		This option defines a board specific value for the
28796feff899SWolfgang Denk		address where standalone program gets loaded, thus
28806feff899SWolfgang Denk		overwriting the architecture dependent default
28814cf2609bSWolfgang Denk		settings.
28824cf2609bSWolfgang Denk
28834cf2609bSWolfgang Denk- Frame Buffer Address:
28844cf2609bSWolfgang Denk		CONFIG_FB_ADDR
28854cf2609bSWolfgang Denk
28864cf2609bSWolfgang Denk		Define CONFIG_FB_ADDR if you want to use specific
288744a53b57SWolfgang Denk		address for frame buffer.  This is typically the case
288844a53b57SWolfgang Denk		when using a graphics controller has separate video
288944a53b57SWolfgang Denk		memory.  U-Boot will then place the frame buffer at
289044a53b57SWolfgang Denk		the given address instead of dynamically reserving it
289144a53b57SWolfgang Denk		in system RAM by calling lcd_setmem(), which grabs
289244a53b57SWolfgang Denk		the memory for the frame buffer depending on the
289344a53b57SWolfgang Denk		configured panel size.
28944cf2609bSWolfgang Denk
28954cf2609bSWolfgang Denk		Please see board_init_f function.
28964cf2609bSWolfgang Denk
2897cccfc2abSDetlev Zundel- Automatic software updates via TFTP server
2898cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP
2899cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_CNT_MAX
2900cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_MSEC_MAX
2901cccfc2abSDetlev Zundel
2902cccfc2abSDetlev Zundel		These options enable and control the auto-update feature;
2903cccfc2abSDetlev Zundel		for a more detailed description refer to doc/README.update.
2904cccfc2abSDetlev Zundel
2905cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support)
2906cccfc2abSDetlev Zundel		CONFIG_MTD_DEVICE
2907cccfc2abSDetlev Zundel
2908cccfc2abSDetlev Zundel		Adds the MTD device infrastructure from the Linux kernel.
2909cccfc2abSDetlev Zundel		Needed for mtdparts command support.
2910cccfc2abSDetlev Zundel
2911cccfc2abSDetlev Zundel		CONFIG_MTD_PARTITIONS
2912cccfc2abSDetlev Zundel
2913cccfc2abSDetlev Zundel		Adds the MTD partitioning infrastructure from the Linux
2914cccfc2abSDetlev Zundel		kernel. Needed for UBI support.
2915cccfc2abSDetlev Zundel
291670c219cdSJoe Hershberger- UBI support
291770c219cdSJoe Hershberger		CONFIG_CMD_UBI
291870c219cdSJoe Hershberger
291970c219cdSJoe Hershberger		Adds commands for interacting with MTD partitions formatted
292070c219cdSJoe Hershberger		with the UBI flash translation layer
292170c219cdSJoe Hershberger
292270c219cdSJoe Hershberger		Requires also defining CONFIG_RBTREE
292370c219cdSJoe Hershberger
2924147162daSJoe Hershberger		CONFIG_UBI_SILENCE_MSG
2925147162daSJoe Hershberger
2926147162daSJoe Hershberger		Make the verbose messages from UBI stop printing.  This leaves
2927147162daSJoe Hershberger		warnings and errors enabled.
2928147162daSJoe Hershberger
292970c219cdSJoe Hershberger- UBIFS support
293070c219cdSJoe Hershberger		CONFIG_CMD_UBIFS
293170c219cdSJoe Hershberger
293270c219cdSJoe Hershberger		Adds commands for interacting with UBI volumes formatted as
293370c219cdSJoe Hershberger		UBIFS.  UBIFS is read-only in u-boot.
293470c219cdSJoe Hershberger
293570c219cdSJoe Hershberger		Requires UBI support as well as CONFIG_LZO
293670c219cdSJoe Hershberger
2937147162daSJoe Hershberger		CONFIG_UBIFS_SILENCE_MSG
2938147162daSJoe Hershberger
2939147162daSJoe Hershberger		Make the verbose messages from UBIFS stop printing.  This leaves
2940147162daSJoe Hershberger		warnings and errors enabled.
2941147162daSJoe Hershberger
29426a11cf48SDaniel Schwierzeck- SPL framework
29436a11cf48SDaniel Schwierzeck		CONFIG_SPL
29446a11cf48SDaniel Schwierzeck		Enable building of SPL globally.
29456a11cf48SDaniel Schwierzeck
294695579793STom Rini		CONFIG_SPL_LDSCRIPT
294795579793STom Rini		LDSCRIPT for linking the SPL binary.
294895579793STom Rini
29496ebc3461SAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT
29506ebc3461SAlbert ARIBAUD		Maximum size in memory allocated to the SPL, BSS included.
29516ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual memory
29526ebc3461SAlbert ARIBAUD		used by SPL from _start to __bss_end does not exceed it.
29538960af8bSAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
29546ebc3461SAlbert ARIBAUD		must not be both defined at the same time.
29556ebc3461SAlbert ARIBAUD
295695579793STom Rini		CONFIG_SPL_MAX_SIZE
29576ebc3461SAlbert ARIBAUD		Maximum size of the SPL image (text, data, rodata, and
29586ebc3461SAlbert ARIBAUD		linker lists sections), BSS excluded.
29596ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual size does
29606ebc3461SAlbert ARIBAUD		not exceed it.
296195579793STom Rini
29626a11cf48SDaniel Schwierzeck		CONFIG_SPL_TEXT_BASE
29636a11cf48SDaniel Schwierzeck		TEXT_BASE for linking the SPL binary.
29646a11cf48SDaniel Schwierzeck
296594a45bb1SScott Wood		CONFIG_SPL_RELOC_TEXT_BASE
296694a45bb1SScott Wood		Address to relocate to.  If unspecified, this is equal to
296794a45bb1SScott Wood		CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
296894a45bb1SScott Wood
296995579793STom Rini		CONFIG_SPL_BSS_START_ADDR
297095579793STom Rini		Link address for the BSS within the SPL binary.
297195579793STom Rini
297295579793STom Rini		CONFIG_SPL_BSS_MAX_SIZE
29736ebc3461SAlbert ARIBAUD		Maximum size in memory allocated to the SPL BSS.
29746ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual memory used
29756ebc3461SAlbert ARIBAUD		by SPL from __bss_start to __bss_end does not exceed it.
29768960af8bSAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
29776ebc3461SAlbert ARIBAUD		must not be both defined at the same time.
297895579793STom Rini
297995579793STom Rini		CONFIG_SPL_STACK
298095579793STom Rini		Adress of the start of the stack SPL will use
298195579793STom Rini
298294a45bb1SScott Wood		CONFIG_SPL_RELOC_STACK
298394a45bb1SScott Wood		Adress of the start of the stack SPL will use after
298494a45bb1SScott Wood		relocation.  If unspecified, this is equal to
298594a45bb1SScott Wood		CONFIG_SPL_STACK.
298694a45bb1SScott Wood
298795579793STom Rini		CONFIG_SYS_SPL_MALLOC_START
298895579793STom Rini		Starting address of the malloc pool used in SPL.
298995579793STom Rini
299095579793STom Rini		CONFIG_SYS_SPL_MALLOC_SIZE
299195579793STom Rini		The size of the malloc pool used in SPL.
29926a11cf48SDaniel Schwierzeck
299347f7bcaeSTom Rini		CONFIG_SPL_FRAMEWORK
299447f7bcaeSTom Rini		Enable the SPL framework under common/.  This framework
299547f7bcaeSTom Rini		supports MMC, NAND and YMODEM loading of U-Boot and NAND
299647f7bcaeSTom Rini		NAND loading of the Linux Kernel.
299747f7bcaeSTom Rini
2998861a86f4STom Rini		CONFIG_SPL_DISPLAY_PRINT
2999861a86f4STom Rini		For ARM, enable an optional function to print more information
3000861a86f4STom Rini		about the running system.
3001861a86f4STom Rini
30024b919725SScott Wood		CONFIG_SPL_INIT_MINIMAL
30034b919725SScott Wood		Arch init code should be built for a very small image
30044b919725SScott Wood
30056a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBCOMMON_SUPPORT
30066a11cf48SDaniel Schwierzeck		Support for common/libcommon.o in SPL binary
30076a11cf48SDaniel Schwierzeck
30086a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBDISK_SUPPORT
30096a11cf48SDaniel Schwierzeck		Support for disk/libdisk.o in SPL binary
30106a11cf48SDaniel Schwierzeck
30116a11cf48SDaniel Schwierzeck		CONFIG_SPL_I2C_SUPPORT
30126a11cf48SDaniel Schwierzeck		Support for drivers/i2c/libi2c.o in SPL binary
30136a11cf48SDaniel Schwierzeck
30146a11cf48SDaniel Schwierzeck		CONFIG_SPL_GPIO_SUPPORT
30156a11cf48SDaniel Schwierzeck		Support for drivers/gpio/libgpio.o in SPL binary
30166a11cf48SDaniel Schwierzeck
30176a11cf48SDaniel Schwierzeck		CONFIG_SPL_MMC_SUPPORT
30186a11cf48SDaniel Schwierzeck		Support for drivers/mmc/libmmc.o in SPL binary
30196a11cf48SDaniel Schwierzeck
302095579793STom Rini		CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
302195579793STom Rini		CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
302295579793STom Rini		CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION
302395579793STom Rini		Address, size and partition on the MMC to load U-Boot from
302495579793STom Rini		when the MMC is being used in raw mode.
302595579793STom Rini
30262b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
30272b75b0adSPeter Korsgaard		Sector to load kernel uImage from when MMC is being
30282b75b0adSPeter Korsgaard		used in raw mode (for Falcon mode)
30292b75b0adSPeter Korsgaard
30302b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
30312b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
30322b75b0adSPeter Korsgaard		Sector and number of sectors to load kernel argument
30332b75b0adSPeter Korsgaard		parameters from when MMC is being used in raw mode
30342b75b0adSPeter Korsgaard		(for falcon mode)
30352b75b0adSPeter Korsgaard
303695579793STom Rini		CONFIG_SPL_FAT_SUPPORT
303795579793STom Rini		Support for fs/fat/libfat.o in SPL binary
303895579793STom Rini
303995579793STom Rini		CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME
304095579793STom Rini		Filename to read to load U-Boot when reading from FAT
304195579793STom Rini
30427ad2cc79SPeter Korsgaard		CONFIG_SPL_FAT_LOAD_KERNEL_NAME
30437ad2cc79SPeter Korsgaard		Filename to read to load kernel uImage when reading
30447ad2cc79SPeter Korsgaard		from FAT (for Falcon mode)
30457ad2cc79SPeter Korsgaard
30467ad2cc79SPeter Korsgaard		CONFIG_SPL_FAT_LOAD_ARGS_NAME
30477ad2cc79SPeter Korsgaard		Filename to read to load kernel argument parameters
30487ad2cc79SPeter Korsgaard		when reading from FAT (for Falcon mode)
30497ad2cc79SPeter Korsgaard
305006f60ae3SScott Wood		CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
305106f60ae3SScott Wood		Set this for NAND SPL on PPC mpc83xx targets, so that
305206f60ae3SScott Wood		start.S waits for the rest of the SPL to load before
305306f60ae3SScott Wood		continuing (the hardware starts execution after just
305406f60ae3SScott Wood		loading the first page rather than the full 4K).
305506f60ae3SScott Wood
30566f2f01b9SScott Wood		CONFIG_SPL_NAND_BASE
30576f2f01b9SScott Wood		Include nand_base.c in the SPL.  Requires
30586f2f01b9SScott Wood		CONFIG_SPL_NAND_DRIVERS.
30596f2f01b9SScott Wood
30606f2f01b9SScott Wood		CONFIG_SPL_NAND_DRIVERS
30616f2f01b9SScott Wood		SPL uses normal NAND drivers, not minimal drivers.
30626f2f01b9SScott Wood
30636f2f01b9SScott Wood		CONFIG_SPL_NAND_ECC
30646f2f01b9SScott Wood		Include standard software ECC in the SPL
30656f2f01b9SScott Wood
306695579793STom Rini		CONFIG_SPL_NAND_SIMPLE
30677d4b7955SScott Wood		Support for NAND boot using simple NAND drivers that
30687d4b7955SScott Wood		expose the cmd_ctrl() interface.
306995579793STom Rini
307095579793STom Rini		CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
307195579793STom Rini		CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
307295579793STom Rini		CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
307395579793STom Rini		CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
307495579793STom Rini		CONFIG_SYS_NAND_ECCBYTES
307595579793STom Rini		Defines the size and behavior of the NAND that SPL uses
30767d4b7955SScott Wood		to read U-Boot
307795579793STom Rini
307895579793STom Rini		CONFIG_SYS_NAND_U_BOOT_OFFS
30797d4b7955SScott Wood		Location in NAND to read U-Boot from
30807d4b7955SScott Wood
30817d4b7955SScott Wood		CONFIG_SYS_NAND_U_BOOT_DST
30827d4b7955SScott Wood		Location in memory to load U-Boot to
30837d4b7955SScott Wood
30847d4b7955SScott Wood		CONFIG_SYS_NAND_U_BOOT_SIZE
30857d4b7955SScott Wood		Size of image to load
308695579793STom Rini
308795579793STom Rini		CONFIG_SYS_NAND_U_BOOT_START
30887d4b7955SScott Wood		Entry point in loaded image to jump to
308995579793STom Rini
309095579793STom Rini		CONFIG_SYS_NAND_HW_ECC_OOBFIRST
309195579793STom Rini		Define this if you need to first read the OOB and then the
309295579793STom Rini		data. This is used for example on davinci plattforms.
309395579793STom Rini
309495579793STom Rini		CONFIG_SPL_OMAP3_ID_NAND
309595579793STom Rini		Support for an OMAP3-specific set of functions to return the
309695579793STom Rini		ID and MFR of the first attached NAND chip, if present.
309795579793STom Rini
30986a11cf48SDaniel Schwierzeck		CONFIG_SPL_SERIAL_SUPPORT
30996a11cf48SDaniel Schwierzeck		Support for drivers/serial/libserial.o in SPL binary
31006a11cf48SDaniel Schwierzeck
31016a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_FLASH_SUPPORT
31026a11cf48SDaniel Schwierzeck		Support for drivers/mtd/spi/libspi_flash.o in SPL binary
31036a11cf48SDaniel Schwierzeck
31046a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_SUPPORT
31056a11cf48SDaniel Schwierzeck		Support for drivers/spi/libspi.o in SPL binary
31066a11cf48SDaniel Schwierzeck
3107c57b953dSPavel Machek		CONFIG_SPL_RAM_DEVICE
3108c57b953dSPavel Machek		Support for running image already present in ram, in SPL binary
3109c57b953dSPavel Machek
31106a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBGENERIC_SUPPORT
31116a11cf48SDaniel Schwierzeck		Support for lib/libgeneric.o in SPL binary
31121372cce2SMarian Balakowicz
3113ba1bee43SYing Zhang		CONFIG_SPL_ENV_SUPPORT
3114ba1bee43SYing Zhang		Support for the environment operating in SPL binary
3115ba1bee43SYing Zhang
3116ba1bee43SYing Zhang		CONFIG_SPL_NET_SUPPORT
3117ba1bee43SYing Zhang		Support for the net/libnet.o in SPL binary.
3118ba1bee43SYing Zhang		It conflicts with SPL env from storage medium specified by
3119ba1bee43SYing Zhang		CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3120ba1bee43SYing Zhang
312174752baaSScott Wood		CONFIG_SPL_PAD_TO
31226113d3f2SBenoît Thébaudeau		Image offset to which the SPL should be padded before appending
31236113d3f2SBenoît Thébaudeau		the SPL payload. By default, this is defined as
31246113d3f2SBenoît Thébaudeau		CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
31256113d3f2SBenoît Thébaudeau		CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
31266113d3f2SBenoît Thébaudeau		payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
312774752baaSScott Wood
3128ca2fca22SScott Wood		CONFIG_SPL_TARGET
3129ca2fca22SScott Wood		Final target image containing SPL and payload.  Some SPLs
3130ca2fca22SScott Wood		use an arch-specific makefile fragment instead, for
3131ca2fca22SScott Wood		example if more than one image needs to be produced.
3132ca2fca22SScott Wood
313387ebee39SSimon Glass		CONFIG_FIT_SPL_PRINT
313487ebee39SSimon Glass		Printing information about a FIT image adds quite a bit of
313587ebee39SSimon Glass		code to SPL. So this is normally disabled in SPL. Use this
313687ebee39SSimon Glass		option to re-enable it. This will affect the output of the
313787ebee39SSimon Glass		bootm command when booting a FIT image.
313887ebee39SSimon Glass
3139c609719bSwdenkModem Support:
3140c609719bSwdenk--------------
3141c609719bSwdenk
3142566e5cf4SWolfgang Denk[so far only for SMDK2400 boards]
3143c609719bSwdenk
314411ccc33fSMarcel Ziswiler- Modem support enable:
3145c609719bSwdenk		CONFIG_MODEM_SUPPORT
3146c609719bSwdenk
3147c609719bSwdenk- RTS/CTS Flow control enable:
3148c609719bSwdenk		CONFIG_HWFLOW
3149c609719bSwdenk
3150c609719bSwdenk- Modem debug support:
3151c609719bSwdenk		CONFIG_MODEM_SUPPORT_DEBUG
3152c609719bSwdenk
3153c609719bSwdenk		Enables debugging stuff (char screen[1024], dbg())
3154c609719bSwdenk		for modem support. Useful only with BDI2000.
3155c609719bSwdenk
3156a8c7c708Swdenk- Interrupt support (PPC):
3157a8c7c708Swdenk
3158a8c7c708Swdenk		There are common interrupt_init() and timer_interrupt()
3159a8c7c708Swdenk		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
316011ccc33fSMarcel Ziswiler		for CPU specific initialization. interrupt_init_cpu()
3161a8c7c708Swdenk		should set decrementer_count to appropriate value. If
316211ccc33fSMarcel Ziswiler		CPU resets decrementer automatically after interrupt
3163a8c7c708Swdenk		(ppc4xx) it should set decrementer_count to zero.
316411ccc33fSMarcel Ziswiler		timer_interrupt() calls timer_interrupt_cpu() for CPU
3165a8c7c708Swdenk		specific handling. If board has watchdog / status_led
3166a8c7c708Swdenk		/ other_activity_monitor it works automatically from
3167a8c7c708Swdenk		general timer_interrupt().
3168a8c7c708Swdenk
3169c609719bSwdenk- General:
3170c609719bSwdenk
3171c609719bSwdenk		In the target system modem support is enabled when a
3172c609719bSwdenk		specific key (key combination) is pressed during
3173c609719bSwdenk		power-on. Otherwise U-Boot will boot normally
317411ccc33fSMarcel Ziswiler		(autoboot). The key_pressed() function is called from
3175c609719bSwdenk		board_init(). Currently key_pressed() is a dummy
3176c609719bSwdenk		function, returning 1 and thus enabling modem
3177c609719bSwdenk		initialization.
3178c609719bSwdenk
3179c609719bSwdenk		If there are no modem init strings in the
3180c609719bSwdenk		environment, U-Boot proceed to autoboot; the
3181c609719bSwdenk		previous output (banner, info printfs) will be
318211ccc33fSMarcel Ziswiler		suppressed, though.
3183c609719bSwdenk
3184c609719bSwdenk		See also: doc/README.Modem
3185c609719bSwdenk
31869660e442SHelmut RaigerBoard initialization settings:
31879660e442SHelmut Raiger------------------------------
31889660e442SHelmut Raiger
31899660e442SHelmut RaigerDuring Initialization u-boot calls a number of board specific functions
31909660e442SHelmut Raigerto allow the preparation of board specific prerequisites, e.g. pin setup
31919660e442SHelmut Raigerbefore drivers are initialized. To enable these callbacks the
31929660e442SHelmut Raigerfollowing configuration macros have to be defined. Currently this is
31939660e442SHelmut Raigerarchitecture specific, so please check arch/your_architecture/lib/board.c
31949660e442SHelmut Raigertypically in board_init_f() and board_init_r().
31959660e442SHelmut Raiger
31969660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
31979660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
31989660e442SHelmut Raiger- CONFIG_BOARD_LATE_INIT: Call board_late_init()
31999660e442SHelmut Raiger- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
3200c609719bSwdenk
3201c609719bSwdenkConfiguration Settings:
3202c609719bSwdenk-----------------------
3203c609719bSwdenk
32046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
3205c609719bSwdenk		undefine this when you're short of memory.
3206c609719bSwdenk
32072fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
32082fb2604dSPeter Tyser		width of the commands listed in the 'help' command output.
32092fb2604dSPeter Tyser
32106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT:	This is what U-Boot prints on the console to
3211c609719bSwdenk		prompt for user input.
3212c609719bSwdenk
32136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE:	Buffer size for input from the Console
3214c609719bSwdenk
32156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE:	Buffer size for Console output
3216c609719bSwdenk
32176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS:	max. Number of arguments accepted for monitor commands
3218c609719bSwdenk
32196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
3220c609719bSwdenk		the application (usually a Linux kernel) when it is
3221c609719bSwdenk		booted
3222c609719bSwdenk
32236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE:
3224c609719bSwdenk		List of legal baudrate settings for this board.
3225c609719bSwdenk
32266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_INFO_QUIET
3227c609719bSwdenk		Suppress display of console information at boot.
3228c609719bSwdenk
32296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_IS_IN_ENV
3230c609719bSwdenk		If the board specific function
3231c609719bSwdenk			extern int overwrite_console (void);
3232c609719bSwdenk		returns 1, the stdin, stderr and stdout are switched to the
3233c609719bSwdenk		serial port, else the settings in the environment are used.
3234c609719bSwdenk
32356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
3236c609719bSwdenk		Enable the call to overwrite_console().
3237c609719bSwdenk
32386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
3239c609719bSwdenk		Enable overwrite of previous console environment settings.
3240c609719bSwdenk
32416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
3242c609719bSwdenk		Begin and End addresses of the area used by the
3243c609719bSwdenk		simple memory test.
3244c609719bSwdenk
32456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST:
3246c609719bSwdenk		Enable an alternate, more extensive memory test.
3247c609719bSwdenk
32486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH:
32495f535fe1Swdenk		Scratch address used by the alternate memory test
32505f535fe1Swdenk		You only need to set this if address zero isn't writeable
32515f535fe1Swdenk
32526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
32536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
325414f73ca6SStefan Roese		this specified memory area will get subtracted from the top
325511ccc33fSMarcel Ziswiler		(end) of RAM and won't get "touched" at all by U-Boot. By
325614f73ca6SStefan Roese		fixing up gd->ram_size the Linux kernel should gets passed
325714f73ca6SStefan Roese		the now "corrected" memory size and won't touch it either.
325814f73ca6SStefan Roese		This should work for arch/ppc and arch/powerpc. Only Linux
32595e12e75dSStefan Roese		board ports in arch/powerpc with bootwrapper support that
326014f73ca6SStefan Roese		recalculate the memory size from the SDRAM controller setup
32615e12e75dSStefan Roese		will have to get fixed in Linux additionally.
326214f73ca6SStefan Roese
326314f73ca6SStefan Roese		This option can be used as a workaround for the 440EPx/GRx
326414f73ca6SStefan Roese		CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
326514f73ca6SStefan Roese		be touched.
326614f73ca6SStefan Roese
326714f73ca6SStefan Roese		WARNING: Please make sure that this value is a multiple of
326814f73ca6SStefan Roese		the Linux page size (normally 4k). If this is not the case,
326914f73ca6SStefan Roese		then the end address of the Linux memory will be located at a
327014f73ca6SStefan Roese		non page size aligned address and this could cause major
327114f73ca6SStefan Roese		problems.
327214f73ca6SStefan Roese
32736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE:
3274c609719bSwdenk		Enable temporary baudrate change while serial download
3275c609719bSwdenk
32766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE:
3277c609719bSwdenk		Physical start address of SDRAM. _Must_ be 0 here.
3278c609719bSwdenk
32796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MBIO_BASE:
3280c609719bSwdenk		Physical start address of Motherboard I/O (if using a
3281c609719bSwdenk		Cogent motherboard)
3282c609719bSwdenk
32836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE:
3284c609719bSwdenk		Physical start address of Flash memory.
3285c609719bSwdenk
32866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE:
3287c609719bSwdenk		Physical start address of boot monitor code (set by
3288c609719bSwdenk		make config files to be same as the text base address
328914d0a02aSWolfgang Denk		(CONFIG_SYS_TEXT_BASE) used when linking) - same as
32906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FLASH_BASE when booting from flash.
3291c609719bSwdenk
32926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN:
32933b57fe0aSwdenk		Size of memory reserved for monitor code, used to
32943b57fe0aSwdenk		determine _at_compile_time_ (!) if the environment is
32953b57fe0aSwdenk		embedded within the U-Boot image, or in a separate
32963b57fe0aSwdenk		flash sector.
3297c609719bSwdenk
32986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN:
3299c609719bSwdenk		Size of DRAM reserved for malloc() use.
3300c609719bSwdenk
33016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN:
330215940c9aSStefan Roese		Normally compressed uImages are limited to an
330315940c9aSStefan Roese		uncompressed size of 8 MBytes. If this is not enough,
33046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		you can define CONFIG_SYS_BOOTM_LEN in your board config file
330515940c9aSStefan Roese		to adjust this setting to your needs.
3306c609719bSwdenk
33076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ:
3308c609719bSwdenk		Maximum size of memory mapped by the startup code of
3309c609719bSwdenk		the Linux kernel; all data that must be processed by
33107d721e34SBartlomiej Sieka		the Linux kernel (bd_info, boot arguments, FDT blob if
33117d721e34SBartlomiej Sieka		used) must be put below this limit, unless "bootm_low"
33127d721e34SBartlomiej Sieka		enviroment variable is defined and non-zero. In such case
33137d721e34SBartlomiej Sieka		all data for the Linux kernel must be between "bootm_low"
3314c3624e6eSGrant Likely		and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.	 The environment
3315c3624e6eSGrant Likely		variable "bootm_mapsize" will override the value of
3316c3624e6eSGrant Likely		CONFIG_SYS_BOOTMAPSZ.  If CONFIG_SYS_BOOTMAPSZ is undefined,
3317c3624e6eSGrant Likely		then the value in "bootm_size" will be used instead.
3318c609719bSwdenk
3319fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3320fca43cc8SJohn Rigby		Enable initrd_high functionality.  If defined then the
3321fca43cc8SJohn Rigby		initrd_high feature is enabled and the bootm ramdisk subcommand
3322fca43cc8SJohn Rigby		is enabled.
3323fca43cc8SJohn Rigby
3324fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_CMDLINE:
3325fca43cc8SJohn Rigby		Enables allocating and saving kernel cmdline in space between
3326fca43cc8SJohn Rigby		"bootm_low" and "bootm_low" + BOOTMAPSZ.
3327fca43cc8SJohn Rigby
3328fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_KBD:
3329fca43cc8SJohn Rigby		Enables allocating and saving a kernel copy of the bd_info in
3330fca43cc8SJohn Rigby		space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3331fca43cc8SJohn Rigby
33326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS:
3333c609719bSwdenk		Max number of Flash memory banks
3334c609719bSwdenk
33356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT:
3336c609719bSwdenk		Max number of sectors on a Flash chip
3337c609719bSwdenk
33386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT:
3339c609719bSwdenk		Timeout for Flash erase operations (in ms)
3340c609719bSwdenk
33416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT:
3342c609719bSwdenk		Timeout for Flash write operations (in ms)
3343c609719bSwdenk
33446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT
33458564acf9Swdenk		Timeout for Flash set sector lock bit operation (in ms)
33468564acf9Swdenk
33476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT
33488564acf9Swdenk		Timeout for Flash clear lock bits operation (in ms)
33498564acf9Swdenk
33506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION
33518564acf9Swdenk		If defined, hardware flash sectors protection is used
33528564acf9Swdenk		instead of U-Boot software protection.
33538564acf9Swdenk
33546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP:
3355c609719bSwdenk
3356c609719bSwdenk		Enable TFTP transfers directly to flash memory;
3357c609719bSwdenk		without this option such a download has to be
3358c609719bSwdenk		performed in two steps: (1) download to RAM, and (2)
3359c609719bSwdenk		copy from RAM to flash.
3360c609719bSwdenk
3361c609719bSwdenk		The two-step approach is usually more reliable, since
3362c609719bSwdenk		you can check if the download worked before you erase
336311ccc33fSMarcel Ziswiler		the flash, but in some situations (when system RAM is
336411ccc33fSMarcel Ziswiler		too limited to allow for a temporary copy of the
3365c609719bSwdenk		downloaded image) this option may be very useful.
3366c609719bSwdenk
33676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI:
3368c609719bSwdenk		Define if the flash driver uses extra elements in the
33695653fc33Swdenk		common flash structure for storing flash geometry.
33705653fc33Swdenk
337100b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER
33725653fc33Swdenk		This option also enables the building of the cfi_flash driver
33735653fc33Swdenk		in the drivers directory
337453cf9435Sstroese
337591809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD
337691809ed5SPiotr Ziecik		This option enables the building of the cfi_mtd driver
337791809ed5SPiotr Ziecik		in the drivers directory. The driver exports CFI flash
337891809ed5SPiotr Ziecik		to the MTD layer.
337991809ed5SPiotr Ziecik
33806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
338196ef831fSGuennadi Liakhovetski		Use buffered writes to flash.
338296ef831fSGuennadi Liakhovetski
338396ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N
338496ef831fSGuennadi Liakhovetski		s29ws-n MirrorBit flash has non-standard addresses for buffered
338596ef831fSGuennadi Liakhovetski		write commands.
338696ef831fSGuennadi Liakhovetski
33876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST
33885568e613SStefan Roese		If this option is defined, the common CFI flash doesn't
33895568e613SStefan Roese		print it's warning upon not recognized FLASH banks. This
33905568e613SStefan Roese		is useful, if some of the configured banks are only
33915568e613SStefan Roese		optionally available.
33925568e613SStefan Roese
33939a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS
33949a042e9cSJerry Van Baren		If defined (must be an integer), print out countdown
33959a042e9cSJerry Van Baren		digits and dots.  Recommended value: 45 (9..1) for 80
33969a042e9cSJerry Van Baren		column displays, 15 (3..1) for 40 column displays.
33979a042e9cSJerry Van Baren
3398352ef3f1SStefan Roese- CONFIG_FLASH_VERIFY
3399352ef3f1SStefan Roese		If defined, the content of the flash (destination) is compared
3400352ef3f1SStefan Roese		against the source after the write operation. An error message
3401352ef3f1SStefan Roese		will be printed when the contents are not identical.
3402352ef3f1SStefan Roese		Please note that this option is useless in nearly all cases,
3403352ef3f1SStefan Roese		since such flash programming errors usually are detected earlier
3404352ef3f1SStefan Roese		while unprotecting/erasing/programming. Please only enable
3405352ef3f1SStefan Roese		this option if you really know what you are doing.
3406352ef3f1SStefan Roese
34076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER:
340811ccc33fSMarcel Ziswiler		Defines the number of Ethernet receive buffers. On some
340911ccc33fSMarcel Ziswiler		Ethernet controllers it is recommended to set this value
341053cf9435Sstroese		to 8 or even higher (EEPRO100 or 405 EMAC), since all
341153cf9435Sstroese		buffers can be full shortly after enabling the interface
341211ccc33fSMarcel Ziswiler		on high Ethernet traffic.
341353cf9435Sstroese		Defaults to 4 if not defined.
3414c609719bSwdenk
3415ea882bafSWolfgang Denk- CONFIG_ENV_MAX_ENTRIES
3416ea882bafSWolfgang Denk
3417ea882bafSWolfgang Denk	Maximum number of entries in the hash table that is used
3418ea882bafSWolfgang Denk	internally to store the environment settings. The default
3419ea882bafSWolfgang Denk	setting is supposed to be generous and should work in most
3420ea882bafSWolfgang Denk	cases. This setting can be used to tune behaviour; see
3421ea882bafSWolfgang Denk	lib/hashtable.c for details.
3422ea882bafSWolfgang Denk
34232598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_DEFAULT
34242598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_STATIC
34252598090bSJoe Hershberger	Enable validation of the values given to enviroment variables when
34262598090bSJoe Hershberger	calling env set.  Variables can be restricted to only decimal,
34272598090bSJoe Hershberger	hexadecimal, or boolean.  If CONFIG_CMD_NET is also defined,
34282598090bSJoe Hershberger	the variables can also be restricted to IP address or MAC address.
34292598090bSJoe Hershberger
34302598090bSJoe Hershberger	The format of the list is:
34312598090bSJoe Hershberger		type_attribute = [s|d|x|b|i|m]
3432267541f7SJoe Hershberger		access_atribute = [a|r|o|c]
3433267541f7SJoe Hershberger		attributes = type_attribute[access_atribute]
34342598090bSJoe Hershberger		entry = variable_name[:attributes]
34352598090bSJoe Hershberger		list = entry[,list]
34362598090bSJoe Hershberger
34372598090bSJoe Hershberger	The type attributes are:
34382598090bSJoe Hershberger		s - String (default)
34392598090bSJoe Hershberger		d - Decimal
34402598090bSJoe Hershberger		x - Hexadecimal
34412598090bSJoe Hershberger		b - Boolean ([1yYtT|0nNfF])
34422598090bSJoe Hershberger		i - IP address
34432598090bSJoe Hershberger		m - MAC address
34442598090bSJoe Hershberger
3445267541f7SJoe Hershberger	The access attributes are:
3446267541f7SJoe Hershberger		a - Any (default)
3447267541f7SJoe Hershberger		r - Read-only
3448267541f7SJoe Hershberger		o - Write-once
3449267541f7SJoe Hershberger		c - Change-default
3450267541f7SJoe Hershberger
34512598090bSJoe Hershberger	- CONFIG_ENV_FLAGS_LIST_DEFAULT
34522598090bSJoe Hershberger		Define this to a list (string) to define the ".flags"
34532598090bSJoe Hershberger		envirnoment variable in the default or embedded environment.
34542598090bSJoe Hershberger
34552598090bSJoe Hershberger	- CONFIG_ENV_FLAGS_LIST_STATIC
34562598090bSJoe Hershberger		Define this to a list (string) to define validation that
34572598090bSJoe Hershberger		should be done if an entry is not found in the ".flags"
34582598090bSJoe Hershberger		environment variable.  To override a setting in the static
34592598090bSJoe Hershberger		list, simply add an entry for the same variable name to the
34602598090bSJoe Hershberger		".flags" variable.
34612598090bSJoe Hershberger
3462267541f7SJoe Hershberger- CONFIG_ENV_ACCESS_IGNORE_FORCE
3463267541f7SJoe Hershberger	If defined, don't allow the -f switch to env set override variable
3464267541f7SJoe Hershberger	access flags.
3465267541f7SJoe Hershberger
34665c1a7ea6SSimon Glass- CONFIG_SYS_GENERIC_BOARD
34675c1a7ea6SSimon Glass	This selects the architecture-generic board system instead of the
34685c1a7ea6SSimon Glass	architecture-specific board files. It is intended to move boards
34695c1a7ea6SSimon Glass	to this new framework over time. Defining this will disable the
34705c1a7ea6SSimon Glass	arch/foo/lib/board.c file and use common/board_f.c and
34715c1a7ea6SSimon Glass	common/board_r.c instead. To use this option your architecture
34725c1a7ea6SSimon Glass	must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in
34735c1a7ea6SSimon Glass	its config.mk file). If you find problems enabling this option on
34745c1a7ea6SSimon Glass	your board please report the problem and send patches!
34755c1a7ea6SSimon Glass
3476632efa74SSimon Glass- CONFIG_SYS_SYM_OFFSETS
3477632efa74SSimon Glass	This is set by architectures that use offsets for link symbols
3478632efa74SSimon Glass	instead of absolute values. So bss_start is obtained using an
3479632efa74SSimon Glass	offset _bss_start_ofs from CONFIG_SYS_TEXT_BASE, rather than
3480632efa74SSimon Glass	directly. You should not need to touch this setting.
3481632efa74SSimon Glass
34820b1b60c7SLokesh Vutla- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
34830b1b60c7SLokesh Vutla	This is set by OMAP boards for the max time that reset should
34840b1b60c7SLokesh Vutla	be asserted. See doc/README.omap-reset-time for details on how
34850b1b60c7SLokesh Vutla	the value can be calulated on a given board.
3486632efa74SSimon Glass
3487c609719bSwdenkThe following definitions that deal with the placement and management
3488c609719bSwdenkof environment data (variable area); in general, we support the
3489c609719bSwdenkfollowing configurations:
3490c609719bSwdenk
3491c3eb3fe4SMike Frysinger- CONFIG_BUILD_ENVCRC:
3492c3eb3fe4SMike Frysinger
3493c3eb3fe4SMike Frysinger	Builds up envcrc with the target environment so that external utils
3494c3eb3fe4SMike Frysinger	may easily extract it and embed it in final U-Boot images.
3495c3eb3fe4SMike Frysinger
34965a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH:
3497c609719bSwdenk
3498c609719bSwdenk	Define this if the environment is in flash memory.
3499c609719bSwdenk
3500c609719bSwdenk	a) The environment occupies one whole flash sector, which is
3501c609719bSwdenk	   "embedded" in the text segment with the U-Boot code. This
3502c609719bSwdenk	   happens usually with "bottom boot sector" or "top boot
3503c609719bSwdenk	   sector" type flash chips, which have several smaller
3504c609719bSwdenk	   sectors at the start or the end. For instance, such a
3505c609719bSwdenk	   layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3506c609719bSwdenk	   such a case you would place the environment in one of the
3507c609719bSwdenk	   4 kB sectors - with U-Boot code before and after it. With
3508c609719bSwdenk	   "top boot sector" type flash chips, you would put the
3509c609719bSwdenk	   environment in one of the last sectors, leaving a gap
3510c609719bSwdenk	   between U-Boot and the environment.
3511c609719bSwdenk
35120e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
3513c609719bSwdenk
3514c609719bSwdenk	   Offset of environment data (variable area) to the
3515c609719bSwdenk	   beginning of flash memory; for instance, with bottom boot
3516c609719bSwdenk	   type flash chips the second sector can be used: the offset
3517c609719bSwdenk	   for this sector is given here.
3518c609719bSwdenk
35196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
3520c609719bSwdenk
35210e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
3522c609719bSwdenk
3523c609719bSwdenk	   This is just another way to specify the start address of
3524c609719bSwdenk	   the flash sector containing the environment (instead of
35250e8d1586SJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET).
3526c609719bSwdenk
35270e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SECT_SIZE:
3528c609719bSwdenk
3529c609719bSwdenk	   Size of the sector containing the environment.
3530c609719bSwdenk
3531c609719bSwdenk
3532c609719bSwdenk	b) Sometimes flash chips have few, equal sized, BIG sectors.
3533c609719bSwdenk	   In such a case you don't want to spend a whole sector for
3534c609719bSwdenk	   the environment.
3535c609719bSwdenk
35360e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3537c609719bSwdenk
35385a1aceb0SJean-Christophe PLAGNIOL-VILLARD	   If you use this in combination with CONFIG_ENV_IS_IN_FLASH
35390e8d1586SJean-Christophe PLAGNIOL-VILLARD	   and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
3540c609719bSwdenk	   of this flash sector for the environment. This saves
3541c609719bSwdenk	   memory for the RAM copy of the environment.
3542c609719bSwdenk
3543c609719bSwdenk	   It may also save flash memory if you decide to use this
3544c609719bSwdenk	   when your environment is "embedded" within U-Boot code,
3545c609719bSwdenk	   since then the remainder of the flash sector could be used
3546c609719bSwdenk	   for U-Boot code. It should be pointed out that this is
3547c609719bSwdenk	   STRONGLY DISCOURAGED from a robustness point of view:
3548c609719bSwdenk	   updating the environment in flash makes it always
3549c609719bSwdenk	   necessary to erase the WHOLE sector. If something goes
3550c609719bSwdenk	   wrong before the contents has been restored from a copy in
3551c609719bSwdenk	   RAM, your target system will be dead.
3552c609719bSwdenk
35530e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR_REDUND
35540e8d1586SJean-Christophe PLAGNIOL-VILLARD	  CONFIG_ENV_SIZE_REDUND
3555c609719bSwdenk
3556c609719bSwdenk	   These settings describe a second storage area used to hold
355711ccc33fSMarcel Ziswiler	   a redundant copy of the environment data, so that there is
35583e38691eSwdenk	   a valid backup copy in case there is a power failure during
3559c609719bSwdenk	   a "saveenv" operation.
3560c609719bSwdenk
3561c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the
3562c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds*
3563c609719bSwdenkaccordingly!
3564c609719bSwdenk
3565c609719bSwdenk
35669314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM:
3567c609719bSwdenk
3568c609719bSwdenk	Define this if you have some non-volatile memory device
3569c609719bSwdenk	(NVRAM, battery buffered SRAM) which you want to use for the
3570c609719bSwdenk	environment.
3571c609719bSwdenk
35720e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
35730e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3574c609719bSwdenk
357511ccc33fSMarcel Ziswiler	  These two #defines are used to determine the memory area you
3576c609719bSwdenk	  want to use for environment. It is assumed that this memory
3577c609719bSwdenk	  can just be read and written to, without any special
3578c609719bSwdenk	  provision.
3579c609719bSwdenk
3580c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early
3581c609719bSwdenkin U-Boot initalization (when we try to get the setting of for the
358211ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or
3583c609719bSwdenkU-Boot will hang.
3584c609719bSwdenk
3585c609719bSwdenkPlease note that even with NVRAM we still use a copy of the
3586c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to
3587c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv"
3588c609719bSwdenkto save the current settings.
3589c609719bSwdenk
3590c609719bSwdenk
3591bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM:
3592c609719bSwdenk
3593c609719bSwdenk	Use this if you have an EEPROM or similar serial access
3594c609719bSwdenk	device and a driver for it.
3595c609719bSwdenk
35960e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
35970e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3598c609719bSwdenk
3599c609719bSwdenk	  These two #defines specify the offset and size of the
3600c609719bSwdenk	  environment area within the total memory of your EEPROM.
3601c609719bSwdenk
36026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR:
3603c609719bSwdenk	  If defined, specified the chip address of the EEPROM device.
3604c609719bSwdenk	  The default address is zero.
3605c609719bSwdenk
36066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
3607c609719bSwdenk	  If defined, the number of bits used to address bytes in a
3608c609719bSwdenk	  single page in the EEPROM device.  A 64 byte page, for example
3609c609719bSwdenk	  would require six bits.
3610c609719bSwdenk
36116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
3612c609719bSwdenk	  If defined, the number of milliseconds to delay between
3613c609719bSwdenk	  page writes.	The default is zero milliseconds.
3614c609719bSwdenk
36156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
3616c609719bSwdenk	  The length in bytes of the EEPROM memory array address.  Note
3617c609719bSwdenk	  that this is NOT the chip address length!
3618c609719bSwdenk
36196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
36205cf91d6bSwdenk	  EEPROM chips that implement "address overflow" are ones
36215cf91d6bSwdenk	  like Catalyst 24WC04/08/16 which has 9/10/11 bits of
36225cf91d6bSwdenk	  address and the extra bits end up in the "chip address" bit
36235cf91d6bSwdenk	  slots. This makes a 24WC08 (1Kbyte) chip look like four 256
36245cf91d6bSwdenk	  byte chips.
36255cf91d6bSwdenk
36265cf91d6bSwdenk	  Note that we consider the length of the address field to
36275cf91d6bSwdenk	  still be one byte because the extra address bits are hidden
36285cf91d6bSwdenk	  in the chip address.
36295cf91d6bSwdenk
36306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_SIZE:
3631c609719bSwdenk	  The size in bytes of the EEPROM device.
3632c609719bSwdenk
3633548738b4SHeiko Schocher	- CONFIG_ENV_EEPROM_IS_ON_I2C
3634548738b4SHeiko Schocher	  define this, if you have I2C and SPI activated, and your
3635548738b4SHeiko Schocher	  EEPROM, which holds the environment, is on the I2C bus.
3636548738b4SHeiko Schocher
3637548738b4SHeiko Schocher	- CONFIG_I2C_ENV_EEPROM_BUS
3638548738b4SHeiko Schocher	  if you have an Environment on an EEPROM reached over
3639548738b4SHeiko Schocher	  I2C muxes, you can define here, how to reach this
3640548738b4SHeiko Schocher	  EEPROM. For example:
3641548738b4SHeiko Schocher
3642ea818dbbSHeiko Schocher	  #define CONFIG_I2C_ENV_EEPROM_BUS	  1
3643548738b4SHeiko Schocher
3644548738b4SHeiko Schocher	  EEPROM which holds the environment, is reached over
3645548738b4SHeiko Schocher	  a pca9547 i2c mux with address 0x70, channel 3.
3646c609719bSwdenk
3647057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH:
36485779d8d9Swdenk
36495779d8d9Swdenk	Define this if you have a DataFlash memory device which you
36505779d8d9Swdenk	want to use for the environment.
36515779d8d9Swdenk
36520e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
36530e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
36540e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
36555779d8d9Swdenk
36565779d8d9Swdenk	  These three #defines specify the offset and size of the
36575779d8d9Swdenk	  environment area within the total memory of your DataFlash placed
36585779d8d9Swdenk	  at the specified address.
36595779d8d9Swdenk
36600a85a9e7SLiu Gang- CONFIG_ENV_IS_IN_REMOTE:
36610a85a9e7SLiu Gang
36620a85a9e7SLiu Gang	Define this if you have a remote memory space which you
36630a85a9e7SLiu Gang	want to use for the local device's environment.
36640a85a9e7SLiu Gang
36650a85a9e7SLiu Gang	- CONFIG_ENV_ADDR:
36660a85a9e7SLiu Gang	- CONFIG_ENV_SIZE:
36670a85a9e7SLiu Gang
36680a85a9e7SLiu Gang	  These two #defines specify the address and size of the
36690a85a9e7SLiu Gang	  environment area within the remote memory space. The
36700a85a9e7SLiu Gang	  local device can get the environment from remote memory
3671fc54c7faSLiu Gang	  space by SRIO or PCIE links.
36720a85a9e7SLiu Gang
36730a85a9e7SLiu GangBE CAREFUL! For some special cases, the local device can not use
36740a85a9e7SLiu Gang"saveenv" command. For example, the local device will get the
3675fc54c7faSLiu Gangenvironment stored in a remote NOR flash by SRIO or PCIE link,
3676fc54c7faSLiu Gangbut it can not erase, write this NOR flash by SRIO or PCIE interface.
36770a85a9e7SLiu Gang
367851bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND:
367913a5695bSwdenk
368013a5695bSwdenk	Define this if you have a NAND device which you want to use
368113a5695bSwdenk	for the environment.
368213a5695bSwdenk
36830e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
36840e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
368513a5695bSwdenk
368613a5695bSwdenk	  These two #defines specify the offset and size of the environment
3687fdd813deSScott Wood	  area within the first NAND device.  CONFIG_ENV_OFFSET must be
3688fdd813deSScott Wood	  aligned to an erase block boundary.
36895779d8d9Swdenk
3690fdd813deSScott Wood	- CONFIG_ENV_OFFSET_REDUND (optional):
3691e443c944SMarkus Klotzbuecher
36920e8d1586SJean-Christophe PLAGNIOL-VILLARD	  This setting describes a second storage area of CONFIG_ENV_SIZE
3693fdd813deSScott Wood	  size used to hold a redundant copy of the environment data, so
3694fdd813deSScott Wood	  that there is a valid backup copy in case there is a power failure
3695fdd813deSScott Wood	  during a "saveenv" operation.	 CONFIG_ENV_OFFSET_RENDUND must be
3696fdd813deSScott Wood	  aligned to an erase block boundary.
3697e443c944SMarkus Klotzbuecher
3698fdd813deSScott Wood	- CONFIG_ENV_RANGE (optional):
3699fdd813deSScott Wood
3700fdd813deSScott Wood	  Specifies the length of the region in which the environment
3701fdd813deSScott Wood	  can be written.  This should be a multiple of the NAND device's
3702fdd813deSScott Wood	  block size.  Specifying a range with more erase blocks than
3703fdd813deSScott Wood	  are needed to hold CONFIG_ENV_SIZE allows bad blocks within
3704fdd813deSScott Wood	  the range to be avoided.
3705fdd813deSScott Wood
3706fdd813deSScott Wood	- CONFIG_ENV_OFFSET_OOB (optional):
3707fdd813deSScott Wood
3708fdd813deSScott Wood	  Enables support for dynamically retrieving the offset of the
3709fdd813deSScott Wood	  environment from block zero's out-of-band data.  The
3710fdd813deSScott Wood	  "nand env.oob" command can be used to record this offset.
3711fdd813deSScott Wood	  Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
3712fdd813deSScott Wood	  using CONFIG_ENV_OFFSET_OOB.
3713e443c944SMarkus Klotzbuecher
3714b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST
3715b74ab737SGuennadi Liakhovetski
3716b74ab737SGuennadi Liakhovetski	Defines address in RAM to which the nand_spl code should copy the
3717b74ab737SGuennadi Liakhovetski	environment. If redundant environment is used, it will be copied to
3718b74ab737SGuennadi Liakhovetski	CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3719b74ab737SGuennadi Liakhovetski
37202b74433fSJoe Hershberger- CONFIG_ENV_IS_IN_UBI:
37212b74433fSJoe Hershberger
37222b74433fSJoe Hershberger	Define this if you have an UBI volume that you want to use for the
37232b74433fSJoe Hershberger	environment.  This has the benefit of wear-leveling the environment
37242b74433fSJoe Hershberger	accesses, which is important on NAND.
37252b74433fSJoe Hershberger
37262b74433fSJoe Hershberger	- CONFIG_ENV_UBI_PART:
37272b74433fSJoe Hershberger
37282b74433fSJoe Hershberger	  Define this to a string that is the mtd partition containing the UBI.
37292b74433fSJoe Hershberger
37302b74433fSJoe Hershberger	- CONFIG_ENV_UBI_VOLUME:
37312b74433fSJoe Hershberger
37322b74433fSJoe Hershberger	  Define this to the name of the volume that you want to store the
37332b74433fSJoe Hershberger	  environment in.
37342b74433fSJoe Hershberger
3735785881f7SJoe Hershberger	- CONFIG_ENV_UBI_VOLUME_REDUND:
3736785881f7SJoe Hershberger
3737785881f7SJoe Hershberger	  Define this to the name of another volume to store a second copy of
3738785881f7SJoe Hershberger	  the environment in.  This will enable redundant environments in UBI.
3739785881f7SJoe Hershberger	  It is assumed that both volumes are in the same MTD partition.
3740785881f7SJoe Hershberger
37412b74433fSJoe Hershberger	- CONFIG_UBI_SILENCE_MSG
37422b74433fSJoe Hershberger	- CONFIG_UBIFS_SILENCE_MSG
37432b74433fSJoe Hershberger
37442b74433fSJoe Hershberger	  You will probably want to define these to avoid a really noisy system
37452b74433fSJoe Hershberger	  when storing the env in UBI.
37462b74433fSJoe Hershberger
374706e4ae5fSStephen Warren- CONFIG_ENV_IS_IN_MMC:
374806e4ae5fSStephen Warren
374906e4ae5fSStephen Warren	Define this if you have an MMC device which you want to use for the
375006e4ae5fSStephen Warren	environment.
375106e4ae5fSStephen Warren
375206e4ae5fSStephen Warren	- CONFIG_SYS_MMC_ENV_DEV:
375306e4ae5fSStephen Warren
375406e4ae5fSStephen Warren	  Specifies which MMC device the environment is stored in.
375506e4ae5fSStephen Warren
375606e4ae5fSStephen Warren	- CONFIG_SYS_MMC_ENV_PART (optional):
375706e4ae5fSStephen Warren
375806e4ae5fSStephen Warren	  Specifies which MMC partition the environment is stored in. If not
375906e4ae5fSStephen Warren	  set, defaults to partition 0, the user area. Common values might be
376006e4ae5fSStephen Warren	  1 (first MMC boot partition), 2 (second MMC boot partition).
376106e4ae5fSStephen Warren
376206e4ae5fSStephen Warren	- CONFIG_ENV_OFFSET:
376306e4ae5fSStephen Warren	- CONFIG_ENV_SIZE:
376406e4ae5fSStephen Warren
376506e4ae5fSStephen Warren	  These two #defines specify the offset and size of the environment
376606e4ae5fSStephen Warren	  area within the specified MMC device.
376706e4ae5fSStephen Warren
37685c088ee8SStephen Warren	  If offset is positive (the usual case), it is treated as relative to
37695c088ee8SStephen Warren	  the start of the MMC partition. If offset is negative, it is treated
37705c088ee8SStephen Warren	  as relative to the end of the MMC partition. This can be useful if
37715c088ee8SStephen Warren	  your board may be fitted with different MMC devices, which have
37725c088ee8SStephen Warren	  different sizes for the MMC partitions, and you always want the
37735c088ee8SStephen Warren	  environment placed at the very end of the partition, to leave the
37745c088ee8SStephen Warren	  maximum possible space before it, to store other data.
37755c088ee8SStephen Warren
377606e4ae5fSStephen Warren	  These two values are in units of bytes, but must be aligned to an
377706e4ae5fSStephen Warren	  MMC sector boundary.
377806e4ae5fSStephen Warren
377906e4ae5fSStephen Warren	- CONFIG_ENV_OFFSET_REDUND (optional):
378006e4ae5fSStephen Warren
378106e4ae5fSStephen Warren	  Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
378206e4ae5fSStephen Warren	  hold a redundant copy of the environment data. This provides a
378306e4ae5fSStephen Warren	  valid backup copy in case the other copy is corrupted, e.g. due
378406e4ae5fSStephen Warren	  to a power failure during a "saveenv" operation.
378506e4ae5fSStephen Warren
37865c088ee8SStephen Warren	  This value may also be positive or negative; this is handled in the
37875c088ee8SStephen Warren	  same way as CONFIG_ENV_OFFSET.
37885c088ee8SStephen Warren
378906e4ae5fSStephen Warren	  This value is also in units of bytes, but must also be aligned to
379006e4ae5fSStephen Warren	  an MMC sector boundary.
379106e4ae5fSStephen Warren
379206e4ae5fSStephen Warren	- CONFIG_ENV_SIZE_REDUND (optional):
379306e4ae5fSStephen Warren
379406e4ae5fSStephen Warren	  This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
379506e4ae5fSStephen Warren	  set. If this value is set, it must be set to the same value as
379606e4ae5fSStephen Warren	  CONFIG_ENV_SIZE.
379706e4ae5fSStephen Warren
37986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET
3799c609719bSwdenk
3800c609719bSwdenk	Defines offset to the initial SPI buffer area in DPRAM. The
3801c609719bSwdenk	area is used at an early stage (ROM part) if the environment
3802c609719bSwdenk	is configured to reside in the SPI EEPROM: We need a 520 byte
3803c609719bSwdenk	scratch DPRAM area. It is used between the two initialization
3804c609719bSwdenk	calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
3805c609719bSwdenk	to be a good choice since it makes it far enough from the
3806c609719bSwdenk	start of the data area as well as from the stack pointer.
3807c609719bSwdenk
3808e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor
3809c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been
3810cdb74977SWolfgang Denkcreated; also, when using EEPROM you will have to use getenv_f()
3811c609719bSwdenkuntil then to read environment variables.
3812c609719bSwdenk
381385ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor
381485ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working
381585ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is
381685ec0bccSwdenknecessary, because the first environment variable we need is the
381785ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't
381885ec0bccSwdenkhave any device yet where we could complain.]
3819c609719bSwdenk
3820c609719bSwdenkNote: once the monitor has been relocated, then it will complain if
3821c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you
382285ec0bccSwdenkuse the "saveenv" command to store a valid environment.
3823c609719bSwdenk
38246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
3825fc3e2165Swdenk		Echo the inverted Ethernet link state to the fault LED.
3826fc3e2165Swdenk
38276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
3828fc3e2165Swdenk		      also needs to be defined.
3829fc3e2165Swdenk
38306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR:
3831fc3e2165Swdenk		MII address of the PHY to check for the Ethernet link state.
3832c609719bSwdenk
3833f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS:
3834f5675aa5SRon Madrid		Define this if you desire to only have use of the NS16550_init
3835f5675aa5SRon Madrid		and NS16550_putc functions for the serial driver located at
3836f5675aa5SRon Madrid		drivers/serial/ns16550.c.  This option is useful for saving
3837f5675aa5SRon Madrid		space for already greatly restricted images, including but not
3838f5675aa5SRon Madrid		limited to NAND_SPL configurations.
3839f5675aa5SRon Madrid
3840b2b92f53SSimon Glass- CONFIG_DISPLAY_BOARDINFO
3841b2b92f53SSimon Glass		Display information about the board that U-Boot is running on
3842b2b92f53SSimon Glass		when U-Boot starts up. The board function checkboard() is called
3843b2b92f53SSimon Glass		to do this.
3844b2b92f53SSimon Glass
3845e2e3e2b1SSimon Glass- CONFIG_DISPLAY_BOARDINFO_LATE
3846e2e3e2b1SSimon Glass		Similar to the previous option, but display this information
3847e2e3e2b1SSimon Glass		later, once stdio is running and output goes to the LCD, if
3848e2e3e2b1SSimon Glass		present.
3849e2e3e2b1SSimon Glass
3850c609719bSwdenkLow Level (hardware related) configuration options:
3851dc7c9a1aSwdenk---------------------------------------------------
3852c609719bSwdenk
38536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE:
3854c609719bSwdenk		Cache Line Size of the CPU.
3855c609719bSwdenk
38566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR:
3857c609719bSwdenk		Default address of the IMMR after system reset.
38582535d602Swdenk
38592535d602Swdenk		Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
38602535d602Swdenk		and RPXsuper) to be able to adjust the position of
38612535d602Swdenk		the IMMR register after a reset.
3862c609719bSwdenk
3863e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_DEFAULT:
3864e46fedfeSTimur Tabi		Default (power-on reset) physical address of CCSR on Freescale
3865e46fedfeSTimur Tabi		PowerPC SOCs.
3866e46fedfeSTimur Tabi
3867e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR:
3868e46fedfeSTimur Tabi		Virtual address of CCSR.  On a 32-bit build, this is typically
3869e46fedfeSTimur Tabi		the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
3870e46fedfeSTimur Tabi
3871e46fedfeSTimur Tabi		CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
3872e46fedfeSTimur Tabi		for cross-platform code that uses that macro instead.
3873e46fedfeSTimur Tabi
3874e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS:
3875e46fedfeSTimur Tabi		Physical address of CCSR.  CCSR can be relocated to a new
3876e46fedfeSTimur Tabi		physical address, if desired.  In this case, this macro should
3877e46fedfeSTimur Tabi		be set to that address.	 Otherwise, it should be set to the
3878e46fedfeSTimur Tabi		same value as CONFIG_SYS_CCSRBAR_DEFAULT.  For example, CCSR
3879e46fedfeSTimur Tabi		is typically relocated on 36-bit builds.  It is recommended
3880e46fedfeSTimur Tabi		that this macro be defined via the _HIGH and _LOW macros:
3881e46fedfeSTimur Tabi
3882e46fedfeSTimur Tabi		#define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3883e46fedfeSTimur Tabi			* 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3884e46fedfeSTimur Tabi
3885e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
3886e46fedfeSTimur Tabi		Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS.	This value is typically
3887e46fedfeSTimur Tabi		either 0 (32-bit build) or 0xF (36-bit build).	This macro is
3888e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
3889e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
3890e46fedfeSTimur Tabi
3891e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_LOW:
3892e46fedfeSTimur Tabi		Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS.  This macro is
3893e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
3894e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
3895e46fedfeSTimur Tabi
3896e46fedfeSTimur Tabi- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
3897e46fedfeSTimur Tabi		If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
3898e46fedfeSTimur Tabi		forced to a value that ensures that CCSR is not relocated.
3899e46fedfeSTimur Tabi
39007f6c2cbcSwdenk- Floppy Disk Support:
39016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER
39027f6c2cbcSwdenk
39037f6c2cbcSwdenk		the default drive number (default value 0)
39047f6c2cbcSwdenk
39056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_STRIDE
39067f6c2cbcSwdenk
390711ccc33fSMarcel Ziswiler		defines the spacing between FDC chipset registers
39087f6c2cbcSwdenk		(default value 1)
39097f6c2cbcSwdenk
39106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_OFFSET
39117f6c2cbcSwdenk
39127f6c2cbcSwdenk		defines the offset of register from address. It
39137f6c2cbcSwdenk		depends on which part of the data bus is connected to
391411ccc33fSMarcel Ziswiler		the FDC chipset. (default value 0)
39157f6c2cbcSwdenk
39166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
39176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
39187f6c2cbcSwdenk		default value.
39197f6c2cbcSwdenk
39206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		if CONFIG_SYS_FDC_HW_INIT is defined, then the function
39217f6c2cbcSwdenk		fdc_hw_init() is called at the beginning of the FDC
39227f6c2cbcSwdenk		setup. fdc_hw_init() must be provided by the board
39237f6c2cbcSwdenk		source code. It is used to make hardware dependant
39247f6c2cbcSwdenk		initializations.
39257f6c2cbcSwdenk
39260abddf82SMacpaul Lin- CONFIG_IDE_AHB:
39270abddf82SMacpaul Lin		Most IDE controllers were designed to be connected with PCI
39280abddf82SMacpaul Lin		interface. Only few of them were designed for AHB interface.
39290abddf82SMacpaul Lin		When software is doing ATA command and data transfer to
39300abddf82SMacpaul Lin		IDE devices through IDE-AHB controller, some additional
39310abddf82SMacpaul Lin		registers accessing to these kind of IDE-AHB controller
39320abddf82SMacpaul Lin		is requierd.
39330abddf82SMacpaul Lin
39346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR:	Physical address of the Internal Memory.
393525d6712aSwdenk		DO NOT CHANGE unless you know exactly what you're
393625d6712aSwdenk		doing! (11-4) [MPC8xx/82xx systems only]
3937c609719bSwdenk
39386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR:
3939c609719bSwdenk
39407152b1d0Swdenk		Start address of memory area that can be used for
3941c609719bSwdenk		initial data and stack; please note that this must be
3942c609719bSwdenk		writable memory that is working WITHOUT special
3943c609719bSwdenk		initialization, i. e. you CANNOT use normal RAM which
3944c609719bSwdenk		will become available only after programming the
3945c609719bSwdenk		memory controller and running certain initialization
3946c609719bSwdenk		sequences.
3947c609719bSwdenk
3948c609719bSwdenk		U-Boot uses the following memory types:
3949c609719bSwdenk		- MPC8xx and MPC8260: IMMR (internal memory of the CPU)
3950c609719bSwdenk		- MPC824X: data cache
3951c609719bSwdenk		- PPC4xx:  data cache
3952c609719bSwdenk
39536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET:
3954c609719bSwdenk
3955c609719bSwdenk		Offset of the initial data structure in the memory
39566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
39576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
3958c609719bSwdenk		data is located at the end of the available space
3959553f0982SWolfgang Denk		(sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
39606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
39616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
39626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET) downward.
3963c609719bSwdenk
3964c609719bSwdenk	Note:
3965c609719bSwdenk		On the MPC824X (or other systems that use the data
3966c609719bSwdenk		cache for initial memory) the address chosen for
39676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
3968c609719bSwdenk		point to an otherwise UNUSED address space between
3969c609719bSwdenk		the top of RAM and the start of the PCI space.
3970c609719bSwdenk
39716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR:	SIU Module Configuration (11-6)
3972c609719bSwdenk
39736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR:	System Protection Control (11-9)
3974c609719bSwdenk
39756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR:	Time Base Status and Control (11-26)
3976c609719bSwdenk
39776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR:	Periodic Interrupt Status and Control (11-31)
3978c609719bSwdenk
39796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR:	PLL, Low-Power, and Reset Control Register (15-30)
3980c609719bSwdenk
39816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR:	System Clock and reset Control Register (15-27)
3982c609719bSwdenk
39836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM:
3984c609719bSwdenk		SDRAM timing
3985c609719bSwdenk
39866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA:
3987c609719bSwdenk		periodic timer for refresh
3988c609719bSwdenk
39896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER:	Debug Event Register (37-47)
3990c609719bSwdenk
39916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
39926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
39936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
39946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_BR1_PRELIM:
3995c609719bSwdenk		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
3996c609719bSwdenk
3997c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
39986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
39996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
4000c609719bSwdenk		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4001c609719bSwdenk
40026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
40036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
4004c609719bSwdenk		Machine Mode Register and Memory Periodic Timer
4005c609719bSwdenk		Prescaler definitions (SDRAM timing)
4006c609719bSwdenk
40076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
4008c609719bSwdenk		enable I2C microcode relocation patch (MPC8xx);
4009c609719bSwdenk		define relocation offset in DPRAM [DSP2]
4010c609719bSwdenk
40116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
4012b423d055SHeiko Schocher		enable SMC microcode relocation patch (MPC8xx);
4013b423d055SHeiko Schocher		define relocation offset in DPRAM [SMC1]
4014b423d055SHeiko Schocher
40156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
4016c609719bSwdenk		enable SPI microcode relocation patch (MPC8xx);
4017c609719bSwdenk		define relocation offset in DPRAM [SCC4]
4018c609719bSwdenk
40196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_USE_OSCCLK:
4020c609719bSwdenk		Use OSCM clock mode on MBX8xx board. Be careful,
4021c609719bSwdenk		wrong setting might damage your board. Read
4022c609719bSwdenk		doc/README.MBX before setting this variable!
4023c609719bSwdenk
40246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
4025ea909b76Swdenk		Offset of the bootmode word in DPRAM used by post
4026ea909b76Swdenk		(Power On Self Tests). This definition overrides
4027ea909b76Swdenk		#define'd default value in commproc.h resp.
4028ea909b76Swdenk		cpm_8260.h.
4029ea909b76Swdenk
40306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
40316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
40326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
40336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
40346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
40356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
40366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
40376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
4038a47a12beSStefan Roese		Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
40395d232d0eSwdenk
40409cacf4fcSDirk Eibach- CONFIG_PCI_DISABLE_PCIE:
40419cacf4fcSDirk Eibach		Disable PCI-Express on systems where it is supported but not
40429cacf4fcSDirk Eibach		required.
40439cacf4fcSDirk Eibach
404469fd2d3bSAndrew Sharp- CONFIG_PCI_ENUM_ONLY
404569fd2d3bSAndrew Sharp		Only scan through and get the devices on the busses.
404669fd2d3bSAndrew Sharp		Don't do any setup work, presumably because someone or
404769fd2d3bSAndrew Sharp		something has already done it, and we don't need to do it
404869fd2d3bSAndrew Sharp		a second time.	Useful for platforms that are pre-booted
404969fd2d3bSAndrew Sharp		by coreboot or similar.
405069fd2d3bSAndrew Sharp
4051842033e6SGabor Juhos- CONFIG_PCI_INDIRECT_BRIDGE:
4052842033e6SGabor Juhos		Enable support for indirect PCI bridges.
4053842033e6SGabor Juhos
4054a09b9b68SKumar Gala- CONFIG_SYS_SRIO:
4055a09b9b68SKumar Gala		Chip has SRIO or not
4056a09b9b68SKumar Gala
4057a09b9b68SKumar Gala- CONFIG_SRIO1:
4058a09b9b68SKumar Gala		Board has SRIO 1 port available
4059a09b9b68SKumar Gala
4060a09b9b68SKumar Gala- CONFIG_SRIO2:
4061a09b9b68SKumar Gala		Board has SRIO 2 port available
4062a09b9b68SKumar Gala
4063c8b28152SLiu Gang- CONFIG_SRIO_PCIE_BOOT_MASTER
4064c8b28152SLiu Gang		Board can support master function for Boot from SRIO and PCIE
4065c8b28152SLiu Gang
4066a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_VIRT:
4067a09b9b68SKumar Gala		Virtual Address of SRIO port 'n' memory region
4068a09b9b68SKumar Gala
4069a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_PHYS:
4070a09b9b68SKumar Gala		Physical Address of SRIO port 'n' memory region
4071a09b9b68SKumar Gala
4072a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_SIZE:
4073a09b9b68SKumar Gala		Size of SRIO port 'n' memory region
4074a09b9b68SKumar Gala
407566bd1846SFabio Estevam- CONFIG_SYS_NAND_BUSWIDTH_16BIT
407666bd1846SFabio Estevam		Defined to tell the NAND controller that the NAND chip is using
407766bd1846SFabio Estevam		a 16 bit bus.
407866bd1846SFabio Estevam		Not all NAND drivers use this symbol.
4079a430e916SFabio Estevam		Example of drivers that use it:
408066bd1846SFabio Estevam		- drivers/mtd/nand/ndfc.c
4081a430e916SFabio Estevam		- drivers/mtd/nand/mxc_nand.c
4082eced4626SAlex Waterman
4083eced4626SAlex Waterman- CONFIG_SYS_NDFC_EBC0_CFG
4084eced4626SAlex Waterman		Sets the EBC0_CFG register for the NDFC. If not defined
4085eced4626SAlex Waterman		a default value will be used.
4086eced4626SAlex Waterman
4087bb99ad6dSBen Warren- CONFIG_SPD_EEPROM
4088218ca724SWolfgang Denk		Get DDR timing information from an I2C EEPROM. Common
4089218ca724SWolfgang Denk		with pluggable memory modules such as SODIMMs
4090218ca724SWolfgang Denk
4091bb99ad6dSBen Warren  SPD_EEPROM_ADDRESS
4092bb99ad6dSBen Warren		I2C address of the SPD EEPROM
4093bb99ad6dSBen Warren
40946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM
4095218ca724SWolfgang Denk		If SPD EEPROM is on an I2C bus other than the first
4096218ca724SWolfgang Denk		one, specify here. Note that the value must resolve
4097218ca724SWolfgang Denk		to something your driver can deal with.
4098bb99ad6dSBen Warren
40991b3e3c4fSYork Sun- CONFIG_SYS_DDR_RAW_TIMING
41001b3e3c4fSYork Sun		Get DDR timing information from other than SPD. Common with
41011b3e3c4fSYork Sun		soldered DDR chips onboard without SPD. DDR raw timing
41021b3e3c4fSYork Sun		parameters are extracted from datasheet and hard-coded into
41031b3e3c4fSYork Sun		header files or board specific files.
41041b3e3c4fSYork Sun
41056f5e1dc5SYork Sun- CONFIG_FSL_DDR_INTERACTIVE
41066f5e1dc5SYork Sun		Enable interactive DDR debugging. See doc/README.fsl-ddr.
41076f5e1dc5SYork Sun
41086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0
4109218ca724SWolfgang Denk		Only for 83xx systems. If specified, then DDR should
4110218ca724SWolfgang Denk		be configured using CS0 and CS1 instead of CS2 and CS3.
41112ad6b513STimur Tabi
4112c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12]
4113c26e454dSwdenk		Define to enable FEC[12] on a 8xx series processor.
4114c26e454dSwdenk
4115c26e454dSwdenk- CONFIG_FEC[12]_PHY
4116c26e454dSwdenk		Define to the hardcoded PHY address which corresponds
41176e592385Swdenk		to the given FEC; i. e.
4118c26e454dSwdenk			#define CONFIG_FEC1_PHY 4
4119c26e454dSwdenk		means that the PHY with address 4 is connected to FEC1
4120c26e454dSwdenk
4121c26e454dSwdenk		When set to -1, means to probe for first available.
4122c26e454dSwdenk
4123c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR
4124c26e454dSwdenk		The PHY does not have a RXERR line (RMII only).
4125c26e454dSwdenk		(so program the FEC to ignore it).
4126c26e454dSwdenk
4127c26e454dSwdenk- CONFIG_RMII
4128c26e454dSwdenk		Enable RMII mode for all FECs.
4129c26e454dSwdenk		Note that this is a global option, we can't
4130c26e454dSwdenk		have one FEC in standard MII mode and another in RMII mode.
4131c26e454dSwdenk
41325cf91d6bSwdenk- CONFIG_CRC32_VERIFY
41335cf91d6bSwdenk		Add a verify option to the crc32 command.
41345cf91d6bSwdenk		The syntax is:
41355cf91d6bSwdenk
41365cf91d6bSwdenk		=> crc32 -v <address> <count> <crc32>
41375cf91d6bSwdenk
41385cf91d6bSwdenk		Where address/count indicate a memory area
41395cf91d6bSwdenk		and crc32 is the correct crc32 which the
41405cf91d6bSwdenk		area should have.
41415cf91d6bSwdenk
414256523f12Swdenk- CONFIG_LOOPW
414356523f12Swdenk		Add the "loopw" memory command. This only takes effect if
4144602ad3b3SJon Loeliger		the memory commands are activated globally (CONFIG_CMD_MEM).
414556523f12Swdenk
41467b466641Sstroese- CONFIG_MX_CYCLIC
41477b466641Sstroese		Add the "mdc" and "mwc" memory commands. These are cyclic
41487b466641Sstroese		"md/mw" commands.
41497b466641Sstroese		Examples:
41507b466641Sstroese
41517b466641Sstroese		=> mdc.b 10 4 500
41527b466641Sstroese		This command will print 4 bytes (10,11,12,13) each 500 ms.
41537b466641Sstroese
41547b466641Sstroese		=> mwc.l 100 12345678 10
41557b466641Sstroese		This command will write 12345678 to address 100 all 10 ms.
41567b466641Sstroese
41577b466641Sstroese		This only takes effect if the memory commands are activated
4158602ad3b3SJon Loeliger		globally (CONFIG_CMD_MEM).
41597b466641Sstroese
41608aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT
4161afc1ce82SMacpaul Lin		[ARM, NDS32, MIPS only] If this variable is defined, then certain
4162e03f3169SWolfgang Denk		low level initializations (like setting up the memory
4163e03f3169SWolfgang Denk		controller) are omitted and/or U-Boot does not
4164e03f3169SWolfgang Denk		relocate itself into RAM.
41658aa1a2d1Swdenk
4166e03f3169SWolfgang Denk		Normally this variable MUST NOT be defined. The only
4167e03f3169SWolfgang Denk		exception is when U-Boot is loaded (to RAM) by some
4168e03f3169SWolfgang Denk		other boot loader or by a debugger which performs
4169e03f3169SWolfgang Denk		these initializations itself.
41708aa1a2d1Swdenk
4171401bb30bSAneesh V- CONFIG_SPL_BUILD
4172df81238bSMagnus Lilja		Modifies the behaviour of start.S when compiling a loader
4173df81238bSMagnus Lilja		that is executed before the actual U-Boot. E.g. when
4174df81238bSMagnus Lilja		compiling a NAND SPL.
4175400558b5Swdenk
41765df572f0SYing Zhang- CONFIG_SYS_MPC85XX_NO_RESETVEC
41775df572f0SYing Zhang		Only for 85xx systems. If this variable is specified, the section
41785df572f0SYing Zhang		.resetvec is not kept and the section .bootpg is placed in the
41795df572f0SYing Zhang		previous 4k of the .text section.
41805df572f0SYing Zhang
41814213fc29SSimon Glass- CONFIG_ARCH_MAP_SYSMEM
41824213fc29SSimon Glass		Generally U-Boot (and in particular the md command) uses
41834213fc29SSimon Glass		effective address. It is therefore not necessary to regard
41844213fc29SSimon Glass		U-Boot address as virtual addresses that need to be translated
41854213fc29SSimon Glass		to physical addresses. However, sandbox requires this, since
41864213fc29SSimon Glass		it maintains its own little RAM buffer which contains all
41874213fc29SSimon Glass		addressable memory. This option causes some memory accesses
41884213fc29SSimon Glass		to be mapped through map_sysmem() / unmap_sysmem().
41894213fc29SSimon Glass
4190d8834a13SMatthias Weisser- CONFIG_USE_ARCH_MEMCPY
4191d8834a13SMatthias Weisser  CONFIG_USE_ARCH_MEMSET
4192d8834a13SMatthias Weisser		If these options are used a optimized version of memcpy/memset will
4193d8834a13SMatthias Weisser		be used if available. These functions may be faster under some
4194d8834a13SMatthias Weisser		conditions but may increase the binary size.
4195d8834a13SMatthias Weisser
4196588a13f7SSimon Glass- CONFIG_X86_RESET_VECTOR
4197588a13f7SSimon Glass		If defined, the x86 reset vector code is included. This is not
4198588a13f7SSimon Glass		needed when U-Boot is running from Coreboot.
4199b16f521aSGabe Black
4200fc33705eSMark Jackson- CONFIG_SYS_MPUCLK
4201fc33705eSMark Jackson		Defines the MPU clock speed (in MHz).
4202fc33705eSMark Jackson
4203fc33705eSMark Jackson		NOTE : currently only supported on AM335x platforms.
42045b5ece9eSGabe Black
4205f2717b47STimur TabiFreescale QE/FMAN Firmware Support:
4206f2717b47STimur Tabi-----------------------------------
4207f2717b47STimur Tabi
4208f2717b47STimur TabiThe Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4209f2717b47STimur Tabiloading of "firmware", which is encoded in the QE firmware binary format.
4210f2717b47STimur TabiThis firmware often needs to be loaded during U-Boot booting, so macros
4211f2717b47STimur Tabiare used to identify the storage device (NOR flash, SPI, etc) and the address
4212f2717b47STimur Tabiwithin that device.
4213f2717b47STimur Tabi
4214f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_ADDR
4215f2717b47STimur Tabi	The address in the storage device where the firmware is located.  The
4216f2717b47STimur Tabi	meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4217f2717b47STimur Tabi	is also specified.
4218f2717b47STimur Tabi
4219f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_LENGTH
4220f2717b47STimur Tabi	The maximum possible size of the firmware.  The firmware binary format
4221f2717b47STimur Tabi	has a field that specifies the actual size of the firmware, but it
4222f2717b47STimur Tabi	might not be possible to read any part of the firmware unless some
4223f2717b47STimur Tabi	local storage is allocated to hold the entire firmware first.
4224f2717b47STimur Tabi
4225f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4226f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4227f2717b47STimur Tabi	normal addressable memory via the LBC.  CONFIG_SYS_FMAN_FW_ADDR is the
4228f2717b47STimur Tabi	virtual address in NOR flash.
4229f2717b47STimur Tabi
4230f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4231f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NAND flash.
4232f2717b47STimur Tabi	CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4233f2717b47STimur Tabi
4234f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4235f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SD/MMC
4236f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4237f2717b47STimur Tabi
4238f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
4239f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SPI
4240f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4241f2717b47STimur Tabi
4242292dc6c5SLiu Gang- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4243292dc6c5SLiu Gang	Specifies that QE/FMAN firmware is located in the remote (master)
4244292dc6c5SLiu Gang	memory space.	CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
4245fc54c7faSLiu Gang	can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4246fc54c7faSLiu Gang	window->master inbound window->master LAW->the ucode address in
4247fc54c7faSLiu Gang	master's memory space.
4248f2717b47STimur Tabi
4249c609719bSwdenkBuilding the Software:
4250c609719bSwdenk======================
4251c609719bSwdenk
4252218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments
4253218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support
4254218ca724SWolfgang Denkall possibly existing versions of cross development tools in all
4255218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we
4256218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4257218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot.
4258c609719bSwdenk
4259218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you
4260218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case,
4261218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell.
4262218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are
4263218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter:
4264c609719bSwdenk
4265218ca724SWolfgang Denk	$ CROSS_COMPILE=ppc_4xx-
4266218ca724SWolfgang Denk	$ export CROSS_COMPILE
4267c609719bSwdenk
42682f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in
42692f8d396bSPeter Tyser      the tools directory you can use the MinGW toolchain
42702f8d396bSPeter Tyser      (http://www.mingw.org).  Set your HOST tools to the MinGW
42712f8d396bSPeter Tyser      toolchain and execute 'make tools'.  For example:
42722f8d396bSPeter Tyser
42732f8d396bSPeter Tyser       $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
42742f8d396bSPeter Tyser
42752f8d396bSPeter Tyser      Binaries such as tools/mkimage.exe will be created which can
42762f8d396bSPeter Tyser      be executed on computers running Windows.
42772f8d396bSPeter Tyser
4278c609719bSwdenkU-Boot is intended to be simple to build. After installing the
4279c609719bSwdenksources you must configure U-Boot for one specific board type. This
4280c609719bSwdenkis done by typing:
4281c609719bSwdenk
4282c609719bSwdenk	make NAME_config
4283c609719bSwdenk
4284218ca724SWolfgang Denkwhere "NAME_config" is the name of one of the existing configu-
42854d675ae6SMichael Jonesrations; see boards.cfg for supported names.
428654387ac9Swdenk
4287c609719bSwdenkNote: for some board special configuration names may exist; check if
4288c609719bSwdenk      additional information is available from the board vendor; for
42892729af9dSwdenk      instance, the TQM823L systems are available without (standard)
42902729af9dSwdenk      or with LCD support. You can select such additional "features"
429111ccc33fSMarcel Ziswiler      when choosing the configuration, i. e.
4292c609719bSwdenk
42932729af9dSwdenk      make TQM823L_config
42942729af9dSwdenk	- will configure for a plain TQM823L, i. e. no LCD support
4295c609719bSwdenk
4296c609719bSwdenk      make TQM823L_LCD_config
4297c609719bSwdenk	- will configure for a TQM823L with U-Boot console on LCD
4298c609719bSwdenk
4299c609719bSwdenk      etc.
4300c609719bSwdenk
4301c609719bSwdenk
4302c609719bSwdenkFinally, type "make all", and you should get some working U-Boot
43037152b1d0Swdenkimages ready for download to / installation on your system:
4304c609719bSwdenk
4305c609719bSwdenk- "u-boot.bin" is a raw binary image
4306c609719bSwdenk- "u-boot" is an image in ELF binary format
4307c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format
4308c609719bSwdenk
4309baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved
4310baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change
4311baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory:
4312baf31249SMarian Balakowicz
4313baf31249SMarian Balakowicz1. Add O= to the make command line invocations:
4314baf31249SMarian Balakowicz
4315baf31249SMarian Balakowicz	make O=/tmp/build distclean
4316baf31249SMarian Balakowicz	make O=/tmp/build NAME_config
4317baf31249SMarian Balakowicz	make O=/tmp/build all
4318baf31249SMarian Balakowicz
4319baf31249SMarian Balakowicz2. Set environment variable BUILD_DIR to point to the desired location:
4320baf31249SMarian Balakowicz
4321baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
4322baf31249SMarian Balakowicz	make distclean
4323baf31249SMarian Balakowicz	make NAME_config
4324baf31249SMarian Balakowicz	make all
4325baf31249SMarian Balakowicz
4326baf31249SMarian BalakowiczNote that the command line "O=" setting overrides the BUILD_DIR environment
4327baf31249SMarian Balakowiczvariable.
4328baf31249SMarian Balakowicz
4329c609719bSwdenk
4330c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so
4331c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of
4332c609719bSwdenknative "make".
4333c609719bSwdenk
4334c609719bSwdenk
4335c609719bSwdenkIf the system board that you have is not listed, then you will need
4336c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these
4337c609719bSwdenksteps:
4338c609719bSwdenk
4339c609719bSwdenk1.  Add a new configuration option for your board to the toplevel
43404d675ae6SMichael Jones    "boards.cfg" file, using the existing entries as examples.
43414d675ae6SMichael Jones    Follow the instructions there to keep the boards in order.
4342c609719bSwdenk2.  Create a new directory to hold your board specific code. Add any
434385ec0bccSwdenk    files you need. In your board directory, you will need at least
434485ec0bccSwdenk    the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
434585ec0bccSwdenk3.  Create a new configuration file "include/configs/<board>.h" for
434685ec0bccSwdenk    your board
4347c609719bSwdenk3.  If you're porting U-Boot to a new CPU, then also create a new
4348c609719bSwdenk    directory to hold your CPU specific code. Add any files you need.
434985ec0bccSwdenk4.  Run "make <board>_config" with your new name.
4350c609719bSwdenk5.  Type "make", and you should get a working "u-boot.srec" file
4351c609719bSwdenk    to be installed on your target system.
435285ec0bccSwdenk6.  Debug and solve any problems that might arise.
4353c609719bSwdenk    [Of course, this last step is much harder than it sounds.]
4354c609719bSwdenk
4355c609719bSwdenk
4356c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.:
4357c609719bSwdenk==============================================================
4358c609719bSwdenk
4359c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board
4360c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to
4361c609719bSwdenkprovide feedback to the other developers. The feedback normally takes
4362c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest
4363218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources.
4364c609719bSwdenk
4365c609719bSwdenkBut before you submit such a patch, please verify that your modifi-
4366c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of
4367c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so,
4368c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot
4369c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You can
43707152b1d0Swdenkselect which (cross) compiler to use by passing a `CROSS_COMPILE'
4371218ca724SWolfgang Denkenvironment variable to the script, i. e. to use the ELDK cross tools
4372218ca724SWolfgang Denkyou can type
4373c609719bSwdenk
4374c609719bSwdenk	CROSS_COMPILE=ppc_8xx- MAKEALL
4375c609719bSwdenk
4376c609719bSwdenkor to build on a native PowerPC system you can type
4377c609719bSwdenk
4378c609719bSwdenk	CROSS_COMPILE=' ' MAKEALL
4379c609719bSwdenk
4380218ca724SWolfgang DenkWhen using the MAKEALL script, the default behaviour is to build
4381218ca724SWolfgang DenkU-Boot in the source directory. This location can be changed by
4382218ca724SWolfgang Denksetting the BUILD_DIR environment variable. Also, for each target
4383218ca724SWolfgang Denkbuilt, the MAKEALL script saves two log files (<target>.ERR and
4384218ca724SWolfgang Denk<target>.MAKEALL) in the <source dir>/LOG directory. This default
4385218ca724SWolfgang Denklocation can be changed by setting the MAKEALL_LOGDIR environment
4386218ca724SWolfgang Denkvariable. For example:
4387baf31249SMarian Balakowicz
4388baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
4389baf31249SMarian Balakowicz	export MAKEALL_LOGDIR=/tmp/log
4390baf31249SMarian Balakowicz	CROSS_COMPILE=ppc_8xx- MAKEALL
4391baf31249SMarian Balakowicz
4392218ca724SWolfgang DenkWith the above settings build objects are saved in the /tmp/build,
4393218ca724SWolfgang Denklog files are saved in the /tmp/log and the source tree remains clean
4394218ca724SWolfgang Denkduring the whole build process.
4395baf31249SMarian Balakowicz
4396baf31249SMarian Balakowicz
4397c609719bSwdenkSee also "U-Boot Porting Guide" below.
4398c609719bSwdenk
4399c609719bSwdenk
4400c609719bSwdenkMonitor Commands - Overview:
4401c609719bSwdenk============================
4402c609719bSwdenk
4403c609719bSwdenkgo	- start application at address 'addr'
4404c609719bSwdenkrun	- run commands in an environment variable
4405c609719bSwdenkbootm	- boot application image from memory
4406c609719bSwdenkbootp	- boot image via network using BootP/TFTP protocol
440744f074c7SMarek Vasutbootz   - boot zImage from memory
4408c609719bSwdenktftpboot- boot image via network using TFTP protocol
4409c609719bSwdenk	       and env variables "ipaddr" and "serverip"
4410c609719bSwdenk	       (and eventually "gatewayip")
44111fb7cd49SSimon Glasstftpput - upload a file via network using TFTP protocol
4412c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol
4413c609719bSwdenkdiskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
4414c609719bSwdenkloads	- load S-Record file over serial line
4415c609719bSwdenkloadb	- load binary file over serial line (kermit mode)
4416c609719bSwdenkmd	- memory display
4417c609719bSwdenkmm	- memory modify (auto-incrementing)
4418c609719bSwdenknm	- memory modify (constant address)
4419c609719bSwdenkmw	- memory write (fill)
4420c609719bSwdenkcp	- memory copy
4421c609719bSwdenkcmp	- memory compare
4422c609719bSwdenkcrc32	- checksum calculation
44230f89c54bSPeter Tyseri2c	- I2C sub-system
4424c609719bSwdenksspi	- SPI utility commands
4425c609719bSwdenkbase	- print or set address offset
4426c609719bSwdenkprintenv- print environment variables
4427c609719bSwdenksetenv	- set environment variables
4428c609719bSwdenksaveenv - save environment variables to persistent storage
4429c609719bSwdenkprotect - enable or disable FLASH write protection
4430c609719bSwdenkerase	- erase FLASH memory
4431c609719bSwdenkflinfo	- print FLASH memory information
443210635afaSKarl O. Pincnand	- NAND memory operations (see doc/README.nand)
4433c609719bSwdenkbdinfo	- print Board Info structure
4434c609719bSwdenkiminfo	- print header information for application image
4435c609719bSwdenkconinfo - print console devices and informations
4436c609719bSwdenkide	- IDE sub-system
4437c609719bSwdenkloop	- infinite loop on address range
443856523f12Swdenkloopw	- infinite write loop on address range
4439c609719bSwdenkmtest	- simple RAM test
4440c609719bSwdenkicache	- enable or disable instruction cache
4441c609719bSwdenkdcache	- enable or disable data cache
4442c609719bSwdenkreset	- Perform RESET of the CPU
4443c609719bSwdenkecho	- echo args to console
4444c609719bSwdenkversion - print monitor version
4445c609719bSwdenkhelp	- print online help
4446c609719bSwdenk?	- alias for 'help'
4447c609719bSwdenk
4448c609719bSwdenk
4449c609719bSwdenkMonitor Commands - Detailed Description:
4450c609719bSwdenk========================================
4451c609719bSwdenk
4452c609719bSwdenkTODO.
4453c609719bSwdenk
4454c609719bSwdenkFor now: just type "help <command>".
4455c609719bSwdenk
4456c609719bSwdenk
4457c609719bSwdenkEnvironment Variables:
4458c609719bSwdenk======================
4459c609719bSwdenk
4460c609719bSwdenkU-Boot supports user configuration using Environment Variables which
4461c609719bSwdenkcan be made persistent by saving to Flash memory.
4462c609719bSwdenk
4463c609719bSwdenkEnvironment Variables are set using "setenv", printed using
4464c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv"
4465c609719bSwdenkwithout a value can be used to delete a variable from the
4466c609719bSwdenkenvironment. As long as you don't save the environment you are
4467c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the
4468c609719bSwdenkenvironment is erased by accident, a default environment is provided.
4469c609719bSwdenk
4470c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables.
4471c96f86eeSWolfgang Denk
4472c96f86eeSWolfgang DenkList of environment variables (most likely not complete):
4473c609719bSwdenk
4474c609719bSwdenk  baudrate	- see CONFIG_BAUDRATE
4475c609719bSwdenk
4476c609719bSwdenk  bootdelay	- see CONFIG_BOOTDELAY
4477c609719bSwdenk
4478c609719bSwdenk  bootcmd	- see CONFIG_BOOTCOMMAND
4479c609719bSwdenk
4480c609719bSwdenk  bootargs	- Boot arguments when booting an RTOS image
4481c609719bSwdenk
4482c609719bSwdenk  bootfile	- Name of the image to load with TFTP
4483c609719bSwdenk
44847d721e34SBartlomiej Sieka  bootm_low	- Memory range available for image processing in the bootm
44857d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
44867d721e34SBartlomiej Sieka		  a hexadecimal number and defines lowest address allowed
44877d721e34SBartlomiej Sieka		  for use by the bootm command. See also "bootm_size"
44887d721e34SBartlomiej Sieka		  environment variable. Address defined by "bootm_low" is
44897d721e34SBartlomiej Sieka		  also the base of the initial memory mapping for the Linux
4490c3624e6eSGrant Likely		  kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4491c3624e6eSGrant Likely		  bootm_mapsize.
4492c3624e6eSGrant Likely
4493c3624e6eSGrant Likely  bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
4494c3624e6eSGrant Likely		  This variable is given as a hexadecimal number and it
4495c3624e6eSGrant Likely		  defines the size of the memory region starting at base
4496c3624e6eSGrant Likely		  address bootm_low that is accessible by the Linux kernel
4497c3624e6eSGrant Likely		  during early boot.  If unset, CONFIG_SYS_BOOTMAPSZ is used
4498c3624e6eSGrant Likely		  as the default value if it is defined, and bootm_size is
4499c3624e6eSGrant Likely		  used otherwise.
45007d721e34SBartlomiej Sieka
45017d721e34SBartlomiej Sieka  bootm_size	- Memory range available for image processing in the bootm
45027d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
45037d721e34SBartlomiej Sieka		  a hexadecimal number and defines the size of the region
45047d721e34SBartlomiej Sieka		  allowed for use by the bootm command. See also "bootm_low"
45057d721e34SBartlomiej Sieka		  environment variable.
45067d721e34SBartlomiej Sieka
45074bae9090SBartlomiej Sieka  updatefile	- Location of the software update file on a TFTP server, used
45084bae9090SBartlomiej Sieka		  by the automatic software update feature. Please refer to
45094bae9090SBartlomiej Sieka		  documentation in doc/README.update for more details.
45104bae9090SBartlomiej Sieka
4511c609719bSwdenk  autoload	- if set to "no" (any string beginning with 'n'),
4512c609719bSwdenk		  "bootp" will just load perform a lookup of the
4513c609719bSwdenk		  configuration from the BOOTP server, but not try to
4514c609719bSwdenk		  load any image using TFTP
4515c609719bSwdenk
4516c609719bSwdenk  autostart	- if set to "yes", an image loaded using the "bootp",
4517c609719bSwdenk		  "rarpboot", "tftpboot" or "diskboot" commands will
4518c609719bSwdenk		  be automatically started (by internally calling
4519c609719bSwdenk		  "bootm")
4520c609719bSwdenk
45214a6fd34bSwdenk		  If set to "no", a standalone image passed to the
45224a6fd34bSwdenk		  "bootm" command will be copied to the load address
45234a6fd34bSwdenk		  (and eventually uncompressed), but NOT be started.
45244a6fd34bSwdenk		  This can be used to load and uncompress arbitrary
45254a6fd34bSwdenk		  data.
45264a6fd34bSwdenk
4527a28afca5SDavid A. Long  fdt_high	- if set this restricts the maximum address that the
4528a28afca5SDavid A. Long		  flattened device tree will be copied into upon boot.
4529fa34f6b2SShawn Guo		  For example, if you have a system with 1 GB memory
4530fa34f6b2SShawn Guo		  at physical address 0x10000000, while Linux kernel
4531fa34f6b2SShawn Guo		  only recognizes the first 704 MB as low memory, you
4532fa34f6b2SShawn Guo		  may need to set fdt_high as 0x3C000000 to have the
4533fa34f6b2SShawn Guo		  device tree blob be copied to the maximum address
4534fa34f6b2SShawn Guo		  of the 704 MB low memory, so that Linux kernel can
4535fa34f6b2SShawn Guo		  access it during the boot procedure.
4536fa34f6b2SShawn Guo
4537a28afca5SDavid A. Long		  If this is set to the special value 0xFFFFFFFF then
4538a28afca5SDavid A. Long		  the fdt will not be copied at all on boot.  For this
4539a28afca5SDavid A. Long		  to work it must reside in writable memory, have
4540a28afca5SDavid A. Long		  sufficient padding on the end of it for u-boot to
4541a28afca5SDavid A. Long		  add the information it needs into it, and the memory
4542a28afca5SDavid A. Long		  must be accessible by the kernel.
4543a28afca5SDavid A. Long
4544eea63e05SSimon Glass  fdtcontroladdr- if set this is the address of the control flattened
4545eea63e05SSimon Glass		  device tree used by U-Boot when CONFIG_OF_CONTROL is
4546eea63e05SSimon Glass		  defined.
4547eea63e05SSimon Glass
454817ea1177Swdenk  i2cfast	- (PPC405GP|PPC405EP only)
454917ea1177Swdenk		  if set to 'y' configures Linux I2C driver for fast
455017ea1177Swdenk		  mode (400kHZ). This environment variable is used in
455117ea1177Swdenk		  initialization code. So, for changes to be effective
455217ea1177Swdenk		  it must be saved and board must be reset.
455317ea1177Swdenk
4554c609719bSwdenk  initrd_high	- restrict positioning of initrd images:
4555c609719bSwdenk		  If this variable is not set, initrd images will be
4556c609719bSwdenk		  copied to the highest possible address in RAM; this
4557c609719bSwdenk		  is usually what you want since it allows for
4558c609719bSwdenk		  maximum initrd size. If for some reason you want to
4559c609719bSwdenk		  make sure that the initrd image is loaded below the
45606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		  CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
4561c609719bSwdenk		  variable to a value of "no" or "off" or "0".
4562c609719bSwdenk		  Alternatively, you can set it to a maximum upper
4563c609719bSwdenk		  address to use (U-Boot will still check that it
4564c609719bSwdenk		  does not overwrite the U-Boot stack and data).
4565c609719bSwdenk
4566c609719bSwdenk		  For instance, when you have a system with 16 MB
45677152b1d0Swdenk		  RAM, and want to reserve 4 MB from use by Linux,
4568c609719bSwdenk		  you can do this by adding "mem=12M" to the value of
4569c609719bSwdenk		  the "bootargs" variable. However, now you must make
45707152b1d0Swdenk		  sure that the initrd image is placed in the first
4571c609719bSwdenk		  12 MB as well - this can be done with
4572c609719bSwdenk
4573c609719bSwdenk		  setenv initrd_high 00c00000
4574c609719bSwdenk
457538b99261Swdenk		  If you set initrd_high to 0xFFFFFFFF, this is an
457638b99261Swdenk		  indication to U-Boot that all addresses are legal
457738b99261Swdenk		  for the Linux kernel, including addresses in flash
457838b99261Swdenk		  memory. In this case U-Boot will NOT COPY the
457938b99261Swdenk		  ramdisk at all. This may be useful to reduce the
458038b99261Swdenk		  boot time on your system, but requires that this
458138b99261Swdenk		  feature is supported by your Linux kernel.
458238b99261Swdenk
4583c609719bSwdenk  ipaddr	- IP address; needed for tftpboot command
4584c609719bSwdenk
4585c609719bSwdenk  loadaddr	- Default load address for commands like "bootp",
4586dc7c9a1aSwdenk		  "rarpboot", "tftpboot", "loadb" or "diskboot"
4587c609719bSwdenk
4588c609719bSwdenk  loads_echo	- see CONFIG_LOADS_ECHO
4589c609719bSwdenk
4590c609719bSwdenk  serverip	- TFTP server IP address; needed for tftpboot command
4591c609719bSwdenk
4592c609719bSwdenk  bootretry	- see CONFIG_BOOT_RETRY_TIME
4593c609719bSwdenk
4594c609719bSwdenk  bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
4595c609719bSwdenk
4596c609719bSwdenk  bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
4597c609719bSwdenk
4598e2a53458SMike Frysinger  ethprime	- controls which interface is used first.
4599a3d991bdSwdenk
4600e2a53458SMike Frysinger  ethact	- controls which interface is currently active.
4601e2a53458SMike Frysinger		  For example you can do the following
4602a3d991bdSwdenk
460348690d80SHeiko Schocher		  => setenv ethact FEC
460448690d80SHeiko Schocher		  => ping 192.168.0.1 # traffic sent on FEC
460548690d80SHeiko Schocher		  => setenv ethact SCC
460648690d80SHeiko Schocher		  => ping 10.0.0.1 # traffic sent on SCC
4607a3d991bdSwdenk
4608e1692577SMatthias Fuchs  ethrotate	- When set to "no" U-Boot does not go through all
4609e1692577SMatthias Fuchs		  available network interfaces.
4610e1692577SMatthias Fuchs		  It just stays at the currently selected interface.
4611e1692577SMatthias Fuchs
4612a3d991bdSwdenk  netretry	- When set to "no" each network operation will
4613a3d991bdSwdenk		  either succeed or fail without retrying.
46146e592385Swdenk		  When set to "once" the network operation will
46156e592385Swdenk		  fail when all the available network interfaces
46166e592385Swdenk		  are tried once without success.
4617a3d991bdSwdenk		  Useful on scripts which control the retry operation
4618a3d991bdSwdenk		  themselves.
4619a3d991bdSwdenk
4620b4e2f89dSJean-Christophe PLAGNIOL-VILLARD  npe_ucode	- set load address for the NPE microcode
4621a1cf027aSJean-Christophe PLAGNIOL-VILLARD
462228cb9375SWolfgang Denk  tftpsrcport	- If this is set, the value is used for TFTP's
4623ecb0ccd9SWolfgang Denk		  UDP source port.
4624ecb0ccd9SWolfgang Denk
462528cb9375SWolfgang Denk  tftpdstport	- If this is set, the value is used for TFTP's UDP
462628cb9375SWolfgang Denk		  destination port instead of the Well Know Port 69.
462728cb9375SWolfgang Denk
4628c96f86eeSWolfgang Denk  tftpblocksize - Block size to use for TFTP transfers; if not set,
4629c96f86eeSWolfgang Denk		  we use the TFTP server's default block size
4630c96f86eeSWolfgang Denk
4631c96f86eeSWolfgang Denk  tftptimeout	- Retransmission timeout for TFTP packets (in milli-
4632c96f86eeSWolfgang Denk		  seconds, minimum value is 1000 = 1 second). Defines
4633c96f86eeSWolfgang Denk		  when a packet is considered to be lost so it has to
4634c96f86eeSWolfgang Denk		  be retransmitted. The default is 5000 = 5 seconds.
4635c96f86eeSWolfgang Denk		  Lowering this value may make downloads succeed
4636c96f86eeSWolfgang Denk		  faster in networks with high packet loss rates or
4637c96f86eeSWolfgang Denk		  with unreliable TFTP servers.
4638c96f86eeSWolfgang Denk
4639a3d991bdSwdenk  vlan		- When set to a value < 4095 the traffic over
464011ccc33fSMarcel Ziswiler		  Ethernet is encapsulated/received over 802.1q
4641a3d991bdSwdenk		  VLAN tagged frames.
4642c609719bSwdenk
4643dc0b7b0eSJason HobbsThe following image location variables contain the location of images
4644dc0b7b0eSJason Hobbsused in booting. The "Image" column gives the role of the image and is
4645dc0b7b0eSJason Hobbsnot an environment variable name. The other columns are environment
4646dc0b7b0eSJason Hobbsvariable names. "File Name" gives the name of the file on a TFTP
4647dc0b7b0eSJason Hobbsserver, "RAM Address" gives the location in RAM the image will be
4648dc0b7b0eSJason Hobbsloaded to, and "Flash Location" gives the image's address in NOR
4649dc0b7b0eSJason Hobbsflash or offset in NAND flash.
4650dc0b7b0eSJason Hobbs
4651dc0b7b0eSJason Hobbs*Note* - these variables don't have to be defined for all boards, some
4652dc0b7b0eSJason Hobbsboards currenlty use other variables for these purposes, and some
4653dc0b7b0eSJason Hobbsboards use these variables for other purposes.
4654dc0b7b0eSJason Hobbs
4655dc0b7b0eSJason HobbsImage		    File Name	     RAM Address       Flash Location
4656dc0b7b0eSJason Hobbs-----		    ---------	     -----------       --------------
4657dc0b7b0eSJason Hobbsu-boot		    u-boot	     u-boot_addr_r     u-boot_addr
4658dc0b7b0eSJason HobbsLinux kernel	    bootfile	     kernel_addr_r     kernel_addr
4659dc0b7b0eSJason Hobbsdevice tree blob    fdtfile	     fdt_addr_r	       fdt_addr
4660dc0b7b0eSJason Hobbsramdisk		    ramdiskfile	     ramdisk_addr_r    ramdisk_addr
4661dc0b7b0eSJason Hobbs
4662c609719bSwdenkThe following environment variables may be used and automatically
4663c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"),
4664c609719bSwdenkdepending the information provided by your boot server:
4665c609719bSwdenk
4666c609719bSwdenk  bootfile	- see above
4667c609719bSwdenk  dnsip		- IP address of your Domain Name Server
4668fe389a82Sstroese  dnsip2	- IP address of your secondary Domain Name Server
4669c609719bSwdenk  gatewayip	- IP address of the Gateway (Router) to use
4670c609719bSwdenk  hostname	- Target hostname
4671c609719bSwdenk  ipaddr	- see above
4672c609719bSwdenk  netmask	- Subnet Mask
4673c609719bSwdenk  rootpath	- Pathname of the root filesystem on the NFS server
4674c609719bSwdenk  serverip	- see above
4675c609719bSwdenk
4676c609719bSwdenk
4677c609719bSwdenkThere are two special Environment Variables:
4678c609719bSwdenk
4679c609719bSwdenk  serial#	- contains hardware identification information such
4680c609719bSwdenk		  as type string and/or serial number
4681c609719bSwdenk  ethaddr	- Ethernet address
4682c609719bSwdenk
4683c609719bSwdenkThese variables can be set only once (usually during manufacturing of
4684c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables
4685c609719bSwdenkonce they have been set once.
4686c609719bSwdenk
4687c609719bSwdenk
4688c1551ea8SstroeseFurther special Environment Variables:
4689c1551ea8Sstroese
4690c1551ea8Sstroese  ver		- Contains the U-Boot version string as printed
4691c1551ea8Sstroese		  with the "version" command. This variable is
4692c1551ea8Sstroese		  readonly (see CONFIG_VERSION_VARIABLE).
4693c1551ea8Sstroese
4694c1551ea8Sstroese
4695c609719bSwdenkPlease note that changes to some configuration parameters may take
4696c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-).
4697c609719bSwdenk
4698c609719bSwdenk
4699170ab110SJoe HershbergerCallback functions for environment variables:
4700170ab110SJoe Hershberger---------------------------------------------
4701170ab110SJoe Hershberger
4702170ab110SJoe HershbergerFor some environment variables, the behavior of u-boot needs to change
4703170ab110SJoe Hershbergerwhen their values are changed.  This functionailty allows functions to
4704170ab110SJoe Hershbergerbe associated with arbitrary variables.  On creation, overwrite, or
4705170ab110SJoe Hershbergerdeletion, the callback will provide the opportunity for some side
4706170ab110SJoe Hershbergereffect to happen or for the change to be rejected.
4707170ab110SJoe Hershberger
4708170ab110SJoe HershbergerThe callbacks are named and associated with a function using the
4709170ab110SJoe HershbergerU_BOOT_ENV_CALLBACK macro in your board or driver code.
4710170ab110SJoe Hershberger
4711170ab110SJoe HershbergerThese callbacks are associated with variables in one of two ways.  The
4712170ab110SJoe Hershbergerstatic list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
4713170ab110SJoe Hershbergerin the board configuration to a string that defines a list of
4714170ab110SJoe Hershbergerassociations.  The list must be in the following format:
4715170ab110SJoe Hershberger
4716170ab110SJoe Hershberger	entry = variable_name[:callback_name]
4717170ab110SJoe Hershberger	list = entry[,list]
4718170ab110SJoe Hershberger
4719170ab110SJoe HershbergerIf the callback name is not specified, then the callback is deleted.
4720170ab110SJoe HershbergerSpaces are also allowed anywhere in the list.
4721170ab110SJoe Hershberger
4722170ab110SJoe HershbergerCallbacks can also be associated by defining the ".callbacks" variable
4723170ab110SJoe Hershbergerwith the same list format above.  Any association in ".callbacks" will
4724170ab110SJoe Hershbergeroverride any association in the static list. You can define
4725170ab110SJoe HershbergerCONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
4726170ab110SJoe Hershberger".callbacks" envirnoment variable in the default or embedded environment.
4727170ab110SJoe Hershberger
4728170ab110SJoe Hershberger
4729f07771ccSwdenkCommand Line Parsing:
4730f07771ccSwdenk=====================
4731f07771ccSwdenk
4732f07771ccSwdenkThere are two different command line parsers available with U-Boot:
47337152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell:
4734f07771ccSwdenk
4735f07771ccSwdenkOld, simple command line parser:
4736f07771ccSwdenk--------------------------------
4737f07771ccSwdenk
4738f07771ccSwdenk- supports environment variables (through setenv / saveenv commands)
4739f07771ccSwdenk- several commands on one line, separated by ';'
4740fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax
4741f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\',
4742f07771ccSwdenk  for example:
4743fe126d8bSWolfgang Denk	setenv bootcmd bootm \${address}
4744f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example:
4745f07771ccSwdenk	setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
4746f07771ccSwdenk
4747f07771ccSwdenkHush shell:
4748f07771ccSwdenk-----------
4749f07771ccSwdenk
4750f07771ccSwdenk- similar to Bourne shell, with control structures like
4751f07771ccSwdenk  if...then...else...fi, for...do...done; while...do...done,
4752f07771ccSwdenk  until...do...done, ...
4753f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv
4754f07771ccSwdenk  commands) and local shell variables (through standard shell syntax
4755f07771ccSwdenk  "name=value"); only environment variables can be used with "run"
4756f07771ccSwdenk  command
4757f07771ccSwdenk
4758f07771ccSwdenkGeneral rules:
4759f07771ccSwdenk--------------
4760f07771ccSwdenk
4761f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run"
4762f07771ccSwdenk    command) contains several commands separated by semicolon, and
4763f07771ccSwdenk    one of these commands fails, then the remaining commands will be
4764f07771ccSwdenk    executed anyway.
4765f07771ccSwdenk
4766f07771ccSwdenk(2) If you execute several variables with one call to run (i. e.
476711ccc33fSMarcel Ziswiler    calling run with a list of variables as arguments), any failing
4768f07771ccSwdenk    command will cause "run" to terminate, i. e. the remaining
4769f07771ccSwdenk    variables are not executed.
4770f07771ccSwdenk
4771c609719bSwdenkNote for Redundant Ethernet Interfaces:
4772c609719bSwdenk=======================================
4773c609719bSwdenk
477411ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports
4775c609719bSwdenksuch configurations and is capable of automatic selection of a
47767152b1d0Swdenk"working" interface when needed. MAC assignment works as follows:
4777c609719bSwdenk
4778c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding
4779c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0),
4780c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ...
4781c609719bSwdenk
4782c609719bSwdenkIf the network interface stores some valid MAC address (for instance
4783c609719bSwdenkin SROM), this is used as default address if there is NO correspon-
4784c609719bSwdenkding setting in the environment; if the corresponding environment
4785c609719bSwdenkvariable is set, this overrides the settings in the card; that means:
4786c609719bSwdenk
4787c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the
4788c609719bSwdenk  environment, the SROM's address is used.
4789c609719bSwdenk
4790c609719bSwdenko If there is no valid address in the SROM, and a definition in the
4791c609719bSwdenk  environment exists, then the value from the environment variable is
4792c609719bSwdenk  used.
4793c609719bSwdenk
4794c609719bSwdenko If both the SROM and the environment contain a MAC address, and
4795c609719bSwdenk  both addresses are the same, this MAC address is used.
4796c609719bSwdenk
4797c609719bSwdenko If both the SROM and the environment contain a MAC address, and the
4798c609719bSwdenk  addresses differ, the value from the environment is used and a
4799c609719bSwdenk  warning is printed.
4800c609719bSwdenk
4801c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error
4802c609719bSwdenk  is raised.
4803c609719bSwdenk
4804ecee9324SBen WarrenIf Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
4805ecee9324SBen Warrenwill be programmed into hardware as part of the initialization process.	 This
4806ecee9324SBen Warrenmay be skipped by setting the appropriate 'ethmacskip' environment variable.
4807ecee9324SBen WarrenThe naming convention is as follows:
4808ecee9324SBen Warren"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
4809c609719bSwdenk
4810c609719bSwdenkImage Formats:
4811c609719bSwdenk==============
4812c609719bSwdenk
48133310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on)
48143310c549SMarian Balakowiczimages in two formats:
48153310c549SMarian Balakowicz
48163310c549SMarian BalakowiczNew uImage format (FIT)
48173310c549SMarian Balakowicz-----------------------
48183310c549SMarian Balakowicz
48193310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar
48203310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple
48213310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by
48223310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
48233310c549SMarian Balakowicz
48243310c549SMarian Balakowicz
48253310c549SMarian BalakowiczOld uImage format
48263310c549SMarian Balakowicz-----------------
48273310c549SMarian Balakowicz
48283310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything,
48293310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for
48303310c549SMarian Balakowiczdetails; basically, the header defines the following image properties:
4831c609719bSwdenk
4832c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
4833c609719bSwdenk  4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
4834f5ed9e39SPeter Tyser  LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
4835f5ed9e39SPeter Tyser  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
4836f5ed9e39SPeter Tyser  INTEGRITY).
48377b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
4838afc1ce82SMacpaul Lin  IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
4839afc1ce82SMacpaul Lin  Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
4840c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2)
4841c609719bSwdenk* Load Address
4842c609719bSwdenk* Entry Point
4843c609719bSwdenk* Image Name
4844c609719bSwdenk* Image Timestamp
4845c609719bSwdenk
4846c609719bSwdenkThe header is marked by a special Magic Number, and both the header
4847c609719bSwdenkand the data portions of the image are secured against corruption by
4848c609719bSwdenkCRC32 checksums.
4849c609719bSwdenk
4850c609719bSwdenk
4851c609719bSwdenkLinux Support:
4852c609719bSwdenk==============
4853c609719bSwdenk
4854c609719bSwdenkAlthough U-Boot should support any OS or standalone application
48557152b1d0Swdenkeasily, the main focus has always been on Linux during the design of
4856c609719bSwdenkU-Boot.
4857c609719bSwdenk
4858c609719bSwdenkU-Boot includes many features that so far have been part of some
4859c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any
4860c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image;
4861c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation
48627152b1d0Swdenkserves several purposes:
4863c609719bSwdenk
4864c609719bSwdenk- the same features can be used for other OS or standalone
4865c609719bSwdenk  applications (for instance: using compressed images to reduce the
4866c609719bSwdenk  Flash memory footprint)
4867c609719bSwdenk
4868c609719bSwdenk- it becomes much easier to port new Linux kernel versions because
48697152b1d0Swdenk  lots of low-level, hardware dependent stuff are done by U-Boot
4870c609719bSwdenk
4871c609719bSwdenk- the same Linux kernel image can now be used with different "initrd"
4872c609719bSwdenk  images; of course this also means that different kernel images can
4873c609719bSwdenk  be run with the same "initrd". This makes testing easier (you don't
4874c609719bSwdenk  have to build a new "zImage.initrd" Linux image when you just
4875c609719bSwdenk  change a file in your "initrd"). Also, a field-upgrade of the
4876c609719bSwdenk  software is easier now.
4877c609719bSwdenk
4878c609719bSwdenk
4879c609719bSwdenkLinux HOWTO:
4880c609719bSwdenk============
4881c609719bSwdenk
4882c609719bSwdenkPorting Linux to U-Boot based systems:
4883c609719bSwdenk---------------------------------------
4884c609719bSwdenk
4885c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to
4886c609719bSwdenkconfigure the Linux device drivers for use with your target hardware
4887c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to
4888c609719bSwdenkLinux :-).
4889c609719bSwdenk
4890a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
4891c609719bSwdenk
4892c609719bSwdenkJust make sure your machine specific header file (for instance
4893c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board
48941dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h,
48951dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value
48966d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR.
4897c609719bSwdenk
4898c609719bSwdenk
4899c609719bSwdenkConfiguring the Linux kernel:
4900c609719bSwdenk-----------------------------
4901c609719bSwdenk
4902c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root
4903c609719bSwdenkdevice (initial ramdisk, NFS) for your target system.
4904c609719bSwdenk
4905c609719bSwdenk
4906c609719bSwdenkBuilding a Linux Image:
4907c609719bSwdenk-----------------------
4908c609719bSwdenk
490924ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are
491024ee89b9Swdenknot used. If you use recent kernel source, a new build target
491124ee89b9Swdenk"uImage" will exist which automatically builds an image usable by
491224ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target,
491324ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a
491424ee89b9Swdenk100% compatible format.
4915c609719bSwdenk
4916c609719bSwdenkExample:
4917c609719bSwdenk
4918c609719bSwdenk	make TQM850L_config
4919c609719bSwdenk	make oldconfig
4920c609719bSwdenk	make dep
492124ee89b9Swdenk	make uImage
4922c609719bSwdenk
492324ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to
492424ee89b9Swdenkencapsulate a compressed Linux kernel image with header	 information,
492524ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing:
4926c609719bSwdenk
492724ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format):
492824ee89b9Swdenk
492924ee89b9Swdenk* convert the kernel into a raw binary image:
493024ee89b9Swdenk
493124ee89b9Swdenk	${CROSS_COMPILE}-objcopy -O binary \
493224ee89b9Swdenk				 -R .note -R .comment \
493324ee89b9Swdenk				 -S vmlinux linux.bin
493424ee89b9Swdenk
493524ee89b9Swdenk* compress the binary image:
493624ee89b9Swdenk
493724ee89b9Swdenk	gzip -9 linux.bin
493824ee89b9Swdenk
493924ee89b9Swdenk* package compressed binary image for U-Boot:
494024ee89b9Swdenk
494124ee89b9Swdenk	mkimage -A ppc -O linux -T kernel -C gzip \
494224ee89b9Swdenk		-a 0 -e 0 -n "Linux Kernel Image" \
494324ee89b9Swdenk		-d linux.bin.gz uImage
494424ee89b9Swdenk
494524ee89b9Swdenk
494624ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use
494724ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or
494824ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64
494924ee89b9Swdenkbyte header containing information about target architecture,
495024ee89b9Swdenkoperating system, image type, compression method, entry points, time
495124ee89b9Swdenkstamp, CRC32 checksums, etc.
495224ee89b9Swdenk
495324ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and
495424ee89b9Swdenkprint the header information, or to build new images.
4955c609719bSwdenk
4956c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information
4957c609719bSwdenkcontained in the header of an existing U-Boot image; this includes
4958c609719bSwdenkchecksum verification:
4959c609719bSwdenk
4960c609719bSwdenk	tools/mkimage -l image
4961c609719bSwdenk	  -l ==> list image header information
4962c609719bSwdenk
4963c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image
4964c609719bSwdenkfrom a "data file" which is used as image payload:
4965c609719bSwdenk
4966c609719bSwdenk	tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
4967c609719bSwdenk		      -n name -d data_file image
4968c609719bSwdenk	  -A ==> set architecture to 'arch'
4969c609719bSwdenk	  -O ==> set operating system to 'os'
4970c609719bSwdenk	  -T ==> set image type to 'type'
4971c609719bSwdenk	  -C ==> set compression type 'comp'
4972c609719bSwdenk	  -a ==> set load address to 'addr' (hex)
4973c609719bSwdenk	  -e ==> set entry point to 'ep' (hex)
4974c609719bSwdenk	  -n ==> set image name to 'name'
4975c609719bSwdenk	  -d ==> use image data from 'datafile'
4976c609719bSwdenk
497769459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load
497869459791Swdenkaddress (0x00000000), but the entry point address depends on the
497969459791Swdenkkernel version:
4980c609719bSwdenk
4981c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C,
498224ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000.
4983c609719bSwdenk
4984c609719bSwdenkSo a typical call to build a U-Boot image would read:
4985c609719bSwdenk
498624ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
498724ee89b9Swdenk	> -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
4988a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
498924ee89b9Swdenk	> examples/uImage.TQM850L
499024ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
4991c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
4992c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
4993c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
4994c609719bSwdenk	Load Address: 0x00000000
499524ee89b9Swdenk	Entry Point:  0x00000000
4996c609719bSwdenk
4997c609719bSwdenkTo verify the contents of the image (or check for corruption):
4998c609719bSwdenk
499924ee89b9Swdenk	-> tools/mkimage -l examples/uImage.TQM850L
500024ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5001c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5002c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
5003c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
5004c609719bSwdenk	Load Address: 0x00000000
500524ee89b9Swdenk	Entry Point:  0x00000000
5006c609719bSwdenk
5007c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade
5008c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this
5009c609719bSwdenkneeds more space in Flash, but boots much faster since it does not
5010c609719bSwdenkneed to be uncompressed:
5011c609719bSwdenk
5012a47a12beSStefan Roese	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
501324ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
501424ee89b9Swdenk	> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
5015a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
501624ee89b9Swdenk	> examples/uImage.TQM850L-uncompressed
501724ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5018c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5019c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (uncompressed)
5020c609719bSwdenk	Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
5021c609719bSwdenk	Load Address: 0x00000000
502224ee89b9Swdenk	Entry Point:  0x00000000
5023c609719bSwdenk
5024c609719bSwdenk
5025c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file
5026c609719bSwdenkwhen your kernel is intended to use an initial ramdisk:
5027c609719bSwdenk
5028c609719bSwdenk	-> tools/mkimage -n 'Simple Ramdisk Image' \
5029c609719bSwdenk	> -A ppc -O linux -T ramdisk -C gzip \
5030c609719bSwdenk	> -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5031c609719bSwdenk	Image Name:   Simple Ramdisk Image
5032c609719bSwdenk	Created:      Wed Jan 12 14:01:50 2000
5033c609719bSwdenk	Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
5034c609719bSwdenk	Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
5035c609719bSwdenk	Load Address: 0x00000000
5036c609719bSwdenk	Entry Point:  0x00000000
5037c609719bSwdenk
5038c609719bSwdenk
5039c609719bSwdenkInstalling a Linux Image:
5040c609719bSwdenk-------------------------
5041c609719bSwdenk
5042c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface,
5043c609719bSwdenkyou must convert the image to S-Record format:
5044c609719bSwdenk
5045c609719bSwdenk	objcopy -I binary -O srec examples/image examples/image.srec
5046c609719bSwdenk
5047c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot
5048c609719bSwdenkimage header, so the resulting S-Record file will be relative to
5049c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to
5050c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads'
5051c609719bSwdenkcommand.
5052c609719bSwdenk
5053c609719bSwdenkExample: install the image to address 0x40100000 (which on the
5054c609719bSwdenkTQM8xxL is in the first Flash bank):
5055c609719bSwdenk
5056c609719bSwdenk	=> erase 40100000 401FFFFF
5057c609719bSwdenk
5058c609719bSwdenk	.......... done
5059c609719bSwdenk	Erased 8 sectors
5060c609719bSwdenk
5061c609719bSwdenk	=> loads 40100000
5062c609719bSwdenk	## Ready for S-Record download ...
5063c609719bSwdenk	~>examples/image.srec
5064c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5065c609719bSwdenk	...
5066c609719bSwdenk	15989 15990 15991 15992
5067c609719bSwdenk	[file transfer complete]
5068c609719bSwdenk	[connected]
5069c609719bSwdenk	## Start Addr = 0x00000000
5070c609719bSwdenk
5071c609719bSwdenk
5072c609719bSwdenkYou can check the success of the download using the 'iminfo' command;
5073c609719bSwdenkthis includes a checksum verification so you can be sure no data
5074c609719bSwdenkcorruption happened:
5075c609719bSwdenk
5076c609719bSwdenk	=> imi 40100000
5077c609719bSwdenk
5078c609719bSwdenk	## Checking Image at 40100000 ...
5079c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5080c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5081c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5082c609719bSwdenk	   Load Address: 00000000
5083c609719bSwdenk	   Entry Point:	 0000000c
5084c609719bSwdenk	   Verifying Checksum ... OK
5085c609719bSwdenk
5086c609719bSwdenk
5087c609719bSwdenkBoot Linux:
5088c609719bSwdenk-----------
5089c609719bSwdenk
5090c609719bSwdenkThe "bootm" command is used to boot an application that is stored in
5091c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents
5092c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as
5093c609719bSwdenkparameters. You can check and modify this variable using the
5094c609719bSwdenk"printenv" and "setenv" commands:
5095c609719bSwdenk
5096c609719bSwdenk
5097c609719bSwdenk	=> printenv bootargs
5098c609719bSwdenk	bootargs=root=/dev/ram
5099c609719bSwdenk
5100c609719bSwdenk	=> setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5101c609719bSwdenk
5102c609719bSwdenk	=> printenv bootargs
5103c609719bSwdenk	bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5104c609719bSwdenk
5105c609719bSwdenk	=> bootm 40020000
5106c609719bSwdenk	## Booting Linux kernel at 40020000 ...
5107c609719bSwdenk	   Image Name:	 2.2.13 for NFS on TQM850L
5108c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5109c609719bSwdenk	   Data Size:	 381681 Bytes = 372 kB = 0 MB
5110c609719bSwdenk	   Load Address: 00000000
5111c609719bSwdenk	   Entry Point:	 0000000c
5112c609719bSwdenk	   Verifying Checksum ... OK
5113c609719bSwdenk	   Uncompressing Kernel Image ... OK
5114c609719bSwdenk	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
5115c609719bSwdenk	Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5116c609719bSwdenk	time_init: decrementer frequency = 187500000/60
5117c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
5118c609719bSwdenk	Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5119c609719bSwdenk	...
5120c609719bSwdenk
512111ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass
51227152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT
5123c609719bSwdenkformat!) to the "bootm" command:
5124c609719bSwdenk
5125c609719bSwdenk	=> imi 40100000 40200000
5126c609719bSwdenk
5127c609719bSwdenk	## Checking Image at 40100000 ...
5128c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5129c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5130c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5131c609719bSwdenk	   Load Address: 00000000
5132c609719bSwdenk	   Entry Point:	 0000000c
5133c609719bSwdenk	   Verifying Checksum ... OK
5134c609719bSwdenk
5135c609719bSwdenk	## Checking Image at 40200000 ...
5136c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
5137c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
5138c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
5139c609719bSwdenk	   Load Address: 00000000
5140c609719bSwdenk	   Entry Point:	 00000000
5141c609719bSwdenk	   Verifying Checksum ... OK
5142c609719bSwdenk
5143c609719bSwdenk	=> bootm 40100000 40200000
5144c609719bSwdenk	## Booting Linux kernel at 40100000 ...
5145c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5146c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5147c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5148c609719bSwdenk	   Load Address: 00000000
5149c609719bSwdenk	   Entry Point:	 0000000c
5150c609719bSwdenk	   Verifying Checksum ... OK
5151c609719bSwdenk	   Uncompressing Kernel Image ... OK
5152c609719bSwdenk	## Loading RAMDisk Image at 40200000 ...
5153c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
5154c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
5155c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
5156c609719bSwdenk	   Load Address: 00000000
5157c609719bSwdenk	   Entry Point:	 00000000
5158c609719bSwdenk	   Verifying Checksum ... OK
5159c609719bSwdenk	   Loading Ramdisk ... OK
5160c609719bSwdenk	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
5161c609719bSwdenk	Boot arguments: root=/dev/ram
5162c609719bSwdenk	time_init: decrementer frequency = 187500000/60
5163c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
5164c609719bSwdenk	...
5165c609719bSwdenk	RAMDISK: Compressed image found at block 0
5166c609719bSwdenk	VFS: Mounted root (ext2 filesystem).
5167c609719bSwdenk
5168c609719bSwdenk	bash#
5169c609719bSwdenk
51700267768eSMatthew McClintockBoot Linux and pass a flat device tree:
51710267768eSMatthew McClintock-----------
51720267768eSMatthew McClintock
51730267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section
51740267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The
51750267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated
51760267768eSMatthew McClintockflat device tree:
51770267768eSMatthew McClintock
51780267768eSMatthew McClintock=> print oftaddr
51790267768eSMatthew McClintockoftaddr=0x300000
51800267768eSMatthew McClintock=> print oft
51810267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb
51820267768eSMatthew McClintock=> tftp $oftaddr $oft
51830267768eSMatthew McClintockSpeed: 1000, full duplex
51840267768eSMatthew McClintockUsing TSEC0 device
51850267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101
51860267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'.
51870267768eSMatthew McClintockLoad address: 0x300000
51880267768eSMatthew McClintockLoading: #
51890267768eSMatthew McClintockdone
51900267768eSMatthew McClintockBytes transferred = 4106 (100a hex)
51910267768eSMatthew McClintock=> tftp $loadaddr $bootfile
51920267768eSMatthew McClintockSpeed: 1000, full duplex
51930267768eSMatthew McClintockUsing TSEC0 device
51940267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2
51950267768eSMatthew McClintockFilename 'uImage'.
51960267768eSMatthew McClintockLoad address: 0x200000
51970267768eSMatthew McClintockLoading:############
51980267768eSMatthew McClintockdone
51990267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex)
52000267768eSMatthew McClintock=> print loadaddr
52010267768eSMatthew McClintockloadaddr=200000
52020267768eSMatthew McClintock=> print oftaddr
52030267768eSMatthew McClintockoftaddr=0x300000
52040267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr
52050267768eSMatthew McClintock## Booting image at 00200000 ...
52060267768eSMatthew McClintock   Image Name:	 Linux-2.6.17-dirty
52070267768eSMatthew McClintock   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
52080267768eSMatthew McClintock   Data Size:	 1029343 Bytes = 1005.2 kB
52090267768eSMatthew McClintock   Load Address: 00000000
52100267768eSMatthew McClintock   Entry Point:	 00000000
52110267768eSMatthew McClintock   Verifying Checksum ... OK
52120267768eSMatthew McClintock   Uncompressing Kernel Image ... OK
52130267768eSMatthew McClintockBooting using flat device tree at 0x300000
52140267768eSMatthew McClintockUsing MPC85xx ADS machine description
52150267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
52160267768eSMatthew McClintock[snip]
52170267768eSMatthew McClintock
52180267768eSMatthew McClintock
52196069ff26SwdenkMore About U-Boot Image Types:
52206069ff26Swdenk------------------------------
52216069ff26Swdenk
52226069ff26SwdenkU-Boot supports the following image types:
52236069ff26Swdenk
52246069ff26Swdenk   "Standalone Programs" are directly runnable in the environment
52256069ff26Swdenk	provided by U-Boot; it is expected that (if they behave
52266069ff26Swdenk	well) you can continue to work in U-Boot after return from
52276069ff26Swdenk	the Standalone Program.
52286069ff26Swdenk   "OS Kernel Images" are usually images of some Embedded OS which
52296069ff26Swdenk	will take over control completely. Usually these programs
52306069ff26Swdenk	will install their own set of exception handlers, device
52316069ff26Swdenk	drivers, set up the MMU, etc. - this means, that you cannot
52326069ff26Swdenk	expect to re-enter U-Boot except by resetting the CPU.
52336069ff26Swdenk   "RAMDisk Images" are more or less just data blocks, and their
52346069ff26Swdenk	parameters (address, size) are passed to an OS kernel that is
52356069ff26Swdenk	being started.
52366069ff26Swdenk   "Multi-File Images" contain several images, typically an OS
52376069ff26Swdenk	(Linux) kernel image and one or more data images like
52386069ff26Swdenk	RAMDisks. This construct is useful for instance when you want
52396069ff26Swdenk	to boot over the network using BOOTP etc., where the boot
52406069ff26Swdenk	server provides just a single image file, but you want to get
52416069ff26Swdenk	for instance an OS kernel and a RAMDisk image.
52426069ff26Swdenk
52436069ff26Swdenk	"Multi-File Images" start with a list of image sizes, each
52446069ff26Swdenk	image size (in bytes) specified by an "uint32_t" in network
52456069ff26Swdenk	byte order. This list is terminated by an "(uint32_t)0".
52466069ff26Swdenk	Immediately after the terminating 0 follow the images, one by
52476069ff26Swdenk	one, all aligned on "uint32_t" boundaries (size rounded up to
52486069ff26Swdenk	a multiple of 4 bytes).
52496069ff26Swdenk
52506069ff26Swdenk   "Firmware Images" are binary images containing firmware (like
52516069ff26Swdenk	U-Boot or FPGA images) which usually will be programmed to
52526069ff26Swdenk	flash memory.
52536069ff26Swdenk
52546069ff26Swdenk   "Script files" are command sequences that will be executed by
52556069ff26Swdenk	U-Boot's command interpreter; this feature is especially
52566069ff26Swdenk	useful when you configure U-Boot to use a real shell (hush)
52576069ff26Swdenk	as command interpreter.
52586069ff26Swdenk
525944f074c7SMarek VasutBooting the Linux zImage:
526044f074c7SMarek Vasut-------------------------
526144f074c7SMarek Vasut
526244f074c7SMarek VasutOn some platforms, it's possible to boot Linux zImage. This is done
526344f074c7SMarek Vasutusing the "bootz" command. The syntax of "bootz" command is the same
526444f074c7SMarek Vasutas the syntax of "bootm" command.
526544f074c7SMarek Vasut
52668ac28563STom RiniNote, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
5267017e1f3fSMarek Vasutkernel with raw initrd images. The syntax is slightly different, the
5268017e1f3fSMarek Vasutaddress of the initrd must be augmented by it's size, in the following
5269017e1f3fSMarek Vasutformat: "<initrd addres>:<initrd size>".
5270017e1f3fSMarek Vasut
5271c609719bSwdenk
5272c609719bSwdenkStandalone HOWTO:
5273c609719bSwdenk=================
5274c609719bSwdenk
5275c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and
5276c609719bSwdenkrun "standalone" applications, which can use some resources of
5277c609719bSwdenkU-Boot like console I/O functions or interrupt services.
5278c609719bSwdenk
5279c609719bSwdenkTwo simple examples are included with the sources:
5280c609719bSwdenk
5281c609719bSwdenk"Hello World" Demo:
5282c609719bSwdenk-------------------
5283c609719bSwdenk
5284c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo
5285c609719bSwdenkapplication; it is automatically compiled when you build U-Boot.
5286c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it
5287c609719bSwdenklike that:
5288c609719bSwdenk
5289c609719bSwdenk	=> loads
5290c609719bSwdenk	## Ready for S-Record download ...
5291c609719bSwdenk	~>examples/hello_world.srec
5292c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
5293c609719bSwdenk	[file transfer complete]
5294c609719bSwdenk	[connected]
5295c609719bSwdenk	## Start Addr = 0x00040004
5296c609719bSwdenk
5297c609719bSwdenk	=> go 40004 Hello World! This is a test.
5298c609719bSwdenk	## Starting application at 0x00040004 ...
5299c609719bSwdenk	Hello World
5300c609719bSwdenk	argc = 7
5301c609719bSwdenk	argv[0] = "40004"
5302c609719bSwdenk	argv[1] = "Hello"
5303c609719bSwdenk	argv[2] = "World!"
5304c609719bSwdenk	argv[3] = "This"
5305c609719bSwdenk	argv[4] = "is"
5306c609719bSwdenk	argv[5] = "a"
5307c609719bSwdenk	argv[6] = "test."
5308c609719bSwdenk	argv[7] = "<NULL>"
5309c609719bSwdenk	Hit any key to exit ...
5310c609719bSwdenk
5311c609719bSwdenk	## Application terminated, rc = 0x0
5312c609719bSwdenk
5313c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt
5314c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'.
5315c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second.
5316c609719bSwdenkThe interrupt service routine is trivial, just printing a '.'
5317c609719bSwdenkcharacter, but this is just a demo program. The application can be
5318c609719bSwdenkcontrolled by the following keys:
5319c609719bSwdenk
5320c609719bSwdenk	? - print current values og the CPM Timer registers
5321c609719bSwdenk	b - enable interrupts and start timer
5322c609719bSwdenk	e - stop timer and disable interrupts
5323c609719bSwdenk	q - quit application
5324c609719bSwdenk
5325c609719bSwdenk	=> loads
5326c609719bSwdenk	## Ready for S-Record download ...
5327c609719bSwdenk	~>examples/timer.srec
5328c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
5329c609719bSwdenk	[file transfer complete]
5330c609719bSwdenk	[connected]
5331c609719bSwdenk	## Start Addr = 0x00040004
5332c609719bSwdenk
5333c609719bSwdenk	=> go 40004
5334c609719bSwdenk	## Starting application at 0x00040004 ...
5335c609719bSwdenk	TIMERS=0xfff00980
5336c609719bSwdenk	Using timer 1
5337c609719bSwdenk	  tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
5338c609719bSwdenk
5339c609719bSwdenkHit 'b':
5340c609719bSwdenk	[q, b, e, ?] Set interval 1000000 us
5341c609719bSwdenk	Enabling timer
5342c609719bSwdenkHit '?':
5343c609719bSwdenk	[q, b, e, ?] ........
5344c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
5345c609719bSwdenkHit '?':
5346c609719bSwdenk	[q, b, e, ?] .
5347c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
5348c609719bSwdenkHit '?':
5349c609719bSwdenk	[q, b, e, ?] .
5350c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
5351c609719bSwdenkHit '?':
5352c609719bSwdenk	[q, b, e, ?] .
5353c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
5354c609719bSwdenkHit 'e':
5355c609719bSwdenk	[q, b, e, ?] ...Stopping timer
5356c609719bSwdenkHit 'q':
5357c609719bSwdenk	[q, b, e, ?] ## Application terminated, rc = 0x0
5358c609719bSwdenk
5359c609719bSwdenk
536085ec0bccSwdenkMinicom warning:
536185ec0bccSwdenk================
536285ec0bccSwdenk
53637152b1d0SwdenkOver time, many people have reported problems when trying to use the
536485ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd)
536585ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under
5366f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and
536785ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and
5368e53515a2SKarl O. Pincuse "cu" for S-Record download ("loads" command).  See
5369e53515a2SKarl O. Pinchttp://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
5370e53515a2SKarl O. Pincfor help with kermit.
5371e53515a2SKarl O. Pinc
537285ec0bccSwdenk
537352f52c14SwdenkNevertheless, if you absolutely want to use it try adding this
537452f52c14Swdenkconfiguration to your "File transfer protocols" section:
537552f52c14Swdenk
537652f52c14Swdenk	   Name	   Program			Name U/D FullScr IO-Red. Multi
537752f52c14Swdenk	X  kermit  /usr/bin/kermit -i -l %l -s	 Y    U	   Y	   N	  N
537852f52c14Swdenk	Y  kermit  /usr/bin/kermit -i -l %l -r	 N    D	   Y	   N	  N
537952f52c14Swdenk
538052f52c14Swdenk
5381c609719bSwdenkNetBSD Notes:
5382c609719bSwdenk=============
5383c609719bSwdenk
5384c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host
5385c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx).
5386c609719bSwdenk
5387c609719bSwdenkBuilding requires a cross environment; it is known to work on
5388c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5389c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make).
5390c609719bSwdenkNote that the cross-powerpc package does not install include files;
5391c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is
5392c609719bSwdenkmissing.  This file has to be installed and patched manually:
5393c609719bSwdenk
5394c609719bSwdenk	# cd /usr/pkg/cross/powerpc-netbsd/include
5395c609719bSwdenk	# mkdir powerpc
5396c609719bSwdenk	# ln -s powerpc machine
5397c609719bSwdenk	# cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
5398c609719bSwdenk	# ${EDIT} powerpc/ansi.h	## must remove __va_list, _BSD_VA_LIST
5399c609719bSwdenk
5400c609719bSwdenkNative builds *don't* work due to incompatibilities between native
5401c609719bSwdenkand U-Boot include files.
5402c609719bSwdenk
5403c609719bSwdenkBooting assumes that (the first part of) the image booted is a
5404c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel
5405c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source
5406c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
54072a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
5408c609719bSwdenk
5409c609719bSwdenk
5410c609719bSwdenkImplementation Internals:
5411c609719bSwdenk=========================
5412c609719bSwdenk
5413c609719bSwdenkThe following is not intended to be a complete description of every
5414c609719bSwdenkimplementation detail. However, it should help to understand the
5415c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom
5416c609719bSwdenkhardware.
5417c609719bSwdenk
5418c609719bSwdenk
5419c609719bSwdenkInitial Stack, Global Data:
5420c609719bSwdenk---------------------------
5421c609719bSwdenk
5422c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot
5423c609719bSwdenkstarts running out of ROM (flash memory), usually without access to
5424c609719bSwdenksystem RAM (because the memory controller is not initialized yet).
5425c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS
5426c609719bSwdenkis not initialized as zero. To be able to get a C environment working
5427c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation
5428c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU
5429c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and
5430c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be
5431c609719bSwdenklocked as (mis-) used as memory, etc.
5432c609719bSwdenk
54337152b1d0Swdenk	Chris Hallinan posted a good summary of these issues to the
54340668236bSWolfgang Denk	U-Boot mailing list:
543543d9616cSwdenk
543643d9616cSwdenk	Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
543743d9616cSwdenk	From: "Chris Hallinan" <clh@net1plus.com>
543843d9616cSwdenk	Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
543943d9616cSwdenk	...
544043d9616cSwdenk
544143d9616cSwdenk	Correct me if I'm wrong, folks, but the way I understand it
544243d9616cSwdenk	is this: Using DCACHE as initial RAM for Stack, etc, does not
544343d9616cSwdenk	require any physical RAM backing up the cache. The cleverness
544443d9616cSwdenk	is that the cache is being used as a temporary supply of
544543d9616cSwdenk	necessary storage before the SDRAM controller is setup. It's
544611ccc33fSMarcel Ziswiler	beyond the scope of this list to explain the details, but you
544743d9616cSwdenk	can see how this works by studying the cache architecture and
544843d9616cSwdenk	operation in the architecture and processor-specific manuals.
544943d9616cSwdenk
545043d9616cSwdenk	OCM is On Chip Memory, which I believe the 405GP has 4K. It
545143d9616cSwdenk	is another option for the system designer to use as an
545211ccc33fSMarcel Ziswiler	initial stack/RAM area prior to SDRAM being available. Either
545343d9616cSwdenk	option should work for you. Using CS 4 should be fine if your
545443d9616cSwdenk	board designers haven't used it for something that would
545543d9616cSwdenk	cause you grief during the initial boot! It is frequently not
545643d9616cSwdenk	used.
545743d9616cSwdenk
54586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
545943d9616cSwdenk	with your processor/board/system design. The default value
546043d9616cSwdenk	you will find in any recent u-boot distribution in
54618a316c9bSStefan Roese	walnut.h should work for you. I'd set it to a value larger
546243d9616cSwdenk	than your SDRAM module. If you have a 64MB SDRAM module, set
546343d9616cSwdenk	it above 400_0000. Just make sure your board has no resources
546443d9616cSwdenk	that are supposed to respond to that address! That code in
546543d9616cSwdenk	start.S has been around a while and should work as is when
546643d9616cSwdenk	you get the config right.
546743d9616cSwdenk
546843d9616cSwdenk	-Chris Hallinan
546943d9616cSwdenk	DS4.COM, Inc.
547043d9616cSwdenk
5471c609719bSwdenkIt is essential to remember this, since it has some impact on the C
5472c609719bSwdenkcode for the initialization procedures:
5473c609719bSwdenk
5474c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt
5475c609719bSwdenk  to write it.
5476c609719bSwdenk
547711ccc33fSMarcel Ziswiler* Do not use any uninitialized global data (or implicitely initialized
5478c609719bSwdenk  as zero data - BSS segment) at all - this is undefined, initiali-
54797152b1d0Swdenk  zation is performed later (when relocating to RAM).
5480c609719bSwdenk
5481c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like
5482c609719bSwdenk  that.
5483c609719bSwdenk
5484c609719bSwdenkHaving only the stack as writable memory limits means we cannot use
5485c609719bSwdenknormal global data to share information beween the code. But it
5486c609719bSwdenkturned out that the implementation of U-Boot can be greatly
5487c609719bSwdenksimplified by making a global data structure (gd_t) available to all
5488c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_
5489c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of
5490c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we
5491c609719bSwdenkplace a pointer (gd) to the global data into a register which we
5492c609719bSwdenkreserve for this purpose.
5493c609719bSwdenk
54947152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the
5495c609719bSwdenkrelevant  (E)ABI  specifications for the current architecture, and by
5496c609719bSwdenkGCC's implementation.
5497c609719bSwdenk
5498c609719bSwdenkFor PowerPC, the following registers have specific use:
5499c609719bSwdenk	R1:	stack pointer
5500e7670f6cSWolfgang Denk	R2:	reserved for system use
5501c609719bSwdenk	R3-R4:	parameter passing and return values
5502c609719bSwdenk	R5-R10: parameter passing
5503c609719bSwdenk	R13:	small data area pointer
5504c609719bSwdenk	R30:	GOT pointer
5505c609719bSwdenk	R31:	frame pointer
5506c609719bSwdenk
5507e6bee808SJoakim Tjernlund	(U-Boot also uses R12 as internal GOT pointer. r12
5508e6bee808SJoakim Tjernlund	is a volatile register so r12 needs to be reset when
5509e6bee808SJoakim Tjernlund	going back and forth between asm and C)
5510c609719bSwdenk
5511e7670f6cSWolfgang Denk    ==> U-Boot will use R2 to hold a pointer to the global data
5512c609719bSwdenk
5513c609719bSwdenk    Note: on PPC, we could use a static initializer (since the
5514c609719bSwdenk    address of the global data structure is known at compile time),
5515c609719bSwdenk    but it turned out that reserving a register results in somewhat
5516c609719bSwdenk    smaller code - although the code savings are not that big (on
5517c609719bSwdenk    average for all boards 752 bytes for the whole U-Boot image,
5518c609719bSwdenk    624 text + 127 data).
5519c609719bSwdenk
5520c4db335cSRobin GetzOn Blackfin, the normal C ABI (except for P3) is followed as documented here:
55214c58eb55SMike Frysinger	http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
55224c58eb55SMike Frysinger
5523c4db335cSRobin Getz    ==> U-Boot will use P3 to hold a pointer to the global data
55244c58eb55SMike Frysinger
5525c609719bSwdenkOn ARM, the following registers are used:
5526c609719bSwdenk
5527c609719bSwdenk	R0:	function argument word/integer result
5528c609719bSwdenk	R1-R3:	function argument word
5529c609719bSwdenk	R9:	GOT pointer
5530c609719bSwdenk	R10:	stack limit (used only if stack checking if enabled)
5531c609719bSwdenk	R11:	argument (frame) pointer
5532c609719bSwdenk	R12:	temporary workspace
5533c609719bSwdenk	R13:	stack pointer
5534c609719bSwdenk	R14:	link register
5535c609719bSwdenk	R15:	program counter
5536c609719bSwdenk
5537c609719bSwdenk    ==> U-Boot will use R8 to hold a pointer to the global data
5538c609719bSwdenk
55390df01fd3SThomas ChouOn Nios II, the ABI is documented here:
55400df01fd3SThomas Chou	http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
55410df01fd3SThomas Chou
55420df01fd3SThomas Chou    ==> U-Boot will use gp to hold a pointer to the global data
55430df01fd3SThomas Chou
55440df01fd3SThomas Chou    Note: on Nios II, we give "-G0" option to gcc and don't use gp
55450df01fd3SThomas Chou    to access small data sections, so gp is free.
55460df01fd3SThomas Chou
5547afc1ce82SMacpaul LinOn NDS32, the following registers are used:
5548afc1ce82SMacpaul Lin
5549afc1ce82SMacpaul Lin	R0-R1:	argument/return
5550afc1ce82SMacpaul Lin	R2-R5:	argument
5551afc1ce82SMacpaul Lin	R15:	temporary register for assembler
5552afc1ce82SMacpaul Lin	R16:	trampoline register
5553afc1ce82SMacpaul Lin	R28:	frame pointer (FP)
5554afc1ce82SMacpaul Lin	R29:	global pointer (GP)
5555afc1ce82SMacpaul Lin	R30:	link register (LP)
5556afc1ce82SMacpaul Lin	R31:	stack pointer (SP)
5557afc1ce82SMacpaul Lin	PC:	program counter (PC)
5558afc1ce82SMacpaul Lin
5559afc1ce82SMacpaul Lin    ==> U-Boot will use R10 to hold a pointer to the global data
5560afc1ce82SMacpaul Lin
5561d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5562d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much.
5563c609719bSwdenk
5564c609719bSwdenkMemory Management:
5565c609719bSwdenk------------------
5566c609719bSwdenk
5567c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the
5568c609719bSwdenkMMU is not used either for address mapping nor for memory protection.
5569c609719bSwdenk
5570c609719bSwdenkThe available memory is mapped to fixed addresses using the memory
5571c609719bSwdenkcontroller. In this process, a contiguous block is formed for each
5572c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several
5573c609719bSwdenkphysical memory banks.
5574c609719bSwdenk
5575c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on
5576c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5577c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself
5578c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some
55796d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
5580c609719bSwdenkconfiguration setting]. Below that, a structure with global Board
5581c609719bSwdenkInfo data is placed, followed by the stack (growing downward).
5582c609719bSwdenk
5583c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB
5584c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF).
5585c609719bSwdenk
5586c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like
5587c609719bSwdenkthis:
5588c609719bSwdenk
5589c609719bSwdenk	0x0000 0000	Exception Vector code
5590c609719bSwdenk	      :
5591c609719bSwdenk	0x0000 1FFF
5592c609719bSwdenk	0x0000 2000	Free for Application Use
5593c609719bSwdenk	      :
5594c609719bSwdenk	      :
5595c609719bSwdenk
5596c609719bSwdenk	      :
5597c609719bSwdenk	      :
5598c609719bSwdenk	0x00FB FF20	Monitor Stack (Growing downward)
5599c609719bSwdenk	0x00FB FFAC	Board Info Data and permanent copy of global data
5600c609719bSwdenk	0x00FC 0000	Malloc Arena
5601c609719bSwdenk	      :
5602c609719bSwdenk	0x00FD FFFF
5603c609719bSwdenk	0x00FE 0000	RAM Copy of Monitor Code
5604c609719bSwdenk	...		eventually: LCD or video framebuffer
5605c609719bSwdenk	...		eventually: pRAM (Protected RAM - unchanged by reset)
5606c609719bSwdenk	0x00FF FFFF	[End of RAM]
5607c609719bSwdenk
5608c609719bSwdenk
5609c609719bSwdenkSystem Initialization:
5610c609719bSwdenk----------------------
5611c609719bSwdenk
5612c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point
561311ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset
5614c609719bSwdenkconfiguration for CS0# this is a mirror of the onboard Flash memory.
56157152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address.
5616c609719bSwdenkTo be able to implement the initialization code in C, a (small!)
5617c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs
5618c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked
5619c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core,
5620c609719bSwdenkthe caches and the SIU.
5621c609719bSwdenk
5622c609719bSwdenkNext, all (potentially) available memory banks are mapped using a
5623c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries
5624c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5625c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5626c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a
5627c609719bSwdenksimple memory test is run that determines the size of the SDRAM
5628c609719bSwdenkbanks.
5629c609719bSwdenk
5630c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of
56317152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first
5632c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address
5633c609719bSwdenk0x00000000, with any additional banks following immediately to create
5634c609719bSwdenkcontiguous memory starting from 0.
5635c609719bSwdenk
5636c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area
5637c609719bSwdenkand allocates memory for use by malloc() and for the global Board
5638c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM
5639c609719bSwdenkpages, and the final stack is set up.
5640c609719bSwdenk
5641c609719bSwdenkOnly after this relocation will you have a "normal" C environment;
5642c609719bSwdenkuntil that you are restricted in several ways, mostly because you are
5643c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a
5644c609719bSwdenknew address in RAM.
5645c609719bSwdenk
5646c609719bSwdenk
5647c609719bSwdenkU-Boot Porting Guide:
5648c609719bSwdenk----------------------
5649c609719bSwdenk
5650c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
56516aff3115Swdenklist, October 2002]
5652c609719bSwdenk
5653c609719bSwdenk
5654c609719bSwdenkint main(int argc, char *argv[])
5655c609719bSwdenk{
5656c609719bSwdenk	sighandler_t no_more_time;
5657c609719bSwdenk
5658c609719bSwdenk	signal(SIGALRM, no_more_time);
5659c609719bSwdenk	alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
5660c609719bSwdenk
5661c609719bSwdenk	if (available_money > available_manpower) {
56626c3fef28SJerry Van Baren		Pay consultant to port U-Boot;
5663c609719bSwdenk		return 0;
5664c609719bSwdenk	}
5665c609719bSwdenk
5666c609719bSwdenk	Download latest U-Boot source;
5667c609719bSwdenk
56680668236bSWolfgang Denk	Subscribe to u-boot mailing list;
56696aff3115Swdenk
56706c3fef28SJerry Van Baren	if (clueless)
5671c609719bSwdenk		email("Hi, I am new to U-Boot, how do I get started?");
5672c609719bSwdenk
5673c609719bSwdenk	while (learning) {
5674c609719bSwdenk		Read the README file in the top level directory;
56757cb22f97Swdenk		Read http://www.denx.de/twiki/bin/view/DULG/Manual;
56766c3fef28SJerry Van Baren		Read applicable doc/*.README;
5677c609719bSwdenk		Read the source, Luke;
56786c3fef28SJerry Van Baren		/* find . -name "*.[chS]" | xargs grep -i <keyword> */
5679c609719bSwdenk	}
5680c609719bSwdenk
56816c3fef28SJerry Van Baren	if (available_money > toLocalCurrency ($2500))
56826c3fef28SJerry Van Baren		Buy a BDI3000;
56836c3fef28SJerry Van Baren	else
5684c609719bSwdenk		Add a lot of aggravation and time;
5685c609719bSwdenk
56866c3fef28SJerry Van Baren	if (a similar board exists) {	/* hopefully... */
56876c3fef28SJerry Van Baren		cp -a board/<similar> board/<myboard>
56886c3fef28SJerry Van Baren		cp include/configs/<similar>.h include/configs/<myboard>.h
56896c3fef28SJerry Van Baren	} else {
5690c609719bSwdenk		Create your own board support subdirectory;
56916c3fef28SJerry Van Baren		Create your own board include/configs/<myboard>.h file;
56926c3fef28SJerry Van Baren	}
56936c3fef28SJerry Van Baren	Edit new board/<myboard> files
56946c3fef28SJerry Van Baren	Edit new include/configs/<myboard>.h
5695c609719bSwdenk
56966c3fef28SJerry Van Baren	while (!accepted) {
5697c609719bSwdenk		while (!running) {
5698c609719bSwdenk			do {
5699c609719bSwdenk				Add / modify source code;
5700c609719bSwdenk			} until (compiles);
5701c609719bSwdenk			Debug;
5702c609719bSwdenk			if (clueless)
5703c609719bSwdenk				email("Hi, I am having problems...");
5704c609719bSwdenk		}
57056c3fef28SJerry Van Baren		Send patch file to the U-Boot email list;
57066c3fef28SJerry Van Baren		if (reasonable critiques)
57076c3fef28SJerry Van Baren			Incorporate improvements from email list code review;
57086c3fef28SJerry Van Baren		else
57096c3fef28SJerry Van Baren			Defend code as written;
57106c3fef28SJerry Van Baren	}
5711c609719bSwdenk
5712c609719bSwdenk	return 0;
5713c609719bSwdenk}
5714c609719bSwdenk
5715c609719bSwdenkvoid no_more_time (int sig)
5716c609719bSwdenk{
5717c609719bSwdenk      hire_a_guru();
5718c609719bSwdenk}
5719c609719bSwdenk
5720c609719bSwdenk
5721c609719bSwdenkCoding Standards:
5722c609719bSwdenk-----------------
5723c609719bSwdenk
5724c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel
57252c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script
57267ca9296eSWolfgang Denk"scripts/Lindent" in your Linux kernel source directory.
5727c609719bSwdenk
57282c051651SDetlev ZundelSource files originating from a different project (for example the
57292c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not
57302c051651SDetlev Zundelreformated to ease subsequent migration to newer versions of those
57312c051651SDetlev Zundelsources.
57322c051651SDetlev Zundel
57332c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in
57342c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//)
57352c051651SDetlev Zundelin your code.
5736c609719bSwdenk
5737c178d3daSwdenkPlease also stick to the following formatting rules:
5738180d3f74Swdenk- remove any trailing white space
57397ca9296eSWolfgang Denk- use TAB characters for indentation and vertical alignment, not spaces
5740180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds
57417ca9296eSWolfgang Denk- do not add more than 2 consecutive empty lines to source files
5742180d3f74Swdenk- do not add trailing empty lines to source files
5743180d3f74Swdenk
5744c609719bSwdenkSubmissions which do not conform to the standards may be returned
5745c609719bSwdenkwith a request to reformat the changes.
5746c609719bSwdenk
5747c609719bSwdenk
5748c609719bSwdenkSubmitting Patches:
5749c609719bSwdenk-------------------
5750c609719bSwdenk
5751c609719bSwdenkSince the number of patches for U-Boot is growing, we need to
5752c609719bSwdenkestablish some rules. Submissions which do not conform to these rules
5753c609719bSwdenkmay be rejected, even when they contain important and valuable stuff.
5754c609719bSwdenk
57550d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details.
5756218ca724SWolfgang Denk
57570668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
57580668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot
57590668236bSWolfgang Denk
5760c609719bSwdenkWhen you send a patch, please include the following information with
5761c609719bSwdenkit:
5762c609719bSwdenk
5763c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes
5764c609719bSwdenk  this bug. Please try to include a way of demonstrating that the
5765c609719bSwdenk  patch actually fixes something.
5766c609719bSwdenk
5767c609719bSwdenk* For new features: a description of the feature and your
5768c609719bSwdenk  implementation.
5769c609719bSwdenk
5770c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch)
5771c609719bSwdenk
5772c609719bSwdenk* For major contributions, your entry to the CREDITS file
5773c609719bSwdenk
5774c609719bSwdenk* When you add support for a new board, don't forget to add this
57757ca9296eSWolfgang Denk  board to the MAINTAINERS file, too.
5776c609719bSwdenk
5777c609719bSwdenk* If your patch adds new configuration options, don't forget to
5778c609719bSwdenk  document these in the README file.
5779c609719bSwdenk
5780218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly*
5781218ca724SWolfgang Denk  recommended) you can easily generate the patch using the
57827ca9296eSWolfgang Denk  "git format-patch". If you then use "git send-email" to send it to
5783218ca724SWolfgang Denk  the U-Boot mailing list, you will avoid most of the common problems
5784218ca724SWolfgang Denk  with some other mail clients.
5785c609719bSwdenk
5786218ca724SWolfgang Denk  If you cannot use git, use "diff -purN OLD NEW". If your version of
5787218ca724SWolfgang Denk  diff does not support these options, then get the latest version of
5788218ca724SWolfgang Denk  GNU diff.
57896dff5529Swdenk
5790218ca724SWolfgang Denk  The current directory when running this command shall be the parent
5791218ca724SWolfgang Denk  directory of the U-Boot source tree (i. e. please make sure that
5792218ca724SWolfgang Denk  your patch includes sufficient directory information for the
5793218ca724SWolfgang Denk  affected files).
5794218ca724SWolfgang Denk
5795218ca724SWolfgang Denk  We prefer patches as plain text. MIME attachments are discouraged,
5796218ca724SWolfgang Denk  and compressed attachments must not be used.
5797c609719bSwdenk
579852f52c14Swdenk* If one logical set of modifications affects or creates several
579952f52c14Swdenk  files, all these changes shall be submitted in a SINGLE patch file.
580052f52c14Swdenk
580152f52c14Swdenk* Changesets that contain different, unrelated modifications shall be
580252f52c14Swdenk  submitted as SEPARATE patches, one patch per changeset.
580352f52c14Swdenk
580452f52c14Swdenk
5805c609719bSwdenkNotes:
5806c609719bSwdenk
5807c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched
5808c609719bSwdenk  source tree and make sure that no errors or warnings are reported
5809c609719bSwdenk  for any of the boards.
5810c609719bSwdenk
5811c609719bSwdenk* Keep your modifications to the necessary minimum: A patch
5812c609719bSwdenk  containing several unrelated changes or arbitrary reformats will be
5813c609719bSwdenk  returned with a request to re-formatting / split it.
5814c609719bSwdenk
5815c609719bSwdenk* If you modify existing code, make sure that your new code does not
5816c609719bSwdenk  add to the memory footprint of the code ;-) Small is beautiful!
5817c609719bSwdenk  When adding new features, these should compile conditionally only
5818c609719bSwdenk  (using #ifdef), and the resulting code with the new feature
5819c609719bSwdenk  disabled must not need more memory than the old code without your
5820c609719bSwdenk  modification.
582190dc6704Swdenk
58220668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the
58230668236bSWolfgang Denk  u-boot mailing list. Bigger patches will be moderated. If they are
58240668236bSWolfgang Denk  reasonable and not too big, they will be acknowledged. But patches
58250668236bSWolfgang Denk  bigger than the size limit should be avoided.
5826