xref: /openbmc/u-boot/README (revision 67193864bce78b38fda2c73b9918403d1c572fcc)
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
26775b3c3aaSSimon GlassSandbox Environment:
26875b3c3aaSSimon Glass--------------------
26975b3c3aaSSimon Glass
27075b3c3aaSSimon GlassU-Boot can be built natively to run on a Linux host using the 'sandbox'
27175b3c3aaSSimon Glassboard. This allows feature development which is not board- or architecture-
27275b3c3aaSSimon Glassspecific to be undertaken on a native platform. The sandbox is also used to
27375b3c3aaSSimon Glassrun some of U-Boot's tests.
27475b3c3aaSSimon Glass
27575b3c3aaSSimon GlassSee board/sandbox/sandbox/README.sandbox for more details.
27675b3c3aaSSimon Glass
27775b3c3aaSSimon Glass
278c609719bSwdenkConfiguration Options:
279c609719bSwdenk----------------------
280c609719bSwdenk
281c609719bSwdenkConfiguration depends on the combination of board and CPU type; all
282c609719bSwdenksuch information is kept in a configuration file
283c609719bSwdenk"include/configs/<board_name>.h".
284c609719bSwdenk
285c609719bSwdenkExample: For a TQM823L module, all configuration settings are in
286c609719bSwdenk"include/configs/TQM823L.h".
287c609719bSwdenk
288c609719bSwdenk
2897f6c2cbcSwdenkMany of the options are named exactly as the corresponding Linux
2907f6c2cbcSwdenkkernel configuration options. The intention is to make it easier to
2917f6c2cbcSwdenkbuild a config tool - later.
2927f6c2cbcSwdenk
2937f6c2cbcSwdenk
294c609719bSwdenkThe following options need to be configured:
295c609719bSwdenk
2962628114eSKim Phillips- CPU Type:	Define exactly one, e.g. CONFIG_MPC85XX.
297c609719bSwdenk
2982628114eSKim Phillips- Board Type:	Define exactly one, e.g. CONFIG_MPC8540ADS.
2996ccec449SWolfgang Denk
3006ccec449SWolfgang Denk- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
30109ea0de0SHaavard Skinnemoen		Define exactly one, e.g. CONFIG_ATSTK1002
302c609719bSwdenk
303c609719bSwdenk- CPU Module Type: (if CONFIG_COGENT is defined)
304c609719bSwdenk		Define exactly one of
305c609719bSwdenk		CONFIG_CMA286_60_OLD
306c609719bSwdenk--- FIXME --- not tested yet:
307c609719bSwdenk		CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
308c609719bSwdenk		CONFIG_CMA287_23, CONFIG_CMA287_50
309c609719bSwdenk
310c609719bSwdenk- Motherboard Type: (if CONFIG_COGENT is defined)
311c609719bSwdenk		Define exactly one of
312c609719bSwdenk		CONFIG_CMA101, CONFIG_CMA102
313c609719bSwdenk
314c609719bSwdenk- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
315c609719bSwdenk		Define one or more of
316c609719bSwdenk		CONFIG_CMA302
317c609719bSwdenk
318c609719bSwdenk- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
319c609719bSwdenk		Define one or more of
320c609719bSwdenk		CONFIG_LCD_HEARTBEAT	- update a character position on
32111ccc33fSMarcel Ziswiler					  the LCD display every second with
322c609719bSwdenk					  a "rotator" |\-/|\-/
323c609719bSwdenk
3242535d602Swdenk- Board flavour: (if CONFIG_MPC8260ADS is defined)
3252535d602Swdenk		CONFIG_ADSTYPE
3262535d602Swdenk		Possible values are:
3276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8260ADS	- original MPC8260ADS
3286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8266ADS	- MPC8266ADS
3296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_PQ2FADS	- PQ2FADS-ZU or PQ2FADS-VR
3306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8272ADS	- MPC8272ADS
3312535d602Swdenk
332cf946c6dSLei Wen- Marvell Family Member
333cf946c6dSLei Wen		CONFIG_SYS_MVFS		- define it if you want to enable
334cf946c6dSLei Wen					  multiple fs option at one time
335cf946c6dSLei Wen					  for marvell soc family
336cf946c6dSLei Wen
337c609719bSwdenk- MPC824X Family Member (if CONFIG_MPC824X is defined)
338c609719bSwdenk		Define exactly one of
339c609719bSwdenk		CONFIG_MPC8240, CONFIG_MPC8245
340c609719bSwdenk
34111ccc33fSMarcel Ziswiler- 8xx CPU Options: (if using an MPC8xx CPU)
34266ca92a5Swdenk		CONFIG_8xx_GCLK_FREQ	- deprecated: CPU clock if
34366ca92a5Swdenk					  get_gclk_freq() cannot work
3445da627a4Swdenk					  e.g. if there is no 32KHz
3455da627a4Swdenk					  reference PIT/RTC clock
34666ca92a5Swdenk		CONFIG_8xx_OSCLK	- PLL input clock (either EXTCLK
34766ca92a5Swdenk					  or XTAL/EXTAL)
348c609719bSwdenk
34966ca92a5Swdenk- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
3506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MIN
3516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MAX
35266ca92a5Swdenk		CONFIG_8xx_CPUCLK_DEFAULT
35375d1ea7fSwdenk			See doc/README.MPC866
35475d1ea7fSwdenk
3556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MEASURE_CPUCLK
35675d1ea7fSwdenk
35775d1ea7fSwdenk		Define this to measure the actual CPU clock instead
35875d1ea7fSwdenk		of relying on the correctness of the configured
35975d1ea7fSwdenk		values. Mostly useful for board bringup to make sure
36075d1ea7fSwdenk		the PLL is locked at the intended frequency. Note
36175d1ea7fSwdenk		that this requires a (stable) reference clock (32 kHz
3626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		RTC clock or CONFIG_SYS_8XX_XIN)
36375d1ea7fSwdenk
364506f3918SHeiko Schocher		CONFIG_SYS_DELAYED_ICACHE
365506f3918SHeiko Schocher
366506f3918SHeiko Schocher		Define this option if you want to enable the
367506f3918SHeiko Schocher		ICache only when Code runs from RAM.
368506f3918SHeiko Schocher
36966412c63SKumar Gala- 85xx CPU Options:
370ffd06e02SYork Sun		CONFIG_SYS_PPC64
371ffd06e02SYork Sun
372ffd06e02SYork Sun		Specifies that the core is a 64-bit PowerPC implementation (implements
373ffd06e02SYork Sun		the "64" category of the Power ISA). This is necessary for ePAPR
374ffd06e02SYork Sun		compliance, among other possible reasons.
375ffd06e02SYork Sun
37666412c63SKumar Gala		CONFIG_SYS_FSL_TBCLK_DIV
37766412c63SKumar Gala
37866412c63SKumar Gala		Defines the core time base clock divider ratio compared to the
37966412c63SKumar Gala		system clock.  On most PQ3 devices this is 8, on newer QorIQ
38066412c63SKumar Gala		devices it can be 16 or 32.  The ratio varies from SoC to Soc.
38166412c63SKumar Gala
3828f29084aSKumar Gala		CONFIG_SYS_FSL_PCIE_COMPAT
3838f29084aSKumar Gala
3848f29084aSKumar Gala		Defines the string to utilize when trying to match PCIe device
3858f29084aSKumar Gala		tree nodes for the given platform.
3868f29084aSKumar Gala
387afa6b551SPrabhakar Kushwaha		CONFIG_SYS_PPC_E500_DEBUG_TLB
388afa6b551SPrabhakar Kushwaha
389afa6b551SPrabhakar Kushwaha		Enables a temporary TLB entry to be used during boot to work
390afa6b551SPrabhakar Kushwaha		around limitations in e500v1 and e500v2 external debugger
391afa6b551SPrabhakar Kushwaha		support. This reduces the portions of the boot code where
392afa6b551SPrabhakar Kushwaha		breakpoints and single stepping do not work.  The value of this
393afa6b551SPrabhakar Kushwaha		symbol should be set to the TLB1 entry to be used for this
394afa6b551SPrabhakar Kushwaha		purpose.
395afa6b551SPrabhakar Kushwaha
39633eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510
39733eee330SScott Wood
39833eee330SScott Wood		Enables a workaround for erratum A004510.  If set,
39933eee330SScott Wood		then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
40033eee330SScott Wood		CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
40133eee330SScott Wood
40233eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
40333eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
40433eee330SScott Wood
40533eee330SScott Wood		Defines one or two SoC revisions (low 8 bits of SVR)
40633eee330SScott Wood		for which the A004510 workaround should be applied.
40733eee330SScott Wood
40833eee330SScott Wood		The rest of SVR is either not relevant to the decision
40933eee330SScott Wood		of whether the erratum is present (e.g. p2040 versus
41033eee330SScott Wood		p2041) or is implied by the build target, which controls
41133eee330SScott Wood		whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
41233eee330SScott Wood
41333eee330SScott Wood		See Freescale App Note 4493 for more information about
41433eee330SScott Wood		this erratum.
41533eee330SScott Wood
41674fa22edSPrabhakar Kushwaha		CONFIG_A003399_NOR_WORKAROUND
41774fa22edSPrabhakar Kushwaha		Enables a workaround for IFC erratum A003399. It is only
41874fa22edSPrabhakar Kushwaha		requred during NOR boot.
41974fa22edSPrabhakar Kushwaha
42033eee330SScott Wood		CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
42133eee330SScott Wood
42233eee330SScott Wood		This is the value to write into CCSR offset 0x18600
42333eee330SScott Wood		according to the A004510 workaround.
42433eee330SScott Wood
42564501c66SPriyanka Jain		CONFIG_SYS_FSL_DSP_DDR_ADDR
42664501c66SPriyanka Jain		This value denotes start offset of DDR memory which is
42764501c66SPriyanka Jain		connected exclusively to the DSP cores.
42864501c66SPriyanka Jain
429765b0bdbSPriyanka Jain		CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
430765b0bdbSPriyanka Jain		This value denotes start offset of M2 memory
431765b0bdbSPriyanka Jain		which is directly connected to the DSP core.
432765b0bdbSPriyanka Jain
43364501c66SPriyanka Jain		CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
43464501c66SPriyanka Jain		This value denotes start offset of M3 memory which is directly
43564501c66SPriyanka Jain		connected to the DSP core.
43664501c66SPriyanka Jain
437765b0bdbSPriyanka Jain		CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
438765b0bdbSPriyanka Jain		This value denotes start offset of DSP CCSR space.
439765b0bdbSPriyanka Jain
440b135991aSPriyanka Jain		CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
441b135991aSPriyanka Jain		Single Source Clock is clocking mode present in some of FSL SoC's.
442b135991aSPriyanka Jain		In this mode, a single differential clock is used to supply
443b135991aSPriyanka Jain		clocks to the sysclock, ddrclock and usbclock.
444b135991aSPriyanka Jain
445fb4a2409SAneesh Bansal		CONFIG_SYS_CPC_REINIT_F
446fb4a2409SAneesh Bansal		This CONFIG is defined when the CPC is configured as SRAM at the
447fb4a2409SAneesh Bansal		time of U-boot entry and is required to be re-initialized.
448fb4a2409SAneesh Bansal
449aade2004STang Yuantian		CONFIG_DEEP_SLEEP
450aade2004STang Yuantian		Inidcates this SoC supports deep sleep feature. If deep sleep is
451aade2004STang Yuantian		supported, core will start to execute uboot when wakes up.
452aade2004STang Yuantian
4536cb461b4SDaniel Schwierzeck- Generic CPU options:
4542a1680e3SYork Sun		CONFIG_SYS_GENERIC_GLOBAL_DATA
4552a1680e3SYork Sun		Defines global data is initialized in generic board board_init_f().
4562a1680e3SYork Sun		If this macro is defined, global data is created and cleared in
4572a1680e3SYork Sun		generic board board_init_f(). Without this macro, architecture/board
4582a1680e3SYork Sun		should initialize global data before calling board_init_f().
4592a1680e3SYork Sun
4606cb461b4SDaniel Schwierzeck		CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
4616cb461b4SDaniel Schwierzeck
4626cb461b4SDaniel Schwierzeck		Defines the endianess of the CPU. Implementation of those
4636cb461b4SDaniel Schwierzeck		values is arch specific.
4646cb461b4SDaniel Schwierzeck
4655614e71bSYork Sun		CONFIG_SYS_FSL_DDR
4665614e71bSYork Sun		Freescale DDR driver in use. This type of DDR controller is
4675614e71bSYork Sun		found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
4685614e71bSYork Sun		SoCs.
4695614e71bSYork Sun
4705614e71bSYork Sun		CONFIG_SYS_FSL_DDR_ADDR
4715614e71bSYork Sun		Freescale DDR memory-mapped register base.
4725614e71bSYork Sun
4735614e71bSYork Sun		CONFIG_SYS_FSL_DDR_EMU
4745614e71bSYork Sun		Specify emulator support for DDR. Some DDR features such as
4755614e71bSYork Sun		deskew training are not available.
4765614e71bSYork Sun
4775614e71bSYork Sun		CONFIG_SYS_FSL_DDRC_GEN1
4785614e71bSYork Sun		Freescale DDR1 controller.
4795614e71bSYork Sun
4805614e71bSYork Sun		CONFIG_SYS_FSL_DDRC_GEN2
4815614e71bSYork Sun		Freescale DDR2 controller.
4825614e71bSYork Sun
4835614e71bSYork Sun		CONFIG_SYS_FSL_DDRC_GEN3
4845614e71bSYork Sun		Freescale DDR3 controller.
4855614e71bSYork Sun
48634e026f9SYork Sun		CONFIG_SYS_FSL_DDRC_GEN4
48734e026f9SYork Sun		Freescale DDR4 controller.
48834e026f9SYork Sun
4899ac4ffbdSYork Sun		CONFIG_SYS_FSL_DDRC_ARM_GEN3
4909ac4ffbdSYork Sun		Freescale DDR3 controller for ARM-based SoCs.
4919ac4ffbdSYork Sun
4925614e71bSYork Sun		CONFIG_SYS_FSL_DDR1
4935614e71bSYork Sun		Board config to use DDR1. It can be enabled for SoCs with
4945614e71bSYork Sun		Freescale DDR1 or DDR2 controllers, depending on the board
4955614e71bSYork Sun		implemetation.
4965614e71bSYork Sun
4975614e71bSYork Sun		CONFIG_SYS_FSL_DDR2
4985614e71bSYork Sun		Board config to use DDR2. It can be eanbeld for SoCs with
4995614e71bSYork Sun		Freescale DDR2 or DDR3 controllers, depending on the board
5005614e71bSYork Sun		implementation.
5015614e71bSYork Sun
5025614e71bSYork Sun		CONFIG_SYS_FSL_DDR3
5035614e71bSYork Sun		Board config to use DDR3. It can be enabled for SoCs with
50434e026f9SYork Sun		Freescale DDR3 or DDR3L controllers.
50534e026f9SYork Sun
50634e026f9SYork Sun		CONFIG_SYS_FSL_DDR3L
50734e026f9SYork Sun		Board config to use DDR3L. It can be enabled for SoCs with
50834e026f9SYork Sun		DDR3L controllers.
50934e026f9SYork Sun
51034e026f9SYork Sun		CONFIG_SYS_FSL_DDR4
51134e026f9SYork Sun		Board config to use DDR4. It can be enabled for SoCs with
51234e026f9SYork Sun		DDR4 controllers.
5135614e71bSYork Sun
5141b4175d6SPrabhakar Kushwaha		CONFIG_SYS_FSL_IFC_BE
5151b4175d6SPrabhakar Kushwaha		Defines the IFC controller register space as Big Endian
5161b4175d6SPrabhakar Kushwaha
5171b4175d6SPrabhakar Kushwaha		CONFIG_SYS_FSL_IFC_LE
5181b4175d6SPrabhakar Kushwaha		Defines the IFC controller register space as Little Endian
5191b4175d6SPrabhakar Kushwaha
520690e4258SPrabhakar Kushwaha		CONFIG_SYS_FSL_PBL_PBI
521690e4258SPrabhakar Kushwaha		It enables addition of RCW (Power on reset configuration) in built image.
522690e4258SPrabhakar Kushwaha		Please refer doc/README.pblimage for more details
523690e4258SPrabhakar Kushwaha
524690e4258SPrabhakar Kushwaha		CONFIG_SYS_FSL_PBL_RCW
525690e4258SPrabhakar Kushwaha		It adds PBI(pre-boot instructions) commands in u-boot build image.
526690e4258SPrabhakar Kushwaha		PBI commands can be used to configure SoC before it starts the execution.
527690e4258SPrabhakar Kushwaha		Please refer doc/README.pblimage for more details
528690e4258SPrabhakar Kushwaha
52989ad7be8SPrabhakar Kushwaha		CONFIG_SPL_FSL_PBL
53089ad7be8SPrabhakar Kushwaha		It adds a target to create boot binary having SPL binary in PBI format
53189ad7be8SPrabhakar Kushwaha		concatenated with u-boot binary.
53289ad7be8SPrabhakar Kushwaha
5334e5b1bd0SYork Sun		CONFIG_SYS_FSL_DDR_BE
5344e5b1bd0SYork Sun		Defines the DDR controller register space as Big Endian
5354e5b1bd0SYork Sun
5364e5b1bd0SYork Sun		CONFIG_SYS_FSL_DDR_LE
5374e5b1bd0SYork Sun		Defines the DDR controller register space as Little Endian
5384e5b1bd0SYork Sun
5396b9e309aSYork Sun		CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
5406b9e309aSYork Sun		Physical address from the view of DDR controllers. It is the
5416b9e309aSYork Sun		same as CONFIG_SYS_DDR_SDRAM_BASE for  all Power SoCs. But
5426b9e309aSYork Sun		it could be different for ARM SoCs.
5436b9e309aSYork Sun
5446b1e1254SYork Sun		CONFIG_SYS_FSL_DDR_INTLV_256B
5456b1e1254SYork Sun		DDR controller interleaving on 256-byte. This is a special
5466b1e1254SYork Sun		interleaving mode, handled by Dickens for Freescale layerscape
5476b1e1254SYork Sun		SoCs with ARM core.
5486b1e1254SYork Sun
5490b953ffcSMarkus Klotzbuecher- Intel Monahans options:
5506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
5510b953ffcSMarkus Klotzbuecher
5520b953ffcSMarkus Klotzbuecher		Defines the Monahans run mode to oscillator
5530b953ffcSMarkus Klotzbuecher		ratio. Valid values are 8, 16, 24, 31. The core
5540b953ffcSMarkus Klotzbuecher		frequency is this value multiplied by 13 MHz.
5550b953ffcSMarkus Klotzbuecher
5566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
5570b953ffcSMarkus Klotzbuecher
5580b953ffcSMarkus Klotzbuecher		Defines the Monahans turbo mode to oscillator
5590b953ffcSMarkus Klotzbuecher		ratio. Valid values are 1 (default if undefined) and
5600b953ffcSMarkus Klotzbuecher		2. The core frequency as calculated above is multiplied
5610b953ffcSMarkus Klotzbuecher		by this value.
5620b953ffcSMarkus Klotzbuecher
56392bbd64eSDaniel Schwierzeck- MIPS CPU options:
56492bbd64eSDaniel Schwierzeck		CONFIG_SYS_INIT_SP_OFFSET
56592bbd64eSDaniel Schwierzeck
56692bbd64eSDaniel Schwierzeck		Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
56792bbd64eSDaniel Schwierzeck		pointer. This is needed for the temporary stack before
56892bbd64eSDaniel Schwierzeck		relocation.
56992bbd64eSDaniel Schwierzeck
57092bbd64eSDaniel Schwierzeck		CONFIG_SYS_MIPS_CACHE_MODE
57192bbd64eSDaniel Schwierzeck
57292bbd64eSDaniel Schwierzeck		Cache operation mode for the MIPS CPU.
57392bbd64eSDaniel Schwierzeck		See also arch/mips/include/asm/mipsregs.h.
57492bbd64eSDaniel Schwierzeck		Possible values are:
57592bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_NO_WA
57692bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_WA
57792bbd64eSDaniel Schwierzeck			CONF_CM_UNCACHED
57892bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_NONCOHERENT
57992bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_CE
58092bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_COW
58192bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_CUW
58292bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_ACCELERATED
58392bbd64eSDaniel Schwierzeck
58492bbd64eSDaniel Schwierzeck		CONFIG_SYS_XWAY_EBU_BOOTCFG
58592bbd64eSDaniel Schwierzeck
58692bbd64eSDaniel Schwierzeck		Special option for Lantiq XWAY SoCs for booting from NOR flash.
58792bbd64eSDaniel Schwierzeck		See also arch/mips/cpu/mips32/start.S.
58892bbd64eSDaniel Schwierzeck
58992bbd64eSDaniel Schwierzeck		CONFIG_XWAY_SWAP_BYTES
59092bbd64eSDaniel Schwierzeck
59192bbd64eSDaniel Schwierzeck		Enable compilation of tools/xway-swap-bytes needed for Lantiq
59292bbd64eSDaniel Schwierzeck		XWAY SoCs for booting from NOR flash. The U-Boot image needs to
59392bbd64eSDaniel Schwierzeck		be swapped if a flash programmer is used.
59492bbd64eSDaniel Schwierzeck
595b67d8816SChristian Riesch- ARM options:
596b67d8816SChristian Riesch		CONFIG_SYS_EXCEPTION_VECTORS_HIGH
597b67d8816SChristian Riesch
598b67d8816SChristian Riesch		Select high exception vectors of the ARM core, e.g., do not
599b67d8816SChristian Riesch		clear the V bit of the c1 register of CP15.
600b67d8816SChristian Riesch
6015356f545SAneesh V		CONFIG_SYS_THUMB_BUILD
6025356f545SAneesh V
6035356f545SAneesh V		Use this flag to build U-Boot using the Thumb instruction
6045356f545SAneesh V		set for ARM architectures. Thumb instruction set provides
6055356f545SAneesh V		better code density. For ARM architectures that support
6065356f545SAneesh V		Thumb2 this flag will result in Thumb2 code generated by
6075356f545SAneesh V		GCC.
6085356f545SAneesh V
609c5d4752cSStephen Warren		CONFIG_ARM_ERRATA_716044
6100678587fSStephen Warren		CONFIG_ARM_ERRATA_742230
6110678587fSStephen Warren		CONFIG_ARM_ERRATA_743622
6120678587fSStephen Warren		CONFIG_ARM_ERRATA_751472
613f71cbfe3SNitin Garg		CONFIG_ARM_ERRATA_794072
614b7588e3bSNitin Garg		CONFIG_ARM_ERRATA_761320
6150678587fSStephen Warren
6160678587fSStephen Warren		If set, the workarounds for these ARM errata are applied early
6170678587fSStephen Warren		during U-Boot startup. Note that these options force the
6180678587fSStephen Warren		workarounds to be applied; no CPU-type/version detection
6190678587fSStephen Warren		exists, unlike the similar options in the Linux kernel. Do not
6200678587fSStephen Warren		set these options unless they apply!
6210678587fSStephen Warren
622795659dcSStephen Warren- CPU timer options:
623795659dcSStephen Warren		CONFIG_SYS_HZ
624795659dcSStephen Warren
625795659dcSStephen Warren		The frequency of the timer returned by get_timer().
626795659dcSStephen Warren		get_timer() must operate in milliseconds and this CONFIG
627795659dcSStephen Warren		option must be set to 1000.
628795659dcSStephen Warren
6295da627a4Swdenk- Linux Kernel Interface:
630c609719bSwdenk		CONFIG_CLOCKS_IN_MHZ
631c609719bSwdenk
632c609719bSwdenk		U-Boot stores all clock information in Hz
633c609719bSwdenk		internally. For binary compatibility with older Linux
634c609719bSwdenk		kernels (which expect the clocks passed in the
635c609719bSwdenk		bd_info data to be in MHz) the environment variable
636c609719bSwdenk		"clocks_in_mhz" can be defined so that U-Boot
637c609719bSwdenk		converts clock data to MHZ before passing it to the
638c609719bSwdenk		Linux kernel.
639c609719bSwdenk		When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
640c609719bSwdenk		"clocks_in_mhz=1" is automatically included in the
641c609719bSwdenk		default environment.
642c609719bSwdenk
6435da627a4Swdenk		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]
6445da627a4Swdenk
64511ccc33fSMarcel Ziswiler		When transferring memsize parameter to linux, some versions
6465da627a4Swdenk		expect it to be in bytes, others in MB.
6475da627a4Swdenk		Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
6485da627a4Swdenk
649fec6d9eeSGerald Van Baren		CONFIG_OF_LIBFDT
650f57f70aaSWolfgang Denk
651f57f70aaSWolfgang Denk		New kernel versions are expecting firmware settings to be
652213bf8c8SGerald Van Baren		passed using flattened device trees (based on open firmware
653213bf8c8SGerald Van Baren		concepts).
654213bf8c8SGerald Van Baren
655213bf8c8SGerald Van Baren		CONFIG_OF_LIBFDT
656213bf8c8SGerald Van Baren		 * New libfdt-based support
657213bf8c8SGerald Van Baren		 * Adds the "fdt" command
6583bb342fcSKim Phillips		 * The bootm command automatically updates the fdt
659213bf8c8SGerald Van Baren
660b55ae402SMarcel Ziswiler		OF_CPU - The proper name of the cpus node (only required for
661b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
662b55ae402SMarcel Ziswiler		OF_SOC - The proper name of the soc node (only required for
663b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
664f57f70aaSWolfgang Denk		OF_TBCLK - The timebase frequency.
665c2871f03SKumar Gala		OF_STDOUT_PATH - The path to the console device
666f57f70aaSWolfgang Denk
66711ccc33fSMarcel Ziswiler		boards with QUICC Engines require OF_QE to set UCC MAC
66811ccc33fSMarcel Ziswiler		addresses
6693bb342fcSKim Phillips
6704e253137SKumar Gala		CONFIG_OF_BOARD_SETUP
6714e253137SKumar Gala
6724e253137SKumar Gala		Board code has addition modification that it wants to make
6734e253137SKumar Gala		to the flat device tree before handing it off to the kernel
6746705d81eSwdenk
6750267768eSMatthew McClintock		CONFIG_OF_BOOT_CPU
6760267768eSMatthew McClintock
67711ccc33fSMarcel Ziswiler		This define fills in the correct boot CPU in the boot
6780267768eSMatthew McClintock		param header, the default value is zero if undefined.
6790267768eSMatthew McClintock
6803887c3fbSHeiko Schocher		CONFIG_OF_IDE_FIXUP
6813887c3fbSHeiko Schocher
6823887c3fbSHeiko Schocher		U-Boot can detect if an IDE device is present or not.
6833887c3fbSHeiko Schocher		If not, and this new config option is activated, U-Boot
6843887c3fbSHeiko Schocher		removes the ATA node from the DTS before booting Linux,
6853887c3fbSHeiko Schocher		so the Linux IDE driver does not probe the device and
6863887c3fbSHeiko Schocher		crash. This is needed for buggy hardware (uc101) where
6873887c3fbSHeiko Schocher		no pull down resistor is connected to the signal IDE5V_DD7.
6883887c3fbSHeiko Schocher
6897eb29398SIgor Grinberg		CONFIG_MACH_TYPE	[relevant for ARM only][mandatory]
6907eb29398SIgor Grinberg
6917eb29398SIgor Grinberg		This setting is mandatory for all boards that have only one
6927eb29398SIgor Grinberg		machine type and must be used to specify the machine type
6937eb29398SIgor Grinberg		number as it appears in the ARM machine registry
6947eb29398SIgor Grinberg		(see http://www.arm.linux.org.uk/developer/machines/).
6957eb29398SIgor Grinberg		Only boards that have multiple machine types supported
6967eb29398SIgor Grinberg		in a single configuration file and the machine type is
6977eb29398SIgor Grinberg		runtime discoverable, do not have to use this setting.
6987eb29398SIgor Grinberg
6990b2f4ecaSNiklaus Giger- vxWorks boot parameters:
7000b2f4ecaSNiklaus Giger
7010b2f4ecaSNiklaus Giger		bootvx constructs a valid bootline using the following
7020b2f4ecaSNiklaus Giger		environments variables: bootfile, ipaddr, serverip, hostname.
7030b2f4ecaSNiklaus Giger		It loads the vxWorks image pointed bootfile.
7040b2f4ecaSNiklaus Giger
7050b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
7060b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
7070b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
7080b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
7090b2f4ecaSNiklaus Giger
7100b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_ADD_PARAMS
7110b2f4ecaSNiklaus Giger
7120b2f4ecaSNiklaus Giger		Add it at the end of the bootline. E.g "u=username pw=secret"
7130b2f4ecaSNiklaus Giger
7140b2f4ecaSNiklaus Giger		Note: If a "bootargs" environment is defined, it will overwride
7150b2f4ecaSNiklaus Giger		the defaults discussed just above.
7160b2f4ecaSNiklaus Giger
7172c451f78SAneesh V- Cache Configuration:
7182c451f78SAneesh V		CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
7192c451f78SAneesh V		CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
7202c451f78SAneesh V		CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
7212c451f78SAneesh V
72293bc2193SAneesh V- Cache Configuration for ARM:
72393bc2193SAneesh V		CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
72493bc2193SAneesh V				      controller
72593bc2193SAneesh V		CONFIG_SYS_PL310_BASE - Physical base address of PL310
72693bc2193SAneesh V					controller register space
72793bc2193SAneesh V
7286705d81eSwdenk- Serial Ports:
72948d0192fSAndreas Engel		CONFIG_PL010_SERIAL
7306705d81eSwdenk
7316705d81eSwdenk		Define this if you want support for Amba PrimeCell PL010 UARTs.
7326705d81eSwdenk
73348d0192fSAndreas Engel		CONFIG_PL011_SERIAL
7346705d81eSwdenk
7356705d81eSwdenk		Define this if you want support for Amba PrimeCell PL011 UARTs.
7366705d81eSwdenk
7376705d81eSwdenk		CONFIG_PL011_CLOCK
7386705d81eSwdenk
7396705d81eSwdenk		If you have Amba PrimeCell PL011 UARTs, set this variable to
7406705d81eSwdenk		the clock speed of the UARTs.
7416705d81eSwdenk
7426705d81eSwdenk		CONFIG_PL01x_PORTS
7436705d81eSwdenk
7446705d81eSwdenk		If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
7456705d81eSwdenk		define this to a list of base addresses for each (supported)
7466705d81eSwdenk		port. See e.g. include/configs/versatile.h
7476705d81eSwdenk
748910f1ae3SJohn Rigby		CONFIG_PL011_SERIAL_RLCR
749910f1ae3SJohn Rigby
750910f1ae3SJohn Rigby		Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
751910f1ae3SJohn Rigby		have separate receive and transmit line control registers.  Set
752910f1ae3SJohn Rigby		this variable to initialize the extra register.
753910f1ae3SJohn Rigby
754910f1ae3SJohn Rigby		CONFIG_PL011_SERIAL_FLUSH_ON_INIT
755910f1ae3SJohn Rigby
756910f1ae3SJohn Rigby		On some platforms (e.g. U8500) U-Boot is loaded by a second stage
757910f1ae3SJohn Rigby		boot loader that has already initialized the UART.  Define this
758910f1ae3SJohn Rigby		variable to flush the UART at init time.
759910f1ae3SJohn Rigby
760d57dee57SKaricheri, Muralidharan		CONFIG_SERIAL_HW_FLOW_CONTROL
761d57dee57SKaricheri, Muralidharan
762d57dee57SKaricheri, Muralidharan		Define this variable to enable hw flow control in serial driver.
763d57dee57SKaricheri, Muralidharan		Current user of this option is drivers/serial/nsl16550.c driver
7646705d81eSwdenk
765c609719bSwdenk- Console Interface:
766c609719bSwdenk		Depending on board, define exactly one serial port
767c609719bSwdenk		(like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
768c609719bSwdenk		CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
769c609719bSwdenk		console by defining CONFIG_8xx_CONS_NONE
770c609719bSwdenk
771c609719bSwdenk		Note: if CONFIG_8xx_CONS_NONE is defined, the serial
772c609719bSwdenk		port routines must be defined elsewhere
773c609719bSwdenk		(i.e. serial_init(), serial_getc(), ...)
774c609719bSwdenk
775c609719bSwdenk		CONFIG_CFB_CONSOLE
776c609719bSwdenk		Enables console device for a color framebuffer. Needs following
777c53043b7SWolfgang Denk		defines (cf. smiLynxEM, i8042)
778c609719bSwdenk			VIDEO_FB_LITTLE_ENDIAN	graphic memory organisation
779c609719bSwdenk						(default big endian)
780c609719bSwdenk			VIDEO_HW_RECTFILL	graphic chip supports
781c609719bSwdenk						rectangle fill
782c609719bSwdenk						(cf. smiLynxEM)
783c609719bSwdenk			VIDEO_HW_BITBLT		graphic chip supports
784c609719bSwdenk						bit-blit (cf. smiLynxEM)
785c609719bSwdenk			VIDEO_VISIBLE_COLS	visible pixel columns
786c609719bSwdenk						(cols=pitch)
787c609719bSwdenk			VIDEO_VISIBLE_ROWS	visible pixel rows
788c609719bSwdenk			VIDEO_PIXEL_SIZE	bytes per pixel
789c609719bSwdenk			VIDEO_DATA_FORMAT	graphic data format
790c609719bSwdenk						(0-5, cf. cfb_console.c)
791c609719bSwdenk			VIDEO_FB_ADRS		framebuffer address
792c609719bSwdenk			VIDEO_KBD_INIT_FCT	keyboard int fct
793c609719bSwdenk						(i.e. i8042_kbd_init())
794c609719bSwdenk			VIDEO_TSTC_FCT		test char fct
795c609719bSwdenk						(i.e. i8042_tstc)
796c609719bSwdenk			VIDEO_GETC_FCT		get char fct
797c609719bSwdenk						(i.e. i8042_getc)
798c609719bSwdenk			CONFIG_CONSOLE_CURSOR	cursor drawing on/off
799c609719bSwdenk						(requires blink timer
800c609719bSwdenk						cf. i8042.c)
8016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
802c609719bSwdenk			CONFIG_CONSOLE_TIME	display time/date info in
803c609719bSwdenk						upper right corner
804602ad3b3SJon Loeliger						(requires CONFIG_CMD_DATE)
805c609719bSwdenk			CONFIG_VIDEO_LOGO	display Linux logo in
806c609719bSwdenk						upper left corner
807a6c7ad2fSwdenk			CONFIG_VIDEO_BMP_LOGO	use bmp_logo.h instead of
808a6c7ad2fSwdenk						linux_logo.h for logo.
809a6c7ad2fSwdenk						Requires CONFIG_VIDEO_LOGO
810c609719bSwdenk			CONFIG_CONSOLE_EXTRA_INFO
81111ccc33fSMarcel Ziswiler						additional board info beside
812c609719bSwdenk						the logo
813c609719bSwdenk
81433a35bbbSPali Rohár		When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
81533a35bbbSPali Rohár		a limited number of ANSI escape sequences (cursor control,
81633a35bbbSPali Rohár		erase functions and limited graphics rendition control).
81733a35bbbSPali Rohár
818c609719bSwdenk		When CONFIG_CFB_CONSOLE is defined, video console is
819c609719bSwdenk		default i/o. Serial console can be forced with
820c609719bSwdenk		environment 'console=serial'.
821c609719bSwdenk
822a3ad8e26Swdenk		When CONFIG_SILENT_CONSOLE is defined, all console
823a3ad8e26Swdenk		messages (by U-Boot and Linux!) can be silenced with
824a3ad8e26Swdenk		the "silent" environment variable. See
825a3ad8e26Swdenk		doc/README.silent for more information.
826a3ad8e26Swdenk
82745ae2546SHeiko Schocher		CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default
82845ae2546SHeiko Schocher			is 0x00.
82945ae2546SHeiko Schocher		CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default
83045ae2546SHeiko Schocher			is 0xa0.
83145ae2546SHeiko Schocher
832c609719bSwdenk- Console Baudrate:
833c609719bSwdenk		CONFIG_BAUDRATE - in bps
834c609719bSwdenk		Select one of the baudrates listed in
8356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
8366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
837c609719bSwdenk
838c92fac91SHeiko Schocher- Console Rx buffer length
839c92fac91SHeiko Schocher		With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
840c92fac91SHeiko Schocher		the maximum receive buffer length for the SMC.
8412b3f12c2SHeiko Schocher		This option is actual only for 82xx and 8xx possible.
842c92fac91SHeiko Schocher		If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
843c92fac91SHeiko Schocher		must be defined, to setup the maximum idle timeout for
844c92fac91SHeiko Schocher		the SMC.
845c92fac91SHeiko Schocher
8469558b48aSGraeme Russ- Pre-Console Buffer:
8479558b48aSGraeme Russ		Prior to the console being initialised (i.e. serial UART
8489558b48aSGraeme Russ		initialised etc) all console output is silently discarded.
8499558b48aSGraeme Russ		Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
8509558b48aSGraeme Russ		buffer any console messages prior to the console being
8519558b48aSGraeme Russ		initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
8529558b48aSGraeme Russ		bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
8539558b48aSGraeme Russ		a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
8549558b48aSGraeme Russ		bytes are output before the console is initialised, the
8559558b48aSGraeme Russ		earlier bytes are discarded.
8569558b48aSGraeme Russ
8579558b48aSGraeme Russ		'Sane' compilers will generate smaller code if
8589558b48aSGraeme Russ		CONFIG_PRE_CON_BUF_SZ is a power of 2
8599558b48aSGraeme Russ
860046a37bdSSonny Rao- Safe printf() functions
861046a37bdSSonny Rao		Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
862046a37bdSSonny Rao		the printf() functions. These are defined in
863046a37bdSSonny Rao		include/vsprintf.h and include snprintf(), vsnprintf() and
864046a37bdSSonny Rao		so on. Code size increase is approximately 300-500 bytes.
865046a37bdSSonny Rao		If this option is not given then these functions will
866046a37bdSSonny Rao		silently discard their buffer size argument - this means
867046a37bdSSonny Rao		you are not getting any overflow checking in this case.
868046a37bdSSonny Rao
869c609719bSwdenk- Boot Delay:	CONFIG_BOOTDELAY - in seconds
870c609719bSwdenk		Delay before automatically booting the default image;
871c609719bSwdenk		set to -1 to disable autoboot.
87293d7212fSJoe Hershberger		set to -2 to autoboot with no delay and not check for abort
87393d7212fSJoe Hershberger		(even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
874c609719bSwdenk
875c609719bSwdenk		See doc/README.autoboot for these options that
876c609719bSwdenk		work with CONFIG_BOOTDELAY. None are required.
877c609719bSwdenk		CONFIG_BOOT_RETRY_TIME
878c609719bSwdenk		CONFIG_BOOT_RETRY_MIN
879c609719bSwdenk		CONFIG_AUTOBOOT_KEYED
880c609719bSwdenk		CONFIG_AUTOBOOT_PROMPT
881c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR
882c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR
883c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR2
884c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR2
885c609719bSwdenk		CONFIG_ZERO_BOOTDELAY_CHECK
886c609719bSwdenk		CONFIG_RESET_TO_RETRY
887c609719bSwdenk
888c609719bSwdenk- Autoboot Command:
889c609719bSwdenk		CONFIG_BOOTCOMMAND
890c609719bSwdenk		Only needed when CONFIG_BOOTDELAY is enabled;
891c609719bSwdenk		define a command string that is automatically executed
892c609719bSwdenk		when no character is read on the console interface
893c609719bSwdenk		within "Boot Delay" after reset.
894c609719bSwdenk
895c609719bSwdenk		CONFIG_BOOTARGS
896c609719bSwdenk		This can be used to pass arguments to the bootm
897c609719bSwdenk		command. The value of CONFIG_BOOTARGS goes into the
898c609719bSwdenk		environment value "bootargs".
899c609719bSwdenk
900c609719bSwdenk		CONFIG_RAMBOOT and CONFIG_NFSBOOT
901c609719bSwdenk		The value of these goes into the environment as
902c609719bSwdenk		"ramboot" and "nfsboot" respectively, and can be used
903c609719bSwdenk		as a convenience, when switching between booting from
90411ccc33fSMarcel Ziswiler		RAM and NFS.
905c609719bSwdenk
906eda0ba38SHeiko Schocher- Bootcount:
907eda0ba38SHeiko Schocher		CONFIG_BOOTCOUNT_LIMIT
908eda0ba38SHeiko Schocher		Implements a mechanism for detecting a repeating reboot
909eda0ba38SHeiko Schocher		cycle, see:
910eda0ba38SHeiko Schocher		http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
911eda0ba38SHeiko Schocher
912eda0ba38SHeiko Schocher		CONFIG_BOOTCOUNT_ENV
913eda0ba38SHeiko Schocher		If no softreset save registers are found on the hardware
914eda0ba38SHeiko Schocher		"bootcount" is stored in the environment. To prevent a
915eda0ba38SHeiko Schocher		saveenv on all reboots, the environment variable
916eda0ba38SHeiko Schocher		"upgrade_available" is used. If "upgrade_available" is
917eda0ba38SHeiko Schocher		0, "bootcount" is always 0, if "upgrade_available" is
918eda0ba38SHeiko Schocher		1 "bootcount" is incremented in the environment.
919eda0ba38SHeiko Schocher		So the Userspace Applikation must set the "upgrade_available"
920eda0ba38SHeiko Schocher		and "bootcount" variable to 0, if a boot was successfully.
921eda0ba38SHeiko Schocher
922c609719bSwdenk- Pre-Boot Commands:
923c609719bSwdenk		CONFIG_PREBOOT
924c609719bSwdenk
925c609719bSwdenk		When this option is #defined, the existence of the
926c609719bSwdenk		environment variable "preboot" will be checked
927c609719bSwdenk		immediately before starting the CONFIG_BOOTDELAY
928c609719bSwdenk		countdown and/or running the auto-boot command resp.
929c609719bSwdenk		entering interactive mode.
930c609719bSwdenk
931c609719bSwdenk		This feature is especially useful when "preboot" is
932c609719bSwdenk		automatically generated or modified. For an example
933c609719bSwdenk		see the LWMON board specific code: here "preboot" is
934c609719bSwdenk		modified when the user holds down a certain
935c609719bSwdenk		combination of keys on the (special) keyboard when
936c609719bSwdenk		booting the systems
937c609719bSwdenk
938c609719bSwdenk- Serial Download Echo Mode:
939c609719bSwdenk		CONFIG_LOADS_ECHO
940c609719bSwdenk		If defined to 1, all characters received during a
941c609719bSwdenk		serial download (using the "loads" command) are
942c609719bSwdenk		echoed back. This might be needed by some terminal
943c609719bSwdenk		emulations (like "cu"), but may as well just take
944c609719bSwdenk		time on others. This setting #define's the initial
945c609719bSwdenk		value of the "loads_echo" environment variable.
946c609719bSwdenk
947602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
948c609719bSwdenk		CONFIG_KGDB_BAUDRATE
949c609719bSwdenk		Select one of the baudrates listed in
9506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
951c609719bSwdenk
952c609719bSwdenk- Monitor Functions:
953602ad3b3SJon Loeliger		Monitor commands can be included or excluded
954602ad3b3SJon Loeliger		from the build by using the #include files
955c6c621bdSStephen Warren		<config_cmd_all.h> and #undef'ing unwanted
956c6c621bdSStephen Warren		commands, or using <config_cmd_default.h>
957602ad3b3SJon Loeliger		and augmenting with additional #define's
958602ad3b3SJon Loeliger		for wanted commands.
959c609719bSwdenk
960602ad3b3SJon Loeliger		The default command configuration includes all commands
961602ad3b3SJon Loeliger		except those marked below with a "*".
962602ad3b3SJon Loeliger
963b401b73dSMarek Vasut		CONFIG_CMD_AES		  AES 128 CBC encrypt/decrypt
964602ad3b3SJon Loeliger		CONFIG_CMD_ASKENV	* ask for env variable
965602ad3b3SJon Loeliger		CONFIG_CMD_BDI		  bdinfo
966602ad3b3SJon Loeliger		CONFIG_CMD_BEDBUG	* Include BedBug Debugger
967602ad3b3SJon Loeliger		CONFIG_CMD_BMP		* BMP support
968602ad3b3SJon Loeliger		CONFIG_CMD_BSP		* Board specific commands
969602ad3b3SJon Loeliger		CONFIG_CMD_BOOTD	  bootd
970602ad3b3SJon Loeliger		CONFIG_CMD_CACHE	* icache, dcache
97108d0d6f3SMichal Simek		CONFIG_CMD_CLK   	* clock command support
972602ad3b3SJon Loeliger		CONFIG_CMD_CONSOLE	  coninfo
973710b9938SMike Frysinger		CONFIG_CMD_CRC32	* crc32
974602ad3b3SJon Loeliger		CONFIG_CMD_DATE		* support for RTC, date/time...
975602ad3b3SJon Loeliger		CONFIG_CMD_DHCP		* DHCP support
976602ad3b3SJon Loeliger		CONFIG_CMD_DIAG		* Diagnostics
977a7c93104SPeter Tyser		CONFIG_CMD_DS4510	* ds4510 I2C gpio commands
978a7c93104SPeter Tyser		CONFIG_CMD_DS4510_INFO	* ds4510 I2C info command
979a7c93104SPeter Tyser		CONFIG_CMD_DS4510_MEM	* ds4510 I2C eeprom/sram commansd
980a7c93104SPeter Tyser		CONFIG_CMD_DS4510_RST	* ds4510 I2C rst command
981602ad3b3SJon Loeliger		CONFIG_CMD_DTT		* Digital Therm and Thermostat
982602ad3b3SJon Loeliger		CONFIG_CMD_ECHO		  echo arguments
983246c6922SPeter Tyser		CONFIG_CMD_EDITENV	  edit env variable
984602ad3b3SJon Loeliger		CONFIG_CMD_EEPROM	* EEPROM read/write support
985602ad3b3SJon Loeliger		CONFIG_CMD_ELF		* bootelf, bootvx
9865e2b3e0cSJoe Hershberger		CONFIG_CMD_ENV_CALLBACK	* display details about env callbacks
987fffad71bSJoe Hershberger		CONFIG_CMD_ENV_FLAGS	* display details about env flags
98888733e2cSAndrew Ruder		CONFIG_CMD_ENV_EXISTS	* check existence of env variable
9890c79cda0SMike Frysinger		CONFIG_CMD_EXPORTENV	* export the environment
99003e2ecf6SStephen Warren		CONFIG_CMD_EXT2		* ext2 command support
99103e2ecf6SStephen Warren		CONFIG_CMD_EXT4		* ext4 command support
99216f4d933SStephen Warren		CONFIG_CMD_FS_GENERIC	* filesystem commands (e.g. load, ls)
99316f4d933SStephen Warren					  that work for multiple fs types
994bdab39d3SMike Frysinger		CONFIG_CMD_SAVEENV	  saveenv
995602ad3b3SJon Loeliger		CONFIG_CMD_FDC		* Floppy Disk Support
99603e2ecf6SStephen Warren		CONFIG_CMD_FAT		* FAT command support
997602ad3b3SJon Loeliger		CONFIG_CMD_FLASH	  flinfo, erase, protect
998602ad3b3SJon Loeliger		CONFIG_CMD_FPGA		  FPGA device initialization support
9994d98b5c8SVincent Stehlé		CONFIG_CMD_FUSE		* Device fuse support
100053fdc7efSAnton Staaf		CONFIG_CMD_GETTIME	* Get time since boot
1001a641b979SMike Frysinger		CONFIG_CMD_GO		* the 'go' command (exec code)
1002a000b795SKim Phillips		CONFIG_CMD_GREPENV	* search environment
1003bf36c5d5SSimon Glass		CONFIG_CMD_HASH		* calculate hash / digest
1004602ad3b3SJon Loeliger		CONFIG_CMD_HWFLOW	* RTS/CTS hw flow control
1005602ad3b3SJon Loeliger		CONFIG_CMD_I2C		* I2C serial bus support
1006602ad3b3SJon Loeliger		CONFIG_CMD_IDE		* IDE harddisk support
1007602ad3b3SJon Loeliger		CONFIG_CMD_IMI		  iminfo
10088fdf1e0fSVipin Kumar		CONFIG_CMD_IMLS		  List all images found in NOR flash
10094d98b5c8SVincent Stehlé		CONFIG_CMD_IMLS_NAND	* List all images found in NAND flash
1010602ad3b3SJon Loeliger		CONFIG_CMD_IMMAP	* IMMR dump support
10110c79cda0SMike Frysinger		CONFIG_CMD_IMPORTENV	* import an environment
1012c167cc02SJoe Hershberger		CONFIG_CMD_INI		* import data from an ini file into the env
1013602ad3b3SJon Loeliger		CONFIG_CMD_IRQ		* irqinfo
1014602ad3b3SJon Loeliger		CONFIG_CMD_ITEST	  Integer/string test of 2 values
1015602ad3b3SJon Loeliger		CONFIG_CMD_JFFS2	* JFFS2 Support
1016602ad3b3SJon Loeliger		CONFIG_CMD_KGDB		* kgdb
10174d98b5c8SVincent Stehlé		CONFIG_CMD_LDRINFO	* ldrinfo (display Blackfin loader)
1018d22c338eSJoe Hershberger		CONFIG_CMD_LINK_LOCAL	* link-local IP address auto-configuration
1019d22c338eSJoe Hershberger					  (169.254.*.*)
1020602ad3b3SJon Loeliger		CONFIG_CMD_LOADB	  loadb
1021602ad3b3SJon Loeliger		CONFIG_CMD_LOADS	  loads
10224d98b5c8SVincent Stehlé		CONFIG_CMD_MD5SUM	* print md5 message digest
102302c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
102415a33e49SSimon Glass		CONFIG_CMD_MEMINFO	* Display detailed memory information
1025602ad3b3SJon Loeliger		CONFIG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
1026a2681707SWolfgang Denk					  loop, loopw
10274d98b5c8SVincent Stehlé		CONFIG_CMD_MEMTEST	* mtest
1028602ad3b3SJon Loeliger		CONFIG_CMD_MISC		  Misc functions like sleep etc
1029602ad3b3SJon Loeliger		CONFIG_CMD_MMC		* MMC memory mapped support
1030602ad3b3SJon Loeliger		CONFIG_CMD_MII		* MII utility commands
103168d7d651SStefan Roese		CONFIG_CMD_MTDPARTS	* MTD partition support
1032602ad3b3SJon Loeliger		CONFIG_CMD_NAND		* NAND support
1033602ad3b3SJon Loeliger		CONFIG_CMD_NET		  bootp, tftpboot, rarpboot
10344d98b5c8SVincent Stehlé		CONFIG_CMD_NFS		  NFS support
1035e92739d3SPeter Tyser		CONFIG_CMD_PCA953X	* PCA953x I2C gpio commands
1036e92739d3SPeter Tyser		CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
1037602ad3b3SJon Loeliger		CONFIG_CMD_PCI		* pciinfo
1038602ad3b3SJon Loeliger		CONFIG_CMD_PCMCIA		* PCMCIA support
1039602ad3b3SJon Loeliger		CONFIG_CMD_PING		* send ICMP ECHO_REQUEST to network
1040602ad3b3SJon Loeliger					  host
1041602ad3b3SJon Loeliger		CONFIG_CMD_PORTIO	* Port I/O
1042ff048ea9SKenneth Waters		CONFIG_CMD_READ		* Read raw data from partition
1043602ad3b3SJon Loeliger		CONFIG_CMD_REGINFO	* Register dump
1044602ad3b3SJon Loeliger		CONFIG_CMD_RUN		  run command in env variable
1045d304931fSSimon Glass		CONFIG_CMD_SANDBOX	* sb command to access sandbox features
1046602ad3b3SJon Loeliger		CONFIG_CMD_SAVES	* save S record dump
1047602ad3b3SJon Loeliger		CONFIG_CMD_SCSI		* SCSI Support
1048602ad3b3SJon Loeliger		CONFIG_CMD_SDRAM	* print SDRAM configuration information
1049602ad3b3SJon Loeliger					  (requires CONFIG_CMD_I2C)
1050602ad3b3SJon Loeliger		CONFIG_CMD_SETGETDCR	  Support for DCR Register access
1051602ad3b3SJon Loeliger					  (4xx only)
1052f61ec45eSEric Nelson		CONFIG_CMD_SF		* Read/write/erase SPI NOR flash
10534d98b5c8SVincent Stehlé		CONFIG_CMD_SHA1SUM	* print sha1 memory digest
105402c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY)
10557d861d95SBob Liu		CONFIG_CMD_SOFTSWITCH	* Soft switch setting command for BF60x
105674de7aefSWolfgang Denk		CONFIG_CMD_SOURCE	  "source" command Support
1057602ad3b3SJon Loeliger		CONFIG_CMD_SPI		* SPI serial bus support
10587a83af07SLuca Ceresoli		CONFIG_CMD_TFTPSRV	* TFTP transfer in server mode
10591fb7cd49SSimon Glass		CONFIG_CMD_TFTPPUT	* TFTP put command (upload)
1060da83bcd7SJoe Hershberger		CONFIG_CMD_TIME		* run command and report execution time (ARM specific)
1061da83bcd7SJoe Hershberger		CONFIG_CMD_TIMER	* access to the system tick timer
1062602ad3b3SJon Loeliger		CONFIG_CMD_USB		* USB support
1063602ad3b3SJon Loeliger		CONFIG_CMD_CDP		* Cisco Discover Protocol support
1064c8339f51SMarek Vasut		CONFIG_CMD_MFSL		* Microblaze FSL support
10654d98b5c8SVincent Stehlé		CONFIG_CMD_XIMG		  Load part of Multi Image
106689c8230dSPrzemyslaw Marczak		CONFIG_CMD_UUID		* Generate random UUID or GUID string
1067c609719bSwdenk
1068c609719bSwdenk		EXAMPLE: If you want all functions except of network
1069c609719bSwdenk		support you can write:
1070c609719bSwdenk
1071602ad3b3SJon Loeliger		#include "config_cmd_all.h"
1072602ad3b3SJon Loeliger		#undef CONFIG_CMD_NET
1073c609719bSwdenk
1074213bf8c8SGerald Van Baren	Other Commands:
1075213bf8c8SGerald Van Baren		fdt (flattened device tree) command: CONFIG_OF_LIBFDT
1076c609719bSwdenk
1077c609719bSwdenk	Note:	Don't enable the "icache" and "dcache" commands
1078602ad3b3SJon Loeliger		(configuration option CONFIG_CMD_CACHE) unless you know
1079c609719bSwdenk		what you (and your U-Boot users) are doing. Data
1080c609719bSwdenk		cache cannot be enabled on systems like the 8xx or
1081c609719bSwdenk		8260 (where accesses to the IMMR region must be
1082c609719bSwdenk		uncached), and it cannot be disabled on all other
1083c609719bSwdenk		systems where we (mis-) use the data cache to hold an
1084c609719bSwdenk		initial stack and some data.
1085c609719bSwdenk
1086c609719bSwdenk
1087c609719bSwdenk		XXX - this list needs to get updated!
1088c609719bSwdenk
1089a5ecbe62SWolfgang Denk- Regular expression support:
1090a5ecbe62SWolfgang Denk		CONFIG_REGEX
1091a5ecbe62SWolfgang Denk		If this variable is defined, U-Boot is linked against
1092a5ecbe62SWolfgang Denk		the SLRE (Super Light Regular Expression) library,
1093a5ecbe62SWolfgang Denk		which adds regex support to some commands, as for
1094a5ecbe62SWolfgang Denk		example "env grep" and "setexpr".
1095a5ecbe62SWolfgang Denk
109645ba8077SSimon Glass- Device tree:
109745ba8077SSimon Glass		CONFIG_OF_CONTROL
109845ba8077SSimon Glass		If this variable is defined, U-Boot will use a device tree
109945ba8077SSimon Glass		to configure its devices, instead of relying on statically
110045ba8077SSimon Glass		compiled #defines in the board file. This option is
110145ba8077SSimon Glass		experimental and only available on a few boards. The device
110245ba8077SSimon Glass		tree is available in the global data as gd->fdt_blob.
110345ba8077SSimon Glass
11042c0f79e4SSimon Glass		U-Boot needs to get its device tree from somewhere. This can
11052c0f79e4SSimon Glass		be done using one of the two options below:
1106bbb0b128SSimon Glass
1107bbb0b128SSimon Glass		CONFIG_OF_EMBED
1108bbb0b128SSimon Glass		If this variable is defined, U-Boot will embed a device tree
1109bbb0b128SSimon Glass		binary in its image. This device tree file should be in the
1110bbb0b128SSimon Glass		board directory and called <soc>-<board>.dts. The binary file
1111bbb0b128SSimon Glass		is then picked up in board_init_f() and made available through
1112bbb0b128SSimon Glass		the global data structure as gd->blob.
111345ba8077SSimon Glass
11142c0f79e4SSimon Glass		CONFIG_OF_SEPARATE
11152c0f79e4SSimon Glass		If this variable is defined, U-Boot will build a device tree
11162c0f79e4SSimon Glass		binary. It will be called u-boot.dtb. Architecture-specific
11172c0f79e4SSimon Glass		code will locate it at run-time. Generally this works by:
11182c0f79e4SSimon Glass
11192c0f79e4SSimon Glass			cat u-boot.bin u-boot.dtb >image.bin
11202c0f79e4SSimon Glass
11212c0f79e4SSimon Glass		and in fact, U-Boot does this for you, creating a file called
11222c0f79e4SSimon Glass		u-boot-dtb.bin which is useful in the common case. You can
11232c0f79e4SSimon Glass		still use the individual files if you need something more
11242c0f79e4SSimon Glass		exotic.
11252c0f79e4SSimon Glass
1126c609719bSwdenk- Watchdog:
1127c609719bSwdenk		CONFIG_WATCHDOG
1128c609719bSwdenk		If this variable is defined, it enables watchdog
11296abe6fb6SDetlev Zundel		support for the SoC. There must be support in the SoC
11306abe6fb6SDetlev Zundel		specific code for a watchdog. For the 8xx and 8260
11316abe6fb6SDetlev Zundel		CPUs, the SIU Watchdog feature is enabled in the SYPCR
11326abe6fb6SDetlev Zundel		register.  When supported for a specific SoC is
11336abe6fb6SDetlev Zundel		available, then no further board specific code should
11346abe6fb6SDetlev Zundel		be needed to use it.
11356abe6fb6SDetlev Zundel
11366abe6fb6SDetlev Zundel		CONFIG_HW_WATCHDOG
11376abe6fb6SDetlev Zundel		When using a watchdog circuitry external to the used
11386abe6fb6SDetlev Zundel		SoC, then define this variable and provide board
11396abe6fb6SDetlev Zundel		specific code for the "hw_watchdog_reset" function.
1140c609719bSwdenk
1141c1551ea8Sstroese- U-Boot Version:
1142c1551ea8Sstroese		CONFIG_VERSION_VARIABLE
1143c1551ea8Sstroese		If this variable is defined, an environment variable
1144c1551ea8Sstroese		named "ver" is created by U-Boot showing the U-Boot
1145c1551ea8Sstroese		version as printed by the "version" command.
1146a1ea8e51SBenoît Thébaudeau		Any change to this variable will be reverted at the
1147a1ea8e51SBenoît Thébaudeau		next reset.
1148c1551ea8Sstroese
1149c609719bSwdenk- Real-Time Clock:
1150c609719bSwdenk
1151602ad3b3SJon Loeliger		When CONFIG_CMD_DATE is selected, the type of the RTC
1152c609719bSwdenk		has to be selected, too. Define exactly one of the
1153c609719bSwdenk		following options:
1154c609719bSwdenk
1155c609719bSwdenk		CONFIG_RTC_MPC8xx	- use internal RTC of MPC8xx
1156c609719bSwdenk		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
11574e8b7544SFabio Estevam		CONFIG_RTC_MC13XXX	- use MC13783 or MC13892 RTC
1158c609719bSwdenk		CONFIG_RTC_MC146818	- use MC146818 RTC
11591cb8e980Swdenk		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
1160c609719bSwdenk		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
11617f70e853Swdenk		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
11623bac3513Swdenk		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
11639536dfccSTor Krill		CONFIG_RTC_ISL1208	- use Intersil ISL1208 RTC
11644c0d4c3bSwdenk		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
11656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_DS1337_NOOSC	- Turn off the OSC output for DS1337
116671d19f30SHeiko Schocher		CONFIG_SYS_RV3029_TCR	- enable trickle charger on
116771d19f30SHeiko Schocher					  RV3029 RTC.
1168c609719bSwdenk
1169b37c7e5eSwdenk		Note that if the RTC uses I2C, then the I2C interface
1170b37c7e5eSwdenk		must also be configured. See I2C Support, below.
1171b37c7e5eSwdenk
1172e92739d3SPeter Tyser- GPIO Support:
1173e92739d3SPeter Tyser		CONFIG_PCA953X		- use NXP's PCA953X series I2C GPIO
1174e92739d3SPeter Tyser
11755dec49caSChris Packham		The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
11765dec49caSChris Packham		chip-ngpio pairs that tell the PCA953X driver the number of
11775dec49caSChris Packham		pins supported by a particular chip.
11785dec49caSChris Packham
1179e92739d3SPeter Tyser		Note that if the GPIO device uses I2C, then the I2C interface
1180e92739d3SPeter Tyser		must also be configured. See I2C Support, below.
1181e92739d3SPeter Tyser
1182c609719bSwdenk- Timestamp Support:
1183c609719bSwdenk
1184c609719bSwdenk		When CONFIG_TIMESTAMP is selected, the timestamp
1185c609719bSwdenk		(date and time) of an image is printed by image
1186c609719bSwdenk		commands like bootm or iminfo. This option is
1187602ad3b3SJon Loeliger		automatically enabled when you select CONFIG_CMD_DATE .
1188c609719bSwdenk
1189923c46f9SKarl O. Pinc- Partition Labels (disklabels) Supported:
1190923c46f9SKarl O. Pinc		Zero or more of the following:
1191923c46f9SKarl O. Pinc		CONFIG_MAC_PARTITION   Apple's MacOS partition table.
1192923c46f9SKarl O. Pinc		CONFIG_DOS_PARTITION   MS Dos partition table, traditional on the
1193923c46f9SKarl O. Pinc				       Intel architecture, USB sticks, etc.
1194923c46f9SKarl O. Pinc		CONFIG_ISO_PARTITION   ISO partition table, used on CDROM etc.
1195923c46f9SKarl O. Pinc		CONFIG_EFI_PARTITION   GPT partition table, common when EFI is the
1196923c46f9SKarl O. Pinc				       bootloader.  Note 2TB partition limit; see
1197923c46f9SKarl O. Pinc				       disk/part_efi.c
1198923c46f9SKarl O. Pinc		CONFIG_MTD_PARTITIONS  Memory Technology Device partition table.
1199c609719bSwdenk
1200602ad3b3SJon Loeliger		If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1201218ca724SWolfgang Denk		CONFIG_CMD_SCSI) you must configure support for at
1202923c46f9SKarl O. Pinc		least one non-MTD partition type as well.
1203c609719bSwdenk
1204c609719bSwdenk- IDE Reset method:
12054d13cbadSwdenk		CONFIG_IDE_RESET_ROUTINE - this is defined in several
12064d13cbadSwdenk		board configurations files but used nowhere!
1207c609719bSwdenk
12084d13cbadSwdenk		CONFIG_IDE_RESET - is this is defined, IDE Reset will
12094d13cbadSwdenk		be performed by calling the function
12104d13cbadSwdenk			ide_set_reset(int reset)
12114d13cbadSwdenk		which has to be defined in a board specific file
1212c609719bSwdenk
1213c609719bSwdenk- ATAPI Support:
1214c609719bSwdenk		CONFIG_ATAPI
1215c609719bSwdenk
1216c609719bSwdenk		Set this to enable ATAPI support.
1217c609719bSwdenk
1218c40b2956Swdenk- LBA48 Support
1219c40b2956Swdenk		CONFIG_LBA48
1220c40b2956Swdenk
1221c40b2956Swdenk		Set this to enable support for disks larger than 137GB
12224b142febSHeiko Schocher		Also look at CONFIG_SYS_64BIT_LBA.
1223c40b2956Swdenk		Whithout these , LBA48 support uses 32bit variables and will 'only'
1224c40b2956Swdenk		support disks up to 2.1TB.
1225c40b2956Swdenk
12266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_64BIT_LBA:
1227c40b2956Swdenk			When enabled, makes the IDE subsystem use 64bit sector addresses.
1228c40b2956Swdenk			Default is 32bit.
1229c40b2956Swdenk
1230c609719bSwdenk- SCSI Support:
1231c609719bSwdenk		At the moment only there is only support for the
1232c609719bSwdenk		SYM53C8XX SCSI controller; define
1233c609719bSwdenk		CONFIG_SCSI_SYM53C8XX to enable it.
1234c609719bSwdenk
12356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
12366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
12376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
1238c609719bSwdenk		maximum numbers of LUNs, SCSI ID's and target
1239c609719bSwdenk		devices.
12406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
1241c609719bSwdenk
1242447c031bSStefan Reinauer		The environment variable 'scsidevs' is set to the number of
1243447c031bSStefan Reinauer		SCSI devices found during the last scan.
1244447c031bSStefan Reinauer
1245c609719bSwdenk- NETWORK Support (PCI):
1246682011ffSwdenk		CONFIG_E1000
1247ce5207e1SKyle Moffett		Support for Intel 8254x/8257x gigabit chips.
1248ce5207e1SKyle Moffett
1249ce5207e1SKyle Moffett		CONFIG_E1000_SPI
1250ce5207e1SKyle Moffett		Utility code for direct access to the SPI bus on Intel 8257x.
1251ce5207e1SKyle Moffett		This does not do anything useful unless you set at least one
1252ce5207e1SKyle Moffett		of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1253ce5207e1SKyle Moffett
1254ce5207e1SKyle Moffett		CONFIG_E1000_SPI_GENERIC
1255ce5207e1SKyle Moffett		Allow generic access to the SPI bus on the Intel 8257x, for
1256ce5207e1SKyle Moffett		example with the "sspi" command.
1257ce5207e1SKyle Moffett
1258ce5207e1SKyle Moffett		CONFIG_CMD_E1000
1259ce5207e1SKyle Moffett		Management command for E1000 devices.  When used on devices
1260ce5207e1SKyle Moffett		with SPI support you can reprogram the EEPROM from U-Boot.
1261682011ffSwdenk
1262ac3315c2SAndre Schwarz		CONFIG_E1000_FALLBACK_MAC
126311ccc33fSMarcel Ziswiler		default MAC for empty EEPROM after production.
1264ac3315c2SAndre Schwarz
1265c609719bSwdenk		CONFIG_EEPRO100
1266c609719bSwdenk		Support for Intel 82557/82559/82559ER chips.
126711ccc33fSMarcel Ziswiler		Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
1268c609719bSwdenk		write routine for first time initialisation.
1269c609719bSwdenk
1270c609719bSwdenk		CONFIG_TULIP
1271c609719bSwdenk		Support for Digital 2114x chips.
1272c609719bSwdenk		Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1273c609719bSwdenk		modem chip initialisation (KS8761/QS6611).
1274c609719bSwdenk
1275c609719bSwdenk		CONFIG_NATSEMI
1276c609719bSwdenk		Support for National dp83815 chips.
1277c609719bSwdenk
1278c609719bSwdenk		CONFIG_NS8382X
1279c609719bSwdenk		Support for National dp8382[01] gigabit chips.
1280c609719bSwdenk
128145219c46Swdenk- NETWORK Support (other):
128245219c46Swdenk
1283c041e9d2SJens Scharsig		CONFIG_DRIVER_AT91EMAC
1284c041e9d2SJens Scharsig		Support for AT91RM9200 EMAC.
1285c041e9d2SJens Scharsig
1286c041e9d2SJens Scharsig			CONFIG_RMII
1287c041e9d2SJens Scharsig			Define this to use reduced MII inteface
1288c041e9d2SJens Scharsig
1289c041e9d2SJens Scharsig			CONFIG_DRIVER_AT91EMAC_QUIET
1290c041e9d2SJens Scharsig			If this defined, the driver is quiet.
1291c041e9d2SJens Scharsig			The driver doen't show link status messages.
1292c041e9d2SJens Scharsig
1293efdd7319SRob Herring		CONFIG_CALXEDA_XGMAC
1294efdd7319SRob Herring		Support for the Calxeda XGMAC device
1295efdd7319SRob Herring
12963bb46d23SAshok		CONFIG_LAN91C96
129745219c46Swdenk		Support for SMSC's LAN91C96 chips.
129845219c46Swdenk
129945219c46Swdenk			CONFIG_LAN91C96_BASE
130045219c46Swdenk			Define this to hold the physical address
130145219c46Swdenk			of the LAN91C96's I/O space
130245219c46Swdenk
130345219c46Swdenk			CONFIG_LAN91C96_USE_32_BIT
130445219c46Swdenk			Define this to enable 32 bit addressing
130545219c46Swdenk
13063bb46d23SAshok		CONFIG_SMC91111
1307f39748aeSwdenk		Support for SMSC's LAN91C111 chip
1308f39748aeSwdenk
1309f39748aeSwdenk			CONFIG_SMC91111_BASE
1310f39748aeSwdenk			Define this to hold the physical address
1311f39748aeSwdenk			of the device (I/O space)
1312f39748aeSwdenk
1313f39748aeSwdenk			CONFIG_SMC_USE_32_BIT
1314f39748aeSwdenk			Define this if data bus is 32 bits
1315f39748aeSwdenk
1316f39748aeSwdenk			CONFIG_SMC_USE_IOFUNCS
1317f39748aeSwdenk			Define this to use i/o functions instead of macros
1318f39748aeSwdenk			(some hardware wont work with macros)
1319f39748aeSwdenk
1320dc02badaSHeiko Schocher		CONFIG_DRIVER_TI_EMAC
1321dc02badaSHeiko Schocher		Support for davinci emac
1322dc02badaSHeiko Schocher
1323dc02badaSHeiko Schocher			CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1324dc02badaSHeiko Schocher			Define this if you have more then 3 PHYs.
1325dc02badaSHeiko Schocher
1326b3dbf4a5SMacpaul Lin		CONFIG_FTGMAC100
1327b3dbf4a5SMacpaul Lin		Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1328b3dbf4a5SMacpaul Lin
1329b3dbf4a5SMacpaul Lin			CONFIG_FTGMAC100_EGIGA
1330b3dbf4a5SMacpaul Lin			Define this to use GE link update with gigabit PHY.
1331b3dbf4a5SMacpaul Lin			Define this if FTGMAC100 is connected to gigabit PHY.
1332b3dbf4a5SMacpaul Lin			If your system has 10/100 PHY only, it might not occur
1333b3dbf4a5SMacpaul Lin			wrong behavior. Because PHY usually return timeout or
1334b3dbf4a5SMacpaul Lin			useless data when polling gigabit status and gigabit
1335b3dbf4a5SMacpaul Lin			control registers. This behavior won't affect the
1336b3dbf4a5SMacpaul Lin			correctnessof 10/100 link speed update.
1337b3dbf4a5SMacpaul Lin
1338c2fff331SMike Rapoport		CONFIG_SMC911X
1339557b377dSJens Gehrlein		Support for SMSC's LAN911x and LAN921x chips
1340557b377dSJens Gehrlein
1341c2fff331SMike Rapoport			CONFIG_SMC911X_BASE
1342557b377dSJens Gehrlein			Define this to hold the physical address
1343557b377dSJens Gehrlein			of the device (I/O space)
1344557b377dSJens Gehrlein
1345c2fff331SMike Rapoport			CONFIG_SMC911X_32_BIT
1346557b377dSJens Gehrlein			Define this if data bus is 32 bits
1347557b377dSJens Gehrlein
1348c2fff331SMike Rapoport			CONFIG_SMC911X_16_BIT
1349557b377dSJens Gehrlein			Define this if data bus is 16 bits. If your processor
1350557b377dSJens Gehrlein			automatically converts one 32 bit word to two 16 bit
1351c2fff331SMike Rapoport			words you may also try CONFIG_SMC911X_32_BIT.
1352557b377dSJens Gehrlein
13533d0075faSYoshihiro Shimoda		CONFIG_SH_ETHER
13543d0075faSYoshihiro Shimoda		Support for Renesas on-chip Ethernet controller
13553d0075faSYoshihiro Shimoda
13563d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_USE_PORT
13573d0075faSYoshihiro Shimoda			Define the number of ports to be used
13583d0075faSYoshihiro Shimoda
13593d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_PHY_ADDR
13603d0075faSYoshihiro Shimoda			Define the ETH PHY's address
13613d0075faSYoshihiro Shimoda
136268260aabSYoshihiro Shimoda			CONFIG_SH_ETHER_CACHE_WRITEBACK
136368260aabSYoshihiro Shimoda			If this option is set, the driver enables cache flush.
136468260aabSYoshihiro Shimoda
13655e124724SVadim Bendebury- TPM Support:
136690899cc0SChe-liang Chiou		CONFIG_TPM
136790899cc0SChe-liang Chiou		Support TPM devices.
136890899cc0SChe-liang Chiou
13691b393db5STom Wai-Hong Tam		CONFIG_TPM_TIS_I2C
13701b393db5STom Wai-Hong Tam		Support for i2c bus TPM devices. Only one device
13711b393db5STom Wai-Hong Tam		per system is supported at this time.
13721b393db5STom Wai-Hong Tam
13731b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_BUS_NUMBER
13741b393db5STom Wai-Hong Tam			Define the the i2c bus number for the TPM device
13751b393db5STom Wai-Hong Tam
13761b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS
13771b393db5STom Wai-Hong Tam			Define the TPM's address on the i2c bus
13781b393db5STom Wai-Hong Tam
13791b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_BURST_LIMITATION
13801b393db5STom Wai-Hong Tam			Define the burst count bytes upper limit
13811b393db5STom Wai-Hong Tam
1382c01939c7SDirk Eibach		CONFIG_TPM_ATMEL_TWI
1383c01939c7SDirk Eibach		Support for Atmel TWI TPM device. Requires I2C support.
1384c01939c7SDirk Eibach
138590899cc0SChe-liang Chiou		CONFIG_TPM_TIS_LPC
13865e124724SVadim Bendebury		Support for generic parallel port TPM devices. Only one device
13875e124724SVadim Bendebury		per system is supported at this time.
13885e124724SVadim Bendebury
13895e124724SVadim Bendebury			CONFIG_TPM_TIS_BASE_ADDRESS
13905e124724SVadim Bendebury			Base address where the generic TPM device is mapped
13915e124724SVadim Bendebury			to. Contemporary x86 systems usually map it at
13925e124724SVadim Bendebury			0xfed40000.
13935e124724SVadim Bendebury
1394be6c1529SReinhard Pfau		CONFIG_CMD_TPM
1395be6c1529SReinhard Pfau		Add tpm monitor functions.
1396be6c1529SReinhard Pfau		Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1397be6c1529SReinhard Pfau		provides monitor access to authorized functions.
1398be6c1529SReinhard Pfau
1399be6c1529SReinhard Pfau		CONFIG_TPM
1400be6c1529SReinhard Pfau		Define this to enable the TPM support library which provides
1401be6c1529SReinhard Pfau		functional interfaces to some TPM commands.
1402be6c1529SReinhard Pfau		Requires support for a TPM device.
1403be6c1529SReinhard Pfau
1404be6c1529SReinhard Pfau		CONFIG_TPM_AUTH_SESSIONS
1405be6c1529SReinhard Pfau		Define this to enable authorized functions in the TPM library.
1406be6c1529SReinhard Pfau		Requires CONFIG_TPM and CONFIG_SHA1.
1407be6c1529SReinhard Pfau
1408c609719bSwdenk- USB Support:
1409c609719bSwdenk		At the moment only the UHCI host controller is
14104d13cbadSwdenk		supported (PIP405, MIP405, MPC5200); define
1411c609719bSwdenk		CONFIG_USB_UHCI to enable it.
1412c609719bSwdenk		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
141330d56faeSwdenk		and define CONFIG_USB_STORAGE to enable the USB
1414c609719bSwdenk		storage devices.
1415c609719bSwdenk		Note:
1416c609719bSwdenk		Supported are USB Keyboards and USB Floppy drives
1417c609719bSwdenk		(TEAC FD-05PUB).
14184d13cbadSwdenk		MPC5200 USB requires additional defines:
14194d13cbadSwdenk			CONFIG_USB_CLOCK
14204d13cbadSwdenk				for 528 MHz Clock: 0x0001bbbb
1421307ecb6dSEric Millbrandt			CONFIG_PSC3_USB
1422307ecb6dSEric Millbrandt				for USB on PSC3
14234d13cbadSwdenk			CONFIG_USB_CONFIG
14244d13cbadSwdenk				for differential drivers: 0x00001000
14254d13cbadSwdenk				for single ended drivers: 0x00005000
1426307ecb6dSEric Millbrandt				for differential drivers on PSC3: 0x00000100
1427307ecb6dSEric Millbrandt				for single ended drivers on PSC3: 0x00004100
14286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_USB_EVENT_POLL
1429fdcfaa1bSZhang Wei				May be defined to allow interrupt polling
1430fdcfaa1bSZhang Wei				instead of using asynchronous interrupts
14314d13cbadSwdenk
14329ab4ce22SSimon Glass		CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
14339ab4ce22SSimon Glass		txfilltuning field in the EHCI controller on reset.
14349ab4ce22SSimon Glass
1435aa155058SKuo-Jung Su		CONFIG_USB_HUB_MIN_POWER_ON_DELAY defines the minimum
1436aa155058SKuo-Jung Su		interval for usb hub power-on delay.(minimum 100msec)
1437aa155058SKuo-Jung Su
143816c8d5e7SWolfgang Denk- USB Device:
143916c8d5e7SWolfgang Denk		Define the below if you wish to use the USB console.
144016c8d5e7SWolfgang Denk		Once firmware is rebuilt from a serial console issue the
144116c8d5e7SWolfgang Denk		command "setenv stdin usbtty; setenv stdout usbtty" and
144211ccc33fSMarcel Ziswiler		attach your USB cable. The Unix command "dmesg" should print
144316c8d5e7SWolfgang Denk		it has found a new device. The environment variable usbtty
144416c8d5e7SWolfgang Denk		can be set to gserial or cdc_acm to enable your device to
144516c8d5e7SWolfgang Denk		appear to a USB host as a Linux gserial device or a
144616c8d5e7SWolfgang Denk		Common Device Class Abstract Control Model serial device.
144716c8d5e7SWolfgang Denk		If you select usbtty = gserial you should be able to enumerate
144816c8d5e7SWolfgang Denk		a Linux host by
144916c8d5e7SWolfgang Denk		# modprobe usbserial vendor=0xVendorID product=0xProductID
145016c8d5e7SWolfgang Denk		else if using cdc_acm, simply setting the environment
145116c8d5e7SWolfgang Denk		variable usbtty to be cdc_acm should suffice. The following
145216c8d5e7SWolfgang Denk		might be defined in YourBoardName.h
145316c8d5e7SWolfgang Denk
145416c8d5e7SWolfgang Denk			CONFIG_USB_DEVICE
145516c8d5e7SWolfgang Denk			Define this to build a UDC device
145616c8d5e7SWolfgang Denk
145716c8d5e7SWolfgang Denk			CONFIG_USB_TTY
145816c8d5e7SWolfgang Denk			Define this to have a tty type of device available to
145916c8d5e7SWolfgang Denk			talk to the UDC device
146016c8d5e7SWolfgang Denk
1461f9da0f89SVipin KUMAR			CONFIG_USBD_HS
1462f9da0f89SVipin KUMAR			Define this to enable the high speed support for usb
1463f9da0f89SVipin KUMAR			device and usbtty. If this feature is enabled, a routine
1464f9da0f89SVipin KUMAR			int is_usbd_high_speed(void)
1465f9da0f89SVipin KUMAR			also needs to be defined by the driver to dynamically poll
1466f9da0f89SVipin KUMAR			whether the enumeration has succeded at high speed or full
1467f9da0f89SVipin KUMAR			speed.
1468f9da0f89SVipin KUMAR
14696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_IS_IN_ENV
147016c8d5e7SWolfgang Denk			Define this if you want stdin, stdout &/or stderr to
147116c8d5e7SWolfgang Denk			be set to usbtty.
147216c8d5e7SWolfgang Denk
147316c8d5e7SWolfgang Denk			mpc8xx:
14746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_EXTC_CLK 0xBLAH
147516c8d5e7SWolfgang Denk				Derive USB clock from external clock "blah"
14766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_EXTC_CLK 0x02
147716c8d5e7SWolfgang Denk
14786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_BRG_CLK 0xBLAH
147916c8d5e7SWolfgang Denk				Derive USB clock from brgclk
14806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_BRG_CLK 0x04
148116c8d5e7SWolfgang Denk
148216c8d5e7SWolfgang Denk		If you have a USB-IF assigned VendorID then you may wish to
148316c8d5e7SWolfgang Denk		define your own vendor specific values either in BoardName.h
148416c8d5e7SWolfgang Denk		or directly in usbd_vendor_info.h. If you don't define
148516c8d5e7SWolfgang Denk		CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
148616c8d5e7SWolfgang Denk		CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
148716c8d5e7SWolfgang Denk		should pretend to be a Linux device to it's target host.
148816c8d5e7SWolfgang Denk
148916c8d5e7SWolfgang Denk			CONFIG_USBD_MANUFACTURER
149016c8d5e7SWolfgang Denk			Define this string as the name of your company for
149116c8d5e7SWolfgang Denk			- CONFIG_USBD_MANUFACTURER "my company"
149216c8d5e7SWolfgang Denk
149316c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCT_NAME
149416c8d5e7SWolfgang Denk			Define this string as the name of your product
149516c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCT_NAME "acme usb device"
149616c8d5e7SWolfgang Denk
149716c8d5e7SWolfgang Denk			CONFIG_USBD_VENDORID
149816c8d5e7SWolfgang Denk			Define this as your assigned Vendor ID from the USB
149916c8d5e7SWolfgang Denk			Implementors Forum. This *must* be a genuine Vendor ID
150016c8d5e7SWolfgang Denk			to avoid polluting the USB namespace.
150116c8d5e7SWolfgang Denk			- CONFIG_USBD_VENDORID 0xFFFF
150216c8d5e7SWolfgang Denk
150316c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCTID
150416c8d5e7SWolfgang Denk			Define this as the unique Product ID
150516c8d5e7SWolfgang Denk			for your device
150616c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCTID 0xFFFF
1507c609719bSwdenk
1508d70a560fSIgor Grinberg- ULPI Layer Support:
1509d70a560fSIgor Grinberg		The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1510d70a560fSIgor Grinberg		the generic ULPI layer. The generic layer accesses the ULPI PHY
1511d70a560fSIgor Grinberg		via the platform viewport, so you need both the genric layer and
1512d70a560fSIgor Grinberg		the viewport enabled. Currently only Chipidea/ARC based
1513d70a560fSIgor Grinberg		viewport is supported.
1514d70a560fSIgor Grinberg		To enable the ULPI layer support, define CONFIG_USB_ULPI and
1515d70a560fSIgor Grinberg		CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
15166d365ea0SLucas Stach		If your ULPI phy needs a different reference clock than the
15176d365ea0SLucas Stach		standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
15186d365ea0SLucas Stach		the appropriate value in Hz.
1519c609719bSwdenk
1520c609719bSwdenk- MMC Support:
1521c609719bSwdenk		The MMC controller on the Intel PXA is supported. To
1522c609719bSwdenk		enable this define CONFIG_MMC. The MMC can be
1523c609719bSwdenk		accessed from the boot prompt by mapping the device
1524c609719bSwdenk		to physical memory similar to flash. Command line is
1525602ad3b3SJon Loeliger		enabled with CONFIG_CMD_MMC. The MMC driver also works with
1526602ad3b3SJon Loeliger		the FAT fs. This is enabled with CONFIG_CMD_FAT.
1527c609719bSwdenk
1528afb35666SYoshihiro Shimoda		CONFIG_SH_MMCIF
1529afb35666SYoshihiro Shimoda		Support for Renesas on-chip MMCIF controller
1530afb35666SYoshihiro Shimoda
1531afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_ADDR
1532afb35666SYoshihiro Shimoda			Define the base address of MMCIF registers
1533afb35666SYoshihiro Shimoda
1534afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_CLK
1535afb35666SYoshihiro Shimoda			Define the clock frequency for MMCIF
1536afb35666SYoshihiro Shimoda
1537b3ba6e94STom Rini- USB Device Firmware Update (DFU) class support:
1538b3ba6e94STom Rini		CONFIG_DFU_FUNCTION
1539b3ba6e94STom Rini		This enables the USB portion of the DFU USB class
1540b3ba6e94STom Rini
1541b3ba6e94STom Rini		CONFIG_CMD_DFU
1542b3ba6e94STom Rini		This enables the command "dfu" which is used to have
1543b3ba6e94STom Rini		U-Boot create a DFU class device via USB.  This command
1544b3ba6e94STom Rini		requires that the "dfu_alt_info" environment variable be
1545b3ba6e94STom Rini		set and define the alt settings to expose to the host.
1546b3ba6e94STom Rini
1547b3ba6e94STom Rini		CONFIG_DFU_MMC
1548b3ba6e94STom Rini		This enables support for exposing (e)MMC devices via DFU.
1549b3ba6e94STom Rini
1550c6631764SPantelis Antoniou		CONFIG_DFU_NAND
1551c6631764SPantelis Antoniou		This enables support for exposing NAND devices via DFU.
1552c6631764SPantelis Antoniou
1553a9479f04SAfzal Mohammed		CONFIG_DFU_RAM
1554a9479f04SAfzal Mohammed		This enables support for exposing RAM via DFU.
1555a9479f04SAfzal Mohammed		Note: DFU spec refer to non-volatile memory usage, but
1556a9479f04SAfzal Mohammed		allow usages beyond the scope of spec - here RAM usage,
1557a9479f04SAfzal Mohammed		one that would help mostly the developer.
1558a9479f04SAfzal Mohammed
1559e7e75c70SHeiko Schocher		CONFIG_SYS_DFU_DATA_BUF_SIZE
1560e7e75c70SHeiko Schocher		Dfu transfer uses a buffer before writing data to the
1561e7e75c70SHeiko Schocher		raw storage device. Make the size (in bytes) of this buffer
1562e7e75c70SHeiko Schocher		configurable. The size of this buffer is also configurable
1563e7e75c70SHeiko Schocher		through the "dfu_bufsiz" environment variable.
1564e7e75c70SHeiko Schocher
1565ea2453d5SPantelis Antoniou		CONFIG_SYS_DFU_MAX_FILE_SIZE
1566ea2453d5SPantelis Antoniou		When updating files rather than the raw storage device,
1567ea2453d5SPantelis Antoniou		we use a static buffer to copy the file into and then write
1568ea2453d5SPantelis Antoniou		the buffer once we've been given the whole file.  Define
1569ea2453d5SPantelis Antoniou		this to the maximum filesize (in bytes) for the buffer.
1570ea2453d5SPantelis Antoniou		Default is 4 MiB if undefined.
1571ea2453d5SPantelis Antoniou
1572001a8319SHeiko Schocher		DFU_DEFAULT_POLL_TIMEOUT
1573001a8319SHeiko Schocher		Poll timeout [ms], is the timeout a device can send to the
1574001a8319SHeiko Schocher		host. The host must wait for this timeout before sending
1575001a8319SHeiko Schocher		a subsequent DFU_GET_STATUS request to the device.
1576001a8319SHeiko Schocher
1577001a8319SHeiko Schocher		DFU_MANIFEST_POLL_TIMEOUT
1578001a8319SHeiko Schocher		Poll timeout [ms], which the device sends to the host when
1579001a8319SHeiko Schocher		entering dfuMANIFEST state. Host waits this timeout, before
1580001a8319SHeiko Schocher		sending again an USB request to the device.
1581001a8319SHeiko Schocher
15826705d81eSwdenk- Journaling Flash filesystem support:
15836705d81eSwdenk		CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
15846705d81eSwdenk		CONFIG_JFFS2_NAND_DEV
15856705d81eSwdenk		Define these for a default partition on a NAND device
15866705d81eSwdenk
15876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_SECTOR,
15886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
15896705d81eSwdenk		Define these for a default partition on a NOR device
15906705d81eSwdenk
15916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS_CUSTOM_PART
15926705d81eSwdenk		Define this to create an own partition. You have to provide a
15936705d81eSwdenk		function struct part_info* jffs2_part_info(int part_num)
15946705d81eSwdenk
15956705d81eSwdenk		If you define only one JFFS2 partition you may also want to
15966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_JFFS_SINGLE_PART	1
15976705d81eSwdenk		to disable the command chpart. This is the default when you
15986705d81eSwdenk		have not defined a custom partition
15996705d81eSwdenk
1600c30a15e5SDonggeun Kim- FAT(File Allocation Table) filesystem write function support:
1601c30a15e5SDonggeun Kim		CONFIG_FAT_WRITE
1602656f4c65SDonggeun Kim
1603656f4c65SDonggeun Kim		Define this to enable support for saving memory data as a
1604656f4c65SDonggeun Kim		file in FAT formatted partition.
1605656f4c65SDonggeun Kim
1606656f4c65SDonggeun Kim		This will also enable the command "fatwrite" enabling the
1607656f4c65SDonggeun Kim		user to write files to FAT.
1608c30a15e5SDonggeun Kim
160984cd9327SGabe BlackCBFS (Coreboot Filesystem) support
161084cd9327SGabe Black		CONFIG_CMD_CBFS
161184cd9327SGabe Black
161284cd9327SGabe Black		Define this to enable support for reading from a Coreboot
161384cd9327SGabe Black		filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
161484cd9327SGabe Black		and cbfsload.
161584cd9327SGabe Black
1616c609719bSwdenk- Keyboard Support:
1617c609719bSwdenk		CONFIG_ISA_KEYBOARD
1618c609719bSwdenk
1619c609719bSwdenk		Define this to enable standard (PC-Style) keyboard
1620c609719bSwdenk		support
1621c609719bSwdenk
1622c609719bSwdenk		CONFIG_I8042_KBD
1623c609719bSwdenk		Standard PC keyboard driver with US (is default) and
1624c609719bSwdenk		GERMAN key layout (switch via environment 'keymap=de') support.
1625c609719bSwdenk		Export function i8042_kbd_init, i8042_tstc and i8042_getc
1626c609719bSwdenk		for cfb_console. Supports cursor blinking.
1627c609719bSwdenk
1628713cb680SHung-ying Tyan		CONFIG_CROS_EC_KEYB
1629713cb680SHung-ying Tyan		Enables a Chrome OS keyboard using the CROS_EC interface.
1630713cb680SHung-ying Tyan		This uses CROS_EC to communicate with a second microcontroller
1631713cb680SHung-ying Tyan		which provides key scans on request.
1632713cb680SHung-ying Tyan
1633c609719bSwdenk- Video support:
1634c609719bSwdenk		CONFIG_VIDEO
1635c609719bSwdenk
1636c609719bSwdenk		Define this to enable video support (for output to
1637c609719bSwdenk		video).
1638c609719bSwdenk
1639c609719bSwdenk		CONFIG_VIDEO_CT69000
1640c609719bSwdenk
1641c609719bSwdenk		Enable Chips & Technologies 69000 Video chip
1642c609719bSwdenk
1643c609719bSwdenk		CONFIG_VIDEO_SMI_LYNXEM
1644eeb1b77bSwdenk		Enable Silicon Motion SMI 712/710/810 Video chip. The
1645eeb1b77bSwdenk		video output is selected via environment 'videoout'
1646eeb1b77bSwdenk		(1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1647eeb1b77bSwdenk		assumed.
1648c609719bSwdenk
1649eeb1b77bSwdenk		For the CT69000 and SMI_LYNXEM drivers, videomode is
165011ccc33fSMarcel Ziswiler		selected via environment 'videomode'. Two different ways
1651eeb1b77bSwdenk		are possible:
1652eeb1b77bSwdenk		- "videomode=num"   'num' is a standard LiLo mode numbers.
1653eeb1b77bSwdenk		Following standard modes are supported	(* is default):
1654eeb1b77bSwdenk
1655eeb1b77bSwdenk		      Colors	640x480 800x600 1024x768 1152x864 1280x1024
1656eeb1b77bSwdenk		-------------+---------------------------------------------
1657eeb1b77bSwdenk		      8 bits |	0x301*	0x303	 0x305	  0x161	    0x307
1658eeb1b77bSwdenk		     15 bits |	0x310	0x313	 0x316	  0x162	    0x319
1659eeb1b77bSwdenk		     16 bits |	0x311	0x314	 0x317	  0x163	    0x31A
1660eeb1b77bSwdenk		     24 bits |	0x312	0x315	 0x318	    ?	    0x31B
1661eeb1b77bSwdenk		-------------+---------------------------------------------
1662c609719bSwdenk		(i.e. setenv videomode 317; saveenv; reset;)
1663c609719bSwdenk
1664eeb1b77bSwdenk		- "videomode=bootargs" all the video parameters are parsed
16657817cb20SMarcel Ziswiler		from the bootargs. (See drivers/video/videomodes.c)
1666eeb1b77bSwdenk
1667eeb1b77bSwdenk
1668a6c7ad2fSwdenk		CONFIG_VIDEO_SED13806
1669a6c7ad2fSwdenk		Enable Epson SED13806 driver. This driver supports 8bpp
1670a6c7ad2fSwdenk		and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1671a6c7ad2fSwdenk		or CONFIG_VIDEO_SED13806_16BPP
1672a6c7ad2fSwdenk
16737d3053fbSTimur Tabi		CONFIG_FSL_DIU_FB
16747d3053fbSTimur Tabi		Enable the Freescale DIU video driver.	Reference boards for
16757d3053fbSTimur Tabi		SOCs that have a DIU should define this macro to enable DIU
16767d3053fbSTimur Tabi		support, and should also define these other macros:
16777d3053fbSTimur Tabi
16787d3053fbSTimur Tabi			CONFIG_SYS_DIU_ADDR
16797d3053fbSTimur Tabi			CONFIG_VIDEO
16807d3053fbSTimur Tabi			CONFIG_CMD_BMP
16817d3053fbSTimur Tabi			CONFIG_CFB_CONSOLE
16827d3053fbSTimur Tabi			CONFIG_VIDEO_SW_CURSOR
16837d3053fbSTimur Tabi			CONFIG_VGA_AS_SINGLE_DEVICE
16847d3053fbSTimur Tabi			CONFIG_VIDEO_LOGO
16857d3053fbSTimur Tabi			CONFIG_VIDEO_BMP_LOGO
16867d3053fbSTimur Tabi
1687ba8e76bdSTimur Tabi		The DIU driver will look for the 'video-mode' environment
1688ba8e76bdSTimur Tabi		variable, and if defined, enable the DIU as a console during
1689ba8e76bdSTimur Tabi		boot.  See the documentation file README.video for a
1690ba8e76bdSTimur Tabi		description of this variable.
16917d3053fbSTimur Tabi
1692058d59b0SSimon Glass		CONFIG_VIDEO_VGA
1693058d59b0SSimon Glass
1694058d59b0SSimon Glass		Enable the VGA video / BIOS for x86. The alternative if you
1695058d59b0SSimon Glass		are using coreboot is to use the coreboot frame buffer
1696058d59b0SSimon Glass		driver.
1697058d59b0SSimon Glass
1698058d59b0SSimon Glass
1699682011ffSwdenk- Keyboard Support:
1700682011ffSwdenk		CONFIG_KEYBOARD
1701682011ffSwdenk
1702682011ffSwdenk		Define this to enable a custom keyboard support.
1703682011ffSwdenk		This simply calls drv_keyboard_init() which must be
1704682011ffSwdenk		defined in your board-specific files.
1705682011ffSwdenk		The only board using this so far is RBC823.
1706a6c7ad2fSwdenk
1707c609719bSwdenk- LCD Support:	CONFIG_LCD
1708c609719bSwdenk
1709c609719bSwdenk		Define this to enable LCD support (for output to LCD
1710c609719bSwdenk		display); also select one of the supported displays
1711c609719bSwdenk		by defining one of these:
1712c609719bSwdenk
171339cf4804SStelian Pop		CONFIG_ATMEL_LCD:
171439cf4804SStelian Pop
171539cf4804SStelian Pop			HITACHI TX09D70VM1CCA, 3.5", 240x320.
171639cf4804SStelian Pop
1717fd3103bbSwdenk		CONFIG_NEC_NL6448AC33:
1718c609719bSwdenk
1719fd3103bbSwdenk			NEC NL6448AC33-18. Active, color, single scan.
1720c609719bSwdenk
1721fd3103bbSwdenk		CONFIG_NEC_NL6448BC20
1722c609719bSwdenk
1723fd3103bbSwdenk			NEC NL6448BC20-08. 6.5", 640x480.
1724fd3103bbSwdenk			Active, color, single scan.
1725fd3103bbSwdenk
1726fd3103bbSwdenk		CONFIG_NEC_NL6448BC33_54
1727fd3103bbSwdenk
1728fd3103bbSwdenk			NEC NL6448BC33-54. 10.4", 640x480.
1729c609719bSwdenk			Active, color, single scan.
1730c609719bSwdenk
1731c609719bSwdenk		CONFIG_SHARP_16x9
1732c609719bSwdenk
1733c609719bSwdenk			Sharp 320x240. Active, color, single scan.
1734c609719bSwdenk			It isn't 16x9, and I am not sure what it is.
1735c609719bSwdenk
1736c609719bSwdenk		CONFIG_SHARP_LQ64D341
1737c609719bSwdenk
1738c609719bSwdenk			Sharp LQ64D341 display, 640x480.
1739c609719bSwdenk			Active, color, single scan.
1740c609719bSwdenk
1741c609719bSwdenk		CONFIG_HLD1045
1742c609719bSwdenk
1743c609719bSwdenk			HLD1045 display, 640x480.
1744c609719bSwdenk			Active, color, single scan.
1745c609719bSwdenk
1746c609719bSwdenk		CONFIG_OPTREX_BW
1747c609719bSwdenk
1748c609719bSwdenk			Optrex	 CBL50840-2 NF-FW 99 22 M5
1749c609719bSwdenk			or
1750c609719bSwdenk			Hitachi	 LMG6912RPFC-00T
1751c609719bSwdenk			or
1752c609719bSwdenk			Hitachi	 SP14Q002
1753c609719bSwdenk
1754c609719bSwdenk			320x240. Black & white.
1755c609719bSwdenk
1756c609719bSwdenk		Normally display is black on white background; define
17576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
1758c609719bSwdenk
1759676d319eSSimon Glass		CONFIG_LCD_ALIGNMENT
1760676d319eSSimon Glass
1761676d319eSSimon Glass		Normally the LCD is page-aligned (tyically 4KB). If this is
1762676d319eSSimon Glass		defined then the LCD will be aligned to this value instead.
1763676d319eSSimon Glass		For ARM it is sometimes useful to use MMU_SECTION_SIZE
1764676d319eSSimon Glass		here, since it is cheaper to change data cache settings on
1765676d319eSSimon Glass		a per-section basis.
1766676d319eSSimon Glass
17670d89efefSSimon Glass		CONFIG_CONSOLE_SCROLL_LINES
17680d89efefSSimon Glass
17690d89efefSSimon Glass		When the console need to be scrolled, this is the number of
17700d89efefSSimon Glass		lines to scroll by. It defaults to 1. Increasing this makes
17710d89efefSSimon Glass		the console jump but can help speed up operation when scrolling
17720d89efefSSimon Glass		is slow.
1773676d319eSSimon Glass
177445d7f525STom Wai-Hong Tam		CONFIG_LCD_BMP_RLE8
177545d7f525STom Wai-Hong Tam
177645d7f525STom Wai-Hong Tam		Support drawing of RLE8-compressed bitmaps on the LCD.
177745d7f525STom Wai-Hong Tam
1778735987c5STom Wai-Hong Tam		CONFIG_I2C_EDID
1779735987c5STom Wai-Hong Tam
1780735987c5STom Wai-Hong Tam		Enables an 'i2c edid' command which can read EDID
1781735987c5STom Wai-Hong Tam		information over I2C from an attached LCD display.
1782735987c5STom Wai-Hong Tam
17837152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN
1784d791b1dcSwdenk
1785d791b1dcSwdenk		If this option is set, the environment is checked for
1786d791b1dcSwdenk		a variable "splashimage". If found, the usual display
1787d791b1dcSwdenk		of logo, copyright and system information on the LCD
1788e94d2cd9Swdenk		is suppressed and the BMP image at the address
1789d791b1dcSwdenk		specified in "splashimage" is loaded instead. The
1790d791b1dcSwdenk		console is redirected to the "nulldev", too. This
1791d791b1dcSwdenk		allows for a "silent" boot where a splash screen is
1792d791b1dcSwdenk		loaded very quickly after power-on.
1793d791b1dcSwdenk
1794c0880485SNikita Kiryanov		CONFIG_SPLASHIMAGE_GUARD
1795c0880485SNikita Kiryanov
1796c0880485SNikita Kiryanov		If this option is set, then U-Boot will prevent the environment
1797c0880485SNikita Kiryanov		variable "splashimage" from being set to a problematic address
17981551df35STom Rini		(see README.displaying-bmps).
1799c0880485SNikita Kiryanov		This option is useful for targets where, due to alignment
1800c0880485SNikita Kiryanov		restrictions, an improperly aligned BMP image will cause a data
1801c0880485SNikita Kiryanov		abort. If you think you will not have problems with unaligned
1802c0880485SNikita Kiryanov		accesses (for example because your toolchain prevents them)
1803c0880485SNikita Kiryanov		there is no need to set this option.
1804c0880485SNikita Kiryanov
18051ca298ceSMatthias Weisser		CONFIG_SPLASH_SCREEN_ALIGN
18061ca298ceSMatthias Weisser
18071ca298ceSMatthias Weisser		If this option is set the splash image can be freely positioned
18081ca298ceSMatthias Weisser		on the screen. Environment variable "splashpos" specifies the
18091ca298ceSMatthias Weisser		position as "x,y". If a positive number is given it is used as
18101ca298ceSMatthias Weisser		number of pixel from left/top. If a negative number is given it
18111ca298ceSMatthias Weisser		is used as number of pixel from right/bottom. You can also
18121ca298ceSMatthias Weisser		specify 'm' for centering the image.
18131ca298ceSMatthias Weisser
18141ca298ceSMatthias Weisser		Example:
18151ca298ceSMatthias Weisser		setenv splashpos m,m
18161ca298ceSMatthias Weisser			=> image at center of screen
18171ca298ceSMatthias Weisser
18181ca298ceSMatthias Weisser		setenv splashpos 30,20
18191ca298ceSMatthias Weisser			=> image at x = 30 and y = 20
18201ca298ceSMatthias Weisser
18211ca298ceSMatthias Weisser		setenv splashpos -10,m
18221ca298ceSMatthias Weisser			=> vertically centered image
18231ca298ceSMatthias Weisser			   at x = dspWidth - bmpWidth - 9
18241ca298ceSMatthias Weisser
182598f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
182698f4a3dfSStefan Roese
182798f4a3dfSStefan Roese		If this option is set, additionally to standard BMP
182898f4a3dfSStefan Roese		images, gzipped BMP images can be displayed via the
182998f4a3dfSStefan Roese		splashscreen support or the bmp command.
183098f4a3dfSStefan Roese
1831d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1832d5011762SAnatolij Gustschin
1833d5011762SAnatolij Gustschin		If this option is set, 8-bit RLE compressed BMP images
1834d5011762SAnatolij Gustschin		can be displayed via the splashscreen support or the
1835d5011762SAnatolij Gustschin		bmp command.
1836d5011762SAnatolij Gustschin
1837f2b96dfbSLei Wen- Do compresssing for memory range:
1838f2b96dfbSLei Wen		CONFIG_CMD_ZIP
1839f2b96dfbSLei Wen
1840f2b96dfbSLei Wen		If this option is set, it would use zlib deflate method
1841f2b96dfbSLei Wen		to compress the specified memory at its best effort.
1842f2b96dfbSLei Wen
1843c29fdfc1Swdenk- Compression support:
18448ef70478SKees Cook		CONFIG_GZIP
18458ef70478SKees Cook
18468ef70478SKees Cook		Enabled by default to support gzip compressed images.
18478ef70478SKees Cook
1848c29fdfc1Swdenk		CONFIG_BZIP2
1849c29fdfc1Swdenk
1850c29fdfc1Swdenk		If this option is set, support for bzip2 compressed
1851c29fdfc1Swdenk		images is included. If not, only uncompressed and gzip
1852c29fdfc1Swdenk		compressed images are supported.
1853c29fdfc1Swdenk
1854c29fdfc1Swdenk		NOTE: the bzip2 algorithm requires a lot of RAM, so
18556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
1856c29fdfc1Swdenk		be at least 4MB.
1857d791b1dcSwdenk
1858fc9c1727SLuigi 'Comio' Mantellini		CONFIG_LZMA
1859fc9c1727SLuigi 'Comio' Mantellini
1860fc9c1727SLuigi 'Comio' Mantellini		If this option is set, support for lzma compressed
1861fc9c1727SLuigi 'Comio' Mantellini		images is included.
1862fc9c1727SLuigi 'Comio' Mantellini
1863fc9c1727SLuigi 'Comio' Mantellini		Note: The LZMA algorithm adds between 2 and 4KB of code and it
1864fc9c1727SLuigi 'Comio' Mantellini		requires an amount of dynamic memory that is given by the
1865fc9c1727SLuigi 'Comio' Mantellini		formula:
1866fc9c1727SLuigi 'Comio' Mantellini
1867fc9c1727SLuigi 'Comio' Mantellini			(1846 + 768 << (lc + lp)) * sizeof(uint16)
1868fc9c1727SLuigi 'Comio' Mantellini
1869fc9c1727SLuigi 'Comio' Mantellini		Where lc and lp stand for, respectively, Literal context bits
1870fc9c1727SLuigi 'Comio' Mantellini		and Literal pos bits.
1871fc9c1727SLuigi 'Comio' Mantellini
1872fc9c1727SLuigi 'Comio' Mantellini		This value is upper-bounded by 14MB in the worst case. Anyway,
1873fc9c1727SLuigi 'Comio' Mantellini		for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1874fc9c1727SLuigi 'Comio' Mantellini		total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1875fc9c1727SLuigi 'Comio' Mantellini		a very small buffer.
1876fc9c1727SLuigi 'Comio' Mantellini
1877fc9c1727SLuigi 'Comio' Mantellini		Use the lzmainfo tool to determinate the lc and lp values and
1878fc9c1727SLuigi 'Comio' Mantellini		then calculate the amount of needed dynamic memory (ensuring
18796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the appropriate CONFIG_SYS_MALLOC_LEN value).
1880fc9c1727SLuigi 'Comio' Mantellini
18818ef70478SKees Cook		CONFIG_LZO
18828ef70478SKees Cook
18838ef70478SKees Cook		If this option is set, support for LZO compressed images
18848ef70478SKees Cook		is included.
18858ef70478SKees Cook
188617ea1177Swdenk- MII/PHY support:
188717ea1177Swdenk		CONFIG_PHY_ADDR
188817ea1177Swdenk
188917ea1177Swdenk		The address of PHY on MII bus.
189017ea1177Swdenk
189117ea1177Swdenk		CONFIG_PHY_CLOCK_FREQ (ppc4xx)
189217ea1177Swdenk
189317ea1177Swdenk		The clock frequency of the MII bus
189417ea1177Swdenk
189517ea1177Swdenk		CONFIG_PHY_GIGE
189617ea1177Swdenk
189717ea1177Swdenk		If this option is set, support for speed/duplex
189811ccc33fSMarcel Ziswiler		detection of gigabit PHY is included.
189917ea1177Swdenk
190017ea1177Swdenk		CONFIG_PHY_RESET_DELAY
190117ea1177Swdenk
190217ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
190317ea1177Swdenk		reset before any MII register access is possible.
190417ea1177Swdenk		For such PHY, set this option to the usec delay
190517ea1177Swdenk		required. (minimum 300usec for LXT971A)
190617ea1177Swdenk
190717ea1177Swdenk		CONFIG_PHY_CMD_DELAY (ppc4xx)
190817ea1177Swdenk
190917ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
191017ea1177Swdenk		command issued before MII status register can be read
191117ea1177Swdenk
1912c609719bSwdenk- Ethernet address:
1913c609719bSwdenk		CONFIG_ETHADDR
1914c68a05feSrichardretanubun		CONFIG_ETH1ADDR
1915c609719bSwdenk		CONFIG_ETH2ADDR
1916c609719bSwdenk		CONFIG_ETH3ADDR
1917c68a05feSrichardretanubun		CONFIG_ETH4ADDR
1918c68a05feSrichardretanubun		CONFIG_ETH5ADDR
1919c609719bSwdenk
192011ccc33fSMarcel Ziswiler		Define a default value for Ethernet address to use
192111ccc33fSMarcel Ziswiler		for the respective Ethernet interface, in case this
1922c609719bSwdenk		is not determined automatically.
1923c609719bSwdenk
1924c609719bSwdenk- IP address:
1925c609719bSwdenk		CONFIG_IPADDR
1926c609719bSwdenk
1927c609719bSwdenk		Define a default value for the IP address to use for
192811ccc33fSMarcel Ziswiler		the default Ethernet interface, in case this is not
1929c609719bSwdenk		determined through e.g. bootp.
19301ebcd654SWolfgang Denk		(Environment variable "ipaddr")
1931c609719bSwdenk
1932c609719bSwdenk- Server IP address:
1933c609719bSwdenk		CONFIG_SERVERIP
1934c609719bSwdenk
1935c609719bSwdenk		Defines a default value for the IP address of a TFTP
1936c609719bSwdenk		server to contact when using the "tftboot" command.
19371ebcd654SWolfgang Denk		(Environment variable "serverip")
1938c609719bSwdenk
193997cfe861SRobin Getz		CONFIG_KEEP_SERVERADDR
194097cfe861SRobin Getz
194197cfe861SRobin Getz		Keeps the server's MAC address, in the env 'serveraddr'
194297cfe861SRobin Getz		for passing to bootargs (like Linux's netconsole option)
194397cfe861SRobin Getz
19441ebcd654SWolfgang Denk- Gateway IP address:
19451ebcd654SWolfgang Denk		CONFIG_GATEWAYIP
19461ebcd654SWolfgang Denk
19471ebcd654SWolfgang Denk		Defines a default value for the IP address of the
19481ebcd654SWolfgang Denk		default router where packets to other networks are
19491ebcd654SWolfgang Denk		sent to.
19501ebcd654SWolfgang Denk		(Environment variable "gatewayip")
19511ebcd654SWolfgang Denk
19521ebcd654SWolfgang Denk- Subnet mask:
19531ebcd654SWolfgang Denk		CONFIG_NETMASK
19541ebcd654SWolfgang Denk
19551ebcd654SWolfgang Denk		Defines a default value for the subnet mask (or
19561ebcd654SWolfgang Denk		routing prefix) which is used to determine if an IP
19571ebcd654SWolfgang Denk		address belongs to the local subnet or needs to be
19581ebcd654SWolfgang Denk		forwarded through a router.
19591ebcd654SWolfgang Denk		(Environment variable "netmask")
19601ebcd654SWolfgang Denk
196153a5c424SDavid Updegraff- Multicast TFTP Mode:
196253a5c424SDavid Updegraff		CONFIG_MCAST_TFTP
196353a5c424SDavid Updegraff
196453a5c424SDavid Updegraff		Defines whether you want to support multicast TFTP as per
196553a5c424SDavid Updegraff		rfc-2090; for example to work with atftp.  Lets lots of targets
196611ccc33fSMarcel Ziswiler		tftp down the same boot image concurrently.  Note: the Ethernet
196753a5c424SDavid Updegraff		driver in use must provide a function: mcast() to join/leave a
196853a5c424SDavid Updegraff		multicast group.
196953a5c424SDavid Updegraff
1970c609719bSwdenk- BOOTP Recovery Mode:
1971c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY
1972c609719bSwdenk
1973c609719bSwdenk		If you have many targets in a network that try to
1974c609719bSwdenk		boot using BOOTP, you may want to avoid that all
1975c609719bSwdenk		systems send out BOOTP requests at precisely the same
1976c609719bSwdenk		moment (which would happen for instance at recovery
1977c609719bSwdenk		from a power failure, when all systems will try to
1978c609719bSwdenk		boot, thus flooding the BOOTP server. Defining
1979c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1980c609719bSwdenk		inserted before sending out BOOTP requests. The
19816c33c785SWolfgang Denk		following delays are inserted then:
1982c609719bSwdenk
1983c609719bSwdenk		1st BOOTP request:	delay 0 ... 1 sec
1984c609719bSwdenk		2nd BOOTP request:	delay 0 ... 2 sec
1985c609719bSwdenk		3rd BOOTP request:	delay 0 ... 4 sec
1986c609719bSwdenk		4th and following
1987c609719bSwdenk		BOOTP requests:		delay 0 ... 8 sec
1988c609719bSwdenk
1989fe389a82Sstroese- DHCP Advanced Options:
19901fe80d79SJon Loeliger		You can fine tune the DHCP functionality by defining
19911fe80d79SJon Loeliger		CONFIG_BOOTP_* symbols:
1992fe389a82Sstroese
19931fe80d79SJon Loeliger		CONFIG_BOOTP_SUBNETMASK
19941fe80d79SJon Loeliger		CONFIG_BOOTP_GATEWAY
19951fe80d79SJon Loeliger		CONFIG_BOOTP_HOSTNAME
19961fe80d79SJon Loeliger		CONFIG_BOOTP_NISDOMAIN
19971fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTPATH
19981fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTFILESIZE
19991fe80d79SJon Loeliger		CONFIG_BOOTP_DNS
20001fe80d79SJon Loeliger		CONFIG_BOOTP_DNS2
20011fe80d79SJon Loeliger		CONFIG_BOOTP_SEND_HOSTNAME
20021fe80d79SJon Loeliger		CONFIG_BOOTP_NTPSERVER
20031fe80d79SJon Loeliger		CONFIG_BOOTP_TIMEOFFSET
20041fe80d79SJon Loeliger		CONFIG_BOOTP_VENDOREX
20052c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL
2006fe389a82Sstroese
20075d110f0aSWilson Callan		CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
20085d110f0aSWilson Callan		environment variable, not the BOOTP server.
2009fe389a82Sstroese
20102c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
20112c00e099SJoe Hershberger		after the configured retry count, the call will fail
20122c00e099SJoe Hershberger		instead of starting over.  This can be used to fail over
20132c00e099SJoe Hershberger		to Link-local IP address configuration if the DHCP server
20142c00e099SJoe Hershberger		is not available.
20152c00e099SJoe Hershberger
2016fe389a82Sstroese		CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
2017fe389a82Sstroese		serverip from a DHCP server, it is possible that more
2018fe389a82Sstroese		than one DNS serverip is offered to the client.
2019fe389a82Sstroese		If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
2020fe389a82Sstroese		serverip will be stored in the additional environment
2021fe389a82Sstroese		variable "dnsip2". The first DNS serverip is always
2022fe389a82Sstroese		stored in the variable "dnsip", when CONFIG_BOOTP_DNS
20231fe80d79SJon Loeliger		is defined.
2024fe389a82Sstroese
2025fe389a82Sstroese		CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
2026fe389a82Sstroese		to do a dynamic update of a DNS server. To do this, they
2027fe389a82Sstroese		need the hostname of the DHCP requester.
20285d110f0aSWilson Callan		If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
20291fe80d79SJon Loeliger		of the "hostname" environment variable is passed as
20301fe80d79SJon Loeliger		option 12 to the DHCP server.
2031fe389a82Sstroese
2032d9a2f416SAras Vaichas		CONFIG_BOOTP_DHCP_REQUEST_DELAY
2033d9a2f416SAras Vaichas
2034d9a2f416SAras Vaichas		A 32bit value in microseconds for a delay between
2035d9a2f416SAras Vaichas		receiving a "DHCP Offer" and sending the "DHCP Request".
2036d9a2f416SAras Vaichas		This fixes a problem with certain DHCP servers that don't
2037d9a2f416SAras Vaichas		respond 100% of the time to a "DHCP request". E.g. On an
2038d9a2f416SAras Vaichas		AT91RM9200 processor running at 180MHz, this delay needed
2039d9a2f416SAras Vaichas		to be *at least* 15,000 usec before a Windows Server 2003
2040d9a2f416SAras Vaichas		DHCP server would reply 100% of the time. I recommend at
2041d9a2f416SAras Vaichas		least 50,000 usec to be safe. The alternative is to hope
2042d9a2f416SAras Vaichas		that one of the retries will be successful but note that
2043d9a2f416SAras Vaichas		the DHCP timeout and retry process takes a longer than
2044d9a2f416SAras Vaichas		this delay.
2045d9a2f416SAras Vaichas
2046d22c338eSJoe Hershberger - Link-local IP address negotiation:
2047d22c338eSJoe Hershberger		Negotiate with other link-local clients on the local network
2048d22c338eSJoe Hershberger		for an address that doesn't require explicit configuration.
2049d22c338eSJoe Hershberger		This is especially useful if a DHCP server cannot be guaranteed
2050d22c338eSJoe Hershberger		to exist in all environments that the device must operate.
2051d22c338eSJoe Hershberger
2052d22c338eSJoe Hershberger		See doc/README.link-local for more information.
2053d22c338eSJoe Hershberger
2054a3d991bdSwdenk - CDP Options:
2055a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID
2056a3d991bdSwdenk
2057a3d991bdSwdenk		The device id used in CDP trigger frames.
2058a3d991bdSwdenk
2059a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID_PREFIX
2060a3d991bdSwdenk
2061a3d991bdSwdenk		A two character string which is prefixed to the MAC address
2062a3d991bdSwdenk		of the device.
2063a3d991bdSwdenk
2064a3d991bdSwdenk		CONFIG_CDP_PORT_ID
2065a3d991bdSwdenk
2066a3d991bdSwdenk		A printf format string which contains the ascii name of
2067a3d991bdSwdenk		the port. Normally is set to "eth%d" which sets
206811ccc33fSMarcel Ziswiler		eth0 for the first Ethernet, eth1 for the second etc.
2069a3d991bdSwdenk
2070a3d991bdSwdenk		CONFIG_CDP_CAPABILITIES
2071a3d991bdSwdenk
2072a3d991bdSwdenk		A 32bit integer which indicates the device capabilities;
2073a3d991bdSwdenk		0x00000010 for a normal host which does not forwards.
2074a3d991bdSwdenk
2075a3d991bdSwdenk		CONFIG_CDP_VERSION
2076a3d991bdSwdenk
2077a3d991bdSwdenk		An ascii string containing the version of the software.
2078a3d991bdSwdenk
2079a3d991bdSwdenk		CONFIG_CDP_PLATFORM
2080a3d991bdSwdenk
2081a3d991bdSwdenk		An ascii string containing the name of the platform.
2082a3d991bdSwdenk
2083a3d991bdSwdenk		CONFIG_CDP_TRIGGER
2084a3d991bdSwdenk
2085a3d991bdSwdenk		A 32bit integer sent on the trigger.
2086a3d991bdSwdenk
2087a3d991bdSwdenk		CONFIG_CDP_POWER_CONSUMPTION
2088a3d991bdSwdenk
2089a3d991bdSwdenk		A 16bit integer containing the power consumption of the
2090a3d991bdSwdenk		device in .1 of milliwatts.
2091a3d991bdSwdenk
2092a3d991bdSwdenk		CONFIG_CDP_APPLIANCE_VLAN_TYPE
2093a3d991bdSwdenk
2094a3d991bdSwdenk		A byte containing the id of the VLAN.
2095a3d991bdSwdenk
2096c609719bSwdenk- Status LED:	CONFIG_STATUS_LED
2097c609719bSwdenk
2098c609719bSwdenk		Several configurations allow to display the current
2099c609719bSwdenk		status using a LED. For instance, the LED will blink
2100c609719bSwdenk		fast while running U-Boot code, stop blinking as
2101c609719bSwdenk		soon as a reply to a BOOTP request was received, and
2102c609719bSwdenk		start blinking slow once the Linux kernel is running
2103c609719bSwdenk		(supported by a status LED driver in the Linux
2104c609719bSwdenk		kernel). Defining CONFIG_STATUS_LED enables this
2105c609719bSwdenk		feature in U-Boot.
2106c609719bSwdenk
21071df7bbbaSIgor Grinberg		Additional options:
21081df7bbbaSIgor Grinberg
21091df7bbbaSIgor Grinberg		CONFIG_GPIO_LED
21101df7bbbaSIgor Grinberg		The status LED can be connected to a GPIO pin.
21111df7bbbaSIgor Grinberg		In such cases, the gpio_led driver can be used as a
21121df7bbbaSIgor Grinberg		status LED backend implementation. Define CONFIG_GPIO_LED
21131df7bbbaSIgor Grinberg		to include the gpio_led driver in the U-Boot binary.
21141df7bbbaSIgor Grinberg
21159dfdcdfeSIgor Grinberg		CONFIG_GPIO_LED_INVERTED_TABLE
21169dfdcdfeSIgor Grinberg		Some GPIO connected LEDs may have inverted polarity in which
21179dfdcdfeSIgor Grinberg		case the GPIO high value corresponds to LED off state and
21189dfdcdfeSIgor Grinberg		GPIO low value corresponds to LED on state.
21199dfdcdfeSIgor Grinberg		In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
21209dfdcdfeSIgor Grinberg		with a list of GPIO LEDs that have inverted polarity.
21219dfdcdfeSIgor Grinberg
2122c609719bSwdenk- CAN Support:	CONFIG_CAN_DRIVER
2123c609719bSwdenk
2124c609719bSwdenk		Defining CONFIG_CAN_DRIVER enables CAN driver support
2125c609719bSwdenk		on those systems that support this (optional)
2126c609719bSwdenk		feature, like the TQM8xxL modules.
2127c609719bSwdenk
21283f4978c7SHeiko Schocher- I2C Support:	CONFIG_SYS_I2C
2129c609719bSwdenk
21303f4978c7SHeiko Schocher		This enable the NEW i2c subsystem, and will allow you to use
21313f4978c7SHeiko Schocher		i2c commands at the u-boot command line (as long as you set
21323f4978c7SHeiko Schocher		CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
21333f4978c7SHeiko Schocher		based realtime clock chips or other i2c devices. See
21343f4978c7SHeiko Schocher		common/cmd_i2c.c for a description of the command line
21353f4978c7SHeiko Schocher		interface.
21363f4978c7SHeiko Schocher
21373f4978c7SHeiko Schocher		ported i2c driver to the new framework:
2138ea818dbbSHeiko Schocher		- drivers/i2c/soft_i2c.c:
2139ea818dbbSHeiko Schocher		  - activate first bus with CONFIG_SYS_I2C_SOFT define
2140ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2141ea818dbbSHeiko Schocher		    for defining speed and slave address
2142ea818dbbSHeiko Schocher		  - activate second bus with I2C_SOFT_DECLARATIONS2 define
2143ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2144ea818dbbSHeiko Schocher		    for defining speed and slave address
2145ea818dbbSHeiko Schocher		  - activate third bus with I2C_SOFT_DECLARATIONS3 define
2146ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2147ea818dbbSHeiko Schocher		    for defining speed and slave address
2148ea818dbbSHeiko Schocher		  - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2149ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2150ea818dbbSHeiko Schocher		    for defining speed and slave address
21513f4978c7SHeiko Schocher
215200f792e0SHeiko Schocher		- drivers/i2c/fsl_i2c.c:
215300f792e0SHeiko Schocher		  - activate i2c driver with CONFIG_SYS_I2C_FSL
215400f792e0SHeiko Schocher		    define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
215500f792e0SHeiko Schocher		    offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
215600f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
215700f792e0SHeiko Schocher		    bus.
215800f792e0SHeiko Schocher		  - If your board supports a second fsl i2c bus, define
215900f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
216000f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_SPEED for the speed and
216100f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
216200f792e0SHeiko Schocher		    second bus.
216300f792e0SHeiko Schocher
21641f2ba722SSimon Glass		- drivers/i2c/tegra_i2c.c:
21651f2ba722SSimon Glass		  - activate this driver with CONFIG_SYS_I2C_TEGRA
21661f2ba722SSimon Glass		  - This driver adds 4 i2c buses with a fix speed from
21671f2ba722SSimon Glass		    100000 and the slave addr 0!
21681f2ba722SSimon Glass
2169880540deSDirk Eibach		- drivers/i2c/ppc4xx_i2c.c
2170880540deSDirk Eibach		  - activate this driver with CONFIG_SYS_I2C_PPC4XX
2171880540deSDirk Eibach		  - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2172880540deSDirk Eibach		  - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2173880540deSDirk Eibach
2174fac96408Strem		- drivers/i2c/i2c_mxc.c
2175fac96408Strem		  - activate this driver with CONFIG_SYS_I2C_MXC
2176fac96408Strem		  - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2177fac96408Strem		  - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2178fac96408Strem		  - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2179fac96408Strem		  - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2180fac96408Strem		  - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2181fac96408Strem		  - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
2182fac96408Strem		If thoses defines are not set, default value is 100000
2183fac96408Strem		for speed, and 0 for slave.
2184fac96408Strem
21851086bfa9SNobuhiro Iwamatsu		- drivers/i2c/rcar_i2c.c:
21861086bfa9SNobuhiro Iwamatsu		  - activate this driver with CONFIG_SYS_I2C_RCAR
21871086bfa9SNobuhiro Iwamatsu		  - This driver adds 4 i2c buses
21881086bfa9SNobuhiro Iwamatsu
21891086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
21901086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
21911086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
21921086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
21931086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
21941086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
21951086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
21961086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
21971086bfa9SNobuhiro Iwamatsu		  - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
21981086bfa9SNobuhiro Iwamatsu
21992035d77dSNobuhiro Iwamatsu		- drivers/i2c/sh_i2c.c:
22002035d77dSNobuhiro Iwamatsu		  - activate this driver with CONFIG_SYS_I2C_SH
22012035d77dSNobuhiro Iwamatsu		  - This driver adds from 2 to 5 i2c buses
22022035d77dSNobuhiro Iwamatsu
22032035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
22042035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
22052035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
22062035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
22072035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
22082035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
22092035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
22102035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
22112035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
22122035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
22132035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
22142035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
22152035d77dSNobuhiro Iwamatsu		  - CONFIF_SYS_I2C_SH_NUM_CONTROLLERS for nummber of i2c buses
22162035d77dSNobuhiro Iwamatsu
22176789e84eSHeiko Schocher		- drivers/i2c/omap24xx_i2c.c
22186789e84eSHeiko Schocher		  - activate this driver with CONFIG_SYS_I2C_OMAP24XX
22196789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
22206789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
22216789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
22226789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
22236789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
22246789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
22256789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
22266789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
22276789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
22286789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
22296789e84eSHeiko Schocher
22300bdffe71SHeiko Schocher		- drivers/i2c/zynq_i2c.c
22310bdffe71SHeiko Schocher		  - activate this driver with CONFIG_SYS_I2C_ZYNQ
22320bdffe71SHeiko Schocher		  - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
22330bdffe71SHeiko Schocher		  - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
22340bdffe71SHeiko Schocher
2235e717fc6dSNaveen Krishna Ch		- drivers/i2c/s3c24x0_i2c.c:
2236e717fc6dSNaveen Krishna Ch		  - activate this driver with CONFIG_SYS_I2C_S3C24X0
2237e717fc6dSNaveen Krishna Ch		  - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2238e717fc6dSNaveen Krishna Ch		    9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2239e717fc6dSNaveen Krishna Ch		    with a fix speed from 100000 and the slave addr 0!
2240e717fc6dSNaveen Krishna Ch
22413f4978c7SHeiko Schocher		additional defines:
22423f4978c7SHeiko Schocher
22433f4978c7SHeiko Schocher		CONFIG_SYS_NUM_I2C_BUSES
22443f4978c7SHeiko Schocher		Hold the number of i2c busses you want to use. If you
22453f4978c7SHeiko Schocher		don't use/have i2c muxes on your i2c bus, this
22463f4978c7SHeiko Schocher		is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
22473f4978c7SHeiko Schocher		omit this define.
22483f4978c7SHeiko Schocher
22493f4978c7SHeiko Schocher		CONFIG_SYS_I2C_DIRECT_BUS
22503f4978c7SHeiko Schocher		define this, if you don't use i2c muxes on your hardware.
22513f4978c7SHeiko Schocher		if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
22523f4978c7SHeiko Schocher		omit this define.
22533f4978c7SHeiko Schocher
22543f4978c7SHeiko Schocher		CONFIG_SYS_I2C_MAX_HOPS
22553f4978c7SHeiko Schocher		define how many muxes are maximal consecutively connected
22563f4978c7SHeiko Schocher		on one i2c bus. If you not use i2c muxes, omit this
22573f4978c7SHeiko Schocher		define.
22583f4978c7SHeiko Schocher
22593f4978c7SHeiko Schocher		CONFIG_SYS_I2C_BUSES
22603f4978c7SHeiko Schocher		hold a list of busses you want to use, only used if
22613f4978c7SHeiko Schocher		CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
22623f4978c7SHeiko Schocher		a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
22633f4978c7SHeiko Schocher		CONFIG_SYS_NUM_I2C_BUSES = 9:
22643f4978c7SHeiko Schocher
22653f4978c7SHeiko Schocher		 CONFIG_SYS_I2C_BUSES	{{0, {I2C_NULL_HOP}}, \
22663f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
22673f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
22683f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
22693f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
22703f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
22713f4978c7SHeiko Schocher					{1, {I2C_NULL_HOP}}, \
22723f4978c7SHeiko Schocher					{1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
22733f4978c7SHeiko Schocher					{1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
22743f4978c7SHeiko Schocher					}
22753f4978c7SHeiko Schocher
22763f4978c7SHeiko Schocher		which defines
22773f4978c7SHeiko Schocher			bus 0 on adapter 0 without a mux
2278ea818dbbSHeiko Schocher			bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2279ea818dbbSHeiko Schocher			bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2280ea818dbbSHeiko Schocher			bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2281ea818dbbSHeiko Schocher			bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2282ea818dbbSHeiko Schocher			bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
22833f4978c7SHeiko Schocher			bus 6 on adapter 1 without a mux
2284ea818dbbSHeiko Schocher			bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2285ea818dbbSHeiko Schocher			bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
22863f4978c7SHeiko Schocher
22873f4978c7SHeiko Schocher		If you do not have i2c muxes on your board, omit this define.
22883f4978c7SHeiko Schocher
2289ea818dbbSHeiko Schocher- Legacy I2C Support:	CONFIG_HARD_I2C
22903f4978c7SHeiko Schocher
22913f4978c7SHeiko Schocher		NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
22923f4978c7SHeiko Schocher		provides the following compelling advantages:
22933f4978c7SHeiko Schocher
22943f4978c7SHeiko Schocher		- more than one i2c adapter is usable
22953f4978c7SHeiko Schocher		- approved multibus support
22963f4978c7SHeiko Schocher		- better i2c mux support
22973f4978c7SHeiko Schocher
22983f4978c7SHeiko Schocher		** Please consider updating your I2C driver now. **
22993f4978c7SHeiko Schocher
2300ea818dbbSHeiko Schocher		These enable legacy I2C serial bus commands. Defining
2301ea818dbbSHeiko Schocher		CONFIG_HARD_I2C will include the appropriate I2C driver
2302ea818dbbSHeiko Schocher		for the selected CPU.
2303c609719bSwdenk
2304b37c7e5eSwdenk		This will allow you to use i2c commands at the u-boot
2305602ad3b3SJon Loeliger		command line (as long as you set CONFIG_CMD_I2C in
2306b37c7e5eSwdenk		CONFIG_COMMANDS) and communicate with i2c based realtime
2307b37c7e5eSwdenk		clock chips. See common/cmd_i2c.c for a description of the
2308c609719bSwdenk		command line interface.
2309c609719bSwdenk
2310bb99ad6dSBen Warren		CONFIG_HARD_I2C selects a hardware I2C controller.
2311c609719bSwdenk
2312b37c7e5eSwdenk		There are several other quantities that must also be
2313ea818dbbSHeiko Schocher		defined when you define CONFIG_HARD_I2C.
2314c609719bSwdenk
23156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		In both cases you will need to define CONFIG_SYS_I2C_SPEED
2316b37c7e5eSwdenk		to be the frequency (in Hz) at which you wish your i2c bus
23176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
231811ccc33fSMarcel Ziswiler		the CPU's i2c node address).
2319c609719bSwdenk
23208d321b81SPeter Tyser		Now, the u-boot i2c code for the mpc8xx
2321a47a12beSStefan Roese		(arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
23228d321b81SPeter Tyser		and so its address should therefore be cleared to 0 (See,
23238d321b81SPeter Tyser		eg, MPC823e User's Manual p.16-473). So, set
23248d321b81SPeter Tyser		CONFIG_SYS_I2C_SLAVE to 0.
2325b37c7e5eSwdenk
23265da71efaSEric Millbrandt		CONFIG_SYS_I2C_INIT_MPC5XXX
23275da71efaSEric Millbrandt
23285da71efaSEric Millbrandt		When a board is reset during an i2c bus transfer
23295da71efaSEric Millbrandt		chips might think that the current transfer is still
23305da71efaSEric Millbrandt		in progress.  Reset the slave devices by sending start
23315da71efaSEric Millbrandt		commands until the slave device responds.
23325da71efaSEric Millbrandt
2333b37c7e5eSwdenk		That's all that's required for CONFIG_HARD_I2C.
2334b37c7e5eSwdenk
2335ea818dbbSHeiko Schocher		If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
2336b37c7e5eSwdenk		then the following macros need to be defined (examples are
2337b37c7e5eSwdenk		from include/configs/lwmon.h):
2338c609719bSwdenk
2339c609719bSwdenk		I2C_INIT
2340c609719bSwdenk
2341b37c7e5eSwdenk		(Optional). Any commands necessary to enable the I2C
2342c609719bSwdenk		controller or configure ports.
2343c609719bSwdenk
2344b37c7e5eSwdenk		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
2345b37c7e5eSwdenk
2346c609719bSwdenk		I2C_PORT
2347c609719bSwdenk
2348c609719bSwdenk		(Only for MPC8260 CPU). The I/O port to use (the code
2349c609719bSwdenk		assumes both bits are on the same port). Valid values
2350c609719bSwdenk		are 0..3 for ports A..D.
2351c609719bSwdenk
2352c609719bSwdenk		I2C_ACTIVE
2353c609719bSwdenk
2354c609719bSwdenk		The code necessary to make the I2C data line active
2355c609719bSwdenk		(driven).  If the data line is open collector, this
2356c609719bSwdenk		define can be null.
2357c609719bSwdenk
2358b37c7e5eSwdenk		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
2359b37c7e5eSwdenk
2360c609719bSwdenk		I2C_TRISTATE
2361c609719bSwdenk
2362c609719bSwdenk		The code necessary to make the I2C data line tri-stated
2363c609719bSwdenk		(inactive).  If the data line is open collector, this
2364c609719bSwdenk		define can be null.
2365c609719bSwdenk
2366b37c7e5eSwdenk		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2367b37c7e5eSwdenk
2368c609719bSwdenk		I2C_READ
2369c609719bSwdenk
2370472d5460SYork Sun		Code that returns true if the I2C data line is high,
2371472d5460SYork Sun		false if it is low.
2372c609719bSwdenk
2373b37c7e5eSwdenk		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2374b37c7e5eSwdenk
2375c609719bSwdenk		I2C_SDA(bit)
2376c609719bSwdenk
2377472d5460SYork Sun		If <bit> is true, sets the I2C data line high. If it
2378472d5460SYork Sun		is false, it clears it (low).
2379c609719bSwdenk
2380b37c7e5eSwdenk		eg: #define I2C_SDA(bit) \
2381b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
2382b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
2383b37c7e5eSwdenk
2384c609719bSwdenk		I2C_SCL(bit)
2385c609719bSwdenk
2386472d5460SYork Sun		If <bit> is true, sets the I2C clock line high. If it
2387472d5460SYork Sun		is false, it clears it (low).
2388c609719bSwdenk
2389b37c7e5eSwdenk		eg: #define I2C_SCL(bit) \
2390b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
2391b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
2392b37c7e5eSwdenk
2393c609719bSwdenk		I2C_DELAY
2394c609719bSwdenk
2395c609719bSwdenk		This delay is invoked four times per clock cycle so this
2396c609719bSwdenk		controls the rate of data transfer.  The data rate thus
2397b37c7e5eSwdenk		is 1 / (I2C_DELAY * 4). Often defined to be something
2398b37c7e5eSwdenk		like:
2399b37c7e5eSwdenk
2400b37c7e5eSwdenk		#define I2C_DELAY  udelay(2)
2401c609719bSwdenk
2402793b5726SMike Frysinger		CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2403793b5726SMike Frysinger
2404793b5726SMike Frysinger		If your arch supports the generic GPIO framework (asm/gpio.h),
2405793b5726SMike Frysinger		then you may alternatively define the two GPIOs that are to be
2406793b5726SMike Frysinger		used as SCL / SDA.  Any of the previous I2C_xxx macros will
2407793b5726SMike Frysinger		have GPIO-based defaults assigned to them as appropriate.
2408793b5726SMike Frysinger
2409793b5726SMike Frysinger		You should define these to the GPIO value as given directly to
2410793b5726SMike Frysinger		the generic GPIO functions.
2411793b5726SMike Frysinger
24126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_INIT_BOARD
241347cd00faSwdenk
241447cd00faSwdenk		When a board is reset during an i2c bus transfer
241547cd00faSwdenk		chips might think that the current transfer is still
241647cd00faSwdenk		in progress. On some boards it is possible to access
241747cd00faSwdenk		the i2c SCLK line directly, either by using the
241847cd00faSwdenk		processor pin as a GPIO or by having a second pin
241947cd00faSwdenk		connected to the bus. If this option is defined a
242047cd00faSwdenk		custom i2c_init_board() routine in boards/xxx/board.c
242147cd00faSwdenk		is run early in the boot sequence.
242247cd00faSwdenk
242326a33504SRichard Retanubun		CONFIG_SYS_I2C_BOARD_LATE_INIT
242426a33504SRichard Retanubun
242526a33504SRichard Retanubun		An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
242626a33504SRichard Retanubun		defined a custom i2c_board_late_init() routine in
242726a33504SRichard Retanubun		boards/xxx/board.c is run AFTER the operations in i2c_init()
242826a33504SRichard Retanubun		is completed. This callpoint can be used to unreset i2c bus
242926a33504SRichard Retanubun		using CPU i2c controller register accesses for CPUs whose i2c
243026a33504SRichard Retanubun		controller provide such a method. It is called at the end of
243126a33504SRichard Retanubun		i2c_init() to allow i2c_init operations to setup the i2c bus
243226a33504SRichard Retanubun		controller on the CPU (e.g. setting bus speed & slave address).
243326a33504SRichard Retanubun
243417ea1177Swdenk		CONFIG_I2CFAST (PPC405GP|PPC405EP only)
243517ea1177Swdenk
243617ea1177Swdenk		This option enables configuration of bi_iic_fast[] flags
243717ea1177Swdenk		in u-boot bd_info structure based on u-boot environment
243817ea1177Swdenk		variable "i2cfast". (see also i2cfast)
243917ea1177Swdenk
2440bb99ad6dSBen Warren		CONFIG_I2C_MULTI_BUS
2441bb99ad6dSBen Warren
2442bb99ad6dSBen Warren		This option allows the use of multiple I2C buses, each of which
2443bb99ad6dSBen Warren		must have a controller.	 At any point in time, only one bus is
2444bb99ad6dSBen Warren		active.	 To switch to a different bus, use the 'i2c dev' command.
2445bb99ad6dSBen Warren		Note that bus numbering is zero-based.
2446bb99ad6dSBen Warren
24476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_NOPROBES
2448bb99ad6dSBen Warren
2449bb99ad6dSBen Warren		This option specifies a list of I2C devices that will be skipped
24500f89c54bSPeter Tyser		when the 'i2c probe' command is issued.	 If CONFIG_I2C_MULTI_BUS
24510f89c54bSPeter Tyser		is set, specify a list of bus-device pairs.  Otherwise, specify
24520f89c54bSPeter Tyser		a 1D array of device addresses
2453bb99ad6dSBen Warren
2454bb99ad6dSBen Warren		e.g.
2455bb99ad6dSBen Warren			#undef	CONFIG_I2C_MULTI_BUS
24566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
2457bb99ad6dSBen Warren
2458bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on a board with one I2C bus
2459bb99ad6dSBen Warren
2460bb99ad6dSBen Warren			#define CONFIG_I2C_MULTI_BUS
24616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_MULTI_NOPROBES	{{0,0x50},{0,0x68},{1,0x54}}
2462bb99ad6dSBen Warren
2463bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2464bb99ad6dSBen Warren
24656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SPD_BUS_NUM
2466be5e6181STimur Tabi
2467be5e6181STimur Tabi		If defined, then this indicates the I2C bus number for DDR SPD.
2468be5e6181STimur Tabi		If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2469be5e6181STimur Tabi
24706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_BUS_NUM
24710dc018ecSStefan Roese
24720dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the RTC.
24730dc018ecSStefan Roese		If not defined, then U-Boot assumes that RTC is on I2C bus 0.
24740dc018ecSStefan Roese
24756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_DTT_BUS_NUM
24760dc018ecSStefan Roese
24770dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the DTT.
24780dc018ecSStefan Roese		If not defined, then U-Boot assumes that DTT is on I2C bus 0.
24790dc018ecSStefan Roese
24806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_DTT_ADDR:
24819ebbb54fSVictor Gallardo
24829ebbb54fSVictor Gallardo		If defined, specifies the I2C address of the DTT device.
24839ebbb54fSVictor Gallardo		If not defined, then U-Boot uses predefined value for
24849ebbb54fSVictor Gallardo		specified DTT device.
24859ebbb54fSVictor Gallardo
24862ac6985aSAndrew Dyer		CONFIG_SOFT_I2C_READ_REPEATED_START
24872ac6985aSAndrew Dyer
24882ac6985aSAndrew Dyer		defining this will force the i2c_read() function in
24892ac6985aSAndrew Dyer		the soft_i2c driver to perform an I2C repeated start
24902ac6985aSAndrew Dyer		between writing the address pointer and reading the
24912ac6985aSAndrew Dyer		data.  If this define is omitted the default behaviour
24922ac6985aSAndrew Dyer		of doing a stop-start sequence will be used.  Most I2C
24932ac6985aSAndrew Dyer		devices can use either method, but some require one or
24942ac6985aSAndrew Dyer		the other.
2495be5e6181STimur Tabi
2496c609719bSwdenk- SPI Support:	CONFIG_SPI
2497c609719bSwdenk
2498c609719bSwdenk		Enables SPI driver (so far only tested with
2499c609719bSwdenk		SPI EEPROM, also an instance works with Crystal A/D and
2500c609719bSwdenk		D/As on the SACSng board)
2501c609719bSwdenk
25026639562eSYoshihiro Shimoda		CONFIG_SH_SPI
25036639562eSYoshihiro Shimoda
25046639562eSYoshihiro Shimoda		Enables the driver for SPI controller on SuperH. Currently
25056639562eSYoshihiro Shimoda		only SH7757 is supported.
25066639562eSYoshihiro Shimoda
2507c609719bSwdenk		CONFIG_SPI_X
2508c609719bSwdenk
2509c609719bSwdenk		Enables extended (16-bit) SPI EEPROM addressing.
2510c609719bSwdenk		(symmetrical to CONFIG_I2C_X)
2511c609719bSwdenk
2512c609719bSwdenk		CONFIG_SOFT_SPI
2513c609719bSwdenk
2514c609719bSwdenk		Enables a software (bit-bang) SPI driver rather than
2515c609719bSwdenk		using hardware support. This is a general purpose
2516c609719bSwdenk		driver that only requires three general I/O port pins
2517c609719bSwdenk		(two outputs, one input) to function. If this is
2518c609719bSwdenk		defined, the board configuration must define several
2519c609719bSwdenk		SPI configuration items (port pins to use, etc). For
2520c609719bSwdenk		an example, see include/configs/sacsng.h.
2521c609719bSwdenk
252204a9e118SBen Warren		CONFIG_HARD_SPI
252304a9e118SBen Warren
252404a9e118SBen Warren		Enables a hardware SPI driver for general-purpose reads
252504a9e118SBen Warren		and writes.  As with CONFIG_SOFT_SPI, the board configuration
252604a9e118SBen Warren		must define a list of chip-select function pointers.
252704a9e118SBen Warren		Currently supported on some MPC8xxx processors.	 For an
252804a9e118SBen Warren		example, see include/configs/mpc8349emds.h.
252904a9e118SBen Warren
253038254f45SGuennadi Liakhovetski		CONFIG_MXC_SPI
253138254f45SGuennadi Liakhovetski
253238254f45SGuennadi Liakhovetski		Enables the driver for the SPI controllers on i.MX and MXC
25332e3cd1cdSFabio Estevam		SoCs. Currently i.MX31/35/51 are supported.
253438254f45SGuennadi Liakhovetski
25350133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA
25360133502eSMatthias Fuchs
25370133502eSMatthias Fuchs		Enables FPGA subsystem.
25380133502eSMatthias Fuchs
25390133502eSMatthias Fuchs		CONFIG_FPGA_<vendor>
25400133502eSMatthias Fuchs
25410133502eSMatthias Fuchs		Enables support for specific chip vendors.
25420133502eSMatthias Fuchs		(ALTERA, XILINX)
25430133502eSMatthias Fuchs
25440133502eSMatthias Fuchs		CONFIG_FPGA_<family>
25450133502eSMatthias Fuchs
25460133502eSMatthias Fuchs		Enables support for FPGA family.
25470133502eSMatthias Fuchs		(SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
25480133502eSMatthias Fuchs
25490133502eSMatthias Fuchs		CONFIG_FPGA_COUNT
2550c609719bSwdenk
2551c609719bSwdenk		Specify the number of FPGA devices to support.
2552c609719bSwdenk
255364e809afSSiva Durga Prasad Paladugu		CONFIG_CMD_FPGA_LOADMK
255464e809afSSiva Durga Prasad Paladugu
255564e809afSSiva Durga Prasad Paladugu		Enable support for fpga loadmk command
255664e809afSSiva Durga Prasad Paladugu
2557*67193864SMichal Simek		CONFIG_CMD_FPGA_LOADP
2558*67193864SMichal Simek
2559*67193864SMichal Simek		Enable support for fpga loadp command - load partial bitstream
2560*67193864SMichal Simek
2561*67193864SMichal Simek		CONFIG_CMD_FPGA_LOADBP
2562*67193864SMichal Simek
2563*67193864SMichal Simek		Enable support for fpga loadbp command - load partial bitstream
2564*67193864SMichal Simek		(Xilinx only)
2565*67193864SMichal Simek
25666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_PROG_FEEDBACK
2567c609719bSwdenk
2568c609719bSwdenk		Enable printing of hash marks during FPGA configuration.
2569c609719bSwdenk
25706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_BUSY
2571c609719bSwdenk
2572c609719bSwdenk		Enable checks on FPGA configuration interface busy
2573c609719bSwdenk		status by the configuration function. This option
2574c609719bSwdenk		will require a board or device specific function to
2575c609719bSwdenk		be written.
2576c609719bSwdenk
2577c609719bSwdenk		CONFIG_FPGA_DELAY
2578c609719bSwdenk
2579c609719bSwdenk		If defined, a function that provides delays in the FPGA
2580c609719bSwdenk		configuration driver.
2581c609719bSwdenk
25826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_CTRLC
2583c609719bSwdenk		Allow Control-C to interrupt FPGA configuration
2584c609719bSwdenk
25856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_ERROR
2586c609719bSwdenk
2587c609719bSwdenk		Check for configuration errors during FPGA bitfile
2588c609719bSwdenk		loading. For example, abort during Virtex II
2589c609719bSwdenk		configuration if the INIT_B line goes low (which
2590c609719bSwdenk		indicated a CRC error).
2591c609719bSwdenk
25926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_INIT
2593c609719bSwdenk
2594c609719bSwdenk		Maximum time to wait for the INIT_B line to deassert
2595c609719bSwdenk		after PROB_B has been deasserted during a Virtex II
2596c609719bSwdenk		FPGA configuration sequence. The default time is 500
259711ccc33fSMarcel Ziswiler		ms.
2598c609719bSwdenk
25996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_BUSY
2600c609719bSwdenk
2601c609719bSwdenk		Maximum time to wait for BUSY to deassert during
260211ccc33fSMarcel Ziswiler		Virtex II FPGA configuration. The default is 5 ms.
2603c609719bSwdenk
26046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_CONFIG
2605c609719bSwdenk
2606c609719bSwdenk		Time to wait after FPGA configuration. The default is
260711ccc33fSMarcel Ziswiler		200 ms.
2608c609719bSwdenk
2609c609719bSwdenk- Configuration Management:
2610c609719bSwdenk		CONFIG_IDENT_STRING
2611c609719bSwdenk
2612c609719bSwdenk		If defined, this string will be added to the U-Boot
2613c609719bSwdenk		version information (U_BOOT_VERSION)
2614c609719bSwdenk
2615c609719bSwdenk- Vendor Parameter Protection:
2616c609719bSwdenk
2617c609719bSwdenk		U-Boot considers the values of the environment
2618c609719bSwdenk		variables "serial#" (Board Serial Number) and
26197152b1d0Swdenk		"ethaddr" (Ethernet Address) to be parameters that
2620c609719bSwdenk		are set once by the board vendor / manufacturer, and
2621c609719bSwdenk		protects these variables from casual modification by
2622c609719bSwdenk		the user. Once set, these variables are read-only,
2623c609719bSwdenk		and write or delete attempts are rejected. You can
262411ccc33fSMarcel Ziswiler		change this behaviour:
2625c609719bSwdenk
2626c609719bSwdenk		If CONFIG_ENV_OVERWRITE is #defined in your config
2627c609719bSwdenk		file, the write protection for vendor parameters is
262847cd00faSwdenk		completely disabled. Anybody can change or delete
2629c609719bSwdenk		these parameters.
2630c609719bSwdenk
2631c609719bSwdenk		Alternatively, if you #define _both_ CONFIG_ETHADDR
2632c609719bSwdenk		_and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
263311ccc33fSMarcel Ziswiler		Ethernet address is installed in the environment,
2634c609719bSwdenk		which can be changed exactly ONCE by the user. [The
2635c609719bSwdenk		serial# is unaffected by this, i. e. it remains
2636c609719bSwdenk		read-only.]
2637c609719bSwdenk
26382598090bSJoe Hershberger		The same can be accomplished in a more flexible way
26392598090bSJoe Hershberger		for any variable by configuring the type of access
26402598090bSJoe Hershberger		to allow for those variables in the ".flags" variable
26412598090bSJoe Hershberger		or define CONFIG_ENV_FLAGS_LIST_STATIC.
26422598090bSJoe Hershberger
2643c609719bSwdenk- Protected RAM:
2644c609719bSwdenk		CONFIG_PRAM
2645c609719bSwdenk
2646c609719bSwdenk		Define this variable to enable the reservation of
2647c609719bSwdenk		"protected RAM", i. e. RAM which is not overwritten
2648c609719bSwdenk		by U-Boot. Define CONFIG_PRAM to hold the number of
2649c609719bSwdenk		kB you want to reserve for pRAM. You can overwrite
2650c609719bSwdenk		this default value by defining an environment
2651c609719bSwdenk		variable "pram" to the number of kB you want to
2652c609719bSwdenk		reserve. Note that the board info structure will
2653c609719bSwdenk		still show the full amount of RAM. If pRAM is
2654c609719bSwdenk		reserved, a new environment variable "mem" will
2655c609719bSwdenk		automatically be defined to hold the amount of
2656c609719bSwdenk		remaining RAM in a form that can be passed as boot
2657c609719bSwdenk		argument to Linux, for instance like that:
2658c609719bSwdenk
2659fe126d8bSWolfgang Denk			setenv bootargs ... mem=\${mem}
2660c609719bSwdenk			saveenv
2661c609719bSwdenk
2662c609719bSwdenk		This way you can tell Linux not to use this memory,
2663c609719bSwdenk		either, which results in a memory region that will
2664c609719bSwdenk		not be affected by reboots.
2665c609719bSwdenk
2666c609719bSwdenk		*WARNING* If your board configuration uses automatic
2667c609719bSwdenk		detection of the RAM size, you must make sure that
2668c609719bSwdenk		this memory test is non-destructive. So far, the
2669c609719bSwdenk		following board configurations are known to be
2670c609719bSwdenk		"pRAM-clean":
2671c609719bSwdenk
26721b0757ecSWolfgang Denk			IVMS8, IVML24, SPD8xx, TQM8xxL,
26731b0757ecSWolfgang Denk			HERMES, IP860, RPXlite, LWMON,
2674544d97e9SWolfgang Denk			FLAGADM, TQM8260
2675c609719bSwdenk
267640fef049SGabe Black- Access to physical memory region (> 4GB)
267740fef049SGabe Black		Some basic support is provided for operations on memory not
267840fef049SGabe Black		normally accessible to U-Boot - e.g. some architectures
267940fef049SGabe Black		support access to more than 4GB of memory on 32-bit
268040fef049SGabe Black		machines using physical address extension or similar.
268140fef049SGabe Black		Define CONFIG_PHYSMEM to access this basic support, which
268240fef049SGabe Black		currently only supports clearing the memory.
268340fef049SGabe Black
2684c609719bSwdenk- Error Recovery:
2685c609719bSwdenk		CONFIG_PANIC_HANG
2686c609719bSwdenk
2687c609719bSwdenk		Define this variable to stop the system in case of a
2688c609719bSwdenk		fatal error, so that you have to reset it manually.
2689c609719bSwdenk		This is probably NOT a good idea for an embedded
269011ccc33fSMarcel Ziswiler		system where you want the system to reboot
2691c609719bSwdenk		automatically as fast as possible, but it may be
2692c609719bSwdenk		useful during development since you can try to debug
2693c609719bSwdenk		the conditions that lead to the situation.
2694c609719bSwdenk
2695c609719bSwdenk		CONFIG_NET_RETRY_COUNT
2696c609719bSwdenk
2697c609719bSwdenk		This variable defines the number of retries for
2698c609719bSwdenk		network operations like ARP, RARP, TFTP, or BOOTP
2699c609719bSwdenk		before giving up the operation. If not defined, a
2700c609719bSwdenk		default value of 5 is used.
2701c609719bSwdenk
270240cb90eeSGuennadi Liakhovetski		CONFIG_ARP_TIMEOUT
270340cb90eeSGuennadi Liakhovetski
270440cb90eeSGuennadi Liakhovetski		Timeout waiting for an ARP reply in milliseconds.
270540cb90eeSGuennadi Liakhovetski
270648a3e999STetsuyuki Kobayashi		CONFIG_NFS_TIMEOUT
270748a3e999STetsuyuki Kobayashi
270848a3e999STetsuyuki Kobayashi		Timeout in milliseconds used in NFS protocol.
270948a3e999STetsuyuki Kobayashi		If you encounter "ERROR: Cannot umount" in nfs command,
271048a3e999STetsuyuki Kobayashi		try longer timeout such as
271148a3e999STetsuyuki Kobayashi		#define CONFIG_NFS_TIMEOUT 10000UL
271248a3e999STetsuyuki Kobayashi
2713c609719bSwdenk- Command Interpreter:
27148078f1a5SWolfgang Denk		CONFIG_AUTO_COMPLETE
271504a85b3bSwdenk
271604a85b3bSwdenk		Enable auto completion of commands using TAB.
271704a85b3bSwdenk
27188078f1a5SWolfgang Denk		Note that this feature has NOT been implemented yet
27198078f1a5SWolfgang Denk		for the "hush" shell.
27208078f1a5SWolfgang Denk
27218078f1a5SWolfgang Denk
27226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_HUSH_PARSER
2723c609719bSwdenk
2724c609719bSwdenk		Define this variable to enable the "hush" shell (from
2725c609719bSwdenk		Busybox) as command line interpreter, thus enabling
2726c609719bSwdenk		powerful command line syntax like
2727c609719bSwdenk		if...then...else...fi conditionals or `&&' and '||'
2728c609719bSwdenk		constructs ("shell scripts").
2729c609719bSwdenk
2730c609719bSwdenk		If undefined, you get the old, much simpler behaviour
2731c609719bSwdenk		with a somewhat smaller memory footprint.
2732c609719bSwdenk
2733c609719bSwdenk
27346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_PROMPT_HUSH_PS2
2735c609719bSwdenk
2736c609719bSwdenk		This defines the secondary prompt string, which is
2737c609719bSwdenk		printed when the command interpreter needs more input
2738c609719bSwdenk		to complete a command. Usually "> ".
2739c609719bSwdenk
2740c609719bSwdenk	Note:
2741c609719bSwdenk
2742c609719bSwdenk		In the current implementation, the local variables
2743c609719bSwdenk		space and global environment variables space are
2744c609719bSwdenk		separated. Local variables are those you define by
27453b57fe0aSwdenk		simply typing `name=value'. To access a local
2746c609719bSwdenk		variable later on, you have write `$name' or
27473b57fe0aSwdenk		`${name}'; to execute the contents of a variable
27483b57fe0aSwdenk		directly type `$name' at the command prompt.
2749c609719bSwdenk
2750c609719bSwdenk		Global environment variables are those you use
2751c609719bSwdenk		setenv/printenv to work with. To run a command stored
2752c609719bSwdenk		in such a variable, you need to use the run command,
2753c609719bSwdenk		and you must not use the '$' sign to access them.
2754c609719bSwdenk
2755c609719bSwdenk		To store commands and special characters in a
2756c609719bSwdenk		variable, please use double quotation marks
2757c609719bSwdenk		surrounding the whole text of the variable, instead
2758c609719bSwdenk		of the backslashes before semicolons and special
2759c609719bSwdenk		symbols.
2760c609719bSwdenk
2761aa0c71acSWolfgang Denk- Commandline Editing and History:
2762aa0c71acSWolfgang Denk		CONFIG_CMDLINE_EDITING
2763aa0c71acSWolfgang Denk
276411ccc33fSMarcel Ziswiler		Enable editing and History functions for interactive
2765aa0c71acSWolfgang Denk		commandline input operations
2766aa0c71acSWolfgang Denk
2767a8c7c708Swdenk- Default Environment:
2768c609719bSwdenk		CONFIG_EXTRA_ENV_SETTINGS
2769c609719bSwdenk
2770c609719bSwdenk		Define this to contain any number of null terminated
2771c609719bSwdenk		strings (variable = value pairs) that will be part of
27727152b1d0Swdenk		the default environment compiled into the boot image.
27732262cfeeSwdenk
2774c609719bSwdenk		For example, place something like this in your
2775c609719bSwdenk		board's config file:
2776c609719bSwdenk
2777c609719bSwdenk		#define CONFIG_EXTRA_ENV_SETTINGS \
2778c609719bSwdenk			"myvar1=value1\0" \
2779c609719bSwdenk			"myvar2=value2\0"
2780c609719bSwdenk
2781c609719bSwdenk		Warning: This method is based on knowledge about the
2782c609719bSwdenk		internal format how the environment is stored by the
27832262cfeeSwdenk		U-Boot code. This is NOT an official, exported
2784c609719bSwdenk		interface! Although it is unlikely that this format
27857152b1d0Swdenk		will change soon, there is no guarantee either.
2786c609719bSwdenk		You better know what you are doing here.
2787c609719bSwdenk
2788c609719bSwdenk		Note: overly (ab)use of the default environment is
2789c609719bSwdenk		discouraged. Make sure to check other ways to preset
279074de7aefSWolfgang Denk		the environment like the "source" command or the
2791c609719bSwdenk		boot command first.
2792c609719bSwdenk
27935e724ca2SStephen Warren		CONFIG_ENV_VARS_UBOOT_CONFIG
27945e724ca2SStephen Warren
27955e724ca2SStephen Warren		Define this in order to add variables describing the
27965e724ca2SStephen Warren		U-Boot build configuration to the default environment.
27975e724ca2SStephen Warren		These will be named arch, cpu, board, vendor, and soc.
27985e724ca2SStephen Warren
27995e724ca2SStephen Warren		Enabling this option will cause the following to be defined:
28005e724ca2SStephen Warren
28015e724ca2SStephen Warren		- CONFIG_SYS_ARCH
28025e724ca2SStephen Warren		- CONFIG_SYS_CPU
28035e724ca2SStephen Warren		- CONFIG_SYS_BOARD
28045e724ca2SStephen Warren		- CONFIG_SYS_VENDOR
28055e724ca2SStephen Warren		- CONFIG_SYS_SOC
28065e724ca2SStephen Warren
28077e27f89fSTom Rini		CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
28087e27f89fSTom Rini
28097e27f89fSTom Rini		Define this in order to add variables describing certain
28107e27f89fSTom Rini		run-time determined information about the hardware to the
28117e27f89fSTom Rini		environment.  These will be named board_name, board_rev.
28127e27f89fSTom Rini
281306fd8538SSimon Glass		CONFIG_DELAY_ENVIRONMENT
281406fd8538SSimon Glass
281506fd8538SSimon Glass		Normally the environment is loaded when the board is
281606fd8538SSimon Glass		intialised so that it is available to U-Boot. This inhibits
281706fd8538SSimon Glass		that so that the environment is not available until
281806fd8538SSimon Glass		explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
281906fd8538SSimon Glass		this is instead controlled by the value of
282006fd8538SSimon Glass		/config/load-environment.
282106fd8538SSimon Glass
2822a8c7c708Swdenk- DataFlash Support:
28232abbe075Swdenk		CONFIG_HAS_DATAFLASH
28242abbe075Swdenk
28252abbe075Swdenk		Defining this option enables DataFlash features and
28262abbe075Swdenk		allows to read/write in Dataflash via the standard
28272abbe075Swdenk		commands cp, md...
28282abbe075Swdenk
2829f61ec45eSEric Nelson- Serial Flash support
2830f61ec45eSEric Nelson		CONFIG_CMD_SF
2831f61ec45eSEric Nelson
2832f61ec45eSEric Nelson		Defining this option enables SPI flash commands
2833f61ec45eSEric Nelson		'sf probe/read/write/erase/update'.
2834f61ec45eSEric Nelson
2835f61ec45eSEric Nelson		Usage requires an initial 'probe' to define the serial
2836f61ec45eSEric Nelson		flash parameters, followed by read/write/erase/update
2837f61ec45eSEric Nelson		commands.
2838f61ec45eSEric Nelson
2839f61ec45eSEric Nelson		The following defaults may be provided by the platform
2840f61ec45eSEric Nelson		to handle the common case when only a single serial
2841f61ec45eSEric Nelson		flash is present on the system.
2842f61ec45eSEric Nelson
2843f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_BUS		Bus identifier
2844f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_CS		Chip-select
2845f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_MODE 		(see include/spi.h)
2846f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_SPEED		in Hz
2847f61ec45eSEric Nelson
284824007273SSimon Glass		CONFIG_CMD_SF_TEST
284924007273SSimon Glass
285024007273SSimon Glass		Define this option to include a destructive SPI flash
285124007273SSimon Glass		test ('sf test').
285224007273SSimon Glass
28531dcd6d03SJagannadha Sutradharudu Teki		CONFIG_SPI_FLASH_BAR		Ban/Extended Addr Reg
28541dcd6d03SJagannadha Sutradharudu Teki
28551dcd6d03SJagannadha Sutradharudu Teki		Define this option to use the Bank addr/Extended addr
28561dcd6d03SJagannadha Sutradharudu Teki		support on SPI flashes which has size > 16Mbytes.
28571dcd6d03SJagannadha Sutradharudu Teki
2858b902e07cSJagannadha Sutradharudu Teki		CONFIG_SF_DUAL_FLASH		Dual flash memories
2859b902e07cSJagannadha Sutradharudu Teki
2860b902e07cSJagannadha Sutradharudu Teki		Define this option to use dual flash support where two flash
2861b902e07cSJagannadha Sutradharudu Teki		memories can be connected with a given cs line.
2862b902e07cSJagannadha Sutradharudu Teki		currently Xilinx Zynq qspi support these type of connections.
2863b902e07cSJagannadha Sutradharudu Teki
28643f85ce27Swdenk- SystemACE Support:
28653f85ce27Swdenk		CONFIG_SYSTEMACE
28663f85ce27Swdenk
28673f85ce27Swdenk		Adding this option adds support for Xilinx SystemACE
28683f85ce27Swdenk		chips attached via some sort of local bus. The address
286911ccc33fSMarcel Ziswiler		of the chip must also be defined in the
28706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SYSTEMACE_BASE macro. For example:
28713f85ce27Swdenk
28723f85ce27Swdenk		#define CONFIG_SYSTEMACE
28736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
28743f85ce27Swdenk
28753f85ce27Swdenk		When SystemACE support is added, the "ace" device type
28763f85ce27Swdenk		becomes available to the fat commands, i.e. fatls.
28773f85ce27Swdenk
2878ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port:
2879ecb0ccd9SWolfgang Denk		CONFIG_TFTP_PORT
2880ecb0ccd9SWolfgang Denk
288128cb9375SWolfgang Denk		If this is defined, the environment variable tftpsrcp
2882ecb0ccd9SWolfgang Denk		is used to supply the TFTP UDP source port value.
288328cb9375SWolfgang Denk		If tftpsrcp isn't defined, the normal pseudo-random port
2884ecb0ccd9SWolfgang Denk		number generator is used.
2885ecb0ccd9SWolfgang Denk
288628cb9375SWolfgang Denk		Also, the environment variable tftpdstp is used to supply
288728cb9375SWolfgang Denk		the TFTP UDP destination port value.  If tftpdstp isn't
288828cb9375SWolfgang Denk		defined, the normal port 69 is used.
288928cb9375SWolfgang Denk
289028cb9375SWolfgang Denk		The purpose for tftpsrcp is to allow a TFTP server to
2891ecb0ccd9SWolfgang Denk		blindly start the TFTP transfer using the pre-configured
2892ecb0ccd9SWolfgang Denk		target IP address and UDP port. This has the effect of
2893ecb0ccd9SWolfgang Denk		"punching through" the (Windows XP) firewall, allowing
2894ecb0ccd9SWolfgang Denk		the remainder of the TFTP transfer to proceed normally.
2895ecb0ccd9SWolfgang Denk		A better solution is to properly configure the firewall,
2896ecb0ccd9SWolfgang Denk		but sometimes that is not allowed.
2897ecb0ccd9SWolfgang Denk
2898bf36c5d5SSimon Glass- Hashing support:
2899bf36c5d5SSimon Glass		CONFIG_CMD_HASH
2900bf36c5d5SSimon Glass
2901bf36c5d5SSimon Glass		This enables a generic 'hash' command which can produce
2902bf36c5d5SSimon Glass		hashes / digests from a few algorithms (e.g. SHA1, SHA256).
2903bf36c5d5SSimon Glass
2904bf36c5d5SSimon Glass		CONFIG_HASH_VERIFY
2905bf36c5d5SSimon Glass
2906bf36c5d5SSimon Glass		Enable the hash verify command (hash -v). This adds to code
2907bf36c5d5SSimon Glass		size a little.
2908bf36c5d5SSimon Glass
2909bf36c5d5SSimon Glass		CONFIG_SHA1 - support SHA1 hashing
2910bf36c5d5SSimon Glass		CONFIG_SHA256 - support SHA256 hashing
2911bf36c5d5SSimon Glass
2912bf36c5d5SSimon Glass		Note: There is also a sha1sum command, which should perhaps
2913bf36c5d5SSimon Glass		be deprecated in favour of 'hash sha1'.
2914bf36c5d5SSimon Glass
2915a11f1873SRobert Winkler- Freescale i.MX specific commands:
2916a11f1873SRobert Winkler		CONFIG_CMD_HDMIDETECT
2917a11f1873SRobert Winkler		This enables 'hdmidet' command which returns true if an
2918a11f1873SRobert Winkler		HDMI monitor is detected.  This command is i.MX 6 specific.
2919a11f1873SRobert Winkler
2920a11f1873SRobert Winkler		CONFIG_CMD_BMODE
2921a11f1873SRobert Winkler		This enables the 'bmode' (bootmode) command for forcing
2922a11f1873SRobert Winkler		a boot from specific media.
2923a11f1873SRobert Winkler
2924a11f1873SRobert Winkler		This is useful for forcing the ROM's usb downloader to
2925a11f1873SRobert Winkler		activate upon a watchdog reset which is nice when iterating
2926a11f1873SRobert Winkler		on U-Boot.  Using the reset button or running bmode normal
2927a11f1873SRobert Winkler		will set it back to normal.  This command currently
2928a11f1873SRobert Winkler		supports i.MX53 and i.MX6.
2929a11f1873SRobert Winkler
293019c402afSSimon Glass- Signing support:
293119c402afSSimon Glass		CONFIG_RSA
293219c402afSSimon Glass
293319c402afSSimon Glass		This enables the RSA algorithm used for FIT image verification
29348bf2aad7SDetlev Zundel		in U-Boot. See doc/uImage.FIT/signature.txt for more information.
293519c402afSSimon Glass
293619c402afSSimon Glass		The signing part is build into mkimage regardless of this
293719c402afSSimon Glass		option.
293819c402afSSimon Glass
29399e50c406SHeiko Schocher- bootcount support:
29409e50c406SHeiko Schocher		CONFIG_BOOTCOUNT_LIMIT
29419e50c406SHeiko Schocher
29429e50c406SHeiko Schocher		This enables the bootcounter support, see:
29439e50c406SHeiko Schocher		http://www.denx.de/wiki/DULG/UBootBootCountLimit
29449e50c406SHeiko Schocher
29459e50c406SHeiko Schocher		CONFIG_AT91SAM9XE
29469e50c406SHeiko Schocher		enable special bootcounter support on at91sam9xe based boards.
29479e50c406SHeiko Schocher		CONFIG_BLACKFIN
29489e50c406SHeiko Schocher		enable special bootcounter support on blackfin based boards.
29499e50c406SHeiko Schocher		CONFIG_SOC_DA8XX
29509e50c406SHeiko Schocher		enable special bootcounter support on da850 based boards.
29519e50c406SHeiko Schocher		CONFIG_BOOTCOUNT_RAM
29529e50c406SHeiko Schocher		enable support for the bootcounter in RAM
29539e50c406SHeiko Schocher		CONFIG_BOOTCOUNT_I2C
29549e50c406SHeiko Schocher		enable support for the bootcounter on an i2c (like RTC) device.
29559e50c406SHeiko Schocher			CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
29569e50c406SHeiko Schocher			CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
29579e50c406SHeiko Schocher						    the bootcounter.
29589e50c406SHeiko Schocher			CONFIG_BOOTCOUNT_ALEN = address len
295919c402afSSimon Glass
2960a8c7c708Swdenk- Show boot progress:
2961c609719bSwdenk		CONFIG_SHOW_BOOT_PROGRESS
2962c609719bSwdenk
2963c609719bSwdenk		Defining this option allows to add some board-
2964c609719bSwdenk		specific code (calling a user-provided function
2965c609719bSwdenk		"show_boot_progress(int)") that enables you to show
2966c609719bSwdenk		the system's boot progress on some display (for
2967c609719bSwdenk		example, some LED's) on your board. At the moment,
2968c609719bSwdenk		the following checkpoints are implemented:
2969c609719bSwdenk
29703a608ca0SSimon Glass- Detailed boot stage timing
29713a608ca0SSimon Glass		CONFIG_BOOTSTAGE
29723a608ca0SSimon Glass		Define this option to get detailed timing of each stage
29733a608ca0SSimon Glass		of the boot process.
29743a608ca0SSimon Glass
29753a608ca0SSimon Glass		CONFIG_BOOTSTAGE_USER_COUNT
29763a608ca0SSimon Glass		This is the number of available user bootstage records.
29773a608ca0SSimon Glass		Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
29783a608ca0SSimon Glass		a new ID will be allocated from this stash. If you exceed
29793a608ca0SSimon Glass		the limit, recording will stop.
29803a608ca0SSimon Glass
29813a608ca0SSimon Glass		CONFIG_BOOTSTAGE_REPORT
29823a608ca0SSimon Glass		Define this to print a report before boot, similar to this:
29833a608ca0SSimon Glass
29843a608ca0SSimon Glass		Timer summary in microseconds:
29853a608ca0SSimon Glass		       Mark    Elapsed  Stage
29863a608ca0SSimon Glass			  0          0  reset
29873a608ca0SSimon Glass		  3,575,678  3,575,678  board_init_f start
29883a608ca0SSimon Glass		  3,575,695         17  arch_cpu_init A9
29893a608ca0SSimon Glass		  3,575,777         82  arch_cpu_init done
29903a608ca0SSimon Glass		  3,659,598     83,821  board_init_r start
29913a608ca0SSimon Glass		  3,910,375    250,777  main_loop
29923a608ca0SSimon Glass		 29,916,167 26,005,792  bootm_start
29933a608ca0SSimon Glass		 30,361,327    445,160  start_kernel
29943a608ca0SSimon Glass
29952eba38cfSSimon Glass		CONFIG_CMD_BOOTSTAGE
29962eba38cfSSimon Glass		Add a 'bootstage' command which supports printing a report
29972eba38cfSSimon Glass		and un/stashing of bootstage data.
29982eba38cfSSimon Glass
299994fd1316SSimon Glass		CONFIG_BOOTSTAGE_FDT
300094fd1316SSimon Glass		Stash the bootstage information in the FDT. A root 'bootstage'
300194fd1316SSimon Glass		node is created with each bootstage id as a child. Each child
300294fd1316SSimon Glass		has a 'name' property and either 'mark' containing the
300394fd1316SSimon Glass		mark time in microsecond, or 'accum' containing the
300494fd1316SSimon Glass		accumulated time for that bootstage id in microseconds.
300594fd1316SSimon Glass		For example:
300694fd1316SSimon Glass
300794fd1316SSimon Glass		bootstage {
300894fd1316SSimon Glass			154 {
300994fd1316SSimon Glass				name = "board_init_f";
301094fd1316SSimon Glass				mark = <3575678>;
301194fd1316SSimon Glass			};
301294fd1316SSimon Glass			170 {
301394fd1316SSimon Glass				name = "lcd";
301494fd1316SSimon Glass				accum = <33482>;
301594fd1316SSimon Glass			};
301694fd1316SSimon Glass		};
301794fd1316SSimon Glass
301894fd1316SSimon Glass		Code in the Linux kernel can find this in /proc/devicetree.
301994fd1316SSimon Glass
30201372cce2SMarian BalakowiczLegacy uImage format:
30211372cce2SMarian Balakowicz
3022c609719bSwdenk  Arg	Where			When
3023c609719bSwdenk    1	common/cmd_bootm.c	before attempting to boot an image
3024c609719bSwdenk   -1	common/cmd_bootm.c	Image header has bad	 magic number
3025c609719bSwdenk    2	common/cmd_bootm.c	Image header has correct magic number
3026c609719bSwdenk   -2	common/cmd_bootm.c	Image header has bad	 checksum
3027c609719bSwdenk    3	common/cmd_bootm.c	Image header has correct checksum
3028c609719bSwdenk   -3	common/cmd_bootm.c	Image data   has bad	 checksum
3029c609719bSwdenk    4	common/cmd_bootm.c	Image data   has correct checksum
3030c609719bSwdenk   -4	common/cmd_bootm.c	Image is for unsupported architecture
3031c609719bSwdenk    5	common/cmd_bootm.c	Architecture check OK
30321372cce2SMarian Balakowicz   -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi)
3033c609719bSwdenk    6	common/cmd_bootm.c	Image Type check OK
3034c609719bSwdenk   -6	common/cmd_bootm.c	gunzip uncompression error
3035c609719bSwdenk   -7	common/cmd_bootm.c	Unimplemented compression type
3036c609719bSwdenk    7	common/cmd_bootm.c	Uncompression OK
30371372cce2SMarian Balakowicz    8	common/cmd_bootm.c	No uncompress/copy overwrite error
3038c609719bSwdenk   -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
30391372cce2SMarian Balakowicz
30401372cce2SMarian Balakowicz    9	common/image.c		Start initial ramdisk verification
30411372cce2SMarian Balakowicz  -10	common/image.c		Ramdisk header has bad	   magic number
30421372cce2SMarian Balakowicz  -11	common/image.c		Ramdisk header has bad	   checksum
30431372cce2SMarian Balakowicz   10	common/image.c		Ramdisk header is OK
30441372cce2SMarian Balakowicz  -12	common/image.c		Ramdisk data   has bad	   checksum
30451372cce2SMarian Balakowicz   11	common/image.c		Ramdisk data   has correct checksum
30461372cce2SMarian Balakowicz   12	common/image.c		Ramdisk verification complete, start loading
304711ccc33fSMarcel Ziswiler  -13	common/image.c		Wrong Image Type (not PPC Linux ramdisk)
30481372cce2SMarian Balakowicz   13	common/image.c		Start multifile image verification
30491372cce2SMarian Balakowicz   14	common/image.c		No initial ramdisk, no multifile, continue.
30501372cce2SMarian Balakowicz
3051ea0364f1SPeter Tyser   15	arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
3052c609719bSwdenk
3053a47a12beSStefan Roese  -30	arch/powerpc/lib/board.c	Fatal error, hang the system
305463e73c9aSwdenk  -31	post/post.c		POST test failed, detected by post_output_backlog()
305563e73c9aSwdenk  -32	post/post.c		POST test failed, detected by post_run_single()
305663e73c9aSwdenk
3057566a494fSHeiko Schocher   34	common/cmd_doc.c	before loading a Image from a DOC device
3058566a494fSHeiko Schocher  -35	common/cmd_doc.c	Bad usage of "doc" command
3059566a494fSHeiko Schocher   35	common/cmd_doc.c	correct usage of "doc" command
3060566a494fSHeiko Schocher  -36	common/cmd_doc.c	No boot device
3061566a494fSHeiko Schocher   36	common/cmd_doc.c	correct boot device
3062566a494fSHeiko Schocher  -37	common/cmd_doc.c	Unknown Chip ID on boot device
3063566a494fSHeiko Schocher   37	common/cmd_doc.c	correct chip ID found, device available
3064566a494fSHeiko Schocher  -38	common/cmd_doc.c	Read Error on boot device
3065566a494fSHeiko Schocher   38	common/cmd_doc.c	reading Image header from DOC device OK
3066566a494fSHeiko Schocher  -39	common/cmd_doc.c	Image header has bad magic number
3067566a494fSHeiko Schocher   39	common/cmd_doc.c	Image header has correct magic number
3068566a494fSHeiko Schocher  -40	common/cmd_doc.c	Error reading Image from DOC device
3069566a494fSHeiko Schocher   40	common/cmd_doc.c	Image header has correct magic number
3070566a494fSHeiko Schocher   41	common/cmd_ide.c	before loading a Image from a IDE device
3071566a494fSHeiko Schocher  -42	common/cmd_ide.c	Bad usage of "ide" command
3072566a494fSHeiko Schocher   42	common/cmd_ide.c	correct usage of "ide" command
3073566a494fSHeiko Schocher  -43	common/cmd_ide.c	No boot device
3074566a494fSHeiko Schocher   43	common/cmd_ide.c	boot device found
3075566a494fSHeiko Schocher  -44	common/cmd_ide.c	Device not available
3076566a494fSHeiko Schocher   44	common/cmd_ide.c	Device available
3077566a494fSHeiko Schocher  -45	common/cmd_ide.c	wrong partition selected
3078566a494fSHeiko Schocher   45	common/cmd_ide.c	partition selected
3079566a494fSHeiko Schocher  -46	common/cmd_ide.c	Unknown partition table
3080566a494fSHeiko Schocher   46	common/cmd_ide.c	valid partition table found
3081566a494fSHeiko Schocher  -47	common/cmd_ide.c	Invalid partition type
3082566a494fSHeiko Schocher   47	common/cmd_ide.c	correct partition type
3083566a494fSHeiko Schocher  -48	common/cmd_ide.c	Error reading Image Header on boot device
3084566a494fSHeiko Schocher   48	common/cmd_ide.c	reading Image Header from IDE device OK
3085566a494fSHeiko Schocher  -49	common/cmd_ide.c	Image header has bad magic number
3086566a494fSHeiko Schocher   49	common/cmd_ide.c	Image header has correct magic number
3087566a494fSHeiko Schocher  -50	common/cmd_ide.c	Image header has bad	 checksum
3088566a494fSHeiko Schocher   50	common/cmd_ide.c	Image header has correct checksum
3089566a494fSHeiko Schocher  -51	common/cmd_ide.c	Error reading Image from IDE device
3090566a494fSHeiko Schocher   51	common/cmd_ide.c	reading Image from IDE device OK
3091566a494fSHeiko Schocher   52	common/cmd_nand.c	before loading a Image from a NAND device
3092566a494fSHeiko Schocher  -53	common/cmd_nand.c	Bad usage of "nand" command
3093566a494fSHeiko Schocher   53	common/cmd_nand.c	correct usage of "nand" command
3094566a494fSHeiko Schocher  -54	common/cmd_nand.c	No boot device
3095566a494fSHeiko Schocher   54	common/cmd_nand.c	boot device found
3096566a494fSHeiko Schocher  -55	common/cmd_nand.c	Unknown Chip ID on boot device
3097566a494fSHeiko Schocher   55	common/cmd_nand.c	correct chip ID found, device available
3098566a494fSHeiko Schocher  -56	common/cmd_nand.c	Error reading Image Header on boot device
3099566a494fSHeiko Schocher   56	common/cmd_nand.c	reading Image Header from NAND device OK
3100566a494fSHeiko Schocher  -57	common/cmd_nand.c	Image header has bad magic number
3101566a494fSHeiko Schocher   57	common/cmd_nand.c	Image header has correct magic number
3102566a494fSHeiko Schocher  -58	common/cmd_nand.c	Error reading Image from NAND device
3103566a494fSHeiko Schocher   58	common/cmd_nand.c	reading Image from NAND device OK
3104c609719bSwdenk
3105566a494fSHeiko Schocher  -60	common/env_common.c	Environment has a bad CRC, using default
3106c609719bSwdenk
3107566a494fSHeiko Schocher   64	net/eth.c		starting with Ethernet configuration.
3108566a494fSHeiko Schocher  -64	net/eth.c		no Ethernet found.
3109566a494fSHeiko Schocher   65	net/eth.c		Ethernet found.
3110206c60cbSwdenk
3111566a494fSHeiko Schocher  -80	common/cmd_net.c	usage wrong
3112566a494fSHeiko Schocher   80	common/cmd_net.c	before calling NetLoop()
311311ccc33fSMarcel Ziswiler  -81	common/cmd_net.c	some error in NetLoop() occurred
3114566a494fSHeiko Schocher   81	common/cmd_net.c	NetLoop() back without error
3115566a494fSHeiko Schocher  -82	common/cmd_net.c	size == 0 (File with size 0 loaded)
3116566a494fSHeiko Schocher   82	common/cmd_net.c	trying automatic boot
311774de7aefSWolfgang Denk   83	common/cmd_net.c	running "source" command
311874de7aefSWolfgang Denk  -83	common/cmd_net.c	some error in automatic boot or "source" command
3119566a494fSHeiko Schocher   84	common/cmd_net.c	end without errors
3120c609719bSwdenk
31211372cce2SMarian BalakowiczFIT uImage format:
31221372cce2SMarian Balakowicz
31231372cce2SMarian Balakowicz  Arg	Where			When
31241372cce2SMarian Balakowicz  100	common/cmd_bootm.c	Kernel FIT Image has correct format
31251372cce2SMarian Balakowicz -100	common/cmd_bootm.c	Kernel FIT Image has incorrect format
31261372cce2SMarian Balakowicz  101	common/cmd_bootm.c	No Kernel subimage unit name, using configuration
31271372cce2SMarian Balakowicz -101	common/cmd_bootm.c	Can't get configuration for kernel subimage
31281372cce2SMarian Balakowicz  102	common/cmd_bootm.c	Kernel unit name specified
31291372cce2SMarian Balakowicz -103	common/cmd_bootm.c	Can't get kernel subimage node offset
3130f773bea8SMarian Balakowicz  103	common/cmd_bootm.c	Found configuration node
31311372cce2SMarian Balakowicz  104	common/cmd_bootm.c	Got kernel subimage node offset
31321372cce2SMarian Balakowicz -104	common/cmd_bootm.c	Kernel subimage hash verification failed
31331372cce2SMarian Balakowicz  105	common/cmd_bootm.c	Kernel subimage hash verification OK
31341372cce2SMarian Balakowicz -105	common/cmd_bootm.c	Kernel subimage is for unsupported architecture
31351372cce2SMarian Balakowicz  106	common/cmd_bootm.c	Architecture check OK
313611ccc33fSMarcel Ziswiler -106	common/cmd_bootm.c	Kernel subimage has wrong type
313711ccc33fSMarcel Ziswiler  107	common/cmd_bootm.c	Kernel subimage type OK
31381372cce2SMarian Balakowicz -107	common/cmd_bootm.c	Can't get kernel subimage data/size
31391372cce2SMarian Balakowicz  108	common/cmd_bootm.c	Got kernel subimage data/size
31401372cce2SMarian Balakowicz -108	common/cmd_bootm.c	Wrong image type (not legacy, FIT)
31411372cce2SMarian Balakowicz -109	common/cmd_bootm.c	Can't get kernel subimage type
31421372cce2SMarian Balakowicz -110	common/cmd_bootm.c	Can't get kernel subimage comp
31431372cce2SMarian Balakowicz -111	common/cmd_bootm.c	Can't get kernel subimage os
31441372cce2SMarian Balakowicz -112	common/cmd_bootm.c	Can't get kernel subimage load address
31451372cce2SMarian Balakowicz -113	common/cmd_bootm.c	Image uncompress/copy overwrite error
31461372cce2SMarian Balakowicz
31471372cce2SMarian Balakowicz  120	common/image.c		Start initial ramdisk verification
31481372cce2SMarian Balakowicz -120	common/image.c		Ramdisk FIT image has incorrect format
31491372cce2SMarian Balakowicz  121	common/image.c		Ramdisk FIT image has correct format
315011ccc33fSMarcel Ziswiler  122	common/image.c		No ramdisk subimage unit name, using configuration
31511372cce2SMarian Balakowicz -122	common/image.c		Can't get configuration for ramdisk subimage
31521372cce2SMarian Balakowicz  123	common/image.c		Ramdisk unit name specified
31531372cce2SMarian Balakowicz -124	common/image.c		Can't get ramdisk subimage node offset
31541372cce2SMarian Balakowicz  125	common/image.c		Got ramdisk subimage node offset
31551372cce2SMarian Balakowicz -125	common/image.c		Ramdisk subimage hash verification failed
31561372cce2SMarian Balakowicz  126	common/image.c		Ramdisk subimage hash verification OK
31571372cce2SMarian Balakowicz -126	common/image.c		Ramdisk subimage for unsupported architecture
31581372cce2SMarian Balakowicz  127	common/image.c		Architecture check OK
31591372cce2SMarian Balakowicz -127	common/image.c		Can't get ramdisk subimage data/size
31601372cce2SMarian Balakowicz  128	common/image.c		Got ramdisk subimage data/size
31611372cce2SMarian Balakowicz  129	common/image.c		Can't get ramdisk load address
31621372cce2SMarian Balakowicz -129	common/image.c		Got ramdisk load address
31631372cce2SMarian Balakowicz
316411ccc33fSMarcel Ziswiler -130	common/cmd_doc.c	Incorrect FIT image format
31651372cce2SMarian Balakowicz  131	common/cmd_doc.c	FIT image format OK
31661372cce2SMarian Balakowicz
316711ccc33fSMarcel Ziswiler -140	common/cmd_ide.c	Incorrect FIT image format
31681372cce2SMarian Balakowicz  141	common/cmd_ide.c	FIT image format OK
31691372cce2SMarian Balakowicz
317011ccc33fSMarcel Ziswiler -150	common/cmd_nand.c	Incorrect FIT image format
31711372cce2SMarian Balakowicz  151	common/cmd_nand.c	FIT image format OK
31721372cce2SMarian Balakowicz
3173d95f6ec7SGabe Black- FIT image support:
3174d95f6ec7SGabe Black		CONFIG_FIT
3175d95f6ec7SGabe Black		Enable support for the FIT uImage format.
3176d95f6ec7SGabe Black
3177d95f6ec7SGabe Black		CONFIG_FIT_BEST_MATCH
3178d95f6ec7SGabe Black		When no configuration is explicitly selected, default to the
3179d95f6ec7SGabe Black		one whose fdt's compatibility field best matches that of
3180d95f6ec7SGabe Black		U-Boot itself. A match is considered "best" if it matches the
3181d95f6ec7SGabe Black		most specific compatibility entry of U-Boot's fdt's root node.
3182d95f6ec7SGabe Black		The order of entries in the configuration's fdt is ignored.
3183d95f6ec7SGabe Black
31843e569a6bSSimon Glass		CONFIG_FIT_SIGNATURE
31853e569a6bSSimon Glass		This option enables signature verification of FIT uImages,
31863e569a6bSSimon Glass		using a hash signed and verified using RSA. See
31873e569a6bSSimon Glass		doc/uImage.FIT/signature.txt for more details.
31883e569a6bSSimon Glass
31894cf2609bSWolfgang Denk- Standalone program support:
31904cf2609bSWolfgang Denk		CONFIG_STANDALONE_LOAD_ADDR
31914cf2609bSWolfgang Denk
31926feff899SWolfgang Denk		This option defines a board specific value for the
31936feff899SWolfgang Denk		address where standalone program gets loaded, thus
31946feff899SWolfgang Denk		overwriting the architecture dependent default
31954cf2609bSWolfgang Denk		settings.
31964cf2609bSWolfgang Denk
31974cf2609bSWolfgang Denk- Frame Buffer Address:
31984cf2609bSWolfgang Denk		CONFIG_FB_ADDR
31994cf2609bSWolfgang Denk
32004cf2609bSWolfgang Denk		Define CONFIG_FB_ADDR if you want to use specific
320144a53b57SWolfgang Denk		address for frame buffer.  This is typically the case
320244a53b57SWolfgang Denk		when using a graphics controller has separate video
320344a53b57SWolfgang Denk		memory.  U-Boot will then place the frame buffer at
320444a53b57SWolfgang Denk		the given address instead of dynamically reserving it
320544a53b57SWolfgang Denk		in system RAM by calling lcd_setmem(), which grabs
320644a53b57SWolfgang Denk		the memory for the frame buffer depending on the
320744a53b57SWolfgang Denk		configured panel size.
32084cf2609bSWolfgang Denk
32094cf2609bSWolfgang Denk		Please see board_init_f function.
32104cf2609bSWolfgang Denk
3211cccfc2abSDetlev Zundel- Automatic software updates via TFTP server
3212cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP
3213cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_CNT_MAX
3214cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_MSEC_MAX
3215cccfc2abSDetlev Zundel
3216cccfc2abSDetlev Zundel		These options enable and control the auto-update feature;
3217cccfc2abSDetlev Zundel		for a more detailed description refer to doc/README.update.
3218cccfc2abSDetlev Zundel
3219cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support)
3220cccfc2abSDetlev Zundel		CONFIG_MTD_DEVICE
3221cccfc2abSDetlev Zundel
3222cccfc2abSDetlev Zundel		Adds the MTD device infrastructure from the Linux kernel.
3223cccfc2abSDetlev Zundel		Needed for mtdparts command support.
3224cccfc2abSDetlev Zundel
3225cccfc2abSDetlev Zundel		CONFIG_MTD_PARTITIONS
3226cccfc2abSDetlev Zundel
3227cccfc2abSDetlev Zundel		Adds the MTD partitioning infrastructure from the Linux
3228cccfc2abSDetlev Zundel		kernel. Needed for UBI support.
3229cccfc2abSDetlev Zundel
323070c219cdSJoe Hershberger- UBI support
323170c219cdSJoe Hershberger		CONFIG_CMD_UBI
323270c219cdSJoe Hershberger
323370c219cdSJoe Hershberger		Adds commands for interacting with MTD partitions formatted
323470c219cdSJoe Hershberger		with the UBI flash translation layer
323570c219cdSJoe Hershberger
323670c219cdSJoe Hershberger		Requires also defining CONFIG_RBTREE
323770c219cdSJoe Hershberger
3238147162daSJoe Hershberger		CONFIG_UBI_SILENCE_MSG
3239147162daSJoe Hershberger
3240147162daSJoe Hershberger		Make the verbose messages from UBI stop printing.  This leaves
3241147162daSJoe Hershberger		warnings and errors enabled.
3242147162daSJoe Hershberger
324370c219cdSJoe Hershberger- UBIFS support
324470c219cdSJoe Hershberger		CONFIG_CMD_UBIFS
324570c219cdSJoe Hershberger
324670c219cdSJoe Hershberger		Adds commands for interacting with UBI volumes formatted as
324770c219cdSJoe Hershberger		UBIFS.  UBIFS is read-only in u-boot.
324870c219cdSJoe Hershberger
324970c219cdSJoe Hershberger		Requires UBI support as well as CONFIG_LZO
325070c219cdSJoe Hershberger
3251147162daSJoe Hershberger		CONFIG_UBIFS_SILENCE_MSG
3252147162daSJoe Hershberger
3253147162daSJoe Hershberger		Make the verbose messages from UBIFS stop printing.  This leaves
3254147162daSJoe Hershberger		warnings and errors enabled.
3255147162daSJoe Hershberger
32566a11cf48SDaniel Schwierzeck- SPL framework
32576a11cf48SDaniel Schwierzeck		CONFIG_SPL
32586a11cf48SDaniel Schwierzeck		Enable building of SPL globally.
32596a11cf48SDaniel Schwierzeck
326095579793STom Rini		CONFIG_SPL_LDSCRIPT
326195579793STom Rini		LDSCRIPT for linking the SPL binary.
326295579793STom Rini
32636ebc3461SAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT
32646ebc3461SAlbert ARIBAUD		Maximum size in memory allocated to the SPL, BSS included.
32656ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual memory
32666ebc3461SAlbert ARIBAUD		used by SPL from _start to __bss_end does not exceed it.
32678960af8bSAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
32686ebc3461SAlbert ARIBAUD		must not be both defined at the same time.
32696ebc3461SAlbert ARIBAUD
327095579793STom Rini		CONFIG_SPL_MAX_SIZE
32716ebc3461SAlbert ARIBAUD		Maximum size of the SPL image (text, data, rodata, and
32726ebc3461SAlbert ARIBAUD		linker lists sections), BSS excluded.
32736ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual size does
32746ebc3461SAlbert ARIBAUD		not exceed it.
327595579793STom Rini
32766a11cf48SDaniel Schwierzeck		CONFIG_SPL_TEXT_BASE
32776a11cf48SDaniel Schwierzeck		TEXT_BASE for linking the SPL binary.
32786a11cf48SDaniel Schwierzeck
327994a45bb1SScott Wood		CONFIG_SPL_RELOC_TEXT_BASE
328094a45bb1SScott Wood		Address to relocate to.  If unspecified, this is equal to
328194a45bb1SScott Wood		CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
328294a45bb1SScott Wood
328395579793STom Rini		CONFIG_SPL_BSS_START_ADDR
328495579793STom Rini		Link address for the BSS within the SPL binary.
328595579793STom Rini
328695579793STom Rini		CONFIG_SPL_BSS_MAX_SIZE
32876ebc3461SAlbert ARIBAUD		Maximum size in memory allocated to the SPL BSS.
32886ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual memory used
32896ebc3461SAlbert ARIBAUD		by SPL from __bss_start to __bss_end does not exceed it.
32908960af8bSAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
32916ebc3461SAlbert ARIBAUD		must not be both defined at the same time.
329295579793STom Rini
329395579793STom Rini		CONFIG_SPL_STACK
329495579793STom Rini		Adress of the start of the stack SPL will use
329595579793STom Rini
329694a45bb1SScott Wood		CONFIG_SPL_RELOC_STACK
329794a45bb1SScott Wood		Adress of the start of the stack SPL will use after
329894a45bb1SScott Wood		relocation.  If unspecified, this is equal to
329994a45bb1SScott Wood		CONFIG_SPL_STACK.
330094a45bb1SScott Wood
330195579793STom Rini		CONFIG_SYS_SPL_MALLOC_START
330295579793STom Rini		Starting address of the malloc pool used in SPL.
330395579793STom Rini
330495579793STom Rini		CONFIG_SYS_SPL_MALLOC_SIZE
330595579793STom Rini		The size of the malloc pool used in SPL.
33066a11cf48SDaniel Schwierzeck
330747f7bcaeSTom Rini		CONFIG_SPL_FRAMEWORK
330847f7bcaeSTom Rini		Enable the SPL framework under common/.  This framework
330947f7bcaeSTom Rini		supports MMC, NAND and YMODEM loading of U-Boot and NAND
331047f7bcaeSTom Rini		NAND loading of the Linux Kernel.
331147f7bcaeSTom Rini
33129607faf2STom Rini		CONFIG_SPL_OS_BOOT
33139607faf2STom Rini		Enable booting directly to an OS from SPL.
33149607faf2STom Rini		See also: doc/README.falcon
33159607faf2STom Rini
3316861a86f4STom Rini		CONFIG_SPL_DISPLAY_PRINT
3317861a86f4STom Rini		For ARM, enable an optional function to print more information
3318861a86f4STom Rini		about the running system.
3319861a86f4STom Rini
33204b919725SScott Wood		CONFIG_SPL_INIT_MINIMAL
33214b919725SScott Wood		Arch init code should be built for a very small image
33224b919725SScott Wood
33236a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBCOMMON_SUPPORT
33246a11cf48SDaniel Schwierzeck		Support for common/libcommon.o in SPL binary
33256a11cf48SDaniel Schwierzeck
33266a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBDISK_SUPPORT
33276a11cf48SDaniel Schwierzeck		Support for disk/libdisk.o in SPL binary
33286a11cf48SDaniel Schwierzeck
33296a11cf48SDaniel Schwierzeck		CONFIG_SPL_I2C_SUPPORT
33306a11cf48SDaniel Schwierzeck		Support for drivers/i2c/libi2c.o in SPL binary
33316a11cf48SDaniel Schwierzeck
33326a11cf48SDaniel Schwierzeck		CONFIG_SPL_GPIO_SUPPORT
33336a11cf48SDaniel Schwierzeck		Support for drivers/gpio/libgpio.o in SPL binary
33346a11cf48SDaniel Schwierzeck
33356a11cf48SDaniel Schwierzeck		CONFIG_SPL_MMC_SUPPORT
33366a11cf48SDaniel Schwierzeck		Support for drivers/mmc/libmmc.o in SPL binary
33376a11cf48SDaniel Schwierzeck
333895579793STom Rini		CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
333995579793STom Rini		CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
334095579793STom Rini		CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION
334195579793STom Rini		Address, size and partition on the MMC to load U-Boot from
334295579793STom Rini		when the MMC is being used in raw mode.
334395579793STom Rini
33442b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
33452b75b0adSPeter Korsgaard		Sector to load kernel uImage from when MMC is being
33462b75b0adSPeter Korsgaard		used in raw mode (for Falcon mode)
33472b75b0adSPeter Korsgaard
33482b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
33492b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
33502b75b0adSPeter Korsgaard		Sector and number of sectors to load kernel argument
33512b75b0adSPeter Korsgaard		parameters from when MMC is being used in raw mode
33522b75b0adSPeter Korsgaard		(for falcon mode)
33532b75b0adSPeter Korsgaard
335495579793STom Rini		CONFIG_SPL_FAT_SUPPORT
335595579793STom Rini		Support for fs/fat/libfat.o in SPL binary
335695579793STom Rini
335795579793STom Rini		CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME
335895579793STom Rini		Filename to read to load U-Boot when reading from FAT
335995579793STom Rini
33607ad2cc79SPeter Korsgaard		CONFIG_SPL_FAT_LOAD_KERNEL_NAME
33617ad2cc79SPeter Korsgaard		Filename to read to load kernel uImage when reading
33627ad2cc79SPeter Korsgaard		from FAT (for Falcon mode)
33637ad2cc79SPeter Korsgaard
33647ad2cc79SPeter Korsgaard		CONFIG_SPL_FAT_LOAD_ARGS_NAME
33657ad2cc79SPeter Korsgaard		Filename to read to load kernel argument parameters
33667ad2cc79SPeter Korsgaard		when reading from FAT (for Falcon mode)
33677ad2cc79SPeter Korsgaard
336806f60ae3SScott Wood		CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
336906f60ae3SScott Wood		Set this for NAND SPL on PPC mpc83xx targets, so that
337006f60ae3SScott Wood		start.S waits for the rest of the SPL to load before
337106f60ae3SScott Wood		continuing (the hardware starts execution after just
337206f60ae3SScott Wood		loading the first page rather than the full 4K).
337306f60ae3SScott Wood
3374651fcf60SPrabhakar Kushwaha		CONFIG_SPL_SKIP_RELOCATE
3375651fcf60SPrabhakar Kushwaha		Avoid SPL relocation
3376651fcf60SPrabhakar Kushwaha
33776f2f01b9SScott Wood		CONFIG_SPL_NAND_BASE
33786f2f01b9SScott Wood		Include nand_base.c in the SPL.  Requires
33796f2f01b9SScott Wood		CONFIG_SPL_NAND_DRIVERS.
33806f2f01b9SScott Wood
33816f2f01b9SScott Wood		CONFIG_SPL_NAND_DRIVERS
33826f2f01b9SScott Wood		SPL uses normal NAND drivers, not minimal drivers.
33836f2f01b9SScott Wood
33846f2f01b9SScott Wood		CONFIG_SPL_NAND_ECC
33856f2f01b9SScott Wood		Include standard software ECC in the SPL
33866f2f01b9SScott Wood
338795579793STom Rini		CONFIG_SPL_NAND_SIMPLE
33887d4b7955SScott Wood		Support for NAND boot using simple NAND drivers that
33897d4b7955SScott Wood		expose the cmd_ctrl() interface.
339095579793STom Rini
33916dd3b566STom Rini		CONFIG_SPL_MTD_SUPPORT
33926dd3b566STom Rini		Support for the MTD subsystem within SPL.  Useful for
33936dd3b566STom Rini		environment on NAND support within SPL.
33946dd3b566STom Rini
3395bb0dc108SYing Zhang		CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT
3396bb0dc108SYing Zhang		Set for the SPL on PPC mpc8xxx targets, support for
33975614e71bSYork Sun		drivers/ddr/fsl/libddr.o in SPL binary.
3398bb0dc108SYing Zhang
33997c8eea59SYing Zhang		CONFIG_SPL_COMMON_INIT_DDR
34007c8eea59SYing Zhang		Set for common ddr init with serial presence detect in
34017c8eea59SYing Zhang		SPL binary.
34027c8eea59SYing Zhang
340395579793STom Rini		CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
340495579793STom Rini		CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
340595579793STom Rini		CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
340695579793STom Rini		CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
340795579793STom Rini		CONFIG_SYS_NAND_ECCBYTES
340895579793STom Rini		Defines the size and behavior of the NAND that SPL uses
34097d4b7955SScott Wood		to read U-Boot
341095579793STom Rini
3411fbe76ae4SPrabhakar Kushwaha		CONFIG_SPL_NAND_BOOT
3412fbe76ae4SPrabhakar Kushwaha		Add support NAND boot
3413fbe76ae4SPrabhakar Kushwaha
341495579793STom Rini		CONFIG_SYS_NAND_U_BOOT_OFFS
34157d4b7955SScott Wood		Location in NAND to read U-Boot from
34167d4b7955SScott Wood
34177d4b7955SScott Wood		CONFIG_SYS_NAND_U_BOOT_DST
34187d4b7955SScott Wood		Location in memory to load U-Boot to
34197d4b7955SScott Wood
34207d4b7955SScott Wood		CONFIG_SYS_NAND_U_BOOT_SIZE
34217d4b7955SScott Wood		Size of image to load
342295579793STom Rini
342395579793STom Rini		CONFIG_SYS_NAND_U_BOOT_START
34247d4b7955SScott Wood		Entry point in loaded image to jump to
342595579793STom Rini
342695579793STom Rini		CONFIG_SYS_NAND_HW_ECC_OOBFIRST
342795579793STom Rini		Define this if you need to first read the OOB and then the
342895579793STom Rini		data. This is used for example on davinci plattforms.
342995579793STom Rini
343095579793STom Rini		CONFIG_SPL_OMAP3_ID_NAND
343195579793STom Rini		Support for an OMAP3-specific set of functions to return the
343295579793STom Rini		ID and MFR of the first attached NAND chip, if present.
343395579793STom Rini
34346a11cf48SDaniel Schwierzeck		CONFIG_SPL_SERIAL_SUPPORT
34356a11cf48SDaniel Schwierzeck		Support for drivers/serial/libserial.o in SPL binary
34366a11cf48SDaniel Schwierzeck
34376a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_FLASH_SUPPORT
34386a11cf48SDaniel Schwierzeck		Support for drivers/mtd/spi/libspi_flash.o in SPL binary
34396a11cf48SDaniel Schwierzeck
34406a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_SUPPORT
34416a11cf48SDaniel Schwierzeck		Support for drivers/spi/libspi.o in SPL binary
34426a11cf48SDaniel Schwierzeck
3443c57b953dSPavel Machek		CONFIG_SPL_RAM_DEVICE
3444c57b953dSPavel Machek		Support for running image already present in ram, in SPL binary
3445c57b953dSPavel Machek
34466a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBGENERIC_SUPPORT
34476a11cf48SDaniel Schwierzeck		Support for lib/libgeneric.o in SPL binary
34481372cce2SMarian Balakowicz
3449ba1bee43SYing Zhang		CONFIG_SPL_ENV_SUPPORT
3450ba1bee43SYing Zhang		Support for the environment operating in SPL binary
3451ba1bee43SYing Zhang
3452ba1bee43SYing Zhang		CONFIG_SPL_NET_SUPPORT
3453ba1bee43SYing Zhang		Support for the net/libnet.o in SPL binary.
3454ba1bee43SYing Zhang		It conflicts with SPL env from storage medium specified by
3455ba1bee43SYing Zhang		CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3456ba1bee43SYing Zhang
345774752baaSScott Wood		CONFIG_SPL_PAD_TO
34586113d3f2SBenoît Thébaudeau		Image offset to which the SPL should be padded before appending
34596113d3f2SBenoît Thébaudeau		the SPL payload. By default, this is defined as
34606113d3f2SBenoît Thébaudeau		CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
34616113d3f2SBenoît Thébaudeau		CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
34626113d3f2SBenoît Thébaudeau		payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
346374752baaSScott Wood
3464ca2fca22SScott Wood		CONFIG_SPL_TARGET
3465ca2fca22SScott Wood		Final target image containing SPL and payload.  Some SPLs
3466ca2fca22SScott Wood		use an arch-specific makefile fragment instead, for
3467ca2fca22SScott Wood		example if more than one image needs to be produced.
3468ca2fca22SScott Wood
346987ebee39SSimon Glass		CONFIG_FIT_SPL_PRINT
347087ebee39SSimon Glass		Printing information about a FIT image adds quite a bit of
347187ebee39SSimon Glass		code to SPL. So this is normally disabled in SPL. Use this
347287ebee39SSimon Glass		option to re-enable it. This will affect the output of the
347387ebee39SSimon Glass		bootm command when booting a FIT image.
347487ebee39SSimon Glass
34753aa29de0SYing Zhang- TPL framework
34763aa29de0SYing Zhang		CONFIG_TPL
34773aa29de0SYing Zhang		Enable building of TPL globally.
34783aa29de0SYing Zhang
34793aa29de0SYing Zhang		CONFIG_TPL_PAD_TO
34803aa29de0SYing Zhang		Image offset to which the TPL should be padded before appending
34813aa29de0SYing Zhang		the TPL payload. By default, this is defined as
34823aa29de0SYing Zhang		CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
34833aa29de0SYing Zhang		CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
34843aa29de0SYing Zhang		payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
34853aa29de0SYing Zhang
3486c609719bSwdenkModem Support:
3487c609719bSwdenk--------------
3488c609719bSwdenk
3489566e5cf4SWolfgang Denk[so far only for SMDK2400 boards]
3490c609719bSwdenk
349111ccc33fSMarcel Ziswiler- Modem support enable:
3492c609719bSwdenk		CONFIG_MODEM_SUPPORT
3493c609719bSwdenk
3494c609719bSwdenk- RTS/CTS Flow control enable:
3495c609719bSwdenk		CONFIG_HWFLOW
3496c609719bSwdenk
3497c609719bSwdenk- Modem debug support:
3498c609719bSwdenk		CONFIG_MODEM_SUPPORT_DEBUG
3499c609719bSwdenk
3500c609719bSwdenk		Enables debugging stuff (char screen[1024], dbg())
3501c609719bSwdenk		for modem support. Useful only with BDI2000.
3502c609719bSwdenk
3503a8c7c708Swdenk- Interrupt support (PPC):
3504a8c7c708Swdenk
3505a8c7c708Swdenk		There are common interrupt_init() and timer_interrupt()
3506a8c7c708Swdenk		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
350711ccc33fSMarcel Ziswiler		for CPU specific initialization. interrupt_init_cpu()
3508a8c7c708Swdenk		should set decrementer_count to appropriate value. If
350911ccc33fSMarcel Ziswiler		CPU resets decrementer automatically after interrupt
3510a8c7c708Swdenk		(ppc4xx) it should set decrementer_count to zero.
351111ccc33fSMarcel Ziswiler		timer_interrupt() calls timer_interrupt_cpu() for CPU
3512a8c7c708Swdenk		specific handling. If board has watchdog / status_led
3513a8c7c708Swdenk		/ other_activity_monitor it works automatically from
3514a8c7c708Swdenk		general timer_interrupt().
3515a8c7c708Swdenk
3516c609719bSwdenk- General:
3517c609719bSwdenk
3518c609719bSwdenk		In the target system modem support is enabled when a
3519c609719bSwdenk		specific key (key combination) is pressed during
3520c609719bSwdenk		power-on. Otherwise U-Boot will boot normally
352111ccc33fSMarcel Ziswiler		(autoboot). The key_pressed() function is called from
3522c609719bSwdenk		board_init(). Currently key_pressed() is a dummy
3523c609719bSwdenk		function, returning 1 and thus enabling modem
3524c609719bSwdenk		initialization.
3525c609719bSwdenk
3526c609719bSwdenk		If there are no modem init strings in the
3527c609719bSwdenk		environment, U-Boot proceed to autoboot; the
3528c609719bSwdenk		previous output (banner, info printfs) will be
352911ccc33fSMarcel Ziswiler		suppressed, though.
3530c609719bSwdenk
3531c609719bSwdenk		See also: doc/README.Modem
3532c609719bSwdenk
35339660e442SHelmut RaigerBoard initialization settings:
35349660e442SHelmut Raiger------------------------------
35359660e442SHelmut Raiger
35369660e442SHelmut RaigerDuring Initialization u-boot calls a number of board specific functions
35379660e442SHelmut Raigerto allow the preparation of board specific prerequisites, e.g. pin setup
35389660e442SHelmut Raigerbefore drivers are initialized. To enable these callbacks the
35399660e442SHelmut Raigerfollowing configuration macros have to be defined. Currently this is
35409660e442SHelmut Raigerarchitecture specific, so please check arch/your_architecture/lib/board.c
35419660e442SHelmut Raigertypically in board_init_f() and board_init_r().
35429660e442SHelmut Raiger
35439660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
35449660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
35459660e442SHelmut Raiger- CONFIG_BOARD_LATE_INIT: Call board_late_init()
35469660e442SHelmut Raiger- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
3547c609719bSwdenk
3548c609719bSwdenkConfiguration Settings:
3549c609719bSwdenk-----------------------
3550c609719bSwdenk
35514d1fd7f1SYork Sun- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
35524d1fd7f1SYork Sun		Optionally it can be defined to support 64-bit memory commands.
35534d1fd7f1SYork Sun
35546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
3555c609719bSwdenk		undefine this when you're short of memory.
3556c609719bSwdenk
35572fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
35582fb2604dSPeter Tyser		width of the commands listed in the 'help' command output.
35592fb2604dSPeter Tyser
35606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT:	This is what U-Boot prints on the console to
3561c609719bSwdenk		prompt for user input.
3562c609719bSwdenk
35636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE:	Buffer size for input from the Console
3564c609719bSwdenk
35656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE:	Buffer size for Console output
3566c609719bSwdenk
35676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS:	max. Number of arguments accepted for monitor commands
3568c609719bSwdenk
35696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
3570c609719bSwdenk		the application (usually a Linux kernel) when it is
3571c609719bSwdenk		booted
3572c609719bSwdenk
35736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE:
3574c609719bSwdenk		List of legal baudrate settings for this board.
3575c609719bSwdenk
35766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_INFO_QUIET
3577c609719bSwdenk		Suppress display of console information at boot.
3578c609719bSwdenk
35796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_IS_IN_ENV
3580c609719bSwdenk		If the board specific function
3581c609719bSwdenk			extern int overwrite_console (void);
3582c609719bSwdenk		returns 1, the stdin, stderr and stdout are switched to the
3583c609719bSwdenk		serial port, else the settings in the environment are used.
3584c609719bSwdenk
35856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
3586c609719bSwdenk		Enable the call to overwrite_console().
3587c609719bSwdenk
35886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
3589c609719bSwdenk		Enable overwrite of previous console environment settings.
3590c609719bSwdenk
35916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
3592c609719bSwdenk		Begin and End addresses of the area used by the
3593c609719bSwdenk		simple memory test.
3594c609719bSwdenk
35956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST:
3596c609719bSwdenk		Enable an alternate, more extensive memory test.
3597c609719bSwdenk
35986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH:
35995f535fe1Swdenk		Scratch address used by the alternate memory test
36005f535fe1Swdenk		You only need to set this if address zero isn't writeable
36015f535fe1Swdenk
36026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
36036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
360414f73ca6SStefan Roese		this specified memory area will get subtracted from the top
360511ccc33fSMarcel Ziswiler		(end) of RAM and won't get "touched" at all by U-Boot. By
360614f73ca6SStefan Roese		fixing up gd->ram_size the Linux kernel should gets passed
360714f73ca6SStefan Roese		the now "corrected" memory size and won't touch it either.
360814f73ca6SStefan Roese		This should work for arch/ppc and arch/powerpc. Only Linux
36095e12e75dSStefan Roese		board ports in arch/powerpc with bootwrapper support that
361014f73ca6SStefan Roese		recalculate the memory size from the SDRAM controller setup
36115e12e75dSStefan Roese		will have to get fixed in Linux additionally.
361214f73ca6SStefan Roese
361314f73ca6SStefan Roese		This option can be used as a workaround for the 440EPx/GRx
361414f73ca6SStefan Roese		CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
361514f73ca6SStefan Roese		be touched.
361614f73ca6SStefan Roese
361714f73ca6SStefan Roese		WARNING: Please make sure that this value is a multiple of
361814f73ca6SStefan Roese		the Linux page size (normally 4k). If this is not the case,
361914f73ca6SStefan Roese		then the end address of the Linux memory will be located at a
362014f73ca6SStefan Roese		non page size aligned address and this could cause major
362114f73ca6SStefan Roese		problems.
362214f73ca6SStefan Roese
36236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE:
3624c609719bSwdenk		Enable temporary baudrate change while serial download
3625c609719bSwdenk
36266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE:
3627c609719bSwdenk		Physical start address of SDRAM. _Must_ be 0 here.
3628c609719bSwdenk
36296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MBIO_BASE:
3630c609719bSwdenk		Physical start address of Motherboard I/O (if using a
3631c609719bSwdenk		Cogent motherboard)
3632c609719bSwdenk
36336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE:
3634c609719bSwdenk		Physical start address of Flash memory.
3635c609719bSwdenk
36366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE:
3637c609719bSwdenk		Physical start address of boot monitor code (set by
3638c609719bSwdenk		make config files to be same as the text base address
363914d0a02aSWolfgang Denk		(CONFIG_SYS_TEXT_BASE) used when linking) - same as
36406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FLASH_BASE when booting from flash.
3641c609719bSwdenk
36426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN:
36433b57fe0aSwdenk		Size of memory reserved for monitor code, used to
36443b57fe0aSwdenk		determine _at_compile_time_ (!) if the environment is
36453b57fe0aSwdenk		embedded within the U-Boot image, or in a separate
36463b57fe0aSwdenk		flash sector.
3647c609719bSwdenk
36486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN:
3649c609719bSwdenk		Size of DRAM reserved for malloc() use.
3650c609719bSwdenk
36516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN:
365215940c9aSStefan Roese		Normally compressed uImages are limited to an
365315940c9aSStefan Roese		uncompressed size of 8 MBytes. If this is not enough,
36546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		you can define CONFIG_SYS_BOOTM_LEN in your board config file
365515940c9aSStefan Roese		to adjust this setting to your needs.
3656c609719bSwdenk
36576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ:
3658c609719bSwdenk		Maximum size of memory mapped by the startup code of
3659c609719bSwdenk		the Linux kernel; all data that must be processed by
36607d721e34SBartlomiej Sieka		the Linux kernel (bd_info, boot arguments, FDT blob if
36617d721e34SBartlomiej Sieka		used) must be put below this limit, unless "bootm_low"
36621bce2aebSRobert P. J. Day		environment variable is defined and non-zero. In such case
36637d721e34SBartlomiej Sieka		all data for the Linux kernel must be between "bootm_low"
3664c3624e6eSGrant Likely		and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.	 The environment
3665c3624e6eSGrant Likely		variable "bootm_mapsize" will override the value of
3666c3624e6eSGrant Likely		CONFIG_SYS_BOOTMAPSZ.  If CONFIG_SYS_BOOTMAPSZ is undefined,
3667c3624e6eSGrant Likely		then the value in "bootm_size" will be used instead.
3668c609719bSwdenk
3669fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3670fca43cc8SJohn Rigby		Enable initrd_high functionality.  If defined then the
3671fca43cc8SJohn Rigby		initrd_high feature is enabled and the bootm ramdisk subcommand
3672fca43cc8SJohn Rigby		is enabled.
3673fca43cc8SJohn Rigby
3674fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_CMDLINE:
3675fca43cc8SJohn Rigby		Enables allocating and saving kernel cmdline in space between
3676fca43cc8SJohn Rigby		"bootm_low" and "bootm_low" + BOOTMAPSZ.
3677fca43cc8SJohn Rigby
3678fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_KBD:
3679fca43cc8SJohn Rigby		Enables allocating and saving a kernel copy of the bd_info in
3680fca43cc8SJohn Rigby		space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3681fca43cc8SJohn Rigby
36826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS:
3683c609719bSwdenk		Max number of Flash memory banks
3684c609719bSwdenk
36856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT:
3686c609719bSwdenk		Max number of sectors on a Flash chip
3687c609719bSwdenk
36886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT:
3689c609719bSwdenk		Timeout for Flash erase operations (in ms)
3690c609719bSwdenk
36916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT:
3692c609719bSwdenk		Timeout for Flash write operations (in ms)
3693c609719bSwdenk
36946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT
36958564acf9Swdenk		Timeout for Flash set sector lock bit operation (in ms)
36968564acf9Swdenk
36976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT
36988564acf9Swdenk		Timeout for Flash clear lock bits operation (in ms)
36998564acf9Swdenk
37006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION
37018564acf9Swdenk		If defined, hardware flash sectors protection is used
37028564acf9Swdenk		instead of U-Boot software protection.
37038564acf9Swdenk
37046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP:
3705c609719bSwdenk
3706c609719bSwdenk		Enable TFTP transfers directly to flash memory;
3707c609719bSwdenk		without this option such a download has to be
3708c609719bSwdenk		performed in two steps: (1) download to RAM, and (2)
3709c609719bSwdenk		copy from RAM to flash.
3710c609719bSwdenk
3711c609719bSwdenk		The two-step approach is usually more reliable, since
3712c609719bSwdenk		you can check if the download worked before you erase
371311ccc33fSMarcel Ziswiler		the flash, but in some situations (when system RAM is
371411ccc33fSMarcel Ziswiler		too limited to allow for a temporary copy of the
3715c609719bSwdenk		downloaded image) this option may be very useful.
3716c609719bSwdenk
37176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI:
3718c609719bSwdenk		Define if the flash driver uses extra elements in the
37195653fc33Swdenk		common flash structure for storing flash geometry.
37205653fc33Swdenk
372100b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER
37225653fc33Swdenk		This option also enables the building of the cfi_flash driver
37235653fc33Swdenk		in the drivers directory
372453cf9435Sstroese
372591809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD
372691809ed5SPiotr Ziecik		This option enables the building of the cfi_mtd driver
372791809ed5SPiotr Ziecik		in the drivers directory. The driver exports CFI flash
372891809ed5SPiotr Ziecik		to the MTD layer.
372991809ed5SPiotr Ziecik
37306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
373196ef831fSGuennadi Liakhovetski		Use buffered writes to flash.
373296ef831fSGuennadi Liakhovetski
373396ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N
373496ef831fSGuennadi Liakhovetski		s29ws-n MirrorBit flash has non-standard addresses for buffered
373596ef831fSGuennadi Liakhovetski		write commands.
373696ef831fSGuennadi Liakhovetski
37376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST
37385568e613SStefan Roese		If this option is defined, the common CFI flash doesn't
37395568e613SStefan Roese		print it's warning upon not recognized FLASH banks. This
37405568e613SStefan Roese		is useful, if some of the configured banks are only
37415568e613SStefan Roese		optionally available.
37425568e613SStefan Roese
37439a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS
37449a042e9cSJerry Van Baren		If defined (must be an integer), print out countdown
37459a042e9cSJerry Van Baren		digits and dots.  Recommended value: 45 (9..1) for 80
37469a042e9cSJerry Van Baren		column displays, 15 (3..1) for 40 column displays.
37479a042e9cSJerry Van Baren
3748352ef3f1SStefan Roese- CONFIG_FLASH_VERIFY
3749352ef3f1SStefan Roese		If defined, the content of the flash (destination) is compared
3750352ef3f1SStefan Roese		against the source after the write operation. An error message
3751352ef3f1SStefan Roese		will be printed when the contents are not identical.
3752352ef3f1SStefan Roese		Please note that this option is useless in nearly all cases,
3753352ef3f1SStefan Roese		since such flash programming errors usually are detected earlier
3754352ef3f1SStefan Roese		while unprotecting/erasing/programming. Please only enable
3755352ef3f1SStefan Roese		this option if you really know what you are doing.
3756352ef3f1SStefan Roese
37576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER:
375811ccc33fSMarcel Ziswiler		Defines the number of Ethernet receive buffers. On some
375911ccc33fSMarcel Ziswiler		Ethernet controllers it is recommended to set this value
376053cf9435Sstroese		to 8 or even higher (EEPRO100 or 405 EMAC), since all
376153cf9435Sstroese		buffers can be full shortly after enabling the interface
376211ccc33fSMarcel Ziswiler		on high Ethernet traffic.
376353cf9435Sstroese		Defaults to 4 if not defined.
3764c609719bSwdenk
3765ea882bafSWolfgang Denk- CONFIG_ENV_MAX_ENTRIES
3766ea882bafSWolfgang Denk
3767ea882bafSWolfgang Denk	Maximum number of entries in the hash table that is used
3768ea882bafSWolfgang Denk	internally to store the environment settings. The default
3769ea882bafSWolfgang Denk	setting is supposed to be generous and should work in most
3770ea882bafSWolfgang Denk	cases. This setting can be used to tune behaviour; see
3771ea882bafSWolfgang Denk	lib/hashtable.c for details.
3772ea882bafSWolfgang Denk
37732598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_DEFAULT
37742598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_STATIC
37751bce2aebSRobert P. J. Day	Enable validation of the values given to environment variables when
37762598090bSJoe Hershberger	calling env set.  Variables can be restricted to only decimal,
37772598090bSJoe Hershberger	hexadecimal, or boolean.  If CONFIG_CMD_NET is also defined,
37782598090bSJoe Hershberger	the variables can also be restricted to IP address or MAC address.
37792598090bSJoe Hershberger
37802598090bSJoe Hershberger	The format of the list is:
37812598090bSJoe Hershberger		type_attribute = [s|d|x|b|i|m]
3782267541f7SJoe Hershberger		access_atribute = [a|r|o|c]
3783267541f7SJoe Hershberger		attributes = type_attribute[access_atribute]
37842598090bSJoe Hershberger		entry = variable_name[:attributes]
37852598090bSJoe Hershberger		list = entry[,list]
37862598090bSJoe Hershberger
37872598090bSJoe Hershberger	The type attributes are:
37882598090bSJoe Hershberger		s - String (default)
37892598090bSJoe Hershberger		d - Decimal
37902598090bSJoe Hershberger		x - Hexadecimal
37912598090bSJoe Hershberger		b - Boolean ([1yYtT|0nNfF])
37922598090bSJoe Hershberger		i - IP address
37932598090bSJoe Hershberger		m - MAC address
37942598090bSJoe Hershberger
3795267541f7SJoe Hershberger	The access attributes are:
3796267541f7SJoe Hershberger		a - Any (default)
3797267541f7SJoe Hershberger		r - Read-only
3798267541f7SJoe Hershberger		o - Write-once
3799267541f7SJoe Hershberger		c - Change-default
3800267541f7SJoe Hershberger
38012598090bSJoe Hershberger	- CONFIG_ENV_FLAGS_LIST_DEFAULT
38022598090bSJoe Hershberger		Define this to a list (string) to define the ".flags"
38032598090bSJoe Hershberger		envirnoment variable in the default or embedded environment.
38042598090bSJoe Hershberger
38052598090bSJoe Hershberger	- CONFIG_ENV_FLAGS_LIST_STATIC
38062598090bSJoe Hershberger		Define this to a list (string) to define validation that
38072598090bSJoe Hershberger		should be done if an entry is not found in the ".flags"
38082598090bSJoe Hershberger		environment variable.  To override a setting in the static
38092598090bSJoe Hershberger		list, simply add an entry for the same variable name to the
38102598090bSJoe Hershberger		".flags" variable.
38112598090bSJoe Hershberger
3812267541f7SJoe Hershberger- CONFIG_ENV_ACCESS_IGNORE_FORCE
3813267541f7SJoe Hershberger	If defined, don't allow the -f switch to env set override variable
3814267541f7SJoe Hershberger	access flags.
3815267541f7SJoe Hershberger
38165c1a7ea6SSimon Glass- CONFIG_SYS_GENERIC_BOARD
38175c1a7ea6SSimon Glass	This selects the architecture-generic board system instead of the
38185c1a7ea6SSimon Glass	architecture-specific board files. It is intended to move boards
38195c1a7ea6SSimon Glass	to this new framework over time. Defining this will disable the
38205c1a7ea6SSimon Glass	arch/foo/lib/board.c file and use common/board_f.c and
38215c1a7ea6SSimon Glass	common/board_r.c instead. To use this option your architecture
38225c1a7ea6SSimon Glass	must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in
38235c1a7ea6SSimon Glass	its config.mk file). If you find problems enabling this option on
38245c1a7ea6SSimon Glass	your board please report the problem and send patches!
38255c1a7ea6SSimon Glass
38260b1b60c7SLokesh Vutla- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
38270b1b60c7SLokesh Vutla	This is set by OMAP boards for the max time that reset should
38280b1b60c7SLokesh Vutla	be asserted. See doc/README.omap-reset-time for details on how
38290b1b60c7SLokesh Vutla	the value can be calulated on a given board.
3830632efa74SSimon Glass
3831c609719bSwdenkThe following definitions that deal with the placement and management
3832c609719bSwdenkof environment data (variable area); in general, we support the
3833c609719bSwdenkfollowing configurations:
3834c609719bSwdenk
3835c3eb3fe4SMike Frysinger- CONFIG_BUILD_ENVCRC:
3836c3eb3fe4SMike Frysinger
3837c3eb3fe4SMike Frysinger	Builds up envcrc with the target environment so that external utils
3838c3eb3fe4SMike Frysinger	may easily extract it and embed it in final U-Boot images.
3839c3eb3fe4SMike Frysinger
38405a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH:
3841c609719bSwdenk
3842c609719bSwdenk	Define this if the environment is in flash memory.
3843c609719bSwdenk
3844c609719bSwdenk	a) The environment occupies one whole flash sector, which is
3845c609719bSwdenk	   "embedded" in the text segment with the U-Boot code. This
3846c609719bSwdenk	   happens usually with "bottom boot sector" or "top boot
3847c609719bSwdenk	   sector" type flash chips, which have several smaller
3848c609719bSwdenk	   sectors at the start or the end. For instance, such a
3849c609719bSwdenk	   layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3850c609719bSwdenk	   such a case you would place the environment in one of the
3851c609719bSwdenk	   4 kB sectors - with U-Boot code before and after it. With
3852c609719bSwdenk	   "top boot sector" type flash chips, you would put the
3853c609719bSwdenk	   environment in one of the last sectors, leaving a gap
3854c609719bSwdenk	   between U-Boot and the environment.
3855c609719bSwdenk
38560e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
3857c609719bSwdenk
3858c609719bSwdenk	   Offset of environment data (variable area) to the
3859c609719bSwdenk	   beginning of flash memory; for instance, with bottom boot
3860c609719bSwdenk	   type flash chips the second sector can be used: the offset
3861c609719bSwdenk	   for this sector is given here.
3862c609719bSwdenk
38636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
3864c609719bSwdenk
38650e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
3866c609719bSwdenk
3867c609719bSwdenk	   This is just another way to specify the start address of
3868c609719bSwdenk	   the flash sector containing the environment (instead of
38690e8d1586SJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET).
3870c609719bSwdenk
38710e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SECT_SIZE:
3872c609719bSwdenk
3873c609719bSwdenk	   Size of the sector containing the environment.
3874c609719bSwdenk
3875c609719bSwdenk
3876c609719bSwdenk	b) Sometimes flash chips have few, equal sized, BIG sectors.
3877c609719bSwdenk	   In such a case you don't want to spend a whole sector for
3878c609719bSwdenk	   the environment.
3879c609719bSwdenk
38800e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3881c609719bSwdenk
38825a1aceb0SJean-Christophe PLAGNIOL-VILLARD	   If you use this in combination with CONFIG_ENV_IS_IN_FLASH
38830e8d1586SJean-Christophe PLAGNIOL-VILLARD	   and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
3884c609719bSwdenk	   of this flash sector for the environment. This saves
3885c609719bSwdenk	   memory for the RAM copy of the environment.
3886c609719bSwdenk
3887c609719bSwdenk	   It may also save flash memory if you decide to use this
3888c609719bSwdenk	   when your environment is "embedded" within U-Boot code,
3889c609719bSwdenk	   since then the remainder of the flash sector could be used
3890c609719bSwdenk	   for U-Boot code. It should be pointed out that this is
3891c609719bSwdenk	   STRONGLY DISCOURAGED from a robustness point of view:
3892c609719bSwdenk	   updating the environment in flash makes it always
3893c609719bSwdenk	   necessary to erase the WHOLE sector. If something goes
3894c609719bSwdenk	   wrong before the contents has been restored from a copy in
3895c609719bSwdenk	   RAM, your target system will be dead.
3896c609719bSwdenk
38970e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR_REDUND
38980e8d1586SJean-Christophe PLAGNIOL-VILLARD	  CONFIG_ENV_SIZE_REDUND
3899c609719bSwdenk
3900c609719bSwdenk	   These settings describe a second storage area used to hold
390111ccc33fSMarcel Ziswiler	   a redundant copy of the environment data, so that there is
39023e38691eSwdenk	   a valid backup copy in case there is a power failure during
3903c609719bSwdenk	   a "saveenv" operation.
3904c609719bSwdenk
3905c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the
3906c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds*
3907c609719bSwdenkaccordingly!
3908c609719bSwdenk
3909c609719bSwdenk
39109314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM:
3911c609719bSwdenk
3912c609719bSwdenk	Define this if you have some non-volatile memory device
3913c609719bSwdenk	(NVRAM, battery buffered SRAM) which you want to use for the
3914c609719bSwdenk	environment.
3915c609719bSwdenk
39160e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
39170e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3918c609719bSwdenk
391911ccc33fSMarcel Ziswiler	  These two #defines are used to determine the memory area you
3920c609719bSwdenk	  want to use for environment. It is assumed that this memory
3921c609719bSwdenk	  can just be read and written to, without any special
3922c609719bSwdenk	  provision.
3923c609719bSwdenk
3924c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early
3925c609719bSwdenkin U-Boot initalization (when we try to get the setting of for the
392611ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or
3927c609719bSwdenkU-Boot will hang.
3928c609719bSwdenk
3929c609719bSwdenkPlease note that even with NVRAM we still use a copy of the
3930c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to
3931c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv"
3932c609719bSwdenkto save the current settings.
3933c609719bSwdenk
3934c609719bSwdenk
3935bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM:
3936c609719bSwdenk
3937c609719bSwdenk	Use this if you have an EEPROM or similar serial access
3938c609719bSwdenk	device and a driver for it.
3939c609719bSwdenk
39400e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
39410e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3942c609719bSwdenk
3943c609719bSwdenk	  These two #defines specify the offset and size of the
3944c609719bSwdenk	  environment area within the total memory of your EEPROM.
3945c609719bSwdenk
39466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR:
3947c609719bSwdenk	  If defined, specified the chip address of the EEPROM device.
3948c609719bSwdenk	  The default address is zero.
3949c609719bSwdenk
39506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
3951c609719bSwdenk	  If defined, the number of bits used to address bytes in a
3952c609719bSwdenk	  single page in the EEPROM device.  A 64 byte page, for example
3953c609719bSwdenk	  would require six bits.
3954c609719bSwdenk
39556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
3956c609719bSwdenk	  If defined, the number of milliseconds to delay between
3957c609719bSwdenk	  page writes.	The default is zero milliseconds.
3958c609719bSwdenk
39596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
3960c609719bSwdenk	  The length in bytes of the EEPROM memory array address.  Note
3961c609719bSwdenk	  that this is NOT the chip address length!
3962c609719bSwdenk
39636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
39645cf91d6bSwdenk	  EEPROM chips that implement "address overflow" are ones
39655cf91d6bSwdenk	  like Catalyst 24WC04/08/16 which has 9/10/11 bits of
39665cf91d6bSwdenk	  address and the extra bits end up in the "chip address" bit
39675cf91d6bSwdenk	  slots. This makes a 24WC08 (1Kbyte) chip look like four 256
39685cf91d6bSwdenk	  byte chips.
39695cf91d6bSwdenk
39705cf91d6bSwdenk	  Note that we consider the length of the address field to
39715cf91d6bSwdenk	  still be one byte because the extra address bits are hidden
39725cf91d6bSwdenk	  in the chip address.
39735cf91d6bSwdenk
39746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_SIZE:
3975c609719bSwdenk	  The size in bytes of the EEPROM device.
3976c609719bSwdenk
3977548738b4SHeiko Schocher	- CONFIG_ENV_EEPROM_IS_ON_I2C
3978548738b4SHeiko Schocher	  define this, if you have I2C and SPI activated, and your
3979548738b4SHeiko Schocher	  EEPROM, which holds the environment, is on the I2C bus.
3980548738b4SHeiko Schocher
3981548738b4SHeiko Schocher	- CONFIG_I2C_ENV_EEPROM_BUS
3982548738b4SHeiko Schocher	  if you have an Environment on an EEPROM reached over
3983548738b4SHeiko Schocher	  I2C muxes, you can define here, how to reach this
3984548738b4SHeiko Schocher	  EEPROM. For example:
3985548738b4SHeiko Schocher
3986ea818dbbSHeiko Schocher	  #define CONFIG_I2C_ENV_EEPROM_BUS	  1
3987548738b4SHeiko Schocher
3988548738b4SHeiko Schocher	  EEPROM which holds the environment, is reached over
3989548738b4SHeiko Schocher	  a pca9547 i2c mux with address 0x70, channel 3.
3990c609719bSwdenk
3991057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH:
39925779d8d9Swdenk
39935779d8d9Swdenk	Define this if you have a DataFlash memory device which you
39945779d8d9Swdenk	want to use for the environment.
39955779d8d9Swdenk
39960e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
39970e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
39980e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
39995779d8d9Swdenk
40005779d8d9Swdenk	  These three #defines specify the offset and size of the
40015779d8d9Swdenk	  environment area within the total memory of your DataFlash placed
40025779d8d9Swdenk	  at the specified address.
40035779d8d9Swdenk
40040a85a9e7SLiu Gang- CONFIG_ENV_IS_IN_REMOTE:
40050a85a9e7SLiu Gang
40060a85a9e7SLiu Gang	Define this if you have a remote memory space which you
40070a85a9e7SLiu Gang	want to use for the local device's environment.
40080a85a9e7SLiu Gang
40090a85a9e7SLiu Gang	- CONFIG_ENV_ADDR:
40100a85a9e7SLiu Gang	- CONFIG_ENV_SIZE:
40110a85a9e7SLiu Gang
40120a85a9e7SLiu Gang	  These two #defines specify the address and size of the
40130a85a9e7SLiu Gang	  environment area within the remote memory space. The
40140a85a9e7SLiu Gang	  local device can get the environment from remote memory
4015fc54c7faSLiu Gang	  space by SRIO or PCIE links.
40160a85a9e7SLiu Gang
40170a85a9e7SLiu GangBE CAREFUL! For some special cases, the local device can not use
40180a85a9e7SLiu Gang"saveenv" command. For example, the local device will get the
4019fc54c7faSLiu Gangenvironment stored in a remote NOR flash by SRIO or PCIE link,
4020fc54c7faSLiu Gangbut it can not erase, write this NOR flash by SRIO or PCIE interface.
40210a85a9e7SLiu Gang
402251bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND:
402313a5695bSwdenk
402413a5695bSwdenk	Define this if you have a NAND device which you want to use
402513a5695bSwdenk	for the environment.
402613a5695bSwdenk
40270e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
40280e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
402913a5695bSwdenk
403013a5695bSwdenk	  These two #defines specify the offset and size of the environment
4031fdd813deSScott Wood	  area within the first NAND device.  CONFIG_ENV_OFFSET must be
4032fdd813deSScott Wood	  aligned to an erase block boundary.
40335779d8d9Swdenk
4034fdd813deSScott Wood	- CONFIG_ENV_OFFSET_REDUND (optional):
4035e443c944SMarkus Klotzbuecher
40360e8d1586SJean-Christophe PLAGNIOL-VILLARD	  This setting describes a second storage area of CONFIG_ENV_SIZE
4037fdd813deSScott Wood	  size used to hold a redundant copy of the environment data, so
4038fdd813deSScott Wood	  that there is a valid backup copy in case there is a power failure
4039fdd813deSScott Wood	  during a "saveenv" operation.	 CONFIG_ENV_OFFSET_RENDUND must be
4040fdd813deSScott Wood	  aligned to an erase block boundary.
4041e443c944SMarkus Klotzbuecher
4042fdd813deSScott Wood	- CONFIG_ENV_RANGE (optional):
4043fdd813deSScott Wood
4044fdd813deSScott Wood	  Specifies the length of the region in which the environment
4045fdd813deSScott Wood	  can be written.  This should be a multiple of the NAND device's
4046fdd813deSScott Wood	  block size.  Specifying a range with more erase blocks than
4047fdd813deSScott Wood	  are needed to hold CONFIG_ENV_SIZE allows bad blocks within
4048fdd813deSScott Wood	  the range to be avoided.
4049fdd813deSScott Wood
4050fdd813deSScott Wood	- CONFIG_ENV_OFFSET_OOB (optional):
4051fdd813deSScott Wood
4052fdd813deSScott Wood	  Enables support for dynamically retrieving the offset of the
4053fdd813deSScott Wood	  environment from block zero's out-of-band data.  The
4054fdd813deSScott Wood	  "nand env.oob" command can be used to record this offset.
4055fdd813deSScott Wood	  Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
4056fdd813deSScott Wood	  using CONFIG_ENV_OFFSET_OOB.
4057e443c944SMarkus Klotzbuecher
4058b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST
4059b74ab737SGuennadi Liakhovetski
4060b74ab737SGuennadi Liakhovetski	Defines address in RAM to which the nand_spl code should copy the
4061b74ab737SGuennadi Liakhovetski	environment. If redundant environment is used, it will be copied to
4062b74ab737SGuennadi Liakhovetski	CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
4063b74ab737SGuennadi Liakhovetski
40642b74433fSJoe Hershberger- CONFIG_ENV_IS_IN_UBI:
40652b74433fSJoe Hershberger
40662b74433fSJoe Hershberger	Define this if you have an UBI volume that you want to use for the
40672b74433fSJoe Hershberger	environment.  This has the benefit of wear-leveling the environment
40682b74433fSJoe Hershberger	accesses, which is important on NAND.
40692b74433fSJoe Hershberger
40702b74433fSJoe Hershberger	- CONFIG_ENV_UBI_PART:
40712b74433fSJoe Hershberger
40722b74433fSJoe Hershberger	  Define this to a string that is the mtd partition containing the UBI.
40732b74433fSJoe Hershberger
40742b74433fSJoe Hershberger	- CONFIG_ENV_UBI_VOLUME:
40752b74433fSJoe Hershberger
40762b74433fSJoe Hershberger	  Define this to the name of the volume that you want to store the
40772b74433fSJoe Hershberger	  environment in.
40782b74433fSJoe Hershberger
4079785881f7SJoe Hershberger	- CONFIG_ENV_UBI_VOLUME_REDUND:
4080785881f7SJoe Hershberger
4081785881f7SJoe Hershberger	  Define this to the name of another volume to store a second copy of
4082785881f7SJoe Hershberger	  the environment in.  This will enable redundant environments in UBI.
4083785881f7SJoe Hershberger	  It is assumed that both volumes are in the same MTD partition.
4084785881f7SJoe Hershberger
40852b74433fSJoe Hershberger	- CONFIG_UBI_SILENCE_MSG
40862b74433fSJoe Hershberger	- CONFIG_UBIFS_SILENCE_MSG
40872b74433fSJoe Hershberger
40882b74433fSJoe Hershberger	  You will probably want to define these to avoid a really noisy system
40892b74433fSJoe Hershberger	  when storing the env in UBI.
40902b74433fSJoe Hershberger
409106e4ae5fSStephen Warren- CONFIG_ENV_IS_IN_MMC:
409206e4ae5fSStephen Warren
409306e4ae5fSStephen Warren	Define this if you have an MMC device which you want to use for the
409406e4ae5fSStephen Warren	environment.
409506e4ae5fSStephen Warren
409606e4ae5fSStephen Warren	- CONFIG_SYS_MMC_ENV_DEV:
409706e4ae5fSStephen Warren
409806e4ae5fSStephen Warren	  Specifies which MMC device the environment is stored in.
409906e4ae5fSStephen Warren
410006e4ae5fSStephen Warren	- CONFIG_SYS_MMC_ENV_PART (optional):
410106e4ae5fSStephen Warren
410206e4ae5fSStephen Warren	  Specifies which MMC partition the environment is stored in. If not
410306e4ae5fSStephen Warren	  set, defaults to partition 0, the user area. Common values might be
410406e4ae5fSStephen Warren	  1 (first MMC boot partition), 2 (second MMC boot partition).
410506e4ae5fSStephen Warren
410606e4ae5fSStephen Warren	- CONFIG_ENV_OFFSET:
410706e4ae5fSStephen Warren	- CONFIG_ENV_SIZE:
410806e4ae5fSStephen Warren
410906e4ae5fSStephen Warren	  These two #defines specify the offset and size of the environment
411006e4ae5fSStephen Warren	  area within the specified MMC device.
411106e4ae5fSStephen Warren
41125c088ee8SStephen Warren	  If offset is positive (the usual case), it is treated as relative to
41135c088ee8SStephen Warren	  the start of the MMC partition. If offset is negative, it is treated
41145c088ee8SStephen Warren	  as relative to the end of the MMC partition. This can be useful if
41155c088ee8SStephen Warren	  your board may be fitted with different MMC devices, which have
41165c088ee8SStephen Warren	  different sizes for the MMC partitions, and you always want the
41175c088ee8SStephen Warren	  environment placed at the very end of the partition, to leave the
41185c088ee8SStephen Warren	  maximum possible space before it, to store other data.
41195c088ee8SStephen Warren
412006e4ae5fSStephen Warren	  These two values are in units of bytes, but must be aligned to an
412106e4ae5fSStephen Warren	  MMC sector boundary.
412206e4ae5fSStephen Warren
412306e4ae5fSStephen Warren	- CONFIG_ENV_OFFSET_REDUND (optional):
412406e4ae5fSStephen Warren
412506e4ae5fSStephen Warren	  Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
412606e4ae5fSStephen Warren	  hold a redundant copy of the environment data. This provides a
412706e4ae5fSStephen Warren	  valid backup copy in case the other copy is corrupted, e.g. due
412806e4ae5fSStephen Warren	  to a power failure during a "saveenv" operation.
412906e4ae5fSStephen Warren
41305c088ee8SStephen Warren	  This value may also be positive or negative; this is handled in the
41315c088ee8SStephen Warren	  same way as CONFIG_ENV_OFFSET.
41325c088ee8SStephen Warren
413306e4ae5fSStephen Warren	  This value is also in units of bytes, but must also be aligned to
413406e4ae5fSStephen Warren	  an MMC sector boundary.
413506e4ae5fSStephen Warren
413606e4ae5fSStephen Warren	- CONFIG_ENV_SIZE_REDUND (optional):
413706e4ae5fSStephen Warren
413806e4ae5fSStephen Warren	  This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
413906e4ae5fSStephen Warren	  set. If this value is set, it must be set to the same value as
414006e4ae5fSStephen Warren	  CONFIG_ENV_SIZE.
414106e4ae5fSStephen Warren
41426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET
4143c609719bSwdenk
4144c609719bSwdenk	Defines offset to the initial SPI buffer area in DPRAM. The
4145c609719bSwdenk	area is used at an early stage (ROM part) if the environment
4146c609719bSwdenk	is configured to reside in the SPI EEPROM: We need a 520 byte
4147c609719bSwdenk	scratch DPRAM area. It is used between the two initialization
4148c609719bSwdenk	calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4149c609719bSwdenk	to be a good choice since it makes it far enough from the
4150c609719bSwdenk	start of the data area as well as from the stack pointer.
4151c609719bSwdenk
4152e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor
4153c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been
4154cdb74977SWolfgang Denkcreated; also, when using EEPROM you will have to use getenv_f()
4155c609719bSwdenkuntil then to read environment variables.
4156c609719bSwdenk
415785ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor
415885ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working
415985ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is
416085ec0bccSwdenknecessary, because the first environment variable we need is the
416185ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't
416285ec0bccSwdenkhave any device yet where we could complain.]
4163c609719bSwdenk
4164c609719bSwdenkNote: once the monitor has been relocated, then it will complain if
4165c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you
416685ec0bccSwdenkuse the "saveenv" command to store a valid environment.
4167c609719bSwdenk
41686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
4169fc3e2165Swdenk		Echo the inverted Ethernet link state to the fault LED.
4170fc3e2165Swdenk
41716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
4172fc3e2165Swdenk		      also needs to be defined.
4173fc3e2165Swdenk
41746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR:
4175fc3e2165Swdenk		MII address of the PHY to check for the Ethernet link state.
4176c609719bSwdenk
4177f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS:
4178f5675aa5SRon Madrid		Define this if you desire to only have use of the NS16550_init
4179f5675aa5SRon Madrid		and NS16550_putc functions for the serial driver located at
4180f5675aa5SRon Madrid		drivers/serial/ns16550.c.  This option is useful for saving
4181f5675aa5SRon Madrid		space for already greatly restricted images, including but not
4182f5675aa5SRon Madrid		limited to NAND_SPL configurations.
4183f5675aa5SRon Madrid
4184b2b92f53SSimon Glass- CONFIG_DISPLAY_BOARDINFO
4185b2b92f53SSimon Glass		Display information about the board that U-Boot is running on
4186b2b92f53SSimon Glass		when U-Boot starts up. The board function checkboard() is called
4187b2b92f53SSimon Glass		to do this.
4188b2b92f53SSimon Glass
4189e2e3e2b1SSimon Glass- CONFIG_DISPLAY_BOARDINFO_LATE
4190e2e3e2b1SSimon Glass		Similar to the previous option, but display this information
4191e2e3e2b1SSimon Glass		later, once stdio is running and output goes to the LCD, if
4192e2e3e2b1SSimon Glass		present.
4193e2e3e2b1SSimon Glass
4194c609719bSwdenkLow Level (hardware related) configuration options:
4195dc7c9a1aSwdenk---------------------------------------------------
4196c609719bSwdenk
41976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE:
4198c609719bSwdenk		Cache Line Size of the CPU.
4199c609719bSwdenk
42006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR:
4201c609719bSwdenk		Default address of the IMMR after system reset.
42022535d602Swdenk
42032535d602Swdenk		Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
42042535d602Swdenk		and RPXsuper) to be able to adjust the position of
42052535d602Swdenk		the IMMR register after a reset.
4206c609719bSwdenk
4207e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_DEFAULT:
4208e46fedfeSTimur Tabi		Default (power-on reset) physical address of CCSR on Freescale
4209e46fedfeSTimur Tabi		PowerPC SOCs.
4210e46fedfeSTimur Tabi
4211e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR:
4212e46fedfeSTimur Tabi		Virtual address of CCSR.  On a 32-bit build, this is typically
4213e46fedfeSTimur Tabi		the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4214e46fedfeSTimur Tabi
4215e46fedfeSTimur Tabi		CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4216e46fedfeSTimur Tabi		for cross-platform code that uses that macro instead.
4217e46fedfeSTimur Tabi
4218e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS:
4219e46fedfeSTimur Tabi		Physical address of CCSR.  CCSR can be relocated to a new
4220e46fedfeSTimur Tabi		physical address, if desired.  In this case, this macro should
4221e46fedfeSTimur Tabi		be set to that address.	 Otherwise, it should be set to the
4222e46fedfeSTimur Tabi		same value as CONFIG_SYS_CCSRBAR_DEFAULT.  For example, CCSR
4223e46fedfeSTimur Tabi		is typically relocated on 36-bit builds.  It is recommended
4224e46fedfeSTimur Tabi		that this macro be defined via the _HIGH and _LOW macros:
4225e46fedfeSTimur Tabi
4226e46fedfeSTimur Tabi		#define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4227e46fedfeSTimur Tabi			* 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4228e46fedfeSTimur Tabi
4229e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
4230e46fedfeSTimur Tabi		Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS.	This value is typically
4231e46fedfeSTimur Tabi		either 0 (32-bit build) or 0xF (36-bit build).	This macro is
4232e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
4233e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
4234e46fedfeSTimur Tabi
4235e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4236e46fedfeSTimur Tabi		Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS.  This macro is
4237e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
4238e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
4239e46fedfeSTimur Tabi
4240e46fedfeSTimur Tabi- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4241e46fedfeSTimur Tabi		If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4242e46fedfeSTimur Tabi		forced to a value that ensures that CCSR is not relocated.
4243e46fedfeSTimur Tabi
42447f6c2cbcSwdenk- Floppy Disk Support:
42456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER
42467f6c2cbcSwdenk
42477f6c2cbcSwdenk		the default drive number (default value 0)
42487f6c2cbcSwdenk
42496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_STRIDE
42507f6c2cbcSwdenk
425111ccc33fSMarcel Ziswiler		defines the spacing between FDC chipset registers
42527f6c2cbcSwdenk		(default value 1)
42537f6c2cbcSwdenk
42546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_OFFSET
42557f6c2cbcSwdenk
42567f6c2cbcSwdenk		defines the offset of register from address. It
42577f6c2cbcSwdenk		depends on which part of the data bus is connected to
425811ccc33fSMarcel Ziswiler		the FDC chipset. (default value 0)
42597f6c2cbcSwdenk
42606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
42616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
42627f6c2cbcSwdenk		default value.
42637f6c2cbcSwdenk
42646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		if CONFIG_SYS_FDC_HW_INIT is defined, then the function
42657f6c2cbcSwdenk		fdc_hw_init() is called at the beginning of the FDC
42667f6c2cbcSwdenk		setup. fdc_hw_init() must be provided by the board
42677f6c2cbcSwdenk		source code. It is used to make hardware dependant
42687f6c2cbcSwdenk		initializations.
42697f6c2cbcSwdenk
42700abddf82SMacpaul Lin- CONFIG_IDE_AHB:
42710abddf82SMacpaul Lin		Most IDE controllers were designed to be connected with PCI
42720abddf82SMacpaul Lin		interface. Only few of them were designed for AHB interface.
42730abddf82SMacpaul Lin		When software is doing ATA command and data transfer to
42740abddf82SMacpaul Lin		IDE devices through IDE-AHB controller, some additional
42750abddf82SMacpaul Lin		registers accessing to these kind of IDE-AHB controller
42760abddf82SMacpaul Lin		is requierd.
42770abddf82SMacpaul Lin
42786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR:	Physical address of the Internal Memory.
427925d6712aSwdenk		DO NOT CHANGE unless you know exactly what you're
428025d6712aSwdenk		doing! (11-4) [MPC8xx/82xx systems only]
4281c609719bSwdenk
42826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR:
4283c609719bSwdenk
42847152b1d0Swdenk		Start address of memory area that can be used for
4285c609719bSwdenk		initial data and stack; please note that this must be
4286c609719bSwdenk		writable memory that is working WITHOUT special
4287c609719bSwdenk		initialization, i. e. you CANNOT use normal RAM which
4288c609719bSwdenk		will become available only after programming the
4289c609719bSwdenk		memory controller and running certain initialization
4290c609719bSwdenk		sequences.
4291c609719bSwdenk
4292c609719bSwdenk		U-Boot uses the following memory types:
4293c609719bSwdenk		- MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4294c609719bSwdenk		- MPC824X: data cache
4295c609719bSwdenk		- PPC4xx:  data cache
4296c609719bSwdenk
42976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET:
4298c609719bSwdenk
4299c609719bSwdenk		Offset of the initial data structure in the memory
43006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
43016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
4302c609719bSwdenk		data is located at the end of the available space
4303553f0982SWolfgang Denk		(sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
43046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
43056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
43066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET) downward.
4307c609719bSwdenk
4308c609719bSwdenk	Note:
4309c609719bSwdenk		On the MPC824X (or other systems that use the data
4310c609719bSwdenk		cache for initial memory) the address chosen for
43116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
4312c609719bSwdenk		point to an otherwise UNUSED address space between
4313c609719bSwdenk		the top of RAM and the start of the PCI space.
4314c609719bSwdenk
43156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR:	SIU Module Configuration (11-6)
4316c609719bSwdenk
43176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR:	System Protection Control (11-9)
4318c609719bSwdenk
43196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR:	Time Base Status and Control (11-26)
4320c609719bSwdenk
43216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR:	Periodic Interrupt Status and Control (11-31)
4322c609719bSwdenk
43236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR:	PLL, Low-Power, and Reset Control Register (15-30)
4324c609719bSwdenk
43256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR:	System Clock and reset Control Register (15-27)
4326c609719bSwdenk
43276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM:
4328c609719bSwdenk		SDRAM timing
4329c609719bSwdenk
43306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA:
4331c609719bSwdenk		periodic timer for refresh
4332c609719bSwdenk
43336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER:	Debug Event Register (37-47)
4334c609719bSwdenk
43356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
43366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
43376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
43386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_BR1_PRELIM:
4339c609719bSwdenk		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4340c609719bSwdenk
4341c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
43426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
43436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
4344c609719bSwdenk		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4345c609719bSwdenk
43466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
43476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
4348c609719bSwdenk		Machine Mode Register and Memory Periodic Timer
4349c609719bSwdenk		Prescaler definitions (SDRAM timing)
4350c609719bSwdenk
43516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
4352c609719bSwdenk		enable I2C microcode relocation patch (MPC8xx);
4353c609719bSwdenk		define relocation offset in DPRAM [DSP2]
4354c609719bSwdenk
43556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
4356b423d055SHeiko Schocher		enable SMC microcode relocation patch (MPC8xx);
4357b423d055SHeiko Schocher		define relocation offset in DPRAM [SMC1]
4358b423d055SHeiko Schocher
43596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
4360c609719bSwdenk		enable SPI microcode relocation patch (MPC8xx);
4361c609719bSwdenk		define relocation offset in DPRAM [SCC4]
4362c609719bSwdenk
43636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_USE_OSCCLK:
4364c609719bSwdenk		Use OSCM clock mode on MBX8xx board. Be careful,
4365c609719bSwdenk		wrong setting might damage your board. Read
4366c609719bSwdenk		doc/README.MBX before setting this variable!
4367c609719bSwdenk
43686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
4369ea909b76Swdenk		Offset of the bootmode word in DPRAM used by post
4370ea909b76Swdenk		(Power On Self Tests). This definition overrides
4371ea909b76Swdenk		#define'd default value in commproc.h resp.
4372ea909b76Swdenk		cpm_8260.h.
4373ea909b76Swdenk
43746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
43756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
43766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
43776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
43786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
43796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
43806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
43816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
4382a47a12beSStefan Roese		Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
43835d232d0eSwdenk
43849cacf4fcSDirk Eibach- CONFIG_PCI_DISABLE_PCIE:
43859cacf4fcSDirk Eibach		Disable PCI-Express on systems where it is supported but not
43869cacf4fcSDirk Eibach		required.
43879cacf4fcSDirk Eibach
438869fd2d3bSAndrew Sharp- CONFIG_PCI_ENUM_ONLY
438969fd2d3bSAndrew Sharp		Only scan through and get the devices on the busses.
439069fd2d3bSAndrew Sharp		Don't do any setup work, presumably because someone or
439169fd2d3bSAndrew Sharp		something has already done it, and we don't need to do it
439269fd2d3bSAndrew Sharp		a second time.	Useful for platforms that are pre-booted
439369fd2d3bSAndrew Sharp		by coreboot or similar.
439469fd2d3bSAndrew Sharp
4395842033e6SGabor Juhos- CONFIG_PCI_INDIRECT_BRIDGE:
4396842033e6SGabor Juhos		Enable support for indirect PCI bridges.
4397842033e6SGabor Juhos
4398a09b9b68SKumar Gala- CONFIG_SYS_SRIO:
4399a09b9b68SKumar Gala		Chip has SRIO or not
4400a09b9b68SKumar Gala
4401a09b9b68SKumar Gala- CONFIG_SRIO1:
4402a09b9b68SKumar Gala		Board has SRIO 1 port available
4403a09b9b68SKumar Gala
4404a09b9b68SKumar Gala- CONFIG_SRIO2:
4405a09b9b68SKumar Gala		Board has SRIO 2 port available
4406a09b9b68SKumar Gala
4407c8b28152SLiu Gang- CONFIG_SRIO_PCIE_BOOT_MASTER
4408c8b28152SLiu Gang		Board can support master function for Boot from SRIO and PCIE
4409c8b28152SLiu Gang
4410a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_VIRT:
4411a09b9b68SKumar Gala		Virtual Address of SRIO port 'n' memory region
4412a09b9b68SKumar Gala
4413a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_PHYS:
4414a09b9b68SKumar Gala		Physical Address of SRIO port 'n' memory region
4415a09b9b68SKumar Gala
4416a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_SIZE:
4417a09b9b68SKumar Gala		Size of SRIO port 'n' memory region
4418a09b9b68SKumar Gala
441966bd1846SFabio Estevam- CONFIG_SYS_NAND_BUSWIDTH_16BIT
442066bd1846SFabio Estevam		Defined to tell the NAND controller that the NAND chip is using
442166bd1846SFabio Estevam		a 16 bit bus.
442266bd1846SFabio Estevam		Not all NAND drivers use this symbol.
4423a430e916SFabio Estevam		Example of drivers that use it:
442466bd1846SFabio Estevam		- drivers/mtd/nand/ndfc.c
4425a430e916SFabio Estevam		- drivers/mtd/nand/mxc_nand.c
4426eced4626SAlex Waterman
4427eced4626SAlex Waterman- CONFIG_SYS_NDFC_EBC0_CFG
4428eced4626SAlex Waterman		Sets the EBC0_CFG register for the NDFC. If not defined
4429eced4626SAlex Waterman		a default value will be used.
4430eced4626SAlex Waterman
4431bb99ad6dSBen Warren- CONFIG_SPD_EEPROM
4432218ca724SWolfgang Denk		Get DDR timing information from an I2C EEPROM. Common
4433218ca724SWolfgang Denk		with pluggable memory modules such as SODIMMs
4434218ca724SWolfgang Denk
4435bb99ad6dSBen Warren  SPD_EEPROM_ADDRESS
4436bb99ad6dSBen Warren		I2C address of the SPD EEPROM
4437bb99ad6dSBen Warren
44386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM
4439218ca724SWolfgang Denk		If SPD EEPROM is on an I2C bus other than the first
4440218ca724SWolfgang Denk		one, specify here. Note that the value must resolve
4441218ca724SWolfgang Denk		to something your driver can deal with.
4442bb99ad6dSBen Warren
44431b3e3c4fSYork Sun- CONFIG_SYS_DDR_RAW_TIMING
44441b3e3c4fSYork Sun		Get DDR timing information from other than SPD. Common with
44451b3e3c4fSYork Sun		soldered DDR chips onboard without SPD. DDR raw timing
44461b3e3c4fSYork Sun		parameters are extracted from datasheet and hard-coded into
44471b3e3c4fSYork Sun		header files or board specific files.
44481b3e3c4fSYork Sun
44496f5e1dc5SYork Sun- CONFIG_FSL_DDR_INTERACTIVE
44506f5e1dc5SYork Sun		Enable interactive DDR debugging. See doc/README.fsl-ddr.
44516f5e1dc5SYork Sun
44526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0
4453218ca724SWolfgang Denk		Only for 83xx systems. If specified, then DDR should
4454218ca724SWolfgang Denk		be configured using CS0 and CS1 instead of CS2 and CS3.
44552ad6b513STimur Tabi
4456c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12]
4457c26e454dSwdenk		Define to enable FEC[12] on a 8xx series processor.
4458c26e454dSwdenk
4459c26e454dSwdenk- CONFIG_FEC[12]_PHY
4460c26e454dSwdenk		Define to the hardcoded PHY address which corresponds
44616e592385Swdenk		to the given FEC; i. e.
4462c26e454dSwdenk			#define CONFIG_FEC1_PHY 4
4463c26e454dSwdenk		means that the PHY with address 4 is connected to FEC1
4464c26e454dSwdenk
4465c26e454dSwdenk		When set to -1, means to probe for first available.
4466c26e454dSwdenk
4467c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR
4468c26e454dSwdenk		The PHY does not have a RXERR line (RMII only).
4469c26e454dSwdenk		(so program the FEC to ignore it).
4470c26e454dSwdenk
4471c26e454dSwdenk- CONFIG_RMII
4472c26e454dSwdenk		Enable RMII mode for all FECs.
4473c26e454dSwdenk		Note that this is a global option, we can't
4474c26e454dSwdenk		have one FEC in standard MII mode and another in RMII mode.
4475c26e454dSwdenk
44765cf91d6bSwdenk- CONFIG_CRC32_VERIFY
44775cf91d6bSwdenk		Add a verify option to the crc32 command.
44785cf91d6bSwdenk		The syntax is:
44795cf91d6bSwdenk
44805cf91d6bSwdenk		=> crc32 -v <address> <count> <crc32>
44815cf91d6bSwdenk
44825cf91d6bSwdenk		Where address/count indicate a memory area
44835cf91d6bSwdenk		and crc32 is the correct crc32 which the
44845cf91d6bSwdenk		area should have.
44855cf91d6bSwdenk
448656523f12Swdenk- CONFIG_LOOPW
448756523f12Swdenk		Add the "loopw" memory command. This only takes effect if
4488602ad3b3SJon Loeliger		the memory commands are activated globally (CONFIG_CMD_MEM).
448956523f12Swdenk
44907b466641Sstroese- CONFIG_MX_CYCLIC
44917b466641Sstroese		Add the "mdc" and "mwc" memory commands. These are cyclic
44927b466641Sstroese		"md/mw" commands.
44937b466641Sstroese		Examples:
44947b466641Sstroese
44957b466641Sstroese		=> mdc.b 10 4 500
44967b466641Sstroese		This command will print 4 bytes (10,11,12,13) each 500 ms.
44977b466641Sstroese
44987b466641Sstroese		=> mwc.l 100 12345678 10
44997b466641Sstroese		This command will write 12345678 to address 100 all 10 ms.
45007b466641Sstroese
45017b466641Sstroese		This only takes effect if the memory commands are activated
4502602ad3b3SJon Loeliger		globally (CONFIG_CMD_MEM).
45037b466641Sstroese
45048aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT
4505afc1ce82SMacpaul Lin		[ARM, NDS32, MIPS only] If this variable is defined, then certain
4506e03f3169SWolfgang Denk		low level initializations (like setting up the memory
4507e03f3169SWolfgang Denk		controller) are omitted and/or U-Boot does not
4508e03f3169SWolfgang Denk		relocate itself into RAM.
45098aa1a2d1Swdenk
4510e03f3169SWolfgang Denk		Normally this variable MUST NOT be defined. The only
4511e03f3169SWolfgang Denk		exception is when U-Boot is loaded (to RAM) by some
4512e03f3169SWolfgang Denk		other boot loader or by a debugger which performs
4513e03f3169SWolfgang Denk		these initializations itself.
45148aa1a2d1Swdenk
4515401bb30bSAneesh V- CONFIG_SPL_BUILD
4516df81238bSMagnus Lilja		Modifies the behaviour of start.S when compiling a loader
4517df81238bSMagnus Lilja		that is executed before the actual U-Boot. E.g. when
4518df81238bSMagnus Lilja		compiling a NAND SPL.
4519400558b5Swdenk
45203aa29de0SYing Zhang- CONFIG_TPL_BUILD
45213aa29de0SYing Zhang		Modifies the behaviour of start.S  when compiling a loader
45223aa29de0SYing Zhang		that is executed after the SPL and before the actual U-Boot.
45233aa29de0SYing Zhang		It is loaded by the SPL.
45243aa29de0SYing Zhang
45255df572f0SYing Zhang- CONFIG_SYS_MPC85XX_NO_RESETVEC
45265df572f0SYing Zhang		Only for 85xx systems. If this variable is specified, the section
45275df572f0SYing Zhang		.resetvec is not kept and the section .bootpg is placed in the
45285df572f0SYing Zhang		previous 4k of the .text section.
45295df572f0SYing Zhang
45304213fc29SSimon Glass- CONFIG_ARCH_MAP_SYSMEM
45314213fc29SSimon Glass		Generally U-Boot (and in particular the md command) uses
45324213fc29SSimon Glass		effective address. It is therefore not necessary to regard
45334213fc29SSimon Glass		U-Boot address as virtual addresses that need to be translated
45344213fc29SSimon Glass		to physical addresses. However, sandbox requires this, since
45354213fc29SSimon Glass		it maintains its own little RAM buffer which contains all
45364213fc29SSimon Glass		addressable memory. This option causes some memory accesses
45374213fc29SSimon Glass		to be mapped through map_sysmem() / unmap_sysmem().
45384213fc29SSimon Glass
4539d8834a13SMatthias Weisser- CONFIG_USE_ARCH_MEMCPY
4540d8834a13SMatthias Weisser  CONFIG_USE_ARCH_MEMSET
4541d8834a13SMatthias Weisser		If these options are used a optimized version of memcpy/memset will
4542d8834a13SMatthias Weisser		be used if available. These functions may be faster under some
4543d8834a13SMatthias Weisser		conditions but may increase the binary size.
4544d8834a13SMatthias Weisser
4545588a13f7SSimon Glass- CONFIG_X86_RESET_VECTOR
4546588a13f7SSimon Glass		If defined, the x86 reset vector code is included. This is not
4547588a13f7SSimon Glass		needed when U-Boot is running from Coreboot.
4548b16f521aSGabe Black
4549fc33705eSMark Jackson- CONFIG_SYS_MPUCLK
4550fc33705eSMark Jackson		Defines the MPU clock speed (in MHz).
4551fc33705eSMark Jackson
4552fc33705eSMark Jackson		NOTE : currently only supported on AM335x platforms.
45535b5ece9eSGabe Black
455416678eb4SHeiko Schocher- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
455516678eb4SHeiko Schocher		Enables the RTC32K OSC on AM33xx based plattforms
455616678eb4SHeiko Schocher
4557999d7d32SKaricheri, Muralidharan- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
4558999d7d32SKaricheri, Muralidharan		Option to disable subpage write in NAND driver
4559999d7d32SKaricheri, Muralidharan		driver that uses this:
4560999d7d32SKaricheri, Muralidharan		drivers/mtd/nand/davinci_nand.c
4561999d7d32SKaricheri, Muralidharan
4562f2717b47STimur TabiFreescale QE/FMAN Firmware Support:
4563f2717b47STimur Tabi-----------------------------------
4564f2717b47STimur Tabi
4565f2717b47STimur TabiThe Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4566f2717b47STimur Tabiloading of "firmware", which is encoded in the QE firmware binary format.
4567f2717b47STimur TabiThis firmware often needs to be loaded during U-Boot booting, so macros
4568f2717b47STimur Tabiare used to identify the storage device (NOR flash, SPI, etc) and the address
4569f2717b47STimur Tabiwithin that device.
4570f2717b47STimur Tabi
4571dcf1d774SZhao Qiang- CONFIG_SYS_FMAN_FW_ADDR
4572dcf1d774SZhao Qiang	The address in the storage device where the FMAN microcode is located.  The
4573dcf1d774SZhao Qiang	meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4574dcf1d774SZhao Qiang	is also specified.
4575dcf1d774SZhao Qiang
4576dcf1d774SZhao Qiang- CONFIG_SYS_QE_FW_ADDR
4577dcf1d774SZhao Qiang	The address in the storage device where the QE microcode is located.  The
4578f2717b47STimur Tabi	meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4579f2717b47STimur Tabi	is also specified.
4580f2717b47STimur Tabi
4581f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_LENGTH
4582f2717b47STimur Tabi	The maximum possible size of the firmware.  The firmware binary format
4583f2717b47STimur Tabi	has a field that specifies the actual size of the firmware, but it
4584f2717b47STimur Tabi	might not be possible to read any part of the firmware unless some
4585f2717b47STimur Tabi	local storage is allocated to hold the entire firmware first.
4586f2717b47STimur Tabi
4587f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4588f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4589f2717b47STimur Tabi	normal addressable memory via the LBC.  CONFIG_SYS_FMAN_FW_ADDR is the
4590f2717b47STimur Tabi	virtual address in NOR flash.
4591f2717b47STimur Tabi
4592f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4593f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NAND flash.
4594f2717b47STimur Tabi	CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4595f2717b47STimur Tabi
4596f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4597f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SD/MMC
4598f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4599f2717b47STimur Tabi
4600f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
4601f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SPI
4602f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4603f2717b47STimur Tabi
4604292dc6c5SLiu Gang- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4605292dc6c5SLiu Gang	Specifies that QE/FMAN firmware is located in the remote (master)
4606292dc6c5SLiu Gang	memory space.	CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
4607fc54c7faSLiu Gang	can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4608fc54c7faSLiu Gang	window->master inbound window->master LAW->the ucode address in
4609fc54c7faSLiu Gang	master's memory space.
4610f2717b47STimur Tabi
4611c609719bSwdenkBuilding the Software:
4612c609719bSwdenk======================
4613c609719bSwdenk
4614218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments
4615218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support
4616218ca724SWolfgang Denkall possibly existing versions of cross development tools in all
4617218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we
4618218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4619218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot.
4620c609719bSwdenk
4621218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you
4622218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case,
4623218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell.
4624218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are
4625218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter:
4626c609719bSwdenk
4627218ca724SWolfgang Denk	$ CROSS_COMPILE=ppc_4xx-
4628218ca724SWolfgang Denk	$ export CROSS_COMPILE
4629c609719bSwdenk
46302f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in
46312f8d396bSPeter Tyser      the tools directory you can use the MinGW toolchain
46322f8d396bSPeter Tyser      (http://www.mingw.org).  Set your HOST tools to the MinGW
46332f8d396bSPeter Tyser      toolchain and execute 'make tools'.  For example:
46342f8d396bSPeter Tyser
46352f8d396bSPeter Tyser       $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
46362f8d396bSPeter Tyser
46372f8d396bSPeter Tyser      Binaries such as tools/mkimage.exe will be created which can
46382f8d396bSPeter Tyser      be executed on computers running Windows.
46392f8d396bSPeter Tyser
4640c609719bSwdenkU-Boot is intended to be simple to build. After installing the
4641c609719bSwdenksources you must configure U-Boot for one specific board type. This
4642c609719bSwdenkis done by typing:
4643c609719bSwdenk
4644c609719bSwdenk	make NAME_config
4645c609719bSwdenk
4646218ca724SWolfgang Denkwhere "NAME_config" is the name of one of the existing configu-
46474d675ae6SMichael Jonesrations; see boards.cfg for supported names.
464854387ac9Swdenk
4649c609719bSwdenkNote: for some board special configuration names may exist; check if
4650c609719bSwdenk      additional information is available from the board vendor; for
46512729af9dSwdenk      instance, the TQM823L systems are available without (standard)
46522729af9dSwdenk      or with LCD support. You can select such additional "features"
465311ccc33fSMarcel Ziswiler      when choosing the configuration, i. e.
4654c609719bSwdenk
46552729af9dSwdenk      make TQM823L_config
46562729af9dSwdenk	- will configure for a plain TQM823L, i. e. no LCD support
4657c609719bSwdenk
4658c609719bSwdenk      make TQM823L_LCD_config
4659c609719bSwdenk	- will configure for a TQM823L with U-Boot console on LCD
4660c609719bSwdenk
4661c609719bSwdenk      etc.
4662c609719bSwdenk
4663c609719bSwdenk
4664c609719bSwdenkFinally, type "make all", and you should get some working U-Boot
46657152b1d0Swdenkimages ready for download to / installation on your system:
4666c609719bSwdenk
4667c609719bSwdenk- "u-boot.bin" is a raw binary image
4668c609719bSwdenk- "u-boot" is an image in ELF binary format
4669c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format
4670c609719bSwdenk
4671baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved
4672baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change
4673baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory:
4674baf31249SMarian Balakowicz
4675baf31249SMarian Balakowicz1. Add O= to the make command line invocations:
4676baf31249SMarian Balakowicz
4677baf31249SMarian Balakowicz	make O=/tmp/build distclean
4678baf31249SMarian Balakowicz	make O=/tmp/build NAME_config
4679baf31249SMarian Balakowicz	make O=/tmp/build all
4680baf31249SMarian Balakowicz
4681baf31249SMarian Balakowicz2. Set environment variable BUILD_DIR to point to the desired location:
4682baf31249SMarian Balakowicz
4683baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
4684baf31249SMarian Balakowicz	make distclean
4685baf31249SMarian Balakowicz	make NAME_config
4686baf31249SMarian Balakowicz	make all
4687baf31249SMarian Balakowicz
4688baf31249SMarian BalakowiczNote that the command line "O=" setting overrides the BUILD_DIR environment
4689baf31249SMarian Balakowiczvariable.
4690baf31249SMarian Balakowicz
4691c609719bSwdenk
4692c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so
4693c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of
4694c609719bSwdenknative "make".
4695c609719bSwdenk
4696c609719bSwdenk
4697c609719bSwdenkIf the system board that you have is not listed, then you will need
4698c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these
4699c609719bSwdenksteps:
4700c609719bSwdenk
4701c609719bSwdenk1.  Add a new configuration option for your board to the toplevel
47024d675ae6SMichael Jones    "boards.cfg" file, using the existing entries as examples.
47034d675ae6SMichael Jones    Follow the instructions there to keep the boards in order.
4704c609719bSwdenk2.  Create a new directory to hold your board specific code. Add any
470585ec0bccSwdenk    files you need. In your board directory, you will need at least
470685ec0bccSwdenk    the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
470785ec0bccSwdenk3.  Create a new configuration file "include/configs/<board>.h" for
470885ec0bccSwdenk    your board
4709c609719bSwdenk3.  If you're porting U-Boot to a new CPU, then also create a new
4710c609719bSwdenk    directory to hold your CPU specific code. Add any files you need.
471185ec0bccSwdenk4.  Run "make <board>_config" with your new name.
4712c609719bSwdenk5.  Type "make", and you should get a working "u-boot.srec" file
4713c609719bSwdenk    to be installed on your target system.
471485ec0bccSwdenk6.  Debug and solve any problems that might arise.
4715c609719bSwdenk    [Of course, this last step is much harder than it sounds.]
4716c609719bSwdenk
4717c609719bSwdenk
4718c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.:
4719c609719bSwdenk==============================================================
4720c609719bSwdenk
4721c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board
4722c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to
4723c609719bSwdenkprovide feedback to the other developers. The feedback normally takes
4724c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest
4725218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources.
4726c609719bSwdenk
4727c609719bSwdenkBut before you submit such a patch, please verify that your modifi-
4728c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of
4729c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so,
4730c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot
4731c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You can
47327152b1d0Swdenkselect which (cross) compiler to use by passing a `CROSS_COMPILE'
4733218ca724SWolfgang Denkenvironment variable to the script, i. e. to use the ELDK cross tools
4734218ca724SWolfgang Denkyou can type
4735c609719bSwdenk
4736c609719bSwdenk	CROSS_COMPILE=ppc_8xx- MAKEALL
4737c609719bSwdenk
4738c609719bSwdenkor to build on a native PowerPC system you can type
4739c609719bSwdenk
4740c609719bSwdenk	CROSS_COMPILE=' ' MAKEALL
4741c609719bSwdenk
4742218ca724SWolfgang DenkWhen using the MAKEALL script, the default behaviour is to build
4743218ca724SWolfgang DenkU-Boot in the source directory. This location can be changed by
4744218ca724SWolfgang Denksetting the BUILD_DIR environment variable. Also, for each target
4745218ca724SWolfgang Denkbuilt, the MAKEALL script saves two log files (<target>.ERR and
4746218ca724SWolfgang Denk<target>.MAKEALL) in the <source dir>/LOG directory. This default
4747218ca724SWolfgang Denklocation can be changed by setting the MAKEALL_LOGDIR environment
4748218ca724SWolfgang Denkvariable. For example:
4749baf31249SMarian Balakowicz
4750baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
4751baf31249SMarian Balakowicz	export MAKEALL_LOGDIR=/tmp/log
4752baf31249SMarian Balakowicz	CROSS_COMPILE=ppc_8xx- MAKEALL
4753baf31249SMarian Balakowicz
4754218ca724SWolfgang DenkWith the above settings build objects are saved in the /tmp/build,
4755218ca724SWolfgang Denklog files are saved in the /tmp/log and the source tree remains clean
4756218ca724SWolfgang Denkduring the whole build process.
4757baf31249SMarian Balakowicz
4758baf31249SMarian Balakowicz
4759c609719bSwdenkSee also "U-Boot Porting Guide" below.
4760c609719bSwdenk
4761c609719bSwdenk
4762c609719bSwdenkMonitor Commands - Overview:
4763c609719bSwdenk============================
4764c609719bSwdenk
4765c609719bSwdenkgo	- start application at address 'addr'
4766c609719bSwdenkrun	- run commands in an environment variable
4767c609719bSwdenkbootm	- boot application image from memory
4768c609719bSwdenkbootp	- boot image via network using BootP/TFTP protocol
476944f074c7SMarek Vasutbootz   - boot zImage from memory
4770c609719bSwdenktftpboot- boot image via network using TFTP protocol
4771c609719bSwdenk	       and env variables "ipaddr" and "serverip"
4772c609719bSwdenk	       (and eventually "gatewayip")
47731fb7cd49SSimon Glasstftpput - upload a file via network using TFTP protocol
4774c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol
4775c609719bSwdenkdiskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
4776c609719bSwdenkloads	- load S-Record file over serial line
4777c609719bSwdenkloadb	- load binary file over serial line (kermit mode)
4778c609719bSwdenkmd	- memory display
4779c609719bSwdenkmm	- memory modify (auto-incrementing)
4780c609719bSwdenknm	- memory modify (constant address)
4781c609719bSwdenkmw	- memory write (fill)
4782c609719bSwdenkcp	- memory copy
4783c609719bSwdenkcmp	- memory compare
4784c609719bSwdenkcrc32	- checksum calculation
47850f89c54bSPeter Tyseri2c	- I2C sub-system
4786c609719bSwdenksspi	- SPI utility commands
4787c609719bSwdenkbase	- print or set address offset
4788c609719bSwdenkprintenv- print environment variables
4789c609719bSwdenksetenv	- set environment variables
4790c609719bSwdenksaveenv - save environment variables to persistent storage
4791c609719bSwdenkprotect - enable or disable FLASH write protection
4792c609719bSwdenkerase	- erase FLASH memory
4793c609719bSwdenkflinfo	- print FLASH memory information
479410635afaSKarl O. Pincnand	- NAND memory operations (see doc/README.nand)
4795c609719bSwdenkbdinfo	- print Board Info structure
4796c609719bSwdenkiminfo	- print header information for application image
4797c609719bSwdenkconinfo - print console devices and informations
4798c609719bSwdenkide	- IDE sub-system
4799c609719bSwdenkloop	- infinite loop on address range
480056523f12Swdenkloopw	- infinite write loop on address range
4801c609719bSwdenkmtest	- simple RAM test
4802c609719bSwdenkicache	- enable or disable instruction cache
4803c609719bSwdenkdcache	- enable or disable data cache
4804c609719bSwdenkreset	- Perform RESET of the CPU
4805c609719bSwdenkecho	- echo args to console
4806c609719bSwdenkversion - print monitor version
4807c609719bSwdenkhelp	- print online help
4808c609719bSwdenk?	- alias for 'help'
4809c609719bSwdenk
4810c609719bSwdenk
4811c609719bSwdenkMonitor Commands - Detailed Description:
4812c609719bSwdenk========================================
4813c609719bSwdenk
4814c609719bSwdenkTODO.
4815c609719bSwdenk
4816c609719bSwdenkFor now: just type "help <command>".
4817c609719bSwdenk
4818c609719bSwdenk
4819c609719bSwdenkEnvironment Variables:
4820c609719bSwdenk======================
4821c609719bSwdenk
4822c609719bSwdenkU-Boot supports user configuration using Environment Variables which
4823c609719bSwdenkcan be made persistent by saving to Flash memory.
4824c609719bSwdenk
4825c609719bSwdenkEnvironment Variables are set using "setenv", printed using
4826c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv"
4827c609719bSwdenkwithout a value can be used to delete a variable from the
4828c609719bSwdenkenvironment. As long as you don't save the environment you are
4829c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the
4830c609719bSwdenkenvironment is erased by accident, a default environment is provided.
4831c609719bSwdenk
4832c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables.
4833c96f86eeSWolfgang Denk
4834c96f86eeSWolfgang DenkList of environment variables (most likely not complete):
4835c609719bSwdenk
4836c609719bSwdenk  baudrate	- see CONFIG_BAUDRATE
4837c609719bSwdenk
4838c609719bSwdenk  bootdelay	- see CONFIG_BOOTDELAY
4839c609719bSwdenk
4840c609719bSwdenk  bootcmd	- see CONFIG_BOOTCOMMAND
4841c609719bSwdenk
4842c609719bSwdenk  bootargs	- Boot arguments when booting an RTOS image
4843c609719bSwdenk
4844c609719bSwdenk  bootfile	- Name of the image to load with TFTP
4845c609719bSwdenk
48467d721e34SBartlomiej Sieka  bootm_low	- Memory range available for image processing in the bootm
48477d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
48487d721e34SBartlomiej Sieka		  a hexadecimal number and defines lowest address allowed
48497d721e34SBartlomiej Sieka		  for use by the bootm command. See also "bootm_size"
48507d721e34SBartlomiej Sieka		  environment variable. Address defined by "bootm_low" is
48517d721e34SBartlomiej Sieka		  also the base of the initial memory mapping for the Linux
4852c3624e6eSGrant Likely		  kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4853c3624e6eSGrant Likely		  bootm_mapsize.
4854c3624e6eSGrant Likely
4855c3624e6eSGrant Likely  bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
4856c3624e6eSGrant Likely		  This variable is given as a hexadecimal number and it
4857c3624e6eSGrant Likely		  defines the size of the memory region starting at base
4858c3624e6eSGrant Likely		  address bootm_low that is accessible by the Linux kernel
4859c3624e6eSGrant Likely		  during early boot.  If unset, CONFIG_SYS_BOOTMAPSZ is used
4860c3624e6eSGrant Likely		  as the default value if it is defined, and bootm_size is
4861c3624e6eSGrant Likely		  used otherwise.
48627d721e34SBartlomiej Sieka
48637d721e34SBartlomiej Sieka  bootm_size	- Memory range available for image processing in the bootm
48647d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
48657d721e34SBartlomiej Sieka		  a hexadecimal number and defines the size of the region
48667d721e34SBartlomiej Sieka		  allowed for use by the bootm command. See also "bootm_low"
48677d721e34SBartlomiej Sieka		  environment variable.
48687d721e34SBartlomiej Sieka
48694bae9090SBartlomiej Sieka  updatefile	- Location of the software update file on a TFTP server, used
48704bae9090SBartlomiej Sieka		  by the automatic software update feature. Please refer to
48714bae9090SBartlomiej Sieka		  documentation in doc/README.update for more details.
48724bae9090SBartlomiej Sieka
4873c609719bSwdenk  autoload	- if set to "no" (any string beginning with 'n'),
4874c609719bSwdenk		  "bootp" will just load perform a lookup of the
4875c609719bSwdenk		  configuration from the BOOTP server, but not try to
4876c609719bSwdenk		  load any image using TFTP
4877c609719bSwdenk
4878c609719bSwdenk  autostart	- if set to "yes", an image loaded using the "bootp",
4879c609719bSwdenk		  "rarpboot", "tftpboot" or "diskboot" commands will
4880c609719bSwdenk		  be automatically started (by internally calling
4881c609719bSwdenk		  "bootm")
4882c609719bSwdenk
48834a6fd34bSwdenk		  If set to "no", a standalone image passed to the
48844a6fd34bSwdenk		  "bootm" command will be copied to the load address
48854a6fd34bSwdenk		  (and eventually uncompressed), but NOT be started.
48864a6fd34bSwdenk		  This can be used to load and uncompress arbitrary
48874a6fd34bSwdenk		  data.
48884a6fd34bSwdenk
4889a28afca5SDavid A. Long  fdt_high	- if set this restricts the maximum address that the
4890a28afca5SDavid A. Long		  flattened device tree will be copied into upon boot.
4891fa34f6b2SShawn Guo		  For example, if you have a system with 1 GB memory
4892fa34f6b2SShawn Guo		  at physical address 0x10000000, while Linux kernel
4893fa34f6b2SShawn Guo		  only recognizes the first 704 MB as low memory, you
4894fa34f6b2SShawn Guo		  may need to set fdt_high as 0x3C000000 to have the
4895fa34f6b2SShawn Guo		  device tree blob be copied to the maximum address
4896fa34f6b2SShawn Guo		  of the 704 MB low memory, so that Linux kernel can
4897fa34f6b2SShawn Guo		  access it during the boot procedure.
4898fa34f6b2SShawn Guo
4899a28afca5SDavid A. Long		  If this is set to the special value 0xFFFFFFFF then
4900a28afca5SDavid A. Long		  the fdt will not be copied at all on boot.  For this
4901a28afca5SDavid A. Long		  to work it must reside in writable memory, have
4902a28afca5SDavid A. Long		  sufficient padding on the end of it for u-boot to
4903a28afca5SDavid A. Long		  add the information it needs into it, and the memory
4904a28afca5SDavid A. Long		  must be accessible by the kernel.
4905a28afca5SDavid A. Long
4906eea63e05SSimon Glass  fdtcontroladdr- if set this is the address of the control flattened
4907eea63e05SSimon Glass		  device tree used by U-Boot when CONFIG_OF_CONTROL is
4908eea63e05SSimon Glass		  defined.
4909eea63e05SSimon Glass
491017ea1177Swdenk  i2cfast	- (PPC405GP|PPC405EP only)
491117ea1177Swdenk		  if set to 'y' configures Linux I2C driver for fast
491217ea1177Swdenk		  mode (400kHZ). This environment variable is used in
491317ea1177Swdenk		  initialization code. So, for changes to be effective
491417ea1177Swdenk		  it must be saved and board must be reset.
491517ea1177Swdenk
4916c609719bSwdenk  initrd_high	- restrict positioning of initrd images:
4917c609719bSwdenk		  If this variable is not set, initrd images will be
4918c609719bSwdenk		  copied to the highest possible address in RAM; this
4919c609719bSwdenk		  is usually what you want since it allows for
4920c609719bSwdenk		  maximum initrd size. If for some reason you want to
4921c609719bSwdenk		  make sure that the initrd image is loaded below the
49226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		  CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
4923c609719bSwdenk		  variable to a value of "no" or "off" or "0".
4924c609719bSwdenk		  Alternatively, you can set it to a maximum upper
4925c609719bSwdenk		  address to use (U-Boot will still check that it
4926c609719bSwdenk		  does not overwrite the U-Boot stack and data).
4927c609719bSwdenk
4928c609719bSwdenk		  For instance, when you have a system with 16 MB
49297152b1d0Swdenk		  RAM, and want to reserve 4 MB from use by Linux,
4930c609719bSwdenk		  you can do this by adding "mem=12M" to the value of
4931c609719bSwdenk		  the "bootargs" variable. However, now you must make
49327152b1d0Swdenk		  sure that the initrd image is placed in the first
4933c609719bSwdenk		  12 MB as well - this can be done with
4934c609719bSwdenk
4935c609719bSwdenk		  setenv initrd_high 00c00000
4936c609719bSwdenk
493738b99261Swdenk		  If you set initrd_high to 0xFFFFFFFF, this is an
493838b99261Swdenk		  indication to U-Boot that all addresses are legal
493938b99261Swdenk		  for the Linux kernel, including addresses in flash
494038b99261Swdenk		  memory. In this case U-Boot will NOT COPY the
494138b99261Swdenk		  ramdisk at all. This may be useful to reduce the
494238b99261Swdenk		  boot time on your system, but requires that this
494338b99261Swdenk		  feature is supported by your Linux kernel.
494438b99261Swdenk
4945c609719bSwdenk  ipaddr	- IP address; needed for tftpboot command
4946c609719bSwdenk
4947c609719bSwdenk  loadaddr	- Default load address for commands like "bootp",
4948dc7c9a1aSwdenk		  "rarpboot", "tftpboot", "loadb" or "diskboot"
4949c609719bSwdenk
4950c609719bSwdenk  loads_echo	- see CONFIG_LOADS_ECHO
4951c609719bSwdenk
4952c609719bSwdenk  serverip	- TFTP server IP address; needed for tftpboot command
4953c609719bSwdenk
4954c609719bSwdenk  bootretry	- see CONFIG_BOOT_RETRY_TIME
4955c609719bSwdenk
4956c609719bSwdenk  bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
4957c609719bSwdenk
4958c609719bSwdenk  bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
4959c609719bSwdenk
4960e2a53458SMike Frysinger  ethprime	- controls which interface is used first.
4961a3d991bdSwdenk
4962e2a53458SMike Frysinger  ethact	- controls which interface is currently active.
4963e2a53458SMike Frysinger		  For example you can do the following
4964a3d991bdSwdenk
496548690d80SHeiko Schocher		  => setenv ethact FEC
496648690d80SHeiko Schocher		  => ping 192.168.0.1 # traffic sent on FEC
496748690d80SHeiko Schocher		  => setenv ethact SCC
496848690d80SHeiko Schocher		  => ping 10.0.0.1 # traffic sent on SCC
4969a3d991bdSwdenk
4970e1692577SMatthias Fuchs  ethrotate	- When set to "no" U-Boot does not go through all
4971e1692577SMatthias Fuchs		  available network interfaces.
4972e1692577SMatthias Fuchs		  It just stays at the currently selected interface.
4973e1692577SMatthias Fuchs
4974a3d991bdSwdenk  netretry	- When set to "no" each network operation will
4975a3d991bdSwdenk		  either succeed or fail without retrying.
49766e592385Swdenk		  When set to "once" the network operation will
49776e592385Swdenk		  fail when all the available network interfaces
49786e592385Swdenk		  are tried once without success.
4979a3d991bdSwdenk		  Useful on scripts which control the retry operation
4980a3d991bdSwdenk		  themselves.
4981a3d991bdSwdenk
4982b4e2f89dSJean-Christophe PLAGNIOL-VILLARD  npe_ucode	- set load address for the NPE microcode
4983a1cf027aSJean-Christophe PLAGNIOL-VILLARD
49848d51aacdSSimon Glass  silent_linux  - If set then linux will be told to boot silently, by
49858d51aacdSSimon Glass		  changing the console to be empty. If "yes" it will be
49868d51aacdSSimon Glass		  made silent. If "no" it will not be made silent. If
49878d51aacdSSimon Glass		  unset, then it will be made silent if the U-Boot console
49888d51aacdSSimon Glass		  is silent.
49898d51aacdSSimon Glass
499028cb9375SWolfgang Denk  tftpsrcport	- If this is set, the value is used for TFTP's
4991ecb0ccd9SWolfgang Denk		  UDP source port.
4992ecb0ccd9SWolfgang Denk
499328cb9375SWolfgang Denk  tftpdstport	- If this is set, the value is used for TFTP's UDP
499428cb9375SWolfgang Denk		  destination port instead of the Well Know Port 69.
499528cb9375SWolfgang Denk
4996c96f86eeSWolfgang Denk  tftpblocksize - Block size to use for TFTP transfers; if not set,
4997c96f86eeSWolfgang Denk		  we use the TFTP server's default block size
4998c96f86eeSWolfgang Denk
4999c96f86eeSWolfgang Denk  tftptimeout	- Retransmission timeout for TFTP packets (in milli-
5000c96f86eeSWolfgang Denk		  seconds, minimum value is 1000 = 1 second). Defines
5001c96f86eeSWolfgang Denk		  when a packet is considered to be lost so it has to
5002c96f86eeSWolfgang Denk		  be retransmitted. The default is 5000 = 5 seconds.
5003c96f86eeSWolfgang Denk		  Lowering this value may make downloads succeed
5004c96f86eeSWolfgang Denk		  faster in networks with high packet loss rates or
5005c96f86eeSWolfgang Denk		  with unreliable TFTP servers.
5006c96f86eeSWolfgang Denk
5007a3d991bdSwdenk  vlan		- When set to a value < 4095 the traffic over
500811ccc33fSMarcel Ziswiler		  Ethernet is encapsulated/received over 802.1q
5009a3d991bdSwdenk		  VLAN tagged frames.
5010c609719bSwdenk
5011dc0b7b0eSJason HobbsThe following image location variables contain the location of images
5012dc0b7b0eSJason Hobbsused in booting. The "Image" column gives the role of the image and is
5013dc0b7b0eSJason Hobbsnot an environment variable name. The other columns are environment
5014dc0b7b0eSJason Hobbsvariable names. "File Name" gives the name of the file on a TFTP
5015dc0b7b0eSJason Hobbsserver, "RAM Address" gives the location in RAM the image will be
5016dc0b7b0eSJason Hobbsloaded to, and "Flash Location" gives the image's address in NOR
5017dc0b7b0eSJason Hobbsflash or offset in NAND flash.
5018dc0b7b0eSJason Hobbs
5019dc0b7b0eSJason Hobbs*Note* - these variables don't have to be defined for all boards, some
5020dc0b7b0eSJason Hobbsboards currenlty use other variables for these purposes, and some
5021dc0b7b0eSJason Hobbsboards use these variables for other purposes.
5022dc0b7b0eSJason Hobbs
5023dc0b7b0eSJason HobbsImage		    File Name	     RAM Address       Flash Location
5024dc0b7b0eSJason Hobbs-----		    ---------	     -----------       --------------
5025dc0b7b0eSJason Hobbsu-boot		    u-boot	     u-boot_addr_r     u-boot_addr
5026dc0b7b0eSJason HobbsLinux kernel	    bootfile	     kernel_addr_r     kernel_addr
5027dc0b7b0eSJason Hobbsdevice tree blob    fdtfile	     fdt_addr_r	       fdt_addr
5028dc0b7b0eSJason Hobbsramdisk		    ramdiskfile	     ramdisk_addr_r    ramdisk_addr
5029dc0b7b0eSJason Hobbs
5030c609719bSwdenkThe following environment variables may be used and automatically
5031c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"),
5032c609719bSwdenkdepending the information provided by your boot server:
5033c609719bSwdenk
5034c609719bSwdenk  bootfile	- see above
5035c609719bSwdenk  dnsip		- IP address of your Domain Name Server
5036fe389a82Sstroese  dnsip2	- IP address of your secondary Domain Name Server
5037c609719bSwdenk  gatewayip	- IP address of the Gateway (Router) to use
5038c609719bSwdenk  hostname	- Target hostname
5039c609719bSwdenk  ipaddr	- see above
5040c609719bSwdenk  netmask	- Subnet Mask
5041c609719bSwdenk  rootpath	- Pathname of the root filesystem on the NFS server
5042c609719bSwdenk  serverip	- see above
5043c609719bSwdenk
5044c609719bSwdenk
5045c609719bSwdenkThere are two special Environment Variables:
5046c609719bSwdenk
5047c609719bSwdenk  serial#	- contains hardware identification information such
5048c609719bSwdenk		  as type string and/or serial number
5049c609719bSwdenk  ethaddr	- Ethernet address
5050c609719bSwdenk
5051c609719bSwdenkThese variables can be set only once (usually during manufacturing of
5052c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables
5053c609719bSwdenkonce they have been set once.
5054c609719bSwdenk
5055c609719bSwdenk
5056c1551ea8SstroeseFurther special Environment Variables:
5057c1551ea8Sstroese
5058c1551ea8Sstroese  ver		- Contains the U-Boot version string as printed
5059c1551ea8Sstroese		  with the "version" command. This variable is
5060c1551ea8Sstroese		  readonly (see CONFIG_VERSION_VARIABLE).
5061c1551ea8Sstroese
5062c1551ea8Sstroese
5063c609719bSwdenkPlease note that changes to some configuration parameters may take
5064c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-).
5065c609719bSwdenk
5066c609719bSwdenk
5067170ab110SJoe HershbergerCallback functions for environment variables:
5068170ab110SJoe Hershberger---------------------------------------------
5069170ab110SJoe Hershberger
5070170ab110SJoe HershbergerFor some environment variables, the behavior of u-boot needs to change
5071170ab110SJoe Hershbergerwhen their values are changed.  This functionailty allows functions to
5072170ab110SJoe Hershbergerbe associated with arbitrary variables.  On creation, overwrite, or
5073170ab110SJoe Hershbergerdeletion, the callback will provide the opportunity for some side
5074170ab110SJoe Hershbergereffect to happen or for the change to be rejected.
5075170ab110SJoe Hershberger
5076170ab110SJoe HershbergerThe callbacks are named and associated with a function using the
5077170ab110SJoe HershbergerU_BOOT_ENV_CALLBACK macro in your board or driver code.
5078170ab110SJoe Hershberger
5079170ab110SJoe HershbergerThese callbacks are associated with variables in one of two ways.  The
5080170ab110SJoe Hershbergerstatic list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
5081170ab110SJoe Hershbergerin the board configuration to a string that defines a list of
5082170ab110SJoe Hershbergerassociations.  The list must be in the following format:
5083170ab110SJoe Hershberger
5084170ab110SJoe Hershberger	entry = variable_name[:callback_name]
5085170ab110SJoe Hershberger	list = entry[,list]
5086170ab110SJoe Hershberger
5087170ab110SJoe HershbergerIf the callback name is not specified, then the callback is deleted.
5088170ab110SJoe HershbergerSpaces are also allowed anywhere in the list.
5089170ab110SJoe Hershberger
5090170ab110SJoe HershbergerCallbacks can also be associated by defining the ".callbacks" variable
5091170ab110SJoe Hershbergerwith the same list format above.  Any association in ".callbacks" will
5092170ab110SJoe Hershbergeroverride any association in the static list. You can define
5093170ab110SJoe HershbergerCONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
5094170ab110SJoe Hershberger".callbacks" envirnoment variable in the default or embedded environment.
5095170ab110SJoe Hershberger
5096170ab110SJoe Hershberger
5097f07771ccSwdenkCommand Line Parsing:
5098f07771ccSwdenk=====================
5099f07771ccSwdenk
5100f07771ccSwdenkThere are two different command line parsers available with U-Boot:
51017152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell:
5102f07771ccSwdenk
5103f07771ccSwdenkOld, simple command line parser:
5104f07771ccSwdenk--------------------------------
5105f07771ccSwdenk
5106f07771ccSwdenk- supports environment variables (through setenv / saveenv commands)
5107f07771ccSwdenk- several commands on one line, separated by ';'
5108fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax
5109f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\',
5110f07771ccSwdenk  for example:
5111fe126d8bSWolfgang Denk	setenv bootcmd bootm \${address}
5112f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example:
5113f07771ccSwdenk	setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
5114f07771ccSwdenk
5115f07771ccSwdenkHush shell:
5116f07771ccSwdenk-----------
5117f07771ccSwdenk
5118f07771ccSwdenk- similar to Bourne shell, with control structures like
5119f07771ccSwdenk  if...then...else...fi, for...do...done; while...do...done,
5120f07771ccSwdenk  until...do...done, ...
5121f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv
5122f07771ccSwdenk  commands) and local shell variables (through standard shell syntax
5123f07771ccSwdenk  "name=value"); only environment variables can be used with "run"
5124f07771ccSwdenk  command
5125f07771ccSwdenk
5126f07771ccSwdenkGeneral rules:
5127f07771ccSwdenk--------------
5128f07771ccSwdenk
5129f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run"
5130f07771ccSwdenk    command) contains several commands separated by semicolon, and
5131f07771ccSwdenk    one of these commands fails, then the remaining commands will be
5132f07771ccSwdenk    executed anyway.
5133f07771ccSwdenk
5134f07771ccSwdenk(2) If you execute several variables with one call to run (i. e.
513511ccc33fSMarcel Ziswiler    calling run with a list of variables as arguments), any failing
5136f07771ccSwdenk    command will cause "run" to terminate, i. e. the remaining
5137f07771ccSwdenk    variables are not executed.
5138f07771ccSwdenk
5139c609719bSwdenkNote for Redundant Ethernet Interfaces:
5140c609719bSwdenk=======================================
5141c609719bSwdenk
514211ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports
5143c609719bSwdenksuch configurations and is capable of automatic selection of a
51447152b1d0Swdenk"working" interface when needed. MAC assignment works as follows:
5145c609719bSwdenk
5146c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding
5147c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0),
5148c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ...
5149c609719bSwdenk
5150c609719bSwdenkIf the network interface stores some valid MAC address (for instance
5151c609719bSwdenkin SROM), this is used as default address if there is NO correspon-
5152c609719bSwdenkding setting in the environment; if the corresponding environment
5153c609719bSwdenkvariable is set, this overrides the settings in the card; that means:
5154c609719bSwdenk
5155c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the
5156c609719bSwdenk  environment, the SROM's address is used.
5157c609719bSwdenk
5158c609719bSwdenko If there is no valid address in the SROM, and a definition in the
5159c609719bSwdenk  environment exists, then the value from the environment variable is
5160c609719bSwdenk  used.
5161c609719bSwdenk
5162c609719bSwdenko If both the SROM and the environment contain a MAC address, and
5163c609719bSwdenk  both addresses are the same, this MAC address is used.
5164c609719bSwdenk
5165c609719bSwdenko If both the SROM and the environment contain a MAC address, and the
5166c609719bSwdenk  addresses differ, the value from the environment is used and a
5167c609719bSwdenk  warning is printed.
5168c609719bSwdenk
5169c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error
5170c609719bSwdenk  is raised.
5171c609719bSwdenk
5172ecee9324SBen WarrenIf Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
5173ecee9324SBen Warrenwill be programmed into hardware as part of the initialization process.	 This
5174ecee9324SBen Warrenmay be skipped by setting the appropriate 'ethmacskip' environment variable.
5175ecee9324SBen WarrenThe naming convention is as follows:
5176ecee9324SBen Warren"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
5177c609719bSwdenk
5178c609719bSwdenkImage Formats:
5179c609719bSwdenk==============
5180c609719bSwdenk
51813310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on)
51823310c549SMarian Balakowiczimages in two formats:
51833310c549SMarian Balakowicz
51843310c549SMarian BalakowiczNew uImage format (FIT)
51853310c549SMarian Balakowicz-----------------------
51863310c549SMarian Balakowicz
51873310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar
51883310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple
51893310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by
51903310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
51913310c549SMarian Balakowicz
51923310c549SMarian Balakowicz
51933310c549SMarian BalakowiczOld uImage format
51943310c549SMarian Balakowicz-----------------
51953310c549SMarian Balakowicz
51963310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything,
51973310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for
51983310c549SMarian Balakowiczdetails; basically, the header defines the following image properties:
5199c609719bSwdenk
5200c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5201c609719bSwdenk  4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
5202f5ed9e39SPeter Tyser  LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5203f5ed9e39SPeter Tyser  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5204f5ed9e39SPeter Tyser  INTEGRITY).
52057b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
5206afc1ce82SMacpaul Lin  IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5207afc1ce82SMacpaul Lin  Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
5208c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2)
5209c609719bSwdenk* Load Address
5210c609719bSwdenk* Entry Point
5211c609719bSwdenk* Image Name
5212c609719bSwdenk* Image Timestamp
5213c609719bSwdenk
5214c609719bSwdenkThe header is marked by a special Magic Number, and both the header
5215c609719bSwdenkand the data portions of the image are secured against corruption by
5216c609719bSwdenkCRC32 checksums.
5217c609719bSwdenk
5218c609719bSwdenk
5219c609719bSwdenkLinux Support:
5220c609719bSwdenk==============
5221c609719bSwdenk
5222c609719bSwdenkAlthough U-Boot should support any OS or standalone application
52237152b1d0Swdenkeasily, the main focus has always been on Linux during the design of
5224c609719bSwdenkU-Boot.
5225c609719bSwdenk
5226c609719bSwdenkU-Boot includes many features that so far have been part of some
5227c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any
5228c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image;
5229c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation
52307152b1d0Swdenkserves several purposes:
5231c609719bSwdenk
5232c609719bSwdenk- the same features can be used for other OS or standalone
5233c609719bSwdenk  applications (for instance: using compressed images to reduce the
5234c609719bSwdenk  Flash memory footprint)
5235c609719bSwdenk
5236c609719bSwdenk- it becomes much easier to port new Linux kernel versions because
52377152b1d0Swdenk  lots of low-level, hardware dependent stuff are done by U-Boot
5238c609719bSwdenk
5239c609719bSwdenk- the same Linux kernel image can now be used with different "initrd"
5240c609719bSwdenk  images; of course this also means that different kernel images can
5241c609719bSwdenk  be run with the same "initrd". This makes testing easier (you don't
5242c609719bSwdenk  have to build a new "zImage.initrd" Linux image when you just
5243c609719bSwdenk  change a file in your "initrd"). Also, a field-upgrade of the
5244c609719bSwdenk  software is easier now.
5245c609719bSwdenk
5246c609719bSwdenk
5247c609719bSwdenkLinux HOWTO:
5248c609719bSwdenk============
5249c609719bSwdenk
5250c609719bSwdenkPorting Linux to U-Boot based systems:
5251c609719bSwdenk---------------------------------------
5252c609719bSwdenk
5253c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to
5254c609719bSwdenkconfigure the Linux device drivers for use with your target hardware
5255c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to
5256c609719bSwdenkLinux :-).
5257c609719bSwdenk
5258a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
5259c609719bSwdenk
5260c609719bSwdenkJust make sure your machine specific header file (for instance
5261c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board
52621dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h,
52631dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value
52646d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR.
5265c609719bSwdenk
5266c609719bSwdenk
5267c609719bSwdenkConfiguring the Linux kernel:
5268c609719bSwdenk-----------------------------
5269c609719bSwdenk
5270c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root
5271c609719bSwdenkdevice (initial ramdisk, NFS) for your target system.
5272c609719bSwdenk
5273c609719bSwdenk
5274c609719bSwdenkBuilding a Linux Image:
5275c609719bSwdenk-----------------------
5276c609719bSwdenk
527724ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are
527824ee89b9Swdenknot used. If you use recent kernel source, a new build target
527924ee89b9Swdenk"uImage" will exist which automatically builds an image usable by
528024ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target,
528124ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a
528224ee89b9Swdenk100% compatible format.
5283c609719bSwdenk
5284c609719bSwdenkExample:
5285c609719bSwdenk
5286c609719bSwdenk	make TQM850L_config
5287c609719bSwdenk	make oldconfig
5288c609719bSwdenk	make dep
528924ee89b9Swdenk	make uImage
5290c609719bSwdenk
529124ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to
529224ee89b9Swdenkencapsulate a compressed Linux kernel image with header	 information,
529324ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing:
5294c609719bSwdenk
529524ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format):
529624ee89b9Swdenk
529724ee89b9Swdenk* convert the kernel into a raw binary image:
529824ee89b9Swdenk
529924ee89b9Swdenk	${CROSS_COMPILE}-objcopy -O binary \
530024ee89b9Swdenk				 -R .note -R .comment \
530124ee89b9Swdenk				 -S vmlinux linux.bin
530224ee89b9Swdenk
530324ee89b9Swdenk* compress the binary image:
530424ee89b9Swdenk
530524ee89b9Swdenk	gzip -9 linux.bin
530624ee89b9Swdenk
530724ee89b9Swdenk* package compressed binary image for U-Boot:
530824ee89b9Swdenk
530924ee89b9Swdenk	mkimage -A ppc -O linux -T kernel -C gzip \
531024ee89b9Swdenk		-a 0 -e 0 -n "Linux Kernel Image" \
531124ee89b9Swdenk		-d linux.bin.gz uImage
531224ee89b9Swdenk
531324ee89b9Swdenk
531424ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use
531524ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or
531624ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64
531724ee89b9Swdenkbyte header containing information about target architecture,
531824ee89b9Swdenkoperating system, image type, compression method, entry points, time
531924ee89b9Swdenkstamp, CRC32 checksums, etc.
532024ee89b9Swdenk
532124ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and
532224ee89b9Swdenkprint the header information, or to build new images.
5323c609719bSwdenk
5324c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information
5325c609719bSwdenkcontained in the header of an existing U-Boot image; this includes
5326c609719bSwdenkchecksum verification:
5327c609719bSwdenk
5328c609719bSwdenk	tools/mkimage -l image
5329c609719bSwdenk	  -l ==> list image header information
5330c609719bSwdenk
5331c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image
5332c609719bSwdenkfrom a "data file" which is used as image payload:
5333c609719bSwdenk
5334c609719bSwdenk	tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5335c609719bSwdenk		      -n name -d data_file image
5336c609719bSwdenk	  -A ==> set architecture to 'arch'
5337c609719bSwdenk	  -O ==> set operating system to 'os'
5338c609719bSwdenk	  -T ==> set image type to 'type'
5339c609719bSwdenk	  -C ==> set compression type 'comp'
5340c609719bSwdenk	  -a ==> set load address to 'addr' (hex)
5341c609719bSwdenk	  -e ==> set entry point to 'ep' (hex)
5342c609719bSwdenk	  -n ==> set image name to 'name'
5343c609719bSwdenk	  -d ==> use image data from 'datafile'
5344c609719bSwdenk
534569459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load
534669459791Swdenkaddress (0x00000000), but the entry point address depends on the
534769459791Swdenkkernel version:
5348c609719bSwdenk
5349c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C,
535024ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000.
5351c609719bSwdenk
5352c609719bSwdenkSo a typical call to build a U-Boot image would read:
5353c609719bSwdenk
535424ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
535524ee89b9Swdenk	> -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
5356a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
535724ee89b9Swdenk	> examples/uImage.TQM850L
535824ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5359c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5360c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
5361c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
5362c609719bSwdenk	Load Address: 0x00000000
536324ee89b9Swdenk	Entry Point:  0x00000000
5364c609719bSwdenk
5365c609719bSwdenkTo verify the contents of the image (or check for corruption):
5366c609719bSwdenk
536724ee89b9Swdenk	-> tools/mkimage -l examples/uImage.TQM850L
536824ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5369c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5370c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
5371c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
5372c609719bSwdenk	Load Address: 0x00000000
537324ee89b9Swdenk	Entry Point:  0x00000000
5374c609719bSwdenk
5375c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade
5376c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this
5377c609719bSwdenkneeds more space in Flash, but boots much faster since it does not
5378c609719bSwdenkneed to be uncompressed:
5379c609719bSwdenk
5380a47a12beSStefan Roese	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
538124ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
538224ee89b9Swdenk	> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
5383a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
538424ee89b9Swdenk	> examples/uImage.TQM850L-uncompressed
538524ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5386c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5387c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (uncompressed)
5388c609719bSwdenk	Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
5389c609719bSwdenk	Load Address: 0x00000000
539024ee89b9Swdenk	Entry Point:  0x00000000
5391c609719bSwdenk
5392c609719bSwdenk
5393c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file
5394c609719bSwdenkwhen your kernel is intended to use an initial ramdisk:
5395c609719bSwdenk
5396c609719bSwdenk	-> tools/mkimage -n 'Simple Ramdisk Image' \
5397c609719bSwdenk	> -A ppc -O linux -T ramdisk -C gzip \
5398c609719bSwdenk	> -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5399c609719bSwdenk	Image Name:   Simple Ramdisk Image
5400c609719bSwdenk	Created:      Wed Jan 12 14:01:50 2000
5401c609719bSwdenk	Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
5402c609719bSwdenk	Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
5403c609719bSwdenk	Load Address: 0x00000000
5404c609719bSwdenk	Entry Point:  0x00000000
5405c609719bSwdenk
5406a804b5ceSGuilherme Maciel FerreiraThe "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5407a804b5ceSGuilherme Maciel Ferreiraoption performs the converse operation of the mkimage's second form (the "-d"
5408a804b5ceSGuilherme Maciel Ferreiraoption). Given an image built by mkimage, the dumpimage extracts a "data file"
5409a804b5ceSGuilherme Maciel Ferreirafrom the image:
5410a804b5ceSGuilherme Maciel Ferreira
5411a804b5ceSGuilherme Maciel Ferreira	tools/dumpimage -i image -p position data_file
5412a804b5ceSGuilherme Maciel Ferreira	  -i ==> extract from the 'image' a specific 'data_file', \
5413a804b5ceSGuilherme Maciel Ferreira	   indexed by 'position'
5414a804b5ceSGuilherme Maciel Ferreira
5415c609719bSwdenk
5416c609719bSwdenkInstalling a Linux Image:
5417c609719bSwdenk-------------------------
5418c609719bSwdenk
5419c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface,
5420c609719bSwdenkyou must convert the image to S-Record format:
5421c609719bSwdenk
5422c609719bSwdenk	objcopy -I binary -O srec examples/image examples/image.srec
5423c609719bSwdenk
5424c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot
5425c609719bSwdenkimage header, so the resulting S-Record file will be relative to
5426c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to
5427c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads'
5428c609719bSwdenkcommand.
5429c609719bSwdenk
5430c609719bSwdenkExample: install the image to address 0x40100000 (which on the
5431c609719bSwdenkTQM8xxL is in the first Flash bank):
5432c609719bSwdenk
5433c609719bSwdenk	=> erase 40100000 401FFFFF
5434c609719bSwdenk
5435c609719bSwdenk	.......... done
5436c609719bSwdenk	Erased 8 sectors
5437c609719bSwdenk
5438c609719bSwdenk	=> loads 40100000
5439c609719bSwdenk	## Ready for S-Record download ...
5440c609719bSwdenk	~>examples/image.srec
5441c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5442c609719bSwdenk	...
5443c609719bSwdenk	15989 15990 15991 15992
5444c609719bSwdenk	[file transfer complete]
5445c609719bSwdenk	[connected]
5446c609719bSwdenk	## Start Addr = 0x00000000
5447c609719bSwdenk
5448c609719bSwdenk
5449c609719bSwdenkYou can check the success of the download using the 'iminfo' command;
5450c609719bSwdenkthis includes a checksum verification so you can be sure no data
5451c609719bSwdenkcorruption happened:
5452c609719bSwdenk
5453c609719bSwdenk	=> imi 40100000
5454c609719bSwdenk
5455c609719bSwdenk	## Checking Image at 40100000 ...
5456c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5457c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5458c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5459c609719bSwdenk	   Load Address: 00000000
5460c609719bSwdenk	   Entry Point:	 0000000c
5461c609719bSwdenk	   Verifying Checksum ... OK
5462c609719bSwdenk
5463c609719bSwdenk
5464c609719bSwdenkBoot Linux:
5465c609719bSwdenk-----------
5466c609719bSwdenk
5467c609719bSwdenkThe "bootm" command is used to boot an application that is stored in
5468c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents
5469c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as
5470c609719bSwdenkparameters. You can check and modify this variable using the
5471c609719bSwdenk"printenv" and "setenv" commands:
5472c609719bSwdenk
5473c609719bSwdenk
5474c609719bSwdenk	=> printenv bootargs
5475c609719bSwdenk	bootargs=root=/dev/ram
5476c609719bSwdenk
5477c609719bSwdenk	=> setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5478c609719bSwdenk
5479c609719bSwdenk	=> printenv bootargs
5480c609719bSwdenk	bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5481c609719bSwdenk
5482c609719bSwdenk	=> bootm 40020000
5483c609719bSwdenk	## Booting Linux kernel at 40020000 ...
5484c609719bSwdenk	   Image Name:	 2.2.13 for NFS on TQM850L
5485c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5486c609719bSwdenk	   Data Size:	 381681 Bytes = 372 kB = 0 MB
5487c609719bSwdenk	   Load Address: 00000000
5488c609719bSwdenk	   Entry Point:	 0000000c
5489c609719bSwdenk	   Verifying Checksum ... OK
5490c609719bSwdenk	   Uncompressing Kernel Image ... OK
5491c609719bSwdenk	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
5492c609719bSwdenk	Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5493c609719bSwdenk	time_init: decrementer frequency = 187500000/60
5494c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
5495c609719bSwdenk	Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5496c609719bSwdenk	...
5497c609719bSwdenk
549811ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass
54997152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT
5500c609719bSwdenkformat!) to the "bootm" command:
5501c609719bSwdenk
5502c609719bSwdenk	=> imi 40100000 40200000
5503c609719bSwdenk
5504c609719bSwdenk	## Checking Image at 40100000 ...
5505c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5506c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5507c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5508c609719bSwdenk	   Load Address: 00000000
5509c609719bSwdenk	   Entry Point:	 0000000c
5510c609719bSwdenk	   Verifying Checksum ... OK
5511c609719bSwdenk
5512c609719bSwdenk	## Checking Image at 40200000 ...
5513c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
5514c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
5515c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
5516c609719bSwdenk	   Load Address: 00000000
5517c609719bSwdenk	   Entry Point:	 00000000
5518c609719bSwdenk	   Verifying Checksum ... OK
5519c609719bSwdenk
5520c609719bSwdenk	=> bootm 40100000 40200000
5521c609719bSwdenk	## Booting Linux kernel at 40100000 ...
5522c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5523c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5524c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5525c609719bSwdenk	   Load Address: 00000000
5526c609719bSwdenk	   Entry Point:	 0000000c
5527c609719bSwdenk	   Verifying Checksum ... OK
5528c609719bSwdenk	   Uncompressing Kernel Image ... OK
5529c609719bSwdenk	## Loading RAMDisk Image at 40200000 ...
5530c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
5531c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
5532c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
5533c609719bSwdenk	   Load Address: 00000000
5534c609719bSwdenk	   Entry Point:	 00000000
5535c609719bSwdenk	   Verifying Checksum ... OK
5536c609719bSwdenk	   Loading Ramdisk ... OK
5537c609719bSwdenk	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
5538c609719bSwdenk	Boot arguments: root=/dev/ram
5539c609719bSwdenk	time_init: decrementer frequency = 187500000/60
5540c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
5541c609719bSwdenk	...
5542c609719bSwdenk	RAMDISK: Compressed image found at block 0
5543c609719bSwdenk	VFS: Mounted root (ext2 filesystem).
5544c609719bSwdenk
5545c609719bSwdenk	bash#
5546c609719bSwdenk
55470267768eSMatthew McClintockBoot Linux and pass a flat device tree:
55480267768eSMatthew McClintock-----------
55490267768eSMatthew McClintock
55500267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section
55510267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The
55520267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated
55530267768eSMatthew McClintockflat device tree:
55540267768eSMatthew McClintock
55550267768eSMatthew McClintock=> print oftaddr
55560267768eSMatthew McClintockoftaddr=0x300000
55570267768eSMatthew McClintock=> print oft
55580267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb
55590267768eSMatthew McClintock=> tftp $oftaddr $oft
55600267768eSMatthew McClintockSpeed: 1000, full duplex
55610267768eSMatthew McClintockUsing TSEC0 device
55620267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101
55630267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'.
55640267768eSMatthew McClintockLoad address: 0x300000
55650267768eSMatthew McClintockLoading: #
55660267768eSMatthew McClintockdone
55670267768eSMatthew McClintockBytes transferred = 4106 (100a hex)
55680267768eSMatthew McClintock=> tftp $loadaddr $bootfile
55690267768eSMatthew McClintockSpeed: 1000, full duplex
55700267768eSMatthew McClintockUsing TSEC0 device
55710267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2
55720267768eSMatthew McClintockFilename 'uImage'.
55730267768eSMatthew McClintockLoad address: 0x200000
55740267768eSMatthew McClintockLoading:############
55750267768eSMatthew McClintockdone
55760267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex)
55770267768eSMatthew McClintock=> print loadaddr
55780267768eSMatthew McClintockloadaddr=200000
55790267768eSMatthew McClintock=> print oftaddr
55800267768eSMatthew McClintockoftaddr=0x300000
55810267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr
55820267768eSMatthew McClintock## Booting image at 00200000 ...
55830267768eSMatthew McClintock   Image Name:	 Linux-2.6.17-dirty
55840267768eSMatthew McClintock   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
55850267768eSMatthew McClintock   Data Size:	 1029343 Bytes = 1005.2 kB
55860267768eSMatthew McClintock   Load Address: 00000000
55870267768eSMatthew McClintock   Entry Point:	 00000000
55880267768eSMatthew McClintock   Verifying Checksum ... OK
55890267768eSMatthew McClintock   Uncompressing Kernel Image ... OK
55900267768eSMatthew McClintockBooting using flat device tree at 0x300000
55910267768eSMatthew McClintockUsing MPC85xx ADS machine description
55920267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
55930267768eSMatthew McClintock[snip]
55940267768eSMatthew McClintock
55950267768eSMatthew McClintock
55966069ff26SwdenkMore About U-Boot Image Types:
55976069ff26Swdenk------------------------------
55986069ff26Swdenk
55996069ff26SwdenkU-Boot supports the following image types:
56006069ff26Swdenk
56016069ff26Swdenk   "Standalone Programs" are directly runnable in the environment
56026069ff26Swdenk	provided by U-Boot; it is expected that (if they behave
56036069ff26Swdenk	well) you can continue to work in U-Boot after return from
56046069ff26Swdenk	the Standalone Program.
56056069ff26Swdenk   "OS Kernel Images" are usually images of some Embedded OS which
56066069ff26Swdenk	will take over control completely. Usually these programs
56076069ff26Swdenk	will install their own set of exception handlers, device
56086069ff26Swdenk	drivers, set up the MMU, etc. - this means, that you cannot
56096069ff26Swdenk	expect to re-enter U-Boot except by resetting the CPU.
56106069ff26Swdenk   "RAMDisk Images" are more or less just data blocks, and their
56116069ff26Swdenk	parameters (address, size) are passed to an OS kernel that is
56126069ff26Swdenk	being started.
56136069ff26Swdenk   "Multi-File Images" contain several images, typically an OS
56146069ff26Swdenk	(Linux) kernel image and one or more data images like
56156069ff26Swdenk	RAMDisks. This construct is useful for instance when you want
56166069ff26Swdenk	to boot over the network using BOOTP etc., where the boot
56176069ff26Swdenk	server provides just a single image file, but you want to get
56186069ff26Swdenk	for instance an OS kernel and a RAMDisk image.
56196069ff26Swdenk
56206069ff26Swdenk	"Multi-File Images" start with a list of image sizes, each
56216069ff26Swdenk	image size (in bytes) specified by an "uint32_t" in network
56226069ff26Swdenk	byte order. This list is terminated by an "(uint32_t)0".
56236069ff26Swdenk	Immediately after the terminating 0 follow the images, one by
56246069ff26Swdenk	one, all aligned on "uint32_t" boundaries (size rounded up to
56256069ff26Swdenk	a multiple of 4 bytes).
56266069ff26Swdenk
56276069ff26Swdenk   "Firmware Images" are binary images containing firmware (like
56286069ff26Swdenk	U-Boot or FPGA images) which usually will be programmed to
56296069ff26Swdenk	flash memory.
56306069ff26Swdenk
56316069ff26Swdenk   "Script files" are command sequences that will be executed by
56326069ff26Swdenk	U-Boot's command interpreter; this feature is especially
56336069ff26Swdenk	useful when you configure U-Boot to use a real shell (hush)
56346069ff26Swdenk	as command interpreter.
56356069ff26Swdenk
563644f074c7SMarek VasutBooting the Linux zImage:
563744f074c7SMarek Vasut-------------------------
563844f074c7SMarek Vasut
563944f074c7SMarek VasutOn some platforms, it's possible to boot Linux zImage. This is done
564044f074c7SMarek Vasutusing the "bootz" command. The syntax of "bootz" command is the same
564144f074c7SMarek Vasutas the syntax of "bootm" command.
564244f074c7SMarek Vasut
56438ac28563STom RiniNote, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
5644017e1f3fSMarek Vasutkernel with raw initrd images. The syntax is slightly different, the
5645017e1f3fSMarek Vasutaddress of the initrd must be augmented by it's size, in the following
5646017e1f3fSMarek Vasutformat: "<initrd addres>:<initrd size>".
5647017e1f3fSMarek Vasut
5648c609719bSwdenk
5649c609719bSwdenkStandalone HOWTO:
5650c609719bSwdenk=================
5651c609719bSwdenk
5652c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and
5653c609719bSwdenkrun "standalone" applications, which can use some resources of
5654c609719bSwdenkU-Boot like console I/O functions or interrupt services.
5655c609719bSwdenk
5656c609719bSwdenkTwo simple examples are included with the sources:
5657c609719bSwdenk
5658c609719bSwdenk"Hello World" Demo:
5659c609719bSwdenk-------------------
5660c609719bSwdenk
5661c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo
5662c609719bSwdenkapplication; it is automatically compiled when you build U-Boot.
5663c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it
5664c609719bSwdenklike that:
5665c609719bSwdenk
5666c609719bSwdenk	=> loads
5667c609719bSwdenk	## Ready for S-Record download ...
5668c609719bSwdenk	~>examples/hello_world.srec
5669c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
5670c609719bSwdenk	[file transfer complete]
5671c609719bSwdenk	[connected]
5672c609719bSwdenk	## Start Addr = 0x00040004
5673c609719bSwdenk
5674c609719bSwdenk	=> go 40004 Hello World! This is a test.
5675c609719bSwdenk	## Starting application at 0x00040004 ...
5676c609719bSwdenk	Hello World
5677c609719bSwdenk	argc = 7
5678c609719bSwdenk	argv[0] = "40004"
5679c609719bSwdenk	argv[1] = "Hello"
5680c609719bSwdenk	argv[2] = "World!"
5681c609719bSwdenk	argv[3] = "This"
5682c609719bSwdenk	argv[4] = "is"
5683c609719bSwdenk	argv[5] = "a"
5684c609719bSwdenk	argv[6] = "test."
5685c609719bSwdenk	argv[7] = "<NULL>"
5686c609719bSwdenk	Hit any key to exit ...
5687c609719bSwdenk
5688c609719bSwdenk	## Application terminated, rc = 0x0
5689c609719bSwdenk
5690c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt
5691c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'.
5692c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second.
5693c609719bSwdenkThe interrupt service routine is trivial, just printing a '.'
5694c609719bSwdenkcharacter, but this is just a demo program. The application can be
5695c609719bSwdenkcontrolled by the following keys:
5696c609719bSwdenk
5697c609719bSwdenk	? - print current values og the CPM Timer registers
5698c609719bSwdenk	b - enable interrupts and start timer
5699c609719bSwdenk	e - stop timer and disable interrupts
5700c609719bSwdenk	q - quit application
5701c609719bSwdenk
5702c609719bSwdenk	=> loads
5703c609719bSwdenk	## Ready for S-Record download ...
5704c609719bSwdenk	~>examples/timer.srec
5705c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
5706c609719bSwdenk	[file transfer complete]
5707c609719bSwdenk	[connected]
5708c609719bSwdenk	## Start Addr = 0x00040004
5709c609719bSwdenk
5710c609719bSwdenk	=> go 40004
5711c609719bSwdenk	## Starting application at 0x00040004 ...
5712c609719bSwdenk	TIMERS=0xfff00980
5713c609719bSwdenk	Using timer 1
5714c609719bSwdenk	  tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
5715c609719bSwdenk
5716c609719bSwdenkHit 'b':
5717c609719bSwdenk	[q, b, e, ?] Set interval 1000000 us
5718c609719bSwdenk	Enabling timer
5719c609719bSwdenkHit '?':
5720c609719bSwdenk	[q, b, e, ?] ........
5721c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
5722c609719bSwdenkHit '?':
5723c609719bSwdenk	[q, b, e, ?] .
5724c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
5725c609719bSwdenkHit '?':
5726c609719bSwdenk	[q, b, e, ?] .
5727c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
5728c609719bSwdenkHit '?':
5729c609719bSwdenk	[q, b, e, ?] .
5730c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
5731c609719bSwdenkHit 'e':
5732c609719bSwdenk	[q, b, e, ?] ...Stopping timer
5733c609719bSwdenkHit 'q':
5734c609719bSwdenk	[q, b, e, ?] ## Application terminated, rc = 0x0
5735c609719bSwdenk
5736c609719bSwdenk
573785ec0bccSwdenkMinicom warning:
573885ec0bccSwdenk================
573985ec0bccSwdenk
57407152b1d0SwdenkOver time, many people have reported problems when trying to use the
574185ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd)
574285ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under
5743f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and
574485ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and
5745e53515a2SKarl O. Pincuse "cu" for S-Record download ("loads" command).  See
5746e53515a2SKarl O. Pinchttp://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
5747e53515a2SKarl O. Pincfor help with kermit.
5748e53515a2SKarl O. Pinc
574985ec0bccSwdenk
575052f52c14SwdenkNevertheless, if you absolutely want to use it try adding this
575152f52c14Swdenkconfiguration to your "File transfer protocols" section:
575252f52c14Swdenk
575352f52c14Swdenk	   Name	   Program			Name U/D FullScr IO-Red. Multi
575452f52c14Swdenk	X  kermit  /usr/bin/kermit -i -l %l -s	 Y    U	   Y	   N	  N
575552f52c14Swdenk	Y  kermit  /usr/bin/kermit -i -l %l -r	 N    D	   Y	   N	  N
575652f52c14Swdenk
575752f52c14Swdenk
5758c609719bSwdenkNetBSD Notes:
5759c609719bSwdenk=============
5760c609719bSwdenk
5761c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host
5762c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx).
5763c609719bSwdenk
5764c609719bSwdenkBuilding requires a cross environment; it is known to work on
5765c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5766c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make).
5767c609719bSwdenkNote that the cross-powerpc package does not install include files;
5768c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is
5769c609719bSwdenkmissing.  This file has to be installed and patched manually:
5770c609719bSwdenk
5771c609719bSwdenk	# cd /usr/pkg/cross/powerpc-netbsd/include
5772c609719bSwdenk	# mkdir powerpc
5773c609719bSwdenk	# ln -s powerpc machine
5774c609719bSwdenk	# cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
5775c609719bSwdenk	# ${EDIT} powerpc/ansi.h	## must remove __va_list, _BSD_VA_LIST
5776c609719bSwdenk
5777c609719bSwdenkNative builds *don't* work due to incompatibilities between native
5778c609719bSwdenkand U-Boot include files.
5779c609719bSwdenk
5780c609719bSwdenkBooting assumes that (the first part of) the image booted is a
5781c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel
5782c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source
5783c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
57842a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
5785c609719bSwdenk
5786c609719bSwdenk
5787c609719bSwdenkImplementation Internals:
5788c609719bSwdenk=========================
5789c609719bSwdenk
5790c609719bSwdenkThe following is not intended to be a complete description of every
5791c609719bSwdenkimplementation detail. However, it should help to understand the
5792c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom
5793c609719bSwdenkhardware.
5794c609719bSwdenk
5795c609719bSwdenk
5796c609719bSwdenkInitial Stack, Global Data:
5797c609719bSwdenk---------------------------
5798c609719bSwdenk
5799c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot
5800c609719bSwdenkstarts running out of ROM (flash memory), usually without access to
5801c609719bSwdenksystem RAM (because the memory controller is not initialized yet).
5802c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS
5803c609719bSwdenkis not initialized as zero. To be able to get a C environment working
5804c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation
5805c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU
5806c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and
5807c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be
5808c609719bSwdenklocked as (mis-) used as memory, etc.
5809c609719bSwdenk
58107152b1d0Swdenk	Chris Hallinan posted a good summary of these issues to the
58110668236bSWolfgang Denk	U-Boot mailing list:
581243d9616cSwdenk
581343d9616cSwdenk	Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
581443d9616cSwdenk	From: "Chris Hallinan" <clh@net1plus.com>
581543d9616cSwdenk	Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
581643d9616cSwdenk	...
581743d9616cSwdenk
581843d9616cSwdenk	Correct me if I'm wrong, folks, but the way I understand it
581943d9616cSwdenk	is this: Using DCACHE as initial RAM for Stack, etc, does not
582043d9616cSwdenk	require any physical RAM backing up the cache. The cleverness
582143d9616cSwdenk	is that the cache is being used as a temporary supply of
582243d9616cSwdenk	necessary storage before the SDRAM controller is setup. It's
582311ccc33fSMarcel Ziswiler	beyond the scope of this list to explain the details, but you
582443d9616cSwdenk	can see how this works by studying the cache architecture and
582543d9616cSwdenk	operation in the architecture and processor-specific manuals.
582643d9616cSwdenk
582743d9616cSwdenk	OCM is On Chip Memory, which I believe the 405GP has 4K. It
582843d9616cSwdenk	is another option for the system designer to use as an
582911ccc33fSMarcel Ziswiler	initial stack/RAM area prior to SDRAM being available. Either
583043d9616cSwdenk	option should work for you. Using CS 4 should be fine if your
583143d9616cSwdenk	board designers haven't used it for something that would
583243d9616cSwdenk	cause you grief during the initial boot! It is frequently not
583343d9616cSwdenk	used.
583443d9616cSwdenk
58356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
583643d9616cSwdenk	with your processor/board/system design. The default value
583743d9616cSwdenk	you will find in any recent u-boot distribution in
58388a316c9bSStefan Roese	walnut.h should work for you. I'd set it to a value larger
583943d9616cSwdenk	than your SDRAM module. If you have a 64MB SDRAM module, set
584043d9616cSwdenk	it above 400_0000. Just make sure your board has no resources
584143d9616cSwdenk	that are supposed to respond to that address! That code in
584243d9616cSwdenk	start.S has been around a while and should work as is when
584343d9616cSwdenk	you get the config right.
584443d9616cSwdenk
584543d9616cSwdenk	-Chris Hallinan
584643d9616cSwdenk	DS4.COM, Inc.
584743d9616cSwdenk
5848c609719bSwdenkIt is essential to remember this, since it has some impact on the C
5849c609719bSwdenkcode for the initialization procedures:
5850c609719bSwdenk
5851c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt
5852c609719bSwdenk  to write it.
5853c609719bSwdenk
585411ccc33fSMarcel Ziswiler* Do not use any uninitialized global data (or implicitely initialized
5855c609719bSwdenk  as zero data - BSS segment) at all - this is undefined, initiali-
58567152b1d0Swdenk  zation is performed later (when relocating to RAM).
5857c609719bSwdenk
5858c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like
5859c609719bSwdenk  that.
5860c609719bSwdenk
5861c609719bSwdenkHaving only the stack as writable memory limits means we cannot use
5862c609719bSwdenknormal global data to share information beween the code. But it
5863c609719bSwdenkturned out that the implementation of U-Boot can be greatly
5864c609719bSwdenksimplified by making a global data structure (gd_t) available to all
5865c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_
5866c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of
5867c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we
5868c609719bSwdenkplace a pointer (gd) to the global data into a register which we
5869c609719bSwdenkreserve for this purpose.
5870c609719bSwdenk
58717152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the
5872c609719bSwdenkrelevant  (E)ABI  specifications for the current architecture, and by
5873c609719bSwdenkGCC's implementation.
5874c609719bSwdenk
5875c609719bSwdenkFor PowerPC, the following registers have specific use:
5876c609719bSwdenk	R1:	stack pointer
5877e7670f6cSWolfgang Denk	R2:	reserved for system use
5878c609719bSwdenk	R3-R4:	parameter passing and return values
5879c609719bSwdenk	R5-R10: parameter passing
5880c609719bSwdenk	R13:	small data area pointer
5881c609719bSwdenk	R30:	GOT pointer
5882c609719bSwdenk	R31:	frame pointer
5883c609719bSwdenk
5884e6bee808SJoakim Tjernlund	(U-Boot also uses R12 as internal GOT pointer. r12
5885e6bee808SJoakim Tjernlund	is a volatile register so r12 needs to be reset when
5886e6bee808SJoakim Tjernlund	going back and forth between asm and C)
5887c609719bSwdenk
5888e7670f6cSWolfgang Denk    ==> U-Boot will use R2 to hold a pointer to the global data
5889c609719bSwdenk
5890c609719bSwdenk    Note: on PPC, we could use a static initializer (since the
5891c609719bSwdenk    address of the global data structure is known at compile time),
5892c609719bSwdenk    but it turned out that reserving a register results in somewhat
5893c609719bSwdenk    smaller code - although the code savings are not that big (on
5894c609719bSwdenk    average for all boards 752 bytes for the whole U-Boot image,
5895c609719bSwdenk    624 text + 127 data).
5896c609719bSwdenk
5897c4db335cSRobin GetzOn Blackfin, the normal C ABI (except for P3) is followed as documented here:
58984c58eb55SMike Frysinger	http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
58994c58eb55SMike Frysinger
5900c4db335cSRobin Getz    ==> U-Boot will use P3 to hold a pointer to the global data
59014c58eb55SMike Frysinger
5902c609719bSwdenkOn ARM, the following registers are used:
5903c609719bSwdenk
5904c609719bSwdenk	R0:	function argument word/integer result
5905c609719bSwdenk	R1-R3:	function argument word
590612eba1b4SJeroen Hofstee	R9:	platform specific
590712eba1b4SJeroen Hofstee	R10:	stack limit (used only if stack checking is enabled)
5908c609719bSwdenk	R11:	argument (frame) pointer
5909c609719bSwdenk	R12:	temporary workspace
5910c609719bSwdenk	R13:	stack pointer
5911c609719bSwdenk	R14:	link register
5912c609719bSwdenk	R15:	program counter
5913c609719bSwdenk
591412eba1b4SJeroen Hofstee    ==> U-Boot will use R9 to hold a pointer to the global data
591512eba1b4SJeroen Hofstee
591612eba1b4SJeroen Hofstee    Note: on ARM, only R_ARM_RELATIVE relocations are supported.
5917c609719bSwdenk
59180df01fd3SThomas ChouOn Nios II, the ABI is documented here:
59190df01fd3SThomas Chou	http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
59200df01fd3SThomas Chou
59210df01fd3SThomas Chou    ==> U-Boot will use gp to hold a pointer to the global data
59220df01fd3SThomas Chou
59230df01fd3SThomas Chou    Note: on Nios II, we give "-G0" option to gcc and don't use gp
59240df01fd3SThomas Chou    to access small data sections, so gp is free.
59250df01fd3SThomas Chou
5926afc1ce82SMacpaul LinOn NDS32, the following registers are used:
5927afc1ce82SMacpaul Lin
5928afc1ce82SMacpaul Lin	R0-R1:	argument/return
5929afc1ce82SMacpaul Lin	R2-R5:	argument
5930afc1ce82SMacpaul Lin	R15:	temporary register for assembler
5931afc1ce82SMacpaul Lin	R16:	trampoline register
5932afc1ce82SMacpaul Lin	R28:	frame pointer (FP)
5933afc1ce82SMacpaul Lin	R29:	global pointer (GP)
5934afc1ce82SMacpaul Lin	R30:	link register (LP)
5935afc1ce82SMacpaul Lin	R31:	stack pointer (SP)
5936afc1ce82SMacpaul Lin	PC:	program counter (PC)
5937afc1ce82SMacpaul Lin
5938afc1ce82SMacpaul Lin    ==> U-Boot will use R10 to hold a pointer to the global data
5939afc1ce82SMacpaul Lin
5940d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5941d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much.
5942c609719bSwdenk
5943c609719bSwdenkMemory Management:
5944c609719bSwdenk------------------
5945c609719bSwdenk
5946c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the
5947c609719bSwdenkMMU is not used either for address mapping nor for memory protection.
5948c609719bSwdenk
5949c609719bSwdenkThe available memory is mapped to fixed addresses using the memory
5950c609719bSwdenkcontroller. In this process, a contiguous block is formed for each
5951c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several
5952c609719bSwdenkphysical memory banks.
5953c609719bSwdenk
5954c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on
5955c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5956c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself
5957c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some
59586d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
5959c609719bSwdenkconfiguration setting]. Below that, a structure with global Board
5960c609719bSwdenkInfo data is placed, followed by the stack (growing downward).
5961c609719bSwdenk
5962c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB
5963c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF).
5964c609719bSwdenk
5965c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like
5966c609719bSwdenkthis:
5967c609719bSwdenk
5968c609719bSwdenk	0x0000 0000	Exception Vector code
5969c609719bSwdenk	      :
5970c609719bSwdenk	0x0000 1FFF
5971c609719bSwdenk	0x0000 2000	Free for Application Use
5972c609719bSwdenk	      :
5973c609719bSwdenk	      :
5974c609719bSwdenk
5975c609719bSwdenk	      :
5976c609719bSwdenk	      :
5977c609719bSwdenk	0x00FB FF20	Monitor Stack (Growing downward)
5978c609719bSwdenk	0x00FB FFAC	Board Info Data and permanent copy of global data
5979c609719bSwdenk	0x00FC 0000	Malloc Arena
5980c609719bSwdenk	      :
5981c609719bSwdenk	0x00FD FFFF
5982c609719bSwdenk	0x00FE 0000	RAM Copy of Monitor Code
5983c609719bSwdenk	...		eventually: LCD or video framebuffer
5984c609719bSwdenk	...		eventually: pRAM (Protected RAM - unchanged by reset)
5985c609719bSwdenk	0x00FF FFFF	[End of RAM]
5986c609719bSwdenk
5987c609719bSwdenk
5988c609719bSwdenkSystem Initialization:
5989c609719bSwdenk----------------------
5990c609719bSwdenk
5991c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point
599211ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset
5993c609719bSwdenkconfiguration for CS0# this is a mirror of the onboard Flash memory.
59947152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address.
5995c609719bSwdenkTo be able to implement the initialization code in C, a (small!)
5996c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs
5997c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked
5998c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core,
5999c609719bSwdenkthe caches and the SIU.
6000c609719bSwdenk
6001c609719bSwdenkNext, all (potentially) available memory banks are mapped using a
6002c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries
6003c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
6004c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
6005c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a
6006c609719bSwdenksimple memory test is run that determines the size of the SDRAM
6007c609719bSwdenkbanks.
6008c609719bSwdenk
6009c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of
60107152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first
6011c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address
6012c609719bSwdenk0x00000000, with any additional banks following immediately to create
6013c609719bSwdenkcontiguous memory starting from 0.
6014c609719bSwdenk
6015c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area
6016c609719bSwdenkand allocates memory for use by malloc() and for the global Board
6017c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM
6018c609719bSwdenkpages, and the final stack is set up.
6019c609719bSwdenk
6020c609719bSwdenkOnly after this relocation will you have a "normal" C environment;
6021c609719bSwdenkuntil that you are restricted in several ways, mostly because you are
6022c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a
6023c609719bSwdenknew address in RAM.
6024c609719bSwdenk
6025c609719bSwdenk
6026c609719bSwdenkU-Boot Porting Guide:
6027c609719bSwdenk----------------------
6028c609719bSwdenk
6029c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
60306aff3115Swdenklist, October 2002]
6031c609719bSwdenk
6032c609719bSwdenk
6033c609719bSwdenkint main(int argc, char *argv[])
6034c609719bSwdenk{
6035c609719bSwdenk	sighandler_t no_more_time;
6036c609719bSwdenk
6037c609719bSwdenk	signal(SIGALRM, no_more_time);
6038c609719bSwdenk	alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
6039c609719bSwdenk
6040c609719bSwdenk	if (available_money > available_manpower) {
60416c3fef28SJerry Van Baren		Pay consultant to port U-Boot;
6042c609719bSwdenk		return 0;
6043c609719bSwdenk	}
6044c609719bSwdenk
6045c609719bSwdenk	Download latest U-Boot source;
6046c609719bSwdenk
60470668236bSWolfgang Denk	Subscribe to u-boot mailing list;
60486aff3115Swdenk
60496c3fef28SJerry Van Baren	if (clueless)
6050c609719bSwdenk		email("Hi, I am new to U-Boot, how do I get started?");
6051c609719bSwdenk
6052c609719bSwdenk	while (learning) {
6053c609719bSwdenk		Read the README file in the top level directory;
60547cb22f97Swdenk		Read http://www.denx.de/twiki/bin/view/DULG/Manual;
60556c3fef28SJerry Van Baren		Read applicable doc/*.README;
6056c609719bSwdenk		Read the source, Luke;
60576c3fef28SJerry Van Baren		/* find . -name "*.[chS]" | xargs grep -i <keyword> */
6058c609719bSwdenk	}
6059c609719bSwdenk
60606c3fef28SJerry Van Baren	if (available_money > toLocalCurrency ($2500))
60616c3fef28SJerry Van Baren		Buy a BDI3000;
60626c3fef28SJerry Van Baren	else
6063c609719bSwdenk		Add a lot of aggravation and time;
6064c609719bSwdenk
60656c3fef28SJerry Van Baren	if (a similar board exists) {	/* hopefully... */
60666c3fef28SJerry Van Baren		cp -a board/<similar> board/<myboard>
60676c3fef28SJerry Van Baren		cp include/configs/<similar>.h include/configs/<myboard>.h
60686c3fef28SJerry Van Baren	} else {
6069c609719bSwdenk		Create your own board support subdirectory;
60706c3fef28SJerry Van Baren		Create your own board include/configs/<myboard>.h file;
60716c3fef28SJerry Van Baren	}
60726c3fef28SJerry Van Baren	Edit new board/<myboard> files
60736c3fef28SJerry Van Baren	Edit new include/configs/<myboard>.h
6074c609719bSwdenk
60756c3fef28SJerry Van Baren	while (!accepted) {
6076c609719bSwdenk		while (!running) {
6077c609719bSwdenk			do {
6078c609719bSwdenk				Add / modify source code;
6079c609719bSwdenk			} until (compiles);
6080c609719bSwdenk			Debug;
6081c609719bSwdenk			if (clueless)
6082c609719bSwdenk				email("Hi, I am having problems...");
6083c609719bSwdenk		}
60846c3fef28SJerry Van Baren		Send patch file to the U-Boot email list;
60856c3fef28SJerry Van Baren		if (reasonable critiques)
60866c3fef28SJerry Van Baren			Incorporate improvements from email list code review;
60876c3fef28SJerry Van Baren		else
60886c3fef28SJerry Van Baren			Defend code as written;
60896c3fef28SJerry Van Baren	}
6090c609719bSwdenk
6091c609719bSwdenk	return 0;
6092c609719bSwdenk}
6093c609719bSwdenk
6094c609719bSwdenkvoid no_more_time (int sig)
6095c609719bSwdenk{
6096c609719bSwdenk      hire_a_guru();
6097c609719bSwdenk}
6098c609719bSwdenk
6099c609719bSwdenk
6100c609719bSwdenkCoding Standards:
6101c609719bSwdenk-----------------
6102c609719bSwdenk
6103c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel
61042c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script
61057ca9296eSWolfgang Denk"scripts/Lindent" in your Linux kernel source directory.
6106c609719bSwdenk
61072c051651SDetlev ZundelSource files originating from a different project (for example the
61082c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not
61092c051651SDetlev Zundelreformated to ease subsequent migration to newer versions of those
61102c051651SDetlev Zundelsources.
61112c051651SDetlev Zundel
61122c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in
61132c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//)
61142c051651SDetlev Zundelin your code.
6115c609719bSwdenk
6116c178d3daSwdenkPlease also stick to the following formatting rules:
6117180d3f74Swdenk- remove any trailing white space
61187ca9296eSWolfgang Denk- use TAB characters for indentation and vertical alignment, not spaces
6119180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds
61207ca9296eSWolfgang Denk- do not add more than 2 consecutive empty lines to source files
6121180d3f74Swdenk- do not add trailing empty lines to source files
6122180d3f74Swdenk
6123c609719bSwdenkSubmissions which do not conform to the standards may be returned
6124c609719bSwdenkwith a request to reformat the changes.
6125c609719bSwdenk
6126c609719bSwdenk
6127c609719bSwdenkSubmitting Patches:
6128c609719bSwdenk-------------------
6129c609719bSwdenk
6130c609719bSwdenkSince the number of patches for U-Boot is growing, we need to
6131c609719bSwdenkestablish some rules. Submissions which do not conform to these rules
6132c609719bSwdenkmay be rejected, even when they contain important and valuable stuff.
6133c609719bSwdenk
61340d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details.
6135218ca724SWolfgang Denk
61360668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
61370668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot
61380668236bSWolfgang Denk
6139c609719bSwdenkWhen you send a patch, please include the following information with
6140c609719bSwdenkit:
6141c609719bSwdenk
6142c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes
6143c609719bSwdenk  this bug. Please try to include a way of demonstrating that the
6144c609719bSwdenk  patch actually fixes something.
6145c609719bSwdenk
6146c609719bSwdenk* For new features: a description of the feature and your
6147c609719bSwdenk  implementation.
6148c609719bSwdenk
6149c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch)
6150c609719bSwdenk
6151c609719bSwdenk* For major contributions, your entry to the CREDITS file
6152c609719bSwdenk
615327af930eSAlbert ARIBAUD* When you add support for a new board, don't forget to add a
615427af930eSAlbert ARIBAUD  maintainer e-mail address to the boards.cfg file, too.
6155c609719bSwdenk
6156c609719bSwdenk* If your patch adds new configuration options, don't forget to
6157c609719bSwdenk  document these in the README file.
6158c609719bSwdenk
6159218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly*
6160218ca724SWolfgang Denk  recommended) you can easily generate the patch using the
61617ca9296eSWolfgang Denk  "git format-patch". If you then use "git send-email" to send it to
6162218ca724SWolfgang Denk  the U-Boot mailing list, you will avoid most of the common problems
6163218ca724SWolfgang Denk  with some other mail clients.
6164c609719bSwdenk
6165218ca724SWolfgang Denk  If you cannot use git, use "diff -purN OLD NEW". If your version of
6166218ca724SWolfgang Denk  diff does not support these options, then get the latest version of
6167218ca724SWolfgang Denk  GNU diff.
61686dff5529Swdenk
6169218ca724SWolfgang Denk  The current directory when running this command shall be the parent
6170218ca724SWolfgang Denk  directory of the U-Boot source tree (i. e. please make sure that
6171218ca724SWolfgang Denk  your patch includes sufficient directory information for the
6172218ca724SWolfgang Denk  affected files).
6173218ca724SWolfgang Denk
6174218ca724SWolfgang Denk  We prefer patches as plain text. MIME attachments are discouraged,
6175218ca724SWolfgang Denk  and compressed attachments must not be used.
6176c609719bSwdenk
617752f52c14Swdenk* If one logical set of modifications affects or creates several
617852f52c14Swdenk  files, all these changes shall be submitted in a SINGLE patch file.
617952f52c14Swdenk
618052f52c14Swdenk* Changesets that contain different, unrelated modifications shall be
618152f52c14Swdenk  submitted as SEPARATE patches, one patch per changeset.
618252f52c14Swdenk
618352f52c14Swdenk
6184c609719bSwdenkNotes:
6185c609719bSwdenk
6186c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched
6187c609719bSwdenk  source tree and make sure that no errors or warnings are reported
6188c609719bSwdenk  for any of the boards.
6189c609719bSwdenk
6190c609719bSwdenk* Keep your modifications to the necessary minimum: A patch
6191c609719bSwdenk  containing several unrelated changes or arbitrary reformats will be
6192c609719bSwdenk  returned with a request to re-formatting / split it.
6193c609719bSwdenk
6194c609719bSwdenk* If you modify existing code, make sure that your new code does not
6195c609719bSwdenk  add to the memory footprint of the code ;-) Small is beautiful!
6196c609719bSwdenk  When adding new features, these should compile conditionally only
6197c609719bSwdenk  (using #ifdef), and the resulting code with the new feature
6198c609719bSwdenk  disabled must not need more memory than the old code without your
6199c609719bSwdenk  modification.
620090dc6704Swdenk
62010668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the
62020668236bSWolfgang Denk  u-boot mailing list. Bigger patches will be moderated. If they are
62030668236bSWolfgang Denk  reasonable and not too big, they will be acknowledged. But patches
62040668236bSWolfgang Denk  bigger than the size limit should be avoided.
6205