xref: /openbmc/u-boot/README (revision 59e890ef)
1c609719bSwdenk#
2eca3aeb3SWolfgang Denk# (C) Copyright 2000 - 2013
3c609719bSwdenk# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4c609719bSwdenk#
5eca3aeb3SWolfgang Denk# SPDX-License-Identifier:	GPL-2.0+
6c609719bSwdenk#
7c609719bSwdenk
8c609719bSwdenkSummary:
9c609719bSwdenk========
10c609719bSwdenk
1124ee89b9SwdenkThis directory contains the source code for U-Boot, a boot loader for
12e86e5a07SwdenkEmbedded boards based on PowerPC, ARM, MIPS and several other
13e86e5a07Swdenkprocessors, which can be installed in a boot ROM and used to
14e86e5a07Swdenkinitialize and test the hardware or to download and run application
15e86e5a07Swdenkcode.
16c609719bSwdenk
17c609719bSwdenkThe development of U-Boot is closely related to Linux: some parts of
1824ee89b9Swdenkthe source code originate in the Linux source tree, we have some
1924ee89b9Swdenkheader files in common, and special provision has been made to
20c609719bSwdenksupport booting of Linux images.
21c609719bSwdenk
22c609719bSwdenkSome attention has been paid to make this software easily
23c609719bSwdenkconfigurable and extendable. For instance, all monitor commands are
24c609719bSwdenkimplemented with the same call interface, so that it's very easy to
25c609719bSwdenkadd new commands. Also, instead of permanently adding rarely used
26c609719bSwdenkcode (for instance hardware test utilities) to the monitor, you can
27c609719bSwdenkload and run it dynamically.
28c609719bSwdenk
29c609719bSwdenk
30c609719bSwdenkStatus:
31c609719bSwdenk=======
32c609719bSwdenk
33c609719bSwdenkIn general, all boards for which a configuration option exists in the
34c609719bSwdenkMakefile have been tested to some extent and can be considered
35c609719bSwdenk"working". In fact, many of them are used in production systems.
36c609719bSwdenk
37c609719bSwdenkIn case of problems see the CHANGELOG and CREDITS files to find out
3827af930eSAlbert ARIBAUDwho contributed the specific port. The boards.cfg file lists board
39218ca724SWolfgang Denkmaintainers.
40c609719bSwdenk
41adb9d851SRobert P. J. DayNote: There is no CHANGELOG file in the actual U-Boot source tree;
42adb9d851SRobert P. J. Dayit can be created dynamically from the Git log using:
43adb9d851SRobert P. J. Day
44adb9d851SRobert P. J. Day	make CHANGELOG
45adb9d851SRobert P. J. Day
46c609719bSwdenk
47c609719bSwdenkWhere to get help:
48c609719bSwdenk==================
49c609719bSwdenk
50c609719bSwdenkIn case you have questions about, problems with or contributions for
51c609719bSwdenkU-Boot you should send a message to the U-Boot mailing list at
520c32565fSPeter Tyser<u-boot@lists.denx.de>. There is also an archive of previous traffic
530c32565fSPeter Tyseron the mailing list - please search the archive before asking FAQ's.
540c32565fSPeter TyserPlease see http://lists.denx.de/pipermail/u-boot and
550c32565fSPeter Tyserhttp://dir.gmane.org/gmane.comp.boot-loaders.u-boot
56c609719bSwdenk
57c609719bSwdenk
58218ca724SWolfgang DenkWhere to get source code:
59218ca724SWolfgang Denk=========================
60218ca724SWolfgang Denk
61218ca724SWolfgang DenkThe U-Boot source code is maintained in the git repository at
62218ca724SWolfgang Denkgit://www.denx.de/git/u-boot.git ; you can browse it online at
63218ca724SWolfgang Denkhttp://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
64218ca724SWolfgang Denk
65218ca724SWolfgang DenkThe "snapshot" links on this page allow you to download tarballs of
6611ccc33fSMarcel Ziswilerany version you might be interested in. Official releases are also
67218ca724SWolfgang Denkavailable for FTP download from the ftp://ftp.denx.de/pub/u-boot/
68218ca724SWolfgang Denkdirectory.
69218ca724SWolfgang Denk
70d4ee711dSAnatolij GustschinPre-built (and tested) images are available from
71218ca724SWolfgang Denkftp://ftp.denx.de/pub/u-boot/images/
72218ca724SWolfgang Denk
73218ca724SWolfgang Denk
74c609719bSwdenkWhere we come from:
75c609719bSwdenk===================
76c609719bSwdenk
77c609719bSwdenk- start from 8xxrom sources
7824ee89b9Swdenk- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
79c609719bSwdenk- clean up code
80c609719bSwdenk- make it easier to add custom boards
81c609719bSwdenk- make it possible to add other [PowerPC] CPUs
82c609719bSwdenk- extend functions, especially:
83c609719bSwdenk  * Provide extended interface to Linux boot loader
84c609719bSwdenk  * S-Record download
85c609719bSwdenk  * network boot
8611ccc33fSMarcel Ziswiler  * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
8724ee89b9Swdenk- create ARMBoot project (http://sourceforge.net/projects/armboot)
88c609719bSwdenk- add other CPU families (starting with ARM)
8924ee89b9Swdenk- create U-Boot project (http://sourceforge.net/projects/u-boot)
900d28f34bSMagnus Lilja- current project page: see http://www.denx.de/wiki/U-Boot
9124ee89b9Swdenk
9224ee89b9Swdenk
9324ee89b9SwdenkNames and Spelling:
9424ee89b9Swdenk===================
9524ee89b9Swdenk
9624ee89b9SwdenkThe "official" name of this project is "Das U-Boot". The spelling
9724ee89b9Swdenk"U-Boot" shall be used in all written text (documentation, comments
9824ee89b9Swdenkin source files etc.). Example:
9924ee89b9Swdenk
10024ee89b9Swdenk	This is the README file for the U-Boot project.
10124ee89b9Swdenk
10224ee89b9SwdenkFile names etc. shall be based on the string "u-boot". Examples:
10324ee89b9Swdenk
10424ee89b9Swdenk	include/asm-ppc/u-boot.h
10524ee89b9Swdenk
10624ee89b9Swdenk	#include <asm/u-boot.h>
10724ee89b9Swdenk
10824ee89b9SwdenkVariable names, preprocessor constants etc. shall be either based on
10924ee89b9Swdenkthe string "u_boot" or on "U_BOOT". Example:
11024ee89b9Swdenk
11124ee89b9Swdenk	U_BOOT_VERSION		u_boot_logo
11224ee89b9Swdenk	IH_OS_U_BOOT		u_boot_hush_start
113c609719bSwdenk
114c609719bSwdenk
11593f19cc0SwdenkVersioning:
11693f19cc0Swdenk===========
11793f19cc0Swdenk
118360d883aSThomas WeberStarting with the release in October 2008, the names of the releases
119360d883aSThomas Weberwere changed from numerical release numbers without deeper meaning
120360d883aSThomas Weberinto a time stamp based numbering. Regular releases are identified by
121360d883aSThomas Webernames consisting of the calendar year and month of the release date.
122360d883aSThomas WeberAdditional fields (if present) indicate release candidates or bug fix
123360d883aSThomas Weberreleases in "stable" maintenance trees.
12493f19cc0Swdenk
125360d883aSThomas WeberExamples:
126360d883aSThomas Weber	U-Boot v2009.11	    - Release November 2009
127360d883aSThomas Weber	U-Boot v2009.11.1   - Release 1 in version November 2009 stable tree
128360d883aSThomas Weber	U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release
12993f19cc0Swdenk
13093f19cc0Swdenk
131c609719bSwdenkDirectory Hierarchy:
132c609719bSwdenk====================
133c609719bSwdenk
1348d321b81SPeter Tyser/arch			Architecture specific files
1356eae68e4SMasahiro Yamada  /arc			Files generic to ARC architecture
1366eae68e4SMasahiro Yamada    /cpu		CPU specific files
1376eae68e4SMasahiro Yamada      /arc700		Files specific to ARC 700 CPUs
1386eae68e4SMasahiro Yamada    /lib		Architecture specific library files
1398d321b81SPeter Tyser  /arm			Files generic to ARM architecture
1408d321b81SPeter Tyser    /cpu		CPU specific files
1418d321b81SPeter Tyser      /arm720t		Files specific to ARM 720 CPUs
1428d321b81SPeter Tyser      /arm920t		Files specific to ARM 920 CPUs
1436eb0921aSAndreas Bießmann	/at91		Files specific to Atmel AT91RM9200 CPU
1448d321b81SPeter Tyser	/imx		Files specific to Freescale MC9328 i.MX CPUs
1458d321b81SPeter Tyser	/s3c24x0	Files specific to Samsung S3C24X0 CPUs
1468d321b81SPeter Tyser      /arm926ejs	Files specific to ARM 926 CPUs
1478d321b81SPeter Tyser      /arm1136		Files specific to ARM 1136 CPUs
1488d321b81SPeter Tyser      /pxa		Files specific to Intel XScale PXA CPUs
1498d321b81SPeter Tyser      /sa1100		Files specific to Intel StrongARM SA1100 CPUs
1508d321b81SPeter Tyser    /lib		Architecture specific library files
1518d321b81SPeter Tyser  /avr32		Files generic to AVR32 architecture
1528d321b81SPeter Tyser    /cpu		CPU specific files
1538d321b81SPeter Tyser    /lib		Architecture specific library files
1548d321b81SPeter Tyser  /blackfin		Files generic to Analog Devices Blackfin architecture
1558d321b81SPeter Tyser    /cpu		CPU specific files
1568d321b81SPeter Tyser    /lib		Architecture specific library files
1578d321b81SPeter Tyser  /m68k			Files generic to m68k architecture
1588d321b81SPeter Tyser    /cpu		CPU specific files
1598d321b81SPeter Tyser      /mcf52x2		Files specific to Freescale ColdFire MCF52x2 CPUs
1608d321b81SPeter Tyser      /mcf5227x		Files specific to Freescale ColdFire MCF5227x CPUs
1618d321b81SPeter Tyser      /mcf532x		Files specific to Freescale ColdFire MCF5329 CPUs
1628d321b81SPeter Tyser      /mcf5445x		Files specific to Freescale ColdFire MCF5445x CPUs
1638d321b81SPeter Tyser      /mcf547x_8x	Files specific to Freescale ColdFire MCF547x_8x CPUs
1648d321b81SPeter Tyser    /lib		Architecture specific library files
1658d321b81SPeter Tyser  /microblaze		Files generic to microblaze architecture
1668d321b81SPeter Tyser    /cpu		CPU specific files
1678d321b81SPeter Tyser    /lib		Architecture specific library files
1688d321b81SPeter Tyser  /mips			Files generic to MIPS architecture
1698d321b81SPeter Tyser    /cpu		CPU specific files
17092bbd64eSDaniel Schwierzeck      /mips32		Files specific to MIPS32 CPUs
1716eae68e4SMasahiro Yamada      /mips64		Files specific to MIPS64 CPUs
1728d321b81SPeter Tyser    /lib		Architecture specific library files
173afc1ce82SMacpaul Lin  /nds32		Files generic to NDS32 architecture
174afc1ce82SMacpaul Lin    /cpu		CPU specific files
175afc1ce82SMacpaul Lin      /n1213		Files specific to Andes Technology N1213 CPUs
176afc1ce82SMacpaul Lin    /lib		Architecture specific library files
1778d321b81SPeter Tyser  /nios2		Files generic to Altera NIOS2 architecture
1788d321b81SPeter Tyser    /cpu		CPU specific files
1798d321b81SPeter Tyser    /lib		Architecture specific library files
18033c7731bSRobert P. J. Day  /openrisc		Files generic to OpenRISC architecture
18133c7731bSRobert P. J. Day    /cpu		CPU specific files
18233c7731bSRobert P. J. Day    /lib		Architecture specific library files
183a47a12beSStefan Roese  /powerpc		Files generic to PowerPC architecture
1848d321b81SPeter Tyser    /cpu		CPU specific files
1858d321b81SPeter Tyser      /74xx_7xx		Files specific to Freescale MPC74xx and 7xx CPUs
1868d321b81SPeter Tyser      /mpc5xx		Files specific to Freescale MPC5xx CPUs
1878d321b81SPeter Tyser      /mpc5xxx		Files specific to Freescale MPC5xxx CPUs
1888d321b81SPeter Tyser      /mpc8xx		Files specific to Freescale MPC8xx CPUs
1898d321b81SPeter Tyser      /mpc824x		Files specific to Freescale MPC824x CPUs
1908d321b81SPeter Tyser      /mpc8260		Files specific to Freescale MPC8260 CPUs
1918d321b81SPeter Tyser      /mpc85xx		Files specific to Freescale MPC85xx CPUs
1928d321b81SPeter Tyser      /ppc4xx		Files specific to AMCC PowerPC 4xx CPUs
1938d321b81SPeter Tyser    /lib		Architecture specific library files
1948d321b81SPeter Tyser  /sh			Files generic to SH architecture
1958d321b81SPeter Tyser    /cpu		CPU specific files
1968d321b81SPeter Tyser      /sh2		Files specific to sh2 CPUs
1978d321b81SPeter Tyser      /sh3		Files specific to sh3 CPUs
1988d321b81SPeter Tyser      /sh4		Files specific to sh4 CPUs
1998d321b81SPeter Tyser    /lib		Architecture specific library files
2008d321b81SPeter Tyser  /sparc		Files generic to SPARC architecture
2018d321b81SPeter Tyser    /cpu		CPU specific files
2028d321b81SPeter Tyser      /leon2		Files specific to Gaisler LEON2 SPARC CPU
2038d321b81SPeter Tyser      /leon3		Files specific to Gaisler LEON3 SPARC CPU
2048d321b81SPeter Tyser    /lib		Architecture specific library files
20533c7731bSRobert P. J. Day  /x86			Files generic to x86 architecture
20633c7731bSRobert P. J. Day    /cpu		CPU specific files
20733c7731bSRobert P. J. Day    /lib		Architecture specific library files
2088d321b81SPeter Tyser/api			Machine/arch independent API for external apps
2098d321b81SPeter Tyser/board			Board dependent files
2108d321b81SPeter Tyser/common			Misc architecture independent functions
2118d321b81SPeter Tyser/disk			Code for disk drive partition handling
2128d321b81SPeter Tyser/doc			Documentation (don't expect too much)
2138d321b81SPeter Tyser/drivers		Commonly used device drivers
21433c7731bSRobert P. J. Day/dts			Contains Makefile for building internal U-Boot fdt.
2158d321b81SPeter Tyser/examples		Example code for standalone applications, etc.
2168d321b81SPeter Tyser/fs			Filesystem code (cramfs, ext2, jffs2, etc.)
2178d321b81SPeter Tyser/include		Header Files
2188d321b81SPeter Tyser/lib			Files generic to all architectures
2198d321b81SPeter Tyser  /libfdt		Library files to support flattened device trees
2208d321b81SPeter Tyser  /lzma			Library files to support LZMA decompression
2218d321b81SPeter Tyser  /lzo			Library files to support LZO decompression
2228d321b81SPeter Tyser/net			Networking code
2238d321b81SPeter Tyser/post			Power On Self Test
22433c7731bSRobert P. J. Day/spl			Secondary Program Loader framework
2258d321b81SPeter Tyser/tools			Tools to build S-Record or U-Boot images, etc.
226c609719bSwdenk
227c609719bSwdenkSoftware Configuration:
228c609719bSwdenk=======================
229c609719bSwdenk
230c609719bSwdenkConfiguration is usually done using C preprocessor defines; the
231c609719bSwdenkrationale behind that is to avoid dead code whenever possible.
232c609719bSwdenk
233c609719bSwdenkThere are two classes of configuration variables:
234c609719bSwdenk
235c609719bSwdenk* Configuration _OPTIONS_:
236c609719bSwdenk  These are selectable by the user and have names beginning with
237c609719bSwdenk  "CONFIG_".
238c609719bSwdenk
239c609719bSwdenk* Configuration _SETTINGS_:
240c609719bSwdenk  These depend on the hardware etc. and should not be meddled with if
241c609719bSwdenk  you don't know what you're doing; they have names beginning with
2426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  "CONFIG_SYS_".
243c609719bSwdenk
244c609719bSwdenkLater we will add a configuration tool - probably similar to or even
245c609719bSwdenkidentical to what's used for the Linux kernel. Right now, we have to
246c609719bSwdenkdo the configuration by hand, which means creating some symbolic
247c609719bSwdenklinks and editing some configuration files. We use the TQM8xxL boards
248c609719bSwdenkas an example here.
249c609719bSwdenk
250c609719bSwdenk
251c609719bSwdenkSelection of Processor Architecture and Board Type:
252c609719bSwdenk---------------------------------------------------
253c609719bSwdenk
254c609719bSwdenkFor all supported boards there are ready-to-use default
255ab584d67SHolger Freytherconfigurations available; just type "make <board_name>_defconfig".
256c609719bSwdenk
257c609719bSwdenkExample: For a TQM823L module type:
258c609719bSwdenk
259c609719bSwdenk	cd u-boot
260ab584d67SHolger Freyther	make TQM823L_defconfig
261c609719bSwdenk
26211ccc33fSMarcel ZiswilerFor the Cogent platform, you need to specify the CPU type as well;
263ab584d67SHolger Freythere.g. "make cogent_mpc8xx_defconfig". And also configure the cogent
264c609719bSwdenkdirectory according to the instructions in cogent/README.
265c609719bSwdenk
266c609719bSwdenk
26775b3c3aaSSimon GlassSandbox Environment:
26875b3c3aaSSimon Glass--------------------
26975b3c3aaSSimon Glass
27075b3c3aaSSimon GlassU-Boot can be built natively to run on a Linux host using the 'sandbox'
27175b3c3aaSSimon Glassboard. This allows feature development which is not board- or architecture-
27275b3c3aaSSimon Glassspecific to be undertaken on a native platform. The sandbox is also used to
27375b3c3aaSSimon Glassrun some of U-Boot's tests.
27475b3c3aaSSimon Glass
2756b1978f8SJagannadha Sutradharudu TekiSee board/sandbox/README.sandbox for more details.
27675b3c3aaSSimon Glass
27775b3c3aaSSimon Glass
278c609719bSwdenkConfiguration Options:
279c609719bSwdenk----------------------
280c609719bSwdenk
281c609719bSwdenkConfiguration depends on the combination of board and CPU type; all
282c609719bSwdenksuch information is kept in a configuration file
283c609719bSwdenk"include/configs/<board_name>.h".
284c609719bSwdenk
285c609719bSwdenkExample: For a TQM823L module, all configuration settings are in
286c609719bSwdenk"include/configs/TQM823L.h".
287c609719bSwdenk
288c609719bSwdenk
2897f6c2cbcSwdenkMany of the options are named exactly as the corresponding Linux
2907f6c2cbcSwdenkkernel configuration options. The intention is to make it easier to
2917f6c2cbcSwdenkbuild a config tool - later.
2927f6c2cbcSwdenk
2937f6c2cbcSwdenk
294c609719bSwdenkThe following options need to be configured:
295c609719bSwdenk
2962628114eSKim Phillips- CPU Type:	Define exactly one, e.g. CONFIG_MPC85XX.
297c609719bSwdenk
2982628114eSKim Phillips- Board Type:	Define exactly one, e.g. CONFIG_MPC8540ADS.
2996ccec449SWolfgang Denk
3006ccec449SWolfgang Denk- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
30109ea0de0SHaavard Skinnemoen		Define exactly one, e.g. CONFIG_ATSTK1002
302c609719bSwdenk
303c609719bSwdenk- CPU Module Type: (if CONFIG_COGENT is defined)
304c609719bSwdenk		Define exactly one of
305c609719bSwdenk		CONFIG_CMA286_60_OLD
306c609719bSwdenk--- FIXME --- not tested yet:
307c609719bSwdenk		CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
308c609719bSwdenk		CONFIG_CMA287_23, CONFIG_CMA287_50
309c609719bSwdenk
310c609719bSwdenk- Motherboard Type: (if CONFIG_COGENT is defined)
311c609719bSwdenk		Define exactly one of
312c609719bSwdenk		CONFIG_CMA101, CONFIG_CMA102
313c609719bSwdenk
314c609719bSwdenk- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
315c609719bSwdenk		Define one or more of
316c609719bSwdenk		CONFIG_CMA302
317c609719bSwdenk
318c609719bSwdenk- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
319c609719bSwdenk		Define one or more of
320c609719bSwdenk		CONFIG_LCD_HEARTBEAT	- update a character position on
32111ccc33fSMarcel Ziswiler					  the LCD display every second with
322c609719bSwdenk					  a "rotator" |\-/|\-/
323c609719bSwdenk
324cf946c6dSLei Wen- Marvell Family Member
325cf946c6dSLei Wen		CONFIG_SYS_MVFS		- define it if you want to enable
326cf946c6dSLei Wen					  multiple fs option at one time
327cf946c6dSLei Wen					  for marvell soc family
328cf946c6dSLei Wen
329c609719bSwdenk- MPC824X Family Member (if CONFIG_MPC824X is defined)
330c609719bSwdenk		Define exactly one of
331c609719bSwdenk		CONFIG_MPC8240, CONFIG_MPC8245
332c609719bSwdenk
33311ccc33fSMarcel Ziswiler- 8xx CPU Options: (if using an MPC8xx CPU)
33466ca92a5Swdenk		CONFIG_8xx_GCLK_FREQ	- deprecated: CPU clock if
33566ca92a5Swdenk					  get_gclk_freq() cannot work
3365da627a4Swdenk					  e.g. if there is no 32KHz
3375da627a4Swdenk					  reference PIT/RTC clock
33866ca92a5Swdenk		CONFIG_8xx_OSCLK	- PLL input clock (either EXTCLK
33966ca92a5Swdenk					  or XTAL/EXTAL)
340c609719bSwdenk
34166ca92a5Swdenk- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
3426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MIN
3436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MAX
34466ca92a5Swdenk		CONFIG_8xx_CPUCLK_DEFAULT
34575d1ea7fSwdenk			See doc/README.MPC866
34675d1ea7fSwdenk
3476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MEASURE_CPUCLK
34875d1ea7fSwdenk
34975d1ea7fSwdenk		Define this to measure the actual CPU clock instead
35075d1ea7fSwdenk		of relying on the correctness of the configured
35175d1ea7fSwdenk		values. Mostly useful for board bringup to make sure
35275d1ea7fSwdenk		the PLL is locked at the intended frequency. Note
35375d1ea7fSwdenk		that this requires a (stable) reference clock (32 kHz
3546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		RTC clock or CONFIG_SYS_8XX_XIN)
35575d1ea7fSwdenk
356506f3918SHeiko Schocher		CONFIG_SYS_DELAYED_ICACHE
357506f3918SHeiko Schocher
358506f3918SHeiko Schocher		Define this option if you want to enable the
359506f3918SHeiko Schocher		ICache only when Code runs from RAM.
360506f3918SHeiko Schocher
36166412c63SKumar Gala- 85xx CPU Options:
362ffd06e02SYork Sun		CONFIG_SYS_PPC64
363ffd06e02SYork Sun
364ffd06e02SYork Sun		Specifies that the core is a 64-bit PowerPC implementation (implements
365ffd06e02SYork Sun		the "64" category of the Power ISA). This is necessary for ePAPR
366ffd06e02SYork Sun		compliance, among other possible reasons.
367ffd06e02SYork Sun
36866412c63SKumar Gala		CONFIG_SYS_FSL_TBCLK_DIV
36966412c63SKumar Gala
37066412c63SKumar Gala		Defines the core time base clock divider ratio compared to the
37166412c63SKumar Gala		system clock.  On most PQ3 devices this is 8, on newer QorIQ
37266412c63SKumar Gala		devices it can be 16 or 32.  The ratio varies from SoC to Soc.
37366412c63SKumar Gala
3748f29084aSKumar Gala		CONFIG_SYS_FSL_PCIE_COMPAT
3758f29084aSKumar Gala
3768f29084aSKumar Gala		Defines the string to utilize when trying to match PCIe device
3778f29084aSKumar Gala		tree nodes for the given platform.
3788f29084aSKumar Gala
379afa6b551SPrabhakar Kushwaha		CONFIG_SYS_PPC_E500_DEBUG_TLB
380afa6b551SPrabhakar Kushwaha
381afa6b551SPrabhakar Kushwaha		Enables a temporary TLB entry to be used during boot to work
382afa6b551SPrabhakar Kushwaha		around limitations in e500v1 and e500v2 external debugger
383afa6b551SPrabhakar Kushwaha		support. This reduces the portions of the boot code where
384afa6b551SPrabhakar Kushwaha		breakpoints and single stepping do not work.  The value of this
385afa6b551SPrabhakar Kushwaha		symbol should be set to the TLB1 entry to be used for this
386afa6b551SPrabhakar Kushwaha		purpose.
387afa6b551SPrabhakar Kushwaha
38833eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510
38933eee330SScott Wood
39033eee330SScott Wood		Enables a workaround for erratum A004510.  If set,
39133eee330SScott Wood		then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
39233eee330SScott Wood		CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
39333eee330SScott Wood
39433eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
39533eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
39633eee330SScott Wood
39733eee330SScott Wood		Defines one or two SoC revisions (low 8 bits of SVR)
39833eee330SScott Wood		for which the A004510 workaround should be applied.
39933eee330SScott Wood
40033eee330SScott Wood		The rest of SVR is either not relevant to the decision
40133eee330SScott Wood		of whether the erratum is present (e.g. p2040 versus
40233eee330SScott Wood		p2041) or is implied by the build target, which controls
40333eee330SScott Wood		whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
40433eee330SScott Wood
40533eee330SScott Wood		See Freescale App Note 4493 for more information about
40633eee330SScott Wood		this erratum.
40733eee330SScott Wood
40874fa22edSPrabhakar Kushwaha		CONFIG_A003399_NOR_WORKAROUND
40974fa22edSPrabhakar Kushwaha		Enables a workaround for IFC erratum A003399. It is only
41074fa22edSPrabhakar Kushwaha		requred during NOR boot.
41174fa22edSPrabhakar Kushwaha
41233eee330SScott Wood		CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
41333eee330SScott Wood
41433eee330SScott Wood		This is the value to write into CCSR offset 0x18600
41533eee330SScott Wood		according to the A004510 workaround.
41633eee330SScott Wood
41764501c66SPriyanka Jain		CONFIG_SYS_FSL_DSP_DDR_ADDR
41864501c66SPriyanka Jain		This value denotes start offset of DDR memory which is
41964501c66SPriyanka Jain		connected exclusively to the DSP cores.
42064501c66SPriyanka Jain
421765b0bdbSPriyanka Jain		CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
422765b0bdbSPriyanka Jain		This value denotes start offset of M2 memory
423765b0bdbSPriyanka Jain		which is directly connected to the DSP core.
424765b0bdbSPriyanka Jain
42564501c66SPriyanka Jain		CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
42664501c66SPriyanka Jain		This value denotes start offset of M3 memory which is directly
42764501c66SPriyanka Jain		connected to the DSP core.
42864501c66SPriyanka Jain
429765b0bdbSPriyanka Jain		CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
430765b0bdbSPriyanka Jain		This value denotes start offset of DSP CCSR space.
431765b0bdbSPriyanka Jain
432b135991aSPriyanka Jain		CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
433b135991aSPriyanka Jain		Single Source Clock is clocking mode present in some of FSL SoC's.
434b135991aSPriyanka Jain		In this mode, a single differential clock is used to supply
435b135991aSPriyanka Jain		clocks to the sysclock, ddrclock and usbclock.
436b135991aSPriyanka Jain
437fb4a2409SAneesh Bansal		CONFIG_SYS_CPC_REINIT_F
438fb4a2409SAneesh Bansal		This CONFIG is defined when the CPC is configured as SRAM at the
439fb4a2409SAneesh Bansal		time of U-boot entry and is required to be re-initialized.
440fb4a2409SAneesh Bansal
441aade2004STang Yuantian		CONFIG_DEEP_SLEEP
442aade2004STang Yuantian		Inidcates this SoC supports deep sleep feature. If deep sleep is
443aade2004STang Yuantian		supported, core will start to execute uboot when wakes up.
444aade2004STang Yuantian
4456cb461b4SDaniel Schwierzeck- Generic CPU options:
4462a1680e3SYork Sun		CONFIG_SYS_GENERIC_GLOBAL_DATA
4472a1680e3SYork Sun		Defines global data is initialized in generic board board_init_f().
4482a1680e3SYork Sun		If this macro is defined, global data is created and cleared in
4492a1680e3SYork Sun		generic board board_init_f(). Without this macro, architecture/board
4502a1680e3SYork Sun		should initialize global data before calling board_init_f().
4512a1680e3SYork Sun
4526cb461b4SDaniel Schwierzeck		CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
4536cb461b4SDaniel Schwierzeck
4546cb461b4SDaniel Schwierzeck		Defines the endianess of the CPU. Implementation of those
4556cb461b4SDaniel Schwierzeck		values is arch specific.
4566cb461b4SDaniel Schwierzeck
4575614e71bSYork Sun		CONFIG_SYS_FSL_DDR
4585614e71bSYork Sun		Freescale DDR driver in use. This type of DDR controller is
4595614e71bSYork Sun		found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
4605614e71bSYork Sun		SoCs.
4615614e71bSYork Sun
4625614e71bSYork Sun		CONFIG_SYS_FSL_DDR_ADDR
4635614e71bSYork Sun		Freescale DDR memory-mapped register base.
4645614e71bSYork Sun
4655614e71bSYork Sun		CONFIG_SYS_FSL_DDR_EMU
4665614e71bSYork Sun		Specify emulator support for DDR. Some DDR features such as
4675614e71bSYork Sun		deskew training are not available.
4685614e71bSYork Sun
4695614e71bSYork Sun		CONFIG_SYS_FSL_DDRC_GEN1
4705614e71bSYork Sun		Freescale DDR1 controller.
4715614e71bSYork Sun
4725614e71bSYork Sun		CONFIG_SYS_FSL_DDRC_GEN2
4735614e71bSYork Sun		Freescale DDR2 controller.
4745614e71bSYork Sun
4755614e71bSYork Sun		CONFIG_SYS_FSL_DDRC_GEN3
4765614e71bSYork Sun		Freescale DDR3 controller.
4775614e71bSYork Sun
47834e026f9SYork Sun		CONFIG_SYS_FSL_DDRC_GEN4
47934e026f9SYork Sun		Freescale DDR4 controller.
48034e026f9SYork Sun
4819ac4ffbdSYork Sun		CONFIG_SYS_FSL_DDRC_ARM_GEN3
4829ac4ffbdSYork Sun		Freescale DDR3 controller for ARM-based SoCs.
4839ac4ffbdSYork Sun
4845614e71bSYork Sun		CONFIG_SYS_FSL_DDR1
4855614e71bSYork Sun		Board config to use DDR1. It can be enabled for SoCs with
4865614e71bSYork Sun		Freescale DDR1 or DDR2 controllers, depending on the board
4875614e71bSYork Sun		implemetation.
4885614e71bSYork Sun
4895614e71bSYork Sun		CONFIG_SYS_FSL_DDR2
4905614e71bSYork Sun		Board config to use DDR2. It can be eanbeld for SoCs with
4915614e71bSYork Sun		Freescale DDR2 or DDR3 controllers, depending on the board
4925614e71bSYork Sun		implementation.
4935614e71bSYork Sun
4945614e71bSYork Sun		CONFIG_SYS_FSL_DDR3
4955614e71bSYork Sun		Board config to use DDR3. It can be enabled for SoCs with
49634e026f9SYork Sun		Freescale DDR3 or DDR3L controllers.
49734e026f9SYork Sun
49834e026f9SYork Sun		CONFIG_SYS_FSL_DDR3L
49934e026f9SYork Sun		Board config to use DDR3L. It can be enabled for SoCs with
50034e026f9SYork Sun		DDR3L controllers.
50134e026f9SYork Sun
50234e026f9SYork Sun		CONFIG_SYS_FSL_DDR4
50334e026f9SYork Sun		Board config to use DDR4. It can be enabled for SoCs with
50434e026f9SYork Sun		DDR4 controllers.
5055614e71bSYork Sun
5061b4175d6SPrabhakar Kushwaha		CONFIG_SYS_FSL_IFC_BE
5071b4175d6SPrabhakar Kushwaha		Defines the IFC controller register space as Big Endian
5081b4175d6SPrabhakar Kushwaha
5091b4175d6SPrabhakar Kushwaha		CONFIG_SYS_FSL_IFC_LE
5101b4175d6SPrabhakar Kushwaha		Defines the IFC controller register space as Little Endian
5111b4175d6SPrabhakar Kushwaha
512690e4258SPrabhakar Kushwaha		CONFIG_SYS_FSL_PBL_PBI
513690e4258SPrabhakar Kushwaha		It enables addition of RCW (Power on reset configuration) in built image.
514690e4258SPrabhakar Kushwaha		Please refer doc/README.pblimage for more details
515690e4258SPrabhakar Kushwaha
516690e4258SPrabhakar Kushwaha		CONFIG_SYS_FSL_PBL_RCW
517690e4258SPrabhakar Kushwaha		It adds PBI(pre-boot instructions) commands in u-boot build image.
518690e4258SPrabhakar Kushwaha		PBI commands can be used to configure SoC before it starts the execution.
519690e4258SPrabhakar Kushwaha		Please refer doc/README.pblimage for more details
520690e4258SPrabhakar Kushwaha
52189ad7be8SPrabhakar Kushwaha		CONFIG_SPL_FSL_PBL
52289ad7be8SPrabhakar Kushwaha		It adds a target to create boot binary having SPL binary in PBI format
52389ad7be8SPrabhakar Kushwaha		concatenated with u-boot binary.
52489ad7be8SPrabhakar Kushwaha
5254e5b1bd0SYork Sun		CONFIG_SYS_FSL_DDR_BE
5264e5b1bd0SYork Sun		Defines the DDR controller register space as Big Endian
5274e5b1bd0SYork Sun
5284e5b1bd0SYork Sun		CONFIG_SYS_FSL_DDR_LE
5294e5b1bd0SYork Sun		Defines the DDR controller register space as Little Endian
5304e5b1bd0SYork Sun
5316b9e309aSYork Sun		CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
5326b9e309aSYork Sun		Physical address from the view of DDR controllers. It is the
5336b9e309aSYork Sun		same as CONFIG_SYS_DDR_SDRAM_BASE for  all Power SoCs. But
5346b9e309aSYork Sun		it could be different for ARM SoCs.
5356b9e309aSYork Sun
5366b1e1254SYork Sun		CONFIG_SYS_FSL_DDR_INTLV_256B
5376b1e1254SYork Sun		DDR controller interleaving on 256-byte. This is a special
5386b1e1254SYork Sun		interleaving mode, handled by Dickens for Freescale layerscape
5396b1e1254SYork Sun		SoCs with ARM core.
5406b1e1254SYork Sun
5411d71efbbSYork Sun		CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
5421d71efbbSYork Sun		Number of controllers used as main memory.
5431d71efbbSYork Sun
5441d71efbbSYork Sun		CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
5451d71efbbSYork Sun		Number of controllers used for other than main memory.
5461d71efbbSYork Sun
547028dbb8dSRuchika Gupta		CONFIG_SYS_FSL_SEC_BE
548028dbb8dSRuchika Gupta		Defines the SEC controller register space as Big Endian
549028dbb8dSRuchika Gupta
550028dbb8dSRuchika Gupta		CONFIG_SYS_FSL_SEC_LE
551028dbb8dSRuchika Gupta		Defines the SEC controller register space as Little Endian
552028dbb8dSRuchika Gupta
5530b953ffcSMarkus Klotzbuecher- Intel Monahans options:
5546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
5550b953ffcSMarkus Klotzbuecher
5560b953ffcSMarkus Klotzbuecher		Defines the Monahans run mode to oscillator
5570b953ffcSMarkus Klotzbuecher		ratio. Valid values are 8, 16, 24, 31. The core
5580b953ffcSMarkus Klotzbuecher		frequency is this value multiplied by 13 MHz.
5590b953ffcSMarkus Klotzbuecher
5606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
5610b953ffcSMarkus Klotzbuecher
5620b953ffcSMarkus Klotzbuecher		Defines the Monahans turbo mode to oscillator
5630b953ffcSMarkus Klotzbuecher		ratio. Valid values are 1 (default if undefined) and
5640b953ffcSMarkus Klotzbuecher		2. The core frequency as calculated above is multiplied
5650b953ffcSMarkus Klotzbuecher		by this value.
5660b953ffcSMarkus Klotzbuecher
56792bbd64eSDaniel Schwierzeck- MIPS CPU options:
56892bbd64eSDaniel Schwierzeck		CONFIG_SYS_INIT_SP_OFFSET
56992bbd64eSDaniel Schwierzeck
57092bbd64eSDaniel Schwierzeck		Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
57192bbd64eSDaniel Schwierzeck		pointer. This is needed for the temporary stack before
57292bbd64eSDaniel Schwierzeck		relocation.
57392bbd64eSDaniel Schwierzeck
57492bbd64eSDaniel Schwierzeck		CONFIG_SYS_MIPS_CACHE_MODE
57592bbd64eSDaniel Schwierzeck
57692bbd64eSDaniel Schwierzeck		Cache operation mode for the MIPS CPU.
57792bbd64eSDaniel Schwierzeck		See also arch/mips/include/asm/mipsregs.h.
57892bbd64eSDaniel Schwierzeck		Possible values are:
57992bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_NO_WA
58092bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_WA
58192bbd64eSDaniel Schwierzeck			CONF_CM_UNCACHED
58292bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_NONCOHERENT
58392bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_CE
58492bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_COW
58592bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_CUW
58692bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_ACCELERATED
58792bbd64eSDaniel Schwierzeck
58892bbd64eSDaniel Schwierzeck		CONFIG_SYS_XWAY_EBU_BOOTCFG
58992bbd64eSDaniel Schwierzeck
59092bbd64eSDaniel Schwierzeck		Special option for Lantiq XWAY SoCs for booting from NOR flash.
59192bbd64eSDaniel Schwierzeck		See also arch/mips/cpu/mips32/start.S.
59292bbd64eSDaniel Schwierzeck
59392bbd64eSDaniel Schwierzeck		CONFIG_XWAY_SWAP_BYTES
59492bbd64eSDaniel Schwierzeck
59592bbd64eSDaniel Schwierzeck		Enable compilation of tools/xway-swap-bytes needed for Lantiq
59692bbd64eSDaniel Schwierzeck		XWAY SoCs for booting from NOR flash. The U-Boot image needs to
59792bbd64eSDaniel Schwierzeck		be swapped if a flash programmer is used.
59892bbd64eSDaniel Schwierzeck
599b67d8816SChristian Riesch- ARM options:
600b67d8816SChristian Riesch		CONFIG_SYS_EXCEPTION_VECTORS_HIGH
601b67d8816SChristian Riesch
602b67d8816SChristian Riesch		Select high exception vectors of the ARM core, e.g., do not
603b67d8816SChristian Riesch		clear the V bit of the c1 register of CP15.
604b67d8816SChristian Riesch
6055356f545SAneesh V		CONFIG_SYS_THUMB_BUILD
6065356f545SAneesh V
6075356f545SAneesh V		Use this flag to build U-Boot using the Thumb instruction
6085356f545SAneesh V		set for ARM architectures. Thumb instruction set provides
6095356f545SAneesh V		better code density. For ARM architectures that support
6105356f545SAneesh V		Thumb2 this flag will result in Thumb2 code generated by
6115356f545SAneesh V		GCC.
6125356f545SAneesh V
613c5d4752cSStephen Warren		CONFIG_ARM_ERRATA_716044
6140678587fSStephen Warren		CONFIG_ARM_ERRATA_742230
6150678587fSStephen Warren		CONFIG_ARM_ERRATA_743622
6160678587fSStephen Warren		CONFIG_ARM_ERRATA_751472
617f71cbfe3SNitin Garg		CONFIG_ARM_ERRATA_794072
618b7588e3bSNitin Garg		CONFIG_ARM_ERRATA_761320
6190678587fSStephen Warren
6200678587fSStephen Warren		If set, the workarounds for these ARM errata are applied early
6210678587fSStephen Warren		during U-Boot startup. Note that these options force the
6220678587fSStephen Warren		workarounds to be applied; no CPU-type/version detection
6230678587fSStephen Warren		exists, unlike the similar options in the Linux kernel. Do not
6240678587fSStephen Warren		set these options unless they apply!
6250678587fSStephen Warren
6265da627a4Swdenk- Linux Kernel Interface:
627c609719bSwdenk		CONFIG_CLOCKS_IN_MHZ
628c609719bSwdenk
629c609719bSwdenk		U-Boot stores all clock information in Hz
630c609719bSwdenk		internally. For binary compatibility with older Linux
631c609719bSwdenk		kernels (which expect the clocks passed in the
632c609719bSwdenk		bd_info data to be in MHz) the environment variable
633c609719bSwdenk		"clocks_in_mhz" can be defined so that U-Boot
634c609719bSwdenk		converts clock data to MHZ before passing it to the
635c609719bSwdenk		Linux kernel.
636c609719bSwdenk		When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
637c609719bSwdenk		"clocks_in_mhz=1" is automatically included in the
638c609719bSwdenk		default environment.
639c609719bSwdenk
6405da627a4Swdenk		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]
6415da627a4Swdenk
64211ccc33fSMarcel Ziswiler		When transferring memsize parameter to linux, some versions
6435da627a4Swdenk		expect it to be in bytes, others in MB.
6445da627a4Swdenk		Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
6455da627a4Swdenk
646fec6d9eeSGerald Van Baren		CONFIG_OF_LIBFDT
647f57f70aaSWolfgang Denk
648f57f70aaSWolfgang Denk		New kernel versions are expecting firmware settings to be
649213bf8c8SGerald Van Baren		passed using flattened device trees (based on open firmware
650213bf8c8SGerald Van Baren		concepts).
651213bf8c8SGerald Van Baren
652213bf8c8SGerald Van Baren		CONFIG_OF_LIBFDT
653213bf8c8SGerald Van Baren		 * New libfdt-based support
654213bf8c8SGerald Van Baren		 * Adds the "fdt" command
6553bb342fcSKim Phillips		 * The bootm command automatically updates the fdt
656213bf8c8SGerald Van Baren
657b55ae402SMarcel Ziswiler		OF_CPU - The proper name of the cpus node (only required for
658b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
659b55ae402SMarcel Ziswiler		OF_SOC - The proper name of the soc node (only required for
660b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
661f57f70aaSWolfgang Denk		OF_TBCLK - The timebase frequency.
662c2871f03SKumar Gala		OF_STDOUT_PATH - The path to the console device
663f57f70aaSWolfgang Denk
66411ccc33fSMarcel Ziswiler		boards with QUICC Engines require OF_QE to set UCC MAC
66511ccc33fSMarcel Ziswiler		addresses
6663bb342fcSKim Phillips
6674e253137SKumar Gala		CONFIG_OF_BOARD_SETUP
6684e253137SKumar Gala
6694e253137SKumar Gala		Board code has addition modification that it wants to make
6704e253137SKumar Gala		to the flat device tree before handing it off to the kernel
6716705d81eSwdenk
6720267768eSMatthew McClintock		CONFIG_OF_BOOT_CPU
6730267768eSMatthew McClintock
67411ccc33fSMarcel Ziswiler		This define fills in the correct boot CPU in the boot
6750267768eSMatthew McClintock		param header, the default value is zero if undefined.
6760267768eSMatthew McClintock
6773887c3fbSHeiko Schocher		CONFIG_OF_IDE_FIXUP
6783887c3fbSHeiko Schocher
6793887c3fbSHeiko Schocher		U-Boot can detect if an IDE device is present or not.
6803887c3fbSHeiko Schocher		If not, and this new config option is activated, U-Boot
6813887c3fbSHeiko Schocher		removes the ATA node from the DTS before booting Linux,
6823887c3fbSHeiko Schocher		so the Linux IDE driver does not probe the device and
6833887c3fbSHeiko Schocher		crash. This is needed for buggy hardware (uc101) where
6843887c3fbSHeiko Schocher		no pull down resistor is connected to the signal IDE5V_DD7.
6853887c3fbSHeiko Schocher
6867eb29398SIgor Grinberg		CONFIG_MACH_TYPE	[relevant for ARM only][mandatory]
6877eb29398SIgor Grinberg
6887eb29398SIgor Grinberg		This setting is mandatory for all boards that have only one
6897eb29398SIgor Grinberg		machine type and must be used to specify the machine type
6907eb29398SIgor Grinberg		number as it appears in the ARM machine registry
6917eb29398SIgor Grinberg		(see http://www.arm.linux.org.uk/developer/machines/).
6927eb29398SIgor Grinberg		Only boards that have multiple machine types supported
6937eb29398SIgor Grinberg		in a single configuration file and the machine type is
6947eb29398SIgor Grinberg		runtime discoverable, do not have to use this setting.
6957eb29398SIgor Grinberg
6960b2f4ecaSNiklaus Giger- vxWorks boot parameters:
6970b2f4ecaSNiklaus Giger
6980b2f4ecaSNiklaus Giger		bootvx constructs a valid bootline using the following
6990b2f4ecaSNiklaus Giger		environments variables: bootfile, ipaddr, serverip, hostname.
7000b2f4ecaSNiklaus Giger		It loads the vxWorks image pointed bootfile.
7010b2f4ecaSNiklaus Giger
7020b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
7030b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
7040b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
7050b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
7060b2f4ecaSNiklaus Giger
7070b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_ADD_PARAMS
7080b2f4ecaSNiklaus Giger
7090b2f4ecaSNiklaus Giger		Add it at the end of the bootline. E.g "u=username pw=secret"
7100b2f4ecaSNiklaus Giger
7110b2f4ecaSNiklaus Giger		Note: If a "bootargs" environment is defined, it will overwride
7120b2f4ecaSNiklaus Giger		the defaults discussed just above.
7130b2f4ecaSNiklaus Giger
7142c451f78SAneesh V- Cache Configuration:
7152c451f78SAneesh V		CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
7162c451f78SAneesh V		CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
7172c451f78SAneesh V		CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
7182c451f78SAneesh V
71993bc2193SAneesh V- Cache Configuration for ARM:
72093bc2193SAneesh V		CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
72193bc2193SAneesh V				      controller
72293bc2193SAneesh V		CONFIG_SYS_PL310_BASE - Physical base address of PL310
72393bc2193SAneesh V					controller register space
72493bc2193SAneesh V
7256705d81eSwdenk- Serial Ports:
72648d0192fSAndreas Engel		CONFIG_PL010_SERIAL
7276705d81eSwdenk
7286705d81eSwdenk		Define this if you want support for Amba PrimeCell PL010 UARTs.
7296705d81eSwdenk
73048d0192fSAndreas Engel		CONFIG_PL011_SERIAL
7316705d81eSwdenk
7326705d81eSwdenk		Define this if you want support for Amba PrimeCell PL011 UARTs.
7336705d81eSwdenk
7346705d81eSwdenk		CONFIG_PL011_CLOCK
7356705d81eSwdenk
7366705d81eSwdenk		If you have Amba PrimeCell PL011 UARTs, set this variable to
7376705d81eSwdenk		the clock speed of the UARTs.
7386705d81eSwdenk
7396705d81eSwdenk		CONFIG_PL01x_PORTS
7406705d81eSwdenk
7416705d81eSwdenk		If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
7426705d81eSwdenk		define this to a list of base addresses for each (supported)
7436705d81eSwdenk		port. See e.g. include/configs/versatile.h
7446705d81eSwdenk
745910f1ae3SJohn Rigby		CONFIG_PL011_SERIAL_RLCR
746910f1ae3SJohn Rigby
747910f1ae3SJohn Rigby		Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
748910f1ae3SJohn Rigby		have separate receive and transmit line control registers.  Set
749910f1ae3SJohn Rigby		this variable to initialize the extra register.
750910f1ae3SJohn Rigby
751910f1ae3SJohn Rigby		CONFIG_PL011_SERIAL_FLUSH_ON_INIT
752910f1ae3SJohn Rigby
753910f1ae3SJohn Rigby		On some platforms (e.g. U8500) U-Boot is loaded by a second stage
754910f1ae3SJohn Rigby		boot loader that has already initialized the UART.  Define this
755910f1ae3SJohn Rigby		variable to flush the UART at init time.
756910f1ae3SJohn Rigby
757d57dee57SKaricheri, Muralidharan		CONFIG_SERIAL_HW_FLOW_CONTROL
758d57dee57SKaricheri, Muralidharan
759d57dee57SKaricheri, Muralidharan		Define this variable to enable hw flow control in serial driver.
760d57dee57SKaricheri, Muralidharan		Current user of this option is drivers/serial/nsl16550.c driver
7616705d81eSwdenk
762c609719bSwdenk- Console Interface:
763c609719bSwdenk		Depending on board, define exactly one serial port
764c609719bSwdenk		(like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
765c609719bSwdenk		CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
766c609719bSwdenk		console by defining CONFIG_8xx_CONS_NONE
767c609719bSwdenk
768c609719bSwdenk		Note: if CONFIG_8xx_CONS_NONE is defined, the serial
769c609719bSwdenk		port routines must be defined elsewhere
770c609719bSwdenk		(i.e. serial_init(), serial_getc(), ...)
771c609719bSwdenk
772c609719bSwdenk		CONFIG_CFB_CONSOLE
773c609719bSwdenk		Enables console device for a color framebuffer. Needs following
774c53043b7SWolfgang Denk		defines (cf. smiLynxEM, i8042)
775c609719bSwdenk			VIDEO_FB_LITTLE_ENDIAN	graphic memory organisation
776c609719bSwdenk						(default big endian)
777c609719bSwdenk			VIDEO_HW_RECTFILL	graphic chip supports
778c609719bSwdenk						rectangle fill
779c609719bSwdenk						(cf. smiLynxEM)
780c609719bSwdenk			VIDEO_HW_BITBLT		graphic chip supports
781c609719bSwdenk						bit-blit (cf. smiLynxEM)
782c609719bSwdenk			VIDEO_VISIBLE_COLS	visible pixel columns
783c609719bSwdenk						(cols=pitch)
784c609719bSwdenk			VIDEO_VISIBLE_ROWS	visible pixel rows
785c609719bSwdenk			VIDEO_PIXEL_SIZE	bytes per pixel
786c609719bSwdenk			VIDEO_DATA_FORMAT	graphic data format
787c609719bSwdenk						(0-5, cf. cfb_console.c)
788c609719bSwdenk			VIDEO_FB_ADRS		framebuffer address
789c609719bSwdenk			VIDEO_KBD_INIT_FCT	keyboard int fct
790c609719bSwdenk						(i.e. i8042_kbd_init())
791c609719bSwdenk			VIDEO_TSTC_FCT		test char fct
792c609719bSwdenk						(i.e. i8042_tstc)
793c609719bSwdenk			VIDEO_GETC_FCT		get char fct
794c609719bSwdenk						(i.e. i8042_getc)
795c609719bSwdenk			CONFIG_CONSOLE_CURSOR	cursor drawing on/off
796c609719bSwdenk						(requires blink timer
797c609719bSwdenk						cf. i8042.c)
7986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
799c609719bSwdenk			CONFIG_CONSOLE_TIME	display time/date info in
800c609719bSwdenk						upper right corner
801602ad3b3SJon Loeliger						(requires CONFIG_CMD_DATE)
802c609719bSwdenk			CONFIG_VIDEO_LOGO	display Linux logo in
803c609719bSwdenk						upper left corner
804a6c7ad2fSwdenk			CONFIG_VIDEO_BMP_LOGO	use bmp_logo.h instead of
805a6c7ad2fSwdenk						linux_logo.h for logo.
806a6c7ad2fSwdenk						Requires CONFIG_VIDEO_LOGO
807c609719bSwdenk			CONFIG_CONSOLE_EXTRA_INFO
80811ccc33fSMarcel Ziswiler						additional board info beside
809c609719bSwdenk						the logo
810c609719bSwdenk
81133a35bbbSPali Rohár		When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
81233a35bbbSPali Rohár		a limited number of ANSI escape sequences (cursor control,
81333a35bbbSPali Rohár		erase functions and limited graphics rendition control).
81433a35bbbSPali Rohár
815c609719bSwdenk		When CONFIG_CFB_CONSOLE is defined, video console is
816c609719bSwdenk		default i/o. Serial console can be forced with
817c609719bSwdenk		environment 'console=serial'.
818c609719bSwdenk
819a3ad8e26Swdenk		When CONFIG_SILENT_CONSOLE is defined, all console
820a3ad8e26Swdenk		messages (by U-Boot and Linux!) can be silenced with
821a3ad8e26Swdenk		the "silent" environment variable. See
822a3ad8e26Swdenk		doc/README.silent for more information.
823a3ad8e26Swdenk
82445ae2546SHeiko Schocher		CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default
82545ae2546SHeiko Schocher			is 0x00.
82645ae2546SHeiko Schocher		CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default
82745ae2546SHeiko Schocher			is 0xa0.
82845ae2546SHeiko Schocher
829c609719bSwdenk- Console Baudrate:
830c609719bSwdenk		CONFIG_BAUDRATE - in bps
831c609719bSwdenk		Select one of the baudrates listed in
8326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
8336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
834c609719bSwdenk
835c92fac91SHeiko Schocher- Console Rx buffer length
836c92fac91SHeiko Schocher		With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
837c92fac91SHeiko Schocher		the maximum receive buffer length for the SMC.
8382b3f12c2SHeiko Schocher		This option is actual only for 82xx and 8xx possible.
839c92fac91SHeiko Schocher		If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
840c92fac91SHeiko Schocher		must be defined, to setup the maximum idle timeout for
841c92fac91SHeiko Schocher		the SMC.
842c92fac91SHeiko Schocher
8439558b48aSGraeme Russ- Pre-Console Buffer:
8449558b48aSGraeme Russ		Prior to the console being initialised (i.e. serial UART
8459558b48aSGraeme Russ		initialised etc) all console output is silently discarded.
8469558b48aSGraeme Russ		Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
8479558b48aSGraeme Russ		buffer any console messages prior to the console being
8489558b48aSGraeme Russ		initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
8499558b48aSGraeme Russ		bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
8509558b48aSGraeme Russ		a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
8519558b48aSGraeme Russ		bytes are output before the console is initialised, the
8529558b48aSGraeme Russ		earlier bytes are discarded.
8539558b48aSGraeme Russ
8549558b48aSGraeme Russ		'Sane' compilers will generate smaller code if
8559558b48aSGraeme Russ		CONFIG_PRE_CON_BUF_SZ is a power of 2
8569558b48aSGraeme Russ
857046a37bdSSonny Rao- Safe printf() functions
858046a37bdSSonny Rao		Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
859046a37bdSSonny Rao		the printf() functions. These are defined in
860046a37bdSSonny Rao		include/vsprintf.h and include snprintf(), vsnprintf() and
861046a37bdSSonny Rao		so on. Code size increase is approximately 300-500 bytes.
862046a37bdSSonny Rao		If this option is not given then these functions will
863046a37bdSSonny Rao		silently discard their buffer size argument - this means
864046a37bdSSonny Rao		you are not getting any overflow checking in this case.
865046a37bdSSonny Rao
866c609719bSwdenk- Boot Delay:	CONFIG_BOOTDELAY - in seconds
867c609719bSwdenk		Delay before automatically booting the default image;
868c609719bSwdenk		set to -1 to disable autoboot.
86993d7212fSJoe Hershberger		set to -2 to autoboot with no delay and not check for abort
87093d7212fSJoe Hershberger		(even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
871c609719bSwdenk
872c609719bSwdenk		See doc/README.autoboot for these options that
873c609719bSwdenk		work with CONFIG_BOOTDELAY. None are required.
874c609719bSwdenk		CONFIG_BOOT_RETRY_TIME
875c609719bSwdenk		CONFIG_BOOT_RETRY_MIN
876c609719bSwdenk		CONFIG_AUTOBOOT_KEYED
877c609719bSwdenk		CONFIG_AUTOBOOT_PROMPT
878c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR
879c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR
880c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR2
881c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR2
882c609719bSwdenk		CONFIG_ZERO_BOOTDELAY_CHECK
883c609719bSwdenk		CONFIG_RESET_TO_RETRY
884c609719bSwdenk
885c609719bSwdenk- Autoboot Command:
886c609719bSwdenk		CONFIG_BOOTCOMMAND
887c609719bSwdenk		Only needed when CONFIG_BOOTDELAY is enabled;
888c609719bSwdenk		define a command string that is automatically executed
889c609719bSwdenk		when no character is read on the console interface
890c609719bSwdenk		within "Boot Delay" after reset.
891c609719bSwdenk
892c609719bSwdenk		CONFIG_BOOTARGS
893c609719bSwdenk		This can be used to pass arguments to the bootm
894c609719bSwdenk		command. The value of CONFIG_BOOTARGS goes into the
895c609719bSwdenk		environment value "bootargs".
896c609719bSwdenk
897c609719bSwdenk		CONFIG_RAMBOOT and CONFIG_NFSBOOT
898c609719bSwdenk		The value of these goes into the environment as
899c609719bSwdenk		"ramboot" and "nfsboot" respectively, and can be used
900c609719bSwdenk		as a convenience, when switching between booting from
90111ccc33fSMarcel Ziswiler		RAM and NFS.
902c609719bSwdenk
903eda0ba38SHeiko Schocher- Bootcount:
904eda0ba38SHeiko Schocher		CONFIG_BOOTCOUNT_LIMIT
905eda0ba38SHeiko Schocher		Implements a mechanism for detecting a repeating reboot
906eda0ba38SHeiko Schocher		cycle, see:
907eda0ba38SHeiko Schocher		http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
908eda0ba38SHeiko Schocher
909eda0ba38SHeiko Schocher		CONFIG_BOOTCOUNT_ENV
910eda0ba38SHeiko Schocher		If no softreset save registers are found on the hardware
911eda0ba38SHeiko Schocher		"bootcount" is stored in the environment. To prevent a
912eda0ba38SHeiko Schocher		saveenv on all reboots, the environment variable
913eda0ba38SHeiko Schocher		"upgrade_available" is used. If "upgrade_available" is
914eda0ba38SHeiko Schocher		0, "bootcount" is always 0, if "upgrade_available" is
915eda0ba38SHeiko Schocher		1 "bootcount" is incremented in the environment.
916eda0ba38SHeiko Schocher		So the Userspace Applikation must set the "upgrade_available"
917eda0ba38SHeiko Schocher		and "bootcount" variable to 0, if a boot was successfully.
918eda0ba38SHeiko Schocher
919c609719bSwdenk- Pre-Boot Commands:
920c609719bSwdenk		CONFIG_PREBOOT
921c609719bSwdenk
922c609719bSwdenk		When this option is #defined, the existence of the
923c609719bSwdenk		environment variable "preboot" will be checked
924c609719bSwdenk		immediately before starting the CONFIG_BOOTDELAY
925c609719bSwdenk		countdown and/or running the auto-boot command resp.
926c609719bSwdenk		entering interactive mode.
927c609719bSwdenk
928c609719bSwdenk		This feature is especially useful when "preboot" is
929c609719bSwdenk		automatically generated or modified. For an example
930c609719bSwdenk		see the LWMON board specific code: here "preboot" is
931c609719bSwdenk		modified when the user holds down a certain
932c609719bSwdenk		combination of keys on the (special) keyboard when
933c609719bSwdenk		booting the systems
934c609719bSwdenk
935c609719bSwdenk- Serial Download Echo Mode:
936c609719bSwdenk		CONFIG_LOADS_ECHO
937c609719bSwdenk		If defined to 1, all characters received during a
938c609719bSwdenk		serial download (using the "loads" command) are
939c609719bSwdenk		echoed back. This might be needed by some terminal
940c609719bSwdenk		emulations (like "cu"), but may as well just take
941c609719bSwdenk		time on others. This setting #define's the initial
942c609719bSwdenk		value of the "loads_echo" environment variable.
943c609719bSwdenk
944602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
945c609719bSwdenk		CONFIG_KGDB_BAUDRATE
946c609719bSwdenk		Select one of the baudrates listed in
9476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
948c609719bSwdenk
949c609719bSwdenk- Monitor Functions:
950602ad3b3SJon Loeliger		Monitor commands can be included or excluded
951602ad3b3SJon Loeliger		from the build by using the #include files
952c6c621bdSStephen Warren		<config_cmd_all.h> and #undef'ing unwanted
953c6c621bdSStephen Warren		commands, or using <config_cmd_default.h>
954602ad3b3SJon Loeliger		and augmenting with additional #define's
955602ad3b3SJon Loeliger		for wanted commands.
956c609719bSwdenk
957602ad3b3SJon Loeliger		The default command configuration includes all commands
958602ad3b3SJon Loeliger		except those marked below with a "*".
959602ad3b3SJon Loeliger
960b401b73dSMarek Vasut		CONFIG_CMD_AES		  AES 128 CBC encrypt/decrypt
961602ad3b3SJon Loeliger		CONFIG_CMD_ASKENV	* ask for env variable
962602ad3b3SJon Loeliger		CONFIG_CMD_BDI		  bdinfo
963602ad3b3SJon Loeliger		CONFIG_CMD_BEDBUG	* Include BedBug Debugger
964602ad3b3SJon Loeliger		CONFIG_CMD_BMP		* BMP support
965602ad3b3SJon Loeliger		CONFIG_CMD_BSP		* Board specific commands
966602ad3b3SJon Loeliger		CONFIG_CMD_BOOTD	  bootd
967d2b2ffe3STom Rini		CONFIG_CMD_BOOTI	* ARM64 Linux kernel Image support
968602ad3b3SJon Loeliger		CONFIG_CMD_CACHE	* icache, dcache
96908d0d6f3SMichal Simek		CONFIG_CMD_CLK   	* clock command support
970602ad3b3SJon Loeliger		CONFIG_CMD_CONSOLE	  coninfo
971710b9938SMike Frysinger		CONFIG_CMD_CRC32	* crc32
972602ad3b3SJon Loeliger		CONFIG_CMD_DATE		* support for RTC, date/time...
973602ad3b3SJon Loeliger		CONFIG_CMD_DHCP		* DHCP support
974602ad3b3SJon Loeliger		CONFIG_CMD_DIAG		* Diagnostics
975a7c93104SPeter Tyser		CONFIG_CMD_DS4510	* ds4510 I2C gpio commands
976a7c93104SPeter Tyser		CONFIG_CMD_DS4510_INFO	* ds4510 I2C info command
977a7c93104SPeter Tyser		CONFIG_CMD_DS4510_MEM	* ds4510 I2C eeprom/sram commansd
978a7c93104SPeter Tyser		CONFIG_CMD_DS4510_RST	* ds4510 I2C rst command
979602ad3b3SJon Loeliger		CONFIG_CMD_DTT		* Digital Therm and Thermostat
980602ad3b3SJon Loeliger		CONFIG_CMD_ECHO		  echo arguments
981246c6922SPeter Tyser		CONFIG_CMD_EDITENV	  edit env variable
982602ad3b3SJon Loeliger		CONFIG_CMD_EEPROM	* EEPROM read/write support
983602ad3b3SJon Loeliger		CONFIG_CMD_ELF		* bootelf, bootvx
9845e2b3e0cSJoe Hershberger		CONFIG_CMD_ENV_CALLBACK	* display details about env callbacks
985fffad71bSJoe Hershberger		CONFIG_CMD_ENV_FLAGS	* display details about env flags
98688733e2cSAndrew Ruder		CONFIG_CMD_ENV_EXISTS	* check existence of env variable
9870c79cda0SMike Frysinger		CONFIG_CMD_EXPORTENV	* export the environment
98803e2ecf6SStephen Warren		CONFIG_CMD_EXT2		* ext2 command support
98903e2ecf6SStephen Warren		CONFIG_CMD_EXT4		* ext4 command support
99016f4d933SStephen Warren		CONFIG_CMD_FS_GENERIC	* filesystem commands (e.g. load, ls)
99116f4d933SStephen Warren					  that work for multiple fs types
992*59e890efSChristian Gmeiner		CONFIG_CMD_FS_UUID	* Look up a filesystem UUID
993bdab39d3SMike Frysinger		CONFIG_CMD_SAVEENV	  saveenv
994602ad3b3SJon Loeliger		CONFIG_CMD_FDC		* Floppy Disk Support
99503e2ecf6SStephen Warren		CONFIG_CMD_FAT		* FAT command support
996602ad3b3SJon Loeliger		CONFIG_CMD_FLASH	  flinfo, erase, protect
997602ad3b3SJon Loeliger		CONFIG_CMD_FPGA		  FPGA device initialization support
9984d98b5c8SVincent Stehlé		CONFIG_CMD_FUSE		* Device fuse support
99953fdc7efSAnton Staaf		CONFIG_CMD_GETTIME	* Get time since boot
1000a641b979SMike Frysinger		CONFIG_CMD_GO		* the 'go' command (exec code)
1001a000b795SKim Phillips		CONFIG_CMD_GREPENV	* search environment
1002bf36c5d5SSimon Glass		CONFIG_CMD_HASH		* calculate hash / digest
1003602ad3b3SJon Loeliger		CONFIG_CMD_HWFLOW	* RTS/CTS hw flow control
1004602ad3b3SJon Loeliger		CONFIG_CMD_I2C		* I2C serial bus support
1005602ad3b3SJon Loeliger		CONFIG_CMD_IDE		* IDE harddisk support
1006602ad3b3SJon Loeliger		CONFIG_CMD_IMI		  iminfo
10078fdf1e0fSVipin Kumar		CONFIG_CMD_IMLS		  List all images found in NOR flash
10084d98b5c8SVincent Stehlé		CONFIG_CMD_IMLS_NAND	* List all images found in NAND flash
1009602ad3b3SJon Loeliger		CONFIG_CMD_IMMAP	* IMMR dump support
1010aa53233aSSimon Glass		CONFIG_CMD_IOTRACE	* I/O tracing for debugging
10110c79cda0SMike Frysinger		CONFIG_CMD_IMPORTENV	* import an environment
1012c167cc02SJoe Hershberger		CONFIG_CMD_INI		* import data from an ini file into the env
1013602ad3b3SJon Loeliger		CONFIG_CMD_IRQ		* irqinfo
1014602ad3b3SJon Loeliger		CONFIG_CMD_ITEST	  Integer/string test of 2 values
1015602ad3b3SJon Loeliger		CONFIG_CMD_JFFS2	* JFFS2 Support
1016602ad3b3SJon Loeliger		CONFIG_CMD_KGDB		* kgdb
10174d98b5c8SVincent Stehlé		CONFIG_CMD_LDRINFO	* ldrinfo (display Blackfin loader)
1018d22c338eSJoe Hershberger		CONFIG_CMD_LINK_LOCAL	* link-local IP address auto-configuration
1019d22c338eSJoe Hershberger					  (169.254.*.*)
1020602ad3b3SJon Loeliger		CONFIG_CMD_LOADB	  loadb
1021602ad3b3SJon Loeliger		CONFIG_CMD_LOADS	  loads
10224d98b5c8SVincent Stehlé		CONFIG_CMD_MD5SUM	* print md5 message digest
102302c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
102415a33e49SSimon Glass		CONFIG_CMD_MEMINFO	* Display detailed memory information
1025602ad3b3SJon Loeliger		CONFIG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
1026a2681707SWolfgang Denk					  loop, loopw
10274d98b5c8SVincent Stehlé		CONFIG_CMD_MEMTEST	* mtest
1028602ad3b3SJon Loeliger		CONFIG_CMD_MISC		  Misc functions like sleep etc
1029602ad3b3SJon Loeliger		CONFIG_CMD_MMC		* MMC memory mapped support
1030602ad3b3SJon Loeliger		CONFIG_CMD_MII		* MII utility commands
103168d7d651SStefan Roese		CONFIG_CMD_MTDPARTS	* MTD partition support
1032602ad3b3SJon Loeliger		CONFIG_CMD_NAND		* NAND support
1033602ad3b3SJon Loeliger		CONFIG_CMD_NET		  bootp, tftpboot, rarpboot
10344d98b5c8SVincent Stehlé		CONFIG_CMD_NFS		  NFS support
1035e92739d3SPeter Tyser		CONFIG_CMD_PCA953X	* PCA953x I2C gpio commands
1036e92739d3SPeter Tyser		CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
1037602ad3b3SJon Loeliger		CONFIG_CMD_PCI		* pciinfo
1038602ad3b3SJon Loeliger		CONFIG_CMD_PCMCIA		* PCMCIA support
1039602ad3b3SJon Loeliger		CONFIG_CMD_PING		* send ICMP ECHO_REQUEST to network
1040602ad3b3SJon Loeliger					  host
1041602ad3b3SJon Loeliger		CONFIG_CMD_PORTIO	* Port I/O
1042ff048ea9SKenneth Waters		CONFIG_CMD_READ		* Read raw data from partition
1043602ad3b3SJon Loeliger		CONFIG_CMD_REGINFO	* Register dump
1044602ad3b3SJon Loeliger		CONFIG_CMD_RUN		  run command in env variable
1045d304931fSSimon Glass		CONFIG_CMD_SANDBOX	* sb command to access sandbox features
1046602ad3b3SJon Loeliger		CONFIG_CMD_SAVES	* save S record dump
1047602ad3b3SJon Loeliger		CONFIG_CMD_SCSI		* SCSI Support
1048602ad3b3SJon Loeliger		CONFIG_CMD_SDRAM	* print SDRAM configuration information
1049602ad3b3SJon Loeliger					  (requires CONFIG_CMD_I2C)
1050602ad3b3SJon Loeliger		CONFIG_CMD_SETGETDCR	  Support for DCR Register access
1051602ad3b3SJon Loeliger					  (4xx only)
1052f61ec45eSEric Nelson		CONFIG_CMD_SF		* Read/write/erase SPI NOR flash
10534d98b5c8SVincent Stehlé		CONFIG_CMD_SHA1SUM	* print sha1 memory digest
105402c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY)
10557d861d95SBob Liu		CONFIG_CMD_SOFTSWITCH	* Soft switch setting command for BF60x
105674de7aefSWolfgang Denk		CONFIG_CMD_SOURCE	  "source" command Support
1057602ad3b3SJon Loeliger		CONFIG_CMD_SPI		* SPI serial bus support
10587a83af07SLuca Ceresoli		CONFIG_CMD_TFTPSRV	* TFTP transfer in server mode
10591fb7cd49SSimon Glass		CONFIG_CMD_TFTPPUT	* TFTP put command (upload)
1060da83bcd7SJoe Hershberger		CONFIG_CMD_TIME		* run command and report execution time (ARM specific)
1061da83bcd7SJoe Hershberger		CONFIG_CMD_TIMER	* access to the system tick timer
1062602ad3b3SJon Loeliger		CONFIG_CMD_USB		* USB support
1063602ad3b3SJon Loeliger		CONFIG_CMD_CDP		* Cisco Discover Protocol support
1064c8339f51SMarek Vasut		CONFIG_CMD_MFSL		* Microblaze FSL support
10654d98b5c8SVincent Stehlé		CONFIG_CMD_XIMG		  Load part of Multi Image
106689c8230dSPrzemyslaw Marczak		CONFIG_CMD_UUID		* Generate random UUID or GUID string
1067c609719bSwdenk
1068c609719bSwdenk		EXAMPLE: If you want all functions except of network
1069c609719bSwdenk		support you can write:
1070c609719bSwdenk
1071602ad3b3SJon Loeliger		#include "config_cmd_all.h"
1072602ad3b3SJon Loeliger		#undef CONFIG_CMD_NET
1073c609719bSwdenk
1074213bf8c8SGerald Van Baren	Other Commands:
1075213bf8c8SGerald Van Baren		fdt (flattened device tree) command: CONFIG_OF_LIBFDT
1076c609719bSwdenk
1077c609719bSwdenk	Note:	Don't enable the "icache" and "dcache" commands
1078602ad3b3SJon Loeliger		(configuration option CONFIG_CMD_CACHE) unless you know
1079c609719bSwdenk		what you (and your U-Boot users) are doing. Data
1080c609719bSwdenk		cache cannot be enabled on systems like the 8xx or
1081c609719bSwdenk		8260 (where accesses to the IMMR region must be
1082c609719bSwdenk		uncached), and it cannot be disabled on all other
1083c609719bSwdenk		systems where we (mis-) use the data cache to hold an
1084c609719bSwdenk		initial stack and some data.
1085c609719bSwdenk
1086c609719bSwdenk
1087c609719bSwdenk		XXX - this list needs to get updated!
1088c609719bSwdenk
1089a5ecbe62SWolfgang Denk- Regular expression support:
1090a5ecbe62SWolfgang Denk		CONFIG_REGEX
1091a5ecbe62SWolfgang Denk		If this variable is defined, U-Boot is linked against
1092a5ecbe62SWolfgang Denk		the SLRE (Super Light Regular Expression) library,
1093a5ecbe62SWolfgang Denk		which adds regex support to some commands, as for
1094a5ecbe62SWolfgang Denk		example "env grep" and "setexpr".
1095a5ecbe62SWolfgang Denk
109645ba8077SSimon Glass- Device tree:
109745ba8077SSimon Glass		CONFIG_OF_CONTROL
109845ba8077SSimon Glass		If this variable is defined, U-Boot will use a device tree
109945ba8077SSimon Glass		to configure its devices, instead of relying on statically
110045ba8077SSimon Glass		compiled #defines in the board file. This option is
110145ba8077SSimon Glass		experimental and only available on a few boards. The device
110245ba8077SSimon Glass		tree is available in the global data as gd->fdt_blob.
110345ba8077SSimon Glass
11042c0f79e4SSimon Glass		U-Boot needs to get its device tree from somewhere. This can
11052c0f79e4SSimon Glass		be done using one of the two options below:
1106bbb0b128SSimon Glass
1107bbb0b128SSimon Glass		CONFIG_OF_EMBED
1108bbb0b128SSimon Glass		If this variable is defined, U-Boot will embed a device tree
1109bbb0b128SSimon Glass		binary in its image. This device tree file should be in the
1110bbb0b128SSimon Glass		board directory and called <soc>-<board>.dts. The binary file
1111bbb0b128SSimon Glass		is then picked up in board_init_f() and made available through
1112bbb0b128SSimon Glass		the global data structure as gd->blob.
111345ba8077SSimon Glass
11142c0f79e4SSimon Glass		CONFIG_OF_SEPARATE
11152c0f79e4SSimon Glass		If this variable is defined, U-Boot will build a device tree
11162c0f79e4SSimon Glass		binary. It will be called u-boot.dtb. Architecture-specific
11172c0f79e4SSimon Glass		code will locate it at run-time. Generally this works by:
11182c0f79e4SSimon Glass
11192c0f79e4SSimon Glass			cat u-boot.bin u-boot.dtb >image.bin
11202c0f79e4SSimon Glass
11212c0f79e4SSimon Glass		and in fact, U-Boot does this for you, creating a file called
11222c0f79e4SSimon Glass		u-boot-dtb.bin which is useful in the common case. You can
11232c0f79e4SSimon Glass		still use the individual files if you need something more
11242c0f79e4SSimon Glass		exotic.
11252c0f79e4SSimon Glass
1126c609719bSwdenk- Watchdog:
1127c609719bSwdenk		CONFIG_WATCHDOG
1128c609719bSwdenk		If this variable is defined, it enables watchdog
11296abe6fb6SDetlev Zundel		support for the SoC. There must be support in the SoC
11306abe6fb6SDetlev Zundel		specific code for a watchdog. For the 8xx and 8260
11316abe6fb6SDetlev Zundel		CPUs, the SIU Watchdog feature is enabled in the SYPCR
11326abe6fb6SDetlev Zundel		register.  When supported for a specific SoC is
11336abe6fb6SDetlev Zundel		available, then no further board specific code should
11346abe6fb6SDetlev Zundel		be needed to use it.
11356abe6fb6SDetlev Zundel
11366abe6fb6SDetlev Zundel		CONFIG_HW_WATCHDOG
11376abe6fb6SDetlev Zundel		When using a watchdog circuitry external to the used
11386abe6fb6SDetlev Zundel		SoC, then define this variable and provide board
11396abe6fb6SDetlev Zundel		specific code for the "hw_watchdog_reset" function.
1140c609719bSwdenk
1141c1551ea8Sstroese- U-Boot Version:
1142c1551ea8Sstroese		CONFIG_VERSION_VARIABLE
1143c1551ea8Sstroese		If this variable is defined, an environment variable
1144c1551ea8Sstroese		named "ver" is created by U-Boot showing the U-Boot
1145c1551ea8Sstroese		version as printed by the "version" command.
1146a1ea8e51SBenoît Thébaudeau		Any change to this variable will be reverted at the
1147a1ea8e51SBenoît Thébaudeau		next reset.
1148c1551ea8Sstroese
1149c609719bSwdenk- Real-Time Clock:
1150c609719bSwdenk
1151602ad3b3SJon Loeliger		When CONFIG_CMD_DATE is selected, the type of the RTC
1152c609719bSwdenk		has to be selected, too. Define exactly one of the
1153c609719bSwdenk		following options:
1154c609719bSwdenk
1155c609719bSwdenk		CONFIG_RTC_MPC8xx	- use internal RTC of MPC8xx
1156c609719bSwdenk		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
11574e8b7544SFabio Estevam		CONFIG_RTC_MC13XXX	- use MC13783 or MC13892 RTC
1158c609719bSwdenk		CONFIG_RTC_MC146818	- use MC146818 RTC
11591cb8e980Swdenk		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
1160c609719bSwdenk		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
11617f70e853Swdenk		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
1162412921d2SMarkus Niebel		CONFIG_RTC_DS1339	- use Maxim, Inc. DS1339 RTC
11633bac3513Swdenk		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
11649536dfccSTor Krill		CONFIG_RTC_ISL1208	- use Intersil ISL1208 RTC
11654c0d4c3bSwdenk		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
11666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_DS1337_NOOSC	- Turn off the OSC output for DS1337
116771d19f30SHeiko Schocher		CONFIG_SYS_RV3029_TCR	- enable trickle charger on
116871d19f30SHeiko Schocher					  RV3029 RTC.
1169c609719bSwdenk
1170b37c7e5eSwdenk		Note that if the RTC uses I2C, then the I2C interface
1171b37c7e5eSwdenk		must also be configured. See I2C Support, below.
1172b37c7e5eSwdenk
1173e92739d3SPeter Tyser- GPIO Support:
1174e92739d3SPeter Tyser		CONFIG_PCA953X		- use NXP's PCA953X series I2C GPIO
1175e92739d3SPeter Tyser
11765dec49caSChris Packham		The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
11775dec49caSChris Packham		chip-ngpio pairs that tell the PCA953X driver the number of
11785dec49caSChris Packham		pins supported by a particular chip.
11795dec49caSChris Packham
1180e92739d3SPeter Tyser		Note that if the GPIO device uses I2C, then the I2C interface
1181e92739d3SPeter Tyser		must also be configured. See I2C Support, below.
1182e92739d3SPeter Tyser
1183aa53233aSSimon Glass- I/O tracing:
1184aa53233aSSimon Glass		When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
1185aa53233aSSimon Glass		accesses and can checksum them or write a list of them out
1186aa53233aSSimon Glass		to memory. See the 'iotrace' command for details. This is
1187aa53233aSSimon Glass		useful for testing device drivers since it can confirm that
1188aa53233aSSimon Glass		the driver behaves the same way before and after a code
1189aa53233aSSimon Glass		change. Currently this is supported on sandbox and arm. To
1190aa53233aSSimon Glass		add support for your architecture, add '#include <iotrace.h>'
1191aa53233aSSimon Glass		to the bottom of arch/<arch>/include/asm/io.h and test.
1192aa53233aSSimon Glass
1193aa53233aSSimon Glass		Example output from the 'iotrace stats' command is below.
1194aa53233aSSimon Glass		Note that if the trace buffer is exhausted, the checksum will
1195aa53233aSSimon Glass		still continue to operate.
1196aa53233aSSimon Glass
1197aa53233aSSimon Glass			iotrace is enabled
1198aa53233aSSimon Glass			Start:  10000000	(buffer start address)
1199aa53233aSSimon Glass			Size:   00010000	(buffer size)
1200aa53233aSSimon Glass			Offset: 00000120	(current buffer offset)
1201aa53233aSSimon Glass			Output: 10000120	(start + offset)
1202aa53233aSSimon Glass			Count:  00000018	(number of trace records)
1203aa53233aSSimon Glass			CRC32:  9526fb66	(CRC32 of all trace records)
1204aa53233aSSimon Glass
1205c609719bSwdenk- Timestamp Support:
1206c609719bSwdenk
1207c609719bSwdenk		When CONFIG_TIMESTAMP is selected, the timestamp
1208c609719bSwdenk		(date and time) of an image is printed by image
1209c609719bSwdenk		commands like bootm or iminfo. This option is
1210602ad3b3SJon Loeliger		automatically enabled when you select CONFIG_CMD_DATE .
1211c609719bSwdenk
1212923c46f9SKarl O. Pinc- Partition Labels (disklabels) Supported:
1213923c46f9SKarl O. Pinc		Zero or more of the following:
1214923c46f9SKarl O. Pinc		CONFIG_MAC_PARTITION   Apple's MacOS partition table.
1215923c46f9SKarl O. Pinc		CONFIG_DOS_PARTITION   MS Dos partition table, traditional on the
1216923c46f9SKarl O. Pinc				       Intel architecture, USB sticks, etc.
1217923c46f9SKarl O. Pinc		CONFIG_ISO_PARTITION   ISO partition table, used on CDROM etc.
1218923c46f9SKarl O. Pinc		CONFIG_EFI_PARTITION   GPT partition table, common when EFI is the
1219923c46f9SKarl O. Pinc				       bootloader.  Note 2TB partition limit; see
1220923c46f9SKarl O. Pinc				       disk/part_efi.c
1221923c46f9SKarl O. Pinc		CONFIG_MTD_PARTITIONS  Memory Technology Device partition table.
1222c609719bSwdenk
1223602ad3b3SJon Loeliger		If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1224218ca724SWolfgang Denk		CONFIG_CMD_SCSI) you must configure support for at
1225923c46f9SKarl O. Pinc		least one non-MTD partition type as well.
1226c609719bSwdenk
1227c609719bSwdenk- IDE Reset method:
12284d13cbadSwdenk		CONFIG_IDE_RESET_ROUTINE - this is defined in several
12294d13cbadSwdenk		board configurations files but used nowhere!
1230c609719bSwdenk
12314d13cbadSwdenk		CONFIG_IDE_RESET - is this is defined, IDE Reset will
12324d13cbadSwdenk		be performed by calling the function
12334d13cbadSwdenk			ide_set_reset(int reset)
12344d13cbadSwdenk		which has to be defined in a board specific file
1235c609719bSwdenk
1236c609719bSwdenk- ATAPI Support:
1237c609719bSwdenk		CONFIG_ATAPI
1238c609719bSwdenk
1239c609719bSwdenk		Set this to enable ATAPI support.
1240c609719bSwdenk
1241c40b2956Swdenk- LBA48 Support
1242c40b2956Swdenk		CONFIG_LBA48
1243c40b2956Swdenk
1244c40b2956Swdenk		Set this to enable support for disks larger than 137GB
12454b142febSHeiko Schocher		Also look at CONFIG_SYS_64BIT_LBA.
1246c40b2956Swdenk		Whithout these , LBA48 support uses 32bit variables and will 'only'
1247c40b2956Swdenk		support disks up to 2.1TB.
1248c40b2956Swdenk
12496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_64BIT_LBA:
1250c40b2956Swdenk			When enabled, makes the IDE subsystem use 64bit sector addresses.
1251c40b2956Swdenk			Default is 32bit.
1252c40b2956Swdenk
1253c609719bSwdenk- SCSI Support:
1254c609719bSwdenk		At the moment only there is only support for the
1255c609719bSwdenk		SYM53C8XX SCSI controller; define
1256c609719bSwdenk		CONFIG_SCSI_SYM53C8XX to enable it.
1257c609719bSwdenk
12586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
12596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
12606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
1261c609719bSwdenk		maximum numbers of LUNs, SCSI ID's and target
1262c609719bSwdenk		devices.
12636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
1264c609719bSwdenk
1265447c031bSStefan Reinauer		The environment variable 'scsidevs' is set to the number of
1266447c031bSStefan Reinauer		SCSI devices found during the last scan.
1267447c031bSStefan Reinauer
1268c609719bSwdenk- NETWORK Support (PCI):
1269682011ffSwdenk		CONFIG_E1000
1270ce5207e1SKyle Moffett		Support for Intel 8254x/8257x gigabit chips.
1271ce5207e1SKyle Moffett
1272ce5207e1SKyle Moffett		CONFIG_E1000_SPI
1273ce5207e1SKyle Moffett		Utility code for direct access to the SPI bus on Intel 8257x.
1274ce5207e1SKyle Moffett		This does not do anything useful unless you set at least one
1275ce5207e1SKyle Moffett		of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1276ce5207e1SKyle Moffett
1277ce5207e1SKyle Moffett		CONFIG_E1000_SPI_GENERIC
1278ce5207e1SKyle Moffett		Allow generic access to the SPI bus on the Intel 8257x, for
1279ce5207e1SKyle Moffett		example with the "sspi" command.
1280ce5207e1SKyle Moffett
1281ce5207e1SKyle Moffett		CONFIG_CMD_E1000
1282ce5207e1SKyle Moffett		Management command for E1000 devices.  When used on devices
1283ce5207e1SKyle Moffett		with SPI support you can reprogram the EEPROM from U-Boot.
1284682011ffSwdenk
1285ac3315c2SAndre Schwarz		CONFIG_E1000_FALLBACK_MAC
128611ccc33fSMarcel Ziswiler		default MAC for empty EEPROM after production.
1287ac3315c2SAndre Schwarz
1288c609719bSwdenk		CONFIG_EEPRO100
1289c609719bSwdenk		Support for Intel 82557/82559/82559ER chips.
129011ccc33fSMarcel Ziswiler		Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
1291c609719bSwdenk		write routine for first time initialisation.
1292c609719bSwdenk
1293c609719bSwdenk		CONFIG_TULIP
1294c609719bSwdenk		Support for Digital 2114x chips.
1295c609719bSwdenk		Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1296c609719bSwdenk		modem chip initialisation (KS8761/QS6611).
1297c609719bSwdenk
1298c609719bSwdenk		CONFIG_NATSEMI
1299c609719bSwdenk		Support for National dp83815 chips.
1300c609719bSwdenk
1301c609719bSwdenk		CONFIG_NS8382X
1302c609719bSwdenk		Support for National dp8382[01] gigabit chips.
1303c609719bSwdenk
130445219c46Swdenk- NETWORK Support (other):
130545219c46Swdenk
1306c041e9d2SJens Scharsig		CONFIG_DRIVER_AT91EMAC
1307c041e9d2SJens Scharsig		Support for AT91RM9200 EMAC.
1308c041e9d2SJens Scharsig
1309c041e9d2SJens Scharsig			CONFIG_RMII
1310c041e9d2SJens Scharsig			Define this to use reduced MII inteface
1311c041e9d2SJens Scharsig
1312c041e9d2SJens Scharsig			CONFIG_DRIVER_AT91EMAC_QUIET
1313c041e9d2SJens Scharsig			If this defined, the driver is quiet.
1314c041e9d2SJens Scharsig			The driver doen't show link status messages.
1315c041e9d2SJens Scharsig
1316efdd7319SRob Herring		CONFIG_CALXEDA_XGMAC
1317efdd7319SRob Herring		Support for the Calxeda XGMAC device
1318efdd7319SRob Herring
13193bb46d23SAshok		CONFIG_LAN91C96
132045219c46Swdenk		Support for SMSC's LAN91C96 chips.
132145219c46Swdenk
132245219c46Swdenk			CONFIG_LAN91C96_BASE
132345219c46Swdenk			Define this to hold the physical address
132445219c46Swdenk			of the LAN91C96's I/O space
132545219c46Swdenk
132645219c46Swdenk			CONFIG_LAN91C96_USE_32_BIT
132745219c46Swdenk			Define this to enable 32 bit addressing
132845219c46Swdenk
13293bb46d23SAshok		CONFIG_SMC91111
1330f39748aeSwdenk		Support for SMSC's LAN91C111 chip
1331f39748aeSwdenk
1332f39748aeSwdenk			CONFIG_SMC91111_BASE
1333f39748aeSwdenk			Define this to hold the physical address
1334f39748aeSwdenk			of the device (I/O space)
1335f39748aeSwdenk
1336f39748aeSwdenk			CONFIG_SMC_USE_32_BIT
1337f39748aeSwdenk			Define this if data bus is 32 bits
1338f39748aeSwdenk
1339f39748aeSwdenk			CONFIG_SMC_USE_IOFUNCS
1340f39748aeSwdenk			Define this to use i/o functions instead of macros
1341f39748aeSwdenk			(some hardware wont work with macros)
1342f39748aeSwdenk
1343dc02badaSHeiko Schocher		CONFIG_DRIVER_TI_EMAC
1344dc02badaSHeiko Schocher		Support for davinci emac
1345dc02badaSHeiko Schocher
1346dc02badaSHeiko Schocher			CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1347dc02badaSHeiko Schocher			Define this if you have more then 3 PHYs.
1348dc02badaSHeiko Schocher
1349b3dbf4a5SMacpaul Lin		CONFIG_FTGMAC100
1350b3dbf4a5SMacpaul Lin		Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1351b3dbf4a5SMacpaul Lin
1352b3dbf4a5SMacpaul Lin			CONFIG_FTGMAC100_EGIGA
1353b3dbf4a5SMacpaul Lin			Define this to use GE link update with gigabit PHY.
1354b3dbf4a5SMacpaul Lin			Define this if FTGMAC100 is connected to gigabit PHY.
1355b3dbf4a5SMacpaul Lin			If your system has 10/100 PHY only, it might not occur
1356b3dbf4a5SMacpaul Lin			wrong behavior. Because PHY usually return timeout or
1357b3dbf4a5SMacpaul Lin			useless data when polling gigabit status and gigabit
1358b3dbf4a5SMacpaul Lin			control registers. This behavior won't affect the
1359b3dbf4a5SMacpaul Lin			correctnessof 10/100 link speed update.
1360b3dbf4a5SMacpaul Lin
1361c2fff331SMike Rapoport		CONFIG_SMC911X
1362557b377dSJens Gehrlein		Support for SMSC's LAN911x and LAN921x chips
1363557b377dSJens Gehrlein
1364c2fff331SMike Rapoport			CONFIG_SMC911X_BASE
1365557b377dSJens Gehrlein			Define this to hold the physical address
1366557b377dSJens Gehrlein			of the device (I/O space)
1367557b377dSJens Gehrlein
1368c2fff331SMike Rapoport			CONFIG_SMC911X_32_BIT
1369557b377dSJens Gehrlein			Define this if data bus is 32 bits
1370557b377dSJens Gehrlein
1371c2fff331SMike Rapoport			CONFIG_SMC911X_16_BIT
1372557b377dSJens Gehrlein			Define this if data bus is 16 bits. If your processor
1373557b377dSJens Gehrlein			automatically converts one 32 bit word to two 16 bit
1374c2fff331SMike Rapoport			words you may also try CONFIG_SMC911X_32_BIT.
1375557b377dSJens Gehrlein
13763d0075faSYoshihiro Shimoda		CONFIG_SH_ETHER
13773d0075faSYoshihiro Shimoda		Support for Renesas on-chip Ethernet controller
13783d0075faSYoshihiro Shimoda
13793d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_USE_PORT
13803d0075faSYoshihiro Shimoda			Define the number of ports to be used
13813d0075faSYoshihiro Shimoda
13823d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_PHY_ADDR
13833d0075faSYoshihiro Shimoda			Define the ETH PHY's address
13843d0075faSYoshihiro Shimoda
138568260aabSYoshihiro Shimoda			CONFIG_SH_ETHER_CACHE_WRITEBACK
138668260aabSYoshihiro Shimoda			If this option is set, the driver enables cache flush.
138768260aabSYoshihiro Shimoda
1388b2f97cf2SHeiko Schocher- PWM Support:
1389b2f97cf2SHeiko Schocher		CONFIG_PWM_IMX
1390b2f97cf2SHeiko Schocher		Support for PWM modul on the imx6.
1391b2f97cf2SHeiko Schocher
13925e124724SVadim Bendebury- TPM Support:
139390899cc0SChe-liang Chiou		CONFIG_TPM
139490899cc0SChe-liang Chiou		Support TPM devices.
139590899cc0SChe-liang Chiou
13961b393db5STom Wai-Hong Tam		CONFIG_TPM_TIS_I2C
13971b393db5STom Wai-Hong Tam		Support for i2c bus TPM devices. Only one device
13981b393db5STom Wai-Hong Tam		per system is supported at this time.
13991b393db5STom Wai-Hong Tam
14001b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_BUS_NUMBER
14011b393db5STom Wai-Hong Tam			Define the the i2c bus number for the TPM device
14021b393db5STom Wai-Hong Tam
14031b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS
14041b393db5STom Wai-Hong Tam			Define the TPM's address on the i2c bus
14051b393db5STom Wai-Hong Tam
14061b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_BURST_LIMITATION
14071b393db5STom Wai-Hong Tam			Define the burst count bytes upper limit
14081b393db5STom Wai-Hong Tam
1409c01939c7SDirk Eibach		CONFIG_TPM_ATMEL_TWI
1410c01939c7SDirk Eibach		Support for Atmel TWI TPM device. Requires I2C support.
1411c01939c7SDirk Eibach
141290899cc0SChe-liang Chiou		CONFIG_TPM_TIS_LPC
14135e124724SVadim Bendebury		Support for generic parallel port TPM devices. Only one device
14145e124724SVadim Bendebury		per system is supported at this time.
14155e124724SVadim Bendebury
14165e124724SVadim Bendebury			CONFIG_TPM_TIS_BASE_ADDRESS
14175e124724SVadim Bendebury			Base address where the generic TPM device is mapped
14185e124724SVadim Bendebury			to. Contemporary x86 systems usually map it at
14195e124724SVadim Bendebury			0xfed40000.
14205e124724SVadim Bendebury
1421be6c1529SReinhard Pfau		CONFIG_CMD_TPM
1422be6c1529SReinhard Pfau		Add tpm monitor functions.
1423be6c1529SReinhard Pfau		Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1424be6c1529SReinhard Pfau		provides monitor access to authorized functions.
1425be6c1529SReinhard Pfau
1426be6c1529SReinhard Pfau		CONFIG_TPM
1427be6c1529SReinhard Pfau		Define this to enable the TPM support library which provides
1428be6c1529SReinhard Pfau		functional interfaces to some TPM commands.
1429be6c1529SReinhard Pfau		Requires support for a TPM device.
1430be6c1529SReinhard Pfau
1431be6c1529SReinhard Pfau		CONFIG_TPM_AUTH_SESSIONS
1432be6c1529SReinhard Pfau		Define this to enable authorized functions in the TPM library.
1433be6c1529SReinhard Pfau		Requires CONFIG_TPM and CONFIG_SHA1.
1434be6c1529SReinhard Pfau
1435c609719bSwdenk- USB Support:
1436c609719bSwdenk		At the moment only the UHCI host controller is
14374d13cbadSwdenk		supported (PIP405, MIP405, MPC5200); define
1438c609719bSwdenk		CONFIG_USB_UHCI to enable it.
1439c609719bSwdenk		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
144030d56faeSwdenk		and define CONFIG_USB_STORAGE to enable the USB
1441c609719bSwdenk		storage devices.
1442c609719bSwdenk		Note:
1443c609719bSwdenk		Supported are USB Keyboards and USB Floppy drives
1444c609719bSwdenk		(TEAC FD-05PUB).
14454d13cbadSwdenk		MPC5200 USB requires additional defines:
14464d13cbadSwdenk			CONFIG_USB_CLOCK
14474d13cbadSwdenk				for 528 MHz Clock: 0x0001bbbb
1448307ecb6dSEric Millbrandt			CONFIG_PSC3_USB
1449307ecb6dSEric Millbrandt				for USB on PSC3
14504d13cbadSwdenk			CONFIG_USB_CONFIG
14514d13cbadSwdenk				for differential drivers: 0x00001000
14524d13cbadSwdenk				for single ended drivers: 0x00005000
1453307ecb6dSEric Millbrandt				for differential drivers on PSC3: 0x00000100
1454307ecb6dSEric Millbrandt				for single ended drivers on PSC3: 0x00004100
14556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_USB_EVENT_POLL
1456fdcfaa1bSZhang Wei				May be defined to allow interrupt polling
1457fdcfaa1bSZhang Wei				instead of using asynchronous interrupts
14584d13cbadSwdenk
14599ab4ce22SSimon Glass		CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
14609ab4ce22SSimon Glass		txfilltuning field in the EHCI controller on reset.
14619ab4ce22SSimon Glass
14626e9e0626SOleksandr Tymoshenko		CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
14636e9e0626SOleksandr Tymoshenko		HW module registers.
14646e9e0626SOleksandr Tymoshenko
146516c8d5e7SWolfgang Denk- USB Device:
146616c8d5e7SWolfgang Denk		Define the below if you wish to use the USB console.
146716c8d5e7SWolfgang Denk		Once firmware is rebuilt from a serial console issue the
146816c8d5e7SWolfgang Denk		command "setenv stdin usbtty; setenv stdout usbtty" and
146911ccc33fSMarcel Ziswiler		attach your USB cable. The Unix command "dmesg" should print
147016c8d5e7SWolfgang Denk		it has found a new device. The environment variable usbtty
147116c8d5e7SWolfgang Denk		can be set to gserial or cdc_acm to enable your device to
147216c8d5e7SWolfgang Denk		appear to a USB host as a Linux gserial device or a
147316c8d5e7SWolfgang Denk		Common Device Class Abstract Control Model serial device.
147416c8d5e7SWolfgang Denk		If you select usbtty = gserial you should be able to enumerate
147516c8d5e7SWolfgang Denk		a Linux host by
147616c8d5e7SWolfgang Denk		# modprobe usbserial vendor=0xVendorID product=0xProductID
147716c8d5e7SWolfgang Denk		else if using cdc_acm, simply setting the environment
147816c8d5e7SWolfgang Denk		variable usbtty to be cdc_acm should suffice. The following
147916c8d5e7SWolfgang Denk		might be defined in YourBoardName.h
148016c8d5e7SWolfgang Denk
148116c8d5e7SWolfgang Denk			CONFIG_USB_DEVICE
148216c8d5e7SWolfgang Denk			Define this to build a UDC device
148316c8d5e7SWolfgang Denk
148416c8d5e7SWolfgang Denk			CONFIG_USB_TTY
148516c8d5e7SWolfgang Denk			Define this to have a tty type of device available to
148616c8d5e7SWolfgang Denk			talk to the UDC device
148716c8d5e7SWolfgang Denk
1488f9da0f89SVipin KUMAR			CONFIG_USBD_HS
1489f9da0f89SVipin KUMAR			Define this to enable the high speed support for usb
1490f9da0f89SVipin KUMAR			device and usbtty. If this feature is enabled, a routine
1491f9da0f89SVipin KUMAR			int is_usbd_high_speed(void)
1492f9da0f89SVipin KUMAR			also needs to be defined by the driver to dynamically poll
1493f9da0f89SVipin KUMAR			whether the enumeration has succeded at high speed or full
1494f9da0f89SVipin KUMAR			speed.
1495f9da0f89SVipin KUMAR
14966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_IS_IN_ENV
149716c8d5e7SWolfgang Denk			Define this if you want stdin, stdout &/or stderr to
149816c8d5e7SWolfgang Denk			be set to usbtty.
149916c8d5e7SWolfgang Denk
150016c8d5e7SWolfgang Denk			mpc8xx:
15016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_EXTC_CLK 0xBLAH
150216c8d5e7SWolfgang Denk				Derive USB clock from external clock "blah"
15036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_EXTC_CLK 0x02
150416c8d5e7SWolfgang Denk
15056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_BRG_CLK 0xBLAH
150616c8d5e7SWolfgang Denk				Derive USB clock from brgclk
15076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_BRG_CLK 0x04
150816c8d5e7SWolfgang Denk
150916c8d5e7SWolfgang Denk		If you have a USB-IF assigned VendorID then you may wish to
151016c8d5e7SWolfgang Denk		define your own vendor specific values either in BoardName.h
151116c8d5e7SWolfgang Denk		or directly in usbd_vendor_info.h. If you don't define
151216c8d5e7SWolfgang Denk		CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
151316c8d5e7SWolfgang Denk		CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
151416c8d5e7SWolfgang Denk		should pretend to be a Linux device to it's target host.
151516c8d5e7SWolfgang Denk
151616c8d5e7SWolfgang Denk			CONFIG_USBD_MANUFACTURER
151716c8d5e7SWolfgang Denk			Define this string as the name of your company for
151816c8d5e7SWolfgang Denk			- CONFIG_USBD_MANUFACTURER "my company"
151916c8d5e7SWolfgang Denk
152016c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCT_NAME
152116c8d5e7SWolfgang Denk			Define this string as the name of your product
152216c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCT_NAME "acme usb device"
152316c8d5e7SWolfgang Denk
152416c8d5e7SWolfgang Denk			CONFIG_USBD_VENDORID
152516c8d5e7SWolfgang Denk			Define this as your assigned Vendor ID from the USB
152616c8d5e7SWolfgang Denk			Implementors Forum. This *must* be a genuine Vendor ID
152716c8d5e7SWolfgang Denk			to avoid polluting the USB namespace.
152816c8d5e7SWolfgang Denk			- CONFIG_USBD_VENDORID 0xFFFF
152916c8d5e7SWolfgang Denk
153016c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCTID
153116c8d5e7SWolfgang Denk			Define this as the unique Product ID
153216c8d5e7SWolfgang Denk			for your device
153316c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCTID 0xFFFF
1534c609719bSwdenk
1535d70a560fSIgor Grinberg- ULPI Layer Support:
1536d70a560fSIgor Grinberg		The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1537d70a560fSIgor Grinberg		the generic ULPI layer. The generic layer accesses the ULPI PHY
1538d70a560fSIgor Grinberg		via the platform viewport, so you need both the genric layer and
1539d70a560fSIgor Grinberg		the viewport enabled. Currently only Chipidea/ARC based
1540d70a560fSIgor Grinberg		viewport is supported.
1541d70a560fSIgor Grinberg		To enable the ULPI layer support, define CONFIG_USB_ULPI and
1542d70a560fSIgor Grinberg		CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
15436d365ea0SLucas Stach		If your ULPI phy needs a different reference clock than the
15446d365ea0SLucas Stach		standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
15456d365ea0SLucas Stach		the appropriate value in Hz.
1546c609719bSwdenk
1547c609719bSwdenk- MMC Support:
1548c609719bSwdenk		The MMC controller on the Intel PXA is supported. To
1549c609719bSwdenk		enable this define CONFIG_MMC. The MMC can be
1550c609719bSwdenk		accessed from the boot prompt by mapping the device
1551c609719bSwdenk		to physical memory similar to flash. Command line is
1552602ad3b3SJon Loeliger		enabled with CONFIG_CMD_MMC. The MMC driver also works with
1553602ad3b3SJon Loeliger		the FAT fs. This is enabled with CONFIG_CMD_FAT.
1554c609719bSwdenk
1555afb35666SYoshihiro Shimoda		CONFIG_SH_MMCIF
1556afb35666SYoshihiro Shimoda		Support for Renesas on-chip MMCIF controller
1557afb35666SYoshihiro Shimoda
1558afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_ADDR
1559afb35666SYoshihiro Shimoda			Define the base address of MMCIF registers
1560afb35666SYoshihiro Shimoda
1561afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_CLK
1562afb35666SYoshihiro Shimoda			Define the clock frequency for MMCIF
1563afb35666SYoshihiro Shimoda
15641fd93c6eSPierre Aubert		CONFIG_GENERIC_MMC
15651fd93c6eSPierre Aubert		Enable the generic MMC driver
15661fd93c6eSPierre Aubert
15671fd93c6eSPierre Aubert		CONFIG_SUPPORT_EMMC_BOOT
15681fd93c6eSPierre Aubert		Enable some additional features of the eMMC boot partitions.
15691fd93c6eSPierre Aubert
15701fd93c6eSPierre Aubert		CONFIG_SUPPORT_EMMC_RPMB
15711fd93c6eSPierre Aubert		Enable the commands for reading, writing and programming the
15721fd93c6eSPierre Aubert		key for the Replay Protection Memory Block partition in eMMC.
15731fd93c6eSPierre Aubert
1574b3ba6e94STom Rini- USB Device Firmware Update (DFU) class support:
1575b3ba6e94STom Rini		CONFIG_DFU_FUNCTION
1576b3ba6e94STom Rini		This enables the USB portion of the DFU USB class
1577b3ba6e94STom Rini
1578b3ba6e94STom Rini		CONFIG_CMD_DFU
1579b3ba6e94STom Rini		This enables the command "dfu" which is used to have
1580b3ba6e94STom Rini		U-Boot create a DFU class device via USB.  This command
1581b3ba6e94STom Rini		requires that the "dfu_alt_info" environment variable be
1582b3ba6e94STom Rini		set and define the alt settings to expose to the host.
1583b3ba6e94STom Rini
1584b3ba6e94STom Rini		CONFIG_DFU_MMC
1585b3ba6e94STom Rini		This enables support for exposing (e)MMC devices via DFU.
1586b3ba6e94STom Rini
1587c6631764SPantelis Antoniou		CONFIG_DFU_NAND
1588c6631764SPantelis Antoniou		This enables support for exposing NAND devices via DFU.
1589c6631764SPantelis Antoniou
1590a9479f04SAfzal Mohammed		CONFIG_DFU_RAM
1591a9479f04SAfzal Mohammed		This enables support for exposing RAM via DFU.
1592a9479f04SAfzal Mohammed		Note: DFU spec refer to non-volatile memory usage, but
1593a9479f04SAfzal Mohammed		allow usages beyond the scope of spec - here RAM usage,
1594a9479f04SAfzal Mohammed		one that would help mostly the developer.
1595a9479f04SAfzal Mohammed
1596e7e75c70SHeiko Schocher		CONFIG_SYS_DFU_DATA_BUF_SIZE
1597e7e75c70SHeiko Schocher		Dfu transfer uses a buffer before writing data to the
1598e7e75c70SHeiko Schocher		raw storage device. Make the size (in bytes) of this buffer
1599e7e75c70SHeiko Schocher		configurable. The size of this buffer is also configurable
1600e7e75c70SHeiko Schocher		through the "dfu_bufsiz" environment variable.
1601e7e75c70SHeiko Schocher
1602ea2453d5SPantelis Antoniou		CONFIG_SYS_DFU_MAX_FILE_SIZE
1603ea2453d5SPantelis Antoniou		When updating files rather than the raw storage device,
1604ea2453d5SPantelis Antoniou		we use a static buffer to copy the file into and then write
1605ea2453d5SPantelis Antoniou		the buffer once we've been given the whole file.  Define
1606ea2453d5SPantelis Antoniou		this to the maximum filesize (in bytes) for the buffer.
1607ea2453d5SPantelis Antoniou		Default is 4 MiB if undefined.
1608ea2453d5SPantelis Antoniou
1609001a8319SHeiko Schocher		DFU_DEFAULT_POLL_TIMEOUT
1610001a8319SHeiko Schocher		Poll timeout [ms], is the timeout a device can send to the
1611001a8319SHeiko Schocher		host. The host must wait for this timeout before sending
1612001a8319SHeiko Schocher		a subsequent DFU_GET_STATUS request to the device.
1613001a8319SHeiko Schocher
1614001a8319SHeiko Schocher		DFU_MANIFEST_POLL_TIMEOUT
1615001a8319SHeiko Schocher		Poll timeout [ms], which the device sends to the host when
1616001a8319SHeiko Schocher		entering dfuMANIFEST state. Host waits this timeout, before
1617001a8319SHeiko Schocher		sending again an USB request to the device.
1618001a8319SHeiko Schocher
16193aab70afSSebastian Siewior- USB Device Android Fastboot support:
16203aab70afSSebastian Siewior		CONFIG_CMD_FASTBOOT
16213aab70afSSebastian Siewior		This enables the command "fastboot" which enables the Android
16223aab70afSSebastian Siewior		fastboot mode for the platform's USB device. Fastboot is a USB
16233aab70afSSebastian Siewior		protocol for downloading images, flashing and device control
16243aab70afSSebastian Siewior		used on Android devices.
16253aab70afSSebastian Siewior		See doc/README.android-fastboot for more information.
16263aab70afSSebastian Siewior
16273aab70afSSebastian Siewior		CONFIG_ANDROID_BOOT_IMAGE
16283aab70afSSebastian Siewior		This enables support for booting images which use the Android
16293aab70afSSebastian Siewior		image format header.
16303aab70afSSebastian Siewior
16313aab70afSSebastian Siewior		CONFIG_USB_FASTBOOT_BUF_ADDR
16323aab70afSSebastian Siewior		The fastboot protocol requires a large memory buffer for
16333aab70afSSebastian Siewior		downloads. Define this to the starting RAM address to use for
16343aab70afSSebastian Siewior		downloaded images.
16353aab70afSSebastian Siewior
16363aab70afSSebastian Siewior		CONFIG_USB_FASTBOOT_BUF_SIZE
16373aab70afSSebastian Siewior		The fastboot protocol requires a large memory buffer for
16383aab70afSSebastian Siewior		downloads. This buffer should be as large as possible for a
16393aab70afSSebastian Siewior		platform. Define this to the size available RAM for fastboot.
16403aab70afSSebastian Siewior
1641d1b5ed07SSteve Rae		CONFIG_FASTBOOT_FLASH
1642d1b5ed07SSteve Rae		The fastboot protocol includes a "flash" command for writing
1643d1b5ed07SSteve Rae		the downloaded image to a non-volatile storage device. Define
1644d1b5ed07SSteve Rae		this to enable the "fastboot flash" command.
1645d1b5ed07SSteve Rae
1646d1b5ed07SSteve Rae		CONFIG_FASTBOOT_FLASH_MMC_DEV
1647d1b5ed07SSteve Rae		The fastboot "flash" command requires additional information
1648d1b5ed07SSteve Rae		regarding the non-volatile storage device. Define this to
1649d1b5ed07SSteve Rae		the eMMC device that fastboot should use to store the image.
1650d1b5ed07SSteve Rae
16516705d81eSwdenk- Journaling Flash filesystem support:
16526705d81eSwdenk		CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
16536705d81eSwdenk		CONFIG_JFFS2_NAND_DEV
16546705d81eSwdenk		Define these for a default partition on a NAND device
16556705d81eSwdenk
16566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_SECTOR,
16576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
16586705d81eSwdenk		Define these for a default partition on a NOR device
16596705d81eSwdenk
16606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS_CUSTOM_PART
16616705d81eSwdenk		Define this to create an own partition. You have to provide a
16626705d81eSwdenk		function struct part_info* jffs2_part_info(int part_num)
16636705d81eSwdenk
16646705d81eSwdenk		If you define only one JFFS2 partition you may also want to
16656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_JFFS_SINGLE_PART	1
16666705d81eSwdenk		to disable the command chpart. This is the default when you
16676705d81eSwdenk		have not defined a custom partition
16686705d81eSwdenk
1669c30a15e5SDonggeun Kim- FAT(File Allocation Table) filesystem write function support:
1670c30a15e5SDonggeun Kim		CONFIG_FAT_WRITE
1671656f4c65SDonggeun Kim
1672656f4c65SDonggeun Kim		Define this to enable support for saving memory data as a
1673656f4c65SDonggeun Kim		file in FAT formatted partition.
1674656f4c65SDonggeun Kim
1675656f4c65SDonggeun Kim		This will also enable the command "fatwrite" enabling the
1676656f4c65SDonggeun Kim		user to write files to FAT.
1677c30a15e5SDonggeun Kim
167884cd9327SGabe BlackCBFS (Coreboot Filesystem) support
167984cd9327SGabe Black		CONFIG_CMD_CBFS
168084cd9327SGabe Black
168184cd9327SGabe Black		Define this to enable support for reading from a Coreboot
168284cd9327SGabe Black		filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
168384cd9327SGabe Black		and cbfsload.
168484cd9327SGabe Black
16854f0d1a2aSSiva Durga Prasad Paladugu- FAT(File Allocation Table) filesystem cluster size:
16864f0d1a2aSSiva Durga Prasad Paladugu		CONFIG_FS_FAT_MAX_CLUSTSIZE
16874f0d1a2aSSiva Durga Prasad Paladugu
16884f0d1a2aSSiva Durga Prasad Paladugu		Define the max cluster size for fat operations else
16894f0d1a2aSSiva Durga Prasad Paladugu		a default value of 65536 will be defined.
16904f0d1a2aSSiva Durga Prasad Paladugu
1691c609719bSwdenk- Keyboard Support:
1692c609719bSwdenk		CONFIG_ISA_KEYBOARD
1693c609719bSwdenk
1694c609719bSwdenk		Define this to enable standard (PC-Style) keyboard
1695c609719bSwdenk		support
1696c609719bSwdenk
1697c609719bSwdenk		CONFIG_I8042_KBD
1698c609719bSwdenk		Standard PC keyboard driver with US (is default) and
1699c609719bSwdenk		GERMAN key layout (switch via environment 'keymap=de') support.
1700c609719bSwdenk		Export function i8042_kbd_init, i8042_tstc and i8042_getc
1701c609719bSwdenk		for cfb_console. Supports cursor blinking.
1702c609719bSwdenk
1703713cb680SHung-ying Tyan		CONFIG_CROS_EC_KEYB
1704713cb680SHung-ying Tyan		Enables a Chrome OS keyboard using the CROS_EC interface.
1705713cb680SHung-ying Tyan		This uses CROS_EC to communicate with a second microcontroller
1706713cb680SHung-ying Tyan		which provides key scans on request.
1707713cb680SHung-ying Tyan
1708c609719bSwdenk- Video support:
1709c609719bSwdenk		CONFIG_VIDEO
1710c609719bSwdenk
1711c609719bSwdenk		Define this to enable video support (for output to
1712c609719bSwdenk		video).
1713c609719bSwdenk
1714c609719bSwdenk		CONFIG_VIDEO_CT69000
1715c609719bSwdenk
1716c609719bSwdenk		Enable Chips & Technologies 69000 Video chip
1717c609719bSwdenk
1718c609719bSwdenk		CONFIG_VIDEO_SMI_LYNXEM
1719eeb1b77bSwdenk		Enable Silicon Motion SMI 712/710/810 Video chip. The
1720eeb1b77bSwdenk		video output is selected via environment 'videoout'
1721eeb1b77bSwdenk		(1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1722eeb1b77bSwdenk		assumed.
1723c609719bSwdenk
1724eeb1b77bSwdenk		For the CT69000 and SMI_LYNXEM drivers, videomode is
172511ccc33fSMarcel Ziswiler		selected via environment 'videomode'. Two different ways
1726eeb1b77bSwdenk		are possible:
1727eeb1b77bSwdenk		- "videomode=num"   'num' is a standard LiLo mode numbers.
1728eeb1b77bSwdenk		Following standard modes are supported	(* is default):
1729eeb1b77bSwdenk
1730eeb1b77bSwdenk		      Colors	640x480 800x600 1024x768 1152x864 1280x1024
1731eeb1b77bSwdenk		-------------+---------------------------------------------
1732eeb1b77bSwdenk		      8 bits |	0x301*	0x303	 0x305	  0x161	    0x307
1733eeb1b77bSwdenk		     15 bits |	0x310	0x313	 0x316	  0x162	    0x319
1734eeb1b77bSwdenk		     16 bits |	0x311	0x314	 0x317	  0x163	    0x31A
1735eeb1b77bSwdenk		     24 bits |	0x312	0x315	 0x318	    ?	    0x31B
1736eeb1b77bSwdenk		-------------+---------------------------------------------
1737c609719bSwdenk		(i.e. setenv videomode 317; saveenv; reset;)
1738c609719bSwdenk
1739eeb1b77bSwdenk		- "videomode=bootargs" all the video parameters are parsed
17407817cb20SMarcel Ziswiler		from the bootargs. (See drivers/video/videomodes.c)
1741eeb1b77bSwdenk
1742eeb1b77bSwdenk
1743a6c7ad2fSwdenk		CONFIG_VIDEO_SED13806
1744a6c7ad2fSwdenk		Enable Epson SED13806 driver. This driver supports 8bpp
1745a6c7ad2fSwdenk		and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1746a6c7ad2fSwdenk		or CONFIG_VIDEO_SED13806_16BPP
1747a6c7ad2fSwdenk
17487d3053fbSTimur Tabi		CONFIG_FSL_DIU_FB
17497d3053fbSTimur Tabi		Enable the Freescale DIU video driver.	Reference boards for
17507d3053fbSTimur Tabi		SOCs that have a DIU should define this macro to enable DIU
17517d3053fbSTimur Tabi		support, and should also define these other macros:
17527d3053fbSTimur Tabi
17537d3053fbSTimur Tabi			CONFIG_SYS_DIU_ADDR
17547d3053fbSTimur Tabi			CONFIG_VIDEO
17557d3053fbSTimur Tabi			CONFIG_CMD_BMP
17567d3053fbSTimur Tabi			CONFIG_CFB_CONSOLE
17577d3053fbSTimur Tabi			CONFIG_VIDEO_SW_CURSOR
17587d3053fbSTimur Tabi			CONFIG_VGA_AS_SINGLE_DEVICE
17597d3053fbSTimur Tabi			CONFIG_VIDEO_LOGO
17607d3053fbSTimur Tabi			CONFIG_VIDEO_BMP_LOGO
17617d3053fbSTimur Tabi
1762ba8e76bdSTimur Tabi		The DIU driver will look for the 'video-mode' environment
1763ba8e76bdSTimur Tabi		variable, and if defined, enable the DIU as a console during
1764ba8e76bdSTimur Tabi		boot.  See the documentation file README.video for a
1765ba8e76bdSTimur Tabi		description of this variable.
17667d3053fbSTimur Tabi
1767058d59b0SSimon Glass		CONFIG_VIDEO_VGA
1768058d59b0SSimon Glass
1769058d59b0SSimon Glass		Enable the VGA video / BIOS for x86. The alternative if you
1770058d59b0SSimon Glass		are using coreboot is to use the coreboot frame buffer
1771058d59b0SSimon Glass		driver.
1772058d59b0SSimon Glass
1773058d59b0SSimon Glass
1774682011ffSwdenk- Keyboard Support:
1775682011ffSwdenk		CONFIG_KEYBOARD
1776682011ffSwdenk
1777682011ffSwdenk		Define this to enable a custom keyboard support.
1778682011ffSwdenk		This simply calls drv_keyboard_init() which must be
1779682011ffSwdenk		defined in your board-specific files.
1780682011ffSwdenk		The only board using this so far is RBC823.
1781a6c7ad2fSwdenk
1782c609719bSwdenk- LCD Support:	CONFIG_LCD
1783c609719bSwdenk
1784c609719bSwdenk		Define this to enable LCD support (for output to LCD
1785c609719bSwdenk		display); also select one of the supported displays
1786c609719bSwdenk		by defining one of these:
1787c609719bSwdenk
178839cf4804SStelian Pop		CONFIG_ATMEL_LCD:
178939cf4804SStelian Pop
179039cf4804SStelian Pop			HITACHI TX09D70VM1CCA, 3.5", 240x320.
179139cf4804SStelian Pop
1792fd3103bbSwdenk		CONFIG_NEC_NL6448AC33:
1793c609719bSwdenk
1794fd3103bbSwdenk			NEC NL6448AC33-18. Active, color, single scan.
1795c609719bSwdenk
1796fd3103bbSwdenk		CONFIG_NEC_NL6448BC20
1797c609719bSwdenk
1798fd3103bbSwdenk			NEC NL6448BC20-08. 6.5", 640x480.
1799fd3103bbSwdenk			Active, color, single scan.
1800fd3103bbSwdenk
1801fd3103bbSwdenk		CONFIG_NEC_NL6448BC33_54
1802fd3103bbSwdenk
1803fd3103bbSwdenk			NEC NL6448BC33-54. 10.4", 640x480.
1804c609719bSwdenk			Active, color, single scan.
1805c609719bSwdenk
1806c609719bSwdenk		CONFIG_SHARP_16x9
1807c609719bSwdenk
1808c609719bSwdenk			Sharp 320x240. Active, color, single scan.
1809c609719bSwdenk			It isn't 16x9, and I am not sure what it is.
1810c609719bSwdenk
1811c609719bSwdenk		CONFIG_SHARP_LQ64D341
1812c609719bSwdenk
1813c609719bSwdenk			Sharp LQ64D341 display, 640x480.
1814c609719bSwdenk			Active, color, single scan.
1815c609719bSwdenk
1816c609719bSwdenk		CONFIG_HLD1045
1817c609719bSwdenk
1818c609719bSwdenk			HLD1045 display, 640x480.
1819c609719bSwdenk			Active, color, single scan.
1820c609719bSwdenk
1821c609719bSwdenk		CONFIG_OPTREX_BW
1822c609719bSwdenk
1823c609719bSwdenk			Optrex	 CBL50840-2 NF-FW 99 22 M5
1824c609719bSwdenk			or
1825c609719bSwdenk			Hitachi	 LMG6912RPFC-00T
1826c609719bSwdenk			or
1827c609719bSwdenk			Hitachi	 SP14Q002
1828c609719bSwdenk
1829c609719bSwdenk			320x240. Black & white.
1830c609719bSwdenk
1831c609719bSwdenk		Normally display is black on white background; define
18326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
1833c609719bSwdenk
1834676d319eSSimon Glass		CONFIG_LCD_ALIGNMENT
1835676d319eSSimon Glass
1836676d319eSSimon Glass		Normally the LCD is page-aligned (tyically 4KB). If this is
1837676d319eSSimon Glass		defined then the LCD will be aligned to this value instead.
1838676d319eSSimon Glass		For ARM it is sometimes useful to use MMU_SECTION_SIZE
1839676d319eSSimon Glass		here, since it is cheaper to change data cache settings on
1840676d319eSSimon Glass		a per-section basis.
1841676d319eSSimon Glass
18420d89efefSSimon Glass		CONFIG_CONSOLE_SCROLL_LINES
18430d89efefSSimon Glass
18440d89efefSSimon Glass		When the console need to be scrolled, this is the number of
18450d89efefSSimon Glass		lines to scroll by. It defaults to 1. Increasing this makes
18460d89efefSSimon Glass		the console jump but can help speed up operation when scrolling
18470d89efefSSimon Glass		is slow.
1848676d319eSSimon Glass
184945d7f525STom Wai-Hong Tam		CONFIG_LCD_BMP_RLE8
185045d7f525STom Wai-Hong Tam
185145d7f525STom Wai-Hong Tam		Support drawing of RLE8-compressed bitmaps on the LCD.
185245d7f525STom Wai-Hong Tam
1853735987c5STom Wai-Hong Tam		CONFIG_I2C_EDID
1854735987c5STom Wai-Hong Tam
1855735987c5STom Wai-Hong Tam		Enables an 'i2c edid' command which can read EDID
1856735987c5STom Wai-Hong Tam		information over I2C from an attached LCD display.
1857735987c5STom Wai-Hong Tam
18587152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN
1859d791b1dcSwdenk
1860d791b1dcSwdenk		If this option is set, the environment is checked for
1861d791b1dcSwdenk		a variable "splashimage". If found, the usual display
1862d791b1dcSwdenk		of logo, copyright and system information on the LCD
1863e94d2cd9Swdenk		is suppressed and the BMP image at the address
1864d791b1dcSwdenk		specified in "splashimage" is loaded instead. The
1865d791b1dcSwdenk		console is redirected to the "nulldev", too. This
1866d791b1dcSwdenk		allows for a "silent" boot where a splash screen is
1867d791b1dcSwdenk		loaded very quickly after power-on.
1868d791b1dcSwdenk
1869c0880485SNikita Kiryanov		CONFIG_SPLASHIMAGE_GUARD
1870c0880485SNikita Kiryanov
1871c0880485SNikita Kiryanov		If this option is set, then U-Boot will prevent the environment
1872c0880485SNikita Kiryanov		variable "splashimage" from being set to a problematic address
18731551df35STom Rini		(see README.displaying-bmps).
1874c0880485SNikita Kiryanov		This option is useful for targets where, due to alignment
1875c0880485SNikita Kiryanov		restrictions, an improperly aligned BMP image will cause a data
1876c0880485SNikita Kiryanov		abort. If you think you will not have problems with unaligned
1877c0880485SNikita Kiryanov		accesses (for example because your toolchain prevents them)
1878c0880485SNikita Kiryanov		there is no need to set this option.
1879c0880485SNikita Kiryanov
18801ca298ceSMatthias Weisser		CONFIG_SPLASH_SCREEN_ALIGN
18811ca298ceSMatthias Weisser
18821ca298ceSMatthias Weisser		If this option is set the splash image can be freely positioned
18831ca298ceSMatthias Weisser		on the screen. Environment variable "splashpos" specifies the
18841ca298ceSMatthias Weisser		position as "x,y". If a positive number is given it is used as
18851ca298ceSMatthias Weisser		number of pixel from left/top. If a negative number is given it
18861ca298ceSMatthias Weisser		is used as number of pixel from right/bottom. You can also
18871ca298ceSMatthias Weisser		specify 'm' for centering the image.
18881ca298ceSMatthias Weisser
18891ca298ceSMatthias Weisser		Example:
18901ca298ceSMatthias Weisser		setenv splashpos m,m
18911ca298ceSMatthias Weisser			=> image at center of screen
18921ca298ceSMatthias Weisser
18931ca298ceSMatthias Weisser		setenv splashpos 30,20
18941ca298ceSMatthias Weisser			=> image at x = 30 and y = 20
18951ca298ceSMatthias Weisser
18961ca298ceSMatthias Weisser		setenv splashpos -10,m
18971ca298ceSMatthias Weisser			=> vertically centered image
18981ca298ceSMatthias Weisser			   at x = dspWidth - bmpWidth - 9
18991ca298ceSMatthias Weisser
190098f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
190198f4a3dfSStefan Roese
190298f4a3dfSStefan Roese		If this option is set, additionally to standard BMP
190398f4a3dfSStefan Roese		images, gzipped BMP images can be displayed via the
190498f4a3dfSStefan Roese		splashscreen support or the bmp command.
190598f4a3dfSStefan Roese
1906d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1907d5011762SAnatolij Gustschin
1908d5011762SAnatolij Gustschin		If this option is set, 8-bit RLE compressed BMP images
1909d5011762SAnatolij Gustschin		can be displayed via the splashscreen support or the
1910d5011762SAnatolij Gustschin		bmp command.
1911d5011762SAnatolij Gustschin
1912f2b96dfbSLei Wen- Do compresssing for memory range:
1913f2b96dfbSLei Wen		CONFIG_CMD_ZIP
1914f2b96dfbSLei Wen
1915f2b96dfbSLei Wen		If this option is set, it would use zlib deflate method
1916f2b96dfbSLei Wen		to compress the specified memory at its best effort.
1917f2b96dfbSLei Wen
1918c29fdfc1Swdenk- Compression support:
19198ef70478SKees Cook		CONFIG_GZIP
19208ef70478SKees Cook
19218ef70478SKees Cook		Enabled by default to support gzip compressed images.
19228ef70478SKees Cook
1923c29fdfc1Swdenk		CONFIG_BZIP2
1924c29fdfc1Swdenk
1925c29fdfc1Swdenk		If this option is set, support for bzip2 compressed
1926c29fdfc1Swdenk		images is included. If not, only uncompressed and gzip
1927c29fdfc1Swdenk		compressed images are supported.
1928c29fdfc1Swdenk
1929c29fdfc1Swdenk		NOTE: the bzip2 algorithm requires a lot of RAM, so
19306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
1931c29fdfc1Swdenk		be at least 4MB.
1932d791b1dcSwdenk
1933fc9c1727SLuigi 'Comio' Mantellini		CONFIG_LZMA
1934fc9c1727SLuigi 'Comio' Mantellini
1935fc9c1727SLuigi 'Comio' Mantellini		If this option is set, support for lzma compressed
1936fc9c1727SLuigi 'Comio' Mantellini		images is included.
1937fc9c1727SLuigi 'Comio' Mantellini
1938fc9c1727SLuigi 'Comio' Mantellini		Note: The LZMA algorithm adds between 2 and 4KB of code and it
1939fc9c1727SLuigi 'Comio' Mantellini		requires an amount of dynamic memory that is given by the
1940fc9c1727SLuigi 'Comio' Mantellini		formula:
1941fc9c1727SLuigi 'Comio' Mantellini
1942fc9c1727SLuigi 'Comio' Mantellini			(1846 + 768 << (lc + lp)) * sizeof(uint16)
1943fc9c1727SLuigi 'Comio' Mantellini
1944fc9c1727SLuigi 'Comio' Mantellini		Where lc and lp stand for, respectively, Literal context bits
1945fc9c1727SLuigi 'Comio' Mantellini		and Literal pos bits.
1946fc9c1727SLuigi 'Comio' Mantellini
1947fc9c1727SLuigi 'Comio' Mantellini		This value is upper-bounded by 14MB in the worst case. Anyway,
1948fc9c1727SLuigi 'Comio' Mantellini		for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1949fc9c1727SLuigi 'Comio' Mantellini		total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1950fc9c1727SLuigi 'Comio' Mantellini		a very small buffer.
1951fc9c1727SLuigi 'Comio' Mantellini
1952fc9c1727SLuigi 'Comio' Mantellini		Use the lzmainfo tool to determinate the lc and lp values and
1953fc9c1727SLuigi 'Comio' Mantellini		then calculate the amount of needed dynamic memory (ensuring
19546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the appropriate CONFIG_SYS_MALLOC_LEN value).
1955fc9c1727SLuigi 'Comio' Mantellini
19568ef70478SKees Cook		CONFIG_LZO
19578ef70478SKees Cook
19588ef70478SKees Cook		If this option is set, support for LZO compressed images
19598ef70478SKees Cook		is included.
19608ef70478SKees Cook
196117ea1177Swdenk- MII/PHY support:
196217ea1177Swdenk		CONFIG_PHY_ADDR
196317ea1177Swdenk
196417ea1177Swdenk		The address of PHY on MII bus.
196517ea1177Swdenk
196617ea1177Swdenk		CONFIG_PHY_CLOCK_FREQ (ppc4xx)
196717ea1177Swdenk
196817ea1177Swdenk		The clock frequency of the MII bus
196917ea1177Swdenk
197017ea1177Swdenk		CONFIG_PHY_GIGE
197117ea1177Swdenk
197217ea1177Swdenk		If this option is set, support for speed/duplex
197311ccc33fSMarcel Ziswiler		detection of gigabit PHY is included.
197417ea1177Swdenk
197517ea1177Swdenk		CONFIG_PHY_RESET_DELAY
197617ea1177Swdenk
197717ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
197817ea1177Swdenk		reset before any MII register access is possible.
197917ea1177Swdenk		For such PHY, set this option to the usec delay
198017ea1177Swdenk		required. (minimum 300usec for LXT971A)
198117ea1177Swdenk
198217ea1177Swdenk		CONFIG_PHY_CMD_DELAY (ppc4xx)
198317ea1177Swdenk
198417ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
198517ea1177Swdenk		command issued before MII status register can be read
198617ea1177Swdenk
1987c609719bSwdenk- Ethernet address:
1988c609719bSwdenk		CONFIG_ETHADDR
1989c68a05feSrichardretanubun		CONFIG_ETH1ADDR
1990c609719bSwdenk		CONFIG_ETH2ADDR
1991c609719bSwdenk		CONFIG_ETH3ADDR
1992c68a05feSrichardretanubun		CONFIG_ETH4ADDR
1993c68a05feSrichardretanubun		CONFIG_ETH5ADDR
1994c609719bSwdenk
199511ccc33fSMarcel Ziswiler		Define a default value for Ethernet address to use
199611ccc33fSMarcel Ziswiler		for the respective Ethernet interface, in case this
1997c609719bSwdenk		is not determined automatically.
1998c609719bSwdenk
1999c609719bSwdenk- IP address:
2000c609719bSwdenk		CONFIG_IPADDR
2001c609719bSwdenk
2002c609719bSwdenk		Define a default value for the IP address to use for
200311ccc33fSMarcel Ziswiler		the default Ethernet interface, in case this is not
2004c609719bSwdenk		determined through e.g. bootp.
20051ebcd654SWolfgang Denk		(Environment variable "ipaddr")
2006c609719bSwdenk
2007c609719bSwdenk- Server IP address:
2008c609719bSwdenk		CONFIG_SERVERIP
2009c609719bSwdenk
2010c609719bSwdenk		Defines a default value for the IP address of a TFTP
2011c609719bSwdenk		server to contact when using the "tftboot" command.
20121ebcd654SWolfgang Denk		(Environment variable "serverip")
2013c609719bSwdenk
201497cfe861SRobin Getz		CONFIG_KEEP_SERVERADDR
201597cfe861SRobin Getz
201697cfe861SRobin Getz		Keeps the server's MAC address, in the env 'serveraddr'
201797cfe861SRobin Getz		for passing to bootargs (like Linux's netconsole option)
201897cfe861SRobin Getz
20191ebcd654SWolfgang Denk- Gateway IP address:
20201ebcd654SWolfgang Denk		CONFIG_GATEWAYIP
20211ebcd654SWolfgang Denk
20221ebcd654SWolfgang Denk		Defines a default value for the IP address of the
20231ebcd654SWolfgang Denk		default router where packets to other networks are
20241ebcd654SWolfgang Denk		sent to.
20251ebcd654SWolfgang Denk		(Environment variable "gatewayip")
20261ebcd654SWolfgang Denk
20271ebcd654SWolfgang Denk- Subnet mask:
20281ebcd654SWolfgang Denk		CONFIG_NETMASK
20291ebcd654SWolfgang Denk
20301ebcd654SWolfgang Denk		Defines a default value for the subnet mask (or
20311ebcd654SWolfgang Denk		routing prefix) which is used to determine if an IP
20321ebcd654SWolfgang Denk		address belongs to the local subnet or needs to be
20331ebcd654SWolfgang Denk		forwarded through a router.
20341ebcd654SWolfgang Denk		(Environment variable "netmask")
20351ebcd654SWolfgang Denk
203653a5c424SDavid Updegraff- Multicast TFTP Mode:
203753a5c424SDavid Updegraff		CONFIG_MCAST_TFTP
203853a5c424SDavid Updegraff
203953a5c424SDavid Updegraff		Defines whether you want to support multicast TFTP as per
204053a5c424SDavid Updegraff		rfc-2090; for example to work with atftp.  Lets lots of targets
204111ccc33fSMarcel Ziswiler		tftp down the same boot image concurrently.  Note: the Ethernet
204253a5c424SDavid Updegraff		driver in use must provide a function: mcast() to join/leave a
204353a5c424SDavid Updegraff		multicast group.
204453a5c424SDavid Updegraff
2045c609719bSwdenk- BOOTP Recovery Mode:
2046c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY
2047c609719bSwdenk
2048c609719bSwdenk		If you have many targets in a network that try to
2049c609719bSwdenk		boot using BOOTP, you may want to avoid that all
2050c609719bSwdenk		systems send out BOOTP requests at precisely the same
2051c609719bSwdenk		moment (which would happen for instance at recovery
2052c609719bSwdenk		from a power failure, when all systems will try to
2053c609719bSwdenk		boot, thus flooding the BOOTP server. Defining
2054c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
2055c609719bSwdenk		inserted before sending out BOOTP requests. The
20566c33c785SWolfgang Denk		following delays are inserted then:
2057c609719bSwdenk
2058c609719bSwdenk		1st BOOTP request:	delay 0 ... 1 sec
2059c609719bSwdenk		2nd BOOTP request:	delay 0 ... 2 sec
2060c609719bSwdenk		3rd BOOTP request:	delay 0 ... 4 sec
2061c609719bSwdenk		4th and following
2062c609719bSwdenk		BOOTP requests:		delay 0 ... 8 sec
2063c609719bSwdenk
206492ac8accSThierry Reding		CONFIG_BOOTP_ID_CACHE_SIZE
206592ac8accSThierry Reding
206692ac8accSThierry Reding		BOOTP packets are uniquely identified using a 32-bit ID. The
206792ac8accSThierry Reding		server will copy the ID from client requests to responses and
206892ac8accSThierry Reding		U-Boot will use this to determine if it is the destination of
206992ac8accSThierry Reding		an incoming response. Some servers will check that addresses
207092ac8accSThierry Reding		aren't in use before handing them out (usually using an ARP
207192ac8accSThierry Reding		ping) and therefore take up to a few hundred milliseconds to
207292ac8accSThierry Reding		respond. Network congestion may also influence the time it
207392ac8accSThierry Reding		takes for a response to make it back to the client. If that
207492ac8accSThierry Reding		time is too long, U-Boot will retransmit requests. In order
207592ac8accSThierry Reding		to allow earlier responses to still be accepted after these
207692ac8accSThierry Reding		retransmissions, U-Boot's BOOTP client keeps a small cache of
207792ac8accSThierry Reding		IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
207892ac8accSThierry Reding		cache. The default is to keep IDs for up to four outstanding
207992ac8accSThierry Reding		requests. Increasing this will allow U-Boot to accept offers
208092ac8accSThierry Reding		from a BOOTP client in networks with unusually high latency.
208192ac8accSThierry Reding
2082fe389a82Sstroese- DHCP Advanced Options:
20831fe80d79SJon Loeliger		You can fine tune the DHCP functionality by defining
20841fe80d79SJon Loeliger		CONFIG_BOOTP_* symbols:
2085fe389a82Sstroese
20861fe80d79SJon Loeliger		CONFIG_BOOTP_SUBNETMASK
20871fe80d79SJon Loeliger		CONFIG_BOOTP_GATEWAY
20881fe80d79SJon Loeliger		CONFIG_BOOTP_HOSTNAME
20891fe80d79SJon Loeliger		CONFIG_BOOTP_NISDOMAIN
20901fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTPATH
20911fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTFILESIZE
20921fe80d79SJon Loeliger		CONFIG_BOOTP_DNS
20931fe80d79SJon Loeliger		CONFIG_BOOTP_DNS2
20941fe80d79SJon Loeliger		CONFIG_BOOTP_SEND_HOSTNAME
20951fe80d79SJon Loeliger		CONFIG_BOOTP_NTPSERVER
20961fe80d79SJon Loeliger		CONFIG_BOOTP_TIMEOFFSET
20971fe80d79SJon Loeliger		CONFIG_BOOTP_VENDOREX
20982c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL
2099fe389a82Sstroese
21005d110f0aSWilson Callan		CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
21015d110f0aSWilson Callan		environment variable, not the BOOTP server.
2102fe389a82Sstroese
21032c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
21042c00e099SJoe Hershberger		after the configured retry count, the call will fail
21052c00e099SJoe Hershberger		instead of starting over.  This can be used to fail over
21062c00e099SJoe Hershberger		to Link-local IP address configuration if the DHCP server
21072c00e099SJoe Hershberger		is not available.
21082c00e099SJoe Hershberger
2109fe389a82Sstroese		CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
2110fe389a82Sstroese		serverip from a DHCP server, it is possible that more
2111fe389a82Sstroese		than one DNS serverip is offered to the client.
2112fe389a82Sstroese		If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
2113fe389a82Sstroese		serverip will be stored in the additional environment
2114fe389a82Sstroese		variable "dnsip2". The first DNS serverip is always
2115fe389a82Sstroese		stored in the variable "dnsip", when CONFIG_BOOTP_DNS
21161fe80d79SJon Loeliger		is defined.
2117fe389a82Sstroese
2118fe389a82Sstroese		CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
2119fe389a82Sstroese		to do a dynamic update of a DNS server. To do this, they
2120fe389a82Sstroese		need the hostname of the DHCP requester.
21215d110f0aSWilson Callan		If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
21221fe80d79SJon Loeliger		of the "hostname" environment variable is passed as
21231fe80d79SJon Loeliger		option 12 to the DHCP server.
2124fe389a82Sstroese
2125d9a2f416SAras Vaichas		CONFIG_BOOTP_DHCP_REQUEST_DELAY
2126d9a2f416SAras Vaichas
2127d9a2f416SAras Vaichas		A 32bit value in microseconds for a delay between
2128d9a2f416SAras Vaichas		receiving a "DHCP Offer" and sending the "DHCP Request".
2129d9a2f416SAras Vaichas		This fixes a problem with certain DHCP servers that don't
2130d9a2f416SAras Vaichas		respond 100% of the time to a "DHCP request". E.g. On an
2131d9a2f416SAras Vaichas		AT91RM9200 processor running at 180MHz, this delay needed
2132d9a2f416SAras Vaichas		to be *at least* 15,000 usec before a Windows Server 2003
2133d9a2f416SAras Vaichas		DHCP server would reply 100% of the time. I recommend at
2134d9a2f416SAras Vaichas		least 50,000 usec to be safe. The alternative is to hope
2135d9a2f416SAras Vaichas		that one of the retries will be successful but note that
2136d9a2f416SAras Vaichas		the DHCP timeout and retry process takes a longer than
2137d9a2f416SAras Vaichas		this delay.
2138d9a2f416SAras Vaichas
2139d22c338eSJoe Hershberger - Link-local IP address negotiation:
2140d22c338eSJoe Hershberger		Negotiate with other link-local clients on the local network
2141d22c338eSJoe Hershberger		for an address that doesn't require explicit configuration.
2142d22c338eSJoe Hershberger		This is especially useful if a DHCP server cannot be guaranteed
2143d22c338eSJoe Hershberger		to exist in all environments that the device must operate.
2144d22c338eSJoe Hershberger
2145d22c338eSJoe Hershberger		See doc/README.link-local for more information.
2146d22c338eSJoe Hershberger
2147a3d991bdSwdenk - CDP Options:
2148a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID
2149a3d991bdSwdenk
2150a3d991bdSwdenk		The device id used in CDP trigger frames.
2151a3d991bdSwdenk
2152a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID_PREFIX
2153a3d991bdSwdenk
2154a3d991bdSwdenk		A two character string which is prefixed to the MAC address
2155a3d991bdSwdenk		of the device.
2156a3d991bdSwdenk
2157a3d991bdSwdenk		CONFIG_CDP_PORT_ID
2158a3d991bdSwdenk
2159a3d991bdSwdenk		A printf format string which contains the ascii name of
2160a3d991bdSwdenk		the port. Normally is set to "eth%d" which sets
216111ccc33fSMarcel Ziswiler		eth0 for the first Ethernet, eth1 for the second etc.
2162a3d991bdSwdenk
2163a3d991bdSwdenk		CONFIG_CDP_CAPABILITIES
2164a3d991bdSwdenk
2165a3d991bdSwdenk		A 32bit integer which indicates the device capabilities;
2166a3d991bdSwdenk		0x00000010 for a normal host which does not forwards.
2167a3d991bdSwdenk
2168a3d991bdSwdenk		CONFIG_CDP_VERSION
2169a3d991bdSwdenk
2170a3d991bdSwdenk		An ascii string containing the version of the software.
2171a3d991bdSwdenk
2172a3d991bdSwdenk		CONFIG_CDP_PLATFORM
2173a3d991bdSwdenk
2174a3d991bdSwdenk		An ascii string containing the name of the platform.
2175a3d991bdSwdenk
2176a3d991bdSwdenk		CONFIG_CDP_TRIGGER
2177a3d991bdSwdenk
2178a3d991bdSwdenk		A 32bit integer sent on the trigger.
2179a3d991bdSwdenk
2180a3d991bdSwdenk		CONFIG_CDP_POWER_CONSUMPTION
2181a3d991bdSwdenk
2182a3d991bdSwdenk		A 16bit integer containing the power consumption of the
2183a3d991bdSwdenk		device in .1 of milliwatts.
2184a3d991bdSwdenk
2185a3d991bdSwdenk		CONFIG_CDP_APPLIANCE_VLAN_TYPE
2186a3d991bdSwdenk
2187a3d991bdSwdenk		A byte containing the id of the VLAN.
2188a3d991bdSwdenk
2189c609719bSwdenk- Status LED:	CONFIG_STATUS_LED
2190c609719bSwdenk
2191c609719bSwdenk		Several configurations allow to display the current
2192c609719bSwdenk		status using a LED. For instance, the LED will blink
2193c609719bSwdenk		fast while running U-Boot code, stop blinking as
2194c609719bSwdenk		soon as a reply to a BOOTP request was received, and
2195c609719bSwdenk		start blinking slow once the Linux kernel is running
2196c609719bSwdenk		(supported by a status LED driver in the Linux
2197c609719bSwdenk		kernel). Defining CONFIG_STATUS_LED enables this
2198c609719bSwdenk		feature in U-Boot.
2199c609719bSwdenk
22001df7bbbaSIgor Grinberg		Additional options:
22011df7bbbaSIgor Grinberg
22021df7bbbaSIgor Grinberg		CONFIG_GPIO_LED
22031df7bbbaSIgor Grinberg		The status LED can be connected to a GPIO pin.
22041df7bbbaSIgor Grinberg		In such cases, the gpio_led driver can be used as a
22051df7bbbaSIgor Grinberg		status LED backend implementation. Define CONFIG_GPIO_LED
22061df7bbbaSIgor Grinberg		to include the gpio_led driver in the U-Boot binary.
22071df7bbbaSIgor Grinberg
22089dfdcdfeSIgor Grinberg		CONFIG_GPIO_LED_INVERTED_TABLE
22099dfdcdfeSIgor Grinberg		Some GPIO connected LEDs may have inverted polarity in which
22109dfdcdfeSIgor Grinberg		case the GPIO high value corresponds to LED off state and
22119dfdcdfeSIgor Grinberg		GPIO low value corresponds to LED on state.
22129dfdcdfeSIgor Grinberg		In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
22139dfdcdfeSIgor Grinberg		with a list of GPIO LEDs that have inverted polarity.
22149dfdcdfeSIgor Grinberg
2215c609719bSwdenk- CAN Support:	CONFIG_CAN_DRIVER
2216c609719bSwdenk
2217c609719bSwdenk		Defining CONFIG_CAN_DRIVER enables CAN driver support
2218c609719bSwdenk		on those systems that support this (optional)
2219c609719bSwdenk		feature, like the TQM8xxL modules.
2220c609719bSwdenk
22213f4978c7SHeiko Schocher- I2C Support:	CONFIG_SYS_I2C
2222c609719bSwdenk
22233f4978c7SHeiko Schocher		This enable the NEW i2c subsystem, and will allow you to use
22243f4978c7SHeiko Schocher		i2c commands at the u-boot command line (as long as you set
22253f4978c7SHeiko Schocher		CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
22263f4978c7SHeiko Schocher		based realtime clock chips or other i2c devices. See
22273f4978c7SHeiko Schocher		common/cmd_i2c.c for a description of the command line
22283f4978c7SHeiko Schocher		interface.
22293f4978c7SHeiko Schocher
22303f4978c7SHeiko Schocher		ported i2c driver to the new framework:
2231ea818dbbSHeiko Schocher		- drivers/i2c/soft_i2c.c:
2232ea818dbbSHeiko Schocher		  - activate first bus with CONFIG_SYS_I2C_SOFT define
2233ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2234ea818dbbSHeiko Schocher		    for defining speed and slave address
2235ea818dbbSHeiko Schocher		  - activate second bus with I2C_SOFT_DECLARATIONS2 define
2236ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2237ea818dbbSHeiko Schocher		    for defining speed and slave address
2238ea818dbbSHeiko Schocher		  - activate third bus with I2C_SOFT_DECLARATIONS3 define
2239ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2240ea818dbbSHeiko Schocher		    for defining speed and slave address
2241ea818dbbSHeiko Schocher		  - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2242ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2243ea818dbbSHeiko Schocher		    for defining speed and slave address
22443f4978c7SHeiko Schocher
224500f792e0SHeiko Schocher		- drivers/i2c/fsl_i2c.c:
224600f792e0SHeiko Schocher		  - activate i2c driver with CONFIG_SYS_I2C_FSL
224700f792e0SHeiko Schocher		    define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
224800f792e0SHeiko Schocher		    offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
224900f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
225000f792e0SHeiko Schocher		    bus.
225100f792e0SHeiko Schocher		  - If your board supports a second fsl i2c bus, define
225200f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
225300f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_SPEED for the speed and
225400f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
225500f792e0SHeiko Schocher		    second bus.
225600f792e0SHeiko Schocher
22571f2ba722SSimon Glass		- drivers/i2c/tegra_i2c.c:
22581f2ba722SSimon Glass		  - activate this driver with CONFIG_SYS_I2C_TEGRA
22591f2ba722SSimon Glass		  - This driver adds 4 i2c buses with a fix speed from
22601f2ba722SSimon Glass		    100000 and the slave addr 0!
22611f2ba722SSimon Glass
2262880540deSDirk Eibach		- drivers/i2c/ppc4xx_i2c.c
2263880540deSDirk Eibach		  - activate this driver with CONFIG_SYS_I2C_PPC4XX
2264880540deSDirk Eibach		  - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2265880540deSDirk Eibach		  - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2266880540deSDirk Eibach
2267fac96408Strem		- drivers/i2c/i2c_mxc.c
2268fac96408Strem		  - activate this driver with CONFIG_SYS_I2C_MXC
2269fac96408Strem		  - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2270fac96408Strem		  - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2271fac96408Strem		  - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2272fac96408Strem		  - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2273fac96408Strem		  - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2274fac96408Strem		  - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
2275fac96408Strem		If thoses defines are not set, default value is 100000
2276fac96408Strem		for speed, and 0 for slave.
2277fac96408Strem
22781086bfa9SNobuhiro Iwamatsu		- drivers/i2c/rcar_i2c.c:
22791086bfa9SNobuhiro Iwamatsu		  - activate this driver with CONFIG_SYS_I2C_RCAR
22801086bfa9SNobuhiro Iwamatsu		  - This driver adds 4 i2c buses
22811086bfa9SNobuhiro Iwamatsu
22821086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
22831086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
22841086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
22851086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
22861086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
22871086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
22881086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
22891086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
22901086bfa9SNobuhiro Iwamatsu		  - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
22911086bfa9SNobuhiro Iwamatsu
22922035d77dSNobuhiro Iwamatsu		- drivers/i2c/sh_i2c.c:
22932035d77dSNobuhiro Iwamatsu		  - activate this driver with CONFIG_SYS_I2C_SH
22942035d77dSNobuhiro Iwamatsu		  - This driver adds from 2 to 5 i2c buses
22952035d77dSNobuhiro Iwamatsu
22962035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
22972035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
22982035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
22992035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
23002035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
23012035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
23022035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
23032035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
23042035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
23052035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
23062035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
23072035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
23082035d77dSNobuhiro Iwamatsu		  - CONFIF_SYS_I2C_SH_NUM_CONTROLLERS for nummber of i2c buses
23092035d77dSNobuhiro Iwamatsu
23106789e84eSHeiko Schocher		- drivers/i2c/omap24xx_i2c.c
23116789e84eSHeiko Schocher		  - activate this driver with CONFIG_SYS_I2C_OMAP24XX
23126789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
23136789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
23146789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
23156789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
23166789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
23176789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
23186789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
23196789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
23206789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
23216789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
23226789e84eSHeiko Schocher
23230bdffe71SHeiko Schocher		- drivers/i2c/zynq_i2c.c
23240bdffe71SHeiko Schocher		  - activate this driver with CONFIG_SYS_I2C_ZYNQ
23250bdffe71SHeiko Schocher		  - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
23260bdffe71SHeiko Schocher		  - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
23270bdffe71SHeiko Schocher
2328e717fc6dSNaveen Krishna Ch		- drivers/i2c/s3c24x0_i2c.c:
2329e717fc6dSNaveen Krishna Ch		  - activate this driver with CONFIG_SYS_I2C_S3C24X0
2330e717fc6dSNaveen Krishna Ch		  - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2331e717fc6dSNaveen Krishna Ch		    9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2332e717fc6dSNaveen Krishna Ch		    with a fix speed from 100000 and the slave addr 0!
2333e717fc6dSNaveen Krishna Ch
2334b46226bdSDirk Eibach		- drivers/i2c/ihs_i2c.c
2335b46226bdSDirk Eibach		  - activate this driver with CONFIG_SYS_I2C_IHS
2336b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
2337b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
2338b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
2339b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
2340b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
2341b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
2342b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
2343b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
2344b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
2345b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
2346b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
2347b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
2348b46226bdSDirk Eibach
23493f4978c7SHeiko Schocher		additional defines:
23503f4978c7SHeiko Schocher
23513f4978c7SHeiko Schocher		CONFIG_SYS_NUM_I2C_BUSES
23523f4978c7SHeiko Schocher		Hold the number of i2c busses you want to use. If you
23533f4978c7SHeiko Schocher		don't use/have i2c muxes on your i2c bus, this
23543f4978c7SHeiko Schocher		is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
23553f4978c7SHeiko Schocher		omit this define.
23563f4978c7SHeiko Schocher
23573f4978c7SHeiko Schocher		CONFIG_SYS_I2C_DIRECT_BUS
23583f4978c7SHeiko Schocher		define this, if you don't use i2c muxes on your hardware.
23593f4978c7SHeiko Schocher		if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
23603f4978c7SHeiko Schocher		omit this define.
23613f4978c7SHeiko Schocher
23623f4978c7SHeiko Schocher		CONFIG_SYS_I2C_MAX_HOPS
23633f4978c7SHeiko Schocher		define how many muxes are maximal consecutively connected
23643f4978c7SHeiko Schocher		on one i2c bus. If you not use i2c muxes, omit this
23653f4978c7SHeiko Schocher		define.
23663f4978c7SHeiko Schocher
23673f4978c7SHeiko Schocher		CONFIG_SYS_I2C_BUSES
23683f4978c7SHeiko Schocher		hold a list of busses you want to use, only used if
23693f4978c7SHeiko Schocher		CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
23703f4978c7SHeiko Schocher		a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
23713f4978c7SHeiko Schocher		CONFIG_SYS_NUM_I2C_BUSES = 9:
23723f4978c7SHeiko Schocher
23733f4978c7SHeiko Schocher		 CONFIG_SYS_I2C_BUSES	{{0, {I2C_NULL_HOP}}, \
23743f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
23753f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
23763f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
23773f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
23783f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
23793f4978c7SHeiko Schocher					{1, {I2C_NULL_HOP}}, \
23803f4978c7SHeiko Schocher					{1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
23813f4978c7SHeiko Schocher					{1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
23823f4978c7SHeiko Schocher					}
23833f4978c7SHeiko Schocher
23843f4978c7SHeiko Schocher		which defines
23853f4978c7SHeiko Schocher			bus 0 on adapter 0 without a mux
2386ea818dbbSHeiko Schocher			bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2387ea818dbbSHeiko Schocher			bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2388ea818dbbSHeiko Schocher			bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2389ea818dbbSHeiko Schocher			bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2390ea818dbbSHeiko Schocher			bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
23913f4978c7SHeiko Schocher			bus 6 on adapter 1 without a mux
2392ea818dbbSHeiko Schocher			bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2393ea818dbbSHeiko Schocher			bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
23943f4978c7SHeiko Schocher
23953f4978c7SHeiko Schocher		If you do not have i2c muxes on your board, omit this define.
23963f4978c7SHeiko Schocher
2397ea818dbbSHeiko Schocher- Legacy I2C Support:	CONFIG_HARD_I2C
23983f4978c7SHeiko Schocher
23993f4978c7SHeiko Schocher		NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
24003f4978c7SHeiko Schocher		provides the following compelling advantages:
24013f4978c7SHeiko Schocher
24023f4978c7SHeiko Schocher		- more than one i2c adapter is usable
24033f4978c7SHeiko Schocher		- approved multibus support
24043f4978c7SHeiko Schocher		- better i2c mux support
24053f4978c7SHeiko Schocher
24063f4978c7SHeiko Schocher		** Please consider updating your I2C driver now. **
24073f4978c7SHeiko Schocher
2408ea818dbbSHeiko Schocher		These enable legacy I2C serial bus commands. Defining
2409ea818dbbSHeiko Schocher		CONFIG_HARD_I2C will include the appropriate I2C driver
2410ea818dbbSHeiko Schocher		for the selected CPU.
2411c609719bSwdenk
2412b37c7e5eSwdenk		This will allow you to use i2c commands at the u-boot
2413602ad3b3SJon Loeliger		command line (as long as you set CONFIG_CMD_I2C in
2414b37c7e5eSwdenk		CONFIG_COMMANDS) and communicate with i2c based realtime
2415b37c7e5eSwdenk		clock chips. See common/cmd_i2c.c for a description of the
2416c609719bSwdenk		command line interface.
2417c609719bSwdenk
2418bb99ad6dSBen Warren		CONFIG_HARD_I2C selects a hardware I2C controller.
2419c609719bSwdenk
2420b37c7e5eSwdenk		There are several other quantities that must also be
2421ea818dbbSHeiko Schocher		defined when you define CONFIG_HARD_I2C.
2422c609719bSwdenk
24236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		In both cases you will need to define CONFIG_SYS_I2C_SPEED
2424b37c7e5eSwdenk		to be the frequency (in Hz) at which you wish your i2c bus
24256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
242611ccc33fSMarcel Ziswiler		the CPU's i2c node address).
2427c609719bSwdenk
24288d321b81SPeter Tyser		Now, the u-boot i2c code for the mpc8xx
2429a47a12beSStefan Roese		(arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
24308d321b81SPeter Tyser		and so its address should therefore be cleared to 0 (See,
24318d321b81SPeter Tyser		eg, MPC823e User's Manual p.16-473). So, set
24328d321b81SPeter Tyser		CONFIG_SYS_I2C_SLAVE to 0.
2433b37c7e5eSwdenk
24345da71efaSEric Millbrandt		CONFIG_SYS_I2C_INIT_MPC5XXX
24355da71efaSEric Millbrandt
24365da71efaSEric Millbrandt		When a board is reset during an i2c bus transfer
24375da71efaSEric Millbrandt		chips might think that the current transfer is still
24385da71efaSEric Millbrandt		in progress.  Reset the slave devices by sending start
24395da71efaSEric Millbrandt		commands until the slave device responds.
24405da71efaSEric Millbrandt
2441b37c7e5eSwdenk		That's all that's required for CONFIG_HARD_I2C.
2442b37c7e5eSwdenk
2443ea818dbbSHeiko Schocher		If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
2444b37c7e5eSwdenk		then the following macros need to be defined (examples are
2445b37c7e5eSwdenk		from include/configs/lwmon.h):
2446c609719bSwdenk
2447c609719bSwdenk		I2C_INIT
2448c609719bSwdenk
2449b37c7e5eSwdenk		(Optional). Any commands necessary to enable the I2C
2450c609719bSwdenk		controller or configure ports.
2451c609719bSwdenk
2452b37c7e5eSwdenk		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
2453b37c7e5eSwdenk
2454c609719bSwdenk		I2C_PORT
2455c609719bSwdenk
2456c609719bSwdenk		(Only for MPC8260 CPU). The I/O port to use (the code
2457c609719bSwdenk		assumes both bits are on the same port). Valid values
2458c609719bSwdenk		are 0..3 for ports A..D.
2459c609719bSwdenk
2460c609719bSwdenk		I2C_ACTIVE
2461c609719bSwdenk
2462c609719bSwdenk		The code necessary to make the I2C data line active
2463c609719bSwdenk		(driven).  If the data line is open collector, this
2464c609719bSwdenk		define can be null.
2465c609719bSwdenk
2466b37c7e5eSwdenk		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
2467b37c7e5eSwdenk
2468c609719bSwdenk		I2C_TRISTATE
2469c609719bSwdenk
2470c609719bSwdenk		The code necessary to make the I2C data line tri-stated
2471c609719bSwdenk		(inactive).  If the data line is open collector, this
2472c609719bSwdenk		define can be null.
2473c609719bSwdenk
2474b37c7e5eSwdenk		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2475b37c7e5eSwdenk
2476c609719bSwdenk		I2C_READ
2477c609719bSwdenk
2478472d5460SYork Sun		Code that returns true if the I2C data line is high,
2479472d5460SYork Sun		false if it is low.
2480c609719bSwdenk
2481b37c7e5eSwdenk		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2482b37c7e5eSwdenk
2483c609719bSwdenk		I2C_SDA(bit)
2484c609719bSwdenk
2485472d5460SYork Sun		If <bit> is true, sets the I2C data line high. If it
2486472d5460SYork Sun		is false, it clears it (low).
2487c609719bSwdenk
2488b37c7e5eSwdenk		eg: #define I2C_SDA(bit) \
2489b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
2490b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
2491b37c7e5eSwdenk
2492c609719bSwdenk		I2C_SCL(bit)
2493c609719bSwdenk
2494472d5460SYork Sun		If <bit> is true, sets the I2C clock line high. If it
2495472d5460SYork Sun		is false, it clears it (low).
2496c609719bSwdenk
2497b37c7e5eSwdenk		eg: #define I2C_SCL(bit) \
2498b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
2499b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
2500b37c7e5eSwdenk
2501c609719bSwdenk		I2C_DELAY
2502c609719bSwdenk
2503c609719bSwdenk		This delay is invoked four times per clock cycle so this
2504c609719bSwdenk		controls the rate of data transfer.  The data rate thus
2505b37c7e5eSwdenk		is 1 / (I2C_DELAY * 4). Often defined to be something
2506b37c7e5eSwdenk		like:
2507b37c7e5eSwdenk
2508b37c7e5eSwdenk		#define I2C_DELAY  udelay(2)
2509c609719bSwdenk
2510793b5726SMike Frysinger		CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2511793b5726SMike Frysinger
2512793b5726SMike Frysinger		If your arch supports the generic GPIO framework (asm/gpio.h),
2513793b5726SMike Frysinger		then you may alternatively define the two GPIOs that are to be
2514793b5726SMike Frysinger		used as SCL / SDA.  Any of the previous I2C_xxx macros will
2515793b5726SMike Frysinger		have GPIO-based defaults assigned to them as appropriate.
2516793b5726SMike Frysinger
2517793b5726SMike Frysinger		You should define these to the GPIO value as given directly to
2518793b5726SMike Frysinger		the generic GPIO functions.
2519793b5726SMike Frysinger
25206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_INIT_BOARD
252147cd00faSwdenk
252247cd00faSwdenk		When a board is reset during an i2c bus transfer
252347cd00faSwdenk		chips might think that the current transfer is still
252447cd00faSwdenk		in progress. On some boards it is possible to access
252547cd00faSwdenk		the i2c SCLK line directly, either by using the
252647cd00faSwdenk		processor pin as a GPIO or by having a second pin
252747cd00faSwdenk		connected to the bus. If this option is defined a
252847cd00faSwdenk		custom i2c_init_board() routine in boards/xxx/board.c
252947cd00faSwdenk		is run early in the boot sequence.
253047cd00faSwdenk
253126a33504SRichard Retanubun		CONFIG_SYS_I2C_BOARD_LATE_INIT
253226a33504SRichard Retanubun
253326a33504SRichard Retanubun		An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
253426a33504SRichard Retanubun		defined a custom i2c_board_late_init() routine in
253526a33504SRichard Retanubun		boards/xxx/board.c is run AFTER the operations in i2c_init()
253626a33504SRichard Retanubun		is completed. This callpoint can be used to unreset i2c bus
253726a33504SRichard Retanubun		using CPU i2c controller register accesses for CPUs whose i2c
253826a33504SRichard Retanubun		controller provide such a method. It is called at the end of
253926a33504SRichard Retanubun		i2c_init() to allow i2c_init operations to setup the i2c bus
254026a33504SRichard Retanubun		controller on the CPU (e.g. setting bus speed & slave address).
254126a33504SRichard Retanubun
254217ea1177Swdenk		CONFIG_I2CFAST (PPC405GP|PPC405EP only)
254317ea1177Swdenk
254417ea1177Swdenk		This option enables configuration of bi_iic_fast[] flags
254517ea1177Swdenk		in u-boot bd_info structure based on u-boot environment
254617ea1177Swdenk		variable "i2cfast". (see also i2cfast)
254717ea1177Swdenk
2548bb99ad6dSBen Warren		CONFIG_I2C_MULTI_BUS
2549bb99ad6dSBen Warren
2550bb99ad6dSBen Warren		This option allows the use of multiple I2C buses, each of which
2551bb99ad6dSBen Warren		must have a controller.	 At any point in time, only one bus is
2552bb99ad6dSBen Warren		active.	 To switch to a different bus, use the 'i2c dev' command.
2553bb99ad6dSBen Warren		Note that bus numbering is zero-based.
2554bb99ad6dSBen Warren
25556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_NOPROBES
2556bb99ad6dSBen Warren
2557bb99ad6dSBen Warren		This option specifies a list of I2C devices that will be skipped
25580f89c54bSPeter Tyser		when the 'i2c probe' command is issued.	 If CONFIG_I2C_MULTI_BUS
25590f89c54bSPeter Tyser		is set, specify a list of bus-device pairs.  Otherwise, specify
25600f89c54bSPeter Tyser		a 1D array of device addresses
2561bb99ad6dSBen Warren
2562bb99ad6dSBen Warren		e.g.
2563bb99ad6dSBen Warren			#undef	CONFIG_I2C_MULTI_BUS
25646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
2565bb99ad6dSBen Warren
2566bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on a board with one I2C bus
2567bb99ad6dSBen Warren
2568bb99ad6dSBen Warren			#define CONFIG_I2C_MULTI_BUS
25696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_MULTI_NOPROBES	{{0,0x50},{0,0x68},{1,0x54}}
2570bb99ad6dSBen Warren
2571bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2572bb99ad6dSBen Warren
25736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SPD_BUS_NUM
2574be5e6181STimur Tabi
2575be5e6181STimur Tabi		If defined, then this indicates the I2C bus number for DDR SPD.
2576be5e6181STimur Tabi		If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2577be5e6181STimur Tabi
25786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_BUS_NUM
25790dc018ecSStefan Roese
25800dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the RTC.
25810dc018ecSStefan Roese		If not defined, then U-Boot assumes that RTC is on I2C bus 0.
25820dc018ecSStefan Roese
25836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_DTT_BUS_NUM
25840dc018ecSStefan Roese
25850dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the DTT.
25860dc018ecSStefan Roese		If not defined, then U-Boot assumes that DTT is on I2C bus 0.
25870dc018ecSStefan Roese
25886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_DTT_ADDR:
25899ebbb54fSVictor Gallardo
25909ebbb54fSVictor Gallardo		If defined, specifies the I2C address of the DTT device.
25919ebbb54fSVictor Gallardo		If not defined, then U-Boot uses predefined value for
25929ebbb54fSVictor Gallardo		specified DTT device.
25939ebbb54fSVictor Gallardo
25942ac6985aSAndrew Dyer		CONFIG_SOFT_I2C_READ_REPEATED_START
25952ac6985aSAndrew Dyer
25962ac6985aSAndrew Dyer		defining this will force the i2c_read() function in
25972ac6985aSAndrew Dyer		the soft_i2c driver to perform an I2C repeated start
25982ac6985aSAndrew Dyer		between writing the address pointer and reading the
25992ac6985aSAndrew Dyer		data.  If this define is omitted the default behaviour
26002ac6985aSAndrew Dyer		of doing a stop-start sequence will be used.  Most I2C
26012ac6985aSAndrew Dyer		devices can use either method, but some require one or
26022ac6985aSAndrew Dyer		the other.
2603be5e6181STimur Tabi
2604c609719bSwdenk- SPI Support:	CONFIG_SPI
2605c609719bSwdenk
2606c609719bSwdenk		Enables SPI driver (so far only tested with
2607c609719bSwdenk		SPI EEPROM, also an instance works with Crystal A/D and
2608c609719bSwdenk		D/As on the SACSng board)
2609c609719bSwdenk
26106639562eSYoshihiro Shimoda		CONFIG_SH_SPI
26116639562eSYoshihiro Shimoda
26126639562eSYoshihiro Shimoda		Enables the driver for SPI controller on SuperH. Currently
26136639562eSYoshihiro Shimoda		only SH7757 is supported.
26146639562eSYoshihiro Shimoda
2615c609719bSwdenk		CONFIG_SPI_X
2616c609719bSwdenk
2617c609719bSwdenk		Enables extended (16-bit) SPI EEPROM addressing.
2618c609719bSwdenk		(symmetrical to CONFIG_I2C_X)
2619c609719bSwdenk
2620c609719bSwdenk		CONFIG_SOFT_SPI
2621c609719bSwdenk
2622c609719bSwdenk		Enables a software (bit-bang) SPI driver rather than
2623c609719bSwdenk		using hardware support. This is a general purpose
2624c609719bSwdenk		driver that only requires three general I/O port pins
2625c609719bSwdenk		(two outputs, one input) to function. If this is
2626c609719bSwdenk		defined, the board configuration must define several
2627c609719bSwdenk		SPI configuration items (port pins to use, etc). For
2628c609719bSwdenk		an example, see include/configs/sacsng.h.
2629c609719bSwdenk
263004a9e118SBen Warren		CONFIG_HARD_SPI
263104a9e118SBen Warren
263204a9e118SBen Warren		Enables a hardware SPI driver for general-purpose reads
263304a9e118SBen Warren		and writes.  As with CONFIG_SOFT_SPI, the board configuration
263404a9e118SBen Warren		must define a list of chip-select function pointers.
263504a9e118SBen Warren		Currently supported on some MPC8xxx processors.	 For an
263604a9e118SBen Warren		example, see include/configs/mpc8349emds.h.
263704a9e118SBen Warren
263838254f45SGuennadi Liakhovetski		CONFIG_MXC_SPI
263938254f45SGuennadi Liakhovetski
264038254f45SGuennadi Liakhovetski		Enables the driver for the SPI controllers on i.MX and MXC
26412e3cd1cdSFabio Estevam		SoCs. Currently i.MX31/35/51 are supported.
264238254f45SGuennadi Liakhovetski
2643f659b573SHeiko Schocher		CONFIG_SYS_SPI_MXC_WAIT
2644f659b573SHeiko Schocher		Timeout for waiting until spi transfer completed.
2645f659b573SHeiko Schocher		default: (CONFIG_SYS_HZ/100)     /* 10 ms */
2646f659b573SHeiko Schocher
26470133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA
26480133502eSMatthias Fuchs
26490133502eSMatthias Fuchs		Enables FPGA subsystem.
26500133502eSMatthias Fuchs
26510133502eSMatthias Fuchs		CONFIG_FPGA_<vendor>
26520133502eSMatthias Fuchs
26530133502eSMatthias Fuchs		Enables support for specific chip vendors.
26540133502eSMatthias Fuchs		(ALTERA, XILINX)
26550133502eSMatthias Fuchs
26560133502eSMatthias Fuchs		CONFIG_FPGA_<family>
26570133502eSMatthias Fuchs
26580133502eSMatthias Fuchs		Enables support for FPGA family.
26590133502eSMatthias Fuchs		(SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
26600133502eSMatthias Fuchs
26610133502eSMatthias Fuchs		CONFIG_FPGA_COUNT
2662c609719bSwdenk
2663c609719bSwdenk		Specify the number of FPGA devices to support.
2664c609719bSwdenk
266564e809afSSiva Durga Prasad Paladugu		CONFIG_CMD_FPGA_LOADMK
266664e809afSSiva Durga Prasad Paladugu
266764e809afSSiva Durga Prasad Paladugu		Enable support for fpga loadmk command
266864e809afSSiva Durga Prasad Paladugu
266967193864SMichal Simek		CONFIG_CMD_FPGA_LOADP
267067193864SMichal Simek
267167193864SMichal Simek		Enable support for fpga loadp command - load partial bitstream
267267193864SMichal Simek
267367193864SMichal Simek		CONFIG_CMD_FPGA_LOADBP
267467193864SMichal Simek
267567193864SMichal Simek		Enable support for fpga loadbp command - load partial bitstream
267667193864SMichal Simek		(Xilinx only)
267767193864SMichal Simek
26786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_PROG_FEEDBACK
2679c609719bSwdenk
2680c609719bSwdenk		Enable printing of hash marks during FPGA configuration.
2681c609719bSwdenk
26826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_BUSY
2683c609719bSwdenk
2684c609719bSwdenk		Enable checks on FPGA configuration interface busy
2685c609719bSwdenk		status by the configuration function. This option
2686c609719bSwdenk		will require a board or device specific function to
2687c609719bSwdenk		be written.
2688c609719bSwdenk
2689c609719bSwdenk		CONFIG_FPGA_DELAY
2690c609719bSwdenk
2691c609719bSwdenk		If defined, a function that provides delays in the FPGA
2692c609719bSwdenk		configuration driver.
2693c609719bSwdenk
26946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_CTRLC
2695c609719bSwdenk		Allow Control-C to interrupt FPGA configuration
2696c609719bSwdenk
26976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_ERROR
2698c609719bSwdenk
2699c609719bSwdenk		Check for configuration errors during FPGA bitfile
2700c609719bSwdenk		loading. For example, abort during Virtex II
2701c609719bSwdenk		configuration if the INIT_B line goes low (which
2702c609719bSwdenk		indicated a CRC error).
2703c609719bSwdenk
27046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_INIT
2705c609719bSwdenk
2706c609719bSwdenk		Maximum time to wait for the INIT_B line to deassert
2707c609719bSwdenk		after PROB_B has been deasserted during a Virtex II
2708c609719bSwdenk		FPGA configuration sequence. The default time is 500
270911ccc33fSMarcel Ziswiler		ms.
2710c609719bSwdenk
27116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_BUSY
2712c609719bSwdenk
2713c609719bSwdenk		Maximum time to wait for BUSY to deassert during
271411ccc33fSMarcel Ziswiler		Virtex II FPGA configuration. The default is 5 ms.
2715c609719bSwdenk
27166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_CONFIG
2717c609719bSwdenk
2718c609719bSwdenk		Time to wait after FPGA configuration. The default is
271911ccc33fSMarcel Ziswiler		200 ms.
2720c609719bSwdenk
2721c609719bSwdenk- Configuration Management:
2722b2b8a696SStefan Roese		CONFIG_BUILD_TARGET
2723b2b8a696SStefan Roese
2724b2b8a696SStefan Roese		Some SoCs need special image types (e.g. U-Boot binary
2725b2b8a696SStefan Roese		with a special header) as build targets. By defining
2726b2b8a696SStefan Roese		CONFIG_BUILD_TARGET in the SoC / board header, this
2727b2b8a696SStefan Roese		special image will be automatically built upon calling
2728b2b8a696SStefan Roese		make / MAKEALL.
2729b2b8a696SStefan Roese
2730c609719bSwdenk		CONFIG_IDENT_STRING
2731c609719bSwdenk
2732c609719bSwdenk		If defined, this string will be added to the U-Boot
2733c609719bSwdenk		version information (U_BOOT_VERSION)
2734c609719bSwdenk
2735c609719bSwdenk- Vendor Parameter Protection:
2736c609719bSwdenk
2737c609719bSwdenk		U-Boot considers the values of the environment
2738c609719bSwdenk		variables "serial#" (Board Serial Number) and
27397152b1d0Swdenk		"ethaddr" (Ethernet Address) to be parameters that
2740c609719bSwdenk		are set once by the board vendor / manufacturer, and
2741c609719bSwdenk		protects these variables from casual modification by
2742c609719bSwdenk		the user. Once set, these variables are read-only,
2743c609719bSwdenk		and write or delete attempts are rejected. You can
274411ccc33fSMarcel Ziswiler		change this behaviour:
2745c609719bSwdenk
2746c609719bSwdenk		If CONFIG_ENV_OVERWRITE is #defined in your config
2747c609719bSwdenk		file, the write protection for vendor parameters is
274847cd00faSwdenk		completely disabled. Anybody can change or delete
2749c609719bSwdenk		these parameters.
2750c609719bSwdenk
2751c609719bSwdenk		Alternatively, if you #define _both_ CONFIG_ETHADDR
2752c609719bSwdenk		_and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
275311ccc33fSMarcel Ziswiler		Ethernet address is installed in the environment,
2754c609719bSwdenk		which can be changed exactly ONCE by the user. [The
2755c609719bSwdenk		serial# is unaffected by this, i. e. it remains
2756c609719bSwdenk		read-only.]
2757c609719bSwdenk
27582598090bSJoe Hershberger		The same can be accomplished in a more flexible way
27592598090bSJoe Hershberger		for any variable by configuring the type of access
27602598090bSJoe Hershberger		to allow for those variables in the ".flags" variable
27612598090bSJoe Hershberger		or define CONFIG_ENV_FLAGS_LIST_STATIC.
27622598090bSJoe Hershberger
2763c609719bSwdenk- Protected RAM:
2764c609719bSwdenk		CONFIG_PRAM
2765c609719bSwdenk
2766c609719bSwdenk		Define this variable to enable the reservation of
2767c609719bSwdenk		"protected RAM", i. e. RAM which is not overwritten
2768c609719bSwdenk		by U-Boot. Define CONFIG_PRAM to hold the number of
2769c609719bSwdenk		kB you want to reserve for pRAM. You can overwrite
2770c609719bSwdenk		this default value by defining an environment
2771c609719bSwdenk		variable "pram" to the number of kB you want to
2772c609719bSwdenk		reserve. Note that the board info structure will
2773c609719bSwdenk		still show the full amount of RAM. If pRAM is
2774c609719bSwdenk		reserved, a new environment variable "mem" will
2775c609719bSwdenk		automatically be defined to hold the amount of
2776c609719bSwdenk		remaining RAM in a form that can be passed as boot
2777c609719bSwdenk		argument to Linux, for instance like that:
2778c609719bSwdenk
2779fe126d8bSWolfgang Denk			setenv bootargs ... mem=\${mem}
2780c609719bSwdenk			saveenv
2781c609719bSwdenk
2782c609719bSwdenk		This way you can tell Linux not to use this memory,
2783c609719bSwdenk		either, which results in a memory region that will
2784c609719bSwdenk		not be affected by reboots.
2785c609719bSwdenk
2786c609719bSwdenk		*WARNING* If your board configuration uses automatic
2787c609719bSwdenk		detection of the RAM size, you must make sure that
2788c609719bSwdenk		this memory test is non-destructive. So far, the
2789c609719bSwdenk		following board configurations are known to be
2790c609719bSwdenk		"pRAM-clean":
2791c609719bSwdenk
27921b0757ecSWolfgang Denk			IVMS8, IVML24, SPD8xx, TQM8xxL,
27931b0757ecSWolfgang Denk			HERMES, IP860, RPXlite, LWMON,
2794544d97e9SWolfgang Denk			FLAGADM, TQM8260
2795c609719bSwdenk
279640fef049SGabe Black- Access to physical memory region (> 4GB)
279740fef049SGabe Black		Some basic support is provided for operations on memory not
279840fef049SGabe Black		normally accessible to U-Boot - e.g. some architectures
279940fef049SGabe Black		support access to more than 4GB of memory on 32-bit
280040fef049SGabe Black		machines using physical address extension or similar.
280140fef049SGabe Black		Define CONFIG_PHYSMEM to access this basic support, which
280240fef049SGabe Black		currently only supports clearing the memory.
280340fef049SGabe Black
2804c609719bSwdenk- Error Recovery:
2805c609719bSwdenk		CONFIG_PANIC_HANG
2806c609719bSwdenk
2807c609719bSwdenk		Define this variable to stop the system in case of a
2808c609719bSwdenk		fatal error, so that you have to reset it manually.
2809c609719bSwdenk		This is probably NOT a good idea for an embedded
281011ccc33fSMarcel Ziswiler		system where you want the system to reboot
2811c609719bSwdenk		automatically as fast as possible, but it may be
2812c609719bSwdenk		useful during development since you can try to debug
2813c609719bSwdenk		the conditions that lead to the situation.
2814c609719bSwdenk
2815c609719bSwdenk		CONFIG_NET_RETRY_COUNT
2816c609719bSwdenk
2817c609719bSwdenk		This variable defines the number of retries for
2818c609719bSwdenk		network operations like ARP, RARP, TFTP, or BOOTP
2819c609719bSwdenk		before giving up the operation. If not defined, a
2820c609719bSwdenk		default value of 5 is used.
2821c609719bSwdenk
282240cb90eeSGuennadi Liakhovetski		CONFIG_ARP_TIMEOUT
282340cb90eeSGuennadi Liakhovetski
282440cb90eeSGuennadi Liakhovetski		Timeout waiting for an ARP reply in milliseconds.
282540cb90eeSGuennadi Liakhovetski
282648a3e999STetsuyuki Kobayashi		CONFIG_NFS_TIMEOUT
282748a3e999STetsuyuki Kobayashi
282848a3e999STetsuyuki Kobayashi		Timeout in milliseconds used in NFS protocol.
282948a3e999STetsuyuki Kobayashi		If you encounter "ERROR: Cannot umount" in nfs command,
283048a3e999STetsuyuki Kobayashi		try longer timeout such as
283148a3e999STetsuyuki Kobayashi		#define CONFIG_NFS_TIMEOUT 10000UL
283248a3e999STetsuyuki Kobayashi
2833c609719bSwdenk- Command Interpreter:
28348078f1a5SWolfgang Denk		CONFIG_AUTO_COMPLETE
283504a85b3bSwdenk
283604a85b3bSwdenk		Enable auto completion of commands using TAB.
283704a85b3bSwdenk
28386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_HUSH_PARSER
2839c609719bSwdenk
2840c609719bSwdenk		Define this variable to enable the "hush" shell (from
2841c609719bSwdenk		Busybox) as command line interpreter, thus enabling
2842c609719bSwdenk		powerful command line syntax like
2843c609719bSwdenk		if...then...else...fi conditionals or `&&' and '||'
2844c609719bSwdenk		constructs ("shell scripts").
2845c609719bSwdenk
2846c609719bSwdenk		If undefined, you get the old, much simpler behaviour
2847c609719bSwdenk		with a somewhat smaller memory footprint.
2848c609719bSwdenk
2849c609719bSwdenk
28506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_PROMPT_HUSH_PS2
2851c609719bSwdenk
2852c609719bSwdenk		This defines the secondary prompt string, which is
2853c609719bSwdenk		printed when the command interpreter needs more input
2854c609719bSwdenk		to complete a command. Usually "> ".
2855c609719bSwdenk
2856c609719bSwdenk	Note:
2857c609719bSwdenk
2858c609719bSwdenk		In the current implementation, the local variables
2859c609719bSwdenk		space and global environment variables space are
2860c609719bSwdenk		separated. Local variables are those you define by
28613b57fe0aSwdenk		simply typing `name=value'. To access a local
2862c609719bSwdenk		variable later on, you have write `$name' or
28633b57fe0aSwdenk		`${name}'; to execute the contents of a variable
28643b57fe0aSwdenk		directly type `$name' at the command prompt.
2865c609719bSwdenk
2866c609719bSwdenk		Global environment variables are those you use
2867c609719bSwdenk		setenv/printenv to work with. To run a command stored
2868c609719bSwdenk		in such a variable, you need to use the run command,
2869c609719bSwdenk		and you must not use the '$' sign to access them.
2870c609719bSwdenk
2871c609719bSwdenk		To store commands and special characters in a
2872c609719bSwdenk		variable, please use double quotation marks
2873c609719bSwdenk		surrounding the whole text of the variable, instead
2874c609719bSwdenk		of the backslashes before semicolons and special
2875c609719bSwdenk		symbols.
2876c609719bSwdenk
2877aa0c71acSWolfgang Denk- Commandline Editing and History:
2878aa0c71acSWolfgang Denk		CONFIG_CMDLINE_EDITING
2879aa0c71acSWolfgang Denk
288011ccc33fSMarcel Ziswiler		Enable editing and History functions for interactive
2881aa0c71acSWolfgang Denk		commandline input operations
2882aa0c71acSWolfgang Denk
2883a8c7c708Swdenk- Default Environment:
2884c609719bSwdenk		CONFIG_EXTRA_ENV_SETTINGS
2885c609719bSwdenk
2886c609719bSwdenk		Define this to contain any number of null terminated
2887c609719bSwdenk		strings (variable = value pairs) that will be part of
28887152b1d0Swdenk		the default environment compiled into the boot image.
28892262cfeeSwdenk
2890c609719bSwdenk		For example, place something like this in your
2891c609719bSwdenk		board's config file:
2892c609719bSwdenk
2893c609719bSwdenk		#define CONFIG_EXTRA_ENV_SETTINGS \
2894c609719bSwdenk			"myvar1=value1\0" \
2895c609719bSwdenk			"myvar2=value2\0"
2896c609719bSwdenk
2897c609719bSwdenk		Warning: This method is based on knowledge about the
2898c609719bSwdenk		internal format how the environment is stored by the
28992262cfeeSwdenk		U-Boot code. This is NOT an official, exported
2900c609719bSwdenk		interface! Although it is unlikely that this format
29017152b1d0Swdenk		will change soon, there is no guarantee either.
2902c609719bSwdenk		You better know what you are doing here.
2903c609719bSwdenk
2904c609719bSwdenk		Note: overly (ab)use of the default environment is
2905c609719bSwdenk		discouraged. Make sure to check other ways to preset
290674de7aefSWolfgang Denk		the environment like the "source" command or the
2907c609719bSwdenk		boot command first.
2908c609719bSwdenk
29095e724ca2SStephen Warren		CONFIG_ENV_VARS_UBOOT_CONFIG
29105e724ca2SStephen Warren
29115e724ca2SStephen Warren		Define this in order to add variables describing the
29125e724ca2SStephen Warren		U-Boot build configuration to the default environment.
29135e724ca2SStephen Warren		These will be named arch, cpu, board, vendor, and soc.
29145e724ca2SStephen Warren
29155e724ca2SStephen Warren		Enabling this option will cause the following to be defined:
29165e724ca2SStephen Warren
29175e724ca2SStephen Warren		- CONFIG_SYS_ARCH
29185e724ca2SStephen Warren		- CONFIG_SYS_CPU
29195e724ca2SStephen Warren		- CONFIG_SYS_BOARD
29205e724ca2SStephen Warren		- CONFIG_SYS_VENDOR
29215e724ca2SStephen Warren		- CONFIG_SYS_SOC
29225e724ca2SStephen Warren
29237e27f89fSTom Rini		CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
29247e27f89fSTom Rini
29257e27f89fSTom Rini		Define this in order to add variables describing certain
29267e27f89fSTom Rini		run-time determined information about the hardware to the
29277e27f89fSTom Rini		environment.  These will be named board_name, board_rev.
29287e27f89fSTom Rini
292906fd8538SSimon Glass		CONFIG_DELAY_ENVIRONMENT
293006fd8538SSimon Glass
293106fd8538SSimon Glass		Normally the environment is loaded when the board is
293206fd8538SSimon Glass		intialised so that it is available to U-Boot. This inhibits
293306fd8538SSimon Glass		that so that the environment is not available until
293406fd8538SSimon Glass		explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
293506fd8538SSimon Glass		this is instead controlled by the value of
293606fd8538SSimon Glass		/config/load-environment.
293706fd8538SSimon Glass
2938a8c7c708Swdenk- DataFlash Support:
29392abbe075Swdenk		CONFIG_HAS_DATAFLASH
29402abbe075Swdenk
29412abbe075Swdenk		Defining this option enables DataFlash features and
29422abbe075Swdenk		allows to read/write in Dataflash via the standard
29432abbe075Swdenk		commands cp, md...
29442abbe075Swdenk
2945f61ec45eSEric Nelson- Serial Flash support
2946f61ec45eSEric Nelson		CONFIG_CMD_SF
2947f61ec45eSEric Nelson
2948f61ec45eSEric Nelson		Defining this option enables SPI flash commands
2949f61ec45eSEric Nelson		'sf probe/read/write/erase/update'.
2950f61ec45eSEric Nelson
2951f61ec45eSEric Nelson		Usage requires an initial 'probe' to define the serial
2952f61ec45eSEric Nelson		flash parameters, followed by read/write/erase/update
2953f61ec45eSEric Nelson		commands.
2954f61ec45eSEric Nelson
2955f61ec45eSEric Nelson		The following defaults may be provided by the platform
2956f61ec45eSEric Nelson		to handle the common case when only a single serial
2957f61ec45eSEric Nelson		flash is present on the system.
2958f61ec45eSEric Nelson
2959f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_BUS		Bus identifier
2960f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_CS		Chip-select
2961f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_MODE 		(see include/spi.h)
2962f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_SPEED		in Hz
2963f61ec45eSEric Nelson
296424007273SSimon Glass		CONFIG_CMD_SF_TEST
296524007273SSimon Glass
296624007273SSimon Glass		Define this option to include a destructive SPI flash
296724007273SSimon Glass		test ('sf test').
296824007273SSimon Glass
29691dcd6d03SJagannadha Sutradharudu Teki		CONFIG_SPI_FLASH_BAR		Ban/Extended Addr Reg
29701dcd6d03SJagannadha Sutradharudu Teki
29711dcd6d03SJagannadha Sutradharudu Teki		Define this option to use the Bank addr/Extended addr
29721dcd6d03SJagannadha Sutradharudu Teki		support on SPI flashes which has size > 16Mbytes.
29731dcd6d03SJagannadha Sutradharudu Teki
2974b902e07cSJagannadha Sutradharudu Teki		CONFIG_SF_DUAL_FLASH		Dual flash memories
2975b902e07cSJagannadha Sutradharudu Teki
2976b902e07cSJagannadha Sutradharudu Teki		Define this option to use dual flash support where two flash
2977b902e07cSJagannadha Sutradharudu Teki		memories can be connected with a given cs line.
2978b902e07cSJagannadha Sutradharudu Teki		currently Xilinx Zynq qspi support these type of connections.
2979b902e07cSJagannadha Sutradharudu Teki
2980562f8df1SHeiko Schocher		CONFIG_SYS_SPI_ST_ENABLE_WP_PIN
2981562f8df1SHeiko Schocher		enable the W#/Vpp signal to disable writing to the status
2982562f8df1SHeiko Schocher		register on ST MICRON flashes like the N25Q128.
2983562f8df1SHeiko Schocher		The status register write enable/disable bit, combined with
2984562f8df1SHeiko Schocher		the W#/VPP signal provides hardware data protection for the
2985562f8df1SHeiko Schocher		device as follows: When the enable/disable bit is set to 1,
2986562f8df1SHeiko Schocher		and the W#/VPP signal is driven LOW, the status register
2987562f8df1SHeiko Schocher		nonvolatile bits become read-only and the WRITE STATUS REGISTER
2988562f8df1SHeiko Schocher		operation will not execute. The only way to exit this
2989562f8df1SHeiko Schocher		hardware-protected mode is to drive W#/VPP HIGH.
2990562f8df1SHeiko Schocher
29913f85ce27Swdenk- SystemACE Support:
29923f85ce27Swdenk		CONFIG_SYSTEMACE
29933f85ce27Swdenk
29943f85ce27Swdenk		Adding this option adds support for Xilinx SystemACE
29953f85ce27Swdenk		chips attached via some sort of local bus. The address
299611ccc33fSMarcel Ziswiler		of the chip must also be defined in the
29976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SYSTEMACE_BASE macro. For example:
29983f85ce27Swdenk
29993f85ce27Swdenk		#define CONFIG_SYSTEMACE
30006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
30013f85ce27Swdenk
30023f85ce27Swdenk		When SystemACE support is added, the "ace" device type
30033f85ce27Swdenk		becomes available to the fat commands, i.e. fatls.
30043f85ce27Swdenk
3005ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port:
3006ecb0ccd9SWolfgang Denk		CONFIG_TFTP_PORT
3007ecb0ccd9SWolfgang Denk
300828cb9375SWolfgang Denk		If this is defined, the environment variable tftpsrcp
3009ecb0ccd9SWolfgang Denk		is used to supply the TFTP UDP source port value.
301028cb9375SWolfgang Denk		If tftpsrcp isn't defined, the normal pseudo-random port
3011ecb0ccd9SWolfgang Denk		number generator is used.
3012ecb0ccd9SWolfgang Denk
301328cb9375SWolfgang Denk		Also, the environment variable tftpdstp is used to supply
301428cb9375SWolfgang Denk		the TFTP UDP destination port value.  If tftpdstp isn't
301528cb9375SWolfgang Denk		defined, the normal port 69 is used.
301628cb9375SWolfgang Denk
301728cb9375SWolfgang Denk		The purpose for tftpsrcp is to allow a TFTP server to
3018ecb0ccd9SWolfgang Denk		blindly start the TFTP transfer using the pre-configured
3019ecb0ccd9SWolfgang Denk		target IP address and UDP port. This has the effect of
3020ecb0ccd9SWolfgang Denk		"punching through" the (Windows XP) firewall, allowing
3021ecb0ccd9SWolfgang Denk		the remainder of the TFTP transfer to proceed normally.
3022ecb0ccd9SWolfgang Denk		A better solution is to properly configure the firewall,
3023ecb0ccd9SWolfgang Denk		but sometimes that is not allowed.
3024ecb0ccd9SWolfgang Denk
3025bf36c5d5SSimon Glass- Hashing support:
3026bf36c5d5SSimon Glass		CONFIG_CMD_HASH
3027bf36c5d5SSimon Glass
3028bf36c5d5SSimon Glass		This enables a generic 'hash' command which can produce
3029bf36c5d5SSimon Glass		hashes / digests from a few algorithms (e.g. SHA1, SHA256).
3030bf36c5d5SSimon Glass
3031bf36c5d5SSimon Glass		CONFIG_HASH_VERIFY
3032bf36c5d5SSimon Glass
3033bf36c5d5SSimon Glass		Enable the hash verify command (hash -v). This adds to code
3034bf36c5d5SSimon Glass		size a little.
3035bf36c5d5SSimon Glass
3036bf36c5d5SSimon Glass		CONFIG_SHA1 - support SHA1 hashing
3037bf36c5d5SSimon Glass		CONFIG_SHA256 - support SHA256 hashing
3038bf36c5d5SSimon Glass
3039bf36c5d5SSimon Glass		Note: There is also a sha1sum command, which should perhaps
3040bf36c5d5SSimon Glass		be deprecated in favour of 'hash sha1'.
3041bf36c5d5SSimon Glass
3042a11f1873SRobert Winkler- Freescale i.MX specific commands:
3043a11f1873SRobert Winkler		CONFIG_CMD_HDMIDETECT
3044a11f1873SRobert Winkler		This enables 'hdmidet' command which returns true if an
3045a11f1873SRobert Winkler		HDMI monitor is detected.  This command is i.MX 6 specific.
3046a11f1873SRobert Winkler
3047a11f1873SRobert Winkler		CONFIG_CMD_BMODE
3048a11f1873SRobert Winkler		This enables the 'bmode' (bootmode) command for forcing
3049a11f1873SRobert Winkler		a boot from specific media.
3050a11f1873SRobert Winkler
3051a11f1873SRobert Winkler		This is useful for forcing the ROM's usb downloader to
3052a11f1873SRobert Winkler		activate upon a watchdog reset which is nice when iterating
3053a11f1873SRobert Winkler		on U-Boot.  Using the reset button or running bmode normal
3054a11f1873SRobert Winkler		will set it back to normal.  This command currently
3055a11f1873SRobert Winkler		supports i.MX53 and i.MX6.
3056a11f1873SRobert Winkler
305719c402afSSimon Glass- Signing support:
305819c402afSSimon Glass		CONFIG_RSA
305919c402afSSimon Glass
306019c402afSSimon Glass		This enables the RSA algorithm used for FIT image verification
30618bf2aad7SDetlev Zundel		in U-Boot. See doc/uImage.FIT/signature.txt for more information.
306219c402afSSimon Glass
306319c402afSSimon Glass		The signing part is build into mkimage regardless of this
306419c402afSSimon Glass		option.
306519c402afSSimon Glass
30669e50c406SHeiko Schocher- bootcount support:
30679e50c406SHeiko Schocher		CONFIG_BOOTCOUNT_LIMIT
30689e50c406SHeiko Schocher
30699e50c406SHeiko Schocher		This enables the bootcounter support, see:
30709e50c406SHeiko Schocher		http://www.denx.de/wiki/DULG/UBootBootCountLimit
30719e50c406SHeiko Schocher
30729e50c406SHeiko Schocher		CONFIG_AT91SAM9XE
30739e50c406SHeiko Schocher		enable special bootcounter support on at91sam9xe based boards.
30749e50c406SHeiko Schocher		CONFIG_BLACKFIN
30759e50c406SHeiko Schocher		enable special bootcounter support on blackfin based boards.
30769e50c406SHeiko Schocher		CONFIG_SOC_DA8XX
30779e50c406SHeiko Schocher		enable special bootcounter support on da850 based boards.
30789e50c406SHeiko Schocher		CONFIG_BOOTCOUNT_RAM
30799e50c406SHeiko Schocher		enable support for the bootcounter in RAM
30809e50c406SHeiko Schocher		CONFIG_BOOTCOUNT_I2C
30819e50c406SHeiko Schocher		enable support for the bootcounter on an i2c (like RTC) device.
30829e50c406SHeiko Schocher			CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
30839e50c406SHeiko Schocher			CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
30849e50c406SHeiko Schocher						    the bootcounter.
30859e50c406SHeiko Schocher			CONFIG_BOOTCOUNT_ALEN = address len
308619c402afSSimon Glass
3087a8c7c708Swdenk- Show boot progress:
3088c609719bSwdenk		CONFIG_SHOW_BOOT_PROGRESS
3089c609719bSwdenk
3090c609719bSwdenk		Defining this option allows to add some board-
3091c609719bSwdenk		specific code (calling a user-provided function
3092c609719bSwdenk		"show_boot_progress(int)") that enables you to show
3093c609719bSwdenk		the system's boot progress on some display (for
3094c609719bSwdenk		example, some LED's) on your board. At the moment,
3095c609719bSwdenk		the following checkpoints are implemented:
3096c609719bSwdenk
30973a608ca0SSimon Glass- Detailed boot stage timing
30983a608ca0SSimon Glass		CONFIG_BOOTSTAGE
30993a608ca0SSimon Glass		Define this option to get detailed timing of each stage
31003a608ca0SSimon Glass		of the boot process.
31013a608ca0SSimon Glass
31023a608ca0SSimon Glass		CONFIG_BOOTSTAGE_USER_COUNT
31033a608ca0SSimon Glass		This is the number of available user bootstage records.
31043a608ca0SSimon Glass		Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
31053a608ca0SSimon Glass		a new ID will be allocated from this stash. If you exceed
31063a608ca0SSimon Glass		the limit, recording will stop.
31073a608ca0SSimon Glass
31083a608ca0SSimon Glass		CONFIG_BOOTSTAGE_REPORT
31093a608ca0SSimon Glass		Define this to print a report before boot, similar to this:
31103a608ca0SSimon Glass
31113a608ca0SSimon Glass		Timer summary in microseconds:
31123a608ca0SSimon Glass		       Mark    Elapsed  Stage
31133a608ca0SSimon Glass			  0          0  reset
31143a608ca0SSimon Glass		  3,575,678  3,575,678  board_init_f start
31153a608ca0SSimon Glass		  3,575,695         17  arch_cpu_init A9
31163a608ca0SSimon Glass		  3,575,777         82  arch_cpu_init done
31173a608ca0SSimon Glass		  3,659,598     83,821  board_init_r start
31183a608ca0SSimon Glass		  3,910,375    250,777  main_loop
31193a608ca0SSimon Glass		 29,916,167 26,005,792  bootm_start
31203a608ca0SSimon Glass		 30,361,327    445,160  start_kernel
31213a608ca0SSimon Glass
31222eba38cfSSimon Glass		CONFIG_CMD_BOOTSTAGE
31232eba38cfSSimon Glass		Add a 'bootstage' command which supports printing a report
31242eba38cfSSimon Glass		and un/stashing of bootstage data.
31252eba38cfSSimon Glass
312694fd1316SSimon Glass		CONFIG_BOOTSTAGE_FDT
312794fd1316SSimon Glass		Stash the bootstage information in the FDT. A root 'bootstage'
312894fd1316SSimon Glass		node is created with each bootstage id as a child. Each child
312994fd1316SSimon Glass		has a 'name' property and either 'mark' containing the
313094fd1316SSimon Glass		mark time in microsecond, or 'accum' containing the
313194fd1316SSimon Glass		accumulated time for that bootstage id in microseconds.
313294fd1316SSimon Glass		For example:
313394fd1316SSimon Glass
313494fd1316SSimon Glass		bootstage {
313594fd1316SSimon Glass			154 {
313694fd1316SSimon Glass				name = "board_init_f";
313794fd1316SSimon Glass				mark = <3575678>;
313894fd1316SSimon Glass			};
313994fd1316SSimon Glass			170 {
314094fd1316SSimon Glass				name = "lcd";
314194fd1316SSimon Glass				accum = <33482>;
314294fd1316SSimon Glass			};
314394fd1316SSimon Glass		};
314494fd1316SSimon Glass
314594fd1316SSimon Glass		Code in the Linux kernel can find this in /proc/devicetree.
314694fd1316SSimon Glass
31471372cce2SMarian BalakowiczLegacy uImage format:
31481372cce2SMarian Balakowicz
3149c609719bSwdenk  Arg	Where			When
3150c609719bSwdenk    1	common/cmd_bootm.c	before attempting to boot an image
3151c609719bSwdenk   -1	common/cmd_bootm.c	Image header has bad	 magic number
3152c609719bSwdenk    2	common/cmd_bootm.c	Image header has correct magic number
3153c609719bSwdenk   -2	common/cmd_bootm.c	Image header has bad	 checksum
3154c609719bSwdenk    3	common/cmd_bootm.c	Image header has correct checksum
3155c609719bSwdenk   -3	common/cmd_bootm.c	Image data   has bad	 checksum
3156c609719bSwdenk    4	common/cmd_bootm.c	Image data   has correct checksum
3157c609719bSwdenk   -4	common/cmd_bootm.c	Image is for unsupported architecture
3158c609719bSwdenk    5	common/cmd_bootm.c	Architecture check OK
31591372cce2SMarian Balakowicz   -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi)
3160c609719bSwdenk    6	common/cmd_bootm.c	Image Type check OK
3161c609719bSwdenk   -6	common/cmd_bootm.c	gunzip uncompression error
3162c609719bSwdenk   -7	common/cmd_bootm.c	Unimplemented compression type
3163c609719bSwdenk    7	common/cmd_bootm.c	Uncompression OK
31641372cce2SMarian Balakowicz    8	common/cmd_bootm.c	No uncompress/copy overwrite error
3165c609719bSwdenk   -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
31661372cce2SMarian Balakowicz
31671372cce2SMarian Balakowicz    9	common/image.c		Start initial ramdisk verification
31681372cce2SMarian Balakowicz  -10	common/image.c		Ramdisk header has bad	   magic number
31691372cce2SMarian Balakowicz  -11	common/image.c		Ramdisk header has bad	   checksum
31701372cce2SMarian Balakowicz   10	common/image.c		Ramdisk header is OK
31711372cce2SMarian Balakowicz  -12	common/image.c		Ramdisk data   has bad	   checksum
31721372cce2SMarian Balakowicz   11	common/image.c		Ramdisk data   has correct checksum
31731372cce2SMarian Balakowicz   12	common/image.c		Ramdisk verification complete, start loading
317411ccc33fSMarcel Ziswiler  -13	common/image.c		Wrong Image Type (not PPC Linux ramdisk)
31751372cce2SMarian Balakowicz   13	common/image.c		Start multifile image verification
31761372cce2SMarian Balakowicz   14	common/image.c		No initial ramdisk, no multifile, continue.
31771372cce2SMarian Balakowicz
3178ea0364f1SPeter Tyser   15	arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
3179c609719bSwdenk
3180a47a12beSStefan Roese  -30	arch/powerpc/lib/board.c	Fatal error, hang the system
318163e73c9aSwdenk  -31	post/post.c		POST test failed, detected by post_output_backlog()
318263e73c9aSwdenk  -32	post/post.c		POST test failed, detected by post_run_single()
318363e73c9aSwdenk
3184566a494fSHeiko Schocher   34	common/cmd_doc.c	before loading a Image from a DOC device
3185566a494fSHeiko Schocher  -35	common/cmd_doc.c	Bad usage of "doc" command
3186566a494fSHeiko Schocher   35	common/cmd_doc.c	correct usage of "doc" command
3187566a494fSHeiko Schocher  -36	common/cmd_doc.c	No boot device
3188566a494fSHeiko Schocher   36	common/cmd_doc.c	correct boot device
3189566a494fSHeiko Schocher  -37	common/cmd_doc.c	Unknown Chip ID on boot device
3190566a494fSHeiko Schocher   37	common/cmd_doc.c	correct chip ID found, device available
3191566a494fSHeiko Schocher  -38	common/cmd_doc.c	Read Error on boot device
3192566a494fSHeiko Schocher   38	common/cmd_doc.c	reading Image header from DOC device OK
3193566a494fSHeiko Schocher  -39	common/cmd_doc.c	Image header has bad magic number
3194566a494fSHeiko Schocher   39	common/cmd_doc.c	Image header has correct magic number
3195566a494fSHeiko Schocher  -40	common/cmd_doc.c	Error reading Image from DOC device
3196566a494fSHeiko Schocher   40	common/cmd_doc.c	Image header has correct magic number
3197566a494fSHeiko Schocher   41	common/cmd_ide.c	before loading a Image from a IDE device
3198566a494fSHeiko Schocher  -42	common/cmd_ide.c	Bad usage of "ide" command
3199566a494fSHeiko Schocher   42	common/cmd_ide.c	correct usage of "ide" command
3200566a494fSHeiko Schocher  -43	common/cmd_ide.c	No boot device
3201566a494fSHeiko Schocher   43	common/cmd_ide.c	boot device found
3202566a494fSHeiko Schocher  -44	common/cmd_ide.c	Device not available
3203566a494fSHeiko Schocher   44	common/cmd_ide.c	Device available
3204566a494fSHeiko Schocher  -45	common/cmd_ide.c	wrong partition selected
3205566a494fSHeiko Schocher   45	common/cmd_ide.c	partition selected
3206566a494fSHeiko Schocher  -46	common/cmd_ide.c	Unknown partition table
3207566a494fSHeiko Schocher   46	common/cmd_ide.c	valid partition table found
3208566a494fSHeiko Schocher  -47	common/cmd_ide.c	Invalid partition type
3209566a494fSHeiko Schocher   47	common/cmd_ide.c	correct partition type
3210566a494fSHeiko Schocher  -48	common/cmd_ide.c	Error reading Image Header on boot device
3211566a494fSHeiko Schocher   48	common/cmd_ide.c	reading Image Header from IDE device OK
3212566a494fSHeiko Schocher  -49	common/cmd_ide.c	Image header has bad magic number
3213566a494fSHeiko Schocher   49	common/cmd_ide.c	Image header has correct magic number
3214566a494fSHeiko Schocher  -50	common/cmd_ide.c	Image header has bad	 checksum
3215566a494fSHeiko Schocher   50	common/cmd_ide.c	Image header has correct checksum
3216566a494fSHeiko Schocher  -51	common/cmd_ide.c	Error reading Image from IDE device
3217566a494fSHeiko Schocher   51	common/cmd_ide.c	reading Image from IDE device OK
3218566a494fSHeiko Schocher   52	common/cmd_nand.c	before loading a Image from a NAND device
3219566a494fSHeiko Schocher  -53	common/cmd_nand.c	Bad usage of "nand" command
3220566a494fSHeiko Schocher   53	common/cmd_nand.c	correct usage of "nand" command
3221566a494fSHeiko Schocher  -54	common/cmd_nand.c	No boot device
3222566a494fSHeiko Schocher   54	common/cmd_nand.c	boot device found
3223566a494fSHeiko Schocher  -55	common/cmd_nand.c	Unknown Chip ID on boot device
3224566a494fSHeiko Schocher   55	common/cmd_nand.c	correct chip ID found, device available
3225566a494fSHeiko Schocher  -56	common/cmd_nand.c	Error reading Image Header on boot device
3226566a494fSHeiko Schocher   56	common/cmd_nand.c	reading Image Header from NAND device OK
3227566a494fSHeiko Schocher  -57	common/cmd_nand.c	Image header has bad magic number
3228566a494fSHeiko Schocher   57	common/cmd_nand.c	Image header has correct magic number
3229566a494fSHeiko Schocher  -58	common/cmd_nand.c	Error reading Image from NAND device
3230566a494fSHeiko Schocher   58	common/cmd_nand.c	reading Image from NAND device OK
3231c609719bSwdenk
3232566a494fSHeiko Schocher  -60	common/env_common.c	Environment has a bad CRC, using default
3233c609719bSwdenk
3234566a494fSHeiko Schocher   64	net/eth.c		starting with Ethernet configuration.
3235566a494fSHeiko Schocher  -64	net/eth.c		no Ethernet found.
3236566a494fSHeiko Schocher   65	net/eth.c		Ethernet found.
3237206c60cbSwdenk
3238566a494fSHeiko Schocher  -80	common/cmd_net.c	usage wrong
3239566a494fSHeiko Schocher   80	common/cmd_net.c	before calling NetLoop()
324011ccc33fSMarcel Ziswiler  -81	common/cmd_net.c	some error in NetLoop() occurred
3241566a494fSHeiko Schocher   81	common/cmd_net.c	NetLoop() back without error
3242566a494fSHeiko Schocher  -82	common/cmd_net.c	size == 0 (File with size 0 loaded)
3243566a494fSHeiko Schocher   82	common/cmd_net.c	trying automatic boot
324474de7aefSWolfgang Denk   83	common/cmd_net.c	running "source" command
324574de7aefSWolfgang Denk  -83	common/cmd_net.c	some error in automatic boot or "source" command
3246566a494fSHeiko Schocher   84	common/cmd_net.c	end without errors
3247c609719bSwdenk
32481372cce2SMarian BalakowiczFIT uImage format:
32491372cce2SMarian Balakowicz
32501372cce2SMarian Balakowicz  Arg	Where			When
32511372cce2SMarian Balakowicz  100	common/cmd_bootm.c	Kernel FIT Image has correct format
32521372cce2SMarian Balakowicz -100	common/cmd_bootm.c	Kernel FIT Image has incorrect format
32531372cce2SMarian Balakowicz  101	common/cmd_bootm.c	No Kernel subimage unit name, using configuration
32541372cce2SMarian Balakowicz -101	common/cmd_bootm.c	Can't get configuration for kernel subimage
32551372cce2SMarian Balakowicz  102	common/cmd_bootm.c	Kernel unit name specified
32561372cce2SMarian Balakowicz -103	common/cmd_bootm.c	Can't get kernel subimage node offset
3257f773bea8SMarian Balakowicz  103	common/cmd_bootm.c	Found configuration node
32581372cce2SMarian Balakowicz  104	common/cmd_bootm.c	Got kernel subimage node offset
32591372cce2SMarian Balakowicz -104	common/cmd_bootm.c	Kernel subimage hash verification failed
32601372cce2SMarian Balakowicz  105	common/cmd_bootm.c	Kernel subimage hash verification OK
32611372cce2SMarian Balakowicz -105	common/cmd_bootm.c	Kernel subimage is for unsupported architecture
32621372cce2SMarian Balakowicz  106	common/cmd_bootm.c	Architecture check OK
326311ccc33fSMarcel Ziswiler -106	common/cmd_bootm.c	Kernel subimage has wrong type
326411ccc33fSMarcel Ziswiler  107	common/cmd_bootm.c	Kernel subimage type OK
32651372cce2SMarian Balakowicz -107	common/cmd_bootm.c	Can't get kernel subimage data/size
32661372cce2SMarian Balakowicz  108	common/cmd_bootm.c	Got kernel subimage data/size
32671372cce2SMarian Balakowicz -108	common/cmd_bootm.c	Wrong image type (not legacy, FIT)
32681372cce2SMarian Balakowicz -109	common/cmd_bootm.c	Can't get kernel subimage type
32691372cce2SMarian Balakowicz -110	common/cmd_bootm.c	Can't get kernel subimage comp
32701372cce2SMarian Balakowicz -111	common/cmd_bootm.c	Can't get kernel subimage os
32711372cce2SMarian Balakowicz -112	common/cmd_bootm.c	Can't get kernel subimage load address
32721372cce2SMarian Balakowicz -113	common/cmd_bootm.c	Image uncompress/copy overwrite error
32731372cce2SMarian Balakowicz
32741372cce2SMarian Balakowicz  120	common/image.c		Start initial ramdisk verification
32751372cce2SMarian Balakowicz -120	common/image.c		Ramdisk FIT image has incorrect format
32761372cce2SMarian Balakowicz  121	common/image.c		Ramdisk FIT image has correct format
327711ccc33fSMarcel Ziswiler  122	common/image.c		No ramdisk subimage unit name, using configuration
32781372cce2SMarian Balakowicz -122	common/image.c		Can't get configuration for ramdisk subimage
32791372cce2SMarian Balakowicz  123	common/image.c		Ramdisk unit name specified
32801372cce2SMarian Balakowicz -124	common/image.c		Can't get ramdisk subimage node offset
32811372cce2SMarian Balakowicz  125	common/image.c		Got ramdisk subimage node offset
32821372cce2SMarian Balakowicz -125	common/image.c		Ramdisk subimage hash verification failed
32831372cce2SMarian Balakowicz  126	common/image.c		Ramdisk subimage hash verification OK
32841372cce2SMarian Balakowicz -126	common/image.c		Ramdisk subimage for unsupported architecture
32851372cce2SMarian Balakowicz  127	common/image.c		Architecture check OK
32861372cce2SMarian Balakowicz -127	common/image.c		Can't get ramdisk subimage data/size
32871372cce2SMarian Balakowicz  128	common/image.c		Got ramdisk subimage data/size
32881372cce2SMarian Balakowicz  129	common/image.c		Can't get ramdisk load address
32891372cce2SMarian Balakowicz -129	common/image.c		Got ramdisk load address
32901372cce2SMarian Balakowicz
329111ccc33fSMarcel Ziswiler -130	common/cmd_doc.c	Incorrect FIT image format
32921372cce2SMarian Balakowicz  131	common/cmd_doc.c	FIT image format OK
32931372cce2SMarian Balakowicz
329411ccc33fSMarcel Ziswiler -140	common/cmd_ide.c	Incorrect FIT image format
32951372cce2SMarian Balakowicz  141	common/cmd_ide.c	FIT image format OK
32961372cce2SMarian Balakowicz
329711ccc33fSMarcel Ziswiler -150	common/cmd_nand.c	Incorrect FIT image format
32981372cce2SMarian Balakowicz  151	common/cmd_nand.c	FIT image format OK
32991372cce2SMarian Balakowicz
330021d29f7fSHeiko Schocher- legacy image format:
330121d29f7fSHeiko Schocher		CONFIG_IMAGE_FORMAT_LEGACY
330221d29f7fSHeiko Schocher		enables the legacy image format support in U-Boot.
330321d29f7fSHeiko Schocher
330421d29f7fSHeiko Schocher		Default:
330521d29f7fSHeiko Schocher		enabled if CONFIG_FIT_SIGNATURE is not defined.
330621d29f7fSHeiko Schocher
330721d29f7fSHeiko Schocher		CONFIG_DISABLE_IMAGE_LEGACY
330821d29f7fSHeiko Schocher		disable the legacy image format
330921d29f7fSHeiko Schocher
331021d29f7fSHeiko Schocher		This define is introduced, as the legacy image format is
331121d29f7fSHeiko Schocher		enabled per default for backward compatibility.
331221d29f7fSHeiko Schocher
3313d95f6ec7SGabe Black- FIT image support:
3314d95f6ec7SGabe Black		CONFIG_FIT
3315d95f6ec7SGabe Black		Enable support for the FIT uImage format.
3316d95f6ec7SGabe Black
3317d95f6ec7SGabe Black		CONFIG_FIT_BEST_MATCH
3318d95f6ec7SGabe Black		When no configuration is explicitly selected, default to the
3319d95f6ec7SGabe Black		one whose fdt's compatibility field best matches that of
3320d95f6ec7SGabe Black		U-Boot itself. A match is considered "best" if it matches the
3321d95f6ec7SGabe Black		most specific compatibility entry of U-Boot's fdt's root node.
3322d95f6ec7SGabe Black		The order of entries in the configuration's fdt is ignored.
3323d95f6ec7SGabe Black
33243e569a6bSSimon Glass		CONFIG_FIT_SIGNATURE
33253e569a6bSSimon Glass		This option enables signature verification of FIT uImages,
33263e569a6bSSimon Glass		using a hash signed and verified using RSA. See
33273e569a6bSSimon Glass		doc/uImage.FIT/signature.txt for more details.
33283e569a6bSSimon Glass
332921d29f7fSHeiko Schocher		WARNING: When relying on signed FIT images with required
333021d29f7fSHeiko Schocher		signature check the legacy image format is default
333121d29f7fSHeiko Schocher		disabled. If a board need legacy image format support
333221d29f7fSHeiko Schocher		enable this through CONFIG_IMAGE_FORMAT_LEGACY
333321d29f7fSHeiko Schocher
33349a4f479bSDirk Eibach		CONFIG_FIT_DISABLE_SHA256
33359a4f479bSDirk Eibach		Supporting SHA256 hashes has quite an impact on binary size.
33369a4f479bSDirk Eibach		For constrained systems sha256 hash support can be disabled
33379a4f479bSDirk Eibach		with this option.
33389a4f479bSDirk Eibach
33394cf2609bSWolfgang Denk- Standalone program support:
33404cf2609bSWolfgang Denk		CONFIG_STANDALONE_LOAD_ADDR
33414cf2609bSWolfgang Denk
33426feff899SWolfgang Denk		This option defines a board specific value for the
33436feff899SWolfgang Denk		address where standalone program gets loaded, thus
33446feff899SWolfgang Denk		overwriting the architecture dependent default
33454cf2609bSWolfgang Denk		settings.
33464cf2609bSWolfgang Denk
33474cf2609bSWolfgang Denk- Frame Buffer Address:
33484cf2609bSWolfgang Denk		CONFIG_FB_ADDR
33494cf2609bSWolfgang Denk
33504cf2609bSWolfgang Denk		Define CONFIG_FB_ADDR if you want to use specific
335144a53b57SWolfgang Denk		address for frame buffer.  This is typically the case
335244a53b57SWolfgang Denk		when using a graphics controller has separate video
335344a53b57SWolfgang Denk		memory.  U-Boot will then place the frame buffer at
335444a53b57SWolfgang Denk		the given address instead of dynamically reserving it
335544a53b57SWolfgang Denk		in system RAM by calling lcd_setmem(), which grabs
335644a53b57SWolfgang Denk		the memory for the frame buffer depending on the
335744a53b57SWolfgang Denk		configured panel size.
33584cf2609bSWolfgang Denk
33594cf2609bSWolfgang Denk		Please see board_init_f function.
33604cf2609bSWolfgang Denk
3361cccfc2abSDetlev Zundel- Automatic software updates via TFTP server
3362cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP
3363cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_CNT_MAX
3364cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_MSEC_MAX
3365cccfc2abSDetlev Zundel
3366cccfc2abSDetlev Zundel		These options enable and control the auto-update feature;
3367cccfc2abSDetlev Zundel		for a more detailed description refer to doc/README.update.
3368cccfc2abSDetlev Zundel
3369cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support)
3370cccfc2abSDetlev Zundel		CONFIG_MTD_DEVICE
3371cccfc2abSDetlev Zundel
3372cccfc2abSDetlev Zundel		Adds the MTD device infrastructure from the Linux kernel.
3373cccfc2abSDetlev Zundel		Needed for mtdparts command support.
3374cccfc2abSDetlev Zundel
3375cccfc2abSDetlev Zundel		CONFIG_MTD_PARTITIONS
3376cccfc2abSDetlev Zundel
3377cccfc2abSDetlev Zundel		Adds the MTD partitioning infrastructure from the Linux
3378cccfc2abSDetlev Zundel		kernel. Needed for UBI support.
3379cccfc2abSDetlev Zundel
3380ff94bc40SHeiko Schocher		CONFIG_MTD_NAND_VERIFY_WRITE
3381ff94bc40SHeiko Schocher		verify if the written data is correct reread.
3382ff94bc40SHeiko Schocher
338370c219cdSJoe Hershberger- UBI support
338470c219cdSJoe Hershberger		CONFIG_CMD_UBI
338570c219cdSJoe Hershberger
338670c219cdSJoe Hershberger		Adds commands for interacting with MTD partitions formatted
338770c219cdSJoe Hershberger		with the UBI flash translation layer
338870c219cdSJoe Hershberger
338970c219cdSJoe Hershberger		Requires also defining CONFIG_RBTREE
339070c219cdSJoe Hershberger
3391147162daSJoe Hershberger		CONFIG_UBI_SILENCE_MSG
3392147162daSJoe Hershberger
3393147162daSJoe Hershberger		Make the verbose messages from UBI stop printing.  This leaves
3394147162daSJoe Hershberger		warnings and errors enabled.
3395147162daSJoe Hershberger
3396ff94bc40SHeiko Schocher
3397ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_WL_THRESHOLD
3398ff94bc40SHeiko Schocher		This parameter defines the maximum difference between the highest
3399ff94bc40SHeiko Schocher		erase counter value and the lowest erase counter value of eraseblocks
3400ff94bc40SHeiko Schocher		of UBI devices. When this threshold is exceeded, UBI starts performing
3401ff94bc40SHeiko Schocher		wear leveling by means of moving data from eraseblock with low erase
3402ff94bc40SHeiko Schocher		counter to eraseblocks with high erase counter.
3403ff94bc40SHeiko Schocher
3404ff94bc40SHeiko Schocher		The default value should be OK for SLC NAND flashes, NOR flashes and
3405ff94bc40SHeiko Schocher		other flashes which have eraseblock life-cycle 100000 or more.
3406ff94bc40SHeiko Schocher		However, in case of MLC NAND flashes which typically have eraseblock
3407ff94bc40SHeiko Schocher		life-cycle less than 10000, the threshold should be lessened (e.g.,
3408ff94bc40SHeiko Schocher		to 128 or 256, although it does not have to be power of 2).
3409ff94bc40SHeiko Schocher
3410ff94bc40SHeiko Schocher		default: 4096
3411ff94bc40SHeiko Schocher
3412ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_BEB_LIMIT
3413ff94bc40SHeiko Schocher		This option specifies the maximum bad physical eraseblocks UBI
3414ff94bc40SHeiko Schocher		expects on the MTD device (per 1024 eraseblocks). If the
3415ff94bc40SHeiko Schocher		underlying flash does not admit of bad eraseblocks (e.g. NOR
3416ff94bc40SHeiko Schocher		flash), this value is ignored.
3417ff94bc40SHeiko Schocher
3418ff94bc40SHeiko Schocher		NAND datasheets often specify the minimum and maximum NVM
3419ff94bc40SHeiko Schocher		(Number of Valid Blocks) for the flashes' endurance lifetime.
3420ff94bc40SHeiko Schocher		The maximum expected bad eraseblocks per 1024 eraseblocks
3421ff94bc40SHeiko Schocher		then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
3422ff94bc40SHeiko Schocher		which gives 20 for most NANDs (MaxNVB is basically the total
3423ff94bc40SHeiko Schocher		count of eraseblocks on the chip).
3424ff94bc40SHeiko Schocher
3425ff94bc40SHeiko Schocher		To put it differently, if this value is 20, UBI will try to
3426ff94bc40SHeiko Schocher		reserve about 1.9% of physical eraseblocks for bad blocks
3427ff94bc40SHeiko Schocher		handling. And that will be 1.9% of eraseblocks on the entire
3428ff94bc40SHeiko Schocher		NAND chip, not just the MTD partition UBI attaches. This means
3429ff94bc40SHeiko Schocher		that if you have, say, a NAND flash chip admits maximum 40 bad
3430ff94bc40SHeiko Schocher		eraseblocks, and it is split on two MTD partitions of the same
3431ff94bc40SHeiko Schocher		size, UBI will reserve 40 eraseblocks when attaching a
3432ff94bc40SHeiko Schocher		partition.
3433ff94bc40SHeiko Schocher
3434ff94bc40SHeiko Schocher		default: 20
3435ff94bc40SHeiko Schocher
3436ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_FASTMAP
3437ff94bc40SHeiko Schocher		Fastmap is a mechanism which allows attaching an UBI device
3438ff94bc40SHeiko Schocher		in nearly constant time. Instead of scanning the whole MTD device it
3439ff94bc40SHeiko Schocher		only has to locate a checkpoint (called fastmap) on the device.
3440ff94bc40SHeiko Schocher		The on-flash fastmap contains all information needed to attach
3441ff94bc40SHeiko Schocher		the device. Using fastmap makes only sense on large devices where
3442ff94bc40SHeiko Schocher		attaching by scanning takes long. UBI will not automatically install
3443ff94bc40SHeiko Schocher		a fastmap on old images, but you can set the UBI parameter
3444ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
3445ff94bc40SHeiko Schocher		that fastmap-enabled images are still usable with UBI implementations
3446ff94bc40SHeiko Schocher		without	fastmap support. On typical flash devices the whole fastmap
3447ff94bc40SHeiko Schocher		fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
3448ff94bc40SHeiko Schocher
3449ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
3450ff94bc40SHeiko Schocher		Set this parameter to enable fastmap automatically on images
3451ff94bc40SHeiko Schocher		without a fastmap.
3452ff94bc40SHeiko Schocher		default: 0
3453ff94bc40SHeiko Schocher
345470c219cdSJoe Hershberger- UBIFS support
345570c219cdSJoe Hershberger		CONFIG_CMD_UBIFS
345670c219cdSJoe Hershberger
345770c219cdSJoe Hershberger		Adds commands for interacting with UBI volumes formatted as
345870c219cdSJoe Hershberger		UBIFS.  UBIFS is read-only in u-boot.
345970c219cdSJoe Hershberger
346070c219cdSJoe Hershberger		Requires UBI support as well as CONFIG_LZO
346170c219cdSJoe Hershberger
3462147162daSJoe Hershberger		CONFIG_UBIFS_SILENCE_MSG
3463147162daSJoe Hershberger
3464147162daSJoe Hershberger		Make the verbose messages from UBIFS stop printing.  This leaves
3465147162daSJoe Hershberger		warnings and errors enabled.
3466147162daSJoe Hershberger
34676a11cf48SDaniel Schwierzeck- SPL framework
34686a11cf48SDaniel Schwierzeck		CONFIG_SPL
34696a11cf48SDaniel Schwierzeck		Enable building of SPL globally.
34706a11cf48SDaniel Schwierzeck
347195579793STom Rini		CONFIG_SPL_LDSCRIPT
347295579793STom Rini		LDSCRIPT for linking the SPL binary.
347395579793STom Rini
34746ebc3461SAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT
34756ebc3461SAlbert ARIBAUD		Maximum size in memory allocated to the SPL, BSS included.
34766ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual memory
34776ebc3461SAlbert ARIBAUD		used by SPL from _start to __bss_end does not exceed it.
34788960af8bSAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
34796ebc3461SAlbert ARIBAUD		must not be both defined at the same time.
34806ebc3461SAlbert ARIBAUD
348195579793STom Rini		CONFIG_SPL_MAX_SIZE
34826ebc3461SAlbert ARIBAUD		Maximum size of the SPL image (text, data, rodata, and
34836ebc3461SAlbert ARIBAUD		linker lists sections), BSS excluded.
34846ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual size does
34856ebc3461SAlbert ARIBAUD		not exceed it.
348695579793STom Rini
34876a11cf48SDaniel Schwierzeck		CONFIG_SPL_TEXT_BASE
34886a11cf48SDaniel Schwierzeck		TEXT_BASE for linking the SPL binary.
34896a11cf48SDaniel Schwierzeck
349094a45bb1SScott Wood		CONFIG_SPL_RELOC_TEXT_BASE
349194a45bb1SScott Wood		Address to relocate to.  If unspecified, this is equal to
349294a45bb1SScott Wood		CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
349394a45bb1SScott Wood
349495579793STom Rini		CONFIG_SPL_BSS_START_ADDR
349595579793STom Rini		Link address for the BSS within the SPL binary.
349695579793STom Rini
349795579793STom Rini		CONFIG_SPL_BSS_MAX_SIZE
34986ebc3461SAlbert ARIBAUD		Maximum size in memory allocated to the SPL BSS.
34996ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual memory used
35006ebc3461SAlbert ARIBAUD		by SPL from __bss_start to __bss_end does not exceed it.
35018960af8bSAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
35026ebc3461SAlbert ARIBAUD		must not be both defined at the same time.
350395579793STom Rini
350495579793STom Rini		CONFIG_SPL_STACK
350595579793STom Rini		Adress of the start of the stack SPL will use
350695579793STom Rini
350794a45bb1SScott Wood		CONFIG_SPL_RELOC_STACK
350894a45bb1SScott Wood		Adress of the start of the stack SPL will use after
350994a45bb1SScott Wood		relocation.  If unspecified, this is equal to
351094a45bb1SScott Wood		CONFIG_SPL_STACK.
351194a45bb1SScott Wood
351295579793STom Rini		CONFIG_SYS_SPL_MALLOC_START
351395579793STom Rini		Starting address of the malloc pool used in SPL.
351495579793STom Rini
351595579793STom Rini		CONFIG_SYS_SPL_MALLOC_SIZE
351695579793STom Rini		The size of the malloc pool used in SPL.
35176a11cf48SDaniel Schwierzeck
351847f7bcaeSTom Rini		CONFIG_SPL_FRAMEWORK
351947f7bcaeSTom Rini		Enable the SPL framework under common/.  This framework
352047f7bcaeSTom Rini		supports MMC, NAND and YMODEM loading of U-Boot and NAND
352147f7bcaeSTom Rini		NAND loading of the Linux Kernel.
352247f7bcaeSTom Rini
35239607faf2STom Rini		CONFIG_SPL_OS_BOOT
35249607faf2STom Rini		Enable booting directly to an OS from SPL.
35259607faf2STom Rini		See also: doc/README.falcon
35269607faf2STom Rini
3527861a86f4STom Rini		CONFIG_SPL_DISPLAY_PRINT
3528861a86f4STom Rini		For ARM, enable an optional function to print more information
3529861a86f4STom Rini		about the running system.
3530861a86f4STom Rini
35314b919725SScott Wood		CONFIG_SPL_INIT_MINIMAL
35324b919725SScott Wood		Arch init code should be built for a very small image
35334b919725SScott Wood
35346a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBCOMMON_SUPPORT
35356a11cf48SDaniel Schwierzeck		Support for common/libcommon.o in SPL binary
35366a11cf48SDaniel Schwierzeck
35376a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBDISK_SUPPORT
35386a11cf48SDaniel Schwierzeck		Support for disk/libdisk.o in SPL binary
35396a11cf48SDaniel Schwierzeck
35406a11cf48SDaniel Schwierzeck		CONFIG_SPL_I2C_SUPPORT
35416a11cf48SDaniel Schwierzeck		Support for drivers/i2c/libi2c.o in SPL binary
35426a11cf48SDaniel Schwierzeck
35436a11cf48SDaniel Schwierzeck		CONFIG_SPL_GPIO_SUPPORT
35446a11cf48SDaniel Schwierzeck		Support for drivers/gpio/libgpio.o in SPL binary
35456a11cf48SDaniel Schwierzeck
35466a11cf48SDaniel Schwierzeck		CONFIG_SPL_MMC_SUPPORT
35476a11cf48SDaniel Schwierzeck		Support for drivers/mmc/libmmc.o in SPL binary
35486a11cf48SDaniel Schwierzeck
354995579793STom Rini		CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
355095579793STom Rini		CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
3551fae81c72SGuillaume GARDET		CONFIG_SYS_MMC_SD_FS_BOOT_PARTITION
355295579793STom Rini		Address, size and partition on the MMC to load U-Boot from
355395579793STom Rini		when the MMC is being used in raw mode.
355495579793STom Rini
35552b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
35562b75b0adSPeter Korsgaard		Sector to load kernel uImage from when MMC is being
35572b75b0adSPeter Korsgaard		used in raw mode (for Falcon mode)
35582b75b0adSPeter Korsgaard
35592b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
35602b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
35612b75b0adSPeter Korsgaard		Sector and number of sectors to load kernel argument
35622b75b0adSPeter Korsgaard		parameters from when MMC is being used in raw mode
35632b75b0adSPeter Korsgaard		(for falcon mode)
35642b75b0adSPeter Korsgaard
356595579793STom Rini		CONFIG_SPL_FAT_SUPPORT
356695579793STom Rini		Support for fs/fat/libfat.o in SPL binary
356795579793STom Rini
3568fae81c72SGuillaume GARDET		CONFIG_SPL_EXT_SUPPORT
3569fae81c72SGuillaume GARDET		Support for EXT filesystem in SPL binary
357095579793STom Rini
3571fae81c72SGuillaume GARDET		CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
3572fae81c72SGuillaume GARDET		Filename to read to load U-Boot when reading from filesystem
3573fae81c72SGuillaume GARDET
3574fae81c72SGuillaume GARDET		CONFIG_SPL_FS_LOAD_KERNEL_NAME
35757ad2cc79SPeter Korsgaard		Filename to read to load kernel uImage when reading
3576fae81c72SGuillaume GARDET		from filesystem (for Falcon mode)
35777ad2cc79SPeter Korsgaard
3578fae81c72SGuillaume GARDET		CONFIG_SPL_FS_LOAD_ARGS_NAME
35797ad2cc79SPeter Korsgaard		Filename to read to load kernel argument parameters
3580fae81c72SGuillaume GARDET		when reading from filesystem (for Falcon mode)
35817ad2cc79SPeter Korsgaard
358206f60ae3SScott Wood		CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
358306f60ae3SScott Wood		Set this for NAND SPL on PPC mpc83xx targets, so that
358406f60ae3SScott Wood		start.S waits for the rest of the SPL to load before
358506f60ae3SScott Wood		continuing (the hardware starts execution after just
358606f60ae3SScott Wood		loading the first page rather than the full 4K).
358706f60ae3SScott Wood
3588651fcf60SPrabhakar Kushwaha		CONFIG_SPL_SKIP_RELOCATE
3589651fcf60SPrabhakar Kushwaha		Avoid SPL relocation
3590651fcf60SPrabhakar Kushwaha
35916f2f01b9SScott Wood		CONFIG_SPL_NAND_BASE
35926f2f01b9SScott Wood		Include nand_base.c in the SPL.  Requires
35936f2f01b9SScott Wood		CONFIG_SPL_NAND_DRIVERS.
35946f2f01b9SScott Wood
35956f2f01b9SScott Wood		CONFIG_SPL_NAND_DRIVERS
35966f2f01b9SScott Wood		SPL uses normal NAND drivers, not minimal drivers.
35976f2f01b9SScott Wood
35986f2f01b9SScott Wood		CONFIG_SPL_NAND_ECC
35996f2f01b9SScott Wood		Include standard software ECC in the SPL
36006f2f01b9SScott Wood
360195579793STom Rini		CONFIG_SPL_NAND_SIMPLE
36027d4b7955SScott Wood		Support for NAND boot using simple NAND drivers that
36037d4b7955SScott Wood		expose the cmd_ctrl() interface.
360495579793STom Rini
36056dd3b566STom Rini		CONFIG_SPL_MTD_SUPPORT
36066dd3b566STom Rini		Support for the MTD subsystem within SPL.  Useful for
36076dd3b566STom Rini		environment on NAND support within SPL.
36086dd3b566STom Rini
36090c3117b1SHeiko Schocher		CONFIG_SPL_NAND_RAW_ONLY
36100c3117b1SHeiko Schocher		Support to boot only raw u-boot.bin images. Use this only
36110c3117b1SHeiko Schocher		if you need to save space.
36120c3117b1SHeiko Schocher
3613bb0dc108SYing Zhang		CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT
3614bb0dc108SYing Zhang		Set for the SPL on PPC mpc8xxx targets, support for
36155614e71bSYork Sun		drivers/ddr/fsl/libddr.o in SPL binary.
3616bb0dc108SYing Zhang
36177c8eea59SYing Zhang		CONFIG_SPL_COMMON_INIT_DDR
36187c8eea59SYing Zhang		Set for common ddr init with serial presence detect in
36197c8eea59SYing Zhang		SPL binary.
36207c8eea59SYing Zhang
362195579793STom Rini		CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
362295579793STom Rini		CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
362395579793STom Rini		CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
362495579793STom Rini		CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
362595579793STom Rini		CONFIG_SYS_NAND_ECCBYTES
362695579793STom Rini		Defines the size and behavior of the NAND that SPL uses
36277d4b7955SScott Wood		to read U-Boot
362895579793STom Rini
3629fbe76ae4SPrabhakar Kushwaha		CONFIG_SPL_NAND_BOOT
3630fbe76ae4SPrabhakar Kushwaha		Add support NAND boot
3631fbe76ae4SPrabhakar Kushwaha
363295579793STom Rini		CONFIG_SYS_NAND_U_BOOT_OFFS
36337d4b7955SScott Wood		Location in NAND to read U-Boot from
36347d4b7955SScott Wood
36357d4b7955SScott Wood		CONFIG_SYS_NAND_U_BOOT_DST
36367d4b7955SScott Wood		Location in memory to load U-Boot to
36377d4b7955SScott Wood
36387d4b7955SScott Wood		CONFIG_SYS_NAND_U_BOOT_SIZE
36397d4b7955SScott Wood		Size of image to load
364095579793STom Rini
364195579793STom Rini		CONFIG_SYS_NAND_U_BOOT_START
36427d4b7955SScott Wood		Entry point in loaded image to jump to
364395579793STom Rini
364495579793STom Rini		CONFIG_SYS_NAND_HW_ECC_OOBFIRST
364595579793STom Rini		Define this if you need to first read the OOB and then the
364695579793STom Rini		data. This is used for example on davinci plattforms.
364795579793STom Rini
364895579793STom Rini		CONFIG_SPL_OMAP3_ID_NAND
364995579793STom Rini		Support for an OMAP3-specific set of functions to return the
365095579793STom Rini		ID and MFR of the first attached NAND chip, if present.
365195579793STom Rini
36526a11cf48SDaniel Schwierzeck		CONFIG_SPL_SERIAL_SUPPORT
36536a11cf48SDaniel Schwierzeck		Support for drivers/serial/libserial.o in SPL binary
36546a11cf48SDaniel Schwierzeck
36556a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_FLASH_SUPPORT
36566a11cf48SDaniel Schwierzeck		Support for drivers/mtd/spi/libspi_flash.o in SPL binary
36576a11cf48SDaniel Schwierzeck
36586a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_SUPPORT
36596a11cf48SDaniel Schwierzeck		Support for drivers/spi/libspi.o in SPL binary
36606a11cf48SDaniel Schwierzeck
3661c57b953dSPavel Machek		CONFIG_SPL_RAM_DEVICE
3662c57b953dSPavel Machek		Support for running image already present in ram, in SPL binary
3663c57b953dSPavel Machek
36646a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBGENERIC_SUPPORT
36656a11cf48SDaniel Schwierzeck		Support for lib/libgeneric.o in SPL binary
36661372cce2SMarian Balakowicz
3667ba1bee43SYing Zhang		CONFIG_SPL_ENV_SUPPORT
3668ba1bee43SYing Zhang		Support for the environment operating in SPL binary
3669ba1bee43SYing Zhang
3670ba1bee43SYing Zhang		CONFIG_SPL_NET_SUPPORT
3671ba1bee43SYing Zhang		Support for the net/libnet.o in SPL binary.
3672ba1bee43SYing Zhang		It conflicts with SPL env from storage medium specified by
3673ba1bee43SYing Zhang		CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3674ba1bee43SYing Zhang
367574752baaSScott Wood		CONFIG_SPL_PAD_TO
36766113d3f2SBenoît Thébaudeau		Image offset to which the SPL should be padded before appending
36776113d3f2SBenoît Thébaudeau		the SPL payload. By default, this is defined as
36786113d3f2SBenoît Thébaudeau		CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
36796113d3f2SBenoît Thébaudeau		CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
36806113d3f2SBenoît Thébaudeau		payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
368174752baaSScott Wood
3682ca2fca22SScott Wood		CONFIG_SPL_TARGET
3683ca2fca22SScott Wood		Final target image containing SPL and payload.  Some SPLs
3684ca2fca22SScott Wood		use an arch-specific makefile fragment instead, for
3685ca2fca22SScott Wood		example if more than one image needs to be produced.
3686ca2fca22SScott Wood
368787ebee39SSimon Glass		CONFIG_FIT_SPL_PRINT
368887ebee39SSimon Glass		Printing information about a FIT image adds quite a bit of
368987ebee39SSimon Glass		code to SPL. So this is normally disabled in SPL. Use this
369087ebee39SSimon Glass		option to re-enable it. This will affect the output of the
369187ebee39SSimon Glass		bootm command when booting a FIT image.
369287ebee39SSimon Glass
36933aa29de0SYing Zhang- TPL framework
36943aa29de0SYing Zhang		CONFIG_TPL
36953aa29de0SYing Zhang		Enable building of TPL globally.
36963aa29de0SYing Zhang
36973aa29de0SYing Zhang		CONFIG_TPL_PAD_TO
36983aa29de0SYing Zhang		Image offset to which the TPL should be padded before appending
36993aa29de0SYing Zhang		the TPL payload. By default, this is defined as
37003aa29de0SYing Zhang		CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
37013aa29de0SYing Zhang		CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
37023aa29de0SYing Zhang		payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
37033aa29de0SYing Zhang
3704c609719bSwdenkModem Support:
3705c609719bSwdenk--------------
3706c609719bSwdenk
3707566e5cf4SWolfgang Denk[so far only for SMDK2400 boards]
3708c609719bSwdenk
370911ccc33fSMarcel Ziswiler- Modem support enable:
3710c609719bSwdenk		CONFIG_MODEM_SUPPORT
3711c609719bSwdenk
3712c609719bSwdenk- RTS/CTS Flow control enable:
3713c609719bSwdenk		CONFIG_HWFLOW
3714c609719bSwdenk
3715c609719bSwdenk- Modem debug support:
3716c609719bSwdenk		CONFIG_MODEM_SUPPORT_DEBUG
3717c609719bSwdenk
3718c609719bSwdenk		Enables debugging stuff (char screen[1024], dbg())
3719c609719bSwdenk		for modem support. Useful only with BDI2000.
3720c609719bSwdenk
3721a8c7c708Swdenk- Interrupt support (PPC):
3722a8c7c708Swdenk
3723a8c7c708Swdenk		There are common interrupt_init() and timer_interrupt()
3724a8c7c708Swdenk		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
372511ccc33fSMarcel Ziswiler		for CPU specific initialization. interrupt_init_cpu()
3726a8c7c708Swdenk		should set decrementer_count to appropriate value. If
372711ccc33fSMarcel Ziswiler		CPU resets decrementer automatically after interrupt
3728a8c7c708Swdenk		(ppc4xx) it should set decrementer_count to zero.
372911ccc33fSMarcel Ziswiler		timer_interrupt() calls timer_interrupt_cpu() for CPU
3730a8c7c708Swdenk		specific handling. If board has watchdog / status_led
3731a8c7c708Swdenk		/ other_activity_monitor it works automatically from
3732a8c7c708Swdenk		general timer_interrupt().
3733a8c7c708Swdenk
3734c609719bSwdenk- General:
3735c609719bSwdenk
3736c609719bSwdenk		In the target system modem support is enabled when a
3737c609719bSwdenk		specific key (key combination) is pressed during
3738c609719bSwdenk		power-on. Otherwise U-Boot will boot normally
373911ccc33fSMarcel Ziswiler		(autoboot). The key_pressed() function is called from
3740c609719bSwdenk		board_init(). Currently key_pressed() is a dummy
3741c609719bSwdenk		function, returning 1 and thus enabling modem
3742c609719bSwdenk		initialization.
3743c609719bSwdenk
3744c609719bSwdenk		If there are no modem init strings in the
3745c609719bSwdenk		environment, U-Boot proceed to autoboot; the
3746c609719bSwdenk		previous output (banner, info printfs) will be
374711ccc33fSMarcel Ziswiler		suppressed, though.
3748c609719bSwdenk
3749c609719bSwdenk		See also: doc/README.Modem
3750c609719bSwdenk
37519660e442SHelmut RaigerBoard initialization settings:
37529660e442SHelmut Raiger------------------------------
37539660e442SHelmut Raiger
37549660e442SHelmut RaigerDuring Initialization u-boot calls a number of board specific functions
37559660e442SHelmut Raigerto allow the preparation of board specific prerequisites, e.g. pin setup
37569660e442SHelmut Raigerbefore drivers are initialized. To enable these callbacks the
37579660e442SHelmut Raigerfollowing configuration macros have to be defined. Currently this is
37589660e442SHelmut Raigerarchitecture specific, so please check arch/your_architecture/lib/board.c
37599660e442SHelmut Raigertypically in board_init_f() and board_init_r().
37609660e442SHelmut Raiger
37619660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
37629660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
37639660e442SHelmut Raiger- CONFIG_BOARD_LATE_INIT: Call board_late_init()
37649660e442SHelmut Raiger- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
3765c609719bSwdenk
3766c609719bSwdenkConfiguration Settings:
3767c609719bSwdenk-----------------------
3768c609719bSwdenk
37694d1fd7f1SYork Sun- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
37704d1fd7f1SYork Sun		Optionally it can be defined to support 64-bit memory commands.
37714d1fd7f1SYork Sun
37726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
3773c609719bSwdenk		undefine this when you're short of memory.
3774c609719bSwdenk
37752fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
37762fb2604dSPeter Tyser		width of the commands listed in the 'help' command output.
37772fb2604dSPeter Tyser
37786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT:	This is what U-Boot prints on the console to
3779c609719bSwdenk		prompt for user input.
3780c609719bSwdenk
37816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE:	Buffer size for input from the Console
3782c609719bSwdenk
37836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE:	Buffer size for Console output
3784c609719bSwdenk
37856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS:	max. Number of arguments accepted for monitor commands
3786c609719bSwdenk
37876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
3788c609719bSwdenk		the application (usually a Linux kernel) when it is
3789c609719bSwdenk		booted
3790c609719bSwdenk
37916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE:
3792c609719bSwdenk		List of legal baudrate settings for this board.
3793c609719bSwdenk
37946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_INFO_QUIET
3795c609719bSwdenk		Suppress display of console information at boot.
3796c609719bSwdenk
37976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_IS_IN_ENV
3798c609719bSwdenk		If the board specific function
3799c609719bSwdenk			extern int overwrite_console (void);
3800c609719bSwdenk		returns 1, the stdin, stderr and stdout are switched to the
3801c609719bSwdenk		serial port, else the settings in the environment are used.
3802c609719bSwdenk
38036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
3804c609719bSwdenk		Enable the call to overwrite_console().
3805c609719bSwdenk
38066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
3807c609719bSwdenk		Enable overwrite of previous console environment settings.
3808c609719bSwdenk
38096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
3810c609719bSwdenk		Begin and End addresses of the area used by the
3811c609719bSwdenk		simple memory test.
3812c609719bSwdenk
38136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST:
3814c609719bSwdenk		Enable an alternate, more extensive memory test.
3815c609719bSwdenk
38166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH:
38175f535fe1Swdenk		Scratch address used by the alternate memory test
38185f535fe1Swdenk		You only need to set this if address zero isn't writeable
38195f535fe1Swdenk
38206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
38216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
382214f73ca6SStefan Roese		this specified memory area will get subtracted from the top
382311ccc33fSMarcel Ziswiler		(end) of RAM and won't get "touched" at all by U-Boot. By
382414f73ca6SStefan Roese		fixing up gd->ram_size the Linux kernel should gets passed
382514f73ca6SStefan Roese		the now "corrected" memory size and won't touch it either.
382614f73ca6SStefan Roese		This should work for arch/ppc and arch/powerpc. Only Linux
38275e12e75dSStefan Roese		board ports in arch/powerpc with bootwrapper support that
382814f73ca6SStefan Roese		recalculate the memory size from the SDRAM controller setup
38295e12e75dSStefan Roese		will have to get fixed in Linux additionally.
383014f73ca6SStefan Roese
383114f73ca6SStefan Roese		This option can be used as a workaround for the 440EPx/GRx
383214f73ca6SStefan Roese		CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
383314f73ca6SStefan Roese		be touched.
383414f73ca6SStefan Roese
383514f73ca6SStefan Roese		WARNING: Please make sure that this value is a multiple of
383614f73ca6SStefan Roese		the Linux page size (normally 4k). If this is not the case,
383714f73ca6SStefan Roese		then the end address of the Linux memory will be located at a
383814f73ca6SStefan Roese		non page size aligned address and this could cause major
383914f73ca6SStefan Roese		problems.
384014f73ca6SStefan Roese
38416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE:
3842c609719bSwdenk		Enable temporary baudrate change while serial download
3843c609719bSwdenk
38446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE:
3845c609719bSwdenk		Physical start address of SDRAM. _Must_ be 0 here.
3846c609719bSwdenk
38476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MBIO_BASE:
3848c609719bSwdenk		Physical start address of Motherboard I/O (if using a
3849c609719bSwdenk		Cogent motherboard)
3850c609719bSwdenk
38516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE:
3852c609719bSwdenk		Physical start address of Flash memory.
3853c609719bSwdenk
38546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE:
3855c609719bSwdenk		Physical start address of boot monitor code (set by
3856c609719bSwdenk		make config files to be same as the text base address
385714d0a02aSWolfgang Denk		(CONFIG_SYS_TEXT_BASE) used when linking) - same as
38586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FLASH_BASE when booting from flash.
3859c609719bSwdenk
38606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN:
38613b57fe0aSwdenk		Size of memory reserved for monitor code, used to
38623b57fe0aSwdenk		determine _at_compile_time_ (!) if the environment is
38633b57fe0aSwdenk		embedded within the U-Boot image, or in a separate
38643b57fe0aSwdenk		flash sector.
3865c609719bSwdenk
38666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN:
3867c609719bSwdenk		Size of DRAM reserved for malloc() use.
3868c609719bSwdenk
3869d59476b6SSimon Glass- CONFIG_SYS_MALLOC_F_LEN
3870d59476b6SSimon Glass		Size of the malloc() pool for use before relocation. If
3871d59476b6SSimon Glass		this is defined, then a very simple malloc() implementation
3872d59476b6SSimon Glass		will become available before relocation. The address is just
3873d59476b6SSimon Glass		below the global data, and the stack is moved down to make
3874d59476b6SSimon Glass		space.
3875d59476b6SSimon Glass
3876d59476b6SSimon Glass		This feature allocates regions with increasing addresses
3877d59476b6SSimon Glass		within the region. calloc() is supported, but realloc()
3878d59476b6SSimon Glass		is not available. free() is supported but does nothing.
3879d59476b6SSimon Glass		The memory will be freed (or in fact just forgotton) when
3880d59476b6SSimon Glass		U-Boot relocates itself.
3881d59476b6SSimon Glass
3882e7b14e9aSSimon Glass		Pre-relocation malloc() is only supported on ARM and sandbox
388329afe9e6SSimon Glass		at present but is fairly easy to enable for other archs.
388429afe9e6SSimon Glass
38856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN:
388615940c9aSStefan Roese		Normally compressed uImages are limited to an
388715940c9aSStefan Roese		uncompressed size of 8 MBytes. If this is not enough,
38886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		you can define CONFIG_SYS_BOOTM_LEN in your board config file
388915940c9aSStefan Roese		to adjust this setting to your needs.
3890c609719bSwdenk
38916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ:
3892c609719bSwdenk		Maximum size of memory mapped by the startup code of
3893c609719bSwdenk		the Linux kernel; all data that must be processed by
38947d721e34SBartlomiej Sieka		the Linux kernel (bd_info, boot arguments, FDT blob if
38957d721e34SBartlomiej Sieka		used) must be put below this limit, unless "bootm_low"
38961bce2aebSRobert P. J. Day		environment variable is defined and non-zero. In such case
38977d721e34SBartlomiej Sieka		all data for the Linux kernel must be between "bootm_low"
3898c3624e6eSGrant Likely		and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.	 The environment
3899c3624e6eSGrant Likely		variable "bootm_mapsize" will override the value of
3900c3624e6eSGrant Likely		CONFIG_SYS_BOOTMAPSZ.  If CONFIG_SYS_BOOTMAPSZ is undefined,
3901c3624e6eSGrant Likely		then the value in "bootm_size" will be used instead.
3902c609719bSwdenk
3903fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3904fca43cc8SJohn Rigby		Enable initrd_high functionality.  If defined then the
3905fca43cc8SJohn Rigby		initrd_high feature is enabled and the bootm ramdisk subcommand
3906fca43cc8SJohn Rigby		is enabled.
3907fca43cc8SJohn Rigby
3908fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_CMDLINE:
3909fca43cc8SJohn Rigby		Enables allocating and saving kernel cmdline in space between
3910fca43cc8SJohn Rigby		"bootm_low" and "bootm_low" + BOOTMAPSZ.
3911fca43cc8SJohn Rigby
3912fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_KBD:
3913fca43cc8SJohn Rigby		Enables allocating and saving a kernel copy of the bd_info in
3914fca43cc8SJohn Rigby		space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3915fca43cc8SJohn Rigby
39166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS:
3917c609719bSwdenk		Max number of Flash memory banks
3918c609719bSwdenk
39196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT:
3920c609719bSwdenk		Max number of sectors on a Flash chip
3921c609719bSwdenk
39226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT:
3923c609719bSwdenk		Timeout for Flash erase operations (in ms)
3924c609719bSwdenk
39256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT:
3926c609719bSwdenk		Timeout for Flash write operations (in ms)
3927c609719bSwdenk
39286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT
39298564acf9Swdenk		Timeout for Flash set sector lock bit operation (in ms)
39308564acf9Swdenk
39316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT
39328564acf9Swdenk		Timeout for Flash clear lock bits operation (in ms)
39338564acf9Swdenk
39346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION
39358564acf9Swdenk		If defined, hardware flash sectors protection is used
39368564acf9Swdenk		instead of U-Boot software protection.
39378564acf9Swdenk
39386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP:
3939c609719bSwdenk
3940c609719bSwdenk		Enable TFTP transfers directly to flash memory;
3941c609719bSwdenk		without this option such a download has to be
3942c609719bSwdenk		performed in two steps: (1) download to RAM, and (2)
3943c609719bSwdenk		copy from RAM to flash.
3944c609719bSwdenk
3945c609719bSwdenk		The two-step approach is usually more reliable, since
3946c609719bSwdenk		you can check if the download worked before you erase
394711ccc33fSMarcel Ziswiler		the flash, but in some situations (when system RAM is
394811ccc33fSMarcel Ziswiler		too limited to allow for a temporary copy of the
3949c609719bSwdenk		downloaded image) this option may be very useful.
3950c609719bSwdenk
39516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI:
3952c609719bSwdenk		Define if the flash driver uses extra elements in the
39535653fc33Swdenk		common flash structure for storing flash geometry.
39545653fc33Swdenk
395500b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER
39565653fc33Swdenk		This option also enables the building of the cfi_flash driver
39575653fc33Swdenk		in the drivers directory
395853cf9435Sstroese
395991809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD
396091809ed5SPiotr Ziecik		This option enables the building of the cfi_mtd driver
396191809ed5SPiotr Ziecik		in the drivers directory. The driver exports CFI flash
396291809ed5SPiotr Ziecik		to the MTD layer.
396391809ed5SPiotr Ziecik
39646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
396596ef831fSGuennadi Liakhovetski		Use buffered writes to flash.
396696ef831fSGuennadi Liakhovetski
396796ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N
396896ef831fSGuennadi Liakhovetski		s29ws-n MirrorBit flash has non-standard addresses for buffered
396996ef831fSGuennadi Liakhovetski		write commands.
397096ef831fSGuennadi Liakhovetski
39716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST
39725568e613SStefan Roese		If this option is defined, the common CFI flash doesn't
39735568e613SStefan Roese		print it's warning upon not recognized FLASH banks. This
39745568e613SStefan Roese		is useful, if some of the configured banks are only
39755568e613SStefan Roese		optionally available.
39765568e613SStefan Roese
39779a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS
39789a042e9cSJerry Van Baren		If defined (must be an integer), print out countdown
39799a042e9cSJerry Van Baren		digits and dots.  Recommended value: 45 (9..1) for 80
39809a042e9cSJerry Van Baren		column displays, 15 (3..1) for 40 column displays.
39819a042e9cSJerry Van Baren
3982352ef3f1SStefan Roese- CONFIG_FLASH_VERIFY
3983352ef3f1SStefan Roese		If defined, the content of the flash (destination) is compared
3984352ef3f1SStefan Roese		against the source after the write operation. An error message
3985352ef3f1SStefan Roese		will be printed when the contents are not identical.
3986352ef3f1SStefan Roese		Please note that this option is useless in nearly all cases,
3987352ef3f1SStefan Roese		since such flash programming errors usually are detected earlier
3988352ef3f1SStefan Roese		while unprotecting/erasing/programming. Please only enable
3989352ef3f1SStefan Roese		this option if you really know what you are doing.
3990352ef3f1SStefan Roese
39916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER:
399211ccc33fSMarcel Ziswiler		Defines the number of Ethernet receive buffers. On some
399311ccc33fSMarcel Ziswiler		Ethernet controllers it is recommended to set this value
399453cf9435Sstroese		to 8 or even higher (EEPRO100 or 405 EMAC), since all
399553cf9435Sstroese		buffers can be full shortly after enabling the interface
399611ccc33fSMarcel Ziswiler		on high Ethernet traffic.
399753cf9435Sstroese		Defaults to 4 if not defined.
3998c609719bSwdenk
3999ea882bafSWolfgang Denk- CONFIG_ENV_MAX_ENTRIES
4000ea882bafSWolfgang Denk
4001ea882bafSWolfgang Denk	Maximum number of entries in the hash table that is used
4002ea882bafSWolfgang Denk	internally to store the environment settings. The default
4003ea882bafSWolfgang Denk	setting is supposed to be generous and should work in most
4004ea882bafSWolfgang Denk	cases. This setting can be used to tune behaviour; see
4005ea882bafSWolfgang Denk	lib/hashtable.c for details.
4006ea882bafSWolfgang Denk
40072598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_DEFAULT
40082598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_STATIC
40091bce2aebSRobert P. J. Day	Enable validation of the values given to environment variables when
40102598090bSJoe Hershberger	calling env set.  Variables can be restricted to only decimal,
40112598090bSJoe Hershberger	hexadecimal, or boolean.  If CONFIG_CMD_NET is also defined,
40122598090bSJoe Hershberger	the variables can also be restricted to IP address or MAC address.
40132598090bSJoe Hershberger
40142598090bSJoe Hershberger	The format of the list is:
40152598090bSJoe Hershberger		type_attribute = [s|d|x|b|i|m]
4016267541f7SJoe Hershberger		access_atribute = [a|r|o|c]
4017267541f7SJoe Hershberger		attributes = type_attribute[access_atribute]
40182598090bSJoe Hershberger		entry = variable_name[:attributes]
40192598090bSJoe Hershberger		list = entry[,list]
40202598090bSJoe Hershberger
40212598090bSJoe Hershberger	The type attributes are:
40222598090bSJoe Hershberger		s - String (default)
40232598090bSJoe Hershberger		d - Decimal
40242598090bSJoe Hershberger		x - Hexadecimal
40252598090bSJoe Hershberger		b - Boolean ([1yYtT|0nNfF])
40262598090bSJoe Hershberger		i - IP address
40272598090bSJoe Hershberger		m - MAC address
40282598090bSJoe Hershberger
4029267541f7SJoe Hershberger	The access attributes are:
4030267541f7SJoe Hershberger		a - Any (default)
4031267541f7SJoe Hershberger		r - Read-only
4032267541f7SJoe Hershberger		o - Write-once
4033267541f7SJoe Hershberger		c - Change-default
4034267541f7SJoe Hershberger
40352598090bSJoe Hershberger	- CONFIG_ENV_FLAGS_LIST_DEFAULT
40362598090bSJoe Hershberger		Define this to a list (string) to define the ".flags"
40372598090bSJoe Hershberger		envirnoment variable in the default or embedded environment.
40382598090bSJoe Hershberger
40392598090bSJoe Hershberger	- CONFIG_ENV_FLAGS_LIST_STATIC
40402598090bSJoe Hershberger		Define this to a list (string) to define validation that
40412598090bSJoe Hershberger		should be done if an entry is not found in the ".flags"
40422598090bSJoe Hershberger		environment variable.  To override a setting in the static
40432598090bSJoe Hershberger		list, simply add an entry for the same variable name to the
40442598090bSJoe Hershberger		".flags" variable.
40452598090bSJoe Hershberger
4046267541f7SJoe Hershberger- CONFIG_ENV_ACCESS_IGNORE_FORCE
4047267541f7SJoe Hershberger	If defined, don't allow the -f switch to env set override variable
4048267541f7SJoe Hershberger	access flags.
4049267541f7SJoe Hershberger
40505c1a7ea6SSimon Glass- CONFIG_SYS_GENERIC_BOARD
40515c1a7ea6SSimon Glass	This selects the architecture-generic board system instead of the
40525c1a7ea6SSimon Glass	architecture-specific board files. It is intended to move boards
40535c1a7ea6SSimon Glass	to this new framework over time. Defining this will disable the
40545c1a7ea6SSimon Glass	arch/foo/lib/board.c file and use common/board_f.c and
40555c1a7ea6SSimon Glass	common/board_r.c instead. To use this option your architecture
40565c1a7ea6SSimon Glass	must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in
40575c1a7ea6SSimon Glass	its config.mk file). If you find problems enabling this option on
40585c1a7ea6SSimon Glass	your board please report the problem and send patches!
40595c1a7ea6SSimon Glass
40600b1b60c7SLokesh Vutla- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
40610b1b60c7SLokesh Vutla	This is set by OMAP boards for the max time that reset should
40620b1b60c7SLokesh Vutla	be asserted. See doc/README.omap-reset-time for details on how
40630b1b60c7SLokesh Vutla	the value can be calulated on a given board.
4064632efa74SSimon Glass
40650d296cc2SGabe Black- CONFIG_USE_STDINT
40660d296cc2SGabe Black	If stdint.h is available with your toolchain you can define this
40670d296cc2SGabe Black	option to enable it. You can provide option 'USE_STDINT=1' when
40680d296cc2SGabe Black	building U-Boot to enable this.
40690d296cc2SGabe Black
4070c609719bSwdenkThe following definitions that deal with the placement and management
4071c609719bSwdenkof environment data (variable area); in general, we support the
4072c609719bSwdenkfollowing configurations:
4073c609719bSwdenk
4074c3eb3fe4SMike Frysinger- CONFIG_BUILD_ENVCRC:
4075c3eb3fe4SMike Frysinger
4076c3eb3fe4SMike Frysinger	Builds up envcrc with the target environment so that external utils
4077c3eb3fe4SMike Frysinger	may easily extract it and embed it in final U-Boot images.
4078c3eb3fe4SMike Frysinger
40795a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH:
4080c609719bSwdenk
4081c609719bSwdenk	Define this if the environment is in flash memory.
4082c609719bSwdenk
4083c609719bSwdenk	a) The environment occupies one whole flash sector, which is
4084c609719bSwdenk	   "embedded" in the text segment with the U-Boot code. This
4085c609719bSwdenk	   happens usually with "bottom boot sector" or "top boot
4086c609719bSwdenk	   sector" type flash chips, which have several smaller
4087c609719bSwdenk	   sectors at the start or the end. For instance, such a
4088c609719bSwdenk	   layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
4089c609719bSwdenk	   such a case you would place the environment in one of the
4090c609719bSwdenk	   4 kB sectors - with U-Boot code before and after it. With
4091c609719bSwdenk	   "top boot sector" type flash chips, you would put the
4092c609719bSwdenk	   environment in one of the last sectors, leaving a gap
4093c609719bSwdenk	   between U-Boot and the environment.
4094c609719bSwdenk
40950e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
4096c609719bSwdenk
4097c609719bSwdenk	   Offset of environment data (variable area) to the
4098c609719bSwdenk	   beginning of flash memory; for instance, with bottom boot
4099c609719bSwdenk	   type flash chips the second sector can be used: the offset
4100c609719bSwdenk	   for this sector is given here.
4101c609719bSwdenk
41026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
4103c609719bSwdenk
41040e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
4105c609719bSwdenk
4106c609719bSwdenk	   This is just another way to specify the start address of
4107c609719bSwdenk	   the flash sector containing the environment (instead of
41080e8d1586SJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET).
4109c609719bSwdenk
41100e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SECT_SIZE:
4111c609719bSwdenk
4112c609719bSwdenk	   Size of the sector containing the environment.
4113c609719bSwdenk
4114c609719bSwdenk
4115c609719bSwdenk	b) Sometimes flash chips have few, equal sized, BIG sectors.
4116c609719bSwdenk	   In such a case you don't want to spend a whole sector for
4117c609719bSwdenk	   the environment.
4118c609719bSwdenk
41190e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
4120c609719bSwdenk
41215a1aceb0SJean-Christophe PLAGNIOL-VILLARD	   If you use this in combination with CONFIG_ENV_IS_IN_FLASH
41220e8d1586SJean-Christophe PLAGNIOL-VILLARD	   and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
4123c609719bSwdenk	   of this flash sector for the environment. This saves
4124c609719bSwdenk	   memory for the RAM copy of the environment.
4125c609719bSwdenk
4126c609719bSwdenk	   It may also save flash memory if you decide to use this
4127c609719bSwdenk	   when your environment is "embedded" within U-Boot code,
4128c609719bSwdenk	   since then the remainder of the flash sector could be used
4129c609719bSwdenk	   for U-Boot code. It should be pointed out that this is
4130c609719bSwdenk	   STRONGLY DISCOURAGED from a robustness point of view:
4131c609719bSwdenk	   updating the environment in flash makes it always
4132c609719bSwdenk	   necessary to erase the WHOLE sector. If something goes
4133c609719bSwdenk	   wrong before the contents has been restored from a copy in
4134c609719bSwdenk	   RAM, your target system will be dead.
4135c609719bSwdenk
41360e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR_REDUND
41370e8d1586SJean-Christophe PLAGNIOL-VILLARD	  CONFIG_ENV_SIZE_REDUND
4138c609719bSwdenk
4139c609719bSwdenk	   These settings describe a second storage area used to hold
414011ccc33fSMarcel Ziswiler	   a redundant copy of the environment data, so that there is
41413e38691eSwdenk	   a valid backup copy in case there is a power failure during
4142c609719bSwdenk	   a "saveenv" operation.
4143c609719bSwdenk
4144c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the
4145c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds*
4146c609719bSwdenkaccordingly!
4147c609719bSwdenk
4148c609719bSwdenk
41499314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM:
4150c609719bSwdenk
4151c609719bSwdenk	Define this if you have some non-volatile memory device
4152c609719bSwdenk	(NVRAM, battery buffered SRAM) which you want to use for the
4153c609719bSwdenk	environment.
4154c609719bSwdenk
41550e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
41560e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
4157c609719bSwdenk
415811ccc33fSMarcel Ziswiler	  These two #defines are used to determine the memory area you
4159c609719bSwdenk	  want to use for environment. It is assumed that this memory
4160c609719bSwdenk	  can just be read and written to, without any special
4161c609719bSwdenk	  provision.
4162c609719bSwdenk
4163c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early
4164c609719bSwdenkin U-Boot initalization (when we try to get the setting of for the
416511ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or
4166c609719bSwdenkU-Boot will hang.
4167c609719bSwdenk
4168c609719bSwdenkPlease note that even with NVRAM we still use a copy of the
4169c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to
4170c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv"
4171c609719bSwdenkto save the current settings.
4172c609719bSwdenk
4173c609719bSwdenk
4174bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM:
4175c609719bSwdenk
4176c609719bSwdenk	Use this if you have an EEPROM or similar serial access
4177c609719bSwdenk	device and a driver for it.
4178c609719bSwdenk
41790e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
41800e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
4181c609719bSwdenk
4182c609719bSwdenk	  These two #defines specify the offset and size of the
4183c609719bSwdenk	  environment area within the total memory of your EEPROM.
4184c609719bSwdenk
41856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR:
4186c609719bSwdenk	  If defined, specified the chip address of the EEPROM device.
4187c609719bSwdenk	  The default address is zero.
4188c609719bSwdenk
41896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
4190c609719bSwdenk	  If defined, the number of bits used to address bytes in a
4191c609719bSwdenk	  single page in the EEPROM device.  A 64 byte page, for example
4192c609719bSwdenk	  would require six bits.
4193c609719bSwdenk
41946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
4195c609719bSwdenk	  If defined, the number of milliseconds to delay between
4196c609719bSwdenk	  page writes.	The default is zero milliseconds.
4197c609719bSwdenk
41986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
4199c609719bSwdenk	  The length in bytes of the EEPROM memory array address.  Note
4200c609719bSwdenk	  that this is NOT the chip address length!
4201c609719bSwdenk
42026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
42035cf91d6bSwdenk	  EEPROM chips that implement "address overflow" are ones
42045cf91d6bSwdenk	  like Catalyst 24WC04/08/16 which has 9/10/11 bits of
42055cf91d6bSwdenk	  address and the extra bits end up in the "chip address" bit
42065cf91d6bSwdenk	  slots. This makes a 24WC08 (1Kbyte) chip look like four 256
42075cf91d6bSwdenk	  byte chips.
42085cf91d6bSwdenk
42095cf91d6bSwdenk	  Note that we consider the length of the address field to
42105cf91d6bSwdenk	  still be one byte because the extra address bits are hidden
42115cf91d6bSwdenk	  in the chip address.
42125cf91d6bSwdenk
42136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_SIZE:
4214c609719bSwdenk	  The size in bytes of the EEPROM device.
4215c609719bSwdenk
4216548738b4SHeiko Schocher	- CONFIG_ENV_EEPROM_IS_ON_I2C
4217548738b4SHeiko Schocher	  define this, if you have I2C and SPI activated, and your
4218548738b4SHeiko Schocher	  EEPROM, which holds the environment, is on the I2C bus.
4219548738b4SHeiko Schocher
4220548738b4SHeiko Schocher	- CONFIG_I2C_ENV_EEPROM_BUS
4221548738b4SHeiko Schocher	  if you have an Environment on an EEPROM reached over
4222548738b4SHeiko Schocher	  I2C muxes, you can define here, how to reach this
4223548738b4SHeiko Schocher	  EEPROM. For example:
4224548738b4SHeiko Schocher
4225ea818dbbSHeiko Schocher	  #define CONFIG_I2C_ENV_EEPROM_BUS	  1
4226548738b4SHeiko Schocher
4227548738b4SHeiko Schocher	  EEPROM which holds the environment, is reached over
4228548738b4SHeiko Schocher	  a pca9547 i2c mux with address 0x70, channel 3.
4229c609719bSwdenk
4230057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH:
42315779d8d9Swdenk
42325779d8d9Swdenk	Define this if you have a DataFlash memory device which you
42335779d8d9Swdenk	want to use for the environment.
42345779d8d9Swdenk
42350e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
42360e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
42370e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
42385779d8d9Swdenk
42395779d8d9Swdenk	  These three #defines specify the offset and size of the
42405779d8d9Swdenk	  environment area within the total memory of your DataFlash placed
42415779d8d9Swdenk	  at the specified address.
42425779d8d9Swdenk
4243bd83b592SWu, Josh- CONFIG_ENV_IS_IN_SPI_FLASH:
4244bd83b592SWu, Josh
4245bd83b592SWu, Josh	Define this if you have a SPI Flash memory device which you
4246bd83b592SWu, Josh	want to use for the environment.
4247bd83b592SWu, Josh
4248bd83b592SWu, Josh	- CONFIG_ENV_OFFSET:
4249bd83b592SWu, Josh	- CONFIG_ENV_SIZE:
4250bd83b592SWu, Josh
4251bd83b592SWu, Josh	  These two #defines specify the offset and size of the
4252bd83b592SWu, Josh	  environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
4253bd83b592SWu, Josh	  aligned to an erase sector boundary.
4254bd83b592SWu, Josh
4255bd83b592SWu, Josh	- CONFIG_ENV_SECT_SIZE:
4256bd83b592SWu, Josh
4257bd83b592SWu, Josh	  Define the SPI flash's sector size.
4258bd83b592SWu, Josh
4259bd83b592SWu, Josh	- CONFIG_ENV_OFFSET_REDUND (optional):
4260bd83b592SWu, Josh
4261bd83b592SWu, Josh	  This setting describes a second storage area of CONFIG_ENV_SIZE
4262bd83b592SWu, Josh	  size used to hold a redundant copy of the environment data, so
4263bd83b592SWu, Josh	  that there is a valid backup copy in case there is a power failure
4264bd83b592SWu, Josh	  during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
4265bd83b592SWu, Josh	  aligned to an erase sector boundary.
4266bd83b592SWu, Josh
4267bd83b592SWu, Josh	- CONFIG_ENV_SPI_BUS (optional):
4268bd83b592SWu, Josh	- CONFIG_ENV_SPI_CS (optional):
4269bd83b592SWu, Josh
4270bd83b592SWu, Josh	  Define the SPI bus and chip select. If not defined they will be 0.
4271bd83b592SWu, Josh
4272bd83b592SWu, Josh	- CONFIG_ENV_SPI_MAX_HZ (optional):
4273bd83b592SWu, Josh
4274bd83b592SWu, Josh	  Define the SPI max work clock. If not defined then use 1MHz.
4275bd83b592SWu, Josh
4276bd83b592SWu, Josh	- CONFIG_ENV_SPI_MODE (optional):
4277bd83b592SWu, Josh
4278bd83b592SWu, Josh	  Define the SPI work mode. If not defined then use SPI_MODE_3.
4279bd83b592SWu, Josh
42800a85a9e7SLiu Gang- CONFIG_ENV_IS_IN_REMOTE:
42810a85a9e7SLiu Gang
42820a85a9e7SLiu Gang	Define this if you have a remote memory space which you
42830a85a9e7SLiu Gang	want to use for the local device's environment.
42840a85a9e7SLiu Gang
42850a85a9e7SLiu Gang	- CONFIG_ENV_ADDR:
42860a85a9e7SLiu Gang	- CONFIG_ENV_SIZE:
42870a85a9e7SLiu Gang
42880a85a9e7SLiu Gang	  These two #defines specify the address and size of the
42890a85a9e7SLiu Gang	  environment area within the remote memory space. The
42900a85a9e7SLiu Gang	  local device can get the environment from remote memory
4291fc54c7faSLiu Gang	  space by SRIO or PCIE links.
42920a85a9e7SLiu Gang
42930a85a9e7SLiu GangBE CAREFUL! For some special cases, the local device can not use
42940a85a9e7SLiu Gang"saveenv" command. For example, the local device will get the
4295fc54c7faSLiu Gangenvironment stored in a remote NOR flash by SRIO or PCIE link,
4296fc54c7faSLiu Gangbut it can not erase, write this NOR flash by SRIO or PCIE interface.
42970a85a9e7SLiu Gang
429851bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND:
429913a5695bSwdenk
430013a5695bSwdenk	Define this if you have a NAND device which you want to use
430113a5695bSwdenk	for the environment.
430213a5695bSwdenk
43030e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
43040e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
430513a5695bSwdenk
430613a5695bSwdenk	  These two #defines specify the offset and size of the environment
4307fdd813deSScott Wood	  area within the first NAND device.  CONFIG_ENV_OFFSET must be
4308fdd813deSScott Wood	  aligned to an erase block boundary.
43095779d8d9Swdenk
4310fdd813deSScott Wood	- CONFIG_ENV_OFFSET_REDUND (optional):
4311e443c944SMarkus Klotzbuecher
43120e8d1586SJean-Christophe PLAGNIOL-VILLARD	  This setting describes a second storage area of CONFIG_ENV_SIZE
4313fdd813deSScott Wood	  size used to hold a redundant copy of the environment data, so
4314fdd813deSScott Wood	  that there is a valid backup copy in case there is a power failure
4315fdd813deSScott Wood	  during a "saveenv" operation.	 CONFIG_ENV_OFFSET_RENDUND must be
4316fdd813deSScott Wood	  aligned to an erase block boundary.
4317e443c944SMarkus Klotzbuecher
4318fdd813deSScott Wood	- CONFIG_ENV_RANGE (optional):
4319fdd813deSScott Wood
4320fdd813deSScott Wood	  Specifies the length of the region in which the environment
4321fdd813deSScott Wood	  can be written.  This should be a multiple of the NAND device's
4322fdd813deSScott Wood	  block size.  Specifying a range with more erase blocks than
4323fdd813deSScott Wood	  are needed to hold CONFIG_ENV_SIZE allows bad blocks within
4324fdd813deSScott Wood	  the range to be avoided.
4325fdd813deSScott Wood
4326fdd813deSScott Wood	- CONFIG_ENV_OFFSET_OOB (optional):
4327fdd813deSScott Wood
4328fdd813deSScott Wood	  Enables support for dynamically retrieving the offset of the
4329fdd813deSScott Wood	  environment from block zero's out-of-band data.  The
4330fdd813deSScott Wood	  "nand env.oob" command can be used to record this offset.
4331fdd813deSScott Wood	  Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
4332fdd813deSScott Wood	  using CONFIG_ENV_OFFSET_OOB.
4333e443c944SMarkus Klotzbuecher
4334b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST
4335b74ab737SGuennadi Liakhovetski
4336b74ab737SGuennadi Liakhovetski	Defines address in RAM to which the nand_spl code should copy the
4337b74ab737SGuennadi Liakhovetski	environment. If redundant environment is used, it will be copied to
4338b74ab737SGuennadi Liakhovetski	CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
4339b74ab737SGuennadi Liakhovetski
43402b74433fSJoe Hershberger- CONFIG_ENV_IS_IN_UBI:
43412b74433fSJoe Hershberger
43422b74433fSJoe Hershberger	Define this if you have an UBI volume that you want to use for the
43432b74433fSJoe Hershberger	environment.  This has the benefit of wear-leveling the environment
43442b74433fSJoe Hershberger	accesses, which is important on NAND.
43452b74433fSJoe Hershberger
43462b74433fSJoe Hershberger	- CONFIG_ENV_UBI_PART:
43472b74433fSJoe Hershberger
43482b74433fSJoe Hershberger	  Define this to a string that is the mtd partition containing the UBI.
43492b74433fSJoe Hershberger
43502b74433fSJoe Hershberger	- CONFIG_ENV_UBI_VOLUME:
43512b74433fSJoe Hershberger
43522b74433fSJoe Hershberger	  Define this to the name of the volume that you want to store the
43532b74433fSJoe Hershberger	  environment in.
43542b74433fSJoe Hershberger
4355785881f7SJoe Hershberger	- CONFIG_ENV_UBI_VOLUME_REDUND:
4356785881f7SJoe Hershberger
4357785881f7SJoe Hershberger	  Define this to the name of another volume to store a second copy of
4358785881f7SJoe Hershberger	  the environment in.  This will enable redundant environments in UBI.
4359785881f7SJoe Hershberger	  It is assumed that both volumes are in the same MTD partition.
4360785881f7SJoe Hershberger
43612b74433fSJoe Hershberger	- CONFIG_UBI_SILENCE_MSG
43622b74433fSJoe Hershberger	- CONFIG_UBIFS_SILENCE_MSG
43632b74433fSJoe Hershberger
43642b74433fSJoe Hershberger	  You will probably want to define these to avoid a really noisy system
43652b74433fSJoe Hershberger	  when storing the env in UBI.
43662b74433fSJoe Hershberger
4367d1db76f1SWu, Josh- CONFIG_ENV_IS_IN_FAT:
4368d1db76f1SWu, Josh       Define this if you want to use the FAT file system for the environment.
4369d1db76f1SWu, Josh
4370d1db76f1SWu, Josh       - FAT_ENV_INTERFACE:
4371d1db76f1SWu, Josh
4372d1db76f1SWu, Josh         Define this to a string that is the name of the block device.
4373d1db76f1SWu, Josh
4374d1db76f1SWu, Josh       - FAT_ENV_DEV_AND_PART:
4375d1db76f1SWu, Josh
4376d1db76f1SWu, Josh         Define this to a string to specify the partition of the device. It can
4377d1db76f1SWu, Josh         be as following:
4378d1db76f1SWu, Josh
4379d1db76f1SWu, Josh           "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
4380d1db76f1SWu, Josh               - "D:P": device D partition P. Error occurs if device D has no
4381d1db76f1SWu, Josh                        partition table.
4382d1db76f1SWu, Josh               - "D:0": device D.
4383d1db76f1SWu, Josh               - "D" or "D:": device D partition 1 if device D has partition
4384d1db76f1SWu, Josh                              table, or the whole device D if has no partition
4385d1db76f1SWu, Josh                              table.
4386d1db76f1SWu, Josh               - "D:auto": first partition in device D with bootable flag set.
4387d1db76f1SWu, Josh                           If none, first valid paratition in device D. If no
4388d1db76f1SWu, Josh                           partition table then means device D.
4389d1db76f1SWu, Josh
4390d1db76f1SWu, Josh       - FAT_ENV_FILE:
4391d1db76f1SWu, Josh
4392d1db76f1SWu, Josh         It's a string of the FAT file name. This file use to store the
4393d1db76f1SWu, Josh         envrionment.
4394d1db76f1SWu, Josh
4395d1db76f1SWu, Josh       - CONFIG_FAT_WRITE:
4396d1db76f1SWu, Josh         This should be defined. Otherwise it cannot save the envrionment file.
4397d1db76f1SWu, Josh
439806e4ae5fSStephen Warren- CONFIG_ENV_IS_IN_MMC:
439906e4ae5fSStephen Warren
440006e4ae5fSStephen Warren	Define this if you have an MMC device which you want to use for the
440106e4ae5fSStephen Warren	environment.
440206e4ae5fSStephen Warren
440306e4ae5fSStephen Warren	- CONFIG_SYS_MMC_ENV_DEV:
440406e4ae5fSStephen Warren
440506e4ae5fSStephen Warren	  Specifies which MMC device the environment is stored in.
440606e4ae5fSStephen Warren
440706e4ae5fSStephen Warren	- CONFIG_SYS_MMC_ENV_PART (optional):
440806e4ae5fSStephen Warren
440906e4ae5fSStephen Warren	  Specifies which MMC partition the environment is stored in. If not
441006e4ae5fSStephen Warren	  set, defaults to partition 0, the user area. Common values might be
441106e4ae5fSStephen Warren	  1 (first MMC boot partition), 2 (second MMC boot partition).
441206e4ae5fSStephen Warren
441306e4ae5fSStephen Warren	- CONFIG_ENV_OFFSET:
441406e4ae5fSStephen Warren	- CONFIG_ENV_SIZE:
441506e4ae5fSStephen Warren
441606e4ae5fSStephen Warren	  These two #defines specify the offset and size of the environment
441706e4ae5fSStephen Warren	  area within the specified MMC device.
441806e4ae5fSStephen Warren
44195c088ee8SStephen Warren	  If offset is positive (the usual case), it is treated as relative to
44205c088ee8SStephen Warren	  the start of the MMC partition. If offset is negative, it is treated
44215c088ee8SStephen Warren	  as relative to the end of the MMC partition. This can be useful if
44225c088ee8SStephen Warren	  your board may be fitted with different MMC devices, which have
44235c088ee8SStephen Warren	  different sizes for the MMC partitions, and you always want the
44245c088ee8SStephen Warren	  environment placed at the very end of the partition, to leave the
44255c088ee8SStephen Warren	  maximum possible space before it, to store other data.
44265c088ee8SStephen Warren
442706e4ae5fSStephen Warren	  These two values are in units of bytes, but must be aligned to an
442806e4ae5fSStephen Warren	  MMC sector boundary.
442906e4ae5fSStephen Warren
443006e4ae5fSStephen Warren	- CONFIG_ENV_OFFSET_REDUND (optional):
443106e4ae5fSStephen Warren
443206e4ae5fSStephen Warren	  Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
443306e4ae5fSStephen Warren	  hold a redundant copy of the environment data. This provides a
443406e4ae5fSStephen Warren	  valid backup copy in case the other copy is corrupted, e.g. due
443506e4ae5fSStephen Warren	  to a power failure during a "saveenv" operation.
443606e4ae5fSStephen Warren
44375c088ee8SStephen Warren	  This value may also be positive or negative; this is handled in the
44385c088ee8SStephen Warren	  same way as CONFIG_ENV_OFFSET.
44395c088ee8SStephen Warren
444006e4ae5fSStephen Warren	  This value is also in units of bytes, but must also be aligned to
444106e4ae5fSStephen Warren	  an MMC sector boundary.
444206e4ae5fSStephen Warren
444306e4ae5fSStephen Warren	- CONFIG_ENV_SIZE_REDUND (optional):
444406e4ae5fSStephen Warren
444506e4ae5fSStephen Warren	  This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
444606e4ae5fSStephen Warren	  set. If this value is set, it must be set to the same value as
444706e4ae5fSStephen Warren	  CONFIG_ENV_SIZE.
444806e4ae5fSStephen Warren
44496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET
4450c609719bSwdenk
4451c609719bSwdenk	Defines offset to the initial SPI buffer area in DPRAM. The
4452c609719bSwdenk	area is used at an early stage (ROM part) if the environment
4453c609719bSwdenk	is configured to reside in the SPI EEPROM: We need a 520 byte
4454c609719bSwdenk	scratch DPRAM area. It is used between the two initialization
4455c609719bSwdenk	calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4456c609719bSwdenk	to be a good choice since it makes it far enough from the
4457c609719bSwdenk	start of the data area as well as from the stack pointer.
4458c609719bSwdenk
4459e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor
4460c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been
4461cdb74977SWolfgang Denkcreated; also, when using EEPROM you will have to use getenv_f()
4462c609719bSwdenkuntil then to read environment variables.
4463c609719bSwdenk
446485ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor
446585ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working
446685ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is
446785ec0bccSwdenknecessary, because the first environment variable we need is the
446885ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't
446985ec0bccSwdenkhave any device yet where we could complain.]
4470c609719bSwdenk
4471c609719bSwdenkNote: once the monitor has been relocated, then it will complain if
4472c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you
447385ec0bccSwdenkuse the "saveenv" command to store a valid environment.
4474c609719bSwdenk
44756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
4476fc3e2165Swdenk		Echo the inverted Ethernet link state to the fault LED.
4477fc3e2165Swdenk
44786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
4479fc3e2165Swdenk		      also needs to be defined.
4480fc3e2165Swdenk
44816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR:
4482fc3e2165Swdenk		MII address of the PHY to check for the Ethernet link state.
4483c609719bSwdenk
4484f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS:
4485f5675aa5SRon Madrid		Define this if you desire to only have use of the NS16550_init
4486f5675aa5SRon Madrid		and NS16550_putc functions for the serial driver located at
4487f5675aa5SRon Madrid		drivers/serial/ns16550.c.  This option is useful for saving
4488f5675aa5SRon Madrid		space for already greatly restricted images, including but not
4489f5675aa5SRon Madrid		limited to NAND_SPL configurations.
4490f5675aa5SRon Madrid
4491b2b92f53SSimon Glass- CONFIG_DISPLAY_BOARDINFO
4492b2b92f53SSimon Glass		Display information about the board that U-Boot is running on
4493b2b92f53SSimon Glass		when U-Boot starts up. The board function checkboard() is called
4494b2b92f53SSimon Glass		to do this.
4495b2b92f53SSimon Glass
4496e2e3e2b1SSimon Glass- CONFIG_DISPLAY_BOARDINFO_LATE
4497e2e3e2b1SSimon Glass		Similar to the previous option, but display this information
4498e2e3e2b1SSimon Glass		later, once stdio is running and output goes to the LCD, if
4499e2e3e2b1SSimon Glass		present.
4500e2e3e2b1SSimon Glass
4501feb85801SSascha Silbe- CONFIG_BOARD_SIZE_LIMIT:
4502feb85801SSascha Silbe		Maximum size of the U-Boot image. When defined, the
4503feb85801SSascha Silbe		build system checks that the actual size does not
4504feb85801SSascha Silbe		exceed it.
4505feb85801SSascha Silbe
4506c609719bSwdenkLow Level (hardware related) configuration options:
4507dc7c9a1aSwdenk---------------------------------------------------
4508c609719bSwdenk
45096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE:
4510c609719bSwdenk		Cache Line Size of the CPU.
4511c609719bSwdenk
45126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR:
4513c609719bSwdenk		Default address of the IMMR after system reset.
45142535d602Swdenk
45152535d602Swdenk		Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
45162535d602Swdenk		and RPXsuper) to be able to adjust the position of
45172535d602Swdenk		the IMMR register after a reset.
4518c609719bSwdenk
4519e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_DEFAULT:
4520e46fedfeSTimur Tabi		Default (power-on reset) physical address of CCSR on Freescale
4521e46fedfeSTimur Tabi		PowerPC SOCs.
4522e46fedfeSTimur Tabi
4523e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR:
4524e46fedfeSTimur Tabi		Virtual address of CCSR.  On a 32-bit build, this is typically
4525e46fedfeSTimur Tabi		the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4526e46fedfeSTimur Tabi
4527e46fedfeSTimur Tabi		CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4528e46fedfeSTimur Tabi		for cross-platform code that uses that macro instead.
4529e46fedfeSTimur Tabi
4530e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS:
4531e46fedfeSTimur Tabi		Physical address of CCSR.  CCSR can be relocated to a new
4532e46fedfeSTimur Tabi		physical address, if desired.  In this case, this macro should
4533e46fedfeSTimur Tabi		be set to that address.	 Otherwise, it should be set to the
4534e46fedfeSTimur Tabi		same value as CONFIG_SYS_CCSRBAR_DEFAULT.  For example, CCSR
4535e46fedfeSTimur Tabi		is typically relocated on 36-bit builds.  It is recommended
4536e46fedfeSTimur Tabi		that this macro be defined via the _HIGH and _LOW macros:
4537e46fedfeSTimur Tabi
4538e46fedfeSTimur Tabi		#define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4539e46fedfeSTimur Tabi			* 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4540e46fedfeSTimur Tabi
4541e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
4542e46fedfeSTimur Tabi		Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS.	This value is typically
4543e46fedfeSTimur Tabi		either 0 (32-bit build) or 0xF (36-bit build).	This macro is
4544e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
4545e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
4546e46fedfeSTimur Tabi
4547e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4548e46fedfeSTimur Tabi		Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS.  This macro is
4549e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
4550e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
4551e46fedfeSTimur Tabi
4552e46fedfeSTimur Tabi- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4553e46fedfeSTimur Tabi		If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4554e46fedfeSTimur Tabi		forced to a value that ensures that CCSR is not relocated.
4555e46fedfeSTimur Tabi
45567f6c2cbcSwdenk- Floppy Disk Support:
45576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER
45587f6c2cbcSwdenk
45597f6c2cbcSwdenk		the default drive number (default value 0)
45607f6c2cbcSwdenk
45616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_STRIDE
45627f6c2cbcSwdenk
456311ccc33fSMarcel Ziswiler		defines the spacing between FDC chipset registers
45647f6c2cbcSwdenk		(default value 1)
45657f6c2cbcSwdenk
45666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_OFFSET
45677f6c2cbcSwdenk
45687f6c2cbcSwdenk		defines the offset of register from address. It
45697f6c2cbcSwdenk		depends on which part of the data bus is connected to
457011ccc33fSMarcel Ziswiler		the FDC chipset. (default value 0)
45717f6c2cbcSwdenk
45726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
45736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
45747f6c2cbcSwdenk		default value.
45757f6c2cbcSwdenk
45766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		if CONFIG_SYS_FDC_HW_INIT is defined, then the function
45777f6c2cbcSwdenk		fdc_hw_init() is called at the beginning of the FDC
45787f6c2cbcSwdenk		setup. fdc_hw_init() must be provided by the board
45797f6c2cbcSwdenk		source code. It is used to make hardware dependant
45807f6c2cbcSwdenk		initializations.
45817f6c2cbcSwdenk
45820abddf82SMacpaul Lin- CONFIG_IDE_AHB:
45830abddf82SMacpaul Lin		Most IDE controllers were designed to be connected with PCI
45840abddf82SMacpaul Lin		interface. Only few of them were designed for AHB interface.
45850abddf82SMacpaul Lin		When software is doing ATA command and data transfer to
45860abddf82SMacpaul Lin		IDE devices through IDE-AHB controller, some additional
45870abddf82SMacpaul Lin		registers accessing to these kind of IDE-AHB controller
45880abddf82SMacpaul Lin		is requierd.
45890abddf82SMacpaul Lin
45906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR:	Physical address of the Internal Memory.
459125d6712aSwdenk		DO NOT CHANGE unless you know exactly what you're
459225d6712aSwdenk		doing! (11-4) [MPC8xx/82xx systems only]
4593c609719bSwdenk
45946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR:
4595c609719bSwdenk
45967152b1d0Swdenk		Start address of memory area that can be used for
4597c609719bSwdenk		initial data and stack; please note that this must be
4598c609719bSwdenk		writable memory that is working WITHOUT special
4599c609719bSwdenk		initialization, i. e. you CANNOT use normal RAM which
4600c609719bSwdenk		will become available only after programming the
4601c609719bSwdenk		memory controller and running certain initialization
4602c609719bSwdenk		sequences.
4603c609719bSwdenk
4604c609719bSwdenk		U-Boot uses the following memory types:
4605c609719bSwdenk		- MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4606c609719bSwdenk		- MPC824X: data cache
4607c609719bSwdenk		- PPC4xx:  data cache
4608c609719bSwdenk
46096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET:
4610c609719bSwdenk
4611c609719bSwdenk		Offset of the initial data structure in the memory
46126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
46136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
4614c609719bSwdenk		data is located at the end of the available space
4615553f0982SWolfgang Denk		(sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
46166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
46176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
46186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET) downward.
4619c609719bSwdenk
4620c609719bSwdenk	Note:
4621c609719bSwdenk		On the MPC824X (or other systems that use the data
4622c609719bSwdenk		cache for initial memory) the address chosen for
46236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
4624c609719bSwdenk		point to an otherwise UNUSED address space between
4625c609719bSwdenk		the top of RAM and the start of the PCI space.
4626c609719bSwdenk
46276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR:	SIU Module Configuration (11-6)
4628c609719bSwdenk
46296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR:	System Protection Control (11-9)
4630c609719bSwdenk
46316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR:	Time Base Status and Control (11-26)
4632c609719bSwdenk
46336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR:	Periodic Interrupt Status and Control (11-31)
4634c609719bSwdenk
46356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR:	PLL, Low-Power, and Reset Control Register (15-30)
4636c609719bSwdenk
46376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR:	System Clock and reset Control Register (15-27)
4638c609719bSwdenk
46396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM:
4640c609719bSwdenk		SDRAM timing
4641c609719bSwdenk
46426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA:
4643c609719bSwdenk		periodic timer for refresh
4644c609719bSwdenk
46456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER:	Debug Event Register (37-47)
4646c609719bSwdenk
46476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
46486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
46496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
46506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_BR1_PRELIM:
4651c609719bSwdenk		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4652c609719bSwdenk
4653c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
46546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
46556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
4656c609719bSwdenk		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4657c609719bSwdenk
46586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
46596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
4660c609719bSwdenk		Machine Mode Register and Memory Periodic Timer
4661c609719bSwdenk		Prescaler definitions (SDRAM timing)
4662c609719bSwdenk
46636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
4664c609719bSwdenk		enable I2C microcode relocation patch (MPC8xx);
4665c609719bSwdenk		define relocation offset in DPRAM [DSP2]
4666c609719bSwdenk
46676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
4668b423d055SHeiko Schocher		enable SMC microcode relocation patch (MPC8xx);
4669b423d055SHeiko Schocher		define relocation offset in DPRAM [SMC1]
4670b423d055SHeiko Schocher
46716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
4672c609719bSwdenk		enable SPI microcode relocation patch (MPC8xx);
4673c609719bSwdenk		define relocation offset in DPRAM [SCC4]
4674c609719bSwdenk
46756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_USE_OSCCLK:
4676c609719bSwdenk		Use OSCM clock mode on MBX8xx board. Be careful,
4677c609719bSwdenk		wrong setting might damage your board. Read
4678c609719bSwdenk		doc/README.MBX before setting this variable!
4679c609719bSwdenk
46806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
4681ea909b76Swdenk		Offset of the bootmode word in DPRAM used by post
4682ea909b76Swdenk		(Power On Self Tests). This definition overrides
4683ea909b76Swdenk		#define'd default value in commproc.h resp.
4684ea909b76Swdenk		cpm_8260.h.
4685ea909b76Swdenk
46866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
46876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
46886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
46896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
46906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
46916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
46926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
46936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
4694a47a12beSStefan Roese		Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
46955d232d0eSwdenk
46969cacf4fcSDirk Eibach- CONFIG_PCI_DISABLE_PCIE:
46979cacf4fcSDirk Eibach		Disable PCI-Express on systems where it is supported but not
46989cacf4fcSDirk Eibach		required.
46999cacf4fcSDirk Eibach
470069fd2d3bSAndrew Sharp- CONFIG_PCI_ENUM_ONLY
470169fd2d3bSAndrew Sharp		Only scan through and get the devices on the busses.
470269fd2d3bSAndrew Sharp		Don't do any setup work, presumably because someone or
470369fd2d3bSAndrew Sharp		something has already done it, and we don't need to do it
470469fd2d3bSAndrew Sharp		a second time.	Useful for platforms that are pre-booted
470569fd2d3bSAndrew Sharp		by coreboot or similar.
470669fd2d3bSAndrew Sharp
4707842033e6SGabor Juhos- CONFIG_PCI_INDIRECT_BRIDGE:
4708842033e6SGabor Juhos		Enable support for indirect PCI bridges.
4709842033e6SGabor Juhos
4710a09b9b68SKumar Gala- CONFIG_SYS_SRIO:
4711a09b9b68SKumar Gala		Chip has SRIO or not
4712a09b9b68SKumar Gala
4713a09b9b68SKumar Gala- CONFIG_SRIO1:
4714a09b9b68SKumar Gala		Board has SRIO 1 port available
4715a09b9b68SKumar Gala
4716a09b9b68SKumar Gala- CONFIG_SRIO2:
4717a09b9b68SKumar Gala		Board has SRIO 2 port available
4718a09b9b68SKumar Gala
4719c8b28152SLiu Gang- CONFIG_SRIO_PCIE_BOOT_MASTER
4720c8b28152SLiu Gang		Board can support master function for Boot from SRIO and PCIE
4721c8b28152SLiu Gang
4722a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_VIRT:
4723a09b9b68SKumar Gala		Virtual Address of SRIO port 'n' memory region
4724a09b9b68SKumar Gala
4725a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_PHYS:
4726a09b9b68SKumar Gala		Physical Address of SRIO port 'n' memory region
4727a09b9b68SKumar Gala
4728a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_SIZE:
4729a09b9b68SKumar Gala		Size of SRIO port 'n' memory region
4730a09b9b68SKumar Gala
473166bd1846SFabio Estevam- CONFIG_SYS_NAND_BUSWIDTH_16BIT
473266bd1846SFabio Estevam		Defined to tell the NAND controller that the NAND chip is using
473366bd1846SFabio Estevam		a 16 bit bus.
473466bd1846SFabio Estevam		Not all NAND drivers use this symbol.
4735a430e916SFabio Estevam		Example of drivers that use it:
473666bd1846SFabio Estevam		- drivers/mtd/nand/ndfc.c
4737a430e916SFabio Estevam		- drivers/mtd/nand/mxc_nand.c
4738eced4626SAlex Waterman
4739eced4626SAlex Waterman- CONFIG_SYS_NDFC_EBC0_CFG
4740eced4626SAlex Waterman		Sets the EBC0_CFG register for the NDFC. If not defined
4741eced4626SAlex Waterman		a default value will be used.
4742eced4626SAlex Waterman
4743bb99ad6dSBen Warren- CONFIG_SPD_EEPROM
4744218ca724SWolfgang Denk		Get DDR timing information from an I2C EEPROM. Common
4745218ca724SWolfgang Denk		with pluggable memory modules such as SODIMMs
4746218ca724SWolfgang Denk
4747bb99ad6dSBen Warren  SPD_EEPROM_ADDRESS
4748bb99ad6dSBen Warren		I2C address of the SPD EEPROM
4749bb99ad6dSBen Warren
47506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM
4751218ca724SWolfgang Denk		If SPD EEPROM is on an I2C bus other than the first
4752218ca724SWolfgang Denk		one, specify here. Note that the value must resolve
4753218ca724SWolfgang Denk		to something your driver can deal with.
4754bb99ad6dSBen Warren
47551b3e3c4fSYork Sun- CONFIG_SYS_DDR_RAW_TIMING
47561b3e3c4fSYork Sun		Get DDR timing information from other than SPD. Common with
47571b3e3c4fSYork Sun		soldered DDR chips onboard without SPD. DDR raw timing
47581b3e3c4fSYork Sun		parameters are extracted from datasheet and hard-coded into
47591b3e3c4fSYork Sun		header files or board specific files.
47601b3e3c4fSYork Sun
47616f5e1dc5SYork Sun- CONFIG_FSL_DDR_INTERACTIVE
47626f5e1dc5SYork Sun		Enable interactive DDR debugging. See doc/README.fsl-ddr.
47636f5e1dc5SYork Sun
47646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0
4765218ca724SWolfgang Denk		Only for 83xx systems. If specified, then DDR should
4766218ca724SWolfgang Denk		be configured using CS0 and CS1 instead of CS2 and CS3.
47672ad6b513STimur Tabi
4768c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12]
4769c26e454dSwdenk		Define to enable FEC[12] on a 8xx series processor.
4770c26e454dSwdenk
4771c26e454dSwdenk- CONFIG_FEC[12]_PHY
4772c26e454dSwdenk		Define to the hardcoded PHY address which corresponds
47736e592385Swdenk		to the given FEC; i. e.
4774c26e454dSwdenk			#define CONFIG_FEC1_PHY 4
4775c26e454dSwdenk		means that the PHY with address 4 is connected to FEC1
4776c26e454dSwdenk
4777c26e454dSwdenk		When set to -1, means to probe for first available.
4778c26e454dSwdenk
4779c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR
4780c26e454dSwdenk		The PHY does not have a RXERR line (RMII only).
4781c26e454dSwdenk		(so program the FEC to ignore it).
4782c26e454dSwdenk
4783c26e454dSwdenk- CONFIG_RMII
4784c26e454dSwdenk		Enable RMII mode for all FECs.
4785c26e454dSwdenk		Note that this is a global option, we can't
4786c26e454dSwdenk		have one FEC in standard MII mode and another in RMII mode.
4787c26e454dSwdenk
47885cf91d6bSwdenk- CONFIG_CRC32_VERIFY
47895cf91d6bSwdenk		Add a verify option to the crc32 command.
47905cf91d6bSwdenk		The syntax is:
47915cf91d6bSwdenk
47925cf91d6bSwdenk		=> crc32 -v <address> <count> <crc32>
47935cf91d6bSwdenk
47945cf91d6bSwdenk		Where address/count indicate a memory area
47955cf91d6bSwdenk		and crc32 is the correct crc32 which the
47965cf91d6bSwdenk		area should have.
47975cf91d6bSwdenk
479856523f12Swdenk- CONFIG_LOOPW
479956523f12Swdenk		Add the "loopw" memory command. This only takes effect if
4800602ad3b3SJon Loeliger		the memory commands are activated globally (CONFIG_CMD_MEM).
480156523f12Swdenk
48027b466641Sstroese- CONFIG_MX_CYCLIC
48037b466641Sstroese		Add the "mdc" and "mwc" memory commands. These are cyclic
48047b466641Sstroese		"md/mw" commands.
48057b466641Sstroese		Examples:
48067b466641Sstroese
48077b466641Sstroese		=> mdc.b 10 4 500
48087b466641Sstroese		This command will print 4 bytes (10,11,12,13) each 500 ms.
48097b466641Sstroese
48107b466641Sstroese		=> mwc.l 100 12345678 10
48117b466641Sstroese		This command will write 12345678 to address 100 all 10 ms.
48127b466641Sstroese
48137b466641Sstroese		This only takes effect if the memory commands are activated
4814602ad3b3SJon Loeliger		globally (CONFIG_CMD_MEM).
48157b466641Sstroese
48168aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT
4817afc1ce82SMacpaul Lin		[ARM, NDS32, MIPS only] If this variable is defined, then certain
4818e03f3169SWolfgang Denk		low level initializations (like setting up the memory
4819e03f3169SWolfgang Denk		controller) are omitted and/or U-Boot does not
4820e03f3169SWolfgang Denk		relocate itself into RAM.
48218aa1a2d1Swdenk
4822e03f3169SWolfgang Denk		Normally this variable MUST NOT be defined. The only
4823e03f3169SWolfgang Denk		exception is when U-Boot is loaded (to RAM) by some
4824e03f3169SWolfgang Denk		other boot loader or by a debugger which performs
4825e03f3169SWolfgang Denk		these initializations itself.
48268aa1a2d1Swdenk
4827401bb30bSAneesh V- CONFIG_SPL_BUILD
4828df81238bSMagnus Lilja		Modifies the behaviour of start.S when compiling a loader
4829df81238bSMagnus Lilja		that is executed before the actual U-Boot. E.g. when
4830df81238bSMagnus Lilja		compiling a NAND SPL.
4831400558b5Swdenk
48323aa29de0SYing Zhang- CONFIG_TPL_BUILD
48333aa29de0SYing Zhang		Modifies the behaviour of start.S  when compiling a loader
48343aa29de0SYing Zhang		that is executed after the SPL and before the actual U-Boot.
48353aa29de0SYing Zhang		It is loaded by the SPL.
48363aa29de0SYing Zhang
48375df572f0SYing Zhang- CONFIG_SYS_MPC85XX_NO_RESETVEC
48385df572f0SYing Zhang		Only for 85xx systems. If this variable is specified, the section
48395df572f0SYing Zhang		.resetvec is not kept and the section .bootpg is placed in the
48405df572f0SYing Zhang		previous 4k of the .text section.
48415df572f0SYing Zhang
48424213fc29SSimon Glass- CONFIG_ARCH_MAP_SYSMEM
48434213fc29SSimon Glass		Generally U-Boot (and in particular the md command) uses
48444213fc29SSimon Glass		effective address. It is therefore not necessary to regard
48454213fc29SSimon Glass		U-Boot address as virtual addresses that need to be translated
48464213fc29SSimon Glass		to physical addresses. However, sandbox requires this, since
48474213fc29SSimon Glass		it maintains its own little RAM buffer which contains all
48484213fc29SSimon Glass		addressable memory. This option causes some memory accesses
48494213fc29SSimon Glass		to be mapped through map_sysmem() / unmap_sysmem().
48504213fc29SSimon Glass
4851d8834a13SMatthias Weisser- CONFIG_USE_ARCH_MEMCPY
4852d8834a13SMatthias Weisser  CONFIG_USE_ARCH_MEMSET
4853d8834a13SMatthias Weisser		If these options are used a optimized version of memcpy/memset will
4854d8834a13SMatthias Weisser		be used if available. These functions may be faster under some
4855d8834a13SMatthias Weisser		conditions but may increase the binary size.
4856d8834a13SMatthias Weisser
4857588a13f7SSimon Glass- CONFIG_X86_RESET_VECTOR
4858588a13f7SSimon Glass		If defined, the x86 reset vector code is included. This is not
4859588a13f7SSimon Glass		needed when U-Boot is running from Coreboot.
4860b16f521aSGabe Black
4861fc33705eSMark Jackson- CONFIG_SYS_MPUCLK
4862fc33705eSMark Jackson		Defines the MPU clock speed (in MHz).
4863fc33705eSMark Jackson
4864fc33705eSMark Jackson		NOTE : currently only supported on AM335x platforms.
48655b5ece9eSGabe Black
486616678eb4SHeiko Schocher- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
486716678eb4SHeiko Schocher		Enables the RTC32K OSC on AM33xx based plattforms
486816678eb4SHeiko Schocher
4869999d7d32SKaricheri, Muralidharan- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
4870999d7d32SKaricheri, Muralidharan		Option to disable subpage write in NAND driver
4871999d7d32SKaricheri, Muralidharan		driver that uses this:
4872999d7d32SKaricheri, Muralidharan		drivers/mtd/nand/davinci_nand.c
4873999d7d32SKaricheri, Muralidharan
4874f2717b47STimur TabiFreescale QE/FMAN Firmware Support:
4875f2717b47STimur Tabi-----------------------------------
4876f2717b47STimur Tabi
4877f2717b47STimur TabiThe Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4878f2717b47STimur Tabiloading of "firmware", which is encoded in the QE firmware binary format.
4879f2717b47STimur TabiThis firmware often needs to be loaded during U-Boot booting, so macros
4880f2717b47STimur Tabiare used to identify the storage device (NOR flash, SPI, etc) and the address
4881f2717b47STimur Tabiwithin that device.
4882f2717b47STimur Tabi
4883dcf1d774SZhao Qiang- CONFIG_SYS_FMAN_FW_ADDR
4884dcf1d774SZhao Qiang	The address in the storage device where the FMAN microcode is located.  The
4885dcf1d774SZhao Qiang	meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4886dcf1d774SZhao Qiang	is also specified.
4887dcf1d774SZhao Qiang
4888dcf1d774SZhao Qiang- CONFIG_SYS_QE_FW_ADDR
4889dcf1d774SZhao Qiang	The address in the storage device where the QE microcode is located.  The
4890f2717b47STimur Tabi	meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4891f2717b47STimur Tabi	is also specified.
4892f2717b47STimur Tabi
4893f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_LENGTH
4894f2717b47STimur Tabi	The maximum possible size of the firmware.  The firmware binary format
4895f2717b47STimur Tabi	has a field that specifies the actual size of the firmware, but it
4896f2717b47STimur Tabi	might not be possible to read any part of the firmware unless some
4897f2717b47STimur Tabi	local storage is allocated to hold the entire firmware first.
4898f2717b47STimur Tabi
4899f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4900f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4901f2717b47STimur Tabi	normal addressable memory via the LBC.  CONFIG_SYS_FMAN_FW_ADDR is the
4902f2717b47STimur Tabi	virtual address in NOR flash.
4903f2717b47STimur Tabi
4904f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4905f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NAND flash.
4906f2717b47STimur Tabi	CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4907f2717b47STimur Tabi
4908f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4909f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SD/MMC
4910f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4911f2717b47STimur Tabi
4912f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
4913f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SPI
4914f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4915f2717b47STimur Tabi
4916292dc6c5SLiu Gang- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4917292dc6c5SLiu Gang	Specifies that QE/FMAN firmware is located in the remote (master)
4918292dc6c5SLiu Gang	memory space.	CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
4919fc54c7faSLiu Gang	can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4920fc54c7faSLiu Gang	window->master inbound window->master LAW->the ucode address in
4921fc54c7faSLiu Gang	master's memory space.
4922f2717b47STimur Tabi
4923b940ca64SJ. German RiveraFreescale Layerscape Management Complex Firmware Support:
4924b940ca64SJ. German Rivera---------------------------------------------------------
4925b940ca64SJ. German RiveraThe Freescale Layerscape Management Complex (MC) supports the loading of
4926b940ca64SJ. German Rivera"firmware".
4927b940ca64SJ. German RiveraThis firmware often needs to be loaded during U-Boot booting, so macros
4928b940ca64SJ. German Riveraare used to identify the storage device (NOR flash, SPI, etc) and the address
4929b940ca64SJ. German Riverawithin that device.
4930b940ca64SJ. German Rivera
4931b940ca64SJ. German Rivera- CONFIG_FSL_MC_ENET
4932b940ca64SJ. German Rivera	Enable the MC driver for Layerscape SoCs.
4933b940ca64SJ. German Rivera
4934b940ca64SJ. German Rivera- CONFIG_SYS_LS_MC_FW_ADDR
4935b940ca64SJ. German Rivera	The address in the storage device where the firmware is located.  The
4936b940ca64SJ. German Rivera	meaning of this address depends on which CONFIG_SYS_LS_MC_FW_IN_xxx macro
4937b940ca64SJ. German Rivera	is also specified.
4938b940ca64SJ. German Rivera
4939b940ca64SJ. German Rivera- CONFIG_SYS_LS_MC_FW_LENGTH
4940b940ca64SJ. German Rivera	The maximum possible size of the firmware.  The firmware binary format
4941b940ca64SJ. German Rivera	has a field that specifies the actual size of the firmware, but it
4942b940ca64SJ. German Rivera	might not be possible to read any part of the firmware unless some
4943b940ca64SJ. German Rivera	local storage is allocated to hold the entire firmware first.
4944b940ca64SJ. German Rivera
4945b940ca64SJ. German Rivera- CONFIG_SYS_LS_MC_FW_IN_NOR
4946b940ca64SJ. German Rivera	Specifies that MC firmware is located in NOR flash, mapped as
4947b940ca64SJ. German Rivera	normal addressable memory via the LBC. CONFIG_SYS_LS_MC_FW_ADDR is the
4948b940ca64SJ. German Rivera	virtual address in NOR flash.
4949b940ca64SJ. German Rivera
4950c609719bSwdenkBuilding the Software:
4951c609719bSwdenk======================
4952c609719bSwdenk
4953218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments
4954218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support
4955218ca724SWolfgang Denkall possibly existing versions of cross development tools in all
4956218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we
4957218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4958218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot.
4959c609719bSwdenk
4960218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you
4961218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case,
4962218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell.
4963218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are
4964218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter:
4965c609719bSwdenk
4966218ca724SWolfgang Denk	$ CROSS_COMPILE=ppc_4xx-
4967218ca724SWolfgang Denk	$ export CROSS_COMPILE
4968c609719bSwdenk
49692f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in
49702f8d396bSPeter Tyser      the tools directory you can use the MinGW toolchain
49712f8d396bSPeter Tyser      (http://www.mingw.org).  Set your HOST tools to the MinGW
49722f8d396bSPeter Tyser      toolchain and execute 'make tools'.  For example:
49732f8d396bSPeter Tyser
49742f8d396bSPeter Tyser       $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
49752f8d396bSPeter Tyser
49762f8d396bSPeter Tyser      Binaries such as tools/mkimage.exe will be created which can
49772f8d396bSPeter Tyser      be executed on computers running Windows.
49782f8d396bSPeter Tyser
4979c609719bSwdenkU-Boot is intended to be simple to build. After installing the
4980c609719bSwdenksources you must configure U-Boot for one specific board type. This
4981c609719bSwdenkis done by typing:
4982c609719bSwdenk
4983ab584d67SHolger Freyther	make NAME_defconfig
4984c609719bSwdenk
4985ab584d67SHolger Freytherwhere "NAME_defconfig" is the name of one of the existing configu-
49864d675ae6SMichael Jonesrations; see boards.cfg for supported names.
498754387ac9Swdenk
4988c609719bSwdenkNote: for some board special configuration names may exist; check if
4989c609719bSwdenk      additional information is available from the board vendor; for
49902729af9dSwdenk      instance, the TQM823L systems are available without (standard)
49912729af9dSwdenk      or with LCD support. You can select such additional "features"
499211ccc33fSMarcel Ziswiler      when choosing the configuration, i. e.
4993c609719bSwdenk
4994ab584d67SHolger Freyther      make TQM823L_defconfig
49952729af9dSwdenk	- will configure for a plain TQM823L, i. e. no LCD support
4996c609719bSwdenk
4997ab584d67SHolger Freyther      make TQM823L_LCD_defconfig
4998c609719bSwdenk	- will configure for a TQM823L with U-Boot console on LCD
4999c609719bSwdenk
5000c609719bSwdenk      etc.
5001c609719bSwdenk
5002c609719bSwdenk
5003c609719bSwdenkFinally, type "make all", and you should get some working U-Boot
50047152b1d0Swdenkimages ready for download to / installation on your system:
5005c609719bSwdenk
5006c609719bSwdenk- "u-boot.bin" is a raw binary image
5007c609719bSwdenk- "u-boot" is an image in ELF binary format
5008c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format
5009c609719bSwdenk
5010baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved
5011baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change
5012baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory:
5013baf31249SMarian Balakowicz
5014baf31249SMarian Balakowicz1. Add O= to the make command line invocations:
5015baf31249SMarian Balakowicz
5016baf31249SMarian Balakowicz	make O=/tmp/build distclean
5017ab584d67SHolger Freyther	make O=/tmp/build NAME_defconfig
5018baf31249SMarian Balakowicz	make O=/tmp/build all
5019baf31249SMarian Balakowicz
5020adbba996STimo Ketola2. Set environment variable KBUILD_OUTPUT to point to the desired location:
5021baf31249SMarian Balakowicz
5022adbba996STimo Ketola	export KBUILD_OUTPUT=/tmp/build
5023baf31249SMarian Balakowicz	make distclean
5024ab584d67SHolger Freyther	make NAME_defconfig
5025baf31249SMarian Balakowicz	make all
5026baf31249SMarian Balakowicz
5027adbba996STimo KetolaNote that the command line "O=" setting overrides the KBUILD_OUTPUT environment
5028baf31249SMarian Balakowiczvariable.
5029baf31249SMarian Balakowicz
5030c609719bSwdenk
5031c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so
5032c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of
5033c609719bSwdenknative "make".
5034c609719bSwdenk
5035c609719bSwdenk
5036c609719bSwdenkIf the system board that you have is not listed, then you will need
5037c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these
5038c609719bSwdenksteps:
5039c609719bSwdenk
5040c609719bSwdenk1.  Add a new configuration option for your board to the toplevel
50414d675ae6SMichael Jones    "boards.cfg" file, using the existing entries as examples.
50424d675ae6SMichael Jones    Follow the instructions there to keep the boards in order.
5043c609719bSwdenk2.  Create a new directory to hold your board specific code. Add any
504485ec0bccSwdenk    files you need. In your board directory, you will need at least
504585ec0bccSwdenk    the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
504685ec0bccSwdenk3.  Create a new configuration file "include/configs/<board>.h" for
504785ec0bccSwdenk    your board
5048c609719bSwdenk3.  If you're porting U-Boot to a new CPU, then also create a new
5049c609719bSwdenk    directory to hold your CPU specific code. Add any files you need.
5050ab584d67SHolger Freyther4.  Run "make <board>_defconfig" with your new name.
5051c609719bSwdenk5.  Type "make", and you should get a working "u-boot.srec" file
5052c609719bSwdenk    to be installed on your target system.
505385ec0bccSwdenk6.  Debug and solve any problems that might arise.
5054c609719bSwdenk    [Of course, this last step is much harder than it sounds.]
5055c609719bSwdenk
5056c609719bSwdenk
5057c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.:
5058c609719bSwdenk==============================================================
5059c609719bSwdenk
5060c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board
5061c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to
5062c609719bSwdenkprovide feedback to the other developers. The feedback normally takes
5063c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest
5064218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources.
5065c609719bSwdenk
5066c609719bSwdenkBut before you submit such a patch, please verify that your modifi-
5067c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of
5068c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so,
5069c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot
5070c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You can
50717152b1d0Swdenkselect which (cross) compiler to use by passing a `CROSS_COMPILE'
5072218ca724SWolfgang Denkenvironment variable to the script, i. e. to use the ELDK cross tools
5073218ca724SWolfgang Denkyou can type
5074c609719bSwdenk
5075c609719bSwdenk	CROSS_COMPILE=ppc_8xx- MAKEALL
5076c609719bSwdenk
5077c609719bSwdenkor to build on a native PowerPC system you can type
5078c609719bSwdenk
5079c609719bSwdenk	CROSS_COMPILE=' ' MAKEALL
5080c609719bSwdenk
5081218ca724SWolfgang DenkWhen using the MAKEALL script, the default behaviour is to build
5082218ca724SWolfgang DenkU-Boot in the source directory. This location can be changed by
5083218ca724SWolfgang Denksetting the BUILD_DIR environment variable. Also, for each target
5084218ca724SWolfgang Denkbuilt, the MAKEALL script saves two log files (<target>.ERR and
5085218ca724SWolfgang Denk<target>.MAKEALL) in the <source dir>/LOG directory. This default
5086218ca724SWolfgang Denklocation can be changed by setting the MAKEALL_LOGDIR environment
5087218ca724SWolfgang Denkvariable. For example:
5088baf31249SMarian Balakowicz
5089baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
5090baf31249SMarian Balakowicz	export MAKEALL_LOGDIR=/tmp/log
5091baf31249SMarian Balakowicz	CROSS_COMPILE=ppc_8xx- MAKEALL
5092baf31249SMarian Balakowicz
5093218ca724SWolfgang DenkWith the above settings build objects are saved in the /tmp/build,
5094218ca724SWolfgang Denklog files are saved in the /tmp/log and the source tree remains clean
5095218ca724SWolfgang Denkduring the whole build process.
5096baf31249SMarian Balakowicz
5097baf31249SMarian Balakowicz
5098c609719bSwdenkSee also "U-Boot Porting Guide" below.
5099c609719bSwdenk
5100c609719bSwdenk
5101c609719bSwdenkMonitor Commands - Overview:
5102c609719bSwdenk============================
5103c609719bSwdenk
5104c609719bSwdenkgo	- start application at address 'addr'
5105c609719bSwdenkrun	- run commands in an environment variable
5106c609719bSwdenkbootm	- boot application image from memory
5107c609719bSwdenkbootp	- boot image via network using BootP/TFTP protocol
510844f074c7SMarek Vasutbootz   - boot zImage from memory
5109c609719bSwdenktftpboot- boot image via network using TFTP protocol
5110c609719bSwdenk	       and env variables "ipaddr" and "serverip"
5111c609719bSwdenk	       (and eventually "gatewayip")
51121fb7cd49SSimon Glasstftpput - upload a file via network using TFTP protocol
5113c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol
5114c609719bSwdenkdiskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
5115c609719bSwdenkloads	- load S-Record file over serial line
5116c609719bSwdenkloadb	- load binary file over serial line (kermit mode)
5117c609719bSwdenkmd	- memory display
5118c609719bSwdenkmm	- memory modify (auto-incrementing)
5119c609719bSwdenknm	- memory modify (constant address)
5120c609719bSwdenkmw	- memory write (fill)
5121c609719bSwdenkcp	- memory copy
5122c609719bSwdenkcmp	- memory compare
5123c609719bSwdenkcrc32	- checksum calculation
51240f89c54bSPeter Tyseri2c	- I2C sub-system
5125c609719bSwdenksspi	- SPI utility commands
5126c609719bSwdenkbase	- print or set address offset
5127c609719bSwdenkprintenv- print environment variables
5128c609719bSwdenksetenv	- set environment variables
5129c609719bSwdenksaveenv - save environment variables to persistent storage
5130c609719bSwdenkprotect - enable or disable FLASH write protection
5131c609719bSwdenkerase	- erase FLASH memory
5132c609719bSwdenkflinfo	- print FLASH memory information
513310635afaSKarl O. Pincnand	- NAND memory operations (see doc/README.nand)
5134c609719bSwdenkbdinfo	- print Board Info structure
5135c609719bSwdenkiminfo	- print header information for application image
5136c609719bSwdenkconinfo - print console devices and informations
5137c609719bSwdenkide	- IDE sub-system
5138c609719bSwdenkloop	- infinite loop on address range
513956523f12Swdenkloopw	- infinite write loop on address range
5140c609719bSwdenkmtest	- simple RAM test
5141c609719bSwdenkicache	- enable or disable instruction cache
5142c609719bSwdenkdcache	- enable or disable data cache
5143c609719bSwdenkreset	- Perform RESET of the CPU
5144c609719bSwdenkecho	- echo args to console
5145c609719bSwdenkversion - print monitor version
5146c609719bSwdenkhelp	- print online help
5147c609719bSwdenk?	- alias for 'help'
5148c609719bSwdenk
5149c609719bSwdenk
5150c609719bSwdenkMonitor Commands - Detailed Description:
5151c609719bSwdenk========================================
5152c609719bSwdenk
5153c609719bSwdenkTODO.
5154c609719bSwdenk
5155c609719bSwdenkFor now: just type "help <command>".
5156c609719bSwdenk
5157c609719bSwdenk
5158c609719bSwdenkEnvironment Variables:
5159c609719bSwdenk======================
5160c609719bSwdenk
5161c609719bSwdenkU-Boot supports user configuration using Environment Variables which
5162c609719bSwdenkcan be made persistent by saving to Flash memory.
5163c609719bSwdenk
5164c609719bSwdenkEnvironment Variables are set using "setenv", printed using
5165c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv"
5166c609719bSwdenkwithout a value can be used to delete a variable from the
5167c609719bSwdenkenvironment. As long as you don't save the environment you are
5168c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the
5169c609719bSwdenkenvironment is erased by accident, a default environment is provided.
5170c609719bSwdenk
5171c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables.
5172c96f86eeSWolfgang Denk
5173c96f86eeSWolfgang DenkList of environment variables (most likely not complete):
5174c609719bSwdenk
5175c609719bSwdenk  baudrate	- see CONFIG_BAUDRATE
5176c609719bSwdenk
5177c609719bSwdenk  bootdelay	- see CONFIG_BOOTDELAY
5178c609719bSwdenk
5179c609719bSwdenk  bootcmd	- see CONFIG_BOOTCOMMAND
5180c609719bSwdenk
5181c609719bSwdenk  bootargs	- Boot arguments when booting an RTOS image
5182c609719bSwdenk
5183c609719bSwdenk  bootfile	- Name of the image to load with TFTP
5184c609719bSwdenk
51857d721e34SBartlomiej Sieka  bootm_low	- Memory range available for image processing in the bootm
51867d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
51877d721e34SBartlomiej Sieka		  a hexadecimal number and defines lowest address allowed
51887d721e34SBartlomiej Sieka		  for use by the bootm command. See also "bootm_size"
51897d721e34SBartlomiej Sieka		  environment variable. Address defined by "bootm_low" is
51907d721e34SBartlomiej Sieka		  also the base of the initial memory mapping for the Linux
5191c3624e6eSGrant Likely		  kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
5192c3624e6eSGrant Likely		  bootm_mapsize.
5193c3624e6eSGrant Likely
5194c3624e6eSGrant Likely  bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
5195c3624e6eSGrant Likely		  This variable is given as a hexadecimal number and it
5196c3624e6eSGrant Likely		  defines the size of the memory region starting at base
5197c3624e6eSGrant Likely		  address bootm_low that is accessible by the Linux kernel
5198c3624e6eSGrant Likely		  during early boot.  If unset, CONFIG_SYS_BOOTMAPSZ is used
5199c3624e6eSGrant Likely		  as the default value if it is defined, and bootm_size is
5200c3624e6eSGrant Likely		  used otherwise.
52017d721e34SBartlomiej Sieka
52027d721e34SBartlomiej Sieka  bootm_size	- Memory range available for image processing in the bootm
52037d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
52047d721e34SBartlomiej Sieka		  a hexadecimal number and defines the size of the region
52057d721e34SBartlomiej Sieka		  allowed for use by the bootm command. See also "bootm_low"
52067d721e34SBartlomiej Sieka		  environment variable.
52077d721e34SBartlomiej Sieka
52084bae9090SBartlomiej Sieka  updatefile	- Location of the software update file on a TFTP server, used
52094bae9090SBartlomiej Sieka		  by the automatic software update feature. Please refer to
52104bae9090SBartlomiej Sieka		  documentation in doc/README.update for more details.
52114bae9090SBartlomiej Sieka
5212c609719bSwdenk  autoload	- if set to "no" (any string beginning with 'n'),
5213c609719bSwdenk		  "bootp" will just load perform a lookup of the
5214c609719bSwdenk		  configuration from the BOOTP server, but not try to
5215c609719bSwdenk		  load any image using TFTP
5216c609719bSwdenk
5217c609719bSwdenk  autostart	- if set to "yes", an image loaded using the "bootp",
5218c609719bSwdenk		  "rarpboot", "tftpboot" or "diskboot" commands will
5219c609719bSwdenk		  be automatically started (by internally calling
5220c609719bSwdenk		  "bootm")
5221c609719bSwdenk
52224a6fd34bSwdenk		  If set to "no", a standalone image passed to the
52234a6fd34bSwdenk		  "bootm" command will be copied to the load address
52244a6fd34bSwdenk		  (and eventually uncompressed), but NOT be started.
52254a6fd34bSwdenk		  This can be used to load and uncompress arbitrary
52264a6fd34bSwdenk		  data.
52274a6fd34bSwdenk
5228a28afca5SDavid A. Long  fdt_high	- if set this restricts the maximum address that the
5229a28afca5SDavid A. Long		  flattened device tree will be copied into upon boot.
5230fa34f6b2SShawn Guo		  For example, if you have a system with 1 GB memory
5231fa34f6b2SShawn Guo		  at physical address 0x10000000, while Linux kernel
5232fa34f6b2SShawn Guo		  only recognizes the first 704 MB as low memory, you
5233fa34f6b2SShawn Guo		  may need to set fdt_high as 0x3C000000 to have the
5234fa34f6b2SShawn Guo		  device tree blob be copied to the maximum address
5235fa34f6b2SShawn Guo		  of the 704 MB low memory, so that Linux kernel can
5236fa34f6b2SShawn Guo		  access it during the boot procedure.
5237fa34f6b2SShawn Guo
5238a28afca5SDavid A. Long		  If this is set to the special value 0xFFFFFFFF then
5239a28afca5SDavid A. Long		  the fdt will not be copied at all on boot.  For this
5240a28afca5SDavid A. Long		  to work it must reside in writable memory, have
5241a28afca5SDavid A. Long		  sufficient padding on the end of it for u-boot to
5242a28afca5SDavid A. Long		  add the information it needs into it, and the memory
5243a28afca5SDavid A. Long		  must be accessible by the kernel.
5244a28afca5SDavid A. Long
5245eea63e05SSimon Glass  fdtcontroladdr- if set this is the address of the control flattened
5246eea63e05SSimon Glass		  device tree used by U-Boot when CONFIG_OF_CONTROL is
5247eea63e05SSimon Glass		  defined.
5248eea63e05SSimon Glass
524917ea1177Swdenk  i2cfast	- (PPC405GP|PPC405EP only)
525017ea1177Swdenk		  if set to 'y' configures Linux I2C driver for fast
525117ea1177Swdenk		  mode (400kHZ). This environment variable is used in
525217ea1177Swdenk		  initialization code. So, for changes to be effective
525317ea1177Swdenk		  it must be saved and board must be reset.
525417ea1177Swdenk
5255c609719bSwdenk  initrd_high	- restrict positioning of initrd images:
5256c609719bSwdenk		  If this variable is not set, initrd images will be
5257c609719bSwdenk		  copied to the highest possible address in RAM; this
5258c609719bSwdenk		  is usually what you want since it allows for
5259c609719bSwdenk		  maximum initrd size. If for some reason you want to
5260c609719bSwdenk		  make sure that the initrd image is loaded below the
52616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		  CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
5262c609719bSwdenk		  variable to a value of "no" or "off" or "0".
5263c609719bSwdenk		  Alternatively, you can set it to a maximum upper
5264c609719bSwdenk		  address to use (U-Boot will still check that it
5265c609719bSwdenk		  does not overwrite the U-Boot stack and data).
5266c609719bSwdenk
5267c609719bSwdenk		  For instance, when you have a system with 16 MB
52687152b1d0Swdenk		  RAM, and want to reserve 4 MB from use by Linux,
5269c609719bSwdenk		  you can do this by adding "mem=12M" to the value of
5270c609719bSwdenk		  the "bootargs" variable. However, now you must make
52717152b1d0Swdenk		  sure that the initrd image is placed in the first
5272c609719bSwdenk		  12 MB as well - this can be done with
5273c609719bSwdenk
5274c609719bSwdenk		  setenv initrd_high 00c00000
5275c609719bSwdenk
527638b99261Swdenk		  If you set initrd_high to 0xFFFFFFFF, this is an
527738b99261Swdenk		  indication to U-Boot that all addresses are legal
527838b99261Swdenk		  for the Linux kernel, including addresses in flash
527938b99261Swdenk		  memory. In this case U-Boot will NOT COPY the
528038b99261Swdenk		  ramdisk at all. This may be useful to reduce the
528138b99261Swdenk		  boot time on your system, but requires that this
528238b99261Swdenk		  feature is supported by your Linux kernel.
528338b99261Swdenk
5284c609719bSwdenk  ipaddr	- IP address; needed for tftpboot command
5285c609719bSwdenk
5286c609719bSwdenk  loadaddr	- Default load address for commands like "bootp",
5287dc7c9a1aSwdenk		  "rarpboot", "tftpboot", "loadb" or "diskboot"
5288c609719bSwdenk
5289c609719bSwdenk  loads_echo	- see CONFIG_LOADS_ECHO
5290c609719bSwdenk
5291c609719bSwdenk  serverip	- TFTP server IP address; needed for tftpboot command
5292c609719bSwdenk
5293c609719bSwdenk  bootretry	- see CONFIG_BOOT_RETRY_TIME
5294c609719bSwdenk
5295c609719bSwdenk  bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
5296c609719bSwdenk
5297c609719bSwdenk  bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
5298c609719bSwdenk
5299e2a53458SMike Frysinger  ethprime	- controls which interface is used first.
5300a3d991bdSwdenk
5301e2a53458SMike Frysinger  ethact	- controls which interface is currently active.
5302e2a53458SMike Frysinger		  For example you can do the following
5303a3d991bdSwdenk
530448690d80SHeiko Schocher		  => setenv ethact FEC
530548690d80SHeiko Schocher		  => ping 192.168.0.1 # traffic sent on FEC
530648690d80SHeiko Schocher		  => setenv ethact SCC
530748690d80SHeiko Schocher		  => ping 10.0.0.1 # traffic sent on SCC
5308a3d991bdSwdenk
5309e1692577SMatthias Fuchs  ethrotate	- When set to "no" U-Boot does not go through all
5310e1692577SMatthias Fuchs		  available network interfaces.
5311e1692577SMatthias Fuchs		  It just stays at the currently selected interface.
5312e1692577SMatthias Fuchs
5313a3d991bdSwdenk  netretry	- When set to "no" each network operation will
5314a3d991bdSwdenk		  either succeed or fail without retrying.
53156e592385Swdenk		  When set to "once" the network operation will
53166e592385Swdenk		  fail when all the available network interfaces
53176e592385Swdenk		  are tried once without success.
5318a3d991bdSwdenk		  Useful on scripts which control the retry operation
5319a3d991bdSwdenk		  themselves.
5320a3d991bdSwdenk
5321b4e2f89dSJean-Christophe PLAGNIOL-VILLARD  npe_ucode	- set load address for the NPE microcode
5322a1cf027aSJean-Christophe PLAGNIOL-VILLARD
53238d51aacdSSimon Glass  silent_linux  - If set then linux will be told to boot silently, by
53248d51aacdSSimon Glass		  changing the console to be empty. If "yes" it will be
53258d51aacdSSimon Glass		  made silent. If "no" it will not be made silent. If
53268d51aacdSSimon Glass		  unset, then it will be made silent if the U-Boot console
53278d51aacdSSimon Glass		  is silent.
53288d51aacdSSimon Glass
532928cb9375SWolfgang Denk  tftpsrcport	- If this is set, the value is used for TFTP's
5330ecb0ccd9SWolfgang Denk		  UDP source port.
5331ecb0ccd9SWolfgang Denk
533228cb9375SWolfgang Denk  tftpdstport	- If this is set, the value is used for TFTP's UDP
533328cb9375SWolfgang Denk		  destination port instead of the Well Know Port 69.
533428cb9375SWolfgang Denk
5335c96f86eeSWolfgang Denk  tftpblocksize - Block size to use for TFTP transfers; if not set,
5336c96f86eeSWolfgang Denk		  we use the TFTP server's default block size
5337c96f86eeSWolfgang Denk
5338c96f86eeSWolfgang Denk  tftptimeout	- Retransmission timeout for TFTP packets (in milli-
5339c96f86eeSWolfgang Denk		  seconds, minimum value is 1000 = 1 second). Defines
5340c96f86eeSWolfgang Denk		  when a packet is considered to be lost so it has to
5341c96f86eeSWolfgang Denk		  be retransmitted. The default is 5000 = 5 seconds.
5342c96f86eeSWolfgang Denk		  Lowering this value may make downloads succeed
5343c96f86eeSWolfgang Denk		  faster in networks with high packet loss rates or
5344c96f86eeSWolfgang Denk		  with unreliable TFTP servers.
5345c96f86eeSWolfgang Denk
5346a3d991bdSwdenk  vlan		- When set to a value < 4095 the traffic over
534711ccc33fSMarcel Ziswiler		  Ethernet is encapsulated/received over 802.1q
5348a3d991bdSwdenk		  VLAN tagged frames.
5349c609719bSwdenk
5350dc0b7b0eSJason HobbsThe following image location variables contain the location of images
5351dc0b7b0eSJason Hobbsused in booting. The "Image" column gives the role of the image and is
5352dc0b7b0eSJason Hobbsnot an environment variable name. The other columns are environment
5353dc0b7b0eSJason Hobbsvariable names. "File Name" gives the name of the file on a TFTP
5354dc0b7b0eSJason Hobbsserver, "RAM Address" gives the location in RAM the image will be
5355dc0b7b0eSJason Hobbsloaded to, and "Flash Location" gives the image's address in NOR
5356dc0b7b0eSJason Hobbsflash or offset in NAND flash.
5357dc0b7b0eSJason Hobbs
5358dc0b7b0eSJason Hobbs*Note* - these variables don't have to be defined for all boards, some
5359dc0b7b0eSJason Hobbsboards currenlty use other variables for these purposes, and some
5360dc0b7b0eSJason Hobbsboards use these variables for other purposes.
5361dc0b7b0eSJason Hobbs
5362dc0b7b0eSJason HobbsImage		    File Name	     RAM Address       Flash Location
5363dc0b7b0eSJason Hobbs-----		    ---------	     -----------       --------------
5364dc0b7b0eSJason Hobbsu-boot		    u-boot	     u-boot_addr_r     u-boot_addr
5365dc0b7b0eSJason HobbsLinux kernel	    bootfile	     kernel_addr_r     kernel_addr
5366dc0b7b0eSJason Hobbsdevice tree blob    fdtfile	     fdt_addr_r	       fdt_addr
5367dc0b7b0eSJason Hobbsramdisk		    ramdiskfile	     ramdisk_addr_r    ramdisk_addr
5368dc0b7b0eSJason Hobbs
5369c609719bSwdenkThe following environment variables may be used and automatically
5370c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"),
5371c609719bSwdenkdepending the information provided by your boot server:
5372c609719bSwdenk
5373c609719bSwdenk  bootfile	- see above
5374c609719bSwdenk  dnsip		- IP address of your Domain Name Server
5375fe389a82Sstroese  dnsip2	- IP address of your secondary Domain Name Server
5376c609719bSwdenk  gatewayip	- IP address of the Gateway (Router) to use
5377c609719bSwdenk  hostname	- Target hostname
5378c609719bSwdenk  ipaddr	- see above
5379c609719bSwdenk  netmask	- Subnet Mask
5380c609719bSwdenk  rootpath	- Pathname of the root filesystem on the NFS server
5381c609719bSwdenk  serverip	- see above
5382c609719bSwdenk
5383c609719bSwdenk
5384c609719bSwdenkThere are two special Environment Variables:
5385c609719bSwdenk
5386c609719bSwdenk  serial#	- contains hardware identification information such
5387c609719bSwdenk		  as type string and/or serial number
5388c609719bSwdenk  ethaddr	- Ethernet address
5389c609719bSwdenk
5390c609719bSwdenkThese variables can be set only once (usually during manufacturing of
5391c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables
5392c609719bSwdenkonce they have been set once.
5393c609719bSwdenk
5394c609719bSwdenk
5395c1551ea8SstroeseFurther special Environment Variables:
5396c1551ea8Sstroese
5397c1551ea8Sstroese  ver		- Contains the U-Boot version string as printed
5398c1551ea8Sstroese		  with the "version" command. This variable is
5399c1551ea8Sstroese		  readonly (see CONFIG_VERSION_VARIABLE).
5400c1551ea8Sstroese
5401c1551ea8Sstroese
5402c609719bSwdenkPlease note that changes to some configuration parameters may take
5403c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-).
5404c609719bSwdenk
5405c609719bSwdenk
5406170ab110SJoe HershbergerCallback functions for environment variables:
5407170ab110SJoe Hershberger---------------------------------------------
5408170ab110SJoe Hershberger
5409170ab110SJoe HershbergerFor some environment variables, the behavior of u-boot needs to change
5410170ab110SJoe Hershbergerwhen their values are changed.  This functionailty allows functions to
5411170ab110SJoe Hershbergerbe associated with arbitrary variables.  On creation, overwrite, or
5412170ab110SJoe Hershbergerdeletion, the callback will provide the opportunity for some side
5413170ab110SJoe Hershbergereffect to happen or for the change to be rejected.
5414170ab110SJoe Hershberger
5415170ab110SJoe HershbergerThe callbacks are named and associated with a function using the
5416170ab110SJoe HershbergerU_BOOT_ENV_CALLBACK macro in your board or driver code.
5417170ab110SJoe Hershberger
5418170ab110SJoe HershbergerThese callbacks are associated with variables in one of two ways.  The
5419170ab110SJoe Hershbergerstatic list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
5420170ab110SJoe Hershbergerin the board configuration to a string that defines a list of
5421170ab110SJoe Hershbergerassociations.  The list must be in the following format:
5422170ab110SJoe Hershberger
5423170ab110SJoe Hershberger	entry = variable_name[:callback_name]
5424170ab110SJoe Hershberger	list = entry[,list]
5425170ab110SJoe Hershberger
5426170ab110SJoe HershbergerIf the callback name is not specified, then the callback is deleted.
5427170ab110SJoe HershbergerSpaces are also allowed anywhere in the list.
5428170ab110SJoe Hershberger
5429170ab110SJoe HershbergerCallbacks can also be associated by defining the ".callbacks" variable
5430170ab110SJoe Hershbergerwith the same list format above.  Any association in ".callbacks" will
5431170ab110SJoe Hershbergeroverride any association in the static list. You can define
5432170ab110SJoe HershbergerCONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
5433170ab110SJoe Hershberger".callbacks" envirnoment variable in the default or embedded environment.
5434170ab110SJoe Hershberger
5435170ab110SJoe Hershberger
5436f07771ccSwdenkCommand Line Parsing:
5437f07771ccSwdenk=====================
5438f07771ccSwdenk
5439f07771ccSwdenkThere are two different command line parsers available with U-Boot:
54407152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell:
5441f07771ccSwdenk
5442f07771ccSwdenkOld, simple command line parser:
5443f07771ccSwdenk--------------------------------
5444f07771ccSwdenk
5445f07771ccSwdenk- supports environment variables (through setenv / saveenv commands)
5446f07771ccSwdenk- several commands on one line, separated by ';'
5447fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax
5448f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\',
5449f07771ccSwdenk  for example:
5450fe126d8bSWolfgang Denk	setenv bootcmd bootm \${address}
5451f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example:
5452f07771ccSwdenk	setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
5453f07771ccSwdenk
5454f07771ccSwdenkHush shell:
5455f07771ccSwdenk-----------
5456f07771ccSwdenk
5457f07771ccSwdenk- similar to Bourne shell, with control structures like
5458f07771ccSwdenk  if...then...else...fi, for...do...done; while...do...done,
5459f07771ccSwdenk  until...do...done, ...
5460f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv
5461f07771ccSwdenk  commands) and local shell variables (through standard shell syntax
5462f07771ccSwdenk  "name=value"); only environment variables can be used with "run"
5463f07771ccSwdenk  command
5464f07771ccSwdenk
5465f07771ccSwdenkGeneral rules:
5466f07771ccSwdenk--------------
5467f07771ccSwdenk
5468f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run"
5469f07771ccSwdenk    command) contains several commands separated by semicolon, and
5470f07771ccSwdenk    one of these commands fails, then the remaining commands will be
5471f07771ccSwdenk    executed anyway.
5472f07771ccSwdenk
5473f07771ccSwdenk(2) If you execute several variables with one call to run (i. e.
547411ccc33fSMarcel Ziswiler    calling run with a list of variables as arguments), any failing
5475f07771ccSwdenk    command will cause "run" to terminate, i. e. the remaining
5476f07771ccSwdenk    variables are not executed.
5477f07771ccSwdenk
5478c609719bSwdenkNote for Redundant Ethernet Interfaces:
5479c609719bSwdenk=======================================
5480c609719bSwdenk
548111ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports
5482c609719bSwdenksuch configurations and is capable of automatic selection of a
54837152b1d0Swdenk"working" interface when needed. MAC assignment works as follows:
5484c609719bSwdenk
5485c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding
5486c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0),
5487c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ...
5488c609719bSwdenk
5489c609719bSwdenkIf the network interface stores some valid MAC address (for instance
5490c609719bSwdenkin SROM), this is used as default address if there is NO correspon-
5491c609719bSwdenkding setting in the environment; if the corresponding environment
5492c609719bSwdenkvariable is set, this overrides the settings in the card; that means:
5493c609719bSwdenk
5494c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the
5495c609719bSwdenk  environment, the SROM's address is used.
5496c609719bSwdenk
5497c609719bSwdenko If there is no valid address in the SROM, and a definition in the
5498c609719bSwdenk  environment exists, then the value from the environment variable is
5499c609719bSwdenk  used.
5500c609719bSwdenk
5501c609719bSwdenko If both the SROM and the environment contain a MAC address, and
5502c609719bSwdenk  both addresses are the same, this MAC address is used.
5503c609719bSwdenk
5504c609719bSwdenko If both the SROM and the environment contain a MAC address, and the
5505c609719bSwdenk  addresses differ, the value from the environment is used and a
5506c609719bSwdenk  warning is printed.
5507c609719bSwdenk
5508c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error
5509c609719bSwdenk  is raised.
5510c609719bSwdenk
5511ecee9324SBen WarrenIf Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
5512ecee9324SBen Warrenwill be programmed into hardware as part of the initialization process.	 This
5513ecee9324SBen Warrenmay be skipped by setting the appropriate 'ethmacskip' environment variable.
5514ecee9324SBen WarrenThe naming convention is as follows:
5515ecee9324SBen Warren"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
5516c609719bSwdenk
5517c609719bSwdenkImage Formats:
5518c609719bSwdenk==============
5519c609719bSwdenk
55203310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on)
55213310c549SMarian Balakowiczimages in two formats:
55223310c549SMarian Balakowicz
55233310c549SMarian BalakowiczNew uImage format (FIT)
55243310c549SMarian Balakowicz-----------------------
55253310c549SMarian Balakowicz
55263310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar
55273310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple
55283310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by
55293310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
55303310c549SMarian Balakowicz
55313310c549SMarian Balakowicz
55323310c549SMarian BalakowiczOld uImage format
55333310c549SMarian Balakowicz-----------------
55343310c549SMarian Balakowicz
55353310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything,
55363310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for
55373310c549SMarian Balakowiczdetails; basically, the header defines the following image properties:
5538c609719bSwdenk
5539c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5540c609719bSwdenk  4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
5541f5ed9e39SPeter Tyser  LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5542f5ed9e39SPeter Tyser  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5543f5ed9e39SPeter Tyser  INTEGRITY).
55447b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
5545afc1ce82SMacpaul Lin  IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5546afc1ce82SMacpaul Lin  Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
5547c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2)
5548c609719bSwdenk* Load Address
5549c609719bSwdenk* Entry Point
5550c609719bSwdenk* Image Name
5551c609719bSwdenk* Image Timestamp
5552c609719bSwdenk
5553c609719bSwdenkThe header is marked by a special Magic Number, and both the header
5554c609719bSwdenkand the data portions of the image are secured against corruption by
5555c609719bSwdenkCRC32 checksums.
5556c609719bSwdenk
5557c609719bSwdenk
5558c609719bSwdenkLinux Support:
5559c609719bSwdenk==============
5560c609719bSwdenk
5561c609719bSwdenkAlthough U-Boot should support any OS or standalone application
55627152b1d0Swdenkeasily, the main focus has always been on Linux during the design of
5563c609719bSwdenkU-Boot.
5564c609719bSwdenk
5565c609719bSwdenkU-Boot includes many features that so far have been part of some
5566c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any
5567c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image;
5568c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation
55697152b1d0Swdenkserves several purposes:
5570c609719bSwdenk
5571c609719bSwdenk- the same features can be used for other OS or standalone
5572c609719bSwdenk  applications (for instance: using compressed images to reduce the
5573c609719bSwdenk  Flash memory footprint)
5574c609719bSwdenk
5575c609719bSwdenk- it becomes much easier to port new Linux kernel versions because
55767152b1d0Swdenk  lots of low-level, hardware dependent stuff are done by U-Boot
5577c609719bSwdenk
5578c609719bSwdenk- the same Linux kernel image can now be used with different "initrd"
5579c609719bSwdenk  images; of course this also means that different kernel images can
5580c609719bSwdenk  be run with the same "initrd". This makes testing easier (you don't
5581c609719bSwdenk  have to build a new "zImage.initrd" Linux image when you just
5582c609719bSwdenk  change a file in your "initrd"). Also, a field-upgrade of the
5583c609719bSwdenk  software is easier now.
5584c609719bSwdenk
5585c609719bSwdenk
5586c609719bSwdenkLinux HOWTO:
5587c609719bSwdenk============
5588c609719bSwdenk
5589c609719bSwdenkPorting Linux to U-Boot based systems:
5590c609719bSwdenk---------------------------------------
5591c609719bSwdenk
5592c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to
5593c609719bSwdenkconfigure the Linux device drivers for use with your target hardware
5594c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to
5595c609719bSwdenkLinux :-).
5596c609719bSwdenk
5597a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
5598c609719bSwdenk
5599c609719bSwdenkJust make sure your machine specific header file (for instance
5600c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board
56011dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h,
56021dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value
56036d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR.
5604c609719bSwdenk
56052eb31b13SSimon GlassNote that U-Boot now has a driver model, a unified model for drivers.
56062eb31b13SSimon GlassIf you are adding a new driver, plumb it into driver model. If there
56072eb31b13SSimon Glassis no uclass available, you are encouraged to create one. See
56082eb31b13SSimon Glassdoc/driver-model.
56092eb31b13SSimon Glass
5610c609719bSwdenk
5611c609719bSwdenkConfiguring the Linux kernel:
5612c609719bSwdenk-----------------------------
5613c609719bSwdenk
5614c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root
5615c609719bSwdenkdevice (initial ramdisk, NFS) for your target system.
5616c609719bSwdenk
5617c609719bSwdenk
5618c609719bSwdenkBuilding a Linux Image:
5619c609719bSwdenk-----------------------
5620c609719bSwdenk
562124ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are
562224ee89b9Swdenknot used. If you use recent kernel source, a new build target
562324ee89b9Swdenk"uImage" will exist which automatically builds an image usable by
562424ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target,
562524ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a
562624ee89b9Swdenk100% compatible format.
5627c609719bSwdenk
5628c609719bSwdenkExample:
5629c609719bSwdenk
5630ab584d67SHolger Freyther	make TQM850L_defconfig
5631c609719bSwdenk	make oldconfig
5632c609719bSwdenk	make dep
563324ee89b9Swdenk	make uImage
5634c609719bSwdenk
563524ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to
563624ee89b9Swdenkencapsulate a compressed Linux kernel image with header	 information,
563724ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing:
5638c609719bSwdenk
563924ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format):
564024ee89b9Swdenk
564124ee89b9Swdenk* convert the kernel into a raw binary image:
564224ee89b9Swdenk
564324ee89b9Swdenk	${CROSS_COMPILE}-objcopy -O binary \
564424ee89b9Swdenk				 -R .note -R .comment \
564524ee89b9Swdenk				 -S vmlinux linux.bin
564624ee89b9Swdenk
564724ee89b9Swdenk* compress the binary image:
564824ee89b9Swdenk
564924ee89b9Swdenk	gzip -9 linux.bin
565024ee89b9Swdenk
565124ee89b9Swdenk* package compressed binary image for U-Boot:
565224ee89b9Swdenk
565324ee89b9Swdenk	mkimage -A ppc -O linux -T kernel -C gzip \
565424ee89b9Swdenk		-a 0 -e 0 -n "Linux Kernel Image" \
565524ee89b9Swdenk		-d linux.bin.gz uImage
565624ee89b9Swdenk
565724ee89b9Swdenk
565824ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use
565924ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or
566024ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64
566124ee89b9Swdenkbyte header containing information about target architecture,
566224ee89b9Swdenkoperating system, image type, compression method, entry points, time
566324ee89b9Swdenkstamp, CRC32 checksums, etc.
566424ee89b9Swdenk
566524ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and
566624ee89b9Swdenkprint the header information, or to build new images.
5667c609719bSwdenk
5668c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information
5669c609719bSwdenkcontained in the header of an existing U-Boot image; this includes
5670c609719bSwdenkchecksum verification:
5671c609719bSwdenk
5672c609719bSwdenk	tools/mkimage -l image
5673c609719bSwdenk	  -l ==> list image header information
5674c609719bSwdenk
5675c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image
5676c609719bSwdenkfrom a "data file" which is used as image payload:
5677c609719bSwdenk
5678c609719bSwdenk	tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5679c609719bSwdenk		      -n name -d data_file image
5680c609719bSwdenk	  -A ==> set architecture to 'arch'
5681c609719bSwdenk	  -O ==> set operating system to 'os'
5682c609719bSwdenk	  -T ==> set image type to 'type'
5683c609719bSwdenk	  -C ==> set compression type 'comp'
5684c609719bSwdenk	  -a ==> set load address to 'addr' (hex)
5685c609719bSwdenk	  -e ==> set entry point to 'ep' (hex)
5686c609719bSwdenk	  -n ==> set image name to 'name'
5687c609719bSwdenk	  -d ==> use image data from 'datafile'
5688c609719bSwdenk
568969459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load
569069459791Swdenkaddress (0x00000000), but the entry point address depends on the
569169459791Swdenkkernel version:
5692c609719bSwdenk
5693c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C,
569424ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000.
5695c609719bSwdenk
5696c609719bSwdenkSo a typical call to build a U-Boot image would read:
5697c609719bSwdenk
569824ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
569924ee89b9Swdenk	> -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
5700a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
570124ee89b9Swdenk	> examples/uImage.TQM850L
570224ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5703c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5704c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
5705c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
5706c609719bSwdenk	Load Address: 0x00000000
570724ee89b9Swdenk	Entry Point:  0x00000000
5708c609719bSwdenk
5709c609719bSwdenkTo verify the contents of the image (or check for corruption):
5710c609719bSwdenk
571124ee89b9Swdenk	-> tools/mkimage -l examples/uImage.TQM850L
571224ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5713c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5714c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
5715c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
5716c609719bSwdenk	Load Address: 0x00000000
571724ee89b9Swdenk	Entry Point:  0x00000000
5718c609719bSwdenk
5719c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade
5720c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this
5721c609719bSwdenkneeds more space in Flash, but boots much faster since it does not
5722c609719bSwdenkneed to be uncompressed:
5723c609719bSwdenk
5724a47a12beSStefan Roese	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
572524ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
572624ee89b9Swdenk	> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
5727a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
572824ee89b9Swdenk	> examples/uImage.TQM850L-uncompressed
572924ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5730c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5731c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (uncompressed)
5732c609719bSwdenk	Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
5733c609719bSwdenk	Load Address: 0x00000000
573424ee89b9Swdenk	Entry Point:  0x00000000
5735c609719bSwdenk
5736c609719bSwdenk
5737c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file
5738c609719bSwdenkwhen your kernel is intended to use an initial ramdisk:
5739c609719bSwdenk
5740c609719bSwdenk	-> tools/mkimage -n 'Simple Ramdisk Image' \
5741c609719bSwdenk	> -A ppc -O linux -T ramdisk -C gzip \
5742c609719bSwdenk	> -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5743c609719bSwdenk	Image Name:   Simple Ramdisk Image
5744c609719bSwdenk	Created:      Wed Jan 12 14:01:50 2000
5745c609719bSwdenk	Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
5746c609719bSwdenk	Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
5747c609719bSwdenk	Load Address: 0x00000000
5748c609719bSwdenk	Entry Point:  0x00000000
5749c609719bSwdenk
5750a804b5ceSGuilherme Maciel FerreiraThe "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5751a804b5ceSGuilherme Maciel Ferreiraoption performs the converse operation of the mkimage's second form (the "-d"
5752a804b5ceSGuilherme Maciel Ferreiraoption). Given an image built by mkimage, the dumpimage extracts a "data file"
5753a804b5ceSGuilherme Maciel Ferreirafrom the image:
5754a804b5ceSGuilherme Maciel Ferreira
5755a804b5ceSGuilherme Maciel Ferreira	tools/dumpimage -i image -p position data_file
5756a804b5ceSGuilherme Maciel Ferreira	  -i ==> extract from the 'image' a specific 'data_file', \
5757a804b5ceSGuilherme Maciel Ferreira	   indexed by 'position'
5758a804b5ceSGuilherme Maciel Ferreira
5759c609719bSwdenk
5760c609719bSwdenkInstalling a Linux Image:
5761c609719bSwdenk-------------------------
5762c609719bSwdenk
5763c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface,
5764c609719bSwdenkyou must convert the image to S-Record format:
5765c609719bSwdenk
5766c609719bSwdenk	objcopy -I binary -O srec examples/image examples/image.srec
5767c609719bSwdenk
5768c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot
5769c609719bSwdenkimage header, so the resulting S-Record file will be relative to
5770c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to
5771c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads'
5772c609719bSwdenkcommand.
5773c609719bSwdenk
5774c609719bSwdenkExample: install the image to address 0x40100000 (which on the
5775c609719bSwdenkTQM8xxL is in the first Flash bank):
5776c609719bSwdenk
5777c609719bSwdenk	=> erase 40100000 401FFFFF
5778c609719bSwdenk
5779c609719bSwdenk	.......... done
5780c609719bSwdenk	Erased 8 sectors
5781c609719bSwdenk
5782c609719bSwdenk	=> loads 40100000
5783c609719bSwdenk	## Ready for S-Record download ...
5784c609719bSwdenk	~>examples/image.srec
5785c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5786c609719bSwdenk	...
5787c609719bSwdenk	15989 15990 15991 15992
5788c609719bSwdenk	[file transfer complete]
5789c609719bSwdenk	[connected]
5790c609719bSwdenk	## Start Addr = 0x00000000
5791c609719bSwdenk
5792c609719bSwdenk
5793c609719bSwdenkYou can check the success of the download using the 'iminfo' command;
5794c609719bSwdenkthis includes a checksum verification so you can be sure no data
5795c609719bSwdenkcorruption happened:
5796c609719bSwdenk
5797c609719bSwdenk	=> imi 40100000
5798c609719bSwdenk
5799c609719bSwdenk	## Checking Image at 40100000 ...
5800c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5801c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5802c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5803c609719bSwdenk	   Load Address: 00000000
5804c609719bSwdenk	   Entry Point:	 0000000c
5805c609719bSwdenk	   Verifying Checksum ... OK
5806c609719bSwdenk
5807c609719bSwdenk
5808c609719bSwdenkBoot Linux:
5809c609719bSwdenk-----------
5810c609719bSwdenk
5811c609719bSwdenkThe "bootm" command is used to boot an application that is stored in
5812c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents
5813c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as
5814c609719bSwdenkparameters. You can check and modify this variable using the
5815c609719bSwdenk"printenv" and "setenv" commands:
5816c609719bSwdenk
5817c609719bSwdenk
5818c609719bSwdenk	=> printenv bootargs
5819c609719bSwdenk	bootargs=root=/dev/ram
5820c609719bSwdenk
5821c609719bSwdenk	=> setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5822c609719bSwdenk
5823c609719bSwdenk	=> printenv bootargs
5824c609719bSwdenk	bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5825c609719bSwdenk
5826c609719bSwdenk	=> bootm 40020000
5827c609719bSwdenk	## Booting Linux kernel at 40020000 ...
5828c609719bSwdenk	   Image Name:	 2.2.13 for NFS on TQM850L
5829c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5830c609719bSwdenk	   Data Size:	 381681 Bytes = 372 kB = 0 MB
5831c609719bSwdenk	   Load Address: 00000000
5832c609719bSwdenk	   Entry Point:	 0000000c
5833c609719bSwdenk	   Verifying Checksum ... OK
5834c609719bSwdenk	   Uncompressing Kernel Image ... OK
5835c609719bSwdenk	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
5836c609719bSwdenk	Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5837c609719bSwdenk	time_init: decrementer frequency = 187500000/60
5838c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
5839c609719bSwdenk	Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5840c609719bSwdenk	...
5841c609719bSwdenk
584211ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass
58437152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT
5844c609719bSwdenkformat!) to the "bootm" command:
5845c609719bSwdenk
5846c609719bSwdenk	=> imi 40100000 40200000
5847c609719bSwdenk
5848c609719bSwdenk	## Checking Image at 40100000 ...
5849c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5850c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5851c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5852c609719bSwdenk	   Load Address: 00000000
5853c609719bSwdenk	   Entry Point:	 0000000c
5854c609719bSwdenk	   Verifying Checksum ... OK
5855c609719bSwdenk
5856c609719bSwdenk	## Checking Image at 40200000 ...
5857c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
5858c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
5859c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
5860c609719bSwdenk	   Load Address: 00000000
5861c609719bSwdenk	   Entry Point:	 00000000
5862c609719bSwdenk	   Verifying Checksum ... OK
5863c609719bSwdenk
5864c609719bSwdenk	=> bootm 40100000 40200000
5865c609719bSwdenk	## Booting Linux kernel at 40100000 ...
5866c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5867c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5868c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5869c609719bSwdenk	   Load Address: 00000000
5870c609719bSwdenk	   Entry Point:	 0000000c
5871c609719bSwdenk	   Verifying Checksum ... OK
5872c609719bSwdenk	   Uncompressing Kernel Image ... OK
5873c609719bSwdenk	## Loading RAMDisk Image at 40200000 ...
5874c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
5875c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
5876c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
5877c609719bSwdenk	   Load Address: 00000000
5878c609719bSwdenk	   Entry Point:	 00000000
5879c609719bSwdenk	   Verifying Checksum ... OK
5880c609719bSwdenk	   Loading Ramdisk ... OK
5881c609719bSwdenk	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
5882c609719bSwdenk	Boot arguments: root=/dev/ram
5883c609719bSwdenk	time_init: decrementer frequency = 187500000/60
5884c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
5885c609719bSwdenk	...
5886c609719bSwdenk	RAMDISK: Compressed image found at block 0
5887c609719bSwdenk	VFS: Mounted root (ext2 filesystem).
5888c609719bSwdenk
5889c609719bSwdenk	bash#
5890c609719bSwdenk
58910267768eSMatthew McClintockBoot Linux and pass a flat device tree:
58920267768eSMatthew McClintock-----------
58930267768eSMatthew McClintock
58940267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section
58950267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The
58960267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated
58970267768eSMatthew McClintockflat device tree:
58980267768eSMatthew McClintock
58990267768eSMatthew McClintock=> print oftaddr
59000267768eSMatthew McClintockoftaddr=0x300000
59010267768eSMatthew McClintock=> print oft
59020267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb
59030267768eSMatthew McClintock=> tftp $oftaddr $oft
59040267768eSMatthew McClintockSpeed: 1000, full duplex
59050267768eSMatthew McClintockUsing TSEC0 device
59060267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101
59070267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'.
59080267768eSMatthew McClintockLoad address: 0x300000
59090267768eSMatthew McClintockLoading: #
59100267768eSMatthew McClintockdone
59110267768eSMatthew McClintockBytes transferred = 4106 (100a hex)
59120267768eSMatthew McClintock=> tftp $loadaddr $bootfile
59130267768eSMatthew McClintockSpeed: 1000, full duplex
59140267768eSMatthew McClintockUsing TSEC0 device
59150267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2
59160267768eSMatthew McClintockFilename 'uImage'.
59170267768eSMatthew McClintockLoad address: 0x200000
59180267768eSMatthew McClintockLoading:############
59190267768eSMatthew McClintockdone
59200267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex)
59210267768eSMatthew McClintock=> print loadaddr
59220267768eSMatthew McClintockloadaddr=200000
59230267768eSMatthew McClintock=> print oftaddr
59240267768eSMatthew McClintockoftaddr=0x300000
59250267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr
59260267768eSMatthew McClintock## Booting image at 00200000 ...
59270267768eSMatthew McClintock   Image Name:	 Linux-2.6.17-dirty
59280267768eSMatthew McClintock   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
59290267768eSMatthew McClintock   Data Size:	 1029343 Bytes = 1005.2 kB
59300267768eSMatthew McClintock   Load Address: 00000000
59310267768eSMatthew McClintock   Entry Point:	 00000000
59320267768eSMatthew McClintock   Verifying Checksum ... OK
59330267768eSMatthew McClintock   Uncompressing Kernel Image ... OK
59340267768eSMatthew McClintockBooting using flat device tree at 0x300000
59350267768eSMatthew McClintockUsing MPC85xx ADS machine description
59360267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
59370267768eSMatthew McClintock[snip]
59380267768eSMatthew McClintock
59390267768eSMatthew McClintock
59406069ff26SwdenkMore About U-Boot Image Types:
59416069ff26Swdenk------------------------------
59426069ff26Swdenk
59436069ff26SwdenkU-Boot supports the following image types:
59446069ff26Swdenk
59456069ff26Swdenk   "Standalone Programs" are directly runnable in the environment
59466069ff26Swdenk	provided by U-Boot; it is expected that (if they behave
59476069ff26Swdenk	well) you can continue to work in U-Boot after return from
59486069ff26Swdenk	the Standalone Program.
59496069ff26Swdenk   "OS Kernel Images" are usually images of some Embedded OS which
59506069ff26Swdenk	will take over control completely. Usually these programs
59516069ff26Swdenk	will install their own set of exception handlers, device
59526069ff26Swdenk	drivers, set up the MMU, etc. - this means, that you cannot
59536069ff26Swdenk	expect to re-enter U-Boot except by resetting the CPU.
59546069ff26Swdenk   "RAMDisk Images" are more or less just data blocks, and their
59556069ff26Swdenk	parameters (address, size) are passed to an OS kernel that is
59566069ff26Swdenk	being started.
59576069ff26Swdenk   "Multi-File Images" contain several images, typically an OS
59586069ff26Swdenk	(Linux) kernel image and one or more data images like
59596069ff26Swdenk	RAMDisks. This construct is useful for instance when you want
59606069ff26Swdenk	to boot over the network using BOOTP etc., where the boot
59616069ff26Swdenk	server provides just a single image file, but you want to get
59626069ff26Swdenk	for instance an OS kernel and a RAMDisk image.
59636069ff26Swdenk
59646069ff26Swdenk	"Multi-File Images" start with a list of image sizes, each
59656069ff26Swdenk	image size (in bytes) specified by an "uint32_t" in network
59666069ff26Swdenk	byte order. This list is terminated by an "(uint32_t)0".
59676069ff26Swdenk	Immediately after the terminating 0 follow the images, one by
59686069ff26Swdenk	one, all aligned on "uint32_t" boundaries (size rounded up to
59696069ff26Swdenk	a multiple of 4 bytes).
59706069ff26Swdenk
59716069ff26Swdenk   "Firmware Images" are binary images containing firmware (like
59726069ff26Swdenk	U-Boot or FPGA images) which usually will be programmed to
59736069ff26Swdenk	flash memory.
59746069ff26Swdenk
59756069ff26Swdenk   "Script files" are command sequences that will be executed by
59766069ff26Swdenk	U-Boot's command interpreter; this feature is especially
59776069ff26Swdenk	useful when you configure U-Boot to use a real shell (hush)
59786069ff26Swdenk	as command interpreter.
59796069ff26Swdenk
598044f074c7SMarek VasutBooting the Linux zImage:
598144f074c7SMarek Vasut-------------------------
598244f074c7SMarek Vasut
598344f074c7SMarek VasutOn some platforms, it's possible to boot Linux zImage. This is done
598444f074c7SMarek Vasutusing the "bootz" command. The syntax of "bootz" command is the same
598544f074c7SMarek Vasutas the syntax of "bootm" command.
598644f074c7SMarek Vasut
59878ac28563STom RiniNote, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
5988017e1f3fSMarek Vasutkernel with raw initrd images. The syntax is slightly different, the
5989017e1f3fSMarek Vasutaddress of the initrd must be augmented by it's size, in the following
5990017e1f3fSMarek Vasutformat: "<initrd addres>:<initrd size>".
5991017e1f3fSMarek Vasut
5992c609719bSwdenk
5993c609719bSwdenkStandalone HOWTO:
5994c609719bSwdenk=================
5995c609719bSwdenk
5996c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and
5997c609719bSwdenkrun "standalone" applications, which can use some resources of
5998c609719bSwdenkU-Boot like console I/O functions or interrupt services.
5999c609719bSwdenk
6000c609719bSwdenkTwo simple examples are included with the sources:
6001c609719bSwdenk
6002c609719bSwdenk"Hello World" Demo:
6003c609719bSwdenk-------------------
6004c609719bSwdenk
6005c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo
6006c609719bSwdenkapplication; it is automatically compiled when you build U-Boot.
6007c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it
6008c609719bSwdenklike that:
6009c609719bSwdenk
6010c609719bSwdenk	=> loads
6011c609719bSwdenk	## Ready for S-Record download ...
6012c609719bSwdenk	~>examples/hello_world.srec
6013c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
6014c609719bSwdenk	[file transfer complete]
6015c609719bSwdenk	[connected]
6016c609719bSwdenk	## Start Addr = 0x00040004
6017c609719bSwdenk
6018c609719bSwdenk	=> go 40004 Hello World! This is a test.
6019c609719bSwdenk	## Starting application at 0x00040004 ...
6020c609719bSwdenk	Hello World
6021c609719bSwdenk	argc = 7
6022c609719bSwdenk	argv[0] = "40004"
6023c609719bSwdenk	argv[1] = "Hello"
6024c609719bSwdenk	argv[2] = "World!"
6025c609719bSwdenk	argv[3] = "This"
6026c609719bSwdenk	argv[4] = "is"
6027c609719bSwdenk	argv[5] = "a"
6028c609719bSwdenk	argv[6] = "test."
6029c609719bSwdenk	argv[7] = "<NULL>"
6030c609719bSwdenk	Hit any key to exit ...
6031c609719bSwdenk
6032c609719bSwdenk	## Application terminated, rc = 0x0
6033c609719bSwdenk
6034c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt
6035c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'.
6036c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second.
6037c609719bSwdenkThe interrupt service routine is trivial, just printing a '.'
6038c609719bSwdenkcharacter, but this is just a demo program. The application can be
6039c609719bSwdenkcontrolled by the following keys:
6040c609719bSwdenk
6041c609719bSwdenk	? - print current values og the CPM Timer registers
6042c609719bSwdenk	b - enable interrupts and start timer
6043c609719bSwdenk	e - stop timer and disable interrupts
6044c609719bSwdenk	q - quit application
6045c609719bSwdenk
6046c609719bSwdenk	=> loads
6047c609719bSwdenk	## Ready for S-Record download ...
6048c609719bSwdenk	~>examples/timer.srec
6049c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
6050c609719bSwdenk	[file transfer complete]
6051c609719bSwdenk	[connected]
6052c609719bSwdenk	## Start Addr = 0x00040004
6053c609719bSwdenk
6054c609719bSwdenk	=> go 40004
6055c609719bSwdenk	## Starting application at 0x00040004 ...
6056c609719bSwdenk	TIMERS=0xfff00980
6057c609719bSwdenk	Using timer 1
6058c609719bSwdenk	  tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
6059c609719bSwdenk
6060c609719bSwdenkHit 'b':
6061c609719bSwdenk	[q, b, e, ?] Set interval 1000000 us
6062c609719bSwdenk	Enabling timer
6063c609719bSwdenkHit '?':
6064c609719bSwdenk	[q, b, e, ?] ........
6065c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
6066c609719bSwdenkHit '?':
6067c609719bSwdenk	[q, b, e, ?] .
6068c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
6069c609719bSwdenkHit '?':
6070c609719bSwdenk	[q, b, e, ?] .
6071c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
6072c609719bSwdenkHit '?':
6073c609719bSwdenk	[q, b, e, ?] .
6074c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
6075c609719bSwdenkHit 'e':
6076c609719bSwdenk	[q, b, e, ?] ...Stopping timer
6077c609719bSwdenkHit 'q':
6078c609719bSwdenk	[q, b, e, ?] ## Application terminated, rc = 0x0
6079c609719bSwdenk
6080c609719bSwdenk
608185ec0bccSwdenkMinicom warning:
608285ec0bccSwdenk================
608385ec0bccSwdenk
60847152b1d0SwdenkOver time, many people have reported problems when trying to use the
608585ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd)
608685ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under
6087f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and
608885ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and
6089e53515a2SKarl O. Pincuse "cu" for S-Record download ("loads" command).  See
6090e53515a2SKarl O. Pinchttp://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
6091e53515a2SKarl O. Pincfor help with kermit.
6092e53515a2SKarl O. Pinc
609385ec0bccSwdenk
609452f52c14SwdenkNevertheless, if you absolutely want to use it try adding this
609552f52c14Swdenkconfiguration to your "File transfer protocols" section:
609652f52c14Swdenk
609752f52c14Swdenk	   Name	   Program			Name U/D FullScr IO-Red. Multi
609852f52c14Swdenk	X  kermit  /usr/bin/kermit -i -l %l -s	 Y    U	   Y	   N	  N
609952f52c14Swdenk	Y  kermit  /usr/bin/kermit -i -l %l -r	 N    D	   Y	   N	  N
610052f52c14Swdenk
610152f52c14Swdenk
6102c609719bSwdenkNetBSD Notes:
6103c609719bSwdenk=============
6104c609719bSwdenk
6105c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host
6106c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx).
6107c609719bSwdenk
6108c609719bSwdenkBuilding requires a cross environment; it is known to work on
6109c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
6110c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make).
6111c609719bSwdenkNote that the cross-powerpc package does not install include files;
6112c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is
6113c609719bSwdenkmissing.  This file has to be installed and patched manually:
6114c609719bSwdenk
6115c609719bSwdenk	# cd /usr/pkg/cross/powerpc-netbsd/include
6116c609719bSwdenk	# mkdir powerpc
6117c609719bSwdenk	# ln -s powerpc machine
6118c609719bSwdenk	# cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
6119c609719bSwdenk	# ${EDIT} powerpc/ansi.h	## must remove __va_list, _BSD_VA_LIST
6120c609719bSwdenk
6121c609719bSwdenkNative builds *don't* work due to incompatibilities between native
6122c609719bSwdenkand U-Boot include files.
6123c609719bSwdenk
6124c609719bSwdenkBooting assumes that (the first part of) the image booted is a
6125c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel
6126c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source
6127c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
61282a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
6129c609719bSwdenk
6130c609719bSwdenk
6131c609719bSwdenkImplementation Internals:
6132c609719bSwdenk=========================
6133c609719bSwdenk
6134c609719bSwdenkThe following is not intended to be a complete description of every
6135c609719bSwdenkimplementation detail. However, it should help to understand the
6136c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom
6137c609719bSwdenkhardware.
6138c609719bSwdenk
6139c609719bSwdenk
6140c609719bSwdenkInitial Stack, Global Data:
6141c609719bSwdenk---------------------------
6142c609719bSwdenk
6143c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot
6144c609719bSwdenkstarts running out of ROM (flash memory), usually without access to
6145c609719bSwdenksystem RAM (because the memory controller is not initialized yet).
6146c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS
6147c609719bSwdenkis not initialized as zero. To be able to get a C environment working
6148c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation
6149c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU
6150c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and
6151c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be
6152c609719bSwdenklocked as (mis-) used as memory, etc.
6153c609719bSwdenk
61547152b1d0Swdenk	Chris Hallinan posted a good summary of these issues to the
61550668236bSWolfgang Denk	U-Boot mailing list:
615643d9616cSwdenk
615743d9616cSwdenk	Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
615843d9616cSwdenk	From: "Chris Hallinan" <clh@net1plus.com>
615943d9616cSwdenk	Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
616043d9616cSwdenk	...
616143d9616cSwdenk
616243d9616cSwdenk	Correct me if I'm wrong, folks, but the way I understand it
616343d9616cSwdenk	is this: Using DCACHE as initial RAM for Stack, etc, does not
616443d9616cSwdenk	require any physical RAM backing up the cache. The cleverness
616543d9616cSwdenk	is that the cache is being used as a temporary supply of
616643d9616cSwdenk	necessary storage before the SDRAM controller is setup. It's
616711ccc33fSMarcel Ziswiler	beyond the scope of this list to explain the details, but you
616843d9616cSwdenk	can see how this works by studying the cache architecture and
616943d9616cSwdenk	operation in the architecture and processor-specific manuals.
617043d9616cSwdenk
617143d9616cSwdenk	OCM is On Chip Memory, which I believe the 405GP has 4K. It
617243d9616cSwdenk	is another option for the system designer to use as an
617311ccc33fSMarcel Ziswiler	initial stack/RAM area prior to SDRAM being available. Either
617443d9616cSwdenk	option should work for you. Using CS 4 should be fine if your
617543d9616cSwdenk	board designers haven't used it for something that would
617643d9616cSwdenk	cause you grief during the initial boot! It is frequently not
617743d9616cSwdenk	used.
617843d9616cSwdenk
61796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
618043d9616cSwdenk	with your processor/board/system design. The default value
618143d9616cSwdenk	you will find in any recent u-boot distribution in
61828a316c9bSStefan Roese	walnut.h should work for you. I'd set it to a value larger
618343d9616cSwdenk	than your SDRAM module. If you have a 64MB SDRAM module, set
618443d9616cSwdenk	it above 400_0000. Just make sure your board has no resources
618543d9616cSwdenk	that are supposed to respond to that address! That code in
618643d9616cSwdenk	start.S has been around a while and should work as is when
618743d9616cSwdenk	you get the config right.
618843d9616cSwdenk
618943d9616cSwdenk	-Chris Hallinan
619043d9616cSwdenk	DS4.COM, Inc.
619143d9616cSwdenk
6192c609719bSwdenkIt is essential to remember this, since it has some impact on the C
6193c609719bSwdenkcode for the initialization procedures:
6194c609719bSwdenk
6195c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt
6196c609719bSwdenk  to write it.
6197c609719bSwdenk
619811ccc33fSMarcel Ziswiler* Do not use any uninitialized global data (or implicitely initialized
6199c609719bSwdenk  as zero data - BSS segment) at all - this is undefined, initiali-
62007152b1d0Swdenk  zation is performed later (when relocating to RAM).
6201c609719bSwdenk
6202c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like
6203c609719bSwdenk  that.
6204c609719bSwdenk
6205c609719bSwdenkHaving only the stack as writable memory limits means we cannot use
6206c609719bSwdenknormal global data to share information beween the code. But it
6207c609719bSwdenkturned out that the implementation of U-Boot can be greatly
6208c609719bSwdenksimplified by making a global data structure (gd_t) available to all
6209c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_
6210c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of
6211c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we
6212c609719bSwdenkplace a pointer (gd) to the global data into a register which we
6213c609719bSwdenkreserve for this purpose.
6214c609719bSwdenk
62157152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the
6216c609719bSwdenkrelevant  (E)ABI  specifications for the current architecture, and by
6217c609719bSwdenkGCC's implementation.
6218c609719bSwdenk
6219c609719bSwdenkFor PowerPC, the following registers have specific use:
6220c609719bSwdenk	R1:	stack pointer
6221e7670f6cSWolfgang Denk	R2:	reserved for system use
6222c609719bSwdenk	R3-R4:	parameter passing and return values
6223c609719bSwdenk	R5-R10: parameter passing
6224c609719bSwdenk	R13:	small data area pointer
6225c609719bSwdenk	R30:	GOT pointer
6226c609719bSwdenk	R31:	frame pointer
6227c609719bSwdenk
6228e6bee808SJoakim Tjernlund	(U-Boot also uses R12 as internal GOT pointer. r12
6229e6bee808SJoakim Tjernlund	is a volatile register so r12 needs to be reset when
6230e6bee808SJoakim Tjernlund	going back and forth between asm and C)
6231c609719bSwdenk
6232e7670f6cSWolfgang Denk    ==> U-Boot will use R2 to hold a pointer to the global data
6233c609719bSwdenk
6234c609719bSwdenk    Note: on PPC, we could use a static initializer (since the
6235c609719bSwdenk    address of the global data structure is known at compile time),
6236c609719bSwdenk    but it turned out that reserving a register results in somewhat
6237c609719bSwdenk    smaller code - although the code savings are not that big (on
6238c609719bSwdenk    average for all boards 752 bytes for the whole U-Boot image,
6239c609719bSwdenk    624 text + 127 data).
6240c609719bSwdenk
6241c4db335cSRobin GetzOn Blackfin, the normal C ABI (except for P3) is followed as documented here:
62424c58eb55SMike Frysinger	http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
62434c58eb55SMike Frysinger
6244c4db335cSRobin Getz    ==> U-Boot will use P3 to hold a pointer to the global data
62454c58eb55SMike Frysinger
6246c609719bSwdenkOn ARM, the following registers are used:
6247c609719bSwdenk
6248c609719bSwdenk	R0:	function argument word/integer result
6249c609719bSwdenk	R1-R3:	function argument word
625012eba1b4SJeroen Hofstee	R9:	platform specific
625112eba1b4SJeroen Hofstee	R10:	stack limit (used only if stack checking is enabled)
6252c609719bSwdenk	R11:	argument (frame) pointer
6253c609719bSwdenk	R12:	temporary workspace
6254c609719bSwdenk	R13:	stack pointer
6255c609719bSwdenk	R14:	link register
6256c609719bSwdenk	R15:	program counter
6257c609719bSwdenk
625812eba1b4SJeroen Hofstee    ==> U-Boot will use R9 to hold a pointer to the global data
625912eba1b4SJeroen Hofstee
626012eba1b4SJeroen Hofstee    Note: on ARM, only R_ARM_RELATIVE relocations are supported.
6261c609719bSwdenk
62620df01fd3SThomas ChouOn Nios II, the ABI is documented here:
62630df01fd3SThomas Chou	http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
62640df01fd3SThomas Chou
62650df01fd3SThomas Chou    ==> U-Boot will use gp to hold a pointer to the global data
62660df01fd3SThomas Chou
62670df01fd3SThomas Chou    Note: on Nios II, we give "-G0" option to gcc and don't use gp
62680df01fd3SThomas Chou    to access small data sections, so gp is free.
62690df01fd3SThomas Chou
6270afc1ce82SMacpaul LinOn NDS32, the following registers are used:
6271afc1ce82SMacpaul Lin
6272afc1ce82SMacpaul Lin	R0-R1:	argument/return
6273afc1ce82SMacpaul Lin	R2-R5:	argument
6274afc1ce82SMacpaul Lin	R15:	temporary register for assembler
6275afc1ce82SMacpaul Lin	R16:	trampoline register
6276afc1ce82SMacpaul Lin	R28:	frame pointer (FP)
6277afc1ce82SMacpaul Lin	R29:	global pointer (GP)
6278afc1ce82SMacpaul Lin	R30:	link register (LP)
6279afc1ce82SMacpaul Lin	R31:	stack pointer (SP)
6280afc1ce82SMacpaul Lin	PC:	program counter (PC)
6281afc1ce82SMacpaul Lin
6282afc1ce82SMacpaul Lin    ==> U-Boot will use R10 to hold a pointer to the global data
6283afc1ce82SMacpaul Lin
6284d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
6285d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much.
6286c609719bSwdenk
6287c609719bSwdenkMemory Management:
6288c609719bSwdenk------------------
6289c609719bSwdenk
6290c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the
6291c609719bSwdenkMMU is not used either for address mapping nor for memory protection.
6292c609719bSwdenk
6293c609719bSwdenkThe available memory is mapped to fixed addresses using the memory
6294c609719bSwdenkcontroller. In this process, a contiguous block is formed for each
6295c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several
6296c609719bSwdenkphysical memory banks.
6297c609719bSwdenk
6298c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on
6299c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
6300c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself
6301c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some
63026d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
6303c609719bSwdenkconfiguration setting]. Below that, a structure with global Board
6304c609719bSwdenkInfo data is placed, followed by the stack (growing downward).
6305c609719bSwdenk
6306c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB
6307c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF).
6308c609719bSwdenk
6309c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like
6310c609719bSwdenkthis:
6311c609719bSwdenk
6312c609719bSwdenk	0x0000 0000	Exception Vector code
6313c609719bSwdenk	      :
6314c609719bSwdenk	0x0000 1FFF
6315c609719bSwdenk	0x0000 2000	Free for Application Use
6316c609719bSwdenk	      :
6317c609719bSwdenk	      :
6318c609719bSwdenk
6319c609719bSwdenk	      :
6320c609719bSwdenk	      :
6321c609719bSwdenk	0x00FB FF20	Monitor Stack (Growing downward)
6322c609719bSwdenk	0x00FB FFAC	Board Info Data and permanent copy of global data
6323c609719bSwdenk	0x00FC 0000	Malloc Arena
6324c609719bSwdenk	      :
6325c609719bSwdenk	0x00FD FFFF
6326c609719bSwdenk	0x00FE 0000	RAM Copy of Monitor Code
6327c609719bSwdenk	...		eventually: LCD or video framebuffer
6328c609719bSwdenk	...		eventually: pRAM (Protected RAM - unchanged by reset)
6329c609719bSwdenk	0x00FF FFFF	[End of RAM]
6330c609719bSwdenk
6331c609719bSwdenk
6332c609719bSwdenkSystem Initialization:
6333c609719bSwdenk----------------------
6334c609719bSwdenk
6335c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point
633611ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset
6337c609719bSwdenkconfiguration for CS0# this is a mirror of the onboard Flash memory.
63387152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address.
6339c609719bSwdenkTo be able to implement the initialization code in C, a (small!)
6340c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs
6341c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked
6342c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core,
6343c609719bSwdenkthe caches and the SIU.
6344c609719bSwdenk
6345c609719bSwdenkNext, all (potentially) available memory banks are mapped using a
6346c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries
6347c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
6348c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
6349c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a
6350c609719bSwdenksimple memory test is run that determines the size of the SDRAM
6351c609719bSwdenkbanks.
6352c609719bSwdenk
6353c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of
63547152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first
6355c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address
6356c609719bSwdenk0x00000000, with any additional banks following immediately to create
6357c609719bSwdenkcontiguous memory starting from 0.
6358c609719bSwdenk
6359c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area
6360c609719bSwdenkand allocates memory for use by malloc() and for the global Board
6361c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM
6362c609719bSwdenkpages, and the final stack is set up.
6363c609719bSwdenk
6364c609719bSwdenkOnly after this relocation will you have a "normal" C environment;
6365c609719bSwdenkuntil that you are restricted in several ways, mostly because you are
6366c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a
6367c609719bSwdenknew address in RAM.
6368c609719bSwdenk
6369c609719bSwdenk
6370c609719bSwdenkU-Boot Porting Guide:
6371c609719bSwdenk----------------------
6372c609719bSwdenk
6373c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
63746aff3115Swdenklist, October 2002]
6375c609719bSwdenk
6376c609719bSwdenk
6377c609719bSwdenkint main(int argc, char *argv[])
6378c609719bSwdenk{
6379c609719bSwdenk	sighandler_t no_more_time;
6380c609719bSwdenk
6381c609719bSwdenk	signal(SIGALRM, no_more_time);
6382c609719bSwdenk	alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
6383c609719bSwdenk
6384c609719bSwdenk	if (available_money > available_manpower) {
63856c3fef28SJerry Van Baren		Pay consultant to port U-Boot;
6386c609719bSwdenk		return 0;
6387c609719bSwdenk	}
6388c609719bSwdenk
6389c609719bSwdenk	Download latest U-Boot source;
6390c609719bSwdenk
63910668236bSWolfgang Denk	Subscribe to u-boot mailing list;
63926aff3115Swdenk
63936c3fef28SJerry Van Baren	if (clueless)
6394c609719bSwdenk		email("Hi, I am new to U-Boot, how do I get started?");
6395c609719bSwdenk
6396c609719bSwdenk	while (learning) {
6397c609719bSwdenk		Read the README file in the top level directory;
63987cb22f97Swdenk		Read http://www.denx.de/twiki/bin/view/DULG/Manual;
63996c3fef28SJerry Van Baren		Read applicable doc/*.README;
6400c609719bSwdenk		Read the source, Luke;
64016c3fef28SJerry Van Baren		/* find . -name "*.[chS]" | xargs grep -i <keyword> */
6402c609719bSwdenk	}
6403c609719bSwdenk
64046c3fef28SJerry Van Baren	if (available_money > toLocalCurrency ($2500))
64056c3fef28SJerry Van Baren		Buy a BDI3000;
64066c3fef28SJerry Van Baren	else
6407c609719bSwdenk		Add a lot of aggravation and time;
6408c609719bSwdenk
64096c3fef28SJerry Van Baren	if (a similar board exists) {	/* hopefully... */
64106c3fef28SJerry Van Baren		cp -a board/<similar> board/<myboard>
64116c3fef28SJerry Van Baren		cp include/configs/<similar>.h include/configs/<myboard>.h
64126c3fef28SJerry Van Baren	} else {
6413c609719bSwdenk		Create your own board support subdirectory;
64146c3fef28SJerry Van Baren		Create your own board include/configs/<myboard>.h file;
64156c3fef28SJerry Van Baren	}
64166c3fef28SJerry Van Baren	Edit new board/<myboard> files
64176c3fef28SJerry Van Baren	Edit new include/configs/<myboard>.h
6418c609719bSwdenk
64196c3fef28SJerry Van Baren	while (!accepted) {
6420c609719bSwdenk		while (!running) {
6421c609719bSwdenk			do {
6422c609719bSwdenk				Add / modify source code;
6423c609719bSwdenk			} until (compiles);
6424c609719bSwdenk			Debug;
6425c609719bSwdenk			if (clueless)
6426c609719bSwdenk				email("Hi, I am having problems...");
6427c609719bSwdenk		}
64286c3fef28SJerry Van Baren		Send patch file to the U-Boot email list;
64296c3fef28SJerry Van Baren		if (reasonable critiques)
64306c3fef28SJerry Van Baren			Incorporate improvements from email list code review;
64316c3fef28SJerry Van Baren		else
64326c3fef28SJerry Van Baren			Defend code as written;
64336c3fef28SJerry Van Baren	}
6434c609719bSwdenk
6435c609719bSwdenk	return 0;
6436c609719bSwdenk}
6437c609719bSwdenk
6438c609719bSwdenkvoid no_more_time (int sig)
6439c609719bSwdenk{
6440c609719bSwdenk      hire_a_guru();
6441c609719bSwdenk}
6442c609719bSwdenk
6443c609719bSwdenk
6444c609719bSwdenkCoding Standards:
6445c609719bSwdenk-----------------
6446c609719bSwdenk
6447c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel
64482c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script
64497ca9296eSWolfgang Denk"scripts/Lindent" in your Linux kernel source directory.
6450c609719bSwdenk
64512c051651SDetlev ZundelSource files originating from a different project (for example the
64522c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not
64532c051651SDetlev Zundelreformated to ease subsequent migration to newer versions of those
64542c051651SDetlev Zundelsources.
64552c051651SDetlev Zundel
64562c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in
64572c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//)
64582c051651SDetlev Zundelin your code.
6459c609719bSwdenk
6460c178d3daSwdenkPlease also stick to the following formatting rules:
6461180d3f74Swdenk- remove any trailing white space
64627ca9296eSWolfgang Denk- use TAB characters for indentation and vertical alignment, not spaces
6463180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds
64647ca9296eSWolfgang Denk- do not add more than 2 consecutive empty lines to source files
6465180d3f74Swdenk- do not add trailing empty lines to source files
6466180d3f74Swdenk
6467c609719bSwdenkSubmissions which do not conform to the standards may be returned
6468c609719bSwdenkwith a request to reformat the changes.
6469c609719bSwdenk
6470c609719bSwdenk
6471c609719bSwdenkSubmitting Patches:
6472c609719bSwdenk-------------------
6473c609719bSwdenk
6474c609719bSwdenkSince the number of patches for U-Boot is growing, we need to
6475c609719bSwdenkestablish some rules. Submissions which do not conform to these rules
6476c609719bSwdenkmay be rejected, even when they contain important and valuable stuff.
6477c609719bSwdenk
64780d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details.
6479218ca724SWolfgang Denk
64800668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
64810668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot
64820668236bSWolfgang Denk
6483c609719bSwdenkWhen you send a patch, please include the following information with
6484c609719bSwdenkit:
6485c609719bSwdenk
6486c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes
6487c609719bSwdenk  this bug. Please try to include a way of demonstrating that the
6488c609719bSwdenk  patch actually fixes something.
6489c609719bSwdenk
6490c609719bSwdenk* For new features: a description of the feature and your
6491c609719bSwdenk  implementation.
6492c609719bSwdenk
6493c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch)
6494c609719bSwdenk
6495c609719bSwdenk* For major contributions, your entry to the CREDITS file
6496c609719bSwdenk
649727af930eSAlbert ARIBAUD* When you add support for a new board, don't forget to add a
649827af930eSAlbert ARIBAUD  maintainer e-mail address to the boards.cfg file, too.
6499c609719bSwdenk
6500c609719bSwdenk* If your patch adds new configuration options, don't forget to
6501c609719bSwdenk  document these in the README file.
6502c609719bSwdenk
6503218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly*
6504218ca724SWolfgang Denk  recommended) you can easily generate the patch using the
65057ca9296eSWolfgang Denk  "git format-patch". If you then use "git send-email" to send it to
6506218ca724SWolfgang Denk  the U-Boot mailing list, you will avoid most of the common problems
6507218ca724SWolfgang Denk  with some other mail clients.
6508c609719bSwdenk
6509218ca724SWolfgang Denk  If you cannot use git, use "diff -purN OLD NEW". If your version of
6510218ca724SWolfgang Denk  diff does not support these options, then get the latest version of
6511218ca724SWolfgang Denk  GNU diff.
65126dff5529Swdenk
6513218ca724SWolfgang Denk  The current directory when running this command shall be the parent
6514218ca724SWolfgang Denk  directory of the U-Boot source tree (i. e. please make sure that
6515218ca724SWolfgang Denk  your patch includes sufficient directory information for the
6516218ca724SWolfgang Denk  affected files).
6517218ca724SWolfgang Denk
6518218ca724SWolfgang Denk  We prefer patches as plain text. MIME attachments are discouraged,
6519218ca724SWolfgang Denk  and compressed attachments must not be used.
6520c609719bSwdenk
652152f52c14Swdenk* If one logical set of modifications affects or creates several
652252f52c14Swdenk  files, all these changes shall be submitted in a SINGLE patch file.
652352f52c14Swdenk
652452f52c14Swdenk* Changesets that contain different, unrelated modifications shall be
652552f52c14Swdenk  submitted as SEPARATE patches, one patch per changeset.
652652f52c14Swdenk
652752f52c14Swdenk
6528c609719bSwdenkNotes:
6529c609719bSwdenk
6530c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched
6531c609719bSwdenk  source tree and make sure that no errors or warnings are reported
6532c609719bSwdenk  for any of the boards.
6533c609719bSwdenk
6534c609719bSwdenk* Keep your modifications to the necessary minimum: A patch
6535c609719bSwdenk  containing several unrelated changes or arbitrary reformats will be
6536c609719bSwdenk  returned with a request to re-formatting / split it.
6537c609719bSwdenk
6538c609719bSwdenk* If you modify existing code, make sure that your new code does not
6539c609719bSwdenk  add to the memory footprint of the code ;-) Small is beautiful!
6540c609719bSwdenk  When adding new features, these should compile conditionally only
6541c609719bSwdenk  (using #ifdef), and the resulting code with the new feature
6542c609719bSwdenk  disabled must not need more memory than the old code without your
6543c609719bSwdenk  modification.
654490dc6704Swdenk
65450668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the
65460668236bSWolfgang Denk  u-boot mailing list. Bigger patches will be moderated. If they are
65470668236bSWolfgang Denk  reasonable and not too big, they will be acknowledged. But patches
65480668236bSWolfgang Denk  bigger than the size limit should be avoided.
6549