xref: /openbmc/u-boot/README (revision a804b5ce2d84dca6f9e145003e588876adf2c71f)
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
4266cb461b4SDaniel Schwierzeck- Generic CPU options:
4276cb461b4SDaniel Schwierzeck		CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
4286cb461b4SDaniel Schwierzeck
4296cb461b4SDaniel Schwierzeck		Defines the endianess of the CPU. Implementation of those
4306cb461b4SDaniel Schwierzeck		values is arch specific.
4316cb461b4SDaniel Schwierzeck
4325614e71bSYork Sun		CONFIG_SYS_FSL_DDR
4335614e71bSYork Sun		Freescale DDR driver in use. This type of DDR controller is
4345614e71bSYork Sun		found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
4355614e71bSYork Sun		SoCs.
4365614e71bSYork Sun
4375614e71bSYork Sun		CONFIG_SYS_FSL_DDR_ADDR
4385614e71bSYork Sun		Freescale DDR memory-mapped register base.
4395614e71bSYork Sun
4405614e71bSYork Sun		CONFIG_SYS_FSL_DDR_EMU
4415614e71bSYork Sun		Specify emulator support for DDR. Some DDR features such as
4425614e71bSYork Sun		deskew training are not available.
4435614e71bSYork Sun
4445614e71bSYork Sun		CONFIG_SYS_FSL_DDRC_GEN1
4455614e71bSYork Sun		Freescale DDR1 controller.
4465614e71bSYork Sun
4475614e71bSYork Sun		CONFIG_SYS_FSL_DDRC_GEN2
4485614e71bSYork Sun		Freescale DDR2 controller.
4495614e71bSYork Sun
4505614e71bSYork Sun		CONFIG_SYS_FSL_DDRC_GEN3
4515614e71bSYork Sun		Freescale DDR3 controller.
4525614e71bSYork Sun
4539ac4ffbdSYork Sun		CONFIG_SYS_FSL_DDRC_ARM_GEN3
4549ac4ffbdSYork Sun		Freescale DDR3 controller for ARM-based SoCs.
4559ac4ffbdSYork Sun
4565614e71bSYork Sun		CONFIG_SYS_FSL_DDR1
4575614e71bSYork Sun		Board config to use DDR1. It can be enabled for SoCs with
4585614e71bSYork Sun		Freescale DDR1 or DDR2 controllers, depending on the board
4595614e71bSYork Sun		implemetation.
4605614e71bSYork Sun
4615614e71bSYork Sun		CONFIG_SYS_FSL_DDR2
4625614e71bSYork Sun		Board config to use DDR2. It can be eanbeld for SoCs with
4635614e71bSYork Sun		Freescale DDR2 or DDR3 controllers, depending on the board
4645614e71bSYork Sun		implementation.
4655614e71bSYork Sun
4665614e71bSYork Sun		CONFIG_SYS_FSL_DDR3
4675614e71bSYork Sun		Board config to use DDR3. It can be enabled for SoCs with
4685614e71bSYork Sun		Freescale DDR3 controllers.
4695614e71bSYork Sun
4700b953ffcSMarkus Klotzbuecher- Intel Monahans options:
4716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
4720b953ffcSMarkus Klotzbuecher
4730b953ffcSMarkus Klotzbuecher		Defines the Monahans run mode to oscillator
4740b953ffcSMarkus Klotzbuecher		ratio. Valid values are 8, 16, 24, 31. The core
4750b953ffcSMarkus Klotzbuecher		frequency is this value multiplied by 13 MHz.
4760b953ffcSMarkus Klotzbuecher
4776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
4780b953ffcSMarkus Klotzbuecher
4790b953ffcSMarkus Klotzbuecher		Defines the Monahans turbo mode to oscillator
4800b953ffcSMarkus Klotzbuecher		ratio. Valid values are 1 (default if undefined) and
4810b953ffcSMarkus Klotzbuecher		2. The core frequency as calculated above is multiplied
4820b953ffcSMarkus Klotzbuecher		by this value.
4830b953ffcSMarkus Klotzbuecher
48492bbd64eSDaniel Schwierzeck- MIPS CPU options:
48592bbd64eSDaniel Schwierzeck		CONFIG_SYS_INIT_SP_OFFSET
48692bbd64eSDaniel Schwierzeck
48792bbd64eSDaniel Schwierzeck		Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
48892bbd64eSDaniel Schwierzeck		pointer. This is needed for the temporary stack before
48992bbd64eSDaniel Schwierzeck		relocation.
49092bbd64eSDaniel Schwierzeck
49192bbd64eSDaniel Schwierzeck		CONFIG_SYS_MIPS_CACHE_MODE
49292bbd64eSDaniel Schwierzeck
49392bbd64eSDaniel Schwierzeck		Cache operation mode for the MIPS CPU.
49492bbd64eSDaniel Schwierzeck		See also arch/mips/include/asm/mipsregs.h.
49592bbd64eSDaniel Schwierzeck		Possible values are:
49692bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_NO_WA
49792bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_WA
49892bbd64eSDaniel Schwierzeck			CONF_CM_UNCACHED
49992bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_NONCOHERENT
50092bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_CE
50192bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_COW
50292bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_CUW
50392bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_ACCELERATED
50492bbd64eSDaniel Schwierzeck
50592bbd64eSDaniel Schwierzeck		CONFIG_SYS_XWAY_EBU_BOOTCFG
50692bbd64eSDaniel Schwierzeck
50792bbd64eSDaniel Schwierzeck		Special option for Lantiq XWAY SoCs for booting from NOR flash.
50892bbd64eSDaniel Schwierzeck		See also arch/mips/cpu/mips32/start.S.
50992bbd64eSDaniel Schwierzeck
51092bbd64eSDaniel Schwierzeck		CONFIG_XWAY_SWAP_BYTES
51192bbd64eSDaniel Schwierzeck
51292bbd64eSDaniel Schwierzeck		Enable compilation of tools/xway-swap-bytes needed for Lantiq
51392bbd64eSDaniel Schwierzeck		XWAY SoCs for booting from NOR flash. The U-Boot image needs to
51492bbd64eSDaniel Schwierzeck		be swapped if a flash programmer is used.
51592bbd64eSDaniel Schwierzeck
516b67d8816SChristian Riesch- ARM options:
517b67d8816SChristian Riesch		CONFIG_SYS_EXCEPTION_VECTORS_HIGH
518b67d8816SChristian Riesch
519b67d8816SChristian Riesch		Select high exception vectors of the ARM core, e.g., do not
520b67d8816SChristian Riesch		clear the V bit of the c1 register of CP15.
521b67d8816SChristian Riesch
5225356f545SAneesh V		CONFIG_SYS_THUMB_BUILD
5235356f545SAneesh V
5245356f545SAneesh V		Use this flag to build U-Boot using the Thumb instruction
5255356f545SAneesh V		set for ARM architectures. Thumb instruction set provides
5265356f545SAneesh V		better code density. For ARM architectures that support
5275356f545SAneesh V		Thumb2 this flag will result in Thumb2 code generated by
5285356f545SAneesh V		GCC.
5295356f545SAneesh V
530c5d4752cSStephen Warren		CONFIG_ARM_ERRATA_716044
5310678587fSStephen Warren		CONFIG_ARM_ERRATA_742230
5320678587fSStephen Warren		CONFIG_ARM_ERRATA_743622
5330678587fSStephen Warren		CONFIG_ARM_ERRATA_751472
5340678587fSStephen Warren
5350678587fSStephen Warren		If set, the workarounds for these ARM errata are applied early
5360678587fSStephen Warren		during U-Boot startup. Note that these options force the
5370678587fSStephen Warren		workarounds to be applied; no CPU-type/version detection
5380678587fSStephen Warren		exists, unlike the similar options in the Linux kernel. Do not
5390678587fSStephen Warren		set these options unless they apply!
5400678587fSStephen Warren
541795659dcSStephen Warren- CPU timer options:
542795659dcSStephen Warren		CONFIG_SYS_HZ
543795659dcSStephen Warren
544795659dcSStephen Warren		The frequency of the timer returned by get_timer().
545795659dcSStephen Warren		get_timer() must operate in milliseconds and this CONFIG
546795659dcSStephen Warren		option must be set to 1000.
547795659dcSStephen Warren
5485da627a4Swdenk- Linux Kernel Interface:
549c609719bSwdenk		CONFIG_CLOCKS_IN_MHZ
550c609719bSwdenk
551c609719bSwdenk		U-Boot stores all clock information in Hz
552c609719bSwdenk		internally. For binary compatibility with older Linux
553c609719bSwdenk		kernels (which expect the clocks passed in the
554c609719bSwdenk		bd_info data to be in MHz) the environment variable
555c609719bSwdenk		"clocks_in_mhz" can be defined so that U-Boot
556c609719bSwdenk		converts clock data to MHZ before passing it to the
557c609719bSwdenk		Linux kernel.
558c609719bSwdenk		When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
559c609719bSwdenk		"clocks_in_mhz=1" is automatically included in the
560c609719bSwdenk		default environment.
561c609719bSwdenk
5625da627a4Swdenk		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]
5635da627a4Swdenk
56411ccc33fSMarcel Ziswiler		When transferring memsize parameter to linux, some versions
5655da627a4Swdenk		expect it to be in bytes, others in MB.
5665da627a4Swdenk		Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
5675da627a4Swdenk
568fec6d9eeSGerald Van Baren		CONFIG_OF_LIBFDT
569f57f70aaSWolfgang Denk
570f57f70aaSWolfgang Denk		New kernel versions are expecting firmware settings to be
571213bf8c8SGerald Van Baren		passed using flattened device trees (based on open firmware
572213bf8c8SGerald Van Baren		concepts).
573213bf8c8SGerald Van Baren
574213bf8c8SGerald Van Baren		CONFIG_OF_LIBFDT
575213bf8c8SGerald Van Baren		 * New libfdt-based support
576213bf8c8SGerald Van Baren		 * Adds the "fdt" command
5773bb342fcSKim Phillips		 * The bootm command automatically updates the fdt
578213bf8c8SGerald Van Baren
579b55ae402SMarcel Ziswiler		OF_CPU - The proper name of the cpus node (only required for
580b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
581b55ae402SMarcel Ziswiler		OF_SOC - The proper name of the soc node (only required for
582b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
583f57f70aaSWolfgang Denk		OF_TBCLK - The timebase frequency.
584c2871f03SKumar Gala		OF_STDOUT_PATH - The path to the console device
585f57f70aaSWolfgang Denk
58611ccc33fSMarcel Ziswiler		boards with QUICC Engines require OF_QE to set UCC MAC
58711ccc33fSMarcel Ziswiler		addresses
5883bb342fcSKim Phillips
5894e253137SKumar Gala		CONFIG_OF_BOARD_SETUP
5904e253137SKumar Gala
5914e253137SKumar Gala		Board code has addition modification that it wants to make
5924e253137SKumar Gala		to the flat device tree before handing it off to the kernel
5936705d81eSwdenk
5940267768eSMatthew McClintock		CONFIG_OF_BOOT_CPU
5950267768eSMatthew McClintock
59611ccc33fSMarcel Ziswiler		This define fills in the correct boot CPU in the boot
5970267768eSMatthew McClintock		param header, the default value is zero if undefined.
5980267768eSMatthew McClintock
5993887c3fbSHeiko Schocher		CONFIG_OF_IDE_FIXUP
6003887c3fbSHeiko Schocher
6013887c3fbSHeiko Schocher		U-Boot can detect if an IDE device is present or not.
6023887c3fbSHeiko Schocher		If not, and this new config option is activated, U-Boot
6033887c3fbSHeiko Schocher		removes the ATA node from the DTS before booting Linux,
6043887c3fbSHeiko Schocher		so the Linux IDE driver does not probe the device and
6053887c3fbSHeiko Schocher		crash. This is needed for buggy hardware (uc101) where
6063887c3fbSHeiko Schocher		no pull down resistor is connected to the signal IDE5V_DD7.
6073887c3fbSHeiko Schocher
6087eb29398SIgor Grinberg		CONFIG_MACH_TYPE	[relevant for ARM only][mandatory]
6097eb29398SIgor Grinberg
6107eb29398SIgor Grinberg		This setting is mandatory for all boards that have only one
6117eb29398SIgor Grinberg		machine type and must be used to specify the machine type
6127eb29398SIgor Grinberg		number as it appears in the ARM machine registry
6137eb29398SIgor Grinberg		(see http://www.arm.linux.org.uk/developer/machines/).
6147eb29398SIgor Grinberg		Only boards that have multiple machine types supported
6157eb29398SIgor Grinberg		in a single configuration file and the machine type is
6167eb29398SIgor Grinberg		runtime discoverable, do not have to use this setting.
6177eb29398SIgor Grinberg
6180b2f4ecaSNiklaus Giger- vxWorks boot parameters:
6190b2f4ecaSNiklaus Giger
6200b2f4ecaSNiklaus Giger		bootvx constructs a valid bootline using the following
6210b2f4ecaSNiklaus Giger		environments variables: bootfile, ipaddr, serverip, hostname.
6220b2f4ecaSNiklaus Giger		It loads the vxWorks image pointed bootfile.
6230b2f4ecaSNiklaus Giger
6240b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
6250b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
6260b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
6270b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
6280b2f4ecaSNiklaus Giger
6290b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_ADD_PARAMS
6300b2f4ecaSNiklaus Giger
6310b2f4ecaSNiklaus Giger		Add it at the end of the bootline. E.g "u=username pw=secret"
6320b2f4ecaSNiklaus Giger
6330b2f4ecaSNiklaus Giger		Note: If a "bootargs" environment is defined, it will overwride
6340b2f4ecaSNiklaus Giger		the defaults discussed just above.
6350b2f4ecaSNiklaus Giger
6362c451f78SAneesh V- Cache Configuration:
6372c451f78SAneesh V		CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
6382c451f78SAneesh V		CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
6392c451f78SAneesh V		CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
6402c451f78SAneesh V
64193bc2193SAneesh V- Cache Configuration for ARM:
64293bc2193SAneesh V		CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
64393bc2193SAneesh V				      controller
64493bc2193SAneesh V		CONFIG_SYS_PL310_BASE - Physical base address of PL310
64593bc2193SAneesh V					controller register space
64693bc2193SAneesh V
6476705d81eSwdenk- Serial Ports:
64848d0192fSAndreas Engel		CONFIG_PL010_SERIAL
6496705d81eSwdenk
6506705d81eSwdenk		Define this if you want support for Amba PrimeCell PL010 UARTs.
6516705d81eSwdenk
65248d0192fSAndreas Engel		CONFIG_PL011_SERIAL
6536705d81eSwdenk
6546705d81eSwdenk		Define this if you want support for Amba PrimeCell PL011 UARTs.
6556705d81eSwdenk
6566705d81eSwdenk		CONFIG_PL011_CLOCK
6576705d81eSwdenk
6586705d81eSwdenk		If you have Amba PrimeCell PL011 UARTs, set this variable to
6596705d81eSwdenk		the clock speed of the UARTs.
6606705d81eSwdenk
6616705d81eSwdenk		CONFIG_PL01x_PORTS
6626705d81eSwdenk
6636705d81eSwdenk		If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
6646705d81eSwdenk		define this to a list of base addresses for each (supported)
6656705d81eSwdenk		port. See e.g. include/configs/versatile.h
6666705d81eSwdenk
667910f1ae3SJohn Rigby		CONFIG_PL011_SERIAL_RLCR
668910f1ae3SJohn Rigby
669910f1ae3SJohn Rigby		Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
670910f1ae3SJohn Rigby		have separate receive and transmit line control registers.  Set
671910f1ae3SJohn Rigby		this variable to initialize the extra register.
672910f1ae3SJohn Rigby
673910f1ae3SJohn Rigby		CONFIG_PL011_SERIAL_FLUSH_ON_INIT
674910f1ae3SJohn Rigby
675910f1ae3SJohn Rigby		On some platforms (e.g. U8500) U-Boot is loaded by a second stage
676910f1ae3SJohn Rigby		boot loader that has already initialized the UART.  Define this
677910f1ae3SJohn Rigby		variable to flush the UART at init time.
678910f1ae3SJohn Rigby
6796705d81eSwdenk
680c609719bSwdenk- Console Interface:
681c609719bSwdenk		Depending on board, define exactly one serial port
682c609719bSwdenk		(like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
683c609719bSwdenk		CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
684c609719bSwdenk		console by defining CONFIG_8xx_CONS_NONE
685c609719bSwdenk
686c609719bSwdenk		Note: if CONFIG_8xx_CONS_NONE is defined, the serial
687c609719bSwdenk		port routines must be defined elsewhere
688c609719bSwdenk		(i.e. serial_init(), serial_getc(), ...)
689c609719bSwdenk
690c609719bSwdenk		CONFIG_CFB_CONSOLE
691c609719bSwdenk		Enables console device for a color framebuffer. Needs following
692c53043b7SWolfgang Denk		defines (cf. smiLynxEM, i8042)
693c609719bSwdenk			VIDEO_FB_LITTLE_ENDIAN	graphic memory organisation
694c609719bSwdenk						(default big endian)
695c609719bSwdenk			VIDEO_HW_RECTFILL	graphic chip supports
696c609719bSwdenk						rectangle fill
697c609719bSwdenk						(cf. smiLynxEM)
698c609719bSwdenk			VIDEO_HW_BITBLT		graphic chip supports
699c609719bSwdenk						bit-blit (cf. smiLynxEM)
700c609719bSwdenk			VIDEO_VISIBLE_COLS	visible pixel columns
701c609719bSwdenk						(cols=pitch)
702c609719bSwdenk			VIDEO_VISIBLE_ROWS	visible pixel rows
703c609719bSwdenk			VIDEO_PIXEL_SIZE	bytes per pixel
704c609719bSwdenk			VIDEO_DATA_FORMAT	graphic data format
705c609719bSwdenk						(0-5, cf. cfb_console.c)
706c609719bSwdenk			VIDEO_FB_ADRS		framebuffer address
707c609719bSwdenk			VIDEO_KBD_INIT_FCT	keyboard int fct
708c609719bSwdenk						(i.e. i8042_kbd_init())
709c609719bSwdenk			VIDEO_TSTC_FCT		test char fct
710c609719bSwdenk						(i.e. i8042_tstc)
711c609719bSwdenk			VIDEO_GETC_FCT		get char fct
712c609719bSwdenk						(i.e. i8042_getc)
713c609719bSwdenk			CONFIG_CONSOLE_CURSOR	cursor drawing on/off
714c609719bSwdenk						(requires blink timer
715c609719bSwdenk						cf. i8042.c)
7166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
717c609719bSwdenk			CONFIG_CONSOLE_TIME	display time/date info in
718c609719bSwdenk						upper right corner
719602ad3b3SJon Loeliger						(requires CONFIG_CMD_DATE)
720c609719bSwdenk			CONFIG_VIDEO_LOGO	display Linux logo in
721c609719bSwdenk						upper left corner
722a6c7ad2fSwdenk			CONFIG_VIDEO_BMP_LOGO	use bmp_logo.h instead of
723a6c7ad2fSwdenk						linux_logo.h for logo.
724a6c7ad2fSwdenk						Requires CONFIG_VIDEO_LOGO
725c609719bSwdenk			CONFIG_CONSOLE_EXTRA_INFO
72611ccc33fSMarcel Ziswiler						additional board info beside
727c609719bSwdenk						the logo
728c609719bSwdenk
72933a35bbbSPali Rohár		When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
73033a35bbbSPali Rohár		a limited number of ANSI escape sequences (cursor control,
73133a35bbbSPali Rohár		erase functions and limited graphics rendition control).
73233a35bbbSPali Rohár
733c609719bSwdenk		When CONFIG_CFB_CONSOLE is defined, video console is
734c609719bSwdenk		default i/o. Serial console can be forced with
735c609719bSwdenk		environment 'console=serial'.
736c609719bSwdenk
737a3ad8e26Swdenk		When CONFIG_SILENT_CONSOLE is defined, all console
738a3ad8e26Swdenk		messages (by U-Boot and Linux!) can be silenced with
739a3ad8e26Swdenk		the "silent" environment variable. See
740a3ad8e26Swdenk		doc/README.silent for more information.
741a3ad8e26Swdenk
74245ae2546SHeiko Schocher		CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default
74345ae2546SHeiko Schocher			is 0x00.
74445ae2546SHeiko Schocher		CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default
74545ae2546SHeiko Schocher			is 0xa0.
74645ae2546SHeiko Schocher
747c609719bSwdenk- Console Baudrate:
748c609719bSwdenk		CONFIG_BAUDRATE - in bps
749c609719bSwdenk		Select one of the baudrates listed in
7506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
7516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
752c609719bSwdenk
753c92fac91SHeiko Schocher- Console Rx buffer length
754c92fac91SHeiko Schocher		With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
755c92fac91SHeiko Schocher		the maximum receive buffer length for the SMC.
7562b3f12c2SHeiko Schocher		This option is actual only for 82xx and 8xx possible.
757c92fac91SHeiko Schocher		If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
758c92fac91SHeiko Schocher		must be defined, to setup the maximum idle timeout for
759c92fac91SHeiko Schocher		the SMC.
760c92fac91SHeiko Schocher
7619558b48aSGraeme Russ- Pre-Console Buffer:
7629558b48aSGraeme Russ		Prior to the console being initialised (i.e. serial UART
7639558b48aSGraeme Russ		initialised etc) all console output is silently discarded.
7649558b48aSGraeme Russ		Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
7659558b48aSGraeme Russ		buffer any console messages prior to the console being
7669558b48aSGraeme Russ		initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
7679558b48aSGraeme Russ		bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
7689558b48aSGraeme Russ		a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
7699558b48aSGraeme Russ		bytes are output before the console is initialised, the
7709558b48aSGraeme Russ		earlier bytes are discarded.
7719558b48aSGraeme Russ
7729558b48aSGraeme Russ		'Sane' compilers will generate smaller code if
7739558b48aSGraeme Russ		CONFIG_PRE_CON_BUF_SZ is a power of 2
7749558b48aSGraeme Russ
775046a37bdSSonny Rao- Safe printf() functions
776046a37bdSSonny Rao		Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
777046a37bdSSonny Rao		the printf() functions. These are defined in
778046a37bdSSonny Rao		include/vsprintf.h and include snprintf(), vsnprintf() and
779046a37bdSSonny Rao		so on. Code size increase is approximately 300-500 bytes.
780046a37bdSSonny Rao		If this option is not given then these functions will
781046a37bdSSonny Rao		silently discard their buffer size argument - this means
782046a37bdSSonny Rao		you are not getting any overflow checking in this case.
783046a37bdSSonny Rao
784c609719bSwdenk- Boot Delay:	CONFIG_BOOTDELAY - in seconds
785c609719bSwdenk		Delay before automatically booting the default image;
786c609719bSwdenk		set to -1 to disable autoboot.
78793d7212fSJoe Hershberger		set to -2 to autoboot with no delay and not check for abort
78893d7212fSJoe Hershberger		(even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
789c609719bSwdenk
790c609719bSwdenk		See doc/README.autoboot for these options that
791c609719bSwdenk		work with CONFIG_BOOTDELAY. None are required.
792c609719bSwdenk		CONFIG_BOOT_RETRY_TIME
793c609719bSwdenk		CONFIG_BOOT_RETRY_MIN
794c609719bSwdenk		CONFIG_AUTOBOOT_KEYED
795c609719bSwdenk		CONFIG_AUTOBOOT_PROMPT
796c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR
797c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR
798c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR2
799c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR2
800c609719bSwdenk		CONFIG_ZERO_BOOTDELAY_CHECK
801c609719bSwdenk		CONFIG_RESET_TO_RETRY
802c609719bSwdenk
803c609719bSwdenk- Autoboot Command:
804c609719bSwdenk		CONFIG_BOOTCOMMAND
805c609719bSwdenk		Only needed when CONFIG_BOOTDELAY is enabled;
806c609719bSwdenk		define a command string that is automatically executed
807c609719bSwdenk		when no character is read on the console interface
808c609719bSwdenk		within "Boot Delay" after reset.
809c609719bSwdenk
810c609719bSwdenk		CONFIG_BOOTARGS
811c609719bSwdenk		This can be used to pass arguments to the bootm
812c609719bSwdenk		command. The value of CONFIG_BOOTARGS goes into the
813c609719bSwdenk		environment value "bootargs".
814c609719bSwdenk
815c609719bSwdenk		CONFIG_RAMBOOT and CONFIG_NFSBOOT
816c609719bSwdenk		The value of these goes into the environment as
817c609719bSwdenk		"ramboot" and "nfsboot" respectively, and can be used
818c609719bSwdenk		as a convenience, when switching between booting from
81911ccc33fSMarcel Ziswiler		RAM and NFS.
820c609719bSwdenk
821eda0ba38SHeiko Schocher- Bootcount:
822eda0ba38SHeiko Schocher		CONFIG_BOOTCOUNT_LIMIT
823eda0ba38SHeiko Schocher		Implements a mechanism for detecting a repeating reboot
824eda0ba38SHeiko Schocher		cycle, see:
825eda0ba38SHeiko Schocher		http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
826eda0ba38SHeiko Schocher
827eda0ba38SHeiko Schocher		CONFIG_BOOTCOUNT_ENV
828eda0ba38SHeiko Schocher		If no softreset save registers are found on the hardware
829eda0ba38SHeiko Schocher		"bootcount" is stored in the environment. To prevent a
830eda0ba38SHeiko Schocher		saveenv on all reboots, the environment variable
831eda0ba38SHeiko Schocher		"upgrade_available" is used. If "upgrade_available" is
832eda0ba38SHeiko Schocher		0, "bootcount" is always 0, if "upgrade_available" is
833eda0ba38SHeiko Schocher		1 "bootcount" is incremented in the environment.
834eda0ba38SHeiko Schocher		So the Userspace Applikation must set the "upgrade_available"
835eda0ba38SHeiko Schocher		and "bootcount" variable to 0, if a boot was successfully.
836eda0ba38SHeiko Schocher
837c609719bSwdenk- Pre-Boot Commands:
838c609719bSwdenk		CONFIG_PREBOOT
839c609719bSwdenk
840c609719bSwdenk		When this option is #defined, the existence of the
841c609719bSwdenk		environment variable "preboot" will be checked
842c609719bSwdenk		immediately before starting the CONFIG_BOOTDELAY
843c609719bSwdenk		countdown and/or running the auto-boot command resp.
844c609719bSwdenk		entering interactive mode.
845c609719bSwdenk
846c609719bSwdenk		This feature is especially useful when "preboot" is
847c609719bSwdenk		automatically generated or modified. For an example
848c609719bSwdenk		see the LWMON board specific code: here "preboot" is
849c609719bSwdenk		modified when the user holds down a certain
850c609719bSwdenk		combination of keys on the (special) keyboard when
851c609719bSwdenk		booting the systems
852c609719bSwdenk
853c609719bSwdenk- Serial Download Echo Mode:
854c609719bSwdenk		CONFIG_LOADS_ECHO
855c609719bSwdenk		If defined to 1, all characters received during a
856c609719bSwdenk		serial download (using the "loads" command) are
857c609719bSwdenk		echoed back. This might be needed by some terminal
858c609719bSwdenk		emulations (like "cu"), but may as well just take
859c609719bSwdenk		time on others. This setting #define's the initial
860c609719bSwdenk		value of the "loads_echo" environment variable.
861c609719bSwdenk
862602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
863c609719bSwdenk		CONFIG_KGDB_BAUDRATE
864c609719bSwdenk		Select one of the baudrates listed in
8656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
866c609719bSwdenk
867c609719bSwdenk- Monitor Functions:
868602ad3b3SJon Loeliger		Monitor commands can be included or excluded
869602ad3b3SJon Loeliger		from the build by using the #include files
870c6c621bdSStephen Warren		<config_cmd_all.h> and #undef'ing unwanted
871c6c621bdSStephen Warren		commands, or using <config_cmd_default.h>
872602ad3b3SJon Loeliger		and augmenting with additional #define's
873602ad3b3SJon Loeliger		for wanted commands.
874c609719bSwdenk
875602ad3b3SJon Loeliger		The default command configuration includes all commands
876602ad3b3SJon Loeliger		except those marked below with a "*".
877602ad3b3SJon Loeliger
878602ad3b3SJon Loeliger		CONFIG_CMD_ASKENV	* ask for env variable
879602ad3b3SJon Loeliger		CONFIG_CMD_BDI		  bdinfo
880602ad3b3SJon Loeliger		CONFIG_CMD_BEDBUG	* Include BedBug Debugger
881602ad3b3SJon Loeliger		CONFIG_CMD_BMP		* BMP support
882602ad3b3SJon Loeliger		CONFIG_CMD_BSP		* Board specific commands
883602ad3b3SJon Loeliger		CONFIG_CMD_BOOTD	  bootd
884602ad3b3SJon Loeliger		CONFIG_CMD_CACHE	* icache, dcache
885602ad3b3SJon Loeliger		CONFIG_CMD_CONSOLE	  coninfo
886710b9938SMike Frysinger		CONFIG_CMD_CRC32	* crc32
887602ad3b3SJon Loeliger		CONFIG_CMD_DATE		* support for RTC, date/time...
888602ad3b3SJon Loeliger		CONFIG_CMD_DHCP		* DHCP support
889602ad3b3SJon Loeliger		CONFIG_CMD_DIAG		* Diagnostics
890a7c93104SPeter Tyser		CONFIG_CMD_DS4510	* ds4510 I2C gpio commands
891a7c93104SPeter Tyser		CONFIG_CMD_DS4510_INFO	* ds4510 I2C info command
892a7c93104SPeter Tyser		CONFIG_CMD_DS4510_MEM	* ds4510 I2C eeprom/sram commansd
893a7c93104SPeter Tyser		CONFIG_CMD_DS4510_RST	* ds4510 I2C rst command
894602ad3b3SJon Loeliger		CONFIG_CMD_DTT		* Digital Therm and Thermostat
895602ad3b3SJon Loeliger		CONFIG_CMD_ECHO		  echo arguments
896246c6922SPeter Tyser		CONFIG_CMD_EDITENV	  edit env variable
897602ad3b3SJon Loeliger		CONFIG_CMD_EEPROM	* EEPROM read/write support
898602ad3b3SJon Loeliger		CONFIG_CMD_ELF		* bootelf, bootvx
8995e2b3e0cSJoe Hershberger		CONFIG_CMD_ENV_CALLBACK	* display details about env callbacks
900fffad71bSJoe Hershberger		CONFIG_CMD_ENV_FLAGS	* display details about env flags
90188733e2cSAndrew Ruder		CONFIG_CMD_ENV_EXISTS	* check existence of env variable
9020c79cda0SMike Frysinger		CONFIG_CMD_EXPORTENV	* export the environment
90303e2ecf6SStephen Warren		CONFIG_CMD_EXT2		* ext2 command support
90403e2ecf6SStephen Warren		CONFIG_CMD_EXT4		* ext4 command support
905bdab39d3SMike Frysinger		CONFIG_CMD_SAVEENV	  saveenv
906602ad3b3SJon Loeliger		CONFIG_CMD_FDC		* Floppy Disk Support
90703e2ecf6SStephen Warren		CONFIG_CMD_FAT		* FAT command support
908602ad3b3SJon Loeliger		CONFIG_CMD_FDOS		* Dos diskette Support
909602ad3b3SJon Loeliger		CONFIG_CMD_FLASH	  flinfo, erase, protect
910602ad3b3SJon Loeliger		CONFIG_CMD_FPGA		  FPGA device initialization support
9114d98b5c8SVincent Stehlé		CONFIG_CMD_FUSE		* Device fuse support
91253fdc7efSAnton Staaf		CONFIG_CMD_GETTIME	* Get time since boot
913a641b979SMike Frysinger		CONFIG_CMD_GO		* the 'go' command (exec code)
914a000b795SKim Phillips		CONFIG_CMD_GREPENV	* search environment
915bf36c5d5SSimon Glass		CONFIG_CMD_HASH		* calculate hash / digest
916602ad3b3SJon Loeliger		CONFIG_CMD_HWFLOW	* RTS/CTS hw flow control
917602ad3b3SJon Loeliger		CONFIG_CMD_I2C		* I2C serial bus support
918602ad3b3SJon Loeliger		CONFIG_CMD_IDE		* IDE harddisk support
919602ad3b3SJon Loeliger		CONFIG_CMD_IMI		  iminfo
9208fdf1e0fSVipin Kumar		CONFIG_CMD_IMLS		  List all images found in NOR flash
9214d98b5c8SVincent Stehlé		CONFIG_CMD_IMLS_NAND	* List all images found in NAND flash
922602ad3b3SJon Loeliger		CONFIG_CMD_IMMAP	* IMMR dump support
9230c79cda0SMike Frysinger		CONFIG_CMD_IMPORTENV	* import an environment
924c167cc02SJoe Hershberger		CONFIG_CMD_INI		* import data from an ini file into the env
925602ad3b3SJon Loeliger		CONFIG_CMD_IRQ		* irqinfo
926602ad3b3SJon Loeliger		CONFIG_CMD_ITEST	  Integer/string test of 2 values
927602ad3b3SJon Loeliger		CONFIG_CMD_JFFS2	* JFFS2 Support
928602ad3b3SJon Loeliger		CONFIG_CMD_KGDB		* kgdb
9294d98b5c8SVincent Stehlé		CONFIG_CMD_LDRINFO	* ldrinfo (display Blackfin loader)
930d22c338eSJoe Hershberger		CONFIG_CMD_LINK_LOCAL	* link-local IP address auto-configuration
931d22c338eSJoe Hershberger					  (169.254.*.*)
932602ad3b3SJon Loeliger		CONFIG_CMD_LOADB	  loadb
933602ad3b3SJon Loeliger		CONFIG_CMD_LOADS	  loads
9344d98b5c8SVincent Stehlé		CONFIG_CMD_MD5SUM	* print md5 message digest
93502c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
93615a33e49SSimon Glass		CONFIG_CMD_MEMINFO	* Display detailed memory information
937602ad3b3SJon Loeliger		CONFIG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
938a2681707SWolfgang Denk					  loop, loopw
9394d98b5c8SVincent Stehlé		CONFIG_CMD_MEMTEST	* mtest
940602ad3b3SJon Loeliger		CONFIG_CMD_MISC		  Misc functions like sleep etc
941602ad3b3SJon Loeliger		CONFIG_CMD_MMC		* MMC memory mapped support
942602ad3b3SJon Loeliger		CONFIG_CMD_MII		* MII utility commands
94368d7d651SStefan Roese		CONFIG_CMD_MTDPARTS	* MTD partition support
944602ad3b3SJon Loeliger		CONFIG_CMD_NAND		* NAND support
945602ad3b3SJon Loeliger		CONFIG_CMD_NET		  bootp, tftpboot, rarpboot
9464d98b5c8SVincent Stehlé		CONFIG_CMD_NFS		  NFS support
947e92739d3SPeter Tyser		CONFIG_CMD_PCA953X	* PCA953x I2C gpio commands
948e92739d3SPeter Tyser		CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
949602ad3b3SJon Loeliger		CONFIG_CMD_PCI		* pciinfo
950602ad3b3SJon Loeliger		CONFIG_CMD_PCMCIA		* PCMCIA support
951602ad3b3SJon Loeliger		CONFIG_CMD_PING		* send ICMP ECHO_REQUEST to network
952602ad3b3SJon Loeliger					  host
953602ad3b3SJon Loeliger		CONFIG_CMD_PORTIO	* Port I/O
954ff048ea9SKenneth Waters		CONFIG_CMD_READ		* Read raw data from partition
955602ad3b3SJon Loeliger		CONFIG_CMD_REGINFO	* Register dump
956602ad3b3SJon Loeliger		CONFIG_CMD_RUN		  run command in env variable
957d304931fSSimon Glass		CONFIG_CMD_SANDBOX	* sb command to access sandbox features
958602ad3b3SJon Loeliger		CONFIG_CMD_SAVES	* save S record dump
959602ad3b3SJon Loeliger		CONFIG_CMD_SCSI		* SCSI Support
960602ad3b3SJon Loeliger		CONFIG_CMD_SDRAM	* print SDRAM configuration information
961602ad3b3SJon Loeliger					  (requires CONFIG_CMD_I2C)
962602ad3b3SJon Loeliger		CONFIG_CMD_SETGETDCR	  Support for DCR Register access
963602ad3b3SJon Loeliger					  (4xx only)
964f61ec45eSEric Nelson		CONFIG_CMD_SF		* Read/write/erase SPI NOR flash
9654d98b5c8SVincent Stehlé		CONFIG_CMD_SHA1SUM	* print sha1 memory digest
96602c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY)
9677d861d95SBob Liu		CONFIG_CMD_SOFTSWITCH	* Soft switch setting command for BF60x
96874de7aefSWolfgang Denk		CONFIG_CMD_SOURCE	  "source" command Support
969602ad3b3SJon Loeliger		CONFIG_CMD_SPI		* SPI serial bus support
9707a83af07SLuca Ceresoli		CONFIG_CMD_TFTPSRV	* TFTP transfer in server mode
9711fb7cd49SSimon Glass		CONFIG_CMD_TFTPPUT	* TFTP put command (upload)
972da83bcd7SJoe Hershberger		CONFIG_CMD_TIME		* run command and report execution time (ARM specific)
973da83bcd7SJoe Hershberger		CONFIG_CMD_TIMER	* access to the system tick timer
974602ad3b3SJon Loeliger		CONFIG_CMD_USB		* USB support
975602ad3b3SJon Loeliger		CONFIG_CMD_CDP		* Cisco Discover Protocol support
976c8339f51SMarek Vasut		CONFIG_CMD_MFSL		* Microblaze FSL support
9774d98b5c8SVincent Stehlé		CONFIG_CMD_XIMG		  Load part of Multi Image
978c609719bSwdenk
979c609719bSwdenk
980c609719bSwdenk		EXAMPLE: If you want all functions except of network
981c609719bSwdenk		support you can write:
982c609719bSwdenk
983602ad3b3SJon Loeliger		#include "config_cmd_all.h"
984602ad3b3SJon Loeliger		#undef CONFIG_CMD_NET
985c609719bSwdenk
986213bf8c8SGerald Van Baren	Other Commands:
987213bf8c8SGerald Van Baren		fdt (flattened device tree) command: CONFIG_OF_LIBFDT
988c609719bSwdenk
989c609719bSwdenk	Note:	Don't enable the "icache" and "dcache" commands
990602ad3b3SJon Loeliger		(configuration option CONFIG_CMD_CACHE) unless you know
991c609719bSwdenk		what you (and your U-Boot users) are doing. Data
992c609719bSwdenk		cache cannot be enabled on systems like the 8xx or
993c609719bSwdenk		8260 (where accesses to the IMMR region must be
994c609719bSwdenk		uncached), and it cannot be disabled on all other
995c609719bSwdenk		systems where we (mis-) use the data cache to hold an
996c609719bSwdenk		initial stack and some data.
997c609719bSwdenk
998c609719bSwdenk
999c609719bSwdenk		XXX - this list needs to get updated!
1000c609719bSwdenk
1001a5ecbe62SWolfgang Denk- Regular expression support:
1002a5ecbe62SWolfgang Denk		CONFIG_REGEX
1003a5ecbe62SWolfgang Denk		If this variable is defined, U-Boot is linked against
1004a5ecbe62SWolfgang Denk		the SLRE (Super Light Regular Expression) library,
1005a5ecbe62SWolfgang Denk		which adds regex support to some commands, as for
1006a5ecbe62SWolfgang Denk		example "env grep" and "setexpr".
1007a5ecbe62SWolfgang Denk
100845ba8077SSimon Glass- Device tree:
100945ba8077SSimon Glass		CONFIG_OF_CONTROL
101045ba8077SSimon Glass		If this variable is defined, U-Boot will use a device tree
101145ba8077SSimon Glass		to configure its devices, instead of relying on statically
101245ba8077SSimon Glass		compiled #defines in the board file. This option is
101345ba8077SSimon Glass		experimental and only available on a few boards. The device
101445ba8077SSimon Glass		tree is available in the global data as gd->fdt_blob.
101545ba8077SSimon Glass
10162c0f79e4SSimon Glass		U-Boot needs to get its device tree from somewhere. This can
10172c0f79e4SSimon Glass		be done using one of the two options below:
1018bbb0b128SSimon Glass
1019bbb0b128SSimon Glass		CONFIG_OF_EMBED
1020bbb0b128SSimon Glass		If this variable is defined, U-Boot will embed a device tree
1021bbb0b128SSimon Glass		binary in its image. This device tree file should be in the
1022bbb0b128SSimon Glass		board directory and called <soc>-<board>.dts. The binary file
1023bbb0b128SSimon Glass		is then picked up in board_init_f() and made available through
1024bbb0b128SSimon Glass		the global data structure as gd->blob.
102545ba8077SSimon Glass
10262c0f79e4SSimon Glass		CONFIG_OF_SEPARATE
10272c0f79e4SSimon Glass		If this variable is defined, U-Boot will build a device tree
10282c0f79e4SSimon Glass		binary. It will be called u-boot.dtb. Architecture-specific
10292c0f79e4SSimon Glass		code will locate it at run-time. Generally this works by:
10302c0f79e4SSimon Glass
10312c0f79e4SSimon Glass			cat u-boot.bin u-boot.dtb >image.bin
10322c0f79e4SSimon Glass
10332c0f79e4SSimon Glass		and in fact, U-Boot does this for you, creating a file called
10342c0f79e4SSimon Glass		u-boot-dtb.bin which is useful in the common case. You can
10352c0f79e4SSimon Glass		still use the individual files if you need something more
10362c0f79e4SSimon Glass		exotic.
10372c0f79e4SSimon Glass
1038c609719bSwdenk- Watchdog:
1039c609719bSwdenk		CONFIG_WATCHDOG
1040c609719bSwdenk		If this variable is defined, it enables watchdog
10416abe6fb6SDetlev Zundel		support for the SoC. There must be support in the SoC
10426abe6fb6SDetlev Zundel		specific code for a watchdog. For the 8xx and 8260
10436abe6fb6SDetlev Zundel		CPUs, the SIU Watchdog feature is enabled in the SYPCR
10446abe6fb6SDetlev Zundel		register.  When supported for a specific SoC is
10456abe6fb6SDetlev Zundel		available, then no further board specific code should
10466abe6fb6SDetlev Zundel		be needed to use it.
10476abe6fb6SDetlev Zundel
10486abe6fb6SDetlev Zundel		CONFIG_HW_WATCHDOG
10496abe6fb6SDetlev Zundel		When using a watchdog circuitry external to the used
10506abe6fb6SDetlev Zundel		SoC, then define this variable and provide board
10516abe6fb6SDetlev Zundel		specific code for the "hw_watchdog_reset" function.
1052c609719bSwdenk
1053c1551ea8Sstroese- U-Boot Version:
1054c1551ea8Sstroese		CONFIG_VERSION_VARIABLE
1055c1551ea8Sstroese		If this variable is defined, an environment variable
1056c1551ea8Sstroese		named "ver" is created by U-Boot showing the U-Boot
1057c1551ea8Sstroese		version as printed by the "version" command.
1058a1ea8e51SBenoît Thébaudeau		Any change to this variable will be reverted at the
1059a1ea8e51SBenoît Thébaudeau		next reset.
1060c1551ea8Sstroese
1061c609719bSwdenk- Real-Time Clock:
1062c609719bSwdenk
1063602ad3b3SJon Loeliger		When CONFIG_CMD_DATE is selected, the type of the RTC
1064c609719bSwdenk		has to be selected, too. Define exactly one of the
1065c609719bSwdenk		following options:
1066c609719bSwdenk
1067c609719bSwdenk		CONFIG_RTC_MPC8xx	- use internal RTC of MPC8xx
1068c609719bSwdenk		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
10694e8b7544SFabio Estevam		CONFIG_RTC_MC13XXX	- use MC13783 or MC13892 RTC
1070c609719bSwdenk		CONFIG_RTC_MC146818	- use MC146818 RTC
10711cb8e980Swdenk		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
1072c609719bSwdenk		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
10737f70e853Swdenk		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
10743bac3513Swdenk		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
10759536dfccSTor Krill		CONFIG_RTC_ISL1208	- use Intersil ISL1208 RTC
10764c0d4c3bSwdenk		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
10776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_DS1337_NOOSC	- Turn off the OSC output for DS1337
107871d19f30SHeiko Schocher		CONFIG_SYS_RV3029_TCR	- enable trickle charger on
107971d19f30SHeiko Schocher					  RV3029 RTC.
1080c609719bSwdenk
1081b37c7e5eSwdenk		Note that if the RTC uses I2C, then the I2C interface
1082b37c7e5eSwdenk		must also be configured. See I2C Support, below.
1083b37c7e5eSwdenk
1084e92739d3SPeter Tyser- GPIO Support:
1085e92739d3SPeter Tyser		CONFIG_PCA953X		- use NXP's PCA953X series I2C GPIO
1086e92739d3SPeter Tyser
10875dec49caSChris Packham		The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
10885dec49caSChris Packham		chip-ngpio pairs that tell the PCA953X driver the number of
10895dec49caSChris Packham		pins supported by a particular chip.
10905dec49caSChris Packham
1091e92739d3SPeter Tyser		Note that if the GPIO device uses I2C, then the I2C interface
1092e92739d3SPeter Tyser		must also be configured. See I2C Support, below.
1093e92739d3SPeter Tyser
1094c609719bSwdenk- Timestamp Support:
1095c609719bSwdenk
1096c609719bSwdenk		When CONFIG_TIMESTAMP is selected, the timestamp
1097c609719bSwdenk		(date and time) of an image is printed by image
1098c609719bSwdenk		commands like bootm or iminfo. This option is
1099602ad3b3SJon Loeliger		automatically enabled when you select CONFIG_CMD_DATE .
1100c609719bSwdenk
1101923c46f9SKarl O. Pinc- Partition Labels (disklabels) Supported:
1102923c46f9SKarl O. Pinc		Zero or more of the following:
1103923c46f9SKarl O. Pinc		CONFIG_MAC_PARTITION   Apple's MacOS partition table.
1104923c46f9SKarl O. Pinc		CONFIG_DOS_PARTITION   MS Dos partition table, traditional on the
1105923c46f9SKarl O. Pinc				       Intel architecture, USB sticks, etc.
1106923c46f9SKarl O. Pinc		CONFIG_ISO_PARTITION   ISO partition table, used on CDROM etc.
1107923c46f9SKarl O. Pinc		CONFIG_EFI_PARTITION   GPT partition table, common when EFI is the
1108923c46f9SKarl O. Pinc				       bootloader.  Note 2TB partition limit; see
1109923c46f9SKarl O. Pinc				       disk/part_efi.c
1110923c46f9SKarl O. Pinc		CONFIG_MTD_PARTITIONS  Memory Technology Device partition table.
1111c609719bSwdenk
1112602ad3b3SJon Loeliger		If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1113218ca724SWolfgang Denk		CONFIG_CMD_SCSI) you must configure support for at
1114923c46f9SKarl O. Pinc		least one non-MTD partition type as well.
1115c609719bSwdenk
1116c609719bSwdenk- IDE Reset method:
11174d13cbadSwdenk		CONFIG_IDE_RESET_ROUTINE - this is defined in several
11184d13cbadSwdenk		board configurations files but used nowhere!
1119c609719bSwdenk
11204d13cbadSwdenk		CONFIG_IDE_RESET - is this is defined, IDE Reset will
11214d13cbadSwdenk		be performed by calling the function
11224d13cbadSwdenk			ide_set_reset(int reset)
11234d13cbadSwdenk		which has to be defined in a board specific file
1124c609719bSwdenk
1125c609719bSwdenk- ATAPI Support:
1126c609719bSwdenk		CONFIG_ATAPI
1127c609719bSwdenk
1128c609719bSwdenk		Set this to enable ATAPI support.
1129c609719bSwdenk
1130c40b2956Swdenk- LBA48 Support
1131c40b2956Swdenk		CONFIG_LBA48
1132c40b2956Swdenk
1133c40b2956Swdenk		Set this to enable support for disks larger than 137GB
11344b142febSHeiko Schocher		Also look at CONFIG_SYS_64BIT_LBA.
1135c40b2956Swdenk		Whithout these , LBA48 support uses 32bit variables and will 'only'
1136c40b2956Swdenk		support disks up to 2.1TB.
1137c40b2956Swdenk
11386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_64BIT_LBA:
1139c40b2956Swdenk			When enabled, makes the IDE subsystem use 64bit sector addresses.
1140c40b2956Swdenk			Default is 32bit.
1141c40b2956Swdenk
1142c609719bSwdenk- SCSI Support:
1143c609719bSwdenk		At the moment only there is only support for the
1144c609719bSwdenk		SYM53C8XX SCSI controller; define
1145c609719bSwdenk		CONFIG_SCSI_SYM53C8XX to enable it.
1146c609719bSwdenk
11476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
11486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
11496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
1150c609719bSwdenk		maximum numbers of LUNs, SCSI ID's and target
1151c609719bSwdenk		devices.
11526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
1153c609719bSwdenk
1154447c031bSStefan Reinauer		The environment variable 'scsidevs' is set to the number of
1155447c031bSStefan Reinauer		SCSI devices found during the last scan.
1156447c031bSStefan Reinauer
1157c609719bSwdenk- NETWORK Support (PCI):
1158682011ffSwdenk		CONFIG_E1000
1159ce5207e1SKyle Moffett		Support for Intel 8254x/8257x gigabit chips.
1160ce5207e1SKyle Moffett
1161ce5207e1SKyle Moffett		CONFIG_E1000_SPI
1162ce5207e1SKyle Moffett		Utility code for direct access to the SPI bus on Intel 8257x.
1163ce5207e1SKyle Moffett		This does not do anything useful unless you set at least one
1164ce5207e1SKyle Moffett		of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1165ce5207e1SKyle Moffett
1166ce5207e1SKyle Moffett		CONFIG_E1000_SPI_GENERIC
1167ce5207e1SKyle Moffett		Allow generic access to the SPI bus on the Intel 8257x, for
1168ce5207e1SKyle Moffett		example with the "sspi" command.
1169ce5207e1SKyle Moffett
1170ce5207e1SKyle Moffett		CONFIG_CMD_E1000
1171ce5207e1SKyle Moffett		Management command for E1000 devices.  When used on devices
1172ce5207e1SKyle Moffett		with SPI support you can reprogram the EEPROM from U-Boot.
1173682011ffSwdenk
1174ac3315c2SAndre Schwarz		CONFIG_E1000_FALLBACK_MAC
117511ccc33fSMarcel Ziswiler		default MAC for empty EEPROM after production.
1176ac3315c2SAndre Schwarz
1177c609719bSwdenk		CONFIG_EEPRO100
1178c609719bSwdenk		Support for Intel 82557/82559/82559ER chips.
117911ccc33fSMarcel Ziswiler		Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
1180c609719bSwdenk		write routine for first time initialisation.
1181c609719bSwdenk
1182c609719bSwdenk		CONFIG_TULIP
1183c609719bSwdenk		Support for Digital 2114x chips.
1184c609719bSwdenk		Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1185c609719bSwdenk		modem chip initialisation (KS8761/QS6611).
1186c609719bSwdenk
1187c609719bSwdenk		CONFIG_NATSEMI
1188c609719bSwdenk		Support for National dp83815 chips.
1189c609719bSwdenk
1190c609719bSwdenk		CONFIG_NS8382X
1191c609719bSwdenk		Support for National dp8382[01] gigabit chips.
1192c609719bSwdenk
119345219c46Swdenk- NETWORK Support (other):
119445219c46Swdenk
1195c041e9d2SJens Scharsig		CONFIG_DRIVER_AT91EMAC
1196c041e9d2SJens Scharsig		Support for AT91RM9200 EMAC.
1197c041e9d2SJens Scharsig
1198c041e9d2SJens Scharsig			CONFIG_RMII
1199c041e9d2SJens Scharsig			Define this to use reduced MII inteface
1200c041e9d2SJens Scharsig
1201c041e9d2SJens Scharsig			CONFIG_DRIVER_AT91EMAC_QUIET
1202c041e9d2SJens Scharsig			If this defined, the driver is quiet.
1203c041e9d2SJens Scharsig			The driver doen't show link status messages.
1204c041e9d2SJens Scharsig
1205efdd7319SRob Herring		CONFIG_CALXEDA_XGMAC
1206efdd7319SRob Herring		Support for the Calxeda XGMAC device
1207efdd7319SRob Herring
12083bb46d23SAshok		CONFIG_LAN91C96
120945219c46Swdenk		Support for SMSC's LAN91C96 chips.
121045219c46Swdenk
121145219c46Swdenk			CONFIG_LAN91C96_BASE
121245219c46Swdenk			Define this to hold the physical address
121345219c46Swdenk			of the LAN91C96's I/O space
121445219c46Swdenk
121545219c46Swdenk			CONFIG_LAN91C96_USE_32_BIT
121645219c46Swdenk			Define this to enable 32 bit addressing
121745219c46Swdenk
12183bb46d23SAshok		CONFIG_SMC91111
1219f39748aeSwdenk		Support for SMSC's LAN91C111 chip
1220f39748aeSwdenk
1221f39748aeSwdenk			CONFIG_SMC91111_BASE
1222f39748aeSwdenk			Define this to hold the physical address
1223f39748aeSwdenk			of the device (I/O space)
1224f39748aeSwdenk
1225f39748aeSwdenk			CONFIG_SMC_USE_32_BIT
1226f39748aeSwdenk			Define this if data bus is 32 bits
1227f39748aeSwdenk
1228f39748aeSwdenk			CONFIG_SMC_USE_IOFUNCS
1229f39748aeSwdenk			Define this to use i/o functions instead of macros
1230f39748aeSwdenk			(some hardware wont work with macros)
1231f39748aeSwdenk
1232dc02badaSHeiko Schocher		CONFIG_DRIVER_TI_EMAC
1233dc02badaSHeiko Schocher		Support for davinci emac
1234dc02badaSHeiko Schocher
1235dc02badaSHeiko Schocher			CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1236dc02badaSHeiko Schocher			Define this if you have more then 3 PHYs.
1237dc02badaSHeiko Schocher
1238b3dbf4a5SMacpaul Lin		CONFIG_FTGMAC100
1239b3dbf4a5SMacpaul Lin		Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1240b3dbf4a5SMacpaul Lin
1241b3dbf4a5SMacpaul Lin			CONFIG_FTGMAC100_EGIGA
1242b3dbf4a5SMacpaul Lin			Define this to use GE link update with gigabit PHY.
1243b3dbf4a5SMacpaul Lin			Define this if FTGMAC100 is connected to gigabit PHY.
1244b3dbf4a5SMacpaul Lin			If your system has 10/100 PHY only, it might not occur
1245b3dbf4a5SMacpaul Lin			wrong behavior. Because PHY usually return timeout or
1246b3dbf4a5SMacpaul Lin			useless data when polling gigabit status and gigabit
1247b3dbf4a5SMacpaul Lin			control registers. This behavior won't affect the
1248b3dbf4a5SMacpaul Lin			correctnessof 10/100 link speed update.
1249b3dbf4a5SMacpaul Lin
1250c2fff331SMike Rapoport		CONFIG_SMC911X
1251557b377dSJens Gehrlein		Support for SMSC's LAN911x and LAN921x chips
1252557b377dSJens Gehrlein
1253c2fff331SMike Rapoport			CONFIG_SMC911X_BASE
1254557b377dSJens Gehrlein			Define this to hold the physical address
1255557b377dSJens Gehrlein			of the device (I/O space)
1256557b377dSJens Gehrlein
1257c2fff331SMike Rapoport			CONFIG_SMC911X_32_BIT
1258557b377dSJens Gehrlein			Define this if data bus is 32 bits
1259557b377dSJens Gehrlein
1260c2fff331SMike Rapoport			CONFIG_SMC911X_16_BIT
1261557b377dSJens Gehrlein			Define this if data bus is 16 bits. If your processor
1262557b377dSJens Gehrlein			automatically converts one 32 bit word to two 16 bit
1263c2fff331SMike Rapoport			words you may also try CONFIG_SMC911X_32_BIT.
1264557b377dSJens Gehrlein
12653d0075faSYoshihiro Shimoda		CONFIG_SH_ETHER
12663d0075faSYoshihiro Shimoda		Support for Renesas on-chip Ethernet controller
12673d0075faSYoshihiro Shimoda
12683d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_USE_PORT
12693d0075faSYoshihiro Shimoda			Define the number of ports to be used
12703d0075faSYoshihiro Shimoda
12713d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_PHY_ADDR
12723d0075faSYoshihiro Shimoda			Define the ETH PHY's address
12733d0075faSYoshihiro Shimoda
127468260aabSYoshihiro Shimoda			CONFIG_SH_ETHER_CACHE_WRITEBACK
127568260aabSYoshihiro Shimoda			If this option is set, the driver enables cache flush.
127668260aabSYoshihiro Shimoda
12775e124724SVadim Bendebury- TPM Support:
127890899cc0SChe-liang Chiou		CONFIG_TPM
127990899cc0SChe-liang Chiou		Support TPM devices.
128090899cc0SChe-liang Chiou
12811b393db5STom Wai-Hong Tam		CONFIG_TPM_TIS_I2C
12821b393db5STom Wai-Hong Tam		Support for i2c bus TPM devices. Only one device
12831b393db5STom Wai-Hong Tam		per system is supported at this time.
12841b393db5STom Wai-Hong Tam
12851b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_BUS_NUMBER
12861b393db5STom Wai-Hong Tam			Define the the i2c bus number for the TPM device
12871b393db5STom Wai-Hong Tam
12881b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS
12891b393db5STom Wai-Hong Tam			Define the TPM's address on the i2c bus
12901b393db5STom Wai-Hong Tam
12911b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_BURST_LIMITATION
12921b393db5STom Wai-Hong Tam			Define the burst count bytes upper limit
12931b393db5STom Wai-Hong Tam
1294c01939c7SDirk Eibach		CONFIG_TPM_ATMEL_TWI
1295c01939c7SDirk Eibach		Support for Atmel TWI TPM device. Requires I2C support.
1296c01939c7SDirk Eibach
129790899cc0SChe-liang Chiou		CONFIG_TPM_TIS_LPC
12985e124724SVadim Bendebury		Support for generic parallel port TPM devices. Only one device
12995e124724SVadim Bendebury		per system is supported at this time.
13005e124724SVadim Bendebury
13015e124724SVadim Bendebury			CONFIG_TPM_TIS_BASE_ADDRESS
13025e124724SVadim Bendebury			Base address where the generic TPM device is mapped
13035e124724SVadim Bendebury			to. Contemporary x86 systems usually map it at
13045e124724SVadim Bendebury			0xfed40000.
13055e124724SVadim Bendebury
1306be6c1529SReinhard Pfau		CONFIG_CMD_TPM
1307be6c1529SReinhard Pfau		Add tpm monitor functions.
1308be6c1529SReinhard Pfau		Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1309be6c1529SReinhard Pfau		provides monitor access to authorized functions.
1310be6c1529SReinhard Pfau
1311be6c1529SReinhard Pfau		CONFIG_TPM
1312be6c1529SReinhard Pfau		Define this to enable the TPM support library which provides
1313be6c1529SReinhard Pfau		functional interfaces to some TPM commands.
1314be6c1529SReinhard Pfau		Requires support for a TPM device.
1315be6c1529SReinhard Pfau
1316be6c1529SReinhard Pfau		CONFIG_TPM_AUTH_SESSIONS
1317be6c1529SReinhard Pfau		Define this to enable authorized functions in the TPM library.
1318be6c1529SReinhard Pfau		Requires CONFIG_TPM and CONFIG_SHA1.
1319be6c1529SReinhard Pfau
1320c609719bSwdenk- USB Support:
1321c609719bSwdenk		At the moment only the UHCI host controller is
13224d13cbadSwdenk		supported (PIP405, MIP405, MPC5200); define
1323c609719bSwdenk		CONFIG_USB_UHCI to enable it.
1324c609719bSwdenk		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
132530d56faeSwdenk		and define CONFIG_USB_STORAGE to enable the USB
1326c609719bSwdenk		storage devices.
1327c609719bSwdenk		Note:
1328c609719bSwdenk		Supported are USB Keyboards and USB Floppy drives
1329c609719bSwdenk		(TEAC FD-05PUB).
13304d13cbadSwdenk		MPC5200 USB requires additional defines:
13314d13cbadSwdenk			CONFIG_USB_CLOCK
13324d13cbadSwdenk				for 528 MHz Clock: 0x0001bbbb
1333307ecb6dSEric Millbrandt			CONFIG_PSC3_USB
1334307ecb6dSEric Millbrandt				for USB on PSC3
13354d13cbadSwdenk			CONFIG_USB_CONFIG
13364d13cbadSwdenk				for differential drivers: 0x00001000
13374d13cbadSwdenk				for single ended drivers: 0x00005000
1338307ecb6dSEric Millbrandt				for differential drivers on PSC3: 0x00000100
1339307ecb6dSEric Millbrandt				for single ended drivers on PSC3: 0x00004100
13406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_USB_EVENT_POLL
1341fdcfaa1bSZhang Wei				May be defined to allow interrupt polling
1342fdcfaa1bSZhang Wei				instead of using asynchronous interrupts
13434d13cbadSwdenk
13449ab4ce22SSimon Glass		CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
13459ab4ce22SSimon Glass		txfilltuning field in the EHCI controller on reset.
13469ab4ce22SSimon Glass
1347aa155058SKuo-Jung Su		CONFIG_USB_HUB_MIN_POWER_ON_DELAY defines the minimum
1348aa155058SKuo-Jung Su		interval for usb hub power-on delay.(minimum 100msec)
1349aa155058SKuo-Jung Su
135016c8d5e7SWolfgang Denk- USB Device:
135116c8d5e7SWolfgang Denk		Define the below if you wish to use the USB console.
135216c8d5e7SWolfgang Denk		Once firmware is rebuilt from a serial console issue the
135316c8d5e7SWolfgang Denk		command "setenv stdin usbtty; setenv stdout usbtty" and
135411ccc33fSMarcel Ziswiler		attach your USB cable. The Unix command "dmesg" should print
135516c8d5e7SWolfgang Denk		it has found a new device. The environment variable usbtty
135616c8d5e7SWolfgang Denk		can be set to gserial or cdc_acm to enable your device to
135716c8d5e7SWolfgang Denk		appear to a USB host as a Linux gserial device or a
135816c8d5e7SWolfgang Denk		Common Device Class Abstract Control Model serial device.
135916c8d5e7SWolfgang Denk		If you select usbtty = gserial you should be able to enumerate
136016c8d5e7SWolfgang Denk		a Linux host by
136116c8d5e7SWolfgang Denk		# modprobe usbserial vendor=0xVendorID product=0xProductID
136216c8d5e7SWolfgang Denk		else if using cdc_acm, simply setting the environment
136316c8d5e7SWolfgang Denk		variable usbtty to be cdc_acm should suffice. The following
136416c8d5e7SWolfgang Denk		might be defined in YourBoardName.h
136516c8d5e7SWolfgang Denk
136616c8d5e7SWolfgang Denk			CONFIG_USB_DEVICE
136716c8d5e7SWolfgang Denk			Define this to build a UDC device
136816c8d5e7SWolfgang Denk
136916c8d5e7SWolfgang Denk			CONFIG_USB_TTY
137016c8d5e7SWolfgang Denk			Define this to have a tty type of device available to
137116c8d5e7SWolfgang Denk			talk to the UDC device
137216c8d5e7SWolfgang Denk
1373f9da0f89SVipin KUMAR			CONFIG_USBD_HS
1374f9da0f89SVipin KUMAR			Define this to enable the high speed support for usb
1375f9da0f89SVipin KUMAR			device and usbtty. If this feature is enabled, a routine
1376f9da0f89SVipin KUMAR			int is_usbd_high_speed(void)
1377f9da0f89SVipin KUMAR			also needs to be defined by the driver to dynamically poll
1378f9da0f89SVipin KUMAR			whether the enumeration has succeded at high speed or full
1379f9da0f89SVipin KUMAR			speed.
1380f9da0f89SVipin KUMAR
13816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_IS_IN_ENV
138216c8d5e7SWolfgang Denk			Define this if you want stdin, stdout &/or stderr to
138316c8d5e7SWolfgang Denk			be set to usbtty.
138416c8d5e7SWolfgang Denk
138516c8d5e7SWolfgang Denk			mpc8xx:
13866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_EXTC_CLK 0xBLAH
138716c8d5e7SWolfgang Denk				Derive USB clock from external clock "blah"
13886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_EXTC_CLK 0x02
138916c8d5e7SWolfgang Denk
13906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_BRG_CLK 0xBLAH
139116c8d5e7SWolfgang Denk				Derive USB clock from brgclk
13926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_BRG_CLK 0x04
139316c8d5e7SWolfgang Denk
139416c8d5e7SWolfgang Denk		If you have a USB-IF assigned VendorID then you may wish to
139516c8d5e7SWolfgang Denk		define your own vendor specific values either in BoardName.h
139616c8d5e7SWolfgang Denk		or directly in usbd_vendor_info.h. If you don't define
139716c8d5e7SWolfgang Denk		CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
139816c8d5e7SWolfgang Denk		CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
139916c8d5e7SWolfgang Denk		should pretend to be a Linux device to it's target host.
140016c8d5e7SWolfgang Denk
140116c8d5e7SWolfgang Denk			CONFIG_USBD_MANUFACTURER
140216c8d5e7SWolfgang Denk			Define this string as the name of your company for
140316c8d5e7SWolfgang Denk			- CONFIG_USBD_MANUFACTURER "my company"
140416c8d5e7SWolfgang Denk
140516c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCT_NAME
140616c8d5e7SWolfgang Denk			Define this string as the name of your product
140716c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCT_NAME "acme usb device"
140816c8d5e7SWolfgang Denk
140916c8d5e7SWolfgang Denk			CONFIG_USBD_VENDORID
141016c8d5e7SWolfgang Denk			Define this as your assigned Vendor ID from the USB
141116c8d5e7SWolfgang Denk			Implementors Forum. This *must* be a genuine Vendor ID
141216c8d5e7SWolfgang Denk			to avoid polluting the USB namespace.
141316c8d5e7SWolfgang Denk			- CONFIG_USBD_VENDORID 0xFFFF
141416c8d5e7SWolfgang Denk
141516c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCTID
141616c8d5e7SWolfgang Denk			Define this as the unique Product ID
141716c8d5e7SWolfgang Denk			for your device
141816c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCTID 0xFFFF
1419c609719bSwdenk
1420351e9b20SPrzemyslaw Marczak		Some USB device drivers may need to check USB cable attachment.
1421351e9b20SPrzemyslaw Marczak		In this case you can enable following config in BoardName.h:
1422351e9b20SPrzemyslaw Marczak			CONFIG_USB_CABLE_CHECK
1423351e9b20SPrzemyslaw Marczak			This enables function definition:
1424351e9b20SPrzemyslaw Marczak			- usb_cable_connected() in include/usb.h
1425351e9b20SPrzemyslaw Marczak			Implementation of this function is board-specific.
1426351e9b20SPrzemyslaw Marczak
1427d70a560fSIgor Grinberg- ULPI Layer Support:
1428d70a560fSIgor Grinberg		The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1429d70a560fSIgor Grinberg		the generic ULPI layer. The generic layer accesses the ULPI PHY
1430d70a560fSIgor Grinberg		via the platform viewport, so you need both the genric layer and
1431d70a560fSIgor Grinberg		the viewport enabled. Currently only Chipidea/ARC based
1432d70a560fSIgor Grinberg		viewport is supported.
1433d70a560fSIgor Grinberg		To enable the ULPI layer support, define CONFIG_USB_ULPI and
1434d70a560fSIgor Grinberg		CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
14356d365ea0SLucas Stach		If your ULPI phy needs a different reference clock than the
14366d365ea0SLucas Stach		standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
14376d365ea0SLucas Stach		the appropriate value in Hz.
1438c609719bSwdenk
1439c609719bSwdenk- MMC Support:
1440c609719bSwdenk		The MMC controller on the Intel PXA is supported. To
1441c609719bSwdenk		enable this define CONFIG_MMC. The MMC can be
1442c609719bSwdenk		accessed from the boot prompt by mapping the device
1443c609719bSwdenk		to physical memory similar to flash. Command line is
1444602ad3b3SJon Loeliger		enabled with CONFIG_CMD_MMC. The MMC driver also works with
1445602ad3b3SJon Loeliger		the FAT fs. This is enabled with CONFIG_CMD_FAT.
1446c609719bSwdenk
1447afb35666SYoshihiro Shimoda		CONFIG_SH_MMCIF
1448afb35666SYoshihiro Shimoda		Support for Renesas on-chip MMCIF controller
1449afb35666SYoshihiro Shimoda
1450afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_ADDR
1451afb35666SYoshihiro Shimoda			Define the base address of MMCIF registers
1452afb35666SYoshihiro Shimoda
1453afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_CLK
1454afb35666SYoshihiro Shimoda			Define the clock frequency for MMCIF
1455afb35666SYoshihiro Shimoda
1456b3ba6e94STom Rini- USB Device Firmware Update (DFU) class support:
1457b3ba6e94STom Rini		CONFIG_DFU_FUNCTION
1458b3ba6e94STom Rini		This enables the USB portion of the DFU USB class
1459b3ba6e94STom Rini
1460b3ba6e94STom Rini		CONFIG_CMD_DFU
1461b3ba6e94STom Rini		This enables the command "dfu" which is used to have
1462b3ba6e94STom Rini		U-Boot create a DFU class device via USB.  This command
1463b3ba6e94STom Rini		requires that the "dfu_alt_info" environment variable be
1464b3ba6e94STom Rini		set and define the alt settings to expose to the host.
1465b3ba6e94STom Rini
1466b3ba6e94STom Rini		CONFIG_DFU_MMC
1467b3ba6e94STom Rini		This enables support for exposing (e)MMC devices via DFU.
1468b3ba6e94STom Rini
1469c6631764SPantelis Antoniou		CONFIG_DFU_NAND
1470c6631764SPantelis Antoniou		This enables support for exposing NAND devices via DFU.
1471c6631764SPantelis Antoniou
1472a9479f04SAfzal Mohammed		CONFIG_DFU_RAM
1473a9479f04SAfzal Mohammed		This enables support for exposing RAM via DFU.
1474a9479f04SAfzal Mohammed		Note: DFU spec refer to non-volatile memory usage, but
1475a9479f04SAfzal Mohammed		allow usages beyond the scope of spec - here RAM usage,
1476a9479f04SAfzal Mohammed		one that would help mostly the developer.
1477a9479f04SAfzal Mohammed
1478e7e75c70SHeiko Schocher		CONFIG_SYS_DFU_DATA_BUF_SIZE
1479e7e75c70SHeiko Schocher		Dfu transfer uses a buffer before writing data to the
1480e7e75c70SHeiko Schocher		raw storage device. Make the size (in bytes) of this buffer
1481e7e75c70SHeiko Schocher		configurable. The size of this buffer is also configurable
1482e7e75c70SHeiko Schocher		through the "dfu_bufsiz" environment variable.
1483e7e75c70SHeiko Schocher
1484ea2453d5SPantelis Antoniou		CONFIG_SYS_DFU_MAX_FILE_SIZE
1485ea2453d5SPantelis Antoniou		When updating files rather than the raw storage device,
1486ea2453d5SPantelis Antoniou		we use a static buffer to copy the file into and then write
1487ea2453d5SPantelis Antoniou		the buffer once we've been given the whole file.  Define
1488ea2453d5SPantelis Antoniou		this to the maximum filesize (in bytes) for the buffer.
1489ea2453d5SPantelis Antoniou		Default is 4 MiB if undefined.
1490ea2453d5SPantelis Antoniou
14916705d81eSwdenk- Journaling Flash filesystem support:
14926705d81eSwdenk		CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
14936705d81eSwdenk		CONFIG_JFFS2_NAND_DEV
14946705d81eSwdenk		Define these for a default partition on a NAND device
14956705d81eSwdenk
14966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_SECTOR,
14976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
14986705d81eSwdenk		Define these for a default partition on a NOR device
14996705d81eSwdenk
15006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS_CUSTOM_PART
15016705d81eSwdenk		Define this to create an own partition. You have to provide a
15026705d81eSwdenk		function struct part_info* jffs2_part_info(int part_num)
15036705d81eSwdenk
15046705d81eSwdenk		If you define only one JFFS2 partition you may also want to
15056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_JFFS_SINGLE_PART	1
15066705d81eSwdenk		to disable the command chpart. This is the default when you
15076705d81eSwdenk		have not defined a custom partition
15086705d81eSwdenk
1509c30a15e5SDonggeun Kim- FAT(File Allocation Table) filesystem write function support:
1510c30a15e5SDonggeun Kim		CONFIG_FAT_WRITE
1511656f4c65SDonggeun Kim
1512656f4c65SDonggeun Kim		Define this to enable support for saving memory data as a
1513656f4c65SDonggeun Kim		file in FAT formatted partition.
1514656f4c65SDonggeun Kim
1515656f4c65SDonggeun Kim		This will also enable the command "fatwrite" enabling the
1516656f4c65SDonggeun Kim		user to write files to FAT.
1517c30a15e5SDonggeun Kim
151884cd9327SGabe BlackCBFS (Coreboot Filesystem) support
151984cd9327SGabe Black		CONFIG_CMD_CBFS
152084cd9327SGabe Black
152184cd9327SGabe Black		Define this to enable support for reading from a Coreboot
152284cd9327SGabe Black		filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
152384cd9327SGabe Black		and cbfsload.
152484cd9327SGabe Black
1525c609719bSwdenk- Keyboard Support:
1526c609719bSwdenk		CONFIG_ISA_KEYBOARD
1527c609719bSwdenk
1528c609719bSwdenk		Define this to enable standard (PC-Style) keyboard
1529c609719bSwdenk		support
1530c609719bSwdenk
1531c609719bSwdenk		CONFIG_I8042_KBD
1532c609719bSwdenk		Standard PC keyboard driver with US (is default) and
1533c609719bSwdenk		GERMAN key layout (switch via environment 'keymap=de') support.
1534c609719bSwdenk		Export function i8042_kbd_init, i8042_tstc and i8042_getc
1535c609719bSwdenk		for cfb_console. Supports cursor blinking.
1536c609719bSwdenk
1537713cb680SHung-ying Tyan		CONFIG_CROS_EC_KEYB
1538713cb680SHung-ying Tyan		Enables a Chrome OS keyboard using the CROS_EC interface.
1539713cb680SHung-ying Tyan		This uses CROS_EC to communicate with a second microcontroller
1540713cb680SHung-ying Tyan		which provides key scans on request.
1541713cb680SHung-ying Tyan
1542c609719bSwdenk- Video support:
1543c609719bSwdenk		CONFIG_VIDEO
1544c609719bSwdenk
1545c609719bSwdenk		Define this to enable video support (for output to
1546c609719bSwdenk		video).
1547c609719bSwdenk
1548c609719bSwdenk		CONFIG_VIDEO_CT69000
1549c609719bSwdenk
1550c609719bSwdenk		Enable Chips & Technologies 69000 Video chip
1551c609719bSwdenk
1552c609719bSwdenk		CONFIG_VIDEO_SMI_LYNXEM
1553eeb1b77bSwdenk		Enable Silicon Motion SMI 712/710/810 Video chip. The
1554eeb1b77bSwdenk		video output is selected via environment 'videoout'
1555eeb1b77bSwdenk		(1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1556eeb1b77bSwdenk		assumed.
1557c609719bSwdenk
1558eeb1b77bSwdenk		For the CT69000 and SMI_LYNXEM drivers, videomode is
155911ccc33fSMarcel Ziswiler		selected via environment 'videomode'. Two different ways
1560eeb1b77bSwdenk		are possible:
1561eeb1b77bSwdenk		- "videomode=num"   'num' is a standard LiLo mode numbers.
1562eeb1b77bSwdenk		Following standard modes are supported	(* is default):
1563eeb1b77bSwdenk
1564eeb1b77bSwdenk		      Colors	640x480 800x600 1024x768 1152x864 1280x1024
1565eeb1b77bSwdenk		-------------+---------------------------------------------
1566eeb1b77bSwdenk		      8 bits |	0x301*	0x303	 0x305	  0x161	    0x307
1567eeb1b77bSwdenk		     15 bits |	0x310	0x313	 0x316	  0x162	    0x319
1568eeb1b77bSwdenk		     16 bits |	0x311	0x314	 0x317	  0x163	    0x31A
1569eeb1b77bSwdenk		     24 bits |	0x312	0x315	 0x318	    ?	    0x31B
1570eeb1b77bSwdenk		-------------+---------------------------------------------
1571c609719bSwdenk		(i.e. setenv videomode 317; saveenv; reset;)
1572c609719bSwdenk
1573eeb1b77bSwdenk		- "videomode=bootargs" all the video parameters are parsed
15747817cb20SMarcel Ziswiler		from the bootargs. (See drivers/video/videomodes.c)
1575eeb1b77bSwdenk
1576eeb1b77bSwdenk
1577a6c7ad2fSwdenk		CONFIG_VIDEO_SED13806
1578a6c7ad2fSwdenk		Enable Epson SED13806 driver. This driver supports 8bpp
1579a6c7ad2fSwdenk		and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1580a6c7ad2fSwdenk		or CONFIG_VIDEO_SED13806_16BPP
1581a6c7ad2fSwdenk
15827d3053fbSTimur Tabi		CONFIG_FSL_DIU_FB
15837d3053fbSTimur Tabi		Enable the Freescale DIU video driver.	Reference boards for
15847d3053fbSTimur Tabi		SOCs that have a DIU should define this macro to enable DIU
15857d3053fbSTimur Tabi		support, and should also define these other macros:
15867d3053fbSTimur Tabi
15877d3053fbSTimur Tabi			CONFIG_SYS_DIU_ADDR
15887d3053fbSTimur Tabi			CONFIG_VIDEO
15897d3053fbSTimur Tabi			CONFIG_CMD_BMP
15907d3053fbSTimur Tabi			CONFIG_CFB_CONSOLE
15917d3053fbSTimur Tabi			CONFIG_VIDEO_SW_CURSOR
15927d3053fbSTimur Tabi			CONFIG_VGA_AS_SINGLE_DEVICE
15937d3053fbSTimur Tabi			CONFIG_VIDEO_LOGO
15947d3053fbSTimur Tabi			CONFIG_VIDEO_BMP_LOGO
15957d3053fbSTimur Tabi
1596ba8e76bdSTimur Tabi		The DIU driver will look for the 'video-mode' environment
1597ba8e76bdSTimur Tabi		variable, and if defined, enable the DIU as a console during
1598ba8e76bdSTimur Tabi		boot.  See the documentation file README.video for a
1599ba8e76bdSTimur Tabi		description of this variable.
16007d3053fbSTimur Tabi
1601058d59b0SSimon Glass		CONFIG_VIDEO_VGA
1602058d59b0SSimon Glass
1603058d59b0SSimon Glass		Enable the VGA video / BIOS for x86. The alternative if you
1604058d59b0SSimon Glass		are using coreboot is to use the coreboot frame buffer
1605058d59b0SSimon Glass		driver.
1606058d59b0SSimon Glass
1607058d59b0SSimon Glass
1608682011ffSwdenk- Keyboard Support:
1609682011ffSwdenk		CONFIG_KEYBOARD
1610682011ffSwdenk
1611682011ffSwdenk		Define this to enable a custom keyboard support.
1612682011ffSwdenk		This simply calls drv_keyboard_init() which must be
1613682011ffSwdenk		defined in your board-specific files.
1614682011ffSwdenk		The only board using this so far is RBC823.
1615a6c7ad2fSwdenk
1616c609719bSwdenk- LCD Support:	CONFIG_LCD
1617c609719bSwdenk
1618c609719bSwdenk		Define this to enable LCD support (for output to LCD
1619c609719bSwdenk		display); also select one of the supported displays
1620c609719bSwdenk		by defining one of these:
1621c609719bSwdenk
162239cf4804SStelian Pop		CONFIG_ATMEL_LCD:
162339cf4804SStelian Pop
162439cf4804SStelian Pop			HITACHI TX09D70VM1CCA, 3.5", 240x320.
162539cf4804SStelian Pop
1626fd3103bbSwdenk		CONFIG_NEC_NL6448AC33:
1627c609719bSwdenk
1628fd3103bbSwdenk			NEC NL6448AC33-18. Active, color, single scan.
1629c609719bSwdenk
1630fd3103bbSwdenk		CONFIG_NEC_NL6448BC20
1631c609719bSwdenk
1632fd3103bbSwdenk			NEC NL6448BC20-08. 6.5", 640x480.
1633fd3103bbSwdenk			Active, color, single scan.
1634fd3103bbSwdenk
1635fd3103bbSwdenk		CONFIG_NEC_NL6448BC33_54
1636fd3103bbSwdenk
1637fd3103bbSwdenk			NEC NL6448BC33-54. 10.4", 640x480.
1638c609719bSwdenk			Active, color, single scan.
1639c609719bSwdenk
1640c609719bSwdenk		CONFIG_SHARP_16x9
1641c609719bSwdenk
1642c609719bSwdenk			Sharp 320x240. Active, color, single scan.
1643c609719bSwdenk			It isn't 16x9, and I am not sure what it is.
1644c609719bSwdenk
1645c609719bSwdenk		CONFIG_SHARP_LQ64D341
1646c609719bSwdenk
1647c609719bSwdenk			Sharp LQ64D341 display, 640x480.
1648c609719bSwdenk			Active, color, single scan.
1649c609719bSwdenk
1650c609719bSwdenk		CONFIG_HLD1045
1651c609719bSwdenk
1652c609719bSwdenk			HLD1045 display, 640x480.
1653c609719bSwdenk			Active, color, single scan.
1654c609719bSwdenk
1655c609719bSwdenk		CONFIG_OPTREX_BW
1656c609719bSwdenk
1657c609719bSwdenk			Optrex	 CBL50840-2 NF-FW 99 22 M5
1658c609719bSwdenk			or
1659c609719bSwdenk			Hitachi	 LMG6912RPFC-00T
1660c609719bSwdenk			or
1661c609719bSwdenk			Hitachi	 SP14Q002
1662c609719bSwdenk
1663c609719bSwdenk			320x240. Black & white.
1664c609719bSwdenk
1665c609719bSwdenk		Normally display is black on white background; define
16666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
1667c609719bSwdenk
1668676d319eSSimon Glass		CONFIG_LCD_ALIGNMENT
1669676d319eSSimon Glass
1670676d319eSSimon Glass		Normally the LCD is page-aligned (tyically 4KB). If this is
1671676d319eSSimon Glass		defined then the LCD will be aligned to this value instead.
1672676d319eSSimon Glass		For ARM it is sometimes useful to use MMU_SECTION_SIZE
1673676d319eSSimon Glass		here, since it is cheaper to change data cache settings on
1674676d319eSSimon Glass		a per-section basis.
1675676d319eSSimon Glass
16760d89efefSSimon Glass		CONFIG_CONSOLE_SCROLL_LINES
16770d89efefSSimon Glass
16780d89efefSSimon Glass		When the console need to be scrolled, this is the number of
16790d89efefSSimon Glass		lines to scroll by. It defaults to 1. Increasing this makes
16800d89efefSSimon Glass		the console jump but can help speed up operation when scrolling
16810d89efefSSimon Glass		is slow.
1682676d319eSSimon Glass
168345d7f525STom Wai-Hong Tam		CONFIG_LCD_BMP_RLE8
168445d7f525STom Wai-Hong Tam
168545d7f525STom Wai-Hong Tam		Support drawing of RLE8-compressed bitmaps on the LCD.
168645d7f525STom Wai-Hong Tam
1687735987c5STom Wai-Hong Tam		CONFIG_I2C_EDID
1688735987c5STom Wai-Hong Tam
1689735987c5STom Wai-Hong Tam		Enables an 'i2c edid' command which can read EDID
1690735987c5STom Wai-Hong Tam		information over I2C from an attached LCD display.
1691735987c5STom Wai-Hong Tam
16927152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN
1693d791b1dcSwdenk
1694d791b1dcSwdenk		If this option is set, the environment is checked for
1695d791b1dcSwdenk		a variable "splashimage". If found, the usual display
1696d791b1dcSwdenk		of logo, copyright and system information on the LCD
1697e94d2cd9Swdenk		is suppressed and the BMP image at the address
1698d791b1dcSwdenk		specified in "splashimage" is loaded instead. The
1699d791b1dcSwdenk		console is redirected to the "nulldev", too. This
1700d791b1dcSwdenk		allows for a "silent" boot where a splash screen is
1701d791b1dcSwdenk		loaded very quickly after power-on.
1702d791b1dcSwdenk
1703c0880485SNikita Kiryanov		CONFIG_SPLASHIMAGE_GUARD
1704c0880485SNikita Kiryanov
1705c0880485SNikita Kiryanov		If this option is set, then U-Boot will prevent the environment
1706c0880485SNikita Kiryanov		variable "splashimage" from being set to a problematic address
1707c0880485SNikita Kiryanov		(see README.displaying-bmps and README.arm-unaligned-accesses).
1708c0880485SNikita Kiryanov		This option is useful for targets where, due to alignment
1709c0880485SNikita Kiryanov		restrictions, an improperly aligned BMP image will cause a data
1710c0880485SNikita Kiryanov		abort. If you think you will not have problems with unaligned
1711c0880485SNikita Kiryanov		accesses (for example because your toolchain prevents them)
1712c0880485SNikita Kiryanov		there is no need to set this option.
1713c0880485SNikita Kiryanov
17141ca298ceSMatthias Weisser		CONFIG_SPLASH_SCREEN_ALIGN
17151ca298ceSMatthias Weisser
17161ca298ceSMatthias Weisser		If this option is set the splash image can be freely positioned
17171ca298ceSMatthias Weisser		on the screen. Environment variable "splashpos" specifies the
17181ca298ceSMatthias Weisser		position as "x,y". If a positive number is given it is used as
17191ca298ceSMatthias Weisser		number of pixel from left/top. If a negative number is given it
17201ca298ceSMatthias Weisser		is used as number of pixel from right/bottom. You can also
17211ca298ceSMatthias Weisser		specify 'm' for centering the image.
17221ca298ceSMatthias Weisser
17231ca298ceSMatthias Weisser		Example:
17241ca298ceSMatthias Weisser		setenv splashpos m,m
17251ca298ceSMatthias Weisser			=> image at center of screen
17261ca298ceSMatthias Weisser
17271ca298ceSMatthias Weisser		setenv splashpos 30,20
17281ca298ceSMatthias Weisser			=> image at x = 30 and y = 20
17291ca298ceSMatthias Weisser
17301ca298ceSMatthias Weisser		setenv splashpos -10,m
17311ca298ceSMatthias Weisser			=> vertically centered image
17321ca298ceSMatthias Weisser			   at x = dspWidth - bmpWidth - 9
17331ca298ceSMatthias Weisser
173498f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
173598f4a3dfSStefan Roese
173698f4a3dfSStefan Roese		If this option is set, additionally to standard BMP
173798f4a3dfSStefan Roese		images, gzipped BMP images can be displayed via the
173898f4a3dfSStefan Roese		splashscreen support or the bmp command.
173998f4a3dfSStefan Roese
1740d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1741d5011762SAnatolij Gustschin
1742d5011762SAnatolij Gustschin		If this option is set, 8-bit RLE compressed BMP images
1743d5011762SAnatolij Gustschin		can be displayed via the splashscreen support or the
1744d5011762SAnatolij Gustschin		bmp command.
1745d5011762SAnatolij Gustschin
1746f2b96dfbSLei Wen- Do compresssing for memory range:
1747f2b96dfbSLei Wen		CONFIG_CMD_ZIP
1748f2b96dfbSLei Wen
1749f2b96dfbSLei Wen		If this option is set, it would use zlib deflate method
1750f2b96dfbSLei Wen		to compress the specified memory at its best effort.
1751f2b96dfbSLei Wen
1752c29fdfc1Swdenk- Compression support:
17538ef70478SKees Cook		CONFIG_GZIP
17548ef70478SKees Cook
17558ef70478SKees Cook		Enabled by default to support gzip compressed images.
17568ef70478SKees Cook
1757c29fdfc1Swdenk		CONFIG_BZIP2
1758c29fdfc1Swdenk
1759c29fdfc1Swdenk		If this option is set, support for bzip2 compressed
1760c29fdfc1Swdenk		images is included. If not, only uncompressed and gzip
1761c29fdfc1Swdenk		compressed images are supported.
1762c29fdfc1Swdenk
1763c29fdfc1Swdenk		NOTE: the bzip2 algorithm requires a lot of RAM, so
17646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
1765c29fdfc1Swdenk		be at least 4MB.
1766d791b1dcSwdenk
1767fc9c1727SLuigi 'Comio' Mantellini		CONFIG_LZMA
1768fc9c1727SLuigi 'Comio' Mantellini
1769fc9c1727SLuigi 'Comio' Mantellini		If this option is set, support for lzma compressed
1770fc9c1727SLuigi 'Comio' Mantellini		images is included.
1771fc9c1727SLuigi 'Comio' Mantellini
1772fc9c1727SLuigi 'Comio' Mantellini		Note: The LZMA algorithm adds between 2 and 4KB of code and it
1773fc9c1727SLuigi 'Comio' Mantellini		requires an amount of dynamic memory that is given by the
1774fc9c1727SLuigi 'Comio' Mantellini		formula:
1775fc9c1727SLuigi 'Comio' Mantellini
1776fc9c1727SLuigi 'Comio' Mantellini			(1846 + 768 << (lc + lp)) * sizeof(uint16)
1777fc9c1727SLuigi 'Comio' Mantellini
1778fc9c1727SLuigi 'Comio' Mantellini		Where lc and lp stand for, respectively, Literal context bits
1779fc9c1727SLuigi 'Comio' Mantellini		and Literal pos bits.
1780fc9c1727SLuigi 'Comio' Mantellini
1781fc9c1727SLuigi 'Comio' Mantellini		This value is upper-bounded by 14MB in the worst case. Anyway,
1782fc9c1727SLuigi 'Comio' Mantellini		for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1783fc9c1727SLuigi 'Comio' Mantellini		total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1784fc9c1727SLuigi 'Comio' Mantellini		a very small buffer.
1785fc9c1727SLuigi 'Comio' Mantellini
1786fc9c1727SLuigi 'Comio' Mantellini		Use the lzmainfo tool to determinate the lc and lp values and
1787fc9c1727SLuigi 'Comio' Mantellini		then calculate the amount of needed dynamic memory (ensuring
17886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the appropriate CONFIG_SYS_MALLOC_LEN value).
1789fc9c1727SLuigi 'Comio' Mantellini
17908ef70478SKees Cook		CONFIG_LZO
17918ef70478SKees Cook
17928ef70478SKees Cook		If this option is set, support for LZO compressed images
17938ef70478SKees Cook		is included.
17948ef70478SKees Cook
179517ea1177Swdenk- MII/PHY support:
179617ea1177Swdenk		CONFIG_PHY_ADDR
179717ea1177Swdenk
179817ea1177Swdenk		The address of PHY on MII bus.
179917ea1177Swdenk
180017ea1177Swdenk		CONFIG_PHY_CLOCK_FREQ (ppc4xx)
180117ea1177Swdenk
180217ea1177Swdenk		The clock frequency of the MII bus
180317ea1177Swdenk
180417ea1177Swdenk		CONFIG_PHY_GIGE
180517ea1177Swdenk
180617ea1177Swdenk		If this option is set, support for speed/duplex
180711ccc33fSMarcel Ziswiler		detection of gigabit PHY is included.
180817ea1177Swdenk
180917ea1177Swdenk		CONFIG_PHY_RESET_DELAY
181017ea1177Swdenk
181117ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
181217ea1177Swdenk		reset before any MII register access is possible.
181317ea1177Swdenk		For such PHY, set this option to the usec delay
181417ea1177Swdenk		required. (minimum 300usec for LXT971A)
181517ea1177Swdenk
181617ea1177Swdenk		CONFIG_PHY_CMD_DELAY (ppc4xx)
181717ea1177Swdenk
181817ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
181917ea1177Swdenk		command issued before MII status register can be read
182017ea1177Swdenk
1821c609719bSwdenk- Ethernet address:
1822c609719bSwdenk		CONFIG_ETHADDR
1823c68a05feSrichardretanubun		CONFIG_ETH1ADDR
1824c609719bSwdenk		CONFIG_ETH2ADDR
1825c609719bSwdenk		CONFIG_ETH3ADDR
1826c68a05feSrichardretanubun		CONFIG_ETH4ADDR
1827c68a05feSrichardretanubun		CONFIG_ETH5ADDR
1828c609719bSwdenk
182911ccc33fSMarcel Ziswiler		Define a default value for Ethernet address to use
183011ccc33fSMarcel Ziswiler		for the respective Ethernet interface, in case this
1831c609719bSwdenk		is not determined automatically.
1832c609719bSwdenk
1833c609719bSwdenk- IP address:
1834c609719bSwdenk		CONFIG_IPADDR
1835c609719bSwdenk
1836c609719bSwdenk		Define a default value for the IP address to use for
183711ccc33fSMarcel Ziswiler		the default Ethernet interface, in case this is not
1838c609719bSwdenk		determined through e.g. bootp.
18391ebcd654SWolfgang Denk		(Environment variable "ipaddr")
1840c609719bSwdenk
1841c609719bSwdenk- Server IP address:
1842c609719bSwdenk		CONFIG_SERVERIP
1843c609719bSwdenk
1844c609719bSwdenk		Defines a default value for the IP address of a TFTP
1845c609719bSwdenk		server to contact when using the "tftboot" command.
18461ebcd654SWolfgang Denk		(Environment variable "serverip")
1847c609719bSwdenk
184897cfe861SRobin Getz		CONFIG_KEEP_SERVERADDR
184997cfe861SRobin Getz
185097cfe861SRobin Getz		Keeps the server's MAC address, in the env 'serveraddr'
185197cfe861SRobin Getz		for passing to bootargs (like Linux's netconsole option)
185297cfe861SRobin Getz
18531ebcd654SWolfgang Denk- Gateway IP address:
18541ebcd654SWolfgang Denk		CONFIG_GATEWAYIP
18551ebcd654SWolfgang Denk
18561ebcd654SWolfgang Denk		Defines a default value for the IP address of the
18571ebcd654SWolfgang Denk		default router where packets to other networks are
18581ebcd654SWolfgang Denk		sent to.
18591ebcd654SWolfgang Denk		(Environment variable "gatewayip")
18601ebcd654SWolfgang Denk
18611ebcd654SWolfgang Denk- Subnet mask:
18621ebcd654SWolfgang Denk		CONFIG_NETMASK
18631ebcd654SWolfgang Denk
18641ebcd654SWolfgang Denk		Defines a default value for the subnet mask (or
18651ebcd654SWolfgang Denk		routing prefix) which is used to determine if an IP
18661ebcd654SWolfgang Denk		address belongs to the local subnet or needs to be
18671ebcd654SWolfgang Denk		forwarded through a router.
18681ebcd654SWolfgang Denk		(Environment variable "netmask")
18691ebcd654SWolfgang Denk
187053a5c424SDavid Updegraff- Multicast TFTP Mode:
187153a5c424SDavid Updegraff		CONFIG_MCAST_TFTP
187253a5c424SDavid Updegraff
187353a5c424SDavid Updegraff		Defines whether you want to support multicast TFTP as per
187453a5c424SDavid Updegraff		rfc-2090; for example to work with atftp.  Lets lots of targets
187511ccc33fSMarcel Ziswiler		tftp down the same boot image concurrently.  Note: the Ethernet
187653a5c424SDavid Updegraff		driver in use must provide a function: mcast() to join/leave a
187753a5c424SDavid Updegraff		multicast group.
187853a5c424SDavid Updegraff
1879c609719bSwdenk- BOOTP Recovery Mode:
1880c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY
1881c609719bSwdenk
1882c609719bSwdenk		If you have many targets in a network that try to
1883c609719bSwdenk		boot using BOOTP, you may want to avoid that all
1884c609719bSwdenk		systems send out BOOTP requests at precisely the same
1885c609719bSwdenk		moment (which would happen for instance at recovery
1886c609719bSwdenk		from a power failure, when all systems will try to
1887c609719bSwdenk		boot, thus flooding the BOOTP server. Defining
1888c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1889c609719bSwdenk		inserted before sending out BOOTP requests. The
18906c33c785SWolfgang Denk		following delays are inserted then:
1891c609719bSwdenk
1892c609719bSwdenk		1st BOOTP request:	delay 0 ... 1 sec
1893c609719bSwdenk		2nd BOOTP request:	delay 0 ... 2 sec
1894c609719bSwdenk		3rd BOOTP request:	delay 0 ... 4 sec
1895c609719bSwdenk		4th and following
1896c609719bSwdenk		BOOTP requests:		delay 0 ... 8 sec
1897c609719bSwdenk
1898fe389a82Sstroese- DHCP Advanced Options:
18991fe80d79SJon Loeliger		You can fine tune the DHCP functionality by defining
19001fe80d79SJon Loeliger		CONFIG_BOOTP_* symbols:
1901fe389a82Sstroese
19021fe80d79SJon Loeliger		CONFIG_BOOTP_SUBNETMASK
19031fe80d79SJon Loeliger		CONFIG_BOOTP_GATEWAY
19041fe80d79SJon Loeliger		CONFIG_BOOTP_HOSTNAME
19051fe80d79SJon Loeliger		CONFIG_BOOTP_NISDOMAIN
19061fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTPATH
19071fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTFILESIZE
19081fe80d79SJon Loeliger		CONFIG_BOOTP_DNS
19091fe80d79SJon Loeliger		CONFIG_BOOTP_DNS2
19101fe80d79SJon Loeliger		CONFIG_BOOTP_SEND_HOSTNAME
19111fe80d79SJon Loeliger		CONFIG_BOOTP_NTPSERVER
19121fe80d79SJon Loeliger		CONFIG_BOOTP_TIMEOFFSET
19131fe80d79SJon Loeliger		CONFIG_BOOTP_VENDOREX
19142c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL
1915fe389a82Sstroese
19165d110f0aSWilson Callan		CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
19175d110f0aSWilson Callan		environment variable, not the BOOTP server.
1918fe389a82Sstroese
19192c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
19202c00e099SJoe Hershberger		after the configured retry count, the call will fail
19212c00e099SJoe Hershberger		instead of starting over.  This can be used to fail over
19222c00e099SJoe Hershberger		to Link-local IP address configuration if the DHCP server
19232c00e099SJoe Hershberger		is not available.
19242c00e099SJoe Hershberger
1925fe389a82Sstroese		CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1926fe389a82Sstroese		serverip from a DHCP server, it is possible that more
1927fe389a82Sstroese		than one DNS serverip is offered to the client.
1928fe389a82Sstroese		If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1929fe389a82Sstroese		serverip will be stored in the additional environment
1930fe389a82Sstroese		variable "dnsip2". The first DNS serverip is always
1931fe389a82Sstroese		stored in the variable "dnsip", when CONFIG_BOOTP_DNS
19321fe80d79SJon Loeliger		is defined.
1933fe389a82Sstroese
1934fe389a82Sstroese		CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1935fe389a82Sstroese		to do a dynamic update of a DNS server. To do this, they
1936fe389a82Sstroese		need the hostname of the DHCP requester.
19375d110f0aSWilson Callan		If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
19381fe80d79SJon Loeliger		of the "hostname" environment variable is passed as
19391fe80d79SJon Loeliger		option 12 to the DHCP server.
1940fe389a82Sstroese
1941d9a2f416SAras Vaichas		CONFIG_BOOTP_DHCP_REQUEST_DELAY
1942d9a2f416SAras Vaichas
1943d9a2f416SAras Vaichas		A 32bit value in microseconds for a delay between
1944d9a2f416SAras Vaichas		receiving a "DHCP Offer" and sending the "DHCP Request".
1945d9a2f416SAras Vaichas		This fixes a problem with certain DHCP servers that don't
1946d9a2f416SAras Vaichas		respond 100% of the time to a "DHCP request". E.g. On an
1947d9a2f416SAras Vaichas		AT91RM9200 processor running at 180MHz, this delay needed
1948d9a2f416SAras Vaichas		to be *at least* 15,000 usec before a Windows Server 2003
1949d9a2f416SAras Vaichas		DHCP server would reply 100% of the time. I recommend at
1950d9a2f416SAras Vaichas		least 50,000 usec to be safe. The alternative is to hope
1951d9a2f416SAras Vaichas		that one of the retries will be successful but note that
1952d9a2f416SAras Vaichas		the DHCP timeout and retry process takes a longer than
1953d9a2f416SAras Vaichas		this delay.
1954d9a2f416SAras Vaichas
1955d22c338eSJoe Hershberger - Link-local IP address negotiation:
1956d22c338eSJoe Hershberger		Negotiate with other link-local clients on the local network
1957d22c338eSJoe Hershberger		for an address that doesn't require explicit configuration.
1958d22c338eSJoe Hershberger		This is especially useful if a DHCP server cannot be guaranteed
1959d22c338eSJoe Hershberger		to exist in all environments that the device must operate.
1960d22c338eSJoe Hershberger
1961d22c338eSJoe Hershberger		See doc/README.link-local for more information.
1962d22c338eSJoe Hershberger
1963a3d991bdSwdenk - CDP Options:
1964a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID
1965a3d991bdSwdenk
1966a3d991bdSwdenk		The device id used in CDP trigger frames.
1967a3d991bdSwdenk
1968a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID_PREFIX
1969a3d991bdSwdenk
1970a3d991bdSwdenk		A two character string which is prefixed to the MAC address
1971a3d991bdSwdenk		of the device.
1972a3d991bdSwdenk
1973a3d991bdSwdenk		CONFIG_CDP_PORT_ID
1974a3d991bdSwdenk
1975a3d991bdSwdenk		A printf format string which contains the ascii name of
1976a3d991bdSwdenk		the port. Normally is set to "eth%d" which sets
197711ccc33fSMarcel Ziswiler		eth0 for the first Ethernet, eth1 for the second etc.
1978a3d991bdSwdenk
1979a3d991bdSwdenk		CONFIG_CDP_CAPABILITIES
1980a3d991bdSwdenk
1981a3d991bdSwdenk		A 32bit integer which indicates the device capabilities;
1982a3d991bdSwdenk		0x00000010 for a normal host which does not forwards.
1983a3d991bdSwdenk
1984a3d991bdSwdenk		CONFIG_CDP_VERSION
1985a3d991bdSwdenk
1986a3d991bdSwdenk		An ascii string containing the version of the software.
1987a3d991bdSwdenk
1988a3d991bdSwdenk		CONFIG_CDP_PLATFORM
1989a3d991bdSwdenk
1990a3d991bdSwdenk		An ascii string containing the name of the platform.
1991a3d991bdSwdenk
1992a3d991bdSwdenk		CONFIG_CDP_TRIGGER
1993a3d991bdSwdenk
1994a3d991bdSwdenk		A 32bit integer sent on the trigger.
1995a3d991bdSwdenk
1996a3d991bdSwdenk		CONFIG_CDP_POWER_CONSUMPTION
1997a3d991bdSwdenk
1998a3d991bdSwdenk		A 16bit integer containing the power consumption of the
1999a3d991bdSwdenk		device in .1 of milliwatts.
2000a3d991bdSwdenk
2001a3d991bdSwdenk		CONFIG_CDP_APPLIANCE_VLAN_TYPE
2002a3d991bdSwdenk
2003a3d991bdSwdenk		A byte containing the id of the VLAN.
2004a3d991bdSwdenk
2005c609719bSwdenk- Status LED:	CONFIG_STATUS_LED
2006c609719bSwdenk
2007c609719bSwdenk		Several configurations allow to display the current
2008c609719bSwdenk		status using a LED. For instance, the LED will blink
2009c609719bSwdenk		fast while running U-Boot code, stop blinking as
2010c609719bSwdenk		soon as a reply to a BOOTP request was received, and
2011c609719bSwdenk		start blinking slow once the Linux kernel is running
2012c609719bSwdenk		(supported by a status LED driver in the Linux
2013c609719bSwdenk		kernel). Defining CONFIG_STATUS_LED enables this
2014c609719bSwdenk		feature in U-Boot.
2015c609719bSwdenk
20161df7bbbaSIgor Grinberg		Additional options:
20171df7bbbaSIgor Grinberg
20181df7bbbaSIgor Grinberg		CONFIG_GPIO_LED
20191df7bbbaSIgor Grinberg		The status LED can be connected to a GPIO pin.
20201df7bbbaSIgor Grinberg		In such cases, the gpio_led driver can be used as a
20211df7bbbaSIgor Grinberg		status LED backend implementation. Define CONFIG_GPIO_LED
20221df7bbbaSIgor Grinberg		to include the gpio_led driver in the U-Boot binary.
20231df7bbbaSIgor Grinberg
20249dfdcdfeSIgor Grinberg		CONFIG_GPIO_LED_INVERTED_TABLE
20259dfdcdfeSIgor Grinberg		Some GPIO connected LEDs may have inverted polarity in which
20269dfdcdfeSIgor Grinberg		case the GPIO high value corresponds to LED off state and
20279dfdcdfeSIgor Grinberg		GPIO low value corresponds to LED on state.
20289dfdcdfeSIgor Grinberg		In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
20299dfdcdfeSIgor Grinberg		with a list of GPIO LEDs that have inverted polarity.
20309dfdcdfeSIgor Grinberg
2031c609719bSwdenk- CAN Support:	CONFIG_CAN_DRIVER
2032c609719bSwdenk
2033c609719bSwdenk		Defining CONFIG_CAN_DRIVER enables CAN driver support
2034c609719bSwdenk		on those systems that support this (optional)
2035c609719bSwdenk		feature, like the TQM8xxL modules.
2036c609719bSwdenk
20373f4978c7SHeiko Schocher- I2C Support:	CONFIG_SYS_I2C
2038c609719bSwdenk
20393f4978c7SHeiko Schocher		This enable the NEW i2c subsystem, and will allow you to use
20403f4978c7SHeiko Schocher		i2c commands at the u-boot command line (as long as you set
20413f4978c7SHeiko Schocher		CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
20423f4978c7SHeiko Schocher		based realtime clock chips or other i2c devices. See
20433f4978c7SHeiko Schocher		common/cmd_i2c.c for a description of the command line
20443f4978c7SHeiko Schocher		interface.
20453f4978c7SHeiko Schocher
20463f4978c7SHeiko Schocher		ported i2c driver to the new framework:
2047ea818dbbSHeiko Schocher		- drivers/i2c/soft_i2c.c:
2048ea818dbbSHeiko Schocher		  - activate first bus with CONFIG_SYS_I2C_SOFT define
2049ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2050ea818dbbSHeiko Schocher		    for defining speed and slave address
2051ea818dbbSHeiko Schocher		  - activate second bus with I2C_SOFT_DECLARATIONS2 define
2052ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2053ea818dbbSHeiko Schocher		    for defining speed and slave address
2054ea818dbbSHeiko Schocher		  - activate third bus with I2C_SOFT_DECLARATIONS3 define
2055ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2056ea818dbbSHeiko Schocher		    for defining speed and slave address
2057ea818dbbSHeiko Schocher		  - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2058ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2059ea818dbbSHeiko Schocher		    for defining speed and slave address
20603f4978c7SHeiko Schocher
206100f792e0SHeiko Schocher		- drivers/i2c/fsl_i2c.c:
206200f792e0SHeiko Schocher		  - activate i2c driver with CONFIG_SYS_I2C_FSL
206300f792e0SHeiko Schocher		    define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
206400f792e0SHeiko Schocher		    offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
206500f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
206600f792e0SHeiko Schocher		    bus.
206700f792e0SHeiko Schocher		  - If your board supports a second fsl i2c bus, define
206800f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
206900f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_SPEED for the speed and
207000f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
207100f792e0SHeiko Schocher		    second bus.
207200f792e0SHeiko Schocher
20731f2ba722SSimon Glass		- drivers/i2c/tegra_i2c.c:
20741f2ba722SSimon Glass		  - activate this driver with CONFIG_SYS_I2C_TEGRA
20751f2ba722SSimon Glass		  - This driver adds 4 i2c buses with a fix speed from
20761f2ba722SSimon Glass		    100000 and the slave addr 0!
20771f2ba722SSimon Glass
2078880540deSDirk Eibach		- drivers/i2c/ppc4xx_i2c.c
2079880540deSDirk Eibach		  - activate this driver with CONFIG_SYS_I2C_PPC4XX
2080880540deSDirk Eibach		  - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2081880540deSDirk Eibach		  - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2082880540deSDirk Eibach
2083fac96408Strem		- drivers/i2c/i2c_mxc.c
2084fac96408Strem		  - activate this driver with CONFIG_SYS_I2C_MXC
2085fac96408Strem		  - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2086fac96408Strem		  - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2087fac96408Strem		  - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2088fac96408Strem		  - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2089fac96408Strem		  - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2090fac96408Strem		  - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
2091fac96408Strem		If thoses defines are not set, default value is 100000
2092fac96408Strem		for speed, and 0 for slave.
2093fac96408Strem
20941086bfa9SNobuhiro Iwamatsu		- drivers/i2c/rcar_i2c.c:
20951086bfa9SNobuhiro Iwamatsu		  - activate this driver with CONFIG_SYS_I2C_RCAR
20961086bfa9SNobuhiro Iwamatsu		  - This driver adds 4 i2c buses
20971086bfa9SNobuhiro Iwamatsu
20981086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
20991086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
21001086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
21011086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
21021086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
21031086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
21041086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
21051086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
21061086bfa9SNobuhiro Iwamatsu		  - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
21071086bfa9SNobuhiro Iwamatsu
21082035d77dSNobuhiro Iwamatsu		- drivers/i2c/sh_i2c.c:
21092035d77dSNobuhiro Iwamatsu		  - activate this driver with CONFIG_SYS_I2C_SH
21102035d77dSNobuhiro Iwamatsu		  - This driver adds from 2 to 5 i2c buses
21112035d77dSNobuhiro Iwamatsu
21122035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
21132035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
21142035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
21152035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
21162035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
21172035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
21182035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
21192035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
21202035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
21212035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
21222035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
21232035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
21242035d77dSNobuhiro Iwamatsu		  - CONFIF_SYS_I2C_SH_NUM_CONTROLLERS for nummber of i2c buses
21252035d77dSNobuhiro Iwamatsu
21266789e84eSHeiko Schocher		- drivers/i2c/omap24xx_i2c.c
21276789e84eSHeiko Schocher		  - activate this driver with CONFIG_SYS_I2C_OMAP24XX
21286789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
21296789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
21306789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
21316789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
21326789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
21336789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
21346789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
21356789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
21366789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
21376789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
21386789e84eSHeiko Schocher
21390bdffe71SHeiko Schocher		- drivers/i2c/zynq_i2c.c
21400bdffe71SHeiko Schocher		  - activate this driver with CONFIG_SYS_I2C_ZYNQ
21410bdffe71SHeiko Schocher		  - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
21420bdffe71SHeiko Schocher		  - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
21430bdffe71SHeiko Schocher
2144e717fc6dSNaveen Krishna Ch		- drivers/i2c/s3c24x0_i2c.c:
2145e717fc6dSNaveen Krishna Ch		  - activate this driver with CONFIG_SYS_I2C_S3C24X0
2146e717fc6dSNaveen Krishna Ch		  - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2147e717fc6dSNaveen Krishna Ch		    9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2148e717fc6dSNaveen Krishna Ch		    with a fix speed from 100000 and the slave addr 0!
2149e717fc6dSNaveen Krishna Ch
21503f4978c7SHeiko Schocher		additional defines:
21513f4978c7SHeiko Schocher
21523f4978c7SHeiko Schocher		CONFIG_SYS_NUM_I2C_BUSES
21533f4978c7SHeiko Schocher		Hold the number of i2c busses you want to use. If you
21543f4978c7SHeiko Schocher		don't use/have i2c muxes on your i2c bus, this
21553f4978c7SHeiko Schocher		is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
21563f4978c7SHeiko Schocher		omit this define.
21573f4978c7SHeiko Schocher
21583f4978c7SHeiko Schocher		CONFIG_SYS_I2C_DIRECT_BUS
21593f4978c7SHeiko Schocher		define this, if you don't use i2c muxes on your hardware.
21603f4978c7SHeiko Schocher		if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
21613f4978c7SHeiko Schocher		omit this define.
21623f4978c7SHeiko Schocher
21633f4978c7SHeiko Schocher		CONFIG_SYS_I2C_MAX_HOPS
21643f4978c7SHeiko Schocher		define how many muxes are maximal consecutively connected
21653f4978c7SHeiko Schocher		on one i2c bus. If you not use i2c muxes, omit this
21663f4978c7SHeiko Schocher		define.
21673f4978c7SHeiko Schocher
21683f4978c7SHeiko Schocher		CONFIG_SYS_I2C_BUSES
21693f4978c7SHeiko Schocher		hold a list of busses you want to use, only used if
21703f4978c7SHeiko Schocher		CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
21713f4978c7SHeiko Schocher		a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
21723f4978c7SHeiko Schocher		CONFIG_SYS_NUM_I2C_BUSES = 9:
21733f4978c7SHeiko Schocher
21743f4978c7SHeiko Schocher		 CONFIG_SYS_I2C_BUSES	{{0, {I2C_NULL_HOP}}, \
21753f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
21763f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
21773f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
21783f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
21793f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
21803f4978c7SHeiko Schocher					{1, {I2C_NULL_HOP}}, \
21813f4978c7SHeiko Schocher					{1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
21823f4978c7SHeiko Schocher					{1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
21833f4978c7SHeiko Schocher					}
21843f4978c7SHeiko Schocher
21853f4978c7SHeiko Schocher		which defines
21863f4978c7SHeiko Schocher			bus 0 on adapter 0 without a mux
2187ea818dbbSHeiko Schocher			bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2188ea818dbbSHeiko Schocher			bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2189ea818dbbSHeiko Schocher			bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2190ea818dbbSHeiko Schocher			bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2191ea818dbbSHeiko Schocher			bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
21923f4978c7SHeiko Schocher			bus 6 on adapter 1 without a mux
2193ea818dbbSHeiko Schocher			bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2194ea818dbbSHeiko Schocher			bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
21953f4978c7SHeiko Schocher
21963f4978c7SHeiko Schocher		If you do not have i2c muxes on your board, omit this define.
21973f4978c7SHeiko Schocher
2198ea818dbbSHeiko Schocher- Legacy I2C Support:	CONFIG_HARD_I2C
21993f4978c7SHeiko Schocher
22003f4978c7SHeiko Schocher		NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
22013f4978c7SHeiko Schocher		provides the following compelling advantages:
22023f4978c7SHeiko Schocher
22033f4978c7SHeiko Schocher		- more than one i2c adapter is usable
22043f4978c7SHeiko Schocher		- approved multibus support
22053f4978c7SHeiko Schocher		- better i2c mux support
22063f4978c7SHeiko Schocher
22073f4978c7SHeiko Schocher		** Please consider updating your I2C driver now. **
22083f4978c7SHeiko Schocher
2209ea818dbbSHeiko Schocher		These enable legacy I2C serial bus commands. Defining
2210ea818dbbSHeiko Schocher		CONFIG_HARD_I2C will include the appropriate I2C driver
2211ea818dbbSHeiko Schocher		for the selected CPU.
2212c609719bSwdenk
2213b37c7e5eSwdenk		This will allow you to use i2c commands at the u-boot
2214602ad3b3SJon Loeliger		command line (as long as you set CONFIG_CMD_I2C in
2215b37c7e5eSwdenk		CONFIG_COMMANDS) and communicate with i2c based realtime
2216b37c7e5eSwdenk		clock chips. See common/cmd_i2c.c for a description of the
2217c609719bSwdenk		command line interface.
2218c609719bSwdenk
2219bb99ad6dSBen Warren		CONFIG_HARD_I2C selects a hardware I2C controller.
2220c609719bSwdenk
2221b37c7e5eSwdenk		There are several other quantities that must also be
2222ea818dbbSHeiko Schocher		defined when you define CONFIG_HARD_I2C.
2223c609719bSwdenk
22246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		In both cases you will need to define CONFIG_SYS_I2C_SPEED
2225b37c7e5eSwdenk		to be the frequency (in Hz) at which you wish your i2c bus
22266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
222711ccc33fSMarcel Ziswiler		the CPU's i2c node address).
2228c609719bSwdenk
22298d321b81SPeter Tyser		Now, the u-boot i2c code for the mpc8xx
2230a47a12beSStefan Roese		(arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
22318d321b81SPeter Tyser		and so its address should therefore be cleared to 0 (See,
22328d321b81SPeter Tyser		eg, MPC823e User's Manual p.16-473). So, set
22338d321b81SPeter Tyser		CONFIG_SYS_I2C_SLAVE to 0.
2234b37c7e5eSwdenk
22355da71efaSEric Millbrandt		CONFIG_SYS_I2C_INIT_MPC5XXX
22365da71efaSEric Millbrandt
22375da71efaSEric Millbrandt		When a board is reset during an i2c bus transfer
22385da71efaSEric Millbrandt		chips might think that the current transfer is still
22395da71efaSEric Millbrandt		in progress.  Reset the slave devices by sending start
22405da71efaSEric Millbrandt		commands until the slave device responds.
22415da71efaSEric Millbrandt
2242b37c7e5eSwdenk		That's all that's required for CONFIG_HARD_I2C.
2243b37c7e5eSwdenk
2244ea818dbbSHeiko Schocher		If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
2245b37c7e5eSwdenk		then the following macros need to be defined (examples are
2246b37c7e5eSwdenk		from include/configs/lwmon.h):
2247c609719bSwdenk
2248c609719bSwdenk		I2C_INIT
2249c609719bSwdenk
2250b37c7e5eSwdenk		(Optional). Any commands necessary to enable the I2C
2251c609719bSwdenk		controller or configure ports.
2252c609719bSwdenk
2253b37c7e5eSwdenk		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
2254b37c7e5eSwdenk
2255c609719bSwdenk		I2C_PORT
2256c609719bSwdenk
2257c609719bSwdenk		(Only for MPC8260 CPU). The I/O port to use (the code
2258c609719bSwdenk		assumes both bits are on the same port). Valid values
2259c609719bSwdenk		are 0..3 for ports A..D.
2260c609719bSwdenk
2261c609719bSwdenk		I2C_ACTIVE
2262c609719bSwdenk
2263c609719bSwdenk		The code necessary to make the I2C data line active
2264c609719bSwdenk		(driven).  If the data line is open collector, this
2265c609719bSwdenk		define can be null.
2266c609719bSwdenk
2267b37c7e5eSwdenk		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
2268b37c7e5eSwdenk
2269c609719bSwdenk		I2C_TRISTATE
2270c609719bSwdenk
2271c609719bSwdenk		The code necessary to make the I2C data line tri-stated
2272c609719bSwdenk		(inactive).  If the data line is open collector, this
2273c609719bSwdenk		define can be null.
2274c609719bSwdenk
2275b37c7e5eSwdenk		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2276b37c7e5eSwdenk
2277c609719bSwdenk		I2C_READ
2278c609719bSwdenk
2279472d5460SYork Sun		Code that returns true if the I2C data line is high,
2280472d5460SYork Sun		false if it is low.
2281c609719bSwdenk
2282b37c7e5eSwdenk		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2283b37c7e5eSwdenk
2284c609719bSwdenk		I2C_SDA(bit)
2285c609719bSwdenk
2286472d5460SYork Sun		If <bit> is true, sets the I2C data line high. If it
2287472d5460SYork Sun		is false, it clears it (low).
2288c609719bSwdenk
2289b37c7e5eSwdenk		eg: #define I2C_SDA(bit) \
2290b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
2291b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
2292b37c7e5eSwdenk
2293c609719bSwdenk		I2C_SCL(bit)
2294c609719bSwdenk
2295472d5460SYork Sun		If <bit> is true, sets the I2C clock line high. If it
2296472d5460SYork Sun		is false, it clears it (low).
2297c609719bSwdenk
2298b37c7e5eSwdenk		eg: #define I2C_SCL(bit) \
2299b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
2300b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
2301b37c7e5eSwdenk
2302c609719bSwdenk		I2C_DELAY
2303c609719bSwdenk
2304c609719bSwdenk		This delay is invoked four times per clock cycle so this
2305c609719bSwdenk		controls the rate of data transfer.  The data rate thus
2306b37c7e5eSwdenk		is 1 / (I2C_DELAY * 4). Often defined to be something
2307b37c7e5eSwdenk		like:
2308b37c7e5eSwdenk
2309b37c7e5eSwdenk		#define I2C_DELAY  udelay(2)
2310c609719bSwdenk
2311793b5726SMike Frysinger		CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2312793b5726SMike Frysinger
2313793b5726SMike Frysinger		If your arch supports the generic GPIO framework (asm/gpio.h),
2314793b5726SMike Frysinger		then you may alternatively define the two GPIOs that are to be
2315793b5726SMike Frysinger		used as SCL / SDA.  Any of the previous I2C_xxx macros will
2316793b5726SMike Frysinger		have GPIO-based defaults assigned to them as appropriate.
2317793b5726SMike Frysinger
2318793b5726SMike Frysinger		You should define these to the GPIO value as given directly to
2319793b5726SMike Frysinger		the generic GPIO functions.
2320793b5726SMike Frysinger
23216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_INIT_BOARD
232247cd00faSwdenk
232347cd00faSwdenk		When a board is reset during an i2c bus transfer
232447cd00faSwdenk		chips might think that the current transfer is still
232547cd00faSwdenk		in progress. On some boards it is possible to access
232647cd00faSwdenk		the i2c SCLK line directly, either by using the
232747cd00faSwdenk		processor pin as a GPIO or by having a second pin
232847cd00faSwdenk		connected to the bus. If this option is defined a
232947cd00faSwdenk		custom i2c_init_board() routine in boards/xxx/board.c
233047cd00faSwdenk		is run early in the boot sequence.
233147cd00faSwdenk
233226a33504SRichard Retanubun		CONFIG_SYS_I2C_BOARD_LATE_INIT
233326a33504SRichard Retanubun
233426a33504SRichard Retanubun		An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
233526a33504SRichard Retanubun		defined a custom i2c_board_late_init() routine in
233626a33504SRichard Retanubun		boards/xxx/board.c is run AFTER the operations in i2c_init()
233726a33504SRichard Retanubun		is completed. This callpoint can be used to unreset i2c bus
233826a33504SRichard Retanubun		using CPU i2c controller register accesses for CPUs whose i2c
233926a33504SRichard Retanubun		controller provide such a method. It is called at the end of
234026a33504SRichard Retanubun		i2c_init() to allow i2c_init operations to setup the i2c bus
234126a33504SRichard Retanubun		controller on the CPU (e.g. setting bus speed & slave address).
234226a33504SRichard Retanubun
234317ea1177Swdenk		CONFIG_I2CFAST (PPC405GP|PPC405EP only)
234417ea1177Swdenk
234517ea1177Swdenk		This option enables configuration of bi_iic_fast[] flags
234617ea1177Swdenk		in u-boot bd_info structure based on u-boot environment
234717ea1177Swdenk		variable "i2cfast". (see also i2cfast)
234817ea1177Swdenk
2349bb99ad6dSBen Warren		CONFIG_I2C_MULTI_BUS
2350bb99ad6dSBen Warren
2351bb99ad6dSBen Warren		This option allows the use of multiple I2C buses, each of which
2352bb99ad6dSBen Warren		must have a controller.	 At any point in time, only one bus is
2353bb99ad6dSBen Warren		active.	 To switch to a different bus, use the 'i2c dev' command.
2354bb99ad6dSBen Warren		Note that bus numbering is zero-based.
2355bb99ad6dSBen Warren
23566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_NOPROBES
2357bb99ad6dSBen Warren
2358bb99ad6dSBen Warren		This option specifies a list of I2C devices that will be skipped
23590f89c54bSPeter Tyser		when the 'i2c probe' command is issued.	 If CONFIG_I2C_MULTI_BUS
23600f89c54bSPeter Tyser		is set, specify a list of bus-device pairs.  Otherwise, specify
23610f89c54bSPeter Tyser		a 1D array of device addresses
2362bb99ad6dSBen Warren
2363bb99ad6dSBen Warren		e.g.
2364bb99ad6dSBen Warren			#undef	CONFIG_I2C_MULTI_BUS
23656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
2366bb99ad6dSBen Warren
2367bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on a board with one I2C bus
2368bb99ad6dSBen Warren
2369bb99ad6dSBen Warren			#define CONFIG_I2C_MULTI_BUS
23706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_MULTI_NOPROBES	{{0,0x50},{0,0x68},{1,0x54}}
2371bb99ad6dSBen Warren
2372bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2373bb99ad6dSBen Warren
23746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SPD_BUS_NUM
2375be5e6181STimur Tabi
2376be5e6181STimur Tabi		If defined, then this indicates the I2C bus number for DDR SPD.
2377be5e6181STimur Tabi		If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2378be5e6181STimur Tabi
23796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_BUS_NUM
23800dc018ecSStefan Roese
23810dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the RTC.
23820dc018ecSStefan Roese		If not defined, then U-Boot assumes that RTC is on I2C bus 0.
23830dc018ecSStefan Roese
23846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_DTT_BUS_NUM
23850dc018ecSStefan Roese
23860dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the DTT.
23870dc018ecSStefan Roese		If not defined, then U-Boot assumes that DTT is on I2C bus 0.
23880dc018ecSStefan Roese
23896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_DTT_ADDR:
23909ebbb54fSVictor Gallardo
23919ebbb54fSVictor Gallardo		If defined, specifies the I2C address of the DTT device.
23929ebbb54fSVictor Gallardo		If not defined, then U-Boot uses predefined value for
23939ebbb54fSVictor Gallardo		specified DTT device.
23949ebbb54fSVictor Gallardo
23952ac6985aSAndrew Dyer		CONFIG_SOFT_I2C_READ_REPEATED_START
23962ac6985aSAndrew Dyer
23972ac6985aSAndrew Dyer		defining this will force the i2c_read() function in
23982ac6985aSAndrew Dyer		the soft_i2c driver to perform an I2C repeated start
23992ac6985aSAndrew Dyer		between writing the address pointer and reading the
24002ac6985aSAndrew Dyer		data.  If this define is omitted the default behaviour
24012ac6985aSAndrew Dyer		of doing a stop-start sequence will be used.  Most I2C
24022ac6985aSAndrew Dyer		devices can use either method, but some require one or
24032ac6985aSAndrew Dyer		the other.
2404be5e6181STimur Tabi
2405c609719bSwdenk- SPI Support:	CONFIG_SPI
2406c609719bSwdenk
2407c609719bSwdenk		Enables SPI driver (so far only tested with
2408c609719bSwdenk		SPI EEPROM, also an instance works with Crystal A/D and
2409c609719bSwdenk		D/As on the SACSng board)
2410c609719bSwdenk
24116639562eSYoshihiro Shimoda		CONFIG_SH_SPI
24126639562eSYoshihiro Shimoda
24136639562eSYoshihiro Shimoda		Enables the driver for SPI controller on SuperH. Currently
24146639562eSYoshihiro Shimoda		only SH7757 is supported.
24156639562eSYoshihiro Shimoda
2416c609719bSwdenk		CONFIG_SPI_X
2417c609719bSwdenk
2418c609719bSwdenk		Enables extended (16-bit) SPI EEPROM addressing.
2419c609719bSwdenk		(symmetrical to CONFIG_I2C_X)
2420c609719bSwdenk
2421c609719bSwdenk		CONFIG_SOFT_SPI
2422c609719bSwdenk
2423c609719bSwdenk		Enables a software (bit-bang) SPI driver rather than
2424c609719bSwdenk		using hardware support. This is a general purpose
2425c609719bSwdenk		driver that only requires three general I/O port pins
2426c609719bSwdenk		(two outputs, one input) to function. If this is
2427c609719bSwdenk		defined, the board configuration must define several
2428c609719bSwdenk		SPI configuration items (port pins to use, etc). For
2429c609719bSwdenk		an example, see include/configs/sacsng.h.
2430c609719bSwdenk
243104a9e118SBen Warren		CONFIG_HARD_SPI
243204a9e118SBen Warren
243304a9e118SBen Warren		Enables a hardware SPI driver for general-purpose reads
243404a9e118SBen Warren		and writes.  As with CONFIG_SOFT_SPI, the board configuration
243504a9e118SBen Warren		must define a list of chip-select function pointers.
243604a9e118SBen Warren		Currently supported on some MPC8xxx processors.	 For an
243704a9e118SBen Warren		example, see include/configs/mpc8349emds.h.
243804a9e118SBen Warren
243938254f45SGuennadi Liakhovetski		CONFIG_MXC_SPI
244038254f45SGuennadi Liakhovetski
244138254f45SGuennadi Liakhovetski		Enables the driver for the SPI controllers on i.MX and MXC
24422e3cd1cdSFabio Estevam		SoCs. Currently i.MX31/35/51 are supported.
244338254f45SGuennadi Liakhovetski
24440133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA
24450133502eSMatthias Fuchs
24460133502eSMatthias Fuchs		Enables FPGA subsystem.
24470133502eSMatthias Fuchs
24480133502eSMatthias Fuchs		CONFIG_FPGA_<vendor>
24490133502eSMatthias Fuchs
24500133502eSMatthias Fuchs		Enables support for specific chip vendors.
24510133502eSMatthias Fuchs		(ALTERA, XILINX)
24520133502eSMatthias Fuchs
24530133502eSMatthias Fuchs		CONFIG_FPGA_<family>
24540133502eSMatthias Fuchs
24550133502eSMatthias Fuchs		Enables support for FPGA family.
24560133502eSMatthias Fuchs		(SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
24570133502eSMatthias Fuchs
24580133502eSMatthias Fuchs		CONFIG_FPGA_COUNT
2459c609719bSwdenk
2460c609719bSwdenk		Specify the number of FPGA devices to support.
2461c609719bSwdenk
24626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_PROG_FEEDBACK
2463c609719bSwdenk
2464c609719bSwdenk		Enable printing of hash marks during FPGA configuration.
2465c609719bSwdenk
24666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_BUSY
2467c609719bSwdenk
2468c609719bSwdenk		Enable checks on FPGA configuration interface busy
2469c609719bSwdenk		status by the configuration function. This option
2470c609719bSwdenk		will require a board or device specific function to
2471c609719bSwdenk		be written.
2472c609719bSwdenk
2473c609719bSwdenk		CONFIG_FPGA_DELAY
2474c609719bSwdenk
2475c609719bSwdenk		If defined, a function that provides delays in the FPGA
2476c609719bSwdenk		configuration driver.
2477c609719bSwdenk
24786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_CTRLC
2479c609719bSwdenk		Allow Control-C to interrupt FPGA configuration
2480c609719bSwdenk
24816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_ERROR
2482c609719bSwdenk
2483c609719bSwdenk		Check for configuration errors during FPGA bitfile
2484c609719bSwdenk		loading. For example, abort during Virtex II
2485c609719bSwdenk		configuration if the INIT_B line goes low (which
2486c609719bSwdenk		indicated a CRC error).
2487c609719bSwdenk
24886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_INIT
2489c609719bSwdenk
2490c609719bSwdenk		Maximum time to wait for the INIT_B line to deassert
2491c609719bSwdenk		after PROB_B has been deasserted during a Virtex II
2492c609719bSwdenk		FPGA configuration sequence. The default time is 500
249311ccc33fSMarcel Ziswiler		ms.
2494c609719bSwdenk
24956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_BUSY
2496c609719bSwdenk
2497c609719bSwdenk		Maximum time to wait for BUSY to deassert during
249811ccc33fSMarcel Ziswiler		Virtex II FPGA configuration. The default is 5 ms.
2499c609719bSwdenk
25006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_CONFIG
2501c609719bSwdenk
2502c609719bSwdenk		Time to wait after FPGA configuration. The default is
250311ccc33fSMarcel Ziswiler		200 ms.
2504c609719bSwdenk
2505c609719bSwdenk- Configuration Management:
2506c609719bSwdenk		CONFIG_IDENT_STRING
2507c609719bSwdenk
2508c609719bSwdenk		If defined, this string will be added to the U-Boot
2509c609719bSwdenk		version information (U_BOOT_VERSION)
2510c609719bSwdenk
2511c609719bSwdenk- Vendor Parameter Protection:
2512c609719bSwdenk
2513c609719bSwdenk		U-Boot considers the values of the environment
2514c609719bSwdenk		variables "serial#" (Board Serial Number) and
25157152b1d0Swdenk		"ethaddr" (Ethernet Address) to be parameters that
2516c609719bSwdenk		are set once by the board vendor / manufacturer, and
2517c609719bSwdenk		protects these variables from casual modification by
2518c609719bSwdenk		the user. Once set, these variables are read-only,
2519c609719bSwdenk		and write or delete attempts are rejected. You can
252011ccc33fSMarcel Ziswiler		change this behaviour:
2521c609719bSwdenk
2522c609719bSwdenk		If CONFIG_ENV_OVERWRITE is #defined in your config
2523c609719bSwdenk		file, the write protection for vendor parameters is
252447cd00faSwdenk		completely disabled. Anybody can change or delete
2525c609719bSwdenk		these parameters.
2526c609719bSwdenk
2527c609719bSwdenk		Alternatively, if you #define _both_ CONFIG_ETHADDR
2528c609719bSwdenk		_and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
252911ccc33fSMarcel Ziswiler		Ethernet address is installed in the environment,
2530c609719bSwdenk		which can be changed exactly ONCE by the user. [The
2531c609719bSwdenk		serial# is unaffected by this, i. e. it remains
2532c609719bSwdenk		read-only.]
2533c609719bSwdenk
25342598090bSJoe Hershberger		The same can be accomplished in a more flexible way
25352598090bSJoe Hershberger		for any variable by configuring the type of access
25362598090bSJoe Hershberger		to allow for those variables in the ".flags" variable
25372598090bSJoe Hershberger		or define CONFIG_ENV_FLAGS_LIST_STATIC.
25382598090bSJoe Hershberger
2539c609719bSwdenk- Protected RAM:
2540c609719bSwdenk		CONFIG_PRAM
2541c609719bSwdenk
2542c609719bSwdenk		Define this variable to enable the reservation of
2543c609719bSwdenk		"protected RAM", i. e. RAM which is not overwritten
2544c609719bSwdenk		by U-Boot. Define CONFIG_PRAM to hold the number of
2545c609719bSwdenk		kB you want to reserve for pRAM. You can overwrite
2546c609719bSwdenk		this default value by defining an environment
2547c609719bSwdenk		variable "pram" to the number of kB you want to
2548c609719bSwdenk		reserve. Note that the board info structure will
2549c609719bSwdenk		still show the full amount of RAM. If pRAM is
2550c609719bSwdenk		reserved, a new environment variable "mem" will
2551c609719bSwdenk		automatically be defined to hold the amount of
2552c609719bSwdenk		remaining RAM in a form that can be passed as boot
2553c609719bSwdenk		argument to Linux, for instance like that:
2554c609719bSwdenk
2555fe126d8bSWolfgang Denk			setenv bootargs ... mem=\${mem}
2556c609719bSwdenk			saveenv
2557c609719bSwdenk
2558c609719bSwdenk		This way you can tell Linux not to use this memory,
2559c609719bSwdenk		either, which results in a memory region that will
2560c609719bSwdenk		not be affected by reboots.
2561c609719bSwdenk
2562c609719bSwdenk		*WARNING* If your board configuration uses automatic
2563c609719bSwdenk		detection of the RAM size, you must make sure that
2564c609719bSwdenk		this memory test is non-destructive. So far, the
2565c609719bSwdenk		following board configurations are known to be
2566c609719bSwdenk		"pRAM-clean":
2567c609719bSwdenk
25681b0757ecSWolfgang Denk			IVMS8, IVML24, SPD8xx, TQM8xxL,
25691b0757ecSWolfgang Denk			HERMES, IP860, RPXlite, LWMON,
2570544d97e9SWolfgang Denk			FLAGADM, TQM8260
2571c609719bSwdenk
257240fef049SGabe Black- Access to physical memory region (> 4GB)
257340fef049SGabe Black		Some basic support is provided for operations on memory not
257440fef049SGabe Black		normally accessible to U-Boot - e.g. some architectures
257540fef049SGabe Black		support access to more than 4GB of memory on 32-bit
257640fef049SGabe Black		machines using physical address extension or similar.
257740fef049SGabe Black		Define CONFIG_PHYSMEM to access this basic support, which
257840fef049SGabe Black		currently only supports clearing the memory.
257940fef049SGabe Black
2580c609719bSwdenk- Error Recovery:
2581c609719bSwdenk		CONFIG_PANIC_HANG
2582c609719bSwdenk
2583c609719bSwdenk		Define this variable to stop the system in case of a
2584c609719bSwdenk		fatal error, so that you have to reset it manually.
2585c609719bSwdenk		This is probably NOT a good idea for an embedded
258611ccc33fSMarcel Ziswiler		system where you want the system to reboot
2587c609719bSwdenk		automatically as fast as possible, but it may be
2588c609719bSwdenk		useful during development since you can try to debug
2589c609719bSwdenk		the conditions that lead to the situation.
2590c609719bSwdenk
2591c609719bSwdenk		CONFIG_NET_RETRY_COUNT
2592c609719bSwdenk
2593c609719bSwdenk		This variable defines the number of retries for
2594c609719bSwdenk		network operations like ARP, RARP, TFTP, or BOOTP
2595c609719bSwdenk		before giving up the operation. If not defined, a
2596c609719bSwdenk		default value of 5 is used.
2597c609719bSwdenk
259840cb90eeSGuennadi Liakhovetski		CONFIG_ARP_TIMEOUT
259940cb90eeSGuennadi Liakhovetski
260040cb90eeSGuennadi Liakhovetski		Timeout waiting for an ARP reply in milliseconds.
260140cb90eeSGuennadi Liakhovetski
260248a3e999STetsuyuki Kobayashi		CONFIG_NFS_TIMEOUT
260348a3e999STetsuyuki Kobayashi
260448a3e999STetsuyuki Kobayashi		Timeout in milliseconds used in NFS protocol.
260548a3e999STetsuyuki Kobayashi		If you encounter "ERROR: Cannot umount" in nfs command,
260648a3e999STetsuyuki Kobayashi		try longer timeout such as
260748a3e999STetsuyuki Kobayashi		#define CONFIG_NFS_TIMEOUT 10000UL
260848a3e999STetsuyuki Kobayashi
2609c609719bSwdenk- Command Interpreter:
26108078f1a5SWolfgang Denk		CONFIG_AUTO_COMPLETE
261104a85b3bSwdenk
261204a85b3bSwdenk		Enable auto completion of commands using TAB.
261304a85b3bSwdenk
26148078f1a5SWolfgang Denk		Note that this feature has NOT been implemented yet
26158078f1a5SWolfgang Denk		for the "hush" shell.
26168078f1a5SWolfgang Denk
26178078f1a5SWolfgang Denk
26186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_HUSH_PARSER
2619c609719bSwdenk
2620c609719bSwdenk		Define this variable to enable the "hush" shell (from
2621c609719bSwdenk		Busybox) as command line interpreter, thus enabling
2622c609719bSwdenk		powerful command line syntax like
2623c609719bSwdenk		if...then...else...fi conditionals or `&&' and '||'
2624c609719bSwdenk		constructs ("shell scripts").
2625c609719bSwdenk
2626c609719bSwdenk		If undefined, you get the old, much simpler behaviour
2627c609719bSwdenk		with a somewhat smaller memory footprint.
2628c609719bSwdenk
2629c609719bSwdenk
26306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_PROMPT_HUSH_PS2
2631c609719bSwdenk
2632c609719bSwdenk		This defines the secondary prompt string, which is
2633c609719bSwdenk		printed when the command interpreter needs more input
2634c609719bSwdenk		to complete a command. Usually "> ".
2635c609719bSwdenk
2636c609719bSwdenk	Note:
2637c609719bSwdenk
2638c609719bSwdenk		In the current implementation, the local variables
2639c609719bSwdenk		space and global environment variables space are
2640c609719bSwdenk		separated. Local variables are those you define by
26413b57fe0aSwdenk		simply typing `name=value'. To access a local
2642c609719bSwdenk		variable later on, you have write `$name' or
26433b57fe0aSwdenk		`${name}'; to execute the contents of a variable
26443b57fe0aSwdenk		directly type `$name' at the command prompt.
2645c609719bSwdenk
2646c609719bSwdenk		Global environment variables are those you use
2647c609719bSwdenk		setenv/printenv to work with. To run a command stored
2648c609719bSwdenk		in such a variable, you need to use the run command,
2649c609719bSwdenk		and you must not use the '$' sign to access them.
2650c609719bSwdenk
2651c609719bSwdenk		To store commands and special characters in a
2652c609719bSwdenk		variable, please use double quotation marks
2653c609719bSwdenk		surrounding the whole text of the variable, instead
2654c609719bSwdenk		of the backslashes before semicolons and special
2655c609719bSwdenk		symbols.
2656c609719bSwdenk
2657aa0c71acSWolfgang Denk- Commandline Editing and History:
2658aa0c71acSWolfgang Denk		CONFIG_CMDLINE_EDITING
2659aa0c71acSWolfgang Denk
266011ccc33fSMarcel Ziswiler		Enable editing and History functions for interactive
2661aa0c71acSWolfgang Denk		commandline input operations
2662aa0c71acSWolfgang Denk
2663a8c7c708Swdenk- Default Environment:
2664c609719bSwdenk		CONFIG_EXTRA_ENV_SETTINGS
2665c609719bSwdenk
2666c609719bSwdenk		Define this to contain any number of null terminated
2667c609719bSwdenk		strings (variable = value pairs) that will be part of
26687152b1d0Swdenk		the default environment compiled into the boot image.
26692262cfeeSwdenk
2670c609719bSwdenk		For example, place something like this in your
2671c609719bSwdenk		board's config file:
2672c609719bSwdenk
2673c609719bSwdenk		#define CONFIG_EXTRA_ENV_SETTINGS \
2674c609719bSwdenk			"myvar1=value1\0" \
2675c609719bSwdenk			"myvar2=value2\0"
2676c609719bSwdenk
2677c609719bSwdenk		Warning: This method is based on knowledge about the
2678c609719bSwdenk		internal format how the environment is stored by the
26792262cfeeSwdenk		U-Boot code. This is NOT an official, exported
2680c609719bSwdenk		interface! Although it is unlikely that this format
26817152b1d0Swdenk		will change soon, there is no guarantee either.
2682c609719bSwdenk		You better know what you are doing here.
2683c609719bSwdenk
2684c609719bSwdenk		Note: overly (ab)use of the default environment is
2685c609719bSwdenk		discouraged. Make sure to check other ways to preset
268674de7aefSWolfgang Denk		the environment like the "source" command or the
2687c609719bSwdenk		boot command first.
2688c609719bSwdenk
26895e724ca2SStephen Warren		CONFIG_ENV_VARS_UBOOT_CONFIG
26905e724ca2SStephen Warren
26915e724ca2SStephen Warren		Define this in order to add variables describing the
26925e724ca2SStephen Warren		U-Boot build configuration to the default environment.
26935e724ca2SStephen Warren		These will be named arch, cpu, board, vendor, and soc.
26945e724ca2SStephen Warren
26955e724ca2SStephen Warren		Enabling this option will cause the following to be defined:
26965e724ca2SStephen Warren
26975e724ca2SStephen Warren		- CONFIG_SYS_ARCH
26985e724ca2SStephen Warren		- CONFIG_SYS_CPU
26995e724ca2SStephen Warren		- CONFIG_SYS_BOARD
27005e724ca2SStephen Warren		- CONFIG_SYS_VENDOR
27015e724ca2SStephen Warren		- CONFIG_SYS_SOC
27025e724ca2SStephen Warren
27037e27f89fSTom Rini		CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
27047e27f89fSTom Rini
27057e27f89fSTom Rini		Define this in order to add variables describing certain
27067e27f89fSTom Rini		run-time determined information about the hardware to the
27077e27f89fSTom Rini		environment.  These will be named board_name, board_rev.
27087e27f89fSTom Rini
270906fd8538SSimon Glass		CONFIG_DELAY_ENVIRONMENT
271006fd8538SSimon Glass
271106fd8538SSimon Glass		Normally the environment is loaded when the board is
271206fd8538SSimon Glass		intialised so that it is available to U-Boot. This inhibits
271306fd8538SSimon Glass		that so that the environment is not available until
271406fd8538SSimon Glass		explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
271506fd8538SSimon Glass		this is instead controlled by the value of
271606fd8538SSimon Glass		/config/load-environment.
271706fd8538SSimon Glass
2718a8c7c708Swdenk- DataFlash Support:
27192abbe075Swdenk		CONFIG_HAS_DATAFLASH
27202abbe075Swdenk
27212abbe075Swdenk		Defining this option enables DataFlash features and
27222abbe075Swdenk		allows to read/write in Dataflash via the standard
27232abbe075Swdenk		commands cp, md...
27242abbe075Swdenk
2725f61ec45eSEric Nelson- Serial Flash support
2726f61ec45eSEric Nelson		CONFIG_CMD_SF
2727f61ec45eSEric Nelson
2728f61ec45eSEric Nelson		Defining this option enables SPI flash commands
2729f61ec45eSEric Nelson		'sf probe/read/write/erase/update'.
2730f61ec45eSEric Nelson
2731f61ec45eSEric Nelson		Usage requires an initial 'probe' to define the serial
2732f61ec45eSEric Nelson		flash parameters, followed by read/write/erase/update
2733f61ec45eSEric Nelson		commands.
2734f61ec45eSEric Nelson
2735f61ec45eSEric Nelson		The following defaults may be provided by the platform
2736f61ec45eSEric Nelson		to handle the common case when only a single serial
2737f61ec45eSEric Nelson		flash is present on the system.
2738f61ec45eSEric Nelson
2739f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_BUS		Bus identifier
2740f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_CS		Chip-select
2741f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_MODE 		(see include/spi.h)
2742f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_SPEED		in Hz
2743f61ec45eSEric Nelson
274424007273SSimon Glass		CONFIG_CMD_SF_TEST
274524007273SSimon Glass
274624007273SSimon Glass		Define this option to include a destructive SPI flash
274724007273SSimon Glass		test ('sf test').
274824007273SSimon Glass
27491dcd6d03SJagannadha Sutradharudu Teki		CONFIG_SPI_FLASH_BAR		Ban/Extended Addr Reg
27501dcd6d03SJagannadha Sutradharudu Teki
27511dcd6d03SJagannadha Sutradharudu Teki		Define this option to use the Bank addr/Extended addr
27521dcd6d03SJagannadha Sutradharudu Teki		support on SPI flashes which has size > 16Mbytes.
27531dcd6d03SJagannadha Sutradharudu Teki
27543f85ce27Swdenk- SystemACE Support:
27553f85ce27Swdenk		CONFIG_SYSTEMACE
27563f85ce27Swdenk
27573f85ce27Swdenk		Adding this option adds support for Xilinx SystemACE
27583f85ce27Swdenk		chips attached via some sort of local bus. The address
275911ccc33fSMarcel Ziswiler		of the chip must also be defined in the
27606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SYSTEMACE_BASE macro. For example:
27613f85ce27Swdenk
27623f85ce27Swdenk		#define CONFIG_SYSTEMACE
27636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
27643f85ce27Swdenk
27653f85ce27Swdenk		When SystemACE support is added, the "ace" device type
27663f85ce27Swdenk		becomes available to the fat commands, i.e. fatls.
27673f85ce27Swdenk
2768ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port:
2769ecb0ccd9SWolfgang Denk		CONFIG_TFTP_PORT
2770ecb0ccd9SWolfgang Denk
277128cb9375SWolfgang Denk		If this is defined, the environment variable tftpsrcp
2772ecb0ccd9SWolfgang Denk		is used to supply the TFTP UDP source port value.
277328cb9375SWolfgang Denk		If tftpsrcp isn't defined, the normal pseudo-random port
2774ecb0ccd9SWolfgang Denk		number generator is used.
2775ecb0ccd9SWolfgang Denk
277628cb9375SWolfgang Denk		Also, the environment variable tftpdstp is used to supply
277728cb9375SWolfgang Denk		the TFTP UDP destination port value.  If tftpdstp isn't
277828cb9375SWolfgang Denk		defined, the normal port 69 is used.
277928cb9375SWolfgang Denk
278028cb9375SWolfgang Denk		The purpose for tftpsrcp is to allow a TFTP server to
2781ecb0ccd9SWolfgang Denk		blindly start the TFTP transfer using the pre-configured
2782ecb0ccd9SWolfgang Denk		target IP address and UDP port. This has the effect of
2783ecb0ccd9SWolfgang Denk		"punching through" the (Windows XP) firewall, allowing
2784ecb0ccd9SWolfgang Denk		the remainder of the TFTP transfer to proceed normally.
2785ecb0ccd9SWolfgang Denk		A better solution is to properly configure the firewall,
2786ecb0ccd9SWolfgang Denk		but sometimes that is not allowed.
2787ecb0ccd9SWolfgang Denk
2788bf36c5d5SSimon Glass- Hashing support:
2789bf36c5d5SSimon Glass		CONFIG_CMD_HASH
2790bf36c5d5SSimon Glass
2791bf36c5d5SSimon Glass		This enables a generic 'hash' command which can produce
2792bf36c5d5SSimon Glass		hashes / digests from a few algorithms (e.g. SHA1, SHA256).
2793bf36c5d5SSimon Glass
2794bf36c5d5SSimon Glass		CONFIG_HASH_VERIFY
2795bf36c5d5SSimon Glass
2796bf36c5d5SSimon Glass		Enable the hash verify command (hash -v). This adds to code
2797bf36c5d5SSimon Glass		size a little.
2798bf36c5d5SSimon Glass
2799bf36c5d5SSimon Glass		CONFIG_SHA1 - support SHA1 hashing
2800bf36c5d5SSimon Glass		CONFIG_SHA256 - support SHA256 hashing
2801bf36c5d5SSimon Glass
2802bf36c5d5SSimon Glass		Note: There is also a sha1sum command, which should perhaps
2803bf36c5d5SSimon Glass		be deprecated in favour of 'hash sha1'.
2804bf36c5d5SSimon Glass
2805a11f1873SRobert Winkler- Freescale i.MX specific commands:
2806a11f1873SRobert Winkler		CONFIG_CMD_HDMIDETECT
2807a11f1873SRobert Winkler		This enables 'hdmidet' command which returns true if an
2808a11f1873SRobert Winkler		HDMI monitor is detected.  This command is i.MX 6 specific.
2809a11f1873SRobert Winkler
2810a11f1873SRobert Winkler		CONFIG_CMD_BMODE
2811a11f1873SRobert Winkler		This enables the 'bmode' (bootmode) command for forcing
2812a11f1873SRobert Winkler		a boot from specific media.
2813a11f1873SRobert Winkler
2814a11f1873SRobert Winkler		This is useful for forcing the ROM's usb downloader to
2815a11f1873SRobert Winkler		activate upon a watchdog reset which is nice when iterating
2816a11f1873SRobert Winkler		on U-Boot.  Using the reset button or running bmode normal
2817a11f1873SRobert Winkler		will set it back to normal.  This command currently
2818a11f1873SRobert Winkler		supports i.MX53 and i.MX6.
2819a11f1873SRobert Winkler
282019c402afSSimon Glass- Signing support:
282119c402afSSimon Glass		CONFIG_RSA
282219c402afSSimon Glass
282319c402afSSimon Glass		This enables the RSA algorithm used for FIT image verification
282419c402afSSimon Glass		in U-Boot. See doc/uImage/signature for more information.
282519c402afSSimon Glass
282619c402afSSimon Glass		The signing part is build into mkimage regardless of this
282719c402afSSimon Glass		option.
282819c402afSSimon Glass
282919c402afSSimon Glass
2830a8c7c708Swdenk- Show boot progress:
2831c609719bSwdenk		CONFIG_SHOW_BOOT_PROGRESS
2832c609719bSwdenk
2833c609719bSwdenk		Defining this option allows to add some board-
2834c609719bSwdenk		specific code (calling a user-provided function
2835c609719bSwdenk		"show_boot_progress(int)") that enables you to show
2836c609719bSwdenk		the system's boot progress on some display (for
2837c609719bSwdenk		example, some LED's) on your board. At the moment,
2838c609719bSwdenk		the following checkpoints are implemented:
2839c609719bSwdenk
28403a608ca0SSimon Glass- Detailed boot stage timing
28413a608ca0SSimon Glass		CONFIG_BOOTSTAGE
28423a608ca0SSimon Glass		Define this option to get detailed timing of each stage
28433a608ca0SSimon Glass		of the boot process.
28443a608ca0SSimon Glass
28453a608ca0SSimon Glass		CONFIG_BOOTSTAGE_USER_COUNT
28463a608ca0SSimon Glass		This is the number of available user bootstage records.
28473a608ca0SSimon Glass		Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
28483a608ca0SSimon Glass		a new ID will be allocated from this stash. If you exceed
28493a608ca0SSimon Glass		the limit, recording will stop.
28503a608ca0SSimon Glass
28513a608ca0SSimon Glass		CONFIG_BOOTSTAGE_REPORT
28523a608ca0SSimon Glass		Define this to print a report before boot, similar to this:
28533a608ca0SSimon Glass
28543a608ca0SSimon Glass		Timer summary in microseconds:
28553a608ca0SSimon Glass		       Mark    Elapsed  Stage
28563a608ca0SSimon Glass			  0          0  reset
28573a608ca0SSimon Glass		  3,575,678  3,575,678  board_init_f start
28583a608ca0SSimon Glass		  3,575,695         17  arch_cpu_init A9
28593a608ca0SSimon Glass		  3,575,777         82  arch_cpu_init done
28603a608ca0SSimon Glass		  3,659,598     83,821  board_init_r start
28613a608ca0SSimon Glass		  3,910,375    250,777  main_loop
28623a608ca0SSimon Glass		 29,916,167 26,005,792  bootm_start
28633a608ca0SSimon Glass		 30,361,327    445,160  start_kernel
28643a608ca0SSimon Glass
28652eba38cfSSimon Glass		CONFIG_CMD_BOOTSTAGE
28662eba38cfSSimon Glass		Add a 'bootstage' command which supports printing a report
28672eba38cfSSimon Glass		and un/stashing of bootstage data.
28682eba38cfSSimon Glass
286994fd1316SSimon Glass		CONFIG_BOOTSTAGE_FDT
287094fd1316SSimon Glass		Stash the bootstage information in the FDT. A root 'bootstage'
287194fd1316SSimon Glass		node is created with each bootstage id as a child. Each child
287294fd1316SSimon Glass		has a 'name' property and either 'mark' containing the
287394fd1316SSimon Glass		mark time in microsecond, or 'accum' containing the
287494fd1316SSimon Glass		accumulated time for that bootstage id in microseconds.
287594fd1316SSimon Glass		For example:
287694fd1316SSimon Glass
287794fd1316SSimon Glass		bootstage {
287894fd1316SSimon Glass			154 {
287994fd1316SSimon Glass				name = "board_init_f";
288094fd1316SSimon Glass				mark = <3575678>;
288194fd1316SSimon Glass			};
288294fd1316SSimon Glass			170 {
288394fd1316SSimon Glass				name = "lcd";
288494fd1316SSimon Glass				accum = <33482>;
288594fd1316SSimon Glass			};
288694fd1316SSimon Glass		};
288794fd1316SSimon Glass
288894fd1316SSimon Glass		Code in the Linux kernel can find this in /proc/devicetree.
288994fd1316SSimon Glass
28901372cce2SMarian BalakowiczLegacy uImage format:
28911372cce2SMarian Balakowicz
2892c609719bSwdenk  Arg	Where			When
2893c609719bSwdenk    1	common/cmd_bootm.c	before attempting to boot an image
2894c609719bSwdenk   -1	common/cmd_bootm.c	Image header has bad	 magic number
2895c609719bSwdenk    2	common/cmd_bootm.c	Image header has correct magic number
2896c609719bSwdenk   -2	common/cmd_bootm.c	Image header has bad	 checksum
2897c609719bSwdenk    3	common/cmd_bootm.c	Image header has correct checksum
2898c609719bSwdenk   -3	common/cmd_bootm.c	Image data   has bad	 checksum
2899c609719bSwdenk    4	common/cmd_bootm.c	Image data   has correct checksum
2900c609719bSwdenk   -4	common/cmd_bootm.c	Image is for unsupported architecture
2901c609719bSwdenk    5	common/cmd_bootm.c	Architecture check OK
29021372cce2SMarian Balakowicz   -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi)
2903c609719bSwdenk    6	common/cmd_bootm.c	Image Type check OK
2904c609719bSwdenk   -6	common/cmd_bootm.c	gunzip uncompression error
2905c609719bSwdenk   -7	common/cmd_bootm.c	Unimplemented compression type
2906c609719bSwdenk    7	common/cmd_bootm.c	Uncompression OK
29071372cce2SMarian Balakowicz    8	common/cmd_bootm.c	No uncompress/copy overwrite error
2908c609719bSwdenk   -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
29091372cce2SMarian Balakowicz
29101372cce2SMarian Balakowicz    9	common/image.c		Start initial ramdisk verification
29111372cce2SMarian Balakowicz  -10	common/image.c		Ramdisk header has bad	   magic number
29121372cce2SMarian Balakowicz  -11	common/image.c		Ramdisk header has bad	   checksum
29131372cce2SMarian Balakowicz   10	common/image.c		Ramdisk header is OK
29141372cce2SMarian Balakowicz  -12	common/image.c		Ramdisk data   has bad	   checksum
29151372cce2SMarian Balakowicz   11	common/image.c		Ramdisk data   has correct checksum
29161372cce2SMarian Balakowicz   12	common/image.c		Ramdisk verification complete, start loading
291711ccc33fSMarcel Ziswiler  -13	common/image.c		Wrong Image Type (not PPC Linux ramdisk)
29181372cce2SMarian Balakowicz   13	common/image.c		Start multifile image verification
29191372cce2SMarian Balakowicz   14	common/image.c		No initial ramdisk, no multifile, continue.
29201372cce2SMarian Balakowicz
2921ea0364f1SPeter Tyser   15	arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
2922c609719bSwdenk
2923a47a12beSStefan Roese  -30	arch/powerpc/lib/board.c	Fatal error, hang the system
292463e73c9aSwdenk  -31	post/post.c		POST test failed, detected by post_output_backlog()
292563e73c9aSwdenk  -32	post/post.c		POST test failed, detected by post_run_single()
292663e73c9aSwdenk
2927566a494fSHeiko Schocher   34	common/cmd_doc.c	before loading a Image from a DOC device
2928566a494fSHeiko Schocher  -35	common/cmd_doc.c	Bad usage of "doc" command
2929566a494fSHeiko Schocher   35	common/cmd_doc.c	correct usage of "doc" command
2930566a494fSHeiko Schocher  -36	common/cmd_doc.c	No boot device
2931566a494fSHeiko Schocher   36	common/cmd_doc.c	correct boot device
2932566a494fSHeiko Schocher  -37	common/cmd_doc.c	Unknown Chip ID on boot device
2933566a494fSHeiko Schocher   37	common/cmd_doc.c	correct chip ID found, device available
2934566a494fSHeiko Schocher  -38	common/cmd_doc.c	Read Error on boot device
2935566a494fSHeiko Schocher   38	common/cmd_doc.c	reading Image header from DOC device OK
2936566a494fSHeiko Schocher  -39	common/cmd_doc.c	Image header has bad magic number
2937566a494fSHeiko Schocher   39	common/cmd_doc.c	Image header has correct magic number
2938566a494fSHeiko Schocher  -40	common/cmd_doc.c	Error reading Image from DOC device
2939566a494fSHeiko Schocher   40	common/cmd_doc.c	Image header has correct magic number
2940566a494fSHeiko Schocher   41	common/cmd_ide.c	before loading a Image from a IDE device
2941566a494fSHeiko Schocher  -42	common/cmd_ide.c	Bad usage of "ide" command
2942566a494fSHeiko Schocher   42	common/cmd_ide.c	correct usage of "ide" command
2943566a494fSHeiko Schocher  -43	common/cmd_ide.c	No boot device
2944566a494fSHeiko Schocher   43	common/cmd_ide.c	boot device found
2945566a494fSHeiko Schocher  -44	common/cmd_ide.c	Device not available
2946566a494fSHeiko Schocher   44	common/cmd_ide.c	Device available
2947566a494fSHeiko Schocher  -45	common/cmd_ide.c	wrong partition selected
2948566a494fSHeiko Schocher   45	common/cmd_ide.c	partition selected
2949566a494fSHeiko Schocher  -46	common/cmd_ide.c	Unknown partition table
2950566a494fSHeiko Schocher   46	common/cmd_ide.c	valid partition table found
2951566a494fSHeiko Schocher  -47	common/cmd_ide.c	Invalid partition type
2952566a494fSHeiko Schocher   47	common/cmd_ide.c	correct partition type
2953566a494fSHeiko Schocher  -48	common/cmd_ide.c	Error reading Image Header on boot device
2954566a494fSHeiko Schocher   48	common/cmd_ide.c	reading Image Header from IDE device OK
2955566a494fSHeiko Schocher  -49	common/cmd_ide.c	Image header has bad magic number
2956566a494fSHeiko Schocher   49	common/cmd_ide.c	Image header has correct magic number
2957566a494fSHeiko Schocher  -50	common/cmd_ide.c	Image header has bad	 checksum
2958566a494fSHeiko Schocher   50	common/cmd_ide.c	Image header has correct checksum
2959566a494fSHeiko Schocher  -51	common/cmd_ide.c	Error reading Image from IDE device
2960566a494fSHeiko Schocher   51	common/cmd_ide.c	reading Image from IDE device OK
2961566a494fSHeiko Schocher   52	common/cmd_nand.c	before loading a Image from a NAND device
2962566a494fSHeiko Schocher  -53	common/cmd_nand.c	Bad usage of "nand" command
2963566a494fSHeiko Schocher   53	common/cmd_nand.c	correct usage of "nand" command
2964566a494fSHeiko Schocher  -54	common/cmd_nand.c	No boot device
2965566a494fSHeiko Schocher   54	common/cmd_nand.c	boot device found
2966566a494fSHeiko Schocher  -55	common/cmd_nand.c	Unknown Chip ID on boot device
2967566a494fSHeiko Schocher   55	common/cmd_nand.c	correct chip ID found, device available
2968566a494fSHeiko Schocher  -56	common/cmd_nand.c	Error reading Image Header on boot device
2969566a494fSHeiko Schocher   56	common/cmd_nand.c	reading Image Header from NAND device OK
2970566a494fSHeiko Schocher  -57	common/cmd_nand.c	Image header has bad magic number
2971566a494fSHeiko Schocher   57	common/cmd_nand.c	Image header has correct magic number
2972566a494fSHeiko Schocher  -58	common/cmd_nand.c	Error reading Image from NAND device
2973566a494fSHeiko Schocher   58	common/cmd_nand.c	reading Image from NAND device OK
2974c609719bSwdenk
2975566a494fSHeiko Schocher  -60	common/env_common.c	Environment has a bad CRC, using default
2976c609719bSwdenk
2977566a494fSHeiko Schocher   64	net/eth.c		starting with Ethernet configuration.
2978566a494fSHeiko Schocher  -64	net/eth.c		no Ethernet found.
2979566a494fSHeiko Schocher   65	net/eth.c		Ethernet found.
2980206c60cbSwdenk
2981566a494fSHeiko Schocher  -80	common/cmd_net.c	usage wrong
2982566a494fSHeiko Schocher   80	common/cmd_net.c	before calling NetLoop()
298311ccc33fSMarcel Ziswiler  -81	common/cmd_net.c	some error in NetLoop() occurred
2984566a494fSHeiko Schocher   81	common/cmd_net.c	NetLoop() back without error
2985566a494fSHeiko Schocher  -82	common/cmd_net.c	size == 0 (File with size 0 loaded)
2986566a494fSHeiko Schocher   82	common/cmd_net.c	trying automatic boot
298774de7aefSWolfgang Denk   83	common/cmd_net.c	running "source" command
298874de7aefSWolfgang Denk  -83	common/cmd_net.c	some error in automatic boot or "source" command
2989566a494fSHeiko Schocher   84	common/cmd_net.c	end without errors
2990c609719bSwdenk
29911372cce2SMarian BalakowiczFIT uImage format:
29921372cce2SMarian Balakowicz
29931372cce2SMarian Balakowicz  Arg	Where			When
29941372cce2SMarian Balakowicz  100	common/cmd_bootm.c	Kernel FIT Image has correct format
29951372cce2SMarian Balakowicz -100	common/cmd_bootm.c	Kernel FIT Image has incorrect format
29961372cce2SMarian Balakowicz  101	common/cmd_bootm.c	No Kernel subimage unit name, using configuration
29971372cce2SMarian Balakowicz -101	common/cmd_bootm.c	Can't get configuration for kernel subimage
29981372cce2SMarian Balakowicz  102	common/cmd_bootm.c	Kernel unit name specified
29991372cce2SMarian Balakowicz -103	common/cmd_bootm.c	Can't get kernel subimage node offset
3000f773bea8SMarian Balakowicz  103	common/cmd_bootm.c	Found configuration node
30011372cce2SMarian Balakowicz  104	common/cmd_bootm.c	Got kernel subimage node offset
30021372cce2SMarian Balakowicz -104	common/cmd_bootm.c	Kernel subimage hash verification failed
30031372cce2SMarian Balakowicz  105	common/cmd_bootm.c	Kernel subimage hash verification OK
30041372cce2SMarian Balakowicz -105	common/cmd_bootm.c	Kernel subimage is for unsupported architecture
30051372cce2SMarian Balakowicz  106	common/cmd_bootm.c	Architecture check OK
300611ccc33fSMarcel Ziswiler -106	common/cmd_bootm.c	Kernel subimage has wrong type
300711ccc33fSMarcel Ziswiler  107	common/cmd_bootm.c	Kernel subimage type OK
30081372cce2SMarian Balakowicz -107	common/cmd_bootm.c	Can't get kernel subimage data/size
30091372cce2SMarian Balakowicz  108	common/cmd_bootm.c	Got kernel subimage data/size
30101372cce2SMarian Balakowicz -108	common/cmd_bootm.c	Wrong image type (not legacy, FIT)
30111372cce2SMarian Balakowicz -109	common/cmd_bootm.c	Can't get kernel subimage type
30121372cce2SMarian Balakowicz -110	common/cmd_bootm.c	Can't get kernel subimage comp
30131372cce2SMarian Balakowicz -111	common/cmd_bootm.c	Can't get kernel subimage os
30141372cce2SMarian Balakowicz -112	common/cmd_bootm.c	Can't get kernel subimage load address
30151372cce2SMarian Balakowicz -113	common/cmd_bootm.c	Image uncompress/copy overwrite error
30161372cce2SMarian Balakowicz
30171372cce2SMarian Balakowicz  120	common/image.c		Start initial ramdisk verification
30181372cce2SMarian Balakowicz -120	common/image.c		Ramdisk FIT image has incorrect format
30191372cce2SMarian Balakowicz  121	common/image.c		Ramdisk FIT image has correct format
302011ccc33fSMarcel Ziswiler  122	common/image.c		No ramdisk subimage unit name, using configuration
30211372cce2SMarian Balakowicz -122	common/image.c		Can't get configuration for ramdisk subimage
30221372cce2SMarian Balakowicz  123	common/image.c		Ramdisk unit name specified
30231372cce2SMarian Balakowicz -124	common/image.c		Can't get ramdisk subimage node offset
30241372cce2SMarian Balakowicz  125	common/image.c		Got ramdisk subimage node offset
30251372cce2SMarian Balakowicz -125	common/image.c		Ramdisk subimage hash verification failed
30261372cce2SMarian Balakowicz  126	common/image.c		Ramdisk subimage hash verification OK
30271372cce2SMarian Balakowicz -126	common/image.c		Ramdisk subimage for unsupported architecture
30281372cce2SMarian Balakowicz  127	common/image.c		Architecture check OK
30291372cce2SMarian Balakowicz -127	common/image.c		Can't get ramdisk subimage data/size
30301372cce2SMarian Balakowicz  128	common/image.c		Got ramdisk subimage data/size
30311372cce2SMarian Balakowicz  129	common/image.c		Can't get ramdisk load address
30321372cce2SMarian Balakowicz -129	common/image.c		Got ramdisk load address
30331372cce2SMarian Balakowicz
303411ccc33fSMarcel Ziswiler -130	common/cmd_doc.c	Incorrect FIT image format
30351372cce2SMarian Balakowicz  131	common/cmd_doc.c	FIT image format OK
30361372cce2SMarian Balakowicz
303711ccc33fSMarcel Ziswiler -140	common/cmd_ide.c	Incorrect FIT image format
30381372cce2SMarian Balakowicz  141	common/cmd_ide.c	FIT image format OK
30391372cce2SMarian Balakowicz
304011ccc33fSMarcel Ziswiler -150	common/cmd_nand.c	Incorrect FIT image format
30411372cce2SMarian Balakowicz  151	common/cmd_nand.c	FIT image format OK
30421372cce2SMarian Balakowicz
3043d95f6ec7SGabe Black- FIT image support:
3044d95f6ec7SGabe Black		CONFIG_FIT
3045d95f6ec7SGabe Black		Enable support for the FIT uImage format.
3046d95f6ec7SGabe Black
3047d95f6ec7SGabe Black		CONFIG_FIT_BEST_MATCH
3048d95f6ec7SGabe Black		When no configuration is explicitly selected, default to the
3049d95f6ec7SGabe Black		one whose fdt's compatibility field best matches that of
3050d95f6ec7SGabe Black		U-Boot itself. A match is considered "best" if it matches the
3051d95f6ec7SGabe Black		most specific compatibility entry of U-Boot's fdt's root node.
3052d95f6ec7SGabe Black		The order of entries in the configuration's fdt is ignored.
3053d95f6ec7SGabe Black
30543e569a6bSSimon Glass		CONFIG_FIT_SIGNATURE
30553e569a6bSSimon Glass		This option enables signature verification of FIT uImages,
30563e569a6bSSimon Glass		using a hash signed and verified using RSA. See
30573e569a6bSSimon Glass		doc/uImage.FIT/signature.txt for more details.
30583e569a6bSSimon Glass
30594cf2609bSWolfgang Denk- Standalone program support:
30604cf2609bSWolfgang Denk		CONFIG_STANDALONE_LOAD_ADDR
30614cf2609bSWolfgang Denk
30626feff899SWolfgang Denk		This option defines a board specific value for the
30636feff899SWolfgang Denk		address where standalone program gets loaded, thus
30646feff899SWolfgang Denk		overwriting the architecture dependent default
30654cf2609bSWolfgang Denk		settings.
30664cf2609bSWolfgang Denk
30674cf2609bSWolfgang Denk- Frame Buffer Address:
30684cf2609bSWolfgang Denk		CONFIG_FB_ADDR
30694cf2609bSWolfgang Denk
30704cf2609bSWolfgang Denk		Define CONFIG_FB_ADDR if you want to use specific
307144a53b57SWolfgang Denk		address for frame buffer.  This is typically the case
307244a53b57SWolfgang Denk		when using a graphics controller has separate video
307344a53b57SWolfgang Denk		memory.  U-Boot will then place the frame buffer at
307444a53b57SWolfgang Denk		the given address instead of dynamically reserving it
307544a53b57SWolfgang Denk		in system RAM by calling lcd_setmem(), which grabs
307644a53b57SWolfgang Denk		the memory for the frame buffer depending on the
307744a53b57SWolfgang Denk		configured panel size.
30784cf2609bSWolfgang Denk
30794cf2609bSWolfgang Denk		Please see board_init_f function.
30804cf2609bSWolfgang Denk
3081cccfc2abSDetlev Zundel- Automatic software updates via TFTP server
3082cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP
3083cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_CNT_MAX
3084cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_MSEC_MAX
3085cccfc2abSDetlev Zundel
3086cccfc2abSDetlev Zundel		These options enable and control the auto-update feature;
3087cccfc2abSDetlev Zundel		for a more detailed description refer to doc/README.update.
3088cccfc2abSDetlev Zundel
3089cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support)
3090cccfc2abSDetlev Zundel		CONFIG_MTD_DEVICE
3091cccfc2abSDetlev Zundel
3092cccfc2abSDetlev Zundel		Adds the MTD device infrastructure from the Linux kernel.
3093cccfc2abSDetlev Zundel		Needed for mtdparts command support.
3094cccfc2abSDetlev Zundel
3095cccfc2abSDetlev Zundel		CONFIG_MTD_PARTITIONS
3096cccfc2abSDetlev Zundel
3097cccfc2abSDetlev Zundel		Adds the MTD partitioning infrastructure from the Linux
3098cccfc2abSDetlev Zundel		kernel. Needed for UBI support.
3099cccfc2abSDetlev Zundel
310070c219cdSJoe Hershberger- UBI support
310170c219cdSJoe Hershberger		CONFIG_CMD_UBI
310270c219cdSJoe Hershberger
310370c219cdSJoe Hershberger		Adds commands for interacting with MTD partitions formatted
310470c219cdSJoe Hershberger		with the UBI flash translation layer
310570c219cdSJoe Hershberger
310670c219cdSJoe Hershberger		Requires also defining CONFIG_RBTREE
310770c219cdSJoe Hershberger
3108147162daSJoe Hershberger		CONFIG_UBI_SILENCE_MSG
3109147162daSJoe Hershberger
3110147162daSJoe Hershberger		Make the verbose messages from UBI stop printing.  This leaves
3111147162daSJoe Hershberger		warnings and errors enabled.
3112147162daSJoe Hershberger
311370c219cdSJoe Hershberger- UBIFS support
311470c219cdSJoe Hershberger		CONFIG_CMD_UBIFS
311570c219cdSJoe Hershberger
311670c219cdSJoe Hershberger		Adds commands for interacting with UBI volumes formatted as
311770c219cdSJoe Hershberger		UBIFS.  UBIFS is read-only in u-boot.
311870c219cdSJoe Hershberger
311970c219cdSJoe Hershberger		Requires UBI support as well as CONFIG_LZO
312070c219cdSJoe Hershberger
3121147162daSJoe Hershberger		CONFIG_UBIFS_SILENCE_MSG
3122147162daSJoe Hershberger
3123147162daSJoe Hershberger		Make the verbose messages from UBIFS stop printing.  This leaves
3124147162daSJoe Hershberger		warnings and errors enabled.
3125147162daSJoe Hershberger
31266a11cf48SDaniel Schwierzeck- SPL framework
31276a11cf48SDaniel Schwierzeck		CONFIG_SPL
31286a11cf48SDaniel Schwierzeck		Enable building of SPL globally.
31296a11cf48SDaniel Schwierzeck
313095579793STom Rini		CONFIG_SPL_LDSCRIPT
313195579793STom Rini		LDSCRIPT for linking the SPL binary.
313295579793STom Rini
31336ebc3461SAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT
31346ebc3461SAlbert ARIBAUD		Maximum size in memory allocated to the SPL, BSS included.
31356ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual memory
31366ebc3461SAlbert ARIBAUD		used by SPL from _start to __bss_end does not exceed it.
31378960af8bSAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
31386ebc3461SAlbert ARIBAUD		must not be both defined at the same time.
31396ebc3461SAlbert ARIBAUD
314095579793STom Rini		CONFIG_SPL_MAX_SIZE
31416ebc3461SAlbert ARIBAUD		Maximum size of the SPL image (text, data, rodata, and
31426ebc3461SAlbert ARIBAUD		linker lists sections), BSS excluded.
31436ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual size does
31446ebc3461SAlbert ARIBAUD		not exceed it.
314595579793STom Rini
31466a11cf48SDaniel Schwierzeck		CONFIG_SPL_TEXT_BASE
31476a11cf48SDaniel Schwierzeck		TEXT_BASE for linking the SPL binary.
31486a11cf48SDaniel Schwierzeck
314994a45bb1SScott Wood		CONFIG_SPL_RELOC_TEXT_BASE
315094a45bb1SScott Wood		Address to relocate to.  If unspecified, this is equal to
315194a45bb1SScott Wood		CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
315294a45bb1SScott Wood
315395579793STom Rini		CONFIG_SPL_BSS_START_ADDR
315495579793STom Rini		Link address for the BSS within the SPL binary.
315595579793STom Rini
315695579793STom Rini		CONFIG_SPL_BSS_MAX_SIZE
31576ebc3461SAlbert ARIBAUD		Maximum size in memory allocated to the SPL BSS.
31586ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual memory used
31596ebc3461SAlbert ARIBAUD		by SPL from __bss_start to __bss_end does not exceed it.
31608960af8bSAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
31616ebc3461SAlbert ARIBAUD		must not be both defined at the same time.
316295579793STom Rini
316395579793STom Rini		CONFIG_SPL_STACK
316495579793STom Rini		Adress of the start of the stack SPL will use
316595579793STom Rini
316694a45bb1SScott Wood		CONFIG_SPL_RELOC_STACK
316794a45bb1SScott Wood		Adress of the start of the stack SPL will use after
316894a45bb1SScott Wood		relocation.  If unspecified, this is equal to
316994a45bb1SScott Wood		CONFIG_SPL_STACK.
317094a45bb1SScott Wood
317195579793STom Rini		CONFIG_SYS_SPL_MALLOC_START
317295579793STom Rini		Starting address of the malloc pool used in SPL.
317395579793STom Rini
317495579793STom Rini		CONFIG_SYS_SPL_MALLOC_SIZE
317595579793STom Rini		The size of the malloc pool used in SPL.
31766a11cf48SDaniel Schwierzeck
317747f7bcaeSTom Rini		CONFIG_SPL_FRAMEWORK
317847f7bcaeSTom Rini		Enable the SPL framework under common/.  This framework
317947f7bcaeSTom Rini		supports MMC, NAND and YMODEM loading of U-Boot and NAND
318047f7bcaeSTom Rini		NAND loading of the Linux Kernel.
318147f7bcaeSTom Rini
3182861a86f4STom Rini		CONFIG_SPL_DISPLAY_PRINT
3183861a86f4STom Rini		For ARM, enable an optional function to print more information
3184861a86f4STom Rini		about the running system.
3185861a86f4STom Rini
31864b919725SScott Wood		CONFIG_SPL_INIT_MINIMAL
31874b919725SScott Wood		Arch init code should be built for a very small image
31884b919725SScott Wood
31896a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBCOMMON_SUPPORT
31906a11cf48SDaniel Schwierzeck		Support for common/libcommon.o in SPL binary
31916a11cf48SDaniel Schwierzeck
31926a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBDISK_SUPPORT
31936a11cf48SDaniel Schwierzeck		Support for disk/libdisk.o in SPL binary
31946a11cf48SDaniel Schwierzeck
31956a11cf48SDaniel Schwierzeck		CONFIG_SPL_I2C_SUPPORT
31966a11cf48SDaniel Schwierzeck		Support for drivers/i2c/libi2c.o in SPL binary
31976a11cf48SDaniel Schwierzeck
31986a11cf48SDaniel Schwierzeck		CONFIG_SPL_GPIO_SUPPORT
31996a11cf48SDaniel Schwierzeck		Support for drivers/gpio/libgpio.o in SPL binary
32006a11cf48SDaniel Schwierzeck
32016a11cf48SDaniel Schwierzeck		CONFIG_SPL_MMC_SUPPORT
32026a11cf48SDaniel Schwierzeck		Support for drivers/mmc/libmmc.o in SPL binary
32036a11cf48SDaniel Schwierzeck
320495579793STom Rini		CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
320595579793STom Rini		CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
320695579793STom Rini		CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION
320795579793STom Rini		Address, size and partition on the MMC to load U-Boot from
320895579793STom Rini		when the MMC is being used in raw mode.
320995579793STom Rini
32102b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
32112b75b0adSPeter Korsgaard		Sector to load kernel uImage from when MMC is being
32122b75b0adSPeter Korsgaard		used in raw mode (for Falcon mode)
32132b75b0adSPeter Korsgaard
32142b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
32152b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
32162b75b0adSPeter Korsgaard		Sector and number of sectors to load kernel argument
32172b75b0adSPeter Korsgaard		parameters from when MMC is being used in raw mode
32182b75b0adSPeter Korsgaard		(for falcon mode)
32192b75b0adSPeter Korsgaard
322095579793STom Rini		CONFIG_SPL_FAT_SUPPORT
322195579793STom Rini		Support for fs/fat/libfat.o in SPL binary
322295579793STom Rini
322395579793STom Rini		CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME
322495579793STom Rini		Filename to read to load U-Boot when reading from FAT
322595579793STom Rini
32267ad2cc79SPeter Korsgaard		CONFIG_SPL_FAT_LOAD_KERNEL_NAME
32277ad2cc79SPeter Korsgaard		Filename to read to load kernel uImage when reading
32287ad2cc79SPeter Korsgaard		from FAT (for Falcon mode)
32297ad2cc79SPeter Korsgaard
32307ad2cc79SPeter Korsgaard		CONFIG_SPL_FAT_LOAD_ARGS_NAME
32317ad2cc79SPeter Korsgaard		Filename to read to load kernel argument parameters
32327ad2cc79SPeter Korsgaard		when reading from FAT (for Falcon mode)
32337ad2cc79SPeter Korsgaard
323406f60ae3SScott Wood		CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
323506f60ae3SScott Wood		Set this for NAND SPL on PPC mpc83xx targets, so that
323606f60ae3SScott Wood		start.S waits for the rest of the SPL to load before
323706f60ae3SScott Wood		continuing (the hardware starts execution after just
323806f60ae3SScott Wood		loading the first page rather than the full 4K).
323906f60ae3SScott Wood
32406f2f01b9SScott Wood		CONFIG_SPL_NAND_BASE
32416f2f01b9SScott Wood		Include nand_base.c in the SPL.  Requires
32426f2f01b9SScott Wood		CONFIG_SPL_NAND_DRIVERS.
32436f2f01b9SScott Wood
32446f2f01b9SScott Wood		CONFIG_SPL_NAND_DRIVERS
32456f2f01b9SScott Wood		SPL uses normal NAND drivers, not minimal drivers.
32466f2f01b9SScott Wood
32476f2f01b9SScott Wood		CONFIG_SPL_NAND_ECC
32486f2f01b9SScott Wood		Include standard software ECC in the SPL
32496f2f01b9SScott Wood
325095579793STom Rini		CONFIG_SPL_NAND_SIMPLE
32517d4b7955SScott Wood		Support for NAND boot using simple NAND drivers that
32527d4b7955SScott Wood		expose the cmd_ctrl() interface.
325395579793STom Rini
3254bb0dc108SYing Zhang		CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT
3255bb0dc108SYing Zhang		Set for the SPL on PPC mpc8xxx targets, support for
32565614e71bSYork Sun		drivers/ddr/fsl/libddr.o in SPL binary.
3257bb0dc108SYing Zhang
32587c8eea59SYing Zhang		CONFIG_SPL_COMMON_INIT_DDR
32597c8eea59SYing Zhang		Set for common ddr init with serial presence detect in
32607c8eea59SYing Zhang		SPL binary.
32617c8eea59SYing Zhang
326295579793STom Rini		CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
326395579793STom Rini		CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
326495579793STom Rini		CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
326595579793STom Rini		CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
326695579793STom Rini		CONFIG_SYS_NAND_ECCBYTES
326795579793STom Rini		Defines the size and behavior of the NAND that SPL uses
32687d4b7955SScott Wood		to read U-Boot
326995579793STom Rini
327095579793STom Rini		CONFIG_SYS_NAND_U_BOOT_OFFS
32717d4b7955SScott Wood		Location in NAND to read U-Boot from
32727d4b7955SScott Wood
32737d4b7955SScott Wood		CONFIG_SYS_NAND_U_BOOT_DST
32747d4b7955SScott Wood		Location in memory to load U-Boot to
32757d4b7955SScott Wood
32767d4b7955SScott Wood		CONFIG_SYS_NAND_U_BOOT_SIZE
32777d4b7955SScott Wood		Size of image to load
327895579793STom Rini
327995579793STom Rini		CONFIG_SYS_NAND_U_BOOT_START
32807d4b7955SScott Wood		Entry point in loaded image to jump to
328195579793STom Rini
328295579793STom Rini		CONFIG_SYS_NAND_HW_ECC_OOBFIRST
328395579793STom Rini		Define this if you need to first read the OOB and then the
328495579793STom Rini		data. This is used for example on davinci plattforms.
328595579793STom Rini
328695579793STom Rini		CONFIG_SPL_OMAP3_ID_NAND
328795579793STom Rini		Support for an OMAP3-specific set of functions to return the
328895579793STom Rini		ID and MFR of the first attached NAND chip, if present.
328995579793STom Rini
32906a11cf48SDaniel Schwierzeck		CONFIG_SPL_SERIAL_SUPPORT
32916a11cf48SDaniel Schwierzeck		Support for drivers/serial/libserial.o in SPL binary
32926a11cf48SDaniel Schwierzeck
32936a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_FLASH_SUPPORT
32946a11cf48SDaniel Schwierzeck		Support for drivers/mtd/spi/libspi_flash.o in SPL binary
32956a11cf48SDaniel Schwierzeck
32966a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_SUPPORT
32976a11cf48SDaniel Schwierzeck		Support for drivers/spi/libspi.o in SPL binary
32986a11cf48SDaniel Schwierzeck
3299c57b953dSPavel Machek		CONFIG_SPL_RAM_DEVICE
3300c57b953dSPavel Machek		Support for running image already present in ram, in SPL binary
3301c57b953dSPavel Machek
33026a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBGENERIC_SUPPORT
33036a11cf48SDaniel Schwierzeck		Support for lib/libgeneric.o in SPL binary
33041372cce2SMarian Balakowicz
3305ba1bee43SYing Zhang		CONFIG_SPL_ENV_SUPPORT
3306ba1bee43SYing Zhang		Support for the environment operating in SPL binary
3307ba1bee43SYing Zhang
3308ba1bee43SYing Zhang		CONFIG_SPL_NET_SUPPORT
3309ba1bee43SYing Zhang		Support for the net/libnet.o in SPL binary.
3310ba1bee43SYing Zhang		It conflicts with SPL env from storage medium specified by
3311ba1bee43SYing Zhang		CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3312ba1bee43SYing Zhang
331374752baaSScott Wood		CONFIG_SPL_PAD_TO
33146113d3f2SBenoît Thébaudeau		Image offset to which the SPL should be padded before appending
33156113d3f2SBenoît Thébaudeau		the SPL payload. By default, this is defined as
33166113d3f2SBenoît Thébaudeau		CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
33176113d3f2SBenoît Thébaudeau		CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
33186113d3f2SBenoît Thébaudeau		payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
331974752baaSScott Wood
3320ca2fca22SScott Wood		CONFIG_SPL_TARGET
3321ca2fca22SScott Wood		Final target image containing SPL and payload.  Some SPLs
3322ca2fca22SScott Wood		use an arch-specific makefile fragment instead, for
3323ca2fca22SScott Wood		example if more than one image needs to be produced.
3324ca2fca22SScott Wood
332587ebee39SSimon Glass		CONFIG_FIT_SPL_PRINT
332687ebee39SSimon Glass		Printing information about a FIT image adds quite a bit of
332787ebee39SSimon Glass		code to SPL. So this is normally disabled in SPL. Use this
332887ebee39SSimon Glass		option to re-enable it. This will affect the output of the
332987ebee39SSimon Glass		bootm command when booting a FIT image.
333087ebee39SSimon Glass
33313aa29de0SYing Zhang- TPL framework
33323aa29de0SYing Zhang		CONFIG_TPL
33333aa29de0SYing Zhang		Enable building of TPL globally.
33343aa29de0SYing Zhang
33353aa29de0SYing Zhang		CONFIG_TPL_PAD_TO
33363aa29de0SYing Zhang		Image offset to which the TPL should be padded before appending
33373aa29de0SYing Zhang		the TPL payload. By default, this is defined as
33383aa29de0SYing Zhang		CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
33393aa29de0SYing Zhang		CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
33403aa29de0SYing Zhang		payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
33413aa29de0SYing Zhang
3342c609719bSwdenkModem Support:
3343c609719bSwdenk--------------
3344c609719bSwdenk
3345566e5cf4SWolfgang Denk[so far only for SMDK2400 boards]
3346c609719bSwdenk
334711ccc33fSMarcel Ziswiler- Modem support enable:
3348c609719bSwdenk		CONFIG_MODEM_SUPPORT
3349c609719bSwdenk
3350c609719bSwdenk- RTS/CTS Flow control enable:
3351c609719bSwdenk		CONFIG_HWFLOW
3352c609719bSwdenk
3353c609719bSwdenk- Modem debug support:
3354c609719bSwdenk		CONFIG_MODEM_SUPPORT_DEBUG
3355c609719bSwdenk
3356c609719bSwdenk		Enables debugging stuff (char screen[1024], dbg())
3357c609719bSwdenk		for modem support. Useful only with BDI2000.
3358c609719bSwdenk
3359a8c7c708Swdenk- Interrupt support (PPC):
3360a8c7c708Swdenk
3361a8c7c708Swdenk		There are common interrupt_init() and timer_interrupt()
3362a8c7c708Swdenk		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
336311ccc33fSMarcel Ziswiler		for CPU specific initialization. interrupt_init_cpu()
3364a8c7c708Swdenk		should set decrementer_count to appropriate value. If
336511ccc33fSMarcel Ziswiler		CPU resets decrementer automatically after interrupt
3366a8c7c708Swdenk		(ppc4xx) it should set decrementer_count to zero.
336711ccc33fSMarcel Ziswiler		timer_interrupt() calls timer_interrupt_cpu() for CPU
3368a8c7c708Swdenk		specific handling. If board has watchdog / status_led
3369a8c7c708Swdenk		/ other_activity_monitor it works automatically from
3370a8c7c708Swdenk		general timer_interrupt().
3371a8c7c708Swdenk
3372c609719bSwdenk- General:
3373c609719bSwdenk
3374c609719bSwdenk		In the target system modem support is enabled when a
3375c609719bSwdenk		specific key (key combination) is pressed during
3376c609719bSwdenk		power-on. Otherwise U-Boot will boot normally
337711ccc33fSMarcel Ziswiler		(autoboot). The key_pressed() function is called from
3378c609719bSwdenk		board_init(). Currently key_pressed() is a dummy
3379c609719bSwdenk		function, returning 1 and thus enabling modem
3380c609719bSwdenk		initialization.
3381c609719bSwdenk
3382c609719bSwdenk		If there are no modem init strings in the
3383c609719bSwdenk		environment, U-Boot proceed to autoboot; the
3384c609719bSwdenk		previous output (banner, info printfs) will be
338511ccc33fSMarcel Ziswiler		suppressed, though.
3386c609719bSwdenk
3387c609719bSwdenk		See also: doc/README.Modem
3388c609719bSwdenk
33899660e442SHelmut RaigerBoard initialization settings:
33909660e442SHelmut Raiger------------------------------
33919660e442SHelmut Raiger
33929660e442SHelmut RaigerDuring Initialization u-boot calls a number of board specific functions
33939660e442SHelmut Raigerto allow the preparation of board specific prerequisites, e.g. pin setup
33949660e442SHelmut Raigerbefore drivers are initialized. To enable these callbacks the
33959660e442SHelmut Raigerfollowing configuration macros have to be defined. Currently this is
33969660e442SHelmut Raigerarchitecture specific, so please check arch/your_architecture/lib/board.c
33979660e442SHelmut Raigertypically in board_init_f() and board_init_r().
33989660e442SHelmut Raiger
33999660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
34009660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
34019660e442SHelmut Raiger- CONFIG_BOARD_LATE_INIT: Call board_late_init()
34029660e442SHelmut Raiger- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
3403c609719bSwdenk
3404c609719bSwdenkConfiguration Settings:
3405c609719bSwdenk-----------------------
3406c609719bSwdenk
34076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
3408c609719bSwdenk		undefine this when you're short of memory.
3409c609719bSwdenk
34102fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
34112fb2604dSPeter Tyser		width of the commands listed in the 'help' command output.
34122fb2604dSPeter Tyser
34136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT:	This is what U-Boot prints on the console to
3414c609719bSwdenk		prompt for user input.
3415c609719bSwdenk
34166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE:	Buffer size for input from the Console
3417c609719bSwdenk
34186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE:	Buffer size for Console output
3419c609719bSwdenk
34206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS:	max. Number of arguments accepted for monitor commands
3421c609719bSwdenk
34226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
3423c609719bSwdenk		the application (usually a Linux kernel) when it is
3424c609719bSwdenk		booted
3425c609719bSwdenk
34266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE:
3427c609719bSwdenk		List of legal baudrate settings for this board.
3428c609719bSwdenk
34296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_INFO_QUIET
3430c609719bSwdenk		Suppress display of console information at boot.
3431c609719bSwdenk
34326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_IS_IN_ENV
3433c609719bSwdenk		If the board specific function
3434c609719bSwdenk			extern int overwrite_console (void);
3435c609719bSwdenk		returns 1, the stdin, stderr and stdout are switched to the
3436c609719bSwdenk		serial port, else the settings in the environment are used.
3437c609719bSwdenk
34386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
3439c609719bSwdenk		Enable the call to overwrite_console().
3440c609719bSwdenk
34416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
3442c609719bSwdenk		Enable overwrite of previous console environment settings.
3443c609719bSwdenk
34446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
3445c609719bSwdenk		Begin and End addresses of the area used by the
3446c609719bSwdenk		simple memory test.
3447c609719bSwdenk
34486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST:
3449c609719bSwdenk		Enable an alternate, more extensive memory test.
3450c609719bSwdenk
34516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH:
34525f535fe1Swdenk		Scratch address used by the alternate memory test
34535f535fe1Swdenk		You only need to set this if address zero isn't writeable
34545f535fe1Swdenk
34556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
34566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
345714f73ca6SStefan Roese		this specified memory area will get subtracted from the top
345811ccc33fSMarcel Ziswiler		(end) of RAM and won't get "touched" at all by U-Boot. By
345914f73ca6SStefan Roese		fixing up gd->ram_size the Linux kernel should gets passed
346014f73ca6SStefan Roese		the now "corrected" memory size and won't touch it either.
346114f73ca6SStefan Roese		This should work for arch/ppc and arch/powerpc. Only Linux
34625e12e75dSStefan Roese		board ports in arch/powerpc with bootwrapper support that
346314f73ca6SStefan Roese		recalculate the memory size from the SDRAM controller setup
34645e12e75dSStefan Roese		will have to get fixed in Linux additionally.
346514f73ca6SStefan Roese
346614f73ca6SStefan Roese		This option can be used as a workaround for the 440EPx/GRx
346714f73ca6SStefan Roese		CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
346814f73ca6SStefan Roese		be touched.
346914f73ca6SStefan Roese
347014f73ca6SStefan Roese		WARNING: Please make sure that this value is a multiple of
347114f73ca6SStefan Roese		the Linux page size (normally 4k). If this is not the case,
347214f73ca6SStefan Roese		then the end address of the Linux memory will be located at a
347314f73ca6SStefan Roese		non page size aligned address and this could cause major
347414f73ca6SStefan Roese		problems.
347514f73ca6SStefan Roese
34766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE:
3477c609719bSwdenk		Enable temporary baudrate change while serial download
3478c609719bSwdenk
34796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE:
3480c609719bSwdenk		Physical start address of SDRAM. _Must_ be 0 here.
3481c609719bSwdenk
34826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MBIO_BASE:
3483c609719bSwdenk		Physical start address of Motherboard I/O (if using a
3484c609719bSwdenk		Cogent motherboard)
3485c609719bSwdenk
34866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE:
3487c609719bSwdenk		Physical start address of Flash memory.
3488c609719bSwdenk
34896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE:
3490c609719bSwdenk		Physical start address of boot monitor code (set by
3491c609719bSwdenk		make config files to be same as the text base address
349214d0a02aSWolfgang Denk		(CONFIG_SYS_TEXT_BASE) used when linking) - same as
34936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FLASH_BASE when booting from flash.
3494c609719bSwdenk
34956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN:
34963b57fe0aSwdenk		Size of memory reserved for monitor code, used to
34973b57fe0aSwdenk		determine _at_compile_time_ (!) if the environment is
34983b57fe0aSwdenk		embedded within the U-Boot image, or in a separate
34993b57fe0aSwdenk		flash sector.
3500c609719bSwdenk
35016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN:
3502c609719bSwdenk		Size of DRAM reserved for malloc() use.
3503c609719bSwdenk
35046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN:
350515940c9aSStefan Roese		Normally compressed uImages are limited to an
350615940c9aSStefan Roese		uncompressed size of 8 MBytes. If this is not enough,
35076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		you can define CONFIG_SYS_BOOTM_LEN in your board config file
350815940c9aSStefan Roese		to adjust this setting to your needs.
3509c609719bSwdenk
35106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ:
3511c609719bSwdenk		Maximum size of memory mapped by the startup code of
3512c609719bSwdenk		the Linux kernel; all data that must be processed by
35137d721e34SBartlomiej Sieka		the Linux kernel (bd_info, boot arguments, FDT blob if
35147d721e34SBartlomiej Sieka		used) must be put below this limit, unless "bootm_low"
35151bce2aebSRobert P. J. Day		environment variable is defined and non-zero. In such case
35167d721e34SBartlomiej Sieka		all data for the Linux kernel must be between "bootm_low"
3517c3624e6eSGrant Likely		and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.	 The environment
3518c3624e6eSGrant Likely		variable "bootm_mapsize" will override the value of
3519c3624e6eSGrant Likely		CONFIG_SYS_BOOTMAPSZ.  If CONFIG_SYS_BOOTMAPSZ is undefined,
3520c3624e6eSGrant Likely		then the value in "bootm_size" will be used instead.
3521c609719bSwdenk
3522fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3523fca43cc8SJohn Rigby		Enable initrd_high functionality.  If defined then the
3524fca43cc8SJohn Rigby		initrd_high feature is enabled and the bootm ramdisk subcommand
3525fca43cc8SJohn Rigby		is enabled.
3526fca43cc8SJohn Rigby
3527fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_CMDLINE:
3528fca43cc8SJohn Rigby		Enables allocating and saving kernel cmdline in space between
3529fca43cc8SJohn Rigby		"bootm_low" and "bootm_low" + BOOTMAPSZ.
3530fca43cc8SJohn Rigby
3531fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_KBD:
3532fca43cc8SJohn Rigby		Enables allocating and saving a kernel copy of the bd_info in
3533fca43cc8SJohn Rigby		space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3534fca43cc8SJohn Rigby
35356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS:
3536c609719bSwdenk		Max number of Flash memory banks
3537c609719bSwdenk
35386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT:
3539c609719bSwdenk		Max number of sectors on a Flash chip
3540c609719bSwdenk
35416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT:
3542c609719bSwdenk		Timeout for Flash erase operations (in ms)
3543c609719bSwdenk
35446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT:
3545c609719bSwdenk		Timeout for Flash write operations (in ms)
3546c609719bSwdenk
35476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT
35488564acf9Swdenk		Timeout for Flash set sector lock bit operation (in ms)
35498564acf9Swdenk
35506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT
35518564acf9Swdenk		Timeout for Flash clear lock bits operation (in ms)
35528564acf9Swdenk
35536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION
35548564acf9Swdenk		If defined, hardware flash sectors protection is used
35558564acf9Swdenk		instead of U-Boot software protection.
35568564acf9Swdenk
35576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP:
3558c609719bSwdenk
3559c609719bSwdenk		Enable TFTP transfers directly to flash memory;
3560c609719bSwdenk		without this option such a download has to be
3561c609719bSwdenk		performed in two steps: (1) download to RAM, and (2)
3562c609719bSwdenk		copy from RAM to flash.
3563c609719bSwdenk
3564c609719bSwdenk		The two-step approach is usually more reliable, since
3565c609719bSwdenk		you can check if the download worked before you erase
356611ccc33fSMarcel Ziswiler		the flash, but in some situations (when system RAM is
356711ccc33fSMarcel Ziswiler		too limited to allow for a temporary copy of the
3568c609719bSwdenk		downloaded image) this option may be very useful.
3569c609719bSwdenk
35706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI:
3571c609719bSwdenk		Define if the flash driver uses extra elements in the
35725653fc33Swdenk		common flash structure for storing flash geometry.
35735653fc33Swdenk
357400b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER
35755653fc33Swdenk		This option also enables the building of the cfi_flash driver
35765653fc33Swdenk		in the drivers directory
357753cf9435Sstroese
357891809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD
357991809ed5SPiotr Ziecik		This option enables the building of the cfi_mtd driver
358091809ed5SPiotr Ziecik		in the drivers directory. The driver exports CFI flash
358191809ed5SPiotr Ziecik		to the MTD layer.
358291809ed5SPiotr Ziecik
35836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
358496ef831fSGuennadi Liakhovetski		Use buffered writes to flash.
358596ef831fSGuennadi Liakhovetski
358696ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N
358796ef831fSGuennadi Liakhovetski		s29ws-n MirrorBit flash has non-standard addresses for buffered
358896ef831fSGuennadi Liakhovetski		write commands.
358996ef831fSGuennadi Liakhovetski
35906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST
35915568e613SStefan Roese		If this option is defined, the common CFI flash doesn't
35925568e613SStefan Roese		print it's warning upon not recognized FLASH banks. This
35935568e613SStefan Roese		is useful, if some of the configured banks are only
35945568e613SStefan Roese		optionally available.
35955568e613SStefan Roese
35969a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS
35979a042e9cSJerry Van Baren		If defined (must be an integer), print out countdown
35989a042e9cSJerry Van Baren		digits and dots.  Recommended value: 45 (9..1) for 80
35999a042e9cSJerry Van Baren		column displays, 15 (3..1) for 40 column displays.
36009a042e9cSJerry Van Baren
3601352ef3f1SStefan Roese- CONFIG_FLASH_VERIFY
3602352ef3f1SStefan Roese		If defined, the content of the flash (destination) is compared
3603352ef3f1SStefan Roese		against the source after the write operation. An error message
3604352ef3f1SStefan Roese		will be printed when the contents are not identical.
3605352ef3f1SStefan Roese		Please note that this option is useless in nearly all cases,
3606352ef3f1SStefan Roese		since such flash programming errors usually are detected earlier
3607352ef3f1SStefan Roese		while unprotecting/erasing/programming. Please only enable
3608352ef3f1SStefan Roese		this option if you really know what you are doing.
3609352ef3f1SStefan Roese
36106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER:
361111ccc33fSMarcel Ziswiler		Defines the number of Ethernet receive buffers. On some
361211ccc33fSMarcel Ziswiler		Ethernet controllers it is recommended to set this value
361353cf9435Sstroese		to 8 or even higher (EEPRO100 or 405 EMAC), since all
361453cf9435Sstroese		buffers can be full shortly after enabling the interface
361511ccc33fSMarcel Ziswiler		on high Ethernet traffic.
361653cf9435Sstroese		Defaults to 4 if not defined.
3617c609719bSwdenk
3618ea882bafSWolfgang Denk- CONFIG_ENV_MAX_ENTRIES
3619ea882bafSWolfgang Denk
3620ea882bafSWolfgang Denk	Maximum number of entries in the hash table that is used
3621ea882bafSWolfgang Denk	internally to store the environment settings. The default
3622ea882bafSWolfgang Denk	setting is supposed to be generous and should work in most
3623ea882bafSWolfgang Denk	cases. This setting can be used to tune behaviour; see
3624ea882bafSWolfgang Denk	lib/hashtable.c for details.
3625ea882bafSWolfgang Denk
36262598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_DEFAULT
36272598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_STATIC
36281bce2aebSRobert P. J. Day	Enable validation of the values given to environment variables when
36292598090bSJoe Hershberger	calling env set.  Variables can be restricted to only decimal,
36302598090bSJoe Hershberger	hexadecimal, or boolean.  If CONFIG_CMD_NET is also defined,
36312598090bSJoe Hershberger	the variables can also be restricted to IP address or MAC address.
36322598090bSJoe Hershberger
36332598090bSJoe Hershberger	The format of the list is:
36342598090bSJoe Hershberger		type_attribute = [s|d|x|b|i|m]
3635267541f7SJoe Hershberger		access_atribute = [a|r|o|c]
3636267541f7SJoe Hershberger		attributes = type_attribute[access_atribute]
36372598090bSJoe Hershberger		entry = variable_name[:attributes]
36382598090bSJoe Hershberger		list = entry[,list]
36392598090bSJoe Hershberger
36402598090bSJoe Hershberger	The type attributes are:
36412598090bSJoe Hershberger		s - String (default)
36422598090bSJoe Hershberger		d - Decimal
36432598090bSJoe Hershberger		x - Hexadecimal
36442598090bSJoe Hershberger		b - Boolean ([1yYtT|0nNfF])
36452598090bSJoe Hershberger		i - IP address
36462598090bSJoe Hershberger		m - MAC address
36472598090bSJoe Hershberger
3648267541f7SJoe Hershberger	The access attributes are:
3649267541f7SJoe Hershberger		a - Any (default)
3650267541f7SJoe Hershberger		r - Read-only
3651267541f7SJoe Hershberger		o - Write-once
3652267541f7SJoe Hershberger		c - Change-default
3653267541f7SJoe Hershberger
36542598090bSJoe Hershberger	- CONFIG_ENV_FLAGS_LIST_DEFAULT
36552598090bSJoe Hershberger		Define this to a list (string) to define the ".flags"
36562598090bSJoe Hershberger		envirnoment variable in the default or embedded environment.
36572598090bSJoe Hershberger
36582598090bSJoe Hershberger	- CONFIG_ENV_FLAGS_LIST_STATIC
36592598090bSJoe Hershberger		Define this to a list (string) to define validation that
36602598090bSJoe Hershberger		should be done if an entry is not found in the ".flags"
36612598090bSJoe Hershberger		environment variable.  To override a setting in the static
36622598090bSJoe Hershberger		list, simply add an entry for the same variable name to the
36632598090bSJoe Hershberger		".flags" variable.
36642598090bSJoe Hershberger
3665267541f7SJoe Hershberger- CONFIG_ENV_ACCESS_IGNORE_FORCE
3666267541f7SJoe Hershberger	If defined, don't allow the -f switch to env set override variable
3667267541f7SJoe Hershberger	access flags.
3668267541f7SJoe Hershberger
36695c1a7ea6SSimon Glass- CONFIG_SYS_GENERIC_BOARD
36705c1a7ea6SSimon Glass	This selects the architecture-generic board system instead of the
36715c1a7ea6SSimon Glass	architecture-specific board files. It is intended to move boards
36725c1a7ea6SSimon Glass	to this new framework over time. Defining this will disable the
36735c1a7ea6SSimon Glass	arch/foo/lib/board.c file and use common/board_f.c and
36745c1a7ea6SSimon Glass	common/board_r.c instead. To use this option your architecture
36755c1a7ea6SSimon Glass	must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in
36765c1a7ea6SSimon Glass	its config.mk file). If you find problems enabling this option on
36775c1a7ea6SSimon Glass	your board please report the problem and send patches!
36785c1a7ea6SSimon Glass
3679632efa74SSimon Glass- CONFIG_SYS_SYM_OFFSETS
3680632efa74SSimon Glass	This is set by architectures that use offsets for link symbols
3681632efa74SSimon Glass	instead of absolute values. So bss_start is obtained using an
3682632efa74SSimon Glass	offset _bss_start_ofs from CONFIG_SYS_TEXT_BASE, rather than
3683632efa74SSimon Glass	directly. You should not need to touch this setting.
3684632efa74SSimon Glass
36850b1b60c7SLokesh Vutla- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
36860b1b60c7SLokesh Vutla	This is set by OMAP boards for the max time that reset should
36870b1b60c7SLokesh Vutla	be asserted. See doc/README.omap-reset-time for details on how
36880b1b60c7SLokesh Vutla	the value can be calulated on a given board.
3689632efa74SSimon Glass
3690c609719bSwdenkThe following definitions that deal with the placement and management
3691c609719bSwdenkof environment data (variable area); in general, we support the
3692c609719bSwdenkfollowing configurations:
3693c609719bSwdenk
3694c3eb3fe4SMike Frysinger- CONFIG_BUILD_ENVCRC:
3695c3eb3fe4SMike Frysinger
3696c3eb3fe4SMike Frysinger	Builds up envcrc with the target environment so that external utils
3697c3eb3fe4SMike Frysinger	may easily extract it and embed it in final U-Boot images.
3698c3eb3fe4SMike Frysinger
36995a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH:
3700c609719bSwdenk
3701c609719bSwdenk	Define this if the environment is in flash memory.
3702c609719bSwdenk
3703c609719bSwdenk	a) The environment occupies one whole flash sector, which is
3704c609719bSwdenk	   "embedded" in the text segment with the U-Boot code. This
3705c609719bSwdenk	   happens usually with "bottom boot sector" or "top boot
3706c609719bSwdenk	   sector" type flash chips, which have several smaller
3707c609719bSwdenk	   sectors at the start or the end. For instance, such a
3708c609719bSwdenk	   layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3709c609719bSwdenk	   such a case you would place the environment in one of the
3710c609719bSwdenk	   4 kB sectors - with U-Boot code before and after it. With
3711c609719bSwdenk	   "top boot sector" type flash chips, you would put the
3712c609719bSwdenk	   environment in one of the last sectors, leaving a gap
3713c609719bSwdenk	   between U-Boot and the environment.
3714c609719bSwdenk
37150e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
3716c609719bSwdenk
3717c609719bSwdenk	   Offset of environment data (variable area) to the
3718c609719bSwdenk	   beginning of flash memory; for instance, with bottom boot
3719c609719bSwdenk	   type flash chips the second sector can be used: the offset
3720c609719bSwdenk	   for this sector is given here.
3721c609719bSwdenk
37226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
3723c609719bSwdenk
37240e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
3725c609719bSwdenk
3726c609719bSwdenk	   This is just another way to specify the start address of
3727c609719bSwdenk	   the flash sector containing the environment (instead of
37280e8d1586SJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET).
3729c609719bSwdenk
37300e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SECT_SIZE:
3731c609719bSwdenk
3732c609719bSwdenk	   Size of the sector containing the environment.
3733c609719bSwdenk
3734c609719bSwdenk
3735c609719bSwdenk	b) Sometimes flash chips have few, equal sized, BIG sectors.
3736c609719bSwdenk	   In such a case you don't want to spend a whole sector for
3737c609719bSwdenk	   the environment.
3738c609719bSwdenk
37390e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3740c609719bSwdenk
37415a1aceb0SJean-Christophe PLAGNIOL-VILLARD	   If you use this in combination with CONFIG_ENV_IS_IN_FLASH
37420e8d1586SJean-Christophe PLAGNIOL-VILLARD	   and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
3743c609719bSwdenk	   of this flash sector for the environment. This saves
3744c609719bSwdenk	   memory for the RAM copy of the environment.
3745c609719bSwdenk
3746c609719bSwdenk	   It may also save flash memory if you decide to use this
3747c609719bSwdenk	   when your environment is "embedded" within U-Boot code,
3748c609719bSwdenk	   since then the remainder of the flash sector could be used
3749c609719bSwdenk	   for U-Boot code. It should be pointed out that this is
3750c609719bSwdenk	   STRONGLY DISCOURAGED from a robustness point of view:
3751c609719bSwdenk	   updating the environment in flash makes it always
3752c609719bSwdenk	   necessary to erase the WHOLE sector. If something goes
3753c609719bSwdenk	   wrong before the contents has been restored from a copy in
3754c609719bSwdenk	   RAM, your target system will be dead.
3755c609719bSwdenk
37560e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR_REDUND
37570e8d1586SJean-Christophe PLAGNIOL-VILLARD	  CONFIG_ENV_SIZE_REDUND
3758c609719bSwdenk
3759c609719bSwdenk	   These settings describe a second storage area used to hold
376011ccc33fSMarcel Ziswiler	   a redundant copy of the environment data, so that there is
37613e38691eSwdenk	   a valid backup copy in case there is a power failure during
3762c609719bSwdenk	   a "saveenv" operation.
3763c609719bSwdenk
3764c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the
3765c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds*
3766c609719bSwdenkaccordingly!
3767c609719bSwdenk
3768c609719bSwdenk
37699314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM:
3770c609719bSwdenk
3771c609719bSwdenk	Define this if you have some non-volatile memory device
3772c609719bSwdenk	(NVRAM, battery buffered SRAM) which you want to use for the
3773c609719bSwdenk	environment.
3774c609719bSwdenk
37750e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
37760e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3777c609719bSwdenk
377811ccc33fSMarcel Ziswiler	  These two #defines are used to determine the memory area you
3779c609719bSwdenk	  want to use for environment. It is assumed that this memory
3780c609719bSwdenk	  can just be read and written to, without any special
3781c609719bSwdenk	  provision.
3782c609719bSwdenk
3783c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early
3784c609719bSwdenkin U-Boot initalization (when we try to get the setting of for the
378511ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or
3786c609719bSwdenkU-Boot will hang.
3787c609719bSwdenk
3788c609719bSwdenkPlease note that even with NVRAM we still use a copy of the
3789c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to
3790c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv"
3791c609719bSwdenkto save the current settings.
3792c609719bSwdenk
3793c609719bSwdenk
3794bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM:
3795c609719bSwdenk
3796c609719bSwdenk	Use this if you have an EEPROM or similar serial access
3797c609719bSwdenk	device and a driver for it.
3798c609719bSwdenk
37990e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
38000e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3801c609719bSwdenk
3802c609719bSwdenk	  These two #defines specify the offset and size of the
3803c609719bSwdenk	  environment area within the total memory of your EEPROM.
3804c609719bSwdenk
38056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR:
3806c609719bSwdenk	  If defined, specified the chip address of the EEPROM device.
3807c609719bSwdenk	  The default address is zero.
3808c609719bSwdenk
38096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
3810c609719bSwdenk	  If defined, the number of bits used to address bytes in a
3811c609719bSwdenk	  single page in the EEPROM device.  A 64 byte page, for example
3812c609719bSwdenk	  would require six bits.
3813c609719bSwdenk
38146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
3815c609719bSwdenk	  If defined, the number of milliseconds to delay between
3816c609719bSwdenk	  page writes.	The default is zero milliseconds.
3817c609719bSwdenk
38186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
3819c609719bSwdenk	  The length in bytes of the EEPROM memory array address.  Note
3820c609719bSwdenk	  that this is NOT the chip address length!
3821c609719bSwdenk
38226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
38235cf91d6bSwdenk	  EEPROM chips that implement "address overflow" are ones
38245cf91d6bSwdenk	  like Catalyst 24WC04/08/16 which has 9/10/11 bits of
38255cf91d6bSwdenk	  address and the extra bits end up in the "chip address" bit
38265cf91d6bSwdenk	  slots. This makes a 24WC08 (1Kbyte) chip look like four 256
38275cf91d6bSwdenk	  byte chips.
38285cf91d6bSwdenk
38295cf91d6bSwdenk	  Note that we consider the length of the address field to
38305cf91d6bSwdenk	  still be one byte because the extra address bits are hidden
38315cf91d6bSwdenk	  in the chip address.
38325cf91d6bSwdenk
38336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_SIZE:
3834c609719bSwdenk	  The size in bytes of the EEPROM device.
3835c609719bSwdenk
3836548738b4SHeiko Schocher	- CONFIG_ENV_EEPROM_IS_ON_I2C
3837548738b4SHeiko Schocher	  define this, if you have I2C and SPI activated, and your
3838548738b4SHeiko Schocher	  EEPROM, which holds the environment, is on the I2C bus.
3839548738b4SHeiko Schocher
3840548738b4SHeiko Schocher	- CONFIG_I2C_ENV_EEPROM_BUS
3841548738b4SHeiko Schocher	  if you have an Environment on an EEPROM reached over
3842548738b4SHeiko Schocher	  I2C muxes, you can define here, how to reach this
3843548738b4SHeiko Schocher	  EEPROM. For example:
3844548738b4SHeiko Schocher
3845ea818dbbSHeiko Schocher	  #define CONFIG_I2C_ENV_EEPROM_BUS	  1
3846548738b4SHeiko Schocher
3847548738b4SHeiko Schocher	  EEPROM which holds the environment, is reached over
3848548738b4SHeiko Schocher	  a pca9547 i2c mux with address 0x70, channel 3.
3849c609719bSwdenk
3850057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH:
38515779d8d9Swdenk
38525779d8d9Swdenk	Define this if you have a DataFlash memory device which you
38535779d8d9Swdenk	want to use for the environment.
38545779d8d9Swdenk
38550e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
38560e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
38570e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
38585779d8d9Swdenk
38595779d8d9Swdenk	  These three #defines specify the offset and size of the
38605779d8d9Swdenk	  environment area within the total memory of your DataFlash placed
38615779d8d9Swdenk	  at the specified address.
38625779d8d9Swdenk
38630a85a9e7SLiu Gang- CONFIG_ENV_IS_IN_REMOTE:
38640a85a9e7SLiu Gang
38650a85a9e7SLiu Gang	Define this if you have a remote memory space which you
38660a85a9e7SLiu Gang	want to use for the local device's environment.
38670a85a9e7SLiu Gang
38680a85a9e7SLiu Gang	- CONFIG_ENV_ADDR:
38690a85a9e7SLiu Gang	- CONFIG_ENV_SIZE:
38700a85a9e7SLiu Gang
38710a85a9e7SLiu Gang	  These two #defines specify the address and size of the
38720a85a9e7SLiu Gang	  environment area within the remote memory space. The
38730a85a9e7SLiu Gang	  local device can get the environment from remote memory
3874fc54c7faSLiu Gang	  space by SRIO or PCIE links.
38750a85a9e7SLiu Gang
38760a85a9e7SLiu GangBE CAREFUL! For some special cases, the local device can not use
38770a85a9e7SLiu Gang"saveenv" command. For example, the local device will get the
3878fc54c7faSLiu Gangenvironment stored in a remote NOR flash by SRIO or PCIE link,
3879fc54c7faSLiu Gangbut it can not erase, write this NOR flash by SRIO or PCIE interface.
38800a85a9e7SLiu Gang
388151bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND:
388213a5695bSwdenk
388313a5695bSwdenk	Define this if you have a NAND device which you want to use
388413a5695bSwdenk	for the environment.
388513a5695bSwdenk
38860e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
38870e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
388813a5695bSwdenk
388913a5695bSwdenk	  These two #defines specify the offset and size of the environment
3890fdd813deSScott Wood	  area within the first NAND device.  CONFIG_ENV_OFFSET must be
3891fdd813deSScott Wood	  aligned to an erase block boundary.
38925779d8d9Swdenk
3893fdd813deSScott Wood	- CONFIG_ENV_OFFSET_REDUND (optional):
3894e443c944SMarkus Klotzbuecher
38950e8d1586SJean-Christophe PLAGNIOL-VILLARD	  This setting describes a second storage area of CONFIG_ENV_SIZE
3896fdd813deSScott Wood	  size used to hold a redundant copy of the environment data, so
3897fdd813deSScott Wood	  that there is a valid backup copy in case there is a power failure
3898fdd813deSScott Wood	  during a "saveenv" operation.	 CONFIG_ENV_OFFSET_RENDUND must be
3899fdd813deSScott Wood	  aligned to an erase block boundary.
3900e443c944SMarkus Klotzbuecher
3901fdd813deSScott Wood	- CONFIG_ENV_RANGE (optional):
3902fdd813deSScott Wood
3903fdd813deSScott Wood	  Specifies the length of the region in which the environment
3904fdd813deSScott Wood	  can be written.  This should be a multiple of the NAND device's
3905fdd813deSScott Wood	  block size.  Specifying a range with more erase blocks than
3906fdd813deSScott Wood	  are needed to hold CONFIG_ENV_SIZE allows bad blocks within
3907fdd813deSScott Wood	  the range to be avoided.
3908fdd813deSScott Wood
3909fdd813deSScott Wood	- CONFIG_ENV_OFFSET_OOB (optional):
3910fdd813deSScott Wood
3911fdd813deSScott Wood	  Enables support for dynamically retrieving the offset of the
3912fdd813deSScott Wood	  environment from block zero's out-of-band data.  The
3913fdd813deSScott Wood	  "nand env.oob" command can be used to record this offset.
3914fdd813deSScott Wood	  Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
3915fdd813deSScott Wood	  using CONFIG_ENV_OFFSET_OOB.
3916e443c944SMarkus Klotzbuecher
3917b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST
3918b74ab737SGuennadi Liakhovetski
3919b74ab737SGuennadi Liakhovetski	Defines address in RAM to which the nand_spl code should copy the
3920b74ab737SGuennadi Liakhovetski	environment. If redundant environment is used, it will be copied to
3921b74ab737SGuennadi Liakhovetski	CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3922b74ab737SGuennadi Liakhovetski
39232b74433fSJoe Hershberger- CONFIG_ENV_IS_IN_UBI:
39242b74433fSJoe Hershberger
39252b74433fSJoe Hershberger	Define this if you have an UBI volume that you want to use for the
39262b74433fSJoe Hershberger	environment.  This has the benefit of wear-leveling the environment
39272b74433fSJoe Hershberger	accesses, which is important on NAND.
39282b74433fSJoe Hershberger
39292b74433fSJoe Hershberger	- CONFIG_ENV_UBI_PART:
39302b74433fSJoe Hershberger
39312b74433fSJoe Hershberger	  Define this to a string that is the mtd partition containing the UBI.
39322b74433fSJoe Hershberger
39332b74433fSJoe Hershberger	- CONFIG_ENV_UBI_VOLUME:
39342b74433fSJoe Hershberger
39352b74433fSJoe Hershberger	  Define this to the name of the volume that you want to store the
39362b74433fSJoe Hershberger	  environment in.
39372b74433fSJoe Hershberger
3938785881f7SJoe Hershberger	- CONFIG_ENV_UBI_VOLUME_REDUND:
3939785881f7SJoe Hershberger
3940785881f7SJoe Hershberger	  Define this to the name of another volume to store a second copy of
3941785881f7SJoe Hershberger	  the environment in.  This will enable redundant environments in UBI.
3942785881f7SJoe Hershberger	  It is assumed that both volumes are in the same MTD partition.
3943785881f7SJoe Hershberger
39442b74433fSJoe Hershberger	- CONFIG_UBI_SILENCE_MSG
39452b74433fSJoe Hershberger	- CONFIG_UBIFS_SILENCE_MSG
39462b74433fSJoe Hershberger
39472b74433fSJoe Hershberger	  You will probably want to define these to avoid a really noisy system
39482b74433fSJoe Hershberger	  when storing the env in UBI.
39492b74433fSJoe Hershberger
395006e4ae5fSStephen Warren- CONFIG_ENV_IS_IN_MMC:
395106e4ae5fSStephen Warren
395206e4ae5fSStephen Warren	Define this if you have an MMC device which you want to use for the
395306e4ae5fSStephen Warren	environment.
395406e4ae5fSStephen Warren
395506e4ae5fSStephen Warren	- CONFIG_SYS_MMC_ENV_DEV:
395606e4ae5fSStephen Warren
395706e4ae5fSStephen Warren	  Specifies which MMC device the environment is stored in.
395806e4ae5fSStephen Warren
395906e4ae5fSStephen Warren	- CONFIG_SYS_MMC_ENV_PART (optional):
396006e4ae5fSStephen Warren
396106e4ae5fSStephen Warren	  Specifies which MMC partition the environment is stored in. If not
396206e4ae5fSStephen Warren	  set, defaults to partition 0, the user area. Common values might be
396306e4ae5fSStephen Warren	  1 (first MMC boot partition), 2 (second MMC boot partition).
396406e4ae5fSStephen Warren
396506e4ae5fSStephen Warren	- CONFIG_ENV_OFFSET:
396606e4ae5fSStephen Warren	- CONFIG_ENV_SIZE:
396706e4ae5fSStephen Warren
396806e4ae5fSStephen Warren	  These two #defines specify the offset and size of the environment
396906e4ae5fSStephen Warren	  area within the specified MMC device.
397006e4ae5fSStephen Warren
39715c088ee8SStephen Warren	  If offset is positive (the usual case), it is treated as relative to
39725c088ee8SStephen Warren	  the start of the MMC partition. If offset is negative, it is treated
39735c088ee8SStephen Warren	  as relative to the end of the MMC partition. This can be useful if
39745c088ee8SStephen Warren	  your board may be fitted with different MMC devices, which have
39755c088ee8SStephen Warren	  different sizes for the MMC partitions, and you always want the
39765c088ee8SStephen Warren	  environment placed at the very end of the partition, to leave the
39775c088ee8SStephen Warren	  maximum possible space before it, to store other data.
39785c088ee8SStephen Warren
397906e4ae5fSStephen Warren	  These two values are in units of bytes, but must be aligned to an
398006e4ae5fSStephen Warren	  MMC sector boundary.
398106e4ae5fSStephen Warren
398206e4ae5fSStephen Warren	- CONFIG_ENV_OFFSET_REDUND (optional):
398306e4ae5fSStephen Warren
398406e4ae5fSStephen Warren	  Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
398506e4ae5fSStephen Warren	  hold a redundant copy of the environment data. This provides a
398606e4ae5fSStephen Warren	  valid backup copy in case the other copy is corrupted, e.g. due
398706e4ae5fSStephen Warren	  to a power failure during a "saveenv" operation.
398806e4ae5fSStephen Warren
39895c088ee8SStephen Warren	  This value may also be positive or negative; this is handled in the
39905c088ee8SStephen Warren	  same way as CONFIG_ENV_OFFSET.
39915c088ee8SStephen Warren
399206e4ae5fSStephen Warren	  This value is also in units of bytes, but must also be aligned to
399306e4ae5fSStephen Warren	  an MMC sector boundary.
399406e4ae5fSStephen Warren
399506e4ae5fSStephen Warren	- CONFIG_ENV_SIZE_REDUND (optional):
399606e4ae5fSStephen Warren
399706e4ae5fSStephen Warren	  This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
399806e4ae5fSStephen Warren	  set. If this value is set, it must be set to the same value as
399906e4ae5fSStephen Warren	  CONFIG_ENV_SIZE.
400006e4ae5fSStephen Warren
40016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET
4002c609719bSwdenk
4003c609719bSwdenk	Defines offset to the initial SPI buffer area in DPRAM. The
4004c609719bSwdenk	area is used at an early stage (ROM part) if the environment
4005c609719bSwdenk	is configured to reside in the SPI EEPROM: We need a 520 byte
4006c609719bSwdenk	scratch DPRAM area. It is used between the two initialization
4007c609719bSwdenk	calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4008c609719bSwdenk	to be a good choice since it makes it far enough from the
4009c609719bSwdenk	start of the data area as well as from the stack pointer.
4010c609719bSwdenk
4011e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor
4012c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been
4013cdb74977SWolfgang Denkcreated; also, when using EEPROM you will have to use getenv_f()
4014c609719bSwdenkuntil then to read environment variables.
4015c609719bSwdenk
401685ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor
401785ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working
401885ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is
401985ec0bccSwdenknecessary, because the first environment variable we need is the
402085ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't
402185ec0bccSwdenkhave any device yet where we could complain.]
4022c609719bSwdenk
4023c609719bSwdenkNote: once the monitor has been relocated, then it will complain if
4024c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you
402585ec0bccSwdenkuse the "saveenv" command to store a valid environment.
4026c609719bSwdenk
40276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
4028fc3e2165Swdenk		Echo the inverted Ethernet link state to the fault LED.
4029fc3e2165Swdenk
40306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
4031fc3e2165Swdenk		      also needs to be defined.
4032fc3e2165Swdenk
40336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR:
4034fc3e2165Swdenk		MII address of the PHY to check for the Ethernet link state.
4035c609719bSwdenk
4036f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS:
4037f5675aa5SRon Madrid		Define this if you desire to only have use of the NS16550_init
4038f5675aa5SRon Madrid		and NS16550_putc functions for the serial driver located at
4039f5675aa5SRon Madrid		drivers/serial/ns16550.c.  This option is useful for saving
4040f5675aa5SRon Madrid		space for already greatly restricted images, including but not
4041f5675aa5SRon Madrid		limited to NAND_SPL configurations.
4042f5675aa5SRon Madrid
4043b2b92f53SSimon Glass- CONFIG_DISPLAY_BOARDINFO
4044b2b92f53SSimon Glass		Display information about the board that U-Boot is running on
4045b2b92f53SSimon Glass		when U-Boot starts up. The board function checkboard() is called
4046b2b92f53SSimon Glass		to do this.
4047b2b92f53SSimon Glass
4048e2e3e2b1SSimon Glass- CONFIG_DISPLAY_BOARDINFO_LATE
4049e2e3e2b1SSimon Glass		Similar to the previous option, but display this information
4050e2e3e2b1SSimon Glass		later, once stdio is running and output goes to the LCD, if
4051e2e3e2b1SSimon Glass		present.
4052e2e3e2b1SSimon Glass
4053c609719bSwdenkLow Level (hardware related) configuration options:
4054dc7c9a1aSwdenk---------------------------------------------------
4055c609719bSwdenk
40566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE:
4057c609719bSwdenk		Cache Line Size of the CPU.
4058c609719bSwdenk
40596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR:
4060c609719bSwdenk		Default address of the IMMR after system reset.
40612535d602Swdenk
40622535d602Swdenk		Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
40632535d602Swdenk		and RPXsuper) to be able to adjust the position of
40642535d602Swdenk		the IMMR register after a reset.
4065c609719bSwdenk
4066e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_DEFAULT:
4067e46fedfeSTimur Tabi		Default (power-on reset) physical address of CCSR on Freescale
4068e46fedfeSTimur Tabi		PowerPC SOCs.
4069e46fedfeSTimur Tabi
4070e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR:
4071e46fedfeSTimur Tabi		Virtual address of CCSR.  On a 32-bit build, this is typically
4072e46fedfeSTimur Tabi		the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4073e46fedfeSTimur Tabi
4074e46fedfeSTimur Tabi		CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4075e46fedfeSTimur Tabi		for cross-platform code that uses that macro instead.
4076e46fedfeSTimur Tabi
4077e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS:
4078e46fedfeSTimur Tabi		Physical address of CCSR.  CCSR can be relocated to a new
4079e46fedfeSTimur Tabi		physical address, if desired.  In this case, this macro should
4080e46fedfeSTimur Tabi		be set to that address.	 Otherwise, it should be set to the
4081e46fedfeSTimur Tabi		same value as CONFIG_SYS_CCSRBAR_DEFAULT.  For example, CCSR
4082e46fedfeSTimur Tabi		is typically relocated on 36-bit builds.  It is recommended
4083e46fedfeSTimur Tabi		that this macro be defined via the _HIGH and _LOW macros:
4084e46fedfeSTimur Tabi
4085e46fedfeSTimur Tabi		#define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4086e46fedfeSTimur Tabi			* 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4087e46fedfeSTimur Tabi
4088e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
4089e46fedfeSTimur Tabi		Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS.	This value is typically
4090e46fedfeSTimur Tabi		either 0 (32-bit build) or 0xF (36-bit build).	This macro is
4091e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
4092e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
4093e46fedfeSTimur Tabi
4094e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4095e46fedfeSTimur Tabi		Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS.  This macro is
4096e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
4097e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
4098e46fedfeSTimur Tabi
4099e46fedfeSTimur Tabi- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4100e46fedfeSTimur Tabi		If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4101e46fedfeSTimur Tabi		forced to a value that ensures that CCSR is not relocated.
4102e46fedfeSTimur Tabi
41037f6c2cbcSwdenk- Floppy Disk Support:
41046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER
41057f6c2cbcSwdenk
41067f6c2cbcSwdenk		the default drive number (default value 0)
41077f6c2cbcSwdenk
41086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_STRIDE
41097f6c2cbcSwdenk
411011ccc33fSMarcel Ziswiler		defines the spacing between FDC chipset registers
41117f6c2cbcSwdenk		(default value 1)
41127f6c2cbcSwdenk
41136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_OFFSET
41147f6c2cbcSwdenk
41157f6c2cbcSwdenk		defines the offset of register from address. It
41167f6c2cbcSwdenk		depends on which part of the data bus is connected to
411711ccc33fSMarcel Ziswiler		the FDC chipset. (default value 0)
41187f6c2cbcSwdenk
41196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
41206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
41217f6c2cbcSwdenk		default value.
41227f6c2cbcSwdenk
41236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		if CONFIG_SYS_FDC_HW_INIT is defined, then the function
41247f6c2cbcSwdenk		fdc_hw_init() is called at the beginning of the FDC
41257f6c2cbcSwdenk		setup. fdc_hw_init() must be provided by the board
41267f6c2cbcSwdenk		source code. It is used to make hardware dependant
41277f6c2cbcSwdenk		initializations.
41287f6c2cbcSwdenk
41290abddf82SMacpaul Lin- CONFIG_IDE_AHB:
41300abddf82SMacpaul Lin		Most IDE controllers were designed to be connected with PCI
41310abddf82SMacpaul Lin		interface. Only few of them were designed for AHB interface.
41320abddf82SMacpaul Lin		When software is doing ATA command and data transfer to
41330abddf82SMacpaul Lin		IDE devices through IDE-AHB controller, some additional
41340abddf82SMacpaul Lin		registers accessing to these kind of IDE-AHB controller
41350abddf82SMacpaul Lin		is requierd.
41360abddf82SMacpaul Lin
41376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR:	Physical address of the Internal Memory.
413825d6712aSwdenk		DO NOT CHANGE unless you know exactly what you're
413925d6712aSwdenk		doing! (11-4) [MPC8xx/82xx systems only]
4140c609719bSwdenk
41416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR:
4142c609719bSwdenk
41437152b1d0Swdenk		Start address of memory area that can be used for
4144c609719bSwdenk		initial data and stack; please note that this must be
4145c609719bSwdenk		writable memory that is working WITHOUT special
4146c609719bSwdenk		initialization, i. e. you CANNOT use normal RAM which
4147c609719bSwdenk		will become available only after programming the
4148c609719bSwdenk		memory controller and running certain initialization
4149c609719bSwdenk		sequences.
4150c609719bSwdenk
4151c609719bSwdenk		U-Boot uses the following memory types:
4152c609719bSwdenk		- MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4153c609719bSwdenk		- MPC824X: data cache
4154c609719bSwdenk		- PPC4xx:  data cache
4155c609719bSwdenk
41566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET:
4157c609719bSwdenk
4158c609719bSwdenk		Offset of the initial data structure in the memory
41596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
41606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
4161c609719bSwdenk		data is located at the end of the available space
4162553f0982SWolfgang Denk		(sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
41636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
41646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
41656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET) downward.
4166c609719bSwdenk
4167c609719bSwdenk	Note:
4168c609719bSwdenk		On the MPC824X (or other systems that use the data
4169c609719bSwdenk		cache for initial memory) the address chosen for
41706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
4171c609719bSwdenk		point to an otherwise UNUSED address space between
4172c609719bSwdenk		the top of RAM and the start of the PCI space.
4173c609719bSwdenk
41746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR:	SIU Module Configuration (11-6)
4175c609719bSwdenk
41766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR:	System Protection Control (11-9)
4177c609719bSwdenk
41786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR:	Time Base Status and Control (11-26)
4179c609719bSwdenk
41806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR:	Periodic Interrupt Status and Control (11-31)
4181c609719bSwdenk
41826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR:	PLL, Low-Power, and Reset Control Register (15-30)
4183c609719bSwdenk
41846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR:	System Clock and reset Control Register (15-27)
4185c609719bSwdenk
41866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM:
4187c609719bSwdenk		SDRAM timing
4188c609719bSwdenk
41896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA:
4190c609719bSwdenk		periodic timer for refresh
4191c609719bSwdenk
41926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER:	Debug Event Register (37-47)
4193c609719bSwdenk
41946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
41956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
41966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
41976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_BR1_PRELIM:
4198c609719bSwdenk		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4199c609719bSwdenk
4200c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
42016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
42026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
4203c609719bSwdenk		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4204c609719bSwdenk
42056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
42066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
4207c609719bSwdenk		Machine Mode Register and Memory Periodic Timer
4208c609719bSwdenk		Prescaler definitions (SDRAM timing)
4209c609719bSwdenk
42106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
4211c609719bSwdenk		enable I2C microcode relocation patch (MPC8xx);
4212c609719bSwdenk		define relocation offset in DPRAM [DSP2]
4213c609719bSwdenk
42146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
4215b423d055SHeiko Schocher		enable SMC microcode relocation patch (MPC8xx);
4216b423d055SHeiko Schocher		define relocation offset in DPRAM [SMC1]
4217b423d055SHeiko Schocher
42186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
4219c609719bSwdenk		enable SPI microcode relocation patch (MPC8xx);
4220c609719bSwdenk		define relocation offset in DPRAM [SCC4]
4221c609719bSwdenk
42226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_USE_OSCCLK:
4223c609719bSwdenk		Use OSCM clock mode on MBX8xx board. Be careful,
4224c609719bSwdenk		wrong setting might damage your board. Read
4225c609719bSwdenk		doc/README.MBX before setting this variable!
4226c609719bSwdenk
42276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
4228ea909b76Swdenk		Offset of the bootmode word in DPRAM used by post
4229ea909b76Swdenk		(Power On Self Tests). This definition overrides
4230ea909b76Swdenk		#define'd default value in commproc.h resp.
4231ea909b76Swdenk		cpm_8260.h.
4232ea909b76Swdenk
42336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
42346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
42356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
42366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
42376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
42386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
42396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
42406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
4241a47a12beSStefan Roese		Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
42425d232d0eSwdenk
42439cacf4fcSDirk Eibach- CONFIG_PCI_DISABLE_PCIE:
42449cacf4fcSDirk Eibach		Disable PCI-Express on systems where it is supported but not
42459cacf4fcSDirk Eibach		required.
42469cacf4fcSDirk Eibach
424769fd2d3bSAndrew Sharp- CONFIG_PCI_ENUM_ONLY
424869fd2d3bSAndrew Sharp		Only scan through and get the devices on the busses.
424969fd2d3bSAndrew Sharp		Don't do any setup work, presumably because someone or
425069fd2d3bSAndrew Sharp		something has already done it, and we don't need to do it
425169fd2d3bSAndrew Sharp		a second time.	Useful for platforms that are pre-booted
425269fd2d3bSAndrew Sharp		by coreboot or similar.
425369fd2d3bSAndrew Sharp
4254842033e6SGabor Juhos- CONFIG_PCI_INDIRECT_BRIDGE:
4255842033e6SGabor Juhos		Enable support for indirect PCI bridges.
4256842033e6SGabor Juhos
4257a09b9b68SKumar Gala- CONFIG_SYS_SRIO:
4258a09b9b68SKumar Gala		Chip has SRIO or not
4259a09b9b68SKumar Gala
4260a09b9b68SKumar Gala- CONFIG_SRIO1:
4261a09b9b68SKumar Gala		Board has SRIO 1 port available
4262a09b9b68SKumar Gala
4263a09b9b68SKumar Gala- CONFIG_SRIO2:
4264a09b9b68SKumar Gala		Board has SRIO 2 port available
4265a09b9b68SKumar Gala
4266c8b28152SLiu Gang- CONFIG_SRIO_PCIE_BOOT_MASTER
4267c8b28152SLiu Gang		Board can support master function for Boot from SRIO and PCIE
4268c8b28152SLiu Gang
4269a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_VIRT:
4270a09b9b68SKumar Gala		Virtual Address of SRIO port 'n' memory region
4271a09b9b68SKumar Gala
4272a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_PHYS:
4273a09b9b68SKumar Gala		Physical Address of SRIO port 'n' memory region
4274a09b9b68SKumar Gala
4275a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_SIZE:
4276a09b9b68SKumar Gala		Size of SRIO port 'n' memory region
4277a09b9b68SKumar Gala
427866bd1846SFabio Estevam- CONFIG_SYS_NAND_BUSWIDTH_16BIT
427966bd1846SFabio Estevam		Defined to tell the NAND controller that the NAND chip is using
428066bd1846SFabio Estevam		a 16 bit bus.
428166bd1846SFabio Estevam		Not all NAND drivers use this symbol.
4282a430e916SFabio Estevam		Example of drivers that use it:
428366bd1846SFabio Estevam		- drivers/mtd/nand/ndfc.c
4284a430e916SFabio Estevam		- drivers/mtd/nand/mxc_nand.c
4285eced4626SAlex Waterman
4286eced4626SAlex Waterman- CONFIG_SYS_NDFC_EBC0_CFG
4287eced4626SAlex Waterman		Sets the EBC0_CFG register for the NDFC. If not defined
4288eced4626SAlex Waterman		a default value will be used.
4289eced4626SAlex Waterman
4290bb99ad6dSBen Warren- CONFIG_SPD_EEPROM
4291218ca724SWolfgang Denk		Get DDR timing information from an I2C EEPROM. Common
4292218ca724SWolfgang Denk		with pluggable memory modules such as SODIMMs
4293218ca724SWolfgang Denk
4294bb99ad6dSBen Warren  SPD_EEPROM_ADDRESS
4295bb99ad6dSBen Warren		I2C address of the SPD EEPROM
4296bb99ad6dSBen Warren
42976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM
4298218ca724SWolfgang Denk		If SPD EEPROM is on an I2C bus other than the first
4299218ca724SWolfgang Denk		one, specify here. Note that the value must resolve
4300218ca724SWolfgang Denk		to something your driver can deal with.
4301bb99ad6dSBen Warren
43021b3e3c4fSYork Sun- CONFIG_SYS_DDR_RAW_TIMING
43031b3e3c4fSYork Sun		Get DDR timing information from other than SPD. Common with
43041b3e3c4fSYork Sun		soldered DDR chips onboard without SPD. DDR raw timing
43051b3e3c4fSYork Sun		parameters are extracted from datasheet and hard-coded into
43061b3e3c4fSYork Sun		header files or board specific files.
43071b3e3c4fSYork Sun
43086f5e1dc5SYork Sun- CONFIG_FSL_DDR_INTERACTIVE
43096f5e1dc5SYork Sun		Enable interactive DDR debugging. See doc/README.fsl-ddr.
43106f5e1dc5SYork Sun
43116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0
4312218ca724SWolfgang Denk		Only for 83xx systems. If specified, then DDR should
4313218ca724SWolfgang Denk		be configured using CS0 and CS1 instead of CS2 and CS3.
43142ad6b513STimur Tabi
4315c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12]
4316c26e454dSwdenk		Define to enable FEC[12] on a 8xx series processor.
4317c26e454dSwdenk
4318c26e454dSwdenk- CONFIG_FEC[12]_PHY
4319c26e454dSwdenk		Define to the hardcoded PHY address which corresponds
43206e592385Swdenk		to the given FEC; i. e.
4321c26e454dSwdenk			#define CONFIG_FEC1_PHY 4
4322c26e454dSwdenk		means that the PHY with address 4 is connected to FEC1
4323c26e454dSwdenk
4324c26e454dSwdenk		When set to -1, means to probe for first available.
4325c26e454dSwdenk
4326c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR
4327c26e454dSwdenk		The PHY does not have a RXERR line (RMII only).
4328c26e454dSwdenk		(so program the FEC to ignore it).
4329c26e454dSwdenk
4330c26e454dSwdenk- CONFIG_RMII
4331c26e454dSwdenk		Enable RMII mode for all FECs.
4332c26e454dSwdenk		Note that this is a global option, we can't
4333c26e454dSwdenk		have one FEC in standard MII mode and another in RMII mode.
4334c26e454dSwdenk
43355cf91d6bSwdenk- CONFIG_CRC32_VERIFY
43365cf91d6bSwdenk		Add a verify option to the crc32 command.
43375cf91d6bSwdenk		The syntax is:
43385cf91d6bSwdenk
43395cf91d6bSwdenk		=> crc32 -v <address> <count> <crc32>
43405cf91d6bSwdenk
43415cf91d6bSwdenk		Where address/count indicate a memory area
43425cf91d6bSwdenk		and crc32 is the correct crc32 which the
43435cf91d6bSwdenk		area should have.
43445cf91d6bSwdenk
434556523f12Swdenk- CONFIG_LOOPW
434656523f12Swdenk		Add the "loopw" memory command. This only takes effect if
4347602ad3b3SJon Loeliger		the memory commands are activated globally (CONFIG_CMD_MEM).
434856523f12Swdenk
43497b466641Sstroese- CONFIG_MX_CYCLIC
43507b466641Sstroese		Add the "mdc" and "mwc" memory commands. These are cyclic
43517b466641Sstroese		"md/mw" commands.
43527b466641Sstroese		Examples:
43537b466641Sstroese
43547b466641Sstroese		=> mdc.b 10 4 500
43557b466641Sstroese		This command will print 4 bytes (10,11,12,13) each 500 ms.
43567b466641Sstroese
43577b466641Sstroese		=> mwc.l 100 12345678 10
43587b466641Sstroese		This command will write 12345678 to address 100 all 10 ms.
43597b466641Sstroese
43607b466641Sstroese		This only takes effect if the memory commands are activated
4361602ad3b3SJon Loeliger		globally (CONFIG_CMD_MEM).
43627b466641Sstroese
43638aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT
4364afc1ce82SMacpaul Lin		[ARM, NDS32, MIPS only] If this variable is defined, then certain
4365e03f3169SWolfgang Denk		low level initializations (like setting up the memory
4366e03f3169SWolfgang Denk		controller) are omitted and/or U-Boot does not
4367e03f3169SWolfgang Denk		relocate itself into RAM.
43688aa1a2d1Swdenk
4369e03f3169SWolfgang Denk		Normally this variable MUST NOT be defined. The only
4370e03f3169SWolfgang Denk		exception is when U-Boot is loaded (to RAM) by some
4371e03f3169SWolfgang Denk		other boot loader or by a debugger which performs
4372e03f3169SWolfgang Denk		these initializations itself.
43738aa1a2d1Swdenk
4374401bb30bSAneesh V- CONFIG_SPL_BUILD
4375df81238bSMagnus Lilja		Modifies the behaviour of start.S when compiling a loader
4376df81238bSMagnus Lilja		that is executed before the actual U-Boot. E.g. when
4377df81238bSMagnus Lilja		compiling a NAND SPL.
4378400558b5Swdenk
43793aa29de0SYing Zhang- CONFIG_TPL_BUILD
43803aa29de0SYing Zhang		Modifies the behaviour of start.S  when compiling a loader
43813aa29de0SYing Zhang		that is executed after the SPL and before the actual U-Boot.
43823aa29de0SYing Zhang		It is loaded by the SPL.
43833aa29de0SYing Zhang
43845df572f0SYing Zhang- CONFIG_SYS_MPC85XX_NO_RESETVEC
43855df572f0SYing Zhang		Only for 85xx systems. If this variable is specified, the section
43865df572f0SYing Zhang		.resetvec is not kept and the section .bootpg is placed in the
43875df572f0SYing Zhang		previous 4k of the .text section.
43885df572f0SYing Zhang
43894213fc29SSimon Glass- CONFIG_ARCH_MAP_SYSMEM
43904213fc29SSimon Glass		Generally U-Boot (and in particular the md command) uses
43914213fc29SSimon Glass		effective address. It is therefore not necessary to regard
43924213fc29SSimon Glass		U-Boot address as virtual addresses that need to be translated
43934213fc29SSimon Glass		to physical addresses. However, sandbox requires this, since
43944213fc29SSimon Glass		it maintains its own little RAM buffer which contains all
43954213fc29SSimon Glass		addressable memory. This option causes some memory accesses
43964213fc29SSimon Glass		to be mapped through map_sysmem() / unmap_sysmem().
43974213fc29SSimon Glass
4398d8834a13SMatthias Weisser- CONFIG_USE_ARCH_MEMCPY
4399d8834a13SMatthias Weisser  CONFIG_USE_ARCH_MEMSET
4400d8834a13SMatthias Weisser		If these options are used a optimized version of memcpy/memset will
4401d8834a13SMatthias Weisser		be used if available. These functions may be faster under some
4402d8834a13SMatthias Weisser		conditions but may increase the binary size.
4403d8834a13SMatthias Weisser
4404588a13f7SSimon Glass- CONFIG_X86_RESET_VECTOR
4405588a13f7SSimon Glass		If defined, the x86 reset vector code is included. This is not
4406588a13f7SSimon Glass		needed when U-Boot is running from Coreboot.
4407b16f521aSGabe Black
4408fc33705eSMark Jackson- CONFIG_SYS_MPUCLK
4409fc33705eSMark Jackson		Defines the MPU clock speed (in MHz).
4410fc33705eSMark Jackson
4411fc33705eSMark Jackson		NOTE : currently only supported on AM335x platforms.
44125b5ece9eSGabe Black
441316678eb4SHeiko Schocher- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
441416678eb4SHeiko Schocher		Enables the RTC32K OSC on AM33xx based plattforms
441516678eb4SHeiko Schocher
4416f2717b47STimur TabiFreescale QE/FMAN Firmware Support:
4417f2717b47STimur Tabi-----------------------------------
4418f2717b47STimur Tabi
4419f2717b47STimur TabiThe Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4420f2717b47STimur Tabiloading of "firmware", which is encoded in the QE firmware binary format.
4421f2717b47STimur TabiThis firmware often needs to be loaded during U-Boot booting, so macros
4422f2717b47STimur Tabiare used to identify the storage device (NOR flash, SPI, etc) and the address
4423f2717b47STimur Tabiwithin that device.
4424f2717b47STimur Tabi
4425f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_ADDR
4426f2717b47STimur Tabi	The address in the storage device where the firmware is located.  The
4427f2717b47STimur Tabi	meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4428f2717b47STimur Tabi	is also specified.
4429f2717b47STimur Tabi
4430f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_LENGTH
4431f2717b47STimur Tabi	The maximum possible size of the firmware.  The firmware binary format
4432f2717b47STimur Tabi	has a field that specifies the actual size of the firmware, but it
4433f2717b47STimur Tabi	might not be possible to read any part of the firmware unless some
4434f2717b47STimur Tabi	local storage is allocated to hold the entire firmware first.
4435f2717b47STimur Tabi
4436f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4437f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4438f2717b47STimur Tabi	normal addressable memory via the LBC.  CONFIG_SYS_FMAN_FW_ADDR is the
4439f2717b47STimur Tabi	virtual address in NOR flash.
4440f2717b47STimur Tabi
4441f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4442f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NAND flash.
4443f2717b47STimur Tabi	CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4444f2717b47STimur Tabi
4445f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4446f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SD/MMC
4447f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4448f2717b47STimur Tabi
4449f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
4450f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SPI
4451f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4452f2717b47STimur Tabi
4453292dc6c5SLiu Gang- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4454292dc6c5SLiu Gang	Specifies that QE/FMAN firmware is located in the remote (master)
4455292dc6c5SLiu Gang	memory space.	CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
4456fc54c7faSLiu Gang	can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4457fc54c7faSLiu Gang	window->master inbound window->master LAW->the ucode address in
4458fc54c7faSLiu Gang	master's memory space.
4459f2717b47STimur Tabi
4460c609719bSwdenkBuilding the Software:
4461c609719bSwdenk======================
4462c609719bSwdenk
4463218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments
4464218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support
4465218ca724SWolfgang Denkall possibly existing versions of cross development tools in all
4466218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we
4467218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4468218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot.
4469c609719bSwdenk
4470218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you
4471218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case,
4472218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell.
4473218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are
4474218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter:
4475c609719bSwdenk
4476218ca724SWolfgang Denk	$ CROSS_COMPILE=ppc_4xx-
4477218ca724SWolfgang Denk	$ export CROSS_COMPILE
4478c609719bSwdenk
44792f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in
44802f8d396bSPeter Tyser      the tools directory you can use the MinGW toolchain
44812f8d396bSPeter Tyser      (http://www.mingw.org).  Set your HOST tools to the MinGW
44822f8d396bSPeter Tyser      toolchain and execute 'make tools'.  For example:
44832f8d396bSPeter Tyser
44842f8d396bSPeter Tyser       $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
44852f8d396bSPeter Tyser
44862f8d396bSPeter Tyser      Binaries such as tools/mkimage.exe will be created which can
44872f8d396bSPeter Tyser      be executed on computers running Windows.
44882f8d396bSPeter Tyser
4489c609719bSwdenkU-Boot is intended to be simple to build. After installing the
4490c609719bSwdenksources you must configure U-Boot for one specific board type. This
4491c609719bSwdenkis done by typing:
4492c609719bSwdenk
4493c609719bSwdenk	make NAME_config
4494c609719bSwdenk
4495218ca724SWolfgang Denkwhere "NAME_config" is the name of one of the existing configu-
44964d675ae6SMichael Jonesrations; see boards.cfg for supported names.
449754387ac9Swdenk
4498c609719bSwdenkNote: for some board special configuration names may exist; check if
4499c609719bSwdenk      additional information is available from the board vendor; for
45002729af9dSwdenk      instance, the TQM823L systems are available without (standard)
45012729af9dSwdenk      or with LCD support. You can select such additional "features"
450211ccc33fSMarcel Ziswiler      when choosing the configuration, i. e.
4503c609719bSwdenk
45042729af9dSwdenk      make TQM823L_config
45052729af9dSwdenk	- will configure for a plain TQM823L, i. e. no LCD support
4506c609719bSwdenk
4507c609719bSwdenk      make TQM823L_LCD_config
4508c609719bSwdenk	- will configure for a TQM823L with U-Boot console on LCD
4509c609719bSwdenk
4510c609719bSwdenk      etc.
4511c609719bSwdenk
4512c609719bSwdenk
4513c609719bSwdenkFinally, type "make all", and you should get some working U-Boot
45147152b1d0Swdenkimages ready for download to / installation on your system:
4515c609719bSwdenk
4516c609719bSwdenk- "u-boot.bin" is a raw binary image
4517c609719bSwdenk- "u-boot" is an image in ELF binary format
4518c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format
4519c609719bSwdenk
4520baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved
4521baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change
4522baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory:
4523baf31249SMarian Balakowicz
4524baf31249SMarian Balakowicz1. Add O= to the make command line invocations:
4525baf31249SMarian Balakowicz
4526baf31249SMarian Balakowicz	make O=/tmp/build distclean
4527baf31249SMarian Balakowicz	make O=/tmp/build NAME_config
4528baf31249SMarian Balakowicz	make O=/tmp/build all
4529baf31249SMarian Balakowicz
4530baf31249SMarian Balakowicz2. Set environment variable BUILD_DIR to point to the desired location:
4531baf31249SMarian Balakowicz
4532baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
4533baf31249SMarian Balakowicz	make distclean
4534baf31249SMarian Balakowicz	make NAME_config
4535baf31249SMarian Balakowicz	make all
4536baf31249SMarian Balakowicz
4537baf31249SMarian BalakowiczNote that the command line "O=" setting overrides the BUILD_DIR environment
4538baf31249SMarian Balakowiczvariable.
4539baf31249SMarian Balakowicz
4540c609719bSwdenk
4541c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so
4542c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of
4543c609719bSwdenknative "make".
4544c609719bSwdenk
4545c609719bSwdenk
4546c609719bSwdenkIf the system board that you have is not listed, then you will need
4547c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these
4548c609719bSwdenksteps:
4549c609719bSwdenk
4550c609719bSwdenk1.  Add a new configuration option for your board to the toplevel
45514d675ae6SMichael Jones    "boards.cfg" file, using the existing entries as examples.
45524d675ae6SMichael Jones    Follow the instructions there to keep the boards in order.
4553c609719bSwdenk2.  Create a new directory to hold your board specific code. Add any
455485ec0bccSwdenk    files you need. In your board directory, you will need at least
455585ec0bccSwdenk    the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
455685ec0bccSwdenk3.  Create a new configuration file "include/configs/<board>.h" for
455785ec0bccSwdenk    your board
4558c609719bSwdenk3.  If you're porting U-Boot to a new CPU, then also create a new
4559c609719bSwdenk    directory to hold your CPU specific code. Add any files you need.
456085ec0bccSwdenk4.  Run "make <board>_config" with your new name.
4561c609719bSwdenk5.  Type "make", and you should get a working "u-boot.srec" file
4562c609719bSwdenk    to be installed on your target system.
456385ec0bccSwdenk6.  Debug and solve any problems that might arise.
4564c609719bSwdenk    [Of course, this last step is much harder than it sounds.]
4565c609719bSwdenk
4566c609719bSwdenk
4567c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.:
4568c609719bSwdenk==============================================================
4569c609719bSwdenk
4570c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board
4571c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to
4572c609719bSwdenkprovide feedback to the other developers. The feedback normally takes
4573c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest
4574218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources.
4575c609719bSwdenk
4576c609719bSwdenkBut before you submit such a patch, please verify that your modifi-
4577c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of
4578c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so,
4579c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot
4580c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You can
45817152b1d0Swdenkselect which (cross) compiler to use by passing a `CROSS_COMPILE'
4582218ca724SWolfgang Denkenvironment variable to the script, i. e. to use the ELDK cross tools
4583218ca724SWolfgang Denkyou can type
4584c609719bSwdenk
4585c609719bSwdenk	CROSS_COMPILE=ppc_8xx- MAKEALL
4586c609719bSwdenk
4587c609719bSwdenkor to build on a native PowerPC system you can type
4588c609719bSwdenk
4589c609719bSwdenk	CROSS_COMPILE=' ' MAKEALL
4590c609719bSwdenk
4591218ca724SWolfgang DenkWhen using the MAKEALL script, the default behaviour is to build
4592218ca724SWolfgang DenkU-Boot in the source directory. This location can be changed by
4593218ca724SWolfgang Denksetting the BUILD_DIR environment variable. Also, for each target
4594218ca724SWolfgang Denkbuilt, the MAKEALL script saves two log files (<target>.ERR and
4595218ca724SWolfgang Denk<target>.MAKEALL) in the <source dir>/LOG directory. This default
4596218ca724SWolfgang Denklocation can be changed by setting the MAKEALL_LOGDIR environment
4597218ca724SWolfgang Denkvariable. For example:
4598baf31249SMarian Balakowicz
4599baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
4600baf31249SMarian Balakowicz	export MAKEALL_LOGDIR=/tmp/log
4601baf31249SMarian Balakowicz	CROSS_COMPILE=ppc_8xx- MAKEALL
4602baf31249SMarian Balakowicz
4603218ca724SWolfgang DenkWith the above settings build objects are saved in the /tmp/build,
4604218ca724SWolfgang Denklog files are saved in the /tmp/log and the source tree remains clean
4605218ca724SWolfgang Denkduring the whole build process.
4606baf31249SMarian Balakowicz
4607baf31249SMarian Balakowicz
4608c609719bSwdenkSee also "U-Boot Porting Guide" below.
4609c609719bSwdenk
4610c609719bSwdenk
4611c609719bSwdenkMonitor Commands - Overview:
4612c609719bSwdenk============================
4613c609719bSwdenk
4614c609719bSwdenkgo	- start application at address 'addr'
4615c609719bSwdenkrun	- run commands in an environment variable
4616c609719bSwdenkbootm	- boot application image from memory
4617c609719bSwdenkbootp	- boot image via network using BootP/TFTP protocol
461844f074c7SMarek Vasutbootz   - boot zImage from memory
4619c609719bSwdenktftpboot- boot image via network using TFTP protocol
4620c609719bSwdenk	       and env variables "ipaddr" and "serverip"
4621c609719bSwdenk	       (and eventually "gatewayip")
46221fb7cd49SSimon Glasstftpput - upload a file via network using TFTP protocol
4623c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol
4624c609719bSwdenkdiskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
4625c609719bSwdenkloads	- load S-Record file over serial line
4626c609719bSwdenkloadb	- load binary file over serial line (kermit mode)
4627c609719bSwdenkmd	- memory display
4628c609719bSwdenkmm	- memory modify (auto-incrementing)
4629c609719bSwdenknm	- memory modify (constant address)
4630c609719bSwdenkmw	- memory write (fill)
4631c609719bSwdenkcp	- memory copy
4632c609719bSwdenkcmp	- memory compare
4633c609719bSwdenkcrc32	- checksum calculation
46340f89c54bSPeter Tyseri2c	- I2C sub-system
4635c609719bSwdenksspi	- SPI utility commands
4636c609719bSwdenkbase	- print or set address offset
4637c609719bSwdenkprintenv- print environment variables
4638c609719bSwdenksetenv	- set environment variables
4639c609719bSwdenksaveenv - save environment variables to persistent storage
4640c609719bSwdenkprotect - enable or disable FLASH write protection
4641c609719bSwdenkerase	- erase FLASH memory
4642c609719bSwdenkflinfo	- print FLASH memory information
464310635afaSKarl O. Pincnand	- NAND memory operations (see doc/README.nand)
4644c609719bSwdenkbdinfo	- print Board Info structure
4645c609719bSwdenkiminfo	- print header information for application image
4646c609719bSwdenkconinfo - print console devices and informations
4647c609719bSwdenkide	- IDE sub-system
4648c609719bSwdenkloop	- infinite loop on address range
464956523f12Swdenkloopw	- infinite write loop on address range
4650c609719bSwdenkmtest	- simple RAM test
4651c609719bSwdenkicache	- enable or disable instruction cache
4652c609719bSwdenkdcache	- enable or disable data cache
4653c609719bSwdenkreset	- Perform RESET of the CPU
4654c609719bSwdenkecho	- echo args to console
4655c609719bSwdenkversion - print monitor version
4656c609719bSwdenkhelp	- print online help
4657c609719bSwdenk?	- alias for 'help'
4658c609719bSwdenk
4659c609719bSwdenk
4660c609719bSwdenkMonitor Commands - Detailed Description:
4661c609719bSwdenk========================================
4662c609719bSwdenk
4663c609719bSwdenkTODO.
4664c609719bSwdenk
4665c609719bSwdenkFor now: just type "help <command>".
4666c609719bSwdenk
4667c609719bSwdenk
4668c609719bSwdenkEnvironment Variables:
4669c609719bSwdenk======================
4670c609719bSwdenk
4671c609719bSwdenkU-Boot supports user configuration using Environment Variables which
4672c609719bSwdenkcan be made persistent by saving to Flash memory.
4673c609719bSwdenk
4674c609719bSwdenkEnvironment Variables are set using "setenv", printed using
4675c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv"
4676c609719bSwdenkwithout a value can be used to delete a variable from the
4677c609719bSwdenkenvironment. As long as you don't save the environment you are
4678c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the
4679c609719bSwdenkenvironment is erased by accident, a default environment is provided.
4680c609719bSwdenk
4681c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables.
4682c96f86eeSWolfgang Denk
4683c96f86eeSWolfgang DenkList of environment variables (most likely not complete):
4684c609719bSwdenk
4685c609719bSwdenk  baudrate	- see CONFIG_BAUDRATE
4686c609719bSwdenk
4687c609719bSwdenk  bootdelay	- see CONFIG_BOOTDELAY
4688c609719bSwdenk
4689c609719bSwdenk  bootcmd	- see CONFIG_BOOTCOMMAND
4690c609719bSwdenk
4691c609719bSwdenk  bootargs	- Boot arguments when booting an RTOS image
4692c609719bSwdenk
4693c609719bSwdenk  bootfile	- Name of the image to load with TFTP
4694c609719bSwdenk
46957d721e34SBartlomiej Sieka  bootm_low	- Memory range available for image processing in the bootm
46967d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
46977d721e34SBartlomiej Sieka		  a hexadecimal number and defines lowest address allowed
46987d721e34SBartlomiej Sieka		  for use by the bootm command. See also "bootm_size"
46997d721e34SBartlomiej Sieka		  environment variable. Address defined by "bootm_low" is
47007d721e34SBartlomiej Sieka		  also the base of the initial memory mapping for the Linux
4701c3624e6eSGrant Likely		  kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4702c3624e6eSGrant Likely		  bootm_mapsize.
4703c3624e6eSGrant Likely
4704c3624e6eSGrant Likely  bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
4705c3624e6eSGrant Likely		  This variable is given as a hexadecimal number and it
4706c3624e6eSGrant Likely		  defines the size of the memory region starting at base
4707c3624e6eSGrant Likely		  address bootm_low that is accessible by the Linux kernel
4708c3624e6eSGrant Likely		  during early boot.  If unset, CONFIG_SYS_BOOTMAPSZ is used
4709c3624e6eSGrant Likely		  as the default value if it is defined, and bootm_size is
4710c3624e6eSGrant Likely		  used otherwise.
47117d721e34SBartlomiej Sieka
47127d721e34SBartlomiej Sieka  bootm_size	- Memory range available for image processing in the bootm
47137d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
47147d721e34SBartlomiej Sieka		  a hexadecimal number and defines the size of the region
47157d721e34SBartlomiej Sieka		  allowed for use by the bootm command. See also "bootm_low"
47167d721e34SBartlomiej Sieka		  environment variable.
47177d721e34SBartlomiej Sieka
47184bae9090SBartlomiej Sieka  updatefile	- Location of the software update file on a TFTP server, used
47194bae9090SBartlomiej Sieka		  by the automatic software update feature. Please refer to
47204bae9090SBartlomiej Sieka		  documentation in doc/README.update for more details.
47214bae9090SBartlomiej Sieka
4722c609719bSwdenk  autoload	- if set to "no" (any string beginning with 'n'),
4723c609719bSwdenk		  "bootp" will just load perform a lookup of the
4724c609719bSwdenk		  configuration from the BOOTP server, but not try to
4725c609719bSwdenk		  load any image using TFTP
4726c609719bSwdenk
4727c609719bSwdenk  autostart	- if set to "yes", an image loaded using the "bootp",
4728c609719bSwdenk		  "rarpboot", "tftpboot" or "diskboot" commands will
4729c609719bSwdenk		  be automatically started (by internally calling
4730c609719bSwdenk		  "bootm")
4731c609719bSwdenk
47324a6fd34bSwdenk		  If set to "no", a standalone image passed to the
47334a6fd34bSwdenk		  "bootm" command will be copied to the load address
47344a6fd34bSwdenk		  (and eventually uncompressed), but NOT be started.
47354a6fd34bSwdenk		  This can be used to load and uncompress arbitrary
47364a6fd34bSwdenk		  data.
47374a6fd34bSwdenk
4738a28afca5SDavid A. Long  fdt_high	- if set this restricts the maximum address that the
4739a28afca5SDavid A. Long		  flattened device tree will be copied into upon boot.
4740fa34f6b2SShawn Guo		  For example, if you have a system with 1 GB memory
4741fa34f6b2SShawn Guo		  at physical address 0x10000000, while Linux kernel
4742fa34f6b2SShawn Guo		  only recognizes the first 704 MB as low memory, you
4743fa34f6b2SShawn Guo		  may need to set fdt_high as 0x3C000000 to have the
4744fa34f6b2SShawn Guo		  device tree blob be copied to the maximum address
4745fa34f6b2SShawn Guo		  of the 704 MB low memory, so that Linux kernel can
4746fa34f6b2SShawn Guo		  access it during the boot procedure.
4747fa34f6b2SShawn Guo
4748a28afca5SDavid A. Long		  If this is set to the special value 0xFFFFFFFF then
4749a28afca5SDavid A. Long		  the fdt will not be copied at all on boot.  For this
4750a28afca5SDavid A. Long		  to work it must reside in writable memory, have
4751a28afca5SDavid A. Long		  sufficient padding on the end of it for u-boot to
4752a28afca5SDavid A. Long		  add the information it needs into it, and the memory
4753a28afca5SDavid A. Long		  must be accessible by the kernel.
4754a28afca5SDavid A. Long
4755eea63e05SSimon Glass  fdtcontroladdr- if set this is the address of the control flattened
4756eea63e05SSimon Glass		  device tree used by U-Boot when CONFIG_OF_CONTROL is
4757eea63e05SSimon Glass		  defined.
4758eea63e05SSimon Glass
475917ea1177Swdenk  i2cfast	- (PPC405GP|PPC405EP only)
476017ea1177Swdenk		  if set to 'y' configures Linux I2C driver for fast
476117ea1177Swdenk		  mode (400kHZ). This environment variable is used in
476217ea1177Swdenk		  initialization code. So, for changes to be effective
476317ea1177Swdenk		  it must be saved and board must be reset.
476417ea1177Swdenk
4765c609719bSwdenk  initrd_high	- restrict positioning of initrd images:
4766c609719bSwdenk		  If this variable is not set, initrd images will be
4767c609719bSwdenk		  copied to the highest possible address in RAM; this
4768c609719bSwdenk		  is usually what you want since it allows for
4769c609719bSwdenk		  maximum initrd size. If for some reason you want to
4770c609719bSwdenk		  make sure that the initrd image is loaded below the
47716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		  CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
4772c609719bSwdenk		  variable to a value of "no" or "off" or "0".
4773c609719bSwdenk		  Alternatively, you can set it to a maximum upper
4774c609719bSwdenk		  address to use (U-Boot will still check that it
4775c609719bSwdenk		  does not overwrite the U-Boot stack and data).
4776c609719bSwdenk
4777c609719bSwdenk		  For instance, when you have a system with 16 MB
47787152b1d0Swdenk		  RAM, and want to reserve 4 MB from use by Linux,
4779c609719bSwdenk		  you can do this by adding "mem=12M" to the value of
4780c609719bSwdenk		  the "bootargs" variable. However, now you must make
47817152b1d0Swdenk		  sure that the initrd image is placed in the first
4782c609719bSwdenk		  12 MB as well - this can be done with
4783c609719bSwdenk
4784c609719bSwdenk		  setenv initrd_high 00c00000
4785c609719bSwdenk
478638b99261Swdenk		  If you set initrd_high to 0xFFFFFFFF, this is an
478738b99261Swdenk		  indication to U-Boot that all addresses are legal
478838b99261Swdenk		  for the Linux kernel, including addresses in flash
478938b99261Swdenk		  memory. In this case U-Boot will NOT COPY the
479038b99261Swdenk		  ramdisk at all. This may be useful to reduce the
479138b99261Swdenk		  boot time on your system, but requires that this
479238b99261Swdenk		  feature is supported by your Linux kernel.
479338b99261Swdenk
4794c609719bSwdenk  ipaddr	- IP address; needed for tftpboot command
4795c609719bSwdenk
4796c609719bSwdenk  loadaddr	- Default load address for commands like "bootp",
4797dc7c9a1aSwdenk		  "rarpboot", "tftpboot", "loadb" or "diskboot"
4798c609719bSwdenk
4799c609719bSwdenk  loads_echo	- see CONFIG_LOADS_ECHO
4800c609719bSwdenk
4801c609719bSwdenk  serverip	- TFTP server IP address; needed for tftpboot command
4802c609719bSwdenk
4803c609719bSwdenk  bootretry	- see CONFIG_BOOT_RETRY_TIME
4804c609719bSwdenk
4805c609719bSwdenk  bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
4806c609719bSwdenk
4807c609719bSwdenk  bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
4808c609719bSwdenk
4809e2a53458SMike Frysinger  ethprime	- controls which interface is used first.
4810a3d991bdSwdenk
4811e2a53458SMike Frysinger  ethact	- controls which interface is currently active.
4812e2a53458SMike Frysinger		  For example you can do the following
4813a3d991bdSwdenk
481448690d80SHeiko Schocher		  => setenv ethact FEC
481548690d80SHeiko Schocher		  => ping 192.168.0.1 # traffic sent on FEC
481648690d80SHeiko Schocher		  => setenv ethact SCC
481748690d80SHeiko Schocher		  => ping 10.0.0.1 # traffic sent on SCC
4818a3d991bdSwdenk
4819e1692577SMatthias Fuchs  ethrotate	- When set to "no" U-Boot does not go through all
4820e1692577SMatthias Fuchs		  available network interfaces.
4821e1692577SMatthias Fuchs		  It just stays at the currently selected interface.
4822e1692577SMatthias Fuchs
4823a3d991bdSwdenk  netretry	- When set to "no" each network operation will
4824a3d991bdSwdenk		  either succeed or fail without retrying.
48256e592385Swdenk		  When set to "once" the network operation will
48266e592385Swdenk		  fail when all the available network interfaces
48276e592385Swdenk		  are tried once without success.
4828a3d991bdSwdenk		  Useful on scripts which control the retry operation
4829a3d991bdSwdenk		  themselves.
4830a3d991bdSwdenk
4831b4e2f89dSJean-Christophe PLAGNIOL-VILLARD  npe_ucode	- set load address for the NPE microcode
4832a1cf027aSJean-Christophe PLAGNIOL-VILLARD
48338d51aacdSSimon Glass  silent_linux  - If set then linux will be told to boot silently, by
48348d51aacdSSimon Glass		  changing the console to be empty. If "yes" it will be
48358d51aacdSSimon Glass		  made silent. If "no" it will not be made silent. If
48368d51aacdSSimon Glass		  unset, then it will be made silent if the U-Boot console
48378d51aacdSSimon Glass		  is silent.
48388d51aacdSSimon Glass
483928cb9375SWolfgang Denk  tftpsrcport	- If this is set, the value is used for TFTP's
4840ecb0ccd9SWolfgang Denk		  UDP source port.
4841ecb0ccd9SWolfgang Denk
484228cb9375SWolfgang Denk  tftpdstport	- If this is set, the value is used for TFTP's UDP
484328cb9375SWolfgang Denk		  destination port instead of the Well Know Port 69.
484428cb9375SWolfgang Denk
4845c96f86eeSWolfgang Denk  tftpblocksize - Block size to use for TFTP transfers; if not set,
4846c96f86eeSWolfgang Denk		  we use the TFTP server's default block size
4847c96f86eeSWolfgang Denk
4848c96f86eeSWolfgang Denk  tftptimeout	- Retransmission timeout for TFTP packets (in milli-
4849c96f86eeSWolfgang Denk		  seconds, minimum value is 1000 = 1 second). Defines
4850c96f86eeSWolfgang Denk		  when a packet is considered to be lost so it has to
4851c96f86eeSWolfgang Denk		  be retransmitted. The default is 5000 = 5 seconds.
4852c96f86eeSWolfgang Denk		  Lowering this value may make downloads succeed
4853c96f86eeSWolfgang Denk		  faster in networks with high packet loss rates or
4854c96f86eeSWolfgang Denk		  with unreliable TFTP servers.
4855c96f86eeSWolfgang Denk
4856a3d991bdSwdenk  vlan		- When set to a value < 4095 the traffic over
485711ccc33fSMarcel Ziswiler		  Ethernet is encapsulated/received over 802.1q
4858a3d991bdSwdenk		  VLAN tagged frames.
4859c609719bSwdenk
4860dc0b7b0eSJason HobbsThe following image location variables contain the location of images
4861dc0b7b0eSJason Hobbsused in booting. The "Image" column gives the role of the image and is
4862dc0b7b0eSJason Hobbsnot an environment variable name. The other columns are environment
4863dc0b7b0eSJason Hobbsvariable names. "File Name" gives the name of the file on a TFTP
4864dc0b7b0eSJason Hobbsserver, "RAM Address" gives the location in RAM the image will be
4865dc0b7b0eSJason Hobbsloaded to, and "Flash Location" gives the image's address in NOR
4866dc0b7b0eSJason Hobbsflash or offset in NAND flash.
4867dc0b7b0eSJason Hobbs
4868dc0b7b0eSJason Hobbs*Note* - these variables don't have to be defined for all boards, some
4869dc0b7b0eSJason Hobbsboards currenlty use other variables for these purposes, and some
4870dc0b7b0eSJason Hobbsboards use these variables for other purposes.
4871dc0b7b0eSJason Hobbs
4872dc0b7b0eSJason HobbsImage		    File Name	     RAM Address       Flash Location
4873dc0b7b0eSJason Hobbs-----		    ---------	     -----------       --------------
4874dc0b7b0eSJason Hobbsu-boot		    u-boot	     u-boot_addr_r     u-boot_addr
4875dc0b7b0eSJason HobbsLinux kernel	    bootfile	     kernel_addr_r     kernel_addr
4876dc0b7b0eSJason Hobbsdevice tree blob    fdtfile	     fdt_addr_r	       fdt_addr
4877dc0b7b0eSJason Hobbsramdisk		    ramdiskfile	     ramdisk_addr_r    ramdisk_addr
4878dc0b7b0eSJason Hobbs
4879c609719bSwdenkThe following environment variables may be used and automatically
4880c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"),
4881c609719bSwdenkdepending the information provided by your boot server:
4882c609719bSwdenk
4883c609719bSwdenk  bootfile	- see above
4884c609719bSwdenk  dnsip		- IP address of your Domain Name Server
4885fe389a82Sstroese  dnsip2	- IP address of your secondary Domain Name Server
4886c609719bSwdenk  gatewayip	- IP address of the Gateway (Router) to use
4887c609719bSwdenk  hostname	- Target hostname
4888c609719bSwdenk  ipaddr	- see above
4889c609719bSwdenk  netmask	- Subnet Mask
4890c609719bSwdenk  rootpath	- Pathname of the root filesystem on the NFS server
4891c609719bSwdenk  serverip	- see above
4892c609719bSwdenk
4893c609719bSwdenk
4894c609719bSwdenkThere are two special Environment Variables:
4895c609719bSwdenk
4896c609719bSwdenk  serial#	- contains hardware identification information such
4897c609719bSwdenk		  as type string and/or serial number
4898c609719bSwdenk  ethaddr	- Ethernet address
4899c609719bSwdenk
4900c609719bSwdenkThese variables can be set only once (usually during manufacturing of
4901c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables
4902c609719bSwdenkonce they have been set once.
4903c609719bSwdenk
4904c609719bSwdenk
4905c1551ea8SstroeseFurther special Environment Variables:
4906c1551ea8Sstroese
4907c1551ea8Sstroese  ver		- Contains the U-Boot version string as printed
4908c1551ea8Sstroese		  with the "version" command. This variable is
4909c1551ea8Sstroese		  readonly (see CONFIG_VERSION_VARIABLE).
4910c1551ea8Sstroese
4911c1551ea8Sstroese
4912c609719bSwdenkPlease note that changes to some configuration parameters may take
4913c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-).
4914c609719bSwdenk
4915c609719bSwdenk
4916170ab110SJoe HershbergerCallback functions for environment variables:
4917170ab110SJoe Hershberger---------------------------------------------
4918170ab110SJoe Hershberger
4919170ab110SJoe HershbergerFor some environment variables, the behavior of u-boot needs to change
4920170ab110SJoe Hershbergerwhen their values are changed.  This functionailty allows functions to
4921170ab110SJoe Hershbergerbe associated with arbitrary variables.  On creation, overwrite, or
4922170ab110SJoe Hershbergerdeletion, the callback will provide the opportunity for some side
4923170ab110SJoe Hershbergereffect to happen or for the change to be rejected.
4924170ab110SJoe Hershberger
4925170ab110SJoe HershbergerThe callbacks are named and associated with a function using the
4926170ab110SJoe HershbergerU_BOOT_ENV_CALLBACK macro in your board or driver code.
4927170ab110SJoe Hershberger
4928170ab110SJoe HershbergerThese callbacks are associated with variables in one of two ways.  The
4929170ab110SJoe Hershbergerstatic list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
4930170ab110SJoe Hershbergerin the board configuration to a string that defines a list of
4931170ab110SJoe Hershbergerassociations.  The list must be in the following format:
4932170ab110SJoe Hershberger
4933170ab110SJoe Hershberger	entry = variable_name[:callback_name]
4934170ab110SJoe Hershberger	list = entry[,list]
4935170ab110SJoe Hershberger
4936170ab110SJoe HershbergerIf the callback name is not specified, then the callback is deleted.
4937170ab110SJoe HershbergerSpaces are also allowed anywhere in the list.
4938170ab110SJoe Hershberger
4939170ab110SJoe HershbergerCallbacks can also be associated by defining the ".callbacks" variable
4940170ab110SJoe Hershbergerwith the same list format above.  Any association in ".callbacks" will
4941170ab110SJoe Hershbergeroverride any association in the static list. You can define
4942170ab110SJoe HershbergerCONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
4943170ab110SJoe Hershberger".callbacks" envirnoment variable in the default or embedded environment.
4944170ab110SJoe Hershberger
4945170ab110SJoe Hershberger
4946f07771ccSwdenkCommand Line Parsing:
4947f07771ccSwdenk=====================
4948f07771ccSwdenk
4949f07771ccSwdenkThere are two different command line parsers available with U-Boot:
49507152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell:
4951f07771ccSwdenk
4952f07771ccSwdenkOld, simple command line parser:
4953f07771ccSwdenk--------------------------------
4954f07771ccSwdenk
4955f07771ccSwdenk- supports environment variables (through setenv / saveenv commands)
4956f07771ccSwdenk- several commands on one line, separated by ';'
4957fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax
4958f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\',
4959f07771ccSwdenk  for example:
4960fe126d8bSWolfgang Denk	setenv bootcmd bootm \${address}
4961f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example:
4962f07771ccSwdenk	setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
4963f07771ccSwdenk
4964f07771ccSwdenkHush shell:
4965f07771ccSwdenk-----------
4966f07771ccSwdenk
4967f07771ccSwdenk- similar to Bourne shell, with control structures like
4968f07771ccSwdenk  if...then...else...fi, for...do...done; while...do...done,
4969f07771ccSwdenk  until...do...done, ...
4970f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv
4971f07771ccSwdenk  commands) and local shell variables (through standard shell syntax
4972f07771ccSwdenk  "name=value"); only environment variables can be used with "run"
4973f07771ccSwdenk  command
4974f07771ccSwdenk
4975f07771ccSwdenkGeneral rules:
4976f07771ccSwdenk--------------
4977f07771ccSwdenk
4978f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run"
4979f07771ccSwdenk    command) contains several commands separated by semicolon, and
4980f07771ccSwdenk    one of these commands fails, then the remaining commands will be
4981f07771ccSwdenk    executed anyway.
4982f07771ccSwdenk
4983f07771ccSwdenk(2) If you execute several variables with one call to run (i. e.
498411ccc33fSMarcel Ziswiler    calling run with a list of variables as arguments), any failing
4985f07771ccSwdenk    command will cause "run" to terminate, i. e. the remaining
4986f07771ccSwdenk    variables are not executed.
4987f07771ccSwdenk
4988c609719bSwdenkNote for Redundant Ethernet Interfaces:
4989c609719bSwdenk=======================================
4990c609719bSwdenk
499111ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports
4992c609719bSwdenksuch configurations and is capable of automatic selection of a
49937152b1d0Swdenk"working" interface when needed. MAC assignment works as follows:
4994c609719bSwdenk
4995c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding
4996c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0),
4997c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ...
4998c609719bSwdenk
4999c609719bSwdenkIf the network interface stores some valid MAC address (for instance
5000c609719bSwdenkin SROM), this is used as default address if there is NO correspon-
5001c609719bSwdenkding setting in the environment; if the corresponding environment
5002c609719bSwdenkvariable is set, this overrides the settings in the card; that means:
5003c609719bSwdenk
5004c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the
5005c609719bSwdenk  environment, the SROM's address is used.
5006c609719bSwdenk
5007c609719bSwdenko If there is no valid address in the SROM, and a definition in the
5008c609719bSwdenk  environment exists, then the value from the environment variable is
5009c609719bSwdenk  used.
5010c609719bSwdenk
5011c609719bSwdenko If both the SROM and the environment contain a MAC address, and
5012c609719bSwdenk  both addresses are the same, this MAC address is used.
5013c609719bSwdenk
5014c609719bSwdenko If both the SROM and the environment contain a MAC address, and the
5015c609719bSwdenk  addresses differ, the value from the environment is used and a
5016c609719bSwdenk  warning is printed.
5017c609719bSwdenk
5018c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error
5019c609719bSwdenk  is raised.
5020c609719bSwdenk
5021ecee9324SBen WarrenIf Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
5022ecee9324SBen Warrenwill be programmed into hardware as part of the initialization process.	 This
5023ecee9324SBen Warrenmay be skipped by setting the appropriate 'ethmacskip' environment variable.
5024ecee9324SBen WarrenThe naming convention is as follows:
5025ecee9324SBen Warren"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
5026c609719bSwdenk
5027c609719bSwdenkImage Formats:
5028c609719bSwdenk==============
5029c609719bSwdenk
50303310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on)
50313310c549SMarian Balakowiczimages in two formats:
50323310c549SMarian Balakowicz
50333310c549SMarian BalakowiczNew uImage format (FIT)
50343310c549SMarian Balakowicz-----------------------
50353310c549SMarian Balakowicz
50363310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar
50373310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple
50383310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by
50393310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
50403310c549SMarian Balakowicz
50413310c549SMarian Balakowicz
50423310c549SMarian BalakowiczOld uImage format
50433310c549SMarian Balakowicz-----------------
50443310c549SMarian Balakowicz
50453310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything,
50463310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for
50473310c549SMarian Balakowiczdetails; basically, the header defines the following image properties:
5048c609719bSwdenk
5049c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5050c609719bSwdenk  4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
5051f5ed9e39SPeter Tyser  LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5052f5ed9e39SPeter Tyser  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5053f5ed9e39SPeter Tyser  INTEGRITY).
50547b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
5055afc1ce82SMacpaul Lin  IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5056afc1ce82SMacpaul Lin  Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
5057c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2)
5058c609719bSwdenk* Load Address
5059c609719bSwdenk* Entry Point
5060c609719bSwdenk* Image Name
5061c609719bSwdenk* Image Timestamp
5062c609719bSwdenk
5063c609719bSwdenkThe header is marked by a special Magic Number, and both the header
5064c609719bSwdenkand the data portions of the image are secured against corruption by
5065c609719bSwdenkCRC32 checksums.
5066c609719bSwdenk
5067c609719bSwdenk
5068c609719bSwdenkLinux Support:
5069c609719bSwdenk==============
5070c609719bSwdenk
5071c609719bSwdenkAlthough U-Boot should support any OS or standalone application
50727152b1d0Swdenkeasily, the main focus has always been on Linux during the design of
5073c609719bSwdenkU-Boot.
5074c609719bSwdenk
5075c609719bSwdenkU-Boot includes many features that so far have been part of some
5076c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any
5077c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image;
5078c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation
50797152b1d0Swdenkserves several purposes:
5080c609719bSwdenk
5081c609719bSwdenk- the same features can be used for other OS or standalone
5082c609719bSwdenk  applications (for instance: using compressed images to reduce the
5083c609719bSwdenk  Flash memory footprint)
5084c609719bSwdenk
5085c609719bSwdenk- it becomes much easier to port new Linux kernel versions because
50867152b1d0Swdenk  lots of low-level, hardware dependent stuff are done by U-Boot
5087c609719bSwdenk
5088c609719bSwdenk- the same Linux kernel image can now be used with different "initrd"
5089c609719bSwdenk  images; of course this also means that different kernel images can
5090c609719bSwdenk  be run with the same "initrd". This makes testing easier (you don't
5091c609719bSwdenk  have to build a new "zImage.initrd" Linux image when you just
5092c609719bSwdenk  change a file in your "initrd"). Also, a field-upgrade of the
5093c609719bSwdenk  software is easier now.
5094c609719bSwdenk
5095c609719bSwdenk
5096c609719bSwdenkLinux HOWTO:
5097c609719bSwdenk============
5098c609719bSwdenk
5099c609719bSwdenkPorting Linux to U-Boot based systems:
5100c609719bSwdenk---------------------------------------
5101c609719bSwdenk
5102c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to
5103c609719bSwdenkconfigure the Linux device drivers for use with your target hardware
5104c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to
5105c609719bSwdenkLinux :-).
5106c609719bSwdenk
5107a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
5108c609719bSwdenk
5109c609719bSwdenkJust make sure your machine specific header file (for instance
5110c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board
51111dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h,
51121dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value
51136d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR.
5114c609719bSwdenk
5115c609719bSwdenk
5116c609719bSwdenkConfiguring the Linux kernel:
5117c609719bSwdenk-----------------------------
5118c609719bSwdenk
5119c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root
5120c609719bSwdenkdevice (initial ramdisk, NFS) for your target system.
5121c609719bSwdenk
5122c609719bSwdenk
5123c609719bSwdenkBuilding a Linux Image:
5124c609719bSwdenk-----------------------
5125c609719bSwdenk
512624ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are
512724ee89b9Swdenknot used. If you use recent kernel source, a new build target
512824ee89b9Swdenk"uImage" will exist which automatically builds an image usable by
512924ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target,
513024ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a
513124ee89b9Swdenk100% compatible format.
5132c609719bSwdenk
5133c609719bSwdenkExample:
5134c609719bSwdenk
5135c609719bSwdenk	make TQM850L_config
5136c609719bSwdenk	make oldconfig
5137c609719bSwdenk	make dep
513824ee89b9Swdenk	make uImage
5139c609719bSwdenk
514024ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to
514124ee89b9Swdenkencapsulate a compressed Linux kernel image with header	 information,
514224ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing:
5143c609719bSwdenk
514424ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format):
514524ee89b9Swdenk
514624ee89b9Swdenk* convert the kernel into a raw binary image:
514724ee89b9Swdenk
514824ee89b9Swdenk	${CROSS_COMPILE}-objcopy -O binary \
514924ee89b9Swdenk				 -R .note -R .comment \
515024ee89b9Swdenk				 -S vmlinux linux.bin
515124ee89b9Swdenk
515224ee89b9Swdenk* compress the binary image:
515324ee89b9Swdenk
515424ee89b9Swdenk	gzip -9 linux.bin
515524ee89b9Swdenk
515624ee89b9Swdenk* package compressed binary image for U-Boot:
515724ee89b9Swdenk
515824ee89b9Swdenk	mkimage -A ppc -O linux -T kernel -C gzip \
515924ee89b9Swdenk		-a 0 -e 0 -n "Linux Kernel Image" \
516024ee89b9Swdenk		-d linux.bin.gz uImage
516124ee89b9Swdenk
516224ee89b9Swdenk
516324ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use
516424ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or
516524ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64
516624ee89b9Swdenkbyte header containing information about target architecture,
516724ee89b9Swdenkoperating system, image type, compression method, entry points, time
516824ee89b9Swdenkstamp, CRC32 checksums, etc.
516924ee89b9Swdenk
517024ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and
517124ee89b9Swdenkprint the header information, or to build new images.
5172c609719bSwdenk
5173c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information
5174c609719bSwdenkcontained in the header of an existing U-Boot image; this includes
5175c609719bSwdenkchecksum verification:
5176c609719bSwdenk
5177c609719bSwdenk	tools/mkimage -l image
5178c609719bSwdenk	  -l ==> list image header information
5179c609719bSwdenk
5180c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image
5181c609719bSwdenkfrom a "data file" which is used as image payload:
5182c609719bSwdenk
5183c609719bSwdenk	tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5184c609719bSwdenk		      -n name -d data_file image
5185c609719bSwdenk	  -A ==> set architecture to 'arch'
5186c609719bSwdenk	  -O ==> set operating system to 'os'
5187c609719bSwdenk	  -T ==> set image type to 'type'
5188c609719bSwdenk	  -C ==> set compression type 'comp'
5189c609719bSwdenk	  -a ==> set load address to 'addr' (hex)
5190c609719bSwdenk	  -e ==> set entry point to 'ep' (hex)
5191c609719bSwdenk	  -n ==> set image name to 'name'
5192c609719bSwdenk	  -d ==> use image data from 'datafile'
5193c609719bSwdenk
519469459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load
519569459791Swdenkaddress (0x00000000), but the entry point address depends on the
519669459791Swdenkkernel version:
5197c609719bSwdenk
5198c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C,
519924ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000.
5200c609719bSwdenk
5201c609719bSwdenkSo a typical call to build a U-Boot image would read:
5202c609719bSwdenk
520324ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
520424ee89b9Swdenk	> -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
5205a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
520624ee89b9Swdenk	> examples/uImage.TQM850L
520724ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5208c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5209c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
5210c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
5211c609719bSwdenk	Load Address: 0x00000000
521224ee89b9Swdenk	Entry Point:  0x00000000
5213c609719bSwdenk
5214c609719bSwdenkTo verify the contents of the image (or check for corruption):
5215c609719bSwdenk
521624ee89b9Swdenk	-> tools/mkimage -l examples/uImage.TQM850L
521724ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5218c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5219c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
5220c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
5221c609719bSwdenk	Load Address: 0x00000000
522224ee89b9Swdenk	Entry Point:  0x00000000
5223c609719bSwdenk
5224c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade
5225c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this
5226c609719bSwdenkneeds more space in Flash, but boots much faster since it does not
5227c609719bSwdenkneed to be uncompressed:
5228c609719bSwdenk
5229a47a12beSStefan Roese	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
523024ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
523124ee89b9Swdenk	> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
5232a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
523324ee89b9Swdenk	> examples/uImage.TQM850L-uncompressed
523424ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5235c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5236c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (uncompressed)
5237c609719bSwdenk	Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
5238c609719bSwdenk	Load Address: 0x00000000
523924ee89b9Swdenk	Entry Point:  0x00000000
5240c609719bSwdenk
5241c609719bSwdenk
5242c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file
5243c609719bSwdenkwhen your kernel is intended to use an initial ramdisk:
5244c609719bSwdenk
5245c609719bSwdenk	-> tools/mkimage -n 'Simple Ramdisk Image' \
5246c609719bSwdenk	> -A ppc -O linux -T ramdisk -C gzip \
5247c609719bSwdenk	> -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5248c609719bSwdenk	Image Name:   Simple Ramdisk Image
5249c609719bSwdenk	Created:      Wed Jan 12 14:01:50 2000
5250c609719bSwdenk	Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
5251c609719bSwdenk	Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
5252c609719bSwdenk	Load Address: 0x00000000
5253c609719bSwdenk	Entry Point:  0x00000000
5254c609719bSwdenk
5255*a804b5ceSGuilherme Maciel FerreiraThe "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5256*a804b5ceSGuilherme Maciel Ferreiraoption performs the converse operation of the mkimage's second form (the "-d"
5257*a804b5ceSGuilherme Maciel Ferreiraoption). Given an image built by mkimage, the dumpimage extracts a "data file"
5258*a804b5ceSGuilherme Maciel Ferreirafrom the image:
5259*a804b5ceSGuilherme Maciel Ferreira
5260*a804b5ceSGuilherme Maciel Ferreira	tools/dumpimage -i image -p position data_file
5261*a804b5ceSGuilherme Maciel Ferreira	  -i ==> extract from the 'image' a specific 'data_file', \
5262*a804b5ceSGuilherme Maciel Ferreira	   indexed by 'position'
5263*a804b5ceSGuilherme Maciel Ferreira
5264c609719bSwdenk
5265c609719bSwdenkInstalling a Linux Image:
5266c609719bSwdenk-------------------------
5267c609719bSwdenk
5268c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface,
5269c609719bSwdenkyou must convert the image to S-Record format:
5270c609719bSwdenk
5271c609719bSwdenk	objcopy -I binary -O srec examples/image examples/image.srec
5272c609719bSwdenk
5273c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot
5274c609719bSwdenkimage header, so the resulting S-Record file will be relative to
5275c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to
5276c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads'
5277c609719bSwdenkcommand.
5278c609719bSwdenk
5279c609719bSwdenkExample: install the image to address 0x40100000 (which on the
5280c609719bSwdenkTQM8xxL is in the first Flash bank):
5281c609719bSwdenk
5282c609719bSwdenk	=> erase 40100000 401FFFFF
5283c609719bSwdenk
5284c609719bSwdenk	.......... done
5285c609719bSwdenk	Erased 8 sectors
5286c609719bSwdenk
5287c609719bSwdenk	=> loads 40100000
5288c609719bSwdenk	## Ready for S-Record download ...
5289c609719bSwdenk	~>examples/image.srec
5290c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5291c609719bSwdenk	...
5292c609719bSwdenk	15989 15990 15991 15992
5293c609719bSwdenk	[file transfer complete]
5294c609719bSwdenk	[connected]
5295c609719bSwdenk	## Start Addr = 0x00000000
5296c609719bSwdenk
5297c609719bSwdenk
5298c609719bSwdenkYou can check the success of the download using the 'iminfo' command;
5299c609719bSwdenkthis includes a checksum verification so you can be sure no data
5300c609719bSwdenkcorruption happened:
5301c609719bSwdenk
5302c609719bSwdenk	=> imi 40100000
5303c609719bSwdenk
5304c609719bSwdenk	## Checking Image at 40100000 ...
5305c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5306c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5307c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5308c609719bSwdenk	   Load Address: 00000000
5309c609719bSwdenk	   Entry Point:	 0000000c
5310c609719bSwdenk	   Verifying Checksum ... OK
5311c609719bSwdenk
5312c609719bSwdenk
5313c609719bSwdenkBoot Linux:
5314c609719bSwdenk-----------
5315c609719bSwdenk
5316c609719bSwdenkThe "bootm" command is used to boot an application that is stored in
5317c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents
5318c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as
5319c609719bSwdenkparameters. You can check and modify this variable using the
5320c609719bSwdenk"printenv" and "setenv" commands:
5321c609719bSwdenk
5322c609719bSwdenk
5323c609719bSwdenk	=> printenv bootargs
5324c609719bSwdenk	bootargs=root=/dev/ram
5325c609719bSwdenk
5326c609719bSwdenk	=> setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5327c609719bSwdenk
5328c609719bSwdenk	=> printenv bootargs
5329c609719bSwdenk	bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5330c609719bSwdenk
5331c609719bSwdenk	=> bootm 40020000
5332c609719bSwdenk	## Booting Linux kernel at 40020000 ...
5333c609719bSwdenk	   Image Name:	 2.2.13 for NFS on TQM850L
5334c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5335c609719bSwdenk	   Data Size:	 381681 Bytes = 372 kB = 0 MB
5336c609719bSwdenk	   Load Address: 00000000
5337c609719bSwdenk	   Entry Point:	 0000000c
5338c609719bSwdenk	   Verifying Checksum ... OK
5339c609719bSwdenk	   Uncompressing Kernel Image ... OK
5340c609719bSwdenk	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
5341c609719bSwdenk	Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5342c609719bSwdenk	time_init: decrementer frequency = 187500000/60
5343c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
5344c609719bSwdenk	Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5345c609719bSwdenk	...
5346c609719bSwdenk
534711ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass
53487152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT
5349c609719bSwdenkformat!) to the "bootm" command:
5350c609719bSwdenk
5351c609719bSwdenk	=> imi 40100000 40200000
5352c609719bSwdenk
5353c609719bSwdenk	## Checking Image at 40100000 ...
5354c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5355c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5356c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5357c609719bSwdenk	   Load Address: 00000000
5358c609719bSwdenk	   Entry Point:	 0000000c
5359c609719bSwdenk	   Verifying Checksum ... OK
5360c609719bSwdenk
5361c609719bSwdenk	## Checking Image at 40200000 ...
5362c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
5363c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
5364c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
5365c609719bSwdenk	   Load Address: 00000000
5366c609719bSwdenk	   Entry Point:	 00000000
5367c609719bSwdenk	   Verifying Checksum ... OK
5368c609719bSwdenk
5369c609719bSwdenk	=> bootm 40100000 40200000
5370c609719bSwdenk	## Booting Linux kernel at 40100000 ...
5371c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5372c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5373c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5374c609719bSwdenk	   Load Address: 00000000
5375c609719bSwdenk	   Entry Point:	 0000000c
5376c609719bSwdenk	   Verifying Checksum ... OK
5377c609719bSwdenk	   Uncompressing Kernel Image ... OK
5378c609719bSwdenk	## Loading RAMDisk Image at 40200000 ...
5379c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
5380c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
5381c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
5382c609719bSwdenk	   Load Address: 00000000
5383c609719bSwdenk	   Entry Point:	 00000000
5384c609719bSwdenk	   Verifying Checksum ... OK
5385c609719bSwdenk	   Loading Ramdisk ... OK
5386c609719bSwdenk	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
5387c609719bSwdenk	Boot arguments: root=/dev/ram
5388c609719bSwdenk	time_init: decrementer frequency = 187500000/60
5389c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
5390c609719bSwdenk	...
5391c609719bSwdenk	RAMDISK: Compressed image found at block 0
5392c609719bSwdenk	VFS: Mounted root (ext2 filesystem).
5393c609719bSwdenk
5394c609719bSwdenk	bash#
5395c609719bSwdenk
53960267768eSMatthew McClintockBoot Linux and pass a flat device tree:
53970267768eSMatthew McClintock-----------
53980267768eSMatthew McClintock
53990267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section
54000267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The
54010267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated
54020267768eSMatthew McClintockflat device tree:
54030267768eSMatthew McClintock
54040267768eSMatthew McClintock=> print oftaddr
54050267768eSMatthew McClintockoftaddr=0x300000
54060267768eSMatthew McClintock=> print oft
54070267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb
54080267768eSMatthew McClintock=> tftp $oftaddr $oft
54090267768eSMatthew McClintockSpeed: 1000, full duplex
54100267768eSMatthew McClintockUsing TSEC0 device
54110267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101
54120267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'.
54130267768eSMatthew McClintockLoad address: 0x300000
54140267768eSMatthew McClintockLoading: #
54150267768eSMatthew McClintockdone
54160267768eSMatthew McClintockBytes transferred = 4106 (100a hex)
54170267768eSMatthew McClintock=> tftp $loadaddr $bootfile
54180267768eSMatthew McClintockSpeed: 1000, full duplex
54190267768eSMatthew McClintockUsing TSEC0 device
54200267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2
54210267768eSMatthew McClintockFilename 'uImage'.
54220267768eSMatthew McClintockLoad address: 0x200000
54230267768eSMatthew McClintockLoading:############
54240267768eSMatthew McClintockdone
54250267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex)
54260267768eSMatthew McClintock=> print loadaddr
54270267768eSMatthew McClintockloadaddr=200000
54280267768eSMatthew McClintock=> print oftaddr
54290267768eSMatthew McClintockoftaddr=0x300000
54300267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr
54310267768eSMatthew McClintock## Booting image at 00200000 ...
54320267768eSMatthew McClintock   Image Name:	 Linux-2.6.17-dirty
54330267768eSMatthew McClintock   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
54340267768eSMatthew McClintock   Data Size:	 1029343 Bytes = 1005.2 kB
54350267768eSMatthew McClintock   Load Address: 00000000
54360267768eSMatthew McClintock   Entry Point:	 00000000
54370267768eSMatthew McClintock   Verifying Checksum ... OK
54380267768eSMatthew McClintock   Uncompressing Kernel Image ... OK
54390267768eSMatthew McClintockBooting using flat device tree at 0x300000
54400267768eSMatthew McClintockUsing MPC85xx ADS machine description
54410267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
54420267768eSMatthew McClintock[snip]
54430267768eSMatthew McClintock
54440267768eSMatthew McClintock
54456069ff26SwdenkMore About U-Boot Image Types:
54466069ff26Swdenk------------------------------
54476069ff26Swdenk
54486069ff26SwdenkU-Boot supports the following image types:
54496069ff26Swdenk
54506069ff26Swdenk   "Standalone Programs" are directly runnable in the environment
54516069ff26Swdenk	provided by U-Boot; it is expected that (if they behave
54526069ff26Swdenk	well) you can continue to work in U-Boot after return from
54536069ff26Swdenk	the Standalone Program.
54546069ff26Swdenk   "OS Kernel Images" are usually images of some Embedded OS which
54556069ff26Swdenk	will take over control completely. Usually these programs
54566069ff26Swdenk	will install their own set of exception handlers, device
54576069ff26Swdenk	drivers, set up the MMU, etc. - this means, that you cannot
54586069ff26Swdenk	expect to re-enter U-Boot except by resetting the CPU.
54596069ff26Swdenk   "RAMDisk Images" are more or less just data blocks, and their
54606069ff26Swdenk	parameters (address, size) are passed to an OS kernel that is
54616069ff26Swdenk	being started.
54626069ff26Swdenk   "Multi-File Images" contain several images, typically an OS
54636069ff26Swdenk	(Linux) kernel image and one or more data images like
54646069ff26Swdenk	RAMDisks. This construct is useful for instance when you want
54656069ff26Swdenk	to boot over the network using BOOTP etc., where the boot
54666069ff26Swdenk	server provides just a single image file, but you want to get
54676069ff26Swdenk	for instance an OS kernel and a RAMDisk image.
54686069ff26Swdenk
54696069ff26Swdenk	"Multi-File Images" start with a list of image sizes, each
54706069ff26Swdenk	image size (in bytes) specified by an "uint32_t" in network
54716069ff26Swdenk	byte order. This list is terminated by an "(uint32_t)0".
54726069ff26Swdenk	Immediately after the terminating 0 follow the images, one by
54736069ff26Swdenk	one, all aligned on "uint32_t" boundaries (size rounded up to
54746069ff26Swdenk	a multiple of 4 bytes).
54756069ff26Swdenk
54766069ff26Swdenk   "Firmware Images" are binary images containing firmware (like
54776069ff26Swdenk	U-Boot or FPGA images) which usually will be programmed to
54786069ff26Swdenk	flash memory.
54796069ff26Swdenk
54806069ff26Swdenk   "Script files" are command sequences that will be executed by
54816069ff26Swdenk	U-Boot's command interpreter; this feature is especially
54826069ff26Swdenk	useful when you configure U-Boot to use a real shell (hush)
54836069ff26Swdenk	as command interpreter.
54846069ff26Swdenk
548544f074c7SMarek VasutBooting the Linux zImage:
548644f074c7SMarek Vasut-------------------------
548744f074c7SMarek Vasut
548844f074c7SMarek VasutOn some platforms, it's possible to boot Linux zImage. This is done
548944f074c7SMarek Vasutusing the "bootz" command. The syntax of "bootz" command is the same
549044f074c7SMarek Vasutas the syntax of "bootm" command.
549144f074c7SMarek Vasut
54928ac28563STom RiniNote, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
5493017e1f3fSMarek Vasutkernel with raw initrd images. The syntax is slightly different, the
5494017e1f3fSMarek Vasutaddress of the initrd must be augmented by it's size, in the following
5495017e1f3fSMarek Vasutformat: "<initrd addres>:<initrd size>".
5496017e1f3fSMarek Vasut
5497c609719bSwdenk
5498c609719bSwdenkStandalone HOWTO:
5499c609719bSwdenk=================
5500c609719bSwdenk
5501c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and
5502c609719bSwdenkrun "standalone" applications, which can use some resources of
5503c609719bSwdenkU-Boot like console I/O functions or interrupt services.
5504c609719bSwdenk
5505c609719bSwdenkTwo simple examples are included with the sources:
5506c609719bSwdenk
5507c609719bSwdenk"Hello World" Demo:
5508c609719bSwdenk-------------------
5509c609719bSwdenk
5510c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo
5511c609719bSwdenkapplication; it is automatically compiled when you build U-Boot.
5512c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it
5513c609719bSwdenklike that:
5514c609719bSwdenk
5515c609719bSwdenk	=> loads
5516c609719bSwdenk	## Ready for S-Record download ...
5517c609719bSwdenk	~>examples/hello_world.srec
5518c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
5519c609719bSwdenk	[file transfer complete]
5520c609719bSwdenk	[connected]
5521c609719bSwdenk	## Start Addr = 0x00040004
5522c609719bSwdenk
5523c609719bSwdenk	=> go 40004 Hello World! This is a test.
5524c609719bSwdenk	## Starting application at 0x00040004 ...
5525c609719bSwdenk	Hello World
5526c609719bSwdenk	argc = 7
5527c609719bSwdenk	argv[0] = "40004"
5528c609719bSwdenk	argv[1] = "Hello"
5529c609719bSwdenk	argv[2] = "World!"
5530c609719bSwdenk	argv[3] = "This"
5531c609719bSwdenk	argv[4] = "is"
5532c609719bSwdenk	argv[5] = "a"
5533c609719bSwdenk	argv[6] = "test."
5534c609719bSwdenk	argv[7] = "<NULL>"
5535c609719bSwdenk	Hit any key to exit ...
5536c609719bSwdenk
5537c609719bSwdenk	## Application terminated, rc = 0x0
5538c609719bSwdenk
5539c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt
5540c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'.
5541c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second.
5542c609719bSwdenkThe interrupt service routine is trivial, just printing a '.'
5543c609719bSwdenkcharacter, but this is just a demo program. The application can be
5544c609719bSwdenkcontrolled by the following keys:
5545c609719bSwdenk
5546c609719bSwdenk	? - print current values og the CPM Timer registers
5547c609719bSwdenk	b - enable interrupts and start timer
5548c609719bSwdenk	e - stop timer and disable interrupts
5549c609719bSwdenk	q - quit application
5550c609719bSwdenk
5551c609719bSwdenk	=> loads
5552c609719bSwdenk	## Ready for S-Record download ...
5553c609719bSwdenk	~>examples/timer.srec
5554c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
5555c609719bSwdenk	[file transfer complete]
5556c609719bSwdenk	[connected]
5557c609719bSwdenk	## Start Addr = 0x00040004
5558c609719bSwdenk
5559c609719bSwdenk	=> go 40004
5560c609719bSwdenk	## Starting application at 0x00040004 ...
5561c609719bSwdenk	TIMERS=0xfff00980
5562c609719bSwdenk	Using timer 1
5563c609719bSwdenk	  tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
5564c609719bSwdenk
5565c609719bSwdenkHit 'b':
5566c609719bSwdenk	[q, b, e, ?] Set interval 1000000 us
5567c609719bSwdenk	Enabling timer
5568c609719bSwdenkHit '?':
5569c609719bSwdenk	[q, b, e, ?] ........
5570c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
5571c609719bSwdenkHit '?':
5572c609719bSwdenk	[q, b, e, ?] .
5573c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
5574c609719bSwdenkHit '?':
5575c609719bSwdenk	[q, b, e, ?] .
5576c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
5577c609719bSwdenkHit '?':
5578c609719bSwdenk	[q, b, e, ?] .
5579c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
5580c609719bSwdenkHit 'e':
5581c609719bSwdenk	[q, b, e, ?] ...Stopping timer
5582c609719bSwdenkHit 'q':
5583c609719bSwdenk	[q, b, e, ?] ## Application terminated, rc = 0x0
5584c609719bSwdenk
5585c609719bSwdenk
558685ec0bccSwdenkMinicom warning:
558785ec0bccSwdenk================
558885ec0bccSwdenk
55897152b1d0SwdenkOver time, many people have reported problems when trying to use the
559085ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd)
559185ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under
5592f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and
559385ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and
5594e53515a2SKarl O. Pincuse "cu" for S-Record download ("loads" command).  See
5595e53515a2SKarl O. Pinchttp://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
5596e53515a2SKarl O. Pincfor help with kermit.
5597e53515a2SKarl O. Pinc
559885ec0bccSwdenk
559952f52c14SwdenkNevertheless, if you absolutely want to use it try adding this
560052f52c14Swdenkconfiguration to your "File transfer protocols" section:
560152f52c14Swdenk
560252f52c14Swdenk	   Name	   Program			Name U/D FullScr IO-Red. Multi
560352f52c14Swdenk	X  kermit  /usr/bin/kermit -i -l %l -s	 Y    U	   Y	   N	  N
560452f52c14Swdenk	Y  kermit  /usr/bin/kermit -i -l %l -r	 N    D	   Y	   N	  N
560552f52c14Swdenk
560652f52c14Swdenk
5607c609719bSwdenkNetBSD Notes:
5608c609719bSwdenk=============
5609c609719bSwdenk
5610c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host
5611c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx).
5612c609719bSwdenk
5613c609719bSwdenkBuilding requires a cross environment; it is known to work on
5614c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5615c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make).
5616c609719bSwdenkNote that the cross-powerpc package does not install include files;
5617c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is
5618c609719bSwdenkmissing.  This file has to be installed and patched manually:
5619c609719bSwdenk
5620c609719bSwdenk	# cd /usr/pkg/cross/powerpc-netbsd/include
5621c609719bSwdenk	# mkdir powerpc
5622c609719bSwdenk	# ln -s powerpc machine
5623c609719bSwdenk	# cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
5624c609719bSwdenk	# ${EDIT} powerpc/ansi.h	## must remove __va_list, _BSD_VA_LIST
5625c609719bSwdenk
5626c609719bSwdenkNative builds *don't* work due to incompatibilities between native
5627c609719bSwdenkand U-Boot include files.
5628c609719bSwdenk
5629c609719bSwdenkBooting assumes that (the first part of) the image booted is a
5630c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel
5631c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source
5632c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
56332a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
5634c609719bSwdenk
5635c609719bSwdenk
5636c609719bSwdenkImplementation Internals:
5637c609719bSwdenk=========================
5638c609719bSwdenk
5639c609719bSwdenkThe following is not intended to be a complete description of every
5640c609719bSwdenkimplementation detail. However, it should help to understand the
5641c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom
5642c609719bSwdenkhardware.
5643c609719bSwdenk
5644c609719bSwdenk
5645c609719bSwdenkInitial Stack, Global Data:
5646c609719bSwdenk---------------------------
5647c609719bSwdenk
5648c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot
5649c609719bSwdenkstarts running out of ROM (flash memory), usually without access to
5650c609719bSwdenksystem RAM (because the memory controller is not initialized yet).
5651c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS
5652c609719bSwdenkis not initialized as zero. To be able to get a C environment working
5653c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation
5654c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU
5655c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and
5656c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be
5657c609719bSwdenklocked as (mis-) used as memory, etc.
5658c609719bSwdenk
56597152b1d0Swdenk	Chris Hallinan posted a good summary of these issues to the
56600668236bSWolfgang Denk	U-Boot mailing list:
566143d9616cSwdenk
566243d9616cSwdenk	Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
566343d9616cSwdenk	From: "Chris Hallinan" <clh@net1plus.com>
566443d9616cSwdenk	Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
566543d9616cSwdenk	...
566643d9616cSwdenk
566743d9616cSwdenk	Correct me if I'm wrong, folks, but the way I understand it
566843d9616cSwdenk	is this: Using DCACHE as initial RAM for Stack, etc, does not
566943d9616cSwdenk	require any physical RAM backing up the cache. The cleverness
567043d9616cSwdenk	is that the cache is being used as a temporary supply of
567143d9616cSwdenk	necessary storage before the SDRAM controller is setup. It's
567211ccc33fSMarcel Ziswiler	beyond the scope of this list to explain the details, but you
567343d9616cSwdenk	can see how this works by studying the cache architecture and
567443d9616cSwdenk	operation in the architecture and processor-specific manuals.
567543d9616cSwdenk
567643d9616cSwdenk	OCM is On Chip Memory, which I believe the 405GP has 4K. It
567743d9616cSwdenk	is another option for the system designer to use as an
567811ccc33fSMarcel Ziswiler	initial stack/RAM area prior to SDRAM being available. Either
567943d9616cSwdenk	option should work for you. Using CS 4 should be fine if your
568043d9616cSwdenk	board designers haven't used it for something that would
568143d9616cSwdenk	cause you grief during the initial boot! It is frequently not
568243d9616cSwdenk	used.
568343d9616cSwdenk
56846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
568543d9616cSwdenk	with your processor/board/system design. The default value
568643d9616cSwdenk	you will find in any recent u-boot distribution in
56878a316c9bSStefan Roese	walnut.h should work for you. I'd set it to a value larger
568843d9616cSwdenk	than your SDRAM module. If you have a 64MB SDRAM module, set
568943d9616cSwdenk	it above 400_0000. Just make sure your board has no resources
569043d9616cSwdenk	that are supposed to respond to that address! That code in
569143d9616cSwdenk	start.S has been around a while and should work as is when
569243d9616cSwdenk	you get the config right.
569343d9616cSwdenk
569443d9616cSwdenk	-Chris Hallinan
569543d9616cSwdenk	DS4.COM, Inc.
569643d9616cSwdenk
5697c609719bSwdenkIt is essential to remember this, since it has some impact on the C
5698c609719bSwdenkcode for the initialization procedures:
5699c609719bSwdenk
5700c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt
5701c609719bSwdenk  to write it.
5702c609719bSwdenk
570311ccc33fSMarcel Ziswiler* Do not use any uninitialized global data (or implicitely initialized
5704c609719bSwdenk  as zero data - BSS segment) at all - this is undefined, initiali-
57057152b1d0Swdenk  zation is performed later (when relocating to RAM).
5706c609719bSwdenk
5707c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like
5708c609719bSwdenk  that.
5709c609719bSwdenk
5710c609719bSwdenkHaving only the stack as writable memory limits means we cannot use
5711c609719bSwdenknormal global data to share information beween the code. But it
5712c609719bSwdenkturned out that the implementation of U-Boot can be greatly
5713c609719bSwdenksimplified by making a global data structure (gd_t) available to all
5714c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_
5715c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of
5716c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we
5717c609719bSwdenkplace a pointer (gd) to the global data into a register which we
5718c609719bSwdenkreserve for this purpose.
5719c609719bSwdenk
57207152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the
5721c609719bSwdenkrelevant  (E)ABI  specifications for the current architecture, and by
5722c609719bSwdenkGCC's implementation.
5723c609719bSwdenk
5724c609719bSwdenkFor PowerPC, the following registers have specific use:
5725c609719bSwdenk	R1:	stack pointer
5726e7670f6cSWolfgang Denk	R2:	reserved for system use
5727c609719bSwdenk	R3-R4:	parameter passing and return values
5728c609719bSwdenk	R5-R10: parameter passing
5729c609719bSwdenk	R13:	small data area pointer
5730c609719bSwdenk	R30:	GOT pointer
5731c609719bSwdenk	R31:	frame pointer
5732c609719bSwdenk
5733e6bee808SJoakim Tjernlund	(U-Boot also uses R12 as internal GOT pointer. r12
5734e6bee808SJoakim Tjernlund	is a volatile register so r12 needs to be reset when
5735e6bee808SJoakim Tjernlund	going back and forth between asm and C)
5736c609719bSwdenk
5737e7670f6cSWolfgang Denk    ==> U-Boot will use R2 to hold a pointer to the global data
5738c609719bSwdenk
5739c609719bSwdenk    Note: on PPC, we could use a static initializer (since the
5740c609719bSwdenk    address of the global data structure is known at compile time),
5741c609719bSwdenk    but it turned out that reserving a register results in somewhat
5742c609719bSwdenk    smaller code - although the code savings are not that big (on
5743c609719bSwdenk    average for all boards 752 bytes for the whole U-Boot image,
5744c609719bSwdenk    624 text + 127 data).
5745c609719bSwdenk
5746c4db335cSRobin GetzOn Blackfin, the normal C ABI (except for P3) is followed as documented here:
57474c58eb55SMike Frysinger	http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
57484c58eb55SMike Frysinger
5749c4db335cSRobin Getz    ==> U-Boot will use P3 to hold a pointer to the global data
57504c58eb55SMike Frysinger
5751c609719bSwdenkOn ARM, the following registers are used:
5752c609719bSwdenk
5753c609719bSwdenk	R0:	function argument word/integer result
5754c609719bSwdenk	R1-R3:	function argument word
575512eba1b4SJeroen Hofstee	R9:	platform specific
575612eba1b4SJeroen Hofstee	R10:	stack limit (used only if stack checking is enabled)
5757c609719bSwdenk	R11:	argument (frame) pointer
5758c609719bSwdenk	R12:	temporary workspace
5759c609719bSwdenk	R13:	stack pointer
5760c609719bSwdenk	R14:	link register
5761c609719bSwdenk	R15:	program counter
5762c609719bSwdenk
576312eba1b4SJeroen Hofstee    ==> U-Boot will use R9 to hold a pointer to the global data
576412eba1b4SJeroen Hofstee
576512eba1b4SJeroen Hofstee    Note: on ARM, only R_ARM_RELATIVE relocations are supported.
5766c609719bSwdenk
57670df01fd3SThomas ChouOn Nios II, the ABI is documented here:
57680df01fd3SThomas Chou	http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
57690df01fd3SThomas Chou
57700df01fd3SThomas Chou    ==> U-Boot will use gp to hold a pointer to the global data
57710df01fd3SThomas Chou
57720df01fd3SThomas Chou    Note: on Nios II, we give "-G0" option to gcc and don't use gp
57730df01fd3SThomas Chou    to access small data sections, so gp is free.
57740df01fd3SThomas Chou
5775afc1ce82SMacpaul LinOn NDS32, the following registers are used:
5776afc1ce82SMacpaul Lin
5777afc1ce82SMacpaul Lin	R0-R1:	argument/return
5778afc1ce82SMacpaul Lin	R2-R5:	argument
5779afc1ce82SMacpaul Lin	R15:	temporary register for assembler
5780afc1ce82SMacpaul Lin	R16:	trampoline register
5781afc1ce82SMacpaul Lin	R28:	frame pointer (FP)
5782afc1ce82SMacpaul Lin	R29:	global pointer (GP)
5783afc1ce82SMacpaul Lin	R30:	link register (LP)
5784afc1ce82SMacpaul Lin	R31:	stack pointer (SP)
5785afc1ce82SMacpaul Lin	PC:	program counter (PC)
5786afc1ce82SMacpaul Lin
5787afc1ce82SMacpaul Lin    ==> U-Boot will use R10 to hold a pointer to the global data
5788afc1ce82SMacpaul Lin
5789d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5790d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much.
5791c609719bSwdenk
5792c609719bSwdenkMemory Management:
5793c609719bSwdenk------------------
5794c609719bSwdenk
5795c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the
5796c609719bSwdenkMMU is not used either for address mapping nor for memory protection.
5797c609719bSwdenk
5798c609719bSwdenkThe available memory is mapped to fixed addresses using the memory
5799c609719bSwdenkcontroller. In this process, a contiguous block is formed for each
5800c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several
5801c609719bSwdenkphysical memory banks.
5802c609719bSwdenk
5803c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on
5804c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5805c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself
5806c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some
58076d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
5808c609719bSwdenkconfiguration setting]. Below that, a structure with global Board
5809c609719bSwdenkInfo data is placed, followed by the stack (growing downward).
5810c609719bSwdenk
5811c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB
5812c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF).
5813c609719bSwdenk
5814c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like
5815c609719bSwdenkthis:
5816c609719bSwdenk
5817c609719bSwdenk	0x0000 0000	Exception Vector code
5818c609719bSwdenk	      :
5819c609719bSwdenk	0x0000 1FFF
5820c609719bSwdenk	0x0000 2000	Free for Application Use
5821c609719bSwdenk	      :
5822c609719bSwdenk	      :
5823c609719bSwdenk
5824c609719bSwdenk	      :
5825c609719bSwdenk	      :
5826c609719bSwdenk	0x00FB FF20	Monitor Stack (Growing downward)
5827c609719bSwdenk	0x00FB FFAC	Board Info Data and permanent copy of global data
5828c609719bSwdenk	0x00FC 0000	Malloc Arena
5829c609719bSwdenk	      :
5830c609719bSwdenk	0x00FD FFFF
5831c609719bSwdenk	0x00FE 0000	RAM Copy of Monitor Code
5832c609719bSwdenk	...		eventually: LCD or video framebuffer
5833c609719bSwdenk	...		eventually: pRAM (Protected RAM - unchanged by reset)
5834c609719bSwdenk	0x00FF FFFF	[End of RAM]
5835c609719bSwdenk
5836c609719bSwdenk
5837c609719bSwdenkSystem Initialization:
5838c609719bSwdenk----------------------
5839c609719bSwdenk
5840c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point
584111ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset
5842c609719bSwdenkconfiguration for CS0# this is a mirror of the onboard Flash memory.
58437152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address.
5844c609719bSwdenkTo be able to implement the initialization code in C, a (small!)
5845c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs
5846c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked
5847c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core,
5848c609719bSwdenkthe caches and the SIU.
5849c609719bSwdenk
5850c609719bSwdenkNext, all (potentially) available memory banks are mapped using a
5851c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries
5852c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5853c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5854c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a
5855c609719bSwdenksimple memory test is run that determines the size of the SDRAM
5856c609719bSwdenkbanks.
5857c609719bSwdenk
5858c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of
58597152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first
5860c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address
5861c609719bSwdenk0x00000000, with any additional banks following immediately to create
5862c609719bSwdenkcontiguous memory starting from 0.
5863c609719bSwdenk
5864c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area
5865c609719bSwdenkand allocates memory for use by malloc() and for the global Board
5866c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM
5867c609719bSwdenkpages, and the final stack is set up.
5868c609719bSwdenk
5869c609719bSwdenkOnly after this relocation will you have a "normal" C environment;
5870c609719bSwdenkuntil that you are restricted in several ways, mostly because you are
5871c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a
5872c609719bSwdenknew address in RAM.
5873c609719bSwdenk
5874c609719bSwdenk
5875c609719bSwdenkU-Boot Porting Guide:
5876c609719bSwdenk----------------------
5877c609719bSwdenk
5878c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
58796aff3115Swdenklist, October 2002]
5880c609719bSwdenk
5881c609719bSwdenk
5882c609719bSwdenkint main(int argc, char *argv[])
5883c609719bSwdenk{
5884c609719bSwdenk	sighandler_t no_more_time;
5885c609719bSwdenk
5886c609719bSwdenk	signal(SIGALRM, no_more_time);
5887c609719bSwdenk	alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
5888c609719bSwdenk
5889c609719bSwdenk	if (available_money > available_manpower) {
58906c3fef28SJerry Van Baren		Pay consultant to port U-Boot;
5891c609719bSwdenk		return 0;
5892c609719bSwdenk	}
5893c609719bSwdenk
5894c609719bSwdenk	Download latest U-Boot source;
5895c609719bSwdenk
58960668236bSWolfgang Denk	Subscribe to u-boot mailing list;
58976aff3115Swdenk
58986c3fef28SJerry Van Baren	if (clueless)
5899c609719bSwdenk		email("Hi, I am new to U-Boot, how do I get started?");
5900c609719bSwdenk
5901c609719bSwdenk	while (learning) {
5902c609719bSwdenk		Read the README file in the top level directory;
59037cb22f97Swdenk		Read http://www.denx.de/twiki/bin/view/DULG/Manual;
59046c3fef28SJerry Van Baren		Read applicable doc/*.README;
5905c609719bSwdenk		Read the source, Luke;
59066c3fef28SJerry Van Baren		/* find . -name "*.[chS]" | xargs grep -i <keyword> */
5907c609719bSwdenk	}
5908c609719bSwdenk
59096c3fef28SJerry Van Baren	if (available_money > toLocalCurrency ($2500))
59106c3fef28SJerry Van Baren		Buy a BDI3000;
59116c3fef28SJerry Van Baren	else
5912c609719bSwdenk		Add a lot of aggravation and time;
5913c609719bSwdenk
59146c3fef28SJerry Van Baren	if (a similar board exists) {	/* hopefully... */
59156c3fef28SJerry Van Baren		cp -a board/<similar> board/<myboard>
59166c3fef28SJerry Van Baren		cp include/configs/<similar>.h include/configs/<myboard>.h
59176c3fef28SJerry Van Baren	} else {
5918c609719bSwdenk		Create your own board support subdirectory;
59196c3fef28SJerry Van Baren		Create your own board include/configs/<myboard>.h file;
59206c3fef28SJerry Van Baren	}
59216c3fef28SJerry Van Baren	Edit new board/<myboard> files
59226c3fef28SJerry Van Baren	Edit new include/configs/<myboard>.h
5923c609719bSwdenk
59246c3fef28SJerry Van Baren	while (!accepted) {
5925c609719bSwdenk		while (!running) {
5926c609719bSwdenk			do {
5927c609719bSwdenk				Add / modify source code;
5928c609719bSwdenk			} until (compiles);
5929c609719bSwdenk			Debug;
5930c609719bSwdenk			if (clueless)
5931c609719bSwdenk				email("Hi, I am having problems...");
5932c609719bSwdenk		}
59336c3fef28SJerry Van Baren		Send patch file to the U-Boot email list;
59346c3fef28SJerry Van Baren		if (reasonable critiques)
59356c3fef28SJerry Van Baren			Incorporate improvements from email list code review;
59366c3fef28SJerry Van Baren		else
59376c3fef28SJerry Van Baren			Defend code as written;
59386c3fef28SJerry Van Baren	}
5939c609719bSwdenk
5940c609719bSwdenk	return 0;
5941c609719bSwdenk}
5942c609719bSwdenk
5943c609719bSwdenkvoid no_more_time (int sig)
5944c609719bSwdenk{
5945c609719bSwdenk      hire_a_guru();
5946c609719bSwdenk}
5947c609719bSwdenk
5948c609719bSwdenk
5949c609719bSwdenkCoding Standards:
5950c609719bSwdenk-----------------
5951c609719bSwdenk
5952c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel
59532c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script
59547ca9296eSWolfgang Denk"scripts/Lindent" in your Linux kernel source directory.
5955c609719bSwdenk
59562c051651SDetlev ZundelSource files originating from a different project (for example the
59572c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not
59582c051651SDetlev Zundelreformated to ease subsequent migration to newer versions of those
59592c051651SDetlev Zundelsources.
59602c051651SDetlev Zundel
59612c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in
59622c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//)
59632c051651SDetlev Zundelin your code.
5964c609719bSwdenk
5965c178d3daSwdenkPlease also stick to the following formatting rules:
5966180d3f74Swdenk- remove any trailing white space
59677ca9296eSWolfgang Denk- use TAB characters for indentation and vertical alignment, not spaces
5968180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds
59697ca9296eSWolfgang Denk- do not add more than 2 consecutive empty lines to source files
5970180d3f74Swdenk- do not add trailing empty lines to source files
5971180d3f74Swdenk
5972c609719bSwdenkSubmissions which do not conform to the standards may be returned
5973c609719bSwdenkwith a request to reformat the changes.
5974c609719bSwdenk
5975c609719bSwdenk
5976c609719bSwdenkSubmitting Patches:
5977c609719bSwdenk-------------------
5978c609719bSwdenk
5979c609719bSwdenkSince the number of patches for U-Boot is growing, we need to
5980c609719bSwdenkestablish some rules. Submissions which do not conform to these rules
5981c609719bSwdenkmay be rejected, even when they contain important and valuable stuff.
5982c609719bSwdenk
59830d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details.
5984218ca724SWolfgang Denk
59850668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
59860668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot
59870668236bSWolfgang Denk
5988c609719bSwdenkWhen you send a patch, please include the following information with
5989c609719bSwdenkit:
5990c609719bSwdenk
5991c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes
5992c609719bSwdenk  this bug. Please try to include a way of demonstrating that the
5993c609719bSwdenk  patch actually fixes something.
5994c609719bSwdenk
5995c609719bSwdenk* For new features: a description of the feature and your
5996c609719bSwdenk  implementation.
5997c609719bSwdenk
5998c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch)
5999c609719bSwdenk
6000c609719bSwdenk* For major contributions, your entry to the CREDITS file
6001c609719bSwdenk
600227af930eSAlbert ARIBAUD* When you add support for a new board, don't forget to add a
600327af930eSAlbert ARIBAUD  maintainer e-mail address to the boards.cfg file, too.
6004c609719bSwdenk
6005c609719bSwdenk* If your patch adds new configuration options, don't forget to
6006c609719bSwdenk  document these in the README file.
6007c609719bSwdenk
6008218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly*
6009218ca724SWolfgang Denk  recommended) you can easily generate the patch using the
60107ca9296eSWolfgang Denk  "git format-patch". If you then use "git send-email" to send it to
6011218ca724SWolfgang Denk  the U-Boot mailing list, you will avoid most of the common problems
6012218ca724SWolfgang Denk  with some other mail clients.
6013c609719bSwdenk
6014218ca724SWolfgang Denk  If you cannot use git, use "diff -purN OLD NEW". If your version of
6015218ca724SWolfgang Denk  diff does not support these options, then get the latest version of
6016218ca724SWolfgang Denk  GNU diff.
60176dff5529Swdenk
6018218ca724SWolfgang Denk  The current directory when running this command shall be the parent
6019218ca724SWolfgang Denk  directory of the U-Boot source tree (i. e. please make sure that
6020218ca724SWolfgang Denk  your patch includes sufficient directory information for the
6021218ca724SWolfgang Denk  affected files).
6022218ca724SWolfgang Denk
6023218ca724SWolfgang Denk  We prefer patches as plain text. MIME attachments are discouraged,
6024218ca724SWolfgang Denk  and compressed attachments must not be used.
6025c609719bSwdenk
602652f52c14Swdenk* If one logical set of modifications affects or creates several
602752f52c14Swdenk  files, all these changes shall be submitted in a SINGLE patch file.
602852f52c14Swdenk
602952f52c14Swdenk* Changesets that contain different, unrelated modifications shall be
603052f52c14Swdenk  submitted as SEPARATE patches, one patch per changeset.
603152f52c14Swdenk
603252f52c14Swdenk
6033c609719bSwdenkNotes:
6034c609719bSwdenk
6035c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched
6036c609719bSwdenk  source tree and make sure that no errors or warnings are reported
6037c609719bSwdenk  for any of the boards.
6038c609719bSwdenk
6039c609719bSwdenk* Keep your modifications to the necessary minimum: A patch
6040c609719bSwdenk  containing several unrelated changes or arbitrary reformats will be
6041c609719bSwdenk  returned with a request to re-formatting / split it.
6042c609719bSwdenk
6043c609719bSwdenk* If you modify existing code, make sure that your new code does not
6044c609719bSwdenk  add to the memory footprint of the code ;-) Small is beautiful!
6045c609719bSwdenk  When adding new features, these should compile conditionally only
6046c609719bSwdenk  (using #ifdef), and the resulting code with the new feature
6047c609719bSwdenk  disabled must not need more memory than the old code without your
6048c609719bSwdenk  modification.
604990dc6704Swdenk
60500668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the
60510668236bSWolfgang Denk  u-boot mailing list. Bigger patches will be moderated. If they are
60520668236bSWolfgang Denk  reasonable and not too big, they will be acknowledged. But patches
60530668236bSWolfgang Denk  bigger than the size limit should be avoided.
6054