xref: /openbmc/u-boot/README (revision 3aab70afc531d1eea0e6fcfcf49001163ad13137)
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
1356eae68e4SMasahiro Yamada  /arc			Files generic to ARC architecture
1366eae68e4SMasahiro Yamada    /cpu		CPU specific files
1376eae68e4SMasahiro Yamada      /arc700		Files specific to ARC 700 CPUs
1386eae68e4SMasahiro Yamada    /lib		Architecture specific library files
1398d321b81SPeter Tyser  /arm			Files generic to ARM architecture
1408d321b81SPeter Tyser    /cpu		CPU specific files
1418d321b81SPeter Tyser      /arm720t		Files specific to ARM 720 CPUs
1428d321b81SPeter Tyser      /arm920t		Files specific to ARM 920 CPUs
1436eb0921aSAndreas Bießmann	/at91		Files specific to Atmel AT91RM9200 CPU
1448d321b81SPeter Tyser	/imx		Files specific to Freescale MC9328 i.MX CPUs
1458d321b81SPeter Tyser	/s3c24x0	Files specific to Samsung S3C24X0 CPUs
1468d321b81SPeter Tyser      /arm926ejs	Files specific to ARM 926 CPUs
1478d321b81SPeter Tyser      /arm1136		Files specific to ARM 1136 CPUs
1488d321b81SPeter Tyser      /pxa		Files specific to Intel XScale PXA CPUs
1498d321b81SPeter Tyser      /sa1100		Files specific to Intel StrongARM SA1100 CPUs
1508d321b81SPeter Tyser    /lib		Architecture specific library files
1518d321b81SPeter Tyser  /avr32		Files generic to AVR32 architecture
1528d321b81SPeter Tyser    /cpu		CPU specific files
1538d321b81SPeter Tyser    /lib		Architecture specific library files
1548d321b81SPeter Tyser  /blackfin		Files generic to Analog Devices Blackfin architecture
1558d321b81SPeter Tyser    /cpu		CPU specific files
1568d321b81SPeter Tyser    /lib		Architecture specific library files
1578d321b81SPeter Tyser  /m68k			Files generic to m68k architecture
1588d321b81SPeter Tyser    /cpu		CPU specific files
1598d321b81SPeter Tyser      /mcf52x2		Files specific to Freescale ColdFire MCF52x2 CPUs
1608d321b81SPeter Tyser      /mcf5227x		Files specific to Freescale ColdFire MCF5227x CPUs
1618d321b81SPeter Tyser      /mcf532x		Files specific to Freescale ColdFire MCF5329 CPUs
1628d321b81SPeter Tyser      /mcf5445x		Files specific to Freescale ColdFire MCF5445x CPUs
1638d321b81SPeter Tyser      /mcf547x_8x	Files specific to Freescale ColdFire MCF547x_8x CPUs
1648d321b81SPeter Tyser    /lib		Architecture specific library files
1658d321b81SPeter Tyser  /microblaze		Files generic to microblaze architecture
1668d321b81SPeter Tyser    /cpu		CPU specific files
1678d321b81SPeter Tyser    /lib		Architecture specific library files
1688d321b81SPeter Tyser  /mips			Files generic to MIPS architecture
1698d321b81SPeter Tyser    /cpu		CPU specific files
17092bbd64eSDaniel Schwierzeck      /mips32		Files specific to MIPS32 CPUs
1716eae68e4SMasahiro Yamada      /mips64		Files specific to MIPS64 CPUs
1728d321b81SPeter Tyser    /lib		Architecture specific library files
173afc1ce82SMacpaul Lin  /nds32		Files generic to NDS32 architecture
174afc1ce82SMacpaul Lin    /cpu		CPU specific files
175afc1ce82SMacpaul Lin      /n1213		Files specific to Andes Technology N1213 CPUs
176afc1ce82SMacpaul Lin    /lib		Architecture specific library files
1778d321b81SPeter Tyser  /nios2		Files generic to Altera NIOS2 architecture
1788d321b81SPeter Tyser    /cpu		CPU specific files
1798d321b81SPeter Tyser    /lib		Architecture specific library files
18033c7731bSRobert P. J. Day  /openrisc		Files generic to OpenRISC architecture
18133c7731bSRobert P. J. Day    /cpu		CPU specific files
18233c7731bSRobert P. J. Day    /lib		Architecture specific library files
183a47a12beSStefan Roese  /powerpc		Files generic to PowerPC architecture
1848d321b81SPeter Tyser    /cpu		CPU specific files
1858d321b81SPeter Tyser      /74xx_7xx		Files specific to Freescale MPC74xx and 7xx CPUs
1868d321b81SPeter Tyser      /mpc5xx		Files specific to Freescale MPC5xx CPUs
1878d321b81SPeter Tyser      /mpc5xxx		Files specific to Freescale MPC5xxx CPUs
1888d321b81SPeter Tyser      /mpc8xx		Files specific to Freescale MPC8xx CPUs
1898d321b81SPeter Tyser      /mpc824x		Files specific to Freescale MPC824x CPUs
1908d321b81SPeter Tyser      /mpc8260		Files specific to Freescale MPC8260 CPUs
1918d321b81SPeter Tyser      /mpc85xx		Files specific to Freescale MPC85xx CPUs
1928d321b81SPeter Tyser      /ppc4xx		Files specific to AMCC PowerPC 4xx CPUs
1938d321b81SPeter Tyser    /lib		Architecture specific library files
1948d321b81SPeter Tyser  /sh			Files generic to SH architecture
1958d321b81SPeter Tyser    /cpu		CPU specific files
1968d321b81SPeter Tyser      /sh2		Files specific to sh2 CPUs
1978d321b81SPeter Tyser      /sh3		Files specific to sh3 CPUs
1988d321b81SPeter Tyser      /sh4		Files specific to sh4 CPUs
1998d321b81SPeter Tyser    /lib		Architecture specific library files
2008d321b81SPeter Tyser  /sparc		Files generic to SPARC architecture
2018d321b81SPeter Tyser    /cpu		CPU specific files
2028d321b81SPeter Tyser      /leon2		Files specific to Gaisler LEON2 SPARC CPU
2038d321b81SPeter Tyser      /leon3		Files specific to Gaisler LEON3 SPARC CPU
2048d321b81SPeter Tyser    /lib		Architecture specific library files
20533c7731bSRobert P. J. Day  /x86			Files generic to x86 architecture
20633c7731bSRobert P. J. Day    /cpu		CPU specific files
20733c7731bSRobert P. J. Day    /lib		Architecture specific library files
2088d321b81SPeter Tyser/api			Machine/arch independent API for external apps
2098d321b81SPeter Tyser/board			Board dependent files
2108d321b81SPeter Tyser/common			Misc architecture independent functions
2118d321b81SPeter Tyser/disk			Code for disk drive partition handling
2128d321b81SPeter Tyser/doc			Documentation (don't expect too much)
2138d321b81SPeter Tyser/drivers		Commonly used device drivers
21433c7731bSRobert P. J. Day/dts			Contains Makefile for building internal U-Boot fdt.
2158d321b81SPeter Tyser/examples		Example code for standalone applications, etc.
2168d321b81SPeter Tyser/fs			Filesystem code (cramfs, ext2, jffs2, etc.)
2178d321b81SPeter Tyser/include		Header Files
2188d321b81SPeter Tyser/lib			Files generic to all architectures
2198d321b81SPeter Tyser  /libfdt		Library files to support flattened device trees
2208d321b81SPeter Tyser  /lzma			Library files to support LZMA decompression
2218d321b81SPeter Tyser  /lzo			Library files to support LZO decompression
2228d321b81SPeter Tyser/net			Networking code
2238d321b81SPeter Tyser/post			Power On Self Test
22433c7731bSRobert P. J. Day/spl			Secondary Program Loader framework
2258d321b81SPeter Tyser/tools			Tools to build S-Record or U-Boot images, etc.
226c609719bSwdenk
227c609719bSwdenkSoftware Configuration:
228c609719bSwdenk=======================
229c609719bSwdenk
230c609719bSwdenkConfiguration is usually done using C preprocessor defines; the
231c609719bSwdenkrationale behind that is to avoid dead code whenever possible.
232c609719bSwdenk
233c609719bSwdenkThere are two classes of configuration variables:
234c609719bSwdenk
235c609719bSwdenk* Configuration _OPTIONS_:
236c609719bSwdenk  These are selectable by the user and have names beginning with
237c609719bSwdenk  "CONFIG_".
238c609719bSwdenk
239c609719bSwdenk* Configuration _SETTINGS_:
240c609719bSwdenk  These depend on the hardware etc. and should not be meddled with if
241c609719bSwdenk  you don't know what you're doing; they have names beginning with
2426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  "CONFIG_SYS_".
243c609719bSwdenk
244c609719bSwdenkLater we will add a configuration tool - probably similar to or even
245c609719bSwdenkidentical to what's used for the Linux kernel. Right now, we have to
246c609719bSwdenkdo the configuration by hand, which means creating some symbolic
247c609719bSwdenklinks and editing some configuration files. We use the TQM8xxL boards
248c609719bSwdenkas an example here.
249c609719bSwdenk
250c609719bSwdenk
251c609719bSwdenkSelection of Processor Architecture and Board Type:
252c609719bSwdenk---------------------------------------------------
253c609719bSwdenk
254c609719bSwdenkFor all supported boards there are ready-to-use default
255c609719bSwdenkconfigurations available; just type "make <board_name>_config".
256c609719bSwdenk
257c609719bSwdenkExample: For a TQM823L module type:
258c609719bSwdenk
259c609719bSwdenk	cd u-boot
260c609719bSwdenk	make TQM823L_config
261c609719bSwdenk
26211ccc33fSMarcel ZiswilerFor the Cogent platform, you need to specify the CPU type as well;
263c609719bSwdenke.g. "make cogent_mpc8xx_config". And also configure the cogent
264c609719bSwdenkdirectory according to the instructions in cogent/README.
265c609719bSwdenk
266c609719bSwdenk
267c609719bSwdenkConfiguration Options:
268c609719bSwdenk----------------------
269c609719bSwdenk
270c609719bSwdenkConfiguration depends on the combination of board and CPU type; all
271c609719bSwdenksuch information is kept in a configuration file
272c609719bSwdenk"include/configs/<board_name>.h".
273c609719bSwdenk
274c609719bSwdenkExample: For a TQM823L module, all configuration settings are in
275c609719bSwdenk"include/configs/TQM823L.h".
276c609719bSwdenk
277c609719bSwdenk
2787f6c2cbcSwdenkMany of the options are named exactly as the corresponding Linux
2797f6c2cbcSwdenkkernel configuration options. The intention is to make it easier to
2807f6c2cbcSwdenkbuild a config tool - later.
2817f6c2cbcSwdenk
2827f6c2cbcSwdenk
283c609719bSwdenkThe following options need to be configured:
284c609719bSwdenk
2852628114eSKim Phillips- CPU Type:	Define exactly one, e.g. CONFIG_MPC85XX.
286c609719bSwdenk
2872628114eSKim Phillips- Board Type:	Define exactly one, e.g. CONFIG_MPC8540ADS.
2886ccec449SWolfgang Denk
2896ccec449SWolfgang Denk- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
29009ea0de0SHaavard Skinnemoen		Define exactly one, e.g. CONFIG_ATSTK1002
291c609719bSwdenk
292c609719bSwdenk- CPU Module Type: (if CONFIG_COGENT is defined)
293c609719bSwdenk		Define exactly one of
294c609719bSwdenk		CONFIG_CMA286_60_OLD
295c609719bSwdenk--- FIXME --- not tested yet:
296c609719bSwdenk		CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
297c609719bSwdenk		CONFIG_CMA287_23, CONFIG_CMA287_50
298c609719bSwdenk
299c609719bSwdenk- Motherboard Type: (if CONFIG_COGENT is defined)
300c609719bSwdenk		Define exactly one of
301c609719bSwdenk		CONFIG_CMA101, CONFIG_CMA102
302c609719bSwdenk
303c609719bSwdenk- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
304c609719bSwdenk		Define one or more of
305c609719bSwdenk		CONFIG_CMA302
306c609719bSwdenk
307c609719bSwdenk- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
308c609719bSwdenk		Define one or more of
309c609719bSwdenk		CONFIG_LCD_HEARTBEAT	- update a character position on
31011ccc33fSMarcel Ziswiler					  the LCD display every second with
311c609719bSwdenk					  a "rotator" |\-/|\-/
312c609719bSwdenk
3132535d602Swdenk- Board flavour: (if CONFIG_MPC8260ADS is defined)
3142535d602Swdenk		CONFIG_ADSTYPE
3152535d602Swdenk		Possible values are:
3166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8260ADS	- original MPC8260ADS
3176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8266ADS	- MPC8266ADS
3186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_PQ2FADS	- PQ2FADS-ZU or PQ2FADS-VR
3196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8272ADS	- MPC8272ADS
3202535d602Swdenk
321cf946c6dSLei Wen- Marvell Family Member
322cf946c6dSLei Wen		CONFIG_SYS_MVFS		- define it if you want to enable
323cf946c6dSLei Wen					  multiple fs option at one time
324cf946c6dSLei Wen					  for marvell soc family
325cf946c6dSLei Wen
326c609719bSwdenk- MPC824X Family Member (if CONFIG_MPC824X is defined)
327c609719bSwdenk		Define exactly one of
328c609719bSwdenk		CONFIG_MPC8240, CONFIG_MPC8245
329c609719bSwdenk
33011ccc33fSMarcel Ziswiler- 8xx CPU Options: (if using an MPC8xx CPU)
33166ca92a5Swdenk		CONFIG_8xx_GCLK_FREQ	- deprecated: CPU clock if
33266ca92a5Swdenk					  get_gclk_freq() cannot work
3335da627a4Swdenk					  e.g. if there is no 32KHz
3345da627a4Swdenk					  reference PIT/RTC clock
33566ca92a5Swdenk		CONFIG_8xx_OSCLK	- PLL input clock (either EXTCLK
33666ca92a5Swdenk					  or XTAL/EXTAL)
337c609719bSwdenk
33866ca92a5Swdenk- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
3396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MIN
3406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MAX
34166ca92a5Swdenk		CONFIG_8xx_CPUCLK_DEFAULT
34275d1ea7fSwdenk			See doc/README.MPC866
34375d1ea7fSwdenk
3446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MEASURE_CPUCLK
34575d1ea7fSwdenk
34675d1ea7fSwdenk		Define this to measure the actual CPU clock instead
34775d1ea7fSwdenk		of relying on the correctness of the configured
34875d1ea7fSwdenk		values. Mostly useful for board bringup to make sure
34975d1ea7fSwdenk		the PLL is locked at the intended frequency. Note
35075d1ea7fSwdenk		that this requires a (stable) reference clock (32 kHz
3516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		RTC clock or CONFIG_SYS_8XX_XIN)
35275d1ea7fSwdenk
353506f3918SHeiko Schocher		CONFIG_SYS_DELAYED_ICACHE
354506f3918SHeiko Schocher
355506f3918SHeiko Schocher		Define this option if you want to enable the
356506f3918SHeiko Schocher		ICache only when Code runs from RAM.
357506f3918SHeiko Schocher
35866412c63SKumar Gala- 85xx CPU Options:
359ffd06e02SYork Sun		CONFIG_SYS_PPC64
360ffd06e02SYork Sun
361ffd06e02SYork Sun		Specifies that the core is a 64-bit PowerPC implementation (implements
362ffd06e02SYork Sun		the "64" category of the Power ISA). This is necessary for ePAPR
363ffd06e02SYork Sun		compliance, among other possible reasons.
364ffd06e02SYork Sun
36566412c63SKumar Gala		CONFIG_SYS_FSL_TBCLK_DIV
36666412c63SKumar Gala
36766412c63SKumar Gala		Defines the core time base clock divider ratio compared to the
36866412c63SKumar Gala		system clock.  On most PQ3 devices this is 8, on newer QorIQ
36966412c63SKumar Gala		devices it can be 16 or 32.  The ratio varies from SoC to Soc.
37066412c63SKumar Gala
3718f29084aSKumar Gala		CONFIG_SYS_FSL_PCIE_COMPAT
3728f29084aSKumar Gala
3738f29084aSKumar Gala		Defines the string to utilize when trying to match PCIe device
3748f29084aSKumar Gala		tree nodes for the given platform.
3758f29084aSKumar Gala
376afa6b551SPrabhakar Kushwaha		CONFIG_SYS_PPC_E500_DEBUG_TLB
377afa6b551SPrabhakar Kushwaha
378afa6b551SPrabhakar Kushwaha		Enables a temporary TLB entry to be used during boot to work
379afa6b551SPrabhakar Kushwaha		around limitations in e500v1 and e500v2 external debugger
380afa6b551SPrabhakar Kushwaha		support. This reduces the portions of the boot code where
381afa6b551SPrabhakar Kushwaha		breakpoints and single stepping do not work.  The value of this
382afa6b551SPrabhakar Kushwaha		symbol should be set to the TLB1 entry to be used for this
383afa6b551SPrabhakar Kushwaha		purpose.
384afa6b551SPrabhakar Kushwaha
38533eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510
38633eee330SScott Wood
38733eee330SScott Wood		Enables a workaround for erratum A004510.  If set,
38833eee330SScott Wood		then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
38933eee330SScott Wood		CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
39033eee330SScott Wood
39133eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
39233eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
39333eee330SScott Wood
39433eee330SScott Wood		Defines one or two SoC revisions (low 8 bits of SVR)
39533eee330SScott Wood		for which the A004510 workaround should be applied.
39633eee330SScott Wood
39733eee330SScott Wood		The rest of SVR is either not relevant to the decision
39833eee330SScott Wood		of whether the erratum is present (e.g. p2040 versus
39933eee330SScott Wood		p2041) or is implied by the build target, which controls
40033eee330SScott Wood		whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
40133eee330SScott Wood
40233eee330SScott Wood		See Freescale App Note 4493 for more information about
40333eee330SScott Wood		this erratum.
40433eee330SScott Wood
40574fa22edSPrabhakar Kushwaha		CONFIG_A003399_NOR_WORKAROUND
40674fa22edSPrabhakar Kushwaha		Enables a workaround for IFC erratum A003399. It is only
40774fa22edSPrabhakar Kushwaha		requred during NOR boot.
40874fa22edSPrabhakar Kushwaha
40933eee330SScott Wood		CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
41033eee330SScott Wood
41133eee330SScott Wood		This is the value to write into CCSR offset 0x18600
41233eee330SScott Wood		according to the A004510 workaround.
41333eee330SScott Wood
41464501c66SPriyanka Jain		CONFIG_SYS_FSL_DSP_DDR_ADDR
41564501c66SPriyanka Jain		This value denotes start offset of DDR memory which is
41664501c66SPriyanka Jain		connected exclusively to the DSP cores.
41764501c66SPriyanka Jain
418765b0bdbSPriyanka Jain		CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
419765b0bdbSPriyanka Jain		This value denotes start offset of M2 memory
420765b0bdbSPriyanka Jain		which is directly connected to the DSP core.
421765b0bdbSPriyanka Jain
42264501c66SPriyanka Jain		CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
42364501c66SPriyanka Jain		This value denotes start offset of M3 memory which is directly
42464501c66SPriyanka Jain		connected to the DSP core.
42564501c66SPriyanka Jain
426765b0bdbSPriyanka Jain		CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
427765b0bdbSPriyanka Jain		This value denotes start offset of DSP CCSR space.
428765b0bdbSPriyanka Jain
429b135991aSPriyanka Jain		CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
430b135991aSPriyanka Jain		Single Source Clock is clocking mode present in some of FSL SoC's.
431b135991aSPriyanka Jain		In this mode, a single differential clock is used to supply
432b135991aSPriyanka Jain		clocks to the sysclock, ddrclock and usbclock.
433b135991aSPriyanka Jain
434fb4a2409SAneesh Bansal		CONFIG_SYS_CPC_REINIT_F
435fb4a2409SAneesh Bansal		This CONFIG is defined when the CPC is configured as SRAM at the
436fb4a2409SAneesh Bansal		time of U-boot entry and is required to be re-initialized.
437fb4a2409SAneesh Bansal
438aade2004STang Yuantian		CONFIG_DEEP_SLEEP
439aade2004STang Yuantian		Inidcates this SoC supports deep sleep feature. If deep sleep is
440aade2004STang Yuantian		supported, core will start to execute uboot when wakes up.
441aade2004STang Yuantian
4426cb461b4SDaniel Schwierzeck- Generic CPU options:
4436cb461b4SDaniel Schwierzeck		CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
4446cb461b4SDaniel Schwierzeck
4456cb461b4SDaniel Schwierzeck		Defines the endianess of the CPU. Implementation of those
4466cb461b4SDaniel Schwierzeck		values is arch specific.
4476cb461b4SDaniel Schwierzeck
4485614e71bSYork Sun		CONFIG_SYS_FSL_DDR
4495614e71bSYork Sun		Freescale DDR driver in use. This type of DDR controller is
4505614e71bSYork Sun		found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
4515614e71bSYork Sun		SoCs.
4525614e71bSYork Sun
4535614e71bSYork Sun		CONFIG_SYS_FSL_DDR_ADDR
4545614e71bSYork Sun		Freescale DDR memory-mapped register base.
4555614e71bSYork Sun
4565614e71bSYork Sun		CONFIG_SYS_FSL_DDR_EMU
4575614e71bSYork Sun		Specify emulator support for DDR. Some DDR features such as
4585614e71bSYork Sun		deskew training are not available.
4595614e71bSYork Sun
4605614e71bSYork Sun		CONFIG_SYS_FSL_DDRC_GEN1
4615614e71bSYork Sun		Freescale DDR1 controller.
4625614e71bSYork Sun
4635614e71bSYork Sun		CONFIG_SYS_FSL_DDRC_GEN2
4645614e71bSYork Sun		Freescale DDR2 controller.
4655614e71bSYork Sun
4665614e71bSYork Sun		CONFIG_SYS_FSL_DDRC_GEN3
4675614e71bSYork Sun		Freescale DDR3 controller.
4685614e71bSYork Sun
46934e026f9SYork Sun		CONFIG_SYS_FSL_DDRC_GEN4
47034e026f9SYork Sun		Freescale DDR4 controller.
47134e026f9SYork Sun
4729ac4ffbdSYork Sun		CONFIG_SYS_FSL_DDRC_ARM_GEN3
4739ac4ffbdSYork Sun		Freescale DDR3 controller for ARM-based SoCs.
4749ac4ffbdSYork Sun
4755614e71bSYork Sun		CONFIG_SYS_FSL_DDR1
4765614e71bSYork Sun		Board config to use DDR1. It can be enabled for SoCs with
4775614e71bSYork Sun		Freescale DDR1 or DDR2 controllers, depending on the board
4785614e71bSYork Sun		implemetation.
4795614e71bSYork Sun
4805614e71bSYork Sun		CONFIG_SYS_FSL_DDR2
4815614e71bSYork Sun		Board config to use DDR2. It can be eanbeld for SoCs with
4825614e71bSYork Sun		Freescale DDR2 or DDR3 controllers, depending on the board
4835614e71bSYork Sun		implementation.
4845614e71bSYork Sun
4855614e71bSYork Sun		CONFIG_SYS_FSL_DDR3
4865614e71bSYork Sun		Board config to use DDR3. It can be enabled for SoCs with
48734e026f9SYork Sun		Freescale DDR3 or DDR3L controllers.
48834e026f9SYork Sun
48934e026f9SYork Sun		CONFIG_SYS_FSL_DDR3L
49034e026f9SYork Sun		Board config to use DDR3L. It can be enabled for SoCs with
49134e026f9SYork Sun		DDR3L controllers.
49234e026f9SYork Sun
49334e026f9SYork Sun		CONFIG_SYS_FSL_DDR4
49434e026f9SYork Sun		Board config to use DDR4. It can be enabled for SoCs with
49534e026f9SYork Sun		DDR4 controllers.
4965614e71bSYork Sun
4971b4175d6SPrabhakar Kushwaha		CONFIG_SYS_FSL_IFC_BE
4981b4175d6SPrabhakar Kushwaha		Defines the IFC controller register space as Big Endian
4991b4175d6SPrabhakar Kushwaha
5001b4175d6SPrabhakar Kushwaha		CONFIG_SYS_FSL_IFC_LE
5011b4175d6SPrabhakar Kushwaha		Defines the IFC controller register space as Little Endian
5021b4175d6SPrabhakar Kushwaha
503690e4258SPrabhakar Kushwaha		CONFIG_SYS_FSL_PBL_PBI
504690e4258SPrabhakar Kushwaha		It enables addition of RCW (Power on reset configuration) in built image.
505690e4258SPrabhakar Kushwaha		Please refer doc/README.pblimage for more details
506690e4258SPrabhakar Kushwaha
507690e4258SPrabhakar Kushwaha		CONFIG_SYS_FSL_PBL_RCW
508690e4258SPrabhakar Kushwaha		It adds PBI(pre-boot instructions) commands in u-boot build image.
509690e4258SPrabhakar Kushwaha		PBI commands can be used to configure SoC before it starts the execution.
510690e4258SPrabhakar Kushwaha		Please refer doc/README.pblimage for more details
511690e4258SPrabhakar Kushwaha
51289ad7be8SPrabhakar Kushwaha		CONFIG_SPL_FSL_PBL
51389ad7be8SPrabhakar Kushwaha		It adds a target to create boot binary having SPL binary in PBI format
51489ad7be8SPrabhakar Kushwaha		concatenated with u-boot binary.
51589ad7be8SPrabhakar Kushwaha
5164e5b1bd0SYork Sun		CONFIG_SYS_FSL_DDR_BE
5174e5b1bd0SYork Sun		Defines the DDR controller register space as Big Endian
5184e5b1bd0SYork Sun
5194e5b1bd0SYork Sun		CONFIG_SYS_FSL_DDR_LE
5204e5b1bd0SYork Sun		Defines the DDR controller register space as Little Endian
5214e5b1bd0SYork Sun
5226b9e309aSYork Sun		CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
5236b9e309aSYork Sun		Physical address from the view of DDR controllers. It is the
5246b9e309aSYork Sun		same as CONFIG_SYS_DDR_SDRAM_BASE for  all Power SoCs. But
5256b9e309aSYork Sun		it could be different for ARM SoCs.
5266b9e309aSYork Sun
5276b1e1254SYork Sun		CONFIG_SYS_FSL_DDR_INTLV_256B
5286b1e1254SYork Sun		DDR controller interleaving on 256-byte. This is a special
5296b1e1254SYork Sun		interleaving mode, handled by Dickens for Freescale layerscape
5306b1e1254SYork Sun		SoCs with ARM core.
5316b1e1254SYork Sun
5320b953ffcSMarkus Klotzbuecher- Intel Monahans options:
5336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
5340b953ffcSMarkus Klotzbuecher
5350b953ffcSMarkus Klotzbuecher		Defines the Monahans run mode to oscillator
5360b953ffcSMarkus Klotzbuecher		ratio. Valid values are 8, 16, 24, 31. The core
5370b953ffcSMarkus Klotzbuecher		frequency is this value multiplied by 13 MHz.
5380b953ffcSMarkus Klotzbuecher
5396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
5400b953ffcSMarkus Klotzbuecher
5410b953ffcSMarkus Klotzbuecher		Defines the Monahans turbo mode to oscillator
5420b953ffcSMarkus Klotzbuecher		ratio. Valid values are 1 (default if undefined) and
5430b953ffcSMarkus Klotzbuecher		2. The core frequency as calculated above is multiplied
5440b953ffcSMarkus Klotzbuecher		by this value.
5450b953ffcSMarkus Klotzbuecher
54692bbd64eSDaniel Schwierzeck- MIPS CPU options:
54792bbd64eSDaniel Schwierzeck		CONFIG_SYS_INIT_SP_OFFSET
54892bbd64eSDaniel Schwierzeck
54992bbd64eSDaniel Schwierzeck		Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
55092bbd64eSDaniel Schwierzeck		pointer. This is needed for the temporary stack before
55192bbd64eSDaniel Schwierzeck		relocation.
55292bbd64eSDaniel Schwierzeck
55392bbd64eSDaniel Schwierzeck		CONFIG_SYS_MIPS_CACHE_MODE
55492bbd64eSDaniel Schwierzeck
55592bbd64eSDaniel Schwierzeck		Cache operation mode for the MIPS CPU.
55692bbd64eSDaniel Schwierzeck		See also arch/mips/include/asm/mipsregs.h.
55792bbd64eSDaniel Schwierzeck		Possible values are:
55892bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_NO_WA
55992bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_WA
56092bbd64eSDaniel Schwierzeck			CONF_CM_UNCACHED
56192bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_NONCOHERENT
56292bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_CE
56392bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_COW
56492bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_CUW
56592bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_ACCELERATED
56692bbd64eSDaniel Schwierzeck
56792bbd64eSDaniel Schwierzeck		CONFIG_SYS_XWAY_EBU_BOOTCFG
56892bbd64eSDaniel Schwierzeck
56992bbd64eSDaniel Schwierzeck		Special option for Lantiq XWAY SoCs for booting from NOR flash.
57092bbd64eSDaniel Schwierzeck		See also arch/mips/cpu/mips32/start.S.
57192bbd64eSDaniel Schwierzeck
57292bbd64eSDaniel Schwierzeck		CONFIG_XWAY_SWAP_BYTES
57392bbd64eSDaniel Schwierzeck
57492bbd64eSDaniel Schwierzeck		Enable compilation of tools/xway-swap-bytes needed for Lantiq
57592bbd64eSDaniel Schwierzeck		XWAY SoCs for booting from NOR flash. The U-Boot image needs to
57692bbd64eSDaniel Schwierzeck		be swapped if a flash programmer is used.
57792bbd64eSDaniel Schwierzeck
578b67d8816SChristian Riesch- ARM options:
579b67d8816SChristian Riesch		CONFIG_SYS_EXCEPTION_VECTORS_HIGH
580b67d8816SChristian Riesch
581b67d8816SChristian Riesch		Select high exception vectors of the ARM core, e.g., do not
582b67d8816SChristian Riesch		clear the V bit of the c1 register of CP15.
583b67d8816SChristian Riesch
5845356f545SAneesh V		CONFIG_SYS_THUMB_BUILD
5855356f545SAneesh V
5865356f545SAneesh V		Use this flag to build U-Boot using the Thumb instruction
5875356f545SAneesh V		set for ARM architectures. Thumb instruction set provides
5885356f545SAneesh V		better code density. For ARM architectures that support
5895356f545SAneesh V		Thumb2 this flag will result in Thumb2 code generated by
5905356f545SAneesh V		GCC.
5915356f545SAneesh V
592c5d4752cSStephen Warren		CONFIG_ARM_ERRATA_716044
5930678587fSStephen Warren		CONFIG_ARM_ERRATA_742230
5940678587fSStephen Warren		CONFIG_ARM_ERRATA_743622
5950678587fSStephen Warren		CONFIG_ARM_ERRATA_751472
596f71cbfe3SNitin Garg		CONFIG_ARM_ERRATA_794072
597b7588e3bSNitin Garg		CONFIG_ARM_ERRATA_761320
5980678587fSStephen Warren
5990678587fSStephen Warren		If set, the workarounds for these ARM errata are applied early
6000678587fSStephen Warren		during U-Boot startup. Note that these options force the
6010678587fSStephen Warren		workarounds to be applied; no CPU-type/version detection
6020678587fSStephen Warren		exists, unlike the similar options in the Linux kernel. Do not
6030678587fSStephen Warren		set these options unless they apply!
6040678587fSStephen Warren
605795659dcSStephen Warren- CPU timer options:
606795659dcSStephen Warren		CONFIG_SYS_HZ
607795659dcSStephen Warren
608795659dcSStephen Warren		The frequency of the timer returned by get_timer().
609795659dcSStephen Warren		get_timer() must operate in milliseconds and this CONFIG
610795659dcSStephen Warren		option must be set to 1000.
611795659dcSStephen Warren
6125da627a4Swdenk- Linux Kernel Interface:
613c609719bSwdenk		CONFIG_CLOCKS_IN_MHZ
614c609719bSwdenk
615c609719bSwdenk		U-Boot stores all clock information in Hz
616c609719bSwdenk		internally. For binary compatibility with older Linux
617c609719bSwdenk		kernels (which expect the clocks passed in the
618c609719bSwdenk		bd_info data to be in MHz) the environment variable
619c609719bSwdenk		"clocks_in_mhz" can be defined so that U-Boot
620c609719bSwdenk		converts clock data to MHZ before passing it to the
621c609719bSwdenk		Linux kernel.
622c609719bSwdenk		When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
623c609719bSwdenk		"clocks_in_mhz=1" is automatically included in the
624c609719bSwdenk		default environment.
625c609719bSwdenk
6265da627a4Swdenk		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]
6275da627a4Swdenk
62811ccc33fSMarcel Ziswiler		When transferring memsize parameter to linux, some versions
6295da627a4Swdenk		expect it to be in bytes, others in MB.
6305da627a4Swdenk		Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
6315da627a4Swdenk
632fec6d9eeSGerald Van Baren		CONFIG_OF_LIBFDT
633f57f70aaSWolfgang Denk
634f57f70aaSWolfgang Denk		New kernel versions are expecting firmware settings to be
635213bf8c8SGerald Van Baren		passed using flattened device trees (based on open firmware
636213bf8c8SGerald Van Baren		concepts).
637213bf8c8SGerald Van Baren
638213bf8c8SGerald Van Baren		CONFIG_OF_LIBFDT
639213bf8c8SGerald Van Baren		 * New libfdt-based support
640213bf8c8SGerald Van Baren		 * Adds the "fdt" command
6413bb342fcSKim Phillips		 * The bootm command automatically updates the fdt
642213bf8c8SGerald Van Baren
643b55ae402SMarcel Ziswiler		OF_CPU - The proper name of the cpus node (only required for
644b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
645b55ae402SMarcel Ziswiler		OF_SOC - The proper name of the soc node (only required for
646b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
647f57f70aaSWolfgang Denk		OF_TBCLK - The timebase frequency.
648c2871f03SKumar Gala		OF_STDOUT_PATH - The path to the console device
649f57f70aaSWolfgang Denk
65011ccc33fSMarcel Ziswiler		boards with QUICC Engines require OF_QE to set UCC MAC
65111ccc33fSMarcel Ziswiler		addresses
6523bb342fcSKim Phillips
6534e253137SKumar Gala		CONFIG_OF_BOARD_SETUP
6544e253137SKumar Gala
6554e253137SKumar Gala		Board code has addition modification that it wants to make
6564e253137SKumar Gala		to the flat device tree before handing it off to the kernel
6576705d81eSwdenk
6580267768eSMatthew McClintock		CONFIG_OF_BOOT_CPU
6590267768eSMatthew McClintock
66011ccc33fSMarcel Ziswiler		This define fills in the correct boot CPU in the boot
6610267768eSMatthew McClintock		param header, the default value is zero if undefined.
6620267768eSMatthew McClintock
6633887c3fbSHeiko Schocher		CONFIG_OF_IDE_FIXUP
6643887c3fbSHeiko Schocher
6653887c3fbSHeiko Schocher		U-Boot can detect if an IDE device is present or not.
6663887c3fbSHeiko Schocher		If not, and this new config option is activated, U-Boot
6673887c3fbSHeiko Schocher		removes the ATA node from the DTS before booting Linux,
6683887c3fbSHeiko Schocher		so the Linux IDE driver does not probe the device and
6693887c3fbSHeiko Schocher		crash. This is needed for buggy hardware (uc101) where
6703887c3fbSHeiko Schocher		no pull down resistor is connected to the signal IDE5V_DD7.
6713887c3fbSHeiko Schocher
6727eb29398SIgor Grinberg		CONFIG_MACH_TYPE	[relevant for ARM only][mandatory]
6737eb29398SIgor Grinberg
6747eb29398SIgor Grinberg		This setting is mandatory for all boards that have only one
6757eb29398SIgor Grinberg		machine type and must be used to specify the machine type
6767eb29398SIgor Grinberg		number as it appears in the ARM machine registry
6777eb29398SIgor Grinberg		(see http://www.arm.linux.org.uk/developer/machines/).
6787eb29398SIgor Grinberg		Only boards that have multiple machine types supported
6797eb29398SIgor Grinberg		in a single configuration file and the machine type is
6807eb29398SIgor Grinberg		runtime discoverable, do not have to use this setting.
6817eb29398SIgor Grinberg
6820b2f4ecaSNiklaus Giger- vxWorks boot parameters:
6830b2f4ecaSNiklaus Giger
6840b2f4ecaSNiklaus Giger		bootvx constructs a valid bootline using the following
6850b2f4ecaSNiklaus Giger		environments variables: bootfile, ipaddr, serverip, hostname.
6860b2f4ecaSNiklaus Giger		It loads the vxWorks image pointed bootfile.
6870b2f4ecaSNiklaus Giger
6880b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
6890b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
6900b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
6910b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
6920b2f4ecaSNiklaus Giger
6930b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_ADD_PARAMS
6940b2f4ecaSNiklaus Giger
6950b2f4ecaSNiklaus Giger		Add it at the end of the bootline. E.g "u=username pw=secret"
6960b2f4ecaSNiklaus Giger
6970b2f4ecaSNiklaus Giger		Note: If a "bootargs" environment is defined, it will overwride
6980b2f4ecaSNiklaus Giger		the defaults discussed just above.
6990b2f4ecaSNiklaus Giger
7002c451f78SAneesh V- Cache Configuration:
7012c451f78SAneesh V		CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
7022c451f78SAneesh V		CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
7032c451f78SAneesh V		CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
7042c451f78SAneesh V
70593bc2193SAneesh V- Cache Configuration for ARM:
70693bc2193SAneesh V		CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
70793bc2193SAneesh V				      controller
70893bc2193SAneesh V		CONFIG_SYS_PL310_BASE - Physical base address of PL310
70993bc2193SAneesh V					controller register space
71093bc2193SAneesh V
7116705d81eSwdenk- Serial Ports:
71248d0192fSAndreas Engel		CONFIG_PL010_SERIAL
7136705d81eSwdenk
7146705d81eSwdenk		Define this if you want support for Amba PrimeCell PL010 UARTs.
7156705d81eSwdenk
71648d0192fSAndreas Engel		CONFIG_PL011_SERIAL
7176705d81eSwdenk
7186705d81eSwdenk		Define this if you want support for Amba PrimeCell PL011 UARTs.
7196705d81eSwdenk
7206705d81eSwdenk		CONFIG_PL011_CLOCK
7216705d81eSwdenk
7226705d81eSwdenk		If you have Amba PrimeCell PL011 UARTs, set this variable to
7236705d81eSwdenk		the clock speed of the UARTs.
7246705d81eSwdenk
7256705d81eSwdenk		CONFIG_PL01x_PORTS
7266705d81eSwdenk
7276705d81eSwdenk		If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
7286705d81eSwdenk		define this to a list of base addresses for each (supported)
7296705d81eSwdenk		port. See e.g. include/configs/versatile.h
7306705d81eSwdenk
731910f1ae3SJohn Rigby		CONFIG_PL011_SERIAL_RLCR
732910f1ae3SJohn Rigby
733910f1ae3SJohn Rigby		Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
734910f1ae3SJohn Rigby		have separate receive and transmit line control registers.  Set
735910f1ae3SJohn Rigby		this variable to initialize the extra register.
736910f1ae3SJohn Rigby
737910f1ae3SJohn Rigby		CONFIG_PL011_SERIAL_FLUSH_ON_INIT
738910f1ae3SJohn Rigby
739910f1ae3SJohn Rigby		On some platforms (e.g. U8500) U-Boot is loaded by a second stage
740910f1ae3SJohn Rigby		boot loader that has already initialized the UART.  Define this
741910f1ae3SJohn Rigby		variable to flush the UART at init time.
742910f1ae3SJohn Rigby
7436705d81eSwdenk
744c609719bSwdenk- Console Interface:
745c609719bSwdenk		Depending on board, define exactly one serial port
746c609719bSwdenk		(like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
747c609719bSwdenk		CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
748c609719bSwdenk		console by defining CONFIG_8xx_CONS_NONE
749c609719bSwdenk
750c609719bSwdenk		Note: if CONFIG_8xx_CONS_NONE is defined, the serial
751c609719bSwdenk		port routines must be defined elsewhere
752c609719bSwdenk		(i.e. serial_init(), serial_getc(), ...)
753c609719bSwdenk
754c609719bSwdenk		CONFIG_CFB_CONSOLE
755c609719bSwdenk		Enables console device for a color framebuffer. Needs following
756c53043b7SWolfgang Denk		defines (cf. smiLynxEM, i8042)
757c609719bSwdenk			VIDEO_FB_LITTLE_ENDIAN	graphic memory organisation
758c609719bSwdenk						(default big endian)
759c609719bSwdenk			VIDEO_HW_RECTFILL	graphic chip supports
760c609719bSwdenk						rectangle fill
761c609719bSwdenk						(cf. smiLynxEM)
762c609719bSwdenk			VIDEO_HW_BITBLT		graphic chip supports
763c609719bSwdenk						bit-blit (cf. smiLynxEM)
764c609719bSwdenk			VIDEO_VISIBLE_COLS	visible pixel columns
765c609719bSwdenk						(cols=pitch)
766c609719bSwdenk			VIDEO_VISIBLE_ROWS	visible pixel rows
767c609719bSwdenk			VIDEO_PIXEL_SIZE	bytes per pixel
768c609719bSwdenk			VIDEO_DATA_FORMAT	graphic data format
769c609719bSwdenk						(0-5, cf. cfb_console.c)
770c609719bSwdenk			VIDEO_FB_ADRS		framebuffer address
771c609719bSwdenk			VIDEO_KBD_INIT_FCT	keyboard int fct
772c609719bSwdenk						(i.e. i8042_kbd_init())
773c609719bSwdenk			VIDEO_TSTC_FCT		test char fct
774c609719bSwdenk						(i.e. i8042_tstc)
775c609719bSwdenk			VIDEO_GETC_FCT		get char fct
776c609719bSwdenk						(i.e. i8042_getc)
777c609719bSwdenk			CONFIG_CONSOLE_CURSOR	cursor drawing on/off
778c609719bSwdenk						(requires blink timer
779c609719bSwdenk						cf. i8042.c)
7806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
781c609719bSwdenk			CONFIG_CONSOLE_TIME	display time/date info in
782c609719bSwdenk						upper right corner
783602ad3b3SJon Loeliger						(requires CONFIG_CMD_DATE)
784c609719bSwdenk			CONFIG_VIDEO_LOGO	display Linux logo in
785c609719bSwdenk						upper left corner
786a6c7ad2fSwdenk			CONFIG_VIDEO_BMP_LOGO	use bmp_logo.h instead of
787a6c7ad2fSwdenk						linux_logo.h for logo.
788a6c7ad2fSwdenk						Requires CONFIG_VIDEO_LOGO
789c609719bSwdenk			CONFIG_CONSOLE_EXTRA_INFO
79011ccc33fSMarcel Ziswiler						additional board info beside
791c609719bSwdenk						the logo
792c609719bSwdenk
79333a35bbbSPali Rohár		When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
79433a35bbbSPali Rohár		a limited number of ANSI escape sequences (cursor control,
79533a35bbbSPali Rohár		erase functions and limited graphics rendition control).
79633a35bbbSPali Rohár
797c609719bSwdenk		When CONFIG_CFB_CONSOLE is defined, video console is
798c609719bSwdenk		default i/o. Serial console can be forced with
799c609719bSwdenk		environment 'console=serial'.
800c609719bSwdenk
801a3ad8e26Swdenk		When CONFIG_SILENT_CONSOLE is defined, all console
802a3ad8e26Swdenk		messages (by U-Boot and Linux!) can be silenced with
803a3ad8e26Swdenk		the "silent" environment variable. See
804a3ad8e26Swdenk		doc/README.silent for more information.
805a3ad8e26Swdenk
80645ae2546SHeiko Schocher		CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default
80745ae2546SHeiko Schocher			is 0x00.
80845ae2546SHeiko Schocher		CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default
80945ae2546SHeiko Schocher			is 0xa0.
81045ae2546SHeiko Schocher
811c609719bSwdenk- Console Baudrate:
812c609719bSwdenk		CONFIG_BAUDRATE - in bps
813c609719bSwdenk		Select one of the baudrates listed in
8146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
8156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
816c609719bSwdenk
817c92fac91SHeiko Schocher- Console Rx buffer length
818c92fac91SHeiko Schocher		With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
819c92fac91SHeiko Schocher		the maximum receive buffer length for the SMC.
8202b3f12c2SHeiko Schocher		This option is actual only for 82xx and 8xx possible.
821c92fac91SHeiko Schocher		If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
822c92fac91SHeiko Schocher		must be defined, to setup the maximum idle timeout for
823c92fac91SHeiko Schocher		the SMC.
824c92fac91SHeiko Schocher
8259558b48aSGraeme Russ- Pre-Console Buffer:
8269558b48aSGraeme Russ		Prior to the console being initialised (i.e. serial UART
8279558b48aSGraeme Russ		initialised etc) all console output is silently discarded.
8289558b48aSGraeme Russ		Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
8299558b48aSGraeme Russ		buffer any console messages prior to the console being
8309558b48aSGraeme Russ		initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
8319558b48aSGraeme Russ		bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
8329558b48aSGraeme Russ		a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
8339558b48aSGraeme Russ		bytes are output before the console is initialised, the
8349558b48aSGraeme Russ		earlier bytes are discarded.
8359558b48aSGraeme Russ
8369558b48aSGraeme Russ		'Sane' compilers will generate smaller code if
8379558b48aSGraeme Russ		CONFIG_PRE_CON_BUF_SZ is a power of 2
8389558b48aSGraeme Russ
839046a37bdSSonny Rao- Safe printf() functions
840046a37bdSSonny Rao		Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
841046a37bdSSonny Rao		the printf() functions. These are defined in
842046a37bdSSonny Rao		include/vsprintf.h and include snprintf(), vsnprintf() and
843046a37bdSSonny Rao		so on. Code size increase is approximately 300-500 bytes.
844046a37bdSSonny Rao		If this option is not given then these functions will
845046a37bdSSonny Rao		silently discard their buffer size argument - this means
846046a37bdSSonny Rao		you are not getting any overflow checking in this case.
847046a37bdSSonny Rao
848c609719bSwdenk- Boot Delay:	CONFIG_BOOTDELAY - in seconds
849c609719bSwdenk		Delay before automatically booting the default image;
850c609719bSwdenk		set to -1 to disable autoboot.
85193d7212fSJoe Hershberger		set to -2 to autoboot with no delay and not check for abort
85293d7212fSJoe Hershberger		(even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
853c609719bSwdenk
854c609719bSwdenk		See doc/README.autoboot for these options that
855c609719bSwdenk		work with CONFIG_BOOTDELAY. None are required.
856c609719bSwdenk		CONFIG_BOOT_RETRY_TIME
857c609719bSwdenk		CONFIG_BOOT_RETRY_MIN
858c609719bSwdenk		CONFIG_AUTOBOOT_KEYED
859c609719bSwdenk		CONFIG_AUTOBOOT_PROMPT
860c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR
861c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR
862c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR2
863c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR2
864c609719bSwdenk		CONFIG_ZERO_BOOTDELAY_CHECK
865c609719bSwdenk		CONFIG_RESET_TO_RETRY
866c609719bSwdenk
867c609719bSwdenk- Autoboot Command:
868c609719bSwdenk		CONFIG_BOOTCOMMAND
869c609719bSwdenk		Only needed when CONFIG_BOOTDELAY is enabled;
870c609719bSwdenk		define a command string that is automatically executed
871c609719bSwdenk		when no character is read on the console interface
872c609719bSwdenk		within "Boot Delay" after reset.
873c609719bSwdenk
874c609719bSwdenk		CONFIG_BOOTARGS
875c609719bSwdenk		This can be used to pass arguments to the bootm
876c609719bSwdenk		command. The value of CONFIG_BOOTARGS goes into the
877c609719bSwdenk		environment value "bootargs".
878c609719bSwdenk
879c609719bSwdenk		CONFIG_RAMBOOT and CONFIG_NFSBOOT
880c609719bSwdenk		The value of these goes into the environment as
881c609719bSwdenk		"ramboot" and "nfsboot" respectively, and can be used
882c609719bSwdenk		as a convenience, when switching between booting from
88311ccc33fSMarcel Ziswiler		RAM and NFS.
884c609719bSwdenk
885eda0ba38SHeiko Schocher- Bootcount:
886eda0ba38SHeiko Schocher		CONFIG_BOOTCOUNT_LIMIT
887eda0ba38SHeiko Schocher		Implements a mechanism for detecting a repeating reboot
888eda0ba38SHeiko Schocher		cycle, see:
889eda0ba38SHeiko Schocher		http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
890eda0ba38SHeiko Schocher
891eda0ba38SHeiko Schocher		CONFIG_BOOTCOUNT_ENV
892eda0ba38SHeiko Schocher		If no softreset save registers are found on the hardware
893eda0ba38SHeiko Schocher		"bootcount" is stored in the environment. To prevent a
894eda0ba38SHeiko Schocher		saveenv on all reboots, the environment variable
895eda0ba38SHeiko Schocher		"upgrade_available" is used. If "upgrade_available" is
896eda0ba38SHeiko Schocher		0, "bootcount" is always 0, if "upgrade_available" is
897eda0ba38SHeiko Schocher		1 "bootcount" is incremented in the environment.
898eda0ba38SHeiko Schocher		So the Userspace Applikation must set the "upgrade_available"
899eda0ba38SHeiko Schocher		and "bootcount" variable to 0, if a boot was successfully.
900eda0ba38SHeiko Schocher
901c609719bSwdenk- Pre-Boot Commands:
902c609719bSwdenk		CONFIG_PREBOOT
903c609719bSwdenk
904c609719bSwdenk		When this option is #defined, the existence of the
905c609719bSwdenk		environment variable "preboot" will be checked
906c609719bSwdenk		immediately before starting the CONFIG_BOOTDELAY
907c609719bSwdenk		countdown and/or running the auto-boot command resp.
908c609719bSwdenk		entering interactive mode.
909c609719bSwdenk
910c609719bSwdenk		This feature is especially useful when "preboot" is
911c609719bSwdenk		automatically generated or modified. For an example
912c609719bSwdenk		see the LWMON board specific code: here "preboot" is
913c609719bSwdenk		modified when the user holds down a certain
914c609719bSwdenk		combination of keys on the (special) keyboard when
915c609719bSwdenk		booting the systems
916c609719bSwdenk
917c609719bSwdenk- Serial Download Echo Mode:
918c609719bSwdenk		CONFIG_LOADS_ECHO
919c609719bSwdenk		If defined to 1, all characters received during a
920c609719bSwdenk		serial download (using the "loads" command) are
921c609719bSwdenk		echoed back. This might be needed by some terminal
922c609719bSwdenk		emulations (like "cu"), but may as well just take
923c609719bSwdenk		time on others. This setting #define's the initial
924c609719bSwdenk		value of the "loads_echo" environment variable.
925c609719bSwdenk
926602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
927c609719bSwdenk		CONFIG_KGDB_BAUDRATE
928c609719bSwdenk		Select one of the baudrates listed in
9296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
930c609719bSwdenk
931c609719bSwdenk- Monitor Functions:
932602ad3b3SJon Loeliger		Monitor commands can be included or excluded
933602ad3b3SJon Loeliger		from the build by using the #include files
934c6c621bdSStephen Warren		<config_cmd_all.h> and #undef'ing unwanted
935c6c621bdSStephen Warren		commands, or using <config_cmd_default.h>
936602ad3b3SJon Loeliger		and augmenting with additional #define's
937602ad3b3SJon Loeliger		for wanted commands.
938c609719bSwdenk
939602ad3b3SJon Loeliger		The default command configuration includes all commands
940602ad3b3SJon Loeliger		except those marked below with a "*".
941602ad3b3SJon Loeliger
942b401b73dSMarek Vasut		CONFIG_CMD_AES		  AES 128 CBC encrypt/decrypt
943602ad3b3SJon Loeliger		CONFIG_CMD_ASKENV	* ask for env variable
944602ad3b3SJon Loeliger		CONFIG_CMD_BDI		  bdinfo
945602ad3b3SJon Loeliger		CONFIG_CMD_BEDBUG	* Include BedBug Debugger
946602ad3b3SJon Loeliger		CONFIG_CMD_BMP		* BMP support
947602ad3b3SJon Loeliger		CONFIG_CMD_BSP		* Board specific commands
948602ad3b3SJon Loeliger		CONFIG_CMD_BOOTD	  bootd
949602ad3b3SJon Loeliger		CONFIG_CMD_CACHE	* icache, dcache
95008d0d6f3SMichal Simek		CONFIG_CMD_CLK   	* clock command support
951602ad3b3SJon Loeliger		CONFIG_CMD_CONSOLE	  coninfo
952710b9938SMike Frysinger		CONFIG_CMD_CRC32	* crc32
953602ad3b3SJon Loeliger		CONFIG_CMD_DATE		* support for RTC, date/time...
954602ad3b3SJon Loeliger		CONFIG_CMD_DHCP		* DHCP support
955602ad3b3SJon Loeliger		CONFIG_CMD_DIAG		* Diagnostics
956a7c93104SPeter Tyser		CONFIG_CMD_DS4510	* ds4510 I2C gpio commands
957a7c93104SPeter Tyser		CONFIG_CMD_DS4510_INFO	* ds4510 I2C info command
958a7c93104SPeter Tyser		CONFIG_CMD_DS4510_MEM	* ds4510 I2C eeprom/sram commansd
959a7c93104SPeter Tyser		CONFIG_CMD_DS4510_RST	* ds4510 I2C rst command
960602ad3b3SJon Loeliger		CONFIG_CMD_DTT		* Digital Therm and Thermostat
961602ad3b3SJon Loeliger		CONFIG_CMD_ECHO		  echo arguments
962246c6922SPeter Tyser		CONFIG_CMD_EDITENV	  edit env variable
963602ad3b3SJon Loeliger		CONFIG_CMD_EEPROM	* EEPROM read/write support
964602ad3b3SJon Loeliger		CONFIG_CMD_ELF		* bootelf, bootvx
9655e2b3e0cSJoe Hershberger		CONFIG_CMD_ENV_CALLBACK	* display details about env callbacks
966fffad71bSJoe Hershberger		CONFIG_CMD_ENV_FLAGS	* display details about env flags
96788733e2cSAndrew Ruder		CONFIG_CMD_ENV_EXISTS	* check existence of env variable
9680c79cda0SMike Frysinger		CONFIG_CMD_EXPORTENV	* export the environment
96903e2ecf6SStephen Warren		CONFIG_CMD_EXT2		* ext2 command support
97003e2ecf6SStephen Warren		CONFIG_CMD_EXT4		* ext4 command support
97116f4d933SStephen Warren		CONFIG_CMD_FS_GENERIC	* filesystem commands (e.g. load, ls)
97216f4d933SStephen Warren					  that work for multiple fs types
973bdab39d3SMike Frysinger		CONFIG_CMD_SAVEENV	  saveenv
974602ad3b3SJon Loeliger		CONFIG_CMD_FDC		* Floppy Disk Support
97503e2ecf6SStephen Warren		CONFIG_CMD_FAT		* FAT command support
976602ad3b3SJon Loeliger		CONFIG_CMD_FLASH	  flinfo, erase, protect
977602ad3b3SJon Loeliger		CONFIG_CMD_FPGA		  FPGA device initialization support
9784d98b5c8SVincent Stehlé		CONFIG_CMD_FUSE		* Device fuse support
97953fdc7efSAnton Staaf		CONFIG_CMD_GETTIME	* Get time since boot
980a641b979SMike Frysinger		CONFIG_CMD_GO		* the 'go' command (exec code)
981a000b795SKim Phillips		CONFIG_CMD_GREPENV	* search environment
982bf36c5d5SSimon Glass		CONFIG_CMD_HASH		* calculate hash / digest
983602ad3b3SJon Loeliger		CONFIG_CMD_HWFLOW	* RTS/CTS hw flow control
984602ad3b3SJon Loeliger		CONFIG_CMD_I2C		* I2C serial bus support
985602ad3b3SJon Loeliger		CONFIG_CMD_IDE		* IDE harddisk support
986602ad3b3SJon Loeliger		CONFIG_CMD_IMI		  iminfo
9878fdf1e0fSVipin Kumar		CONFIG_CMD_IMLS		  List all images found in NOR flash
9884d98b5c8SVincent Stehlé		CONFIG_CMD_IMLS_NAND	* List all images found in NAND flash
989602ad3b3SJon Loeliger		CONFIG_CMD_IMMAP	* IMMR dump support
9900c79cda0SMike Frysinger		CONFIG_CMD_IMPORTENV	* import an environment
991c167cc02SJoe Hershberger		CONFIG_CMD_INI		* import data from an ini file into the env
992602ad3b3SJon Loeliger		CONFIG_CMD_IRQ		* irqinfo
993602ad3b3SJon Loeliger		CONFIG_CMD_ITEST	  Integer/string test of 2 values
994602ad3b3SJon Loeliger		CONFIG_CMD_JFFS2	* JFFS2 Support
995602ad3b3SJon Loeliger		CONFIG_CMD_KGDB		* kgdb
9964d98b5c8SVincent Stehlé		CONFIG_CMD_LDRINFO	* ldrinfo (display Blackfin loader)
997d22c338eSJoe Hershberger		CONFIG_CMD_LINK_LOCAL	* link-local IP address auto-configuration
998d22c338eSJoe Hershberger					  (169.254.*.*)
999602ad3b3SJon Loeliger		CONFIG_CMD_LOADB	  loadb
1000602ad3b3SJon Loeliger		CONFIG_CMD_LOADS	  loads
10014d98b5c8SVincent Stehlé		CONFIG_CMD_MD5SUM	* print md5 message digest
100202c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
100315a33e49SSimon Glass		CONFIG_CMD_MEMINFO	* Display detailed memory information
1004602ad3b3SJon Loeliger		CONFIG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
1005a2681707SWolfgang Denk					  loop, loopw
10064d98b5c8SVincent Stehlé		CONFIG_CMD_MEMTEST	* mtest
1007602ad3b3SJon Loeliger		CONFIG_CMD_MISC		  Misc functions like sleep etc
1008602ad3b3SJon Loeliger		CONFIG_CMD_MMC		* MMC memory mapped support
1009602ad3b3SJon Loeliger		CONFIG_CMD_MII		* MII utility commands
101068d7d651SStefan Roese		CONFIG_CMD_MTDPARTS	* MTD partition support
1011602ad3b3SJon Loeliger		CONFIG_CMD_NAND		* NAND support
1012602ad3b3SJon Loeliger		CONFIG_CMD_NET		  bootp, tftpboot, rarpboot
10134d98b5c8SVincent Stehlé		CONFIG_CMD_NFS		  NFS support
1014e92739d3SPeter Tyser		CONFIG_CMD_PCA953X	* PCA953x I2C gpio commands
1015e92739d3SPeter Tyser		CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
1016602ad3b3SJon Loeliger		CONFIG_CMD_PCI		* pciinfo
1017602ad3b3SJon Loeliger		CONFIG_CMD_PCMCIA		* PCMCIA support
1018602ad3b3SJon Loeliger		CONFIG_CMD_PING		* send ICMP ECHO_REQUEST to network
1019602ad3b3SJon Loeliger					  host
1020602ad3b3SJon Loeliger		CONFIG_CMD_PORTIO	* Port I/O
1021ff048ea9SKenneth Waters		CONFIG_CMD_READ		* Read raw data from partition
1022602ad3b3SJon Loeliger		CONFIG_CMD_REGINFO	* Register dump
1023602ad3b3SJon Loeliger		CONFIG_CMD_RUN		  run command in env variable
1024d304931fSSimon Glass		CONFIG_CMD_SANDBOX	* sb command to access sandbox features
1025602ad3b3SJon Loeliger		CONFIG_CMD_SAVES	* save S record dump
1026602ad3b3SJon Loeliger		CONFIG_CMD_SCSI		* SCSI Support
1027602ad3b3SJon Loeliger		CONFIG_CMD_SDRAM	* print SDRAM configuration information
1028602ad3b3SJon Loeliger					  (requires CONFIG_CMD_I2C)
1029602ad3b3SJon Loeliger		CONFIG_CMD_SETGETDCR	  Support for DCR Register access
1030602ad3b3SJon Loeliger					  (4xx only)
1031f61ec45eSEric Nelson		CONFIG_CMD_SF		* Read/write/erase SPI NOR flash
10324d98b5c8SVincent Stehlé		CONFIG_CMD_SHA1SUM	* print sha1 memory digest
103302c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY)
10347d861d95SBob Liu		CONFIG_CMD_SOFTSWITCH	* Soft switch setting command for BF60x
103574de7aefSWolfgang Denk		CONFIG_CMD_SOURCE	  "source" command Support
1036602ad3b3SJon Loeliger		CONFIG_CMD_SPI		* SPI serial bus support
10377a83af07SLuca Ceresoli		CONFIG_CMD_TFTPSRV	* TFTP transfer in server mode
10381fb7cd49SSimon Glass		CONFIG_CMD_TFTPPUT	* TFTP put command (upload)
1039da83bcd7SJoe Hershberger		CONFIG_CMD_TIME		* run command and report execution time (ARM specific)
1040da83bcd7SJoe Hershberger		CONFIG_CMD_TIMER	* access to the system tick timer
1041602ad3b3SJon Loeliger		CONFIG_CMD_USB		* USB support
1042602ad3b3SJon Loeliger		CONFIG_CMD_CDP		* Cisco Discover Protocol support
1043c8339f51SMarek Vasut		CONFIG_CMD_MFSL		* Microblaze FSL support
10444d98b5c8SVincent Stehlé		CONFIG_CMD_XIMG		  Load part of Multi Image
104589c8230dSPrzemyslaw Marczak		CONFIG_CMD_UUID		* Generate random UUID or GUID string
1046c609719bSwdenk
1047c609719bSwdenk		EXAMPLE: If you want all functions except of network
1048c609719bSwdenk		support you can write:
1049c609719bSwdenk
1050602ad3b3SJon Loeliger		#include "config_cmd_all.h"
1051602ad3b3SJon Loeliger		#undef CONFIG_CMD_NET
1052c609719bSwdenk
1053213bf8c8SGerald Van Baren	Other Commands:
1054213bf8c8SGerald Van Baren		fdt (flattened device tree) command: CONFIG_OF_LIBFDT
1055c609719bSwdenk
1056c609719bSwdenk	Note:	Don't enable the "icache" and "dcache" commands
1057602ad3b3SJon Loeliger		(configuration option CONFIG_CMD_CACHE) unless you know
1058c609719bSwdenk		what you (and your U-Boot users) are doing. Data
1059c609719bSwdenk		cache cannot be enabled on systems like the 8xx or
1060c609719bSwdenk		8260 (where accesses to the IMMR region must be
1061c609719bSwdenk		uncached), and it cannot be disabled on all other
1062c609719bSwdenk		systems where we (mis-) use the data cache to hold an
1063c609719bSwdenk		initial stack and some data.
1064c609719bSwdenk
1065c609719bSwdenk
1066c609719bSwdenk		XXX - this list needs to get updated!
1067c609719bSwdenk
1068a5ecbe62SWolfgang Denk- Regular expression support:
1069a5ecbe62SWolfgang Denk		CONFIG_REGEX
1070a5ecbe62SWolfgang Denk		If this variable is defined, U-Boot is linked against
1071a5ecbe62SWolfgang Denk		the SLRE (Super Light Regular Expression) library,
1072a5ecbe62SWolfgang Denk		which adds regex support to some commands, as for
1073a5ecbe62SWolfgang Denk		example "env grep" and "setexpr".
1074a5ecbe62SWolfgang Denk
107545ba8077SSimon Glass- Device tree:
107645ba8077SSimon Glass		CONFIG_OF_CONTROL
107745ba8077SSimon Glass		If this variable is defined, U-Boot will use a device tree
107845ba8077SSimon Glass		to configure its devices, instead of relying on statically
107945ba8077SSimon Glass		compiled #defines in the board file. This option is
108045ba8077SSimon Glass		experimental and only available on a few boards. The device
108145ba8077SSimon Glass		tree is available in the global data as gd->fdt_blob.
108245ba8077SSimon Glass
10832c0f79e4SSimon Glass		U-Boot needs to get its device tree from somewhere. This can
10842c0f79e4SSimon Glass		be done using one of the two options below:
1085bbb0b128SSimon Glass
1086bbb0b128SSimon Glass		CONFIG_OF_EMBED
1087bbb0b128SSimon Glass		If this variable is defined, U-Boot will embed a device tree
1088bbb0b128SSimon Glass		binary in its image. This device tree file should be in the
1089bbb0b128SSimon Glass		board directory and called <soc>-<board>.dts. The binary file
1090bbb0b128SSimon Glass		is then picked up in board_init_f() and made available through
1091bbb0b128SSimon Glass		the global data structure as gd->blob.
109245ba8077SSimon Glass
10932c0f79e4SSimon Glass		CONFIG_OF_SEPARATE
10942c0f79e4SSimon Glass		If this variable is defined, U-Boot will build a device tree
10952c0f79e4SSimon Glass		binary. It will be called u-boot.dtb. Architecture-specific
10962c0f79e4SSimon Glass		code will locate it at run-time. Generally this works by:
10972c0f79e4SSimon Glass
10982c0f79e4SSimon Glass			cat u-boot.bin u-boot.dtb >image.bin
10992c0f79e4SSimon Glass
11002c0f79e4SSimon Glass		and in fact, U-Boot does this for you, creating a file called
11012c0f79e4SSimon Glass		u-boot-dtb.bin which is useful in the common case. You can
11022c0f79e4SSimon Glass		still use the individual files if you need something more
11032c0f79e4SSimon Glass		exotic.
11042c0f79e4SSimon Glass
1105c609719bSwdenk- Watchdog:
1106c609719bSwdenk		CONFIG_WATCHDOG
1107c609719bSwdenk		If this variable is defined, it enables watchdog
11086abe6fb6SDetlev Zundel		support for the SoC. There must be support in the SoC
11096abe6fb6SDetlev Zundel		specific code for a watchdog. For the 8xx and 8260
11106abe6fb6SDetlev Zundel		CPUs, the SIU Watchdog feature is enabled in the SYPCR
11116abe6fb6SDetlev Zundel		register.  When supported for a specific SoC is
11126abe6fb6SDetlev Zundel		available, then no further board specific code should
11136abe6fb6SDetlev Zundel		be needed to use it.
11146abe6fb6SDetlev Zundel
11156abe6fb6SDetlev Zundel		CONFIG_HW_WATCHDOG
11166abe6fb6SDetlev Zundel		When using a watchdog circuitry external to the used
11176abe6fb6SDetlev Zundel		SoC, then define this variable and provide board
11186abe6fb6SDetlev Zundel		specific code for the "hw_watchdog_reset" function.
1119c609719bSwdenk
1120c1551ea8Sstroese- U-Boot Version:
1121c1551ea8Sstroese		CONFIG_VERSION_VARIABLE
1122c1551ea8Sstroese		If this variable is defined, an environment variable
1123c1551ea8Sstroese		named "ver" is created by U-Boot showing the U-Boot
1124c1551ea8Sstroese		version as printed by the "version" command.
1125a1ea8e51SBenoît Thébaudeau		Any change to this variable will be reverted at the
1126a1ea8e51SBenoît Thébaudeau		next reset.
1127c1551ea8Sstroese
1128c609719bSwdenk- Real-Time Clock:
1129c609719bSwdenk
1130602ad3b3SJon Loeliger		When CONFIG_CMD_DATE is selected, the type of the RTC
1131c609719bSwdenk		has to be selected, too. Define exactly one of the
1132c609719bSwdenk		following options:
1133c609719bSwdenk
1134c609719bSwdenk		CONFIG_RTC_MPC8xx	- use internal RTC of MPC8xx
1135c609719bSwdenk		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
11364e8b7544SFabio Estevam		CONFIG_RTC_MC13XXX	- use MC13783 or MC13892 RTC
1137c609719bSwdenk		CONFIG_RTC_MC146818	- use MC146818 RTC
11381cb8e980Swdenk		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
1139c609719bSwdenk		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
11407f70e853Swdenk		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
11413bac3513Swdenk		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
11429536dfccSTor Krill		CONFIG_RTC_ISL1208	- use Intersil ISL1208 RTC
11434c0d4c3bSwdenk		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
11446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_DS1337_NOOSC	- Turn off the OSC output for DS1337
114571d19f30SHeiko Schocher		CONFIG_SYS_RV3029_TCR	- enable trickle charger on
114671d19f30SHeiko Schocher					  RV3029 RTC.
1147c609719bSwdenk
1148b37c7e5eSwdenk		Note that if the RTC uses I2C, then the I2C interface
1149b37c7e5eSwdenk		must also be configured. See I2C Support, below.
1150b37c7e5eSwdenk
1151e92739d3SPeter Tyser- GPIO Support:
1152e92739d3SPeter Tyser		CONFIG_PCA953X		- use NXP's PCA953X series I2C GPIO
1153e92739d3SPeter Tyser
11545dec49caSChris Packham		The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
11555dec49caSChris Packham		chip-ngpio pairs that tell the PCA953X driver the number of
11565dec49caSChris Packham		pins supported by a particular chip.
11575dec49caSChris Packham
1158e92739d3SPeter Tyser		Note that if the GPIO device uses I2C, then the I2C interface
1159e92739d3SPeter Tyser		must also be configured. See I2C Support, below.
1160e92739d3SPeter Tyser
1161c609719bSwdenk- Timestamp Support:
1162c609719bSwdenk
1163c609719bSwdenk		When CONFIG_TIMESTAMP is selected, the timestamp
1164c609719bSwdenk		(date and time) of an image is printed by image
1165c609719bSwdenk		commands like bootm or iminfo. This option is
1166602ad3b3SJon Loeliger		automatically enabled when you select CONFIG_CMD_DATE .
1167c609719bSwdenk
1168923c46f9SKarl O. Pinc- Partition Labels (disklabels) Supported:
1169923c46f9SKarl O. Pinc		Zero or more of the following:
1170923c46f9SKarl O. Pinc		CONFIG_MAC_PARTITION   Apple's MacOS partition table.
1171923c46f9SKarl O. Pinc		CONFIG_DOS_PARTITION   MS Dos partition table, traditional on the
1172923c46f9SKarl O. Pinc				       Intel architecture, USB sticks, etc.
1173923c46f9SKarl O. Pinc		CONFIG_ISO_PARTITION   ISO partition table, used on CDROM etc.
1174923c46f9SKarl O. Pinc		CONFIG_EFI_PARTITION   GPT partition table, common when EFI is the
1175923c46f9SKarl O. Pinc				       bootloader.  Note 2TB partition limit; see
1176923c46f9SKarl O. Pinc				       disk/part_efi.c
1177923c46f9SKarl O. Pinc		CONFIG_MTD_PARTITIONS  Memory Technology Device partition table.
1178c609719bSwdenk
1179602ad3b3SJon Loeliger		If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1180218ca724SWolfgang Denk		CONFIG_CMD_SCSI) you must configure support for at
1181923c46f9SKarl O. Pinc		least one non-MTD partition type as well.
1182c609719bSwdenk
1183c609719bSwdenk- IDE Reset method:
11844d13cbadSwdenk		CONFIG_IDE_RESET_ROUTINE - this is defined in several
11854d13cbadSwdenk		board configurations files but used nowhere!
1186c609719bSwdenk
11874d13cbadSwdenk		CONFIG_IDE_RESET - is this is defined, IDE Reset will
11884d13cbadSwdenk		be performed by calling the function
11894d13cbadSwdenk			ide_set_reset(int reset)
11904d13cbadSwdenk		which has to be defined in a board specific file
1191c609719bSwdenk
1192c609719bSwdenk- ATAPI Support:
1193c609719bSwdenk		CONFIG_ATAPI
1194c609719bSwdenk
1195c609719bSwdenk		Set this to enable ATAPI support.
1196c609719bSwdenk
1197c40b2956Swdenk- LBA48 Support
1198c40b2956Swdenk		CONFIG_LBA48
1199c40b2956Swdenk
1200c40b2956Swdenk		Set this to enable support for disks larger than 137GB
12014b142febSHeiko Schocher		Also look at CONFIG_SYS_64BIT_LBA.
1202c40b2956Swdenk		Whithout these , LBA48 support uses 32bit variables and will 'only'
1203c40b2956Swdenk		support disks up to 2.1TB.
1204c40b2956Swdenk
12056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_64BIT_LBA:
1206c40b2956Swdenk			When enabled, makes the IDE subsystem use 64bit sector addresses.
1207c40b2956Swdenk			Default is 32bit.
1208c40b2956Swdenk
1209c609719bSwdenk- SCSI Support:
1210c609719bSwdenk		At the moment only there is only support for the
1211c609719bSwdenk		SYM53C8XX SCSI controller; define
1212c609719bSwdenk		CONFIG_SCSI_SYM53C8XX to enable it.
1213c609719bSwdenk
12146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
12156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
12166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
1217c609719bSwdenk		maximum numbers of LUNs, SCSI ID's and target
1218c609719bSwdenk		devices.
12196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
1220c609719bSwdenk
1221447c031bSStefan Reinauer		The environment variable 'scsidevs' is set to the number of
1222447c031bSStefan Reinauer		SCSI devices found during the last scan.
1223447c031bSStefan Reinauer
1224c609719bSwdenk- NETWORK Support (PCI):
1225682011ffSwdenk		CONFIG_E1000
1226ce5207e1SKyle Moffett		Support for Intel 8254x/8257x gigabit chips.
1227ce5207e1SKyle Moffett
1228ce5207e1SKyle Moffett		CONFIG_E1000_SPI
1229ce5207e1SKyle Moffett		Utility code for direct access to the SPI bus on Intel 8257x.
1230ce5207e1SKyle Moffett		This does not do anything useful unless you set at least one
1231ce5207e1SKyle Moffett		of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1232ce5207e1SKyle Moffett
1233ce5207e1SKyle Moffett		CONFIG_E1000_SPI_GENERIC
1234ce5207e1SKyle Moffett		Allow generic access to the SPI bus on the Intel 8257x, for
1235ce5207e1SKyle Moffett		example with the "sspi" command.
1236ce5207e1SKyle Moffett
1237ce5207e1SKyle Moffett		CONFIG_CMD_E1000
1238ce5207e1SKyle Moffett		Management command for E1000 devices.  When used on devices
1239ce5207e1SKyle Moffett		with SPI support you can reprogram the EEPROM from U-Boot.
1240682011ffSwdenk
1241ac3315c2SAndre Schwarz		CONFIG_E1000_FALLBACK_MAC
124211ccc33fSMarcel Ziswiler		default MAC for empty EEPROM after production.
1243ac3315c2SAndre Schwarz
1244c609719bSwdenk		CONFIG_EEPRO100
1245c609719bSwdenk		Support for Intel 82557/82559/82559ER chips.
124611ccc33fSMarcel Ziswiler		Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
1247c609719bSwdenk		write routine for first time initialisation.
1248c609719bSwdenk
1249c609719bSwdenk		CONFIG_TULIP
1250c609719bSwdenk		Support for Digital 2114x chips.
1251c609719bSwdenk		Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1252c609719bSwdenk		modem chip initialisation (KS8761/QS6611).
1253c609719bSwdenk
1254c609719bSwdenk		CONFIG_NATSEMI
1255c609719bSwdenk		Support for National dp83815 chips.
1256c609719bSwdenk
1257c609719bSwdenk		CONFIG_NS8382X
1258c609719bSwdenk		Support for National dp8382[01] gigabit chips.
1259c609719bSwdenk
126045219c46Swdenk- NETWORK Support (other):
126145219c46Swdenk
1262c041e9d2SJens Scharsig		CONFIG_DRIVER_AT91EMAC
1263c041e9d2SJens Scharsig		Support for AT91RM9200 EMAC.
1264c041e9d2SJens Scharsig
1265c041e9d2SJens Scharsig			CONFIG_RMII
1266c041e9d2SJens Scharsig			Define this to use reduced MII inteface
1267c041e9d2SJens Scharsig
1268c041e9d2SJens Scharsig			CONFIG_DRIVER_AT91EMAC_QUIET
1269c041e9d2SJens Scharsig			If this defined, the driver is quiet.
1270c041e9d2SJens Scharsig			The driver doen't show link status messages.
1271c041e9d2SJens Scharsig
1272efdd7319SRob Herring		CONFIG_CALXEDA_XGMAC
1273efdd7319SRob Herring		Support for the Calxeda XGMAC device
1274efdd7319SRob Herring
12753bb46d23SAshok		CONFIG_LAN91C96
127645219c46Swdenk		Support for SMSC's LAN91C96 chips.
127745219c46Swdenk
127845219c46Swdenk			CONFIG_LAN91C96_BASE
127945219c46Swdenk			Define this to hold the physical address
128045219c46Swdenk			of the LAN91C96's I/O space
128145219c46Swdenk
128245219c46Swdenk			CONFIG_LAN91C96_USE_32_BIT
128345219c46Swdenk			Define this to enable 32 bit addressing
128445219c46Swdenk
12853bb46d23SAshok		CONFIG_SMC91111
1286f39748aeSwdenk		Support for SMSC's LAN91C111 chip
1287f39748aeSwdenk
1288f39748aeSwdenk			CONFIG_SMC91111_BASE
1289f39748aeSwdenk			Define this to hold the physical address
1290f39748aeSwdenk			of the device (I/O space)
1291f39748aeSwdenk
1292f39748aeSwdenk			CONFIG_SMC_USE_32_BIT
1293f39748aeSwdenk			Define this if data bus is 32 bits
1294f39748aeSwdenk
1295f39748aeSwdenk			CONFIG_SMC_USE_IOFUNCS
1296f39748aeSwdenk			Define this to use i/o functions instead of macros
1297f39748aeSwdenk			(some hardware wont work with macros)
1298f39748aeSwdenk
1299dc02badaSHeiko Schocher		CONFIG_DRIVER_TI_EMAC
1300dc02badaSHeiko Schocher		Support for davinci emac
1301dc02badaSHeiko Schocher
1302dc02badaSHeiko Schocher			CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1303dc02badaSHeiko Schocher			Define this if you have more then 3 PHYs.
1304dc02badaSHeiko Schocher
1305b3dbf4a5SMacpaul Lin		CONFIG_FTGMAC100
1306b3dbf4a5SMacpaul Lin		Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1307b3dbf4a5SMacpaul Lin
1308b3dbf4a5SMacpaul Lin			CONFIG_FTGMAC100_EGIGA
1309b3dbf4a5SMacpaul Lin			Define this to use GE link update with gigabit PHY.
1310b3dbf4a5SMacpaul Lin			Define this if FTGMAC100 is connected to gigabit PHY.
1311b3dbf4a5SMacpaul Lin			If your system has 10/100 PHY only, it might not occur
1312b3dbf4a5SMacpaul Lin			wrong behavior. Because PHY usually return timeout or
1313b3dbf4a5SMacpaul Lin			useless data when polling gigabit status and gigabit
1314b3dbf4a5SMacpaul Lin			control registers. This behavior won't affect the
1315b3dbf4a5SMacpaul Lin			correctnessof 10/100 link speed update.
1316b3dbf4a5SMacpaul Lin
1317c2fff331SMike Rapoport		CONFIG_SMC911X
1318557b377dSJens Gehrlein		Support for SMSC's LAN911x and LAN921x chips
1319557b377dSJens Gehrlein
1320c2fff331SMike Rapoport			CONFIG_SMC911X_BASE
1321557b377dSJens Gehrlein			Define this to hold the physical address
1322557b377dSJens Gehrlein			of the device (I/O space)
1323557b377dSJens Gehrlein
1324c2fff331SMike Rapoport			CONFIG_SMC911X_32_BIT
1325557b377dSJens Gehrlein			Define this if data bus is 32 bits
1326557b377dSJens Gehrlein
1327c2fff331SMike Rapoport			CONFIG_SMC911X_16_BIT
1328557b377dSJens Gehrlein			Define this if data bus is 16 bits. If your processor
1329557b377dSJens Gehrlein			automatically converts one 32 bit word to two 16 bit
1330c2fff331SMike Rapoport			words you may also try CONFIG_SMC911X_32_BIT.
1331557b377dSJens Gehrlein
13323d0075faSYoshihiro Shimoda		CONFIG_SH_ETHER
13333d0075faSYoshihiro Shimoda		Support for Renesas on-chip Ethernet controller
13343d0075faSYoshihiro Shimoda
13353d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_USE_PORT
13363d0075faSYoshihiro Shimoda			Define the number of ports to be used
13373d0075faSYoshihiro Shimoda
13383d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_PHY_ADDR
13393d0075faSYoshihiro Shimoda			Define the ETH PHY's address
13403d0075faSYoshihiro Shimoda
134168260aabSYoshihiro Shimoda			CONFIG_SH_ETHER_CACHE_WRITEBACK
134268260aabSYoshihiro Shimoda			If this option is set, the driver enables cache flush.
134368260aabSYoshihiro Shimoda
13445e124724SVadim Bendebury- TPM Support:
134590899cc0SChe-liang Chiou		CONFIG_TPM
134690899cc0SChe-liang Chiou		Support TPM devices.
134790899cc0SChe-liang Chiou
13481b393db5STom Wai-Hong Tam		CONFIG_TPM_TIS_I2C
13491b393db5STom Wai-Hong Tam		Support for i2c bus TPM devices. Only one device
13501b393db5STom Wai-Hong Tam		per system is supported at this time.
13511b393db5STom Wai-Hong Tam
13521b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_BUS_NUMBER
13531b393db5STom Wai-Hong Tam			Define the the i2c bus number for the TPM device
13541b393db5STom Wai-Hong Tam
13551b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS
13561b393db5STom Wai-Hong Tam			Define the TPM's address on the i2c bus
13571b393db5STom Wai-Hong Tam
13581b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_BURST_LIMITATION
13591b393db5STom Wai-Hong Tam			Define the burst count bytes upper limit
13601b393db5STom Wai-Hong Tam
1361c01939c7SDirk Eibach		CONFIG_TPM_ATMEL_TWI
1362c01939c7SDirk Eibach		Support for Atmel TWI TPM device. Requires I2C support.
1363c01939c7SDirk Eibach
136490899cc0SChe-liang Chiou		CONFIG_TPM_TIS_LPC
13655e124724SVadim Bendebury		Support for generic parallel port TPM devices. Only one device
13665e124724SVadim Bendebury		per system is supported at this time.
13675e124724SVadim Bendebury
13685e124724SVadim Bendebury			CONFIG_TPM_TIS_BASE_ADDRESS
13695e124724SVadim Bendebury			Base address where the generic TPM device is mapped
13705e124724SVadim Bendebury			to. Contemporary x86 systems usually map it at
13715e124724SVadim Bendebury			0xfed40000.
13725e124724SVadim Bendebury
1373be6c1529SReinhard Pfau		CONFIG_CMD_TPM
1374be6c1529SReinhard Pfau		Add tpm monitor functions.
1375be6c1529SReinhard Pfau		Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1376be6c1529SReinhard Pfau		provides monitor access to authorized functions.
1377be6c1529SReinhard Pfau
1378be6c1529SReinhard Pfau		CONFIG_TPM
1379be6c1529SReinhard Pfau		Define this to enable the TPM support library which provides
1380be6c1529SReinhard Pfau		functional interfaces to some TPM commands.
1381be6c1529SReinhard Pfau		Requires support for a TPM device.
1382be6c1529SReinhard Pfau
1383be6c1529SReinhard Pfau		CONFIG_TPM_AUTH_SESSIONS
1384be6c1529SReinhard Pfau		Define this to enable authorized functions in the TPM library.
1385be6c1529SReinhard Pfau		Requires CONFIG_TPM and CONFIG_SHA1.
1386be6c1529SReinhard Pfau
1387c609719bSwdenk- USB Support:
1388c609719bSwdenk		At the moment only the UHCI host controller is
13894d13cbadSwdenk		supported (PIP405, MIP405, MPC5200); define
1390c609719bSwdenk		CONFIG_USB_UHCI to enable it.
1391c609719bSwdenk		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
139230d56faeSwdenk		and define CONFIG_USB_STORAGE to enable the USB
1393c609719bSwdenk		storage devices.
1394c609719bSwdenk		Note:
1395c609719bSwdenk		Supported are USB Keyboards and USB Floppy drives
1396c609719bSwdenk		(TEAC FD-05PUB).
13974d13cbadSwdenk		MPC5200 USB requires additional defines:
13984d13cbadSwdenk			CONFIG_USB_CLOCK
13994d13cbadSwdenk				for 528 MHz Clock: 0x0001bbbb
1400307ecb6dSEric Millbrandt			CONFIG_PSC3_USB
1401307ecb6dSEric Millbrandt				for USB on PSC3
14024d13cbadSwdenk			CONFIG_USB_CONFIG
14034d13cbadSwdenk				for differential drivers: 0x00001000
14044d13cbadSwdenk				for single ended drivers: 0x00005000
1405307ecb6dSEric Millbrandt				for differential drivers on PSC3: 0x00000100
1406307ecb6dSEric Millbrandt				for single ended drivers on PSC3: 0x00004100
14076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_USB_EVENT_POLL
1408fdcfaa1bSZhang Wei				May be defined to allow interrupt polling
1409fdcfaa1bSZhang Wei				instead of using asynchronous interrupts
14104d13cbadSwdenk
14119ab4ce22SSimon Glass		CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
14129ab4ce22SSimon Glass		txfilltuning field in the EHCI controller on reset.
14139ab4ce22SSimon Glass
1414aa155058SKuo-Jung Su		CONFIG_USB_HUB_MIN_POWER_ON_DELAY defines the minimum
1415aa155058SKuo-Jung Su		interval for usb hub power-on delay.(minimum 100msec)
1416aa155058SKuo-Jung Su
141716c8d5e7SWolfgang Denk- USB Device:
141816c8d5e7SWolfgang Denk		Define the below if you wish to use the USB console.
141916c8d5e7SWolfgang Denk		Once firmware is rebuilt from a serial console issue the
142016c8d5e7SWolfgang Denk		command "setenv stdin usbtty; setenv stdout usbtty" and
142111ccc33fSMarcel Ziswiler		attach your USB cable. The Unix command "dmesg" should print
142216c8d5e7SWolfgang Denk		it has found a new device. The environment variable usbtty
142316c8d5e7SWolfgang Denk		can be set to gserial or cdc_acm to enable your device to
142416c8d5e7SWolfgang Denk		appear to a USB host as a Linux gserial device or a
142516c8d5e7SWolfgang Denk		Common Device Class Abstract Control Model serial device.
142616c8d5e7SWolfgang Denk		If you select usbtty = gserial you should be able to enumerate
142716c8d5e7SWolfgang Denk		a Linux host by
142816c8d5e7SWolfgang Denk		# modprobe usbserial vendor=0xVendorID product=0xProductID
142916c8d5e7SWolfgang Denk		else if using cdc_acm, simply setting the environment
143016c8d5e7SWolfgang Denk		variable usbtty to be cdc_acm should suffice. The following
143116c8d5e7SWolfgang Denk		might be defined in YourBoardName.h
143216c8d5e7SWolfgang Denk
143316c8d5e7SWolfgang Denk			CONFIG_USB_DEVICE
143416c8d5e7SWolfgang Denk			Define this to build a UDC device
143516c8d5e7SWolfgang Denk
143616c8d5e7SWolfgang Denk			CONFIG_USB_TTY
143716c8d5e7SWolfgang Denk			Define this to have a tty type of device available to
143816c8d5e7SWolfgang Denk			talk to the UDC device
143916c8d5e7SWolfgang Denk
1440f9da0f89SVipin KUMAR			CONFIG_USBD_HS
1441f9da0f89SVipin KUMAR			Define this to enable the high speed support for usb
1442f9da0f89SVipin KUMAR			device and usbtty. If this feature is enabled, a routine
1443f9da0f89SVipin KUMAR			int is_usbd_high_speed(void)
1444f9da0f89SVipin KUMAR			also needs to be defined by the driver to dynamically poll
1445f9da0f89SVipin KUMAR			whether the enumeration has succeded at high speed or full
1446f9da0f89SVipin KUMAR			speed.
1447f9da0f89SVipin KUMAR
14486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_IS_IN_ENV
144916c8d5e7SWolfgang Denk			Define this if you want stdin, stdout &/or stderr to
145016c8d5e7SWolfgang Denk			be set to usbtty.
145116c8d5e7SWolfgang Denk
145216c8d5e7SWolfgang Denk			mpc8xx:
14536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_EXTC_CLK 0xBLAH
145416c8d5e7SWolfgang Denk				Derive USB clock from external clock "blah"
14556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_EXTC_CLK 0x02
145616c8d5e7SWolfgang Denk
14576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_BRG_CLK 0xBLAH
145816c8d5e7SWolfgang Denk				Derive USB clock from brgclk
14596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_BRG_CLK 0x04
146016c8d5e7SWolfgang Denk
146116c8d5e7SWolfgang Denk		If you have a USB-IF assigned VendorID then you may wish to
146216c8d5e7SWolfgang Denk		define your own vendor specific values either in BoardName.h
146316c8d5e7SWolfgang Denk		or directly in usbd_vendor_info.h. If you don't define
146416c8d5e7SWolfgang Denk		CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
146516c8d5e7SWolfgang Denk		CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
146616c8d5e7SWolfgang Denk		should pretend to be a Linux device to it's target host.
146716c8d5e7SWolfgang Denk
146816c8d5e7SWolfgang Denk			CONFIG_USBD_MANUFACTURER
146916c8d5e7SWolfgang Denk			Define this string as the name of your company for
147016c8d5e7SWolfgang Denk			- CONFIG_USBD_MANUFACTURER "my company"
147116c8d5e7SWolfgang Denk
147216c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCT_NAME
147316c8d5e7SWolfgang Denk			Define this string as the name of your product
147416c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCT_NAME "acme usb device"
147516c8d5e7SWolfgang Denk
147616c8d5e7SWolfgang Denk			CONFIG_USBD_VENDORID
147716c8d5e7SWolfgang Denk			Define this as your assigned Vendor ID from the USB
147816c8d5e7SWolfgang Denk			Implementors Forum. This *must* be a genuine Vendor ID
147916c8d5e7SWolfgang Denk			to avoid polluting the USB namespace.
148016c8d5e7SWolfgang Denk			- CONFIG_USBD_VENDORID 0xFFFF
148116c8d5e7SWolfgang Denk
148216c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCTID
148316c8d5e7SWolfgang Denk			Define this as the unique Product ID
148416c8d5e7SWolfgang Denk			for your device
148516c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCTID 0xFFFF
1486c609719bSwdenk
1487d70a560fSIgor Grinberg- ULPI Layer Support:
1488d70a560fSIgor Grinberg		The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1489d70a560fSIgor Grinberg		the generic ULPI layer. The generic layer accesses the ULPI PHY
1490d70a560fSIgor Grinberg		via the platform viewport, so you need both the genric layer and
1491d70a560fSIgor Grinberg		the viewport enabled. Currently only Chipidea/ARC based
1492d70a560fSIgor Grinberg		viewport is supported.
1493d70a560fSIgor Grinberg		To enable the ULPI layer support, define CONFIG_USB_ULPI and
1494d70a560fSIgor Grinberg		CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
14956d365ea0SLucas Stach		If your ULPI phy needs a different reference clock than the
14966d365ea0SLucas Stach		standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
14976d365ea0SLucas Stach		the appropriate value in Hz.
1498c609719bSwdenk
1499c609719bSwdenk- MMC Support:
1500c609719bSwdenk		The MMC controller on the Intel PXA is supported. To
1501c609719bSwdenk		enable this define CONFIG_MMC. The MMC can be
1502c609719bSwdenk		accessed from the boot prompt by mapping the device
1503c609719bSwdenk		to physical memory similar to flash. Command line is
1504602ad3b3SJon Loeliger		enabled with CONFIG_CMD_MMC. The MMC driver also works with
1505602ad3b3SJon Loeliger		the FAT fs. This is enabled with CONFIG_CMD_FAT.
1506c609719bSwdenk
1507afb35666SYoshihiro Shimoda		CONFIG_SH_MMCIF
1508afb35666SYoshihiro Shimoda		Support for Renesas on-chip MMCIF controller
1509afb35666SYoshihiro Shimoda
1510afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_ADDR
1511afb35666SYoshihiro Shimoda			Define the base address of MMCIF registers
1512afb35666SYoshihiro Shimoda
1513afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_CLK
1514afb35666SYoshihiro Shimoda			Define the clock frequency for MMCIF
1515afb35666SYoshihiro Shimoda
1516b3ba6e94STom Rini- USB Device Firmware Update (DFU) class support:
1517b3ba6e94STom Rini		CONFIG_DFU_FUNCTION
1518b3ba6e94STom Rini		This enables the USB portion of the DFU USB class
1519b3ba6e94STom Rini
1520b3ba6e94STom Rini		CONFIG_CMD_DFU
1521b3ba6e94STom Rini		This enables the command "dfu" which is used to have
1522b3ba6e94STom Rini		U-Boot create a DFU class device via USB.  This command
1523b3ba6e94STom Rini		requires that the "dfu_alt_info" environment variable be
1524b3ba6e94STom Rini		set and define the alt settings to expose to the host.
1525b3ba6e94STom Rini
1526b3ba6e94STom Rini		CONFIG_DFU_MMC
1527b3ba6e94STom Rini		This enables support for exposing (e)MMC devices via DFU.
1528b3ba6e94STom Rini
1529c6631764SPantelis Antoniou		CONFIG_DFU_NAND
1530c6631764SPantelis Antoniou		This enables support for exposing NAND devices via DFU.
1531c6631764SPantelis Antoniou
1532a9479f04SAfzal Mohammed		CONFIG_DFU_RAM
1533a9479f04SAfzal Mohammed		This enables support for exposing RAM via DFU.
1534a9479f04SAfzal Mohammed		Note: DFU spec refer to non-volatile memory usage, but
1535a9479f04SAfzal Mohammed		allow usages beyond the scope of spec - here RAM usage,
1536a9479f04SAfzal Mohammed		one that would help mostly the developer.
1537a9479f04SAfzal Mohammed
1538e7e75c70SHeiko Schocher		CONFIG_SYS_DFU_DATA_BUF_SIZE
1539e7e75c70SHeiko Schocher		Dfu transfer uses a buffer before writing data to the
1540e7e75c70SHeiko Schocher		raw storage device. Make the size (in bytes) of this buffer
1541e7e75c70SHeiko Schocher		configurable. The size of this buffer is also configurable
1542e7e75c70SHeiko Schocher		through the "dfu_bufsiz" environment variable.
1543e7e75c70SHeiko Schocher
1544ea2453d5SPantelis Antoniou		CONFIG_SYS_DFU_MAX_FILE_SIZE
1545ea2453d5SPantelis Antoniou		When updating files rather than the raw storage device,
1546ea2453d5SPantelis Antoniou		we use a static buffer to copy the file into and then write
1547ea2453d5SPantelis Antoniou		the buffer once we've been given the whole file.  Define
1548ea2453d5SPantelis Antoniou		this to the maximum filesize (in bytes) for the buffer.
1549ea2453d5SPantelis Antoniou		Default is 4 MiB if undefined.
1550ea2453d5SPantelis Antoniou
1551001a8319SHeiko Schocher		DFU_DEFAULT_POLL_TIMEOUT
1552001a8319SHeiko Schocher		Poll timeout [ms], is the timeout a device can send to the
1553001a8319SHeiko Schocher		host. The host must wait for this timeout before sending
1554001a8319SHeiko Schocher		a subsequent DFU_GET_STATUS request to the device.
1555001a8319SHeiko Schocher
1556001a8319SHeiko Schocher		DFU_MANIFEST_POLL_TIMEOUT
1557001a8319SHeiko Schocher		Poll timeout [ms], which the device sends to the host when
1558001a8319SHeiko Schocher		entering dfuMANIFEST state. Host waits this timeout, before
1559001a8319SHeiko Schocher		sending again an USB request to the device.
1560001a8319SHeiko Schocher
1561*3aab70afSSebastian Siewior- USB Device Android Fastboot support:
1562*3aab70afSSebastian Siewior		CONFIG_CMD_FASTBOOT
1563*3aab70afSSebastian Siewior		This enables the command "fastboot" which enables the Android
1564*3aab70afSSebastian Siewior		fastboot mode for the platform's USB device. Fastboot is a USB
1565*3aab70afSSebastian Siewior		protocol for downloading images, flashing and device control
1566*3aab70afSSebastian Siewior		used on Android devices.
1567*3aab70afSSebastian Siewior		See doc/README.android-fastboot for more information.
1568*3aab70afSSebastian Siewior
1569*3aab70afSSebastian Siewior		CONFIG_ANDROID_BOOT_IMAGE
1570*3aab70afSSebastian Siewior		This enables support for booting images which use the Android
1571*3aab70afSSebastian Siewior		image format header.
1572*3aab70afSSebastian Siewior
1573*3aab70afSSebastian Siewior		CONFIG_USB_FASTBOOT_BUF_ADDR
1574*3aab70afSSebastian Siewior		The fastboot protocol requires a large memory buffer for
1575*3aab70afSSebastian Siewior		downloads. Define this to the starting RAM address to use for
1576*3aab70afSSebastian Siewior		downloaded images.
1577*3aab70afSSebastian Siewior
1578*3aab70afSSebastian Siewior		CONFIG_USB_FASTBOOT_BUF_SIZE
1579*3aab70afSSebastian Siewior		The fastboot protocol requires a large memory buffer for
1580*3aab70afSSebastian Siewior		downloads. This buffer should be as large as possible for a
1581*3aab70afSSebastian Siewior		platform. Define this to the size available RAM for fastboot.
1582*3aab70afSSebastian Siewior
15836705d81eSwdenk- Journaling Flash filesystem support:
15846705d81eSwdenk		CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
15856705d81eSwdenk		CONFIG_JFFS2_NAND_DEV
15866705d81eSwdenk		Define these for a default partition on a NAND device
15876705d81eSwdenk
15886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_SECTOR,
15896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
15906705d81eSwdenk		Define these for a default partition on a NOR device
15916705d81eSwdenk
15926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS_CUSTOM_PART
15936705d81eSwdenk		Define this to create an own partition. You have to provide a
15946705d81eSwdenk		function struct part_info* jffs2_part_info(int part_num)
15956705d81eSwdenk
15966705d81eSwdenk		If you define only one JFFS2 partition you may also want to
15976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_JFFS_SINGLE_PART	1
15986705d81eSwdenk		to disable the command chpart. This is the default when you
15996705d81eSwdenk		have not defined a custom partition
16006705d81eSwdenk
1601c30a15e5SDonggeun Kim- FAT(File Allocation Table) filesystem write function support:
1602c30a15e5SDonggeun Kim		CONFIG_FAT_WRITE
1603656f4c65SDonggeun Kim
1604656f4c65SDonggeun Kim		Define this to enable support for saving memory data as a
1605656f4c65SDonggeun Kim		file in FAT formatted partition.
1606656f4c65SDonggeun Kim
1607656f4c65SDonggeun Kim		This will also enable the command "fatwrite" enabling the
1608656f4c65SDonggeun Kim		user to write files to FAT.
1609c30a15e5SDonggeun Kim
161084cd9327SGabe BlackCBFS (Coreboot Filesystem) support
161184cd9327SGabe Black		CONFIG_CMD_CBFS
161284cd9327SGabe Black
161384cd9327SGabe Black		Define this to enable support for reading from a Coreboot
161484cd9327SGabe Black		filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
161584cd9327SGabe Black		and cbfsload.
161684cd9327SGabe Black
1617c609719bSwdenk- Keyboard Support:
1618c609719bSwdenk		CONFIG_ISA_KEYBOARD
1619c609719bSwdenk
1620c609719bSwdenk		Define this to enable standard (PC-Style) keyboard
1621c609719bSwdenk		support
1622c609719bSwdenk
1623c609719bSwdenk		CONFIG_I8042_KBD
1624c609719bSwdenk		Standard PC keyboard driver with US (is default) and
1625c609719bSwdenk		GERMAN key layout (switch via environment 'keymap=de') support.
1626c609719bSwdenk		Export function i8042_kbd_init, i8042_tstc and i8042_getc
1627c609719bSwdenk		for cfb_console. Supports cursor blinking.
1628c609719bSwdenk
1629713cb680SHung-ying Tyan		CONFIG_CROS_EC_KEYB
1630713cb680SHung-ying Tyan		Enables a Chrome OS keyboard using the CROS_EC interface.
1631713cb680SHung-ying Tyan		This uses CROS_EC to communicate with a second microcontroller
1632713cb680SHung-ying Tyan		which provides key scans on request.
1633713cb680SHung-ying Tyan
1634c609719bSwdenk- Video support:
1635c609719bSwdenk		CONFIG_VIDEO
1636c609719bSwdenk
1637c609719bSwdenk		Define this to enable video support (for output to
1638c609719bSwdenk		video).
1639c609719bSwdenk
1640c609719bSwdenk		CONFIG_VIDEO_CT69000
1641c609719bSwdenk
1642c609719bSwdenk		Enable Chips & Technologies 69000 Video chip
1643c609719bSwdenk
1644c609719bSwdenk		CONFIG_VIDEO_SMI_LYNXEM
1645eeb1b77bSwdenk		Enable Silicon Motion SMI 712/710/810 Video chip. The
1646eeb1b77bSwdenk		video output is selected via environment 'videoout'
1647eeb1b77bSwdenk		(1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1648eeb1b77bSwdenk		assumed.
1649c609719bSwdenk
1650eeb1b77bSwdenk		For the CT69000 and SMI_LYNXEM drivers, videomode is
165111ccc33fSMarcel Ziswiler		selected via environment 'videomode'. Two different ways
1652eeb1b77bSwdenk		are possible:
1653eeb1b77bSwdenk		- "videomode=num"   'num' is a standard LiLo mode numbers.
1654eeb1b77bSwdenk		Following standard modes are supported	(* is default):
1655eeb1b77bSwdenk
1656eeb1b77bSwdenk		      Colors	640x480 800x600 1024x768 1152x864 1280x1024
1657eeb1b77bSwdenk		-------------+---------------------------------------------
1658eeb1b77bSwdenk		      8 bits |	0x301*	0x303	 0x305	  0x161	    0x307
1659eeb1b77bSwdenk		     15 bits |	0x310	0x313	 0x316	  0x162	    0x319
1660eeb1b77bSwdenk		     16 bits |	0x311	0x314	 0x317	  0x163	    0x31A
1661eeb1b77bSwdenk		     24 bits |	0x312	0x315	 0x318	    ?	    0x31B
1662eeb1b77bSwdenk		-------------+---------------------------------------------
1663c609719bSwdenk		(i.e. setenv videomode 317; saveenv; reset;)
1664c609719bSwdenk
1665eeb1b77bSwdenk		- "videomode=bootargs" all the video parameters are parsed
16667817cb20SMarcel Ziswiler		from the bootargs. (See drivers/video/videomodes.c)
1667eeb1b77bSwdenk
1668eeb1b77bSwdenk
1669a6c7ad2fSwdenk		CONFIG_VIDEO_SED13806
1670a6c7ad2fSwdenk		Enable Epson SED13806 driver. This driver supports 8bpp
1671a6c7ad2fSwdenk		and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1672a6c7ad2fSwdenk		or CONFIG_VIDEO_SED13806_16BPP
1673a6c7ad2fSwdenk
16747d3053fbSTimur Tabi		CONFIG_FSL_DIU_FB
16757d3053fbSTimur Tabi		Enable the Freescale DIU video driver.	Reference boards for
16767d3053fbSTimur Tabi		SOCs that have a DIU should define this macro to enable DIU
16777d3053fbSTimur Tabi		support, and should also define these other macros:
16787d3053fbSTimur Tabi
16797d3053fbSTimur Tabi			CONFIG_SYS_DIU_ADDR
16807d3053fbSTimur Tabi			CONFIG_VIDEO
16817d3053fbSTimur Tabi			CONFIG_CMD_BMP
16827d3053fbSTimur Tabi			CONFIG_CFB_CONSOLE
16837d3053fbSTimur Tabi			CONFIG_VIDEO_SW_CURSOR
16847d3053fbSTimur Tabi			CONFIG_VGA_AS_SINGLE_DEVICE
16857d3053fbSTimur Tabi			CONFIG_VIDEO_LOGO
16867d3053fbSTimur Tabi			CONFIG_VIDEO_BMP_LOGO
16877d3053fbSTimur Tabi
1688ba8e76bdSTimur Tabi		The DIU driver will look for the 'video-mode' environment
1689ba8e76bdSTimur Tabi		variable, and if defined, enable the DIU as a console during
1690ba8e76bdSTimur Tabi		boot.  See the documentation file README.video for a
1691ba8e76bdSTimur Tabi		description of this variable.
16927d3053fbSTimur Tabi
1693058d59b0SSimon Glass		CONFIG_VIDEO_VGA
1694058d59b0SSimon Glass
1695058d59b0SSimon Glass		Enable the VGA video / BIOS for x86. The alternative if you
1696058d59b0SSimon Glass		are using coreboot is to use the coreboot frame buffer
1697058d59b0SSimon Glass		driver.
1698058d59b0SSimon Glass
1699058d59b0SSimon Glass
1700682011ffSwdenk- Keyboard Support:
1701682011ffSwdenk		CONFIG_KEYBOARD
1702682011ffSwdenk
1703682011ffSwdenk		Define this to enable a custom keyboard support.
1704682011ffSwdenk		This simply calls drv_keyboard_init() which must be
1705682011ffSwdenk		defined in your board-specific files.
1706682011ffSwdenk		The only board using this so far is RBC823.
1707a6c7ad2fSwdenk
1708c609719bSwdenk- LCD Support:	CONFIG_LCD
1709c609719bSwdenk
1710c609719bSwdenk		Define this to enable LCD support (for output to LCD
1711c609719bSwdenk		display); also select one of the supported displays
1712c609719bSwdenk		by defining one of these:
1713c609719bSwdenk
171439cf4804SStelian Pop		CONFIG_ATMEL_LCD:
171539cf4804SStelian Pop
171639cf4804SStelian Pop			HITACHI TX09D70VM1CCA, 3.5", 240x320.
171739cf4804SStelian Pop
1718fd3103bbSwdenk		CONFIG_NEC_NL6448AC33:
1719c609719bSwdenk
1720fd3103bbSwdenk			NEC NL6448AC33-18. Active, color, single scan.
1721c609719bSwdenk
1722fd3103bbSwdenk		CONFIG_NEC_NL6448BC20
1723c609719bSwdenk
1724fd3103bbSwdenk			NEC NL6448BC20-08. 6.5", 640x480.
1725fd3103bbSwdenk			Active, color, single scan.
1726fd3103bbSwdenk
1727fd3103bbSwdenk		CONFIG_NEC_NL6448BC33_54
1728fd3103bbSwdenk
1729fd3103bbSwdenk			NEC NL6448BC33-54. 10.4", 640x480.
1730c609719bSwdenk			Active, color, single scan.
1731c609719bSwdenk
1732c609719bSwdenk		CONFIG_SHARP_16x9
1733c609719bSwdenk
1734c609719bSwdenk			Sharp 320x240. Active, color, single scan.
1735c609719bSwdenk			It isn't 16x9, and I am not sure what it is.
1736c609719bSwdenk
1737c609719bSwdenk		CONFIG_SHARP_LQ64D341
1738c609719bSwdenk
1739c609719bSwdenk			Sharp LQ64D341 display, 640x480.
1740c609719bSwdenk			Active, color, single scan.
1741c609719bSwdenk
1742c609719bSwdenk		CONFIG_HLD1045
1743c609719bSwdenk
1744c609719bSwdenk			HLD1045 display, 640x480.
1745c609719bSwdenk			Active, color, single scan.
1746c609719bSwdenk
1747c609719bSwdenk		CONFIG_OPTREX_BW
1748c609719bSwdenk
1749c609719bSwdenk			Optrex	 CBL50840-2 NF-FW 99 22 M5
1750c609719bSwdenk			or
1751c609719bSwdenk			Hitachi	 LMG6912RPFC-00T
1752c609719bSwdenk			or
1753c609719bSwdenk			Hitachi	 SP14Q002
1754c609719bSwdenk
1755c609719bSwdenk			320x240. Black & white.
1756c609719bSwdenk
1757c609719bSwdenk		Normally display is black on white background; define
17586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
1759c609719bSwdenk
1760676d319eSSimon Glass		CONFIG_LCD_ALIGNMENT
1761676d319eSSimon Glass
1762676d319eSSimon Glass		Normally the LCD is page-aligned (tyically 4KB). If this is
1763676d319eSSimon Glass		defined then the LCD will be aligned to this value instead.
1764676d319eSSimon Glass		For ARM it is sometimes useful to use MMU_SECTION_SIZE
1765676d319eSSimon Glass		here, since it is cheaper to change data cache settings on
1766676d319eSSimon Glass		a per-section basis.
1767676d319eSSimon Glass
17680d89efefSSimon Glass		CONFIG_CONSOLE_SCROLL_LINES
17690d89efefSSimon Glass
17700d89efefSSimon Glass		When the console need to be scrolled, this is the number of
17710d89efefSSimon Glass		lines to scroll by. It defaults to 1. Increasing this makes
17720d89efefSSimon Glass		the console jump but can help speed up operation when scrolling
17730d89efefSSimon Glass		is slow.
1774676d319eSSimon Glass
177545d7f525STom Wai-Hong Tam		CONFIG_LCD_BMP_RLE8
177645d7f525STom Wai-Hong Tam
177745d7f525STom Wai-Hong Tam		Support drawing of RLE8-compressed bitmaps on the LCD.
177845d7f525STom Wai-Hong Tam
1779735987c5STom Wai-Hong Tam		CONFIG_I2C_EDID
1780735987c5STom Wai-Hong Tam
1781735987c5STom Wai-Hong Tam		Enables an 'i2c edid' command which can read EDID
1782735987c5STom Wai-Hong Tam		information over I2C from an attached LCD display.
1783735987c5STom Wai-Hong Tam
17847152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN
1785d791b1dcSwdenk
1786d791b1dcSwdenk		If this option is set, the environment is checked for
1787d791b1dcSwdenk		a variable "splashimage". If found, the usual display
1788d791b1dcSwdenk		of logo, copyright and system information on the LCD
1789e94d2cd9Swdenk		is suppressed and the BMP image at the address
1790d791b1dcSwdenk		specified in "splashimage" is loaded instead. The
1791d791b1dcSwdenk		console is redirected to the "nulldev", too. This
1792d791b1dcSwdenk		allows for a "silent" boot where a splash screen is
1793d791b1dcSwdenk		loaded very quickly after power-on.
1794d791b1dcSwdenk
1795c0880485SNikita Kiryanov		CONFIG_SPLASHIMAGE_GUARD
1796c0880485SNikita Kiryanov
1797c0880485SNikita Kiryanov		If this option is set, then U-Boot will prevent the environment
1798c0880485SNikita Kiryanov		variable "splashimage" from being set to a problematic address
17991551df35STom Rini		(see README.displaying-bmps).
1800c0880485SNikita Kiryanov		This option is useful for targets where, due to alignment
1801c0880485SNikita Kiryanov		restrictions, an improperly aligned BMP image will cause a data
1802c0880485SNikita Kiryanov		abort. If you think you will not have problems with unaligned
1803c0880485SNikita Kiryanov		accesses (for example because your toolchain prevents them)
1804c0880485SNikita Kiryanov		there is no need to set this option.
1805c0880485SNikita Kiryanov
18061ca298ceSMatthias Weisser		CONFIG_SPLASH_SCREEN_ALIGN
18071ca298ceSMatthias Weisser
18081ca298ceSMatthias Weisser		If this option is set the splash image can be freely positioned
18091ca298ceSMatthias Weisser		on the screen. Environment variable "splashpos" specifies the
18101ca298ceSMatthias Weisser		position as "x,y". If a positive number is given it is used as
18111ca298ceSMatthias Weisser		number of pixel from left/top. If a negative number is given it
18121ca298ceSMatthias Weisser		is used as number of pixel from right/bottom. You can also
18131ca298ceSMatthias Weisser		specify 'm' for centering the image.
18141ca298ceSMatthias Weisser
18151ca298ceSMatthias Weisser		Example:
18161ca298ceSMatthias Weisser		setenv splashpos m,m
18171ca298ceSMatthias Weisser			=> image at center of screen
18181ca298ceSMatthias Weisser
18191ca298ceSMatthias Weisser		setenv splashpos 30,20
18201ca298ceSMatthias Weisser			=> image at x = 30 and y = 20
18211ca298ceSMatthias Weisser
18221ca298ceSMatthias Weisser		setenv splashpos -10,m
18231ca298ceSMatthias Weisser			=> vertically centered image
18241ca298ceSMatthias Weisser			   at x = dspWidth - bmpWidth - 9
18251ca298ceSMatthias Weisser
182698f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
182798f4a3dfSStefan Roese
182898f4a3dfSStefan Roese		If this option is set, additionally to standard BMP
182998f4a3dfSStefan Roese		images, gzipped BMP images can be displayed via the
183098f4a3dfSStefan Roese		splashscreen support or the bmp command.
183198f4a3dfSStefan Roese
1832d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1833d5011762SAnatolij Gustschin
1834d5011762SAnatolij Gustschin		If this option is set, 8-bit RLE compressed BMP images
1835d5011762SAnatolij Gustschin		can be displayed via the splashscreen support or the
1836d5011762SAnatolij Gustschin		bmp command.
1837d5011762SAnatolij Gustschin
1838f2b96dfbSLei Wen- Do compresssing for memory range:
1839f2b96dfbSLei Wen		CONFIG_CMD_ZIP
1840f2b96dfbSLei Wen
1841f2b96dfbSLei Wen		If this option is set, it would use zlib deflate method
1842f2b96dfbSLei Wen		to compress the specified memory at its best effort.
1843f2b96dfbSLei Wen
1844c29fdfc1Swdenk- Compression support:
18458ef70478SKees Cook		CONFIG_GZIP
18468ef70478SKees Cook
18478ef70478SKees Cook		Enabled by default to support gzip compressed images.
18488ef70478SKees Cook
1849c29fdfc1Swdenk		CONFIG_BZIP2
1850c29fdfc1Swdenk
1851c29fdfc1Swdenk		If this option is set, support for bzip2 compressed
1852c29fdfc1Swdenk		images is included. If not, only uncompressed and gzip
1853c29fdfc1Swdenk		compressed images are supported.
1854c29fdfc1Swdenk
1855c29fdfc1Swdenk		NOTE: the bzip2 algorithm requires a lot of RAM, so
18566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
1857c29fdfc1Swdenk		be at least 4MB.
1858d791b1dcSwdenk
1859fc9c1727SLuigi 'Comio' Mantellini		CONFIG_LZMA
1860fc9c1727SLuigi 'Comio' Mantellini
1861fc9c1727SLuigi 'Comio' Mantellini		If this option is set, support for lzma compressed
1862fc9c1727SLuigi 'Comio' Mantellini		images is included.
1863fc9c1727SLuigi 'Comio' Mantellini
1864fc9c1727SLuigi 'Comio' Mantellini		Note: The LZMA algorithm adds between 2 and 4KB of code and it
1865fc9c1727SLuigi 'Comio' Mantellini		requires an amount of dynamic memory that is given by the
1866fc9c1727SLuigi 'Comio' Mantellini		formula:
1867fc9c1727SLuigi 'Comio' Mantellini
1868fc9c1727SLuigi 'Comio' Mantellini			(1846 + 768 << (lc + lp)) * sizeof(uint16)
1869fc9c1727SLuigi 'Comio' Mantellini
1870fc9c1727SLuigi 'Comio' Mantellini		Where lc and lp stand for, respectively, Literal context bits
1871fc9c1727SLuigi 'Comio' Mantellini		and Literal pos bits.
1872fc9c1727SLuigi 'Comio' Mantellini
1873fc9c1727SLuigi 'Comio' Mantellini		This value is upper-bounded by 14MB in the worst case. Anyway,
1874fc9c1727SLuigi 'Comio' Mantellini		for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1875fc9c1727SLuigi 'Comio' Mantellini		total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1876fc9c1727SLuigi 'Comio' Mantellini		a very small buffer.
1877fc9c1727SLuigi 'Comio' Mantellini
1878fc9c1727SLuigi 'Comio' Mantellini		Use the lzmainfo tool to determinate the lc and lp values and
1879fc9c1727SLuigi 'Comio' Mantellini		then calculate the amount of needed dynamic memory (ensuring
18806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the appropriate CONFIG_SYS_MALLOC_LEN value).
1881fc9c1727SLuigi 'Comio' Mantellini
18828ef70478SKees Cook		CONFIG_LZO
18838ef70478SKees Cook
18848ef70478SKees Cook		If this option is set, support for LZO compressed images
18858ef70478SKees Cook		is included.
18868ef70478SKees Cook
188717ea1177Swdenk- MII/PHY support:
188817ea1177Swdenk		CONFIG_PHY_ADDR
188917ea1177Swdenk
189017ea1177Swdenk		The address of PHY on MII bus.
189117ea1177Swdenk
189217ea1177Swdenk		CONFIG_PHY_CLOCK_FREQ (ppc4xx)
189317ea1177Swdenk
189417ea1177Swdenk		The clock frequency of the MII bus
189517ea1177Swdenk
189617ea1177Swdenk		CONFIG_PHY_GIGE
189717ea1177Swdenk
189817ea1177Swdenk		If this option is set, support for speed/duplex
189911ccc33fSMarcel Ziswiler		detection of gigabit PHY is included.
190017ea1177Swdenk
190117ea1177Swdenk		CONFIG_PHY_RESET_DELAY
190217ea1177Swdenk
190317ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
190417ea1177Swdenk		reset before any MII register access is possible.
190517ea1177Swdenk		For such PHY, set this option to the usec delay
190617ea1177Swdenk		required. (minimum 300usec for LXT971A)
190717ea1177Swdenk
190817ea1177Swdenk		CONFIG_PHY_CMD_DELAY (ppc4xx)
190917ea1177Swdenk
191017ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
191117ea1177Swdenk		command issued before MII status register can be read
191217ea1177Swdenk
1913c609719bSwdenk- Ethernet address:
1914c609719bSwdenk		CONFIG_ETHADDR
1915c68a05feSrichardretanubun		CONFIG_ETH1ADDR
1916c609719bSwdenk		CONFIG_ETH2ADDR
1917c609719bSwdenk		CONFIG_ETH3ADDR
1918c68a05feSrichardretanubun		CONFIG_ETH4ADDR
1919c68a05feSrichardretanubun		CONFIG_ETH5ADDR
1920c609719bSwdenk
192111ccc33fSMarcel Ziswiler		Define a default value for Ethernet address to use
192211ccc33fSMarcel Ziswiler		for the respective Ethernet interface, in case this
1923c609719bSwdenk		is not determined automatically.
1924c609719bSwdenk
1925c609719bSwdenk- IP address:
1926c609719bSwdenk		CONFIG_IPADDR
1927c609719bSwdenk
1928c609719bSwdenk		Define a default value for the IP address to use for
192911ccc33fSMarcel Ziswiler		the default Ethernet interface, in case this is not
1930c609719bSwdenk		determined through e.g. bootp.
19311ebcd654SWolfgang Denk		(Environment variable "ipaddr")
1932c609719bSwdenk
1933c609719bSwdenk- Server IP address:
1934c609719bSwdenk		CONFIG_SERVERIP
1935c609719bSwdenk
1936c609719bSwdenk		Defines a default value for the IP address of a TFTP
1937c609719bSwdenk		server to contact when using the "tftboot" command.
19381ebcd654SWolfgang Denk		(Environment variable "serverip")
1939c609719bSwdenk
194097cfe861SRobin Getz		CONFIG_KEEP_SERVERADDR
194197cfe861SRobin Getz
194297cfe861SRobin Getz		Keeps the server's MAC address, in the env 'serveraddr'
194397cfe861SRobin Getz		for passing to bootargs (like Linux's netconsole option)
194497cfe861SRobin Getz
19451ebcd654SWolfgang Denk- Gateway IP address:
19461ebcd654SWolfgang Denk		CONFIG_GATEWAYIP
19471ebcd654SWolfgang Denk
19481ebcd654SWolfgang Denk		Defines a default value for the IP address of the
19491ebcd654SWolfgang Denk		default router where packets to other networks are
19501ebcd654SWolfgang Denk		sent to.
19511ebcd654SWolfgang Denk		(Environment variable "gatewayip")
19521ebcd654SWolfgang Denk
19531ebcd654SWolfgang Denk- Subnet mask:
19541ebcd654SWolfgang Denk		CONFIG_NETMASK
19551ebcd654SWolfgang Denk
19561ebcd654SWolfgang Denk		Defines a default value for the subnet mask (or
19571ebcd654SWolfgang Denk		routing prefix) which is used to determine if an IP
19581ebcd654SWolfgang Denk		address belongs to the local subnet or needs to be
19591ebcd654SWolfgang Denk		forwarded through a router.
19601ebcd654SWolfgang Denk		(Environment variable "netmask")
19611ebcd654SWolfgang Denk
196253a5c424SDavid Updegraff- Multicast TFTP Mode:
196353a5c424SDavid Updegraff		CONFIG_MCAST_TFTP
196453a5c424SDavid Updegraff
196553a5c424SDavid Updegraff		Defines whether you want to support multicast TFTP as per
196653a5c424SDavid Updegraff		rfc-2090; for example to work with atftp.  Lets lots of targets
196711ccc33fSMarcel Ziswiler		tftp down the same boot image concurrently.  Note: the Ethernet
196853a5c424SDavid Updegraff		driver in use must provide a function: mcast() to join/leave a
196953a5c424SDavid Updegraff		multicast group.
197053a5c424SDavid Updegraff
1971c609719bSwdenk- BOOTP Recovery Mode:
1972c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY
1973c609719bSwdenk
1974c609719bSwdenk		If you have many targets in a network that try to
1975c609719bSwdenk		boot using BOOTP, you may want to avoid that all
1976c609719bSwdenk		systems send out BOOTP requests at precisely the same
1977c609719bSwdenk		moment (which would happen for instance at recovery
1978c609719bSwdenk		from a power failure, when all systems will try to
1979c609719bSwdenk		boot, thus flooding the BOOTP server. Defining
1980c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1981c609719bSwdenk		inserted before sending out BOOTP requests. The
19826c33c785SWolfgang Denk		following delays are inserted then:
1983c609719bSwdenk
1984c609719bSwdenk		1st BOOTP request:	delay 0 ... 1 sec
1985c609719bSwdenk		2nd BOOTP request:	delay 0 ... 2 sec
1986c609719bSwdenk		3rd BOOTP request:	delay 0 ... 4 sec
1987c609719bSwdenk		4th and following
1988c609719bSwdenk		BOOTP requests:		delay 0 ... 8 sec
1989c609719bSwdenk
1990fe389a82Sstroese- DHCP Advanced Options:
19911fe80d79SJon Loeliger		You can fine tune the DHCP functionality by defining
19921fe80d79SJon Loeliger		CONFIG_BOOTP_* symbols:
1993fe389a82Sstroese
19941fe80d79SJon Loeliger		CONFIG_BOOTP_SUBNETMASK
19951fe80d79SJon Loeliger		CONFIG_BOOTP_GATEWAY
19961fe80d79SJon Loeliger		CONFIG_BOOTP_HOSTNAME
19971fe80d79SJon Loeliger		CONFIG_BOOTP_NISDOMAIN
19981fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTPATH
19991fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTFILESIZE
20001fe80d79SJon Loeliger		CONFIG_BOOTP_DNS
20011fe80d79SJon Loeliger		CONFIG_BOOTP_DNS2
20021fe80d79SJon Loeliger		CONFIG_BOOTP_SEND_HOSTNAME
20031fe80d79SJon Loeliger		CONFIG_BOOTP_NTPSERVER
20041fe80d79SJon Loeliger		CONFIG_BOOTP_TIMEOFFSET
20051fe80d79SJon Loeliger		CONFIG_BOOTP_VENDOREX
20062c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL
2007fe389a82Sstroese
20085d110f0aSWilson Callan		CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
20095d110f0aSWilson Callan		environment variable, not the BOOTP server.
2010fe389a82Sstroese
20112c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
20122c00e099SJoe Hershberger		after the configured retry count, the call will fail
20132c00e099SJoe Hershberger		instead of starting over.  This can be used to fail over
20142c00e099SJoe Hershberger		to Link-local IP address configuration if the DHCP server
20152c00e099SJoe Hershberger		is not available.
20162c00e099SJoe Hershberger
2017fe389a82Sstroese		CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
2018fe389a82Sstroese		serverip from a DHCP server, it is possible that more
2019fe389a82Sstroese		than one DNS serverip is offered to the client.
2020fe389a82Sstroese		If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
2021fe389a82Sstroese		serverip will be stored in the additional environment
2022fe389a82Sstroese		variable "dnsip2". The first DNS serverip is always
2023fe389a82Sstroese		stored in the variable "dnsip", when CONFIG_BOOTP_DNS
20241fe80d79SJon Loeliger		is defined.
2025fe389a82Sstroese
2026fe389a82Sstroese		CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
2027fe389a82Sstroese		to do a dynamic update of a DNS server. To do this, they
2028fe389a82Sstroese		need the hostname of the DHCP requester.
20295d110f0aSWilson Callan		If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
20301fe80d79SJon Loeliger		of the "hostname" environment variable is passed as
20311fe80d79SJon Loeliger		option 12 to the DHCP server.
2032fe389a82Sstroese
2033d9a2f416SAras Vaichas		CONFIG_BOOTP_DHCP_REQUEST_DELAY
2034d9a2f416SAras Vaichas
2035d9a2f416SAras Vaichas		A 32bit value in microseconds for a delay between
2036d9a2f416SAras Vaichas		receiving a "DHCP Offer" and sending the "DHCP Request".
2037d9a2f416SAras Vaichas		This fixes a problem with certain DHCP servers that don't
2038d9a2f416SAras Vaichas		respond 100% of the time to a "DHCP request". E.g. On an
2039d9a2f416SAras Vaichas		AT91RM9200 processor running at 180MHz, this delay needed
2040d9a2f416SAras Vaichas		to be *at least* 15,000 usec before a Windows Server 2003
2041d9a2f416SAras Vaichas		DHCP server would reply 100% of the time. I recommend at
2042d9a2f416SAras Vaichas		least 50,000 usec to be safe. The alternative is to hope
2043d9a2f416SAras Vaichas		that one of the retries will be successful but note that
2044d9a2f416SAras Vaichas		the DHCP timeout and retry process takes a longer than
2045d9a2f416SAras Vaichas		this delay.
2046d9a2f416SAras Vaichas
2047d22c338eSJoe Hershberger - Link-local IP address negotiation:
2048d22c338eSJoe Hershberger		Negotiate with other link-local clients on the local network
2049d22c338eSJoe Hershberger		for an address that doesn't require explicit configuration.
2050d22c338eSJoe Hershberger		This is especially useful if a DHCP server cannot be guaranteed
2051d22c338eSJoe Hershberger		to exist in all environments that the device must operate.
2052d22c338eSJoe Hershberger
2053d22c338eSJoe Hershberger		See doc/README.link-local for more information.
2054d22c338eSJoe Hershberger
2055a3d991bdSwdenk - CDP Options:
2056a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID
2057a3d991bdSwdenk
2058a3d991bdSwdenk		The device id used in CDP trigger frames.
2059a3d991bdSwdenk
2060a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID_PREFIX
2061a3d991bdSwdenk
2062a3d991bdSwdenk		A two character string which is prefixed to the MAC address
2063a3d991bdSwdenk		of the device.
2064a3d991bdSwdenk
2065a3d991bdSwdenk		CONFIG_CDP_PORT_ID
2066a3d991bdSwdenk
2067a3d991bdSwdenk		A printf format string which contains the ascii name of
2068a3d991bdSwdenk		the port. Normally is set to "eth%d" which sets
206911ccc33fSMarcel Ziswiler		eth0 for the first Ethernet, eth1 for the second etc.
2070a3d991bdSwdenk
2071a3d991bdSwdenk		CONFIG_CDP_CAPABILITIES
2072a3d991bdSwdenk
2073a3d991bdSwdenk		A 32bit integer which indicates the device capabilities;
2074a3d991bdSwdenk		0x00000010 for a normal host which does not forwards.
2075a3d991bdSwdenk
2076a3d991bdSwdenk		CONFIG_CDP_VERSION
2077a3d991bdSwdenk
2078a3d991bdSwdenk		An ascii string containing the version of the software.
2079a3d991bdSwdenk
2080a3d991bdSwdenk		CONFIG_CDP_PLATFORM
2081a3d991bdSwdenk
2082a3d991bdSwdenk		An ascii string containing the name of the platform.
2083a3d991bdSwdenk
2084a3d991bdSwdenk		CONFIG_CDP_TRIGGER
2085a3d991bdSwdenk
2086a3d991bdSwdenk		A 32bit integer sent on the trigger.
2087a3d991bdSwdenk
2088a3d991bdSwdenk		CONFIG_CDP_POWER_CONSUMPTION
2089a3d991bdSwdenk
2090a3d991bdSwdenk		A 16bit integer containing the power consumption of the
2091a3d991bdSwdenk		device in .1 of milliwatts.
2092a3d991bdSwdenk
2093a3d991bdSwdenk		CONFIG_CDP_APPLIANCE_VLAN_TYPE
2094a3d991bdSwdenk
2095a3d991bdSwdenk		A byte containing the id of the VLAN.
2096a3d991bdSwdenk
2097c609719bSwdenk- Status LED:	CONFIG_STATUS_LED
2098c609719bSwdenk
2099c609719bSwdenk		Several configurations allow to display the current
2100c609719bSwdenk		status using a LED. For instance, the LED will blink
2101c609719bSwdenk		fast while running U-Boot code, stop blinking as
2102c609719bSwdenk		soon as a reply to a BOOTP request was received, and
2103c609719bSwdenk		start blinking slow once the Linux kernel is running
2104c609719bSwdenk		(supported by a status LED driver in the Linux
2105c609719bSwdenk		kernel). Defining CONFIG_STATUS_LED enables this
2106c609719bSwdenk		feature in U-Boot.
2107c609719bSwdenk
21081df7bbbaSIgor Grinberg		Additional options:
21091df7bbbaSIgor Grinberg
21101df7bbbaSIgor Grinberg		CONFIG_GPIO_LED
21111df7bbbaSIgor Grinberg		The status LED can be connected to a GPIO pin.
21121df7bbbaSIgor Grinberg		In such cases, the gpio_led driver can be used as a
21131df7bbbaSIgor Grinberg		status LED backend implementation. Define CONFIG_GPIO_LED
21141df7bbbaSIgor Grinberg		to include the gpio_led driver in the U-Boot binary.
21151df7bbbaSIgor Grinberg
21169dfdcdfeSIgor Grinberg		CONFIG_GPIO_LED_INVERTED_TABLE
21179dfdcdfeSIgor Grinberg		Some GPIO connected LEDs may have inverted polarity in which
21189dfdcdfeSIgor Grinberg		case the GPIO high value corresponds to LED off state and
21199dfdcdfeSIgor Grinberg		GPIO low value corresponds to LED on state.
21209dfdcdfeSIgor Grinberg		In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
21219dfdcdfeSIgor Grinberg		with a list of GPIO LEDs that have inverted polarity.
21229dfdcdfeSIgor Grinberg
2123c609719bSwdenk- CAN Support:	CONFIG_CAN_DRIVER
2124c609719bSwdenk
2125c609719bSwdenk		Defining CONFIG_CAN_DRIVER enables CAN driver support
2126c609719bSwdenk		on those systems that support this (optional)
2127c609719bSwdenk		feature, like the TQM8xxL modules.
2128c609719bSwdenk
21293f4978c7SHeiko Schocher- I2C Support:	CONFIG_SYS_I2C
2130c609719bSwdenk
21313f4978c7SHeiko Schocher		This enable the NEW i2c subsystem, and will allow you to use
21323f4978c7SHeiko Schocher		i2c commands at the u-boot command line (as long as you set
21333f4978c7SHeiko Schocher		CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
21343f4978c7SHeiko Schocher		based realtime clock chips or other i2c devices. See
21353f4978c7SHeiko Schocher		common/cmd_i2c.c for a description of the command line
21363f4978c7SHeiko Schocher		interface.
21373f4978c7SHeiko Schocher
21383f4978c7SHeiko Schocher		ported i2c driver to the new framework:
2139ea818dbbSHeiko Schocher		- drivers/i2c/soft_i2c.c:
2140ea818dbbSHeiko Schocher		  - activate first bus with CONFIG_SYS_I2C_SOFT define
2141ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2142ea818dbbSHeiko Schocher		    for defining speed and slave address
2143ea818dbbSHeiko Schocher		  - activate second bus with I2C_SOFT_DECLARATIONS2 define
2144ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2145ea818dbbSHeiko Schocher		    for defining speed and slave address
2146ea818dbbSHeiko Schocher		  - activate third bus with I2C_SOFT_DECLARATIONS3 define
2147ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2148ea818dbbSHeiko Schocher		    for defining speed and slave address
2149ea818dbbSHeiko Schocher		  - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2150ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2151ea818dbbSHeiko Schocher		    for defining speed and slave address
21523f4978c7SHeiko Schocher
215300f792e0SHeiko Schocher		- drivers/i2c/fsl_i2c.c:
215400f792e0SHeiko Schocher		  - activate i2c driver with CONFIG_SYS_I2C_FSL
215500f792e0SHeiko Schocher		    define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
215600f792e0SHeiko Schocher		    offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
215700f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
215800f792e0SHeiko Schocher		    bus.
215900f792e0SHeiko Schocher		  - If your board supports a second fsl i2c bus, define
216000f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
216100f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_SPEED for the speed and
216200f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
216300f792e0SHeiko Schocher		    second bus.
216400f792e0SHeiko Schocher
21651f2ba722SSimon Glass		- drivers/i2c/tegra_i2c.c:
21661f2ba722SSimon Glass		  - activate this driver with CONFIG_SYS_I2C_TEGRA
21671f2ba722SSimon Glass		  - This driver adds 4 i2c buses with a fix speed from
21681f2ba722SSimon Glass		    100000 and the slave addr 0!
21691f2ba722SSimon Glass
2170880540deSDirk Eibach		- drivers/i2c/ppc4xx_i2c.c
2171880540deSDirk Eibach		  - activate this driver with CONFIG_SYS_I2C_PPC4XX
2172880540deSDirk Eibach		  - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2173880540deSDirk Eibach		  - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2174880540deSDirk Eibach
2175fac96408Strem		- drivers/i2c/i2c_mxc.c
2176fac96408Strem		  - activate this driver with CONFIG_SYS_I2C_MXC
2177fac96408Strem		  - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2178fac96408Strem		  - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2179fac96408Strem		  - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2180fac96408Strem		  - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2181fac96408Strem		  - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2182fac96408Strem		  - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
2183fac96408Strem		If thoses defines are not set, default value is 100000
2184fac96408Strem		for speed, and 0 for slave.
2185fac96408Strem
21861086bfa9SNobuhiro Iwamatsu		- drivers/i2c/rcar_i2c.c:
21871086bfa9SNobuhiro Iwamatsu		  - activate this driver with CONFIG_SYS_I2C_RCAR
21881086bfa9SNobuhiro Iwamatsu		  - This driver adds 4 i2c buses
21891086bfa9SNobuhiro Iwamatsu
21901086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
21911086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
21921086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
21931086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
21941086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
21951086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
21961086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
21971086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
21981086bfa9SNobuhiro Iwamatsu		  - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
21991086bfa9SNobuhiro Iwamatsu
22002035d77dSNobuhiro Iwamatsu		- drivers/i2c/sh_i2c.c:
22012035d77dSNobuhiro Iwamatsu		  - activate this driver with CONFIG_SYS_I2C_SH
22022035d77dSNobuhiro Iwamatsu		  - This driver adds from 2 to 5 i2c buses
22032035d77dSNobuhiro Iwamatsu
22042035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
22052035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
22062035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
22072035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
22082035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
22092035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
22102035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
22112035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
22122035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
22132035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
22142035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
22152035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
22162035d77dSNobuhiro Iwamatsu		  - CONFIF_SYS_I2C_SH_NUM_CONTROLLERS for nummber of i2c buses
22172035d77dSNobuhiro Iwamatsu
22186789e84eSHeiko Schocher		- drivers/i2c/omap24xx_i2c.c
22196789e84eSHeiko Schocher		  - activate this driver with CONFIG_SYS_I2C_OMAP24XX
22206789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
22216789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
22226789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
22236789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
22246789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
22256789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
22266789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
22276789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
22286789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
22296789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
22306789e84eSHeiko Schocher
22310bdffe71SHeiko Schocher		- drivers/i2c/zynq_i2c.c
22320bdffe71SHeiko Schocher		  - activate this driver with CONFIG_SYS_I2C_ZYNQ
22330bdffe71SHeiko Schocher		  - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
22340bdffe71SHeiko Schocher		  - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
22350bdffe71SHeiko Schocher
2236e717fc6dSNaveen Krishna Ch		- drivers/i2c/s3c24x0_i2c.c:
2237e717fc6dSNaveen Krishna Ch		  - activate this driver with CONFIG_SYS_I2C_S3C24X0
2238e717fc6dSNaveen Krishna Ch		  - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2239e717fc6dSNaveen Krishna Ch		    9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2240e717fc6dSNaveen Krishna Ch		    with a fix speed from 100000 and the slave addr 0!
2241e717fc6dSNaveen Krishna Ch
22423f4978c7SHeiko Schocher		additional defines:
22433f4978c7SHeiko Schocher
22443f4978c7SHeiko Schocher		CONFIG_SYS_NUM_I2C_BUSES
22453f4978c7SHeiko Schocher		Hold the number of i2c busses you want to use. If you
22463f4978c7SHeiko Schocher		don't use/have i2c muxes on your i2c bus, this
22473f4978c7SHeiko Schocher		is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
22483f4978c7SHeiko Schocher		omit this define.
22493f4978c7SHeiko Schocher
22503f4978c7SHeiko Schocher		CONFIG_SYS_I2C_DIRECT_BUS
22513f4978c7SHeiko Schocher		define this, if you don't use i2c muxes on your hardware.
22523f4978c7SHeiko Schocher		if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
22533f4978c7SHeiko Schocher		omit this define.
22543f4978c7SHeiko Schocher
22553f4978c7SHeiko Schocher		CONFIG_SYS_I2C_MAX_HOPS
22563f4978c7SHeiko Schocher		define how many muxes are maximal consecutively connected
22573f4978c7SHeiko Schocher		on one i2c bus. If you not use i2c muxes, omit this
22583f4978c7SHeiko Schocher		define.
22593f4978c7SHeiko Schocher
22603f4978c7SHeiko Schocher		CONFIG_SYS_I2C_BUSES
22613f4978c7SHeiko Schocher		hold a list of busses you want to use, only used if
22623f4978c7SHeiko Schocher		CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
22633f4978c7SHeiko Schocher		a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
22643f4978c7SHeiko Schocher		CONFIG_SYS_NUM_I2C_BUSES = 9:
22653f4978c7SHeiko Schocher
22663f4978c7SHeiko Schocher		 CONFIG_SYS_I2C_BUSES	{{0, {I2C_NULL_HOP}}, \
22673f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
22683f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
22693f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
22703f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
22713f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
22723f4978c7SHeiko Schocher					{1, {I2C_NULL_HOP}}, \
22733f4978c7SHeiko Schocher					{1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
22743f4978c7SHeiko Schocher					{1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
22753f4978c7SHeiko Schocher					}
22763f4978c7SHeiko Schocher
22773f4978c7SHeiko Schocher		which defines
22783f4978c7SHeiko Schocher			bus 0 on adapter 0 without a mux
2279ea818dbbSHeiko Schocher			bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2280ea818dbbSHeiko Schocher			bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2281ea818dbbSHeiko Schocher			bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2282ea818dbbSHeiko Schocher			bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2283ea818dbbSHeiko Schocher			bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
22843f4978c7SHeiko Schocher			bus 6 on adapter 1 without a mux
2285ea818dbbSHeiko Schocher			bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2286ea818dbbSHeiko Schocher			bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
22873f4978c7SHeiko Schocher
22883f4978c7SHeiko Schocher		If you do not have i2c muxes on your board, omit this define.
22893f4978c7SHeiko Schocher
2290ea818dbbSHeiko Schocher- Legacy I2C Support:	CONFIG_HARD_I2C
22913f4978c7SHeiko Schocher
22923f4978c7SHeiko Schocher		NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
22933f4978c7SHeiko Schocher		provides the following compelling advantages:
22943f4978c7SHeiko Schocher
22953f4978c7SHeiko Schocher		- more than one i2c adapter is usable
22963f4978c7SHeiko Schocher		- approved multibus support
22973f4978c7SHeiko Schocher		- better i2c mux support
22983f4978c7SHeiko Schocher
22993f4978c7SHeiko Schocher		** Please consider updating your I2C driver now. **
23003f4978c7SHeiko Schocher
2301ea818dbbSHeiko Schocher		These enable legacy I2C serial bus commands. Defining
2302ea818dbbSHeiko Schocher		CONFIG_HARD_I2C will include the appropriate I2C driver
2303ea818dbbSHeiko Schocher		for the selected CPU.
2304c609719bSwdenk
2305b37c7e5eSwdenk		This will allow you to use i2c commands at the u-boot
2306602ad3b3SJon Loeliger		command line (as long as you set CONFIG_CMD_I2C in
2307b37c7e5eSwdenk		CONFIG_COMMANDS) and communicate with i2c based realtime
2308b37c7e5eSwdenk		clock chips. See common/cmd_i2c.c for a description of the
2309c609719bSwdenk		command line interface.
2310c609719bSwdenk
2311bb99ad6dSBen Warren		CONFIG_HARD_I2C selects a hardware I2C controller.
2312c609719bSwdenk
2313b37c7e5eSwdenk		There are several other quantities that must also be
2314ea818dbbSHeiko Schocher		defined when you define CONFIG_HARD_I2C.
2315c609719bSwdenk
23166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		In both cases you will need to define CONFIG_SYS_I2C_SPEED
2317b37c7e5eSwdenk		to be the frequency (in Hz) at which you wish your i2c bus
23186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
231911ccc33fSMarcel Ziswiler		the CPU's i2c node address).
2320c609719bSwdenk
23218d321b81SPeter Tyser		Now, the u-boot i2c code for the mpc8xx
2322a47a12beSStefan Roese		(arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
23238d321b81SPeter Tyser		and so its address should therefore be cleared to 0 (See,
23248d321b81SPeter Tyser		eg, MPC823e User's Manual p.16-473). So, set
23258d321b81SPeter Tyser		CONFIG_SYS_I2C_SLAVE to 0.
2326b37c7e5eSwdenk
23275da71efaSEric Millbrandt		CONFIG_SYS_I2C_INIT_MPC5XXX
23285da71efaSEric Millbrandt
23295da71efaSEric Millbrandt		When a board is reset during an i2c bus transfer
23305da71efaSEric Millbrandt		chips might think that the current transfer is still
23315da71efaSEric Millbrandt		in progress.  Reset the slave devices by sending start
23325da71efaSEric Millbrandt		commands until the slave device responds.
23335da71efaSEric Millbrandt
2334b37c7e5eSwdenk		That's all that's required for CONFIG_HARD_I2C.
2335b37c7e5eSwdenk
2336ea818dbbSHeiko Schocher		If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
2337b37c7e5eSwdenk		then the following macros need to be defined (examples are
2338b37c7e5eSwdenk		from include/configs/lwmon.h):
2339c609719bSwdenk
2340c609719bSwdenk		I2C_INIT
2341c609719bSwdenk
2342b37c7e5eSwdenk		(Optional). Any commands necessary to enable the I2C
2343c609719bSwdenk		controller or configure ports.
2344c609719bSwdenk
2345b37c7e5eSwdenk		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
2346b37c7e5eSwdenk
2347c609719bSwdenk		I2C_PORT
2348c609719bSwdenk
2349c609719bSwdenk		(Only for MPC8260 CPU). The I/O port to use (the code
2350c609719bSwdenk		assumes both bits are on the same port). Valid values
2351c609719bSwdenk		are 0..3 for ports A..D.
2352c609719bSwdenk
2353c609719bSwdenk		I2C_ACTIVE
2354c609719bSwdenk
2355c609719bSwdenk		The code necessary to make the I2C data line active
2356c609719bSwdenk		(driven).  If the data line is open collector, this
2357c609719bSwdenk		define can be null.
2358c609719bSwdenk
2359b37c7e5eSwdenk		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
2360b37c7e5eSwdenk
2361c609719bSwdenk		I2C_TRISTATE
2362c609719bSwdenk
2363c609719bSwdenk		The code necessary to make the I2C data line tri-stated
2364c609719bSwdenk		(inactive).  If the data line is open collector, this
2365c609719bSwdenk		define can be null.
2366c609719bSwdenk
2367b37c7e5eSwdenk		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2368b37c7e5eSwdenk
2369c609719bSwdenk		I2C_READ
2370c609719bSwdenk
2371472d5460SYork Sun		Code that returns true if the I2C data line is high,
2372472d5460SYork Sun		false if it is low.
2373c609719bSwdenk
2374b37c7e5eSwdenk		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2375b37c7e5eSwdenk
2376c609719bSwdenk		I2C_SDA(bit)
2377c609719bSwdenk
2378472d5460SYork Sun		If <bit> is true, sets the I2C data line high. If it
2379472d5460SYork Sun		is false, it clears it (low).
2380c609719bSwdenk
2381b37c7e5eSwdenk		eg: #define I2C_SDA(bit) \
2382b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
2383b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
2384b37c7e5eSwdenk
2385c609719bSwdenk		I2C_SCL(bit)
2386c609719bSwdenk
2387472d5460SYork Sun		If <bit> is true, sets the I2C clock line high. If it
2388472d5460SYork Sun		is false, it clears it (low).
2389c609719bSwdenk
2390b37c7e5eSwdenk		eg: #define I2C_SCL(bit) \
2391b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
2392b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
2393b37c7e5eSwdenk
2394c609719bSwdenk		I2C_DELAY
2395c609719bSwdenk
2396c609719bSwdenk		This delay is invoked four times per clock cycle so this
2397c609719bSwdenk		controls the rate of data transfer.  The data rate thus
2398b37c7e5eSwdenk		is 1 / (I2C_DELAY * 4). Often defined to be something
2399b37c7e5eSwdenk		like:
2400b37c7e5eSwdenk
2401b37c7e5eSwdenk		#define I2C_DELAY  udelay(2)
2402c609719bSwdenk
2403793b5726SMike Frysinger		CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2404793b5726SMike Frysinger
2405793b5726SMike Frysinger		If your arch supports the generic GPIO framework (asm/gpio.h),
2406793b5726SMike Frysinger		then you may alternatively define the two GPIOs that are to be
2407793b5726SMike Frysinger		used as SCL / SDA.  Any of the previous I2C_xxx macros will
2408793b5726SMike Frysinger		have GPIO-based defaults assigned to them as appropriate.
2409793b5726SMike Frysinger
2410793b5726SMike Frysinger		You should define these to the GPIO value as given directly to
2411793b5726SMike Frysinger		the generic GPIO functions.
2412793b5726SMike Frysinger
24136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_INIT_BOARD
241447cd00faSwdenk
241547cd00faSwdenk		When a board is reset during an i2c bus transfer
241647cd00faSwdenk		chips might think that the current transfer is still
241747cd00faSwdenk		in progress. On some boards it is possible to access
241847cd00faSwdenk		the i2c SCLK line directly, either by using the
241947cd00faSwdenk		processor pin as a GPIO or by having a second pin
242047cd00faSwdenk		connected to the bus. If this option is defined a
242147cd00faSwdenk		custom i2c_init_board() routine in boards/xxx/board.c
242247cd00faSwdenk		is run early in the boot sequence.
242347cd00faSwdenk
242426a33504SRichard Retanubun		CONFIG_SYS_I2C_BOARD_LATE_INIT
242526a33504SRichard Retanubun
242626a33504SRichard Retanubun		An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
242726a33504SRichard Retanubun		defined a custom i2c_board_late_init() routine in
242826a33504SRichard Retanubun		boards/xxx/board.c is run AFTER the operations in i2c_init()
242926a33504SRichard Retanubun		is completed. This callpoint can be used to unreset i2c bus
243026a33504SRichard Retanubun		using CPU i2c controller register accesses for CPUs whose i2c
243126a33504SRichard Retanubun		controller provide such a method. It is called at the end of
243226a33504SRichard Retanubun		i2c_init() to allow i2c_init operations to setup the i2c bus
243326a33504SRichard Retanubun		controller on the CPU (e.g. setting bus speed & slave address).
243426a33504SRichard Retanubun
243517ea1177Swdenk		CONFIG_I2CFAST (PPC405GP|PPC405EP only)
243617ea1177Swdenk
243717ea1177Swdenk		This option enables configuration of bi_iic_fast[] flags
243817ea1177Swdenk		in u-boot bd_info structure based on u-boot environment
243917ea1177Swdenk		variable "i2cfast". (see also i2cfast)
244017ea1177Swdenk
2441bb99ad6dSBen Warren		CONFIG_I2C_MULTI_BUS
2442bb99ad6dSBen Warren
2443bb99ad6dSBen Warren		This option allows the use of multiple I2C buses, each of which
2444bb99ad6dSBen Warren		must have a controller.	 At any point in time, only one bus is
2445bb99ad6dSBen Warren		active.	 To switch to a different bus, use the 'i2c dev' command.
2446bb99ad6dSBen Warren		Note that bus numbering is zero-based.
2447bb99ad6dSBen Warren
24486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_NOPROBES
2449bb99ad6dSBen Warren
2450bb99ad6dSBen Warren		This option specifies a list of I2C devices that will be skipped
24510f89c54bSPeter Tyser		when the 'i2c probe' command is issued.	 If CONFIG_I2C_MULTI_BUS
24520f89c54bSPeter Tyser		is set, specify a list of bus-device pairs.  Otherwise, specify
24530f89c54bSPeter Tyser		a 1D array of device addresses
2454bb99ad6dSBen Warren
2455bb99ad6dSBen Warren		e.g.
2456bb99ad6dSBen Warren			#undef	CONFIG_I2C_MULTI_BUS
24576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
2458bb99ad6dSBen Warren
2459bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on a board with one I2C bus
2460bb99ad6dSBen Warren
2461bb99ad6dSBen Warren			#define CONFIG_I2C_MULTI_BUS
24626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_MULTI_NOPROBES	{{0,0x50},{0,0x68},{1,0x54}}
2463bb99ad6dSBen Warren
2464bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2465bb99ad6dSBen Warren
24666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SPD_BUS_NUM
2467be5e6181STimur Tabi
2468be5e6181STimur Tabi		If defined, then this indicates the I2C bus number for DDR SPD.
2469be5e6181STimur Tabi		If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2470be5e6181STimur Tabi
24716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_BUS_NUM
24720dc018ecSStefan Roese
24730dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the RTC.
24740dc018ecSStefan Roese		If not defined, then U-Boot assumes that RTC is on I2C bus 0.
24750dc018ecSStefan Roese
24766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_DTT_BUS_NUM
24770dc018ecSStefan Roese
24780dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the DTT.
24790dc018ecSStefan Roese		If not defined, then U-Boot assumes that DTT is on I2C bus 0.
24800dc018ecSStefan Roese
24816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_DTT_ADDR:
24829ebbb54fSVictor Gallardo
24839ebbb54fSVictor Gallardo		If defined, specifies the I2C address of the DTT device.
24849ebbb54fSVictor Gallardo		If not defined, then U-Boot uses predefined value for
24859ebbb54fSVictor Gallardo		specified DTT device.
24869ebbb54fSVictor Gallardo
24872ac6985aSAndrew Dyer		CONFIG_SOFT_I2C_READ_REPEATED_START
24882ac6985aSAndrew Dyer
24892ac6985aSAndrew Dyer		defining this will force the i2c_read() function in
24902ac6985aSAndrew Dyer		the soft_i2c driver to perform an I2C repeated start
24912ac6985aSAndrew Dyer		between writing the address pointer and reading the
24922ac6985aSAndrew Dyer		data.  If this define is omitted the default behaviour
24932ac6985aSAndrew Dyer		of doing a stop-start sequence will be used.  Most I2C
24942ac6985aSAndrew Dyer		devices can use either method, but some require one or
24952ac6985aSAndrew Dyer		the other.
2496be5e6181STimur Tabi
2497c609719bSwdenk- SPI Support:	CONFIG_SPI
2498c609719bSwdenk
2499c609719bSwdenk		Enables SPI driver (so far only tested with
2500c609719bSwdenk		SPI EEPROM, also an instance works with Crystal A/D and
2501c609719bSwdenk		D/As on the SACSng board)
2502c609719bSwdenk
25036639562eSYoshihiro Shimoda		CONFIG_SH_SPI
25046639562eSYoshihiro Shimoda
25056639562eSYoshihiro Shimoda		Enables the driver for SPI controller on SuperH. Currently
25066639562eSYoshihiro Shimoda		only SH7757 is supported.
25076639562eSYoshihiro Shimoda
2508c609719bSwdenk		CONFIG_SPI_X
2509c609719bSwdenk
2510c609719bSwdenk		Enables extended (16-bit) SPI EEPROM addressing.
2511c609719bSwdenk		(symmetrical to CONFIG_I2C_X)
2512c609719bSwdenk
2513c609719bSwdenk		CONFIG_SOFT_SPI
2514c609719bSwdenk
2515c609719bSwdenk		Enables a software (bit-bang) SPI driver rather than
2516c609719bSwdenk		using hardware support. This is a general purpose
2517c609719bSwdenk		driver that only requires three general I/O port pins
2518c609719bSwdenk		(two outputs, one input) to function. If this is
2519c609719bSwdenk		defined, the board configuration must define several
2520c609719bSwdenk		SPI configuration items (port pins to use, etc). For
2521c609719bSwdenk		an example, see include/configs/sacsng.h.
2522c609719bSwdenk
252304a9e118SBen Warren		CONFIG_HARD_SPI
252404a9e118SBen Warren
252504a9e118SBen Warren		Enables a hardware SPI driver for general-purpose reads
252604a9e118SBen Warren		and writes.  As with CONFIG_SOFT_SPI, the board configuration
252704a9e118SBen Warren		must define a list of chip-select function pointers.
252804a9e118SBen Warren		Currently supported on some MPC8xxx processors.	 For an
252904a9e118SBen Warren		example, see include/configs/mpc8349emds.h.
253004a9e118SBen Warren
253138254f45SGuennadi Liakhovetski		CONFIG_MXC_SPI
253238254f45SGuennadi Liakhovetski
253338254f45SGuennadi Liakhovetski		Enables the driver for the SPI controllers on i.MX and MXC
25342e3cd1cdSFabio Estevam		SoCs. Currently i.MX31/35/51 are supported.
253538254f45SGuennadi Liakhovetski
25360133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA
25370133502eSMatthias Fuchs
25380133502eSMatthias Fuchs		Enables FPGA subsystem.
25390133502eSMatthias Fuchs
25400133502eSMatthias Fuchs		CONFIG_FPGA_<vendor>
25410133502eSMatthias Fuchs
25420133502eSMatthias Fuchs		Enables support for specific chip vendors.
25430133502eSMatthias Fuchs		(ALTERA, XILINX)
25440133502eSMatthias Fuchs
25450133502eSMatthias Fuchs		CONFIG_FPGA_<family>
25460133502eSMatthias Fuchs
25470133502eSMatthias Fuchs		Enables support for FPGA family.
25480133502eSMatthias Fuchs		(SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
25490133502eSMatthias Fuchs
25500133502eSMatthias Fuchs		CONFIG_FPGA_COUNT
2551c609719bSwdenk
2552c609719bSwdenk		Specify the number of FPGA devices to support.
2553c609719bSwdenk
25546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_PROG_FEEDBACK
2555c609719bSwdenk
2556c609719bSwdenk		Enable printing of hash marks during FPGA configuration.
2557c609719bSwdenk
25586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_BUSY
2559c609719bSwdenk
2560c609719bSwdenk		Enable checks on FPGA configuration interface busy
2561c609719bSwdenk		status by the configuration function. This option
2562c609719bSwdenk		will require a board or device specific function to
2563c609719bSwdenk		be written.
2564c609719bSwdenk
2565c609719bSwdenk		CONFIG_FPGA_DELAY
2566c609719bSwdenk
2567c609719bSwdenk		If defined, a function that provides delays in the FPGA
2568c609719bSwdenk		configuration driver.
2569c609719bSwdenk
25706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_CTRLC
2571c609719bSwdenk		Allow Control-C to interrupt FPGA configuration
2572c609719bSwdenk
25736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_ERROR
2574c609719bSwdenk
2575c609719bSwdenk		Check for configuration errors during FPGA bitfile
2576c609719bSwdenk		loading. For example, abort during Virtex II
2577c609719bSwdenk		configuration if the INIT_B line goes low (which
2578c609719bSwdenk		indicated a CRC error).
2579c609719bSwdenk
25806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_INIT
2581c609719bSwdenk
2582c609719bSwdenk		Maximum time to wait for the INIT_B line to deassert
2583c609719bSwdenk		after PROB_B has been deasserted during a Virtex II
2584c609719bSwdenk		FPGA configuration sequence. The default time is 500
258511ccc33fSMarcel Ziswiler		ms.
2586c609719bSwdenk
25876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_BUSY
2588c609719bSwdenk
2589c609719bSwdenk		Maximum time to wait for BUSY to deassert during
259011ccc33fSMarcel Ziswiler		Virtex II FPGA configuration. The default is 5 ms.
2591c609719bSwdenk
25926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_CONFIG
2593c609719bSwdenk
2594c609719bSwdenk		Time to wait after FPGA configuration. The default is
259511ccc33fSMarcel Ziswiler		200 ms.
2596c609719bSwdenk
2597c609719bSwdenk- Configuration Management:
2598c609719bSwdenk		CONFIG_IDENT_STRING
2599c609719bSwdenk
2600c609719bSwdenk		If defined, this string will be added to the U-Boot
2601c609719bSwdenk		version information (U_BOOT_VERSION)
2602c609719bSwdenk
2603c609719bSwdenk- Vendor Parameter Protection:
2604c609719bSwdenk
2605c609719bSwdenk		U-Boot considers the values of the environment
2606c609719bSwdenk		variables "serial#" (Board Serial Number) and
26077152b1d0Swdenk		"ethaddr" (Ethernet Address) to be parameters that
2608c609719bSwdenk		are set once by the board vendor / manufacturer, and
2609c609719bSwdenk		protects these variables from casual modification by
2610c609719bSwdenk		the user. Once set, these variables are read-only,
2611c609719bSwdenk		and write or delete attempts are rejected. You can
261211ccc33fSMarcel Ziswiler		change this behaviour:
2613c609719bSwdenk
2614c609719bSwdenk		If CONFIG_ENV_OVERWRITE is #defined in your config
2615c609719bSwdenk		file, the write protection for vendor parameters is
261647cd00faSwdenk		completely disabled. Anybody can change or delete
2617c609719bSwdenk		these parameters.
2618c609719bSwdenk
2619c609719bSwdenk		Alternatively, if you #define _both_ CONFIG_ETHADDR
2620c609719bSwdenk		_and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
262111ccc33fSMarcel Ziswiler		Ethernet address is installed in the environment,
2622c609719bSwdenk		which can be changed exactly ONCE by the user. [The
2623c609719bSwdenk		serial# is unaffected by this, i. e. it remains
2624c609719bSwdenk		read-only.]
2625c609719bSwdenk
26262598090bSJoe Hershberger		The same can be accomplished in a more flexible way
26272598090bSJoe Hershberger		for any variable by configuring the type of access
26282598090bSJoe Hershberger		to allow for those variables in the ".flags" variable
26292598090bSJoe Hershberger		or define CONFIG_ENV_FLAGS_LIST_STATIC.
26302598090bSJoe Hershberger
2631c609719bSwdenk- Protected RAM:
2632c609719bSwdenk		CONFIG_PRAM
2633c609719bSwdenk
2634c609719bSwdenk		Define this variable to enable the reservation of
2635c609719bSwdenk		"protected RAM", i. e. RAM which is not overwritten
2636c609719bSwdenk		by U-Boot. Define CONFIG_PRAM to hold the number of
2637c609719bSwdenk		kB you want to reserve for pRAM. You can overwrite
2638c609719bSwdenk		this default value by defining an environment
2639c609719bSwdenk		variable "pram" to the number of kB you want to
2640c609719bSwdenk		reserve. Note that the board info structure will
2641c609719bSwdenk		still show the full amount of RAM. If pRAM is
2642c609719bSwdenk		reserved, a new environment variable "mem" will
2643c609719bSwdenk		automatically be defined to hold the amount of
2644c609719bSwdenk		remaining RAM in a form that can be passed as boot
2645c609719bSwdenk		argument to Linux, for instance like that:
2646c609719bSwdenk
2647fe126d8bSWolfgang Denk			setenv bootargs ... mem=\${mem}
2648c609719bSwdenk			saveenv
2649c609719bSwdenk
2650c609719bSwdenk		This way you can tell Linux not to use this memory,
2651c609719bSwdenk		either, which results in a memory region that will
2652c609719bSwdenk		not be affected by reboots.
2653c609719bSwdenk
2654c609719bSwdenk		*WARNING* If your board configuration uses automatic
2655c609719bSwdenk		detection of the RAM size, you must make sure that
2656c609719bSwdenk		this memory test is non-destructive. So far, the
2657c609719bSwdenk		following board configurations are known to be
2658c609719bSwdenk		"pRAM-clean":
2659c609719bSwdenk
26601b0757ecSWolfgang Denk			IVMS8, IVML24, SPD8xx, TQM8xxL,
26611b0757ecSWolfgang Denk			HERMES, IP860, RPXlite, LWMON,
2662544d97e9SWolfgang Denk			FLAGADM, TQM8260
2663c609719bSwdenk
266440fef049SGabe Black- Access to physical memory region (> 4GB)
266540fef049SGabe Black		Some basic support is provided for operations on memory not
266640fef049SGabe Black		normally accessible to U-Boot - e.g. some architectures
266740fef049SGabe Black		support access to more than 4GB of memory on 32-bit
266840fef049SGabe Black		machines using physical address extension or similar.
266940fef049SGabe Black		Define CONFIG_PHYSMEM to access this basic support, which
267040fef049SGabe Black		currently only supports clearing the memory.
267140fef049SGabe Black
2672c609719bSwdenk- Error Recovery:
2673c609719bSwdenk		CONFIG_PANIC_HANG
2674c609719bSwdenk
2675c609719bSwdenk		Define this variable to stop the system in case of a
2676c609719bSwdenk		fatal error, so that you have to reset it manually.
2677c609719bSwdenk		This is probably NOT a good idea for an embedded
267811ccc33fSMarcel Ziswiler		system where you want the system to reboot
2679c609719bSwdenk		automatically as fast as possible, but it may be
2680c609719bSwdenk		useful during development since you can try to debug
2681c609719bSwdenk		the conditions that lead to the situation.
2682c609719bSwdenk
2683c609719bSwdenk		CONFIG_NET_RETRY_COUNT
2684c609719bSwdenk
2685c609719bSwdenk		This variable defines the number of retries for
2686c609719bSwdenk		network operations like ARP, RARP, TFTP, or BOOTP
2687c609719bSwdenk		before giving up the operation. If not defined, a
2688c609719bSwdenk		default value of 5 is used.
2689c609719bSwdenk
269040cb90eeSGuennadi Liakhovetski		CONFIG_ARP_TIMEOUT
269140cb90eeSGuennadi Liakhovetski
269240cb90eeSGuennadi Liakhovetski		Timeout waiting for an ARP reply in milliseconds.
269340cb90eeSGuennadi Liakhovetski
269448a3e999STetsuyuki Kobayashi		CONFIG_NFS_TIMEOUT
269548a3e999STetsuyuki Kobayashi
269648a3e999STetsuyuki Kobayashi		Timeout in milliseconds used in NFS protocol.
269748a3e999STetsuyuki Kobayashi		If you encounter "ERROR: Cannot umount" in nfs command,
269848a3e999STetsuyuki Kobayashi		try longer timeout such as
269948a3e999STetsuyuki Kobayashi		#define CONFIG_NFS_TIMEOUT 10000UL
270048a3e999STetsuyuki Kobayashi
2701c609719bSwdenk- Command Interpreter:
27028078f1a5SWolfgang Denk		CONFIG_AUTO_COMPLETE
270304a85b3bSwdenk
270404a85b3bSwdenk		Enable auto completion of commands using TAB.
270504a85b3bSwdenk
27068078f1a5SWolfgang Denk		Note that this feature has NOT been implemented yet
27078078f1a5SWolfgang Denk		for the "hush" shell.
27088078f1a5SWolfgang Denk
27098078f1a5SWolfgang Denk
27106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_HUSH_PARSER
2711c609719bSwdenk
2712c609719bSwdenk		Define this variable to enable the "hush" shell (from
2713c609719bSwdenk		Busybox) as command line interpreter, thus enabling
2714c609719bSwdenk		powerful command line syntax like
2715c609719bSwdenk		if...then...else...fi conditionals or `&&' and '||'
2716c609719bSwdenk		constructs ("shell scripts").
2717c609719bSwdenk
2718c609719bSwdenk		If undefined, you get the old, much simpler behaviour
2719c609719bSwdenk		with a somewhat smaller memory footprint.
2720c609719bSwdenk
2721c609719bSwdenk
27226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_PROMPT_HUSH_PS2
2723c609719bSwdenk
2724c609719bSwdenk		This defines the secondary prompt string, which is
2725c609719bSwdenk		printed when the command interpreter needs more input
2726c609719bSwdenk		to complete a command. Usually "> ".
2727c609719bSwdenk
2728c609719bSwdenk	Note:
2729c609719bSwdenk
2730c609719bSwdenk		In the current implementation, the local variables
2731c609719bSwdenk		space and global environment variables space are
2732c609719bSwdenk		separated. Local variables are those you define by
27333b57fe0aSwdenk		simply typing `name=value'. To access a local
2734c609719bSwdenk		variable later on, you have write `$name' or
27353b57fe0aSwdenk		`${name}'; to execute the contents of a variable
27363b57fe0aSwdenk		directly type `$name' at the command prompt.
2737c609719bSwdenk
2738c609719bSwdenk		Global environment variables are those you use
2739c609719bSwdenk		setenv/printenv to work with. To run a command stored
2740c609719bSwdenk		in such a variable, you need to use the run command,
2741c609719bSwdenk		and you must not use the '$' sign to access them.
2742c609719bSwdenk
2743c609719bSwdenk		To store commands and special characters in a
2744c609719bSwdenk		variable, please use double quotation marks
2745c609719bSwdenk		surrounding the whole text of the variable, instead
2746c609719bSwdenk		of the backslashes before semicolons and special
2747c609719bSwdenk		symbols.
2748c609719bSwdenk
2749aa0c71acSWolfgang Denk- Commandline Editing and History:
2750aa0c71acSWolfgang Denk		CONFIG_CMDLINE_EDITING
2751aa0c71acSWolfgang Denk
275211ccc33fSMarcel Ziswiler		Enable editing and History functions for interactive
2753aa0c71acSWolfgang Denk		commandline input operations
2754aa0c71acSWolfgang Denk
2755a8c7c708Swdenk- Default Environment:
2756c609719bSwdenk		CONFIG_EXTRA_ENV_SETTINGS
2757c609719bSwdenk
2758c609719bSwdenk		Define this to contain any number of null terminated
2759c609719bSwdenk		strings (variable = value pairs) that will be part of
27607152b1d0Swdenk		the default environment compiled into the boot image.
27612262cfeeSwdenk
2762c609719bSwdenk		For example, place something like this in your
2763c609719bSwdenk		board's config file:
2764c609719bSwdenk
2765c609719bSwdenk		#define CONFIG_EXTRA_ENV_SETTINGS \
2766c609719bSwdenk			"myvar1=value1\0" \
2767c609719bSwdenk			"myvar2=value2\0"
2768c609719bSwdenk
2769c609719bSwdenk		Warning: This method is based on knowledge about the
2770c609719bSwdenk		internal format how the environment is stored by the
27712262cfeeSwdenk		U-Boot code. This is NOT an official, exported
2772c609719bSwdenk		interface! Although it is unlikely that this format
27737152b1d0Swdenk		will change soon, there is no guarantee either.
2774c609719bSwdenk		You better know what you are doing here.
2775c609719bSwdenk
2776c609719bSwdenk		Note: overly (ab)use of the default environment is
2777c609719bSwdenk		discouraged. Make sure to check other ways to preset
277874de7aefSWolfgang Denk		the environment like the "source" command or the
2779c609719bSwdenk		boot command first.
2780c609719bSwdenk
27815e724ca2SStephen Warren		CONFIG_ENV_VARS_UBOOT_CONFIG
27825e724ca2SStephen Warren
27835e724ca2SStephen Warren		Define this in order to add variables describing the
27845e724ca2SStephen Warren		U-Boot build configuration to the default environment.
27855e724ca2SStephen Warren		These will be named arch, cpu, board, vendor, and soc.
27865e724ca2SStephen Warren
27875e724ca2SStephen Warren		Enabling this option will cause the following to be defined:
27885e724ca2SStephen Warren
27895e724ca2SStephen Warren		- CONFIG_SYS_ARCH
27905e724ca2SStephen Warren		- CONFIG_SYS_CPU
27915e724ca2SStephen Warren		- CONFIG_SYS_BOARD
27925e724ca2SStephen Warren		- CONFIG_SYS_VENDOR
27935e724ca2SStephen Warren		- CONFIG_SYS_SOC
27945e724ca2SStephen Warren
27957e27f89fSTom Rini		CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
27967e27f89fSTom Rini
27977e27f89fSTom Rini		Define this in order to add variables describing certain
27987e27f89fSTom Rini		run-time determined information about the hardware to the
27997e27f89fSTom Rini		environment.  These will be named board_name, board_rev.
28007e27f89fSTom Rini
280106fd8538SSimon Glass		CONFIG_DELAY_ENVIRONMENT
280206fd8538SSimon Glass
280306fd8538SSimon Glass		Normally the environment is loaded when the board is
280406fd8538SSimon Glass		intialised so that it is available to U-Boot. This inhibits
280506fd8538SSimon Glass		that so that the environment is not available until
280606fd8538SSimon Glass		explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
280706fd8538SSimon Glass		this is instead controlled by the value of
280806fd8538SSimon Glass		/config/load-environment.
280906fd8538SSimon Glass
2810a8c7c708Swdenk- DataFlash Support:
28112abbe075Swdenk		CONFIG_HAS_DATAFLASH
28122abbe075Swdenk
28132abbe075Swdenk		Defining this option enables DataFlash features and
28142abbe075Swdenk		allows to read/write in Dataflash via the standard
28152abbe075Swdenk		commands cp, md...
28162abbe075Swdenk
2817f61ec45eSEric Nelson- Serial Flash support
2818f61ec45eSEric Nelson		CONFIG_CMD_SF
2819f61ec45eSEric Nelson
2820f61ec45eSEric Nelson		Defining this option enables SPI flash commands
2821f61ec45eSEric Nelson		'sf probe/read/write/erase/update'.
2822f61ec45eSEric Nelson
2823f61ec45eSEric Nelson		Usage requires an initial 'probe' to define the serial
2824f61ec45eSEric Nelson		flash parameters, followed by read/write/erase/update
2825f61ec45eSEric Nelson		commands.
2826f61ec45eSEric Nelson
2827f61ec45eSEric Nelson		The following defaults may be provided by the platform
2828f61ec45eSEric Nelson		to handle the common case when only a single serial
2829f61ec45eSEric Nelson		flash is present on the system.
2830f61ec45eSEric Nelson
2831f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_BUS		Bus identifier
2832f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_CS		Chip-select
2833f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_MODE 		(see include/spi.h)
2834f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_SPEED		in Hz
2835f61ec45eSEric Nelson
283624007273SSimon Glass		CONFIG_CMD_SF_TEST
283724007273SSimon Glass
283824007273SSimon Glass		Define this option to include a destructive SPI flash
283924007273SSimon Glass		test ('sf test').
284024007273SSimon Glass
28411dcd6d03SJagannadha Sutradharudu Teki		CONFIG_SPI_FLASH_BAR		Ban/Extended Addr Reg
28421dcd6d03SJagannadha Sutradharudu Teki
28431dcd6d03SJagannadha Sutradharudu Teki		Define this option to use the Bank addr/Extended addr
28441dcd6d03SJagannadha Sutradharudu Teki		support on SPI flashes which has size > 16Mbytes.
28451dcd6d03SJagannadha Sutradharudu Teki
2846b902e07cSJagannadha Sutradharudu Teki		CONFIG_SF_DUAL_FLASH		Dual flash memories
2847b902e07cSJagannadha Sutradharudu Teki
2848b902e07cSJagannadha Sutradharudu Teki		Define this option to use dual flash support where two flash
2849b902e07cSJagannadha Sutradharudu Teki		memories can be connected with a given cs line.
2850b902e07cSJagannadha Sutradharudu Teki		currently Xilinx Zynq qspi support these type of connections.
2851b902e07cSJagannadha Sutradharudu Teki
28523f85ce27Swdenk- SystemACE Support:
28533f85ce27Swdenk		CONFIG_SYSTEMACE
28543f85ce27Swdenk
28553f85ce27Swdenk		Adding this option adds support for Xilinx SystemACE
28563f85ce27Swdenk		chips attached via some sort of local bus. The address
285711ccc33fSMarcel Ziswiler		of the chip must also be defined in the
28586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SYSTEMACE_BASE macro. For example:
28593f85ce27Swdenk
28603f85ce27Swdenk		#define CONFIG_SYSTEMACE
28616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
28623f85ce27Swdenk
28633f85ce27Swdenk		When SystemACE support is added, the "ace" device type
28643f85ce27Swdenk		becomes available to the fat commands, i.e. fatls.
28653f85ce27Swdenk
2866ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port:
2867ecb0ccd9SWolfgang Denk		CONFIG_TFTP_PORT
2868ecb0ccd9SWolfgang Denk
286928cb9375SWolfgang Denk		If this is defined, the environment variable tftpsrcp
2870ecb0ccd9SWolfgang Denk		is used to supply the TFTP UDP source port value.
287128cb9375SWolfgang Denk		If tftpsrcp isn't defined, the normal pseudo-random port
2872ecb0ccd9SWolfgang Denk		number generator is used.
2873ecb0ccd9SWolfgang Denk
287428cb9375SWolfgang Denk		Also, the environment variable tftpdstp is used to supply
287528cb9375SWolfgang Denk		the TFTP UDP destination port value.  If tftpdstp isn't
287628cb9375SWolfgang Denk		defined, the normal port 69 is used.
287728cb9375SWolfgang Denk
287828cb9375SWolfgang Denk		The purpose for tftpsrcp is to allow a TFTP server to
2879ecb0ccd9SWolfgang Denk		blindly start the TFTP transfer using the pre-configured
2880ecb0ccd9SWolfgang Denk		target IP address and UDP port. This has the effect of
2881ecb0ccd9SWolfgang Denk		"punching through" the (Windows XP) firewall, allowing
2882ecb0ccd9SWolfgang Denk		the remainder of the TFTP transfer to proceed normally.
2883ecb0ccd9SWolfgang Denk		A better solution is to properly configure the firewall,
2884ecb0ccd9SWolfgang Denk		but sometimes that is not allowed.
2885ecb0ccd9SWolfgang Denk
2886bf36c5d5SSimon Glass- Hashing support:
2887bf36c5d5SSimon Glass		CONFIG_CMD_HASH
2888bf36c5d5SSimon Glass
2889bf36c5d5SSimon Glass		This enables a generic 'hash' command which can produce
2890bf36c5d5SSimon Glass		hashes / digests from a few algorithms (e.g. SHA1, SHA256).
2891bf36c5d5SSimon Glass
2892bf36c5d5SSimon Glass		CONFIG_HASH_VERIFY
2893bf36c5d5SSimon Glass
2894bf36c5d5SSimon Glass		Enable the hash verify command (hash -v). This adds to code
2895bf36c5d5SSimon Glass		size a little.
2896bf36c5d5SSimon Glass
2897bf36c5d5SSimon Glass		CONFIG_SHA1 - support SHA1 hashing
2898bf36c5d5SSimon Glass		CONFIG_SHA256 - support SHA256 hashing
2899bf36c5d5SSimon Glass
2900bf36c5d5SSimon Glass		Note: There is also a sha1sum command, which should perhaps
2901bf36c5d5SSimon Glass		be deprecated in favour of 'hash sha1'.
2902bf36c5d5SSimon Glass
2903a11f1873SRobert Winkler- Freescale i.MX specific commands:
2904a11f1873SRobert Winkler		CONFIG_CMD_HDMIDETECT
2905a11f1873SRobert Winkler		This enables 'hdmidet' command which returns true if an
2906a11f1873SRobert Winkler		HDMI monitor is detected.  This command is i.MX 6 specific.
2907a11f1873SRobert Winkler
2908a11f1873SRobert Winkler		CONFIG_CMD_BMODE
2909a11f1873SRobert Winkler		This enables the 'bmode' (bootmode) command for forcing
2910a11f1873SRobert Winkler		a boot from specific media.
2911a11f1873SRobert Winkler
2912a11f1873SRobert Winkler		This is useful for forcing the ROM's usb downloader to
2913a11f1873SRobert Winkler		activate upon a watchdog reset which is nice when iterating
2914a11f1873SRobert Winkler		on U-Boot.  Using the reset button or running bmode normal
2915a11f1873SRobert Winkler		will set it back to normal.  This command currently
2916a11f1873SRobert Winkler		supports i.MX53 and i.MX6.
2917a11f1873SRobert Winkler
291819c402afSSimon Glass- Signing support:
291919c402afSSimon Glass		CONFIG_RSA
292019c402afSSimon Glass
292119c402afSSimon Glass		This enables the RSA algorithm used for FIT image verification
29228bf2aad7SDetlev Zundel		in U-Boot. See doc/uImage.FIT/signature.txt for more information.
292319c402afSSimon Glass
292419c402afSSimon Glass		The signing part is build into mkimage regardless of this
292519c402afSSimon Glass		option.
292619c402afSSimon Glass
29279e50c406SHeiko Schocher- bootcount support:
29289e50c406SHeiko Schocher		CONFIG_BOOTCOUNT_LIMIT
29299e50c406SHeiko Schocher
29309e50c406SHeiko Schocher		This enables the bootcounter support, see:
29319e50c406SHeiko Schocher		http://www.denx.de/wiki/DULG/UBootBootCountLimit
29329e50c406SHeiko Schocher
29339e50c406SHeiko Schocher		CONFIG_AT91SAM9XE
29349e50c406SHeiko Schocher		enable special bootcounter support on at91sam9xe based boards.
29359e50c406SHeiko Schocher		CONFIG_BLACKFIN
29369e50c406SHeiko Schocher		enable special bootcounter support on blackfin based boards.
29379e50c406SHeiko Schocher		CONFIG_SOC_DA8XX
29389e50c406SHeiko Schocher		enable special bootcounter support on da850 based boards.
29399e50c406SHeiko Schocher		CONFIG_BOOTCOUNT_RAM
29409e50c406SHeiko Schocher		enable support for the bootcounter in RAM
29419e50c406SHeiko Schocher		CONFIG_BOOTCOUNT_I2C
29429e50c406SHeiko Schocher		enable support for the bootcounter on an i2c (like RTC) device.
29439e50c406SHeiko Schocher			CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
29449e50c406SHeiko Schocher			CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
29459e50c406SHeiko Schocher						    the bootcounter.
29469e50c406SHeiko Schocher			CONFIG_BOOTCOUNT_ALEN = address len
294719c402afSSimon Glass
2948a8c7c708Swdenk- Show boot progress:
2949c609719bSwdenk		CONFIG_SHOW_BOOT_PROGRESS
2950c609719bSwdenk
2951c609719bSwdenk		Defining this option allows to add some board-
2952c609719bSwdenk		specific code (calling a user-provided function
2953c609719bSwdenk		"show_boot_progress(int)") that enables you to show
2954c609719bSwdenk		the system's boot progress on some display (for
2955c609719bSwdenk		example, some LED's) on your board. At the moment,
2956c609719bSwdenk		the following checkpoints are implemented:
2957c609719bSwdenk
29583a608ca0SSimon Glass- Detailed boot stage timing
29593a608ca0SSimon Glass		CONFIG_BOOTSTAGE
29603a608ca0SSimon Glass		Define this option to get detailed timing of each stage
29613a608ca0SSimon Glass		of the boot process.
29623a608ca0SSimon Glass
29633a608ca0SSimon Glass		CONFIG_BOOTSTAGE_USER_COUNT
29643a608ca0SSimon Glass		This is the number of available user bootstage records.
29653a608ca0SSimon Glass		Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
29663a608ca0SSimon Glass		a new ID will be allocated from this stash. If you exceed
29673a608ca0SSimon Glass		the limit, recording will stop.
29683a608ca0SSimon Glass
29693a608ca0SSimon Glass		CONFIG_BOOTSTAGE_REPORT
29703a608ca0SSimon Glass		Define this to print a report before boot, similar to this:
29713a608ca0SSimon Glass
29723a608ca0SSimon Glass		Timer summary in microseconds:
29733a608ca0SSimon Glass		       Mark    Elapsed  Stage
29743a608ca0SSimon Glass			  0          0  reset
29753a608ca0SSimon Glass		  3,575,678  3,575,678  board_init_f start
29763a608ca0SSimon Glass		  3,575,695         17  arch_cpu_init A9
29773a608ca0SSimon Glass		  3,575,777         82  arch_cpu_init done
29783a608ca0SSimon Glass		  3,659,598     83,821  board_init_r start
29793a608ca0SSimon Glass		  3,910,375    250,777  main_loop
29803a608ca0SSimon Glass		 29,916,167 26,005,792  bootm_start
29813a608ca0SSimon Glass		 30,361,327    445,160  start_kernel
29823a608ca0SSimon Glass
29832eba38cfSSimon Glass		CONFIG_CMD_BOOTSTAGE
29842eba38cfSSimon Glass		Add a 'bootstage' command which supports printing a report
29852eba38cfSSimon Glass		and un/stashing of bootstage data.
29862eba38cfSSimon Glass
298794fd1316SSimon Glass		CONFIG_BOOTSTAGE_FDT
298894fd1316SSimon Glass		Stash the bootstage information in the FDT. A root 'bootstage'
298994fd1316SSimon Glass		node is created with each bootstage id as a child. Each child
299094fd1316SSimon Glass		has a 'name' property and either 'mark' containing the
299194fd1316SSimon Glass		mark time in microsecond, or 'accum' containing the
299294fd1316SSimon Glass		accumulated time for that bootstage id in microseconds.
299394fd1316SSimon Glass		For example:
299494fd1316SSimon Glass
299594fd1316SSimon Glass		bootstage {
299694fd1316SSimon Glass			154 {
299794fd1316SSimon Glass				name = "board_init_f";
299894fd1316SSimon Glass				mark = <3575678>;
299994fd1316SSimon Glass			};
300094fd1316SSimon Glass			170 {
300194fd1316SSimon Glass				name = "lcd";
300294fd1316SSimon Glass				accum = <33482>;
300394fd1316SSimon Glass			};
300494fd1316SSimon Glass		};
300594fd1316SSimon Glass
300694fd1316SSimon Glass		Code in the Linux kernel can find this in /proc/devicetree.
300794fd1316SSimon Glass
30081372cce2SMarian BalakowiczLegacy uImage format:
30091372cce2SMarian Balakowicz
3010c609719bSwdenk  Arg	Where			When
3011c609719bSwdenk    1	common/cmd_bootm.c	before attempting to boot an image
3012c609719bSwdenk   -1	common/cmd_bootm.c	Image header has bad	 magic number
3013c609719bSwdenk    2	common/cmd_bootm.c	Image header has correct magic number
3014c609719bSwdenk   -2	common/cmd_bootm.c	Image header has bad	 checksum
3015c609719bSwdenk    3	common/cmd_bootm.c	Image header has correct checksum
3016c609719bSwdenk   -3	common/cmd_bootm.c	Image data   has bad	 checksum
3017c609719bSwdenk    4	common/cmd_bootm.c	Image data   has correct checksum
3018c609719bSwdenk   -4	common/cmd_bootm.c	Image is for unsupported architecture
3019c609719bSwdenk    5	common/cmd_bootm.c	Architecture check OK
30201372cce2SMarian Balakowicz   -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi)
3021c609719bSwdenk    6	common/cmd_bootm.c	Image Type check OK
3022c609719bSwdenk   -6	common/cmd_bootm.c	gunzip uncompression error
3023c609719bSwdenk   -7	common/cmd_bootm.c	Unimplemented compression type
3024c609719bSwdenk    7	common/cmd_bootm.c	Uncompression OK
30251372cce2SMarian Balakowicz    8	common/cmd_bootm.c	No uncompress/copy overwrite error
3026c609719bSwdenk   -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
30271372cce2SMarian Balakowicz
30281372cce2SMarian Balakowicz    9	common/image.c		Start initial ramdisk verification
30291372cce2SMarian Balakowicz  -10	common/image.c		Ramdisk header has bad	   magic number
30301372cce2SMarian Balakowicz  -11	common/image.c		Ramdisk header has bad	   checksum
30311372cce2SMarian Balakowicz   10	common/image.c		Ramdisk header is OK
30321372cce2SMarian Balakowicz  -12	common/image.c		Ramdisk data   has bad	   checksum
30331372cce2SMarian Balakowicz   11	common/image.c		Ramdisk data   has correct checksum
30341372cce2SMarian Balakowicz   12	common/image.c		Ramdisk verification complete, start loading
303511ccc33fSMarcel Ziswiler  -13	common/image.c		Wrong Image Type (not PPC Linux ramdisk)
30361372cce2SMarian Balakowicz   13	common/image.c		Start multifile image verification
30371372cce2SMarian Balakowicz   14	common/image.c		No initial ramdisk, no multifile, continue.
30381372cce2SMarian Balakowicz
3039ea0364f1SPeter Tyser   15	arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
3040c609719bSwdenk
3041a47a12beSStefan Roese  -30	arch/powerpc/lib/board.c	Fatal error, hang the system
304263e73c9aSwdenk  -31	post/post.c		POST test failed, detected by post_output_backlog()
304363e73c9aSwdenk  -32	post/post.c		POST test failed, detected by post_run_single()
304463e73c9aSwdenk
3045566a494fSHeiko Schocher   34	common/cmd_doc.c	before loading a Image from a DOC device
3046566a494fSHeiko Schocher  -35	common/cmd_doc.c	Bad usage of "doc" command
3047566a494fSHeiko Schocher   35	common/cmd_doc.c	correct usage of "doc" command
3048566a494fSHeiko Schocher  -36	common/cmd_doc.c	No boot device
3049566a494fSHeiko Schocher   36	common/cmd_doc.c	correct boot device
3050566a494fSHeiko Schocher  -37	common/cmd_doc.c	Unknown Chip ID on boot device
3051566a494fSHeiko Schocher   37	common/cmd_doc.c	correct chip ID found, device available
3052566a494fSHeiko Schocher  -38	common/cmd_doc.c	Read Error on boot device
3053566a494fSHeiko Schocher   38	common/cmd_doc.c	reading Image header from DOC device OK
3054566a494fSHeiko Schocher  -39	common/cmd_doc.c	Image header has bad magic number
3055566a494fSHeiko Schocher   39	common/cmd_doc.c	Image header has correct magic number
3056566a494fSHeiko Schocher  -40	common/cmd_doc.c	Error reading Image from DOC device
3057566a494fSHeiko Schocher   40	common/cmd_doc.c	Image header has correct magic number
3058566a494fSHeiko Schocher   41	common/cmd_ide.c	before loading a Image from a IDE device
3059566a494fSHeiko Schocher  -42	common/cmd_ide.c	Bad usage of "ide" command
3060566a494fSHeiko Schocher   42	common/cmd_ide.c	correct usage of "ide" command
3061566a494fSHeiko Schocher  -43	common/cmd_ide.c	No boot device
3062566a494fSHeiko Schocher   43	common/cmd_ide.c	boot device found
3063566a494fSHeiko Schocher  -44	common/cmd_ide.c	Device not available
3064566a494fSHeiko Schocher   44	common/cmd_ide.c	Device available
3065566a494fSHeiko Schocher  -45	common/cmd_ide.c	wrong partition selected
3066566a494fSHeiko Schocher   45	common/cmd_ide.c	partition selected
3067566a494fSHeiko Schocher  -46	common/cmd_ide.c	Unknown partition table
3068566a494fSHeiko Schocher   46	common/cmd_ide.c	valid partition table found
3069566a494fSHeiko Schocher  -47	common/cmd_ide.c	Invalid partition type
3070566a494fSHeiko Schocher   47	common/cmd_ide.c	correct partition type
3071566a494fSHeiko Schocher  -48	common/cmd_ide.c	Error reading Image Header on boot device
3072566a494fSHeiko Schocher   48	common/cmd_ide.c	reading Image Header from IDE device OK
3073566a494fSHeiko Schocher  -49	common/cmd_ide.c	Image header has bad magic number
3074566a494fSHeiko Schocher   49	common/cmd_ide.c	Image header has correct magic number
3075566a494fSHeiko Schocher  -50	common/cmd_ide.c	Image header has bad	 checksum
3076566a494fSHeiko Schocher   50	common/cmd_ide.c	Image header has correct checksum
3077566a494fSHeiko Schocher  -51	common/cmd_ide.c	Error reading Image from IDE device
3078566a494fSHeiko Schocher   51	common/cmd_ide.c	reading Image from IDE device OK
3079566a494fSHeiko Schocher   52	common/cmd_nand.c	before loading a Image from a NAND device
3080566a494fSHeiko Schocher  -53	common/cmd_nand.c	Bad usage of "nand" command
3081566a494fSHeiko Schocher   53	common/cmd_nand.c	correct usage of "nand" command
3082566a494fSHeiko Schocher  -54	common/cmd_nand.c	No boot device
3083566a494fSHeiko Schocher   54	common/cmd_nand.c	boot device found
3084566a494fSHeiko Schocher  -55	common/cmd_nand.c	Unknown Chip ID on boot device
3085566a494fSHeiko Schocher   55	common/cmd_nand.c	correct chip ID found, device available
3086566a494fSHeiko Schocher  -56	common/cmd_nand.c	Error reading Image Header on boot device
3087566a494fSHeiko Schocher   56	common/cmd_nand.c	reading Image Header from NAND device OK
3088566a494fSHeiko Schocher  -57	common/cmd_nand.c	Image header has bad magic number
3089566a494fSHeiko Schocher   57	common/cmd_nand.c	Image header has correct magic number
3090566a494fSHeiko Schocher  -58	common/cmd_nand.c	Error reading Image from NAND device
3091566a494fSHeiko Schocher   58	common/cmd_nand.c	reading Image from NAND device OK
3092c609719bSwdenk
3093566a494fSHeiko Schocher  -60	common/env_common.c	Environment has a bad CRC, using default
3094c609719bSwdenk
3095566a494fSHeiko Schocher   64	net/eth.c		starting with Ethernet configuration.
3096566a494fSHeiko Schocher  -64	net/eth.c		no Ethernet found.
3097566a494fSHeiko Schocher   65	net/eth.c		Ethernet found.
3098206c60cbSwdenk
3099566a494fSHeiko Schocher  -80	common/cmd_net.c	usage wrong
3100566a494fSHeiko Schocher   80	common/cmd_net.c	before calling NetLoop()
310111ccc33fSMarcel Ziswiler  -81	common/cmd_net.c	some error in NetLoop() occurred
3102566a494fSHeiko Schocher   81	common/cmd_net.c	NetLoop() back without error
3103566a494fSHeiko Schocher  -82	common/cmd_net.c	size == 0 (File with size 0 loaded)
3104566a494fSHeiko Schocher   82	common/cmd_net.c	trying automatic boot
310574de7aefSWolfgang Denk   83	common/cmd_net.c	running "source" command
310674de7aefSWolfgang Denk  -83	common/cmd_net.c	some error in automatic boot or "source" command
3107566a494fSHeiko Schocher   84	common/cmd_net.c	end without errors
3108c609719bSwdenk
31091372cce2SMarian BalakowiczFIT uImage format:
31101372cce2SMarian Balakowicz
31111372cce2SMarian Balakowicz  Arg	Where			When
31121372cce2SMarian Balakowicz  100	common/cmd_bootm.c	Kernel FIT Image has correct format
31131372cce2SMarian Balakowicz -100	common/cmd_bootm.c	Kernel FIT Image has incorrect format
31141372cce2SMarian Balakowicz  101	common/cmd_bootm.c	No Kernel subimage unit name, using configuration
31151372cce2SMarian Balakowicz -101	common/cmd_bootm.c	Can't get configuration for kernel subimage
31161372cce2SMarian Balakowicz  102	common/cmd_bootm.c	Kernel unit name specified
31171372cce2SMarian Balakowicz -103	common/cmd_bootm.c	Can't get kernel subimage node offset
3118f773bea8SMarian Balakowicz  103	common/cmd_bootm.c	Found configuration node
31191372cce2SMarian Balakowicz  104	common/cmd_bootm.c	Got kernel subimage node offset
31201372cce2SMarian Balakowicz -104	common/cmd_bootm.c	Kernel subimage hash verification failed
31211372cce2SMarian Balakowicz  105	common/cmd_bootm.c	Kernel subimage hash verification OK
31221372cce2SMarian Balakowicz -105	common/cmd_bootm.c	Kernel subimage is for unsupported architecture
31231372cce2SMarian Balakowicz  106	common/cmd_bootm.c	Architecture check OK
312411ccc33fSMarcel Ziswiler -106	common/cmd_bootm.c	Kernel subimage has wrong type
312511ccc33fSMarcel Ziswiler  107	common/cmd_bootm.c	Kernel subimage type OK
31261372cce2SMarian Balakowicz -107	common/cmd_bootm.c	Can't get kernel subimage data/size
31271372cce2SMarian Balakowicz  108	common/cmd_bootm.c	Got kernel subimage data/size
31281372cce2SMarian Balakowicz -108	common/cmd_bootm.c	Wrong image type (not legacy, FIT)
31291372cce2SMarian Balakowicz -109	common/cmd_bootm.c	Can't get kernel subimage type
31301372cce2SMarian Balakowicz -110	common/cmd_bootm.c	Can't get kernel subimage comp
31311372cce2SMarian Balakowicz -111	common/cmd_bootm.c	Can't get kernel subimage os
31321372cce2SMarian Balakowicz -112	common/cmd_bootm.c	Can't get kernel subimage load address
31331372cce2SMarian Balakowicz -113	common/cmd_bootm.c	Image uncompress/copy overwrite error
31341372cce2SMarian Balakowicz
31351372cce2SMarian Balakowicz  120	common/image.c		Start initial ramdisk verification
31361372cce2SMarian Balakowicz -120	common/image.c		Ramdisk FIT image has incorrect format
31371372cce2SMarian Balakowicz  121	common/image.c		Ramdisk FIT image has correct format
313811ccc33fSMarcel Ziswiler  122	common/image.c		No ramdisk subimage unit name, using configuration
31391372cce2SMarian Balakowicz -122	common/image.c		Can't get configuration for ramdisk subimage
31401372cce2SMarian Balakowicz  123	common/image.c		Ramdisk unit name specified
31411372cce2SMarian Balakowicz -124	common/image.c		Can't get ramdisk subimage node offset
31421372cce2SMarian Balakowicz  125	common/image.c		Got ramdisk subimage node offset
31431372cce2SMarian Balakowicz -125	common/image.c		Ramdisk subimage hash verification failed
31441372cce2SMarian Balakowicz  126	common/image.c		Ramdisk subimage hash verification OK
31451372cce2SMarian Balakowicz -126	common/image.c		Ramdisk subimage for unsupported architecture
31461372cce2SMarian Balakowicz  127	common/image.c		Architecture check OK
31471372cce2SMarian Balakowicz -127	common/image.c		Can't get ramdisk subimage data/size
31481372cce2SMarian Balakowicz  128	common/image.c		Got ramdisk subimage data/size
31491372cce2SMarian Balakowicz  129	common/image.c		Can't get ramdisk load address
31501372cce2SMarian Balakowicz -129	common/image.c		Got ramdisk load address
31511372cce2SMarian Balakowicz
315211ccc33fSMarcel Ziswiler -130	common/cmd_doc.c	Incorrect FIT image format
31531372cce2SMarian Balakowicz  131	common/cmd_doc.c	FIT image format OK
31541372cce2SMarian Balakowicz
315511ccc33fSMarcel Ziswiler -140	common/cmd_ide.c	Incorrect FIT image format
31561372cce2SMarian Balakowicz  141	common/cmd_ide.c	FIT image format OK
31571372cce2SMarian Balakowicz
315811ccc33fSMarcel Ziswiler -150	common/cmd_nand.c	Incorrect FIT image format
31591372cce2SMarian Balakowicz  151	common/cmd_nand.c	FIT image format OK
31601372cce2SMarian Balakowicz
3161d95f6ec7SGabe Black- FIT image support:
3162d95f6ec7SGabe Black		CONFIG_FIT
3163d95f6ec7SGabe Black		Enable support for the FIT uImage format.
3164d95f6ec7SGabe Black
3165d95f6ec7SGabe Black		CONFIG_FIT_BEST_MATCH
3166d95f6ec7SGabe Black		When no configuration is explicitly selected, default to the
3167d95f6ec7SGabe Black		one whose fdt's compatibility field best matches that of
3168d95f6ec7SGabe Black		U-Boot itself. A match is considered "best" if it matches the
3169d95f6ec7SGabe Black		most specific compatibility entry of U-Boot's fdt's root node.
3170d95f6ec7SGabe Black		The order of entries in the configuration's fdt is ignored.
3171d95f6ec7SGabe Black
31723e569a6bSSimon Glass		CONFIG_FIT_SIGNATURE
31733e569a6bSSimon Glass		This option enables signature verification of FIT uImages,
31743e569a6bSSimon Glass		using a hash signed and verified using RSA. See
31753e569a6bSSimon Glass		doc/uImage.FIT/signature.txt for more details.
31763e569a6bSSimon Glass
31774cf2609bSWolfgang Denk- Standalone program support:
31784cf2609bSWolfgang Denk		CONFIG_STANDALONE_LOAD_ADDR
31794cf2609bSWolfgang Denk
31806feff899SWolfgang Denk		This option defines a board specific value for the
31816feff899SWolfgang Denk		address where standalone program gets loaded, thus
31826feff899SWolfgang Denk		overwriting the architecture dependent default
31834cf2609bSWolfgang Denk		settings.
31844cf2609bSWolfgang Denk
31854cf2609bSWolfgang Denk- Frame Buffer Address:
31864cf2609bSWolfgang Denk		CONFIG_FB_ADDR
31874cf2609bSWolfgang Denk
31884cf2609bSWolfgang Denk		Define CONFIG_FB_ADDR if you want to use specific
318944a53b57SWolfgang Denk		address for frame buffer.  This is typically the case
319044a53b57SWolfgang Denk		when using a graphics controller has separate video
319144a53b57SWolfgang Denk		memory.  U-Boot will then place the frame buffer at
319244a53b57SWolfgang Denk		the given address instead of dynamically reserving it
319344a53b57SWolfgang Denk		in system RAM by calling lcd_setmem(), which grabs
319444a53b57SWolfgang Denk		the memory for the frame buffer depending on the
319544a53b57SWolfgang Denk		configured panel size.
31964cf2609bSWolfgang Denk
31974cf2609bSWolfgang Denk		Please see board_init_f function.
31984cf2609bSWolfgang Denk
3199cccfc2abSDetlev Zundel- Automatic software updates via TFTP server
3200cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP
3201cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_CNT_MAX
3202cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_MSEC_MAX
3203cccfc2abSDetlev Zundel
3204cccfc2abSDetlev Zundel		These options enable and control the auto-update feature;
3205cccfc2abSDetlev Zundel		for a more detailed description refer to doc/README.update.
3206cccfc2abSDetlev Zundel
3207cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support)
3208cccfc2abSDetlev Zundel		CONFIG_MTD_DEVICE
3209cccfc2abSDetlev Zundel
3210cccfc2abSDetlev Zundel		Adds the MTD device infrastructure from the Linux kernel.
3211cccfc2abSDetlev Zundel		Needed for mtdparts command support.
3212cccfc2abSDetlev Zundel
3213cccfc2abSDetlev Zundel		CONFIG_MTD_PARTITIONS
3214cccfc2abSDetlev Zundel
3215cccfc2abSDetlev Zundel		Adds the MTD partitioning infrastructure from the Linux
3216cccfc2abSDetlev Zundel		kernel. Needed for UBI support.
3217cccfc2abSDetlev Zundel
321870c219cdSJoe Hershberger- UBI support
321970c219cdSJoe Hershberger		CONFIG_CMD_UBI
322070c219cdSJoe Hershberger
322170c219cdSJoe Hershberger		Adds commands for interacting with MTD partitions formatted
322270c219cdSJoe Hershberger		with the UBI flash translation layer
322370c219cdSJoe Hershberger
322470c219cdSJoe Hershberger		Requires also defining CONFIG_RBTREE
322570c219cdSJoe Hershberger
3226147162daSJoe Hershberger		CONFIG_UBI_SILENCE_MSG
3227147162daSJoe Hershberger
3228147162daSJoe Hershberger		Make the verbose messages from UBI stop printing.  This leaves
3229147162daSJoe Hershberger		warnings and errors enabled.
3230147162daSJoe Hershberger
323170c219cdSJoe Hershberger- UBIFS support
323270c219cdSJoe Hershberger		CONFIG_CMD_UBIFS
323370c219cdSJoe Hershberger
323470c219cdSJoe Hershberger		Adds commands for interacting with UBI volumes formatted as
323570c219cdSJoe Hershberger		UBIFS.  UBIFS is read-only in u-boot.
323670c219cdSJoe Hershberger
323770c219cdSJoe Hershberger		Requires UBI support as well as CONFIG_LZO
323870c219cdSJoe Hershberger
3239147162daSJoe Hershberger		CONFIG_UBIFS_SILENCE_MSG
3240147162daSJoe Hershberger
3241147162daSJoe Hershberger		Make the verbose messages from UBIFS stop printing.  This leaves
3242147162daSJoe Hershberger		warnings and errors enabled.
3243147162daSJoe Hershberger
32446a11cf48SDaniel Schwierzeck- SPL framework
32456a11cf48SDaniel Schwierzeck		CONFIG_SPL
32466a11cf48SDaniel Schwierzeck		Enable building of SPL globally.
32476a11cf48SDaniel Schwierzeck
324895579793STom Rini		CONFIG_SPL_LDSCRIPT
324995579793STom Rini		LDSCRIPT for linking the SPL binary.
325095579793STom Rini
32516ebc3461SAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT
32526ebc3461SAlbert ARIBAUD		Maximum size in memory allocated to the SPL, BSS included.
32536ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual memory
32546ebc3461SAlbert ARIBAUD		used by SPL from _start to __bss_end does not exceed it.
32558960af8bSAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
32566ebc3461SAlbert ARIBAUD		must not be both defined at the same time.
32576ebc3461SAlbert ARIBAUD
325895579793STom Rini		CONFIG_SPL_MAX_SIZE
32596ebc3461SAlbert ARIBAUD		Maximum size of the SPL image (text, data, rodata, and
32606ebc3461SAlbert ARIBAUD		linker lists sections), BSS excluded.
32616ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual size does
32626ebc3461SAlbert ARIBAUD		not exceed it.
326395579793STom Rini
32646a11cf48SDaniel Schwierzeck		CONFIG_SPL_TEXT_BASE
32656a11cf48SDaniel Schwierzeck		TEXT_BASE for linking the SPL binary.
32666a11cf48SDaniel Schwierzeck
326794a45bb1SScott Wood		CONFIG_SPL_RELOC_TEXT_BASE
326894a45bb1SScott Wood		Address to relocate to.  If unspecified, this is equal to
326994a45bb1SScott Wood		CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
327094a45bb1SScott Wood
327195579793STom Rini		CONFIG_SPL_BSS_START_ADDR
327295579793STom Rini		Link address for the BSS within the SPL binary.
327395579793STom Rini
327495579793STom Rini		CONFIG_SPL_BSS_MAX_SIZE
32756ebc3461SAlbert ARIBAUD		Maximum size in memory allocated to the SPL BSS.
32766ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual memory used
32776ebc3461SAlbert ARIBAUD		by SPL from __bss_start to __bss_end does not exceed it.
32788960af8bSAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
32796ebc3461SAlbert ARIBAUD		must not be both defined at the same time.
328095579793STom Rini
328195579793STom Rini		CONFIG_SPL_STACK
328295579793STom Rini		Adress of the start of the stack SPL will use
328395579793STom Rini
328494a45bb1SScott Wood		CONFIG_SPL_RELOC_STACK
328594a45bb1SScott Wood		Adress of the start of the stack SPL will use after
328694a45bb1SScott Wood		relocation.  If unspecified, this is equal to
328794a45bb1SScott Wood		CONFIG_SPL_STACK.
328894a45bb1SScott Wood
328995579793STom Rini		CONFIG_SYS_SPL_MALLOC_START
329095579793STom Rini		Starting address of the malloc pool used in SPL.
329195579793STom Rini
329295579793STom Rini		CONFIG_SYS_SPL_MALLOC_SIZE
329395579793STom Rini		The size of the malloc pool used in SPL.
32946a11cf48SDaniel Schwierzeck
329547f7bcaeSTom Rini		CONFIG_SPL_FRAMEWORK
329647f7bcaeSTom Rini		Enable the SPL framework under common/.  This framework
329747f7bcaeSTom Rini		supports MMC, NAND and YMODEM loading of U-Boot and NAND
329847f7bcaeSTom Rini		NAND loading of the Linux Kernel.
329947f7bcaeSTom Rini
3300861a86f4STom Rini		CONFIG_SPL_DISPLAY_PRINT
3301861a86f4STom Rini		For ARM, enable an optional function to print more information
3302861a86f4STom Rini		about the running system.
3303861a86f4STom Rini
33044b919725SScott Wood		CONFIG_SPL_INIT_MINIMAL
33054b919725SScott Wood		Arch init code should be built for a very small image
33064b919725SScott Wood
33076a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBCOMMON_SUPPORT
33086a11cf48SDaniel Schwierzeck		Support for common/libcommon.o in SPL binary
33096a11cf48SDaniel Schwierzeck
33106a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBDISK_SUPPORT
33116a11cf48SDaniel Schwierzeck		Support for disk/libdisk.o in SPL binary
33126a11cf48SDaniel Schwierzeck
33136a11cf48SDaniel Schwierzeck		CONFIG_SPL_I2C_SUPPORT
33146a11cf48SDaniel Schwierzeck		Support for drivers/i2c/libi2c.o in SPL binary
33156a11cf48SDaniel Schwierzeck
33166a11cf48SDaniel Schwierzeck		CONFIG_SPL_GPIO_SUPPORT
33176a11cf48SDaniel Schwierzeck		Support for drivers/gpio/libgpio.o in SPL binary
33186a11cf48SDaniel Schwierzeck
33196a11cf48SDaniel Schwierzeck		CONFIG_SPL_MMC_SUPPORT
33206a11cf48SDaniel Schwierzeck		Support for drivers/mmc/libmmc.o in SPL binary
33216a11cf48SDaniel Schwierzeck
332295579793STom Rini		CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
332395579793STom Rini		CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
332495579793STom Rini		CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION
332595579793STom Rini		Address, size and partition on the MMC to load U-Boot from
332695579793STom Rini		when the MMC is being used in raw mode.
332795579793STom Rini
33282b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
33292b75b0adSPeter Korsgaard		Sector to load kernel uImage from when MMC is being
33302b75b0adSPeter Korsgaard		used in raw mode (for Falcon mode)
33312b75b0adSPeter Korsgaard
33322b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
33332b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
33342b75b0adSPeter Korsgaard		Sector and number of sectors to load kernel argument
33352b75b0adSPeter Korsgaard		parameters from when MMC is being used in raw mode
33362b75b0adSPeter Korsgaard		(for falcon mode)
33372b75b0adSPeter Korsgaard
333895579793STom Rini		CONFIG_SPL_FAT_SUPPORT
333995579793STom Rini		Support for fs/fat/libfat.o in SPL binary
334095579793STom Rini
334195579793STom Rini		CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME
334295579793STom Rini		Filename to read to load U-Boot when reading from FAT
334395579793STom Rini
33447ad2cc79SPeter Korsgaard		CONFIG_SPL_FAT_LOAD_KERNEL_NAME
33457ad2cc79SPeter Korsgaard		Filename to read to load kernel uImage when reading
33467ad2cc79SPeter Korsgaard		from FAT (for Falcon mode)
33477ad2cc79SPeter Korsgaard
33487ad2cc79SPeter Korsgaard		CONFIG_SPL_FAT_LOAD_ARGS_NAME
33497ad2cc79SPeter Korsgaard		Filename to read to load kernel argument parameters
33507ad2cc79SPeter Korsgaard		when reading from FAT (for Falcon mode)
33517ad2cc79SPeter Korsgaard
335206f60ae3SScott Wood		CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
335306f60ae3SScott Wood		Set this for NAND SPL on PPC mpc83xx targets, so that
335406f60ae3SScott Wood		start.S waits for the rest of the SPL to load before
335506f60ae3SScott Wood		continuing (the hardware starts execution after just
335606f60ae3SScott Wood		loading the first page rather than the full 4K).
335706f60ae3SScott Wood
3358651fcf60SPrabhakar Kushwaha		CONFIG_SPL_SKIP_RELOCATE
3359651fcf60SPrabhakar Kushwaha		Avoid SPL relocation
3360651fcf60SPrabhakar Kushwaha
33616f2f01b9SScott Wood		CONFIG_SPL_NAND_BASE
33626f2f01b9SScott Wood		Include nand_base.c in the SPL.  Requires
33636f2f01b9SScott Wood		CONFIG_SPL_NAND_DRIVERS.
33646f2f01b9SScott Wood
33656f2f01b9SScott Wood		CONFIG_SPL_NAND_DRIVERS
33666f2f01b9SScott Wood		SPL uses normal NAND drivers, not minimal drivers.
33676f2f01b9SScott Wood
33686f2f01b9SScott Wood		CONFIG_SPL_NAND_ECC
33696f2f01b9SScott Wood		Include standard software ECC in the SPL
33706f2f01b9SScott Wood
337195579793STom Rini		CONFIG_SPL_NAND_SIMPLE
33727d4b7955SScott Wood		Support for NAND boot using simple NAND drivers that
33737d4b7955SScott Wood		expose the cmd_ctrl() interface.
337495579793STom Rini
3375bb0dc108SYing Zhang		CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT
3376bb0dc108SYing Zhang		Set for the SPL on PPC mpc8xxx targets, support for
33775614e71bSYork Sun		drivers/ddr/fsl/libddr.o in SPL binary.
3378bb0dc108SYing Zhang
33797c8eea59SYing Zhang		CONFIG_SPL_COMMON_INIT_DDR
33807c8eea59SYing Zhang		Set for common ddr init with serial presence detect in
33817c8eea59SYing Zhang		SPL binary.
33827c8eea59SYing Zhang
338395579793STom Rini		CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
338495579793STom Rini		CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
338595579793STom Rini		CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
338695579793STom Rini		CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
338795579793STom Rini		CONFIG_SYS_NAND_ECCBYTES
338895579793STom Rini		Defines the size and behavior of the NAND that SPL uses
33897d4b7955SScott Wood		to read U-Boot
339095579793STom Rini
3391fbe76ae4SPrabhakar Kushwaha		CONFIG_SPL_NAND_BOOT
3392fbe76ae4SPrabhakar Kushwaha		Add support NAND boot
3393fbe76ae4SPrabhakar Kushwaha
339495579793STom Rini		CONFIG_SYS_NAND_U_BOOT_OFFS
33957d4b7955SScott Wood		Location in NAND to read U-Boot from
33967d4b7955SScott Wood
33977d4b7955SScott Wood		CONFIG_SYS_NAND_U_BOOT_DST
33987d4b7955SScott Wood		Location in memory to load U-Boot to
33997d4b7955SScott Wood
34007d4b7955SScott Wood		CONFIG_SYS_NAND_U_BOOT_SIZE
34017d4b7955SScott Wood		Size of image to load
340295579793STom Rini
340395579793STom Rini		CONFIG_SYS_NAND_U_BOOT_START
34047d4b7955SScott Wood		Entry point in loaded image to jump to
340595579793STom Rini
340695579793STom Rini		CONFIG_SYS_NAND_HW_ECC_OOBFIRST
340795579793STom Rini		Define this if you need to first read the OOB and then the
340895579793STom Rini		data. This is used for example on davinci plattforms.
340995579793STom Rini
341095579793STom Rini		CONFIG_SPL_OMAP3_ID_NAND
341195579793STom Rini		Support for an OMAP3-specific set of functions to return the
341295579793STom Rini		ID and MFR of the first attached NAND chip, if present.
341395579793STom Rini
34146a11cf48SDaniel Schwierzeck		CONFIG_SPL_SERIAL_SUPPORT
34156a11cf48SDaniel Schwierzeck		Support for drivers/serial/libserial.o in SPL binary
34166a11cf48SDaniel Schwierzeck
34176a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_FLASH_SUPPORT
34186a11cf48SDaniel Schwierzeck		Support for drivers/mtd/spi/libspi_flash.o in SPL binary
34196a11cf48SDaniel Schwierzeck
34206a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_SUPPORT
34216a11cf48SDaniel Schwierzeck		Support for drivers/spi/libspi.o in SPL binary
34226a11cf48SDaniel Schwierzeck
3423c57b953dSPavel Machek		CONFIG_SPL_RAM_DEVICE
3424c57b953dSPavel Machek		Support for running image already present in ram, in SPL binary
3425c57b953dSPavel Machek
34266a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBGENERIC_SUPPORT
34276a11cf48SDaniel Schwierzeck		Support for lib/libgeneric.o in SPL binary
34281372cce2SMarian Balakowicz
3429ba1bee43SYing Zhang		CONFIG_SPL_ENV_SUPPORT
3430ba1bee43SYing Zhang		Support for the environment operating in SPL binary
3431ba1bee43SYing Zhang
3432ba1bee43SYing Zhang		CONFIG_SPL_NET_SUPPORT
3433ba1bee43SYing Zhang		Support for the net/libnet.o in SPL binary.
3434ba1bee43SYing Zhang		It conflicts with SPL env from storage medium specified by
3435ba1bee43SYing Zhang		CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3436ba1bee43SYing Zhang
343774752baaSScott Wood		CONFIG_SPL_PAD_TO
34386113d3f2SBenoît Thébaudeau		Image offset to which the SPL should be padded before appending
34396113d3f2SBenoît Thébaudeau		the SPL payload. By default, this is defined as
34406113d3f2SBenoît Thébaudeau		CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
34416113d3f2SBenoît Thébaudeau		CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
34426113d3f2SBenoît Thébaudeau		payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
344374752baaSScott Wood
3444ca2fca22SScott Wood		CONFIG_SPL_TARGET
3445ca2fca22SScott Wood		Final target image containing SPL and payload.  Some SPLs
3446ca2fca22SScott Wood		use an arch-specific makefile fragment instead, for
3447ca2fca22SScott Wood		example if more than one image needs to be produced.
3448ca2fca22SScott Wood
344987ebee39SSimon Glass		CONFIG_FIT_SPL_PRINT
345087ebee39SSimon Glass		Printing information about a FIT image adds quite a bit of
345187ebee39SSimon Glass		code to SPL. So this is normally disabled in SPL. Use this
345287ebee39SSimon Glass		option to re-enable it. This will affect the output of the
345387ebee39SSimon Glass		bootm command when booting a FIT image.
345487ebee39SSimon Glass
34553aa29de0SYing Zhang- TPL framework
34563aa29de0SYing Zhang		CONFIG_TPL
34573aa29de0SYing Zhang		Enable building of TPL globally.
34583aa29de0SYing Zhang
34593aa29de0SYing Zhang		CONFIG_TPL_PAD_TO
34603aa29de0SYing Zhang		Image offset to which the TPL should be padded before appending
34613aa29de0SYing Zhang		the TPL payload. By default, this is defined as
34623aa29de0SYing Zhang		CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
34633aa29de0SYing Zhang		CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
34643aa29de0SYing Zhang		payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
34653aa29de0SYing Zhang
3466c609719bSwdenkModem Support:
3467c609719bSwdenk--------------
3468c609719bSwdenk
3469566e5cf4SWolfgang Denk[so far only for SMDK2400 boards]
3470c609719bSwdenk
347111ccc33fSMarcel Ziswiler- Modem support enable:
3472c609719bSwdenk		CONFIG_MODEM_SUPPORT
3473c609719bSwdenk
3474c609719bSwdenk- RTS/CTS Flow control enable:
3475c609719bSwdenk		CONFIG_HWFLOW
3476c609719bSwdenk
3477c609719bSwdenk- Modem debug support:
3478c609719bSwdenk		CONFIG_MODEM_SUPPORT_DEBUG
3479c609719bSwdenk
3480c609719bSwdenk		Enables debugging stuff (char screen[1024], dbg())
3481c609719bSwdenk		for modem support. Useful only with BDI2000.
3482c609719bSwdenk
3483a8c7c708Swdenk- Interrupt support (PPC):
3484a8c7c708Swdenk
3485a8c7c708Swdenk		There are common interrupt_init() and timer_interrupt()
3486a8c7c708Swdenk		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
348711ccc33fSMarcel Ziswiler		for CPU specific initialization. interrupt_init_cpu()
3488a8c7c708Swdenk		should set decrementer_count to appropriate value. If
348911ccc33fSMarcel Ziswiler		CPU resets decrementer automatically after interrupt
3490a8c7c708Swdenk		(ppc4xx) it should set decrementer_count to zero.
349111ccc33fSMarcel Ziswiler		timer_interrupt() calls timer_interrupt_cpu() for CPU
3492a8c7c708Swdenk		specific handling. If board has watchdog / status_led
3493a8c7c708Swdenk		/ other_activity_monitor it works automatically from
3494a8c7c708Swdenk		general timer_interrupt().
3495a8c7c708Swdenk
3496c609719bSwdenk- General:
3497c609719bSwdenk
3498c609719bSwdenk		In the target system modem support is enabled when a
3499c609719bSwdenk		specific key (key combination) is pressed during
3500c609719bSwdenk		power-on. Otherwise U-Boot will boot normally
350111ccc33fSMarcel Ziswiler		(autoboot). The key_pressed() function is called from
3502c609719bSwdenk		board_init(). Currently key_pressed() is a dummy
3503c609719bSwdenk		function, returning 1 and thus enabling modem
3504c609719bSwdenk		initialization.
3505c609719bSwdenk
3506c609719bSwdenk		If there are no modem init strings in the
3507c609719bSwdenk		environment, U-Boot proceed to autoboot; the
3508c609719bSwdenk		previous output (banner, info printfs) will be
350911ccc33fSMarcel Ziswiler		suppressed, though.
3510c609719bSwdenk
3511c609719bSwdenk		See also: doc/README.Modem
3512c609719bSwdenk
35139660e442SHelmut RaigerBoard initialization settings:
35149660e442SHelmut Raiger------------------------------
35159660e442SHelmut Raiger
35169660e442SHelmut RaigerDuring Initialization u-boot calls a number of board specific functions
35179660e442SHelmut Raigerto allow the preparation of board specific prerequisites, e.g. pin setup
35189660e442SHelmut Raigerbefore drivers are initialized. To enable these callbacks the
35199660e442SHelmut Raigerfollowing configuration macros have to be defined. Currently this is
35209660e442SHelmut Raigerarchitecture specific, so please check arch/your_architecture/lib/board.c
35219660e442SHelmut Raigertypically in board_init_f() and board_init_r().
35229660e442SHelmut Raiger
35239660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
35249660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
35259660e442SHelmut Raiger- CONFIG_BOARD_LATE_INIT: Call board_late_init()
35269660e442SHelmut Raiger- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
3527c609719bSwdenk
3528c609719bSwdenkConfiguration Settings:
3529c609719bSwdenk-----------------------
3530c609719bSwdenk
35314d1fd7f1SYork Sun- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
35324d1fd7f1SYork Sun		Optionally it can be defined to support 64-bit memory commands.
35334d1fd7f1SYork Sun
35346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
3535c609719bSwdenk		undefine this when you're short of memory.
3536c609719bSwdenk
35372fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
35382fb2604dSPeter Tyser		width of the commands listed in the 'help' command output.
35392fb2604dSPeter Tyser
35406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT:	This is what U-Boot prints on the console to
3541c609719bSwdenk		prompt for user input.
3542c609719bSwdenk
35436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE:	Buffer size for input from the Console
3544c609719bSwdenk
35456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE:	Buffer size for Console output
3546c609719bSwdenk
35476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS:	max. Number of arguments accepted for monitor commands
3548c609719bSwdenk
35496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
3550c609719bSwdenk		the application (usually a Linux kernel) when it is
3551c609719bSwdenk		booted
3552c609719bSwdenk
35536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE:
3554c609719bSwdenk		List of legal baudrate settings for this board.
3555c609719bSwdenk
35566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_INFO_QUIET
3557c609719bSwdenk		Suppress display of console information at boot.
3558c609719bSwdenk
35596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_IS_IN_ENV
3560c609719bSwdenk		If the board specific function
3561c609719bSwdenk			extern int overwrite_console (void);
3562c609719bSwdenk		returns 1, the stdin, stderr and stdout are switched to the
3563c609719bSwdenk		serial port, else the settings in the environment are used.
3564c609719bSwdenk
35656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
3566c609719bSwdenk		Enable the call to overwrite_console().
3567c609719bSwdenk
35686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
3569c609719bSwdenk		Enable overwrite of previous console environment settings.
3570c609719bSwdenk
35716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
3572c609719bSwdenk		Begin and End addresses of the area used by the
3573c609719bSwdenk		simple memory test.
3574c609719bSwdenk
35756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST:
3576c609719bSwdenk		Enable an alternate, more extensive memory test.
3577c609719bSwdenk
35786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH:
35795f535fe1Swdenk		Scratch address used by the alternate memory test
35805f535fe1Swdenk		You only need to set this if address zero isn't writeable
35815f535fe1Swdenk
35826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
35836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
358414f73ca6SStefan Roese		this specified memory area will get subtracted from the top
358511ccc33fSMarcel Ziswiler		(end) of RAM and won't get "touched" at all by U-Boot. By
358614f73ca6SStefan Roese		fixing up gd->ram_size the Linux kernel should gets passed
358714f73ca6SStefan Roese		the now "corrected" memory size and won't touch it either.
358814f73ca6SStefan Roese		This should work for arch/ppc and arch/powerpc. Only Linux
35895e12e75dSStefan Roese		board ports in arch/powerpc with bootwrapper support that
359014f73ca6SStefan Roese		recalculate the memory size from the SDRAM controller setup
35915e12e75dSStefan Roese		will have to get fixed in Linux additionally.
359214f73ca6SStefan Roese
359314f73ca6SStefan Roese		This option can be used as a workaround for the 440EPx/GRx
359414f73ca6SStefan Roese		CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
359514f73ca6SStefan Roese		be touched.
359614f73ca6SStefan Roese
359714f73ca6SStefan Roese		WARNING: Please make sure that this value is a multiple of
359814f73ca6SStefan Roese		the Linux page size (normally 4k). If this is not the case,
359914f73ca6SStefan Roese		then the end address of the Linux memory will be located at a
360014f73ca6SStefan Roese		non page size aligned address and this could cause major
360114f73ca6SStefan Roese		problems.
360214f73ca6SStefan Roese
36036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE:
3604c609719bSwdenk		Enable temporary baudrate change while serial download
3605c609719bSwdenk
36066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE:
3607c609719bSwdenk		Physical start address of SDRAM. _Must_ be 0 here.
3608c609719bSwdenk
36096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MBIO_BASE:
3610c609719bSwdenk		Physical start address of Motherboard I/O (if using a
3611c609719bSwdenk		Cogent motherboard)
3612c609719bSwdenk
36136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE:
3614c609719bSwdenk		Physical start address of Flash memory.
3615c609719bSwdenk
36166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE:
3617c609719bSwdenk		Physical start address of boot monitor code (set by
3618c609719bSwdenk		make config files to be same as the text base address
361914d0a02aSWolfgang Denk		(CONFIG_SYS_TEXT_BASE) used when linking) - same as
36206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FLASH_BASE when booting from flash.
3621c609719bSwdenk
36226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN:
36233b57fe0aSwdenk		Size of memory reserved for monitor code, used to
36243b57fe0aSwdenk		determine _at_compile_time_ (!) if the environment is
36253b57fe0aSwdenk		embedded within the U-Boot image, or in a separate
36263b57fe0aSwdenk		flash sector.
3627c609719bSwdenk
36286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN:
3629c609719bSwdenk		Size of DRAM reserved for malloc() use.
3630c609719bSwdenk
36316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN:
363215940c9aSStefan Roese		Normally compressed uImages are limited to an
363315940c9aSStefan Roese		uncompressed size of 8 MBytes. If this is not enough,
36346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		you can define CONFIG_SYS_BOOTM_LEN in your board config file
363515940c9aSStefan Roese		to adjust this setting to your needs.
3636c609719bSwdenk
36376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ:
3638c609719bSwdenk		Maximum size of memory mapped by the startup code of
3639c609719bSwdenk		the Linux kernel; all data that must be processed by
36407d721e34SBartlomiej Sieka		the Linux kernel (bd_info, boot arguments, FDT blob if
36417d721e34SBartlomiej Sieka		used) must be put below this limit, unless "bootm_low"
36421bce2aebSRobert P. J. Day		environment variable is defined and non-zero. In such case
36437d721e34SBartlomiej Sieka		all data for the Linux kernel must be between "bootm_low"
3644c3624e6eSGrant Likely		and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.	 The environment
3645c3624e6eSGrant Likely		variable "bootm_mapsize" will override the value of
3646c3624e6eSGrant Likely		CONFIG_SYS_BOOTMAPSZ.  If CONFIG_SYS_BOOTMAPSZ is undefined,
3647c3624e6eSGrant Likely		then the value in "bootm_size" will be used instead.
3648c609719bSwdenk
3649fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3650fca43cc8SJohn Rigby		Enable initrd_high functionality.  If defined then the
3651fca43cc8SJohn Rigby		initrd_high feature is enabled and the bootm ramdisk subcommand
3652fca43cc8SJohn Rigby		is enabled.
3653fca43cc8SJohn Rigby
3654fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_CMDLINE:
3655fca43cc8SJohn Rigby		Enables allocating and saving kernel cmdline in space between
3656fca43cc8SJohn Rigby		"bootm_low" and "bootm_low" + BOOTMAPSZ.
3657fca43cc8SJohn Rigby
3658fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_KBD:
3659fca43cc8SJohn Rigby		Enables allocating and saving a kernel copy of the bd_info in
3660fca43cc8SJohn Rigby		space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3661fca43cc8SJohn Rigby
36626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS:
3663c609719bSwdenk		Max number of Flash memory banks
3664c609719bSwdenk
36656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT:
3666c609719bSwdenk		Max number of sectors on a Flash chip
3667c609719bSwdenk
36686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT:
3669c609719bSwdenk		Timeout for Flash erase operations (in ms)
3670c609719bSwdenk
36716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT:
3672c609719bSwdenk		Timeout for Flash write operations (in ms)
3673c609719bSwdenk
36746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT
36758564acf9Swdenk		Timeout for Flash set sector lock bit operation (in ms)
36768564acf9Swdenk
36776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT
36788564acf9Swdenk		Timeout for Flash clear lock bits operation (in ms)
36798564acf9Swdenk
36806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION
36818564acf9Swdenk		If defined, hardware flash sectors protection is used
36828564acf9Swdenk		instead of U-Boot software protection.
36838564acf9Swdenk
36846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP:
3685c609719bSwdenk
3686c609719bSwdenk		Enable TFTP transfers directly to flash memory;
3687c609719bSwdenk		without this option such a download has to be
3688c609719bSwdenk		performed in two steps: (1) download to RAM, and (2)
3689c609719bSwdenk		copy from RAM to flash.
3690c609719bSwdenk
3691c609719bSwdenk		The two-step approach is usually more reliable, since
3692c609719bSwdenk		you can check if the download worked before you erase
369311ccc33fSMarcel Ziswiler		the flash, but in some situations (when system RAM is
369411ccc33fSMarcel Ziswiler		too limited to allow for a temporary copy of the
3695c609719bSwdenk		downloaded image) this option may be very useful.
3696c609719bSwdenk
36976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI:
3698c609719bSwdenk		Define if the flash driver uses extra elements in the
36995653fc33Swdenk		common flash structure for storing flash geometry.
37005653fc33Swdenk
370100b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER
37025653fc33Swdenk		This option also enables the building of the cfi_flash driver
37035653fc33Swdenk		in the drivers directory
370453cf9435Sstroese
370591809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD
370691809ed5SPiotr Ziecik		This option enables the building of the cfi_mtd driver
370791809ed5SPiotr Ziecik		in the drivers directory. The driver exports CFI flash
370891809ed5SPiotr Ziecik		to the MTD layer.
370991809ed5SPiotr Ziecik
37106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
371196ef831fSGuennadi Liakhovetski		Use buffered writes to flash.
371296ef831fSGuennadi Liakhovetski
371396ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N
371496ef831fSGuennadi Liakhovetski		s29ws-n MirrorBit flash has non-standard addresses for buffered
371596ef831fSGuennadi Liakhovetski		write commands.
371696ef831fSGuennadi Liakhovetski
37176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST
37185568e613SStefan Roese		If this option is defined, the common CFI flash doesn't
37195568e613SStefan Roese		print it's warning upon not recognized FLASH banks. This
37205568e613SStefan Roese		is useful, if some of the configured banks are only
37215568e613SStefan Roese		optionally available.
37225568e613SStefan Roese
37239a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS
37249a042e9cSJerry Van Baren		If defined (must be an integer), print out countdown
37259a042e9cSJerry Van Baren		digits and dots.  Recommended value: 45 (9..1) for 80
37269a042e9cSJerry Van Baren		column displays, 15 (3..1) for 40 column displays.
37279a042e9cSJerry Van Baren
3728352ef3f1SStefan Roese- CONFIG_FLASH_VERIFY
3729352ef3f1SStefan Roese		If defined, the content of the flash (destination) is compared
3730352ef3f1SStefan Roese		against the source after the write operation. An error message
3731352ef3f1SStefan Roese		will be printed when the contents are not identical.
3732352ef3f1SStefan Roese		Please note that this option is useless in nearly all cases,
3733352ef3f1SStefan Roese		since such flash programming errors usually are detected earlier
3734352ef3f1SStefan Roese		while unprotecting/erasing/programming. Please only enable
3735352ef3f1SStefan Roese		this option if you really know what you are doing.
3736352ef3f1SStefan Roese
37376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER:
373811ccc33fSMarcel Ziswiler		Defines the number of Ethernet receive buffers. On some
373911ccc33fSMarcel Ziswiler		Ethernet controllers it is recommended to set this value
374053cf9435Sstroese		to 8 or even higher (EEPRO100 or 405 EMAC), since all
374153cf9435Sstroese		buffers can be full shortly after enabling the interface
374211ccc33fSMarcel Ziswiler		on high Ethernet traffic.
374353cf9435Sstroese		Defaults to 4 if not defined.
3744c609719bSwdenk
3745ea882bafSWolfgang Denk- CONFIG_ENV_MAX_ENTRIES
3746ea882bafSWolfgang Denk
3747ea882bafSWolfgang Denk	Maximum number of entries in the hash table that is used
3748ea882bafSWolfgang Denk	internally to store the environment settings. The default
3749ea882bafSWolfgang Denk	setting is supposed to be generous and should work in most
3750ea882bafSWolfgang Denk	cases. This setting can be used to tune behaviour; see
3751ea882bafSWolfgang Denk	lib/hashtable.c for details.
3752ea882bafSWolfgang Denk
37532598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_DEFAULT
37542598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_STATIC
37551bce2aebSRobert P. J. Day	Enable validation of the values given to environment variables when
37562598090bSJoe Hershberger	calling env set.  Variables can be restricted to only decimal,
37572598090bSJoe Hershberger	hexadecimal, or boolean.  If CONFIG_CMD_NET is also defined,
37582598090bSJoe Hershberger	the variables can also be restricted to IP address or MAC address.
37592598090bSJoe Hershberger
37602598090bSJoe Hershberger	The format of the list is:
37612598090bSJoe Hershberger		type_attribute = [s|d|x|b|i|m]
3762267541f7SJoe Hershberger		access_atribute = [a|r|o|c]
3763267541f7SJoe Hershberger		attributes = type_attribute[access_atribute]
37642598090bSJoe Hershberger		entry = variable_name[:attributes]
37652598090bSJoe Hershberger		list = entry[,list]
37662598090bSJoe Hershberger
37672598090bSJoe Hershberger	The type attributes are:
37682598090bSJoe Hershberger		s - String (default)
37692598090bSJoe Hershberger		d - Decimal
37702598090bSJoe Hershberger		x - Hexadecimal
37712598090bSJoe Hershberger		b - Boolean ([1yYtT|0nNfF])
37722598090bSJoe Hershberger		i - IP address
37732598090bSJoe Hershberger		m - MAC address
37742598090bSJoe Hershberger
3775267541f7SJoe Hershberger	The access attributes are:
3776267541f7SJoe Hershberger		a - Any (default)
3777267541f7SJoe Hershberger		r - Read-only
3778267541f7SJoe Hershberger		o - Write-once
3779267541f7SJoe Hershberger		c - Change-default
3780267541f7SJoe Hershberger
37812598090bSJoe Hershberger	- CONFIG_ENV_FLAGS_LIST_DEFAULT
37822598090bSJoe Hershberger		Define this to a list (string) to define the ".flags"
37832598090bSJoe Hershberger		envirnoment variable in the default or embedded environment.
37842598090bSJoe Hershberger
37852598090bSJoe Hershberger	- CONFIG_ENV_FLAGS_LIST_STATIC
37862598090bSJoe Hershberger		Define this to a list (string) to define validation that
37872598090bSJoe Hershberger		should be done if an entry is not found in the ".flags"
37882598090bSJoe Hershberger		environment variable.  To override a setting in the static
37892598090bSJoe Hershberger		list, simply add an entry for the same variable name to the
37902598090bSJoe Hershberger		".flags" variable.
37912598090bSJoe Hershberger
3792267541f7SJoe Hershberger- CONFIG_ENV_ACCESS_IGNORE_FORCE
3793267541f7SJoe Hershberger	If defined, don't allow the -f switch to env set override variable
3794267541f7SJoe Hershberger	access flags.
3795267541f7SJoe Hershberger
37965c1a7ea6SSimon Glass- CONFIG_SYS_GENERIC_BOARD
37975c1a7ea6SSimon Glass	This selects the architecture-generic board system instead of the
37985c1a7ea6SSimon Glass	architecture-specific board files. It is intended to move boards
37995c1a7ea6SSimon Glass	to this new framework over time. Defining this will disable the
38005c1a7ea6SSimon Glass	arch/foo/lib/board.c file and use common/board_f.c and
38015c1a7ea6SSimon Glass	common/board_r.c instead. To use this option your architecture
38025c1a7ea6SSimon Glass	must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in
38035c1a7ea6SSimon Glass	its config.mk file). If you find problems enabling this option on
38045c1a7ea6SSimon Glass	your board please report the problem and send patches!
38055c1a7ea6SSimon Glass
38060b1b60c7SLokesh Vutla- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
38070b1b60c7SLokesh Vutla	This is set by OMAP boards for the max time that reset should
38080b1b60c7SLokesh Vutla	be asserted. See doc/README.omap-reset-time for details on how
38090b1b60c7SLokesh Vutla	the value can be calulated on a given board.
3810632efa74SSimon Glass
3811c609719bSwdenkThe following definitions that deal with the placement and management
3812c609719bSwdenkof environment data (variable area); in general, we support the
3813c609719bSwdenkfollowing configurations:
3814c609719bSwdenk
3815c3eb3fe4SMike Frysinger- CONFIG_BUILD_ENVCRC:
3816c3eb3fe4SMike Frysinger
3817c3eb3fe4SMike Frysinger	Builds up envcrc with the target environment so that external utils
3818c3eb3fe4SMike Frysinger	may easily extract it and embed it in final U-Boot images.
3819c3eb3fe4SMike Frysinger
38205a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH:
3821c609719bSwdenk
3822c609719bSwdenk	Define this if the environment is in flash memory.
3823c609719bSwdenk
3824c609719bSwdenk	a) The environment occupies one whole flash sector, which is
3825c609719bSwdenk	   "embedded" in the text segment with the U-Boot code. This
3826c609719bSwdenk	   happens usually with "bottom boot sector" or "top boot
3827c609719bSwdenk	   sector" type flash chips, which have several smaller
3828c609719bSwdenk	   sectors at the start or the end. For instance, such a
3829c609719bSwdenk	   layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3830c609719bSwdenk	   such a case you would place the environment in one of the
3831c609719bSwdenk	   4 kB sectors - with U-Boot code before and after it. With
3832c609719bSwdenk	   "top boot sector" type flash chips, you would put the
3833c609719bSwdenk	   environment in one of the last sectors, leaving a gap
3834c609719bSwdenk	   between U-Boot and the environment.
3835c609719bSwdenk
38360e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
3837c609719bSwdenk
3838c609719bSwdenk	   Offset of environment data (variable area) to the
3839c609719bSwdenk	   beginning of flash memory; for instance, with bottom boot
3840c609719bSwdenk	   type flash chips the second sector can be used: the offset
3841c609719bSwdenk	   for this sector is given here.
3842c609719bSwdenk
38436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
3844c609719bSwdenk
38450e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
3846c609719bSwdenk
3847c609719bSwdenk	   This is just another way to specify the start address of
3848c609719bSwdenk	   the flash sector containing the environment (instead of
38490e8d1586SJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET).
3850c609719bSwdenk
38510e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SECT_SIZE:
3852c609719bSwdenk
3853c609719bSwdenk	   Size of the sector containing the environment.
3854c609719bSwdenk
3855c609719bSwdenk
3856c609719bSwdenk	b) Sometimes flash chips have few, equal sized, BIG sectors.
3857c609719bSwdenk	   In such a case you don't want to spend a whole sector for
3858c609719bSwdenk	   the environment.
3859c609719bSwdenk
38600e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3861c609719bSwdenk
38625a1aceb0SJean-Christophe PLAGNIOL-VILLARD	   If you use this in combination with CONFIG_ENV_IS_IN_FLASH
38630e8d1586SJean-Christophe PLAGNIOL-VILLARD	   and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
3864c609719bSwdenk	   of this flash sector for the environment. This saves
3865c609719bSwdenk	   memory for the RAM copy of the environment.
3866c609719bSwdenk
3867c609719bSwdenk	   It may also save flash memory if you decide to use this
3868c609719bSwdenk	   when your environment is "embedded" within U-Boot code,
3869c609719bSwdenk	   since then the remainder of the flash sector could be used
3870c609719bSwdenk	   for U-Boot code. It should be pointed out that this is
3871c609719bSwdenk	   STRONGLY DISCOURAGED from a robustness point of view:
3872c609719bSwdenk	   updating the environment in flash makes it always
3873c609719bSwdenk	   necessary to erase the WHOLE sector. If something goes
3874c609719bSwdenk	   wrong before the contents has been restored from a copy in
3875c609719bSwdenk	   RAM, your target system will be dead.
3876c609719bSwdenk
38770e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR_REDUND
38780e8d1586SJean-Christophe PLAGNIOL-VILLARD	  CONFIG_ENV_SIZE_REDUND
3879c609719bSwdenk
3880c609719bSwdenk	   These settings describe a second storage area used to hold
388111ccc33fSMarcel Ziswiler	   a redundant copy of the environment data, so that there is
38823e38691eSwdenk	   a valid backup copy in case there is a power failure during
3883c609719bSwdenk	   a "saveenv" operation.
3884c609719bSwdenk
3885c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the
3886c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds*
3887c609719bSwdenkaccordingly!
3888c609719bSwdenk
3889c609719bSwdenk
38909314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM:
3891c609719bSwdenk
3892c609719bSwdenk	Define this if you have some non-volatile memory device
3893c609719bSwdenk	(NVRAM, battery buffered SRAM) which you want to use for the
3894c609719bSwdenk	environment.
3895c609719bSwdenk
38960e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
38970e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3898c609719bSwdenk
389911ccc33fSMarcel Ziswiler	  These two #defines are used to determine the memory area you
3900c609719bSwdenk	  want to use for environment. It is assumed that this memory
3901c609719bSwdenk	  can just be read and written to, without any special
3902c609719bSwdenk	  provision.
3903c609719bSwdenk
3904c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early
3905c609719bSwdenkin U-Boot initalization (when we try to get the setting of for the
390611ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or
3907c609719bSwdenkU-Boot will hang.
3908c609719bSwdenk
3909c609719bSwdenkPlease note that even with NVRAM we still use a copy of the
3910c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to
3911c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv"
3912c609719bSwdenkto save the current settings.
3913c609719bSwdenk
3914c609719bSwdenk
3915bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM:
3916c609719bSwdenk
3917c609719bSwdenk	Use this if you have an EEPROM or similar serial access
3918c609719bSwdenk	device and a driver for it.
3919c609719bSwdenk
39200e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
39210e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3922c609719bSwdenk
3923c609719bSwdenk	  These two #defines specify the offset and size of the
3924c609719bSwdenk	  environment area within the total memory of your EEPROM.
3925c609719bSwdenk
39266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR:
3927c609719bSwdenk	  If defined, specified the chip address of the EEPROM device.
3928c609719bSwdenk	  The default address is zero.
3929c609719bSwdenk
39306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
3931c609719bSwdenk	  If defined, the number of bits used to address bytes in a
3932c609719bSwdenk	  single page in the EEPROM device.  A 64 byte page, for example
3933c609719bSwdenk	  would require six bits.
3934c609719bSwdenk
39356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
3936c609719bSwdenk	  If defined, the number of milliseconds to delay between
3937c609719bSwdenk	  page writes.	The default is zero milliseconds.
3938c609719bSwdenk
39396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
3940c609719bSwdenk	  The length in bytes of the EEPROM memory array address.  Note
3941c609719bSwdenk	  that this is NOT the chip address length!
3942c609719bSwdenk
39436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
39445cf91d6bSwdenk	  EEPROM chips that implement "address overflow" are ones
39455cf91d6bSwdenk	  like Catalyst 24WC04/08/16 which has 9/10/11 bits of
39465cf91d6bSwdenk	  address and the extra bits end up in the "chip address" bit
39475cf91d6bSwdenk	  slots. This makes a 24WC08 (1Kbyte) chip look like four 256
39485cf91d6bSwdenk	  byte chips.
39495cf91d6bSwdenk
39505cf91d6bSwdenk	  Note that we consider the length of the address field to
39515cf91d6bSwdenk	  still be one byte because the extra address bits are hidden
39525cf91d6bSwdenk	  in the chip address.
39535cf91d6bSwdenk
39546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_SIZE:
3955c609719bSwdenk	  The size in bytes of the EEPROM device.
3956c609719bSwdenk
3957548738b4SHeiko Schocher	- CONFIG_ENV_EEPROM_IS_ON_I2C
3958548738b4SHeiko Schocher	  define this, if you have I2C and SPI activated, and your
3959548738b4SHeiko Schocher	  EEPROM, which holds the environment, is on the I2C bus.
3960548738b4SHeiko Schocher
3961548738b4SHeiko Schocher	- CONFIG_I2C_ENV_EEPROM_BUS
3962548738b4SHeiko Schocher	  if you have an Environment on an EEPROM reached over
3963548738b4SHeiko Schocher	  I2C muxes, you can define here, how to reach this
3964548738b4SHeiko Schocher	  EEPROM. For example:
3965548738b4SHeiko Schocher
3966ea818dbbSHeiko Schocher	  #define CONFIG_I2C_ENV_EEPROM_BUS	  1
3967548738b4SHeiko Schocher
3968548738b4SHeiko Schocher	  EEPROM which holds the environment, is reached over
3969548738b4SHeiko Schocher	  a pca9547 i2c mux with address 0x70, channel 3.
3970c609719bSwdenk
3971057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH:
39725779d8d9Swdenk
39735779d8d9Swdenk	Define this if you have a DataFlash memory device which you
39745779d8d9Swdenk	want to use for the environment.
39755779d8d9Swdenk
39760e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
39770e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
39780e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
39795779d8d9Swdenk
39805779d8d9Swdenk	  These three #defines specify the offset and size of the
39815779d8d9Swdenk	  environment area within the total memory of your DataFlash placed
39825779d8d9Swdenk	  at the specified address.
39835779d8d9Swdenk
39840a85a9e7SLiu Gang- CONFIG_ENV_IS_IN_REMOTE:
39850a85a9e7SLiu Gang
39860a85a9e7SLiu Gang	Define this if you have a remote memory space which you
39870a85a9e7SLiu Gang	want to use for the local device's environment.
39880a85a9e7SLiu Gang
39890a85a9e7SLiu Gang	- CONFIG_ENV_ADDR:
39900a85a9e7SLiu Gang	- CONFIG_ENV_SIZE:
39910a85a9e7SLiu Gang
39920a85a9e7SLiu Gang	  These two #defines specify the address and size of the
39930a85a9e7SLiu Gang	  environment area within the remote memory space. The
39940a85a9e7SLiu Gang	  local device can get the environment from remote memory
3995fc54c7faSLiu Gang	  space by SRIO or PCIE links.
39960a85a9e7SLiu Gang
39970a85a9e7SLiu GangBE CAREFUL! For some special cases, the local device can not use
39980a85a9e7SLiu Gang"saveenv" command. For example, the local device will get the
3999fc54c7faSLiu Gangenvironment stored in a remote NOR flash by SRIO or PCIE link,
4000fc54c7faSLiu Gangbut it can not erase, write this NOR flash by SRIO or PCIE interface.
40010a85a9e7SLiu Gang
400251bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND:
400313a5695bSwdenk
400413a5695bSwdenk	Define this if you have a NAND device which you want to use
400513a5695bSwdenk	for the environment.
400613a5695bSwdenk
40070e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
40080e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
400913a5695bSwdenk
401013a5695bSwdenk	  These two #defines specify the offset and size of the environment
4011fdd813deSScott Wood	  area within the first NAND device.  CONFIG_ENV_OFFSET must be
4012fdd813deSScott Wood	  aligned to an erase block boundary.
40135779d8d9Swdenk
4014fdd813deSScott Wood	- CONFIG_ENV_OFFSET_REDUND (optional):
4015e443c944SMarkus Klotzbuecher
40160e8d1586SJean-Christophe PLAGNIOL-VILLARD	  This setting describes a second storage area of CONFIG_ENV_SIZE
4017fdd813deSScott Wood	  size used to hold a redundant copy of the environment data, so
4018fdd813deSScott Wood	  that there is a valid backup copy in case there is a power failure
4019fdd813deSScott Wood	  during a "saveenv" operation.	 CONFIG_ENV_OFFSET_RENDUND must be
4020fdd813deSScott Wood	  aligned to an erase block boundary.
4021e443c944SMarkus Klotzbuecher
4022fdd813deSScott Wood	- CONFIG_ENV_RANGE (optional):
4023fdd813deSScott Wood
4024fdd813deSScott Wood	  Specifies the length of the region in which the environment
4025fdd813deSScott Wood	  can be written.  This should be a multiple of the NAND device's
4026fdd813deSScott Wood	  block size.  Specifying a range with more erase blocks than
4027fdd813deSScott Wood	  are needed to hold CONFIG_ENV_SIZE allows bad blocks within
4028fdd813deSScott Wood	  the range to be avoided.
4029fdd813deSScott Wood
4030fdd813deSScott Wood	- CONFIG_ENV_OFFSET_OOB (optional):
4031fdd813deSScott Wood
4032fdd813deSScott Wood	  Enables support for dynamically retrieving the offset of the
4033fdd813deSScott Wood	  environment from block zero's out-of-band data.  The
4034fdd813deSScott Wood	  "nand env.oob" command can be used to record this offset.
4035fdd813deSScott Wood	  Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
4036fdd813deSScott Wood	  using CONFIG_ENV_OFFSET_OOB.
4037e443c944SMarkus Klotzbuecher
4038b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST
4039b74ab737SGuennadi Liakhovetski
4040b74ab737SGuennadi Liakhovetski	Defines address in RAM to which the nand_spl code should copy the
4041b74ab737SGuennadi Liakhovetski	environment. If redundant environment is used, it will be copied to
4042b74ab737SGuennadi Liakhovetski	CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
4043b74ab737SGuennadi Liakhovetski
40442b74433fSJoe Hershberger- CONFIG_ENV_IS_IN_UBI:
40452b74433fSJoe Hershberger
40462b74433fSJoe Hershberger	Define this if you have an UBI volume that you want to use for the
40472b74433fSJoe Hershberger	environment.  This has the benefit of wear-leveling the environment
40482b74433fSJoe Hershberger	accesses, which is important on NAND.
40492b74433fSJoe Hershberger
40502b74433fSJoe Hershberger	- CONFIG_ENV_UBI_PART:
40512b74433fSJoe Hershberger
40522b74433fSJoe Hershberger	  Define this to a string that is the mtd partition containing the UBI.
40532b74433fSJoe Hershberger
40542b74433fSJoe Hershberger	- CONFIG_ENV_UBI_VOLUME:
40552b74433fSJoe Hershberger
40562b74433fSJoe Hershberger	  Define this to the name of the volume that you want to store the
40572b74433fSJoe Hershberger	  environment in.
40582b74433fSJoe Hershberger
4059785881f7SJoe Hershberger	- CONFIG_ENV_UBI_VOLUME_REDUND:
4060785881f7SJoe Hershberger
4061785881f7SJoe Hershberger	  Define this to the name of another volume to store a second copy of
4062785881f7SJoe Hershberger	  the environment in.  This will enable redundant environments in UBI.
4063785881f7SJoe Hershberger	  It is assumed that both volumes are in the same MTD partition.
4064785881f7SJoe Hershberger
40652b74433fSJoe Hershberger	- CONFIG_UBI_SILENCE_MSG
40662b74433fSJoe Hershberger	- CONFIG_UBIFS_SILENCE_MSG
40672b74433fSJoe Hershberger
40682b74433fSJoe Hershberger	  You will probably want to define these to avoid a really noisy system
40692b74433fSJoe Hershberger	  when storing the env in UBI.
40702b74433fSJoe Hershberger
407106e4ae5fSStephen Warren- CONFIG_ENV_IS_IN_MMC:
407206e4ae5fSStephen Warren
407306e4ae5fSStephen Warren	Define this if you have an MMC device which you want to use for the
407406e4ae5fSStephen Warren	environment.
407506e4ae5fSStephen Warren
407606e4ae5fSStephen Warren	- CONFIG_SYS_MMC_ENV_DEV:
407706e4ae5fSStephen Warren
407806e4ae5fSStephen Warren	  Specifies which MMC device the environment is stored in.
407906e4ae5fSStephen Warren
408006e4ae5fSStephen Warren	- CONFIG_SYS_MMC_ENV_PART (optional):
408106e4ae5fSStephen Warren
408206e4ae5fSStephen Warren	  Specifies which MMC partition the environment is stored in. If not
408306e4ae5fSStephen Warren	  set, defaults to partition 0, the user area. Common values might be
408406e4ae5fSStephen Warren	  1 (first MMC boot partition), 2 (second MMC boot partition).
408506e4ae5fSStephen Warren
408606e4ae5fSStephen Warren	- CONFIG_ENV_OFFSET:
408706e4ae5fSStephen Warren	- CONFIG_ENV_SIZE:
408806e4ae5fSStephen Warren
408906e4ae5fSStephen Warren	  These two #defines specify the offset and size of the environment
409006e4ae5fSStephen Warren	  area within the specified MMC device.
409106e4ae5fSStephen Warren
40925c088ee8SStephen Warren	  If offset is positive (the usual case), it is treated as relative to
40935c088ee8SStephen Warren	  the start of the MMC partition. If offset is negative, it is treated
40945c088ee8SStephen Warren	  as relative to the end of the MMC partition. This can be useful if
40955c088ee8SStephen Warren	  your board may be fitted with different MMC devices, which have
40965c088ee8SStephen Warren	  different sizes for the MMC partitions, and you always want the
40975c088ee8SStephen Warren	  environment placed at the very end of the partition, to leave the
40985c088ee8SStephen Warren	  maximum possible space before it, to store other data.
40995c088ee8SStephen Warren
410006e4ae5fSStephen Warren	  These two values are in units of bytes, but must be aligned to an
410106e4ae5fSStephen Warren	  MMC sector boundary.
410206e4ae5fSStephen Warren
410306e4ae5fSStephen Warren	- CONFIG_ENV_OFFSET_REDUND (optional):
410406e4ae5fSStephen Warren
410506e4ae5fSStephen Warren	  Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
410606e4ae5fSStephen Warren	  hold a redundant copy of the environment data. This provides a
410706e4ae5fSStephen Warren	  valid backup copy in case the other copy is corrupted, e.g. due
410806e4ae5fSStephen Warren	  to a power failure during a "saveenv" operation.
410906e4ae5fSStephen Warren
41105c088ee8SStephen Warren	  This value may also be positive or negative; this is handled in the
41115c088ee8SStephen Warren	  same way as CONFIG_ENV_OFFSET.
41125c088ee8SStephen Warren
411306e4ae5fSStephen Warren	  This value is also in units of bytes, but must also be aligned to
411406e4ae5fSStephen Warren	  an MMC sector boundary.
411506e4ae5fSStephen Warren
411606e4ae5fSStephen Warren	- CONFIG_ENV_SIZE_REDUND (optional):
411706e4ae5fSStephen Warren
411806e4ae5fSStephen Warren	  This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
411906e4ae5fSStephen Warren	  set. If this value is set, it must be set to the same value as
412006e4ae5fSStephen Warren	  CONFIG_ENV_SIZE.
412106e4ae5fSStephen Warren
41226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET
4123c609719bSwdenk
4124c609719bSwdenk	Defines offset to the initial SPI buffer area in DPRAM. The
4125c609719bSwdenk	area is used at an early stage (ROM part) if the environment
4126c609719bSwdenk	is configured to reside in the SPI EEPROM: We need a 520 byte
4127c609719bSwdenk	scratch DPRAM area. It is used between the two initialization
4128c609719bSwdenk	calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4129c609719bSwdenk	to be a good choice since it makes it far enough from the
4130c609719bSwdenk	start of the data area as well as from the stack pointer.
4131c609719bSwdenk
4132e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor
4133c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been
4134cdb74977SWolfgang Denkcreated; also, when using EEPROM you will have to use getenv_f()
4135c609719bSwdenkuntil then to read environment variables.
4136c609719bSwdenk
413785ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor
413885ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working
413985ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is
414085ec0bccSwdenknecessary, because the first environment variable we need is the
414185ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't
414285ec0bccSwdenkhave any device yet where we could complain.]
4143c609719bSwdenk
4144c609719bSwdenkNote: once the monitor has been relocated, then it will complain if
4145c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you
414685ec0bccSwdenkuse the "saveenv" command to store a valid environment.
4147c609719bSwdenk
41486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
4149fc3e2165Swdenk		Echo the inverted Ethernet link state to the fault LED.
4150fc3e2165Swdenk
41516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
4152fc3e2165Swdenk		      also needs to be defined.
4153fc3e2165Swdenk
41546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR:
4155fc3e2165Swdenk		MII address of the PHY to check for the Ethernet link state.
4156c609719bSwdenk
4157f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS:
4158f5675aa5SRon Madrid		Define this if you desire to only have use of the NS16550_init
4159f5675aa5SRon Madrid		and NS16550_putc functions for the serial driver located at
4160f5675aa5SRon Madrid		drivers/serial/ns16550.c.  This option is useful for saving
4161f5675aa5SRon Madrid		space for already greatly restricted images, including but not
4162f5675aa5SRon Madrid		limited to NAND_SPL configurations.
4163f5675aa5SRon Madrid
4164b2b92f53SSimon Glass- CONFIG_DISPLAY_BOARDINFO
4165b2b92f53SSimon Glass		Display information about the board that U-Boot is running on
4166b2b92f53SSimon Glass		when U-Boot starts up. The board function checkboard() is called
4167b2b92f53SSimon Glass		to do this.
4168b2b92f53SSimon Glass
4169e2e3e2b1SSimon Glass- CONFIG_DISPLAY_BOARDINFO_LATE
4170e2e3e2b1SSimon Glass		Similar to the previous option, but display this information
4171e2e3e2b1SSimon Glass		later, once stdio is running and output goes to the LCD, if
4172e2e3e2b1SSimon Glass		present.
4173e2e3e2b1SSimon Glass
4174c609719bSwdenkLow Level (hardware related) configuration options:
4175dc7c9a1aSwdenk---------------------------------------------------
4176c609719bSwdenk
41776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE:
4178c609719bSwdenk		Cache Line Size of the CPU.
4179c609719bSwdenk
41806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR:
4181c609719bSwdenk		Default address of the IMMR after system reset.
41822535d602Swdenk
41832535d602Swdenk		Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
41842535d602Swdenk		and RPXsuper) to be able to adjust the position of
41852535d602Swdenk		the IMMR register after a reset.
4186c609719bSwdenk
4187e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_DEFAULT:
4188e46fedfeSTimur Tabi		Default (power-on reset) physical address of CCSR on Freescale
4189e46fedfeSTimur Tabi		PowerPC SOCs.
4190e46fedfeSTimur Tabi
4191e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR:
4192e46fedfeSTimur Tabi		Virtual address of CCSR.  On a 32-bit build, this is typically
4193e46fedfeSTimur Tabi		the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4194e46fedfeSTimur Tabi
4195e46fedfeSTimur Tabi		CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4196e46fedfeSTimur Tabi		for cross-platform code that uses that macro instead.
4197e46fedfeSTimur Tabi
4198e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS:
4199e46fedfeSTimur Tabi		Physical address of CCSR.  CCSR can be relocated to a new
4200e46fedfeSTimur Tabi		physical address, if desired.  In this case, this macro should
4201e46fedfeSTimur Tabi		be set to that address.	 Otherwise, it should be set to the
4202e46fedfeSTimur Tabi		same value as CONFIG_SYS_CCSRBAR_DEFAULT.  For example, CCSR
4203e46fedfeSTimur Tabi		is typically relocated on 36-bit builds.  It is recommended
4204e46fedfeSTimur Tabi		that this macro be defined via the _HIGH and _LOW macros:
4205e46fedfeSTimur Tabi
4206e46fedfeSTimur Tabi		#define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4207e46fedfeSTimur Tabi			* 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4208e46fedfeSTimur Tabi
4209e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
4210e46fedfeSTimur Tabi		Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS.	This value is typically
4211e46fedfeSTimur Tabi		either 0 (32-bit build) or 0xF (36-bit build).	This macro is
4212e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
4213e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
4214e46fedfeSTimur Tabi
4215e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4216e46fedfeSTimur Tabi		Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS.  This macro is
4217e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
4218e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
4219e46fedfeSTimur Tabi
4220e46fedfeSTimur Tabi- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4221e46fedfeSTimur Tabi		If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4222e46fedfeSTimur Tabi		forced to a value that ensures that CCSR is not relocated.
4223e46fedfeSTimur Tabi
42247f6c2cbcSwdenk- Floppy Disk Support:
42256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER
42267f6c2cbcSwdenk
42277f6c2cbcSwdenk		the default drive number (default value 0)
42287f6c2cbcSwdenk
42296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_STRIDE
42307f6c2cbcSwdenk
423111ccc33fSMarcel Ziswiler		defines the spacing between FDC chipset registers
42327f6c2cbcSwdenk		(default value 1)
42337f6c2cbcSwdenk
42346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_OFFSET
42357f6c2cbcSwdenk
42367f6c2cbcSwdenk		defines the offset of register from address. It
42377f6c2cbcSwdenk		depends on which part of the data bus is connected to
423811ccc33fSMarcel Ziswiler		the FDC chipset. (default value 0)
42397f6c2cbcSwdenk
42406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
42416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
42427f6c2cbcSwdenk		default value.
42437f6c2cbcSwdenk
42446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		if CONFIG_SYS_FDC_HW_INIT is defined, then the function
42457f6c2cbcSwdenk		fdc_hw_init() is called at the beginning of the FDC
42467f6c2cbcSwdenk		setup. fdc_hw_init() must be provided by the board
42477f6c2cbcSwdenk		source code. It is used to make hardware dependant
42487f6c2cbcSwdenk		initializations.
42497f6c2cbcSwdenk
42500abddf82SMacpaul Lin- CONFIG_IDE_AHB:
42510abddf82SMacpaul Lin		Most IDE controllers were designed to be connected with PCI
42520abddf82SMacpaul Lin		interface. Only few of them were designed for AHB interface.
42530abddf82SMacpaul Lin		When software is doing ATA command and data transfer to
42540abddf82SMacpaul Lin		IDE devices through IDE-AHB controller, some additional
42550abddf82SMacpaul Lin		registers accessing to these kind of IDE-AHB controller
42560abddf82SMacpaul Lin		is requierd.
42570abddf82SMacpaul Lin
42586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR:	Physical address of the Internal Memory.
425925d6712aSwdenk		DO NOT CHANGE unless you know exactly what you're
426025d6712aSwdenk		doing! (11-4) [MPC8xx/82xx systems only]
4261c609719bSwdenk
42626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR:
4263c609719bSwdenk
42647152b1d0Swdenk		Start address of memory area that can be used for
4265c609719bSwdenk		initial data and stack; please note that this must be
4266c609719bSwdenk		writable memory that is working WITHOUT special
4267c609719bSwdenk		initialization, i. e. you CANNOT use normal RAM which
4268c609719bSwdenk		will become available only after programming the
4269c609719bSwdenk		memory controller and running certain initialization
4270c609719bSwdenk		sequences.
4271c609719bSwdenk
4272c609719bSwdenk		U-Boot uses the following memory types:
4273c609719bSwdenk		- MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4274c609719bSwdenk		- MPC824X: data cache
4275c609719bSwdenk		- PPC4xx:  data cache
4276c609719bSwdenk
42776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET:
4278c609719bSwdenk
4279c609719bSwdenk		Offset of the initial data structure in the memory
42806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
42816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
4282c609719bSwdenk		data is located at the end of the available space
4283553f0982SWolfgang Denk		(sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
42846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
42856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
42866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET) downward.
4287c609719bSwdenk
4288c609719bSwdenk	Note:
4289c609719bSwdenk		On the MPC824X (or other systems that use the data
4290c609719bSwdenk		cache for initial memory) the address chosen for
42916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
4292c609719bSwdenk		point to an otherwise UNUSED address space between
4293c609719bSwdenk		the top of RAM and the start of the PCI space.
4294c609719bSwdenk
42956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR:	SIU Module Configuration (11-6)
4296c609719bSwdenk
42976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR:	System Protection Control (11-9)
4298c609719bSwdenk
42996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR:	Time Base Status and Control (11-26)
4300c609719bSwdenk
43016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR:	Periodic Interrupt Status and Control (11-31)
4302c609719bSwdenk
43036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR:	PLL, Low-Power, and Reset Control Register (15-30)
4304c609719bSwdenk
43056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR:	System Clock and reset Control Register (15-27)
4306c609719bSwdenk
43076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM:
4308c609719bSwdenk		SDRAM timing
4309c609719bSwdenk
43106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA:
4311c609719bSwdenk		periodic timer for refresh
4312c609719bSwdenk
43136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER:	Debug Event Register (37-47)
4314c609719bSwdenk
43156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
43166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
43176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
43186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_BR1_PRELIM:
4319c609719bSwdenk		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4320c609719bSwdenk
4321c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
43226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
43236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
4324c609719bSwdenk		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4325c609719bSwdenk
43266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
43276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
4328c609719bSwdenk		Machine Mode Register and Memory Periodic Timer
4329c609719bSwdenk		Prescaler definitions (SDRAM timing)
4330c609719bSwdenk
43316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
4332c609719bSwdenk		enable I2C microcode relocation patch (MPC8xx);
4333c609719bSwdenk		define relocation offset in DPRAM [DSP2]
4334c609719bSwdenk
43356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
4336b423d055SHeiko Schocher		enable SMC microcode relocation patch (MPC8xx);
4337b423d055SHeiko Schocher		define relocation offset in DPRAM [SMC1]
4338b423d055SHeiko Schocher
43396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
4340c609719bSwdenk		enable SPI microcode relocation patch (MPC8xx);
4341c609719bSwdenk		define relocation offset in DPRAM [SCC4]
4342c609719bSwdenk
43436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_USE_OSCCLK:
4344c609719bSwdenk		Use OSCM clock mode on MBX8xx board. Be careful,
4345c609719bSwdenk		wrong setting might damage your board. Read
4346c609719bSwdenk		doc/README.MBX before setting this variable!
4347c609719bSwdenk
43486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
4349ea909b76Swdenk		Offset of the bootmode word in DPRAM used by post
4350ea909b76Swdenk		(Power On Self Tests). This definition overrides
4351ea909b76Swdenk		#define'd default value in commproc.h resp.
4352ea909b76Swdenk		cpm_8260.h.
4353ea909b76Swdenk
43546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
43556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
43566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
43576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
43586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
43596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
43606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
43616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
4362a47a12beSStefan Roese		Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
43635d232d0eSwdenk
43649cacf4fcSDirk Eibach- CONFIG_PCI_DISABLE_PCIE:
43659cacf4fcSDirk Eibach		Disable PCI-Express on systems where it is supported but not
43669cacf4fcSDirk Eibach		required.
43679cacf4fcSDirk Eibach
436869fd2d3bSAndrew Sharp- CONFIG_PCI_ENUM_ONLY
436969fd2d3bSAndrew Sharp		Only scan through and get the devices on the busses.
437069fd2d3bSAndrew Sharp		Don't do any setup work, presumably because someone or
437169fd2d3bSAndrew Sharp		something has already done it, and we don't need to do it
437269fd2d3bSAndrew Sharp		a second time.	Useful for platforms that are pre-booted
437369fd2d3bSAndrew Sharp		by coreboot or similar.
437469fd2d3bSAndrew Sharp
4375842033e6SGabor Juhos- CONFIG_PCI_INDIRECT_BRIDGE:
4376842033e6SGabor Juhos		Enable support for indirect PCI bridges.
4377842033e6SGabor Juhos
4378a09b9b68SKumar Gala- CONFIG_SYS_SRIO:
4379a09b9b68SKumar Gala		Chip has SRIO or not
4380a09b9b68SKumar Gala
4381a09b9b68SKumar Gala- CONFIG_SRIO1:
4382a09b9b68SKumar Gala		Board has SRIO 1 port available
4383a09b9b68SKumar Gala
4384a09b9b68SKumar Gala- CONFIG_SRIO2:
4385a09b9b68SKumar Gala		Board has SRIO 2 port available
4386a09b9b68SKumar Gala
4387c8b28152SLiu Gang- CONFIG_SRIO_PCIE_BOOT_MASTER
4388c8b28152SLiu Gang		Board can support master function for Boot from SRIO and PCIE
4389c8b28152SLiu Gang
4390a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_VIRT:
4391a09b9b68SKumar Gala		Virtual Address of SRIO port 'n' memory region
4392a09b9b68SKumar Gala
4393a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_PHYS:
4394a09b9b68SKumar Gala		Physical Address of SRIO port 'n' memory region
4395a09b9b68SKumar Gala
4396a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_SIZE:
4397a09b9b68SKumar Gala		Size of SRIO port 'n' memory region
4398a09b9b68SKumar Gala
439966bd1846SFabio Estevam- CONFIG_SYS_NAND_BUSWIDTH_16BIT
440066bd1846SFabio Estevam		Defined to tell the NAND controller that the NAND chip is using
440166bd1846SFabio Estevam		a 16 bit bus.
440266bd1846SFabio Estevam		Not all NAND drivers use this symbol.
4403a430e916SFabio Estevam		Example of drivers that use it:
440466bd1846SFabio Estevam		- drivers/mtd/nand/ndfc.c
4405a430e916SFabio Estevam		- drivers/mtd/nand/mxc_nand.c
4406eced4626SAlex Waterman
4407eced4626SAlex Waterman- CONFIG_SYS_NDFC_EBC0_CFG
4408eced4626SAlex Waterman		Sets the EBC0_CFG register for the NDFC. If not defined
4409eced4626SAlex Waterman		a default value will be used.
4410eced4626SAlex Waterman
4411bb99ad6dSBen Warren- CONFIG_SPD_EEPROM
4412218ca724SWolfgang Denk		Get DDR timing information from an I2C EEPROM. Common
4413218ca724SWolfgang Denk		with pluggable memory modules such as SODIMMs
4414218ca724SWolfgang Denk
4415bb99ad6dSBen Warren  SPD_EEPROM_ADDRESS
4416bb99ad6dSBen Warren		I2C address of the SPD EEPROM
4417bb99ad6dSBen Warren
44186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM
4419218ca724SWolfgang Denk		If SPD EEPROM is on an I2C bus other than the first
4420218ca724SWolfgang Denk		one, specify here. Note that the value must resolve
4421218ca724SWolfgang Denk		to something your driver can deal with.
4422bb99ad6dSBen Warren
44231b3e3c4fSYork Sun- CONFIG_SYS_DDR_RAW_TIMING
44241b3e3c4fSYork Sun		Get DDR timing information from other than SPD. Common with
44251b3e3c4fSYork Sun		soldered DDR chips onboard without SPD. DDR raw timing
44261b3e3c4fSYork Sun		parameters are extracted from datasheet and hard-coded into
44271b3e3c4fSYork Sun		header files or board specific files.
44281b3e3c4fSYork Sun
44296f5e1dc5SYork Sun- CONFIG_FSL_DDR_INTERACTIVE
44306f5e1dc5SYork Sun		Enable interactive DDR debugging. See doc/README.fsl-ddr.
44316f5e1dc5SYork Sun
44326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0
4433218ca724SWolfgang Denk		Only for 83xx systems. If specified, then DDR should
4434218ca724SWolfgang Denk		be configured using CS0 and CS1 instead of CS2 and CS3.
44352ad6b513STimur Tabi
4436c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12]
4437c26e454dSwdenk		Define to enable FEC[12] on a 8xx series processor.
4438c26e454dSwdenk
4439c26e454dSwdenk- CONFIG_FEC[12]_PHY
4440c26e454dSwdenk		Define to the hardcoded PHY address which corresponds
44416e592385Swdenk		to the given FEC; i. e.
4442c26e454dSwdenk			#define CONFIG_FEC1_PHY 4
4443c26e454dSwdenk		means that the PHY with address 4 is connected to FEC1
4444c26e454dSwdenk
4445c26e454dSwdenk		When set to -1, means to probe for first available.
4446c26e454dSwdenk
4447c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR
4448c26e454dSwdenk		The PHY does not have a RXERR line (RMII only).
4449c26e454dSwdenk		(so program the FEC to ignore it).
4450c26e454dSwdenk
4451c26e454dSwdenk- CONFIG_RMII
4452c26e454dSwdenk		Enable RMII mode for all FECs.
4453c26e454dSwdenk		Note that this is a global option, we can't
4454c26e454dSwdenk		have one FEC in standard MII mode and another in RMII mode.
4455c26e454dSwdenk
44565cf91d6bSwdenk- CONFIG_CRC32_VERIFY
44575cf91d6bSwdenk		Add a verify option to the crc32 command.
44585cf91d6bSwdenk		The syntax is:
44595cf91d6bSwdenk
44605cf91d6bSwdenk		=> crc32 -v <address> <count> <crc32>
44615cf91d6bSwdenk
44625cf91d6bSwdenk		Where address/count indicate a memory area
44635cf91d6bSwdenk		and crc32 is the correct crc32 which the
44645cf91d6bSwdenk		area should have.
44655cf91d6bSwdenk
446656523f12Swdenk- CONFIG_LOOPW
446756523f12Swdenk		Add the "loopw" memory command. This only takes effect if
4468602ad3b3SJon Loeliger		the memory commands are activated globally (CONFIG_CMD_MEM).
446956523f12Swdenk
44707b466641Sstroese- CONFIG_MX_CYCLIC
44717b466641Sstroese		Add the "mdc" and "mwc" memory commands. These are cyclic
44727b466641Sstroese		"md/mw" commands.
44737b466641Sstroese		Examples:
44747b466641Sstroese
44757b466641Sstroese		=> mdc.b 10 4 500
44767b466641Sstroese		This command will print 4 bytes (10,11,12,13) each 500 ms.
44777b466641Sstroese
44787b466641Sstroese		=> mwc.l 100 12345678 10
44797b466641Sstroese		This command will write 12345678 to address 100 all 10 ms.
44807b466641Sstroese
44817b466641Sstroese		This only takes effect if the memory commands are activated
4482602ad3b3SJon Loeliger		globally (CONFIG_CMD_MEM).
44837b466641Sstroese
44848aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT
4485afc1ce82SMacpaul Lin		[ARM, NDS32, MIPS only] If this variable is defined, then certain
4486e03f3169SWolfgang Denk		low level initializations (like setting up the memory
4487e03f3169SWolfgang Denk		controller) are omitted and/or U-Boot does not
4488e03f3169SWolfgang Denk		relocate itself into RAM.
44898aa1a2d1Swdenk
4490e03f3169SWolfgang Denk		Normally this variable MUST NOT be defined. The only
4491e03f3169SWolfgang Denk		exception is when U-Boot is loaded (to RAM) by some
4492e03f3169SWolfgang Denk		other boot loader or by a debugger which performs
4493e03f3169SWolfgang Denk		these initializations itself.
44948aa1a2d1Swdenk
4495401bb30bSAneesh V- CONFIG_SPL_BUILD
4496df81238bSMagnus Lilja		Modifies the behaviour of start.S when compiling a loader
4497df81238bSMagnus Lilja		that is executed before the actual U-Boot. E.g. when
4498df81238bSMagnus Lilja		compiling a NAND SPL.
4499400558b5Swdenk
45003aa29de0SYing Zhang- CONFIG_TPL_BUILD
45013aa29de0SYing Zhang		Modifies the behaviour of start.S  when compiling a loader
45023aa29de0SYing Zhang		that is executed after the SPL and before the actual U-Boot.
45033aa29de0SYing Zhang		It is loaded by the SPL.
45043aa29de0SYing Zhang
45055df572f0SYing Zhang- CONFIG_SYS_MPC85XX_NO_RESETVEC
45065df572f0SYing Zhang		Only for 85xx systems. If this variable is specified, the section
45075df572f0SYing Zhang		.resetvec is not kept and the section .bootpg is placed in the
45085df572f0SYing Zhang		previous 4k of the .text section.
45095df572f0SYing Zhang
45104213fc29SSimon Glass- CONFIG_ARCH_MAP_SYSMEM
45114213fc29SSimon Glass		Generally U-Boot (and in particular the md command) uses
45124213fc29SSimon Glass		effective address. It is therefore not necessary to regard
45134213fc29SSimon Glass		U-Boot address as virtual addresses that need to be translated
45144213fc29SSimon Glass		to physical addresses. However, sandbox requires this, since
45154213fc29SSimon Glass		it maintains its own little RAM buffer which contains all
45164213fc29SSimon Glass		addressable memory. This option causes some memory accesses
45174213fc29SSimon Glass		to be mapped through map_sysmem() / unmap_sysmem().
45184213fc29SSimon Glass
4519d8834a13SMatthias Weisser- CONFIG_USE_ARCH_MEMCPY
4520d8834a13SMatthias Weisser  CONFIG_USE_ARCH_MEMSET
4521d8834a13SMatthias Weisser		If these options are used a optimized version of memcpy/memset will
4522d8834a13SMatthias Weisser		be used if available. These functions may be faster under some
4523d8834a13SMatthias Weisser		conditions but may increase the binary size.
4524d8834a13SMatthias Weisser
4525588a13f7SSimon Glass- CONFIG_X86_RESET_VECTOR
4526588a13f7SSimon Glass		If defined, the x86 reset vector code is included. This is not
4527588a13f7SSimon Glass		needed when U-Boot is running from Coreboot.
4528b16f521aSGabe Black
4529fc33705eSMark Jackson- CONFIG_SYS_MPUCLK
4530fc33705eSMark Jackson		Defines the MPU clock speed (in MHz).
4531fc33705eSMark Jackson
4532fc33705eSMark Jackson		NOTE : currently only supported on AM335x platforms.
45335b5ece9eSGabe Black
453416678eb4SHeiko Schocher- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
453516678eb4SHeiko Schocher		Enables the RTC32K OSC on AM33xx based plattforms
453616678eb4SHeiko Schocher
4537f2717b47STimur TabiFreescale QE/FMAN Firmware Support:
4538f2717b47STimur Tabi-----------------------------------
4539f2717b47STimur Tabi
4540f2717b47STimur TabiThe Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4541f2717b47STimur Tabiloading of "firmware", which is encoded in the QE firmware binary format.
4542f2717b47STimur TabiThis firmware often needs to be loaded during U-Boot booting, so macros
4543f2717b47STimur Tabiare used to identify the storage device (NOR flash, SPI, etc) and the address
4544f2717b47STimur Tabiwithin that device.
4545f2717b47STimur Tabi
4546dcf1d774SZhao Qiang- CONFIG_SYS_FMAN_FW_ADDR
4547dcf1d774SZhao Qiang	The address in the storage device where the FMAN microcode is located.  The
4548dcf1d774SZhao Qiang	meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4549dcf1d774SZhao Qiang	is also specified.
4550dcf1d774SZhao Qiang
4551dcf1d774SZhao Qiang- CONFIG_SYS_QE_FW_ADDR
4552dcf1d774SZhao Qiang	The address in the storage device where the QE microcode is located.  The
4553f2717b47STimur Tabi	meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4554f2717b47STimur Tabi	is also specified.
4555f2717b47STimur Tabi
4556f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_LENGTH
4557f2717b47STimur Tabi	The maximum possible size of the firmware.  The firmware binary format
4558f2717b47STimur Tabi	has a field that specifies the actual size of the firmware, but it
4559f2717b47STimur Tabi	might not be possible to read any part of the firmware unless some
4560f2717b47STimur Tabi	local storage is allocated to hold the entire firmware first.
4561f2717b47STimur Tabi
4562f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4563f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4564f2717b47STimur Tabi	normal addressable memory via the LBC.  CONFIG_SYS_FMAN_FW_ADDR is the
4565f2717b47STimur Tabi	virtual address in NOR flash.
4566f2717b47STimur Tabi
4567f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4568f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NAND flash.
4569f2717b47STimur Tabi	CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4570f2717b47STimur Tabi
4571f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4572f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SD/MMC
4573f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4574f2717b47STimur Tabi
4575f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
4576f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SPI
4577f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4578f2717b47STimur Tabi
4579292dc6c5SLiu Gang- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4580292dc6c5SLiu Gang	Specifies that QE/FMAN firmware is located in the remote (master)
4581292dc6c5SLiu Gang	memory space.	CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
4582fc54c7faSLiu Gang	can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4583fc54c7faSLiu Gang	window->master inbound window->master LAW->the ucode address in
4584fc54c7faSLiu Gang	master's memory space.
4585f2717b47STimur Tabi
4586c609719bSwdenkBuilding the Software:
4587c609719bSwdenk======================
4588c609719bSwdenk
4589218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments
4590218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support
4591218ca724SWolfgang Denkall possibly existing versions of cross development tools in all
4592218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we
4593218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4594218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot.
4595c609719bSwdenk
4596218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you
4597218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case,
4598218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell.
4599218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are
4600218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter:
4601c609719bSwdenk
4602218ca724SWolfgang Denk	$ CROSS_COMPILE=ppc_4xx-
4603218ca724SWolfgang Denk	$ export CROSS_COMPILE
4604c609719bSwdenk
46052f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in
46062f8d396bSPeter Tyser      the tools directory you can use the MinGW toolchain
46072f8d396bSPeter Tyser      (http://www.mingw.org).  Set your HOST tools to the MinGW
46082f8d396bSPeter Tyser      toolchain and execute 'make tools'.  For example:
46092f8d396bSPeter Tyser
46102f8d396bSPeter Tyser       $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
46112f8d396bSPeter Tyser
46122f8d396bSPeter Tyser      Binaries such as tools/mkimage.exe will be created which can
46132f8d396bSPeter Tyser      be executed on computers running Windows.
46142f8d396bSPeter Tyser
4615c609719bSwdenkU-Boot is intended to be simple to build. After installing the
4616c609719bSwdenksources you must configure U-Boot for one specific board type. This
4617c609719bSwdenkis done by typing:
4618c609719bSwdenk
4619c609719bSwdenk	make NAME_config
4620c609719bSwdenk
4621218ca724SWolfgang Denkwhere "NAME_config" is the name of one of the existing configu-
46224d675ae6SMichael Jonesrations; see boards.cfg for supported names.
462354387ac9Swdenk
4624c609719bSwdenkNote: for some board special configuration names may exist; check if
4625c609719bSwdenk      additional information is available from the board vendor; for
46262729af9dSwdenk      instance, the TQM823L systems are available without (standard)
46272729af9dSwdenk      or with LCD support. You can select such additional "features"
462811ccc33fSMarcel Ziswiler      when choosing the configuration, i. e.
4629c609719bSwdenk
46302729af9dSwdenk      make TQM823L_config
46312729af9dSwdenk	- will configure for a plain TQM823L, i. e. no LCD support
4632c609719bSwdenk
4633c609719bSwdenk      make TQM823L_LCD_config
4634c609719bSwdenk	- will configure for a TQM823L with U-Boot console on LCD
4635c609719bSwdenk
4636c609719bSwdenk      etc.
4637c609719bSwdenk
4638c609719bSwdenk
4639c609719bSwdenkFinally, type "make all", and you should get some working U-Boot
46407152b1d0Swdenkimages ready for download to / installation on your system:
4641c609719bSwdenk
4642c609719bSwdenk- "u-boot.bin" is a raw binary image
4643c609719bSwdenk- "u-boot" is an image in ELF binary format
4644c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format
4645c609719bSwdenk
4646baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved
4647baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change
4648baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory:
4649baf31249SMarian Balakowicz
4650baf31249SMarian Balakowicz1. Add O= to the make command line invocations:
4651baf31249SMarian Balakowicz
4652baf31249SMarian Balakowicz	make O=/tmp/build distclean
4653baf31249SMarian Balakowicz	make O=/tmp/build NAME_config
4654baf31249SMarian Balakowicz	make O=/tmp/build all
4655baf31249SMarian Balakowicz
4656baf31249SMarian Balakowicz2. Set environment variable BUILD_DIR to point to the desired location:
4657baf31249SMarian Balakowicz
4658baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
4659baf31249SMarian Balakowicz	make distclean
4660baf31249SMarian Balakowicz	make NAME_config
4661baf31249SMarian Balakowicz	make all
4662baf31249SMarian Balakowicz
4663baf31249SMarian BalakowiczNote that the command line "O=" setting overrides the BUILD_DIR environment
4664baf31249SMarian Balakowiczvariable.
4665baf31249SMarian Balakowicz
4666c609719bSwdenk
4667c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so
4668c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of
4669c609719bSwdenknative "make".
4670c609719bSwdenk
4671c609719bSwdenk
4672c609719bSwdenkIf the system board that you have is not listed, then you will need
4673c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these
4674c609719bSwdenksteps:
4675c609719bSwdenk
4676c609719bSwdenk1.  Add a new configuration option for your board to the toplevel
46774d675ae6SMichael Jones    "boards.cfg" file, using the existing entries as examples.
46784d675ae6SMichael Jones    Follow the instructions there to keep the boards in order.
4679c609719bSwdenk2.  Create a new directory to hold your board specific code. Add any
468085ec0bccSwdenk    files you need. In your board directory, you will need at least
468185ec0bccSwdenk    the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
468285ec0bccSwdenk3.  Create a new configuration file "include/configs/<board>.h" for
468385ec0bccSwdenk    your board
4684c609719bSwdenk3.  If you're porting U-Boot to a new CPU, then also create a new
4685c609719bSwdenk    directory to hold your CPU specific code. Add any files you need.
468685ec0bccSwdenk4.  Run "make <board>_config" with your new name.
4687c609719bSwdenk5.  Type "make", and you should get a working "u-boot.srec" file
4688c609719bSwdenk    to be installed on your target system.
468985ec0bccSwdenk6.  Debug and solve any problems that might arise.
4690c609719bSwdenk    [Of course, this last step is much harder than it sounds.]
4691c609719bSwdenk
4692c609719bSwdenk
4693c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.:
4694c609719bSwdenk==============================================================
4695c609719bSwdenk
4696c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board
4697c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to
4698c609719bSwdenkprovide feedback to the other developers. The feedback normally takes
4699c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest
4700218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources.
4701c609719bSwdenk
4702c609719bSwdenkBut before you submit such a patch, please verify that your modifi-
4703c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of
4704c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so,
4705c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot
4706c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You can
47077152b1d0Swdenkselect which (cross) compiler to use by passing a `CROSS_COMPILE'
4708218ca724SWolfgang Denkenvironment variable to the script, i. e. to use the ELDK cross tools
4709218ca724SWolfgang Denkyou can type
4710c609719bSwdenk
4711c609719bSwdenk	CROSS_COMPILE=ppc_8xx- MAKEALL
4712c609719bSwdenk
4713c609719bSwdenkor to build on a native PowerPC system you can type
4714c609719bSwdenk
4715c609719bSwdenk	CROSS_COMPILE=' ' MAKEALL
4716c609719bSwdenk
4717218ca724SWolfgang DenkWhen using the MAKEALL script, the default behaviour is to build
4718218ca724SWolfgang DenkU-Boot in the source directory. This location can be changed by
4719218ca724SWolfgang Denksetting the BUILD_DIR environment variable. Also, for each target
4720218ca724SWolfgang Denkbuilt, the MAKEALL script saves two log files (<target>.ERR and
4721218ca724SWolfgang Denk<target>.MAKEALL) in the <source dir>/LOG directory. This default
4722218ca724SWolfgang Denklocation can be changed by setting the MAKEALL_LOGDIR environment
4723218ca724SWolfgang Denkvariable. For example:
4724baf31249SMarian Balakowicz
4725baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
4726baf31249SMarian Balakowicz	export MAKEALL_LOGDIR=/tmp/log
4727baf31249SMarian Balakowicz	CROSS_COMPILE=ppc_8xx- MAKEALL
4728baf31249SMarian Balakowicz
4729218ca724SWolfgang DenkWith the above settings build objects are saved in the /tmp/build,
4730218ca724SWolfgang Denklog files are saved in the /tmp/log and the source tree remains clean
4731218ca724SWolfgang Denkduring the whole build process.
4732baf31249SMarian Balakowicz
4733baf31249SMarian Balakowicz
4734c609719bSwdenkSee also "U-Boot Porting Guide" below.
4735c609719bSwdenk
4736c609719bSwdenk
4737c609719bSwdenkMonitor Commands - Overview:
4738c609719bSwdenk============================
4739c609719bSwdenk
4740c609719bSwdenkgo	- start application at address 'addr'
4741c609719bSwdenkrun	- run commands in an environment variable
4742c609719bSwdenkbootm	- boot application image from memory
4743c609719bSwdenkbootp	- boot image via network using BootP/TFTP protocol
474444f074c7SMarek Vasutbootz   - boot zImage from memory
4745c609719bSwdenktftpboot- boot image via network using TFTP protocol
4746c609719bSwdenk	       and env variables "ipaddr" and "serverip"
4747c609719bSwdenk	       (and eventually "gatewayip")
47481fb7cd49SSimon Glasstftpput - upload a file via network using TFTP protocol
4749c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol
4750c609719bSwdenkdiskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
4751c609719bSwdenkloads	- load S-Record file over serial line
4752c609719bSwdenkloadb	- load binary file over serial line (kermit mode)
4753c609719bSwdenkmd	- memory display
4754c609719bSwdenkmm	- memory modify (auto-incrementing)
4755c609719bSwdenknm	- memory modify (constant address)
4756c609719bSwdenkmw	- memory write (fill)
4757c609719bSwdenkcp	- memory copy
4758c609719bSwdenkcmp	- memory compare
4759c609719bSwdenkcrc32	- checksum calculation
47600f89c54bSPeter Tyseri2c	- I2C sub-system
4761c609719bSwdenksspi	- SPI utility commands
4762c609719bSwdenkbase	- print or set address offset
4763c609719bSwdenkprintenv- print environment variables
4764c609719bSwdenksetenv	- set environment variables
4765c609719bSwdenksaveenv - save environment variables to persistent storage
4766c609719bSwdenkprotect - enable or disable FLASH write protection
4767c609719bSwdenkerase	- erase FLASH memory
4768c609719bSwdenkflinfo	- print FLASH memory information
476910635afaSKarl O. Pincnand	- NAND memory operations (see doc/README.nand)
4770c609719bSwdenkbdinfo	- print Board Info structure
4771c609719bSwdenkiminfo	- print header information for application image
4772c609719bSwdenkconinfo - print console devices and informations
4773c609719bSwdenkide	- IDE sub-system
4774c609719bSwdenkloop	- infinite loop on address range
477556523f12Swdenkloopw	- infinite write loop on address range
4776c609719bSwdenkmtest	- simple RAM test
4777c609719bSwdenkicache	- enable or disable instruction cache
4778c609719bSwdenkdcache	- enable or disable data cache
4779c609719bSwdenkreset	- Perform RESET of the CPU
4780c609719bSwdenkecho	- echo args to console
4781c609719bSwdenkversion - print monitor version
4782c609719bSwdenkhelp	- print online help
4783c609719bSwdenk?	- alias for 'help'
4784c609719bSwdenk
4785c609719bSwdenk
4786c609719bSwdenkMonitor Commands - Detailed Description:
4787c609719bSwdenk========================================
4788c609719bSwdenk
4789c609719bSwdenkTODO.
4790c609719bSwdenk
4791c609719bSwdenkFor now: just type "help <command>".
4792c609719bSwdenk
4793c609719bSwdenk
4794c609719bSwdenkEnvironment Variables:
4795c609719bSwdenk======================
4796c609719bSwdenk
4797c609719bSwdenkU-Boot supports user configuration using Environment Variables which
4798c609719bSwdenkcan be made persistent by saving to Flash memory.
4799c609719bSwdenk
4800c609719bSwdenkEnvironment Variables are set using "setenv", printed using
4801c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv"
4802c609719bSwdenkwithout a value can be used to delete a variable from the
4803c609719bSwdenkenvironment. As long as you don't save the environment you are
4804c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the
4805c609719bSwdenkenvironment is erased by accident, a default environment is provided.
4806c609719bSwdenk
4807c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables.
4808c96f86eeSWolfgang Denk
4809c96f86eeSWolfgang DenkList of environment variables (most likely not complete):
4810c609719bSwdenk
4811c609719bSwdenk  baudrate	- see CONFIG_BAUDRATE
4812c609719bSwdenk
4813c609719bSwdenk  bootdelay	- see CONFIG_BOOTDELAY
4814c609719bSwdenk
4815c609719bSwdenk  bootcmd	- see CONFIG_BOOTCOMMAND
4816c609719bSwdenk
4817c609719bSwdenk  bootargs	- Boot arguments when booting an RTOS image
4818c609719bSwdenk
4819c609719bSwdenk  bootfile	- Name of the image to load with TFTP
4820c609719bSwdenk
48217d721e34SBartlomiej Sieka  bootm_low	- Memory range available for image processing in the bootm
48227d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
48237d721e34SBartlomiej Sieka		  a hexadecimal number and defines lowest address allowed
48247d721e34SBartlomiej Sieka		  for use by the bootm command. See also "bootm_size"
48257d721e34SBartlomiej Sieka		  environment variable. Address defined by "bootm_low" is
48267d721e34SBartlomiej Sieka		  also the base of the initial memory mapping for the Linux
4827c3624e6eSGrant Likely		  kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4828c3624e6eSGrant Likely		  bootm_mapsize.
4829c3624e6eSGrant Likely
4830c3624e6eSGrant Likely  bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
4831c3624e6eSGrant Likely		  This variable is given as a hexadecimal number and it
4832c3624e6eSGrant Likely		  defines the size of the memory region starting at base
4833c3624e6eSGrant Likely		  address bootm_low that is accessible by the Linux kernel
4834c3624e6eSGrant Likely		  during early boot.  If unset, CONFIG_SYS_BOOTMAPSZ is used
4835c3624e6eSGrant Likely		  as the default value if it is defined, and bootm_size is
4836c3624e6eSGrant Likely		  used otherwise.
48377d721e34SBartlomiej Sieka
48387d721e34SBartlomiej Sieka  bootm_size	- Memory range available for image processing in the bootm
48397d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
48407d721e34SBartlomiej Sieka		  a hexadecimal number and defines the size of the region
48417d721e34SBartlomiej Sieka		  allowed for use by the bootm command. See also "bootm_low"
48427d721e34SBartlomiej Sieka		  environment variable.
48437d721e34SBartlomiej Sieka
48444bae9090SBartlomiej Sieka  updatefile	- Location of the software update file on a TFTP server, used
48454bae9090SBartlomiej Sieka		  by the automatic software update feature. Please refer to
48464bae9090SBartlomiej Sieka		  documentation in doc/README.update for more details.
48474bae9090SBartlomiej Sieka
4848c609719bSwdenk  autoload	- if set to "no" (any string beginning with 'n'),
4849c609719bSwdenk		  "bootp" will just load perform a lookup of the
4850c609719bSwdenk		  configuration from the BOOTP server, but not try to
4851c609719bSwdenk		  load any image using TFTP
4852c609719bSwdenk
4853c609719bSwdenk  autostart	- if set to "yes", an image loaded using the "bootp",
4854c609719bSwdenk		  "rarpboot", "tftpboot" or "diskboot" commands will
4855c609719bSwdenk		  be automatically started (by internally calling
4856c609719bSwdenk		  "bootm")
4857c609719bSwdenk
48584a6fd34bSwdenk		  If set to "no", a standalone image passed to the
48594a6fd34bSwdenk		  "bootm" command will be copied to the load address
48604a6fd34bSwdenk		  (and eventually uncompressed), but NOT be started.
48614a6fd34bSwdenk		  This can be used to load and uncompress arbitrary
48624a6fd34bSwdenk		  data.
48634a6fd34bSwdenk
4864a28afca5SDavid A. Long  fdt_high	- if set this restricts the maximum address that the
4865a28afca5SDavid A. Long		  flattened device tree will be copied into upon boot.
4866fa34f6b2SShawn Guo		  For example, if you have a system with 1 GB memory
4867fa34f6b2SShawn Guo		  at physical address 0x10000000, while Linux kernel
4868fa34f6b2SShawn Guo		  only recognizes the first 704 MB as low memory, you
4869fa34f6b2SShawn Guo		  may need to set fdt_high as 0x3C000000 to have the
4870fa34f6b2SShawn Guo		  device tree blob be copied to the maximum address
4871fa34f6b2SShawn Guo		  of the 704 MB low memory, so that Linux kernel can
4872fa34f6b2SShawn Guo		  access it during the boot procedure.
4873fa34f6b2SShawn Guo
4874a28afca5SDavid A. Long		  If this is set to the special value 0xFFFFFFFF then
4875a28afca5SDavid A. Long		  the fdt will not be copied at all on boot.  For this
4876a28afca5SDavid A. Long		  to work it must reside in writable memory, have
4877a28afca5SDavid A. Long		  sufficient padding on the end of it for u-boot to
4878a28afca5SDavid A. Long		  add the information it needs into it, and the memory
4879a28afca5SDavid A. Long		  must be accessible by the kernel.
4880a28afca5SDavid A. Long
4881eea63e05SSimon Glass  fdtcontroladdr- if set this is the address of the control flattened
4882eea63e05SSimon Glass		  device tree used by U-Boot when CONFIG_OF_CONTROL is
4883eea63e05SSimon Glass		  defined.
4884eea63e05SSimon Glass
488517ea1177Swdenk  i2cfast	- (PPC405GP|PPC405EP only)
488617ea1177Swdenk		  if set to 'y' configures Linux I2C driver for fast
488717ea1177Swdenk		  mode (400kHZ). This environment variable is used in
488817ea1177Swdenk		  initialization code. So, for changes to be effective
488917ea1177Swdenk		  it must be saved and board must be reset.
489017ea1177Swdenk
4891c609719bSwdenk  initrd_high	- restrict positioning of initrd images:
4892c609719bSwdenk		  If this variable is not set, initrd images will be
4893c609719bSwdenk		  copied to the highest possible address in RAM; this
4894c609719bSwdenk		  is usually what you want since it allows for
4895c609719bSwdenk		  maximum initrd size. If for some reason you want to
4896c609719bSwdenk		  make sure that the initrd image is loaded below the
48976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		  CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
4898c609719bSwdenk		  variable to a value of "no" or "off" or "0".
4899c609719bSwdenk		  Alternatively, you can set it to a maximum upper
4900c609719bSwdenk		  address to use (U-Boot will still check that it
4901c609719bSwdenk		  does not overwrite the U-Boot stack and data).
4902c609719bSwdenk
4903c609719bSwdenk		  For instance, when you have a system with 16 MB
49047152b1d0Swdenk		  RAM, and want to reserve 4 MB from use by Linux,
4905c609719bSwdenk		  you can do this by adding "mem=12M" to the value of
4906c609719bSwdenk		  the "bootargs" variable. However, now you must make
49077152b1d0Swdenk		  sure that the initrd image is placed in the first
4908c609719bSwdenk		  12 MB as well - this can be done with
4909c609719bSwdenk
4910c609719bSwdenk		  setenv initrd_high 00c00000
4911c609719bSwdenk
491238b99261Swdenk		  If you set initrd_high to 0xFFFFFFFF, this is an
491338b99261Swdenk		  indication to U-Boot that all addresses are legal
491438b99261Swdenk		  for the Linux kernel, including addresses in flash
491538b99261Swdenk		  memory. In this case U-Boot will NOT COPY the
491638b99261Swdenk		  ramdisk at all. This may be useful to reduce the
491738b99261Swdenk		  boot time on your system, but requires that this
491838b99261Swdenk		  feature is supported by your Linux kernel.
491938b99261Swdenk
4920c609719bSwdenk  ipaddr	- IP address; needed for tftpboot command
4921c609719bSwdenk
4922c609719bSwdenk  loadaddr	- Default load address for commands like "bootp",
4923dc7c9a1aSwdenk		  "rarpboot", "tftpboot", "loadb" or "diskboot"
4924c609719bSwdenk
4925c609719bSwdenk  loads_echo	- see CONFIG_LOADS_ECHO
4926c609719bSwdenk
4927c609719bSwdenk  serverip	- TFTP server IP address; needed for tftpboot command
4928c609719bSwdenk
4929c609719bSwdenk  bootretry	- see CONFIG_BOOT_RETRY_TIME
4930c609719bSwdenk
4931c609719bSwdenk  bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
4932c609719bSwdenk
4933c609719bSwdenk  bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
4934c609719bSwdenk
4935e2a53458SMike Frysinger  ethprime	- controls which interface is used first.
4936a3d991bdSwdenk
4937e2a53458SMike Frysinger  ethact	- controls which interface is currently active.
4938e2a53458SMike Frysinger		  For example you can do the following
4939a3d991bdSwdenk
494048690d80SHeiko Schocher		  => setenv ethact FEC
494148690d80SHeiko Schocher		  => ping 192.168.0.1 # traffic sent on FEC
494248690d80SHeiko Schocher		  => setenv ethact SCC
494348690d80SHeiko Schocher		  => ping 10.0.0.1 # traffic sent on SCC
4944a3d991bdSwdenk
4945e1692577SMatthias Fuchs  ethrotate	- When set to "no" U-Boot does not go through all
4946e1692577SMatthias Fuchs		  available network interfaces.
4947e1692577SMatthias Fuchs		  It just stays at the currently selected interface.
4948e1692577SMatthias Fuchs
4949a3d991bdSwdenk  netretry	- When set to "no" each network operation will
4950a3d991bdSwdenk		  either succeed or fail without retrying.
49516e592385Swdenk		  When set to "once" the network operation will
49526e592385Swdenk		  fail when all the available network interfaces
49536e592385Swdenk		  are tried once without success.
4954a3d991bdSwdenk		  Useful on scripts which control the retry operation
4955a3d991bdSwdenk		  themselves.
4956a3d991bdSwdenk
4957b4e2f89dSJean-Christophe PLAGNIOL-VILLARD  npe_ucode	- set load address for the NPE microcode
4958a1cf027aSJean-Christophe PLAGNIOL-VILLARD
49598d51aacdSSimon Glass  silent_linux  - If set then linux will be told to boot silently, by
49608d51aacdSSimon Glass		  changing the console to be empty. If "yes" it will be
49618d51aacdSSimon Glass		  made silent. If "no" it will not be made silent. If
49628d51aacdSSimon Glass		  unset, then it will be made silent if the U-Boot console
49638d51aacdSSimon Glass		  is silent.
49648d51aacdSSimon Glass
496528cb9375SWolfgang Denk  tftpsrcport	- If this is set, the value is used for TFTP's
4966ecb0ccd9SWolfgang Denk		  UDP source port.
4967ecb0ccd9SWolfgang Denk
496828cb9375SWolfgang Denk  tftpdstport	- If this is set, the value is used for TFTP's UDP
496928cb9375SWolfgang Denk		  destination port instead of the Well Know Port 69.
497028cb9375SWolfgang Denk
4971c96f86eeSWolfgang Denk  tftpblocksize - Block size to use for TFTP transfers; if not set,
4972c96f86eeSWolfgang Denk		  we use the TFTP server's default block size
4973c96f86eeSWolfgang Denk
4974c96f86eeSWolfgang Denk  tftptimeout	- Retransmission timeout for TFTP packets (in milli-
4975c96f86eeSWolfgang Denk		  seconds, minimum value is 1000 = 1 second). Defines
4976c96f86eeSWolfgang Denk		  when a packet is considered to be lost so it has to
4977c96f86eeSWolfgang Denk		  be retransmitted. The default is 5000 = 5 seconds.
4978c96f86eeSWolfgang Denk		  Lowering this value may make downloads succeed
4979c96f86eeSWolfgang Denk		  faster in networks with high packet loss rates or
4980c96f86eeSWolfgang Denk		  with unreliable TFTP servers.
4981c96f86eeSWolfgang Denk
4982a3d991bdSwdenk  vlan		- When set to a value < 4095 the traffic over
498311ccc33fSMarcel Ziswiler		  Ethernet is encapsulated/received over 802.1q
4984a3d991bdSwdenk		  VLAN tagged frames.
4985c609719bSwdenk
4986dc0b7b0eSJason HobbsThe following image location variables contain the location of images
4987dc0b7b0eSJason Hobbsused in booting. The "Image" column gives the role of the image and is
4988dc0b7b0eSJason Hobbsnot an environment variable name. The other columns are environment
4989dc0b7b0eSJason Hobbsvariable names. "File Name" gives the name of the file on a TFTP
4990dc0b7b0eSJason Hobbsserver, "RAM Address" gives the location in RAM the image will be
4991dc0b7b0eSJason Hobbsloaded to, and "Flash Location" gives the image's address in NOR
4992dc0b7b0eSJason Hobbsflash or offset in NAND flash.
4993dc0b7b0eSJason Hobbs
4994dc0b7b0eSJason Hobbs*Note* - these variables don't have to be defined for all boards, some
4995dc0b7b0eSJason Hobbsboards currenlty use other variables for these purposes, and some
4996dc0b7b0eSJason Hobbsboards use these variables for other purposes.
4997dc0b7b0eSJason Hobbs
4998dc0b7b0eSJason HobbsImage		    File Name	     RAM Address       Flash Location
4999dc0b7b0eSJason Hobbs-----		    ---------	     -----------       --------------
5000dc0b7b0eSJason Hobbsu-boot		    u-boot	     u-boot_addr_r     u-boot_addr
5001dc0b7b0eSJason HobbsLinux kernel	    bootfile	     kernel_addr_r     kernel_addr
5002dc0b7b0eSJason Hobbsdevice tree blob    fdtfile	     fdt_addr_r	       fdt_addr
5003dc0b7b0eSJason Hobbsramdisk		    ramdiskfile	     ramdisk_addr_r    ramdisk_addr
5004dc0b7b0eSJason Hobbs
5005c609719bSwdenkThe following environment variables may be used and automatically
5006c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"),
5007c609719bSwdenkdepending the information provided by your boot server:
5008c609719bSwdenk
5009c609719bSwdenk  bootfile	- see above
5010c609719bSwdenk  dnsip		- IP address of your Domain Name Server
5011fe389a82Sstroese  dnsip2	- IP address of your secondary Domain Name Server
5012c609719bSwdenk  gatewayip	- IP address of the Gateway (Router) to use
5013c609719bSwdenk  hostname	- Target hostname
5014c609719bSwdenk  ipaddr	- see above
5015c609719bSwdenk  netmask	- Subnet Mask
5016c609719bSwdenk  rootpath	- Pathname of the root filesystem on the NFS server
5017c609719bSwdenk  serverip	- see above
5018c609719bSwdenk
5019c609719bSwdenk
5020c609719bSwdenkThere are two special Environment Variables:
5021c609719bSwdenk
5022c609719bSwdenk  serial#	- contains hardware identification information such
5023c609719bSwdenk		  as type string and/or serial number
5024c609719bSwdenk  ethaddr	- Ethernet address
5025c609719bSwdenk
5026c609719bSwdenkThese variables can be set only once (usually during manufacturing of
5027c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables
5028c609719bSwdenkonce they have been set once.
5029c609719bSwdenk
5030c609719bSwdenk
5031c1551ea8SstroeseFurther special Environment Variables:
5032c1551ea8Sstroese
5033c1551ea8Sstroese  ver		- Contains the U-Boot version string as printed
5034c1551ea8Sstroese		  with the "version" command. This variable is
5035c1551ea8Sstroese		  readonly (see CONFIG_VERSION_VARIABLE).
5036c1551ea8Sstroese
5037c1551ea8Sstroese
5038c609719bSwdenkPlease note that changes to some configuration parameters may take
5039c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-).
5040c609719bSwdenk
5041c609719bSwdenk
5042170ab110SJoe HershbergerCallback functions for environment variables:
5043170ab110SJoe Hershberger---------------------------------------------
5044170ab110SJoe Hershberger
5045170ab110SJoe HershbergerFor some environment variables, the behavior of u-boot needs to change
5046170ab110SJoe Hershbergerwhen their values are changed.  This functionailty allows functions to
5047170ab110SJoe Hershbergerbe associated with arbitrary variables.  On creation, overwrite, or
5048170ab110SJoe Hershbergerdeletion, the callback will provide the opportunity for some side
5049170ab110SJoe Hershbergereffect to happen or for the change to be rejected.
5050170ab110SJoe Hershberger
5051170ab110SJoe HershbergerThe callbacks are named and associated with a function using the
5052170ab110SJoe HershbergerU_BOOT_ENV_CALLBACK macro in your board or driver code.
5053170ab110SJoe Hershberger
5054170ab110SJoe HershbergerThese callbacks are associated with variables in one of two ways.  The
5055170ab110SJoe Hershbergerstatic list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
5056170ab110SJoe Hershbergerin the board configuration to a string that defines a list of
5057170ab110SJoe Hershbergerassociations.  The list must be in the following format:
5058170ab110SJoe Hershberger
5059170ab110SJoe Hershberger	entry = variable_name[:callback_name]
5060170ab110SJoe Hershberger	list = entry[,list]
5061170ab110SJoe Hershberger
5062170ab110SJoe HershbergerIf the callback name is not specified, then the callback is deleted.
5063170ab110SJoe HershbergerSpaces are also allowed anywhere in the list.
5064170ab110SJoe Hershberger
5065170ab110SJoe HershbergerCallbacks can also be associated by defining the ".callbacks" variable
5066170ab110SJoe Hershbergerwith the same list format above.  Any association in ".callbacks" will
5067170ab110SJoe Hershbergeroverride any association in the static list. You can define
5068170ab110SJoe HershbergerCONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
5069170ab110SJoe Hershberger".callbacks" envirnoment variable in the default or embedded environment.
5070170ab110SJoe Hershberger
5071170ab110SJoe Hershberger
5072f07771ccSwdenkCommand Line Parsing:
5073f07771ccSwdenk=====================
5074f07771ccSwdenk
5075f07771ccSwdenkThere are two different command line parsers available with U-Boot:
50767152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell:
5077f07771ccSwdenk
5078f07771ccSwdenkOld, simple command line parser:
5079f07771ccSwdenk--------------------------------
5080f07771ccSwdenk
5081f07771ccSwdenk- supports environment variables (through setenv / saveenv commands)
5082f07771ccSwdenk- several commands on one line, separated by ';'
5083fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax
5084f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\',
5085f07771ccSwdenk  for example:
5086fe126d8bSWolfgang Denk	setenv bootcmd bootm \${address}
5087f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example:
5088f07771ccSwdenk	setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
5089f07771ccSwdenk
5090f07771ccSwdenkHush shell:
5091f07771ccSwdenk-----------
5092f07771ccSwdenk
5093f07771ccSwdenk- similar to Bourne shell, with control structures like
5094f07771ccSwdenk  if...then...else...fi, for...do...done; while...do...done,
5095f07771ccSwdenk  until...do...done, ...
5096f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv
5097f07771ccSwdenk  commands) and local shell variables (through standard shell syntax
5098f07771ccSwdenk  "name=value"); only environment variables can be used with "run"
5099f07771ccSwdenk  command
5100f07771ccSwdenk
5101f07771ccSwdenkGeneral rules:
5102f07771ccSwdenk--------------
5103f07771ccSwdenk
5104f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run"
5105f07771ccSwdenk    command) contains several commands separated by semicolon, and
5106f07771ccSwdenk    one of these commands fails, then the remaining commands will be
5107f07771ccSwdenk    executed anyway.
5108f07771ccSwdenk
5109f07771ccSwdenk(2) If you execute several variables with one call to run (i. e.
511011ccc33fSMarcel Ziswiler    calling run with a list of variables as arguments), any failing
5111f07771ccSwdenk    command will cause "run" to terminate, i. e. the remaining
5112f07771ccSwdenk    variables are not executed.
5113f07771ccSwdenk
5114c609719bSwdenkNote for Redundant Ethernet Interfaces:
5115c609719bSwdenk=======================================
5116c609719bSwdenk
511711ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports
5118c609719bSwdenksuch configurations and is capable of automatic selection of a
51197152b1d0Swdenk"working" interface when needed. MAC assignment works as follows:
5120c609719bSwdenk
5121c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding
5122c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0),
5123c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ...
5124c609719bSwdenk
5125c609719bSwdenkIf the network interface stores some valid MAC address (for instance
5126c609719bSwdenkin SROM), this is used as default address if there is NO correspon-
5127c609719bSwdenkding setting in the environment; if the corresponding environment
5128c609719bSwdenkvariable is set, this overrides the settings in the card; that means:
5129c609719bSwdenk
5130c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the
5131c609719bSwdenk  environment, the SROM's address is used.
5132c609719bSwdenk
5133c609719bSwdenko If there is no valid address in the SROM, and a definition in the
5134c609719bSwdenk  environment exists, then the value from the environment variable is
5135c609719bSwdenk  used.
5136c609719bSwdenk
5137c609719bSwdenko If both the SROM and the environment contain a MAC address, and
5138c609719bSwdenk  both addresses are the same, this MAC address is used.
5139c609719bSwdenk
5140c609719bSwdenko If both the SROM and the environment contain a MAC address, and the
5141c609719bSwdenk  addresses differ, the value from the environment is used and a
5142c609719bSwdenk  warning is printed.
5143c609719bSwdenk
5144c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error
5145c609719bSwdenk  is raised.
5146c609719bSwdenk
5147ecee9324SBen WarrenIf Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
5148ecee9324SBen Warrenwill be programmed into hardware as part of the initialization process.	 This
5149ecee9324SBen Warrenmay be skipped by setting the appropriate 'ethmacskip' environment variable.
5150ecee9324SBen WarrenThe naming convention is as follows:
5151ecee9324SBen Warren"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
5152c609719bSwdenk
5153c609719bSwdenkImage Formats:
5154c609719bSwdenk==============
5155c609719bSwdenk
51563310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on)
51573310c549SMarian Balakowiczimages in two formats:
51583310c549SMarian Balakowicz
51593310c549SMarian BalakowiczNew uImage format (FIT)
51603310c549SMarian Balakowicz-----------------------
51613310c549SMarian Balakowicz
51623310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar
51633310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple
51643310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by
51653310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
51663310c549SMarian Balakowicz
51673310c549SMarian Balakowicz
51683310c549SMarian BalakowiczOld uImage format
51693310c549SMarian Balakowicz-----------------
51703310c549SMarian Balakowicz
51713310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything,
51723310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for
51733310c549SMarian Balakowiczdetails; basically, the header defines the following image properties:
5174c609719bSwdenk
5175c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5176c609719bSwdenk  4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
5177f5ed9e39SPeter Tyser  LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5178f5ed9e39SPeter Tyser  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5179f5ed9e39SPeter Tyser  INTEGRITY).
51807b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
5181afc1ce82SMacpaul Lin  IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5182afc1ce82SMacpaul Lin  Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
5183c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2)
5184c609719bSwdenk* Load Address
5185c609719bSwdenk* Entry Point
5186c609719bSwdenk* Image Name
5187c609719bSwdenk* Image Timestamp
5188c609719bSwdenk
5189c609719bSwdenkThe header is marked by a special Magic Number, and both the header
5190c609719bSwdenkand the data portions of the image are secured against corruption by
5191c609719bSwdenkCRC32 checksums.
5192c609719bSwdenk
5193c609719bSwdenk
5194c609719bSwdenkLinux Support:
5195c609719bSwdenk==============
5196c609719bSwdenk
5197c609719bSwdenkAlthough U-Boot should support any OS or standalone application
51987152b1d0Swdenkeasily, the main focus has always been on Linux during the design of
5199c609719bSwdenkU-Boot.
5200c609719bSwdenk
5201c609719bSwdenkU-Boot includes many features that so far have been part of some
5202c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any
5203c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image;
5204c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation
52057152b1d0Swdenkserves several purposes:
5206c609719bSwdenk
5207c609719bSwdenk- the same features can be used for other OS or standalone
5208c609719bSwdenk  applications (for instance: using compressed images to reduce the
5209c609719bSwdenk  Flash memory footprint)
5210c609719bSwdenk
5211c609719bSwdenk- it becomes much easier to port new Linux kernel versions because
52127152b1d0Swdenk  lots of low-level, hardware dependent stuff are done by U-Boot
5213c609719bSwdenk
5214c609719bSwdenk- the same Linux kernel image can now be used with different "initrd"
5215c609719bSwdenk  images; of course this also means that different kernel images can
5216c609719bSwdenk  be run with the same "initrd". This makes testing easier (you don't
5217c609719bSwdenk  have to build a new "zImage.initrd" Linux image when you just
5218c609719bSwdenk  change a file in your "initrd"). Also, a field-upgrade of the
5219c609719bSwdenk  software is easier now.
5220c609719bSwdenk
5221c609719bSwdenk
5222c609719bSwdenkLinux HOWTO:
5223c609719bSwdenk============
5224c609719bSwdenk
5225c609719bSwdenkPorting Linux to U-Boot based systems:
5226c609719bSwdenk---------------------------------------
5227c609719bSwdenk
5228c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to
5229c609719bSwdenkconfigure the Linux device drivers for use with your target hardware
5230c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to
5231c609719bSwdenkLinux :-).
5232c609719bSwdenk
5233a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
5234c609719bSwdenk
5235c609719bSwdenkJust make sure your machine specific header file (for instance
5236c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board
52371dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h,
52381dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value
52396d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR.
5240c609719bSwdenk
5241c609719bSwdenk
5242c609719bSwdenkConfiguring the Linux kernel:
5243c609719bSwdenk-----------------------------
5244c609719bSwdenk
5245c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root
5246c609719bSwdenkdevice (initial ramdisk, NFS) for your target system.
5247c609719bSwdenk
5248c609719bSwdenk
5249c609719bSwdenkBuilding a Linux Image:
5250c609719bSwdenk-----------------------
5251c609719bSwdenk
525224ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are
525324ee89b9Swdenknot used. If you use recent kernel source, a new build target
525424ee89b9Swdenk"uImage" will exist which automatically builds an image usable by
525524ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target,
525624ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a
525724ee89b9Swdenk100% compatible format.
5258c609719bSwdenk
5259c609719bSwdenkExample:
5260c609719bSwdenk
5261c609719bSwdenk	make TQM850L_config
5262c609719bSwdenk	make oldconfig
5263c609719bSwdenk	make dep
526424ee89b9Swdenk	make uImage
5265c609719bSwdenk
526624ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to
526724ee89b9Swdenkencapsulate a compressed Linux kernel image with header	 information,
526824ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing:
5269c609719bSwdenk
527024ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format):
527124ee89b9Swdenk
527224ee89b9Swdenk* convert the kernel into a raw binary image:
527324ee89b9Swdenk
527424ee89b9Swdenk	${CROSS_COMPILE}-objcopy -O binary \
527524ee89b9Swdenk				 -R .note -R .comment \
527624ee89b9Swdenk				 -S vmlinux linux.bin
527724ee89b9Swdenk
527824ee89b9Swdenk* compress the binary image:
527924ee89b9Swdenk
528024ee89b9Swdenk	gzip -9 linux.bin
528124ee89b9Swdenk
528224ee89b9Swdenk* package compressed binary image for U-Boot:
528324ee89b9Swdenk
528424ee89b9Swdenk	mkimage -A ppc -O linux -T kernel -C gzip \
528524ee89b9Swdenk		-a 0 -e 0 -n "Linux Kernel Image" \
528624ee89b9Swdenk		-d linux.bin.gz uImage
528724ee89b9Swdenk
528824ee89b9Swdenk
528924ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use
529024ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or
529124ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64
529224ee89b9Swdenkbyte header containing information about target architecture,
529324ee89b9Swdenkoperating system, image type, compression method, entry points, time
529424ee89b9Swdenkstamp, CRC32 checksums, etc.
529524ee89b9Swdenk
529624ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and
529724ee89b9Swdenkprint the header information, or to build new images.
5298c609719bSwdenk
5299c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information
5300c609719bSwdenkcontained in the header of an existing U-Boot image; this includes
5301c609719bSwdenkchecksum verification:
5302c609719bSwdenk
5303c609719bSwdenk	tools/mkimage -l image
5304c609719bSwdenk	  -l ==> list image header information
5305c609719bSwdenk
5306c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image
5307c609719bSwdenkfrom a "data file" which is used as image payload:
5308c609719bSwdenk
5309c609719bSwdenk	tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5310c609719bSwdenk		      -n name -d data_file image
5311c609719bSwdenk	  -A ==> set architecture to 'arch'
5312c609719bSwdenk	  -O ==> set operating system to 'os'
5313c609719bSwdenk	  -T ==> set image type to 'type'
5314c609719bSwdenk	  -C ==> set compression type 'comp'
5315c609719bSwdenk	  -a ==> set load address to 'addr' (hex)
5316c609719bSwdenk	  -e ==> set entry point to 'ep' (hex)
5317c609719bSwdenk	  -n ==> set image name to 'name'
5318c609719bSwdenk	  -d ==> use image data from 'datafile'
5319c609719bSwdenk
532069459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load
532169459791Swdenkaddress (0x00000000), but the entry point address depends on the
532269459791Swdenkkernel version:
5323c609719bSwdenk
5324c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C,
532524ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000.
5326c609719bSwdenk
5327c609719bSwdenkSo a typical call to build a U-Boot image would read:
5328c609719bSwdenk
532924ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
533024ee89b9Swdenk	> -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
5331a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
533224ee89b9Swdenk	> examples/uImage.TQM850L
533324ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5334c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5335c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
5336c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
5337c609719bSwdenk	Load Address: 0x00000000
533824ee89b9Swdenk	Entry Point:  0x00000000
5339c609719bSwdenk
5340c609719bSwdenkTo verify the contents of the image (or check for corruption):
5341c609719bSwdenk
534224ee89b9Swdenk	-> tools/mkimage -l examples/uImage.TQM850L
534324ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5344c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5345c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
5346c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
5347c609719bSwdenk	Load Address: 0x00000000
534824ee89b9Swdenk	Entry Point:  0x00000000
5349c609719bSwdenk
5350c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade
5351c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this
5352c609719bSwdenkneeds more space in Flash, but boots much faster since it does not
5353c609719bSwdenkneed to be uncompressed:
5354c609719bSwdenk
5355a47a12beSStefan Roese	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
535624ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
535724ee89b9Swdenk	> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
5358a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
535924ee89b9Swdenk	> examples/uImage.TQM850L-uncompressed
536024ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5361c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5362c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (uncompressed)
5363c609719bSwdenk	Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
5364c609719bSwdenk	Load Address: 0x00000000
536524ee89b9Swdenk	Entry Point:  0x00000000
5366c609719bSwdenk
5367c609719bSwdenk
5368c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file
5369c609719bSwdenkwhen your kernel is intended to use an initial ramdisk:
5370c609719bSwdenk
5371c609719bSwdenk	-> tools/mkimage -n 'Simple Ramdisk Image' \
5372c609719bSwdenk	> -A ppc -O linux -T ramdisk -C gzip \
5373c609719bSwdenk	> -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5374c609719bSwdenk	Image Name:   Simple Ramdisk Image
5375c609719bSwdenk	Created:      Wed Jan 12 14:01:50 2000
5376c609719bSwdenk	Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
5377c609719bSwdenk	Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
5378c609719bSwdenk	Load Address: 0x00000000
5379c609719bSwdenk	Entry Point:  0x00000000
5380c609719bSwdenk
5381a804b5ceSGuilherme Maciel FerreiraThe "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5382a804b5ceSGuilherme Maciel Ferreiraoption performs the converse operation of the mkimage's second form (the "-d"
5383a804b5ceSGuilherme Maciel Ferreiraoption). Given an image built by mkimage, the dumpimage extracts a "data file"
5384a804b5ceSGuilherme Maciel Ferreirafrom the image:
5385a804b5ceSGuilherme Maciel Ferreira
5386a804b5ceSGuilherme Maciel Ferreira	tools/dumpimage -i image -p position data_file
5387a804b5ceSGuilherme Maciel Ferreira	  -i ==> extract from the 'image' a specific 'data_file', \
5388a804b5ceSGuilherme Maciel Ferreira	   indexed by 'position'
5389a804b5ceSGuilherme Maciel Ferreira
5390c609719bSwdenk
5391c609719bSwdenkInstalling a Linux Image:
5392c609719bSwdenk-------------------------
5393c609719bSwdenk
5394c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface,
5395c609719bSwdenkyou must convert the image to S-Record format:
5396c609719bSwdenk
5397c609719bSwdenk	objcopy -I binary -O srec examples/image examples/image.srec
5398c609719bSwdenk
5399c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot
5400c609719bSwdenkimage header, so the resulting S-Record file will be relative to
5401c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to
5402c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads'
5403c609719bSwdenkcommand.
5404c609719bSwdenk
5405c609719bSwdenkExample: install the image to address 0x40100000 (which on the
5406c609719bSwdenkTQM8xxL is in the first Flash bank):
5407c609719bSwdenk
5408c609719bSwdenk	=> erase 40100000 401FFFFF
5409c609719bSwdenk
5410c609719bSwdenk	.......... done
5411c609719bSwdenk	Erased 8 sectors
5412c609719bSwdenk
5413c609719bSwdenk	=> loads 40100000
5414c609719bSwdenk	## Ready for S-Record download ...
5415c609719bSwdenk	~>examples/image.srec
5416c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5417c609719bSwdenk	...
5418c609719bSwdenk	15989 15990 15991 15992
5419c609719bSwdenk	[file transfer complete]
5420c609719bSwdenk	[connected]
5421c609719bSwdenk	## Start Addr = 0x00000000
5422c609719bSwdenk
5423c609719bSwdenk
5424c609719bSwdenkYou can check the success of the download using the 'iminfo' command;
5425c609719bSwdenkthis includes a checksum verification so you can be sure no data
5426c609719bSwdenkcorruption happened:
5427c609719bSwdenk
5428c609719bSwdenk	=> imi 40100000
5429c609719bSwdenk
5430c609719bSwdenk	## Checking Image at 40100000 ...
5431c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5432c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5433c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5434c609719bSwdenk	   Load Address: 00000000
5435c609719bSwdenk	   Entry Point:	 0000000c
5436c609719bSwdenk	   Verifying Checksum ... OK
5437c609719bSwdenk
5438c609719bSwdenk
5439c609719bSwdenkBoot Linux:
5440c609719bSwdenk-----------
5441c609719bSwdenk
5442c609719bSwdenkThe "bootm" command is used to boot an application that is stored in
5443c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents
5444c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as
5445c609719bSwdenkparameters. You can check and modify this variable using the
5446c609719bSwdenk"printenv" and "setenv" commands:
5447c609719bSwdenk
5448c609719bSwdenk
5449c609719bSwdenk	=> printenv bootargs
5450c609719bSwdenk	bootargs=root=/dev/ram
5451c609719bSwdenk
5452c609719bSwdenk	=> setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5453c609719bSwdenk
5454c609719bSwdenk	=> printenv bootargs
5455c609719bSwdenk	bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5456c609719bSwdenk
5457c609719bSwdenk	=> bootm 40020000
5458c609719bSwdenk	## Booting Linux kernel at 40020000 ...
5459c609719bSwdenk	   Image Name:	 2.2.13 for NFS on TQM850L
5460c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5461c609719bSwdenk	   Data Size:	 381681 Bytes = 372 kB = 0 MB
5462c609719bSwdenk	   Load Address: 00000000
5463c609719bSwdenk	   Entry Point:	 0000000c
5464c609719bSwdenk	   Verifying Checksum ... OK
5465c609719bSwdenk	   Uncompressing Kernel Image ... OK
5466c609719bSwdenk	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
5467c609719bSwdenk	Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5468c609719bSwdenk	time_init: decrementer frequency = 187500000/60
5469c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
5470c609719bSwdenk	Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5471c609719bSwdenk	...
5472c609719bSwdenk
547311ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass
54747152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT
5475c609719bSwdenkformat!) to the "bootm" command:
5476c609719bSwdenk
5477c609719bSwdenk	=> imi 40100000 40200000
5478c609719bSwdenk
5479c609719bSwdenk	## Checking Image at 40100000 ...
5480c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5481c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5482c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5483c609719bSwdenk	   Load Address: 00000000
5484c609719bSwdenk	   Entry Point:	 0000000c
5485c609719bSwdenk	   Verifying Checksum ... OK
5486c609719bSwdenk
5487c609719bSwdenk	## Checking Image at 40200000 ...
5488c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
5489c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
5490c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
5491c609719bSwdenk	   Load Address: 00000000
5492c609719bSwdenk	   Entry Point:	 00000000
5493c609719bSwdenk	   Verifying Checksum ... OK
5494c609719bSwdenk
5495c609719bSwdenk	=> bootm 40100000 40200000
5496c609719bSwdenk	## Booting Linux kernel at 40100000 ...
5497c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5498c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5499c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5500c609719bSwdenk	   Load Address: 00000000
5501c609719bSwdenk	   Entry Point:	 0000000c
5502c609719bSwdenk	   Verifying Checksum ... OK
5503c609719bSwdenk	   Uncompressing Kernel Image ... OK
5504c609719bSwdenk	## Loading RAMDisk Image at 40200000 ...
5505c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
5506c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
5507c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
5508c609719bSwdenk	   Load Address: 00000000
5509c609719bSwdenk	   Entry Point:	 00000000
5510c609719bSwdenk	   Verifying Checksum ... OK
5511c609719bSwdenk	   Loading Ramdisk ... OK
5512c609719bSwdenk	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
5513c609719bSwdenk	Boot arguments: root=/dev/ram
5514c609719bSwdenk	time_init: decrementer frequency = 187500000/60
5515c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
5516c609719bSwdenk	...
5517c609719bSwdenk	RAMDISK: Compressed image found at block 0
5518c609719bSwdenk	VFS: Mounted root (ext2 filesystem).
5519c609719bSwdenk
5520c609719bSwdenk	bash#
5521c609719bSwdenk
55220267768eSMatthew McClintockBoot Linux and pass a flat device tree:
55230267768eSMatthew McClintock-----------
55240267768eSMatthew McClintock
55250267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section
55260267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The
55270267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated
55280267768eSMatthew McClintockflat device tree:
55290267768eSMatthew McClintock
55300267768eSMatthew McClintock=> print oftaddr
55310267768eSMatthew McClintockoftaddr=0x300000
55320267768eSMatthew McClintock=> print oft
55330267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb
55340267768eSMatthew McClintock=> tftp $oftaddr $oft
55350267768eSMatthew McClintockSpeed: 1000, full duplex
55360267768eSMatthew McClintockUsing TSEC0 device
55370267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101
55380267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'.
55390267768eSMatthew McClintockLoad address: 0x300000
55400267768eSMatthew McClintockLoading: #
55410267768eSMatthew McClintockdone
55420267768eSMatthew McClintockBytes transferred = 4106 (100a hex)
55430267768eSMatthew McClintock=> tftp $loadaddr $bootfile
55440267768eSMatthew McClintockSpeed: 1000, full duplex
55450267768eSMatthew McClintockUsing TSEC0 device
55460267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2
55470267768eSMatthew McClintockFilename 'uImage'.
55480267768eSMatthew McClintockLoad address: 0x200000
55490267768eSMatthew McClintockLoading:############
55500267768eSMatthew McClintockdone
55510267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex)
55520267768eSMatthew McClintock=> print loadaddr
55530267768eSMatthew McClintockloadaddr=200000
55540267768eSMatthew McClintock=> print oftaddr
55550267768eSMatthew McClintockoftaddr=0x300000
55560267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr
55570267768eSMatthew McClintock## Booting image at 00200000 ...
55580267768eSMatthew McClintock   Image Name:	 Linux-2.6.17-dirty
55590267768eSMatthew McClintock   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
55600267768eSMatthew McClintock   Data Size:	 1029343 Bytes = 1005.2 kB
55610267768eSMatthew McClintock   Load Address: 00000000
55620267768eSMatthew McClintock   Entry Point:	 00000000
55630267768eSMatthew McClintock   Verifying Checksum ... OK
55640267768eSMatthew McClintock   Uncompressing Kernel Image ... OK
55650267768eSMatthew McClintockBooting using flat device tree at 0x300000
55660267768eSMatthew McClintockUsing MPC85xx ADS machine description
55670267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
55680267768eSMatthew McClintock[snip]
55690267768eSMatthew McClintock
55700267768eSMatthew McClintock
55716069ff26SwdenkMore About U-Boot Image Types:
55726069ff26Swdenk------------------------------
55736069ff26Swdenk
55746069ff26SwdenkU-Boot supports the following image types:
55756069ff26Swdenk
55766069ff26Swdenk   "Standalone Programs" are directly runnable in the environment
55776069ff26Swdenk	provided by U-Boot; it is expected that (if they behave
55786069ff26Swdenk	well) you can continue to work in U-Boot after return from
55796069ff26Swdenk	the Standalone Program.
55806069ff26Swdenk   "OS Kernel Images" are usually images of some Embedded OS which
55816069ff26Swdenk	will take over control completely. Usually these programs
55826069ff26Swdenk	will install their own set of exception handlers, device
55836069ff26Swdenk	drivers, set up the MMU, etc. - this means, that you cannot
55846069ff26Swdenk	expect to re-enter U-Boot except by resetting the CPU.
55856069ff26Swdenk   "RAMDisk Images" are more or less just data blocks, and their
55866069ff26Swdenk	parameters (address, size) are passed to an OS kernel that is
55876069ff26Swdenk	being started.
55886069ff26Swdenk   "Multi-File Images" contain several images, typically an OS
55896069ff26Swdenk	(Linux) kernel image and one or more data images like
55906069ff26Swdenk	RAMDisks. This construct is useful for instance when you want
55916069ff26Swdenk	to boot over the network using BOOTP etc., where the boot
55926069ff26Swdenk	server provides just a single image file, but you want to get
55936069ff26Swdenk	for instance an OS kernel and a RAMDisk image.
55946069ff26Swdenk
55956069ff26Swdenk	"Multi-File Images" start with a list of image sizes, each
55966069ff26Swdenk	image size (in bytes) specified by an "uint32_t" in network
55976069ff26Swdenk	byte order. This list is terminated by an "(uint32_t)0".
55986069ff26Swdenk	Immediately after the terminating 0 follow the images, one by
55996069ff26Swdenk	one, all aligned on "uint32_t" boundaries (size rounded up to
56006069ff26Swdenk	a multiple of 4 bytes).
56016069ff26Swdenk
56026069ff26Swdenk   "Firmware Images" are binary images containing firmware (like
56036069ff26Swdenk	U-Boot or FPGA images) which usually will be programmed to
56046069ff26Swdenk	flash memory.
56056069ff26Swdenk
56066069ff26Swdenk   "Script files" are command sequences that will be executed by
56076069ff26Swdenk	U-Boot's command interpreter; this feature is especially
56086069ff26Swdenk	useful when you configure U-Boot to use a real shell (hush)
56096069ff26Swdenk	as command interpreter.
56106069ff26Swdenk
561144f074c7SMarek VasutBooting the Linux zImage:
561244f074c7SMarek Vasut-------------------------
561344f074c7SMarek Vasut
561444f074c7SMarek VasutOn some platforms, it's possible to boot Linux zImage. This is done
561544f074c7SMarek Vasutusing the "bootz" command. The syntax of "bootz" command is the same
561644f074c7SMarek Vasutas the syntax of "bootm" command.
561744f074c7SMarek Vasut
56188ac28563STom RiniNote, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
5619017e1f3fSMarek Vasutkernel with raw initrd images. The syntax is slightly different, the
5620017e1f3fSMarek Vasutaddress of the initrd must be augmented by it's size, in the following
5621017e1f3fSMarek Vasutformat: "<initrd addres>:<initrd size>".
5622017e1f3fSMarek Vasut
5623c609719bSwdenk
5624c609719bSwdenkStandalone HOWTO:
5625c609719bSwdenk=================
5626c609719bSwdenk
5627c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and
5628c609719bSwdenkrun "standalone" applications, which can use some resources of
5629c609719bSwdenkU-Boot like console I/O functions or interrupt services.
5630c609719bSwdenk
5631c609719bSwdenkTwo simple examples are included with the sources:
5632c609719bSwdenk
5633c609719bSwdenk"Hello World" Demo:
5634c609719bSwdenk-------------------
5635c609719bSwdenk
5636c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo
5637c609719bSwdenkapplication; it is automatically compiled when you build U-Boot.
5638c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it
5639c609719bSwdenklike that:
5640c609719bSwdenk
5641c609719bSwdenk	=> loads
5642c609719bSwdenk	## Ready for S-Record download ...
5643c609719bSwdenk	~>examples/hello_world.srec
5644c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
5645c609719bSwdenk	[file transfer complete]
5646c609719bSwdenk	[connected]
5647c609719bSwdenk	## Start Addr = 0x00040004
5648c609719bSwdenk
5649c609719bSwdenk	=> go 40004 Hello World! This is a test.
5650c609719bSwdenk	## Starting application at 0x00040004 ...
5651c609719bSwdenk	Hello World
5652c609719bSwdenk	argc = 7
5653c609719bSwdenk	argv[0] = "40004"
5654c609719bSwdenk	argv[1] = "Hello"
5655c609719bSwdenk	argv[2] = "World!"
5656c609719bSwdenk	argv[3] = "This"
5657c609719bSwdenk	argv[4] = "is"
5658c609719bSwdenk	argv[5] = "a"
5659c609719bSwdenk	argv[6] = "test."
5660c609719bSwdenk	argv[7] = "<NULL>"
5661c609719bSwdenk	Hit any key to exit ...
5662c609719bSwdenk
5663c609719bSwdenk	## Application terminated, rc = 0x0
5664c609719bSwdenk
5665c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt
5666c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'.
5667c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second.
5668c609719bSwdenkThe interrupt service routine is trivial, just printing a '.'
5669c609719bSwdenkcharacter, but this is just a demo program. The application can be
5670c609719bSwdenkcontrolled by the following keys:
5671c609719bSwdenk
5672c609719bSwdenk	? - print current values og the CPM Timer registers
5673c609719bSwdenk	b - enable interrupts and start timer
5674c609719bSwdenk	e - stop timer and disable interrupts
5675c609719bSwdenk	q - quit application
5676c609719bSwdenk
5677c609719bSwdenk	=> loads
5678c609719bSwdenk	## Ready for S-Record download ...
5679c609719bSwdenk	~>examples/timer.srec
5680c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
5681c609719bSwdenk	[file transfer complete]
5682c609719bSwdenk	[connected]
5683c609719bSwdenk	## Start Addr = 0x00040004
5684c609719bSwdenk
5685c609719bSwdenk	=> go 40004
5686c609719bSwdenk	## Starting application at 0x00040004 ...
5687c609719bSwdenk	TIMERS=0xfff00980
5688c609719bSwdenk	Using timer 1
5689c609719bSwdenk	  tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
5690c609719bSwdenk
5691c609719bSwdenkHit 'b':
5692c609719bSwdenk	[q, b, e, ?] Set interval 1000000 us
5693c609719bSwdenk	Enabling timer
5694c609719bSwdenkHit '?':
5695c609719bSwdenk	[q, b, e, ?] ........
5696c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
5697c609719bSwdenkHit '?':
5698c609719bSwdenk	[q, b, e, ?] .
5699c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
5700c609719bSwdenkHit '?':
5701c609719bSwdenk	[q, b, e, ?] .
5702c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
5703c609719bSwdenkHit '?':
5704c609719bSwdenk	[q, b, e, ?] .
5705c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
5706c609719bSwdenkHit 'e':
5707c609719bSwdenk	[q, b, e, ?] ...Stopping timer
5708c609719bSwdenkHit 'q':
5709c609719bSwdenk	[q, b, e, ?] ## Application terminated, rc = 0x0
5710c609719bSwdenk
5711c609719bSwdenk
571285ec0bccSwdenkMinicom warning:
571385ec0bccSwdenk================
571485ec0bccSwdenk
57157152b1d0SwdenkOver time, many people have reported problems when trying to use the
571685ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd)
571785ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under
5718f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and
571985ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and
5720e53515a2SKarl O. Pincuse "cu" for S-Record download ("loads" command).  See
5721e53515a2SKarl O. Pinchttp://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
5722e53515a2SKarl O. Pincfor help with kermit.
5723e53515a2SKarl O. Pinc
572485ec0bccSwdenk
572552f52c14SwdenkNevertheless, if you absolutely want to use it try adding this
572652f52c14Swdenkconfiguration to your "File transfer protocols" section:
572752f52c14Swdenk
572852f52c14Swdenk	   Name	   Program			Name U/D FullScr IO-Red. Multi
572952f52c14Swdenk	X  kermit  /usr/bin/kermit -i -l %l -s	 Y    U	   Y	   N	  N
573052f52c14Swdenk	Y  kermit  /usr/bin/kermit -i -l %l -r	 N    D	   Y	   N	  N
573152f52c14Swdenk
573252f52c14Swdenk
5733c609719bSwdenkNetBSD Notes:
5734c609719bSwdenk=============
5735c609719bSwdenk
5736c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host
5737c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx).
5738c609719bSwdenk
5739c609719bSwdenkBuilding requires a cross environment; it is known to work on
5740c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5741c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make).
5742c609719bSwdenkNote that the cross-powerpc package does not install include files;
5743c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is
5744c609719bSwdenkmissing.  This file has to be installed and patched manually:
5745c609719bSwdenk
5746c609719bSwdenk	# cd /usr/pkg/cross/powerpc-netbsd/include
5747c609719bSwdenk	# mkdir powerpc
5748c609719bSwdenk	# ln -s powerpc machine
5749c609719bSwdenk	# cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
5750c609719bSwdenk	# ${EDIT} powerpc/ansi.h	## must remove __va_list, _BSD_VA_LIST
5751c609719bSwdenk
5752c609719bSwdenkNative builds *don't* work due to incompatibilities between native
5753c609719bSwdenkand U-Boot include files.
5754c609719bSwdenk
5755c609719bSwdenkBooting assumes that (the first part of) the image booted is a
5756c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel
5757c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source
5758c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
57592a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
5760c609719bSwdenk
5761c609719bSwdenk
5762c609719bSwdenkImplementation Internals:
5763c609719bSwdenk=========================
5764c609719bSwdenk
5765c609719bSwdenkThe following is not intended to be a complete description of every
5766c609719bSwdenkimplementation detail. However, it should help to understand the
5767c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom
5768c609719bSwdenkhardware.
5769c609719bSwdenk
5770c609719bSwdenk
5771c609719bSwdenkInitial Stack, Global Data:
5772c609719bSwdenk---------------------------
5773c609719bSwdenk
5774c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot
5775c609719bSwdenkstarts running out of ROM (flash memory), usually without access to
5776c609719bSwdenksystem RAM (because the memory controller is not initialized yet).
5777c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS
5778c609719bSwdenkis not initialized as zero. To be able to get a C environment working
5779c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation
5780c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU
5781c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and
5782c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be
5783c609719bSwdenklocked as (mis-) used as memory, etc.
5784c609719bSwdenk
57857152b1d0Swdenk	Chris Hallinan posted a good summary of these issues to the
57860668236bSWolfgang Denk	U-Boot mailing list:
578743d9616cSwdenk
578843d9616cSwdenk	Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
578943d9616cSwdenk	From: "Chris Hallinan" <clh@net1plus.com>
579043d9616cSwdenk	Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
579143d9616cSwdenk	...
579243d9616cSwdenk
579343d9616cSwdenk	Correct me if I'm wrong, folks, but the way I understand it
579443d9616cSwdenk	is this: Using DCACHE as initial RAM for Stack, etc, does not
579543d9616cSwdenk	require any physical RAM backing up the cache. The cleverness
579643d9616cSwdenk	is that the cache is being used as a temporary supply of
579743d9616cSwdenk	necessary storage before the SDRAM controller is setup. It's
579811ccc33fSMarcel Ziswiler	beyond the scope of this list to explain the details, but you
579943d9616cSwdenk	can see how this works by studying the cache architecture and
580043d9616cSwdenk	operation in the architecture and processor-specific manuals.
580143d9616cSwdenk
580243d9616cSwdenk	OCM is On Chip Memory, which I believe the 405GP has 4K. It
580343d9616cSwdenk	is another option for the system designer to use as an
580411ccc33fSMarcel Ziswiler	initial stack/RAM area prior to SDRAM being available. Either
580543d9616cSwdenk	option should work for you. Using CS 4 should be fine if your
580643d9616cSwdenk	board designers haven't used it for something that would
580743d9616cSwdenk	cause you grief during the initial boot! It is frequently not
580843d9616cSwdenk	used.
580943d9616cSwdenk
58106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
581143d9616cSwdenk	with your processor/board/system design. The default value
581243d9616cSwdenk	you will find in any recent u-boot distribution in
58138a316c9bSStefan Roese	walnut.h should work for you. I'd set it to a value larger
581443d9616cSwdenk	than your SDRAM module. If you have a 64MB SDRAM module, set
581543d9616cSwdenk	it above 400_0000. Just make sure your board has no resources
581643d9616cSwdenk	that are supposed to respond to that address! That code in
581743d9616cSwdenk	start.S has been around a while and should work as is when
581843d9616cSwdenk	you get the config right.
581943d9616cSwdenk
582043d9616cSwdenk	-Chris Hallinan
582143d9616cSwdenk	DS4.COM, Inc.
582243d9616cSwdenk
5823c609719bSwdenkIt is essential to remember this, since it has some impact on the C
5824c609719bSwdenkcode for the initialization procedures:
5825c609719bSwdenk
5826c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt
5827c609719bSwdenk  to write it.
5828c609719bSwdenk
582911ccc33fSMarcel Ziswiler* Do not use any uninitialized global data (or implicitely initialized
5830c609719bSwdenk  as zero data - BSS segment) at all - this is undefined, initiali-
58317152b1d0Swdenk  zation is performed later (when relocating to RAM).
5832c609719bSwdenk
5833c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like
5834c609719bSwdenk  that.
5835c609719bSwdenk
5836c609719bSwdenkHaving only the stack as writable memory limits means we cannot use
5837c609719bSwdenknormal global data to share information beween the code. But it
5838c609719bSwdenkturned out that the implementation of U-Boot can be greatly
5839c609719bSwdenksimplified by making a global data structure (gd_t) available to all
5840c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_
5841c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of
5842c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we
5843c609719bSwdenkplace a pointer (gd) to the global data into a register which we
5844c609719bSwdenkreserve for this purpose.
5845c609719bSwdenk
58467152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the
5847c609719bSwdenkrelevant  (E)ABI  specifications for the current architecture, and by
5848c609719bSwdenkGCC's implementation.
5849c609719bSwdenk
5850c609719bSwdenkFor PowerPC, the following registers have specific use:
5851c609719bSwdenk	R1:	stack pointer
5852e7670f6cSWolfgang Denk	R2:	reserved for system use
5853c609719bSwdenk	R3-R4:	parameter passing and return values
5854c609719bSwdenk	R5-R10: parameter passing
5855c609719bSwdenk	R13:	small data area pointer
5856c609719bSwdenk	R30:	GOT pointer
5857c609719bSwdenk	R31:	frame pointer
5858c609719bSwdenk
5859e6bee808SJoakim Tjernlund	(U-Boot also uses R12 as internal GOT pointer. r12
5860e6bee808SJoakim Tjernlund	is a volatile register so r12 needs to be reset when
5861e6bee808SJoakim Tjernlund	going back and forth between asm and C)
5862c609719bSwdenk
5863e7670f6cSWolfgang Denk    ==> U-Boot will use R2 to hold a pointer to the global data
5864c609719bSwdenk
5865c609719bSwdenk    Note: on PPC, we could use a static initializer (since the
5866c609719bSwdenk    address of the global data structure is known at compile time),
5867c609719bSwdenk    but it turned out that reserving a register results in somewhat
5868c609719bSwdenk    smaller code - although the code savings are not that big (on
5869c609719bSwdenk    average for all boards 752 bytes for the whole U-Boot image,
5870c609719bSwdenk    624 text + 127 data).
5871c609719bSwdenk
5872c4db335cSRobin GetzOn Blackfin, the normal C ABI (except for P3) is followed as documented here:
58734c58eb55SMike Frysinger	http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
58744c58eb55SMike Frysinger
5875c4db335cSRobin Getz    ==> U-Boot will use P3 to hold a pointer to the global data
58764c58eb55SMike Frysinger
5877c609719bSwdenkOn ARM, the following registers are used:
5878c609719bSwdenk
5879c609719bSwdenk	R0:	function argument word/integer result
5880c609719bSwdenk	R1-R3:	function argument word
588112eba1b4SJeroen Hofstee	R9:	platform specific
588212eba1b4SJeroen Hofstee	R10:	stack limit (used only if stack checking is enabled)
5883c609719bSwdenk	R11:	argument (frame) pointer
5884c609719bSwdenk	R12:	temporary workspace
5885c609719bSwdenk	R13:	stack pointer
5886c609719bSwdenk	R14:	link register
5887c609719bSwdenk	R15:	program counter
5888c609719bSwdenk
588912eba1b4SJeroen Hofstee    ==> U-Boot will use R9 to hold a pointer to the global data
589012eba1b4SJeroen Hofstee
589112eba1b4SJeroen Hofstee    Note: on ARM, only R_ARM_RELATIVE relocations are supported.
5892c609719bSwdenk
58930df01fd3SThomas ChouOn Nios II, the ABI is documented here:
58940df01fd3SThomas Chou	http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
58950df01fd3SThomas Chou
58960df01fd3SThomas Chou    ==> U-Boot will use gp to hold a pointer to the global data
58970df01fd3SThomas Chou
58980df01fd3SThomas Chou    Note: on Nios II, we give "-G0" option to gcc and don't use gp
58990df01fd3SThomas Chou    to access small data sections, so gp is free.
59000df01fd3SThomas Chou
5901afc1ce82SMacpaul LinOn NDS32, the following registers are used:
5902afc1ce82SMacpaul Lin
5903afc1ce82SMacpaul Lin	R0-R1:	argument/return
5904afc1ce82SMacpaul Lin	R2-R5:	argument
5905afc1ce82SMacpaul Lin	R15:	temporary register for assembler
5906afc1ce82SMacpaul Lin	R16:	trampoline register
5907afc1ce82SMacpaul Lin	R28:	frame pointer (FP)
5908afc1ce82SMacpaul Lin	R29:	global pointer (GP)
5909afc1ce82SMacpaul Lin	R30:	link register (LP)
5910afc1ce82SMacpaul Lin	R31:	stack pointer (SP)
5911afc1ce82SMacpaul Lin	PC:	program counter (PC)
5912afc1ce82SMacpaul Lin
5913afc1ce82SMacpaul Lin    ==> U-Boot will use R10 to hold a pointer to the global data
5914afc1ce82SMacpaul Lin
5915d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5916d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much.
5917c609719bSwdenk
5918c609719bSwdenkMemory Management:
5919c609719bSwdenk------------------
5920c609719bSwdenk
5921c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the
5922c609719bSwdenkMMU is not used either for address mapping nor for memory protection.
5923c609719bSwdenk
5924c609719bSwdenkThe available memory is mapped to fixed addresses using the memory
5925c609719bSwdenkcontroller. In this process, a contiguous block is formed for each
5926c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several
5927c609719bSwdenkphysical memory banks.
5928c609719bSwdenk
5929c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on
5930c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5931c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself
5932c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some
59336d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
5934c609719bSwdenkconfiguration setting]. Below that, a structure with global Board
5935c609719bSwdenkInfo data is placed, followed by the stack (growing downward).
5936c609719bSwdenk
5937c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB
5938c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF).
5939c609719bSwdenk
5940c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like
5941c609719bSwdenkthis:
5942c609719bSwdenk
5943c609719bSwdenk	0x0000 0000	Exception Vector code
5944c609719bSwdenk	      :
5945c609719bSwdenk	0x0000 1FFF
5946c609719bSwdenk	0x0000 2000	Free for Application Use
5947c609719bSwdenk	      :
5948c609719bSwdenk	      :
5949c609719bSwdenk
5950c609719bSwdenk	      :
5951c609719bSwdenk	      :
5952c609719bSwdenk	0x00FB FF20	Monitor Stack (Growing downward)
5953c609719bSwdenk	0x00FB FFAC	Board Info Data and permanent copy of global data
5954c609719bSwdenk	0x00FC 0000	Malloc Arena
5955c609719bSwdenk	      :
5956c609719bSwdenk	0x00FD FFFF
5957c609719bSwdenk	0x00FE 0000	RAM Copy of Monitor Code
5958c609719bSwdenk	...		eventually: LCD or video framebuffer
5959c609719bSwdenk	...		eventually: pRAM (Protected RAM - unchanged by reset)
5960c609719bSwdenk	0x00FF FFFF	[End of RAM]
5961c609719bSwdenk
5962c609719bSwdenk
5963c609719bSwdenkSystem Initialization:
5964c609719bSwdenk----------------------
5965c609719bSwdenk
5966c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point
596711ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset
5968c609719bSwdenkconfiguration for CS0# this is a mirror of the onboard Flash memory.
59697152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address.
5970c609719bSwdenkTo be able to implement the initialization code in C, a (small!)
5971c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs
5972c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked
5973c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core,
5974c609719bSwdenkthe caches and the SIU.
5975c609719bSwdenk
5976c609719bSwdenkNext, all (potentially) available memory banks are mapped using a
5977c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries
5978c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5979c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5980c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a
5981c609719bSwdenksimple memory test is run that determines the size of the SDRAM
5982c609719bSwdenkbanks.
5983c609719bSwdenk
5984c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of
59857152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first
5986c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address
5987c609719bSwdenk0x00000000, with any additional banks following immediately to create
5988c609719bSwdenkcontiguous memory starting from 0.
5989c609719bSwdenk
5990c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area
5991c609719bSwdenkand allocates memory for use by malloc() and for the global Board
5992c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM
5993c609719bSwdenkpages, and the final stack is set up.
5994c609719bSwdenk
5995c609719bSwdenkOnly after this relocation will you have a "normal" C environment;
5996c609719bSwdenkuntil that you are restricted in several ways, mostly because you are
5997c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a
5998c609719bSwdenknew address in RAM.
5999c609719bSwdenk
6000c609719bSwdenk
6001c609719bSwdenkU-Boot Porting Guide:
6002c609719bSwdenk----------------------
6003c609719bSwdenk
6004c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
60056aff3115Swdenklist, October 2002]
6006c609719bSwdenk
6007c609719bSwdenk
6008c609719bSwdenkint main(int argc, char *argv[])
6009c609719bSwdenk{
6010c609719bSwdenk	sighandler_t no_more_time;
6011c609719bSwdenk
6012c609719bSwdenk	signal(SIGALRM, no_more_time);
6013c609719bSwdenk	alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
6014c609719bSwdenk
6015c609719bSwdenk	if (available_money > available_manpower) {
60166c3fef28SJerry Van Baren		Pay consultant to port U-Boot;
6017c609719bSwdenk		return 0;
6018c609719bSwdenk	}
6019c609719bSwdenk
6020c609719bSwdenk	Download latest U-Boot source;
6021c609719bSwdenk
60220668236bSWolfgang Denk	Subscribe to u-boot mailing list;
60236aff3115Swdenk
60246c3fef28SJerry Van Baren	if (clueless)
6025c609719bSwdenk		email("Hi, I am new to U-Boot, how do I get started?");
6026c609719bSwdenk
6027c609719bSwdenk	while (learning) {
6028c609719bSwdenk		Read the README file in the top level directory;
60297cb22f97Swdenk		Read http://www.denx.de/twiki/bin/view/DULG/Manual;
60306c3fef28SJerry Van Baren		Read applicable doc/*.README;
6031c609719bSwdenk		Read the source, Luke;
60326c3fef28SJerry Van Baren		/* find . -name "*.[chS]" | xargs grep -i <keyword> */
6033c609719bSwdenk	}
6034c609719bSwdenk
60356c3fef28SJerry Van Baren	if (available_money > toLocalCurrency ($2500))
60366c3fef28SJerry Van Baren		Buy a BDI3000;
60376c3fef28SJerry Van Baren	else
6038c609719bSwdenk		Add a lot of aggravation and time;
6039c609719bSwdenk
60406c3fef28SJerry Van Baren	if (a similar board exists) {	/* hopefully... */
60416c3fef28SJerry Van Baren		cp -a board/<similar> board/<myboard>
60426c3fef28SJerry Van Baren		cp include/configs/<similar>.h include/configs/<myboard>.h
60436c3fef28SJerry Van Baren	} else {
6044c609719bSwdenk		Create your own board support subdirectory;
60456c3fef28SJerry Van Baren		Create your own board include/configs/<myboard>.h file;
60466c3fef28SJerry Van Baren	}
60476c3fef28SJerry Van Baren	Edit new board/<myboard> files
60486c3fef28SJerry Van Baren	Edit new include/configs/<myboard>.h
6049c609719bSwdenk
60506c3fef28SJerry Van Baren	while (!accepted) {
6051c609719bSwdenk		while (!running) {
6052c609719bSwdenk			do {
6053c609719bSwdenk				Add / modify source code;
6054c609719bSwdenk			} until (compiles);
6055c609719bSwdenk			Debug;
6056c609719bSwdenk			if (clueless)
6057c609719bSwdenk				email("Hi, I am having problems...");
6058c609719bSwdenk		}
60596c3fef28SJerry Van Baren		Send patch file to the U-Boot email list;
60606c3fef28SJerry Van Baren		if (reasonable critiques)
60616c3fef28SJerry Van Baren			Incorporate improvements from email list code review;
60626c3fef28SJerry Van Baren		else
60636c3fef28SJerry Van Baren			Defend code as written;
60646c3fef28SJerry Van Baren	}
6065c609719bSwdenk
6066c609719bSwdenk	return 0;
6067c609719bSwdenk}
6068c609719bSwdenk
6069c609719bSwdenkvoid no_more_time (int sig)
6070c609719bSwdenk{
6071c609719bSwdenk      hire_a_guru();
6072c609719bSwdenk}
6073c609719bSwdenk
6074c609719bSwdenk
6075c609719bSwdenkCoding Standards:
6076c609719bSwdenk-----------------
6077c609719bSwdenk
6078c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel
60792c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script
60807ca9296eSWolfgang Denk"scripts/Lindent" in your Linux kernel source directory.
6081c609719bSwdenk
60822c051651SDetlev ZundelSource files originating from a different project (for example the
60832c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not
60842c051651SDetlev Zundelreformated to ease subsequent migration to newer versions of those
60852c051651SDetlev Zundelsources.
60862c051651SDetlev Zundel
60872c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in
60882c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//)
60892c051651SDetlev Zundelin your code.
6090c609719bSwdenk
6091c178d3daSwdenkPlease also stick to the following formatting rules:
6092180d3f74Swdenk- remove any trailing white space
60937ca9296eSWolfgang Denk- use TAB characters for indentation and vertical alignment, not spaces
6094180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds
60957ca9296eSWolfgang Denk- do not add more than 2 consecutive empty lines to source files
6096180d3f74Swdenk- do not add trailing empty lines to source files
6097180d3f74Swdenk
6098c609719bSwdenkSubmissions which do not conform to the standards may be returned
6099c609719bSwdenkwith a request to reformat the changes.
6100c609719bSwdenk
6101c609719bSwdenk
6102c609719bSwdenkSubmitting Patches:
6103c609719bSwdenk-------------------
6104c609719bSwdenk
6105c609719bSwdenkSince the number of patches for U-Boot is growing, we need to
6106c609719bSwdenkestablish some rules. Submissions which do not conform to these rules
6107c609719bSwdenkmay be rejected, even when they contain important and valuable stuff.
6108c609719bSwdenk
61090d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details.
6110218ca724SWolfgang Denk
61110668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
61120668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot
61130668236bSWolfgang Denk
6114c609719bSwdenkWhen you send a patch, please include the following information with
6115c609719bSwdenkit:
6116c609719bSwdenk
6117c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes
6118c609719bSwdenk  this bug. Please try to include a way of demonstrating that the
6119c609719bSwdenk  patch actually fixes something.
6120c609719bSwdenk
6121c609719bSwdenk* For new features: a description of the feature and your
6122c609719bSwdenk  implementation.
6123c609719bSwdenk
6124c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch)
6125c609719bSwdenk
6126c609719bSwdenk* For major contributions, your entry to the CREDITS file
6127c609719bSwdenk
612827af930eSAlbert ARIBAUD* When you add support for a new board, don't forget to add a
612927af930eSAlbert ARIBAUD  maintainer e-mail address to the boards.cfg file, too.
6130c609719bSwdenk
6131c609719bSwdenk* If your patch adds new configuration options, don't forget to
6132c609719bSwdenk  document these in the README file.
6133c609719bSwdenk
6134218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly*
6135218ca724SWolfgang Denk  recommended) you can easily generate the patch using the
61367ca9296eSWolfgang Denk  "git format-patch". If you then use "git send-email" to send it to
6137218ca724SWolfgang Denk  the U-Boot mailing list, you will avoid most of the common problems
6138218ca724SWolfgang Denk  with some other mail clients.
6139c609719bSwdenk
6140218ca724SWolfgang Denk  If you cannot use git, use "diff -purN OLD NEW". If your version of
6141218ca724SWolfgang Denk  diff does not support these options, then get the latest version of
6142218ca724SWolfgang Denk  GNU diff.
61436dff5529Swdenk
6144218ca724SWolfgang Denk  The current directory when running this command shall be the parent
6145218ca724SWolfgang Denk  directory of the U-Boot source tree (i. e. please make sure that
6146218ca724SWolfgang Denk  your patch includes sufficient directory information for the
6147218ca724SWolfgang Denk  affected files).
6148218ca724SWolfgang Denk
6149218ca724SWolfgang Denk  We prefer patches as plain text. MIME attachments are discouraged,
6150218ca724SWolfgang Denk  and compressed attachments must not be used.
6151c609719bSwdenk
615252f52c14Swdenk* If one logical set of modifications affects or creates several
615352f52c14Swdenk  files, all these changes shall be submitted in a SINGLE patch file.
615452f52c14Swdenk
615552f52c14Swdenk* Changesets that contain different, unrelated modifications shall be
615652f52c14Swdenk  submitted as SEPARATE patches, one patch per changeset.
615752f52c14Swdenk
615852f52c14Swdenk
6159c609719bSwdenkNotes:
6160c609719bSwdenk
6161c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched
6162c609719bSwdenk  source tree and make sure that no errors or warnings are reported
6163c609719bSwdenk  for any of the boards.
6164c609719bSwdenk
6165c609719bSwdenk* Keep your modifications to the necessary minimum: A patch
6166c609719bSwdenk  containing several unrelated changes or arbitrary reformats will be
6167c609719bSwdenk  returned with a request to re-formatting / split it.
6168c609719bSwdenk
6169c609719bSwdenk* If you modify existing code, make sure that your new code does not
6170c609719bSwdenk  add to the memory footprint of the code ;-) Small is beautiful!
6171c609719bSwdenk  When adding new features, these should compile conditionally only
6172c609719bSwdenk  (using #ifdef), and the resulting code with the new feature
6173c609719bSwdenk  disabled must not need more memory than the old code without your
6174c609719bSwdenk  modification.
617590dc6704Swdenk
61760668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the
61770668236bSWolfgang Denk  u-boot mailing list. Bigger patches will be moderated. If they are
61780668236bSWolfgang Denk  reasonable and not too big, they will be acknowledged. But patches
61790668236bSWolfgang Denk  bigger than the size limit should be avoided.
6180