xref: /openbmc/u-boot/README (revision 73c38934daa10b518b20f2d21298fc8a8226843b)
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      /mpc5xx		Files specific to Freescale MPC5xx CPUs
1868d321b81SPeter Tyser      /mpc5xxx		Files specific to Freescale MPC5xxx CPUs
1878d321b81SPeter Tyser      /mpc8xx		Files specific to Freescale MPC8xx CPUs
1888d321b81SPeter Tyser      /mpc8260		Files specific to Freescale MPC8260 CPUs
1898d321b81SPeter Tyser      /mpc85xx		Files specific to Freescale MPC85xx CPUs
1908d321b81SPeter Tyser      /ppc4xx		Files specific to AMCC PowerPC 4xx CPUs
1918d321b81SPeter Tyser    /lib		Architecture specific library files
1928d321b81SPeter Tyser  /sh			Files generic to SH architecture
1938d321b81SPeter Tyser    /cpu		CPU specific files
1948d321b81SPeter Tyser      /sh2		Files specific to sh2 CPUs
1958d321b81SPeter Tyser      /sh3		Files specific to sh3 CPUs
1968d321b81SPeter Tyser      /sh4		Files specific to sh4 CPUs
1978d321b81SPeter Tyser    /lib		Architecture specific library files
1988d321b81SPeter Tyser  /sparc		Files generic to SPARC architecture
1998d321b81SPeter Tyser    /cpu		CPU specific files
2008d321b81SPeter Tyser      /leon2		Files specific to Gaisler LEON2 SPARC CPU
2018d321b81SPeter Tyser      /leon3		Files specific to Gaisler LEON3 SPARC CPU
2028d321b81SPeter Tyser    /lib		Architecture specific library files
20333c7731bSRobert P. J. Day  /x86			Files generic to x86 architecture
20433c7731bSRobert P. J. Day    /cpu		CPU specific files
20533c7731bSRobert P. J. Day    /lib		Architecture specific library files
2068d321b81SPeter Tyser/api			Machine/arch independent API for external apps
2078d321b81SPeter Tyser/board			Board dependent files
2088d321b81SPeter Tyser/common			Misc architecture independent functions
2098d321b81SPeter Tyser/disk			Code for disk drive partition handling
2108d321b81SPeter Tyser/doc			Documentation (don't expect too much)
2118d321b81SPeter Tyser/drivers		Commonly used device drivers
21233c7731bSRobert P. J. Day/dts			Contains Makefile for building internal U-Boot fdt.
2138d321b81SPeter Tyser/examples		Example code for standalone applications, etc.
2148d321b81SPeter Tyser/fs			Filesystem code (cramfs, ext2, jffs2, etc.)
2158d321b81SPeter Tyser/include		Header Files
2168d321b81SPeter Tyser/lib			Files generic to all architectures
2178d321b81SPeter Tyser  /libfdt		Library files to support flattened device trees
2188d321b81SPeter Tyser  /lzma			Library files to support LZMA decompression
2198d321b81SPeter Tyser  /lzo			Library files to support LZO decompression
2208d321b81SPeter Tyser/net			Networking code
2218d321b81SPeter Tyser/post			Power On Self Test
22233c7731bSRobert P. J. Day/spl			Secondary Program Loader framework
2238d321b81SPeter Tyser/tools			Tools to build S-Record or U-Boot images, etc.
224c609719bSwdenk
225c609719bSwdenkSoftware Configuration:
226c609719bSwdenk=======================
227c609719bSwdenk
228c609719bSwdenkConfiguration is usually done using C preprocessor defines; the
229c609719bSwdenkrationale behind that is to avoid dead code whenever possible.
230c609719bSwdenk
231c609719bSwdenkThere are two classes of configuration variables:
232c609719bSwdenk
233c609719bSwdenk* Configuration _OPTIONS_:
234c609719bSwdenk  These are selectable by the user and have names beginning with
235c609719bSwdenk  "CONFIG_".
236c609719bSwdenk
237c609719bSwdenk* Configuration _SETTINGS_:
238c609719bSwdenk  These depend on the hardware etc. and should not be meddled with if
239c609719bSwdenk  you don't know what you're doing; they have names beginning with
2406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  "CONFIG_SYS_".
241c609719bSwdenk
242c609719bSwdenkLater we will add a configuration tool - probably similar to or even
243c609719bSwdenkidentical to what's used for the Linux kernel. Right now, we have to
244c609719bSwdenkdo the configuration by hand, which means creating some symbolic
245c609719bSwdenklinks and editing some configuration files. We use the TQM8xxL boards
246c609719bSwdenkas an example here.
247c609719bSwdenk
248c609719bSwdenk
249c609719bSwdenkSelection of Processor Architecture and Board Type:
250c609719bSwdenk---------------------------------------------------
251c609719bSwdenk
252c609719bSwdenkFor all supported boards there are ready-to-use default
253ab584d67SHolger Freytherconfigurations available; just type "make <board_name>_defconfig".
254c609719bSwdenk
255c609719bSwdenkExample: For a TQM823L module type:
256c609719bSwdenk
257c609719bSwdenk	cd u-boot
258ab584d67SHolger Freyther	make TQM823L_defconfig
259c609719bSwdenk
26011ccc33fSMarcel ZiswilerFor the Cogent platform, you need to specify the CPU type as well;
261ab584d67SHolger Freythere.g. "make cogent_mpc8xx_defconfig". And also configure the cogent
262c609719bSwdenkdirectory according to the instructions in cogent/README.
263c609719bSwdenk
264c609719bSwdenk
26575b3c3aaSSimon GlassSandbox Environment:
26675b3c3aaSSimon Glass--------------------
26775b3c3aaSSimon Glass
26875b3c3aaSSimon GlassU-Boot can be built natively to run on a Linux host using the 'sandbox'
26975b3c3aaSSimon Glassboard. This allows feature development which is not board- or architecture-
27075b3c3aaSSimon Glassspecific to be undertaken on a native platform. The sandbox is also used to
27175b3c3aaSSimon Glassrun some of U-Boot's tests.
27275b3c3aaSSimon Glass
2736b1978f8SJagannadha Sutradharudu TekiSee board/sandbox/README.sandbox for more details.
27475b3c3aaSSimon Glass
27575b3c3aaSSimon Glass
276c609719bSwdenkConfiguration Options:
277c609719bSwdenk----------------------
278c609719bSwdenk
279c609719bSwdenkConfiguration depends on the combination of board and CPU type; all
280c609719bSwdenksuch information is kept in a configuration file
281c609719bSwdenk"include/configs/<board_name>.h".
282c609719bSwdenk
283c609719bSwdenkExample: For a TQM823L module, all configuration settings are in
284c609719bSwdenk"include/configs/TQM823L.h".
285c609719bSwdenk
286c609719bSwdenk
2877f6c2cbcSwdenkMany of the options are named exactly as the corresponding Linux
2887f6c2cbcSwdenkkernel configuration options. The intention is to make it easier to
2897f6c2cbcSwdenkbuild a config tool - later.
2907f6c2cbcSwdenk
2917f6c2cbcSwdenk
292c609719bSwdenkThe following options need to be configured:
293c609719bSwdenk
2942628114eSKim Phillips- CPU Type:	Define exactly one, e.g. CONFIG_MPC85XX.
295c609719bSwdenk
2962628114eSKim Phillips- Board Type:	Define exactly one, e.g. CONFIG_MPC8540ADS.
2976ccec449SWolfgang Denk
2986ccec449SWolfgang Denk- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
29909ea0de0SHaavard Skinnemoen		Define exactly one, e.g. CONFIG_ATSTK1002
300c609719bSwdenk
301c609719bSwdenk- CPU Module Type: (if CONFIG_COGENT is defined)
302c609719bSwdenk		Define exactly one of
303c609719bSwdenk		CONFIG_CMA286_60_OLD
304c609719bSwdenk--- FIXME --- not tested yet:
305c609719bSwdenk		CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
306c609719bSwdenk		CONFIG_CMA287_23, CONFIG_CMA287_50
307c609719bSwdenk
308c609719bSwdenk- Motherboard Type: (if CONFIG_COGENT is defined)
309c609719bSwdenk		Define exactly one of
310c609719bSwdenk		CONFIG_CMA101, CONFIG_CMA102
311c609719bSwdenk
312c609719bSwdenk- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
313c609719bSwdenk		Define one or more of
314c609719bSwdenk		CONFIG_CMA302
315c609719bSwdenk
316c609719bSwdenk- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
317c609719bSwdenk		Define one or more of
318c609719bSwdenk		CONFIG_LCD_HEARTBEAT	- update a character position on
31911ccc33fSMarcel Ziswiler					  the LCD display every second with
320c609719bSwdenk					  a "rotator" |\-/|\-/
321c609719bSwdenk
322cf946c6dSLei Wen- Marvell Family Member
323cf946c6dSLei Wen		CONFIG_SYS_MVFS		- define it if you want to enable
324cf946c6dSLei Wen					  multiple fs option at one time
325cf946c6dSLei Wen					  for marvell soc family
326cf946c6dSLei Wen
32711ccc33fSMarcel Ziswiler- 8xx CPU Options: (if using an MPC8xx CPU)
32866ca92a5Swdenk		CONFIG_8xx_GCLK_FREQ	- deprecated: CPU clock if
32966ca92a5Swdenk					  get_gclk_freq() cannot work
3305da627a4Swdenk					  e.g. if there is no 32KHz
3315da627a4Swdenk					  reference PIT/RTC clock
33266ca92a5Swdenk		CONFIG_8xx_OSCLK	- PLL input clock (either EXTCLK
33366ca92a5Swdenk					  or XTAL/EXTAL)
334c609719bSwdenk
33566ca92a5Swdenk- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
3366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MIN
3376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MAX
33866ca92a5Swdenk		CONFIG_8xx_CPUCLK_DEFAULT
33975d1ea7fSwdenk			See doc/README.MPC866
34075d1ea7fSwdenk
3416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MEASURE_CPUCLK
34275d1ea7fSwdenk
34375d1ea7fSwdenk		Define this to measure the actual CPU clock instead
34475d1ea7fSwdenk		of relying on the correctness of the configured
34575d1ea7fSwdenk		values. Mostly useful for board bringup to make sure
34675d1ea7fSwdenk		the PLL is locked at the intended frequency. Note
34775d1ea7fSwdenk		that this requires a (stable) reference clock (32 kHz
3486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		RTC clock or CONFIG_SYS_8XX_XIN)
34975d1ea7fSwdenk
350506f3918SHeiko Schocher		CONFIG_SYS_DELAYED_ICACHE
351506f3918SHeiko Schocher
352506f3918SHeiko Schocher		Define this option if you want to enable the
353506f3918SHeiko Schocher		ICache only when Code runs from RAM.
354506f3918SHeiko Schocher
35566412c63SKumar Gala- 85xx CPU Options:
356ffd06e02SYork Sun		CONFIG_SYS_PPC64
357ffd06e02SYork Sun
358ffd06e02SYork Sun		Specifies that the core is a 64-bit PowerPC implementation (implements
359ffd06e02SYork Sun		the "64" category of the Power ISA). This is necessary for ePAPR
360ffd06e02SYork Sun		compliance, among other possible reasons.
361ffd06e02SYork Sun
36266412c63SKumar Gala		CONFIG_SYS_FSL_TBCLK_DIV
36366412c63SKumar Gala
36466412c63SKumar Gala		Defines the core time base clock divider ratio compared to the
36566412c63SKumar Gala		system clock.  On most PQ3 devices this is 8, on newer QorIQ
36666412c63SKumar Gala		devices it can be 16 or 32.  The ratio varies from SoC to Soc.
36766412c63SKumar Gala
3688f29084aSKumar Gala		CONFIG_SYS_FSL_PCIE_COMPAT
3698f29084aSKumar Gala
3708f29084aSKumar Gala		Defines the string to utilize when trying to match PCIe device
3718f29084aSKumar Gala		tree nodes for the given platform.
3728f29084aSKumar Gala
373afa6b551SPrabhakar Kushwaha		CONFIG_SYS_PPC_E500_DEBUG_TLB
374afa6b551SPrabhakar Kushwaha
375afa6b551SPrabhakar Kushwaha		Enables a temporary TLB entry to be used during boot to work
376afa6b551SPrabhakar Kushwaha		around limitations in e500v1 and e500v2 external debugger
377afa6b551SPrabhakar Kushwaha		support. This reduces the portions of the boot code where
378afa6b551SPrabhakar Kushwaha		breakpoints and single stepping do not work.  The value of this
379afa6b551SPrabhakar Kushwaha		symbol should be set to the TLB1 entry to be used for this
380afa6b551SPrabhakar Kushwaha		purpose.
381afa6b551SPrabhakar Kushwaha
38233eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510
38333eee330SScott Wood
38433eee330SScott Wood		Enables a workaround for erratum A004510.  If set,
38533eee330SScott Wood		then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
38633eee330SScott Wood		CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
38733eee330SScott Wood
38833eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
38933eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
39033eee330SScott Wood
39133eee330SScott Wood		Defines one or two SoC revisions (low 8 bits of SVR)
39233eee330SScott Wood		for which the A004510 workaround should be applied.
39333eee330SScott Wood
39433eee330SScott Wood		The rest of SVR is either not relevant to the decision
39533eee330SScott Wood		of whether the erratum is present (e.g. p2040 versus
39633eee330SScott Wood		p2041) or is implied by the build target, which controls
39733eee330SScott Wood		whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
39833eee330SScott Wood
39933eee330SScott Wood		See Freescale App Note 4493 for more information about
40033eee330SScott Wood		this erratum.
40133eee330SScott Wood
40274fa22edSPrabhakar Kushwaha		CONFIG_A003399_NOR_WORKAROUND
40374fa22edSPrabhakar Kushwaha		Enables a workaround for IFC erratum A003399. It is only
404b445bbb4SJeremiah Mahler		required during NOR boot.
40574fa22edSPrabhakar Kushwaha
4069f074e67SPrabhakar Kushwaha		CONFIG_A008044_WORKAROUND
4079f074e67SPrabhakar Kushwaha		Enables a workaround for T1040/T1042 erratum A008044. It is only
408b445bbb4SJeremiah Mahler		required during NAND boot and valid for Rev 1.0 SoC revision
4099f074e67SPrabhakar Kushwaha
41033eee330SScott Wood		CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
41133eee330SScott Wood
41233eee330SScott Wood		This is the value to write into CCSR offset 0x18600
41333eee330SScott Wood		according to the A004510 workaround.
41433eee330SScott Wood
41564501c66SPriyanka Jain		CONFIG_SYS_FSL_DSP_DDR_ADDR
41664501c66SPriyanka Jain		This value denotes start offset of DDR memory which is
41764501c66SPriyanka Jain		connected exclusively to the DSP cores.
41864501c66SPriyanka Jain
419765b0bdbSPriyanka Jain		CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
420765b0bdbSPriyanka Jain		This value denotes start offset of M2 memory
421765b0bdbSPriyanka Jain		which is directly connected to the DSP core.
422765b0bdbSPriyanka Jain
42364501c66SPriyanka Jain		CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
42464501c66SPriyanka Jain		This value denotes start offset of M3 memory which is directly
42564501c66SPriyanka Jain		connected to the DSP core.
42664501c66SPriyanka Jain
427765b0bdbSPriyanka Jain		CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
428765b0bdbSPriyanka Jain		This value denotes start offset of DSP CCSR space.
429765b0bdbSPriyanka Jain
430b135991aSPriyanka Jain		CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
431b135991aSPriyanka Jain		Single Source Clock is clocking mode present in some of FSL SoC's.
432b135991aSPriyanka Jain		In this mode, a single differential clock is used to supply
433b135991aSPriyanka Jain		clocks to the sysclock, ddrclock and usbclock.
434b135991aSPriyanka Jain
435fb4a2409SAneesh Bansal		CONFIG_SYS_CPC_REINIT_F
436fb4a2409SAneesh Bansal		This CONFIG is defined when the CPC is configured as SRAM at the
437fb4a2409SAneesh Bansal		time of U-boot entry and is required to be re-initialized.
438fb4a2409SAneesh Bansal
439aade2004STang Yuantian		CONFIG_DEEP_SLEEP
440b445bbb4SJeremiah Mahler		Indicates this SoC supports deep sleep feature. If deep sleep is
441aade2004STang Yuantian		supported, core will start to execute uboot when wakes up.
442aade2004STang Yuantian
4436cb461b4SDaniel Schwierzeck- Generic CPU options:
4442a1680e3SYork Sun		CONFIG_SYS_GENERIC_GLOBAL_DATA
4452a1680e3SYork Sun		Defines global data is initialized in generic board board_init_f().
4462a1680e3SYork Sun		If this macro is defined, global data is created and cleared in
4472a1680e3SYork Sun		generic board board_init_f(). Without this macro, architecture/board
4482a1680e3SYork Sun		should initialize global data before calling board_init_f().
4492a1680e3SYork Sun
4506cb461b4SDaniel Schwierzeck		CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
4516cb461b4SDaniel Schwierzeck
4526cb461b4SDaniel Schwierzeck		Defines the endianess of the CPU. Implementation of those
4536cb461b4SDaniel Schwierzeck		values is arch specific.
4546cb461b4SDaniel Schwierzeck
4555614e71bSYork Sun		CONFIG_SYS_FSL_DDR
4565614e71bSYork Sun		Freescale DDR driver in use. This type of DDR controller is
4575614e71bSYork Sun		found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
4585614e71bSYork Sun		SoCs.
4595614e71bSYork Sun
4605614e71bSYork Sun		CONFIG_SYS_FSL_DDR_ADDR
4615614e71bSYork Sun		Freescale DDR memory-mapped register base.
4625614e71bSYork Sun
4635614e71bSYork Sun		CONFIG_SYS_FSL_DDR_EMU
4645614e71bSYork Sun		Specify emulator support for DDR. Some DDR features such as
4655614e71bSYork Sun		deskew training are not available.
4665614e71bSYork Sun
4675614e71bSYork Sun		CONFIG_SYS_FSL_DDRC_GEN1
4685614e71bSYork Sun		Freescale DDR1 controller.
4695614e71bSYork Sun
4705614e71bSYork Sun		CONFIG_SYS_FSL_DDRC_GEN2
4715614e71bSYork Sun		Freescale DDR2 controller.
4725614e71bSYork Sun
4735614e71bSYork Sun		CONFIG_SYS_FSL_DDRC_GEN3
4745614e71bSYork Sun		Freescale DDR3 controller.
4755614e71bSYork Sun
47634e026f9SYork Sun		CONFIG_SYS_FSL_DDRC_GEN4
47734e026f9SYork Sun		Freescale DDR4 controller.
47834e026f9SYork Sun
4799ac4ffbdSYork Sun		CONFIG_SYS_FSL_DDRC_ARM_GEN3
4809ac4ffbdSYork Sun		Freescale DDR3 controller for ARM-based SoCs.
4819ac4ffbdSYork Sun
4825614e71bSYork Sun		CONFIG_SYS_FSL_DDR1
4835614e71bSYork Sun		Board config to use DDR1. It can be enabled for SoCs with
4845614e71bSYork Sun		Freescale DDR1 or DDR2 controllers, depending on the board
4855614e71bSYork Sun		implemetation.
4865614e71bSYork Sun
4875614e71bSYork Sun		CONFIG_SYS_FSL_DDR2
4885614e71bSYork Sun		Board config to use DDR2. It can be eanbeld for SoCs with
4895614e71bSYork Sun		Freescale DDR2 or DDR3 controllers, depending on the board
4905614e71bSYork Sun		implementation.
4915614e71bSYork Sun
4925614e71bSYork Sun		CONFIG_SYS_FSL_DDR3
4935614e71bSYork Sun		Board config to use DDR3. It can be enabled for SoCs with
49434e026f9SYork Sun		Freescale DDR3 or DDR3L controllers.
49534e026f9SYork Sun
49634e026f9SYork Sun		CONFIG_SYS_FSL_DDR3L
49734e026f9SYork Sun		Board config to use DDR3L. It can be enabled for SoCs with
49834e026f9SYork Sun		DDR3L controllers.
49934e026f9SYork Sun
50034e026f9SYork Sun		CONFIG_SYS_FSL_DDR4
50134e026f9SYork Sun		Board config to use DDR4. It can be enabled for SoCs with
50234e026f9SYork Sun		DDR4 controllers.
5035614e71bSYork Sun
5041b4175d6SPrabhakar Kushwaha		CONFIG_SYS_FSL_IFC_BE
5051b4175d6SPrabhakar Kushwaha		Defines the IFC controller register space as Big Endian
5061b4175d6SPrabhakar Kushwaha
5071b4175d6SPrabhakar Kushwaha		CONFIG_SYS_FSL_IFC_LE
5081b4175d6SPrabhakar Kushwaha		Defines the IFC controller register space as Little Endian
5091b4175d6SPrabhakar Kushwaha
510690e4258SPrabhakar Kushwaha		CONFIG_SYS_FSL_PBL_PBI
511690e4258SPrabhakar Kushwaha		It enables addition of RCW (Power on reset configuration) in built image.
512690e4258SPrabhakar Kushwaha		Please refer doc/README.pblimage for more details
513690e4258SPrabhakar Kushwaha
514690e4258SPrabhakar Kushwaha		CONFIG_SYS_FSL_PBL_RCW
515690e4258SPrabhakar Kushwaha		It adds PBI(pre-boot instructions) commands in u-boot build image.
516690e4258SPrabhakar Kushwaha		PBI commands can be used to configure SoC before it starts the execution.
517690e4258SPrabhakar Kushwaha		Please refer doc/README.pblimage for more details
518690e4258SPrabhakar Kushwaha
51989ad7be8SPrabhakar Kushwaha		CONFIG_SPL_FSL_PBL
52089ad7be8SPrabhakar Kushwaha		It adds a target to create boot binary having SPL binary in PBI format
52189ad7be8SPrabhakar Kushwaha		concatenated with u-boot binary.
52289ad7be8SPrabhakar Kushwaha
5234e5b1bd0SYork Sun		CONFIG_SYS_FSL_DDR_BE
5244e5b1bd0SYork Sun		Defines the DDR controller register space as Big Endian
5254e5b1bd0SYork Sun
5264e5b1bd0SYork Sun		CONFIG_SYS_FSL_DDR_LE
5274e5b1bd0SYork Sun		Defines the DDR controller register space as Little Endian
5284e5b1bd0SYork Sun
5296b9e309aSYork Sun		CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
5306b9e309aSYork Sun		Physical address from the view of DDR controllers. It is the
5316b9e309aSYork Sun		same as CONFIG_SYS_DDR_SDRAM_BASE for  all Power SoCs. But
5326b9e309aSYork Sun		it could be different for ARM SoCs.
5336b9e309aSYork Sun
5346b1e1254SYork Sun		CONFIG_SYS_FSL_DDR_INTLV_256B
5356b1e1254SYork Sun		DDR controller interleaving on 256-byte. This is a special
5366b1e1254SYork Sun		interleaving mode, handled by Dickens for Freescale layerscape
5376b1e1254SYork Sun		SoCs with ARM core.
5386b1e1254SYork Sun
5391d71efbbSYork Sun		CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
5401d71efbbSYork Sun		Number of controllers used as main memory.
5411d71efbbSYork Sun
5421d71efbbSYork Sun		CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
5431d71efbbSYork Sun		Number of controllers used for other than main memory.
5441d71efbbSYork Sun
545028dbb8dSRuchika Gupta		CONFIG_SYS_FSL_SEC_BE
546028dbb8dSRuchika Gupta		Defines the SEC controller register space as Big Endian
547028dbb8dSRuchika Gupta
548028dbb8dSRuchika Gupta		CONFIG_SYS_FSL_SEC_LE
549028dbb8dSRuchika Gupta		Defines the SEC controller register space as Little Endian
550028dbb8dSRuchika Gupta
5510b953ffcSMarkus Klotzbuecher- Intel Monahans options:
5526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
5530b953ffcSMarkus Klotzbuecher
5540b953ffcSMarkus Klotzbuecher		Defines the Monahans run mode to oscillator
5550b953ffcSMarkus Klotzbuecher		ratio. Valid values are 8, 16, 24, 31. The core
5560b953ffcSMarkus Klotzbuecher		frequency is this value multiplied by 13 MHz.
5570b953ffcSMarkus Klotzbuecher
5586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
5590b953ffcSMarkus Klotzbuecher
5600b953ffcSMarkus Klotzbuecher		Defines the Monahans turbo mode to oscillator
5610b953ffcSMarkus Klotzbuecher		ratio. Valid values are 1 (default if undefined) and
5620b953ffcSMarkus Klotzbuecher		2. The core frequency as calculated above is multiplied
5630b953ffcSMarkus Klotzbuecher		by this value.
5640b953ffcSMarkus Klotzbuecher
56592bbd64eSDaniel Schwierzeck- MIPS CPU options:
56692bbd64eSDaniel Schwierzeck		CONFIG_SYS_INIT_SP_OFFSET
56792bbd64eSDaniel Schwierzeck
56892bbd64eSDaniel Schwierzeck		Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
56992bbd64eSDaniel Schwierzeck		pointer. This is needed for the temporary stack before
57092bbd64eSDaniel Schwierzeck		relocation.
57192bbd64eSDaniel Schwierzeck
57292bbd64eSDaniel Schwierzeck		CONFIG_SYS_MIPS_CACHE_MODE
57392bbd64eSDaniel Schwierzeck
57492bbd64eSDaniel Schwierzeck		Cache operation mode for the MIPS CPU.
57592bbd64eSDaniel Schwierzeck		See also arch/mips/include/asm/mipsregs.h.
57692bbd64eSDaniel Schwierzeck		Possible values are:
57792bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_NO_WA
57892bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_WA
57992bbd64eSDaniel Schwierzeck			CONF_CM_UNCACHED
58092bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_NONCOHERENT
58192bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_CE
58292bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_COW
58392bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_CUW
58492bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_ACCELERATED
58592bbd64eSDaniel Schwierzeck
58692bbd64eSDaniel Schwierzeck		CONFIG_SYS_XWAY_EBU_BOOTCFG
58792bbd64eSDaniel Schwierzeck
58892bbd64eSDaniel Schwierzeck		Special option for Lantiq XWAY SoCs for booting from NOR flash.
58992bbd64eSDaniel Schwierzeck		See also arch/mips/cpu/mips32/start.S.
59092bbd64eSDaniel Schwierzeck
59192bbd64eSDaniel Schwierzeck		CONFIG_XWAY_SWAP_BYTES
59292bbd64eSDaniel Schwierzeck
59392bbd64eSDaniel Schwierzeck		Enable compilation of tools/xway-swap-bytes needed for Lantiq
59492bbd64eSDaniel Schwierzeck		XWAY SoCs for booting from NOR flash. The U-Boot image needs to
59592bbd64eSDaniel Schwierzeck		be swapped if a flash programmer is used.
59692bbd64eSDaniel Schwierzeck
597b67d8816SChristian Riesch- ARM options:
598b67d8816SChristian Riesch		CONFIG_SYS_EXCEPTION_VECTORS_HIGH
599b67d8816SChristian Riesch
600b67d8816SChristian Riesch		Select high exception vectors of the ARM core, e.g., do not
601b67d8816SChristian Riesch		clear the V bit of the c1 register of CP15.
602b67d8816SChristian Riesch
6035356f545SAneesh V		CONFIG_SYS_THUMB_BUILD
6045356f545SAneesh V
6055356f545SAneesh V		Use this flag to build U-Boot using the Thumb instruction
6065356f545SAneesh V		set for ARM architectures. Thumb instruction set provides
6075356f545SAneesh V		better code density. For ARM architectures that support
6085356f545SAneesh V		Thumb2 this flag will result in Thumb2 code generated by
6095356f545SAneesh V		GCC.
6105356f545SAneesh V
611c5d4752cSStephen Warren		CONFIG_ARM_ERRATA_716044
6120678587fSStephen Warren		CONFIG_ARM_ERRATA_742230
6130678587fSStephen Warren		CONFIG_ARM_ERRATA_743622
6140678587fSStephen Warren		CONFIG_ARM_ERRATA_751472
615f71cbfe3SNitin Garg		CONFIG_ARM_ERRATA_794072
616b7588e3bSNitin Garg		CONFIG_ARM_ERRATA_761320
6170678587fSStephen Warren
6180678587fSStephen Warren		If set, the workarounds for these ARM errata are applied early
6190678587fSStephen Warren		during U-Boot startup. Note that these options force the
6200678587fSStephen Warren		workarounds to be applied; no CPU-type/version detection
6210678587fSStephen Warren		exists, unlike the similar options in the Linux kernel. Do not
6220678587fSStephen Warren		set these options unless they apply!
6230678587fSStephen Warren
624*73c38934SStephen Warren- Tegra SoC options:
625*73c38934SStephen Warren		CONFIG_TEGRA_SUPPORT_NON_SECURE
626*73c38934SStephen Warren
627*73c38934SStephen Warren		Support executing U-Boot in non-secure (NS) mode. Certain
628*73c38934SStephen Warren		impossible actions will be skipped if the CPU is in NS mode,
629*73c38934SStephen Warren		such as ARM architectural timer initialization.
630*73c38934SStephen Warren
63138687ae6SSimon Glass- Driver Model
63238687ae6SSimon Glass		Driver model is a new framework for devices in U-Boot
63338687ae6SSimon Glass		introduced in early 2014. U-Boot is being progressively
63438687ae6SSimon Glass		moved over to this. It offers a consistent device structure,
63538687ae6SSimon Glass		supports grouping devices into classes and has built-in
63638687ae6SSimon Glass		handling of platform data and device tree.
63738687ae6SSimon Glass
63838687ae6SSimon Glass		To enable transition to driver model in a relatively
63938687ae6SSimon Glass		painful fashion, each subsystem can be independently
64038687ae6SSimon Glass		switched between the legacy/ad-hoc approach and the new
64138687ae6SSimon Glass		driver model using the options below. Also, many uclass
64238687ae6SSimon Glass		interfaces include compatibility features which may be
64338687ae6SSimon Glass		removed once the conversion of that subsystem is complete.
64438687ae6SSimon Glass		As a result, the API provided by the subsystem may in fact
64538687ae6SSimon Glass		not change with driver model.
64638687ae6SSimon Glass
64738687ae6SSimon Glass		See doc/driver-model/README.txt for more information.
64838687ae6SSimon Glass
64938687ae6SSimon Glass		CONFIG_DM
65038687ae6SSimon Glass
65138687ae6SSimon Glass		Enable driver model. This brings in the core support,
65238687ae6SSimon Glass		including scanning of platform data on start-up. If
65338687ae6SSimon Glass		CONFIG_OF_CONTROL is enabled, the device tree will be
65438687ae6SSimon Glass		scanned also when available.
65538687ae6SSimon Glass
65638687ae6SSimon Glass		CONFIG_CMD_DM
65738687ae6SSimon Glass
65838687ae6SSimon Glass		Enable driver model test commands. These allow you to print
65938687ae6SSimon Glass		out the driver model tree and the uclasses.
66038687ae6SSimon Glass
66138687ae6SSimon Glass		CONFIG_DM_DEMO
66238687ae6SSimon Glass
66338687ae6SSimon Glass		Enable some demo devices and the 'demo' command. These are
66438687ae6SSimon Glass		really only useful for playing around while trying to
66538687ae6SSimon Glass		understand driver model in sandbox.
66638687ae6SSimon Glass
66738687ae6SSimon Glass		CONFIG_SPL_DM
66838687ae6SSimon Glass
66938687ae6SSimon Glass		Enable driver model in SPL. You will need to provide a
67038687ae6SSimon Glass		suitable malloc() implementation. If you are not using the
67138687ae6SSimon Glass		full malloc() enabled by CONFIG_SYS_SPL_MALLOC_START,
67238687ae6SSimon Glass		consider using CONFIG_SYS_MALLOC_SIMPLE. In that case you
67338687ae6SSimon Glass		must provide CONFIG_SYS_MALLOC_F_LEN to set the size.
67438687ae6SSimon Glass		In most cases driver model will only allocate a few uclasses
67538687ae6SSimon Glass		and devices in SPL, so 1KB should be enable. See
67638687ae6SSimon Glass		CONFIG_SYS_MALLOC_F_LEN for more details on how to enable
67738687ae6SSimon Glass		it.
67838687ae6SSimon Glass
67938687ae6SSimon Glass		CONFIG_DM_SERIAL
68038687ae6SSimon Glass
68138687ae6SSimon Glass		Enable driver model for serial. This replaces
68238687ae6SSimon Glass		drivers/serial/serial.c with the serial uclass, which
68338687ae6SSimon Glass		implements serial_putc() etc. The uclass interface is
68438687ae6SSimon Glass		defined in include/serial.h.
68538687ae6SSimon Glass
68638687ae6SSimon Glass		CONFIG_DM_GPIO
68738687ae6SSimon Glass
68838687ae6SSimon Glass		Enable driver model for GPIO access. The standard GPIO
68938687ae6SSimon Glass		interface (gpio_get_value(), etc.) is then implemented by
69038687ae6SSimon Glass		the GPIO uclass. Drivers provide methods to query the
69138687ae6SSimon Glass		particular GPIOs that they provide. The uclass interface
69238687ae6SSimon Glass		is defined in include/asm-generic/gpio.h.
69338687ae6SSimon Glass
69438687ae6SSimon Glass		CONFIG_DM_SPI
69538687ae6SSimon Glass
69638687ae6SSimon Glass		Enable driver model for SPI. The SPI slave interface
69738687ae6SSimon Glass		(spi_setup_slave(), spi_xfer(), etc.) is then implemented by
69838687ae6SSimon Glass		the SPI uclass. Drivers provide methods to access the SPI
69938687ae6SSimon Glass		buses that they control. The uclass interface is defined in
70038687ae6SSimon Glass		include/spi.h. The existing spi_slave structure is attached
70138687ae6SSimon Glass		as 'parent data' to every slave on each bus. Slaves
70238687ae6SSimon Glass		typically use driver-private data instead of extending the
70338687ae6SSimon Glass		spi_slave structure.
70438687ae6SSimon Glass
70538687ae6SSimon Glass		CONFIG_DM_SPI_FLASH
70638687ae6SSimon Glass
70738687ae6SSimon Glass		Enable driver model for SPI flash. This SPI flash interface
70838687ae6SSimon Glass		(spi_flash_probe(), spi_flash_write(), etc.) is then
70938687ae6SSimon Glass		implemented by the SPI flash uclass. There is one standard
71038687ae6SSimon Glass		SPI flash driver which knows how to probe most chips
71138687ae6SSimon Glass		supported by U-Boot. The uclass interface is defined in
71238687ae6SSimon Glass		include/spi_flash.h, but is currently fully compatible
71338687ae6SSimon Glass		with the old interface to avoid confusion and duplication
71438687ae6SSimon Glass		during the transition parent. SPI and SPI flash must be
71538687ae6SSimon Glass		enabled together (it is not possible to use driver model
71638687ae6SSimon Glass		for one and not the other).
71738687ae6SSimon Glass
71838687ae6SSimon Glass		CONFIG_DM_CROS_EC
71938687ae6SSimon Glass
72038687ae6SSimon Glass		Enable driver model for the Chrome OS EC interface. This
72138687ae6SSimon Glass		allows the cros_ec SPI driver to operate with CONFIG_DM_SPI
72238687ae6SSimon Glass		but otherwise makes few changes. Since cros_ec also supports
72338687ae6SSimon Glass		I2C and LPC (which don't support driver model yet), a full
72438687ae6SSimon Glass		conversion is not yet possible.
72538687ae6SSimon Glass
72638687ae6SSimon Glass
72738687ae6SSimon Glass		** Code size options: The following options are enabled by
72838687ae6SSimon Glass		default except in SPL. Enable them explicitly to get these
72938687ae6SSimon Glass		features in SPL.
73038687ae6SSimon Glass
73138687ae6SSimon Glass		CONFIG_DM_WARN
73238687ae6SSimon Glass
73338687ae6SSimon Glass		Enable the dm_warn() function. This can use up quite a bit
73438687ae6SSimon Glass		of space for its strings.
73538687ae6SSimon Glass
73638687ae6SSimon Glass		CONFIG_DM_STDIO
73738687ae6SSimon Glass
73838687ae6SSimon Glass		Enable registering a serial device with the stdio library.
73938687ae6SSimon Glass
74038687ae6SSimon Glass		CONFIG_DM_DEVICE_REMOVE
74138687ae6SSimon Glass
74238687ae6SSimon Glass		Enable removing of devices.
74338687ae6SSimon Glass
74438687ae6SSimon Glass
7455da627a4Swdenk- Linux Kernel Interface:
746c609719bSwdenk		CONFIG_CLOCKS_IN_MHZ
747c609719bSwdenk
748c609719bSwdenk		U-Boot stores all clock information in Hz
749c609719bSwdenk		internally. For binary compatibility with older Linux
750c609719bSwdenk		kernels (which expect the clocks passed in the
751c609719bSwdenk		bd_info data to be in MHz) the environment variable
752c609719bSwdenk		"clocks_in_mhz" can be defined so that U-Boot
753c609719bSwdenk		converts clock data to MHZ before passing it to the
754c609719bSwdenk		Linux kernel.
755c609719bSwdenk		When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
756c609719bSwdenk		"clocks_in_mhz=1" is automatically included in the
757c609719bSwdenk		default environment.
758c609719bSwdenk
7595da627a4Swdenk		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]
7605da627a4Swdenk
761b445bbb4SJeremiah Mahler		When transferring memsize parameter to Linux, some versions
7625da627a4Swdenk		expect it to be in bytes, others in MB.
7635da627a4Swdenk		Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
7645da627a4Swdenk
765fec6d9eeSGerald Van Baren		CONFIG_OF_LIBFDT
766f57f70aaSWolfgang Denk
767f57f70aaSWolfgang Denk		New kernel versions are expecting firmware settings to be
768213bf8c8SGerald Van Baren		passed using flattened device trees (based on open firmware
769213bf8c8SGerald Van Baren		concepts).
770213bf8c8SGerald Van Baren
771213bf8c8SGerald Van Baren		CONFIG_OF_LIBFDT
772213bf8c8SGerald Van Baren		 * New libfdt-based support
773213bf8c8SGerald Van Baren		 * Adds the "fdt" command
7743bb342fcSKim Phillips		 * The bootm command automatically updates the fdt
775213bf8c8SGerald Van Baren
776b55ae402SMarcel Ziswiler		OF_CPU - The proper name of the cpus node (only required for
777b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
778b55ae402SMarcel Ziswiler		OF_SOC - The proper name of the soc node (only required for
779b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
780f57f70aaSWolfgang Denk		OF_TBCLK - The timebase frequency.
781c2871f03SKumar Gala		OF_STDOUT_PATH - The path to the console device
782f57f70aaSWolfgang Denk
78311ccc33fSMarcel Ziswiler		boards with QUICC Engines require OF_QE to set UCC MAC
78411ccc33fSMarcel Ziswiler		addresses
7853bb342fcSKim Phillips
7864e253137SKumar Gala		CONFIG_OF_BOARD_SETUP
7874e253137SKumar Gala
7884e253137SKumar Gala		Board code has addition modification that it wants to make
7894e253137SKumar Gala		to the flat device tree before handing it off to the kernel
7906705d81eSwdenk
791c654b517SSimon Glass		CONFIG_OF_SYSTEM_SETUP
792c654b517SSimon Glass
793c654b517SSimon Glass		Other code has addition modification that it wants to make
794c654b517SSimon Glass		to the flat device tree before handing it off to the kernel.
795c654b517SSimon Glass		This causes ft_system_setup() to be called before booting
796c654b517SSimon Glass		the kernel.
797c654b517SSimon Glass
7980267768eSMatthew McClintock		CONFIG_OF_BOOT_CPU
7990267768eSMatthew McClintock
80011ccc33fSMarcel Ziswiler		This define fills in the correct boot CPU in the boot
8010267768eSMatthew McClintock		param header, the default value is zero if undefined.
8020267768eSMatthew McClintock
8033887c3fbSHeiko Schocher		CONFIG_OF_IDE_FIXUP
8043887c3fbSHeiko Schocher
8053887c3fbSHeiko Schocher		U-Boot can detect if an IDE device is present or not.
8063887c3fbSHeiko Schocher		If not, and this new config option is activated, U-Boot
8073887c3fbSHeiko Schocher		removes the ATA node from the DTS before booting Linux,
8083887c3fbSHeiko Schocher		so the Linux IDE driver does not probe the device and
8093887c3fbSHeiko Schocher		crash. This is needed for buggy hardware (uc101) where
8103887c3fbSHeiko Schocher		no pull down resistor is connected to the signal IDE5V_DD7.
8113887c3fbSHeiko Schocher
8127eb29398SIgor Grinberg		CONFIG_MACH_TYPE	[relevant for ARM only][mandatory]
8137eb29398SIgor Grinberg
8147eb29398SIgor Grinberg		This setting is mandatory for all boards that have only one
8157eb29398SIgor Grinberg		machine type and must be used to specify the machine type
8167eb29398SIgor Grinberg		number as it appears in the ARM machine registry
8177eb29398SIgor Grinberg		(see http://www.arm.linux.org.uk/developer/machines/).
8187eb29398SIgor Grinberg		Only boards that have multiple machine types supported
8197eb29398SIgor Grinberg		in a single configuration file and the machine type is
8207eb29398SIgor Grinberg		runtime discoverable, do not have to use this setting.
8217eb29398SIgor Grinberg
8220b2f4ecaSNiklaus Giger- vxWorks boot parameters:
8230b2f4ecaSNiklaus Giger
8240b2f4ecaSNiklaus Giger		bootvx constructs a valid bootline using the following
8250b2f4ecaSNiklaus Giger		environments variables: bootfile, ipaddr, serverip, hostname.
8260b2f4ecaSNiklaus Giger		It loads the vxWorks image pointed bootfile.
8270b2f4ecaSNiklaus Giger
8280b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
8290b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
8300b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
8310b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
8320b2f4ecaSNiklaus Giger
8330b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_ADD_PARAMS
8340b2f4ecaSNiklaus Giger
8350b2f4ecaSNiklaus Giger		Add it at the end of the bootline. E.g "u=username pw=secret"
8360b2f4ecaSNiklaus Giger
8370b2f4ecaSNiklaus Giger		Note: If a "bootargs" environment is defined, it will overwride
8380b2f4ecaSNiklaus Giger		the defaults discussed just above.
8390b2f4ecaSNiklaus Giger
8402c451f78SAneesh V- Cache Configuration:
8412c451f78SAneesh V		CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
8422c451f78SAneesh V		CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
8432c451f78SAneesh V		CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
8442c451f78SAneesh V
84593bc2193SAneesh V- Cache Configuration for ARM:
84693bc2193SAneesh V		CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
84793bc2193SAneesh V				      controller
84893bc2193SAneesh V		CONFIG_SYS_PL310_BASE - Physical base address of PL310
84993bc2193SAneesh V					controller register space
85093bc2193SAneesh V
8516705d81eSwdenk- Serial Ports:
85248d0192fSAndreas Engel		CONFIG_PL010_SERIAL
8536705d81eSwdenk
8546705d81eSwdenk		Define this if you want support for Amba PrimeCell PL010 UARTs.
8556705d81eSwdenk
85648d0192fSAndreas Engel		CONFIG_PL011_SERIAL
8576705d81eSwdenk
8586705d81eSwdenk		Define this if you want support for Amba PrimeCell PL011 UARTs.
8596705d81eSwdenk
8606705d81eSwdenk		CONFIG_PL011_CLOCK
8616705d81eSwdenk
8626705d81eSwdenk		If you have Amba PrimeCell PL011 UARTs, set this variable to
8636705d81eSwdenk		the clock speed of the UARTs.
8646705d81eSwdenk
8656705d81eSwdenk		CONFIG_PL01x_PORTS
8666705d81eSwdenk
8676705d81eSwdenk		If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
8686705d81eSwdenk		define this to a list of base addresses for each (supported)
8696705d81eSwdenk		port. See e.g. include/configs/versatile.h
8706705d81eSwdenk
871910f1ae3SJohn Rigby		CONFIG_PL011_SERIAL_RLCR
872910f1ae3SJohn Rigby
873910f1ae3SJohn Rigby		Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
874910f1ae3SJohn Rigby		have separate receive and transmit line control registers.  Set
875910f1ae3SJohn Rigby		this variable to initialize the extra register.
876910f1ae3SJohn Rigby
877910f1ae3SJohn Rigby		CONFIG_PL011_SERIAL_FLUSH_ON_INIT
878910f1ae3SJohn Rigby
879910f1ae3SJohn Rigby		On some platforms (e.g. U8500) U-Boot is loaded by a second stage
880910f1ae3SJohn Rigby		boot loader that has already initialized the UART.  Define this
881910f1ae3SJohn Rigby		variable to flush the UART at init time.
882910f1ae3SJohn Rigby
883d57dee57SKaricheri, Muralidharan		CONFIG_SERIAL_HW_FLOW_CONTROL
884d57dee57SKaricheri, Muralidharan
885d57dee57SKaricheri, Muralidharan		Define this variable to enable hw flow control in serial driver.
886d57dee57SKaricheri, Muralidharan		Current user of this option is drivers/serial/nsl16550.c driver
8876705d81eSwdenk
888c609719bSwdenk- Console Interface:
889c609719bSwdenk		Depending on board, define exactly one serial port
890c609719bSwdenk		(like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
891c609719bSwdenk		CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
892c609719bSwdenk		console by defining CONFIG_8xx_CONS_NONE
893c609719bSwdenk
894c609719bSwdenk		Note: if CONFIG_8xx_CONS_NONE is defined, the serial
895c609719bSwdenk		port routines must be defined elsewhere
896c609719bSwdenk		(i.e. serial_init(), serial_getc(), ...)
897c609719bSwdenk
898c609719bSwdenk		CONFIG_CFB_CONSOLE
899c609719bSwdenk		Enables console device for a color framebuffer. Needs following
900c53043b7SWolfgang Denk		defines (cf. smiLynxEM, i8042)
901c609719bSwdenk			VIDEO_FB_LITTLE_ENDIAN	graphic memory organisation
902c609719bSwdenk						(default big endian)
903c609719bSwdenk			VIDEO_HW_RECTFILL	graphic chip supports
904c609719bSwdenk						rectangle fill
905c609719bSwdenk						(cf. smiLynxEM)
906c609719bSwdenk			VIDEO_HW_BITBLT		graphic chip supports
907c609719bSwdenk						bit-blit (cf. smiLynxEM)
908c609719bSwdenk			VIDEO_VISIBLE_COLS	visible pixel columns
909c609719bSwdenk						(cols=pitch)
910c609719bSwdenk			VIDEO_VISIBLE_ROWS	visible pixel rows
911c609719bSwdenk			VIDEO_PIXEL_SIZE	bytes per pixel
912c609719bSwdenk			VIDEO_DATA_FORMAT	graphic data format
913c609719bSwdenk						(0-5, cf. cfb_console.c)
914c609719bSwdenk			VIDEO_FB_ADRS		framebuffer address
915c609719bSwdenk			VIDEO_KBD_INIT_FCT	keyboard int fct
916c609719bSwdenk						(i.e. i8042_kbd_init())
917c609719bSwdenk			VIDEO_TSTC_FCT		test char fct
918c609719bSwdenk						(i.e. i8042_tstc)
919c609719bSwdenk			VIDEO_GETC_FCT		get char fct
920c609719bSwdenk						(i.e. i8042_getc)
921c609719bSwdenk			CONFIG_CONSOLE_CURSOR	cursor drawing on/off
922c609719bSwdenk						(requires blink timer
923c609719bSwdenk						cf. i8042.c)
9246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
925c609719bSwdenk			CONFIG_CONSOLE_TIME	display time/date info in
926c609719bSwdenk						upper right corner
927602ad3b3SJon Loeliger						(requires CONFIG_CMD_DATE)
928c609719bSwdenk			CONFIG_VIDEO_LOGO	display Linux logo in
929c609719bSwdenk						upper left corner
930a6c7ad2fSwdenk			CONFIG_VIDEO_BMP_LOGO	use bmp_logo.h instead of
931a6c7ad2fSwdenk						linux_logo.h for logo.
932a6c7ad2fSwdenk						Requires CONFIG_VIDEO_LOGO
933c609719bSwdenk			CONFIG_CONSOLE_EXTRA_INFO
93411ccc33fSMarcel Ziswiler						additional board info beside
935c609719bSwdenk						the logo
936c609719bSwdenk
93733a35bbbSPali Rohár		When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
93833a35bbbSPali Rohár		a limited number of ANSI escape sequences (cursor control,
93933a35bbbSPali Rohár		erase functions and limited graphics rendition control).
94033a35bbbSPali Rohár
941c609719bSwdenk		When CONFIG_CFB_CONSOLE is defined, video console is
942c609719bSwdenk		default i/o. Serial console can be forced with
943c609719bSwdenk		environment 'console=serial'.
944c609719bSwdenk
945a3ad8e26Swdenk		When CONFIG_SILENT_CONSOLE is defined, all console
946a3ad8e26Swdenk		messages (by U-Boot and Linux!) can be silenced with
947a3ad8e26Swdenk		the "silent" environment variable. See
948a3ad8e26Swdenk		doc/README.silent for more information.
949a3ad8e26Swdenk
95045ae2546SHeiko Schocher		CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default
95145ae2546SHeiko Schocher			is 0x00.
95245ae2546SHeiko Schocher		CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default
95345ae2546SHeiko Schocher			is 0xa0.
95445ae2546SHeiko Schocher
955c609719bSwdenk- Console Baudrate:
956c609719bSwdenk		CONFIG_BAUDRATE - in bps
957c609719bSwdenk		Select one of the baudrates listed in
9586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
9596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
960c609719bSwdenk
961c92fac91SHeiko Schocher- Console Rx buffer length
962c92fac91SHeiko Schocher		With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
963c92fac91SHeiko Schocher		the maximum receive buffer length for the SMC.
9642b3f12c2SHeiko Schocher		This option is actual only for 82xx and 8xx possible.
965c92fac91SHeiko Schocher		If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
966c92fac91SHeiko Schocher		must be defined, to setup the maximum idle timeout for
967c92fac91SHeiko Schocher		the SMC.
968c92fac91SHeiko Schocher
9699558b48aSGraeme Russ- Pre-Console Buffer:
9709558b48aSGraeme Russ		Prior to the console being initialised (i.e. serial UART
9719558b48aSGraeme Russ		initialised etc) all console output is silently discarded.
9729558b48aSGraeme Russ		Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
9739558b48aSGraeme Russ		buffer any console messages prior to the console being
9749558b48aSGraeme Russ		initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
9759558b48aSGraeme Russ		bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
9769558b48aSGraeme Russ		a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
9779558b48aSGraeme Russ		bytes are output before the console is initialised, the
9789558b48aSGraeme Russ		earlier bytes are discarded.
9799558b48aSGraeme Russ
9809558b48aSGraeme Russ		'Sane' compilers will generate smaller code if
9819558b48aSGraeme Russ		CONFIG_PRE_CON_BUF_SZ is a power of 2
9829558b48aSGraeme Russ
983046a37bdSSonny Rao- Safe printf() functions
984046a37bdSSonny Rao		Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
985046a37bdSSonny Rao		the printf() functions. These are defined in
986046a37bdSSonny Rao		include/vsprintf.h and include snprintf(), vsnprintf() and
987046a37bdSSonny Rao		so on. Code size increase is approximately 300-500 bytes.
988046a37bdSSonny Rao		If this option is not given then these functions will
989046a37bdSSonny Rao		silently discard their buffer size argument - this means
990046a37bdSSonny Rao		you are not getting any overflow checking in this case.
991046a37bdSSonny Rao
992c609719bSwdenk- Boot Delay:	CONFIG_BOOTDELAY - in seconds
993c609719bSwdenk		Delay before automatically booting the default image;
994c609719bSwdenk		set to -1 to disable autoboot.
99593d7212fSJoe Hershberger		set to -2 to autoboot with no delay and not check for abort
99693d7212fSJoe Hershberger		(even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
997c609719bSwdenk
998c609719bSwdenk		See doc/README.autoboot for these options that
999c609719bSwdenk		work with CONFIG_BOOTDELAY. None are required.
1000c609719bSwdenk		CONFIG_BOOT_RETRY_TIME
1001c609719bSwdenk		CONFIG_BOOT_RETRY_MIN
1002c609719bSwdenk		CONFIG_AUTOBOOT_KEYED
1003c609719bSwdenk		CONFIG_AUTOBOOT_PROMPT
1004c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR
1005c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR
1006c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR2
1007c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR2
1008c609719bSwdenk		CONFIG_ZERO_BOOTDELAY_CHECK
1009c609719bSwdenk		CONFIG_RESET_TO_RETRY
1010c609719bSwdenk
1011c609719bSwdenk- Autoboot Command:
1012c609719bSwdenk		CONFIG_BOOTCOMMAND
1013c609719bSwdenk		Only needed when CONFIG_BOOTDELAY is enabled;
1014c609719bSwdenk		define a command string that is automatically executed
1015c609719bSwdenk		when no character is read on the console interface
1016c609719bSwdenk		within "Boot Delay" after reset.
1017c609719bSwdenk
1018c609719bSwdenk		CONFIG_BOOTARGS
1019c609719bSwdenk		This can be used to pass arguments to the bootm
1020c609719bSwdenk		command. The value of CONFIG_BOOTARGS goes into the
1021c609719bSwdenk		environment value "bootargs".
1022c609719bSwdenk
1023c609719bSwdenk		CONFIG_RAMBOOT and CONFIG_NFSBOOT
1024c609719bSwdenk		The value of these goes into the environment as
1025c609719bSwdenk		"ramboot" and "nfsboot" respectively, and can be used
1026c609719bSwdenk		as a convenience, when switching between booting from
102711ccc33fSMarcel Ziswiler		RAM and NFS.
1028c609719bSwdenk
1029eda0ba38SHeiko Schocher- Bootcount:
1030eda0ba38SHeiko Schocher		CONFIG_BOOTCOUNT_LIMIT
1031eda0ba38SHeiko Schocher		Implements a mechanism for detecting a repeating reboot
1032eda0ba38SHeiko Schocher		cycle, see:
1033eda0ba38SHeiko Schocher		http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
1034eda0ba38SHeiko Schocher
1035eda0ba38SHeiko Schocher		CONFIG_BOOTCOUNT_ENV
1036eda0ba38SHeiko Schocher		If no softreset save registers are found on the hardware
1037eda0ba38SHeiko Schocher		"bootcount" is stored in the environment. To prevent a
1038eda0ba38SHeiko Schocher		saveenv on all reboots, the environment variable
1039eda0ba38SHeiko Schocher		"upgrade_available" is used. If "upgrade_available" is
1040eda0ba38SHeiko Schocher		0, "bootcount" is always 0, if "upgrade_available" is
1041eda0ba38SHeiko Schocher		1 "bootcount" is incremented in the environment.
1042eda0ba38SHeiko Schocher		So the Userspace Applikation must set the "upgrade_available"
1043eda0ba38SHeiko Schocher		and "bootcount" variable to 0, if a boot was successfully.
1044eda0ba38SHeiko Schocher
1045c609719bSwdenk- Pre-Boot Commands:
1046c609719bSwdenk		CONFIG_PREBOOT
1047c609719bSwdenk
1048c609719bSwdenk		When this option is #defined, the existence of the
1049c609719bSwdenk		environment variable "preboot" will be checked
1050c609719bSwdenk		immediately before starting the CONFIG_BOOTDELAY
1051c609719bSwdenk		countdown and/or running the auto-boot command resp.
1052c609719bSwdenk		entering interactive mode.
1053c609719bSwdenk
1054c609719bSwdenk		This feature is especially useful when "preboot" is
1055c609719bSwdenk		automatically generated or modified. For an example
1056c609719bSwdenk		see the LWMON board specific code: here "preboot" is
1057c609719bSwdenk		modified when the user holds down a certain
1058c609719bSwdenk		combination of keys on the (special) keyboard when
1059c609719bSwdenk		booting the systems
1060c609719bSwdenk
1061c609719bSwdenk- Serial Download Echo Mode:
1062c609719bSwdenk		CONFIG_LOADS_ECHO
1063c609719bSwdenk		If defined to 1, all characters received during a
1064c609719bSwdenk		serial download (using the "loads" command) are
1065c609719bSwdenk		echoed back. This might be needed by some terminal
1066c609719bSwdenk		emulations (like "cu"), but may as well just take
1067c609719bSwdenk		time on others. This setting #define's the initial
1068c609719bSwdenk		value of the "loads_echo" environment variable.
1069c609719bSwdenk
1070602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
1071c609719bSwdenk		CONFIG_KGDB_BAUDRATE
1072c609719bSwdenk		Select one of the baudrates listed in
10736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
1074c609719bSwdenk
1075c609719bSwdenk- Monitor Functions:
1076602ad3b3SJon Loeliger		Monitor commands can be included or excluded
1077602ad3b3SJon Loeliger		from the build by using the #include files
1078c6c621bdSStephen Warren		<config_cmd_all.h> and #undef'ing unwanted
1079c6c621bdSStephen Warren		commands, or using <config_cmd_default.h>
1080602ad3b3SJon Loeliger		and augmenting with additional #define's
1081602ad3b3SJon Loeliger		for wanted commands.
1082c609719bSwdenk
1083602ad3b3SJon Loeliger		The default command configuration includes all commands
1084602ad3b3SJon Loeliger		except those marked below with a "*".
1085602ad3b3SJon Loeliger
1086b401b73dSMarek Vasut		CONFIG_CMD_AES		  AES 128 CBC encrypt/decrypt
1087602ad3b3SJon Loeliger		CONFIG_CMD_ASKENV	* ask for env variable
1088602ad3b3SJon Loeliger		CONFIG_CMD_BDI		  bdinfo
1089602ad3b3SJon Loeliger		CONFIG_CMD_BEDBUG	* Include BedBug Debugger
1090602ad3b3SJon Loeliger		CONFIG_CMD_BMP		* BMP support
1091602ad3b3SJon Loeliger		CONFIG_CMD_BSP		* Board specific commands
1092602ad3b3SJon Loeliger		CONFIG_CMD_BOOTD	  bootd
1093d2b2ffe3STom Rini		CONFIG_CMD_BOOTI	* ARM64 Linux kernel Image support
1094602ad3b3SJon Loeliger		CONFIG_CMD_CACHE	* icache, dcache
109508d0d6f3SMichal Simek		CONFIG_CMD_CLK   	* clock command support
1096602ad3b3SJon Loeliger		CONFIG_CMD_CONSOLE	  coninfo
1097710b9938SMike Frysinger		CONFIG_CMD_CRC32	* crc32
1098602ad3b3SJon Loeliger		CONFIG_CMD_DATE		* support for RTC, date/time...
1099602ad3b3SJon Loeliger		CONFIG_CMD_DHCP		* DHCP support
1100602ad3b3SJon Loeliger		CONFIG_CMD_DIAG		* Diagnostics
1101a7c93104SPeter Tyser		CONFIG_CMD_DS4510	* ds4510 I2C gpio commands
1102a7c93104SPeter Tyser		CONFIG_CMD_DS4510_INFO	* ds4510 I2C info command
1103a7c93104SPeter Tyser		CONFIG_CMD_DS4510_MEM	* ds4510 I2C eeprom/sram commansd
1104a7c93104SPeter Tyser		CONFIG_CMD_DS4510_RST	* ds4510 I2C rst command
1105602ad3b3SJon Loeliger		CONFIG_CMD_DTT		* Digital Therm and Thermostat
1106602ad3b3SJon Loeliger		CONFIG_CMD_ECHO		  echo arguments
1107246c6922SPeter Tyser		CONFIG_CMD_EDITENV	  edit env variable
1108602ad3b3SJon Loeliger		CONFIG_CMD_EEPROM	* EEPROM read/write support
1109602ad3b3SJon Loeliger		CONFIG_CMD_ELF		* bootelf, bootvx
11105e2b3e0cSJoe Hershberger		CONFIG_CMD_ENV_CALLBACK	* display details about env callbacks
1111fffad71bSJoe Hershberger		CONFIG_CMD_ENV_FLAGS	* display details about env flags
111288733e2cSAndrew Ruder		CONFIG_CMD_ENV_EXISTS	* check existence of env variable
11130c79cda0SMike Frysinger		CONFIG_CMD_EXPORTENV	* export the environment
111403e2ecf6SStephen Warren		CONFIG_CMD_EXT2		* ext2 command support
111503e2ecf6SStephen Warren		CONFIG_CMD_EXT4		* ext4 command support
111616f4d933SStephen Warren		CONFIG_CMD_FS_GENERIC	* filesystem commands (e.g. load, ls)
111716f4d933SStephen Warren					  that work for multiple fs types
111859e890efSChristian Gmeiner		CONFIG_CMD_FS_UUID	* Look up a filesystem UUID
1119bdab39d3SMike Frysinger		CONFIG_CMD_SAVEENV	  saveenv
1120602ad3b3SJon Loeliger		CONFIG_CMD_FDC		* Floppy Disk Support
112103e2ecf6SStephen Warren		CONFIG_CMD_FAT		* FAT command support
1122602ad3b3SJon Loeliger		CONFIG_CMD_FLASH	  flinfo, erase, protect
1123602ad3b3SJon Loeliger		CONFIG_CMD_FPGA		  FPGA device initialization support
11244d98b5c8SVincent Stehlé		CONFIG_CMD_FUSE		* Device fuse support
112553fdc7efSAnton Staaf		CONFIG_CMD_GETTIME	* Get time since boot
1126a641b979SMike Frysinger		CONFIG_CMD_GO		* the 'go' command (exec code)
1127a000b795SKim Phillips		CONFIG_CMD_GREPENV	* search environment
1128bf36c5d5SSimon Glass		CONFIG_CMD_HASH		* calculate hash / digest
1129602ad3b3SJon Loeliger		CONFIG_CMD_HWFLOW	* RTS/CTS hw flow control
1130602ad3b3SJon Loeliger		CONFIG_CMD_I2C		* I2C serial bus support
1131602ad3b3SJon Loeliger		CONFIG_CMD_IDE		* IDE harddisk support
1132602ad3b3SJon Loeliger		CONFIG_CMD_IMI		  iminfo
11338fdf1e0fSVipin Kumar		CONFIG_CMD_IMLS		  List all images found in NOR flash
11344d98b5c8SVincent Stehlé		CONFIG_CMD_IMLS_NAND	* List all images found in NAND flash
1135602ad3b3SJon Loeliger		CONFIG_CMD_IMMAP	* IMMR dump support
1136aa53233aSSimon Glass		CONFIG_CMD_IOTRACE	* I/O tracing for debugging
11370c79cda0SMike Frysinger		CONFIG_CMD_IMPORTENV	* import an environment
1138c167cc02SJoe Hershberger		CONFIG_CMD_INI		* import data from an ini file into the env
1139602ad3b3SJon Loeliger		CONFIG_CMD_IRQ		* irqinfo
1140602ad3b3SJon Loeliger		CONFIG_CMD_ITEST	  Integer/string test of 2 values
1141602ad3b3SJon Loeliger		CONFIG_CMD_JFFS2	* JFFS2 Support
1142602ad3b3SJon Loeliger		CONFIG_CMD_KGDB		* kgdb
11434d98b5c8SVincent Stehlé		CONFIG_CMD_LDRINFO	* ldrinfo (display Blackfin loader)
1144d22c338eSJoe Hershberger		CONFIG_CMD_LINK_LOCAL	* link-local IP address auto-configuration
1145d22c338eSJoe Hershberger					  (169.254.*.*)
1146602ad3b3SJon Loeliger		CONFIG_CMD_LOADB	  loadb
1147602ad3b3SJon Loeliger		CONFIG_CMD_LOADS	  loads
11484d98b5c8SVincent Stehlé		CONFIG_CMD_MD5SUM	* print md5 message digest
114902c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
115015a33e49SSimon Glass		CONFIG_CMD_MEMINFO	* Display detailed memory information
1151602ad3b3SJon Loeliger		CONFIG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
1152a2681707SWolfgang Denk					  loop, loopw
11534d98b5c8SVincent Stehlé		CONFIG_CMD_MEMTEST	* mtest
1154602ad3b3SJon Loeliger		CONFIG_CMD_MISC		  Misc functions like sleep etc
1155602ad3b3SJon Loeliger		CONFIG_CMD_MMC		* MMC memory mapped support
1156602ad3b3SJon Loeliger		CONFIG_CMD_MII		* MII utility commands
115768d7d651SStefan Roese		CONFIG_CMD_MTDPARTS	* MTD partition support
1158602ad3b3SJon Loeliger		CONFIG_CMD_NAND		* NAND support
1159602ad3b3SJon Loeliger		CONFIG_CMD_NET		  bootp, tftpboot, rarpboot
11604d98b5c8SVincent Stehlé		CONFIG_CMD_NFS		  NFS support
1161e92739d3SPeter Tyser		CONFIG_CMD_PCA953X	* PCA953x I2C gpio commands
1162e92739d3SPeter Tyser		CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
1163602ad3b3SJon Loeliger		CONFIG_CMD_PCI		* pciinfo
1164602ad3b3SJon Loeliger		CONFIG_CMD_PCMCIA		* PCMCIA support
1165602ad3b3SJon Loeliger		CONFIG_CMD_PING		* send ICMP ECHO_REQUEST to network
1166602ad3b3SJon Loeliger					  host
1167602ad3b3SJon Loeliger		CONFIG_CMD_PORTIO	* Port I/O
1168ff048ea9SKenneth Waters		CONFIG_CMD_READ		* Read raw data from partition
1169602ad3b3SJon Loeliger		CONFIG_CMD_REGINFO	* Register dump
1170602ad3b3SJon Loeliger		CONFIG_CMD_RUN		  run command in env variable
1171d304931fSSimon Glass		CONFIG_CMD_SANDBOX	* sb command to access sandbox features
1172602ad3b3SJon Loeliger		CONFIG_CMD_SAVES	* save S record dump
1173602ad3b3SJon Loeliger		CONFIG_CMD_SCSI		* SCSI Support
1174602ad3b3SJon Loeliger		CONFIG_CMD_SDRAM	* print SDRAM configuration information
1175602ad3b3SJon Loeliger					  (requires CONFIG_CMD_I2C)
1176602ad3b3SJon Loeliger		CONFIG_CMD_SETGETDCR	  Support for DCR Register access
1177602ad3b3SJon Loeliger					  (4xx only)
1178f61ec45eSEric Nelson		CONFIG_CMD_SF		* Read/write/erase SPI NOR flash
11794d98b5c8SVincent Stehlé		CONFIG_CMD_SHA1SUM	* print sha1 memory digest
118002c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY)
11817d861d95SBob Liu		CONFIG_CMD_SOFTSWITCH	* Soft switch setting command for BF60x
118274de7aefSWolfgang Denk		CONFIG_CMD_SOURCE	  "source" command Support
1183602ad3b3SJon Loeliger		CONFIG_CMD_SPI		* SPI serial bus support
11847a83af07SLuca Ceresoli		CONFIG_CMD_TFTPSRV	* TFTP transfer in server mode
11851fb7cd49SSimon Glass		CONFIG_CMD_TFTPPUT	* TFTP put command (upload)
1186da83bcd7SJoe Hershberger		CONFIG_CMD_TIME		* run command and report execution time (ARM specific)
1187da83bcd7SJoe Hershberger		CONFIG_CMD_TIMER	* access to the system tick timer
1188602ad3b3SJon Loeliger		CONFIG_CMD_USB		* USB support
1189602ad3b3SJon Loeliger		CONFIG_CMD_CDP		* Cisco Discover Protocol support
1190c8339f51SMarek Vasut		CONFIG_CMD_MFSL		* Microblaze FSL support
11914d98b5c8SVincent Stehlé		CONFIG_CMD_XIMG		  Load part of Multi Image
119289c8230dSPrzemyslaw Marczak		CONFIG_CMD_UUID		* Generate random UUID or GUID string
1193c609719bSwdenk
1194c609719bSwdenk		EXAMPLE: If you want all functions except of network
1195c609719bSwdenk		support you can write:
1196c609719bSwdenk
1197602ad3b3SJon Loeliger		#include "config_cmd_all.h"
1198602ad3b3SJon Loeliger		#undef CONFIG_CMD_NET
1199c609719bSwdenk
1200213bf8c8SGerald Van Baren	Other Commands:
1201213bf8c8SGerald Van Baren		fdt (flattened device tree) command: CONFIG_OF_LIBFDT
1202c609719bSwdenk
1203c609719bSwdenk	Note:	Don't enable the "icache" and "dcache" commands
1204602ad3b3SJon Loeliger		(configuration option CONFIG_CMD_CACHE) unless you know
1205c609719bSwdenk		what you (and your U-Boot users) are doing. Data
1206c609719bSwdenk		cache cannot be enabled on systems like the 8xx or
1207c609719bSwdenk		8260 (where accesses to the IMMR region must be
1208c609719bSwdenk		uncached), and it cannot be disabled on all other
1209c609719bSwdenk		systems where we (mis-) use the data cache to hold an
1210c609719bSwdenk		initial stack and some data.
1211c609719bSwdenk
1212c609719bSwdenk
1213c609719bSwdenk		XXX - this list needs to get updated!
1214c609719bSwdenk
1215a5ecbe62SWolfgang Denk- Regular expression support:
1216a5ecbe62SWolfgang Denk		CONFIG_REGEX
1217a5ecbe62SWolfgang Denk		If this variable is defined, U-Boot is linked against
1218a5ecbe62SWolfgang Denk		the SLRE (Super Light Regular Expression) library,
1219a5ecbe62SWolfgang Denk		which adds regex support to some commands, as for
1220a5ecbe62SWolfgang Denk		example "env grep" and "setexpr".
1221a5ecbe62SWolfgang Denk
122245ba8077SSimon Glass- Device tree:
122345ba8077SSimon Glass		CONFIG_OF_CONTROL
122445ba8077SSimon Glass		If this variable is defined, U-Boot will use a device tree
122545ba8077SSimon Glass		to configure its devices, instead of relying on statically
122645ba8077SSimon Glass		compiled #defines in the board file. This option is
122745ba8077SSimon Glass		experimental and only available on a few boards. The device
122845ba8077SSimon Glass		tree is available in the global data as gd->fdt_blob.
122945ba8077SSimon Glass
12302c0f79e4SSimon Glass		U-Boot needs to get its device tree from somewhere. This can
12312c0f79e4SSimon Glass		be done using one of the two options below:
1232bbb0b128SSimon Glass
1233bbb0b128SSimon Glass		CONFIG_OF_EMBED
1234bbb0b128SSimon Glass		If this variable is defined, U-Boot will embed a device tree
1235bbb0b128SSimon Glass		binary in its image. This device tree file should be in the
1236bbb0b128SSimon Glass		board directory and called <soc>-<board>.dts. The binary file
1237bbb0b128SSimon Glass		is then picked up in board_init_f() and made available through
1238bbb0b128SSimon Glass		the global data structure as gd->blob.
123945ba8077SSimon Glass
12402c0f79e4SSimon Glass		CONFIG_OF_SEPARATE
12412c0f79e4SSimon Glass		If this variable is defined, U-Boot will build a device tree
12422c0f79e4SSimon Glass		binary. It will be called u-boot.dtb. Architecture-specific
12432c0f79e4SSimon Glass		code will locate it at run-time. Generally this works by:
12442c0f79e4SSimon Glass
12452c0f79e4SSimon Glass			cat u-boot.bin u-boot.dtb >image.bin
12462c0f79e4SSimon Glass
12472c0f79e4SSimon Glass		and in fact, U-Boot does this for you, creating a file called
12482c0f79e4SSimon Glass		u-boot-dtb.bin which is useful in the common case. You can
12492c0f79e4SSimon Glass		still use the individual files if you need something more
12502c0f79e4SSimon Glass		exotic.
12512c0f79e4SSimon Glass
1252c609719bSwdenk- Watchdog:
1253c609719bSwdenk		CONFIG_WATCHDOG
1254c609719bSwdenk		If this variable is defined, it enables watchdog
12556abe6fb6SDetlev Zundel		support for the SoC. There must be support in the SoC
12566abe6fb6SDetlev Zundel		specific code for a watchdog. For the 8xx and 8260
12576abe6fb6SDetlev Zundel		CPUs, the SIU Watchdog feature is enabled in the SYPCR
12586abe6fb6SDetlev Zundel		register.  When supported for a specific SoC is
12596abe6fb6SDetlev Zundel		available, then no further board specific code should
12606abe6fb6SDetlev Zundel		be needed to use it.
12616abe6fb6SDetlev Zundel
12626abe6fb6SDetlev Zundel		CONFIG_HW_WATCHDOG
12636abe6fb6SDetlev Zundel		When using a watchdog circuitry external to the used
12646abe6fb6SDetlev Zundel		SoC, then define this variable and provide board
12656abe6fb6SDetlev Zundel		specific code for the "hw_watchdog_reset" function.
1266c609719bSwdenk
12677bae0d6fSHeiko Schocher		CONFIG_AT91_HW_WDT_TIMEOUT
12687bae0d6fSHeiko Schocher		specify the timeout in seconds. default 2 seconds.
12697bae0d6fSHeiko Schocher
1270c1551ea8Sstroese- U-Boot Version:
1271c1551ea8Sstroese		CONFIG_VERSION_VARIABLE
1272c1551ea8Sstroese		If this variable is defined, an environment variable
1273c1551ea8Sstroese		named "ver" is created by U-Boot showing the U-Boot
1274c1551ea8Sstroese		version as printed by the "version" command.
1275a1ea8e51SBenoît Thébaudeau		Any change to this variable will be reverted at the
1276a1ea8e51SBenoît Thébaudeau		next reset.
1277c1551ea8Sstroese
1278c609719bSwdenk- Real-Time Clock:
1279c609719bSwdenk
1280602ad3b3SJon Loeliger		When CONFIG_CMD_DATE is selected, the type of the RTC
1281c609719bSwdenk		has to be selected, too. Define exactly one of the
1282c609719bSwdenk		following options:
1283c609719bSwdenk
1284c609719bSwdenk		CONFIG_RTC_MPC8xx	- use internal RTC of MPC8xx
1285c609719bSwdenk		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
12864e8b7544SFabio Estevam		CONFIG_RTC_MC13XXX	- use MC13783 or MC13892 RTC
1287c609719bSwdenk		CONFIG_RTC_MC146818	- use MC146818 RTC
12881cb8e980Swdenk		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
1289c609719bSwdenk		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
12907f70e853Swdenk		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
1291412921d2SMarkus Niebel		CONFIG_RTC_DS1339	- use Maxim, Inc. DS1339 RTC
12923bac3513Swdenk		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
12939536dfccSTor Krill		CONFIG_RTC_ISL1208	- use Intersil ISL1208 RTC
12944c0d4c3bSwdenk		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
12956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_DS1337_NOOSC	- Turn off the OSC output for DS1337
129671d19f30SHeiko Schocher		CONFIG_SYS_RV3029_TCR	- enable trickle charger on
129771d19f30SHeiko Schocher					  RV3029 RTC.
1298c609719bSwdenk
1299b37c7e5eSwdenk		Note that if the RTC uses I2C, then the I2C interface
1300b37c7e5eSwdenk		must also be configured. See I2C Support, below.
1301b37c7e5eSwdenk
1302e92739d3SPeter Tyser- GPIO Support:
1303e92739d3SPeter Tyser		CONFIG_PCA953X		- use NXP's PCA953X series I2C GPIO
1304e92739d3SPeter Tyser
13055dec49caSChris Packham		The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
13065dec49caSChris Packham		chip-ngpio pairs that tell the PCA953X driver the number of
13075dec49caSChris Packham		pins supported by a particular chip.
13085dec49caSChris Packham
1309e92739d3SPeter Tyser		Note that if the GPIO device uses I2C, then the I2C interface
1310e92739d3SPeter Tyser		must also be configured. See I2C Support, below.
1311e92739d3SPeter Tyser
1312aa53233aSSimon Glass- I/O tracing:
1313aa53233aSSimon Glass		When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
1314aa53233aSSimon Glass		accesses and can checksum them or write a list of them out
1315aa53233aSSimon Glass		to memory. See the 'iotrace' command for details. This is
1316aa53233aSSimon Glass		useful for testing device drivers since it can confirm that
1317aa53233aSSimon Glass		the driver behaves the same way before and after a code
1318aa53233aSSimon Glass		change. Currently this is supported on sandbox and arm. To
1319aa53233aSSimon Glass		add support for your architecture, add '#include <iotrace.h>'
1320aa53233aSSimon Glass		to the bottom of arch/<arch>/include/asm/io.h and test.
1321aa53233aSSimon Glass
1322aa53233aSSimon Glass		Example output from the 'iotrace stats' command is below.
1323aa53233aSSimon Glass		Note that if the trace buffer is exhausted, the checksum will
1324aa53233aSSimon Glass		still continue to operate.
1325aa53233aSSimon Glass
1326aa53233aSSimon Glass			iotrace is enabled
1327aa53233aSSimon Glass			Start:  10000000	(buffer start address)
1328aa53233aSSimon Glass			Size:   00010000	(buffer size)
1329aa53233aSSimon Glass			Offset: 00000120	(current buffer offset)
1330aa53233aSSimon Glass			Output: 10000120	(start + offset)
1331aa53233aSSimon Glass			Count:  00000018	(number of trace records)
1332aa53233aSSimon Glass			CRC32:  9526fb66	(CRC32 of all trace records)
1333aa53233aSSimon Glass
1334c609719bSwdenk- Timestamp Support:
1335c609719bSwdenk
1336c609719bSwdenk		When CONFIG_TIMESTAMP is selected, the timestamp
1337c609719bSwdenk		(date and time) of an image is printed by image
1338c609719bSwdenk		commands like bootm or iminfo. This option is
1339602ad3b3SJon Loeliger		automatically enabled when you select CONFIG_CMD_DATE .
1340c609719bSwdenk
1341923c46f9SKarl O. Pinc- Partition Labels (disklabels) Supported:
1342923c46f9SKarl O. Pinc		Zero or more of the following:
1343923c46f9SKarl O. Pinc		CONFIG_MAC_PARTITION   Apple's MacOS partition table.
1344923c46f9SKarl O. Pinc		CONFIG_DOS_PARTITION   MS Dos partition table, traditional on the
1345923c46f9SKarl O. Pinc				       Intel architecture, USB sticks, etc.
1346923c46f9SKarl O. Pinc		CONFIG_ISO_PARTITION   ISO partition table, used on CDROM etc.
1347923c46f9SKarl O. Pinc		CONFIG_EFI_PARTITION   GPT partition table, common when EFI is the
1348923c46f9SKarl O. Pinc				       bootloader.  Note 2TB partition limit; see
1349923c46f9SKarl O. Pinc				       disk/part_efi.c
1350923c46f9SKarl O. Pinc		CONFIG_MTD_PARTITIONS  Memory Technology Device partition table.
1351c609719bSwdenk
1352602ad3b3SJon Loeliger		If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1353218ca724SWolfgang Denk		CONFIG_CMD_SCSI) you must configure support for at
1354923c46f9SKarl O. Pinc		least one non-MTD partition type as well.
1355c609719bSwdenk
1356c609719bSwdenk- IDE Reset method:
13574d13cbadSwdenk		CONFIG_IDE_RESET_ROUTINE - this is defined in several
13584d13cbadSwdenk		board configurations files but used nowhere!
1359c609719bSwdenk
13604d13cbadSwdenk		CONFIG_IDE_RESET - is this is defined, IDE Reset will
13614d13cbadSwdenk		be performed by calling the function
13624d13cbadSwdenk			ide_set_reset(int reset)
13634d13cbadSwdenk		which has to be defined in a board specific file
1364c609719bSwdenk
1365c609719bSwdenk- ATAPI Support:
1366c609719bSwdenk		CONFIG_ATAPI
1367c609719bSwdenk
1368c609719bSwdenk		Set this to enable ATAPI support.
1369c609719bSwdenk
1370c40b2956Swdenk- LBA48 Support
1371c40b2956Swdenk		CONFIG_LBA48
1372c40b2956Swdenk
1373c40b2956Swdenk		Set this to enable support for disks larger than 137GB
13744b142febSHeiko Schocher		Also look at CONFIG_SYS_64BIT_LBA.
1375c40b2956Swdenk		Whithout these , LBA48 support uses 32bit variables and will 'only'
1376c40b2956Swdenk		support disks up to 2.1TB.
1377c40b2956Swdenk
13786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_64BIT_LBA:
1379c40b2956Swdenk			When enabled, makes the IDE subsystem use 64bit sector addresses.
1380c40b2956Swdenk			Default is 32bit.
1381c40b2956Swdenk
1382c609719bSwdenk- SCSI Support:
1383c609719bSwdenk		At the moment only there is only support for the
1384c609719bSwdenk		SYM53C8XX SCSI controller; define
1385c609719bSwdenk		CONFIG_SCSI_SYM53C8XX to enable it.
1386c609719bSwdenk
13876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
13886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
13896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
1390c609719bSwdenk		maximum numbers of LUNs, SCSI ID's and target
1391c609719bSwdenk		devices.
13926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
1393c609719bSwdenk
1394447c031bSStefan Reinauer		The environment variable 'scsidevs' is set to the number of
1395447c031bSStefan Reinauer		SCSI devices found during the last scan.
1396447c031bSStefan Reinauer
1397c609719bSwdenk- NETWORK Support (PCI):
1398682011ffSwdenk		CONFIG_E1000
1399ce5207e1SKyle Moffett		Support for Intel 8254x/8257x gigabit chips.
1400ce5207e1SKyle Moffett
1401ce5207e1SKyle Moffett		CONFIG_E1000_SPI
1402ce5207e1SKyle Moffett		Utility code for direct access to the SPI bus on Intel 8257x.
1403ce5207e1SKyle Moffett		This does not do anything useful unless you set at least one
1404ce5207e1SKyle Moffett		of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1405ce5207e1SKyle Moffett
1406ce5207e1SKyle Moffett		CONFIG_E1000_SPI_GENERIC
1407ce5207e1SKyle Moffett		Allow generic access to the SPI bus on the Intel 8257x, for
1408ce5207e1SKyle Moffett		example with the "sspi" command.
1409ce5207e1SKyle Moffett
1410ce5207e1SKyle Moffett		CONFIG_CMD_E1000
1411ce5207e1SKyle Moffett		Management command for E1000 devices.  When used on devices
1412ce5207e1SKyle Moffett		with SPI support you can reprogram the EEPROM from U-Boot.
1413682011ffSwdenk
1414ac3315c2SAndre Schwarz		CONFIG_E1000_FALLBACK_MAC
141511ccc33fSMarcel Ziswiler		default MAC for empty EEPROM after production.
1416ac3315c2SAndre Schwarz
1417c609719bSwdenk		CONFIG_EEPRO100
1418c609719bSwdenk		Support for Intel 82557/82559/82559ER chips.
141911ccc33fSMarcel Ziswiler		Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
1420c609719bSwdenk		write routine for first time initialisation.
1421c609719bSwdenk
1422c609719bSwdenk		CONFIG_TULIP
1423c609719bSwdenk		Support for Digital 2114x chips.
1424c609719bSwdenk		Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1425c609719bSwdenk		modem chip initialisation (KS8761/QS6611).
1426c609719bSwdenk
1427c609719bSwdenk		CONFIG_NATSEMI
1428c609719bSwdenk		Support for National dp83815 chips.
1429c609719bSwdenk
1430c609719bSwdenk		CONFIG_NS8382X
1431c609719bSwdenk		Support for National dp8382[01] gigabit chips.
1432c609719bSwdenk
143345219c46Swdenk- NETWORK Support (other):
143445219c46Swdenk
1435c041e9d2SJens Scharsig		CONFIG_DRIVER_AT91EMAC
1436c041e9d2SJens Scharsig		Support for AT91RM9200 EMAC.
1437c041e9d2SJens Scharsig
1438c041e9d2SJens Scharsig			CONFIG_RMII
1439c041e9d2SJens Scharsig			Define this to use reduced MII inteface
1440c041e9d2SJens Scharsig
1441c041e9d2SJens Scharsig			CONFIG_DRIVER_AT91EMAC_QUIET
1442c041e9d2SJens Scharsig			If this defined, the driver is quiet.
1443c041e9d2SJens Scharsig			The driver doen't show link status messages.
1444c041e9d2SJens Scharsig
1445efdd7319SRob Herring		CONFIG_CALXEDA_XGMAC
1446efdd7319SRob Herring		Support for the Calxeda XGMAC device
1447efdd7319SRob Herring
14483bb46d23SAshok		CONFIG_LAN91C96
144945219c46Swdenk		Support for SMSC's LAN91C96 chips.
145045219c46Swdenk
145145219c46Swdenk			CONFIG_LAN91C96_BASE
145245219c46Swdenk			Define this to hold the physical address
145345219c46Swdenk			of the LAN91C96's I/O space
145445219c46Swdenk
145545219c46Swdenk			CONFIG_LAN91C96_USE_32_BIT
145645219c46Swdenk			Define this to enable 32 bit addressing
145745219c46Swdenk
14583bb46d23SAshok		CONFIG_SMC91111
1459f39748aeSwdenk		Support for SMSC's LAN91C111 chip
1460f39748aeSwdenk
1461f39748aeSwdenk			CONFIG_SMC91111_BASE
1462f39748aeSwdenk			Define this to hold the physical address
1463f39748aeSwdenk			of the device (I/O space)
1464f39748aeSwdenk
1465f39748aeSwdenk			CONFIG_SMC_USE_32_BIT
1466f39748aeSwdenk			Define this if data bus is 32 bits
1467f39748aeSwdenk
1468f39748aeSwdenk			CONFIG_SMC_USE_IOFUNCS
1469f39748aeSwdenk			Define this to use i/o functions instead of macros
1470f39748aeSwdenk			(some hardware wont work with macros)
1471f39748aeSwdenk
1472dc02badaSHeiko Schocher		CONFIG_DRIVER_TI_EMAC
1473dc02badaSHeiko Schocher		Support for davinci emac
1474dc02badaSHeiko Schocher
1475dc02badaSHeiko Schocher			CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1476dc02badaSHeiko Schocher			Define this if you have more then 3 PHYs.
1477dc02badaSHeiko Schocher
1478b3dbf4a5SMacpaul Lin		CONFIG_FTGMAC100
1479b3dbf4a5SMacpaul Lin		Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1480b3dbf4a5SMacpaul Lin
1481b3dbf4a5SMacpaul Lin			CONFIG_FTGMAC100_EGIGA
1482b3dbf4a5SMacpaul Lin			Define this to use GE link update with gigabit PHY.
1483b3dbf4a5SMacpaul Lin			Define this if FTGMAC100 is connected to gigabit PHY.
1484b3dbf4a5SMacpaul Lin			If your system has 10/100 PHY only, it might not occur
1485b3dbf4a5SMacpaul Lin			wrong behavior. Because PHY usually return timeout or
1486b3dbf4a5SMacpaul Lin			useless data when polling gigabit status and gigabit
1487b3dbf4a5SMacpaul Lin			control registers. This behavior won't affect the
1488b3dbf4a5SMacpaul Lin			correctnessof 10/100 link speed update.
1489b3dbf4a5SMacpaul Lin
1490c2fff331SMike Rapoport		CONFIG_SMC911X
1491557b377dSJens Gehrlein		Support for SMSC's LAN911x and LAN921x chips
1492557b377dSJens Gehrlein
1493c2fff331SMike Rapoport			CONFIG_SMC911X_BASE
1494557b377dSJens Gehrlein			Define this to hold the physical address
1495557b377dSJens Gehrlein			of the device (I/O space)
1496557b377dSJens Gehrlein
1497c2fff331SMike Rapoport			CONFIG_SMC911X_32_BIT
1498557b377dSJens Gehrlein			Define this if data bus is 32 bits
1499557b377dSJens Gehrlein
1500c2fff331SMike Rapoport			CONFIG_SMC911X_16_BIT
1501557b377dSJens Gehrlein			Define this if data bus is 16 bits. If your processor
1502557b377dSJens Gehrlein			automatically converts one 32 bit word to two 16 bit
1503c2fff331SMike Rapoport			words you may also try CONFIG_SMC911X_32_BIT.
1504557b377dSJens Gehrlein
15053d0075faSYoshihiro Shimoda		CONFIG_SH_ETHER
15063d0075faSYoshihiro Shimoda		Support for Renesas on-chip Ethernet controller
15073d0075faSYoshihiro Shimoda
15083d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_USE_PORT
15093d0075faSYoshihiro Shimoda			Define the number of ports to be used
15103d0075faSYoshihiro Shimoda
15113d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_PHY_ADDR
15123d0075faSYoshihiro Shimoda			Define the ETH PHY's address
15133d0075faSYoshihiro Shimoda
151468260aabSYoshihiro Shimoda			CONFIG_SH_ETHER_CACHE_WRITEBACK
151568260aabSYoshihiro Shimoda			If this option is set, the driver enables cache flush.
151668260aabSYoshihiro Shimoda
1517b2f97cf2SHeiko Schocher- PWM Support:
1518b2f97cf2SHeiko Schocher		CONFIG_PWM_IMX
1519b2f97cf2SHeiko Schocher		Support for PWM modul on the imx6.
1520b2f97cf2SHeiko Schocher
15215e124724SVadim Bendebury- TPM Support:
152290899cc0SChe-liang Chiou		CONFIG_TPM
152390899cc0SChe-liang Chiou		Support TPM devices.
152490899cc0SChe-liang Chiou
15251b393db5STom Wai-Hong Tam		CONFIG_TPM_TIS_I2C
15261b393db5STom Wai-Hong Tam		Support for i2c bus TPM devices. Only one device
15271b393db5STom Wai-Hong Tam		per system is supported at this time.
15281b393db5STom Wai-Hong Tam
15291b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_BUS_NUMBER
15301b393db5STom Wai-Hong Tam			Define the the i2c bus number for the TPM device
15311b393db5STom Wai-Hong Tam
15321b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS
15331b393db5STom Wai-Hong Tam			Define the TPM's address on the i2c bus
15341b393db5STom Wai-Hong Tam
15351b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_BURST_LIMITATION
15361b393db5STom Wai-Hong Tam			Define the burst count bytes upper limit
15371b393db5STom Wai-Hong Tam
1538c01939c7SDirk Eibach		CONFIG_TPM_ATMEL_TWI
1539c01939c7SDirk Eibach		Support for Atmel TWI TPM device. Requires I2C support.
1540c01939c7SDirk Eibach
154190899cc0SChe-liang Chiou		CONFIG_TPM_TIS_LPC
15425e124724SVadim Bendebury		Support for generic parallel port TPM devices. Only one device
15435e124724SVadim Bendebury		per system is supported at this time.
15445e124724SVadim Bendebury
15455e124724SVadim Bendebury			CONFIG_TPM_TIS_BASE_ADDRESS
15465e124724SVadim Bendebury			Base address where the generic TPM device is mapped
15475e124724SVadim Bendebury			to. Contemporary x86 systems usually map it at
15485e124724SVadim Bendebury			0xfed40000.
15495e124724SVadim Bendebury
1550be6c1529SReinhard Pfau		CONFIG_CMD_TPM
1551be6c1529SReinhard Pfau		Add tpm monitor functions.
1552be6c1529SReinhard Pfau		Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1553be6c1529SReinhard Pfau		provides monitor access to authorized functions.
1554be6c1529SReinhard Pfau
1555be6c1529SReinhard Pfau		CONFIG_TPM
1556be6c1529SReinhard Pfau		Define this to enable the TPM support library which provides
1557be6c1529SReinhard Pfau		functional interfaces to some TPM commands.
1558be6c1529SReinhard Pfau		Requires support for a TPM device.
1559be6c1529SReinhard Pfau
1560be6c1529SReinhard Pfau		CONFIG_TPM_AUTH_SESSIONS
1561be6c1529SReinhard Pfau		Define this to enable authorized functions in the TPM library.
1562be6c1529SReinhard Pfau		Requires CONFIG_TPM and CONFIG_SHA1.
1563be6c1529SReinhard Pfau
1564c609719bSwdenk- USB Support:
1565c609719bSwdenk		At the moment only the UHCI host controller is
15664d13cbadSwdenk		supported (PIP405, MIP405, MPC5200); define
1567c609719bSwdenk		CONFIG_USB_UHCI to enable it.
1568c609719bSwdenk		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
156930d56faeSwdenk		and define CONFIG_USB_STORAGE to enable the USB
1570c609719bSwdenk		storage devices.
1571c609719bSwdenk		Note:
1572c609719bSwdenk		Supported are USB Keyboards and USB Floppy drives
1573c609719bSwdenk		(TEAC FD-05PUB).
15744d13cbadSwdenk		MPC5200 USB requires additional defines:
15754d13cbadSwdenk			CONFIG_USB_CLOCK
15764d13cbadSwdenk				for 528 MHz Clock: 0x0001bbbb
1577307ecb6dSEric Millbrandt			CONFIG_PSC3_USB
1578307ecb6dSEric Millbrandt				for USB on PSC3
15794d13cbadSwdenk			CONFIG_USB_CONFIG
15804d13cbadSwdenk				for differential drivers: 0x00001000
15814d13cbadSwdenk				for single ended drivers: 0x00005000
1582307ecb6dSEric Millbrandt				for differential drivers on PSC3: 0x00000100
1583307ecb6dSEric Millbrandt				for single ended drivers on PSC3: 0x00004100
15846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_USB_EVENT_POLL
1585fdcfaa1bSZhang Wei				May be defined to allow interrupt polling
1586fdcfaa1bSZhang Wei				instead of using asynchronous interrupts
15874d13cbadSwdenk
15889ab4ce22SSimon Glass		CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
15899ab4ce22SSimon Glass		txfilltuning field in the EHCI controller on reset.
15909ab4ce22SSimon Glass
15916e9e0626SOleksandr Tymoshenko		CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
15926e9e0626SOleksandr Tymoshenko		HW module registers.
15936e9e0626SOleksandr Tymoshenko
159416c8d5e7SWolfgang Denk- USB Device:
159516c8d5e7SWolfgang Denk		Define the below if you wish to use the USB console.
159616c8d5e7SWolfgang Denk		Once firmware is rebuilt from a serial console issue the
159716c8d5e7SWolfgang Denk		command "setenv stdin usbtty; setenv stdout usbtty" and
159811ccc33fSMarcel Ziswiler		attach your USB cable. The Unix command "dmesg" should print
159916c8d5e7SWolfgang Denk		it has found a new device. The environment variable usbtty
160016c8d5e7SWolfgang Denk		can be set to gserial or cdc_acm to enable your device to
160116c8d5e7SWolfgang Denk		appear to a USB host as a Linux gserial device or a
160216c8d5e7SWolfgang Denk		Common Device Class Abstract Control Model serial device.
160316c8d5e7SWolfgang Denk		If you select usbtty = gserial you should be able to enumerate
160416c8d5e7SWolfgang Denk		a Linux host by
160516c8d5e7SWolfgang Denk		# modprobe usbserial vendor=0xVendorID product=0xProductID
160616c8d5e7SWolfgang Denk		else if using cdc_acm, simply setting the environment
160716c8d5e7SWolfgang Denk		variable usbtty to be cdc_acm should suffice. The following
160816c8d5e7SWolfgang Denk		might be defined in YourBoardName.h
160916c8d5e7SWolfgang Denk
161016c8d5e7SWolfgang Denk			CONFIG_USB_DEVICE
161116c8d5e7SWolfgang Denk			Define this to build a UDC device
161216c8d5e7SWolfgang Denk
161316c8d5e7SWolfgang Denk			CONFIG_USB_TTY
161416c8d5e7SWolfgang Denk			Define this to have a tty type of device available to
161516c8d5e7SWolfgang Denk			talk to the UDC device
161616c8d5e7SWolfgang Denk
1617f9da0f89SVipin KUMAR			CONFIG_USBD_HS
1618f9da0f89SVipin KUMAR			Define this to enable the high speed support for usb
1619f9da0f89SVipin KUMAR			device and usbtty. If this feature is enabled, a routine
1620f9da0f89SVipin KUMAR			int is_usbd_high_speed(void)
1621f9da0f89SVipin KUMAR			also needs to be defined by the driver to dynamically poll
1622f9da0f89SVipin KUMAR			whether the enumeration has succeded at high speed or full
1623f9da0f89SVipin KUMAR			speed.
1624f9da0f89SVipin KUMAR
16256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_IS_IN_ENV
162616c8d5e7SWolfgang Denk			Define this if you want stdin, stdout &/or stderr to
162716c8d5e7SWolfgang Denk			be set to usbtty.
162816c8d5e7SWolfgang Denk
162916c8d5e7SWolfgang Denk			mpc8xx:
16306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_EXTC_CLK 0xBLAH
163116c8d5e7SWolfgang Denk				Derive USB clock from external clock "blah"
16326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_EXTC_CLK 0x02
163316c8d5e7SWolfgang Denk
16346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_BRG_CLK 0xBLAH
163516c8d5e7SWolfgang Denk				Derive USB clock from brgclk
16366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_BRG_CLK 0x04
163716c8d5e7SWolfgang Denk
163816c8d5e7SWolfgang Denk		If you have a USB-IF assigned VendorID then you may wish to
163916c8d5e7SWolfgang Denk		define your own vendor specific values either in BoardName.h
164016c8d5e7SWolfgang Denk		or directly in usbd_vendor_info.h. If you don't define
164116c8d5e7SWolfgang Denk		CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
164216c8d5e7SWolfgang Denk		CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
164316c8d5e7SWolfgang Denk		should pretend to be a Linux device to it's target host.
164416c8d5e7SWolfgang Denk
164516c8d5e7SWolfgang Denk			CONFIG_USBD_MANUFACTURER
164616c8d5e7SWolfgang Denk			Define this string as the name of your company for
164716c8d5e7SWolfgang Denk			- CONFIG_USBD_MANUFACTURER "my company"
164816c8d5e7SWolfgang Denk
164916c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCT_NAME
165016c8d5e7SWolfgang Denk			Define this string as the name of your product
165116c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCT_NAME "acme usb device"
165216c8d5e7SWolfgang Denk
165316c8d5e7SWolfgang Denk			CONFIG_USBD_VENDORID
165416c8d5e7SWolfgang Denk			Define this as your assigned Vendor ID from the USB
165516c8d5e7SWolfgang Denk			Implementors Forum. This *must* be a genuine Vendor ID
165616c8d5e7SWolfgang Denk			to avoid polluting the USB namespace.
165716c8d5e7SWolfgang Denk			- CONFIG_USBD_VENDORID 0xFFFF
165816c8d5e7SWolfgang Denk
165916c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCTID
166016c8d5e7SWolfgang Denk			Define this as the unique Product ID
166116c8d5e7SWolfgang Denk			for your device
166216c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCTID 0xFFFF
1663c609719bSwdenk
1664d70a560fSIgor Grinberg- ULPI Layer Support:
1665d70a560fSIgor Grinberg		The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1666d70a560fSIgor Grinberg		the generic ULPI layer. The generic layer accesses the ULPI PHY
1667d70a560fSIgor Grinberg		via the platform viewport, so you need both the genric layer and
1668d70a560fSIgor Grinberg		the viewport enabled. Currently only Chipidea/ARC based
1669d70a560fSIgor Grinberg		viewport is supported.
1670d70a560fSIgor Grinberg		To enable the ULPI layer support, define CONFIG_USB_ULPI and
1671d70a560fSIgor Grinberg		CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
16726d365ea0SLucas Stach		If your ULPI phy needs a different reference clock than the
16736d365ea0SLucas Stach		standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
16746d365ea0SLucas Stach		the appropriate value in Hz.
1675c609719bSwdenk
1676c609719bSwdenk- MMC Support:
1677c609719bSwdenk		The MMC controller on the Intel PXA is supported. To
1678c609719bSwdenk		enable this define CONFIG_MMC. The MMC can be
1679c609719bSwdenk		accessed from the boot prompt by mapping the device
1680c609719bSwdenk		to physical memory similar to flash. Command line is
1681602ad3b3SJon Loeliger		enabled with CONFIG_CMD_MMC. The MMC driver also works with
1682602ad3b3SJon Loeliger		the FAT fs. This is enabled with CONFIG_CMD_FAT.
1683c609719bSwdenk
1684afb35666SYoshihiro Shimoda		CONFIG_SH_MMCIF
1685afb35666SYoshihiro Shimoda		Support for Renesas on-chip MMCIF controller
1686afb35666SYoshihiro Shimoda
1687afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_ADDR
1688afb35666SYoshihiro Shimoda			Define the base address of MMCIF registers
1689afb35666SYoshihiro Shimoda
1690afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_CLK
1691afb35666SYoshihiro Shimoda			Define the clock frequency for MMCIF
1692afb35666SYoshihiro Shimoda
16931fd93c6eSPierre Aubert		CONFIG_GENERIC_MMC
16941fd93c6eSPierre Aubert		Enable the generic MMC driver
16951fd93c6eSPierre Aubert
16961fd93c6eSPierre Aubert		CONFIG_SUPPORT_EMMC_BOOT
16971fd93c6eSPierre Aubert		Enable some additional features of the eMMC boot partitions.
16981fd93c6eSPierre Aubert
16991fd93c6eSPierre Aubert		CONFIG_SUPPORT_EMMC_RPMB
17001fd93c6eSPierre Aubert		Enable the commands for reading, writing and programming the
17011fd93c6eSPierre Aubert		key for the Replay Protection Memory Block partition in eMMC.
17021fd93c6eSPierre Aubert
1703b3ba6e94STom Rini- USB Device Firmware Update (DFU) class support:
1704b3ba6e94STom Rini		CONFIG_DFU_FUNCTION
1705b3ba6e94STom Rini		This enables the USB portion of the DFU USB class
1706b3ba6e94STom Rini
1707b3ba6e94STom Rini		CONFIG_CMD_DFU
1708b3ba6e94STom Rini		This enables the command "dfu" which is used to have
1709b3ba6e94STom Rini		U-Boot create a DFU class device via USB.  This command
1710b3ba6e94STom Rini		requires that the "dfu_alt_info" environment variable be
1711b3ba6e94STom Rini		set and define the alt settings to expose to the host.
1712b3ba6e94STom Rini
1713b3ba6e94STom Rini		CONFIG_DFU_MMC
1714b3ba6e94STom Rini		This enables support for exposing (e)MMC devices via DFU.
1715b3ba6e94STom Rini
1716c6631764SPantelis Antoniou		CONFIG_DFU_NAND
1717c6631764SPantelis Antoniou		This enables support for exposing NAND devices via DFU.
1718c6631764SPantelis Antoniou
1719a9479f04SAfzal Mohammed		CONFIG_DFU_RAM
1720a9479f04SAfzal Mohammed		This enables support for exposing RAM via DFU.
1721a9479f04SAfzal Mohammed		Note: DFU spec refer to non-volatile memory usage, but
1722a9479f04SAfzal Mohammed		allow usages beyond the scope of spec - here RAM usage,
1723a9479f04SAfzal Mohammed		one that would help mostly the developer.
1724a9479f04SAfzal Mohammed
1725e7e75c70SHeiko Schocher		CONFIG_SYS_DFU_DATA_BUF_SIZE
1726e7e75c70SHeiko Schocher		Dfu transfer uses a buffer before writing data to the
1727e7e75c70SHeiko Schocher		raw storage device. Make the size (in bytes) of this buffer
1728e7e75c70SHeiko Schocher		configurable. The size of this buffer is also configurable
1729e7e75c70SHeiko Schocher		through the "dfu_bufsiz" environment variable.
1730e7e75c70SHeiko Schocher
1731ea2453d5SPantelis Antoniou		CONFIG_SYS_DFU_MAX_FILE_SIZE
1732ea2453d5SPantelis Antoniou		When updating files rather than the raw storage device,
1733ea2453d5SPantelis Antoniou		we use a static buffer to copy the file into and then write
1734ea2453d5SPantelis Antoniou		the buffer once we've been given the whole file.  Define
1735ea2453d5SPantelis Antoniou		this to the maximum filesize (in bytes) for the buffer.
1736ea2453d5SPantelis Antoniou		Default is 4 MiB if undefined.
1737ea2453d5SPantelis Antoniou
1738001a8319SHeiko Schocher		DFU_DEFAULT_POLL_TIMEOUT
1739001a8319SHeiko Schocher		Poll timeout [ms], is the timeout a device can send to the
1740001a8319SHeiko Schocher		host. The host must wait for this timeout before sending
1741001a8319SHeiko Schocher		a subsequent DFU_GET_STATUS request to the device.
1742001a8319SHeiko Schocher
1743001a8319SHeiko Schocher		DFU_MANIFEST_POLL_TIMEOUT
1744001a8319SHeiko Schocher		Poll timeout [ms], which the device sends to the host when
1745001a8319SHeiko Schocher		entering dfuMANIFEST state. Host waits this timeout, before
1746001a8319SHeiko Schocher		sending again an USB request to the device.
1747001a8319SHeiko Schocher
17483aab70afSSebastian Siewior- USB Device Android Fastboot support:
17493aab70afSSebastian Siewior		CONFIG_CMD_FASTBOOT
17503aab70afSSebastian Siewior		This enables the command "fastboot" which enables the Android
17513aab70afSSebastian Siewior		fastboot mode for the platform's USB device. Fastboot is a USB
17523aab70afSSebastian Siewior		protocol for downloading images, flashing and device control
17533aab70afSSebastian Siewior		used on Android devices.
17543aab70afSSebastian Siewior		See doc/README.android-fastboot for more information.
17553aab70afSSebastian Siewior
17563aab70afSSebastian Siewior		CONFIG_ANDROID_BOOT_IMAGE
17573aab70afSSebastian Siewior		This enables support for booting images which use the Android
17583aab70afSSebastian Siewior		image format header.
17593aab70afSSebastian Siewior
17603aab70afSSebastian Siewior		CONFIG_USB_FASTBOOT_BUF_ADDR
17613aab70afSSebastian Siewior		The fastboot protocol requires a large memory buffer for
17623aab70afSSebastian Siewior		downloads. Define this to the starting RAM address to use for
17633aab70afSSebastian Siewior		downloaded images.
17643aab70afSSebastian Siewior
17653aab70afSSebastian Siewior		CONFIG_USB_FASTBOOT_BUF_SIZE
17663aab70afSSebastian Siewior		The fastboot protocol requires a large memory buffer for
17673aab70afSSebastian Siewior		downloads. This buffer should be as large as possible for a
17683aab70afSSebastian Siewior		platform. Define this to the size available RAM for fastboot.
17693aab70afSSebastian Siewior
1770d1b5ed07SSteve Rae		CONFIG_FASTBOOT_FLASH
1771d1b5ed07SSteve Rae		The fastboot protocol includes a "flash" command for writing
1772d1b5ed07SSteve Rae		the downloaded image to a non-volatile storage device. Define
1773d1b5ed07SSteve Rae		this to enable the "fastboot flash" command.
1774d1b5ed07SSteve Rae
1775d1b5ed07SSteve Rae		CONFIG_FASTBOOT_FLASH_MMC_DEV
1776d1b5ed07SSteve Rae		The fastboot "flash" command requires additional information
1777d1b5ed07SSteve Rae		regarding the non-volatile storage device. Define this to
1778d1b5ed07SSteve Rae		the eMMC device that fastboot should use to store the image.
1779d1b5ed07SSteve Rae
17800ff7e585SSteve Rae		CONFIG_FASTBOOT_GPT_NAME
17810ff7e585SSteve Rae		The fastboot "flash" command supports writing the downloaded
17820ff7e585SSteve Rae		image to the Protective MBR and the Primary GUID Partition
17830ff7e585SSteve Rae		Table. (Additionally, this downloaded image is post-processed
17840ff7e585SSteve Rae		to generate and write the Backup GUID Partition Table.)
17850ff7e585SSteve Rae		This occurs when the specified "partition name" on the
17860ff7e585SSteve Rae		"fastboot flash" command line matches this value.
17870ff7e585SSteve Rae		Default is GPT_ENTRY_NAME (currently "gpt") if undefined.
17880ff7e585SSteve Rae
17896705d81eSwdenk- Journaling Flash filesystem support:
17906705d81eSwdenk		CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
17916705d81eSwdenk		CONFIG_JFFS2_NAND_DEV
17926705d81eSwdenk		Define these for a default partition on a NAND device
17936705d81eSwdenk
17946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_SECTOR,
17956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
17966705d81eSwdenk		Define these for a default partition on a NOR device
17976705d81eSwdenk
17986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS_CUSTOM_PART
17996705d81eSwdenk		Define this to create an own partition. You have to provide a
18006705d81eSwdenk		function struct part_info* jffs2_part_info(int part_num)
18016705d81eSwdenk
18026705d81eSwdenk		If you define only one JFFS2 partition you may also want to
18036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_JFFS_SINGLE_PART	1
18046705d81eSwdenk		to disable the command chpart. This is the default when you
18056705d81eSwdenk		have not defined a custom partition
18066705d81eSwdenk
1807c30a15e5SDonggeun Kim- FAT(File Allocation Table) filesystem write function support:
1808c30a15e5SDonggeun Kim		CONFIG_FAT_WRITE
1809656f4c65SDonggeun Kim
1810656f4c65SDonggeun Kim		Define this to enable support for saving memory data as a
1811656f4c65SDonggeun Kim		file in FAT formatted partition.
1812656f4c65SDonggeun Kim
1813656f4c65SDonggeun Kim		This will also enable the command "fatwrite" enabling the
1814656f4c65SDonggeun Kim		user to write files to FAT.
1815c30a15e5SDonggeun Kim
181684cd9327SGabe BlackCBFS (Coreboot Filesystem) support
181784cd9327SGabe Black		CONFIG_CMD_CBFS
181884cd9327SGabe Black
181984cd9327SGabe Black		Define this to enable support for reading from a Coreboot
182084cd9327SGabe Black		filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
182184cd9327SGabe Black		and cbfsload.
182284cd9327SGabe Black
18234f0d1a2aSSiva Durga Prasad Paladugu- FAT(File Allocation Table) filesystem cluster size:
18244f0d1a2aSSiva Durga Prasad Paladugu		CONFIG_FS_FAT_MAX_CLUSTSIZE
18254f0d1a2aSSiva Durga Prasad Paladugu
18264f0d1a2aSSiva Durga Prasad Paladugu		Define the max cluster size for fat operations else
18274f0d1a2aSSiva Durga Prasad Paladugu		a default value of 65536 will be defined.
18284f0d1a2aSSiva Durga Prasad Paladugu
1829c609719bSwdenk- Keyboard Support:
1830c609719bSwdenk		CONFIG_ISA_KEYBOARD
1831c609719bSwdenk
1832c609719bSwdenk		Define this to enable standard (PC-Style) keyboard
1833c609719bSwdenk		support
1834c609719bSwdenk
1835c609719bSwdenk		CONFIG_I8042_KBD
1836c609719bSwdenk		Standard PC keyboard driver with US (is default) and
1837c609719bSwdenk		GERMAN key layout (switch via environment 'keymap=de') support.
1838c609719bSwdenk		Export function i8042_kbd_init, i8042_tstc and i8042_getc
1839c609719bSwdenk		for cfb_console. Supports cursor blinking.
1840c609719bSwdenk
1841713cb680SHung-ying Tyan		CONFIG_CROS_EC_KEYB
1842713cb680SHung-ying Tyan		Enables a Chrome OS keyboard using the CROS_EC interface.
1843713cb680SHung-ying Tyan		This uses CROS_EC to communicate with a second microcontroller
1844713cb680SHung-ying Tyan		which provides key scans on request.
1845713cb680SHung-ying Tyan
1846c609719bSwdenk- Video support:
1847c609719bSwdenk		CONFIG_VIDEO
1848c609719bSwdenk
1849c609719bSwdenk		Define this to enable video support (for output to
1850c609719bSwdenk		video).
1851c609719bSwdenk
1852c609719bSwdenk		CONFIG_VIDEO_CT69000
1853c609719bSwdenk
1854c609719bSwdenk		Enable Chips & Technologies 69000 Video chip
1855c609719bSwdenk
1856c609719bSwdenk		CONFIG_VIDEO_SMI_LYNXEM
1857eeb1b77bSwdenk		Enable Silicon Motion SMI 712/710/810 Video chip. The
1858eeb1b77bSwdenk		video output is selected via environment 'videoout'
1859eeb1b77bSwdenk		(1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1860eeb1b77bSwdenk		assumed.
1861c609719bSwdenk
1862eeb1b77bSwdenk		For the CT69000 and SMI_LYNXEM drivers, videomode is
186311ccc33fSMarcel Ziswiler		selected via environment 'videomode'. Two different ways
1864eeb1b77bSwdenk		are possible:
1865eeb1b77bSwdenk		- "videomode=num"   'num' is a standard LiLo mode numbers.
1866eeb1b77bSwdenk		Following standard modes are supported	(* is default):
1867eeb1b77bSwdenk
1868eeb1b77bSwdenk		      Colors	640x480 800x600 1024x768 1152x864 1280x1024
1869eeb1b77bSwdenk		-------------+---------------------------------------------
1870eeb1b77bSwdenk		      8 bits |	0x301*	0x303	 0x305	  0x161	    0x307
1871eeb1b77bSwdenk		     15 bits |	0x310	0x313	 0x316	  0x162	    0x319
1872eeb1b77bSwdenk		     16 bits |	0x311	0x314	 0x317	  0x163	    0x31A
1873eeb1b77bSwdenk		     24 bits |	0x312	0x315	 0x318	    ?	    0x31B
1874eeb1b77bSwdenk		-------------+---------------------------------------------
1875c609719bSwdenk		(i.e. setenv videomode 317; saveenv; reset;)
1876c609719bSwdenk
1877eeb1b77bSwdenk		- "videomode=bootargs" all the video parameters are parsed
18787817cb20SMarcel Ziswiler		from the bootargs. (See drivers/video/videomodes.c)
1879eeb1b77bSwdenk
1880eeb1b77bSwdenk
1881a6c7ad2fSwdenk		CONFIG_VIDEO_SED13806
1882a6c7ad2fSwdenk		Enable Epson SED13806 driver. This driver supports 8bpp
1883a6c7ad2fSwdenk		and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1884a6c7ad2fSwdenk		or CONFIG_VIDEO_SED13806_16BPP
1885a6c7ad2fSwdenk
18867d3053fbSTimur Tabi		CONFIG_FSL_DIU_FB
18877d3053fbSTimur Tabi		Enable the Freescale DIU video driver.	Reference boards for
18887d3053fbSTimur Tabi		SOCs that have a DIU should define this macro to enable DIU
18897d3053fbSTimur Tabi		support, and should also define these other macros:
18907d3053fbSTimur Tabi
18917d3053fbSTimur Tabi			CONFIG_SYS_DIU_ADDR
18927d3053fbSTimur Tabi			CONFIG_VIDEO
18937d3053fbSTimur Tabi			CONFIG_CMD_BMP
18947d3053fbSTimur Tabi			CONFIG_CFB_CONSOLE
18957d3053fbSTimur Tabi			CONFIG_VIDEO_SW_CURSOR
18967d3053fbSTimur Tabi			CONFIG_VGA_AS_SINGLE_DEVICE
18977d3053fbSTimur Tabi			CONFIG_VIDEO_LOGO
18987d3053fbSTimur Tabi			CONFIG_VIDEO_BMP_LOGO
18997d3053fbSTimur Tabi
1900ba8e76bdSTimur Tabi		The DIU driver will look for the 'video-mode' environment
1901ba8e76bdSTimur Tabi		variable, and if defined, enable the DIU as a console during
1902ba8e76bdSTimur Tabi		boot.  See the documentation file README.video for a
1903ba8e76bdSTimur Tabi		description of this variable.
19047d3053fbSTimur Tabi
1905058d59b0SSimon Glass		CONFIG_VIDEO_VGA
1906058d59b0SSimon Glass
1907058d59b0SSimon Glass		Enable the VGA video / BIOS for x86. The alternative if you
1908058d59b0SSimon Glass		are using coreboot is to use the coreboot frame buffer
1909058d59b0SSimon Glass		driver.
1910058d59b0SSimon Glass
1911058d59b0SSimon Glass
1912682011ffSwdenk- Keyboard Support:
1913682011ffSwdenk		CONFIG_KEYBOARD
1914682011ffSwdenk
1915682011ffSwdenk		Define this to enable a custom keyboard support.
1916682011ffSwdenk		This simply calls drv_keyboard_init() which must be
1917682011ffSwdenk		defined in your board-specific files.
1918682011ffSwdenk		The only board using this so far is RBC823.
1919a6c7ad2fSwdenk
1920c609719bSwdenk- LCD Support:	CONFIG_LCD
1921c609719bSwdenk
1922c609719bSwdenk		Define this to enable LCD support (for output to LCD
1923c609719bSwdenk		display); also select one of the supported displays
1924c609719bSwdenk		by defining one of these:
1925c609719bSwdenk
192639cf4804SStelian Pop		CONFIG_ATMEL_LCD:
192739cf4804SStelian Pop
192839cf4804SStelian Pop			HITACHI TX09D70VM1CCA, 3.5", 240x320.
192939cf4804SStelian Pop
1930fd3103bbSwdenk		CONFIG_NEC_NL6448AC33:
1931c609719bSwdenk
1932fd3103bbSwdenk			NEC NL6448AC33-18. Active, color, single scan.
1933c609719bSwdenk
1934fd3103bbSwdenk		CONFIG_NEC_NL6448BC20
1935c609719bSwdenk
1936fd3103bbSwdenk			NEC NL6448BC20-08. 6.5", 640x480.
1937fd3103bbSwdenk			Active, color, single scan.
1938fd3103bbSwdenk
1939fd3103bbSwdenk		CONFIG_NEC_NL6448BC33_54
1940fd3103bbSwdenk
1941fd3103bbSwdenk			NEC NL6448BC33-54. 10.4", 640x480.
1942c609719bSwdenk			Active, color, single scan.
1943c609719bSwdenk
1944c609719bSwdenk		CONFIG_SHARP_16x9
1945c609719bSwdenk
1946c609719bSwdenk			Sharp 320x240. Active, color, single scan.
1947c609719bSwdenk			It isn't 16x9, and I am not sure what it is.
1948c609719bSwdenk
1949c609719bSwdenk		CONFIG_SHARP_LQ64D341
1950c609719bSwdenk
1951c609719bSwdenk			Sharp LQ64D341 display, 640x480.
1952c609719bSwdenk			Active, color, single scan.
1953c609719bSwdenk
1954c609719bSwdenk		CONFIG_HLD1045
1955c609719bSwdenk
1956c609719bSwdenk			HLD1045 display, 640x480.
1957c609719bSwdenk			Active, color, single scan.
1958c609719bSwdenk
1959c609719bSwdenk		CONFIG_OPTREX_BW
1960c609719bSwdenk
1961c609719bSwdenk			Optrex	 CBL50840-2 NF-FW 99 22 M5
1962c609719bSwdenk			or
1963c609719bSwdenk			Hitachi	 LMG6912RPFC-00T
1964c609719bSwdenk			or
1965c609719bSwdenk			Hitachi	 SP14Q002
1966c609719bSwdenk
1967c609719bSwdenk			320x240. Black & white.
1968c609719bSwdenk
1969c609719bSwdenk		Normally display is black on white background; define
19706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
1971c609719bSwdenk
1972676d319eSSimon Glass		CONFIG_LCD_ALIGNMENT
1973676d319eSSimon Glass
1974b445bbb4SJeremiah Mahler		Normally the LCD is page-aligned (typically 4KB). If this is
1975676d319eSSimon Glass		defined then the LCD will be aligned to this value instead.
1976676d319eSSimon Glass		For ARM it is sometimes useful to use MMU_SECTION_SIZE
1977676d319eSSimon Glass		here, since it is cheaper to change data cache settings on
1978676d319eSSimon Glass		a per-section basis.
1979676d319eSSimon Glass
19800d89efefSSimon Glass		CONFIG_CONSOLE_SCROLL_LINES
19810d89efefSSimon Glass
19820d89efefSSimon Glass		When the console need to be scrolled, this is the number of
19830d89efefSSimon Glass		lines to scroll by. It defaults to 1. Increasing this makes
19840d89efefSSimon Glass		the console jump but can help speed up operation when scrolling
19850d89efefSSimon Glass		is slow.
1986676d319eSSimon Glass
198745d7f525STom Wai-Hong Tam		CONFIG_LCD_BMP_RLE8
198845d7f525STom Wai-Hong Tam
198945d7f525STom Wai-Hong Tam		Support drawing of RLE8-compressed bitmaps on the LCD.
199045d7f525STom Wai-Hong Tam
1991735987c5STom Wai-Hong Tam		CONFIG_I2C_EDID
1992735987c5STom Wai-Hong Tam
1993735987c5STom Wai-Hong Tam		Enables an 'i2c edid' command which can read EDID
1994735987c5STom Wai-Hong Tam		information over I2C from an attached LCD display.
1995735987c5STom Wai-Hong Tam
19967152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN
1997d791b1dcSwdenk
1998d791b1dcSwdenk		If this option is set, the environment is checked for
1999d791b1dcSwdenk		a variable "splashimage". If found, the usual display
2000d791b1dcSwdenk		of logo, copyright and system information on the LCD
2001e94d2cd9Swdenk		is suppressed and the BMP image at the address
2002d791b1dcSwdenk		specified in "splashimage" is loaded instead. The
2003d791b1dcSwdenk		console is redirected to the "nulldev", too. This
2004d791b1dcSwdenk		allows for a "silent" boot where a splash screen is
2005d791b1dcSwdenk		loaded very quickly after power-on.
2006d791b1dcSwdenk
2007c0880485SNikita Kiryanov		CONFIG_SPLASHIMAGE_GUARD
2008c0880485SNikita Kiryanov
2009c0880485SNikita Kiryanov		If this option is set, then U-Boot will prevent the environment
2010c0880485SNikita Kiryanov		variable "splashimage" from being set to a problematic address
20111551df35STom Rini		(see README.displaying-bmps).
2012c0880485SNikita Kiryanov		This option is useful for targets where, due to alignment
2013c0880485SNikita Kiryanov		restrictions, an improperly aligned BMP image will cause a data
2014c0880485SNikita Kiryanov		abort. If you think you will not have problems with unaligned
2015c0880485SNikita Kiryanov		accesses (for example because your toolchain prevents them)
2016c0880485SNikita Kiryanov		there is no need to set this option.
2017c0880485SNikita Kiryanov
20181ca298ceSMatthias Weisser		CONFIG_SPLASH_SCREEN_ALIGN
20191ca298ceSMatthias Weisser
20201ca298ceSMatthias Weisser		If this option is set the splash image can be freely positioned
20211ca298ceSMatthias Weisser		on the screen. Environment variable "splashpos" specifies the
20221ca298ceSMatthias Weisser		position as "x,y". If a positive number is given it is used as
20231ca298ceSMatthias Weisser		number of pixel from left/top. If a negative number is given it
20241ca298ceSMatthias Weisser		is used as number of pixel from right/bottom. You can also
20251ca298ceSMatthias Weisser		specify 'm' for centering the image.
20261ca298ceSMatthias Weisser
20271ca298ceSMatthias Weisser		Example:
20281ca298ceSMatthias Weisser		setenv splashpos m,m
20291ca298ceSMatthias Weisser			=> image at center of screen
20301ca298ceSMatthias Weisser
20311ca298ceSMatthias Weisser		setenv splashpos 30,20
20321ca298ceSMatthias Weisser			=> image at x = 30 and y = 20
20331ca298ceSMatthias Weisser
20341ca298ceSMatthias Weisser		setenv splashpos -10,m
20351ca298ceSMatthias Weisser			=> vertically centered image
20361ca298ceSMatthias Weisser			   at x = dspWidth - bmpWidth - 9
20371ca298ceSMatthias Weisser
203898f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
203998f4a3dfSStefan Roese
204098f4a3dfSStefan Roese		If this option is set, additionally to standard BMP
204198f4a3dfSStefan Roese		images, gzipped BMP images can be displayed via the
204298f4a3dfSStefan Roese		splashscreen support or the bmp command.
204398f4a3dfSStefan Roese
2044d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
2045d5011762SAnatolij Gustschin
2046d5011762SAnatolij Gustschin		If this option is set, 8-bit RLE compressed BMP images
2047d5011762SAnatolij Gustschin		can be displayed via the splashscreen support or the
2048d5011762SAnatolij Gustschin		bmp command.
2049d5011762SAnatolij Gustschin
2050b445bbb4SJeremiah Mahler- Do compressing for memory range:
2051f2b96dfbSLei Wen		CONFIG_CMD_ZIP
2052f2b96dfbSLei Wen
2053f2b96dfbSLei Wen		If this option is set, it would use zlib deflate method
2054f2b96dfbSLei Wen		to compress the specified memory at its best effort.
2055f2b96dfbSLei Wen
2056c29fdfc1Swdenk- Compression support:
20578ef70478SKees Cook		CONFIG_GZIP
20588ef70478SKees Cook
20598ef70478SKees Cook		Enabled by default to support gzip compressed images.
20608ef70478SKees Cook
2061c29fdfc1Swdenk		CONFIG_BZIP2
2062c29fdfc1Swdenk
2063c29fdfc1Swdenk		If this option is set, support for bzip2 compressed
2064c29fdfc1Swdenk		images is included. If not, only uncompressed and gzip
2065c29fdfc1Swdenk		compressed images are supported.
2066c29fdfc1Swdenk
2067c29fdfc1Swdenk		NOTE: the bzip2 algorithm requires a lot of RAM, so
20686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
2069c29fdfc1Swdenk		be at least 4MB.
2070d791b1dcSwdenk
2071fc9c1727SLuigi 'Comio' Mantellini		CONFIG_LZMA
2072fc9c1727SLuigi 'Comio' Mantellini
2073fc9c1727SLuigi 'Comio' Mantellini		If this option is set, support for lzma compressed
2074fc9c1727SLuigi 'Comio' Mantellini		images is included.
2075fc9c1727SLuigi 'Comio' Mantellini
2076fc9c1727SLuigi 'Comio' Mantellini		Note: The LZMA algorithm adds between 2 and 4KB of code and it
2077fc9c1727SLuigi 'Comio' Mantellini		requires an amount of dynamic memory that is given by the
2078fc9c1727SLuigi 'Comio' Mantellini		formula:
2079fc9c1727SLuigi 'Comio' Mantellini
2080fc9c1727SLuigi 'Comio' Mantellini			(1846 + 768 << (lc + lp)) * sizeof(uint16)
2081fc9c1727SLuigi 'Comio' Mantellini
2082fc9c1727SLuigi 'Comio' Mantellini		Where lc and lp stand for, respectively, Literal context bits
2083fc9c1727SLuigi 'Comio' Mantellini		and Literal pos bits.
2084fc9c1727SLuigi 'Comio' Mantellini
2085fc9c1727SLuigi 'Comio' Mantellini		This value is upper-bounded by 14MB in the worst case. Anyway,
2086fc9c1727SLuigi 'Comio' Mantellini		for a ~4MB large kernel image, we have lc=3 and lp=0 for a
2087fc9c1727SLuigi 'Comio' Mantellini		total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
2088fc9c1727SLuigi 'Comio' Mantellini		a very small buffer.
2089fc9c1727SLuigi 'Comio' Mantellini
2090fc9c1727SLuigi 'Comio' Mantellini		Use the lzmainfo tool to determinate the lc and lp values and
2091fc9c1727SLuigi 'Comio' Mantellini		then calculate the amount of needed dynamic memory (ensuring
20926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the appropriate CONFIG_SYS_MALLOC_LEN value).
2093fc9c1727SLuigi 'Comio' Mantellini
20948ef70478SKees Cook		CONFIG_LZO
20958ef70478SKees Cook
20968ef70478SKees Cook		If this option is set, support for LZO compressed images
20978ef70478SKees Cook		is included.
20988ef70478SKees Cook
209917ea1177Swdenk- MII/PHY support:
210017ea1177Swdenk		CONFIG_PHY_ADDR
210117ea1177Swdenk
210217ea1177Swdenk		The address of PHY on MII bus.
210317ea1177Swdenk
210417ea1177Swdenk		CONFIG_PHY_CLOCK_FREQ (ppc4xx)
210517ea1177Swdenk
210617ea1177Swdenk		The clock frequency of the MII bus
210717ea1177Swdenk
210817ea1177Swdenk		CONFIG_PHY_GIGE
210917ea1177Swdenk
211017ea1177Swdenk		If this option is set, support for speed/duplex
211111ccc33fSMarcel Ziswiler		detection of gigabit PHY is included.
211217ea1177Swdenk
211317ea1177Swdenk		CONFIG_PHY_RESET_DELAY
211417ea1177Swdenk
211517ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
211617ea1177Swdenk		reset before any MII register access is possible.
211717ea1177Swdenk		For such PHY, set this option to the usec delay
211817ea1177Swdenk		required. (minimum 300usec for LXT971A)
211917ea1177Swdenk
212017ea1177Swdenk		CONFIG_PHY_CMD_DELAY (ppc4xx)
212117ea1177Swdenk
212217ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
212317ea1177Swdenk		command issued before MII status register can be read
212417ea1177Swdenk
2125c609719bSwdenk- Ethernet address:
2126c609719bSwdenk		CONFIG_ETHADDR
2127c68a05feSrichardretanubun		CONFIG_ETH1ADDR
2128c609719bSwdenk		CONFIG_ETH2ADDR
2129c609719bSwdenk		CONFIG_ETH3ADDR
2130c68a05feSrichardretanubun		CONFIG_ETH4ADDR
2131c68a05feSrichardretanubun		CONFIG_ETH5ADDR
2132c609719bSwdenk
213311ccc33fSMarcel Ziswiler		Define a default value for Ethernet address to use
213411ccc33fSMarcel Ziswiler		for the respective Ethernet interface, in case this
2135c609719bSwdenk		is not determined automatically.
2136c609719bSwdenk
2137c609719bSwdenk- IP address:
2138c609719bSwdenk		CONFIG_IPADDR
2139c609719bSwdenk
2140c609719bSwdenk		Define a default value for the IP address to use for
214111ccc33fSMarcel Ziswiler		the default Ethernet interface, in case this is not
2142c609719bSwdenk		determined through e.g. bootp.
21431ebcd654SWolfgang Denk		(Environment variable "ipaddr")
2144c609719bSwdenk
2145c609719bSwdenk- Server IP address:
2146c609719bSwdenk		CONFIG_SERVERIP
2147c609719bSwdenk
2148c609719bSwdenk		Defines a default value for the IP address of a TFTP
2149c609719bSwdenk		server to contact when using the "tftboot" command.
21501ebcd654SWolfgang Denk		(Environment variable "serverip")
2151c609719bSwdenk
215297cfe861SRobin Getz		CONFIG_KEEP_SERVERADDR
215397cfe861SRobin Getz
215497cfe861SRobin Getz		Keeps the server's MAC address, in the env 'serveraddr'
215597cfe861SRobin Getz		for passing to bootargs (like Linux's netconsole option)
215697cfe861SRobin Getz
21571ebcd654SWolfgang Denk- Gateway IP address:
21581ebcd654SWolfgang Denk		CONFIG_GATEWAYIP
21591ebcd654SWolfgang Denk
21601ebcd654SWolfgang Denk		Defines a default value for the IP address of the
21611ebcd654SWolfgang Denk		default router where packets to other networks are
21621ebcd654SWolfgang Denk		sent to.
21631ebcd654SWolfgang Denk		(Environment variable "gatewayip")
21641ebcd654SWolfgang Denk
21651ebcd654SWolfgang Denk- Subnet mask:
21661ebcd654SWolfgang Denk		CONFIG_NETMASK
21671ebcd654SWolfgang Denk
21681ebcd654SWolfgang Denk		Defines a default value for the subnet mask (or
21691ebcd654SWolfgang Denk		routing prefix) which is used to determine if an IP
21701ebcd654SWolfgang Denk		address belongs to the local subnet or needs to be
21711ebcd654SWolfgang Denk		forwarded through a router.
21721ebcd654SWolfgang Denk		(Environment variable "netmask")
21731ebcd654SWolfgang Denk
217453a5c424SDavid Updegraff- Multicast TFTP Mode:
217553a5c424SDavid Updegraff		CONFIG_MCAST_TFTP
217653a5c424SDavid Updegraff
217753a5c424SDavid Updegraff		Defines whether you want to support multicast TFTP as per
217853a5c424SDavid Updegraff		rfc-2090; for example to work with atftp.  Lets lots of targets
217911ccc33fSMarcel Ziswiler		tftp down the same boot image concurrently.  Note: the Ethernet
218053a5c424SDavid Updegraff		driver in use must provide a function: mcast() to join/leave a
218153a5c424SDavid Updegraff		multicast group.
218253a5c424SDavid Updegraff
2183c609719bSwdenk- BOOTP Recovery Mode:
2184c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY
2185c609719bSwdenk
2186c609719bSwdenk		If you have many targets in a network that try to
2187c609719bSwdenk		boot using BOOTP, you may want to avoid that all
2188c609719bSwdenk		systems send out BOOTP requests at precisely the same
2189c609719bSwdenk		moment (which would happen for instance at recovery
2190c609719bSwdenk		from a power failure, when all systems will try to
2191c609719bSwdenk		boot, thus flooding the BOOTP server. Defining
2192c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
2193c609719bSwdenk		inserted before sending out BOOTP requests. The
21946c33c785SWolfgang Denk		following delays are inserted then:
2195c609719bSwdenk
2196c609719bSwdenk		1st BOOTP request:	delay 0 ... 1 sec
2197c609719bSwdenk		2nd BOOTP request:	delay 0 ... 2 sec
2198c609719bSwdenk		3rd BOOTP request:	delay 0 ... 4 sec
2199c609719bSwdenk		4th and following
2200c609719bSwdenk		BOOTP requests:		delay 0 ... 8 sec
2201c609719bSwdenk
220292ac8accSThierry Reding		CONFIG_BOOTP_ID_CACHE_SIZE
220392ac8accSThierry Reding
220492ac8accSThierry Reding		BOOTP packets are uniquely identified using a 32-bit ID. The
220592ac8accSThierry Reding		server will copy the ID from client requests to responses and
220692ac8accSThierry Reding		U-Boot will use this to determine if it is the destination of
220792ac8accSThierry Reding		an incoming response. Some servers will check that addresses
220892ac8accSThierry Reding		aren't in use before handing them out (usually using an ARP
220992ac8accSThierry Reding		ping) and therefore take up to a few hundred milliseconds to
221092ac8accSThierry Reding		respond. Network congestion may also influence the time it
221192ac8accSThierry Reding		takes for a response to make it back to the client. If that
221292ac8accSThierry Reding		time is too long, U-Boot will retransmit requests. In order
221392ac8accSThierry Reding		to allow earlier responses to still be accepted after these
221492ac8accSThierry Reding		retransmissions, U-Boot's BOOTP client keeps a small cache of
221592ac8accSThierry Reding		IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
221692ac8accSThierry Reding		cache. The default is to keep IDs for up to four outstanding
221792ac8accSThierry Reding		requests. Increasing this will allow U-Boot to accept offers
221892ac8accSThierry Reding		from a BOOTP client in networks with unusually high latency.
221992ac8accSThierry Reding
2220fe389a82Sstroese- DHCP Advanced Options:
22211fe80d79SJon Loeliger		You can fine tune the DHCP functionality by defining
22221fe80d79SJon Loeliger		CONFIG_BOOTP_* symbols:
2223fe389a82Sstroese
22241fe80d79SJon Loeliger		CONFIG_BOOTP_SUBNETMASK
22251fe80d79SJon Loeliger		CONFIG_BOOTP_GATEWAY
22261fe80d79SJon Loeliger		CONFIG_BOOTP_HOSTNAME
22271fe80d79SJon Loeliger		CONFIG_BOOTP_NISDOMAIN
22281fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTPATH
22291fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTFILESIZE
22301fe80d79SJon Loeliger		CONFIG_BOOTP_DNS
22311fe80d79SJon Loeliger		CONFIG_BOOTP_DNS2
22321fe80d79SJon Loeliger		CONFIG_BOOTP_SEND_HOSTNAME
22331fe80d79SJon Loeliger		CONFIG_BOOTP_NTPSERVER
22341fe80d79SJon Loeliger		CONFIG_BOOTP_TIMEOFFSET
22351fe80d79SJon Loeliger		CONFIG_BOOTP_VENDOREX
22362c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL
2237fe389a82Sstroese
22385d110f0aSWilson Callan		CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
22395d110f0aSWilson Callan		environment variable, not the BOOTP server.
2240fe389a82Sstroese
22412c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
22422c00e099SJoe Hershberger		after the configured retry count, the call will fail
22432c00e099SJoe Hershberger		instead of starting over.  This can be used to fail over
22442c00e099SJoe Hershberger		to Link-local IP address configuration if the DHCP server
22452c00e099SJoe Hershberger		is not available.
22462c00e099SJoe Hershberger
2247fe389a82Sstroese		CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
2248fe389a82Sstroese		serverip from a DHCP server, it is possible that more
2249fe389a82Sstroese		than one DNS serverip is offered to the client.
2250fe389a82Sstroese		If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
2251fe389a82Sstroese		serverip will be stored in the additional environment
2252fe389a82Sstroese		variable "dnsip2". The first DNS serverip is always
2253fe389a82Sstroese		stored in the variable "dnsip", when CONFIG_BOOTP_DNS
22541fe80d79SJon Loeliger		is defined.
2255fe389a82Sstroese
2256fe389a82Sstroese		CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
2257fe389a82Sstroese		to do a dynamic update of a DNS server. To do this, they
2258fe389a82Sstroese		need the hostname of the DHCP requester.
22595d110f0aSWilson Callan		If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
22601fe80d79SJon Loeliger		of the "hostname" environment variable is passed as
22611fe80d79SJon Loeliger		option 12 to the DHCP server.
2262fe389a82Sstroese
2263d9a2f416SAras Vaichas		CONFIG_BOOTP_DHCP_REQUEST_DELAY
2264d9a2f416SAras Vaichas
2265d9a2f416SAras Vaichas		A 32bit value in microseconds for a delay between
2266d9a2f416SAras Vaichas		receiving a "DHCP Offer" and sending the "DHCP Request".
2267d9a2f416SAras Vaichas		This fixes a problem with certain DHCP servers that don't
2268d9a2f416SAras Vaichas		respond 100% of the time to a "DHCP request". E.g. On an
2269d9a2f416SAras Vaichas		AT91RM9200 processor running at 180MHz, this delay needed
2270d9a2f416SAras Vaichas		to be *at least* 15,000 usec before a Windows Server 2003
2271d9a2f416SAras Vaichas		DHCP server would reply 100% of the time. I recommend at
2272d9a2f416SAras Vaichas		least 50,000 usec to be safe. The alternative is to hope
2273d9a2f416SAras Vaichas		that one of the retries will be successful but note that
2274d9a2f416SAras Vaichas		the DHCP timeout and retry process takes a longer than
2275d9a2f416SAras Vaichas		this delay.
2276d9a2f416SAras Vaichas
2277d22c338eSJoe Hershberger - Link-local IP address negotiation:
2278d22c338eSJoe Hershberger		Negotiate with other link-local clients on the local network
2279d22c338eSJoe Hershberger		for an address that doesn't require explicit configuration.
2280d22c338eSJoe Hershberger		This is especially useful if a DHCP server cannot be guaranteed
2281d22c338eSJoe Hershberger		to exist in all environments that the device must operate.
2282d22c338eSJoe Hershberger
2283d22c338eSJoe Hershberger		See doc/README.link-local for more information.
2284d22c338eSJoe Hershberger
2285a3d991bdSwdenk - CDP Options:
2286a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID
2287a3d991bdSwdenk
2288a3d991bdSwdenk		The device id used in CDP trigger frames.
2289a3d991bdSwdenk
2290a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID_PREFIX
2291a3d991bdSwdenk
2292a3d991bdSwdenk		A two character string which is prefixed to the MAC address
2293a3d991bdSwdenk		of the device.
2294a3d991bdSwdenk
2295a3d991bdSwdenk		CONFIG_CDP_PORT_ID
2296a3d991bdSwdenk
2297a3d991bdSwdenk		A printf format string which contains the ascii name of
2298a3d991bdSwdenk		the port. Normally is set to "eth%d" which sets
229911ccc33fSMarcel Ziswiler		eth0 for the first Ethernet, eth1 for the second etc.
2300a3d991bdSwdenk
2301a3d991bdSwdenk		CONFIG_CDP_CAPABILITIES
2302a3d991bdSwdenk
2303a3d991bdSwdenk		A 32bit integer which indicates the device capabilities;
2304a3d991bdSwdenk		0x00000010 for a normal host which does not forwards.
2305a3d991bdSwdenk
2306a3d991bdSwdenk		CONFIG_CDP_VERSION
2307a3d991bdSwdenk
2308a3d991bdSwdenk		An ascii string containing the version of the software.
2309a3d991bdSwdenk
2310a3d991bdSwdenk		CONFIG_CDP_PLATFORM
2311a3d991bdSwdenk
2312a3d991bdSwdenk		An ascii string containing the name of the platform.
2313a3d991bdSwdenk
2314a3d991bdSwdenk		CONFIG_CDP_TRIGGER
2315a3d991bdSwdenk
2316a3d991bdSwdenk		A 32bit integer sent on the trigger.
2317a3d991bdSwdenk
2318a3d991bdSwdenk		CONFIG_CDP_POWER_CONSUMPTION
2319a3d991bdSwdenk
2320a3d991bdSwdenk		A 16bit integer containing the power consumption of the
2321a3d991bdSwdenk		device in .1 of milliwatts.
2322a3d991bdSwdenk
2323a3d991bdSwdenk		CONFIG_CDP_APPLIANCE_VLAN_TYPE
2324a3d991bdSwdenk
2325a3d991bdSwdenk		A byte containing the id of the VLAN.
2326a3d991bdSwdenk
2327c609719bSwdenk- Status LED:	CONFIG_STATUS_LED
2328c609719bSwdenk
2329c609719bSwdenk		Several configurations allow to display the current
2330c609719bSwdenk		status using a LED. For instance, the LED will blink
2331c609719bSwdenk		fast while running U-Boot code, stop blinking as
2332c609719bSwdenk		soon as a reply to a BOOTP request was received, and
2333c609719bSwdenk		start blinking slow once the Linux kernel is running
2334c609719bSwdenk		(supported by a status LED driver in the Linux
2335c609719bSwdenk		kernel). Defining CONFIG_STATUS_LED enables this
2336c609719bSwdenk		feature in U-Boot.
2337c609719bSwdenk
23381df7bbbaSIgor Grinberg		Additional options:
23391df7bbbaSIgor Grinberg
23401df7bbbaSIgor Grinberg		CONFIG_GPIO_LED
23411df7bbbaSIgor Grinberg		The status LED can be connected to a GPIO pin.
23421df7bbbaSIgor Grinberg		In such cases, the gpio_led driver can be used as a
23431df7bbbaSIgor Grinberg		status LED backend implementation. Define CONFIG_GPIO_LED
23441df7bbbaSIgor Grinberg		to include the gpio_led driver in the U-Boot binary.
23451df7bbbaSIgor Grinberg
23469dfdcdfeSIgor Grinberg		CONFIG_GPIO_LED_INVERTED_TABLE
23479dfdcdfeSIgor Grinberg		Some GPIO connected LEDs may have inverted polarity in which
23489dfdcdfeSIgor Grinberg		case the GPIO high value corresponds to LED off state and
23499dfdcdfeSIgor Grinberg		GPIO low value corresponds to LED on state.
23509dfdcdfeSIgor Grinberg		In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
23519dfdcdfeSIgor Grinberg		with a list of GPIO LEDs that have inverted polarity.
23529dfdcdfeSIgor Grinberg
2353c609719bSwdenk- CAN Support:	CONFIG_CAN_DRIVER
2354c609719bSwdenk
2355c609719bSwdenk		Defining CONFIG_CAN_DRIVER enables CAN driver support
2356c609719bSwdenk		on those systems that support this (optional)
2357c609719bSwdenk		feature, like the TQM8xxL modules.
2358c609719bSwdenk
23593f4978c7SHeiko Schocher- I2C Support:	CONFIG_SYS_I2C
2360c609719bSwdenk
23613f4978c7SHeiko Schocher		This enable the NEW i2c subsystem, and will allow you to use
23623f4978c7SHeiko Schocher		i2c commands at the u-boot command line (as long as you set
23633f4978c7SHeiko Schocher		CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
23643f4978c7SHeiko Schocher		based realtime clock chips or other i2c devices. See
23653f4978c7SHeiko Schocher		common/cmd_i2c.c for a description of the command line
23663f4978c7SHeiko Schocher		interface.
23673f4978c7SHeiko Schocher
23683f4978c7SHeiko Schocher		ported i2c driver to the new framework:
2369ea818dbbSHeiko Schocher		- drivers/i2c/soft_i2c.c:
2370ea818dbbSHeiko Schocher		  - activate first bus with CONFIG_SYS_I2C_SOFT define
2371ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2372ea818dbbSHeiko Schocher		    for defining speed and slave address
2373ea818dbbSHeiko Schocher		  - activate second bus with I2C_SOFT_DECLARATIONS2 define
2374ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2375ea818dbbSHeiko Schocher		    for defining speed and slave address
2376ea818dbbSHeiko Schocher		  - activate third bus with I2C_SOFT_DECLARATIONS3 define
2377ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2378ea818dbbSHeiko Schocher		    for defining speed and slave address
2379ea818dbbSHeiko Schocher		  - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2380ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2381ea818dbbSHeiko Schocher		    for defining speed and slave address
23823f4978c7SHeiko Schocher
238300f792e0SHeiko Schocher		- drivers/i2c/fsl_i2c.c:
238400f792e0SHeiko Schocher		  - activate i2c driver with CONFIG_SYS_I2C_FSL
238500f792e0SHeiko Schocher		    define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
238600f792e0SHeiko Schocher		    offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
238700f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
238800f792e0SHeiko Schocher		    bus.
238900f792e0SHeiko Schocher		  - If your board supports a second fsl i2c bus, define
239000f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
239100f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_SPEED for the speed and
239200f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
239300f792e0SHeiko Schocher		    second bus.
239400f792e0SHeiko Schocher
23951f2ba722SSimon Glass		- drivers/i2c/tegra_i2c.c:
23961f2ba722SSimon Glass		  - activate this driver with CONFIG_SYS_I2C_TEGRA
23971f2ba722SSimon Glass		  - This driver adds 4 i2c buses with a fix speed from
23981f2ba722SSimon Glass		    100000 and the slave addr 0!
23991f2ba722SSimon Glass
2400880540deSDirk Eibach		- drivers/i2c/ppc4xx_i2c.c
2401880540deSDirk Eibach		  - activate this driver with CONFIG_SYS_I2C_PPC4XX
2402880540deSDirk Eibach		  - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2403880540deSDirk Eibach		  - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2404880540deSDirk Eibach
2405fac96408Strem		- drivers/i2c/i2c_mxc.c
2406fac96408Strem		  - activate this driver with CONFIG_SYS_I2C_MXC
2407fac96408Strem		  - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2408fac96408Strem		  - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2409fac96408Strem		  - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2410fac96408Strem		  - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2411fac96408Strem		  - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2412fac96408Strem		  - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
2413b445bbb4SJeremiah Mahler		If those defines are not set, default value is 100000
2414fac96408Strem		for speed, and 0 for slave.
2415fac96408Strem
24161086bfa9SNobuhiro Iwamatsu		- drivers/i2c/rcar_i2c.c:
24171086bfa9SNobuhiro Iwamatsu		  - activate this driver with CONFIG_SYS_I2C_RCAR
24181086bfa9SNobuhiro Iwamatsu		  - This driver adds 4 i2c buses
24191086bfa9SNobuhiro Iwamatsu
24201086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
24211086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
24221086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
24231086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
24241086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
24251086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
24261086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
24271086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
24281086bfa9SNobuhiro Iwamatsu		  - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
24291086bfa9SNobuhiro Iwamatsu
24302035d77dSNobuhiro Iwamatsu		- drivers/i2c/sh_i2c.c:
24312035d77dSNobuhiro Iwamatsu		  - activate this driver with CONFIG_SYS_I2C_SH
24322035d77dSNobuhiro Iwamatsu		  - This driver adds from 2 to 5 i2c buses
24332035d77dSNobuhiro Iwamatsu
24342035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
24352035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
24362035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
24372035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
24382035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
24392035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
24402035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
24412035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
24422035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
24432035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
24442035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
24452035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
2446b445bbb4SJeremiah Mahler		  - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
24472035d77dSNobuhiro Iwamatsu
24486789e84eSHeiko Schocher		- drivers/i2c/omap24xx_i2c.c
24496789e84eSHeiko Schocher		  - activate this driver with CONFIG_SYS_I2C_OMAP24XX
24506789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
24516789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
24526789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
24536789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
24546789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
24556789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
24566789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
24576789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
24586789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
24596789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
24606789e84eSHeiko Schocher
24610bdffe71SHeiko Schocher		- drivers/i2c/zynq_i2c.c
24620bdffe71SHeiko Schocher		  - activate this driver with CONFIG_SYS_I2C_ZYNQ
24630bdffe71SHeiko Schocher		  - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
24640bdffe71SHeiko Schocher		  - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
24650bdffe71SHeiko Schocher
2466e717fc6dSNaveen Krishna Ch		- drivers/i2c/s3c24x0_i2c.c:
2467e717fc6dSNaveen Krishna Ch		  - activate this driver with CONFIG_SYS_I2C_S3C24X0
2468e717fc6dSNaveen Krishna Ch		  - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2469e717fc6dSNaveen Krishna Ch		    9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2470e717fc6dSNaveen Krishna Ch		    with a fix speed from 100000 and the slave addr 0!
2471e717fc6dSNaveen Krishna Ch
2472b46226bdSDirk Eibach		- drivers/i2c/ihs_i2c.c
2473b46226bdSDirk Eibach		  - activate this driver with CONFIG_SYS_I2C_IHS
2474b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
2475b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
2476b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
2477b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
2478b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
2479b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
2480b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
2481b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
2482b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
2483b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
2484b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
2485b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
2486b46226bdSDirk Eibach
24873f4978c7SHeiko Schocher		additional defines:
24883f4978c7SHeiko Schocher
24893f4978c7SHeiko Schocher		CONFIG_SYS_NUM_I2C_BUSES
2490b445bbb4SJeremiah Mahler		Hold the number of i2c buses you want to use. If you
24913f4978c7SHeiko Schocher		don't use/have i2c muxes on your i2c bus, this
24923f4978c7SHeiko Schocher		is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
24933f4978c7SHeiko Schocher		omit this define.
24943f4978c7SHeiko Schocher
24953f4978c7SHeiko Schocher		CONFIG_SYS_I2C_DIRECT_BUS
24963f4978c7SHeiko Schocher		define this, if you don't use i2c muxes on your hardware.
24973f4978c7SHeiko Schocher		if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
24983f4978c7SHeiko Schocher		omit this define.
24993f4978c7SHeiko Schocher
25003f4978c7SHeiko Schocher		CONFIG_SYS_I2C_MAX_HOPS
25013f4978c7SHeiko Schocher		define how many muxes are maximal consecutively connected
25023f4978c7SHeiko Schocher		on one i2c bus. If you not use i2c muxes, omit this
25033f4978c7SHeiko Schocher		define.
25043f4978c7SHeiko Schocher
25053f4978c7SHeiko Schocher		CONFIG_SYS_I2C_BUSES
2506b445bbb4SJeremiah Mahler		hold a list of buses you want to use, only used if
25073f4978c7SHeiko Schocher		CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
25083f4978c7SHeiko Schocher		a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
25093f4978c7SHeiko Schocher		CONFIG_SYS_NUM_I2C_BUSES = 9:
25103f4978c7SHeiko Schocher
25113f4978c7SHeiko Schocher		 CONFIG_SYS_I2C_BUSES	{{0, {I2C_NULL_HOP}}, \
25123f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
25133f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
25143f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
25153f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
25163f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
25173f4978c7SHeiko Schocher					{1, {I2C_NULL_HOP}}, \
25183f4978c7SHeiko Schocher					{1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
25193f4978c7SHeiko Schocher					{1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
25203f4978c7SHeiko Schocher					}
25213f4978c7SHeiko Schocher
25223f4978c7SHeiko Schocher		which defines
25233f4978c7SHeiko Schocher			bus 0 on adapter 0 without a mux
2524ea818dbbSHeiko Schocher			bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2525ea818dbbSHeiko Schocher			bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2526ea818dbbSHeiko Schocher			bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2527ea818dbbSHeiko Schocher			bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2528ea818dbbSHeiko Schocher			bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
25293f4978c7SHeiko Schocher			bus 6 on adapter 1 without a mux
2530ea818dbbSHeiko Schocher			bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2531ea818dbbSHeiko Schocher			bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
25323f4978c7SHeiko Schocher
25333f4978c7SHeiko Schocher		If you do not have i2c muxes on your board, omit this define.
25343f4978c7SHeiko Schocher
2535ea818dbbSHeiko Schocher- Legacy I2C Support:	CONFIG_HARD_I2C
25363f4978c7SHeiko Schocher
25373f4978c7SHeiko Schocher		NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
25383f4978c7SHeiko Schocher		provides the following compelling advantages:
25393f4978c7SHeiko Schocher
25403f4978c7SHeiko Schocher		- more than one i2c adapter is usable
25413f4978c7SHeiko Schocher		- approved multibus support
25423f4978c7SHeiko Schocher		- better i2c mux support
25433f4978c7SHeiko Schocher
25443f4978c7SHeiko Schocher		** Please consider updating your I2C driver now. **
25453f4978c7SHeiko Schocher
2546ea818dbbSHeiko Schocher		These enable legacy I2C serial bus commands. Defining
2547ea818dbbSHeiko Schocher		CONFIG_HARD_I2C will include the appropriate I2C driver
2548ea818dbbSHeiko Schocher		for the selected CPU.
2549c609719bSwdenk
2550b37c7e5eSwdenk		This will allow you to use i2c commands at the u-boot
2551602ad3b3SJon Loeliger		command line (as long as you set CONFIG_CMD_I2C in
2552b37c7e5eSwdenk		CONFIG_COMMANDS) and communicate with i2c based realtime
2553b37c7e5eSwdenk		clock chips. See common/cmd_i2c.c for a description of the
2554c609719bSwdenk		command line interface.
2555c609719bSwdenk
2556bb99ad6dSBen Warren		CONFIG_HARD_I2C selects a hardware I2C controller.
2557c609719bSwdenk
2558b37c7e5eSwdenk		There are several other quantities that must also be
2559ea818dbbSHeiko Schocher		defined when you define CONFIG_HARD_I2C.
2560c609719bSwdenk
25616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		In both cases you will need to define CONFIG_SYS_I2C_SPEED
2562b37c7e5eSwdenk		to be the frequency (in Hz) at which you wish your i2c bus
25636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
256411ccc33fSMarcel Ziswiler		the CPU's i2c node address).
2565c609719bSwdenk
25668d321b81SPeter Tyser		Now, the u-boot i2c code for the mpc8xx
2567a47a12beSStefan Roese		(arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
25688d321b81SPeter Tyser		and so its address should therefore be cleared to 0 (See,
25698d321b81SPeter Tyser		eg, MPC823e User's Manual p.16-473). So, set
25708d321b81SPeter Tyser		CONFIG_SYS_I2C_SLAVE to 0.
2571b37c7e5eSwdenk
25725da71efaSEric Millbrandt		CONFIG_SYS_I2C_INIT_MPC5XXX
25735da71efaSEric Millbrandt
25745da71efaSEric Millbrandt		When a board is reset during an i2c bus transfer
25755da71efaSEric Millbrandt		chips might think that the current transfer is still
25765da71efaSEric Millbrandt		in progress.  Reset the slave devices by sending start
25775da71efaSEric Millbrandt		commands until the slave device responds.
25785da71efaSEric Millbrandt
2579b37c7e5eSwdenk		That's all that's required for CONFIG_HARD_I2C.
2580b37c7e5eSwdenk
2581ea818dbbSHeiko Schocher		If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
2582b37c7e5eSwdenk		then the following macros need to be defined (examples are
2583b37c7e5eSwdenk		from include/configs/lwmon.h):
2584c609719bSwdenk
2585c609719bSwdenk		I2C_INIT
2586c609719bSwdenk
2587b37c7e5eSwdenk		(Optional). Any commands necessary to enable the I2C
2588c609719bSwdenk		controller or configure ports.
2589c609719bSwdenk
2590b37c7e5eSwdenk		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
2591b37c7e5eSwdenk
2592c609719bSwdenk		I2C_PORT
2593c609719bSwdenk
2594c609719bSwdenk		(Only for MPC8260 CPU). The I/O port to use (the code
2595c609719bSwdenk		assumes both bits are on the same port). Valid values
2596c609719bSwdenk		are 0..3 for ports A..D.
2597c609719bSwdenk
2598c609719bSwdenk		I2C_ACTIVE
2599c609719bSwdenk
2600c609719bSwdenk		The code necessary to make the I2C data line active
2601c609719bSwdenk		(driven).  If the data line is open collector, this
2602c609719bSwdenk		define can be null.
2603c609719bSwdenk
2604b37c7e5eSwdenk		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
2605b37c7e5eSwdenk
2606c609719bSwdenk		I2C_TRISTATE
2607c609719bSwdenk
2608c609719bSwdenk		The code necessary to make the I2C data line tri-stated
2609c609719bSwdenk		(inactive).  If the data line is open collector, this
2610c609719bSwdenk		define can be null.
2611c609719bSwdenk
2612b37c7e5eSwdenk		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2613b37c7e5eSwdenk
2614c609719bSwdenk		I2C_READ
2615c609719bSwdenk
2616472d5460SYork Sun		Code that returns true if the I2C data line is high,
2617472d5460SYork Sun		false if it is low.
2618c609719bSwdenk
2619b37c7e5eSwdenk		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2620b37c7e5eSwdenk
2621c609719bSwdenk		I2C_SDA(bit)
2622c609719bSwdenk
2623472d5460SYork Sun		If <bit> is true, sets the I2C data line high. If it
2624472d5460SYork Sun		is false, it clears it (low).
2625c609719bSwdenk
2626b37c7e5eSwdenk		eg: #define I2C_SDA(bit) \
2627b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
2628b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
2629b37c7e5eSwdenk
2630c609719bSwdenk		I2C_SCL(bit)
2631c609719bSwdenk
2632472d5460SYork Sun		If <bit> is true, sets the I2C clock line high. If it
2633472d5460SYork Sun		is false, it clears it (low).
2634c609719bSwdenk
2635b37c7e5eSwdenk		eg: #define I2C_SCL(bit) \
2636b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
2637b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
2638b37c7e5eSwdenk
2639c609719bSwdenk		I2C_DELAY
2640c609719bSwdenk
2641c609719bSwdenk		This delay is invoked four times per clock cycle so this
2642c609719bSwdenk		controls the rate of data transfer.  The data rate thus
2643b37c7e5eSwdenk		is 1 / (I2C_DELAY * 4). Often defined to be something
2644b37c7e5eSwdenk		like:
2645b37c7e5eSwdenk
2646b37c7e5eSwdenk		#define I2C_DELAY  udelay(2)
2647c609719bSwdenk
2648793b5726SMike Frysinger		CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2649793b5726SMike Frysinger
2650793b5726SMike Frysinger		If your arch supports the generic GPIO framework (asm/gpio.h),
2651793b5726SMike Frysinger		then you may alternatively define the two GPIOs that are to be
2652793b5726SMike Frysinger		used as SCL / SDA.  Any of the previous I2C_xxx macros will
2653793b5726SMike Frysinger		have GPIO-based defaults assigned to them as appropriate.
2654793b5726SMike Frysinger
2655793b5726SMike Frysinger		You should define these to the GPIO value as given directly to
2656793b5726SMike Frysinger		the generic GPIO functions.
2657793b5726SMike Frysinger
26586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_INIT_BOARD
265947cd00faSwdenk
266047cd00faSwdenk		When a board is reset during an i2c bus transfer
266147cd00faSwdenk		chips might think that the current transfer is still
266247cd00faSwdenk		in progress. On some boards it is possible to access
266347cd00faSwdenk		the i2c SCLK line directly, either by using the
266447cd00faSwdenk		processor pin as a GPIO or by having a second pin
266547cd00faSwdenk		connected to the bus. If this option is defined a
266647cd00faSwdenk		custom i2c_init_board() routine in boards/xxx/board.c
266747cd00faSwdenk		is run early in the boot sequence.
266847cd00faSwdenk
266926a33504SRichard Retanubun		CONFIG_SYS_I2C_BOARD_LATE_INIT
267026a33504SRichard Retanubun
267126a33504SRichard Retanubun		An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
267226a33504SRichard Retanubun		defined a custom i2c_board_late_init() routine in
267326a33504SRichard Retanubun		boards/xxx/board.c is run AFTER the operations in i2c_init()
267426a33504SRichard Retanubun		is completed. This callpoint can be used to unreset i2c bus
267526a33504SRichard Retanubun		using CPU i2c controller register accesses for CPUs whose i2c
267626a33504SRichard Retanubun		controller provide such a method. It is called at the end of
267726a33504SRichard Retanubun		i2c_init() to allow i2c_init operations to setup the i2c bus
267826a33504SRichard Retanubun		controller on the CPU (e.g. setting bus speed & slave address).
267926a33504SRichard Retanubun
268017ea1177Swdenk		CONFIG_I2CFAST (PPC405GP|PPC405EP only)
268117ea1177Swdenk
268217ea1177Swdenk		This option enables configuration of bi_iic_fast[] flags
268317ea1177Swdenk		in u-boot bd_info structure based on u-boot environment
268417ea1177Swdenk		variable "i2cfast". (see also i2cfast)
268517ea1177Swdenk
2686bb99ad6dSBen Warren		CONFIG_I2C_MULTI_BUS
2687bb99ad6dSBen Warren
2688bb99ad6dSBen Warren		This option allows the use of multiple I2C buses, each of which
2689bb99ad6dSBen Warren		must have a controller.	 At any point in time, only one bus is
2690bb99ad6dSBen Warren		active.	 To switch to a different bus, use the 'i2c dev' command.
2691bb99ad6dSBen Warren		Note that bus numbering is zero-based.
2692bb99ad6dSBen Warren
26936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_NOPROBES
2694bb99ad6dSBen Warren
2695bb99ad6dSBen Warren		This option specifies a list of I2C devices that will be skipped
26960f89c54bSPeter Tyser		when the 'i2c probe' command is issued.	 If CONFIG_I2C_MULTI_BUS
26970f89c54bSPeter Tyser		is set, specify a list of bus-device pairs.  Otherwise, specify
26980f89c54bSPeter Tyser		a 1D array of device addresses
2699bb99ad6dSBen Warren
2700bb99ad6dSBen Warren		e.g.
2701bb99ad6dSBen Warren			#undef	CONFIG_I2C_MULTI_BUS
27026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
2703bb99ad6dSBen Warren
2704bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on a board with one I2C bus
2705bb99ad6dSBen Warren
2706bb99ad6dSBen Warren			#define CONFIG_I2C_MULTI_BUS
27076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_MULTI_NOPROBES	{{0,0x50},{0,0x68},{1,0x54}}
2708bb99ad6dSBen Warren
2709bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2710bb99ad6dSBen Warren
27116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SPD_BUS_NUM
2712be5e6181STimur Tabi
2713be5e6181STimur Tabi		If defined, then this indicates the I2C bus number for DDR SPD.
2714be5e6181STimur Tabi		If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2715be5e6181STimur Tabi
27166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_BUS_NUM
27170dc018ecSStefan Roese
27180dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the RTC.
27190dc018ecSStefan Roese		If not defined, then U-Boot assumes that RTC is on I2C bus 0.
27200dc018ecSStefan Roese
27216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_DTT_BUS_NUM
27220dc018ecSStefan Roese
27230dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the DTT.
27240dc018ecSStefan Roese		If not defined, then U-Boot assumes that DTT is on I2C bus 0.
27250dc018ecSStefan Roese
27266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_DTT_ADDR:
27279ebbb54fSVictor Gallardo
27289ebbb54fSVictor Gallardo		If defined, specifies the I2C address of the DTT device.
27299ebbb54fSVictor Gallardo		If not defined, then U-Boot uses predefined value for
27309ebbb54fSVictor Gallardo		specified DTT device.
27319ebbb54fSVictor Gallardo
27322ac6985aSAndrew Dyer		CONFIG_SOFT_I2C_READ_REPEATED_START
27332ac6985aSAndrew Dyer
27342ac6985aSAndrew Dyer		defining this will force the i2c_read() function in
27352ac6985aSAndrew Dyer		the soft_i2c driver to perform an I2C repeated start
27362ac6985aSAndrew Dyer		between writing the address pointer and reading the
27372ac6985aSAndrew Dyer		data.  If this define is omitted the default behaviour
27382ac6985aSAndrew Dyer		of doing a stop-start sequence will be used.  Most I2C
27392ac6985aSAndrew Dyer		devices can use either method, but some require one or
27402ac6985aSAndrew Dyer		the other.
2741be5e6181STimur Tabi
2742c609719bSwdenk- SPI Support:	CONFIG_SPI
2743c609719bSwdenk
2744c609719bSwdenk		Enables SPI driver (so far only tested with
2745c609719bSwdenk		SPI EEPROM, also an instance works with Crystal A/D and
2746c609719bSwdenk		D/As on the SACSng board)
2747c609719bSwdenk
27486639562eSYoshihiro Shimoda		CONFIG_SH_SPI
27496639562eSYoshihiro Shimoda
27506639562eSYoshihiro Shimoda		Enables the driver for SPI controller on SuperH. Currently
27516639562eSYoshihiro Shimoda		only SH7757 is supported.
27526639562eSYoshihiro Shimoda
2753c609719bSwdenk		CONFIG_SPI_X
2754c609719bSwdenk
2755c609719bSwdenk		Enables extended (16-bit) SPI EEPROM addressing.
2756c609719bSwdenk		(symmetrical to CONFIG_I2C_X)
2757c609719bSwdenk
2758c609719bSwdenk		CONFIG_SOFT_SPI
2759c609719bSwdenk
2760c609719bSwdenk		Enables a software (bit-bang) SPI driver rather than
2761c609719bSwdenk		using hardware support. This is a general purpose
2762c609719bSwdenk		driver that only requires three general I/O port pins
2763c609719bSwdenk		(two outputs, one input) to function. If this is
2764c609719bSwdenk		defined, the board configuration must define several
2765c609719bSwdenk		SPI configuration items (port pins to use, etc). For
2766c609719bSwdenk		an example, see include/configs/sacsng.h.
2767c609719bSwdenk
276804a9e118SBen Warren		CONFIG_HARD_SPI
276904a9e118SBen Warren
277004a9e118SBen Warren		Enables a hardware SPI driver for general-purpose reads
277104a9e118SBen Warren		and writes.  As with CONFIG_SOFT_SPI, the board configuration
277204a9e118SBen Warren		must define a list of chip-select function pointers.
277304a9e118SBen Warren		Currently supported on some MPC8xxx processors.	 For an
277404a9e118SBen Warren		example, see include/configs/mpc8349emds.h.
277504a9e118SBen Warren
277638254f45SGuennadi Liakhovetski		CONFIG_MXC_SPI
277738254f45SGuennadi Liakhovetski
277838254f45SGuennadi Liakhovetski		Enables the driver for the SPI controllers on i.MX and MXC
27792e3cd1cdSFabio Estevam		SoCs. Currently i.MX31/35/51 are supported.
278038254f45SGuennadi Liakhovetski
2781f659b573SHeiko Schocher		CONFIG_SYS_SPI_MXC_WAIT
2782f659b573SHeiko Schocher		Timeout for waiting until spi transfer completed.
2783f659b573SHeiko Schocher		default: (CONFIG_SYS_HZ/100)     /* 10 ms */
2784f659b573SHeiko Schocher
27850133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA
27860133502eSMatthias Fuchs
27870133502eSMatthias Fuchs		Enables FPGA subsystem.
27880133502eSMatthias Fuchs
27890133502eSMatthias Fuchs		CONFIG_FPGA_<vendor>
27900133502eSMatthias Fuchs
27910133502eSMatthias Fuchs		Enables support for specific chip vendors.
27920133502eSMatthias Fuchs		(ALTERA, XILINX)
27930133502eSMatthias Fuchs
27940133502eSMatthias Fuchs		CONFIG_FPGA_<family>
27950133502eSMatthias Fuchs
27960133502eSMatthias Fuchs		Enables support for FPGA family.
27970133502eSMatthias Fuchs		(SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
27980133502eSMatthias Fuchs
27990133502eSMatthias Fuchs		CONFIG_FPGA_COUNT
2800c609719bSwdenk
2801c609719bSwdenk		Specify the number of FPGA devices to support.
2802c609719bSwdenk
280364e809afSSiva Durga Prasad Paladugu		CONFIG_CMD_FPGA_LOADMK
280464e809afSSiva Durga Prasad Paladugu
280564e809afSSiva Durga Prasad Paladugu		Enable support for fpga loadmk command
280664e809afSSiva Durga Prasad Paladugu
280767193864SMichal Simek		CONFIG_CMD_FPGA_LOADP
280867193864SMichal Simek
280967193864SMichal Simek		Enable support for fpga loadp command - load partial bitstream
281067193864SMichal Simek
281167193864SMichal Simek		CONFIG_CMD_FPGA_LOADBP
281267193864SMichal Simek
281367193864SMichal Simek		Enable support for fpga loadbp command - load partial bitstream
281467193864SMichal Simek		(Xilinx only)
281567193864SMichal Simek
28166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_PROG_FEEDBACK
2817c609719bSwdenk
2818c609719bSwdenk		Enable printing of hash marks during FPGA configuration.
2819c609719bSwdenk
28206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_BUSY
2821c609719bSwdenk
2822c609719bSwdenk		Enable checks on FPGA configuration interface busy
2823c609719bSwdenk		status by the configuration function. This option
2824c609719bSwdenk		will require a board or device specific function to
2825c609719bSwdenk		be written.
2826c609719bSwdenk
2827c609719bSwdenk		CONFIG_FPGA_DELAY
2828c609719bSwdenk
2829c609719bSwdenk		If defined, a function that provides delays in the FPGA
2830c609719bSwdenk		configuration driver.
2831c609719bSwdenk
28326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_CTRLC
2833c609719bSwdenk		Allow Control-C to interrupt FPGA configuration
2834c609719bSwdenk
28356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_ERROR
2836c609719bSwdenk
2837c609719bSwdenk		Check for configuration errors during FPGA bitfile
2838c609719bSwdenk		loading. For example, abort during Virtex II
2839c609719bSwdenk		configuration if the INIT_B line goes low (which
2840c609719bSwdenk		indicated a CRC error).
2841c609719bSwdenk
28426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_INIT
2843c609719bSwdenk
2844b445bbb4SJeremiah Mahler		Maximum time to wait for the INIT_B line to de-assert
2845b445bbb4SJeremiah Mahler		after PROB_B has been de-asserted during a Virtex II
2846c609719bSwdenk		FPGA configuration sequence. The default time is 500
284711ccc33fSMarcel Ziswiler		ms.
2848c609719bSwdenk
28496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_BUSY
2850c609719bSwdenk
2851b445bbb4SJeremiah Mahler		Maximum time to wait for BUSY to de-assert during
285211ccc33fSMarcel Ziswiler		Virtex II FPGA configuration. The default is 5 ms.
2853c609719bSwdenk
28546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_CONFIG
2855c609719bSwdenk
2856c609719bSwdenk		Time to wait after FPGA configuration. The default is
285711ccc33fSMarcel Ziswiler		200 ms.
2858c609719bSwdenk
2859c609719bSwdenk- Configuration Management:
2860b2b8a696SStefan Roese		CONFIG_BUILD_TARGET
2861b2b8a696SStefan Roese
2862b2b8a696SStefan Roese		Some SoCs need special image types (e.g. U-Boot binary
2863b2b8a696SStefan Roese		with a special header) as build targets. By defining
2864b2b8a696SStefan Roese		CONFIG_BUILD_TARGET in the SoC / board header, this
2865b2b8a696SStefan Roese		special image will be automatically built upon calling
2866b2b8a696SStefan Roese		make / MAKEALL.
2867b2b8a696SStefan Roese
2868c609719bSwdenk		CONFIG_IDENT_STRING
2869c609719bSwdenk
2870c609719bSwdenk		If defined, this string will be added to the U-Boot
2871c609719bSwdenk		version information (U_BOOT_VERSION)
2872c609719bSwdenk
2873c609719bSwdenk- Vendor Parameter Protection:
2874c609719bSwdenk
2875c609719bSwdenk		U-Boot considers the values of the environment
2876c609719bSwdenk		variables "serial#" (Board Serial Number) and
28777152b1d0Swdenk		"ethaddr" (Ethernet Address) to be parameters that
2878c609719bSwdenk		are set once by the board vendor / manufacturer, and
2879c609719bSwdenk		protects these variables from casual modification by
2880c609719bSwdenk		the user. Once set, these variables are read-only,
2881c609719bSwdenk		and write or delete attempts are rejected. You can
288211ccc33fSMarcel Ziswiler		change this behaviour:
2883c609719bSwdenk
2884c609719bSwdenk		If CONFIG_ENV_OVERWRITE is #defined in your config
2885c609719bSwdenk		file, the write protection for vendor parameters is
288647cd00faSwdenk		completely disabled. Anybody can change or delete
2887c609719bSwdenk		these parameters.
2888c609719bSwdenk
2889c609719bSwdenk		Alternatively, if you #define _both_ CONFIG_ETHADDR
2890c609719bSwdenk		_and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
289111ccc33fSMarcel Ziswiler		Ethernet address is installed in the environment,
2892c609719bSwdenk		which can be changed exactly ONCE by the user. [The
2893c609719bSwdenk		serial# is unaffected by this, i. e. it remains
2894c609719bSwdenk		read-only.]
2895c609719bSwdenk
28962598090bSJoe Hershberger		The same can be accomplished in a more flexible way
28972598090bSJoe Hershberger		for any variable by configuring the type of access
28982598090bSJoe Hershberger		to allow for those variables in the ".flags" variable
28992598090bSJoe Hershberger		or define CONFIG_ENV_FLAGS_LIST_STATIC.
29002598090bSJoe Hershberger
2901c609719bSwdenk- Protected RAM:
2902c609719bSwdenk		CONFIG_PRAM
2903c609719bSwdenk
2904c609719bSwdenk		Define this variable to enable the reservation of
2905c609719bSwdenk		"protected RAM", i. e. RAM which is not overwritten
2906c609719bSwdenk		by U-Boot. Define CONFIG_PRAM to hold the number of
2907c609719bSwdenk		kB you want to reserve for pRAM. You can overwrite
2908c609719bSwdenk		this default value by defining an environment
2909c609719bSwdenk		variable "pram" to the number of kB you want to
2910c609719bSwdenk		reserve. Note that the board info structure will
2911c609719bSwdenk		still show the full amount of RAM. If pRAM is
2912c609719bSwdenk		reserved, a new environment variable "mem" will
2913c609719bSwdenk		automatically be defined to hold the amount of
2914c609719bSwdenk		remaining RAM in a form that can be passed as boot
2915c609719bSwdenk		argument to Linux, for instance like that:
2916c609719bSwdenk
2917fe126d8bSWolfgang Denk			setenv bootargs ... mem=\${mem}
2918c609719bSwdenk			saveenv
2919c609719bSwdenk
2920c609719bSwdenk		This way you can tell Linux not to use this memory,
2921c609719bSwdenk		either, which results in a memory region that will
2922c609719bSwdenk		not be affected by reboots.
2923c609719bSwdenk
2924c609719bSwdenk		*WARNING* If your board configuration uses automatic
2925c609719bSwdenk		detection of the RAM size, you must make sure that
2926c609719bSwdenk		this memory test is non-destructive. So far, the
2927c609719bSwdenk		following board configurations are known to be
2928c609719bSwdenk		"pRAM-clean":
2929c609719bSwdenk
29301b0757ecSWolfgang Denk			IVMS8, IVML24, SPD8xx, TQM8xxL,
29311b0757ecSWolfgang Denk			HERMES, IP860, RPXlite, LWMON,
2932544d97e9SWolfgang Denk			FLAGADM, TQM8260
2933c609719bSwdenk
293440fef049SGabe Black- Access to physical memory region (> 4GB)
293540fef049SGabe Black		Some basic support is provided for operations on memory not
293640fef049SGabe Black		normally accessible to U-Boot - e.g. some architectures
293740fef049SGabe Black		support access to more than 4GB of memory on 32-bit
293840fef049SGabe Black		machines using physical address extension or similar.
293940fef049SGabe Black		Define CONFIG_PHYSMEM to access this basic support, which
294040fef049SGabe Black		currently only supports clearing the memory.
294140fef049SGabe Black
2942c609719bSwdenk- Error Recovery:
2943c609719bSwdenk		CONFIG_PANIC_HANG
2944c609719bSwdenk
2945c609719bSwdenk		Define this variable to stop the system in case of a
2946c609719bSwdenk		fatal error, so that you have to reset it manually.
2947c609719bSwdenk		This is probably NOT a good idea for an embedded
294811ccc33fSMarcel Ziswiler		system where you want the system to reboot
2949c609719bSwdenk		automatically as fast as possible, but it may be
2950c609719bSwdenk		useful during development since you can try to debug
2951c609719bSwdenk		the conditions that lead to the situation.
2952c609719bSwdenk
2953c609719bSwdenk		CONFIG_NET_RETRY_COUNT
2954c609719bSwdenk
2955c609719bSwdenk		This variable defines the number of retries for
2956c609719bSwdenk		network operations like ARP, RARP, TFTP, or BOOTP
2957c609719bSwdenk		before giving up the operation. If not defined, a
2958c609719bSwdenk		default value of 5 is used.
2959c609719bSwdenk
296040cb90eeSGuennadi Liakhovetski		CONFIG_ARP_TIMEOUT
296140cb90eeSGuennadi Liakhovetski
296240cb90eeSGuennadi Liakhovetski		Timeout waiting for an ARP reply in milliseconds.
296340cb90eeSGuennadi Liakhovetski
296448a3e999STetsuyuki Kobayashi		CONFIG_NFS_TIMEOUT
296548a3e999STetsuyuki Kobayashi
296648a3e999STetsuyuki Kobayashi		Timeout in milliseconds used in NFS protocol.
296748a3e999STetsuyuki Kobayashi		If you encounter "ERROR: Cannot umount" in nfs command,
296848a3e999STetsuyuki Kobayashi		try longer timeout such as
296948a3e999STetsuyuki Kobayashi		#define CONFIG_NFS_TIMEOUT 10000UL
297048a3e999STetsuyuki Kobayashi
2971c609719bSwdenk- Command Interpreter:
29728078f1a5SWolfgang Denk		CONFIG_AUTO_COMPLETE
297304a85b3bSwdenk
297404a85b3bSwdenk		Enable auto completion of commands using TAB.
297504a85b3bSwdenk
29766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_PROMPT_HUSH_PS2
2977c609719bSwdenk
2978c609719bSwdenk		This defines the secondary prompt string, which is
2979c609719bSwdenk		printed when the command interpreter needs more input
2980c609719bSwdenk		to complete a command. Usually "> ".
2981c609719bSwdenk
2982c609719bSwdenk	Note:
2983c609719bSwdenk
2984c609719bSwdenk		In the current implementation, the local variables
2985c609719bSwdenk		space and global environment variables space are
2986c609719bSwdenk		separated. Local variables are those you define by
29873b57fe0aSwdenk		simply typing `name=value'. To access a local
2988c609719bSwdenk		variable later on, you have write `$name' or
29893b57fe0aSwdenk		`${name}'; to execute the contents of a variable
29903b57fe0aSwdenk		directly type `$name' at the command prompt.
2991c609719bSwdenk
2992c609719bSwdenk		Global environment variables are those you use
2993c609719bSwdenk		setenv/printenv to work with. To run a command stored
2994c609719bSwdenk		in such a variable, you need to use the run command,
2995c609719bSwdenk		and you must not use the '$' sign to access them.
2996c609719bSwdenk
2997c609719bSwdenk		To store commands and special characters in a
2998c609719bSwdenk		variable, please use double quotation marks
2999c609719bSwdenk		surrounding the whole text of the variable, instead
3000c609719bSwdenk		of the backslashes before semicolons and special
3001c609719bSwdenk		symbols.
3002c609719bSwdenk
3003b445bbb4SJeremiah Mahler- Command Line Editing and History:
3004aa0c71acSWolfgang Denk		CONFIG_CMDLINE_EDITING
3005aa0c71acSWolfgang Denk
300611ccc33fSMarcel Ziswiler		Enable editing and History functions for interactive
3007aa0c71acSWolfgang Denk		command line input operations
3008aa0c71acSWolfgang Denk
3009a8c7c708Swdenk- Default Environment:
3010c609719bSwdenk		CONFIG_EXTRA_ENV_SETTINGS
3011c609719bSwdenk
3012c609719bSwdenk		Define this to contain any number of null terminated
3013c609719bSwdenk		strings (variable = value pairs) that will be part of
30147152b1d0Swdenk		the default environment compiled into the boot image.
30152262cfeeSwdenk
3016c609719bSwdenk		For example, place something like this in your
3017c609719bSwdenk		board's config file:
3018c609719bSwdenk
3019c609719bSwdenk		#define CONFIG_EXTRA_ENV_SETTINGS \
3020c609719bSwdenk			"myvar1=value1\0" \
3021c609719bSwdenk			"myvar2=value2\0"
3022c609719bSwdenk
3023c609719bSwdenk		Warning: This method is based on knowledge about the
3024c609719bSwdenk		internal format how the environment is stored by the
30252262cfeeSwdenk		U-Boot code. This is NOT an official, exported
3026c609719bSwdenk		interface! Although it is unlikely that this format
30277152b1d0Swdenk		will change soon, there is no guarantee either.
3028c609719bSwdenk		You better know what you are doing here.
3029c609719bSwdenk
3030c609719bSwdenk		Note: overly (ab)use of the default environment is
3031c609719bSwdenk		discouraged. Make sure to check other ways to preset
303274de7aefSWolfgang Denk		the environment like the "source" command or the
3033c609719bSwdenk		boot command first.
3034c609719bSwdenk
30355e724ca2SStephen Warren		CONFIG_ENV_VARS_UBOOT_CONFIG
30365e724ca2SStephen Warren
30375e724ca2SStephen Warren		Define this in order to add variables describing the
30385e724ca2SStephen Warren		U-Boot build configuration to the default environment.
30395e724ca2SStephen Warren		These will be named arch, cpu, board, vendor, and soc.
30405e724ca2SStephen Warren
30415e724ca2SStephen Warren		Enabling this option will cause the following to be defined:
30425e724ca2SStephen Warren
30435e724ca2SStephen Warren		- CONFIG_SYS_ARCH
30445e724ca2SStephen Warren		- CONFIG_SYS_CPU
30455e724ca2SStephen Warren		- CONFIG_SYS_BOARD
30465e724ca2SStephen Warren		- CONFIG_SYS_VENDOR
30475e724ca2SStephen Warren		- CONFIG_SYS_SOC
30485e724ca2SStephen Warren
30497e27f89fSTom Rini		CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
30507e27f89fSTom Rini
30517e27f89fSTom Rini		Define this in order to add variables describing certain
30527e27f89fSTom Rini		run-time determined information about the hardware to the
30537e27f89fSTom Rini		environment.  These will be named board_name, board_rev.
30547e27f89fSTom Rini
305506fd8538SSimon Glass		CONFIG_DELAY_ENVIRONMENT
305606fd8538SSimon Glass
305706fd8538SSimon Glass		Normally the environment is loaded when the board is
3058b445bbb4SJeremiah Mahler		initialised so that it is available to U-Boot. This inhibits
305906fd8538SSimon Glass		that so that the environment is not available until
306006fd8538SSimon Glass		explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
306106fd8538SSimon Glass		this is instead controlled by the value of
306206fd8538SSimon Glass		/config/load-environment.
306306fd8538SSimon Glass
3064a8c7c708Swdenk- DataFlash Support:
30652abbe075Swdenk		CONFIG_HAS_DATAFLASH
30662abbe075Swdenk
30672abbe075Swdenk		Defining this option enables DataFlash features and
30682abbe075Swdenk		allows to read/write in Dataflash via the standard
30692abbe075Swdenk		commands cp, md...
30702abbe075Swdenk
3071f61ec45eSEric Nelson- Serial Flash support
3072f61ec45eSEric Nelson		CONFIG_CMD_SF
3073f61ec45eSEric Nelson
3074f61ec45eSEric Nelson		Defining this option enables SPI flash commands
3075f61ec45eSEric Nelson		'sf probe/read/write/erase/update'.
3076f61ec45eSEric Nelson
3077f61ec45eSEric Nelson		Usage requires an initial 'probe' to define the serial
3078f61ec45eSEric Nelson		flash parameters, followed by read/write/erase/update
3079f61ec45eSEric Nelson		commands.
3080f61ec45eSEric Nelson
3081f61ec45eSEric Nelson		The following defaults may be provided by the platform
3082f61ec45eSEric Nelson		to handle the common case when only a single serial
3083f61ec45eSEric Nelson		flash is present on the system.
3084f61ec45eSEric Nelson
3085f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_BUS		Bus identifier
3086f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_CS		Chip-select
3087f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_MODE 		(see include/spi.h)
3088f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_SPEED		in Hz
3089f61ec45eSEric Nelson
309024007273SSimon Glass		CONFIG_CMD_SF_TEST
309124007273SSimon Glass
309224007273SSimon Glass		Define this option to include a destructive SPI flash
309324007273SSimon Glass		test ('sf test').
309424007273SSimon Glass
30951dcd6d03SJagannadha Sutradharudu Teki		CONFIG_SPI_FLASH_BAR		Ban/Extended Addr Reg
30961dcd6d03SJagannadha Sutradharudu Teki
30971dcd6d03SJagannadha Sutradharudu Teki		Define this option to use the Bank addr/Extended addr
30981dcd6d03SJagannadha Sutradharudu Teki		support on SPI flashes which has size > 16Mbytes.
30991dcd6d03SJagannadha Sutradharudu Teki
3100b902e07cSJagannadha Sutradharudu Teki		CONFIG_SF_DUAL_FLASH		Dual flash memories
3101b902e07cSJagannadha Sutradharudu Teki
3102b902e07cSJagannadha Sutradharudu Teki		Define this option to use dual flash support where two flash
3103b902e07cSJagannadha Sutradharudu Teki		memories can be connected with a given cs line.
3104b445bbb4SJeremiah Mahler		Currently Xilinx Zynq qspi supports these type of connections.
3105b902e07cSJagannadha Sutradharudu Teki
3106562f8df1SHeiko Schocher		CONFIG_SYS_SPI_ST_ENABLE_WP_PIN
3107562f8df1SHeiko Schocher		enable the W#/Vpp signal to disable writing to the status
3108562f8df1SHeiko Schocher		register on ST MICRON flashes like the N25Q128.
3109562f8df1SHeiko Schocher		The status register write enable/disable bit, combined with
3110562f8df1SHeiko Schocher		the W#/VPP signal provides hardware data protection for the
3111562f8df1SHeiko Schocher		device as follows: When the enable/disable bit is set to 1,
3112562f8df1SHeiko Schocher		and the W#/VPP signal is driven LOW, the status register
3113562f8df1SHeiko Schocher		nonvolatile bits become read-only and the WRITE STATUS REGISTER
3114562f8df1SHeiko Schocher		operation will not execute. The only way to exit this
3115562f8df1SHeiko Schocher		hardware-protected mode is to drive W#/VPP HIGH.
3116562f8df1SHeiko Schocher
31173f85ce27Swdenk- SystemACE Support:
31183f85ce27Swdenk		CONFIG_SYSTEMACE
31193f85ce27Swdenk
31203f85ce27Swdenk		Adding this option adds support for Xilinx SystemACE
31213f85ce27Swdenk		chips attached via some sort of local bus. The address
312211ccc33fSMarcel Ziswiler		of the chip must also be defined in the
31236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SYSTEMACE_BASE macro. For example:
31243f85ce27Swdenk
31253f85ce27Swdenk		#define CONFIG_SYSTEMACE
31266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
31273f85ce27Swdenk
31283f85ce27Swdenk		When SystemACE support is added, the "ace" device type
31293f85ce27Swdenk		becomes available to the fat commands, i.e. fatls.
31303f85ce27Swdenk
3131ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port:
3132ecb0ccd9SWolfgang Denk		CONFIG_TFTP_PORT
3133ecb0ccd9SWolfgang Denk
313428cb9375SWolfgang Denk		If this is defined, the environment variable tftpsrcp
3135ecb0ccd9SWolfgang Denk		is used to supply the TFTP UDP source port value.
313628cb9375SWolfgang Denk		If tftpsrcp isn't defined, the normal pseudo-random port
3137ecb0ccd9SWolfgang Denk		number generator is used.
3138ecb0ccd9SWolfgang Denk
313928cb9375SWolfgang Denk		Also, the environment variable tftpdstp is used to supply
314028cb9375SWolfgang Denk		the TFTP UDP destination port value.  If tftpdstp isn't
314128cb9375SWolfgang Denk		defined, the normal port 69 is used.
314228cb9375SWolfgang Denk
314328cb9375SWolfgang Denk		The purpose for tftpsrcp is to allow a TFTP server to
3144ecb0ccd9SWolfgang Denk		blindly start the TFTP transfer using the pre-configured
3145ecb0ccd9SWolfgang Denk		target IP address and UDP port. This has the effect of
3146ecb0ccd9SWolfgang Denk		"punching through" the (Windows XP) firewall, allowing
3147ecb0ccd9SWolfgang Denk		the remainder of the TFTP transfer to proceed normally.
3148ecb0ccd9SWolfgang Denk		A better solution is to properly configure the firewall,
3149ecb0ccd9SWolfgang Denk		but sometimes that is not allowed.
3150ecb0ccd9SWolfgang Denk
3151bf36c5d5SSimon Glass- Hashing support:
3152bf36c5d5SSimon Glass		CONFIG_CMD_HASH
3153bf36c5d5SSimon Glass
3154bf36c5d5SSimon Glass		This enables a generic 'hash' command which can produce
3155bf36c5d5SSimon Glass		hashes / digests from a few algorithms (e.g. SHA1, SHA256).
3156bf36c5d5SSimon Glass
3157bf36c5d5SSimon Glass		CONFIG_HASH_VERIFY
3158bf36c5d5SSimon Glass
3159bf36c5d5SSimon Glass		Enable the hash verify command (hash -v). This adds to code
3160bf36c5d5SSimon Glass		size a little.
3161bf36c5d5SSimon Glass
3162bf36c5d5SSimon Glass		CONFIG_SHA1 - support SHA1 hashing
3163bf36c5d5SSimon Glass		CONFIG_SHA256 - support SHA256 hashing
3164bf36c5d5SSimon Glass
3165bf36c5d5SSimon Glass		Note: There is also a sha1sum command, which should perhaps
3166bf36c5d5SSimon Glass		be deprecated in favour of 'hash sha1'.
3167bf36c5d5SSimon Glass
3168a11f1873SRobert Winkler- Freescale i.MX specific commands:
3169a11f1873SRobert Winkler		CONFIG_CMD_HDMIDETECT
3170a11f1873SRobert Winkler		This enables 'hdmidet' command which returns true if an
3171a11f1873SRobert Winkler		HDMI monitor is detected.  This command is i.MX 6 specific.
3172a11f1873SRobert Winkler
3173a11f1873SRobert Winkler		CONFIG_CMD_BMODE
3174a11f1873SRobert Winkler		This enables the 'bmode' (bootmode) command for forcing
3175a11f1873SRobert Winkler		a boot from specific media.
3176a11f1873SRobert Winkler
3177a11f1873SRobert Winkler		This is useful for forcing the ROM's usb downloader to
3178a11f1873SRobert Winkler		activate upon a watchdog reset which is nice when iterating
3179a11f1873SRobert Winkler		on U-Boot.  Using the reset button or running bmode normal
3180a11f1873SRobert Winkler		will set it back to normal.  This command currently
3181a11f1873SRobert Winkler		supports i.MX53 and i.MX6.
3182a11f1873SRobert Winkler
318319c402afSSimon Glass- Signing support:
318419c402afSSimon Glass		CONFIG_RSA
318519c402afSSimon Glass
318619c402afSSimon Glass		This enables the RSA algorithm used for FIT image verification
31878bf2aad7SDetlev Zundel		in U-Boot. See doc/uImage.FIT/signature.txt for more information.
318819c402afSSimon Glass
3189c937ff6dSRuchika Gupta		The Modular Exponentiation algorithm in RSA is implemented using
3190c937ff6dSRuchika Gupta		driver model. So CONFIG_DM needs to be enabled by default for this
3191c937ff6dSRuchika Gupta		library to function.
3192c937ff6dSRuchika Gupta
319319c402afSSimon Glass		The signing part is build into mkimage regardless of this
3194c937ff6dSRuchika Gupta		option. The software based modular exponentiation is built into
3195c937ff6dSRuchika Gupta		mkimage irrespective of this option.
319619c402afSSimon Glass
31979e50c406SHeiko Schocher- bootcount support:
31989e50c406SHeiko Schocher		CONFIG_BOOTCOUNT_LIMIT
31999e50c406SHeiko Schocher
32009e50c406SHeiko Schocher		This enables the bootcounter support, see:
32019e50c406SHeiko Schocher		http://www.denx.de/wiki/DULG/UBootBootCountLimit
32029e50c406SHeiko Schocher
32039e50c406SHeiko Schocher		CONFIG_AT91SAM9XE
32049e50c406SHeiko Schocher		enable special bootcounter support on at91sam9xe based boards.
32059e50c406SHeiko Schocher		CONFIG_BLACKFIN
32069e50c406SHeiko Schocher		enable special bootcounter support on blackfin based boards.
32079e50c406SHeiko Schocher		CONFIG_SOC_DA8XX
32089e50c406SHeiko Schocher		enable special bootcounter support on da850 based boards.
32099e50c406SHeiko Schocher		CONFIG_BOOTCOUNT_RAM
32109e50c406SHeiko Schocher		enable support for the bootcounter in RAM
32119e50c406SHeiko Schocher		CONFIG_BOOTCOUNT_I2C
32129e50c406SHeiko Schocher		enable support for the bootcounter on an i2c (like RTC) device.
32139e50c406SHeiko Schocher			CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
32149e50c406SHeiko Schocher			CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
32159e50c406SHeiko Schocher						    the bootcounter.
32169e50c406SHeiko Schocher			CONFIG_BOOTCOUNT_ALEN = address len
321719c402afSSimon Glass
3218a8c7c708Swdenk- Show boot progress:
3219c609719bSwdenk		CONFIG_SHOW_BOOT_PROGRESS
3220c609719bSwdenk
3221c609719bSwdenk		Defining this option allows to add some board-
3222c609719bSwdenk		specific code (calling a user-provided function
3223c609719bSwdenk		"show_boot_progress(int)") that enables you to show
3224c609719bSwdenk		the system's boot progress on some display (for
3225c609719bSwdenk		example, some LED's) on your board. At the moment,
3226c609719bSwdenk		the following checkpoints are implemented:
3227c609719bSwdenk
32283a608ca0SSimon Glass- Detailed boot stage timing
32293a608ca0SSimon Glass		CONFIG_BOOTSTAGE
32303a608ca0SSimon Glass		Define this option to get detailed timing of each stage
32313a608ca0SSimon Glass		of the boot process.
32323a608ca0SSimon Glass
32333a608ca0SSimon Glass		CONFIG_BOOTSTAGE_USER_COUNT
32343a608ca0SSimon Glass		This is the number of available user bootstage records.
32353a608ca0SSimon Glass		Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
32363a608ca0SSimon Glass		a new ID will be allocated from this stash. If you exceed
32373a608ca0SSimon Glass		the limit, recording will stop.
32383a608ca0SSimon Glass
32393a608ca0SSimon Glass		CONFIG_BOOTSTAGE_REPORT
32403a608ca0SSimon Glass		Define this to print a report before boot, similar to this:
32413a608ca0SSimon Glass
32423a608ca0SSimon Glass		Timer summary in microseconds:
32433a608ca0SSimon Glass		       Mark    Elapsed  Stage
32443a608ca0SSimon Glass			  0          0  reset
32453a608ca0SSimon Glass		  3,575,678  3,575,678  board_init_f start
32463a608ca0SSimon Glass		  3,575,695         17  arch_cpu_init A9
32473a608ca0SSimon Glass		  3,575,777         82  arch_cpu_init done
32483a608ca0SSimon Glass		  3,659,598     83,821  board_init_r start
32493a608ca0SSimon Glass		  3,910,375    250,777  main_loop
32503a608ca0SSimon Glass		 29,916,167 26,005,792  bootm_start
32513a608ca0SSimon Glass		 30,361,327    445,160  start_kernel
32523a608ca0SSimon Glass
32532eba38cfSSimon Glass		CONFIG_CMD_BOOTSTAGE
32542eba38cfSSimon Glass		Add a 'bootstage' command which supports printing a report
32552eba38cfSSimon Glass		and un/stashing of bootstage data.
32562eba38cfSSimon Glass
325794fd1316SSimon Glass		CONFIG_BOOTSTAGE_FDT
325894fd1316SSimon Glass		Stash the bootstage information in the FDT. A root 'bootstage'
325994fd1316SSimon Glass		node is created with each bootstage id as a child. Each child
326094fd1316SSimon Glass		has a 'name' property and either 'mark' containing the
326194fd1316SSimon Glass		mark time in microsecond, or 'accum' containing the
326294fd1316SSimon Glass		accumulated time for that bootstage id in microseconds.
326394fd1316SSimon Glass		For example:
326494fd1316SSimon Glass
326594fd1316SSimon Glass		bootstage {
326694fd1316SSimon Glass			154 {
326794fd1316SSimon Glass				name = "board_init_f";
326894fd1316SSimon Glass				mark = <3575678>;
326994fd1316SSimon Glass			};
327094fd1316SSimon Glass			170 {
327194fd1316SSimon Glass				name = "lcd";
327294fd1316SSimon Glass				accum = <33482>;
327394fd1316SSimon Glass			};
327494fd1316SSimon Glass		};
327594fd1316SSimon Glass
327694fd1316SSimon Glass		Code in the Linux kernel can find this in /proc/devicetree.
327794fd1316SSimon Glass
32781372cce2SMarian BalakowiczLegacy uImage format:
32791372cce2SMarian Balakowicz
3280c609719bSwdenk  Arg	Where			When
3281c609719bSwdenk    1	common/cmd_bootm.c	before attempting to boot an image
3282c609719bSwdenk   -1	common/cmd_bootm.c	Image header has bad	 magic number
3283c609719bSwdenk    2	common/cmd_bootm.c	Image header has correct magic number
3284c609719bSwdenk   -2	common/cmd_bootm.c	Image header has bad	 checksum
3285c609719bSwdenk    3	common/cmd_bootm.c	Image header has correct checksum
3286c609719bSwdenk   -3	common/cmd_bootm.c	Image data   has bad	 checksum
3287c609719bSwdenk    4	common/cmd_bootm.c	Image data   has correct checksum
3288c609719bSwdenk   -4	common/cmd_bootm.c	Image is for unsupported architecture
3289c609719bSwdenk    5	common/cmd_bootm.c	Architecture check OK
32901372cce2SMarian Balakowicz   -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi)
3291c609719bSwdenk    6	common/cmd_bootm.c	Image Type check OK
3292c609719bSwdenk   -6	common/cmd_bootm.c	gunzip uncompression error
3293c609719bSwdenk   -7	common/cmd_bootm.c	Unimplemented compression type
3294c609719bSwdenk    7	common/cmd_bootm.c	Uncompression OK
32951372cce2SMarian Balakowicz    8	common/cmd_bootm.c	No uncompress/copy overwrite error
3296c609719bSwdenk   -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
32971372cce2SMarian Balakowicz
32981372cce2SMarian Balakowicz    9	common/image.c		Start initial ramdisk verification
32991372cce2SMarian Balakowicz  -10	common/image.c		Ramdisk header has bad	   magic number
33001372cce2SMarian Balakowicz  -11	common/image.c		Ramdisk header has bad	   checksum
33011372cce2SMarian Balakowicz   10	common/image.c		Ramdisk header is OK
33021372cce2SMarian Balakowicz  -12	common/image.c		Ramdisk data   has bad	   checksum
33031372cce2SMarian Balakowicz   11	common/image.c		Ramdisk data   has correct checksum
33041372cce2SMarian Balakowicz   12	common/image.c		Ramdisk verification complete, start loading
330511ccc33fSMarcel Ziswiler  -13	common/image.c		Wrong Image Type (not PPC Linux ramdisk)
33061372cce2SMarian Balakowicz   13	common/image.c		Start multifile image verification
33071372cce2SMarian Balakowicz   14	common/image.c		No initial ramdisk, no multifile, continue.
33081372cce2SMarian Balakowicz
3309ea0364f1SPeter Tyser   15	arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
3310c609719bSwdenk
3311a47a12beSStefan Roese  -30	arch/powerpc/lib/board.c	Fatal error, hang the system
331263e73c9aSwdenk  -31	post/post.c		POST test failed, detected by post_output_backlog()
331363e73c9aSwdenk  -32	post/post.c		POST test failed, detected by post_run_single()
331463e73c9aSwdenk
3315566a494fSHeiko Schocher   34	common/cmd_doc.c	before loading a Image from a DOC device
3316566a494fSHeiko Schocher  -35	common/cmd_doc.c	Bad usage of "doc" command
3317566a494fSHeiko Schocher   35	common/cmd_doc.c	correct usage of "doc" command
3318566a494fSHeiko Schocher  -36	common/cmd_doc.c	No boot device
3319566a494fSHeiko Schocher   36	common/cmd_doc.c	correct boot device
3320566a494fSHeiko Schocher  -37	common/cmd_doc.c	Unknown Chip ID on boot device
3321566a494fSHeiko Schocher   37	common/cmd_doc.c	correct chip ID found, device available
3322566a494fSHeiko Schocher  -38	common/cmd_doc.c	Read Error on boot device
3323566a494fSHeiko Schocher   38	common/cmd_doc.c	reading Image header from DOC device OK
3324566a494fSHeiko Schocher  -39	common/cmd_doc.c	Image header has bad magic number
3325566a494fSHeiko Schocher   39	common/cmd_doc.c	Image header has correct magic number
3326566a494fSHeiko Schocher  -40	common/cmd_doc.c	Error reading Image from DOC device
3327566a494fSHeiko Schocher   40	common/cmd_doc.c	Image header has correct magic number
3328566a494fSHeiko Schocher   41	common/cmd_ide.c	before loading a Image from a IDE device
3329566a494fSHeiko Schocher  -42	common/cmd_ide.c	Bad usage of "ide" command
3330566a494fSHeiko Schocher   42	common/cmd_ide.c	correct usage of "ide" command
3331566a494fSHeiko Schocher  -43	common/cmd_ide.c	No boot device
3332566a494fSHeiko Schocher   43	common/cmd_ide.c	boot device found
3333566a494fSHeiko Schocher  -44	common/cmd_ide.c	Device not available
3334566a494fSHeiko Schocher   44	common/cmd_ide.c	Device available
3335566a494fSHeiko Schocher  -45	common/cmd_ide.c	wrong partition selected
3336566a494fSHeiko Schocher   45	common/cmd_ide.c	partition selected
3337566a494fSHeiko Schocher  -46	common/cmd_ide.c	Unknown partition table
3338566a494fSHeiko Schocher   46	common/cmd_ide.c	valid partition table found
3339566a494fSHeiko Schocher  -47	common/cmd_ide.c	Invalid partition type
3340566a494fSHeiko Schocher   47	common/cmd_ide.c	correct partition type
3341566a494fSHeiko Schocher  -48	common/cmd_ide.c	Error reading Image Header on boot device
3342566a494fSHeiko Schocher   48	common/cmd_ide.c	reading Image Header from IDE device OK
3343566a494fSHeiko Schocher  -49	common/cmd_ide.c	Image header has bad magic number
3344566a494fSHeiko Schocher   49	common/cmd_ide.c	Image header has correct magic number
3345566a494fSHeiko Schocher  -50	common/cmd_ide.c	Image header has bad	 checksum
3346566a494fSHeiko Schocher   50	common/cmd_ide.c	Image header has correct checksum
3347566a494fSHeiko Schocher  -51	common/cmd_ide.c	Error reading Image from IDE device
3348566a494fSHeiko Schocher   51	common/cmd_ide.c	reading Image from IDE device OK
3349566a494fSHeiko Schocher   52	common/cmd_nand.c	before loading a Image from a NAND device
3350566a494fSHeiko Schocher  -53	common/cmd_nand.c	Bad usage of "nand" command
3351566a494fSHeiko Schocher   53	common/cmd_nand.c	correct usage of "nand" command
3352566a494fSHeiko Schocher  -54	common/cmd_nand.c	No boot device
3353566a494fSHeiko Schocher   54	common/cmd_nand.c	boot device found
3354566a494fSHeiko Schocher  -55	common/cmd_nand.c	Unknown Chip ID on boot device
3355566a494fSHeiko Schocher   55	common/cmd_nand.c	correct chip ID found, device available
3356566a494fSHeiko Schocher  -56	common/cmd_nand.c	Error reading Image Header on boot device
3357566a494fSHeiko Schocher   56	common/cmd_nand.c	reading Image Header from NAND device OK
3358566a494fSHeiko Schocher  -57	common/cmd_nand.c	Image header has bad magic number
3359566a494fSHeiko Schocher   57	common/cmd_nand.c	Image header has correct magic number
3360566a494fSHeiko Schocher  -58	common/cmd_nand.c	Error reading Image from NAND device
3361566a494fSHeiko Schocher   58	common/cmd_nand.c	reading Image from NAND device OK
3362c609719bSwdenk
3363566a494fSHeiko Schocher  -60	common/env_common.c	Environment has a bad CRC, using default
3364c609719bSwdenk
3365566a494fSHeiko Schocher   64	net/eth.c		starting with Ethernet configuration.
3366566a494fSHeiko Schocher  -64	net/eth.c		no Ethernet found.
3367566a494fSHeiko Schocher   65	net/eth.c		Ethernet found.
3368206c60cbSwdenk
3369566a494fSHeiko Schocher  -80	common/cmd_net.c	usage wrong
3370566a494fSHeiko Schocher   80	common/cmd_net.c	before calling NetLoop()
337111ccc33fSMarcel Ziswiler  -81	common/cmd_net.c	some error in NetLoop() occurred
3372566a494fSHeiko Schocher   81	common/cmd_net.c	NetLoop() back without error
3373566a494fSHeiko Schocher  -82	common/cmd_net.c	size == 0 (File with size 0 loaded)
3374566a494fSHeiko Schocher   82	common/cmd_net.c	trying automatic boot
337574de7aefSWolfgang Denk   83	common/cmd_net.c	running "source" command
337674de7aefSWolfgang Denk  -83	common/cmd_net.c	some error in automatic boot or "source" command
3377566a494fSHeiko Schocher   84	common/cmd_net.c	end without errors
3378c609719bSwdenk
33791372cce2SMarian BalakowiczFIT uImage format:
33801372cce2SMarian Balakowicz
33811372cce2SMarian Balakowicz  Arg	Where			When
33821372cce2SMarian Balakowicz  100	common/cmd_bootm.c	Kernel FIT Image has correct format
33831372cce2SMarian Balakowicz -100	common/cmd_bootm.c	Kernel FIT Image has incorrect format
33841372cce2SMarian Balakowicz  101	common/cmd_bootm.c	No Kernel subimage unit name, using configuration
33851372cce2SMarian Balakowicz -101	common/cmd_bootm.c	Can't get configuration for kernel subimage
33861372cce2SMarian Balakowicz  102	common/cmd_bootm.c	Kernel unit name specified
33871372cce2SMarian Balakowicz -103	common/cmd_bootm.c	Can't get kernel subimage node offset
3388f773bea8SMarian Balakowicz  103	common/cmd_bootm.c	Found configuration node
33891372cce2SMarian Balakowicz  104	common/cmd_bootm.c	Got kernel subimage node offset
33901372cce2SMarian Balakowicz -104	common/cmd_bootm.c	Kernel subimage hash verification failed
33911372cce2SMarian Balakowicz  105	common/cmd_bootm.c	Kernel subimage hash verification OK
33921372cce2SMarian Balakowicz -105	common/cmd_bootm.c	Kernel subimage is for unsupported architecture
33931372cce2SMarian Balakowicz  106	common/cmd_bootm.c	Architecture check OK
339411ccc33fSMarcel Ziswiler -106	common/cmd_bootm.c	Kernel subimage has wrong type
339511ccc33fSMarcel Ziswiler  107	common/cmd_bootm.c	Kernel subimage type OK
33961372cce2SMarian Balakowicz -107	common/cmd_bootm.c	Can't get kernel subimage data/size
33971372cce2SMarian Balakowicz  108	common/cmd_bootm.c	Got kernel subimage data/size
33981372cce2SMarian Balakowicz -108	common/cmd_bootm.c	Wrong image type (not legacy, FIT)
33991372cce2SMarian Balakowicz -109	common/cmd_bootm.c	Can't get kernel subimage type
34001372cce2SMarian Balakowicz -110	common/cmd_bootm.c	Can't get kernel subimage comp
34011372cce2SMarian Balakowicz -111	common/cmd_bootm.c	Can't get kernel subimage os
34021372cce2SMarian Balakowicz -112	common/cmd_bootm.c	Can't get kernel subimage load address
34031372cce2SMarian Balakowicz -113	common/cmd_bootm.c	Image uncompress/copy overwrite error
34041372cce2SMarian Balakowicz
34051372cce2SMarian Balakowicz  120	common/image.c		Start initial ramdisk verification
34061372cce2SMarian Balakowicz -120	common/image.c		Ramdisk FIT image has incorrect format
34071372cce2SMarian Balakowicz  121	common/image.c		Ramdisk FIT image has correct format
340811ccc33fSMarcel Ziswiler  122	common/image.c		No ramdisk subimage unit name, using configuration
34091372cce2SMarian Balakowicz -122	common/image.c		Can't get configuration for ramdisk subimage
34101372cce2SMarian Balakowicz  123	common/image.c		Ramdisk unit name specified
34111372cce2SMarian Balakowicz -124	common/image.c		Can't get ramdisk subimage node offset
34121372cce2SMarian Balakowicz  125	common/image.c		Got ramdisk subimage node offset
34131372cce2SMarian Balakowicz -125	common/image.c		Ramdisk subimage hash verification failed
34141372cce2SMarian Balakowicz  126	common/image.c		Ramdisk subimage hash verification OK
34151372cce2SMarian Balakowicz -126	common/image.c		Ramdisk subimage for unsupported architecture
34161372cce2SMarian Balakowicz  127	common/image.c		Architecture check OK
34171372cce2SMarian Balakowicz -127	common/image.c		Can't get ramdisk subimage data/size
34181372cce2SMarian Balakowicz  128	common/image.c		Got ramdisk subimage data/size
34191372cce2SMarian Balakowicz  129	common/image.c		Can't get ramdisk load address
34201372cce2SMarian Balakowicz -129	common/image.c		Got ramdisk load address
34211372cce2SMarian Balakowicz
342211ccc33fSMarcel Ziswiler -130	common/cmd_doc.c	Incorrect FIT image format
34231372cce2SMarian Balakowicz  131	common/cmd_doc.c	FIT image format OK
34241372cce2SMarian Balakowicz
342511ccc33fSMarcel Ziswiler -140	common/cmd_ide.c	Incorrect FIT image format
34261372cce2SMarian Balakowicz  141	common/cmd_ide.c	FIT image format OK
34271372cce2SMarian Balakowicz
342811ccc33fSMarcel Ziswiler -150	common/cmd_nand.c	Incorrect FIT image format
34291372cce2SMarian Balakowicz  151	common/cmd_nand.c	FIT image format OK
34301372cce2SMarian Balakowicz
343121d29f7fSHeiko Schocher- legacy image format:
343221d29f7fSHeiko Schocher		CONFIG_IMAGE_FORMAT_LEGACY
343321d29f7fSHeiko Schocher		enables the legacy image format support in U-Boot.
343421d29f7fSHeiko Schocher
343521d29f7fSHeiko Schocher		Default:
343621d29f7fSHeiko Schocher		enabled if CONFIG_FIT_SIGNATURE is not defined.
343721d29f7fSHeiko Schocher
343821d29f7fSHeiko Schocher		CONFIG_DISABLE_IMAGE_LEGACY
343921d29f7fSHeiko Schocher		disable the legacy image format
344021d29f7fSHeiko Schocher
344121d29f7fSHeiko Schocher		This define is introduced, as the legacy image format is
344221d29f7fSHeiko Schocher		enabled per default for backward compatibility.
344321d29f7fSHeiko Schocher
3444d95f6ec7SGabe Black- FIT image support:
3445d95f6ec7SGabe Black		CONFIG_FIT
3446d95f6ec7SGabe Black		Enable support for the FIT uImage format.
3447d95f6ec7SGabe Black
3448d95f6ec7SGabe Black		CONFIG_FIT_BEST_MATCH
3449d95f6ec7SGabe Black		When no configuration is explicitly selected, default to the
3450d95f6ec7SGabe Black		one whose fdt's compatibility field best matches that of
3451d95f6ec7SGabe Black		U-Boot itself. A match is considered "best" if it matches the
3452d95f6ec7SGabe Black		most specific compatibility entry of U-Boot's fdt's root node.
3453d95f6ec7SGabe Black		The order of entries in the configuration's fdt is ignored.
3454d95f6ec7SGabe Black
34553e569a6bSSimon Glass		CONFIG_FIT_SIGNATURE
34563e569a6bSSimon Glass		This option enables signature verification of FIT uImages,
34573e569a6bSSimon Glass		using a hash signed and verified using RSA. See
34583e569a6bSSimon Glass		doc/uImage.FIT/signature.txt for more details.
34593e569a6bSSimon Glass
346021d29f7fSHeiko Schocher		WARNING: When relying on signed FIT images with required
346121d29f7fSHeiko Schocher		signature check the legacy image format is default
346221d29f7fSHeiko Schocher		disabled. If a board need legacy image format support
346321d29f7fSHeiko Schocher		enable this through CONFIG_IMAGE_FORMAT_LEGACY
346421d29f7fSHeiko Schocher
34659a4f479bSDirk Eibach		CONFIG_FIT_DISABLE_SHA256
34669a4f479bSDirk Eibach		Supporting SHA256 hashes has quite an impact on binary size.
34679a4f479bSDirk Eibach		For constrained systems sha256 hash support can be disabled
34689a4f479bSDirk Eibach		with this option.
34699a4f479bSDirk Eibach
34704cf2609bSWolfgang Denk- Standalone program support:
34714cf2609bSWolfgang Denk		CONFIG_STANDALONE_LOAD_ADDR
34724cf2609bSWolfgang Denk
34736feff899SWolfgang Denk		This option defines a board specific value for the
34746feff899SWolfgang Denk		address where standalone program gets loaded, thus
34756feff899SWolfgang Denk		overwriting the architecture dependent default
34764cf2609bSWolfgang Denk		settings.
34774cf2609bSWolfgang Denk
34784cf2609bSWolfgang Denk- Frame Buffer Address:
34794cf2609bSWolfgang Denk		CONFIG_FB_ADDR
34804cf2609bSWolfgang Denk
34814cf2609bSWolfgang Denk		Define CONFIG_FB_ADDR if you want to use specific
348244a53b57SWolfgang Denk		address for frame buffer.  This is typically the case
348344a53b57SWolfgang Denk		when using a graphics controller has separate video
348444a53b57SWolfgang Denk		memory.  U-Boot will then place the frame buffer at
348544a53b57SWolfgang Denk		the given address instead of dynamically reserving it
348644a53b57SWolfgang Denk		in system RAM by calling lcd_setmem(), which grabs
348744a53b57SWolfgang Denk		the memory for the frame buffer depending on the
348844a53b57SWolfgang Denk		configured panel size.
34894cf2609bSWolfgang Denk
34904cf2609bSWolfgang Denk		Please see board_init_f function.
34914cf2609bSWolfgang Denk
3492cccfc2abSDetlev Zundel- Automatic software updates via TFTP server
3493cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP
3494cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_CNT_MAX
3495cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_MSEC_MAX
3496cccfc2abSDetlev Zundel
3497cccfc2abSDetlev Zundel		These options enable and control the auto-update feature;
3498cccfc2abSDetlev Zundel		for a more detailed description refer to doc/README.update.
3499cccfc2abSDetlev Zundel
3500cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support)
3501cccfc2abSDetlev Zundel		CONFIG_MTD_DEVICE
3502cccfc2abSDetlev Zundel
3503cccfc2abSDetlev Zundel		Adds the MTD device infrastructure from the Linux kernel.
3504cccfc2abSDetlev Zundel		Needed for mtdparts command support.
3505cccfc2abSDetlev Zundel
3506cccfc2abSDetlev Zundel		CONFIG_MTD_PARTITIONS
3507cccfc2abSDetlev Zundel
3508cccfc2abSDetlev Zundel		Adds the MTD partitioning infrastructure from the Linux
3509cccfc2abSDetlev Zundel		kernel. Needed for UBI support.
3510cccfc2abSDetlev Zundel
3511ff94bc40SHeiko Schocher		CONFIG_MTD_NAND_VERIFY_WRITE
3512ff94bc40SHeiko Schocher		verify if the written data is correct reread.
3513ff94bc40SHeiko Schocher
351470c219cdSJoe Hershberger- UBI support
351570c219cdSJoe Hershberger		CONFIG_CMD_UBI
351670c219cdSJoe Hershberger
351770c219cdSJoe Hershberger		Adds commands for interacting with MTD partitions formatted
351870c219cdSJoe Hershberger		with the UBI flash translation layer
351970c219cdSJoe Hershberger
352070c219cdSJoe Hershberger		Requires also defining CONFIG_RBTREE
352170c219cdSJoe Hershberger
3522147162daSJoe Hershberger		CONFIG_UBI_SILENCE_MSG
3523147162daSJoe Hershberger
3524147162daSJoe Hershberger		Make the verbose messages from UBI stop printing.  This leaves
3525147162daSJoe Hershberger		warnings and errors enabled.
3526147162daSJoe Hershberger
3527ff94bc40SHeiko Schocher
3528ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_WL_THRESHOLD
3529ff94bc40SHeiko Schocher		This parameter defines the maximum difference between the highest
3530ff94bc40SHeiko Schocher		erase counter value and the lowest erase counter value of eraseblocks
3531ff94bc40SHeiko Schocher		of UBI devices. When this threshold is exceeded, UBI starts performing
3532ff94bc40SHeiko Schocher		wear leveling by means of moving data from eraseblock with low erase
3533ff94bc40SHeiko Schocher		counter to eraseblocks with high erase counter.
3534ff94bc40SHeiko Schocher
3535ff94bc40SHeiko Schocher		The default value should be OK for SLC NAND flashes, NOR flashes and
3536ff94bc40SHeiko Schocher		other flashes which have eraseblock life-cycle 100000 or more.
3537ff94bc40SHeiko Schocher		However, in case of MLC NAND flashes which typically have eraseblock
3538ff94bc40SHeiko Schocher		life-cycle less than 10000, the threshold should be lessened (e.g.,
3539ff94bc40SHeiko Schocher		to 128 or 256, although it does not have to be power of 2).
3540ff94bc40SHeiko Schocher
3541ff94bc40SHeiko Schocher		default: 4096
3542ff94bc40SHeiko Schocher
3543ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_BEB_LIMIT
3544ff94bc40SHeiko Schocher		This option specifies the maximum bad physical eraseblocks UBI
3545ff94bc40SHeiko Schocher		expects on the MTD device (per 1024 eraseblocks). If the
3546ff94bc40SHeiko Schocher		underlying flash does not admit of bad eraseblocks (e.g. NOR
3547ff94bc40SHeiko Schocher		flash), this value is ignored.
3548ff94bc40SHeiko Schocher
3549ff94bc40SHeiko Schocher		NAND datasheets often specify the minimum and maximum NVM
3550ff94bc40SHeiko Schocher		(Number of Valid Blocks) for the flashes' endurance lifetime.
3551ff94bc40SHeiko Schocher		The maximum expected bad eraseblocks per 1024 eraseblocks
3552ff94bc40SHeiko Schocher		then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
3553ff94bc40SHeiko Schocher		which gives 20 for most NANDs (MaxNVB is basically the total
3554ff94bc40SHeiko Schocher		count of eraseblocks on the chip).
3555ff94bc40SHeiko Schocher
3556ff94bc40SHeiko Schocher		To put it differently, if this value is 20, UBI will try to
3557ff94bc40SHeiko Schocher		reserve about 1.9% of physical eraseblocks for bad blocks
3558ff94bc40SHeiko Schocher		handling. And that will be 1.9% of eraseblocks on the entire
3559ff94bc40SHeiko Schocher		NAND chip, not just the MTD partition UBI attaches. This means
3560ff94bc40SHeiko Schocher		that if you have, say, a NAND flash chip admits maximum 40 bad
3561ff94bc40SHeiko Schocher		eraseblocks, and it is split on two MTD partitions of the same
3562ff94bc40SHeiko Schocher		size, UBI will reserve 40 eraseblocks when attaching a
3563ff94bc40SHeiko Schocher		partition.
3564ff94bc40SHeiko Schocher
3565ff94bc40SHeiko Schocher		default: 20
3566ff94bc40SHeiko Schocher
3567ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_FASTMAP
3568ff94bc40SHeiko Schocher		Fastmap is a mechanism which allows attaching an UBI device
3569ff94bc40SHeiko Schocher		in nearly constant time. Instead of scanning the whole MTD device it
3570ff94bc40SHeiko Schocher		only has to locate a checkpoint (called fastmap) on the device.
3571ff94bc40SHeiko Schocher		The on-flash fastmap contains all information needed to attach
3572ff94bc40SHeiko Schocher		the device. Using fastmap makes only sense on large devices where
3573ff94bc40SHeiko Schocher		attaching by scanning takes long. UBI will not automatically install
3574ff94bc40SHeiko Schocher		a fastmap on old images, but you can set the UBI parameter
3575ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
3576ff94bc40SHeiko Schocher		that fastmap-enabled images are still usable with UBI implementations
3577ff94bc40SHeiko Schocher		without	fastmap support. On typical flash devices the whole fastmap
3578ff94bc40SHeiko Schocher		fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
3579ff94bc40SHeiko Schocher
3580ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
3581ff94bc40SHeiko Schocher		Set this parameter to enable fastmap automatically on images
3582ff94bc40SHeiko Schocher		without a fastmap.
3583ff94bc40SHeiko Schocher		default: 0
3584ff94bc40SHeiko Schocher
358570c219cdSJoe Hershberger- UBIFS support
358670c219cdSJoe Hershberger		CONFIG_CMD_UBIFS
358770c219cdSJoe Hershberger
358870c219cdSJoe Hershberger		Adds commands for interacting with UBI volumes formatted as
358970c219cdSJoe Hershberger		UBIFS.  UBIFS is read-only in u-boot.
359070c219cdSJoe Hershberger
359170c219cdSJoe Hershberger		Requires UBI support as well as CONFIG_LZO
359270c219cdSJoe Hershberger
3593147162daSJoe Hershberger		CONFIG_UBIFS_SILENCE_MSG
3594147162daSJoe Hershberger
3595147162daSJoe Hershberger		Make the verbose messages from UBIFS stop printing.  This leaves
3596147162daSJoe Hershberger		warnings and errors enabled.
3597147162daSJoe Hershberger
35986a11cf48SDaniel Schwierzeck- SPL framework
35996a11cf48SDaniel Schwierzeck		CONFIG_SPL
36006a11cf48SDaniel Schwierzeck		Enable building of SPL globally.
36016a11cf48SDaniel Schwierzeck
360295579793STom Rini		CONFIG_SPL_LDSCRIPT
360395579793STom Rini		LDSCRIPT for linking the SPL binary.
360495579793STom Rini
36056ebc3461SAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT
36066ebc3461SAlbert ARIBAUD		Maximum size in memory allocated to the SPL, BSS included.
36076ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual memory
36086ebc3461SAlbert ARIBAUD		used by SPL from _start to __bss_end does not exceed it.
36098960af8bSAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
36106ebc3461SAlbert ARIBAUD		must not be both defined at the same time.
36116ebc3461SAlbert ARIBAUD
361295579793STom Rini		CONFIG_SPL_MAX_SIZE
36136ebc3461SAlbert ARIBAUD		Maximum size of the SPL image (text, data, rodata, and
36146ebc3461SAlbert ARIBAUD		linker lists sections), BSS excluded.
36156ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual size does
36166ebc3461SAlbert ARIBAUD		not exceed it.
361795579793STom Rini
36186a11cf48SDaniel Schwierzeck		CONFIG_SPL_TEXT_BASE
36196a11cf48SDaniel Schwierzeck		TEXT_BASE for linking the SPL binary.
36206a11cf48SDaniel Schwierzeck
362194a45bb1SScott Wood		CONFIG_SPL_RELOC_TEXT_BASE
362294a45bb1SScott Wood		Address to relocate to.  If unspecified, this is equal to
362394a45bb1SScott Wood		CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
362494a45bb1SScott Wood
362595579793STom Rini		CONFIG_SPL_BSS_START_ADDR
362695579793STom Rini		Link address for the BSS within the SPL binary.
362795579793STom Rini
362895579793STom Rini		CONFIG_SPL_BSS_MAX_SIZE
36296ebc3461SAlbert ARIBAUD		Maximum size in memory allocated to the SPL BSS.
36306ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual memory used
36316ebc3461SAlbert ARIBAUD		by SPL from __bss_start to __bss_end does not exceed it.
36328960af8bSAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
36336ebc3461SAlbert ARIBAUD		must not be both defined at the same time.
363495579793STom Rini
363595579793STom Rini		CONFIG_SPL_STACK
363695579793STom Rini		Adress of the start of the stack SPL will use
363795579793STom Rini
363894a45bb1SScott Wood		CONFIG_SPL_RELOC_STACK
363994a45bb1SScott Wood		Adress of the start of the stack SPL will use after
364094a45bb1SScott Wood		relocation.  If unspecified, this is equal to
364194a45bb1SScott Wood		CONFIG_SPL_STACK.
364294a45bb1SScott Wood
364395579793STom Rini		CONFIG_SYS_SPL_MALLOC_START
364495579793STom Rini		Starting address of the malloc pool used in SPL.
364595579793STom Rini
364695579793STom Rini		CONFIG_SYS_SPL_MALLOC_SIZE
364795579793STom Rini		The size of the malloc pool used in SPL.
36486a11cf48SDaniel Schwierzeck
364947f7bcaeSTom Rini		CONFIG_SPL_FRAMEWORK
365047f7bcaeSTom Rini		Enable the SPL framework under common/.  This framework
365147f7bcaeSTom Rini		supports MMC, NAND and YMODEM loading of U-Boot and NAND
365247f7bcaeSTom Rini		NAND loading of the Linux Kernel.
365347f7bcaeSTom Rini
36549607faf2STom Rini		CONFIG_SPL_OS_BOOT
36559607faf2STom Rini		Enable booting directly to an OS from SPL.
36569607faf2STom Rini		See also: doc/README.falcon
36579607faf2STom Rini
3658861a86f4STom Rini		CONFIG_SPL_DISPLAY_PRINT
3659861a86f4STom Rini		For ARM, enable an optional function to print more information
3660861a86f4STom Rini		about the running system.
3661861a86f4STom Rini
36624b919725SScott Wood		CONFIG_SPL_INIT_MINIMAL
36634b919725SScott Wood		Arch init code should be built for a very small image
36644b919725SScott Wood
36656a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBCOMMON_SUPPORT
36666a11cf48SDaniel Schwierzeck		Support for common/libcommon.o in SPL binary
36676a11cf48SDaniel Schwierzeck
36686a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBDISK_SUPPORT
36696a11cf48SDaniel Schwierzeck		Support for disk/libdisk.o in SPL binary
36706a11cf48SDaniel Schwierzeck
36716a11cf48SDaniel Schwierzeck		CONFIG_SPL_I2C_SUPPORT
36726a11cf48SDaniel Schwierzeck		Support for drivers/i2c/libi2c.o in SPL binary
36736a11cf48SDaniel Schwierzeck
36746a11cf48SDaniel Schwierzeck		CONFIG_SPL_GPIO_SUPPORT
36756a11cf48SDaniel Schwierzeck		Support for drivers/gpio/libgpio.o in SPL binary
36766a11cf48SDaniel Schwierzeck
36776a11cf48SDaniel Schwierzeck		CONFIG_SPL_MMC_SUPPORT
36786a11cf48SDaniel Schwierzeck		Support for drivers/mmc/libmmc.o in SPL binary
36796a11cf48SDaniel Schwierzeck
368095579793STom Rini		CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
368195579793STom Rini		CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
3682e2ccdf89SPaul Kocialkowski		Address and partition on the MMC to load U-Boot from
368395579793STom Rini		when the MMC is being used in raw mode.
368495579793STom Rini
3685b97300b6SPaul Kocialkowski		CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
3686b97300b6SPaul Kocialkowski		Partition on the MMC to load U-Boot from when the MMC is being
3687b97300b6SPaul Kocialkowski		used in raw mode
3688b97300b6SPaul Kocialkowski
36892b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
36902b75b0adSPeter Korsgaard		Sector to load kernel uImage from when MMC is being
36912b75b0adSPeter Korsgaard		used in raw mode (for Falcon mode)
36922b75b0adSPeter Korsgaard
36932b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
36942b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
36952b75b0adSPeter Korsgaard		Sector and number of sectors to load kernel argument
36962b75b0adSPeter Korsgaard		parameters from when MMC is being used in raw mode
36972b75b0adSPeter Korsgaard		(for falcon mode)
36982b75b0adSPeter Korsgaard
3699e2ccdf89SPaul Kocialkowski		CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
3700e2ccdf89SPaul Kocialkowski		Partition on the MMC to load U-Boot from when the MMC is being
3701e2ccdf89SPaul Kocialkowski		used in fs mode
3702e2ccdf89SPaul Kocialkowski
370395579793STom Rini		CONFIG_SPL_FAT_SUPPORT
370495579793STom Rini		Support for fs/fat/libfat.o in SPL binary
370595579793STom Rini
3706fae81c72SGuillaume GARDET		CONFIG_SPL_EXT_SUPPORT
3707fae81c72SGuillaume GARDET		Support for EXT filesystem in SPL binary
370895579793STom Rini
3709fae81c72SGuillaume GARDET		CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
3710fae81c72SGuillaume GARDET		Filename to read to load U-Boot when reading from filesystem
3711fae81c72SGuillaume GARDET
3712fae81c72SGuillaume GARDET		CONFIG_SPL_FS_LOAD_KERNEL_NAME
37137ad2cc79SPeter Korsgaard		Filename to read to load kernel uImage when reading
3714fae81c72SGuillaume GARDET		from filesystem (for Falcon mode)
37157ad2cc79SPeter Korsgaard
3716fae81c72SGuillaume GARDET		CONFIG_SPL_FS_LOAD_ARGS_NAME
37177ad2cc79SPeter Korsgaard		Filename to read to load kernel argument parameters
3718fae81c72SGuillaume GARDET		when reading from filesystem (for Falcon mode)
37197ad2cc79SPeter Korsgaard
372006f60ae3SScott Wood		CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
372106f60ae3SScott Wood		Set this for NAND SPL on PPC mpc83xx targets, so that
372206f60ae3SScott Wood		start.S waits for the rest of the SPL to load before
372306f60ae3SScott Wood		continuing (the hardware starts execution after just
372406f60ae3SScott Wood		loading the first page rather than the full 4K).
372506f60ae3SScott Wood
3726651fcf60SPrabhakar Kushwaha		CONFIG_SPL_SKIP_RELOCATE
3727651fcf60SPrabhakar Kushwaha		Avoid SPL relocation
3728651fcf60SPrabhakar Kushwaha
37296f2f01b9SScott Wood		CONFIG_SPL_NAND_BASE
37306f2f01b9SScott Wood		Include nand_base.c in the SPL.  Requires
37316f2f01b9SScott Wood		CONFIG_SPL_NAND_DRIVERS.
37326f2f01b9SScott Wood
37336f2f01b9SScott Wood		CONFIG_SPL_NAND_DRIVERS
37346f2f01b9SScott Wood		SPL uses normal NAND drivers, not minimal drivers.
37356f2f01b9SScott Wood
37366f2f01b9SScott Wood		CONFIG_SPL_NAND_ECC
37376f2f01b9SScott Wood		Include standard software ECC in the SPL
37386f2f01b9SScott Wood
373995579793STom Rini		CONFIG_SPL_NAND_SIMPLE
37407d4b7955SScott Wood		Support for NAND boot using simple NAND drivers that
37417d4b7955SScott Wood		expose the cmd_ctrl() interface.
374295579793STom Rini
37436dd3b566STom Rini		CONFIG_SPL_MTD_SUPPORT
37446dd3b566STom Rini		Support for the MTD subsystem within SPL.  Useful for
37456dd3b566STom Rini		environment on NAND support within SPL.
37466dd3b566STom Rini
37470c3117b1SHeiko Schocher		CONFIG_SPL_NAND_RAW_ONLY
37480c3117b1SHeiko Schocher		Support to boot only raw u-boot.bin images. Use this only
37490c3117b1SHeiko Schocher		if you need to save space.
37500c3117b1SHeiko Schocher
3751bb0dc108SYing Zhang		CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT
3752bb0dc108SYing Zhang		Set for the SPL on PPC mpc8xxx targets, support for
37535614e71bSYork Sun		drivers/ddr/fsl/libddr.o in SPL binary.
3754bb0dc108SYing Zhang
37557c8eea59SYing Zhang		CONFIG_SPL_COMMON_INIT_DDR
37567c8eea59SYing Zhang		Set for common ddr init with serial presence detect in
37577c8eea59SYing Zhang		SPL binary.
37587c8eea59SYing Zhang
375995579793STom Rini		CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
376095579793STom Rini		CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
376195579793STom Rini		CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
376295579793STom Rini		CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
376395579793STom Rini		CONFIG_SYS_NAND_ECCBYTES
376495579793STom Rini		Defines the size and behavior of the NAND that SPL uses
37657d4b7955SScott Wood		to read U-Boot
376695579793STom Rini
3767fbe76ae4SPrabhakar Kushwaha		CONFIG_SPL_NAND_BOOT
3768fbe76ae4SPrabhakar Kushwaha		Add support NAND boot
3769fbe76ae4SPrabhakar Kushwaha
377095579793STom Rini		CONFIG_SYS_NAND_U_BOOT_OFFS
37717d4b7955SScott Wood		Location in NAND to read U-Boot from
37727d4b7955SScott Wood
37737d4b7955SScott Wood		CONFIG_SYS_NAND_U_BOOT_DST
37747d4b7955SScott Wood		Location in memory to load U-Boot to
37757d4b7955SScott Wood
37767d4b7955SScott Wood		CONFIG_SYS_NAND_U_BOOT_SIZE
37777d4b7955SScott Wood		Size of image to load
377895579793STom Rini
377995579793STom Rini		CONFIG_SYS_NAND_U_BOOT_START
37807d4b7955SScott Wood		Entry point in loaded image to jump to
378195579793STom Rini
378295579793STom Rini		CONFIG_SYS_NAND_HW_ECC_OOBFIRST
378395579793STom Rini		Define this if you need to first read the OOB and then the
3784b445bbb4SJeremiah Mahler		data. This is used, for example, on davinci platforms.
378595579793STom Rini
378695579793STom Rini		CONFIG_SPL_OMAP3_ID_NAND
378795579793STom Rini		Support for an OMAP3-specific set of functions to return the
378895579793STom Rini		ID and MFR of the first attached NAND chip, if present.
378995579793STom Rini
37906a11cf48SDaniel Schwierzeck		CONFIG_SPL_SERIAL_SUPPORT
37916a11cf48SDaniel Schwierzeck		Support for drivers/serial/libserial.o in SPL binary
37926a11cf48SDaniel Schwierzeck
37936a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_FLASH_SUPPORT
37946a11cf48SDaniel Schwierzeck		Support for drivers/mtd/spi/libspi_flash.o in SPL binary
37956a11cf48SDaniel Schwierzeck
37966a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_SUPPORT
37976a11cf48SDaniel Schwierzeck		Support for drivers/spi/libspi.o in SPL binary
37986a11cf48SDaniel Schwierzeck
3799c57b953dSPavel Machek		CONFIG_SPL_RAM_DEVICE
3800c57b953dSPavel Machek		Support for running image already present in ram, in SPL binary
3801c57b953dSPavel Machek
38026a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBGENERIC_SUPPORT
38036a11cf48SDaniel Schwierzeck		Support for lib/libgeneric.o in SPL binary
38041372cce2SMarian Balakowicz
3805ba1bee43SYing Zhang		CONFIG_SPL_ENV_SUPPORT
3806ba1bee43SYing Zhang		Support for the environment operating in SPL binary
3807ba1bee43SYing Zhang
3808ba1bee43SYing Zhang		CONFIG_SPL_NET_SUPPORT
3809ba1bee43SYing Zhang		Support for the net/libnet.o in SPL binary.
3810ba1bee43SYing Zhang		It conflicts with SPL env from storage medium specified by
3811ba1bee43SYing Zhang		CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3812ba1bee43SYing Zhang
381374752baaSScott Wood		CONFIG_SPL_PAD_TO
38146113d3f2SBenoît Thébaudeau		Image offset to which the SPL should be padded before appending
38156113d3f2SBenoît Thébaudeau		the SPL payload. By default, this is defined as
38166113d3f2SBenoît Thébaudeau		CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
38176113d3f2SBenoît Thébaudeau		CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
38186113d3f2SBenoît Thébaudeau		payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
381974752baaSScott Wood
3820ca2fca22SScott Wood		CONFIG_SPL_TARGET
3821ca2fca22SScott Wood		Final target image containing SPL and payload.  Some SPLs
3822ca2fca22SScott Wood		use an arch-specific makefile fragment instead, for
3823ca2fca22SScott Wood		example if more than one image needs to be produced.
3824ca2fca22SScott Wood
382587ebee39SSimon Glass		CONFIG_FIT_SPL_PRINT
382687ebee39SSimon Glass		Printing information about a FIT image adds quite a bit of
382787ebee39SSimon Glass		code to SPL. So this is normally disabled in SPL. Use this
382887ebee39SSimon Glass		option to re-enable it. This will affect the output of the
382987ebee39SSimon Glass		bootm command when booting a FIT image.
383087ebee39SSimon Glass
38313aa29de0SYing Zhang- TPL framework
38323aa29de0SYing Zhang		CONFIG_TPL
38333aa29de0SYing Zhang		Enable building of TPL globally.
38343aa29de0SYing Zhang
38353aa29de0SYing Zhang		CONFIG_TPL_PAD_TO
38363aa29de0SYing Zhang		Image offset to which the TPL should be padded before appending
38373aa29de0SYing Zhang		the TPL payload. By default, this is defined as
38383aa29de0SYing Zhang		CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
38393aa29de0SYing Zhang		CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
38403aa29de0SYing Zhang		payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
38413aa29de0SYing Zhang
3842c609719bSwdenkModem Support:
3843c609719bSwdenk--------------
3844c609719bSwdenk
3845566e5cf4SWolfgang Denk[so far only for SMDK2400 boards]
3846c609719bSwdenk
384711ccc33fSMarcel Ziswiler- Modem support enable:
3848c609719bSwdenk		CONFIG_MODEM_SUPPORT
3849c609719bSwdenk
3850c609719bSwdenk- RTS/CTS Flow control enable:
3851c609719bSwdenk		CONFIG_HWFLOW
3852c609719bSwdenk
3853c609719bSwdenk- Modem debug support:
3854c609719bSwdenk		CONFIG_MODEM_SUPPORT_DEBUG
3855c609719bSwdenk
3856c609719bSwdenk		Enables debugging stuff (char screen[1024], dbg())
3857c609719bSwdenk		for modem support. Useful only with BDI2000.
3858c609719bSwdenk
3859a8c7c708Swdenk- Interrupt support (PPC):
3860a8c7c708Swdenk
3861a8c7c708Swdenk		There are common interrupt_init() and timer_interrupt()
3862a8c7c708Swdenk		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
386311ccc33fSMarcel Ziswiler		for CPU specific initialization. interrupt_init_cpu()
3864a8c7c708Swdenk		should set decrementer_count to appropriate value. If
386511ccc33fSMarcel Ziswiler		CPU resets decrementer automatically after interrupt
3866a8c7c708Swdenk		(ppc4xx) it should set decrementer_count to zero.
386711ccc33fSMarcel Ziswiler		timer_interrupt() calls timer_interrupt_cpu() for CPU
3868a8c7c708Swdenk		specific handling. If board has watchdog / status_led
3869a8c7c708Swdenk		/ other_activity_monitor it works automatically from
3870a8c7c708Swdenk		general timer_interrupt().
3871a8c7c708Swdenk
3872c609719bSwdenk- General:
3873c609719bSwdenk
3874c609719bSwdenk		In the target system modem support is enabled when a
3875c609719bSwdenk		specific key (key combination) is pressed during
3876c609719bSwdenk		power-on. Otherwise U-Boot will boot normally
387711ccc33fSMarcel Ziswiler		(autoboot). The key_pressed() function is called from
3878c609719bSwdenk		board_init(). Currently key_pressed() is a dummy
3879c609719bSwdenk		function, returning 1 and thus enabling modem
3880c609719bSwdenk		initialization.
3881c609719bSwdenk
3882c609719bSwdenk		If there are no modem init strings in the
3883c609719bSwdenk		environment, U-Boot proceed to autoboot; the
3884c609719bSwdenk		previous output (banner, info printfs) will be
388511ccc33fSMarcel Ziswiler		suppressed, though.
3886c609719bSwdenk
3887c609719bSwdenk		See also: doc/README.Modem
3888c609719bSwdenk
38899660e442SHelmut RaigerBoard initialization settings:
38909660e442SHelmut Raiger------------------------------
38919660e442SHelmut Raiger
38929660e442SHelmut RaigerDuring Initialization u-boot calls a number of board specific functions
38939660e442SHelmut Raigerto allow the preparation of board specific prerequisites, e.g. pin setup
38949660e442SHelmut Raigerbefore drivers are initialized. To enable these callbacks the
38959660e442SHelmut Raigerfollowing configuration macros have to be defined. Currently this is
38969660e442SHelmut Raigerarchitecture specific, so please check arch/your_architecture/lib/board.c
38979660e442SHelmut Raigertypically in board_init_f() and board_init_r().
38989660e442SHelmut Raiger
38999660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
39009660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
39019660e442SHelmut Raiger- CONFIG_BOARD_LATE_INIT: Call board_late_init()
39029660e442SHelmut Raiger- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
3903c609719bSwdenk
3904c609719bSwdenkConfiguration Settings:
3905c609719bSwdenk-----------------------
3906c609719bSwdenk
39074d1fd7f1SYork Sun- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
39084d1fd7f1SYork Sun		Optionally it can be defined to support 64-bit memory commands.
39094d1fd7f1SYork Sun
39106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
3911c609719bSwdenk		undefine this when you're short of memory.
3912c609719bSwdenk
39132fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
39142fb2604dSPeter Tyser		width of the commands listed in the 'help' command output.
39152fb2604dSPeter Tyser
39166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT:	This is what U-Boot prints on the console to
3917c609719bSwdenk		prompt for user input.
3918c609719bSwdenk
39196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE:	Buffer size for input from the Console
3920c609719bSwdenk
39216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE:	Buffer size for Console output
3922c609719bSwdenk
39236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS:	max. Number of arguments accepted for monitor commands
3924c609719bSwdenk
39256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
3926c609719bSwdenk		the application (usually a Linux kernel) when it is
3927c609719bSwdenk		booted
3928c609719bSwdenk
39296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE:
3930c609719bSwdenk		List of legal baudrate settings for this board.
3931c609719bSwdenk
39326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_INFO_QUIET
3933c609719bSwdenk		Suppress display of console information at boot.
3934c609719bSwdenk
39356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_IS_IN_ENV
3936c609719bSwdenk		If the board specific function
3937c609719bSwdenk			extern int overwrite_console (void);
3938c609719bSwdenk		returns 1, the stdin, stderr and stdout are switched to the
3939c609719bSwdenk		serial port, else the settings in the environment are used.
3940c609719bSwdenk
39416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
3942c609719bSwdenk		Enable the call to overwrite_console().
3943c609719bSwdenk
39446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
3945c609719bSwdenk		Enable overwrite of previous console environment settings.
3946c609719bSwdenk
39476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
3948c609719bSwdenk		Begin and End addresses of the area used by the
3949c609719bSwdenk		simple memory test.
3950c609719bSwdenk
39516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST:
3952c609719bSwdenk		Enable an alternate, more extensive memory test.
3953c609719bSwdenk
39546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH:
39555f535fe1Swdenk		Scratch address used by the alternate memory test
39565f535fe1Swdenk		You only need to set this if address zero isn't writeable
39575f535fe1Swdenk
39586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
39596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
396014f73ca6SStefan Roese		this specified memory area will get subtracted from the top
396111ccc33fSMarcel Ziswiler		(end) of RAM and won't get "touched" at all by U-Boot. By
396214f73ca6SStefan Roese		fixing up gd->ram_size the Linux kernel should gets passed
396314f73ca6SStefan Roese		the now "corrected" memory size and won't touch it either.
396414f73ca6SStefan Roese		This should work for arch/ppc and arch/powerpc. Only Linux
39655e12e75dSStefan Roese		board ports in arch/powerpc with bootwrapper support that
396614f73ca6SStefan Roese		recalculate the memory size from the SDRAM controller setup
39675e12e75dSStefan Roese		will have to get fixed in Linux additionally.
396814f73ca6SStefan Roese
396914f73ca6SStefan Roese		This option can be used as a workaround for the 440EPx/GRx
397014f73ca6SStefan Roese		CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
397114f73ca6SStefan Roese		be touched.
397214f73ca6SStefan Roese
397314f73ca6SStefan Roese		WARNING: Please make sure that this value is a multiple of
397414f73ca6SStefan Roese		the Linux page size (normally 4k). If this is not the case,
397514f73ca6SStefan Roese		then the end address of the Linux memory will be located at a
397614f73ca6SStefan Roese		non page size aligned address and this could cause major
397714f73ca6SStefan Roese		problems.
397814f73ca6SStefan Roese
39796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE:
3980c609719bSwdenk		Enable temporary baudrate change while serial download
3981c609719bSwdenk
39826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE:
3983c609719bSwdenk		Physical start address of SDRAM. _Must_ be 0 here.
3984c609719bSwdenk
39856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MBIO_BASE:
3986c609719bSwdenk		Physical start address of Motherboard I/O (if using a
3987c609719bSwdenk		Cogent motherboard)
3988c609719bSwdenk
39896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE:
3990c609719bSwdenk		Physical start address of Flash memory.
3991c609719bSwdenk
39926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE:
3993c609719bSwdenk		Physical start address of boot monitor code (set by
3994c609719bSwdenk		make config files to be same as the text base address
399514d0a02aSWolfgang Denk		(CONFIG_SYS_TEXT_BASE) used when linking) - same as
39966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FLASH_BASE when booting from flash.
3997c609719bSwdenk
39986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN:
39993b57fe0aSwdenk		Size of memory reserved for monitor code, used to
40003b57fe0aSwdenk		determine _at_compile_time_ (!) if the environment is
40013b57fe0aSwdenk		embedded within the U-Boot image, or in a separate
40023b57fe0aSwdenk		flash sector.
4003c609719bSwdenk
40046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN:
4005c609719bSwdenk		Size of DRAM reserved for malloc() use.
4006c609719bSwdenk
4007d59476b6SSimon Glass- CONFIG_SYS_MALLOC_F_LEN
4008d59476b6SSimon Glass		Size of the malloc() pool for use before relocation. If
4009d59476b6SSimon Glass		this is defined, then a very simple malloc() implementation
4010d59476b6SSimon Glass		will become available before relocation. The address is just
4011d59476b6SSimon Glass		below the global data, and the stack is moved down to make
4012d59476b6SSimon Glass		space.
4013d59476b6SSimon Glass
4014d59476b6SSimon Glass		This feature allocates regions with increasing addresses
4015d59476b6SSimon Glass		within the region. calloc() is supported, but realloc()
4016d59476b6SSimon Glass		is not available. free() is supported but does nothing.
4017b445bbb4SJeremiah Mahler		The memory will be freed (or in fact just forgotten) when
4018d59476b6SSimon Glass		U-Boot relocates itself.
4019d59476b6SSimon Glass
4020e7b14e9aSSimon Glass		Pre-relocation malloc() is only supported on ARM and sandbox
402129afe9e6SSimon Glass		at present but is fairly easy to enable for other archs.
402229afe9e6SSimon Glass
402338687ae6SSimon Glass- CONFIG_SYS_MALLOC_SIMPLE
402438687ae6SSimon Glass		Provides a simple and small malloc() and calloc() for those
402538687ae6SSimon Glass		boards which do not use the full malloc in SPL (which is
402638687ae6SSimon Glass		enabled with CONFIG_SYS_SPL_MALLOC_START).
402738687ae6SSimon Glass
40281dfdd9baSThierry Reding- CONFIG_SYS_NONCACHED_MEMORY:
40291dfdd9baSThierry Reding		Size of non-cached memory area. This area of memory will be
40301dfdd9baSThierry Reding		typically located right below the malloc() area and mapped
40311dfdd9baSThierry Reding		uncached in the MMU. This is useful for drivers that would
40321dfdd9baSThierry Reding		otherwise require a lot of explicit cache maintenance. For
40331dfdd9baSThierry Reding		some drivers it's also impossible to properly maintain the
40341dfdd9baSThierry Reding		cache. For example if the regions that need to be flushed
40351dfdd9baSThierry Reding		are not a multiple of the cache-line size, *and* padding
40361dfdd9baSThierry Reding		cannot be allocated between the regions to align them (i.e.
40371dfdd9baSThierry Reding		if the HW requires a contiguous array of regions, and the
40381dfdd9baSThierry Reding		size of each region is not cache-aligned), then a flush of
40391dfdd9baSThierry Reding		one region may result in overwriting data that hardware has
40401dfdd9baSThierry Reding		written to another region in the same cache-line. This can
40411dfdd9baSThierry Reding		happen for example in network drivers where descriptors for
40421dfdd9baSThierry Reding		buffers are typically smaller than the CPU cache-line (e.g.
40431dfdd9baSThierry Reding		16 bytes vs. 32 or 64 bytes).
40441dfdd9baSThierry Reding
40451dfdd9baSThierry Reding		Non-cached memory is only supported on 32-bit ARM at present.
40461dfdd9baSThierry Reding
40476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN:
404815940c9aSStefan Roese		Normally compressed uImages are limited to an
404915940c9aSStefan Roese		uncompressed size of 8 MBytes. If this is not enough,
40506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		you can define CONFIG_SYS_BOOTM_LEN in your board config file
405115940c9aSStefan Roese		to adjust this setting to your needs.
4052c609719bSwdenk
40536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ:
4054c609719bSwdenk		Maximum size of memory mapped by the startup code of
4055c609719bSwdenk		the Linux kernel; all data that must be processed by
40567d721e34SBartlomiej Sieka		the Linux kernel (bd_info, boot arguments, FDT blob if
40577d721e34SBartlomiej Sieka		used) must be put below this limit, unless "bootm_low"
40581bce2aebSRobert P. J. Day		environment variable is defined and non-zero. In such case
40597d721e34SBartlomiej Sieka		all data for the Linux kernel must be between "bootm_low"
4060c3624e6eSGrant Likely		and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.	 The environment
4061c3624e6eSGrant Likely		variable "bootm_mapsize" will override the value of
4062c3624e6eSGrant Likely		CONFIG_SYS_BOOTMAPSZ.  If CONFIG_SYS_BOOTMAPSZ is undefined,
4063c3624e6eSGrant Likely		then the value in "bootm_size" will be used instead.
4064c609719bSwdenk
4065fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_RAMDISK_HIGH:
4066fca43cc8SJohn Rigby		Enable initrd_high functionality.  If defined then the
4067fca43cc8SJohn Rigby		initrd_high feature is enabled and the bootm ramdisk subcommand
4068fca43cc8SJohn Rigby		is enabled.
4069fca43cc8SJohn Rigby
4070fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_CMDLINE:
4071fca43cc8SJohn Rigby		Enables allocating and saving kernel cmdline in space between
4072fca43cc8SJohn Rigby		"bootm_low" and "bootm_low" + BOOTMAPSZ.
4073fca43cc8SJohn Rigby
4074fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_KBD:
4075fca43cc8SJohn Rigby		Enables allocating and saving a kernel copy of the bd_info in
4076fca43cc8SJohn Rigby		space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
4077fca43cc8SJohn Rigby
40786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS:
4079c609719bSwdenk		Max number of Flash memory banks
4080c609719bSwdenk
40816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT:
4082c609719bSwdenk		Max number of sectors on a Flash chip
4083c609719bSwdenk
40846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT:
4085c609719bSwdenk		Timeout for Flash erase operations (in ms)
4086c609719bSwdenk
40876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT:
4088c609719bSwdenk		Timeout for Flash write operations (in ms)
4089c609719bSwdenk
40906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT
40918564acf9Swdenk		Timeout for Flash set sector lock bit operation (in ms)
40928564acf9Swdenk
40936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT
40948564acf9Swdenk		Timeout for Flash clear lock bits operation (in ms)
40958564acf9Swdenk
40966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION
40978564acf9Swdenk		If defined, hardware flash sectors protection is used
40988564acf9Swdenk		instead of U-Boot software protection.
40998564acf9Swdenk
41006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP:
4101c609719bSwdenk
4102c609719bSwdenk		Enable TFTP transfers directly to flash memory;
4103c609719bSwdenk		without this option such a download has to be
4104c609719bSwdenk		performed in two steps: (1) download to RAM, and (2)
4105c609719bSwdenk		copy from RAM to flash.
4106c609719bSwdenk
4107c609719bSwdenk		The two-step approach is usually more reliable, since
4108c609719bSwdenk		you can check if the download worked before you erase
410911ccc33fSMarcel Ziswiler		the flash, but in some situations (when system RAM is
411011ccc33fSMarcel Ziswiler		too limited to allow for a temporary copy of the
4111c609719bSwdenk		downloaded image) this option may be very useful.
4112c609719bSwdenk
41136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI:
4114c609719bSwdenk		Define if the flash driver uses extra elements in the
41155653fc33Swdenk		common flash structure for storing flash geometry.
41165653fc33Swdenk
411700b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER
41185653fc33Swdenk		This option also enables the building of the cfi_flash driver
41195653fc33Swdenk		in the drivers directory
412053cf9435Sstroese
412191809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD
412291809ed5SPiotr Ziecik		This option enables the building of the cfi_mtd driver
412391809ed5SPiotr Ziecik		in the drivers directory. The driver exports CFI flash
412491809ed5SPiotr Ziecik		to the MTD layer.
412591809ed5SPiotr Ziecik
41266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
412796ef831fSGuennadi Liakhovetski		Use buffered writes to flash.
412896ef831fSGuennadi Liakhovetski
412996ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N
413096ef831fSGuennadi Liakhovetski		s29ws-n MirrorBit flash has non-standard addresses for buffered
413196ef831fSGuennadi Liakhovetski		write commands.
413296ef831fSGuennadi Liakhovetski
41336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST
41345568e613SStefan Roese		If this option is defined, the common CFI flash doesn't
41355568e613SStefan Roese		print it's warning upon not recognized FLASH banks. This
41365568e613SStefan Roese		is useful, if some of the configured banks are only
41375568e613SStefan Roese		optionally available.
41385568e613SStefan Roese
41399a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS
41409a042e9cSJerry Van Baren		If defined (must be an integer), print out countdown
41419a042e9cSJerry Van Baren		digits and dots.  Recommended value: 45 (9..1) for 80
41429a042e9cSJerry Van Baren		column displays, 15 (3..1) for 40 column displays.
41439a042e9cSJerry Van Baren
4144352ef3f1SStefan Roese- CONFIG_FLASH_VERIFY
4145352ef3f1SStefan Roese		If defined, the content of the flash (destination) is compared
4146352ef3f1SStefan Roese		against the source after the write operation. An error message
4147352ef3f1SStefan Roese		will be printed when the contents are not identical.
4148352ef3f1SStefan Roese		Please note that this option is useless in nearly all cases,
4149352ef3f1SStefan Roese		since such flash programming errors usually are detected earlier
4150352ef3f1SStefan Roese		while unprotecting/erasing/programming. Please only enable
4151352ef3f1SStefan Roese		this option if you really know what you are doing.
4152352ef3f1SStefan Roese
41536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER:
415411ccc33fSMarcel Ziswiler		Defines the number of Ethernet receive buffers. On some
415511ccc33fSMarcel Ziswiler		Ethernet controllers it is recommended to set this value
415653cf9435Sstroese		to 8 or even higher (EEPRO100 or 405 EMAC), since all
415753cf9435Sstroese		buffers can be full shortly after enabling the interface
415811ccc33fSMarcel Ziswiler		on high Ethernet traffic.
415953cf9435Sstroese		Defaults to 4 if not defined.
4160c609719bSwdenk
4161ea882bafSWolfgang Denk- CONFIG_ENV_MAX_ENTRIES
4162ea882bafSWolfgang Denk
4163ea882bafSWolfgang Denk	Maximum number of entries in the hash table that is used
4164ea882bafSWolfgang Denk	internally to store the environment settings. The default
4165ea882bafSWolfgang Denk	setting is supposed to be generous and should work in most
4166ea882bafSWolfgang Denk	cases. This setting can be used to tune behaviour; see
4167ea882bafSWolfgang Denk	lib/hashtable.c for details.
4168ea882bafSWolfgang Denk
41692598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_DEFAULT
41702598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_STATIC
41711bce2aebSRobert P. J. Day	Enable validation of the values given to environment variables when
41722598090bSJoe Hershberger	calling env set.  Variables can be restricted to only decimal,
41732598090bSJoe Hershberger	hexadecimal, or boolean.  If CONFIG_CMD_NET is also defined,
41742598090bSJoe Hershberger	the variables can also be restricted to IP address or MAC address.
41752598090bSJoe Hershberger
41762598090bSJoe Hershberger	The format of the list is:
41772598090bSJoe Hershberger		type_attribute = [s|d|x|b|i|m]
4178b445bbb4SJeremiah Mahler		access_attribute = [a|r|o|c]
4179b445bbb4SJeremiah Mahler		attributes = type_attribute[access_attribute]
41802598090bSJoe Hershberger		entry = variable_name[:attributes]
41812598090bSJoe Hershberger		list = entry[,list]
41822598090bSJoe Hershberger
41832598090bSJoe Hershberger	The type attributes are:
41842598090bSJoe Hershberger		s - String (default)
41852598090bSJoe Hershberger		d - Decimal
41862598090bSJoe Hershberger		x - Hexadecimal
41872598090bSJoe Hershberger		b - Boolean ([1yYtT|0nNfF])
41882598090bSJoe Hershberger		i - IP address
41892598090bSJoe Hershberger		m - MAC address
41902598090bSJoe Hershberger
4191267541f7SJoe Hershberger	The access attributes are:
4192267541f7SJoe Hershberger		a - Any (default)
4193267541f7SJoe Hershberger		r - Read-only
4194267541f7SJoe Hershberger		o - Write-once
4195267541f7SJoe Hershberger		c - Change-default
4196267541f7SJoe Hershberger
41972598090bSJoe Hershberger	- CONFIG_ENV_FLAGS_LIST_DEFAULT
41982598090bSJoe Hershberger		Define this to a list (string) to define the ".flags"
4199b445bbb4SJeremiah Mahler		environment variable in the default or embedded environment.
42002598090bSJoe Hershberger
42012598090bSJoe Hershberger	- CONFIG_ENV_FLAGS_LIST_STATIC
42022598090bSJoe Hershberger		Define this to a list (string) to define validation that
42032598090bSJoe Hershberger		should be done if an entry is not found in the ".flags"
42042598090bSJoe Hershberger		environment variable.  To override a setting in the static
42052598090bSJoe Hershberger		list, simply add an entry for the same variable name to the
42062598090bSJoe Hershberger		".flags" variable.
42072598090bSJoe Hershberger
4208267541f7SJoe Hershberger- CONFIG_ENV_ACCESS_IGNORE_FORCE
4209267541f7SJoe Hershberger	If defined, don't allow the -f switch to env set override variable
4210267541f7SJoe Hershberger	access flags.
4211267541f7SJoe Hershberger
42125c1a7ea6SSimon Glass- CONFIG_SYS_GENERIC_BOARD
42135c1a7ea6SSimon Glass	This selects the architecture-generic board system instead of the
42145c1a7ea6SSimon Glass	architecture-specific board files. It is intended to move boards
42155c1a7ea6SSimon Glass	to this new framework over time. Defining this will disable the
42165c1a7ea6SSimon Glass	arch/foo/lib/board.c file and use common/board_f.c and
42175c1a7ea6SSimon Glass	common/board_r.c instead. To use this option your architecture
42185c1a7ea6SSimon Glass	must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in
42195c1a7ea6SSimon Glass	its config.mk file). If you find problems enabling this option on
42205c1a7ea6SSimon Glass	your board please report the problem and send patches!
42215c1a7ea6SSimon Glass
42220b1b60c7SLokesh Vutla- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
42230b1b60c7SLokesh Vutla	This is set by OMAP boards for the max time that reset should
42240b1b60c7SLokesh Vutla	be asserted. See doc/README.omap-reset-time for details on how
4225b445bbb4SJeremiah Mahler	the value can be calculated on a given board.
4226632efa74SSimon Glass
42270d296cc2SGabe Black- CONFIG_USE_STDINT
42280d296cc2SGabe Black	If stdint.h is available with your toolchain you can define this
42290d296cc2SGabe Black	option to enable it. You can provide option 'USE_STDINT=1' when
42300d296cc2SGabe Black	building U-Boot to enable this.
42310d296cc2SGabe Black
4232c609719bSwdenkThe following definitions that deal with the placement and management
4233c609719bSwdenkof environment data (variable area); in general, we support the
4234c609719bSwdenkfollowing configurations:
4235c609719bSwdenk
4236c3eb3fe4SMike Frysinger- CONFIG_BUILD_ENVCRC:
4237c3eb3fe4SMike Frysinger
4238c3eb3fe4SMike Frysinger	Builds up envcrc with the target environment so that external utils
4239c3eb3fe4SMike Frysinger	may easily extract it and embed it in final U-Boot images.
4240c3eb3fe4SMike Frysinger
42415a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH:
4242c609719bSwdenk
4243c609719bSwdenk	Define this if the environment is in flash memory.
4244c609719bSwdenk
4245c609719bSwdenk	a) The environment occupies one whole flash sector, which is
4246c609719bSwdenk	   "embedded" in the text segment with the U-Boot code. This
4247c609719bSwdenk	   happens usually with "bottom boot sector" or "top boot
4248c609719bSwdenk	   sector" type flash chips, which have several smaller
4249c609719bSwdenk	   sectors at the start or the end. For instance, such a
4250c609719bSwdenk	   layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
4251c609719bSwdenk	   such a case you would place the environment in one of the
4252c609719bSwdenk	   4 kB sectors - with U-Boot code before and after it. With
4253c609719bSwdenk	   "top boot sector" type flash chips, you would put the
4254c609719bSwdenk	   environment in one of the last sectors, leaving a gap
4255c609719bSwdenk	   between U-Boot and the environment.
4256c609719bSwdenk
42570e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
4258c609719bSwdenk
4259c609719bSwdenk	   Offset of environment data (variable area) to the
4260c609719bSwdenk	   beginning of flash memory; for instance, with bottom boot
4261c609719bSwdenk	   type flash chips the second sector can be used: the offset
4262c609719bSwdenk	   for this sector is given here.
4263c609719bSwdenk
42646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
4265c609719bSwdenk
42660e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
4267c609719bSwdenk
4268c609719bSwdenk	   This is just another way to specify the start address of
4269c609719bSwdenk	   the flash sector containing the environment (instead of
42700e8d1586SJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET).
4271c609719bSwdenk
42720e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SECT_SIZE:
4273c609719bSwdenk
4274c609719bSwdenk	   Size of the sector containing the environment.
4275c609719bSwdenk
4276c609719bSwdenk
4277c609719bSwdenk	b) Sometimes flash chips have few, equal sized, BIG sectors.
4278c609719bSwdenk	   In such a case you don't want to spend a whole sector for
4279c609719bSwdenk	   the environment.
4280c609719bSwdenk
42810e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
4282c609719bSwdenk
42835a1aceb0SJean-Christophe PLAGNIOL-VILLARD	   If you use this in combination with CONFIG_ENV_IS_IN_FLASH
42840e8d1586SJean-Christophe PLAGNIOL-VILLARD	   and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
4285c609719bSwdenk	   of this flash sector for the environment. This saves
4286c609719bSwdenk	   memory for the RAM copy of the environment.
4287c609719bSwdenk
4288c609719bSwdenk	   It may also save flash memory if you decide to use this
4289c609719bSwdenk	   when your environment is "embedded" within U-Boot code,
4290c609719bSwdenk	   since then the remainder of the flash sector could be used
4291c609719bSwdenk	   for U-Boot code. It should be pointed out that this is
4292c609719bSwdenk	   STRONGLY DISCOURAGED from a robustness point of view:
4293c609719bSwdenk	   updating the environment in flash makes it always
4294c609719bSwdenk	   necessary to erase the WHOLE sector. If something goes
4295c609719bSwdenk	   wrong before the contents has been restored from a copy in
4296c609719bSwdenk	   RAM, your target system will be dead.
4297c609719bSwdenk
42980e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR_REDUND
42990e8d1586SJean-Christophe PLAGNIOL-VILLARD	  CONFIG_ENV_SIZE_REDUND
4300c609719bSwdenk
4301c609719bSwdenk	   These settings describe a second storage area used to hold
430211ccc33fSMarcel Ziswiler	   a redundant copy of the environment data, so that there is
43033e38691eSwdenk	   a valid backup copy in case there is a power failure during
4304c609719bSwdenk	   a "saveenv" operation.
4305c609719bSwdenk
4306c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the
4307c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds*
4308c609719bSwdenkaccordingly!
4309c609719bSwdenk
4310c609719bSwdenk
43119314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM:
4312c609719bSwdenk
4313c609719bSwdenk	Define this if you have some non-volatile memory device
4314c609719bSwdenk	(NVRAM, battery buffered SRAM) which you want to use for the
4315c609719bSwdenk	environment.
4316c609719bSwdenk
43170e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
43180e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
4319c609719bSwdenk
432011ccc33fSMarcel Ziswiler	  These two #defines are used to determine the memory area you
4321c609719bSwdenk	  want to use for environment. It is assumed that this memory
4322c609719bSwdenk	  can just be read and written to, without any special
4323c609719bSwdenk	  provision.
4324c609719bSwdenk
4325c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early
4326b445bbb4SJeremiah Mahlerin U-Boot initialization (when we try to get the setting of for the
432711ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or
4328c609719bSwdenkU-Boot will hang.
4329c609719bSwdenk
4330c609719bSwdenkPlease note that even with NVRAM we still use a copy of the
4331c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to
4332c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv"
4333c609719bSwdenkto save the current settings.
4334c609719bSwdenk
4335c609719bSwdenk
4336bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM:
4337c609719bSwdenk
4338c609719bSwdenk	Use this if you have an EEPROM or similar serial access
4339c609719bSwdenk	device and a driver for it.
4340c609719bSwdenk
43410e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
43420e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
4343c609719bSwdenk
4344c609719bSwdenk	  These two #defines specify the offset and size of the
4345c609719bSwdenk	  environment area within the total memory of your EEPROM.
4346c609719bSwdenk
43476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR:
4348c609719bSwdenk	  If defined, specified the chip address of the EEPROM device.
4349c609719bSwdenk	  The default address is zero.
4350c609719bSwdenk
43516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
4352c609719bSwdenk	  If defined, the number of bits used to address bytes in a
4353c609719bSwdenk	  single page in the EEPROM device.  A 64 byte page, for example
4354c609719bSwdenk	  would require six bits.
4355c609719bSwdenk
43566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
4357c609719bSwdenk	  If defined, the number of milliseconds to delay between
4358c609719bSwdenk	  page writes.	The default is zero milliseconds.
4359c609719bSwdenk
43606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
4361c609719bSwdenk	  The length in bytes of the EEPROM memory array address.  Note
4362c609719bSwdenk	  that this is NOT the chip address length!
4363c609719bSwdenk
43646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
43655cf91d6bSwdenk	  EEPROM chips that implement "address overflow" are ones
43665cf91d6bSwdenk	  like Catalyst 24WC04/08/16 which has 9/10/11 bits of
43675cf91d6bSwdenk	  address and the extra bits end up in the "chip address" bit
43685cf91d6bSwdenk	  slots. This makes a 24WC08 (1Kbyte) chip look like four 256
43695cf91d6bSwdenk	  byte chips.
43705cf91d6bSwdenk
43715cf91d6bSwdenk	  Note that we consider the length of the address field to
43725cf91d6bSwdenk	  still be one byte because the extra address bits are hidden
43735cf91d6bSwdenk	  in the chip address.
43745cf91d6bSwdenk
43756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_SIZE:
4376c609719bSwdenk	  The size in bytes of the EEPROM device.
4377c609719bSwdenk
4378548738b4SHeiko Schocher	- CONFIG_ENV_EEPROM_IS_ON_I2C
4379548738b4SHeiko Schocher	  define this, if you have I2C and SPI activated, and your
4380548738b4SHeiko Schocher	  EEPROM, which holds the environment, is on the I2C bus.
4381548738b4SHeiko Schocher
4382548738b4SHeiko Schocher	- CONFIG_I2C_ENV_EEPROM_BUS
4383548738b4SHeiko Schocher	  if you have an Environment on an EEPROM reached over
4384548738b4SHeiko Schocher	  I2C muxes, you can define here, how to reach this
4385548738b4SHeiko Schocher	  EEPROM. For example:
4386548738b4SHeiko Schocher
4387ea818dbbSHeiko Schocher	  #define CONFIG_I2C_ENV_EEPROM_BUS	  1
4388548738b4SHeiko Schocher
4389548738b4SHeiko Schocher	  EEPROM which holds the environment, is reached over
4390548738b4SHeiko Schocher	  a pca9547 i2c mux with address 0x70, channel 3.
4391c609719bSwdenk
4392057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH:
43935779d8d9Swdenk
43945779d8d9Swdenk	Define this if you have a DataFlash memory device which you
43955779d8d9Swdenk	want to use for the environment.
43965779d8d9Swdenk
43970e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
43980e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
43990e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
44005779d8d9Swdenk
44015779d8d9Swdenk	  These three #defines specify the offset and size of the
44025779d8d9Swdenk	  environment area within the total memory of your DataFlash placed
44035779d8d9Swdenk	  at the specified address.
44045779d8d9Swdenk
4405bd83b592SWu, Josh- CONFIG_ENV_IS_IN_SPI_FLASH:
4406bd83b592SWu, Josh
4407bd83b592SWu, Josh	Define this if you have a SPI Flash memory device which you
4408bd83b592SWu, Josh	want to use for the environment.
4409bd83b592SWu, Josh
4410bd83b592SWu, Josh	- CONFIG_ENV_OFFSET:
4411bd83b592SWu, Josh	- CONFIG_ENV_SIZE:
4412bd83b592SWu, Josh
4413bd83b592SWu, Josh	  These two #defines specify the offset and size of the
4414bd83b592SWu, Josh	  environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
4415bd83b592SWu, Josh	  aligned to an erase sector boundary.
4416bd83b592SWu, Josh
4417bd83b592SWu, Josh	- CONFIG_ENV_SECT_SIZE:
4418bd83b592SWu, Josh
4419bd83b592SWu, Josh	  Define the SPI flash's sector size.
4420bd83b592SWu, Josh
4421bd83b592SWu, Josh	- CONFIG_ENV_OFFSET_REDUND (optional):
4422bd83b592SWu, Josh
4423bd83b592SWu, Josh	  This setting describes a second storage area of CONFIG_ENV_SIZE
4424bd83b592SWu, Josh	  size used to hold a redundant copy of the environment data, so
4425bd83b592SWu, Josh	  that there is a valid backup copy in case there is a power failure
4426bd83b592SWu, Josh	  during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
4427bd83b592SWu, Josh	  aligned to an erase sector boundary.
4428bd83b592SWu, Josh
4429bd83b592SWu, Josh	- CONFIG_ENV_SPI_BUS (optional):
4430bd83b592SWu, Josh	- CONFIG_ENV_SPI_CS (optional):
4431bd83b592SWu, Josh
4432bd83b592SWu, Josh	  Define the SPI bus and chip select. If not defined they will be 0.
4433bd83b592SWu, Josh
4434bd83b592SWu, Josh	- CONFIG_ENV_SPI_MAX_HZ (optional):
4435bd83b592SWu, Josh
4436bd83b592SWu, Josh	  Define the SPI max work clock. If not defined then use 1MHz.
4437bd83b592SWu, Josh
4438bd83b592SWu, Josh	- CONFIG_ENV_SPI_MODE (optional):
4439bd83b592SWu, Josh
4440bd83b592SWu, Josh	  Define the SPI work mode. If not defined then use SPI_MODE_3.
4441bd83b592SWu, Josh
44420a85a9e7SLiu Gang- CONFIG_ENV_IS_IN_REMOTE:
44430a85a9e7SLiu Gang
44440a85a9e7SLiu Gang	Define this if you have a remote memory space which you
44450a85a9e7SLiu Gang	want to use for the local device's environment.
44460a85a9e7SLiu Gang
44470a85a9e7SLiu Gang	- CONFIG_ENV_ADDR:
44480a85a9e7SLiu Gang	- CONFIG_ENV_SIZE:
44490a85a9e7SLiu Gang
44500a85a9e7SLiu Gang	  These two #defines specify the address and size of the
44510a85a9e7SLiu Gang	  environment area within the remote memory space. The
44520a85a9e7SLiu Gang	  local device can get the environment from remote memory
4453fc54c7faSLiu Gang	  space by SRIO or PCIE links.
44540a85a9e7SLiu Gang
44550a85a9e7SLiu GangBE CAREFUL! For some special cases, the local device can not use
44560a85a9e7SLiu Gang"saveenv" command. For example, the local device will get the
4457fc54c7faSLiu Gangenvironment stored in a remote NOR flash by SRIO or PCIE link,
4458fc54c7faSLiu Gangbut it can not erase, write this NOR flash by SRIO or PCIE interface.
44590a85a9e7SLiu Gang
446051bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND:
446113a5695bSwdenk
446213a5695bSwdenk	Define this if you have a NAND device which you want to use
446313a5695bSwdenk	for the environment.
446413a5695bSwdenk
44650e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
44660e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
446713a5695bSwdenk
446813a5695bSwdenk	  These two #defines specify the offset and size of the environment
4469fdd813deSScott Wood	  area within the first NAND device.  CONFIG_ENV_OFFSET must be
4470fdd813deSScott Wood	  aligned to an erase block boundary.
44715779d8d9Swdenk
4472fdd813deSScott Wood	- CONFIG_ENV_OFFSET_REDUND (optional):
4473e443c944SMarkus Klotzbuecher
44740e8d1586SJean-Christophe PLAGNIOL-VILLARD	  This setting describes a second storage area of CONFIG_ENV_SIZE
4475fdd813deSScott Wood	  size used to hold a redundant copy of the environment data, so
4476fdd813deSScott Wood	  that there is a valid backup copy in case there is a power failure
4477fdd813deSScott Wood	  during a "saveenv" operation.	 CONFIG_ENV_OFFSET_RENDUND must be
4478fdd813deSScott Wood	  aligned to an erase block boundary.
4479e443c944SMarkus Klotzbuecher
4480fdd813deSScott Wood	- CONFIG_ENV_RANGE (optional):
4481fdd813deSScott Wood
4482fdd813deSScott Wood	  Specifies the length of the region in which the environment
4483fdd813deSScott Wood	  can be written.  This should be a multiple of the NAND device's
4484fdd813deSScott Wood	  block size.  Specifying a range with more erase blocks than
4485fdd813deSScott Wood	  are needed to hold CONFIG_ENV_SIZE allows bad blocks within
4486fdd813deSScott Wood	  the range to be avoided.
4487fdd813deSScott Wood
4488fdd813deSScott Wood	- CONFIG_ENV_OFFSET_OOB (optional):
4489fdd813deSScott Wood
4490fdd813deSScott Wood	  Enables support for dynamically retrieving the offset of the
4491fdd813deSScott Wood	  environment from block zero's out-of-band data.  The
4492fdd813deSScott Wood	  "nand env.oob" command can be used to record this offset.
4493fdd813deSScott Wood	  Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
4494fdd813deSScott Wood	  using CONFIG_ENV_OFFSET_OOB.
4495e443c944SMarkus Klotzbuecher
4496b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST
4497b74ab737SGuennadi Liakhovetski
4498b74ab737SGuennadi Liakhovetski	Defines address in RAM to which the nand_spl code should copy the
4499b74ab737SGuennadi Liakhovetski	environment. If redundant environment is used, it will be copied to
4500b74ab737SGuennadi Liakhovetski	CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
4501b74ab737SGuennadi Liakhovetski
45022b74433fSJoe Hershberger- CONFIG_ENV_IS_IN_UBI:
45032b74433fSJoe Hershberger
45042b74433fSJoe Hershberger	Define this if you have an UBI volume that you want to use for the
45052b74433fSJoe Hershberger	environment.  This has the benefit of wear-leveling the environment
45062b74433fSJoe Hershberger	accesses, which is important on NAND.
45072b74433fSJoe Hershberger
45082b74433fSJoe Hershberger	- CONFIG_ENV_UBI_PART:
45092b74433fSJoe Hershberger
45102b74433fSJoe Hershberger	  Define this to a string that is the mtd partition containing the UBI.
45112b74433fSJoe Hershberger
45122b74433fSJoe Hershberger	- CONFIG_ENV_UBI_VOLUME:
45132b74433fSJoe Hershberger
45142b74433fSJoe Hershberger	  Define this to the name of the volume that you want to store the
45152b74433fSJoe Hershberger	  environment in.
45162b74433fSJoe Hershberger
4517785881f7SJoe Hershberger	- CONFIG_ENV_UBI_VOLUME_REDUND:
4518785881f7SJoe Hershberger
4519785881f7SJoe Hershberger	  Define this to the name of another volume to store a second copy of
4520785881f7SJoe Hershberger	  the environment in.  This will enable redundant environments in UBI.
4521785881f7SJoe Hershberger	  It is assumed that both volumes are in the same MTD partition.
4522785881f7SJoe Hershberger
45232b74433fSJoe Hershberger	- CONFIG_UBI_SILENCE_MSG
45242b74433fSJoe Hershberger	- CONFIG_UBIFS_SILENCE_MSG
45252b74433fSJoe Hershberger
45262b74433fSJoe Hershberger	  You will probably want to define these to avoid a really noisy system
45272b74433fSJoe Hershberger	  when storing the env in UBI.
45282b74433fSJoe Hershberger
4529d1db76f1SWu, Josh- CONFIG_ENV_IS_IN_FAT:
4530d1db76f1SWu, Josh       Define this if you want to use the FAT file system for the environment.
4531d1db76f1SWu, Josh
4532d1db76f1SWu, Josh       - FAT_ENV_INTERFACE:
4533d1db76f1SWu, Josh
4534d1db76f1SWu, Josh         Define this to a string that is the name of the block device.
4535d1db76f1SWu, Josh
4536d1db76f1SWu, Josh       - FAT_ENV_DEV_AND_PART:
4537d1db76f1SWu, Josh
4538d1db76f1SWu, Josh         Define this to a string to specify the partition of the device. It can
4539d1db76f1SWu, Josh         be as following:
4540d1db76f1SWu, Josh
4541d1db76f1SWu, Josh           "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
4542d1db76f1SWu, Josh               - "D:P": device D partition P. Error occurs if device D has no
4543d1db76f1SWu, Josh                        partition table.
4544d1db76f1SWu, Josh               - "D:0": device D.
4545d1db76f1SWu, Josh               - "D" or "D:": device D partition 1 if device D has partition
4546d1db76f1SWu, Josh                              table, or the whole device D if has no partition
4547d1db76f1SWu, Josh                              table.
4548d1db76f1SWu, Josh               - "D:auto": first partition in device D with bootable flag set.
4549b445bbb4SJeremiah Mahler                           If none, first valid partition in device D. If no
4550d1db76f1SWu, Josh                           partition table then means device D.
4551d1db76f1SWu, Josh
4552d1db76f1SWu, Josh       - FAT_ENV_FILE:
4553d1db76f1SWu, Josh
4554d1db76f1SWu, Josh         It's a string of the FAT file name. This file use to store the
4555b445bbb4SJeremiah Mahler         environment.
4556d1db76f1SWu, Josh
4557d1db76f1SWu, Josh       - CONFIG_FAT_WRITE:
4558b445bbb4SJeremiah Mahler         This should be defined. Otherwise it cannot save the environment file.
4559d1db76f1SWu, Josh
456006e4ae5fSStephen Warren- CONFIG_ENV_IS_IN_MMC:
456106e4ae5fSStephen Warren
456206e4ae5fSStephen Warren	Define this if you have an MMC device which you want to use for the
456306e4ae5fSStephen Warren	environment.
456406e4ae5fSStephen Warren
456506e4ae5fSStephen Warren	- CONFIG_SYS_MMC_ENV_DEV:
456606e4ae5fSStephen Warren
456706e4ae5fSStephen Warren	  Specifies which MMC device the environment is stored in.
456806e4ae5fSStephen Warren
456906e4ae5fSStephen Warren	- CONFIG_SYS_MMC_ENV_PART (optional):
457006e4ae5fSStephen Warren
457106e4ae5fSStephen Warren	  Specifies which MMC partition the environment is stored in. If not
457206e4ae5fSStephen Warren	  set, defaults to partition 0, the user area. Common values might be
457306e4ae5fSStephen Warren	  1 (first MMC boot partition), 2 (second MMC boot partition).
457406e4ae5fSStephen Warren
457506e4ae5fSStephen Warren	- CONFIG_ENV_OFFSET:
457606e4ae5fSStephen Warren	- CONFIG_ENV_SIZE:
457706e4ae5fSStephen Warren
457806e4ae5fSStephen Warren	  These two #defines specify the offset and size of the environment
457906e4ae5fSStephen Warren	  area within the specified MMC device.
458006e4ae5fSStephen Warren
45815c088ee8SStephen Warren	  If offset is positive (the usual case), it is treated as relative to
45825c088ee8SStephen Warren	  the start of the MMC partition. If offset is negative, it is treated
45835c088ee8SStephen Warren	  as relative to the end of the MMC partition. This can be useful if
45845c088ee8SStephen Warren	  your board may be fitted with different MMC devices, which have
45855c088ee8SStephen Warren	  different sizes for the MMC partitions, and you always want the
45865c088ee8SStephen Warren	  environment placed at the very end of the partition, to leave the
45875c088ee8SStephen Warren	  maximum possible space before it, to store other data.
45885c088ee8SStephen Warren
458906e4ae5fSStephen Warren	  These two values are in units of bytes, but must be aligned to an
459006e4ae5fSStephen Warren	  MMC sector boundary.
459106e4ae5fSStephen Warren
459206e4ae5fSStephen Warren	- CONFIG_ENV_OFFSET_REDUND (optional):
459306e4ae5fSStephen Warren
459406e4ae5fSStephen Warren	  Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
459506e4ae5fSStephen Warren	  hold a redundant copy of the environment data. This provides a
459606e4ae5fSStephen Warren	  valid backup copy in case the other copy is corrupted, e.g. due
459706e4ae5fSStephen Warren	  to a power failure during a "saveenv" operation.
459806e4ae5fSStephen Warren
45995c088ee8SStephen Warren	  This value may also be positive or negative; this is handled in the
46005c088ee8SStephen Warren	  same way as CONFIG_ENV_OFFSET.
46015c088ee8SStephen Warren
460206e4ae5fSStephen Warren	  This value is also in units of bytes, but must also be aligned to
460306e4ae5fSStephen Warren	  an MMC sector boundary.
460406e4ae5fSStephen Warren
460506e4ae5fSStephen Warren	- CONFIG_ENV_SIZE_REDUND (optional):
460606e4ae5fSStephen Warren
460706e4ae5fSStephen Warren	  This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
460806e4ae5fSStephen Warren	  set. If this value is set, it must be set to the same value as
460906e4ae5fSStephen Warren	  CONFIG_ENV_SIZE.
461006e4ae5fSStephen Warren
46116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET
4612c609719bSwdenk
4613c609719bSwdenk	Defines offset to the initial SPI buffer area in DPRAM. The
4614c609719bSwdenk	area is used at an early stage (ROM part) if the environment
4615c609719bSwdenk	is configured to reside in the SPI EEPROM: We need a 520 byte
4616c609719bSwdenk	scratch DPRAM area. It is used between the two initialization
4617c609719bSwdenk	calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4618c609719bSwdenk	to be a good choice since it makes it far enough from the
4619c609719bSwdenk	start of the data area as well as from the stack pointer.
4620c609719bSwdenk
4621e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor
4622c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been
4623cdb74977SWolfgang Denkcreated; also, when using EEPROM you will have to use getenv_f()
4624c609719bSwdenkuntil then to read environment variables.
4625c609719bSwdenk
462685ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor
462785ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working
462885ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is
462985ec0bccSwdenknecessary, because the first environment variable we need is the
463085ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't
463185ec0bccSwdenkhave any device yet where we could complain.]
4632c609719bSwdenk
4633c609719bSwdenkNote: once the monitor has been relocated, then it will complain if
4634c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you
463585ec0bccSwdenkuse the "saveenv" command to store a valid environment.
4636c609719bSwdenk
46376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
4638fc3e2165Swdenk		Echo the inverted Ethernet link state to the fault LED.
4639fc3e2165Swdenk
46406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
4641fc3e2165Swdenk		      also needs to be defined.
4642fc3e2165Swdenk
46436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR:
4644fc3e2165Swdenk		MII address of the PHY to check for the Ethernet link state.
4645c609719bSwdenk
4646f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS:
4647f5675aa5SRon Madrid		Define this if you desire to only have use of the NS16550_init
4648f5675aa5SRon Madrid		and NS16550_putc functions for the serial driver located at
4649f5675aa5SRon Madrid		drivers/serial/ns16550.c.  This option is useful for saving
4650f5675aa5SRon Madrid		space for already greatly restricted images, including but not
4651f5675aa5SRon Madrid		limited to NAND_SPL configurations.
4652f5675aa5SRon Madrid
4653b2b92f53SSimon Glass- CONFIG_DISPLAY_BOARDINFO
4654b2b92f53SSimon Glass		Display information about the board that U-Boot is running on
4655b2b92f53SSimon Glass		when U-Boot starts up. The board function checkboard() is called
4656b2b92f53SSimon Glass		to do this.
4657b2b92f53SSimon Glass
4658e2e3e2b1SSimon Glass- CONFIG_DISPLAY_BOARDINFO_LATE
4659e2e3e2b1SSimon Glass		Similar to the previous option, but display this information
4660e2e3e2b1SSimon Glass		later, once stdio is running and output goes to the LCD, if
4661e2e3e2b1SSimon Glass		present.
4662e2e3e2b1SSimon Glass
4663feb85801SSascha Silbe- CONFIG_BOARD_SIZE_LIMIT:
4664feb85801SSascha Silbe		Maximum size of the U-Boot image. When defined, the
4665feb85801SSascha Silbe		build system checks that the actual size does not
4666feb85801SSascha Silbe		exceed it.
4667feb85801SSascha Silbe
4668c609719bSwdenkLow Level (hardware related) configuration options:
4669dc7c9a1aSwdenk---------------------------------------------------
4670c609719bSwdenk
46716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE:
4672c609719bSwdenk		Cache Line Size of the CPU.
4673c609719bSwdenk
46746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR:
4675c609719bSwdenk		Default address of the IMMR after system reset.
46762535d602Swdenk
46772535d602Swdenk		Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
46782535d602Swdenk		and RPXsuper) to be able to adjust the position of
46792535d602Swdenk		the IMMR register after a reset.
4680c609719bSwdenk
4681e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_DEFAULT:
4682e46fedfeSTimur Tabi		Default (power-on reset) physical address of CCSR on Freescale
4683e46fedfeSTimur Tabi		PowerPC SOCs.
4684e46fedfeSTimur Tabi
4685e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR:
4686e46fedfeSTimur Tabi		Virtual address of CCSR.  On a 32-bit build, this is typically
4687e46fedfeSTimur Tabi		the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4688e46fedfeSTimur Tabi
4689e46fedfeSTimur Tabi		CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4690e46fedfeSTimur Tabi		for cross-platform code that uses that macro instead.
4691e46fedfeSTimur Tabi
4692e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS:
4693e46fedfeSTimur Tabi		Physical address of CCSR.  CCSR can be relocated to a new
4694e46fedfeSTimur Tabi		physical address, if desired.  In this case, this macro should
4695e46fedfeSTimur Tabi		be set to that address.	 Otherwise, it should be set to the
4696e46fedfeSTimur Tabi		same value as CONFIG_SYS_CCSRBAR_DEFAULT.  For example, CCSR
4697e46fedfeSTimur Tabi		is typically relocated on 36-bit builds.  It is recommended
4698e46fedfeSTimur Tabi		that this macro be defined via the _HIGH and _LOW macros:
4699e46fedfeSTimur Tabi
4700e46fedfeSTimur Tabi		#define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4701e46fedfeSTimur Tabi			* 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4702e46fedfeSTimur Tabi
4703e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
4704e46fedfeSTimur Tabi		Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS.	This value is typically
4705e46fedfeSTimur Tabi		either 0 (32-bit build) or 0xF (36-bit build).	This macro is
4706e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
4707e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
4708e46fedfeSTimur Tabi
4709e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4710e46fedfeSTimur Tabi		Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS.  This macro is
4711e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
4712e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
4713e46fedfeSTimur Tabi
4714e46fedfeSTimur Tabi- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4715e46fedfeSTimur Tabi		If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4716e46fedfeSTimur Tabi		forced to a value that ensures that CCSR is not relocated.
4717e46fedfeSTimur Tabi
47187f6c2cbcSwdenk- Floppy Disk Support:
47196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER
47207f6c2cbcSwdenk
47217f6c2cbcSwdenk		the default drive number (default value 0)
47227f6c2cbcSwdenk
47236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_STRIDE
47247f6c2cbcSwdenk
472511ccc33fSMarcel Ziswiler		defines the spacing between FDC chipset registers
47267f6c2cbcSwdenk		(default value 1)
47277f6c2cbcSwdenk
47286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_OFFSET
47297f6c2cbcSwdenk
47307f6c2cbcSwdenk		defines the offset of register from address. It
47317f6c2cbcSwdenk		depends on which part of the data bus is connected to
473211ccc33fSMarcel Ziswiler		the FDC chipset. (default value 0)
47337f6c2cbcSwdenk
47346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
47356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
47367f6c2cbcSwdenk		default value.
47377f6c2cbcSwdenk
47386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		if CONFIG_SYS_FDC_HW_INIT is defined, then the function
47397f6c2cbcSwdenk		fdc_hw_init() is called at the beginning of the FDC
47407f6c2cbcSwdenk		setup. fdc_hw_init() must be provided by the board
4741b445bbb4SJeremiah Mahler		source code. It is used to make hardware-dependent
47427f6c2cbcSwdenk		initializations.
47437f6c2cbcSwdenk
47440abddf82SMacpaul Lin- CONFIG_IDE_AHB:
47450abddf82SMacpaul Lin		Most IDE controllers were designed to be connected with PCI
47460abddf82SMacpaul Lin		interface. Only few of them were designed for AHB interface.
47470abddf82SMacpaul Lin		When software is doing ATA command and data transfer to
47480abddf82SMacpaul Lin		IDE devices through IDE-AHB controller, some additional
47490abddf82SMacpaul Lin		registers accessing to these kind of IDE-AHB controller
4750b445bbb4SJeremiah Mahler		is required.
47510abddf82SMacpaul Lin
47526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR:	Physical address of the Internal Memory.
475325d6712aSwdenk		DO NOT CHANGE unless you know exactly what you're
475425d6712aSwdenk		doing! (11-4) [MPC8xx/82xx systems only]
4755c609719bSwdenk
47566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR:
4757c609719bSwdenk
47587152b1d0Swdenk		Start address of memory area that can be used for
4759c609719bSwdenk		initial data and stack; please note that this must be
4760c609719bSwdenk		writable memory that is working WITHOUT special
4761c609719bSwdenk		initialization, i. e. you CANNOT use normal RAM which
4762c609719bSwdenk		will become available only after programming the
4763c609719bSwdenk		memory controller and running certain initialization
4764c609719bSwdenk		sequences.
4765c609719bSwdenk
4766c609719bSwdenk		U-Boot uses the following memory types:
4767c609719bSwdenk		- MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4768c609719bSwdenk		- MPC824X: data cache
4769c609719bSwdenk		- PPC4xx:  data cache
4770c609719bSwdenk
47716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET:
4772c609719bSwdenk
4773c609719bSwdenk		Offset of the initial data structure in the memory
47746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
47756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
4776c609719bSwdenk		data is located at the end of the available space
4777553f0982SWolfgang Denk		(sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
47786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
47796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
47806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET) downward.
4781c609719bSwdenk
4782c609719bSwdenk	Note:
4783c609719bSwdenk		On the MPC824X (or other systems that use the data
4784c609719bSwdenk		cache for initial memory) the address chosen for
47856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
4786c609719bSwdenk		point to an otherwise UNUSED address space between
4787c609719bSwdenk		the top of RAM and the start of the PCI space.
4788c609719bSwdenk
47896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR:	SIU Module Configuration (11-6)
4790c609719bSwdenk
47916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR:	System Protection Control (11-9)
4792c609719bSwdenk
47936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR:	Time Base Status and Control (11-26)
4794c609719bSwdenk
47956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR:	Periodic Interrupt Status and Control (11-31)
4796c609719bSwdenk
47976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR:	PLL, Low-Power, and Reset Control Register (15-30)
4798c609719bSwdenk
47996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR:	System Clock and reset Control Register (15-27)
4800c609719bSwdenk
48016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM:
4802c609719bSwdenk		SDRAM timing
4803c609719bSwdenk
48046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA:
4805c609719bSwdenk		periodic timer for refresh
4806c609719bSwdenk
48076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER:	Debug Event Register (37-47)
4808c609719bSwdenk
48096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
48106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
48116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
48126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_BR1_PRELIM:
4813c609719bSwdenk		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4814c609719bSwdenk
4815c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
48166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
48176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
4818c609719bSwdenk		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4819c609719bSwdenk
48206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
48216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
4822c609719bSwdenk		Machine Mode Register and Memory Periodic Timer
4823c609719bSwdenk		Prescaler definitions (SDRAM timing)
4824c609719bSwdenk
48256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
4826c609719bSwdenk		enable I2C microcode relocation patch (MPC8xx);
4827c609719bSwdenk		define relocation offset in DPRAM [DSP2]
4828c609719bSwdenk
48296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
4830b423d055SHeiko Schocher		enable SMC microcode relocation patch (MPC8xx);
4831b423d055SHeiko Schocher		define relocation offset in DPRAM [SMC1]
4832b423d055SHeiko Schocher
48336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
4834c609719bSwdenk		enable SPI microcode relocation patch (MPC8xx);
4835c609719bSwdenk		define relocation offset in DPRAM [SCC4]
4836c609719bSwdenk
48376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_USE_OSCCLK:
4838c609719bSwdenk		Use OSCM clock mode on MBX8xx board. Be careful,
4839c609719bSwdenk		wrong setting might damage your board. Read
4840c609719bSwdenk		doc/README.MBX before setting this variable!
4841c609719bSwdenk
48426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
4843ea909b76Swdenk		Offset of the bootmode word in DPRAM used by post
4844ea909b76Swdenk		(Power On Self Tests). This definition overrides
4845ea909b76Swdenk		#define'd default value in commproc.h resp.
4846ea909b76Swdenk		cpm_8260.h.
4847ea909b76Swdenk
48486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
48496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
48506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
48516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
48526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
48536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
48546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
48556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
4856a47a12beSStefan Roese		Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
48575d232d0eSwdenk
48589cacf4fcSDirk Eibach- CONFIG_PCI_DISABLE_PCIE:
48599cacf4fcSDirk Eibach		Disable PCI-Express on systems where it is supported but not
48609cacf4fcSDirk Eibach		required.
48619cacf4fcSDirk Eibach
486269fd2d3bSAndrew Sharp- CONFIG_PCI_ENUM_ONLY
4863b445bbb4SJeremiah Mahler		Only scan through and get the devices on the buses.
486469fd2d3bSAndrew Sharp		Don't do any setup work, presumably because someone or
486569fd2d3bSAndrew Sharp		something has already done it, and we don't need to do it
486669fd2d3bSAndrew Sharp		a second time.	Useful for platforms that are pre-booted
486769fd2d3bSAndrew Sharp		by coreboot or similar.
486869fd2d3bSAndrew Sharp
4869842033e6SGabor Juhos- CONFIG_PCI_INDIRECT_BRIDGE:
4870842033e6SGabor Juhos		Enable support for indirect PCI bridges.
4871842033e6SGabor Juhos
4872a09b9b68SKumar Gala- CONFIG_SYS_SRIO:
4873a09b9b68SKumar Gala		Chip has SRIO or not
4874a09b9b68SKumar Gala
4875a09b9b68SKumar Gala- CONFIG_SRIO1:
4876a09b9b68SKumar Gala		Board has SRIO 1 port available
4877a09b9b68SKumar Gala
4878a09b9b68SKumar Gala- CONFIG_SRIO2:
4879a09b9b68SKumar Gala		Board has SRIO 2 port available
4880a09b9b68SKumar Gala
4881c8b28152SLiu Gang- CONFIG_SRIO_PCIE_BOOT_MASTER
4882c8b28152SLiu Gang		Board can support master function for Boot from SRIO and PCIE
4883c8b28152SLiu Gang
4884a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_VIRT:
4885a09b9b68SKumar Gala		Virtual Address of SRIO port 'n' memory region
4886a09b9b68SKumar Gala
4887a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_PHYS:
4888a09b9b68SKumar Gala		Physical Address of SRIO port 'n' memory region
4889a09b9b68SKumar Gala
4890a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_SIZE:
4891a09b9b68SKumar Gala		Size of SRIO port 'n' memory region
4892a09b9b68SKumar Gala
489366bd1846SFabio Estevam- CONFIG_SYS_NAND_BUSWIDTH_16BIT
489466bd1846SFabio Estevam		Defined to tell the NAND controller that the NAND chip is using
489566bd1846SFabio Estevam		a 16 bit bus.
489666bd1846SFabio Estevam		Not all NAND drivers use this symbol.
4897a430e916SFabio Estevam		Example of drivers that use it:
489866bd1846SFabio Estevam		- drivers/mtd/nand/ndfc.c
4899a430e916SFabio Estevam		- drivers/mtd/nand/mxc_nand.c
4900eced4626SAlex Waterman
4901eced4626SAlex Waterman- CONFIG_SYS_NDFC_EBC0_CFG
4902eced4626SAlex Waterman		Sets the EBC0_CFG register for the NDFC. If not defined
4903eced4626SAlex Waterman		a default value will be used.
4904eced4626SAlex Waterman
4905bb99ad6dSBen Warren- CONFIG_SPD_EEPROM
4906218ca724SWolfgang Denk		Get DDR timing information from an I2C EEPROM. Common
4907218ca724SWolfgang Denk		with pluggable memory modules such as SODIMMs
4908218ca724SWolfgang Denk
4909bb99ad6dSBen Warren  SPD_EEPROM_ADDRESS
4910bb99ad6dSBen Warren		I2C address of the SPD EEPROM
4911bb99ad6dSBen Warren
49126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM
4913218ca724SWolfgang Denk		If SPD EEPROM is on an I2C bus other than the first
4914218ca724SWolfgang Denk		one, specify here. Note that the value must resolve
4915218ca724SWolfgang Denk		to something your driver can deal with.
4916bb99ad6dSBen Warren
49171b3e3c4fSYork Sun- CONFIG_SYS_DDR_RAW_TIMING
49181b3e3c4fSYork Sun		Get DDR timing information from other than SPD. Common with
49191b3e3c4fSYork Sun		soldered DDR chips onboard without SPD. DDR raw timing
49201b3e3c4fSYork Sun		parameters are extracted from datasheet and hard-coded into
49211b3e3c4fSYork Sun		header files or board specific files.
49221b3e3c4fSYork Sun
49236f5e1dc5SYork Sun- CONFIG_FSL_DDR_INTERACTIVE
49246f5e1dc5SYork Sun		Enable interactive DDR debugging. See doc/README.fsl-ddr.
49256f5e1dc5SYork Sun
49266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0
4927218ca724SWolfgang Denk		Only for 83xx systems. If specified, then DDR should
4928218ca724SWolfgang Denk		be configured using CS0 and CS1 instead of CS2 and CS3.
49292ad6b513STimur Tabi
4930c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12]
4931c26e454dSwdenk		Define to enable FEC[12] on a 8xx series processor.
4932c26e454dSwdenk
4933c26e454dSwdenk- CONFIG_FEC[12]_PHY
4934c26e454dSwdenk		Define to the hardcoded PHY address which corresponds
49356e592385Swdenk		to the given FEC; i. e.
4936c26e454dSwdenk			#define CONFIG_FEC1_PHY 4
4937c26e454dSwdenk		means that the PHY with address 4 is connected to FEC1
4938c26e454dSwdenk
4939c26e454dSwdenk		When set to -1, means to probe for first available.
4940c26e454dSwdenk
4941c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR
4942c26e454dSwdenk		The PHY does not have a RXERR line (RMII only).
4943c26e454dSwdenk		(so program the FEC to ignore it).
4944c26e454dSwdenk
4945c26e454dSwdenk- CONFIG_RMII
4946c26e454dSwdenk		Enable RMII mode for all FECs.
4947c26e454dSwdenk		Note that this is a global option, we can't
4948c26e454dSwdenk		have one FEC in standard MII mode and another in RMII mode.
4949c26e454dSwdenk
49505cf91d6bSwdenk- CONFIG_CRC32_VERIFY
49515cf91d6bSwdenk		Add a verify option to the crc32 command.
49525cf91d6bSwdenk		The syntax is:
49535cf91d6bSwdenk
49545cf91d6bSwdenk		=> crc32 -v <address> <count> <crc32>
49555cf91d6bSwdenk
49565cf91d6bSwdenk		Where address/count indicate a memory area
49575cf91d6bSwdenk		and crc32 is the correct crc32 which the
49585cf91d6bSwdenk		area should have.
49595cf91d6bSwdenk
496056523f12Swdenk- CONFIG_LOOPW
496156523f12Swdenk		Add the "loopw" memory command. This only takes effect if
4962602ad3b3SJon Loeliger		the memory commands are activated globally (CONFIG_CMD_MEM).
496356523f12Swdenk
49647b466641Sstroese- CONFIG_MX_CYCLIC
49657b466641Sstroese		Add the "mdc" and "mwc" memory commands. These are cyclic
49667b466641Sstroese		"md/mw" commands.
49677b466641Sstroese		Examples:
49687b466641Sstroese
49697b466641Sstroese		=> mdc.b 10 4 500
49707b466641Sstroese		This command will print 4 bytes (10,11,12,13) each 500 ms.
49717b466641Sstroese
49727b466641Sstroese		=> mwc.l 100 12345678 10
49737b466641Sstroese		This command will write 12345678 to address 100 all 10 ms.
49747b466641Sstroese
49757b466641Sstroese		This only takes effect if the memory commands are activated
4976602ad3b3SJon Loeliger		globally (CONFIG_CMD_MEM).
49777b466641Sstroese
49788aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT
4979afc1ce82SMacpaul Lin		[ARM, NDS32, MIPS only] If this variable is defined, then certain
4980e03f3169SWolfgang Denk		low level initializations (like setting up the memory
4981e03f3169SWolfgang Denk		controller) are omitted and/or U-Boot does not
4982e03f3169SWolfgang Denk		relocate itself into RAM.
49838aa1a2d1Swdenk
4984e03f3169SWolfgang Denk		Normally this variable MUST NOT be defined. The only
4985e03f3169SWolfgang Denk		exception is when U-Boot is loaded (to RAM) by some
4986e03f3169SWolfgang Denk		other boot loader or by a debugger which performs
4987e03f3169SWolfgang Denk		these initializations itself.
49888aa1a2d1Swdenk
4989401bb30bSAneesh V- CONFIG_SPL_BUILD
4990df81238bSMagnus Lilja		Modifies the behaviour of start.S when compiling a loader
4991df81238bSMagnus Lilja		that is executed before the actual U-Boot. E.g. when
4992df81238bSMagnus Lilja		compiling a NAND SPL.
4993400558b5Swdenk
49943aa29de0SYing Zhang- CONFIG_TPL_BUILD
49953aa29de0SYing Zhang		Modifies the behaviour of start.S  when compiling a loader
49963aa29de0SYing Zhang		that is executed after the SPL and before the actual U-Boot.
49973aa29de0SYing Zhang		It is loaded by the SPL.
49983aa29de0SYing Zhang
49995df572f0SYing Zhang- CONFIG_SYS_MPC85XX_NO_RESETVEC
50005df572f0SYing Zhang		Only for 85xx systems. If this variable is specified, the section
50015df572f0SYing Zhang		.resetvec is not kept and the section .bootpg is placed in the
50025df572f0SYing Zhang		previous 4k of the .text section.
50035df572f0SYing Zhang
50044213fc29SSimon Glass- CONFIG_ARCH_MAP_SYSMEM
50054213fc29SSimon Glass		Generally U-Boot (and in particular the md command) uses
50064213fc29SSimon Glass		effective address. It is therefore not necessary to regard
50074213fc29SSimon Glass		U-Boot address as virtual addresses that need to be translated
50084213fc29SSimon Glass		to physical addresses. However, sandbox requires this, since
50094213fc29SSimon Glass		it maintains its own little RAM buffer which contains all
50104213fc29SSimon Glass		addressable memory. This option causes some memory accesses
50114213fc29SSimon Glass		to be mapped through map_sysmem() / unmap_sysmem().
50124213fc29SSimon Glass
5013d8834a13SMatthias Weisser- CONFIG_USE_ARCH_MEMCPY
5014d8834a13SMatthias Weisser  CONFIG_USE_ARCH_MEMSET
5015d8834a13SMatthias Weisser		If these options are used a optimized version of memcpy/memset will
5016d8834a13SMatthias Weisser		be used if available. These functions may be faster under some
5017d8834a13SMatthias Weisser		conditions but may increase the binary size.
5018d8834a13SMatthias Weisser
5019588a13f7SSimon Glass- CONFIG_X86_RESET_VECTOR
5020588a13f7SSimon Glass		If defined, the x86 reset vector code is included. This is not
5021588a13f7SSimon Glass		needed when U-Boot is running from Coreboot.
5022b16f521aSGabe Black
5023fc33705eSMark Jackson- CONFIG_SYS_MPUCLK
5024fc33705eSMark Jackson		Defines the MPU clock speed (in MHz).
5025fc33705eSMark Jackson
5026fc33705eSMark Jackson		NOTE : currently only supported on AM335x platforms.
50275b5ece9eSGabe Black
502816678eb4SHeiko Schocher- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
502916678eb4SHeiko Schocher		Enables the RTC32K OSC on AM33xx based plattforms
503016678eb4SHeiko Schocher
5031999d7d32SKaricheri, Muralidharan- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
5032999d7d32SKaricheri, Muralidharan		Option to disable subpage write in NAND driver
5033999d7d32SKaricheri, Muralidharan		driver that uses this:
5034999d7d32SKaricheri, Muralidharan		drivers/mtd/nand/davinci_nand.c
5035999d7d32SKaricheri, Muralidharan
5036f2717b47STimur TabiFreescale QE/FMAN Firmware Support:
5037f2717b47STimur Tabi-----------------------------------
5038f2717b47STimur Tabi
5039f2717b47STimur TabiThe Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
5040f2717b47STimur Tabiloading of "firmware", which is encoded in the QE firmware binary format.
5041f2717b47STimur TabiThis firmware often needs to be loaded during U-Boot booting, so macros
5042f2717b47STimur Tabiare used to identify the storage device (NOR flash, SPI, etc) and the address
5043f2717b47STimur Tabiwithin that device.
5044f2717b47STimur Tabi
5045dcf1d774SZhao Qiang- CONFIG_SYS_FMAN_FW_ADDR
5046dcf1d774SZhao Qiang	The address in the storage device where the FMAN microcode is located.  The
5047dcf1d774SZhao Qiang	meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
5048dcf1d774SZhao Qiang	is also specified.
5049dcf1d774SZhao Qiang
5050dcf1d774SZhao Qiang- CONFIG_SYS_QE_FW_ADDR
5051dcf1d774SZhao Qiang	The address in the storage device where the QE microcode is located.  The
5052f2717b47STimur Tabi	meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
5053f2717b47STimur Tabi	is also specified.
5054f2717b47STimur Tabi
5055f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_LENGTH
5056f2717b47STimur Tabi	The maximum possible size of the firmware.  The firmware binary format
5057f2717b47STimur Tabi	has a field that specifies the actual size of the firmware, but it
5058f2717b47STimur Tabi	might not be possible to read any part of the firmware unless some
5059f2717b47STimur Tabi	local storage is allocated to hold the entire firmware first.
5060f2717b47STimur Tabi
5061f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NOR
5062f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NOR flash, mapped as
5063f2717b47STimur Tabi	normal addressable memory via the LBC.  CONFIG_SYS_FMAN_FW_ADDR is the
5064f2717b47STimur Tabi	virtual address in NOR flash.
5065f2717b47STimur Tabi
5066f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NAND
5067f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NAND flash.
5068f2717b47STimur Tabi	CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
5069f2717b47STimur Tabi
5070f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_MMC
5071f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SD/MMC
5072f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
5073f2717b47STimur Tabi
5074f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
5075f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SPI
5076f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
5077f2717b47STimur Tabi
5078292dc6c5SLiu Gang- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
5079292dc6c5SLiu Gang	Specifies that QE/FMAN firmware is located in the remote (master)
5080292dc6c5SLiu Gang	memory space.	CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
5081fc54c7faSLiu Gang	can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
5082fc54c7faSLiu Gang	window->master inbound window->master LAW->the ucode address in
5083fc54c7faSLiu Gang	master's memory space.
5084f2717b47STimur Tabi
5085b940ca64SJ. German RiveraFreescale Layerscape Management Complex Firmware Support:
5086b940ca64SJ. German Rivera---------------------------------------------------------
5087b940ca64SJ. German RiveraThe Freescale Layerscape Management Complex (MC) supports the loading of
5088b940ca64SJ. German Rivera"firmware".
5089b940ca64SJ. German RiveraThis firmware often needs to be loaded during U-Boot booting, so macros
5090b940ca64SJ. German Riveraare used to identify the storage device (NOR flash, SPI, etc) and the address
5091b940ca64SJ. German Riverawithin that device.
5092b940ca64SJ. German Rivera
5093b940ca64SJ. German Rivera- CONFIG_FSL_MC_ENET
5094b940ca64SJ. German Rivera	Enable the MC driver for Layerscape SoCs.
5095b940ca64SJ. German Rivera
5096b940ca64SJ. German Rivera- CONFIG_SYS_LS_MC_FW_ADDR
5097b940ca64SJ. German Rivera	The address in the storage device where the firmware is located.  The
5098b940ca64SJ. German Rivera	meaning of this address depends on which CONFIG_SYS_LS_MC_FW_IN_xxx macro
5099b940ca64SJ. German Rivera	is also specified.
5100b940ca64SJ. German Rivera
5101b940ca64SJ. German Rivera- CONFIG_SYS_LS_MC_FW_LENGTH
5102b940ca64SJ. German Rivera	The maximum possible size of the firmware.  The firmware binary format
5103b940ca64SJ. German Rivera	has a field that specifies the actual size of the firmware, but it
5104b940ca64SJ. German Rivera	might not be possible to read any part of the firmware unless some
5105b940ca64SJ. German Rivera	local storage is allocated to hold the entire firmware first.
5106b940ca64SJ. German Rivera
5107b940ca64SJ. German Rivera- CONFIG_SYS_LS_MC_FW_IN_NOR
5108b940ca64SJ. German Rivera	Specifies that MC firmware is located in NOR flash, mapped as
5109b940ca64SJ. German Rivera	normal addressable memory via the LBC. CONFIG_SYS_LS_MC_FW_ADDR is the
5110b940ca64SJ. German Rivera	virtual address in NOR flash.
5111b940ca64SJ. German Rivera
5112c609719bSwdenkBuilding the Software:
5113c609719bSwdenk======================
5114c609719bSwdenk
5115218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments
5116218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support
5117218ca724SWolfgang Denkall possibly existing versions of cross development tools in all
5118218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we
5119218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
5120218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot.
5121c609719bSwdenk
5122218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you
5123218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case,
5124218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell.
5125218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are
5126218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter:
5127c609719bSwdenk
5128218ca724SWolfgang Denk	$ CROSS_COMPILE=ppc_4xx-
5129218ca724SWolfgang Denk	$ export CROSS_COMPILE
5130c609719bSwdenk
51312f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in
51322f8d396bSPeter Tyser      the tools directory you can use the MinGW toolchain
51332f8d396bSPeter Tyser      (http://www.mingw.org).  Set your HOST tools to the MinGW
51342f8d396bSPeter Tyser      toolchain and execute 'make tools'.  For example:
51352f8d396bSPeter Tyser
51362f8d396bSPeter Tyser       $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
51372f8d396bSPeter Tyser
51382f8d396bSPeter Tyser      Binaries such as tools/mkimage.exe will be created which can
51392f8d396bSPeter Tyser      be executed on computers running Windows.
51402f8d396bSPeter Tyser
5141c609719bSwdenkU-Boot is intended to be simple to build. After installing the
5142c609719bSwdenksources you must configure U-Boot for one specific board type. This
5143c609719bSwdenkis done by typing:
5144c609719bSwdenk
5145ab584d67SHolger Freyther	make NAME_defconfig
5146c609719bSwdenk
5147ab584d67SHolger Freytherwhere "NAME_defconfig" is the name of one of the existing configu-
51484d675ae6SMichael Jonesrations; see boards.cfg for supported names.
514954387ac9Swdenk
5150c609719bSwdenkNote: for some board special configuration names may exist; check if
5151c609719bSwdenk      additional information is available from the board vendor; for
51522729af9dSwdenk      instance, the TQM823L systems are available without (standard)
51532729af9dSwdenk      or with LCD support. You can select such additional "features"
515411ccc33fSMarcel Ziswiler      when choosing the configuration, i. e.
5155c609719bSwdenk
5156ab584d67SHolger Freyther      make TQM823L_defconfig
51572729af9dSwdenk	- will configure for a plain TQM823L, i. e. no LCD support
5158c609719bSwdenk
5159ab584d67SHolger Freyther      make TQM823L_LCD_defconfig
5160c609719bSwdenk	- will configure for a TQM823L with U-Boot console on LCD
5161c609719bSwdenk
5162c609719bSwdenk      etc.
5163c609719bSwdenk
5164c609719bSwdenk
5165c609719bSwdenkFinally, type "make all", and you should get some working U-Boot
51667152b1d0Swdenkimages ready for download to / installation on your system:
5167c609719bSwdenk
5168c609719bSwdenk- "u-boot.bin" is a raw binary image
5169c609719bSwdenk- "u-boot" is an image in ELF binary format
5170c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format
5171c609719bSwdenk
5172baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved
5173baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change
5174baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory:
5175baf31249SMarian Balakowicz
5176baf31249SMarian Balakowicz1. Add O= to the make command line invocations:
5177baf31249SMarian Balakowicz
5178baf31249SMarian Balakowicz	make O=/tmp/build distclean
5179ab584d67SHolger Freyther	make O=/tmp/build NAME_defconfig
5180baf31249SMarian Balakowicz	make O=/tmp/build all
5181baf31249SMarian Balakowicz
5182adbba996STimo Ketola2. Set environment variable KBUILD_OUTPUT to point to the desired location:
5183baf31249SMarian Balakowicz
5184adbba996STimo Ketola	export KBUILD_OUTPUT=/tmp/build
5185baf31249SMarian Balakowicz	make distclean
5186ab584d67SHolger Freyther	make NAME_defconfig
5187baf31249SMarian Balakowicz	make all
5188baf31249SMarian Balakowicz
5189adbba996STimo KetolaNote that the command line "O=" setting overrides the KBUILD_OUTPUT environment
5190baf31249SMarian Balakowiczvariable.
5191baf31249SMarian Balakowicz
5192c609719bSwdenk
5193c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so
5194c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of
5195c609719bSwdenknative "make".
5196c609719bSwdenk
5197c609719bSwdenk
5198c609719bSwdenkIf the system board that you have is not listed, then you will need
5199c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these
5200c609719bSwdenksteps:
5201c609719bSwdenk
5202c609719bSwdenk1.  Add a new configuration option for your board to the toplevel
52034d675ae6SMichael Jones    "boards.cfg" file, using the existing entries as examples.
52044d675ae6SMichael Jones    Follow the instructions there to keep the boards in order.
5205c609719bSwdenk2.  Create a new directory to hold your board specific code. Add any
520685ec0bccSwdenk    files you need. In your board directory, you will need at least
520785ec0bccSwdenk    the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
520885ec0bccSwdenk3.  Create a new configuration file "include/configs/<board>.h" for
520985ec0bccSwdenk    your board
5210c609719bSwdenk3.  If you're porting U-Boot to a new CPU, then also create a new
5211c609719bSwdenk    directory to hold your CPU specific code. Add any files you need.
5212ab584d67SHolger Freyther4.  Run "make <board>_defconfig" with your new name.
5213c609719bSwdenk5.  Type "make", and you should get a working "u-boot.srec" file
5214c609719bSwdenk    to be installed on your target system.
521585ec0bccSwdenk6.  Debug and solve any problems that might arise.
5216c609719bSwdenk    [Of course, this last step is much harder than it sounds.]
5217c609719bSwdenk
5218c609719bSwdenk
5219c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.:
5220c609719bSwdenk==============================================================
5221c609719bSwdenk
5222c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board
5223c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to
5224c609719bSwdenkprovide feedback to the other developers. The feedback normally takes
5225c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest
5226218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources.
5227c609719bSwdenk
5228c609719bSwdenkBut before you submit such a patch, please verify that your modifi-
5229c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of
5230c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so,
5231c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot
5232c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You can
52337152b1d0Swdenkselect which (cross) compiler to use by passing a `CROSS_COMPILE'
5234218ca724SWolfgang Denkenvironment variable to the script, i. e. to use the ELDK cross tools
5235218ca724SWolfgang Denkyou can type
5236c609719bSwdenk
5237c609719bSwdenk	CROSS_COMPILE=ppc_8xx- MAKEALL
5238c609719bSwdenk
5239c609719bSwdenkor to build on a native PowerPC system you can type
5240c609719bSwdenk
5241c609719bSwdenk	CROSS_COMPILE=' ' MAKEALL
5242c609719bSwdenk
5243218ca724SWolfgang DenkWhen using the MAKEALL script, the default behaviour is to build
5244218ca724SWolfgang DenkU-Boot in the source directory. This location can be changed by
5245218ca724SWolfgang Denksetting the BUILD_DIR environment variable. Also, for each target
5246218ca724SWolfgang Denkbuilt, the MAKEALL script saves two log files (<target>.ERR and
5247218ca724SWolfgang Denk<target>.MAKEALL) in the <source dir>/LOG directory. This default
5248218ca724SWolfgang Denklocation can be changed by setting the MAKEALL_LOGDIR environment
5249218ca724SWolfgang Denkvariable. For example:
5250baf31249SMarian Balakowicz
5251baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
5252baf31249SMarian Balakowicz	export MAKEALL_LOGDIR=/tmp/log
5253baf31249SMarian Balakowicz	CROSS_COMPILE=ppc_8xx- MAKEALL
5254baf31249SMarian Balakowicz
5255218ca724SWolfgang DenkWith the above settings build objects are saved in the /tmp/build,
5256218ca724SWolfgang Denklog files are saved in the /tmp/log and the source tree remains clean
5257218ca724SWolfgang Denkduring the whole build process.
5258baf31249SMarian Balakowicz
5259baf31249SMarian Balakowicz
5260c609719bSwdenkSee also "U-Boot Porting Guide" below.
5261c609719bSwdenk
5262c609719bSwdenk
5263c609719bSwdenkMonitor Commands - Overview:
5264c609719bSwdenk============================
5265c609719bSwdenk
5266c609719bSwdenkgo	- start application at address 'addr'
5267c609719bSwdenkrun	- run commands in an environment variable
5268c609719bSwdenkbootm	- boot application image from memory
5269c609719bSwdenkbootp	- boot image via network using BootP/TFTP protocol
527044f074c7SMarek Vasutbootz   - boot zImage from memory
5271c609719bSwdenktftpboot- boot image via network using TFTP protocol
5272c609719bSwdenk	       and env variables "ipaddr" and "serverip"
5273c609719bSwdenk	       (and eventually "gatewayip")
52741fb7cd49SSimon Glasstftpput - upload a file via network using TFTP protocol
5275c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol
5276c609719bSwdenkdiskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
5277c609719bSwdenkloads	- load S-Record file over serial line
5278c609719bSwdenkloadb	- load binary file over serial line (kermit mode)
5279c609719bSwdenkmd	- memory display
5280c609719bSwdenkmm	- memory modify (auto-incrementing)
5281c609719bSwdenknm	- memory modify (constant address)
5282c609719bSwdenkmw	- memory write (fill)
5283c609719bSwdenkcp	- memory copy
5284c609719bSwdenkcmp	- memory compare
5285c609719bSwdenkcrc32	- checksum calculation
52860f89c54bSPeter Tyseri2c	- I2C sub-system
5287c609719bSwdenksspi	- SPI utility commands
5288c609719bSwdenkbase	- print or set address offset
5289c609719bSwdenkprintenv- print environment variables
5290c609719bSwdenksetenv	- set environment variables
5291c609719bSwdenksaveenv - save environment variables to persistent storage
5292c609719bSwdenkprotect - enable or disable FLASH write protection
5293c609719bSwdenkerase	- erase FLASH memory
5294c609719bSwdenkflinfo	- print FLASH memory information
529510635afaSKarl O. Pincnand	- NAND memory operations (see doc/README.nand)
5296c609719bSwdenkbdinfo	- print Board Info structure
5297c609719bSwdenkiminfo	- print header information for application image
5298c609719bSwdenkconinfo - print console devices and informations
5299c609719bSwdenkide	- IDE sub-system
5300c609719bSwdenkloop	- infinite loop on address range
530156523f12Swdenkloopw	- infinite write loop on address range
5302c609719bSwdenkmtest	- simple RAM test
5303c609719bSwdenkicache	- enable or disable instruction cache
5304c609719bSwdenkdcache	- enable or disable data cache
5305c609719bSwdenkreset	- Perform RESET of the CPU
5306c609719bSwdenkecho	- echo args to console
5307c609719bSwdenkversion - print monitor version
5308c609719bSwdenkhelp	- print online help
5309c609719bSwdenk?	- alias for 'help'
5310c609719bSwdenk
5311c609719bSwdenk
5312c609719bSwdenkMonitor Commands - Detailed Description:
5313c609719bSwdenk========================================
5314c609719bSwdenk
5315c609719bSwdenkTODO.
5316c609719bSwdenk
5317c609719bSwdenkFor now: just type "help <command>".
5318c609719bSwdenk
5319c609719bSwdenk
5320c609719bSwdenkEnvironment Variables:
5321c609719bSwdenk======================
5322c609719bSwdenk
5323c609719bSwdenkU-Boot supports user configuration using Environment Variables which
5324c609719bSwdenkcan be made persistent by saving to Flash memory.
5325c609719bSwdenk
5326c609719bSwdenkEnvironment Variables are set using "setenv", printed using
5327c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv"
5328c609719bSwdenkwithout a value can be used to delete a variable from the
5329c609719bSwdenkenvironment. As long as you don't save the environment you are
5330c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the
5331c609719bSwdenkenvironment is erased by accident, a default environment is provided.
5332c609719bSwdenk
5333c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables.
5334c96f86eeSWolfgang Denk
5335c96f86eeSWolfgang DenkList of environment variables (most likely not complete):
5336c609719bSwdenk
5337c609719bSwdenk  baudrate	- see CONFIG_BAUDRATE
5338c609719bSwdenk
5339c609719bSwdenk  bootdelay	- see CONFIG_BOOTDELAY
5340c609719bSwdenk
5341c609719bSwdenk  bootcmd	- see CONFIG_BOOTCOMMAND
5342c609719bSwdenk
5343c609719bSwdenk  bootargs	- Boot arguments when booting an RTOS image
5344c609719bSwdenk
5345c609719bSwdenk  bootfile	- Name of the image to load with TFTP
5346c609719bSwdenk
53477d721e34SBartlomiej Sieka  bootm_low	- Memory range available for image processing in the bootm
53487d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
53497d721e34SBartlomiej Sieka		  a hexadecimal number and defines lowest address allowed
53507d721e34SBartlomiej Sieka		  for use by the bootm command. See also "bootm_size"
53517d721e34SBartlomiej Sieka		  environment variable. Address defined by "bootm_low" is
53527d721e34SBartlomiej Sieka		  also the base of the initial memory mapping for the Linux
5353c3624e6eSGrant Likely		  kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
5354c3624e6eSGrant Likely		  bootm_mapsize.
5355c3624e6eSGrant Likely
5356c3624e6eSGrant Likely  bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
5357c3624e6eSGrant Likely		  This variable is given as a hexadecimal number and it
5358c3624e6eSGrant Likely		  defines the size of the memory region starting at base
5359c3624e6eSGrant Likely		  address bootm_low that is accessible by the Linux kernel
5360c3624e6eSGrant Likely		  during early boot.  If unset, CONFIG_SYS_BOOTMAPSZ is used
5361c3624e6eSGrant Likely		  as the default value if it is defined, and bootm_size is
5362c3624e6eSGrant Likely		  used otherwise.
53637d721e34SBartlomiej Sieka
53647d721e34SBartlomiej Sieka  bootm_size	- Memory range available for image processing in the bootm
53657d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
53667d721e34SBartlomiej Sieka		  a hexadecimal number and defines the size of the region
53677d721e34SBartlomiej Sieka		  allowed for use by the bootm command. See also "bootm_low"
53687d721e34SBartlomiej Sieka		  environment variable.
53697d721e34SBartlomiej Sieka
53704bae9090SBartlomiej Sieka  updatefile	- Location of the software update file on a TFTP server, used
53714bae9090SBartlomiej Sieka		  by the automatic software update feature. Please refer to
53724bae9090SBartlomiej Sieka		  documentation in doc/README.update for more details.
53734bae9090SBartlomiej Sieka
5374c609719bSwdenk  autoload	- if set to "no" (any string beginning with 'n'),
5375c609719bSwdenk		  "bootp" will just load perform a lookup of the
5376c609719bSwdenk		  configuration from the BOOTP server, but not try to
5377c609719bSwdenk		  load any image using TFTP
5378c609719bSwdenk
5379c609719bSwdenk  autostart	- if set to "yes", an image loaded using the "bootp",
5380c609719bSwdenk		  "rarpboot", "tftpboot" or "diskboot" commands will
5381c609719bSwdenk		  be automatically started (by internally calling
5382c609719bSwdenk		  "bootm")
5383c609719bSwdenk
53844a6fd34bSwdenk		  If set to "no", a standalone image passed to the
53854a6fd34bSwdenk		  "bootm" command will be copied to the load address
53864a6fd34bSwdenk		  (and eventually uncompressed), but NOT be started.
53874a6fd34bSwdenk		  This can be used to load and uncompress arbitrary
53884a6fd34bSwdenk		  data.
53894a6fd34bSwdenk
5390a28afca5SDavid A. Long  fdt_high	- if set this restricts the maximum address that the
5391a28afca5SDavid A. Long		  flattened device tree will be copied into upon boot.
5392fa34f6b2SShawn Guo		  For example, if you have a system with 1 GB memory
5393fa34f6b2SShawn Guo		  at physical address 0x10000000, while Linux kernel
5394fa34f6b2SShawn Guo		  only recognizes the first 704 MB as low memory, you
5395fa34f6b2SShawn Guo		  may need to set fdt_high as 0x3C000000 to have the
5396fa34f6b2SShawn Guo		  device tree blob be copied to the maximum address
5397fa34f6b2SShawn Guo		  of the 704 MB low memory, so that Linux kernel can
5398fa34f6b2SShawn Guo		  access it during the boot procedure.
5399fa34f6b2SShawn Guo
5400a28afca5SDavid A. Long		  If this is set to the special value 0xFFFFFFFF then
5401a28afca5SDavid A. Long		  the fdt will not be copied at all on boot.  For this
5402a28afca5SDavid A. Long		  to work it must reside in writable memory, have
5403a28afca5SDavid A. Long		  sufficient padding on the end of it for u-boot to
5404a28afca5SDavid A. Long		  add the information it needs into it, and the memory
5405a28afca5SDavid A. Long		  must be accessible by the kernel.
5406a28afca5SDavid A. Long
5407eea63e05SSimon Glass  fdtcontroladdr- if set this is the address of the control flattened
5408eea63e05SSimon Glass		  device tree used by U-Boot when CONFIG_OF_CONTROL is
5409eea63e05SSimon Glass		  defined.
5410eea63e05SSimon Glass
541117ea1177Swdenk  i2cfast	- (PPC405GP|PPC405EP only)
541217ea1177Swdenk		  if set to 'y' configures Linux I2C driver for fast
541317ea1177Swdenk		  mode (400kHZ). This environment variable is used in
541417ea1177Swdenk		  initialization code. So, for changes to be effective
541517ea1177Swdenk		  it must be saved and board must be reset.
541617ea1177Swdenk
5417c609719bSwdenk  initrd_high	- restrict positioning of initrd images:
5418c609719bSwdenk		  If this variable is not set, initrd images will be
5419c609719bSwdenk		  copied to the highest possible address in RAM; this
5420c609719bSwdenk		  is usually what you want since it allows for
5421c609719bSwdenk		  maximum initrd size. If for some reason you want to
5422c609719bSwdenk		  make sure that the initrd image is loaded below the
54236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		  CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
5424c609719bSwdenk		  variable to a value of "no" or "off" or "0".
5425c609719bSwdenk		  Alternatively, you can set it to a maximum upper
5426c609719bSwdenk		  address to use (U-Boot will still check that it
5427c609719bSwdenk		  does not overwrite the U-Boot stack and data).
5428c609719bSwdenk
5429c609719bSwdenk		  For instance, when you have a system with 16 MB
54307152b1d0Swdenk		  RAM, and want to reserve 4 MB from use by Linux,
5431c609719bSwdenk		  you can do this by adding "mem=12M" to the value of
5432c609719bSwdenk		  the "bootargs" variable. However, now you must make
54337152b1d0Swdenk		  sure that the initrd image is placed in the first
5434c609719bSwdenk		  12 MB as well - this can be done with
5435c609719bSwdenk
5436c609719bSwdenk		  setenv initrd_high 00c00000
5437c609719bSwdenk
543838b99261Swdenk		  If you set initrd_high to 0xFFFFFFFF, this is an
543938b99261Swdenk		  indication to U-Boot that all addresses are legal
544038b99261Swdenk		  for the Linux kernel, including addresses in flash
544138b99261Swdenk		  memory. In this case U-Boot will NOT COPY the
544238b99261Swdenk		  ramdisk at all. This may be useful to reduce the
544338b99261Swdenk		  boot time on your system, but requires that this
544438b99261Swdenk		  feature is supported by your Linux kernel.
544538b99261Swdenk
5446c609719bSwdenk  ipaddr	- IP address; needed for tftpboot command
5447c609719bSwdenk
5448c609719bSwdenk  loadaddr	- Default load address for commands like "bootp",
5449dc7c9a1aSwdenk		  "rarpboot", "tftpboot", "loadb" or "diskboot"
5450c609719bSwdenk
5451c609719bSwdenk  loads_echo	- see CONFIG_LOADS_ECHO
5452c609719bSwdenk
5453c609719bSwdenk  serverip	- TFTP server IP address; needed for tftpboot command
5454c609719bSwdenk
5455c609719bSwdenk  bootretry	- see CONFIG_BOOT_RETRY_TIME
5456c609719bSwdenk
5457c609719bSwdenk  bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
5458c609719bSwdenk
5459c609719bSwdenk  bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
5460c609719bSwdenk
5461e2a53458SMike Frysinger  ethprime	- controls which interface is used first.
5462a3d991bdSwdenk
5463e2a53458SMike Frysinger  ethact	- controls which interface is currently active.
5464e2a53458SMike Frysinger		  For example you can do the following
5465a3d991bdSwdenk
546648690d80SHeiko Schocher		  => setenv ethact FEC
546748690d80SHeiko Schocher		  => ping 192.168.0.1 # traffic sent on FEC
546848690d80SHeiko Schocher		  => setenv ethact SCC
546948690d80SHeiko Schocher		  => ping 10.0.0.1 # traffic sent on SCC
5470a3d991bdSwdenk
5471e1692577SMatthias Fuchs  ethrotate	- When set to "no" U-Boot does not go through all
5472e1692577SMatthias Fuchs		  available network interfaces.
5473e1692577SMatthias Fuchs		  It just stays at the currently selected interface.
5474e1692577SMatthias Fuchs
5475a3d991bdSwdenk  netretry	- When set to "no" each network operation will
5476a3d991bdSwdenk		  either succeed or fail without retrying.
54776e592385Swdenk		  When set to "once" the network operation will
54786e592385Swdenk		  fail when all the available network interfaces
54796e592385Swdenk		  are tried once without success.
5480a3d991bdSwdenk		  Useful on scripts which control the retry operation
5481a3d991bdSwdenk		  themselves.
5482a3d991bdSwdenk
5483b4e2f89dSJean-Christophe PLAGNIOL-VILLARD  npe_ucode	- set load address for the NPE microcode
5484a1cf027aSJean-Christophe PLAGNIOL-VILLARD
5485b445bbb4SJeremiah Mahler  silent_linux  - If set then Linux will be told to boot silently, by
54868d51aacdSSimon Glass		  changing the console to be empty. If "yes" it will be
54878d51aacdSSimon Glass		  made silent. If "no" it will not be made silent. If
54888d51aacdSSimon Glass		  unset, then it will be made silent if the U-Boot console
54898d51aacdSSimon Glass		  is silent.
54908d51aacdSSimon Glass
549128cb9375SWolfgang Denk  tftpsrcport	- If this is set, the value is used for TFTP's
5492ecb0ccd9SWolfgang Denk		  UDP source port.
5493ecb0ccd9SWolfgang Denk
549428cb9375SWolfgang Denk  tftpdstport	- If this is set, the value is used for TFTP's UDP
549528cb9375SWolfgang Denk		  destination port instead of the Well Know Port 69.
549628cb9375SWolfgang Denk
5497c96f86eeSWolfgang Denk  tftpblocksize - Block size to use for TFTP transfers; if not set,
5498c96f86eeSWolfgang Denk		  we use the TFTP server's default block size
5499c96f86eeSWolfgang Denk
5500c96f86eeSWolfgang Denk  tftptimeout	- Retransmission timeout for TFTP packets (in milli-
5501c96f86eeSWolfgang Denk		  seconds, minimum value is 1000 = 1 second). Defines
5502c96f86eeSWolfgang Denk		  when a packet is considered to be lost so it has to
5503c96f86eeSWolfgang Denk		  be retransmitted. The default is 5000 = 5 seconds.
5504c96f86eeSWolfgang Denk		  Lowering this value may make downloads succeed
5505c96f86eeSWolfgang Denk		  faster in networks with high packet loss rates or
5506c96f86eeSWolfgang Denk		  with unreliable TFTP servers.
5507c96f86eeSWolfgang Denk
5508a3d991bdSwdenk  vlan		- When set to a value < 4095 the traffic over
550911ccc33fSMarcel Ziswiler		  Ethernet is encapsulated/received over 802.1q
5510a3d991bdSwdenk		  VLAN tagged frames.
5511c609719bSwdenk
5512dc0b7b0eSJason HobbsThe following image location variables contain the location of images
5513dc0b7b0eSJason Hobbsused in booting. The "Image" column gives the role of the image and is
5514dc0b7b0eSJason Hobbsnot an environment variable name. The other columns are environment
5515dc0b7b0eSJason Hobbsvariable names. "File Name" gives the name of the file on a TFTP
5516dc0b7b0eSJason Hobbsserver, "RAM Address" gives the location in RAM the image will be
5517dc0b7b0eSJason Hobbsloaded to, and "Flash Location" gives the image's address in NOR
5518dc0b7b0eSJason Hobbsflash or offset in NAND flash.
5519dc0b7b0eSJason Hobbs
5520dc0b7b0eSJason Hobbs*Note* - these variables don't have to be defined for all boards, some
5521dc0b7b0eSJason Hobbsboards currenlty use other variables for these purposes, and some
5522dc0b7b0eSJason Hobbsboards use these variables for other purposes.
5523dc0b7b0eSJason Hobbs
5524dc0b7b0eSJason HobbsImage		    File Name	     RAM Address       Flash Location
5525dc0b7b0eSJason Hobbs-----		    ---------	     -----------       --------------
5526dc0b7b0eSJason Hobbsu-boot		    u-boot	     u-boot_addr_r     u-boot_addr
5527dc0b7b0eSJason HobbsLinux kernel	    bootfile	     kernel_addr_r     kernel_addr
5528dc0b7b0eSJason Hobbsdevice tree blob    fdtfile	     fdt_addr_r	       fdt_addr
5529dc0b7b0eSJason Hobbsramdisk		    ramdiskfile	     ramdisk_addr_r    ramdisk_addr
5530dc0b7b0eSJason Hobbs
5531c609719bSwdenkThe following environment variables may be used and automatically
5532c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"),
5533c609719bSwdenkdepending the information provided by your boot server:
5534c609719bSwdenk
5535c609719bSwdenk  bootfile	- see above
5536c609719bSwdenk  dnsip		- IP address of your Domain Name Server
5537fe389a82Sstroese  dnsip2	- IP address of your secondary Domain Name Server
5538c609719bSwdenk  gatewayip	- IP address of the Gateway (Router) to use
5539c609719bSwdenk  hostname	- Target hostname
5540c609719bSwdenk  ipaddr	- see above
5541c609719bSwdenk  netmask	- Subnet Mask
5542c609719bSwdenk  rootpath	- Pathname of the root filesystem on the NFS server
5543c609719bSwdenk  serverip	- see above
5544c609719bSwdenk
5545c609719bSwdenk
5546c609719bSwdenkThere are two special Environment Variables:
5547c609719bSwdenk
5548c609719bSwdenk  serial#	- contains hardware identification information such
5549c609719bSwdenk		  as type string and/or serial number
5550c609719bSwdenk  ethaddr	- Ethernet address
5551c609719bSwdenk
5552c609719bSwdenkThese variables can be set only once (usually during manufacturing of
5553c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables
5554c609719bSwdenkonce they have been set once.
5555c609719bSwdenk
5556c609719bSwdenk
5557c1551ea8SstroeseFurther special Environment Variables:
5558c1551ea8Sstroese
5559c1551ea8Sstroese  ver		- Contains the U-Boot version string as printed
5560c1551ea8Sstroese		  with the "version" command. This variable is
5561c1551ea8Sstroese		  readonly (see CONFIG_VERSION_VARIABLE).
5562c1551ea8Sstroese
5563c1551ea8Sstroese
5564c609719bSwdenkPlease note that changes to some configuration parameters may take
5565c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-).
5566c609719bSwdenk
5567c609719bSwdenk
5568170ab110SJoe HershbergerCallback functions for environment variables:
5569170ab110SJoe Hershberger---------------------------------------------
5570170ab110SJoe Hershberger
5571170ab110SJoe HershbergerFor some environment variables, the behavior of u-boot needs to change
5572b445bbb4SJeremiah Mahlerwhen their values are changed.  This functionality allows functions to
5573170ab110SJoe Hershbergerbe associated with arbitrary variables.  On creation, overwrite, or
5574170ab110SJoe Hershbergerdeletion, the callback will provide the opportunity for some side
5575170ab110SJoe Hershbergereffect to happen or for the change to be rejected.
5576170ab110SJoe Hershberger
5577170ab110SJoe HershbergerThe callbacks are named and associated with a function using the
5578170ab110SJoe HershbergerU_BOOT_ENV_CALLBACK macro in your board or driver code.
5579170ab110SJoe Hershberger
5580170ab110SJoe HershbergerThese callbacks are associated with variables in one of two ways.  The
5581170ab110SJoe Hershbergerstatic list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
5582170ab110SJoe Hershbergerin the board configuration to a string that defines a list of
5583170ab110SJoe Hershbergerassociations.  The list must be in the following format:
5584170ab110SJoe Hershberger
5585170ab110SJoe Hershberger	entry = variable_name[:callback_name]
5586170ab110SJoe Hershberger	list = entry[,list]
5587170ab110SJoe Hershberger
5588170ab110SJoe HershbergerIf the callback name is not specified, then the callback is deleted.
5589170ab110SJoe HershbergerSpaces are also allowed anywhere in the list.
5590170ab110SJoe Hershberger
5591170ab110SJoe HershbergerCallbacks can also be associated by defining the ".callbacks" variable
5592170ab110SJoe Hershbergerwith the same list format above.  Any association in ".callbacks" will
5593170ab110SJoe Hershbergeroverride any association in the static list. You can define
5594170ab110SJoe HershbergerCONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
5595b445bbb4SJeremiah Mahler".callbacks" environment variable in the default or embedded environment.
5596170ab110SJoe Hershberger
5597170ab110SJoe Hershberger
5598f07771ccSwdenkCommand Line Parsing:
5599f07771ccSwdenk=====================
5600f07771ccSwdenk
5601f07771ccSwdenkThere are two different command line parsers available with U-Boot:
56027152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell:
5603f07771ccSwdenk
5604f07771ccSwdenkOld, simple command line parser:
5605f07771ccSwdenk--------------------------------
5606f07771ccSwdenk
5607f07771ccSwdenk- supports environment variables (through setenv / saveenv commands)
5608f07771ccSwdenk- several commands on one line, separated by ';'
5609fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax
5610f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\',
5611f07771ccSwdenk  for example:
5612fe126d8bSWolfgang Denk	setenv bootcmd bootm \${address}
5613f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example:
5614f07771ccSwdenk	setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
5615f07771ccSwdenk
5616f07771ccSwdenkHush shell:
5617f07771ccSwdenk-----------
5618f07771ccSwdenk
5619f07771ccSwdenk- similar to Bourne shell, with control structures like
5620f07771ccSwdenk  if...then...else...fi, for...do...done; while...do...done,
5621f07771ccSwdenk  until...do...done, ...
5622f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv
5623f07771ccSwdenk  commands) and local shell variables (through standard shell syntax
5624f07771ccSwdenk  "name=value"); only environment variables can be used with "run"
5625f07771ccSwdenk  command
5626f07771ccSwdenk
5627f07771ccSwdenkGeneral rules:
5628f07771ccSwdenk--------------
5629f07771ccSwdenk
5630f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run"
5631f07771ccSwdenk    command) contains several commands separated by semicolon, and
5632f07771ccSwdenk    one of these commands fails, then the remaining commands will be
5633f07771ccSwdenk    executed anyway.
5634f07771ccSwdenk
5635f07771ccSwdenk(2) If you execute several variables with one call to run (i. e.
563611ccc33fSMarcel Ziswiler    calling run with a list of variables as arguments), any failing
5637f07771ccSwdenk    command will cause "run" to terminate, i. e. the remaining
5638f07771ccSwdenk    variables are not executed.
5639f07771ccSwdenk
5640c609719bSwdenkNote for Redundant Ethernet Interfaces:
5641c609719bSwdenk=======================================
5642c609719bSwdenk
564311ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports
5644c609719bSwdenksuch configurations and is capable of automatic selection of a
56457152b1d0Swdenk"working" interface when needed. MAC assignment works as follows:
5646c609719bSwdenk
5647c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding
5648c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0),
5649c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ...
5650c609719bSwdenk
5651c609719bSwdenkIf the network interface stores some valid MAC address (for instance
5652c609719bSwdenkin SROM), this is used as default address if there is NO correspon-
5653c609719bSwdenkding setting in the environment; if the corresponding environment
5654c609719bSwdenkvariable is set, this overrides the settings in the card; that means:
5655c609719bSwdenk
5656c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the
5657c609719bSwdenk  environment, the SROM's address is used.
5658c609719bSwdenk
5659c609719bSwdenko If there is no valid address in the SROM, and a definition in the
5660c609719bSwdenk  environment exists, then the value from the environment variable is
5661c609719bSwdenk  used.
5662c609719bSwdenk
5663c609719bSwdenko If both the SROM and the environment contain a MAC address, and
5664c609719bSwdenk  both addresses are the same, this MAC address is used.
5665c609719bSwdenk
5666c609719bSwdenko If both the SROM and the environment contain a MAC address, and the
5667c609719bSwdenk  addresses differ, the value from the environment is used and a
5668c609719bSwdenk  warning is printed.
5669c609719bSwdenk
5670c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error
5671c609719bSwdenk  is raised.
5672c609719bSwdenk
5673ecee9324SBen WarrenIf Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
5674ecee9324SBen Warrenwill be programmed into hardware as part of the initialization process.	 This
5675ecee9324SBen Warrenmay be skipped by setting the appropriate 'ethmacskip' environment variable.
5676ecee9324SBen WarrenThe naming convention is as follows:
5677ecee9324SBen Warren"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
5678c609719bSwdenk
5679c609719bSwdenkImage Formats:
5680c609719bSwdenk==============
5681c609719bSwdenk
56823310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on)
56833310c549SMarian Balakowiczimages in two formats:
56843310c549SMarian Balakowicz
56853310c549SMarian BalakowiczNew uImage format (FIT)
56863310c549SMarian Balakowicz-----------------------
56873310c549SMarian Balakowicz
56883310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar
56893310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple
56903310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by
56913310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
56923310c549SMarian Balakowicz
56933310c549SMarian Balakowicz
56943310c549SMarian BalakowiczOld uImage format
56953310c549SMarian Balakowicz-----------------
56963310c549SMarian Balakowicz
56973310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything,
56983310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for
56993310c549SMarian Balakowiczdetails; basically, the header defines the following image properties:
5700c609719bSwdenk
5701c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5702c609719bSwdenk  4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
5703f5ed9e39SPeter Tyser  LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5704f5ed9e39SPeter Tyser  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5705f5ed9e39SPeter Tyser  INTEGRITY).
57067b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
5707afc1ce82SMacpaul Lin  IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5708afc1ce82SMacpaul Lin  Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
5709c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2)
5710c609719bSwdenk* Load Address
5711c609719bSwdenk* Entry Point
5712c609719bSwdenk* Image Name
5713c609719bSwdenk* Image Timestamp
5714c609719bSwdenk
5715c609719bSwdenkThe header is marked by a special Magic Number, and both the header
5716c609719bSwdenkand the data portions of the image are secured against corruption by
5717c609719bSwdenkCRC32 checksums.
5718c609719bSwdenk
5719c609719bSwdenk
5720c609719bSwdenkLinux Support:
5721c609719bSwdenk==============
5722c609719bSwdenk
5723c609719bSwdenkAlthough U-Boot should support any OS or standalone application
57247152b1d0Swdenkeasily, the main focus has always been on Linux during the design of
5725c609719bSwdenkU-Boot.
5726c609719bSwdenk
5727c609719bSwdenkU-Boot includes many features that so far have been part of some
5728c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any
5729c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image;
5730c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation
57317152b1d0Swdenkserves several purposes:
5732c609719bSwdenk
5733c609719bSwdenk- the same features can be used for other OS or standalone
5734c609719bSwdenk  applications (for instance: using compressed images to reduce the
5735c609719bSwdenk  Flash memory footprint)
5736c609719bSwdenk
5737c609719bSwdenk- it becomes much easier to port new Linux kernel versions because
57387152b1d0Swdenk  lots of low-level, hardware dependent stuff are done by U-Boot
5739c609719bSwdenk
5740c609719bSwdenk- the same Linux kernel image can now be used with different "initrd"
5741c609719bSwdenk  images; of course this also means that different kernel images can
5742c609719bSwdenk  be run with the same "initrd". This makes testing easier (you don't
5743c609719bSwdenk  have to build a new "zImage.initrd" Linux image when you just
5744c609719bSwdenk  change a file in your "initrd"). Also, a field-upgrade of the
5745c609719bSwdenk  software is easier now.
5746c609719bSwdenk
5747c609719bSwdenk
5748c609719bSwdenkLinux HOWTO:
5749c609719bSwdenk============
5750c609719bSwdenk
5751c609719bSwdenkPorting Linux to U-Boot based systems:
5752c609719bSwdenk---------------------------------------
5753c609719bSwdenk
5754c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to
5755c609719bSwdenkconfigure the Linux device drivers for use with your target hardware
5756c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to
5757c609719bSwdenkLinux :-).
5758c609719bSwdenk
5759a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
5760c609719bSwdenk
5761c609719bSwdenkJust make sure your machine specific header file (for instance
5762c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board
57631dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h,
57641dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value
57656d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR.
5766c609719bSwdenk
57672eb31b13SSimon GlassNote that U-Boot now has a driver model, a unified model for drivers.
57682eb31b13SSimon GlassIf you are adding a new driver, plumb it into driver model. If there
57692eb31b13SSimon Glassis no uclass available, you are encouraged to create one. See
57702eb31b13SSimon Glassdoc/driver-model.
57712eb31b13SSimon Glass
5772c609719bSwdenk
5773c609719bSwdenkConfiguring the Linux kernel:
5774c609719bSwdenk-----------------------------
5775c609719bSwdenk
5776c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root
5777c609719bSwdenkdevice (initial ramdisk, NFS) for your target system.
5778c609719bSwdenk
5779c609719bSwdenk
5780c609719bSwdenkBuilding a Linux Image:
5781c609719bSwdenk-----------------------
5782c609719bSwdenk
578324ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are
578424ee89b9Swdenknot used. If you use recent kernel source, a new build target
578524ee89b9Swdenk"uImage" will exist which automatically builds an image usable by
578624ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target,
578724ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a
578824ee89b9Swdenk100% compatible format.
5789c609719bSwdenk
5790c609719bSwdenkExample:
5791c609719bSwdenk
5792ab584d67SHolger Freyther	make TQM850L_defconfig
5793c609719bSwdenk	make oldconfig
5794c609719bSwdenk	make dep
579524ee89b9Swdenk	make uImage
5796c609719bSwdenk
579724ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to
579824ee89b9Swdenkencapsulate a compressed Linux kernel image with header	 information,
579924ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing:
5800c609719bSwdenk
580124ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format):
580224ee89b9Swdenk
580324ee89b9Swdenk* convert the kernel into a raw binary image:
580424ee89b9Swdenk
580524ee89b9Swdenk	${CROSS_COMPILE}-objcopy -O binary \
580624ee89b9Swdenk				 -R .note -R .comment \
580724ee89b9Swdenk				 -S vmlinux linux.bin
580824ee89b9Swdenk
580924ee89b9Swdenk* compress the binary image:
581024ee89b9Swdenk
581124ee89b9Swdenk	gzip -9 linux.bin
581224ee89b9Swdenk
581324ee89b9Swdenk* package compressed binary image for U-Boot:
581424ee89b9Swdenk
581524ee89b9Swdenk	mkimage -A ppc -O linux -T kernel -C gzip \
581624ee89b9Swdenk		-a 0 -e 0 -n "Linux Kernel Image" \
581724ee89b9Swdenk		-d linux.bin.gz uImage
581824ee89b9Swdenk
581924ee89b9Swdenk
582024ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use
582124ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or
582224ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64
582324ee89b9Swdenkbyte header containing information about target architecture,
582424ee89b9Swdenkoperating system, image type, compression method, entry points, time
582524ee89b9Swdenkstamp, CRC32 checksums, etc.
582624ee89b9Swdenk
582724ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and
582824ee89b9Swdenkprint the header information, or to build new images.
5829c609719bSwdenk
5830c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information
5831c609719bSwdenkcontained in the header of an existing U-Boot image; this includes
5832c609719bSwdenkchecksum verification:
5833c609719bSwdenk
5834c609719bSwdenk	tools/mkimage -l image
5835c609719bSwdenk	  -l ==> list image header information
5836c609719bSwdenk
5837c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image
5838c609719bSwdenkfrom a "data file" which is used as image payload:
5839c609719bSwdenk
5840c609719bSwdenk	tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5841c609719bSwdenk		      -n name -d data_file image
5842c609719bSwdenk	  -A ==> set architecture to 'arch'
5843c609719bSwdenk	  -O ==> set operating system to 'os'
5844c609719bSwdenk	  -T ==> set image type to 'type'
5845c609719bSwdenk	  -C ==> set compression type 'comp'
5846c609719bSwdenk	  -a ==> set load address to 'addr' (hex)
5847c609719bSwdenk	  -e ==> set entry point to 'ep' (hex)
5848c609719bSwdenk	  -n ==> set image name to 'name'
5849c609719bSwdenk	  -d ==> use image data from 'datafile'
5850c609719bSwdenk
585169459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load
585269459791Swdenkaddress (0x00000000), but the entry point address depends on the
585369459791Swdenkkernel version:
5854c609719bSwdenk
5855c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C,
585624ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000.
5857c609719bSwdenk
5858c609719bSwdenkSo a typical call to build a U-Boot image would read:
5859c609719bSwdenk
586024ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
586124ee89b9Swdenk	> -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
5862a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
586324ee89b9Swdenk	> examples/uImage.TQM850L
586424ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5865c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5866c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
5867c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
5868c609719bSwdenk	Load Address: 0x00000000
586924ee89b9Swdenk	Entry Point:  0x00000000
5870c609719bSwdenk
5871c609719bSwdenkTo verify the contents of the image (or check for corruption):
5872c609719bSwdenk
587324ee89b9Swdenk	-> tools/mkimage -l examples/uImage.TQM850L
587424ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5875c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5876c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
5877c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
5878c609719bSwdenk	Load Address: 0x00000000
587924ee89b9Swdenk	Entry Point:  0x00000000
5880c609719bSwdenk
5881c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade
5882c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this
5883c609719bSwdenkneeds more space in Flash, but boots much faster since it does not
5884c609719bSwdenkneed to be uncompressed:
5885c609719bSwdenk
5886a47a12beSStefan Roese	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
588724ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
588824ee89b9Swdenk	> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
5889a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
589024ee89b9Swdenk	> examples/uImage.TQM850L-uncompressed
589124ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5892c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5893c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (uncompressed)
5894c609719bSwdenk	Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
5895c609719bSwdenk	Load Address: 0x00000000
589624ee89b9Swdenk	Entry Point:  0x00000000
5897c609719bSwdenk
5898c609719bSwdenk
5899c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file
5900c609719bSwdenkwhen your kernel is intended to use an initial ramdisk:
5901c609719bSwdenk
5902c609719bSwdenk	-> tools/mkimage -n 'Simple Ramdisk Image' \
5903c609719bSwdenk	> -A ppc -O linux -T ramdisk -C gzip \
5904c609719bSwdenk	> -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5905c609719bSwdenk	Image Name:   Simple Ramdisk Image
5906c609719bSwdenk	Created:      Wed Jan 12 14:01:50 2000
5907c609719bSwdenk	Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
5908c609719bSwdenk	Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
5909c609719bSwdenk	Load Address: 0x00000000
5910c609719bSwdenk	Entry Point:  0x00000000
5911c609719bSwdenk
5912a804b5ceSGuilherme Maciel FerreiraThe "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5913a804b5ceSGuilherme Maciel Ferreiraoption performs the converse operation of the mkimage's second form (the "-d"
5914a804b5ceSGuilherme Maciel Ferreiraoption). Given an image built by mkimage, the dumpimage extracts a "data file"
5915a804b5ceSGuilherme Maciel Ferreirafrom the image:
5916a804b5ceSGuilherme Maciel Ferreira
5917f41f5b7cSGuilherme Maciel Ferreira	tools/dumpimage -i image -T type -p position data_file
5918f41f5b7cSGuilherme Maciel Ferreira	  -i ==> extract from the 'image' a specific 'data_file'
5919f41f5b7cSGuilherme Maciel Ferreira	  -T ==> set image type to 'type'
5920f41f5b7cSGuilherme Maciel Ferreira	  -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
5921a804b5ceSGuilherme Maciel Ferreira
5922c609719bSwdenk
5923c609719bSwdenkInstalling a Linux Image:
5924c609719bSwdenk-------------------------
5925c609719bSwdenk
5926c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface,
5927c609719bSwdenkyou must convert the image to S-Record format:
5928c609719bSwdenk
5929c609719bSwdenk	objcopy -I binary -O srec examples/image examples/image.srec
5930c609719bSwdenk
5931c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot
5932c609719bSwdenkimage header, so the resulting S-Record file will be relative to
5933c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to
5934c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads'
5935c609719bSwdenkcommand.
5936c609719bSwdenk
5937c609719bSwdenkExample: install the image to address 0x40100000 (which on the
5938c609719bSwdenkTQM8xxL is in the first Flash bank):
5939c609719bSwdenk
5940c609719bSwdenk	=> erase 40100000 401FFFFF
5941c609719bSwdenk
5942c609719bSwdenk	.......... done
5943c609719bSwdenk	Erased 8 sectors
5944c609719bSwdenk
5945c609719bSwdenk	=> loads 40100000
5946c609719bSwdenk	## Ready for S-Record download ...
5947c609719bSwdenk	~>examples/image.srec
5948c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5949c609719bSwdenk	...
5950c609719bSwdenk	15989 15990 15991 15992
5951c609719bSwdenk	[file transfer complete]
5952c609719bSwdenk	[connected]
5953c609719bSwdenk	## Start Addr = 0x00000000
5954c609719bSwdenk
5955c609719bSwdenk
5956c609719bSwdenkYou can check the success of the download using the 'iminfo' command;
5957c609719bSwdenkthis includes a checksum verification so you can be sure no data
5958c609719bSwdenkcorruption happened:
5959c609719bSwdenk
5960c609719bSwdenk	=> imi 40100000
5961c609719bSwdenk
5962c609719bSwdenk	## Checking Image at 40100000 ...
5963c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5964c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5965c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5966c609719bSwdenk	   Load Address: 00000000
5967c609719bSwdenk	   Entry Point:	 0000000c
5968c609719bSwdenk	   Verifying Checksum ... OK
5969c609719bSwdenk
5970c609719bSwdenk
5971c609719bSwdenkBoot Linux:
5972c609719bSwdenk-----------
5973c609719bSwdenk
5974c609719bSwdenkThe "bootm" command is used to boot an application that is stored in
5975c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents
5976c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as
5977c609719bSwdenkparameters. You can check and modify this variable using the
5978c609719bSwdenk"printenv" and "setenv" commands:
5979c609719bSwdenk
5980c609719bSwdenk
5981c609719bSwdenk	=> printenv bootargs
5982c609719bSwdenk	bootargs=root=/dev/ram
5983c609719bSwdenk
5984c609719bSwdenk	=> setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5985c609719bSwdenk
5986c609719bSwdenk	=> printenv bootargs
5987c609719bSwdenk	bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5988c609719bSwdenk
5989c609719bSwdenk	=> bootm 40020000
5990c609719bSwdenk	## Booting Linux kernel at 40020000 ...
5991c609719bSwdenk	   Image Name:	 2.2.13 for NFS on TQM850L
5992c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5993c609719bSwdenk	   Data Size:	 381681 Bytes = 372 kB = 0 MB
5994c609719bSwdenk	   Load Address: 00000000
5995c609719bSwdenk	   Entry Point:	 0000000c
5996c609719bSwdenk	   Verifying Checksum ... OK
5997c609719bSwdenk	   Uncompressing Kernel Image ... OK
5998c609719bSwdenk	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
5999c609719bSwdenk	Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
6000c609719bSwdenk	time_init: decrementer frequency = 187500000/60
6001c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
6002c609719bSwdenk	Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
6003c609719bSwdenk	...
6004c609719bSwdenk
600511ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass
60067152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT
6007c609719bSwdenkformat!) to the "bootm" command:
6008c609719bSwdenk
6009c609719bSwdenk	=> imi 40100000 40200000
6010c609719bSwdenk
6011c609719bSwdenk	## Checking Image at 40100000 ...
6012c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
6013c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
6014c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
6015c609719bSwdenk	   Load Address: 00000000
6016c609719bSwdenk	   Entry Point:	 0000000c
6017c609719bSwdenk	   Verifying Checksum ... OK
6018c609719bSwdenk
6019c609719bSwdenk	## Checking Image at 40200000 ...
6020c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
6021c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
6022c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
6023c609719bSwdenk	   Load Address: 00000000
6024c609719bSwdenk	   Entry Point:	 00000000
6025c609719bSwdenk	   Verifying Checksum ... OK
6026c609719bSwdenk
6027c609719bSwdenk	=> bootm 40100000 40200000
6028c609719bSwdenk	## Booting Linux kernel at 40100000 ...
6029c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
6030c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
6031c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
6032c609719bSwdenk	   Load Address: 00000000
6033c609719bSwdenk	   Entry Point:	 0000000c
6034c609719bSwdenk	   Verifying Checksum ... OK
6035c609719bSwdenk	   Uncompressing Kernel Image ... OK
6036c609719bSwdenk	## Loading RAMDisk Image at 40200000 ...
6037c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
6038c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
6039c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
6040c609719bSwdenk	   Load Address: 00000000
6041c609719bSwdenk	   Entry Point:	 00000000
6042c609719bSwdenk	   Verifying Checksum ... OK
6043c609719bSwdenk	   Loading Ramdisk ... OK
6044c609719bSwdenk	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
6045c609719bSwdenk	Boot arguments: root=/dev/ram
6046c609719bSwdenk	time_init: decrementer frequency = 187500000/60
6047c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
6048c609719bSwdenk	...
6049c609719bSwdenk	RAMDISK: Compressed image found at block 0
6050c609719bSwdenk	VFS: Mounted root (ext2 filesystem).
6051c609719bSwdenk
6052c609719bSwdenk	bash#
6053c609719bSwdenk
60540267768eSMatthew McClintockBoot Linux and pass a flat device tree:
60550267768eSMatthew McClintock-----------
60560267768eSMatthew McClintock
60570267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section
60580267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The
60590267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated
60600267768eSMatthew McClintockflat device tree:
60610267768eSMatthew McClintock
60620267768eSMatthew McClintock=> print oftaddr
60630267768eSMatthew McClintockoftaddr=0x300000
60640267768eSMatthew McClintock=> print oft
60650267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb
60660267768eSMatthew McClintock=> tftp $oftaddr $oft
60670267768eSMatthew McClintockSpeed: 1000, full duplex
60680267768eSMatthew McClintockUsing TSEC0 device
60690267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101
60700267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'.
60710267768eSMatthew McClintockLoad address: 0x300000
60720267768eSMatthew McClintockLoading: #
60730267768eSMatthew McClintockdone
60740267768eSMatthew McClintockBytes transferred = 4106 (100a hex)
60750267768eSMatthew McClintock=> tftp $loadaddr $bootfile
60760267768eSMatthew McClintockSpeed: 1000, full duplex
60770267768eSMatthew McClintockUsing TSEC0 device
60780267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2
60790267768eSMatthew McClintockFilename 'uImage'.
60800267768eSMatthew McClintockLoad address: 0x200000
60810267768eSMatthew McClintockLoading:############
60820267768eSMatthew McClintockdone
60830267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex)
60840267768eSMatthew McClintock=> print loadaddr
60850267768eSMatthew McClintockloadaddr=200000
60860267768eSMatthew McClintock=> print oftaddr
60870267768eSMatthew McClintockoftaddr=0x300000
60880267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr
60890267768eSMatthew McClintock## Booting image at 00200000 ...
60900267768eSMatthew McClintock   Image Name:	 Linux-2.6.17-dirty
60910267768eSMatthew McClintock   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
60920267768eSMatthew McClintock   Data Size:	 1029343 Bytes = 1005.2 kB
60930267768eSMatthew McClintock   Load Address: 00000000
60940267768eSMatthew McClintock   Entry Point:	 00000000
60950267768eSMatthew McClintock   Verifying Checksum ... OK
60960267768eSMatthew McClintock   Uncompressing Kernel Image ... OK
60970267768eSMatthew McClintockBooting using flat device tree at 0x300000
60980267768eSMatthew McClintockUsing MPC85xx ADS machine description
60990267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
61000267768eSMatthew McClintock[snip]
61010267768eSMatthew McClintock
61020267768eSMatthew McClintock
61036069ff26SwdenkMore About U-Boot Image Types:
61046069ff26Swdenk------------------------------
61056069ff26Swdenk
61066069ff26SwdenkU-Boot supports the following image types:
61076069ff26Swdenk
61086069ff26Swdenk   "Standalone Programs" are directly runnable in the environment
61096069ff26Swdenk	provided by U-Boot; it is expected that (if they behave
61106069ff26Swdenk	well) you can continue to work in U-Boot after return from
61116069ff26Swdenk	the Standalone Program.
61126069ff26Swdenk   "OS Kernel Images" are usually images of some Embedded OS which
61136069ff26Swdenk	will take over control completely. Usually these programs
61146069ff26Swdenk	will install their own set of exception handlers, device
61156069ff26Swdenk	drivers, set up the MMU, etc. - this means, that you cannot
61166069ff26Swdenk	expect to re-enter U-Boot except by resetting the CPU.
61176069ff26Swdenk   "RAMDisk Images" are more or less just data blocks, and their
61186069ff26Swdenk	parameters (address, size) are passed to an OS kernel that is
61196069ff26Swdenk	being started.
61206069ff26Swdenk   "Multi-File Images" contain several images, typically an OS
61216069ff26Swdenk	(Linux) kernel image and one or more data images like
61226069ff26Swdenk	RAMDisks. This construct is useful for instance when you want
61236069ff26Swdenk	to boot over the network using BOOTP etc., where the boot
61246069ff26Swdenk	server provides just a single image file, but you want to get
61256069ff26Swdenk	for instance an OS kernel and a RAMDisk image.
61266069ff26Swdenk
61276069ff26Swdenk	"Multi-File Images" start with a list of image sizes, each
61286069ff26Swdenk	image size (in bytes) specified by an "uint32_t" in network
61296069ff26Swdenk	byte order. This list is terminated by an "(uint32_t)0".
61306069ff26Swdenk	Immediately after the terminating 0 follow the images, one by
61316069ff26Swdenk	one, all aligned on "uint32_t" boundaries (size rounded up to
61326069ff26Swdenk	a multiple of 4 bytes).
61336069ff26Swdenk
61346069ff26Swdenk   "Firmware Images" are binary images containing firmware (like
61356069ff26Swdenk	U-Boot or FPGA images) which usually will be programmed to
61366069ff26Swdenk	flash memory.
61376069ff26Swdenk
61386069ff26Swdenk   "Script files" are command sequences that will be executed by
61396069ff26Swdenk	U-Boot's command interpreter; this feature is especially
61406069ff26Swdenk	useful when you configure U-Boot to use a real shell (hush)
61416069ff26Swdenk	as command interpreter.
61426069ff26Swdenk
614344f074c7SMarek VasutBooting the Linux zImage:
614444f074c7SMarek Vasut-------------------------
614544f074c7SMarek Vasut
614644f074c7SMarek VasutOn some platforms, it's possible to boot Linux zImage. This is done
614744f074c7SMarek Vasutusing the "bootz" command. The syntax of "bootz" command is the same
614844f074c7SMarek Vasutas the syntax of "bootm" command.
614944f074c7SMarek Vasut
61508ac28563STom RiniNote, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
6151017e1f3fSMarek Vasutkernel with raw initrd images. The syntax is slightly different, the
6152017e1f3fSMarek Vasutaddress of the initrd must be augmented by it's size, in the following
6153017e1f3fSMarek Vasutformat: "<initrd addres>:<initrd size>".
6154017e1f3fSMarek Vasut
6155c609719bSwdenk
6156c609719bSwdenkStandalone HOWTO:
6157c609719bSwdenk=================
6158c609719bSwdenk
6159c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and
6160c609719bSwdenkrun "standalone" applications, which can use some resources of
6161c609719bSwdenkU-Boot like console I/O functions or interrupt services.
6162c609719bSwdenk
6163c609719bSwdenkTwo simple examples are included with the sources:
6164c609719bSwdenk
6165c609719bSwdenk"Hello World" Demo:
6166c609719bSwdenk-------------------
6167c609719bSwdenk
6168c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo
6169c609719bSwdenkapplication; it is automatically compiled when you build U-Boot.
6170c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it
6171c609719bSwdenklike that:
6172c609719bSwdenk
6173c609719bSwdenk	=> loads
6174c609719bSwdenk	## Ready for S-Record download ...
6175c609719bSwdenk	~>examples/hello_world.srec
6176c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
6177c609719bSwdenk	[file transfer complete]
6178c609719bSwdenk	[connected]
6179c609719bSwdenk	## Start Addr = 0x00040004
6180c609719bSwdenk
6181c609719bSwdenk	=> go 40004 Hello World! This is a test.
6182c609719bSwdenk	## Starting application at 0x00040004 ...
6183c609719bSwdenk	Hello World
6184c609719bSwdenk	argc = 7
6185c609719bSwdenk	argv[0] = "40004"
6186c609719bSwdenk	argv[1] = "Hello"
6187c609719bSwdenk	argv[2] = "World!"
6188c609719bSwdenk	argv[3] = "This"
6189c609719bSwdenk	argv[4] = "is"
6190c609719bSwdenk	argv[5] = "a"
6191c609719bSwdenk	argv[6] = "test."
6192c609719bSwdenk	argv[7] = "<NULL>"
6193c609719bSwdenk	Hit any key to exit ...
6194c609719bSwdenk
6195c609719bSwdenk	## Application terminated, rc = 0x0
6196c609719bSwdenk
6197c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt
6198c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'.
6199c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second.
6200c609719bSwdenkThe interrupt service routine is trivial, just printing a '.'
6201c609719bSwdenkcharacter, but this is just a demo program. The application can be
6202c609719bSwdenkcontrolled by the following keys:
6203c609719bSwdenk
6204c609719bSwdenk	? - print current values og the CPM Timer registers
6205c609719bSwdenk	b - enable interrupts and start timer
6206c609719bSwdenk	e - stop timer and disable interrupts
6207c609719bSwdenk	q - quit application
6208c609719bSwdenk
6209c609719bSwdenk	=> loads
6210c609719bSwdenk	## Ready for S-Record download ...
6211c609719bSwdenk	~>examples/timer.srec
6212c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
6213c609719bSwdenk	[file transfer complete]
6214c609719bSwdenk	[connected]
6215c609719bSwdenk	## Start Addr = 0x00040004
6216c609719bSwdenk
6217c609719bSwdenk	=> go 40004
6218c609719bSwdenk	## Starting application at 0x00040004 ...
6219c609719bSwdenk	TIMERS=0xfff00980
6220c609719bSwdenk	Using timer 1
6221c609719bSwdenk	  tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
6222c609719bSwdenk
6223c609719bSwdenkHit 'b':
6224c609719bSwdenk	[q, b, e, ?] Set interval 1000000 us
6225c609719bSwdenk	Enabling timer
6226c609719bSwdenkHit '?':
6227c609719bSwdenk	[q, b, e, ?] ........
6228c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
6229c609719bSwdenkHit '?':
6230c609719bSwdenk	[q, b, e, ?] .
6231c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
6232c609719bSwdenkHit '?':
6233c609719bSwdenk	[q, b, e, ?] .
6234c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
6235c609719bSwdenkHit '?':
6236c609719bSwdenk	[q, b, e, ?] .
6237c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
6238c609719bSwdenkHit 'e':
6239c609719bSwdenk	[q, b, e, ?] ...Stopping timer
6240c609719bSwdenkHit 'q':
6241c609719bSwdenk	[q, b, e, ?] ## Application terminated, rc = 0x0
6242c609719bSwdenk
6243c609719bSwdenk
624485ec0bccSwdenkMinicom warning:
624585ec0bccSwdenk================
624685ec0bccSwdenk
62477152b1d0SwdenkOver time, many people have reported problems when trying to use the
624885ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd)
624985ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under
6250f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and
625185ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and
6252e53515a2SKarl O. Pincuse "cu" for S-Record download ("loads" command).  See
6253e53515a2SKarl O. Pinchttp://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
6254e53515a2SKarl O. Pincfor help with kermit.
6255e53515a2SKarl O. Pinc
625685ec0bccSwdenk
625752f52c14SwdenkNevertheless, if you absolutely want to use it try adding this
625852f52c14Swdenkconfiguration to your "File transfer protocols" section:
625952f52c14Swdenk
626052f52c14Swdenk	   Name	   Program			Name U/D FullScr IO-Red. Multi
626152f52c14Swdenk	X  kermit  /usr/bin/kermit -i -l %l -s	 Y    U	   Y	   N	  N
626252f52c14Swdenk	Y  kermit  /usr/bin/kermit -i -l %l -r	 N    D	   Y	   N	  N
626352f52c14Swdenk
626452f52c14Swdenk
6265c609719bSwdenkNetBSD Notes:
6266c609719bSwdenk=============
6267c609719bSwdenk
6268c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host
6269c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx).
6270c609719bSwdenk
6271c609719bSwdenkBuilding requires a cross environment; it is known to work on
6272c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
6273c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make).
6274c609719bSwdenkNote that the cross-powerpc package does not install include files;
6275c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is
6276c609719bSwdenkmissing.  This file has to be installed and patched manually:
6277c609719bSwdenk
6278c609719bSwdenk	# cd /usr/pkg/cross/powerpc-netbsd/include
6279c609719bSwdenk	# mkdir powerpc
6280c609719bSwdenk	# ln -s powerpc machine
6281c609719bSwdenk	# cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
6282c609719bSwdenk	# ${EDIT} powerpc/ansi.h	## must remove __va_list, _BSD_VA_LIST
6283c609719bSwdenk
6284c609719bSwdenkNative builds *don't* work due to incompatibilities between native
6285c609719bSwdenkand U-Boot include files.
6286c609719bSwdenk
6287c609719bSwdenkBooting assumes that (the first part of) the image booted is a
6288c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel
6289c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source
6290c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
62912a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
6292c609719bSwdenk
6293c609719bSwdenk
6294c609719bSwdenkImplementation Internals:
6295c609719bSwdenk=========================
6296c609719bSwdenk
6297c609719bSwdenkThe following is not intended to be a complete description of every
6298c609719bSwdenkimplementation detail. However, it should help to understand the
6299c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom
6300c609719bSwdenkhardware.
6301c609719bSwdenk
6302c609719bSwdenk
6303c609719bSwdenkInitial Stack, Global Data:
6304c609719bSwdenk---------------------------
6305c609719bSwdenk
6306c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot
6307c609719bSwdenkstarts running out of ROM (flash memory), usually without access to
6308c609719bSwdenksystem RAM (because the memory controller is not initialized yet).
6309c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS
6310c609719bSwdenkis not initialized as zero. To be able to get a C environment working
6311c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation
6312c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU
6313c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and
6314c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be
6315c609719bSwdenklocked as (mis-) used as memory, etc.
6316c609719bSwdenk
63177152b1d0Swdenk	Chris Hallinan posted a good summary of these issues to the
63180668236bSWolfgang Denk	U-Boot mailing list:
631943d9616cSwdenk
632043d9616cSwdenk	Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
632143d9616cSwdenk	From: "Chris Hallinan" <clh@net1plus.com>
632243d9616cSwdenk	Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
632343d9616cSwdenk	...
632443d9616cSwdenk
632543d9616cSwdenk	Correct me if I'm wrong, folks, but the way I understand it
632643d9616cSwdenk	is this: Using DCACHE as initial RAM for Stack, etc, does not
632743d9616cSwdenk	require any physical RAM backing up the cache. The cleverness
632843d9616cSwdenk	is that the cache is being used as a temporary supply of
632943d9616cSwdenk	necessary storage before the SDRAM controller is setup. It's
633011ccc33fSMarcel Ziswiler	beyond the scope of this list to explain the details, but you
633143d9616cSwdenk	can see how this works by studying the cache architecture and
633243d9616cSwdenk	operation in the architecture and processor-specific manuals.
633343d9616cSwdenk
633443d9616cSwdenk	OCM is On Chip Memory, which I believe the 405GP has 4K. It
633543d9616cSwdenk	is another option for the system designer to use as an
633611ccc33fSMarcel Ziswiler	initial stack/RAM area prior to SDRAM being available. Either
633743d9616cSwdenk	option should work for you. Using CS 4 should be fine if your
633843d9616cSwdenk	board designers haven't used it for something that would
633943d9616cSwdenk	cause you grief during the initial boot! It is frequently not
634043d9616cSwdenk	used.
634143d9616cSwdenk
63426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
634343d9616cSwdenk	with your processor/board/system design. The default value
634443d9616cSwdenk	you will find in any recent u-boot distribution in
63458a316c9bSStefan Roese	walnut.h should work for you. I'd set it to a value larger
634643d9616cSwdenk	than your SDRAM module. If you have a 64MB SDRAM module, set
634743d9616cSwdenk	it above 400_0000. Just make sure your board has no resources
634843d9616cSwdenk	that are supposed to respond to that address! That code in
634943d9616cSwdenk	start.S has been around a while and should work as is when
635043d9616cSwdenk	you get the config right.
635143d9616cSwdenk
635243d9616cSwdenk	-Chris Hallinan
635343d9616cSwdenk	DS4.COM, Inc.
635443d9616cSwdenk
6355c609719bSwdenkIt is essential to remember this, since it has some impact on the C
6356c609719bSwdenkcode for the initialization procedures:
6357c609719bSwdenk
6358c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt
6359c609719bSwdenk  to write it.
6360c609719bSwdenk
6361b445bbb4SJeremiah Mahler* Do not use any uninitialized global data (or implicitly initialized
6362c609719bSwdenk  as zero data - BSS segment) at all - this is undefined, initiali-
63637152b1d0Swdenk  zation is performed later (when relocating to RAM).
6364c609719bSwdenk
6365c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like
6366c609719bSwdenk  that.
6367c609719bSwdenk
6368c609719bSwdenkHaving only the stack as writable memory limits means we cannot use
6369b445bbb4SJeremiah Mahlernormal global data to share information between the code. But it
6370c609719bSwdenkturned out that the implementation of U-Boot can be greatly
6371c609719bSwdenksimplified by making a global data structure (gd_t) available to all
6372c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_
6373c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of
6374c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we
6375c609719bSwdenkplace a pointer (gd) to the global data into a register which we
6376c609719bSwdenkreserve for this purpose.
6377c609719bSwdenk
63787152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the
6379c609719bSwdenkrelevant  (E)ABI  specifications for the current architecture, and by
6380c609719bSwdenkGCC's implementation.
6381c609719bSwdenk
6382c609719bSwdenkFor PowerPC, the following registers have specific use:
6383c609719bSwdenk	R1:	stack pointer
6384e7670f6cSWolfgang Denk	R2:	reserved for system use
6385c609719bSwdenk	R3-R4:	parameter passing and return values
6386c609719bSwdenk	R5-R10: parameter passing
6387c609719bSwdenk	R13:	small data area pointer
6388c609719bSwdenk	R30:	GOT pointer
6389c609719bSwdenk	R31:	frame pointer
6390c609719bSwdenk
6391e6bee808SJoakim Tjernlund	(U-Boot also uses R12 as internal GOT pointer. r12
6392e6bee808SJoakim Tjernlund	is a volatile register so r12 needs to be reset when
6393e6bee808SJoakim Tjernlund	going back and forth between asm and C)
6394c609719bSwdenk
6395e7670f6cSWolfgang Denk    ==> U-Boot will use R2 to hold a pointer to the global data
6396c609719bSwdenk
6397c609719bSwdenk    Note: on PPC, we could use a static initializer (since the
6398c609719bSwdenk    address of the global data structure is known at compile time),
6399c609719bSwdenk    but it turned out that reserving a register results in somewhat
6400c609719bSwdenk    smaller code - although the code savings are not that big (on
6401c609719bSwdenk    average for all boards 752 bytes for the whole U-Boot image,
6402c609719bSwdenk    624 text + 127 data).
6403c609719bSwdenk
6404c4db335cSRobin GetzOn Blackfin, the normal C ABI (except for P3) is followed as documented here:
64054c58eb55SMike Frysinger	http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
64064c58eb55SMike Frysinger
6407c4db335cSRobin Getz    ==> U-Boot will use P3 to hold a pointer to the global data
64084c58eb55SMike Frysinger
6409c609719bSwdenkOn ARM, the following registers are used:
6410c609719bSwdenk
6411c609719bSwdenk	R0:	function argument word/integer result
6412c609719bSwdenk	R1-R3:	function argument word
641312eba1b4SJeroen Hofstee	R9:	platform specific
641412eba1b4SJeroen Hofstee	R10:	stack limit (used only if stack checking is enabled)
6415c609719bSwdenk	R11:	argument (frame) pointer
6416c609719bSwdenk	R12:	temporary workspace
6417c609719bSwdenk	R13:	stack pointer
6418c609719bSwdenk	R14:	link register
6419c609719bSwdenk	R15:	program counter
6420c609719bSwdenk
642112eba1b4SJeroen Hofstee    ==> U-Boot will use R9 to hold a pointer to the global data
642212eba1b4SJeroen Hofstee
642312eba1b4SJeroen Hofstee    Note: on ARM, only R_ARM_RELATIVE relocations are supported.
6424c609719bSwdenk
64250df01fd3SThomas ChouOn Nios II, the ABI is documented here:
64260df01fd3SThomas Chou	http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
64270df01fd3SThomas Chou
64280df01fd3SThomas Chou    ==> U-Boot will use gp to hold a pointer to the global data
64290df01fd3SThomas Chou
64300df01fd3SThomas Chou    Note: on Nios II, we give "-G0" option to gcc and don't use gp
64310df01fd3SThomas Chou    to access small data sections, so gp is free.
64320df01fd3SThomas Chou
6433afc1ce82SMacpaul LinOn NDS32, the following registers are used:
6434afc1ce82SMacpaul Lin
6435afc1ce82SMacpaul Lin	R0-R1:	argument/return
6436afc1ce82SMacpaul Lin	R2-R5:	argument
6437afc1ce82SMacpaul Lin	R15:	temporary register for assembler
6438afc1ce82SMacpaul Lin	R16:	trampoline register
6439afc1ce82SMacpaul Lin	R28:	frame pointer (FP)
6440afc1ce82SMacpaul Lin	R29:	global pointer (GP)
6441afc1ce82SMacpaul Lin	R30:	link register (LP)
6442afc1ce82SMacpaul Lin	R31:	stack pointer (SP)
6443afc1ce82SMacpaul Lin	PC:	program counter (PC)
6444afc1ce82SMacpaul Lin
6445afc1ce82SMacpaul Lin    ==> U-Boot will use R10 to hold a pointer to the global data
6446afc1ce82SMacpaul Lin
6447d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
6448d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much.
6449c609719bSwdenk
6450c609719bSwdenkMemory Management:
6451c609719bSwdenk------------------
6452c609719bSwdenk
6453c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the
6454c609719bSwdenkMMU is not used either for address mapping nor for memory protection.
6455c609719bSwdenk
6456c609719bSwdenkThe available memory is mapped to fixed addresses using the memory
6457c609719bSwdenkcontroller. In this process, a contiguous block is formed for each
6458c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several
6459c609719bSwdenkphysical memory banks.
6460c609719bSwdenk
6461c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on
6462c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
6463c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself
6464c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some
64656d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
6466c609719bSwdenkconfiguration setting]. Below that, a structure with global Board
6467c609719bSwdenkInfo data is placed, followed by the stack (growing downward).
6468c609719bSwdenk
6469c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB
6470c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF).
6471c609719bSwdenk
6472c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like
6473c609719bSwdenkthis:
6474c609719bSwdenk
6475c609719bSwdenk	0x0000 0000	Exception Vector code
6476c609719bSwdenk	      :
6477c609719bSwdenk	0x0000 1FFF
6478c609719bSwdenk	0x0000 2000	Free for Application Use
6479c609719bSwdenk	      :
6480c609719bSwdenk	      :
6481c609719bSwdenk
6482c609719bSwdenk	      :
6483c609719bSwdenk	      :
6484c609719bSwdenk	0x00FB FF20	Monitor Stack (Growing downward)
6485c609719bSwdenk	0x00FB FFAC	Board Info Data and permanent copy of global data
6486c609719bSwdenk	0x00FC 0000	Malloc Arena
6487c609719bSwdenk	      :
6488c609719bSwdenk	0x00FD FFFF
6489c609719bSwdenk	0x00FE 0000	RAM Copy of Monitor Code
6490c609719bSwdenk	...		eventually: LCD or video framebuffer
6491c609719bSwdenk	...		eventually: pRAM (Protected RAM - unchanged by reset)
6492c609719bSwdenk	0x00FF FFFF	[End of RAM]
6493c609719bSwdenk
6494c609719bSwdenk
6495c609719bSwdenkSystem Initialization:
6496c609719bSwdenk----------------------
6497c609719bSwdenk
6498c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point
649911ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset
6500c609719bSwdenkconfiguration for CS0# this is a mirror of the on board Flash memory.
65017152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address.
6502c609719bSwdenkTo be able to implement the initialization code in C, a (small!)
6503c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs
6504c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked
6505c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core,
6506c609719bSwdenkthe caches and the SIU.
6507c609719bSwdenk
6508c609719bSwdenkNext, all (potentially) available memory banks are mapped using a
6509c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries
6510c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
6511c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
6512c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a
6513c609719bSwdenksimple memory test is run that determines the size of the SDRAM
6514c609719bSwdenkbanks.
6515c609719bSwdenk
6516c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of
65177152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first
6518c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address
6519c609719bSwdenk0x00000000, with any additional banks following immediately to create
6520c609719bSwdenkcontiguous memory starting from 0.
6521c609719bSwdenk
6522c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area
6523c609719bSwdenkand allocates memory for use by malloc() and for the global Board
6524c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM
6525c609719bSwdenkpages, and the final stack is set up.
6526c609719bSwdenk
6527c609719bSwdenkOnly after this relocation will you have a "normal" C environment;
6528c609719bSwdenkuntil that you are restricted in several ways, mostly because you are
6529c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a
6530c609719bSwdenknew address in RAM.
6531c609719bSwdenk
6532c609719bSwdenk
6533c609719bSwdenkU-Boot Porting Guide:
6534c609719bSwdenk----------------------
6535c609719bSwdenk
6536c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
65376aff3115Swdenklist, October 2002]
6538c609719bSwdenk
6539c609719bSwdenk
6540c609719bSwdenkint main(int argc, char *argv[])
6541c609719bSwdenk{
6542c609719bSwdenk	sighandler_t no_more_time;
6543c609719bSwdenk
6544c609719bSwdenk	signal(SIGALRM, no_more_time);
6545c609719bSwdenk	alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
6546c609719bSwdenk
6547c609719bSwdenk	if (available_money > available_manpower) {
65486c3fef28SJerry Van Baren		Pay consultant to port U-Boot;
6549c609719bSwdenk		return 0;
6550c609719bSwdenk	}
6551c609719bSwdenk
6552c609719bSwdenk	Download latest U-Boot source;
6553c609719bSwdenk
65540668236bSWolfgang Denk	Subscribe to u-boot mailing list;
65556aff3115Swdenk
65566c3fef28SJerry Van Baren	if (clueless)
6557c609719bSwdenk		email("Hi, I am new to U-Boot, how do I get started?");
6558c609719bSwdenk
6559c609719bSwdenk	while (learning) {
6560c609719bSwdenk		Read the README file in the top level directory;
65617cb22f97Swdenk		Read http://www.denx.de/twiki/bin/view/DULG/Manual;
65626c3fef28SJerry Van Baren		Read applicable doc/*.README;
6563c609719bSwdenk		Read the source, Luke;
65646c3fef28SJerry Van Baren		/* find . -name "*.[chS]" | xargs grep -i <keyword> */
6565c609719bSwdenk	}
6566c609719bSwdenk
65676c3fef28SJerry Van Baren	if (available_money > toLocalCurrency ($2500))
65686c3fef28SJerry Van Baren		Buy a BDI3000;
65696c3fef28SJerry Van Baren	else
6570c609719bSwdenk		Add a lot of aggravation and time;
6571c609719bSwdenk
65726c3fef28SJerry Van Baren	if (a similar board exists) {	/* hopefully... */
65736c3fef28SJerry Van Baren		cp -a board/<similar> board/<myboard>
65746c3fef28SJerry Van Baren		cp include/configs/<similar>.h include/configs/<myboard>.h
65756c3fef28SJerry Van Baren	} else {
6576c609719bSwdenk		Create your own board support subdirectory;
65776c3fef28SJerry Van Baren		Create your own board include/configs/<myboard>.h file;
65786c3fef28SJerry Van Baren	}
65796c3fef28SJerry Van Baren	Edit new board/<myboard> files
65806c3fef28SJerry Van Baren	Edit new include/configs/<myboard>.h
6581c609719bSwdenk
65826c3fef28SJerry Van Baren	while (!accepted) {
6583c609719bSwdenk		while (!running) {
6584c609719bSwdenk			do {
6585c609719bSwdenk				Add / modify source code;
6586c609719bSwdenk			} until (compiles);
6587c609719bSwdenk			Debug;
6588c609719bSwdenk			if (clueless)
6589c609719bSwdenk				email("Hi, I am having problems...");
6590c609719bSwdenk		}
65916c3fef28SJerry Van Baren		Send patch file to the U-Boot email list;
65926c3fef28SJerry Van Baren		if (reasonable critiques)
65936c3fef28SJerry Van Baren			Incorporate improvements from email list code review;
65946c3fef28SJerry Van Baren		else
65956c3fef28SJerry Van Baren			Defend code as written;
65966c3fef28SJerry Van Baren	}
6597c609719bSwdenk
6598c609719bSwdenk	return 0;
6599c609719bSwdenk}
6600c609719bSwdenk
6601c609719bSwdenkvoid no_more_time (int sig)
6602c609719bSwdenk{
6603c609719bSwdenk      hire_a_guru();
6604c609719bSwdenk}
6605c609719bSwdenk
6606c609719bSwdenk
6607c609719bSwdenkCoding Standards:
6608c609719bSwdenk-----------------
6609c609719bSwdenk
6610c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel
66112c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script
66127ca9296eSWolfgang Denk"scripts/Lindent" in your Linux kernel source directory.
6613c609719bSwdenk
66142c051651SDetlev ZundelSource files originating from a different project (for example the
66152c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not
6616b445bbb4SJeremiah Mahlerreformatted to ease subsequent migration to newer versions of those
66172c051651SDetlev Zundelsources.
66182c051651SDetlev Zundel
66192c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in
66202c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//)
66212c051651SDetlev Zundelin your code.
6622c609719bSwdenk
6623c178d3daSwdenkPlease also stick to the following formatting rules:
6624180d3f74Swdenk- remove any trailing white space
66257ca9296eSWolfgang Denk- use TAB characters for indentation and vertical alignment, not spaces
6626180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds
66277ca9296eSWolfgang Denk- do not add more than 2 consecutive empty lines to source files
6628180d3f74Swdenk- do not add trailing empty lines to source files
6629180d3f74Swdenk
6630c609719bSwdenkSubmissions which do not conform to the standards may be returned
6631c609719bSwdenkwith a request to reformat the changes.
6632c609719bSwdenk
6633c609719bSwdenk
6634c609719bSwdenkSubmitting Patches:
6635c609719bSwdenk-------------------
6636c609719bSwdenk
6637c609719bSwdenkSince the number of patches for U-Boot is growing, we need to
6638c609719bSwdenkestablish some rules. Submissions which do not conform to these rules
6639c609719bSwdenkmay be rejected, even when they contain important and valuable stuff.
6640c609719bSwdenk
66410d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details.
6642218ca724SWolfgang Denk
66430668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
66440668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot
66450668236bSWolfgang Denk
6646c609719bSwdenkWhen you send a patch, please include the following information with
6647c609719bSwdenkit:
6648c609719bSwdenk
6649c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes
6650c609719bSwdenk  this bug. Please try to include a way of demonstrating that the
6651c609719bSwdenk  patch actually fixes something.
6652c609719bSwdenk
6653c609719bSwdenk* For new features: a description of the feature and your
6654c609719bSwdenk  implementation.
6655c609719bSwdenk
6656c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch)
6657c609719bSwdenk
6658c609719bSwdenk* For major contributions, your entry to the CREDITS file
6659c609719bSwdenk
666027af930eSAlbert ARIBAUD* When you add support for a new board, don't forget to add a
666127af930eSAlbert ARIBAUD  maintainer e-mail address to the boards.cfg file, too.
6662c609719bSwdenk
6663c609719bSwdenk* If your patch adds new configuration options, don't forget to
6664c609719bSwdenk  document these in the README file.
6665c609719bSwdenk
6666218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly*
6667218ca724SWolfgang Denk  recommended) you can easily generate the patch using the
66687ca9296eSWolfgang Denk  "git format-patch". If you then use "git send-email" to send it to
6669218ca724SWolfgang Denk  the U-Boot mailing list, you will avoid most of the common problems
6670218ca724SWolfgang Denk  with some other mail clients.
6671c609719bSwdenk
6672218ca724SWolfgang Denk  If you cannot use git, use "diff -purN OLD NEW". If your version of
6673218ca724SWolfgang Denk  diff does not support these options, then get the latest version of
6674218ca724SWolfgang Denk  GNU diff.
66756dff5529Swdenk
6676218ca724SWolfgang Denk  The current directory when running this command shall be the parent
6677218ca724SWolfgang Denk  directory of the U-Boot source tree (i. e. please make sure that
6678218ca724SWolfgang Denk  your patch includes sufficient directory information for the
6679218ca724SWolfgang Denk  affected files).
6680218ca724SWolfgang Denk
6681218ca724SWolfgang Denk  We prefer patches as plain text. MIME attachments are discouraged,
6682218ca724SWolfgang Denk  and compressed attachments must not be used.
6683c609719bSwdenk
668452f52c14Swdenk* If one logical set of modifications affects or creates several
668552f52c14Swdenk  files, all these changes shall be submitted in a SINGLE patch file.
668652f52c14Swdenk
668752f52c14Swdenk* Changesets that contain different, unrelated modifications shall be
668852f52c14Swdenk  submitted as SEPARATE patches, one patch per changeset.
668952f52c14Swdenk
669052f52c14Swdenk
6691c609719bSwdenkNotes:
6692c609719bSwdenk
6693c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched
6694c609719bSwdenk  source tree and make sure that no errors or warnings are reported
6695c609719bSwdenk  for any of the boards.
6696c609719bSwdenk
6697c609719bSwdenk* Keep your modifications to the necessary minimum: A patch
6698c609719bSwdenk  containing several unrelated changes or arbitrary reformats will be
6699c609719bSwdenk  returned with a request to re-formatting / split it.
6700c609719bSwdenk
6701c609719bSwdenk* If you modify existing code, make sure that your new code does not
6702c609719bSwdenk  add to the memory footprint of the code ;-) Small is beautiful!
6703c609719bSwdenk  When adding new features, these should compile conditionally only
6704c609719bSwdenk  (using #ifdef), and the resulting code with the new feature
6705c609719bSwdenk  disabled must not need more memory than the old code without your
6706c609719bSwdenk  modification.
670790dc6704Swdenk
67080668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the
67090668236bSWolfgang Denk  u-boot mailing list. Bigger patches will be moderated. If they are
67100668236bSWolfgang Denk  reasonable and not too big, they will be acknowledged. But patches
67110668236bSWolfgang Denk  bigger than the size limit should be avoided.
6712