xref: /openbmc/u-boot/README (revision 1b4175d6)
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      /ixp		Files specific to Intel XScale IXP CPUs
1458d321b81SPeter Tyser      /pxa		Files specific to Intel XScale PXA CPUs
1468d321b81SPeter Tyser      /sa1100		Files specific to Intel StrongARM SA1100 CPUs
1478d321b81SPeter Tyser    /lib		Architecture specific library files
1488d321b81SPeter Tyser  /avr32		Files generic to AVR32 architecture
1498d321b81SPeter Tyser    /cpu		CPU specific files
1508d321b81SPeter Tyser    /lib		Architecture specific library files
1518d321b81SPeter Tyser  /blackfin		Files generic to Analog Devices Blackfin architecture
1528d321b81SPeter Tyser    /cpu		CPU specific files
1538d321b81SPeter Tyser    /lib		Architecture specific library files
1548d321b81SPeter Tyser  /m68k			Files generic to m68k architecture
1558d321b81SPeter Tyser    /cpu		CPU specific files
1568d321b81SPeter Tyser      /mcf52x2		Files specific to Freescale ColdFire MCF52x2 CPUs
1578d321b81SPeter Tyser      /mcf5227x		Files specific to Freescale ColdFire MCF5227x CPUs
1588d321b81SPeter Tyser      /mcf532x		Files specific to Freescale ColdFire MCF5329 CPUs
1598d321b81SPeter Tyser      /mcf5445x		Files specific to Freescale ColdFire MCF5445x CPUs
1608d321b81SPeter Tyser      /mcf547x_8x	Files specific to Freescale ColdFire MCF547x_8x CPUs
1618d321b81SPeter Tyser    /lib		Architecture specific library files
1628d321b81SPeter Tyser  /microblaze		Files generic to microblaze architecture
1638d321b81SPeter Tyser    /cpu		CPU specific files
1648d321b81SPeter Tyser    /lib		Architecture specific library files
1658d321b81SPeter Tyser  /mips			Files generic to MIPS architecture
1668d321b81SPeter Tyser    /cpu		CPU specific files
16792bbd64eSDaniel Schwierzeck      /mips32		Files specific to MIPS32 CPUs
16880421fccSXiangfu Liu      /xburst		Files specific to Ingenic XBurst CPUs
1698d321b81SPeter Tyser    /lib		Architecture specific library files
170afc1ce82SMacpaul Lin  /nds32		Files generic to NDS32 architecture
171afc1ce82SMacpaul Lin    /cpu		CPU specific files
172afc1ce82SMacpaul Lin      /n1213		Files specific to Andes Technology N1213 CPUs
173afc1ce82SMacpaul Lin    /lib		Architecture specific library files
1748d321b81SPeter Tyser  /nios2		Files generic to Altera NIOS2 architecture
1758d321b81SPeter Tyser    /cpu		CPU specific files
1768d321b81SPeter Tyser    /lib		Architecture specific library files
17733c7731bSRobert P. J. Day  /openrisc		Files generic to OpenRISC architecture
17833c7731bSRobert P. J. Day    /cpu		CPU specific files
17933c7731bSRobert P. J. Day    /lib		Architecture specific library files
180a47a12beSStefan Roese  /powerpc		Files generic to PowerPC architecture
1818d321b81SPeter Tyser    /cpu		CPU specific files
1828d321b81SPeter Tyser      /74xx_7xx		Files specific to Freescale MPC74xx and 7xx CPUs
1838d321b81SPeter Tyser      /mpc5xx		Files specific to Freescale MPC5xx CPUs
1848d321b81SPeter Tyser      /mpc5xxx		Files specific to Freescale MPC5xxx CPUs
1858d321b81SPeter Tyser      /mpc8xx		Files specific to Freescale MPC8xx CPUs
1868d321b81SPeter Tyser      /mpc824x		Files specific to Freescale MPC824x CPUs
1878d321b81SPeter Tyser      /mpc8260		Files specific to Freescale MPC8260 CPUs
1888d321b81SPeter Tyser      /mpc85xx		Files specific to Freescale MPC85xx CPUs
1898d321b81SPeter Tyser      /ppc4xx		Files specific to AMCC PowerPC 4xx CPUs
1908d321b81SPeter Tyser    /lib		Architecture specific library files
1918d321b81SPeter Tyser  /sh			Files generic to SH architecture
1928d321b81SPeter Tyser    /cpu		CPU specific files
1938d321b81SPeter Tyser      /sh2		Files specific to sh2 CPUs
1948d321b81SPeter Tyser      /sh3		Files specific to sh3 CPUs
1958d321b81SPeter Tyser      /sh4		Files specific to sh4 CPUs
1968d321b81SPeter Tyser    /lib		Architecture specific library files
1978d321b81SPeter Tyser  /sparc		Files generic to SPARC architecture
1988d321b81SPeter Tyser    /cpu		CPU specific files
1998d321b81SPeter Tyser      /leon2		Files specific to Gaisler LEON2 SPARC CPU
2008d321b81SPeter Tyser      /leon3		Files specific to Gaisler LEON3 SPARC CPU
2018d321b81SPeter Tyser    /lib		Architecture specific library files
20233c7731bSRobert P. J. Day  /x86			Files generic to x86 architecture
20333c7731bSRobert P. J. Day    /cpu		CPU specific files
20433c7731bSRobert P. J. Day    /lib		Architecture specific library files
2058d321b81SPeter Tyser/api			Machine/arch independent API for external apps
2068d321b81SPeter Tyser/board			Board dependent files
2078d321b81SPeter Tyser/common			Misc architecture independent functions
2088d321b81SPeter Tyser/disk			Code for disk drive partition handling
2098d321b81SPeter Tyser/doc			Documentation (don't expect too much)
2108d321b81SPeter Tyser/drivers		Commonly used device drivers
21133c7731bSRobert P. J. Day/dts			Contains Makefile for building internal U-Boot fdt.
2128d321b81SPeter Tyser/examples		Example code for standalone applications, etc.
2138d321b81SPeter Tyser/fs			Filesystem code (cramfs, ext2, jffs2, etc.)
2148d321b81SPeter Tyser/include		Header Files
2158d321b81SPeter Tyser/lib			Files generic to all architectures
2168d321b81SPeter Tyser  /libfdt		Library files to support flattened device trees
2178d321b81SPeter Tyser  /lzma			Library files to support LZMA decompression
2188d321b81SPeter Tyser  /lzo			Library files to support LZO decompression
2198d321b81SPeter Tyser/net			Networking code
2208d321b81SPeter Tyser/post			Power On Self Test
22133c7731bSRobert P. J. Day/spl			Secondary Program Loader framework
2228d321b81SPeter Tyser/tools			Tools to build S-Record or U-Boot images, etc.
223c609719bSwdenk
224c609719bSwdenkSoftware Configuration:
225c609719bSwdenk=======================
226c609719bSwdenk
227c609719bSwdenkConfiguration is usually done using C preprocessor defines; the
228c609719bSwdenkrationale behind that is to avoid dead code whenever possible.
229c609719bSwdenk
230c609719bSwdenkThere are two classes of configuration variables:
231c609719bSwdenk
232c609719bSwdenk* Configuration _OPTIONS_:
233c609719bSwdenk  These are selectable by the user and have names beginning with
234c609719bSwdenk  "CONFIG_".
235c609719bSwdenk
236c609719bSwdenk* Configuration _SETTINGS_:
237c609719bSwdenk  These depend on the hardware etc. and should not be meddled with if
238c609719bSwdenk  you don't know what you're doing; they have names beginning with
2396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  "CONFIG_SYS_".
240c609719bSwdenk
241c609719bSwdenkLater we will add a configuration tool - probably similar to or even
242c609719bSwdenkidentical to what's used for the Linux kernel. Right now, we have to
243c609719bSwdenkdo the configuration by hand, which means creating some symbolic
244c609719bSwdenklinks and editing some configuration files. We use the TQM8xxL boards
245c609719bSwdenkas an example here.
246c609719bSwdenk
247c609719bSwdenk
248c609719bSwdenkSelection of Processor Architecture and Board Type:
249c609719bSwdenk---------------------------------------------------
250c609719bSwdenk
251c609719bSwdenkFor all supported boards there are ready-to-use default
252c609719bSwdenkconfigurations available; just type "make <board_name>_config".
253c609719bSwdenk
254c609719bSwdenkExample: For a TQM823L module type:
255c609719bSwdenk
256c609719bSwdenk	cd u-boot
257c609719bSwdenk	make TQM823L_config
258c609719bSwdenk
25911ccc33fSMarcel ZiswilerFor the Cogent platform, you need to specify the CPU type as well;
260c609719bSwdenke.g. "make cogent_mpc8xx_config". And also configure the cogent
261c609719bSwdenkdirectory according to the instructions in cogent/README.
262c609719bSwdenk
263c609719bSwdenk
264c609719bSwdenkConfiguration Options:
265c609719bSwdenk----------------------
266c609719bSwdenk
267c609719bSwdenkConfiguration depends on the combination of board and CPU type; all
268c609719bSwdenksuch information is kept in a configuration file
269c609719bSwdenk"include/configs/<board_name>.h".
270c609719bSwdenk
271c609719bSwdenkExample: For a TQM823L module, all configuration settings are in
272c609719bSwdenk"include/configs/TQM823L.h".
273c609719bSwdenk
274c609719bSwdenk
2757f6c2cbcSwdenkMany of the options are named exactly as the corresponding Linux
2767f6c2cbcSwdenkkernel configuration options. The intention is to make it easier to
2777f6c2cbcSwdenkbuild a config tool - later.
2787f6c2cbcSwdenk
2797f6c2cbcSwdenk
280c609719bSwdenkThe following options need to be configured:
281c609719bSwdenk
2822628114eSKim Phillips- CPU Type:	Define exactly one, e.g. CONFIG_MPC85XX.
283c609719bSwdenk
2842628114eSKim Phillips- Board Type:	Define exactly one, e.g. CONFIG_MPC8540ADS.
2856ccec449SWolfgang Denk
2866ccec449SWolfgang Denk- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
28709ea0de0SHaavard Skinnemoen		Define exactly one, e.g. CONFIG_ATSTK1002
288c609719bSwdenk
289c609719bSwdenk- CPU Module Type: (if CONFIG_COGENT is defined)
290c609719bSwdenk		Define exactly one of
291c609719bSwdenk		CONFIG_CMA286_60_OLD
292c609719bSwdenk--- FIXME --- not tested yet:
293c609719bSwdenk		CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
294c609719bSwdenk		CONFIG_CMA287_23, CONFIG_CMA287_50
295c609719bSwdenk
296c609719bSwdenk- Motherboard Type: (if CONFIG_COGENT is defined)
297c609719bSwdenk		Define exactly one of
298c609719bSwdenk		CONFIG_CMA101, CONFIG_CMA102
299c609719bSwdenk
300c609719bSwdenk- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
301c609719bSwdenk		Define one or more of
302c609719bSwdenk		CONFIG_CMA302
303c609719bSwdenk
304c609719bSwdenk- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
305c609719bSwdenk		Define one or more of
306c609719bSwdenk		CONFIG_LCD_HEARTBEAT	- update a character position on
30711ccc33fSMarcel Ziswiler					  the LCD display every second with
308c609719bSwdenk					  a "rotator" |\-/|\-/
309c609719bSwdenk
3102535d602Swdenk- Board flavour: (if CONFIG_MPC8260ADS is defined)
3112535d602Swdenk		CONFIG_ADSTYPE
3122535d602Swdenk		Possible values are:
3136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8260ADS	- original MPC8260ADS
3146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8266ADS	- MPC8266ADS
3156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_PQ2FADS	- PQ2FADS-ZU or PQ2FADS-VR
3166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8272ADS	- MPC8272ADS
3172535d602Swdenk
318cf946c6dSLei Wen- Marvell Family Member
319cf946c6dSLei Wen		CONFIG_SYS_MVFS		- define it if you want to enable
320cf946c6dSLei Wen					  multiple fs option at one time
321cf946c6dSLei Wen					  for marvell soc family
322cf946c6dSLei Wen
323c609719bSwdenk- MPC824X Family Member (if CONFIG_MPC824X is defined)
324c609719bSwdenk		Define exactly one of
325c609719bSwdenk		CONFIG_MPC8240, CONFIG_MPC8245
326c609719bSwdenk
32711ccc33fSMarcel Ziswiler- 8xx CPU Options: (if using an MPC8xx CPU)
32866ca92a5Swdenk		CONFIG_8xx_GCLK_FREQ	- deprecated: CPU clock if
32966ca92a5Swdenk					  get_gclk_freq() cannot work
3305da627a4Swdenk					  e.g. if there is no 32KHz
3315da627a4Swdenk					  reference PIT/RTC clock
33266ca92a5Swdenk		CONFIG_8xx_OSCLK	- PLL input clock (either EXTCLK
33366ca92a5Swdenk					  or XTAL/EXTAL)
334c609719bSwdenk
33566ca92a5Swdenk- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
3366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MIN
3376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MAX
33866ca92a5Swdenk		CONFIG_8xx_CPUCLK_DEFAULT
33975d1ea7fSwdenk			See doc/README.MPC866
34075d1ea7fSwdenk
3416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MEASURE_CPUCLK
34275d1ea7fSwdenk
34375d1ea7fSwdenk		Define this to measure the actual CPU clock instead
34475d1ea7fSwdenk		of relying on the correctness of the configured
34575d1ea7fSwdenk		values. Mostly useful for board bringup to make sure
34675d1ea7fSwdenk		the PLL is locked at the intended frequency. Note
34775d1ea7fSwdenk		that this requires a (stable) reference clock (32 kHz
3486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		RTC clock or CONFIG_SYS_8XX_XIN)
34975d1ea7fSwdenk
350506f3918SHeiko Schocher		CONFIG_SYS_DELAYED_ICACHE
351506f3918SHeiko Schocher
352506f3918SHeiko Schocher		Define this option if you want to enable the
353506f3918SHeiko Schocher		ICache only when Code runs from RAM.
354506f3918SHeiko Schocher
35566412c63SKumar Gala- 85xx CPU Options:
356ffd06e02SYork Sun		CONFIG_SYS_PPC64
357ffd06e02SYork Sun
358ffd06e02SYork Sun		Specifies that the core is a 64-bit PowerPC implementation (implements
359ffd06e02SYork Sun		the "64" category of the Power ISA). This is necessary for ePAPR
360ffd06e02SYork Sun		compliance, among other possible reasons.
361ffd06e02SYork Sun
36266412c63SKumar Gala		CONFIG_SYS_FSL_TBCLK_DIV
36366412c63SKumar Gala
36466412c63SKumar Gala		Defines the core time base clock divider ratio compared to the
36566412c63SKumar Gala		system clock.  On most PQ3 devices this is 8, on newer QorIQ
36666412c63SKumar Gala		devices it can be 16 or 32.  The ratio varies from SoC to Soc.
36766412c63SKumar Gala
3688f29084aSKumar Gala		CONFIG_SYS_FSL_PCIE_COMPAT
3698f29084aSKumar Gala
3708f29084aSKumar Gala		Defines the string to utilize when trying to match PCIe device
3718f29084aSKumar Gala		tree nodes for the given platform.
3728f29084aSKumar Gala
373afa6b551SPrabhakar Kushwaha		CONFIG_SYS_PPC_E500_DEBUG_TLB
374afa6b551SPrabhakar Kushwaha
375afa6b551SPrabhakar Kushwaha		Enables a temporary TLB entry to be used during boot to work
376afa6b551SPrabhakar Kushwaha		around limitations in e500v1 and e500v2 external debugger
377afa6b551SPrabhakar Kushwaha		support. This reduces the portions of the boot code where
378afa6b551SPrabhakar Kushwaha		breakpoints and single stepping do not work.  The value of this
379afa6b551SPrabhakar Kushwaha		symbol should be set to the TLB1 entry to be used for this
380afa6b551SPrabhakar Kushwaha		purpose.
381afa6b551SPrabhakar Kushwaha
38233eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510
38333eee330SScott Wood
38433eee330SScott Wood		Enables a workaround for erratum A004510.  If set,
38533eee330SScott Wood		then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
38633eee330SScott Wood		CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
38733eee330SScott Wood
38833eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
38933eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
39033eee330SScott Wood
39133eee330SScott Wood		Defines one or two SoC revisions (low 8 bits of SVR)
39233eee330SScott Wood		for which the A004510 workaround should be applied.
39333eee330SScott Wood
39433eee330SScott Wood		The rest of SVR is either not relevant to the decision
39533eee330SScott Wood		of whether the erratum is present (e.g. p2040 versus
39633eee330SScott Wood		p2041) or is implied by the build target, which controls
39733eee330SScott Wood		whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
39833eee330SScott Wood
39933eee330SScott Wood		See Freescale App Note 4493 for more information about
40033eee330SScott Wood		this erratum.
40133eee330SScott Wood
40274fa22edSPrabhakar Kushwaha		CONFIG_A003399_NOR_WORKAROUND
40374fa22edSPrabhakar Kushwaha		Enables a workaround for IFC erratum A003399. It is only
40474fa22edSPrabhakar Kushwaha		requred during NOR boot.
40574fa22edSPrabhakar Kushwaha
40633eee330SScott Wood		CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
40733eee330SScott Wood
40833eee330SScott Wood		This is the value to write into CCSR offset 0x18600
40933eee330SScott Wood		according to the A004510 workaround.
41033eee330SScott Wood
41164501c66SPriyanka Jain		CONFIG_SYS_FSL_DSP_DDR_ADDR
41264501c66SPriyanka Jain		This value denotes start offset of DDR memory which is
41364501c66SPriyanka Jain		connected exclusively to the DSP cores.
41464501c66SPriyanka Jain
415765b0bdbSPriyanka Jain		CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
416765b0bdbSPriyanka Jain		This value denotes start offset of M2 memory
417765b0bdbSPriyanka Jain		which is directly connected to the DSP core.
418765b0bdbSPriyanka Jain
41964501c66SPriyanka Jain		CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
42064501c66SPriyanka Jain		This value denotes start offset of M3 memory which is directly
42164501c66SPriyanka Jain		connected to the DSP core.
42264501c66SPriyanka Jain
423765b0bdbSPriyanka Jain		CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
424765b0bdbSPriyanka Jain		This value denotes start offset of DSP CCSR space.
425765b0bdbSPriyanka Jain
426b135991aSPriyanka Jain		CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
427b135991aSPriyanka Jain		Single Source Clock is clocking mode present in some of FSL SoC's.
428b135991aSPriyanka Jain		In this mode, a single differential clock is used to supply
429b135991aSPriyanka Jain		clocks to the sysclock, ddrclock and usbclock.
430b135991aSPriyanka Jain
4316cb461b4SDaniel Schwierzeck- Generic CPU options:
4326cb461b4SDaniel Schwierzeck		CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
4336cb461b4SDaniel Schwierzeck
4346cb461b4SDaniel Schwierzeck		Defines the endianess of the CPU. Implementation of those
4356cb461b4SDaniel Schwierzeck		values is arch specific.
4366cb461b4SDaniel Schwierzeck
4375614e71bSYork Sun		CONFIG_SYS_FSL_DDR
4385614e71bSYork Sun		Freescale DDR driver in use. This type of DDR controller is
4395614e71bSYork Sun		found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
4405614e71bSYork Sun		SoCs.
4415614e71bSYork Sun
4425614e71bSYork Sun		CONFIG_SYS_FSL_DDR_ADDR
4435614e71bSYork Sun		Freescale DDR memory-mapped register base.
4445614e71bSYork Sun
4455614e71bSYork Sun		CONFIG_SYS_FSL_DDR_EMU
4465614e71bSYork Sun		Specify emulator support for DDR. Some DDR features such as
4475614e71bSYork Sun		deskew training are not available.
4485614e71bSYork Sun
4495614e71bSYork Sun		CONFIG_SYS_FSL_DDRC_GEN1
4505614e71bSYork Sun		Freescale DDR1 controller.
4515614e71bSYork Sun
4525614e71bSYork Sun		CONFIG_SYS_FSL_DDRC_GEN2
4535614e71bSYork Sun		Freescale DDR2 controller.
4545614e71bSYork Sun
4555614e71bSYork Sun		CONFIG_SYS_FSL_DDRC_GEN3
4565614e71bSYork Sun		Freescale DDR3 controller.
4575614e71bSYork Sun
4589ac4ffbdSYork Sun		CONFIG_SYS_FSL_DDRC_ARM_GEN3
4599ac4ffbdSYork Sun		Freescale DDR3 controller for ARM-based SoCs.
4609ac4ffbdSYork Sun
4615614e71bSYork Sun		CONFIG_SYS_FSL_DDR1
4625614e71bSYork Sun		Board config to use DDR1. It can be enabled for SoCs with
4635614e71bSYork Sun		Freescale DDR1 or DDR2 controllers, depending on the board
4645614e71bSYork Sun		implemetation.
4655614e71bSYork Sun
4665614e71bSYork Sun		CONFIG_SYS_FSL_DDR2
4675614e71bSYork Sun		Board config to use DDR2. It can be eanbeld for SoCs with
4685614e71bSYork Sun		Freescale DDR2 or DDR3 controllers, depending on the board
4695614e71bSYork Sun		implementation.
4705614e71bSYork Sun
4715614e71bSYork Sun		CONFIG_SYS_FSL_DDR3
4725614e71bSYork Sun		Board config to use DDR3. It can be enabled for SoCs with
4735614e71bSYork Sun		Freescale DDR3 controllers.
4745614e71bSYork Sun
475*1b4175d6SPrabhakar Kushwaha		CONFIG_SYS_FSL_IFC_BE
476*1b4175d6SPrabhakar Kushwaha		Defines the IFC controller register space as Big Endian
477*1b4175d6SPrabhakar Kushwaha
478*1b4175d6SPrabhakar Kushwaha		CONFIG_SYS_FSL_IFC_LE
479*1b4175d6SPrabhakar Kushwaha		Defines the IFC controller register space as Little Endian
480*1b4175d6SPrabhakar Kushwaha
481690e4258SPrabhakar Kushwaha		CONFIG_SYS_FSL_PBL_PBI
482690e4258SPrabhakar Kushwaha		It enables addition of RCW (Power on reset configuration) in built image.
483690e4258SPrabhakar Kushwaha		Please refer doc/README.pblimage for more details
484690e4258SPrabhakar Kushwaha
485690e4258SPrabhakar Kushwaha		CONFIG_SYS_FSL_PBL_RCW
486690e4258SPrabhakar Kushwaha		It adds PBI(pre-boot instructions) commands in u-boot build image.
487690e4258SPrabhakar Kushwaha		PBI commands can be used to configure SoC before it starts the execution.
488690e4258SPrabhakar Kushwaha		Please refer doc/README.pblimage for more details
489690e4258SPrabhakar Kushwaha
4900b953ffcSMarkus Klotzbuecher- Intel Monahans options:
4916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
4920b953ffcSMarkus Klotzbuecher
4930b953ffcSMarkus Klotzbuecher		Defines the Monahans run mode to oscillator
4940b953ffcSMarkus Klotzbuecher		ratio. Valid values are 8, 16, 24, 31. The core
4950b953ffcSMarkus Klotzbuecher		frequency is this value multiplied by 13 MHz.
4960b953ffcSMarkus Klotzbuecher
4976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
4980b953ffcSMarkus Klotzbuecher
4990b953ffcSMarkus Klotzbuecher		Defines the Monahans turbo mode to oscillator
5000b953ffcSMarkus Klotzbuecher		ratio. Valid values are 1 (default if undefined) and
5010b953ffcSMarkus Klotzbuecher		2. The core frequency as calculated above is multiplied
5020b953ffcSMarkus Klotzbuecher		by this value.
5030b953ffcSMarkus Klotzbuecher
50492bbd64eSDaniel Schwierzeck- MIPS CPU options:
50592bbd64eSDaniel Schwierzeck		CONFIG_SYS_INIT_SP_OFFSET
50692bbd64eSDaniel Schwierzeck
50792bbd64eSDaniel Schwierzeck		Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
50892bbd64eSDaniel Schwierzeck		pointer. This is needed for the temporary stack before
50992bbd64eSDaniel Schwierzeck		relocation.
51092bbd64eSDaniel Schwierzeck
51192bbd64eSDaniel Schwierzeck		CONFIG_SYS_MIPS_CACHE_MODE
51292bbd64eSDaniel Schwierzeck
51392bbd64eSDaniel Schwierzeck		Cache operation mode for the MIPS CPU.
51492bbd64eSDaniel Schwierzeck		See also arch/mips/include/asm/mipsregs.h.
51592bbd64eSDaniel Schwierzeck		Possible values are:
51692bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_NO_WA
51792bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_WA
51892bbd64eSDaniel Schwierzeck			CONF_CM_UNCACHED
51992bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_NONCOHERENT
52092bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_CE
52192bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_COW
52292bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_CUW
52392bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_ACCELERATED
52492bbd64eSDaniel Schwierzeck
52592bbd64eSDaniel Schwierzeck		CONFIG_SYS_XWAY_EBU_BOOTCFG
52692bbd64eSDaniel Schwierzeck
52792bbd64eSDaniel Schwierzeck		Special option for Lantiq XWAY SoCs for booting from NOR flash.
52892bbd64eSDaniel Schwierzeck		See also arch/mips/cpu/mips32/start.S.
52992bbd64eSDaniel Schwierzeck
53092bbd64eSDaniel Schwierzeck		CONFIG_XWAY_SWAP_BYTES
53192bbd64eSDaniel Schwierzeck
53292bbd64eSDaniel Schwierzeck		Enable compilation of tools/xway-swap-bytes needed for Lantiq
53392bbd64eSDaniel Schwierzeck		XWAY SoCs for booting from NOR flash. The U-Boot image needs to
53492bbd64eSDaniel Schwierzeck		be swapped if a flash programmer is used.
53592bbd64eSDaniel Schwierzeck
536b67d8816SChristian Riesch- ARM options:
537b67d8816SChristian Riesch		CONFIG_SYS_EXCEPTION_VECTORS_HIGH
538b67d8816SChristian Riesch
539b67d8816SChristian Riesch		Select high exception vectors of the ARM core, e.g., do not
540b67d8816SChristian Riesch		clear the V bit of the c1 register of CP15.
541b67d8816SChristian Riesch
5425356f545SAneesh V		CONFIG_SYS_THUMB_BUILD
5435356f545SAneesh V
5445356f545SAneesh V		Use this flag to build U-Boot using the Thumb instruction
5455356f545SAneesh V		set for ARM architectures. Thumb instruction set provides
5465356f545SAneesh V		better code density. For ARM architectures that support
5475356f545SAneesh V		Thumb2 this flag will result in Thumb2 code generated by
5485356f545SAneesh V		GCC.
5495356f545SAneesh V
550c5d4752cSStephen Warren		CONFIG_ARM_ERRATA_716044
5510678587fSStephen Warren		CONFIG_ARM_ERRATA_742230
5520678587fSStephen Warren		CONFIG_ARM_ERRATA_743622
5530678587fSStephen Warren		CONFIG_ARM_ERRATA_751472
5540678587fSStephen Warren
5550678587fSStephen Warren		If set, the workarounds for these ARM errata are applied early
5560678587fSStephen Warren		during U-Boot startup. Note that these options force the
5570678587fSStephen Warren		workarounds to be applied; no CPU-type/version detection
5580678587fSStephen Warren		exists, unlike the similar options in the Linux kernel. Do not
5590678587fSStephen Warren		set these options unless they apply!
5600678587fSStephen Warren
561795659dcSStephen Warren- CPU timer options:
562795659dcSStephen Warren		CONFIG_SYS_HZ
563795659dcSStephen Warren
564795659dcSStephen Warren		The frequency of the timer returned by get_timer().
565795659dcSStephen Warren		get_timer() must operate in milliseconds and this CONFIG
566795659dcSStephen Warren		option must be set to 1000.
567795659dcSStephen Warren
5685da627a4Swdenk- Linux Kernel Interface:
569c609719bSwdenk		CONFIG_CLOCKS_IN_MHZ
570c609719bSwdenk
571c609719bSwdenk		U-Boot stores all clock information in Hz
572c609719bSwdenk		internally. For binary compatibility with older Linux
573c609719bSwdenk		kernels (which expect the clocks passed in the
574c609719bSwdenk		bd_info data to be in MHz) the environment variable
575c609719bSwdenk		"clocks_in_mhz" can be defined so that U-Boot
576c609719bSwdenk		converts clock data to MHZ before passing it to the
577c609719bSwdenk		Linux kernel.
578c609719bSwdenk		When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
579c609719bSwdenk		"clocks_in_mhz=1" is automatically included in the
580c609719bSwdenk		default environment.
581c609719bSwdenk
5825da627a4Swdenk		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]
5835da627a4Swdenk
58411ccc33fSMarcel Ziswiler		When transferring memsize parameter to linux, some versions
5855da627a4Swdenk		expect it to be in bytes, others in MB.
5865da627a4Swdenk		Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
5875da627a4Swdenk
588fec6d9eeSGerald Van Baren		CONFIG_OF_LIBFDT
589f57f70aaSWolfgang Denk
590f57f70aaSWolfgang Denk		New kernel versions are expecting firmware settings to be
591213bf8c8SGerald Van Baren		passed using flattened device trees (based on open firmware
592213bf8c8SGerald Van Baren		concepts).
593213bf8c8SGerald Van Baren
594213bf8c8SGerald Van Baren		CONFIG_OF_LIBFDT
595213bf8c8SGerald Van Baren		 * New libfdt-based support
596213bf8c8SGerald Van Baren		 * Adds the "fdt" command
5973bb342fcSKim Phillips		 * The bootm command automatically updates the fdt
598213bf8c8SGerald Van Baren
599b55ae402SMarcel Ziswiler		OF_CPU - The proper name of the cpus node (only required for
600b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
601b55ae402SMarcel Ziswiler		OF_SOC - The proper name of the soc node (only required for
602b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
603f57f70aaSWolfgang Denk		OF_TBCLK - The timebase frequency.
604c2871f03SKumar Gala		OF_STDOUT_PATH - The path to the console device
605f57f70aaSWolfgang Denk
60611ccc33fSMarcel Ziswiler		boards with QUICC Engines require OF_QE to set UCC MAC
60711ccc33fSMarcel Ziswiler		addresses
6083bb342fcSKim Phillips
6094e253137SKumar Gala		CONFIG_OF_BOARD_SETUP
6104e253137SKumar Gala
6114e253137SKumar Gala		Board code has addition modification that it wants to make
6124e253137SKumar Gala		to the flat device tree before handing it off to the kernel
6136705d81eSwdenk
6140267768eSMatthew McClintock		CONFIG_OF_BOOT_CPU
6150267768eSMatthew McClintock
61611ccc33fSMarcel Ziswiler		This define fills in the correct boot CPU in the boot
6170267768eSMatthew McClintock		param header, the default value is zero if undefined.
6180267768eSMatthew McClintock
6193887c3fbSHeiko Schocher		CONFIG_OF_IDE_FIXUP
6203887c3fbSHeiko Schocher
6213887c3fbSHeiko Schocher		U-Boot can detect if an IDE device is present or not.
6223887c3fbSHeiko Schocher		If not, and this new config option is activated, U-Boot
6233887c3fbSHeiko Schocher		removes the ATA node from the DTS before booting Linux,
6243887c3fbSHeiko Schocher		so the Linux IDE driver does not probe the device and
6253887c3fbSHeiko Schocher		crash. This is needed for buggy hardware (uc101) where
6263887c3fbSHeiko Schocher		no pull down resistor is connected to the signal IDE5V_DD7.
6273887c3fbSHeiko Schocher
6287eb29398SIgor Grinberg		CONFIG_MACH_TYPE	[relevant for ARM only][mandatory]
6297eb29398SIgor Grinberg
6307eb29398SIgor Grinberg		This setting is mandatory for all boards that have only one
6317eb29398SIgor Grinberg		machine type and must be used to specify the machine type
6327eb29398SIgor Grinberg		number as it appears in the ARM machine registry
6337eb29398SIgor Grinberg		(see http://www.arm.linux.org.uk/developer/machines/).
6347eb29398SIgor Grinberg		Only boards that have multiple machine types supported
6357eb29398SIgor Grinberg		in a single configuration file and the machine type is
6367eb29398SIgor Grinberg		runtime discoverable, do not have to use this setting.
6377eb29398SIgor Grinberg
6380b2f4ecaSNiklaus Giger- vxWorks boot parameters:
6390b2f4ecaSNiklaus Giger
6400b2f4ecaSNiklaus Giger		bootvx constructs a valid bootline using the following
6410b2f4ecaSNiklaus Giger		environments variables: bootfile, ipaddr, serverip, hostname.
6420b2f4ecaSNiklaus Giger		It loads the vxWorks image pointed bootfile.
6430b2f4ecaSNiklaus Giger
6440b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
6450b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
6460b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
6470b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
6480b2f4ecaSNiklaus Giger
6490b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_ADD_PARAMS
6500b2f4ecaSNiklaus Giger
6510b2f4ecaSNiklaus Giger		Add it at the end of the bootline. E.g "u=username pw=secret"
6520b2f4ecaSNiklaus Giger
6530b2f4ecaSNiklaus Giger		Note: If a "bootargs" environment is defined, it will overwride
6540b2f4ecaSNiklaus Giger		the defaults discussed just above.
6550b2f4ecaSNiklaus Giger
6562c451f78SAneesh V- Cache Configuration:
6572c451f78SAneesh V		CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
6582c451f78SAneesh V		CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
6592c451f78SAneesh V		CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
6602c451f78SAneesh V
66193bc2193SAneesh V- Cache Configuration for ARM:
66293bc2193SAneesh V		CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
66393bc2193SAneesh V				      controller
66493bc2193SAneesh V		CONFIG_SYS_PL310_BASE - Physical base address of PL310
66593bc2193SAneesh V					controller register space
66693bc2193SAneesh V
6676705d81eSwdenk- Serial Ports:
66848d0192fSAndreas Engel		CONFIG_PL010_SERIAL
6696705d81eSwdenk
6706705d81eSwdenk		Define this if you want support for Amba PrimeCell PL010 UARTs.
6716705d81eSwdenk
67248d0192fSAndreas Engel		CONFIG_PL011_SERIAL
6736705d81eSwdenk
6746705d81eSwdenk		Define this if you want support for Amba PrimeCell PL011 UARTs.
6756705d81eSwdenk
6766705d81eSwdenk		CONFIG_PL011_CLOCK
6776705d81eSwdenk
6786705d81eSwdenk		If you have Amba PrimeCell PL011 UARTs, set this variable to
6796705d81eSwdenk		the clock speed of the UARTs.
6806705d81eSwdenk
6816705d81eSwdenk		CONFIG_PL01x_PORTS
6826705d81eSwdenk
6836705d81eSwdenk		If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
6846705d81eSwdenk		define this to a list of base addresses for each (supported)
6856705d81eSwdenk		port. See e.g. include/configs/versatile.h
6866705d81eSwdenk
687910f1ae3SJohn Rigby		CONFIG_PL011_SERIAL_RLCR
688910f1ae3SJohn Rigby
689910f1ae3SJohn Rigby		Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
690910f1ae3SJohn Rigby		have separate receive and transmit line control registers.  Set
691910f1ae3SJohn Rigby		this variable to initialize the extra register.
692910f1ae3SJohn Rigby
693910f1ae3SJohn Rigby		CONFIG_PL011_SERIAL_FLUSH_ON_INIT
694910f1ae3SJohn Rigby
695910f1ae3SJohn Rigby		On some platforms (e.g. U8500) U-Boot is loaded by a second stage
696910f1ae3SJohn Rigby		boot loader that has already initialized the UART.  Define this
697910f1ae3SJohn Rigby		variable to flush the UART at init time.
698910f1ae3SJohn Rigby
6996705d81eSwdenk
700c609719bSwdenk- Console Interface:
701c609719bSwdenk		Depending on board, define exactly one serial port
702c609719bSwdenk		(like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
703c609719bSwdenk		CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
704c609719bSwdenk		console by defining CONFIG_8xx_CONS_NONE
705c609719bSwdenk
706c609719bSwdenk		Note: if CONFIG_8xx_CONS_NONE is defined, the serial
707c609719bSwdenk		port routines must be defined elsewhere
708c609719bSwdenk		(i.e. serial_init(), serial_getc(), ...)
709c609719bSwdenk
710c609719bSwdenk		CONFIG_CFB_CONSOLE
711c609719bSwdenk		Enables console device for a color framebuffer. Needs following
712c53043b7SWolfgang Denk		defines (cf. smiLynxEM, i8042)
713c609719bSwdenk			VIDEO_FB_LITTLE_ENDIAN	graphic memory organisation
714c609719bSwdenk						(default big endian)
715c609719bSwdenk			VIDEO_HW_RECTFILL	graphic chip supports
716c609719bSwdenk						rectangle fill
717c609719bSwdenk						(cf. smiLynxEM)
718c609719bSwdenk			VIDEO_HW_BITBLT		graphic chip supports
719c609719bSwdenk						bit-blit (cf. smiLynxEM)
720c609719bSwdenk			VIDEO_VISIBLE_COLS	visible pixel columns
721c609719bSwdenk						(cols=pitch)
722c609719bSwdenk			VIDEO_VISIBLE_ROWS	visible pixel rows
723c609719bSwdenk			VIDEO_PIXEL_SIZE	bytes per pixel
724c609719bSwdenk			VIDEO_DATA_FORMAT	graphic data format
725c609719bSwdenk						(0-5, cf. cfb_console.c)
726c609719bSwdenk			VIDEO_FB_ADRS		framebuffer address
727c609719bSwdenk			VIDEO_KBD_INIT_FCT	keyboard int fct
728c609719bSwdenk						(i.e. i8042_kbd_init())
729c609719bSwdenk			VIDEO_TSTC_FCT		test char fct
730c609719bSwdenk						(i.e. i8042_tstc)
731c609719bSwdenk			VIDEO_GETC_FCT		get char fct
732c609719bSwdenk						(i.e. i8042_getc)
733c609719bSwdenk			CONFIG_CONSOLE_CURSOR	cursor drawing on/off
734c609719bSwdenk						(requires blink timer
735c609719bSwdenk						cf. i8042.c)
7366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
737c609719bSwdenk			CONFIG_CONSOLE_TIME	display time/date info in
738c609719bSwdenk						upper right corner
739602ad3b3SJon Loeliger						(requires CONFIG_CMD_DATE)
740c609719bSwdenk			CONFIG_VIDEO_LOGO	display Linux logo in
741c609719bSwdenk						upper left corner
742a6c7ad2fSwdenk			CONFIG_VIDEO_BMP_LOGO	use bmp_logo.h instead of
743a6c7ad2fSwdenk						linux_logo.h for logo.
744a6c7ad2fSwdenk						Requires CONFIG_VIDEO_LOGO
745c609719bSwdenk			CONFIG_CONSOLE_EXTRA_INFO
74611ccc33fSMarcel Ziswiler						additional board info beside
747c609719bSwdenk						the logo
748c609719bSwdenk
74933a35bbbSPali Rohár		When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
75033a35bbbSPali Rohár		a limited number of ANSI escape sequences (cursor control,
75133a35bbbSPali Rohár		erase functions and limited graphics rendition control).
75233a35bbbSPali Rohár
753c609719bSwdenk		When CONFIG_CFB_CONSOLE is defined, video console is
754c609719bSwdenk		default i/o. Serial console can be forced with
755c609719bSwdenk		environment 'console=serial'.
756c609719bSwdenk
757a3ad8e26Swdenk		When CONFIG_SILENT_CONSOLE is defined, all console
758a3ad8e26Swdenk		messages (by U-Boot and Linux!) can be silenced with
759a3ad8e26Swdenk		the "silent" environment variable. See
760a3ad8e26Swdenk		doc/README.silent for more information.
761a3ad8e26Swdenk
76245ae2546SHeiko Schocher		CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default
76345ae2546SHeiko Schocher			is 0x00.
76445ae2546SHeiko Schocher		CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default
76545ae2546SHeiko Schocher			is 0xa0.
76645ae2546SHeiko Schocher
767c609719bSwdenk- Console Baudrate:
768c609719bSwdenk		CONFIG_BAUDRATE - in bps
769c609719bSwdenk		Select one of the baudrates listed in
7706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
7716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
772c609719bSwdenk
773c92fac91SHeiko Schocher- Console Rx buffer length
774c92fac91SHeiko Schocher		With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
775c92fac91SHeiko Schocher		the maximum receive buffer length for the SMC.
7762b3f12c2SHeiko Schocher		This option is actual only for 82xx and 8xx possible.
777c92fac91SHeiko Schocher		If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
778c92fac91SHeiko Schocher		must be defined, to setup the maximum idle timeout for
779c92fac91SHeiko Schocher		the SMC.
780c92fac91SHeiko Schocher
7819558b48aSGraeme Russ- Pre-Console Buffer:
7829558b48aSGraeme Russ		Prior to the console being initialised (i.e. serial UART
7839558b48aSGraeme Russ		initialised etc) all console output is silently discarded.
7849558b48aSGraeme Russ		Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
7859558b48aSGraeme Russ		buffer any console messages prior to the console being
7869558b48aSGraeme Russ		initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
7879558b48aSGraeme Russ		bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
7889558b48aSGraeme Russ		a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
7899558b48aSGraeme Russ		bytes are output before the console is initialised, the
7909558b48aSGraeme Russ		earlier bytes are discarded.
7919558b48aSGraeme Russ
7929558b48aSGraeme Russ		'Sane' compilers will generate smaller code if
7939558b48aSGraeme Russ		CONFIG_PRE_CON_BUF_SZ is a power of 2
7949558b48aSGraeme Russ
795046a37bdSSonny Rao- Safe printf() functions
796046a37bdSSonny Rao		Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
797046a37bdSSonny Rao		the printf() functions. These are defined in
798046a37bdSSonny Rao		include/vsprintf.h and include snprintf(), vsnprintf() and
799046a37bdSSonny Rao		so on. Code size increase is approximately 300-500 bytes.
800046a37bdSSonny Rao		If this option is not given then these functions will
801046a37bdSSonny Rao		silently discard their buffer size argument - this means
802046a37bdSSonny Rao		you are not getting any overflow checking in this case.
803046a37bdSSonny Rao
804c609719bSwdenk- Boot Delay:	CONFIG_BOOTDELAY - in seconds
805c609719bSwdenk		Delay before automatically booting the default image;
806c609719bSwdenk		set to -1 to disable autoboot.
80793d7212fSJoe Hershberger		set to -2 to autoboot with no delay and not check for abort
80893d7212fSJoe Hershberger		(even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
809c609719bSwdenk
810c609719bSwdenk		See doc/README.autoboot for these options that
811c609719bSwdenk		work with CONFIG_BOOTDELAY. None are required.
812c609719bSwdenk		CONFIG_BOOT_RETRY_TIME
813c609719bSwdenk		CONFIG_BOOT_RETRY_MIN
814c609719bSwdenk		CONFIG_AUTOBOOT_KEYED
815c609719bSwdenk		CONFIG_AUTOBOOT_PROMPT
816c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR
817c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR
818c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR2
819c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR2
820c609719bSwdenk		CONFIG_ZERO_BOOTDELAY_CHECK
821c609719bSwdenk		CONFIG_RESET_TO_RETRY
822c609719bSwdenk
823c609719bSwdenk- Autoboot Command:
824c609719bSwdenk		CONFIG_BOOTCOMMAND
825c609719bSwdenk		Only needed when CONFIG_BOOTDELAY is enabled;
826c609719bSwdenk		define a command string that is automatically executed
827c609719bSwdenk		when no character is read on the console interface
828c609719bSwdenk		within "Boot Delay" after reset.
829c609719bSwdenk
830c609719bSwdenk		CONFIG_BOOTARGS
831c609719bSwdenk		This can be used to pass arguments to the bootm
832c609719bSwdenk		command. The value of CONFIG_BOOTARGS goes into the
833c609719bSwdenk		environment value "bootargs".
834c609719bSwdenk
835c609719bSwdenk		CONFIG_RAMBOOT and CONFIG_NFSBOOT
836c609719bSwdenk		The value of these goes into the environment as
837c609719bSwdenk		"ramboot" and "nfsboot" respectively, and can be used
838c609719bSwdenk		as a convenience, when switching between booting from
83911ccc33fSMarcel Ziswiler		RAM and NFS.
840c609719bSwdenk
841eda0ba38SHeiko Schocher- Bootcount:
842eda0ba38SHeiko Schocher		CONFIG_BOOTCOUNT_LIMIT
843eda0ba38SHeiko Schocher		Implements a mechanism for detecting a repeating reboot
844eda0ba38SHeiko Schocher		cycle, see:
845eda0ba38SHeiko Schocher		http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
846eda0ba38SHeiko Schocher
847eda0ba38SHeiko Schocher		CONFIG_BOOTCOUNT_ENV
848eda0ba38SHeiko Schocher		If no softreset save registers are found on the hardware
849eda0ba38SHeiko Schocher		"bootcount" is stored in the environment. To prevent a
850eda0ba38SHeiko Schocher		saveenv on all reboots, the environment variable
851eda0ba38SHeiko Schocher		"upgrade_available" is used. If "upgrade_available" is
852eda0ba38SHeiko Schocher		0, "bootcount" is always 0, if "upgrade_available" is
853eda0ba38SHeiko Schocher		1 "bootcount" is incremented in the environment.
854eda0ba38SHeiko Schocher		So the Userspace Applikation must set the "upgrade_available"
855eda0ba38SHeiko Schocher		and "bootcount" variable to 0, if a boot was successfully.
856eda0ba38SHeiko Schocher
857c609719bSwdenk- Pre-Boot Commands:
858c609719bSwdenk		CONFIG_PREBOOT
859c609719bSwdenk
860c609719bSwdenk		When this option is #defined, the existence of the
861c609719bSwdenk		environment variable "preboot" will be checked
862c609719bSwdenk		immediately before starting the CONFIG_BOOTDELAY
863c609719bSwdenk		countdown and/or running the auto-boot command resp.
864c609719bSwdenk		entering interactive mode.
865c609719bSwdenk
866c609719bSwdenk		This feature is especially useful when "preboot" is
867c609719bSwdenk		automatically generated or modified. For an example
868c609719bSwdenk		see the LWMON board specific code: here "preboot" is
869c609719bSwdenk		modified when the user holds down a certain
870c609719bSwdenk		combination of keys on the (special) keyboard when
871c609719bSwdenk		booting the systems
872c609719bSwdenk
873c609719bSwdenk- Serial Download Echo Mode:
874c609719bSwdenk		CONFIG_LOADS_ECHO
875c609719bSwdenk		If defined to 1, all characters received during a
876c609719bSwdenk		serial download (using the "loads" command) are
877c609719bSwdenk		echoed back. This might be needed by some terminal
878c609719bSwdenk		emulations (like "cu"), but may as well just take
879c609719bSwdenk		time on others. This setting #define's the initial
880c609719bSwdenk		value of the "loads_echo" environment variable.
881c609719bSwdenk
882602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
883c609719bSwdenk		CONFIG_KGDB_BAUDRATE
884c609719bSwdenk		Select one of the baudrates listed in
8856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
886c609719bSwdenk
887c609719bSwdenk- Monitor Functions:
888602ad3b3SJon Loeliger		Monitor commands can be included or excluded
889602ad3b3SJon Loeliger		from the build by using the #include files
890c6c621bdSStephen Warren		<config_cmd_all.h> and #undef'ing unwanted
891c6c621bdSStephen Warren		commands, or using <config_cmd_default.h>
892602ad3b3SJon Loeliger		and augmenting with additional #define's
893602ad3b3SJon Loeliger		for wanted commands.
894c609719bSwdenk
895602ad3b3SJon Loeliger		The default command configuration includes all commands
896602ad3b3SJon Loeliger		except those marked below with a "*".
897602ad3b3SJon Loeliger
898602ad3b3SJon Loeliger		CONFIG_CMD_ASKENV	* ask for env variable
899602ad3b3SJon Loeliger		CONFIG_CMD_BDI		  bdinfo
900602ad3b3SJon Loeliger		CONFIG_CMD_BEDBUG	* Include BedBug Debugger
901602ad3b3SJon Loeliger		CONFIG_CMD_BMP		* BMP support
902602ad3b3SJon Loeliger		CONFIG_CMD_BSP		* Board specific commands
903602ad3b3SJon Loeliger		CONFIG_CMD_BOOTD	  bootd
904602ad3b3SJon Loeliger		CONFIG_CMD_CACHE	* icache, dcache
905602ad3b3SJon Loeliger		CONFIG_CMD_CONSOLE	  coninfo
906710b9938SMike Frysinger		CONFIG_CMD_CRC32	* crc32
907602ad3b3SJon Loeliger		CONFIG_CMD_DATE		* support for RTC, date/time...
908602ad3b3SJon Loeliger		CONFIG_CMD_DHCP		* DHCP support
909602ad3b3SJon Loeliger		CONFIG_CMD_DIAG		* Diagnostics
910a7c93104SPeter Tyser		CONFIG_CMD_DS4510	* ds4510 I2C gpio commands
911a7c93104SPeter Tyser		CONFIG_CMD_DS4510_INFO	* ds4510 I2C info command
912a7c93104SPeter Tyser		CONFIG_CMD_DS4510_MEM	* ds4510 I2C eeprom/sram commansd
913a7c93104SPeter Tyser		CONFIG_CMD_DS4510_RST	* ds4510 I2C rst command
914602ad3b3SJon Loeliger		CONFIG_CMD_DTT		* Digital Therm and Thermostat
915602ad3b3SJon Loeliger		CONFIG_CMD_ECHO		  echo arguments
916246c6922SPeter Tyser		CONFIG_CMD_EDITENV	  edit env variable
917602ad3b3SJon Loeliger		CONFIG_CMD_EEPROM	* EEPROM read/write support
918602ad3b3SJon Loeliger		CONFIG_CMD_ELF		* bootelf, bootvx
9195e2b3e0cSJoe Hershberger		CONFIG_CMD_ENV_CALLBACK	* display details about env callbacks
920fffad71bSJoe Hershberger		CONFIG_CMD_ENV_FLAGS	* display details about env flags
92188733e2cSAndrew Ruder		CONFIG_CMD_ENV_EXISTS	* check existence of env variable
9220c79cda0SMike Frysinger		CONFIG_CMD_EXPORTENV	* export the environment
92303e2ecf6SStephen Warren		CONFIG_CMD_EXT2		* ext2 command support
92403e2ecf6SStephen Warren		CONFIG_CMD_EXT4		* ext4 command support
925bdab39d3SMike Frysinger		CONFIG_CMD_SAVEENV	  saveenv
926602ad3b3SJon Loeliger		CONFIG_CMD_FDC		* Floppy Disk Support
92703e2ecf6SStephen Warren		CONFIG_CMD_FAT		* FAT command support
928602ad3b3SJon Loeliger		CONFIG_CMD_FDOS		* Dos diskette Support
929602ad3b3SJon Loeliger		CONFIG_CMD_FLASH	  flinfo, erase, protect
930602ad3b3SJon Loeliger		CONFIG_CMD_FPGA		  FPGA device initialization support
9314d98b5c8SVincent Stehlé		CONFIG_CMD_FUSE		* Device fuse support
93253fdc7efSAnton Staaf		CONFIG_CMD_GETTIME	* Get time since boot
933a641b979SMike Frysinger		CONFIG_CMD_GO		* the 'go' command (exec code)
934a000b795SKim Phillips		CONFIG_CMD_GREPENV	* search environment
935bf36c5d5SSimon Glass		CONFIG_CMD_HASH		* calculate hash / digest
936602ad3b3SJon Loeliger		CONFIG_CMD_HWFLOW	* RTS/CTS hw flow control
937602ad3b3SJon Loeliger		CONFIG_CMD_I2C		* I2C serial bus support
938602ad3b3SJon Loeliger		CONFIG_CMD_IDE		* IDE harddisk support
939602ad3b3SJon Loeliger		CONFIG_CMD_IMI		  iminfo
9408fdf1e0fSVipin Kumar		CONFIG_CMD_IMLS		  List all images found in NOR flash
9414d98b5c8SVincent Stehlé		CONFIG_CMD_IMLS_NAND	* List all images found in NAND flash
942602ad3b3SJon Loeliger		CONFIG_CMD_IMMAP	* IMMR dump support
9430c79cda0SMike Frysinger		CONFIG_CMD_IMPORTENV	* import an environment
944c167cc02SJoe Hershberger		CONFIG_CMD_INI		* import data from an ini file into the env
945602ad3b3SJon Loeliger		CONFIG_CMD_IRQ		* irqinfo
946602ad3b3SJon Loeliger		CONFIG_CMD_ITEST	  Integer/string test of 2 values
947602ad3b3SJon Loeliger		CONFIG_CMD_JFFS2	* JFFS2 Support
948602ad3b3SJon Loeliger		CONFIG_CMD_KGDB		* kgdb
9494d98b5c8SVincent Stehlé		CONFIG_CMD_LDRINFO	* ldrinfo (display Blackfin loader)
950d22c338eSJoe Hershberger		CONFIG_CMD_LINK_LOCAL	* link-local IP address auto-configuration
951d22c338eSJoe Hershberger					  (169.254.*.*)
952602ad3b3SJon Loeliger		CONFIG_CMD_LOADB	  loadb
953602ad3b3SJon Loeliger		CONFIG_CMD_LOADS	  loads
9544d98b5c8SVincent Stehlé		CONFIG_CMD_MD5SUM	* print md5 message digest
95502c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
95615a33e49SSimon Glass		CONFIG_CMD_MEMINFO	* Display detailed memory information
957602ad3b3SJon Loeliger		CONFIG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
958a2681707SWolfgang Denk					  loop, loopw
9594d98b5c8SVincent Stehlé		CONFIG_CMD_MEMTEST	* mtest
960602ad3b3SJon Loeliger		CONFIG_CMD_MISC		  Misc functions like sleep etc
961602ad3b3SJon Loeliger		CONFIG_CMD_MMC		* MMC memory mapped support
962602ad3b3SJon Loeliger		CONFIG_CMD_MII		* MII utility commands
96368d7d651SStefan Roese		CONFIG_CMD_MTDPARTS	* MTD partition support
964602ad3b3SJon Loeliger		CONFIG_CMD_NAND		* NAND support
965602ad3b3SJon Loeliger		CONFIG_CMD_NET		  bootp, tftpboot, rarpboot
9664d98b5c8SVincent Stehlé		CONFIG_CMD_NFS		  NFS support
967e92739d3SPeter Tyser		CONFIG_CMD_PCA953X	* PCA953x I2C gpio commands
968e92739d3SPeter Tyser		CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
969602ad3b3SJon Loeliger		CONFIG_CMD_PCI		* pciinfo
970602ad3b3SJon Loeliger		CONFIG_CMD_PCMCIA		* PCMCIA support
971602ad3b3SJon Loeliger		CONFIG_CMD_PING		* send ICMP ECHO_REQUEST to network
972602ad3b3SJon Loeliger					  host
973602ad3b3SJon Loeliger		CONFIG_CMD_PORTIO	* Port I/O
974ff048ea9SKenneth Waters		CONFIG_CMD_READ		* Read raw data from partition
975602ad3b3SJon Loeliger		CONFIG_CMD_REGINFO	* Register dump
976602ad3b3SJon Loeliger		CONFIG_CMD_RUN		  run command in env variable
977d304931fSSimon Glass		CONFIG_CMD_SANDBOX	* sb command to access sandbox features
978602ad3b3SJon Loeliger		CONFIG_CMD_SAVES	* save S record dump
979602ad3b3SJon Loeliger		CONFIG_CMD_SCSI		* SCSI Support
980602ad3b3SJon Loeliger		CONFIG_CMD_SDRAM	* print SDRAM configuration information
981602ad3b3SJon Loeliger					  (requires CONFIG_CMD_I2C)
982602ad3b3SJon Loeliger		CONFIG_CMD_SETGETDCR	  Support for DCR Register access
983602ad3b3SJon Loeliger					  (4xx only)
984f61ec45eSEric Nelson		CONFIG_CMD_SF		* Read/write/erase SPI NOR flash
9854d98b5c8SVincent Stehlé		CONFIG_CMD_SHA1SUM	* print sha1 memory digest
98602c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY)
9877d861d95SBob Liu		CONFIG_CMD_SOFTSWITCH	* Soft switch setting command for BF60x
98874de7aefSWolfgang Denk		CONFIG_CMD_SOURCE	  "source" command Support
989602ad3b3SJon Loeliger		CONFIG_CMD_SPI		* SPI serial bus support
9907a83af07SLuca Ceresoli		CONFIG_CMD_TFTPSRV	* TFTP transfer in server mode
9911fb7cd49SSimon Glass		CONFIG_CMD_TFTPPUT	* TFTP put command (upload)
992da83bcd7SJoe Hershberger		CONFIG_CMD_TIME		* run command and report execution time (ARM specific)
993da83bcd7SJoe Hershberger		CONFIG_CMD_TIMER	* access to the system tick timer
994602ad3b3SJon Loeliger		CONFIG_CMD_USB		* USB support
995602ad3b3SJon Loeliger		CONFIG_CMD_CDP		* Cisco Discover Protocol support
996c8339f51SMarek Vasut		CONFIG_CMD_MFSL		* Microblaze FSL support
9974d98b5c8SVincent Stehlé		CONFIG_CMD_XIMG		  Load part of Multi Image
998c609719bSwdenk
999c609719bSwdenk
1000c609719bSwdenk		EXAMPLE: If you want all functions except of network
1001c609719bSwdenk		support you can write:
1002c609719bSwdenk
1003602ad3b3SJon Loeliger		#include "config_cmd_all.h"
1004602ad3b3SJon Loeliger		#undef CONFIG_CMD_NET
1005c609719bSwdenk
1006213bf8c8SGerald Van Baren	Other Commands:
1007213bf8c8SGerald Van Baren		fdt (flattened device tree) command: CONFIG_OF_LIBFDT
1008c609719bSwdenk
1009c609719bSwdenk	Note:	Don't enable the "icache" and "dcache" commands
1010602ad3b3SJon Loeliger		(configuration option CONFIG_CMD_CACHE) unless you know
1011c609719bSwdenk		what you (and your U-Boot users) are doing. Data
1012c609719bSwdenk		cache cannot be enabled on systems like the 8xx or
1013c609719bSwdenk		8260 (where accesses to the IMMR region must be
1014c609719bSwdenk		uncached), and it cannot be disabled on all other
1015c609719bSwdenk		systems where we (mis-) use the data cache to hold an
1016c609719bSwdenk		initial stack and some data.
1017c609719bSwdenk
1018c609719bSwdenk
1019c609719bSwdenk		XXX - this list needs to get updated!
1020c609719bSwdenk
1021a5ecbe62SWolfgang Denk- Regular expression support:
1022a5ecbe62SWolfgang Denk		CONFIG_REGEX
1023a5ecbe62SWolfgang Denk		If this variable is defined, U-Boot is linked against
1024a5ecbe62SWolfgang Denk		the SLRE (Super Light Regular Expression) library,
1025a5ecbe62SWolfgang Denk		which adds regex support to some commands, as for
1026a5ecbe62SWolfgang Denk		example "env grep" and "setexpr".
1027a5ecbe62SWolfgang Denk
102845ba8077SSimon Glass- Device tree:
102945ba8077SSimon Glass		CONFIG_OF_CONTROL
103045ba8077SSimon Glass		If this variable is defined, U-Boot will use a device tree
103145ba8077SSimon Glass		to configure its devices, instead of relying on statically
103245ba8077SSimon Glass		compiled #defines in the board file. This option is
103345ba8077SSimon Glass		experimental and only available on a few boards. The device
103445ba8077SSimon Glass		tree is available in the global data as gd->fdt_blob.
103545ba8077SSimon Glass
10362c0f79e4SSimon Glass		U-Boot needs to get its device tree from somewhere. This can
10372c0f79e4SSimon Glass		be done using one of the two options below:
1038bbb0b128SSimon Glass
1039bbb0b128SSimon Glass		CONFIG_OF_EMBED
1040bbb0b128SSimon Glass		If this variable is defined, U-Boot will embed a device tree
1041bbb0b128SSimon Glass		binary in its image. This device tree file should be in the
1042bbb0b128SSimon Glass		board directory and called <soc>-<board>.dts. The binary file
1043bbb0b128SSimon Glass		is then picked up in board_init_f() and made available through
1044bbb0b128SSimon Glass		the global data structure as gd->blob.
104545ba8077SSimon Glass
10462c0f79e4SSimon Glass		CONFIG_OF_SEPARATE
10472c0f79e4SSimon Glass		If this variable is defined, U-Boot will build a device tree
10482c0f79e4SSimon Glass		binary. It will be called u-boot.dtb. Architecture-specific
10492c0f79e4SSimon Glass		code will locate it at run-time. Generally this works by:
10502c0f79e4SSimon Glass
10512c0f79e4SSimon Glass			cat u-boot.bin u-boot.dtb >image.bin
10522c0f79e4SSimon Glass
10532c0f79e4SSimon Glass		and in fact, U-Boot does this for you, creating a file called
10542c0f79e4SSimon Glass		u-boot-dtb.bin which is useful in the common case. You can
10552c0f79e4SSimon Glass		still use the individual files if you need something more
10562c0f79e4SSimon Glass		exotic.
10572c0f79e4SSimon Glass
1058c609719bSwdenk- Watchdog:
1059c609719bSwdenk		CONFIG_WATCHDOG
1060c609719bSwdenk		If this variable is defined, it enables watchdog
10616abe6fb6SDetlev Zundel		support for the SoC. There must be support in the SoC
10626abe6fb6SDetlev Zundel		specific code for a watchdog. For the 8xx and 8260
10636abe6fb6SDetlev Zundel		CPUs, the SIU Watchdog feature is enabled in the SYPCR
10646abe6fb6SDetlev Zundel		register.  When supported for a specific SoC is
10656abe6fb6SDetlev Zundel		available, then no further board specific code should
10666abe6fb6SDetlev Zundel		be needed to use it.
10676abe6fb6SDetlev Zundel
10686abe6fb6SDetlev Zundel		CONFIG_HW_WATCHDOG
10696abe6fb6SDetlev Zundel		When using a watchdog circuitry external to the used
10706abe6fb6SDetlev Zundel		SoC, then define this variable and provide board
10716abe6fb6SDetlev Zundel		specific code for the "hw_watchdog_reset" function.
1072c609719bSwdenk
1073c1551ea8Sstroese- U-Boot Version:
1074c1551ea8Sstroese		CONFIG_VERSION_VARIABLE
1075c1551ea8Sstroese		If this variable is defined, an environment variable
1076c1551ea8Sstroese		named "ver" is created by U-Boot showing the U-Boot
1077c1551ea8Sstroese		version as printed by the "version" command.
1078a1ea8e51SBenoît Thébaudeau		Any change to this variable will be reverted at the
1079a1ea8e51SBenoît Thébaudeau		next reset.
1080c1551ea8Sstroese
1081c609719bSwdenk- Real-Time Clock:
1082c609719bSwdenk
1083602ad3b3SJon Loeliger		When CONFIG_CMD_DATE is selected, the type of the RTC
1084c609719bSwdenk		has to be selected, too. Define exactly one of the
1085c609719bSwdenk		following options:
1086c609719bSwdenk
1087c609719bSwdenk		CONFIG_RTC_MPC8xx	- use internal RTC of MPC8xx
1088c609719bSwdenk		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
10894e8b7544SFabio Estevam		CONFIG_RTC_MC13XXX	- use MC13783 or MC13892 RTC
1090c609719bSwdenk		CONFIG_RTC_MC146818	- use MC146818 RTC
10911cb8e980Swdenk		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
1092c609719bSwdenk		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
10937f70e853Swdenk		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
10943bac3513Swdenk		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
10959536dfccSTor Krill		CONFIG_RTC_ISL1208	- use Intersil ISL1208 RTC
10964c0d4c3bSwdenk		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
10976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_DS1337_NOOSC	- Turn off the OSC output for DS1337
109871d19f30SHeiko Schocher		CONFIG_SYS_RV3029_TCR	- enable trickle charger on
109971d19f30SHeiko Schocher					  RV3029 RTC.
1100c609719bSwdenk
1101b37c7e5eSwdenk		Note that if the RTC uses I2C, then the I2C interface
1102b37c7e5eSwdenk		must also be configured. See I2C Support, below.
1103b37c7e5eSwdenk
1104e92739d3SPeter Tyser- GPIO Support:
1105e92739d3SPeter Tyser		CONFIG_PCA953X		- use NXP's PCA953X series I2C GPIO
1106e92739d3SPeter Tyser
11075dec49caSChris Packham		The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
11085dec49caSChris Packham		chip-ngpio pairs that tell the PCA953X driver the number of
11095dec49caSChris Packham		pins supported by a particular chip.
11105dec49caSChris Packham
1111e92739d3SPeter Tyser		Note that if the GPIO device uses I2C, then the I2C interface
1112e92739d3SPeter Tyser		must also be configured. See I2C Support, below.
1113e92739d3SPeter Tyser
1114c609719bSwdenk- Timestamp Support:
1115c609719bSwdenk
1116c609719bSwdenk		When CONFIG_TIMESTAMP is selected, the timestamp
1117c609719bSwdenk		(date and time) of an image is printed by image
1118c609719bSwdenk		commands like bootm or iminfo. This option is
1119602ad3b3SJon Loeliger		automatically enabled when you select CONFIG_CMD_DATE .
1120c609719bSwdenk
1121923c46f9SKarl O. Pinc- Partition Labels (disklabels) Supported:
1122923c46f9SKarl O. Pinc		Zero or more of the following:
1123923c46f9SKarl O. Pinc		CONFIG_MAC_PARTITION   Apple's MacOS partition table.
1124923c46f9SKarl O. Pinc		CONFIG_DOS_PARTITION   MS Dos partition table, traditional on the
1125923c46f9SKarl O. Pinc				       Intel architecture, USB sticks, etc.
1126923c46f9SKarl O. Pinc		CONFIG_ISO_PARTITION   ISO partition table, used on CDROM etc.
1127923c46f9SKarl O. Pinc		CONFIG_EFI_PARTITION   GPT partition table, common when EFI is the
1128923c46f9SKarl O. Pinc				       bootloader.  Note 2TB partition limit; see
1129923c46f9SKarl O. Pinc				       disk/part_efi.c
1130923c46f9SKarl O. Pinc		CONFIG_MTD_PARTITIONS  Memory Technology Device partition table.
1131c609719bSwdenk
1132602ad3b3SJon Loeliger		If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1133218ca724SWolfgang Denk		CONFIG_CMD_SCSI) you must configure support for at
1134923c46f9SKarl O. Pinc		least one non-MTD partition type as well.
1135c609719bSwdenk
1136c609719bSwdenk- IDE Reset method:
11374d13cbadSwdenk		CONFIG_IDE_RESET_ROUTINE - this is defined in several
11384d13cbadSwdenk		board configurations files but used nowhere!
1139c609719bSwdenk
11404d13cbadSwdenk		CONFIG_IDE_RESET - is this is defined, IDE Reset will
11414d13cbadSwdenk		be performed by calling the function
11424d13cbadSwdenk			ide_set_reset(int reset)
11434d13cbadSwdenk		which has to be defined in a board specific file
1144c609719bSwdenk
1145c609719bSwdenk- ATAPI Support:
1146c609719bSwdenk		CONFIG_ATAPI
1147c609719bSwdenk
1148c609719bSwdenk		Set this to enable ATAPI support.
1149c609719bSwdenk
1150c40b2956Swdenk- LBA48 Support
1151c40b2956Swdenk		CONFIG_LBA48
1152c40b2956Swdenk
1153c40b2956Swdenk		Set this to enable support for disks larger than 137GB
11544b142febSHeiko Schocher		Also look at CONFIG_SYS_64BIT_LBA.
1155c40b2956Swdenk		Whithout these , LBA48 support uses 32bit variables and will 'only'
1156c40b2956Swdenk		support disks up to 2.1TB.
1157c40b2956Swdenk
11586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_64BIT_LBA:
1159c40b2956Swdenk			When enabled, makes the IDE subsystem use 64bit sector addresses.
1160c40b2956Swdenk			Default is 32bit.
1161c40b2956Swdenk
1162c609719bSwdenk- SCSI Support:
1163c609719bSwdenk		At the moment only there is only support for the
1164c609719bSwdenk		SYM53C8XX SCSI controller; define
1165c609719bSwdenk		CONFIG_SCSI_SYM53C8XX to enable it.
1166c609719bSwdenk
11676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
11686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
11696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
1170c609719bSwdenk		maximum numbers of LUNs, SCSI ID's and target
1171c609719bSwdenk		devices.
11726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
1173c609719bSwdenk
1174447c031bSStefan Reinauer		The environment variable 'scsidevs' is set to the number of
1175447c031bSStefan Reinauer		SCSI devices found during the last scan.
1176447c031bSStefan Reinauer
1177c609719bSwdenk- NETWORK Support (PCI):
1178682011ffSwdenk		CONFIG_E1000
1179ce5207e1SKyle Moffett		Support for Intel 8254x/8257x gigabit chips.
1180ce5207e1SKyle Moffett
1181ce5207e1SKyle Moffett		CONFIG_E1000_SPI
1182ce5207e1SKyle Moffett		Utility code for direct access to the SPI bus on Intel 8257x.
1183ce5207e1SKyle Moffett		This does not do anything useful unless you set at least one
1184ce5207e1SKyle Moffett		of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1185ce5207e1SKyle Moffett
1186ce5207e1SKyle Moffett		CONFIG_E1000_SPI_GENERIC
1187ce5207e1SKyle Moffett		Allow generic access to the SPI bus on the Intel 8257x, for
1188ce5207e1SKyle Moffett		example with the "sspi" command.
1189ce5207e1SKyle Moffett
1190ce5207e1SKyle Moffett		CONFIG_CMD_E1000
1191ce5207e1SKyle Moffett		Management command for E1000 devices.  When used on devices
1192ce5207e1SKyle Moffett		with SPI support you can reprogram the EEPROM from U-Boot.
1193682011ffSwdenk
1194ac3315c2SAndre Schwarz		CONFIG_E1000_FALLBACK_MAC
119511ccc33fSMarcel Ziswiler		default MAC for empty EEPROM after production.
1196ac3315c2SAndre Schwarz
1197c609719bSwdenk		CONFIG_EEPRO100
1198c609719bSwdenk		Support for Intel 82557/82559/82559ER chips.
119911ccc33fSMarcel Ziswiler		Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
1200c609719bSwdenk		write routine for first time initialisation.
1201c609719bSwdenk
1202c609719bSwdenk		CONFIG_TULIP
1203c609719bSwdenk		Support for Digital 2114x chips.
1204c609719bSwdenk		Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1205c609719bSwdenk		modem chip initialisation (KS8761/QS6611).
1206c609719bSwdenk
1207c609719bSwdenk		CONFIG_NATSEMI
1208c609719bSwdenk		Support for National dp83815 chips.
1209c609719bSwdenk
1210c609719bSwdenk		CONFIG_NS8382X
1211c609719bSwdenk		Support for National dp8382[01] gigabit chips.
1212c609719bSwdenk
121345219c46Swdenk- NETWORK Support (other):
121445219c46Swdenk
1215c041e9d2SJens Scharsig		CONFIG_DRIVER_AT91EMAC
1216c041e9d2SJens Scharsig		Support for AT91RM9200 EMAC.
1217c041e9d2SJens Scharsig
1218c041e9d2SJens Scharsig			CONFIG_RMII
1219c041e9d2SJens Scharsig			Define this to use reduced MII inteface
1220c041e9d2SJens Scharsig
1221c041e9d2SJens Scharsig			CONFIG_DRIVER_AT91EMAC_QUIET
1222c041e9d2SJens Scharsig			If this defined, the driver is quiet.
1223c041e9d2SJens Scharsig			The driver doen't show link status messages.
1224c041e9d2SJens Scharsig
1225efdd7319SRob Herring		CONFIG_CALXEDA_XGMAC
1226efdd7319SRob Herring		Support for the Calxeda XGMAC device
1227efdd7319SRob Herring
12283bb46d23SAshok		CONFIG_LAN91C96
122945219c46Swdenk		Support for SMSC's LAN91C96 chips.
123045219c46Swdenk
123145219c46Swdenk			CONFIG_LAN91C96_BASE
123245219c46Swdenk			Define this to hold the physical address
123345219c46Swdenk			of the LAN91C96's I/O space
123445219c46Swdenk
123545219c46Swdenk			CONFIG_LAN91C96_USE_32_BIT
123645219c46Swdenk			Define this to enable 32 bit addressing
123745219c46Swdenk
12383bb46d23SAshok		CONFIG_SMC91111
1239f39748aeSwdenk		Support for SMSC's LAN91C111 chip
1240f39748aeSwdenk
1241f39748aeSwdenk			CONFIG_SMC91111_BASE
1242f39748aeSwdenk			Define this to hold the physical address
1243f39748aeSwdenk			of the device (I/O space)
1244f39748aeSwdenk
1245f39748aeSwdenk			CONFIG_SMC_USE_32_BIT
1246f39748aeSwdenk			Define this if data bus is 32 bits
1247f39748aeSwdenk
1248f39748aeSwdenk			CONFIG_SMC_USE_IOFUNCS
1249f39748aeSwdenk			Define this to use i/o functions instead of macros
1250f39748aeSwdenk			(some hardware wont work with macros)
1251f39748aeSwdenk
1252dc02badaSHeiko Schocher		CONFIG_DRIVER_TI_EMAC
1253dc02badaSHeiko Schocher		Support for davinci emac
1254dc02badaSHeiko Schocher
1255dc02badaSHeiko Schocher			CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1256dc02badaSHeiko Schocher			Define this if you have more then 3 PHYs.
1257dc02badaSHeiko Schocher
1258b3dbf4a5SMacpaul Lin		CONFIG_FTGMAC100
1259b3dbf4a5SMacpaul Lin		Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1260b3dbf4a5SMacpaul Lin
1261b3dbf4a5SMacpaul Lin			CONFIG_FTGMAC100_EGIGA
1262b3dbf4a5SMacpaul Lin			Define this to use GE link update with gigabit PHY.
1263b3dbf4a5SMacpaul Lin			Define this if FTGMAC100 is connected to gigabit PHY.
1264b3dbf4a5SMacpaul Lin			If your system has 10/100 PHY only, it might not occur
1265b3dbf4a5SMacpaul Lin			wrong behavior. Because PHY usually return timeout or
1266b3dbf4a5SMacpaul Lin			useless data when polling gigabit status and gigabit
1267b3dbf4a5SMacpaul Lin			control registers. This behavior won't affect the
1268b3dbf4a5SMacpaul Lin			correctnessof 10/100 link speed update.
1269b3dbf4a5SMacpaul Lin
1270c2fff331SMike Rapoport		CONFIG_SMC911X
1271557b377dSJens Gehrlein		Support for SMSC's LAN911x and LAN921x chips
1272557b377dSJens Gehrlein
1273c2fff331SMike Rapoport			CONFIG_SMC911X_BASE
1274557b377dSJens Gehrlein			Define this to hold the physical address
1275557b377dSJens Gehrlein			of the device (I/O space)
1276557b377dSJens Gehrlein
1277c2fff331SMike Rapoport			CONFIG_SMC911X_32_BIT
1278557b377dSJens Gehrlein			Define this if data bus is 32 bits
1279557b377dSJens Gehrlein
1280c2fff331SMike Rapoport			CONFIG_SMC911X_16_BIT
1281557b377dSJens Gehrlein			Define this if data bus is 16 bits. If your processor
1282557b377dSJens Gehrlein			automatically converts one 32 bit word to two 16 bit
1283c2fff331SMike Rapoport			words you may also try CONFIG_SMC911X_32_BIT.
1284557b377dSJens Gehrlein
12853d0075faSYoshihiro Shimoda		CONFIG_SH_ETHER
12863d0075faSYoshihiro Shimoda		Support for Renesas on-chip Ethernet controller
12873d0075faSYoshihiro Shimoda
12883d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_USE_PORT
12893d0075faSYoshihiro Shimoda			Define the number of ports to be used
12903d0075faSYoshihiro Shimoda
12913d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_PHY_ADDR
12923d0075faSYoshihiro Shimoda			Define the ETH PHY's address
12933d0075faSYoshihiro Shimoda
129468260aabSYoshihiro Shimoda			CONFIG_SH_ETHER_CACHE_WRITEBACK
129568260aabSYoshihiro Shimoda			If this option is set, the driver enables cache flush.
129668260aabSYoshihiro Shimoda
12975e124724SVadim Bendebury- TPM Support:
129890899cc0SChe-liang Chiou		CONFIG_TPM
129990899cc0SChe-liang Chiou		Support TPM devices.
130090899cc0SChe-liang Chiou
13011b393db5STom Wai-Hong Tam		CONFIG_TPM_TIS_I2C
13021b393db5STom Wai-Hong Tam		Support for i2c bus TPM devices. Only one device
13031b393db5STom Wai-Hong Tam		per system is supported at this time.
13041b393db5STom Wai-Hong Tam
13051b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_BUS_NUMBER
13061b393db5STom Wai-Hong Tam			Define the the i2c bus number for the TPM device
13071b393db5STom Wai-Hong Tam
13081b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS
13091b393db5STom Wai-Hong Tam			Define the TPM's address on the i2c bus
13101b393db5STom Wai-Hong Tam
13111b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_BURST_LIMITATION
13121b393db5STom Wai-Hong Tam			Define the burst count bytes upper limit
13131b393db5STom Wai-Hong Tam
1314c01939c7SDirk Eibach		CONFIG_TPM_ATMEL_TWI
1315c01939c7SDirk Eibach		Support for Atmel TWI TPM device. Requires I2C support.
1316c01939c7SDirk Eibach
131790899cc0SChe-liang Chiou		CONFIG_TPM_TIS_LPC
13185e124724SVadim Bendebury		Support for generic parallel port TPM devices. Only one device
13195e124724SVadim Bendebury		per system is supported at this time.
13205e124724SVadim Bendebury
13215e124724SVadim Bendebury			CONFIG_TPM_TIS_BASE_ADDRESS
13225e124724SVadim Bendebury			Base address where the generic TPM device is mapped
13235e124724SVadim Bendebury			to. Contemporary x86 systems usually map it at
13245e124724SVadim Bendebury			0xfed40000.
13255e124724SVadim Bendebury
1326be6c1529SReinhard Pfau		CONFIG_CMD_TPM
1327be6c1529SReinhard Pfau		Add tpm monitor functions.
1328be6c1529SReinhard Pfau		Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1329be6c1529SReinhard Pfau		provides monitor access to authorized functions.
1330be6c1529SReinhard Pfau
1331be6c1529SReinhard Pfau		CONFIG_TPM
1332be6c1529SReinhard Pfau		Define this to enable the TPM support library which provides
1333be6c1529SReinhard Pfau		functional interfaces to some TPM commands.
1334be6c1529SReinhard Pfau		Requires support for a TPM device.
1335be6c1529SReinhard Pfau
1336be6c1529SReinhard Pfau		CONFIG_TPM_AUTH_SESSIONS
1337be6c1529SReinhard Pfau		Define this to enable authorized functions in the TPM library.
1338be6c1529SReinhard Pfau		Requires CONFIG_TPM and CONFIG_SHA1.
1339be6c1529SReinhard Pfau
1340c609719bSwdenk- USB Support:
1341c609719bSwdenk		At the moment only the UHCI host controller is
13424d13cbadSwdenk		supported (PIP405, MIP405, MPC5200); define
1343c609719bSwdenk		CONFIG_USB_UHCI to enable it.
1344c609719bSwdenk		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
134530d56faeSwdenk		and define CONFIG_USB_STORAGE to enable the USB
1346c609719bSwdenk		storage devices.
1347c609719bSwdenk		Note:
1348c609719bSwdenk		Supported are USB Keyboards and USB Floppy drives
1349c609719bSwdenk		(TEAC FD-05PUB).
13504d13cbadSwdenk		MPC5200 USB requires additional defines:
13514d13cbadSwdenk			CONFIG_USB_CLOCK
13524d13cbadSwdenk				for 528 MHz Clock: 0x0001bbbb
1353307ecb6dSEric Millbrandt			CONFIG_PSC3_USB
1354307ecb6dSEric Millbrandt				for USB on PSC3
13554d13cbadSwdenk			CONFIG_USB_CONFIG
13564d13cbadSwdenk				for differential drivers: 0x00001000
13574d13cbadSwdenk				for single ended drivers: 0x00005000
1358307ecb6dSEric Millbrandt				for differential drivers on PSC3: 0x00000100
1359307ecb6dSEric Millbrandt				for single ended drivers on PSC3: 0x00004100
13606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_USB_EVENT_POLL
1361fdcfaa1bSZhang Wei				May be defined to allow interrupt polling
1362fdcfaa1bSZhang Wei				instead of using asynchronous interrupts
13634d13cbadSwdenk
13649ab4ce22SSimon Glass		CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
13659ab4ce22SSimon Glass		txfilltuning field in the EHCI controller on reset.
13669ab4ce22SSimon Glass
1367aa155058SKuo-Jung Su		CONFIG_USB_HUB_MIN_POWER_ON_DELAY defines the minimum
1368aa155058SKuo-Jung Su		interval for usb hub power-on delay.(minimum 100msec)
1369aa155058SKuo-Jung Su
137016c8d5e7SWolfgang Denk- USB Device:
137116c8d5e7SWolfgang Denk		Define the below if you wish to use the USB console.
137216c8d5e7SWolfgang Denk		Once firmware is rebuilt from a serial console issue the
137316c8d5e7SWolfgang Denk		command "setenv stdin usbtty; setenv stdout usbtty" and
137411ccc33fSMarcel Ziswiler		attach your USB cable. The Unix command "dmesg" should print
137516c8d5e7SWolfgang Denk		it has found a new device. The environment variable usbtty
137616c8d5e7SWolfgang Denk		can be set to gserial or cdc_acm to enable your device to
137716c8d5e7SWolfgang Denk		appear to a USB host as a Linux gserial device or a
137816c8d5e7SWolfgang Denk		Common Device Class Abstract Control Model serial device.
137916c8d5e7SWolfgang Denk		If you select usbtty = gserial you should be able to enumerate
138016c8d5e7SWolfgang Denk		a Linux host by
138116c8d5e7SWolfgang Denk		# modprobe usbserial vendor=0xVendorID product=0xProductID
138216c8d5e7SWolfgang Denk		else if using cdc_acm, simply setting the environment
138316c8d5e7SWolfgang Denk		variable usbtty to be cdc_acm should suffice. The following
138416c8d5e7SWolfgang Denk		might be defined in YourBoardName.h
138516c8d5e7SWolfgang Denk
138616c8d5e7SWolfgang Denk			CONFIG_USB_DEVICE
138716c8d5e7SWolfgang Denk			Define this to build a UDC device
138816c8d5e7SWolfgang Denk
138916c8d5e7SWolfgang Denk			CONFIG_USB_TTY
139016c8d5e7SWolfgang Denk			Define this to have a tty type of device available to
139116c8d5e7SWolfgang Denk			talk to the UDC device
139216c8d5e7SWolfgang Denk
1393f9da0f89SVipin KUMAR			CONFIG_USBD_HS
1394f9da0f89SVipin KUMAR			Define this to enable the high speed support for usb
1395f9da0f89SVipin KUMAR			device and usbtty. If this feature is enabled, a routine
1396f9da0f89SVipin KUMAR			int is_usbd_high_speed(void)
1397f9da0f89SVipin KUMAR			also needs to be defined by the driver to dynamically poll
1398f9da0f89SVipin KUMAR			whether the enumeration has succeded at high speed or full
1399f9da0f89SVipin KUMAR			speed.
1400f9da0f89SVipin KUMAR
14016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_IS_IN_ENV
140216c8d5e7SWolfgang Denk			Define this if you want stdin, stdout &/or stderr to
140316c8d5e7SWolfgang Denk			be set to usbtty.
140416c8d5e7SWolfgang Denk
140516c8d5e7SWolfgang Denk			mpc8xx:
14066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_EXTC_CLK 0xBLAH
140716c8d5e7SWolfgang Denk				Derive USB clock from external clock "blah"
14086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_EXTC_CLK 0x02
140916c8d5e7SWolfgang Denk
14106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_BRG_CLK 0xBLAH
141116c8d5e7SWolfgang Denk				Derive USB clock from brgclk
14126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_BRG_CLK 0x04
141316c8d5e7SWolfgang Denk
141416c8d5e7SWolfgang Denk		If you have a USB-IF assigned VendorID then you may wish to
141516c8d5e7SWolfgang Denk		define your own vendor specific values either in BoardName.h
141616c8d5e7SWolfgang Denk		or directly in usbd_vendor_info.h. If you don't define
141716c8d5e7SWolfgang Denk		CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
141816c8d5e7SWolfgang Denk		CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
141916c8d5e7SWolfgang Denk		should pretend to be a Linux device to it's target host.
142016c8d5e7SWolfgang Denk
142116c8d5e7SWolfgang Denk			CONFIG_USBD_MANUFACTURER
142216c8d5e7SWolfgang Denk			Define this string as the name of your company for
142316c8d5e7SWolfgang Denk			- CONFIG_USBD_MANUFACTURER "my company"
142416c8d5e7SWolfgang Denk
142516c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCT_NAME
142616c8d5e7SWolfgang Denk			Define this string as the name of your product
142716c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCT_NAME "acme usb device"
142816c8d5e7SWolfgang Denk
142916c8d5e7SWolfgang Denk			CONFIG_USBD_VENDORID
143016c8d5e7SWolfgang Denk			Define this as your assigned Vendor ID from the USB
143116c8d5e7SWolfgang Denk			Implementors Forum. This *must* be a genuine Vendor ID
143216c8d5e7SWolfgang Denk			to avoid polluting the USB namespace.
143316c8d5e7SWolfgang Denk			- CONFIG_USBD_VENDORID 0xFFFF
143416c8d5e7SWolfgang Denk
143516c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCTID
143616c8d5e7SWolfgang Denk			Define this as the unique Product ID
143716c8d5e7SWolfgang Denk			for your device
143816c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCTID 0xFFFF
1439c609719bSwdenk
1440351e9b20SPrzemyslaw Marczak		Some USB device drivers may need to check USB cable attachment.
1441351e9b20SPrzemyslaw Marczak		In this case you can enable following config in BoardName.h:
1442351e9b20SPrzemyslaw Marczak			CONFIG_USB_CABLE_CHECK
1443351e9b20SPrzemyslaw Marczak			This enables function definition:
1444351e9b20SPrzemyslaw Marczak			- usb_cable_connected() in include/usb.h
1445351e9b20SPrzemyslaw Marczak			Implementation of this function is board-specific.
1446351e9b20SPrzemyslaw Marczak
1447d70a560fSIgor Grinberg- ULPI Layer Support:
1448d70a560fSIgor Grinberg		The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1449d70a560fSIgor Grinberg		the generic ULPI layer. The generic layer accesses the ULPI PHY
1450d70a560fSIgor Grinberg		via the platform viewport, so you need both the genric layer and
1451d70a560fSIgor Grinberg		the viewport enabled. Currently only Chipidea/ARC based
1452d70a560fSIgor Grinberg		viewport is supported.
1453d70a560fSIgor Grinberg		To enable the ULPI layer support, define CONFIG_USB_ULPI and
1454d70a560fSIgor Grinberg		CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
14556d365ea0SLucas Stach		If your ULPI phy needs a different reference clock than the
14566d365ea0SLucas Stach		standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
14576d365ea0SLucas Stach		the appropriate value in Hz.
1458c609719bSwdenk
1459c609719bSwdenk- MMC Support:
1460c609719bSwdenk		The MMC controller on the Intel PXA is supported. To
1461c609719bSwdenk		enable this define CONFIG_MMC. The MMC can be
1462c609719bSwdenk		accessed from the boot prompt by mapping the device
1463c609719bSwdenk		to physical memory similar to flash. Command line is
1464602ad3b3SJon Loeliger		enabled with CONFIG_CMD_MMC. The MMC driver also works with
1465602ad3b3SJon Loeliger		the FAT fs. This is enabled with CONFIG_CMD_FAT.
1466c609719bSwdenk
1467afb35666SYoshihiro Shimoda		CONFIG_SH_MMCIF
1468afb35666SYoshihiro Shimoda		Support for Renesas on-chip MMCIF controller
1469afb35666SYoshihiro Shimoda
1470afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_ADDR
1471afb35666SYoshihiro Shimoda			Define the base address of MMCIF registers
1472afb35666SYoshihiro Shimoda
1473afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_CLK
1474afb35666SYoshihiro Shimoda			Define the clock frequency for MMCIF
1475afb35666SYoshihiro Shimoda
1476b3ba6e94STom Rini- USB Device Firmware Update (DFU) class support:
1477b3ba6e94STom Rini		CONFIG_DFU_FUNCTION
1478b3ba6e94STom Rini		This enables the USB portion of the DFU USB class
1479b3ba6e94STom Rini
1480b3ba6e94STom Rini		CONFIG_CMD_DFU
1481b3ba6e94STom Rini		This enables the command "dfu" which is used to have
1482b3ba6e94STom Rini		U-Boot create a DFU class device via USB.  This command
1483b3ba6e94STom Rini		requires that the "dfu_alt_info" environment variable be
1484b3ba6e94STom Rini		set and define the alt settings to expose to the host.
1485b3ba6e94STom Rini
1486b3ba6e94STom Rini		CONFIG_DFU_MMC
1487b3ba6e94STom Rini		This enables support for exposing (e)MMC devices via DFU.
1488b3ba6e94STom Rini
1489c6631764SPantelis Antoniou		CONFIG_DFU_NAND
1490c6631764SPantelis Antoniou		This enables support for exposing NAND devices via DFU.
1491c6631764SPantelis Antoniou
1492a9479f04SAfzal Mohammed		CONFIG_DFU_RAM
1493a9479f04SAfzal Mohammed		This enables support for exposing RAM via DFU.
1494a9479f04SAfzal Mohammed		Note: DFU spec refer to non-volatile memory usage, but
1495a9479f04SAfzal Mohammed		allow usages beyond the scope of spec - here RAM usage,
1496a9479f04SAfzal Mohammed		one that would help mostly the developer.
1497a9479f04SAfzal Mohammed
1498e7e75c70SHeiko Schocher		CONFIG_SYS_DFU_DATA_BUF_SIZE
1499e7e75c70SHeiko Schocher		Dfu transfer uses a buffer before writing data to the
1500e7e75c70SHeiko Schocher		raw storage device. Make the size (in bytes) of this buffer
1501e7e75c70SHeiko Schocher		configurable. The size of this buffer is also configurable
1502e7e75c70SHeiko Schocher		through the "dfu_bufsiz" environment variable.
1503e7e75c70SHeiko Schocher
1504ea2453d5SPantelis Antoniou		CONFIG_SYS_DFU_MAX_FILE_SIZE
1505ea2453d5SPantelis Antoniou		When updating files rather than the raw storage device,
1506ea2453d5SPantelis Antoniou		we use a static buffer to copy the file into and then write
1507ea2453d5SPantelis Antoniou		the buffer once we've been given the whole file.  Define
1508ea2453d5SPantelis Antoniou		this to the maximum filesize (in bytes) for the buffer.
1509ea2453d5SPantelis Antoniou		Default is 4 MiB if undefined.
1510ea2453d5SPantelis Antoniou
15116705d81eSwdenk- Journaling Flash filesystem support:
15126705d81eSwdenk		CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
15136705d81eSwdenk		CONFIG_JFFS2_NAND_DEV
15146705d81eSwdenk		Define these for a default partition on a NAND device
15156705d81eSwdenk
15166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_SECTOR,
15176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
15186705d81eSwdenk		Define these for a default partition on a NOR device
15196705d81eSwdenk
15206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS_CUSTOM_PART
15216705d81eSwdenk		Define this to create an own partition. You have to provide a
15226705d81eSwdenk		function struct part_info* jffs2_part_info(int part_num)
15236705d81eSwdenk
15246705d81eSwdenk		If you define only one JFFS2 partition you may also want to
15256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_JFFS_SINGLE_PART	1
15266705d81eSwdenk		to disable the command chpart. This is the default when you
15276705d81eSwdenk		have not defined a custom partition
15286705d81eSwdenk
1529c30a15e5SDonggeun Kim- FAT(File Allocation Table) filesystem write function support:
1530c30a15e5SDonggeun Kim		CONFIG_FAT_WRITE
1531656f4c65SDonggeun Kim
1532656f4c65SDonggeun Kim		Define this to enable support for saving memory data as a
1533656f4c65SDonggeun Kim		file in FAT formatted partition.
1534656f4c65SDonggeun Kim
1535656f4c65SDonggeun Kim		This will also enable the command "fatwrite" enabling the
1536656f4c65SDonggeun Kim		user to write files to FAT.
1537c30a15e5SDonggeun Kim
153884cd9327SGabe BlackCBFS (Coreboot Filesystem) support
153984cd9327SGabe Black		CONFIG_CMD_CBFS
154084cd9327SGabe Black
154184cd9327SGabe Black		Define this to enable support for reading from a Coreboot
154284cd9327SGabe Black		filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
154384cd9327SGabe Black		and cbfsload.
154484cd9327SGabe Black
1545c609719bSwdenk- Keyboard Support:
1546c609719bSwdenk		CONFIG_ISA_KEYBOARD
1547c609719bSwdenk
1548c609719bSwdenk		Define this to enable standard (PC-Style) keyboard
1549c609719bSwdenk		support
1550c609719bSwdenk
1551c609719bSwdenk		CONFIG_I8042_KBD
1552c609719bSwdenk		Standard PC keyboard driver with US (is default) and
1553c609719bSwdenk		GERMAN key layout (switch via environment 'keymap=de') support.
1554c609719bSwdenk		Export function i8042_kbd_init, i8042_tstc and i8042_getc
1555c609719bSwdenk		for cfb_console. Supports cursor blinking.
1556c609719bSwdenk
1557713cb680SHung-ying Tyan		CONFIG_CROS_EC_KEYB
1558713cb680SHung-ying Tyan		Enables a Chrome OS keyboard using the CROS_EC interface.
1559713cb680SHung-ying Tyan		This uses CROS_EC to communicate with a second microcontroller
1560713cb680SHung-ying Tyan		which provides key scans on request.
1561713cb680SHung-ying Tyan
1562c609719bSwdenk- Video support:
1563c609719bSwdenk		CONFIG_VIDEO
1564c609719bSwdenk
1565c609719bSwdenk		Define this to enable video support (for output to
1566c609719bSwdenk		video).
1567c609719bSwdenk
1568c609719bSwdenk		CONFIG_VIDEO_CT69000
1569c609719bSwdenk
1570c609719bSwdenk		Enable Chips & Technologies 69000 Video chip
1571c609719bSwdenk
1572c609719bSwdenk		CONFIG_VIDEO_SMI_LYNXEM
1573eeb1b77bSwdenk		Enable Silicon Motion SMI 712/710/810 Video chip. The
1574eeb1b77bSwdenk		video output is selected via environment 'videoout'
1575eeb1b77bSwdenk		(1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1576eeb1b77bSwdenk		assumed.
1577c609719bSwdenk
1578eeb1b77bSwdenk		For the CT69000 and SMI_LYNXEM drivers, videomode is
157911ccc33fSMarcel Ziswiler		selected via environment 'videomode'. Two different ways
1580eeb1b77bSwdenk		are possible:
1581eeb1b77bSwdenk		- "videomode=num"   'num' is a standard LiLo mode numbers.
1582eeb1b77bSwdenk		Following standard modes are supported	(* is default):
1583eeb1b77bSwdenk
1584eeb1b77bSwdenk		      Colors	640x480 800x600 1024x768 1152x864 1280x1024
1585eeb1b77bSwdenk		-------------+---------------------------------------------
1586eeb1b77bSwdenk		      8 bits |	0x301*	0x303	 0x305	  0x161	    0x307
1587eeb1b77bSwdenk		     15 bits |	0x310	0x313	 0x316	  0x162	    0x319
1588eeb1b77bSwdenk		     16 bits |	0x311	0x314	 0x317	  0x163	    0x31A
1589eeb1b77bSwdenk		     24 bits |	0x312	0x315	 0x318	    ?	    0x31B
1590eeb1b77bSwdenk		-------------+---------------------------------------------
1591c609719bSwdenk		(i.e. setenv videomode 317; saveenv; reset;)
1592c609719bSwdenk
1593eeb1b77bSwdenk		- "videomode=bootargs" all the video parameters are parsed
15947817cb20SMarcel Ziswiler		from the bootargs. (See drivers/video/videomodes.c)
1595eeb1b77bSwdenk
1596eeb1b77bSwdenk
1597a6c7ad2fSwdenk		CONFIG_VIDEO_SED13806
1598a6c7ad2fSwdenk		Enable Epson SED13806 driver. This driver supports 8bpp
1599a6c7ad2fSwdenk		and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1600a6c7ad2fSwdenk		or CONFIG_VIDEO_SED13806_16BPP
1601a6c7ad2fSwdenk
16027d3053fbSTimur Tabi		CONFIG_FSL_DIU_FB
16037d3053fbSTimur Tabi		Enable the Freescale DIU video driver.	Reference boards for
16047d3053fbSTimur Tabi		SOCs that have a DIU should define this macro to enable DIU
16057d3053fbSTimur Tabi		support, and should also define these other macros:
16067d3053fbSTimur Tabi
16077d3053fbSTimur Tabi			CONFIG_SYS_DIU_ADDR
16087d3053fbSTimur Tabi			CONFIG_VIDEO
16097d3053fbSTimur Tabi			CONFIG_CMD_BMP
16107d3053fbSTimur Tabi			CONFIG_CFB_CONSOLE
16117d3053fbSTimur Tabi			CONFIG_VIDEO_SW_CURSOR
16127d3053fbSTimur Tabi			CONFIG_VGA_AS_SINGLE_DEVICE
16137d3053fbSTimur Tabi			CONFIG_VIDEO_LOGO
16147d3053fbSTimur Tabi			CONFIG_VIDEO_BMP_LOGO
16157d3053fbSTimur Tabi
1616ba8e76bdSTimur Tabi		The DIU driver will look for the 'video-mode' environment
1617ba8e76bdSTimur Tabi		variable, and if defined, enable the DIU as a console during
1618ba8e76bdSTimur Tabi		boot.  See the documentation file README.video for a
1619ba8e76bdSTimur Tabi		description of this variable.
16207d3053fbSTimur Tabi
1621058d59b0SSimon Glass		CONFIG_VIDEO_VGA
1622058d59b0SSimon Glass
1623058d59b0SSimon Glass		Enable the VGA video / BIOS for x86. The alternative if you
1624058d59b0SSimon Glass		are using coreboot is to use the coreboot frame buffer
1625058d59b0SSimon Glass		driver.
1626058d59b0SSimon Glass
1627058d59b0SSimon Glass
1628682011ffSwdenk- Keyboard Support:
1629682011ffSwdenk		CONFIG_KEYBOARD
1630682011ffSwdenk
1631682011ffSwdenk		Define this to enable a custom keyboard support.
1632682011ffSwdenk		This simply calls drv_keyboard_init() which must be
1633682011ffSwdenk		defined in your board-specific files.
1634682011ffSwdenk		The only board using this so far is RBC823.
1635a6c7ad2fSwdenk
1636c609719bSwdenk- LCD Support:	CONFIG_LCD
1637c609719bSwdenk
1638c609719bSwdenk		Define this to enable LCD support (for output to LCD
1639c609719bSwdenk		display); also select one of the supported displays
1640c609719bSwdenk		by defining one of these:
1641c609719bSwdenk
164239cf4804SStelian Pop		CONFIG_ATMEL_LCD:
164339cf4804SStelian Pop
164439cf4804SStelian Pop			HITACHI TX09D70VM1CCA, 3.5", 240x320.
164539cf4804SStelian Pop
1646fd3103bbSwdenk		CONFIG_NEC_NL6448AC33:
1647c609719bSwdenk
1648fd3103bbSwdenk			NEC NL6448AC33-18. Active, color, single scan.
1649c609719bSwdenk
1650fd3103bbSwdenk		CONFIG_NEC_NL6448BC20
1651c609719bSwdenk
1652fd3103bbSwdenk			NEC NL6448BC20-08. 6.5", 640x480.
1653fd3103bbSwdenk			Active, color, single scan.
1654fd3103bbSwdenk
1655fd3103bbSwdenk		CONFIG_NEC_NL6448BC33_54
1656fd3103bbSwdenk
1657fd3103bbSwdenk			NEC NL6448BC33-54. 10.4", 640x480.
1658c609719bSwdenk			Active, color, single scan.
1659c609719bSwdenk
1660c609719bSwdenk		CONFIG_SHARP_16x9
1661c609719bSwdenk
1662c609719bSwdenk			Sharp 320x240. Active, color, single scan.
1663c609719bSwdenk			It isn't 16x9, and I am not sure what it is.
1664c609719bSwdenk
1665c609719bSwdenk		CONFIG_SHARP_LQ64D341
1666c609719bSwdenk
1667c609719bSwdenk			Sharp LQ64D341 display, 640x480.
1668c609719bSwdenk			Active, color, single scan.
1669c609719bSwdenk
1670c609719bSwdenk		CONFIG_HLD1045
1671c609719bSwdenk
1672c609719bSwdenk			HLD1045 display, 640x480.
1673c609719bSwdenk			Active, color, single scan.
1674c609719bSwdenk
1675c609719bSwdenk		CONFIG_OPTREX_BW
1676c609719bSwdenk
1677c609719bSwdenk			Optrex	 CBL50840-2 NF-FW 99 22 M5
1678c609719bSwdenk			or
1679c609719bSwdenk			Hitachi	 LMG6912RPFC-00T
1680c609719bSwdenk			or
1681c609719bSwdenk			Hitachi	 SP14Q002
1682c609719bSwdenk
1683c609719bSwdenk			320x240. Black & white.
1684c609719bSwdenk
1685c609719bSwdenk		Normally display is black on white background; define
16866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
1687c609719bSwdenk
1688676d319eSSimon Glass		CONFIG_LCD_ALIGNMENT
1689676d319eSSimon Glass
1690676d319eSSimon Glass		Normally the LCD is page-aligned (tyically 4KB). If this is
1691676d319eSSimon Glass		defined then the LCD will be aligned to this value instead.
1692676d319eSSimon Glass		For ARM it is sometimes useful to use MMU_SECTION_SIZE
1693676d319eSSimon Glass		here, since it is cheaper to change data cache settings on
1694676d319eSSimon Glass		a per-section basis.
1695676d319eSSimon Glass
16960d89efefSSimon Glass		CONFIG_CONSOLE_SCROLL_LINES
16970d89efefSSimon Glass
16980d89efefSSimon Glass		When the console need to be scrolled, this is the number of
16990d89efefSSimon Glass		lines to scroll by. It defaults to 1. Increasing this makes
17000d89efefSSimon Glass		the console jump but can help speed up operation when scrolling
17010d89efefSSimon Glass		is slow.
1702676d319eSSimon Glass
170345d7f525STom Wai-Hong Tam		CONFIG_LCD_BMP_RLE8
170445d7f525STom Wai-Hong Tam
170545d7f525STom Wai-Hong Tam		Support drawing of RLE8-compressed bitmaps on the LCD.
170645d7f525STom Wai-Hong Tam
1707735987c5STom Wai-Hong Tam		CONFIG_I2C_EDID
1708735987c5STom Wai-Hong Tam
1709735987c5STom Wai-Hong Tam		Enables an 'i2c edid' command which can read EDID
1710735987c5STom Wai-Hong Tam		information over I2C from an attached LCD display.
1711735987c5STom Wai-Hong Tam
17127152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN
1713d791b1dcSwdenk
1714d791b1dcSwdenk		If this option is set, the environment is checked for
1715d791b1dcSwdenk		a variable "splashimage". If found, the usual display
1716d791b1dcSwdenk		of logo, copyright and system information on the LCD
1717e94d2cd9Swdenk		is suppressed and the BMP image at the address
1718d791b1dcSwdenk		specified in "splashimage" is loaded instead. The
1719d791b1dcSwdenk		console is redirected to the "nulldev", too. This
1720d791b1dcSwdenk		allows for a "silent" boot where a splash screen is
1721d791b1dcSwdenk		loaded very quickly after power-on.
1722d791b1dcSwdenk
1723c0880485SNikita Kiryanov		CONFIG_SPLASHIMAGE_GUARD
1724c0880485SNikita Kiryanov
1725c0880485SNikita Kiryanov		If this option is set, then U-Boot will prevent the environment
1726c0880485SNikita Kiryanov		variable "splashimage" from being set to a problematic address
1727c0880485SNikita Kiryanov		(see README.displaying-bmps and README.arm-unaligned-accesses).
1728c0880485SNikita Kiryanov		This option is useful for targets where, due to alignment
1729c0880485SNikita Kiryanov		restrictions, an improperly aligned BMP image will cause a data
1730c0880485SNikita Kiryanov		abort. If you think you will not have problems with unaligned
1731c0880485SNikita Kiryanov		accesses (for example because your toolchain prevents them)
1732c0880485SNikita Kiryanov		there is no need to set this option.
1733c0880485SNikita Kiryanov
17341ca298ceSMatthias Weisser		CONFIG_SPLASH_SCREEN_ALIGN
17351ca298ceSMatthias Weisser
17361ca298ceSMatthias Weisser		If this option is set the splash image can be freely positioned
17371ca298ceSMatthias Weisser		on the screen. Environment variable "splashpos" specifies the
17381ca298ceSMatthias Weisser		position as "x,y". If a positive number is given it is used as
17391ca298ceSMatthias Weisser		number of pixel from left/top. If a negative number is given it
17401ca298ceSMatthias Weisser		is used as number of pixel from right/bottom. You can also
17411ca298ceSMatthias Weisser		specify 'm' for centering the image.
17421ca298ceSMatthias Weisser
17431ca298ceSMatthias Weisser		Example:
17441ca298ceSMatthias Weisser		setenv splashpos m,m
17451ca298ceSMatthias Weisser			=> image at center of screen
17461ca298ceSMatthias Weisser
17471ca298ceSMatthias Weisser		setenv splashpos 30,20
17481ca298ceSMatthias Weisser			=> image at x = 30 and y = 20
17491ca298ceSMatthias Weisser
17501ca298ceSMatthias Weisser		setenv splashpos -10,m
17511ca298ceSMatthias Weisser			=> vertically centered image
17521ca298ceSMatthias Weisser			   at x = dspWidth - bmpWidth - 9
17531ca298ceSMatthias Weisser
175498f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
175598f4a3dfSStefan Roese
175698f4a3dfSStefan Roese		If this option is set, additionally to standard BMP
175798f4a3dfSStefan Roese		images, gzipped BMP images can be displayed via the
175898f4a3dfSStefan Roese		splashscreen support or the bmp command.
175998f4a3dfSStefan Roese
1760d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1761d5011762SAnatolij Gustschin
1762d5011762SAnatolij Gustschin		If this option is set, 8-bit RLE compressed BMP images
1763d5011762SAnatolij Gustschin		can be displayed via the splashscreen support or the
1764d5011762SAnatolij Gustschin		bmp command.
1765d5011762SAnatolij Gustschin
1766f2b96dfbSLei Wen- Do compresssing for memory range:
1767f2b96dfbSLei Wen		CONFIG_CMD_ZIP
1768f2b96dfbSLei Wen
1769f2b96dfbSLei Wen		If this option is set, it would use zlib deflate method
1770f2b96dfbSLei Wen		to compress the specified memory at its best effort.
1771f2b96dfbSLei Wen
1772c29fdfc1Swdenk- Compression support:
17738ef70478SKees Cook		CONFIG_GZIP
17748ef70478SKees Cook
17758ef70478SKees Cook		Enabled by default to support gzip compressed images.
17768ef70478SKees Cook
1777c29fdfc1Swdenk		CONFIG_BZIP2
1778c29fdfc1Swdenk
1779c29fdfc1Swdenk		If this option is set, support for bzip2 compressed
1780c29fdfc1Swdenk		images is included. If not, only uncompressed and gzip
1781c29fdfc1Swdenk		compressed images are supported.
1782c29fdfc1Swdenk
1783c29fdfc1Swdenk		NOTE: the bzip2 algorithm requires a lot of RAM, so
17846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
1785c29fdfc1Swdenk		be at least 4MB.
1786d791b1dcSwdenk
1787fc9c1727SLuigi 'Comio' Mantellini		CONFIG_LZMA
1788fc9c1727SLuigi 'Comio' Mantellini
1789fc9c1727SLuigi 'Comio' Mantellini		If this option is set, support for lzma compressed
1790fc9c1727SLuigi 'Comio' Mantellini		images is included.
1791fc9c1727SLuigi 'Comio' Mantellini
1792fc9c1727SLuigi 'Comio' Mantellini		Note: The LZMA algorithm adds between 2 and 4KB of code and it
1793fc9c1727SLuigi 'Comio' Mantellini		requires an amount of dynamic memory that is given by the
1794fc9c1727SLuigi 'Comio' Mantellini		formula:
1795fc9c1727SLuigi 'Comio' Mantellini
1796fc9c1727SLuigi 'Comio' Mantellini			(1846 + 768 << (lc + lp)) * sizeof(uint16)
1797fc9c1727SLuigi 'Comio' Mantellini
1798fc9c1727SLuigi 'Comio' Mantellini		Where lc and lp stand for, respectively, Literal context bits
1799fc9c1727SLuigi 'Comio' Mantellini		and Literal pos bits.
1800fc9c1727SLuigi 'Comio' Mantellini
1801fc9c1727SLuigi 'Comio' Mantellini		This value is upper-bounded by 14MB in the worst case. Anyway,
1802fc9c1727SLuigi 'Comio' Mantellini		for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1803fc9c1727SLuigi 'Comio' Mantellini		total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1804fc9c1727SLuigi 'Comio' Mantellini		a very small buffer.
1805fc9c1727SLuigi 'Comio' Mantellini
1806fc9c1727SLuigi 'Comio' Mantellini		Use the lzmainfo tool to determinate the lc and lp values and
1807fc9c1727SLuigi 'Comio' Mantellini		then calculate the amount of needed dynamic memory (ensuring
18086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the appropriate CONFIG_SYS_MALLOC_LEN value).
1809fc9c1727SLuigi 'Comio' Mantellini
18108ef70478SKees Cook		CONFIG_LZO
18118ef70478SKees Cook
18128ef70478SKees Cook		If this option is set, support for LZO compressed images
18138ef70478SKees Cook		is included.
18148ef70478SKees Cook
181517ea1177Swdenk- MII/PHY support:
181617ea1177Swdenk		CONFIG_PHY_ADDR
181717ea1177Swdenk
181817ea1177Swdenk		The address of PHY on MII bus.
181917ea1177Swdenk
182017ea1177Swdenk		CONFIG_PHY_CLOCK_FREQ (ppc4xx)
182117ea1177Swdenk
182217ea1177Swdenk		The clock frequency of the MII bus
182317ea1177Swdenk
182417ea1177Swdenk		CONFIG_PHY_GIGE
182517ea1177Swdenk
182617ea1177Swdenk		If this option is set, support for speed/duplex
182711ccc33fSMarcel Ziswiler		detection of gigabit PHY is included.
182817ea1177Swdenk
182917ea1177Swdenk		CONFIG_PHY_RESET_DELAY
183017ea1177Swdenk
183117ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
183217ea1177Swdenk		reset before any MII register access is possible.
183317ea1177Swdenk		For such PHY, set this option to the usec delay
183417ea1177Swdenk		required. (minimum 300usec for LXT971A)
183517ea1177Swdenk
183617ea1177Swdenk		CONFIG_PHY_CMD_DELAY (ppc4xx)
183717ea1177Swdenk
183817ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
183917ea1177Swdenk		command issued before MII status register can be read
184017ea1177Swdenk
1841c609719bSwdenk- Ethernet address:
1842c609719bSwdenk		CONFIG_ETHADDR
1843c68a05feSrichardretanubun		CONFIG_ETH1ADDR
1844c609719bSwdenk		CONFIG_ETH2ADDR
1845c609719bSwdenk		CONFIG_ETH3ADDR
1846c68a05feSrichardretanubun		CONFIG_ETH4ADDR
1847c68a05feSrichardretanubun		CONFIG_ETH5ADDR
1848c609719bSwdenk
184911ccc33fSMarcel Ziswiler		Define a default value for Ethernet address to use
185011ccc33fSMarcel Ziswiler		for the respective Ethernet interface, in case this
1851c609719bSwdenk		is not determined automatically.
1852c609719bSwdenk
1853c609719bSwdenk- IP address:
1854c609719bSwdenk		CONFIG_IPADDR
1855c609719bSwdenk
1856c609719bSwdenk		Define a default value for the IP address to use for
185711ccc33fSMarcel Ziswiler		the default Ethernet interface, in case this is not
1858c609719bSwdenk		determined through e.g. bootp.
18591ebcd654SWolfgang Denk		(Environment variable "ipaddr")
1860c609719bSwdenk
1861c609719bSwdenk- Server IP address:
1862c609719bSwdenk		CONFIG_SERVERIP
1863c609719bSwdenk
1864c609719bSwdenk		Defines a default value for the IP address of a TFTP
1865c609719bSwdenk		server to contact when using the "tftboot" command.
18661ebcd654SWolfgang Denk		(Environment variable "serverip")
1867c609719bSwdenk
186897cfe861SRobin Getz		CONFIG_KEEP_SERVERADDR
186997cfe861SRobin Getz
187097cfe861SRobin Getz		Keeps the server's MAC address, in the env 'serveraddr'
187197cfe861SRobin Getz		for passing to bootargs (like Linux's netconsole option)
187297cfe861SRobin Getz
18731ebcd654SWolfgang Denk- Gateway IP address:
18741ebcd654SWolfgang Denk		CONFIG_GATEWAYIP
18751ebcd654SWolfgang Denk
18761ebcd654SWolfgang Denk		Defines a default value for the IP address of the
18771ebcd654SWolfgang Denk		default router where packets to other networks are
18781ebcd654SWolfgang Denk		sent to.
18791ebcd654SWolfgang Denk		(Environment variable "gatewayip")
18801ebcd654SWolfgang Denk
18811ebcd654SWolfgang Denk- Subnet mask:
18821ebcd654SWolfgang Denk		CONFIG_NETMASK
18831ebcd654SWolfgang Denk
18841ebcd654SWolfgang Denk		Defines a default value for the subnet mask (or
18851ebcd654SWolfgang Denk		routing prefix) which is used to determine if an IP
18861ebcd654SWolfgang Denk		address belongs to the local subnet or needs to be
18871ebcd654SWolfgang Denk		forwarded through a router.
18881ebcd654SWolfgang Denk		(Environment variable "netmask")
18891ebcd654SWolfgang Denk
189053a5c424SDavid Updegraff- Multicast TFTP Mode:
189153a5c424SDavid Updegraff		CONFIG_MCAST_TFTP
189253a5c424SDavid Updegraff
189353a5c424SDavid Updegraff		Defines whether you want to support multicast TFTP as per
189453a5c424SDavid Updegraff		rfc-2090; for example to work with atftp.  Lets lots of targets
189511ccc33fSMarcel Ziswiler		tftp down the same boot image concurrently.  Note: the Ethernet
189653a5c424SDavid Updegraff		driver in use must provide a function: mcast() to join/leave a
189753a5c424SDavid Updegraff		multicast group.
189853a5c424SDavid Updegraff
1899c609719bSwdenk- BOOTP Recovery Mode:
1900c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY
1901c609719bSwdenk
1902c609719bSwdenk		If you have many targets in a network that try to
1903c609719bSwdenk		boot using BOOTP, you may want to avoid that all
1904c609719bSwdenk		systems send out BOOTP requests at precisely the same
1905c609719bSwdenk		moment (which would happen for instance at recovery
1906c609719bSwdenk		from a power failure, when all systems will try to
1907c609719bSwdenk		boot, thus flooding the BOOTP server. Defining
1908c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1909c609719bSwdenk		inserted before sending out BOOTP requests. The
19106c33c785SWolfgang Denk		following delays are inserted then:
1911c609719bSwdenk
1912c609719bSwdenk		1st BOOTP request:	delay 0 ... 1 sec
1913c609719bSwdenk		2nd BOOTP request:	delay 0 ... 2 sec
1914c609719bSwdenk		3rd BOOTP request:	delay 0 ... 4 sec
1915c609719bSwdenk		4th and following
1916c609719bSwdenk		BOOTP requests:		delay 0 ... 8 sec
1917c609719bSwdenk
1918fe389a82Sstroese- DHCP Advanced Options:
19191fe80d79SJon Loeliger		You can fine tune the DHCP functionality by defining
19201fe80d79SJon Loeliger		CONFIG_BOOTP_* symbols:
1921fe389a82Sstroese
19221fe80d79SJon Loeliger		CONFIG_BOOTP_SUBNETMASK
19231fe80d79SJon Loeliger		CONFIG_BOOTP_GATEWAY
19241fe80d79SJon Loeliger		CONFIG_BOOTP_HOSTNAME
19251fe80d79SJon Loeliger		CONFIG_BOOTP_NISDOMAIN
19261fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTPATH
19271fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTFILESIZE
19281fe80d79SJon Loeliger		CONFIG_BOOTP_DNS
19291fe80d79SJon Loeliger		CONFIG_BOOTP_DNS2
19301fe80d79SJon Loeliger		CONFIG_BOOTP_SEND_HOSTNAME
19311fe80d79SJon Loeliger		CONFIG_BOOTP_NTPSERVER
19321fe80d79SJon Loeliger		CONFIG_BOOTP_TIMEOFFSET
19331fe80d79SJon Loeliger		CONFIG_BOOTP_VENDOREX
19342c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL
1935fe389a82Sstroese
19365d110f0aSWilson Callan		CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
19375d110f0aSWilson Callan		environment variable, not the BOOTP server.
1938fe389a82Sstroese
19392c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
19402c00e099SJoe Hershberger		after the configured retry count, the call will fail
19412c00e099SJoe Hershberger		instead of starting over.  This can be used to fail over
19422c00e099SJoe Hershberger		to Link-local IP address configuration if the DHCP server
19432c00e099SJoe Hershberger		is not available.
19442c00e099SJoe Hershberger
1945fe389a82Sstroese		CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1946fe389a82Sstroese		serverip from a DHCP server, it is possible that more
1947fe389a82Sstroese		than one DNS serverip is offered to the client.
1948fe389a82Sstroese		If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1949fe389a82Sstroese		serverip will be stored in the additional environment
1950fe389a82Sstroese		variable "dnsip2". The first DNS serverip is always
1951fe389a82Sstroese		stored in the variable "dnsip", when CONFIG_BOOTP_DNS
19521fe80d79SJon Loeliger		is defined.
1953fe389a82Sstroese
1954fe389a82Sstroese		CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1955fe389a82Sstroese		to do a dynamic update of a DNS server. To do this, they
1956fe389a82Sstroese		need the hostname of the DHCP requester.
19575d110f0aSWilson Callan		If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
19581fe80d79SJon Loeliger		of the "hostname" environment variable is passed as
19591fe80d79SJon Loeliger		option 12 to the DHCP server.
1960fe389a82Sstroese
1961d9a2f416SAras Vaichas		CONFIG_BOOTP_DHCP_REQUEST_DELAY
1962d9a2f416SAras Vaichas
1963d9a2f416SAras Vaichas		A 32bit value in microseconds for a delay between
1964d9a2f416SAras Vaichas		receiving a "DHCP Offer" and sending the "DHCP Request".
1965d9a2f416SAras Vaichas		This fixes a problem with certain DHCP servers that don't
1966d9a2f416SAras Vaichas		respond 100% of the time to a "DHCP request". E.g. On an
1967d9a2f416SAras Vaichas		AT91RM9200 processor running at 180MHz, this delay needed
1968d9a2f416SAras Vaichas		to be *at least* 15,000 usec before a Windows Server 2003
1969d9a2f416SAras Vaichas		DHCP server would reply 100% of the time. I recommend at
1970d9a2f416SAras Vaichas		least 50,000 usec to be safe. The alternative is to hope
1971d9a2f416SAras Vaichas		that one of the retries will be successful but note that
1972d9a2f416SAras Vaichas		the DHCP timeout and retry process takes a longer than
1973d9a2f416SAras Vaichas		this delay.
1974d9a2f416SAras Vaichas
1975d22c338eSJoe Hershberger - Link-local IP address negotiation:
1976d22c338eSJoe Hershberger		Negotiate with other link-local clients on the local network
1977d22c338eSJoe Hershberger		for an address that doesn't require explicit configuration.
1978d22c338eSJoe Hershberger		This is especially useful if a DHCP server cannot be guaranteed
1979d22c338eSJoe Hershberger		to exist in all environments that the device must operate.
1980d22c338eSJoe Hershberger
1981d22c338eSJoe Hershberger		See doc/README.link-local for more information.
1982d22c338eSJoe Hershberger
1983a3d991bdSwdenk - CDP Options:
1984a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID
1985a3d991bdSwdenk
1986a3d991bdSwdenk		The device id used in CDP trigger frames.
1987a3d991bdSwdenk
1988a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID_PREFIX
1989a3d991bdSwdenk
1990a3d991bdSwdenk		A two character string which is prefixed to the MAC address
1991a3d991bdSwdenk		of the device.
1992a3d991bdSwdenk
1993a3d991bdSwdenk		CONFIG_CDP_PORT_ID
1994a3d991bdSwdenk
1995a3d991bdSwdenk		A printf format string which contains the ascii name of
1996a3d991bdSwdenk		the port. Normally is set to "eth%d" which sets
199711ccc33fSMarcel Ziswiler		eth0 for the first Ethernet, eth1 for the second etc.
1998a3d991bdSwdenk
1999a3d991bdSwdenk		CONFIG_CDP_CAPABILITIES
2000a3d991bdSwdenk
2001a3d991bdSwdenk		A 32bit integer which indicates the device capabilities;
2002a3d991bdSwdenk		0x00000010 for a normal host which does not forwards.
2003a3d991bdSwdenk
2004a3d991bdSwdenk		CONFIG_CDP_VERSION
2005a3d991bdSwdenk
2006a3d991bdSwdenk		An ascii string containing the version of the software.
2007a3d991bdSwdenk
2008a3d991bdSwdenk		CONFIG_CDP_PLATFORM
2009a3d991bdSwdenk
2010a3d991bdSwdenk		An ascii string containing the name of the platform.
2011a3d991bdSwdenk
2012a3d991bdSwdenk		CONFIG_CDP_TRIGGER
2013a3d991bdSwdenk
2014a3d991bdSwdenk		A 32bit integer sent on the trigger.
2015a3d991bdSwdenk
2016a3d991bdSwdenk		CONFIG_CDP_POWER_CONSUMPTION
2017a3d991bdSwdenk
2018a3d991bdSwdenk		A 16bit integer containing the power consumption of the
2019a3d991bdSwdenk		device in .1 of milliwatts.
2020a3d991bdSwdenk
2021a3d991bdSwdenk		CONFIG_CDP_APPLIANCE_VLAN_TYPE
2022a3d991bdSwdenk
2023a3d991bdSwdenk		A byte containing the id of the VLAN.
2024a3d991bdSwdenk
2025c609719bSwdenk- Status LED:	CONFIG_STATUS_LED
2026c609719bSwdenk
2027c609719bSwdenk		Several configurations allow to display the current
2028c609719bSwdenk		status using a LED. For instance, the LED will blink
2029c609719bSwdenk		fast while running U-Boot code, stop blinking as
2030c609719bSwdenk		soon as a reply to a BOOTP request was received, and
2031c609719bSwdenk		start blinking slow once the Linux kernel is running
2032c609719bSwdenk		(supported by a status LED driver in the Linux
2033c609719bSwdenk		kernel). Defining CONFIG_STATUS_LED enables this
2034c609719bSwdenk		feature in U-Boot.
2035c609719bSwdenk
20361df7bbbaSIgor Grinberg		Additional options:
20371df7bbbaSIgor Grinberg
20381df7bbbaSIgor Grinberg		CONFIG_GPIO_LED
20391df7bbbaSIgor Grinberg		The status LED can be connected to a GPIO pin.
20401df7bbbaSIgor Grinberg		In such cases, the gpio_led driver can be used as a
20411df7bbbaSIgor Grinberg		status LED backend implementation. Define CONFIG_GPIO_LED
20421df7bbbaSIgor Grinberg		to include the gpio_led driver in the U-Boot binary.
20431df7bbbaSIgor Grinberg
20449dfdcdfeSIgor Grinberg		CONFIG_GPIO_LED_INVERTED_TABLE
20459dfdcdfeSIgor Grinberg		Some GPIO connected LEDs may have inverted polarity in which
20469dfdcdfeSIgor Grinberg		case the GPIO high value corresponds to LED off state and
20479dfdcdfeSIgor Grinberg		GPIO low value corresponds to LED on state.
20489dfdcdfeSIgor Grinberg		In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
20499dfdcdfeSIgor Grinberg		with a list of GPIO LEDs that have inverted polarity.
20509dfdcdfeSIgor Grinberg
2051c609719bSwdenk- CAN Support:	CONFIG_CAN_DRIVER
2052c609719bSwdenk
2053c609719bSwdenk		Defining CONFIG_CAN_DRIVER enables CAN driver support
2054c609719bSwdenk		on those systems that support this (optional)
2055c609719bSwdenk		feature, like the TQM8xxL modules.
2056c609719bSwdenk
20573f4978c7SHeiko Schocher- I2C Support:	CONFIG_SYS_I2C
2058c609719bSwdenk
20593f4978c7SHeiko Schocher		This enable the NEW i2c subsystem, and will allow you to use
20603f4978c7SHeiko Schocher		i2c commands at the u-boot command line (as long as you set
20613f4978c7SHeiko Schocher		CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
20623f4978c7SHeiko Schocher		based realtime clock chips or other i2c devices. See
20633f4978c7SHeiko Schocher		common/cmd_i2c.c for a description of the command line
20643f4978c7SHeiko Schocher		interface.
20653f4978c7SHeiko Schocher
20663f4978c7SHeiko Schocher		ported i2c driver to the new framework:
2067ea818dbbSHeiko Schocher		- drivers/i2c/soft_i2c.c:
2068ea818dbbSHeiko Schocher		  - activate first bus with CONFIG_SYS_I2C_SOFT define
2069ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2070ea818dbbSHeiko Schocher		    for defining speed and slave address
2071ea818dbbSHeiko Schocher		  - activate second bus with I2C_SOFT_DECLARATIONS2 define
2072ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2073ea818dbbSHeiko Schocher		    for defining speed and slave address
2074ea818dbbSHeiko Schocher		  - activate third bus with I2C_SOFT_DECLARATIONS3 define
2075ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2076ea818dbbSHeiko Schocher		    for defining speed and slave address
2077ea818dbbSHeiko Schocher		  - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2078ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2079ea818dbbSHeiko Schocher		    for defining speed and slave address
20803f4978c7SHeiko Schocher
208100f792e0SHeiko Schocher		- drivers/i2c/fsl_i2c.c:
208200f792e0SHeiko Schocher		  - activate i2c driver with CONFIG_SYS_I2C_FSL
208300f792e0SHeiko Schocher		    define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
208400f792e0SHeiko Schocher		    offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
208500f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
208600f792e0SHeiko Schocher		    bus.
208700f792e0SHeiko Schocher		  - If your board supports a second fsl i2c bus, define
208800f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
208900f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_SPEED for the speed and
209000f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
209100f792e0SHeiko Schocher		    second bus.
209200f792e0SHeiko Schocher
20931f2ba722SSimon Glass		- drivers/i2c/tegra_i2c.c:
20941f2ba722SSimon Glass		  - activate this driver with CONFIG_SYS_I2C_TEGRA
20951f2ba722SSimon Glass		  - This driver adds 4 i2c buses with a fix speed from
20961f2ba722SSimon Glass		    100000 and the slave addr 0!
20971f2ba722SSimon Glass
2098880540deSDirk Eibach		- drivers/i2c/ppc4xx_i2c.c
2099880540deSDirk Eibach		  - activate this driver with CONFIG_SYS_I2C_PPC4XX
2100880540deSDirk Eibach		  - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2101880540deSDirk Eibach		  - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2102880540deSDirk Eibach
2103fac96408Strem		- drivers/i2c/i2c_mxc.c
2104fac96408Strem		  - activate this driver with CONFIG_SYS_I2C_MXC
2105fac96408Strem		  - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2106fac96408Strem		  - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2107fac96408Strem		  - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2108fac96408Strem		  - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2109fac96408Strem		  - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2110fac96408Strem		  - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
2111fac96408Strem		If thoses defines are not set, default value is 100000
2112fac96408Strem		for speed, and 0 for slave.
2113fac96408Strem
21141086bfa9SNobuhiro Iwamatsu		- drivers/i2c/rcar_i2c.c:
21151086bfa9SNobuhiro Iwamatsu		  - activate this driver with CONFIG_SYS_I2C_RCAR
21161086bfa9SNobuhiro Iwamatsu		  - This driver adds 4 i2c buses
21171086bfa9SNobuhiro Iwamatsu
21181086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
21191086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
21201086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
21211086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
21221086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
21231086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
21241086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
21251086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
21261086bfa9SNobuhiro Iwamatsu		  - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
21271086bfa9SNobuhiro Iwamatsu
21282035d77dSNobuhiro Iwamatsu		- drivers/i2c/sh_i2c.c:
21292035d77dSNobuhiro Iwamatsu		  - activate this driver with CONFIG_SYS_I2C_SH
21302035d77dSNobuhiro Iwamatsu		  - This driver adds from 2 to 5 i2c buses
21312035d77dSNobuhiro Iwamatsu
21322035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
21332035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
21342035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
21352035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
21362035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
21372035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
21382035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
21392035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
21402035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
21412035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
21422035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
21432035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
21442035d77dSNobuhiro Iwamatsu		  - CONFIF_SYS_I2C_SH_NUM_CONTROLLERS for nummber of i2c buses
21452035d77dSNobuhiro Iwamatsu
21466789e84eSHeiko Schocher		- drivers/i2c/omap24xx_i2c.c
21476789e84eSHeiko Schocher		  - activate this driver with CONFIG_SYS_I2C_OMAP24XX
21486789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
21496789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
21506789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
21516789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
21526789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
21536789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
21546789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
21556789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
21566789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
21576789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
21586789e84eSHeiko Schocher
21590bdffe71SHeiko Schocher		- drivers/i2c/zynq_i2c.c
21600bdffe71SHeiko Schocher		  - activate this driver with CONFIG_SYS_I2C_ZYNQ
21610bdffe71SHeiko Schocher		  - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
21620bdffe71SHeiko Schocher		  - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
21630bdffe71SHeiko Schocher
2164e717fc6dSNaveen Krishna Ch		- drivers/i2c/s3c24x0_i2c.c:
2165e717fc6dSNaveen Krishna Ch		  - activate this driver with CONFIG_SYS_I2C_S3C24X0
2166e717fc6dSNaveen Krishna Ch		  - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2167e717fc6dSNaveen Krishna Ch		    9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2168e717fc6dSNaveen Krishna Ch		    with a fix speed from 100000 and the slave addr 0!
2169e717fc6dSNaveen Krishna Ch
21703f4978c7SHeiko Schocher		additional defines:
21713f4978c7SHeiko Schocher
21723f4978c7SHeiko Schocher		CONFIG_SYS_NUM_I2C_BUSES
21733f4978c7SHeiko Schocher		Hold the number of i2c busses you want to use. If you
21743f4978c7SHeiko Schocher		don't use/have i2c muxes on your i2c bus, this
21753f4978c7SHeiko Schocher		is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
21763f4978c7SHeiko Schocher		omit this define.
21773f4978c7SHeiko Schocher
21783f4978c7SHeiko Schocher		CONFIG_SYS_I2C_DIRECT_BUS
21793f4978c7SHeiko Schocher		define this, if you don't use i2c muxes on your hardware.
21803f4978c7SHeiko Schocher		if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
21813f4978c7SHeiko Schocher		omit this define.
21823f4978c7SHeiko Schocher
21833f4978c7SHeiko Schocher		CONFIG_SYS_I2C_MAX_HOPS
21843f4978c7SHeiko Schocher		define how many muxes are maximal consecutively connected
21853f4978c7SHeiko Schocher		on one i2c bus. If you not use i2c muxes, omit this
21863f4978c7SHeiko Schocher		define.
21873f4978c7SHeiko Schocher
21883f4978c7SHeiko Schocher		CONFIG_SYS_I2C_BUSES
21893f4978c7SHeiko Schocher		hold a list of busses you want to use, only used if
21903f4978c7SHeiko Schocher		CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
21913f4978c7SHeiko Schocher		a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
21923f4978c7SHeiko Schocher		CONFIG_SYS_NUM_I2C_BUSES = 9:
21933f4978c7SHeiko Schocher
21943f4978c7SHeiko Schocher		 CONFIG_SYS_I2C_BUSES	{{0, {I2C_NULL_HOP}}, \
21953f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
21963f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
21973f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
21983f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
21993f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
22003f4978c7SHeiko Schocher					{1, {I2C_NULL_HOP}}, \
22013f4978c7SHeiko Schocher					{1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
22023f4978c7SHeiko Schocher					{1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
22033f4978c7SHeiko Schocher					}
22043f4978c7SHeiko Schocher
22053f4978c7SHeiko Schocher		which defines
22063f4978c7SHeiko Schocher			bus 0 on adapter 0 without a mux
2207ea818dbbSHeiko Schocher			bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2208ea818dbbSHeiko Schocher			bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2209ea818dbbSHeiko Schocher			bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2210ea818dbbSHeiko Schocher			bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2211ea818dbbSHeiko Schocher			bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
22123f4978c7SHeiko Schocher			bus 6 on adapter 1 without a mux
2213ea818dbbSHeiko Schocher			bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2214ea818dbbSHeiko Schocher			bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
22153f4978c7SHeiko Schocher
22163f4978c7SHeiko Schocher		If you do not have i2c muxes on your board, omit this define.
22173f4978c7SHeiko Schocher
2218ea818dbbSHeiko Schocher- Legacy I2C Support:	CONFIG_HARD_I2C
22193f4978c7SHeiko Schocher
22203f4978c7SHeiko Schocher		NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
22213f4978c7SHeiko Schocher		provides the following compelling advantages:
22223f4978c7SHeiko Schocher
22233f4978c7SHeiko Schocher		- more than one i2c adapter is usable
22243f4978c7SHeiko Schocher		- approved multibus support
22253f4978c7SHeiko Schocher		- better i2c mux support
22263f4978c7SHeiko Schocher
22273f4978c7SHeiko Schocher		** Please consider updating your I2C driver now. **
22283f4978c7SHeiko Schocher
2229ea818dbbSHeiko Schocher		These enable legacy I2C serial bus commands. Defining
2230ea818dbbSHeiko Schocher		CONFIG_HARD_I2C will include the appropriate I2C driver
2231ea818dbbSHeiko Schocher		for the selected CPU.
2232c609719bSwdenk
2233b37c7e5eSwdenk		This will allow you to use i2c commands at the u-boot
2234602ad3b3SJon Loeliger		command line (as long as you set CONFIG_CMD_I2C in
2235b37c7e5eSwdenk		CONFIG_COMMANDS) and communicate with i2c based realtime
2236b37c7e5eSwdenk		clock chips. See common/cmd_i2c.c for a description of the
2237c609719bSwdenk		command line interface.
2238c609719bSwdenk
2239bb99ad6dSBen Warren		CONFIG_HARD_I2C selects a hardware I2C controller.
2240c609719bSwdenk
2241b37c7e5eSwdenk		There are several other quantities that must also be
2242ea818dbbSHeiko Schocher		defined when you define CONFIG_HARD_I2C.
2243c609719bSwdenk
22446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		In both cases you will need to define CONFIG_SYS_I2C_SPEED
2245b37c7e5eSwdenk		to be the frequency (in Hz) at which you wish your i2c bus
22466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
224711ccc33fSMarcel Ziswiler		the CPU's i2c node address).
2248c609719bSwdenk
22498d321b81SPeter Tyser		Now, the u-boot i2c code for the mpc8xx
2250a47a12beSStefan Roese		(arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
22518d321b81SPeter Tyser		and so its address should therefore be cleared to 0 (See,
22528d321b81SPeter Tyser		eg, MPC823e User's Manual p.16-473). So, set
22538d321b81SPeter Tyser		CONFIG_SYS_I2C_SLAVE to 0.
2254b37c7e5eSwdenk
22555da71efaSEric Millbrandt		CONFIG_SYS_I2C_INIT_MPC5XXX
22565da71efaSEric Millbrandt
22575da71efaSEric Millbrandt		When a board is reset during an i2c bus transfer
22585da71efaSEric Millbrandt		chips might think that the current transfer is still
22595da71efaSEric Millbrandt		in progress.  Reset the slave devices by sending start
22605da71efaSEric Millbrandt		commands until the slave device responds.
22615da71efaSEric Millbrandt
2262b37c7e5eSwdenk		That's all that's required for CONFIG_HARD_I2C.
2263b37c7e5eSwdenk
2264ea818dbbSHeiko Schocher		If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
2265b37c7e5eSwdenk		then the following macros need to be defined (examples are
2266b37c7e5eSwdenk		from include/configs/lwmon.h):
2267c609719bSwdenk
2268c609719bSwdenk		I2C_INIT
2269c609719bSwdenk
2270b37c7e5eSwdenk		(Optional). Any commands necessary to enable the I2C
2271c609719bSwdenk		controller or configure ports.
2272c609719bSwdenk
2273b37c7e5eSwdenk		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
2274b37c7e5eSwdenk
2275c609719bSwdenk		I2C_PORT
2276c609719bSwdenk
2277c609719bSwdenk		(Only for MPC8260 CPU). The I/O port to use (the code
2278c609719bSwdenk		assumes both bits are on the same port). Valid values
2279c609719bSwdenk		are 0..3 for ports A..D.
2280c609719bSwdenk
2281c609719bSwdenk		I2C_ACTIVE
2282c609719bSwdenk
2283c609719bSwdenk		The code necessary to make the I2C data line active
2284c609719bSwdenk		(driven).  If the data line is open collector, this
2285c609719bSwdenk		define can be null.
2286c609719bSwdenk
2287b37c7e5eSwdenk		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
2288b37c7e5eSwdenk
2289c609719bSwdenk		I2C_TRISTATE
2290c609719bSwdenk
2291c609719bSwdenk		The code necessary to make the I2C data line tri-stated
2292c609719bSwdenk		(inactive).  If the data line is open collector, this
2293c609719bSwdenk		define can be null.
2294c609719bSwdenk
2295b37c7e5eSwdenk		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2296b37c7e5eSwdenk
2297c609719bSwdenk		I2C_READ
2298c609719bSwdenk
2299472d5460SYork Sun		Code that returns true if the I2C data line is high,
2300472d5460SYork Sun		false if it is low.
2301c609719bSwdenk
2302b37c7e5eSwdenk		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2303b37c7e5eSwdenk
2304c609719bSwdenk		I2C_SDA(bit)
2305c609719bSwdenk
2306472d5460SYork Sun		If <bit> is true, sets the I2C data line high. If it
2307472d5460SYork Sun		is false, it clears it (low).
2308c609719bSwdenk
2309b37c7e5eSwdenk		eg: #define I2C_SDA(bit) \
2310b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
2311b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
2312b37c7e5eSwdenk
2313c609719bSwdenk		I2C_SCL(bit)
2314c609719bSwdenk
2315472d5460SYork Sun		If <bit> is true, sets the I2C clock line high. If it
2316472d5460SYork Sun		is false, it clears it (low).
2317c609719bSwdenk
2318b37c7e5eSwdenk		eg: #define I2C_SCL(bit) \
2319b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
2320b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
2321b37c7e5eSwdenk
2322c609719bSwdenk		I2C_DELAY
2323c609719bSwdenk
2324c609719bSwdenk		This delay is invoked four times per clock cycle so this
2325c609719bSwdenk		controls the rate of data transfer.  The data rate thus
2326b37c7e5eSwdenk		is 1 / (I2C_DELAY * 4). Often defined to be something
2327b37c7e5eSwdenk		like:
2328b37c7e5eSwdenk
2329b37c7e5eSwdenk		#define I2C_DELAY  udelay(2)
2330c609719bSwdenk
2331793b5726SMike Frysinger		CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2332793b5726SMike Frysinger
2333793b5726SMike Frysinger		If your arch supports the generic GPIO framework (asm/gpio.h),
2334793b5726SMike Frysinger		then you may alternatively define the two GPIOs that are to be
2335793b5726SMike Frysinger		used as SCL / SDA.  Any of the previous I2C_xxx macros will
2336793b5726SMike Frysinger		have GPIO-based defaults assigned to them as appropriate.
2337793b5726SMike Frysinger
2338793b5726SMike Frysinger		You should define these to the GPIO value as given directly to
2339793b5726SMike Frysinger		the generic GPIO functions.
2340793b5726SMike Frysinger
23416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_INIT_BOARD
234247cd00faSwdenk
234347cd00faSwdenk		When a board is reset during an i2c bus transfer
234447cd00faSwdenk		chips might think that the current transfer is still
234547cd00faSwdenk		in progress. On some boards it is possible to access
234647cd00faSwdenk		the i2c SCLK line directly, either by using the
234747cd00faSwdenk		processor pin as a GPIO or by having a second pin
234847cd00faSwdenk		connected to the bus. If this option is defined a
234947cd00faSwdenk		custom i2c_init_board() routine in boards/xxx/board.c
235047cd00faSwdenk		is run early in the boot sequence.
235147cd00faSwdenk
235226a33504SRichard Retanubun		CONFIG_SYS_I2C_BOARD_LATE_INIT
235326a33504SRichard Retanubun
235426a33504SRichard Retanubun		An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
235526a33504SRichard Retanubun		defined a custom i2c_board_late_init() routine in
235626a33504SRichard Retanubun		boards/xxx/board.c is run AFTER the operations in i2c_init()
235726a33504SRichard Retanubun		is completed. This callpoint can be used to unreset i2c bus
235826a33504SRichard Retanubun		using CPU i2c controller register accesses for CPUs whose i2c
235926a33504SRichard Retanubun		controller provide such a method. It is called at the end of
236026a33504SRichard Retanubun		i2c_init() to allow i2c_init operations to setup the i2c bus
236126a33504SRichard Retanubun		controller on the CPU (e.g. setting bus speed & slave address).
236226a33504SRichard Retanubun
236317ea1177Swdenk		CONFIG_I2CFAST (PPC405GP|PPC405EP only)
236417ea1177Swdenk
236517ea1177Swdenk		This option enables configuration of bi_iic_fast[] flags
236617ea1177Swdenk		in u-boot bd_info structure based on u-boot environment
236717ea1177Swdenk		variable "i2cfast". (see also i2cfast)
236817ea1177Swdenk
2369bb99ad6dSBen Warren		CONFIG_I2C_MULTI_BUS
2370bb99ad6dSBen Warren
2371bb99ad6dSBen Warren		This option allows the use of multiple I2C buses, each of which
2372bb99ad6dSBen Warren		must have a controller.	 At any point in time, only one bus is
2373bb99ad6dSBen Warren		active.	 To switch to a different bus, use the 'i2c dev' command.
2374bb99ad6dSBen Warren		Note that bus numbering is zero-based.
2375bb99ad6dSBen Warren
23766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_NOPROBES
2377bb99ad6dSBen Warren
2378bb99ad6dSBen Warren		This option specifies a list of I2C devices that will be skipped
23790f89c54bSPeter Tyser		when the 'i2c probe' command is issued.	 If CONFIG_I2C_MULTI_BUS
23800f89c54bSPeter Tyser		is set, specify a list of bus-device pairs.  Otherwise, specify
23810f89c54bSPeter Tyser		a 1D array of device addresses
2382bb99ad6dSBen Warren
2383bb99ad6dSBen Warren		e.g.
2384bb99ad6dSBen Warren			#undef	CONFIG_I2C_MULTI_BUS
23856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
2386bb99ad6dSBen Warren
2387bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on a board with one I2C bus
2388bb99ad6dSBen Warren
2389bb99ad6dSBen Warren			#define CONFIG_I2C_MULTI_BUS
23906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_MULTI_NOPROBES	{{0,0x50},{0,0x68},{1,0x54}}
2391bb99ad6dSBen Warren
2392bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2393bb99ad6dSBen Warren
23946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SPD_BUS_NUM
2395be5e6181STimur Tabi
2396be5e6181STimur Tabi		If defined, then this indicates the I2C bus number for DDR SPD.
2397be5e6181STimur Tabi		If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2398be5e6181STimur Tabi
23996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_BUS_NUM
24000dc018ecSStefan Roese
24010dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the RTC.
24020dc018ecSStefan Roese		If not defined, then U-Boot assumes that RTC is on I2C bus 0.
24030dc018ecSStefan Roese
24046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_DTT_BUS_NUM
24050dc018ecSStefan Roese
24060dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the DTT.
24070dc018ecSStefan Roese		If not defined, then U-Boot assumes that DTT is on I2C bus 0.
24080dc018ecSStefan Roese
24096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_DTT_ADDR:
24109ebbb54fSVictor Gallardo
24119ebbb54fSVictor Gallardo		If defined, specifies the I2C address of the DTT device.
24129ebbb54fSVictor Gallardo		If not defined, then U-Boot uses predefined value for
24139ebbb54fSVictor Gallardo		specified DTT device.
24149ebbb54fSVictor Gallardo
24152ac6985aSAndrew Dyer		CONFIG_SOFT_I2C_READ_REPEATED_START
24162ac6985aSAndrew Dyer
24172ac6985aSAndrew Dyer		defining this will force the i2c_read() function in
24182ac6985aSAndrew Dyer		the soft_i2c driver to perform an I2C repeated start
24192ac6985aSAndrew Dyer		between writing the address pointer and reading the
24202ac6985aSAndrew Dyer		data.  If this define is omitted the default behaviour
24212ac6985aSAndrew Dyer		of doing a stop-start sequence will be used.  Most I2C
24222ac6985aSAndrew Dyer		devices can use either method, but some require one or
24232ac6985aSAndrew Dyer		the other.
2424be5e6181STimur Tabi
2425c609719bSwdenk- SPI Support:	CONFIG_SPI
2426c609719bSwdenk
2427c609719bSwdenk		Enables SPI driver (so far only tested with
2428c609719bSwdenk		SPI EEPROM, also an instance works with Crystal A/D and
2429c609719bSwdenk		D/As on the SACSng board)
2430c609719bSwdenk
24316639562eSYoshihiro Shimoda		CONFIG_SH_SPI
24326639562eSYoshihiro Shimoda
24336639562eSYoshihiro Shimoda		Enables the driver for SPI controller on SuperH. Currently
24346639562eSYoshihiro Shimoda		only SH7757 is supported.
24356639562eSYoshihiro Shimoda
2436c609719bSwdenk		CONFIG_SPI_X
2437c609719bSwdenk
2438c609719bSwdenk		Enables extended (16-bit) SPI EEPROM addressing.
2439c609719bSwdenk		(symmetrical to CONFIG_I2C_X)
2440c609719bSwdenk
2441c609719bSwdenk		CONFIG_SOFT_SPI
2442c609719bSwdenk
2443c609719bSwdenk		Enables a software (bit-bang) SPI driver rather than
2444c609719bSwdenk		using hardware support. This is a general purpose
2445c609719bSwdenk		driver that only requires three general I/O port pins
2446c609719bSwdenk		(two outputs, one input) to function. If this is
2447c609719bSwdenk		defined, the board configuration must define several
2448c609719bSwdenk		SPI configuration items (port pins to use, etc). For
2449c609719bSwdenk		an example, see include/configs/sacsng.h.
2450c609719bSwdenk
245104a9e118SBen Warren		CONFIG_HARD_SPI
245204a9e118SBen Warren
245304a9e118SBen Warren		Enables a hardware SPI driver for general-purpose reads
245404a9e118SBen Warren		and writes.  As with CONFIG_SOFT_SPI, the board configuration
245504a9e118SBen Warren		must define a list of chip-select function pointers.
245604a9e118SBen Warren		Currently supported on some MPC8xxx processors.	 For an
245704a9e118SBen Warren		example, see include/configs/mpc8349emds.h.
245804a9e118SBen Warren
245938254f45SGuennadi Liakhovetski		CONFIG_MXC_SPI
246038254f45SGuennadi Liakhovetski
246138254f45SGuennadi Liakhovetski		Enables the driver for the SPI controllers on i.MX and MXC
24622e3cd1cdSFabio Estevam		SoCs. Currently i.MX31/35/51 are supported.
246338254f45SGuennadi Liakhovetski
24640133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA
24650133502eSMatthias Fuchs
24660133502eSMatthias Fuchs		Enables FPGA subsystem.
24670133502eSMatthias Fuchs
24680133502eSMatthias Fuchs		CONFIG_FPGA_<vendor>
24690133502eSMatthias Fuchs
24700133502eSMatthias Fuchs		Enables support for specific chip vendors.
24710133502eSMatthias Fuchs		(ALTERA, XILINX)
24720133502eSMatthias Fuchs
24730133502eSMatthias Fuchs		CONFIG_FPGA_<family>
24740133502eSMatthias Fuchs
24750133502eSMatthias Fuchs		Enables support for FPGA family.
24760133502eSMatthias Fuchs		(SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
24770133502eSMatthias Fuchs
24780133502eSMatthias Fuchs		CONFIG_FPGA_COUNT
2479c609719bSwdenk
2480c609719bSwdenk		Specify the number of FPGA devices to support.
2481c609719bSwdenk
24826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_PROG_FEEDBACK
2483c609719bSwdenk
2484c609719bSwdenk		Enable printing of hash marks during FPGA configuration.
2485c609719bSwdenk
24866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_BUSY
2487c609719bSwdenk
2488c609719bSwdenk		Enable checks on FPGA configuration interface busy
2489c609719bSwdenk		status by the configuration function. This option
2490c609719bSwdenk		will require a board or device specific function to
2491c609719bSwdenk		be written.
2492c609719bSwdenk
2493c609719bSwdenk		CONFIG_FPGA_DELAY
2494c609719bSwdenk
2495c609719bSwdenk		If defined, a function that provides delays in the FPGA
2496c609719bSwdenk		configuration driver.
2497c609719bSwdenk
24986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_CTRLC
2499c609719bSwdenk		Allow Control-C to interrupt FPGA configuration
2500c609719bSwdenk
25016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_ERROR
2502c609719bSwdenk
2503c609719bSwdenk		Check for configuration errors during FPGA bitfile
2504c609719bSwdenk		loading. For example, abort during Virtex II
2505c609719bSwdenk		configuration if the INIT_B line goes low (which
2506c609719bSwdenk		indicated a CRC error).
2507c609719bSwdenk
25086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_INIT
2509c609719bSwdenk
2510c609719bSwdenk		Maximum time to wait for the INIT_B line to deassert
2511c609719bSwdenk		after PROB_B has been deasserted during a Virtex II
2512c609719bSwdenk		FPGA configuration sequence. The default time is 500
251311ccc33fSMarcel Ziswiler		ms.
2514c609719bSwdenk
25156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_BUSY
2516c609719bSwdenk
2517c609719bSwdenk		Maximum time to wait for BUSY to deassert during
251811ccc33fSMarcel Ziswiler		Virtex II FPGA configuration. The default is 5 ms.
2519c609719bSwdenk
25206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_CONFIG
2521c609719bSwdenk
2522c609719bSwdenk		Time to wait after FPGA configuration. The default is
252311ccc33fSMarcel Ziswiler		200 ms.
2524c609719bSwdenk
2525c609719bSwdenk- Configuration Management:
2526c609719bSwdenk		CONFIG_IDENT_STRING
2527c609719bSwdenk
2528c609719bSwdenk		If defined, this string will be added to the U-Boot
2529c609719bSwdenk		version information (U_BOOT_VERSION)
2530c609719bSwdenk
2531c609719bSwdenk- Vendor Parameter Protection:
2532c609719bSwdenk
2533c609719bSwdenk		U-Boot considers the values of the environment
2534c609719bSwdenk		variables "serial#" (Board Serial Number) and
25357152b1d0Swdenk		"ethaddr" (Ethernet Address) to be parameters that
2536c609719bSwdenk		are set once by the board vendor / manufacturer, and
2537c609719bSwdenk		protects these variables from casual modification by
2538c609719bSwdenk		the user. Once set, these variables are read-only,
2539c609719bSwdenk		and write or delete attempts are rejected. You can
254011ccc33fSMarcel Ziswiler		change this behaviour:
2541c609719bSwdenk
2542c609719bSwdenk		If CONFIG_ENV_OVERWRITE is #defined in your config
2543c609719bSwdenk		file, the write protection for vendor parameters is
254447cd00faSwdenk		completely disabled. Anybody can change or delete
2545c609719bSwdenk		these parameters.
2546c609719bSwdenk
2547c609719bSwdenk		Alternatively, if you #define _both_ CONFIG_ETHADDR
2548c609719bSwdenk		_and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
254911ccc33fSMarcel Ziswiler		Ethernet address is installed in the environment,
2550c609719bSwdenk		which can be changed exactly ONCE by the user. [The
2551c609719bSwdenk		serial# is unaffected by this, i. e. it remains
2552c609719bSwdenk		read-only.]
2553c609719bSwdenk
25542598090bSJoe Hershberger		The same can be accomplished in a more flexible way
25552598090bSJoe Hershberger		for any variable by configuring the type of access
25562598090bSJoe Hershberger		to allow for those variables in the ".flags" variable
25572598090bSJoe Hershberger		or define CONFIG_ENV_FLAGS_LIST_STATIC.
25582598090bSJoe Hershberger
2559c609719bSwdenk- Protected RAM:
2560c609719bSwdenk		CONFIG_PRAM
2561c609719bSwdenk
2562c609719bSwdenk		Define this variable to enable the reservation of
2563c609719bSwdenk		"protected RAM", i. e. RAM which is not overwritten
2564c609719bSwdenk		by U-Boot. Define CONFIG_PRAM to hold the number of
2565c609719bSwdenk		kB you want to reserve for pRAM. You can overwrite
2566c609719bSwdenk		this default value by defining an environment
2567c609719bSwdenk		variable "pram" to the number of kB you want to
2568c609719bSwdenk		reserve. Note that the board info structure will
2569c609719bSwdenk		still show the full amount of RAM. If pRAM is
2570c609719bSwdenk		reserved, a new environment variable "mem" will
2571c609719bSwdenk		automatically be defined to hold the amount of
2572c609719bSwdenk		remaining RAM in a form that can be passed as boot
2573c609719bSwdenk		argument to Linux, for instance like that:
2574c609719bSwdenk
2575fe126d8bSWolfgang Denk			setenv bootargs ... mem=\${mem}
2576c609719bSwdenk			saveenv
2577c609719bSwdenk
2578c609719bSwdenk		This way you can tell Linux not to use this memory,
2579c609719bSwdenk		either, which results in a memory region that will
2580c609719bSwdenk		not be affected by reboots.
2581c609719bSwdenk
2582c609719bSwdenk		*WARNING* If your board configuration uses automatic
2583c609719bSwdenk		detection of the RAM size, you must make sure that
2584c609719bSwdenk		this memory test is non-destructive. So far, the
2585c609719bSwdenk		following board configurations are known to be
2586c609719bSwdenk		"pRAM-clean":
2587c609719bSwdenk
25881b0757ecSWolfgang Denk			IVMS8, IVML24, SPD8xx, TQM8xxL,
25891b0757ecSWolfgang Denk			HERMES, IP860, RPXlite, LWMON,
2590544d97e9SWolfgang Denk			FLAGADM, TQM8260
2591c609719bSwdenk
259240fef049SGabe Black- Access to physical memory region (> 4GB)
259340fef049SGabe Black		Some basic support is provided for operations on memory not
259440fef049SGabe Black		normally accessible to U-Boot - e.g. some architectures
259540fef049SGabe Black		support access to more than 4GB of memory on 32-bit
259640fef049SGabe Black		machines using physical address extension or similar.
259740fef049SGabe Black		Define CONFIG_PHYSMEM to access this basic support, which
259840fef049SGabe Black		currently only supports clearing the memory.
259940fef049SGabe Black
2600c609719bSwdenk- Error Recovery:
2601c609719bSwdenk		CONFIG_PANIC_HANG
2602c609719bSwdenk
2603c609719bSwdenk		Define this variable to stop the system in case of a
2604c609719bSwdenk		fatal error, so that you have to reset it manually.
2605c609719bSwdenk		This is probably NOT a good idea for an embedded
260611ccc33fSMarcel Ziswiler		system where you want the system to reboot
2607c609719bSwdenk		automatically as fast as possible, but it may be
2608c609719bSwdenk		useful during development since you can try to debug
2609c609719bSwdenk		the conditions that lead to the situation.
2610c609719bSwdenk
2611c609719bSwdenk		CONFIG_NET_RETRY_COUNT
2612c609719bSwdenk
2613c609719bSwdenk		This variable defines the number of retries for
2614c609719bSwdenk		network operations like ARP, RARP, TFTP, or BOOTP
2615c609719bSwdenk		before giving up the operation. If not defined, a
2616c609719bSwdenk		default value of 5 is used.
2617c609719bSwdenk
261840cb90eeSGuennadi Liakhovetski		CONFIG_ARP_TIMEOUT
261940cb90eeSGuennadi Liakhovetski
262040cb90eeSGuennadi Liakhovetski		Timeout waiting for an ARP reply in milliseconds.
262140cb90eeSGuennadi Liakhovetski
262248a3e999STetsuyuki Kobayashi		CONFIG_NFS_TIMEOUT
262348a3e999STetsuyuki Kobayashi
262448a3e999STetsuyuki Kobayashi		Timeout in milliseconds used in NFS protocol.
262548a3e999STetsuyuki Kobayashi		If you encounter "ERROR: Cannot umount" in nfs command,
262648a3e999STetsuyuki Kobayashi		try longer timeout such as
262748a3e999STetsuyuki Kobayashi		#define CONFIG_NFS_TIMEOUT 10000UL
262848a3e999STetsuyuki Kobayashi
2629c609719bSwdenk- Command Interpreter:
26308078f1a5SWolfgang Denk		CONFIG_AUTO_COMPLETE
263104a85b3bSwdenk
263204a85b3bSwdenk		Enable auto completion of commands using TAB.
263304a85b3bSwdenk
26348078f1a5SWolfgang Denk		Note that this feature has NOT been implemented yet
26358078f1a5SWolfgang Denk		for the "hush" shell.
26368078f1a5SWolfgang Denk
26378078f1a5SWolfgang Denk
26386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_HUSH_PARSER
2639c609719bSwdenk
2640c609719bSwdenk		Define this variable to enable the "hush" shell (from
2641c609719bSwdenk		Busybox) as command line interpreter, thus enabling
2642c609719bSwdenk		powerful command line syntax like
2643c609719bSwdenk		if...then...else...fi conditionals or `&&' and '||'
2644c609719bSwdenk		constructs ("shell scripts").
2645c609719bSwdenk
2646c609719bSwdenk		If undefined, you get the old, much simpler behaviour
2647c609719bSwdenk		with a somewhat smaller memory footprint.
2648c609719bSwdenk
2649c609719bSwdenk
26506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_PROMPT_HUSH_PS2
2651c609719bSwdenk
2652c609719bSwdenk		This defines the secondary prompt string, which is
2653c609719bSwdenk		printed when the command interpreter needs more input
2654c609719bSwdenk		to complete a command. Usually "> ".
2655c609719bSwdenk
2656c609719bSwdenk	Note:
2657c609719bSwdenk
2658c609719bSwdenk		In the current implementation, the local variables
2659c609719bSwdenk		space and global environment variables space are
2660c609719bSwdenk		separated. Local variables are those you define by
26613b57fe0aSwdenk		simply typing `name=value'. To access a local
2662c609719bSwdenk		variable later on, you have write `$name' or
26633b57fe0aSwdenk		`${name}'; to execute the contents of a variable
26643b57fe0aSwdenk		directly type `$name' at the command prompt.
2665c609719bSwdenk
2666c609719bSwdenk		Global environment variables are those you use
2667c609719bSwdenk		setenv/printenv to work with. To run a command stored
2668c609719bSwdenk		in such a variable, you need to use the run command,
2669c609719bSwdenk		and you must not use the '$' sign to access them.
2670c609719bSwdenk
2671c609719bSwdenk		To store commands and special characters in a
2672c609719bSwdenk		variable, please use double quotation marks
2673c609719bSwdenk		surrounding the whole text of the variable, instead
2674c609719bSwdenk		of the backslashes before semicolons and special
2675c609719bSwdenk		symbols.
2676c609719bSwdenk
2677aa0c71acSWolfgang Denk- Commandline Editing and History:
2678aa0c71acSWolfgang Denk		CONFIG_CMDLINE_EDITING
2679aa0c71acSWolfgang Denk
268011ccc33fSMarcel Ziswiler		Enable editing and History functions for interactive
2681aa0c71acSWolfgang Denk		commandline input operations
2682aa0c71acSWolfgang Denk
2683a8c7c708Swdenk- Default Environment:
2684c609719bSwdenk		CONFIG_EXTRA_ENV_SETTINGS
2685c609719bSwdenk
2686c609719bSwdenk		Define this to contain any number of null terminated
2687c609719bSwdenk		strings (variable = value pairs) that will be part of
26887152b1d0Swdenk		the default environment compiled into the boot image.
26892262cfeeSwdenk
2690c609719bSwdenk		For example, place something like this in your
2691c609719bSwdenk		board's config file:
2692c609719bSwdenk
2693c609719bSwdenk		#define CONFIG_EXTRA_ENV_SETTINGS \
2694c609719bSwdenk			"myvar1=value1\0" \
2695c609719bSwdenk			"myvar2=value2\0"
2696c609719bSwdenk
2697c609719bSwdenk		Warning: This method is based on knowledge about the
2698c609719bSwdenk		internal format how the environment is stored by the
26992262cfeeSwdenk		U-Boot code. This is NOT an official, exported
2700c609719bSwdenk		interface! Although it is unlikely that this format
27017152b1d0Swdenk		will change soon, there is no guarantee either.
2702c609719bSwdenk		You better know what you are doing here.
2703c609719bSwdenk
2704c609719bSwdenk		Note: overly (ab)use of the default environment is
2705c609719bSwdenk		discouraged. Make sure to check other ways to preset
270674de7aefSWolfgang Denk		the environment like the "source" command or the
2707c609719bSwdenk		boot command first.
2708c609719bSwdenk
27095e724ca2SStephen Warren		CONFIG_ENV_VARS_UBOOT_CONFIG
27105e724ca2SStephen Warren
27115e724ca2SStephen Warren		Define this in order to add variables describing the
27125e724ca2SStephen Warren		U-Boot build configuration to the default environment.
27135e724ca2SStephen Warren		These will be named arch, cpu, board, vendor, and soc.
27145e724ca2SStephen Warren
27155e724ca2SStephen Warren		Enabling this option will cause the following to be defined:
27165e724ca2SStephen Warren
27175e724ca2SStephen Warren		- CONFIG_SYS_ARCH
27185e724ca2SStephen Warren		- CONFIG_SYS_CPU
27195e724ca2SStephen Warren		- CONFIG_SYS_BOARD
27205e724ca2SStephen Warren		- CONFIG_SYS_VENDOR
27215e724ca2SStephen Warren		- CONFIG_SYS_SOC
27225e724ca2SStephen Warren
27237e27f89fSTom Rini		CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
27247e27f89fSTom Rini
27257e27f89fSTom Rini		Define this in order to add variables describing certain
27267e27f89fSTom Rini		run-time determined information about the hardware to the
27277e27f89fSTom Rini		environment.  These will be named board_name, board_rev.
27287e27f89fSTom Rini
272906fd8538SSimon Glass		CONFIG_DELAY_ENVIRONMENT
273006fd8538SSimon Glass
273106fd8538SSimon Glass		Normally the environment is loaded when the board is
273206fd8538SSimon Glass		intialised so that it is available to U-Boot. This inhibits
273306fd8538SSimon Glass		that so that the environment is not available until
273406fd8538SSimon Glass		explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
273506fd8538SSimon Glass		this is instead controlled by the value of
273606fd8538SSimon Glass		/config/load-environment.
273706fd8538SSimon Glass
2738a8c7c708Swdenk- DataFlash Support:
27392abbe075Swdenk		CONFIG_HAS_DATAFLASH
27402abbe075Swdenk
27412abbe075Swdenk		Defining this option enables DataFlash features and
27422abbe075Swdenk		allows to read/write in Dataflash via the standard
27432abbe075Swdenk		commands cp, md...
27442abbe075Swdenk
2745f61ec45eSEric Nelson- Serial Flash support
2746f61ec45eSEric Nelson		CONFIG_CMD_SF
2747f61ec45eSEric Nelson
2748f61ec45eSEric Nelson		Defining this option enables SPI flash commands
2749f61ec45eSEric Nelson		'sf probe/read/write/erase/update'.
2750f61ec45eSEric Nelson
2751f61ec45eSEric Nelson		Usage requires an initial 'probe' to define the serial
2752f61ec45eSEric Nelson		flash parameters, followed by read/write/erase/update
2753f61ec45eSEric Nelson		commands.
2754f61ec45eSEric Nelson
2755f61ec45eSEric Nelson		The following defaults may be provided by the platform
2756f61ec45eSEric Nelson		to handle the common case when only a single serial
2757f61ec45eSEric Nelson		flash is present on the system.
2758f61ec45eSEric Nelson
2759f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_BUS		Bus identifier
2760f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_CS		Chip-select
2761f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_MODE 		(see include/spi.h)
2762f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_SPEED		in Hz
2763f61ec45eSEric Nelson
276424007273SSimon Glass		CONFIG_CMD_SF_TEST
276524007273SSimon Glass
276624007273SSimon Glass		Define this option to include a destructive SPI flash
276724007273SSimon Glass		test ('sf test').
276824007273SSimon Glass
27691dcd6d03SJagannadha Sutradharudu Teki		CONFIG_SPI_FLASH_BAR		Ban/Extended Addr Reg
27701dcd6d03SJagannadha Sutradharudu Teki
27711dcd6d03SJagannadha Sutradharudu Teki		Define this option to use the Bank addr/Extended addr
27721dcd6d03SJagannadha Sutradharudu Teki		support on SPI flashes which has size > 16Mbytes.
27731dcd6d03SJagannadha Sutradharudu Teki
2774b902e07cSJagannadha Sutradharudu Teki		CONFIG_SF_DUAL_FLASH		Dual flash memories
2775b902e07cSJagannadha Sutradharudu Teki
2776b902e07cSJagannadha Sutradharudu Teki		Define this option to use dual flash support where two flash
2777b902e07cSJagannadha Sutradharudu Teki		memories can be connected with a given cs line.
2778b902e07cSJagannadha Sutradharudu Teki		currently Xilinx Zynq qspi support these type of connections.
2779b902e07cSJagannadha Sutradharudu Teki
27803f85ce27Swdenk- SystemACE Support:
27813f85ce27Swdenk		CONFIG_SYSTEMACE
27823f85ce27Swdenk
27833f85ce27Swdenk		Adding this option adds support for Xilinx SystemACE
27843f85ce27Swdenk		chips attached via some sort of local bus. The address
278511ccc33fSMarcel Ziswiler		of the chip must also be defined in the
27866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SYSTEMACE_BASE macro. For example:
27873f85ce27Swdenk
27883f85ce27Swdenk		#define CONFIG_SYSTEMACE
27896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
27903f85ce27Swdenk
27913f85ce27Swdenk		When SystemACE support is added, the "ace" device type
27923f85ce27Swdenk		becomes available to the fat commands, i.e. fatls.
27933f85ce27Swdenk
2794ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port:
2795ecb0ccd9SWolfgang Denk		CONFIG_TFTP_PORT
2796ecb0ccd9SWolfgang Denk
279728cb9375SWolfgang Denk		If this is defined, the environment variable tftpsrcp
2798ecb0ccd9SWolfgang Denk		is used to supply the TFTP UDP source port value.
279928cb9375SWolfgang Denk		If tftpsrcp isn't defined, the normal pseudo-random port
2800ecb0ccd9SWolfgang Denk		number generator is used.
2801ecb0ccd9SWolfgang Denk
280228cb9375SWolfgang Denk		Also, the environment variable tftpdstp is used to supply
280328cb9375SWolfgang Denk		the TFTP UDP destination port value.  If tftpdstp isn't
280428cb9375SWolfgang Denk		defined, the normal port 69 is used.
280528cb9375SWolfgang Denk
280628cb9375SWolfgang Denk		The purpose for tftpsrcp is to allow a TFTP server to
2807ecb0ccd9SWolfgang Denk		blindly start the TFTP transfer using the pre-configured
2808ecb0ccd9SWolfgang Denk		target IP address and UDP port. This has the effect of
2809ecb0ccd9SWolfgang Denk		"punching through" the (Windows XP) firewall, allowing
2810ecb0ccd9SWolfgang Denk		the remainder of the TFTP transfer to proceed normally.
2811ecb0ccd9SWolfgang Denk		A better solution is to properly configure the firewall,
2812ecb0ccd9SWolfgang Denk		but sometimes that is not allowed.
2813ecb0ccd9SWolfgang Denk
2814bf36c5d5SSimon Glass- Hashing support:
2815bf36c5d5SSimon Glass		CONFIG_CMD_HASH
2816bf36c5d5SSimon Glass
2817bf36c5d5SSimon Glass		This enables a generic 'hash' command which can produce
2818bf36c5d5SSimon Glass		hashes / digests from a few algorithms (e.g. SHA1, SHA256).
2819bf36c5d5SSimon Glass
2820bf36c5d5SSimon Glass		CONFIG_HASH_VERIFY
2821bf36c5d5SSimon Glass
2822bf36c5d5SSimon Glass		Enable the hash verify command (hash -v). This adds to code
2823bf36c5d5SSimon Glass		size a little.
2824bf36c5d5SSimon Glass
2825bf36c5d5SSimon Glass		CONFIG_SHA1 - support SHA1 hashing
2826bf36c5d5SSimon Glass		CONFIG_SHA256 - support SHA256 hashing
2827bf36c5d5SSimon Glass
2828bf36c5d5SSimon Glass		Note: There is also a sha1sum command, which should perhaps
2829bf36c5d5SSimon Glass		be deprecated in favour of 'hash sha1'.
2830bf36c5d5SSimon Glass
2831a11f1873SRobert Winkler- Freescale i.MX specific commands:
2832a11f1873SRobert Winkler		CONFIG_CMD_HDMIDETECT
2833a11f1873SRobert Winkler		This enables 'hdmidet' command which returns true if an
2834a11f1873SRobert Winkler		HDMI monitor is detected.  This command is i.MX 6 specific.
2835a11f1873SRobert Winkler
2836a11f1873SRobert Winkler		CONFIG_CMD_BMODE
2837a11f1873SRobert Winkler		This enables the 'bmode' (bootmode) command for forcing
2838a11f1873SRobert Winkler		a boot from specific media.
2839a11f1873SRobert Winkler
2840a11f1873SRobert Winkler		This is useful for forcing the ROM's usb downloader to
2841a11f1873SRobert Winkler		activate upon a watchdog reset which is nice when iterating
2842a11f1873SRobert Winkler		on U-Boot.  Using the reset button or running bmode normal
2843a11f1873SRobert Winkler		will set it back to normal.  This command currently
2844a11f1873SRobert Winkler		supports i.MX53 and i.MX6.
2845a11f1873SRobert Winkler
284619c402afSSimon Glass- Signing support:
284719c402afSSimon Glass		CONFIG_RSA
284819c402afSSimon Glass
284919c402afSSimon Glass		This enables the RSA algorithm used for FIT image verification
285019c402afSSimon Glass		in U-Boot. See doc/uImage/signature for more information.
285119c402afSSimon Glass
285219c402afSSimon Glass		The signing part is build into mkimage regardless of this
285319c402afSSimon Glass		option.
285419c402afSSimon Glass
285519c402afSSimon Glass
2856a8c7c708Swdenk- Show boot progress:
2857c609719bSwdenk		CONFIG_SHOW_BOOT_PROGRESS
2858c609719bSwdenk
2859c609719bSwdenk		Defining this option allows to add some board-
2860c609719bSwdenk		specific code (calling a user-provided function
2861c609719bSwdenk		"show_boot_progress(int)") that enables you to show
2862c609719bSwdenk		the system's boot progress on some display (for
2863c609719bSwdenk		example, some LED's) on your board. At the moment,
2864c609719bSwdenk		the following checkpoints are implemented:
2865c609719bSwdenk
28663a608ca0SSimon Glass- Detailed boot stage timing
28673a608ca0SSimon Glass		CONFIG_BOOTSTAGE
28683a608ca0SSimon Glass		Define this option to get detailed timing of each stage
28693a608ca0SSimon Glass		of the boot process.
28703a608ca0SSimon Glass
28713a608ca0SSimon Glass		CONFIG_BOOTSTAGE_USER_COUNT
28723a608ca0SSimon Glass		This is the number of available user bootstage records.
28733a608ca0SSimon Glass		Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
28743a608ca0SSimon Glass		a new ID will be allocated from this stash. If you exceed
28753a608ca0SSimon Glass		the limit, recording will stop.
28763a608ca0SSimon Glass
28773a608ca0SSimon Glass		CONFIG_BOOTSTAGE_REPORT
28783a608ca0SSimon Glass		Define this to print a report before boot, similar to this:
28793a608ca0SSimon Glass
28803a608ca0SSimon Glass		Timer summary in microseconds:
28813a608ca0SSimon Glass		       Mark    Elapsed  Stage
28823a608ca0SSimon Glass			  0          0  reset
28833a608ca0SSimon Glass		  3,575,678  3,575,678  board_init_f start
28843a608ca0SSimon Glass		  3,575,695         17  arch_cpu_init A9
28853a608ca0SSimon Glass		  3,575,777         82  arch_cpu_init done
28863a608ca0SSimon Glass		  3,659,598     83,821  board_init_r start
28873a608ca0SSimon Glass		  3,910,375    250,777  main_loop
28883a608ca0SSimon Glass		 29,916,167 26,005,792  bootm_start
28893a608ca0SSimon Glass		 30,361,327    445,160  start_kernel
28903a608ca0SSimon Glass
28912eba38cfSSimon Glass		CONFIG_CMD_BOOTSTAGE
28922eba38cfSSimon Glass		Add a 'bootstage' command which supports printing a report
28932eba38cfSSimon Glass		and un/stashing of bootstage data.
28942eba38cfSSimon Glass
289594fd1316SSimon Glass		CONFIG_BOOTSTAGE_FDT
289694fd1316SSimon Glass		Stash the bootstage information in the FDT. A root 'bootstage'
289794fd1316SSimon Glass		node is created with each bootstage id as a child. Each child
289894fd1316SSimon Glass		has a 'name' property and either 'mark' containing the
289994fd1316SSimon Glass		mark time in microsecond, or 'accum' containing the
290094fd1316SSimon Glass		accumulated time for that bootstage id in microseconds.
290194fd1316SSimon Glass		For example:
290294fd1316SSimon Glass
290394fd1316SSimon Glass		bootstage {
290494fd1316SSimon Glass			154 {
290594fd1316SSimon Glass				name = "board_init_f";
290694fd1316SSimon Glass				mark = <3575678>;
290794fd1316SSimon Glass			};
290894fd1316SSimon Glass			170 {
290994fd1316SSimon Glass				name = "lcd";
291094fd1316SSimon Glass				accum = <33482>;
291194fd1316SSimon Glass			};
291294fd1316SSimon Glass		};
291394fd1316SSimon Glass
291494fd1316SSimon Glass		Code in the Linux kernel can find this in /proc/devicetree.
291594fd1316SSimon Glass
29161372cce2SMarian BalakowiczLegacy uImage format:
29171372cce2SMarian Balakowicz
2918c609719bSwdenk  Arg	Where			When
2919c609719bSwdenk    1	common/cmd_bootm.c	before attempting to boot an image
2920c609719bSwdenk   -1	common/cmd_bootm.c	Image header has bad	 magic number
2921c609719bSwdenk    2	common/cmd_bootm.c	Image header has correct magic number
2922c609719bSwdenk   -2	common/cmd_bootm.c	Image header has bad	 checksum
2923c609719bSwdenk    3	common/cmd_bootm.c	Image header has correct checksum
2924c609719bSwdenk   -3	common/cmd_bootm.c	Image data   has bad	 checksum
2925c609719bSwdenk    4	common/cmd_bootm.c	Image data   has correct checksum
2926c609719bSwdenk   -4	common/cmd_bootm.c	Image is for unsupported architecture
2927c609719bSwdenk    5	common/cmd_bootm.c	Architecture check OK
29281372cce2SMarian Balakowicz   -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi)
2929c609719bSwdenk    6	common/cmd_bootm.c	Image Type check OK
2930c609719bSwdenk   -6	common/cmd_bootm.c	gunzip uncompression error
2931c609719bSwdenk   -7	common/cmd_bootm.c	Unimplemented compression type
2932c609719bSwdenk    7	common/cmd_bootm.c	Uncompression OK
29331372cce2SMarian Balakowicz    8	common/cmd_bootm.c	No uncompress/copy overwrite error
2934c609719bSwdenk   -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
29351372cce2SMarian Balakowicz
29361372cce2SMarian Balakowicz    9	common/image.c		Start initial ramdisk verification
29371372cce2SMarian Balakowicz  -10	common/image.c		Ramdisk header has bad	   magic number
29381372cce2SMarian Balakowicz  -11	common/image.c		Ramdisk header has bad	   checksum
29391372cce2SMarian Balakowicz   10	common/image.c		Ramdisk header is OK
29401372cce2SMarian Balakowicz  -12	common/image.c		Ramdisk data   has bad	   checksum
29411372cce2SMarian Balakowicz   11	common/image.c		Ramdisk data   has correct checksum
29421372cce2SMarian Balakowicz   12	common/image.c		Ramdisk verification complete, start loading
294311ccc33fSMarcel Ziswiler  -13	common/image.c		Wrong Image Type (not PPC Linux ramdisk)
29441372cce2SMarian Balakowicz   13	common/image.c		Start multifile image verification
29451372cce2SMarian Balakowicz   14	common/image.c		No initial ramdisk, no multifile, continue.
29461372cce2SMarian Balakowicz
2947ea0364f1SPeter Tyser   15	arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
2948c609719bSwdenk
2949a47a12beSStefan Roese  -30	arch/powerpc/lib/board.c	Fatal error, hang the system
295063e73c9aSwdenk  -31	post/post.c		POST test failed, detected by post_output_backlog()
295163e73c9aSwdenk  -32	post/post.c		POST test failed, detected by post_run_single()
295263e73c9aSwdenk
2953566a494fSHeiko Schocher   34	common/cmd_doc.c	before loading a Image from a DOC device
2954566a494fSHeiko Schocher  -35	common/cmd_doc.c	Bad usage of "doc" command
2955566a494fSHeiko Schocher   35	common/cmd_doc.c	correct usage of "doc" command
2956566a494fSHeiko Schocher  -36	common/cmd_doc.c	No boot device
2957566a494fSHeiko Schocher   36	common/cmd_doc.c	correct boot device
2958566a494fSHeiko Schocher  -37	common/cmd_doc.c	Unknown Chip ID on boot device
2959566a494fSHeiko Schocher   37	common/cmd_doc.c	correct chip ID found, device available
2960566a494fSHeiko Schocher  -38	common/cmd_doc.c	Read Error on boot device
2961566a494fSHeiko Schocher   38	common/cmd_doc.c	reading Image header from DOC device OK
2962566a494fSHeiko Schocher  -39	common/cmd_doc.c	Image header has bad magic number
2963566a494fSHeiko Schocher   39	common/cmd_doc.c	Image header has correct magic number
2964566a494fSHeiko Schocher  -40	common/cmd_doc.c	Error reading Image from DOC device
2965566a494fSHeiko Schocher   40	common/cmd_doc.c	Image header has correct magic number
2966566a494fSHeiko Schocher   41	common/cmd_ide.c	before loading a Image from a IDE device
2967566a494fSHeiko Schocher  -42	common/cmd_ide.c	Bad usage of "ide" command
2968566a494fSHeiko Schocher   42	common/cmd_ide.c	correct usage of "ide" command
2969566a494fSHeiko Schocher  -43	common/cmd_ide.c	No boot device
2970566a494fSHeiko Schocher   43	common/cmd_ide.c	boot device found
2971566a494fSHeiko Schocher  -44	common/cmd_ide.c	Device not available
2972566a494fSHeiko Schocher   44	common/cmd_ide.c	Device available
2973566a494fSHeiko Schocher  -45	common/cmd_ide.c	wrong partition selected
2974566a494fSHeiko Schocher   45	common/cmd_ide.c	partition selected
2975566a494fSHeiko Schocher  -46	common/cmd_ide.c	Unknown partition table
2976566a494fSHeiko Schocher   46	common/cmd_ide.c	valid partition table found
2977566a494fSHeiko Schocher  -47	common/cmd_ide.c	Invalid partition type
2978566a494fSHeiko Schocher   47	common/cmd_ide.c	correct partition type
2979566a494fSHeiko Schocher  -48	common/cmd_ide.c	Error reading Image Header on boot device
2980566a494fSHeiko Schocher   48	common/cmd_ide.c	reading Image Header from IDE device OK
2981566a494fSHeiko Schocher  -49	common/cmd_ide.c	Image header has bad magic number
2982566a494fSHeiko Schocher   49	common/cmd_ide.c	Image header has correct magic number
2983566a494fSHeiko Schocher  -50	common/cmd_ide.c	Image header has bad	 checksum
2984566a494fSHeiko Schocher   50	common/cmd_ide.c	Image header has correct checksum
2985566a494fSHeiko Schocher  -51	common/cmd_ide.c	Error reading Image from IDE device
2986566a494fSHeiko Schocher   51	common/cmd_ide.c	reading Image from IDE device OK
2987566a494fSHeiko Schocher   52	common/cmd_nand.c	before loading a Image from a NAND device
2988566a494fSHeiko Schocher  -53	common/cmd_nand.c	Bad usage of "nand" command
2989566a494fSHeiko Schocher   53	common/cmd_nand.c	correct usage of "nand" command
2990566a494fSHeiko Schocher  -54	common/cmd_nand.c	No boot device
2991566a494fSHeiko Schocher   54	common/cmd_nand.c	boot device found
2992566a494fSHeiko Schocher  -55	common/cmd_nand.c	Unknown Chip ID on boot device
2993566a494fSHeiko Schocher   55	common/cmd_nand.c	correct chip ID found, device available
2994566a494fSHeiko Schocher  -56	common/cmd_nand.c	Error reading Image Header on boot device
2995566a494fSHeiko Schocher   56	common/cmd_nand.c	reading Image Header from NAND device OK
2996566a494fSHeiko Schocher  -57	common/cmd_nand.c	Image header has bad magic number
2997566a494fSHeiko Schocher   57	common/cmd_nand.c	Image header has correct magic number
2998566a494fSHeiko Schocher  -58	common/cmd_nand.c	Error reading Image from NAND device
2999566a494fSHeiko Schocher   58	common/cmd_nand.c	reading Image from NAND device OK
3000c609719bSwdenk
3001566a494fSHeiko Schocher  -60	common/env_common.c	Environment has a bad CRC, using default
3002c609719bSwdenk
3003566a494fSHeiko Schocher   64	net/eth.c		starting with Ethernet configuration.
3004566a494fSHeiko Schocher  -64	net/eth.c		no Ethernet found.
3005566a494fSHeiko Schocher   65	net/eth.c		Ethernet found.
3006206c60cbSwdenk
3007566a494fSHeiko Schocher  -80	common/cmd_net.c	usage wrong
3008566a494fSHeiko Schocher   80	common/cmd_net.c	before calling NetLoop()
300911ccc33fSMarcel Ziswiler  -81	common/cmd_net.c	some error in NetLoop() occurred
3010566a494fSHeiko Schocher   81	common/cmd_net.c	NetLoop() back without error
3011566a494fSHeiko Schocher  -82	common/cmd_net.c	size == 0 (File with size 0 loaded)
3012566a494fSHeiko Schocher   82	common/cmd_net.c	trying automatic boot
301374de7aefSWolfgang Denk   83	common/cmd_net.c	running "source" command
301474de7aefSWolfgang Denk  -83	common/cmd_net.c	some error in automatic boot or "source" command
3015566a494fSHeiko Schocher   84	common/cmd_net.c	end without errors
3016c609719bSwdenk
30171372cce2SMarian BalakowiczFIT uImage format:
30181372cce2SMarian Balakowicz
30191372cce2SMarian Balakowicz  Arg	Where			When
30201372cce2SMarian Balakowicz  100	common/cmd_bootm.c	Kernel FIT Image has correct format
30211372cce2SMarian Balakowicz -100	common/cmd_bootm.c	Kernel FIT Image has incorrect format
30221372cce2SMarian Balakowicz  101	common/cmd_bootm.c	No Kernel subimage unit name, using configuration
30231372cce2SMarian Balakowicz -101	common/cmd_bootm.c	Can't get configuration for kernel subimage
30241372cce2SMarian Balakowicz  102	common/cmd_bootm.c	Kernel unit name specified
30251372cce2SMarian Balakowicz -103	common/cmd_bootm.c	Can't get kernel subimage node offset
3026f773bea8SMarian Balakowicz  103	common/cmd_bootm.c	Found configuration node
30271372cce2SMarian Balakowicz  104	common/cmd_bootm.c	Got kernel subimage node offset
30281372cce2SMarian Balakowicz -104	common/cmd_bootm.c	Kernel subimage hash verification failed
30291372cce2SMarian Balakowicz  105	common/cmd_bootm.c	Kernel subimage hash verification OK
30301372cce2SMarian Balakowicz -105	common/cmd_bootm.c	Kernel subimage is for unsupported architecture
30311372cce2SMarian Balakowicz  106	common/cmd_bootm.c	Architecture check OK
303211ccc33fSMarcel Ziswiler -106	common/cmd_bootm.c	Kernel subimage has wrong type
303311ccc33fSMarcel Ziswiler  107	common/cmd_bootm.c	Kernel subimage type OK
30341372cce2SMarian Balakowicz -107	common/cmd_bootm.c	Can't get kernel subimage data/size
30351372cce2SMarian Balakowicz  108	common/cmd_bootm.c	Got kernel subimage data/size
30361372cce2SMarian Balakowicz -108	common/cmd_bootm.c	Wrong image type (not legacy, FIT)
30371372cce2SMarian Balakowicz -109	common/cmd_bootm.c	Can't get kernel subimage type
30381372cce2SMarian Balakowicz -110	common/cmd_bootm.c	Can't get kernel subimage comp
30391372cce2SMarian Balakowicz -111	common/cmd_bootm.c	Can't get kernel subimage os
30401372cce2SMarian Balakowicz -112	common/cmd_bootm.c	Can't get kernel subimage load address
30411372cce2SMarian Balakowicz -113	common/cmd_bootm.c	Image uncompress/copy overwrite error
30421372cce2SMarian Balakowicz
30431372cce2SMarian Balakowicz  120	common/image.c		Start initial ramdisk verification
30441372cce2SMarian Balakowicz -120	common/image.c		Ramdisk FIT image has incorrect format
30451372cce2SMarian Balakowicz  121	common/image.c		Ramdisk FIT image has correct format
304611ccc33fSMarcel Ziswiler  122	common/image.c		No ramdisk subimage unit name, using configuration
30471372cce2SMarian Balakowicz -122	common/image.c		Can't get configuration for ramdisk subimage
30481372cce2SMarian Balakowicz  123	common/image.c		Ramdisk unit name specified
30491372cce2SMarian Balakowicz -124	common/image.c		Can't get ramdisk subimage node offset
30501372cce2SMarian Balakowicz  125	common/image.c		Got ramdisk subimage node offset
30511372cce2SMarian Balakowicz -125	common/image.c		Ramdisk subimage hash verification failed
30521372cce2SMarian Balakowicz  126	common/image.c		Ramdisk subimage hash verification OK
30531372cce2SMarian Balakowicz -126	common/image.c		Ramdisk subimage for unsupported architecture
30541372cce2SMarian Balakowicz  127	common/image.c		Architecture check OK
30551372cce2SMarian Balakowicz -127	common/image.c		Can't get ramdisk subimage data/size
30561372cce2SMarian Balakowicz  128	common/image.c		Got ramdisk subimage data/size
30571372cce2SMarian Balakowicz  129	common/image.c		Can't get ramdisk load address
30581372cce2SMarian Balakowicz -129	common/image.c		Got ramdisk load address
30591372cce2SMarian Balakowicz
306011ccc33fSMarcel Ziswiler -130	common/cmd_doc.c	Incorrect FIT image format
30611372cce2SMarian Balakowicz  131	common/cmd_doc.c	FIT image format OK
30621372cce2SMarian Balakowicz
306311ccc33fSMarcel Ziswiler -140	common/cmd_ide.c	Incorrect FIT image format
30641372cce2SMarian Balakowicz  141	common/cmd_ide.c	FIT image format OK
30651372cce2SMarian Balakowicz
306611ccc33fSMarcel Ziswiler -150	common/cmd_nand.c	Incorrect FIT image format
30671372cce2SMarian Balakowicz  151	common/cmd_nand.c	FIT image format OK
30681372cce2SMarian Balakowicz
3069d95f6ec7SGabe Black- FIT image support:
3070d95f6ec7SGabe Black		CONFIG_FIT
3071d95f6ec7SGabe Black		Enable support for the FIT uImage format.
3072d95f6ec7SGabe Black
3073d95f6ec7SGabe Black		CONFIG_FIT_BEST_MATCH
3074d95f6ec7SGabe Black		When no configuration is explicitly selected, default to the
3075d95f6ec7SGabe Black		one whose fdt's compatibility field best matches that of
3076d95f6ec7SGabe Black		U-Boot itself. A match is considered "best" if it matches the
3077d95f6ec7SGabe Black		most specific compatibility entry of U-Boot's fdt's root node.
3078d95f6ec7SGabe Black		The order of entries in the configuration's fdt is ignored.
3079d95f6ec7SGabe Black
30803e569a6bSSimon Glass		CONFIG_FIT_SIGNATURE
30813e569a6bSSimon Glass		This option enables signature verification of FIT uImages,
30823e569a6bSSimon Glass		using a hash signed and verified using RSA. See
30833e569a6bSSimon Glass		doc/uImage.FIT/signature.txt for more details.
30843e569a6bSSimon Glass
30854cf2609bSWolfgang Denk- Standalone program support:
30864cf2609bSWolfgang Denk		CONFIG_STANDALONE_LOAD_ADDR
30874cf2609bSWolfgang Denk
30886feff899SWolfgang Denk		This option defines a board specific value for the
30896feff899SWolfgang Denk		address where standalone program gets loaded, thus
30906feff899SWolfgang Denk		overwriting the architecture dependent default
30914cf2609bSWolfgang Denk		settings.
30924cf2609bSWolfgang Denk
30934cf2609bSWolfgang Denk- Frame Buffer Address:
30944cf2609bSWolfgang Denk		CONFIG_FB_ADDR
30954cf2609bSWolfgang Denk
30964cf2609bSWolfgang Denk		Define CONFIG_FB_ADDR if you want to use specific
309744a53b57SWolfgang Denk		address for frame buffer.  This is typically the case
309844a53b57SWolfgang Denk		when using a graphics controller has separate video
309944a53b57SWolfgang Denk		memory.  U-Boot will then place the frame buffer at
310044a53b57SWolfgang Denk		the given address instead of dynamically reserving it
310144a53b57SWolfgang Denk		in system RAM by calling lcd_setmem(), which grabs
310244a53b57SWolfgang Denk		the memory for the frame buffer depending on the
310344a53b57SWolfgang Denk		configured panel size.
31044cf2609bSWolfgang Denk
31054cf2609bSWolfgang Denk		Please see board_init_f function.
31064cf2609bSWolfgang Denk
3107cccfc2abSDetlev Zundel- Automatic software updates via TFTP server
3108cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP
3109cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_CNT_MAX
3110cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_MSEC_MAX
3111cccfc2abSDetlev Zundel
3112cccfc2abSDetlev Zundel		These options enable and control the auto-update feature;
3113cccfc2abSDetlev Zundel		for a more detailed description refer to doc/README.update.
3114cccfc2abSDetlev Zundel
3115cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support)
3116cccfc2abSDetlev Zundel		CONFIG_MTD_DEVICE
3117cccfc2abSDetlev Zundel
3118cccfc2abSDetlev Zundel		Adds the MTD device infrastructure from the Linux kernel.
3119cccfc2abSDetlev Zundel		Needed for mtdparts command support.
3120cccfc2abSDetlev Zundel
3121cccfc2abSDetlev Zundel		CONFIG_MTD_PARTITIONS
3122cccfc2abSDetlev Zundel
3123cccfc2abSDetlev Zundel		Adds the MTD partitioning infrastructure from the Linux
3124cccfc2abSDetlev Zundel		kernel. Needed for UBI support.
3125cccfc2abSDetlev Zundel
312670c219cdSJoe Hershberger- UBI support
312770c219cdSJoe Hershberger		CONFIG_CMD_UBI
312870c219cdSJoe Hershberger
312970c219cdSJoe Hershberger		Adds commands for interacting with MTD partitions formatted
313070c219cdSJoe Hershberger		with the UBI flash translation layer
313170c219cdSJoe Hershberger
313270c219cdSJoe Hershberger		Requires also defining CONFIG_RBTREE
313370c219cdSJoe Hershberger
3134147162daSJoe Hershberger		CONFIG_UBI_SILENCE_MSG
3135147162daSJoe Hershberger
3136147162daSJoe Hershberger		Make the verbose messages from UBI stop printing.  This leaves
3137147162daSJoe Hershberger		warnings and errors enabled.
3138147162daSJoe Hershberger
313970c219cdSJoe Hershberger- UBIFS support
314070c219cdSJoe Hershberger		CONFIG_CMD_UBIFS
314170c219cdSJoe Hershberger
314270c219cdSJoe Hershberger		Adds commands for interacting with UBI volumes formatted as
314370c219cdSJoe Hershberger		UBIFS.  UBIFS is read-only in u-boot.
314470c219cdSJoe Hershberger
314570c219cdSJoe Hershberger		Requires UBI support as well as CONFIG_LZO
314670c219cdSJoe Hershberger
3147147162daSJoe Hershberger		CONFIG_UBIFS_SILENCE_MSG
3148147162daSJoe Hershberger
3149147162daSJoe Hershberger		Make the verbose messages from UBIFS stop printing.  This leaves
3150147162daSJoe Hershberger		warnings and errors enabled.
3151147162daSJoe Hershberger
31526a11cf48SDaniel Schwierzeck- SPL framework
31536a11cf48SDaniel Schwierzeck		CONFIG_SPL
31546a11cf48SDaniel Schwierzeck		Enable building of SPL globally.
31556a11cf48SDaniel Schwierzeck
315695579793STom Rini		CONFIG_SPL_LDSCRIPT
315795579793STom Rini		LDSCRIPT for linking the SPL binary.
315895579793STom Rini
31596ebc3461SAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT
31606ebc3461SAlbert ARIBAUD		Maximum size in memory allocated to the SPL, BSS included.
31616ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual memory
31626ebc3461SAlbert ARIBAUD		used by SPL from _start to __bss_end does not exceed it.
31638960af8bSAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
31646ebc3461SAlbert ARIBAUD		must not be both defined at the same time.
31656ebc3461SAlbert ARIBAUD
316695579793STom Rini		CONFIG_SPL_MAX_SIZE
31676ebc3461SAlbert ARIBAUD		Maximum size of the SPL image (text, data, rodata, and
31686ebc3461SAlbert ARIBAUD		linker lists sections), BSS excluded.
31696ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual size does
31706ebc3461SAlbert ARIBAUD		not exceed it.
317195579793STom Rini
31726a11cf48SDaniel Schwierzeck		CONFIG_SPL_TEXT_BASE
31736a11cf48SDaniel Schwierzeck		TEXT_BASE for linking the SPL binary.
31746a11cf48SDaniel Schwierzeck
317594a45bb1SScott Wood		CONFIG_SPL_RELOC_TEXT_BASE
317694a45bb1SScott Wood		Address to relocate to.  If unspecified, this is equal to
317794a45bb1SScott Wood		CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
317894a45bb1SScott Wood
317995579793STom Rini		CONFIG_SPL_BSS_START_ADDR
318095579793STom Rini		Link address for the BSS within the SPL binary.
318195579793STom Rini
318295579793STom Rini		CONFIG_SPL_BSS_MAX_SIZE
31836ebc3461SAlbert ARIBAUD		Maximum size in memory allocated to the SPL BSS.
31846ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual memory used
31856ebc3461SAlbert ARIBAUD		by SPL from __bss_start to __bss_end does not exceed it.
31868960af8bSAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
31876ebc3461SAlbert ARIBAUD		must not be both defined at the same time.
318895579793STom Rini
318995579793STom Rini		CONFIG_SPL_STACK
319095579793STom Rini		Adress of the start of the stack SPL will use
319195579793STom Rini
319294a45bb1SScott Wood		CONFIG_SPL_RELOC_STACK
319394a45bb1SScott Wood		Adress of the start of the stack SPL will use after
319494a45bb1SScott Wood		relocation.  If unspecified, this is equal to
319594a45bb1SScott Wood		CONFIG_SPL_STACK.
319694a45bb1SScott Wood
319795579793STom Rini		CONFIG_SYS_SPL_MALLOC_START
319895579793STom Rini		Starting address of the malloc pool used in SPL.
319995579793STom Rini
320095579793STom Rini		CONFIG_SYS_SPL_MALLOC_SIZE
320195579793STom Rini		The size of the malloc pool used in SPL.
32026a11cf48SDaniel Schwierzeck
320347f7bcaeSTom Rini		CONFIG_SPL_FRAMEWORK
320447f7bcaeSTom Rini		Enable the SPL framework under common/.  This framework
320547f7bcaeSTom Rini		supports MMC, NAND and YMODEM loading of U-Boot and NAND
320647f7bcaeSTom Rini		NAND loading of the Linux Kernel.
320747f7bcaeSTom Rini
3208861a86f4STom Rini		CONFIG_SPL_DISPLAY_PRINT
3209861a86f4STom Rini		For ARM, enable an optional function to print more information
3210861a86f4STom Rini		about the running system.
3211861a86f4STom Rini
32124b919725SScott Wood		CONFIG_SPL_INIT_MINIMAL
32134b919725SScott Wood		Arch init code should be built for a very small image
32144b919725SScott Wood
32156a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBCOMMON_SUPPORT
32166a11cf48SDaniel Schwierzeck		Support for common/libcommon.o in SPL binary
32176a11cf48SDaniel Schwierzeck
32186a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBDISK_SUPPORT
32196a11cf48SDaniel Schwierzeck		Support for disk/libdisk.o in SPL binary
32206a11cf48SDaniel Schwierzeck
32216a11cf48SDaniel Schwierzeck		CONFIG_SPL_I2C_SUPPORT
32226a11cf48SDaniel Schwierzeck		Support for drivers/i2c/libi2c.o in SPL binary
32236a11cf48SDaniel Schwierzeck
32246a11cf48SDaniel Schwierzeck		CONFIG_SPL_GPIO_SUPPORT
32256a11cf48SDaniel Schwierzeck		Support for drivers/gpio/libgpio.o in SPL binary
32266a11cf48SDaniel Schwierzeck
32276a11cf48SDaniel Schwierzeck		CONFIG_SPL_MMC_SUPPORT
32286a11cf48SDaniel Schwierzeck		Support for drivers/mmc/libmmc.o in SPL binary
32296a11cf48SDaniel Schwierzeck
323095579793STom Rini		CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
323195579793STom Rini		CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
323295579793STom Rini		CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION
323395579793STom Rini		Address, size and partition on the MMC to load U-Boot from
323495579793STom Rini		when the MMC is being used in raw mode.
323595579793STom Rini
32362b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
32372b75b0adSPeter Korsgaard		Sector to load kernel uImage from when MMC is being
32382b75b0adSPeter Korsgaard		used in raw mode (for Falcon mode)
32392b75b0adSPeter Korsgaard
32402b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
32412b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
32422b75b0adSPeter Korsgaard		Sector and number of sectors to load kernel argument
32432b75b0adSPeter Korsgaard		parameters from when MMC is being used in raw mode
32442b75b0adSPeter Korsgaard		(for falcon mode)
32452b75b0adSPeter Korsgaard
324695579793STom Rini		CONFIG_SPL_FAT_SUPPORT
324795579793STom Rini		Support for fs/fat/libfat.o in SPL binary
324895579793STom Rini
324995579793STom Rini		CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME
325095579793STom Rini		Filename to read to load U-Boot when reading from FAT
325195579793STom Rini
32527ad2cc79SPeter Korsgaard		CONFIG_SPL_FAT_LOAD_KERNEL_NAME
32537ad2cc79SPeter Korsgaard		Filename to read to load kernel uImage when reading
32547ad2cc79SPeter Korsgaard		from FAT (for Falcon mode)
32557ad2cc79SPeter Korsgaard
32567ad2cc79SPeter Korsgaard		CONFIG_SPL_FAT_LOAD_ARGS_NAME
32577ad2cc79SPeter Korsgaard		Filename to read to load kernel argument parameters
32587ad2cc79SPeter Korsgaard		when reading from FAT (for Falcon mode)
32597ad2cc79SPeter Korsgaard
326006f60ae3SScott Wood		CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
326106f60ae3SScott Wood		Set this for NAND SPL on PPC mpc83xx targets, so that
326206f60ae3SScott Wood		start.S waits for the rest of the SPL to load before
326306f60ae3SScott Wood		continuing (the hardware starts execution after just
326406f60ae3SScott Wood		loading the first page rather than the full 4K).
326506f60ae3SScott Wood
32666f2f01b9SScott Wood		CONFIG_SPL_NAND_BASE
32676f2f01b9SScott Wood		Include nand_base.c in the SPL.  Requires
32686f2f01b9SScott Wood		CONFIG_SPL_NAND_DRIVERS.
32696f2f01b9SScott Wood
32706f2f01b9SScott Wood		CONFIG_SPL_NAND_DRIVERS
32716f2f01b9SScott Wood		SPL uses normal NAND drivers, not minimal drivers.
32726f2f01b9SScott Wood
32736f2f01b9SScott Wood		CONFIG_SPL_NAND_ECC
32746f2f01b9SScott Wood		Include standard software ECC in the SPL
32756f2f01b9SScott Wood
327695579793STom Rini		CONFIG_SPL_NAND_SIMPLE
32777d4b7955SScott Wood		Support for NAND boot using simple NAND drivers that
32787d4b7955SScott Wood		expose the cmd_ctrl() interface.
327995579793STom Rini
3280bb0dc108SYing Zhang		CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT
3281bb0dc108SYing Zhang		Set for the SPL on PPC mpc8xxx targets, support for
32825614e71bSYork Sun		drivers/ddr/fsl/libddr.o in SPL binary.
3283bb0dc108SYing Zhang
32847c8eea59SYing Zhang		CONFIG_SPL_COMMON_INIT_DDR
32857c8eea59SYing Zhang		Set for common ddr init with serial presence detect in
32867c8eea59SYing Zhang		SPL binary.
32877c8eea59SYing Zhang
328895579793STom Rini		CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
328995579793STom Rini		CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
329095579793STom Rini		CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
329195579793STom Rini		CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
329295579793STom Rini		CONFIG_SYS_NAND_ECCBYTES
329395579793STom Rini		Defines the size and behavior of the NAND that SPL uses
32947d4b7955SScott Wood		to read U-Boot
329595579793STom Rini
3296fbe76ae4SPrabhakar Kushwaha		CONFIG_SPL_NAND_BOOT
3297fbe76ae4SPrabhakar Kushwaha		Add support NAND boot
3298fbe76ae4SPrabhakar Kushwaha
329995579793STom Rini		CONFIG_SYS_NAND_U_BOOT_OFFS
33007d4b7955SScott Wood		Location in NAND to read U-Boot from
33017d4b7955SScott Wood
33027d4b7955SScott Wood		CONFIG_SYS_NAND_U_BOOT_DST
33037d4b7955SScott Wood		Location in memory to load U-Boot to
33047d4b7955SScott Wood
33057d4b7955SScott Wood		CONFIG_SYS_NAND_U_BOOT_SIZE
33067d4b7955SScott Wood		Size of image to load
330795579793STom Rini
330895579793STom Rini		CONFIG_SYS_NAND_U_BOOT_START
33097d4b7955SScott Wood		Entry point in loaded image to jump to
331095579793STom Rini
331195579793STom Rini		CONFIG_SYS_NAND_HW_ECC_OOBFIRST
331295579793STom Rini		Define this if you need to first read the OOB and then the
331395579793STom Rini		data. This is used for example on davinci plattforms.
331495579793STom Rini
331595579793STom Rini		CONFIG_SPL_OMAP3_ID_NAND
331695579793STom Rini		Support for an OMAP3-specific set of functions to return the
331795579793STom Rini		ID and MFR of the first attached NAND chip, if present.
331895579793STom Rini
33196a11cf48SDaniel Schwierzeck		CONFIG_SPL_SERIAL_SUPPORT
33206a11cf48SDaniel Schwierzeck		Support for drivers/serial/libserial.o in SPL binary
33216a11cf48SDaniel Schwierzeck
33226a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_FLASH_SUPPORT
33236a11cf48SDaniel Schwierzeck		Support for drivers/mtd/spi/libspi_flash.o in SPL binary
33246a11cf48SDaniel Schwierzeck
33256a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_SUPPORT
33266a11cf48SDaniel Schwierzeck		Support for drivers/spi/libspi.o in SPL binary
33276a11cf48SDaniel Schwierzeck
3328c57b953dSPavel Machek		CONFIG_SPL_RAM_DEVICE
3329c57b953dSPavel Machek		Support for running image already present in ram, in SPL binary
3330c57b953dSPavel Machek
33316a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBGENERIC_SUPPORT
33326a11cf48SDaniel Schwierzeck		Support for lib/libgeneric.o in SPL binary
33331372cce2SMarian Balakowicz
3334ba1bee43SYing Zhang		CONFIG_SPL_ENV_SUPPORT
3335ba1bee43SYing Zhang		Support for the environment operating in SPL binary
3336ba1bee43SYing Zhang
3337ba1bee43SYing Zhang		CONFIG_SPL_NET_SUPPORT
3338ba1bee43SYing Zhang		Support for the net/libnet.o in SPL binary.
3339ba1bee43SYing Zhang		It conflicts with SPL env from storage medium specified by
3340ba1bee43SYing Zhang		CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3341ba1bee43SYing Zhang
334274752baaSScott Wood		CONFIG_SPL_PAD_TO
33436113d3f2SBenoît Thébaudeau		Image offset to which the SPL should be padded before appending
33446113d3f2SBenoît Thébaudeau		the SPL payload. By default, this is defined as
33456113d3f2SBenoît Thébaudeau		CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
33466113d3f2SBenoît Thébaudeau		CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
33476113d3f2SBenoît Thébaudeau		payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
334874752baaSScott Wood
3349ca2fca22SScott Wood		CONFIG_SPL_TARGET
3350ca2fca22SScott Wood		Final target image containing SPL and payload.  Some SPLs
3351ca2fca22SScott Wood		use an arch-specific makefile fragment instead, for
3352ca2fca22SScott Wood		example if more than one image needs to be produced.
3353ca2fca22SScott Wood
335487ebee39SSimon Glass		CONFIG_FIT_SPL_PRINT
335587ebee39SSimon Glass		Printing information about a FIT image adds quite a bit of
335687ebee39SSimon Glass		code to SPL. So this is normally disabled in SPL. Use this
335787ebee39SSimon Glass		option to re-enable it. This will affect the output of the
335887ebee39SSimon Glass		bootm command when booting a FIT image.
335987ebee39SSimon Glass
33603aa29de0SYing Zhang- TPL framework
33613aa29de0SYing Zhang		CONFIG_TPL
33623aa29de0SYing Zhang		Enable building of TPL globally.
33633aa29de0SYing Zhang
33643aa29de0SYing Zhang		CONFIG_TPL_PAD_TO
33653aa29de0SYing Zhang		Image offset to which the TPL should be padded before appending
33663aa29de0SYing Zhang		the TPL payload. By default, this is defined as
33673aa29de0SYing Zhang		CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
33683aa29de0SYing Zhang		CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
33693aa29de0SYing Zhang		payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
33703aa29de0SYing Zhang
3371c609719bSwdenkModem Support:
3372c609719bSwdenk--------------
3373c609719bSwdenk
3374566e5cf4SWolfgang Denk[so far only for SMDK2400 boards]
3375c609719bSwdenk
337611ccc33fSMarcel Ziswiler- Modem support enable:
3377c609719bSwdenk		CONFIG_MODEM_SUPPORT
3378c609719bSwdenk
3379c609719bSwdenk- RTS/CTS Flow control enable:
3380c609719bSwdenk		CONFIG_HWFLOW
3381c609719bSwdenk
3382c609719bSwdenk- Modem debug support:
3383c609719bSwdenk		CONFIG_MODEM_SUPPORT_DEBUG
3384c609719bSwdenk
3385c609719bSwdenk		Enables debugging stuff (char screen[1024], dbg())
3386c609719bSwdenk		for modem support. Useful only with BDI2000.
3387c609719bSwdenk
3388a8c7c708Swdenk- Interrupt support (PPC):
3389a8c7c708Swdenk
3390a8c7c708Swdenk		There are common interrupt_init() and timer_interrupt()
3391a8c7c708Swdenk		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
339211ccc33fSMarcel Ziswiler		for CPU specific initialization. interrupt_init_cpu()
3393a8c7c708Swdenk		should set decrementer_count to appropriate value. If
339411ccc33fSMarcel Ziswiler		CPU resets decrementer automatically after interrupt
3395a8c7c708Swdenk		(ppc4xx) it should set decrementer_count to zero.
339611ccc33fSMarcel Ziswiler		timer_interrupt() calls timer_interrupt_cpu() for CPU
3397a8c7c708Swdenk		specific handling. If board has watchdog / status_led
3398a8c7c708Swdenk		/ other_activity_monitor it works automatically from
3399a8c7c708Swdenk		general timer_interrupt().
3400a8c7c708Swdenk
3401c609719bSwdenk- General:
3402c609719bSwdenk
3403c609719bSwdenk		In the target system modem support is enabled when a
3404c609719bSwdenk		specific key (key combination) is pressed during
3405c609719bSwdenk		power-on. Otherwise U-Boot will boot normally
340611ccc33fSMarcel Ziswiler		(autoboot). The key_pressed() function is called from
3407c609719bSwdenk		board_init(). Currently key_pressed() is a dummy
3408c609719bSwdenk		function, returning 1 and thus enabling modem
3409c609719bSwdenk		initialization.
3410c609719bSwdenk
3411c609719bSwdenk		If there are no modem init strings in the
3412c609719bSwdenk		environment, U-Boot proceed to autoboot; the
3413c609719bSwdenk		previous output (banner, info printfs) will be
341411ccc33fSMarcel Ziswiler		suppressed, though.
3415c609719bSwdenk
3416c609719bSwdenk		See also: doc/README.Modem
3417c609719bSwdenk
34189660e442SHelmut RaigerBoard initialization settings:
34199660e442SHelmut Raiger------------------------------
34209660e442SHelmut Raiger
34219660e442SHelmut RaigerDuring Initialization u-boot calls a number of board specific functions
34229660e442SHelmut Raigerto allow the preparation of board specific prerequisites, e.g. pin setup
34239660e442SHelmut Raigerbefore drivers are initialized. To enable these callbacks the
34249660e442SHelmut Raigerfollowing configuration macros have to be defined. Currently this is
34259660e442SHelmut Raigerarchitecture specific, so please check arch/your_architecture/lib/board.c
34269660e442SHelmut Raigertypically in board_init_f() and board_init_r().
34279660e442SHelmut Raiger
34289660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
34299660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
34309660e442SHelmut Raiger- CONFIG_BOARD_LATE_INIT: Call board_late_init()
34319660e442SHelmut Raiger- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
3432c609719bSwdenk
3433c609719bSwdenkConfiguration Settings:
3434c609719bSwdenk-----------------------
3435c609719bSwdenk
34366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
3437c609719bSwdenk		undefine this when you're short of memory.
3438c609719bSwdenk
34392fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
34402fb2604dSPeter Tyser		width of the commands listed in the 'help' command output.
34412fb2604dSPeter Tyser
34426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT:	This is what U-Boot prints on the console to
3443c609719bSwdenk		prompt for user input.
3444c609719bSwdenk
34456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE:	Buffer size for input from the Console
3446c609719bSwdenk
34476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE:	Buffer size for Console output
3448c609719bSwdenk
34496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS:	max. Number of arguments accepted for monitor commands
3450c609719bSwdenk
34516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
3452c609719bSwdenk		the application (usually a Linux kernel) when it is
3453c609719bSwdenk		booted
3454c609719bSwdenk
34556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE:
3456c609719bSwdenk		List of legal baudrate settings for this board.
3457c609719bSwdenk
34586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_INFO_QUIET
3459c609719bSwdenk		Suppress display of console information at boot.
3460c609719bSwdenk
34616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_IS_IN_ENV
3462c609719bSwdenk		If the board specific function
3463c609719bSwdenk			extern int overwrite_console (void);
3464c609719bSwdenk		returns 1, the stdin, stderr and stdout are switched to the
3465c609719bSwdenk		serial port, else the settings in the environment are used.
3466c609719bSwdenk
34676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
3468c609719bSwdenk		Enable the call to overwrite_console().
3469c609719bSwdenk
34706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
3471c609719bSwdenk		Enable overwrite of previous console environment settings.
3472c609719bSwdenk
34736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
3474c609719bSwdenk		Begin and End addresses of the area used by the
3475c609719bSwdenk		simple memory test.
3476c609719bSwdenk
34776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST:
3478c609719bSwdenk		Enable an alternate, more extensive memory test.
3479c609719bSwdenk
34806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH:
34815f535fe1Swdenk		Scratch address used by the alternate memory test
34825f535fe1Swdenk		You only need to set this if address zero isn't writeable
34835f535fe1Swdenk
34846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
34856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
348614f73ca6SStefan Roese		this specified memory area will get subtracted from the top
348711ccc33fSMarcel Ziswiler		(end) of RAM and won't get "touched" at all by U-Boot. By
348814f73ca6SStefan Roese		fixing up gd->ram_size the Linux kernel should gets passed
348914f73ca6SStefan Roese		the now "corrected" memory size and won't touch it either.
349014f73ca6SStefan Roese		This should work for arch/ppc and arch/powerpc. Only Linux
34915e12e75dSStefan Roese		board ports in arch/powerpc with bootwrapper support that
349214f73ca6SStefan Roese		recalculate the memory size from the SDRAM controller setup
34935e12e75dSStefan Roese		will have to get fixed in Linux additionally.
349414f73ca6SStefan Roese
349514f73ca6SStefan Roese		This option can be used as a workaround for the 440EPx/GRx
349614f73ca6SStefan Roese		CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
349714f73ca6SStefan Roese		be touched.
349814f73ca6SStefan Roese
349914f73ca6SStefan Roese		WARNING: Please make sure that this value is a multiple of
350014f73ca6SStefan Roese		the Linux page size (normally 4k). If this is not the case,
350114f73ca6SStefan Roese		then the end address of the Linux memory will be located at a
350214f73ca6SStefan Roese		non page size aligned address and this could cause major
350314f73ca6SStefan Roese		problems.
350414f73ca6SStefan Roese
35056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE:
3506c609719bSwdenk		Enable temporary baudrate change while serial download
3507c609719bSwdenk
35086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE:
3509c609719bSwdenk		Physical start address of SDRAM. _Must_ be 0 here.
3510c609719bSwdenk
35116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MBIO_BASE:
3512c609719bSwdenk		Physical start address of Motherboard I/O (if using a
3513c609719bSwdenk		Cogent motherboard)
3514c609719bSwdenk
35156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE:
3516c609719bSwdenk		Physical start address of Flash memory.
3517c609719bSwdenk
35186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE:
3519c609719bSwdenk		Physical start address of boot monitor code (set by
3520c609719bSwdenk		make config files to be same as the text base address
352114d0a02aSWolfgang Denk		(CONFIG_SYS_TEXT_BASE) used when linking) - same as
35226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FLASH_BASE when booting from flash.
3523c609719bSwdenk
35246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN:
35253b57fe0aSwdenk		Size of memory reserved for monitor code, used to
35263b57fe0aSwdenk		determine _at_compile_time_ (!) if the environment is
35273b57fe0aSwdenk		embedded within the U-Boot image, or in a separate
35283b57fe0aSwdenk		flash sector.
3529c609719bSwdenk
35306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN:
3531c609719bSwdenk		Size of DRAM reserved for malloc() use.
3532c609719bSwdenk
35336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN:
353415940c9aSStefan Roese		Normally compressed uImages are limited to an
353515940c9aSStefan Roese		uncompressed size of 8 MBytes. If this is not enough,
35366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		you can define CONFIG_SYS_BOOTM_LEN in your board config file
353715940c9aSStefan Roese		to adjust this setting to your needs.
3538c609719bSwdenk
35396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ:
3540c609719bSwdenk		Maximum size of memory mapped by the startup code of
3541c609719bSwdenk		the Linux kernel; all data that must be processed by
35427d721e34SBartlomiej Sieka		the Linux kernel (bd_info, boot arguments, FDT blob if
35437d721e34SBartlomiej Sieka		used) must be put below this limit, unless "bootm_low"
35441bce2aebSRobert P. J. Day		environment variable is defined and non-zero. In such case
35457d721e34SBartlomiej Sieka		all data for the Linux kernel must be between "bootm_low"
3546c3624e6eSGrant Likely		and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.	 The environment
3547c3624e6eSGrant Likely		variable "bootm_mapsize" will override the value of
3548c3624e6eSGrant Likely		CONFIG_SYS_BOOTMAPSZ.  If CONFIG_SYS_BOOTMAPSZ is undefined,
3549c3624e6eSGrant Likely		then the value in "bootm_size" will be used instead.
3550c609719bSwdenk
3551fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3552fca43cc8SJohn Rigby		Enable initrd_high functionality.  If defined then the
3553fca43cc8SJohn Rigby		initrd_high feature is enabled and the bootm ramdisk subcommand
3554fca43cc8SJohn Rigby		is enabled.
3555fca43cc8SJohn Rigby
3556fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_CMDLINE:
3557fca43cc8SJohn Rigby		Enables allocating and saving kernel cmdline in space between
3558fca43cc8SJohn Rigby		"bootm_low" and "bootm_low" + BOOTMAPSZ.
3559fca43cc8SJohn Rigby
3560fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_KBD:
3561fca43cc8SJohn Rigby		Enables allocating and saving a kernel copy of the bd_info in
3562fca43cc8SJohn Rigby		space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3563fca43cc8SJohn Rigby
35646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS:
3565c609719bSwdenk		Max number of Flash memory banks
3566c609719bSwdenk
35676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT:
3568c609719bSwdenk		Max number of sectors on a Flash chip
3569c609719bSwdenk
35706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT:
3571c609719bSwdenk		Timeout for Flash erase operations (in ms)
3572c609719bSwdenk
35736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT:
3574c609719bSwdenk		Timeout for Flash write operations (in ms)
3575c609719bSwdenk
35766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT
35778564acf9Swdenk		Timeout for Flash set sector lock bit operation (in ms)
35788564acf9Swdenk
35796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT
35808564acf9Swdenk		Timeout for Flash clear lock bits operation (in ms)
35818564acf9Swdenk
35826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION
35838564acf9Swdenk		If defined, hardware flash sectors protection is used
35848564acf9Swdenk		instead of U-Boot software protection.
35858564acf9Swdenk
35866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP:
3587c609719bSwdenk
3588c609719bSwdenk		Enable TFTP transfers directly to flash memory;
3589c609719bSwdenk		without this option such a download has to be
3590c609719bSwdenk		performed in two steps: (1) download to RAM, and (2)
3591c609719bSwdenk		copy from RAM to flash.
3592c609719bSwdenk
3593c609719bSwdenk		The two-step approach is usually more reliable, since
3594c609719bSwdenk		you can check if the download worked before you erase
359511ccc33fSMarcel Ziswiler		the flash, but in some situations (when system RAM is
359611ccc33fSMarcel Ziswiler		too limited to allow for a temporary copy of the
3597c609719bSwdenk		downloaded image) this option may be very useful.
3598c609719bSwdenk
35996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI:
3600c609719bSwdenk		Define if the flash driver uses extra elements in the
36015653fc33Swdenk		common flash structure for storing flash geometry.
36025653fc33Swdenk
360300b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER
36045653fc33Swdenk		This option also enables the building of the cfi_flash driver
36055653fc33Swdenk		in the drivers directory
360653cf9435Sstroese
360791809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD
360891809ed5SPiotr Ziecik		This option enables the building of the cfi_mtd driver
360991809ed5SPiotr Ziecik		in the drivers directory. The driver exports CFI flash
361091809ed5SPiotr Ziecik		to the MTD layer.
361191809ed5SPiotr Ziecik
36126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
361396ef831fSGuennadi Liakhovetski		Use buffered writes to flash.
361496ef831fSGuennadi Liakhovetski
361596ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N
361696ef831fSGuennadi Liakhovetski		s29ws-n MirrorBit flash has non-standard addresses for buffered
361796ef831fSGuennadi Liakhovetski		write commands.
361896ef831fSGuennadi Liakhovetski
36196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST
36205568e613SStefan Roese		If this option is defined, the common CFI flash doesn't
36215568e613SStefan Roese		print it's warning upon not recognized FLASH banks. This
36225568e613SStefan Roese		is useful, if some of the configured banks are only
36235568e613SStefan Roese		optionally available.
36245568e613SStefan Roese
36259a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS
36269a042e9cSJerry Van Baren		If defined (must be an integer), print out countdown
36279a042e9cSJerry Van Baren		digits and dots.  Recommended value: 45 (9..1) for 80
36289a042e9cSJerry Van Baren		column displays, 15 (3..1) for 40 column displays.
36299a042e9cSJerry Van Baren
3630352ef3f1SStefan Roese- CONFIG_FLASH_VERIFY
3631352ef3f1SStefan Roese		If defined, the content of the flash (destination) is compared
3632352ef3f1SStefan Roese		against the source after the write operation. An error message
3633352ef3f1SStefan Roese		will be printed when the contents are not identical.
3634352ef3f1SStefan Roese		Please note that this option is useless in nearly all cases,
3635352ef3f1SStefan Roese		since such flash programming errors usually are detected earlier
3636352ef3f1SStefan Roese		while unprotecting/erasing/programming. Please only enable
3637352ef3f1SStefan Roese		this option if you really know what you are doing.
3638352ef3f1SStefan Roese
36396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER:
364011ccc33fSMarcel Ziswiler		Defines the number of Ethernet receive buffers. On some
364111ccc33fSMarcel Ziswiler		Ethernet controllers it is recommended to set this value
364253cf9435Sstroese		to 8 or even higher (EEPRO100 or 405 EMAC), since all
364353cf9435Sstroese		buffers can be full shortly after enabling the interface
364411ccc33fSMarcel Ziswiler		on high Ethernet traffic.
364553cf9435Sstroese		Defaults to 4 if not defined.
3646c609719bSwdenk
3647ea882bafSWolfgang Denk- CONFIG_ENV_MAX_ENTRIES
3648ea882bafSWolfgang Denk
3649ea882bafSWolfgang Denk	Maximum number of entries in the hash table that is used
3650ea882bafSWolfgang Denk	internally to store the environment settings. The default
3651ea882bafSWolfgang Denk	setting is supposed to be generous and should work in most
3652ea882bafSWolfgang Denk	cases. This setting can be used to tune behaviour; see
3653ea882bafSWolfgang Denk	lib/hashtable.c for details.
3654ea882bafSWolfgang Denk
36552598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_DEFAULT
36562598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_STATIC
36571bce2aebSRobert P. J. Day	Enable validation of the values given to environment variables when
36582598090bSJoe Hershberger	calling env set.  Variables can be restricted to only decimal,
36592598090bSJoe Hershberger	hexadecimal, or boolean.  If CONFIG_CMD_NET is also defined,
36602598090bSJoe Hershberger	the variables can also be restricted to IP address or MAC address.
36612598090bSJoe Hershberger
36622598090bSJoe Hershberger	The format of the list is:
36632598090bSJoe Hershberger		type_attribute = [s|d|x|b|i|m]
3664267541f7SJoe Hershberger		access_atribute = [a|r|o|c]
3665267541f7SJoe Hershberger		attributes = type_attribute[access_atribute]
36662598090bSJoe Hershberger		entry = variable_name[:attributes]
36672598090bSJoe Hershberger		list = entry[,list]
36682598090bSJoe Hershberger
36692598090bSJoe Hershberger	The type attributes are:
36702598090bSJoe Hershberger		s - String (default)
36712598090bSJoe Hershberger		d - Decimal
36722598090bSJoe Hershberger		x - Hexadecimal
36732598090bSJoe Hershberger		b - Boolean ([1yYtT|0nNfF])
36742598090bSJoe Hershberger		i - IP address
36752598090bSJoe Hershberger		m - MAC address
36762598090bSJoe Hershberger
3677267541f7SJoe Hershberger	The access attributes are:
3678267541f7SJoe Hershberger		a - Any (default)
3679267541f7SJoe Hershberger		r - Read-only
3680267541f7SJoe Hershberger		o - Write-once
3681267541f7SJoe Hershberger		c - Change-default
3682267541f7SJoe Hershberger
36832598090bSJoe Hershberger	- CONFIG_ENV_FLAGS_LIST_DEFAULT
36842598090bSJoe Hershberger		Define this to a list (string) to define the ".flags"
36852598090bSJoe Hershberger		envirnoment variable in the default or embedded environment.
36862598090bSJoe Hershberger
36872598090bSJoe Hershberger	- CONFIG_ENV_FLAGS_LIST_STATIC
36882598090bSJoe Hershberger		Define this to a list (string) to define validation that
36892598090bSJoe Hershberger		should be done if an entry is not found in the ".flags"
36902598090bSJoe Hershberger		environment variable.  To override a setting in the static
36912598090bSJoe Hershberger		list, simply add an entry for the same variable name to the
36922598090bSJoe Hershberger		".flags" variable.
36932598090bSJoe Hershberger
3694267541f7SJoe Hershberger- CONFIG_ENV_ACCESS_IGNORE_FORCE
3695267541f7SJoe Hershberger	If defined, don't allow the -f switch to env set override variable
3696267541f7SJoe Hershberger	access flags.
3697267541f7SJoe Hershberger
36985c1a7ea6SSimon Glass- CONFIG_SYS_GENERIC_BOARD
36995c1a7ea6SSimon Glass	This selects the architecture-generic board system instead of the
37005c1a7ea6SSimon Glass	architecture-specific board files. It is intended to move boards
37015c1a7ea6SSimon Glass	to this new framework over time. Defining this will disable the
37025c1a7ea6SSimon Glass	arch/foo/lib/board.c file and use common/board_f.c and
37035c1a7ea6SSimon Glass	common/board_r.c instead. To use this option your architecture
37045c1a7ea6SSimon Glass	must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in
37055c1a7ea6SSimon Glass	its config.mk file). If you find problems enabling this option on
37065c1a7ea6SSimon Glass	your board please report the problem and send patches!
37075c1a7ea6SSimon Glass
3708632efa74SSimon Glass- CONFIG_SYS_SYM_OFFSETS
3709632efa74SSimon Glass	This is set by architectures that use offsets for link symbols
3710632efa74SSimon Glass	instead of absolute values. So bss_start is obtained using an
3711632efa74SSimon Glass	offset _bss_start_ofs from CONFIG_SYS_TEXT_BASE, rather than
3712632efa74SSimon Glass	directly. You should not need to touch this setting.
3713632efa74SSimon Glass
37140b1b60c7SLokesh Vutla- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
37150b1b60c7SLokesh Vutla	This is set by OMAP boards for the max time that reset should
37160b1b60c7SLokesh Vutla	be asserted. See doc/README.omap-reset-time for details on how
37170b1b60c7SLokesh Vutla	the value can be calulated on a given board.
3718632efa74SSimon Glass
3719c609719bSwdenkThe following definitions that deal with the placement and management
3720c609719bSwdenkof environment data (variable area); in general, we support the
3721c609719bSwdenkfollowing configurations:
3722c609719bSwdenk
3723c3eb3fe4SMike Frysinger- CONFIG_BUILD_ENVCRC:
3724c3eb3fe4SMike Frysinger
3725c3eb3fe4SMike Frysinger	Builds up envcrc with the target environment so that external utils
3726c3eb3fe4SMike Frysinger	may easily extract it and embed it in final U-Boot images.
3727c3eb3fe4SMike Frysinger
37285a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH:
3729c609719bSwdenk
3730c609719bSwdenk	Define this if the environment is in flash memory.
3731c609719bSwdenk
3732c609719bSwdenk	a) The environment occupies one whole flash sector, which is
3733c609719bSwdenk	   "embedded" in the text segment with the U-Boot code. This
3734c609719bSwdenk	   happens usually with "bottom boot sector" or "top boot
3735c609719bSwdenk	   sector" type flash chips, which have several smaller
3736c609719bSwdenk	   sectors at the start or the end. For instance, such a
3737c609719bSwdenk	   layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3738c609719bSwdenk	   such a case you would place the environment in one of the
3739c609719bSwdenk	   4 kB sectors - with U-Boot code before and after it. With
3740c609719bSwdenk	   "top boot sector" type flash chips, you would put the
3741c609719bSwdenk	   environment in one of the last sectors, leaving a gap
3742c609719bSwdenk	   between U-Boot and the environment.
3743c609719bSwdenk
37440e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
3745c609719bSwdenk
3746c609719bSwdenk	   Offset of environment data (variable area) to the
3747c609719bSwdenk	   beginning of flash memory; for instance, with bottom boot
3748c609719bSwdenk	   type flash chips the second sector can be used: the offset
3749c609719bSwdenk	   for this sector is given here.
3750c609719bSwdenk
37516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
3752c609719bSwdenk
37530e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
3754c609719bSwdenk
3755c609719bSwdenk	   This is just another way to specify the start address of
3756c609719bSwdenk	   the flash sector containing the environment (instead of
37570e8d1586SJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET).
3758c609719bSwdenk
37590e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SECT_SIZE:
3760c609719bSwdenk
3761c609719bSwdenk	   Size of the sector containing the environment.
3762c609719bSwdenk
3763c609719bSwdenk
3764c609719bSwdenk	b) Sometimes flash chips have few, equal sized, BIG sectors.
3765c609719bSwdenk	   In such a case you don't want to spend a whole sector for
3766c609719bSwdenk	   the environment.
3767c609719bSwdenk
37680e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3769c609719bSwdenk
37705a1aceb0SJean-Christophe PLAGNIOL-VILLARD	   If you use this in combination with CONFIG_ENV_IS_IN_FLASH
37710e8d1586SJean-Christophe PLAGNIOL-VILLARD	   and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
3772c609719bSwdenk	   of this flash sector for the environment. This saves
3773c609719bSwdenk	   memory for the RAM copy of the environment.
3774c609719bSwdenk
3775c609719bSwdenk	   It may also save flash memory if you decide to use this
3776c609719bSwdenk	   when your environment is "embedded" within U-Boot code,
3777c609719bSwdenk	   since then the remainder of the flash sector could be used
3778c609719bSwdenk	   for U-Boot code. It should be pointed out that this is
3779c609719bSwdenk	   STRONGLY DISCOURAGED from a robustness point of view:
3780c609719bSwdenk	   updating the environment in flash makes it always
3781c609719bSwdenk	   necessary to erase the WHOLE sector. If something goes
3782c609719bSwdenk	   wrong before the contents has been restored from a copy in
3783c609719bSwdenk	   RAM, your target system will be dead.
3784c609719bSwdenk
37850e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR_REDUND
37860e8d1586SJean-Christophe PLAGNIOL-VILLARD	  CONFIG_ENV_SIZE_REDUND
3787c609719bSwdenk
3788c609719bSwdenk	   These settings describe a second storage area used to hold
378911ccc33fSMarcel Ziswiler	   a redundant copy of the environment data, so that there is
37903e38691eSwdenk	   a valid backup copy in case there is a power failure during
3791c609719bSwdenk	   a "saveenv" operation.
3792c609719bSwdenk
3793c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the
3794c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds*
3795c609719bSwdenkaccordingly!
3796c609719bSwdenk
3797c609719bSwdenk
37989314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM:
3799c609719bSwdenk
3800c609719bSwdenk	Define this if you have some non-volatile memory device
3801c609719bSwdenk	(NVRAM, battery buffered SRAM) which you want to use for the
3802c609719bSwdenk	environment.
3803c609719bSwdenk
38040e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
38050e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3806c609719bSwdenk
380711ccc33fSMarcel Ziswiler	  These two #defines are used to determine the memory area you
3808c609719bSwdenk	  want to use for environment. It is assumed that this memory
3809c609719bSwdenk	  can just be read and written to, without any special
3810c609719bSwdenk	  provision.
3811c609719bSwdenk
3812c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early
3813c609719bSwdenkin U-Boot initalization (when we try to get the setting of for the
381411ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or
3815c609719bSwdenkU-Boot will hang.
3816c609719bSwdenk
3817c609719bSwdenkPlease note that even with NVRAM we still use a copy of the
3818c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to
3819c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv"
3820c609719bSwdenkto save the current settings.
3821c609719bSwdenk
3822c609719bSwdenk
3823bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM:
3824c609719bSwdenk
3825c609719bSwdenk	Use this if you have an EEPROM or similar serial access
3826c609719bSwdenk	device and a driver for it.
3827c609719bSwdenk
38280e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
38290e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3830c609719bSwdenk
3831c609719bSwdenk	  These two #defines specify the offset and size of the
3832c609719bSwdenk	  environment area within the total memory of your EEPROM.
3833c609719bSwdenk
38346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR:
3835c609719bSwdenk	  If defined, specified the chip address of the EEPROM device.
3836c609719bSwdenk	  The default address is zero.
3837c609719bSwdenk
38386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
3839c609719bSwdenk	  If defined, the number of bits used to address bytes in a
3840c609719bSwdenk	  single page in the EEPROM device.  A 64 byte page, for example
3841c609719bSwdenk	  would require six bits.
3842c609719bSwdenk
38436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
3844c609719bSwdenk	  If defined, the number of milliseconds to delay between
3845c609719bSwdenk	  page writes.	The default is zero milliseconds.
3846c609719bSwdenk
38476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
3848c609719bSwdenk	  The length in bytes of the EEPROM memory array address.  Note
3849c609719bSwdenk	  that this is NOT the chip address length!
3850c609719bSwdenk
38516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
38525cf91d6bSwdenk	  EEPROM chips that implement "address overflow" are ones
38535cf91d6bSwdenk	  like Catalyst 24WC04/08/16 which has 9/10/11 bits of
38545cf91d6bSwdenk	  address and the extra bits end up in the "chip address" bit
38555cf91d6bSwdenk	  slots. This makes a 24WC08 (1Kbyte) chip look like four 256
38565cf91d6bSwdenk	  byte chips.
38575cf91d6bSwdenk
38585cf91d6bSwdenk	  Note that we consider the length of the address field to
38595cf91d6bSwdenk	  still be one byte because the extra address bits are hidden
38605cf91d6bSwdenk	  in the chip address.
38615cf91d6bSwdenk
38626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_SIZE:
3863c609719bSwdenk	  The size in bytes of the EEPROM device.
3864c609719bSwdenk
3865548738b4SHeiko Schocher	- CONFIG_ENV_EEPROM_IS_ON_I2C
3866548738b4SHeiko Schocher	  define this, if you have I2C and SPI activated, and your
3867548738b4SHeiko Schocher	  EEPROM, which holds the environment, is on the I2C bus.
3868548738b4SHeiko Schocher
3869548738b4SHeiko Schocher	- CONFIG_I2C_ENV_EEPROM_BUS
3870548738b4SHeiko Schocher	  if you have an Environment on an EEPROM reached over
3871548738b4SHeiko Schocher	  I2C muxes, you can define here, how to reach this
3872548738b4SHeiko Schocher	  EEPROM. For example:
3873548738b4SHeiko Schocher
3874ea818dbbSHeiko Schocher	  #define CONFIG_I2C_ENV_EEPROM_BUS	  1
3875548738b4SHeiko Schocher
3876548738b4SHeiko Schocher	  EEPROM which holds the environment, is reached over
3877548738b4SHeiko Schocher	  a pca9547 i2c mux with address 0x70, channel 3.
3878c609719bSwdenk
3879057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH:
38805779d8d9Swdenk
38815779d8d9Swdenk	Define this if you have a DataFlash memory device which you
38825779d8d9Swdenk	want to use for the environment.
38835779d8d9Swdenk
38840e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
38850e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
38860e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
38875779d8d9Swdenk
38885779d8d9Swdenk	  These three #defines specify the offset and size of the
38895779d8d9Swdenk	  environment area within the total memory of your DataFlash placed
38905779d8d9Swdenk	  at the specified address.
38915779d8d9Swdenk
38920a85a9e7SLiu Gang- CONFIG_ENV_IS_IN_REMOTE:
38930a85a9e7SLiu Gang
38940a85a9e7SLiu Gang	Define this if you have a remote memory space which you
38950a85a9e7SLiu Gang	want to use for the local device's environment.
38960a85a9e7SLiu Gang
38970a85a9e7SLiu Gang	- CONFIG_ENV_ADDR:
38980a85a9e7SLiu Gang	- CONFIG_ENV_SIZE:
38990a85a9e7SLiu Gang
39000a85a9e7SLiu Gang	  These two #defines specify the address and size of the
39010a85a9e7SLiu Gang	  environment area within the remote memory space. The
39020a85a9e7SLiu Gang	  local device can get the environment from remote memory
3903fc54c7faSLiu Gang	  space by SRIO or PCIE links.
39040a85a9e7SLiu Gang
39050a85a9e7SLiu GangBE CAREFUL! For some special cases, the local device can not use
39060a85a9e7SLiu Gang"saveenv" command. For example, the local device will get the
3907fc54c7faSLiu Gangenvironment stored in a remote NOR flash by SRIO or PCIE link,
3908fc54c7faSLiu Gangbut it can not erase, write this NOR flash by SRIO or PCIE interface.
39090a85a9e7SLiu Gang
391051bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND:
391113a5695bSwdenk
391213a5695bSwdenk	Define this if you have a NAND device which you want to use
391313a5695bSwdenk	for the environment.
391413a5695bSwdenk
39150e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
39160e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
391713a5695bSwdenk
391813a5695bSwdenk	  These two #defines specify the offset and size of the environment
3919fdd813deSScott Wood	  area within the first NAND device.  CONFIG_ENV_OFFSET must be
3920fdd813deSScott Wood	  aligned to an erase block boundary.
39215779d8d9Swdenk
3922fdd813deSScott Wood	- CONFIG_ENV_OFFSET_REDUND (optional):
3923e443c944SMarkus Klotzbuecher
39240e8d1586SJean-Christophe PLAGNIOL-VILLARD	  This setting describes a second storage area of CONFIG_ENV_SIZE
3925fdd813deSScott Wood	  size used to hold a redundant copy of the environment data, so
3926fdd813deSScott Wood	  that there is a valid backup copy in case there is a power failure
3927fdd813deSScott Wood	  during a "saveenv" operation.	 CONFIG_ENV_OFFSET_RENDUND must be
3928fdd813deSScott Wood	  aligned to an erase block boundary.
3929e443c944SMarkus Klotzbuecher
3930fdd813deSScott Wood	- CONFIG_ENV_RANGE (optional):
3931fdd813deSScott Wood
3932fdd813deSScott Wood	  Specifies the length of the region in which the environment
3933fdd813deSScott Wood	  can be written.  This should be a multiple of the NAND device's
3934fdd813deSScott Wood	  block size.  Specifying a range with more erase blocks than
3935fdd813deSScott Wood	  are needed to hold CONFIG_ENV_SIZE allows bad blocks within
3936fdd813deSScott Wood	  the range to be avoided.
3937fdd813deSScott Wood
3938fdd813deSScott Wood	- CONFIG_ENV_OFFSET_OOB (optional):
3939fdd813deSScott Wood
3940fdd813deSScott Wood	  Enables support for dynamically retrieving the offset of the
3941fdd813deSScott Wood	  environment from block zero's out-of-band data.  The
3942fdd813deSScott Wood	  "nand env.oob" command can be used to record this offset.
3943fdd813deSScott Wood	  Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
3944fdd813deSScott Wood	  using CONFIG_ENV_OFFSET_OOB.
3945e443c944SMarkus Klotzbuecher
3946b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST
3947b74ab737SGuennadi Liakhovetski
3948b74ab737SGuennadi Liakhovetski	Defines address in RAM to which the nand_spl code should copy the
3949b74ab737SGuennadi Liakhovetski	environment. If redundant environment is used, it will be copied to
3950b74ab737SGuennadi Liakhovetski	CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3951b74ab737SGuennadi Liakhovetski
39522b74433fSJoe Hershberger- CONFIG_ENV_IS_IN_UBI:
39532b74433fSJoe Hershberger
39542b74433fSJoe Hershberger	Define this if you have an UBI volume that you want to use for the
39552b74433fSJoe Hershberger	environment.  This has the benefit of wear-leveling the environment
39562b74433fSJoe Hershberger	accesses, which is important on NAND.
39572b74433fSJoe Hershberger
39582b74433fSJoe Hershberger	- CONFIG_ENV_UBI_PART:
39592b74433fSJoe Hershberger
39602b74433fSJoe Hershberger	  Define this to a string that is the mtd partition containing the UBI.
39612b74433fSJoe Hershberger
39622b74433fSJoe Hershberger	- CONFIG_ENV_UBI_VOLUME:
39632b74433fSJoe Hershberger
39642b74433fSJoe Hershberger	  Define this to the name of the volume that you want to store the
39652b74433fSJoe Hershberger	  environment in.
39662b74433fSJoe Hershberger
3967785881f7SJoe Hershberger	- CONFIG_ENV_UBI_VOLUME_REDUND:
3968785881f7SJoe Hershberger
3969785881f7SJoe Hershberger	  Define this to the name of another volume to store a second copy of
3970785881f7SJoe Hershberger	  the environment in.  This will enable redundant environments in UBI.
3971785881f7SJoe Hershberger	  It is assumed that both volumes are in the same MTD partition.
3972785881f7SJoe Hershberger
39732b74433fSJoe Hershberger	- CONFIG_UBI_SILENCE_MSG
39742b74433fSJoe Hershberger	- CONFIG_UBIFS_SILENCE_MSG
39752b74433fSJoe Hershberger
39762b74433fSJoe Hershberger	  You will probably want to define these to avoid a really noisy system
39772b74433fSJoe Hershberger	  when storing the env in UBI.
39782b74433fSJoe Hershberger
397906e4ae5fSStephen Warren- CONFIG_ENV_IS_IN_MMC:
398006e4ae5fSStephen Warren
398106e4ae5fSStephen Warren	Define this if you have an MMC device which you want to use for the
398206e4ae5fSStephen Warren	environment.
398306e4ae5fSStephen Warren
398406e4ae5fSStephen Warren	- CONFIG_SYS_MMC_ENV_DEV:
398506e4ae5fSStephen Warren
398606e4ae5fSStephen Warren	  Specifies which MMC device the environment is stored in.
398706e4ae5fSStephen Warren
398806e4ae5fSStephen Warren	- CONFIG_SYS_MMC_ENV_PART (optional):
398906e4ae5fSStephen Warren
399006e4ae5fSStephen Warren	  Specifies which MMC partition the environment is stored in. If not
399106e4ae5fSStephen Warren	  set, defaults to partition 0, the user area. Common values might be
399206e4ae5fSStephen Warren	  1 (first MMC boot partition), 2 (second MMC boot partition).
399306e4ae5fSStephen Warren
399406e4ae5fSStephen Warren	- CONFIG_ENV_OFFSET:
399506e4ae5fSStephen Warren	- CONFIG_ENV_SIZE:
399606e4ae5fSStephen Warren
399706e4ae5fSStephen Warren	  These two #defines specify the offset and size of the environment
399806e4ae5fSStephen Warren	  area within the specified MMC device.
399906e4ae5fSStephen Warren
40005c088ee8SStephen Warren	  If offset is positive (the usual case), it is treated as relative to
40015c088ee8SStephen Warren	  the start of the MMC partition. If offset is negative, it is treated
40025c088ee8SStephen Warren	  as relative to the end of the MMC partition. This can be useful if
40035c088ee8SStephen Warren	  your board may be fitted with different MMC devices, which have
40045c088ee8SStephen Warren	  different sizes for the MMC partitions, and you always want the
40055c088ee8SStephen Warren	  environment placed at the very end of the partition, to leave the
40065c088ee8SStephen Warren	  maximum possible space before it, to store other data.
40075c088ee8SStephen Warren
400806e4ae5fSStephen Warren	  These two values are in units of bytes, but must be aligned to an
400906e4ae5fSStephen Warren	  MMC sector boundary.
401006e4ae5fSStephen Warren
401106e4ae5fSStephen Warren	- CONFIG_ENV_OFFSET_REDUND (optional):
401206e4ae5fSStephen Warren
401306e4ae5fSStephen Warren	  Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
401406e4ae5fSStephen Warren	  hold a redundant copy of the environment data. This provides a
401506e4ae5fSStephen Warren	  valid backup copy in case the other copy is corrupted, e.g. due
401606e4ae5fSStephen Warren	  to a power failure during a "saveenv" operation.
401706e4ae5fSStephen Warren
40185c088ee8SStephen Warren	  This value may also be positive or negative; this is handled in the
40195c088ee8SStephen Warren	  same way as CONFIG_ENV_OFFSET.
40205c088ee8SStephen Warren
402106e4ae5fSStephen Warren	  This value is also in units of bytes, but must also be aligned to
402206e4ae5fSStephen Warren	  an MMC sector boundary.
402306e4ae5fSStephen Warren
402406e4ae5fSStephen Warren	- CONFIG_ENV_SIZE_REDUND (optional):
402506e4ae5fSStephen Warren
402606e4ae5fSStephen Warren	  This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
402706e4ae5fSStephen Warren	  set. If this value is set, it must be set to the same value as
402806e4ae5fSStephen Warren	  CONFIG_ENV_SIZE.
402906e4ae5fSStephen Warren
40306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET
4031c609719bSwdenk
4032c609719bSwdenk	Defines offset to the initial SPI buffer area in DPRAM. The
4033c609719bSwdenk	area is used at an early stage (ROM part) if the environment
4034c609719bSwdenk	is configured to reside in the SPI EEPROM: We need a 520 byte
4035c609719bSwdenk	scratch DPRAM area. It is used between the two initialization
4036c609719bSwdenk	calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4037c609719bSwdenk	to be a good choice since it makes it far enough from the
4038c609719bSwdenk	start of the data area as well as from the stack pointer.
4039c609719bSwdenk
4040e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor
4041c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been
4042cdb74977SWolfgang Denkcreated; also, when using EEPROM you will have to use getenv_f()
4043c609719bSwdenkuntil then to read environment variables.
4044c609719bSwdenk
404585ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor
404685ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working
404785ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is
404885ec0bccSwdenknecessary, because the first environment variable we need is the
404985ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't
405085ec0bccSwdenkhave any device yet where we could complain.]
4051c609719bSwdenk
4052c609719bSwdenkNote: once the monitor has been relocated, then it will complain if
4053c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you
405485ec0bccSwdenkuse the "saveenv" command to store a valid environment.
4055c609719bSwdenk
40566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
4057fc3e2165Swdenk		Echo the inverted Ethernet link state to the fault LED.
4058fc3e2165Swdenk
40596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
4060fc3e2165Swdenk		      also needs to be defined.
4061fc3e2165Swdenk
40626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR:
4063fc3e2165Swdenk		MII address of the PHY to check for the Ethernet link state.
4064c609719bSwdenk
4065f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS:
4066f5675aa5SRon Madrid		Define this if you desire to only have use of the NS16550_init
4067f5675aa5SRon Madrid		and NS16550_putc functions for the serial driver located at
4068f5675aa5SRon Madrid		drivers/serial/ns16550.c.  This option is useful for saving
4069f5675aa5SRon Madrid		space for already greatly restricted images, including but not
4070f5675aa5SRon Madrid		limited to NAND_SPL configurations.
4071f5675aa5SRon Madrid
4072b2b92f53SSimon Glass- CONFIG_DISPLAY_BOARDINFO
4073b2b92f53SSimon Glass		Display information about the board that U-Boot is running on
4074b2b92f53SSimon Glass		when U-Boot starts up. The board function checkboard() is called
4075b2b92f53SSimon Glass		to do this.
4076b2b92f53SSimon Glass
4077e2e3e2b1SSimon Glass- CONFIG_DISPLAY_BOARDINFO_LATE
4078e2e3e2b1SSimon Glass		Similar to the previous option, but display this information
4079e2e3e2b1SSimon Glass		later, once stdio is running and output goes to the LCD, if
4080e2e3e2b1SSimon Glass		present.
4081e2e3e2b1SSimon Glass
4082c609719bSwdenkLow Level (hardware related) configuration options:
4083dc7c9a1aSwdenk---------------------------------------------------
4084c609719bSwdenk
40856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE:
4086c609719bSwdenk		Cache Line Size of the CPU.
4087c609719bSwdenk
40886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR:
4089c609719bSwdenk		Default address of the IMMR after system reset.
40902535d602Swdenk
40912535d602Swdenk		Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
40922535d602Swdenk		and RPXsuper) to be able to adjust the position of
40932535d602Swdenk		the IMMR register after a reset.
4094c609719bSwdenk
4095e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_DEFAULT:
4096e46fedfeSTimur Tabi		Default (power-on reset) physical address of CCSR on Freescale
4097e46fedfeSTimur Tabi		PowerPC SOCs.
4098e46fedfeSTimur Tabi
4099e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR:
4100e46fedfeSTimur Tabi		Virtual address of CCSR.  On a 32-bit build, this is typically
4101e46fedfeSTimur Tabi		the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4102e46fedfeSTimur Tabi
4103e46fedfeSTimur Tabi		CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4104e46fedfeSTimur Tabi		for cross-platform code that uses that macro instead.
4105e46fedfeSTimur Tabi
4106e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS:
4107e46fedfeSTimur Tabi		Physical address of CCSR.  CCSR can be relocated to a new
4108e46fedfeSTimur Tabi		physical address, if desired.  In this case, this macro should
4109e46fedfeSTimur Tabi		be set to that address.	 Otherwise, it should be set to the
4110e46fedfeSTimur Tabi		same value as CONFIG_SYS_CCSRBAR_DEFAULT.  For example, CCSR
4111e46fedfeSTimur Tabi		is typically relocated on 36-bit builds.  It is recommended
4112e46fedfeSTimur Tabi		that this macro be defined via the _HIGH and _LOW macros:
4113e46fedfeSTimur Tabi
4114e46fedfeSTimur Tabi		#define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4115e46fedfeSTimur Tabi			* 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4116e46fedfeSTimur Tabi
4117e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
4118e46fedfeSTimur Tabi		Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS.	This value is typically
4119e46fedfeSTimur Tabi		either 0 (32-bit build) or 0xF (36-bit build).	This macro is
4120e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
4121e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
4122e46fedfeSTimur Tabi
4123e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4124e46fedfeSTimur Tabi		Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS.  This macro is
4125e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
4126e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
4127e46fedfeSTimur Tabi
4128e46fedfeSTimur Tabi- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4129e46fedfeSTimur Tabi		If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4130e46fedfeSTimur Tabi		forced to a value that ensures that CCSR is not relocated.
4131e46fedfeSTimur Tabi
41327f6c2cbcSwdenk- Floppy Disk Support:
41336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER
41347f6c2cbcSwdenk
41357f6c2cbcSwdenk		the default drive number (default value 0)
41367f6c2cbcSwdenk
41376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_STRIDE
41387f6c2cbcSwdenk
413911ccc33fSMarcel Ziswiler		defines the spacing between FDC chipset registers
41407f6c2cbcSwdenk		(default value 1)
41417f6c2cbcSwdenk
41426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_OFFSET
41437f6c2cbcSwdenk
41447f6c2cbcSwdenk		defines the offset of register from address. It
41457f6c2cbcSwdenk		depends on which part of the data bus is connected to
414611ccc33fSMarcel Ziswiler		the FDC chipset. (default value 0)
41477f6c2cbcSwdenk
41486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
41496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
41507f6c2cbcSwdenk		default value.
41517f6c2cbcSwdenk
41526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		if CONFIG_SYS_FDC_HW_INIT is defined, then the function
41537f6c2cbcSwdenk		fdc_hw_init() is called at the beginning of the FDC
41547f6c2cbcSwdenk		setup. fdc_hw_init() must be provided by the board
41557f6c2cbcSwdenk		source code. It is used to make hardware dependant
41567f6c2cbcSwdenk		initializations.
41577f6c2cbcSwdenk
41580abddf82SMacpaul Lin- CONFIG_IDE_AHB:
41590abddf82SMacpaul Lin		Most IDE controllers were designed to be connected with PCI
41600abddf82SMacpaul Lin		interface. Only few of them were designed for AHB interface.
41610abddf82SMacpaul Lin		When software is doing ATA command and data transfer to
41620abddf82SMacpaul Lin		IDE devices through IDE-AHB controller, some additional
41630abddf82SMacpaul Lin		registers accessing to these kind of IDE-AHB controller
41640abddf82SMacpaul Lin		is requierd.
41650abddf82SMacpaul Lin
41666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR:	Physical address of the Internal Memory.
416725d6712aSwdenk		DO NOT CHANGE unless you know exactly what you're
416825d6712aSwdenk		doing! (11-4) [MPC8xx/82xx systems only]
4169c609719bSwdenk
41706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR:
4171c609719bSwdenk
41727152b1d0Swdenk		Start address of memory area that can be used for
4173c609719bSwdenk		initial data and stack; please note that this must be
4174c609719bSwdenk		writable memory that is working WITHOUT special
4175c609719bSwdenk		initialization, i. e. you CANNOT use normal RAM which
4176c609719bSwdenk		will become available only after programming the
4177c609719bSwdenk		memory controller and running certain initialization
4178c609719bSwdenk		sequences.
4179c609719bSwdenk
4180c609719bSwdenk		U-Boot uses the following memory types:
4181c609719bSwdenk		- MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4182c609719bSwdenk		- MPC824X: data cache
4183c609719bSwdenk		- PPC4xx:  data cache
4184c609719bSwdenk
41856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET:
4186c609719bSwdenk
4187c609719bSwdenk		Offset of the initial data structure in the memory
41886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
41896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
4190c609719bSwdenk		data is located at the end of the available space
4191553f0982SWolfgang Denk		(sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
41926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
41936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
41946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET) downward.
4195c609719bSwdenk
4196c609719bSwdenk	Note:
4197c609719bSwdenk		On the MPC824X (or other systems that use the data
4198c609719bSwdenk		cache for initial memory) the address chosen for
41996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
4200c609719bSwdenk		point to an otherwise UNUSED address space between
4201c609719bSwdenk		the top of RAM and the start of the PCI space.
4202c609719bSwdenk
42036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR:	SIU Module Configuration (11-6)
4204c609719bSwdenk
42056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR:	System Protection Control (11-9)
4206c609719bSwdenk
42076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR:	Time Base Status and Control (11-26)
4208c609719bSwdenk
42096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR:	Periodic Interrupt Status and Control (11-31)
4210c609719bSwdenk
42116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR:	PLL, Low-Power, and Reset Control Register (15-30)
4212c609719bSwdenk
42136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR:	System Clock and reset Control Register (15-27)
4214c609719bSwdenk
42156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM:
4216c609719bSwdenk		SDRAM timing
4217c609719bSwdenk
42186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA:
4219c609719bSwdenk		periodic timer for refresh
4220c609719bSwdenk
42216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER:	Debug Event Register (37-47)
4222c609719bSwdenk
42236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
42246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
42256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
42266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_BR1_PRELIM:
4227c609719bSwdenk		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4228c609719bSwdenk
4229c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
42306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
42316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
4232c609719bSwdenk		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4233c609719bSwdenk
42346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
42356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
4236c609719bSwdenk		Machine Mode Register and Memory Periodic Timer
4237c609719bSwdenk		Prescaler definitions (SDRAM timing)
4238c609719bSwdenk
42396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
4240c609719bSwdenk		enable I2C microcode relocation patch (MPC8xx);
4241c609719bSwdenk		define relocation offset in DPRAM [DSP2]
4242c609719bSwdenk
42436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
4244b423d055SHeiko Schocher		enable SMC microcode relocation patch (MPC8xx);
4245b423d055SHeiko Schocher		define relocation offset in DPRAM [SMC1]
4246b423d055SHeiko Schocher
42476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
4248c609719bSwdenk		enable SPI microcode relocation patch (MPC8xx);
4249c609719bSwdenk		define relocation offset in DPRAM [SCC4]
4250c609719bSwdenk
42516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_USE_OSCCLK:
4252c609719bSwdenk		Use OSCM clock mode on MBX8xx board. Be careful,
4253c609719bSwdenk		wrong setting might damage your board. Read
4254c609719bSwdenk		doc/README.MBX before setting this variable!
4255c609719bSwdenk
42566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
4257ea909b76Swdenk		Offset of the bootmode word in DPRAM used by post
4258ea909b76Swdenk		(Power On Self Tests). This definition overrides
4259ea909b76Swdenk		#define'd default value in commproc.h resp.
4260ea909b76Swdenk		cpm_8260.h.
4261ea909b76Swdenk
42626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
42636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
42646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
42656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
42666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
42676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
42686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
42696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
4270a47a12beSStefan Roese		Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
42715d232d0eSwdenk
42729cacf4fcSDirk Eibach- CONFIG_PCI_DISABLE_PCIE:
42739cacf4fcSDirk Eibach		Disable PCI-Express on systems where it is supported but not
42749cacf4fcSDirk Eibach		required.
42759cacf4fcSDirk Eibach
427669fd2d3bSAndrew Sharp- CONFIG_PCI_ENUM_ONLY
427769fd2d3bSAndrew Sharp		Only scan through and get the devices on the busses.
427869fd2d3bSAndrew Sharp		Don't do any setup work, presumably because someone or
427969fd2d3bSAndrew Sharp		something has already done it, and we don't need to do it
428069fd2d3bSAndrew Sharp		a second time.	Useful for platforms that are pre-booted
428169fd2d3bSAndrew Sharp		by coreboot or similar.
428269fd2d3bSAndrew Sharp
4283842033e6SGabor Juhos- CONFIG_PCI_INDIRECT_BRIDGE:
4284842033e6SGabor Juhos		Enable support for indirect PCI bridges.
4285842033e6SGabor Juhos
4286a09b9b68SKumar Gala- CONFIG_SYS_SRIO:
4287a09b9b68SKumar Gala		Chip has SRIO or not
4288a09b9b68SKumar Gala
4289a09b9b68SKumar Gala- CONFIG_SRIO1:
4290a09b9b68SKumar Gala		Board has SRIO 1 port available
4291a09b9b68SKumar Gala
4292a09b9b68SKumar Gala- CONFIG_SRIO2:
4293a09b9b68SKumar Gala		Board has SRIO 2 port available
4294a09b9b68SKumar Gala
4295c8b28152SLiu Gang- CONFIG_SRIO_PCIE_BOOT_MASTER
4296c8b28152SLiu Gang		Board can support master function for Boot from SRIO and PCIE
4297c8b28152SLiu Gang
4298a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_VIRT:
4299a09b9b68SKumar Gala		Virtual Address of SRIO port 'n' memory region
4300a09b9b68SKumar Gala
4301a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_PHYS:
4302a09b9b68SKumar Gala		Physical Address of SRIO port 'n' memory region
4303a09b9b68SKumar Gala
4304a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_SIZE:
4305a09b9b68SKumar Gala		Size of SRIO port 'n' memory region
4306a09b9b68SKumar Gala
430766bd1846SFabio Estevam- CONFIG_SYS_NAND_BUSWIDTH_16BIT
430866bd1846SFabio Estevam		Defined to tell the NAND controller that the NAND chip is using
430966bd1846SFabio Estevam		a 16 bit bus.
431066bd1846SFabio Estevam		Not all NAND drivers use this symbol.
4311a430e916SFabio Estevam		Example of drivers that use it:
431266bd1846SFabio Estevam		- drivers/mtd/nand/ndfc.c
4313a430e916SFabio Estevam		- drivers/mtd/nand/mxc_nand.c
4314eced4626SAlex Waterman
4315eced4626SAlex Waterman- CONFIG_SYS_NDFC_EBC0_CFG
4316eced4626SAlex Waterman		Sets the EBC0_CFG register for the NDFC. If not defined
4317eced4626SAlex Waterman		a default value will be used.
4318eced4626SAlex Waterman
4319bb99ad6dSBen Warren- CONFIG_SPD_EEPROM
4320218ca724SWolfgang Denk		Get DDR timing information from an I2C EEPROM. Common
4321218ca724SWolfgang Denk		with pluggable memory modules such as SODIMMs
4322218ca724SWolfgang Denk
4323bb99ad6dSBen Warren  SPD_EEPROM_ADDRESS
4324bb99ad6dSBen Warren		I2C address of the SPD EEPROM
4325bb99ad6dSBen Warren
43266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM
4327218ca724SWolfgang Denk		If SPD EEPROM is on an I2C bus other than the first
4328218ca724SWolfgang Denk		one, specify here. Note that the value must resolve
4329218ca724SWolfgang Denk		to something your driver can deal with.
4330bb99ad6dSBen Warren
43311b3e3c4fSYork Sun- CONFIG_SYS_DDR_RAW_TIMING
43321b3e3c4fSYork Sun		Get DDR timing information from other than SPD. Common with
43331b3e3c4fSYork Sun		soldered DDR chips onboard without SPD. DDR raw timing
43341b3e3c4fSYork Sun		parameters are extracted from datasheet and hard-coded into
43351b3e3c4fSYork Sun		header files or board specific files.
43361b3e3c4fSYork Sun
43376f5e1dc5SYork Sun- CONFIG_FSL_DDR_INTERACTIVE
43386f5e1dc5SYork Sun		Enable interactive DDR debugging. See doc/README.fsl-ddr.
43396f5e1dc5SYork Sun
43406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0
4341218ca724SWolfgang Denk		Only for 83xx systems. If specified, then DDR should
4342218ca724SWolfgang Denk		be configured using CS0 and CS1 instead of CS2 and CS3.
43432ad6b513STimur Tabi
4344c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12]
4345c26e454dSwdenk		Define to enable FEC[12] on a 8xx series processor.
4346c26e454dSwdenk
4347c26e454dSwdenk- CONFIG_FEC[12]_PHY
4348c26e454dSwdenk		Define to the hardcoded PHY address which corresponds
43496e592385Swdenk		to the given FEC; i. e.
4350c26e454dSwdenk			#define CONFIG_FEC1_PHY 4
4351c26e454dSwdenk		means that the PHY with address 4 is connected to FEC1
4352c26e454dSwdenk
4353c26e454dSwdenk		When set to -1, means to probe for first available.
4354c26e454dSwdenk
4355c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR
4356c26e454dSwdenk		The PHY does not have a RXERR line (RMII only).
4357c26e454dSwdenk		(so program the FEC to ignore it).
4358c26e454dSwdenk
4359c26e454dSwdenk- CONFIG_RMII
4360c26e454dSwdenk		Enable RMII mode for all FECs.
4361c26e454dSwdenk		Note that this is a global option, we can't
4362c26e454dSwdenk		have one FEC in standard MII mode and another in RMII mode.
4363c26e454dSwdenk
43645cf91d6bSwdenk- CONFIG_CRC32_VERIFY
43655cf91d6bSwdenk		Add a verify option to the crc32 command.
43665cf91d6bSwdenk		The syntax is:
43675cf91d6bSwdenk
43685cf91d6bSwdenk		=> crc32 -v <address> <count> <crc32>
43695cf91d6bSwdenk
43705cf91d6bSwdenk		Where address/count indicate a memory area
43715cf91d6bSwdenk		and crc32 is the correct crc32 which the
43725cf91d6bSwdenk		area should have.
43735cf91d6bSwdenk
437456523f12Swdenk- CONFIG_LOOPW
437556523f12Swdenk		Add the "loopw" memory command. This only takes effect if
4376602ad3b3SJon Loeliger		the memory commands are activated globally (CONFIG_CMD_MEM).
437756523f12Swdenk
43787b466641Sstroese- CONFIG_MX_CYCLIC
43797b466641Sstroese		Add the "mdc" and "mwc" memory commands. These are cyclic
43807b466641Sstroese		"md/mw" commands.
43817b466641Sstroese		Examples:
43827b466641Sstroese
43837b466641Sstroese		=> mdc.b 10 4 500
43847b466641Sstroese		This command will print 4 bytes (10,11,12,13) each 500 ms.
43857b466641Sstroese
43867b466641Sstroese		=> mwc.l 100 12345678 10
43877b466641Sstroese		This command will write 12345678 to address 100 all 10 ms.
43887b466641Sstroese
43897b466641Sstroese		This only takes effect if the memory commands are activated
4390602ad3b3SJon Loeliger		globally (CONFIG_CMD_MEM).
43917b466641Sstroese
43928aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT
4393afc1ce82SMacpaul Lin		[ARM, NDS32, MIPS only] If this variable is defined, then certain
4394e03f3169SWolfgang Denk		low level initializations (like setting up the memory
4395e03f3169SWolfgang Denk		controller) are omitted and/or U-Boot does not
4396e03f3169SWolfgang Denk		relocate itself into RAM.
43978aa1a2d1Swdenk
4398e03f3169SWolfgang Denk		Normally this variable MUST NOT be defined. The only
4399e03f3169SWolfgang Denk		exception is when U-Boot is loaded (to RAM) by some
4400e03f3169SWolfgang Denk		other boot loader or by a debugger which performs
4401e03f3169SWolfgang Denk		these initializations itself.
44028aa1a2d1Swdenk
4403401bb30bSAneesh V- CONFIG_SPL_BUILD
4404df81238bSMagnus Lilja		Modifies the behaviour of start.S when compiling a loader
4405df81238bSMagnus Lilja		that is executed before the actual U-Boot. E.g. when
4406df81238bSMagnus Lilja		compiling a NAND SPL.
4407400558b5Swdenk
44083aa29de0SYing Zhang- CONFIG_TPL_BUILD
44093aa29de0SYing Zhang		Modifies the behaviour of start.S  when compiling a loader
44103aa29de0SYing Zhang		that is executed after the SPL and before the actual U-Boot.
44113aa29de0SYing Zhang		It is loaded by the SPL.
44123aa29de0SYing Zhang
44135df572f0SYing Zhang- CONFIG_SYS_MPC85XX_NO_RESETVEC
44145df572f0SYing Zhang		Only for 85xx systems. If this variable is specified, the section
44155df572f0SYing Zhang		.resetvec is not kept and the section .bootpg is placed in the
44165df572f0SYing Zhang		previous 4k of the .text section.
44175df572f0SYing Zhang
44184213fc29SSimon Glass- CONFIG_ARCH_MAP_SYSMEM
44194213fc29SSimon Glass		Generally U-Boot (and in particular the md command) uses
44204213fc29SSimon Glass		effective address. It is therefore not necessary to regard
44214213fc29SSimon Glass		U-Boot address as virtual addresses that need to be translated
44224213fc29SSimon Glass		to physical addresses. However, sandbox requires this, since
44234213fc29SSimon Glass		it maintains its own little RAM buffer which contains all
44244213fc29SSimon Glass		addressable memory. This option causes some memory accesses
44254213fc29SSimon Glass		to be mapped through map_sysmem() / unmap_sysmem().
44264213fc29SSimon Glass
4427d8834a13SMatthias Weisser- CONFIG_USE_ARCH_MEMCPY
4428d8834a13SMatthias Weisser  CONFIG_USE_ARCH_MEMSET
4429d8834a13SMatthias Weisser		If these options are used a optimized version of memcpy/memset will
4430d8834a13SMatthias Weisser		be used if available. These functions may be faster under some
4431d8834a13SMatthias Weisser		conditions but may increase the binary size.
4432d8834a13SMatthias Weisser
4433588a13f7SSimon Glass- CONFIG_X86_RESET_VECTOR
4434588a13f7SSimon Glass		If defined, the x86 reset vector code is included. This is not
4435588a13f7SSimon Glass		needed when U-Boot is running from Coreboot.
4436b16f521aSGabe Black
4437fc33705eSMark Jackson- CONFIG_SYS_MPUCLK
4438fc33705eSMark Jackson		Defines the MPU clock speed (in MHz).
4439fc33705eSMark Jackson
4440fc33705eSMark Jackson		NOTE : currently only supported on AM335x platforms.
44415b5ece9eSGabe Black
444216678eb4SHeiko Schocher- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
444316678eb4SHeiko Schocher		Enables the RTC32K OSC on AM33xx based plattforms
444416678eb4SHeiko Schocher
4445f2717b47STimur TabiFreescale QE/FMAN Firmware Support:
4446f2717b47STimur Tabi-----------------------------------
4447f2717b47STimur Tabi
4448f2717b47STimur TabiThe Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4449f2717b47STimur Tabiloading of "firmware", which is encoded in the QE firmware binary format.
4450f2717b47STimur TabiThis firmware often needs to be loaded during U-Boot booting, so macros
4451f2717b47STimur Tabiare used to identify the storage device (NOR flash, SPI, etc) and the address
4452f2717b47STimur Tabiwithin that device.
4453f2717b47STimur Tabi
4454f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_ADDR
4455f2717b47STimur Tabi	The address in the storage device where the firmware is located.  The
4456f2717b47STimur Tabi	meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4457f2717b47STimur Tabi	is also specified.
4458f2717b47STimur Tabi
4459f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_LENGTH
4460f2717b47STimur Tabi	The maximum possible size of the firmware.  The firmware binary format
4461f2717b47STimur Tabi	has a field that specifies the actual size of the firmware, but it
4462f2717b47STimur Tabi	might not be possible to read any part of the firmware unless some
4463f2717b47STimur Tabi	local storage is allocated to hold the entire firmware first.
4464f2717b47STimur Tabi
4465f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4466f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4467f2717b47STimur Tabi	normal addressable memory via the LBC.  CONFIG_SYS_FMAN_FW_ADDR is the
4468f2717b47STimur Tabi	virtual address in NOR flash.
4469f2717b47STimur Tabi
4470f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4471f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NAND flash.
4472f2717b47STimur Tabi	CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4473f2717b47STimur Tabi
4474f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4475f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SD/MMC
4476f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4477f2717b47STimur Tabi
4478f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
4479f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SPI
4480f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4481f2717b47STimur Tabi
4482292dc6c5SLiu Gang- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4483292dc6c5SLiu Gang	Specifies that QE/FMAN firmware is located in the remote (master)
4484292dc6c5SLiu Gang	memory space.	CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
4485fc54c7faSLiu Gang	can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4486fc54c7faSLiu Gang	window->master inbound window->master LAW->the ucode address in
4487fc54c7faSLiu Gang	master's memory space.
4488f2717b47STimur Tabi
4489c609719bSwdenkBuilding the Software:
4490c609719bSwdenk======================
4491c609719bSwdenk
4492218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments
4493218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support
4494218ca724SWolfgang Denkall possibly existing versions of cross development tools in all
4495218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we
4496218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4497218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot.
4498c609719bSwdenk
4499218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you
4500218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case,
4501218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell.
4502218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are
4503218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter:
4504c609719bSwdenk
4505218ca724SWolfgang Denk	$ CROSS_COMPILE=ppc_4xx-
4506218ca724SWolfgang Denk	$ export CROSS_COMPILE
4507c609719bSwdenk
45082f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in
45092f8d396bSPeter Tyser      the tools directory you can use the MinGW toolchain
45102f8d396bSPeter Tyser      (http://www.mingw.org).  Set your HOST tools to the MinGW
45112f8d396bSPeter Tyser      toolchain and execute 'make tools'.  For example:
45122f8d396bSPeter Tyser
45132f8d396bSPeter Tyser       $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
45142f8d396bSPeter Tyser
45152f8d396bSPeter Tyser      Binaries such as tools/mkimage.exe will be created which can
45162f8d396bSPeter Tyser      be executed on computers running Windows.
45172f8d396bSPeter Tyser
4518c609719bSwdenkU-Boot is intended to be simple to build. After installing the
4519c609719bSwdenksources you must configure U-Boot for one specific board type. This
4520c609719bSwdenkis done by typing:
4521c609719bSwdenk
4522c609719bSwdenk	make NAME_config
4523c609719bSwdenk
4524218ca724SWolfgang Denkwhere "NAME_config" is the name of one of the existing configu-
45254d675ae6SMichael Jonesrations; see boards.cfg for supported names.
452654387ac9Swdenk
4527c609719bSwdenkNote: for some board special configuration names may exist; check if
4528c609719bSwdenk      additional information is available from the board vendor; for
45292729af9dSwdenk      instance, the TQM823L systems are available without (standard)
45302729af9dSwdenk      or with LCD support. You can select such additional "features"
453111ccc33fSMarcel Ziswiler      when choosing the configuration, i. e.
4532c609719bSwdenk
45332729af9dSwdenk      make TQM823L_config
45342729af9dSwdenk	- will configure for a plain TQM823L, i. e. no LCD support
4535c609719bSwdenk
4536c609719bSwdenk      make TQM823L_LCD_config
4537c609719bSwdenk	- will configure for a TQM823L with U-Boot console on LCD
4538c609719bSwdenk
4539c609719bSwdenk      etc.
4540c609719bSwdenk
4541c609719bSwdenk
4542c609719bSwdenkFinally, type "make all", and you should get some working U-Boot
45437152b1d0Swdenkimages ready for download to / installation on your system:
4544c609719bSwdenk
4545c609719bSwdenk- "u-boot.bin" is a raw binary image
4546c609719bSwdenk- "u-boot" is an image in ELF binary format
4547c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format
4548c609719bSwdenk
4549baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved
4550baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change
4551baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory:
4552baf31249SMarian Balakowicz
4553baf31249SMarian Balakowicz1. Add O= to the make command line invocations:
4554baf31249SMarian Balakowicz
4555baf31249SMarian Balakowicz	make O=/tmp/build distclean
4556baf31249SMarian Balakowicz	make O=/tmp/build NAME_config
4557baf31249SMarian Balakowicz	make O=/tmp/build all
4558baf31249SMarian Balakowicz
4559baf31249SMarian Balakowicz2. Set environment variable BUILD_DIR to point to the desired location:
4560baf31249SMarian Balakowicz
4561baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
4562baf31249SMarian Balakowicz	make distclean
4563baf31249SMarian Balakowicz	make NAME_config
4564baf31249SMarian Balakowicz	make all
4565baf31249SMarian Balakowicz
4566baf31249SMarian BalakowiczNote that the command line "O=" setting overrides the BUILD_DIR environment
4567baf31249SMarian Balakowiczvariable.
4568baf31249SMarian Balakowicz
4569c609719bSwdenk
4570c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so
4571c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of
4572c609719bSwdenknative "make".
4573c609719bSwdenk
4574c609719bSwdenk
4575c609719bSwdenkIf the system board that you have is not listed, then you will need
4576c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these
4577c609719bSwdenksteps:
4578c609719bSwdenk
4579c609719bSwdenk1.  Add a new configuration option for your board to the toplevel
45804d675ae6SMichael Jones    "boards.cfg" file, using the existing entries as examples.
45814d675ae6SMichael Jones    Follow the instructions there to keep the boards in order.
4582c609719bSwdenk2.  Create a new directory to hold your board specific code. Add any
458385ec0bccSwdenk    files you need. In your board directory, you will need at least
458485ec0bccSwdenk    the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
458585ec0bccSwdenk3.  Create a new configuration file "include/configs/<board>.h" for
458685ec0bccSwdenk    your board
4587c609719bSwdenk3.  If you're porting U-Boot to a new CPU, then also create a new
4588c609719bSwdenk    directory to hold your CPU specific code. Add any files you need.
458985ec0bccSwdenk4.  Run "make <board>_config" with your new name.
4590c609719bSwdenk5.  Type "make", and you should get a working "u-boot.srec" file
4591c609719bSwdenk    to be installed on your target system.
459285ec0bccSwdenk6.  Debug and solve any problems that might arise.
4593c609719bSwdenk    [Of course, this last step is much harder than it sounds.]
4594c609719bSwdenk
4595c609719bSwdenk
4596c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.:
4597c609719bSwdenk==============================================================
4598c609719bSwdenk
4599c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board
4600c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to
4601c609719bSwdenkprovide feedback to the other developers. The feedback normally takes
4602c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest
4603218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources.
4604c609719bSwdenk
4605c609719bSwdenkBut before you submit such a patch, please verify that your modifi-
4606c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of
4607c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so,
4608c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot
4609c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You can
46107152b1d0Swdenkselect which (cross) compiler to use by passing a `CROSS_COMPILE'
4611218ca724SWolfgang Denkenvironment variable to the script, i. e. to use the ELDK cross tools
4612218ca724SWolfgang Denkyou can type
4613c609719bSwdenk
4614c609719bSwdenk	CROSS_COMPILE=ppc_8xx- MAKEALL
4615c609719bSwdenk
4616c609719bSwdenkor to build on a native PowerPC system you can type
4617c609719bSwdenk
4618c609719bSwdenk	CROSS_COMPILE=' ' MAKEALL
4619c609719bSwdenk
4620218ca724SWolfgang DenkWhen using the MAKEALL script, the default behaviour is to build
4621218ca724SWolfgang DenkU-Boot in the source directory. This location can be changed by
4622218ca724SWolfgang Denksetting the BUILD_DIR environment variable. Also, for each target
4623218ca724SWolfgang Denkbuilt, the MAKEALL script saves two log files (<target>.ERR and
4624218ca724SWolfgang Denk<target>.MAKEALL) in the <source dir>/LOG directory. This default
4625218ca724SWolfgang Denklocation can be changed by setting the MAKEALL_LOGDIR environment
4626218ca724SWolfgang Denkvariable. For example:
4627baf31249SMarian Balakowicz
4628baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
4629baf31249SMarian Balakowicz	export MAKEALL_LOGDIR=/tmp/log
4630baf31249SMarian Balakowicz	CROSS_COMPILE=ppc_8xx- MAKEALL
4631baf31249SMarian Balakowicz
4632218ca724SWolfgang DenkWith the above settings build objects are saved in the /tmp/build,
4633218ca724SWolfgang Denklog files are saved in the /tmp/log and the source tree remains clean
4634218ca724SWolfgang Denkduring the whole build process.
4635baf31249SMarian Balakowicz
4636baf31249SMarian Balakowicz
4637c609719bSwdenkSee also "U-Boot Porting Guide" below.
4638c609719bSwdenk
4639c609719bSwdenk
4640c609719bSwdenkMonitor Commands - Overview:
4641c609719bSwdenk============================
4642c609719bSwdenk
4643c609719bSwdenkgo	- start application at address 'addr'
4644c609719bSwdenkrun	- run commands in an environment variable
4645c609719bSwdenkbootm	- boot application image from memory
4646c609719bSwdenkbootp	- boot image via network using BootP/TFTP protocol
464744f074c7SMarek Vasutbootz   - boot zImage from memory
4648c609719bSwdenktftpboot- boot image via network using TFTP protocol
4649c609719bSwdenk	       and env variables "ipaddr" and "serverip"
4650c609719bSwdenk	       (and eventually "gatewayip")
46511fb7cd49SSimon Glasstftpput - upload a file via network using TFTP protocol
4652c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol
4653c609719bSwdenkdiskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
4654c609719bSwdenkloads	- load S-Record file over serial line
4655c609719bSwdenkloadb	- load binary file over serial line (kermit mode)
4656c609719bSwdenkmd	- memory display
4657c609719bSwdenkmm	- memory modify (auto-incrementing)
4658c609719bSwdenknm	- memory modify (constant address)
4659c609719bSwdenkmw	- memory write (fill)
4660c609719bSwdenkcp	- memory copy
4661c609719bSwdenkcmp	- memory compare
4662c609719bSwdenkcrc32	- checksum calculation
46630f89c54bSPeter Tyseri2c	- I2C sub-system
4664c609719bSwdenksspi	- SPI utility commands
4665c609719bSwdenkbase	- print or set address offset
4666c609719bSwdenkprintenv- print environment variables
4667c609719bSwdenksetenv	- set environment variables
4668c609719bSwdenksaveenv - save environment variables to persistent storage
4669c609719bSwdenkprotect - enable or disable FLASH write protection
4670c609719bSwdenkerase	- erase FLASH memory
4671c609719bSwdenkflinfo	- print FLASH memory information
467210635afaSKarl O. Pincnand	- NAND memory operations (see doc/README.nand)
4673c609719bSwdenkbdinfo	- print Board Info structure
4674c609719bSwdenkiminfo	- print header information for application image
4675c609719bSwdenkconinfo - print console devices and informations
4676c609719bSwdenkide	- IDE sub-system
4677c609719bSwdenkloop	- infinite loop on address range
467856523f12Swdenkloopw	- infinite write loop on address range
4679c609719bSwdenkmtest	- simple RAM test
4680c609719bSwdenkicache	- enable or disable instruction cache
4681c609719bSwdenkdcache	- enable or disable data cache
4682c609719bSwdenkreset	- Perform RESET of the CPU
4683c609719bSwdenkecho	- echo args to console
4684c609719bSwdenkversion - print monitor version
4685c609719bSwdenkhelp	- print online help
4686c609719bSwdenk?	- alias for 'help'
4687c609719bSwdenk
4688c609719bSwdenk
4689c609719bSwdenkMonitor Commands - Detailed Description:
4690c609719bSwdenk========================================
4691c609719bSwdenk
4692c609719bSwdenkTODO.
4693c609719bSwdenk
4694c609719bSwdenkFor now: just type "help <command>".
4695c609719bSwdenk
4696c609719bSwdenk
4697c609719bSwdenkEnvironment Variables:
4698c609719bSwdenk======================
4699c609719bSwdenk
4700c609719bSwdenkU-Boot supports user configuration using Environment Variables which
4701c609719bSwdenkcan be made persistent by saving to Flash memory.
4702c609719bSwdenk
4703c609719bSwdenkEnvironment Variables are set using "setenv", printed using
4704c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv"
4705c609719bSwdenkwithout a value can be used to delete a variable from the
4706c609719bSwdenkenvironment. As long as you don't save the environment you are
4707c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the
4708c609719bSwdenkenvironment is erased by accident, a default environment is provided.
4709c609719bSwdenk
4710c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables.
4711c96f86eeSWolfgang Denk
4712c96f86eeSWolfgang DenkList of environment variables (most likely not complete):
4713c609719bSwdenk
4714c609719bSwdenk  baudrate	- see CONFIG_BAUDRATE
4715c609719bSwdenk
4716c609719bSwdenk  bootdelay	- see CONFIG_BOOTDELAY
4717c609719bSwdenk
4718c609719bSwdenk  bootcmd	- see CONFIG_BOOTCOMMAND
4719c609719bSwdenk
4720c609719bSwdenk  bootargs	- Boot arguments when booting an RTOS image
4721c609719bSwdenk
4722c609719bSwdenk  bootfile	- Name of the image to load with TFTP
4723c609719bSwdenk
47247d721e34SBartlomiej Sieka  bootm_low	- Memory range available for image processing in the bootm
47257d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
47267d721e34SBartlomiej Sieka		  a hexadecimal number and defines lowest address allowed
47277d721e34SBartlomiej Sieka		  for use by the bootm command. See also "bootm_size"
47287d721e34SBartlomiej Sieka		  environment variable. Address defined by "bootm_low" is
47297d721e34SBartlomiej Sieka		  also the base of the initial memory mapping for the Linux
4730c3624e6eSGrant Likely		  kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4731c3624e6eSGrant Likely		  bootm_mapsize.
4732c3624e6eSGrant Likely
4733c3624e6eSGrant Likely  bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
4734c3624e6eSGrant Likely		  This variable is given as a hexadecimal number and it
4735c3624e6eSGrant Likely		  defines the size of the memory region starting at base
4736c3624e6eSGrant Likely		  address bootm_low that is accessible by the Linux kernel
4737c3624e6eSGrant Likely		  during early boot.  If unset, CONFIG_SYS_BOOTMAPSZ is used
4738c3624e6eSGrant Likely		  as the default value if it is defined, and bootm_size is
4739c3624e6eSGrant Likely		  used otherwise.
47407d721e34SBartlomiej Sieka
47417d721e34SBartlomiej Sieka  bootm_size	- Memory range available for image processing in the bootm
47427d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
47437d721e34SBartlomiej Sieka		  a hexadecimal number and defines the size of the region
47447d721e34SBartlomiej Sieka		  allowed for use by the bootm command. See also "bootm_low"
47457d721e34SBartlomiej Sieka		  environment variable.
47467d721e34SBartlomiej Sieka
47474bae9090SBartlomiej Sieka  updatefile	- Location of the software update file on a TFTP server, used
47484bae9090SBartlomiej Sieka		  by the automatic software update feature. Please refer to
47494bae9090SBartlomiej Sieka		  documentation in doc/README.update for more details.
47504bae9090SBartlomiej Sieka
4751c609719bSwdenk  autoload	- if set to "no" (any string beginning with 'n'),
4752c609719bSwdenk		  "bootp" will just load perform a lookup of the
4753c609719bSwdenk		  configuration from the BOOTP server, but not try to
4754c609719bSwdenk		  load any image using TFTP
4755c609719bSwdenk
4756c609719bSwdenk  autostart	- if set to "yes", an image loaded using the "bootp",
4757c609719bSwdenk		  "rarpboot", "tftpboot" or "diskboot" commands will
4758c609719bSwdenk		  be automatically started (by internally calling
4759c609719bSwdenk		  "bootm")
4760c609719bSwdenk
47614a6fd34bSwdenk		  If set to "no", a standalone image passed to the
47624a6fd34bSwdenk		  "bootm" command will be copied to the load address
47634a6fd34bSwdenk		  (and eventually uncompressed), but NOT be started.
47644a6fd34bSwdenk		  This can be used to load and uncompress arbitrary
47654a6fd34bSwdenk		  data.
47664a6fd34bSwdenk
4767a28afca5SDavid A. Long  fdt_high	- if set this restricts the maximum address that the
4768a28afca5SDavid A. Long		  flattened device tree will be copied into upon boot.
4769fa34f6b2SShawn Guo		  For example, if you have a system with 1 GB memory
4770fa34f6b2SShawn Guo		  at physical address 0x10000000, while Linux kernel
4771fa34f6b2SShawn Guo		  only recognizes the first 704 MB as low memory, you
4772fa34f6b2SShawn Guo		  may need to set fdt_high as 0x3C000000 to have the
4773fa34f6b2SShawn Guo		  device tree blob be copied to the maximum address
4774fa34f6b2SShawn Guo		  of the 704 MB low memory, so that Linux kernel can
4775fa34f6b2SShawn Guo		  access it during the boot procedure.
4776fa34f6b2SShawn Guo
4777a28afca5SDavid A. Long		  If this is set to the special value 0xFFFFFFFF then
4778a28afca5SDavid A. Long		  the fdt will not be copied at all on boot.  For this
4779a28afca5SDavid A. Long		  to work it must reside in writable memory, have
4780a28afca5SDavid A. Long		  sufficient padding on the end of it for u-boot to
4781a28afca5SDavid A. Long		  add the information it needs into it, and the memory
4782a28afca5SDavid A. Long		  must be accessible by the kernel.
4783a28afca5SDavid A. Long
4784eea63e05SSimon Glass  fdtcontroladdr- if set this is the address of the control flattened
4785eea63e05SSimon Glass		  device tree used by U-Boot when CONFIG_OF_CONTROL is
4786eea63e05SSimon Glass		  defined.
4787eea63e05SSimon Glass
478817ea1177Swdenk  i2cfast	- (PPC405GP|PPC405EP only)
478917ea1177Swdenk		  if set to 'y' configures Linux I2C driver for fast
479017ea1177Swdenk		  mode (400kHZ). This environment variable is used in
479117ea1177Swdenk		  initialization code. So, for changes to be effective
479217ea1177Swdenk		  it must be saved and board must be reset.
479317ea1177Swdenk
4794c609719bSwdenk  initrd_high	- restrict positioning of initrd images:
4795c609719bSwdenk		  If this variable is not set, initrd images will be
4796c609719bSwdenk		  copied to the highest possible address in RAM; this
4797c609719bSwdenk		  is usually what you want since it allows for
4798c609719bSwdenk		  maximum initrd size. If for some reason you want to
4799c609719bSwdenk		  make sure that the initrd image is loaded below the
48006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		  CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
4801c609719bSwdenk		  variable to a value of "no" or "off" or "0".
4802c609719bSwdenk		  Alternatively, you can set it to a maximum upper
4803c609719bSwdenk		  address to use (U-Boot will still check that it
4804c609719bSwdenk		  does not overwrite the U-Boot stack and data).
4805c609719bSwdenk
4806c609719bSwdenk		  For instance, when you have a system with 16 MB
48077152b1d0Swdenk		  RAM, and want to reserve 4 MB from use by Linux,
4808c609719bSwdenk		  you can do this by adding "mem=12M" to the value of
4809c609719bSwdenk		  the "bootargs" variable. However, now you must make
48107152b1d0Swdenk		  sure that the initrd image is placed in the first
4811c609719bSwdenk		  12 MB as well - this can be done with
4812c609719bSwdenk
4813c609719bSwdenk		  setenv initrd_high 00c00000
4814c609719bSwdenk
481538b99261Swdenk		  If you set initrd_high to 0xFFFFFFFF, this is an
481638b99261Swdenk		  indication to U-Boot that all addresses are legal
481738b99261Swdenk		  for the Linux kernel, including addresses in flash
481838b99261Swdenk		  memory. In this case U-Boot will NOT COPY the
481938b99261Swdenk		  ramdisk at all. This may be useful to reduce the
482038b99261Swdenk		  boot time on your system, but requires that this
482138b99261Swdenk		  feature is supported by your Linux kernel.
482238b99261Swdenk
4823c609719bSwdenk  ipaddr	- IP address; needed for tftpboot command
4824c609719bSwdenk
4825c609719bSwdenk  loadaddr	- Default load address for commands like "bootp",
4826dc7c9a1aSwdenk		  "rarpboot", "tftpboot", "loadb" or "diskboot"
4827c609719bSwdenk
4828c609719bSwdenk  loads_echo	- see CONFIG_LOADS_ECHO
4829c609719bSwdenk
4830c609719bSwdenk  serverip	- TFTP server IP address; needed for tftpboot command
4831c609719bSwdenk
4832c609719bSwdenk  bootretry	- see CONFIG_BOOT_RETRY_TIME
4833c609719bSwdenk
4834c609719bSwdenk  bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
4835c609719bSwdenk
4836c609719bSwdenk  bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
4837c609719bSwdenk
4838e2a53458SMike Frysinger  ethprime	- controls which interface is used first.
4839a3d991bdSwdenk
4840e2a53458SMike Frysinger  ethact	- controls which interface is currently active.
4841e2a53458SMike Frysinger		  For example you can do the following
4842a3d991bdSwdenk
484348690d80SHeiko Schocher		  => setenv ethact FEC
484448690d80SHeiko Schocher		  => ping 192.168.0.1 # traffic sent on FEC
484548690d80SHeiko Schocher		  => setenv ethact SCC
484648690d80SHeiko Schocher		  => ping 10.0.0.1 # traffic sent on SCC
4847a3d991bdSwdenk
4848e1692577SMatthias Fuchs  ethrotate	- When set to "no" U-Boot does not go through all
4849e1692577SMatthias Fuchs		  available network interfaces.
4850e1692577SMatthias Fuchs		  It just stays at the currently selected interface.
4851e1692577SMatthias Fuchs
4852a3d991bdSwdenk  netretry	- When set to "no" each network operation will
4853a3d991bdSwdenk		  either succeed or fail without retrying.
48546e592385Swdenk		  When set to "once" the network operation will
48556e592385Swdenk		  fail when all the available network interfaces
48566e592385Swdenk		  are tried once without success.
4857a3d991bdSwdenk		  Useful on scripts which control the retry operation
4858a3d991bdSwdenk		  themselves.
4859a3d991bdSwdenk
4860b4e2f89dSJean-Christophe PLAGNIOL-VILLARD  npe_ucode	- set load address for the NPE microcode
4861a1cf027aSJean-Christophe PLAGNIOL-VILLARD
48628d51aacdSSimon Glass  silent_linux  - If set then linux will be told to boot silently, by
48638d51aacdSSimon Glass		  changing the console to be empty. If "yes" it will be
48648d51aacdSSimon Glass		  made silent. If "no" it will not be made silent. If
48658d51aacdSSimon Glass		  unset, then it will be made silent if the U-Boot console
48668d51aacdSSimon Glass		  is silent.
48678d51aacdSSimon Glass
486828cb9375SWolfgang Denk  tftpsrcport	- If this is set, the value is used for TFTP's
4869ecb0ccd9SWolfgang Denk		  UDP source port.
4870ecb0ccd9SWolfgang Denk
487128cb9375SWolfgang Denk  tftpdstport	- If this is set, the value is used for TFTP's UDP
487228cb9375SWolfgang Denk		  destination port instead of the Well Know Port 69.
487328cb9375SWolfgang Denk
4874c96f86eeSWolfgang Denk  tftpblocksize - Block size to use for TFTP transfers; if not set,
4875c96f86eeSWolfgang Denk		  we use the TFTP server's default block size
4876c96f86eeSWolfgang Denk
4877c96f86eeSWolfgang Denk  tftptimeout	- Retransmission timeout for TFTP packets (in milli-
4878c96f86eeSWolfgang Denk		  seconds, minimum value is 1000 = 1 second). Defines
4879c96f86eeSWolfgang Denk		  when a packet is considered to be lost so it has to
4880c96f86eeSWolfgang Denk		  be retransmitted. The default is 5000 = 5 seconds.
4881c96f86eeSWolfgang Denk		  Lowering this value may make downloads succeed
4882c96f86eeSWolfgang Denk		  faster in networks with high packet loss rates or
4883c96f86eeSWolfgang Denk		  with unreliable TFTP servers.
4884c96f86eeSWolfgang Denk
4885a3d991bdSwdenk  vlan		- When set to a value < 4095 the traffic over
488611ccc33fSMarcel Ziswiler		  Ethernet is encapsulated/received over 802.1q
4887a3d991bdSwdenk		  VLAN tagged frames.
4888c609719bSwdenk
4889dc0b7b0eSJason HobbsThe following image location variables contain the location of images
4890dc0b7b0eSJason Hobbsused in booting. The "Image" column gives the role of the image and is
4891dc0b7b0eSJason Hobbsnot an environment variable name. The other columns are environment
4892dc0b7b0eSJason Hobbsvariable names. "File Name" gives the name of the file on a TFTP
4893dc0b7b0eSJason Hobbsserver, "RAM Address" gives the location in RAM the image will be
4894dc0b7b0eSJason Hobbsloaded to, and "Flash Location" gives the image's address in NOR
4895dc0b7b0eSJason Hobbsflash or offset in NAND flash.
4896dc0b7b0eSJason Hobbs
4897dc0b7b0eSJason Hobbs*Note* - these variables don't have to be defined for all boards, some
4898dc0b7b0eSJason Hobbsboards currenlty use other variables for these purposes, and some
4899dc0b7b0eSJason Hobbsboards use these variables for other purposes.
4900dc0b7b0eSJason Hobbs
4901dc0b7b0eSJason HobbsImage		    File Name	     RAM Address       Flash Location
4902dc0b7b0eSJason Hobbs-----		    ---------	     -----------       --------------
4903dc0b7b0eSJason Hobbsu-boot		    u-boot	     u-boot_addr_r     u-boot_addr
4904dc0b7b0eSJason HobbsLinux kernel	    bootfile	     kernel_addr_r     kernel_addr
4905dc0b7b0eSJason Hobbsdevice tree blob    fdtfile	     fdt_addr_r	       fdt_addr
4906dc0b7b0eSJason Hobbsramdisk		    ramdiskfile	     ramdisk_addr_r    ramdisk_addr
4907dc0b7b0eSJason Hobbs
4908c609719bSwdenkThe following environment variables may be used and automatically
4909c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"),
4910c609719bSwdenkdepending the information provided by your boot server:
4911c609719bSwdenk
4912c609719bSwdenk  bootfile	- see above
4913c609719bSwdenk  dnsip		- IP address of your Domain Name Server
4914fe389a82Sstroese  dnsip2	- IP address of your secondary Domain Name Server
4915c609719bSwdenk  gatewayip	- IP address of the Gateway (Router) to use
4916c609719bSwdenk  hostname	- Target hostname
4917c609719bSwdenk  ipaddr	- see above
4918c609719bSwdenk  netmask	- Subnet Mask
4919c609719bSwdenk  rootpath	- Pathname of the root filesystem on the NFS server
4920c609719bSwdenk  serverip	- see above
4921c609719bSwdenk
4922c609719bSwdenk
4923c609719bSwdenkThere are two special Environment Variables:
4924c609719bSwdenk
4925c609719bSwdenk  serial#	- contains hardware identification information such
4926c609719bSwdenk		  as type string and/or serial number
4927c609719bSwdenk  ethaddr	- Ethernet address
4928c609719bSwdenk
4929c609719bSwdenkThese variables can be set only once (usually during manufacturing of
4930c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables
4931c609719bSwdenkonce they have been set once.
4932c609719bSwdenk
4933c609719bSwdenk
4934c1551ea8SstroeseFurther special Environment Variables:
4935c1551ea8Sstroese
4936c1551ea8Sstroese  ver		- Contains the U-Boot version string as printed
4937c1551ea8Sstroese		  with the "version" command. This variable is
4938c1551ea8Sstroese		  readonly (see CONFIG_VERSION_VARIABLE).
4939c1551ea8Sstroese
4940c1551ea8Sstroese
4941c609719bSwdenkPlease note that changes to some configuration parameters may take
4942c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-).
4943c609719bSwdenk
4944c609719bSwdenk
4945170ab110SJoe HershbergerCallback functions for environment variables:
4946170ab110SJoe Hershberger---------------------------------------------
4947170ab110SJoe Hershberger
4948170ab110SJoe HershbergerFor some environment variables, the behavior of u-boot needs to change
4949170ab110SJoe Hershbergerwhen their values are changed.  This functionailty allows functions to
4950170ab110SJoe Hershbergerbe associated with arbitrary variables.  On creation, overwrite, or
4951170ab110SJoe Hershbergerdeletion, the callback will provide the opportunity for some side
4952170ab110SJoe Hershbergereffect to happen or for the change to be rejected.
4953170ab110SJoe Hershberger
4954170ab110SJoe HershbergerThe callbacks are named and associated with a function using the
4955170ab110SJoe HershbergerU_BOOT_ENV_CALLBACK macro in your board or driver code.
4956170ab110SJoe Hershberger
4957170ab110SJoe HershbergerThese callbacks are associated with variables in one of two ways.  The
4958170ab110SJoe Hershbergerstatic list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
4959170ab110SJoe Hershbergerin the board configuration to a string that defines a list of
4960170ab110SJoe Hershbergerassociations.  The list must be in the following format:
4961170ab110SJoe Hershberger
4962170ab110SJoe Hershberger	entry = variable_name[:callback_name]
4963170ab110SJoe Hershberger	list = entry[,list]
4964170ab110SJoe Hershberger
4965170ab110SJoe HershbergerIf the callback name is not specified, then the callback is deleted.
4966170ab110SJoe HershbergerSpaces are also allowed anywhere in the list.
4967170ab110SJoe Hershberger
4968170ab110SJoe HershbergerCallbacks can also be associated by defining the ".callbacks" variable
4969170ab110SJoe Hershbergerwith the same list format above.  Any association in ".callbacks" will
4970170ab110SJoe Hershbergeroverride any association in the static list. You can define
4971170ab110SJoe HershbergerCONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
4972170ab110SJoe Hershberger".callbacks" envirnoment variable in the default or embedded environment.
4973170ab110SJoe Hershberger
4974170ab110SJoe Hershberger
4975f07771ccSwdenkCommand Line Parsing:
4976f07771ccSwdenk=====================
4977f07771ccSwdenk
4978f07771ccSwdenkThere are two different command line parsers available with U-Boot:
49797152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell:
4980f07771ccSwdenk
4981f07771ccSwdenkOld, simple command line parser:
4982f07771ccSwdenk--------------------------------
4983f07771ccSwdenk
4984f07771ccSwdenk- supports environment variables (through setenv / saveenv commands)
4985f07771ccSwdenk- several commands on one line, separated by ';'
4986fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax
4987f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\',
4988f07771ccSwdenk  for example:
4989fe126d8bSWolfgang Denk	setenv bootcmd bootm \${address}
4990f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example:
4991f07771ccSwdenk	setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
4992f07771ccSwdenk
4993f07771ccSwdenkHush shell:
4994f07771ccSwdenk-----------
4995f07771ccSwdenk
4996f07771ccSwdenk- similar to Bourne shell, with control structures like
4997f07771ccSwdenk  if...then...else...fi, for...do...done; while...do...done,
4998f07771ccSwdenk  until...do...done, ...
4999f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv
5000f07771ccSwdenk  commands) and local shell variables (through standard shell syntax
5001f07771ccSwdenk  "name=value"); only environment variables can be used with "run"
5002f07771ccSwdenk  command
5003f07771ccSwdenk
5004f07771ccSwdenkGeneral rules:
5005f07771ccSwdenk--------------
5006f07771ccSwdenk
5007f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run"
5008f07771ccSwdenk    command) contains several commands separated by semicolon, and
5009f07771ccSwdenk    one of these commands fails, then the remaining commands will be
5010f07771ccSwdenk    executed anyway.
5011f07771ccSwdenk
5012f07771ccSwdenk(2) If you execute several variables with one call to run (i. e.
501311ccc33fSMarcel Ziswiler    calling run with a list of variables as arguments), any failing
5014f07771ccSwdenk    command will cause "run" to terminate, i. e. the remaining
5015f07771ccSwdenk    variables are not executed.
5016f07771ccSwdenk
5017c609719bSwdenkNote for Redundant Ethernet Interfaces:
5018c609719bSwdenk=======================================
5019c609719bSwdenk
502011ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports
5021c609719bSwdenksuch configurations and is capable of automatic selection of a
50227152b1d0Swdenk"working" interface when needed. MAC assignment works as follows:
5023c609719bSwdenk
5024c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding
5025c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0),
5026c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ...
5027c609719bSwdenk
5028c609719bSwdenkIf the network interface stores some valid MAC address (for instance
5029c609719bSwdenkin SROM), this is used as default address if there is NO correspon-
5030c609719bSwdenkding setting in the environment; if the corresponding environment
5031c609719bSwdenkvariable is set, this overrides the settings in the card; that means:
5032c609719bSwdenk
5033c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the
5034c609719bSwdenk  environment, the SROM's address is used.
5035c609719bSwdenk
5036c609719bSwdenko If there is no valid address in the SROM, and a definition in the
5037c609719bSwdenk  environment exists, then the value from the environment variable is
5038c609719bSwdenk  used.
5039c609719bSwdenk
5040c609719bSwdenko If both the SROM and the environment contain a MAC address, and
5041c609719bSwdenk  both addresses are the same, this MAC address is used.
5042c609719bSwdenk
5043c609719bSwdenko If both the SROM and the environment contain a MAC address, and the
5044c609719bSwdenk  addresses differ, the value from the environment is used and a
5045c609719bSwdenk  warning is printed.
5046c609719bSwdenk
5047c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error
5048c609719bSwdenk  is raised.
5049c609719bSwdenk
5050ecee9324SBen WarrenIf Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
5051ecee9324SBen Warrenwill be programmed into hardware as part of the initialization process.	 This
5052ecee9324SBen Warrenmay be skipped by setting the appropriate 'ethmacskip' environment variable.
5053ecee9324SBen WarrenThe naming convention is as follows:
5054ecee9324SBen Warren"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
5055c609719bSwdenk
5056c609719bSwdenkImage Formats:
5057c609719bSwdenk==============
5058c609719bSwdenk
50593310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on)
50603310c549SMarian Balakowiczimages in two formats:
50613310c549SMarian Balakowicz
50623310c549SMarian BalakowiczNew uImage format (FIT)
50633310c549SMarian Balakowicz-----------------------
50643310c549SMarian Balakowicz
50653310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar
50663310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple
50673310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by
50683310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
50693310c549SMarian Balakowicz
50703310c549SMarian Balakowicz
50713310c549SMarian BalakowiczOld uImage format
50723310c549SMarian Balakowicz-----------------
50733310c549SMarian Balakowicz
50743310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything,
50753310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for
50763310c549SMarian Balakowiczdetails; basically, the header defines the following image properties:
5077c609719bSwdenk
5078c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5079c609719bSwdenk  4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
5080f5ed9e39SPeter Tyser  LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5081f5ed9e39SPeter Tyser  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5082f5ed9e39SPeter Tyser  INTEGRITY).
50837b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
5084afc1ce82SMacpaul Lin  IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5085afc1ce82SMacpaul Lin  Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
5086c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2)
5087c609719bSwdenk* Load Address
5088c609719bSwdenk* Entry Point
5089c609719bSwdenk* Image Name
5090c609719bSwdenk* Image Timestamp
5091c609719bSwdenk
5092c609719bSwdenkThe header is marked by a special Magic Number, and both the header
5093c609719bSwdenkand the data portions of the image are secured against corruption by
5094c609719bSwdenkCRC32 checksums.
5095c609719bSwdenk
5096c609719bSwdenk
5097c609719bSwdenkLinux Support:
5098c609719bSwdenk==============
5099c609719bSwdenk
5100c609719bSwdenkAlthough U-Boot should support any OS or standalone application
51017152b1d0Swdenkeasily, the main focus has always been on Linux during the design of
5102c609719bSwdenkU-Boot.
5103c609719bSwdenk
5104c609719bSwdenkU-Boot includes many features that so far have been part of some
5105c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any
5106c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image;
5107c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation
51087152b1d0Swdenkserves several purposes:
5109c609719bSwdenk
5110c609719bSwdenk- the same features can be used for other OS or standalone
5111c609719bSwdenk  applications (for instance: using compressed images to reduce the
5112c609719bSwdenk  Flash memory footprint)
5113c609719bSwdenk
5114c609719bSwdenk- it becomes much easier to port new Linux kernel versions because
51157152b1d0Swdenk  lots of low-level, hardware dependent stuff are done by U-Boot
5116c609719bSwdenk
5117c609719bSwdenk- the same Linux kernel image can now be used with different "initrd"
5118c609719bSwdenk  images; of course this also means that different kernel images can
5119c609719bSwdenk  be run with the same "initrd". This makes testing easier (you don't
5120c609719bSwdenk  have to build a new "zImage.initrd" Linux image when you just
5121c609719bSwdenk  change a file in your "initrd"). Also, a field-upgrade of the
5122c609719bSwdenk  software is easier now.
5123c609719bSwdenk
5124c609719bSwdenk
5125c609719bSwdenkLinux HOWTO:
5126c609719bSwdenk============
5127c609719bSwdenk
5128c609719bSwdenkPorting Linux to U-Boot based systems:
5129c609719bSwdenk---------------------------------------
5130c609719bSwdenk
5131c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to
5132c609719bSwdenkconfigure the Linux device drivers for use with your target hardware
5133c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to
5134c609719bSwdenkLinux :-).
5135c609719bSwdenk
5136a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
5137c609719bSwdenk
5138c609719bSwdenkJust make sure your machine specific header file (for instance
5139c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board
51401dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h,
51411dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value
51426d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR.
5143c609719bSwdenk
5144c609719bSwdenk
5145c609719bSwdenkConfiguring the Linux kernel:
5146c609719bSwdenk-----------------------------
5147c609719bSwdenk
5148c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root
5149c609719bSwdenkdevice (initial ramdisk, NFS) for your target system.
5150c609719bSwdenk
5151c609719bSwdenk
5152c609719bSwdenkBuilding a Linux Image:
5153c609719bSwdenk-----------------------
5154c609719bSwdenk
515524ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are
515624ee89b9Swdenknot used. If you use recent kernel source, a new build target
515724ee89b9Swdenk"uImage" will exist which automatically builds an image usable by
515824ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target,
515924ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a
516024ee89b9Swdenk100% compatible format.
5161c609719bSwdenk
5162c609719bSwdenkExample:
5163c609719bSwdenk
5164c609719bSwdenk	make TQM850L_config
5165c609719bSwdenk	make oldconfig
5166c609719bSwdenk	make dep
516724ee89b9Swdenk	make uImage
5168c609719bSwdenk
516924ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to
517024ee89b9Swdenkencapsulate a compressed Linux kernel image with header	 information,
517124ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing:
5172c609719bSwdenk
517324ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format):
517424ee89b9Swdenk
517524ee89b9Swdenk* convert the kernel into a raw binary image:
517624ee89b9Swdenk
517724ee89b9Swdenk	${CROSS_COMPILE}-objcopy -O binary \
517824ee89b9Swdenk				 -R .note -R .comment \
517924ee89b9Swdenk				 -S vmlinux linux.bin
518024ee89b9Swdenk
518124ee89b9Swdenk* compress the binary image:
518224ee89b9Swdenk
518324ee89b9Swdenk	gzip -9 linux.bin
518424ee89b9Swdenk
518524ee89b9Swdenk* package compressed binary image for U-Boot:
518624ee89b9Swdenk
518724ee89b9Swdenk	mkimage -A ppc -O linux -T kernel -C gzip \
518824ee89b9Swdenk		-a 0 -e 0 -n "Linux Kernel Image" \
518924ee89b9Swdenk		-d linux.bin.gz uImage
519024ee89b9Swdenk
519124ee89b9Swdenk
519224ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use
519324ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or
519424ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64
519524ee89b9Swdenkbyte header containing information about target architecture,
519624ee89b9Swdenkoperating system, image type, compression method, entry points, time
519724ee89b9Swdenkstamp, CRC32 checksums, etc.
519824ee89b9Swdenk
519924ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and
520024ee89b9Swdenkprint the header information, or to build new images.
5201c609719bSwdenk
5202c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information
5203c609719bSwdenkcontained in the header of an existing U-Boot image; this includes
5204c609719bSwdenkchecksum verification:
5205c609719bSwdenk
5206c609719bSwdenk	tools/mkimage -l image
5207c609719bSwdenk	  -l ==> list image header information
5208c609719bSwdenk
5209c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image
5210c609719bSwdenkfrom a "data file" which is used as image payload:
5211c609719bSwdenk
5212c609719bSwdenk	tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5213c609719bSwdenk		      -n name -d data_file image
5214c609719bSwdenk	  -A ==> set architecture to 'arch'
5215c609719bSwdenk	  -O ==> set operating system to 'os'
5216c609719bSwdenk	  -T ==> set image type to 'type'
5217c609719bSwdenk	  -C ==> set compression type 'comp'
5218c609719bSwdenk	  -a ==> set load address to 'addr' (hex)
5219c609719bSwdenk	  -e ==> set entry point to 'ep' (hex)
5220c609719bSwdenk	  -n ==> set image name to 'name'
5221c609719bSwdenk	  -d ==> use image data from 'datafile'
5222c609719bSwdenk
522369459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load
522469459791Swdenkaddress (0x00000000), but the entry point address depends on the
522569459791Swdenkkernel version:
5226c609719bSwdenk
5227c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C,
522824ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000.
5229c609719bSwdenk
5230c609719bSwdenkSo a typical call to build a U-Boot image would read:
5231c609719bSwdenk
523224ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
523324ee89b9Swdenk	> -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
5234a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
523524ee89b9Swdenk	> examples/uImage.TQM850L
523624ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5237c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5238c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
5239c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
5240c609719bSwdenk	Load Address: 0x00000000
524124ee89b9Swdenk	Entry Point:  0x00000000
5242c609719bSwdenk
5243c609719bSwdenkTo verify the contents of the image (or check for corruption):
5244c609719bSwdenk
524524ee89b9Swdenk	-> tools/mkimage -l examples/uImage.TQM850L
524624ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5247c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5248c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
5249c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
5250c609719bSwdenk	Load Address: 0x00000000
525124ee89b9Swdenk	Entry Point:  0x00000000
5252c609719bSwdenk
5253c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade
5254c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this
5255c609719bSwdenkneeds more space in Flash, but boots much faster since it does not
5256c609719bSwdenkneed to be uncompressed:
5257c609719bSwdenk
5258a47a12beSStefan Roese	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
525924ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
526024ee89b9Swdenk	> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
5261a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
526224ee89b9Swdenk	> examples/uImage.TQM850L-uncompressed
526324ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5264c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5265c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (uncompressed)
5266c609719bSwdenk	Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
5267c609719bSwdenk	Load Address: 0x00000000
526824ee89b9Swdenk	Entry Point:  0x00000000
5269c609719bSwdenk
5270c609719bSwdenk
5271c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file
5272c609719bSwdenkwhen your kernel is intended to use an initial ramdisk:
5273c609719bSwdenk
5274c609719bSwdenk	-> tools/mkimage -n 'Simple Ramdisk Image' \
5275c609719bSwdenk	> -A ppc -O linux -T ramdisk -C gzip \
5276c609719bSwdenk	> -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5277c609719bSwdenk	Image Name:   Simple Ramdisk Image
5278c609719bSwdenk	Created:      Wed Jan 12 14:01:50 2000
5279c609719bSwdenk	Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
5280c609719bSwdenk	Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
5281c609719bSwdenk	Load Address: 0x00000000
5282c609719bSwdenk	Entry Point:  0x00000000
5283c609719bSwdenk
5284a804b5ceSGuilherme Maciel FerreiraThe "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5285a804b5ceSGuilherme Maciel Ferreiraoption performs the converse operation of the mkimage's second form (the "-d"
5286a804b5ceSGuilherme Maciel Ferreiraoption). Given an image built by mkimage, the dumpimage extracts a "data file"
5287a804b5ceSGuilherme Maciel Ferreirafrom the image:
5288a804b5ceSGuilherme Maciel Ferreira
5289a804b5ceSGuilherme Maciel Ferreira	tools/dumpimage -i image -p position data_file
5290a804b5ceSGuilherme Maciel Ferreira	  -i ==> extract from the 'image' a specific 'data_file', \
5291a804b5ceSGuilherme Maciel Ferreira	   indexed by 'position'
5292a804b5ceSGuilherme Maciel Ferreira
5293c609719bSwdenk
5294c609719bSwdenkInstalling a Linux Image:
5295c609719bSwdenk-------------------------
5296c609719bSwdenk
5297c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface,
5298c609719bSwdenkyou must convert the image to S-Record format:
5299c609719bSwdenk
5300c609719bSwdenk	objcopy -I binary -O srec examples/image examples/image.srec
5301c609719bSwdenk
5302c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot
5303c609719bSwdenkimage header, so the resulting S-Record file will be relative to
5304c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to
5305c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads'
5306c609719bSwdenkcommand.
5307c609719bSwdenk
5308c609719bSwdenkExample: install the image to address 0x40100000 (which on the
5309c609719bSwdenkTQM8xxL is in the first Flash bank):
5310c609719bSwdenk
5311c609719bSwdenk	=> erase 40100000 401FFFFF
5312c609719bSwdenk
5313c609719bSwdenk	.......... done
5314c609719bSwdenk	Erased 8 sectors
5315c609719bSwdenk
5316c609719bSwdenk	=> loads 40100000
5317c609719bSwdenk	## Ready for S-Record download ...
5318c609719bSwdenk	~>examples/image.srec
5319c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5320c609719bSwdenk	...
5321c609719bSwdenk	15989 15990 15991 15992
5322c609719bSwdenk	[file transfer complete]
5323c609719bSwdenk	[connected]
5324c609719bSwdenk	## Start Addr = 0x00000000
5325c609719bSwdenk
5326c609719bSwdenk
5327c609719bSwdenkYou can check the success of the download using the 'iminfo' command;
5328c609719bSwdenkthis includes a checksum verification so you can be sure no data
5329c609719bSwdenkcorruption happened:
5330c609719bSwdenk
5331c609719bSwdenk	=> imi 40100000
5332c609719bSwdenk
5333c609719bSwdenk	## Checking Image at 40100000 ...
5334c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5335c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5336c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5337c609719bSwdenk	   Load Address: 00000000
5338c609719bSwdenk	   Entry Point:	 0000000c
5339c609719bSwdenk	   Verifying Checksum ... OK
5340c609719bSwdenk
5341c609719bSwdenk
5342c609719bSwdenkBoot Linux:
5343c609719bSwdenk-----------
5344c609719bSwdenk
5345c609719bSwdenkThe "bootm" command is used to boot an application that is stored in
5346c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents
5347c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as
5348c609719bSwdenkparameters. You can check and modify this variable using the
5349c609719bSwdenk"printenv" and "setenv" commands:
5350c609719bSwdenk
5351c609719bSwdenk
5352c609719bSwdenk	=> printenv bootargs
5353c609719bSwdenk	bootargs=root=/dev/ram
5354c609719bSwdenk
5355c609719bSwdenk	=> setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5356c609719bSwdenk
5357c609719bSwdenk	=> printenv bootargs
5358c609719bSwdenk	bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5359c609719bSwdenk
5360c609719bSwdenk	=> bootm 40020000
5361c609719bSwdenk	## Booting Linux kernel at 40020000 ...
5362c609719bSwdenk	   Image Name:	 2.2.13 for NFS on TQM850L
5363c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5364c609719bSwdenk	   Data Size:	 381681 Bytes = 372 kB = 0 MB
5365c609719bSwdenk	   Load Address: 00000000
5366c609719bSwdenk	   Entry Point:	 0000000c
5367c609719bSwdenk	   Verifying Checksum ... OK
5368c609719bSwdenk	   Uncompressing Kernel Image ... OK
5369c609719bSwdenk	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
5370c609719bSwdenk	Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5371c609719bSwdenk	time_init: decrementer frequency = 187500000/60
5372c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
5373c609719bSwdenk	Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5374c609719bSwdenk	...
5375c609719bSwdenk
537611ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass
53777152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT
5378c609719bSwdenkformat!) to the "bootm" command:
5379c609719bSwdenk
5380c609719bSwdenk	=> imi 40100000 40200000
5381c609719bSwdenk
5382c609719bSwdenk	## Checking Image at 40100000 ...
5383c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5384c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5385c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5386c609719bSwdenk	   Load Address: 00000000
5387c609719bSwdenk	   Entry Point:	 0000000c
5388c609719bSwdenk	   Verifying Checksum ... OK
5389c609719bSwdenk
5390c609719bSwdenk	## Checking Image at 40200000 ...
5391c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
5392c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
5393c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
5394c609719bSwdenk	   Load Address: 00000000
5395c609719bSwdenk	   Entry Point:	 00000000
5396c609719bSwdenk	   Verifying Checksum ... OK
5397c609719bSwdenk
5398c609719bSwdenk	=> bootm 40100000 40200000
5399c609719bSwdenk	## Booting Linux kernel at 40100000 ...
5400c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5401c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5402c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5403c609719bSwdenk	   Load Address: 00000000
5404c609719bSwdenk	   Entry Point:	 0000000c
5405c609719bSwdenk	   Verifying Checksum ... OK
5406c609719bSwdenk	   Uncompressing Kernel Image ... OK
5407c609719bSwdenk	## Loading RAMDisk Image at 40200000 ...
5408c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
5409c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
5410c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
5411c609719bSwdenk	   Load Address: 00000000
5412c609719bSwdenk	   Entry Point:	 00000000
5413c609719bSwdenk	   Verifying Checksum ... OK
5414c609719bSwdenk	   Loading Ramdisk ... OK
5415c609719bSwdenk	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
5416c609719bSwdenk	Boot arguments: root=/dev/ram
5417c609719bSwdenk	time_init: decrementer frequency = 187500000/60
5418c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
5419c609719bSwdenk	...
5420c609719bSwdenk	RAMDISK: Compressed image found at block 0
5421c609719bSwdenk	VFS: Mounted root (ext2 filesystem).
5422c609719bSwdenk
5423c609719bSwdenk	bash#
5424c609719bSwdenk
54250267768eSMatthew McClintockBoot Linux and pass a flat device tree:
54260267768eSMatthew McClintock-----------
54270267768eSMatthew McClintock
54280267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section
54290267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The
54300267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated
54310267768eSMatthew McClintockflat device tree:
54320267768eSMatthew McClintock
54330267768eSMatthew McClintock=> print oftaddr
54340267768eSMatthew McClintockoftaddr=0x300000
54350267768eSMatthew McClintock=> print oft
54360267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb
54370267768eSMatthew McClintock=> tftp $oftaddr $oft
54380267768eSMatthew McClintockSpeed: 1000, full duplex
54390267768eSMatthew McClintockUsing TSEC0 device
54400267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101
54410267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'.
54420267768eSMatthew McClintockLoad address: 0x300000
54430267768eSMatthew McClintockLoading: #
54440267768eSMatthew McClintockdone
54450267768eSMatthew McClintockBytes transferred = 4106 (100a hex)
54460267768eSMatthew McClintock=> tftp $loadaddr $bootfile
54470267768eSMatthew McClintockSpeed: 1000, full duplex
54480267768eSMatthew McClintockUsing TSEC0 device
54490267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2
54500267768eSMatthew McClintockFilename 'uImage'.
54510267768eSMatthew McClintockLoad address: 0x200000
54520267768eSMatthew McClintockLoading:############
54530267768eSMatthew McClintockdone
54540267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex)
54550267768eSMatthew McClintock=> print loadaddr
54560267768eSMatthew McClintockloadaddr=200000
54570267768eSMatthew McClintock=> print oftaddr
54580267768eSMatthew McClintockoftaddr=0x300000
54590267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr
54600267768eSMatthew McClintock## Booting image at 00200000 ...
54610267768eSMatthew McClintock   Image Name:	 Linux-2.6.17-dirty
54620267768eSMatthew McClintock   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
54630267768eSMatthew McClintock   Data Size:	 1029343 Bytes = 1005.2 kB
54640267768eSMatthew McClintock   Load Address: 00000000
54650267768eSMatthew McClintock   Entry Point:	 00000000
54660267768eSMatthew McClintock   Verifying Checksum ... OK
54670267768eSMatthew McClintock   Uncompressing Kernel Image ... OK
54680267768eSMatthew McClintockBooting using flat device tree at 0x300000
54690267768eSMatthew McClintockUsing MPC85xx ADS machine description
54700267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
54710267768eSMatthew McClintock[snip]
54720267768eSMatthew McClintock
54730267768eSMatthew McClintock
54746069ff26SwdenkMore About U-Boot Image Types:
54756069ff26Swdenk------------------------------
54766069ff26Swdenk
54776069ff26SwdenkU-Boot supports the following image types:
54786069ff26Swdenk
54796069ff26Swdenk   "Standalone Programs" are directly runnable in the environment
54806069ff26Swdenk	provided by U-Boot; it is expected that (if they behave
54816069ff26Swdenk	well) you can continue to work in U-Boot after return from
54826069ff26Swdenk	the Standalone Program.
54836069ff26Swdenk   "OS Kernel Images" are usually images of some Embedded OS which
54846069ff26Swdenk	will take over control completely. Usually these programs
54856069ff26Swdenk	will install their own set of exception handlers, device
54866069ff26Swdenk	drivers, set up the MMU, etc. - this means, that you cannot
54876069ff26Swdenk	expect to re-enter U-Boot except by resetting the CPU.
54886069ff26Swdenk   "RAMDisk Images" are more or less just data blocks, and their
54896069ff26Swdenk	parameters (address, size) are passed to an OS kernel that is
54906069ff26Swdenk	being started.
54916069ff26Swdenk   "Multi-File Images" contain several images, typically an OS
54926069ff26Swdenk	(Linux) kernel image and one or more data images like
54936069ff26Swdenk	RAMDisks. This construct is useful for instance when you want
54946069ff26Swdenk	to boot over the network using BOOTP etc., where the boot
54956069ff26Swdenk	server provides just a single image file, but you want to get
54966069ff26Swdenk	for instance an OS kernel and a RAMDisk image.
54976069ff26Swdenk
54986069ff26Swdenk	"Multi-File Images" start with a list of image sizes, each
54996069ff26Swdenk	image size (in bytes) specified by an "uint32_t" in network
55006069ff26Swdenk	byte order. This list is terminated by an "(uint32_t)0".
55016069ff26Swdenk	Immediately after the terminating 0 follow the images, one by
55026069ff26Swdenk	one, all aligned on "uint32_t" boundaries (size rounded up to
55036069ff26Swdenk	a multiple of 4 bytes).
55046069ff26Swdenk
55056069ff26Swdenk   "Firmware Images" are binary images containing firmware (like
55066069ff26Swdenk	U-Boot or FPGA images) which usually will be programmed to
55076069ff26Swdenk	flash memory.
55086069ff26Swdenk
55096069ff26Swdenk   "Script files" are command sequences that will be executed by
55106069ff26Swdenk	U-Boot's command interpreter; this feature is especially
55116069ff26Swdenk	useful when you configure U-Boot to use a real shell (hush)
55126069ff26Swdenk	as command interpreter.
55136069ff26Swdenk
551444f074c7SMarek VasutBooting the Linux zImage:
551544f074c7SMarek Vasut-------------------------
551644f074c7SMarek Vasut
551744f074c7SMarek VasutOn some platforms, it's possible to boot Linux zImage. This is done
551844f074c7SMarek Vasutusing the "bootz" command. The syntax of "bootz" command is the same
551944f074c7SMarek Vasutas the syntax of "bootm" command.
552044f074c7SMarek Vasut
55218ac28563STom RiniNote, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
5522017e1f3fSMarek Vasutkernel with raw initrd images. The syntax is slightly different, the
5523017e1f3fSMarek Vasutaddress of the initrd must be augmented by it's size, in the following
5524017e1f3fSMarek Vasutformat: "<initrd addres>:<initrd size>".
5525017e1f3fSMarek Vasut
5526c609719bSwdenk
5527c609719bSwdenkStandalone HOWTO:
5528c609719bSwdenk=================
5529c609719bSwdenk
5530c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and
5531c609719bSwdenkrun "standalone" applications, which can use some resources of
5532c609719bSwdenkU-Boot like console I/O functions or interrupt services.
5533c609719bSwdenk
5534c609719bSwdenkTwo simple examples are included with the sources:
5535c609719bSwdenk
5536c609719bSwdenk"Hello World" Demo:
5537c609719bSwdenk-------------------
5538c609719bSwdenk
5539c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo
5540c609719bSwdenkapplication; it is automatically compiled when you build U-Boot.
5541c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it
5542c609719bSwdenklike that:
5543c609719bSwdenk
5544c609719bSwdenk	=> loads
5545c609719bSwdenk	## Ready for S-Record download ...
5546c609719bSwdenk	~>examples/hello_world.srec
5547c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
5548c609719bSwdenk	[file transfer complete]
5549c609719bSwdenk	[connected]
5550c609719bSwdenk	## Start Addr = 0x00040004
5551c609719bSwdenk
5552c609719bSwdenk	=> go 40004 Hello World! This is a test.
5553c609719bSwdenk	## Starting application at 0x00040004 ...
5554c609719bSwdenk	Hello World
5555c609719bSwdenk	argc = 7
5556c609719bSwdenk	argv[0] = "40004"
5557c609719bSwdenk	argv[1] = "Hello"
5558c609719bSwdenk	argv[2] = "World!"
5559c609719bSwdenk	argv[3] = "This"
5560c609719bSwdenk	argv[4] = "is"
5561c609719bSwdenk	argv[5] = "a"
5562c609719bSwdenk	argv[6] = "test."
5563c609719bSwdenk	argv[7] = "<NULL>"
5564c609719bSwdenk	Hit any key to exit ...
5565c609719bSwdenk
5566c609719bSwdenk	## Application terminated, rc = 0x0
5567c609719bSwdenk
5568c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt
5569c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'.
5570c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second.
5571c609719bSwdenkThe interrupt service routine is trivial, just printing a '.'
5572c609719bSwdenkcharacter, but this is just a demo program. The application can be
5573c609719bSwdenkcontrolled by the following keys:
5574c609719bSwdenk
5575c609719bSwdenk	? - print current values og the CPM Timer registers
5576c609719bSwdenk	b - enable interrupts and start timer
5577c609719bSwdenk	e - stop timer and disable interrupts
5578c609719bSwdenk	q - quit application
5579c609719bSwdenk
5580c609719bSwdenk	=> loads
5581c609719bSwdenk	## Ready for S-Record download ...
5582c609719bSwdenk	~>examples/timer.srec
5583c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
5584c609719bSwdenk	[file transfer complete]
5585c609719bSwdenk	[connected]
5586c609719bSwdenk	## Start Addr = 0x00040004
5587c609719bSwdenk
5588c609719bSwdenk	=> go 40004
5589c609719bSwdenk	## Starting application at 0x00040004 ...
5590c609719bSwdenk	TIMERS=0xfff00980
5591c609719bSwdenk	Using timer 1
5592c609719bSwdenk	  tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
5593c609719bSwdenk
5594c609719bSwdenkHit 'b':
5595c609719bSwdenk	[q, b, e, ?] Set interval 1000000 us
5596c609719bSwdenk	Enabling timer
5597c609719bSwdenkHit '?':
5598c609719bSwdenk	[q, b, e, ?] ........
5599c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
5600c609719bSwdenkHit '?':
5601c609719bSwdenk	[q, b, e, ?] .
5602c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
5603c609719bSwdenkHit '?':
5604c609719bSwdenk	[q, b, e, ?] .
5605c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
5606c609719bSwdenkHit '?':
5607c609719bSwdenk	[q, b, e, ?] .
5608c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
5609c609719bSwdenkHit 'e':
5610c609719bSwdenk	[q, b, e, ?] ...Stopping timer
5611c609719bSwdenkHit 'q':
5612c609719bSwdenk	[q, b, e, ?] ## Application terminated, rc = 0x0
5613c609719bSwdenk
5614c609719bSwdenk
561585ec0bccSwdenkMinicom warning:
561685ec0bccSwdenk================
561785ec0bccSwdenk
56187152b1d0SwdenkOver time, many people have reported problems when trying to use the
561985ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd)
562085ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under
5621f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and
562285ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and
5623e53515a2SKarl O. Pincuse "cu" for S-Record download ("loads" command).  See
5624e53515a2SKarl O. Pinchttp://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
5625e53515a2SKarl O. Pincfor help with kermit.
5626e53515a2SKarl O. Pinc
562785ec0bccSwdenk
562852f52c14SwdenkNevertheless, if you absolutely want to use it try adding this
562952f52c14Swdenkconfiguration to your "File transfer protocols" section:
563052f52c14Swdenk
563152f52c14Swdenk	   Name	   Program			Name U/D FullScr IO-Red. Multi
563252f52c14Swdenk	X  kermit  /usr/bin/kermit -i -l %l -s	 Y    U	   Y	   N	  N
563352f52c14Swdenk	Y  kermit  /usr/bin/kermit -i -l %l -r	 N    D	   Y	   N	  N
563452f52c14Swdenk
563552f52c14Swdenk
5636c609719bSwdenkNetBSD Notes:
5637c609719bSwdenk=============
5638c609719bSwdenk
5639c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host
5640c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx).
5641c609719bSwdenk
5642c609719bSwdenkBuilding requires a cross environment; it is known to work on
5643c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5644c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make).
5645c609719bSwdenkNote that the cross-powerpc package does not install include files;
5646c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is
5647c609719bSwdenkmissing.  This file has to be installed and patched manually:
5648c609719bSwdenk
5649c609719bSwdenk	# cd /usr/pkg/cross/powerpc-netbsd/include
5650c609719bSwdenk	# mkdir powerpc
5651c609719bSwdenk	# ln -s powerpc machine
5652c609719bSwdenk	# cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
5653c609719bSwdenk	# ${EDIT} powerpc/ansi.h	## must remove __va_list, _BSD_VA_LIST
5654c609719bSwdenk
5655c609719bSwdenkNative builds *don't* work due to incompatibilities between native
5656c609719bSwdenkand U-Boot include files.
5657c609719bSwdenk
5658c609719bSwdenkBooting assumes that (the first part of) the image booted is a
5659c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel
5660c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source
5661c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
56622a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
5663c609719bSwdenk
5664c609719bSwdenk
5665c609719bSwdenkImplementation Internals:
5666c609719bSwdenk=========================
5667c609719bSwdenk
5668c609719bSwdenkThe following is not intended to be a complete description of every
5669c609719bSwdenkimplementation detail. However, it should help to understand the
5670c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom
5671c609719bSwdenkhardware.
5672c609719bSwdenk
5673c609719bSwdenk
5674c609719bSwdenkInitial Stack, Global Data:
5675c609719bSwdenk---------------------------
5676c609719bSwdenk
5677c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot
5678c609719bSwdenkstarts running out of ROM (flash memory), usually without access to
5679c609719bSwdenksystem RAM (because the memory controller is not initialized yet).
5680c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS
5681c609719bSwdenkis not initialized as zero. To be able to get a C environment working
5682c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation
5683c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU
5684c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and
5685c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be
5686c609719bSwdenklocked as (mis-) used as memory, etc.
5687c609719bSwdenk
56887152b1d0Swdenk	Chris Hallinan posted a good summary of these issues to the
56890668236bSWolfgang Denk	U-Boot mailing list:
569043d9616cSwdenk
569143d9616cSwdenk	Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
569243d9616cSwdenk	From: "Chris Hallinan" <clh@net1plus.com>
569343d9616cSwdenk	Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
569443d9616cSwdenk	...
569543d9616cSwdenk
569643d9616cSwdenk	Correct me if I'm wrong, folks, but the way I understand it
569743d9616cSwdenk	is this: Using DCACHE as initial RAM for Stack, etc, does not
569843d9616cSwdenk	require any physical RAM backing up the cache. The cleverness
569943d9616cSwdenk	is that the cache is being used as a temporary supply of
570043d9616cSwdenk	necessary storage before the SDRAM controller is setup. It's
570111ccc33fSMarcel Ziswiler	beyond the scope of this list to explain the details, but you
570243d9616cSwdenk	can see how this works by studying the cache architecture and
570343d9616cSwdenk	operation in the architecture and processor-specific manuals.
570443d9616cSwdenk
570543d9616cSwdenk	OCM is On Chip Memory, which I believe the 405GP has 4K. It
570643d9616cSwdenk	is another option for the system designer to use as an
570711ccc33fSMarcel Ziswiler	initial stack/RAM area prior to SDRAM being available. Either
570843d9616cSwdenk	option should work for you. Using CS 4 should be fine if your
570943d9616cSwdenk	board designers haven't used it for something that would
571043d9616cSwdenk	cause you grief during the initial boot! It is frequently not
571143d9616cSwdenk	used.
571243d9616cSwdenk
57136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
571443d9616cSwdenk	with your processor/board/system design. The default value
571543d9616cSwdenk	you will find in any recent u-boot distribution in
57168a316c9bSStefan Roese	walnut.h should work for you. I'd set it to a value larger
571743d9616cSwdenk	than your SDRAM module. If you have a 64MB SDRAM module, set
571843d9616cSwdenk	it above 400_0000. Just make sure your board has no resources
571943d9616cSwdenk	that are supposed to respond to that address! That code in
572043d9616cSwdenk	start.S has been around a while and should work as is when
572143d9616cSwdenk	you get the config right.
572243d9616cSwdenk
572343d9616cSwdenk	-Chris Hallinan
572443d9616cSwdenk	DS4.COM, Inc.
572543d9616cSwdenk
5726c609719bSwdenkIt is essential to remember this, since it has some impact on the C
5727c609719bSwdenkcode for the initialization procedures:
5728c609719bSwdenk
5729c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt
5730c609719bSwdenk  to write it.
5731c609719bSwdenk
573211ccc33fSMarcel Ziswiler* Do not use any uninitialized global data (or implicitely initialized
5733c609719bSwdenk  as zero data - BSS segment) at all - this is undefined, initiali-
57347152b1d0Swdenk  zation is performed later (when relocating to RAM).
5735c609719bSwdenk
5736c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like
5737c609719bSwdenk  that.
5738c609719bSwdenk
5739c609719bSwdenkHaving only the stack as writable memory limits means we cannot use
5740c609719bSwdenknormal global data to share information beween the code. But it
5741c609719bSwdenkturned out that the implementation of U-Boot can be greatly
5742c609719bSwdenksimplified by making a global data structure (gd_t) available to all
5743c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_
5744c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of
5745c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we
5746c609719bSwdenkplace a pointer (gd) to the global data into a register which we
5747c609719bSwdenkreserve for this purpose.
5748c609719bSwdenk
57497152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the
5750c609719bSwdenkrelevant  (E)ABI  specifications for the current architecture, and by
5751c609719bSwdenkGCC's implementation.
5752c609719bSwdenk
5753c609719bSwdenkFor PowerPC, the following registers have specific use:
5754c609719bSwdenk	R1:	stack pointer
5755e7670f6cSWolfgang Denk	R2:	reserved for system use
5756c609719bSwdenk	R3-R4:	parameter passing and return values
5757c609719bSwdenk	R5-R10: parameter passing
5758c609719bSwdenk	R13:	small data area pointer
5759c609719bSwdenk	R30:	GOT pointer
5760c609719bSwdenk	R31:	frame pointer
5761c609719bSwdenk
5762e6bee808SJoakim Tjernlund	(U-Boot also uses R12 as internal GOT pointer. r12
5763e6bee808SJoakim Tjernlund	is a volatile register so r12 needs to be reset when
5764e6bee808SJoakim Tjernlund	going back and forth between asm and C)
5765c609719bSwdenk
5766e7670f6cSWolfgang Denk    ==> U-Boot will use R2 to hold a pointer to the global data
5767c609719bSwdenk
5768c609719bSwdenk    Note: on PPC, we could use a static initializer (since the
5769c609719bSwdenk    address of the global data structure is known at compile time),
5770c609719bSwdenk    but it turned out that reserving a register results in somewhat
5771c609719bSwdenk    smaller code - although the code savings are not that big (on
5772c609719bSwdenk    average for all boards 752 bytes for the whole U-Boot image,
5773c609719bSwdenk    624 text + 127 data).
5774c609719bSwdenk
5775c4db335cSRobin GetzOn Blackfin, the normal C ABI (except for P3) is followed as documented here:
57764c58eb55SMike Frysinger	http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
57774c58eb55SMike Frysinger
5778c4db335cSRobin Getz    ==> U-Boot will use P3 to hold a pointer to the global data
57794c58eb55SMike Frysinger
5780c609719bSwdenkOn ARM, the following registers are used:
5781c609719bSwdenk
5782c609719bSwdenk	R0:	function argument word/integer result
5783c609719bSwdenk	R1-R3:	function argument word
578412eba1b4SJeroen Hofstee	R9:	platform specific
578512eba1b4SJeroen Hofstee	R10:	stack limit (used only if stack checking is enabled)
5786c609719bSwdenk	R11:	argument (frame) pointer
5787c609719bSwdenk	R12:	temporary workspace
5788c609719bSwdenk	R13:	stack pointer
5789c609719bSwdenk	R14:	link register
5790c609719bSwdenk	R15:	program counter
5791c609719bSwdenk
579212eba1b4SJeroen Hofstee    ==> U-Boot will use R9 to hold a pointer to the global data
579312eba1b4SJeroen Hofstee
579412eba1b4SJeroen Hofstee    Note: on ARM, only R_ARM_RELATIVE relocations are supported.
5795c609719bSwdenk
57960df01fd3SThomas ChouOn Nios II, the ABI is documented here:
57970df01fd3SThomas Chou	http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
57980df01fd3SThomas Chou
57990df01fd3SThomas Chou    ==> U-Boot will use gp to hold a pointer to the global data
58000df01fd3SThomas Chou
58010df01fd3SThomas Chou    Note: on Nios II, we give "-G0" option to gcc and don't use gp
58020df01fd3SThomas Chou    to access small data sections, so gp is free.
58030df01fd3SThomas Chou
5804afc1ce82SMacpaul LinOn NDS32, the following registers are used:
5805afc1ce82SMacpaul Lin
5806afc1ce82SMacpaul Lin	R0-R1:	argument/return
5807afc1ce82SMacpaul Lin	R2-R5:	argument
5808afc1ce82SMacpaul Lin	R15:	temporary register for assembler
5809afc1ce82SMacpaul Lin	R16:	trampoline register
5810afc1ce82SMacpaul Lin	R28:	frame pointer (FP)
5811afc1ce82SMacpaul Lin	R29:	global pointer (GP)
5812afc1ce82SMacpaul Lin	R30:	link register (LP)
5813afc1ce82SMacpaul Lin	R31:	stack pointer (SP)
5814afc1ce82SMacpaul Lin	PC:	program counter (PC)
5815afc1ce82SMacpaul Lin
5816afc1ce82SMacpaul Lin    ==> U-Boot will use R10 to hold a pointer to the global data
5817afc1ce82SMacpaul Lin
5818d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5819d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much.
5820c609719bSwdenk
5821c609719bSwdenkMemory Management:
5822c609719bSwdenk------------------
5823c609719bSwdenk
5824c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the
5825c609719bSwdenkMMU is not used either for address mapping nor for memory protection.
5826c609719bSwdenk
5827c609719bSwdenkThe available memory is mapped to fixed addresses using the memory
5828c609719bSwdenkcontroller. In this process, a contiguous block is formed for each
5829c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several
5830c609719bSwdenkphysical memory banks.
5831c609719bSwdenk
5832c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on
5833c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5834c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself
5835c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some
58366d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
5837c609719bSwdenkconfiguration setting]. Below that, a structure with global Board
5838c609719bSwdenkInfo data is placed, followed by the stack (growing downward).
5839c609719bSwdenk
5840c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB
5841c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF).
5842c609719bSwdenk
5843c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like
5844c609719bSwdenkthis:
5845c609719bSwdenk
5846c609719bSwdenk	0x0000 0000	Exception Vector code
5847c609719bSwdenk	      :
5848c609719bSwdenk	0x0000 1FFF
5849c609719bSwdenk	0x0000 2000	Free for Application Use
5850c609719bSwdenk	      :
5851c609719bSwdenk	      :
5852c609719bSwdenk
5853c609719bSwdenk	      :
5854c609719bSwdenk	      :
5855c609719bSwdenk	0x00FB FF20	Monitor Stack (Growing downward)
5856c609719bSwdenk	0x00FB FFAC	Board Info Data and permanent copy of global data
5857c609719bSwdenk	0x00FC 0000	Malloc Arena
5858c609719bSwdenk	      :
5859c609719bSwdenk	0x00FD FFFF
5860c609719bSwdenk	0x00FE 0000	RAM Copy of Monitor Code
5861c609719bSwdenk	...		eventually: LCD or video framebuffer
5862c609719bSwdenk	...		eventually: pRAM (Protected RAM - unchanged by reset)
5863c609719bSwdenk	0x00FF FFFF	[End of RAM]
5864c609719bSwdenk
5865c609719bSwdenk
5866c609719bSwdenkSystem Initialization:
5867c609719bSwdenk----------------------
5868c609719bSwdenk
5869c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point
587011ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset
5871c609719bSwdenkconfiguration for CS0# this is a mirror of the onboard Flash memory.
58727152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address.
5873c609719bSwdenkTo be able to implement the initialization code in C, a (small!)
5874c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs
5875c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked
5876c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core,
5877c609719bSwdenkthe caches and the SIU.
5878c609719bSwdenk
5879c609719bSwdenkNext, all (potentially) available memory banks are mapped using a
5880c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries
5881c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5882c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5883c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a
5884c609719bSwdenksimple memory test is run that determines the size of the SDRAM
5885c609719bSwdenkbanks.
5886c609719bSwdenk
5887c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of
58887152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first
5889c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address
5890c609719bSwdenk0x00000000, with any additional banks following immediately to create
5891c609719bSwdenkcontiguous memory starting from 0.
5892c609719bSwdenk
5893c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area
5894c609719bSwdenkand allocates memory for use by malloc() and for the global Board
5895c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM
5896c609719bSwdenkpages, and the final stack is set up.
5897c609719bSwdenk
5898c609719bSwdenkOnly after this relocation will you have a "normal" C environment;
5899c609719bSwdenkuntil that you are restricted in several ways, mostly because you are
5900c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a
5901c609719bSwdenknew address in RAM.
5902c609719bSwdenk
5903c609719bSwdenk
5904c609719bSwdenkU-Boot Porting Guide:
5905c609719bSwdenk----------------------
5906c609719bSwdenk
5907c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
59086aff3115Swdenklist, October 2002]
5909c609719bSwdenk
5910c609719bSwdenk
5911c609719bSwdenkint main(int argc, char *argv[])
5912c609719bSwdenk{
5913c609719bSwdenk	sighandler_t no_more_time;
5914c609719bSwdenk
5915c609719bSwdenk	signal(SIGALRM, no_more_time);
5916c609719bSwdenk	alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
5917c609719bSwdenk
5918c609719bSwdenk	if (available_money > available_manpower) {
59196c3fef28SJerry Van Baren		Pay consultant to port U-Boot;
5920c609719bSwdenk		return 0;
5921c609719bSwdenk	}
5922c609719bSwdenk
5923c609719bSwdenk	Download latest U-Boot source;
5924c609719bSwdenk
59250668236bSWolfgang Denk	Subscribe to u-boot mailing list;
59266aff3115Swdenk
59276c3fef28SJerry Van Baren	if (clueless)
5928c609719bSwdenk		email("Hi, I am new to U-Boot, how do I get started?");
5929c609719bSwdenk
5930c609719bSwdenk	while (learning) {
5931c609719bSwdenk		Read the README file in the top level directory;
59327cb22f97Swdenk		Read http://www.denx.de/twiki/bin/view/DULG/Manual;
59336c3fef28SJerry Van Baren		Read applicable doc/*.README;
5934c609719bSwdenk		Read the source, Luke;
59356c3fef28SJerry Van Baren		/* find . -name "*.[chS]" | xargs grep -i <keyword> */
5936c609719bSwdenk	}
5937c609719bSwdenk
59386c3fef28SJerry Van Baren	if (available_money > toLocalCurrency ($2500))
59396c3fef28SJerry Van Baren		Buy a BDI3000;
59406c3fef28SJerry Van Baren	else
5941c609719bSwdenk		Add a lot of aggravation and time;
5942c609719bSwdenk
59436c3fef28SJerry Van Baren	if (a similar board exists) {	/* hopefully... */
59446c3fef28SJerry Van Baren		cp -a board/<similar> board/<myboard>
59456c3fef28SJerry Van Baren		cp include/configs/<similar>.h include/configs/<myboard>.h
59466c3fef28SJerry Van Baren	} else {
5947c609719bSwdenk		Create your own board support subdirectory;
59486c3fef28SJerry Van Baren		Create your own board include/configs/<myboard>.h file;
59496c3fef28SJerry Van Baren	}
59506c3fef28SJerry Van Baren	Edit new board/<myboard> files
59516c3fef28SJerry Van Baren	Edit new include/configs/<myboard>.h
5952c609719bSwdenk
59536c3fef28SJerry Van Baren	while (!accepted) {
5954c609719bSwdenk		while (!running) {
5955c609719bSwdenk			do {
5956c609719bSwdenk				Add / modify source code;
5957c609719bSwdenk			} until (compiles);
5958c609719bSwdenk			Debug;
5959c609719bSwdenk			if (clueless)
5960c609719bSwdenk				email("Hi, I am having problems...");
5961c609719bSwdenk		}
59626c3fef28SJerry Van Baren		Send patch file to the U-Boot email list;
59636c3fef28SJerry Van Baren		if (reasonable critiques)
59646c3fef28SJerry Van Baren			Incorporate improvements from email list code review;
59656c3fef28SJerry Van Baren		else
59666c3fef28SJerry Van Baren			Defend code as written;
59676c3fef28SJerry Van Baren	}
5968c609719bSwdenk
5969c609719bSwdenk	return 0;
5970c609719bSwdenk}
5971c609719bSwdenk
5972c609719bSwdenkvoid no_more_time (int sig)
5973c609719bSwdenk{
5974c609719bSwdenk      hire_a_guru();
5975c609719bSwdenk}
5976c609719bSwdenk
5977c609719bSwdenk
5978c609719bSwdenkCoding Standards:
5979c609719bSwdenk-----------------
5980c609719bSwdenk
5981c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel
59822c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script
59837ca9296eSWolfgang Denk"scripts/Lindent" in your Linux kernel source directory.
5984c609719bSwdenk
59852c051651SDetlev ZundelSource files originating from a different project (for example the
59862c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not
59872c051651SDetlev Zundelreformated to ease subsequent migration to newer versions of those
59882c051651SDetlev Zundelsources.
59892c051651SDetlev Zundel
59902c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in
59912c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//)
59922c051651SDetlev Zundelin your code.
5993c609719bSwdenk
5994c178d3daSwdenkPlease also stick to the following formatting rules:
5995180d3f74Swdenk- remove any trailing white space
59967ca9296eSWolfgang Denk- use TAB characters for indentation and vertical alignment, not spaces
5997180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds
59987ca9296eSWolfgang Denk- do not add more than 2 consecutive empty lines to source files
5999180d3f74Swdenk- do not add trailing empty lines to source files
6000180d3f74Swdenk
6001c609719bSwdenkSubmissions which do not conform to the standards may be returned
6002c609719bSwdenkwith a request to reformat the changes.
6003c609719bSwdenk
6004c609719bSwdenk
6005c609719bSwdenkSubmitting Patches:
6006c609719bSwdenk-------------------
6007c609719bSwdenk
6008c609719bSwdenkSince the number of patches for U-Boot is growing, we need to
6009c609719bSwdenkestablish some rules. Submissions which do not conform to these rules
6010c609719bSwdenkmay be rejected, even when they contain important and valuable stuff.
6011c609719bSwdenk
60120d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details.
6013218ca724SWolfgang Denk
60140668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
60150668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot
60160668236bSWolfgang Denk
6017c609719bSwdenkWhen you send a patch, please include the following information with
6018c609719bSwdenkit:
6019c609719bSwdenk
6020c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes
6021c609719bSwdenk  this bug. Please try to include a way of demonstrating that the
6022c609719bSwdenk  patch actually fixes something.
6023c609719bSwdenk
6024c609719bSwdenk* For new features: a description of the feature and your
6025c609719bSwdenk  implementation.
6026c609719bSwdenk
6027c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch)
6028c609719bSwdenk
6029c609719bSwdenk* For major contributions, your entry to the CREDITS file
6030c609719bSwdenk
603127af930eSAlbert ARIBAUD* When you add support for a new board, don't forget to add a
603227af930eSAlbert ARIBAUD  maintainer e-mail address to the boards.cfg file, too.
6033c609719bSwdenk
6034c609719bSwdenk* If your patch adds new configuration options, don't forget to
6035c609719bSwdenk  document these in the README file.
6036c609719bSwdenk
6037218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly*
6038218ca724SWolfgang Denk  recommended) you can easily generate the patch using the
60397ca9296eSWolfgang Denk  "git format-patch". If you then use "git send-email" to send it to
6040218ca724SWolfgang Denk  the U-Boot mailing list, you will avoid most of the common problems
6041218ca724SWolfgang Denk  with some other mail clients.
6042c609719bSwdenk
6043218ca724SWolfgang Denk  If you cannot use git, use "diff -purN OLD NEW". If your version of
6044218ca724SWolfgang Denk  diff does not support these options, then get the latest version of
6045218ca724SWolfgang Denk  GNU diff.
60466dff5529Swdenk
6047218ca724SWolfgang Denk  The current directory when running this command shall be the parent
6048218ca724SWolfgang Denk  directory of the U-Boot source tree (i. e. please make sure that
6049218ca724SWolfgang Denk  your patch includes sufficient directory information for the
6050218ca724SWolfgang Denk  affected files).
6051218ca724SWolfgang Denk
6052218ca724SWolfgang Denk  We prefer patches as plain text. MIME attachments are discouraged,
6053218ca724SWolfgang Denk  and compressed attachments must not be used.
6054c609719bSwdenk
605552f52c14Swdenk* If one logical set of modifications affects or creates several
605652f52c14Swdenk  files, all these changes shall be submitted in a SINGLE patch file.
605752f52c14Swdenk
605852f52c14Swdenk* Changesets that contain different, unrelated modifications shall be
605952f52c14Swdenk  submitted as SEPARATE patches, one patch per changeset.
606052f52c14Swdenk
606152f52c14Swdenk
6062c609719bSwdenkNotes:
6063c609719bSwdenk
6064c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched
6065c609719bSwdenk  source tree and make sure that no errors or warnings are reported
6066c609719bSwdenk  for any of the boards.
6067c609719bSwdenk
6068c609719bSwdenk* Keep your modifications to the necessary minimum: A patch
6069c609719bSwdenk  containing several unrelated changes or arbitrary reformats will be
6070c609719bSwdenk  returned with a request to re-formatting / split it.
6071c609719bSwdenk
6072c609719bSwdenk* If you modify existing code, make sure that your new code does not
6073c609719bSwdenk  add to the memory footprint of the code ;-) Small is beautiful!
6074c609719bSwdenk  When adding new features, these should compile conditionally only
6075c609719bSwdenk  (using #ifdef), and the resulting code with the new feature
6076c609719bSwdenk  disabled must not need more memory than the old code without your
6077c609719bSwdenk  modification.
607890dc6704Swdenk
60790668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the
60800668236bSWolfgang Denk  u-boot mailing list. Bigger patches will be moderated. If they are
60810668236bSWolfgang Denk  reasonable and not too big, they will be acknowledged. But patches
60820668236bSWolfgang Denk  bigger than the size limit should be avoided.
6083