xref: /openbmc/u-boot/README (revision fac9640895c3f778c3d2a33521dfd95bd5cba653)
1c609719bSwdenk#
2eca3aeb3SWolfgang Denk# (C) Copyright 2000 - 2013
3c609719bSwdenk# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4c609719bSwdenk#
5eca3aeb3SWolfgang Denk# SPDX-License-Identifier:	GPL-2.0+
6c609719bSwdenk#
7c609719bSwdenk
8c609719bSwdenkSummary:
9c609719bSwdenk========
10c609719bSwdenk
1124ee89b9SwdenkThis directory contains the source code for U-Boot, a boot loader for
12e86e5a07SwdenkEmbedded boards based on PowerPC, ARM, MIPS and several other
13e86e5a07Swdenkprocessors, which can be installed in a boot ROM and used to
14e86e5a07Swdenkinitialize and test the hardware or to download and run application
15e86e5a07Swdenkcode.
16c609719bSwdenk
17c609719bSwdenkThe development of U-Boot is closely related to Linux: some parts of
1824ee89b9Swdenkthe source code originate in the Linux source tree, we have some
1924ee89b9Swdenkheader files in common, and special provision has been made to
20c609719bSwdenksupport booting of Linux images.
21c609719bSwdenk
22c609719bSwdenkSome attention has been paid to make this software easily
23c609719bSwdenkconfigurable and extendable. For instance, all monitor commands are
24c609719bSwdenkimplemented with the same call interface, so that it's very easy to
25c609719bSwdenkadd new commands. Also, instead of permanently adding rarely used
26c609719bSwdenkcode (for instance hardware test utilities) to the monitor, you can
27c609719bSwdenkload and run it dynamically.
28c609719bSwdenk
29c609719bSwdenk
30c609719bSwdenkStatus:
31c609719bSwdenk=======
32c609719bSwdenk
33c609719bSwdenkIn general, all boards for which a configuration option exists in the
34c609719bSwdenkMakefile have been tested to some extent and can be considered
35c609719bSwdenk"working". In fact, many of them are used in production systems.
36c609719bSwdenk
37c609719bSwdenkIn case of problems see the CHANGELOG and CREDITS files to find out
3827af930eSAlbert ARIBAUDwho contributed the specific port. The boards.cfg file lists board
39218ca724SWolfgang Denkmaintainers.
40c609719bSwdenk
41adb9d851SRobert P. J. DayNote: There is no CHANGELOG file in the actual U-Boot source tree;
42adb9d851SRobert P. J. Dayit can be created dynamically from the Git log using:
43adb9d851SRobert P. J. Day
44adb9d851SRobert P. J. Day	make CHANGELOG
45adb9d851SRobert P. J. Day
46c609719bSwdenk
47c609719bSwdenkWhere to get help:
48c609719bSwdenk==================
49c609719bSwdenk
50c609719bSwdenkIn case you have questions about, problems with or contributions for
51c609719bSwdenkU-Boot you should send a message to the U-Boot mailing list at
520c32565fSPeter Tyser<u-boot@lists.denx.de>. There is also an archive of previous traffic
530c32565fSPeter Tyseron the mailing list - please search the archive before asking FAQ's.
540c32565fSPeter TyserPlease see http://lists.denx.de/pipermail/u-boot and
550c32565fSPeter Tyserhttp://dir.gmane.org/gmane.comp.boot-loaders.u-boot
56c609719bSwdenk
57c609719bSwdenk
58218ca724SWolfgang DenkWhere to get source code:
59218ca724SWolfgang Denk=========================
60218ca724SWolfgang Denk
61218ca724SWolfgang DenkThe U-Boot source code is maintained in the git repository at
62218ca724SWolfgang Denkgit://www.denx.de/git/u-boot.git ; you can browse it online at
63218ca724SWolfgang Denkhttp://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
64218ca724SWolfgang Denk
65218ca724SWolfgang DenkThe "snapshot" links on this page allow you to download tarballs of
6611ccc33fSMarcel Ziswilerany version you might be interested in. Official releases are also
67218ca724SWolfgang Denkavailable for FTP download from the ftp://ftp.denx.de/pub/u-boot/
68218ca724SWolfgang Denkdirectory.
69218ca724SWolfgang Denk
70d4ee711dSAnatolij GustschinPre-built (and tested) images are available from
71218ca724SWolfgang Denkftp://ftp.denx.de/pub/u-boot/images/
72218ca724SWolfgang Denk
73218ca724SWolfgang Denk
74c609719bSwdenkWhere we come from:
75c609719bSwdenk===================
76c609719bSwdenk
77c609719bSwdenk- start from 8xxrom sources
7824ee89b9Swdenk- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
79c609719bSwdenk- clean up code
80c609719bSwdenk- make it easier to add custom boards
81c609719bSwdenk- make it possible to add other [PowerPC] CPUs
82c609719bSwdenk- extend functions, especially:
83c609719bSwdenk  * Provide extended interface to Linux boot loader
84c609719bSwdenk  * S-Record download
85c609719bSwdenk  * network boot
8611ccc33fSMarcel Ziswiler  * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
8724ee89b9Swdenk- create ARMBoot project (http://sourceforge.net/projects/armboot)
88c609719bSwdenk- add other CPU families (starting with ARM)
8924ee89b9Swdenk- create U-Boot project (http://sourceforge.net/projects/u-boot)
900d28f34bSMagnus Lilja- current project page: see http://www.denx.de/wiki/U-Boot
9124ee89b9Swdenk
9224ee89b9Swdenk
9324ee89b9SwdenkNames and Spelling:
9424ee89b9Swdenk===================
9524ee89b9Swdenk
9624ee89b9SwdenkThe "official" name of this project is "Das U-Boot". The spelling
9724ee89b9Swdenk"U-Boot" shall be used in all written text (documentation, comments
9824ee89b9Swdenkin source files etc.). Example:
9924ee89b9Swdenk
10024ee89b9Swdenk	This is the README file for the U-Boot project.
10124ee89b9Swdenk
10224ee89b9SwdenkFile names etc. shall be based on the string "u-boot". Examples:
10324ee89b9Swdenk
10424ee89b9Swdenk	include/asm-ppc/u-boot.h
10524ee89b9Swdenk
10624ee89b9Swdenk	#include <asm/u-boot.h>
10724ee89b9Swdenk
10824ee89b9SwdenkVariable names, preprocessor constants etc. shall be either based on
10924ee89b9Swdenkthe string "u_boot" or on "U_BOOT". Example:
11024ee89b9Swdenk
11124ee89b9Swdenk	U_BOOT_VERSION		u_boot_logo
11224ee89b9Swdenk	IH_OS_U_BOOT		u_boot_hush_start
113c609719bSwdenk
114c609719bSwdenk
11593f19cc0SwdenkVersioning:
11693f19cc0Swdenk===========
11793f19cc0Swdenk
118360d883aSThomas WeberStarting with the release in October 2008, the names of the releases
119360d883aSThomas Weberwere changed from numerical release numbers without deeper meaning
120360d883aSThomas Weberinto a time stamp based numbering. Regular releases are identified by
121360d883aSThomas Webernames consisting of the calendar year and month of the release date.
122360d883aSThomas WeberAdditional fields (if present) indicate release candidates or bug fix
123360d883aSThomas Weberreleases in "stable" maintenance trees.
12493f19cc0Swdenk
125360d883aSThomas WeberExamples:
126360d883aSThomas Weber	U-Boot v2009.11	    - Release November 2009
127360d883aSThomas Weber	U-Boot v2009.11.1   - Release 1 in version November 2009 stable tree
128360d883aSThomas Weber	U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release
12993f19cc0Swdenk
13093f19cc0Swdenk
131c609719bSwdenkDirectory Hierarchy:
132c609719bSwdenk====================
133c609719bSwdenk
1348d321b81SPeter Tyser/arch			Architecture specific files
1358d321b81SPeter Tyser  /arm			Files generic to ARM architecture
1368d321b81SPeter Tyser    /cpu		CPU specific files
1378d321b81SPeter Tyser      /arm720t		Files specific to ARM 720 CPUs
1388d321b81SPeter Tyser      /arm920t		Files specific to ARM 920 CPUs
1396eb0921aSAndreas Bießmann	/at91		Files specific to Atmel AT91RM9200 CPU
1408d321b81SPeter Tyser	/imx		Files specific to Freescale MC9328 i.MX CPUs
1418d321b81SPeter Tyser	/s3c24x0	Files specific to Samsung S3C24X0 CPUs
1428d321b81SPeter Tyser      /arm926ejs	Files specific to ARM 926 CPUs
1438d321b81SPeter Tyser      /arm1136		Files specific to ARM 1136 CPUs
1448d321b81SPeter Tyser      /ixp		Files specific to Intel XScale IXP CPUs
1458d321b81SPeter Tyser      /pxa		Files specific to Intel XScale PXA CPUs
1468d321b81SPeter Tyser      /sa1100		Files specific to Intel StrongARM SA1100 CPUs
1478d321b81SPeter Tyser    /lib		Architecture specific library files
1488d321b81SPeter Tyser  /avr32		Files generic to AVR32 architecture
1498d321b81SPeter Tyser    /cpu		CPU specific files
1508d321b81SPeter Tyser    /lib		Architecture specific library files
1518d321b81SPeter Tyser  /blackfin		Files generic to Analog Devices Blackfin architecture
1528d321b81SPeter Tyser    /cpu		CPU specific files
1538d321b81SPeter Tyser    /lib		Architecture specific library files
1548d321b81SPeter Tyser  /m68k			Files generic to m68k architecture
1558d321b81SPeter Tyser    /cpu		CPU specific files
1568d321b81SPeter Tyser      /mcf52x2		Files specific to Freescale ColdFire MCF52x2 CPUs
1578d321b81SPeter Tyser      /mcf5227x		Files specific to Freescale ColdFire MCF5227x CPUs
1588d321b81SPeter Tyser      /mcf532x		Files specific to Freescale ColdFire MCF5329 CPUs
1598d321b81SPeter Tyser      /mcf5445x		Files specific to Freescale ColdFire MCF5445x CPUs
1608d321b81SPeter Tyser      /mcf547x_8x	Files specific to Freescale ColdFire MCF547x_8x CPUs
1618d321b81SPeter Tyser    /lib		Architecture specific library files
1628d321b81SPeter Tyser  /microblaze		Files generic to microblaze architecture
1638d321b81SPeter Tyser    /cpu		CPU specific files
1648d321b81SPeter Tyser    /lib		Architecture specific library files
1658d321b81SPeter Tyser  /mips			Files generic to MIPS architecture
1668d321b81SPeter Tyser    /cpu		CPU specific files
16792bbd64eSDaniel Schwierzeck      /mips32		Files specific to MIPS32 CPUs
16880421fccSXiangfu Liu      /xburst		Files specific to Ingenic XBurst CPUs
1698d321b81SPeter Tyser    /lib		Architecture specific library files
170afc1ce82SMacpaul Lin  /nds32		Files generic to NDS32 architecture
171afc1ce82SMacpaul Lin    /cpu		CPU specific files
172afc1ce82SMacpaul Lin      /n1213		Files specific to Andes Technology N1213 CPUs
173afc1ce82SMacpaul Lin    /lib		Architecture specific library files
1748d321b81SPeter Tyser  /nios2		Files generic to Altera NIOS2 architecture
1758d321b81SPeter Tyser    /cpu		CPU specific files
1768d321b81SPeter Tyser    /lib		Architecture specific library files
17733c7731bSRobert P. J. Day  /openrisc		Files generic to OpenRISC architecture
17833c7731bSRobert P. J. Day    /cpu		CPU specific files
17933c7731bSRobert P. J. Day    /lib		Architecture specific library files
180a47a12beSStefan Roese  /powerpc		Files generic to PowerPC architecture
1818d321b81SPeter Tyser    /cpu		CPU specific files
1828d321b81SPeter Tyser      /74xx_7xx		Files specific to Freescale MPC74xx and 7xx CPUs
1838d321b81SPeter Tyser      /mpc5xx		Files specific to Freescale MPC5xx CPUs
1848d321b81SPeter Tyser      /mpc5xxx		Files specific to Freescale MPC5xxx CPUs
1858d321b81SPeter Tyser      /mpc8xx		Files specific to Freescale MPC8xx CPUs
1868d321b81SPeter Tyser      /mpc824x		Files specific to Freescale MPC824x CPUs
1878d321b81SPeter Tyser      /mpc8260		Files specific to Freescale MPC8260 CPUs
1888d321b81SPeter Tyser      /mpc85xx		Files specific to Freescale MPC85xx CPUs
1898d321b81SPeter Tyser      /ppc4xx		Files specific to AMCC PowerPC 4xx CPUs
1908d321b81SPeter Tyser    /lib		Architecture specific library files
1918d321b81SPeter Tyser  /sh			Files generic to SH architecture
1928d321b81SPeter Tyser    /cpu		CPU specific files
1938d321b81SPeter Tyser      /sh2		Files specific to sh2 CPUs
1948d321b81SPeter Tyser      /sh3		Files specific to sh3 CPUs
1958d321b81SPeter Tyser      /sh4		Files specific to sh4 CPUs
1968d321b81SPeter Tyser    /lib		Architecture specific library files
1978d321b81SPeter Tyser  /sparc		Files generic to SPARC architecture
1988d321b81SPeter Tyser    /cpu		CPU specific files
1998d321b81SPeter Tyser      /leon2		Files specific to Gaisler LEON2 SPARC CPU
2008d321b81SPeter Tyser      /leon3		Files specific to Gaisler LEON3 SPARC CPU
2018d321b81SPeter Tyser    /lib		Architecture specific library files
20233c7731bSRobert P. J. Day  /x86			Files generic to x86 architecture
20333c7731bSRobert P. J. Day    /cpu		CPU specific files
20433c7731bSRobert P. J. Day    /lib		Architecture specific library files
2058d321b81SPeter Tyser/api			Machine/arch independent API for external apps
2068d321b81SPeter Tyser/board			Board dependent files
2078d321b81SPeter Tyser/common			Misc architecture independent functions
2088d321b81SPeter Tyser/disk			Code for disk drive partition handling
2098d321b81SPeter Tyser/doc			Documentation (don't expect too much)
2108d321b81SPeter Tyser/drivers		Commonly used device drivers
21133c7731bSRobert P. J. Day/dts			Contains Makefile for building internal U-Boot fdt.
2128d321b81SPeter Tyser/examples		Example code for standalone applications, etc.
2138d321b81SPeter Tyser/fs			Filesystem code (cramfs, ext2, jffs2, etc.)
2148d321b81SPeter Tyser/include		Header Files
2158d321b81SPeter Tyser/lib			Files generic to all architectures
2168d321b81SPeter Tyser  /libfdt		Library files to support flattened device trees
2178d321b81SPeter Tyser  /lzma			Library files to support LZMA decompression
2188d321b81SPeter Tyser  /lzo			Library files to support LZO decompression
2198d321b81SPeter Tyser/net			Networking code
2208d321b81SPeter Tyser/post			Power On Self Test
22133c7731bSRobert P. J. Day/spl			Secondary Program Loader framework
2228d321b81SPeter Tyser/tools			Tools to build S-Record or U-Boot images, etc.
223c609719bSwdenk
224c609719bSwdenkSoftware Configuration:
225c609719bSwdenk=======================
226c609719bSwdenk
227c609719bSwdenkConfiguration is usually done using C preprocessor defines; the
228c609719bSwdenkrationale behind that is to avoid dead code whenever possible.
229c609719bSwdenk
230c609719bSwdenkThere are two classes of configuration variables:
231c609719bSwdenk
232c609719bSwdenk* Configuration _OPTIONS_:
233c609719bSwdenk  These are selectable by the user and have names beginning with
234c609719bSwdenk  "CONFIG_".
235c609719bSwdenk
236c609719bSwdenk* Configuration _SETTINGS_:
237c609719bSwdenk  These depend on the hardware etc. and should not be meddled with if
238c609719bSwdenk  you don't know what you're doing; they have names beginning with
2396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  "CONFIG_SYS_".
240c609719bSwdenk
241c609719bSwdenkLater we will add a configuration tool - probably similar to or even
242c609719bSwdenkidentical to what's used for the Linux kernel. Right now, we have to
243c609719bSwdenkdo the configuration by hand, which means creating some symbolic
244c609719bSwdenklinks and editing some configuration files. We use the TQM8xxL boards
245c609719bSwdenkas an example here.
246c609719bSwdenk
247c609719bSwdenk
248c609719bSwdenkSelection of Processor Architecture and Board Type:
249c609719bSwdenk---------------------------------------------------
250c609719bSwdenk
251c609719bSwdenkFor all supported boards there are ready-to-use default
252c609719bSwdenkconfigurations available; just type "make <board_name>_config".
253c609719bSwdenk
254c609719bSwdenkExample: For a TQM823L module type:
255c609719bSwdenk
256c609719bSwdenk	cd u-boot
257c609719bSwdenk	make TQM823L_config
258c609719bSwdenk
25911ccc33fSMarcel ZiswilerFor the Cogent platform, you need to specify the CPU type as well;
260c609719bSwdenke.g. "make cogent_mpc8xx_config". And also configure the cogent
261c609719bSwdenkdirectory according to the instructions in cogent/README.
262c609719bSwdenk
263c609719bSwdenk
264c609719bSwdenkConfiguration Options:
265c609719bSwdenk----------------------
266c609719bSwdenk
267c609719bSwdenkConfiguration depends on the combination of board and CPU type; all
268c609719bSwdenksuch information is kept in a configuration file
269c609719bSwdenk"include/configs/<board_name>.h".
270c609719bSwdenk
271c609719bSwdenkExample: For a TQM823L module, all configuration settings are in
272c609719bSwdenk"include/configs/TQM823L.h".
273c609719bSwdenk
274c609719bSwdenk
2757f6c2cbcSwdenkMany of the options are named exactly as the corresponding Linux
2767f6c2cbcSwdenkkernel configuration options. The intention is to make it easier to
2777f6c2cbcSwdenkbuild a config tool - later.
2787f6c2cbcSwdenk
2797f6c2cbcSwdenk
280c609719bSwdenkThe following options need to be configured:
281c609719bSwdenk
2822628114eSKim Phillips- CPU Type:	Define exactly one, e.g. CONFIG_MPC85XX.
283c609719bSwdenk
2842628114eSKim Phillips- Board Type:	Define exactly one, e.g. CONFIG_MPC8540ADS.
2856ccec449SWolfgang Denk
2866ccec449SWolfgang Denk- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
28709ea0de0SHaavard Skinnemoen		Define exactly one, e.g. CONFIG_ATSTK1002
288c609719bSwdenk
289c609719bSwdenk- CPU Module Type: (if CONFIG_COGENT is defined)
290c609719bSwdenk		Define exactly one of
291c609719bSwdenk		CONFIG_CMA286_60_OLD
292c609719bSwdenk--- FIXME --- not tested yet:
293c609719bSwdenk		CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
294c609719bSwdenk		CONFIG_CMA287_23, CONFIG_CMA287_50
295c609719bSwdenk
296c609719bSwdenk- Motherboard Type: (if CONFIG_COGENT is defined)
297c609719bSwdenk		Define exactly one of
298c609719bSwdenk		CONFIG_CMA101, CONFIG_CMA102
299c609719bSwdenk
300c609719bSwdenk- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
301c609719bSwdenk		Define one or more of
302c609719bSwdenk		CONFIG_CMA302
303c609719bSwdenk
304c609719bSwdenk- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
305c609719bSwdenk		Define one or more of
306c609719bSwdenk		CONFIG_LCD_HEARTBEAT	- update a character position on
30711ccc33fSMarcel Ziswiler					  the LCD display every second with
308c609719bSwdenk					  a "rotator" |\-/|\-/
309c609719bSwdenk
3102535d602Swdenk- Board flavour: (if CONFIG_MPC8260ADS is defined)
3112535d602Swdenk		CONFIG_ADSTYPE
3122535d602Swdenk		Possible values are:
3136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8260ADS	- original MPC8260ADS
3146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8266ADS	- MPC8266ADS
3156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_PQ2FADS	- PQ2FADS-ZU or PQ2FADS-VR
3166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8272ADS	- MPC8272ADS
3172535d602Swdenk
318cf946c6dSLei Wen- Marvell Family Member
319cf946c6dSLei Wen		CONFIG_SYS_MVFS		- define it if you want to enable
320cf946c6dSLei Wen					  multiple fs option at one time
321cf946c6dSLei Wen					  for marvell soc family
322cf946c6dSLei Wen
323c609719bSwdenk- MPC824X Family Member (if CONFIG_MPC824X is defined)
324c609719bSwdenk		Define exactly one of
325c609719bSwdenk		CONFIG_MPC8240, CONFIG_MPC8245
326c609719bSwdenk
32711ccc33fSMarcel Ziswiler- 8xx CPU Options: (if using an MPC8xx CPU)
32866ca92a5Swdenk		CONFIG_8xx_GCLK_FREQ	- deprecated: CPU clock if
32966ca92a5Swdenk					  get_gclk_freq() cannot work
3305da627a4Swdenk					  e.g. if there is no 32KHz
3315da627a4Swdenk					  reference PIT/RTC clock
33266ca92a5Swdenk		CONFIG_8xx_OSCLK	- PLL input clock (either EXTCLK
33366ca92a5Swdenk					  or XTAL/EXTAL)
334c609719bSwdenk
33566ca92a5Swdenk- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
3366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MIN
3376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MAX
33866ca92a5Swdenk		CONFIG_8xx_CPUCLK_DEFAULT
33975d1ea7fSwdenk			See doc/README.MPC866
34075d1ea7fSwdenk
3416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MEASURE_CPUCLK
34275d1ea7fSwdenk
34375d1ea7fSwdenk		Define this to measure the actual CPU clock instead
34475d1ea7fSwdenk		of relying on the correctness of the configured
34575d1ea7fSwdenk		values. Mostly useful for board bringup to make sure
34675d1ea7fSwdenk		the PLL is locked at the intended frequency. Note
34775d1ea7fSwdenk		that this requires a (stable) reference clock (32 kHz
3486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		RTC clock or CONFIG_SYS_8XX_XIN)
34975d1ea7fSwdenk
350506f3918SHeiko Schocher		CONFIG_SYS_DELAYED_ICACHE
351506f3918SHeiko Schocher
352506f3918SHeiko Schocher		Define this option if you want to enable the
353506f3918SHeiko Schocher		ICache only when Code runs from RAM.
354506f3918SHeiko Schocher
35566412c63SKumar Gala- 85xx CPU Options:
356ffd06e02SYork Sun		CONFIG_SYS_PPC64
357ffd06e02SYork Sun
358ffd06e02SYork Sun		Specifies that the core is a 64-bit PowerPC implementation (implements
359ffd06e02SYork Sun		the "64" category of the Power ISA). This is necessary for ePAPR
360ffd06e02SYork Sun		compliance, among other possible reasons.
361ffd06e02SYork Sun
36266412c63SKumar Gala		CONFIG_SYS_FSL_TBCLK_DIV
36366412c63SKumar Gala
36466412c63SKumar Gala		Defines the core time base clock divider ratio compared to the
36566412c63SKumar Gala		system clock.  On most PQ3 devices this is 8, on newer QorIQ
36666412c63SKumar Gala		devices it can be 16 or 32.  The ratio varies from SoC to Soc.
36766412c63SKumar Gala
3688f29084aSKumar Gala		CONFIG_SYS_FSL_PCIE_COMPAT
3698f29084aSKumar Gala
3708f29084aSKumar Gala		Defines the string to utilize when trying to match PCIe device
3718f29084aSKumar Gala		tree nodes for the given platform.
3728f29084aSKumar Gala
373afa6b551SPrabhakar Kushwaha		CONFIG_SYS_PPC_E500_DEBUG_TLB
374afa6b551SPrabhakar Kushwaha
375afa6b551SPrabhakar Kushwaha		Enables a temporary TLB entry to be used during boot to work
376afa6b551SPrabhakar Kushwaha		around limitations in e500v1 and e500v2 external debugger
377afa6b551SPrabhakar Kushwaha		support. This reduces the portions of the boot code where
378afa6b551SPrabhakar Kushwaha		breakpoints and single stepping do not work.  The value of this
379afa6b551SPrabhakar Kushwaha		symbol should be set to the TLB1 entry to be used for this
380afa6b551SPrabhakar Kushwaha		purpose.
381afa6b551SPrabhakar Kushwaha
38233eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510
38333eee330SScott Wood
38433eee330SScott Wood		Enables a workaround for erratum A004510.  If set,
38533eee330SScott Wood		then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
38633eee330SScott Wood		CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
38733eee330SScott Wood
38833eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
38933eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
39033eee330SScott Wood
39133eee330SScott Wood		Defines one or two SoC revisions (low 8 bits of SVR)
39233eee330SScott Wood		for which the A004510 workaround should be applied.
39333eee330SScott Wood
39433eee330SScott Wood		The rest of SVR is either not relevant to the decision
39533eee330SScott Wood		of whether the erratum is present (e.g. p2040 versus
39633eee330SScott Wood		p2041) or is implied by the build target, which controls
39733eee330SScott Wood		whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
39833eee330SScott Wood
39933eee330SScott Wood		See Freescale App Note 4493 for more information about
40033eee330SScott Wood		this erratum.
40133eee330SScott Wood
40274fa22edSPrabhakar Kushwaha		CONFIG_A003399_NOR_WORKAROUND
40374fa22edSPrabhakar Kushwaha		Enables a workaround for IFC erratum A003399. It is only
40474fa22edSPrabhakar Kushwaha		requred during NOR boot.
40574fa22edSPrabhakar Kushwaha
40633eee330SScott Wood		CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
40733eee330SScott Wood
40833eee330SScott Wood		This is the value to write into CCSR offset 0x18600
40933eee330SScott Wood		according to the A004510 workaround.
41033eee330SScott Wood
41164501c66SPriyanka Jain		CONFIG_SYS_FSL_DSP_DDR_ADDR
41264501c66SPriyanka Jain		This value denotes start offset of DDR memory which is
41364501c66SPriyanka Jain		connected exclusively to the DSP cores.
41464501c66SPriyanka Jain
415765b0bdbSPriyanka Jain		CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
416765b0bdbSPriyanka Jain		This value denotes start offset of M2 memory
417765b0bdbSPriyanka Jain		which is directly connected to the DSP core.
418765b0bdbSPriyanka Jain
41964501c66SPriyanka Jain		CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
42064501c66SPriyanka Jain		This value denotes start offset of M3 memory which is directly
42164501c66SPriyanka Jain		connected to the DSP core.
42264501c66SPriyanka Jain
423765b0bdbSPriyanka Jain		CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
424765b0bdbSPriyanka Jain		This value denotes start offset of DSP CCSR space.
425765b0bdbSPriyanka Jain
426cb93071bSYork Sun		CONFIG_SYS_FSL_DDR_EMU
427cb93071bSYork Sun		Specify emulator support for DDR. Some DDR features such as
428cb93071bSYork Sun		deskew training are not available.
429cb93071bSYork Sun
4306cb461b4SDaniel Schwierzeck- Generic CPU options:
4316cb461b4SDaniel Schwierzeck		CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
4326cb461b4SDaniel Schwierzeck
4336cb461b4SDaniel Schwierzeck		Defines the endianess of the CPU. Implementation of those
4346cb461b4SDaniel Schwierzeck		values is arch specific.
4356cb461b4SDaniel Schwierzeck
4360b953ffcSMarkus Klotzbuecher- Intel Monahans options:
4376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
4380b953ffcSMarkus Klotzbuecher
4390b953ffcSMarkus Klotzbuecher		Defines the Monahans run mode to oscillator
4400b953ffcSMarkus Klotzbuecher		ratio. Valid values are 8, 16, 24, 31. The core
4410b953ffcSMarkus Klotzbuecher		frequency is this value multiplied by 13 MHz.
4420b953ffcSMarkus Klotzbuecher
4436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
4440b953ffcSMarkus Klotzbuecher
4450b953ffcSMarkus Klotzbuecher		Defines the Monahans turbo mode to oscillator
4460b953ffcSMarkus Klotzbuecher		ratio. Valid values are 1 (default if undefined) and
4470b953ffcSMarkus Klotzbuecher		2. The core frequency as calculated above is multiplied
4480b953ffcSMarkus Klotzbuecher		by this value.
4490b953ffcSMarkus Klotzbuecher
45092bbd64eSDaniel Schwierzeck- MIPS CPU options:
45192bbd64eSDaniel Schwierzeck		CONFIG_SYS_INIT_SP_OFFSET
45292bbd64eSDaniel Schwierzeck
45392bbd64eSDaniel Schwierzeck		Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
45492bbd64eSDaniel Schwierzeck		pointer. This is needed for the temporary stack before
45592bbd64eSDaniel Schwierzeck		relocation.
45692bbd64eSDaniel Schwierzeck
45792bbd64eSDaniel Schwierzeck		CONFIG_SYS_MIPS_CACHE_MODE
45892bbd64eSDaniel Schwierzeck
45992bbd64eSDaniel Schwierzeck		Cache operation mode for the MIPS CPU.
46092bbd64eSDaniel Schwierzeck		See also arch/mips/include/asm/mipsregs.h.
46192bbd64eSDaniel Schwierzeck		Possible values are:
46292bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_NO_WA
46392bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_WA
46492bbd64eSDaniel Schwierzeck			CONF_CM_UNCACHED
46592bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_NONCOHERENT
46692bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_CE
46792bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_COW
46892bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_CUW
46992bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_ACCELERATED
47092bbd64eSDaniel Schwierzeck
47192bbd64eSDaniel Schwierzeck		CONFIG_SYS_XWAY_EBU_BOOTCFG
47292bbd64eSDaniel Schwierzeck
47392bbd64eSDaniel Schwierzeck		Special option for Lantiq XWAY SoCs for booting from NOR flash.
47492bbd64eSDaniel Schwierzeck		See also arch/mips/cpu/mips32/start.S.
47592bbd64eSDaniel Schwierzeck
47692bbd64eSDaniel Schwierzeck		CONFIG_XWAY_SWAP_BYTES
47792bbd64eSDaniel Schwierzeck
47892bbd64eSDaniel Schwierzeck		Enable compilation of tools/xway-swap-bytes needed for Lantiq
47992bbd64eSDaniel Schwierzeck		XWAY SoCs for booting from NOR flash. The U-Boot image needs to
48092bbd64eSDaniel Schwierzeck		be swapped if a flash programmer is used.
48192bbd64eSDaniel Schwierzeck
482b67d8816SChristian Riesch- ARM options:
483b67d8816SChristian Riesch		CONFIG_SYS_EXCEPTION_VECTORS_HIGH
484b67d8816SChristian Riesch
485b67d8816SChristian Riesch		Select high exception vectors of the ARM core, e.g., do not
486b67d8816SChristian Riesch		clear the V bit of the c1 register of CP15.
487b67d8816SChristian Riesch
4885356f545SAneesh V		CONFIG_SYS_THUMB_BUILD
4895356f545SAneesh V
4905356f545SAneesh V		Use this flag to build U-Boot using the Thumb instruction
4915356f545SAneesh V		set for ARM architectures. Thumb instruction set provides
4925356f545SAneesh V		better code density. For ARM architectures that support
4935356f545SAneesh V		Thumb2 this flag will result in Thumb2 code generated by
4945356f545SAneesh V		GCC.
4955356f545SAneesh V
496c5d4752cSStephen Warren		CONFIG_ARM_ERRATA_716044
4970678587fSStephen Warren		CONFIG_ARM_ERRATA_742230
4980678587fSStephen Warren		CONFIG_ARM_ERRATA_743622
4990678587fSStephen Warren		CONFIG_ARM_ERRATA_751472
5000678587fSStephen Warren
5010678587fSStephen Warren		If set, the workarounds for these ARM errata are applied early
5020678587fSStephen Warren		during U-Boot startup. Note that these options force the
5030678587fSStephen Warren		workarounds to be applied; no CPU-type/version detection
5040678587fSStephen Warren		exists, unlike the similar options in the Linux kernel. Do not
5050678587fSStephen Warren		set these options unless they apply!
5060678587fSStephen Warren
507795659dcSStephen Warren- CPU timer options:
508795659dcSStephen Warren		CONFIG_SYS_HZ
509795659dcSStephen Warren
510795659dcSStephen Warren		The frequency of the timer returned by get_timer().
511795659dcSStephen Warren		get_timer() must operate in milliseconds and this CONFIG
512795659dcSStephen Warren		option must be set to 1000.
513795659dcSStephen Warren
5145da627a4Swdenk- Linux Kernel Interface:
515c609719bSwdenk		CONFIG_CLOCKS_IN_MHZ
516c609719bSwdenk
517c609719bSwdenk		U-Boot stores all clock information in Hz
518c609719bSwdenk		internally. For binary compatibility with older Linux
519c609719bSwdenk		kernels (which expect the clocks passed in the
520c609719bSwdenk		bd_info data to be in MHz) the environment variable
521c609719bSwdenk		"clocks_in_mhz" can be defined so that U-Boot
522c609719bSwdenk		converts clock data to MHZ before passing it to the
523c609719bSwdenk		Linux kernel.
524c609719bSwdenk		When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
525c609719bSwdenk		"clocks_in_mhz=1" is automatically included in the
526c609719bSwdenk		default environment.
527c609719bSwdenk
5285da627a4Swdenk		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]
5295da627a4Swdenk
53011ccc33fSMarcel Ziswiler		When transferring memsize parameter to linux, some versions
5315da627a4Swdenk		expect it to be in bytes, others in MB.
5325da627a4Swdenk		Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
5335da627a4Swdenk
534fec6d9eeSGerald Van Baren		CONFIG_OF_LIBFDT
535f57f70aaSWolfgang Denk
536f57f70aaSWolfgang Denk		New kernel versions are expecting firmware settings to be
537213bf8c8SGerald Van Baren		passed using flattened device trees (based on open firmware
538213bf8c8SGerald Van Baren		concepts).
539213bf8c8SGerald Van Baren
540213bf8c8SGerald Van Baren		CONFIG_OF_LIBFDT
541213bf8c8SGerald Van Baren		 * New libfdt-based support
542213bf8c8SGerald Van Baren		 * Adds the "fdt" command
5433bb342fcSKim Phillips		 * The bootm command automatically updates the fdt
544213bf8c8SGerald Van Baren
545b55ae402SMarcel Ziswiler		OF_CPU - The proper name of the cpus node (only required for
546b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
547b55ae402SMarcel Ziswiler		OF_SOC - The proper name of the soc node (only required for
548b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
549f57f70aaSWolfgang Denk		OF_TBCLK - The timebase frequency.
550c2871f03SKumar Gala		OF_STDOUT_PATH - The path to the console device
551f57f70aaSWolfgang Denk
55211ccc33fSMarcel Ziswiler		boards with QUICC Engines require OF_QE to set UCC MAC
55311ccc33fSMarcel Ziswiler		addresses
5543bb342fcSKim Phillips
5554e253137SKumar Gala		CONFIG_OF_BOARD_SETUP
5564e253137SKumar Gala
5574e253137SKumar Gala		Board code has addition modification that it wants to make
5584e253137SKumar Gala		to the flat device tree before handing it off to the kernel
5596705d81eSwdenk
5600267768eSMatthew McClintock		CONFIG_OF_BOOT_CPU
5610267768eSMatthew McClintock
56211ccc33fSMarcel Ziswiler		This define fills in the correct boot CPU in the boot
5630267768eSMatthew McClintock		param header, the default value is zero if undefined.
5640267768eSMatthew McClintock
5653887c3fbSHeiko Schocher		CONFIG_OF_IDE_FIXUP
5663887c3fbSHeiko Schocher
5673887c3fbSHeiko Schocher		U-Boot can detect if an IDE device is present or not.
5683887c3fbSHeiko Schocher		If not, and this new config option is activated, U-Boot
5693887c3fbSHeiko Schocher		removes the ATA node from the DTS before booting Linux,
5703887c3fbSHeiko Schocher		so the Linux IDE driver does not probe the device and
5713887c3fbSHeiko Schocher		crash. This is needed for buggy hardware (uc101) where
5723887c3fbSHeiko Schocher		no pull down resistor is connected to the signal IDE5V_DD7.
5733887c3fbSHeiko Schocher
5747eb29398SIgor Grinberg		CONFIG_MACH_TYPE	[relevant for ARM only][mandatory]
5757eb29398SIgor Grinberg
5767eb29398SIgor Grinberg		This setting is mandatory for all boards that have only one
5777eb29398SIgor Grinberg		machine type and must be used to specify the machine type
5787eb29398SIgor Grinberg		number as it appears in the ARM machine registry
5797eb29398SIgor Grinberg		(see http://www.arm.linux.org.uk/developer/machines/).
5807eb29398SIgor Grinberg		Only boards that have multiple machine types supported
5817eb29398SIgor Grinberg		in a single configuration file and the machine type is
5827eb29398SIgor Grinberg		runtime discoverable, do not have to use this setting.
5837eb29398SIgor Grinberg
5840b2f4ecaSNiklaus Giger- vxWorks boot parameters:
5850b2f4ecaSNiklaus Giger
5860b2f4ecaSNiklaus Giger		bootvx constructs a valid bootline using the following
5870b2f4ecaSNiklaus Giger		environments variables: bootfile, ipaddr, serverip, hostname.
5880b2f4ecaSNiklaus Giger		It loads the vxWorks image pointed bootfile.
5890b2f4ecaSNiklaus Giger
5900b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
5910b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
5920b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
5930b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
5940b2f4ecaSNiklaus Giger
5950b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_ADD_PARAMS
5960b2f4ecaSNiklaus Giger
5970b2f4ecaSNiklaus Giger		Add it at the end of the bootline. E.g "u=username pw=secret"
5980b2f4ecaSNiklaus Giger
5990b2f4ecaSNiklaus Giger		Note: If a "bootargs" environment is defined, it will overwride
6000b2f4ecaSNiklaus Giger		the defaults discussed just above.
6010b2f4ecaSNiklaus Giger
6022c451f78SAneesh V- Cache Configuration:
6032c451f78SAneesh V		CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
6042c451f78SAneesh V		CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
6052c451f78SAneesh V		CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
6062c451f78SAneesh V
60793bc2193SAneesh V- Cache Configuration for ARM:
60893bc2193SAneesh V		CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
60993bc2193SAneesh V				      controller
61093bc2193SAneesh V		CONFIG_SYS_PL310_BASE - Physical base address of PL310
61193bc2193SAneesh V					controller register space
61293bc2193SAneesh V
6136705d81eSwdenk- Serial Ports:
61448d0192fSAndreas Engel		CONFIG_PL010_SERIAL
6156705d81eSwdenk
6166705d81eSwdenk		Define this if you want support for Amba PrimeCell PL010 UARTs.
6176705d81eSwdenk
61848d0192fSAndreas Engel		CONFIG_PL011_SERIAL
6196705d81eSwdenk
6206705d81eSwdenk		Define this if you want support for Amba PrimeCell PL011 UARTs.
6216705d81eSwdenk
6226705d81eSwdenk		CONFIG_PL011_CLOCK
6236705d81eSwdenk
6246705d81eSwdenk		If you have Amba PrimeCell PL011 UARTs, set this variable to
6256705d81eSwdenk		the clock speed of the UARTs.
6266705d81eSwdenk
6276705d81eSwdenk		CONFIG_PL01x_PORTS
6286705d81eSwdenk
6296705d81eSwdenk		If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
6306705d81eSwdenk		define this to a list of base addresses for each (supported)
6316705d81eSwdenk		port. See e.g. include/configs/versatile.h
6326705d81eSwdenk
633910f1ae3SJohn Rigby		CONFIG_PL011_SERIAL_RLCR
634910f1ae3SJohn Rigby
635910f1ae3SJohn Rigby		Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
636910f1ae3SJohn Rigby		have separate receive and transmit line control registers.  Set
637910f1ae3SJohn Rigby		this variable to initialize the extra register.
638910f1ae3SJohn Rigby
639910f1ae3SJohn Rigby		CONFIG_PL011_SERIAL_FLUSH_ON_INIT
640910f1ae3SJohn Rigby
641910f1ae3SJohn Rigby		On some platforms (e.g. U8500) U-Boot is loaded by a second stage
642910f1ae3SJohn Rigby		boot loader that has already initialized the UART.  Define this
643910f1ae3SJohn Rigby		variable to flush the UART at init time.
644910f1ae3SJohn Rigby
6456705d81eSwdenk
646c609719bSwdenk- Console Interface:
647c609719bSwdenk		Depending on board, define exactly one serial port
648c609719bSwdenk		(like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
649c609719bSwdenk		CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
650c609719bSwdenk		console by defining CONFIG_8xx_CONS_NONE
651c609719bSwdenk
652c609719bSwdenk		Note: if CONFIG_8xx_CONS_NONE is defined, the serial
653c609719bSwdenk		port routines must be defined elsewhere
654c609719bSwdenk		(i.e. serial_init(), serial_getc(), ...)
655c609719bSwdenk
656c609719bSwdenk		CONFIG_CFB_CONSOLE
657c609719bSwdenk		Enables console device for a color framebuffer. Needs following
658c53043b7SWolfgang Denk		defines (cf. smiLynxEM, i8042)
659c609719bSwdenk			VIDEO_FB_LITTLE_ENDIAN	graphic memory organisation
660c609719bSwdenk						(default big endian)
661c609719bSwdenk			VIDEO_HW_RECTFILL	graphic chip supports
662c609719bSwdenk						rectangle fill
663c609719bSwdenk						(cf. smiLynxEM)
664c609719bSwdenk			VIDEO_HW_BITBLT		graphic chip supports
665c609719bSwdenk						bit-blit (cf. smiLynxEM)
666c609719bSwdenk			VIDEO_VISIBLE_COLS	visible pixel columns
667c609719bSwdenk						(cols=pitch)
668c609719bSwdenk			VIDEO_VISIBLE_ROWS	visible pixel rows
669c609719bSwdenk			VIDEO_PIXEL_SIZE	bytes per pixel
670c609719bSwdenk			VIDEO_DATA_FORMAT	graphic data format
671c609719bSwdenk						(0-5, cf. cfb_console.c)
672c609719bSwdenk			VIDEO_FB_ADRS		framebuffer address
673c609719bSwdenk			VIDEO_KBD_INIT_FCT	keyboard int fct
674c609719bSwdenk						(i.e. i8042_kbd_init())
675c609719bSwdenk			VIDEO_TSTC_FCT		test char fct
676c609719bSwdenk						(i.e. i8042_tstc)
677c609719bSwdenk			VIDEO_GETC_FCT		get char fct
678c609719bSwdenk						(i.e. i8042_getc)
679c609719bSwdenk			CONFIG_CONSOLE_CURSOR	cursor drawing on/off
680c609719bSwdenk						(requires blink timer
681c609719bSwdenk						cf. i8042.c)
6826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
683c609719bSwdenk			CONFIG_CONSOLE_TIME	display time/date info in
684c609719bSwdenk						upper right corner
685602ad3b3SJon Loeliger						(requires CONFIG_CMD_DATE)
686c609719bSwdenk			CONFIG_VIDEO_LOGO	display Linux logo in
687c609719bSwdenk						upper left corner
688a6c7ad2fSwdenk			CONFIG_VIDEO_BMP_LOGO	use bmp_logo.h instead of
689a6c7ad2fSwdenk						linux_logo.h for logo.
690a6c7ad2fSwdenk						Requires CONFIG_VIDEO_LOGO
691c609719bSwdenk			CONFIG_CONSOLE_EXTRA_INFO
69211ccc33fSMarcel Ziswiler						additional board info beside
693c609719bSwdenk						the logo
694c609719bSwdenk
69533a35bbbSPali Rohár		When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
69633a35bbbSPali Rohár		a limited number of ANSI escape sequences (cursor control,
69733a35bbbSPali Rohár		erase functions and limited graphics rendition control).
69833a35bbbSPali Rohár
699c609719bSwdenk		When CONFIG_CFB_CONSOLE is defined, video console is
700c609719bSwdenk		default i/o. Serial console can be forced with
701c609719bSwdenk		environment 'console=serial'.
702c609719bSwdenk
703a3ad8e26Swdenk		When CONFIG_SILENT_CONSOLE is defined, all console
704a3ad8e26Swdenk		messages (by U-Boot and Linux!) can be silenced with
705a3ad8e26Swdenk		the "silent" environment variable. See
706a3ad8e26Swdenk		doc/README.silent for more information.
707a3ad8e26Swdenk
708c609719bSwdenk- Console Baudrate:
709c609719bSwdenk		CONFIG_BAUDRATE - in bps
710c609719bSwdenk		Select one of the baudrates listed in
7116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
7126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
713c609719bSwdenk
714c92fac91SHeiko Schocher- Console Rx buffer length
715c92fac91SHeiko Schocher		With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
716c92fac91SHeiko Schocher		the maximum receive buffer length for the SMC.
7172b3f12c2SHeiko Schocher		This option is actual only for 82xx and 8xx possible.
718c92fac91SHeiko Schocher		If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
719c92fac91SHeiko Schocher		must be defined, to setup the maximum idle timeout for
720c92fac91SHeiko Schocher		the SMC.
721c92fac91SHeiko Schocher
7229558b48aSGraeme Russ- Pre-Console Buffer:
7239558b48aSGraeme Russ		Prior to the console being initialised (i.e. serial UART
7249558b48aSGraeme Russ		initialised etc) all console output is silently discarded.
7259558b48aSGraeme Russ		Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
7269558b48aSGraeme Russ		buffer any console messages prior to the console being
7279558b48aSGraeme Russ		initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
7289558b48aSGraeme Russ		bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
7299558b48aSGraeme Russ		a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
7309558b48aSGraeme Russ		bytes are output before the console is initialised, the
7319558b48aSGraeme Russ		earlier bytes are discarded.
7329558b48aSGraeme Russ
7339558b48aSGraeme Russ		'Sane' compilers will generate smaller code if
7349558b48aSGraeme Russ		CONFIG_PRE_CON_BUF_SZ is a power of 2
7359558b48aSGraeme Russ
736046a37bdSSonny Rao- Safe printf() functions
737046a37bdSSonny Rao		Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
738046a37bdSSonny Rao		the printf() functions. These are defined in
739046a37bdSSonny Rao		include/vsprintf.h and include snprintf(), vsnprintf() and
740046a37bdSSonny Rao		so on. Code size increase is approximately 300-500 bytes.
741046a37bdSSonny Rao		If this option is not given then these functions will
742046a37bdSSonny Rao		silently discard their buffer size argument - this means
743046a37bdSSonny Rao		you are not getting any overflow checking in this case.
744046a37bdSSonny Rao
745c609719bSwdenk- Boot Delay:	CONFIG_BOOTDELAY - in seconds
746c609719bSwdenk		Delay before automatically booting the default image;
747c609719bSwdenk		set to -1 to disable autoboot.
74893d7212fSJoe Hershberger		set to -2 to autoboot with no delay and not check for abort
74993d7212fSJoe Hershberger		(even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
750c609719bSwdenk
751c609719bSwdenk		See doc/README.autoboot for these options that
752c609719bSwdenk		work with CONFIG_BOOTDELAY. None are required.
753c609719bSwdenk		CONFIG_BOOT_RETRY_TIME
754c609719bSwdenk		CONFIG_BOOT_RETRY_MIN
755c609719bSwdenk		CONFIG_AUTOBOOT_KEYED
756c609719bSwdenk		CONFIG_AUTOBOOT_PROMPT
757c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR
758c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR
759c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR2
760c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR2
761c609719bSwdenk		CONFIG_ZERO_BOOTDELAY_CHECK
762c609719bSwdenk		CONFIG_RESET_TO_RETRY
763c609719bSwdenk
764c609719bSwdenk- Autoboot Command:
765c609719bSwdenk		CONFIG_BOOTCOMMAND
766c609719bSwdenk		Only needed when CONFIG_BOOTDELAY is enabled;
767c609719bSwdenk		define a command string that is automatically executed
768c609719bSwdenk		when no character is read on the console interface
769c609719bSwdenk		within "Boot Delay" after reset.
770c609719bSwdenk
771c609719bSwdenk		CONFIG_BOOTARGS
772c609719bSwdenk		This can be used to pass arguments to the bootm
773c609719bSwdenk		command. The value of CONFIG_BOOTARGS goes into the
774c609719bSwdenk		environment value "bootargs".
775c609719bSwdenk
776c609719bSwdenk		CONFIG_RAMBOOT and CONFIG_NFSBOOT
777c609719bSwdenk		The value of these goes into the environment as
778c609719bSwdenk		"ramboot" and "nfsboot" respectively, and can be used
779c609719bSwdenk		as a convenience, when switching between booting from
78011ccc33fSMarcel Ziswiler		RAM and NFS.
781c609719bSwdenk
782c609719bSwdenk- Pre-Boot Commands:
783c609719bSwdenk		CONFIG_PREBOOT
784c609719bSwdenk
785c609719bSwdenk		When this option is #defined, the existence of the
786c609719bSwdenk		environment variable "preboot" will be checked
787c609719bSwdenk		immediately before starting the CONFIG_BOOTDELAY
788c609719bSwdenk		countdown and/or running the auto-boot command resp.
789c609719bSwdenk		entering interactive mode.
790c609719bSwdenk
791c609719bSwdenk		This feature is especially useful when "preboot" is
792c609719bSwdenk		automatically generated or modified. For an example
793c609719bSwdenk		see the LWMON board specific code: here "preboot" is
794c609719bSwdenk		modified when the user holds down a certain
795c609719bSwdenk		combination of keys on the (special) keyboard when
796c609719bSwdenk		booting the systems
797c609719bSwdenk
798c609719bSwdenk- Serial Download Echo Mode:
799c609719bSwdenk		CONFIG_LOADS_ECHO
800c609719bSwdenk		If defined to 1, all characters received during a
801c609719bSwdenk		serial download (using the "loads" command) are
802c609719bSwdenk		echoed back. This might be needed by some terminal
803c609719bSwdenk		emulations (like "cu"), but may as well just take
804c609719bSwdenk		time on others. This setting #define's the initial
805c609719bSwdenk		value of the "loads_echo" environment variable.
806c609719bSwdenk
807602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
808c609719bSwdenk		CONFIG_KGDB_BAUDRATE
809c609719bSwdenk		Select one of the baudrates listed in
8106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
811c609719bSwdenk
812c609719bSwdenk- Monitor Functions:
813602ad3b3SJon Loeliger		Monitor commands can be included or excluded
814602ad3b3SJon Loeliger		from the build by using the #include files
815c6c621bdSStephen Warren		<config_cmd_all.h> and #undef'ing unwanted
816c6c621bdSStephen Warren		commands, or using <config_cmd_default.h>
817602ad3b3SJon Loeliger		and augmenting with additional #define's
818602ad3b3SJon Loeliger		for wanted commands.
819c609719bSwdenk
820602ad3b3SJon Loeliger		The default command configuration includes all commands
821602ad3b3SJon Loeliger		except those marked below with a "*".
822602ad3b3SJon Loeliger
823602ad3b3SJon Loeliger		CONFIG_CMD_ASKENV	* ask for env variable
824602ad3b3SJon Loeliger		CONFIG_CMD_BDI		  bdinfo
825602ad3b3SJon Loeliger		CONFIG_CMD_BEDBUG	* Include BedBug Debugger
826602ad3b3SJon Loeliger		CONFIG_CMD_BMP		* BMP support
827602ad3b3SJon Loeliger		CONFIG_CMD_BSP		* Board specific commands
828602ad3b3SJon Loeliger		CONFIG_CMD_BOOTD	  bootd
829602ad3b3SJon Loeliger		CONFIG_CMD_CACHE	* icache, dcache
830602ad3b3SJon Loeliger		CONFIG_CMD_CONSOLE	  coninfo
831710b9938SMike Frysinger		CONFIG_CMD_CRC32	* crc32
832602ad3b3SJon Loeliger		CONFIG_CMD_DATE		* support for RTC, date/time...
833602ad3b3SJon Loeliger		CONFIG_CMD_DHCP		* DHCP support
834602ad3b3SJon Loeliger		CONFIG_CMD_DIAG		* Diagnostics
835a7c93104SPeter Tyser		CONFIG_CMD_DS4510	* ds4510 I2C gpio commands
836a7c93104SPeter Tyser		CONFIG_CMD_DS4510_INFO	* ds4510 I2C info command
837a7c93104SPeter Tyser		CONFIG_CMD_DS4510_MEM	* ds4510 I2C eeprom/sram commansd
838a7c93104SPeter Tyser		CONFIG_CMD_DS4510_RST	* ds4510 I2C rst command
839602ad3b3SJon Loeliger		CONFIG_CMD_DTT		* Digital Therm and Thermostat
840602ad3b3SJon Loeliger		CONFIG_CMD_ECHO		  echo arguments
841246c6922SPeter Tyser		CONFIG_CMD_EDITENV	  edit env variable
842602ad3b3SJon Loeliger		CONFIG_CMD_EEPROM	* EEPROM read/write support
843602ad3b3SJon Loeliger		CONFIG_CMD_ELF		* bootelf, bootvx
8445e2b3e0cSJoe Hershberger		CONFIG_CMD_ENV_CALLBACK	* display details about env callbacks
845fffad71bSJoe Hershberger		CONFIG_CMD_ENV_FLAGS	* display details about env flags
8460c79cda0SMike Frysinger		CONFIG_CMD_EXPORTENV	* export the environment
84703e2ecf6SStephen Warren		CONFIG_CMD_EXT2		* ext2 command support
84803e2ecf6SStephen Warren		CONFIG_CMD_EXT4		* ext4 command support
849bdab39d3SMike Frysinger		CONFIG_CMD_SAVEENV	  saveenv
850602ad3b3SJon Loeliger		CONFIG_CMD_FDC		* Floppy Disk Support
85103e2ecf6SStephen Warren		CONFIG_CMD_FAT		* FAT command support
852602ad3b3SJon Loeliger		CONFIG_CMD_FDOS		* Dos diskette Support
853602ad3b3SJon Loeliger		CONFIG_CMD_FLASH	  flinfo, erase, protect
854602ad3b3SJon Loeliger		CONFIG_CMD_FPGA		  FPGA device initialization support
8554d98b5c8SVincent Stehlé		CONFIG_CMD_FUSE		* Device fuse support
85653fdc7efSAnton Staaf		CONFIG_CMD_GETTIME	* Get time since boot
857a641b979SMike Frysinger		CONFIG_CMD_GO		* the 'go' command (exec code)
858a000b795SKim Phillips		CONFIG_CMD_GREPENV	* search environment
859bf36c5d5SSimon Glass		CONFIG_CMD_HASH		* calculate hash / digest
860602ad3b3SJon Loeliger		CONFIG_CMD_HWFLOW	* RTS/CTS hw flow control
861602ad3b3SJon Loeliger		CONFIG_CMD_I2C		* I2C serial bus support
862602ad3b3SJon Loeliger		CONFIG_CMD_IDE		* IDE harddisk support
863602ad3b3SJon Loeliger		CONFIG_CMD_IMI		  iminfo
8648fdf1e0fSVipin Kumar		CONFIG_CMD_IMLS		  List all images found in NOR flash
8654d98b5c8SVincent Stehlé		CONFIG_CMD_IMLS_NAND	* List all images found in NAND flash
866602ad3b3SJon Loeliger		CONFIG_CMD_IMMAP	* IMMR dump support
8670c79cda0SMike Frysinger		CONFIG_CMD_IMPORTENV	* import an environment
868c167cc02SJoe Hershberger		CONFIG_CMD_INI		* import data from an ini file into the env
869602ad3b3SJon Loeliger		CONFIG_CMD_IRQ		* irqinfo
870602ad3b3SJon Loeliger		CONFIG_CMD_ITEST	  Integer/string test of 2 values
871602ad3b3SJon Loeliger		CONFIG_CMD_JFFS2	* JFFS2 Support
872602ad3b3SJon Loeliger		CONFIG_CMD_KGDB		* kgdb
8734d98b5c8SVincent Stehlé		CONFIG_CMD_LDRINFO	* ldrinfo (display Blackfin loader)
874d22c338eSJoe Hershberger		CONFIG_CMD_LINK_LOCAL	* link-local IP address auto-configuration
875d22c338eSJoe Hershberger					  (169.254.*.*)
876602ad3b3SJon Loeliger		CONFIG_CMD_LOADB	  loadb
877602ad3b3SJon Loeliger		CONFIG_CMD_LOADS	  loads
8784d98b5c8SVincent Stehlé		CONFIG_CMD_MD5SUM	* print md5 message digest
87902c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
88015a33e49SSimon Glass		CONFIG_CMD_MEMINFO	* Display detailed memory information
881602ad3b3SJon Loeliger		CONFIG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
882a2681707SWolfgang Denk					  loop, loopw
8834d98b5c8SVincent Stehlé		CONFIG_CMD_MEMTEST	* mtest
884602ad3b3SJon Loeliger		CONFIG_CMD_MISC		  Misc functions like sleep etc
885602ad3b3SJon Loeliger		CONFIG_CMD_MMC		* MMC memory mapped support
886602ad3b3SJon Loeliger		CONFIG_CMD_MII		* MII utility commands
88768d7d651SStefan Roese		CONFIG_CMD_MTDPARTS	* MTD partition support
888602ad3b3SJon Loeliger		CONFIG_CMD_NAND		* NAND support
889602ad3b3SJon Loeliger		CONFIG_CMD_NET		  bootp, tftpboot, rarpboot
8904d98b5c8SVincent Stehlé		CONFIG_CMD_NFS		  NFS support
891e92739d3SPeter Tyser		CONFIG_CMD_PCA953X	* PCA953x I2C gpio commands
892e92739d3SPeter Tyser		CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
893602ad3b3SJon Loeliger		CONFIG_CMD_PCI		* pciinfo
894602ad3b3SJon Loeliger		CONFIG_CMD_PCMCIA		* PCMCIA support
895602ad3b3SJon Loeliger		CONFIG_CMD_PING		* send ICMP ECHO_REQUEST to network
896602ad3b3SJon Loeliger					  host
897602ad3b3SJon Loeliger		CONFIG_CMD_PORTIO	* Port I/O
898ff048ea9SKenneth Waters		CONFIG_CMD_READ		* Read raw data from partition
899602ad3b3SJon Loeliger		CONFIG_CMD_REGINFO	* Register dump
900602ad3b3SJon Loeliger		CONFIG_CMD_RUN		  run command in env variable
901d304931fSSimon Glass		CONFIG_CMD_SANDBOX	* sb command to access sandbox features
902602ad3b3SJon Loeliger		CONFIG_CMD_SAVES	* save S record dump
903602ad3b3SJon Loeliger		CONFIG_CMD_SCSI		* SCSI Support
904602ad3b3SJon Loeliger		CONFIG_CMD_SDRAM	* print SDRAM configuration information
905602ad3b3SJon Loeliger					  (requires CONFIG_CMD_I2C)
906602ad3b3SJon Loeliger		CONFIG_CMD_SETGETDCR	  Support for DCR Register access
907602ad3b3SJon Loeliger					  (4xx only)
908f61ec45eSEric Nelson		CONFIG_CMD_SF		* Read/write/erase SPI NOR flash
9094d98b5c8SVincent Stehlé		CONFIG_CMD_SHA1SUM	* print sha1 memory digest
91002c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY)
9117d861d95SBob Liu		CONFIG_CMD_SOFTSWITCH	* Soft switch setting command for BF60x
91274de7aefSWolfgang Denk		CONFIG_CMD_SOURCE	  "source" command Support
913602ad3b3SJon Loeliger		CONFIG_CMD_SPI		* SPI serial bus support
9147a83af07SLuca Ceresoli		CONFIG_CMD_TFTPSRV	* TFTP transfer in server mode
9151fb7cd49SSimon Glass		CONFIG_CMD_TFTPPUT	* TFTP put command (upload)
916da83bcd7SJoe Hershberger		CONFIG_CMD_TIME		* run command and report execution time (ARM specific)
917da83bcd7SJoe Hershberger		CONFIG_CMD_TIMER	* access to the system tick timer
918602ad3b3SJon Loeliger		CONFIG_CMD_USB		* USB support
919602ad3b3SJon Loeliger		CONFIG_CMD_CDP		* Cisco Discover Protocol support
920c8339f51SMarek Vasut		CONFIG_CMD_MFSL		* Microblaze FSL support
9214d98b5c8SVincent Stehlé		CONFIG_CMD_XIMG		  Load part of Multi Image
922c609719bSwdenk
923c609719bSwdenk
924c609719bSwdenk		EXAMPLE: If you want all functions except of network
925c609719bSwdenk		support you can write:
926c609719bSwdenk
927602ad3b3SJon Loeliger		#include "config_cmd_all.h"
928602ad3b3SJon Loeliger		#undef CONFIG_CMD_NET
929c609719bSwdenk
930213bf8c8SGerald Van Baren	Other Commands:
931213bf8c8SGerald Van Baren		fdt (flattened device tree) command: CONFIG_OF_LIBFDT
932c609719bSwdenk
933c609719bSwdenk	Note:	Don't enable the "icache" and "dcache" commands
934602ad3b3SJon Loeliger		(configuration option CONFIG_CMD_CACHE) unless you know
935c609719bSwdenk		what you (and your U-Boot users) are doing. Data
936c609719bSwdenk		cache cannot be enabled on systems like the 8xx or
937c609719bSwdenk		8260 (where accesses to the IMMR region must be
938c609719bSwdenk		uncached), and it cannot be disabled on all other
939c609719bSwdenk		systems where we (mis-) use the data cache to hold an
940c609719bSwdenk		initial stack and some data.
941c609719bSwdenk
942c609719bSwdenk
943c609719bSwdenk		XXX - this list needs to get updated!
944c609719bSwdenk
945a5ecbe62SWolfgang Denk- Regular expression support:
946a5ecbe62SWolfgang Denk		CONFIG_REGEX
947a5ecbe62SWolfgang Denk		If this variable is defined, U-Boot is linked against
948a5ecbe62SWolfgang Denk		the SLRE (Super Light Regular Expression) library,
949a5ecbe62SWolfgang Denk		which adds regex support to some commands, as for
950a5ecbe62SWolfgang Denk		example "env grep" and "setexpr".
951a5ecbe62SWolfgang Denk
95245ba8077SSimon Glass- Device tree:
95345ba8077SSimon Glass		CONFIG_OF_CONTROL
95445ba8077SSimon Glass		If this variable is defined, U-Boot will use a device tree
95545ba8077SSimon Glass		to configure its devices, instead of relying on statically
95645ba8077SSimon Glass		compiled #defines in the board file. This option is
95745ba8077SSimon Glass		experimental and only available on a few boards. The device
95845ba8077SSimon Glass		tree is available in the global data as gd->fdt_blob.
95945ba8077SSimon Glass
9602c0f79e4SSimon Glass		U-Boot needs to get its device tree from somewhere. This can
9612c0f79e4SSimon Glass		be done using one of the two options below:
962bbb0b128SSimon Glass
963bbb0b128SSimon Glass		CONFIG_OF_EMBED
964bbb0b128SSimon Glass		If this variable is defined, U-Boot will embed a device tree
965bbb0b128SSimon Glass		binary in its image. This device tree file should be in the
966bbb0b128SSimon Glass		board directory and called <soc>-<board>.dts. The binary file
967bbb0b128SSimon Glass		is then picked up in board_init_f() and made available through
968bbb0b128SSimon Glass		the global data structure as gd->blob.
96945ba8077SSimon Glass
9702c0f79e4SSimon Glass		CONFIG_OF_SEPARATE
9712c0f79e4SSimon Glass		If this variable is defined, U-Boot will build a device tree
9722c0f79e4SSimon Glass		binary. It will be called u-boot.dtb. Architecture-specific
9732c0f79e4SSimon Glass		code will locate it at run-time. Generally this works by:
9742c0f79e4SSimon Glass
9752c0f79e4SSimon Glass			cat u-boot.bin u-boot.dtb >image.bin
9762c0f79e4SSimon Glass
9772c0f79e4SSimon Glass		and in fact, U-Boot does this for you, creating a file called
9782c0f79e4SSimon Glass		u-boot-dtb.bin which is useful in the common case. You can
9792c0f79e4SSimon Glass		still use the individual files if you need something more
9802c0f79e4SSimon Glass		exotic.
9812c0f79e4SSimon Glass
982c609719bSwdenk- Watchdog:
983c609719bSwdenk		CONFIG_WATCHDOG
984c609719bSwdenk		If this variable is defined, it enables watchdog
9856abe6fb6SDetlev Zundel		support for the SoC. There must be support in the SoC
9866abe6fb6SDetlev Zundel		specific code for a watchdog. For the 8xx and 8260
9876abe6fb6SDetlev Zundel		CPUs, the SIU Watchdog feature is enabled in the SYPCR
9886abe6fb6SDetlev Zundel		register.  When supported for a specific SoC is
9896abe6fb6SDetlev Zundel		available, then no further board specific code should
9906abe6fb6SDetlev Zundel		be needed to use it.
9916abe6fb6SDetlev Zundel
9926abe6fb6SDetlev Zundel		CONFIG_HW_WATCHDOG
9936abe6fb6SDetlev Zundel		When using a watchdog circuitry external to the used
9946abe6fb6SDetlev Zundel		SoC, then define this variable and provide board
9956abe6fb6SDetlev Zundel		specific code for the "hw_watchdog_reset" function.
996c609719bSwdenk
997c1551ea8Sstroese- U-Boot Version:
998c1551ea8Sstroese		CONFIG_VERSION_VARIABLE
999c1551ea8Sstroese		If this variable is defined, an environment variable
1000c1551ea8Sstroese		named "ver" is created by U-Boot showing the U-Boot
1001c1551ea8Sstroese		version as printed by the "version" command.
1002a1ea8e51SBenoît Thébaudeau		Any change to this variable will be reverted at the
1003a1ea8e51SBenoît Thébaudeau		next reset.
1004c1551ea8Sstroese
1005c609719bSwdenk- Real-Time Clock:
1006c609719bSwdenk
1007602ad3b3SJon Loeliger		When CONFIG_CMD_DATE is selected, the type of the RTC
1008c609719bSwdenk		has to be selected, too. Define exactly one of the
1009c609719bSwdenk		following options:
1010c609719bSwdenk
1011c609719bSwdenk		CONFIG_RTC_MPC8xx	- use internal RTC of MPC8xx
1012c609719bSwdenk		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
10134e8b7544SFabio Estevam		CONFIG_RTC_MC13XXX	- use MC13783 or MC13892 RTC
1014c609719bSwdenk		CONFIG_RTC_MC146818	- use MC146818 RTC
10151cb8e980Swdenk		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
1016c609719bSwdenk		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
10177f70e853Swdenk		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
10183bac3513Swdenk		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
10199536dfccSTor Krill		CONFIG_RTC_ISL1208	- use Intersil ISL1208 RTC
10204c0d4c3bSwdenk		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
10216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_DS1337_NOOSC	- Turn off the OSC output for DS1337
102271d19f30SHeiko Schocher		CONFIG_SYS_RV3029_TCR	- enable trickle charger on
102371d19f30SHeiko Schocher					  RV3029 RTC.
1024c609719bSwdenk
1025b37c7e5eSwdenk		Note that if the RTC uses I2C, then the I2C interface
1026b37c7e5eSwdenk		must also be configured. See I2C Support, below.
1027b37c7e5eSwdenk
1028e92739d3SPeter Tyser- GPIO Support:
1029e92739d3SPeter Tyser		CONFIG_PCA953X		- use NXP's PCA953X series I2C GPIO
1030e92739d3SPeter Tyser		CONFIG_PCA953X_INFO	- enable pca953x info command
1031e92739d3SPeter Tyser
10325dec49caSChris Packham		The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
10335dec49caSChris Packham		chip-ngpio pairs that tell the PCA953X driver the number of
10345dec49caSChris Packham		pins supported by a particular chip.
10355dec49caSChris Packham
1036e92739d3SPeter Tyser		Note that if the GPIO device uses I2C, then the I2C interface
1037e92739d3SPeter Tyser		must also be configured. See I2C Support, below.
1038e92739d3SPeter Tyser
1039c609719bSwdenk- Timestamp Support:
1040c609719bSwdenk
1041c609719bSwdenk		When CONFIG_TIMESTAMP is selected, the timestamp
1042c609719bSwdenk		(date and time) of an image is printed by image
1043c609719bSwdenk		commands like bootm or iminfo. This option is
1044602ad3b3SJon Loeliger		automatically enabled when you select CONFIG_CMD_DATE .
1045c609719bSwdenk
1046923c46f9SKarl O. Pinc- Partition Labels (disklabels) Supported:
1047923c46f9SKarl O. Pinc		Zero or more of the following:
1048923c46f9SKarl O. Pinc		CONFIG_MAC_PARTITION   Apple's MacOS partition table.
1049923c46f9SKarl O. Pinc		CONFIG_DOS_PARTITION   MS Dos partition table, traditional on the
1050923c46f9SKarl O. Pinc				       Intel architecture, USB sticks, etc.
1051923c46f9SKarl O. Pinc		CONFIG_ISO_PARTITION   ISO partition table, used on CDROM etc.
1052923c46f9SKarl O. Pinc		CONFIG_EFI_PARTITION   GPT partition table, common when EFI is the
1053923c46f9SKarl O. Pinc				       bootloader.  Note 2TB partition limit; see
1054923c46f9SKarl O. Pinc				       disk/part_efi.c
1055923c46f9SKarl O. Pinc		CONFIG_MTD_PARTITIONS  Memory Technology Device partition table.
1056c609719bSwdenk
1057602ad3b3SJon Loeliger		If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1058218ca724SWolfgang Denk		CONFIG_CMD_SCSI) you must configure support for at
1059923c46f9SKarl O. Pinc		least one non-MTD partition type as well.
1060c609719bSwdenk
1061c609719bSwdenk- IDE Reset method:
10624d13cbadSwdenk		CONFIG_IDE_RESET_ROUTINE - this is defined in several
10634d13cbadSwdenk		board configurations files but used nowhere!
1064c609719bSwdenk
10654d13cbadSwdenk		CONFIG_IDE_RESET - is this is defined, IDE Reset will
10664d13cbadSwdenk		be performed by calling the function
10674d13cbadSwdenk			ide_set_reset(int reset)
10684d13cbadSwdenk		which has to be defined in a board specific file
1069c609719bSwdenk
1070c609719bSwdenk- ATAPI Support:
1071c609719bSwdenk		CONFIG_ATAPI
1072c609719bSwdenk
1073c609719bSwdenk		Set this to enable ATAPI support.
1074c609719bSwdenk
1075c40b2956Swdenk- LBA48 Support
1076c40b2956Swdenk		CONFIG_LBA48
1077c40b2956Swdenk
1078c40b2956Swdenk		Set this to enable support for disks larger than 137GB
10794b142febSHeiko Schocher		Also look at CONFIG_SYS_64BIT_LBA.
1080c40b2956Swdenk		Whithout these , LBA48 support uses 32bit variables and will 'only'
1081c40b2956Swdenk		support disks up to 2.1TB.
1082c40b2956Swdenk
10836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_64BIT_LBA:
1084c40b2956Swdenk			When enabled, makes the IDE subsystem use 64bit sector addresses.
1085c40b2956Swdenk			Default is 32bit.
1086c40b2956Swdenk
1087c609719bSwdenk- SCSI Support:
1088c609719bSwdenk		At the moment only there is only support for the
1089c609719bSwdenk		SYM53C8XX SCSI controller; define
1090c609719bSwdenk		CONFIG_SCSI_SYM53C8XX to enable it.
1091c609719bSwdenk
10926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
10936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
10946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
1095c609719bSwdenk		maximum numbers of LUNs, SCSI ID's and target
1096c609719bSwdenk		devices.
10976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
1098c609719bSwdenk
1099447c031bSStefan Reinauer		The environment variable 'scsidevs' is set to the number of
1100447c031bSStefan Reinauer		SCSI devices found during the last scan.
1101447c031bSStefan Reinauer
1102c609719bSwdenk- NETWORK Support (PCI):
1103682011ffSwdenk		CONFIG_E1000
1104ce5207e1SKyle Moffett		Support for Intel 8254x/8257x gigabit chips.
1105ce5207e1SKyle Moffett
1106ce5207e1SKyle Moffett		CONFIG_E1000_SPI
1107ce5207e1SKyle Moffett		Utility code for direct access to the SPI bus on Intel 8257x.
1108ce5207e1SKyle Moffett		This does not do anything useful unless you set at least one
1109ce5207e1SKyle Moffett		of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1110ce5207e1SKyle Moffett
1111ce5207e1SKyle Moffett		CONFIG_E1000_SPI_GENERIC
1112ce5207e1SKyle Moffett		Allow generic access to the SPI bus on the Intel 8257x, for
1113ce5207e1SKyle Moffett		example with the "sspi" command.
1114ce5207e1SKyle Moffett
1115ce5207e1SKyle Moffett		CONFIG_CMD_E1000
1116ce5207e1SKyle Moffett		Management command for E1000 devices.  When used on devices
1117ce5207e1SKyle Moffett		with SPI support you can reprogram the EEPROM from U-Boot.
1118682011ffSwdenk
1119ac3315c2SAndre Schwarz		CONFIG_E1000_FALLBACK_MAC
112011ccc33fSMarcel Ziswiler		default MAC for empty EEPROM after production.
1121ac3315c2SAndre Schwarz
1122c609719bSwdenk		CONFIG_EEPRO100
1123c609719bSwdenk		Support for Intel 82557/82559/82559ER chips.
112411ccc33fSMarcel Ziswiler		Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
1125c609719bSwdenk		write routine for first time initialisation.
1126c609719bSwdenk
1127c609719bSwdenk		CONFIG_TULIP
1128c609719bSwdenk		Support for Digital 2114x chips.
1129c609719bSwdenk		Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1130c609719bSwdenk		modem chip initialisation (KS8761/QS6611).
1131c609719bSwdenk
1132c609719bSwdenk		CONFIG_NATSEMI
1133c609719bSwdenk		Support for National dp83815 chips.
1134c609719bSwdenk
1135c609719bSwdenk		CONFIG_NS8382X
1136c609719bSwdenk		Support for National dp8382[01] gigabit chips.
1137c609719bSwdenk
113845219c46Swdenk- NETWORK Support (other):
113945219c46Swdenk
1140c041e9d2SJens Scharsig		CONFIG_DRIVER_AT91EMAC
1141c041e9d2SJens Scharsig		Support for AT91RM9200 EMAC.
1142c041e9d2SJens Scharsig
1143c041e9d2SJens Scharsig			CONFIG_RMII
1144c041e9d2SJens Scharsig			Define this to use reduced MII inteface
1145c041e9d2SJens Scharsig
1146c041e9d2SJens Scharsig			CONFIG_DRIVER_AT91EMAC_QUIET
1147c041e9d2SJens Scharsig			If this defined, the driver is quiet.
1148c041e9d2SJens Scharsig			The driver doen't show link status messages.
1149c041e9d2SJens Scharsig
1150efdd7319SRob Herring		CONFIG_CALXEDA_XGMAC
1151efdd7319SRob Herring		Support for the Calxeda XGMAC device
1152efdd7319SRob Herring
11533bb46d23SAshok		CONFIG_LAN91C96
115445219c46Swdenk		Support for SMSC's LAN91C96 chips.
115545219c46Swdenk
115645219c46Swdenk			CONFIG_LAN91C96_BASE
115745219c46Swdenk			Define this to hold the physical address
115845219c46Swdenk			of the LAN91C96's I/O space
115945219c46Swdenk
116045219c46Swdenk			CONFIG_LAN91C96_USE_32_BIT
116145219c46Swdenk			Define this to enable 32 bit addressing
116245219c46Swdenk
11633bb46d23SAshok		CONFIG_SMC91111
1164f39748aeSwdenk		Support for SMSC's LAN91C111 chip
1165f39748aeSwdenk
1166f39748aeSwdenk			CONFIG_SMC91111_BASE
1167f39748aeSwdenk			Define this to hold the physical address
1168f39748aeSwdenk			of the device (I/O space)
1169f39748aeSwdenk
1170f39748aeSwdenk			CONFIG_SMC_USE_32_BIT
1171f39748aeSwdenk			Define this if data bus is 32 bits
1172f39748aeSwdenk
1173f39748aeSwdenk			CONFIG_SMC_USE_IOFUNCS
1174f39748aeSwdenk			Define this to use i/o functions instead of macros
1175f39748aeSwdenk			(some hardware wont work with macros)
1176f39748aeSwdenk
1177dc02badaSHeiko Schocher		CONFIG_DRIVER_TI_EMAC
1178dc02badaSHeiko Schocher		Support for davinci emac
1179dc02badaSHeiko Schocher
1180dc02badaSHeiko Schocher			CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1181dc02badaSHeiko Schocher			Define this if you have more then 3 PHYs.
1182dc02badaSHeiko Schocher
1183b3dbf4a5SMacpaul Lin		CONFIG_FTGMAC100
1184b3dbf4a5SMacpaul Lin		Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1185b3dbf4a5SMacpaul Lin
1186b3dbf4a5SMacpaul Lin			CONFIG_FTGMAC100_EGIGA
1187b3dbf4a5SMacpaul Lin			Define this to use GE link update with gigabit PHY.
1188b3dbf4a5SMacpaul Lin			Define this if FTGMAC100 is connected to gigabit PHY.
1189b3dbf4a5SMacpaul Lin			If your system has 10/100 PHY only, it might not occur
1190b3dbf4a5SMacpaul Lin			wrong behavior. Because PHY usually return timeout or
1191b3dbf4a5SMacpaul Lin			useless data when polling gigabit status and gigabit
1192b3dbf4a5SMacpaul Lin			control registers. This behavior won't affect the
1193b3dbf4a5SMacpaul Lin			correctnessof 10/100 link speed update.
1194b3dbf4a5SMacpaul Lin
1195c2fff331SMike Rapoport		CONFIG_SMC911X
1196557b377dSJens Gehrlein		Support for SMSC's LAN911x and LAN921x chips
1197557b377dSJens Gehrlein
1198c2fff331SMike Rapoport			CONFIG_SMC911X_BASE
1199557b377dSJens Gehrlein			Define this to hold the physical address
1200557b377dSJens Gehrlein			of the device (I/O space)
1201557b377dSJens Gehrlein
1202c2fff331SMike Rapoport			CONFIG_SMC911X_32_BIT
1203557b377dSJens Gehrlein			Define this if data bus is 32 bits
1204557b377dSJens Gehrlein
1205c2fff331SMike Rapoport			CONFIG_SMC911X_16_BIT
1206557b377dSJens Gehrlein			Define this if data bus is 16 bits. If your processor
1207557b377dSJens Gehrlein			automatically converts one 32 bit word to two 16 bit
1208c2fff331SMike Rapoport			words you may also try CONFIG_SMC911X_32_BIT.
1209557b377dSJens Gehrlein
12103d0075faSYoshihiro Shimoda		CONFIG_SH_ETHER
12113d0075faSYoshihiro Shimoda		Support for Renesas on-chip Ethernet controller
12123d0075faSYoshihiro Shimoda
12133d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_USE_PORT
12143d0075faSYoshihiro Shimoda			Define the number of ports to be used
12153d0075faSYoshihiro Shimoda
12163d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_PHY_ADDR
12173d0075faSYoshihiro Shimoda			Define the ETH PHY's address
12183d0075faSYoshihiro Shimoda
121968260aabSYoshihiro Shimoda			CONFIG_SH_ETHER_CACHE_WRITEBACK
122068260aabSYoshihiro Shimoda			If this option is set, the driver enables cache flush.
122168260aabSYoshihiro Shimoda
12225e124724SVadim Bendebury- TPM Support:
122390899cc0SChe-liang Chiou		CONFIG_TPM
122490899cc0SChe-liang Chiou		Support TPM devices.
122590899cc0SChe-liang Chiou
12261b393db5STom Wai-Hong Tam		CONFIG_TPM_TIS_I2C
12271b393db5STom Wai-Hong Tam		Support for i2c bus TPM devices. Only one device
12281b393db5STom Wai-Hong Tam		per system is supported at this time.
12291b393db5STom Wai-Hong Tam
12301b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_BUS_NUMBER
12311b393db5STom Wai-Hong Tam			Define the the i2c bus number for the TPM device
12321b393db5STom Wai-Hong Tam
12331b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS
12341b393db5STom Wai-Hong Tam			Define the TPM's address on the i2c bus
12351b393db5STom Wai-Hong Tam
12361b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_BURST_LIMITATION
12371b393db5STom Wai-Hong Tam			Define the burst count bytes upper limit
12381b393db5STom Wai-Hong Tam
1239c01939c7SDirk Eibach		CONFIG_TPM_ATMEL_TWI
1240c01939c7SDirk Eibach		Support for Atmel TWI TPM device. Requires I2C support.
1241c01939c7SDirk Eibach
124290899cc0SChe-liang Chiou		CONFIG_TPM_TIS_LPC
12435e124724SVadim Bendebury		Support for generic parallel port TPM devices. Only one device
12445e124724SVadim Bendebury		per system is supported at this time.
12455e124724SVadim Bendebury
12465e124724SVadim Bendebury			CONFIG_TPM_TIS_BASE_ADDRESS
12475e124724SVadim Bendebury			Base address where the generic TPM device is mapped
12485e124724SVadim Bendebury			to. Contemporary x86 systems usually map it at
12495e124724SVadim Bendebury			0xfed40000.
12505e124724SVadim Bendebury
1251be6c1529SReinhard Pfau		CONFIG_CMD_TPM
1252be6c1529SReinhard Pfau		Add tpm monitor functions.
1253be6c1529SReinhard Pfau		Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1254be6c1529SReinhard Pfau		provides monitor access to authorized functions.
1255be6c1529SReinhard Pfau
1256be6c1529SReinhard Pfau		CONFIG_TPM
1257be6c1529SReinhard Pfau		Define this to enable the TPM support library which provides
1258be6c1529SReinhard Pfau		functional interfaces to some TPM commands.
1259be6c1529SReinhard Pfau		Requires support for a TPM device.
1260be6c1529SReinhard Pfau
1261be6c1529SReinhard Pfau		CONFIG_TPM_AUTH_SESSIONS
1262be6c1529SReinhard Pfau		Define this to enable authorized functions in the TPM library.
1263be6c1529SReinhard Pfau		Requires CONFIG_TPM and CONFIG_SHA1.
1264be6c1529SReinhard Pfau
1265c609719bSwdenk- USB Support:
1266c609719bSwdenk		At the moment only the UHCI host controller is
12674d13cbadSwdenk		supported (PIP405, MIP405, MPC5200); define
1268c609719bSwdenk		CONFIG_USB_UHCI to enable it.
1269c609719bSwdenk		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
127030d56faeSwdenk		and define CONFIG_USB_STORAGE to enable the USB
1271c609719bSwdenk		storage devices.
1272c609719bSwdenk		Note:
1273c609719bSwdenk		Supported are USB Keyboards and USB Floppy drives
1274c609719bSwdenk		(TEAC FD-05PUB).
12754d13cbadSwdenk		MPC5200 USB requires additional defines:
12764d13cbadSwdenk			CONFIG_USB_CLOCK
12774d13cbadSwdenk				for 528 MHz Clock: 0x0001bbbb
1278307ecb6dSEric Millbrandt			CONFIG_PSC3_USB
1279307ecb6dSEric Millbrandt				for USB on PSC3
12804d13cbadSwdenk			CONFIG_USB_CONFIG
12814d13cbadSwdenk				for differential drivers: 0x00001000
12824d13cbadSwdenk				for single ended drivers: 0x00005000
1283307ecb6dSEric Millbrandt				for differential drivers on PSC3: 0x00000100
1284307ecb6dSEric Millbrandt				for single ended drivers on PSC3: 0x00004100
12856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_USB_EVENT_POLL
1286fdcfaa1bSZhang Wei				May be defined to allow interrupt polling
1287fdcfaa1bSZhang Wei				instead of using asynchronous interrupts
12884d13cbadSwdenk
12899ab4ce22SSimon Glass		CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
12909ab4ce22SSimon Glass		txfilltuning field in the EHCI controller on reset.
12919ab4ce22SSimon Glass
1292aa155058SKuo-Jung Su		CONFIG_USB_HUB_MIN_POWER_ON_DELAY defines the minimum
1293aa155058SKuo-Jung Su		interval for usb hub power-on delay.(minimum 100msec)
1294aa155058SKuo-Jung Su
129516c8d5e7SWolfgang Denk- USB Device:
129616c8d5e7SWolfgang Denk		Define the below if you wish to use the USB console.
129716c8d5e7SWolfgang Denk		Once firmware is rebuilt from a serial console issue the
129816c8d5e7SWolfgang Denk		command "setenv stdin usbtty; setenv stdout usbtty" and
129911ccc33fSMarcel Ziswiler		attach your USB cable. The Unix command "dmesg" should print
130016c8d5e7SWolfgang Denk		it has found a new device. The environment variable usbtty
130116c8d5e7SWolfgang Denk		can be set to gserial or cdc_acm to enable your device to
130216c8d5e7SWolfgang Denk		appear to a USB host as a Linux gserial device or a
130316c8d5e7SWolfgang Denk		Common Device Class Abstract Control Model serial device.
130416c8d5e7SWolfgang Denk		If you select usbtty = gserial you should be able to enumerate
130516c8d5e7SWolfgang Denk		a Linux host by
130616c8d5e7SWolfgang Denk		# modprobe usbserial vendor=0xVendorID product=0xProductID
130716c8d5e7SWolfgang Denk		else if using cdc_acm, simply setting the environment
130816c8d5e7SWolfgang Denk		variable usbtty to be cdc_acm should suffice. The following
130916c8d5e7SWolfgang Denk		might be defined in YourBoardName.h
131016c8d5e7SWolfgang Denk
131116c8d5e7SWolfgang Denk			CONFIG_USB_DEVICE
131216c8d5e7SWolfgang Denk			Define this to build a UDC device
131316c8d5e7SWolfgang Denk
131416c8d5e7SWolfgang Denk			CONFIG_USB_TTY
131516c8d5e7SWolfgang Denk			Define this to have a tty type of device available to
131616c8d5e7SWolfgang Denk			talk to the UDC device
131716c8d5e7SWolfgang Denk
1318f9da0f89SVipin KUMAR			CONFIG_USBD_HS
1319f9da0f89SVipin KUMAR			Define this to enable the high speed support for usb
1320f9da0f89SVipin KUMAR			device and usbtty. If this feature is enabled, a routine
1321f9da0f89SVipin KUMAR			int is_usbd_high_speed(void)
1322f9da0f89SVipin KUMAR			also needs to be defined by the driver to dynamically poll
1323f9da0f89SVipin KUMAR			whether the enumeration has succeded at high speed or full
1324f9da0f89SVipin KUMAR			speed.
1325f9da0f89SVipin KUMAR
13266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_IS_IN_ENV
132716c8d5e7SWolfgang Denk			Define this if you want stdin, stdout &/or stderr to
132816c8d5e7SWolfgang Denk			be set to usbtty.
132916c8d5e7SWolfgang Denk
133016c8d5e7SWolfgang Denk			mpc8xx:
13316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_EXTC_CLK 0xBLAH
133216c8d5e7SWolfgang Denk				Derive USB clock from external clock "blah"
13336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_EXTC_CLK 0x02
133416c8d5e7SWolfgang Denk
13356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_BRG_CLK 0xBLAH
133616c8d5e7SWolfgang Denk				Derive USB clock from brgclk
13376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_BRG_CLK 0x04
133816c8d5e7SWolfgang Denk
133916c8d5e7SWolfgang Denk		If you have a USB-IF assigned VendorID then you may wish to
134016c8d5e7SWolfgang Denk		define your own vendor specific values either in BoardName.h
134116c8d5e7SWolfgang Denk		or directly in usbd_vendor_info.h. If you don't define
134216c8d5e7SWolfgang Denk		CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
134316c8d5e7SWolfgang Denk		CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
134416c8d5e7SWolfgang Denk		should pretend to be a Linux device to it's target host.
134516c8d5e7SWolfgang Denk
134616c8d5e7SWolfgang Denk			CONFIG_USBD_MANUFACTURER
134716c8d5e7SWolfgang Denk			Define this string as the name of your company for
134816c8d5e7SWolfgang Denk			- CONFIG_USBD_MANUFACTURER "my company"
134916c8d5e7SWolfgang Denk
135016c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCT_NAME
135116c8d5e7SWolfgang Denk			Define this string as the name of your product
135216c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCT_NAME "acme usb device"
135316c8d5e7SWolfgang Denk
135416c8d5e7SWolfgang Denk			CONFIG_USBD_VENDORID
135516c8d5e7SWolfgang Denk			Define this as your assigned Vendor ID from the USB
135616c8d5e7SWolfgang Denk			Implementors Forum. This *must* be a genuine Vendor ID
135716c8d5e7SWolfgang Denk			to avoid polluting the USB namespace.
135816c8d5e7SWolfgang Denk			- CONFIG_USBD_VENDORID 0xFFFF
135916c8d5e7SWolfgang Denk
136016c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCTID
136116c8d5e7SWolfgang Denk			Define this as the unique Product ID
136216c8d5e7SWolfgang Denk			for your device
136316c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCTID 0xFFFF
1364c609719bSwdenk
1365d70a560fSIgor Grinberg- ULPI Layer Support:
1366d70a560fSIgor Grinberg		The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1367d70a560fSIgor Grinberg		the generic ULPI layer. The generic layer accesses the ULPI PHY
1368d70a560fSIgor Grinberg		via the platform viewport, so you need both the genric layer and
1369d70a560fSIgor Grinberg		the viewport enabled. Currently only Chipidea/ARC based
1370d70a560fSIgor Grinberg		viewport is supported.
1371d70a560fSIgor Grinberg		To enable the ULPI layer support, define CONFIG_USB_ULPI and
1372d70a560fSIgor Grinberg		CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
13736d365ea0SLucas Stach		If your ULPI phy needs a different reference clock than the
13746d365ea0SLucas Stach		standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
13756d365ea0SLucas Stach		the appropriate value in Hz.
1376c609719bSwdenk
1377c609719bSwdenk- MMC Support:
1378c609719bSwdenk		The MMC controller on the Intel PXA is supported. To
1379c609719bSwdenk		enable this define CONFIG_MMC. The MMC can be
1380c609719bSwdenk		accessed from the boot prompt by mapping the device
1381c609719bSwdenk		to physical memory similar to flash. Command line is
1382602ad3b3SJon Loeliger		enabled with CONFIG_CMD_MMC. The MMC driver also works with
1383602ad3b3SJon Loeliger		the FAT fs. This is enabled with CONFIG_CMD_FAT.
1384c609719bSwdenk
1385afb35666SYoshihiro Shimoda		CONFIG_SH_MMCIF
1386afb35666SYoshihiro Shimoda		Support for Renesas on-chip MMCIF controller
1387afb35666SYoshihiro Shimoda
1388afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_ADDR
1389afb35666SYoshihiro Shimoda			Define the base address of MMCIF registers
1390afb35666SYoshihiro Shimoda
1391afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_CLK
1392afb35666SYoshihiro Shimoda			Define the clock frequency for MMCIF
1393afb35666SYoshihiro Shimoda
1394b3ba6e94STom Rini- USB Device Firmware Update (DFU) class support:
1395b3ba6e94STom Rini		CONFIG_DFU_FUNCTION
1396b3ba6e94STom Rini		This enables the USB portion of the DFU USB class
1397b3ba6e94STom Rini
1398b3ba6e94STom Rini		CONFIG_CMD_DFU
1399b3ba6e94STom Rini		This enables the command "dfu" which is used to have
1400b3ba6e94STom Rini		U-Boot create a DFU class device via USB.  This command
1401b3ba6e94STom Rini		requires that the "dfu_alt_info" environment variable be
1402b3ba6e94STom Rini		set and define the alt settings to expose to the host.
1403b3ba6e94STom Rini
1404b3ba6e94STom Rini		CONFIG_DFU_MMC
1405b3ba6e94STom Rini		This enables support for exposing (e)MMC devices via DFU.
1406b3ba6e94STom Rini
1407c6631764SPantelis Antoniou		CONFIG_DFU_NAND
1408c6631764SPantelis Antoniou		This enables support for exposing NAND devices via DFU.
1409c6631764SPantelis Antoniou
1410a9479f04SAfzal Mohammed		CONFIG_DFU_RAM
1411a9479f04SAfzal Mohammed		This enables support for exposing RAM via DFU.
1412a9479f04SAfzal Mohammed		Note: DFU spec refer to non-volatile memory usage, but
1413a9479f04SAfzal Mohammed		allow usages beyond the scope of spec - here RAM usage,
1414a9479f04SAfzal Mohammed		one that would help mostly the developer.
1415a9479f04SAfzal Mohammed
1416e7e75c70SHeiko Schocher		CONFIG_SYS_DFU_DATA_BUF_SIZE
1417e7e75c70SHeiko Schocher		Dfu transfer uses a buffer before writing data to the
1418e7e75c70SHeiko Schocher		raw storage device. Make the size (in bytes) of this buffer
1419e7e75c70SHeiko Schocher		configurable. The size of this buffer is also configurable
1420e7e75c70SHeiko Schocher		through the "dfu_bufsiz" environment variable.
1421e7e75c70SHeiko Schocher
1422ea2453d5SPantelis Antoniou		CONFIG_SYS_DFU_MAX_FILE_SIZE
1423ea2453d5SPantelis Antoniou		When updating files rather than the raw storage device,
1424ea2453d5SPantelis Antoniou		we use a static buffer to copy the file into and then write
1425ea2453d5SPantelis Antoniou		the buffer once we've been given the whole file.  Define
1426ea2453d5SPantelis Antoniou		this to the maximum filesize (in bytes) for the buffer.
1427ea2453d5SPantelis Antoniou		Default is 4 MiB if undefined.
1428ea2453d5SPantelis Antoniou
14296705d81eSwdenk- Journaling Flash filesystem support:
14306705d81eSwdenk		CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
14316705d81eSwdenk		CONFIG_JFFS2_NAND_DEV
14326705d81eSwdenk		Define these for a default partition on a NAND device
14336705d81eSwdenk
14346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_SECTOR,
14356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
14366705d81eSwdenk		Define these for a default partition on a NOR device
14376705d81eSwdenk
14386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS_CUSTOM_PART
14396705d81eSwdenk		Define this to create an own partition. You have to provide a
14406705d81eSwdenk		function struct part_info* jffs2_part_info(int part_num)
14416705d81eSwdenk
14426705d81eSwdenk		If you define only one JFFS2 partition you may also want to
14436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_JFFS_SINGLE_PART	1
14446705d81eSwdenk		to disable the command chpart. This is the default when you
14456705d81eSwdenk		have not defined a custom partition
14466705d81eSwdenk
1447c30a15e5SDonggeun Kim- FAT(File Allocation Table) filesystem write function support:
1448c30a15e5SDonggeun Kim		CONFIG_FAT_WRITE
1449656f4c65SDonggeun Kim
1450656f4c65SDonggeun Kim		Define this to enable support for saving memory data as a
1451656f4c65SDonggeun Kim		file in FAT formatted partition.
1452656f4c65SDonggeun Kim
1453656f4c65SDonggeun Kim		This will also enable the command "fatwrite" enabling the
1454656f4c65SDonggeun Kim		user to write files to FAT.
1455c30a15e5SDonggeun Kim
145684cd9327SGabe BlackCBFS (Coreboot Filesystem) support
145784cd9327SGabe Black		CONFIG_CMD_CBFS
145884cd9327SGabe Black
145984cd9327SGabe Black		Define this to enable support for reading from a Coreboot
146084cd9327SGabe Black		filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
146184cd9327SGabe Black		and cbfsload.
146284cd9327SGabe Black
1463c609719bSwdenk- Keyboard Support:
1464c609719bSwdenk		CONFIG_ISA_KEYBOARD
1465c609719bSwdenk
1466c609719bSwdenk		Define this to enable standard (PC-Style) keyboard
1467c609719bSwdenk		support
1468c609719bSwdenk
1469c609719bSwdenk		CONFIG_I8042_KBD
1470c609719bSwdenk		Standard PC keyboard driver with US (is default) and
1471c609719bSwdenk		GERMAN key layout (switch via environment 'keymap=de') support.
1472c609719bSwdenk		Export function i8042_kbd_init, i8042_tstc and i8042_getc
1473c609719bSwdenk		for cfb_console. Supports cursor blinking.
1474c609719bSwdenk
1475713cb680SHung-ying Tyan		CONFIG_CROS_EC_KEYB
1476713cb680SHung-ying Tyan		Enables a Chrome OS keyboard using the CROS_EC interface.
1477713cb680SHung-ying Tyan		This uses CROS_EC to communicate with a second microcontroller
1478713cb680SHung-ying Tyan		which provides key scans on request.
1479713cb680SHung-ying Tyan
1480c609719bSwdenk- Video support:
1481c609719bSwdenk		CONFIG_VIDEO
1482c609719bSwdenk
1483c609719bSwdenk		Define this to enable video support (for output to
1484c609719bSwdenk		video).
1485c609719bSwdenk
1486c609719bSwdenk		CONFIG_VIDEO_CT69000
1487c609719bSwdenk
1488c609719bSwdenk		Enable Chips & Technologies 69000 Video chip
1489c609719bSwdenk
1490c609719bSwdenk		CONFIG_VIDEO_SMI_LYNXEM
1491eeb1b77bSwdenk		Enable Silicon Motion SMI 712/710/810 Video chip. The
1492eeb1b77bSwdenk		video output is selected via environment 'videoout'
1493eeb1b77bSwdenk		(1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1494eeb1b77bSwdenk		assumed.
1495c609719bSwdenk
1496eeb1b77bSwdenk		For the CT69000 and SMI_LYNXEM drivers, videomode is
149711ccc33fSMarcel Ziswiler		selected via environment 'videomode'. Two different ways
1498eeb1b77bSwdenk		are possible:
1499eeb1b77bSwdenk		- "videomode=num"   'num' is a standard LiLo mode numbers.
1500eeb1b77bSwdenk		Following standard modes are supported	(* is default):
1501eeb1b77bSwdenk
1502eeb1b77bSwdenk		      Colors	640x480 800x600 1024x768 1152x864 1280x1024
1503eeb1b77bSwdenk		-------------+---------------------------------------------
1504eeb1b77bSwdenk		      8 bits |	0x301*	0x303	 0x305	  0x161	    0x307
1505eeb1b77bSwdenk		     15 bits |	0x310	0x313	 0x316	  0x162	    0x319
1506eeb1b77bSwdenk		     16 bits |	0x311	0x314	 0x317	  0x163	    0x31A
1507eeb1b77bSwdenk		     24 bits |	0x312	0x315	 0x318	    ?	    0x31B
1508eeb1b77bSwdenk		-------------+---------------------------------------------
1509c609719bSwdenk		(i.e. setenv videomode 317; saveenv; reset;)
1510c609719bSwdenk
1511eeb1b77bSwdenk		- "videomode=bootargs" all the video parameters are parsed
15127817cb20SMarcel Ziswiler		from the bootargs. (See drivers/video/videomodes.c)
1513eeb1b77bSwdenk
1514eeb1b77bSwdenk
1515a6c7ad2fSwdenk		CONFIG_VIDEO_SED13806
1516a6c7ad2fSwdenk		Enable Epson SED13806 driver. This driver supports 8bpp
1517a6c7ad2fSwdenk		and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1518a6c7ad2fSwdenk		or CONFIG_VIDEO_SED13806_16BPP
1519a6c7ad2fSwdenk
15207d3053fbSTimur Tabi		CONFIG_FSL_DIU_FB
15217d3053fbSTimur Tabi		Enable the Freescale DIU video driver.	Reference boards for
15227d3053fbSTimur Tabi		SOCs that have a DIU should define this macro to enable DIU
15237d3053fbSTimur Tabi		support, and should also define these other macros:
15247d3053fbSTimur Tabi
15257d3053fbSTimur Tabi			CONFIG_SYS_DIU_ADDR
15267d3053fbSTimur Tabi			CONFIG_VIDEO
15277d3053fbSTimur Tabi			CONFIG_CMD_BMP
15287d3053fbSTimur Tabi			CONFIG_CFB_CONSOLE
15297d3053fbSTimur Tabi			CONFIG_VIDEO_SW_CURSOR
15307d3053fbSTimur Tabi			CONFIG_VGA_AS_SINGLE_DEVICE
15317d3053fbSTimur Tabi			CONFIG_VIDEO_LOGO
15327d3053fbSTimur Tabi			CONFIG_VIDEO_BMP_LOGO
15337d3053fbSTimur Tabi
1534ba8e76bdSTimur Tabi		The DIU driver will look for the 'video-mode' environment
1535ba8e76bdSTimur Tabi		variable, and if defined, enable the DIU as a console during
1536ba8e76bdSTimur Tabi		boot.  See the documentation file README.video for a
1537ba8e76bdSTimur Tabi		description of this variable.
15387d3053fbSTimur Tabi
1539058d59b0SSimon Glass		CONFIG_VIDEO_VGA
1540058d59b0SSimon Glass
1541058d59b0SSimon Glass		Enable the VGA video / BIOS for x86. The alternative if you
1542058d59b0SSimon Glass		are using coreboot is to use the coreboot frame buffer
1543058d59b0SSimon Glass		driver.
1544058d59b0SSimon Glass
1545058d59b0SSimon Glass
1546682011ffSwdenk- Keyboard Support:
1547682011ffSwdenk		CONFIG_KEYBOARD
1548682011ffSwdenk
1549682011ffSwdenk		Define this to enable a custom keyboard support.
1550682011ffSwdenk		This simply calls drv_keyboard_init() which must be
1551682011ffSwdenk		defined in your board-specific files.
1552682011ffSwdenk		The only board using this so far is RBC823.
1553a6c7ad2fSwdenk
1554c609719bSwdenk- LCD Support:	CONFIG_LCD
1555c609719bSwdenk
1556c609719bSwdenk		Define this to enable LCD support (for output to LCD
1557c609719bSwdenk		display); also select one of the supported displays
1558c609719bSwdenk		by defining one of these:
1559c609719bSwdenk
156039cf4804SStelian Pop		CONFIG_ATMEL_LCD:
156139cf4804SStelian Pop
156239cf4804SStelian Pop			HITACHI TX09D70VM1CCA, 3.5", 240x320.
156339cf4804SStelian Pop
1564fd3103bbSwdenk		CONFIG_NEC_NL6448AC33:
1565c609719bSwdenk
1566fd3103bbSwdenk			NEC NL6448AC33-18. Active, color, single scan.
1567c609719bSwdenk
1568fd3103bbSwdenk		CONFIG_NEC_NL6448BC20
1569c609719bSwdenk
1570fd3103bbSwdenk			NEC NL6448BC20-08. 6.5", 640x480.
1571fd3103bbSwdenk			Active, color, single scan.
1572fd3103bbSwdenk
1573fd3103bbSwdenk		CONFIG_NEC_NL6448BC33_54
1574fd3103bbSwdenk
1575fd3103bbSwdenk			NEC NL6448BC33-54. 10.4", 640x480.
1576c609719bSwdenk			Active, color, single scan.
1577c609719bSwdenk
1578c609719bSwdenk		CONFIG_SHARP_16x9
1579c609719bSwdenk
1580c609719bSwdenk			Sharp 320x240. Active, color, single scan.
1581c609719bSwdenk			It isn't 16x9, and I am not sure what it is.
1582c609719bSwdenk
1583c609719bSwdenk		CONFIG_SHARP_LQ64D341
1584c609719bSwdenk
1585c609719bSwdenk			Sharp LQ64D341 display, 640x480.
1586c609719bSwdenk			Active, color, single scan.
1587c609719bSwdenk
1588c609719bSwdenk		CONFIG_HLD1045
1589c609719bSwdenk
1590c609719bSwdenk			HLD1045 display, 640x480.
1591c609719bSwdenk			Active, color, single scan.
1592c609719bSwdenk
1593c609719bSwdenk		CONFIG_OPTREX_BW
1594c609719bSwdenk
1595c609719bSwdenk			Optrex	 CBL50840-2 NF-FW 99 22 M5
1596c609719bSwdenk			or
1597c609719bSwdenk			Hitachi	 LMG6912RPFC-00T
1598c609719bSwdenk			or
1599c609719bSwdenk			Hitachi	 SP14Q002
1600c609719bSwdenk
1601c609719bSwdenk			320x240. Black & white.
1602c609719bSwdenk
1603c609719bSwdenk		Normally display is black on white background; define
16046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
1605c609719bSwdenk
1606676d319eSSimon Glass		CONFIG_LCD_ALIGNMENT
1607676d319eSSimon Glass
1608676d319eSSimon Glass		Normally the LCD is page-aligned (tyically 4KB). If this is
1609676d319eSSimon Glass		defined then the LCD will be aligned to this value instead.
1610676d319eSSimon Glass		For ARM it is sometimes useful to use MMU_SECTION_SIZE
1611676d319eSSimon Glass		here, since it is cheaper to change data cache settings on
1612676d319eSSimon Glass		a per-section basis.
1613676d319eSSimon Glass
16140d89efefSSimon Glass		CONFIG_CONSOLE_SCROLL_LINES
16150d89efefSSimon Glass
16160d89efefSSimon Glass		When the console need to be scrolled, this is the number of
16170d89efefSSimon Glass		lines to scroll by. It defaults to 1. Increasing this makes
16180d89efefSSimon Glass		the console jump but can help speed up operation when scrolling
16190d89efefSSimon Glass		is slow.
1620676d319eSSimon Glass
162145d7f525STom Wai-Hong Tam		CONFIG_LCD_BMP_RLE8
162245d7f525STom Wai-Hong Tam
162345d7f525STom Wai-Hong Tam		Support drawing of RLE8-compressed bitmaps on the LCD.
162445d7f525STom Wai-Hong Tam
1625735987c5STom Wai-Hong Tam		CONFIG_I2C_EDID
1626735987c5STom Wai-Hong Tam
1627735987c5STom Wai-Hong Tam		Enables an 'i2c edid' command which can read EDID
1628735987c5STom Wai-Hong Tam		information over I2C from an attached LCD display.
1629735987c5STom Wai-Hong Tam
16307152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN
1631d791b1dcSwdenk
1632d791b1dcSwdenk		If this option is set, the environment is checked for
1633d791b1dcSwdenk		a variable "splashimage". If found, the usual display
1634d791b1dcSwdenk		of logo, copyright and system information on the LCD
1635e94d2cd9Swdenk		is suppressed and the BMP image at the address
1636d791b1dcSwdenk		specified in "splashimage" is loaded instead. The
1637d791b1dcSwdenk		console is redirected to the "nulldev", too. This
1638d791b1dcSwdenk		allows for a "silent" boot where a splash screen is
1639d791b1dcSwdenk		loaded very quickly after power-on.
1640d791b1dcSwdenk
1641c0880485SNikita Kiryanov		CONFIG_SPLASHIMAGE_GUARD
1642c0880485SNikita Kiryanov
1643c0880485SNikita Kiryanov		If this option is set, then U-Boot will prevent the environment
1644c0880485SNikita Kiryanov		variable "splashimage" from being set to a problematic address
1645c0880485SNikita Kiryanov		(see README.displaying-bmps and README.arm-unaligned-accesses).
1646c0880485SNikita Kiryanov		This option is useful for targets where, due to alignment
1647c0880485SNikita Kiryanov		restrictions, an improperly aligned BMP image will cause a data
1648c0880485SNikita Kiryanov		abort. If you think you will not have problems with unaligned
1649c0880485SNikita Kiryanov		accesses (for example because your toolchain prevents them)
1650c0880485SNikita Kiryanov		there is no need to set this option.
1651c0880485SNikita Kiryanov
16521ca298ceSMatthias Weisser		CONFIG_SPLASH_SCREEN_ALIGN
16531ca298ceSMatthias Weisser
16541ca298ceSMatthias Weisser		If this option is set the splash image can be freely positioned
16551ca298ceSMatthias Weisser		on the screen. Environment variable "splashpos" specifies the
16561ca298ceSMatthias Weisser		position as "x,y". If a positive number is given it is used as
16571ca298ceSMatthias Weisser		number of pixel from left/top. If a negative number is given it
16581ca298ceSMatthias Weisser		is used as number of pixel from right/bottom. You can also
16591ca298ceSMatthias Weisser		specify 'm' for centering the image.
16601ca298ceSMatthias Weisser
16611ca298ceSMatthias Weisser		Example:
16621ca298ceSMatthias Weisser		setenv splashpos m,m
16631ca298ceSMatthias Weisser			=> image at center of screen
16641ca298ceSMatthias Weisser
16651ca298ceSMatthias Weisser		setenv splashpos 30,20
16661ca298ceSMatthias Weisser			=> image at x = 30 and y = 20
16671ca298ceSMatthias Weisser
16681ca298ceSMatthias Weisser		setenv splashpos -10,m
16691ca298ceSMatthias Weisser			=> vertically centered image
16701ca298ceSMatthias Weisser			   at x = dspWidth - bmpWidth - 9
16711ca298ceSMatthias Weisser
167298f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
167398f4a3dfSStefan Roese
167498f4a3dfSStefan Roese		If this option is set, additionally to standard BMP
167598f4a3dfSStefan Roese		images, gzipped BMP images can be displayed via the
167698f4a3dfSStefan Roese		splashscreen support or the bmp command.
167798f4a3dfSStefan Roese
1678d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1679d5011762SAnatolij Gustschin
1680d5011762SAnatolij Gustschin		If this option is set, 8-bit RLE compressed BMP images
1681d5011762SAnatolij Gustschin		can be displayed via the splashscreen support or the
1682d5011762SAnatolij Gustschin		bmp command.
1683d5011762SAnatolij Gustschin
1684f2b96dfbSLei Wen- Do compresssing for memory range:
1685f2b96dfbSLei Wen		CONFIG_CMD_ZIP
1686f2b96dfbSLei Wen
1687f2b96dfbSLei Wen		If this option is set, it would use zlib deflate method
1688f2b96dfbSLei Wen		to compress the specified memory at its best effort.
1689f2b96dfbSLei Wen
1690c29fdfc1Swdenk- Compression support:
16918ef70478SKees Cook		CONFIG_GZIP
16928ef70478SKees Cook
16938ef70478SKees Cook		Enabled by default to support gzip compressed images.
16948ef70478SKees Cook
1695c29fdfc1Swdenk		CONFIG_BZIP2
1696c29fdfc1Swdenk
1697c29fdfc1Swdenk		If this option is set, support for bzip2 compressed
1698c29fdfc1Swdenk		images is included. If not, only uncompressed and gzip
1699c29fdfc1Swdenk		compressed images are supported.
1700c29fdfc1Swdenk
1701c29fdfc1Swdenk		NOTE: the bzip2 algorithm requires a lot of RAM, so
17026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
1703c29fdfc1Swdenk		be at least 4MB.
1704d791b1dcSwdenk
1705fc9c1727SLuigi 'Comio' Mantellini		CONFIG_LZMA
1706fc9c1727SLuigi 'Comio' Mantellini
1707fc9c1727SLuigi 'Comio' Mantellini		If this option is set, support for lzma compressed
1708fc9c1727SLuigi 'Comio' Mantellini		images is included.
1709fc9c1727SLuigi 'Comio' Mantellini
1710fc9c1727SLuigi 'Comio' Mantellini		Note: The LZMA algorithm adds between 2 and 4KB of code and it
1711fc9c1727SLuigi 'Comio' Mantellini		requires an amount of dynamic memory that is given by the
1712fc9c1727SLuigi 'Comio' Mantellini		formula:
1713fc9c1727SLuigi 'Comio' Mantellini
1714fc9c1727SLuigi 'Comio' Mantellini			(1846 + 768 << (lc + lp)) * sizeof(uint16)
1715fc9c1727SLuigi 'Comio' Mantellini
1716fc9c1727SLuigi 'Comio' Mantellini		Where lc and lp stand for, respectively, Literal context bits
1717fc9c1727SLuigi 'Comio' Mantellini		and Literal pos bits.
1718fc9c1727SLuigi 'Comio' Mantellini
1719fc9c1727SLuigi 'Comio' Mantellini		This value is upper-bounded by 14MB in the worst case. Anyway,
1720fc9c1727SLuigi 'Comio' Mantellini		for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1721fc9c1727SLuigi 'Comio' Mantellini		total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1722fc9c1727SLuigi 'Comio' Mantellini		a very small buffer.
1723fc9c1727SLuigi 'Comio' Mantellini
1724fc9c1727SLuigi 'Comio' Mantellini		Use the lzmainfo tool to determinate the lc and lp values and
1725fc9c1727SLuigi 'Comio' Mantellini		then calculate the amount of needed dynamic memory (ensuring
17266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the appropriate CONFIG_SYS_MALLOC_LEN value).
1727fc9c1727SLuigi 'Comio' Mantellini
17288ef70478SKees Cook		CONFIG_LZO
17298ef70478SKees Cook
17308ef70478SKees Cook		If this option is set, support for LZO compressed images
17318ef70478SKees Cook		is included.
17328ef70478SKees Cook
173317ea1177Swdenk- MII/PHY support:
173417ea1177Swdenk		CONFIG_PHY_ADDR
173517ea1177Swdenk
173617ea1177Swdenk		The address of PHY on MII bus.
173717ea1177Swdenk
173817ea1177Swdenk		CONFIG_PHY_CLOCK_FREQ (ppc4xx)
173917ea1177Swdenk
174017ea1177Swdenk		The clock frequency of the MII bus
174117ea1177Swdenk
174217ea1177Swdenk		CONFIG_PHY_GIGE
174317ea1177Swdenk
174417ea1177Swdenk		If this option is set, support for speed/duplex
174511ccc33fSMarcel Ziswiler		detection of gigabit PHY is included.
174617ea1177Swdenk
174717ea1177Swdenk		CONFIG_PHY_RESET_DELAY
174817ea1177Swdenk
174917ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
175017ea1177Swdenk		reset before any MII register access is possible.
175117ea1177Swdenk		For such PHY, set this option to the usec delay
175217ea1177Swdenk		required. (minimum 300usec for LXT971A)
175317ea1177Swdenk
175417ea1177Swdenk		CONFIG_PHY_CMD_DELAY (ppc4xx)
175517ea1177Swdenk
175617ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
175717ea1177Swdenk		command issued before MII status register can be read
175817ea1177Swdenk
1759c609719bSwdenk- Ethernet address:
1760c609719bSwdenk		CONFIG_ETHADDR
1761c68a05feSrichardretanubun		CONFIG_ETH1ADDR
1762c609719bSwdenk		CONFIG_ETH2ADDR
1763c609719bSwdenk		CONFIG_ETH3ADDR
1764c68a05feSrichardretanubun		CONFIG_ETH4ADDR
1765c68a05feSrichardretanubun		CONFIG_ETH5ADDR
1766c609719bSwdenk
176711ccc33fSMarcel Ziswiler		Define a default value for Ethernet address to use
176811ccc33fSMarcel Ziswiler		for the respective Ethernet interface, in case this
1769c609719bSwdenk		is not determined automatically.
1770c609719bSwdenk
1771c609719bSwdenk- IP address:
1772c609719bSwdenk		CONFIG_IPADDR
1773c609719bSwdenk
1774c609719bSwdenk		Define a default value for the IP address to use for
177511ccc33fSMarcel Ziswiler		the default Ethernet interface, in case this is not
1776c609719bSwdenk		determined through e.g. bootp.
17771ebcd654SWolfgang Denk		(Environment variable "ipaddr")
1778c609719bSwdenk
1779c609719bSwdenk- Server IP address:
1780c609719bSwdenk		CONFIG_SERVERIP
1781c609719bSwdenk
1782c609719bSwdenk		Defines a default value for the IP address of a TFTP
1783c609719bSwdenk		server to contact when using the "tftboot" command.
17841ebcd654SWolfgang Denk		(Environment variable "serverip")
1785c609719bSwdenk
178697cfe861SRobin Getz		CONFIG_KEEP_SERVERADDR
178797cfe861SRobin Getz
178897cfe861SRobin Getz		Keeps the server's MAC address, in the env 'serveraddr'
178997cfe861SRobin Getz		for passing to bootargs (like Linux's netconsole option)
179097cfe861SRobin Getz
17911ebcd654SWolfgang Denk- Gateway IP address:
17921ebcd654SWolfgang Denk		CONFIG_GATEWAYIP
17931ebcd654SWolfgang Denk
17941ebcd654SWolfgang Denk		Defines a default value for the IP address of the
17951ebcd654SWolfgang Denk		default router where packets to other networks are
17961ebcd654SWolfgang Denk		sent to.
17971ebcd654SWolfgang Denk		(Environment variable "gatewayip")
17981ebcd654SWolfgang Denk
17991ebcd654SWolfgang Denk- Subnet mask:
18001ebcd654SWolfgang Denk		CONFIG_NETMASK
18011ebcd654SWolfgang Denk
18021ebcd654SWolfgang Denk		Defines a default value for the subnet mask (or
18031ebcd654SWolfgang Denk		routing prefix) which is used to determine if an IP
18041ebcd654SWolfgang Denk		address belongs to the local subnet or needs to be
18051ebcd654SWolfgang Denk		forwarded through a router.
18061ebcd654SWolfgang Denk		(Environment variable "netmask")
18071ebcd654SWolfgang Denk
180853a5c424SDavid Updegraff- Multicast TFTP Mode:
180953a5c424SDavid Updegraff		CONFIG_MCAST_TFTP
181053a5c424SDavid Updegraff
181153a5c424SDavid Updegraff		Defines whether you want to support multicast TFTP as per
181253a5c424SDavid Updegraff		rfc-2090; for example to work with atftp.  Lets lots of targets
181311ccc33fSMarcel Ziswiler		tftp down the same boot image concurrently.  Note: the Ethernet
181453a5c424SDavid Updegraff		driver in use must provide a function: mcast() to join/leave a
181553a5c424SDavid Updegraff		multicast group.
181653a5c424SDavid Updegraff
1817c609719bSwdenk- BOOTP Recovery Mode:
1818c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY
1819c609719bSwdenk
1820c609719bSwdenk		If you have many targets in a network that try to
1821c609719bSwdenk		boot using BOOTP, you may want to avoid that all
1822c609719bSwdenk		systems send out BOOTP requests at precisely the same
1823c609719bSwdenk		moment (which would happen for instance at recovery
1824c609719bSwdenk		from a power failure, when all systems will try to
1825c609719bSwdenk		boot, thus flooding the BOOTP server. Defining
1826c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1827c609719bSwdenk		inserted before sending out BOOTP requests. The
18286c33c785SWolfgang Denk		following delays are inserted then:
1829c609719bSwdenk
1830c609719bSwdenk		1st BOOTP request:	delay 0 ... 1 sec
1831c609719bSwdenk		2nd BOOTP request:	delay 0 ... 2 sec
1832c609719bSwdenk		3rd BOOTP request:	delay 0 ... 4 sec
1833c609719bSwdenk		4th and following
1834c609719bSwdenk		BOOTP requests:		delay 0 ... 8 sec
1835c609719bSwdenk
1836fe389a82Sstroese- DHCP Advanced Options:
18371fe80d79SJon Loeliger		You can fine tune the DHCP functionality by defining
18381fe80d79SJon Loeliger		CONFIG_BOOTP_* symbols:
1839fe389a82Sstroese
18401fe80d79SJon Loeliger		CONFIG_BOOTP_SUBNETMASK
18411fe80d79SJon Loeliger		CONFIG_BOOTP_GATEWAY
18421fe80d79SJon Loeliger		CONFIG_BOOTP_HOSTNAME
18431fe80d79SJon Loeliger		CONFIG_BOOTP_NISDOMAIN
18441fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTPATH
18451fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTFILESIZE
18461fe80d79SJon Loeliger		CONFIG_BOOTP_DNS
18471fe80d79SJon Loeliger		CONFIG_BOOTP_DNS2
18481fe80d79SJon Loeliger		CONFIG_BOOTP_SEND_HOSTNAME
18491fe80d79SJon Loeliger		CONFIG_BOOTP_NTPSERVER
18501fe80d79SJon Loeliger		CONFIG_BOOTP_TIMEOFFSET
18511fe80d79SJon Loeliger		CONFIG_BOOTP_VENDOREX
18522c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL
1853fe389a82Sstroese
18545d110f0aSWilson Callan		CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
18555d110f0aSWilson Callan		environment variable, not the BOOTP server.
1856fe389a82Sstroese
18572c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
18582c00e099SJoe Hershberger		after the configured retry count, the call will fail
18592c00e099SJoe Hershberger		instead of starting over.  This can be used to fail over
18602c00e099SJoe Hershberger		to Link-local IP address configuration if the DHCP server
18612c00e099SJoe Hershberger		is not available.
18622c00e099SJoe Hershberger
1863fe389a82Sstroese		CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1864fe389a82Sstroese		serverip from a DHCP server, it is possible that more
1865fe389a82Sstroese		than one DNS serverip is offered to the client.
1866fe389a82Sstroese		If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1867fe389a82Sstroese		serverip will be stored in the additional environment
1868fe389a82Sstroese		variable "dnsip2". The first DNS serverip is always
1869fe389a82Sstroese		stored in the variable "dnsip", when CONFIG_BOOTP_DNS
18701fe80d79SJon Loeliger		is defined.
1871fe389a82Sstroese
1872fe389a82Sstroese		CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1873fe389a82Sstroese		to do a dynamic update of a DNS server. To do this, they
1874fe389a82Sstroese		need the hostname of the DHCP requester.
18755d110f0aSWilson Callan		If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
18761fe80d79SJon Loeliger		of the "hostname" environment variable is passed as
18771fe80d79SJon Loeliger		option 12 to the DHCP server.
1878fe389a82Sstroese
1879d9a2f416SAras Vaichas		CONFIG_BOOTP_DHCP_REQUEST_DELAY
1880d9a2f416SAras Vaichas
1881d9a2f416SAras Vaichas		A 32bit value in microseconds for a delay between
1882d9a2f416SAras Vaichas		receiving a "DHCP Offer" and sending the "DHCP Request".
1883d9a2f416SAras Vaichas		This fixes a problem with certain DHCP servers that don't
1884d9a2f416SAras Vaichas		respond 100% of the time to a "DHCP request". E.g. On an
1885d9a2f416SAras Vaichas		AT91RM9200 processor running at 180MHz, this delay needed
1886d9a2f416SAras Vaichas		to be *at least* 15,000 usec before a Windows Server 2003
1887d9a2f416SAras Vaichas		DHCP server would reply 100% of the time. I recommend at
1888d9a2f416SAras Vaichas		least 50,000 usec to be safe. The alternative is to hope
1889d9a2f416SAras Vaichas		that one of the retries will be successful but note that
1890d9a2f416SAras Vaichas		the DHCP timeout and retry process takes a longer than
1891d9a2f416SAras Vaichas		this delay.
1892d9a2f416SAras Vaichas
1893d22c338eSJoe Hershberger - Link-local IP address negotiation:
1894d22c338eSJoe Hershberger		Negotiate with other link-local clients on the local network
1895d22c338eSJoe Hershberger		for an address that doesn't require explicit configuration.
1896d22c338eSJoe Hershberger		This is especially useful if a DHCP server cannot be guaranteed
1897d22c338eSJoe Hershberger		to exist in all environments that the device must operate.
1898d22c338eSJoe Hershberger
1899d22c338eSJoe Hershberger		See doc/README.link-local for more information.
1900d22c338eSJoe Hershberger
1901a3d991bdSwdenk - CDP Options:
1902a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID
1903a3d991bdSwdenk
1904a3d991bdSwdenk		The device id used in CDP trigger frames.
1905a3d991bdSwdenk
1906a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID_PREFIX
1907a3d991bdSwdenk
1908a3d991bdSwdenk		A two character string which is prefixed to the MAC address
1909a3d991bdSwdenk		of the device.
1910a3d991bdSwdenk
1911a3d991bdSwdenk		CONFIG_CDP_PORT_ID
1912a3d991bdSwdenk
1913a3d991bdSwdenk		A printf format string which contains the ascii name of
1914a3d991bdSwdenk		the port. Normally is set to "eth%d" which sets
191511ccc33fSMarcel Ziswiler		eth0 for the first Ethernet, eth1 for the second etc.
1916a3d991bdSwdenk
1917a3d991bdSwdenk		CONFIG_CDP_CAPABILITIES
1918a3d991bdSwdenk
1919a3d991bdSwdenk		A 32bit integer which indicates the device capabilities;
1920a3d991bdSwdenk		0x00000010 for a normal host which does not forwards.
1921a3d991bdSwdenk
1922a3d991bdSwdenk		CONFIG_CDP_VERSION
1923a3d991bdSwdenk
1924a3d991bdSwdenk		An ascii string containing the version of the software.
1925a3d991bdSwdenk
1926a3d991bdSwdenk		CONFIG_CDP_PLATFORM
1927a3d991bdSwdenk
1928a3d991bdSwdenk		An ascii string containing the name of the platform.
1929a3d991bdSwdenk
1930a3d991bdSwdenk		CONFIG_CDP_TRIGGER
1931a3d991bdSwdenk
1932a3d991bdSwdenk		A 32bit integer sent on the trigger.
1933a3d991bdSwdenk
1934a3d991bdSwdenk		CONFIG_CDP_POWER_CONSUMPTION
1935a3d991bdSwdenk
1936a3d991bdSwdenk		A 16bit integer containing the power consumption of the
1937a3d991bdSwdenk		device in .1 of milliwatts.
1938a3d991bdSwdenk
1939a3d991bdSwdenk		CONFIG_CDP_APPLIANCE_VLAN_TYPE
1940a3d991bdSwdenk
1941a3d991bdSwdenk		A byte containing the id of the VLAN.
1942a3d991bdSwdenk
1943c609719bSwdenk- Status LED:	CONFIG_STATUS_LED
1944c609719bSwdenk
1945c609719bSwdenk		Several configurations allow to display the current
1946c609719bSwdenk		status using a LED. For instance, the LED will blink
1947c609719bSwdenk		fast while running U-Boot code, stop blinking as
1948c609719bSwdenk		soon as a reply to a BOOTP request was received, and
1949c609719bSwdenk		start blinking slow once the Linux kernel is running
1950c609719bSwdenk		(supported by a status LED driver in the Linux
1951c609719bSwdenk		kernel). Defining CONFIG_STATUS_LED enables this
1952c609719bSwdenk		feature in U-Boot.
1953c609719bSwdenk
1954c609719bSwdenk- CAN Support:	CONFIG_CAN_DRIVER
1955c609719bSwdenk
1956c609719bSwdenk		Defining CONFIG_CAN_DRIVER enables CAN driver support
1957c609719bSwdenk		on those systems that support this (optional)
1958c609719bSwdenk		feature, like the TQM8xxL modules.
1959c609719bSwdenk
19603f4978c7SHeiko Schocher- I2C Support:	CONFIG_SYS_I2C
1961c609719bSwdenk
19623f4978c7SHeiko Schocher		This enable the NEW i2c subsystem, and will allow you to use
19633f4978c7SHeiko Schocher		i2c commands at the u-boot command line (as long as you set
19643f4978c7SHeiko Schocher		CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
19653f4978c7SHeiko Schocher		based realtime clock chips or other i2c devices. See
19663f4978c7SHeiko Schocher		common/cmd_i2c.c for a description of the command line
19673f4978c7SHeiko Schocher		interface.
19683f4978c7SHeiko Schocher
19693f4978c7SHeiko Schocher		ported i2c driver to the new framework:
1970ea818dbbSHeiko Schocher		- drivers/i2c/soft_i2c.c:
1971ea818dbbSHeiko Schocher		  - activate first bus with CONFIG_SYS_I2C_SOFT define
1972ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
1973ea818dbbSHeiko Schocher		    for defining speed and slave address
1974ea818dbbSHeiko Schocher		  - activate second bus with I2C_SOFT_DECLARATIONS2 define
1975ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
1976ea818dbbSHeiko Schocher		    for defining speed and slave address
1977ea818dbbSHeiko Schocher		  - activate third bus with I2C_SOFT_DECLARATIONS3 define
1978ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
1979ea818dbbSHeiko Schocher		    for defining speed and slave address
1980ea818dbbSHeiko Schocher		  - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
1981ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
1982ea818dbbSHeiko Schocher		    for defining speed and slave address
19833f4978c7SHeiko Schocher
198400f792e0SHeiko Schocher		- drivers/i2c/fsl_i2c.c:
198500f792e0SHeiko Schocher		  - activate i2c driver with CONFIG_SYS_I2C_FSL
198600f792e0SHeiko Schocher		    define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
198700f792e0SHeiko Schocher		    offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
198800f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
198900f792e0SHeiko Schocher		    bus.
199000f792e0SHeiko Schocher		  - If your board supports a second fsl i2c bus, define
199100f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
199200f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_SPEED for the speed and
199300f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
199400f792e0SHeiko Schocher		    second bus.
199500f792e0SHeiko Schocher
19961f2ba722SSimon Glass		- drivers/i2c/tegra_i2c.c:
19971f2ba722SSimon Glass		 - activate this driver with CONFIG_SYS_I2C_TEGRA
19981f2ba722SSimon Glass		 - This driver adds 4 i2c buses with a fix speed from
19991f2ba722SSimon Glass		   100000 and the slave addr 0!
20001f2ba722SSimon Glass
2001880540deSDirk Eibach		- drivers/i2c/ppc4xx_i2c.c
2002880540deSDirk Eibach		  - activate this driver with CONFIG_SYS_I2C_PPC4XX
2003880540deSDirk Eibach		  - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2004880540deSDirk Eibach		  - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2005880540deSDirk Eibach
2006*fac96408Strem		- drivers/i2c/i2c_mxc.c
2007*fac96408Strem		  - activate this driver with CONFIG_SYS_I2C_MXC
2008*fac96408Strem		  - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2009*fac96408Strem		  - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2010*fac96408Strem		  - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2011*fac96408Strem		  - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2012*fac96408Strem		  - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2013*fac96408Strem		  - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
2014*fac96408Strem		If thoses defines are not set, default value is 100000
2015*fac96408Strem		for speed, and 0 for slave.
2016*fac96408Strem
20173f4978c7SHeiko Schocher		additional defines:
20183f4978c7SHeiko Schocher
20193f4978c7SHeiko Schocher		CONFIG_SYS_NUM_I2C_BUSES
20203f4978c7SHeiko Schocher		Hold the number of i2c busses you want to use. If you
20213f4978c7SHeiko Schocher		don't use/have i2c muxes on your i2c bus, this
20223f4978c7SHeiko Schocher		is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
20233f4978c7SHeiko Schocher		omit this define.
20243f4978c7SHeiko Schocher
20253f4978c7SHeiko Schocher		CONFIG_SYS_I2C_DIRECT_BUS
20263f4978c7SHeiko Schocher		define this, if you don't use i2c muxes on your hardware.
20273f4978c7SHeiko Schocher		if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
20283f4978c7SHeiko Schocher		omit this define.
20293f4978c7SHeiko Schocher
20303f4978c7SHeiko Schocher		CONFIG_SYS_I2C_MAX_HOPS
20313f4978c7SHeiko Schocher		define how many muxes are maximal consecutively connected
20323f4978c7SHeiko Schocher		on one i2c bus. If you not use i2c muxes, omit this
20333f4978c7SHeiko Schocher		define.
20343f4978c7SHeiko Schocher
20353f4978c7SHeiko Schocher		CONFIG_SYS_I2C_BUSES
20363f4978c7SHeiko Schocher		hold a list of busses you want to use, only used if
20373f4978c7SHeiko Schocher		CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
20383f4978c7SHeiko Schocher		a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
20393f4978c7SHeiko Schocher		CONFIG_SYS_NUM_I2C_BUSES = 9:
20403f4978c7SHeiko Schocher
20413f4978c7SHeiko Schocher		 CONFIG_SYS_I2C_BUSES	{{0, {I2C_NULL_HOP}}, \
20423f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
20433f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
20443f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
20453f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
20463f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
20473f4978c7SHeiko Schocher					{1, {I2C_NULL_HOP}}, \
20483f4978c7SHeiko Schocher					{1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
20493f4978c7SHeiko Schocher					{1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
20503f4978c7SHeiko Schocher					}
20513f4978c7SHeiko Schocher
20523f4978c7SHeiko Schocher		which defines
20533f4978c7SHeiko Schocher			bus 0 on adapter 0 without a mux
2054ea818dbbSHeiko Schocher			bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2055ea818dbbSHeiko Schocher			bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2056ea818dbbSHeiko Schocher			bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2057ea818dbbSHeiko Schocher			bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2058ea818dbbSHeiko Schocher			bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
20593f4978c7SHeiko Schocher			bus 6 on adapter 1 without a mux
2060ea818dbbSHeiko Schocher			bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2061ea818dbbSHeiko Schocher			bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
20623f4978c7SHeiko Schocher
20633f4978c7SHeiko Schocher		If you do not have i2c muxes on your board, omit this define.
20643f4978c7SHeiko Schocher
2065ea818dbbSHeiko Schocher- Legacy I2C Support:	CONFIG_HARD_I2C
20663f4978c7SHeiko Schocher
20673f4978c7SHeiko Schocher		NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
20683f4978c7SHeiko Schocher		provides the following compelling advantages:
20693f4978c7SHeiko Schocher
20703f4978c7SHeiko Schocher		- more than one i2c adapter is usable
20713f4978c7SHeiko Schocher		- approved multibus support
20723f4978c7SHeiko Schocher		- better i2c mux support
20733f4978c7SHeiko Schocher
20743f4978c7SHeiko Schocher		** Please consider updating your I2C driver now. **
20753f4978c7SHeiko Schocher
2076ea818dbbSHeiko Schocher		These enable legacy I2C serial bus commands. Defining
2077ea818dbbSHeiko Schocher		CONFIG_HARD_I2C will include the appropriate I2C driver
2078ea818dbbSHeiko Schocher		for the selected CPU.
2079c609719bSwdenk
2080b37c7e5eSwdenk		This will allow you to use i2c commands at the u-boot
2081602ad3b3SJon Loeliger		command line (as long as you set CONFIG_CMD_I2C in
2082b37c7e5eSwdenk		CONFIG_COMMANDS) and communicate with i2c based realtime
2083b37c7e5eSwdenk		clock chips. See common/cmd_i2c.c for a description of the
2084c609719bSwdenk		command line interface.
2085c609719bSwdenk
2086bb99ad6dSBen Warren		CONFIG_HARD_I2C selects a hardware I2C controller.
2087c609719bSwdenk
2088b37c7e5eSwdenk		There are several other quantities that must also be
2089ea818dbbSHeiko Schocher		defined when you define CONFIG_HARD_I2C.
2090c609719bSwdenk
20916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		In both cases you will need to define CONFIG_SYS_I2C_SPEED
2092b37c7e5eSwdenk		to be the frequency (in Hz) at which you wish your i2c bus
20936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
209411ccc33fSMarcel Ziswiler		the CPU's i2c node address).
2095c609719bSwdenk
20968d321b81SPeter Tyser		Now, the u-boot i2c code for the mpc8xx
2097a47a12beSStefan Roese		(arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
20988d321b81SPeter Tyser		and so its address should therefore be cleared to 0 (See,
20998d321b81SPeter Tyser		eg, MPC823e User's Manual p.16-473). So, set
21008d321b81SPeter Tyser		CONFIG_SYS_I2C_SLAVE to 0.
2101b37c7e5eSwdenk
21025da71efaSEric Millbrandt		CONFIG_SYS_I2C_INIT_MPC5XXX
21035da71efaSEric Millbrandt
21045da71efaSEric Millbrandt		When a board is reset during an i2c bus transfer
21055da71efaSEric Millbrandt		chips might think that the current transfer is still
21065da71efaSEric Millbrandt		in progress.  Reset the slave devices by sending start
21075da71efaSEric Millbrandt		commands until the slave device responds.
21085da71efaSEric Millbrandt
2109b37c7e5eSwdenk		That's all that's required for CONFIG_HARD_I2C.
2110b37c7e5eSwdenk
2111ea818dbbSHeiko Schocher		If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
2112b37c7e5eSwdenk		then the following macros need to be defined (examples are
2113b37c7e5eSwdenk		from include/configs/lwmon.h):
2114c609719bSwdenk
2115c609719bSwdenk		I2C_INIT
2116c609719bSwdenk
2117b37c7e5eSwdenk		(Optional). Any commands necessary to enable the I2C
2118c609719bSwdenk		controller or configure ports.
2119c609719bSwdenk
2120b37c7e5eSwdenk		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
2121b37c7e5eSwdenk
2122c609719bSwdenk		I2C_PORT
2123c609719bSwdenk
2124c609719bSwdenk		(Only for MPC8260 CPU). The I/O port to use (the code
2125c609719bSwdenk		assumes both bits are on the same port). Valid values
2126c609719bSwdenk		are 0..3 for ports A..D.
2127c609719bSwdenk
2128c609719bSwdenk		I2C_ACTIVE
2129c609719bSwdenk
2130c609719bSwdenk		The code necessary to make the I2C data line active
2131c609719bSwdenk		(driven).  If the data line is open collector, this
2132c609719bSwdenk		define can be null.
2133c609719bSwdenk
2134b37c7e5eSwdenk		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
2135b37c7e5eSwdenk
2136c609719bSwdenk		I2C_TRISTATE
2137c609719bSwdenk
2138c609719bSwdenk		The code necessary to make the I2C data line tri-stated
2139c609719bSwdenk		(inactive).  If the data line is open collector, this
2140c609719bSwdenk		define can be null.
2141c609719bSwdenk
2142b37c7e5eSwdenk		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2143b37c7e5eSwdenk
2144c609719bSwdenk		I2C_READ
2145c609719bSwdenk
2146472d5460SYork Sun		Code that returns true if the I2C data line is high,
2147472d5460SYork Sun		false if it is low.
2148c609719bSwdenk
2149b37c7e5eSwdenk		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2150b37c7e5eSwdenk
2151c609719bSwdenk		I2C_SDA(bit)
2152c609719bSwdenk
2153472d5460SYork Sun		If <bit> is true, sets the I2C data line high. If it
2154472d5460SYork Sun		is false, it clears it (low).
2155c609719bSwdenk
2156b37c7e5eSwdenk		eg: #define I2C_SDA(bit) \
2157b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
2158b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
2159b37c7e5eSwdenk
2160c609719bSwdenk		I2C_SCL(bit)
2161c609719bSwdenk
2162472d5460SYork Sun		If <bit> is true, sets the I2C clock line high. If it
2163472d5460SYork Sun		is false, it clears it (low).
2164c609719bSwdenk
2165b37c7e5eSwdenk		eg: #define I2C_SCL(bit) \
2166b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
2167b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
2168b37c7e5eSwdenk
2169c609719bSwdenk		I2C_DELAY
2170c609719bSwdenk
2171c609719bSwdenk		This delay is invoked four times per clock cycle so this
2172c609719bSwdenk		controls the rate of data transfer.  The data rate thus
2173b37c7e5eSwdenk		is 1 / (I2C_DELAY * 4). Often defined to be something
2174b37c7e5eSwdenk		like:
2175b37c7e5eSwdenk
2176b37c7e5eSwdenk		#define I2C_DELAY  udelay(2)
2177c609719bSwdenk
2178793b5726SMike Frysinger		CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2179793b5726SMike Frysinger
2180793b5726SMike Frysinger		If your arch supports the generic GPIO framework (asm/gpio.h),
2181793b5726SMike Frysinger		then you may alternatively define the two GPIOs that are to be
2182793b5726SMike Frysinger		used as SCL / SDA.  Any of the previous I2C_xxx macros will
2183793b5726SMike Frysinger		have GPIO-based defaults assigned to them as appropriate.
2184793b5726SMike Frysinger
2185793b5726SMike Frysinger		You should define these to the GPIO value as given directly to
2186793b5726SMike Frysinger		the generic GPIO functions.
2187793b5726SMike Frysinger
21886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_INIT_BOARD
218947cd00faSwdenk
219047cd00faSwdenk		When a board is reset during an i2c bus transfer
219147cd00faSwdenk		chips might think that the current transfer is still
219247cd00faSwdenk		in progress. On some boards it is possible to access
219347cd00faSwdenk		the i2c SCLK line directly, either by using the
219447cd00faSwdenk		processor pin as a GPIO or by having a second pin
219547cd00faSwdenk		connected to the bus. If this option is defined a
219647cd00faSwdenk		custom i2c_init_board() routine in boards/xxx/board.c
219747cd00faSwdenk		is run early in the boot sequence.
219847cd00faSwdenk
219926a33504SRichard Retanubun		CONFIG_SYS_I2C_BOARD_LATE_INIT
220026a33504SRichard Retanubun
220126a33504SRichard Retanubun		An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
220226a33504SRichard Retanubun		defined a custom i2c_board_late_init() routine in
220326a33504SRichard Retanubun		boards/xxx/board.c is run AFTER the operations in i2c_init()
220426a33504SRichard Retanubun		is completed. This callpoint can be used to unreset i2c bus
220526a33504SRichard Retanubun		using CPU i2c controller register accesses for CPUs whose i2c
220626a33504SRichard Retanubun		controller provide such a method. It is called at the end of
220726a33504SRichard Retanubun		i2c_init() to allow i2c_init operations to setup the i2c bus
220826a33504SRichard Retanubun		controller on the CPU (e.g. setting bus speed & slave address).
220926a33504SRichard Retanubun
221017ea1177Swdenk		CONFIG_I2CFAST (PPC405GP|PPC405EP only)
221117ea1177Swdenk
221217ea1177Swdenk		This option enables configuration of bi_iic_fast[] flags
221317ea1177Swdenk		in u-boot bd_info structure based on u-boot environment
221417ea1177Swdenk		variable "i2cfast". (see also i2cfast)
221517ea1177Swdenk
2216bb99ad6dSBen Warren		CONFIG_I2C_MULTI_BUS
2217bb99ad6dSBen Warren
2218bb99ad6dSBen Warren		This option allows the use of multiple I2C buses, each of which
2219bb99ad6dSBen Warren		must have a controller.	 At any point in time, only one bus is
2220bb99ad6dSBen Warren		active.	 To switch to a different bus, use the 'i2c dev' command.
2221bb99ad6dSBen Warren		Note that bus numbering is zero-based.
2222bb99ad6dSBen Warren
22236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_NOPROBES
2224bb99ad6dSBen Warren
2225bb99ad6dSBen Warren		This option specifies a list of I2C devices that will be skipped
22260f89c54bSPeter Tyser		when the 'i2c probe' command is issued.	 If CONFIG_I2C_MULTI_BUS
22270f89c54bSPeter Tyser		is set, specify a list of bus-device pairs.  Otherwise, specify
22280f89c54bSPeter Tyser		a 1D array of device addresses
2229bb99ad6dSBen Warren
2230bb99ad6dSBen Warren		e.g.
2231bb99ad6dSBen Warren			#undef	CONFIG_I2C_MULTI_BUS
22326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
2233bb99ad6dSBen Warren
2234bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on a board with one I2C bus
2235bb99ad6dSBen Warren
2236bb99ad6dSBen Warren			#define CONFIG_I2C_MULTI_BUS
22376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_MULTI_NOPROBES	{{0,0x50},{0,0x68},{1,0x54}}
2238bb99ad6dSBen Warren
2239bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2240bb99ad6dSBen Warren
22416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SPD_BUS_NUM
2242be5e6181STimur Tabi
2243be5e6181STimur Tabi		If defined, then this indicates the I2C bus number for DDR SPD.
2244be5e6181STimur Tabi		If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2245be5e6181STimur Tabi
22466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_BUS_NUM
22470dc018ecSStefan Roese
22480dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the RTC.
22490dc018ecSStefan Roese		If not defined, then U-Boot assumes that RTC is on I2C bus 0.
22500dc018ecSStefan Roese
22516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_DTT_BUS_NUM
22520dc018ecSStefan Roese
22530dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the DTT.
22540dc018ecSStefan Roese		If not defined, then U-Boot assumes that DTT is on I2C bus 0.
22550dc018ecSStefan Roese
22566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_DTT_ADDR:
22579ebbb54fSVictor Gallardo
22589ebbb54fSVictor Gallardo		If defined, specifies the I2C address of the DTT device.
22599ebbb54fSVictor Gallardo		If not defined, then U-Boot uses predefined value for
22609ebbb54fSVictor Gallardo		specified DTT device.
22619ebbb54fSVictor Gallardo
22622ac6985aSAndrew Dyer		CONFIG_SOFT_I2C_READ_REPEATED_START
22632ac6985aSAndrew Dyer
22642ac6985aSAndrew Dyer		defining this will force the i2c_read() function in
22652ac6985aSAndrew Dyer		the soft_i2c driver to perform an I2C repeated start
22662ac6985aSAndrew Dyer		between writing the address pointer and reading the
22672ac6985aSAndrew Dyer		data.  If this define is omitted the default behaviour
22682ac6985aSAndrew Dyer		of doing a stop-start sequence will be used.  Most I2C
22692ac6985aSAndrew Dyer		devices can use either method, but some require one or
22702ac6985aSAndrew Dyer		the other.
2271be5e6181STimur Tabi
2272c609719bSwdenk- SPI Support:	CONFIG_SPI
2273c609719bSwdenk
2274c609719bSwdenk		Enables SPI driver (so far only tested with
2275c609719bSwdenk		SPI EEPROM, also an instance works with Crystal A/D and
2276c609719bSwdenk		D/As on the SACSng board)
2277c609719bSwdenk
22786639562eSYoshihiro Shimoda		CONFIG_SH_SPI
22796639562eSYoshihiro Shimoda
22806639562eSYoshihiro Shimoda		Enables the driver for SPI controller on SuperH. Currently
22816639562eSYoshihiro Shimoda		only SH7757 is supported.
22826639562eSYoshihiro Shimoda
2283c609719bSwdenk		CONFIG_SPI_X
2284c609719bSwdenk
2285c609719bSwdenk		Enables extended (16-bit) SPI EEPROM addressing.
2286c609719bSwdenk		(symmetrical to CONFIG_I2C_X)
2287c609719bSwdenk
2288c609719bSwdenk		CONFIG_SOFT_SPI
2289c609719bSwdenk
2290c609719bSwdenk		Enables a software (bit-bang) SPI driver rather than
2291c609719bSwdenk		using hardware support. This is a general purpose
2292c609719bSwdenk		driver that only requires three general I/O port pins
2293c609719bSwdenk		(two outputs, one input) to function. If this is
2294c609719bSwdenk		defined, the board configuration must define several
2295c609719bSwdenk		SPI configuration items (port pins to use, etc). For
2296c609719bSwdenk		an example, see include/configs/sacsng.h.
2297c609719bSwdenk
229804a9e118SBen Warren		CONFIG_HARD_SPI
229904a9e118SBen Warren
230004a9e118SBen Warren		Enables a hardware SPI driver for general-purpose reads
230104a9e118SBen Warren		and writes.  As with CONFIG_SOFT_SPI, the board configuration
230204a9e118SBen Warren		must define a list of chip-select function pointers.
230304a9e118SBen Warren		Currently supported on some MPC8xxx processors.	 For an
230404a9e118SBen Warren		example, see include/configs/mpc8349emds.h.
230504a9e118SBen Warren
230638254f45SGuennadi Liakhovetski		CONFIG_MXC_SPI
230738254f45SGuennadi Liakhovetski
230838254f45SGuennadi Liakhovetski		Enables the driver for the SPI controllers on i.MX and MXC
23092e3cd1cdSFabio Estevam		SoCs. Currently i.MX31/35/51 are supported.
231038254f45SGuennadi Liakhovetski
23110133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA
23120133502eSMatthias Fuchs
23130133502eSMatthias Fuchs		Enables FPGA subsystem.
23140133502eSMatthias Fuchs
23150133502eSMatthias Fuchs		CONFIG_FPGA_<vendor>
23160133502eSMatthias Fuchs
23170133502eSMatthias Fuchs		Enables support for specific chip vendors.
23180133502eSMatthias Fuchs		(ALTERA, XILINX)
23190133502eSMatthias Fuchs
23200133502eSMatthias Fuchs		CONFIG_FPGA_<family>
23210133502eSMatthias Fuchs
23220133502eSMatthias Fuchs		Enables support for FPGA family.
23230133502eSMatthias Fuchs		(SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
23240133502eSMatthias Fuchs
23250133502eSMatthias Fuchs		CONFIG_FPGA_COUNT
2326c609719bSwdenk
2327c609719bSwdenk		Specify the number of FPGA devices to support.
2328c609719bSwdenk
23296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_PROG_FEEDBACK
2330c609719bSwdenk
2331c609719bSwdenk		Enable printing of hash marks during FPGA configuration.
2332c609719bSwdenk
23336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_BUSY
2334c609719bSwdenk
2335c609719bSwdenk		Enable checks on FPGA configuration interface busy
2336c609719bSwdenk		status by the configuration function. This option
2337c609719bSwdenk		will require a board or device specific function to
2338c609719bSwdenk		be written.
2339c609719bSwdenk
2340c609719bSwdenk		CONFIG_FPGA_DELAY
2341c609719bSwdenk
2342c609719bSwdenk		If defined, a function that provides delays in the FPGA
2343c609719bSwdenk		configuration driver.
2344c609719bSwdenk
23456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_CTRLC
2346c609719bSwdenk		Allow Control-C to interrupt FPGA configuration
2347c609719bSwdenk
23486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_ERROR
2349c609719bSwdenk
2350c609719bSwdenk		Check for configuration errors during FPGA bitfile
2351c609719bSwdenk		loading. For example, abort during Virtex II
2352c609719bSwdenk		configuration if the INIT_B line goes low (which
2353c609719bSwdenk		indicated a CRC error).
2354c609719bSwdenk
23556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_INIT
2356c609719bSwdenk
2357c609719bSwdenk		Maximum time to wait for the INIT_B line to deassert
2358c609719bSwdenk		after PROB_B has been deasserted during a Virtex II
2359c609719bSwdenk		FPGA configuration sequence. The default time is 500
236011ccc33fSMarcel Ziswiler		ms.
2361c609719bSwdenk
23626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_BUSY
2363c609719bSwdenk
2364c609719bSwdenk		Maximum time to wait for BUSY to deassert during
236511ccc33fSMarcel Ziswiler		Virtex II FPGA configuration. The default is 5 ms.
2366c609719bSwdenk
23676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_CONFIG
2368c609719bSwdenk
2369c609719bSwdenk		Time to wait after FPGA configuration. The default is
237011ccc33fSMarcel Ziswiler		200 ms.
2371c609719bSwdenk
2372c609719bSwdenk- Configuration Management:
2373c609719bSwdenk		CONFIG_IDENT_STRING
2374c609719bSwdenk
2375c609719bSwdenk		If defined, this string will be added to the U-Boot
2376c609719bSwdenk		version information (U_BOOT_VERSION)
2377c609719bSwdenk
2378c609719bSwdenk- Vendor Parameter Protection:
2379c609719bSwdenk
2380c609719bSwdenk		U-Boot considers the values of the environment
2381c609719bSwdenk		variables "serial#" (Board Serial Number) and
23827152b1d0Swdenk		"ethaddr" (Ethernet Address) to be parameters that
2383c609719bSwdenk		are set once by the board vendor / manufacturer, and
2384c609719bSwdenk		protects these variables from casual modification by
2385c609719bSwdenk		the user. Once set, these variables are read-only,
2386c609719bSwdenk		and write or delete attempts are rejected. You can
238711ccc33fSMarcel Ziswiler		change this behaviour:
2388c609719bSwdenk
2389c609719bSwdenk		If CONFIG_ENV_OVERWRITE is #defined in your config
2390c609719bSwdenk		file, the write protection for vendor parameters is
239147cd00faSwdenk		completely disabled. Anybody can change or delete
2392c609719bSwdenk		these parameters.
2393c609719bSwdenk
2394c609719bSwdenk		Alternatively, if you #define _both_ CONFIG_ETHADDR
2395c609719bSwdenk		_and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
239611ccc33fSMarcel Ziswiler		Ethernet address is installed in the environment,
2397c609719bSwdenk		which can be changed exactly ONCE by the user. [The
2398c609719bSwdenk		serial# is unaffected by this, i. e. it remains
2399c609719bSwdenk		read-only.]
2400c609719bSwdenk
24012598090bSJoe Hershberger		The same can be accomplished in a more flexible way
24022598090bSJoe Hershberger		for any variable by configuring the type of access
24032598090bSJoe Hershberger		to allow for those variables in the ".flags" variable
24042598090bSJoe Hershberger		or define CONFIG_ENV_FLAGS_LIST_STATIC.
24052598090bSJoe Hershberger
2406c609719bSwdenk- Protected RAM:
2407c609719bSwdenk		CONFIG_PRAM
2408c609719bSwdenk
2409c609719bSwdenk		Define this variable to enable the reservation of
2410c609719bSwdenk		"protected RAM", i. e. RAM which is not overwritten
2411c609719bSwdenk		by U-Boot. Define CONFIG_PRAM to hold the number of
2412c609719bSwdenk		kB you want to reserve for pRAM. You can overwrite
2413c609719bSwdenk		this default value by defining an environment
2414c609719bSwdenk		variable "pram" to the number of kB you want to
2415c609719bSwdenk		reserve. Note that the board info structure will
2416c609719bSwdenk		still show the full amount of RAM. If pRAM is
2417c609719bSwdenk		reserved, a new environment variable "mem" will
2418c609719bSwdenk		automatically be defined to hold the amount of
2419c609719bSwdenk		remaining RAM in a form that can be passed as boot
2420c609719bSwdenk		argument to Linux, for instance like that:
2421c609719bSwdenk
2422fe126d8bSWolfgang Denk			setenv bootargs ... mem=\${mem}
2423c609719bSwdenk			saveenv
2424c609719bSwdenk
2425c609719bSwdenk		This way you can tell Linux not to use this memory,
2426c609719bSwdenk		either, which results in a memory region that will
2427c609719bSwdenk		not be affected by reboots.
2428c609719bSwdenk
2429c609719bSwdenk		*WARNING* If your board configuration uses automatic
2430c609719bSwdenk		detection of the RAM size, you must make sure that
2431c609719bSwdenk		this memory test is non-destructive. So far, the
2432c609719bSwdenk		following board configurations are known to be
2433c609719bSwdenk		"pRAM-clean":
2434c609719bSwdenk
24351b0757ecSWolfgang Denk			IVMS8, IVML24, SPD8xx, TQM8xxL,
24361b0757ecSWolfgang Denk			HERMES, IP860, RPXlite, LWMON,
2437544d97e9SWolfgang Denk			FLAGADM, TQM8260
2438c609719bSwdenk
243940fef049SGabe Black- Access to physical memory region (> 4GB)
244040fef049SGabe Black		Some basic support is provided for operations on memory not
244140fef049SGabe Black		normally accessible to U-Boot - e.g. some architectures
244240fef049SGabe Black		support access to more than 4GB of memory on 32-bit
244340fef049SGabe Black		machines using physical address extension or similar.
244440fef049SGabe Black		Define CONFIG_PHYSMEM to access this basic support, which
244540fef049SGabe Black		currently only supports clearing the memory.
244640fef049SGabe Black
2447c609719bSwdenk- Error Recovery:
2448c609719bSwdenk		CONFIG_PANIC_HANG
2449c609719bSwdenk
2450c609719bSwdenk		Define this variable to stop the system in case of a
2451c609719bSwdenk		fatal error, so that you have to reset it manually.
2452c609719bSwdenk		This is probably NOT a good idea for an embedded
245311ccc33fSMarcel Ziswiler		system where you want the system to reboot
2454c609719bSwdenk		automatically as fast as possible, but it may be
2455c609719bSwdenk		useful during development since you can try to debug
2456c609719bSwdenk		the conditions that lead to the situation.
2457c609719bSwdenk
2458c609719bSwdenk		CONFIG_NET_RETRY_COUNT
2459c609719bSwdenk
2460c609719bSwdenk		This variable defines the number of retries for
2461c609719bSwdenk		network operations like ARP, RARP, TFTP, or BOOTP
2462c609719bSwdenk		before giving up the operation. If not defined, a
2463c609719bSwdenk		default value of 5 is used.
2464c609719bSwdenk
246540cb90eeSGuennadi Liakhovetski		CONFIG_ARP_TIMEOUT
246640cb90eeSGuennadi Liakhovetski
246740cb90eeSGuennadi Liakhovetski		Timeout waiting for an ARP reply in milliseconds.
246840cb90eeSGuennadi Liakhovetski
246948a3e999STetsuyuki Kobayashi		CONFIG_NFS_TIMEOUT
247048a3e999STetsuyuki Kobayashi
247148a3e999STetsuyuki Kobayashi		Timeout in milliseconds used in NFS protocol.
247248a3e999STetsuyuki Kobayashi		If you encounter "ERROR: Cannot umount" in nfs command,
247348a3e999STetsuyuki Kobayashi		try longer timeout such as
247448a3e999STetsuyuki Kobayashi		#define CONFIG_NFS_TIMEOUT 10000UL
247548a3e999STetsuyuki Kobayashi
2476c609719bSwdenk- Command Interpreter:
24778078f1a5SWolfgang Denk		CONFIG_AUTO_COMPLETE
247804a85b3bSwdenk
247904a85b3bSwdenk		Enable auto completion of commands using TAB.
248004a85b3bSwdenk
24818078f1a5SWolfgang Denk		Note that this feature has NOT been implemented yet
24828078f1a5SWolfgang Denk		for the "hush" shell.
24838078f1a5SWolfgang Denk
24848078f1a5SWolfgang Denk
24856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_HUSH_PARSER
2486c609719bSwdenk
2487c609719bSwdenk		Define this variable to enable the "hush" shell (from
2488c609719bSwdenk		Busybox) as command line interpreter, thus enabling
2489c609719bSwdenk		powerful command line syntax like
2490c609719bSwdenk		if...then...else...fi conditionals or `&&' and '||'
2491c609719bSwdenk		constructs ("shell scripts").
2492c609719bSwdenk
2493c609719bSwdenk		If undefined, you get the old, much simpler behaviour
2494c609719bSwdenk		with a somewhat smaller memory footprint.
2495c609719bSwdenk
2496c609719bSwdenk
24976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_PROMPT_HUSH_PS2
2498c609719bSwdenk
2499c609719bSwdenk		This defines the secondary prompt string, which is
2500c609719bSwdenk		printed when the command interpreter needs more input
2501c609719bSwdenk		to complete a command. Usually "> ".
2502c609719bSwdenk
2503c609719bSwdenk	Note:
2504c609719bSwdenk
2505c609719bSwdenk		In the current implementation, the local variables
2506c609719bSwdenk		space and global environment variables space are
2507c609719bSwdenk		separated. Local variables are those you define by
25083b57fe0aSwdenk		simply typing `name=value'. To access a local
2509c609719bSwdenk		variable later on, you have write `$name' or
25103b57fe0aSwdenk		`${name}'; to execute the contents of a variable
25113b57fe0aSwdenk		directly type `$name' at the command prompt.
2512c609719bSwdenk
2513c609719bSwdenk		Global environment variables are those you use
2514c609719bSwdenk		setenv/printenv to work with. To run a command stored
2515c609719bSwdenk		in such a variable, you need to use the run command,
2516c609719bSwdenk		and you must not use the '$' sign to access them.
2517c609719bSwdenk
2518c609719bSwdenk		To store commands and special characters in a
2519c609719bSwdenk		variable, please use double quotation marks
2520c609719bSwdenk		surrounding the whole text of the variable, instead
2521c609719bSwdenk		of the backslashes before semicolons and special
2522c609719bSwdenk		symbols.
2523c609719bSwdenk
2524aa0c71acSWolfgang Denk- Commandline Editing and History:
2525aa0c71acSWolfgang Denk		CONFIG_CMDLINE_EDITING
2526aa0c71acSWolfgang Denk
252711ccc33fSMarcel Ziswiler		Enable editing and History functions for interactive
2528aa0c71acSWolfgang Denk		commandline input operations
2529aa0c71acSWolfgang Denk
2530a8c7c708Swdenk- Default Environment:
2531c609719bSwdenk		CONFIG_EXTRA_ENV_SETTINGS
2532c609719bSwdenk
2533c609719bSwdenk		Define this to contain any number of null terminated
2534c609719bSwdenk		strings (variable = value pairs) that will be part of
25357152b1d0Swdenk		the default environment compiled into the boot image.
25362262cfeeSwdenk
2537c609719bSwdenk		For example, place something like this in your
2538c609719bSwdenk		board's config file:
2539c609719bSwdenk
2540c609719bSwdenk		#define CONFIG_EXTRA_ENV_SETTINGS \
2541c609719bSwdenk			"myvar1=value1\0" \
2542c609719bSwdenk			"myvar2=value2\0"
2543c609719bSwdenk
2544c609719bSwdenk		Warning: This method is based on knowledge about the
2545c609719bSwdenk		internal format how the environment is stored by the
25462262cfeeSwdenk		U-Boot code. This is NOT an official, exported
2547c609719bSwdenk		interface! Although it is unlikely that this format
25487152b1d0Swdenk		will change soon, there is no guarantee either.
2549c609719bSwdenk		You better know what you are doing here.
2550c609719bSwdenk
2551c609719bSwdenk		Note: overly (ab)use of the default environment is
2552c609719bSwdenk		discouraged. Make sure to check other ways to preset
255374de7aefSWolfgang Denk		the environment like the "source" command or the
2554c609719bSwdenk		boot command first.
2555c609719bSwdenk
25565e724ca2SStephen Warren		CONFIG_ENV_VARS_UBOOT_CONFIG
25575e724ca2SStephen Warren
25585e724ca2SStephen Warren		Define this in order to add variables describing the
25595e724ca2SStephen Warren		U-Boot build configuration to the default environment.
25605e724ca2SStephen Warren		These will be named arch, cpu, board, vendor, and soc.
25615e724ca2SStephen Warren
25625e724ca2SStephen Warren		Enabling this option will cause the following to be defined:
25635e724ca2SStephen Warren
25645e724ca2SStephen Warren		- CONFIG_SYS_ARCH
25655e724ca2SStephen Warren		- CONFIG_SYS_CPU
25665e724ca2SStephen Warren		- CONFIG_SYS_BOARD
25675e724ca2SStephen Warren		- CONFIG_SYS_VENDOR
25685e724ca2SStephen Warren		- CONFIG_SYS_SOC
25695e724ca2SStephen Warren
25707e27f89fSTom Rini		CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
25717e27f89fSTom Rini
25727e27f89fSTom Rini		Define this in order to add variables describing certain
25737e27f89fSTom Rini		run-time determined information about the hardware to the
25747e27f89fSTom Rini		environment.  These will be named board_name, board_rev.
25757e27f89fSTom Rini
257606fd8538SSimon Glass		CONFIG_DELAY_ENVIRONMENT
257706fd8538SSimon Glass
257806fd8538SSimon Glass		Normally the environment is loaded when the board is
257906fd8538SSimon Glass		intialised so that it is available to U-Boot. This inhibits
258006fd8538SSimon Glass		that so that the environment is not available until
258106fd8538SSimon Glass		explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
258206fd8538SSimon Glass		this is instead controlled by the value of
258306fd8538SSimon Glass		/config/load-environment.
258406fd8538SSimon Glass
2585a8c7c708Swdenk- DataFlash Support:
25862abbe075Swdenk		CONFIG_HAS_DATAFLASH
25872abbe075Swdenk
25882abbe075Swdenk		Defining this option enables DataFlash features and
25892abbe075Swdenk		allows to read/write in Dataflash via the standard
25902abbe075Swdenk		commands cp, md...
25912abbe075Swdenk
2592f61ec45eSEric Nelson- Serial Flash support
2593f61ec45eSEric Nelson		CONFIG_CMD_SF
2594f61ec45eSEric Nelson
2595f61ec45eSEric Nelson		Defining this option enables SPI flash commands
2596f61ec45eSEric Nelson		'sf probe/read/write/erase/update'.
2597f61ec45eSEric Nelson
2598f61ec45eSEric Nelson		Usage requires an initial 'probe' to define the serial
2599f61ec45eSEric Nelson		flash parameters, followed by read/write/erase/update
2600f61ec45eSEric Nelson		commands.
2601f61ec45eSEric Nelson
2602f61ec45eSEric Nelson		The following defaults may be provided by the platform
2603f61ec45eSEric Nelson		to handle the common case when only a single serial
2604f61ec45eSEric Nelson		flash is present on the system.
2605f61ec45eSEric Nelson
2606f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_BUS		Bus identifier
2607f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_CS		Chip-select
2608f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_MODE 		(see include/spi.h)
2609f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_SPEED		in Hz
2610f61ec45eSEric Nelson
261124007273SSimon Glass		CONFIG_CMD_SF_TEST
261224007273SSimon Glass
261324007273SSimon Glass		Define this option to include a destructive SPI flash
261424007273SSimon Glass		test ('sf test').
261524007273SSimon Glass
26161dcd6d03SJagannadha Sutradharudu Teki		CONFIG_SPI_FLASH_BAR		Ban/Extended Addr Reg
26171dcd6d03SJagannadha Sutradharudu Teki
26181dcd6d03SJagannadha Sutradharudu Teki		Define this option to use the Bank addr/Extended addr
26191dcd6d03SJagannadha Sutradharudu Teki		support on SPI flashes which has size > 16Mbytes.
26201dcd6d03SJagannadha Sutradharudu Teki
26213f85ce27Swdenk- SystemACE Support:
26223f85ce27Swdenk		CONFIG_SYSTEMACE
26233f85ce27Swdenk
26243f85ce27Swdenk		Adding this option adds support for Xilinx SystemACE
26253f85ce27Swdenk		chips attached via some sort of local bus. The address
262611ccc33fSMarcel Ziswiler		of the chip must also be defined in the
26276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SYSTEMACE_BASE macro. For example:
26283f85ce27Swdenk
26293f85ce27Swdenk		#define CONFIG_SYSTEMACE
26306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
26313f85ce27Swdenk
26323f85ce27Swdenk		When SystemACE support is added, the "ace" device type
26333f85ce27Swdenk		becomes available to the fat commands, i.e. fatls.
26343f85ce27Swdenk
2635ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port:
2636ecb0ccd9SWolfgang Denk		CONFIG_TFTP_PORT
2637ecb0ccd9SWolfgang Denk
263828cb9375SWolfgang Denk		If this is defined, the environment variable tftpsrcp
2639ecb0ccd9SWolfgang Denk		is used to supply the TFTP UDP source port value.
264028cb9375SWolfgang Denk		If tftpsrcp isn't defined, the normal pseudo-random port
2641ecb0ccd9SWolfgang Denk		number generator is used.
2642ecb0ccd9SWolfgang Denk
264328cb9375SWolfgang Denk		Also, the environment variable tftpdstp is used to supply
264428cb9375SWolfgang Denk		the TFTP UDP destination port value.  If tftpdstp isn't
264528cb9375SWolfgang Denk		defined, the normal port 69 is used.
264628cb9375SWolfgang Denk
264728cb9375SWolfgang Denk		The purpose for tftpsrcp is to allow a TFTP server to
2648ecb0ccd9SWolfgang Denk		blindly start the TFTP transfer using the pre-configured
2649ecb0ccd9SWolfgang Denk		target IP address and UDP port. This has the effect of
2650ecb0ccd9SWolfgang Denk		"punching through" the (Windows XP) firewall, allowing
2651ecb0ccd9SWolfgang Denk		the remainder of the TFTP transfer to proceed normally.
2652ecb0ccd9SWolfgang Denk		A better solution is to properly configure the firewall,
2653ecb0ccd9SWolfgang Denk		but sometimes that is not allowed.
2654ecb0ccd9SWolfgang Denk
2655bf36c5d5SSimon Glass- Hashing support:
2656bf36c5d5SSimon Glass		CONFIG_CMD_HASH
2657bf36c5d5SSimon Glass
2658bf36c5d5SSimon Glass		This enables a generic 'hash' command which can produce
2659bf36c5d5SSimon Glass		hashes / digests from a few algorithms (e.g. SHA1, SHA256).
2660bf36c5d5SSimon Glass
2661bf36c5d5SSimon Glass		CONFIG_HASH_VERIFY
2662bf36c5d5SSimon Glass
2663bf36c5d5SSimon Glass		Enable the hash verify command (hash -v). This adds to code
2664bf36c5d5SSimon Glass		size a little.
2665bf36c5d5SSimon Glass
2666bf36c5d5SSimon Glass		CONFIG_SHA1 - support SHA1 hashing
2667bf36c5d5SSimon Glass		CONFIG_SHA256 - support SHA256 hashing
2668bf36c5d5SSimon Glass
2669bf36c5d5SSimon Glass		Note: There is also a sha1sum command, which should perhaps
2670bf36c5d5SSimon Glass		be deprecated in favour of 'hash sha1'.
2671bf36c5d5SSimon Glass
2672a11f1873SRobert Winkler- Freescale i.MX specific commands:
2673a11f1873SRobert Winkler		CONFIG_CMD_HDMIDETECT
2674a11f1873SRobert Winkler		This enables 'hdmidet' command which returns true if an
2675a11f1873SRobert Winkler		HDMI monitor is detected.  This command is i.MX 6 specific.
2676a11f1873SRobert Winkler
2677a11f1873SRobert Winkler		CONFIG_CMD_BMODE
2678a11f1873SRobert Winkler		This enables the 'bmode' (bootmode) command for forcing
2679a11f1873SRobert Winkler		a boot from specific media.
2680a11f1873SRobert Winkler
2681a11f1873SRobert Winkler		This is useful for forcing the ROM's usb downloader to
2682a11f1873SRobert Winkler		activate upon a watchdog reset which is nice when iterating
2683a11f1873SRobert Winkler		on U-Boot.  Using the reset button or running bmode normal
2684a11f1873SRobert Winkler		will set it back to normal.  This command currently
2685a11f1873SRobert Winkler		supports i.MX53 and i.MX6.
2686a11f1873SRobert Winkler
268719c402afSSimon Glass- Signing support:
268819c402afSSimon Glass		CONFIG_RSA
268919c402afSSimon Glass
269019c402afSSimon Glass		This enables the RSA algorithm used for FIT image verification
269119c402afSSimon Glass		in U-Boot. See doc/uImage/signature for more information.
269219c402afSSimon Glass
269319c402afSSimon Glass		The signing part is build into mkimage regardless of this
269419c402afSSimon Glass		option.
269519c402afSSimon Glass
269619c402afSSimon Glass
2697a8c7c708Swdenk- Show boot progress:
2698c609719bSwdenk		CONFIG_SHOW_BOOT_PROGRESS
2699c609719bSwdenk
2700c609719bSwdenk		Defining this option allows to add some board-
2701c609719bSwdenk		specific code (calling a user-provided function
2702c609719bSwdenk		"show_boot_progress(int)") that enables you to show
2703c609719bSwdenk		the system's boot progress on some display (for
2704c609719bSwdenk		example, some LED's) on your board. At the moment,
2705c609719bSwdenk		the following checkpoints are implemented:
2706c609719bSwdenk
27073a608ca0SSimon Glass- Detailed boot stage timing
27083a608ca0SSimon Glass		CONFIG_BOOTSTAGE
27093a608ca0SSimon Glass		Define this option to get detailed timing of each stage
27103a608ca0SSimon Glass		of the boot process.
27113a608ca0SSimon Glass
27123a608ca0SSimon Glass		CONFIG_BOOTSTAGE_USER_COUNT
27133a608ca0SSimon Glass		This is the number of available user bootstage records.
27143a608ca0SSimon Glass		Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
27153a608ca0SSimon Glass		a new ID will be allocated from this stash. If you exceed
27163a608ca0SSimon Glass		the limit, recording will stop.
27173a608ca0SSimon Glass
27183a608ca0SSimon Glass		CONFIG_BOOTSTAGE_REPORT
27193a608ca0SSimon Glass		Define this to print a report before boot, similar to this:
27203a608ca0SSimon Glass
27213a608ca0SSimon Glass		Timer summary in microseconds:
27223a608ca0SSimon Glass		       Mark    Elapsed  Stage
27233a608ca0SSimon Glass			  0          0  reset
27243a608ca0SSimon Glass		  3,575,678  3,575,678  board_init_f start
27253a608ca0SSimon Glass		  3,575,695         17  arch_cpu_init A9
27263a608ca0SSimon Glass		  3,575,777         82  arch_cpu_init done
27273a608ca0SSimon Glass		  3,659,598     83,821  board_init_r start
27283a608ca0SSimon Glass		  3,910,375    250,777  main_loop
27293a608ca0SSimon Glass		 29,916,167 26,005,792  bootm_start
27303a608ca0SSimon Glass		 30,361,327    445,160  start_kernel
27313a608ca0SSimon Glass
27322eba38cfSSimon Glass		CONFIG_CMD_BOOTSTAGE
27332eba38cfSSimon Glass		Add a 'bootstage' command which supports printing a report
27342eba38cfSSimon Glass		and un/stashing of bootstage data.
27352eba38cfSSimon Glass
273694fd1316SSimon Glass		CONFIG_BOOTSTAGE_FDT
273794fd1316SSimon Glass		Stash the bootstage information in the FDT. A root 'bootstage'
273894fd1316SSimon Glass		node is created with each bootstage id as a child. Each child
273994fd1316SSimon Glass		has a 'name' property and either 'mark' containing the
274094fd1316SSimon Glass		mark time in microsecond, or 'accum' containing the
274194fd1316SSimon Glass		accumulated time for that bootstage id in microseconds.
274294fd1316SSimon Glass		For example:
274394fd1316SSimon Glass
274494fd1316SSimon Glass		bootstage {
274594fd1316SSimon Glass			154 {
274694fd1316SSimon Glass				name = "board_init_f";
274794fd1316SSimon Glass				mark = <3575678>;
274894fd1316SSimon Glass			};
274994fd1316SSimon Glass			170 {
275094fd1316SSimon Glass				name = "lcd";
275194fd1316SSimon Glass				accum = <33482>;
275294fd1316SSimon Glass			};
275394fd1316SSimon Glass		};
275494fd1316SSimon Glass
275594fd1316SSimon Glass		Code in the Linux kernel can find this in /proc/devicetree.
275694fd1316SSimon Glass
27571372cce2SMarian BalakowiczLegacy uImage format:
27581372cce2SMarian Balakowicz
2759c609719bSwdenk  Arg	Where			When
2760c609719bSwdenk    1	common/cmd_bootm.c	before attempting to boot an image
2761c609719bSwdenk   -1	common/cmd_bootm.c	Image header has bad	 magic number
2762c609719bSwdenk    2	common/cmd_bootm.c	Image header has correct magic number
2763c609719bSwdenk   -2	common/cmd_bootm.c	Image header has bad	 checksum
2764c609719bSwdenk    3	common/cmd_bootm.c	Image header has correct checksum
2765c609719bSwdenk   -3	common/cmd_bootm.c	Image data   has bad	 checksum
2766c609719bSwdenk    4	common/cmd_bootm.c	Image data   has correct checksum
2767c609719bSwdenk   -4	common/cmd_bootm.c	Image is for unsupported architecture
2768c609719bSwdenk    5	common/cmd_bootm.c	Architecture check OK
27691372cce2SMarian Balakowicz   -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi)
2770c609719bSwdenk    6	common/cmd_bootm.c	Image Type check OK
2771c609719bSwdenk   -6	common/cmd_bootm.c	gunzip uncompression error
2772c609719bSwdenk   -7	common/cmd_bootm.c	Unimplemented compression type
2773c609719bSwdenk    7	common/cmd_bootm.c	Uncompression OK
27741372cce2SMarian Balakowicz    8	common/cmd_bootm.c	No uncompress/copy overwrite error
2775c609719bSwdenk   -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
27761372cce2SMarian Balakowicz
27771372cce2SMarian Balakowicz    9	common/image.c		Start initial ramdisk verification
27781372cce2SMarian Balakowicz  -10	common/image.c		Ramdisk header has bad	   magic number
27791372cce2SMarian Balakowicz  -11	common/image.c		Ramdisk header has bad	   checksum
27801372cce2SMarian Balakowicz   10	common/image.c		Ramdisk header is OK
27811372cce2SMarian Balakowicz  -12	common/image.c		Ramdisk data   has bad	   checksum
27821372cce2SMarian Balakowicz   11	common/image.c		Ramdisk data   has correct checksum
27831372cce2SMarian Balakowicz   12	common/image.c		Ramdisk verification complete, start loading
278411ccc33fSMarcel Ziswiler  -13	common/image.c		Wrong Image Type (not PPC Linux ramdisk)
27851372cce2SMarian Balakowicz   13	common/image.c		Start multifile image verification
27861372cce2SMarian Balakowicz   14	common/image.c		No initial ramdisk, no multifile, continue.
27871372cce2SMarian Balakowicz
2788ea0364f1SPeter Tyser   15	arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
2789c609719bSwdenk
2790a47a12beSStefan Roese  -30	arch/powerpc/lib/board.c	Fatal error, hang the system
279163e73c9aSwdenk  -31	post/post.c		POST test failed, detected by post_output_backlog()
279263e73c9aSwdenk  -32	post/post.c		POST test failed, detected by post_run_single()
279363e73c9aSwdenk
2794566a494fSHeiko Schocher   34	common/cmd_doc.c	before loading a Image from a DOC device
2795566a494fSHeiko Schocher  -35	common/cmd_doc.c	Bad usage of "doc" command
2796566a494fSHeiko Schocher   35	common/cmd_doc.c	correct usage of "doc" command
2797566a494fSHeiko Schocher  -36	common/cmd_doc.c	No boot device
2798566a494fSHeiko Schocher   36	common/cmd_doc.c	correct boot device
2799566a494fSHeiko Schocher  -37	common/cmd_doc.c	Unknown Chip ID on boot device
2800566a494fSHeiko Schocher   37	common/cmd_doc.c	correct chip ID found, device available
2801566a494fSHeiko Schocher  -38	common/cmd_doc.c	Read Error on boot device
2802566a494fSHeiko Schocher   38	common/cmd_doc.c	reading Image header from DOC device OK
2803566a494fSHeiko Schocher  -39	common/cmd_doc.c	Image header has bad magic number
2804566a494fSHeiko Schocher   39	common/cmd_doc.c	Image header has correct magic number
2805566a494fSHeiko Schocher  -40	common/cmd_doc.c	Error reading Image from DOC device
2806566a494fSHeiko Schocher   40	common/cmd_doc.c	Image header has correct magic number
2807566a494fSHeiko Schocher   41	common/cmd_ide.c	before loading a Image from a IDE device
2808566a494fSHeiko Schocher  -42	common/cmd_ide.c	Bad usage of "ide" command
2809566a494fSHeiko Schocher   42	common/cmd_ide.c	correct usage of "ide" command
2810566a494fSHeiko Schocher  -43	common/cmd_ide.c	No boot device
2811566a494fSHeiko Schocher   43	common/cmd_ide.c	boot device found
2812566a494fSHeiko Schocher  -44	common/cmd_ide.c	Device not available
2813566a494fSHeiko Schocher   44	common/cmd_ide.c	Device available
2814566a494fSHeiko Schocher  -45	common/cmd_ide.c	wrong partition selected
2815566a494fSHeiko Schocher   45	common/cmd_ide.c	partition selected
2816566a494fSHeiko Schocher  -46	common/cmd_ide.c	Unknown partition table
2817566a494fSHeiko Schocher   46	common/cmd_ide.c	valid partition table found
2818566a494fSHeiko Schocher  -47	common/cmd_ide.c	Invalid partition type
2819566a494fSHeiko Schocher   47	common/cmd_ide.c	correct partition type
2820566a494fSHeiko Schocher  -48	common/cmd_ide.c	Error reading Image Header on boot device
2821566a494fSHeiko Schocher   48	common/cmd_ide.c	reading Image Header from IDE device OK
2822566a494fSHeiko Schocher  -49	common/cmd_ide.c	Image header has bad magic number
2823566a494fSHeiko Schocher   49	common/cmd_ide.c	Image header has correct magic number
2824566a494fSHeiko Schocher  -50	common/cmd_ide.c	Image header has bad	 checksum
2825566a494fSHeiko Schocher   50	common/cmd_ide.c	Image header has correct checksum
2826566a494fSHeiko Schocher  -51	common/cmd_ide.c	Error reading Image from IDE device
2827566a494fSHeiko Schocher   51	common/cmd_ide.c	reading Image from IDE device OK
2828566a494fSHeiko Schocher   52	common/cmd_nand.c	before loading a Image from a NAND device
2829566a494fSHeiko Schocher  -53	common/cmd_nand.c	Bad usage of "nand" command
2830566a494fSHeiko Schocher   53	common/cmd_nand.c	correct usage of "nand" command
2831566a494fSHeiko Schocher  -54	common/cmd_nand.c	No boot device
2832566a494fSHeiko Schocher   54	common/cmd_nand.c	boot device found
2833566a494fSHeiko Schocher  -55	common/cmd_nand.c	Unknown Chip ID on boot device
2834566a494fSHeiko Schocher   55	common/cmd_nand.c	correct chip ID found, device available
2835566a494fSHeiko Schocher  -56	common/cmd_nand.c	Error reading Image Header on boot device
2836566a494fSHeiko Schocher   56	common/cmd_nand.c	reading Image Header from NAND device OK
2837566a494fSHeiko Schocher  -57	common/cmd_nand.c	Image header has bad magic number
2838566a494fSHeiko Schocher   57	common/cmd_nand.c	Image header has correct magic number
2839566a494fSHeiko Schocher  -58	common/cmd_nand.c	Error reading Image from NAND device
2840566a494fSHeiko Schocher   58	common/cmd_nand.c	reading Image from NAND device OK
2841c609719bSwdenk
2842566a494fSHeiko Schocher  -60	common/env_common.c	Environment has a bad CRC, using default
2843c609719bSwdenk
2844566a494fSHeiko Schocher   64	net/eth.c		starting with Ethernet configuration.
2845566a494fSHeiko Schocher  -64	net/eth.c		no Ethernet found.
2846566a494fSHeiko Schocher   65	net/eth.c		Ethernet found.
2847206c60cbSwdenk
2848566a494fSHeiko Schocher  -80	common/cmd_net.c	usage wrong
2849566a494fSHeiko Schocher   80	common/cmd_net.c	before calling NetLoop()
285011ccc33fSMarcel Ziswiler  -81	common/cmd_net.c	some error in NetLoop() occurred
2851566a494fSHeiko Schocher   81	common/cmd_net.c	NetLoop() back without error
2852566a494fSHeiko Schocher  -82	common/cmd_net.c	size == 0 (File with size 0 loaded)
2853566a494fSHeiko Schocher   82	common/cmd_net.c	trying automatic boot
285474de7aefSWolfgang Denk   83	common/cmd_net.c	running "source" command
285574de7aefSWolfgang Denk  -83	common/cmd_net.c	some error in automatic boot or "source" command
2856566a494fSHeiko Schocher   84	common/cmd_net.c	end without errors
2857c609719bSwdenk
28581372cce2SMarian BalakowiczFIT uImage format:
28591372cce2SMarian Balakowicz
28601372cce2SMarian Balakowicz  Arg	Where			When
28611372cce2SMarian Balakowicz  100	common/cmd_bootm.c	Kernel FIT Image has correct format
28621372cce2SMarian Balakowicz -100	common/cmd_bootm.c	Kernel FIT Image has incorrect format
28631372cce2SMarian Balakowicz  101	common/cmd_bootm.c	No Kernel subimage unit name, using configuration
28641372cce2SMarian Balakowicz -101	common/cmd_bootm.c	Can't get configuration for kernel subimage
28651372cce2SMarian Balakowicz  102	common/cmd_bootm.c	Kernel unit name specified
28661372cce2SMarian Balakowicz -103	common/cmd_bootm.c	Can't get kernel subimage node offset
2867f773bea8SMarian Balakowicz  103	common/cmd_bootm.c	Found configuration node
28681372cce2SMarian Balakowicz  104	common/cmd_bootm.c	Got kernel subimage node offset
28691372cce2SMarian Balakowicz -104	common/cmd_bootm.c	Kernel subimage hash verification failed
28701372cce2SMarian Balakowicz  105	common/cmd_bootm.c	Kernel subimage hash verification OK
28711372cce2SMarian Balakowicz -105	common/cmd_bootm.c	Kernel subimage is for unsupported architecture
28721372cce2SMarian Balakowicz  106	common/cmd_bootm.c	Architecture check OK
287311ccc33fSMarcel Ziswiler -106	common/cmd_bootm.c	Kernel subimage has wrong type
287411ccc33fSMarcel Ziswiler  107	common/cmd_bootm.c	Kernel subimage type OK
28751372cce2SMarian Balakowicz -107	common/cmd_bootm.c	Can't get kernel subimage data/size
28761372cce2SMarian Balakowicz  108	common/cmd_bootm.c	Got kernel subimage data/size
28771372cce2SMarian Balakowicz -108	common/cmd_bootm.c	Wrong image type (not legacy, FIT)
28781372cce2SMarian Balakowicz -109	common/cmd_bootm.c	Can't get kernel subimage type
28791372cce2SMarian Balakowicz -110	common/cmd_bootm.c	Can't get kernel subimage comp
28801372cce2SMarian Balakowicz -111	common/cmd_bootm.c	Can't get kernel subimage os
28811372cce2SMarian Balakowicz -112	common/cmd_bootm.c	Can't get kernel subimage load address
28821372cce2SMarian Balakowicz -113	common/cmd_bootm.c	Image uncompress/copy overwrite error
28831372cce2SMarian Balakowicz
28841372cce2SMarian Balakowicz  120	common/image.c		Start initial ramdisk verification
28851372cce2SMarian Balakowicz -120	common/image.c		Ramdisk FIT image has incorrect format
28861372cce2SMarian Balakowicz  121	common/image.c		Ramdisk FIT image has correct format
288711ccc33fSMarcel Ziswiler  122	common/image.c		No ramdisk subimage unit name, using configuration
28881372cce2SMarian Balakowicz -122	common/image.c		Can't get configuration for ramdisk subimage
28891372cce2SMarian Balakowicz  123	common/image.c		Ramdisk unit name specified
28901372cce2SMarian Balakowicz -124	common/image.c		Can't get ramdisk subimage node offset
28911372cce2SMarian Balakowicz  125	common/image.c		Got ramdisk subimage node offset
28921372cce2SMarian Balakowicz -125	common/image.c		Ramdisk subimage hash verification failed
28931372cce2SMarian Balakowicz  126	common/image.c		Ramdisk subimage hash verification OK
28941372cce2SMarian Balakowicz -126	common/image.c		Ramdisk subimage for unsupported architecture
28951372cce2SMarian Balakowicz  127	common/image.c		Architecture check OK
28961372cce2SMarian Balakowicz -127	common/image.c		Can't get ramdisk subimage data/size
28971372cce2SMarian Balakowicz  128	common/image.c		Got ramdisk subimage data/size
28981372cce2SMarian Balakowicz  129	common/image.c		Can't get ramdisk load address
28991372cce2SMarian Balakowicz -129	common/image.c		Got ramdisk load address
29001372cce2SMarian Balakowicz
290111ccc33fSMarcel Ziswiler -130	common/cmd_doc.c	Incorrect FIT image format
29021372cce2SMarian Balakowicz  131	common/cmd_doc.c	FIT image format OK
29031372cce2SMarian Balakowicz
290411ccc33fSMarcel Ziswiler -140	common/cmd_ide.c	Incorrect FIT image format
29051372cce2SMarian Balakowicz  141	common/cmd_ide.c	FIT image format OK
29061372cce2SMarian Balakowicz
290711ccc33fSMarcel Ziswiler -150	common/cmd_nand.c	Incorrect FIT image format
29081372cce2SMarian Balakowicz  151	common/cmd_nand.c	FIT image format OK
29091372cce2SMarian Balakowicz
2910d95f6ec7SGabe Black- FIT image support:
2911d95f6ec7SGabe Black		CONFIG_FIT
2912d95f6ec7SGabe Black		Enable support for the FIT uImage format.
2913d95f6ec7SGabe Black
2914d95f6ec7SGabe Black		CONFIG_FIT_BEST_MATCH
2915d95f6ec7SGabe Black		When no configuration is explicitly selected, default to the
2916d95f6ec7SGabe Black		one whose fdt's compatibility field best matches that of
2917d95f6ec7SGabe Black		U-Boot itself. A match is considered "best" if it matches the
2918d95f6ec7SGabe Black		most specific compatibility entry of U-Boot's fdt's root node.
2919d95f6ec7SGabe Black		The order of entries in the configuration's fdt is ignored.
2920d95f6ec7SGabe Black
29213e569a6bSSimon Glass		CONFIG_FIT_SIGNATURE
29223e569a6bSSimon Glass		This option enables signature verification of FIT uImages,
29233e569a6bSSimon Glass		using a hash signed and verified using RSA. See
29243e569a6bSSimon Glass		doc/uImage.FIT/signature.txt for more details.
29253e569a6bSSimon Glass
29264cf2609bSWolfgang Denk- Standalone program support:
29274cf2609bSWolfgang Denk		CONFIG_STANDALONE_LOAD_ADDR
29284cf2609bSWolfgang Denk
29296feff899SWolfgang Denk		This option defines a board specific value for the
29306feff899SWolfgang Denk		address where standalone program gets loaded, thus
29316feff899SWolfgang Denk		overwriting the architecture dependent default
29324cf2609bSWolfgang Denk		settings.
29334cf2609bSWolfgang Denk
29344cf2609bSWolfgang Denk- Frame Buffer Address:
29354cf2609bSWolfgang Denk		CONFIG_FB_ADDR
29364cf2609bSWolfgang Denk
29374cf2609bSWolfgang Denk		Define CONFIG_FB_ADDR if you want to use specific
293844a53b57SWolfgang Denk		address for frame buffer.  This is typically the case
293944a53b57SWolfgang Denk		when using a graphics controller has separate video
294044a53b57SWolfgang Denk		memory.  U-Boot will then place the frame buffer at
294144a53b57SWolfgang Denk		the given address instead of dynamically reserving it
294244a53b57SWolfgang Denk		in system RAM by calling lcd_setmem(), which grabs
294344a53b57SWolfgang Denk		the memory for the frame buffer depending on the
294444a53b57SWolfgang Denk		configured panel size.
29454cf2609bSWolfgang Denk
29464cf2609bSWolfgang Denk		Please see board_init_f function.
29474cf2609bSWolfgang Denk
2948cccfc2abSDetlev Zundel- Automatic software updates via TFTP server
2949cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP
2950cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_CNT_MAX
2951cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_MSEC_MAX
2952cccfc2abSDetlev Zundel
2953cccfc2abSDetlev Zundel		These options enable and control the auto-update feature;
2954cccfc2abSDetlev Zundel		for a more detailed description refer to doc/README.update.
2955cccfc2abSDetlev Zundel
2956cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support)
2957cccfc2abSDetlev Zundel		CONFIG_MTD_DEVICE
2958cccfc2abSDetlev Zundel
2959cccfc2abSDetlev Zundel		Adds the MTD device infrastructure from the Linux kernel.
2960cccfc2abSDetlev Zundel		Needed for mtdparts command support.
2961cccfc2abSDetlev Zundel
2962cccfc2abSDetlev Zundel		CONFIG_MTD_PARTITIONS
2963cccfc2abSDetlev Zundel
2964cccfc2abSDetlev Zundel		Adds the MTD partitioning infrastructure from the Linux
2965cccfc2abSDetlev Zundel		kernel. Needed for UBI support.
2966cccfc2abSDetlev Zundel
296770c219cdSJoe Hershberger- UBI support
296870c219cdSJoe Hershberger		CONFIG_CMD_UBI
296970c219cdSJoe Hershberger
297070c219cdSJoe Hershberger		Adds commands for interacting with MTD partitions formatted
297170c219cdSJoe Hershberger		with the UBI flash translation layer
297270c219cdSJoe Hershberger
297370c219cdSJoe Hershberger		Requires also defining CONFIG_RBTREE
297470c219cdSJoe Hershberger
2975147162daSJoe Hershberger		CONFIG_UBI_SILENCE_MSG
2976147162daSJoe Hershberger
2977147162daSJoe Hershberger		Make the verbose messages from UBI stop printing.  This leaves
2978147162daSJoe Hershberger		warnings and errors enabled.
2979147162daSJoe Hershberger
298070c219cdSJoe Hershberger- UBIFS support
298170c219cdSJoe Hershberger		CONFIG_CMD_UBIFS
298270c219cdSJoe Hershberger
298370c219cdSJoe Hershberger		Adds commands for interacting with UBI volumes formatted as
298470c219cdSJoe Hershberger		UBIFS.  UBIFS is read-only in u-boot.
298570c219cdSJoe Hershberger
298670c219cdSJoe Hershberger		Requires UBI support as well as CONFIG_LZO
298770c219cdSJoe Hershberger
2988147162daSJoe Hershberger		CONFIG_UBIFS_SILENCE_MSG
2989147162daSJoe Hershberger
2990147162daSJoe Hershberger		Make the verbose messages from UBIFS stop printing.  This leaves
2991147162daSJoe Hershberger		warnings and errors enabled.
2992147162daSJoe Hershberger
29936a11cf48SDaniel Schwierzeck- SPL framework
29946a11cf48SDaniel Schwierzeck		CONFIG_SPL
29956a11cf48SDaniel Schwierzeck		Enable building of SPL globally.
29966a11cf48SDaniel Schwierzeck
299795579793STom Rini		CONFIG_SPL_LDSCRIPT
299895579793STom Rini		LDSCRIPT for linking the SPL binary.
299995579793STom Rini
30006ebc3461SAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT
30016ebc3461SAlbert ARIBAUD		Maximum size in memory allocated to the SPL, BSS included.
30026ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual memory
30036ebc3461SAlbert ARIBAUD		used by SPL from _start to __bss_end does not exceed it.
30048960af8bSAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
30056ebc3461SAlbert ARIBAUD		must not be both defined at the same time.
30066ebc3461SAlbert ARIBAUD
300795579793STom Rini		CONFIG_SPL_MAX_SIZE
30086ebc3461SAlbert ARIBAUD		Maximum size of the SPL image (text, data, rodata, and
30096ebc3461SAlbert ARIBAUD		linker lists sections), BSS excluded.
30106ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual size does
30116ebc3461SAlbert ARIBAUD		not exceed it.
301295579793STom Rini
30136a11cf48SDaniel Schwierzeck		CONFIG_SPL_TEXT_BASE
30146a11cf48SDaniel Schwierzeck		TEXT_BASE for linking the SPL binary.
30156a11cf48SDaniel Schwierzeck
301694a45bb1SScott Wood		CONFIG_SPL_RELOC_TEXT_BASE
301794a45bb1SScott Wood		Address to relocate to.  If unspecified, this is equal to
301894a45bb1SScott Wood		CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
301994a45bb1SScott Wood
302095579793STom Rini		CONFIG_SPL_BSS_START_ADDR
302195579793STom Rini		Link address for the BSS within the SPL binary.
302295579793STom Rini
302395579793STom Rini		CONFIG_SPL_BSS_MAX_SIZE
30246ebc3461SAlbert ARIBAUD		Maximum size in memory allocated to the SPL BSS.
30256ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual memory used
30266ebc3461SAlbert ARIBAUD		by SPL from __bss_start to __bss_end does not exceed it.
30278960af8bSAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
30286ebc3461SAlbert ARIBAUD		must not be both defined at the same time.
302995579793STom Rini
303095579793STom Rini		CONFIG_SPL_STACK
303195579793STom Rini		Adress of the start of the stack SPL will use
303295579793STom Rini
303394a45bb1SScott Wood		CONFIG_SPL_RELOC_STACK
303494a45bb1SScott Wood		Adress of the start of the stack SPL will use after
303594a45bb1SScott Wood		relocation.  If unspecified, this is equal to
303694a45bb1SScott Wood		CONFIG_SPL_STACK.
303794a45bb1SScott Wood
303895579793STom Rini		CONFIG_SYS_SPL_MALLOC_START
303995579793STom Rini		Starting address of the malloc pool used in SPL.
304095579793STom Rini
304195579793STom Rini		CONFIG_SYS_SPL_MALLOC_SIZE
304295579793STom Rini		The size of the malloc pool used in SPL.
30436a11cf48SDaniel Schwierzeck
304447f7bcaeSTom Rini		CONFIG_SPL_FRAMEWORK
304547f7bcaeSTom Rini		Enable the SPL framework under common/.  This framework
304647f7bcaeSTom Rini		supports MMC, NAND and YMODEM loading of U-Boot and NAND
304747f7bcaeSTom Rini		NAND loading of the Linux Kernel.
304847f7bcaeSTom Rini
3049861a86f4STom Rini		CONFIG_SPL_DISPLAY_PRINT
3050861a86f4STom Rini		For ARM, enable an optional function to print more information
3051861a86f4STom Rini		about the running system.
3052861a86f4STom Rini
30534b919725SScott Wood		CONFIG_SPL_INIT_MINIMAL
30544b919725SScott Wood		Arch init code should be built for a very small image
30554b919725SScott Wood
30566a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBCOMMON_SUPPORT
30576a11cf48SDaniel Schwierzeck		Support for common/libcommon.o in SPL binary
30586a11cf48SDaniel Schwierzeck
30596a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBDISK_SUPPORT
30606a11cf48SDaniel Schwierzeck		Support for disk/libdisk.o in SPL binary
30616a11cf48SDaniel Schwierzeck
30626a11cf48SDaniel Schwierzeck		CONFIG_SPL_I2C_SUPPORT
30636a11cf48SDaniel Schwierzeck		Support for drivers/i2c/libi2c.o in SPL binary
30646a11cf48SDaniel Schwierzeck
30656a11cf48SDaniel Schwierzeck		CONFIG_SPL_GPIO_SUPPORT
30666a11cf48SDaniel Schwierzeck		Support for drivers/gpio/libgpio.o in SPL binary
30676a11cf48SDaniel Schwierzeck
30686a11cf48SDaniel Schwierzeck		CONFIG_SPL_MMC_SUPPORT
30696a11cf48SDaniel Schwierzeck		Support for drivers/mmc/libmmc.o in SPL binary
30706a11cf48SDaniel Schwierzeck
307195579793STom Rini		CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
307295579793STom Rini		CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
307395579793STom Rini		CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION
307495579793STom Rini		Address, size and partition on the MMC to load U-Boot from
307595579793STom Rini		when the MMC is being used in raw mode.
307695579793STom Rini
30772b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
30782b75b0adSPeter Korsgaard		Sector to load kernel uImage from when MMC is being
30792b75b0adSPeter Korsgaard		used in raw mode (for Falcon mode)
30802b75b0adSPeter Korsgaard
30812b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
30822b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
30832b75b0adSPeter Korsgaard		Sector and number of sectors to load kernel argument
30842b75b0adSPeter Korsgaard		parameters from when MMC is being used in raw mode
30852b75b0adSPeter Korsgaard		(for falcon mode)
30862b75b0adSPeter Korsgaard
308795579793STom Rini		CONFIG_SPL_FAT_SUPPORT
308895579793STom Rini		Support for fs/fat/libfat.o in SPL binary
308995579793STom Rini
309095579793STom Rini		CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME
309195579793STom Rini		Filename to read to load U-Boot when reading from FAT
309295579793STom Rini
30937ad2cc79SPeter Korsgaard		CONFIG_SPL_FAT_LOAD_KERNEL_NAME
30947ad2cc79SPeter Korsgaard		Filename to read to load kernel uImage when reading
30957ad2cc79SPeter Korsgaard		from FAT (for Falcon mode)
30967ad2cc79SPeter Korsgaard
30977ad2cc79SPeter Korsgaard		CONFIG_SPL_FAT_LOAD_ARGS_NAME
30987ad2cc79SPeter Korsgaard		Filename to read to load kernel argument parameters
30997ad2cc79SPeter Korsgaard		when reading from FAT (for Falcon mode)
31007ad2cc79SPeter Korsgaard
310106f60ae3SScott Wood		CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
310206f60ae3SScott Wood		Set this for NAND SPL on PPC mpc83xx targets, so that
310306f60ae3SScott Wood		start.S waits for the rest of the SPL to load before
310406f60ae3SScott Wood		continuing (the hardware starts execution after just
310506f60ae3SScott Wood		loading the first page rather than the full 4K).
310606f60ae3SScott Wood
31076f2f01b9SScott Wood		CONFIG_SPL_NAND_BASE
31086f2f01b9SScott Wood		Include nand_base.c in the SPL.  Requires
31096f2f01b9SScott Wood		CONFIG_SPL_NAND_DRIVERS.
31106f2f01b9SScott Wood
31116f2f01b9SScott Wood		CONFIG_SPL_NAND_DRIVERS
31126f2f01b9SScott Wood		SPL uses normal NAND drivers, not minimal drivers.
31136f2f01b9SScott Wood
31146f2f01b9SScott Wood		CONFIG_SPL_NAND_ECC
31156f2f01b9SScott Wood		Include standard software ECC in the SPL
31166f2f01b9SScott Wood
311795579793STom Rini		CONFIG_SPL_NAND_SIMPLE
31187d4b7955SScott Wood		Support for NAND boot using simple NAND drivers that
31197d4b7955SScott Wood		expose the cmd_ctrl() interface.
312095579793STom Rini
3121bb0dc108SYing Zhang		CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT
3122bb0dc108SYing Zhang		Set for the SPL on PPC mpc8xxx targets, support for
3123bb0dc108SYing Zhang		arch/powerpc/cpu/mpc8xxx/ddr/libddr.o in SPL binary.
3124bb0dc108SYing Zhang
31257c8eea59SYing Zhang		CONFIG_SPL_COMMON_INIT_DDR
31267c8eea59SYing Zhang		Set for common ddr init with serial presence detect in
31277c8eea59SYing Zhang		SPL binary.
31287c8eea59SYing Zhang
312995579793STom Rini		CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
313095579793STom Rini		CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
313195579793STom Rini		CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
313295579793STom Rini		CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
313395579793STom Rini		CONFIG_SYS_NAND_ECCBYTES
313495579793STom Rini		Defines the size and behavior of the NAND that SPL uses
31357d4b7955SScott Wood		to read U-Boot
313695579793STom Rini
313795579793STom Rini		CONFIG_SYS_NAND_U_BOOT_OFFS
31387d4b7955SScott Wood		Location in NAND to read U-Boot from
31397d4b7955SScott Wood
31407d4b7955SScott Wood		CONFIG_SYS_NAND_U_BOOT_DST
31417d4b7955SScott Wood		Location in memory to load U-Boot to
31427d4b7955SScott Wood
31437d4b7955SScott Wood		CONFIG_SYS_NAND_U_BOOT_SIZE
31447d4b7955SScott Wood		Size of image to load
314595579793STom Rini
314695579793STom Rini		CONFIG_SYS_NAND_U_BOOT_START
31477d4b7955SScott Wood		Entry point in loaded image to jump to
314895579793STom Rini
314995579793STom Rini		CONFIG_SYS_NAND_HW_ECC_OOBFIRST
315095579793STom Rini		Define this if you need to first read the OOB and then the
315195579793STom Rini		data. This is used for example on davinci plattforms.
315295579793STom Rini
315395579793STom Rini		CONFIG_SPL_OMAP3_ID_NAND
315495579793STom Rini		Support for an OMAP3-specific set of functions to return the
315595579793STom Rini		ID and MFR of the first attached NAND chip, if present.
315695579793STom Rini
31576a11cf48SDaniel Schwierzeck		CONFIG_SPL_SERIAL_SUPPORT
31586a11cf48SDaniel Schwierzeck		Support for drivers/serial/libserial.o in SPL binary
31596a11cf48SDaniel Schwierzeck
31606a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_FLASH_SUPPORT
31616a11cf48SDaniel Schwierzeck		Support for drivers/mtd/spi/libspi_flash.o in SPL binary
31626a11cf48SDaniel Schwierzeck
31636a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_SUPPORT
31646a11cf48SDaniel Schwierzeck		Support for drivers/spi/libspi.o in SPL binary
31656a11cf48SDaniel Schwierzeck
3166c57b953dSPavel Machek		CONFIG_SPL_RAM_DEVICE
3167c57b953dSPavel Machek		Support for running image already present in ram, in SPL binary
3168c57b953dSPavel Machek
31696a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBGENERIC_SUPPORT
31706a11cf48SDaniel Schwierzeck		Support for lib/libgeneric.o in SPL binary
31711372cce2SMarian Balakowicz
3172ba1bee43SYing Zhang		CONFIG_SPL_ENV_SUPPORT
3173ba1bee43SYing Zhang		Support for the environment operating in SPL binary
3174ba1bee43SYing Zhang
3175ba1bee43SYing Zhang		CONFIG_SPL_NET_SUPPORT
3176ba1bee43SYing Zhang		Support for the net/libnet.o in SPL binary.
3177ba1bee43SYing Zhang		It conflicts with SPL env from storage medium specified by
3178ba1bee43SYing Zhang		CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3179ba1bee43SYing Zhang
318074752baaSScott Wood		CONFIG_SPL_PAD_TO
31816113d3f2SBenoît Thébaudeau		Image offset to which the SPL should be padded before appending
31826113d3f2SBenoît Thébaudeau		the SPL payload. By default, this is defined as
31836113d3f2SBenoît Thébaudeau		CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
31846113d3f2SBenoît Thébaudeau		CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
31856113d3f2SBenoît Thébaudeau		payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
318674752baaSScott Wood
3187ca2fca22SScott Wood		CONFIG_SPL_TARGET
3188ca2fca22SScott Wood		Final target image containing SPL and payload.  Some SPLs
3189ca2fca22SScott Wood		use an arch-specific makefile fragment instead, for
3190ca2fca22SScott Wood		example if more than one image needs to be produced.
3191ca2fca22SScott Wood
319287ebee39SSimon Glass		CONFIG_FIT_SPL_PRINT
319387ebee39SSimon Glass		Printing information about a FIT image adds quite a bit of
319487ebee39SSimon Glass		code to SPL. So this is normally disabled in SPL. Use this
319587ebee39SSimon Glass		option to re-enable it. This will affect the output of the
319687ebee39SSimon Glass		bootm command when booting a FIT image.
319787ebee39SSimon Glass
31983aa29de0SYing Zhang- TPL framework
31993aa29de0SYing Zhang		CONFIG_TPL
32003aa29de0SYing Zhang		Enable building of TPL globally.
32013aa29de0SYing Zhang
32023aa29de0SYing Zhang		CONFIG_TPL_PAD_TO
32033aa29de0SYing Zhang		Image offset to which the TPL should be padded before appending
32043aa29de0SYing Zhang		the TPL payload. By default, this is defined as
32053aa29de0SYing Zhang		CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
32063aa29de0SYing Zhang		CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
32073aa29de0SYing Zhang		payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
32083aa29de0SYing Zhang
3209c609719bSwdenkModem Support:
3210c609719bSwdenk--------------
3211c609719bSwdenk
3212566e5cf4SWolfgang Denk[so far only for SMDK2400 boards]
3213c609719bSwdenk
321411ccc33fSMarcel Ziswiler- Modem support enable:
3215c609719bSwdenk		CONFIG_MODEM_SUPPORT
3216c609719bSwdenk
3217c609719bSwdenk- RTS/CTS Flow control enable:
3218c609719bSwdenk		CONFIG_HWFLOW
3219c609719bSwdenk
3220c609719bSwdenk- Modem debug support:
3221c609719bSwdenk		CONFIG_MODEM_SUPPORT_DEBUG
3222c609719bSwdenk
3223c609719bSwdenk		Enables debugging stuff (char screen[1024], dbg())
3224c609719bSwdenk		for modem support. Useful only with BDI2000.
3225c609719bSwdenk
3226a8c7c708Swdenk- Interrupt support (PPC):
3227a8c7c708Swdenk
3228a8c7c708Swdenk		There are common interrupt_init() and timer_interrupt()
3229a8c7c708Swdenk		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
323011ccc33fSMarcel Ziswiler		for CPU specific initialization. interrupt_init_cpu()
3231a8c7c708Swdenk		should set decrementer_count to appropriate value. If
323211ccc33fSMarcel Ziswiler		CPU resets decrementer automatically after interrupt
3233a8c7c708Swdenk		(ppc4xx) it should set decrementer_count to zero.
323411ccc33fSMarcel Ziswiler		timer_interrupt() calls timer_interrupt_cpu() for CPU
3235a8c7c708Swdenk		specific handling. If board has watchdog / status_led
3236a8c7c708Swdenk		/ other_activity_monitor it works automatically from
3237a8c7c708Swdenk		general timer_interrupt().
3238a8c7c708Swdenk
3239c609719bSwdenk- General:
3240c609719bSwdenk
3241c609719bSwdenk		In the target system modem support is enabled when a
3242c609719bSwdenk		specific key (key combination) is pressed during
3243c609719bSwdenk		power-on. Otherwise U-Boot will boot normally
324411ccc33fSMarcel Ziswiler		(autoboot). The key_pressed() function is called from
3245c609719bSwdenk		board_init(). Currently key_pressed() is a dummy
3246c609719bSwdenk		function, returning 1 and thus enabling modem
3247c609719bSwdenk		initialization.
3248c609719bSwdenk
3249c609719bSwdenk		If there are no modem init strings in the
3250c609719bSwdenk		environment, U-Boot proceed to autoboot; the
3251c609719bSwdenk		previous output (banner, info printfs) will be
325211ccc33fSMarcel Ziswiler		suppressed, though.
3253c609719bSwdenk
3254c609719bSwdenk		See also: doc/README.Modem
3255c609719bSwdenk
32569660e442SHelmut RaigerBoard initialization settings:
32579660e442SHelmut Raiger------------------------------
32589660e442SHelmut Raiger
32599660e442SHelmut RaigerDuring Initialization u-boot calls a number of board specific functions
32609660e442SHelmut Raigerto allow the preparation of board specific prerequisites, e.g. pin setup
32619660e442SHelmut Raigerbefore drivers are initialized. To enable these callbacks the
32629660e442SHelmut Raigerfollowing configuration macros have to be defined. Currently this is
32639660e442SHelmut Raigerarchitecture specific, so please check arch/your_architecture/lib/board.c
32649660e442SHelmut Raigertypically in board_init_f() and board_init_r().
32659660e442SHelmut Raiger
32669660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
32679660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
32689660e442SHelmut Raiger- CONFIG_BOARD_LATE_INIT: Call board_late_init()
32699660e442SHelmut Raiger- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
3270c609719bSwdenk
3271c609719bSwdenkConfiguration Settings:
3272c609719bSwdenk-----------------------
3273c609719bSwdenk
32746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
3275c609719bSwdenk		undefine this when you're short of memory.
3276c609719bSwdenk
32772fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
32782fb2604dSPeter Tyser		width of the commands listed in the 'help' command output.
32792fb2604dSPeter Tyser
32806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT:	This is what U-Boot prints on the console to
3281c609719bSwdenk		prompt for user input.
3282c609719bSwdenk
32836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE:	Buffer size for input from the Console
3284c609719bSwdenk
32856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE:	Buffer size for Console output
3286c609719bSwdenk
32876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS:	max. Number of arguments accepted for monitor commands
3288c609719bSwdenk
32896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
3290c609719bSwdenk		the application (usually a Linux kernel) when it is
3291c609719bSwdenk		booted
3292c609719bSwdenk
32936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE:
3294c609719bSwdenk		List of legal baudrate settings for this board.
3295c609719bSwdenk
32966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_INFO_QUIET
3297c609719bSwdenk		Suppress display of console information at boot.
3298c609719bSwdenk
32996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_IS_IN_ENV
3300c609719bSwdenk		If the board specific function
3301c609719bSwdenk			extern int overwrite_console (void);
3302c609719bSwdenk		returns 1, the stdin, stderr and stdout are switched to the
3303c609719bSwdenk		serial port, else the settings in the environment are used.
3304c609719bSwdenk
33056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
3306c609719bSwdenk		Enable the call to overwrite_console().
3307c609719bSwdenk
33086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
3309c609719bSwdenk		Enable overwrite of previous console environment settings.
3310c609719bSwdenk
33116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
3312c609719bSwdenk		Begin and End addresses of the area used by the
3313c609719bSwdenk		simple memory test.
3314c609719bSwdenk
33156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST:
3316c609719bSwdenk		Enable an alternate, more extensive memory test.
3317c609719bSwdenk
33186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH:
33195f535fe1Swdenk		Scratch address used by the alternate memory test
33205f535fe1Swdenk		You only need to set this if address zero isn't writeable
33215f535fe1Swdenk
33226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
33236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
332414f73ca6SStefan Roese		this specified memory area will get subtracted from the top
332511ccc33fSMarcel Ziswiler		(end) of RAM and won't get "touched" at all by U-Boot. By
332614f73ca6SStefan Roese		fixing up gd->ram_size the Linux kernel should gets passed
332714f73ca6SStefan Roese		the now "corrected" memory size and won't touch it either.
332814f73ca6SStefan Roese		This should work for arch/ppc and arch/powerpc. Only Linux
33295e12e75dSStefan Roese		board ports in arch/powerpc with bootwrapper support that
333014f73ca6SStefan Roese		recalculate the memory size from the SDRAM controller setup
33315e12e75dSStefan Roese		will have to get fixed in Linux additionally.
333214f73ca6SStefan Roese
333314f73ca6SStefan Roese		This option can be used as a workaround for the 440EPx/GRx
333414f73ca6SStefan Roese		CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
333514f73ca6SStefan Roese		be touched.
333614f73ca6SStefan Roese
333714f73ca6SStefan Roese		WARNING: Please make sure that this value is a multiple of
333814f73ca6SStefan Roese		the Linux page size (normally 4k). If this is not the case,
333914f73ca6SStefan Roese		then the end address of the Linux memory will be located at a
334014f73ca6SStefan Roese		non page size aligned address and this could cause major
334114f73ca6SStefan Roese		problems.
334214f73ca6SStefan Roese
33436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE:
3344c609719bSwdenk		Enable temporary baudrate change while serial download
3345c609719bSwdenk
33466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE:
3347c609719bSwdenk		Physical start address of SDRAM. _Must_ be 0 here.
3348c609719bSwdenk
33496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MBIO_BASE:
3350c609719bSwdenk		Physical start address of Motherboard I/O (if using a
3351c609719bSwdenk		Cogent motherboard)
3352c609719bSwdenk
33536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE:
3354c609719bSwdenk		Physical start address of Flash memory.
3355c609719bSwdenk
33566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE:
3357c609719bSwdenk		Physical start address of boot monitor code (set by
3358c609719bSwdenk		make config files to be same as the text base address
335914d0a02aSWolfgang Denk		(CONFIG_SYS_TEXT_BASE) used when linking) - same as
33606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FLASH_BASE when booting from flash.
3361c609719bSwdenk
33626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN:
33633b57fe0aSwdenk		Size of memory reserved for monitor code, used to
33643b57fe0aSwdenk		determine _at_compile_time_ (!) if the environment is
33653b57fe0aSwdenk		embedded within the U-Boot image, or in a separate
33663b57fe0aSwdenk		flash sector.
3367c609719bSwdenk
33686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN:
3369c609719bSwdenk		Size of DRAM reserved for malloc() use.
3370c609719bSwdenk
33716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN:
337215940c9aSStefan Roese		Normally compressed uImages are limited to an
337315940c9aSStefan Roese		uncompressed size of 8 MBytes. If this is not enough,
33746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		you can define CONFIG_SYS_BOOTM_LEN in your board config file
337515940c9aSStefan Roese		to adjust this setting to your needs.
3376c609719bSwdenk
33776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ:
3378c609719bSwdenk		Maximum size of memory mapped by the startup code of
3379c609719bSwdenk		the Linux kernel; all data that must be processed by
33807d721e34SBartlomiej Sieka		the Linux kernel (bd_info, boot arguments, FDT blob if
33817d721e34SBartlomiej Sieka		used) must be put below this limit, unless "bootm_low"
33821bce2aebSRobert P. J. Day		environment variable is defined and non-zero. In such case
33837d721e34SBartlomiej Sieka		all data for the Linux kernel must be between "bootm_low"
3384c3624e6eSGrant Likely		and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.	 The environment
3385c3624e6eSGrant Likely		variable "bootm_mapsize" will override the value of
3386c3624e6eSGrant Likely		CONFIG_SYS_BOOTMAPSZ.  If CONFIG_SYS_BOOTMAPSZ is undefined,
3387c3624e6eSGrant Likely		then the value in "bootm_size" will be used instead.
3388c609719bSwdenk
3389fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3390fca43cc8SJohn Rigby		Enable initrd_high functionality.  If defined then the
3391fca43cc8SJohn Rigby		initrd_high feature is enabled and the bootm ramdisk subcommand
3392fca43cc8SJohn Rigby		is enabled.
3393fca43cc8SJohn Rigby
3394fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_CMDLINE:
3395fca43cc8SJohn Rigby		Enables allocating and saving kernel cmdline in space between
3396fca43cc8SJohn Rigby		"bootm_low" and "bootm_low" + BOOTMAPSZ.
3397fca43cc8SJohn Rigby
3398fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_KBD:
3399fca43cc8SJohn Rigby		Enables allocating and saving a kernel copy of the bd_info in
3400fca43cc8SJohn Rigby		space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3401fca43cc8SJohn Rigby
34026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS:
3403c609719bSwdenk		Max number of Flash memory banks
3404c609719bSwdenk
34056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT:
3406c609719bSwdenk		Max number of sectors on a Flash chip
3407c609719bSwdenk
34086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT:
3409c609719bSwdenk		Timeout for Flash erase operations (in ms)
3410c609719bSwdenk
34116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT:
3412c609719bSwdenk		Timeout for Flash write operations (in ms)
3413c609719bSwdenk
34146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT
34158564acf9Swdenk		Timeout for Flash set sector lock bit operation (in ms)
34168564acf9Swdenk
34176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT
34188564acf9Swdenk		Timeout for Flash clear lock bits operation (in ms)
34198564acf9Swdenk
34206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION
34218564acf9Swdenk		If defined, hardware flash sectors protection is used
34228564acf9Swdenk		instead of U-Boot software protection.
34238564acf9Swdenk
34246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP:
3425c609719bSwdenk
3426c609719bSwdenk		Enable TFTP transfers directly to flash memory;
3427c609719bSwdenk		without this option such a download has to be
3428c609719bSwdenk		performed in two steps: (1) download to RAM, and (2)
3429c609719bSwdenk		copy from RAM to flash.
3430c609719bSwdenk
3431c609719bSwdenk		The two-step approach is usually more reliable, since
3432c609719bSwdenk		you can check if the download worked before you erase
343311ccc33fSMarcel Ziswiler		the flash, but in some situations (when system RAM is
343411ccc33fSMarcel Ziswiler		too limited to allow for a temporary copy of the
3435c609719bSwdenk		downloaded image) this option may be very useful.
3436c609719bSwdenk
34376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI:
3438c609719bSwdenk		Define if the flash driver uses extra elements in the
34395653fc33Swdenk		common flash structure for storing flash geometry.
34405653fc33Swdenk
344100b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER
34425653fc33Swdenk		This option also enables the building of the cfi_flash driver
34435653fc33Swdenk		in the drivers directory
344453cf9435Sstroese
344591809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD
344691809ed5SPiotr Ziecik		This option enables the building of the cfi_mtd driver
344791809ed5SPiotr Ziecik		in the drivers directory. The driver exports CFI flash
344891809ed5SPiotr Ziecik		to the MTD layer.
344991809ed5SPiotr Ziecik
34506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
345196ef831fSGuennadi Liakhovetski		Use buffered writes to flash.
345296ef831fSGuennadi Liakhovetski
345396ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N
345496ef831fSGuennadi Liakhovetski		s29ws-n MirrorBit flash has non-standard addresses for buffered
345596ef831fSGuennadi Liakhovetski		write commands.
345696ef831fSGuennadi Liakhovetski
34576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST
34585568e613SStefan Roese		If this option is defined, the common CFI flash doesn't
34595568e613SStefan Roese		print it's warning upon not recognized FLASH banks. This
34605568e613SStefan Roese		is useful, if some of the configured banks are only
34615568e613SStefan Roese		optionally available.
34625568e613SStefan Roese
34639a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS
34649a042e9cSJerry Van Baren		If defined (must be an integer), print out countdown
34659a042e9cSJerry Van Baren		digits and dots.  Recommended value: 45 (9..1) for 80
34669a042e9cSJerry Van Baren		column displays, 15 (3..1) for 40 column displays.
34679a042e9cSJerry Van Baren
3468352ef3f1SStefan Roese- CONFIG_FLASH_VERIFY
3469352ef3f1SStefan Roese		If defined, the content of the flash (destination) is compared
3470352ef3f1SStefan Roese		against the source after the write operation. An error message
3471352ef3f1SStefan Roese		will be printed when the contents are not identical.
3472352ef3f1SStefan Roese		Please note that this option is useless in nearly all cases,
3473352ef3f1SStefan Roese		since such flash programming errors usually are detected earlier
3474352ef3f1SStefan Roese		while unprotecting/erasing/programming. Please only enable
3475352ef3f1SStefan Roese		this option if you really know what you are doing.
3476352ef3f1SStefan Roese
34776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER:
347811ccc33fSMarcel Ziswiler		Defines the number of Ethernet receive buffers. On some
347911ccc33fSMarcel Ziswiler		Ethernet controllers it is recommended to set this value
348053cf9435Sstroese		to 8 or even higher (EEPRO100 or 405 EMAC), since all
348153cf9435Sstroese		buffers can be full shortly after enabling the interface
348211ccc33fSMarcel Ziswiler		on high Ethernet traffic.
348353cf9435Sstroese		Defaults to 4 if not defined.
3484c609719bSwdenk
3485ea882bafSWolfgang Denk- CONFIG_ENV_MAX_ENTRIES
3486ea882bafSWolfgang Denk
3487ea882bafSWolfgang Denk	Maximum number of entries in the hash table that is used
3488ea882bafSWolfgang Denk	internally to store the environment settings. The default
3489ea882bafSWolfgang Denk	setting is supposed to be generous and should work in most
3490ea882bafSWolfgang Denk	cases. This setting can be used to tune behaviour; see
3491ea882bafSWolfgang Denk	lib/hashtable.c for details.
3492ea882bafSWolfgang Denk
34932598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_DEFAULT
34942598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_STATIC
34951bce2aebSRobert P. J. Day	Enable validation of the values given to environment variables when
34962598090bSJoe Hershberger	calling env set.  Variables can be restricted to only decimal,
34972598090bSJoe Hershberger	hexadecimal, or boolean.  If CONFIG_CMD_NET is also defined,
34982598090bSJoe Hershberger	the variables can also be restricted to IP address or MAC address.
34992598090bSJoe Hershberger
35002598090bSJoe Hershberger	The format of the list is:
35012598090bSJoe Hershberger		type_attribute = [s|d|x|b|i|m]
3502267541f7SJoe Hershberger		access_atribute = [a|r|o|c]
3503267541f7SJoe Hershberger		attributes = type_attribute[access_atribute]
35042598090bSJoe Hershberger		entry = variable_name[:attributes]
35052598090bSJoe Hershberger		list = entry[,list]
35062598090bSJoe Hershberger
35072598090bSJoe Hershberger	The type attributes are:
35082598090bSJoe Hershberger		s - String (default)
35092598090bSJoe Hershberger		d - Decimal
35102598090bSJoe Hershberger		x - Hexadecimal
35112598090bSJoe Hershberger		b - Boolean ([1yYtT|0nNfF])
35122598090bSJoe Hershberger		i - IP address
35132598090bSJoe Hershberger		m - MAC address
35142598090bSJoe Hershberger
3515267541f7SJoe Hershberger	The access attributes are:
3516267541f7SJoe Hershberger		a - Any (default)
3517267541f7SJoe Hershberger		r - Read-only
3518267541f7SJoe Hershberger		o - Write-once
3519267541f7SJoe Hershberger		c - Change-default
3520267541f7SJoe Hershberger
35212598090bSJoe Hershberger	- CONFIG_ENV_FLAGS_LIST_DEFAULT
35222598090bSJoe Hershberger		Define this to a list (string) to define the ".flags"
35232598090bSJoe Hershberger		envirnoment variable in the default or embedded environment.
35242598090bSJoe Hershberger
35252598090bSJoe Hershberger	- CONFIG_ENV_FLAGS_LIST_STATIC
35262598090bSJoe Hershberger		Define this to a list (string) to define validation that
35272598090bSJoe Hershberger		should be done if an entry is not found in the ".flags"
35282598090bSJoe Hershberger		environment variable.  To override a setting in the static
35292598090bSJoe Hershberger		list, simply add an entry for the same variable name to the
35302598090bSJoe Hershberger		".flags" variable.
35312598090bSJoe Hershberger
3532267541f7SJoe Hershberger- CONFIG_ENV_ACCESS_IGNORE_FORCE
3533267541f7SJoe Hershberger	If defined, don't allow the -f switch to env set override variable
3534267541f7SJoe Hershberger	access flags.
3535267541f7SJoe Hershberger
35365c1a7ea6SSimon Glass- CONFIG_SYS_GENERIC_BOARD
35375c1a7ea6SSimon Glass	This selects the architecture-generic board system instead of the
35385c1a7ea6SSimon Glass	architecture-specific board files. It is intended to move boards
35395c1a7ea6SSimon Glass	to this new framework over time. Defining this will disable the
35405c1a7ea6SSimon Glass	arch/foo/lib/board.c file and use common/board_f.c and
35415c1a7ea6SSimon Glass	common/board_r.c instead. To use this option your architecture
35425c1a7ea6SSimon Glass	must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in
35435c1a7ea6SSimon Glass	its config.mk file). If you find problems enabling this option on
35445c1a7ea6SSimon Glass	your board please report the problem and send patches!
35455c1a7ea6SSimon Glass
3546632efa74SSimon Glass- CONFIG_SYS_SYM_OFFSETS
3547632efa74SSimon Glass	This is set by architectures that use offsets for link symbols
3548632efa74SSimon Glass	instead of absolute values. So bss_start is obtained using an
3549632efa74SSimon Glass	offset _bss_start_ofs from CONFIG_SYS_TEXT_BASE, rather than
3550632efa74SSimon Glass	directly. You should not need to touch this setting.
3551632efa74SSimon Glass
35520b1b60c7SLokesh Vutla- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
35530b1b60c7SLokesh Vutla	This is set by OMAP boards for the max time that reset should
35540b1b60c7SLokesh Vutla	be asserted. See doc/README.omap-reset-time for details on how
35550b1b60c7SLokesh Vutla	the value can be calulated on a given board.
3556632efa74SSimon Glass
3557c609719bSwdenkThe following definitions that deal with the placement and management
3558c609719bSwdenkof environment data (variable area); in general, we support the
3559c609719bSwdenkfollowing configurations:
3560c609719bSwdenk
3561c3eb3fe4SMike Frysinger- CONFIG_BUILD_ENVCRC:
3562c3eb3fe4SMike Frysinger
3563c3eb3fe4SMike Frysinger	Builds up envcrc with the target environment so that external utils
3564c3eb3fe4SMike Frysinger	may easily extract it and embed it in final U-Boot images.
3565c3eb3fe4SMike Frysinger
35665a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH:
3567c609719bSwdenk
3568c609719bSwdenk	Define this if the environment is in flash memory.
3569c609719bSwdenk
3570c609719bSwdenk	a) The environment occupies one whole flash sector, which is
3571c609719bSwdenk	   "embedded" in the text segment with the U-Boot code. This
3572c609719bSwdenk	   happens usually with "bottom boot sector" or "top boot
3573c609719bSwdenk	   sector" type flash chips, which have several smaller
3574c609719bSwdenk	   sectors at the start or the end. For instance, such a
3575c609719bSwdenk	   layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3576c609719bSwdenk	   such a case you would place the environment in one of the
3577c609719bSwdenk	   4 kB sectors - with U-Boot code before and after it. With
3578c609719bSwdenk	   "top boot sector" type flash chips, you would put the
3579c609719bSwdenk	   environment in one of the last sectors, leaving a gap
3580c609719bSwdenk	   between U-Boot and the environment.
3581c609719bSwdenk
35820e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
3583c609719bSwdenk
3584c609719bSwdenk	   Offset of environment data (variable area) to the
3585c609719bSwdenk	   beginning of flash memory; for instance, with bottom boot
3586c609719bSwdenk	   type flash chips the second sector can be used: the offset
3587c609719bSwdenk	   for this sector is given here.
3588c609719bSwdenk
35896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
3590c609719bSwdenk
35910e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
3592c609719bSwdenk
3593c609719bSwdenk	   This is just another way to specify the start address of
3594c609719bSwdenk	   the flash sector containing the environment (instead of
35950e8d1586SJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET).
3596c609719bSwdenk
35970e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SECT_SIZE:
3598c609719bSwdenk
3599c609719bSwdenk	   Size of the sector containing the environment.
3600c609719bSwdenk
3601c609719bSwdenk
3602c609719bSwdenk	b) Sometimes flash chips have few, equal sized, BIG sectors.
3603c609719bSwdenk	   In such a case you don't want to spend a whole sector for
3604c609719bSwdenk	   the environment.
3605c609719bSwdenk
36060e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3607c609719bSwdenk
36085a1aceb0SJean-Christophe PLAGNIOL-VILLARD	   If you use this in combination with CONFIG_ENV_IS_IN_FLASH
36090e8d1586SJean-Christophe PLAGNIOL-VILLARD	   and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
3610c609719bSwdenk	   of this flash sector for the environment. This saves
3611c609719bSwdenk	   memory for the RAM copy of the environment.
3612c609719bSwdenk
3613c609719bSwdenk	   It may also save flash memory if you decide to use this
3614c609719bSwdenk	   when your environment is "embedded" within U-Boot code,
3615c609719bSwdenk	   since then the remainder of the flash sector could be used
3616c609719bSwdenk	   for U-Boot code. It should be pointed out that this is
3617c609719bSwdenk	   STRONGLY DISCOURAGED from a robustness point of view:
3618c609719bSwdenk	   updating the environment in flash makes it always
3619c609719bSwdenk	   necessary to erase the WHOLE sector. If something goes
3620c609719bSwdenk	   wrong before the contents has been restored from a copy in
3621c609719bSwdenk	   RAM, your target system will be dead.
3622c609719bSwdenk
36230e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR_REDUND
36240e8d1586SJean-Christophe PLAGNIOL-VILLARD	  CONFIG_ENV_SIZE_REDUND
3625c609719bSwdenk
3626c609719bSwdenk	   These settings describe a second storage area used to hold
362711ccc33fSMarcel Ziswiler	   a redundant copy of the environment data, so that there is
36283e38691eSwdenk	   a valid backup copy in case there is a power failure during
3629c609719bSwdenk	   a "saveenv" operation.
3630c609719bSwdenk
3631c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the
3632c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds*
3633c609719bSwdenkaccordingly!
3634c609719bSwdenk
3635c609719bSwdenk
36369314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM:
3637c609719bSwdenk
3638c609719bSwdenk	Define this if you have some non-volatile memory device
3639c609719bSwdenk	(NVRAM, battery buffered SRAM) which you want to use for the
3640c609719bSwdenk	environment.
3641c609719bSwdenk
36420e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
36430e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3644c609719bSwdenk
364511ccc33fSMarcel Ziswiler	  These two #defines are used to determine the memory area you
3646c609719bSwdenk	  want to use for environment. It is assumed that this memory
3647c609719bSwdenk	  can just be read and written to, without any special
3648c609719bSwdenk	  provision.
3649c609719bSwdenk
3650c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early
3651c609719bSwdenkin U-Boot initalization (when we try to get the setting of for the
365211ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or
3653c609719bSwdenkU-Boot will hang.
3654c609719bSwdenk
3655c609719bSwdenkPlease note that even with NVRAM we still use a copy of the
3656c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to
3657c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv"
3658c609719bSwdenkto save the current settings.
3659c609719bSwdenk
3660c609719bSwdenk
3661bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM:
3662c609719bSwdenk
3663c609719bSwdenk	Use this if you have an EEPROM or similar serial access
3664c609719bSwdenk	device and a driver for it.
3665c609719bSwdenk
36660e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
36670e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3668c609719bSwdenk
3669c609719bSwdenk	  These two #defines specify the offset and size of the
3670c609719bSwdenk	  environment area within the total memory of your EEPROM.
3671c609719bSwdenk
36726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR:
3673c609719bSwdenk	  If defined, specified the chip address of the EEPROM device.
3674c609719bSwdenk	  The default address is zero.
3675c609719bSwdenk
36766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
3677c609719bSwdenk	  If defined, the number of bits used to address bytes in a
3678c609719bSwdenk	  single page in the EEPROM device.  A 64 byte page, for example
3679c609719bSwdenk	  would require six bits.
3680c609719bSwdenk
36816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
3682c609719bSwdenk	  If defined, the number of milliseconds to delay between
3683c609719bSwdenk	  page writes.	The default is zero milliseconds.
3684c609719bSwdenk
36856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
3686c609719bSwdenk	  The length in bytes of the EEPROM memory array address.  Note
3687c609719bSwdenk	  that this is NOT the chip address length!
3688c609719bSwdenk
36896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
36905cf91d6bSwdenk	  EEPROM chips that implement "address overflow" are ones
36915cf91d6bSwdenk	  like Catalyst 24WC04/08/16 which has 9/10/11 bits of
36925cf91d6bSwdenk	  address and the extra bits end up in the "chip address" bit
36935cf91d6bSwdenk	  slots. This makes a 24WC08 (1Kbyte) chip look like four 256
36945cf91d6bSwdenk	  byte chips.
36955cf91d6bSwdenk
36965cf91d6bSwdenk	  Note that we consider the length of the address field to
36975cf91d6bSwdenk	  still be one byte because the extra address bits are hidden
36985cf91d6bSwdenk	  in the chip address.
36995cf91d6bSwdenk
37006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_SIZE:
3701c609719bSwdenk	  The size in bytes of the EEPROM device.
3702c609719bSwdenk
3703548738b4SHeiko Schocher	- CONFIG_ENV_EEPROM_IS_ON_I2C
3704548738b4SHeiko Schocher	  define this, if you have I2C and SPI activated, and your
3705548738b4SHeiko Schocher	  EEPROM, which holds the environment, is on the I2C bus.
3706548738b4SHeiko Schocher
3707548738b4SHeiko Schocher	- CONFIG_I2C_ENV_EEPROM_BUS
3708548738b4SHeiko Schocher	  if you have an Environment on an EEPROM reached over
3709548738b4SHeiko Schocher	  I2C muxes, you can define here, how to reach this
3710548738b4SHeiko Schocher	  EEPROM. For example:
3711548738b4SHeiko Schocher
3712ea818dbbSHeiko Schocher	  #define CONFIG_I2C_ENV_EEPROM_BUS	  1
3713548738b4SHeiko Schocher
3714548738b4SHeiko Schocher	  EEPROM which holds the environment, is reached over
3715548738b4SHeiko Schocher	  a pca9547 i2c mux with address 0x70, channel 3.
3716c609719bSwdenk
3717057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH:
37185779d8d9Swdenk
37195779d8d9Swdenk	Define this if you have a DataFlash memory device which you
37205779d8d9Swdenk	want to use for the environment.
37215779d8d9Swdenk
37220e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
37230e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
37240e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
37255779d8d9Swdenk
37265779d8d9Swdenk	  These three #defines specify the offset and size of the
37275779d8d9Swdenk	  environment area within the total memory of your DataFlash placed
37285779d8d9Swdenk	  at the specified address.
37295779d8d9Swdenk
37300a85a9e7SLiu Gang- CONFIG_ENV_IS_IN_REMOTE:
37310a85a9e7SLiu Gang
37320a85a9e7SLiu Gang	Define this if you have a remote memory space which you
37330a85a9e7SLiu Gang	want to use for the local device's environment.
37340a85a9e7SLiu Gang
37350a85a9e7SLiu Gang	- CONFIG_ENV_ADDR:
37360a85a9e7SLiu Gang	- CONFIG_ENV_SIZE:
37370a85a9e7SLiu Gang
37380a85a9e7SLiu Gang	  These two #defines specify the address and size of the
37390a85a9e7SLiu Gang	  environment area within the remote memory space. The
37400a85a9e7SLiu Gang	  local device can get the environment from remote memory
3741fc54c7faSLiu Gang	  space by SRIO or PCIE links.
37420a85a9e7SLiu Gang
37430a85a9e7SLiu GangBE CAREFUL! For some special cases, the local device can not use
37440a85a9e7SLiu Gang"saveenv" command. For example, the local device will get the
3745fc54c7faSLiu Gangenvironment stored in a remote NOR flash by SRIO or PCIE link,
3746fc54c7faSLiu Gangbut it can not erase, write this NOR flash by SRIO or PCIE interface.
37470a85a9e7SLiu Gang
374851bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND:
374913a5695bSwdenk
375013a5695bSwdenk	Define this if you have a NAND device which you want to use
375113a5695bSwdenk	for the environment.
375213a5695bSwdenk
37530e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
37540e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
375513a5695bSwdenk
375613a5695bSwdenk	  These two #defines specify the offset and size of the environment
3757fdd813deSScott Wood	  area within the first NAND device.  CONFIG_ENV_OFFSET must be
3758fdd813deSScott Wood	  aligned to an erase block boundary.
37595779d8d9Swdenk
3760fdd813deSScott Wood	- CONFIG_ENV_OFFSET_REDUND (optional):
3761e443c944SMarkus Klotzbuecher
37620e8d1586SJean-Christophe PLAGNIOL-VILLARD	  This setting describes a second storage area of CONFIG_ENV_SIZE
3763fdd813deSScott Wood	  size used to hold a redundant copy of the environment data, so
3764fdd813deSScott Wood	  that there is a valid backup copy in case there is a power failure
3765fdd813deSScott Wood	  during a "saveenv" operation.	 CONFIG_ENV_OFFSET_RENDUND must be
3766fdd813deSScott Wood	  aligned to an erase block boundary.
3767e443c944SMarkus Klotzbuecher
3768fdd813deSScott Wood	- CONFIG_ENV_RANGE (optional):
3769fdd813deSScott Wood
3770fdd813deSScott Wood	  Specifies the length of the region in which the environment
3771fdd813deSScott Wood	  can be written.  This should be a multiple of the NAND device's
3772fdd813deSScott Wood	  block size.  Specifying a range with more erase blocks than
3773fdd813deSScott Wood	  are needed to hold CONFIG_ENV_SIZE allows bad blocks within
3774fdd813deSScott Wood	  the range to be avoided.
3775fdd813deSScott Wood
3776fdd813deSScott Wood	- CONFIG_ENV_OFFSET_OOB (optional):
3777fdd813deSScott Wood
3778fdd813deSScott Wood	  Enables support for dynamically retrieving the offset of the
3779fdd813deSScott Wood	  environment from block zero's out-of-band data.  The
3780fdd813deSScott Wood	  "nand env.oob" command can be used to record this offset.
3781fdd813deSScott Wood	  Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
3782fdd813deSScott Wood	  using CONFIG_ENV_OFFSET_OOB.
3783e443c944SMarkus Klotzbuecher
3784b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST
3785b74ab737SGuennadi Liakhovetski
3786b74ab737SGuennadi Liakhovetski	Defines address in RAM to which the nand_spl code should copy the
3787b74ab737SGuennadi Liakhovetski	environment. If redundant environment is used, it will be copied to
3788b74ab737SGuennadi Liakhovetski	CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3789b74ab737SGuennadi Liakhovetski
37902b74433fSJoe Hershberger- CONFIG_ENV_IS_IN_UBI:
37912b74433fSJoe Hershberger
37922b74433fSJoe Hershberger	Define this if you have an UBI volume that you want to use for the
37932b74433fSJoe Hershberger	environment.  This has the benefit of wear-leveling the environment
37942b74433fSJoe Hershberger	accesses, which is important on NAND.
37952b74433fSJoe Hershberger
37962b74433fSJoe Hershberger	- CONFIG_ENV_UBI_PART:
37972b74433fSJoe Hershberger
37982b74433fSJoe Hershberger	  Define this to a string that is the mtd partition containing the UBI.
37992b74433fSJoe Hershberger
38002b74433fSJoe Hershberger	- CONFIG_ENV_UBI_VOLUME:
38012b74433fSJoe Hershberger
38022b74433fSJoe Hershberger	  Define this to the name of the volume that you want to store the
38032b74433fSJoe Hershberger	  environment in.
38042b74433fSJoe Hershberger
3805785881f7SJoe Hershberger	- CONFIG_ENV_UBI_VOLUME_REDUND:
3806785881f7SJoe Hershberger
3807785881f7SJoe Hershberger	  Define this to the name of another volume to store a second copy of
3808785881f7SJoe Hershberger	  the environment in.  This will enable redundant environments in UBI.
3809785881f7SJoe Hershberger	  It is assumed that both volumes are in the same MTD partition.
3810785881f7SJoe Hershberger
38112b74433fSJoe Hershberger	- CONFIG_UBI_SILENCE_MSG
38122b74433fSJoe Hershberger	- CONFIG_UBIFS_SILENCE_MSG
38132b74433fSJoe Hershberger
38142b74433fSJoe Hershberger	  You will probably want to define these to avoid a really noisy system
38152b74433fSJoe Hershberger	  when storing the env in UBI.
38162b74433fSJoe Hershberger
381706e4ae5fSStephen Warren- CONFIG_ENV_IS_IN_MMC:
381806e4ae5fSStephen Warren
381906e4ae5fSStephen Warren	Define this if you have an MMC device which you want to use for the
382006e4ae5fSStephen Warren	environment.
382106e4ae5fSStephen Warren
382206e4ae5fSStephen Warren	- CONFIG_SYS_MMC_ENV_DEV:
382306e4ae5fSStephen Warren
382406e4ae5fSStephen Warren	  Specifies which MMC device the environment is stored in.
382506e4ae5fSStephen Warren
382606e4ae5fSStephen Warren	- CONFIG_SYS_MMC_ENV_PART (optional):
382706e4ae5fSStephen Warren
382806e4ae5fSStephen Warren	  Specifies which MMC partition the environment is stored in. If not
382906e4ae5fSStephen Warren	  set, defaults to partition 0, the user area. Common values might be
383006e4ae5fSStephen Warren	  1 (first MMC boot partition), 2 (second MMC boot partition).
383106e4ae5fSStephen Warren
383206e4ae5fSStephen Warren	- CONFIG_ENV_OFFSET:
383306e4ae5fSStephen Warren	- CONFIG_ENV_SIZE:
383406e4ae5fSStephen Warren
383506e4ae5fSStephen Warren	  These two #defines specify the offset and size of the environment
383606e4ae5fSStephen Warren	  area within the specified MMC device.
383706e4ae5fSStephen Warren
38385c088ee8SStephen Warren	  If offset is positive (the usual case), it is treated as relative to
38395c088ee8SStephen Warren	  the start of the MMC partition. If offset is negative, it is treated
38405c088ee8SStephen Warren	  as relative to the end of the MMC partition. This can be useful if
38415c088ee8SStephen Warren	  your board may be fitted with different MMC devices, which have
38425c088ee8SStephen Warren	  different sizes for the MMC partitions, and you always want the
38435c088ee8SStephen Warren	  environment placed at the very end of the partition, to leave the
38445c088ee8SStephen Warren	  maximum possible space before it, to store other data.
38455c088ee8SStephen Warren
384606e4ae5fSStephen Warren	  These two values are in units of bytes, but must be aligned to an
384706e4ae5fSStephen Warren	  MMC sector boundary.
384806e4ae5fSStephen Warren
384906e4ae5fSStephen Warren	- CONFIG_ENV_OFFSET_REDUND (optional):
385006e4ae5fSStephen Warren
385106e4ae5fSStephen Warren	  Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
385206e4ae5fSStephen Warren	  hold a redundant copy of the environment data. This provides a
385306e4ae5fSStephen Warren	  valid backup copy in case the other copy is corrupted, e.g. due
385406e4ae5fSStephen Warren	  to a power failure during a "saveenv" operation.
385506e4ae5fSStephen Warren
38565c088ee8SStephen Warren	  This value may also be positive or negative; this is handled in the
38575c088ee8SStephen Warren	  same way as CONFIG_ENV_OFFSET.
38585c088ee8SStephen Warren
385906e4ae5fSStephen Warren	  This value is also in units of bytes, but must also be aligned to
386006e4ae5fSStephen Warren	  an MMC sector boundary.
386106e4ae5fSStephen Warren
386206e4ae5fSStephen Warren	- CONFIG_ENV_SIZE_REDUND (optional):
386306e4ae5fSStephen Warren
386406e4ae5fSStephen Warren	  This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
386506e4ae5fSStephen Warren	  set. If this value is set, it must be set to the same value as
386606e4ae5fSStephen Warren	  CONFIG_ENV_SIZE.
386706e4ae5fSStephen Warren
38686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET
3869c609719bSwdenk
3870c609719bSwdenk	Defines offset to the initial SPI buffer area in DPRAM. The
3871c609719bSwdenk	area is used at an early stage (ROM part) if the environment
3872c609719bSwdenk	is configured to reside in the SPI EEPROM: We need a 520 byte
3873c609719bSwdenk	scratch DPRAM area. It is used between the two initialization
3874c609719bSwdenk	calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
3875c609719bSwdenk	to be a good choice since it makes it far enough from the
3876c609719bSwdenk	start of the data area as well as from the stack pointer.
3877c609719bSwdenk
3878e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor
3879c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been
3880cdb74977SWolfgang Denkcreated; also, when using EEPROM you will have to use getenv_f()
3881c609719bSwdenkuntil then to read environment variables.
3882c609719bSwdenk
388385ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor
388485ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working
388585ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is
388685ec0bccSwdenknecessary, because the first environment variable we need is the
388785ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't
388885ec0bccSwdenkhave any device yet where we could complain.]
3889c609719bSwdenk
3890c609719bSwdenkNote: once the monitor has been relocated, then it will complain if
3891c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you
389285ec0bccSwdenkuse the "saveenv" command to store a valid environment.
3893c609719bSwdenk
38946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
3895fc3e2165Swdenk		Echo the inverted Ethernet link state to the fault LED.
3896fc3e2165Swdenk
38976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
3898fc3e2165Swdenk		      also needs to be defined.
3899fc3e2165Swdenk
39006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR:
3901fc3e2165Swdenk		MII address of the PHY to check for the Ethernet link state.
3902c609719bSwdenk
3903f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS:
3904f5675aa5SRon Madrid		Define this if you desire to only have use of the NS16550_init
3905f5675aa5SRon Madrid		and NS16550_putc functions for the serial driver located at
3906f5675aa5SRon Madrid		drivers/serial/ns16550.c.  This option is useful for saving
3907f5675aa5SRon Madrid		space for already greatly restricted images, including but not
3908f5675aa5SRon Madrid		limited to NAND_SPL configurations.
3909f5675aa5SRon Madrid
3910b2b92f53SSimon Glass- CONFIG_DISPLAY_BOARDINFO
3911b2b92f53SSimon Glass		Display information about the board that U-Boot is running on
3912b2b92f53SSimon Glass		when U-Boot starts up. The board function checkboard() is called
3913b2b92f53SSimon Glass		to do this.
3914b2b92f53SSimon Glass
3915e2e3e2b1SSimon Glass- CONFIG_DISPLAY_BOARDINFO_LATE
3916e2e3e2b1SSimon Glass		Similar to the previous option, but display this information
3917e2e3e2b1SSimon Glass		later, once stdio is running and output goes to the LCD, if
3918e2e3e2b1SSimon Glass		present.
3919e2e3e2b1SSimon Glass
3920c609719bSwdenkLow Level (hardware related) configuration options:
3921dc7c9a1aSwdenk---------------------------------------------------
3922c609719bSwdenk
39236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE:
3924c609719bSwdenk		Cache Line Size of the CPU.
3925c609719bSwdenk
39266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR:
3927c609719bSwdenk		Default address of the IMMR after system reset.
39282535d602Swdenk
39292535d602Swdenk		Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
39302535d602Swdenk		and RPXsuper) to be able to adjust the position of
39312535d602Swdenk		the IMMR register after a reset.
3932c609719bSwdenk
3933e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_DEFAULT:
3934e46fedfeSTimur Tabi		Default (power-on reset) physical address of CCSR on Freescale
3935e46fedfeSTimur Tabi		PowerPC SOCs.
3936e46fedfeSTimur Tabi
3937e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR:
3938e46fedfeSTimur Tabi		Virtual address of CCSR.  On a 32-bit build, this is typically
3939e46fedfeSTimur Tabi		the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
3940e46fedfeSTimur Tabi
3941e46fedfeSTimur Tabi		CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
3942e46fedfeSTimur Tabi		for cross-platform code that uses that macro instead.
3943e46fedfeSTimur Tabi
3944e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS:
3945e46fedfeSTimur Tabi		Physical address of CCSR.  CCSR can be relocated to a new
3946e46fedfeSTimur Tabi		physical address, if desired.  In this case, this macro should
3947e46fedfeSTimur Tabi		be set to that address.	 Otherwise, it should be set to the
3948e46fedfeSTimur Tabi		same value as CONFIG_SYS_CCSRBAR_DEFAULT.  For example, CCSR
3949e46fedfeSTimur Tabi		is typically relocated on 36-bit builds.  It is recommended
3950e46fedfeSTimur Tabi		that this macro be defined via the _HIGH and _LOW macros:
3951e46fedfeSTimur Tabi
3952e46fedfeSTimur Tabi		#define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3953e46fedfeSTimur Tabi			* 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3954e46fedfeSTimur Tabi
3955e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
3956e46fedfeSTimur Tabi		Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS.	This value is typically
3957e46fedfeSTimur Tabi		either 0 (32-bit build) or 0xF (36-bit build).	This macro is
3958e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
3959e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
3960e46fedfeSTimur Tabi
3961e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_LOW:
3962e46fedfeSTimur Tabi		Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS.  This macro is
3963e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
3964e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
3965e46fedfeSTimur Tabi
3966e46fedfeSTimur Tabi- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
3967e46fedfeSTimur Tabi		If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
3968e46fedfeSTimur Tabi		forced to a value that ensures that CCSR is not relocated.
3969e46fedfeSTimur Tabi
39707f6c2cbcSwdenk- Floppy Disk Support:
39716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER
39727f6c2cbcSwdenk
39737f6c2cbcSwdenk		the default drive number (default value 0)
39747f6c2cbcSwdenk
39756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_STRIDE
39767f6c2cbcSwdenk
397711ccc33fSMarcel Ziswiler		defines the spacing between FDC chipset registers
39787f6c2cbcSwdenk		(default value 1)
39797f6c2cbcSwdenk
39806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_OFFSET
39817f6c2cbcSwdenk
39827f6c2cbcSwdenk		defines the offset of register from address. It
39837f6c2cbcSwdenk		depends on which part of the data bus is connected to
398411ccc33fSMarcel Ziswiler		the FDC chipset. (default value 0)
39857f6c2cbcSwdenk
39866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
39876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
39887f6c2cbcSwdenk		default value.
39897f6c2cbcSwdenk
39906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		if CONFIG_SYS_FDC_HW_INIT is defined, then the function
39917f6c2cbcSwdenk		fdc_hw_init() is called at the beginning of the FDC
39927f6c2cbcSwdenk		setup. fdc_hw_init() must be provided by the board
39937f6c2cbcSwdenk		source code. It is used to make hardware dependant
39947f6c2cbcSwdenk		initializations.
39957f6c2cbcSwdenk
39960abddf82SMacpaul Lin- CONFIG_IDE_AHB:
39970abddf82SMacpaul Lin		Most IDE controllers were designed to be connected with PCI
39980abddf82SMacpaul Lin		interface. Only few of them were designed for AHB interface.
39990abddf82SMacpaul Lin		When software is doing ATA command and data transfer to
40000abddf82SMacpaul Lin		IDE devices through IDE-AHB controller, some additional
40010abddf82SMacpaul Lin		registers accessing to these kind of IDE-AHB controller
40020abddf82SMacpaul Lin		is requierd.
40030abddf82SMacpaul Lin
40046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR:	Physical address of the Internal Memory.
400525d6712aSwdenk		DO NOT CHANGE unless you know exactly what you're
400625d6712aSwdenk		doing! (11-4) [MPC8xx/82xx systems only]
4007c609719bSwdenk
40086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR:
4009c609719bSwdenk
40107152b1d0Swdenk		Start address of memory area that can be used for
4011c609719bSwdenk		initial data and stack; please note that this must be
4012c609719bSwdenk		writable memory that is working WITHOUT special
4013c609719bSwdenk		initialization, i. e. you CANNOT use normal RAM which
4014c609719bSwdenk		will become available only after programming the
4015c609719bSwdenk		memory controller and running certain initialization
4016c609719bSwdenk		sequences.
4017c609719bSwdenk
4018c609719bSwdenk		U-Boot uses the following memory types:
4019c609719bSwdenk		- MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4020c609719bSwdenk		- MPC824X: data cache
4021c609719bSwdenk		- PPC4xx:  data cache
4022c609719bSwdenk
40236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET:
4024c609719bSwdenk
4025c609719bSwdenk		Offset of the initial data structure in the memory
40266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
40276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
4028c609719bSwdenk		data is located at the end of the available space
4029553f0982SWolfgang Denk		(sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
40306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
40316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
40326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET) downward.
4033c609719bSwdenk
4034c609719bSwdenk	Note:
4035c609719bSwdenk		On the MPC824X (or other systems that use the data
4036c609719bSwdenk		cache for initial memory) the address chosen for
40376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
4038c609719bSwdenk		point to an otherwise UNUSED address space between
4039c609719bSwdenk		the top of RAM and the start of the PCI space.
4040c609719bSwdenk
40416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR:	SIU Module Configuration (11-6)
4042c609719bSwdenk
40436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR:	System Protection Control (11-9)
4044c609719bSwdenk
40456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR:	Time Base Status and Control (11-26)
4046c609719bSwdenk
40476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR:	Periodic Interrupt Status and Control (11-31)
4048c609719bSwdenk
40496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR:	PLL, Low-Power, and Reset Control Register (15-30)
4050c609719bSwdenk
40516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR:	System Clock and reset Control Register (15-27)
4052c609719bSwdenk
40536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM:
4054c609719bSwdenk		SDRAM timing
4055c609719bSwdenk
40566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA:
4057c609719bSwdenk		periodic timer for refresh
4058c609719bSwdenk
40596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER:	Debug Event Register (37-47)
4060c609719bSwdenk
40616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
40626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
40636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
40646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_BR1_PRELIM:
4065c609719bSwdenk		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4066c609719bSwdenk
4067c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
40686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
40696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
4070c609719bSwdenk		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4071c609719bSwdenk
40726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
40736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
4074c609719bSwdenk		Machine Mode Register and Memory Periodic Timer
4075c609719bSwdenk		Prescaler definitions (SDRAM timing)
4076c609719bSwdenk
40776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
4078c609719bSwdenk		enable I2C microcode relocation patch (MPC8xx);
4079c609719bSwdenk		define relocation offset in DPRAM [DSP2]
4080c609719bSwdenk
40816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
4082b423d055SHeiko Schocher		enable SMC microcode relocation patch (MPC8xx);
4083b423d055SHeiko Schocher		define relocation offset in DPRAM [SMC1]
4084b423d055SHeiko Schocher
40856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
4086c609719bSwdenk		enable SPI microcode relocation patch (MPC8xx);
4087c609719bSwdenk		define relocation offset in DPRAM [SCC4]
4088c609719bSwdenk
40896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_USE_OSCCLK:
4090c609719bSwdenk		Use OSCM clock mode on MBX8xx board. Be careful,
4091c609719bSwdenk		wrong setting might damage your board. Read
4092c609719bSwdenk		doc/README.MBX before setting this variable!
4093c609719bSwdenk
40946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
4095ea909b76Swdenk		Offset of the bootmode word in DPRAM used by post
4096ea909b76Swdenk		(Power On Self Tests). This definition overrides
4097ea909b76Swdenk		#define'd default value in commproc.h resp.
4098ea909b76Swdenk		cpm_8260.h.
4099ea909b76Swdenk
41006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
41016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
41026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
41036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
41046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
41056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
41066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
41076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
4108a47a12beSStefan Roese		Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
41095d232d0eSwdenk
41109cacf4fcSDirk Eibach- CONFIG_PCI_DISABLE_PCIE:
41119cacf4fcSDirk Eibach		Disable PCI-Express on systems where it is supported but not
41129cacf4fcSDirk Eibach		required.
41139cacf4fcSDirk Eibach
411469fd2d3bSAndrew Sharp- CONFIG_PCI_ENUM_ONLY
411569fd2d3bSAndrew Sharp		Only scan through and get the devices on the busses.
411669fd2d3bSAndrew Sharp		Don't do any setup work, presumably because someone or
411769fd2d3bSAndrew Sharp		something has already done it, and we don't need to do it
411869fd2d3bSAndrew Sharp		a second time.	Useful for platforms that are pre-booted
411969fd2d3bSAndrew Sharp		by coreboot or similar.
412069fd2d3bSAndrew Sharp
4121842033e6SGabor Juhos- CONFIG_PCI_INDIRECT_BRIDGE:
4122842033e6SGabor Juhos		Enable support for indirect PCI bridges.
4123842033e6SGabor Juhos
4124a09b9b68SKumar Gala- CONFIG_SYS_SRIO:
4125a09b9b68SKumar Gala		Chip has SRIO or not
4126a09b9b68SKumar Gala
4127a09b9b68SKumar Gala- CONFIG_SRIO1:
4128a09b9b68SKumar Gala		Board has SRIO 1 port available
4129a09b9b68SKumar Gala
4130a09b9b68SKumar Gala- CONFIG_SRIO2:
4131a09b9b68SKumar Gala		Board has SRIO 2 port available
4132a09b9b68SKumar Gala
4133c8b28152SLiu Gang- CONFIG_SRIO_PCIE_BOOT_MASTER
4134c8b28152SLiu Gang		Board can support master function for Boot from SRIO and PCIE
4135c8b28152SLiu Gang
4136a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_VIRT:
4137a09b9b68SKumar Gala		Virtual Address of SRIO port 'n' memory region
4138a09b9b68SKumar Gala
4139a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_PHYS:
4140a09b9b68SKumar Gala		Physical Address of SRIO port 'n' memory region
4141a09b9b68SKumar Gala
4142a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_SIZE:
4143a09b9b68SKumar Gala		Size of SRIO port 'n' memory region
4144a09b9b68SKumar Gala
414566bd1846SFabio Estevam- CONFIG_SYS_NAND_BUSWIDTH_16BIT
414666bd1846SFabio Estevam		Defined to tell the NAND controller that the NAND chip is using
414766bd1846SFabio Estevam		a 16 bit bus.
414866bd1846SFabio Estevam		Not all NAND drivers use this symbol.
4149a430e916SFabio Estevam		Example of drivers that use it:
415066bd1846SFabio Estevam		- drivers/mtd/nand/ndfc.c
4151a430e916SFabio Estevam		- drivers/mtd/nand/mxc_nand.c
4152eced4626SAlex Waterman
4153eced4626SAlex Waterman- CONFIG_SYS_NDFC_EBC0_CFG
4154eced4626SAlex Waterman		Sets the EBC0_CFG register for the NDFC. If not defined
4155eced4626SAlex Waterman		a default value will be used.
4156eced4626SAlex Waterman
4157bb99ad6dSBen Warren- CONFIG_SPD_EEPROM
4158218ca724SWolfgang Denk		Get DDR timing information from an I2C EEPROM. Common
4159218ca724SWolfgang Denk		with pluggable memory modules such as SODIMMs
4160218ca724SWolfgang Denk
4161bb99ad6dSBen Warren  SPD_EEPROM_ADDRESS
4162bb99ad6dSBen Warren		I2C address of the SPD EEPROM
4163bb99ad6dSBen Warren
41646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM
4165218ca724SWolfgang Denk		If SPD EEPROM is on an I2C bus other than the first
4166218ca724SWolfgang Denk		one, specify here. Note that the value must resolve
4167218ca724SWolfgang Denk		to something your driver can deal with.
4168bb99ad6dSBen Warren
41691b3e3c4fSYork Sun- CONFIG_SYS_DDR_RAW_TIMING
41701b3e3c4fSYork Sun		Get DDR timing information from other than SPD. Common with
41711b3e3c4fSYork Sun		soldered DDR chips onboard without SPD. DDR raw timing
41721b3e3c4fSYork Sun		parameters are extracted from datasheet and hard-coded into
41731b3e3c4fSYork Sun		header files or board specific files.
41741b3e3c4fSYork Sun
41756f5e1dc5SYork Sun- CONFIG_FSL_DDR_INTERACTIVE
41766f5e1dc5SYork Sun		Enable interactive DDR debugging. See doc/README.fsl-ddr.
41776f5e1dc5SYork Sun
41786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0
4179218ca724SWolfgang Denk		Only for 83xx systems. If specified, then DDR should
4180218ca724SWolfgang Denk		be configured using CS0 and CS1 instead of CS2 and CS3.
41812ad6b513STimur Tabi
4182c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12]
4183c26e454dSwdenk		Define to enable FEC[12] on a 8xx series processor.
4184c26e454dSwdenk
4185c26e454dSwdenk- CONFIG_FEC[12]_PHY
4186c26e454dSwdenk		Define to the hardcoded PHY address which corresponds
41876e592385Swdenk		to the given FEC; i. e.
4188c26e454dSwdenk			#define CONFIG_FEC1_PHY 4
4189c26e454dSwdenk		means that the PHY with address 4 is connected to FEC1
4190c26e454dSwdenk
4191c26e454dSwdenk		When set to -1, means to probe for first available.
4192c26e454dSwdenk
4193c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR
4194c26e454dSwdenk		The PHY does not have a RXERR line (RMII only).
4195c26e454dSwdenk		(so program the FEC to ignore it).
4196c26e454dSwdenk
4197c26e454dSwdenk- CONFIG_RMII
4198c26e454dSwdenk		Enable RMII mode for all FECs.
4199c26e454dSwdenk		Note that this is a global option, we can't
4200c26e454dSwdenk		have one FEC in standard MII mode and another in RMII mode.
4201c26e454dSwdenk
42025cf91d6bSwdenk- CONFIG_CRC32_VERIFY
42035cf91d6bSwdenk		Add a verify option to the crc32 command.
42045cf91d6bSwdenk		The syntax is:
42055cf91d6bSwdenk
42065cf91d6bSwdenk		=> crc32 -v <address> <count> <crc32>
42075cf91d6bSwdenk
42085cf91d6bSwdenk		Where address/count indicate a memory area
42095cf91d6bSwdenk		and crc32 is the correct crc32 which the
42105cf91d6bSwdenk		area should have.
42115cf91d6bSwdenk
421256523f12Swdenk- CONFIG_LOOPW
421356523f12Swdenk		Add the "loopw" memory command. This only takes effect if
4214602ad3b3SJon Loeliger		the memory commands are activated globally (CONFIG_CMD_MEM).
421556523f12Swdenk
42167b466641Sstroese- CONFIG_MX_CYCLIC
42177b466641Sstroese		Add the "mdc" and "mwc" memory commands. These are cyclic
42187b466641Sstroese		"md/mw" commands.
42197b466641Sstroese		Examples:
42207b466641Sstroese
42217b466641Sstroese		=> mdc.b 10 4 500
42227b466641Sstroese		This command will print 4 bytes (10,11,12,13) each 500 ms.
42237b466641Sstroese
42247b466641Sstroese		=> mwc.l 100 12345678 10
42257b466641Sstroese		This command will write 12345678 to address 100 all 10 ms.
42267b466641Sstroese
42277b466641Sstroese		This only takes effect if the memory commands are activated
4228602ad3b3SJon Loeliger		globally (CONFIG_CMD_MEM).
42297b466641Sstroese
42308aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT
4231afc1ce82SMacpaul Lin		[ARM, NDS32, MIPS only] If this variable is defined, then certain
4232e03f3169SWolfgang Denk		low level initializations (like setting up the memory
4233e03f3169SWolfgang Denk		controller) are omitted and/or U-Boot does not
4234e03f3169SWolfgang Denk		relocate itself into RAM.
42358aa1a2d1Swdenk
4236e03f3169SWolfgang Denk		Normally this variable MUST NOT be defined. The only
4237e03f3169SWolfgang Denk		exception is when U-Boot is loaded (to RAM) by some
4238e03f3169SWolfgang Denk		other boot loader or by a debugger which performs
4239e03f3169SWolfgang Denk		these initializations itself.
42408aa1a2d1Swdenk
4241401bb30bSAneesh V- CONFIG_SPL_BUILD
4242df81238bSMagnus Lilja		Modifies the behaviour of start.S when compiling a loader
4243df81238bSMagnus Lilja		that is executed before the actual U-Boot. E.g. when
4244df81238bSMagnus Lilja		compiling a NAND SPL.
4245400558b5Swdenk
42463aa29de0SYing Zhang- CONFIG_TPL_BUILD
42473aa29de0SYing Zhang		Modifies the behaviour of start.S  when compiling a loader
42483aa29de0SYing Zhang		that is executed after the SPL and before the actual U-Boot.
42493aa29de0SYing Zhang		It is loaded by the SPL.
42503aa29de0SYing Zhang
42515df572f0SYing Zhang- CONFIG_SYS_MPC85XX_NO_RESETVEC
42525df572f0SYing Zhang		Only for 85xx systems. If this variable is specified, the section
42535df572f0SYing Zhang		.resetvec is not kept and the section .bootpg is placed in the
42545df572f0SYing Zhang		previous 4k of the .text section.
42555df572f0SYing Zhang
42564213fc29SSimon Glass- CONFIG_ARCH_MAP_SYSMEM
42574213fc29SSimon Glass		Generally U-Boot (and in particular the md command) uses
42584213fc29SSimon Glass		effective address. It is therefore not necessary to regard
42594213fc29SSimon Glass		U-Boot address as virtual addresses that need to be translated
42604213fc29SSimon Glass		to physical addresses. However, sandbox requires this, since
42614213fc29SSimon Glass		it maintains its own little RAM buffer which contains all
42624213fc29SSimon Glass		addressable memory. This option causes some memory accesses
42634213fc29SSimon Glass		to be mapped through map_sysmem() / unmap_sysmem().
42644213fc29SSimon Glass
4265d8834a13SMatthias Weisser- CONFIG_USE_ARCH_MEMCPY
4266d8834a13SMatthias Weisser  CONFIG_USE_ARCH_MEMSET
4267d8834a13SMatthias Weisser		If these options are used a optimized version of memcpy/memset will
4268d8834a13SMatthias Weisser		be used if available. These functions may be faster under some
4269d8834a13SMatthias Weisser		conditions but may increase the binary size.
4270d8834a13SMatthias Weisser
4271588a13f7SSimon Glass- CONFIG_X86_RESET_VECTOR
4272588a13f7SSimon Glass		If defined, the x86 reset vector code is included. This is not
4273588a13f7SSimon Glass		needed when U-Boot is running from Coreboot.
4274b16f521aSGabe Black
4275fc33705eSMark Jackson- CONFIG_SYS_MPUCLK
4276fc33705eSMark Jackson		Defines the MPU clock speed (in MHz).
4277fc33705eSMark Jackson
4278fc33705eSMark Jackson		NOTE : currently only supported on AM335x platforms.
42795b5ece9eSGabe Black
4280f2717b47STimur TabiFreescale QE/FMAN Firmware Support:
4281f2717b47STimur Tabi-----------------------------------
4282f2717b47STimur Tabi
4283f2717b47STimur TabiThe Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4284f2717b47STimur Tabiloading of "firmware", which is encoded in the QE firmware binary format.
4285f2717b47STimur TabiThis firmware often needs to be loaded during U-Boot booting, so macros
4286f2717b47STimur Tabiare used to identify the storage device (NOR flash, SPI, etc) and the address
4287f2717b47STimur Tabiwithin that device.
4288f2717b47STimur Tabi
4289f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_ADDR
4290f2717b47STimur Tabi	The address in the storage device where the firmware is located.  The
4291f2717b47STimur Tabi	meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4292f2717b47STimur Tabi	is also specified.
4293f2717b47STimur Tabi
4294f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_LENGTH
4295f2717b47STimur Tabi	The maximum possible size of the firmware.  The firmware binary format
4296f2717b47STimur Tabi	has a field that specifies the actual size of the firmware, but it
4297f2717b47STimur Tabi	might not be possible to read any part of the firmware unless some
4298f2717b47STimur Tabi	local storage is allocated to hold the entire firmware first.
4299f2717b47STimur Tabi
4300f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4301f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4302f2717b47STimur Tabi	normal addressable memory via the LBC.  CONFIG_SYS_FMAN_FW_ADDR is the
4303f2717b47STimur Tabi	virtual address in NOR flash.
4304f2717b47STimur Tabi
4305f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4306f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NAND flash.
4307f2717b47STimur Tabi	CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4308f2717b47STimur Tabi
4309f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4310f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SD/MMC
4311f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4312f2717b47STimur Tabi
4313f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
4314f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SPI
4315f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4316f2717b47STimur Tabi
4317292dc6c5SLiu Gang- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4318292dc6c5SLiu Gang	Specifies that QE/FMAN firmware is located in the remote (master)
4319292dc6c5SLiu Gang	memory space.	CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
4320fc54c7faSLiu Gang	can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4321fc54c7faSLiu Gang	window->master inbound window->master LAW->the ucode address in
4322fc54c7faSLiu Gang	master's memory space.
4323f2717b47STimur Tabi
4324c609719bSwdenkBuilding the Software:
4325c609719bSwdenk======================
4326c609719bSwdenk
4327218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments
4328218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support
4329218ca724SWolfgang Denkall possibly existing versions of cross development tools in all
4330218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we
4331218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4332218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot.
4333c609719bSwdenk
4334218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you
4335218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case,
4336218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell.
4337218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are
4338218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter:
4339c609719bSwdenk
4340218ca724SWolfgang Denk	$ CROSS_COMPILE=ppc_4xx-
4341218ca724SWolfgang Denk	$ export CROSS_COMPILE
4342c609719bSwdenk
43432f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in
43442f8d396bSPeter Tyser      the tools directory you can use the MinGW toolchain
43452f8d396bSPeter Tyser      (http://www.mingw.org).  Set your HOST tools to the MinGW
43462f8d396bSPeter Tyser      toolchain and execute 'make tools'.  For example:
43472f8d396bSPeter Tyser
43482f8d396bSPeter Tyser       $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
43492f8d396bSPeter Tyser
43502f8d396bSPeter Tyser      Binaries such as tools/mkimage.exe will be created which can
43512f8d396bSPeter Tyser      be executed on computers running Windows.
43522f8d396bSPeter Tyser
4353c609719bSwdenkU-Boot is intended to be simple to build. After installing the
4354c609719bSwdenksources you must configure U-Boot for one specific board type. This
4355c609719bSwdenkis done by typing:
4356c609719bSwdenk
4357c609719bSwdenk	make NAME_config
4358c609719bSwdenk
4359218ca724SWolfgang Denkwhere "NAME_config" is the name of one of the existing configu-
43604d675ae6SMichael Jonesrations; see boards.cfg for supported names.
436154387ac9Swdenk
4362c609719bSwdenkNote: for some board special configuration names may exist; check if
4363c609719bSwdenk      additional information is available from the board vendor; for
43642729af9dSwdenk      instance, the TQM823L systems are available without (standard)
43652729af9dSwdenk      or with LCD support. You can select such additional "features"
436611ccc33fSMarcel Ziswiler      when choosing the configuration, i. e.
4367c609719bSwdenk
43682729af9dSwdenk      make TQM823L_config
43692729af9dSwdenk	- will configure for a plain TQM823L, i. e. no LCD support
4370c609719bSwdenk
4371c609719bSwdenk      make TQM823L_LCD_config
4372c609719bSwdenk	- will configure for a TQM823L with U-Boot console on LCD
4373c609719bSwdenk
4374c609719bSwdenk      etc.
4375c609719bSwdenk
4376c609719bSwdenk
4377c609719bSwdenkFinally, type "make all", and you should get some working U-Boot
43787152b1d0Swdenkimages ready for download to / installation on your system:
4379c609719bSwdenk
4380c609719bSwdenk- "u-boot.bin" is a raw binary image
4381c609719bSwdenk- "u-boot" is an image in ELF binary format
4382c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format
4383c609719bSwdenk
4384baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved
4385baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change
4386baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory:
4387baf31249SMarian Balakowicz
4388baf31249SMarian Balakowicz1. Add O= to the make command line invocations:
4389baf31249SMarian Balakowicz
4390baf31249SMarian Balakowicz	make O=/tmp/build distclean
4391baf31249SMarian Balakowicz	make O=/tmp/build NAME_config
4392baf31249SMarian Balakowicz	make O=/tmp/build all
4393baf31249SMarian Balakowicz
4394baf31249SMarian Balakowicz2. Set environment variable BUILD_DIR to point to the desired location:
4395baf31249SMarian Balakowicz
4396baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
4397baf31249SMarian Balakowicz	make distclean
4398baf31249SMarian Balakowicz	make NAME_config
4399baf31249SMarian Balakowicz	make all
4400baf31249SMarian Balakowicz
4401baf31249SMarian BalakowiczNote that the command line "O=" setting overrides the BUILD_DIR environment
4402baf31249SMarian Balakowiczvariable.
4403baf31249SMarian Balakowicz
4404c609719bSwdenk
4405c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so
4406c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of
4407c609719bSwdenknative "make".
4408c609719bSwdenk
4409c609719bSwdenk
4410c609719bSwdenkIf the system board that you have is not listed, then you will need
4411c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these
4412c609719bSwdenksteps:
4413c609719bSwdenk
4414c609719bSwdenk1.  Add a new configuration option for your board to the toplevel
44154d675ae6SMichael Jones    "boards.cfg" file, using the existing entries as examples.
44164d675ae6SMichael Jones    Follow the instructions there to keep the boards in order.
4417c609719bSwdenk2.  Create a new directory to hold your board specific code. Add any
441885ec0bccSwdenk    files you need. In your board directory, you will need at least
441985ec0bccSwdenk    the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
442085ec0bccSwdenk3.  Create a new configuration file "include/configs/<board>.h" for
442185ec0bccSwdenk    your board
4422c609719bSwdenk3.  If you're porting U-Boot to a new CPU, then also create a new
4423c609719bSwdenk    directory to hold your CPU specific code. Add any files you need.
442485ec0bccSwdenk4.  Run "make <board>_config" with your new name.
4425c609719bSwdenk5.  Type "make", and you should get a working "u-boot.srec" file
4426c609719bSwdenk    to be installed on your target system.
442785ec0bccSwdenk6.  Debug and solve any problems that might arise.
4428c609719bSwdenk    [Of course, this last step is much harder than it sounds.]
4429c609719bSwdenk
4430c609719bSwdenk
4431c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.:
4432c609719bSwdenk==============================================================
4433c609719bSwdenk
4434c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board
4435c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to
4436c609719bSwdenkprovide feedback to the other developers. The feedback normally takes
4437c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest
4438218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources.
4439c609719bSwdenk
4440c609719bSwdenkBut before you submit such a patch, please verify that your modifi-
4441c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of
4442c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so,
4443c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot
4444c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You can
44457152b1d0Swdenkselect which (cross) compiler to use by passing a `CROSS_COMPILE'
4446218ca724SWolfgang Denkenvironment variable to the script, i. e. to use the ELDK cross tools
4447218ca724SWolfgang Denkyou can type
4448c609719bSwdenk
4449c609719bSwdenk	CROSS_COMPILE=ppc_8xx- MAKEALL
4450c609719bSwdenk
4451c609719bSwdenkor to build on a native PowerPC system you can type
4452c609719bSwdenk
4453c609719bSwdenk	CROSS_COMPILE=' ' MAKEALL
4454c609719bSwdenk
4455218ca724SWolfgang DenkWhen using the MAKEALL script, the default behaviour is to build
4456218ca724SWolfgang DenkU-Boot in the source directory. This location can be changed by
4457218ca724SWolfgang Denksetting the BUILD_DIR environment variable. Also, for each target
4458218ca724SWolfgang Denkbuilt, the MAKEALL script saves two log files (<target>.ERR and
4459218ca724SWolfgang Denk<target>.MAKEALL) in the <source dir>/LOG directory. This default
4460218ca724SWolfgang Denklocation can be changed by setting the MAKEALL_LOGDIR environment
4461218ca724SWolfgang Denkvariable. For example:
4462baf31249SMarian Balakowicz
4463baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
4464baf31249SMarian Balakowicz	export MAKEALL_LOGDIR=/tmp/log
4465baf31249SMarian Balakowicz	CROSS_COMPILE=ppc_8xx- MAKEALL
4466baf31249SMarian Balakowicz
4467218ca724SWolfgang DenkWith the above settings build objects are saved in the /tmp/build,
4468218ca724SWolfgang Denklog files are saved in the /tmp/log and the source tree remains clean
4469218ca724SWolfgang Denkduring the whole build process.
4470baf31249SMarian Balakowicz
4471baf31249SMarian Balakowicz
4472c609719bSwdenkSee also "U-Boot Porting Guide" below.
4473c609719bSwdenk
4474c609719bSwdenk
4475c609719bSwdenkMonitor Commands - Overview:
4476c609719bSwdenk============================
4477c609719bSwdenk
4478c609719bSwdenkgo	- start application at address 'addr'
4479c609719bSwdenkrun	- run commands in an environment variable
4480c609719bSwdenkbootm	- boot application image from memory
4481c609719bSwdenkbootp	- boot image via network using BootP/TFTP protocol
448244f074c7SMarek Vasutbootz   - boot zImage from memory
4483c609719bSwdenktftpboot- boot image via network using TFTP protocol
4484c609719bSwdenk	       and env variables "ipaddr" and "serverip"
4485c609719bSwdenk	       (and eventually "gatewayip")
44861fb7cd49SSimon Glasstftpput - upload a file via network using TFTP protocol
4487c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol
4488c609719bSwdenkdiskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
4489c609719bSwdenkloads	- load S-Record file over serial line
4490c609719bSwdenkloadb	- load binary file over serial line (kermit mode)
4491c609719bSwdenkmd	- memory display
4492c609719bSwdenkmm	- memory modify (auto-incrementing)
4493c609719bSwdenknm	- memory modify (constant address)
4494c609719bSwdenkmw	- memory write (fill)
4495c609719bSwdenkcp	- memory copy
4496c609719bSwdenkcmp	- memory compare
4497c609719bSwdenkcrc32	- checksum calculation
44980f89c54bSPeter Tyseri2c	- I2C sub-system
4499c609719bSwdenksspi	- SPI utility commands
4500c609719bSwdenkbase	- print or set address offset
4501c609719bSwdenkprintenv- print environment variables
4502c609719bSwdenksetenv	- set environment variables
4503c609719bSwdenksaveenv - save environment variables to persistent storage
4504c609719bSwdenkprotect - enable or disable FLASH write protection
4505c609719bSwdenkerase	- erase FLASH memory
4506c609719bSwdenkflinfo	- print FLASH memory information
450710635afaSKarl O. Pincnand	- NAND memory operations (see doc/README.nand)
4508c609719bSwdenkbdinfo	- print Board Info structure
4509c609719bSwdenkiminfo	- print header information for application image
4510c609719bSwdenkconinfo - print console devices and informations
4511c609719bSwdenkide	- IDE sub-system
4512c609719bSwdenkloop	- infinite loop on address range
451356523f12Swdenkloopw	- infinite write loop on address range
4514c609719bSwdenkmtest	- simple RAM test
4515c609719bSwdenkicache	- enable or disable instruction cache
4516c609719bSwdenkdcache	- enable or disable data cache
4517c609719bSwdenkreset	- Perform RESET of the CPU
4518c609719bSwdenkecho	- echo args to console
4519c609719bSwdenkversion - print monitor version
4520c609719bSwdenkhelp	- print online help
4521c609719bSwdenk?	- alias for 'help'
4522c609719bSwdenk
4523c609719bSwdenk
4524c609719bSwdenkMonitor Commands - Detailed Description:
4525c609719bSwdenk========================================
4526c609719bSwdenk
4527c609719bSwdenkTODO.
4528c609719bSwdenk
4529c609719bSwdenkFor now: just type "help <command>".
4530c609719bSwdenk
4531c609719bSwdenk
4532c609719bSwdenkEnvironment Variables:
4533c609719bSwdenk======================
4534c609719bSwdenk
4535c609719bSwdenkU-Boot supports user configuration using Environment Variables which
4536c609719bSwdenkcan be made persistent by saving to Flash memory.
4537c609719bSwdenk
4538c609719bSwdenkEnvironment Variables are set using "setenv", printed using
4539c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv"
4540c609719bSwdenkwithout a value can be used to delete a variable from the
4541c609719bSwdenkenvironment. As long as you don't save the environment you are
4542c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the
4543c609719bSwdenkenvironment is erased by accident, a default environment is provided.
4544c609719bSwdenk
4545c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables.
4546c96f86eeSWolfgang Denk
4547c96f86eeSWolfgang DenkList of environment variables (most likely not complete):
4548c609719bSwdenk
4549c609719bSwdenk  baudrate	- see CONFIG_BAUDRATE
4550c609719bSwdenk
4551c609719bSwdenk  bootdelay	- see CONFIG_BOOTDELAY
4552c609719bSwdenk
4553c609719bSwdenk  bootcmd	- see CONFIG_BOOTCOMMAND
4554c609719bSwdenk
4555c609719bSwdenk  bootargs	- Boot arguments when booting an RTOS image
4556c609719bSwdenk
4557c609719bSwdenk  bootfile	- Name of the image to load with TFTP
4558c609719bSwdenk
45597d721e34SBartlomiej Sieka  bootm_low	- Memory range available for image processing in the bootm
45607d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
45617d721e34SBartlomiej Sieka		  a hexadecimal number and defines lowest address allowed
45627d721e34SBartlomiej Sieka		  for use by the bootm command. See also "bootm_size"
45637d721e34SBartlomiej Sieka		  environment variable. Address defined by "bootm_low" is
45647d721e34SBartlomiej Sieka		  also the base of the initial memory mapping for the Linux
4565c3624e6eSGrant Likely		  kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4566c3624e6eSGrant Likely		  bootm_mapsize.
4567c3624e6eSGrant Likely
4568c3624e6eSGrant Likely  bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
4569c3624e6eSGrant Likely		  This variable is given as a hexadecimal number and it
4570c3624e6eSGrant Likely		  defines the size of the memory region starting at base
4571c3624e6eSGrant Likely		  address bootm_low that is accessible by the Linux kernel
4572c3624e6eSGrant Likely		  during early boot.  If unset, CONFIG_SYS_BOOTMAPSZ is used
4573c3624e6eSGrant Likely		  as the default value if it is defined, and bootm_size is
4574c3624e6eSGrant Likely		  used otherwise.
45757d721e34SBartlomiej Sieka
45767d721e34SBartlomiej Sieka  bootm_size	- Memory range available for image processing in the bootm
45777d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
45787d721e34SBartlomiej Sieka		  a hexadecimal number and defines the size of the region
45797d721e34SBartlomiej Sieka		  allowed for use by the bootm command. See also "bootm_low"
45807d721e34SBartlomiej Sieka		  environment variable.
45817d721e34SBartlomiej Sieka
45824bae9090SBartlomiej Sieka  updatefile	- Location of the software update file on a TFTP server, used
45834bae9090SBartlomiej Sieka		  by the automatic software update feature. Please refer to
45844bae9090SBartlomiej Sieka		  documentation in doc/README.update for more details.
45854bae9090SBartlomiej Sieka
4586c609719bSwdenk  autoload	- if set to "no" (any string beginning with 'n'),
4587c609719bSwdenk		  "bootp" will just load perform a lookup of the
4588c609719bSwdenk		  configuration from the BOOTP server, but not try to
4589c609719bSwdenk		  load any image using TFTP
4590c609719bSwdenk
4591c609719bSwdenk  autostart	- if set to "yes", an image loaded using the "bootp",
4592c609719bSwdenk		  "rarpboot", "tftpboot" or "diskboot" commands will
4593c609719bSwdenk		  be automatically started (by internally calling
4594c609719bSwdenk		  "bootm")
4595c609719bSwdenk
45964a6fd34bSwdenk		  If set to "no", a standalone image passed to the
45974a6fd34bSwdenk		  "bootm" command will be copied to the load address
45984a6fd34bSwdenk		  (and eventually uncompressed), but NOT be started.
45994a6fd34bSwdenk		  This can be used to load and uncompress arbitrary
46004a6fd34bSwdenk		  data.
46014a6fd34bSwdenk
4602a28afca5SDavid A. Long  fdt_high	- if set this restricts the maximum address that the
4603a28afca5SDavid A. Long		  flattened device tree will be copied into upon boot.
4604fa34f6b2SShawn Guo		  For example, if you have a system with 1 GB memory
4605fa34f6b2SShawn Guo		  at physical address 0x10000000, while Linux kernel
4606fa34f6b2SShawn Guo		  only recognizes the first 704 MB as low memory, you
4607fa34f6b2SShawn Guo		  may need to set fdt_high as 0x3C000000 to have the
4608fa34f6b2SShawn Guo		  device tree blob be copied to the maximum address
4609fa34f6b2SShawn Guo		  of the 704 MB low memory, so that Linux kernel can
4610fa34f6b2SShawn Guo		  access it during the boot procedure.
4611fa34f6b2SShawn Guo
4612a28afca5SDavid A. Long		  If this is set to the special value 0xFFFFFFFF then
4613a28afca5SDavid A. Long		  the fdt will not be copied at all on boot.  For this
4614a28afca5SDavid A. Long		  to work it must reside in writable memory, have
4615a28afca5SDavid A. Long		  sufficient padding on the end of it for u-boot to
4616a28afca5SDavid A. Long		  add the information it needs into it, and the memory
4617a28afca5SDavid A. Long		  must be accessible by the kernel.
4618a28afca5SDavid A. Long
4619eea63e05SSimon Glass  fdtcontroladdr- if set this is the address of the control flattened
4620eea63e05SSimon Glass		  device tree used by U-Boot when CONFIG_OF_CONTROL is
4621eea63e05SSimon Glass		  defined.
4622eea63e05SSimon Glass
462317ea1177Swdenk  i2cfast	- (PPC405GP|PPC405EP only)
462417ea1177Swdenk		  if set to 'y' configures Linux I2C driver for fast
462517ea1177Swdenk		  mode (400kHZ). This environment variable is used in
462617ea1177Swdenk		  initialization code. So, for changes to be effective
462717ea1177Swdenk		  it must be saved and board must be reset.
462817ea1177Swdenk
4629c609719bSwdenk  initrd_high	- restrict positioning of initrd images:
4630c609719bSwdenk		  If this variable is not set, initrd images will be
4631c609719bSwdenk		  copied to the highest possible address in RAM; this
4632c609719bSwdenk		  is usually what you want since it allows for
4633c609719bSwdenk		  maximum initrd size. If for some reason you want to
4634c609719bSwdenk		  make sure that the initrd image is loaded below the
46356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		  CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
4636c609719bSwdenk		  variable to a value of "no" or "off" or "0".
4637c609719bSwdenk		  Alternatively, you can set it to a maximum upper
4638c609719bSwdenk		  address to use (U-Boot will still check that it
4639c609719bSwdenk		  does not overwrite the U-Boot stack and data).
4640c609719bSwdenk
4641c609719bSwdenk		  For instance, when you have a system with 16 MB
46427152b1d0Swdenk		  RAM, and want to reserve 4 MB from use by Linux,
4643c609719bSwdenk		  you can do this by adding "mem=12M" to the value of
4644c609719bSwdenk		  the "bootargs" variable. However, now you must make
46457152b1d0Swdenk		  sure that the initrd image is placed in the first
4646c609719bSwdenk		  12 MB as well - this can be done with
4647c609719bSwdenk
4648c609719bSwdenk		  setenv initrd_high 00c00000
4649c609719bSwdenk
465038b99261Swdenk		  If you set initrd_high to 0xFFFFFFFF, this is an
465138b99261Swdenk		  indication to U-Boot that all addresses are legal
465238b99261Swdenk		  for the Linux kernel, including addresses in flash
465338b99261Swdenk		  memory. In this case U-Boot will NOT COPY the
465438b99261Swdenk		  ramdisk at all. This may be useful to reduce the
465538b99261Swdenk		  boot time on your system, but requires that this
465638b99261Swdenk		  feature is supported by your Linux kernel.
465738b99261Swdenk
4658c609719bSwdenk  ipaddr	- IP address; needed for tftpboot command
4659c609719bSwdenk
4660c609719bSwdenk  loadaddr	- Default load address for commands like "bootp",
4661dc7c9a1aSwdenk		  "rarpboot", "tftpboot", "loadb" or "diskboot"
4662c609719bSwdenk
4663c609719bSwdenk  loads_echo	- see CONFIG_LOADS_ECHO
4664c609719bSwdenk
4665c609719bSwdenk  serverip	- TFTP server IP address; needed for tftpboot command
4666c609719bSwdenk
4667c609719bSwdenk  bootretry	- see CONFIG_BOOT_RETRY_TIME
4668c609719bSwdenk
4669c609719bSwdenk  bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
4670c609719bSwdenk
4671c609719bSwdenk  bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
4672c609719bSwdenk
4673e2a53458SMike Frysinger  ethprime	- controls which interface is used first.
4674a3d991bdSwdenk
4675e2a53458SMike Frysinger  ethact	- controls which interface is currently active.
4676e2a53458SMike Frysinger		  For example you can do the following
4677a3d991bdSwdenk
467848690d80SHeiko Schocher		  => setenv ethact FEC
467948690d80SHeiko Schocher		  => ping 192.168.0.1 # traffic sent on FEC
468048690d80SHeiko Schocher		  => setenv ethact SCC
468148690d80SHeiko Schocher		  => ping 10.0.0.1 # traffic sent on SCC
4682a3d991bdSwdenk
4683e1692577SMatthias Fuchs  ethrotate	- When set to "no" U-Boot does not go through all
4684e1692577SMatthias Fuchs		  available network interfaces.
4685e1692577SMatthias Fuchs		  It just stays at the currently selected interface.
4686e1692577SMatthias Fuchs
4687a3d991bdSwdenk  netretry	- When set to "no" each network operation will
4688a3d991bdSwdenk		  either succeed or fail without retrying.
46896e592385Swdenk		  When set to "once" the network operation will
46906e592385Swdenk		  fail when all the available network interfaces
46916e592385Swdenk		  are tried once without success.
4692a3d991bdSwdenk		  Useful on scripts which control the retry operation
4693a3d991bdSwdenk		  themselves.
4694a3d991bdSwdenk
4695b4e2f89dSJean-Christophe PLAGNIOL-VILLARD  npe_ucode	- set load address for the NPE microcode
4696a1cf027aSJean-Christophe PLAGNIOL-VILLARD
46978d51aacdSSimon Glass  silent_linux  - If set then linux will be told to boot silently, by
46988d51aacdSSimon Glass		  changing the console to be empty. If "yes" it will be
46998d51aacdSSimon Glass		  made silent. If "no" it will not be made silent. If
47008d51aacdSSimon Glass		  unset, then it will be made silent if the U-Boot console
47018d51aacdSSimon Glass		  is silent.
47028d51aacdSSimon Glass
470328cb9375SWolfgang Denk  tftpsrcport	- If this is set, the value is used for TFTP's
4704ecb0ccd9SWolfgang Denk		  UDP source port.
4705ecb0ccd9SWolfgang Denk
470628cb9375SWolfgang Denk  tftpdstport	- If this is set, the value is used for TFTP's UDP
470728cb9375SWolfgang Denk		  destination port instead of the Well Know Port 69.
470828cb9375SWolfgang Denk
4709c96f86eeSWolfgang Denk  tftpblocksize - Block size to use for TFTP transfers; if not set,
4710c96f86eeSWolfgang Denk		  we use the TFTP server's default block size
4711c96f86eeSWolfgang Denk
4712c96f86eeSWolfgang Denk  tftptimeout	- Retransmission timeout for TFTP packets (in milli-
4713c96f86eeSWolfgang Denk		  seconds, minimum value is 1000 = 1 second). Defines
4714c96f86eeSWolfgang Denk		  when a packet is considered to be lost so it has to
4715c96f86eeSWolfgang Denk		  be retransmitted. The default is 5000 = 5 seconds.
4716c96f86eeSWolfgang Denk		  Lowering this value may make downloads succeed
4717c96f86eeSWolfgang Denk		  faster in networks with high packet loss rates or
4718c96f86eeSWolfgang Denk		  with unreliable TFTP servers.
4719c96f86eeSWolfgang Denk
4720a3d991bdSwdenk  vlan		- When set to a value < 4095 the traffic over
472111ccc33fSMarcel Ziswiler		  Ethernet is encapsulated/received over 802.1q
4722a3d991bdSwdenk		  VLAN tagged frames.
4723c609719bSwdenk
4724dc0b7b0eSJason HobbsThe following image location variables contain the location of images
4725dc0b7b0eSJason Hobbsused in booting. The "Image" column gives the role of the image and is
4726dc0b7b0eSJason Hobbsnot an environment variable name. The other columns are environment
4727dc0b7b0eSJason Hobbsvariable names. "File Name" gives the name of the file on a TFTP
4728dc0b7b0eSJason Hobbsserver, "RAM Address" gives the location in RAM the image will be
4729dc0b7b0eSJason Hobbsloaded to, and "Flash Location" gives the image's address in NOR
4730dc0b7b0eSJason Hobbsflash or offset in NAND flash.
4731dc0b7b0eSJason Hobbs
4732dc0b7b0eSJason Hobbs*Note* - these variables don't have to be defined for all boards, some
4733dc0b7b0eSJason Hobbsboards currenlty use other variables for these purposes, and some
4734dc0b7b0eSJason Hobbsboards use these variables for other purposes.
4735dc0b7b0eSJason Hobbs
4736dc0b7b0eSJason HobbsImage		    File Name	     RAM Address       Flash Location
4737dc0b7b0eSJason Hobbs-----		    ---------	     -----------       --------------
4738dc0b7b0eSJason Hobbsu-boot		    u-boot	     u-boot_addr_r     u-boot_addr
4739dc0b7b0eSJason HobbsLinux kernel	    bootfile	     kernel_addr_r     kernel_addr
4740dc0b7b0eSJason Hobbsdevice tree blob    fdtfile	     fdt_addr_r	       fdt_addr
4741dc0b7b0eSJason Hobbsramdisk		    ramdiskfile	     ramdisk_addr_r    ramdisk_addr
4742dc0b7b0eSJason Hobbs
4743c609719bSwdenkThe following environment variables may be used and automatically
4744c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"),
4745c609719bSwdenkdepending the information provided by your boot server:
4746c609719bSwdenk
4747c609719bSwdenk  bootfile	- see above
4748c609719bSwdenk  dnsip		- IP address of your Domain Name Server
4749fe389a82Sstroese  dnsip2	- IP address of your secondary Domain Name Server
4750c609719bSwdenk  gatewayip	- IP address of the Gateway (Router) to use
4751c609719bSwdenk  hostname	- Target hostname
4752c609719bSwdenk  ipaddr	- see above
4753c609719bSwdenk  netmask	- Subnet Mask
4754c609719bSwdenk  rootpath	- Pathname of the root filesystem on the NFS server
4755c609719bSwdenk  serverip	- see above
4756c609719bSwdenk
4757c609719bSwdenk
4758c609719bSwdenkThere are two special Environment Variables:
4759c609719bSwdenk
4760c609719bSwdenk  serial#	- contains hardware identification information such
4761c609719bSwdenk		  as type string and/or serial number
4762c609719bSwdenk  ethaddr	- Ethernet address
4763c609719bSwdenk
4764c609719bSwdenkThese variables can be set only once (usually during manufacturing of
4765c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables
4766c609719bSwdenkonce they have been set once.
4767c609719bSwdenk
4768c609719bSwdenk
4769c1551ea8SstroeseFurther special Environment Variables:
4770c1551ea8Sstroese
4771c1551ea8Sstroese  ver		- Contains the U-Boot version string as printed
4772c1551ea8Sstroese		  with the "version" command. This variable is
4773c1551ea8Sstroese		  readonly (see CONFIG_VERSION_VARIABLE).
4774c1551ea8Sstroese
4775c1551ea8Sstroese
4776c609719bSwdenkPlease note that changes to some configuration parameters may take
4777c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-).
4778c609719bSwdenk
4779c609719bSwdenk
4780170ab110SJoe HershbergerCallback functions for environment variables:
4781170ab110SJoe Hershberger---------------------------------------------
4782170ab110SJoe Hershberger
4783170ab110SJoe HershbergerFor some environment variables, the behavior of u-boot needs to change
4784170ab110SJoe Hershbergerwhen their values are changed.  This functionailty allows functions to
4785170ab110SJoe Hershbergerbe associated with arbitrary variables.  On creation, overwrite, or
4786170ab110SJoe Hershbergerdeletion, the callback will provide the opportunity for some side
4787170ab110SJoe Hershbergereffect to happen or for the change to be rejected.
4788170ab110SJoe Hershberger
4789170ab110SJoe HershbergerThe callbacks are named and associated with a function using the
4790170ab110SJoe HershbergerU_BOOT_ENV_CALLBACK macro in your board or driver code.
4791170ab110SJoe Hershberger
4792170ab110SJoe HershbergerThese callbacks are associated with variables in one of two ways.  The
4793170ab110SJoe Hershbergerstatic list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
4794170ab110SJoe Hershbergerin the board configuration to a string that defines a list of
4795170ab110SJoe Hershbergerassociations.  The list must be in the following format:
4796170ab110SJoe Hershberger
4797170ab110SJoe Hershberger	entry = variable_name[:callback_name]
4798170ab110SJoe Hershberger	list = entry[,list]
4799170ab110SJoe Hershberger
4800170ab110SJoe HershbergerIf the callback name is not specified, then the callback is deleted.
4801170ab110SJoe HershbergerSpaces are also allowed anywhere in the list.
4802170ab110SJoe Hershberger
4803170ab110SJoe HershbergerCallbacks can also be associated by defining the ".callbacks" variable
4804170ab110SJoe Hershbergerwith the same list format above.  Any association in ".callbacks" will
4805170ab110SJoe Hershbergeroverride any association in the static list. You can define
4806170ab110SJoe HershbergerCONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
4807170ab110SJoe Hershberger".callbacks" envirnoment variable in the default or embedded environment.
4808170ab110SJoe Hershberger
4809170ab110SJoe Hershberger
4810f07771ccSwdenkCommand Line Parsing:
4811f07771ccSwdenk=====================
4812f07771ccSwdenk
4813f07771ccSwdenkThere are two different command line parsers available with U-Boot:
48147152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell:
4815f07771ccSwdenk
4816f07771ccSwdenkOld, simple command line parser:
4817f07771ccSwdenk--------------------------------
4818f07771ccSwdenk
4819f07771ccSwdenk- supports environment variables (through setenv / saveenv commands)
4820f07771ccSwdenk- several commands on one line, separated by ';'
4821fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax
4822f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\',
4823f07771ccSwdenk  for example:
4824fe126d8bSWolfgang Denk	setenv bootcmd bootm \${address}
4825f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example:
4826f07771ccSwdenk	setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
4827f07771ccSwdenk
4828f07771ccSwdenkHush shell:
4829f07771ccSwdenk-----------
4830f07771ccSwdenk
4831f07771ccSwdenk- similar to Bourne shell, with control structures like
4832f07771ccSwdenk  if...then...else...fi, for...do...done; while...do...done,
4833f07771ccSwdenk  until...do...done, ...
4834f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv
4835f07771ccSwdenk  commands) and local shell variables (through standard shell syntax
4836f07771ccSwdenk  "name=value"); only environment variables can be used with "run"
4837f07771ccSwdenk  command
4838f07771ccSwdenk
4839f07771ccSwdenkGeneral rules:
4840f07771ccSwdenk--------------
4841f07771ccSwdenk
4842f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run"
4843f07771ccSwdenk    command) contains several commands separated by semicolon, and
4844f07771ccSwdenk    one of these commands fails, then the remaining commands will be
4845f07771ccSwdenk    executed anyway.
4846f07771ccSwdenk
4847f07771ccSwdenk(2) If you execute several variables with one call to run (i. e.
484811ccc33fSMarcel Ziswiler    calling run with a list of variables as arguments), any failing
4849f07771ccSwdenk    command will cause "run" to terminate, i. e. the remaining
4850f07771ccSwdenk    variables are not executed.
4851f07771ccSwdenk
4852c609719bSwdenkNote for Redundant Ethernet Interfaces:
4853c609719bSwdenk=======================================
4854c609719bSwdenk
485511ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports
4856c609719bSwdenksuch configurations and is capable of automatic selection of a
48577152b1d0Swdenk"working" interface when needed. MAC assignment works as follows:
4858c609719bSwdenk
4859c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding
4860c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0),
4861c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ...
4862c609719bSwdenk
4863c609719bSwdenkIf the network interface stores some valid MAC address (for instance
4864c609719bSwdenkin SROM), this is used as default address if there is NO correspon-
4865c609719bSwdenkding setting in the environment; if the corresponding environment
4866c609719bSwdenkvariable is set, this overrides the settings in the card; that means:
4867c609719bSwdenk
4868c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the
4869c609719bSwdenk  environment, the SROM's address is used.
4870c609719bSwdenk
4871c609719bSwdenko If there is no valid address in the SROM, and a definition in the
4872c609719bSwdenk  environment exists, then the value from the environment variable is
4873c609719bSwdenk  used.
4874c609719bSwdenk
4875c609719bSwdenko If both the SROM and the environment contain a MAC address, and
4876c609719bSwdenk  both addresses are the same, this MAC address is used.
4877c609719bSwdenk
4878c609719bSwdenko If both the SROM and the environment contain a MAC address, and the
4879c609719bSwdenk  addresses differ, the value from the environment is used and a
4880c609719bSwdenk  warning is printed.
4881c609719bSwdenk
4882c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error
4883c609719bSwdenk  is raised.
4884c609719bSwdenk
4885ecee9324SBen WarrenIf Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
4886ecee9324SBen Warrenwill be programmed into hardware as part of the initialization process.	 This
4887ecee9324SBen Warrenmay be skipped by setting the appropriate 'ethmacskip' environment variable.
4888ecee9324SBen WarrenThe naming convention is as follows:
4889ecee9324SBen Warren"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
4890c609719bSwdenk
4891c609719bSwdenkImage Formats:
4892c609719bSwdenk==============
4893c609719bSwdenk
48943310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on)
48953310c549SMarian Balakowiczimages in two formats:
48963310c549SMarian Balakowicz
48973310c549SMarian BalakowiczNew uImage format (FIT)
48983310c549SMarian Balakowicz-----------------------
48993310c549SMarian Balakowicz
49003310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar
49013310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple
49023310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by
49033310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
49043310c549SMarian Balakowicz
49053310c549SMarian Balakowicz
49063310c549SMarian BalakowiczOld uImage format
49073310c549SMarian Balakowicz-----------------
49083310c549SMarian Balakowicz
49093310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything,
49103310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for
49113310c549SMarian Balakowiczdetails; basically, the header defines the following image properties:
4912c609719bSwdenk
4913c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
4914c609719bSwdenk  4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
4915f5ed9e39SPeter Tyser  LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
4916f5ed9e39SPeter Tyser  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
4917f5ed9e39SPeter Tyser  INTEGRITY).
49187b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
4919afc1ce82SMacpaul Lin  IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
4920afc1ce82SMacpaul Lin  Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
4921c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2)
4922c609719bSwdenk* Load Address
4923c609719bSwdenk* Entry Point
4924c609719bSwdenk* Image Name
4925c609719bSwdenk* Image Timestamp
4926c609719bSwdenk
4927c609719bSwdenkThe header is marked by a special Magic Number, and both the header
4928c609719bSwdenkand the data portions of the image are secured against corruption by
4929c609719bSwdenkCRC32 checksums.
4930c609719bSwdenk
4931c609719bSwdenk
4932c609719bSwdenkLinux Support:
4933c609719bSwdenk==============
4934c609719bSwdenk
4935c609719bSwdenkAlthough U-Boot should support any OS or standalone application
49367152b1d0Swdenkeasily, the main focus has always been on Linux during the design of
4937c609719bSwdenkU-Boot.
4938c609719bSwdenk
4939c609719bSwdenkU-Boot includes many features that so far have been part of some
4940c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any
4941c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image;
4942c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation
49437152b1d0Swdenkserves several purposes:
4944c609719bSwdenk
4945c609719bSwdenk- the same features can be used for other OS or standalone
4946c609719bSwdenk  applications (for instance: using compressed images to reduce the
4947c609719bSwdenk  Flash memory footprint)
4948c609719bSwdenk
4949c609719bSwdenk- it becomes much easier to port new Linux kernel versions because
49507152b1d0Swdenk  lots of low-level, hardware dependent stuff are done by U-Boot
4951c609719bSwdenk
4952c609719bSwdenk- the same Linux kernel image can now be used with different "initrd"
4953c609719bSwdenk  images; of course this also means that different kernel images can
4954c609719bSwdenk  be run with the same "initrd". This makes testing easier (you don't
4955c609719bSwdenk  have to build a new "zImage.initrd" Linux image when you just
4956c609719bSwdenk  change a file in your "initrd"). Also, a field-upgrade of the
4957c609719bSwdenk  software is easier now.
4958c609719bSwdenk
4959c609719bSwdenk
4960c609719bSwdenkLinux HOWTO:
4961c609719bSwdenk============
4962c609719bSwdenk
4963c609719bSwdenkPorting Linux to U-Boot based systems:
4964c609719bSwdenk---------------------------------------
4965c609719bSwdenk
4966c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to
4967c609719bSwdenkconfigure the Linux device drivers for use with your target hardware
4968c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to
4969c609719bSwdenkLinux :-).
4970c609719bSwdenk
4971a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
4972c609719bSwdenk
4973c609719bSwdenkJust make sure your machine specific header file (for instance
4974c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board
49751dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h,
49761dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value
49776d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR.
4978c609719bSwdenk
4979c609719bSwdenk
4980c609719bSwdenkConfiguring the Linux kernel:
4981c609719bSwdenk-----------------------------
4982c609719bSwdenk
4983c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root
4984c609719bSwdenkdevice (initial ramdisk, NFS) for your target system.
4985c609719bSwdenk
4986c609719bSwdenk
4987c609719bSwdenkBuilding a Linux Image:
4988c609719bSwdenk-----------------------
4989c609719bSwdenk
499024ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are
499124ee89b9Swdenknot used. If you use recent kernel source, a new build target
499224ee89b9Swdenk"uImage" will exist which automatically builds an image usable by
499324ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target,
499424ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a
499524ee89b9Swdenk100% compatible format.
4996c609719bSwdenk
4997c609719bSwdenkExample:
4998c609719bSwdenk
4999c609719bSwdenk	make TQM850L_config
5000c609719bSwdenk	make oldconfig
5001c609719bSwdenk	make dep
500224ee89b9Swdenk	make uImage
5003c609719bSwdenk
500424ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to
500524ee89b9Swdenkencapsulate a compressed Linux kernel image with header	 information,
500624ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing:
5007c609719bSwdenk
500824ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format):
500924ee89b9Swdenk
501024ee89b9Swdenk* convert the kernel into a raw binary image:
501124ee89b9Swdenk
501224ee89b9Swdenk	${CROSS_COMPILE}-objcopy -O binary \
501324ee89b9Swdenk				 -R .note -R .comment \
501424ee89b9Swdenk				 -S vmlinux linux.bin
501524ee89b9Swdenk
501624ee89b9Swdenk* compress the binary image:
501724ee89b9Swdenk
501824ee89b9Swdenk	gzip -9 linux.bin
501924ee89b9Swdenk
502024ee89b9Swdenk* package compressed binary image for U-Boot:
502124ee89b9Swdenk
502224ee89b9Swdenk	mkimage -A ppc -O linux -T kernel -C gzip \
502324ee89b9Swdenk		-a 0 -e 0 -n "Linux Kernel Image" \
502424ee89b9Swdenk		-d linux.bin.gz uImage
502524ee89b9Swdenk
502624ee89b9Swdenk
502724ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use
502824ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or
502924ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64
503024ee89b9Swdenkbyte header containing information about target architecture,
503124ee89b9Swdenkoperating system, image type, compression method, entry points, time
503224ee89b9Swdenkstamp, CRC32 checksums, etc.
503324ee89b9Swdenk
503424ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and
503524ee89b9Swdenkprint the header information, or to build new images.
5036c609719bSwdenk
5037c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information
5038c609719bSwdenkcontained in the header of an existing U-Boot image; this includes
5039c609719bSwdenkchecksum verification:
5040c609719bSwdenk
5041c609719bSwdenk	tools/mkimage -l image
5042c609719bSwdenk	  -l ==> list image header information
5043c609719bSwdenk
5044c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image
5045c609719bSwdenkfrom a "data file" which is used as image payload:
5046c609719bSwdenk
5047c609719bSwdenk	tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5048c609719bSwdenk		      -n name -d data_file image
5049c609719bSwdenk	  -A ==> set architecture to 'arch'
5050c609719bSwdenk	  -O ==> set operating system to 'os'
5051c609719bSwdenk	  -T ==> set image type to 'type'
5052c609719bSwdenk	  -C ==> set compression type 'comp'
5053c609719bSwdenk	  -a ==> set load address to 'addr' (hex)
5054c609719bSwdenk	  -e ==> set entry point to 'ep' (hex)
5055c609719bSwdenk	  -n ==> set image name to 'name'
5056c609719bSwdenk	  -d ==> use image data from 'datafile'
5057c609719bSwdenk
505869459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load
505969459791Swdenkaddress (0x00000000), but the entry point address depends on the
506069459791Swdenkkernel version:
5061c609719bSwdenk
5062c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C,
506324ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000.
5064c609719bSwdenk
5065c609719bSwdenkSo a typical call to build a U-Boot image would read:
5066c609719bSwdenk
506724ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
506824ee89b9Swdenk	> -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
5069a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
507024ee89b9Swdenk	> examples/uImage.TQM850L
507124ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5072c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5073c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
5074c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
5075c609719bSwdenk	Load Address: 0x00000000
507624ee89b9Swdenk	Entry Point:  0x00000000
5077c609719bSwdenk
5078c609719bSwdenkTo verify the contents of the image (or check for corruption):
5079c609719bSwdenk
508024ee89b9Swdenk	-> tools/mkimage -l examples/uImage.TQM850L
508124ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5082c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5083c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
5084c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
5085c609719bSwdenk	Load Address: 0x00000000
508624ee89b9Swdenk	Entry Point:  0x00000000
5087c609719bSwdenk
5088c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade
5089c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this
5090c609719bSwdenkneeds more space in Flash, but boots much faster since it does not
5091c609719bSwdenkneed to be uncompressed:
5092c609719bSwdenk
5093a47a12beSStefan Roese	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
509424ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
509524ee89b9Swdenk	> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
5096a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
509724ee89b9Swdenk	> examples/uImage.TQM850L-uncompressed
509824ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5099c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5100c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (uncompressed)
5101c609719bSwdenk	Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
5102c609719bSwdenk	Load Address: 0x00000000
510324ee89b9Swdenk	Entry Point:  0x00000000
5104c609719bSwdenk
5105c609719bSwdenk
5106c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file
5107c609719bSwdenkwhen your kernel is intended to use an initial ramdisk:
5108c609719bSwdenk
5109c609719bSwdenk	-> tools/mkimage -n 'Simple Ramdisk Image' \
5110c609719bSwdenk	> -A ppc -O linux -T ramdisk -C gzip \
5111c609719bSwdenk	> -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5112c609719bSwdenk	Image Name:   Simple Ramdisk Image
5113c609719bSwdenk	Created:      Wed Jan 12 14:01:50 2000
5114c609719bSwdenk	Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
5115c609719bSwdenk	Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
5116c609719bSwdenk	Load Address: 0x00000000
5117c609719bSwdenk	Entry Point:  0x00000000
5118c609719bSwdenk
5119c609719bSwdenk
5120c609719bSwdenkInstalling a Linux Image:
5121c609719bSwdenk-------------------------
5122c609719bSwdenk
5123c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface,
5124c609719bSwdenkyou must convert the image to S-Record format:
5125c609719bSwdenk
5126c609719bSwdenk	objcopy -I binary -O srec examples/image examples/image.srec
5127c609719bSwdenk
5128c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot
5129c609719bSwdenkimage header, so the resulting S-Record file will be relative to
5130c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to
5131c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads'
5132c609719bSwdenkcommand.
5133c609719bSwdenk
5134c609719bSwdenkExample: install the image to address 0x40100000 (which on the
5135c609719bSwdenkTQM8xxL is in the first Flash bank):
5136c609719bSwdenk
5137c609719bSwdenk	=> erase 40100000 401FFFFF
5138c609719bSwdenk
5139c609719bSwdenk	.......... done
5140c609719bSwdenk	Erased 8 sectors
5141c609719bSwdenk
5142c609719bSwdenk	=> loads 40100000
5143c609719bSwdenk	## Ready for S-Record download ...
5144c609719bSwdenk	~>examples/image.srec
5145c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5146c609719bSwdenk	...
5147c609719bSwdenk	15989 15990 15991 15992
5148c609719bSwdenk	[file transfer complete]
5149c609719bSwdenk	[connected]
5150c609719bSwdenk	## Start Addr = 0x00000000
5151c609719bSwdenk
5152c609719bSwdenk
5153c609719bSwdenkYou can check the success of the download using the 'iminfo' command;
5154c609719bSwdenkthis includes a checksum verification so you can be sure no data
5155c609719bSwdenkcorruption happened:
5156c609719bSwdenk
5157c609719bSwdenk	=> imi 40100000
5158c609719bSwdenk
5159c609719bSwdenk	## Checking Image at 40100000 ...
5160c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5161c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5162c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5163c609719bSwdenk	   Load Address: 00000000
5164c609719bSwdenk	   Entry Point:	 0000000c
5165c609719bSwdenk	   Verifying Checksum ... OK
5166c609719bSwdenk
5167c609719bSwdenk
5168c609719bSwdenkBoot Linux:
5169c609719bSwdenk-----------
5170c609719bSwdenk
5171c609719bSwdenkThe "bootm" command is used to boot an application that is stored in
5172c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents
5173c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as
5174c609719bSwdenkparameters. You can check and modify this variable using the
5175c609719bSwdenk"printenv" and "setenv" commands:
5176c609719bSwdenk
5177c609719bSwdenk
5178c609719bSwdenk	=> printenv bootargs
5179c609719bSwdenk	bootargs=root=/dev/ram
5180c609719bSwdenk
5181c609719bSwdenk	=> setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5182c609719bSwdenk
5183c609719bSwdenk	=> printenv bootargs
5184c609719bSwdenk	bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5185c609719bSwdenk
5186c609719bSwdenk	=> bootm 40020000
5187c609719bSwdenk	## Booting Linux kernel at 40020000 ...
5188c609719bSwdenk	   Image Name:	 2.2.13 for NFS on TQM850L
5189c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5190c609719bSwdenk	   Data Size:	 381681 Bytes = 372 kB = 0 MB
5191c609719bSwdenk	   Load Address: 00000000
5192c609719bSwdenk	   Entry Point:	 0000000c
5193c609719bSwdenk	   Verifying Checksum ... OK
5194c609719bSwdenk	   Uncompressing Kernel Image ... OK
5195c609719bSwdenk	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
5196c609719bSwdenk	Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5197c609719bSwdenk	time_init: decrementer frequency = 187500000/60
5198c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
5199c609719bSwdenk	Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5200c609719bSwdenk	...
5201c609719bSwdenk
520211ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass
52037152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT
5204c609719bSwdenkformat!) to the "bootm" command:
5205c609719bSwdenk
5206c609719bSwdenk	=> imi 40100000 40200000
5207c609719bSwdenk
5208c609719bSwdenk	## Checking Image at 40100000 ...
5209c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5210c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5211c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5212c609719bSwdenk	   Load Address: 00000000
5213c609719bSwdenk	   Entry Point:	 0000000c
5214c609719bSwdenk	   Verifying Checksum ... OK
5215c609719bSwdenk
5216c609719bSwdenk	## Checking Image at 40200000 ...
5217c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
5218c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
5219c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
5220c609719bSwdenk	   Load Address: 00000000
5221c609719bSwdenk	   Entry Point:	 00000000
5222c609719bSwdenk	   Verifying Checksum ... OK
5223c609719bSwdenk
5224c609719bSwdenk	=> bootm 40100000 40200000
5225c609719bSwdenk	## Booting Linux kernel at 40100000 ...
5226c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5227c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5228c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5229c609719bSwdenk	   Load Address: 00000000
5230c609719bSwdenk	   Entry Point:	 0000000c
5231c609719bSwdenk	   Verifying Checksum ... OK
5232c609719bSwdenk	   Uncompressing Kernel Image ... OK
5233c609719bSwdenk	## Loading RAMDisk Image at 40200000 ...
5234c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
5235c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
5236c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
5237c609719bSwdenk	   Load Address: 00000000
5238c609719bSwdenk	   Entry Point:	 00000000
5239c609719bSwdenk	   Verifying Checksum ... OK
5240c609719bSwdenk	   Loading Ramdisk ... OK
5241c609719bSwdenk	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
5242c609719bSwdenk	Boot arguments: root=/dev/ram
5243c609719bSwdenk	time_init: decrementer frequency = 187500000/60
5244c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
5245c609719bSwdenk	...
5246c609719bSwdenk	RAMDISK: Compressed image found at block 0
5247c609719bSwdenk	VFS: Mounted root (ext2 filesystem).
5248c609719bSwdenk
5249c609719bSwdenk	bash#
5250c609719bSwdenk
52510267768eSMatthew McClintockBoot Linux and pass a flat device tree:
52520267768eSMatthew McClintock-----------
52530267768eSMatthew McClintock
52540267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section
52550267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The
52560267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated
52570267768eSMatthew McClintockflat device tree:
52580267768eSMatthew McClintock
52590267768eSMatthew McClintock=> print oftaddr
52600267768eSMatthew McClintockoftaddr=0x300000
52610267768eSMatthew McClintock=> print oft
52620267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb
52630267768eSMatthew McClintock=> tftp $oftaddr $oft
52640267768eSMatthew McClintockSpeed: 1000, full duplex
52650267768eSMatthew McClintockUsing TSEC0 device
52660267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101
52670267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'.
52680267768eSMatthew McClintockLoad address: 0x300000
52690267768eSMatthew McClintockLoading: #
52700267768eSMatthew McClintockdone
52710267768eSMatthew McClintockBytes transferred = 4106 (100a hex)
52720267768eSMatthew McClintock=> tftp $loadaddr $bootfile
52730267768eSMatthew McClintockSpeed: 1000, full duplex
52740267768eSMatthew McClintockUsing TSEC0 device
52750267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2
52760267768eSMatthew McClintockFilename 'uImage'.
52770267768eSMatthew McClintockLoad address: 0x200000
52780267768eSMatthew McClintockLoading:############
52790267768eSMatthew McClintockdone
52800267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex)
52810267768eSMatthew McClintock=> print loadaddr
52820267768eSMatthew McClintockloadaddr=200000
52830267768eSMatthew McClintock=> print oftaddr
52840267768eSMatthew McClintockoftaddr=0x300000
52850267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr
52860267768eSMatthew McClintock## Booting image at 00200000 ...
52870267768eSMatthew McClintock   Image Name:	 Linux-2.6.17-dirty
52880267768eSMatthew McClintock   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
52890267768eSMatthew McClintock   Data Size:	 1029343 Bytes = 1005.2 kB
52900267768eSMatthew McClintock   Load Address: 00000000
52910267768eSMatthew McClintock   Entry Point:	 00000000
52920267768eSMatthew McClintock   Verifying Checksum ... OK
52930267768eSMatthew McClintock   Uncompressing Kernel Image ... OK
52940267768eSMatthew McClintockBooting using flat device tree at 0x300000
52950267768eSMatthew McClintockUsing MPC85xx ADS machine description
52960267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
52970267768eSMatthew McClintock[snip]
52980267768eSMatthew McClintock
52990267768eSMatthew McClintock
53006069ff26SwdenkMore About U-Boot Image Types:
53016069ff26Swdenk------------------------------
53026069ff26Swdenk
53036069ff26SwdenkU-Boot supports the following image types:
53046069ff26Swdenk
53056069ff26Swdenk   "Standalone Programs" are directly runnable in the environment
53066069ff26Swdenk	provided by U-Boot; it is expected that (if they behave
53076069ff26Swdenk	well) you can continue to work in U-Boot after return from
53086069ff26Swdenk	the Standalone Program.
53096069ff26Swdenk   "OS Kernel Images" are usually images of some Embedded OS which
53106069ff26Swdenk	will take over control completely. Usually these programs
53116069ff26Swdenk	will install their own set of exception handlers, device
53126069ff26Swdenk	drivers, set up the MMU, etc. - this means, that you cannot
53136069ff26Swdenk	expect to re-enter U-Boot except by resetting the CPU.
53146069ff26Swdenk   "RAMDisk Images" are more or less just data blocks, and their
53156069ff26Swdenk	parameters (address, size) are passed to an OS kernel that is
53166069ff26Swdenk	being started.
53176069ff26Swdenk   "Multi-File Images" contain several images, typically an OS
53186069ff26Swdenk	(Linux) kernel image and one or more data images like
53196069ff26Swdenk	RAMDisks. This construct is useful for instance when you want
53206069ff26Swdenk	to boot over the network using BOOTP etc., where the boot
53216069ff26Swdenk	server provides just a single image file, but you want to get
53226069ff26Swdenk	for instance an OS kernel and a RAMDisk image.
53236069ff26Swdenk
53246069ff26Swdenk	"Multi-File Images" start with a list of image sizes, each
53256069ff26Swdenk	image size (in bytes) specified by an "uint32_t" in network
53266069ff26Swdenk	byte order. This list is terminated by an "(uint32_t)0".
53276069ff26Swdenk	Immediately after the terminating 0 follow the images, one by
53286069ff26Swdenk	one, all aligned on "uint32_t" boundaries (size rounded up to
53296069ff26Swdenk	a multiple of 4 bytes).
53306069ff26Swdenk
53316069ff26Swdenk   "Firmware Images" are binary images containing firmware (like
53326069ff26Swdenk	U-Boot or FPGA images) which usually will be programmed to
53336069ff26Swdenk	flash memory.
53346069ff26Swdenk
53356069ff26Swdenk   "Script files" are command sequences that will be executed by
53366069ff26Swdenk	U-Boot's command interpreter; this feature is especially
53376069ff26Swdenk	useful when you configure U-Boot to use a real shell (hush)
53386069ff26Swdenk	as command interpreter.
53396069ff26Swdenk
534044f074c7SMarek VasutBooting the Linux zImage:
534144f074c7SMarek Vasut-------------------------
534244f074c7SMarek Vasut
534344f074c7SMarek VasutOn some platforms, it's possible to boot Linux zImage. This is done
534444f074c7SMarek Vasutusing the "bootz" command. The syntax of "bootz" command is the same
534544f074c7SMarek Vasutas the syntax of "bootm" command.
534644f074c7SMarek Vasut
53478ac28563STom RiniNote, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
5348017e1f3fSMarek Vasutkernel with raw initrd images. The syntax is slightly different, the
5349017e1f3fSMarek Vasutaddress of the initrd must be augmented by it's size, in the following
5350017e1f3fSMarek Vasutformat: "<initrd addres>:<initrd size>".
5351017e1f3fSMarek Vasut
5352c609719bSwdenk
5353c609719bSwdenkStandalone HOWTO:
5354c609719bSwdenk=================
5355c609719bSwdenk
5356c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and
5357c609719bSwdenkrun "standalone" applications, which can use some resources of
5358c609719bSwdenkU-Boot like console I/O functions or interrupt services.
5359c609719bSwdenk
5360c609719bSwdenkTwo simple examples are included with the sources:
5361c609719bSwdenk
5362c609719bSwdenk"Hello World" Demo:
5363c609719bSwdenk-------------------
5364c609719bSwdenk
5365c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo
5366c609719bSwdenkapplication; it is automatically compiled when you build U-Boot.
5367c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it
5368c609719bSwdenklike that:
5369c609719bSwdenk
5370c609719bSwdenk	=> loads
5371c609719bSwdenk	## Ready for S-Record download ...
5372c609719bSwdenk	~>examples/hello_world.srec
5373c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
5374c609719bSwdenk	[file transfer complete]
5375c609719bSwdenk	[connected]
5376c609719bSwdenk	## Start Addr = 0x00040004
5377c609719bSwdenk
5378c609719bSwdenk	=> go 40004 Hello World! This is a test.
5379c609719bSwdenk	## Starting application at 0x00040004 ...
5380c609719bSwdenk	Hello World
5381c609719bSwdenk	argc = 7
5382c609719bSwdenk	argv[0] = "40004"
5383c609719bSwdenk	argv[1] = "Hello"
5384c609719bSwdenk	argv[2] = "World!"
5385c609719bSwdenk	argv[3] = "This"
5386c609719bSwdenk	argv[4] = "is"
5387c609719bSwdenk	argv[5] = "a"
5388c609719bSwdenk	argv[6] = "test."
5389c609719bSwdenk	argv[7] = "<NULL>"
5390c609719bSwdenk	Hit any key to exit ...
5391c609719bSwdenk
5392c609719bSwdenk	## Application terminated, rc = 0x0
5393c609719bSwdenk
5394c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt
5395c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'.
5396c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second.
5397c609719bSwdenkThe interrupt service routine is trivial, just printing a '.'
5398c609719bSwdenkcharacter, but this is just a demo program. The application can be
5399c609719bSwdenkcontrolled by the following keys:
5400c609719bSwdenk
5401c609719bSwdenk	? - print current values og the CPM Timer registers
5402c609719bSwdenk	b - enable interrupts and start timer
5403c609719bSwdenk	e - stop timer and disable interrupts
5404c609719bSwdenk	q - quit application
5405c609719bSwdenk
5406c609719bSwdenk	=> loads
5407c609719bSwdenk	## Ready for S-Record download ...
5408c609719bSwdenk	~>examples/timer.srec
5409c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
5410c609719bSwdenk	[file transfer complete]
5411c609719bSwdenk	[connected]
5412c609719bSwdenk	## Start Addr = 0x00040004
5413c609719bSwdenk
5414c609719bSwdenk	=> go 40004
5415c609719bSwdenk	## Starting application at 0x00040004 ...
5416c609719bSwdenk	TIMERS=0xfff00980
5417c609719bSwdenk	Using timer 1
5418c609719bSwdenk	  tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
5419c609719bSwdenk
5420c609719bSwdenkHit 'b':
5421c609719bSwdenk	[q, b, e, ?] Set interval 1000000 us
5422c609719bSwdenk	Enabling timer
5423c609719bSwdenkHit '?':
5424c609719bSwdenk	[q, b, e, ?] ........
5425c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
5426c609719bSwdenkHit '?':
5427c609719bSwdenk	[q, b, e, ?] .
5428c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
5429c609719bSwdenkHit '?':
5430c609719bSwdenk	[q, b, e, ?] .
5431c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
5432c609719bSwdenkHit '?':
5433c609719bSwdenk	[q, b, e, ?] .
5434c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
5435c609719bSwdenkHit 'e':
5436c609719bSwdenk	[q, b, e, ?] ...Stopping timer
5437c609719bSwdenkHit 'q':
5438c609719bSwdenk	[q, b, e, ?] ## Application terminated, rc = 0x0
5439c609719bSwdenk
5440c609719bSwdenk
544185ec0bccSwdenkMinicom warning:
544285ec0bccSwdenk================
544385ec0bccSwdenk
54447152b1d0SwdenkOver time, many people have reported problems when trying to use the
544585ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd)
544685ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under
5447f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and
544885ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and
5449e53515a2SKarl O. Pincuse "cu" for S-Record download ("loads" command).  See
5450e53515a2SKarl O. Pinchttp://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
5451e53515a2SKarl O. Pincfor help with kermit.
5452e53515a2SKarl O. Pinc
545385ec0bccSwdenk
545452f52c14SwdenkNevertheless, if you absolutely want to use it try adding this
545552f52c14Swdenkconfiguration to your "File transfer protocols" section:
545652f52c14Swdenk
545752f52c14Swdenk	   Name	   Program			Name U/D FullScr IO-Red. Multi
545852f52c14Swdenk	X  kermit  /usr/bin/kermit -i -l %l -s	 Y    U	   Y	   N	  N
545952f52c14Swdenk	Y  kermit  /usr/bin/kermit -i -l %l -r	 N    D	   Y	   N	  N
546052f52c14Swdenk
546152f52c14Swdenk
5462c609719bSwdenkNetBSD Notes:
5463c609719bSwdenk=============
5464c609719bSwdenk
5465c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host
5466c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx).
5467c609719bSwdenk
5468c609719bSwdenkBuilding requires a cross environment; it is known to work on
5469c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5470c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make).
5471c609719bSwdenkNote that the cross-powerpc package does not install include files;
5472c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is
5473c609719bSwdenkmissing.  This file has to be installed and patched manually:
5474c609719bSwdenk
5475c609719bSwdenk	# cd /usr/pkg/cross/powerpc-netbsd/include
5476c609719bSwdenk	# mkdir powerpc
5477c609719bSwdenk	# ln -s powerpc machine
5478c609719bSwdenk	# cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
5479c609719bSwdenk	# ${EDIT} powerpc/ansi.h	## must remove __va_list, _BSD_VA_LIST
5480c609719bSwdenk
5481c609719bSwdenkNative builds *don't* work due to incompatibilities between native
5482c609719bSwdenkand U-Boot include files.
5483c609719bSwdenk
5484c609719bSwdenkBooting assumes that (the first part of) the image booted is a
5485c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel
5486c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source
5487c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
54882a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
5489c609719bSwdenk
5490c609719bSwdenk
5491c609719bSwdenkImplementation Internals:
5492c609719bSwdenk=========================
5493c609719bSwdenk
5494c609719bSwdenkThe following is not intended to be a complete description of every
5495c609719bSwdenkimplementation detail. However, it should help to understand the
5496c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom
5497c609719bSwdenkhardware.
5498c609719bSwdenk
5499c609719bSwdenk
5500c609719bSwdenkInitial Stack, Global Data:
5501c609719bSwdenk---------------------------
5502c609719bSwdenk
5503c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot
5504c609719bSwdenkstarts running out of ROM (flash memory), usually without access to
5505c609719bSwdenksystem RAM (because the memory controller is not initialized yet).
5506c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS
5507c609719bSwdenkis not initialized as zero. To be able to get a C environment working
5508c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation
5509c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU
5510c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and
5511c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be
5512c609719bSwdenklocked as (mis-) used as memory, etc.
5513c609719bSwdenk
55147152b1d0Swdenk	Chris Hallinan posted a good summary of these issues to the
55150668236bSWolfgang Denk	U-Boot mailing list:
551643d9616cSwdenk
551743d9616cSwdenk	Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
551843d9616cSwdenk	From: "Chris Hallinan" <clh@net1plus.com>
551943d9616cSwdenk	Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
552043d9616cSwdenk	...
552143d9616cSwdenk
552243d9616cSwdenk	Correct me if I'm wrong, folks, but the way I understand it
552343d9616cSwdenk	is this: Using DCACHE as initial RAM for Stack, etc, does not
552443d9616cSwdenk	require any physical RAM backing up the cache. The cleverness
552543d9616cSwdenk	is that the cache is being used as a temporary supply of
552643d9616cSwdenk	necessary storage before the SDRAM controller is setup. It's
552711ccc33fSMarcel Ziswiler	beyond the scope of this list to explain the details, but you
552843d9616cSwdenk	can see how this works by studying the cache architecture and
552943d9616cSwdenk	operation in the architecture and processor-specific manuals.
553043d9616cSwdenk
553143d9616cSwdenk	OCM is On Chip Memory, which I believe the 405GP has 4K. It
553243d9616cSwdenk	is another option for the system designer to use as an
553311ccc33fSMarcel Ziswiler	initial stack/RAM area prior to SDRAM being available. Either
553443d9616cSwdenk	option should work for you. Using CS 4 should be fine if your
553543d9616cSwdenk	board designers haven't used it for something that would
553643d9616cSwdenk	cause you grief during the initial boot! It is frequently not
553743d9616cSwdenk	used.
553843d9616cSwdenk
55396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
554043d9616cSwdenk	with your processor/board/system design. The default value
554143d9616cSwdenk	you will find in any recent u-boot distribution in
55428a316c9bSStefan Roese	walnut.h should work for you. I'd set it to a value larger
554343d9616cSwdenk	than your SDRAM module. If you have a 64MB SDRAM module, set
554443d9616cSwdenk	it above 400_0000. Just make sure your board has no resources
554543d9616cSwdenk	that are supposed to respond to that address! That code in
554643d9616cSwdenk	start.S has been around a while and should work as is when
554743d9616cSwdenk	you get the config right.
554843d9616cSwdenk
554943d9616cSwdenk	-Chris Hallinan
555043d9616cSwdenk	DS4.COM, Inc.
555143d9616cSwdenk
5552c609719bSwdenkIt is essential to remember this, since it has some impact on the C
5553c609719bSwdenkcode for the initialization procedures:
5554c609719bSwdenk
5555c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt
5556c609719bSwdenk  to write it.
5557c609719bSwdenk
555811ccc33fSMarcel Ziswiler* Do not use any uninitialized global data (or implicitely initialized
5559c609719bSwdenk  as zero data - BSS segment) at all - this is undefined, initiali-
55607152b1d0Swdenk  zation is performed later (when relocating to RAM).
5561c609719bSwdenk
5562c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like
5563c609719bSwdenk  that.
5564c609719bSwdenk
5565c609719bSwdenkHaving only the stack as writable memory limits means we cannot use
5566c609719bSwdenknormal global data to share information beween the code. But it
5567c609719bSwdenkturned out that the implementation of U-Boot can be greatly
5568c609719bSwdenksimplified by making a global data structure (gd_t) available to all
5569c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_
5570c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of
5571c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we
5572c609719bSwdenkplace a pointer (gd) to the global data into a register which we
5573c609719bSwdenkreserve for this purpose.
5574c609719bSwdenk
55757152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the
5576c609719bSwdenkrelevant  (E)ABI  specifications for the current architecture, and by
5577c609719bSwdenkGCC's implementation.
5578c609719bSwdenk
5579c609719bSwdenkFor PowerPC, the following registers have specific use:
5580c609719bSwdenk	R1:	stack pointer
5581e7670f6cSWolfgang Denk	R2:	reserved for system use
5582c609719bSwdenk	R3-R4:	parameter passing and return values
5583c609719bSwdenk	R5-R10: parameter passing
5584c609719bSwdenk	R13:	small data area pointer
5585c609719bSwdenk	R30:	GOT pointer
5586c609719bSwdenk	R31:	frame pointer
5587c609719bSwdenk
5588e6bee808SJoakim Tjernlund	(U-Boot also uses R12 as internal GOT pointer. r12
5589e6bee808SJoakim Tjernlund	is a volatile register so r12 needs to be reset when
5590e6bee808SJoakim Tjernlund	going back and forth between asm and C)
5591c609719bSwdenk
5592e7670f6cSWolfgang Denk    ==> U-Boot will use R2 to hold a pointer to the global data
5593c609719bSwdenk
5594c609719bSwdenk    Note: on PPC, we could use a static initializer (since the
5595c609719bSwdenk    address of the global data structure is known at compile time),
5596c609719bSwdenk    but it turned out that reserving a register results in somewhat
5597c609719bSwdenk    smaller code - although the code savings are not that big (on
5598c609719bSwdenk    average for all boards 752 bytes for the whole U-Boot image,
5599c609719bSwdenk    624 text + 127 data).
5600c609719bSwdenk
5601c4db335cSRobin GetzOn Blackfin, the normal C ABI (except for P3) is followed as documented here:
56024c58eb55SMike Frysinger	http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
56034c58eb55SMike Frysinger
5604c4db335cSRobin Getz    ==> U-Boot will use P3 to hold a pointer to the global data
56054c58eb55SMike Frysinger
5606c609719bSwdenkOn ARM, the following registers are used:
5607c609719bSwdenk
5608c609719bSwdenk	R0:	function argument word/integer result
5609c609719bSwdenk	R1-R3:	function argument word
561012eba1b4SJeroen Hofstee	R9:	platform specific
561112eba1b4SJeroen Hofstee	R10:	stack limit (used only if stack checking is enabled)
5612c609719bSwdenk	R11:	argument (frame) pointer
5613c609719bSwdenk	R12:	temporary workspace
5614c609719bSwdenk	R13:	stack pointer
5615c609719bSwdenk	R14:	link register
5616c609719bSwdenk	R15:	program counter
5617c609719bSwdenk
561812eba1b4SJeroen Hofstee    ==> U-Boot will use R9 to hold a pointer to the global data
561912eba1b4SJeroen Hofstee
562012eba1b4SJeroen Hofstee    Note: on ARM, only R_ARM_RELATIVE relocations are supported.
5621c609719bSwdenk
56220df01fd3SThomas ChouOn Nios II, the ABI is documented here:
56230df01fd3SThomas Chou	http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
56240df01fd3SThomas Chou
56250df01fd3SThomas Chou    ==> U-Boot will use gp to hold a pointer to the global data
56260df01fd3SThomas Chou
56270df01fd3SThomas Chou    Note: on Nios II, we give "-G0" option to gcc and don't use gp
56280df01fd3SThomas Chou    to access small data sections, so gp is free.
56290df01fd3SThomas Chou
5630afc1ce82SMacpaul LinOn NDS32, the following registers are used:
5631afc1ce82SMacpaul Lin
5632afc1ce82SMacpaul Lin	R0-R1:	argument/return
5633afc1ce82SMacpaul Lin	R2-R5:	argument
5634afc1ce82SMacpaul Lin	R15:	temporary register for assembler
5635afc1ce82SMacpaul Lin	R16:	trampoline register
5636afc1ce82SMacpaul Lin	R28:	frame pointer (FP)
5637afc1ce82SMacpaul Lin	R29:	global pointer (GP)
5638afc1ce82SMacpaul Lin	R30:	link register (LP)
5639afc1ce82SMacpaul Lin	R31:	stack pointer (SP)
5640afc1ce82SMacpaul Lin	PC:	program counter (PC)
5641afc1ce82SMacpaul Lin
5642afc1ce82SMacpaul Lin    ==> U-Boot will use R10 to hold a pointer to the global data
5643afc1ce82SMacpaul Lin
5644d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5645d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much.
5646c609719bSwdenk
5647c609719bSwdenkMemory Management:
5648c609719bSwdenk------------------
5649c609719bSwdenk
5650c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the
5651c609719bSwdenkMMU is not used either for address mapping nor for memory protection.
5652c609719bSwdenk
5653c609719bSwdenkThe available memory is mapped to fixed addresses using the memory
5654c609719bSwdenkcontroller. In this process, a contiguous block is formed for each
5655c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several
5656c609719bSwdenkphysical memory banks.
5657c609719bSwdenk
5658c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on
5659c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5660c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself
5661c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some
56626d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
5663c609719bSwdenkconfiguration setting]. Below that, a structure with global Board
5664c609719bSwdenkInfo data is placed, followed by the stack (growing downward).
5665c609719bSwdenk
5666c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB
5667c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF).
5668c609719bSwdenk
5669c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like
5670c609719bSwdenkthis:
5671c609719bSwdenk
5672c609719bSwdenk	0x0000 0000	Exception Vector code
5673c609719bSwdenk	      :
5674c609719bSwdenk	0x0000 1FFF
5675c609719bSwdenk	0x0000 2000	Free for Application Use
5676c609719bSwdenk	      :
5677c609719bSwdenk	      :
5678c609719bSwdenk
5679c609719bSwdenk	      :
5680c609719bSwdenk	      :
5681c609719bSwdenk	0x00FB FF20	Monitor Stack (Growing downward)
5682c609719bSwdenk	0x00FB FFAC	Board Info Data and permanent copy of global data
5683c609719bSwdenk	0x00FC 0000	Malloc Arena
5684c609719bSwdenk	      :
5685c609719bSwdenk	0x00FD FFFF
5686c609719bSwdenk	0x00FE 0000	RAM Copy of Monitor Code
5687c609719bSwdenk	...		eventually: LCD or video framebuffer
5688c609719bSwdenk	...		eventually: pRAM (Protected RAM - unchanged by reset)
5689c609719bSwdenk	0x00FF FFFF	[End of RAM]
5690c609719bSwdenk
5691c609719bSwdenk
5692c609719bSwdenkSystem Initialization:
5693c609719bSwdenk----------------------
5694c609719bSwdenk
5695c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point
569611ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset
5697c609719bSwdenkconfiguration for CS0# this is a mirror of the onboard Flash memory.
56987152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address.
5699c609719bSwdenkTo be able to implement the initialization code in C, a (small!)
5700c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs
5701c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked
5702c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core,
5703c609719bSwdenkthe caches and the SIU.
5704c609719bSwdenk
5705c609719bSwdenkNext, all (potentially) available memory banks are mapped using a
5706c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries
5707c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5708c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5709c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a
5710c609719bSwdenksimple memory test is run that determines the size of the SDRAM
5711c609719bSwdenkbanks.
5712c609719bSwdenk
5713c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of
57147152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first
5715c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address
5716c609719bSwdenk0x00000000, with any additional banks following immediately to create
5717c609719bSwdenkcontiguous memory starting from 0.
5718c609719bSwdenk
5719c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area
5720c609719bSwdenkand allocates memory for use by malloc() and for the global Board
5721c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM
5722c609719bSwdenkpages, and the final stack is set up.
5723c609719bSwdenk
5724c609719bSwdenkOnly after this relocation will you have a "normal" C environment;
5725c609719bSwdenkuntil that you are restricted in several ways, mostly because you are
5726c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a
5727c609719bSwdenknew address in RAM.
5728c609719bSwdenk
5729c609719bSwdenk
5730c609719bSwdenkU-Boot Porting Guide:
5731c609719bSwdenk----------------------
5732c609719bSwdenk
5733c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
57346aff3115Swdenklist, October 2002]
5735c609719bSwdenk
5736c609719bSwdenk
5737c609719bSwdenkint main(int argc, char *argv[])
5738c609719bSwdenk{
5739c609719bSwdenk	sighandler_t no_more_time;
5740c609719bSwdenk
5741c609719bSwdenk	signal(SIGALRM, no_more_time);
5742c609719bSwdenk	alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
5743c609719bSwdenk
5744c609719bSwdenk	if (available_money > available_manpower) {
57456c3fef28SJerry Van Baren		Pay consultant to port U-Boot;
5746c609719bSwdenk		return 0;
5747c609719bSwdenk	}
5748c609719bSwdenk
5749c609719bSwdenk	Download latest U-Boot source;
5750c609719bSwdenk
57510668236bSWolfgang Denk	Subscribe to u-boot mailing list;
57526aff3115Swdenk
57536c3fef28SJerry Van Baren	if (clueless)
5754c609719bSwdenk		email("Hi, I am new to U-Boot, how do I get started?");
5755c609719bSwdenk
5756c609719bSwdenk	while (learning) {
5757c609719bSwdenk		Read the README file in the top level directory;
57587cb22f97Swdenk		Read http://www.denx.de/twiki/bin/view/DULG/Manual;
57596c3fef28SJerry Van Baren		Read applicable doc/*.README;
5760c609719bSwdenk		Read the source, Luke;
57616c3fef28SJerry Van Baren		/* find . -name "*.[chS]" | xargs grep -i <keyword> */
5762c609719bSwdenk	}
5763c609719bSwdenk
57646c3fef28SJerry Van Baren	if (available_money > toLocalCurrency ($2500))
57656c3fef28SJerry Van Baren		Buy a BDI3000;
57666c3fef28SJerry Van Baren	else
5767c609719bSwdenk		Add a lot of aggravation and time;
5768c609719bSwdenk
57696c3fef28SJerry Van Baren	if (a similar board exists) {	/* hopefully... */
57706c3fef28SJerry Van Baren		cp -a board/<similar> board/<myboard>
57716c3fef28SJerry Van Baren		cp include/configs/<similar>.h include/configs/<myboard>.h
57726c3fef28SJerry Van Baren	} else {
5773c609719bSwdenk		Create your own board support subdirectory;
57746c3fef28SJerry Van Baren		Create your own board include/configs/<myboard>.h file;
57756c3fef28SJerry Van Baren	}
57766c3fef28SJerry Van Baren	Edit new board/<myboard> files
57776c3fef28SJerry Van Baren	Edit new include/configs/<myboard>.h
5778c609719bSwdenk
57796c3fef28SJerry Van Baren	while (!accepted) {
5780c609719bSwdenk		while (!running) {
5781c609719bSwdenk			do {
5782c609719bSwdenk				Add / modify source code;
5783c609719bSwdenk			} until (compiles);
5784c609719bSwdenk			Debug;
5785c609719bSwdenk			if (clueless)
5786c609719bSwdenk				email("Hi, I am having problems...");
5787c609719bSwdenk		}
57886c3fef28SJerry Van Baren		Send patch file to the U-Boot email list;
57896c3fef28SJerry Van Baren		if (reasonable critiques)
57906c3fef28SJerry Van Baren			Incorporate improvements from email list code review;
57916c3fef28SJerry Van Baren		else
57926c3fef28SJerry Van Baren			Defend code as written;
57936c3fef28SJerry Van Baren	}
5794c609719bSwdenk
5795c609719bSwdenk	return 0;
5796c609719bSwdenk}
5797c609719bSwdenk
5798c609719bSwdenkvoid no_more_time (int sig)
5799c609719bSwdenk{
5800c609719bSwdenk      hire_a_guru();
5801c609719bSwdenk}
5802c609719bSwdenk
5803c609719bSwdenk
5804c609719bSwdenkCoding Standards:
5805c609719bSwdenk-----------------
5806c609719bSwdenk
5807c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel
58082c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script
58097ca9296eSWolfgang Denk"scripts/Lindent" in your Linux kernel source directory.
5810c609719bSwdenk
58112c051651SDetlev ZundelSource files originating from a different project (for example the
58122c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not
58132c051651SDetlev Zundelreformated to ease subsequent migration to newer versions of those
58142c051651SDetlev Zundelsources.
58152c051651SDetlev Zundel
58162c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in
58172c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//)
58182c051651SDetlev Zundelin your code.
5819c609719bSwdenk
5820c178d3daSwdenkPlease also stick to the following formatting rules:
5821180d3f74Swdenk- remove any trailing white space
58227ca9296eSWolfgang Denk- use TAB characters for indentation and vertical alignment, not spaces
5823180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds
58247ca9296eSWolfgang Denk- do not add more than 2 consecutive empty lines to source files
5825180d3f74Swdenk- do not add trailing empty lines to source files
5826180d3f74Swdenk
5827c609719bSwdenkSubmissions which do not conform to the standards may be returned
5828c609719bSwdenkwith a request to reformat the changes.
5829c609719bSwdenk
5830c609719bSwdenk
5831c609719bSwdenkSubmitting Patches:
5832c609719bSwdenk-------------------
5833c609719bSwdenk
5834c609719bSwdenkSince the number of patches for U-Boot is growing, we need to
5835c609719bSwdenkestablish some rules. Submissions which do not conform to these rules
5836c609719bSwdenkmay be rejected, even when they contain important and valuable stuff.
5837c609719bSwdenk
58380d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details.
5839218ca724SWolfgang Denk
58400668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
58410668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot
58420668236bSWolfgang Denk
5843c609719bSwdenkWhen you send a patch, please include the following information with
5844c609719bSwdenkit:
5845c609719bSwdenk
5846c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes
5847c609719bSwdenk  this bug. Please try to include a way of demonstrating that the
5848c609719bSwdenk  patch actually fixes something.
5849c609719bSwdenk
5850c609719bSwdenk* For new features: a description of the feature and your
5851c609719bSwdenk  implementation.
5852c609719bSwdenk
5853c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch)
5854c609719bSwdenk
5855c609719bSwdenk* For major contributions, your entry to the CREDITS file
5856c609719bSwdenk
585727af930eSAlbert ARIBAUD* When you add support for a new board, don't forget to add a
585827af930eSAlbert ARIBAUD  maintainer e-mail address to the boards.cfg file, too.
5859c609719bSwdenk
5860c609719bSwdenk* If your patch adds new configuration options, don't forget to
5861c609719bSwdenk  document these in the README file.
5862c609719bSwdenk
5863218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly*
5864218ca724SWolfgang Denk  recommended) you can easily generate the patch using the
58657ca9296eSWolfgang Denk  "git format-patch". If you then use "git send-email" to send it to
5866218ca724SWolfgang Denk  the U-Boot mailing list, you will avoid most of the common problems
5867218ca724SWolfgang Denk  with some other mail clients.
5868c609719bSwdenk
5869218ca724SWolfgang Denk  If you cannot use git, use "diff -purN OLD NEW". If your version of
5870218ca724SWolfgang Denk  diff does not support these options, then get the latest version of
5871218ca724SWolfgang Denk  GNU diff.
58726dff5529Swdenk
5873218ca724SWolfgang Denk  The current directory when running this command shall be the parent
5874218ca724SWolfgang Denk  directory of the U-Boot source tree (i. e. please make sure that
5875218ca724SWolfgang Denk  your patch includes sufficient directory information for the
5876218ca724SWolfgang Denk  affected files).
5877218ca724SWolfgang Denk
5878218ca724SWolfgang Denk  We prefer patches as plain text. MIME attachments are discouraged,
5879218ca724SWolfgang Denk  and compressed attachments must not be used.
5880c609719bSwdenk
588152f52c14Swdenk* If one logical set of modifications affects or creates several
588252f52c14Swdenk  files, all these changes shall be submitted in a SINGLE patch file.
588352f52c14Swdenk
588452f52c14Swdenk* Changesets that contain different, unrelated modifications shall be
588552f52c14Swdenk  submitted as SEPARATE patches, one patch per changeset.
588652f52c14Swdenk
588752f52c14Swdenk
5888c609719bSwdenkNotes:
5889c609719bSwdenk
5890c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched
5891c609719bSwdenk  source tree and make sure that no errors or warnings are reported
5892c609719bSwdenk  for any of the boards.
5893c609719bSwdenk
5894c609719bSwdenk* Keep your modifications to the necessary minimum: A patch
5895c609719bSwdenk  containing several unrelated changes or arbitrary reformats will be
5896c609719bSwdenk  returned with a request to re-formatting / split it.
5897c609719bSwdenk
5898c609719bSwdenk* If you modify existing code, make sure that your new code does not
5899c609719bSwdenk  add to the memory footprint of the code ;-) Small is beautiful!
5900c609719bSwdenk  When adding new features, these should compile conditionally only
5901c609719bSwdenk  (using #ifdef), and the resulting code with the new feature
5902c609719bSwdenk  disabled must not need more memory than the old code without your
5903c609719bSwdenk  modification.
590490dc6704Swdenk
59050668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the
59060668236bSWolfgang Denk  u-boot mailing list. Bigger patches will be moderated. If they are
59070668236bSWolfgang Denk  reasonable and not too big, they will be acknowledged. But patches
59080668236bSWolfgang Denk  bigger than the size limit should be avoided.
5909