xref: /openbmc/u-boot/README (revision 34e026f9b1eb3bcffb38e7787c2e6eac0e88ba85)
1c609719bSwdenk#
2eca3aeb3SWolfgang Denk# (C) Copyright 2000 - 2013
3c609719bSwdenk# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4c609719bSwdenk#
5eca3aeb3SWolfgang Denk# SPDX-License-Identifier:	GPL-2.0+
6c609719bSwdenk#
7c609719bSwdenk
8c609719bSwdenkSummary:
9c609719bSwdenk========
10c609719bSwdenk
1124ee89b9SwdenkThis directory contains the source code for U-Boot, a boot loader for
12e86e5a07SwdenkEmbedded boards based on PowerPC, ARM, MIPS and several other
13e86e5a07Swdenkprocessors, which can be installed in a boot ROM and used to
14e86e5a07Swdenkinitialize and test the hardware or to download and run application
15e86e5a07Swdenkcode.
16c609719bSwdenk
17c609719bSwdenkThe development of U-Boot is closely related to Linux: some parts of
1824ee89b9Swdenkthe source code originate in the Linux source tree, we have some
1924ee89b9Swdenkheader files in common, and special provision has been made to
20c609719bSwdenksupport booting of Linux images.
21c609719bSwdenk
22c609719bSwdenkSome attention has been paid to make this software easily
23c609719bSwdenkconfigurable and extendable. For instance, all monitor commands are
24c609719bSwdenkimplemented with the same call interface, so that it's very easy to
25c609719bSwdenkadd new commands. Also, instead of permanently adding rarely used
26c609719bSwdenkcode (for instance hardware test utilities) to the monitor, you can
27c609719bSwdenkload and run it dynamically.
28c609719bSwdenk
29c609719bSwdenk
30c609719bSwdenkStatus:
31c609719bSwdenk=======
32c609719bSwdenk
33c609719bSwdenkIn general, all boards for which a configuration option exists in the
34c609719bSwdenkMakefile have been tested to some extent and can be considered
35c609719bSwdenk"working". In fact, many of them are used in production systems.
36c609719bSwdenk
37c609719bSwdenkIn case of problems see the CHANGELOG and CREDITS files to find out
3827af930eSAlbert ARIBAUDwho contributed the specific port. The boards.cfg file lists board
39218ca724SWolfgang Denkmaintainers.
40c609719bSwdenk
41adb9d851SRobert P. J. DayNote: There is no CHANGELOG file in the actual U-Boot source tree;
42adb9d851SRobert P. J. Dayit can be created dynamically from the Git log using:
43adb9d851SRobert P. J. Day
44adb9d851SRobert P. J. Day	make CHANGELOG
45adb9d851SRobert P. J. Day
46c609719bSwdenk
47c609719bSwdenkWhere to get help:
48c609719bSwdenk==================
49c609719bSwdenk
50c609719bSwdenkIn case you have questions about, problems with or contributions for
51c609719bSwdenkU-Boot you should send a message to the U-Boot mailing list at
520c32565fSPeter Tyser<u-boot@lists.denx.de>. There is also an archive of previous traffic
530c32565fSPeter Tyseron the mailing list - please search the archive before asking FAQ's.
540c32565fSPeter TyserPlease see http://lists.denx.de/pipermail/u-boot and
550c32565fSPeter Tyserhttp://dir.gmane.org/gmane.comp.boot-loaders.u-boot
56c609719bSwdenk
57c609719bSwdenk
58218ca724SWolfgang DenkWhere to get source code:
59218ca724SWolfgang Denk=========================
60218ca724SWolfgang Denk
61218ca724SWolfgang DenkThe U-Boot source code is maintained in the git repository at
62218ca724SWolfgang Denkgit://www.denx.de/git/u-boot.git ; you can browse it online at
63218ca724SWolfgang Denkhttp://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
64218ca724SWolfgang Denk
65218ca724SWolfgang DenkThe "snapshot" links on this page allow you to download tarballs of
6611ccc33fSMarcel Ziswilerany version you might be interested in. Official releases are also
67218ca724SWolfgang Denkavailable for FTP download from the ftp://ftp.denx.de/pub/u-boot/
68218ca724SWolfgang Denkdirectory.
69218ca724SWolfgang Denk
70d4ee711dSAnatolij GustschinPre-built (and tested) images are available from
71218ca724SWolfgang Denkftp://ftp.denx.de/pub/u-boot/images/
72218ca724SWolfgang Denk
73218ca724SWolfgang Denk
74c609719bSwdenkWhere we come from:
75c609719bSwdenk===================
76c609719bSwdenk
77c609719bSwdenk- start from 8xxrom sources
7824ee89b9Swdenk- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
79c609719bSwdenk- clean up code
80c609719bSwdenk- make it easier to add custom boards
81c609719bSwdenk- make it possible to add other [PowerPC] CPUs
82c609719bSwdenk- extend functions, especially:
83c609719bSwdenk  * Provide extended interface to Linux boot loader
84c609719bSwdenk  * S-Record download
85c609719bSwdenk  * network boot
8611ccc33fSMarcel Ziswiler  * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
8724ee89b9Swdenk- create ARMBoot project (http://sourceforge.net/projects/armboot)
88c609719bSwdenk- add other CPU families (starting with ARM)
8924ee89b9Swdenk- create U-Boot project (http://sourceforge.net/projects/u-boot)
900d28f34bSMagnus Lilja- current project page: see http://www.denx.de/wiki/U-Boot
9124ee89b9Swdenk
9224ee89b9Swdenk
9324ee89b9SwdenkNames and Spelling:
9424ee89b9Swdenk===================
9524ee89b9Swdenk
9624ee89b9SwdenkThe "official" name of this project is "Das U-Boot". The spelling
9724ee89b9Swdenk"U-Boot" shall be used in all written text (documentation, comments
9824ee89b9Swdenkin source files etc.). Example:
9924ee89b9Swdenk
10024ee89b9Swdenk	This is the README file for the U-Boot project.
10124ee89b9Swdenk
10224ee89b9SwdenkFile names etc. shall be based on the string "u-boot". Examples:
10324ee89b9Swdenk
10424ee89b9Swdenk	include/asm-ppc/u-boot.h
10524ee89b9Swdenk
10624ee89b9Swdenk	#include <asm/u-boot.h>
10724ee89b9Swdenk
10824ee89b9SwdenkVariable names, preprocessor constants etc. shall be either based on
10924ee89b9Swdenkthe string "u_boot" or on "U_BOOT". Example:
11024ee89b9Swdenk
11124ee89b9Swdenk	U_BOOT_VERSION		u_boot_logo
11224ee89b9Swdenk	IH_OS_U_BOOT		u_boot_hush_start
113c609719bSwdenk
114c609719bSwdenk
11593f19cc0SwdenkVersioning:
11693f19cc0Swdenk===========
11793f19cc0Swdenk
118360d883aSThomas WeberStarting with the release in October 2008, the names of the releases
119360d883aSThomas Weberwere changed from numerical release numbers without deeper meaning
120360d883aSThomas Weberinto a time stamp based numbering. Regular releases are identified by
121360d883aSThomas Webernames consisting of the calendar year and month of the release date.
122360d883aSThomas WeberAdditional fields (if present) indicate release candidates or bug fix
123360d883aSThomas Weberreleases in "stable" maintenance trees.
12493f19cc0Swdenk
125360d883aSThomas WeberExamples:
126360d883aSThomas Weber	U-Boot v2009.11	    - Release November 2009
127360d883aSThomas Weber	U-Boot v2009.11.1   - Release 1 in version November 2009 stable tree
128360d883aSThomas Weber	U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release
12993f19cc0Swdenk
13093f19cc0Swdenk
131c609719bSwdenkDirectory Hierarchy:
132c609719bSwdenk====================
133c609719bSwdenk
1348d321b81SPeter Tyser/arch			Architecture specific files
1358d321b81SPeter Tyser  /arm			Files generic to ARM architecture
1368d321b81SPeter Tyser    /cpu		CPU specific files
1378d321b81SPeter Tyser      /arm720t		Files specific to ARM 720 CPUs
1388d321b81SPeter Tyser      /arm920t		Files specific to ARM 920 CPUs
1396eb0921aSAndreas Bießmann	/at91		Files specific to Atmel AT91RM9200 CPU
1408d321b81SPeter Tyser	/imx		Files specific to Freescale MC9328 i.MX CPUs
1418d321b81SPeter Tyser	/s3c24x0	Files specific to Samsung S3C24X0 CPUs
1428d321b81SPeter Tyser      /arm926ejs	Files specific to ARM 926 CPUs
1438d321b81SPeter Tyser      /arm1136		Files specific to ARM 1136 CPUs
1448d321b81SPeter Tyser      /pxa		Files specific to Intel XScale PXA CPUs
1458d321b81SPeter Tyser      /sa1100		Files specific to Intel StrongARM SA1100 CPUs
1468d321b81SPeter Tyser    /lib		Architecture specific library files
1478d321b81SPeter Tyser  /avr32		Files generic to AVR32 architecture
1488d321b81SPeter Tyser    /cpu		CPU specific files
1498d321b81SPeter Tyser    /lib		Architecture specific library files
1508d321b81SPeter Tyser  /blackfin		Files generic to Analog Devices Blackfin architecture
1518d321b81SPeter Tyser    /cpu		CPU specific files
1528d321b81SPeter Tyser    /lib		Architecture specific library files
1538d321b81SPeter Tyser  /m68k			Files generic to m68k architecture
1548d321b81SPeter Tyser    /cpu		CPU specific files
1558d321b81SPeter Tyser      /mcf52x2		Files specific to Freescale ColdFire MCF52x2 CPUs
1568d321b81SPeter Tyser      /mcf5227x		Files specific to Freescale ColdFire MCF5227x CPUs
1578d321b81SPeter Tyser      /mcf532x		Files specific to Freescale ColdFire MCF5329 CPUs
1588d321b81SPeter Tyser      /mcf5445x		Files specific to Freescale ColdFire MCF5445x CPUs
1598d321b81SPeter Tyser      /mcf547x_8x	Files specific to Freescale ColdFire MCF547x_8x CPUs
1608d321b81SPeter Tyser    /lib		Architecture specific library files
1618d321b81SPeter Tyser  /microblaze		Files generic to microblaze architecture
1628d321b81SPeter Tyser    /cpu		CPU specific files
1638d321b81SPeter Tyser    /lib		Architecture specific library files
1648d321b81SPeter Tyser  /mips			Files generic to MIPS architecture
1658d321b81SPeter Tyser    /cpu		CPU specific files
16692bbd64eSDaniel Schwierzeck      /mips32		Files specific to MIPS32 CPUs
16780421fccSXiangfu Liu      /xburst		Files specific to Ingenic XBurst CPUs
1688d321b81SPeter Tyser    /lib		Architecture specific library files
169afc1ce82SMacpaul Lin  /nds32		Files generic to NDS32 architecture
170afc1ce82SMacpaul Lin    /cpu		CPU specific files
171afc1ce82SMacpaul Lin      /n1213		Files specific to Andes Technology N1213 CPUs
172afc1ce82SMacpaul Lin    /lib		Architecture specific library files
1738d321b81SPeter Tyser  /nios2		Files generic to Altera NIOS2 architecture
1748d321b81SPeter Tyser    /cpu		CPU specific files
1758d321b81SPeter Tyser    /lib		Architecture specific library files
17633c7731bSRobert P. J. Day  /openrisc		Files generic to OpenRISC architecture
17733c7731bSRobert P. J. Day    /cpu		CPU specific files
17833c7731bSRobert P. J. Day    /lib		Architecture specific library files
179a47a12beSStefan Roese  /powerpc		Files generic to PowerPC architecture
1808d321b81SPeter Tyser    /cpu		CPU specific files
1818d321b81SPeter Tyser      /74xx_7xx		Files specific to Freescale MPC74xx and 7xx CPUs
1828d321b81SPeter Tyser      /mpc5xx		Files specific to Freescale MPC5xx CPUs
1838d321b81SPeter Tyser      /mpc5xxx		Files specific to Freescale MPC5xxx CPUs
1848d321b81SPeter Tyser      /mpc8xx		Files specific to Freescale MPC8xx CPUs
1858d321b81SPeter Tyser      /mpc824x		Files specific to Freescale MPC824x CPUs
1868d321b81SPeter Tyser      /mpc8260		Files specific to Freescale MPC8260 CPUs
1878d321b81SPeter Tyser      /mpc85xx		Files specific to Freescale MPC85xx CPUs
1888d321b81SPeter Tyser      /ppc4xx		Files specific to AMCC PowerPC 4xx CPUs
1898d321b81SPeter Tyser    /lib		Architecture specific library files
1908d321b81SPeter Tyser  /sh			Files generic to SH architecture
1918d321b81SPeter Tyser    /cpu		CPU specific files
1928d321b81SPeter Tyser      /sh2		Files specific to sh2 CPUs
1938d321b81SPeter Tyser      /sh3		Files specific to sh3 CPUs
1948d321b81SPeter Tyser      /sh4		Files specific to sh4 CPUs
1958d321b81SPeter Tyser    /lib		Architecture specific library files
1968d321b81SPeter Tyser  /sparc		Files generic to SPARC architecture
1978d321b81SPeter Tyser    /cpu		CPU specific files
1988d321b81SPeter Tyser      /leon2		Files specific to Gaisler LEON2 SPARC CPU
1998d321b81SPeter Tyser      /leon3		Files specific to Gaisler LEON3 SPARC CPU
2008d321b81SPeter Tyser    /lib		Architecture specific library files
20133c7731bSRobert P. J. Day  /x86			Files generic to x86 architecture
20233c7731bSRobert P. J. Day    /cpu		CPU specific files
20333c7731bSRobert P. J. Day    /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
21033c7731bSRobert P. J. Day/dts			Contains Makefile for building internal U-Boot fdt.
2118d321b81SPeter Tyser/examples		Example code for standalone applications, etc.
2128d321b81SPeter Tyser/fs			Filesystem code (cramfs, ext2, jffs2, etc.)
2138d321b81SPeter Tyser/include		Header Files
2148d321b81SPeter Tyser/lib			Files generic to all architectures
2158d321b81SPeter Tyser  /libfdt		Library files to support flattened device trees
2168d321b81SPeter Tyser  /lzma			Library files to support LZMA decompression
2178d321b81SPeter Tyser  /lzo			Library files to support LZO decompression
2188d321b81SPeter Tyser/net			Networking code
2198d321b81SPeter Tyser/post			Power On Self Test
22033c7731bSRobert P. J. Day/spl			Secondary Program Loader framework
2218d321b81SPeter Tyser/tools			Tools to build S-Record or U-Boot images, etc.
222c609719bSwdenk
223c609719bSwdenkSoftware Configuration:
224c609719bSwdenk=======================
225c609719bSwdenk
226c609719bSwdenkConfiguration is usually done using C preprocessor defines; the
227c609719bSwdenkrationale behind that is to avoid dead code whenever possible.
228c609719bSwdenk
229c609719bSwdenkThere are two classes of configuration variables:
230c609719bSwdenk
231c609719bSwdenk* Configuration _OPTIONS_:
232c609719bSwdenk  These are selectable by the user and have names beginning with
233c609719bSwdenk  "CONFIG_".
234c609719bSwdenk
235c609719bSwdenk* Configuration _SETTINGS_:
236c609719bSwdenk  These depend on the hardware etc. and should not be meddled with if
237c609719bSwdenk  you don't know what you're doing; they have names beginning with
2386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  "CONFIG_SYS_".
239c609719bSwdenk
240c609719bSwdenkLater we will add a configuration tool - probably similar to or even
241c609719bSwdenkidentical to what's used for the Linux kernel. Right now, we have to
242c609719bSwdenkdo the configuration by hand, which means creating some symbolic
243c609719bSwdenklinks and editing some configuration files. We use the TQM8xxL boards
244c609719bSwdenkas an example here.
245c609719bSwdenk
246c609719bSwdenk
247c609719bSwdenkSelection of Processor Architecture and Board Type:
248c609719bSwdenk---------------------------------------------------
249c609719bSwdenk
250c609719bSwdenkFor all supported boards there are ready-to-use default
251c609719bSwdenkconfigurations available; just type "make <board_name>_config".
252c609719bSwdenk
253c609719bSwdenkExample: For a TQM823L module type:
254c609719bSwdenk
255c609719bSwdenk	cd u-boot
256c609719bSwdenk	make TQM823L_config
257c609719bSwdenk
25811ccc33fSMarcel ZiswilerFor the Cogent platform, you need to specify the CPU type as well;
259c609719bSwdenke.g. "make cogent_mpc8xx_config". And also configure the cogent
260c609719bSwdenkdirectory according to the instructions in cogent/README.
261c609719bSwdenk
262c609719bSwdenk
263c609719bSwdenkConfiguration Options:
264c609719bSwdenk----------------------
265c609719bSwdenk
266c609719bSwdenkConfiguration depends on the combination of board and CPU type; all
267c609719bSwdenksuch information is kept in a configuration file
268c609719bSwdenk"include/configs/<board_name>.h".
269c609719bSwdenk
270c609719bSwdenkExample: For a TQM823L module, all configuration settings are in
271c609719bSwdenk"include/configs/TQM823L.h".
272c609719bSwdenk
273c609719bSwdenk
2747f6c2cbcSwdenkMany of the options are named exactly as the corresponding Linux
2757f6c2cbcSwdenkkernel configuration options. The intention is to make it easier to
2767f6c2cbcSwdenkbuild a config tool - later.
2777f6c2cbcSwdenk
2787f6c2cbcSwdenk
279c609719bSwdenkThe following options need to be configured:
280c609719bSwdenk
2812628114eSKim Phillips- CPU Type:	Define exactly one, e.g. CONFIG_MPC85XX.
282c609719bSwdenk
2832628114eSKim Phillips- Board Type:	Define exactly one, e.g. CONFIG_MPC8540ADS.
2846ccec449SWolfgang Denk
2856ccec449SWolfgang Denk- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
28609ea0de0SHaavard Skinnemoen		Define exactly one, e.g. CONFIG_ATSTK1002
287c609719bSwdenk
288c609719bSwdenk- CPU Module Type: (if CONFIG_COGENT is defined)
289c609719bSwdenk		Define exactly one of
290c609719bSwdenk		CONFIG_CMA286_60_OLD
291c609719bSwdenk--- FIXME --- not tested yet:
292c609719bSwdenk		CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
293c609719bSwdenk		CONFIG_CMA287_23, CONFIG_CMA287_50
294c609719bSwdenk
295c609719bSwdenk- Motherboard Type: (if CONFIG_COGENT is defined)
296c609719bSwdenk		Define exactly one of
297c609719bSwdenk		CONFIG_CMA101, CONFIG_CMA102
298c609719bSwdenk
299c609719bSwdenk- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
300c609719bSwdenk		Define one or more of
301c609719bSwdenk		CONFIG_CMA302
302c609719bSwdenk
303c609719bSwdenk- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
304c609719bSwdenk		Define one or more of
305c609719bSwdenk		CONFIG_LCD_HEARTBEAT	- update a character position on
30611ccc33fSMarcel Ziswiler					  the LCD display every second with
307c609719bSwdenk					  a "rotator" |\-/|\-/
308c609719bSwdenk
3092535d602Swdenk- Board flavour: (if CONFIG_MPC8260ADS is defined)
3102535d602Swdenk		CONFIG_ADSTYPE
3112535d602Swdenk		Possible values are:
3126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8260ADS	- original MPC8260ADS
3136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8266ADS	- MPC8266ADS
3146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_PQ2FADS	- PQ2FADS-ZU or PQ2FADS-VR
3156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8272ADS	- MPC8272ADS
3162535d602Swdenk
317cf946c6dSLei Wen- Marvell Family Member
318cf946c6dSLei Wen		CONFIG_SYS_MVFS		- define it if you want to enable
319cf946c6dSLei Wen					  multiple fs option at one time
320cf946c6dSLei Wen					  for marvell soc family
321cf946c6dSLei Wen
322c609719bSwdenk- MPC824X Family Member (if CONFIG_MPC824X is defined)
323c609719bSwdenk		Define exactly one of
324c609719bSwdenk		CONFIG_MPC8240, CONFIG_MPC8245
325c609719bSwdenk
32611ccc33fSMarcel Ziswiler- 8xx CPU Options: (if using an MPC8xx CPU)
32766ca92a5Swdenk		CONFIG_8xx_GCLK_FREQ	- deprecated: CPU clock if
32866ca92a5Swdenk					  get_gclk_freq() cannot work
3295da627a4Swdenk					  e.g. if there is no 32KHz
3305da627a4Swdenk					  reference PIT/RTC clock
33166ca92a5Swdenk		CONFIG_8xx_OSCLK	- PLL input clock (either EXTCLK
33266ca92a5Swdenk					  or XTAL/EXTAL)
333c609719bSwdenk
33466ca92a5Swdenk- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
3356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MIN
3366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MAX
33766ca92a5Swdenk		CONFIG_8xx_CPUCLK_DEFAULT
33875d1ea7fSwdenk			See doc/README.MPC866
33975d1ea7fSwdenk
3406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MEASURE_CPUCLK
34175d1ea7fSwdenk
34275d1ea7fSwdenk		Define this to measure the actual CPU clock instead
34375d1ea7fSwdenk		of relying on the correctness of the configured
34475d1ea7fSwdenk		values. Mostly useful for board bringup to make sure
34575d1ea7fSwdenk		the PLL is locked at the intended frequency. Note
34675d1ea7fSwdenk		that this requires a (stable) reference clock (32 kHz
3476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		RTC clock or CONFIG_SYS_8XX_XIN)
34875d1ea7fSwdenk
349506f3918SHeiko Schocher		CONFIG_SYS_DELAYED_ICACHE
350506f3918SHeiko Schocher
351506f3918SHeiko Schocher		Define this option if you want to enable the
352506f3918SHeiko Schocher		ICache only when Code runs from RAM.
353506f3918SHeiko Schocher
35466412c63SKumar Gala- 85xx CPU Options:
355ffd06e02SYork Sun		CONFIG_SYS_PPC64
356ffd06e02SYork Sun
357ffd06e02SYork Sun		Specifies that the core is a 64-bit PowerPC implementation (implements
358ffd06e02SYork Sun		the "64" category of the Power ISA). This is necessary for ePAPR
359ffd06e02SYork Sun		compliance, among other possible reasons.
360ffd06e02SYork Sun
36166412c63SKumar Gala		CONFIG_SYS_FSL_TBCLK_DIV
36266412c63SKumar Gala
36366412c63SKumar Gala		Defines the core time base clock divider ratio compared to the
36466412c63SKumar Gala		system clock.  On most PQ3 devices this is 8, on newer QorIQ
36566412c63SKumar Gala		devices it can be 16 or 32.  The ratio varies from SoC to Soc.
36666412c63SKumar Gala
3678f29084aSKumar Gala		CONFIG_SYS_FSL_PCIE_COMPAT
3688f29084aSKumar Gala
3698f29084aSKumar Gala		Defines the string to utilize when trying to match PCIe device
3708f29084aSKumar Gala		tree nodes for the given platform.
3718f29084aSKumar Gala
372afa6b551SPrabhakar Kushwaha		CONFIG_SYS_PPC_E500_DEBUG_TLB
373afa6b551SPrabhakar Kushwaha
374afa6b551SPrabhakar Kushwaha		Enables a temporary TLB entry to be used during boot to work
375afa6b551SPrabhakar Kushwaha		around limitations in e500v1 and e500v2 external debugger
376afa6b551SPrabhakar Kushwaha		support. This reduces the portions of the boot code where
377afa6b551SPrabhakar Kushwaha		breakpoints and single stepping do not work.  The value of this
378afa6b551SPrabhakar Kushwaha		symbol should be set to the TLB1 entry to be used for this
379afa6b551SPrabhakar Kushwaha		purpose.
380afa6b551SPrabhakar Kushwaha
38133eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510
38233eee330SScott Wood
38333eee330SScott Wood		Enables a workaround for erratum A004510.  If set,
38433eee330SScott Wood		then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
38533eee330SScott Wood		CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
38633eee330SScott Wood
38733eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
38833eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
38933eee330SScott Wood
39033eee330SScott Wood		Defines one or two SoC revisions (low 8 bits of SVR)
39133eee330SScott Wood		for which the A004510 workaround should be applied.
39233eee330SScott Wood
39333eee330SScott Wood		The rest of SVR is either not relevant to the decision
39433eee330SScott Wood		of whether the erratum is present (e.g. p2040 versus
39533eee330SScott Wood		p2041) or is implied by the build target, which controls
39633eee330SScott Wood		whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
39733eee330SScott Wood
39833eee330SScott Wood		See Freescale App Note 4493 for more information about
39933eee330SScott Wood		this erratum.
40033eee330SScott Wood
40174fa22edSPrabhakar Kushwaha		CONFIG_A003399_NOR_WORKAROUND
40274fa22edSPrabhakar Kushwaha		Enables a workaround for IFC erratum A003399. It is only
40374fa22edSPrabhakar Kushwaha		requred during NOR boot.
40474fa22edSPrabhakar Kushwaha
40533eee330SScott Wood		CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
40633eee330SScott Wood
40733eee330SScott Wood		This is the value to write into CCSR offset 0x18600
40833eee330SScott Wood		according to the A004510 workaround.
40933eee330SScott Wood
41064501c66SPriyanka Jain		CONFIG_SYS_FSL_DSP_DDR_ADDR
41164501c66SPriyanka Jain		This value denotes start offset of DDR memory which is
41264501c66SPriyanka Jain		connected exclusively to the DSP cores.
41364501c66SPriyanka Jain
414765b0bdbSPriyanka Jain		CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
415765b0bdbSPriyanka Jain		This value denotes start offset of M2 memory
416765b0bdbSPriyanka Jain		which is directly connected to the DSP core.
417765b0bdbSPriyanka Jain
41864501c66SPriyanka Jain		CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
41964501c66SPriyanka Jain		This value denotes start offset of M3 memory which is directly
42064501c66SPriyanka Jain		connected to the DSP core.
42164501c66SPriyanka Jain
422765b0bdbSPriyanka Jain		CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
423765b0bdbSPriyanka Jain		This value denotes start offset of DSP CCSR space.
424765b0bdbSPriyanka Jain
425b135991aSPriyanka Jain		CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
426b135991aSPriyanka Jain		Single Source Clock is clocking mode present in some of FSL SoC's.
427b135991aSPriyanka Jain		In this mode, a single differential clock is used to supply
428b135991aSPriyanka Jain		clocks to the sysclock, ddrclock and usbclock.
429b135991aSPriyanka Jain
430fb4a2409SAneesh Bansal		CONFIG_SYS_CPC_REINIT_F
431fb4a2409SAneesh Bansal		This CONFIG is defined when the CPC is configured as SRAM at the
432fb4a2409SAneesh Bansal		time of U-boot entry and is required to be re-initialized.
433fb4a2409SAneesh Bansal
4346cb461b4SDaniel Schwierzeck- Generic CPU options:
4356cb461b4SDaniel Schwierzeck		CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
4366cb461b4SDaniel Schwierzeck
4376cb461b4SDaniel Schwierzeck		Defines the endianess of the CPU. Implementation of those
4386cb461b4SDaniel Schwierzeck		values is arch specific.
4396cb461b4SDaniel Schwierzeck
4405614e71bSYork Sun		CONFIG_SYS_FSL_DDR
4415614e71bSYork Sun		Freescale DDR driver in use. This type of DDR controller is
4425614e71bSYork Sun		found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
4435614e71bSYork Sun		SoCs.
4445614e71bSYork Sun
4455614e71bSYork Sun		CONFIG_SYS_FSL_DDR_ADDR
4465614e71bSYork Sun		Freescale DDR memory-mapped register base.
4475614e71bSYork Sun
4485614e71bSYork Sun		CONFIG_SYS_FSL_DDR_EMU
4495614e71bSYork Sun		Specify emulator support for DDR. Some DDR features such as
4505614e71bSYork Sun		deskew training are not available.
4515614e71bSYork Sun
4525614e71bSYork Sun		CONFIG_SYS_FSL_DDRC_GEN1
4535614e71bSYork Sun		Freescale DDR1 controller.
4545614e71bSYork Sun
4555614e71bSYork Sun		CONFIG_SYS_FSL_DDRC_GEN2
4565614e71bSYork Sun		Freescale DDR2 controller.
4575614e71bSYork Sun
4585614e71bSYork Sun		CONFIG_SYS_FSL_DDRC_GEN3
4595614e71bSYork Sun		Freescale DDR3 controller.
4605614e71bSYork Sun
461*34e026f9SYork Sun		CONFIG_SYS_FSL_DDRC_GEN4
462*34e026f9SYork Sun		Freescale DDR4 controller.
463*34e026f9SYork Sun
4649ac4ffbdSYork Sun		CONFIG_SYS_FSL_DDRC_ARM_GEN3
4659ac4ffbdSYork Sun		Freescale DDR3 controller for ARM-based SoCs.
4669ac4ffbdSYork Sun
4675614e71bSYork Sun		CONFIG_SYS_FSL_DDR1
4685614e71bSYork Sun		Board config to use DDR1. It can be enabled for SoCs with
4695614e71bSYork Sun		Freescale DDR1 or DDR2 controllers, depending on the board
4705614e71bSYork Sun		implemetation.
4715614e71bSYork Sun
4725614e71bSYork Sun		CONFIG_SYS_FSL_DDR2
4735614e71bSYork Sun		Board config to use DDR2. It can be eanbeld for SoCs with
4745614e71bSYork Sun		Freescale DDR2 or DDR3 controllers, depending on the board
4755614e71bSYork Sun		implementation.
4765614e71bSYork Sun
4775614e71bSYork Sun		CONFIG_SYS_FSL_DDR3
4785614e71bSYork Sun		Board config to use DDR3. It can be enabled for SoCs with
479*34e026f9SYork Sun		Freescale DDR3 or DDR3L controllers.
480*34e026f9SYork Sun
481*34e026f9SYork Sun		CONFIG_SYS_FSL_DDR3L
482*34e026f9SYork Sun		Board config to use DDR3L. It can be enabled for SoCs with
483*34e026f9SYork Sun		DDR3L controllers.
484*34e026f9SYork Sun
485*34e026f9SYork Sun		CONFIG_SYS_FSL_DDR4
486*34e026f9SYork Sun		Board config to use DDR4. It can be enabled for SoCs with
487*34e026f9SYork Sun		DDR4 controllers.
4885614e71bSYork Sun
4891b4175d6SPrabhakar Kushwaha		CONFIG_SYS_FSL_IFC_BE
4901b4175d6SPrabhakar Kushwaha		Defines the IFC controller register space as Big Endian
4911b4175d6SPrabhakar Kushwaha
4921b4175d6SPrabhakar Kushwaha		CONFIG_SYS_FSL_IFC_LE
4931b4175d6SPrabhakar Kushwaha		Defines the IFC controller register space as Little Endian
4941b4175d6SPrabhakar Kushwaha
495690e4258SPrabhakar Kushwaha		CONFIG_SYS_FSL_PBL_PBI
496690e4258SPrabhakar Kushwaha		It enables addition of RCW (Power on reset configuration) in built image.
497690e4258SPrabhakar Kushwaha		Please refer doc/README.pblimage for more details
498690e4258SPrabhakar Kushwaha
499690e4258SPrabhakar Kushwaha		CONFIG_SYS_FSL_PBL_RCW
500690e4258SPrabhakar Kushwaha		It adds PBI(pre-boot instructions) commands in u-boot build image.
501690e4258SPrabhakar Kushwaha		PBI commands can be used to configure SoC before it starts the execution.
502690e4258SPrabhakar Kushwaha		Please refer doc/README.pblimage for more details
503690e4258SPrabhakar Kushwaha
5044e5b1bd0SYork Sun		CONFIG_SYS_FSL_DDR_BE
5054e5b1bd0SYork Sun		Defines the DDR controller register space as Big Endian
5064e5b1bd0SYork Sun
5074e5b1bd0SYork Sun		CONFIG_SYS_FSL_DDR_LE
5084e5b1bd0SYork Sun		Defines the DDR controller register space as Little Endian
5094e5b1bd0SYork Sun
5106b9e309aSYork Sun		CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
5116b9e309aSYork Sun		Physical address from the view of DDR controllers. It is the
5126b9e309aSYork Sun		same as CONFIG_SYS_DDR_SDRAM_BASE for  all Power SoCs. But
5136b9e309aSYork Sun		it could be different for ARM SoCs.
5146b9e309aSYork Sun
5156b1e1254SYork Sun		CONFIG_SYS_FSL_DDR_INTLV_256B
5166b1e1254SYork Sun		DDR controller interleaving on 256-byte. This is a special
5176b1e1254SYork Sun		interleaving mode, handled by Dickens for Freescale layerscape
5186b1e1254SYork Sun		SoCs with ARM core.
5196b1e1254SYork Sun
5200b953ffcSMarkus Klotzbuecher- Intel Monahans options:
5216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
5220b953ffcSMarkus Klotzbuecher
5230b953ffcSMarkus Klotzbuecher		Defines the Monahans run mode to oscillator
5240b953ffcSMarkus Klotzbuecher		ratio. Valid values are 8, 16, 24, 31. The core
5250b953ffcSMarkus Klotzbuecher		frequency is this value multiplied by 13 MHz.
5260b953ffcSMarkus Klotzbuecher
5276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
5280b953ffcSMarkus Klotzbuecher
5290b953ffcSMarkus Klotzbuecher		Defines the Monahans turbo mode to oscillator
5300b953ffcSMarkus Klotzbuecher		ratio. Valid values are 1 (default if undefined) and
5310b953ffcSMarkus Klotzbuecher		2. The core frequency as calculated above is multiplied
5320b953ffcSMarkus Klotzbuecher		by this value.
5330b953ffcSMarkus Klotzbuecher
53492bbd64eSDaniel Schwierzeck- MIPS CPU options:
53592bbd64eSDaniel Schwierzeck		CONFIG_SYS_INIT_SP_OFFSET
53692bbd64eSDaniel Schwierzeck
53792bbd64eSDaniel Schwierzeck		Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
53892bbd64eSDaniel Schwierzeck		pointer. This is needed for the temporary stack before
53992bbd64eSDaniel Schwierzeck		relocation.
54092bbd64eSDaniel Schwierzeck
54192bbd64eSDaniel Schwierzeck		CONFIG_SYS_MIPS_CACHE_MODE
54292bbd64eSDaniel Schwierzeck
54392bbd64eSDaniel Schwierzeck		Cache operation mode for the MIPS CPU.
54492bbd64eSDaniel Schwierzeck		See also arch/mips/include/asm/mipsregs.h.
54592bbd64eSDaniel Schwierzeck		Possible values are:
54692bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_NO_WA
54792bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_WA
54892bbd64eSDaniel Schwierzeck			CONF_CM_UNCACHED
54992bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_NONCOHERENT
55092bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_CE
55192bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_COW
55292bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_CUW
55392bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_ACCELERATED
55492bbd64eSDaniel Schwierzeck
55592bbd64eSDaniel Schwierzeck		CONFIG_SYS_XWAY_EBU_BOOTCFG
55692bbd64eSDaniel Schwierzeck
55792bbd64eSDaniel Schwierzeck		Special option for Lantiq XWAY SoCs for booting from NOR flash.
55892bbd64eSDaniel Schwierzeck		See also arch/mips/cpu/mips32/start.S.
55992bbd64eSDaniel Schwierzeck
56092bbd64eSDaniel Schwierzeck		CONFIG_XWAY_SWAP_BYTES
56192bbd64eSDaniel Schwierzeck
56292bbd64eSDaniel Schwierzeck		Enable compilation of tools/xway-swap-bytes needed for Lantiq
56392bbd64eSDaniel Schwierzeck		XWAY SoCs for booting from NOR flash. The U-Boot image needs to
56492bbd64eSDaniel Schwierzeck		be swapped if a flash programmer is used.
56592bbd64eSDaniel Schwierzeck
566b67d8816SChristian Riesch- ARM options:
567b67d8816SChristian Riesch		CONFIG_SYS_EXCEPTION_VECTORS_HIGH
568b67d8816SChristian Riesch
569b67d8816SChristian Riesch		Select high exception vectors of the ARM core, e.g., do not
570b67d8816SChristian Riesch		clear the V bit of the c1 register of CP15.
571b67d8816SChristian Riesch
5725356f545SAneesh V		CONFIG_SYS_THUMB_BUILD
5735356f545SAneesh V
5745356f545SAneesh V		Use this flag to build U-Boot using the Thumb instruction
5755356f545SAneesh V		set for ARM architectures. Thumb instruction set provides
5765356f545SAneesh V		better code density. For ARM architectures that support
5775356f545SAneesh V		Thumb2 this flag will result in Thumb2 code generated by
5785356f545SAneesh V		GCC.
5795356f545SAneesh V
580c5d4752cSStephen Warren		CONFIG_ARM_ERRATA_716044
5810678587fSStephen Warren		CONFIG_ARM_ERRATA_742230
5820678587fSStephen Warren		CONFIG_ARM_ERRATA_743622
5830678587fSStephen Warren		CONFIG_ARM_ERRATA_751472
584f71cbfe3SNitin Garg		CONFIG_ARM_ERRATA_794072
585b7588e3bSNitin Garg		CONFIG_ARM_ERRATA_761320
5860678587fSStephen Warren
5870678587fSStephen Warren		If set, the workarounds for these ARM errata are applied early
5880678587fSStephen Warren		during U-Boot startup. Note that these options force the
5890678587fSStephen Warren		workarounds to be applied; no CPU-type/version detection
5900678587fSStephen Warren		exists, unlike the similar options in the Linux kernel. Do not
5910678587fSStephen Warren		set these options unless they apply!
5920678587fSStephen Warren
593795659dcSStephen Warren- CPU timer options:
594795659dcSStephen Warren		CONFIG_SYS_HZ
595795659dcSStephen Warren
596795659dcSStephen Warren		The frequency of the timer returned by get_timer().
597795659dcSStephen Warren		get_timer() must operate in milliseconds and this CONFIG
598795659dcSStephen Warren		option must be set to 1000.
599795659dcSStephen Warren
6005da627a4Swdenk- Linux Kernel Interface:
601c609719bSwdenk		CONFIG_CLOCKS_IN_MHZ
602c609719bSwdenk
603c609719bSwdenk		U-Boot stores all clock information in Hz
604c609719bSwdenk		internally. For binary compatibility with older Linux
605c609719bSwdenk		kernels (which expect the clocks passed in the
606c609719bSwdenk		bd_info data to be in MHz) the environment variable
607c609719bSwdenk		"clocks_in_mhz" can be defined so that U-Boot
608c609719bSwdenk		converts clock data to MHZ before passing it to the
609c609719bSwdenk		Linux kernel.
610c609719bSwdenk		When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
611c609719bSwdenk		"clocks_in_mhz=1" is automatically included in the
612c609719bSwdenk		default environment.
613c609719bSwdenk
6145da627a4Swdenk		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]
6155da627a4Swdenk
61611ccc33fSMarcel Ziswiler		When transferring memsize parameter to linux, some versions
6175da627a4Swdenk		expect it to be in bytes, others in MB.
6185da627a4Swdenk		Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
6195da627a4Swdenk
620fec6d9eeSGerald Van Baren		CONFIG_OF_LIBFDT
621f57f70aaSWolfgang Denk
622f57f70aaSWolfgang Denk		New kernel versions are expecting firmware settings to be
623213bf8c8SGerald Van Baren		passed using flattened device trees (based on open firmware
624213bf8c8SGerald Van Baren		concepts).
625213bf8c8SGerald Van Baren
626213bf8c8SGerald Van Baren		CONFIG_OF_LIBFDT
627213bf8c8SGerald Van Baren		 * New libfdt-based support
628213bf8c8SGerald Van Baren		 * Adds the "fdt" command
6293bb342fcSKim Phillips		 * The bootm command automatically updates the fdt
630213bf8c8SGerald Van Baren
631b55ae402SMarcel Ziswiler		OF_CPU - The proper name of the cpus node (only required for
632b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
633b55ae402SMarcel Ziswiler		OF_SOC - The proper name of the soc node (only required for
634b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
635f57f70aaSWolfgang Denk		OF_TBCLK - The timebase frequency.
636c2871f03SKumar Gala		OF_STDOUT_PATH - The path to the console device
637f57f70aaSWolfgang Denk
63811ccc33fSMarcel Ziswiler		boards with QUICC Engines require OF_QE to set UCC MAC
63911ccc33fSMarcel Ziswiler		addresses
6403bb342fcSKim Phillips
6414e253137SKumar Gala		CONFIG_OF_BOARD_SETUP
6424e253137SKumar Gala
6434e253137SKumar Gala		Board code has addition modification that it wants to make
6444e253137SKumar Gala		to the flat device tree before handing it off to the kernel
6456705d81eSwdenk
6460267768eSMatthew McClintock		CONFIG_OF_BOOT_CPU
6470267768eSMatthew McClintock
64811ccc33fSMarcel Ziswiler		This define fills in the correct boot CPU in the boot
6490267768eSMatthew McClintock		param header, the default value is zero if undefined.
6500267768eSMatthew McClintock
6513887c3fbSHeiko Schocher		CONFIG_OF_IDE_FIXUP
6523887c3fbSHeiko Schocher
6533887c3fbSHeiko Schocher		U-Boot can detect if an IDE device is present or not.
6543887c3fbSHeiko Schocher		If not, and this new config option is activated, U-Boot
6553887c3fbSHeiko Schocher		removes the ATA node from the DTS before booting Linux,
6563887c3fbSHeiko Schocher		so the Linux IDE driver does not probe the device and
6573887c3fbSHeiko Schocher		crash. This is needed for buggy hardware (uc101) where
6583887c3fbSHeiko Schocher		no pull down resistor is connected to the signal IDE5V_DD7.
6593887c3fbSHeiko Schocher
6607eb29398SIgor Grinberg		CONFIG_MACH_TYPE	[relevant for ARM only][mandatory]
6617eb29398SIgor Grinberg
6627eb29398SIgor Grinberg		This setting is mandatory for all boards that have only one
6637eb29398SIgor Grinberg		machine type and must be used to specify the machine type
6647eb29398SIgor Grinberg		number as it appears in the ARM machine registry
6657eb29398SIgor Grinberg		(see http://www.arm.linux.org.uk/developer/machines/).
6667eb29398SIgor Grinberg		Only boards that have multiple machine types supported
6677eb29398SIgor Grinberg		in a single configuration file and the machine type is
6687eb29398SIgor Grinberg		runtime discoverable, do not have to use this setting.
6697eb29398SIgor Grinberg
6700b2f4ecaSNiklaus Giger- vxWorks boot parameters:
6710b2f4ecaSNiklaus Giger
6720b2f4ecaSNiklaus Giger		bootvx constructs a valid bootline using the following
6730b2f4ecaSNiklaus Giger		environments variables: bootfile, ipaddr, serverip, hostname.
6740b2f4ecaSNiklaus Giger		It loads the vxWorks image pointed bootfile.
6750b2f4ecaSNiklaus Giger
6760b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
6770b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
6780b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
6790b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
6800b2f4ecaSNiklaus Giger
6810b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_ADD_PARAMS
6820b2f4ecaSNiklaus Giger
6830b2f4ecaSNiklaus Giger		Add it at the end of the bootline. E.g "u=username pw=secret"
6840b2f4ecaSNiklaus Giger
6850b2f4ecaSNiklaus Giger		Note: If a "bootargs" environment is defined, it will overwride
6860b2f4ecaSNiklaus Giger		the defaults discussed just above.
6870b2f4ecaSNiklaus Giger
6882c451f78SAneesh V- Cache Configuration:
6892c451f78SAneesh V		CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
6902c451f78SAneesh V		CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
6912c451f78SAneesh V		CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
6922c451f78SAneesh V
69393bc2193SAneesh V- Cache Configuration for ARM:
69493bc2193SAneesh V		CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
69593bc2193SAneesh V				      controller
69693bc2193SAneesh V		CONFIG_SYS_PL310_BASE - Physical base address of PL310
69793bc2193SAneesh V					controller register space
69893bc2193SAneesh V
6996705d81eSwdenk- Serial Ports:
70048d0192fSAndreas Engel		CONFIG_PL010_SERIAL
7016705d81eSwdenk
7026705d81eSwdenk		Define this if you want support for Amba PrimeCell PL010 UARTs.
7036705d81eSwdenk
70448d0192fSAndreas Engel		CONFIG_PL011_SERIAL
7056705d81eSwdenk
7066705d81eSwdenk		Define this if you want support for Amba PrimeCell PL011 UARTs.
7076705d81eSwdenk
7086705d81eSwdenk		CONFIG_PL011_CLOCK
7096705d81eSwdenk
7106705d81eSwdenk		If you have Amba PrimeCell PL011 UARTs, set this variable to
7116705d81eSwdenk		the clock speed of the UARTs.
7126705d81eSwdenk
7136705d81eSwdenk		CONFIG_PL01x_PORTS
7146705d81eSwdenk
7156705d81eSwdenk		If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
7166705d81eSwdenk		define this to a list of base addresses for each (supported)
7176705d81eSwdenk		port. See e.g. include/configs/versatile.h
7186705d81eSwdenk
719910f1ae3SJohn Rigby		CONFIG_PL011_SERIAL_RLCR
720910f1ae3SJohn Rigby
721910f1ae3SJohn Rigby		Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
722910f1ae3SJohn Rigby		have separate receive and transmit line control registers.  Set
723910f1ae3SJohn Rigby		this variable to initialize the extra register.
724910f1ae3SJohn Rigby
725910f1ae3SJohn Rigby		CONFIG_PL011_SERIAL_FLUSH_ON_INIT
726910f1ae3SJohn Rigby
727910f1ae3SJohn Rigby		On some platforms (e.g. U8500) U-Boot is loaded by a second stage
728910f1ae3SJohn Rigby		boot loader that has already initialized the UART.  Define this
729910f1ae3SJohn Rigby		variable to flush the UART at init time.
730910f1ae3SJohn Rigby
7316705d81eSwdenk
732c609719bSwdenk- Console Interface:
733c609719bSwdenk		Depending on board, define exactly one serial port
734c609719bSwdenk		(like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
735c609719bSwdenk		CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
736c609719bSwdenk		console by defining CONFIG_8xx_CONS_NONE
737c609719bSwdenk
738c609719bSwdenk		Note: if CONFIG_8xx_CONS_NONE is defined, the serial
739c609719bSwdenk		port routines must be defined elsewhere
740c609719bSwdenk		(i.e. serial_init(), serial_getc(), ...)
741c609719bSwdenk
742c609719bSwdenk		CONFIG_CFB_CONSOLE
743c609719bSwdenk		Enables console device for a color framebuffer. Needs following
744c53043b7SWolfgang Denk		defines (cf. smiLynxEM, i8042)
745c609719bSwdenk			VIDEO_FB_LITTLE_ENDIAN	graphic memory organisation
746c609719bSwdenk						(default big endian)
747c609719bSwdenk			VIDEO_HW_RECTFILL	graphic chip supports
748c609719bSwdenk						rectangle fill
749c609719bSwdenk						(cf. smiLynxEM)
750c609719bSwdenk			VIDEO_HW_BITBLT		graphic chip supports
751c609719bSwdenk						bit-blit (cf. smiLynxEM)
752c609719bSwdenk			VIDEO_VISIBLE_COLS	visible pixel columns
753c609719bSwdenk						(cols=pitch)
754c609719bSwdenk			VIDEO_VISIBLE_ROWS	visible pixel rows
755c609719bSwdenk			VIDEO_PIXEL_SIZE	bytes per pixel
756c609719bSwdenk			VIDEO_DATA_FORMAT	graphic data format
757c609719bSwdenk						(0-5, cf. cfb_console.c)
758c609719bSwdenk			VIDEO_FB_ADRS		framebuffer address
759c609719bSwdenk			VIDEO_KBD_INIT_FCT	keyboard int fct
760c609719bSwdenk						(i.e. i8042_kbd_init())
761c609719bSwdenk			VIDEO_TSTC_FCT		test char fct
762c609719bSwdenk						(i.e. i8042_tstc)
763c609719bSwdenk			VIDEO_GETC_FCT		get char fct
764c609719bSwdenk						(i.e. i8042_getc)
765c609719bSwdenk			CONFIG_CONSOLE_CURSOR	cursor drawing on/off
766c609719bSwdenk						(requires blink timer
767c609719bSwdenk						cf. i8042.c)
7686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
769c609719bSwdenk			CONFIG_CONSOLE_TIME	display time/date info in
770c609719bSwdenk						upper right corner
771602ad3b3SJon Loeliger						(requires CONFIG_CMD_DATE)
772c609719bSwdenk			CONFIG_VIDEO_LOGO	display Linux logo in
773c609719bSwdenk						upper left corner
774a6c7ad2fSwdenk			CONFIG_VIDEO_BMP_LOGO	use bmp_logo.h instead of
775a6c7ad2fSwdenk						linux_logo.h for logo.
776a6c7ad2fSwdenk						Requires CONFIG_VIDEO_LOGO
777c609719bSwdenk			CONFIG_CONSOLE_EXTRA_INFO
77811ccc33fSMarcel Ziswiler						additional board info beside
779c609719bSwdenk						the logo
780c609719bSwdenk
78133a35bbbSPali Rohár		When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
78233a35bbbSPali Rohár		a limited number of ANSI escape sequences (cursor control,
78333a35bbbSPali Rohár		erase functions and limited graphics rendition control).
78433a35bbbSPali Rohár
785c609719bSwdenk		When CONFIG_CFB_CONSOLE is defined, video console is
786c609719bSwdenk		default i/o. Serial console can be forced with
787c609719bSwdenk		environment 'console=serial'.
788c609719bSwdenk
789a3ad8e26Swdenk		When CONFIG_SILENT_CONSOLE is defined, all console
790a3ad8e26Swdenk		messages (by U-Boot and Linux!) can be silenced with
791a3ad8e26Swdenk		the "silent" environment variable. See
792a3ad8e26Swdenk		doc/README.silent for more information.
793a3ad8e26Swdenk
79445ae2546SHeiko Schocher		CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default
79545ae2546SHeiko Schocher			is 0x00.
79645ae2546SHeiko Schocher		CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default
79745ae2546SHeiko Schocher			is 0xa0.
79845ae2546SHeiko Schocher
799c609719bSwdenk- Console Baudrate:
800c609719bSwdenk		CONFIG_BAUDRATE - in bps
801c609719bSwdenk		Select one of the baudrates listed in
8026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
8036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
804c609719bSwdenk
805c92fac91SHeiko Schocher- Console Rx buffer length
806c92fac91SHeiko Schocher		With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
807c92fac91SHeiko Schocher		the maximum receive buffer length for the SMC.
8082b3f12c2SHeiko Schocher		This option is actual only for 82xx and 8xx possible.
809c92fac91SHeiko Schocher		If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
810c92fac91SHeiko Schocher		must be defined, to setup the maximum idle timeout for
811c92fac91SHeiko Schocher		the SMC.
812c92fac91SHeiko Schocher
8139558b48aSGraeme Russ- Pre-Console Buffer:
8149558b48aSGraeme Russ		Prior to the console being initialised (i.e. serial UART
8159558b48aSGraeme Russ		initialised etc) all console output is silently discarded.
8169558b48aSGraeme Russ		Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
8179558b48aSGraeme Russ		buffer any console messages prior to the console being
8189558b48aSGraeme Russ		initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
8199558b48aSGraeme Russ		bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
8209558b48aSGraeme Russ		a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
8219558b48aSGraeme Russ		bytes are output before the console is initialised, the
8229558b48aSGraeme Russ		earlier bytes are discarded.
8239558b48aSGraeme Russ
8249558b48aSGraeme Russ		'Sane' compilers will generate smaller code if
8259558b48aSGraeme Russ		CONFIG_PRE_CON_BUF_SZ is a power of 2
8269558b48aSGraeme Russ
827046a37bdSSonny Rao- Safe printf() functions
828046a37bdSSonny Rao		Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
829046a37bdSSonny Rao		the printf() functions. These are defined in
830046a37bdSSonny Rao		include/vsprintf.h and include snprintf(), vsnprintf() and
831046a37bdSSonny Rao		so on. Code size increase is approximately 300-500 bytes.
832046a37bdSSonny Rao		If this option is not given then these functions will
833046a37bdSSonny Rao		silently discard their buffer size argument - this means
834046a37bdSSonny Rao		you are not getting any overflow checking in this case.
835046a37bdSSonny Rao
836c609719bSwdenk- Boot Delay:	CONFIG_BOOTDELAY - in seconds
837c609719bSwdenk		Delay before automatically booting the default image;
838c609719bSwdenk		set to -1 to disable autoboot.
83993d7212fSJoe Hershberger		set to -2 to autoboot with no delay and not check for abort
84093d7212fSJoe Hershberger		(even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
841c609719bSwdenk
842c609719bSwdenk		See doc/README.autoboot for these options that
843c609719bSwdenk		work with CONFIG_BOOTDELAY. None are required.
844c609719bSwdenk		CONFIG_BOOT_RETRY_TIME
845c609719bSwdenk		CONFIG_BOOT_RETRY_MIN
846c609719bSwdenk		CONFIG_AUTOBOOT_KEYED
847c609719bSwdenk		CONFIG_AUTOBOOT_PROMPT
848c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR
849c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR
850c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR2
851c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR2
852c609719bSwdenk		CONFIG_ZERO_BOOTDELAY_CHECK
853c609719bSwdenk		CONFIG_RESET_TO_RETRY
854c609719bSwdenk
855c609719bSwdenk- Autoboot Command:
856c609719bSwdenk		CONFIG_BOOTCOMMAND
857c609719bSwdenk		Only needed when CONFIG_BOOTDELAY is enabled;
858c609719bSwdenk		define a command string that is automatically executed
859c609719bSwdenk		when no character is read on the console interface
860c609719bSwdenk		within "Boot Delay" after reset.
861c609719bSwdenk
862c609719bSwdenk		CONFIG_BOOTARGS
863c609719bSwdenk		This can be used to pass arguments to the bootm
864c609719bSwdenk		command. The value of CONFIG_BOOTARGS goes into the
865c609719bSwdenk		environment value "bootargs".
866c609719bSwdenk
867c609719bSwdenk		CONFIG_RAMBOOT and CONFIG_NFSBOOT
868c609719bSwdenk		The value of these goes into the environment as
869c609719bSwdenk		"ramboot" and "nfsboot" respectively, and can be used
870c609719bSwdenk		as a convenience, when switching between booting from
87111ccc33fSMarcel Ziswiler		RAM and NFS.
872c609719bSwdenk
873eda0ba38SHeiko Schocher- Bootcount:
874eda0ba38SHeiko Schocher		CONFIG_BOOTCOUNT_LIMIT
875eda0ba38SHeiko Schocher		Implements a mechanism for detecting a repeating reboot
876eda0ba38SHeiko Schocher		cycle, see:
877eda0ba38SHeiko Schocher		http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
878eda0ba38SHeiko Schocher
879eda0ba38SHeiko Schocher		CONFIG_BOOTCOUNT_ENV
880eda0ba38SHeiko Schocher		If no softreset save registers are found on the hardware
881eda0ba38SHeiko Schocher		"bootcount" is stored in the environment. To prevent a
882eda0ba38SHeiko Schocher		saveenv on all reboots, the environment variable
883eda0ba38SHeiko Schocher		"upgrade_available" is used. If "upgrade_available" is
884eda0ba38SHeiko Schocher		0, "bootcount" is always 0, if "upgrade_available" is
885eda0ba38SHeiko Schocher		1 "bootcount" is incremented in the environment.
886eda0ba38SHeiko Schocher		So the Userspace Applikation must set the "upgrade_available"
887eda0ba38SHeiko Schocher		and "bootcount" variable to 0, if a boot was successfully.
888eda0ba38SHeiko Schocher
889c609719bSwdenk- Pre-Boot Commands:
890c609719bSwdenk		CONFIG_PREBOOT
891c609719bSwdenk
892c609719bSwdenk		When this option is #defined, the existence of the
893c609719bSwdenk		environment variable "preboot" will be checked
894c609719bSwdenk		immediately before starting the CONFIG_BOOTDELAY
895c609719bSwdenk		countdown and/or running the auto-boot command resp.
896c609719bSwdenk		entering interactive mode.
897c609719bSwdenk
898c609719bSwdenk		This feature is especially useful when "preboot" is
899c609719bSwdenk		automatically generated or modified. For an example
900c609719bSwdenk		see the LWMON board specific code: here "preboot" is
901c609719bSwdenk		modified when the user holds down a certain
902c609719bSwdenk		combination of keys on the (special) keyboard when
903c609719bSwdenk		booting the systems
904c609719bSwdenk
905c609719bSwdenk- Serial Download Echo Mode:
906c609719bSwdenk		CONFIG_LOADS_ECHO
907c609719bSwdenk		If defined to 1, all characters received during a
908c609719bSwdenk		serial download (using the "loads" command) are
909c609719bSwdenk		echoed back. This might be needed by some terminal
910c609719bSwdenk		emulations (like "cu"), but may as well just take
911c609719bSwdenk		time on others. This setting #define's the initial
912c609719bSwdenk		value of the "loads_echo" environment variable.
913c609719bSwdenk
914602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
915c609719bSwdenk		CONFIG_KGDB_BAUDRATE
916c609719bSwdenk		Select one of the baudrates listed in
9176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
918c609719bSwdenk
919c609719bSwdenk- Monitor Functions:
920602ad3b3SJon Loeliger		Monitor commands can be included or excluded
921602ad3b3SJon Loeliger		from the build by using the #include files
922c6c621bdSStephen Warren		<config_cmd_all.h> and #undef'ing unwanted
923c6c621bdSStephen Warren		commands, or using <config_cmd_default.h>
924602ad3b3SJon Loeliger		and augmenting with additional #define's
925602ad3b3SJon Loeliger		for wanted commands.
926c609719bSwdenk
927602ad3b3SJon Loeliger		The default command configuration includes all commands
928602ad3b3SJon Loeliger		except those marked below with a "*".
929602ad3b3SJon Loeliger
930b401b73dSMarek Vasut		CONFIG_CMD_AES		  AES 128 CBC encrypt/decrypt
931602ad3b3SJon Loeliger		CONFIG_CMD_ASKENV	* ask for env variable
932602ad3b3SJon Loeliger		CONFIG_CMD_BDI		  bdinfo
933602ad3b3SJon Loeliger		CONFIG_CMD_BEDBUG	* Include BedBug Debugger
934602ad3b3SJon Loeliger		CONFIG_CMD_BMP		* BMP support
935602ad3b3SJon Loeliger		CONFIG_CMD_BSP		* Board specific commands
936602ad3b3SJon Loeliger		CONFIG_CMD_BOOTD	  bootd
937602ad3b3SJon Loeliger		CONFIG_CMD_CACHE	* icache, dcache
93808d0d6f3SMichal Simek		CONFIG_CMD_CLK   	* clock command support
939602ad3b3SJon Loeliger		CONFIG_CMD_CONSOLE	  coninfo
940710b9938SMike Frysinger		CONFIG_CMD_CRC32	* crc32
941602ad3b3SJon Loeliger		CONFIG_CMD_DATE		* support for RTC, date/time...
942602ad3b3SJon Loeliger		CONFIG_CMD_DHCP		* DHCP support
943602ad3b3SJon Loeliger		CONFIG_CMD_DIAG		* Diagnostics
944a7c93104SPeter Tyser		CONFIG_CMD_DS4510	* ds4510 I2C gpio commands
945a7c93104SPeter Tyser		CONFIG_CMD_DS4510_INFO	* ds4510 I2C info command
946a7c93104SPeter Tyser		CONFIG_CMD_DS4510_MEM	* ds4510 I2C eeprom/sram commansd
947a7c93104SPeter Tyser		CONFIG_CMD_DS4510_RST	* ds4510 I2C rst command
948602ad3b3SJon Loeliger		CONFIG_CMD_DTT		* Digital Therm and Thermostat
949602ad3b3SJon Loeliger		CONFIG_CMD_ECHO		  echo arguments
950246c6922SPeter Tyser		CONFIG_CMD_EDITENV	  edit env variable
951602ad3b3SJon Loeliger		CONFIG_CMD_EEPROM	* EEPROM read/write support
952602ad3b3SJon Loeliger		CONFIG_CMD_ELF		* bootelf, bootvx
9535e2b3e0cSJoe Hershberger		CONFIG_CMD_ENV_CALLBACK	* display details about env callbacks
954fffad71bSJoe Hershberger		CONFIG_CMD_ENV_FLAGS	* display details about env flags
95588733e2cSAndrew Ruder		CONFIG_CMD_ENV_EXISTS	* check existence of env variable
9560c79cda0SMike Frysinger		CONFIG_CMD_EXPORTENV	* export the environment
95703e2ecf6SStephen Warren		CONFIG_CMD_EXT2		* ext2 command support
95803e2ecf6SStephen Warren		CONFIG_CMD_EXT4		* ext4 command support
95916f4d933SStephen Warren		CONFIG_CMD_FS_GENERIC	* filesystem commands (e.g. load, ls)
96016f4d933SStephen Warren					  that work for multiple fs types
961bdab39d3SMike Frysinger		CONFIG_CMD_SAVEENV	  saveenv
962602ad3b3SJon Loeliger		CONFIG_CMD_FDC		* Floppy Disk Support
96303e2ecf6SStephen Warren		CONFIG_CMD_FAT		* FAT command support
964602ad3b3SJon Loeliger		CONFIG_CMD_FLASH	  flinfo, erase, protect
965602ad3b3SJon Loeliger		CONFIG_CMD_FPGA		  FPGA device initialization support
9664d98b5c8SVincent Stehlé		CONFIG_CMD_FUSE		* Device fuse support
96753fdc7efSAnton Staaf		CONFIG_CMD_GETTIME	* Get time since boot
968a641b979SMike Frysinger		CONFIG_CMD_GO		* the 'go' command (exec code)
969a000b795SKim Phillips		CONFIG_CMD_GREPENV	* search environment
970bf36c5d5SSimon Glass		CONFIG_CMD_HASH		* calculate hash / digest
971602ad3b3SJon Loeliger		CONFIG_CMD_HWFLOW	* RTS/CTS hw flow control
972602ad3b3SJon Loeliger		CONFIG_CMD_I2C		* I2C serial bus support
973602ad3b3SJon Loeliger		CONFIG_CMD_IDE		* IDE harddisk support
974602ad3b3SJon Loeliger		CONFIG_CMD_IMI		  iminfo
9758fdf1e0fSVipin Kumar		CONFIG_CMD_IMLS		  List all images found in NOR flash
9764d98b5c8SVincent Stehlé		CONFIG_CMD_IMLS_NAND	* List all images found in NAND flash
977602ad3b3SJon Loeliger		CONFIG_CMD_IMMAP	* IMMR dump support
9780c79cda0SMike Frysinger		CONFIG_CMD_IMPORTENV	* import an environment
979c167cc02SJoe Hershberger		CONFIG_CMD_INI		* import data from an ini file into the env
980602ad3b3SJon Loeliger		CONFIG_CMD_IRQ		* irqinfo
981602ad3b3SJon Loeliger		CONFIG_CMD_ITEST	  Integer/string test of 2 values
982602ad3b3SJon Loeliger		CONFIG_CMD_JFFS2	* JFFS2 Support
983602ad3b3SJon Loeliger		CONFIG_CMD_KGDB		* kgdb
9844d98b5c8SVincent Stehlé		CONFIG_CMD_LDRINFO	* ldrinfo (display Blackfin loader)
985d22c338eSJoe Hershberger		CONFIG_CMD_LINK_LOCAL	* link-local IP address auto-configuration
986d22c338eSJoe Hershberger					  (169.254.*.*)
987602ad3b3SJon Loeliger		CONFIG_CMD_LOADB	  loadb
988602ad3b3SJon Loeliger		CONFIG_CMD_LOADS	  loads
9894d98b5c8SVincent Stehlé		CONFIG_CMD_MD5SUM	* print md5 message digest
99002c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
99115a33e49SSimon Glass		CONFIG_CMD_MEMINFO	* Display detailed memory information
992602ad3b3SJon Loeliger		CONFIG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
993a2681707SWolfgang Denk					  loop, loopw
9944d98b5c8SVincent Stehlé		CONFIG_CMD_MEMTEST	* mtest
995602ad3b3SJon Loeliger		CONFIG_CMD_MISC		  Misc functions like sleep etc
996602ad3b3SJon Loeliger		CONFIG_CMD_MMC		* MMC memory mapped support
997602ad3b3SJon Loeliger		CONFIG_CMD_MII		* MII utility commands
99868d7d651SStefan Roese		CONFIG_CMD_MTDPARTS	* MTD partition support
999602ad3b3SJon Loeliger		CONFIG_CMD_NAND		* NAND support
1000602ad3b3SJon Loeliger		CONFIG_CMD_NET		  bootp, tftpboot, rarpboot
10014d98b5c8SVincent Stehlé		CONFIG_CMD_NFS		  NFS support
1002e92739d3SPeter Tyser		CONFIG_CMD_PCA953X	* PCA953x I2C gpio commands
1003e92739d3SPeter Tyser		CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
1004602ad3b3SJon Loeliger		CONFIG_CMD_PCI		* pciinfo
1005602ad3b3SJon Loeliger		CONFIG_CMD_PCMCIA		* PCMCIA support
1006602ad3b3SJon Loeliger		CONFIG_CMD_PING		* send ICMP ECHO_REQUEST to network
1007602ad3b3SJon Loeliger					  host
1008602ad3b3SJon Loeliger		CONFIG_CMD_PORTIO	* Port I/O
1009ff048ea9SKenneth Waters		CONFIG_CMD_READ		* Read raw data from partition
1010602ad3b3SJon Loeliger		CONFIG_CMD_REGINFO	* Register dump
1011602ad3b3SJon Loeliger		CONFIG_CMD_RUN		  run command in env variable
1012d304931fSSimon Glass		CONFIG_CMD_SANDBOX	* sb command to access sandbox features
1013602ad3b3SJon Loeliger		CONFIG_CMD_SAVES	* save S record dump
1014602ad3b3SJon Loeliger		CONFIG_CMD_SCSI		* SCSI Support
1015602ad3b3SJon Loeliger		CONFIG_CMD_SDRAM	* print SDRAM configuration information
1016602ad3b3SJon Loeliger					  (requires CONFIG_CMD_I2C)
1017602ad3b3SJon Loeliger		CONFIG_CMD_SETGETDCR	  Support for DCR Register access
1018602ad3b3SJon Loeliger					  (4xx only)
1019f61ec45eSEric Nelson		CONFIG_CMD_SF		* Read/write/erase SPI NOR flash
10204d98b5c8SVincent Stehlé		CONFIG_CMD_SHA1SUM	* print sha1 memory digest
102102c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY)
10227d861d95SBob Liu		CONFIG_CMD_SOFTSWITCH	* Soft switch setting command for BF60x
102374de7aefSWolfgang Denk		CONFIG_CMD_SOURCE	  "source" command Support
1024602ad3b3SJon Loeliger		CONFIG_CMD_SPI		* SPI serial bus support
10257a83af07SLuca Ceresoli		CONFIG_CMD_TFTPSRV	* TFTP transfer in server mode
10261fb7cd49SSimon Glass		CONFIG_CMD_TFTPPUT	* TFTP put command (upload)
1027da83bcd7SJoe Hershberger		CONFIG_CMD_TIME		* run command and report execution time (ARM specific)
1028da83bcd7SJoe Hershberger		CONFIG_CMD_TIMER	* access to the system tick timer
1029602ad3b3SJon Loeliger		CONFIG_CMD_USB		* USB support
1030602ad3b3SJon Loeliger		CONFIG_CMD_CDP		* Cisco Discover Protocol support
1031c8339f51SMarek Vasut		CONFIG_CMD_MFSL		* Microblaze FSL support
10324d98b5c8SVincent Stehlé		CONFIG_CMD_XIMG		  Load part of Multi Image
103389c8230dSPrzemyslaw Marczak		CONFIG_CMD_UUID		* Generate random UUID or GUID string
1034c609719bSwdenk
1035c609719bSwdenk		EXAMPLE: If you want all functions except of network
1036c609719bSwdenk		support you can write:
1037c609719bSwdenk
1038602ad3b3SJon Loeliger		#include "config_cmd_all.h"
1039602ad3b3SJon Loeliger		#undef CONFIG_CMD_NET
1040c609719bSwdenk
1041213bf8c8SGerald Van Baren	Other Commands:
1042213bf8c8SGerald Van Baren		fdt (flattened device tree) command: CONFIG_OF_LIBFDT
1043c609719bSwdenk
1044c609719bSwdenk	Note:	Don't enable the "icache" and "dcache" commands
1045602ad3b3SJon Loeliger		(configuration option CONFIG_CMD_CACHE) unless you know
1046c609719bSwdenk		what you (and your U-Boot users) are doing. Data
1047c609719bSwdenk		cache cannot be enabled on systems like the 8xx or
1048c609719bSwdenk		8260 (where accesses to the IMMR region must be
1049c609719bSwdenk		uncached), and it cannot be disabled on all other
1050c609719bSwdenk		systems where we (mis-) use the data cache to hold an
1051c609719bSwdenk		initial stack and some data.
1052c609719bSwdenk
1053c609719bSwdenk
1054c609719bSwdenk		XXX - this list needs to get updated!
1055c609719bSwdenk
1056a5ecbe62SWolfgang Denk- Regular expression support:
1057a5ecbe62SWolfgang Denk		CONFIG_REGEX
1058a5ecbe62SWolfgang Denk		If this variable is defined, U-Boot is linked against
1059a5ecbe62SWolfgang Denk		the SLRE (Super Light Regular Expression) library,
1060a5ecbe62SWolfgang Denk		which adds regex support to some commands, as for
1061a5ecbe62SWolfgang Denk		example "env grep" and "setexpr".
1062a5ecbe62SWolfgang Denk
106345ba8077SSimon Glass- Device tree:
106445ba8077SSimon Glass		CONFIG_OF_CONTROL
106545ba8077SSimon Glass		If this variable is defined, U-Boot will use a device tree
106645ba8077SSimon Glass		to configure its devices, instead of relying on statically
106745ba8077SSimon Glass		compiled #defines in the board file. This option is
106845ba8077SSimon Glass		experimental and only available on a few boards. The device
106945ba8077SSimon Glass		tree is available in the global data as gd->fdt_blob.
107045ba8077SSimon Glass
10712c0f79e4SSimon Glass		U-Boot needs to get its device tree from somewhere. This can
10722c0f79e4SSimon Glass		be done using one of the two options below:
1073bbb0b128SSimon Glass
1074bbb0b128SSimon Glass		CONFIG_OF_EMBED
1075bbb0b128SSimon Glass		If this variable is defined, U-Boot will embed a device tree
1076bbb0b128SSimon Glass		binary in its image. This device tree file should be in the
1077bbb0b128SSimon Glass		board directory and called <soc>-<board>.dts. The binary file
1078bbb0b128SSimon Glass		is then picked up in board_init_f() and made available through
1079bbb0b128SSimon Glass		the global data structure as gd->blob.
108045ba8077SSimon Glass
10812c0f79e4SSimon Glass		CONFIG_OF_SEPARATE
10822c0f79e4SSimon Glass		If this variable is defined, U-Boot will build a device tree
10832c0f79e4SSimon Glass		binary. It will be called u-boot.dtb. Architecture-specific
10842c0f79e4SSimon Glass		code will locate it at run-time. Generally this works by:
10852c0f79e4SSimon Glass
10862c0f79e4SSimon Glass			cat u-boot.bin u-boot.dtb >image.bin
10872c0f79e4SSimon Glass
10882c0f79e4SSimon Glass		and in fact, U-Boot does this for you, creating a file called
10892c0f79e4SSimon Glass		u-boot-dtb.bin which is useful in the common case. You can
10902c0f79e4SSimon Glass		still use the individual files if you need something more
10912c0f79e4SSimon Glass		exotic.
10922c0f79e4SSimon Glass
1093c609719bSwdenk- Watchdog:
1094c609719bSwdenk		CONFIG_WATCHDOG
1095c609719bSwdenk		If this variable is defined, it enables watchdog
10966abe6fb6SDetlev Zundel		support for the SoC. There must be support in the SoC
10976abe6fb6SDetlev Zundel		specific code for a watchdog. For the 8xx and 8260
10986abe6fb6SDetlev Zundel		CPUs, the SIU Watchdog feature is enabled in the SYPCR
10996abe6fb6SDetlev Zundel		register.  When supported for a specific SoC is
11006abe6fb6SDetlev Zundel		available, then no further board specific code should
11016abe6fb6SDetlev Zundel		be needed to use it.
11026abe6fb6SDetlev Zundel
11036abe6fb6SDetlev Zundel		CONFIG_HW_WATCHDOG
11046abe6fb6SDetlev Zundel		When using a watchdog circuitry external to the used
11056abe6fb6SDetlev Zundel		SoC, then define this variable and provide board
11066abe6fb6SDetlev Zundel		specific code for the "hw_watchdog_reset" function.
1107c609719bSwdenk
1108c1551ea8Sstroese- U-Boot Version:
1109c1551ea8Sstroese		CONFIG_VERSION_VARIABLE
1110c1551ea8Sstroese		If this variable is defined, an environment variable
1111c1551ea8Sstroese		named "ver" is created by U-Boot showing the U-Boot
1112c1551ea8Sstroese		version as printed by the "version" command.
1113a1ea8e51SBenoît Thébaudeau		Any change to this variable will be reverted at the
1114a1ea8e51SBenoît Thébaudeau		next reset.
1115c1551ea8Sstroese
1116c609719bSwdenk- Real-Time Clock:
1117c609719bSwdenk
1118602ad3b3SJon Loeliger		When CONFIG_CMD_DATE is selected, the type of the RTC
1119c609719bSwdenk		has to be selected, too. Define exactly one of the
1120c609719bSwdenk		following options:
1121c609719bSwdenk
1122c609719bSwdenk		CONFIG_RTC_MPC8xx	- use internal RTC of MPC8xx
1123c609719bSwdenk		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
11244e8b7544SFabio Estevam		CONFIG_RTC_MC13XXX	- use MC13783 or MC13892 RTC
1125c609719bSwdenk		CONFIG_RTC_MC146818	- use MC146818 RTC
11261cb8e980Swdenk		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
1127c609719bSwdenk		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
11287f70e853Swdenk		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
11293bac3513Swdenk		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
11309536dfccSTor Krill		CONFIG_RTC_ISL1208	- use Intersil ISL1208 RTC
11314c0d4c3bSwdenk		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
11326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_DS1337_NOOSC	- Turn off the OSC output for DS1337
113371d19f30SHeiko Schocher		CONFIG_SYS_RV3029_TCR	- enable trickle charger on
113471d19f30SHeiko Schocher					  RV3029 RTC.
1135c609719bSwdenk
1136b37c7e5eSwdenk		Note that if the RTC uses I2C, then the I2C interface
1137b37c7e5eSwdenk		must also be configured. See I2C Support, below.
1138b37c7e5eSwdenk
1139e92739d3SPeter Tyser- GPIO Support:
1140e92739d3SPeter Tyser		CONFIG_PCA953X		- use NXP's PCA953X series I2C GPIO
1141e92739d3SPeter Tyser
11425dec49caSChris Packham		The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
11435dec49caSChris Packham		chip-ngpio pairs that tell the PCA953X driver the number of
11445dec49caSChris Packham		pins supported by a particular chip.
11455dec49caSChris Packham
1146e92739d3SPeter Tyser		Note that if the GPIO device uses I2C, then the I2C interface
1147e92739d3SPeter Tyser		must also be configured. See I2C Support, below.
1148e92739d3SPeter Tyser
1149c609719bSwdenk- Timestamp Support:
1150c609719bSwdenk
1151c609719bSwdenk		When CONFIG_TIMESTAMP is selected, the timestamp
1152c609719bSwdenk		(date and time) of an image is printed by image
1153c609719bSwdenk		commands like bootm or iminfo. This option is
1154602ad3b3SJon Loeliger		automatically enabled when you select CONFIG_CMD_DATE .
1155c609719bSwdenk
1156923c46f9SKarl O. Pinc- Partition Labels (disklabels) Supported:
1157923c46f9SKarl O. Pinc		Zero or more of the following:
1158923c46f9SKarl O. Pinc		CONFIG_MAC_PARTITION   Apple's MacOS partition table.
1159923c46f9SKarl O. Pinc		CONFIG_DOS_PARTITION   MS Dos partition table, traditional on the
1160923c46f9SKarl O. Pinc				       Intel architecture, USB sticks, etc.
1161923c46f9SKarl O. Pinc		CONFIG_ISO_PARTITION   ISO partition table, used on CDROM etc.
1162923c46f9SKarl O. Pinc		CONFIG_EFI_PARTITION   GPT partition table, common when EFI is the
1163923c46f9SKarl O. Pinc				       bootloader.  Note 2TB partition limit; see
1164923c46f9SKarl O. Pinc				       disk/part_efi.c
1165923c46f9SKarl O. Pinc		CONFIG_MTD_PARTITIONS  Memory Technology Device partition table.
1166c609719bSwdenk
1167602ad3b3SJon Loeliger		If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1168218ca724SWolfgang Denk		CONFIG_CMD_SCSI) you must configure support for at
1169923c46f9SKarl O. Pinc		least one non-MTD partition type as well.
1170c609719bSwdenk
1171c609719bSwdenk- IDE Reset method:
11724d13cbadSwdenk		CONFIG_IDE_RESET_ROUTINE - this is defined in several
11734d13cbadSwdenk		board configurations files but used nowhere!
1174c609719bSwdenk
11754d13cbadSwdenk		CONFIG_IDE_RESET - is this is defined, IDE Reset will
11764d13cbadSwdenk		be performed by calling the function
11774d13cbadSwdenk			ide_set_reset(int reset)
11784d13cbadSwdenk		which has to be defined in a board specific file
1179c609719bSwdenk
1180c609719bSwdenk- ATAPI Support:
1181c609719bSwdenk		CONFIG_ATAPI
1182c609719bSwdenk
1183c609719bSwdenk		Set this to enable ATAPI support.
1184c609719bSwdenk
1185c40b2956Swdenk- LBA48 Support
1186c40b2956Swdenk		CONFIG_LBA48
1187c40b2956Swdenk
1188c40b2956Swdenk		Set this to enable support for disks larger than 137GB
11894b142febSHeiko Schocher		Also look at CONFIG_SYS_64BIT_LBA.
1190c40b2956Swdenk		Whithout these , LBA48 support uses 32bit variables and will 'only'
1191c40b2956Swdenk		support disks up to 2.1TB.
1192c40b2956Swdenk
11936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_64BIT_LBA:
1194c40b2956Swdenk			When enabled, makes the IDE subsystem use 64bit sector addresses.
1195c40b2956Swdenk			Default is 32bit.
1196c40b2956Swdenk
1197c609719bSwdenk- SCSI Support:
1198c609719bSwdenk		At the moment only there is only support for the
1199c609719bSwdenk		SYM53C8XX SCSI controller; define
1200c609719bSwdenk		CONFIG_SCSI_SYM53C8XX to enable it.
1201c609719bSwdenk
12026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
12036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
12046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
1205c609719bSwdenk		maximum numbers of LUNs, SCSI ID's and target
1206c609719bSwdenk		devices.
12076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
1208c609719bSwdenk
1209447c031bSStefan Reinauer		The environment variable 'scsidevs' is set to the number of
1210447c031bSStefan Reinauer		SCSI devices found during the last scan.
1211447c031bSStefan Reinauer
1212c609719bSwdenk- NETWORK Support (PCI):
1213682011ffSwdenk		CONFIG_E1000
1214ce5207e1SKyle Moffett		Support for Intel 8254x/8257x gigabit chips.
1215ce5207e1SKyle Moffett
1216ce5207e1SKyle Moffett		CONFIG_E1000_SPI
1217ce5207e1SKyle Moffett		Utility code for direct access to the SPI bus on Intel 8257x.
1218ce5207e1SKyle Moffett		This does not do anything useful unless you set at least one
1219ce5207e1SKyle Moffett		of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1220ce5207e1SKyle Moffett
1221ce5207e1SKyle Moffett		CONFIG_E1000_SPI_GENERIC
1222ce5207e1SKyle Moffett		Allow generic access to the SPI bus on the Intel 8257x, for
1223ce5207e1SKyle Moffett		example with the "sspi" command.
1224ce5207e1SKyle Moffett
1225ce5207e1SKyle Moffett		CONFIG_CMD_E1000
1226ce5207e1SKyle Moffett		Management command for E1000 devices.  When used on devices
1227ce5207e1SKyle Moffett		with SPI support you can reprogram the EEPROM from U-Boot.
1228682011ffSwdenk
1229ac3315c2SAndre Schwarz		CONFIG_E1000_FALLBACK_MAC
123011ccc33fSMarcel Ziswiler		default MAC for empty EEPROM after production.
1231ac3315c2SAndre Schwarz
1232c609719bSwdenk		CONFIG_EEPRO100
1233c609719bSwdenk		Support for Intel 82557/82559/82559ER chips.
123411ccc33fSMarcel Ziswiler		Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
1235c609719bSwdenk		write routine for first time initialisation.
1236c609719bSwdenk
1237c609719bSwdenk		CONFIG_TULIP
1238c609719bSwdenk		Support for Digital 2114x chips.
1239c609719bSwdenk		Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1240c609719bSwdenk		modem chip initialisation (KS8761/QS6611).
1241c609719bSwdenk
1242c609719bSwdenk		CONFIG_NATSEMI
1243c609719bSwdenk		Support for National dp83815 chips.
1244c609719bSwdenk
1245c609719bSwdenk		CONFIG_NS8382X
1246c609719bSwdenk		Support for National dp8382[01] gigabit chips.
1247c609719bSwdenk
124845219c46Swdenk- NETWORK Support (other):
124945219c46Swdenk
1250c041e9d2SJens Scharsig		CONFIG_DRIVER_AT91EMAC
1251c041e9d2SJens Scharsig		Support for AT91RM9200 EMAC.
1252c041e9d2SJens Scharsig
1253c041e9d2SJens Scharsig			CONFIG_RMII
1254c041e9d2SJens Scharsig			Define this to use reduced MII inteface
1255c041e9d2SJens Scharsig
1256c041e9d2SJens Scharsig			CONFIG_DRIVER_AT91EMAC_QUIET
1257c041e9d2SJens Scharsig			If this defined, the driver is quiet.
1258c041e9d2SJens Scharsig			The driver doen't show link status messages.
1259c041e9d2SJens Scharsig
1260efdd7319SRob Herring		CONFIG_CALXEDA_XGMAC
1261efdd7319SRob Herring		Support for the Calxeda XGMAC device
1262efdd7319SRob Herring
12633bb46d23SAshok		CONFIG_LAN91C96
126445219c46Swdenk		Support for SMSC's LAN91C96 chips.
126545219c46Swdenk
126645219c46Swdenk			CONFIG_LAN91C96_BASE
126745219c46Swdenk			Define this to hold the physical address
126845219c46Swdenk			of the LAN91C96's I/O space
126945219c46Swdenk
127045219c46Swdenk			CONFIG_LAN91C96_USE_32_BIT
127145219c46Swdenk			Define this to enable 32 bit addressing
127245219c46Swdenk
12733bb46d23SAshok		CONFIG_SMC91111
1274f39748aeSwdenk		Support for SMSC's LAN91C111 chip
1275f39748aeSwdenk
1276f39748aeSwdenk			CONFIG_SMC91111_BASE
1277f39748aeSwdenk			Define this to hold the physical address
1278f39748aeSwdenk			of the device (I/O space)
1279f39748aeSwdenk
1280f39748aeSwdenk			CONFIG_SMC_USE_32_BIT
1281f39748aeSwdenk			Define this if data bus is 32 bits
1282f39748aeSwdenk
1283f39748aeSwdenk			CONFIG_SMC_USE_IOFUNCS
1284f39748aeSwdenk			Define this to use i/o functions instead of macros
1285f39748aeSwdenk			(some hardware wont work with macros)
1286f39748aeSwdenk
1287dc02badaSHeiko Schocher		CONFIG_DRIVER_TI_EMAC
1288dc02badaSHeiko Schocher		Support for davinci emac
1289dc02badaSHeiko Schocher
1290dc02badaSHeiko Schocher			CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1291dc02badaSHeiko Schocher			Define this if you have more then 3 PHYs.
1292dc02badaSHeiko Schocher
1293b3dbf4a5SMacpaul Lin		CONFIG_FTGMAC100
1294b3dbf4a5SMacpaul Lin		Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1295b3dbf4a5SMacpaul Lin
1296b3dbf4a5SMacpaul Lin			CONFIG_FTGMAC100_EGIGA
1297b3dbf4a5SMacpaul Lin			Define this to use GE link update with gigabit PHY.
1298b3dbf4a5SMacpaul Lin			Define this if FTGMAC100 is connected to gigabit PHY.
1299b3dbf4a5SMacpaul Lin			If your system has 10/100 PHY only, it might not occur
1300b3dbf4a5SMacpaul Lin			wrong behavior. Because PHY usually return timeout or
1301b3dbf4a5SMacpaul Lin			useless data when polling gigabit status and gigabit
1302b3dbf4a5SMacpaul Lin			control registers. This behavior won't affect the
1303b3dbf4a5SMacpaul Lin			correctnessof 10/100 link speed update.
1304b3dbf4a5SMacpaul Lin
1305c2fff331SMike Rapoport		CONFIG_SMC911X
1306557b377dSJens Gehrlein		Support for SMSC's LAN911x and LAN921x chips
1307557b377dSJens Gehrlein
1308c2fff331SMike Rapoport			CONFIG_SMC911X_BASE
1309557b377dSJens Gehrlein			Define this to hold the physical address
1310557b377dSJens Gehrlein			of the device (I/O space)
1311557b377dSJens Gehrlein
1312c2fff331SMike Rapoport			CONFIG_SMC911X_32_BIT
1313557b377dSJens Gehrlein			Define this if data bus is 32 bits
1314557b377dSJens Gehrlein
1315c2fff331SMike Rapoport			CONFIG_SMC911X_16_BIT
1316557b377dSJens Gehrlein			Define this if data bus is 16 bits. If your processor
1317557b377dSJens Gehrlein			automatically converts one 32 bit word to two 16 bit
1318c2fff331SMike Rapoport			words you may also try CONFIG_SMC911X_32_BIT.
1319557b377dSJens Gehrlein
13203d0075faSYoshihiro Shimoda		CONFIG_SH_ETHER
13213d0075faSYoshihiro Shimoda		Support for Renesas on-chip Ethernet controller
13223d0075faSYoshihiro Shimoda
13233d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_USE_PORT
13243d0075faSYoshihiro Shimoda			Define the number of ports to be used
13253d0075faSYoshihiro Shimoda
13263d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_PHY_ADDR
13273d0075faSYoshihiro Shimoda			Define the ETH PHY's address
13283d0075faSYoshihiro Shimoda
132968260aabSYoshihiro Shimoda			CONFIG_SH_ETHER_CACHE_WRITEBACK
133068260aabSYoshihiro Shimoda			If this option is set, the driver enables cache flush.
133168260aabSYoshihiro Shimoda
13325e124724SVadim Bendebury- TPM Support:
133390899cc0SChe-liang Chiou		CONFIG_TPM
133490899cc0SChe-liang Chiou		Support TPM devices.
133590899cc0SChe-liang Chiou
13361b393db5STom Wai-Hong Tam		CONFIG_TPM_TIS_I2C
13371b393db5STom Wai-Hong Tam		Support for i2c bus TPM devices. Only one device
13381b393db5STom Wai-Hong Tam		per system is supported at this time.
13391b393db5STom Wai-Hong Tam
13401b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_BUS_NUMBER
13411b393db5STom Wai-Hong Tam			Define the the i2c bus number for the TPM device
13421b393db5STom Wai-Hong Tam
13431b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS
13441b393db5STom Wai-Hong Tam			Define the TPM's address on the i2c bus
13451b393db5STom Wai-Hong Tam
13461b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_BURST_LIMITATION
13471b393db5STom Wai-Hong Tam			Define the burst count bytes upper limit
13481b393db5STom Wai-Hong Tam
1349c01939c7SDirk Eibach		CONFIG_TPM_ATMEL_TWI
1350c01939c7SDirk Eibach		Support for Atmel TWI TPM device. Requires I2C support.
1351c01939c7SDirk Eibach
135290899cc0SChe-liang Chiou		CONFIG_TPM_TIS_LPC
13535e124724SVadim Bendebury		Support for generic parallel port TPM devices. Only one device
13545e124724SVadim Bendebury		per system is supported at this time.
13555e124724SVadim Bendebury
13565e124724SVadim Bendebury			CONFIG_TPM_TIS_BASE_ADDRESS
13575e124724SVadim Bendebury			Base address where the generic TPM device is mapped
13585e124724SVadim Bendebury			to. Contemporary x86 systems usually map it at
13595e124724SVadim Bendebury			0xfed40000.
13605e124724SVadim Bendebury
1361be6c1529SReinhard Pfau		CONFIG_CMD_TPM
1362be6c1529SReinhard Pfau		Add tpm monitor functions.
1363be6c1529SReinhard Pfau		Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1364be6c1529SReinhard Pfau		provides monitor access to authorized functions.
1365be6c1529SReinhard Pfau
1366be6c1529SReinhard Pfau		CONFIG_TPM
1367be6c1529SReinhard Pfau		Define this to enable the TPM support library which provides
1368be6c1529SReinhard Pfau		functional interfaces to some TPM commands.
1369be6c1529SReinhard Pfau		Requires support for a TPM device.
1370be6c1529SReinhard Pfau
1371be6c1529SReinhard Pfau		CONFIG_TPM_AUTH_SESSIONS
1372be6c1529SReinhard Pfau		Define this to enable authorized functions in the TPM library.
1373be6c1529SReinhard Pfau		Requires CONFIG_TPM and CONFIG_SHA1.
1374be6c1529SReinhard Pfau
1375c609719bSwdenk- USB Support:
1376c609719bSwdenk		At the moment only the UHCI host controller is
13774d13cbadSwdenk		supported (PIP405, MIP405, MPC5200); define
1378c609719bSwdenk		CONFIG_USB_UHCI to enable it.
1379c609719bSwdenk		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
138030d56faeSwdenk		and define CONFIG_USB_STORAGE to enable the USB
1381c609719bSwdenk		storage devices.
1382c609719bSwdenk		Note:
1383c609719bSwdenk		Supported are USB Keyboards and USB Floppy drives
1384c609719bSwdenk		(TEAC FD-05PUB).
13854d13cbadSwdenk		MPC5200 USB requires additional defines:
13864d13cbadSwdenk			CONFIG_USB_CLOCK
13874d13cbadSwdenk				for 528 MHz Clock: 0x0001bbbb
1388307ecb6dSEric Millbrandt			CONFIG_PSC3_USB
1389307ecb6dSEric Millbrandt				for USB on PSC3
13904d13cbadSwdenk			CONFIG_USB_CONFIG
13914d13cbadSwdenk				for differential drivers: 0x00001000
13924d13cbadSwdenk				for single ended drivers: 0x00005000
1393307ecb6dSEric Millbrandt				for differential drivers on PSC3: 0x00000100
1394307ecb6dSEric Millbrandt				for single ended drivers on PSC3: 0x00004100
13956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_USB_EVENT_POLL
1396fdcfaa1bSZhang Wei				May be defined to allow interrupt polling
1397fdcfaa1bSZhang Wei				instead of using asynchronous interrupts
13984d13cbadSwdenk
13999ab4ce22SSimon Glass		CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
14009ab4ce22SSimon Glass		txfilltuning field in the EHCI controller on reset.
14019ab4ce22SSimon Glass
1402aa155058SKuo-Jung Su		CONFIG_USB_HUB_MIN_POWER_ON_DELAY defines the minimum
1403aa155058SKuo-Jung Su		interval for usb hub power-on delay.(minimum 100msec)
1404aa155058SKuo-Jung Su
140516c8d5e7SWolfgang Denk- USB Device:
140616c8d5e7SWolfgang Denk		Define the below if you wish to use the USB console.
140716c8d5e7SWolfgang Denk		Once firmware is rebuilt from a serial console issue the
140816c8d5e7SWolfgang Denk		command "setenv stdin usbtty; setenv stdout usbtty" and
140911ccc33fSMarcel Ziswiler		attach your USB cable. The Unix command "dmesg" should print
141016c8d5e7SWolfgang Denk		it has found a new device. The environment variable usbtty
141116c8d5e7SWolfgang Denk		can be set to gserial or cdc_acm to enable your device to
141216c8d5e7SWolfgang Denk		appear to a USB host as a Linux gserial device or a
141316c8d5e7SWolfgang Denk		Common Device Class Abstract Control Model serial device.
141416c8d5e7SWolfgang Denk		If you select usbtty = gserial you should be able to enumerate
141516c8d5e7SWolfgang Denk		a Linux host by
141616c8d5e7SWolfgang Denk		# modprobe usbserial vendor=0xVendorID product=0xProductID
141716c8d5e7SWolfgang Denk		else if using cdc_acm, simply setting the environment
141816c8d5e7SWolfgang Denk		variable usbtty to be cdc_acm should suffice. The following
141916c8d5e7SWolfgang Denk		might be defined in YourBoardName.h
142016c8d5e7SWolfgang Denk
142116c8d5e7SWolfgang Denk			CONFIG_USB_DEVICE
142216c8d5e7SWolfgang Denk			Define this to build a UDC device
142316c8d5e7SWolfgang Denk
142416c8d5e7SWolfgang Denk			CONFIG_USB_TTY
142516c8d5e7SWolfgang Denk			Define this to have a tty type of device available to
142616c8d5e7SWolfgang Denk			talk to the UDC device
142716c8d5e7SWolfgang Denk
1428f9da0f89SVipin KUMAR			CONFIG_USBD_HS
1429f9da0f89SVipin KUMAR			Define this to enable the high speed support for usb
1430f9da0f89SVipin KUMAR			device and usbtty. If this feature is enabled, a routine
1431f9da0f89SVipin KUMAR			int is_usbd_high_speed(void)
1432f9da0f89SVipin KUMAR			also needs to be defined by the driver to dynamically poll
1433f9da0f89SVipin KUMAR			whether the enumeration has succeded at high speed or full
1434f9da0f89SVipin KUMAR			speed.
1435f9da0f89SVipin KUMAR
14366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_IS_IN_ENV
143716c8d5e7SWolfgang Denk			Define this if you want stdin, stdout &/or stderr to
143816c8d5e7SWolfgang Denk			be set to usbtty.
143916c8d5e7SWolfgang Denk
144016c8d5e7SWolfgang Denk			mpc8xx:
14416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_EXTC_CLK 0xBLAH
144216c8d5e7SWolfgang Denk				Derive USB clock from external clock "blah"
14436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_EXTC_CLK 0x02
144416c8d5e7SWolfgang Denk
14456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_BRG_CLK 0xBLAH
144616c8d5e7SWolfgang Denk				Derive USB clock from brgclk
14476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_BRG_CLK 0x04
144816c8d5e7SWolfgang Denk
144916c8d5e7SWolfgang Denk		If you have a USB-IF assigned VendorID then you may wish to
145016c8d5e7SWolfgang Denk		define your own vendor specific values either in BoardName.h
145116c8d5e7SWolfgang Denk		or directly in usbd_vendor_info.h. If you don't define
145216c8d5e7SWolfgang Denk		CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
145316c8d5e7SWolfgang Denk		CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
145416c8d5e7SWolfgang Denk		should pretend to be a Linux device to it's target host.
145516c8d5e7SWolfgang Denk
145616c8d5e7SWolfgang Denk			CONFIG_USBD_MANUFACTURER
145716c8d5e7SWolfgang Denk			Define this string as the name of your company for
145816c8d5e7SWolfgang Denk			- CONFIG_USBD_MANUFACTURER "my company"
145916c8d5e7SWolfgang Denk
146016c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCT_NAME
146116c8d5e7SWolfgang Denk			Define this string as the name of your product
146216c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCT_NAME "acme usb device"
146316c8d5e7SWolfgang Denk
146416c8d5e7SWolfgang Denk			CONFIG_USBD_VENDORID
146516c8d5e7SWolfgang Denk			Define this as your assigned Vendor ID from the USB
146616c8d5e7SWolfgang Denk			Implementors Forum. This *must* be a genuine Vendor ID
146716c8d5e7SWolfgang Denk			to avoid polluting the USB namespace.
146816c8d5e7SWolfgang Denk			- CONFIG_USBD_VENDORID 0xFFFF
146916c8d5e7SWolfgang Denk
147016c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCTID
147116c8d5e7SWolfgang Denk			Define this as the unique Product ID
147216c8d5e7SWolfgang Denk			for your device
147316c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCTID 0xFFFF
1474c609719bSwdenk
1475351e9b20SPrzemyslaw Marczak		Some USB device drivers may need to check USB cable attachment.
1476351e9b20SPrzemyslaw Marczak		In this case you can enable following config in BoardName.h:
1477351e9b20SPrzemyslaw Marczak			CONFIG_USB_CABLE_CHECK
1478351e9b20SPrzemyslaw Marczak			This enables function definition:
1479351e9b20SPrzemyslaw Marczak			- usb_cable_connected() in include/usb.h
1480351e9b20SPrzemyslaw Marczak			Implementation of this function is board-specific.
1481351e9b20SPrzemyslaw Marczak
1482d70a560fSIgor Grinberg- ULPI Layer Support:
1483d70a560fSIgor Grinberg		The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1484d70a560fSIgor Grinberg		the generic ULPI layer. The generic layer accesses the ULPI PHY
1485d70a560fSIgor Grinberg		via the platform viewport, so you need both the genric layer and
1486d70a560fSIgor Grinberg		the viewport enabled. Currently only Chipidea/ARC based
1487d70a560fSIgor Grinberg		viewport is supported.
1488d70a560fSIgor Grinberg		To enable the ULPI layer support, define CONFIG_USB_ULPI and
1489d70a560fSIgor Grinberg		CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
14906d365ea0SLucas Stach		If your ULPI phy needs a different reference clock than the
14916d365ea0SLucas Stach		standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
14926d365ea0SLucas Stach		the appropriate value in Hz.
1493c609719bSwdenk
1494c609719bSwdenk- MMC Support:
1495c609719bSwdenk		The MMC controller on the Intel PXA is supported. To
1496c609719bSwdenk		enable this define CONFIG_MMC. The MMC can be
1497c609719bSwdenk		accessed from the boot prompt by mapping the device
1498c609719bSwdenk		to physical memory similar to flash. Command line is
1499602ad3b3SJon Loeliger		enabled with CONFIG_CMD_MMC. The MMC driver also works with
1500602ad3b3SJon Loeliger		the FAT fs. This is enabled with CONFIG_CMD_FAT.
1501c609719bSwdenk
1502afb35666SYoshihiro Shimoda		CONFIG_SH_MMCIF
1503afb35666SYoshihiro Shimoda		Support for Renesas on-chip MMCIF controller
1504afb35666SYoshihiro Shimoda
1505afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_ADDR
1506afb35666SYoshihiro Shimoda			Define the base address of MMCIF registers
1507afb35666SYoshihiro Shimoda
1508afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_CLK
1509afb35666SYoshihiro Shimoda			Define the clock frequency for MMCIF
1510afb35666SYoshihiro Shimoda
1511b3ba6e94STom Rini- USB Device Firmware Update (DFU) class support:
1512b3ba6e94STom Rini		CONFIG_DFU_FUNCTION
1513b3ba6e94STom Rini		This enables the USB portion of the DFU USB class
1514b3ba6e94STom Rini
1515b3ba6e94STom Rini		CONFIG_CMD_DFU
1516b3ba6e94STom Rini		This enables the command "dfu" which is used to have
1517b3ba6e94STom Rini		U-Boot create a DFU class device via USB.  This command
1518b3ba6e94STom Rini		requires that the "dfu_alt_info" environment variable be
1519b3ba6e94STom Rini		set and define the alt settings to expose to the host.
1520b3ba6e94STom Rini
1521b3ba6e94STom Rini		CONFIG_DFU_MMC
1522b3ba6e94STom Rini		This enables support for exposing (e)MMC devices via DFU.
1523b3ba6e94STom Rini
1524c6631764SPantelis Antoniou		CONFIG_DFU_NAND
1525c6631764SPantelis Antoniou		This enables support for exposing NAND devices via DFU.
1526c6631764SPantelis Antoniou
1527a9479f04SAfzal Mohammed		CONFIG_DFU_RAM
1528a9479f04SAfzal Mohammed		This enables support for exposing RAM via DFU.
1529a9479f04SAfzal Mohammed		Note: DFU spec refer to non-volatile memory usage, but
1530a9479f04SAfzal Mohammed		allow usages beyond the scope of spec - here RAM usage,
1531a9479f04SAfzal Mohammed		one that would help mostly the developer.
1532a9479f04SAfzal Mohammed
1533e7e75c70SHeiko Schocher		CONFIG_SYS_DFU_DATA_BUF_SIZE
1534e7e75c70SHeiko Schocher		Dfu transfer uses a buffer before writing data to the
1535e7e75c70SHeiko Schocher		raw storage device. Make the size (in bytes) of this buffer
1536e7e75c70SHeiko Schocher		configurable. The size of this buffer is also configurable
1537e7e75c70SHeiko Schocher		through the "dfu_bufsiz" environment variable.
1538e7e75c70SHeiko Schocher
1539ea2453d5SPantelis Antoniou		CONFIG_SYS_DFU_MAX_FILE_SIZE
1540ea2453d5SPantelis Antoniou		When updating files rather than the raw storage device,
1541ea2453d5SPantelis Antoniou		we use a static buffer to copy the file into and then write
1542ea2453d5SPantelis Antoniou		the buffer once we've been given the whole file.  Define
1543ea2453d5SPantelis Antoniou		this to the maximum filesize (in bytes) for the buffer.
1544ea2453d5SPantelis Antoniou		Default is 4 MiB if undefined.
1545ea2453d5SPantelis Antoniou
1546001a8319SHeiko Schocher		DFU_DEFAULT_POLL_TIMEOUT
1547001a8319SHeiko Schocher		Poll timeout [ms], is the timeout a device can send to the
1548001a8319SHeiko Schocher		host. The host must wait for this timeout before sending
1549001a8319SHeiko Schocher		a subsequent DFU_GET_STATUS request to the device.
1550001a8319SHeiko Schocher
1551001a8319SHeiko Schocher		DFU_MANIFEST_POLL_TIMEOUT
1552001a8319SHeiko Schocher		Poll timeout [ms], which the device sends to the host when
1553001a8319SHeiko Schocher		entering dfuMANIFEST state. Host waits this timeout, before
1554001a8319SHeiko Schocher		sending again an USB request to the device.
1555001a8319SHeiko Schocher
15566705d81eSwdenk- Journaling Flash filesystem support:
15576705d81eSwdenk		CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
15586705d81eSwdenk		CONFIG_JFFS2_NAND_DEV
15596705d81eSwdenk		Define these for a default partition on a NAND device
15606705d81eSwdenk
15616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_SECTOR,
15626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
15636705d81eSwdenk		Define these for a default partition on a NOR device
15646705d81eSwdenk
15656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS_CUSTOM_PART
15666705d81eSwdenk		Define this to create an own partition. You have to provide a
15676705d81eSwdenk		function struct part_info* jffs2_part_info(int part_num)
15686705d81eSwdenk
15696705d81eSwdenk		If you define only one JFFS2 partition you may also want to
15706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_JFFS_SINGLE_PART	1
15716705d81eSwdenk		to disable the command chpart. This is the default when you
15726705d81eSwdenk		have not defined a custom partition
15736705d81eSwdenk
1574c30a15e5SDonggeun Kim- FAT(File Allocation Table) filesystem write function support:
1575c30a15e5SDonggeun Kim		CONFIG_FAT_WRITE
1576656f4c65SDonggeun Kim
1577656f4c65SDonggeun Kim		Define this to enable support for saving memory data as a
1578656f4c65SDonggeun Kim		file in FAT formatted partition.
1579656f4c65SDonggeun Kim
1580656f4c65SDonggeun Kim		This will also enable the command "fatwrite" enabling the
1581656f4c65SDonggeun Kim		user to write files to FAT.
1582c30a15e5SDonggeun Kim
158384cd9327SGabe BlackCBFS (Coreboot Filesystem) support
158484cd9327SGabe Black		CONFIG_CMD_CBFS
158584cd9327SGabe Black
158684cd9327SGabe Black		Define this to enable support for reading from a Coreboot
158784cd9327SGabe Black		filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
158884cd9327SGabe Black		and cbfsload.
158984cd9327SGabe Black
1590c609719bSwdenk- Keyboard Support:
1591c609719bSwdenk		CONFIG_ISA_KEYBOARD
1592c609719bSwdenk
1593c609719bSwdenk		Define this to enable standard (PC-Style) keyboard
1594c609719bSwdenk		support
1595c609719bSwdenk
1596c609719bSwdenk		CONFIG_I8042_KBD
1597c609719bSwdenk		Standard PC keyboard driver with US (is default) and
1598c609719bSwdenk		GERMAN key layout (switch via environment 'keymap=de') support.
1599c609719bSwdenk		Export function i8042_kbd_init, i8042_tstc and i8042_getc
1600c609719bSwdenk		for cfb_console. Supports cursor blinking.
1601c609719bSwdenk
1602713cb680SHung-ying Tyan		CONFIG_CROS_EC_KEYB
1603713cb680SHung-ying Tyan		Enables a Chrome OS keyboard using the CROS_EC interface.
1604713cb680SHung-ying Tyan		This uses CROS_EC to communicate with a second microcontroller
1605713cb680SHung-ying Tyan		which provides key scans on request.
1606713cb680SHung-ying Tyan
1607c609719bSwdenk- Video support:
1608c609719bSwdenk		CONFIG_VIDEO
1609c609719bSwdenk
1610c609719bSwdenk		Define this to enable video support (for output to
1611c609719bSwdenk		video).
1612c609719bSwdenk
1613c609719bSwdenk		CONFIG_VIDEO_CT69000
1614c609719bSwdenk
1615c609719bSwdenk		Enable Chips & Technologies 69000 Video chip
1616c609719bSwdenk
1617c609719bSwdenk		CONFIG_VIDEO_SMI_LYNXEM
1618eeb1b77bSwdenk		Enable Silicon Motion SMI 712/710/810 Video chip. The
1619eeb1b77bSwdenk		video output is selected via environment 'videoout'
1620eeb1b77bSwdenk		(1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1621eeb1b77bSwdenk		assumed.
1622c609719bSwdenk
1623eeb1b77bSwdenk		For the CT69000 and SMI_LYNXEM drivers, videomode is
162411ccc33fSMarcel Ziswiler		selected via environment 'videomode'. Two different ways
1625eeb1b77bSwdenk		are possible:
1626eeb1b77bSwdenk		- "videomode=num"   'num' is a standard LiLo mode numbers.
1627eeb1b77bSwdenk		Following standard modes are supported	(* is default):
1628eeb1b77bSwdenk
1629eeb1b77bSwdenk		      Colors	640x480 800x600 1024x768 1152x864 1280x1024
1630eeb1b77bSwdenk		-------------+---------------------------------------------
1631eeb1b77bSwdenk		      8 bits |	0x301*	0x303	 0x305	  0x161	    0x307
1632eeb1b77bSwdenk		     15 bits |	0x310	0x313	 0x316	  0x162	    0x319
1633eeb1b77bSwdenk		     16 bits |	0x311	0x314	 0x317	  0x163	    0x31A
1634eeb1b77bSwdenk		     24 bits |	0x312	0x315	 0x318	    ?	    0x31B
1635eeb1b77bSwdenk		-------------+---------------------------------------------
1636c609719bSwdenk		(i.e. setenv videomode 317; saveenv; reset;)
1637c609719bSwdenk
1638eeb1b77bSwdenk		- "videomode=bootargs" all the video parameters are parsed
16397817cb20SMarcel Ziswiler		from the bootargs. (See drivers/video/videomodes.c)
1640eeb1b77bSwdenk
1641eeb1b77bSwdenk
1642a6c7ad2fSwdenk		CONFIG_VIDEO_SED13806
1643a6c7ad2fSwdenk		Enable Epson SED13806 driver. This driver supports 8bpp
1644a6c7ad2fSwdenk		and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1645a6c7ad2fSwdenk		or CONFIG_VIDEO_SED13806_16BPP
1646a6c7ad2fSwdenk
16477d3053fbSTimur Tabi		CONFIG_FSL_DIU_FB
16487d3053fbSTimur Tabi		Enable the Freescale DIU video driver.	Reference boards for
16497d3053fbSTimur Tabi		SOCs that have a DIU should define this macro to enable DIU
16507d3053fbSTimur Tabi		support, and should also define these other macros:
16517d3053fbSTimur Tabi
16527d3053fbSTimur Tabi			CONFIG_SYS_DIU_ADDR
16537d3053fbSTimur Tabi			CONFIG_VIDEO
16547d3053fbSTimur Tabi			CONFIG_CMD_BMP
16557d3053fbSTimur Tabi			CONFIG_CFB_CONSOLE
16567d3053fbSTimur Tabi			CONFIG_VIDEO_SW_CURSOR
16577d3053fbSTimur Tabi			CONFIG_VGA_AS_SINGLE_DEVICE
16587d3053fbSTimur Tabi			CONFIG_VIDEO_LOGO
16597d3053fbSTimur Tabi			CONFIG_VIDEO_BMP_LOGO
16607d3053fbSTimur Tabi
1661ba8e76bdSTimur Tabi		The DIU driver will look for the 'video-mode' environment
1662ba8e76bdSTimur Tabi		variable, and if defined, enable the DIU as a console during
1663ba8e76bdSTimur Tabi		boot.  See the documentation file README.video for a
1664ba8e76bdSTimur Tabi		description of this variable.
16657d3053fbSTimur Tabi
1666058d59b0SSimon Glass		CONFIG_VIDEO_VGA
1667058d59b0SSimon Glass
1668058d59b0SSimon Glass		Enable the VGA video / BIOS for x86. The alternative if you
1669058d59b0SSimon Glass		are using coreboot is to use the coreboot frame buffer
1670058d59b0SSimon Glass		driver.
1671058d59b0SSimon Glass
1672058d59b0SSimon Glass
1673682011ffSwdenk- Keyboard Support:
1674682011ffSwdenk		CONFIG_KEYBOARD
1675682011ffSwdenk
1676682011ffSwdenk		Define this to enable a custom keyboard support.
1677682011ffSwdenk		This simply calls drv_keyboard_init() which must be
1678682011ffSwdenk		defined in your board-specific files.
1679682011ffSwdenk		The only board using this so far is RBC823.
1680a6c7ad2fSwdenk
1681c609719bSwdenk- LCD Support:	CONFIG_LCD
1682c609719bSwdenk
1683c609719bSwdenk		Define this to enable LCD support (for output to LCD
1684c609719bSwdenk		display); also select one of the supported displays
1685c609719bSwdenk		by defining one of these:
1686c609719bSwdenk
168739cf4804SStelian Pop		CONFIG_ATMEL_LCD:
168839cf4804SStelian Pop
168939cf4804SStelian Pop			HITACHI TX09D70VM1CCA, 3.5", 240x320.
169039cf4804SStelian Pop
1691fd3103bbSwdenk		CONFIG_NEC_NL6448AC33:
1692c609719bSwdenk
1693fd3103bbSwdenk			NEC NL6448AC33-18. Active, color, single scan.
1694c609719bSwdenk
1695fd3103bbSwdenk		CONFIG_NEC_NL6448BC20
1696c609719bSwdenk
1697fd3103bbSwdenk			NEC NL6448BC20-08. 6.5", 640x480.
1698fd3103bbSwdenk			Active, color, single scan.
1699fd3103bbSwdenk
1700fd3103bbSwdenk		CONFIG_NEC_NL6448BC33_54
1701fd3103bbSwdenk
1702fd3103bbSwdenk			NEC NL6448BC33-54. 10.4", 640x480.
1703c609719bSwdenk			Active, color, single scan.
1704c609719bSwdenk
1705c609719bSwdenk		CONFIG_SHARP_16x9
1706c609719bSwdenk
1707c609719bSwdenk			Sharp 320x240. Active, color, single scan.
1708c609719bSwdenk			It isn't 16x9, and I am not sure what it is.
1709c609719bSwdenk
1710c609719bSwdenk		CONFIG_SHARP_LQ64D341
1711c609719bSwdenk
1712c609719bSwdenk			Sharp LQ64D341 display, 640x480.
1713c609719bSwdenk			Active, color, single scan.
1714c609719bSwdenk
1715c609719bSwdenk		CONFIG_HLD1045
1716c609719bSwdenk
1717c609719bSwdenk			HLD1045 display, 640x480.
1718c609719bSwdenk			Active, color, single scan.
1719c609719bSwdenk
1720c609719bSwdenk		CONFIG_OPTREX_BW
1721c609719bSwdenk
1722c609719bSwdenk			Optrex	 CBL50840-2 NF-FW 99 22 M5
1723c609719bSwdenk			or
1724c609719bSwdenk			Hitachi	 LMG6912RPFC-00T
1725c609719bSwdenk			or
1726c609719bSwdenk			Hitachi	 SP14Q002
1727c609719bSwdenk
1728c609719bSwdenk			320x240. Black & white.
1729c609719bSwdenk
1730c609719bSwdenk		Normally display is black on white background; define
17316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
1732c609719bSwdenk
1733676d319eSSimon Glass		CONFIG_LCD_ALIGNMENT
1734676d319eSSimon Glass
1735676d319eSSimon Glass		Normally the LCD is page-aligned (tyically 4KB). If this is
1736676d319eSSimon Glass		defined then the LCD will be aligned to this value instead.
1737676d319eSSimon Glass		For ARM it is sometimes useful to use MMU_SECTION_SIZE
1738676d319eSSimon Glass		here, since it is cheaper to change data cache settings on
1739676d319eSSimon Glass		a per-section basis.
1740676d319eSSimon Glass
17410d89efefSSimon Glass		CONFIG_CONSOLE_SCROLL_LINES
17420d89efefSSimon Glass
17430d89efefSSimon Glass		When the console need to be scrolled, this is the number of
17440d89efefSSimon Glass		lines to scroll by. It defaults to 1. Increasing this makes
17450d89efefSSimon Glass		the console jump but can help speed up operation when scrolling
17460d89efefSSimon Glass		is slow.
1747676d319eSSimon Glass
174845d7f525STom Wai-Hong Tam		CONFIG_LCD_BMP_RLE8
174945d7f525STom Wai-Hong Tam
175045d7f525STom Wai-Hong Tam		Support drawing of RLE8-compressed bitmaps on the LCD.
175145d7f525STom Wai-Hong Tam
1752735987c5STom Wai-Hong Tam		CONFIG_I2C_EDID
1753735987c5STom Wai-Hong Tam
1754735987c5STom Wai-Hong Tam		Enables an 'i2c edid' command which can read EDID
1755735987c5STom Wai-Hong Tam		information over I2C from an attached LCD display.
1756735987c5STom Wai-Hong Tam
17577152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN
1758d791b1dcSwdenk
1759d791b1dcSwdenk		If this option is set, the environment is checked for
1760d791b1dcSwdenk		a variable "splashimage". If found, the usual display
1761d791b1dcSwdenk		of logo, copyright and system information on the LCD
1762e94d2cd9Swdenk		is suppressed and the BMP image at the address
1763d791b1dcSwdenk		specified in "splashimage" is loaded instead. The
1764d791b1dcSwdenk		console is redirected to the "nulldev", too. This
1765d791b1dcSwdenk		allows for a "silent" boot where a splash screen is
1766d791b1dcSwdenk		loaded very quickly after power-on.
1767d791b1dcSwdenk
1768c0880485SNikita Kiryanov		CONFIG_SPLASHIMAGE_GUARD
1769c0880485SNikita Kiryanov
1770c0880485SNikita Kiryanov		If this option is set, then U-Boot will prevent the environment
1771c0880485SNikita Kiryanov		variable "splashimage" from being set to a problematic address
17721551df35STom Rini		(see README.displaying-bmps).
1773c0880485SNikita Kiryanov		This option is useful for targets where, due to alignment
1774c0880485SNikita Kiryanov		restrictions, an improperly aligned BMP image will cause a data
1775c0880485SNikita Kiryanov		abort. If you think you will not have problems with unaligned
1776c0880485SNikita Kiryanov		accesses (for example because your toolchain prevents them)
1777c0880485SNikita Kiryanov		there is no need to set this option.
1778c0880485SNikita Kiryanov
17791ca298ceSMatthias Weisser		CONFIG_SPLASH_SCREEN_ALIGN
17801ca298ceSMatthias Weisser
17811ca298ceSMatthias Weisser		If this option is set the splash image can be freely positioned
17821ca298ceSMatthias Weisser		on the screen. Environment variable "splashpos" specifies the
17831ca298ceSMatthias Weisser		position as "x,y". If a positive number is given it is used as
17841ca298ceSMatthias Weisser		number of pixel from left/top. If a negative number is given it
17851ca298ceSMatthias Weisser		is used as number of pixel from right/bottom. You can also
17861ca298ceSMatthias Weisser		specify 'm' for centering the image.
17871ca298ceSMatthias Weisser
17881ca298ceSMatthias Weisser		Example:
17891ca298ceSMatthias Weisser		setenv splashpos m,m
17901ca298ceSMatthias Weisser			=> image at center of screen
17911ca298ceSMatthias Weisser
17921ca298ceSMatthias Weisser		setenv splashpos 30,20
17931ca298ceSMatthias Weisser			=> image at x = 30 and y = 20
17941ca298ceSMatthias Weisser
17951ca298ceSMatthias Weisser		setenv splashpos -10,m
17961ca298ceSMatthias Weisser			=> vertically centered image
17971ca298ceSMatthias Weisser			   at x = dspWidth - bmpWidth - 9
17981ca298ceSMatthias Weisser
179998f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
180098f4a3dfSStefan Roese
180198f4a3dfSStefan Roese		If this option is set, additionally to standard BMP
180298f4a3dfSStefan Roese		images, gzipped BMP images can be displayed via the
180398f4a3dfSStefan Roese		splashscreen support or the bmp command.
180498f4a3dfSStefan Roese
1805d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1806d5011762SAnatolij Gustschin
1807d5011762SAnatolij Gustschin		If this option is set, 8-bit RLE compressed BMP images
1808d5011762SAnatolij Gustschin		can be displayed via the splashscreen support or the
1809d5011762SAnatolij Gustschin		bmp command.
1810d5011762SAnatolij Gustschin
1811f2b96dfbSLei Wen- Do compresssing for memory range:
1812f2b96dfbSLei Wen		CONFIG_CMD_ZIP
1813f2b96dfbSLei Wen
1814f2b96dfbSLei Wen		If this option is set, it would use zlib deflate method
1815f2b96dfbSLei Wen		to compress the specified memory at its best effort.
1816f2b96dfbSLei Wen
1817c29fdfc1Swdenk- Compression support:
18188ef70478SKees Cook		CONFIG_GZIP
18198ef70478SKees Cook
18208ef70478SKees Cook		Enabled by default to support gzip compressed images.
18218ef70478SKees Cook
1822c29fdfc1Swdenk		CONFIG_BZIP2
1823c29fdfc1Swdenk
1824c29fdfc1Swdenk		If this option is set, support for bzip2 compressed
1825c29fdfc1Swdenk		images is included. If not, only uncompressed and gzip
1826c29fdfc1Swdenk		compressed images are supported.
1827c29fdfc1Swdenk
1828c29fdfc1Swdenk		NOTE: the bzip2 algorithm requires a lot of RAM, so
18296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
1830c29fdfc1Swdenk		be at least 4MB.
1831d791b1dcSwdenk
1832fc9c1727SLuigi 'Comio' Mantellini		CONFIG_LZMA
1833fc9c1727SLuigi 'Comio' Mantellini
1834fc9c1727SLuigi 'Comio' Mantellini		If this option is set, support for lzma compressed
1835fc9c1727SLuigi 'Comio' Mantellini		images is included.
1836fc9c1727SLuigi 'Comio' Mantellini
1837fc9c1727SLuigi 'Comio' Mantellini		Note: The LZMA algorithm adds between 2 and 4KB of code and it
1838fc9c1727SLuigi 'Comio' Mantellini		requires an amount of dynamic memory that is given by the
1839fc9c1727SLuigi 'Comio' Mantellini		formula:
1840fc9c1727SLuigi 'Comio' Mantellini
1841fc9c1727SLuigi 'Comio' Mantellini			(1846 + 768 << (lc + lp)) * sizeof(uint16)
1842fc9c1727SLuigi 'Comio' Mantellini
1843fc9c1727SLuigi 'Comio' Mantellini		Where lc and lp stand for, respectively, Literal context bits
1844fc9c1727SLuigi 'Comio' Mantellini		and Literal pos bits.
1845fc9c1727SLuigi 'Comio' Mantellini
1846fc9c1727SLuigi 'Comio' Mantellini		This value is upper-bounded by 14MB in the worst case. Anyway,
1847fc9c1727SLuigi 'Comio' Mantellini		for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1848fc9c1727SLuigi 'Comio' Mantellini		total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1849fc9c1727SLuigi 'Comio' Mantellini		a very small buffer.
1850fc9c1727SLuigi 'Comio' Mantellini
1851fc9c1727SLuigi 'Comio' Mantellini		Use the lzmainfo tool to determinate the lc and lp values and
1852fc9c1727SLuigi 'Comio' Mantellini		then calculate the amount of needed dynamic memory (ensuring
18536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the appropriate CONFIG_SYS_MALLOC_LEN value).
1854fc9c1727SLuigi 'Comio' Mantellini
18558ef70478SKees Cook		CONFIG_LZO
18568ef70478SKees Cook
18578ef70478SKees Cook		If this option is set, support for LZO compressed images
18588ef70478SKees Cook		is included.
18598ef70478SKees Cook
186017ea1177Swdenk- MII/PHY support:
186117ea1177Swdenk		CONFIG_PHY_ADDR
186217ea1177Swdenk
186317ea1177Swdenk		The address of PHY on MII bus.
186417ea1177Swdenk
186517ea1177Swdenk		CONFIG_PHY_CLOCK_FREQ (ppc4xx)
186617ea1177Swdenk
186717ea1177Swdenk		The clock frequency of the MII bus
186817ea1177Swdenk
186917ea1177Swdenk		CONFIG_PHY_GIGE
187017ea1177Swdenk
187117ea1177Swdenk		If this option is set, support for speed/duplex
187211ccc33fSMarcel Ziswiler		detection of gigabit PHY is included.
187317ea1177Swdenk
187417ea1177Swdenk		CONFIG_PHY_RESET_DELAY
187517ea1177Swdenk
187617ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
187717ea1177Swdenk		reset before any MII register access is possible.
187817ea1177Swdenk		For such PHY, set this option to the usec delay
187917ea1177Swdenk		required. (minimum 300usec for LXT971A)
188017ea1177Swdenk
188117ea1177Swdenk		CONFIG_PHY_CMD_DELAY (ppc4xx)
188217ea1177Swdenk
188317ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
188417ea1177Swdenk		command issued before MII status register can be read
188517ea1177Swdenk
1886c609719bSwdenk- Ethernet address:
1887c609719bSwdenk		CONFIG_ETHADDR
1888c68a05feSrichardretanubun		CONFIG_ETH1ADDR
1889c609719bSwdenk		CONFIG_ETH2ADDR
1890c609719bSwdenk		CONFIG_ETH3ADDR
1891c68a05feSrichardretanubun		CONFIG_ETH4ADDR
1892c68a05feSrichardretanubun		CONFIG_ETH5ADDR
1893c609719bSwdenk
189411ccc33fSMarcel Ziswiler		Define a default value for Ethernet address to use
189511ccc33fSMarcel Ziswiler		for the respective Ethernet interface, in case this
1896c609719bSwdenk		is not determined automatically.
1897c609719bSwdenk
1898c609719bSwdenk- IP address:
1899c609719bSwdenk		CONFIG_IPADDR
1900c609719bSwdenk
1901c609719bSwdenk		Define a default value for the IP address to use for
190211ccc33fSMarcel Ziswiler		the default Ethernet interface, in case this is not
1903c609719bSwdenk		determined through e.g. bootp.
19041ebcd654SWolfgang Denk		(Environment variable "ipaddr")
1905c609719bSwdenk
1906c609719bSwdenk- Server IP address:
1907c609719bSwdenk		CONFIG_SERVERIP
1908c609719bSwdenk
1909c609719bSwdenk		Defines a default value for the IP address of a TFTP
1910c609719bSwdenk		server to contact when using the "tftboot" command.
19111ebcd654SWolfgang Denk		(Environment variable "serverip")
1912c609719bSwdenk
191397cfe861SRobin Getz		CONFIG_KEEP_SERVERADDR
191497cfe861SRobin Getz
191597cfe861SRobin Getz		Keeps the server's MAC address, in the env 'serveraddr'
191697cfe861SRobin Getz		for passing to bootargs (like Linux's netconsole option)
191797cfe861SRobin Getz
19181ebcd654SWolfgang Denk- Gateway IP address:
19191ebcd654SWolfgang Denk		CONFIG_GATEWAYIP
19201ebcd654SWolfgang Denk
19211ebcd654SWolfgang Denk		Defines a default value for the IP address of the
19221ebcd654SWolfgang Denk		default router where packets to other networks are
19231ebcd654SWolfgang Denk		sent to.
19241ebcd654SWolfgang Denk		(Environment variable "gatewayip")
19251ebcd654SWolfgang Denk
19261ebcd654SWolfgang Denk- Subnet mask:
19271ebcd654SWolfgang Denk		CONFIG_NETMASK
19281ebcd654SWolfgang Denk
19291ebcd654SWolfgang Denk		Defines a default value for the subnet mask (or
19301ebcd654SWolfgang Denk		routing prefix) which is used to determine if an IP
19311ebcd654SWolfgang Denk		address belongs to the local subnet or needs to be
19321ebcd654SWolfgang Denk		forwarded through a router.
19331ebcd654SWolfgang Denk		(Environment variable "netmask")
19341ebcd654SWolfgang Denk
193553a5c424SDavid Updegraff- Multicast TFTP Mode:
193653a5c424SDavid Updegraff		CONFIG_MCAST_TFTP
193753a5c424SDavid Updegraff
193853a5c424SDavid Updegraff		Defines whether you want to support multicast TFTP as per
193953a5c424SDavid Updegraff		rfc-2090; for example to work with atftp.  Lets lots of targets
194011ccc33fSMarcel Ziswiler		tftp down the same boot image concurrently.  Note: the Ethernet
194153a5c424SDavid Updegraff		driver in use must provide a function: mcast() to join/leave a
194253a5c424SDavid Updegraff		multicast group.
194353a5c424SDavid Updegraff
1944c609719bSwdenk- BOOTP Recovery Mode:
1945c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY
1946c609719bSwdenk
1947c609719bSwdenk		If you have many targets in a network that try to
1948c609719bSwdenk		boot using BOOTP, you may want to avoid that all
1949c609719bSwdenk		systems send out BOOTP requests at precisely the same
1950c609719bSwdenk		moment (which would happen for instance at recovery
1951c609719bSwdenk		from a power failure, when all systems will try to
1952c609719bSwdenk		boot, thus flooding the BOOTP server. Defining
1953c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1954c609719bSwdenk		inserted before sending out BOOTP requests. The
19556c33c785SWolfgang Denk		following delays are inserted then:
1956c609719bSwdenk
1957c609719bSwdenk		1st BOOTP request:	delay 0 ... 1 sec
1958c609719bSwdenk		2nd BOOTP request:	delay 0 ... 2 sec
1959c609719bSwdenk		3rd BOOTP request:	delay 0 ... 4 sec
1960c609719bSwdenk		4th and following
1961c609719bSwdenk		BOOTP requests:		delay 0 ... 8 sec
1962c609719bSwdenk
1963fe389a82Sstroese- DHCP Advanced Options:
19641fe80d79SJon Loeliger		You can fine tune the DHCP functionality by defining
19651fe80d79SJon Loeliger		CONFIG_BOOTP_* symbols:
1966fe389a82Sstroese
19671fe80d79SJon Loeliger		CONFIG_BOOTP_SUBNETMASK
19681fe80d79SJon Loeliger		CONFIG_BOOTP_GATEWAY
19691fe80d79SJon Loeliger		CONFIG_BOOTP_HOSTNAME
19701fe80d79SJon Loeliger		CONFIG_BOOTP_NISDOMAIN
19711fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTPATH
19721fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTFILESIZE
19731fe80d79SJon Loeliger		CONFIG_BOOTP_DNS
19741fe80d79SJon Loeliger		CONFIG_BOOTP_DNS2
19751fe80d79SJon Loeliger		CONFIG_BOOTP_SEND_HOSTNAME
19761fe80d79SJon Loeliger		CONFIG_BOOTP_NTPSERVER
19771fe80d79SJon Loeliger		CONFIG_BOOTP_TIMEOFFSET
19781fe80d79SJon Loeliger		CONFIG_BOOTP_VENDOREX
19792c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL
1980fe389a82Sstroese
19815d110f0aSWilson Callan		CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
19825d110f0aSWilson Callan		environment variable, not the BOOTP server.
1983fe389a82Sstroese
19842c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
19852c00e099SJoe Hershberger		after the configured retry count, the call will fail
19862c00e099SJoe Hershberger		instead of starting over.  This can be used to fail over
19872c00e099SJoe Hershberger		to Link-local IP address configuration if the DHCP server
19882c00e099SJoe Hershberger		is not available.
19892c00e099SJoe Hershberger
1990fe389a82Sstroese		CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1991fe389a82Sstroese		serverip from a DHCP server, it is possible that more
1992fe389a82Sstroese		than one DNS serverip is offered to the client.
1993fe389a82Sstroese		If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1994fe389a82Sstroese		serverip will be stored in the additional environment
1995fe389a82Sstroese		variable "dnsip2". The first DNS serverip is always
1996fe389a82Sstroese		stored in the variable "dnsip", when CONFIG_BOOTP_DNS
19971fe80d79SJon Loeliger		is defined.
1998fe389a82Sstroese
1999fe389a82Sstroese		CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
2000fe389a82Sstroese		to do a dynamic update of a DNS server. To do this, they
2001fe389a82Sstroese		need the hostname of the DHCP requester.
20025d110f0aSWilson Callan		If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
20031fe80d79SJon Loeliger		of the "hostname" environment variable is passed as
20041fe80d79SJon Loeliger		option 12 to the DHCP server.
2005fe389a82Sstroese
2006d9a2f416SAras Vaichas		CONFIG_BOOTP_DHCP_REQUEST_DELAY
2007d9a2f416SAras Vaichas
2008d9a2f416SAras Vaichas		A 32bit value in microseconds for a delay between
2009d9a2f416SAras Vaichas		receiving a "DHCP Offer" and sending the "DHCP Request".
2010d9a2f416SAras Vaichas		This fixes a problem with certain DHCP servers that don't
2011d9a2f416SAras Vaichas		respond 100% of the time to a "DHCP request". E.g. On an
2012d9a2f416SAras Vaichas		AT91RM9200 processor running at 180MHz, this delay needed
2013d9a2f416SAras Vaichas		to be *at least* 15,000 usec before a Windows Server 2003
2014d9a2f416SAras Vaichas		DHCP server would reply 100% of the time. I recommend at
2015d9a2f416SAras Vaichas		least 50,000 usec to be safe. The alternative is to hope
2016d9a2f416SAras Vaichas		that one of the retries will be successful but note that
2017d9a2f416SAras Vaichas		the DHCP timeout and retry process takes a longer than
2018d9a2f416SAras Vaichas		this delay.
2019d9a2f416SAras Vaichas
2020d22c338eSJoe Hershberger - Link-local IP address negotiation:
2021d22c338eSJoe Hershberger		Negotiate with other link-local clients on the local network
2022d22c338eSJoe Hershberger		for an address that doesn't require explicit configuration.
2023d22c338eSJoe Hershberger		This is especially useful if a DHCP server cannot be guaranteed
2024d22c338eSJoe Hershberger		to exist in all environments that the device must operate.
2025d22c338eSJoe Hershberger
2026d22c338eSJoe Hershberger		See doc/README.link-local for more information.
2027d22c338eSJoe Hershberger
2028a3d991bdSwdenk - CDP Options:
2029a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID
2030a3d991bdSwdenk
2031a3d991bdSwdenk		The device id used in CDP trigger frames.
2032a3d991bdSwdenk
2033a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID_PREFIX
2034a3d991bdSwdenk
2035a3d991bdSwdenk		A two character string which is prefixed to the MAC address
2036a3d991bdSwdenk		of the device.
2037a3d991bdSwdenk
2038a3d991bdSwdenk		CONFIG_CDP_PORT_ID
2039a3d991bdSwdenk
2040a3d991bdSwdenk		A printf format string which contains the ascii name of
2041a3d991bdSwdenk		the port. Normally is set to "eth%d" which sets
204211ccc33fSMarcel Ziswiler		eth0 for the first Ethernet, eth1 for the second etc.
2043a3d991bdSwdenk
2044a3d991bdSwdenk		CONFIG_CDP_CAPABILITIES
2045a3d991bdSwdenk
2046a3d991bdSwdenk		A 32bit integer which indicates the device capabilities;
2047a3d991bdSwdenk		0x00000010 for a normal host which does not forwards.
2048a3d991bdSwdenk
2049a3d991bdSwdenk		CONFIG_CDP_VERSION
2050a3d991bdSwdenk
2051a3d991bdSwdenk		An ascii string containing the version of the software.
2052a3d991bdSwdenk
2053a3d991bdSwdenk		CONFIG_CDP_PLATFORM
2054a3d991bdSwdenk
2055a3d991bdSwdenk		An ascii string containing the name of the platform.
2056a3d991bdSwdenk
2057a3d991bdSwdenk		CONFIG_CDP_TRIGGER
2058a3d991bdSwdenk
2059a3d991bdSwdenk		A 32bit integer sent on the trigger.
2060a3d991bdSwdenk
2061a3d991bdSwdenk		CONFIG_CDP_POWER_CONSUMPTION
2062a3d991bdSwdenk
2063a3d991bdSwdenk		A 16bit integer containing the power consumption of the
2064a3d991bdSwdenk		device in .1 of milliwatts.
2065a3d991bdSwdenk
2066a3d991bdSwdenk		CONFIG_CDP_APPLIANCE_VLAN_TYPE
2067a3d991bdSwdenk
2068a3d991bdSwdenk		A byte containing the id of the VLAN.
2069a3d991bdSwdenk
2070c609719bSwdenk- Status LED:	CONFIG_STATUS_LED
2071c609719bSwdenk
2072c609719bSwdenk		Several configurations allow to display the current
2073c609719bSwdenk		status using a LED. For instance, the LED will blink
2074c609719bSwdenk		fast while running U-Boot code, stop blinking as
2075c609719bSwdenk		soon as a reply to a BOOTP request was received, and
2076c609719bSwdenk		start blinking slow once the Linux kernel is running
2077c609719bSwdenk		(supported by a status LED driver in the Linux
2078c609719bSwdenk		kernel). Defining CONFIG_STATUS_LED enables this
2079c609719bSwdenk		feature in U-Boot.
2080c609719bSwdenk
20811df7bbbaSIgor Grinberg		Additional options:
20821df7bbbaSIgor Grinberg
20831df7bbbaSIgor Grinberg		CONFIG_GPIO_LED
20841df7bbbaSIgor Grinberg		The status LED can be connected to a GPIO pin.
20851df7bbbaSIgor Grinberg		In such cases, the gpio_led driver can be used as a
20861df7bbbaSIgor Grinberg		status LED backend implementation. Define CONFIG_GPIO_LED
20871df7bbbaSIgor Grinberg		to include the gpio_led driver in the U-Boot binary.
20881df7bbbaSIgor Grinberg
20899dfdcdfeSIgor Grinberg		CONFIG_GPIO_LED_INVERTED_TABLE
20909dfdcdfeSIgor Grinberg		Some GPIO connected LEDs may have inverted polarity in which
20919dfdcdfeSIgor Grinberg		case the GPIO high value corresponds to LED off state and
20929dfdcdfeSIgor Grinberg		GPIO low value corresponds to LED on state.
20939dfdcdfeSIgor Grinberg		In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
20949dfdcdfeSIgor Grinberg		with a list of GPIO LEDs that have inverted polarity.
20959dfdcdfeSIgor Grinberg
2096c609719bSwdenk- CAN Support:	CONFIG_CAN_DRIVER
2097c609719bSwdenk
2098c609719bSwdenk		Defining CONFIG_CAN_DRIVER enables CAN driver support
2099c609719bSwdenk		on those systems that support this (optional)
2100c609719bSwdenk		feature, like the TQM8xxL modules.
2101c609719bSwdenk
21023f4978c7SHeiko Schocher- I2C Support:	CONFIG_SYS_I2C
2103c609719bSwdenk
21043f4978c7SHeiko Schocher		This enable the NEW i2c subsystem, and will allow you to use
21053f4978c7SHeiko Schocher		i2c commands at the u-boot command line (as long as you set
21063f4978c7SHeiko Schocher		CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
21073f4978c7SHeiko Schocher		based realtime clock chips or other i2c devices. See
21083f4978c7SHeiko Schocher		common/cmd_i2c.c for a description of the command line
21093f4978c7SHeiko Schocher		interface.
21103f4978c7SHeiko Schocher
21113f4978c7SHeiko Schocher		ported i2c driver to the new framework:
2112ea818dbbSHeiko Schocher		- drivers/i2c/soft_i2c.c:
2113ea818dbbSHeiko Schocher		  - activate first bus with CONFIG_SYS_I2C_SOFT define
2114ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2115ea818dbbSHeiko Schocher		    for defining speed and slave address
2116ea818dbbSHeiko Schocher		  - activate second bus with I2C_SOFT_DECLARATIONS2 define
2117ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2118ea818dbbSHeiko Schocher		    for defining speed and slave address
2119ea818dbbSHeiko Schocher		  - activate third bus with I2C_SOFT_DECLARATIONS3 define
2120ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2121ea818dbbSHeiko Schocher		    for defining speed and slave address
2122ea818dbbSHeiko Schocher		  - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2123ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2124ea818dbbSHeiko Schocher		    for defining speed and slave address
21253f4978c7SHeiko Schocher
212600f792e0SHeiko Schocher		- drivers/i2c/fsl_i2c.c:
212700f792e0SHeiko Schocher		  - activate i2c driver with CONFIG_SYS_I2C_FSL
212800f792e0SHeiko Schocher		    define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
212900f792e0SHeiko Schocher		    offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
213000f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
213100f792e0SHeiko Schocher		    bus.
213200f792e0SHeiko Schocher		  - If your board supports a second fsl i2c bus, define
213300f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
213400f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_SPEED for the speed and
213500f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
213600f792e0SHeiko Schocher		    second bus.
213700f792e0SHeiko Schocher
21381f2ba722SSimon Glass		- drivers/i2c/tegra_i2c.c:
21391f2ba722SSimon Glass		  - activate this driver with CONFIG_SYS_I2C_TEGRA
21401f2ba722SSimon Glass		  - This driver adds 4 i2c buses with a fix speed from
21411f2ba722SSimon Glass		    100000 and the slave addr 0!
21421f2ba722SSimon Glass
2143880540deSDirk Eibach		- drivers/i2c/ppc4xx_i2c.c
2144880540deSDirk Eibach		  - activate this driver with CONFIG_SYS_I2C_PPC4XX
2145880540deSDirk Eibach		  - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2146880540deSDirk Eibach		  - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2147880540deSDirk Eibach
2148fac96408Strem		- drivers/i2c/i2c_mxc.c
2149fac96408Strem		  - activate this driver with CONFIG_SYS_I2C_MXC
2150fac96408Strem		  - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2151fac96408Strem		  - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2152fac96408Strem		  - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2153fac96408Strem		  - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2154fac96408Strem		  - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2155fac96408Strem		  - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
2156fac96408Strem		If thoses defines are not set, default value is 100000
2157fac96408Strem		for speed, and 0 for slave.
2158fac96408Strem
21591086bfa9SNobuhiro Iwamatsu		- drivers/i2c/rcar_i2c.c:
21601086bfa9SNobuhiro Iwamatsu		  - activate this driver with CONFIG_SYS_I2C_RCAR
21611086bfa9SNobuhiro Iwamatsu		  - This driver adds 4 i2c buses
21621086bfa9SNobuhiro Iwamatsu
21631086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
21641086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
21651086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
21661086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
21671086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
21681086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
21691086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
21701086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
21711086bfa9SNobuhiro Iwamatsu		  - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
21721086bfa9SNobuhiro Iwamatsu
21732035d77dSNobuhiro Iwamatsu		- drivers/i2c/sh_i2c.c:
21742035d77dSNobuhiro Iwamatsu		  - activate this driver with CONFIG_SYS_I2C_SH
21752035d77dSNobuhiro Iwamatsu		  - This driver adds from 2 to 5 i2c buses
21762035d77dSNobuhiro Iwamatsu
21772035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
21782035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
21792035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
21802035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
21812035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
21822035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
21832035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
21842035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
21852035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
21862035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
21872035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
21882035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
21892035d77dSNobuhiro Iwamatsu		  - CONFIF_SYS_I2C_SH_NUM_CONTROLLERS for nummber of i2c buses
21902035d77dSNobuhiro Iwamatsu
21916789e84eSHeiko Schocher		- drivers/i2c/omap24xx_i2c.c
21926789e84eSHeiko Schocher		  - activate this driver with CONFIG_SYS_I2C_OMAP24XX
21936789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
21946789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
21956789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
21966789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
21976789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
21986789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
21996789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
22006789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
22016789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
22026789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
22036789e84eSHeiko Schocher
22040bdffe71SHeiko Schocher		- drivers/i2c/zynq_i2c.c
22050bdffe71SHeiko Schocher		  - activate this driver with CONFIG_SYS_I2C_ZYNQ
22060bdffe71SHeiko Schocher		  - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
22070bdffe71SHeiko Schocher		  - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
22080bdffe71SHeiko Schocher
2209e717fc6dSNaveen Krishna Ch		- drivers/i2c/s3c24x0_i2c.c:
2210e717fc6dSNaveen Krishna Ch		  - activate this driver with CONFIG_SYS_I2C_S3C24X0
2211e717fc6dSNaveen Krishna Ch		  - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2212e717fc6dSNaveen Krishna Ch		    9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2213e717fc6dSNaveen Krishna Ch		    with a fix speed from 100000 and the slave addr 0!
2214e717fc6dSNaveen Krishna Ch
22153f4978c7SHeiko Schocher		additional defines:
22163f4978c7SHeiko Schocher
22173f4978c7SHeiko Schocher		CONFIG_SYS_NUM_I2C_BUSES
22183f4978c7SHeiko Schocher		Hold the number of i2c busses you want to use. If you
22193f4978c7SHeiko Schocher		don't use/have i2c muxes on your i2c bus, this
22203f4978c7SHeiko Schocher		is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
22213f4978c7SHeiko Schocher		omit this define.
22223f4978c7SHeiko Schocher
22233f4978c7SHeiko Schocher		CONFIG_SYS_I2C_DIRECT_BUS
22243f4978c7SHeiko Schocher		define this, if you don't use i2c muxes on your hardware.
22253f4978c7SHeiko Schocher		if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
22263f4978c7SHeiko Schocher		omit this define.
22273f4978c7SHeiko Schocher
22283f4978c7SHeiko Schocher		CONFIG_SYS_I2C_MAX_HOPS
22293f4978c7SHeiko Schocher		define how many muxes are maximal consecutively connected
22303f4978c7SHeiko Schocher		on one i2c bus. If you not use i2c muxes, omit this
22313f4978c7SHeiko Schocher		define.
22323f4978c7SHeiko Schocher
22333f4978c7SHeiko Schocher		CONFIG_SYS_I2C_BUSES
22343f4978c7SHeiko Schocher		hold a list of busses you want to use, only used if
22353f4978c7SHeiko Schocher		CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
22363f4978c7SHeiko Schocher		a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
22373f4978c7SHeiko Schocher		CONFIG_SYS_NUM_I2C_BUSES = 9:
22383f4978c7SHeiko Schocher
22393f4978c7SHeiko Schocher		 CONFIG_SYS_I2C_BUSES	{{0, {I2C_NULL_HOP}}, \
22403f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
22413f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
22423f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
22433f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
22443f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
22453f4978c7SHeiko Schocher					{1, {I2C_NULL_HOP}}, \
22463f4978c7SHeiko Schocher					{1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
22473f4978c7SHeiko Schocher					{1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
22483f4978c7SHeiko Schocher					}
22493f4978c7SHeiko Schocher
22503f4978c7SHeiko Schocher		which defines
22513f4978c7SHeiko Schocher			bus 0 on adapter 0 without a mux
2252ea818dbbSHeiko Schocher			bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2253ea818dbbSHeiko Schocher			bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2254ea818dbbSHeiko Schocher			bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2255ea818dbbSHeiko Schocher			bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2256ea818dbbSHeiko Schocher			bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
22573f4978c7SHeiko Schocher			bus 6 on adapter 1 without a mux
2258ea818dbbSHeiko Schocher			bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2259ea818dbbSHeiko Schocher			bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
22603f4978c7SHeiko Schocher
22613f4978c7SHeiko Schocher		If you do not have i2c muxes on your board, omit this define.
22623f4978c7SHeiko Schocher
2263ea818dbbSHeiko Schocher- Legacy I2C Support:	CONFIG_HARD_I2C
22643f4978c7SHeiko Schocher
22653f4978c7SHeiko Schocher		NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
22663f4978c7SHeiko Schocher		provides the following compelling advantages:
22673f4978c7SHeiko Schocher
22683f4978c7SHeiko Schocher		- more than one i2c adapter is usable
22693f4978c7SHeiko Schocher		- approved multibus support
22703f4978c7SHeiko Schocher		- better i2c mux support
22713f4978c7SHeiko Schocher
22723f4978c7SHeiko Schocher		** Please consider updating your I2C driver now. **
22733f4978c7SHeiko Schocher
2274ea818dbbSHeiko Schocher		These enable legacy I2C serial bus commands. Defining
2275ea818dbbSHeiko Schocher		CONFIG_HARD_I2C will include the appropriate I2C driver
2276ea818dbbSHeiko Schocher		for the selected CPU.
2277c609719bSwdenk
2278b37c7e5eSwdenk		This will allow you to use i2c commands at the u-boot
2279602ad3b3SJon Loeliger		command line (as long as you set CONFIG_CMD_I2C in
2280b37c7e5eSwdenk		CONFIG_COMMANDS) and communicate with i2c based realtime
2281b37c7e5eSwdenk		clock chips. See common/cmd_i2c.c for a description of the
2282c609719bSwdenk		command line interface.
2283c609719bSwdenk
2284bb99ad6dSBen Warren		CONFIG_HARD_I2C selects a hardware I2C controller.
2285c609719bSwdenk
2286b37c7e5eSwdenk		There are several other quantities that must also be
2287ea818dbbSHeiko Schocher		defined when you define CONFIG_HARD_I2C.
2288c609719bSwdenk
22896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		In both cases you will need to define CONFIG_SYS_I2C_SPEED
2290b37c7e5eSwdenk		to be the frequency (in Hz) at which you wish your i2c bus
22916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
229211ccc33fSMarcel Ziswiler		the CPU's i2c node address).
2293c609719bSwdenk
22948d321b81SPeter Tyser		Now, the u-boot i2c code for the mpc8xx
2295a47a12beSStefan Roese		(arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
22968d321b81SPeter Tyser		and so its address should therefore be cleared to 0 (See,
22978d321b81SPeter Tyser		eg, MPC823e User's Manual p.16-473). So, set
22988d321b81SPeter Tyser		CONFIG_SYS_I2C_SLAVE to 0.
2299b37c7e5eSwdenk
23005da71efaSEric Millbrandt		CONFIG_SYS_I2C_INIT_MPC5XXX
23015da71efaSEric Millbrandt
23025da71efaSEric Millbrandt		When a board is reset during an i2c bus transfer
23035da71efaSEric Millbrandt		chips might think that the current transfer is still
23045da71efaSEric Millbrandt		in progress.  Reset the slave devices by sending start
23055da71efaSEric Millbrandt		commands until the slave device responds.
23065da71efaSEric Millbrandt
2307b37c7e5eSwdenk		That's all that's required for CONFIG_HARD_I2C.
2308b37c7e5eSwdenk
2309ea818dbbSHeiko Schocher		If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
2310b37c7e5eSwdenk		then the following macros need to be defined (examples are
2311b37c7e5eSwdenk		from include/configs/lwmon.h):
2312c609719bSwdenk
2313c609719bSwdenk		I2C_INIT
2314c609719bSwdenk
2315b37c7e5eSwdenk		(Optional). Any commands necessary to enable the I2C
2316c609719bSwdenk		controller or configure ports.
2317c609719bSwdenk
2318b37c7e5eSwdenk		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
2319b37c7e5eSwdenk
2320c609719bSwdenk		I2C_PORT
2321c609719bSwdenk
2322c609719bSwdenk		(Only for MPC8260 CPU). The I/O port to use (the code
2323c609719bSwdenk		assumes both bits are on the same port). Valid values
2324c609719bSwdenk		are 0..3 for ports A..D.
2325c609719bSwdenk
2326c609719bSwdenk		I2C_ACTIVE
2327c609719bSwdenk
2328c609719bSwdenk		The code necessary to make the I2C data line active
2329c609719bSwdenk		(driven).  If the data line is open collector, this
2330c609719bSwdenk		define can be null.
2331c609719bSwdenk
2332b37c7e5eSwdenk		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
2333b37c7e5eSwdenk
2334c609719bSwdenk		I2C_TRISTATE
2335c609719bSwdenk
2336c609719bSwdenk		The code necessary to make the I2C data line tri-stated
2337c609719bSwdenk		(inactive).  If the data line is open collector, this
2338c609719bSwdenk		define can be null.
2339c609719bSwdenk
2340b37c7e5eSwdenk		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2341b37c7e5eSwdenk
2342c609719bSwdenk		I2C_READ
2343c609719bSwdenk
2344472d5460SYork Sun		Code that returns true if the I2C data line is high,
2345472d5460SYork Sun		false if it is low.
2346c609719bSwdenk
2347b37c7e5eSwdenk		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2348b37c7e5eSwdenk
2349c609719bSwdenk		I2C_SDA(bit)
2350c609719bSwdenk
2351472d5460SYork Sun		If <bit> is true, sets the I2C data line high. If it
2352472d5460SYork Sun		is false, it clears it (low).
2353c609719bSwdenk
2354b37c7e5eSwdenk		eg: #define I2C_SDA(bit) \
2355b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
2356b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
2357b37c7e5eSwdenk
2358c609719bSwdenk		I2C_SCL(bit)
2359c609719bSwdenk
2360472d5460SYork Sun		If <bit> is true, sets the I2C clock line high. If it
2361472d5460SYork Sun		is false, it clears it (low).
2362c609719bSwdenk
2363b37c7e5eSwdenk		eg: #define I2C_SCL(bit) \
2364b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
2365b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
2366b37c7e5eSwdenk
2367c609719bSwdenk		I2C_DELAY
2368c609719bSwdenk
2369c609719bSwdenk		This delay is invoked four times per clock cycle so this
2370c609719bSwdenk		controls the rate of data transfer.  The data rate thus
2371b37c7e5eSwdenk		is 1 / (I2C_DELAY * 4). Often defined to be something
2372b37c7e5eSwdenk		like:
2373b37c7e5eSwdenk
2374b37c7e5eSwdenk		#define I2C_DELAY  udelay(2)
2375c609719bSwdenk
2376793b5726SMike Frysinger		CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2377793b5726SMike Frysinger
2378793b5726SMike Frysinger		If your arch supports the generic GPIO framework (asm/gpio.h),
2379793b5726SMike Frysinger		then you may alternatively define the two GPIOs that are to be
2380793b5726SMike Frysinger		used as SCL / SDA.  Any of the previous I2C_xxx macros will
2381793b5726SMike Frysinger		have GPIO-based defaults assigned to them as appropriate.
2382793b5726SMike Frysinger
2383793b5726SMike Frysinger		You should define these to the GPIO value as given directly to
2384793b5726SMike Frysinger		the generic GPIO functions.
2385793b5726SMike Frysinger
23866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_INIT_BOARD
238747cd00faSwdenk
238847cd00faSwdenk		When a board is reset during an i2c bus transfer
238947cd00faSwdenk		chips might think that the current transfer is still
239047cd00faSwdenk		in progress. On some boards it is possible to access
239147cd00faSwdenk		the i2c SCLK line directly, either by using the
239247cd00faSwdenk		processor pin as a GPIO or by having a second pin
239347cd00faSwdenk		connected to the bus. If this option is defined a
239447cd00faSwdenk		custom i2c_init_board() routine in boards/xxx/board.c
239547cd00faSwdenk		is run early in the boot sequence.
239647cd00faSwdenk
239726a33504SRichard Retanubun		CONFIG_SYS_I2C_BOARD_LATE_INIT
239826a33504SRichard Retanubun
239926a33504SRichard Retanubun		An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
240026a33504SRichard Retanubun		defined a custom i2c_board_late_init() routine in
240126a33504SRichard Retanubun		boards/xxx/board.c is run AFTER the operations in i2c_init()
240226a33504SRichard Retanubun		is completed. This callpoint can be used to unreset i2c bus
240326a33504SRichard Retanubun		using CPU i2c controller register accesses for CPUs whose i2c
240426a33504SRichard Retanubun		controller provide such a method. It is called at the end of
240526a33504SRichard Retanubun		i2c_init() to allow i2c_init operations to setup the i2c bus
240626a33504SRichard Retanubun		controller on the CPU (e.g. setting bus speed & slave address).
240726a33504SRichard Retanubun
240817ea1177Swdenk		CONFIG_I2CFAST (PPC405GP|PPC405EP only)
240917ea1177Swdenk
241017ea1177Swdenk		This option enables configuration of bi_iic_fast[] flags
241117ea1177Swdenk		in u-boot bd_info structure based on u-boot environment
241217ea1177Swdenk		variable "i2cfast". (see also i2cfast)
241317ea1177Swdenk
2414bb99ad6dSBen Warren		CONFIG_I2C_MULTI_BUS
2415bb99ad6dSBen Warren
2416bb99ad6dSBen Warren		This option allows the use of multiple I2C buses, each of which
2417bb99ad6dSBen Warren		must have a controller.	 At any point in time, only one bus is
2418bb99ad6dSBen Warren		active.	 To switch to a different bus, use the 'i2c dev' command.
2419bb99ad6dSBen Warren		Note that bus numbering is zero-based.
2420bb99ad6dSBen Warren
24216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_NOPROBES
2422bb99ad6dSBen Warren
2423bb99ad6dSBen Warren		This option specifies a list of I2C devices that will be skipped
24240f89c54bSPeter Tyser		when the 'i2c probe' command is issued.	 If CONFIG_I2C_MULTI_BUS
24250f89c54bSPeter Tyser		is set, specify a list of bus-device pairs.  Otherwise, specify
24260f89c54bSPeter Tyser		a 1D array of device addresses
2427bb99ad6dSBen Warren
2428bb99ad6dSBen Warren		e.g.
2429bb99ad6dSBen Warren			#undef	CONFIG_I2C_MULTI_BUS
24306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
2431bb99ad6dSBen Warren
2432bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on a board with one I2C bus
2433bb99ad6dSBen Warren
2434bb99ad6dSBen Warren			#define CONFIG_I2C_MULTI_BUS
24356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_MULTI_NOPROBES	{{0,0x50},{0,0x68},{1,0x54}}
2436bb99ad6dSBen Warren
2437bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2438bb99ad6dSBen Warren
24396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SPD_BUS_NUM
2440be5e6181STimur Tabi
2441be5e6181STimur Tabi		If defined, then this indicates the I2C bus number for DDR SPD.
2442be5e6181STimur Tabi		If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2443be5e6181STimur Tabi
24446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_BUS_NUM
24450dc018ecSStefan Roese
24460dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the RTC.
24470dc018ecSStefan Roese		If not defined, then U-Boot assumes that RTC is on I2C bus 0.
24480dc018ecSStefan Roese
24496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_DTT_BUS_NUM
24500dc018ecSStefan Roese
24510dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the DTT.
24520dc018ecSStefan Roese		If not defined, then U-Boot assumes that DTT is on I2C bus 0.
24530dc018ecSStefan Roese
24546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_DTT_ADDR:
24559ebbb54fSVictor Gallardo
24569ebbb54fSVictor Gallardo		If defined, specifies the I2C address of the DTT device.
24579ebbb54fSVictor Gallardo		If not defined, then U-Boot uses predefined value for
24589ebbb54fSVictor Gallardo		specified DTT device.
24599ebbb54fSVictor Gallardo
24602ac6985aSAndrew Dyer		CONFIG_SOFT_I2C_READ_REPEATED_START
24612ac6985aSAndrew Dyer
24622ac6985aSAndrew Dyer		defining this will force the i2c_read() function in
24632ac6985aSAndrew Dyer		the soft_i2c driver to perform an I2C repeated start
24642ac6985aSAndrew Dyer		between writing the address pointer and reading the
24652ac6985aSAndrew Dyer		data.  If this define is omitted the default behaviour
24662ac6985aSAndrew Dyer		of doing a stop-start sequence will be used.  Most I2C
24672ac6985aSAndrew Dyer		devices can use either method, but some require one or
24682ac6985aSAndrew Dyer		the other.
2469be5e6181STimur Tabi
2470c609719bSwdenk- SPI Support:	CONFIG_SPI
2471c609719bSwdenk
2472c609719bSwdenk		Enables SPI driver (so far only tested with
2473c609719bSwdenk		SPI EEPROM, also an instance works with Crystal A/D and
2474c609719bSwdenk		D/As on the SACSng board)
2475c609719bSwdenk
24766639562eSYoshihiro Shimoda		CONFIG_SH_SPI
24776639562eSYoshihiro Shimoda
24786639562eSYoshihiro Shimoda		Enables the driver for SPI controller on SuperH. Currently
24796639562eSYoshihiro Shimoda		only SH7757 is supported.
24806639562eSYoshihiro Shimoda
2481c609719bSwdenk		CONFIG_SPI_X
2482c609719bSwdenk
2483c609719bSwdenk		Enables extended (16-bit) SPI EEPROM addressing.
2484c609719bSwdenk		(symmetrical to CONFIG_I2C_X)
2485c609719bSwdenk
2486c609719bSwdenk		CONFIG_SOFT_SPI
2487c609719bSwdenk
2488c609719bSwdenk		Enables a software (bit-bang) SPI driver rather than
2489c609719bSwdenk		using hardware support. This is a general purpose
2490c609719bSwdenk		driver that only requires three general I/O port pins
2491c609719bSwdenk		(two outputs, one input) to function. If this is
2492c609719bSwdenk		defined, the board configuration must define several
2493c609719bSwdenk		SPI configuration items (port pins to use, etc). For
2494c609719bSwdenk		an example, see include/configs/sacsng.h.
2495c609719bSwdenk
249604a9e118SBen Warren		CONFIG_HARD_SPI
249704a9e118SBen Warren
249804a9e118SBen Warren		Enables a hardware SPI driver for general-purpose reads
249904a9e118SBen Warren		and writes.  As with CONFIG_SOFT_SPI, the board configuration
250004a9e118SBen Warren		must define a list of chip-select function pointers.
250104a9e118SBen Warren		Currently supported on some MPC8xxx processors.	 For an
250204a9e118SBen Warren		example, see include/configs/mpc8349emds.h.
250304a9e118SBen Warren
250438254f45SGuennadi Liakhovetski		CONFIG_MXC_SPI
250538254f45SGuennadi Liakhovetski
250638254f45SGuennadi Liakhovetski		Enables the driver for the SPI controllers on i.MX and MXC
25072e3cd1cdSFabio Estevam		SoCs. Currently i.MX31/35/51 are supported.
250838254f45SGuennadi Liakhovetski
25090133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA
25100133502eSMatthias Fuchs
25110133502eSMatthias Fuchs		Enables FPGA subsystem.
25120133502eSMatthias Fuchs
25130133502eSMatthias Fuchs		CONFIG_FPGA_<vendor>
25140133502eSMatthias Fuchs
25150133502eSMatthias Fuchs		Enables support for specific chip vendors.
25160133502eSMatthias Fuchs		(ALTERA, XILINX)
25170133502eSMatthias Fuchs
25180133502eSMatthias Fuchs		CONFIG_FPGA_<family>
25190133502eSMatthias Fuchs
25200133502eSMatthias Fuchs		Enables support for FPGA family.
25210133502eSMatthias Fuchs		(SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
25220133502eSMatthias Fuchs
25230133502eSMatthias Fuchs		CONFIG_FPGA_COUNT
2524c609719bSwdenk
2525c609719bSwdenk		Specify the number of FPGA devices to support.
2526c609719bSwdenk
25276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_PROG_FEEDBACK
2528c609719bSwdenk
2529c609719bSwdenk		Enable printing of hash marks during FPGA configuration.
2530c609719bSwdenk
25316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_BUSY
2532c609719bSwdenk
2533c609719bSwdenk		Enable checks on FPGA configuration interface busy
2534c609719bSwdenk		status by the configuration function. This option
2535c609719bSwdenk		will require a board or device specific function to
2536c609719bSwdenk		be written.
2537c609719bSwdenk
2538c609719bSwdenk		CONFIG_FPGA_DELAY
2539c609719bSwdenk
2540c609719bSwdenk		If defined, a function that provides delays in the FPGA
2541c609719bSwdenk		configuration driver.
2542c609719bSwdenk
25436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_CTRLC
2544c609719bSwdenk		Allow Control-C to interrupt FPGA configuration
2545c609719bSwdenk
25466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_ERROR
2547c609719bSwdenk
2548c609719bSwdenk		Check for configuration errors during FPGA bitfile
2549c609719bSwdenk		loading. For example, abort during Virtex II
2550c609719bSwdenk		configuration if the INIT_B line goes low (which
2551c609719bSwdenk		indicated a CRC error).
2552c609719bSwdenk
25536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_INIT
2554c609719bSwdenk
2555c609719bSwdenk		Maximum time to wait for the INIT_B line to deassert
2556c609719bSwdenk		after PROB_B has been deasserted during a Virtex II
2557c609719bSwdenk		FPGA configuration sequence. The default time is 500
255811ccc33fSMarcel Ziswiler		ms.
2559c609719bSwdenk
25606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_BUSY
2561c609719bSwdenk
2562c609719bSwdenk		Maximum time to wait for BUSY to deassert during
256311ccc33fSMarcel Ziswiler		Virtex II FPGA configuration. The default is 5 ms.
2564c609719bSwdenk
25656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_CONFIG
2566c609719bSwdenk
2567c609719bSwdenk		Time to wait after FPGA configuration. The default is
256811ccc33fSMarcel Ziswiler		200 ms.
2569c609719bSwdenk
2570c609719bSwdenk- Configuration Management:
2571c609719bSwdenk		CONFIG_IDENT_STRING
2572c609719bSwdenk
2573c609719bSwdenk		If defined, this string will be added to the U-Boot
2574c609719bSwdenk		version information (U_BOOT_VERSION)
2575c609719bSwdenk
2576c609719bSwdenk- Vendor Parameter Protection:
2577c609719bSwdenk
2578c609719bSwdenk		U-Boot considers the values of the environment
2579c609719bSwdenk		variables "serial#" (Board Serial Number) and
25807152b1d0Swdenk		"ethaddr" (Ethernet Address) to be parameters that
2581c609719bSwdenk		are set once by the board vendor / manufacturer, and
2582c609719bSwdenk		protects these variables from casual modification by
2583c609719bSwdenk		the user. Once set, these variables are read-only,
2584c609719bSwdenk		and write or delete attempts are rejected. You can
258511ccc33fSMarcel Ziswiler		change this behaviour:
2586c609719bSwdenk
2587c609719bSwdenk		If CONFIG_ENV_OVERWRITE is #defined in your config
2588c609719bSwdenk		file, the write protection for vendor parameters is
258947cd00faSwdenk		completely disabled. Anybody can change or delete
2590c609719bSwdenk		these parameters.
2591c609719bSwdenk
2592c609719bSwdenk		Alternatively, if you #define _both_ CONFIG_ETHADDR
2593c609719bSwdenk		_and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
259411ccc33fSMarcel Ziswiler		Ethernet address is installed in the environment,
2595c609719bSwdenk		which can be changed exactly ONCE by the user. [The
2596c609719bSwdenk		serial# is unaffected by this, i. e. it remains
2597c609719bSwdenk		read-only.]
2598c609719bSwdenk
25992598090bSJoe Hershberger		The same can be accomplished in a more flexible way
26002598090bSJoe Hershberger		for any variable by configuring the type of access
26012598090bSJoe Hershberger		to allow for those variables in the ".flags" variable
26022598090bSJoe Hershberger		or define CONFIG_ENV_FLAGS_LIST_STATIC.
26032598090bSJoe Hershberger
2604c609719bSwdenk- Protected RAM:
2605c609719bSwdenk		CONFIG_PRAM
2606c609719bSwdenk
2607c609719bSwdenk		Define this variable to enable the reservation of
2608c609719bSwdenk		"protected RAM", i. e. RAM which is not overwritten
2609c609719bSwdenk		by U-Boot. Define CONFIG_PRAM to hold the number of
2610c609719bSwdenk		kB you want to reserve for pRAM. You can overwrite
2611c609719bSwdenk		this default value by defining an environment
2612c609719bSwdenk		variable "pram" to the number of kB you want to
2613c609719bSwdenk		reserve. Note that the board info structure will
2614c609719bSwdenk		still show the full amount of RAM. If pRAM is
2615c609719bSwdenk		reserved, a new environment variable "mem" will
2616c609719bSwdenk		automatically be defined to hold the amount of
2617c609719bSwdenk		remaining RAM in a form that can be passed as boot
2618c609719bSwdenk		argument to Linux, for instance like that:
2619c609719bSwdenk
2620fe126d8bSWolfgang Denk			setenv bootargs ... mem=\${mem}
2621c609719bSwdenk			saveenv
2622c609719bSwdenk
2623c609719bSwdenk		This way you can tell Linux not to use this memory,
2624c609719bSwdenk		either, which results in a memory region that will
2625c609719bSwdenk		not be affected by reboots.
2626c609719bSwdenk
2627c609719bSwdenk		*WARNING* If your board configuration uses automatic
2628c609719bSwdenk		detection of the RAM size, you must make sure that
2629c609719bSwdenk		this memory test is non-destructive. So far, the
2630c609719bSwdenk		following board configurations are known to be
2631c609719bSwdenk		"pRAM-clean":
2632c609719bSwdenk
26331b0757ecSWolfgang Denk			IVMS8, IVML24, SPD8xx, TQM8xxL,
26341b0757ecSWolfgang Denk			HERMES, IP860, RPXlite, LWMON,
2635544d97e9SWolfgang Denk			FLAGADM, TQM8260
2636c609719bSwdenk
263740fef049SGabe Black- Access to physical memory region (> 4GB)
263840fef049SGabe Black		Some basic support is provided for operations on memory not
263940fef049SGabe Black		normally accessible to U-Boot - e.g. some architectures
264040fef049SGabe Black		support access to more than 4GB of memory on 32-bit
264140fef049SGabe Black		machines using physical address extension or similar.
264240fef049SGabe Black		Define CONFIG_PHYSMEM to access this basic support, which
264340fef049SGabe Black		currently only supports clearing the memory.
264440fef049SGabe Black
2645c609719bSwdenk- Error Recovery:
2646c609719bSwdenk		CONFIG_PANIC_HANG
2647c609719bSwdenk
2648c609719bSwdenk		Define this variable to stop the system in case of a
2649c609719bSwdenk		fatal error, so that you have to reset it manually.
2650c609719bSwdenk		This is probably NOT a good idea for an embedded
265111ccc33fSMarcel Ziswiler		system where you want the system to reboot
2652c609719bSwdenk		automatically as fast as possible, but it may be
2653c609719bSwdenk		useful during development since you can try to debug
2654c609719bSwdenk		the conditions that lead to the situation.
2655c609719bSwdenk
2656c609719bSwdenk		CONFIG_NET_RETRY_COUNT
2657c609719bSwdenk
2658c609719bSwdenk		This variable defines the number of retries for
2659c609719bSwdenk		network operations like ARP, RARP, TFTP, or BOOTP
2660c609719bSwdenk		before giving up the operation. If not defined, a
2661c609719bSwdenk		default value of 5 is used.
2662c609719bSwdenk
266340cb90eeSGuennadi Liakhovetski		CONFIG_ARP_TIMEOUT
266440cb90eeSGuennadi Liakhovetski
266540cb90eeSGuennadi Liakhovetski		Timeout waiting for an ARP reply in milliseconds.
266640cb90eeSGuennadi Liakhovetski
266748a3e999STetsuyuki Kobayashi		CONFIG_NFS_TIMEOUT
266848a3e999STetsuyuki Kobayashi
266948a3e999STetsuyuki Kobayashi		Timeout in milliseconds used in NFS protocol.
267048a3e999STetsuyuki Kobayashi		If you encounter "ERROR: Cannot umount" in nfs command,
267148a3e999STetsuyuki Kobayashi		try longer timeout such as
267248a3e999STetsuyuki Kobayashi		#define CONFIG_NFS_TIMEOUT 10000UL
267348a3e999STetsuyuki Kobayashi
2674c609719bSwdenk- Command Interpreter:
26758078f1a5SWolfgang Denk		CONFIG_AUTO_COMPLETE
267604a85b3bSwdenk
267704a85b3bSwdenk		Enable auto completion of commands using TAB.
267804a85b3bSwdenk
26798078f1a5SWolfgang Denk		Note that this feature has NOT been implemented yet
26808078f1a5SWolfgang Denk		for the "hush" shell.
26818078f1a5SWolfgang Denk
26828078f1a5SWolfgang Denk
26836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_HUSH_PARSER
2684c609719bSwdenk
2685c609719bSwdenk		Define this variable to enable the "hush" shell (from
2686c609719bSwdenk		Busybox) as command line interpreter, thus enabling
2687c609719bSwdenk		powerful command line syntax like
2688c609719bSwdenk		if...then...else...fi conditionals or `&&' and '||'
2689c609719bSwdenk		constructs ("shell scripts").
2690c609719bSwdenk
2691c609719bSwdenk		If undefined, you get the old, much simpler behaviour
2692c609719bSwdenk		with a somewhat smaller memory footprint.
2693c609719bSwdenk
2694c609719bSwdenk
26956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_PROMPT_HUSH_PS2
2696c609719bSwdenk
2697c609719bSwdenk		This defines the secondary prompt string, which is
2698c609719bSwdenk		printed when the command interpreter needs more input
2699c609719bSwdenk		to complete a command. Usually "> ".
2700c609719bSwdenk
2701c609719bSwdenk	Note:
2702c609719bSwdenk
2703c609719bSwdenk		In the current implementation, the local variables
2704c609719bSwdenk		space and global environment variables space are
2705c609719bSwdenk		separated. Local variables are those you define by
27063b57fe0aSwdenk		simply typing `name=value'. To access a local
2707c609719bSwdenk		variable later on, you have write `$name' or
27083b57fe0aSwdenk		`${name}'; to execute the contents of a variable
27093b57fe0aSwdenk		directly type `$name' at the command prompt.
2710c609719bSwdenk
2711c609719bSwdenk		Global environment variables are those you use
2712c609719bSwdenk		setenv/printenv to work with. To run a command stored
2713c609719bSwdenk		in such a variable, you need to use the run command,
2714c609719bSwdenk		and you must not use the '$' sign to access them.
2715c609719bSwdenk
2716c609719bSwdenk		To store commands and special characters in a
2717c609719bSwdenk		variable, please use double quotation marks
2718c609719bSwdenk		surrounding the whole text of the variable, instead
2719c609719bSwdenk		of the backslashes before semicolons and special
2720c609719bSwdenk		symbols.
2721c609719bSwdenk
2722aa0c71acSWolfgang Denk- Commandline Editing and History:
2723aa0c71acSWolfgang Denk		CONFIG_CMDLINE_EDITING
2724aa0c71acSWolfgang Denk
272511ccc33fSMarcel Ziswiler		Enable editing and History functions for interactive
2726aa0c71acSWolfgang Denk		commandline input operations
2727aa0c71acSWolfgang Denk
2728a8c7c708Swdenk- Default Environment:
2729c609719bSwdenk		CONFIG_EXTRA_ENV_SETTINGS
2730c609719bSwdenk
2731c609719bSwdenk		Define this to contain any number of null terminated
2732c609719bSwdenk		strings (variable = value pairs) that will be part of
27337152b1d0Swdenk		the default environment compiled into the boot image.
27342262cfeeSwdenk
2735c609719bSwdenk		For example, place something like this in your
2736c609719bSwdenk		board's config file:
2737c609719bSwdenk
2738c609719bSwdenk		#define CONFIG_EXTRA_ENV_SETTINGS \
2739c609719bSwdenk			"myvar1=value1\0" \
2740c609719bSwdenk			"myvar2=value2\0"
2741c609719bSwdenk
2742c609719bSwdenk		Warning: This method is based on knowledge about the
2743c609719bSwdenk		internal format how the environment is stored by the
27442262cfeeSwdenk		U-Boot code. This is NOT an official, exported
2745c609719bSwdenk		interface! Although it is unlikely that this format
27467152b1d0Swdenk		will change soon, there is no guarantee either.
2747c609719bSwdenk		You better know what you are doing here.
2748c609719bSwdenk
2749c609719bSwdenk		Note: overly (ab)use of the default environment is
2750c609719bSwdenk		discouraged. Make sure to check other ways to preset
275174de7aefSWolfgang Denk		the environment like the "source" command or the
2752c609719bSwdenk		boot command first.
2753c609719bSwdenk
27545e724ca2SStephen Warren		CONFIG_ENV_VARS_UBOOT_CONFIG
27555e724ca2SStephen Warren
27565e724ca2SStephen Warren		Define this in order to add variables describing the
27575e724ca2SStephen Warren		U-Boot build configuration to the default environment.
27585e724ca2SStephen Warren		These will be named arch, cpu, board, vendor, and soc.
27595e724ca2SStephen Warren
27605e724ca2SStephen Warren		Enabling this option will cause the following to be defined:
27615e724ca2SStephen Warren
27625e724ca2SStephen Warren		- CONFIG_SYS_ARCH
27635e724ca2SStephen Warren		- CONFIG_SYS_CPU
27645e724ca2SStephen Warren		- CONFIG_SYS_BOARD
27655e724ca2SStephen Warren		- CONFIG_SYS_VENDOR
27665e724ca2SStephen Warren		- CONFIG_SYS_SOC
27675e724ca2SStephen Warren
27687e27f89fSTom Rini		CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
27697e27f89fSTom Rini
27707e27f89fSTom Rini		Define this in order to add variables describing certain
27717e27f89fSTom Rini		run-time determined information about the hardware to the
27727e27f89fSTom Rini		environment.  These will be named board_name, board_rev.
27737e27f89fSTom Rini
277406fd8538SSimon Glass		CONFIG_DELAY_ENVIRONMENT
277506fd8538SSimon Glass
277606fd8538SSimon Glass		Normally the environment is loaded when the board is
277706fd8538SSimon Glass		intialised so that it is available to U-Boot. This inhibits
277806fd8538SSimon Glass		that so that the environment is not available until
277906fd8538SSimon Glass		explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
278006fd8538SSimon Glass		this is instead controlled by the value of
278106fd8538SSimon Glass		/config/load-environment.
278206fd8538SSimon Glass
2783a8c7c708Swdenk- DataFlash Support:
27842abbe075Swdenk		CONFIG_HAS_DATAFLASH
27852abbe075Swdenk
27862abbe075Swdenk		Defining this option enables DataFlash features and
27872abbe075Swdenk		allows to read/write in Dataflash via the standard
27882abbe075Swdenk		commands cp, md...
27892abbe075Swdenk
2790f61ec45eSEric Nelson- Serial Flash support
2791f61ec45eSEric Nelson		CONFIG_CMD_SF
2792f61ec45eSEric Nelson
2793f61ec45eSEric Nelson		Defining this option enables SPI flash commands
2794f61ec45eSEric Nelson		'sf probe/read/write/erase/update'.
2795f61ec45eSEric Nelson
2796f61ec45eSEric Nelson		Usage requires an initial 'probe' to define the serial
2797f61ec45eSEric Nelson		flash parameters, followed by read/write/erase/update
2798f61ec45eSEric Nelson		commands.
2799f61ec45eSEric Nelson
2800f61ec45eSEric Nelson		The following defaults may be provided by the platform
2801f61ec45eSEric Nelson		to handle the common case when only a single serial
2802f61ec45eSEric Nelson		flash is present on the system.
2803f61ec45eSEric Nelson
2804f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_BUS		Bus identifier
2805f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_CS		Chip-select
2806f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_MODE 		(see include/spi.h)
2807f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_SPEED		in Hz
2808f61ec45eSEric Nelson
280924007273SSimon Glass		CONFIG_CMD_SF_TEST
281024007273SSimon Glass
281124007273SSimon Glass		Define this option to include a destructive SPI flash
281224007273SSimon Glass		test ('sf test').
281324007273SSimon Glass
28141dcd6d03SJagannadha Sutradharudu Teki		CONFIG_SPI_FLASH_BAR		Ban/Extended Addr Reg
28151dcd6d03SJagannadha Sutradharudu Teki
28161dcd6d03SJagannadha Sutradharudu Teki		Define this option to use the Bank addr/Extended addr
28171dcd6d03SJagannadha Sutradharudu Teki		support on SPI flashes which has size > 16Mbytes.
28181dcd6d03SJagannadha Sutradharudu Teki
2819b902e07cSJagannadha Sutradharudu Teki		CONFIG_SF_DUAL_FLASH		Dual flash memories
2820b902e07cSJagannadha Sutradharudu Teki
2821b902e07cSJagannadha Sutradharudu Teki		Define this option to use dual flash support where two flash
2822b902e07cSJagannadha Sutradharudu Teki		memories can be connected with a given cs line.
2823b902e07cSJagannadha Sutradharudu Teki		currently Xilinx Zynq qspi support these type of connections.
2824b902e07cSJagannadha Sutradharudu Teki
28253f85ce27Swdenk- SystemACE Support:
28263f85ce27Swdenk		CONFIG_SYSTEMACE
28273f85ce27Swdenk
28283f85ce27Swdenk		Adding this option adds support for Xilinx SystemACE
28293f85ce27Swdenk		chips attached via some sort of local bus. The address
283011ccc33fSMarcel Ziswiler		of the chip must also be defined in the
28316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SYSTEMACE_BASE macro. For example:
28323f85ce27Swdenk
28333f85ce27Swdenk		#define CONFIG_SYSTEMACE
28346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
28353f85ce27Swdenk
28363f85ce27Swdenk		When SystemACE support is added, the "ace" device type
28373f85ce27Swdenk		becomes available to the fat commands, i.e. fatls.
28383f85ce27Swdenk
2839ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port:
2840ecb0ccd9SWolfgang Denk		CONFIG_TFTP_PORT
2841ecb0ccd9SWolfgang Denk
284228cb9375SWolfgang Denk		If this is defined, the environment variable tftpsrcp
2843ecb0ccd9SWolfgang Denk		is used to supply the TFTP UDP source port value.
284428cb9375SWolfgang Denk		If tftpsrcp isn't defined, the normal pseudo-random port
2845ecb0ccd9SWolfgang Denk		number generator is used.
2846ecb0ccd9SWolfgang Denk
284728cb9375SWolfgang Denk		Also, the environment variable tftpdstp is used to supply
284828cb9375SWolfgang Denk		the TFTP UDP destination port value.  If tftpdstp isn't
284928cb9375SWolfgang Denk		defined, the normal port 69 is used.
285028cb9375SWolfgang Denk
285128cb9375SWolfgang Denk		The purpose for tftpsrcp is to allow a TFTP server to
2852ecb0ccd9SWolfgang Denk		blindly start the TFTP transfer using the pre-configured
2853ecb0ccd9SWolfgang Denk		target IP address and UDP port. This has the effect of
2854ecb0ccd9SWolfgang Denk		"punching through" the (Windows XP) firewall, allowing
2855ecb0ccd9SWolfgang Denk		the remainder of the TFTP transfer to proceed normally.
2856ecb0ccd9SWolfgang Denk		A better solution is to properly configure the firewall,
2857ecb0ccd9SWolfgang Denk		but sometimes that is not allowed.
2858ecb0ccd9SWolfgang Denk
2859bf36c5d5SSimon Glass- Hashing support:
2860bf36c5d5SSimon Glass		CONFIG_CMD_HASH
2861bf36c5d5SSimon Glass
2862bf36c5d5SSimon Glass		This enables a generic 'hash' command which can produce
2863bf36c5d5SSimon Glass		hashes / digests from a few algorithms (e.g. SHA1, SHA256).
2864bf36c5d5SSimon Glass
2865bf36c5d5SSimon Glass		CONFIG_HASH_VERIFY
2866bf36c5d5SSimon Glass
2867bf36c5d5SSimon Glass		Enable the hash verify command (hash -v). This adds to code
2868bf36c5d5SSimon Glass		size a little.
2869bf36c5d5SSimon Glass
2870bf36c5d5SSimon Glass		CONFIG_SHA1 - support SHA1 hashing
2871bf36c5d5SSimon Glass		CONFIG_SHA256 - support SHA256 hashing
2872bf36c5d5SSimon Glass
2873bf36c5d5SSimon Glass		Note: There is also a sha1sum command, which should perhaps
2874bf36c5d5SSimon Glass		be deprecated in favour of 'hash sha1'.
2875bf36c5d5SSimon Glass
2876a11f1873SRobert Winkler- Freescale i.MX specific commands:
2877a11f1873SRobert Winkler		CONFIG_CMD_HDMIDETECT
2878a11f1873SRobert Winkler		This enables 'hdmidet' command which returns true if an
2879a11f1873SRobert Winkler		HDMI monitor is detected.  This command is i.MX 6 specific.
2880a11f1873SRobert Winkler
2881a11f1873SRobert Winkler		CONFIG_CMD_BMODE
2882a11f1873SRobert Winkler		This enables the 'bmode' (bootmode) command for forcing
2883a11f1873SRobert Winkler		a boot from specific media.
2884a11f1873SRobert Winkler
2885a11f1873SRobert Winkler		This is useful for forcing the ROM's usb downloader to
2886a11f1873SRobert Winkler		activate upon a watchdog reset which is nice when iterating
2887a11f1873SRobert Winkler		on U-Boot.  Using the reset button or running bmode normal
2888a11f1873SRobert Winkler		will set it back to normal.  This command currently
2889a11f1873SRobert Winkler		supports i.MX53 and i.MX6.
2890a11f1873SRobert Winkler
289119c402afSSimon Glass- Signing support:
289219c402afSSimon Glass		CONFIG_RSA
289319c402afSSimon Glass
289419c402afSSimon Glass		This enables the RSA algorithm used for FIT image verification
28958bf2aad7SDetlev Zundel		in U-Boot. See doc/uImage.FIT/signature.txt for more information.
289619c402afSSimon Glass
289719c402afSSimon Glass		The signing part is build into mkimage regardless of this
289819c402afSSimon Glass		option.
289919c402afSSimon Glass
29009e50c406SHeiko Schocher- bootcount support:
29019e50c406SHeiko Schocher		CONFIG_BOOTCOUNT_LIMIT
29029e50c406SHeiko Schocher
29039e50c406SHeiko Schocher		This enables the bootcounter support, see:
29049e50c406SHeiko Schocher		http://www.denx.de/wiki/DULG/UBootBootCountLimit
29059e50c406SHeiko Schocher
29069e50c406SHeiko Schocher		CONFIG_AT91SAM9XE
29079e50c406SHeiko Schocher		enable special bootcounter support on at91sam9xe based boards.
29089e50c406SHeiko Schocher		CONFIG_BLACKFIN
29099e50c406SHeiko Schocher		enable special bootcounter support on blackfin based boards.
29109e50c406SHeiko Schocher		CONFIG_SOC_DA8XX
29119e50c406SHeiko Schocher		enable special bootcounter support on da850 based boards.
29129e50c406SHeiko Schocher		CONFIG_BOOTCOUNT_RAM
29139e50c406SHeiko Schocher		enable support for the bootcounter in RAM
29149e50c406SHeiko Schocher		CONFIG_BOOTCOUNT_I2C
29159e50c406SHeiko Schocher		enable support for the bootcounter on an i2c (like RTC) device.
29169e50c406SHeiko Schocher			CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
29179e50c406SHeiko Schocher			CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
29189e50c406SHeiko Schocher						    the bootcounter.
29199e50c406SHeiko Schocher			CONFIG_BOOTCOUNT_ALEN = address len
292019c402afSSimon Glass
2921a8c7c708Swdenk- Show boot progress:
2922c609719bSwdenk		CONFIG_SHOW_BOOT_PROGRESS
2923c609719bSwdenk
2924c609719bSwdenk		Defining this option allows to add some board-
2925c609719bSwdenk		specific code (calling a user-provided function
2926c609719bSwdenk		"show_boot_progress(int)") that enables you to show
2927c609719bSwdenk		the system's boot progress on some display (for
2928c609719bSwdenk		example, some LED's) on your board. At the moment,
2929c609719bSwdenk		the following checkpoints are implemented:
2930c609719bSwdenk
29313a608ca0SSimon Glass- Detailed boot stage timing
29323a608ca0SSimon Glass		CONFIG_BOOTSTAGE
29333a608ca0SSimon Glass		Define this option to get detailed timing of each stage
29343a608ca0SSimon Glass		of the boot process.
29353a608ca0SSimon Glass
29363a608ca0SSimon Glass		CONFIG_BOOTSTAGE_USER_COUNT
29373a608ca0SSimon Glass		This is the number of available user bootstage records.
29383a608ca0SSimon Glass		Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
29393a608ca0SSimon Glass		a new ID will be allocated from this stash. If you exceed
29403a608ca0SSimon Glass		the limit, recording will stop.
29413a608ca0SSimon Glass
29423a608ca0SSimon Glass		CONFIG_BOOTSTAGE_REPORT
29433a608ca0SSimon Glass		Define this to print a report before boot, similar to this:
29443a608ca0SSimon Glass
29453a608ca0SSimon Glass		Timer summary in microseconds:
29463a608ca0SSimon Glass		       Mark    Elapsed  Stage
29473a608ca0SSimon Glass			  0          0  reset
29483a608ca0SSimon Glass		  3,575,678  3,575,678  board_init_f start
29493a608ca0SSimon Glass		  3,575,695         17  arch_cpu_init A9
29503a608ca0SSimon Glass		  3,575,777         82  arch_cpu_init done
29513a608ca0SSimon Glass		  3,659,598     83,821  board_init_r start
29523a608ca0SSimon Glass		  3,910,375    250,777  main_loop
29533a608ca0SSimon Glass		 29,916,167 26,005,792  bootm_start
29543a608ca0SSimon Glass		 30,361,327    445,160  start_kernel
29553a608ca0SSimon Glass
29562eba38cfSSimon Glass		CONFIG_CMD_BOOTSTAGE
29572eba38cfSSimon Glass		Add a 'bootstage' command which supports printing a report
29582eba38cfSSimon Glass		and un/stashing of bootstage data.
29592eba38cfSSimon Glass
296094fd1316SSimon Glass		CONFIG_BOOTSTAGE_FDT
296194fd1316SSimon Glass		Stash the bootstage information in the FDT. A root 'bootstage'
296294fd1316SSimon Glass		node is created with each bootstage id as a child. Each child
296394fd1316SSimon Glass		has a 'name' property and either 'mark' containing the
296494fd1316SSimon Glass		mark time in microsecond, or 'accum' containing the
296594fd1316SSimon Glass		accumulated time for that bootstage id in microseconds.
296694fd1316SSimon Glass		For example:
296794fd1316SSimon Glass
296894fd1316SSimon Glass		bootstage {
296994fd1316SSimon Glass			154 {
297094fd1316SSimon Glass				name = "board_init_f";
297194fd1316SSimon Glass				mark = <3575678>;
297294fd1316SSimon Glass			};
297394fd1316SSimon Glass			170 {
297494fd1316SSimon Glass				name = "lcd";
297594fd1316SSimon Glass				accum = <33482>;
297694fd1316SSimon Glass			};
297794fd1316SSimon Glass		};
297894fd1316SSimon Glass
297994fd1316SSimon Glass		Code in the Linux kernel can find this in /proc/devicetree.
298094fd1316SSimon Glass
29811372cce2SMarian BalakowiczLegacy uImage format:
29821372cce2SMarian Balakowicz
2983c609719bSwdenk  Arg	Where			When
2984c609719bSwdenk    1	common/cmd_bootm.c	before attempting to boot an image
2985c609719bSwdenk   -1	common/cmd_bootm.c	Image header has bad	 magic number
2986c609719bSwdenk    2	common/cmd_bootm.c	Image header has correct magic number
2987c609719bSwdenk   -2	common/cmd_bootm.c	Image header has bad	 checksum
2988c609719bSwdenk    3	common/cmd_bootm.c	Image header has correct checksum
2989c609719bSwdenk   -3	common/cmd_bootm.c	Image data   has bad	 checksum
2990c609719bSwdenk    4	common/cmd_bootm.c	Image data   has correct checksum
2991c609719bSwdenk   -4	common/cmd_bootm.c	Image is for unsupported architecture
2992c609719bSwdenk    5	common/cmd_bootm.c	Architecture check OK
29931372cce2SMarian Balakowicz   -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi)
2994c609719bSwdenk    6	common/cmd_bootm.c	Image Type check OK
2995c609719bSwdenk   -6	common/cmd_bootm.c	gunzip uncompression error
2996c609719bSwdenk   -7	common/cmd_bootm.c	Unimplemented compression type
2997c609719bSwdenk    7	common/cmd_bootm.c	Uncompression OK
29981372cce2SMarian Balakowicz    8	common/cmd_bootm.c	No uncompress/copy overwrite error
2999c609719bSwdenk   -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
30001372cce2SMarian Balakowicz
30011372cce2SMarian Balakowicz    9	common/image.c		Start initial ramdisk verification
30021372cce2SMarian Balakowicz  -10	common/image.c		Ramdisk header has bad	   magic number
30031372cce2SMarian Balakowicz  -11	common/image.c		Ramdisk header has bad	   checksum
30041372cce2SMarian Balakowicz   10	common/image.c		Ramdisk header is OK
30051372cce2SMarian Balakowicz  -12	common/image.c		Ramdisk data   has bad	   checksum
30061372cce2SMarian Balakowicz   11	common/image.c		Ramdisk data   has correct checksum
30071372cce2SMarian Balakowicz   12	common/image.c		Ramdisk verification complete, start loading
300811ccc33fSMarcel Ziswiler  -13	common/image.c		Wrong Image Type (not PPC Linux ramdisk)
30091372cce2SMarian Balakowicz   13	common/image.c		Start multifile image verification
30101372cce2SMarian Balakowicz   14	common/image.c		No initial ramdisk, no multifile, continue.
30111372cce2SMarian Balakowicz
3012ea0364f1SPeter Tyser   15	arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
3013c609719bSwdenk
3014a47a12beSStefan Roese  -30	arch/powerpc/lib/board.c	Fatal error, hang the system
301563e73c9aSwdenk  -31	post/post.c		POST test failed, detected by post_output_backlog()
301663e73c9aSwdenk  -32	post/post.c		POST test failed, detected by post_run_single()
301763e73c9aSwdenk
3018566a494fSHeiko Schocher   34	common/cmd_doc.c	before loading a Image from a DOC device
3019566a494fSHeiko Schocher  -35	common/cmd_doc.c	Bad usage of "doc" command
3020566a494fSHeiko Schocher   35	common/cmd_doc.c	correct usage of "doc" command
3021566a494fSHeiko Schocher  -36	common/cmd_doc.c	No boot device
3022566a494fSHeiko Schocher   36	common/cmd_doc.c	correct boot device
3023566a494fSHeiko Schocher  -37	common/cmd_doc.c	Unknown Chip ID on boot device
3024566a494fSHeiko Schocher   37	common/cmd_doc.c	correct chip ID found, device available
3025566a494fSHeiko Schocher  -38	common/cmd_doc.c	Read Error on boot device
3026566a494fSHeiko Schocher   38	common/cmd_doc.c	reading Image header from DOC device OK
3027566a494fSHeiko Schocher  -39	common/cmd_doc.c	Image header has bad magic number
3028566a494fSHeiko Schocher   39	common/cmd_doc.c	Image header has correct magic number
3029566a494fSHeiko Schocher  -40	common/cmd_doc.c	Error reading Image from DOC device
3030566a494fSHeiko Schocher   40	common/cmd_doc.c	Image header has correct magic number
3031566a494fSHeiko Schocher   41	common/cmd_ide.c	before loading a Image from a IDE device
3032566a494fSHeiko Schocher  -42	common/cmd_ide.c	Bad usage of "ide" command
3033566a494fSHeiko Schocher   42	common/cmd_ide.c	correct usage of "ide" command
3034566a494fSHeiko Schocher  -43	common/cmd_ide.c	No boot device
3035566a494fSHeiko Schocher   43	common/cmd_ide.c	boot device found
3036566a494fSHeiko Schocher  -44	common/cmd_ide.c	Device not available
3037566a494fSHeiko Schocher   44	common/cmd_ide.c	Device available
3038566a494fSHeiko Schocher  -45	common/cmd_ide.c	wrong partition selected
3039566a494fSHeiko Schocher   45	common/cmd_ide.c	partition selected
3040566a494fSHeiko Schocher  -46	common/cmd_ide.c	Unknown partition table
3041566a494fSHeiko Schocher   46	common/cmd_ide.c	valid partition table found
3042566a494fSHeiko Schocher  -47	common/cmd_ide.c	Invalid partition type
3043566a494fSHeiko Schocher   47	common/cmd_ide.c	correct partition type
3044566a494fSHeiko Schocher  -48	common/cmd_ide.c	Error reading Image Header on boot device
3045566a494fSHeiko Schocher   48	common/cmd_ide.c	reading Image Header from IDE device OK
3046566a494fSHeiko Schocher  -49	common/cmd_ide.c	Image header has bad magic number
3047566a494fSHeiko Schocher   49	common/cmd_ide.c	Image header has correct magic number
3048566a494fSHeiko Schocher  -50	common/cmd_ide.c	Image header has bad	 checksum
3049566a494fSHeiko Schocher   50	common/cmd_ide.c	Image header has correct checksum
3050566a494fSHeiko Schocher  -51	common/cmd_ide.c	Error reading Image from IDE device
3051566a494fSHeiko Schocher   51	common/cmd_ide.c	reading Image from IDE device OK
3052566a494fSHeiko Schocher   52	common/cmd_nand.c	before loading a Image from a NAND device
3053566a494fSHeiko Schocher  -53	common/cmd_nand.c	Bad usage of "nand" command
3054566a494fSHeiko Schocher   53	common/cmd_nand.c	correct usage of "nand" command
3055566a494fSHeiko Schocher  -54	common/cmd_nand.c	No boot device
3056566a494fSHeiko Schocher   54	common/cmd_nand.c	boot device found
3057566a494fSHeiko Schocher  -55	common/cmd_nand.c	Unknown Chip ID on boot device
3058566a494fSHeiko Schocher   55	common/cmd_nand.c	correct chip ID found, device available
3059566a494fSHeiko Schocher  -56	common/cmd_nand.c	Error reading Image Header on boot device
3060566a494fSHeiko Schocher   56	common/cmd_nand.c	reading Image Header from NAND device OK
3061566a494fSHeiko Schocher  -57	common/cmd_nand.c	Image header has bad magic number
3062566a494fSHeiko Schocher   57	common/cmd_nand.c	Image header has correct magic number
3063566a494fSHeiko Schocher  -58	common/cmd_nand.c	Error reading Image from NAND device
3064566a494fSHeiko Schocher   58	common/cmd_nand.c	reading Image from NAND device OK
3065c609719bSwdenk
3066566a494fSHeiko Schocher  -60	common/env_common.c	Environment has a bad CRC, using default
3067c609719bSwdenk
3068566a494fSHeiko Schocher   64	net/eth.c		starting with Ethernet configuration.
3069566a494fSHeiko Schocher  -64	net/eth.c		no Ethernet found.
3070566a494fSHeiko Schocher   65	net/eth.c		Ethernet found.
3071206c60cbSwdenk
3072566a494fSHeiko Schocher  -80	common/cmd_net.c	usage wrong
3073566a494fSHeiko Schocher   80	common/cmd_net.c	before calling NetLoop()
307411ccc33fSMarcel Ziswiler  -81	common/cmd_net.c	some error in NetLoop() occurred
3075566a494fSHeiko Schocher   81	common/cmd_net.c	NetLoop() back without error
3076566a494fSHeiko Schocher  -82	common/cmd_net.c	size == 0 (File with size 0 loaded)
3077566a494fSHeiko Schocher   82	common/cmd_net.c	trying automatic boot
307874de7aefSWolfgang Denk   83	common/cmd_net.c	running "source" command
307974de7aefSWolfgang Denk  -83	common/cmd_net.c	some error in automatic boot or "source" command
3080566a494fSHeiko Schocher   84	common/cmd_net.c	end without errors
3081c609719bSwdenk
30821372cce2SMarian BalakowiczFIT uImage format:
30831372cce2SMarian Balakowicz
30841372cce2SMarian Balakowicz  Arg	Where			When
30851372cce2SMarian Balakowicz  100	common/cmd_bootm.c	Kernel FIT Image has correct format
30861372cce2SMarian Balakowicz -100	common/cmd_bootm.c	Kernel FIT Image has incorrect format
30871372cce2SMarian Balakowicz  101	common/cmd_bootm.c	No Kernel subimage unit name, using configuration
30881372cce2SMarian Balakowicz -101	common/cmd_bootm.c	Can't get configuration for kernel subimage
30891372cce2SMarian Balakowicz  102	common/cmd_bootm.c	Kernel unit name specified
30901372cce2SMarian Balakowicz -103	common/cmd_bootm.c	Can't get kernel subimage node offset
3091f773bea8SMarian Balakowicz  103	common/cmd_bootm.c	Found configuration node
30921372cce2SMarian Balakowicz  104	common/cmd_bootm.c	Got kernel subimage node offset
30931372cce2SMarian Balakowicz -104	common/cmd_bootm.c	Kernel subimage hash verification failed
30941372cce2SMarian Balakowicz  105	common/cmd_bootm.c	Kernel subimage hash verification OK
30951372cce2SMarian Balakowicz -105	common/cmd_bootm.c	Kernel subimage is for unsupported architecture
30961372cce2SMarian Balakowicz  106	common/cmd_bootm.c	Architecture check OK
309711ccc33fSMarcel Ziswiler -106	common/cmd_bootm.c	Kernel subimage has wrong type
309811ccc33fSMarcel Ziswiler  107	common/cmd_bootm.c	Kernel subimage type OK
30991372cce2SMarian Balakowicz -107	common/cmd_bootm.c	Can't get kernel subimage data/size
31001372cce2SMarian Balakowicz  108	common/cmd_bootm.c	Got kernel subimage data/size
31011372cce2SMarian Balakowicz -108	common/cmd_bootm.c	Wrong image type (not legacy, FIT)
31021372cce2SMarian Balakowicz -109	common/cmd_bootm.c	Can't get kernel subimage type
31031372cce2SMarian Balakowicz -110	common/cmd_bootm.c	Can't get kernel subimage comp
31041372cce2SMarian Balakowicz -111	common/cmd_bootm.c	Can't get kernel subimage os
31051372cce2SMarian Balakowicz -112	common/cmd_bootm.c	Can't get kernel subimage load address
31061372cce2SMarian Balakowicz -113	common/cmd_bootm.c	Image uncompress/copy overwrite error
31071372cce2SMarian Balakowicz
31081372cce2SMarian Balakowicz  120	common/image.c		Start initial ramdisk verification
31091372cce2SMarian Balakowicz -120	common/image.c		Ramdisk FIT image has incorrect format
31101372cce2SMarian Balakowicz  121	common/image.c		Ramdisk FIT image has correct format
311111ccc33fSMarcel Ziswiler  122	common/image.c		No ramdisk subimage unit name, using configuration
31121372cce2SMarian Balakowicz -122	common/image.c		Can't get configuration for ramdisk subimage
31131372cce2SMarian Balakowicz  123	common/image.c		Ramdisk unit name specified
31141372cce2SMarian Balakowicz -124	common/image.c		Can't get ramdisk subimage node offset
31151372cce2SMarian Balakowicz  125	common/image.c		Got ramdisk subimage node offset
31161372cce2SMarian Balakowicz -125	common/image.c		Ramdisk subimage hash verification failed
31171372cce2SMarian Balakowicz  126	common/image.c		Ramdisk subimage hash verification OK
31181372cce2SMarian Balakowicz -126	common/image.c		Ramdisk subimage for unsupported architecture
31191372cce2SMarian Balakowicz  127	common/image.c		Architecture check OK
31201372cce2SMarian Balakowicz -127	common/image.c		Can't get ramdisk subimage data/size
31211372cce2SMarian Balakowicz  128	common/image.c		Got ramdisk subimage data/size
31221372cce2SMarian Balakowicz  129	common/image.c		Can't get ramdisk load address
31231372cce2SMarian Balakowicz -129	common/image.c		Got ramdisk load address
31241372cce2SMarian Balakowicz
312511ccc33fSMarcel Ziswiler -130	common/cmd_doc.c	Incorrect FIT image format
31261372cce2SMarian Balakowicz  131	common/cmd_doc.c	FIT image format OK
31271372cce2SMarian Balakowicz
312811ccc33fSMarcel Ziswiler -140	common/cmd_ide.c	Incorrect FIT image format
31291372cce2SMarian Balakowicz  141	common/cmd_ide.c	FIT image format OK
31301372cce2SMarian Balakowicz
313111ccc33fSMarcel Ziswiler -150	common/cmd_nand.c	Incorrect FIT image format
31321372cce2SMarian Balakowicz  151	common/cmd_nand.c	FIT image format OK
31331372cce2SMarian Balakowicz
3134d95f6ec7SGabe Black- FIT image support:
3135d95f6ec7SGabe Black		CONFIG_FIT
3136d95f6ec7SGabe Black		Enable support for the FIT uImage format.
3137d95f6ec7SGabe Black
3138d95f6ec7SGabe Black		CONFIG_FIT_BEST_MATCH
3139d95f6ec7SGabe Black		When no configuration is explicitly selected, default to the
3140d95f6ec7SGabe Black		one whose fdt's compatibility field best matches that of
3141d95f6ec7SGabe Black		U-Boot itself. A match is considered "best" if it matches the
3142d95f6ec7SGabe Black		most specific compatibility entry of U-Boot's fdt's root node.
3143d95f6ec7SGabe Black		The order of entries in the configuration's fdt is ignored.
3144d95f6ec7SGabe Black
31453e569a6bSSimon Glass		CONFIG_FIT_SIGNATURE
31463e569a6bSSimon Glass		This option enables signature verification of FIT uImages,
31473e569a6bSSimon Glass		using a hash signed and verified using RSA. See
31483e569a6bSSimon Glass		doc/uImage.FIT/signature.txt for more details.
31493e569a6bSSimon Glass
31504cf2609bSWolfgang Denk- Standalone program support:
31514cf2609bSWolfgang Denk		CONFIG_STANDALONE_LOAD_ADDR
31524cf2609bSWolfgang Denk
31536feff899SWolfgang Denk		This option defines a board specific value for the
31546feff899SWolfgang Denk		address where standalone program gets loaded, thus
31556feff899SWolfgang Denk		overwriting the architecture dependent default
31564cf2609bSWolfgang Denk		settings.
31574cf2609bSWolfgang Denk
31584cf2609bSWolfgang Denk- Frame Buffer Address:
31594cf2609bSWolfgang Denk		CONFIG_FB_ADDR
31604cf2609bSWolfgang Denk
31614cf2609bSWolfgang Denk		Define CONFIG_FB_ADDR if you want to use specific
316244a53b57SWolfgang Denk		address for frame buffer.  This is typically the case
316344a53b57SWolfgang Denk		when using a graphics controller has separate video
316444a53b57SWolfgang Denk		memory.  U-Boot will then place the frame buffer at
316544a53b57SWolfgang Denk		the given address instead of dynamically reserving it
316644a53b57SWolfgang Denk		in system RAM by calling lcd_setmem(), which grabs
316744a53b57SWolfgang Denk		the memory for the frame buffer depending on the
316844a53b57SWolfgang Denk		configured panel size.
31694cf2609bSWolfgang Denk
31704cf2609bSWolfgang Denk		Please see board_init_f function.
31714cf2609bSWolfgang Denk
3172cccfc2abSDetlev Zundel- Automatic software updates via TFTP server
3173cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP
3174cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_CNT_MAX
3175cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_MSEC_MAX
3176cccfc2abSDetlev Zundel
3177cccfc2abSDetlev Zundel		These options enable and control the auto-update feature;
3178cccfc2abSDetlev Zundel		for a more detailed description refer to doc/README.update.
3179cccfc2abSDetlev Zundel
3180cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support)
3181cccfc2abSDetlev Zundel		CONFIG_MTD_DEVICE
3182cccfc2abSDetlev Zundel
3183cccfc2abSDetlev Zundel		Adds the MTD device infrastructure from the Linux kernel.
3184cccfc2abSDetlev Zundel		Needed for mtdparts command support.
3185cccfc2abSDetlev Zundel
3186cccfc2abSDetlev Zundel		CONFIG_MTD_PARTITIONS
3187cccfc2abSDetlev Zundel
3188cccfc2abSDetlev Zundel		Adds the MTD partitioning infrastructure from the Linux
3189cccfc2abSDetlev Zundel		kernel. Needed for UBI support.
3190cccfc2abSDetlev Zundel
319170c219cdSJoe Hershberger- UBI support
319270c219cdSJoe Hershberger		CONFIG_CMD_UBI
319370c219cdSJoe Hershberger
319470c219cdSJoe Hershberger		Adds commands for interacting with MTD partitions formatted
319570c219cdSJoe Hershberger		with the UBI flash translation layer
319670c219cdSJoe Hershberger
319770c219cdSJoe Hershberger		Requires also defining CONFIG_RBTREE
319870c219cdSJoe Hershberger
3199147162daSJoe Hershberger		CONFIG_UBI_SILENCE_MSG
3200147162daSJoe Hershberger
3201147162daSJoe Hershberger		Make the verbose messages from UBI stop printing.  This leaves
3202147162daSJoe Hershberger		warnings and errors enabled.
3203147162daSJoe Hershberger
320470c219cdSJoe Hershberger- UBIFS support
320570c219cdSJoe Hershberger		CONFIG_CMD_UBIFS
320670c219cdSJoe Hershberger
320770c219cdSJoe Hershberger		Adds commands for interacting with UBI volumes formatted as
320870c219cdSJoe Hershberger		UBIFS.  UBIFS is read-only in u-boot.
320970c219cdSJoe Hershberger
321070c219cdSJoe Hershberger		Requires UBI support as well as CONFIG_LZO
321170c219cdSJoe Hershberger
3212147162daSJoe Hershberger		CONFIG_UBIFS_SILENCE_MSG
3213147162daSJoe Hershberger
3214147162daSJoe Hershberger		Make the verbose messages from UBIFS stop printing.  This leaves
3215147162daSJoe Hershberger		warnings and errors enabled.
3216147162daSJoe Hershberger
32176a11cf48SDaniel Schwierzeck- SPL framework
32186a11cf48SDaniel Schwierzeck		CONFIG_SPL
32196a11cf48SDaniel Schwierzeck		Enable building of SPL globally.
32206a11cf48SDaniel Schwierzeck
322195579793STom Rini		CONFIG_SPL_LDSCRIPT
322295579793STom Rini		LDSCRIPT for linking the SPL binary.
322395579793STom Rini
32246ebc3461SAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT
32256ebc3461SAlbert ARIBAUD		Maximum size in memory allocated to the SPL, BSS included.
32266ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual memory
32276ebc3461SAlbert ARIBAUD		used by SPL from _start to __bss_end does not exceed it.
32288960af8bSAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
32296ebc3461SAlbert ARIBAUD		must not be both defined at the same time.
32306ebc3461SAlbert ARIBAUD
323195579793STom Rini		CONFIG_SPL_MAX_SIZE
32326ebc3461SAlbert ARIBAUD		Maximum size of the SPL image (text, data, rodata, and
32336ebc3461SAlbert ARIBAUD		linker lists sections), BSS excluded.
32346ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual size does
32356ebc3461SAlbert ARIBAUD		not exceed it.
323695579793STom Rini
32376a11cf48SDaniel Schwierzeck		CONFIG_SPL_TEXT_BASE
32386a11cf48SDaniel Schwierzeck		TEXT_BASE for linking the SPL binary.
32396a11cf48SDaniel Schwierzeck
324094a45bb1SScott Wood		CONFIG_SPL_RELOC_TEXT_BASE
324194a45bb1SScott Wood		Address to relocate to.  If unspecified, this is equal to
324294a45bb1SScott Wood		CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
324394a45bb1SScott Wood
324495579793STom Rini		CONFIG_SPL_BSS_START_ADDR
324595579793STom Rini		Link address for the BSS within the SPL binary.
324695579793STom Rini
324795579793STom Rini		CONFIG_SPL_BSS_MAX_SIZE
32486ebc3461SAlbert ARIBAUD		Maximum size in memory allocated to the SPL BSS.
32496ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual memory used
32506ebc3461SAlbert ARIBAUD		by SPL from __bss_start to __bss_end does not exceed it.
32518960af8bSAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
32526ebc3461SAlbert ARIBAUD		must not be both defined at the same time.
325395579793STom Rini
325495579793STom Rini		CONFIG_SPL_STACK
325595579793STom Rini		Adress of the start of the stack SPL will use
325695579793STom Rini
325794a45bb1SScott Wood		CONFIG_SPL_RELOC_STACK
325894a45bb1SScott Wood		Adress of the start of the stack SPL will use after
325994a45bb1SScott Wood		relocation.  If unspecified, this is equal to
326094a45bb1SScott Wood		CONFIG_SPL_STACK.
326194a45bb1SScott Wood
326295579793STom Rini		CONFIG_SYS_SPL_MALLOC_START
326395579793STom Rini		Starting address of the malloc pool used in SPL.
326495579793STom Rini
326595579793STom Rini		CONFIG_SYS_SPL_MALLOC_SIZE
326695579793STom Rini		The size of the malloc pool used in SPL.
32676a11cf48SDaniel Schwierzeck
326847f7bcaeSTom Rini		CONFIG_SPL_FRAMEWORK
326947f7bcaeSTom Rini		Enable the SPL framework under common/.  This framework
327047f7bcaeSTom Rini		supports MMC, NAND and YMODEM loading of U-Boot and NAND
327147f7bcaeSTom Rini		NAND loading of the Linux Kernel.
327247f7bcaeSTom Rini
3273861a86f4STom Rini		CONFIG_SPL_DISPLAY_PRINT
3274861a86f4STom Rini		For ARM, enable an optional function to print more information
3275861a86f4STom Rini		about the running system.
3276861a86f4STom Rini
32774b919725SScott Wood		CONFIG_SPL_INIT_MINIMAL
32784b919725SScott Wood		Arch init code should be built for a very small image
32794b919725SScott Wood
32806a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBCOMMON_SUPPORT
32816a11cf48SDaniel Schwierzeck		Support for common/libcommon.o in SPL binary
32826a11cf48SDaniel Schwierzeck
32836a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBDISK_SUPPORT
32846a11cf48SDaniel Schwierzeck		Support for disk/libdisk.o in SPL binary
32856a11cf48SDaniel Schwierzeck
32866a11cf48SDaniel Schwierzeck		CONFIG_SPL_I2C_SUPPORT
32876a11cf48SDaniel Schwierzeck		Support for drivers/i2c/libi2c.o in SPL binary
32886a11cf48SDaniel Schwierzeck
32896a11cf48SDaniel Schwierzeck		CONFIG_SPL_GPIO_SUPPORT
32906a11cf48SDaniel Schwierzeck		Support for drivers/gpio/libgpio.o in SPL binary
32916a11cf48SDaniel Schwierzeck
32926a11cf48SDaniel Schwierzeck		CONFIG_SPL_MMC_SUPPORT
32936a11cf48SDaniel Schwierzeck		Support for drivers/mmc/libmmc.o in SPL binary
32946a11cf48SDaniel Schwierzeck
329595579793STom Rini		CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
329695579793STom Rini		CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
329795579793STom Rini		CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION
329895579793STom Rini		Address, size and partition on the MMC to load U-Boot from
329995579793STom Rini		when the MMC is being used in raw mode.
330095579793STom Rini
33012b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
33022b75b0adSPeter Korsgaard		Sector to load kernel uImage from when MMC is being
33032b75b0adSPeter Korsgaard		used in raw mode (for Falcon mode)
33042b75b0adSPeter Korsgaard
33052b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
33062b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
33072b75b0adSPeter Korsgaard		Sector and number of sectors to load kernel argument
33082b75b0adSPeter Korsgaard		parameters from when MMC is being used in raw mode
33092b75b0adSPeter Korsgaard		(for falcon mode)
33102b75b0adSPeter Korsgaard
331195579793STom Rini		CONFIG_SPL_FAT_SUPPORT
331295579793STom Rini		Support for fs/fat/libfat.o in SPL binary
331395579793STom Rini
331495579793STom Rini		CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME
331595579793STom Rini		Filename to read to load U-Boot when reading from FAT
331695579793STom Rini
33177ad2cc79SPeter Korsgaard		CONFIG_SPL_FAT_LOAD_KERNEL_NAME
33187ad2cc79SPeter Korsgaard		Filename to read to load kernel uImage when reading
33197ad2cc79SPeter Korsgaard		from FAT (for Falcon mode)
33207ad2cc79SPeter Korsgaard
33217ad2cc79SPeter Korsgaard		CONFIG_SPL_FAT_LOAD_ARGS_NAME
33227ad2cc79SPeter Korsgaard		Filename to read to load kernel argument parameters
33237ad2cc79SPeter Korsgaard		when reading from FAT (for Falcon mode)
33247ad2cc79SPeter Korsgaard
332506f60ae3SScott Wood		CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
332606f60ae3SScott Wood		Set this for NAND SPL on PPC mpc83xx targets, so that
332706f60ae3SScott Wood		start.S waits for the rest of the SPL to load before
332806f60ae3SScott Wood		continuing (the hardware starts execution after just
332906f60ae3SScott Wood		loading the first page rather than the full 4K).
333006f60ae3SScott Wood
33316f2f01b9SScott Wood		CONFIG_SPL_NAND_BASE
33326f2f01b9SScott Wood		Include nand_base.c in the SPL.  Requires
33336f2f01b9SScott Wood		CONFIG_SPL_NAND_DRIVERS.
33346f2f01b9SScott Wood
33356f2f01b9SScott Wood		CONFIG_SPL_NAND_DRIVERS
33366f2f01b9SScott Wood		SPL uses normal NAND drivers, not minimal drivers.
33376f2f01b9SScott Wood
33386f2f01b9SScott Wood		CONFIG_SPL_NAND_ECC
33396f2f01b9SScott Wood		Include standard software ECC in the SPL
33406f2f01b9SScott Wood
334195579793STom Rini		CONFIG_SPL_NAND_SIMPLE
33427d4b7955SScott Wood		Support for NAND boot using simple NAND drivers that
33437d4b7955SScott Wood		expose the cmd_ctrl() interface.
334495579793STom Rini
3345bb0dc108SYing Zhang		CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT
3346bb0dc108SYing Zhang		Set for the SPL on PPC mpc8xxx targets, support for
33475614e71bSYork Sun		drivers/ddr/fsl/libddr.o in SPL binary.
3348bb0dc108SYing Zhang
33497c8eea59SYing Zhang		CONFIG_SPL_COMMON_INIT_DDR
33507c8eea59SYing Zhang		Set for common ddr init with serial presence detect in
33517c8eea59SYing Zhang		SPL binary.
33527c8eea59SYing Zhang
335395579793STom Rini		CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
335495579793STom Rini		CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
335595579793STom Rini		CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
335695579793STom Rini		CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
335795579793STom Rini		CONFIG_SYS_NAND_ECCBYTES
335895579793STom Rini		Defines the size and behavior of the NAND that SPL uses
33597d4b7955SScott Wood		to read U-Boot
336095579793STom Rini
3361fbe76ae4SPrabhakar Kushwaha		CONFIG_SPL_NAND_BOOT
3362fbe76ae4SPrabhakar Kushwaha		Add support NAND boot
3363fbe76ae4SPrabhakar Kushwaha
336495579793STom Rini		CONFIG_SYS_NAND_U_BOOT_OFFS
33657d4b7955SScott Wood		Location in NAND to read U-Boot from
33667d4b7955SScott Wood
33677d4b7955SScott Wood		CONFIG_SYS_NAND_U_BOOT_DST
33687d4b7955SScott Wood		Location in memory to load U-Boot to
33697d4b7955SScott Wood
33707d4b7955SScott Wood		CONFIG_SYS_NAND_U_BOOT_SIZE
33717d4b7955SScott Wood		Size of image to load
337295579793STom Rini
337395579793STom Rini		CONFIG_SYS_NAND_U_BOOT_START
33747d4b7955SScott Wood		Entry point in loaded image to jump to
337595579793STom Rini
337695579793STom Rini		CONFIG_SYS_NAND_HW_ECC_OOBFIRST
337795579793STom Rini		Define this if you need to first read the OOB and then the
337895579793STom Rini		data. This is used for example on davinci plattforms.
337995579793STom Rini
338095579793STom Rini		CONFIG_SPL_OMAP3_ID_NAND
338195579793STom Rini		Support for an OMAP3-specific set of functions to return the
338295579793STom Rini		ID and MFR of the first attached NAND chip, if present.
338395579793STom Rini
33846a11cf48SDaniel Schwierzeck		CONFIG_SPL_SERIAL_SUPPORT
33856a11cf48SDaniel Schwierzeck		Support for drivers/serial/libserial.o in SPL binary
33866a11cf48SDaniel Schwierzeck
33876a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_FLASH_SUPPORT
33886a11cf48SDaniel Schwierzeck		Support for drivers/mtd/spi/libspi_flash.o in SPL binary
33896a11cf48SDaniel Schwierzeck
33906a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_SUPPORT
33916a11cf48SDaniel Schwierzeck		Support for drivers/spi/libspi.o in SPL binary
33926a11cf48SDaniel Schwierzeck
3393c57b953dSPavel Machek		CONFIG_SPL_RAM_DEVICE
3394c57b953dSPavel Machek		Support for running image already present in ram, in SPL binary
3395c57b953dSPavel Machek
33966a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBGENERIC_SUPPORT
33976a11cf48SDaniel Schwierzeck		Support for lib/libgeneric.o in SPL binary
33981372cce2SMarian Balakowicz
3399ba1bee43SYing Zhang		CONFIG_SPL_ENV_SUPPORT
3400ba1bee43SYing Zhang		Support for the environment operating in SPL binary
3401ba1bee43SYing Zhang
3402ba1bee43SYing Zhang		CONFIG_SPL_NET_SUPPORT
3403ba1bee43SYing Zhang		Support for the net/libnet.o in SPL binary.
3404ba1bee43SYing Zhang		It conflicts with SPL env from storage medium specified by
3405ba1bee43SYing Zhang		CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3406ba1bee43SYing Zhang
340774752baaSScott Wood		CONFIG_SPL_PAD_TO
34086113d3f2SBenoît Thébaudeau		Image offset to which the SPL should be padded before appending
34096113d3f2SBenoît Thébaudeau		the SPL payload. By default, this is defined as
34106113d3f2SBenoît Thébaudeau		CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
34116113d3f2SBenoît Thébaudeau		CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
34126113d3f2SBenoît Thébaudeau		payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
341374752baaSScott Wood
3414ca2fca22SScott Wood		CONFIG_SPL_TARGET
3415ca2fca22SScott Wood		Final target image containing SPL and payload.  Some SPLs
3416ca2fca22SScott Wood		use an arch-specific makefile fragment instead, for
3417ca2fca22SScott Wood		example if more than one image needs to be produced.
3418ca2fca22SScott Wood
341987ebee39SSimon Glass		CONFIG_FIT_SPL_PRINT
342087ebee39SSimon Glass		Printing information about a FIT image adds quite a bit of
342187ebee39SSimon Glass		code to SPL. So this is normally disabled in SPL. Use this
342287ebee39SSimon Glass		option to re-enable it. This will affect the output of the
342387ebee39SSimon Glass		bootm command when booting a FIT image.
342487ebee39SSimon Glass
34253aa29de0SYing Zhang- TPL framework
34263aa29de0SYing Zhang		CONFIG_TPL
34273aa29de0SYing Zhang		Enable building of TPL globally.
34283aa29de0SYing Zhang
34293aa29de0SYing Zhang		CONFIG_TPL_PAD_TO
34303aa29de0SYing Zhang		Image offset to which the TPL should be padded before appending
34313aa29de0SYing Zhang		the TPL payload. By default, this is defined as
34323aa29de0SYing Zhang		CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
34333aa29de0SYing Zhang		CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
34343aa29de0SYing Zhang		payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
34353aa29de0SYing Zhang
3436c609719bSwdenkModem Support:
3437c609719bSwdenk--------------
3438c609719bSwdenk
3439566e5cf4SWolfgang Denk[so far only for SMDK2400 boards]
3440c609719bSwdenk
344111ccc33fSMarcel Ziswiler- Modem support enable:
3442c609719bSwdenk		CONFIG_MODEM_SUPPORT
3443c609719bSwdenk
3444c609719bSwdenk- RTS/CTS Flow control enable:
3445c609719bSwdenk		CONFIG_HWFLOW
3446c609719bSwdenk
3447c609719bSwdenk- Modem debug support:
3448c609719bSwdenk		CONFIG_MODEM_SUPPORT_DEBUG
3449c609719bSwdenk
3450c609719bSwdenk		Enables debugging stuff (char screen[1024], dbg())
3451c609719bSwdenk		for modem support. Useful only with BDI2000.
3452c609719bSwdenk
3453a8c7c708Swdenk- Interrupt support (PPC):
3454a8c7c708Swdenk
3455a8c7c708Swdenk		There are common interrupt_init() and timer_interrupt()
3456a8c7c708Swdenk		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
345711ccc33fSMarcel Ziswiler		for CPU specific initialization. interrupt_init_cpu()
3458a8c7c708Swdenk		should set decrementer_count to appropriate value. If
345911ccc33fSMarcel Ziswiler		CPU resets decrementer automatically after interrupt
3460a8c7c708Swdenk		(ppc4xx) it should set decrementer_count to zero.
346111ccc33fSMarcel Ziswiler		timer_interrupt() calls timer_interrupt_cpu() for CPU
3462a8c7c708Swdenk		specific handling. If board has watchdog / status_led
3463a8c7c708Swdenk		/ other_activity_monitor it works automatically from
3464a8c7c708Swdenk		general timer_interrupt().
3465a8c7c708Swdenk
3466c609719bSwdenk- General:
3467c609719bSwdenk
3468c609719bSwdenk		In the target system modem support is enabled when a
3469c609719bSwdenk		specific key (key combination) is pressed during
3470c609719bSwdenk		power-on. Otherwise U-Boot will boot normally
347111ccc33fSMarcel Ziswiler		(autoboot). The key_pressed() function is called from
3472c609719bSwdenk		board_init(). Currently key_pressed() is a dummy
3473c609719bSwdenk		function, returning 1 and thus enabling modem
3474c609719bSwdenk		initialization.
3475c609719bSwdenk
3476c609719bSwdenk		If there are no modem init strings in the
3477c609719bSwdenk		environment, U-Boot proceed to autoboot; the
3478c609719bSwdenk		previous output (banner, info printfs) will be
347911ccc33fSMarcel Ziswiler		suppressed, though.
3480c609719bSwdenk
3481c609719bSwdenk		See also: doc/README.Modem
3482c609719bSwdenk
34839660e442SHelmut RaigerBoard initialization settings:
34849660e442SHelmut Raiger------------------------------
34859660e442SHelmut Raiger
34869660e442SHelmut RaigerDuring Initialization u-boot calls a number of board specific functions
34879660e442SHelmut Raigerto allow the preparation of board specific prerequisites, e.g. pin setup
34889660e442SHelmut Raigerbefore drivers are initialized. To enable these callbacks the
34899660e442SHelmut Raigerfollowing configuration macros have to be defined. Currently this is
34909660e442SHelmut Raigerarchitecture specific, so please check arch/your_architecture/lib/board.c
34919660e442SHelmut Raigertypically in board_init_f() and board_init_r().
34929660e442SHelmut Raiger
34939660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
34949660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
34959660e442SHelmut Raiger- CONFIG_BOARD_LATE_INIT: Call board_late_init()
34969660e442SHelmut Raiger- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
3497c609719bSwdenk
3498c609719bSwdenkConfiguration Settings:
3499c609719bSwdenk-----------------------
3500c609719bSwdenk
35014d1fd7f1SYork Sun- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
35024d1fd7f1SYork Sun		Optionally it can be defined to support 64-bit memory commands.
35034d1fd7f1SYork Sun
35046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
3505c609719bSwdenk		undefine this when you're short of memory.
3506c609719bSwdenk
35072fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
35082fb2604dSPeter Tyser		width of the commands listed in the 'help' command output.
35092fb2604dSPeter Tyser
35106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT:	This is what U-Boot prints on the console to
3511c609719bSwdenk		prompt for user input.
3512c609719bSwdenk
35136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE:	Buffer size for input from the Console
3514c609719bSwdenk
35156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE:	Buffer size for Console output
3516c609719bSwdenk
35176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS:	max. Number of arguments accepted for monitor commands
3518c609719bSwdenk
35196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
3520c609719bSwdenk		the application (usually a Linux kernel) when it is
3521c609719bSwdenk		booted
3522c609719bSwdenk
35236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE:
3524c609719bSwdenk		List of legal baudrate settings for this board.
3525c609719bSwdenk
35266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_INFO_QUIET
3527c609719bSwdenk		Suppress display of console information at boot.
3528c609719bSwdenk
35296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_IS_IN_ENV
3530c609719bSwdenk		If the board specific function
3531c609719bSwdenk			extern int overwrite_console (void);
3532c609719bSwdenk		returns 1, the stdin, stderr and stdout are switched to the
3533c609719bSwdenk		serial port, else the settings in the environment are used.
3534c609719bSwdenk
35356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
3536c609719bSwdenk		Enable the call to overwrite_console().
3537c609719bSwdenk
35386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
3539c609719bSwdenk		Enable overwrite of previous console environment settings.
3540c609719bSwdenk
35416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
3542c609719bSwdenk		Begin and End addresses of the area used by the
3543c609719bSwdenk		simple memory test.
3544c609719bSwdenk
35456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST:
3546c609719bSwdenk		Enable an alternate, more extensive memory test.
3547c609719bSwdenk
35486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH:
35495f535fe1Swdenk		Scratch address used by the alternate memory test
35505f535fe1Swdenk		You only need to set this if address zero isn't writeable
35515f535fe1Swdenk
35526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
35536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
355414f73ca6SStefan Roese		this specified memory area will get subtracted from the top
355511ccc33fSMarcel Ziswiler		(end) of RAM and won't get "touched" at all by U-Boot. By
355614f73ca6SStefan Roese		fixing up gd->ram_size the Linux kernel should gets passed
355714f73ca6SStefan Roese		the now "corrected" memory size and won't touch it either.
355814f73ca6SStefan Roese		This should work for arch/ppc and arch/powerpc. Only Linux
35595e12e75dSStefan Roese		board ports in arch/powerpc with bootwrapper support that
356014f73ca6SStefan Roese		recalculate the memory size from the SDRAM controller setup
35615e12e75dSStefan Roese		will have to get fixed in Linux additionally.
356214f73ca6SStefan Roese
356314f73ca6SStefan Roese		This option can be used as a workaround for the 440EPx/GRx
356414f73ca6SStefan Roese		CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
356514f73ca6SStefan Roese		be touched.
356614f73ca6SStefan Roese
356714f73ca6SStefan Roese		WARNING: Please make sure that this value is a multiple of
356814f73ca6SStefan Roese		the Linux page size (normally 4k). If this is not the case,
356914f73ca6SStefan Roese		then the end address of the Linux memory will be located at a
357014f73ca6SStefan Roese		non page size aligned address and this could cause major
357114f73ca6SStefan Roese		problems.
357214f73ca6SStefan Roese
35736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE:
3574c609719bSwdenk		Enable temporary baudrate change while serial download
3575c609719bSwdenk
35766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE:
3577c609719bSwdenk		Physical start address of SDRAM. _Must_ be 0 here.
3578c609719bSwdenk
35796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MBIO_BASE:
3580c609719bSwdenk		Physical start address of Motherboard I/O (if using a
3581c609719bSwdenk		Cogent motherboard)
3582c609719bSwdenk
35836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE:
3584c609719bSwdenk		Physical start address of Flash memory.
3585c609719bSwdenk
35866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE:
3587c609719bSwdenk		Physical start address of boot monitor code (set by
3588c609719bSwdenk		make config files to be same as the text base address
358914d0a02aSWolfgang Denk		(CONFIG_SYS_TEXT_BASE) used when linking) - same as
35906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FLASH_BASE when booting from flash.
3591c609719bSwdenk
35926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN:
35933b57fe0aSwdenk		Size of memory reserved for monitor code, used to
35943b57fe0aSwdenk		determine _at_compile_time_ (!) if the environment is
35953b57fe0aSwdenk		embedded within the U-Boot image, or in a separate
35963b57fe0aSwdenk		flash sector.
3597c609719bSwdenk
35986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN:
3599c609719bSwdenk		Size of DRAM reserved for malloc() use.
3600c609719bSwdenk
36016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN:
360215940c9aSStefan Roese		Normally compressed uImages are limited to an
360315940c9aSStefan Roese		uncompressed size of 8 MBytes. If this is not enough,
36046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		you can define CONFIG_SYS_BOOTM_LEN in your board config file
360515940c9aSStefan Roese		to adjust this setting to your needs.
3606c609719bSwdenk
36076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ:
3608c609719bSwdenk		Maximum size of memory mapped by the startup code of
3609c609719bSwdenk		the Linux kernel; all data that must be processed by
36107d721e34SBartlomiej Sieka		the Linux kernel (bd_info, boot arguments, FDT blob if
36117d721e34SBartlomiej Sieka		used) must be put below this limit, unless "bootm_low"
36121bce2aebSRobert P. J. Day		environment variable is defined and non-zero. In such case
36137d721e34SBartlomiej Sieka		all data for the Linux kernel must be between "bootm_low"
3614c3624e6eSGrant Likely		and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.	 The environment
3615c3624e6eSGrant Likely		variable "bootm_mapsize" will override the value of
3616c3624e6eSGrant Likely		CONFIG_SYS_BOOTMAPSZ.  If CONFIG_SYS_BOOTMAPSZ is undefined,
3617c3624e6eSGrant Likely		then the value in "bootm_size" will be used instead.
3618c609719bSwdenk
3619fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3620fca43cc8SJohn Rigby		Enable initrd_high functionality.  If defined then the
3621fca43cc8SJohn Rigby		initrd_high feature is enabled and the bootm ramdisk subcommand
3622fca43cc8SJohn Rigby		is enabled.
3623fca43cc8SJohn Rigby
3624fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_CMDLINE:
3625fca43cc8SJohn Rigby		Enables allocating and saving kernel cmdline in space between
3626fca43cc8SJohn Rigby		"bootm_low" and "bootm_low" + BOOTMAPSZ.
3627fca43cc8SJohn Rigby
3628fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_KBD:
3629fca43cc8SJohn Rigby		Enables allocating and saving a kernel copy of the bd_info in
3630fca43cc8SJohn Rigby		space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3631fca43cc8SJohn Rigby
36326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS:
3633c609719bSwdenk		Max number of Flash memory banks
3634c609719bSwdenk
36356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT:
3636c609719bSwdenk		Max number of sectors on a Flash chip
3637c609719bSwdenk
36386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT:
3639c609719bSwdenk		Timeout for Flash erase operations (in ms)
3640c609719bSwdenk
36416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT:
3642c609719bSwdenk		Timeout for Flash write operations (in ms)
3643c609719bSwdenk
36446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT
36458564acf9Swdenk		Timeout for Flash set sector lock bit operation (in ms)
36468564acf9Swdenk
36476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT
36488564acf9Swdenk		Timeout for Flash clear lock bits operation (in ms)
36498564acf9Swdenk
36506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION
36518564acf9Swdenk		If defined, hardware flash sectors protection is used
36528564acf9Swdenk		instead of U-Boot software protection.
36538564acf9Swdenk
36546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP:
3655c609719bSwdenk
3656c609719bSwdenk		Enable TFTP transfers directly to flash memory;
3657c609719bSwdenk		without this option such a download has to be
3658c609719bSwdenk		performed in two steps: (1) download to RAM, and (2)
3659c609719bSwdenk		copy from RAM to flash.
3660c609719bSwdenk
3661c609719bSwdenk		The two-step approach is usually more reliable, since
3662c609719bSwdenk		you can check if the download worked before you erase
366311ccc33fSMarcel Ziswiler		the flash, but in some situations (when system RAM is
366411ccc33fSMarcel Ziswiler		too limited to allow for a temporary copy of the
3665c609719bSwdenk		downloaded image) this option may be very useful.
3666c609719bSwdenk
36676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI:
3668c609719bSwdenk		Define if the flash driver uses extra elements in the
36695653fc33Swdenk		common flash structure for storing flash geometry.
36705653fc33Swdenk
367100b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER
36725653fc33Swdenk		This option also enables the building of the cfi_flash driver
36735653fc33Swdenk		in the drivers directory
367453cf9435Sstroese
367591809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD
367691809ed5SPiotr Ziecik		This option enables the building of the cfi_mtd driver
367791809ed5SPiotr Ziecik		in the drivers directory. The driver exports CFI flash
367891809ed5SPiotr Ziecik		to the MTD layer.
367991809ed5SPiotr Ziecik
36806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
368196ef831fSGuennadi Liakhovetski		Use buffered writes to flash.
368296ef831fSGuennadi Liakhovetski
368396ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N
368496ef831fSGuennadi Liakhovetski		s29ws-n MirrorBit flash has non-standard addresses for buffered
368596ef831fSGuennadi Liakhovetski		write commands.
368696ef831fSGuennadi Liakhovetski
36876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST
36885568e613SStefan Roese		If this option is defined, the common CFI flash doesn't
36895568e613SStefan Roese		print it's warning upon not recognized FLASH banks. This
36905568e613SStefan Roese		is useful, if some of the configured banks are only
36915568e613SStefan Roese		optionally available.
36925568e613SStefan Roese
36939a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS
36949a042e9cSJerry Van Baren		If defined (must be an integer), print out countdown
36959a042e9cSJerry Van Baren		digits and dots.  Recommended value: 45 (9..1) for 80
36969a042e9cSJerry Van Baren		column displays, 15 (3..1) for 40 column displays.
36979a042e9cSJerry Van Baren
3698352ef3f1SStefan Roese- CONFIG_FLASH_VERIFY
3699352ef3f1SStefan Roese		If defined, the content of the flash (destination) is compared
3700352ef3f1SStefan Roese		against the source after the write operation. An error message
3701352ef3f1SStefan Roese		will be printed when the contents are not identical.
3702352ef3f1SStefan Roese		Please note that this option is useless in nearly all cases,
3703352ef3f1SStefan Roese		since such flash programming errors usually are detected earlier
3704352ef3f1SStefan Roese		while unprotecting/erasing/programming. Please only enable
3705352ef3f1SStefan Roese		this option if you really know what you are doing.
3706352ef3f1SStefan Roese
37076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER:
370811ccc33fSMarcel Ziswiler		Defines the number of Ethernet receive buffers. On some
370911ccc33fSMarcel Ziswiler		Ethernet controllers it is recommended to set this value
371053cf9435Sstroese		to 8 or even higher (EEPRO100 or 405 EMAC), since all
371153cf9435Sstroese		buffers can be full shortly after enabling the interface
371211ccc33fSMarcel Ziswiler		on high Ethernet traffic.
371353cf9435Sstroese		Defaults to 4 if not defined.
3714c609719bSwdenk
3715ea882bafSWolfgang Denk- CONFIG_ENV_MAX_ENTRIES
3716ea882bafSWolfgang Denk
3717ea882bafSWolfgang Denk	Maximum number of entries in the hash table that is used
3718ea882bafSWolfgang Denk	internally to store the environment settings. The default
3719ea882bafSWolfgang Denk	setting is supposed to be generous and should work in most
3720ea882bafSWolfgang Denk	cases. This setting can be used to tune behaviour; see
3721ea882bafSWolfgang Denk	lib/hashtable.c for details.
3722ea882bafSWolfgang Denk
37232598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_DEFAULT
37242598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_STATIC
37251bce2aebSRobert P. J. Day	Enable validation of the values given to environment variables when
37262598090bSJoe Hershberger	calling env set.  Variables can be restricted to only decimal,
37272598090bSJoe Hershberger	hexadecimal, or boolean.  If CONFIG_CMD_NET is also defined,
37282598090bSJoe Hershberger	the variables can also be restricted to IP address or MAC address.
37292598090bSJoe Hershberger
37302598090bSJoe Hershberger	The format of the list is:
37312598090bSJoe Hershberger		type_attribute = [s|d|x|b|i|m]
3732267541f7SJoe Hershberger		access_atribute = [a|r|o|c]
3733267541f7SJoe Hershberger		attributes = type_attribute[access_atribute]
37342598090bSJoe Hershberger		entry = variable_name[:attributes]
37352598090bSJoe Hershberger		list = entry[,list]
37362598090bSJoe Hershberger
37372598090bSJoe Hershberger	The type attributes are:
37382598090bSJoe Hershberger		s - String (default)
37392598090bSJoe Hershberger		d - Decimal
37402598090bSJoe Hershberger		x - Hexadecimal
37412598090bSJoe Hershberger		b - Boolean ([1yYtT|0nNfF])
37422598090bSJoe Hershberger		i - IP address
37432598090bSJoe Hershberger		m - MAC address
37442598090bSJoe Hershberger
3745267541f7SJoe Hershberger	The access attributes are:
3746267541f7SJoe Hershberger		a - Any (default)
3747267541f7SJoe Hershberger		r - Read-only
3748267541f7SJoe Hershberger		o - Write-once
3749267541f7SJoe Hershberger		c - Change-default
3750267541f7SJoe Hershberger
37512598090bSJoe Hershberger	- CONFIG_ENV_FLAGS_LIST_DEFAULT
37522598090bSJoe Hershberger		Define this to a list (string) to define the ".flags"
37532598090bSJoe Hershberger		envirnoment variable in the default or embedded environment.
37542598090bSJoe Hershberger
37552598090bSJoe Hershberger	- CONFIG_ENV_FLAGS_LIST_STATIC
37562598090bSJoe Hershberger		Define this to a list (string) to define validation that
37572598090bSJoe Hershberger		should be done if an entry is not found in the ".flags"
37582598090bSJoe Hershberger		environment variable.  To override a setting in the static
37592598090bSJoe Hershberger		list, simply add an entry for the same variable name to the
37602598090bSJoe Hershberger		".flags" variable.
37612598090bSJoe Hershberger
3762267541f7SJoe Hershberger- CONFIG_ENV_ACCESS_IGNORE_FORCE
3763267541f7SJoe Hershberger	If defined, don't allow the -f switch to env set override variable
3764267541f7SJoe Hershberger	access flags.
3765267541f7SJoe Hershberger
37665c1a7ea6SSimon Glass- CONFIG_SYS_GENERIC_BOARD
37675c1a7ea6SSimon Glass	This selects the architecture-generic board system instead of the
37685c1a7ea6SSimon Glass	architecture-specific board files. It is intended to move boards
37695c1a7ea6SSimon Glass	to this new framework over time. Defining this will disable the
37705c1a7ea6SSimon Glass	arch/foo/lib/board.c file and use common/board_f.c and
37715c1a7ea6SSimon Glass	common/board_r.c instead. To use this option your architecture
37725c1a7ea6SSimon Glass	must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in
37735c1a7ea6SSimon Glass	its config.mk file). If you find problems enabling this option on
37745c1a7ea6SSimon Glass	your board please report the problem and send patches!
37755c1a7ea6SSimon Glass
37760b1b60c7SLokesh Vutla- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
37770b1b60c7SLokesh Vutla	This is set by OMAP boards for the max time that reset should
37780b1b60c7SLokesh Vutla	be asserted. See doc/README.omap-reset-time for details on how
37790b1b60c7SLokesh Vutla	the value can be calulated on a given board.
3780632efa74SSimon Glass
3781c609719bSwdenkThe following definitions that deal with the placement and management
3782c609719bSwdenkof environment data (variable area); in general, we support the
3783c609719bSwdenkfollowing configurations:
3784c609719bSwdenk
3785c3eb3fe4SMike Frysinger- CONFIG_BUILD_ENVCRC:
3786c3eb3fe4SMike Frysinger
3787c3eb3fe4SMike Frysinger	Builds up envcrc with the target environment so that external utils
3788c3eb3fe4SMike Frysinger	may easily extract it and embed it in final U-Boot images.
3789c3eb3fe4SMike Frysinger
37905a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH:
3791c609719bSwdenk
3792c609719bSwdenk	Define this if the environment is in flash memory.
3793c609719bSwdenk
3794c609719bSwdenk	a) The environment occupies one whole flash sector, which is
3795c609719bSwdenk	   "embedded" in the text segment with the U-Boot code. This
3796c609719bSwdenk	   happens usually with "bottom boot sector" or "top boot
3797c609719bSwdenk	   sector" type flash chips, which have several smaller
3798c609719bSwdenk	   sectors at the start or the end. For instance, such a
3799c609719bSwdenk	   layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3800c609719bSwdenk	   such a case you would place the environment in one of the
3801c609719bSwdenk	   4 kB sectors - with U-Boot code before and after it. With
3802c609719bSwdenk	   "top boot sector" type flash chips, you would put the
3803c609719bSwdenk	   environment in one of the last sectors, leaving a gap
3804c609719bSwdenk	   between U-Boot and the environment.
3805c609719bSwdenk
38060e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
3807c609719bSwdenk
3808c609719bSwdenk	   Offset of environment data (variable area) to the
3809c609719bSwdenk	   beginning of flash memory; for instance, with bottom boot
3810c609719bSwdenk	   type flash chips the second sector can be used: the offset
3811c609719bSwdenk	   for this sector is given here.
3812c609719bSwdenk
38136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
3814c609719bSwdenk
38150e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
3816c609719bSwdenk
3817c609719bSwdenk	   This is just another way to specify the start address of
3818c609719bSwdenk	   the flash sector containing the environment (instead of
38190e8d1586SJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET).
3820c609719bSwdenk
38210e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SECT_SIZE:
3822c609719bSwdenk
3823c609719bSwdenk	   Size of the sector containing the environment.
3824c609719bSwdenk
3825c609719bSwdenk
3826c609719bSwdenk	b) Sometimes flash chips have few, equal sized, BIG sectors.
3827c609719bSwdenk	   In such a case you don't want to spend a whole sector for
3828c609719bSwdenk	   the environment.
3829c609719bSwdenk
38300e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3831c609719bSwdenk
38325a1aceb0SJean-Christophe PLAGNIOL-VILLARD	   If you use this in combination with CONFIG_ENV_IS_IN_FLASH
38330e8d1586SJean-Christophe PLAGNIOL-VILLARD	   and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
3834c609719bSwdenk	   of this flash sector for the environment. This saves
3835c609719bSwdenk	   memory for the RAM copy of the environment.
3836c609719bSwdenk
3837c609719bSwdenk	   It may also save flash memory if you decide to use this
3838c609719bSwdenk	   when your environment is "embedded" within U-Boot code,
3839c609719bSwdenk	   since then the remainder of the flash sector could be used
3840c609719bSwdenk	   for U-Boot code. It should be pointed out that this is
3841c609719bSwdenk	   STRONGLY DISCOURAGED from a robustness point of view:
3842c609719bSwdenk	   updating the environment in flash makes it always
3843c609719bSwdenk	   necessary to erase the WHOLE sector. If something goes
3844c609719bSwdenk	   wrong before the contents has been restored from a copy in
3845c609719bSwdenk	   RAM, your target system will be dead.
3846c609719bSwdenk
38470e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR_REDUND
38480e8d1586SJean-Christophe PLAGNIOL-VILLARD	  CONFIG_ENV_SIZE_REDUND
3849c609719bSwdenk
3850c609719bSwdenk	   These settings describe a second storage area used to hold
385111ccc33fSMarcel Ziswiler	   a redundant copy of the environment data, so that there is
38523e38691eSwdenk	   a valid backup copy in case there is a power failure during
3853c609719bSwdenk	   a "saveenv" operation.
3854c609719bSwdenk
3855c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the
3856c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds*
3857c609719bSwdenkaccordingly!
3858c609719bSwdenk
3859c609719bSwdenk
38609314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM:
3861c609719bSwdenk
3862c609719bSwdenk	Define this if you have some non-volatile memory device
3863c609719bSwdenk	(NVRAM, battery buffered SRAM) which you want to use for the
3864c609719bSwdenk	environment.
3865c609719bSwdenk
38660e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
38670e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3868c609719bSwdenk
386911ccc33fSMarcel Ziswiler	  These two #defines are used to determine the memory area you
3870c609719bSwdenk	  want to use for environment. It is assumed that this memory
3871c609719bSwdenk	  can just be read and written to, without any special
3872c609719bSwdenk	  provision.
3873c609719bSwdenk
3874c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early
3875c609719bSwdenkin U-Boot initalization (when we try to get the setting of for the
387611ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or
3877c609719bSwdenkU-Boot will hang.
3878c609719bSwdenk
3879c609719bSwdenkPlease note that even with NVRAM we still use a copy of the
3880c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to
3881c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv"
3882c609719bSwdenkto save the current settings.
3883c609719bSwdenk
3884c609719bSwdenk
3885bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM:
3886c609719bSwdenk
3887c609719bSwdenk	Use this if you have an EEPROM or similar serial access
3888c609719bSwdenk	device and a driver for it.
3889c609719bSwdenk
38900e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
38910e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3892c609719bSwdenk
3893c609719bSwdenk	  These two #defines specify the offset and size of the
3894c609719bSwdenk	  environment area within the total memory of your EEPROM.
3895c609719bSwdenk
38966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR:
3897c609719bSwdenk	  If defined, specified the chip address of the EEPROM device.
3898c609719bSwdenk	  The default address is zero.
3899c609719bSwdenk
39006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
3901c609719bSwdenk	  If defined, the number of bits used to address bytes in a
3902c609719bSwdenk	  single page in the EEPROM device.  A 64 byte page, for example
3903c609719bSwdenk	  would require six bits.
3904c609719bSwdenk
39056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
3906c609719bSwdenk	  If defined, the number of milliseconds to delay between
3907c609719bSwdenk	  page writes.	The default is zero milliseconds.
3908c609719bSwdenk
39096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
3910c609719bSwdenk	  The length in bytes of the EEPROM memory array address.  Note
3911c609719bSwdenk	  that this is NOT the chip address length!
3912c609719bSwdenk
39136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
39145cf91d6bSwdenk	  EEPROM chips that implement "address overflow" are ones
39155cf91d6bSwdenk	  like Catalyst 24WC04/08/16 which has 9/10/11 bits of
39165cf91d6bSwdenk	  address and the extra bits end up in the "chip address" bit
39175cf91d6bSwdenk	  slots. This makes a 24WC08 (1Kbyte) chip look like four 256
39185cf91d6bSwdenk	  byte chips.
39195cf91d6bSwdenk
39205cf91d6bSwdenk	  Note that we consider the length of the address field to
39215cf91d6bSwdenk	  still be one byte because the extra address bits are hidden
39225cf91d6bSwdenk	  in the chip address.
39235cf91d6bSwdenk
39246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_SIZE:
3925c609719bSwdenk	  The size in bytes of the EEPROM device.
3926c609719bSwdenk
3927548738b4SHeiko Schocher	- CONFIG_ENV_EEPROM_IS_ON_I2C
3928548738b4SHeiko Schocher	  define this, if you have I2C and SPI activated, and your
3929548738b4SHeiko Schocher	  EEPROM, which holds the environment, is on the I2C bus.
3930548738b4SHeiko Schocher
3931548738b4SHeiko Schocher	- CONFIG_I2C_ENV_EEPROM_BUS
3932548738b4SHeiko Schocher	  if you have an Environment on an EEPROM reached over
3933548738b4SHeiko Schocher	  I2C muxes, you can define here, how to reach this
3934548738b4SHeiko Schocher	  EEPROM. For example:
3935548738b4SHeiko Schocher
3936ea818dbbSHeiko Schocher	  #define CONFIG_I2C_ENV_EEPROM_BUS	  1
3937548738b4SHeiko Schocher
3938548738b4SHeiko Schocher	  EEPROM which holds the environment, is reached over
3939548738b4SHeiko Schocher	  a pca9547 i2c mux with address 0x70, channel 3.
3940c609719bSwdenk
3941057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH:
39425779d8d9Swdenk
39435779d8d9Swdenk	Define this if you have a DataFlash memory device which you
39445779d8d9Swdenk	want to use for the environment.
39455779d8d9Swdenk
39460e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
39470e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
39480e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
39495779d8d9Swdenk
39505779d8d9Swdenk	  These three #defines specify the offset and size of the
39515779d8d9Swdenk	  environment area within the total memory of your DataFlash placed
39525779d8d9Swdenk	  at the specified address.
39535779d8d9Swdenk
39540a85a9e7SLiu Gang- CONFIG_ENV_IS_IN_REMOTE:
39550a85a9e7SLiu Gang
39560a85a9e7SLiu Gang	Define this if you have a remote memory space which you
39570a85a9e7SLiu Gang	want to use for the local device's environment.
39580a85a9e7SLiu Gang
39590a85a9e7SLiu Gang	- CONFIG_ENV_ADDR:
39600a85a9e7SLiu Gang	- CONFIG_ENV_SIZE:
39610a85a9e7SLiu Gang
39620a85a9e7SLiu Gang	  These two #defines specify the address and size of the
39630a85a9e7SLiu Gang	  environment area within the remote memory space. The
39640a85a9e7SLiu Gang	  local device can get the environment from remote memory
3965fc54c7faSLiu Gang	  space by SRIO or PCIE links.
39660a85a9e7SLiu Gang
39670a85a9e7SLiu GangBE CAREFUL! For some special cases, the local device can not use
39680a85a9e7SLiu Gang"saveenv" command. For example, the local device will get the
3969fc54c7faSLiu Gangenvironment stored in a remote NOR flash by SRIO or PCIE link,
3970fc54c7faSLiu Gangbut it can not erase, write this NOR flash by SRIO or PCIE interface.
39710a85a9e7SLiu Gang
397251bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND:
397313a5695bSwdenk
397413a5695bSwdenk	Define this if you have a NAND device which you want to use
397513a5695bSwdenk	for the environment.
397613a5695bSwdenk
39770e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
39780e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
397913a5695bSwdenk
398013a5695bSwdenk	  These two #defines specify the offset and size of the environment
3981fdd813deSScott Wood	  area within the first NAND device.  CONFIG_ENV_OFFSET must be
3982fdd813deSScott Wood	  aligned to an erase block boundary.
39835779d8d9Swdenk
3984fdd813deSScott Wood	- CONFIG_ENV_OFFSET_REDUND (optional):
3985e443c944SMarkus Klotzbuecher
39860e8d1586SJean-Christophe PLAGNIOL-VILLARD	  This setting describes a second storage area of CONFIG_ENV_SIZE
3987fdd813deSScott Wood	  size used to hold a redundant copy of the environment data, so
3988fdd813deSScott Wood	  that there is a valid backup copy in case there is a power failure
3989fdd813deSScott Wood	  during a "saveenv" operation.	 CONFIG_ENV_OFFSET_RENDUND must be
3990fdd813deSScott Wood	  aligned to an erase block boundary.
3991e443c944SMarkus Klotzbuecher
3992fdd813deSScott Wood	- CONFIG_ENV_RANGE (optional):
3993fdd813deSScott Wood
3994fdd813deSScott Wood	  Specifies the length of the region in which the environment
3995fdd813deSScott Wood	  can be written.  This should be a multiple of the NAND device's
3996fdd813deSScott Wood	  block size.  Specifying a range with more erase blocks than
3997fdd813deSScott Wood	  are needed to hold CONFIG_ENV_SIZE allows bad blocks within
3998fdd813deSScott Wood	  the range to be avoided.
3999fdd813deSScott Wood
4000fdd813deSScott Wood	- CONFIG_ENV_OFFSET_OOB (optional):
4001fdd813deSScott Wood
4002fdd813deSScott Wood	  Enables support for dynamically retrieving the offset of the
4003fdd813deSScott Wood	  environment from block zero's out-of-band data.  The
4004fdd813deSScott Wood	  "nand env.oob" command can be used to record this offset.
4005fdd813deSScott Wood	  Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
4006fdd813deSScott Wood	  using CONFIG_ENV_OFFSET_OOB.
4007e443c944SMarkus Klotzbuecher
4008b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST
4009b74ab737SGuennadi Liakhovetski
4010b74ab737SGuennadi Liakhovetski	Defines address in RAM to which the nand_spl code should copy the
4011b74ab737SGuennadi Liakhovetski	environment. If redundant environment is used, it will be copied to
4012b74ab737SGuennadi Liakhovetski	CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
4013b74ab737SGuennadi Liakhovetski
40142b74433fSJoe Hershberger- CONFIG_ENV_IS_IN_UBI:
40152b74433fSJoe Hershberger
40162b74433fSJoe Hershberger	Define this if you have an UBI volume that you want to use for the
40172b74433fSJoe Hershberger	environment.  This has the benefit of wear-leveling the environment
40182b74433fSJoe Hershberger	accesses, which is important on NAND.
40192b74433fSJoe Hershberger
40202b74433fSJoe Hershberger	- CONFIG_ENV_UBI_PART:
40212b74433fSJoe Hershberger
40222b74433fSJoe Hershberger	  Define this to a string that is the mtd partition containing the UBI.
40232b74433fSJoe Hershberger
40242b74433fSJoe Hershberger	- CONFIG_ENV_UBI_VOLUME:
40252b74433fSJoe Hershberger
40262b74433fSJoe Hershberger	  Define this to the name of the volume that you want to store the
40272b74433fSJoe Hershberger	  environment in.
40282b74433fSJoe Hershberger
4029785881f7SJoe Hershberger	- CONFIG_ENV_UBI_VOLUME_REDUND:
4030785881f7SJoe Hershberger
4031785881f7SJoe Hershberger	  Define this to the name of another volume to store a second copy of
4032785881f7SJoe Hershberger	  the environment in.  This will enable redundant environments in UBI.
4033785881f7SJoe Hershberger	  It is assumed that both volumes are in the same MTD partition.
4034785881f7SJoe Hershberger
40352b74433fSJoe Hershberger	- CONFIG_UBI_SILENCE_MSG
40362b74433fSJoe Hershberger	- CONFIG_UBIFS_SILENCE_MSG
40372b74433fSJoe Hershberger
40382b74433fSJoe Hershberger	  You will probably want to define these to avoid a really noisy system
40392b74433fSJoe Hershberger	  when storing the env in UBI.
40402b74433fSJoe Hershberger
404106e4ae5fSStephen Warren- CONFIG_ENV_IS_IN_MMC:
404206e4ae5fSStephen Warren
404306e4ae5fSStephen Warren	Define this if you have an MMC device which you want to use for the
404406e4ae5fSStephen Warren	environment.
404506e4ae5fSStephen Warren
404606e4ae5fSStephen Warren	- CONFIG_SYS_MMC_ENV_DEV:
404706e4ae5fSStephen Warren
404806e4ae5fSStephen Warren	  Specifies which MMC device the environment is stored in.
404906e4ae5fSStephen Warren
405006e4ae5fSStephen Warren	- CONFIG_SYS_MMC_ENV_PART (optional):
405106e4ae5fSStephen Warren
405206e4ae5fSStephen Warren	  Specifies which MMC partition the environment is stored in. If not
405306e4ae5fSStephen Warren	  set, defaults to partition 0, the user area. Common values might be
405406e4ae5fSStephen Warren	  1 (first MMC boot partition), 2 (second MMC boot partition).
405506e4ae5fSStephen Warren
405606e4ae5fSStephen Warren	- CONFIG_ENV_OFFSET:
405706e4ae5fSStephen Warren	- CONFIG_ENV_SIZE:
405806e4ae5fSStephen Warren
405906e4ae5fSStephen Warren	  These two #defines specify the offset and size of the environment
406006e4ae5fSStephen Warren	  area within the specified MMC device.
406106e4ae5fSStephen Warren
40625c088ee8SStephen Warren	  If offset is positive (the usual case), it is treated as relative to
40635c088ee8SStephen Warren	  the start of the MMC partition. If offset is negative, it is treated
40645c088ee8SStephen Warren	  as relative to the end of the MMC partition. This can be useful if
40655c088ee8SStephen Warren	  your board may be fitted with different MMC devices, which have
40665c088ee8SStephen Warren	  different sizes for the MMC partitions, and you always want the
40675c088ee8SStephen Warren	  environment placed at the very end of the partition, to leave the
40685c088ee8SStephen Warren	  maximum possible space before it, to store other data.
40695c088ee8SStephen Warren
407006e4ae5fSStephen Warren	  These two values are in units of bytes, but must be aligned to an
407106e4ae5fSStephen Warren	  MMC sector boundary.
407206e4ae5fSStephen Warren
407306e4ae5fSStephen Warren	- CONFIG_ENV_OFFSET_REDUND (optional):
407406e4ae5fSStephen Warren
407506e4ae5fSStephen Warren	  Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
407606e4ae5fSStephen Warren	  hold a redundant copy of the environment data. This provides a
407706e4ae5fSStephen Warren	  valid backup copy in case the other copy is corrupted, e.g. due
407806e4ae5fSStephen Warren	  to a power failure during a "saveenv" operation.
407906e4ae5fSStephen Warren
40805c088ee8SStephen Warren	  This value may also be positive or negative; this is handled in the
40815c088ee8SStephen Warren	  same way as CONFIG_ENV_OFFSET.
40825c088ee8SStephen Warren
408306e4ae5fSStephen Warren	  This value is also in units of bytes, but must also be aligned to
408406e4ae5fSStephen Warren	  an MMC sector boundary.
408506e4ae5fSStephen Warren
408606e4ae5fSStephen Warren	- CONFIG_ENV_SIZE_REDUND (optional):
408706e4ae5fSStephen Warren
408806e4ae5fSStephen Warren	  This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
408906e4ae5fSStephen Warren	  set. If this value is set, it must be set to the same value as
409006e4ae5fSStephen Warren	  CONFIG_ENV_SIZE.
409106e4ae5fSStephen Warren
40926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET
4093c609719bSwdenk
4094c609719bSwdenk	Defines offset to the initial SPI buffer area in DPRAM. The
4095c609719bSwdenk	area is used at an early stage (ROM part) if the environment
4096c609719bSwdenk	is configured to reside in the SPI EEPROM: We need a 520 byte
4097c609719bSwdenk	scratch DPRAM area. It is used between the two initialization
4098c609719bSwdenk	calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4099c609719bSwdenk	to be a good choice since it makes it far enough from the
4100c609719bSwdenk	start of the data area as well as from the stack pointer.
4101c609719bSwdenk
4102e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor
4103c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been
4104cdb74977SWolfgang Denkcreated; also, when using EEPROM you will have to use getenv_f()
4105c609719bSwdenkuntil then to read environment variables.
4106c609719bSwdenk
410785ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor
410885ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working
410985ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is
411085ec0bccSwdenknecessary, because the first environment variable we need is the
411185ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't
411285ec0bccSwdenkhave any device yet where we could complain.]
4113c609719bSwdenk
4114c609719bSwdenkNote: once the monitor has been relocated, then it will complain if
4115c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you
411685ec0bccSwdenkuse the "saveenv" command to store a valid environment.
4117c609719bSwdenk
41186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
4119fc3e2165Swdenk		Echo the inverted Ethernet link state to the fault LED.
4120fc3e2165Swdenk
41216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
4122fc3e2165Swdenk		      also needs to be defined.
4123fc3e2165Swdenk
41246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR:
4125fc3e2165Swdenk		MII address of the PHY to check for the Ethernet link state.
4126c609719bSwdenk
4127f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS:
4128f5675aa5SRon Madrid		Define this if you desire to only have use of the NS16550_init
4129f5675aa5SRon Madrid		and NS16550_putc functions for the serial driver located at
4130f5675aa5SRon Madrid		drivers/serial/ns16550.c.  This option is useful for saving
4131f5675aa5SRon Madrid		space for already greatly restricted images, including but not
4132f5675aa5SRon Madrid		limited to NAND_SPL configurations.
4133f5675aa5SRon Madrid
4134b2b92f53SSimon Glass- CONFIG_DISPLAY_BOARDINFO
4135b2b92f53SSimon Glass		Display information about the board that U-Boot is running on
4136b2b92f53SSimon Glass		when U-Boot starts up. The board function checkboard() is called
4137b2b92f53SSimon Glass		to do this.
4138b2b92f53SSimon Glass
4139e2e3e2b1SSimon Glass- CONFIG_DISPLAY_BOARDINFO_LATE
4140e2e3e2b1SSimon Glass		Similar to the previous option, but display this information
4141e2e3e2b1SSimon Glass		later, once stdio is running and output goes to the LCD, if
4142e2e3e2b1SSimon Glass		present.
4143e2e3e2b1SSimon Glass
4144c609719bSwdenkLow Level (hardware related) configuration options:
4145dc7c9a1aSwdenk---------------------------------------------------
4146c609719bSwdenk
41476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE:
4148c609719bSwdenk		Cache Line Size of the CPU.
4149c609719bSwdenk
41506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR:
4151c609719bSwdenk		Default address of the IMMR after system reset.
41522535d602Swdenk
41532535d602Swdenk		Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
41542535d602Swdenk		and RPXsuper) to be able to adjust the position of
41552535d602Swdenk		the IMMR register after a reset.
4156c609719bSwdenk
4157e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_DEFAULT:
4158e46fedfeSTimur Tabi		Default (power-on reset) physical address of CCSR on Freescale
4159e46fedfeSTimur Tabi		PowerPC SOCs.
4160e46fedfeSTimur Tabi
4161e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR:
4162e46fedfeSTimur Tabi		Virtual address of CCSR.  On a 32-bit build, this is typically
4163e46fedfeSTimur Tabi		the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4164e46fedfeSTimur Tabi
4165e46fedfeSTimur Tabi		CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4166e46fedfeSTimur Tabi		for cross-platform code that uses that macro instead.
4167e46fedfeSTimur Tabi
4168e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS:
4169e46fedfeSTimur Tabi		Physical address of CCSR.  CCSR can be relocated to a new
4170e46fedfeSTimur Tabi		physical address, if desired.  In this case, this macro should
4171e46fedfeSTimur Tabi		be set to that address.	 Otherwise, it should be set to the
4172e46fedfeSTimur Tabi		same value as CONFIG_SYS_CCSRBAR_DEFAULT.  For example, CCSR
4173e46fedfeSTimur Tabi		is typically relocated on 36-bit builds.  It is recommended
4174e46fedfeSTimur Tabi		that this macro be defined via the _HIGH and _LOW macros:
4175e46fedfeSTimur Tabi
4176e46fedfeSTimur Tabi		#define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4177e46fedfeSTimur Tabi			* 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4178e46fedfeSTimur Tabi
4179e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
4180e46fedfeSTimur Tabi		Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS.	This value is typically
4181e46fedfeSTimur Tabi		either 0 (32-bit build) or 0xF (36-bit build).	This macro is
4182e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
4183e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
4184e46fedfeSTimur Tabi
4185e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4186e46fedfeSTimur Tabi		Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS.  This macro is
4187e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
4188e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
4189e46fedfeSTimur Tabi
4190e46fedfeSTimur Tabi- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4191e46fedfeSTimur Tabi		If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4192e46fedfeSTimur Tabi		forced to a value that ensures that CCSR is not relocated.
4193e46fedfeSTimur Tabi
41947f6c2cbcSwdenk- Floppy Disk Support:
41956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER
41967f6c2cbcSwdenk
41977f6c2cbcSwdenk		the default drive number (default value 0)
41987f6c2cbcSwdenk
41996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_STRIDE
42007f6c2cbcSwdenk
420111ccc33fSMarcel Ziswiler		defines the spacing between FDC chipset registers
42027f6c2cbcSwdenk		(default value 1)
42037f6c2cbcSwdenk
42046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_OFFSET
42057f6c2cbcSwdenk
42067f6c2cbcSwdenk		defines the offset of register from address. It
42077f6c2cbcSwdenk		depends on which part of the data bus is connected to
420811ccc33fSMarcel Ziswiler		the FDC chipset. (default value 0)
42097f6c2cbcSwdenk
42106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
42116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
42127f6c2cbcSwdenk		default value.
42137f6c2cbcSwdenk
42146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		if CONFIG_SYS_FDC_HW_INIT is defined, then the function
42157f6c2cbcSwdenk		fdc_hw_init() is called at the beginning of the FDC
42167f6c2cbcSwdenk		setup. fdc_hw_init() must be provided by the board
42177f6c2cbcSwdenk		source code. It is used to make hardware dependant
42187f6c2cbcSwdenk		initializations.
42197f6c2cbcSwdenk
42200abddf82SMacpaul Lin- CONFIG_IDE_AHB:
42210abddf82SMacpaul Lin		Most IDE controllers were designed to be connected with PCI
42220abddf82SMacpaul Lin		interface. Only few of them were designed for AHB interface.
42230abddf82SMacpaul Lin		When software is doing ATA command and data transfer to
42240abddf82SMacpaul Lin		IDE devices through IDE-AHB controller, some additional
42250abddf82SMacpaul Lin		registers accessing to these kind of IDE-AHB controller
42260abddf82SMacpaul Lin		is requierd.
42270abddf82SMacpaul Lin
42286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR:	Physical address of the Internal Memory.
422925d6712aSwdenk		DO NOT CHANGE unless you know exactly what you're
423025d6712aSwdenk		doing! (11-4) [MPC8xx/82xx systems only]
4231c609719bSwdenk
42326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR:
4233c609719bSwdenk
42347152b1d0Swdenk		Start address of memory area that can be used for
4235c609719bSwdenk		initial data and stack; please note that this must be
4236c609719bSwdenk		writable memory that is working WITHOUT special
4237c609719bSwdenk		initialization, i. e. you CANNOT use normal RAM which
4238c609719bSwdenk		will become available only after programming the
4239c609719bSwdenk		memory controller and running certain initialization
4240c609719bSwdenk		sequences.
4241c609719bSwdenk
4242c609719bSwdenk		U-Boot uses the following memory types:
4243c609719bSwdenk		- MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4244c609719bSwdenk		- MPC824X: data cache
4245c609719bSwdenk		- PPC4xx:  data cache
4246c609719bSwdenk
42476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET:
4248c609719bSwdenk
4249c609719bSwdenk		Offset of the initial data structure in the memory
42506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
42516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
4252c609719bSwdenk		data is located at the end of the available space
4253553f0982SWolfgang Denk		(sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
42546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
42556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
42566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET) downward.
4257c609719bSwdenk
4258c609719bSwdenk	Note:
4259c609719bSwdenk		On the MPC824X (or other systems that use the data
4260c609719bSwdenk		cache for initial memory) the address chosen for
42616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
4262c609719bSwdenk		point to an otherwise UNUSED address space between
4263c609719bSwdenk		the top of RAM and the start of the PCI space.
4264c609719bSwdenk
42656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR:	SIU Module Configuration (11-6)
4266c609719bSwdenk
42676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR:	System Protection Control (11-9)
4268c609719bSwdenk
42696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR:	Time Base Status and Control (11-26)
4270c609719bSwdenk
42716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR:	Periodic Interrupt Status and Control (11-31)
4272c609719bSwdenk
42736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR:	PLL, Low-Power, and Reset Control Register (15-30)
4274c609719bSwdenk
42756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR:	System Clock and reset Control Register (15-27)
4276c609719bSwdenk
42776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM:
4278c609719bSwdenk		SDRAM timing
4279c609719bSwdenk
42806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA:
4281c609719bSwdenk		periodic timer for refresh
4282c609719bSwdenk
42836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER:	Debug Event Register (37-47)
4284c609719bSwdenk
42856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
42866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
42876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
42886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_BR1_PRELIM:
4289c609719bSwdenk		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4290c609719bSwdenk
4291c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
42926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
42936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
4294c609719bSwdenk		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4295c609719bSwdenk
42966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
42976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
4298c609719bSwdenk		Machine Mode Register and Memory Periodic Timer
4299c609719bSwdenk		Prescaler definitions (SDRAM timing)
4300c609719bSwdenk
43016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
4302c609719bSwdenk		enable I2C microcode relocation patch (MPC8xx);
4303c609719bSwdenk		define relocation offset in DPRAM [DSP2]
4304c609719bSwdenk
43056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
4306b423d055SHeiko Schocher		enable SMC microcode relocation patch (MPC8xx);
4307b423d055SHeiko Schocher		define relocation offset in DPRAM [SMC1]
4308b423d055SHeiko Schocher
43096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
4310c609719bSwdenk		enable SPI microcode relocation patch (MPC8xx);
4311c609719bSwdenk		define relocation offset in DPRAM [SCC4]
4312c609719bSwdenk
43136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_USE_OSCCLK:
4314c609719bSwdenk		Use OSCM clock mode on MBX8xx board. Be careful,
4315c609719bSwdenk		wrong setting might damage your board. Read
4316c609719bSwdenk		doc/README.MBX before setting this variable!
4317c609719bSwdenk
43186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
4319ea909b76Swdenk		Offset of the bootmode word in DPRAM used by post
4320ea909b76Swdenk		(Power On Self Tests). This definition overrides
4321ea909b76Swdenk		#define'd default value in commproc.h resp.
4322ea909b76Swdenk		cpm_8260.h.
4323ea909b76Swdenk
43246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
43256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
43266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
43276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
43286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
43296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
43306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
43316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
4332a47a12beSStefan Roese		Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
43335d232d0eSwdenk
43349cacf4fcSDirk Eibach- CONFIG_PCI_DISABLE_PCIE:
43359cacf4fcSDirk Eibach		Disable PCI-Express on systems where it is supported but not
43369cacf4fcSDirk Eibach		required.
43379cacf4fcSDirk Eibach
433869fd2d3bSAndrew Sharp- CONFIG_PCI_ENUM_ONLY
433969fd2d3bSAndrew Sharp		Only scan through and get the devices on the busses.
434069fd2d3bSAndrew Sharp		Don't do any setup work, presumably because someone or
434169fd2d3bSAndrew Sharp		something has already done it, and we don't need to do it
434269fd2d3bSAndrew Sharp		a second time.	Useful for platforms that are pre-booted
434369fd2d3bSAndrew Sharp		by coreboot or similar.
434469fd2d3bSAndrew Sharp
4345842033e6SGabor Juhos- CONFIG_PCI_INDIRECT_BRIDGE:
4346842033e6SGabor Juhos		Enable support for indirect PCI bridges.
4347842033e6SGabor Juhos
4348a09b9b68SKumar Gala- CONFIG_SYS_SRIO:
4349a09b9b68SKumar Gala		Chip has SRIO or not
4350a09b9b68SKumar Gala
4351a09b9b68SKumar Gala- CONFIG_SRIO1:
4352a09b9b68SKumar Gala		Board has SRIO 1 port available
4353a09b9b68SKumar Gala
4354a09b9b68SKumar Gala- CONFIG_SRIO2:
4355a09b9b68SKumar Gala		Board has SRIO 2 port available
4356a09b9b68SKumar Gala
4357c8b28152SLiu Gang- CONFIG_SRIO_PCIE_BOOT_MASTER
4358c8b28152SLiu Gang		Board can support master function for Boot from SRIO and PCIE
4359c8b28152SLiu Gang
4360a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_VIRT:
4361a09b9b68SKumar Gala		Virtual Address of SRIO port 'n' memory region
4362a09b9b68SKumar Gala
4363a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_PHYS:
4364a09b9b68SKumar Gala		Physical Address of SRIO port 'n' memory region
4365a09b9b68SKumar Gala
4366a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_SIZE:
4367a09b9b68SKumar Gala		Size of SRIO port 'n' memory region
4368a09b9b68SKumar Gala
436966bd1846SFabio Estevam- CONFIG_SYS_NAND_BUSWIDTH_16BIT
437066bd1846SFabio Estevam		Defined to tell the NAND controller that the NAND chip is using
437166bd1846SFabio Estevam		a 16 bit bus.
437266bd1846SFabio Estevam		Not all NAND drivers use this symbol.
4373a430e916SFabio Estevam		Example of drivers that use it:
437466bd1846SFabio Estevam		- drivers/mtd/nand/ndfc.c
4375a430e916SFabio Estevam		- drivers/mtd/nand/mxc_nand.c
4376eced4626SAlex Waterman
4377eced4626SAlex Waterman- CONFIG_SYS_NDFC_EBC0_CFG
4378eced4626SAlex Waterman		Sets the EBC0_CFG register for the NDFC. If not defined
4379eced4626SAlex Waterman		a default value will be used.
4380eced4626SAlex Waterman
4381bb99ad6dSBen Warren- CONFIG_SPD_EEPROM
4382218ca724SWolfgang Denk		Get DDR timing information from an I2C EEPROM. Common
4383218ca724SWolfgang Denk		with pluggable memory modules such as SODIMMs
4384218ca724SWolfgang Denk
4385bb99ad6dSBen Warren  SPD_EEPROM_ADDRESS
4386bb99ad6dSBen Warren		I2C address of the SPD EEPROM
4387bb99ad6dSBen Warren
43886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM
4389218ca724SWolfgang Denk		If SPD EEPROM is on an I2C bus other than the first
4390218ca724SWolfgang Denk		one, specify here. Note that the value must resolve
4391218ca724SWolfgang Denk		to something your driver can deal with.
4392bb99ad6dSBen Warren
43931b3e3c4fSYork Sun- CONFIG_SYS_DDR_RAW_TIMING
43941b3e3c4fSYork Sun		Get DDR timing information from other than SPD. Common with
43951b3e3c4fSYork Sun		soldered DDR chips onboard without SPD. DDR raw timing
43961b3e3c4fSYork Sun		parameters are extracted from datasheet and hard-coded into
43971b3e3c4fSYork Sun		header files or board specific files.
43981b3e3c4fSYork Sun
43996f5e1dc5SYork Sun- CONFIG_FSL_DDR_INTERACTIVE
44006f5e1dc5SYork Sun		Enable interactive DDR debugging. See doc/README.fsl-ddr.
44016f5e1dc5SYork Sun
44026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0
4403218ca724SWolfgang Denk		Only for 83xx systems. If specified, then DDR should
4404218ca724SWolfgang Denk		be configured using CS0 and CS1 instead of CS2 and CS3.
44052ad6b513STimur Tabi
4406c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12]
4407c26e454dSwdenk		Define to enable FEC[12] on a 8xx series processor.
4408c26e454dSwdenk
4409c26e454dSwdenk- CONFIG_FEC[12]_PHY
4410c26e454dSwdenk		Define to the hardcoded PHY address which corresponds
44116e592385Swdenk		to the given FEC; i. e.
4412c26e454dSwdenk			#define CONFIG_FEC1_PHY 4
4413c26e454dSwdenk		means that the PHY with address 4 is connected to FEC1
4414c26e454dSwdenk
4415c26e454dSwdenk		When set to -1, means to probe for first available.
4416c26e454dSwdenk
4417c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR
4418c26e454dSwdenk		The PHY does not have a RXERR line (RMII only).
4419c26e454dSwdenk		(so program the FEC to ignore it).
4420c26e454dSwdenk
4421c26e454dSwdenk- CONFIG_RMII
4422c26e454dSwdenk		Enable RMII mode for all FECs.
4423c26e454dSwdenk		Note that this is a global option, we can't
4424c26e454dSwdenk		have one FEC in standard MII mode and another in RMII mode.
4425c26e454dSwdenk
44265cf91d6bSwdenk- CONFIG_CRC32_VERIFY
44275cf91d6bSwdenk		Add a verify option to the crc32 command.
44285cf91d6bSwdenk		The syntax is:
44295cf91d6bSwdenk
44305cf91d6bSwdenk		=> crc32 -v <address> <count> <crc32>
44315cf91d6bSwdenk
44325cf91d6bSwdenk		Where address/count indicate a memory area
44335cf91d6bSwdenk		and crc32 is the correct crc32 which the
44345cf91d6bSwdenk		area should have.
44355cf91d6bSwdenk
443656523f12Swdenk- CONFIG_LOOPW
443756523f12Swdenk		Add the "loopw" memory command. This only takes effect if
4438602ad3b3SJon Loeliger		the memory commands are activated globally (CONFIG_CMD_MEM).
443956523f12Swdenk
44407b466641Sstroese- CONFIG_MX_CYCLIC
44417b466641Sstroese		Add the "mdc" and "mwc" memory commands. These are cyclic
44427b466641Sstroese		"md/mw" commands.
44437b466641Sstroese		Examples:
44447b466641Sstroese
44457b466641Sstroese		=> mdc.b 10 4 500
44467b466641Sstroese		This command will print 4 bytes (10,11,12,13) each 500 ms.
44477b466641Sstroese
44487b466641Sstroese		=> mwc.l 100 12345678 10
44497b466641Sstroese		This command will write 12345678 to address 100 all 10 ms.
44507b466641Sstroese
44517b466641Sstroese		This only takes effect if the memory commands are activated
4452602ad3b3SJon Loeliger		globally (CONFIG_CMD_MEM).
44537b466641Sstroese
44548aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT
4455afc1ce82SMacpaul Lin		[ARM, NDS32, MIPS only] If this variable is defined, then certain
4456e03f3169SWolfgang Denk		low level initializations (like setting up the memory
4457e03f3169SWolfgang Denk		controller) are omitted and/or U-Boot does not
4458e03f3169SWolfgang Denk		relocate itself into RAM.
44598aa1a2d1Swdenk
4460e03f3169SWolfgang Denk		Normally this variable MUST NOT be defined. The only
4461e03f3169SWolfgang Denk		exception is when U-Boot is loaded (to RAM) by some
4462e03f3169SWolfgang Denk		other boot loader or by a debugger which performs
4463e03f3169SWolfgang Denk		these initializations itself.
44648aa1a2d1Swdenk
4465401bb30bSAneesh V- CONFIG_SPL_BUILD
4466df81238bSMagnus Lilja		Modifies the behaviour of start.S when compiling a loader
4467df81238bSMagnus Lilja		that is executed before the actual U-Boot. E.g. when
4468df81238bSMagnus Lilja		compiling a NAND SPL.
4469400558b5Swdenk
44703aa29de0SYing Zhang- CONFIG_TPL_BUILD
44713aa29de0SYing Zhang		Modifies the behaviour of start.S  when compiling a loader
44723aa29de0SYing Zhang		that is executed after the SPL and before the actual U-Boot.
44733aa29de0SYing Zhang		It is loaded by the SPL.
44743aa29de0SYing Zhang
44755df572f0SYing Zhang- CONFIG_SYS_MPC85XX_NO_RESETVEC
44765df572f0SYing Zhang		Only for 85xx systems. If this variable is specified, the section
44775df572f0SYing Zhang		.resetvec is not kept and the section .bootpg is placed in the
44785df572f0SYing Zhang		previous 4k of the .text section.
44795df572f0SYing Zhang
44804213fc29SSimon Glass- CONFIG_ARCH_MAP_SYSMEM
44814213fc29SSimon Glass		Generally U-Boot (and in particular the md command) uses
44824213fc29SSimon Glass		effective address. It is therefore not necessary to regard
44834213fc29SSimon Glass		U-Boot address as virtual addresses that need to be translated
44844213fc29SSimon Glass		to physical addresses. However, sandbox requires this, since
44854213fc29SSimon Glass		it maintains its own little RAM buffer which contains all
44864213fc29SSimon Glass		addressable memory. This option causes some memory accesses
44874213fc29SSimon Glass		to be mapped through map_sysmem() / unmap_sysmem().
44884213fc29SSimon Glass
4489d8834a13SMatthias Weisser- CONFIG_USE_ARCH_MEMCPY
4490d8834a13SMatthias Weisser  CONFIG_USE_ARCH_MEMSET
4491d8834a13SMatthias Weisser		If these options are used a optimized version of memcpy/memset will
4492d8834a13SMatthias Weisser		be used if available. These functions may be faster under some
4493d8834a13SMatthias Weisser		conditions but may increase the binary size.
4494d8834a13SMatthias Weisser
4495588a13f7SSimon Glass- CONFIG_X86_RESET_VECTOR
4496588a13f7SSimon Glass		If defined, the x86 reset vector code is included. This is not
4497588a13f7SSimon Glass		needed when U-Boot is running from Coreboot.
4498b16f521aSGabe Black
4499fc33705eSMark Jackson- CONFIG_SYS_MPUCLK
4500fc33705eSMark Jackson		Defines the MPU clock speed (in MHz).
4501fc33705eSMark Jackson
4502fc33705eSMark Jackson		NOTE : currently only supported on AM335x platforms.
45035b5ece9eSGabe Black
450416678eb4SHeiko Schocher- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
450516678eb4SHeiko Schocher		Enables the RTC32K OSC on AM33xx based plattforms
450616678eb4SHeiko Schocher
4507f2717b47STimur TabiFreescale QE/FMAN Firmware Support:
4508f2717b47STimur Tabi-----------------------------------
4509f2717b47STimur Tabi
4510f2717b47STimur TabiThe Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4511f2717b47STimur Tabiloading of "firmware", which is encoded in the QE firmware binary format.
4512f2717b47STimur TabiThis firmware often needs to be loaded during U-Boot booting, so macros
4513f2717b47STimur Tabiare used to identify the storage device (NOR flash, SPI, etc) and the address
4514f2717b47STimur Tabiwithin that device.
4515f2717b47STimur Tabi
4516dcf1d774SZhao Qiang- CONFIG_SYS_FMAN_FW_ADDR
4517dcf1d774SZhao Qiang	The address in the storage device where the FMAN microcode is located.  The
4518dcf1d774SZhao Qiang	meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4519dcf1d774SZhao Qiang	is also specified.
4520dcf1d774SZhao Qiang
4521dcf1d774SZhao Qiang- CONFIG_SYS_QE_FW_ADDR
4522dcf1d774SZhao Qiang	The address in the storage device where the QE microcode is located.  The
4523f2717b47STimur Tabi	meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4524f2717b47STimur Tabi	is also specified.
4525f2717b47STimur Tabi
4526f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_LENGTH
4527f2717b47STimur Tabi	The maximum possible size of the firmware.  The firmware binary format
4528f2717b47STimur Tabi	has a field that specifies the actual size of the firmware, but it
4529f2717b47STimur Tabi	might not be possible to read any part of the firmware unless some
4530f2717b47STimur Tabi	local storage is allocated to hold the entire firmware first.
4531f2717b47STimur Tabi
4532f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4533f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4534f2717b47STimur Tabi	normal addressable memory via the LBC.  CONFIG_SYS_FMAN_FW_ADDR is the
4535f2717b47STimur Tabi	virtual address in NOR flash.
4536f2717b47STimur Tabi
4537f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4538f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NAND flash.
4539f2717b47STimur Tabi	CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4540f2717b47STimur Tabi
4541f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4542f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SD/MMC
4543f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4544f2717b47STimur Tabi
4545f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
4546f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SPI
4547f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4548f2717b47STimur Tabi
4549292dc6c5SLiu Gang- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4550292dc6c5SLiu Gang	Specifies that QE/FMAN firmware is located in the remote (master)
4551292dc6c5SLiu Gang	memory space.	CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
4552fc54c7faSLiu Gang	can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4553fc54c7faSLiu Gang	window->master inbound window->master LAW->the ucode address in
4554fc54c7faSLiu Gang	master's memory space.
4555f2717b47STimur Tabi
4556c609719bSwdenkBuilding the Software:
4557c609719bSwdenk======================
4558c609719bSwdenk
4559218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments
4560218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support
4561218ca724SWolfgang Denkall possibly existing versions of cross development tools in all
4562218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we
4563218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4564218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot.
4565c609719bSwdenk
4566218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you
4567218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case,
4568218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell.
4569218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are
4570218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter:
4571c609719bSwdenk
4572218ca724SWolfgang Denk	$ CROSS_COMPILE=ppc_4xx-
4573218ca724SWolfgang Denk	$ export CROSS_COMPILE
4574c609719bSwdenk
45752f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in
45762f8d396bSPeter Tyser      the tools directory you can use the MinGW toolchain
45772f8d396bSPeter Tyser      (http://www.mingw.org).  Set your HOST tools to the MinGW
45782f8d396bSPeter Tyser      toolchain and execute 'make tools'.  For example:
45792f8d396bSPeter Tyser
45802f8d396bSPeter Tyser       $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
45812f8d396bSPeter Tyser
45822f8d396bSPeter Tyser      Binaries such as tools/mkimage.exe will be created which can
45832f8d396bSPeter Tyser      be executed on computers running Windows.
45842f8d396bSPeter Tyser
4585c609719bSwdenkU-Boot is intended to be simple to build. After installing the
4586c609719bSwdenksources you must configure U-Boot for one specific board type. This
4587c609719bSwdenkis done by typing:
4588c609719bSwdenk
4589c609719bSwdenk	make NAME_config
4590c609719bSwdenk
4591218ca724SWolfgang Denkwhere "NAME_config" is the name of one of the existing configu-
45924d675ae6SMichael Jonesrations; see boards.cfg for supported names.
459354387ac9Swdenk
4594c609719bSwdenkNote: for some board special configuration names may exist; check if
4595c609719bSwdenk      additional information is available from the board vendor; for
45962729af9dSwdenk      instance, the TQM823L systems are available without (standard)
45972729af9dSwdenk      or with LCD support. You can select such additional "features"
459811ccc33fSMarcel Ziswiler      when choosing the configuration, i. e.
4599c609719bSwdenk
46002729af9dSwdenk      make TQM823L_config
46012729af9dSwdenk	- will configure for a plain TQM823L, i. e. no LCD support
4602c609719bSwdenk
4603c609719bSwdenk      make TQM823L_LCD_config
4604c609719bSwdenk	- will configure for a TQM823L with U-Boot console on LCD
4605c609719bSwdenk
4606c609719bSwdenk      etc.
4607c609719bSwdenk
4608c609719bSwdenk
4609c609719bSwdenkFinally, type "make all", and you should get some working U-Boot
46107152b1d0Swdenkimages ready for download to / installation on your system:
4611c609719bSwdenk
4612c609719bSwdenk- "u-boot.bin" is a raw binary image
4613c609719bSwdenk- "u-boot" is an image in ELF binary format
4614c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format
4615c609719bSwdenk
4616baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved
4617baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change
4618baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory:
4619baf31249SMarian Balakowicz
4620baf31249SMarian Balakowicz1. Add O= to the make command line invocations:
4621baf31249SMarian Balakowicz
4622baf31249SMarian Balakowicz	make O=/tmp/build distclean
4623baf31249SMarian Balakowicz	make O=/tmp/build NAME_config
4624baf31249SMarian Balakowicz	make O=/tmp/build all
4625baf31249SMarian Balakowicz
4626baf31249SMarian Balakowicz2. Set environment variable BUILD_DIR to point to the desired location:
4627baf31249SMarian Balakowicz
4628baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
4629baf31249SMarian Balakowicz	make distclean
4630baf31249SMarian Balakowicz	make NAME_config
4631baf31249SMarian Balakowicz	make all
4632baf31249SMarian Balakowicz
4633baf31249SMarian BalakowiczNote that the command line "O=" setting overrides the BUILD_DIR environment
4634baf31249SMarian Balakowiczvariable.
4635baf31249SMarian Balakowicz
4636c609719bSwdenk
4637c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so
4638c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of
4639c609719bSwdenknative "make".
4640c609719bSwdenk
4641c609719bSwdenk
4642c609719bSwdenkIf the system board that you have is not listed, then you will need
4643c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these
4644c609719bSwdenksteps:
4645c609719bSwdenk
4646c609719bSwdenk1.  Add a new configuration option for your board to the toplevel
46474d675ae6SMichael Jones    "boards.cfg" file, using the existing entries as examples.
46484d675ae6SMichael Jones    Follow the instructions there to keep the boards in order.
4649c609719bSwdenk2.  Create a new directory to hold your board specific code. Add any
465085ec0bccSwdenk    files you need. In your board directory, you will need at least
465185ec0bccSwdenk    the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
465285ec0bccSwdenk3.  Create a new configuration file "include/configs/<board>.h" for
465385ec0bccSwdenk    your board
4654c609719bSwdenk3.  If you're porting U-Boot to a new CPU, then also create a new
4655c609719bSwdenk    directory to hold your CPU specific code. Add any files you need.
465685ec0bccSwdenk4.  Run "make <board>_config" with your new name.
4657c609719bSwdenk5.  Type "make", and you should get a working "u-boot.srec" file
4658c609719bSwdenk    to be installed on your target system.
465985ec0bccSwdenk6.  Debug and solve any problems that might arise.
4660c609719bSwdenk    [Of course, this last step is much harder than it sounds.]
4661c609719bSwdenk
4662c609719bSwdenk
4663c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.:
4664c609719bSwdenk==============================================================
4665c609719bSwdenk
4666c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board
4667c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to
4668c609719bSwdenkprovide feedback to the other developers. The feedback normally takes
4669c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest
4670218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources.
4671c609719bSwdenk
4672c609719bSwdenkBut before you submit such a patch, please verify that your modifi-
4673c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of
4674c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so,
4675c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot
4676c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You can
46777152b1d0Swdenkselect which (cross) compiler to use by passing a `CROSS_COMPILE'
4678218ca724SWolfgang Denkenvironment variable to the script, i. e. to use the ELDK cross tools
4679218ca724SWolfgang Denkyou can type
4680c609719bSwdenk
4681c609719bSwdenk	CROSS_COMPILE=ppc_8xx- MAKEALL
4682c609719bSwdenk
4683c609719bSwdenkor to build on a native PowerPC system you can type
4684c609719bSwdenk
4685c609719bSwdenk	CROSS_COMPILE=' ' MAKEALL
4686c609719bSwdenk
4687218ca724SWolfgang DenkWhen using the MAKEALL script, the default behaviour is to build
4688218ca724SWolfgang DenkU-Boot in the source directory. This location can be changed by
4689218ca724SWolfgang Denksetting the BUILD_DIR environment variable. Also, for each target
4690218ca724SWolfgang Denkbuilt, the MAKEALL script saves two log files (<target>.ERR and
4691218ca724SWolfgang Denk<target>.MAKEALL) in the <source dir>/LOG directory. This default
4692218ca724SWolfgang Denklocation can be changed by setting the MAKEALL_LOGDIR environment
4693218ca724SWolfgang Denkvariable. For example:
4694baf31249SMarian Balakowicz
4695baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
4696baf31249SMarian Balakowicz	export MAKEALL_LOGDIR=/tmp/log
4697baf31249SMarian Balakowicz	CROSS_COMPILE=ppc_8xx- MAKEALL
4698baf31249SMarian Balakowicz
4699218ca724SWolfgang DenkWith the above settings build objects are saved in the /tmp/build,
4700218ca724SWolfgang Denklog files are saved in the /tmp/log and the source tree remains clean
4701218ca724SWolfgang Denkduring the whole build process.
4702baf31249SMarian Balakowicz
4703baf31249SMarian Balakowicz
4704c609719bSwdenkSee also "U-Boot Porting Guide" below.
4705c609719bSwdenk
4706c609719bSwdenk
4707c609719bSwdenkMonitor Commands - Overview:
4708c609719bSwdenk============================
4709c609719bSwdenk
4710c609719bSwdenkgo	- start application at address 'addr'
4711c609719bSwdenkrun	- run commands in an environment variable
4712c609719bSwdenkbootm	- boot application image from memory
4713c609719bSwdenkbootp	- boot image via network using BootP/TFTP protocol
471444f074c7SMarek Vasutbootz   - boot zImage from memory
4715c609719bSwdenktftpboot- boot image via network using TFTP protocol
4716c609719bSwdenk	       and env variables "ipaddr" and "serverip"
4717c609719bSwdenk	       (and eventually "gatewayip")
47181fb7cd49SSimon Glasstftpput - upload a file via network using TFTP protocol
4719c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol
4720c609719bSwdenkdiskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
4721c609719bSwdenkloads	- load S-Record file over serial line
4722c609719bSwdenkloadb	- load binary file over serial line (kermit mode)
4723c609719bSwdenkmd	- memory display
4724c609719bSwdenkmm	- memory modify (auto-incrementing)
4725c609719bSwdenknm	- memory modify (constant address)
4726c609719bSwdenkmw	- memory write (fill)
4727c609719bSwdenkcp	- memory copy
4728c609719bSwdenkcmp	- memory compare
4729c609719bSwdenkcrc32	- checksum calculation
47300f89c54bSPeter Tyseri2c	- I2C sub-system
4731c609719bSwdenksspi	- SPI utility commands
4732c609719bSwdenkbase	- print or set address offset
4733c609719bSwdenkprintenv- print environment variables
4734c609719bSwdenksetenv	- set environment variables
4735c609719bSwdenksaveenv - save environment variables to persistent storage
4736c609719bSwdenkprotect - enable or disable FLASH write protection
4737c609719bSwdenkerase	- erase FLASH memory
4738c609719bSwdenkflinfo	- print FLASH memory information
473910635afaSKarl O. Pincnand	- NAND memory operations (see doc/README.nand)
4740c609719bSwdenkbdinfo	- print Board Info structure
4741c609719bSwdenkiminfo	- print header information for application image
4742c609719bSwdenkconinfo - print console devices and informations
4743c609719bSwdenkide	- IDE sub-system
4744c609719bSwdenkloop	- infinite loop on address range
474556523f12Swdenkloopw	- infinite write loop on address range
4746c609719bSwdenkmtest	- simple RAM test
4747c609719bSwdenkicache	- enable or disable instruction cache
4748c609719bSwdenkdcache	- enable or disable data cache
4749c609719bSwdenkreset	- Perform RESET of the CPU
4750c609719bSwdenkecho	- echo args to console
4751c609719bSwdenkversion - print monitor version
4752c609719bSwdenkhelp	- print online help
4753c609719bSwdenk?	- alias for 'help'
4754c609719bSwdenk
4755c609719bSwdenk
4756c609719bSwdenkMonitor Commands - Detailed Description:
4757c609719bSwdenk========================================
4758c609719bSwdenk
4759c609719bSwdenkTODO.
4760c609719bSwdenk
4761c609719bSwdenkFor now: just type "help <command>".
4762c609719bSwdenk
4763c609719bSwdenk
4764c609719bSwdenkEnvironment Variables:
4765c609719bSwdenk======================
4766c609719bSwdenk
4767c609719bSwdenkU-Boot supports user configuration using Environment Variables which
4768c609719bSwdenkcan be made persistent by saving to Flash memory.
4769c609719bSwdenk
4770c609719bSwdenkEnvironment Variables are set using "setenv", printed using
4771c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv"
4772c609719bSwdenkwithout a value can be used to delete a variable from the
4773c609719bSwdenkenvironment. As long as you don't save the environment you are
4774c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the
4775c609719bSwdenkenvironment is erased by accident, a default environment is provided.
4776c609719bSwdenk
4777c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables.
4778c96f86eeSWolfgang Denk
4779c96f86eeSWolfgang DenkList of environment variables (most likely not complete):
4780c609719bSwdenk
4781c609719bSwdenk  baudrate	- see CONFIG_BAUDRATE
4782c609719bSwdenk
4783c609719bSwdenk  bootdelay	- see CONFIG_BOOTDELAY
4784c609719bSwdenk
4785c609719bSwdenk  bootcmd	- see CONFIG_BOOTCOMMAND
4786c609719bSwdenk
4787c609719bSwdenk  bootargs	- Boot arguments when booting an RTOS image
4788c609719bSwdenk
4789c609719bSwdenk  bootfile	- Name of the image to load with TFTP
4790c609719bSwdenk
47917d721e34SBartlomiej Sieka  bootm_low	- Memory range available for image processing in the bootm
47927d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
47937d721e34SBartlomiej Sieka		  a hexadecimal number and defines lowest address allowed
47947d721e34SBartlomiej Sieka		  for use by the bootm command. See also "bootm_size"
47957d721e34SBartlomiej Sieka		  environment variable. Address defined by "bootm_low" is
47967d721e34SBartlomiej Sieka		  also the base of the initial memory mapping for the Linux
4797c3624e6eSGrant Likely		  kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4798c3624e6eSGrant Likely		  bootm_mapsize.
4799c3624e6eSGrant Likely
4800c3624e6eSGrant Likely  bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
4801c3624e6eSGrant Likely		  This variable is given as a hexadecimal number and it
4802c3624e6eSGrant Likely		  defines the size of the memory region starting at base
4803c3624e6eSGrant Likely		  address bootm_low that is accessible by the Linux kernel
4804c3624e6eSGrant Likely		  during early boot.  If unset, CONFIG_SYS_BOOTMAPSZ is used
4805c3624e6eSGrant Likely		  as the default value if it is defined, and bootm_size is
4806c3624e6eSGrant Likely		  used otherwise.
48077d721e34SBartlomiej Sieka
48087d721e34SBartlomiej Sieka  bootm_size	- Memory range available for image processing in the bootm
48097d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
48107d721e34SBartlomiej Sieka		  a hexadecimal number and defines the size of the region
48117d721e34SBartlomiej Sieka		  allowed for use by the bootm command. See also "bootm_low"
48127d721e34SBartlomiej Sieka		  environment variable.
48137d721e34SBartlomiej Sieka
48144bae9090SBartlomiej Sieka  updatefile	- Location of the software update file on a TFTP server, used
48154bae9090SBartlomiej Sieka		  by the automatic software update feature. Please refer to
48164bae9090SBartlomiej Sieka		  documentation in doc/README.update for more details.
48174bae9090SBartlomiej Sieka
4818c609719bSwdenk  autoload	- if set to "no" (any string beginning with 'n'),
4819c609719bSwdenk		  "bootp" will just load perform a lookup of the
4820c609719bSwdenk		  configuration from the BOOTP server, but not try to
4821c609719bSwdenk		  load any image using TFTP
4822c609719bSwdenk
4823c609719bSwdenk  autostart	- if set to "yes", an image loaded using the "bootp",
4824c609719bSwdenk		  "rarpboot", "tftpboot" or "diskboot" commands will
4825c609719bSwdenk		  be automatically started (by internally calling
4826c609719bSwdenk		  "bootm")
4827c609719bSwdenk
48284a6fd34bSwdenk		  If set to "no", a standalone image passed to the
48294a6fd34bSwdenk		  "bootm" command will be copied to the load address
48304a6fd34bSwdenk		  (and eventually uncompressed), but NOT be started.
48314a6fd34bSwdenk		  This can be used to load and uncompress arbitrary
48324a6fd34bSwdenk		  data.
48334a6fd34bSwdenk
4834a28afca5SDavid A. Long  fdt_high	- if set this restricts the maximum address that the
4835a28afca5SDavid A. Long		  flattened device tree will be copied into upon boot.
4836fa34f6b2SShawn Guo		  For example, if you have a system with 1 GB memory
4837fa34f6b2SShawn Guo		  at physical address 0x10000000, while Linux kernel
4838fa34f6b2SShawn Guo		  only recognizes the first 704 MB as low memory, you
4839fa34f6b2SShawn Guo		  may need to set fdt_high as 0x3C000000 to have the
4840fa34f6b2SShawn Guo		  device tree blob be copied to the maximum address
4841fa34f6b2SShawn Guo		  of the 704 MB low memory, so that Linux kernel can
4842fa34f6b2SShawn Guo		  access it during the boot procedure.
4843fa34f6b2SShawn Guo
4844a28afca5SDavid A. Long		  If this is set to the special value 0xFFFFFFFF then
4845a28afca5SDavid A. Long		  the fdt will not be copied at all on boot.  For this
4846a28afca5SDavid A. Long		  to work it must reside in writable memory, have
4847a28afca5SDavid A. Long		  sufficient padding on the end of it for u-boot to
4848a28afca5SDavid A. Long		  add the information it needs into it, and the memory
4849a28afca5SDavid A. Long		  must be accessible by the kernel.
4850a28afca5SDavid A. Long
4851eea63e05SSimon Glass  fdtcontroladdr- if set this is the address of the control flattened
4852eea63e05SSimon Glass		  device tree used by U-Boot when CONFIG_OF_CONTROL is
4853eea63e05SSimon Glass		  defined.
4854eea63e05SSimon Glass
485517ea1177Swdenk  i2cfast	- (PPC405GP|PPC405EP only)
485617ea1177Swdenk		  if set to 'y' configures Linux I2C driver for fast
485717ea1177Swdenk		  mode (400kHZ). This environment variable is used in
485817ea1177Swdenk		  initialization code. So, for changes to be effective
485917ea1177Swdenk		  it must be saved and board must be reset.
486017ea1177Swdenk
4861c609719bSwdenk  initrd_high	- restrict positioning of initrd images:
4862c609719bSwdenk		  If this variable is not set, initrd images will be
4863c609719bSwdenk		  copied to the highest possible address in RAM; this
4864c609719bSwdenk		  is usually what you want since it allows for
4865c609719bSwdenk		  maximum initrd size. If for some reason you want to
4866c609719bSwdenk		  make sure that the initrd image is loaded below the
48676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		  CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
4868c609719bSwdenk		  variable to a value of "no" or "off" or "0".
4869c609719bSwdenk		  Alternatively, you can set it to a maximum upper
4870c609719bSwdenk		  address to use (U-Boot will still check that it
4871c609719bSwdenk		  does not overwrite the U-Boot stack and data).
4872c609719bSwdenk
4873c609719bSwdenk		  For instance, when you have a system with 16 MB
48747152b1d0Swdenk		  RAM, and want to reserve 4 MB from use by Linux,
4875c609719bSwdenk		  you can do this by adding "mem=12M" to the value of
4876c609719bSwdenk		  the "bootargs" variable. However, now you must make
48777152b1d0Swdenk		  sure that the initrd image is placed in the first
4878c609719bSwdenk		  12 MB as well - this can be done with
4879c609719bSwdenk
4880c609719bSwdenk		  setenv initrd_high 00c00000
4881c609719bSwdenk
488238b99261Swdenk		  If you set initrd_high to 0xFFFFFFFF, this is an
488338b99261Swdenk		  indication to U-Boot that all addresses are legal
488438b99261Swdenk		  for the Linux kernel, including addresses in flash
488538b99261Swdenk		  memory. In this case U-Boot will NOT COPY the
488638b99261Swdenk		  ramdisk at all. This may be useful to reduce the
488738b99261Swdenk		  boot time on your system, but requires that this
488838b99261Swdenk		  feature is supported by your Linux kernel.
488938b99261Swdenk
4890c609719bSwdenk  ipaddr	- IP address; needed for tftpboot command
4891c609719bSwdenk
4892c609719bSwdenk  loadaddr	- Default load address for commands like "bootp",
4893dc7c9a1aSwdenk		  "rarpboot", "tftpboot", "loadb" or "diskboot"
4894c609719bSwdenk
4895c609719bSwdenk  loads_echo	- see CONFIG_LOADS_ECHO
4896c609719bSwdenk
4897c609719bSwdenk  serverip	- TFTP server IP address; needed for tftpboot command
4898c609719bSwdenk
4899c609719bSwdenk  bootretry	- see CONFIG_BOOT_RETRY_TIME
4900c609719bSwdenk
4901c609719bSwdenk  bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
4902c609719bSwdenk
4903c609719bSwdenk  bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
4904c609719bSwdenk
4905e2a53458SMike Frysinger  ethprime	- controls which interface is used first.
4906a3d991bdSwdenk
4907e2a53458SMike Frysinger  ethact	- controls which interface is currently active.
4908e2a53458SMike Frysinger		  For example you can do the following
4909a3d991bdSwdenk
491048690d80SHeiko Schocher		  => setenv ethact FEC
491148690d80SHeiko Schocher		  => ping 192.168.0.1 # traffic sent on FEC
491248690d80SHeiko Schocher		  => setenv ethact SCC
491348690d80SHeiko Schocher		  => ping 10.0.0.1 # traffic sent on SCC
4914a3d991bdSwdenk
4915e1692577SMatthias Fuchs  ethrotate	- When set to "no" U-Boot does not go through all
4916e1692577SMatthias Fuchs		  available network interfaces.
4917e1692577SMatthias Fuchs		  It just stays at the currently selected interface.
4918e1692577SMatthias Fuchs
4919a3d991bdSwdenk  netretry	- When set to "no" each network operation will
4920a3d991bdSwdenk		  either succeed or fail without retrying.
49216e592385Swdenk		  When set to "once" the network operation will
49226e592385Swdenk		  fail when all the available network interfaces
49236e592385Swdenk		  are tried once without success.
4924a3d991bdSwdenk		  Useful on scripts which control the retry operation
4925a3d991bdSwdenk		  themselves.
4926a3d991bdSwdenk
4927b4e2f89dSJean-Christophe PLAGNIOL-VILLARD  npe_ucode	- set load address for the NPE microcode
4928a1cf027aSJean-Christophe PLAGNIOL-VILLARD
49298d51aacdSSimon Glass  silent_linux  - If set then linux will be told to boot silently, by
49308d51aacdSSimon Glass		  changing the console to be empty. If "yes" it will be
49318d51aacdSSimon Glass		  made silent. If "no" it will not be made silent. If
49328d51aacdSSimon Glass		  unset, then it will be made silent if the U-Boot console
49338d51aacdSSimon Glass		  is silent.
49348d51aacdSSimon Glass
493528cb9375SWolfgang Denk  tftpsrcport	- If this is set, the value is used for TFTP's
4936ecb0ccd9SWolfgang Denk		  UDP source port.
4937ecb0ccd9SWolfgang Denk
493828cb9375SWolfgang Denk  tftpdstport	- If this is set, the value is used for TFTP's UDP
493928cb9375SWolfgang Denk		  destination port instead of the Well Know Port 69.
494028cb9375SWolfgang Denk
4941c96f86eeSWolfgang Denk  tftpblocksize - Block size to use for TFTP transfers; if not set,
4942c96f86eeSWolfgang Denk		  we use the TFTP server's default block size
4943c96f86eeSWolfgang Denk
4944c96f86eeSWolfgang Denk  tftptimeout	- Retransmission timeout for TFTP packets (in milli-
4945c96f86eeSWolfgang Denk		  seconds, minimum value is 1000 = 1 second). Defines
4946c96f86eeSWolfgang Denk		  when a packet is considered to be lost so it has to
4947c96f86eeSWolfgang Denk		  be retransmitted. The default is 5000 = 5 seconds.
4948c96f86eeSWolfgang Denk		  Lowering this value may make downloads succeed
4949c96f86eeSWolfgang Denk		  faster in networks with high packet loss rates or
4950c96f86eeSWolfgang Denk		  with unreliable TFTP servers.
4951c96f86eeSWolfgang Denk
4952a3d991bdSwdenk  vlan		- When set to a value < 4095 the traffic over
495311ccc33fSMarcel Ziswiler		  Ethernet is encapsulated/received over 802.1q
4954a3d991bdSwdenk		  VLAN tagged frames.
4955c609719bSwdenk
4956dc0b7b0eSJason HobbsThe following image location variables contain the location of images
4957dc0b7b0eSJason Hobbsused in booting. The "Image" column gives the role of the image and is
4958dc0b7b0eSJason Hobbsnot an environment variable name. The other columns are environment
4959dc0b7b0eSJason Hobbsvariable names. "File Name" gives the name of the file on a TFTP
4960dc0b7b0eSJason Hobbsserver, "RAM Address" gives the location in RAM the image will be
4961dc0b7b0eSJason Hobbsloaded to, and "Flash Location" gives the image's address in NOR
4962dc0b7b0eSJason Hobbsflash or offset in NAND flash.
4963dc0b7b0eSJason Hobbs
4964dc0b7b0eSJason Hobbs*Note* - these variables don't have to be defined for all boards, some
4965dc0b7b0eSJason Hobbsboards currenlty use other variables for these purposes, and some
4966dc0b7b0eSJason Hobbsboards use these variables for other purposes.
4967dc0b7b0eSJason Hobbs
4968dc0b7b0eSJason HobbsImage		    File Name	     RAM Address       Flash Location
4969dc0b7b0eSJason Hobbs-----		    ---------	     -----------       --------------
4970dc0b7b0eSJason Hobbsu-boot		    u-boot	     u-boot_addr_r     u-boot_addr
4971dc0b7b0eSJason HobbsLinux kernel	    bootfile	     kernel_addr_r     kernel_addr
4972dc0b7b0eSJason Hobbsdevice tree blob    fdtfile	     fdt_addr_r	       fdt_addr
4973dc0b7b0eSJason Hobbsramdisk		    ramdiskfile	     ramdisk_addr_r    ramdisk_addr
4974dc0b7b0eSJason Hobbs
4975c609719bSwdenkThe following environment variables may be used and automatically
4976c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"),
4977c609719bSwdenkdepending the information provided by your boot server:
4978c609719bSwdenk
4979c609719bSwdenk  bootfile	- see above
4980c609719bSwdenk  dnsip		- IP address of your Domain Name Server
4981fe389a82Sstroese  dnsip2	- IP address of your secondary Domain Name Server
4982c609719bSwdenk  gatewayip	- IP address of the Gateway (Router) to use
4983c609719bSwdenk  hostname	- Target hostname
4984c609719bSwdenk  ipaddr	- see above
4985c609719bSwdenk  netmask	- Subnet Mask
4986c609719bSwdenk  rootpath	- Pathname of the root filesystem on the NFS server
4987c609719bSwdenk  serverip	- see above
4988c609719bSwdenk
4989c609719bSwdenk
4990c609719bSwdenkThere are two special Environment Variables:
4991c609719bSwdenk
4992c609719bSwdenk  serial#	- contains hardware identification information such
4993c609719bSwdenk		  as type string and/or serial number
4994c609719bSwdenk  ethaddr	- Ethernet address
4995c609719bSwdenk
4996c609719bSwdenkThese variables can be set only once (usually during manufacturing of
4997c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables
4998c609719bSwdenkonce they have been set once.
4999c609719bSwdenk
5000c609719bSwdenk
5001c1551ea8SstroeseFurther special Environment Variables:
5002c1551ea8Sstroese
5003c1551ea8Sstroese  ver		- Contains the U-Boot version string as printed
5004c1551ea8Sstroese		  with the "version" command. This variable is
5005c1551ea8Sstroese		  readonly (see CONFIG_VERSION_VARIABLE).
5006c1551ea8Sstroese
5007c1551ea8Sstroese
5008c609719bSwdenkPlease note that changes to some configuration parameters may take
5009c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-).
5010c609719bSwdenk
5011c609719bSwdenk
5012170ab110SJoe HershbergerCallback functions for environment variables:
5013170ab110SJoe Hershberger---------------------------------------------
5014170ab110SJoe Hershberger
5015170ab110SJoe HershbergerFor some environment variables, the behavior of u-boot needs to change
5016170ab110SJoe Hershbergerwhen their values are changed.  This functionailty allows functions to
5017170ab110SJoe Hershbergerbe associated with arbitrary variables.  On creation, overwrite, or
5018170ab110SJoe Hershbergerdeletion, the callback will provide the opportunity for some side
5019170ab110SJoe Hershbergereffect to happen or for the change to be rejected.
5020170ab110SJoe Hershberger
5021170ab110SJoe HershbergerThe callbacks are named and associated with a function using the
5022170ab110SJoe HershbergerU_BOOT_ENV_CALLBACK macro in your board or driver code.
5023170ab110SJoe Hershberger
5024170ab110SJoe HershbergerThese callbacks are associated with variables in one of two ways.  The
5025170ab110SJoe Hershbergerstatic list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
5026170ab110SJoe Hershbergerin the board configuration to a string that defines a list of
5027170ab110SJoe Hershbergerassociations.  The list must be in the following format:
5028170ab110SJoe Hershberger
5029170ab110SJoe Hershberger	entry = variable_name[:callback_name]
5030170ab110SJoe Hershberger	list = entry[,list]
5031170ab110SJoe Hershberger
5032170ab110SJoe HershbergerIf the callback name is not specified, then the callback is deleted.
5033170ab110SJoe HershbergerSpaces are also allowed anywhere in the list.
5034170ab110SJoe Hershberger
5035170ab110SJoe HershbergerCallbacks can also be associated by defining the ".callbacks" variable
5036170ab110SJoe Hershbergerwith the same list format above.  Any association in ".callbacks" will
5037170ab110SJoe Hershbergeroverride any association in the static list. You can define
5038170ab110SJoe HershbergerCONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
5039170ab110SJoe Hershberger".callbacks" envirnoment variable in the default or embedded environment.
5040170ab110SJoe Hershberger
5041170ab110SJoe Hershberger
5042f07771ccSwdenkCommand Line Parsing:
5043f07771ccSwdenk=====================
5044f07771ccSwdenk
5045f07771ccSwdenkThere are two different command line parsers available with U-Boot:
50467152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell:
5047f07771ccSwdenk
5048f07771ccSwdenkOld, simple command line parser:
5049f07771ccSwdenk--------------------------------
5050f07771ccSwdenk
5051f07771ccSwdenk- supports environment variables (through setenv / saveenv commands)
5052f07771ccSwdenk- several commands on one line, separated by ';'
5053fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax
5054f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\',
5055f07771ccSwdenk  for example:
5056fe126d8bSWolfgang Denk	setenv bootcmd bootm \${address}
5057f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example:
5058f07771ccSwdenk	setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
5059f07771ccSwdenk
5060f07771ccSwdenkHush shell:
5061f07771ccSwdenk-----------
5062f07771ccSwdenk
5063f07771ccSwdenk- similar to Bourne shell, with control structures like
5064f07771ccSwdenk  if...then...else...fi, for...do...done; while...do...done,
5065f07771ccSwdenk  until...do...done, ...
5066f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv
5067f07771ccSwdenk  commands) and local shell variables (through standard shell syntax
5068f07771ccSwdenk  "name=value"); only environment variables can be used with "run"
5069f07771ccSwdenk  command
5070f07771ccSwdenk
5071f07771ccSwdenkGeneral rules:
5072f07771ccSwdenk--------------
5073f07771ccSwdenk
5074f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run"
5075f07771ccSwdenk    command) contains several commands separated by semicolon, and
5076f07771ccSwdenk    one of these commands fails, then the remaining commands will be
5077f07771ccSwdenk    executed anyway.
5078f07771ccSwdenk
5079f07771ccSwdenk(2) If you execute several variables with one call to run (i. e.
508011ccc33fSMarcel Ziswiler    calling run with a list of variables as arguments), any failing
5081f07771ccSwdenk    command will cause "run" to terminate, i. e. the remaining
5082f07771ccSwdenk    variables are not executed.
5083f07771ccSwdenk
5084c609719bSwdenkNote for Redundant Ethernet Interfaces:
5085c609719bSwdenk=======================================
5086c609719bSwdenk
508711ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports
5088c609719bSwdenksuch configurations and is capable of automatic selection of a
50897152b1d0Swdenk"working" interface when needed. MAC assignment works as follows:
5090c609719bSwdenk
5091c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding
5092c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0),
5093c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ...
5094c609719bSwdenk
5095c609719bSwdenkIf the network interface stores some valid MAC address (for instance
5096c609719bSwdenkin SROM), this is used as default address if there is NO correspon-
5097c609719bSwdenkding setting in the environment; if the corresponding environment
5098c609719bSwdenkvariable is set, this overrides the settings in the card; that means:
5099c609719bSwdenk
5100c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the
5101c609719bSwdenk  environment, the SROM's address is used.
5102c609719bSwdenk
5103c609719bSwdenko If there is no valid address in the SROM, and a definition in the
5104c609719bSwdenk  environment exists, then the value from the environment variable is
5105c609719bSwdenk  used.
5106c609719bSwdenk
5107c609719bSwdenko If both the SROM and the environment contain a MAC address, and
5108c609719bSwdenk  both addresses are the same, this MAC address is used.
5109c609719bSwdenk
5110c609719bSwdenko If both the SROM and the environment contain a MAC address, and the
5111c609719bSwdenk  addresses differ, the value from the environment is used and a
5112c609719bSwdenk  warning is printed.
5113c609719bSwdenk
5114c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error
5115c609719bSwdenk  is raised.
5116c609719bSwdenk
5117ecee9324SBen WarrenIf Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
5118ecee9324SBen Warrenwill be programmed into hardware as part of the initialization process.	 This
5119ecee9324SBen Warrenmay be skipped by setting the appropriate 'ethmacskip' environment variable.
5120ecee9324SBen WarrenThe naming convention is as follows:
5121ecee9324SBen Warren"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
5122c609719bSwdenk
5123c609719bSwdenkImage Formats:
5124c609719bSwdenk==============
5125c609719bSwdenk
51263310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on)
51273310c549SMarian Balakowiczimages in two formats:
51283310c549SMarian Balakowicz
51293310c549SMarian BalakowiczNew uImage format (FIT)
51303310c549SMarian Balakowicz-----------------------
51313310c549SMarian Balakowicz
51323310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar
51333310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple
51343310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by
51353310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
51363310c549SMarian Balakowicz
51373310c549SMarian Balakowicz
51383310c549SMarian BalakowiczOld uImage format
51393310c549SMarian Balakowicz-----------------
51403310c549SMarian Balakowicz
51413310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything,
51423310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for
51433310c549SMarian Balakowiczdetails; basically, the header defines the following image properties:
5144c609719bSwdenk
5145c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5146c609719bSwdenk  4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
5147f5ed9e39SPeter Tyser  LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5148f5ed9e39SPeter Tyser  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5149f5ed9e39SPeter Tyser  INTEGRITY).
51507b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
5151afc1ce82SMacpaul Lin  IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5152afc1ce82SMacpaul Lin  Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
5153c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2)
5154c609719bSwdenk* Load Address
5155c609719bSwdenk* Entry Point
5156c609719bSwdenk* Image Name
5157c609719bSwdenk* Image Timestamp
5158c609719bSwdenk
5159c609719bSwdenkThe header is marked by a special Magic Number, and both the header
5160c609719bSwdenkand the data portions of the image are secured against corruption by
5161c609719bSwdenkCRC32 checksums.
5162c609719bSwdenk
5163c609719bSwdenk
5164c609719bSwdenkLinux Support:
5165c609719bSwdenk==============
5166c609719bSwdenk
5167c609719bSwdenkAlthough U-Boot should support any OS or standalone application
51687152b1d0Swdenkeasily, the main focus has always been on Linux during the design of
5169c609719bSwdenkU-Boot.
5170c609719bSwdenk
5171c609719bSwdenkU-Boot includes many features that so far have been part of some
5172c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any
5173c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image;
5174c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation
51757152b1d0Swdenkserves several purposes:
5176c609719bSwdenk
5177c609719bSwdenk- the same features can be used for other OS or standalone
5178c609719bSwdenk  applications (for instance: using compressed images to reduce the
5179c609719bSwdenk  Flash memory footprint)
5180c609719bSwdenk
5181c609719bSwdenk- it becomes much easier to port new Linux kernel versions because
51827152b1d0Swdenk  lots of low-level, hardware dependent stuff are done by U-Boot
5183c609719bSwdenk
5184c609719bSwdenk- the same Linux kernel image can now be used with different "initrd"
5185c609719bSwdenk  images; of course this also means that different kernel images can
5186c609719bSwdenk  be run with the same "initrd". This makes testing easier (you don't
5187c609719bSwdenk  have to build a new "zImage.initrd" Linux image when you just
5188c609719bSwdenk  change a file in your "initrd"). Also, a field-upgrade of the
5189c609719bSwdenk  software is easier now.
5190c609719bSwdenk
5191c609719bSwdenk
5192c609719bSwdenkLinux HOWTO:
5193c609719bSwdenk============
5194c609719bSwdenk
5195c609719bSwdenkPorting Linux to U-Boot based systems:
5196c609719bSwdenk---------------------------------------
5197c609719bSwdenk
5198c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to
5199c609719bSwdenkconfigure the Linux device drivers for use with your target hardware
5200c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to
5201c609719bSwdenkLinux :-).
5202c609719bSwdenk
5203a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
5204c609719bSwdenk
5205c609719bSwdenkJust make sure your machine specific header file (for instance
5206c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board
52071dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h,
52081dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value
52096d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR.
5210c609719bSwdenk
5211c609719bSwdenk
5212c609719bSwdenkConfiguring the Linux kernel:
5213c609719bSwdenk-----------------------------
5214c609719bSwdenk
5215c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root
5216c609719bSwdenkdevice (initial ramdisk, NFS) for your target system.
5217c609719bSwdenk
5218c609719bSwdenk
5219c609719bSwdenkBuilding a Linux Image:
5220c609719bSwdenk-----------------------
5221c609719bSwdenk
522224ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are
522324ee89b9Swdenknot used. If you use recent kernel source, a new build target
522424ee89b9Swdenk"uImage" will exist which automatically builds an image usable by
522524ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target,
522624ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a
522724ee89b9Swdenk100% compatible format.
5228c609719bSwdenk
5229c609719bSwdenkExample:
5230c609719bSwdenk
5231c609719bSwdenk	make TQM850L_config
5232c609719bSwdenk	make oldconfig
5233c609719bSwdenk	make dep
523424ee89b9Swdenk	make uImage
5235c609719bSwdenk
523624ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to
523724ee89b9Swdenkencapsulate a compressed Linux kernel image with header	 information,
523824ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing:
5239c609719bSwdenk
524024ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format):
524124ee89b9Swdenk
524224ee89b9Swdenk* convert the kernel into a raw binary image:
524324ee89b9Swdenk
524424ee89b9Swdenk	${CROSS_COMPILE}-objcopy -O binary \
524524ee89b9Swdenk				 -R .note -R .comment \
524624ee89b9Swdenk				 -S vmlinux linux.bin
524724ee89b9Swdenk
524824ee89b9Swdenk* compress the binary image:
524924ee89b9Swdenk
525024ee89b9Swdenk	gzip -9 linux.bin
525124ee89b9Swdenk
525224ee89b9Swdenk* package compressed binary image for U-Boot:
525324ee89b9Swdenk
525424ee89b9Swdenk	mkimage -A ppc -O linux -T kernel -C gzip \
525524ee89b9Swdenk		-a 0 -e 0 -n "Linux Kernel Image" \
525624ee89b9Swdenk		-d linux.bin.gz uImage
525724ee89b9Swdenk
525824ee89b9Swdenk
525924ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use
526024ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or
526124ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64
526224ee89b9Swdenkbyte header containing information about target architecture,
526324ee89b9Swdenkoperating system, image type, compression method, entry points, time
526424ee89b9Swdenkstamp, CRC32 checksums, etc.
526524ee89b9Swdenk
526624ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and
526724ee89b9Swdenkprint the header information, or to build new images.
5268c609719bSwdenk
5269c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information
5270c609719bSwdenkcontained in the header of an existing U-Boot image; this includes
5271c609719bSwdenkchecksum verification:
5272c609719bSwdenk
5273c609719bSwdenk	tools/mkimage -l image
5274c609719bSwdenk	  -l ==> list image header information
5275c609719bSwdenk
5276c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image
5277c609719bSwdenkfrom a "data file" which is used as image payload:
5278c609719bSwdenk
5279c609719bSwdenk	tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5280c609719bSwdenk		      -n name -d data_file image
5281c609719bSwdenk	  -A ==> set architecture to 'arch'
5282c609719bSwdenk	  -O ==> set operating system to 'os'
5283c609719bSwdenk	  -T ==> set image type to 'type'
5284c609719bSwdenk	  -C ==> set compression type 'comp'
5285c609719bSwdenk	  -a ==> set load address to 'addr' (hex)
5286c609719bSwdenk	  -e ==> set entry point to 'ep' (hex)
5287c609719bSwdenk	  -n ==> set image name to 'name'
5288c609719bSwdenk	  -d ==> use image data from 'datafile'
5289c609719bSwdenk
529069459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load
529169459791Swdenkaddress (0x00000000), but the entry point address depends on the
529269459791Swdenkkernel version:
5293c609719bSwdenk
5294c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C,
529524ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000.
5296c609719bSwdenk
5297c609719bSwdenkSo a typical call to build a U-Boot image would read:
5298c609719bSwdenk
529924ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
530024ee89b9Swdenk	> -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
5301a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
530224ee89b9Swdenk	> examples/uImage.TQM850L
530324ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5304c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5305c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
5306c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
5307c609719bSwdenk	Load Address: 0x00000000
530824ee89b9Swdenk	Entry Point:  0x00000000
5309c609719bSwdenk
5310c609719bSwdenkTo verify the contents of the image (or check for corruption):
5311c609719bSwdenk
531224ee89b9Swdenk	-> tools/mkimage -l examples/uImage.TQM850L
531324ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5314c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5315c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
5316c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
5317c609719bSwdenk	Load Address: 0x00000000
531824ee89b9Swdenk	Entry Point:  0x00000000
5319c609719bSwdenk
5320c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade
5321c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this
5322c609719bSwdenkneeds more space in Flash, but boots much faster since it does not
5323c609719bSwdenkneed to be uncompressed:
5324c609719bSwdenk
5325a47a12beSStefan Roese	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
532624ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
532724ee89b9Swdenk	> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
5328a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
532924ee89b9Swdenk	> examples/uImage.TQM850L-uncompressed
533024ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5331c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5332c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (uncompressed)
5333c609719bSwdenk	Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
5334c609719bSwdenk	Load Address: 0x00000000
533524ee89b9Swdenk	Entry Point:  0x00000000
5336c609719bSwdenk
5337c609719bSwdenk
5338c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file
5339c609719bSwdenkwhen your kernel is intended to use an initial ramdisk:
5340c609719bSwdenk
5341c609719bSwdenk	-> tools/mkimage -n 'Simple Ramdisk Image' \
5342c609719bSwdenk	> -A ppc -O linux -T ramdisk -C gzip \
5343c609719bSwdenk	> -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5344c609719bSwdenk	Image Name:   Simple Ramdisk Image
5345c609719bSwdenk	Created:      Wed Jan 12 14:01:50 2000
5346c609719bSwdenk	Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
5347c609719bSwdenk	Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
5348c609719bSwdenk	Load Address: 0x00000000
5349c609719bSwdenk	Entry Point:  0x00000000
5350c609719bSwdenk
5351a804b5ceSGuilherme Maciel FerreiraThe "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5352a804b5ceSGuilherme Maciel Ferreiraoption performs the converse operation of the mkimage's second form (the "-d"
5353a804b5ceSGuilherme Maciel Ferreiraoption). Given an image built by mkimage, the dumpimage extracts a "data file"
5354a804b5ceSGuilherme Maciel Ferreirafrom the image:
5355a804b5ceSGuilherme Maciel Ferreira
5356a804b5ceSGuilherme Maciel Ferreira	tools/dumpimage -i image -p position data_file
5357a804b5ceSGuilherme Maciel Ferreira	  -i ==> extract from the 'image' a specific 'data_file', \
5358a804b5ceSGuilherme Maciel Ferreira	   indexed by 'position'
5359a804b5ceSGuilherme Maciel Ferreira
5360c609719bSwdenk
5361c609719bSwdenkInstalling a Linux Image:
5362c609719bSwdenk-------------------------
5363c609719bSwdenk
5364c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface,
5365c609719bSwdenkyou must convert the image to S-Record format:
5366c609719bSwdenk
5367c609719bSwdenk	objcopy -I binary -O srec examples/image examples/image.srec
5368c609719bSwdenk
5369c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot
5370c609719bSwdenkimage header, so the resulting S-Record file will be relative to
5371c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to
5372c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads'
5373c609719bSwdenkcommand.
5374c609719bSwdenk
5375c609719bSwdenkExample: install the image to address 0x40100000 (which on the
5376c609719bSwdenkTQM8xxL is in the first Flash bank):
5377c609719bSwdenk
5378c609719bSwdenk	=> erase 40100000 401FFFFF
5379c609719bSwdenk
5380c609719bSwdenk	.......... done
5381c609719bSwdenk	Erased 8 sectors
5382c609719bSwdenk
5383c609719bSwdenk	=> loads 40100000
5384c609719bSwdenk	## Ready for S-Record download ...
5385c609719bSwdenk	~>examples/image.srec
5386c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5387c609719bSwdenk	...
5388c609719bSwdenk	15989 15990 15991 15992
5389c609719bSwdenk	[file transfer complete]
5390c609719bSwdenk	[connected]
5391c609719bSwdenk	## Start Addr = 0x00000000
5392c609719bSwdenk
5393c609719bSwdenk
5394c609719bSwdenkYou can check the success of the download using the 'iminfo' command;
5395c609719bSwdenkthis includes a checksum verification so you can be sure no data
5396c609719bSwdenkcorruption happened:
5397c609719bSwdenk
5398c609719bSwdenk	=> imi 40100000
5399c609719bSwdenk
5400c609719bSwdenk	## Checking Image at 40100000 ...
5401c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5402c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5403c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5404c609719bSwdenk	   Load Address: 00000000
5405c609719bSwdenk	   Entry Point:	 0000000c
5406c609719bSwdenk	   Verifying Checksum ... OK
5407c609719bSwdenk
5408c609719bSwdenk
5409c609719bSwdenkBoot Linux:
5410c609719bSwdenk-----------
5411c609719bSwdenk
5412c609719bSwdenkThe "bootm" command is used to boot an application that is stored in
5413c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents
5414c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as
5415c609719bSwdenkparameters. You can check and modify this variable using the
5416c609719bSwdenk"printenv" and "setenv" commands:
5417c609719bSwdenk
5418c609719bSwdenk
5419c609719bSwdenk	=> printenv bootargs
5420c609719bSwdenk	bootargs=root=/dev/ram
5421c609719bSwdenk
5422c609719bSwdenk	=> setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5423c609719bSwdenk
5424c609719bSwdenk	=> printenv bootargs
5425c609719bSwdenk	bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5426c609719bSwdenk
5427c609719bSwdenk	=> bootm 40020000
5428c609719bSwdenk	## Booting Linux kernel at 40020000 ...
5429c609719bSwdenk	   Image Name:	 2.2.13 for NFS on TQM850L
5430c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5431c609719bSwdenk	   Data Size:	 381681 Bytes = 372 kB = 0 MB
5432c609719bSwdenk	   Load Address: 00000000
5433c609719bSwdenk	   Entry Point:	 0000000c
5434c609719bSwdenk	   Verifying Checksum ... OK
5435c609719bSwdenk	   Uncompressing Kernel Image ... OK
5436c609719bSwdenk	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
5437c609719bSwdenk	Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5438c609719bSwdenk	time_init: decrementer frequency = 187500000/60
5439c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
5440c609719bSwdenk	Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5441c609719bSwdenk	...
5442c609719bSwdenk
544311ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass
54447152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT
5445c609719bSwdenkformat!) to the "bootm" command:
5446c609719bSwdenk
5447c609719bSwdenk	=> imi 40100000 40200000
5448c609719bSwdenk
5449c609719bSwdenk	## Checking Image at 40100000 ...
5450c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5451c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5452c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5453c609719bSwdenk	   Load Address: 00000000
5454c609719bSwdenk	   Entry Point:	 0000000c
5455c609719bSwdenk	   Verifying Checksum ... OK
5456c609719bSwdenk
5457c609719bSwdenk	## Checking Image at 40200000 ...
5458c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
5459c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
5460c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
5461c609719bSwdenk	   Load Address: 00000000
5462c609719bSwdenk	   Entry Point:	 00000000
5463c609719bSwdenk	   Verifying Checksum ... OK
5464c609719bSwdenk
5465c609719bSwdenk	=> bootm 40100000 40200000
5466c609719bSwdenk	## Booting Linux kernel at 40100000 ...
5467c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5468c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5469c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5470c609719bSwdenk	   Load Address: 00000000
5471c609719bSwdenk	   Entry Point:	 0000000c
5472c609719bSwdenk	   Verifying Checksum ... OK
5473c609719bSwdenk	   Uncompressing Kernel Image ... OK
5474c609719bSwdenk	## Loading RAMDisk Image at 40200000 ...
5475c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
5476c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
5477c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
5478c609719bSwdenk	   Load Address: 00000000
5479c609719bSwdenk	   Entry Point:	 00000000
5480c609719bSwdenk	   Verifying Checksum ... OK
5481c609719bSwdenk	   Loading Ramdisk ... OK
5482c609719bSwdenk	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
5483c609719bSwdenk	Boot arguments: root=/dev/ram
5484c609719bSwdenk	time_init: decrementer frequency = 187500000/60
5485c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
5486c609719bSwdenk	...
5487c609719bSwdenk	RAMDISK: Compressed image found at block 0
5488c609719bSwdenk	VFS: Mounted root (ext2 filesystem).
5489c609719bSwdenk
5490c609719bSwdenk	bash#
5491c609719bSwdenk
54920267768eSMatthew McClintockBoot Linux and pass a flat device tree:
54930267768eSMatthew McClintock-----------
54940267768eSMatthew McClintock
54950267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section
54960267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The
54970267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated
54980267768eSMatthew McClintockflat device tree:
54990267768eSMatthew McClintock
55000267768eSMatthew McClintock=> print oftaddr
55010267768eSMatthew McClintockoftaddr=0x300000
55020267768eSMatthew McClintock=> print oft
55030267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb
55040267768eSMatthew McClintock=> tftp $oftaddr $oft
55050267768eSMatthew McClintockSpeed: 1000, full duplex
55060267768eSMatthew McClintockUsing TSEC0 device
55070267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101
55080267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'.
55090267768eSMatthew McClintockLoad address: 0x300000
55100267768eSMatthew McClintockLoading: #
55110267768eSMatthew McClintockdone
55120267768eSMatthew McClintockBytes transferred = 4106 (100a hex)
55130267768eSMatthew McClintock=> tftp $loadaddr $bootfile
55140267768eSMatthew McClintockSpeed: 1000, full duplex
55150267768eSMatthew McClintockUsing TSEC0 device
55160267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2
55170267768eSMatthew McClintockFilename 'uImage'.
55180267768eSMatthew McClintockLoad address: 0x200000
55190267768eSMatthew McClintockLoading:############
55200267768eSMatthew McClintockdone
55210267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex)
55220267768eSMatthew McClintock=> print loadaddr
55230267768eSMatthew McClintockloadaddr=200000
55240267768eSMatthew McClintock=> print oftaddr
55250267768eSMatthew McClintockoftaddr=0x300000
55260267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr
55270267768eSMatthew McClintock## Booting image at 00200000 ...
55280267768eSMatthew McClintock   Image Name:	 Linux-2.6.17-dirty
55290267768eSMatthew McClintock   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
55300267768eSMatthew McClintock   Data Size:	 1029343 Bytes = 1005.2 kB
55310267768eSMatthew McClintock   Load Address: 00000000
55320267768eSMatthew McClintock   Entry Point:	 00000000
55330267768eSMatthew McClintock   Verifying Checksum ... OK
55340267768eSMatthew McClintock   Uncompressing Kernel Image ... OK
55350267768eSMatthew McClintockBooting using flat device tree at 0x300000
55360267768eSMatthew McClintockUsing MPC85xx ADS machine description
55370267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
55380267768eSMatthew McClintock[snip]
55390267768eSMatthew McClintock
55400267768eSMatthew McClintock
55416069ff26SwdenkMore About U-Boot Image Types:
55426069ff26Swdenk------------------------------
55436069ff26Swdenk
55446069ff26SwdenkU-Boot supports the following image types:
55456069ff26Swdenk
55466069ff26Swdenk   "Standalone Programs" are directly runnable in the environment
55476069ff26Swdenk	provided by U-Boot; it is expected that (if they behave
55486069ff26Swdenk	well) you can continue to work in U-Boot after return from
55496069ff26Swdenk	the Standalone Program.
55506069ff26Swdenk   "OS Kernel Images" are usually images of some Embedded OS which
55516069ff26Swdenk	will take over control completely. Usually these programs
55526069ff26Swdenk	will install their own set of exception handlers, device
55536069ff26Swdenk	drivers, set up the MMU, etc. - this means, that you cannot
55546069ff26Swdenk	expect to re-enter U-Boot except by resetting the CPU.
55556069ff26Swdenk   "RAMDisk Images" are more or less just data blocks, and their
55566069ff26Swdenk	parameters (address, size) are passed to an OS kernel that is
55576069ff26Swdenk	being started.
55586069ff26Swdenk   "Multi-File Images" contain several images, typically an OS
55596069ff26Swdenk	(Linux) kernel image and one or more data images like
55606069ff26Swdenk	RAMDisks. This construct is useful for instance when you want
55616069ff26Swdenk	to boot over the network using BOOTP etc., where the boot
55626069ff26Swdenk	server provides just a single image file, but you want to get
55636069ff26Swdenk	for instance an OS kernel and a RAMDisk image.
55646069ff26Swdenk
55656069ff26Swdenk	"Multi-File Images" start with a list of image sizes, each
55666069ff26Swdenk	image size (in bytes) specified by an "uint32_t" in network
55676069ff26Swdenk	byte order. This list is terminated by an "(uint32_t)0".
55686069ff26Swdenk	Immediately after the terminating 0 follow the images, one by
55696069ff26Swdenk	one, all aligned on "uint32_t" boundaries (size rounded up to
55706069ff26Swdenk	a multiple of 4 bytes).
55716069ff26Swdenk
55726069ff26Swdenk   "Firmware Images" are binary images containing firmware (like
55736069ff26Swdenk	U-Boot or FPGA images) which usually will be programmed to
55746069ff26Swdenk	flash memory.
55756069ff26Swdenk
55766069ff26Swdenk   "Script files" are command sequences that will be executed by
55776069ff26Swdenk	U-Boot's command interpreter; this feature is especially
55786069ff26Swdenk	useful when you configure U-Boot to use a real shell (hush)
55796069ff26Swdenk	as command interpreter.
55806069ff26Swdenk
558144f074c7SMarek VasutBooting the Linux zImage:
558244f074c7SMarek Vasut-------------------------
558344f074c7SMarek Vasut
558444f074c7SMarek VasutOn some platforms, it's possible to boot Linux zImage. This is done
558544f074c7SMarek Vasutusing the "bootz" command. The syntax of "bootz" command is the same
558644f074c7SMarek Vasutas the syntax of "bootm" command.
558744f074c7SMarek Vasut
55888ac28563STom RiniNote, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
5589017e1f3fSMarek Vasutkernel with raw initrd images. The syntax is slightly different, the
5590017e1f3fSMarek Vasutaddress of the initrd must be augmented by it's size, in the following
5591017e1f3fSMarek Vasutformat: "<initrd addres>:<initrd size>".
5592017e1f3fSMarek Vasut
5593c609719bSwdenk
5594c609719bSwdenkStandalone HOWTO:
5595c609719bSwdenk=================
5596c609719bSwdenk
5597c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and
5598c609719bSwdenkrun "standalone" applications, which can use some resources of
5599c609719bSwdenkU-Boot like console I/O functions or interrupt services.
5600c609719bSwdenk
5601c609719bSwdenkTwo simple examples are included with the sources:
5602c609719bSwdenk
5603c609719bSwdenk"Hello World" Demo:
5604c609719bSwdenk-------------------
5605c609719bSwdenk
5606c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo
5607c609719bSwdenkapplication; it is automatically compiled when you build U-Boot.
5608c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it
5609c609719bSwdenklike that:
5610c609719bSwdenk
5611c609719bSwdenk	=> loads
5612c609719bSwdenk	## Ready for S-Record download ...
5613c609719bSwdenk	~>examples/hello_world.srec
5614c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
5615c609719bSwdenk	[file transfer complete]
5616c609719bSwdenk	[connected]
5617c609719bSwdenk	## Start Addr = 0x00040004
5618c609719bSwdenk
5619c609719bSwdenk	=> go 40004 Hello World! This is a test.
5620c609719bSwdenk	## Starting application at 0x00040004 ...
5621c609719bSwdenk	Hello World
5622c609719bSwdenk	argc = 7
5623c609719bSwdenk	argv[0] = "40004"
5624c609719bSwdenk	argv[1] = "Hello"
5625c609719bSwdenk	argv[2] = "World!"
5626c609719bSwdenk	argv[3] = "This"
5627c609719bSwdenk	argv[4] = "is"
5628c609719bSwdenk	argv[5] = "a"
5629c609719bSwdenk	argv[6] = "test."
5630c609719bSwdenk	argv[7] = "<NULL>"
5631c609719bSwdenk	Hit any key to exit ...
5632c609719bSwdenk
5633c609719bSwdenk	## Application terminated, rc = 0x0
5634c609719bSwdenk
5635c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt
5636c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'.
5637c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second.
5638c609719bSwdenkThe interrupt service routine is trivial, just printing a '.'
5639c609719bSwdenkcharacter, but this is just a demo program. The application can be
5640c609719bSwdenkcontrolled by the following keys:
5641c609719bSwdenk
5642c609719bSwdenk	? - print current values og the CPM Timer registers
5643c609719bSwdenk	b - enable interrupts and start timer
5644c609719bSwdenk	e - stop timer and disable interrupts
5645c609719bSwdenk	q - quit application
5646c609719bSwdenk
5647c609719bSwdenk	=> loads
5648c609719bSwdenk	## Ready for S-Record download ...
5649c609719bSwdenk	~>examples/timer.srec
5650c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
5651c609719bSwdenk	[file transfer complete]
5652c609719bSwdenk	[connected]
5653c609719bSwdenk	## Start Addr = 0x00040004
5654c609719bSwdenk
5655c609719bSwdenk	=> go 40004
5656c609719bSwdenk	## Starting application at 0x00040004 ...
5657c609719bSwdenk	TIMERS=0xfff00980
5658c609719bSwdenk	Using timer 1
5659c609719bSwdenk	  tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
5660c609719bSwdenk
5661c609719bSwdenkHit 'b':
5662c609719bSwdenk	[q, b, e, ?] Set interval 1000000 us
5663c609719bSwdenk	Enabling timer
5664c609719bSwdenkHit '?':
5665c609719bSwdenk	[q, b, e, ?] ........
5666c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
5667c609719bSwdenkHit '?':
5668c609719bSwdenk	[q, b, e, ?] .
5669c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
5670c609719bSwdenkHit '?':
5671c609719bSwdenk	[q, b, e, ?] .
5672c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
5673c609719bSwdenkHit '?':
5674c609719bSwdenk	[q, b, e, ?] .
5675c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
5676c609719bSwdenkHit 'e':
5677c609719bSwdenk	[q, b, e, ?] ...Stopping timer
5678c609719bSwdenkHit 'q':
5679c609719bSwdenk	[q, b, e, ?] ## Application terminated, rc = 0x0
5680c609719bSwdenk
5681c609719bSwdenk
568285ec0bccSwdenkMinicom warning:
568385ec0bccSwdenk================
568485ec0bccSwdenk
56857152b1d0SwdenkOver time, many people have reported problems when trying to use the
568685ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd)
568785ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under
5688f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and
568985ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and
5690e53515a2SKarl O. Pincuse "cu" for S-Record download ("loads" command).  See
5691e53515a2SKarl O. Pinchttp://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
5692e53515a2SKarl O. Pincfor help with kermit.
5693e53515a2SKarl O. Pinc
569485ec0bccSwdenk
569552f52c14SwdenkNevertheless, if you absolutely want to use it try adding this
569652f52c14Swdenkconfiguration to your "File transfer protocols" section:
569752f52c14Swdenk
569852f52c14Swdenk	   Name	   Program			Name U/D FullScr IO-Red. Multi
569952f52c14Swdenk	X  kermit  /usr/bin/kermit -i -l %l -s	 Y    U	   Y	   N	  N
570052f52c14Swdenk	Y  kermit  /usr/bin/kermit -i -l %l -r	 N    D	   Y	   N	  N
570152f52c14Swdenk
570252f52c14Swdenk
5703c609719bSwdenkNetBSD Notes:
5704c609719bSwdenk=============
5705c609719bSwdenk
5706c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host
5707c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx).
5708c609719bSwdenk
5709c609719bSwdenkBuilding requires a cross environment; it is known to work on
5710c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5711c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make).
5712c609719bSwdenkNote that the cross-powerpc package does not install include files;
5713c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is
5714c609719bSwdenkmissing.  This file has to be installed and patched manually:
5715c609719bSwdenk
5716c609719bSwdenk	# cd /usr/pkg/cross/powerpc-netbsd/include
5717c609719bSwdenk	# mkdir powerpc
5718c609719bSwdenk	# ln -s powerpc machine
5719c609719bSwdenk	# cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
5720c609719bSwdenk	# ${EDIT} powerpc/ansi.h	## must remove __va_list, _BSD_VA_LIST
5721c609719bSwdenk
5722c609719bSwdenkNative builds *don't* work due to incompatibilities between native
5723c609719bSwdenkand U-Boot include files.
5724c609719bSwdenk
5725c609719bSwdenkBooting assumes that (the first part of) the image booted is a
5726c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel
5727c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source
5728c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
57292a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
5730c609719bSwdenk
5731c609719bSwdenk
5732c609719bSwdenkImplementation Internals:
5733c609719bSwdenk=========================
5734c609719bSwdenk
5735c609719bSwdenkThe following is not intended to be a complete description of every
5736c609719bSwdenkimplementation detail. However, it should help to understand the
5737c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom
5738c609719bSwdenkhardware.
5739c609719bSwdenk
5740c609719bSwdenk
5741c609719bSwdenkInitial Stack, Global Data:
5742c609719bSwdenk---------------------------
5743c609719bSwdenk
5744c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot
5745c609719bSwdenkstarts running out of ROM (flash memory), usually without access to
5746c609719bSwdenksystem RAM (because the memory controller is not initialized yet).
5747c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS
5748c609719bSwdenkis not initialized as zero. To be able to get a C environment working
5749c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation
5750c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU
5751c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and
5752c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be
5753c609719bSwdenklocked as (mis-) used as memory, etc.
5754c609719bSwdenk
57557152b1d0Swdenk	Chris Hallinan posted a good summary of these issues to the
57560668236bSWolfgang Denk	U-Boot mailing list:
575743d9616cSwdenk
575843d9616cSwdenk	Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
575943d9616cSwdenk	From: "Chris Hallinan" <clh@net1plus.com>
576043d9616cSwdenk	Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
576143d9616cSwdenk	...
576243d9616cSwdenk
576343d9616cSwdenk	Correct me if I'm wrong, folks, but the way I understand it
576443d9616cSwdenk	is this: Using DCACHE as initial RAM for Stack, etc, does not
576543d9616cSwdenk	require any physical RAM backing up the cache. The cleverness
576643d9616cSwdenk	is that the cache is being used as a temporary supply of
576743d9616cSwdenk	necessary storage before the SDRAM controller is setup. It's
576811ccc33fSMarcel Ziswiler	beyond the scope of this list to explain the details, but you
576943d9616cSwdenk	can see how this works by studying the cache architecture and
577043d9616cSwdenk	operation in the architecture and processor-specific manuals.
577143d9616cSwdenk
577243d9616cSwdenk	OCM is On Chip Memory, which I believe the 405GP has 4K. It
577343d9616cSwdenk	is another option for the system designer to use as an
577411ccc33fSMarcel Ziswiler	initial stack/RAM area prior to SDRAM being available. Either
577543d9616cSwdenk	option should work for you. Using CS 4 should be fine if your
577643d9616cSwdenk	board designers haven't used it for something that would
577743d9616cSwdenk	cause you grief during the initial boot! It is frequently not
577843d9616cSwdenk	used.
577943d9616cSwdenk
57806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
578143d9616cSwdenk	with your processor/board/system design. The default value
578243d9616cSwdenk	you will find in any recent u-boot distribution in
57838a316c9bSStefan Roese	walnut.h should work for you. I'd set it to a value larger
578443d9616cSwdenk	than your SDRAM module. If you have a 64MB SDRAM module, set
578543d9616cSwdenk	it above 400_0000. Just make sure your board has no resources
578643d9616cSwdenk	that are supposed to respond to that address! That code in
578743d9616cSwdenk	start.S has been around a while and should work as is when
578843d9616cSwdenk	you get the config right.
578943d9616cSwdenk
579043d9616cSwdenk	-Chris Hallinan
579143d9616cSwdenk	DS4.COM, Inc.
579243d9616cSwdenk
5793c609719bSwdenkIt is essential to remember this, since it has some impact on the C
5794c609719bSwdenkcode for the initialization procedures:
5795c609719bSwdenk
5796c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt
5797c609719bSwdenk  to write it.
5798c609719bSwdenk
579911ccc33fSMarcel Ziswiler* Do not use any uninitialized global data (or implicitely initialized
5800c609719bSwdenk  as zero data - BSS segment) at all - this is undefined, initiali-
58017152b1d0Swdenk  zation is performed later (when relocating to RAM).
5802c609719bSwdenk
5803c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like
5804c609719bSwdenk  that.
5805c609719bSwdenk
5806c609719bSwdenkHaving only the stack as writable memory limits means we cannot use
5807c609719bSwdenknormal global data to share information beween the code. But it
5808c609719bSwdenkturned out that the implementation of U-Boot can be greatly
5809c609719bSwdenksimplified by making a global data structure (gd_t) available to all
5810c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_
5811c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of
5812c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we
5813c609719bSwdenkplace a pointer (gd) to the global data into a register which we
5814c609719bSwdenkreserve for this purpose.
5815c609719bSwdenk
58167152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the
5817c609719bSwdenkrelevant  (E)ABI  specifications for the current architecture, and by
5818c609719bSwdenkGCC's implementation.
5819c609719bSwdenk
5820c609719bSwdenkFor PowerPC, the following registers have specific use:
5821c609719bSwdenk	R1:	stack pointer
5822e7670f6cSWolfgang Denk	R2:	reserved for system use
5823c609719bSwdenk	R3-R4:	parameter passing and return values
5824c609719bSwdenk	R5-R10: parameter passing
5825c609719bSwdenk	R13:	small data area pointer
5826c609719bSwdenk	R30:	GOT pointer
5827c609719bSwdenk	R31:	frame pointer
5828c609719bSwdenk
5829e6bee808SJoakim Tjernlund	(U-Boot also uses R12 as internal GOT pointer. r12
5830e6bee808SJoakim Tjernlund	is a volatile register so r12 needs to be reset when
5831e6bee808SJoakim Tjernlund	going back and forth between asm and C)
5832c609719bSwdenk
5833e7670f6cSWolfgang Denk    ==> U-Boot will use R2 to hold a pointer to the global data
5834c609719bSwdenk
5835c609719bSwdenk    Note: on PPC, we could use a static initializer (since the
5836c609719bSwdenk    address of the global data structure is known at compile time),
5837c609719bSwdenk    but it turned out that reserving a register results in somewhat
5838c609719bSwdenk    smaller code - although the code savings are not that big (on
5839c609719bSwdenk    average for all boards 752 bytes for the whole U-Boot image,
5840c609719bSwdenk    624 text + 127 data).
5841c609719bSwdenk
5842c4db335cSRobin GetzOn Blackfin, the normal C ABI (except for P3) is followed as documented here:
58434c58eb55SMike Frysinger	http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
58444c58eb55SMike Frysinger
5845c4db335cSRobin Getz    ==> U-Boot will use P3 to hold a pointer to the global data
58464c58eb55SMike Frysinger
5847c609719bSwdenkOn ARM, the following registers are used:
5848c609719bSwdenk
5849c609719bSwdenk	R0:	function argument word/integer result
5850c609719bSwdenk	R1-R3:	function argument word
585112eba1b4SJeroen Hofstee	R9:	platform specific
585212eba1b4SJeroen Hofstee	R10:	stack limit (used only if stack checking is enabled)
5853c609719bSwdenk	R11:	argument (frame) pointer
5854c609719bSwdenk	R12:	temporary workspace
5855c609719bSwdenk	R13:	stack pointer
5856c609719bSwdenk	R14:	link register
5857c609719bSwdenk	R15:	program counter
5858c609719bSwdenk
585912eba1b4SJeroen Hofstee    ==> U-Boot will use R9 to hold a pointer to the global data
586012eba1b4SJeroen Hofstee
586112eba1b4SJeroen Hofstee    Note: on ARM, only R_ARM_RELATIVE relocations are supported.
5862c609719bSwdenk
58630df01fd3SThomas ChouOn Nios II, the ABI is documented here:
58640df01fd3SThomas Chou	http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
58650df01fd3SThomas Chou
58660df01fd3SThomas Chou    ==> U-Boot will use gp to hold a pointer to the global data
58670df01fd3SThomas Chou
58680df01fd3SThomas Chou    Note: on Nios II, we give "-G0" option to gcc and don't use gp
58690df01fd3SThomas Chou    to access small data sections, so gp is free.
58700df01fd3SThomas Chou
5871afc1ce82SMacpaul LinOn NDS32, the following registers are used:
5872afc1ce82SMacpaul Lin
5873afc1ce82SMacpaul Lin	R0-R1:	argument/return
5874afc1ce82SMacpaul Lin	R2-R5:	argument
5875afc1ce82SMacpaul Lin	R15:	temporary register for assembler
5876afc1ce82SMacpaul Lin	R16:	trampoline register
5877afc1ce82SMacpaul Lin	R28:	frame pointer (FP)
5878afc1ce82SMacpaul Lin	R29:	global pointer (GP)
5879afc1ce82SMacpaul Lin	R30:	link register (LP)
5880afc1ce82SMacpaul Lin	R31:	stack pointer (SP)
5881afc1ce82SMacpaul Lin	PC:	program counter (PC)
5882afc1ce82SMacpaul Lin
5883afc1ce82SMacpaul Lin    ==> U-Boot will use R10 to hold a pointer to the global data
5884afc1ce82SMacpaul Lin
5885d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5886d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much.
5887c609719bSwdenk
5888c609719bSwdenkMemory Management:
5889c609719bSwdenk------------------
5890c609719bSwdenk
5891c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the
5892c609719bSwdenkMMU is not used either for address mapping nor for memory protection.
5893c609719bSwdenk
5894c609719bSwdenkThe available memory is mapped to fixed addresses using the memory
5895c609719bSwdenkcontroller. In this process, a contiguous block is formed for each
5896c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several
5897c609719bSwdenkphysical memory banks.
5898c609719bSwdenk
5899c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on
5900c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5901c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself
5902c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some
59036d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
5904c609719bSwdenkconfiguration setting]. Below that, a structure with global Board
5905c609719bSwdenkInfo data is placed, followed by the stack (growing downward).
5906c609719bSwdenk
5907c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB
5908c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF).
5909c609719bSwdenk
5910c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like
5911c609719bSwdenkthis:
5912c609719bSwdenk
5913c609719bSwdenk	0x0000 0000	Exception Vector code
5914c609719bSwdenk	      :
5915c609719bSwdenk	0x0000 1FFF
5916c609719bSwdenk	0x0000 2000	Free for Application Use
5917c609719bSwdenk	      :
5918c609719bSwdenk	      :
5919c609719bSwdenk
5920c609719bSwdenk	      :
5921c609719bSwdenk	      :
5922c609719bSwdenk	0x00FB FF20	Monitor Stack (Growing downward)
5923c609719bSwdenk	0x00FB FFAC	Board Info Data and permanent copy of global data
5924c609719bSwdenk	0x00FC 0000	Malloc Arena
5925c609719bSwdenk	      :
5926c609719bSwdenk	0x00FD FFFF
5927c609719bSwdenk	0x00FE 0000	RAM Copy of Monitor Code
5928c609719bSwdenk	...		eventually: LCD or video framebuffer
5929c609719bSwdenk	...		eventually: pRAM (Protected RAM - unchanged by reset)
5930c609719bSwdenk	0x00FF FFFF	[End of RAM]
5931c609719bSwdenk
5932c609719bSwdenk
5933c609719bSwdenkSystem Initialization:
5934c609719bSwdenk----------------------
5935c609719bSwdenk
5936c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point
593711ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset
5938c609719bSwdenkconfiguration for CS0# this is a mirror of the onboard Flash memory.
59397152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address.
5940c609719bSwdenkTo be able to implement the initialization code in C, a (small!)
5941c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs
5942c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked
5943c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core,
5944c609719bSwdenkthe caches and the SIU.
5945c609719bSwdenk
5946c609719bSwdenkNext, all (potentially) available memory banks are mapped using a
5947c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries
5948c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5949c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5950c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a
5951c609719bSwdenksimple memory test is run that determines the size of the SDRAM
5952c609719bSwdenkbanks.
5953c609719bSwdenk
5954c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of
59557152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first
5956c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address
5957c609719bSwdenk0x00000000, with any additional banks following immediately to create
5958c609719bSwdenkcontiguous memory starting from 0.
5959c609719bSwdenk
5960c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area
5961c609719bSwdenkand allocates memory for use by malloc() and for the global Board
5962c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM
5963c609719bSwdenkpages, and the final stack is set up.
5964c609719bSwdenk
5965c609719bSwdenkOnly after this relocation will you have a "normal" C environment;
5966c609719bSwdenkuntil that you are restricted in several ways, mostly because you are
5967c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a
5968c609719bSwdenknew address in RAM.
5969c609719bSwdenk
5970c609719bSwdenk
5971c609719bSwdenkU-Boot Porting Guide:
5972c609719bSwdenk----------------------
5973c609719bSwdenk
5974c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
59756aff3115Swdenklist, October 2002]
5976c609719bSwdenk
5977c609719bSwdenk
5978c609719bSwdenkint main(int argc, char *argv[])
5979c609719bSwdenk{
5980c609719bSwdenk	sighandler_t no_more_time;
5981c609719bSwdenk
5982c609719bSwdenk	signal(SIGALRM, no_more_time);
5983c609719bSwdenk	alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
5984c609719bSwdenk
5985c609719bSwdenk	if (available_money > available_manpower) {
59866c3fef28SJerry Van Baren		Pay consultant to port U-Boot;
5987c609719bSwdenk		return 0;
5988c609719bSwdenk	}
5989c609719bSwdenk
5990c609719bSwdenk	Download latest U-Boot source;
5991c609719bSwdenk
59920668236bSWolfgang Denk	Subscribe to u-boot mailing list;
59936aff3115Swdenk
59946c3fef28SJerry Van Baren	if (clueless)
5995c609719bSwdenk		email("Hi, I am new to U-Boot, how do I get started?");
5996c609719bSwdenk
5997c609719bSwdenk	while (learning) {
5998c609719bSwdenk		Read the README file in the top level directory;
59997cb22f97Swdenk		Read http://www.denx.de/twiki/bin/view/DULG/Manual;
60006c3fef28SJerry Van Baren		Read applicable doc/*.README;
6001c609719bSwdenk		Read the source, Luke;
60026c3fef28SJerry Van Baren		/* find . -name "*.[chS]" | xargs grep -i <keyword> */
6003c609719bSwdenk	}
6004c609719bSwdenk
60056c3fef28SJerry Van Baren	if (available_money > toLocalCurrency ($2500))
60066c3fef28SJerry Van Baren		Buy a BDI3000;
60076c3fef28SJerry Van Baren	else
6008c609719bSwdenk		Add a lot of aggravation and time;
6009c609719bSwdenk
60106c3fef28SJerry Van Baren	if (a similar board exists) {	/* hopefully... */
60116c3fef28SJerry Van Baren		cp -a board/<similar> board/<myboard>
60126c3fef28SJerry Van Baren		cp include/configs/<similar>.h include/configs/<myboard>.h
60136c3fef28SJerry Van Baren	} else {
6014c609719bSwdenk		Create your own board support subdirectory;
60156c3fef28SJerry Van Baren		Create your own board include/configs/<myboard>.h file;
60166c3fef28SJerry Van Baren	}
60176c3fef28SJerry Van Baren	Edit new board/<myboard> files
60186c3fef28SJerry Van Baren	Edit new include/configs/<myboard>.h
6019c609719bSwdenk
60206c3fef28SJerry Van Baren	while (!accepted) {
6021c609719bSwdenk		while (!running) {
6022c609719bSwdenk			do {
6023c609719bSwdenk				Add / modify source code;
6024c609719bSwdenk			} until (compiles);
6025c609719bSwdenk			Debug;
6026c609719bSwdenk			if (clueless)
6027c609719bSwdenk				email("Hi, I am having problems...");
6028c609719bSwdenk		}
60296c3fef28SJerry Van Baren		Send patch file to the U-Boot email list;
60306c3fef28SJerry Van Baren		if (reasonable critiques)
60316c3fef28SJerry Van Baren			Incorporate improvements from email list code review;
60326c3fef28SJerry Van Baren		else
60336c3fef28SJerry Van Baren			Defend code as written;
60346c3fef28SJerry Van Baren	}
6035c609719bSwdenk
6036c609719bSwdenk	return 0;
6037c609719bSwdenk}
6038c609719bSwdenk
6039c609719bSwdenkvoid no_more_time (int sig)
6040c609719bSwdenk{
6041c609719bSwdenk      hire_a_guru();
6042c609719bSwdenk}
6043c609719bSwdenk
6044c609719bSwdenk
6045c609719bSwdenkCoding Standards:
6046c609719bSwdenk-----------------
6047c609719bSwdenk
6048c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel
60492c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script
60507ca9296eSWolfgang Denk"scripts/Lindent" in your Linux kernel source directory.
6051c609719bSwdenk
60522c051651SDetlev ZundelSource files originating from a different project (for example the
60532c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not
60542c051651SDetlev Zundelreformated to ease subsequent migration to newer versions of those
60552c051651SDetlev Zundelsources.
60562c051651SDetlev Zundel
60572c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in
60582c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//)
60592c051651SDetlev Zundelin your code.
6060c609719bSwdenk
6061c178d3daSwdenkPlease also stick to the following formatting rules:
6062180d3f74Swdenk- remove any trailing white space
60637ca9296eSWolfgang Denk- use TAB characters for indentation and vertical alignment, not spaces
6064180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds
60657ca9296eSWolfgang Denk- do not add more than 2 consecutive empty lines to source files
6066180d3f74Swdenk- do not add trailing empty lines to source files
6067180d3f74Swdenk
6068c609719bSwdenkSubmissions which do not conform to the standards may be returned
6069c609719bSwdenkwith a request to reformat the changes.
6070c609719bSwdenk
6071c609719bSwdenk
6072c609719bSwdenkSubmitting Patches:
6073c609719bSwdenk-------------------
6074c609719bSwdenk
6075c609719bSwdenkSince the number of patches for U-Boot is growing, we need to
6076c609719bSwdenkestablish some rules. Submissions which do not conform to these rules
6077c609719bSwdenkmay be rejected, even when they contain important and valuable stuff.
6078c609719bSwdenk
60790d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details.
6080218ca724SWolfgang Denk
60810668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
60820668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot
60830668236bSWolfgang Denk
6084c609719bSwdenkWhen you send a patch, please include the following information with
6085c609719bSwdenkit:
6086c609719bSwdenk
6087c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes
6088c609719bSwdenk  this bug. Please try to include a way of demonstrating that the
6089c609719bSwdenk  patch actually fixes something.
6090c609719bSwdenk
6091c609719bSwdenk* For new features: a description of the feature and your
6092c609719bSwdenk  implementation.
6093c609719bSwdenk
6094c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch)
6095c609719bSwdenk
6096c609719bSwdenk* For major contributions, your entry to the CREDITS file
6097c609719bSwdenk
609827af930eSAlbert ARIBAUD* When you add support for a new board, don't forget to add a
609927af930eSAlbert ARIBAUD  maintainer e-mail address to the boards.cfg file, too.
6100c609719bSwdenk
6101c609719bSwdenk* If your patch adds new configuration options, don't forget to
6102c609719bSwdenk  document these in the README file.
6103c609719bSwdenk
6104218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly*
6105218ca724SWolfgang Denk  recommended) you can easily generate the patch using the
61067ca9296eSWolfgang Denk  "git format-patch". If you then use "git send-email" to send it to
6107218ca724SWolfgang Denk  the U-Boot mailing list, you will avoid most of the common problems
6108218ca724SWolfgang Denk  with some other mail clients.
6109c609719bSwdenk
6110218ca724SWolfgang Denk  If you cannot use git, use "diff -purN OLD NEW". If your version of
6111218ca724SWolfgang Denk  diff does not support these options, then get the latest version of
6112218ca724SWolfgang Denk  GNU diff.
61136dff5529Swdenk
6114218ca724SWolfgang Denk  The current directory when running this command shall be the parent
6115218ca724SWolfgang Denk  directory of the U-Boot source tree (i. e. please make sure that
6116218ca724SWolfgang Denk  your patch includes sufficient directory information for the
6117218ca724SWolfgang Denk  affected files).
6118218ca724SWolfgang Denk
6119218ca724SWolfgang Denk  We prefer patches as plain text. MIME attachments are discouraged,
6120218ca724SWolfgang Denk  and compressed attachments must not be used.
6121c609719bSwdenk
612252f52c14Swdenk* If one logical set of modifications affects or creates several
612352f52c14Swdenk  files, all these changes shall be submitted in a SINGLE patch file.
612452f52c14Swdenk
612552f52c14Swdenk* Changesets that contain different, unrelated modifications shall be
612652f52c14Swdenk  submitted as SEPARATE patches, one patch per changeset.
612752f52c14Swdenk
612852f52c14Swdenk
6129c609719bSwdenkNotes:
6130c609719bSwdenk
6131c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched
6132c609719bSwdenk  source tree and make sure that no errors or warnings are reported
6133c609719bSwdenk  for any of the boards.
6134c609719bSwdenk
6135c609719bSwdenk* Keep your modifications to the necessary minimum: A patch
6136c609719bSwdenk  containing several unrelated changes or arbitrary reformats will be
6137c609719bSwdenk  returned with a request to re-formatting / split it.
6138c609719bSwdenk
6139c609719bSwdenk* If you modify existing code, make sure that your new code does not
6140c609719bSwdenk  add to the memory footprint of the code ;-) Small is beautiful!
6141c609719bSwdenk  When adding new features, these should compile conditionally only
6142c609719bSwdenk  (using #ifdef), and the resulting code with the new feature
6143c609719bSwdenk  disabled must not need more memory than the old code without your
6144c609719bSwdenk  modification.
614590dc6704Swdenk
61460668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the
61470668236bSWolfgang Denk  u-boot mailing list. Bigger patches will be moderated. If they are
61480668236bSWolfgang Denk  reasonable and not too big, they will be acknowledged. But patches
61490668236bSWolfgang Denk  bigger than the size limit should be avoided.
6150