xref: /openbmc/u-boot/README (revision 9f074e67)
1c609719bSwdenk#
2eca3aeb3SWolfgang Denk# (C) Copyright 2000 - 2013
3c609719bSwdenk# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4c609719bSwdenk#
5eca3aeb3SWolfgang Denk# SPDX-License-Identifier:	GPL-2.0+
6c609719bSwdenk#
7c609719bSwdenk
8c609719bSwdenkSummary:
9c609719bSwdenk========
10c609719bSwdenk
1124ee89b9SwdenkThis directory contains the source code for U-Boot, a boot loader for
12e86e5a07SwdenkEmbedded boards based on PowerPC, ARM, MIPS and several other
13e86e5a07Swdenkprocessors, which can be installed in a boot ROM and used to
14e86e5a07Swdenkinitialize and test the hardware or to download and run application
15e86e5a07Swdenkcode.
16c609719bSwdenk
17c609719bSwdenkThe development of U-Boot is closely related to Linux: some parts of
1824ee89b9Swdenkthe source code originate in the Linux source tree, we have some
1924ee89b9Swdenkheader files in common, and special provision has been made to
20c609719bSwdenksupport booting of Linux images.
21c609719bSwdenk
22c609719bSwdenkSome attention has been paid to make this software easily
23c609719bSwdenkconfigurable and extendable. For instance, all monitor commands are
24c609719bSwdenkimplemented with the same call interface, so that it's very easy to
25c609719bSwdenkadd new commands. Also, instead of permanently adding rarely used
26c609719bSwdenkcode (for instance hardware test utilities) to the monitor, you can
27c609719bSwdenkload and run it dynamically.
28c609719bSwdenk
29c609719bSwdenk
30c609719bSwdenkStatus:
31c609719bSwdenk=======
32c609719bSwdenk
33c609719bSwdenkIn general, all boards for which a configuration option exists in the
34c609719bSwdenkMakefile have been tested to some extent and can be considered
35c609719bSwdenk"working". In fact, many of them are used in production systems.
36c609719bSwdenk
37c609719bSwdenkIn case of problems see the CHANGELOG and CREDITS files to find out
3827af930eSAlbert ARIBAUDwho contributed the specific port. The boards.cfg file lists board
39218ca724SWolfgang Denkmaintainers.
40c609719bSwdenk
41adb9d851SRobert P. J. DayNote: There is no CHANGELOG file in the actual U-Boot source tree;
42adb9d851SRobert P. J. Dayit can be created dynamically from the Git log using:
43adb9d851SRobert P. J. Day
44adb9d851SRobert P. J. Day	make CHANGELOG
45adb9d851SRobert P. J. Day
46c609719bSwdenk
47c609719bSwdenkWhere to get help:
48c609719bSwdenk==================
49c609719bSwdenk
50c609719bSwdenkIn case you have questions about, problems with or contributions for
51c609719bSwdenkU-Boot you should send a message to the U-Boot mailing list at
520c32565fSPeter Tyser<u-boot@lists.denx.de>. There is also an archive of previous traffic
530c32565fSPeter Tyseron the mailing list - please search the archive before asking FAQ's.
540c32565fSPeter TyserPlease see http://lists.denx.de/pipermail/u-boot and
550c32565fSPeter Tyserhttp://dir.gmane.org/gmane.comp.boot-loaders.u-boot
56c609719bSwdenk
57c609719bSwdenk
58218ca724SWolfgang DenkWhere to get source code:
59218ca724SWolfgang Denk=========================
60218ca724SWolfgang Denk
61218ca724SWolfgang DenkThe U-Boot source code is maintained in the git repository at
62218ca724SWolfgang Denkgit://www.denx.de/git/u-boot.git ; you can browse it online at
63218ca724SWolfgang Denkhttp://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
64218ca724SWolfgang Denk
65218ca724SWolfgang DenkThe "snapshot" links on this page allow you to download tarballs of
6611ccc33fSMarcel Ziswilerany version you might be interested in. Official releases are also
67218ca724SWolfgang Denkavailable for FTP download from the ftp://ftp.denx.de/pub/u-boot/
68218ca724SWolfgang Denkdirectory.
69218ca724SWolfgang Denk
70d4ee711dSAnatolij GustschinPre-built (and tested) images are available from
71218ca724SWolfgang Denkftp://ftp.denx.de/pub/u-boot/images/
72218ca724SWolfgang Denk
73218ca724SWolfgang Denk
74c609719bSwdenkWhere we come from:
75c609719bSwdenk===================
76c609719bSwdenk
77c609719bSwdenk- start from 8xxrom sources
7824ee89b9Swdenk- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
79c609719bSwdenk- clean up code
80c609719bSwdenk- make it easier to add custom boards
81c609719bSwdenk- make it possible to add other [PowerPC] CPUs
82c609719bSwdenk- extend functions, especially:
83c609719bSwdenk  * Provide extended interface to Linux boot loader
84c609719bSwdenk  * S-Record download
85c609719bSwdenk  * network boot
8611ccc33fSMarcel Ziswiler  * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
8724ee89b9Swdenk- create ARMBoot project (http://sourceforge.net/projects/armboot)
88c609719bSwdenk- add other CPU families (starting with ARM)
8924ee89b9Swdenk- create U-Boot project (http://sourceforge.net/projects/u-boot)
900d28f34bSMagnus Lilja- current project page: see http://www.denx.de/wiki/U-Boot
9124ee89b9Swdenk
9224ee89b9Swdenk
9324ee89b9SwdenkNames and Spelling:
9424ee89b9Swdenk===================
9524ee89b9Swdenk
9624ee89b9SwdenkThe "official" name of this project is "Das U-Boot". The spelling
9724ee89b9Swdenk"U-Boot" shall be used in all written text (documentation, comments
9824ee89b9Swdenkin source files etc.). Example:
9924ee89b9Swdenk
10024ee89b9Swdenk	This is the README file for the U-Boot project.
10124ee89b9Swdenk
10224ee89b9SwdenkFile names etc. shall be based on the string "u-boot". Examples:
10324ee89b9Swdenk
10424ee89b9Swdenk	include/asm-ppc/u-boot.h
10524ee89b9Swdenk
10624ee89b9Swdenk	#include <asm/u-boot.h>
10724ee89b9Swdenk
10824ee89b9SwdenkVariable names, preprocessor constants etc. shall be either based on
10924ee89b9Swdenkthe string "u_boot" or on "U_BOOT". Example:
11024ee89b9Swdenk
11124ee89b9Swdenk	U_BOOT_VERSION		u_boot_logo
11224ee89b9Swdenk	IH_OS_U_BOOT		u_boot_hush_start
113c609719bSwdenk
114c609719bSwdenk
11593f19cc0SwdenkVersioning:
11693f19cc0Swdenk===========
11793f19cc0Swdenk
118360d883aSThomas WeberStarting with the release in October 2008, the names of the releases
119360d883aSThomas Weberwere changed from numerical release numbers without deeper meaning
120360d883aSThomas Weberinto a time stamp based numbering. Regular releases are identified by
121360d883aSThomas Webernames consisting of the calendar year and month of the release date.
122360d883aSThomas WeberAdditional fields (if present) indicate release candidates or bug fix
123360d883aSThomas Weberreleases in "stable" maintenance trees.
12493f19cc0Swdenk
125360d883aSThomas WeberExamples:
126360d883aSThomas Weber	U-Boot v2009.11	    - Release November 2009
127360d883aSThomas Weber	U-Boot v2009.11.1   - Release 1 in version November 2009 stable tree
128360d883aSThomas Weber	U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release
12993f19cc0Swdenk
13093f19cc0Swdenk
131c609719bSwdenkDirectory Hierarchy:
132c609719bSwdenk====================
133c609719bSwdenk
1348d321b81SPeter Tyser/arch			Architecture specific files
1356eae68e4SMasahiro Yamada  /arc			Files generic to ARC architecture
1366eae68e4SMasahiro Yamada    /cpu		CPU specific files
1376eae68e4SMasahiro Yamada      /arc700		Files specific to ARC 700 CPUs
1386eae68e4SMasahiro Yamada    /lib		Architecture specific library files
1398d321b81SPeter Tyser  /arm			Files generic to ARM architecture
1408d321b81SPeter Tyser    /cpu		CPU specific files
1418d321b81SPeter Tyser      /arm720t		Files specific to ARM 720 CPUs
1428d321b81SPeter Tyser      /arm920t		Files specific to ARM 920 CPUs
1436eb0921aSAndreas Bießmann	/at91		Files specific to Atmel AT91RM9200 CPU
1448d321b81SPeter Tyser	/imx		Files specific to Freescale MC9328 i.MX CPUs
1458d321b81SPeter Tyser	/s3c24x0	Files specific to Samsung S3C24X0 CPUs
1468d321b81SPeter Tyser      /arm926ejs	Files specific to ARM 926 CPUs
1478d321b81SPeter Tyser      /arm1136		Files specific to ARM 1136 CPUs
1488d321b81SPeter Tyser      /pxa		Files specific to Intel XScale PXA CPUs
1498d321b81SPeter Tyser      /sa1100		Files specific to Intel StrongARM SA1100 CPUs
1508d321b81SPeter Tyser    /lib		Architecture specific library files
1518d321b81SPeter Tyser  /avr32		Files generic to AVR32 architecture
1528d321b81SPeter Tyser    /cpu		CPU specific files
1538d321b81SPeter Tyser    /lib		Architecture specific library files
1548d321b81SPeter Tyser  /blackfin		Files generic to Analog Devices Blackfin architecture
1558d321b81SPeter Tyser    /cpu		CPU specific files
1568d321b81SPeter Tyser    /lib		Architecture specific library files
1578d321b81SPeter Tyser  /m68k			Files generic to m68k architecture
1588d321b81SPeter Tyser    /cpu		CPU specific files
1598d321b81SPeter Tyser      /mcf52x2		Files specific to Freescale ColdFire MCF52x2 CPUs
1608d321b81SPeter Tyser      /mcf5227x		Files specific to Freescale ColdFire MCF5227x CPUs
1618d321b81SPeter Tyser      /mcf532x		Files specific to Freescale ColdFire MCF5329 CPUs
1628d321b81SPeter Tyser      /mcf5445x		Files specific to Freescale ColdFire MCF5445x CPUs
1638d321b81SPeter Tyser      /mcf547x_8x	Files specific to Freescale ColdFire MCF547x_8x CPUs
1648d321b81SPeter Tyser    /lib		Architecture specific library files
1658d321b81SPeter Tyser  /microblaze		Files generic to microblaze architecture
1668d321b81SPeter Tyser    /cpu		CPU specific files
1678d321b81SPeter Tyser    /lib		Architecture specific library files
1688d321b81SPeter Tyser  /mips			Files generic to MIPS architecture
1698d321b81SPeter Tyser    /cpu		CPU specific files
17092bbd64eSDaniel Schwierzeck      /mips32		Files specific to MIPS32 CPUs
1716eae68e4SMasahiro Yamada      /mips64		Files specific to MIPS64 CPUs
1728d321b81SPeter Tyser    /lib		Architecture specific library files
173afc1ce82SMacpaul Lin  /nds32		Files generic to NDS32 architecture
174afc1ce82SMacpaul Lin    /cpu		CPU specific files
175afc1ce82SMacpaul Lin      /n1213		Files specific to Andes Technology N1213 CPUs
176afc1ce82SMacpaul Lin    /lib		Architecture specific library files
1778d321b81SPeter Tyser  /nios2		Files generic to Altera NIOS2 architecture
1788d321b81SPeter Tyser    /cpu		CPU specific files
1798d321b81SPeter Tyser    /lib		Architecture specific library files
18033c7731bSRobert P. J. Day  /openrisc		Files generic to OpenRISC architecture
18133c7731bSRobert P. J. Day    /cpu		CPU specific files
18233c7731bSRobert P. J. Day    /lib		Architecture specific library files
183a47a12beSStefan Roese  /powerpc		Files generic to PowerPC architecture
1848d321b81SPeter Tyser    /cpu		CPU specific files
1858d321b81SPeter Tyser      /74xx_7xx		Files specific to Freescale MPC74xx and 7xx CPUs
1868d321b81SPeter Tyser      /mpc5xx		Files specific to Freescale MPC5xx CPUs
1878d321b81SPeter Tyser      /mpc5xxx		Files specific to Freescale MPC5xxx CPUs
1888d321b81SPeter Tyser      /mpc8xx		Files specific to Freescale MPC8xx CPUs
1898d321b81SPeter Tyser      /mpc824x		Files specific to Freescale MPC824x CPUs
1908d321b81SPeter Tyser      /mpc8260		Files specific to Freescale MPC8260 CPUs
1918d321b81SPeter Tyser      /mpc85xx		Files specific to Freescale MPC85xx CPUs
1928d321b81SPeter Tyser      /ppc4xx		Files specific to AMCC PowerPC 4xx CPUs
1938d321b81SPeter Tyser    /lib		Architecture specific library files
1948d321b81SPeter Tyser  /sh			Files generic to SH architecture
1958d321b81SPeter Tyser    /cpu		CPU specific files
1968d321b81SPeter Tyser      /sh2		Files specific to sh2 CPUs
1978d321b81SPeter Tyser      /sh3		Files specific to sh3 CPUs
1988d321b81SPeter Tyser      /sh4		Files specific to sh4 CPUs
1998d321b81SPeter Tyser    /lib		Architecture specific library files
2008d321b81SPeter Tyser  /sparc		Files generic to SPARC architecture
2018d321b81SPeter Tyser    /cpu		CPU specific files
2028d321b81SPeter Tyser      /leon2		Files specific to Gaisler LEON2 SPARC CPU
2038d321b81SPeter Tyser      /leon3		Files specific to Gaisler LEON3 SPARC CPU
2048d321b81SPeter Tyser    /lib		Architecture specific library files
20533c7731bSRobert P. J. Day  /x86			Files generic to x86 architecture
20633c7731bSRobert P. J. Day    /cpu		CPU specific files
20733c7731bSRobert P. J. Day    /lib		Architecture specific library files
2088d321b81SPeter Tyser/api			Machine/arch independent API for external apps
2098d321b81SPeter Tyser/board			Board dependent files
2108d321b81SPeter Tyser/common			Misc architecture independent functions
2118d321b81SPeter Tyser/disk			Code for disk drive partition handling
2128d321b81SPeter Tyser/doc			Documentation (don't expect too much)
2138d321b81SPeter Tyser/drivers		Commonly used device drivers
21433c7731bSRobert P. J. Day/dts			Contains Makefile for building internal U-Boot fdt.
2158d321b81SPeter Tyser/examples		Example code for standalone applications, etc.
2168d321b81SPeter Tyser/fs			Filesystem code (cramfs, ext2, jffs2, etc.)
2178d321b81SPeter Tyser/include		Header Files
2188d321b81SPeter Tyser/lib			Files generic to all architectures
2198d321b81SPeter Tyser  /libfdt		Library files to support flattened device trees
2208d321b81SPeter Tyser  /lzma			Library files to support LZMA decompression
2218d321b81SPeter Tyser  /lzo			Library files to support LZO decompression
2228d321b81SPeter Tyser/net			Networking code
2238d321b81SPeter Tyser/post			Power On Self Test
22433c7731bSRobert P. J. Day/spl			Secondary Program Loader framework
2258d321b81SPeter Tyser/tools			Tools to build S-Record or U-Boot images, etc.
226c609719bSwdenk
227c609719bSwdenkSoftware Configuration:
228c609719bSwdenk=======================
229c609719bSwdenk
230c609719bSwdenkConfiguration is usually done using C preprocessor defines; the
231c609719bSwdenkrationale behind that is to avoid dead code whenever possible.
232c609719bSwdenk
233c609719bSwdenkThere are two classes of configuration variables:
234c609719bSwdenk
235c609719bSwdenk* Configuration _OPTIONS_:
236c609719bSwdenk  These are selectable by the user and have names beginning with
237c609719bSwdenk  "CONFIG_".
238c609719bSwdenk
239c609719bSwdenk* Configuration _SETTINGS_:
240c609719bSwdenk  These depend on the hardware etc. and should not be meddled with if
241c609719bSwdenk  you don't know what you're doing; they have names beginning with
2426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  "CONFIG_SYS_".
243c609719bSwdenk
244c609719bSwdenkLater we will add a configuration tool - probably similar to or even
245c609719bSwdenkidentical to what's used for the Linux kernel. Right now, we have to
246c609719bSwdenkdo the configuration by hand, which means creating some symbolic
247c609719bSwdenklinks and editing some configuration files. We use the TQM8xxL boards
248c609719bSwdenkas an example here.
249c609719bSwdenk
250c609719bSwdenk
251c609719bSwdenkSelection of Processor Architecture and Board Type:
252c609719bSwdenk---------------------------------------------------
253c609719bSwdenk
254c609719bSwdenkFor all supported boards there are ready-to-use default
255ab584d67SHolger Freytherconfigurations available; just type "make <board_name>_defconfig".
256c609719bSwdenk
257c609719bSwdenkExample: For a TQM823L module type:
258c609719bSwdenk
259c609719bSwdenk	cd u-boot
260ab584d67SHolger Freyther	make TQM823L_defconfig
261c609719bSwdenk
26211ccc33fSMarcel ZiswilerFor the Cogent platform, you need to specify the CPU type as well;
263ab584d67SHolger Freythere.g. "make cogent_mpc8xx_defconfig". And also configure the cogent
264c609719bSwdenkdirectory according to the instructions in cogent/README.
265c609719bSwdenk
266c609719bSwdenk
26775b3c3aaSSimon GlassSandbox Environment:
26875b3c3aaSSimon Glass--------------------
26975b3c3aaSSimon Glass
27075b3c3aaSSimon GlassU-Boot can be built natively to run on a Linux host using the 'sandbox'
27175b3c3aaSSimon Glassboard. This allows feature development which is not board- or architecture-
27275b3c3aaSSimon Glassspecific to be undertaken on a native platform. The sandbox is also used to
27375b3c3aaSSimon Glassrun some of U-Boot's tests.
27475b3c3aaSSimon Glass
2756b1978f8SJagannadha Sutradharudu TekiSee board/sandbox/README.sandbox for more details.
27675b3c3aaSSimon Glass
27775b3c3aaSSimon Glass
278c609719bSwdenkConfiguration Options:
279c609719bSwdenk----------------------
280c609719bSwdenk
281c609719bSwdenkConfiguration depends on the combination of board and CPU type; all
282c609719bSwdenksuch information is kept in a configuration file
283c609719bSwdenk"include/configs/<board_name>.h".
284c609719bSwdenk
285c609719bSwdenkExample: For a TQM823L module, all configuration settings are in
286c609719bSwdenk"include/configs/TQM823L.h".
287c609719bSwdenk
288c609719bSwdenk
2897f6c2cbcSwdenkMany of the options are named exactly as the corresponding Linux
2907f6c2cbcSwdenkkernel configuration options. The intention is to make it easier to
2917f6c2cbcSwdenkbuild a config tool - later.
2927f6c2cbcSwdenk
2937f6c2cbcSwdenk
294c609719bSwdenkThe following options need to be configured:
295c609719bSwdenk
2962628114eSKim Phillips- CPU Type:	Define exactly one, e.g. CONFIG_MPC85XX.
297c609719bSwdenk
2982628114eSKim Phillips- Board Type:	Define exactly one, e.g. CONFIG_MPC8540ADS.
2996ccec449SWolfgang Denk
3006ccec449SWolfgang Denk- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
30109ea0de0SHaavard Skinnemoen		Define exactly one, e.g. CONFIG_ATSTK1002
302c609719bSwdenk
303c609719bSwdenk- CPU Module Type: (if CONFIG_COGENT is defined)
304c609719bSwdenk		Define exactly one of
305c609719bSwdenk		CONFIG_CMA286_60_OLD
306c609719bSwdenk--- FIXME --- not tested yet:
307c609719bSwdenk		CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
308c609719bSwdenk		CONFIG_CMA287_23, CONFIG_CMA287_50
309c609719bSwdenk
310c609719bSwdenk- Motherboard Type: (if CONFIG_COGENT is defined)
311c609719bSwdenk		Define exactly one of
312c609719bSwdenk		CONFIG_CMA101, CONFIG_CMA102
313c609719bSwdenk
314c609719bSwdenk- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
315c609719bSwdenk		Define one or more of
316c609719bSwdenk		CONFIG_CMA302
317c609719bSwdenk
318c609719bSwdenk- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
319c609719bSwdenk		Define one or more of
320c609719bSwdenk		CONFIG_LCD_HEARTBEAT	- update a character position on
32111ccc33fSMarcel Ziswiler					  the LCD display every second with
322c609719bSwdenk					  a "rotator" |\-/|\-/
323c609719bSwdenk
324cf946c6dSLei Wen- Marvell Family Member
325cf946c6dSLei Wen		CONFIG_SYS_MVFS		- define it if you want to enable
326cf946c6dSLei Wen					  multiple fs option at one time
327cf946c6dSLei Wen					  for marvell soc family
328cf946c6dSLei Wen
329c609719bSwdenk- MPC824X Family Member (if CONFIG_MPC824X is defined)
330c609719bSwdenk		Define exactly one of
331c609719bSwdenk		CONFIG_MPC8240, CONFIG_MPC8245
332c609719bSwdenk
33311ccc33fSMarcel Ziswiler- 8xx CPU Options: (if using an MPC8xx CPU)
33466ca92a5Swdenk		CONFIG_8xx_GCLK_FREQ	- deprecated: CPU clock if
33566ca92a5Swdenk					  get_gclk_freq() cannot work
3365da627a4Swdenk					  e.g. if there is no 32KHz
3375da627a4Swdenk					  reference PIT/RTC clock
33866ca92a5Swdenk		CONFIG_8xx_OSCLK	- PLL input clock (either EXTCLK
33966ca92a5Swdenk					  or XTAL/EXTAL)
340c609719bSwdenk
34166ca92a5Swdenk- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
3426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MIN
3436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MAX
34466ca92a5Swdenk		CONFIG_8xx_CPUCLK_DEFAULT
34575d1ea7fSwdenk			See doc/README.MPC866
34675d1ea7fSwdenk
3476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MEASURE_CPUCLK
34875d1ea7fSwdenk
34975d1ea7fSwdenk		Define this to measure the actual CPU clock instead
35075d1ea7fSwdenk		of relying on the correctness of the configured
35175d1ea7fSwdenk		values. Mostly useful for board bringup to make sure
35275d1ea7fSwdenk		the PLL is locked at the intended frequency. Note
35375d1ea7fSwdenk		that this requires a (stable) reference clock (32 kHz
3546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		RTC clock or CONFIG_SYS_8XX_XIN)
35575d1ea7fSwdenk
356506f3918SHeiko Schocher		CONFIG_SYS_DELAYED_ICACHE
357506f3918SHeiko Schocher
358506f3918SHeiko Schocher		Define this option if you want to enable the
359506f3918SHeiko Schocher		ICache only when Code runs from RAM.
360506f3918SHeiko Schocher
36166412c63SKumar Gala- 85xx CPU Options:
362ffd06e02SYork Sun		CONFIG_SYS_PPC64
363ffd06e02SYork Sun
364ffd06e02SYork Sun		Specifies that the core is a 64-bit PowerPC implementation (implements
365ffd06e02SYork Sun		the "64" category of the Power ISA). This is necessary for ePAPR
366ffd06e02SYork Sun		compliance, among other possible reasons.
367ffd06e02SYork Sun
36866412c63SKumar Gala		CONFIG_SYS_FSL_TBCLK_DIV
36966412c63SKumar Gala
37066412c63SKumar Gala		Defines the core time base clock divider ratio compared to the
37166412c63SKumar Gala		system clock.  On most PQ3 devices this is 8, on newer QorIQ
37266412c63SKumar Gala		devices it can be 16 or 32.  The ratio varies from SoC to Soc.
37366412c63SKumar Gala
3748f29084aSKumar Gala		CONFIG_SYS_FSL_PCIE_COMPAT
3758f29084aSKumar Gala
3768f29084aSKumar Gala		Defines the string to utilize when trying to match PCIe device
3778f29084aSKumar Gala		tree nodes for the given platform.
3788f29084aSKumar Gala
379afa6b551SPrabhakar Kushwaha		CONFIG_SYS_PPC_E500_DEBUG_TLB
380afa6b551SPrabhakar Kushwaha
381afa6b551SPrabhakar Kushwaha		Enables a temporary TLB entry to be used during boot to work
382afa6b551SPrabhakar Kushwaha		around limitations in e500v1 and e500v2 external debugger
383afa6b551SPrabhakar Kushwaha		support. This reduces the portions of the boot code where
384afa6b551SPrabhakar Kushwaha		breakpoints and single stepping do not work.  The value of this
385afa6b551SPrabhakar Kushwaha		symbol should be set to the TLB1 entry to be used for this
386afa6b551SPrabhakar Kushwaha		purpose.
387afa6b551SPrabhakar Kushwaha
38833eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510
38933eee330SScott Wood
39033eee330SScott Wood		Enables a workaround for erratum A004510.  If set,
39133eee330SScott Wood		then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
39233eee330SScott Wood		CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
39333eee330SScott Wood
39433eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
39533eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
39633eee330SScott Wood
39733eee330SScott Wood		Defines one or two SoC revisions (low 8 bits of SVR)
39833eee330SScott Wood		for which the A004510 workaround should be applied.
39933eee330SScott Wood
40033eee330SScott Wood		The rest of SVR is either not relevant to the decision
40133eee330SScott Wood		of whether the erratum is present (e.g. p2040 versus
40233eee330SScott Wood		p2041) or is implied by the build target, which controls
40333eee330SScott Wood		whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
40433eee330SScott Wood
40533eee330SScott Wood		See Freescale App Note 4493 for more information about
40633eee330SScott Wood		this erratum.
40733eee330SScott Wood
40874fa22edSPrabhakar Kushwaha		CONFIG_A003399_NOR_WORKAROUND
40974fa22edSPrabhakar Kushwaha		Enables a workaround for IFC erratum A003399. It is only
41074fa22edSPrabhakar Kushwaha		requred during NOR boot.
41174fa22edSPrabhakar Kushwaha
412*9f074e67SPrabhakar Kushwaha		CONFIG_A008044_WORKAROUND
413*9f074e67SPrabhakar Kushwaha		Enables a workaround for T1040/T1042 erratum A008044. It is only
414*9f074e67SPrabhakar Kushwaha		requred during NAND boot and valid for Rev 1.0 SoC revision
415*9f074e67SPrabhakar Kushwaha
41633eee330SScott Wood		CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
41733eee330SScott Wood
41833eee330SScott Wood		This is the value to write into CCSR offset 0x18600
41933eee330SScott Wood		according to the A004510 workaround.
42033eee330SScott Wood
42164501c66SPriyanka Jain		CONFIG_SYS_FSL_DSP_DDR_ADDR
42264501c66SPriyanka Jain		This value denotes start offset of DDR memory which is
42364501c66SPriyanka Jain		connected exclusively to the DSP cores.
42464501c66SPriyanka Jain
425765b0bdbSPriyanka Jain		CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
426765b0bdbSPriyanka Jain		This value denotes start offset of M2 memory
427765b0bdbSPriyanka Jain		which is directly connected to the DSP core.
428765b0bdbSPriyanka Jain
42964501c66SPriyanka Jain		CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
43064501c66SPriyanka Jain		This value denotes start offset of M3 memory which is directly
43164501c66SPriyanka Jain		connected to the DSP core.
43264501c66SPriyanka Jain
433765b0bdbSPriyanka Jain		CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
434765b0bdbSPriyanka Jain		This value denotes start offset of DSP CCSR space.
435765b0bdbSPriyanka Jain
436b135991aSPriyanka Jain		CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
437b135991aSPriyanka Jain		Single Source Clock is clocking mode present in some of FSL SoC's.
438b135991aSPriyanka Jain		In this mode, a single differential clock is used to supply
439b135991aSPriyanka Jain		clocks to the sysclock, ddrclock and usbclock.
440b135991aSPriyanka Jain
441fb4a2409SAneesh Bansal		CONFIG_SYS_CPC_REINIT_F
442fb4a2409SAneesh Bansal		This CONFIG is defined when the CPC is configured as SRAM at the
443fb4a2409SAneesh Bansal		time of U-boot entry and is required to be re-initialized.
444fb4a2409SAneesh Bansal
445aade2004STang Yuantian		CONFIG_DEEP_SLEEP
446aade2004STang Yuantian		Inidcates this SoC supports deep sleep feature. If deep sleep is
447aade2004STang Yuantian		supported, core will start to execute uboot when wakes up.
448aade2004STang Yuantian
4496cb461b4SDaniel Schwierzeck- Generic CPU options:
4502a1680e3SYork Sun		CONFIG_SYS_GENERIC_GLOBAL_DATA
4512a1680e3SYork Sun		Defines global data is initialized in generic board board_init_f().
4522a1680e3SYork Sun		If this macro is defined, global data is created and cleared in
4532a1680e3SYork Sun		generic board board_init_f(). Without this macro, architecture/board
4542a1680e3SYork Sun		should initialize global data before calling board_init_f().
4552a1680e3SYork Sun
4566cb461b4SDaniel Schwierzeck		CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
4576cb461b4SDaniel Schwierzeck
4586cb461b4SDaniel Schwierzeck		Defines the endianess of the CPU. Implementation of those
4596cb461b4SDaniel Schwierzeck		values is arch specific.
4606cb461b4SDaniel Schwierzeck
4615614e71bSYork Sun		CONFIG_SYS_FSL_DDR
4625614e71bSYork Sun		Freescale DDR driver in use. This type of DDR controller is
4635614e71bSYork Sun		found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
4645614e71bSYork Sun		SoCs.
4655614e71bSYork Sun
4665614e71bSYork Sun		CONFIG_SYS_FSL_DDR_ADDR
4675614e71bSYork Sun		Freescale DDR memory-mapped register base.
4685614e71bSYork Sun
4695614e71bSYork Sun		CONFIG_SYS_FSL_DDR_EMU
4705614e71bSYork Sun		Specify emulator support for DDR. Some DDR features such as
4715614e71bSYork Sun		deskew training are not available.
4725614e71bSYork Sun
4735614e71bSYork Sun		CONFIG_SYS_FSL_DDRC_GEN1
4745614e71bSYork Sun		Freescale DDR1 controller.
4755614e71bSYork Sun
4765614e71bSYork Sun		CONFIG_SYS_FSL_DDRC_GEN2
4775614e71bSYork Sun		Freescale DDR2 controller.
4785614e71bSYork Sun
4795614e71bSYork Sun		CONFIG_SYS_FSL_DDRC_GEN3
4805614e71bSYork Sun		Freescale DDR3 controller.
4815614e71bSYork Sun
48234e026f9SYork Sun		CONFIG_SYS_FSL_DDRC_GEN4
48334e026f9SYork Sun		Freescale DDR4 controller.
48434e026f9SYork Sun
4859ac4ffbdSYork Sun		CONFIG_SYS_FSL_DDRC_ARM_GEN3
4869ac4ffbdSYork Sun		Freescale DDR3 controller for ARM-based SoCs.
4879ac4ffbdSYork Sun
4885614e71bSYork Sun		CONFIG_SYS_FSL_DDR1
4895614e71bSYork Sun		Board config to use DDR1. It can be enabled for SoCs with
4905614e71bSYork Sun		Freescale DDR1 or DDR2 controllers, depending on the board
4915614e71bSYork Sun		implemetation.
4925614e71bSYork Sun
4935614e71bSYork Sun		CONFIG_SYS_FSL_DDR2
4945614e71bSYork Sun		Board config to use DDR2. It can be eanbeld for SoCs with
4955614e71bSYork Sun		Freescale DDR2 or DDR3 controllers, depending on the board
4965614e71bSYork Sun		implementation.
4975614e71bSYork Sun
4985614e71bSYork Sun		CONFIG_SYS_FSL_DDR3
4995614e71bSYork Sun		Board config to use DDR3. It can be enabled for SoCs with
50034e026f9SYork Sun		Freescale DDR3 or DDR3L controllers.
50134e026f9SYork Sun
50234e026f9SYork Sun		CONFIG_SYS_FSL_DDR3L
50334e026f9SYork Sun		Board config to use DDR3L. It can be enabled for SoCs with
50434e026f9SYork Sun		DDR3L controllers.
50534e026f9SYork Sun
50634e026f9SYork Sun		CONFIG_SYS_FSL_DDR4
50734e026f9SYork Sun		Board config to use DDR4. It can be enabled for SoCs with
50834e026f9SYork Sun		DDR4 controllers.
5095614e71bSYork Sun
5101b4175d6SPrabhakar Kushwaha		CONFIG_SYS_FSL_IFC_BE
5111b4175d6SPrabhakar Kushwaha		Defines the IFC controller register space as Big Endian
5121b4175d6SPrabhakar Kushwaha
5131b4175d6SPrabhakar Kushwaha		CONFIG_SYS_FSL_IFC_LE
5141b4175d6SPrabhakar Kushwaha		Defines the IFC controller register space as Little Endian
5151b4175d6SPrabhakar Kushwaha
516690e4258SPrabhakar Kushwaha		CONFIG_SYS_FSL_PBL_PBI
517690e4258SPrabhakar Kushwaha		It enables addition of RCW (Power on reset configuration) in built image.
518690e4258SPrabhakar Kushwaha		Please refer doc/README.pblimage for more details
519690e4258SPrabhakar Kushwaha
520690e4258SPrabhakar Kushwaha		CONFIG_SYS_FSL_PBL_RCW
521690e4258SPrabhakar Kushwaha		It adds PBI(pre-boot instructions) commands in u-boot build image.
522690e4258SPrabhakar Kushwaha		PBI commands can be used to configure SoC before it starts the execution.
523690e4258SPrabhakar Kushwaha		Please refer doc/README.pblimage for more details
524690e4258SPrabhakar Kushwaha
52589ad7be8SPrabhakar Kushwaha		CONFIG_SPL_FSL_PBL
52689ad7be8SPrabhakar Kushwaha		It adds a target to create boot binary having SPL binary in PBI format
52789ad7be8SPrabhakar Kushwaha		concatenated with u-boot binary.
52889ad7be8SPrabhakar Kushwaha
5294e5b1bd0SYork Sun		CONFIG_SYS_FSL_DDR_BE
5304e5b1bd0SYork Sun		Defines the DDR controller register space as Big Endian
5314e5b1bd0SYork Sun
5324e5b1bd0SYork Sun		CONFIG_SYS_FSL_DDR_LE
5334e5b1bd0SYork Sun		Defines the DDR controller register space as Little Endian
5344e5b1bd0SYork Sun
5356b9e309aSYork Sun		CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
5366b9e309aSYork Sun		Physical address from the view of DDR controllers. It is the
5376b9e309aSYork Sun		same as CONFIG_SYS_DDR_SDRAM_BASE for  all Power SoCs. But
5386b9e309aSYork Sun		it could be different for ARM SoCs.
5396b9e309aSYork Sun
5406b1e1254SYork Sun		CONFIG_SYS_FSL_DDR_INTLV_256B
5416b1e1254SYork Sun		DDR controller interleaving on 256-byte. This is a special
5426b1e1254SYork Sun		interleaving mode, handled by Dickens for Freescale layerscape
5436b1e1254SYork Sun		SoCs with ARM core.
5446b1e1254SYork Sun
5451d71efbbSYork Sun		CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
5461d71efbbSYork Sun		Number of controllers used as main memory.
5471d71efbbSYork Sun
5481d71efbbSYork Sun		CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
5491d71efbbSYork Sun		Number of controllers used for other than main memory.
5501d71efbbSYork Sun
551028dbb8dSRuchika Gupta		CONFIG_SYS_FSL_SEC_BE
552028dbb8dSRuchika Gupta		Defines the SEC controller register space as Big Endian
553028dbb8dSRuchika Gupta
554028dbb8dSRuchika Gupta		CONFIG_SYS_FSL_SEC_LE
555028dbb8dSRuchika Gupta		Defines the SEC controller register space as Little Endian
556028dbb8dSRuchika Gupta
5570b953ffcSMarkus Klotzbuecher- Intel Monahans options:
5586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
5590b953ffcSMarkus Klotzbuecher
5600b953ffcSMarkus Klotzbuecher		Defines the Monahans run mode to oscillator
5610b953ffcSMarkus Klotzbuecher		ratio. Valid values are 8, 16, 24, 31. The core
5620b953ffcSMarkus Klotzbuecher		frequency is this value multiplied by 13 MHz.
5630b953ffcSMarkus Klotzbuecher
5646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
5650b953ffcSMarkus Klotzbuecher
5660b953ffcSMarkus Klotzbuecher		Defines the Monahans turbo mode to oscillator
5670b953ffcSMarkus Klotzbuecher		ratio. Valid values are 1 (default if undefined) and
5680b953ffcSMarkus Klotzbuecher		2. The core frequency as calculated above is multiplied
5690b953ffcSMarkus Klotzbuecher		by this value.
5700b953ffcSMarkus Klotzbuecher
57192bbd64eSDaniel Schwierzeck- MIPS CPU options:
57292bbd64eSDaniel Schwierzeck		CONFIG_SYS_INIT_SP_OFFSET
57392bbd64eSDaniel Schwierzeck
57492bbd64eSDaniel Schwierzeck		Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
57592bbd64eSDaniel Schwierzeck		pointer. This is needed for the temporary stack before
57692bbd64eSDaniel Schwierzeck		relocation.
57792bbd64eSDaniel Schwierzeck
57892bbd64eSDaniel Schwierzeck		CONFIG_SYS_MIPS_CACHE_MODE
57992bbd64eSDaniel Schwierzeck
58092bbd64eSDaniel Schwierzeck		Cache operation mode for the MIPS CPU.
58192bbd64eSDaniel Schwierzeck		See also arch/mips/include/asm/mipsregs.h.
58292bbd64eSDaniel Schwierzeck		Possible values are:
58392bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_NO_WA
58492bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_WA
58592bbd64eSDaniel Schwierzeck			CONF_CM_UNCACHED
58692bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_NONCOHERENT
58792bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_CE
58892bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_COW
58992bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_CUW
59092bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_ACCELERATED
59192bbd64eSDaniel Schwierzeck
59292bbd64eSDaniel Schwierzeck		CONFIG_SYS_XWAY_EBU_BOOTCFG
59392bbd64eSDaniel Schwierzeck
59492bbd64eSDaniel Schwierzeck		Special option for Lantiq XWAY SoCs for booting from NOR flash.
59592bbd64eSDaniel Schwierzeck		See also arch/mips/cpu/mips32/start.S.
59692bbd64eSDaniel Schwierzeck
59792bbd64eSDaniel Schwierzeck		CONFIG_XWAY_SWAP_BYTES
59892bbd64eSDaniel Schwierzeck
59992bbd64eSDaniel Schwierzeck		Enable compilation of tools/xway-swap-bytes needed for Lantiq
60092bbd64eSDaniel Schwierzeck		XWAY SoCs for booting from NOR flash. The U-Boot image needs to
60192bbd64eSDaniel Schwierzeck		be swapped if a flash programmer is used.
60292bbd64eSDaniel Schwierzeck
603b67d8816SChristian Riesch- ARM options:
604b67d8816SChristian Riesch		CONFIG_SYS_EXCEPTION_VECTORS_HIGH
605b67d8816SChristian Riesch
606b67d8816SChristian Riesch		Select high exception vectors of the ARM core, e.g., do not
607b67d8816SChristian Riesch		clear the V bit of the c1 register of CP15.
608b67d8816SChristian Riesch
6095356f545SAneesh V		CONFIG_SYS_THUMB_BUILD
6105356f545SAneesh V
6115356f545SAneesh V		Use this flag to build U-Boot using the Thumb instruction
6125356f545SAneesh V		set for ARM architectures. Thumb instruction set provides
6135356f545SAneesh V		better code density. For ARM architectures that support
6145356f545SAneesh V		Thumb2 this flag will result in Thumb2 code generated by
6155356f545SAneesh V		GCC.
6165356f545SAneesh V
617c5d4752cSStephen Warren		CONFIG_ARM_ERRATA_716044
6180678587fSStephen Warren		CONFIG_ARM_ERRATA_742230
6190678587fSStephen Warren		CONFIG_ARM_ERRATA_743622
6200678587fSStephen Warren		CONFIG_ARM_ERRATA_751472
621f71cbfe3SNitin Garg		CONFIG_ARM_ERRATA_794072
622b7588e3bSNitin Garg		CONFIG_ARM_ERRATA_761320
6230678587fSStephen Warren
6240678587fSStephen Warren		If set, the workarounds for these ARM errata are applied early
6250678587fSStephen Warren		during U-Boot startup. Note that these options force the
6260678587fSStephen Warren		workarounds to be applied; no CPU-type/version detection
6270678587fSStephen Warren		exists, unlike the similar options in the Linux kernel. Do not
6280678587fSStephen Warren		set these options unless they apply!
6290678587fSStephen Warren
63038687ae6SSimon Glass- Driver Model
63138687ae6SSimon Glass		Driver model is a new framework for devices in U-Boot
63238687ae6SSimon Glass		introduced in early 2014. U-Boot is being progressively
63338687ae6SSimon Glass		moved over to this. It offers a consistent device structure,
63438687ae6SSimon Glass		supports grouping devices into classes and has built-in
63538687ae6SSimon Glass		handling of platform data and device tree.
63638687ae6SSimon Glass
63738687ae6SSimon Glass		To enable transition to driver model in a relatively
63838687ae6SSimon Glass		painful fashion, each subsystem can be independently
63938687ae6SSimon Glass		switched between the legacy/ad-hoc approach and the new
64038687ae6SSimon Glass		driver model using the options below. Also, many uclass
64138687ae6SSimon Glass		interfaces include compatibility features which may be
64238687ae6SSimon Glass		removed once the conversion of that subsystem is complete.
64338687ae6SSimon Glass		As a result, the API provided by the subsystem may in fact
64438687ae6SSimon Glass		not change with driver model.
64538687ae6SSimon Glass
64638687ae6SSimon Glass		See doc/driver-model/README.txt for more information.
64738687ae6SSimon Glass
64838687ae6SSimon Glass		CONFIG_DM
64938687ae6SSimon Glass
65038687ae6SSimon Glass		Enable driver model. This brings in the core support,
65138687ae6SSimon Glass		including scanning of platform data on start-up. If
65238687ae6SSimon Glass		CONFIG_OF_CONTROL is enabled, the device tree will be
65338687ae6SSimon Glass		scanned also when available.
65438687ae6SSimon Glass
65538687ae6SSimon Glass		CONFIG_CMD_DM
65638687ae6SSimon Glass
65738687ae6SSimon Glass		Enable driver model test commands. These allow you to print
65838687ae6SSimon Glass		out the driver model tree and the uclasses.
65938687ae6SSimon Glass
66038687ae6SSimon Glass		CONFIG_DM_DEMO
66138687ae6SSimon Glass
66238687ae6SSimon Glass		Enable some demo devices and the 'demo' command. These are
66338687ae6SSimon Glass		really only useful for playing around while trying to
66438687ae6SSimon Glass		understand driver model in sandbox.
66538687ae6SSimon Glass
66638687ae6SSimon Glass		CONFIG_SPL_DM
66738687ae6SSimon Glass
66838687ae6SSimon Glass		Enable driver model in SPL. You will need to provide a
66938687ae6SSimon Glass		suitable malloc() implementation. If you are not using the
67038687ae6SSimon Glass		full malloc() enabled by CONFIG_SYS_SPL_MALLOC_START,
67138687ae6SSimon Glass		consider using CONFIG_SYS_MALLOC_SIMPLE. In that case you
67238687ae6SSimon Glass		must provide CONFIG_SYS_MALLOC_F_LEN to set the size.
67338687ae6SSimon Glass		In most cases driver model will only allocate a few uclasses
67438687ae6SSimon Glass		and devices in SPL, so 1KB should be enable. See
67538687ae6SSimon Glass		CONFIG_SYS_MALLOC_F_LEN for more details on how to enable
67638687ae6SSimon Glass		it.
67738687ae6SSimon Glass
67838687ae6SSimon Glass		CONFIG_DM_SERIAL
67938687ae6SSimon Glass
68038687ae6SSimon Glass		Enable driver model for serial. This replaces
68138687ae6SSimon Glass		drivers/serial/serial.c with the serial uclass, which
68238687ae6SSimon Glass		implements serial_putc() etc. The uclass interface is
68338687ae6SSimon Glass		defined in include/serial.h.
68438687ae6SSimon Glass
68538687ae6SSimon Glass		CONFIG_DM_GPIO
68638687ae6SSimon Glass
68738687ae6SSimon Glass		Enable driver model for GPIO access. The standard GPIO
68838687ae6SSimon Glass		interface (gpio_get_value(), etc.) is then implemented by
68938687ae6SSimon Glass		the GPIO uclass. Drivers provide methods to query the
69038687ae6SSimon Glass		particular GPIOs that they provide. The uclass interface
69138687ae6SSimon Glass		is defined in include/asm-generic/gpio.h.
69238687ae6SSimon Glass
69338687ae6SSimon Glass		CONFIG_DM_SPI
69438687ae6SSimon Glass
69538687ae6SSimon Glass		Enable driver model for SPI. The SPI slave interface
69638687ae6SSimon Glass		(spi_setup_slave(), spi_xfer(), etc.) is then implemented by
69738687ae6SSimon Glass		the SPI uclass. Drivers provide methods to access the SPI
69838687ae6SSimon Glass		buses that they control. The uclass interface is defined in
69938687ae6SSimon Glass		include/spi.h. The existing spi_slave structure is attached
70038687ae6SSimon Glass		as 'parent data' to every slave on each bus. Slaves
70138687ae6SSimon Glass		typically use driver-private data instead of extending the
70238687ae6SSimon Glass		spi_slave structure.
70338687ae6SSimon Glass
70438687ae6SSimon Glass		CONFIG_DM_SPI_FLASH
70538687ae6SSimon Glass
70638687ae6SSimon Glass		Enable driver model for SPI flash. This SPI flash interface
70738687ae6SSimon Glass		(spi_flash_probe(), spi_flash_write(), etc.) is then
70838687ae6SSimon Glass		implemented by the SPI flash uclass. There is one standard
70938687ae6SSimon Glass		SPI flash driver which knows how to probe most chips
71038687ae6SSimon Glass		supported by U-Boot. The uclass interface is defined in
71138687ae6SSimon Glass		include/spi_flash.h, but is currently fully compatible
71238687ae6SSimon Glass		with the old interface to avoid confusion and duplication
71338687ae6SSimon Glass		during the transition parent. SPI and SPI flash must be
71438687ae6SSimon Glass		enabled together (it is not possible to use driver model
71538687ae6SSimon Glass		for one and not the other).
71638687ae6SSimon Glass
71738687ae6SSimon Glass		CONFIG_DM_CROS_EC
71838687ae6SSimon Glass
71938687ae6SSimon Glass		Enable driver model for the Chrome OS EC interface. This
72038687ae6SSimon Glass		allows the cros_ec SPI driver to operate with CONFIG_DM_SPI
72138687ae6SSimon Glass		but otherwise makes few changes. Since cros_ec also supports
72238687ae6SSimon Glass		I2C and LPC (which don't support driver model yet), a full
72338687ae6SSimon Glass		conversion is not yet possible.
72438687ae6SSimon Glass
72538687ae6SSimon Glass
72638687ae6SSimon Glass		** Code size options: The following options are enabled by
72738687ae6SSimon Glass		default except in SPL. Enable them explicitly to get these
72838687ae6SSimon Glass		features in SPL.
72938687ae6SSimon Glass
73038687ae6SSimon Glass		CONFIG_DM_WARN
73138687ae6SSimon Glass
73238687ae6SSimon Glass		Enable the dm_warn() function. This can use up quite a bit
73338687ae6SSimon Glass		of space for its strings.
73438687ae6SSimon Glass
73538687ae6SSimon Glass		CONFIG_DM_STDIO
73638687ae6SSimon Glass
73738687ae6SSimon Glass		Enable registering a serial device with the stdio library.
73838687ae6SSimon Glass
73938687ae6SSimon Glass		CONFIG_DM_DEVICE_REMOVE
74038687ae6SSimon Glass
74138687ae6SSimon Glass		Enable removing of devices.
74238687ae6SSimon Glass
74338687ae6SSimon Glass
7445da627a4Swdenk- Linux Kernel Interface:
745c609719bSwdenk		CONFIG_CLOCKS_IN_MHZ
746c609719bSwdenk
747c609719bSwdenk		U-Boot stores all clock information in Hz
748c609719bSwdenk		internally. For binary compatibility with older Linux
749c609719bSwdenk		kernels (which expect the clocks passed in the
750c609719bSwdenk		bd_info data to be in MHz) the environment variable
751c609719bSwdenk		"clocks_in_mhz" can be defined so that U-Boot
752c609719bSwdenk		converts clock data to MHZ before passing it to the
753c609719bSwdenk		Linux kernel.
754c609719bSwdenk		When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
755c609719bSwdenk		"clocks_in_mhz=1" is automatically included in the
756c609719bSwdenk		default environment.
757c609719bSwdenk
7585da627a4Swdenk		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]
7595da627a4Swdenk
76011ccc33fSMarcel Ziswiler		When transferring memsize parameter to linux, some versions
7615da627a4Swdenk		expect it to be in bytes, others in MB.
7625da627a4Swdenk		Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
7635da627a4Swdenk
764fec6d9eeSGerald Van Baren		CONFIG_OF_LIBFDT
765f57f70aaSWolfgang Denk
766f57f70aaSWolfgang Denk		New kernel versions are expecting firmware settings to be
767213bf8c8SGerald Van Baren		passed using flattened device trees (based on open firmware
768213bf8c8SGerald Van Baren		concepts).
769213bf8c8SGerald Van Baren
770213bf8c8SGerald Van Baren		CONFIG_OF_LIBFDT
771213bf8c8SGerald Van Baren		 * New libfdt-based support
772213bf8c8SGerald Van Baren		 * Adds the "fdt" command
7733bb342fcSKim Phillips		 * The bootm command automatically updates the fdt
774213bf8c8SGerald Van Baren
775b55ae402SMarcel Ziswiler		OF_CPU - The proper name of the cpus node (only required for
776b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
777b55ae402SMarcel Ziswiler		OF_SOC - The proper name of the soc node (only required for
778b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
779f57f70aaSWolfgang Denk		OF_TBCLK - The timebase frequency.
780c2871f03SKumar Gala		OF_STDOUT_PATH - The path to the console device
781f57f70aaSWolfgang Denk
78211ccc33fSMarcel Ziswiler		boards with QUICC Engines require OF_QE to set UCC MAC
78311ccc33fSMarcel Ziswiler		addresses
7843bb342fcSKim Phillips
7854e253137SKumar Gala		CONFIG_OF_BOARD_SETUP
7864e253137SKumar Gala
7874e253137SKumar Gala		Board code has addition modification that it wants to make
7884e253137SKumar Gala		to the flat device tree before handing it off to the kernel
7896705d81eSwdenk
790c654b517SSimon Glass		CONFIG_OF_SYSTEM_SETUP
791c654b517SSimon Glass
792c654b517SSimon Glass		Other code has addition modification that it wants to make
793c654b517SSimon Glass		to the flat device tree before handing it off to the kernel.
794c654b517SSimon Glass		This causes ft_system_setup() to be called before booting
795c654b517SSimon Glass		the kernel.
796c654b517SSimon Glass
7970267768eSMatthew McClintock		CONFIG_OF_BOOT_CPU
7980267768eSMatthew McClintock
79911ccc33fSMarcel Ziswiler		This define fills in the correct boot CPU in the boot
8000267768eSMatthew McClintock		param header, the default value is zero if undefined.
8010267768eSMatthew McClintock
8023887c3fbSHeiko Schocher		CONFIG_OF_IDE_FIXUP
8033887c3fbSHeiko Schocher
8043887c3fbSHeiko Schocher		U-Boot can detect if an IDE device is present or not.
8053887c3fbSHeiko Schocher		If not, and this new config option is activated, U-Boot
8063887c3fbSHeiko Schocher		removes the ATA node from the DTS before booting Linux,
8073887c3fbSHeiko Schocher		so the Linux IDE driver does not probe the device and
8083887c3fbSHeiko Schocher		crash. This is needed for buggy hardware (uc101) where
8093887c3fbSHeiko Schocher		no pull down resistor is connected to the signal IDE5V_DD7.
8103887c3fbSHeiko Schocher
8117eb29398SIgor Grinberg		CONFIG_MACH_TYPE	[relevant for ARM only][mandatory]
8127eb29398SIgor Grinberg
8137eb29398SIgor Grinberg		This setting is mandatory for all boards that have only one
8147eb29398SIgor Grinberg		machine type and must be used to specify the machine type
8157eb29398SIgor Grinberg		number as it appears in the ARM machine registry
8167eb29398SIgor Grinberg		(see http://www.arm.linux.org.uk/developer/machines/).
8177eb29398SIgor Grinberg		Only boards that have multiple machine types supported
8187eb29398SIgor Grinberg		in a single configuration file and the machine type is
8197eb29398SIgor Grinberg		runtime discoverable, do not have to use this setting.
8207eb29398SIgor Grinberg
8210b2f4ecaSNiklaus Giger- vxWorks boot parameters:
8220b2f4ecaSNiklaus Giger
8230b2f4ecaSNiklaus Giger		bootvx constructs a valid bootline using the following
8240b2f4ecaSNiklaus Giger		environments variables: bootfile, ipaddr, serverip, hostname.
8250b2f4ecaSNiklaus Giger		It loads the vxWorks image pointed bootfile.
8260b2f4ecaSNiklaus Giger
8270b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
8280b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
8290b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
8300b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
8310b2f4ecaSNiklaus Giger
8320b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_ADD_PARAMS
8330b2f4ecaSNiklaus Giger
8340b2f4ecaSNiklaus Giger		Add it at the end of the bootline. E.g "u=username pw=secret"
8350b2f4ecaSNiklaus Giger
8360b2f4ecaSNiklaus Giger		Note: If a "bootargs" environment is defined, it will overwride
8370b2f4ecaSNiklaus Giger		the defaults discussed just above.
8380b2f4ecaSNiklaus Giger
8392c451f78SAneesh V- Cache Configuration:
8402c451f78SAneesh V		CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
8412c451f78SAneesh V		CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
8422c451f78SAneesh V		CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
8432c451f78SAneesh V
84493bc2193SAneesh V- Cache Configuration for ARM:
84593bc2193SAneesh V		CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
84693bc2193SAneesh V				      controller
84793bc2193SAneesh V		CONFIG_SYS_PL310_BASE - Physical base address of PL310
84893bc2193SAneesh V					controller register space
84993bc2193SAneesh V
8506705d81eSwdenk- Serial Ports:
85148d0192fSAndreas Engel		CONFIG_PL010_SERIAL
8526705d81eSwdenk
8536705d81eSwdenk		Define this if you want support for Amba PrimeCell PL010 UARTs.
8546705d81eSwdenk
85548d0192fSAndreas Engel		CONFIG_PL011_SERIAL
8566705d81eSwdenk
8576705d81eSwdenk		Define this if you want support for Amba PrimeCell PL011 UARTs.
8586705d81eSwdenk
8596705d81eSwdenk		CONFIG_PL011_CLOCK
8606705d81eSwdenk
8616705d81eSwdenk		If you have Amba PrimeCell PL011 UARTs, set this variable to
8626705d81eSwdenk		the clock speed of the UARTs.
8636705d81eSwdenk
8646705d81eSwdenk		CONFIG_PL01x_PORTS
8656705d81eSwdenk
8666705d81eSwdenk		If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
8676705d81eSwdenk		define this to a list of base addresses for each (supported)
8686705d81eSwdenk		port. See e.g. include/configs/versatile.h
8696705d81eSwdenk
870910f1ae3SJohn Rigby		CONFIG_PL011_SERIAL_RLCR
871910f1ae3SJohn Rigby
872910f1ae3SJohn Rigby		Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
873910f1ae3SJohn Rigby		have separate receive and transmit line control registers.  Set
874910f1ae3SJohn Rigby		this variable to initialize the extra register.
875910f1ae3SJohn Rigby
876910f1ae3SJohn Rigby		CONFIG_PL011_SERIAL_FLUSH_ON_INIT
877910f1ae3SJohn Rigby
878910f1ae3SJohn Rigby		On some platforms (e.g. U8500) U-Boot is loaded by a second stage
879910f1ae3SJohn Rigby		boot loader that has already initialized the UART.  Define this
880910f1ae3SJohn Rigby		variable to flush the UART at init time.
881910f1ae3SJohn Rigby
882d57dee57SKaricheri, Muralidharan		CONFIG_SERIAL_HW_FLOW_CONTROL
883d57dee57SKaricheri, Muralidharan
884d57dee57SKaricheri, Muralidharan		Define this variable to enable hw flow control in serial driver.
885d57dee57SKaricheri, Muralidharan		Current user of this option is drivers/serial/nsl16550.c driver
8866705d81eSwdenk
887c609719bSwdenk- Console Interface:
888c609719bSwdenk		Depending on board, define exactly one serial port
889c609719bSwdenk		(like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
890c609719bSwdenk		CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
891c609719bSwdenk		console by defining CONFIG_8xx_CONS_NONE
892c609719bSwdenk
893c609719bSwdenk		Note: if CONFIG_8xx_CONS_NONE is defined, the serial
894c609719bSwdenk		port routines must be defined elsewhere
895c609719bSwdenk		(i.e. serial_init(), serial_getc(), ...)
896c609719bSwdenk
897c609719bSwdenk		CONFIG_CFB_CONSOLE
898c609719bSwdenk		Enables console device for a color framebuffer. Needs following
899c53043b7SWolfgang Denk		defines (cf. smiLynxEM, i8042)
900c609719bSwdenk			VIDEO_FB_LITTLE_ENDIAN	graphic memory organisation
901c609719bSwdenk						(default big endian)
902c609719bSwdenk			VIDEO_HW_RECTFILL	graphic chip supports
903c609719bSwdenk						rectangle fill
904c609719bSwdenk						(cf. smiLynxEM)
905c609719bSwdenk			VIDEO_HW_BITBLT		graphic chip supports
906c609719bSwdenk						bit-blit (cf. smiLynxEM)
907c609719bSwdenk			VIDEO_VISIBLE_COLS	visible pixel columns
908c609719bSwdenk						(cols=pitch)
909c609719bSwdenk			VIDEO_VISIBLE_ROWS	visible pixel rows
910c609719bSwdenk			VIDEO_PIXEL_SIZE	bytes per pixel
911c609719bSwdenk			VIDEO_DATA_FORMAT	graphic data format
912c609719bSwdenk						(0-5, cf. cfb_console.c)
913c609719bSwdenk			VIDEO_FB_ADRS		framebuffer address
914c609719bSwdenk			VIDEO_KBD_INIT_FCT	keyboard int fct
915c609719bSwdenk						(i.e. i8042_kbd_init())
916c609719bSwdenk			VIDEO_TSTC_FCT		test char fct
917c609719bSwdenk						(i.e. i8042_tstc)
918c609719bSwdenk			VIDEO_GETC_FCT		get char fct
919c609719bSwdenk						(i.e. i8042_getc)
920c609719bSwdenk			CONFIG_CONSOLE_CURSOR	cursor drawing on/off
921c609719bSwdenk						(requires blink timer
922c609719bSwdenk						cf. i8042.c)
9236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
924c609719bSwdenk			CONFIG_CONSOLE_TIME	display time/date info in
925c609719bSwdenk						upper right corner
926602ad3b3SJon Loeliger						(requires CONFIG_CMD_DATE)
927c609719bSwdenk			CONFIG_VIDEO_LOGO	display Linux logo in
928c609719bSwdenk						upper left corner
929a6c7ad2fSwdenk			CONFIG_VIDEO_BMP_LOGO	use bmp_logo.h instead of
930a6c7ad2fSwdenk						linux_logo.h for logo.
931a6c7ad2fSwdenk						Requires CONFIG_VIDEO_LOGO
932c609719bSwdenk			CONFIG_CONSOLE_EXTRA_INFO
93311ccc33fSMarcel Ziswiler						additional board info beside
934c609719bSwdenk						the logo
935c609719bSwdenk
93633a35bbbSPali Rohár		When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
93733a35bbbSPali Rohár		a limited number of ANSI escape sequences (cursor control,
93833a35bbbSPali Rohár		erase functions and limited graphics rendition control).
93933a35bbbSPali Rohár
940c609719bSwdenk		When CONFIG_CFB_CONSOLE is defined, video console is
941c609719bSwdenk		default i/o. Serial console can be forced with
942c609719bSwdenk		environment 'console=serial'.
943c609719bSwdenk
944a3ad8e26Swdenk		When CONFIG_SILENT_CONSOLE is defined, all console
945a3ad8e26Swdenk		messages (by U-Boot and Linux!) can be silenced with
946a3ad8e26Swdenk		the "silent" environment variable. See
947a3ad8e26Swdenk		doc/README.silent for more information.
948a3ad8e26Swdenk
94945ae2546SHeiko Schocher		CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default
95045ae2546SHeiko Schocher			is 0x00.
95145ae2546SHeiko Schocher		CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default
95245ae2546SHeiko Schocher			is 0xa0.
95345ae2546SHeiko Schocher
954c609719bSwdenk- Console Baudrate:
955c609719bSwdenk		CONFIG_BAUDRATE - in bps
956c609719bSwdenk		Select one of the baudrates listed in
9576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
9586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
959c609719bSwdenk
960c92fac91SHeiko Schocher- Console Rx buffer length
961c92fac91SHeiko Schocher		With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
962c92fac91SHeiko Schocher		the maximum receive buffer length for the SMC.
9632b3f12c2SHeiko Schocher		This option is actual only for 82xx and 8xx possible.
964c92fac91SHeiko Schocher		If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
965c92fac91SHeiko Schocher		must be defined, to setup the maximum idle timeout for
966c92fac91SHeiko Schocher		the SMC.
967c92fac91SHeiko Schocher
9689558b48aSGraeme Russ- Pre-Console Buffer:
9699558b48aSGraeme Russ		Prior to the console being initialised (i.e. serial UART
9709558b48aSGraeme Russ		initialised etc) all console output is silently discarded.
9719558b48aSGraeme Russ		Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
9729558b48aSGraeme Russ		buffer any console messages prior to the console being
9739558b48aSGraeme Russ		initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
9749558b48aSGraeme Russ		bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
9759558b48aSGraeme Russ		a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
9769558b48aSGraeme Russ		bytes are output before the console is initialised, the
9779558b48aSGraeme Russ		earlier bytes are discarded.
9789558b48aSGraeme Russ
9799558b48aSGraeme Russ		'Sane' compilers will generate smaller code if
9809558b48aSGraeme Russ		CONFIG_PRE_CON_BUF_SZ is a power of 2
9819558b48aSGraeme Russ
982046a37bdSSonny Rao- Safe printf() functions
983046a37bdSSonny Rao		Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
984046a37bdSSonny Rao		the printf() functions. These are defined in
985046a37bdSSonny Rao		include/vsprintf.h and include snprintf(), vsnprintf() and
986046a37bdSSonny Rao		so on. Code size increase is approximately 300-500 bytes.
987046a37bdSSonny Rao		If this option is not given then these functions will
988046a37bdSSonny Rao		silently discard their buffer size argument - this means
989046a37bdSSonny Rao		you are not getting any overflow checking in this case.
990046a37bdSSonny Rao
991c609719bSwdenk- Boot Delay:	CONFIG_BOOTDELAY - in seconds
992c609719bSwdenk		Delay before automatically booting the default image;
993c609719bSwdenk		set to -1 to disable autoboot.
99493d7212fSJoe Hershberger		set to -2 to autoboot with no delay and not check for abort
99593d7212fSJoe Hershberger		(even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
996c609719bSwdenk
997c609719bSwdenk		See doc/README.autoboot for these options that
998c609719bSwdenk		work with CONFIG_BOOTDELAY. None are required.
999c609719bSwdenk		CONFIG_BOOT_RETRY_TIME
1000c609719bSwdenk		CONFIG_BOOT_RETRY_MIN
1001c609719bSwdenk		CONFIG_AUTOBOOT_KEYED
1002c609719bSwdenk		CONFIG_AUTOBOOT_PROMPT
1003c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR
1004c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR
1005c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR2
1006c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR2
1007c609719bSwdenk		CONFIG_ZERO_BOOTDELAY_CHECK
1008c609719bSwdenk		CONFIG_RESET_TO_RETRY
1009c609719bSwdenk
1010c609719bSwdenk- Autoboot Command:
1011c609719bSwdenk		CONFIG_BOOTCOMMAND
1012c609719bSwdenk		Only needed when CONFIG_BOOTDELAY is enabled;
1013c609719bSwdenk		define a command string that is automatically executed
1014c609719bSwdenk		when no character is read on the console interface
1015c609719bSwdenk		within "Boot Delay" after reset.
1016c609719bSwdenk
1017c609719bSwdenk		CONFIG_BOOTARGS
1018c609719bSwdenk		This can be used to pass arguments to the bootm
1019c609719bSwdenk		command. The value of CONFIG_BOOTARGS goes into the
1020c609719bSwdenk		environment value "bootargs".
1021c609719bSwdenk
1022c609719bSwdenk		CONFIG_RAMBOOT and CONFIG_NFSBOOT
1023c609719bSwdenk		The value of these goes into the environment as
1024c609719bSwdenk		"ramboot" and "nfsboot" respectively, and can be used
1025c609719bSwdenk		as a convenience, when switching between booting from
102611ccc33fSMarcel Ziswiler		RAM and NFS.
1027c609719bSwdenk
1028eda0ba38SHeiko Schocher- Bootcount:
1029eda0ba38SHeiko Schocher		CONFIG_BOOTCOUNT_LIMIT
1030eda0ba38SHeiko Schocher		Implements a mechanism for detecting a repeating reboot
1031eda0ba38SHeiko Schocher		cycle, see:
1032eda0ba38SHeiko Schocher		http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
1033eda0ba38SHeiko Schocher
1034eda0ba38SHeiko Schocher		CONFIG_BOOTCOUNT_ENV
1035eda0ba38SHeiko Schocher		If no softreset save registers are found on the hardware
1036eda0ba38SHeiko Schocher		"bootcount" is stored in the environment. To prevent a
1037eda0ba38SHeiko Schocher		saveenv on all reboots, the environment variable
1038eda0ba38SHeiko Schocher		"upgrade_available" is used. If "upgrade_available" is
1039eda0ba38SHeiko Schocher		0, "bootcount" is always 0, if "upgrade_available" is
1040eda0ba38SHeiko Schocher		1 "bootcount" is incremented in the environment.
1041eda0ba38SHeiko Schocher		So the Userspace Applikation must set the "upgrade_available"
1042eda0ba38SHeiko Schocher		and "bootcount" variable to 0, if a boot was successfully.
1043eda0ba38SHeiko Schocher
1044c609719bSwdenk- Pre-Boot Commands:
1045c609719bSwdenk		CONFIG_PREBOOT
1046c609719bSwdenk
1047c609719bSwdenk		When this option is #defined, the existence of the
1048c609719bSwdenk		environment variable "preboot" will be checked
1049c609719bSwdenk		immediately before starting the CONFIG_BOOTDELAY
1050c609719bSwdenk		countdown and/or running the auto-boot command resp.
1051c609719bSwdenk		entering interactive mode.
1052c609719bSwdenk
1053c609719bSwdenk		This feature is especially useful when "preboot" is
1054c609719bSwdenk		automatically generated or modified. For an example
1055c609719bSwdenk		see the LWMON board specific code: here "preboot" is
1056c609719bSwdenk		modified when the user holds down a certain
1057c609719bSwdenk		combination of keys on the (special) keyboard when
1058c609719bSwdenk		booting the systems
1059c609719bSwdenk
1060c609719bSwdenk- Serial Download Echo Mode:
1061c609719bSwdenk		CONFIG_LOADS_ECHO
1062c609719bSwdenk		If defined to 1, all characters received during a
1063c609719bSwdenk		serial download (using the "loads" command) are
1064c609719bSwdenk		echoed back. This might be needed by some terminal
1065c609719bSwdenk		emulations (like "cu"), but may as well just take
1066c609719bSwdenk		time on others. This setting #define's the initial
1067c609719bSwdenk		value of the "loads_echo" environment variable.
1068c609719bSwdenk
1069602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
1070c609719bSwdenk		CONFIG_KGDB_BAUDRATE
1071c609719bSwdenk		Select one of the baudrates listed in
10726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
1073c609719bSwdenk
1074c609719bSwdenk- Monitor Functions:
1075602ad3b3SJon Loeliger		Monitor commands can be included or excluded
1076602ad3b3SJon Loeliger		from the build by using the #include files
1077c6c621bdSStephen Warren		<config_cmd_all.h> and #undef'ing unwanted
1078c6c621bdSStephen Warren		commands, or using <config_cmd_default.h>
1079602ad3b3SJon Loeliger		and augmenting with additional #define's
1080602ad3b3SJon Loeliger		for wanted commands.
1081c609719bSwdenk
1082602ad3b3SJon Loeliger		The default command configuration includes all commands
1083602ad3b3SJon Loeliger		except those marked below with a "*".
1084602ad3b3SJon Loeliger
1085b401b73dSMarek Vasut		CONFIG_CMD_AES		  AES 128 CBC encrypt/decrypt
1086602ad3b3SJon Loeliger		CONFIG_CMD_ASKENV	* ask for env variable
1087602ad3b3SJon Loeliger		CONFIG_CMD_BDI		  bdinfo
1088602ad3b3SJon Loeliger		CONFIG_CMD_BEDBUG	* Include BedBug Debugger
1089602ad3b3SJon Loeliger		CONFIG_CMD_BMP		* BMP support
1090602ad3b3SJon Loeliger		CONFIG_CMD_BSP		* Board specific commands
1091602ad3b3SJon Loeliger		CONFIG_CMD_BOOTD	  bootd
1092d2b2ffe3STom Rini		CONFIG_CMD_BOOTI	* ARM64 Linux kernel Image support
1093602ad3b3SJon Loeliger		CONFIG_CMD_CACHE	* icache, dcache
109408d0d6f3SMichal Simek		CONFIG_CMD_CLK   	* clock command support
1095602ad3b3SJon Loeliger		CONFIG_CMD_CONSOLE	  coninfo
1096710b9938SMike Frysinger		CONFIG_CMD_CRC32	* crc32
1097602ad3b3SJon Loeliger		CONFIG_CMD_DATE		* support for RTC, date/time...
1098602ad3b3SJon Loeliger		CONFIG_CMD_DHCP		* DHCP support
1099602ad3b3SJon Loeliger		CONFIG_CMD_DIAG		* Diagnostics
1100a7c93104SPeter Tyser		CONFIG_CMD_DS4510	* ds4510 I2C gpio commands
1101a7c93104SPeter Tyser		CONFIG_CMD_DS4510_INFO	* ds4510 I2C info command
1102a7c93104SPeter Tyser		CONFIG_CMD_DS4510_MEM	* ds4510 I2C eeprom/sram commansd
1103a7c93104SPeter Tyser		CONFIG_CMD_DS4510_RST	* ds4510 I2C rst command
1104602ad3b3SJon Loeliger		CONFIG_CMD_DTT		* Digital Therm and Thermostat
1105602ad3b3SJon Loeliger		CONFIG_CMD_ECHO		  echo arguments
1106246c6922SPeter Tyser		CONFIG_CMD_EDITENV	  edit env variable
1107602ad3b3SJon Loeliger		CONFIG_CMD_EEPROM	* EEPROM read/write support
1108602ad3b3SJon Loeliger		CONFIG_CMD_ELF		* bootelf, bootvx
11095e2b3e0cSJoe Hershberger		CONFIG_CMD_ENV_CALLBACK	* display details about env callbacks
1110fffad71bSJoe Hershberger		CONFIG_CMD_ENV_FLAGS	* display details about env flags
111188733e2cSAndrew Ruder		CONFIG_CMD_ENV_EXISTS	* check existence of env variable
11120c79cda0SMike Frysinger		CONFIG_CMD_EXPORTENV	* export the environment
111303e2ecf6SStephen Warren		CONFIG_CMD_EXT2		* ext2 command support
111403e2ecf6SStephen Warren		CONFIG_CMD_EXT4		* ext4 command support
111516f4d933SStephen Warren		CONFIG_CMD_FS_GENERIC	* filesystem commands (e.g. load, ls)
111616f4d933SStephen Warren					  that work for multiple fs types
111759e890efSChristian Gmeiner		CONFIG_CMD_FS_UUID	* Look up a filesystem UUID
1118bdab39d3SMike Frysinger		CONFIG_CMD_SAVEENV	  saveenv
1119602ad3b3SJon Loeliger		CONFIG_CMD_FDC		* Floppy Disk Support
112003e2ecf6SStephen Warren		CONFIG_CMD_FAT		* FAT command support
1121602ad3b3SJon Loeliger		CONFIG_CMD_FLASH	  flinfo, erase, protect
1122602ad3b3SJon Loeliger		CONFIG_CMD_FPGA		  FPGA device initialization support
11234d98b5c8SVincent Stehlé		CONFIG_CMD_FUSE		* Device fuse support
112453fdc7efSAnton Staaf		CONFIG_CMD_GETTIME	* Get time since boot
1125a641b979SMike Frysinger		CONFIG_CMD_GO		* the 'go' command (exec code)
1126a000b795SKim Phillips		CONFIG_CMD_GREPENV	* search environment
1127bf36c5d5SSimon Glass		CONFIG_CMD_HASH		* calculate hash / digest
1128602ad3b3SJon Loeliger		CONFIG_CMD_HWFLOW	* RTS/CTS hw flow control
1129602ad3b3SJon Loeliger		CONFIG_CMD_I2C		* I2C serial bus support
1130602ad3b3SJon Loeliger		CONFIG_CMD_IDE		* IDE harddisk support
1131602ad3b3SJon Loeliger		CONFIG_CMD_IMI		  iminfo
11328fdf1e0fSVipin Kumar		CONFIG_CMD_IMLS		  List all images found in NOR flash
11334d98b5c8SVincent Stehlé		CONFIG_CMD_IMLS_NAND	* List all images found in NAND flash
1134602ad3b3SJon Loeliger		CONFIG_CMD_IMMAP	* IMMR dump support
1135aa53233aSSimon Glass		CONFIG_CMD_IOTRACE	* I/O tracing for debugging
11360c79cda0SMike Frysinger		CONFIG_CMD_IMPORTENV	* import an environment
1137c167cc02SJoe Hershberger		CONFIG_CMD_INI		* import data from an ini file into the env
1138602ad3b3SJon Loeliger		CONFIG_CMD_IRQ		* irqinfo
1139602ad3b3SJon Loeliger		CONFIG_CMD_ITEST	  Integer/string test of 2 values
1140602ad3b3SJon Loeliger		CONFIG_CMD_JFFS2	* JFFS2 Support
1141602ad3b3SJon Loeliger		CONFIG_CMD_KGDB		* kgdb
11424d98b5c8SVincent Stehlé		CONFIG_CMD_LDRINFO	* ldrinfo (display Blackfin loader)
1143d22c338eSJoe Hershberger		CONFIG_CMD_LINK_LOCAL	* link-local IP address auto-configuration
1144d22c338eSJoe Hershberger					  (169.254.*.*)
1145602ad3b3SJon Loeliger		CONFIG_CMD_LOADB	  loadb
1146602ad3b3SJon Loeliger		CONFIG_CMD_LOADS	  loads
11474d98b5c8SVincent Stehlé		CONFIG_CMD_MD5SUM	* print md5 message digest
114802c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
114915a33e49SSimon Glass		CONFIG_CMD_MEMINFO	* Display detailed memory information
1150602ad3b3SJon Loeliger		CONFIG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
1151a2681707SWolfgang Denk					  loop, loopw
11524d98b5c8SVincent Stehlé		CONFIG_CMD_MEMTEST	* mtest
1153602ad3b3SJon Loeliger		CONFIG_CMD_MISC		  Misc functions like sleep etc
1154602ad3b3SJon Loeliger		CONFIG_CMD_MMC		* MMC memory mapped support
1155602ad3b3SJon Loeliger		CONFIG_CMD_MII		* MII utility commands
115668d7d651SStefan Roese		CONFIG_CMD_MTDPARTS	* MTD partition support
1157602ad3b3SJon Loeliger		CONFIG_CMD_NAND		* NAND support
1158602ad3b3SJon Loeliger		CONFIG_CMD_NET		  bootp, tftpboot, rarpboot
11594d98b5c8SVincent Stehlé		CONFIG_CMD_NFS		  NFS support
1160e92739d3SPeter Tyser		CONFIG_CMD_PCA953X	* PCA953x I2C gpio commands
1161e92739d3SPeter Tyser		CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
1162602ad3b3SJon Loeliger		CONFIG_CMD_PCI		* pciinfo
1163602ad3b3SJon Loeliger		CONFIG_CMD_PCMCIA		* PCMCIA support
1164602ad3b3SJon Loeliger		CONFIG_CMD_PING		* send ICMP ECHO_REQUEST to network
1165602ad3b3SJon Loeliger					  host
1166602ad3b3SJon Loeliger		CONFIG_CMD_PORTIO	* Port I/O
1167ff048ea9SKenneth Waters		CONFIG_CMD_READ		* Read raw data from partition
1168602ad3b3SJon Loeliger		CONFIG_CMD_REGINFO	* Register dump
1169602ad3b3SJon Loeliger		CONFIG_CMD_RUN		  run command in env variable
1170d304931fSSimon Glass		CONFIG_CMD_SANDBOX	* sb command to access sandbox features
1171602ad3b3SJon Loeliger		CONFIG_CMD_SAVES	* save S record dump
1172602ad3b3SJon Loeliger		CONFIG_CMD_SCSI		* SCSI Support
1173602ad3b3SJon Loeliger		CONFIG_CMD_SDRAM	* print SDRAM configuration information
1174602ad3b3SJon Loeliger					  (requires CONFIG_CMD_I2C)
1175602ad3b3SJon Loeliger		CONFIG_CMD_SETGETDCR	  Support for DCR Register access
1176602ad3b3SJon Loeliger					  (4xx only)
1177f61ec45eSEric Nelson		CONFIG_CMD_SF		* Read/write/erase SPI NOR flash
11784d98b5c8SVincent Stehlé		CONFIG_CMD_SHA1SUM	* print sha1 memory digest
117902c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY)
11807d861d95SBob Liu		CONFIG_CMD_SOFTSWITCH	* Soft switch setting command for BF60x
118174de7aefSWolfgang Denk		CONFIG_CMD_SOURCE	  "source" command Support
1182602ad3b3SJon Loeliger		CONFIG_CMD_SPI		* SPI serial bus support
11837a83af07SLuca Ceresoli		CONFIG_CMD_TFTPSRV	* TFTP transfer in server mode
11841fb7cd49SSimon Glass		CONFIG_CMD_TFTPPUT	* TFTP put command (upload)
1185da83bcd7SJoe Hershberger		CONFIG_CMD_TIME		* run command and report execution time (ARM specific)
1186da83bcd7SJoe Hershberger		CONFIG_CMD_TIMER	* access to the system tick timer
1187602ad3b3SJon Loeliger		CONFIG_CMD_USB		* USB support
1188602ad3b3SJon Loeliger		CONFIG_CMD_CDP		* Cisco Discover Protocol support
1189c8339f51SMarek Vasut		CONFIG_CMD_MFSL		* Microblaze FSL support
11904d98b5c8SVincent Stehlé		CONFIG_CMD_XIMG		  Load part of Multi Image
119189c8230dSPrzemyslaw Marczak		CONFIG_CMD_UUID		* Generate random UUID or GUID string
1192c609719bSwdenk
1193c609719bSwdenk		EXAMPLE: If you want all functions except of network
1194c609719bSwdenk		support you can write:
1195c609719bSwdenk
1196602ad3b3SJon Loeliger		#include "config_cmd_all.h"
1197602ad3b3SJon Loeliger		#undef CONFIG_CMD_NET
1198c609719bSwdenk
1199213bf8c8SGerald Van Baren	Other Commands:
1200213bf8c8SGerald Van Baren		fdt (flattened device tree) command: CONFIG_OF_LIBFDT
1201c609719bSwdenk
1202c609719bSwdenk	Note:	Don't enable the "icache" and "dcache" commands
1203602ad3b3SJon Loeliger		(configuration option CONFIG_CMD_CACHE) unless you know
1204c609719bSwdenk		what you (and your U-Boot users) are doing. Data
1205c609719bSwdenk		cache cannot be enabled on systems like the 8xx or
1206c609719bSwdenk		8260 (where accesses to the IMMR region must be
1207c609719bSwdenk		uncached), and it cannot be disabled on all other
1208c609719bSwdenk		systems where we (mis-) use the data cache to hold an
1209c609719bSwdenk		initial stack and some data.
1210c609719bSwdenk
1211c609719bSwdenk
1212c609719bSwdenk		XXX - this list needs to get updated!
1213c609719bSwdenk
1214a5ecbe62SWolfgang Denk- Regular expression support:
1215a5ecbe62SWolfgang Denk		CONFIG_REGEX
1216a5ecbe62SWolfgang Denk		If this variable is defined, U-Boot is linked against
1217a5ecbe62SWolfgang Denk		the SLRE (Super Light Regular Expression) library,
1218a5ecbe62SWolfgang Denk		which adds regex support to some commands, as for
1219a5ecbe62SWolfgang Denk		example "env grep" and "setexpr".
1220a5ecbe62SWolfgang Denk
122145ba8077SSimon Glass- Device tree:
122245ba8077SSimon Glass		CONFIG_OF_CONTROL
122345ba8077SSimon Glass		If this variable is defined, U-Boot will use a device tree
122445ba8077SSimon Glass		to configure its devices, instead of relying on statically
122545ba8077SSimon Glass		compiled #defines in the board file. This option is
122645ba8077SSimon Glass		experimental and only available on a few boards. The device
122745ba8077SSimon Glass		tree is available in the global data as gd->fdt_blob.
122845ba8077SSimon Glass
12292c0f79e4SSimon Glass		U-Boot needs to get its device tree from somewhere. This can
12302c0f79e4SSimon Glass		be done using one of the two options below:
1231bbb0b128SSimon Glass
1232bbb0b128SSimon Glass		CONFIG_OF_EMBED
1233bbb0b128SSimon Glass		If this variable is defined, U-Boot will embed a device tree
1234bbb0b128SSimon Glass		binary in its image. This device tree file should be in the
1235bbb0b128SSimon Glass		board directory and called <soc>-<board>.dts. The binary file
1236bbb0b128SSimon Glass		is then picked up in board_init_f() and made available through
1237bbb0b128SSimon Glass		the global data structure as gd->blob.
123845ba8077SSimon Glass
12392c0f79e4SSimon Glass		CONFIG_OF_SEPARATE
12402c0f79e4SSimon Glass		If this variable is defined, U-Boot will build a device tree
12412c0f79e4SSimon Glass		binary. It will be called u-boot.dtb. Architecture-specific
12422c0f79e4SSimon Glass		code will locate it at run-time. Generally this works by:
12432c0f79e4SSimon Glass
12442c0f79e4SSimon Glass			cat u-boot.bin u-boot.dtb >image.bin
12452c0f79e4SSimon Glass
12462c0f79e4SSimon Glass		and in fact, U-Boot does this for you, creating a file called
12472c0f79e4SSimon Glass		u-boot-dtb.bin which is useful in the common case. You can
12482c0f79e4SSimon Glass		still use the individual files if you need something more
12492c0f79e4SSimon Glass		exotic.
12502c0f79e4SSimon Glass
1251c609719bSwdenk- Watchdog:
1252c609719bSwdenk		CONFIG_WATCHDOG
1253c609719bSwdenk		If this variable is defined, it enables watchdog
12546abe6fb6SDetlev Zundel		support for the SoC. There must be support in the SoC
12556abe6fb6SDetlev Zundel		specific code for a watchdog. For the 8xx and 8260
12566abe6fb6SDetlev Zundel		CPUs, the SIU Watchdog feature is enabled in the SYPCR
12576abe6fb6SDetlev Zundel		register.  When supported for a specific SoC is
12586abe6fb6SDetlev Zundel		available, then no further board specific code should
12596abe6fb6SDetlev Zundel		be needed to use it.
12606abe6fb6SDetlev Zundel
12616abe6fb6SDetlev Zundel		CONFIG_HW_WATCHDOG
12626abe6fb6SDetlev Zundel		When using a watchdog circuitry external to the used
12636abe6fb6SDetlev Zundel		SoC, then define this variable and provide board
12646abe6fb6SDetlev Zundel		specific code for the "hw_watchdog_reset" function.
1265c609719bSwdenk
1266c1551ea8Sstroese- U-Boot Version:
1267c1551ea8Sstroese		CONFIG_VERSION_VARIABLE
1268c1551ea8Sstroese		If this variable is defined, an environment variable
1269c1551ea8Sstroese		named "ver" is created by U-Boot showing the U-Boot
1270c1551ea8Sstroese		version as printed by the "version" command.
1271a1ea8e51SBenoît Thébaudeau		Any change to this variable will be reverted at the
1272a1ea8e51SBenoît Thébaudeau		next reset.
1273c1551ea8Sstroese
1274c609719bSwdenk- Real-Time Clock:
1275c609719bSwdenk
1276602ad3b3SJon Loeliger		When CONFIG_CMD_DATE is selected, the type of the RTC
1277c609719bSwdenk		has to be selected, too. Define exactly one of the
1278c609719bSwdenk		following options:
1279c609719bSwdenk
1280c609719bSwdenk		CONFIG_RTC_MPC8xx	- use internal RTC of MPC8xx
1281c609719bSwdenk		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
12824e8b7544SFabio Estevam		CONFIG_RTC_MC13XXX	- use MC13783 or MC13892 RTC
1283c609719bSwdenk		CONFIG_RTC_MC146818	- use MC146818 RTC
12841cb8e980Swdenk		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
1285c609719bSwdenk		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
12867f70e853Swdenk		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
1287412921d2SMarkus Niebel		CONFIG_RTC_DS1339	- use Maxim, Inc. DS1339 RTC
12883bac3513Swdenk		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
12899536dfccSTor Krill		CONFIG_RTC_ISL1208	- use Intersil ISL1208 RTC
12904c0d4c3bSwdenk		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
12916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_DS1337_NOOSC	- Turn off the OSC output for DS1337
129271d19f30SHeiko Schocher		CONFIG_SYS_RV3029_TCR	- enable trickle charger on
129371d19f30SHeiko Schocher					  RV3029 RTC.
1294c609719bSwdenk
1295b37c7e5eSwdenk		Note that if the RTC uses I2C, then the I2C interface
1296b37c7e5eSwdenk		must also be configured. See I2C Support, below.
1297b37c7e5eSwdenk
1298e92739d3SPeter Tyser- GPIO Support:
1299e92739d3SPeter Tyser		CONFIG_PCA953X		- use NXP's PCA953X series I2C GPIO
1300e92739d3SPeter Tyser
13015dec49caSChris Packham		The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
13025dec49caSChris Packham		chip-ngpio pairs that tell the PCA953X driver the number of
13035dec49caSChris Packham		pins supported by a particular chip.
13045dec49caSChris Packham
1305e92739d3SPeter Tyser		Note that if the GPIO device uses I2C, then the I2C interface
1306e92739d3SPeter Tyser		must also be configured. See I2C Support, below.
1307e92739d3SPeter Tyser
1308aa53233aSSimon Glass- I/O tracing:
1309aa53233aSSimon Glass		When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
1310aa53233aSSimon Glass		accesses and can checksum them or write a list of them out
1311aa53233aSSimon Glass		to memory. See the 'iotrace' command for details. This is
1312aa53233aSSimon Glass		useful for testing device drivers since it can confirm that
1313aa53233aSSimon Glass		the driver behaves the same way before and after a code
1314aa53233aSSimon Glass		change. Currently this is supported on sandbox and arm. To
1315aa53233aSSimon Glass		add support for your architecture, add '#include <iotrace.h>'
1316aa53233aSSimon Glass		to the bottom of arch/<arch>/include/asm/io.h and test.
1317aa53233aSSimon Glass
1318aa53233aSSimon Glass		Example output from the 'iotrace stats' command is below.
1319aa53233aSSimon Glass		Note that if the trace buffer is exhausted, the checksum will
1320aa53233aSSimon Glass		still continue to operate.
1321aa53233aSSimon Glass
1322aa53233aSSimon Glass			iotrace is enabled
1323aa53233aSSimon Glass			Start:  10000000	(buffer start address)
1324aa53233aSSimon Glass			Size:   00010000	(buffer size)
1325aa53233aSSimon Glass			Offset: 00000120	(current buffer offset)
1326aa53233aSSimon Glass			Output: 10000120	(start + offset)
1327aa53233aSSimon Glass			Count:  00000018	(number of trace records)
1328aa53233aSSimon Glass			CRC32:  9526fb66	(CRC32 of all trace records)
1329aa53233aSSimon Glass
1330c609719bSwdenk- Timestamp Support:
1331c609719bSwdenk
1332c609719bSwdenk		When CONFIG_TIMESTAMP is selected, the timestamp
1333c609719bSwdenk		(date and time) of an image is printed by image
1334c609719bSwdenk		commands like bootm or iminfo. This option is
1335602ad3b3SJon Loeliger		automatically enabled when you select CONFIG_CMD_DATE .
1336c609719bSwdenk
1337923c46f9SKarl O. Pinc- Partition Labels (disklabels) Supported:
1338923c46f9SKarl O. Pinc		Zero or more of the following:
1339923c46f9SKarl O. Pinc		CONFIG_MAC_PARTITION   Apple's MacOS partition table.
1340923c46f9SKarl O. Pinc		CONFIG_DOS_PARTITION   MS Dos partition table, traditional on the
1341923c46f9SKarl O. Pinc				       Intel architecture, USB sticks, etc.
1342923c46f9SKarl O. Pinc		CONFIG_ISO_PARTITION   ISO partition table, used on CDROM etc.
1343923c46f9SKarl O. Pinc		CONFIG_EFI_PARTITION   GPT partition table, common when EFI is the
1344923c46f9SKarl O. Pinc				       bootloader.  Note 2TB partition limit; see
1345923c46f9SKarl O. Pinc				       disk/part_efi.c
1346923c46f9SKarl O. Pinc		CONFIG_MTD_PARTITIONS  Memory Technology Device partition table.
1347c609719bSwdenk
1348602ad3b3SJon Loeliger		If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1349218ca724SWolfgang Denk		CONFIG_CMD_SCSI) you must configure support for at
1350923c46f9SKarl O. Pinc		least one non-MTD partition type as well.
1351c609719bSwdenk
1352c609719bSwdenk- IDE Reset method:
13534d13cbadSwdenk		CONFIG_IDE_RESET_ROUTINE - this is defined in several
13544d13cbadSwdenk		board configurations files but used nowhere!
1355c609719bSwdenk
13564d13cbadSwdenk		CONFIG_IDE_RESET - is this is defined, IDE Reset will
13574d13cbadSwdenk		be performed by calling the function
13584d13cbadSwdenk			ide_set_reset(int reset)
13594d13cbadSwdenk		which has to be defined in a board specific file
1360c609719bSwdenk
1361c609719bSwdenk- ATAPI Support:
1362c609719bSwdenk		CONFIG_ATAPI
1363c609719bSwdenk
1364c609719bSwdenk		Set this to enable ATAPI support.
1365c609719bSwdenk
1366c40b2956Swdenk- LBA48 Support
1367c40b2956Swdenk		CONFIG_LBA48
1368c40b2956Swdenk
1369c40b2956Swdenk		Set this to enable support for disks larger than 137GB
13704b142febSHeiko Schocher		Also look at CONFIG_SYS_64BIT_LBA.
1371c40b2956Swdenk		Whithout these , LBA48 support uses 32bit variables and will 'only'
1372c40b2956Swdenk		support disks up to 2.1TB.
1373c40b2956Swdenk
13746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_64BIT_LBA:
1375c40b2956Swdenk			When enabled, makes the IDE subsystem use 64bit sector addresses.
1376c40b2956Swdenk			Default is 32bit.
1377c40b2956Swdenk
1378c609719bSwdenk- SCSI Support:
1379c609719bSwdenk		At the moment only there is only support for the
1380c609719bSwdenk		SYM53C8XX SCSI controller; define
1381c609719bSwdenk		CONFIG_SCSI_SYM53C8XX to enable it.
1382c609719bSwdenk
13836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
13846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
13856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
1386c609719bSwdenk		maximum numbers of LUNs, SCSI ID's and target
1387c609719bSwdenk		devices.
13886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
1389c609719bSwdenk
1390447c031bSStefan Reinauer		The environment variable 'scsidevs' is set to the number of
1391447c031bSStefan Reinauer		SCSI devices found during the last scan.
1392447c031bSStefan Reinauer
1393c609719bSwdenk- NETWORK Support (PCI):
1394682011ffSwdenk		CONFIG_E1000
1395ce5207e1SKyle Moffett		Support for Intel 8254x/8257x gigabit chips.
1396ce5207e1SKyle Moffett
1397ce5207e1SKyle Moffett		CONFIG_E1000_SPI
1398ce5207e1SKyle Moffett		Utility code for direct access to the SPI bus on Intel 8257x.
1399ce5207e1SKyle Moffett		This does not do anything useful unless you set at least one
1400ce5207e1SKyle Moffett		of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1401ce5207e1SKyle Moffett
1402ce5207e1SKyle Moffett		CONFIG_E1000_SPI_GENERIC
1403ce5207e1SKyle Moffett		Allow generic access to the SPI bus on the Intel 8257x, for
1404ce5207e1SKyle Moffett		example with the "sspi" command.
1405ce5207e1SKyle Moffett
1406ce5207e1SKyle Moffett		CONFIG_CMD_E1000
1407ce5207e1SKyle Moffett		Management command for E1000 devices.  When used on devices
1408ce5207e1SKyle Moffett		with SPI support you can reprogram the EEPROM from U-Boot.
1409682011ffSwdenk
1410ac3315c2SAndre Schwarz		CONFIG_E1000_FALLBACK_MAC
141111ccc33fSMarcel Ziswiler		default MAC for empty EEPROM after production.
1412ac3315c2SAndre Schwarz
1413c609719bSwdenk		CONFIG_EEPRO100
1414c609719bSwdenk		Support for Intel 82557/82559/82559ER chips.
141511ccc33fSMarcel Ziswiler		Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
1416c609719bSwdenk		write routine for first time initialisation.
1417c609719bSwdenk
1418c609719bSwdenk		CONFIG_TULIP
1419c609719bSwdenk		Support for Digital 2114x chips.
1420c609719bSwdenk		Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1421c609719bSwdenk		modem chip initialisation (KS8761/QS6611).
1422c609719bSwdenk
1423c609719bSwdenk		CONFIG_NATSEMI
1424c609719bSwdenk		Support for National dp83815 chips.
1425c609719bSwdenk
1426c609719bSwdenk		CONFIG_NS8382X
1427c609719bSwdenk		Support for National dp8382[01] gigabit chips.
1428c609719bSwdenk
142945219c46Swdenk- NETWORK Support (other):
143045219c46Swdenk
1431c041e9d2SJens Scharsig		CONFIG_DRIVER_AT91EMAC
1432c041e9d2SJens Scharsig		Support for AT91RM9200 EMAC.
1433c041e9d2SJens Scharsig
1434c041e9d2SJens Scharsig			CONFIG_RMII
1435c041e9d2SJens Scharsig			Define this to use reduced MII inteface
1436c041e9d2SJens Scharsig
1437c041e9d2SJens Scharsig			CONFIG_DRIVER_AT91EMAC_QUIET
1438c041e9d2SJens Scharsig			If this defined, the driver is quiet.
1439c041e9d2SJens Scharsig			The driver doen't show link status messages.
1440c041e9d2SJens Scharsig
1441efdd7319SRob Herring		CONFIG_CALXEDA_XGMAC
1442efdd7319SRob Herring		Support for the Calxeda XGMAC device
1443efdd7319SRob Herring
14443bb46d23SAshok		CONFIG_LAN91C96
144545219c46Swdenk		Support for SMSC's LAN91C96 chips.
144645219c46Swdenk
144745219c46Swdenk			CONFIG_LAN91C96_BASE
144845219c46Swdenk			Define this to hold the physical address
144945219c46Swdenk			of the LAN91C96's I/O space
145045219c46Swdenk
145145219c46Swdenk			CONFIG_LAN91C96_USE_32_BIT
145245219c46Swdenk			Define this to enable 32 bit addressing
145345219c46Swdenk
14543bb46d23SAshok		CONFIG_SMC91111
1455f39748aeSwdenk		Support for SMSC's LAN91C111 chip
1456f39748aeSwdenk
1457f39748aeSwdenk			CONFIG_SMC91111_BASE
1458f39748aeSwdenk			Define this to hold the physical address
1459f39748aeSwdenk			of the device (I/O space)
1460f39748aeSwdenk
1461f39748aeSwdenk			CONFIG_SMC_USE_32_BIT
1462f39748aeSwdenk			Define this if data bus is 32 bits
1463f39748aeSwdenk
1464f39748aeSwdenk			CONFIG_SMC_USE_IOFUNCS
1465f39748aeSwdenk			Define this to use i/o functions instead of macros
1466f39748aeSwdenk			(some hardware wont work with macros)
1467f39748aeSwdenk
1468dc02badaSHeiko Schocher		CONFIG_DRIVER_TI_EMAC
1469dc02badaSHeiko Schocher		Support for davinci emac
1470dc02badaSHeiko Schocher
1471dc02badaSHeiko Schocher			CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1472dc02badaSHeiko Schocher			Define this if you have more then 3 PHYs.
1473dc02badaSHeiko Schocher
1474b3dbf4a5SMacpaul Lin		CONFIG_FTGMAC100
1475b3dbf4a5SMacpaul Lin		Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1476b3dbf4a5SMacpaul Lin
1477b3dbf4a5SMacpaul Lin			CONFIG_FTGMAC100_EGIGA
1478b3dbf4a5SMacpaul Lin			Define this to use GE link update with gigabit PHY.
1479b3dbf4a5SMacpaul Lin			Define this if FTGMAC100 is connected to gigabit PHY.
1480b3dbf4a5SMacpaul Lin			If your system has 10/100 PHY only, it might not occur
1481b3dbf4a5SMacpaul Lin			wrong behavior. Because PHY usually return timeout or
1482b3dbf4a5SMacpaul Lin			useless data when polling gigabit status and gigabit
1483b3dbf4a5SMacpaul Lin			control registers. This behavior won't affect the
1484b3dbf4a5SMacpaul Lin			correctnessof 10/100 link speed update.
1485b3dbf4a5SMacpaul Lin
1486c2fff331SMike Rapoport		CONFIG_SMC911X
1487557b377dSJens Gehrlein		Support for SMSC's LAN911x and LAN921x chips
1488557b377dSJens Gehrlein
1489c2fff331SMike Rapoport			CONFIG_SMC911X_BASE
1490557b377dSJens Gehrlein			Define this to hold the physical address
1491557b377dSJens Gehrlein			of the device (I/O space)
1492557b377dSJens Gehrlein
1493c2fff331SMike Rapoport			CONFIG_SMC911X_32_BIT
1494557b377dSJens Gehrlein			Define this if data bus is 32 bits
1495557b377dSJens Gehrlein
1496c2fff331SMike Rapoport			CONFIG_SMC911X_16_BIT
1497557b377dSJens Gehrlein			Define this if data bus is 16 bits. If your processor
1498557b377dSJens Gehrlein			automatically converts one 32 bit word to two 16 bit
1499c2fff331SMike Rapoport			words you may also try CONFIG_SMC911X_32_BIT.
1500557b377dSJens Gehrlein
15013d0075faSYoshihiro Shimoda		CONFIG_SH_ETHER
15023d0075faSYoshihiro Shimoda		Support for Renesas on-chip Ethernet controller
15033d0075faSYoshihiro Shimoda
15043d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_USE_PORT
15053d0075faSYoshihiro Shimoda			Define the number of ports to be used
15063d0075faSYoshihiro Shimoda
15073d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_PHY_ADDR
15083d0075faSYoshihiro Shimoda			Define the ETH PHY's address
15093d0075faSYoshihiro Shimoda
151068260aabSYoshihiro Shimoda			CONFIG_SH_ETHER_CACHE_WRITEBACK
151168260aabSYoshihiro Shimoda			If this option is set, the driver enables cache flush.
151268260aabSYoshihiro Shimoda
1513b2f97cf2SHeiko Schocher- PWM Support:
1514b2f97cf2SHeiko Schocher		CONFIG_PWM_IMX
1515b2f97cf2SHeiko Schocher		Support for PWM modul on the imx6.
1516b2f97cf2SHeiko Schocher
15175e124724SVadim Bendebury- TPM Support:
151890899cc0SChe-liang Chiou		CONFIG_TPM
151990899cc0SChe-liang Chiou		Support TPM devices.
152090899cc0SChe-liang Chiou
15211b393db5STom Wai-Hong Tam		CONFIG_TPM_TIS_I2C
15221b393db5STom Wai-Hong Tam		Support for i2c bus TPM devices. Only one device
15231b393db5STom Wai-Hong Tam		per system is supported at this time.
15241b393db5STom Wai-Hong Tam
15251b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_BUS_NUMBER
15261b393db5STom Wai-Hong Tam			Define the the i2c bus number for the TPM device
15271b393db5STom Wai-Hong Tam
15281b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS
15291b393db5STom Wai-Hong Tam			Define the TPM's address on the i2c bus
15301b393db5STom Wai-Hong Tam
15311b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_BURST_LIMITATION
15321b393db5STom Wai-Hong Tam			Define the burst count bytes upper limit
15331b393db5STom Wai-Hong Tam
1534c01939c7SDirk Eibach		CONFIG_TPM_ATMEL_TWI
1535c01939c7SDirk Eibach		Support for Atmel TWI TPM device. Requires I2C support.
1536c01939c7SDirk Eibach
153790899cc0SChe-liang Chiou		CONFIG_TPM_TIS_LPC
15385e124724SVadim Bendebury		Support for generic parallel port TPM devices. Only one device
15395e124724SVadim Bendebury		per system is supported at this time.
15405e124724SVadim Bendebury
15415e124724SVadim Bendebury			CONFIG_TPM_TIS_BASE_ADDRESS
15425e124724SVadim Bendebury			Base address where the generic TPM device is mapped
15435e124724SVadim Bendebury			to. Contemporary x86 systems usually map it at
15445e124724SVadim Bendebury			0xfed40000.
15455e124724SVadim Bendebury
1546be6c1529SReinhard Pfau		CONFIG_CMD_TPM
1547be6c1529SReinhard Pfau		Add tpm monitor functions.
1548be6c1529SReinhard Pfau		Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1549be6c1529SReinhard Pfau		provides monitor access to authorized functions.
1550be6c1529SReinhard Pfau
1551be6c1529SReinhard Pfau		CONFIG_TPM
1552be6c1529SReinhard Pfau		Define this to enable the TPM support library which provides
1553be6c1529SReinhard Pfau		functional interfaces to some TPM commands.
1554be6c1529SReinhard Pfau		Requires support for a TPM device.
1555be6c1529SReinhard Pfau
1556be6c1529SReinhard Pfau		CONFIG_TPM_AUTH_SESSIONS
1557be6c1529SReinhard Pfau		Define this to enable authorized functions in the TPM library.
1558be6c1529SReinhard Pfau		Requires CONFIG_TPM and CONFIG_SHA1.
1559be6c1529SReinhard Pfau
1560c609719bSwdenk- USB Support:
1561c609719bSwdenk		At the moment only the UHCI host controller is
15624d13cbadSwdenk		supported (PIP405, MIP405, MPC5200); define
1563c609719bSwdenk		CONFIG_USB_UHCI to enable it.
1564c609719bSwdenk		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
156530d56faeSwdenk		and define CONFIG_USB_STORAGE to enable the USB
1566c609719bSwdenk		storage devices.
1567c609719bSwdenk		Note:
1568c609719bSwdenk		Supported are USB Keyboards and USB Floppy drives
1569c609719bSwdenk		(TEAC FD-05PUB).
15704d13cbadSwdenk		MPC5200 USB requires additional defines:
15714d13cbadSwdenk			CONFIG_USB_CLOCK
15724d13cbadSwdenk				for 528 MHz Clock: 0x0001bbbb
1573307ecb6dSEric Millbrandt			CONFIG_PSC3_USB
1574307ecb6dSEric Millbrandt				for USB on PSC3
15754d13cbadSwdenk			CONFIG_USB_CONFIG
15764d13cbadSwdenk				for differential drivers: 0x00001000
15774d13cbadSwdenk				for single ended drivers: 0x00005000
1578307ecb6dSEric Millbrandt				for differential drivers on PSC3: 0x00000100
1579307ecb6dSEric Millbrandt				for single ended drivers on PSC3: 0x00004100
15806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_USB_EVENT_POLL
1581fdcfaa1bSZhang Wei				May be defined to allow interrupt polling
1582fdcfaa1bSZhang Wei				instead of using asynchronous interrupts
15834d13cbadSwdenk
15849ab4ce22SSimon Glass		CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
15859ab4ce22SSimon Glass		txfilltuning field in the EHCI controller on reset.
15869ab4ce22SSimon Glass
15876e9e0626SOleksandr Tymoshenko		CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
15886e9e0626SOleksandr Tymoshenko		HW module registers.
15896e9e0626SOleksandr Tymoshenko
159016c8d5e7SWolfgang Denk- USB Device:
159116c8d5e7SWolfgang Denk		Define the below if you wish to use the USB console.
159216c8d5e7SWolfgang Denk		Once firmware is rebuilt from a serial console issue the
159316c8d5e7SWolfgang Denk		command "setenv stdin usbtty; setenv stdout usbtty" and
159411ccc33fSMarcel Ziswiler		attach your USB cable. The Unix command "dmesg" should print
159516c8d5e7SWolfgang Denk		it has found a new device. The environment variable usbtty
159616c8d5e7SWolfgang Denk		can be set to gserial or cdc_acm to enable your device to
159716c8d5e7SWolfgang Denk		appear to a USB host as a Linux gserial device or a
159816c8d5e7SWolfgang Denk		Common Device Class Abstract Control Model serial device.
159916c8d5e7SWolfgang Denk		If you select usbtty = gserial you should be able to enumerate
160016c8d5e7SWolfgang Denk		a Linux host by
160116c8d5e7SWolfgang Denk		# modprobe usbserial vendor=0xVendorID product=0xProductID
160216c8d5e7SWolfgang Denk		else if using cdc_acm, simply setting the environment
160316c8d5e7SWolfgang Denk		variable usbtty to be cdc_acm should suffice. The following
160416c8d5e7SWolfgang Denk		might be defined in YourBoardName.h
160516c8d5e7SWolfgang Denk
160616c8d5e7SWolfgang Denk			CONFIG_USB_DEVICE
160716c8d5e7SWolfgang Denk			Define this to build a UDC device
160816c8d5e7SWolfgang Denk
160916c8d5e7SWolfgang Denk			CONFIG_USB_TTY
161016c8d5e7SWolfgang Denk			Define this to have a tty type of device available to
161116c8d5e7SWolfgang Denk			talk to the UDC device
161216c8d5e7SWolfgang Denk
1613f9da0f89SVipin KUMAR			CONFIG_USBD_HS
1614f9da0f89SVipin KUMAR			Define this to enable the high speed support for usb
1615f9da0f89SVipin KUMAR			device and usbtty. If this feature is enabled, a routine
1616f9da0f89SVipin KUMAR			int is_usbd_high_speed(void)
1617f9da0f89SVipin KUMAR			also needs to be defined by the driver to dynamically poll
1618f9da0f89SVipin KUMAR			whether the enumeration has succeded at high speed or full
1619f9da0f89SVipin KUMAR			speed.
1620f9da0f89SVipin KUMAR
16216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_IS_IN_ENV
162216c8d5e7SWolfgang Denk			Define this if you want stdin, stdout &/or stderr to
162316c8d5e7SWolfgang Denk			be set to usbtty.
162416c8d5e7SWolfgang Denk
162516c8d5e7SWolfgang Denk			mpc8xx:
16266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_EXTC_CLK 0xBLAH
162716c8d5e7SWolfgang Denk				Derive USB clock from external clock "blah"
16286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_EXTC_CLK 0x02
162916c8d5e7SWolfgang Denk
16306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_BRG_CLK 0xBLAH
163116c8d5e7SWolfgang Denk				Derive USB clock from brgclk
16326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_BRG_CLK 0x04
163316c8d5e7SWolfgang Denk
163416c8d5e7SWolfgang Denk		If you have a USB-IF assigned VendorID then you may wish to
163516c8d5e7SWolfgang Denk		define your own vendor specific values either in BoardName.h
163616c8d5e7SWolfgang Denk		or directly in usbd_vendor_info.h. If you don't define
163716c8d5e7SWolfgang Denk		CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
163816c8d5e7SWolfgang Denk		CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
163916c8d5e7SWolfgang Denk		should pretend to be a Linux device to it's target host.
164016c8d5e7SWolfgang Denk
164116c8d5e7SWolfgang Denk			CONFIG_USBD_MANUFACTURER
164216c8d5e7SWolfgang Denk			Define this string as the name of your company for
164316c8d5e7SWolfgang Denk			- CONFIG_USBD_MANUFACTURER "my company"
164416c8d5e7SWolfgang Denk
164516c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCT_NAME
164616c8d5e7SWolfgang Denk			Define this string as the name of your product
164716c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCT_NAME "acme usb device"
164816c8d5e7SWolfgang Denk
164916c8d5e7SWolfgang Denk			CONFIG_USBD_VENDORID
165016c8d5e7SWolfgang Denk			Define this as your assigned Vendor ID from the USB
165116c8d5e7SWolfgang Denk			Implementors Forum. This *must* be a genuine Vendor ID
165216c8d5e7SWolfgang Denk			to avoid polluting the USB namespace.
165316c8d5e7SWolfgang Denk			- CONFIG_USBD_VENDORID 0xFFFF
165416c8d5e7SWolfgang Denk
165516c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCTID
165616c8d5e7SWolfgang Denk			Define this as the unique Product ID
165716c8d5e7SWolfgang Denk			for your device
165816c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCTID 0xFFFF
1659c609719bSwdenk
1660d70a560fSIgor Grinberg- ULPI Layer Support:
1661d70a560fSIgor Grinberg		The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1662d70a560fSIgor Grinberg		the generic ULPI layer. The generic layer accesses the ULPI PHY
1663d70a560fSIgor Grinberg		via the platform viewport, so you need both the genric layer and
1664d70a560fSIgor Grinberg		the viewport enabled. Currently only Chipidea/ARC based
1665d70a560fSIgor Grinberg		viewport is supported.
1666d70a560fSIgor Grinberg		To enable the ULPI layer support, define CONFIG_USB_ULPI and
1667d70a560fSIgor Grinberg		CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
16686d365ea0SLucas Stach		If your ULPI phy needs a different reference clock than the
16696d365ea0SLucas Stach		standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
16706d365ea0SLucas Stach		the appropriate value in Hz.
1671c609719bSwdenk
1672c609719bSwdenk- MMC Support:
1673c609719bSwdenk		The MMC controller on the Intel PXA is supported. To
1674c609719bSwdenk		enable this define CONFIG_MMC. The MMC can be
1675c609719bSwdenk		accessed from the boot prompt by mapping the device
1676c609719bSwdenk		to physical memory similar to flash. Command line is
1677602ad3b3SJon Loeliger		enabled with CONFIG_CMD_MMC. The MMC driver also works with
1678602ad3b3SJon Loeliger		the FAT fs. This is enabled with CONFIG_CMD_FAT.
1679c609719bSwdenk
1680afb35666SYoshihiro Shimoda		CONFIG_SH_MMCIF
1681afb35666SYoshihiro Shimoda		Support for Renesas on-chip MMCIF controller
1682afb35666SYoshihiro Shimoda
1683afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_ADDR
1684afb35666SYoshihiro Shimoda			Define the base address of MMCIF registers
1685afb35666SYoshihiro Shimoda
1686afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_CLK
1687afb35666SYoshihiro Shimoda			Define the clock frequency for MMCIF
1688afb35666SYoshihiro Shimoda
16891fd93c6eSPierre Aubert		CONFIG_GENERIC_MMC
16901fd93c6eSPierre Aubert		Enable the generic MMC driver
16911fd93c6eSPierre Aubert
16921fd93c6eSPierre Aubert		CONFIG_SUPPORT_EMMC_BOOT
16931fd93c6eSPierre Aubert		Enable some additional features of the eMMC boot partitions.
16941fd93c6eSPierre Aubert
16951fd93c6eSPierre Aubert		CONFIG_SUPPORT_EMMC_RPMB
16961fd93c6eSPierre Aubert		Enable the commands for reading, writing and programming the
16971fd93c6eSPierre Aubert		key for the Replay Protection Memory Block partition in eMMC.
16981fd93c6eSPierre Aubert
1699b3ba6e94STom Rini- USB Device Firmware Update (DFU) class support:
1700b3ba6e94STom Rini		CONFIG_DFU_FUNCTION
1701b3ba6e94STom Rini		This enables the USB portion of the DFU USB class
1702b3ba6e94STom Rini
1703b3ba6e94STom Rini		CONFIG_CMD_DFU
1704b3ba6e94STom Rini		This enables the command "dfu" which is used to have
1705b3ba6e94STom Rini		U-Boot create a DFU class device via USB.  This command
1706b3ba6e94STom Rini		requires that the "dfu_alt_info" environment variable be
1707b3ba6e94STom Rini		set and define the alt settings to expose to the host.
1708b3ba6e94STom Rini
1709b3ba6e94STom Rini		CONFIG_DFU_MMC
1710b3ba6e94STom Rini		This enables support for exposing (e)MMC devices via DFU.
1711b3ba6e94STom Rini
1712c6631764SPantelis Antoniou		CONFIG_DFU_NAND
1713c6631764SPantelis Antoniou		This enables support for exposing NAND devices via DFU.
1714c6631764SPantelis Antoniou
1715a9479f04SAfzal Mohammed		CONFIG_DFU_RAM
1716a9479f04SAfzal Mohammed		This enables support for exposing RAM via DFU.
1717a9479f04SAfzal Mohammed		Note: DFU spec refer to non-volatile memory usage, but
1718a9479f04SAfzal Mohammed		allow usages beyond the scope of spec - here RAM usage,
1719a9479f04SAfzal Mohammed		one that would help mostly the developer.
1720a9479f04SAfzal Mohammed
1721e7e75c70SHeiko Schocher		CONFIG_SYS_DFU_DATA_BUF_SIZE
1722e7e75c70SHeiko Schocher		Dfu transfer uses a buffer before writing data to the
1723e7e75c70SHeiko Schocher		raw storage device. Make the size (in bytes) of this buffer
1724e7e75c70SHeiko Schocher		configurable. The size of this buffer is also configurable
1725e7e75c70SHeiko Schocher		through the "dfu_bufsiz" environment variable.
1726e7e75c70SHeiko Schocher
1727ea2453d5SPantelis Antoniou		CONFIG_SYS_DFU_MAX_FILE_SIZE
1728ea2453d5SPantelis Antoniou		When updating files rather than the raw storage device,
1729ea2453d5SPantelis Antoniou		we use a static buffer to copy the file into and then write
1730ea2453d5SPantelis Antoniou		the buffer once we've been given the whole file.  Define
1731ea2453d5SPantelis Antoniou		this to the maximum filesize (in bytes) for the buffer.
1732ea2453d5SPantelis Antoniou		Default is 4 MiB if undefined.
1733ea2453d5SPantelis Antoniou
1734001a8319SHeiko Schocher		DFU_DEFAULT_POLL_TIMEOUT
1735001a8319SHeiko Schocher		Poll timeout [ms], is the timeout a device can send to the
1736001a8319SHeiko Schocher		host. The host must wait for this timeout before sending
1737001a8319SHeiko Schocher		a subsequent DFU_GET_STATUS request to the device.
1738001a8319SHeiko Schocher
1739001a8319SHeiko Schocher		DFU_MANIFEST_POLL_TIMEOUT
1740001a8319SHeiko Schocher		Poll timeout [ms], which the device sends to the host when
1741001a8319SHeiko Schocher		entering dfuMANIFEST state. Host waits this timeout, before
1742001a8319SHeiko Schocher		sending again an USB request to the device.
1743001a8319SHeiko Schocher
17443aab70afSSebastian Siewior- USB Device Android Fastboot support:
17453aab70afSSebastian Siewior		CONFIG_CMD_FASTBOOT
17463aab70afSSebastian Siewior		This enables the command "fastboot" which enables the Android
17473aab70afSSebastian Siewior		fastboot mode for the platform's USB device. Fastboot is a USB
17483aab70afSSebastian Siewior		protocol for downloading images, flashing and device control
17493aab70afSSebastian Siewior		used on Android devices.
17503aab70afSSebastian Siewior		See doc/README.android-fastboot for more information.
17513aab70afSSebastian Siewior
17523aab70afSSebastian Siewior		CONFIG_ANDROID_BOOT_IMAGE
17533aab70afSSebastian Siewior		This enables support for booting images which use the Android
17543aab70afSSebastian Siewior		image format header.
17553aab70afSSebastian Siewior
17563aab70afSSebastian Siewior		CONFIG_USB_FASTBOOT_BUF_ADDR
17573aab70afSSebastian Siewior		The fastboot protocol requires a large memory buffer for
17583aab70afSSebastian Siewior		downloads. Define this to the starting RAM address to use for
17593aab70afSSebastian Siewior		downloaded images.
17603aab70afSSebastian Siewior
17613aab70afSSebastian Siewior		CONFIG_USB_FASTBOOT_BUF_SIZE
17623aab70afSSebastian Siewior		The fastboot protocol requires a large memory buffer for
17633aab70afSSebastian Siewior		downloads. This buffer should be as large as possible for a
17643aab70afSSebastian Siewior		platform. Define this to the size available RAM for fastboot.
17653aab70afSSebastian Siewior
1766d1b5ed07SSteve Rae		CONFIG_FASTBOOT_FLASH
1767d1b5ed07SSteve Rae		The fastboot protocol includes a "flash" command for writing
1768d1b5ed07SSteve Rae		the downloaded image to a non-volatile storage device. Define
1769d1b5ed07SSteve Rae		this to enable the "fastboot flash" command.
1770d1b5ed07SSteve Rae
1771d1b5ed07SSteve Rae		CONFIG_FASTBOOT_FLASH_MMC_DEV
1772d1b5ed07SSteve Rae		The fastboot "flash" command requires additional information
1773d1b5ed07SSteve Rae		regarding the non-volatile storage device. Define this to
1774d1b5ed07SSteve Rae		the eMMC device that fastboot should use to store the image.
1775d1b5ed07SSteve Rae
17766705d81eSwdenk- Journaling Flash filesystem support:
17776705d81eSwdenk		CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
17786705d81eSwdenk		CONFIG_JFFS2_NAND_DEV
17796705d81eSwdenk		Define these for a default partition on a NAND device
17806705d81eSwdenk
17816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_SECTOR,
17826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
17836705d81eSwdenk		Define these for a default partition on a NOR device
17846705d81eSwdenk
17856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS_CUSTOM_PART
17866705d81eSwdenk		Define this to create an own partition. You have to provide a
17876705d81eSwdenk		function struct part_info* jffs2_part_info(int part_num)
17886705d81eSwdenk
17896705d81eSwdenk		If you define only one JFFS2 partition you may also want to
17906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_JFFS_SINGLE_PART	1
17916705d81eSwdenk		to disable the command chpart. This is the default when you
17926705d81eSwdenk		have not defined a custom partition
17936705d81eSwdenk
1794c30a15e5SDonggeun Kim- FAT(File Allocation Table) filesystem write function support:
1795c30a15e5SDonggeun Kim		CONFIG_FAT_WRITE
1796656f4c65SDonggeun Kim
1797656f4c65SDonggeun Kim		Define this to enable support for saving memory data as a
1798656f4c65SDonggeun Kim		file in FAT formatted partition.
1799656f4c65SDonggeun Kim
1800656f4c65SDonggeun Kim		This will also enable the command "fatwrite" enabling the
1801656f4c65SDonggeun Kim		user to write files to FAT.
1802c30a15e5SDonggeun Kim
180384cd9327SGabe BlackCBFS (Coreboot Filesystem) support
180484cd9327SGabe Black		CONFIG_CMD_CBFS
180584cd9327SGabe Black
180684cd9327SGabe Black		Define this to enable support for reading from a Coreboot
180784cd9327SGabe Black		filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
180884cd9327SGabe Black		and cbfsload.
180984cd9327SGabe Black
18104f0d1a2aSSiva Durga Prasad Paladugu- FAT(File Allocation Table) filesystem cluster size:
18114f0d1a2aSSiva Durga Prasad Paladugu		CONFIG_FS_FAT_MAX_CLUSTSIZE
18124f0d1a2aSSiva Durga Prasad Paladugu
18134f0d1a2aSSiva Durga Prasad Paladugu		Define the max cluster size for fat operations else
18144f0d1a2aSSiva Durga Prasad Paladugu		a default value of 65536 will be defined.
18154f0d1a2aSSiva Durga Prasad Paladugu
1816c609719bSwdenk- Keyboard Support:
1817c609719bSwdenk		CONFIG_ISA_KEYBOARD
1818c609719bSwdenk
1819c609719bSwdenk		Define this to enable standard (PC-Style) keyboard
1820c609719bSwdenk		support
1821c609719bSwdenk
1822c609719bSwdenk		CONFIG_I8042_KBD
1823c609719bSwdenk		Standard PC keyboard driver with US (is default) and
1824c609719bSwdenk		GERMAN key layout (switch via environment 'keymap=de') support.
1825c609719bSwdenk		Export function i8042_kbd_init, i8042_tstc and i8042_getc
1826c609719bSwdenk		for cfb_console. Supports cursor blinking.
1827c609719bSwdenk
1828713cb680SHung-ying Tyan		CONFIG_CROS_EC_KEYB
1829713cb680SHung-ying Tyan		Enables a Chrome OS keyboard using the CROS_EC interface.
1830713cb680SHung-ying Tyan		This uses CROS_EC to communicate with a second microcontroller
1831713cb680SHung-ying Tyan		which provides key scans on request.
1832713cb680SHung-ying Tyan
1833c609719bSwdenk- Video support:
1834c609719bSwdenk		CONFIG_VIDEO
1835c609719bSwdenk
1836c609719bSwdenk		Define this to enable video support (for output to
1837c609719bSwdenk		video).
1838c609719bSwdenk
1839c609719bSwdenk		CONFIG_VIDEO_CT69000
1840c609719bSwdenk
1841c609719bSwdenk		Enable Chips & Technologies 69000 Video chip
1842c609719bSwdenk
1843c609719bSwdenk		CONFIG_VIDEO_SMI_LYNXEM
1844eeb1b77bSwdenk		Enable Silicon Motion SMI 712/710/810 Video chip. The
1845eeb1b77bSwdenk		video output is selected via environment 'videoout'
1846eeb1b77bSwdenk		(1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1847eeb1b77bSwdenk		assumed.
1848c609719bSwdenk
1849eeb1b77bSwdenk		For the CT69000 and SMI_LYNXEM drivers, videomode is
185011ccc33fSMarcel Ziswiler		selected via environment 'videomode'. Two different ways
1851eeb1b77bSwdenk		are possible:
1852eeb1b77bSwdenk		- "videomode=num"   'num' is a standard LiLo mode numbers.
1853eeb1b77bSwdenk		Following standard modes are supported	(* is default):
1854eeb1b77bSwdenk
1855eeb1b77bSwdenk		      Colors	640x480 800x600 1024x768 1152x864 1280x1024
1856eeb1b77bSwdenk		-------------+---------------------------------------------
1857eeb1b77bSwdenk		      8 bits |	0x301*	0x303	 0x305	  0x161	    0x307
1858eeb1b77bSwdenk		     15 bits |	0x310	0x313	 0x316	  0x162	    0x319
1859eeb1b77bSwdenk		     16 bits |	0x311	0x314	 0x317	  0x163	    0x31A
1860eeb1b77bSwdenk		     24 bits |	0x312	0x315	 0x318	    ?	    0x31B
1861eeb1b77bSwdenk		-------------+---------------------------------------------
1862c609719bSwdenk		(i.e. setenv videomode 317; saveenv; reset;)
1863c609719bSwdenk
1864eeb1b77bSwdenk		- "videomode=bootargs" all the video parameters are parsed
18657817cb20SMarcel Ziswiler		from the bootargs. (See drivers/video/videomodes.c)
1866eeb1b77bSwdenk
1867eeb1b77bSwdenk
1868a6c7ad2fSwdenk		CONFIG_VIDEO_SED13806
1869a6c7ad2fSwdenk		Enable Epson SED13806 driver. This driver supports 8bpp
1870a6c7ad2fSwdenk		and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1871a6c7ad2fSwdenk		or CONFIG_VIDEO_SED13806_16BPP
1872a6c7ad2fSwdenk
18737d3053fbSTimur Tabi		CONFIG_FSL_DIU_FB
18747d3053fbSTimur Tabi		Enable the Freescale DIU video driver.	Reference boards for
18757d3053fbSTimur Tabi		SOCs that have a DIU should define this macro to enable DIU
18767d3053fbSTimur Tabi		support, and should also define these other macros:
18777d3053fbSTimur Tabi
18787d3053fbSTimur Tabi			CONFIG_SYS_DIU_ADDR
18797d3053fbSTimur Tabi			CONFIG_VIDEO
18807d3053fbSTimur Tabi			CONFIG_CMD_BMP
18817d3053fbSTimur Tabi			CONFIG_CFB_CONSOLE
18827d3053fbSTimur Tabi			CONFIG_VIDEO_SW_CURSOR
18837d3053fbSTimur Tabi			CONFIG_VGA_AS_SINGLE_DEVICE
18847d3053fbSTimur Tabi			CONFIG_VIDEO_LOGO
18857d3053fbSTimur Tabi			CONFIG_VIDEO_BMP_LOGO
18867d3053fbSTimur Tabi
1887ba8e76bdSTimur Tabi		The DIU driver will look for the 'video-mode' environment
1888ba8e76bdSTimur Tabi		variable, and if defined, enable the DIU as a console during
1889ba8e76bdSTimur Tabi		boot.  See the documentation file README.video for a
1890ba8e76bdSTimur Tabi		description of this variable.
18917d3053fbSTimur Tabi
1892058d59b0SSimon Glass		CONFIG_VIDEO_VGA
1893058d59b0SSimon Glass
1894058d59b0SSimon Glass		Enable the VGA video / BIOS for x86. The alternative if you
1895058d59b0SSimon Glass		are using coreboot is to use the coreboot frame buffer
1896058d59b0SSimon Glass		driver.
1897058d59b0SSimon Glass
1898058d59b0SSimon Glass
1899682011ffSwdenk- Keyboard Support:
1900682011ffSwdenk		CONFIG_KEYBOARD
1901682011ffSwdenk
1902682011ffSwdenk		Define this to enable a custom keyboard support.
1903682011ffSwdenk		This simply calls drv_keyboard_init() which must be
1904682011ffSwdenk		defined in your board-specific files.
1905682011ffSwdenk		The only board using this so far is RBC823.
1906a6c7ad2fSwdenk
1907c609719bSwdenk- LCD Support:	CONFIG_LCD
1908c609719bSwdenk
1909c609719bSwdenk		Define this to enable LCD support (for output to LCD
1910c609719bSwdenk		display); also select one of the supported displays
1911c609719bSwdenk		by defining one of these:
1912c609719bSwdenk
191339cf4804SStelian Pop		CONFIG_ATMEL_LCD:
191439cf4804SStelian Pop
191539cf4804SStelian Pop			HITACHI TX09D70VM1CCA, 3.5", 240x320.
191639cf4804SStelian Pop
1917fd3103bbSwdenk		CONFIG_NEC_NL6448AC33:
1918c609719bSwdenk
1919fd3103bbSwdenk			NEC NL6448AC33-18. Active, color, single scan.
1920c609719bSwdenk
1921fd3103bbSwdenk		CONFIG_NEC_NL6448BC20
1922c609719bSwdenk
1923fd3103bbSwdenk			NEC NL6448BC20-08. 6.5", 640x480.
1924fd3103bbSwdenk			Active, color, single scan.
1925fd3103bbSwdenk
1926fd3103bbSwdenk		CONFIG_NEC_NL6448BC33_54
1927fd3103bbSwdenk
1928fd3103bbSwdenk			NEC NL6448BC33-54. 10.4", 640x480.
1929c609719bSwdenk			Active, color, single scan.
1930c609719bSwdenk
1931c609719bSwdenk		CONFIG_SHARP_16x9
1932c609719bSwdenk
1933c609719bSwdenk			Sharp 320x240. Active, color, single scan.
1934c609719bSwdenk			It isn't 16x9, and I am not sure what it is.
1935c609719bSwdenk
1936c609719bSwdenk		CONFIG_SHARP_LQ64D341
1937c609719bSwdenk
1938c609719bSwdenk			Sharp LQ64D341 display, 640x480.
1939c609719bSwdenk			Active, color, single scan.
1940c609719bSwdenk
1941c609719bSwdenk		CONFIG_HLD1045
1942c609719bSwdenk
1943c609719bSwdenk			HLD1045 display, 640x480.
1944c609719bSwdenk			Active, color, single scan.
1945c609719bSwdenk
1946c609719bSwdenk		CONFIG_OPTREX_BW
1947c609719bSwdenk
1948c609719bSwdenk			Optrex	 CBL50840-2 NF-FW 99 22 M5
1949c609719bSwdenk			or
1950c609719bSwdenk			Hitachi	 LMG6912RPFC-00T
1951c609719bSwdenk			or
1952c609719bSwdenk			Hitachi	 SP14Q002
1953c609719bSwdenk
1954c609719bSwdenk			320x240. Black & white.
1955c609719bSwdenk
1956c609719bSwdenk		Normally display is black on white background; define
19576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
1958c609719bSwdenk
1959676d319eSSimon Glass		CONFIG_LCD_ALIGNMENT
1960676d319eSSimon Glass
1961676d319eSSimon Glass		Normally the LCD is page-aligned (tyically 4KB). If this is
1962676d319eSSimon Glass		defined then the LCD will be aligned to this value instead.
1963676d319eSSimon Glass		For ARM it is sometimes useful to use MMU_SECTION_SIZE
1964676d319eSSimon Glass		here, since it is cheaper to change data cache settings on
1965676d319eSSimon Glass		a per-section basis.
1966676d319eSSimon Glass
19670d89efefSSimon Glass		CONFIG_CONSOLE_SCROLL_LINES
19680d89efefSSimon Glass
19690d89efefSSimon Glass		When the console need to be scrolled, this is the number of
19700d89efefSSimon Glass		lines to scroll by. It defaults to 1. Increasing this makes
19710d89efefSSimon Glass		the console jump but can help speed up operation when scrolling
19720d89efefSSimon Glass		is slow.
1973676d319eSSimon Glass
197445d7f525STom Wai-Hong Tam		CONFIG_LCD_BMP_RLE8
197545d7f525STom Wai-Hong Tam
197645d7f525STom Wai-Hong Tam		Support drawing of RLE8-compressed bitmaps on the LCD.
197745d7f525STom Wai-Hong Tam
1978735987c5STom Wai-Hong Tam		CONFIG_I2C_EDID
1979735987c5STom Wai-Hong Tam
1980735987c5STom Wai-Hong Tam		Enables an 'i2c edid' command which can read EDID
1981735987c5STom Wai-Hong Tam		information over I2C from an attached LCD display.
1982735987c5STom Wai-Hong Tam
19837152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN
1984d791b1dcSwdenk
1985d791b1dcSwdenk		If this option is set, the environment is checked for
1986d791b1dcSwdenk		a variable "splashimage". If found, the usual display
1987d791b1dcSwdenk		of logo, copyright and system information on the LCD
1988e94d2cd9Swdenk		is suppressed and the BMP image at the address
1989d791b1dcSwdenk		specified in "splashimage" is loaded instead. The
1990d791b1dcSwdenk		console is redirected to the "nulldev", too. This
1991d791b1dcSwdenk		allows for a "silent" boot where a splash screen is
1992d791b1dcSwdenk		loaded very quickly after power-on.
1993d791b1dcSwdenk
1994c0880485SNikita Kiryanov		CONFIG_SPLASHIMAGE_GUARD
1995c0880485SNikita Kiryanov
1996c0880485SNikita Kiryanov		If this option is set, then U-Boot will prevent the environment
1997c0880485SNikita Kiryanov		variable "splashimage" from being set to a problematic address
19981551df35STom Rini		(see README.displaying-bmps).
1999c0880485SNikita Kiryanov		This option is useful for targets where, due to alignment
2000c0880485SNikita Kiryanov		restrictions, an improperly aligned BMP image will cause a data
2001c0880485SNikita Kiryanov		abort. If you think you will not have problems with unaligned
2002c0880485SNikita Kiryanov		accesses (for example because your toolchain prevents them)
2003c0880485SNikita Kiryanov		there is no need to set this option.
2004c0880485SNikita Kiryanov
20051ca298ceSMatthias Weisser		CONFIG_SPLASH_SCREEN_ALIGN
20061ca298ceSMatthias Weisser
20071ca298ceSMatthias Weisser		If this option is set the splash image can be freely positioned
20081ca298ceSMatthias Weisser		on the screen. Environment variable "splashpos" specifies the
20091ca298ceSMatthias Weisser		position as "x,y". If a positive number is given it is used as
20101ca298ceSMatthias Weisser		number of pixel from left/top. If a negative number is given it
20111ca298ceSMatthias Weisser		is used as number of pixel from right/bottom. You can also
20121ca298ceSMatthias Weisser		specify 'm' for centering the image.
20131ca298ceSMatthias Weisser
20141ca298ceSMatthias Weisser		Example:
20151ca298ceSMatthias Weisser		setenv splashpos m,m
20161ca298ceSMatthias Weisser			=> image at center of screen
20171ca298ceSMatthias Weisser
20181ca298ceSMatthias Weisser		setenv splashpos 30,20
20191ca298ceSMatthias Weisser			=> image at x = 30 and y = 20
20201ca298ceSMatthias Weisser
20211ca298ceSMatthias Weisser		setenv splashpos -10,m
20221ca298ceSMatthias Weisser			=> vertically centered image
20231ca298ceSMatthias Weisser			   at x = dspWidth - bmpWidth - 9
20241ca298ceSMatthias Weisser
202598f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
202698f4a3dfSStefan Roese
202798f4a3dfSStefan Roese		If this option is set, additionally to standard BMP
202898f4a3dfSStefan Roese		images, gzipped BMP images can be displayed via the
202998f4a3dfSStefan Roese		splashscreen support or the bmp command.
203098f4a3dfSStefan Roese
2031d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
2032d5011762SAnatolij Gustschin
2033d5011762SAnatolij Gustschin		If this option is set, 8-bit RLE compressed BMP images
2034d5011762SAnatolij Gustschin		can be displayed via the splashscreen support or the
2035d5011762SAnatolij Gustschin		bmp command.
2036d5011762SAnatolij Gustschin
2037f2b96dfbSLei Wen- Do compresssing for memory range:
2038f2b96dfbSLei Wen		CONFIG_CMD_ZIP
2039f2b96dfbSLei Wen
2040f2b96dfbSLei Wen		If this option is set, it would use zlib deflate method
2041f2b96dfbSLei Wen		to compress the specified memory at its best effort.
2042f2b96dfbSLei Wen
2043c29fdfc1Swdenk- Compression support:
20448ef70478SKees Cook		CONFIG_GZIP
20458ef70478SKees Cook
20468ef70478SKees Cook		Enabled by default to support gzip compressed images.
20478ef70478SKees Cook
2048c29fdfc1Swdenk		CONFIG_BZIP2
2049c29fdfc1Swdenk
2050c29fdfc1Swdenk		If this option is set, support for bzip2 compressed
2051c29fdfc1Swdenk		images is included. If not, only uncompressed and gzip
2052c29fdfc1Swdenk		compressed images are supported.
2053c29fdfc1Swdenk
2054c29fdfc1Swdenk		NOTE: the bzip2 algorithm requires a lot of RAM, so
20556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
2056c29fdfc1Swdenk		be at least 4MB.
2057d791b1dcSwdenk
2058fc9c1727SLuigi 'Comio' Mantellini		CONFIG_LZMA
2059fc9c1727SLuigi 'Comio' Mantellini
2060fc9c1727SLuigi 'Comio' Mantellini		If this option is set, support for lzma compressed
2061fc9c1727SLuigi 'Comio' Mantellini		images is included.
2062fc9c1727SLuigi 'Comio' Mantellini
2063fc9c1727SLuigi 'Comio' Mantellini		Note: The LZMA algorithm adds between 2 and 4KB of code and it
2064fc9c1727SLuigi 'Comio' Mantellini		requires an amount of dynamic memory that is given by the
2065fc9c1727SLuigi 'Comio' Mantellini		formula:
2066fc9c1727SLuigi 'Comio' Mantellini
2067fc9c1727SLuigi 'Comio' Mantellini			(1846 + 768 << (lc + lp)) * sizeof(uint16)
2068fc9c1727SLuigi 'Comio' Mantellini
2069fc9c1727SLuigi 'Comio' Mantellini		Where lc and lp stand for, respectively, Literal context bits
2070fc9c1727SLuigi 'Comio' Mantellini		and Literal pos bits.
2071fc9c1727SLuigi 'Comio' Mantellini
2072fc9c1727SLuigi 'Comio' Mantellini		This value is upper-bounded by 14MB in the worst case. Anyway,
2073fc9c1727SLuigi 'Comio' Mantellini		for a ~4MB large kernel image, we have lc=3 and lp=0 for a
2074fc9c1727SLuigi 'Comio' Mantellini		total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
2075fc9c1727SLuigi 'Comio' Mantellini		a very small buffer.
2076fc9c1727SLuigi 'Comio' Mantellini
2077fc9c1727SLuigi 'Comio' Mantellini		Use the lzmainfo tool to determinate the lc and lp values and
2078fc9c1727SLuigi 'Comio' Mantellini		then calculate the amount of needed dynamic memory (ensuring
20796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the appropriate CONFIG_SYS_MALLOC_LEN value).
2080fc9c1727SLuigi 'Comio' Mantellini
20818ef70478SKees Cook		CONFIG_LZO
20828ef70478SKees Cook
20838ef70478SKees Cook		If this option is set, support for LZO compressed images
20848ef70478SKees Cook		is included.
20858ef70478SKees Cook
208617ea1177Swdenk- MII/PHY support:
208717ea1177Swdenk		CONFIG_PHY_ADDR
208817ea1177Swdenk
208917ea1177Swdenk		The address of PHY on MII bus.
209017ea1177Swdenk
209117ea1177Swdenk		CONFIG_PHY_CLOCK_FREQ (ppc4xx)
209217ea1177Swdenk
209317ea1177Swdenk		The clock frequency of the MII bus
209417ea1177Swdenk
209517ea1177Swdenk		CONFIG_PHY_GIGE
209617ea1177Swdenk
209717ea1177Swdenk		If this option is set, support for speed/duplex
209811ccc33fSMarcel Ziswiler		detection of gigabit PHY is included.
209917ea1177Swdenk
210017ea1177Swdenk		CONFIG_PHY_RESET_DELAY
210117ea1177Swdenk
210217ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
210317ea1177Swdenk		reset before any MII register access is possible.
210417ea1177Swdenk		For such PHY, set this option to the usec delay
210517ea1177Swdenk		required. (minimum 300usec for LXT971A)
210617ea1177Swdenk
210717ea1177Swdenk		CONFIG_PHY_CMD_DELAY (ppc4xx)
210817ea1177Swdenk
210917ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
211017ea1177Swdenk		command issued before MII status register can be read
211117ea1177Swdenk
2112c609719bSwdenk- Ethernet address:
2113c609719bSwdenk		CONFIG_ETHADDR
2114c68a05feSrichardretanubun		CONFIG_ETH1ADDR
2115c609719bSwdenk		CONFIG_ETH2ADDR
2116c609719bSwdenk		CONFIG_ETH3ADDR
2117c68a05feSrichardretanubun		CONFIG_ETH4ADDR
2118c68a05feSrichardretanubun		CONFIG_ETH5ADDR
2119c609719bSwdenk
212011ccc33fSMarcel Ziswiler		Define a default value for Ethernet address to use
212111ccc33fSMarcel Ziswiler		for the respective Ethernet interface, in case this
2122c609719bSwdenk		is not determined automatically.
2123c609719bSwdenk
2124c609719bSwdenk- IP address:
2125c609719bSwdenk		CONFIG_IPADDR
2126c609719bSwdenk
2127c609719bSwdenk		Define a default value for the IP address to use for
212811ccc33fSMarcel Ziswiler		the default Ethernet interface, in case this is not
2129c609719bSwdenk		determined through e.g. bootp.
21301ebcd654SWolfgang Denk		(Environment variable "ipaddr")
2131c609719bSwdenk
2132c609719bSwdenk- Server IP address:
2133c609719bSwdenk		CONFIG_SERVERIP
2134c609719bSwdenk
2135c609719bSwdenk		Defines a default value for the IP address of a TFTP
2136c609719bSwdenk		server to contact when using the "tftboot" command.
21371ebcd654SWolfgang Denk		(Environment variable "serverip")
2138c609719bSwdenk
213997cfe861SRobin Getz		CONFIG_KEEP_SERVERADDR
214097cfe861SRobin Getz
214197cfe861SRobin Getz		Keeps the server's MAC address, in the env 'serveraddr'
214297cfe861SRobin Getz		for passing to bootargs (like Linux's netconsole option)
214397cfe861SRobin Getz
21441ebcd654SWolfgang Denk- Gateway IP address:
21451ebcd654SWolfgang Denk		CONFIG_GATEWAYIP
21461ebcd654SWolfgang Denk
21471ebcd654SWolfgang Denk		Defines a default value for the IP address of the
21481ebcd654SWolfgang Denk		default router where packets to other networks are
21491ebcd654SWolfgang Denk		sent to.
21501ebcd654SWolfgang Denk		(Environment variable "gatewayip")
21511ebcd654SWolfgang Denk
21521ebcd654SWolfgang Denk- Subnet mask:
21531ebcd654SWolfgang Denk		CONFIG_NETMASK
21541ebcd654SWolfgang Denk
21551ebcd654SWolfgang Denk		Defines a default value for the subnet mask (or
21561ebcd654SWolfgang Denk		routing prefix) which is used to determine if an IP
21571ebcd654SWolfgang Denk		address belongs to the local subnet or needs to be
21581ebcd654SWolfgang Denk		forwarded through a router.
21591ebcd654SWolfgang Denk		(Environment variable "netmask")
21601ebcd654SWolfgang Denk
216153a5c424SDavid Updegraff- Multicast TFTP Mode:
216253a5c424SDavid Updegraff		CONFIG_MCAST_TFTP
216353a5c424SDavid Updegraff
216453a5c424SDavid Updegraff		Defines whether you want to support multicast TFTP as per
216553a5c424SDavid Updegraff		rfc-2090; for example to work with atftp.  Lets lots of targets
216611ccc33fSMarcel Ziswiler		tftp down the same boot image concurrently.  Note: the Ethernet
216753a5c424SDavid Updegraff		driver in use must provide a function: mcast() to join/leave a
216853a5c424SDavid Updegraff		multicast group.
216953a5c424SDavid Updegraff
2170c609719bSwdenk- BOOTP Recovery Mode:
2171c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY
2172c609719bSwdenk
2173c609719bSwdenk		If you have many targets in a network that try to
2174c609719bSwdenk		boot using BOOTP, you may want to avoid that all
2175c609719bSwdenk		systems send out BOOTP requests at precisely the same
2176c609719bSwdenk		moment (which would happen for instance at recovery
2177c609719bSwdenk		from a power failure, when all systems will try to
2178c609719bSwdenk		boot, thus flooding the BOOTP server. Defining
2179c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
2180c609719bSwdenk		inserted before sending out BOOTP requests. The
21816c33c785SWolfgang Denk		following delays are inserted then:
2182c609719bSwdenk
2183c609719bSwdenk		1st BOOTP request:	delay 0 ... 1 sec
2184c609719bSwdenk		2nd BOOTP request:	delay 0 ... 2 sec
2185c609719bSwdenk		3rd BOOTP request:	delay 0 ... 4 sec
2186c609719bSwdenk		4th and following
2187c609719bSwdenk		BOOTP requests:		delay 0 ... 8 sec
2188c609719bSwdenk
218992ac8accSThierry Reding		CONFIG_BOOTP_ID_CACHE_SIZE
219092ac8accSThierry Reding
219192ac8accSThierry Reding		BOOTP packets are uniquely identified using a 32-bit ID. The
219292ac8accSThierry Reding		server will copy the ID from client requests to responses and
219392ac8accSThierry Reding		U-Boot will use this to determine if it is the destination of
219492ac8accSThierry Reding		an incoming response. Some servers will check that addresses
219592ac8accSThierry Reding		aren't in use before handing them out (usually using an ARP
219692ac8accSThierry Reding		ping) and therefore take up to a few hundred milliseconds to
219792ac8accSThierry Reding		respond. Network congestion may also influence the time it
219892ac8accSThierry Reding		takes for a response to make it back to the client. If that
219992ac8accSThierry Reding		time is too long, U-Boot will retransmit requests. In order
220092ac8accSThierry Reding		to allow earlier responses to still be accepted after these
220192ac8accSThierry Reding		retransmissions, U-Boot's BOOTP client keeps a small cache of
220292ac8accSThierry Reding		IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
220392ac8accSThierry Reding		cache. The default is to keep IDs for up to four outstanding
220492ac8accSThierry Reding		requests. Increasing this will allow U-Boot to accept offers
220592ac8accSThierry Reding		from a BOOTP client in networks with unusually high latency.
220692ac8accSThierry Reding
2207fe389a82Sstroese- DHCP Advanced Options:
22081fe80d79SJon Loeliger		You can fine tune the DHCP functionality by defining
22091fe80d79SJon Loeliger		CONFIG_BOOTP_* symbols:
2210fe389a82Sstroese
22111fe80d79SJon Loeliger		CONFIG_BOOTP_SUBNETMASK
22121fe80d79SJon Loeliger		CONFIG_BOOTP_GATEWAY
22131fe80d79SJon Loeliger		CONFIG_BOOTP_HOSTNAME
22141fe80d79SJon Loeliger		CONFIG_BOOTP_NISDOMAIN
22151fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTPATH
22161fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTFILESIZE
22171fe80d79SJon Loeliger		CONFIG_BOOTP_DNS
22181fe80d79SJon Loeliger		CONFIG_BOOTP_DNS2
22191fe80d79SJon Loeliger		CONFIG_BOOTP_SEND_HOSTNAME
22201fe80d79SJon Loeliger		CONFIG_BOOTP_NTPSERVER
22211fe80d79SJon Loeliger		CONFIG_BOOTP_TIMEOFFSET
22221fe80d79SJon Loeliger		CONFIG_BOOTP_VENDOREX
22232c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL
2224fe389a82Sstroese
22255d110f0aSWilson Callan		CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
22265d110f0aSWilson Callan		environment variable, not the BOOTP server.
2227fe389a82Sstroese
22282c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
22292c00e099SJoe Hershberger		after the configured retry count, the call will fail
22302c00e099SJoe Hershberger		instead of starting over.  This can be used to fail over
22312c00e099SJoe Hershberger		to Link-local IP address configuration if the DHCP server
22322c00e099SJoe Hershberger		is not available.
22332c00e099SJoe Hershberger
2234fe389a82Sstroese		CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
2235fe389a82Sstroese		serverip from a DHCP server, it is possible that more
2236fe389a82Sstroese		than one DNS serverip is offered to the client.
2237fe389a82Sstroese		If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
2238fe389a82Sstroese		serverip will be stored in the additional environment
2239fe389a82Sstroese		variable "dnsip2". The first DNS serverip is always
2240fe389a82Sstroese		stored in the variable "dnsip", when CONFIG_BOOTP_DNS
22411fe80d79SJon Loeliger		is defined.
2242fe389a82Sstroese
2243fe389a82Sstroese		CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
2244fe389a82Sstroese		to do a dynamic update of a DNS server. To do this, they
2245fe389a82Sstroese		need the hostname of the DHCP requester.
22465d110f0aSWilson Callan		If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
22471fe80d79SJon Loeliger		of the "hostname" environment variable is passed as
22481fe80d79SJon Loeliger		option 12 to the DHCP server.
2249fe389a82Sstroese
2250d9a2f416SAras Vaichas		CONFIG_BOOTP_DHCP_REQUEST_DELAY
2251d9a2f416SAras Vaichas
2252d9a2f416SAras Vaichas		A 32bit value in microseconds for a delay between
2253d9a2f416SAras Vaichas		receiving a "DHCP Offer" and sending the "DHCP Request".
2254d9a2f416SAras Vaichas		This fixes a problem with certain DHCP servers that don't
2255d9a2f416SAras Vaichas		respond 100% of the time to a "DHCP request". E.g. On an
2256d9a2f416SAras Vaichas		AT91RM9200 processor running at 180MHz, this delay needed
2257d9a2f416SAras Vaichas		to be *at least* 15,000 usec before a Windows Server 2003
2258d9a2f416SAras Vaichas		DHCP server would reply 100% of the time. I recommend at
2259d9a2f416SAras Vaichas		least 50,000 usec to be safe. The alternative is to hope
2260d9a2f416SAras Vaichas		that one of the retries will be successful but note that
2261d9a2f416SAras Vaichas		the DHCP timeout and retry process takes a longer than
2262d9a2f416SAras Vaichas		this delay.
2263d9a2f416SAras Vaichas
2264d22c338eSJoe Hershberger - Link-local IP address negotiation:
2265d22c338eSJoe Hershberger		Negotiate with other link-local clients on the local network
2266d22c338eSJoe Hershberger		for an address that doesn't require explicit configuration.
2267d22c338eSJoe Hershberger		This is especially useful if a DHCP server cannot be guaranteed
2268d22c338eSJoe Hershberger		to exist in all environments that the device must operate.
2269d22c338eSJoe Hershberger
2270d22c338eSJoe Hershberger		See doc/README.link-local for more information.
2271d22c338eSJoe Hershberger
2272a3d991bdSwdenk - CDP Options:
2273a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID
2274a3d991bdSwdenk
2275a3d991bdSwdenk		The device id used in CDP trigger frames.
2276a3d991bdSwdenk
2277a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID_PREFIX
2278a3d991bdSwdenk
2279a3d991bdSwdenk		A two character string which is prefixed to the MAC address
2280a3d991bdSwdenk		of the device.
2281a3d991bdSwdenk
2282a3d991bdSwdenk		CONFIG_CDP_PORT_ID
2283a3d991bdSwdenk
2284a3d991bdSwdenk		A printf format string which contains the ascii name of
2285a3d991bdSwdenk		the port. Normally is set to "eth%d" which sets
228611ccc33fSMarcel Ziswiler		eth0 for the first Ethernet, eth1 for the second etc.
2287a3d991bdSwdenk
2288a3d991bdSwdenk		CONFIG_CDP_CAPABILITIES
2289a3d991bdSwdenk
2290a3d991bdSwdenk		A 32bit integer which indicates the device capabilities;
2291a3d991bdSwdenk		0x00000010 for a normal host which does not forwards.
2292a3d991bdSwdenk
2293a3d991bdSwdenk		CONFIG_CDP_VERSION
2294a3d991bdSwdenk
2295a3d991bdSwdenk		An ascii string containing the version of the software.
2296a3d991bdSwdenk
2297a3d991bdSwdenk		CONFIG_CDP_PLATFORM
2298a3d991bdSwdenk
2299a3d991bdSwdenk		An ascii string containing the name of the platform.
2300a3d991bdSwdenk
2301a3d991bdSwdenk		CONFIG_CDP_TRIGGER
2302a3d991bdSwdenk
2303a3d991bdSwdenk		A 32bit integer sent on the trigger.
2304a3d991bdSwdenk
2305a3d991bdSwdenk		CONFIG_CDP_POWER_CONSUMPTION
2306a3d991bdSwdenk
2307a3d991bdSwdenk		A 16bit integer containing the power consumption of the
2308a3d991bdSwdenk		device in .1 of milliwatts.
2309a3d991bdSwdenk
2310a3d991bdSwdenk		CONFIG_CDP_APPLIANCE_VLAN_TYPE
2311a3d991bdSwdenk
2312a3d991bdSwdenk		A byte containing the id of the VLAN.
2313a3d991bdSwdenk
2314c609719bSwdenk- Status LED:	CONFIG_STATUS_LED
2315c609719bSwdenk
2316c609719bSwdenk		Several configurations allow to display the current
2317c609719bSwdenk		status using a LED. For instance, the LED will blink
2318c609719bSwdenk		fast while running U-Boot code, stop blinking as
2319c609719bSwdenk		soon as a reply to a BOOTP request was received, and
2320c609719bSwdenk		start blinking slow once the Linux kernel is running
2321c609719bSwdenk		(supported by a status LED driver in the Linux
2322c609719bSwdenk		kernel). Defining CONFIG_STATUS_LED enables this
2323c609719bSwdenk		feature in U-Boot.
2324c609719bSwdenk
23251df7bbbaSIgor Grinberg		Additional options:
23261df7bbbaSIgor Grinberg
23271df7bbbaSIgor Grinberg		CONFIG_GPIO_LED
23281df7bbbaSIgor Grinberg		The status LED can be connected to a GPIO pin.
23291df7bbbaSIgor Grinberg		In such cases, the gpio_led driver can be used as a
23301df7bbbaSIgor Grinberg		status LED backend implementation. Define CONFIG_GPIO_LED
23311df7bbbaSIgor Grinberg		to include the gpio_led driver in the U-Boot binary.
23321df7bbbaSIgor Grinberg
23339dfdcdfeSIgor Grinberg		CONFIG_GPIO_LED_INVERTED_TABLE
23349dfdcdfeSIgor Grinberg		Some GPIO connected LEDs may have inverted polarity in which
23359dfdcdfeSIgor Grinberg		case the GPIO high value corresponds to LED off state and
23369dfdcdfeSIgor Grinberg		GPIO low value corresponds to LED on state.
23379dfdcdfeSIgor Grinberg		In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
23389dfdcdfeSIgor Grinberg		with a list of GPIO LEDs that have inverted polarity.
23399dfdcdfeSIgor Grinberg
2340c609719bSwdenk- CAN Support:	CONFIG_CAN_DRIVER
2341c609719bSwdenk
2342c609719bSwdenk		Defining CONFIG_CAN_DRIVER enables CAN driver support
2343c609719bSwdenk		on those systems that support this (optional)
2344c609719bSwdenk		feature, like the TQM8xxL modules.
2345c609719bSwdenk
23463f4978c7SHeiko Schocher- I2C Support:	CONFIG_SYS_I2C
2347c609719bSwdenk
23483f4978c7SHeiko Schocher		This enable the NEW i2c subsystem, and will allow you to use
23493f4978c7SHeiko Schocher		i2c commands at the u-boot command line (as long as you set
23503f4978c7SHeiko Schocher		CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
23513f4978c7SHeiko Schocher		based realtime clock chips or other i2c devices. See
23523f4978c7SHeiko Schocher		common/cmd_i2c.c for a description of the command line
23533f4978c7SHeiko Schocher		interface.
23543f4978c7SHeiko Schocher
23553f4978c7SHeiko Schocher		ported i2c driver to the new framework:
2356ea818dbbSHeiko Schocher		- drivers/i2c/soft_i2c.c:
2357ea818dbbSHeiko Schocher		  - activate first bus with CONFIG_SYS_I2C_SOFT define
2358ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2359ea818dbbSHeiko Schocher		    for defining speed and slave address
2360ea818dbbSHeiko Schocher		  - activate second bus with I2C_SOFT_DECLARATIONS2 define
2361ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2362ea818dbbSHeiko Schocher		    for defining speed and slave address
2363ea818dbbSHeiko Schocher		  - activate third bus with I2C_SOFT_DECLARATIONS3 define
2364ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2365ea818dbbSHeiko Schocher		    for defining speed and slave address
2366ea818dbbSHeiko Schocher		  - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2367ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2368ea818dbbSHeiko Schocher		    for defining speed and slave address
23693f4978c7SHeiko Schocher
237000f792e0SHeiko Schocher		- drivers/i2c/fsl_i2c.c:
237100f792e0SHeiko Schocher		  - activate i2c driver with CONFIG_SYS_I2C_FSL
237200f792e0SHeiko Schocher		    define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
237300f792e0SHeiko Schocher		    offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
237400f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
237500f792e0SHeiko Schocher		    bus.
237600f792e0SHeiko Schocher		  - If your board supports a second fsl i2c bus, define
237700f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
237800f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_SPEED for the speed and
237900f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
238000f792e0SHeiko Schocher		    second bus.
238100f792e0SHeiko Schocher
23821f2ba722SSimon Glass		- drivers/i2c/tegra_i2c.c:
23831f2ba722SSimon Glass		  - activate this driver with CONFIG_SYS_I2C_TEGRA
23841f2ba722SSimon Glass		  - This driver adds 4 i2c buses with a fix speed from
23851f2ba722SSimon Glass		    100000 and the slave addr 0!
23861f2ba722SSimon Glass
2387880540deSDirk Eibach		- drivers/i2c/ppc4xx_i2c.c
2388880540deSDirk Eibach		  - activate this driver with CONFIG_SYS_I2C_PPC4XX
2389880540deSDirk Eibach		  - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2390880540deSDirk Eibach		  - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2391880540deSDirk Eibach
2392fac96408Strem		- drivers/i2c/i2c_mxc.c
2393fac96408Strem		  - activate this driver with CONFIG_SYS_I2C_MXC
2394fac96408Strem		  - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2395fac96408Strem		  - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2396fac96408Strem		  - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2397fac96408Strem		  - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2398fac96408Strem		  - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2399fac96408Strem		  - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
2400fac96408Strem		If thoses defines are not set, default value is 100000
2401fac96408Strem		for speed, and 0 for slave.
2402fac96408Strem
24031086bfa9SNobuhiro Iwamatsu		- drivers/i2c/rcar_i2c.c:
24041086bfa9SNobuhiro Iwamatsu		  - activate this driver with CONFIG_SYS_I2C_RCAR
24051086bfa9SNobuhiro Iwamatsu		  - This driver adds 4 i2c buses
24061086bfa9SNobuhiro Iwamatsu
24071086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
24081086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
24091086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
24101086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
24111086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
24121086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
24131086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
24141086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
24151086bfa9SNobuhiro Iwamatsu		  - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
24161086bfa9SNobuhiro Iwamatsu
24172035d77dSNobuhiro Iwamatsu		- drivers/i2c/sh_i2c.c:
24182035d77dSNobuhiro Iwamatsu		  - activate this driver with CONFIG_SYS_I2C_SH
24192035d77dSNobuhiro Iwamatsu		  - This driver adds from 2 to 5 i2c buses
24202035d77dSNobuhiro Iwamatsu
24212035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
24222035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
24232035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
24242035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
24252035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
24262035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
24272035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
24282035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
24292035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
24302035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
24312035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
24322035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
24332035d77dSNobuhiro Iwamatsu		  - CONFIF_SYS_I2C_SH_NUM_CONTROLLERS for nummber of i2c buses
24342035d77dSNobuhiro Iwamatsu
24356789e84eSHeiko Schocher		- drivers/i2c/omap24xx_i2c.c
24366789e84eSHeiko Schocher		  - activate this driver with CONFIG_SYS_I2C_OMAP24XX
24376789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
24386789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
24396789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
24406789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
24416789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
24426789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
24436789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
24446789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
24456789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
24466789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
24476789e84eSHeiko Schocher
24480bdffe71SHeiko Schocher		- drivers/i2c/zynq_i2c.c
24490bdffe71SHeiko Schocher		  - activate this driver with CONFIG_SYS_I2C_ZYNQ
24500bdffe71SHeiko Schocher		  - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
24510bdffe71SHeiko Schocher		  - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
24520bdffe71SHeiko Schocher
2453e717fc6dSNaveen Krishna Ch		- drivers/i2c/s3c24x0_i2c.c:
2454e717fc6dSNaveen Krishna Ch		  - activate this driver with CONFIG_SYS_I2C_S3C24X0
2455e717fc6dSNaveen Krishna Ch		  - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2456e717fc6dSNaveen Krishna Ch		    9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2457e717fc6dSNaveen Krishna Ch		    with a fix speed from 100000 and the slave addr 0!
2458e717fc6dSNaveen Krishna Ch
2459b46226bdSDirk Eibach		- drivers/i2c/ihs_i2c.c
2460b46226bdSDirk Eibach		  - activate this driver with CONFIG_SYS_I2C_IHS
2461b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
2462b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
2463b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
2464b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
2465b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
2466b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
2467b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
2468b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
2469b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
2470b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
2471b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
2472b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
2473b46226bdSDirk Eibach
24743f4978c7SHeiko Schocher		additional defines:
24753f4978c7SHeiko Schocher
24763f4978c7SHeiko Schocher		CONFIG_SYS_NUM_I2C_BUSES
24773f4978c7SHeiko Schocher		Hold the number of i2c busses you want to use. If you
24783f4978c7SHeiko Schocher		don't use/have i2c muxes on your i2c bus, this
24793f4978c7SHeiko Schocher		is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
24803f4978c7SHeiko Schocher		omit this define.
24813f4978c7SHeiko Schocher
24823f4978c7SHeiko Schocher		CONFIG_SYS_I2C_DIRECT_BUS
24833f4978c7SHeiko Schocher		define this, if you don't use i2c muxes on your hardware.
24843f4978c7SHeiko Schocher		if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
24853f4978c7SHeiko Schocher		omit this define.
24863f4978c7SHeiko Schocher
24873f4978c7SHeiko Schocher		CONFIG_SYS_I2C_MAX_HOPS
24883f4978c7SHeiko Schocher		define how many muxes are maximal consecutively connected
24893f4978c7SHeiko Schocher		on one i2c bus. If you not use i2c muxes, omit this
24903f4978c7SHeiko Schocher		define.
24913f4978c7SHeiko Schocher
24923f4978c7SHeiko Schocher		CONFIG_SYS_I2C_BUSES
24933f4978c7SHeiko Schocher		hold a list of busses you want to use, only used if
24943f4978c7SHeiko Schocher		CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
24953f4978c7SHeiko Schocher		a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
24963f4978c7SHeiko Schocher		CONFIG_SYS_NUM_I2C_BUSES = 9:
24973f4978c7SHeiko Schocher
24983f4978c7SHeiko Schocher		 CONFIG_SYS_I2C_BUSES	{{0, {I2C_NULL_HOP}}, \
24993f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
25003f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
25013f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
25023f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
25033f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
25043f4978c7SHeiko Schocher					{1, {I2C_NULL_HOP}}, \
25053f4978c7SHeiko Schocher					{1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
25063f4978c7SHeiko Schocher					{1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
25073f4978c7SHeiko Schocher					}
25083f4978c7SHeiko Schocher
25093f4978c7SHeiko Schocher		which defines
25103f4978c7SHeiko Schocher			bus 0 on adapter 0 without a mux
2511ea818dbbSHeiko Schocher			bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2512ea818dbbSHeiko Schocher			bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2513ea818dbbSHeiko Schocher			bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2514ea818dbbSHeiko Schocher			bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2515ea818dbbSHeiko Schocher			bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
25163f4978c7SHeiko Schocher			bus 6 on adapter 1 without a mux
2517ea818dbbSHeiko Schocher			bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2518ea818dbbSHeiko Schocher			bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
25193f4978c7SHeiko Schocher
25203f4978c7SHeiko Schocher		If you do not have i2c muxes on your board, omit this define.
25213f4978c7SHeiko Schocher
2522ea818dbbSHeiko Schocher- Legacy I2C Support:	CONFIG_HARD_I2C
25233f4978c7SHeiko Schocher
25243f4978c7SHeiko Schocher		NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
25253f4978c7SHeiko Schocher		provides the following compelling advantages:
25263f4978c7SHeiko Schocher
25273f4978c7SHeiko Schocher		- more than one i2c adapter is usable
25283f4978c7SHeiko Schocher		- approved multibus support
25293f4978c7SHeiko Schocher		- better i2c mux support
25303f4978c7SHeiko Schocher
25313f4978c7SHeiko Schocher		** Please consider updating your I2C driver now. **
25323f4978c7SHeiko Schocher
2533ea818dbbSHeiko Schocher		These enable legacy I2C serial bus commands. Defining
2534ea818dbbSHeiko Schocher		CONFIG_HARD_I2C will include the appropriate I2C driver
2535ea818dbbSHeiko Schocher		for the selected CPU.
2536c609719bSwdenk
2537b37c7e5eSwdenk		This will allow you to use i2c commands at the u-boot
2538602ad3b3SJon Loeliger		command line (as long as you set CONFIG_CMD_I2C in
2539b37c7e5eSwdenk		CONFIG_COMMANDS) and communicate with i2c based realtime
2540b37c7e5eSwdenk		clock chips. See common/cmd_i2c.c for a description of the
2541c609719bSwdenk		command line interface.
2542c609719bSwdenk
2543bb99ad6dSBen Warren		CONFIG_HARD_I2C selects a hardware I2C controller.
2544c609719bSwdenk
2545b37c7e5eSwdenk		There are several other quantities that must also be
2546ea818dbbSHeiko Schocher		defined when you define CONFIG_HARD_I2C.
2547c609719bSwdenk
25486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		In both cases you will need to define CONFIG_SYS_I2C_SPEED
2549b37c7e5eSwdenk		to be the frequency (in Hz) at which you wish your i2c bus
25506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
255111ccc33fSMarcel Ziswiler		the CPU's i2c node address).
2552c609719bSwdenk
25538d321b81SPeter Tyser		Now, the u-boot i2c code for the mpc8xx
2554a47a12beSStefan Roese		(arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
25558d321b81SPeter Tyser		and so its address should therefore be cleared to 0 (See,
25568d321b81SPeter Tyser		eg, MPC823e User's Manual p.16-473). So, set
25578d321b81SPeter Tyser		CONFIG_SYS_I2C_SLAVE to 0.
2558b37c7e5eSwdenk
25595da71efaSEric Millbrandt		CONFIG_SYS_I2C_INIT_MPC5XXX
25605da71efaSEric Millbrandt
25615da71efaSEric Millbrandt		When a board is reset during an i2c bus transfer
25625da71efaSEric Millbrandt		chips might think that the current transfer is still
25635da71efaSEric Millbrandt		in progress.  Reset the slave devices by sending start
25645da71efaSEric Millbrandt		commands until the slave device responds.
25655da71efaSEric Millbrandt
2566b37c7e5eSwdenk		That's all that's required for CONFIG_HARD_I2C.
2567b37c7e5eSwdenk
2568ea818dbbSHeiko Schocher		If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
2569b37c7e5eSwdenk		then the following macros need to be defined (examples are
2570b37c7e5eSwdenk		from include/configs/lwmon.h):
2571c609719bSwdenk
2572c609719bSwdenk		I2C_INIT
2573c609719bSwdenk
2574b37c7e5eSwdenk		(Optional). Any commands necessary to enable the I2C
2575c609719bSwdenk		controller or configure ports.
2576c609719bSwdenk
2577b37c7e5eSwdenk		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
2578b37c7e5eSwdenk
2579c609719bSwdenk		I2C_PORT
2580c609719bSwdenk
2581c609719bSwdenk		(Only for MPC8260 CPU). The I/O port to use (the code
2582c609719bSwdenk		assumes both bits are on the same port). Valid values
2583c609719bSwdenk		are 0..3 for ports A..D.
2584c609719bSwdenk
2585c609719bSwdenk		I2C_ACTIVE
2586c609719bSwdenk
2587c609719bSwdenk		The code necessary to make the I2C data line active
2588c609719bSwdenk		(driven).  If the data line is open collector, this
2589c609719bSwdenk		define can be null.
2590c609719bSwdenk
2591b37c7e5eSwdenk		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
2592b37c7e5eSwdenk
2593c609719bSwdenk		I2C_TRISTATE
2594c609719bSwdenk
2595c609719bSwdenk		The code necessary to make the I2C data line tri-stated
2596c609719bSwdenk		(inactive).  If the data line is open collector, this
2597c609719bSwdenk		define can be null.
2598c609719bSwdenk
2599b37c7e5eSwdenk		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2600b37c7e5eSwdenk
2601c609719bSwdenk		I2C_READ
2602c609719bSwdenk
2603472d5460SYork Sun		Code that returns true if the I2C data line is high,
2604472d5460SYork Sun		false if it is low.
2605c609719bSwdenk
2606b37c7e5eSwdenk		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2607b37c7e5eSwdenk
2608c609719bSwdenk		I2C_SDA(bit)
2609c609719bSwdenk
2610472d5460SYork Sun		If <bit> is true, sets the I2C data line high. If it
2611472d5460SYork Sun		is false, it clears it (low).
2612c609719bSwdenk
2613b37c7e5eSwdenk		eg: #define I2C_SDA(bit) \
2614b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
2615b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
2616b37c7e5eSwdenk
2617c609719bSwdenk		I2C_SCL(bit)
2618c609719bSwdenk
2619472d5460SYork Sun		If <bit> is true, sets the I2C clock line high. If it
2620472d5460SYork Sun		is false, it clears it (low).
2621c609719bSwdenk
2622b37c7e5eSwdenk		eg: #define I2C_SCL(bit) \
2623b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
2624b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
2625b37c7e5eSwdenk
2626c609719bSwdenk		I2C_DELAY
2627c609719bSwdenk
2628c609719bSwdenk		This delay is invoked four times per clock cycle so this
2629c609719bSwdenk		controls the rate of data transfer.  The data rate thus
2630b37c7e5eSwdenk		is 1 / (I2C_DELAY * 4). Often defined to be something
2631b37c7e5eSwdenk		like:
2632b37c7e5eSwdenk
2633b37c7e5eSwdenk		#define I2C_DELAY  udelay(2)
2634c609719bSwdenk
2635793b5726SMike Frysinger		CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2636793b5726SMike Frysinger
2637793b5726SMike Frysinger		If your arch supports the generic GPIO framework (asm/gpio.h),
2638793b5726SMike Frysinger		then you may alternatively define the two GPIOs that are to be
2639793b5726SMike Frysinger		used as SCL / SDA.  Any of the previous I2C_xxx macros will
2640793b5726SMike Frysinger		have GPIO-based defaults assigned to them as appropriate.
2641793b5726SMike Frysinger
2642793b5726SMike Frysinger		You should define these to the GPIO value as given directly to
2643793b5726SMike Frysinger		the generic GPIO functions.
2644793b5726SMike Frysinger
26456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_INIT_BOARD
264647cd00faSwdenk
264747cd00faSwdenk		When a board is reset during an i2c bus transfer
264847cd00faSwdenk		chips might think that the current transfer is still
264947cd00faSwdenk		in progress. On some boards it is possible to access
265047cd00faSwdenk		the i2c SCLK line directly, either by using the
265147cd00faSwdenk		processor pin as a GPIO or by having a second pin
265247cd00faSwdenk		connected to the bus. If this option is defined a
265347cd00faSwdenk		custom i2c_init_board() routine in boards/xxx/board.c
265447cd00faSwdenk		is run early in the boot sequence.
265547cd00faSwdenk
265626a33504SRichard Retanubun		CONFIG_SYS_I2C_BOARD_LATE_INIT
265726a33504SRichard Retanubun
265826a33504SRichard Retanubun		An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
265926a33504SRichard Retanubun		defined a custom i2c_board_late_init() routine in
266026a33504SRichard Retanubun		boards/xxx/board.c is run AFTER the operations in i2c_init()
266126a33504SRichard Retanubun		is completed. This callpoint can be used to unreset i2c bus
266226a33504SRichard Retanubun		using CPU i2c controller register accesses for CPUs whose i2c
266326a33504SRichard Retanubun		controller provide such a method. It is called at the end of
266426a33504SRichard Retanubun		i2c_init() to allow i2c_init operations to setup the i2c bus
266526a33504SRichard Retanubun		controller on the CPU (e.g. setting bus speed & slave address).
266626a33504SRichard Retanubun
266717ea1177Swdenk		CONFIG_I2CFAST (PPC405GP|PPC405EP only)
266817ea1177Swdenk
266917ea1177Swdenk		This option enables configuration of bi_iic_fast[] flags
267017ea1177Swdenk		in u-boot bd_info structure based on u-boot environment
267117ea1177Swdenk		variable "i2cfast". (see also i2cfast)
267217ea1177Swdenk
2673bb99ad6dSBen Warren		CONFIG_I2C_MULTI_BUS
2674bb99ad6dSBen Warren
2675bb99ad6dSBen Warren		This option allows the use of multiple I2C buses, each of which
2676bb99ad6dSBen Warren		must have a controller.	 At any point in time, only one bus is
2677bb99ad6dSBen Warren		active.	 To switch to a different bus, use the 'i2c dev' command.
2678bb99ad6dSBen Warren		Note that bus numbering is zero-based.
2679bb99ad6dSBen Warren
26806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_NOPROBES
2681bb99ad6dSBen Warren
2682bb99ad6dSBen Warren		This option specifies a list of I2C devices that will be skipped
26830f89c54bSPeter Tyser		when the 'i2c probe' command is issued.	 If CONFIG_I2C_MULTI_BUS
26840f89c54bSPeter Tyser		is set, specify a list of bus-device pairs.  Otherwise, specify
26850f89c54bSPeter Tyser		a 1D array of device addresses
2686bb99ad6dSBen Warren
2687bb99ad6dSBen Warren		e.g.
2688bb99ad6dSBen Warren			#undef	CONFIG_I2C_MULTI_BUS
26896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
2690bb99ad6dSBen Warren
2691bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on a board with one I2C bus
2692bb99ad6dSBen Warren
2693bb99ad6dSBen Warren			#define CONFIG_I2C_MULTI_BUS
26946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_MULTI_NOPROBES	{{0,0x50},{0,0x68},{1,0x54}}
2695bb99ad6dSBen Warren
2696bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2697bb99ad6dSBen Warren
26986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SPD_BUS_NUM
2699be5e6181STimur Tabi
2700be5e6181STimur Tabi		If defined, then this indicates the I2C bus number for DDR SPD.
2701be5e6181STimur Tabi		If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2702be5e6181STimur Tabi
27036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_BUS_NUM
27040dc018ecSStefan Roese
27050dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the RTC.
27060dc018ecSStefan Roese		If not defined, then U-Boot assumes that RTC is on I2C bus 0.
27070dc018ecSStefan Roese
27086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_DTT_BUS_NUM
27090dc018ecSStefan Roese
27100dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the DTT.
27110dc018ecSStefan Roese		If not defined, then U-Boot assumes that DTT is on I2C bus 0.
27120dc018ecSStefan Roese
27136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_DTT_ADDR:
27149ebbb54fSVictor Gallardo
27159ebbb54fSVictor Gallardo		If defined, specifies the I2C address of the DTT device.
27169ebbb54fSVictor Gallardo		If not defined, then U-Boot uses predefined value for
27179ebbb54fSVictor Gallardo		specified DTT device.
27189ebbb54fSVictor Gallardo
27192ac6985aSAndrew Dyer		CONFIG_SOFT_I2C_READ_REPEATED_START
27202ac6985aSAndrew Dyer
27212ac6985aSAndrew Dyer		defining this will force the i2c_read() function in
27222ac6985aSAndrew Dyer		the soft_i2c driver to perform an I2C repeated start
27232ac6985aSAndrew Dyer		between writing the address pointer and reading the
27242ac6985aSAndrew Dyer		data.  If this define is omitted the default behaviour
27252ac6985aSAndrew Dyer		of doing a stop-start sequence will be used.  Most I2C
27262ac6985aSAndrew Dyer		devices can use either method, but some require one or
27272ac6985aSAndrew Dyer		the other.
2728be5e6181STimur Tabi
2729c609719bSwdenk- SPI Support:	CONFIG_SPI
2730c609719bSwdenk
2731c609719bSwdenk		Enables SPI driver (so far only tested with
2732c609719bSwdenk		SPI EEPROM, also an instance works with Crystal A/D and
2733c609719bSwdenk		D/As on the SACSng board)
2734c609719bSwdenk
27356639562eSYoshihiro Shimoda		CONFIG_SH_SPI
27366639562eSYoshihiro Shimoda
27376639562eSYoshihiro Shimoda		Enables the driver for SPI controller on SuperH. Currently
27386639562eSYoshihiro Shimoda		only SH7757 is supported.
27396639562eSYoshihiro Shimoda
2740c609719bSwdenk		CONFIG_SPI_X
2741c609719bSwdenk
2742c609719bSwdenk		Enables extended (16-bit) SPI EEPROM addressing.
2743c609719bSwdenk		(symmetrical to CONFIG_I2C_X)
2744c609719bSwdenk
2745c609719bSwdenk		CONFIG_SOFT_SPI
2746c609719bSwdenk
2747c609719bSwdenk		Enables a software (bit-bang) SPI driver rather than
2748c609719bSwdenk		using hardware support. This is a general purpose
2749c609719bSwdenk		driver that only requires three general I/O port pins
2750c609719bSwdenk		(two outputs, one input) to function. If this is
2751c609719bSwdenk		defined, the board configuration must define several
2752c609719bSwdenk		SPI configuration items (port pins to use, etc). For
2753c609719bSwdenk		an example, see include/configs/sacsng.h.
2754c609719bSwdenk
275504a9e118SBen Warren		CONFIG_HARD_SPI
275604a9e118SBen Warren
275704a9e118SBen Warren		Enables a hardware SPI driver for general-purpose reads
275804a9e118SBen Warren		and writes.  As with CONFIG_SOFT_SPI, the board configuration
275904a9e118SBen Warren		must define a list of chip-select function pointers.
276004a9e118SBen Warren		Currently supported on some MPC8xxx processors.	 For an
276104a9e118SBen Warren		example, see include/configs/mpc8349emds.h.
276204a9e118SBen Warren
276338254f45SGuennadi Liakhovetski		CONFIG_MXC_SPI
276438254f45SGuennadi Liakhovetski
276538254f45SGuennadi Liakhovetski		Enables the driver for the SPI controllers on i.MX and MXC
27662e3cd1cdSFabio Estevam		SoCs. Currently i.MX31/35/51 are supported.
276738254f45SGuennadi Liakhovetski
2768f659b573SHeiko Schocher		CONFIG_SYS_SPI_MXC_WAIT
2769f659b573SHeiko Schocher		Timeout for waiting until spi transfer completed.
2770f659b573SHeiko Schocher		default: (CONFIG_SYS_HZ/100)     /* 10 ms */
2771f659b573SHeiko Schocher
27720133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA
27730133502eSMatthias Fuchs
27740133502eSMatthias Fuchs		Enables FPGA subsystem.
27750133502eSMatthias Fuchs
27760133502eSMatthias Fuchs		CONFIG_FPGA_<vendor>
27770133502eSMatthias Fuchs
27780133502eSMatthias Fuchs		Enables support for specific chip vendors.
27790133502eSMatthias Fuchs		(ALTERA, XILINX)
27800133502eSMatthias Fuchs
27810133502eSMatthias Fuchs		CONFIG_FPGA_<family>
27820133502eSMatthias Fuchs
27830133502eSMatthias Fuchs		Enables support for FPGA family.
27840133502eSMatthias Fuchs		(SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
27850133502eSMatthias Fuchs
27860133502eSMatthias Fuchs		CONFIG_FPGA_COUNT
2787c609719bSwdenk
2788c609719bSwdenk		Specify the number of FPGA devices to support.
2789c609719bSwdenk
279064e809afSSiva Durga Prasad Paladugu		CONFIG_CMD_FPGA_LOADMK
279164e809afSSiva Durga Prasad Paladugu
279264e809afSSiva Durga Prasad Paladugu		Enable support for fpga loadmk command
279364e809afSSiva Durga Prasad Paladugu
279467193864SMichal Simek		CONFIG_CMD_FPGA_LOADP
279567193864SMichal Simek
279667193864SMichal Simek		Enable support for fpga loadp command - load partial bitstream
279767193864SMichal Simek
279867193864SMichal Simek		CONFIG_CMD_FPGA_LOADBP
279967193864SMichal Simek
280067193864SMichal Simek		Enable support for fpga loadbp command - load partial bitstream
280167193864SMichal Simek		(Xilinx only)
280267193864SMichal Simek
28036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_PROG_FEEDBACK
2804c609719bSwdenk
2805c609719bSwdenk		Enable printing of hash marks during FPGA configuration.
2806c609719bSwdenk
28076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_BUSY
2808c609719bSwdenk
2809c609719bSwdenk		Enable checks on FPGA configuration interface busy
2810c609719bSwdenk		status by the configuration function. This option
2811c609719bSwdenk		will require a board or device specific function to
2812c609719bSwdenk		be written.
2813c609719bSwdenk
2814c609719bSwdenk		CONFIG_FPGA_DELAY
2815c609719bSwdenk
2816c609719bSwdenk		If defined, a function that provides delays in the FPGA
2817c609719bSwdenk		configuration driver.
2818c609719bSwdenk
28196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_CTRLC
2820c609719bSwdenk		Allow Control-C to interrupt FPGA configuration
2821c609719bSwdenk
28226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_ERROR
2823c609719bSwdenk
2824c609719bSwdenk		Check for configuration errors during FPGA bitfile
2825c609719bSwdenk		loading. For example, abort during Virtex II
2826c609719bSwdenk		configuration if the INIT_B line goes low (which
2827c609719bSwdenk		indicated a CRC error).
2828c609719bSwdenk
28296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_INIT
2830c609719bSwdenk
2831c609719bSwdenk		Maximum time to wait for the INIT_B line to deassert
2832c609719bSwdenk		after PROB_B has been deasserted during a Virtex II
2833c609719bSwdenk		FPGA configuration sequence. The default time is 500
283411ccc33fSMarcel Ziswiler		ms.
2835c609719bSwdenk
28366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_BUSY
2837c609719bSwdenk
2838c609719bSwdenk		Maximum time to wait for BUSY to deassert during
283911ccc33fSMarcel Ziswiler		Virtex II FPGA configuration. The default is 5 ms.
2840c609719bSwdenk
28416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_CONFIG
2842c609719bSwdenk
2843c609719bSwdenk		Time to wait after FPGA configuration. The default is
284411ccc33fSMarcel Ziswiler		200 ms.
2845c609719bSwdenk
2846c609719bSwdenk- Configuration Management:
2847b2b8a696SStefan Roese		CONFIG_BUILD_TARGET
2848b2b8a696SStefan Roese
2849b2b8a696SStefan Roese		Some SoCs need special image types (e.g. U-Boot binary
2850b2b8a696SStefan Roese		with a special header) as build targets. By defining
2851b2b8a696SStefan Roese		CONFIG_BUILD_TARGET in the SoC / board header, this
2852b2b8a696SStefan Roese		special image will be automatically built upon calling
2853b2b8a696SStefan Roese		make / MAKEALL.
2854b2b8a696SStefan Roese
2855c609719bSwdenk		CONFIG_IDENT_STRING
2856c609719bSwdenk
2857c609719bSwdenk		If defined, this string will be added to the U-Boot
2858c609719bSwdenk		version information (U_BOOT_VERSION)
2859c609719bSwdenk
2860c609719bSwdenk- Vendor Parameter Protection:
2861c609719bSwdenk
2862c609719bSwdenk		U-Boot considers the values of the environment
2863c609719bSwdenk		variables "serial#" (Board Serial Number) and
28647152b1d0Swdenk		"ethaddr" (Ethernet Address) to be parameters that
2865c609719bSwdenk		are set once by the board vendor / manufacturer, and
2866c609719bSwdenk		protects these variables from casual modification by
2867c609719bSwdenk		the user. Once set, these variables are read-only,
2868c609719bSwdenk		and write or delete attempts are rejected. You can
286911ccc33fSMarcel Ziswiler		change this behaviour:
2870c609719bSwdenk
2871c609719bSwdenk		If CONFIG_ENV_OVERWRITE is #defined in your config
2872c609719bSwdenk		file, the write protection for vendor parameters is
287347cd00faSwdenk		completely disabled. Anybody can change or delete
2874c609719bSwdenk		these parameters.
2875c609719bSwdenk
2876c609719bSwdenk		Alternatively, if you #define _both_ CONFIG_ETHADDR
2877c609719bSwdenk		_and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
287811ccc33fSMarcel Ziswiler		Ethernet address is installed in the environment,
2879c609719bSwdenk		which can be changed exactly ONCE by the user. [The
2880c609719bSwdenk		serial# is unaffected by this, i. e. it remains
2881c609719bSwdenk		read-only.]
2882c609719bSwdenk
28832598090bSJoe Hershberger		The same can be accomplished in a more flexible way
28842598090bSJoe Hershberger		for any variable by configuring the type of access
28852598090bSJoe Hershberger		to allow for those variables in the ".flags" variable
28862598090bSJoe Hershberger		or define CONFIG_ENV_FLAGS_LIST_STATIC.
28872598090bSJoe Hershberger
2888c609719bSwdenk- Protected RAM:
2889c609719bSwdenk		CONFIG_PRAM
2890c609719bSwdenk
2891c609719bSwdenk		Define this variable to enable the reservation of
2892c609719bSwdenk		"protected RAM", i. e. RAM which is not overwritten
2893c609719bSwdenk		by U-Boot. Define CONFIG_PRAM to hold the number of
2894c609719bSwdenk		kB you want to reserve for pRAM. You can overwrite
2895c609719bSwdenk		this default value by defining an environment
2896c609719bSwdenk		variable "pram" to the number of kB you want to
2897c609719bSwdenk		reserve. Note that the board info structure will
2898c609719bSwdenk		still show the full amount of RAM. If pRAM is
2899c609719bSwdenk		reserved, a new environment variable "mem" will
2900c609719bSwdenk		automatically be defined to hold the amount of
2901c609719bSwdenk		remaining RAM in a form that can be passed as boot
2902c609719bSwdenk		argument to Linux, for instance like that:
2903c609719bSwdenk
2904fe126d8bSWolfgang Denk			setenv bootargs ... mem=\${mem}
2905c609719bSwdenk			saveenv
2906c609719bSwdenk
2907c609719bSwdenk		This way you can tell Linux not to use this memory,
2908c609719bSwdenk		either, which results in a memory region that will
2909c609719bSwdenk		not be affected by reboots.
2910c609719bSwdenk
2911c609719bSwdenk		*WARNING* If your board configuration uses automatic
2912c609719bSwdenk		detection of the RAM size, you must make sure that
2913c609719bSwdenk		this memory test is non-destructive. So far, the
2914c609719bSwdenk		following board configurations are known to be
2915c609719bSwdenk		"pRAM-clean":
2916c609719bSwdenk
29171b0757ecSWolfgang Denk			IVMS8, IVML24, SPD8xx, TQM8xxL,
29181b0757ecSWolfgang Denk			HERMES, IP860, RPXlite, LWMON,
2919544d97e9SWolfgang Denk			FLAGADM, TQM8260
2920c609719bSwdenk
292140fef049SGabe Black- Access to physical memory region (> 4GB)
292240fef049SGabe Black		Some basic support is provided for operations on memory not
292340fef049SGabe Black		normally accessible to U-Boot - e.g. some architectures
292440fef049SGabe Black		support access to more than 4GB of memory on 32-bit
292540fef049SGabe Black		machines using physical address extension or similar.
292640fef049SGabe Black		Define CONFIG_PHYSMEM to access this basic support, which
292740fef049SGabe Black		currently only supports clearing the memory.
292840fef049SGabe Black
2929c609719bSwdenk- Error Recovery:
2930c609719bSwdenk		CONFIG_PANIC_HANG
2931c609719bSwdenk
2932c609719bSwdenk		Define this variable to stop the system in case of a
2933c609719bSwdenk		fatal error, so that you have to reset it manually.
2934c609719bSwdenk		This is probably NOT a good idea for an embedded
293511ccc33fSMarcel Ziswiler		system where you want the system to reboot
2936c609719bSwdenk		automatically as fast as possible, but it may be
2937c609719bSwdenk		useful during development since you can try to debug
2938c609719bSwdenk		the conditions that lead to the situation.
2939c609719bSwdenk
2940c609719bSwdenk		CONFIG_NET_RETRY_COUNT
2941c609719bSwdenk
2942c609719bSwdenk		This variable defines the number of retries for
2943c609719bSwdenk		network operations like ARP, RARP, TFTP, or BOOTP
2944c609719bSwdenk		before giving up the operation. If not defined, a
2945c609719bSwdenk		default value of 5 is used.
2946c609719bSwdenk
294740cb90eeSGuennadi Liakhovetski		CONFIG_ARP_TIMEOUT
294840cb90eeSGuennadi Liakhovetski
294940cb90eeSGuennadi Liakhovetski		Timeout waiting for an ARP reply in milliseconds.
295040cb90eeSGuennadi Liakhovetski
295148a3e999STetsuyuki Kobayashi		CONFIG_NFS_TIMEOUT
295248a3e999STetsuyuki Kobayashi
295348a3e999STetsuyuki Kobayashi		Timeout in milliseconds used in NFS protocol.
295448a3e999STetsuyuki Kobayashi		If you encounter "ERROR: Cannot umount" in nfs command,
295548a3e999STetsuyuki Kobayashi		try longer timeout such as
295648a3e999STetsuyuki Kobayashi		#define CONFIG_NFS_TIMEOUT 10000UL
295748a3e999STetsuyuki Kobayashi
2958c609719bSwdenk- Command Interpreter:
29598078f1a5SWolfgang Denk		CONFIG_AUTO_COMPLETE
296004a85b3bSwdenk
296104a85b3bSwdenk		Enable auto completion of commands using TAB.
296204a85b3bSwdenk
29636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_PROMPT_HUSH_PS2
2964c609719bSwdenk
2965c609719bSwdenk		This defines the secondary prompt string, which is
2966c609719bSwdenk		printed when the command interpreter needs more input
2967c609719bSwdenk		to complete a command. Usually "> ".
2968c609719bSwdenk
2969c609719bSwdenk	Note:
2970c609719bSwdenk
2971c609719bSwdenk		In the current implementation, the local variables
2972c609719bSwdenk		space and global environment variables space are
2973c609719bSwdenk		separated. Local variables are those you define by
29743b57fe0aSwdenk		simply typing `name=value'. To access a local
2975c609719bSwdenk		variable later on, you have write `$name' or
29763b57fe0aSwdenk		`${name}'; to execute the contents of a variable
29773b57fe0aSwdenk		directly type `$name' at the command prompt.
2978c609719bSwdenk
2979c609719bSwdenk		Global environment variables are those you use
2980c609719bSwdenk		setenv/printenv to work with. To run a command stored
2981c609719bSwdenk		in such a variable, you need to use the run command,
2982c609719bSwdenk		and you must not use the '$' sign to access them.
2983c609719bSwdenk
2984c609719bSwdenk		To store commands and special characters in a
2985c609719bSwdenk		variable, please use double quotation marks
2986c609719bSwdenk		surrounding the whole text of the variable, instead
2987c609719bSwdenk		of the backslashes before semicolons and special
2988c609719bSwdenk		symbols.
2989c609719bSwdenk
2990aa0c71acSWolfgang Denk- Commandline Editing and History:
2991aa0c71acSWolfgang Denk		CONFIG_CMDLINE_EDITING
2992aa0c71acSWolfgang Denk
299311ccc33fSMarcel Ziswiler		Enable editing and History functions for interactive
2994aa0c71acSWolfgang Denk		commandline input operations
2995aa0c71acSWolfgang Denk
2996a8c7c708Swdenk- Default Environment:
2997c609719bSwdenk		CONFIG_EXTRA_ENV_SETTINGS
2998c609719bSwdenk
2999c609719bSwdenk		Define this to contain any number of null terminated
3000c609719bSwdenk		strings (variable = value pairs) that will be part of
30017152b1d0Swdenk		the default environment compiled into the boot image.
30022262cfeeSwdenk
3003c609719bSwdenk		For example, place something like this in your
3004c609719bSwdenk		board's config file:
3005c609719bSwdenk
3006c609719bSwdenk		#define CONFIG_EXTRA_ENV_SETTINGS \
3007c609719bSwdenk			"myvar1=value1\0" \
3008c609719bSwdenk			"myvar2=value2\0"
3009c609719bSwdenk
3010c609719bSwdenk		Warning: This method is based on knowledge about the
3011c609719bSwdenk		internal format how the environment is stored by the
30122262cfeeSwdenk		U-Boot code. This is NOT an official, exported
3013c609719bSwdenk		interface! Although it is unlikely that this format
30147152b1d0Swdenk		will change soon, there is no guarantee either.
3015c609719bSwdenk		You better know what you are doing here.
3016c609719bSwdenk
3017c609719bSwdenk		Note: overly (ab)use of the default environment is
3018c609719bSwdenk		discouraged. Make sure to check other ways to preset
301974de7aefSWolfgang Denk		the environment like the "source" command or the
3020c609719bSwdenk		boot command first.
3021c609719bSwdenk
30225e724ca2SStephen Warren		CONFIG_ENV_VARS_UBOOT_CONFIG
30235e724ca2SStephen Warren
30245e724ca2SStephen Warren		Define this in order to add variables describing the
30255e724ca2SStephen Warren		U-Boot build configuration to the default environment.
30265e724ca2SStephen Warren		These will be named arch, cpu, board, vendor, and soc.
30275e724ca2SStephen Warren
30285e724ca2SStephen Warren		Enabling this option will cause the following to be defined:
30295e724ca2SStephen Warren
30305e724ca2SStephen Warren		- CONFIG_SYS_ARCH
30315e724ca2SStephen Warren		- CONFIG_SYS_CPU
30325e724ca2SStephen Warren		- CONFIG_SYS_BOARD
30335e724ca2SStephen Warren		- CONFIG_SYS_VENDOR
30345e724ca2SStephen Warren		- CONFIG_SYS_SOC
30355e724ca2SStephen Warren
30367e27f89fSTom Rini		CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
30377e27f89fSTom Rini
30387e27f89fSTom Rini		Define this in order to add variables describing certain
30397e27f89fSTom Rini		run-time determined information about the hardware to the
30407e27f89fSTom Rini		environment.  These will be named board_name, board_rev.
30417e27f89fSTom Rini
304206fd8538SSimon Glass		CONFIG_DELAY_ENVIRONMENT
304306fd8538SSimon Glass
304406fd8538SSimon Glass		Normally the environment is loaded when the board is
304506fd8538SSimon Glass		intialised so that it is available to U-Boot. This inhibits
304606fd8538SSimon Glass		that so that the environment is not available until
304706fd8538SSimon Glass		explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
304806fd8538SSimon Glass		this is instead controlled by the value of
304906fd8538SSimon Glass		/config/load-environment.
305006fd8538SSimon Glass
3051a8c7c708Swdenk- DataFlash Support:
30522abbe075Swdenk		CONFIG_HAS_DATAFLASH
30532abbe075Swdenk
30542abbe075Swdenk		Defining this option enables DataFlash features and
30552abbe075Swdenk		allows to read/write in Dataflash via the standard
30562abbe075Swdenk		commands cp, md...
30572abbe075Swdenk
3058f61ec45eSEric Nelson- Serial Flash support
3059f61ec45eSEric Nelson		CONFIG_CMD_SF
3060f61ec45eSEric Nelson
3061f61ec45eSEric Nelson		Defining this option enables SPI flash commands
3062f61ec45eSEric Nelson		'sf probe/read/write/erase/update'.
3063f61ec45eSEric Nelson
3064f61ec45eSEric Nelson		Usage requires an initial 'probe' to define the serial
3065f61ec45eSEric Nelson		flash parameters, followed by read/write/erase/update
3066f61ec45eSEric Nelson		commands.
3067f61ec45eSEric Nelson
3068f61ec45eSEric Nelson		The following defaults may be provided by the platform
3069f61ec45eSEric Nelson		to handle the common case when only a single serial
3070f61ec45eSEric Nelson		flash is present on the system.
3071f61ec45eSEric Nelson
3072f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_BUS		Bus identifier
3073f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_CS		Chip-select
3074f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_MODE 		(see include/spi.h)
3075f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_SPEED		in Hz
3076f61ec45eSEric Nelson
307724007273SSimon Glass		CONFIG_CMD_SF_TEST
307824007273SSimon Glass
307924007273SSimon Glass		Define this option to include a destructive SPI flash
308024007273SSimon Glass		test ('sf test').
308124007273SSimon Glass
30821dcd6d03SJagannadha Sutradharudu Teki		CONFIG_SPI_FLASH_BAR		Ban/Extended Addr Reg
30831dcd6d03SJagannadha Sutradharudu Teki
30841dcd6d03SJagannadha Sutradharudu Teki		Define this option to use the Bank addr/Extended addr
30851dcd6d03SJagannadha Sutradharudu Teki		support on SPI flashes which has size > 16Mbytes.
30861dcd6d03SJagannadha Sutradharudu Teki
3087b902e07cSJagannadha Sutradharudu Teki		CONFIG_SF_DUAL_FLASH		Dual flash memories
3088b902e07cSJagannadha Sutradharudu Teki
3089b902e07cSJagannadha Sutradharudu Teki		Define this option to use dual flash support where two flash
3090b902e07cSJagannadha Sutradharudu Teki		memories can be connected with a given cs line.
3091b902e07cSJagannadha Sutradharudu Teki		currently Xilinx Zynq qspi support these type of connections.
3092b902e07cSJagannadha Sutradharudu Teki
3093562f8df1SHeiko Schocher		CONFIG_SYS_SPI_ST_ENABLE_WP_PIN
3094562f8df1SHeiko Schocher		enable the W#/Vpp signal to disable writing to the status
3095562f8df1SHeiko Schocher		register on ST MICRON flashes like the N25Q128.
3096562f8df1SHeiko Schocher		The status register write enable/disable bit, combined with
3097562f8df1SHeiko Schocher		the W#/VPP signal provides hardware data protection for the
3098562f8df1SHeiko Schocher		device as follows: When the enable/disable bit is set to 1,
3099562f8df1SHeiko Schocher		and the W#/VPP signal is driven LOW, the status register
3100562f8df1SHeiko Schocher		nonvolatile bits become read-only and the WRITE STATUS REGISTER
3101562f8df1SHeiko Schocher		operation will not execute. The only way to exit this
3102562f8df1SHeiko Schocher		hardware-protected mode is to drive W#/VPP HIGH.
3103562f8df1SHeiko Schocher
31043f85ce27Swdenk- SystemACE Support:
31053f85ce27Swdenk		CONFIG_SYSTEMACE
31063f85ce27Swdenk
31073f85ce27Swdenk		Adding this option adds support for Xilinx SystemACE
31083f85ce27Swdenk		chips attached via some sort of local bus. The address
310911ccc33fSMarcel Ziswiler		of the chip must also be defined in the
31106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SYSTEMACE_BASE macro. For example:
31113f85ce27Swdenk
31123f85ce27Swdenk		#define CONFIG_SYSTEMACE
31136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
31143f85ce27Swdenk
31153f85ce27Swdenk		When SystemACE support is added, the "ace" device type
31163f85ce27Swdenk		becomes available to the fat commands, i.e. fatls.
31173f85ce27Swdenk
3118ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port:
3119ecb0ccd9SWolfgang Denk		CONFIG_TFTP_PORT
3120ecb0ccd9SWolfgang Denk
312128cb9375SWolfgang Denk		If this is defined, the environment variable tftpsrcp
3122ecb0ccd9SWolfgang Denk		is used to supply the TFTP UDP source port value.
312328cb9375SWolfgang Denk		If tftpsrcp isn't defined, the normal pseudo-random port
3124ecb0ccd9SWolfgang Denk		number generator is used.
3125ecb0ccd9SWolfgang Denk
312628cb9375SWolfgang Denk		Also, the environment variable tftpdstp is used to supply
312728cb9375SWolfgang Denk		the TFTP UDP destination port value.  If tftpdstp isn't
312828cb9375SWolfgang Denk		defined, the normal port 69 is used.
312928cb9375SWolfgang Denk
313028cb9375SWolfgang Denk		The purpose for tftpsrcp is to allow a TFTP server to
3131ecb0ccd9SWolfgang Denk		blindly start the TFTP transfer using the pre-configured
3132ecb0ccd9SWolfgang Denk		target IP address and UDP port. This has the effect of
3133ecb0ccd9SWolfgang Denk		"punching through" the (Windows XP) firewall, allowing
3134ecb0ccd9SWolfgang Denk		the remainder of the TFTP transfer to proceed normally.
3135ecb0ccd9SWolfgang Denk		A better solution is to properly configure the firewall,
3136ecb0ccd9SWolfgang Denk		but sometimes that is not allowed.
3137ecb0ccd9SWolfgang Denk
3138bf36c5d5SSimon Glass- Hashing support:
3139bf36c5d5SSimon Glass		CONFIG_CMD_HASH
3140bf36c5d5SSimon Glass
3141bf36c5d5SSimon Glass		This enables a generic 'hash' command which can produce
3142bf36c5d5SSimon Glass		hashes / digests from a few algorithms (e.g. SHA1, SHA256).
3143bf36c5d5SSimon Glass
3144bf36c5d5SSimon Glass		CONFIG_HASH_VERIFY
3145bf36c5d5SSimon Glass
3146bf36c5d5SSimon Glass		Enable the hash verify command (hash -v). This adds to code
3147bf36c5d5SSimon Glass		size a little.
3148bf36c5d5SSimon Glass
3149bf36c5d5SSimon Glass		CONFIG_SHA1 - support SHA1 hashing
3150bf36c5d5SSimon Glass		CONFIG_SHA256 - support SHA256 hashing
3151bf36c5d5SSimon Glass
3152bf36c5d5SSimon Glass		Note: There is also a sha1sum command, which should perhaps
3153bf36c5d5SSimon Glass		be deprecated in favour of 'hash sha1'.
3154bf36c5d5SSimon Glass
3155a11f1873SRobert Winkler- Freescale i.MX specific commands:
3156a11f1873SRobert Winkler		CONFIG_CMD_HDMIDETECT
3157a11f1873SRobert Winkler		This enables 'hdmidet' command which returns true if an
3158a11f1873SRobert Winkler		HDMI monitor is detected.  This command is i.MX 6 specific.
3159a11f1873SRobert Winkler
3160a11f1873SRobert Winkler		CONFIG_CMD_BMODE
3161a11f1873SRobert Winkler		This enables the 'bmode' (bootmode) command for forcing
3162a11f1873SRobert Winkler		a boot from specific media.
3163a11f1873SRobert Winkler
3164a11f1873SRobert Winkler		This is useful for forcing the ROM's usb downloader to
3165a11f1873SRobert Winkler		activate upon a watchdog reset which is nice when iterating
3166a11f1873SRobert Winkler		on U-Boot.  Using the reset button or running bmode normal
3167a11f1873SRobert Winkler		will set it back to normal.  This command currently
3168a11f1873SRobert Winkler		supports i.MX53 and i.MX6.
3169a11f1873SRobert Winkler
317019c402afSSimon Glass- Signing support:
317119c402afSSimon Glass		CONFIG_RSA
317219c402afSSimon Glass
317319c402afSSimon Glass		This enables the RSA algorithm used for FIT image verification
31748bf2aad7SDetlev Zundel		in U-Boot. See doc/uImage.FIT/signature.txt for more information.
317519c402afSSimon Glass
317619c402afSSimon Glass		The signing part is build into mkimage regardless of this
317719c402afSSimon Glass		option.
317819c402afSSimon Glass
31799e50c406SHeiko Schocher- bootcount support:
31809e50c406SHeiko Schocher		CONFIG_BOOTCOUNT_LIMIT
31819e50c406SHeiko Schocher
31829e50c406SHeiko Schocher		This enables the bootcounter support, see:
31839e50c406SHeiko Schocher		http://www.denx.de/wiki/DULG/UBootBootCountLimit
31849e50c406SHeiko Schocher
31859e50c406SHeiko Schocher		CONFIG_AT91SAM9XE
31869e50c406SHeiko Schocher		enable special bootcounter support on at91sam9xe based boards.
31879e50c406SHeiko Schocher		CONFIG_BLACKFIN
31889e50c406SHeiko Schocher		enable special bootcounter support on blackfin based boards.
31899e50c406SHeiko Schocher		CONFIG_SOC_DA8XX
31909e50c406SHeiko Schocher		enable special bootcounter support on da850 based boards.
31919e50c406SHeiko Schocher		CONFIG_BOOTCOUNT_RAM
31929e50c406SHeiko Schocher		enable support for the bootcounter in RAM
31939e50c406SHeiko Schocher		CONFIG_BOOTCOUNT_I2C
31949e50c406SHeiko Schocher		enable support for the bootcounter on an i2c (like RTC) device.
31959e50c406SHeiko Schocher			CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
31969e50c406SHeiko Schocher			CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
31979e50c406SHeiko Schocher						    the bootcounter.
31989e50c406SHeiko Schocher			CONFIG_BOOTCOUNT_ALEN = address len
319919c402afSSimon Glass
3200a8c7c708Swdenk- Show boot progress:
3201c609719bSwdenk		CONFIG_SHOW_BOOT_PROGRESS
3202c609719bSwdenk
3203c609719bSwdenk		Defining this option allows to add some board-
3204c609719bSwdenk		specific code (calling a user-provided function
3205c609719bSwdenk		"show_boot_progress(int)") that enables you to show
3206c609719bSwdenk		the system's boot progress on some display (for
3207c609719bSwdenk		example, some LED's) on your board. At the moment,
3208c609719bSwdenk		the following checkpoints are implemented:
3209c609719bSwdenk
32103a608ca0SSimon Glass- Detailed boot stage timing
32113a608ca0SSimon Glass		CONFIG_BOOTSTAGE
32123a608ca0SSimon Glass		Define this option to get detailed timing of each stage
32133a608ca0SSimon Glass		of the boot process.
32143a608ca0SSimon Glass
32153a608ca0SSimon Glass		CONFIG_BOOTSTAGE_USER_COUNT
32163a608ca0SSimon Glass		This is the number of available user bootstage records.
32173a608ca0SSimon Glass		Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
32183a608ca0SSimon Glass		a new ID will be allocated from this stash. If you exceed
32193a608ca0SSimon Glass		the limit, recording will stop.
32203a608ca0SSimon Glass
32213a608ca0SSimon Glass		CONFIG_BOOTSTAGE_REPORT
32223a608ca0SSimon Glass		Define this to print a report before boot, similar to this:
32233a608ca0SSimon Glass
32243a608ca0SSimon Glass		Timer summary in microseconds:
32253a608ca0SSimon Glass		       Mark    Elapsed  Stage
32263a608ca0SSimon Glass			  0          0  reset
32273a608ca0SSimon Glass		  3,575,678  3,575,678  board_init_f start
32283a608ca0SSimon Glass		  3,575,695         17  arch_cpu_init A9
32293a608ca0SSimon Glass		  3,575,777         82  arch_cpu_init done
32303a608ca0SSimon Glass		  3,659,598     83,821  board_init_r start
32313a608ca0SSimon Glass		  3,910,375    250,777  main_loop
32323a608ca0SSimon Glass		 29,916,167 26,005,792  bootm_start
32333a608ca0SSimon Glass		 30,361,327    445,160  start_kernel
32343a608ca0SSimon Glass
32352eba38cfSSimon Glass		CONFIG_CMD_BOOTSTAGE
32362eba38cfSSimon Glass		Add a 'bootstage' command which supports printing a report
32372eba38cfSSimon Glass		and un/stashing of bootstage data.
32382eba38cfSSimon Glass
323994fd1316SSimon Glass		CONFIG_BOOTSTAGE_FDT
324094fd1316SSimon Glass		Stash the bootstage information in the FDT. A root 'bootstage'
324194fd1316SSimon Glass		node is created with each bootstage id as a child. Each child
324294fd1316SSimon Glass		has a 'name' property and either 'mark' containing the
324394fd1316SSimon Glass		mark time in microsecond, or 'accum' containing the
324494fd1316SSimon Glass		accumulated time for that bootstage id in microseconds.
324594fd1316SSimon Glass		For example:
324694fd1316SSimon Glass
324794fd1316SSimon Glass		bootstage {
324894fd1316SSimon Glass			154 {
324994fd1316SSimon Glass				name = "board_init_f";
325094fd1316SSimon Glass				mark = <3575678>;
325194fd1316SSimon Glass			};
325294fd1316SSimon Glass			170 {
325394fd1316SSimon Glass				name = "lcd";
325494fd1316SSimon Glass				accum = <33482>;
325594fd1316SSimon Glass			};
325694fd1316SSimon Glass		};
325794fd1316SSimon Glass
325894fd1316SSimon Glass		Code in the Linux kernel can find this in /proc/devicetree.
325994fd1316SSimon Glass
32601372cce2SMarian BalakowiczLegacy uImage format:
32611372cce2SMarian Balakowicz
3262c609719bSwdenk  Arg	Where			When
3263c609719bSwdenk    1	common/cmd_bootm.c	before attempting to boot an image
3264c609719bSwdenk   -1	common/cmd_bootm.c	Image header has bad	 magic number
3265c609719bSwdenk    2	common/cmd_bootm.c	Image header has correct magic number
3266c609719bSwdenk   -2	common/cmd_bootm.c	Image header has bad	 checksum
3267c609719bSwdenk    3	common/cmd_bootm.c	Image header has correct checksum
3268c609719bSwdenk   -3	common/cmd_bootm.c	Image data   has bad	 checksum
3269c609719bSwdenk    4	common/cmd_bootm.c	Image data   has correct checksum
3270c609719bSwdenk   -4	common/cmd_bootm.c	Image is for unsupported architecture
3271c609719bSwdenk    5	common/cmd_bootm.c	Architecture check OK
32721372cce2SMarian Balakowicz   -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi)
3273c609719bSwdenk    6	common/cmd_bootm.c	Image Type check OK
3274c609719bSwdenk   -6	common/cmd_bootm.c	gunzip uncompression error
3275c609719bSwdenk   -7	common/cmd_bootm.c	Unimplemented compression type
3276c609719bSwdenk    7	common/cmd_bootm.c	Uncompression OK
32771372cce2SMarian Balakowicz    8	common/cmd_bootm.c	No uncompress/copy overwrite error
3278c609719bSwdenk   -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
32791372cce2SMarian Balakowicz
32801372cce2SMarian Balakowicz    9	common/image.c		Start initial ramdisk verification
32811372cce2SMarian Balakowicz  -10	common/image.c		Ramdisk header has bad	   magic number
32821372cce2SMarian Balakowicz  -11	common/image.c		Ramdisk header has bad	   checksum
32831372cce2SMarian Balakowicz   10	common/image.c		Ramdisk header is OK
32841372cce2SMarian Balakowicz  -12	common/image.c		Ramdisk data   has bad	   checksum
32851372cce2SMarian Balakowicz   11	common/image.c		Ramdisk data   has correct checksum
32861372cce2SMarian Balakowicz   12	common/image.c		Ramdisk verification complete, start loading
328711ccc33fSMarcel Ziswiler  -13	common/image.c		Wrong Image Type (not PPC Linux ramdisk)
32881372cce2SMarian Balakowicz   13	common/image.c		Start multifile image verification
32891372cce2SMarian Balakowicz   14	common/image.c		No initial ramdisk, no multifile, continue.
32901372cce2SMarian Balakowicz
3291ea0364f1SPeter Tyser   15	arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
3292c609719bSwdenk
3293a47a12beSStefan Roese  -30	arch/powerpc/lib/board.c	Fatal error, hang the system
329463e73c9aSwdenk  -31	post/post.c		POST test failed, detected by post_output_backlog()
329563e73c9aSwdenk  -32	post/post.c		POST test failed, detected by post_run_single()
329663e73c9aSwdenk
3297566a494fSHeiko Schocher   34	common/cmd_doc.c	before loading a Image from a DOC device
3298566a494fSHeiko Schocher  -35	common/cmd_doc.c	Bad usage of "doc" command
3299566a494fSHeiko Schocher   35	common/cmd_doc.c	correct usage of "doc" command
3300566a494fSHeiko Schocher  -36	common/cmd_doc.c	No boot device
3301566a494fSHeiko Schocher   36	common/cmd_doc.c	correct boot device
3302566a494fSHeiko Schocher  -37	common/cmd_doc.c	Unknown Chip ID on boot device
3303566a494fSHeiko Schocher   37	common/cmd_doc.c	correct chip ID found, device available
3304566a494fSHeiko Schocher  -38	common/cmd_doc.c	Read Error on boot device
3305566a494fSHeiko Schocher   38	common/cmd_doc.c	reading Image header from DOC device OK
3306566a494fSHeiko Schocher  -39	common/cmd_doc.c	Image header has bad magic number
3307566a494fSHeiko Schocher   39	common/cmd_doc.c	Image header has correct magic number
3308566a494fSHeiko Schocher  -40	common/cmd_doc.c	Error reading Image from DOC device
3309566a494fSHeiko Schocher   40	common/cmd_doc.c	Image header has correct magic number
3310566a494fSHeiko Schocher   41	common/cmd_ide.c	before loading a Image from a IDE device
3311566a494fSHeiko Schocher  -42	common/cmd_ide.c	Bad usage of "ide" command
3312566a494fSHeiko Schocher   42	common/cmd_ide.c	correct usage of "ide" command
3313566a494fSHeiko Schocher  -43	common/cmd_ide.c	No boot device
3314566a494fSHeiko Schocher   43	common/cmd_ide.c	boot device found
3315566a494fSHeiko Schocher  -44	common/cmd_ide.c	Device not available
3316566a494fSHeiko Schocher   44	common/cmd_ide.c	Device available
3317566a494fSHeiko Schocher  -45	common/cmd_ide.c	wrong partition selected
3318566a494fSHeiko Schocher   45	common/cmd_ide.c	partition selected
3319566a494fSHeiko Schocher  -46	common/cmd_ide.c	Unknown partition table
3320566a494fSHeiko Schocher   46	common/cmd_ide.c	valid partition table found
3321566a494fSHeiko Schocher  -47	common/cmd_ide.c	Invalid partition type
3322566a494fSHeiko Schocher   47	common/cmd_ide.c	correct partition type
3323566a494fSHeiko Schocher  -48	common/cmd_ide.c	Error reading Image Header on boot device
3324566a494fSHeiko Schocher   48	common/cmd_ide.c	reading Image Header from IDE device OK
3325566a494fSHeiko Schocher  -49	common/cmd_ide.c	Image header has bad magic number
3326566a494fSHeiko Schocher   49	common/cmd_ide.c	Image header has correct magic number
3327566a494fSHeiko Schocher  -50	common/cmd_ide.c	Image header has bad	 checksum
3328566a494fSHeiko Schocher   50	common/cmd_ide.c	Image header has correct checksum
3329566a494fSHeiko Schocher  -51	common/cmd_ide.c	Error reading Image from IDE device
3330566a494fSHeiko Schocher   51	common/cmd_ide.c	reading Image from IDE device OK
3331566a494fSHeiko Schocher   52	common/cmd_nand.c	before loading a Image from a NAND device
3332566a494fSHeiko Schocher  -53	common/cmd_nand.c	Bad usage of "nand" command
3333566a494fSHeiko Schocher   53	common/cmd_nand.c	correct usage of "nand" command
3334566a494fSHeiko Schocher  -54	common/cmd_nand.c	No boot device
3335566a494fSHeiko Schocher   54	common/cmd_nand.c	boot device found
3336566a494fSHeiko Schocher  -55	common/cmd_nand.c	Unknown Chip ID on boot device
3337566a494fSHeiko Schocher   55	common/cmd_nand.c	correct chip ID found, device available
3338566a494fSHeiko Schocher  -56	common/cmd_nand.c	Error reading Image Header on boot device
3339566a494fSHeiko Schocher   56	common/cmd_nand.c	reading Image Header from NAND device OK
3340566a494fSHeiko Schocher  -57	common/cmd_nand.c	Image header has bad magic number
3341566a494fSHeiko Schocher   57	common/cmd_nand.c	Image header has correct magic number
3342566a494fSHeiko Schocher  -58	common/cmd_nand.c	Error reading Image from NAND device
3343566a494fSHeiko Schocher   58	common/cmd_nand.c	reading Image from NAND device OK
3344c609719bSwdenk
3345566a494fSHeiko Schocher  -60	common/env_common.c	Environment has a bad CRC, using default
3346c609719bSwdenk
3347566a494fSHeiko Schocher   64	net/eth.c		starting with Ethernet configuration.
3348566a494fSHeiko Schocher  -64	net/eth.c		no Ethernet found.
3349566a494fSHeiko Schocher   65	net/eth.c		Ethernet found.
3350206c60cbSwdenk
3351566a494fSHeiko Schocher  -80	common/cmd_net.c	usage wrong
3352566a494fSHeiko Schocher   80	common/cmd_net.c	before calling NetLoop()
335311ccc33fSMarcel Ziswiler  -81	common/cmd_net.c	some error in NetLoop() occurred
3354566a494fSHeiko Schocher   81	common/cmd_net.c	NetLoop() back without error
3355566a494fSHeiko Schocher  -82	common/cmd_net.c	size == 0 (File with size 0 loaded)
3356566a494fSHeiko Schocher   82	common/cmd_net.c	trying automatic boot
335774de7aefSWolfgang Denk   83	common/cmd_net.c	running "source" command
335874de7aefSWolfgang Denk  -83	common/cmd_net.c	some error in automatic boot or "source" command
3359566a494fSHeiko Schocher   84	common/cmd_net.c	end without errors
3360c609719bSwdenk
33611372cce2SMarian BalakowiczFIT uImage format:
33621372cce2SMarian Balakowicz
33631372cce2SMarian Balakowicz  Arg	Where			When
33641372cce2SMarian Balakowicz  100	common/cmd_bootm.c	Kernel FIT Image has correct format
33651372cce2SMarian Balakowicz -100	common/cmd_bootm.c	Kernel FIT Image has incorrect format
33661372cce2SMarian Balakowicz  101	common/cmd_bootm.c	No Kernel subimage unit name, using configuration
33671372cce2SMarian Balakowicz -101	common/cmd_bootm.c	Can't get configuration for kernel subimage
33681372cce2SMarian Balakowicz  102	common/cmd_bootm.c	Kernel unit name specified
33691372cce2SMarian Balakowicz -103	common/cmd_bootm.c	Can't get kernel subimage node offset
3370f773bea8SMarian Balakowicz  103	common/cmd_bootm.c	Found configuration node
33711372cce2SMarian Balakowicz  104	common/cmd_bootm.c	Got kernel subimage node offset
33721372cce2SMarian Balakowicz -104	common/cmd_bootm.c	Kernel subimage hash verification failed
33731372cce2SMarian Balakowicz  105	common/cmd_bootm.c	Kernel subimage hash verification OK
33741372cce2SMarian Balakowicz -105	common/cmd_bootm.c	Kernel subimage is for unsupported architecture
33751372cce2SMarian Balakowicz  106	common/cmd_bootm.c	Architecture check OK
337611ccc33fSMarcel Ziswiler -106	common/cmd_bootm.c	Kernel subimage has wrong type
337711ccc33fSMarcel Ziswiler  107	common/cmd_bootm.c	Kernel subimage type OK
33781372cce2SMarian Balakowicz -107	common/cmd_bootm.c	Can't get kernel subimage data/size
33791372cce2SMarian Balakowicz  108	common/cmd_bootm.c	Got kernel subimage data/size
33801372cce2SMarian Balakowicz -108	common/cmd_bootm.c	Wrong image type (not legacy, FIT)
33811372cce2SMarian Balakowicz -109	common/cmd_bootm.c	Can't get kernel subimage type
33821372cce2SMarian Balakowicz -110	common/cmd_bootm.c	Can't get kernel subimage comp
33831372cce2SMarian Balakowicz -111	common/cmd_bootm.c	Can't get kernel subimage os
33841372cce2SMarian Balakowicz -112	common/cmd_bootm.c	Can't get kernel subimage load address
33851372cce2SMarian Balakowicz -113	common/cmd_bootm.c	Image uncompress/copy overwrite error
33861372cce2SMarian Balakowicz
33871372cce2SMarian Balakowicz  120	common/image.c		Start initial ramdisk verification
33881372cce2SMarian Balakowicz -120	common/image.c		Ramdisk FIT image has incorrect format
33891372cce2SMarian Balakowicz  121	common/image.c		Ramdisk FIT image has correct format
339011ccc33fSMarcel Ziswiler  122	common/image.c		No ramdisk subimage unit name, using configuration
33911372cce2SMarian Balakowicz -122	common/image.c		Can't get configuration for ramdisk subimage
33921372cce2SMarian Balakowicz  123	common/image.c		Ramdisk unit name specified
33931372cce2SMarian Balakowicz -124	common/image.c		Can't get ramdisk subimage node offset
33941372cce2SMarian Balakowicz  125	common/image.c		Got ramdisk subimage node offset
33951372cce2SMarian Balakowicz -125	common/image.c		Ramdisk subimage hash verification failed
33961372cce2SMarian Balakowicz  126	common/image.c		Ramdisk subimage hash verification OK
33971372cce2SMarian Balakowicz -126	common/image.c		Ramdisk subimage for unsupported architecture
33981372cce2SMarian Balakowicz  127	common/image.c		Architecture check OK
33991372cce2SMarian Balakowicz -127	common/image.c		Can't get ramdisk subimage data/size
34001372cce2SMarian Balakowicz  128	common/image.c		Got ramdisk subimage data/size
34011372cce2SMarian Balakowicz  129	common/image.c		Can't get ramdisk load address
34021372cce2SMarian Balakowicz -129	common/image.c		Got ramdisk load address
34031372cce2SMarian Balakowicz
340411ccc33fSMarcel Ziswiler -130	common/cmd_doc.c	Incorrect FIT image format
34051372cce2SMarian Balakowicz  131	common/cmd_doc.c	FIT image format OK
34061372cce2SMarian Balakowicz
340711ccc33fSMarcel Ziswiler -140	common/cmd_ide.c	Incorrect FIT image format
34081372cce2SMarian Balakowicz  141	common/cmd_ide.c	FIT image format OK
34091372cce2SMarian Balakowicz
341011ccc33fSMarcel Ziswiler -150	common/cmd_nand.c	Incorrect FIT image format
34111372cce2SMarian Balakowicz  151	common/cmd_nand.c	FIT image format OK
34121372cce2SMarian Balakowicz
341321d29f7fSHeiko Schocher- legacy image format:
341421d29f7fSHeiko Schocher		CONFIG_IMAGE_FORMAT_LEGACY
341521d29f7fSHeiko Schocher		enables the legacy image format support in U-Boot.
341621d29f7fSHeiko Schocher
341721d29f7fSHeiko Schocher		Default:
341821d29f7fSHeiko Schocher		enabled if CONFIG_FIT_SIGNATURE is not defined.
341921d29f7fSHeiko Schocher
342021d29f7fSHeiko Schocher		CONFIG_DISABLE_IMAGE_LEGACY
342121d29f7fSHeiko Schocher		disable the legacy image format
342221d29f7fSHeiko Schocher
342321d29f7fSHeiko Schocher		This define is introduced, as the legacy image format is
342421d29f7fSHeiko Schocher		enabled per default for backward compatibility.
342521d29f7fSHeiko Schocher
3426d95f6ec7SGabe Black- FIT image support:
3427d95f6ec7SGabe Black		CONFIG_FIT
3428d95f6ec7SGabe Black		Enable support for the FIT uImage format.
3429d95f6ec7SGabe Black
3430d95f6ec7SGabe Black		CONFIG_FIT_BEST_MATCH
3431d95f6ec7SGabe Black		When no configuration is explicitly selected, default to the
3432d95f6ec7SGabe Black		one whose fdt's compatibility field best matches that of
3433d95f6ec7SGabe Black		U-Boot itself. A match is considered "best" if it matches the
3434d95f6ec7SGabe Black		most specific compatibility entry of U-Boot's fdt's root node.
3435d95f6ec7SGabe Black		The order of entries in the configuration's fdt is ignored.
3436d95f6ec7SGabe Black
34373e569a6bSSimon Glass		CONFIG_FIT_SIGNATURE
34383e569a6bSSimon Glass		This option enables signature verification of FIT uImages,
34393e569a6bSSimon Glass		using a hash signed and verified using RSA. See
34403e569a6bSSimon Glass		doc/uImage.FIT/signature.txt for more details.
34413e569a6bSSimon Glass
344221d29f7fSHeiko Schocher		WARNING: When relying on signed FIT images with required
344321d29f7fSHeiko Schocher		signature check the legacy image format is default
344421d29f7fSHeiko Schocher		disabled. If a board need legacy image format support
344521d29f7fSHeiko Schocher		enable this through CONFIG_IMAGE_FORMAT_LEGACY
344621d29f7fSHeiko Schocher
34479a4f479bSDirk Eibach		CONFIG_FIT_DISABLE_SHA256
34489a4f479bSDirk Eibach		Supporting SHA256 hashes has quite an impact on binary size.
34499a4f479bSDirk Eibach		For constrained systems sha256 hash support can be disabled
34509a4f479bSDirk Eibach		with this option.
34519a4f479bSDirk Eibach
34524cf2609bSWolfgang Denk- Standalone program support:
34534cf2609bSWolfgang Denk		CONFIG_STANDALONE_LOAD_ADDR
34544cf2609bSWolfgang Denk
34556feff899SWolfgang Denk		This option defines a board specific value for the
34566feff899SWolfgang Denk		address where standalone program gets loaded, thus
34576feff899SWolfgang Denk		overwriting the architecture dependent default
34584cf2609bSWolfgang Denk		settings.
34594cf2609bSWolfgang Denk
34604cf2609bSWolfgang Denk- Frame Buffer Address:
34614cf2609bSWolfgang Denk		CONFIG_FB_ADDR
34624cf2609bSWolfgang Denk
34634cf2609bSWolfgang Denk		Define CONFIG_FB_ADDR if you want to use specific
346444a53b57SWolfgang Denk		address for frame buffer.  This is typically the case
346544a53b57SWolfgang Denk		when using a graphics controller has separate video
346644a53b57SWolfgang Denk		memory.  U-Boot will then place the frame buffer at
346744a53b57SWolfgang Denk		the given address instead of dynamically reserving it
346844a53b57SWolfgang Denk		in system RAM by calling lcd_setmem(), which grabs
346944a53b57SWolfgang Denk		the memory for the frame buffer depending on the
347044a53b57SWolfgang Denk		configured panel size.
34714cf2609bSWolfgang Denk
34724cf2609bSWolfgang Denk		Please see board_init_f function.
34734cf2609bSWolfgang Denk
3474cccfc2abSDetlev Zundel- Automatic software updates via TFTP server
3475cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP
3476cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_CNT_MAX
3477cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_MSEC_MAX
3478cccfc2abSDetlev Zundel
3479cccfc2abSDetlev Zundel		These options enable and control the auto-update feature;
3480cccfc2abSDetlev Zundel		for a more detailed description refer to doc/README.update.
3481cccfc2abSDetlev Zundel
3482cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support)
3483cccfc2abSDetlev Zundel		CONFIG_MTD_DEVICE
3484cccfc2abSDetlev Zundel
3485cccfc2abSDetlev Zundel		Adds the MTD device infrastructure from the Linux kernel.
3486cccfc2abSDetlev Zundel		Needed for mtdparts command support.
3487cccfc2abSDetlev Zundel
3488cccfc2abSDetlev Zundel		CONFIG_MTD_PARTITIONS
3489cccfc2abSDetlev Zundel
3490cccfc2abSDetlev Zundel		Adds the MTD partitioning infrastructure from the Linux
3491cccfc2abSDetlev Zundel		kernel. Needed for UBI support.
3492cccfc2abSDetlev Zundel
3493ff94bc40SHeiko Schocher		CONFIG_MTD_NAND_VERIFY_WRITE
3494ff94bc40SHeiko Schocher		verify if the written data is correct reread.
3495ff94bc40SHeiko Schocher
349670c219cdSJoe Hershberger- UBI support
349770c219cdSJoe Hershberger		CONFIG_CMD_UBI
349870c219cdSJoe Hershberger
349970c219cdSJoe Hershberger		Adds commands for interacting with MTD partitions formatted
350070c219cdSJoe Hershberger		with the UBI flash translation layer
350170c219cdSJoe Hershberger
350270c219cdSJoe Hershberger		Requires also defining CONFIG_RBTREE
350370c219cdSJoe Hershberger
3504147162daSJoe Hershberger		CONFIG_UBI_SILENCE_MSG
3505147162daSJoe Hershberger
3506147162daSJoe Hershberger		Make the verbose messages from UBI stop printing.  This leaves
3507147162daSJoe Hershberger		warnings and errors enabled.
3508147162daSJoe Hershberger
3509ff94bc40SHeiko Schocher
3510ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_WL_THRESHOLD
3511ff94bc40SHeiko Schocher		This parameter defines the maximum difference between the highest
3512ff94bc40SHeiko Schocher		erase counter value and the lowest erase counter value of eraseblocks
3513ff94bc40SHeiko Schocher		of UBI devices. When this threshold is exceeded, UBI starts performing
3514ff94bc40SHeiko Schocher		wear leveling by means of moving data from eraseblock with low erase
3515ff94bc40SHeiko Schocher		counter to eraseblocks with high erase counter.
3516ff94bc40SHeiko Schocher
3517ff94bc40SHeiko Schocher		The default value should be OK for SLC NAND flashes, NOR flashes and
3518ff94bc40SHeiko Schocher		other flashes which have eraseblock life-cycle 100000 or more.
3519ff94bc40SHeiko Schocher		However, in case of MLC NAND flashes which typically have eraseblock
3520ff94bc40SHeiko Schocher		life-cycle less than 10000, the threshold should be lessened (e.g.,
3521ff94bc40SHeiko Schocher		to 128 or 256, although it does not have to be power of 2).
3522ff94bc40SHeiko Schocher
3523ff94bc40SHeiko Schocher		default: 4096
3524ff94bc40SHeiko Schocher
3525ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_BEB_LIMIT
3526ff94bc40SHeiko Schocher		This option specifies the maximum bad physical eraseblocks UBI
3527ff94bc40SHeiko Schocher		expects on the MTD device (per 1024 eraseblocks). If the
3528ff94bc40SHeiko Schocher		underlying flash does not admit of bad eraseblocks (e.g. NOR
3529ff94bc40SHeiko Schocher		flash), this value is ignored.
3530ff94bc40SHeiko Schocher
3531ff94bc40SHeiko Schocher		NAND datasheets often specify the minimum and maximum NVM
3532ff94bc40SHeiko Schocher		(Number of Valid Blocks) for the flashes' endurance lifetime.
3533ff94bc40SHeiko Schocher		The maximum expected bad eraseblocks per 1024 eraseblocks
3534ff94bc40SHeiko Schocher		then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
3535ff94bc40SHeiko Schocher		which gives 20 for most NANDs (MaxNVB is basically the total
3536ff94bc40SHeiko Schocher		count of eraseblocks on the chip).
3537ff94bc40SHeiko Schocher
3538ff94bc40SHeiko Schocher		To put it differently, if this value is 20, UBI will try to
3539ff94bc40SHeiko Schocher		reserve about 1.9% of physical eraseblocks for bad blocks
3540ff94bc40SHeiko Schocher		handling. And that will be 1.9% of eraseblocks on the entire
3541ff94bc40SHeiko Schocher		NAND chip, not just the MTD partition UBI attaches. This means
3542ff94bc40SHeiko Schocher		that if you have, say, a NAND flash chip admits maximum 40 bad
3543ff94bc40SHeiko Schocher		eraseblocks, and it is split on two MTD partitions of the same
3544ff94bc40SHeiko Schocher		size, UBI will reserve 40 eraseblocks when attaching a
3545ff94bc40SHeiko Schocher		partition.
3546ff94bc40SHeiko Schocher
3547ff94bc40SHeiko Schocher		default: 20
3548ff94bc40SHeiko Schocher
3549ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_FASTMAP
3550ff94bc40SHeiko Schocher		Fastmap is a mechanism which allows attaching an UBI device
3551ff94bc40SHeiko Schocher		in nearly constant time. Instead of scanning the whole MTD device it
3552ff94bc40SHeiko Schocher		only has to locate a checkpoint (called fastmap) on the device.
3553ff94bc40SHeiko Schocher		The on-flash fastmap contains all information needed to attach
3554ff94bc40SHeiko Schocher		the device. Using fastmap makes only sense on large devices where
3555ff94bc40SHeiko Schocher		attaching by scanning takes long. UBI will not automatically install
3556ff94bc40SHeiko Schocher		a fastmap on old images, but you can set the UBI parameter
3557ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
3558ff94bc40SHeiko Schocher		that fastmap-enabled images are still usable with UBI implementations
3559ff94bc40SHeiko Schocher		without	fastmap support. On typical flash devices the whole fastmap
3560ff94bc40SHeiko Schocher		fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
3561ff94bc40SHeiko Schocher
3562ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
3563ff94bc40SHeiko Schocher		Set this parameter to enable fastmap automatically on images
3564ff94bc40SHeiko Schocher		without a fastmap.
3565ff94bc40SHeiko Schocher		default: 0
3566ff94bc40SHeiko Schocher
356770c219cdSJoe Hershberger- UBIFS support
356870c219cdSJoe Hershberger		CONFIG_CMD_UBIFS
356970c219cdSJoe Hershberger
357070c219cdSJoe Hershberger		Adds commands for interacting with UBI volumes formatted as
357170c219cdSJoe Hershberger		UBIFS.  UBIFS is read-only in u-boot.
357270c219cdSJoe Hershberger
357370c219cdSJoe Hershberger		Requires UBI support as well as CONFIG_LZO
357470c219cdSJoe Hershberger
3575147162daSJoe Hershberger		CONFIG_UBIFS_SILENCE_MSG
3576147162daSJoe Hershberger
3577147162daSJoe Hershberger		Make the verbose messages from UBIFS stop printing.  This leaves
3578147162daSJoe Hershberger		warnings and errors enabled.
3579147162daSJoe Hershberger
35806a11cf48SDaniel Schwierzeck- SPL framework
35816a11cf48SDaniel Schwierzeck		CONFIG_SPL
35826a11cf48SDaniel Schwierzeck		Enable building of SPL globally.
35836a11cf48SDaniel Schwierzeck
358495579793STom Rini		CONFIG_SPL_LDSCRIPT
358595579793STom Rini		LDSCRIPT for linking the SPL binary.
358695579793STom Rini
35876ebc3461SAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT
35886ebc3461SAlbert ARIBAUD		Maximum size in memory allocated to the SPL, BSS included.
35896ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual memory
35906ebc3461SAlbert ARIBAUD		used by SPL from _start to __bss_end does not exceed it.
35918960af8bSAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
35926ebc3461SAlbert ARIBAUD		must not be both defined at the same time.
35936ebc3461SAlbert ARIBAUD
359495579793STom Rini		CONFIG_SPL_MAX_SIZE
35956ebc3461SAlbert ARIBAUD		Maximum size of the SPL image (text, data, rodata, and
35966ebc3461SAlbert ARIBAUD		linker lists sections), BSS excluded.
35976ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual size does
35986ebc3461SAlbert ARIBAUD		not exceed it.
359995579793STom Rini
36006a11cf48SDaniel Schwierzeck		CONFIG_SPL_TEXT_BASE
36016a11cf48SDaniel Schwierzeck		TEXT_BASE for linking the SPL binary.
36026a11cf48SDaniel Schwierzeck
360394a45bb1SScott Wood		CONFIG_SPL_RELOC_TEXT_BASE
360494a45bb1SScott Wood		Address to relocate to.  If unspecified, this is equal to
360594a45bb1SScott Wood		CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
360694a45bb1SScott Wood
360795579793STom Rini		CONFIG_SPL_BSS_START_ADDR
360895579793STom Rini		Link address for the BSS within the SPL binary.
360995579793STom Rini
361095579793STom Rini		CONFIG_SPL_BSS_MAX_SIZE
36116ebc3461SAlbert ARIBAUD		Maximum size in memory allocated to the SPL BSS.
36126ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual memory used
36136ebc3461SAlbert ARIBAUD		by SPL from __bss_start to __bss_end does not exceed it.
36148960af8bSAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
36156ebc3461SAlbert ARIBAUD		must not be both defined at the same time.
361695579793STom Rini
361795579793STom Rini		CONFIG_SPL_STACK
361895579793STom Rini		Adress of the start of the stack SPL will use
361995579793STom Rini
362094a45bb1SScott Wood		CONFIG_SPL_RELOC_STACK
362194a45bb1SScott Wood		Adress of the start of the stack SPL will use after
362294a45bb1SScott Wood		relocation.  If unspecified, this is equal to
362394a45bb1SScott Wood		CONFIG_SPL_STACK.
362494a45bb1SScott Wood
362595579793STom Rini		CONFIG_SYS_SPL_MALLOC_START
362695579793STom Rini		Starting address of the malloc pool used in SPL.
362795579793STom Rini
362895579793STom Rini		CONFIG_SYS_SPL_MALLOC_SIZE
362995579793STom Rini		The size of the malloc pool used in SPL.
36306a11cf48SDaniel Schwierzeck
363147f7bcaeSTom Rini		CONFIG_SPL_FRAMEWORK
363247f7bcaeSTom Rini		Enable the SPL framework under common/.  This framework
363347f7bcaeSTom Rini		supports MMC, NAND and YMODEM loading of U-Boot and NAND
363447f7bcaeSTom Rini		NAND loading of the Linux Kernel.
363547f7bcaeSTom Rini
36369607faf2STom Rini		CONFIG_SPL_OS_BOOT
36379607faf2STom Rini		Enable booting directly to an OS from SPL.
36389607faf2STom Rini		See also: doc/README.falcon
36399607faf2STom Rini
3640861a86f4STom Rini		CONFIG_SPL_DISPLAY_PRINT
3641861a86f4STom Rini		For ARM, enable an optional function to print more information
3642861a86f4STom Rini		about the running system.
3643861a86f4STom Rini
36444b919725SScott Wood		CONFIG_SPL_INIT_MINIMAL
36454b919725SScott Wood		Arch init code should be built for a very small image
36464b919725SScott Wood
36476a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBCOMMON_SUPPORT
36486a11cf48SDaniel Schwierzeck		Support for common/libcommon.o in SPL binary
36496a11cf48SDaniel Schwierzeck
36506a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBDISK_SUPPORT
36516a11cf48SDaniel Schwierzeck		Support for disk/libdisk.o in SPL binary
36526a11cf48SDaniel Schwierzeck
36536a11cf48SDaniel Schwierzeck		CONFIG_SPL_I2C_SUPPORT
36546a11cf48SDaniel Schwierzeck		Support for drivers/i2c/libi2c.o in SPL binary
36556a11cf48SDaniel Schwierzeck
36566a11cf48SDaniel Schwierzeck		CONFIG_SPL_GPIO_SUPPORT
36576a11cf48SDaniel Schwierzeck		Support for drivers/gpio/libgpio.o in SPL binary
36586a11cf48SDaniel Schwierzeck
36596a11cf48SDaniel Schwierzeck		CONFIG_SPL_MMC_SUPPORT
36606a11cf48SDaniel Schwierzeck		Support for drivers/mmc/libmmc.o in SPL binary
36616a11cf48SDaniel Schwierzeck
366295579793STom Rini		CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
366395579793STom Rini		CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
3664fae81c72SGuillaume GARDET		CONFIG_SYS_MMC_SD_FS_BOOT_PARTITION
366595579793STom Rini		Address, size and partition on the MMC to load U-Boot from
366695579793STom Rini		when the MMC is being used in raw mode.
366795579793STom Rini
36682b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
36692b75b0adSPeter Korsgaard		Sector to load kernel uImage from when MMC is being
36702b75b0adSPeter Korsgaard		used in raw mode (for Falcon mode)
36712b75b0adSPeter Korsgaard
36722b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
36732b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
36742b75b0adSPeter Korsgaard		Sector and number of sectors to load kernel argument
36752b75b0adSPeter Korsgaard		parameters from when MMC is being used in raw mode
36762b75b0adSPeter Korsgaard		(for falcon mode)
36772b75b0adSPeter Korsgaard
367895579793STom Rini		CONFIG_SPL_FAT_SUPPORT
367995579793STom Rini		Support for fs/fat/libfat.o in SPL binary
368095579793STom Rini
3681fae81c72SGuillaume GARDET		CONFIG_SPL_EXT_SUPPORT
3682fae81c72SGuillaume GARDET		Support for EXT filesystem in SPL binary
368395579793STom Rini
3684fae81c72SGuillaume GARDET		CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
3685fae81c72SGuillaume GARDET		Filename to read to load U-Boot when reading from filesystem
3686fae81c72SGuillaume GARDET
3687fae81c72SGuillaume GARDET		CONFIG_SPL_FS_LOAD_KERNEL_NAME
36887ad2cc79SPeter Korsgaard		Filename to read to load kernel uImage when reading
3689fae81c72SGuillaume GARDET		from filesystem (for Falcon mode)
36907ad2cc79SPeter Korsgaard
3691fae81c72SGuillaume GARDET		CONFIG_SPL_FS_LOAD_ARGS_NAME
36927ad2cc79SPeter Korsgaard		Filename to read to load kernel argument parameters
3693fae81c72SGuillaume GARDET		when reading from filesystem (for Falcon mode)
36947ad2cc79SPeter Korsgaard
369506f60ae3SScott Wood		CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
369606f60ae3SScott Wood		Set this for NAND SPL on PPC mpc83xx targets, so that
369706f60ae3SScott Wood		start.S waits for the rest of the SPL to load before
369806f60ae3SScott Wood		continuing (the hardware starts execution after just
369906f60ae3SScott Wood		loading the first page rather than the full 4K).
370006f60ae3SScott Wood
3701651fcf60SPrabhakar Kushwaha		CONFIG_SPL_SKIP_RELOCATE
3702651fcf60SPrabhakar Kushwaha		Avoid SPL relocation
3703651fcf60SPrabhakar Kushwaha
37046f2f01b9SScott Wood		CONFIG_SPL_NAND_BASE
37056f2f01b9SScott Wood		Include nand_base.c in the SPL.  Requires
37066f2f01b9SScott Wood		CONFIG_SPL_NAND_DRIVERS.
37076f2f01b9SScott Wood
37086f2f01b9SScott Wood		CONFIG_SPL_NAND_DRIVERS
37096f2f01b9SScott Wood		SPL uses normal NAND drivers, not minimal drivers.
37106f2f01b9SScott Wood
37116f2f01b9SScott Wood		CONFIG_SPL_NAND_ECC
37126f2f01b9SScott Wood		Include standard software ECC in the SPL
37136f2f01b9SScott Wood
371495579793STom Rini		CONFIG_SPL_NAND_SIMPLE
37157d4b7955SScott Wood		Support for NAND boot using simple NAND drivers that
37167d4b7955SScott Wood		expose the cmd_ctrl() interface.
371795579793STom Rini
37186dd3b566STom Rini		CONFIG_SPL_MTD_SUPPORT
37196dd3b566STom Rini		Support for the MTD subsystem within SPL.  Useful for
37206dd3b566STom Rini		environment on NAND support within SPL.
37216dd3b566STom Rini
37220c3117b1SHeiko Schocher		CONFIG_SPL_NAND_RAW_ONLY
37230c3117b1SHeiko Schocher		Support to boot only raw u-boot.bin images. Use this only
37240c3117b1SHeiko Schocher		if you need to save space.
37250c3117b1SHeiko Schocher
3726bb0dc108SYing Zhang		CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT
3727bb0dc108SYing Zhang		Set for the SPL on PPC mpc8xxx targets, support for
37285614e71bSYork Sun		drivers/ddr/fsl/libddr.o in SPL binary.
3729bb0dc108SYing Zhang
37307c8eea59SYing Zhang		CONFIG_SPL_COMMON_INIT_DDR
37317c8eea59SYing Zhang		Set for common ddr init with serial presence detect in
37327c8eea59SYing Zhang		SPL binary.
37337c8eea59SYing Zhang
373495579793STom Rini		CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
373595579793STom Rini		CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
373695579793STom Rini		CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
373795579793STom Rini		CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
373895579793STom Rini		CONFIG_SYS_NAND_ECCBYTES
373995579793STom Rini		Defines the size and behavior of the NAND that SPL uses
37407d4b7955SScott Wood		to read U-Boot
374195579793STom Rini
3742fbe76ae4SPrabhakar Kushwaha		CONFIG_SPL_NAND_BOOT
3743fbe76ae4SPrabhakar Kushwaha		Add support NAND boot
3744fbe76ae4SPrabhakar Kushwaha
374595579793STom Rini		CONFIG_SYS_NAND_U_BOOT_OFFS
37467d4b7955SScott Wood		Location in NAND to read U-Boot from
37477d4b7955SScott Wood
37487d4b7955SScott Wood		CONFIG_SYS_NAND_U_BOOT_DST
37497d4b7955SScott Wood		Location in memory to load U-Boot to
37507d4b7955SScott Wood
37517d4b7955SScott Wood		CONFIG_SYS_NAND_U_BOOT_SIZE
37527d4b7955SScott Wood		Size of image to load
375395579793STom Rini
375495579793STom Rini		CONFIG_SYS_NAND_U_BOOT_START
37557d4b7955SScott Wood		Entry point in loaded image to jump to
375695579793STom Rini
375795579793STom Rini		CONFIG_SYS_NAND_HW_ECC_OOBFIRST
375895579793STom Rini		Define this if you need to first read the OOB and then the
375995579793STom Rini		data. This is used for example on davinci plattforms.
376095579793STom Rini
376195579793STom Rini		CONFIG_SPL_OMAP3_ID_NAND
376295579793STom Rini		Support for an OMAP3-specific set of functions to return the
376395579793STom Rini		ID and MFR of the first attached NAND chip, if present.
376495579793STom Rini
37656a11cf48SDaniel Schwierzeck		CONFIG_SPL_SERIAL_SUPPORT
37666a11cf48SDaniel Schwierzeck		Support for drivers/serial/libserial.o in SPL binary
37676a11cf48SDaniel Schwierzeck
37686a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_FLASH_SUPPORT
37696a11cf48SDaniel Schwierzeck		Support for drivers/mtd/spi/libspi_flash.o in SPL binary
37706a11cf48SDaniel Schwierzeck
37716a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_SUPPORT
37726a11cf48SDaniel Schwierzeck		Support for drivers/spi/libspi.o in SPL binary
37736a11cf48SDaniel Schwierzeck
3774c57b953dSPavel Machek		CONFIG_SPL_RAM_DEVICE
3775c57b953dSPavel Machek		Support for running image already present in ram, in SPL binary
3776c57b953dSPavel Machek
37776a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBGENERIC_SUPPORT
37786a11cf48SDaniel Schwierzeck		Support for lib/libgeneric.o in SPL binary
37791372cce2SMarian Balakowicz
3780ba1bee43SYing Zhang		CONFIG_SPL_ENV_SUPPORT
3781ba1bee43SYing Zhang		Support for the environment operating in SPL binary
3782ba1bee43SYing Zhang
3783ba1bee43SYing Zhang		CONFIG_SPL_NET_SUPPORT
3784ba1bee43SYing Zhang		Support for the net/libnet.o in SPL binary.
3785ba1bee43SYing Zhang		It conflicts with SPL env from storage medium specified by
3786ba1bee43SYing Zhang		CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3787ba1bee43SYing Zhang
378874752baaSScott Wood		CONFIG_SPL_PAD_TO
37896113d3f2SBenoît Thébaudeau		Image offset to which the SPL should be padded before appending
37906113d3f2SBenoît Thébaudeau		the SPL payload. By default, this is defined as
37916113d3f2SBenoît Thébaudeau		CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
37926113d3f2SBenoît Thébaudeau		CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
37936113d3f2SBenoît Thébaudeau		payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
379474752baaSScott Wood
3795ca2fca22SScott Wood		CONFIG_SPL_TARGET
3796ca2fca22SScott Wood		Final target image containing SPL and payload.  Some SPLs
3797ca2fca22SScott Wood		use an arch-specific makefile fragment instead, for
3798ca2fca22SScott Wood		example if more than one image needs to be produced.
3799ca2fca22SScott Wood
380087ebee39SSimon Glass		CONFIG_FIT_SPL_PRINT
380187ebee39SSimon Glass		Printing information about a FIT image adds quite a bit of
380287ebee39SSimon Glass		code to SPL. So this is normally disabled in SPL. Use this
380387ebee39SSimon Glass		option to re-enable it. This will affect the output of the
380487ebee39SSimon Glass		bootm command when booting a FIT image.
380587ebee39SSimon Glass
38063aa29de0SYing Zhang- TPL framework
38073aa29de0SYing Zhang		CONFIG_TPL
38083aa29de0SYing Zhang		Enable building of TPL globally.
38093aa29de0SYing Zhang
38103aa29de0SYing Zhang		CONFIG_TPL_PAD_TO
38113aa29de0SYing Zhang		Image offset to which the TPL should be padded before appending
38123aa29de0SYing Zhang		the TPL payload. By default, this is defined as
38133aa29de0SYing Zhang		CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
38143aa29de0SYing Zhang		CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
38153aa29de0SYing Zhang		payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
38163aa29de0SYing Zhang
3817c609719bSwdenkModem Support:
3818c609719bSwdenk--------------
3819c609719bSwdenk
3820566e5cf4SWolfgang Denk[so far only for SMDK2400 boards]
3821c609719bSwdenk
382211ccc33fSMarcel Ziswiler- Modem support enable:
3823c609719bSwdenk		CONFIG_MODEM_SUPPORT
3824c609719bSwdenk
3825c609719bSwdenk- RTS/CTS Flow control enable:
3826c609719bSwdenk		CONFIG_HWFLOW
3827c609719bSwdenk
3828c609719bSwdenk- Modem debug support:
3829c609719bSwdenk		CONFIG_MODEM_SUPPORT_DEBUG
3830c609719bSwdenk
3831c609719bSwdenk		Enables debugging stuff (char screen[1024], dbg())
3832c609719bSwdenk		for modem support. Useful only with BDI2000.
3833c609719bSwdenk
3834a8c7c708Swdenk- Interrupt support (PPC):
3835a8c7c708Swdenk
3836a8c7c708Swdenk		There are common interrupt_init() and timer_interrupt()
3837a8c7c708Swdenk		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
383811ccc33fSMarcel Ziswiler		for CPU specific initialization. interrupt_init_cpu()
3839a8c7c708Swdenk		should set decrementer_count to appropriate value. If
384011ccc33fSMarcel Ziswiler		CPU resets decrementer automatically after interrupt
3841a8c7c708Swdenk		(ppc4xx) it should set decrementer_count to zero.
384211ccc33fSMarcel Ziswiler		timer_interrupt() calls timer_interrupt_cpu() for CPU
3843a8c7c708Swdenk		specific handling. If board has watchdog / status_led
3844a8c7c708Swdenk		/ other_activity_monitor it works automatically from
3845a8c7c708Swdenk		general timer_interrupt().
3846a8c7c708Swdenk
3847c609719bSwdenk- General:
3848c609719bSwdenk
3849c609719bSwdenk		In the target system modem support is enabled when a
3850c609719bSwdenk		specific key (key combination) is pressed during
3851c609719bSwdenk		power-on. Otherwise U-Boot will boot normally
385211ccc33fSMarcel Ziswiler		(autoboot). The key_pressed() function is called from
3853c609719bSwdenk		board_init(). Currently key_pressed() is a dummy
3854c609719bSwdenk		function, returning 1 and thus enabling modem
3855c609719bSwdenk		initialization.
3856c609719bSwdenk
3857c609719bSwdenk		If there are no modem init strings in the
3858c609719bSwdenk		environment, U-Boot proceed to autoboot; the
3859c609719bSwdenk		previous output (banner, info printfs) will be
386011ccc33fSMarcel Ziswiler		suppressed, though.
3861c609719bSwdenk
3862c609719bSwdenk		See also: doc/README.Modem
3863c609719bSwdenk
38649660e442SHelmut RaigerBoard initialization settings:
38659660e442SHelmut Raiger------------------------------
38669660e442SHelmut Raiger
38679660e442SHelmut RaigerDuring Initialization u-boot calls a number of board specific functions
38689660e442SHelmut Raigerto allow the preparation of board specific prerequisites, e.g. pin setup
38699660e442SHelmut Raigerbefore drivers are initialized. To enable these callbacks the
38709660e442SHelmut Raigerfollowing configuration macros have to be defined. Currently this is
38719660e442SHelmut Raigerarchitecture specific, so please check arch/your_architecture/lib/board.c
38729660e442SHelmut Raigertypically in board_init_f() and board_init_r().
38739660e442SHelmut Raiger
38749660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
38759660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
38769660e442SHelmut Raiger- CONFIG_BOARD_LATE_INIT: Call board_late_init()
38779660e442SHelmut Raiger- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
3878c609719bSwdenk
3879c609719bSwdenkConfiguration Settings:
3880c609719bSwdenk-----------------------
3881c609719bSwdenk
38824d1fd7f1SYork Sun- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
38834d1fd7f1SYork Sun		Optionally it can be defined to support 64-bit memory commands.
38844d1fd7f1SYork Sun
38856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
3886c609719bSwdenk		undefine this when you're short of memory.
3887c609719bSwdenk
38882fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
38892fb2604dSPeter Tyser		width of the commands listed in the 'help' command output.
38902fb2604dSPeter Tyser
38916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT:	This is what U-Boot prints on the console to
3892c609719bSwdenk		prompt for user input.
3893c609719bSwdenk
38946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE:	Buffer size for input from the Console
3895c609719bSwdenk
38966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE:	Buffer size for Console output
3897c609719bSwdenk
38986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS:	max. Number of arguments accepted for monitor commands
3899c609719bSwdenk
39006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
3901c609719bSwdenk		the application (usually a Linux kernel) when it is
3902c609719bSwdenk		booted
3903c609719bSwdenk
39046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE:
3905c609719bSwdenk		List of legal baudrate settings for this board.
3906c609719bSwdenk
39076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_INFO_QUIET
3908c609719bSwdenk		Suppress display of console information at boot.
3909c609719bSwdenk
39106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_IS_IN_ENV
3911c609719bSwdenk		If the board specific function
3912c609719bSwdenk			extern int overwrite_console (void);
3913c609719bSwdenk		returns 1, the stdin, stderr and stdout are switched to the
3914c609719bSwdenk		serial port, else the settings in the environment are used.
3915c609719bSwdenk
39166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
3917c609719bSwdenk		Enable the call to overwrite_console().
3918c609719bSwdenk
39196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
3920c609719bSwdenk		Enable overwrite of previous console environment settings.
3921c609719bSwdenk
39226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
3923c609719bSwdenk		Begin and End addresses of the area used by the
3924c609719bSwdenk		simple memory test.
3925c609719bSwdenk
39266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST:
3927c609719bSwdenk		Enable an alternate, more extensive memory test.
3928c609719bSwdenk
39296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH:
39305f535fe1Swdenk		Scratch address used by the alternate memory test
39315f535fe1Swdenk		You only need to set this if address zero isn't writeable
39325f535fe1Swdenk
39336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
39346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
393514f73ca6SStefan Roese		this specified memory area will get subtracted from the top
393611ccc33fSMarcel Ziswiler		(end) of RAM and won't get "touched" at all by U-Boot. By
393714f73ca6SStefan Roese		fixing up gd->ram_size the Linux kernel should gets passed
393814f73ca6SStefan Roese		the now "corrected" memory size and won't touch it either.
393914f73ca6SStefan Roese		This should work for arch/ppc and arch/powerpc. Only Linux
39405e12e75dSStefan Roese		board ports in arch/powerpc with bootwrapper support that
394114f73ca6SStefan Roese		recalculate the memory size from the SDRAM controller setup
39425e12e75dSStefan Roese		will have to get fixed in Linux additionally.
394314f73ca6SStefan Roese
394414f73ca6SStefan Roese		This option can be used as a workaround for the 440EPx/GRx
394514f73ca6SStefan Roese		CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
394614f73ca6SStefan Roese		be touched.
394714f73ca6SStefan Roese
394814f73ca6SStefan Roese		WARNING: Please make sure that this value is a multiple of
394914f73ca6SStefan Roese		the Linux page size (normally 4k). If this is not the case,
395014f73ca6SStefan Roese		then the end address of the Linux memory will be located at a
395114f73ca6SStefan Roese		non page size aligned address and this could cause major
395214f73ca6SStefan Roese		problems.
395314f73ca6SStefan Roese
39546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE:
3955c609719bSwdenk		Enable temporary baudrate change while serial download
3956c609719bSwdenk
39576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE:
3958c609719bSwdenk		Physical start address of SDRAM. _Must_ be 0 here.
3959c609719bSwdenk
39606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MBIO_BASE:
3961c609719bSwdenk		Physical start address of Motherboard I/O (if using a
3962c609719bSwdenk		Cogent motherboard)
3963c609719bSwdenk
39646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE:
3965c609719bSwdenk		Physical start address of Flash memory.
3966c609719bSwdenk
39676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE:
3968c609719bSwdenk		Physical start address of boot monitor code (set by
3969c609719bSwdenk		make config files to be same as the text base address
397014d0a02aSWolfgang Denk		(CONFIG_SYS_TEXT_BASE) used when linking) - same as
39716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FLASH_BASE when booting from flash.
3972c609719bSwdenk
39736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN:
39743b57fe0aSwdenk		Size of memory reserved for monitor code, used to
39753b57fe0aSwdenk		determine _at_compile_time_ (!) if the environment is
39763b57fe0aSwdenk		embedded within the U-Boot image, or in a separate
39773b57fe0aSwdenk		flash sector.
3978c609719bSwdenk
39796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN:
3980c609719bSwdenk		Size of DRAM reserved for malloc() use.
3981c609719bSwdenk
3982d59476b6SSimon Glass- CONFIG_SYS_MALLOC_F_LEN
3983d59476b6SSimon Glass		Size of the malloc() pool for use before relocation. If
3984d59476b6SSimon Glass		this is defined, then a very simple malloc() implementation
3985d59476b6SSimon Glass		will become available before relocation. The address is just
3986d59476b6SSimon Glass		below the global data, and the stack is moved down to make
3987d59476b6SSimon Glass		space.
3988d59476b6SSimon Glass
3989d59476b6SSimon Glass		This feature allocates regions with increasing addresses
3990d59476b6SSimon Glass		within the region. calloc() is supported, but realloc()
3991d59476b6SSimon Glass		is not available. free() is supported but does nothing.
3992d59476b6SSimon Glass		The memory will be freed (or in fact just forgotton) when
3993d59476b6SSimon Glass		U-Boot relocates itself.
3994d59476b6SSimon Glass
3995e7b14e9aSSimon Glass		Pre-relocation malloc() is only supported on ARM and sandbox
399629afe9e6SSimon Glass		at present but is fairly easy to enable for other archs.
399729afe9e6SSimon Glass
399838687ae6SSimon Glass- CONFIG_SYS_MALLOC_SIMPLE
399938687ae6SSimon Glass		Provides a simple and small malloc() and calloc() for those
400038687ae6SSimon Glass		boards which do not use the full malloc in SPL (which is
400138687ae6SSimon Glass		enabled with CONFIG_SYS_SPL_MALLOC_START).
400238687ae6SSimon Glass
40036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN:
400415940c9aSStefan Roese		Normally compressed uImages are limited to an
400515940c9aSStefan Roese		uncompressed size of 8 MBytes. If this is not enough,
40066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		you can define CONFIG_SYS_BOOTM_LEN in your board config file
400715940c9aSStefan Roese		to adjust this setting to your needs.
4008c609719bSwdenk
40096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ:
4010c609719bSwdenk		Maximum size of memory mapped by the startup code of
4011c609719bSwdenk		the Linux kernel; all data that must be processed by
40127d721e34SBartlomiej Sieka		the Linux kernel (bd_info, boot arguments, FDT blob if
40137d721e34SBartlomiej Sieka		used) must be put below this limit, unless "bootm_low"
40141bce2aebSRobert P. J. Day		environment variable is defined and non-zero. In such case
40157d721e34SBartlomiej Sieka		all data for the Linux kernel must be between "bootm_low"
4016c3624e6eSGrant Likely		and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.	 The environment
4017c3624e6eSGrant Likely		variable "bootm_mapsize" will override the value of
4018c3624e6eSGrant Likely		CONFIG_SYS_BOOTMAPSZ.  If CONFIG_SYS_BOOTMAPSZ is undefined,
4019c3624e6eSGrant Likely		then the value in "bootm_size" will be used instead.
4020c609719bSwdenk
4021fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_RAMDISK_HIGH:
4022fca43cc8SJohn Rigby		Enable initrd_high functionality.  If defined then the
4023fca43cc8SJohn Rigby		initrd_high feature is enabled and the bootm ramdisk subcommand
4024fca43cc8SJohn Rigby		is enabled.
4025fca43cc8SJohn Rigby
4026fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_CMDLINE:
4027fca43cc8SJohn Rigby		Enables allocating and saving kernel cmdline in space between
4028fca43cc8SJohn Rigby		"bootm_low" and "bootm_low" + BOOTMAPSZ.
4029fca43cc8SJohn Rigby
4030fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_KBD:
4031fca43cc8SJohn Rigby		Enables allocating and saving a kernel copy of the bd_info in
4032fca43cc8SJohn Rigby		space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
4033fca43cc8SJohn Rigby
40346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS:
4035c609719bSwdenk		Max number of Flash memory banks
4036c609719bSwdenk
40376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT:
4038c609719bSwdenk		Max number of sectors on a Flash chip
4039c609719bSwdenk
40406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT:
4041c609719bSwdenk		Timeout for Flash erase operations (in ms)
4042c609719bSwdenk
40436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT:
4044c609719bSwdenk		Timeout for Flash write operations (in ms)
4045c609719bSwdenk
40466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT
40478564acf9Swdenk		Timeout for Flash set sector lock bit operation (in ms)
40488564acf9Swdenk
40496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT
40508564acf9Swdenk		Timeout for Flash clear lock bits operation (in ms)
40518564acf9Swdenk
40526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION
40538564acf9Swdenk		If defined, hardware flash sectors protection is used
40548564acf9Swdenk		instead of U-Boot software protection.
40558564acf9Swdenk
40566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP:
4057c609719bSwdenk
4058c609719bSwdenk		Enable TFTP transfers directly to flash memory;
4059c609719bSwdenk		without this option such a download has to be
4060c609719bSwdenk		performed in two steps: (1) download to RAM, and (2)
4061c609719bSwdenk		copy from RAM to flash.
4062c609719bSwdenk
4063c609719bSwdenk		The two-step approach is usually more reliable, since
4064c609719bSwdenk		you can check if the download worked before you erase
406511ccc33fSMarcel Ziswiler		the flash, but in some situations (when system RAM is
406611ccc33fSMarcel Ziswiler		too limited to allow for a temporary copy of the
4067c609719bSwdenk		downloaded image) this option may be very useful.
4068c609719bSwdenk
40696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI:
4070c609719bSwdenk		Define if the flash driver uses extra elements in the
40715653fc33Swdenk		common flash structure for storing flash geometry.
40725653fc33Swdenk
407300b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER
40745653fc33Swdenk		This option also enables the building of the cfi_flash driver
40755653fc33Swdenk		in the drivers directory
407653cf9435Sstroese
407791809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD
407891809ed5SPiotr Ziecik		This option enables the building of the cfi_mtd driver
407991809ed5SPiotr Ziecik		in the drivers directory. The driver exports CFI flash
408091809ed5SPiotr Ziecik		to the MTD layer.
408191809ed5SPiotr Ziecik
40826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
408396ef831fSGuennadi Liakhovetski		Use buffered writes to flash.
408496ef831fSGuennadi Liakhovetski
408596ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N
408696ef831fSGuennadi Liakhovetski		s29ws-n MirrorBit flash has non-standard addresses for buffered
408796ef831fSGuennadi Liakhovetski		write commands.
408896ef831fSGuennadi Liakhovetski
40896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST
40905568e613SStefan Roese		If this option is defined, the common CFI flash doesn't
40915568e613SStefan Roese		print it's warning upon not recognized FLASH banks. This
40925568e613SStefan Roese		is useful, if some of the configured banks are only
40935568e613SStefan Roese		optionally available.
40945568e613SStefan Roese
40959a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS
40969a042e9cSJerry Van Baren		If defined (must be an integer), print out countdown
40979a042e9cSJerry Van Baren		digits and dots.  Recommended value: 45 (9..1) for 80
40989a042e9cSJerry Van Baren		column displays, 15 (3..1) for 40 column displays.
40999a042e9cSJerry Van Baren
4100352ef3f1SStefan Roese- CONFIG_FLASH_VERIFY
4101352ef3f1SStefan Roese		If defined, the content of the flash (destination) is compared
4102352ef3f1SStefan Roese		against the source after the write operation. An error message
4103352ef3f1SStefan Roese		will be printed when the contents are not identical.
4104352ef3f1SStefan Roese		Please note that this option is useless in nearly all cases,
4105352ef3f1SStefan Roese		since such flash programming errors usually are detected earlier
4106352ef3f1SStefan Roese		while unprotecting/erasing/programming. Please only enable
4107352ef3f1SStefan Roese		this option if you really know what you are doing.
4108352ef3f1SStefan Roese
41096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER:
411011ccc33fSMarcel Ziswiler		Defines the number of Ethernet receive buffers. On some
411111ccc33fSMarcel Ziswiler		Ethernet controllers it is recommended to set this value
411253cf9435Sstroese		to 8 or even higher (EEPRO100 or 405 EMAC), since all
411353cf9435Sstroese		buffers can be full shortly after enabling the interface
411411ccc33fSMarcel Ziswiler		on high Ethernet traffic.
411553cf9435Sstroese		Defaults to 4 if not defined.
4116c609719bSwdenk
4117ea882bafSWolfgang Denk- CONFIG_ENV_MAX_ENTRIES
4118ea882bafSWolfgang Denk
4119ea882bafSWolfgang Denk	Maximum number of entries in the hash table that is used
4120ea882bafSWolfgang Denk	internally to store the environment settings. The default
4121ea882bafSWolfgang Denk	setting is supposed to be generous and should work in most
4122ea882bafSWolfgang Denk	cases. This setting can be used to tune behaviour; see
4123ea882bafSWolfgang Denk	lib/hashtable.c for details.
4124ea882bafSWolfgang Denk
41252598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_DEFAULT
41262598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_STATIC
41271bce2aebSRobert P. J. Day	Enable validation of the values given to environment variables when
41282598090bSJoe Hershberger	calling env set.  Variables can be restricted to only decimal,
41292598090bSJoe Hershberger	hexadecimal, or boolean.  If CONFIG_CMD_NET is also defined,
41302598090bSJoe Hershberger	the variables can also be restricted to IP address or MAC address.
41312598090bSJoe Hershberger
41322598090bSJoe Hershberger	The format of the list is:
41332598090bSJoe Hershberger		type_attribute = [s|d|x|b|i|m]
4134267541f7SJoe Hershberger		access_atribute = [a|r|o|c]
4135267541f7SJoe Hershberger		attributes = type_attribute[access_atribute]
41362598090bSJoe Hershberger		entry = variable_name[:attributes]
41372598090bSJoe Hershberger		list = entry[,list]
41382598090bSJoe Hershberger
41392598090bSJoe Hershberger	The type attributes are:
41402598090bSJoe Hershberger		s - String (default)
41412598090bSJoe Hershberger		d - Decimal
41422598090bSJoe Hershberger		x - Hexadecimal
41432598090bSJoe Hershberger		b - Boolean ([1yYtT|0nNfF])
41442598090bSJoe Hershberger		i - IP address
41452598090bSJoe Hershberger		m - MAC address
41462598090bSJoe Hershberger
4147267541f7SJoe Hershberger	The access attributes are:
4148267541f7SJoe Hershberger		a - Any (default)
4149267541f7SJoe Hershberger		r - Read-only
4150267541f7SJoe Hershberger		o - Write-once
4151267541f7SJoe Hershberger		c - Change-default
4152267541f7SJoe Hershberger
41532598090bSJoe Hershberger	- CONFIG_ENV_FLAGS_LIST_DEFAULT
41542598090bSJoe Hershberger		Define this to a list (string) to define the ".flags"
41552598090bSJoe Hershberger		envirnoment variable in the default or embedded environment.
41562598090bSJoe Hershberger
41572598090bSJoe Hershberger	- CONFIG_ENV_FLAGS_LIST_STATIC
41582598090bSJoe Hershberger		Define this to a list (string) to define validation that
41592598090bSJoe Hershberger		should be done if an entry is not found in the ".flags"
41602598090bSJoe Hershberger		environment variable.  To override a setting in the static
41612598090bSJoe Hershberger		list, simply add an entry for the same variable name to the
41622598090bSJoe Hershberger		".flags" variable.
41632598090bSJoe Hershberger
4164267541f7SJoe Hershberger- CONFIG_ENV_ACCESS_IGNORE_FORCE
4165267541f7SJoe Hershberger	If defined, don't allow the -f switch to env set override variable
4166267541f7SJoe Hershberger	access flags.
4167267541f7SJoe Hershberger
41685c1a7ea6SSimon Glass- CONFIG_SYS_GENERIC_BOARD
41695c1a7ea6SSimon Glass	This selects the architecture-generic board system instead of the
41705c1a7ea6SSimon Glass	architecture-specific board files. It is intended to move boards
41715c1a7ea6SSimon Glass	to this new framework over time. Defining this will disable the
41725c1a7ea6SSimon Glass	arch/foo/lib/board.c file and use common/board_f.c and
41735c1a7ea6SSimon Glass	common/board_r.c instead. To use this option your architecture
41745c1a7ea6SSimon Glass	must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in
41755c1a7ea6SSimon Glass	its config.mk file). If you find problems enabling this option on
41765c1a7ea6SSimon Glass	your board please report the problem and send patches!
41775c1a7ea6SSimon Glass
41780b1b60c7SLokesh Vutla- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
41790b1b60c7SLokesh Vutla	This is set by OMAP boards for the max time that reset should
41800b1b60c7SLokesh Vutla	be asserted. See doc/README.omap-reset-time for details on how
41810b1b60c7SLokesh Vutla	the value can be calulated on a given board.
4182632efa74SSimon Glass
41830d296cc2SGabe Black- CONFIG_USE_STDINT
41840d296cc2SGabe Black	If stdint.h is available with your toolchain you can define this
41850d296cc2SGabe Black	option to enable it. You can provide option 'USE_STDINT=1' when
41860d296cc2SGabe Black	building U-Boot to enable this.
41870d296cc2SGabe Black
4188c609719bSwdenkThe following definitions that deal with the placement and management
4189c609719bSwdenkof environment data (variable area); in general, we support the
4190c609719bSwdenkfollowing configurations:
4191c609719bSwdenk
4192c3eb3fe4SMike Frysinger- CONFIG_BUILD_ENVCRC:
4193c3eb3fe4SMike Frysinger
4194c3eb3fe4SMike Frysinger	Builds up envcrc with the target environment so that external utils
4195c3eb3fe4SMike Frysinger	may easily extract it and embed it in final U-Boot images.
4196c3eb3fe4SMike Frysinger
41975a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH:
4198c609719bSwdenk
4199c609719bSwdenk	Define this if the environment is in flash memory.
4200c609719bSwdenk
4201c609719bSwdenk	a) The environment occupies one whole flash sector, which is
4202c609719bSwdenk	   "embedded" in the text segment with the U-Boot code. This
4203c609719bSwdenk	   happens usually with "bottom boot sector" or "top boot
4204c609719bSwdenk	   sector" type flash chips, which have several smaller
4205c609719bSwdenk	   sectors at the start or the end. For instance, such a
4206c609719bSwdenk	   layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
4207c609719bSwdenk	   such a case you would place the environment in one of the
4208c609719bSwdenk	   4 kB sectors - with U-Boot code before and after it. With
4209c609719bSwdenk	   "top boot sector" type flash chips, you would put the
4210c609719bSwdenk	   environment in one of the last sectors, leaving a gap
4211c609719bSwdenk	   between U-Boot and the environment.
4212c609719bSwdenk
42130e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
4214c609719bSwdenk
4215c609719bSwdenk	   Offset of environment data (variable area) to the
4216c609719bSwdenk	   beginning of flash memory; for instance, with bottom boot
4217c609719bSwdenk	   type flash chips the second sector can be used: the offset
4218c609719bSwdenk	   for this sector is given here.
4219c609719bSwdenk
42206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
4221c609719bSwdenk
42220e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
4223c609719bSwdenk
4224c609719bSwdenk	   This is just another way to specify the start address of
4225c609719bSwdenk	   the flash sector containing the environment (instead of
42260e8d1586SJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET).
4227c609719bSwdenk
42280e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SECT_SIZE:
4229c609719bSwdenk
4230c609719bSwdenk	   Size of the sector containing the environment.
4231c609719bSwdenk
4232c609719bSwdenk
4233c609719bSwdenk	b) Sometimes flash chips have few, equal sized, BIG sectors.
4234c609719bSwdenk	   In such a case you don't want to spend a whole sector for
4235c609719bSwdenk	   the environment.
4236c609719bSwdenk
42370e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
4238c609719bSwdenk
42395a1aceb0SJean-Christophe PLAGNIOL-VILLARD	   If you use this in combination with CONFIG_ENV_IS_IN_FLASH
42400e8d1586SJean-Christophe PLAGNIOL-VILLARD	   and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
4241c609719bSwdenk	   of this flash sector for the environment. This saves
4242c609719bSwdenk	   memory for the RAM copy of the environment.
4243c609719bSwdenk
4244c609719bSwdenk	   It may also save flash memory if you decide to use this
4245c609719bSwdenk	   when your environment is "embedded" within U-Boot code,
4246c609719bSwdenk	   since then the remainder of the flash sector could be used
4247c609719bSwdenk	   for U-Boot code. It should be pointed out that this is
4248c609719bSwdenk	   STRONGLY DISCOURAGED from a robustness point of view:
4249c609719bSwdenk	   updating the environment in flash makes it always
4250c609719bSwdenk	   necessary to erase the WHOLE sector. If something goes
4251c609719bSwdenk	   wrong before the contents has been restored from a copy in
4252c609719bSwdenk	   RAM, your target system will be dead.
4253c609719bSwdenk
42540e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR_REDUND
42550e8d1586SJean-Christophe PLAGNIOL-VILLARD	  CONFIG_ENV_SIZE_REDUND
4256c609719bSwdenk
4257c609719bSwdenk	   These settings describe a second storage area used to hold
425811ccc33fSMarcel Ziswiler	   a redundant copy of the environment data, so that there is
42593e38691eSwdenk	   a valid backup copy in case there is a power failure during
4260c609719bSwdenk	   a "saveenv" operation.
4261c609719bSwdenk
4262c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the
4263c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds*
4264c609719bSwdenkaccordingly!
4265c609719bSwdenk
4266c609719bSwdenk
42679314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM:
4268c609719bSwdenk
4269c609719bSwdenk	Define this if you have some non-volatile memory device
4270c609719bSwdenk	(NVRAM, battery buffered SRAM) which you want to use for the
4271c609719bSwdenk	environment.
4272c609719bSwdenk
42730e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
42740e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
4275c609719bSwdenk
427611ccc33fSMarcel Ziswiler	  These two #defines are used to determine the memory area you
4277c609719bSwdenk	  want to use for environment. It is assumed that this memory
4278c609719bSwdenk	  can just be read and written to, without any special
4279c609719bSwdenk	  provision.
4280c609719bSwdenk
4281c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early
4282c609719bSwdenkin U-Boot initalization (when we try to get the setting of for the
428311ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or
4284c609719bSwdenkU-Boot will hang.
4285c609719bSwdenk
4286c609719bSwdenkPlease note that even with NVRAM we still use a copy of the
4287c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to
4288c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv"
4289c609719bSwdenkto save the current settings.
4290c609719bSwdenk
4291c609719bSwdenk
4292bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM:
4293c609719bSwdenk
4294c609719bSwdenk	Use this if you have an EEPROM or similar serial access
4295c609719bSwdenk	device and a driver for it.
4296c609719bSwdenk
42970e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
42980e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
4299c609719bSwdenk
4300c609719bSwdenk	  These two #defines specify the offset and size of the
4301c609719bSwdenk	  environment area within the total memory of your EEPROM.
4302c609719bSwdenk
43036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR:
4304c609719bSwdenk	  If defined, specified the chip address of the EEPROM device.
4305c609719bSwdenk	  The default address is zero.
4306c609719bSwdenk
43076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
4308c609719bSwdenk	  If defined, the number of bits used to address bytes in a
4309c609719bSwdenk	  single page in the EEPROM device.  A 64 byte page, for example
4310c609719bSwdenk	  would require six bits.
4311c609719bSwdenk
43126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
4313c609719bSwdenk	  If defined, the number of milliseconds to delay between
4314c609719bSwdenk	  page writes.	The default is zero milliseconds.
4315c609719bSwdenk
43166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
4317c609719bSwdenk	  The length in bytes of the EEPROM memory array address.  Note
4318c609719bSwdenk	  that this is NOT the chip address length!
4319c609719bSwdenk
43206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
43215cf91d6bSwdenk	  EEPROM chips that implement "address overflow" are ones
43225cf91d6bSwdenk	  like Catalyst 24WC04/08/16 which has 9/10/11 bits of
43235cf91d6bSwdenk	  address and the extra bits end up in the "chip address" bit
43245cf91d6bSwdenk	  slots. This makes a 24WC08 (1Kbyte) chip look like four 256
43255cf91d6bSwdenk	  byte chips.
43265cf91d6bSwdenk
43275cf91d6bSwdenk	  Note that we consider the length of the address field to
43285cf91d6bSwdenk	  still be one byte because the extra address bits are hidden
43295cf91d6bSwdenk	  in the chip address.
43305cf91d6bSwdenk
43316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_SIZE:
4332c609719bSwdenk	  The size in bytes of the EEPROM device.
4333c609719bSwdenk
4334548738b4SHeiko Schocher	- CONFIG_ENV_EEPROM_IS_ON_I2C
4335548738b4SHeiko Schocher	  define this, if you have I2C and SPI activated, and your
4336548738b4SHeiko Schocher	  EEPROM, which holds the environment, is on the I2C bus.
4337548738b4SHeiko Schocher
4338548738b4SHeiko Schocher	- CONFIG_I2C_ENV_EEPROM_BUS
4339548738b4SHeiko Schocher	  if you have an Environment on an EEPROM reached over
4340548738b4SHeiko Schocher	  I2C muxes, you can define here, how to reach this
4341548738b4SHeiko Schocher	  EEPROM. For example:
4342548738b4SHeiko Schocher
4343ea818dbbSHeiko Schocher	  #define CONFIG_I2C_ENV_EEPROM_BUS	  1
4344548738b4SHeiko Schocher
4345548738b4SHeiko Schocher	  EEPROM which holds the environment, is reached over
4346548738b4SHeiko Schocher	  a pca9547 i2c mux with address 0x70, channel 3.
4347c609719bSwdenk
4348057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH:
43495779d8d9Swdenk
43505779d8d9Swdenk	Define this if you have a DataFlash memory device which you
43515779d8d9Swdenk	want to use for the environment.
43525779d8d9Swdenk
43530e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
43540e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
43550e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
43565779d8d9Swdenk
43575779d8d9Swdenk	  These three #defines specify the offset and size of the
43585779d8d9Swdenk	  environment area within the total memory of your DataFlash placed
43595779d8d9Swdenk	  at the specified address.
43605779d8d9Swdenk
4361bd83b592SWu, Josh- CONFIG_ENV_IS_IN_SPI_FLASH:
4362bd83b592SWu, Josh
4363bd83b592SWu, Josh	Define this if you have a SPI Flash memory device which you
4364bd83b592SWu, Josh	want to use for the environment.
4365bd83b592SWu, Josh
4366bd83b592SWu, Josh	- CONFIG_ENV_OFFSET:
4367bd83b592SWu, Josh	- CONFIG_ENV_SIZE:
4368bd83b592SWu, Josh
4369bd83b592SWu, Josh	  These two #defines specify the offset and size of the
4370bd83b592SWu, Josh	  environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
4371bd83b592SWu, Josh	  aligned to an erase sector boundary.
4372bd83b592SWu, Josh
4373bd83b592SWu, Josh	- CONFIG_ENV_SECT_SIZE:
4374bd83b592SWu, Josh
4375bd83b592SWu, Josh	  Define the SPI flash's sector size.
4376bd83b592SWu, Josh
4377bd83b592SWu, Josh	- CONFIG_ENV_OFFSET_REDUND (optional):
4378bd83b592SWu, Josh
4379bd83b592SWu, Josh	  This setting describes a second storage area of CONFIG_ENV_SIZE
4380bd83b592SWu, Josh	  size used to hold a redundant copy of the environment data, so
4381bd83b592SWu, Josh	  that there is a valid backup copy in case there is a power failure
4382bd83b592SWu, Josh	  during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
4383bd83b592SWu, Josh	  aligned to an erase sector boundary.
4384bd83b592SWu, Josh
4385bd83b592SWu, Josh	- CONFIG_ENV_SPI_BUS (optional):
4386bd83b592SWu, Josh	- CONFIG_ENV_SPI_CS (optional):
4387bd83b592SWu, Josh
4388bd83b592SWu, Josh	  Define the SPI bus and chip select. If not defined they will be 0.
4389bd83b592SWu, Josh
4390bd83b592SWu, Josh	- CONFIG_ENV_SPI_MAX_HZ (optional):
4391bd83b592SWu, Josh
4392bd83b592SWu, Josh	  Define the SPI max work clock. If not defined then use 1MHz.
4393bd83b592SWu, Josh
4394bd83b592SWu, Josh	- CONFIG_ENV_SPI_MODE (optional):
4395bd83b592SWu, Josh
4396bd83b592SWu, Josh	  Define the SPI work mode. If not defined then use SPI_MODE_3.
4397bd83b592SWu, Josh
43980a85a9e7SLiu Gang- CONFIG_ENV_IS_IN_REMOTE:
43990a85a9e7SLiu Gang
44000a85a9e7SLiu Gang	Define this if you have a remote memory space which you
44010a85a9e7SLiu Gang	want to use for the local device's environment.
44020a85a9e7SLiu Gang
44030a85a9e7SLiu Gang	- CONFIG_ENV_ADDR:
44040a85a9e7SLiu Gang	- CONFIG_ENV_SIZE:
44050a85a9e7SLiu Gang
44060a85a9e7SLiu Gang	  These two #defines specify the address and size of the
44070a85a9e7SLiu Gang	  environment area within the remote memory space. The
44080a85a9e7SLiu Gang	  local device can get the environment from remote memory
4409fc54c7faSLiu Gang	  space by SRIO or PCIE links.
44100a85a9e7SLiu Gang
44110a85a9e7SLiu GangBE CAREFUL! For some special cases, the local device can not use
44120a85a9e7SLiu Gang"saveenv" command. For example, the local device will get the
4413fc54c7faSLiu Gangenvironment stored in a remote NOR flash by SRIO or PCIE link,
4414fc54c7faSLiu Gangbut it can not erase, write this NOR flash by SRIO or PCIE interface.
44150a85a9e7SLiu Gang
441651bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND:
441713a5695bSwdenk
441813a5695bSwdenk	Define this if you have a NAND device which you want to use
441913a5695bSwdenk	for the environment.
442013a5695bSwdenk
44210e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
44220e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
442313a5695bSwdenk
442413a5695bSwdenk	  These two #defines specify the offset and size of the environment
4425fdd813deSScott Wood	  area within the first NAND device.  CONFIG_ENV_OFFSET must be
4426fdd813deSScott Wood	  aligned to an erase block boundary.
44275779d8d9Swdenk
4428fdd813deSScott Wood	- CONFIG_ENV_OFFSET_REDUND (optional):
4429e443c944SMarkus Klotzbuecher
44300e8d1586SJean-Christophe PLAGNIOL-VILLARD	  This setting describes a second storage area of CONFIG_ENV_SIZE
4431fdd813deSScott Wood	  size used to hold a redundant copy of the environment data, so
4432fdd813deSScott Wood	  that there is a valid backup copy in case there is a power failure
4433fdd813deSScott Wood	  during a "saveenv" operation.	 CONFIG_ENV_OFFSET_RENDUND must be
4434fdd813deSScott Wood	  aligned to an erase block boundary.
4435e443c944SMarkus Klotzbuecher
4436fdd813deSScott Wood	- CONFIG_ENV_RANGE (optional):
4437fdd813deSScott Wood
4438fdd813deSScott Wood	  Specifies the length of the region in which the environment
4439fdd813deSScott Wood	  can be written.  This should be a multiple of the NAND device's
4440fdd813deSScott Wood	  block size.  Specifying a range with more erase blocks than
4441fdd813deSScott Wood	  are needed to hold CONFIG_ENV_SIZE allows bad blocks within
4442fdd813deSScott Wood	  the range to be avoided.
4443fdd813deSScott Wood
4444fdd813deSScott Wood	- CONFIG_ENV_OFFSET_OOB (optional):
4445fdd813deSScott Wood
4446fdd813deSScott Wood	  Enables support for dynamically retrieving the offset of the
4447fdd813deSScott Wood	  environment from block zero's out-of-band data.  The
4448fdd813deSScott Wood	  "nand env.oob" command can be used to record this offset.
4449fdd813deSScott Wood	  Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
4450fdd813deSScott Wood	  using CONFIG_ENV_OFFSET_OOB.
4451e443c944SMarkus Klotzbuecher
4452b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST
4453b74ab737SGuennadi Liakhovetski
4454b74ab737SGuennadi Liakhovetski	Defines address in RAM to which the nand_spl code should copy the
4455b74ab737SGuennadi Liakhovetski	environment. If redundant environment is used, it will be copied to
4456b74ab737SGuennadi Liakhovetski	CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
4457b74ab737SGuennadi Liakhovetski
44582b74433fSJoe Hershberger- CONFIG_ENV_IS_IN_UBI:
44592b74433fSJoe Hershberger
44602b74433fSJoe Hershberger	Define this if you have an UBI volume that you want to use for the
44612b74433fSJoe Hershberger	environment.  This has the benefit of wear-leveling the environment
44622b74433fSJoe Hershberger	accesses, which is important on NAND.
44632b74433fSJoe Hershberger
44642b74433fSJoe Hershberger	- CONFIG_ENV_UBI_PART:
44652b74433fSJoe Hershberger
44662b74433fSJoe Hershberger	  Define this to a string that is the mtd partition containing the UBI.
44672b74433fSJoe Hershberger
44682b74433fSJoe Hershberger	- CONFIG_ENV_UBI_VOLUME:
44692b74433fSJoe Hershberger
44702b74433fSJoe Hershberger	  Define this to the name of the volume that you want to store the
44712b74433fSJoe Hershberger	  environment in.
44722b74433fSJoe Hershberger
4473785881f7SJoe Hershberger	- CONFIG_ENV_UBI_VOLUME_REDUND:
4474785881f7SJoe Hershberger
4475785881f7SJoe Hershberger	  Define this to the name of another volume to store a second copy of
4476785881f7SJoe Hershberger	  the environment in.  This will enable redundant environments in UBI.
4477785881f7SJoe Hershberger	  It is assumed that both volumes are in the same MTD partition.
4478785881f7SJoe Hershberger
44792b74433fSJoe Hershberger	- CONFIG_UBI_SILENCE_MSG
44802b74433fSJoe Hershberger	- CONFIG_UBIFS_SILENCE_MSG
44812b74433fSJoe Hershberger
44822b74433fSJoe Hershberger	  You will probably want to define these to avoid a really noisy system
44832b74433fSJoe Hershberger	  when storing the env in UBI.
44842b74433fSJoe Hershberger
4485d1db76f1SWu, Josh- CONFIG_ENV_IS_IN_FAT:
4486d1db76f1SWu, Josh       Define this if you want to use the FAT file system for the environment.
4487d1db76f1SWu, Josh
4488d1db76f1SWu, Josh       - FAT_ENV_INTERFACE:
4489d1db76f1SWu, Josh
4490d1db76f1SWu, Josh         Define this to a string that is the name of the block device.
4491d1db76f1SWu, Josh
4492d1db76f1SWu, Josh       - FAT_ENV_DEV_AND_PART:
4493d1db76f1SWu, Josh
4494d1db76f1SWu, Josh         Define this to a string to specify the partition of the device. It can
4495d1db76f1SWu, Josh         be as following:
4496d1db76f1SWu, Josh
4497d1db76f1SWu, Josh           "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
4498d1db76f1SWu, Josh               - "D:P": device D partition P. Error occurs if device D has no
4499d1db76f1SWu, Josh                        partition table.
4500d1db76f1SWu, Josh               - "D:0": device D.
4501d1db76f1SWu, Josh               - "D" or "D:": device D partition 1 if device D has partition
4502d1db76f1SWu, Josh                              table, or the whole device D if has no partition
4503d1db76f1SWu, Josh                              table.
4504d1db76f1SWu, Josh               - "D:auto": first partition in device D with bootable flag set.
4505d1db76f1SWu, Josh                           If none, first valid paratition in device D. If no
4506d1db76f1SWu, Josh                           partition table then means device D.
4507d1db76f1SWu, Josh
4508d1db76f1SWu, Josh       - FAT_ENV_FILE:
4509d1db76f1SWu, Josh
4510d1db76f1SWu, Josh         It's a string of the FAT file name. This file use to store the
4511d1db76f1SWu, Josh         envrionment.
4512d1db76f1SWu, Josh
4513d1db76f1SWu, Josh       - CONFIG_FAT_WRITE:
4514d1db76f1SWu, Josh         This should be defined. Otherwise it cannot save the envrionment file.
4515d1db76f1SWu, Josh
451606e4ae5fSStephen Warren- CONFIG_ENV_IS_IN_MMC:
451706e4ae5fSStephen Warren
451806e4ae5fSStephen Warren	Define this if you have an MMC device which you want to use for the
451906e4ae5fSStephen Warren	environment.
452006e4ae5fSStephen Warren
452106e4ae5fSStephen Warren	- CONFIG_SYS_MMC_ENV_DEV:
452206e4ae5fSStephen Warren
452306e4ae5fSStephen Warren	  Specifies which MMC device the environment is stored in.
452406e4ae5fSStephen Warren
452506e4ae5fSStephen Warren	- CONFIG_SYS_MMC_ENV_PART (optional):
452606e4ae5fSStephen Warren
452706e4ae5fSStephen Warren	  Specifies which MMC partition the environment is stored in. If not
452806e4ae5fSStephen Warren	  set, defaults to partition 0, the user area. Common values might be
452906e4ae5fSStephen Warren	  1 (first MMC boot partition), 2 (second MMC boot partition).
453006e4ae5fSStephen Warren
453106e4ae5fSStephen Warren	- CONFIG_ENV_OFFSET:
453206e4ae5fSStephen Warren	- CONFIG_ENV_SIZE:
453306e4ae5fSStephen Warren
453406e4ae5fSStephen Warren	  These two #defines specify the offset and size of the environment
453506e4ae5fSStephen Warren	  area within the specified MMC device.
453606e4ae5fSStephen Warren
45375c088ee8SStephen Warren	  If offset is positive (the usual case), it is treated as relative to
45385c088ee8SStephen Warren	  the start of the MMC partition. If offset is negative, it is treated
45395c088ee8SStephen Warren	  as relative to the end of the MMC partition. This can be useful if
45405c088ee8SStephen Warren	  your board may be fitted with different MMC devices, which have
45415c088ee8SStephen Warren	  different sizes for the MMC partitions, and you always want the
45425c088ee8SStephen Warren	  environment placed at the very end of the partition, to leave the
45435c088ee8SStephen Warren	  maximum possible space before it, to store other data.
45445c088ee8SStephen Warren
454506e4ae5fSStephen Warren	  These two values are in units of bytes, but must be aligned to an
454606e4ae5fSStephen Warren	  MMC sector boundary.
454706e4ae5fSStephen Warren
454806e4ae5fSStephen Warren	- CONFIG_ENV_OFFSET_REDUND (optional):
454906e4ae5fSStephen Warren
455006e4ae5fSStephen Warren	  Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
455106e4ae5fSStephen Warren	  hold a redundant copy of the environment data. This provides a
455206e4ae5fSStephen Warren	  valid backup copy in case the other copy is corrupted, e.g. due
455306e4ae5fSStephen Warren	  to a power failure during a "saveenv" operation.
455406e4ae5fSStephen Warren
45555c088ee8SStephen Warren	  This value may also be positive or negative; this is handled in the
45565c088ee8SStephen Warren	  same way as CONFIG_ENV_OFFSET.
45575c088ee8SStephen Warren
455806e4ae5fSStephen Warren	  This value is also in units of bytes, but must also be aligned to
455906e4ae5fSStephen Warren	  an MMC sector boundary.
456006e4ae5fSStephen Warren
456106e4ae5fSStephen Warren	- CONFIG_ENV_SIZE_REDUND (optional):
456206e4ae5fSStephen Warren
456306e4ae5fSStephen Warren	  This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
456406e4ae5fSStephen Warren	  set. If this value is set, it must be set to the same value as
456506e4ae5fSStephen Warren	  CONFIG_ENV_SIZE.
456606e4ae5fSStephen Warren
45676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET
4568c609719bSwdenk
4569c609719bSwdenk	Defines offset to the initial SPI buffer area in DPRAM. The
4570c609719bSwdenk	area is used at an early stage (ROM part) if the environment
4571c609719bSwdenk	is configured to reside in the SPI EEPROM: We need a 520 byte
4572c609719bSwdenk	scratch DPRAM area. It is used between the two initialization
4573c609719bSwdenk	calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4574c609719bSwdenk	to be a good choice since it makes it far enough from the
4575c609719bSwdenk	start of the data area as well as from the stack pointer.
4576c609719bSwdenk
4577e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor
4578c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been
4579cdb74977SWolfgang Denkcreated; also, when using EEPROM you will have to use getenv_f()
4580c609719bSwdenkuntil then to read environment variables.
4581c609719bSwdenk
458285ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor
458385ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working
458485ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is
458585ec0bccSwdenknecessary, because the first environment variable we need is the
458685ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't
458785ec0bccSwdenkhave any device yet where we could complain.]
4588c609719bSwdenk
4589c609719bSwdenkNote: once the monitor has been relocated, then it will complain if
4590c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you
459185ec0bccSwdenkuse the "saveenv" command to store a valid environment.
4592c609719bSwdenk
45936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
4594fc3e2165Swdenk		Echo the inverted Ethernet link state to the fault LED.
4595fc3e2165Swdenk
45966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
4597fc3e2165Swdenk		      also needs to be defined.
4598fc3e2165Swdenk
45996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR:
4600fc3e2165Swdenk		MII address of the PHY to check for the Ethernet link state.
4601c609719bSwdenk
4602f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS:
4603f5675aa5SRon Madrid		Define this if you desire to only have use of the NS16550_init
4604f5675aa5SRon Madrid		and NS16550_putc functions for the serial driver located at
4605f5675aa5SRon Madrid		drivers/serial/ns16550.c.  This option is useful for saving
4606f5675aa5SRon Madrid		space for already greatly restricted images, including but not
4607f5675aa5SRon Madrid		limited to NAND_SPL configurations.
4608f5675aa5SRon Madrid
4609b2b92f53SSimon Glass- CONFIG_DISPLAY_BOARDINFO
4610b2b92f53SSimon Glass		Display information about the board that U-Boot is running on
4611b2b92f53SSimon Glass		when U-Boot starts up. The board function checkboard() is called
4612b2b92f53SSimon Glass		to do this.
4613b2b92f53SSimon Glass
4614e2e3e2b1SSimon Glass- CONFIG_DISPLAY_BOARDINFO_LATE
4615e2e3e2b1SSimon Glass		Similar to the previous option, but display this information
4616e2e3e2b1SSimon Glass		later, once stdio is running and output goes to the LCD, if
4617e2e3e2b1SSimon Glass		present.
4618e2e3e2b1SSimon Glass
4619feb85801SSascha Silbe- CONFIG_BOARD_SIZE_LIMIT:
4620feb85801SSascha Silbe		Maximum size of the U-Boot image. When defined, the
4621feb85801SSascha Silbe		build system checks that the actual size does not
4622feb85801SSascha Silbe		exceed it.
4623feb85801SSascha Silbe
4624c609719bSwdenkLow Level (hardware related) configuration options:
4625dc7c9a1aSwdenk---------------------------------------------------
4626c609719bSwdenk
46276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE:
4628c609719bSwdenk		Cache Line Size of the CPU.
4629c609719bSwdenk
46306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR:
4631c609719bSwdenk		Default address of the IMMR after system reset.
46322535d602Swdenk
46332535d602Swdenk		Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
46342535d602Swdenk		and RPXsuper) to be able to adjust the position of
46352535d602Swdenk		the IMMR register after a reset.
4636c609719bSwdenk
4637e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_DEFAULT:
4638e46fedfeSTimur Tabi		Default (power-on reset) physical address of CCSR on Freescale
4639e46fedfeSTimur Tabi		PowerPC SOCs.
4640e46fedfeSTimur Tabi
4641e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR:
4642e46fedfeSTimur Tabi		Virtual address of CCSR.  On a 32-bit build, this is typically
4643e46fedfeSTimur Tabi		the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4644e46fedfeSTimur Tabi
4645e46fedfeSTimur Tabi		CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4646e46fedfeSTimur Tabi		for cross-platform code that uses that macro instead.
4647e46fedfeSTimur Tabi
4648e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS:
4649e46fedfeSTimur Tabi		Physical address of CCSR.  CCSR can be relocated to a new
4650e46fedfeSTimur Tabi		physical address, if desired.  In this case, this macro should
4651e46fedfeSTimur Tabi		be set to that address.	 Otherwise, it should be set to the
4652e46fedfeSTimur Tabi		same value as CONFIG_SYS_CCSRBAR_DEFAULT.  For example, CCSR
4653e46fedfeSTimur Tabi		is typically relocated on 36-bit builds.  It is recommended
4654e46fedfeSTimur Tabi		that this macro be defined via the _HIGH and _LOW macros:
4655e46fedfeSTimur Tabi
4656e46fedfeSTimur Tabi		#define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4657e46fedfeSTimur Tabi			* 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4658e46fedfeSTimur Tabi
4659e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
4660e46fedfeSTimur Tabi		Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS.	This value is typically
4661e46fedfeSTimur Tabi		either 0 (32-bit build) or 0xF (36-bit build).	This macro is
4662e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
4663e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
4664e46fedfeSTimur Tabi
4665e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4666e46fedfeSTimur Tabi		Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS.  This macro is
4667e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
4668e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
4669e46fedfeSTimur Tabi
4670e46fedfeSTimur Tabi- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4671e46fedfeSTimur Tabi		If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4672e46fedfeSTimur Tabi		forced to a value that ensures that CCSR is not relocated.
4673e46fedfeSTimur Tabi
46747f6c2cbcSwdenk- Floppy Disk Support:
46756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER
46767f6c2cbcSwdenk
46777f6c2cbcSwdenk		the default drive number (default value 0)
46787f6c2cbcSwdenk
46796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_STRIDE
46807f6c2cbcSwdenk
468111ccc33fSMarcel Ziswiler		defines the spacing between FDC chipset registers
46827f6c2cbcSwdenk		(default value 1)
46837f6c2cbcSwdenk
46846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_OFFSET
46857f6c2cbcSwdenk
46867f6c2cbcSwdenk		defines the offset of register from address. It
46877f6c2cbcSwdenk		depends on which part of the data bus is connected to
468811ccc33fSMarcel Ziswiler		the FDC chipset. (default value 0)
46897f6c2cbcSwdenk
46906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
46916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
46927f6c2cbcSwdenk		default value.
46937f6c2cbcSwdenk
46946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		if CONFIG_SYS_FDC_HW_INIT is defined, then the function
46957f6c2cbcSwdenk		fdc_hw_init() is called at the beginning of the FDC
46967f6c2cbcSwdenk		setup. fdc_hw_init() must be provided by the board
46977f6c2cbcSwdenk		source code. It is used to make hardware dependant
46987f6c2cbcSwdenk		initializations.
46997f6c2cbcSwdenk
47000abddf82SMacpaul Lin- CONFIG_IDE_AHB:
47010abddf82SMacpaul Lin		Most IDE controllers were designed to be connected with PCI
47020abddf82SMacpaul Lin		interface. Only few of them were designed for AHB interface.
47030abddf82SMacpaul Lin		When software is doing ATA command and data transfer to
47040abddf82SMacpaul Lin		IDE devices through IDE-AHB controller, some additional
47050abddf82SMacpaul Lin		registers accessing to these kind of IDE-AHB controller
47060abddf82SMacpaul Lin		is requierd.
47070abddf82SMacpaul Lin
47086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR:	Physical address of the Internal Memory.
470925d6712aSwdenk		DO NOT CHANGE unless you know exactly what you're
471025d6712aSwdenk		doing! (11-4) [MPC8xx/82xx systems only]
4711c609719bSwdenk
47126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR:
4713c609719bSwdenk
47147152b1d0Swdenk		Start address of memory area that can be used for
4715c609719bSwdenk		initial data and stack; please note that this must be
4716c609719bSwdenk		writable memory that is working WITHOUT special
4717c609719bSwdenk		initialization, i. e. you CANNOT use normal RAM which
4718c609719bSwdenk		will become available only after programming the
4719c609719bSwdenk		memory controller and running certain initialization
4720c609719bSwdenk		sequences.
4721c609719bSwdenk
4722c609719bSwdenk		U-Boot uses the following memory types:
4723c609719bSwdenk		- MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4724c609719bSwdenk		- MPC824X: data cache
4725c609719bSwdenk		- PPC4xx:  data cache
4726c609719bSwdenk
47276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET:
4728c609719bSwdenk
4729c609719bSwdenk		Offset of the initial data structure in the memory
47306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
47316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
4732c609719bSwdenk		data is located at the end of the available space
4733553f0982SWolfgang Denk		(sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
47346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
47356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
47366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET) downward.
4737c609719bSwdenk
4738c609719bSwdenk	Note:
4739c609719bSwdenk		On the MPC824X (or other systems that use the data
4740c609719bSwdenk		cache for initial memory) the address chosen for
47416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
4742c609719bSwdenk		point to an otherwise UNUSED address space between
4743c609719bSwdenk		the top of RAM and the start of the PCI space.
4744c609719bSwdenk
47456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR:	SIU Module Configuration (11-6)
4746c609719bSwdenk
47476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR:	System Protection Control (11-9)
4748c609719bSwdenk
47496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR:	Time Base Status and Control (11-26)
4750c609719bSwdenk
47516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR:	Periodic Interrupt Status and Control (11-31)
4752c609719bSwdenk
47536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR:	PLL, Low-Power, and Reset Control Register (15-30)
4754c609719bSwdenk
47556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR:	System Clock and reset Control Register (15-27)
4756c609719bSwdenk
47576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM:
4758c609719bSwdenk		SDRAM timing
4759c609719bSwdenk
47606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA:
4761c609719bSwdenk		periodic timer for refresh
4762c609719bSwdenk
47636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER:	Debug Event Register (37-47)
4764c609719bSwdenk
47656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
47666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
47676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
47686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_BR1_PRELIM:
4769c609719bSwdenk		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4770c609719bSwdenk
4771c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
47726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
47736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
4774c609719bSwdenk		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4775c609719bSwdenk
47766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
47776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
4778c609719bSwdenk		Machine Mode Register and Memory Periodic Timer
4779c609719bSwdenk		Prescaler definitions (SDRAM timing)
4780c609719bSwdenk
47816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
4782c609719bSwdenk		enable I2C microcode relocation patch (MPC8xx);
4783c609719bSwdenk		define relocation offset in DPRAM [DSP2]
4784c609719bSwdenk
47856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
4786b423d055SHeiko Schocher		enable SMC microcode relocation patch (MPC8xx);
4787b423d055SHeiko Schocher		define relocation offset in DPRAM [SMC1]
4788b423d055SHeiko Schocher
47896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
4790c609719bSwdenk		enable SPI microcode relocation patch (MPC8xx);
4791c609719bSwdenk		define relocation offset in DPRAM [SCC4]
4792c609719bSwdenk
47936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_USE_OSCCLK:
4794c609719bSwdenk		Use OSCM clock mode on MBX8xx board. Be careful,
4795c609719bSwdenk		wrong setting might damage your board. Read
4796c609719bSwdenk		doc/README.MBX before setting this variable!
4797c609719bSwdenk
47986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
4799ea909b76Swdenk		Offset of the bootmode word in DPRAM used by post
4800ea909b76Swdenk		(Power On Self Tests). This definition overrides
4801ea909b76Swdenk		#define'd default value in commproc.h resp.
4802ea909b76Swdenk		cpm_8260.h.
4803ea909b76Swdenk
48046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
48056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
48066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
48076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
48086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
48096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
48106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
48116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
4812a47a12beSStefan Roese		Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
48135d232d0eSwdenk
48149cacf4fcSDirk Eibach- CONFIG_PCI_DISABLE_PCIE:
48159cacf4fcSDirk Eibach		Disable PCI-Express on systems where it is supported but not
48169cacf4fcSDirk Eibach		required.
48179cacf4fcSDirk Eibach
481869fd2d3bSAndrew Sharp- CONFIG_PCI_ENUM_ONLY
481969fd2d3bSAndrew Sharp		Only scan through and get the devices on the busses.
482069fd2d3bSAndrew Sharp		Don't do any setup work, presumably because someone or
482169fd2d3bSAndrew Sharp		something has already done it, and we don't need to do it
482269fd2d3bSAndrew Sharp		a second time.	Useful for platforms that are pre-booted
482369fd2d3bSAndrew Sharp		by coreboot or similar.
482469fd2d3bSAndrew Sharp
4825842033e6SGabor Juhos- CONFIG_PCI_INDIRECT_BRIDGE:
4826842033e6SGabor Juhos		Enable support for indirect PCI bridges.
4827842033e6SGabor Juhos
4828a09b9b68SKumar Gala- CONFIG_SYS_SRIO:
4829a09b9b68SKumar Gala		Chip has SRIO or not
4830a09b9b68SKumar Gala
4831a09b9b68SKumar Gala- CONFIG_SRIO1:
4832a09b9b68SKumar Gala		Board has SRIO 1 port available
4833a09b9b68SKumar Gala
4834a09b9b68SKumar Gala- CONFIG_SRIO2:
4835a09b9b68SKumar Gala		Board has SRIO 2 port available
4836a09b9b68SKumar Gala
4837c8b28152SLiu Gang- CONFIG_SRIO_PCIE_BOOT_MASTER
4838c8b28152SLiu Gang		Board can support master function for Boot from SRIO and PCIE
4839c8b28152SLiu Gang
4840a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_VIRT:
4841a09b9b68SKumar Gala		Virtual Address of SRIO port 'n' memory region
4842a09b9b68SKumar Gala
4843a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_PHYS:
4844a09b9b68SKumar Gala		Physical Address of SRIO port 'n' memory region
4845a09b9b68SKumar Gala
4846a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_SIZE:
4847a09b9b68SKumar Gala		Size of SRIO port 'n' memory region
4848a09b9b68SKumar Gala
484966bd1846SFabio Estevam- CONFIG_SYS_NAND_BUSWIDTH_16BIT
485066bd1846SFabio Estevam		Defined to tell the NAND controller that the NAND chip is using
485166bd1846SFabio Estevam		a 16 bit bus.
485266bd1846SFabio Estevam		Not all NAND drivers use this symbol.
4853a430e916SFabio Estevam		Example of drivers that use it:
485466bd1846SFabio Estevam		- drivers/mtd/nand/ndfc.c
4855a430e916SFabio Estevam		- drivers/mtd/nand/mxc_nand.c
4856eced4626SAlex Waterman
4857eced4626SAlex Waterman- CONFIG_SYS_NDFC_EBC0_CFG
4858eced4626SAlex Waterman		Sets the EBC0_CFG register for the NDFC. If not defined
4859eced4626SAlex Waterman		a default value will be used.
4860eced4626SAlex Waterman
4861bb99ad6dSBen Warren- CONFIG_SPD_EEPROM
4862218ca724SWolfgang Denk		Get DDR timing information from an I2C EEPROM. Common
4863218ca724SWolfgang Denk		with pluggable memory modules such as SODIMMs
4864218ca724SWolfgang Denk
4865bb99ad6dSBen Warren  SPD_EEPROM_ADDRESS
4866bb99ad6dSBen Warren		I2C address of the SPD EEPROM
4867bb99ad6dSBen Warren
48686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM
4869218ca724SWolfgang Denk		If SPD EEPROM is on an I2C bus other than the first
4870218ca724SWolfgang Denk		one, specify here. Note that the value must resolve
4871218ca724SWolfgang Denk		to something your driver can deal with.
4872bb99ad6dSBen Warren
48731b3e3c4fSYork Sun- CONFIG_SYS_DDR_RAW_TIMING
48741b3e3c4fSYork Sun		Get DDR timing information from other than SPD. Common with
48751b3e3c4fSYork Sun		soldered DDR chips onboard without SPD. DDR raw timing
48761b3e3c4fSYork Sun		parameters are extracted from datasheet and hard-coded into
48771b3e3c4fSYork Sun		header files or board specific files.
48781b3e3c4fSYork Sun
48796f5e1dc5SYork Sun- CONFIG_FSL_DDR_INTERACTIVE
48806f5e1dc5SYork Sun		Enable interactive DDR debugging. See doc/README.fsl-ddr.
48816f5e1dc5SYork Sun
48826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0
4883218ca724SWolfgang Denk		Only for 83xx systems. If specified, then DDR should
4884218ca724SWolfgang Denk		be configured using CS0 and CS1 instead of CS2 and CS3.
48852ad6b513STimur Tabi
4886c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12]
4887c26e454dSwdenk		Define to enable FEC[12] on a 8xx series processor.
4888c26e454dSwdenk
4889c26e454dSwdenk- CONFIG_FEC[12]_PHY
4890c26e454dSwdenk		Define to the hardcoded PHY address which corresponds
48916e592385Swdenk		to the given FEC; i. e.
4892c26e454dSwdenk			#define CONFIG_FEC1_PHY 4
4893c26e454dSwdenk		means that the PHY with address 4 is connected to FEC1
4894c26e454dSwdenk
4895c26e454dSwdenk		When set to -1, means to probe for first available.
4896c26e454dSwdenk
4897c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR
4898c26e454dSwdenk		The PHY does not have a RXERR line (RMII only).
4899c26e454dSwdenk		(so program the FEC to ignore it).
4900c26e454dSwdenk
4901c26e454dSwdenk- CONFIG_RMII
4902c26e454dSwdenk		Enable RMII mode for all FECs.
4903c26e454dSwdenk		Note that this is a global option, we can't
4904c26e454dSwdenk		have one FEC in standard MII mode and another in RMII mode.
4905c26e454dSwdenk
49065cf91d6bSwdenk- CONFIG_CRC32_VERIFY
49075cf91d6bSwdenk		Add a verify option to the crc32 command.
49085cf91d6bSwdenk		The syntax is:
49095cf91d6bSwdenk
49105cf91d6bSwdenk		=> crc32 -v <address> <count> <crc32>
49115cf91d6bSwdenk
49125cf91d6bSwdenk		Where address/count indicate a memory area
49135cf91d6bSwdenk		and crc32 is the correct crc32 which the
49145cf91d6bSwdenk		area should have.
49155cf91d6bSwdenk
491656523f12Swdenk- CONFIG_LOOPW
491756523f12Swdenk		Add the "loopw" memory command. This only takes effect if
4918602ad3b3SJon Loeliger		the memory commands are activated globally (CONFIG_CMD_MEM).
491956523f12Swdenk
49207b466641Sstroese- CONFIG_MX_CYCLIC
49217b466641Sstroese		Add the "mdc" and "mwc" memory commands. These are cyclic
49227b466641Sstroese		"md/mw" commands.
49237b466641Sstroese		Examples:
49247b466641Sstroese
49257b466641Sstroese		=> mdc.b 10 4 500
49267b466641Sstroese		This command will print 4 bytes (10,11,12,13) each 500 ms.
49277b466641Sstroese
49287b466641Sstroese		=> mwc.l 100 12345678 10
49297b466641Sstroese		This command will write 12345678 to address 100 all 10 ms.
49307b466641Sstroese
49317b466641Sstroese		This only takes effect if the memory commands are activated
4932602ad3b3SJon Loeliger		globally (CONFIG_CMD_MEM).
49337b466641Sstroese
49348aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT
4935afc1ce82SMacpaul Lin		[ARM, NDS32, MIPS only] If this variable is defined, then certain
4936e03f3169SWolfgang Denk		low level initializations (like setting up the memory
4937e03f3169SWolfgang Denk		controller) are omitted and/or U-Boot does not
4938e03f3169SWolfgang Denk		relocate itself into RAM.
49398aa1a2d1Swdenk
4940e03f3169SWolfgang Denk		Normally this variable MUST NOT be defined. The only
4941e03f3169SWolfgang Denk		exception is when U-Boot is loaded (to RAM) by some
4942e03f3169SWolfgang Denk		other boot loader or by a debugger which performs
4943e03f3169SWolfgang Denk		these initializations itself.
49448aa1a2d1Swdenk
4945401bb30bSAneesh V- CONFIG_SPL_BUILD
4946df81238bSMagnus Lilja		Modifies the behaviour of start.S when compiling a loader
4947df81238bSMagnus Lilja		that is executed before the actual U-Boot. E.g. when
4948df81238bSMagnus Lilja		compiling a NAND SPL.
4949400558b5Swdenk
49503aa29de0SYing Zhang- CONFIG_TPL_BUILD
49513aa29de0SYing Zhang		Modifies the behaviour of start.S  when compiling a loader
49523aa29de0SYing Zhang		that is executed after the SPL and before the actual U-Boot.
49533aa29de0SYing Zhang		It is loaded by the SPL.
49543aa29de0SYing Zhang
49555df572f0SYing Zhang- CONFIG_SYS_MPC85XX_NO_RESETVEC
49565df572f0SYing Zhang		Only for 85xx systems. If this variable is specified, the section
49575df572f0SYing Zhang		.resetvec is not kept and the section .bootpg is placed in the
49585df572f0SYing Zhang		previous 4k of the .text section.
49595df572f0SYing Zhang
49604213fc29SSimon Glass- CONFIG_ARCH_MAP_SYSMEM
49614213fc29SSimon Glass		Generally U-Boot (and in particular the md command) uses
49624213fc29SSimon Glass		effective address. It is therefore not necessary to regard
49634213fc29SSimon Glass		U-Boot address as virtual addresses that need to be translated
49644213fc29SSimon Glass		to physical addresses. However, sandbox requires this, since
49654213fc29SSimon Glass		it maintains its own little RAM buffer which contains all
49664213fc29SSimon Glass		addressable memory. This option causes some memory accesses
49674213fc29SSimon Glass		to be mapped through map_sysmem() / unmap_sysmem().
49684213fc29SSimon Glass
4969d8834a13SMatthias Weisser- CONFIG_USE_ARCH_MEMCPY
4970d8834a13SMatthias Weisser  CONFIG_USE_ARCH_MEMSET
4971d8834a13SMatthias Weisser		If these options are used a optimized version of memcpy/memset will
4972d8834a13SMatthias Weisser		be used if available. These functions may be faster under some
4973d8834a13SMatthias Weisser		conditions but may increase the binary size.
4974d8834a13SMatthias Weisser
4975588a13f7SSimon Glass- CONFIG_X86_RESET_VECTOR
4976588a13f7SSimon Glass		If defined, the x86 reset vector code is included. This is not
4977588a13f7SSimon Glass		needed when U-Boot is running from Coreboot.
4978b16f521aSGabe Black
4979fc33705eSMark Jackson- CONFIG_SYS_MPUCLK
4980fc33705eSMark Jackson		Defines the MPU clock speed (in MHz).
4981fc33705eSMark Jackson
4982fc33705eSMark Jackson		NOTE : currently only supported on AM335x platforms.
49835b5ece9eSGabe Black
498416678eb4SHeiko Schocher- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
498516678eb4SHeiko Schocher		Enables the RTC32K OSC on AM33xx based plattforms
498616678eb4SHeiko Schocher
4987999d7d32SKaricheri, Muralidharan- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
4988999d7d32SKaricheri, Muralidharan		Option to disable subpage write in NAND driver
4989999d7d32SKaricheri, Muralidharan		driver that uses this:
4990999d7d32SKaricheri, Muralidharan		drivers/mtd/nand/davinci_nand.c
4991999d7d32SKaricheri, Muralidharan
4992f2717b47STimur TabiFreescale QE/FMAN Firmware Support:
4993f2717b47STimur Tabi-----------------------------------
4994f2717b47STimur Tabi
4995f2717b47STimur TabiThe Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4996f2717b47STimur Tabiloading of "firmware", which is encoded in the QE firmware binary format.
4997f2717b47STimur TabiThis firmware often needs to be loaded during U-Boot booting, so macros
4998f2717b47STimur Tabiare used to identify the storage device (NOR flash, SPI, etc) and the address
4999f2717b47STimur Tabiwithin that device.
5000f2717b47STimur Tabi
5001dcf1d774SZhao Qiang- CONFIG_SYS_FMAN_FW_ADDR
5002dcf1d774SZhao Qiang	The address in the storage device where the FMAN microcode is located.  The
5003dcf1d774SZhao Qiang	meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
5004dcf1d774SZhao Qiang	is also specified.
5005dcf1d774SZhao Qiang
5006dcf1d774SZhao Qiang- CONFIG_SYS_QE_FW_ADDR
5007dcf1d774SZhao Qiang	The address in the storage device where the QE microcode is located.  The
5008f2717b47STimur Tabi	meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
5009f2717b47STimur Tabi	is also specified.
5010f2717b47STimur Tabi
5011f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_LENGTH
5012f2717b47STimur Tabi	The maximum possible size of the firmware.  The firmware binary format
5013f2717b47STimur Tabi	has a field that specifies the actual size of the firmware, but it
5014f2717b47STimur Tabi	might not be possible to read any part of the firmware unless some
5015f2717b47STimur Tabi	local storage is allocated to hold the entire firmware first.
5016f2717b47STimur Tabi
5017f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NOR
5018f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NOR flash, mapped as
5019f2717b47STimur Tabi	normal addressable memory via the LBC.  CONFIG_SYS_FMAN_FW_ADDR is the
5020f2717b47STimur Tabi	virtual address in NOR flash.
5021f2717b47STimur Tabi
5022f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NAND
5023f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NAND flash.
5024f2717b47STimur Tabi	CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
5025f2717b47STimur Tabi
5026f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_MMC
5027f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SD/MMC
5028f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
5029f2717b47STimur Tabi
5030f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
5031f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SPI
5032f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
5033f2717b47STimur Tabi
5034292dc6c5SLiu Gang- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
5035292dc6c5SLiu Gang	Specifies that QE/FMAN firmware is located in the remote (master)
5036292dc6c5SLiu Gang	memory space.	CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
5037fc54c7faSLiu Gang	can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
5038fc54c7faSLiu Gang	window->master inbound window->master LAW->the ucode address in
5039fc54c7faSLiu Gang	master's memory space.
5040f2717b47STimur Tabi
5041b940ca64SJ. German RiveraFreescale Layerscape Management Complex Firmware Support:
5042b940ca64SJ. German Rivera---------------------------------------------------------
5043b940ca64SJ. German RiveraThe Freescale Layerscape Management Complex (MC) supports the loading of
5044b940ca64SJ. German Rivera"firmware".
5045b940ca64SJ. German RiveraThis firmware often needs to be loaded during U-Boot booting, so macros
5046b940ca64SJ. German Riveraare used to identify the storage device (NOR flash, SPI, etc) and the address
5047b940ca64SJ. German Riverawithin that device.
5048b940ca64SJ. German Rivera
5049b940ca64SJ. German Rivera- CONFIG_FSL_MC_ENET
5050b940ca64SJ. German Rivera	Enable the MC driver for Layerscape SoCs.
5051b940ca64SJ. German Rivera
5052b940ca64SJ. German Rivera- CONFIG_SYS_LS_MC_FW_ADDR
5053b940ca64SJ. German Rivera	The address in the storage device where the firmware is located.  The
5054b940ca64SJ. German Rivera	meaning of this address depends on which CONFIG_SYS_LS_MC_FW_IN_xxx macro
5055b940ca64SJ. German Rivera	is also specified.
5056b940ca64SJ. German Rivera
5057b940ca64SJ. German Rivera- CONFIG_SYS_LS_MC_FW_LENGTH
5058b940ca64SJ. German Rivera	The maximum possible size of the firmware.  The firmware binary format
5059b940ca64SJ. German Rivera	has a field that specifies the actual size of the firmware, but it
5060b940ca64SJ. German Rivera	might not be possible to read any part of the firmware unless some
5061b940ca64SJ. German Rivera	local storage is allocated to hold the entire firmware first.
5062b940ca64SJ. German Rivera
5063b940ca64SJ. German Rivera- CONFIG_SYS_LS_MC_FW_IN_NOR
5064b940ca64SJ. German Rivera	Specifies that MC firmware is located in NOR flash, mapped as
5065b940ca64SJ. German Rivera	normal addressable memory via the LBC. CONFIG_SYS_LS_MC_FW_ADDR is the
5066b940ca64SJ. German Rivera	virtual address in NOR flash.
5067b940ca64SJ. German Rivera
5068c609719bSwdenkBuilding the Software:
5069c609719bSwdenk======================
5070c609719bSwdenk
5071218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments
5072218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support
5073218ca724SWolfgang Denkall possibly existing versions of cross development tools in all
5074218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we
5075218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
5076218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot.
5077c609719bSwdenk
5078218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you
5079218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case,
5080218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell.
5081218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are
5082218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter:
5083c609719bSwdenk
5084218ca724SWolfgang Denk	$ CROSS_COMPILE=ppc_4xx-
5085218ca724SWolfgang Denk	$ export CROSS_COMPILE
5086c609719bSwdenk
50872f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in
50882f8d396bSPeter Tyser      the tools directory you can use the MinGW toolchain
50892f8d396bSPeter Tyser      (http://www.mingw.org).  Set your HOST tools to the MinGW
50902f8d396bSPeter Tyser      toolchain and execute 'make tools'.  For example:
50912f8d396bSPeter Tyser
50922f8d396bSPeter Tyser       $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
50932f8d396bSPeter Tyser
50942f8d396bSPeter Tyser      Binaries such as tools/mkimage.exe will be created which can
50952f8d396bSPeter Tyser      be executed on computers running Windows.
50962f8d396bSPeter Tyser
5097c609719bSwdenkU-Boot is intended to be simple to build. After installing the
5098c609719bSwdenksources you must configure U-Boot for one specific board type. This
5099c609719bSwdenkis done by typing:
5100c609719bSwdenk
5101ab584d67SHolger Freyther	make NAME_defconfig
5102c609719bSwdenk
5103ab584d67SHolger Freytherwhere "NAME_defconfig" is the name of one of the existing configu-
51044d675ae6SMichael Jonesrations; see boards.cfg for supported names.
510554387ac9Swdenk
5106c609719bSwdenkNote: for some board special configuration names may exist; check if
5107c609719bSwdenk      additional information is available from the board vendor; for
51082729af9dSwdenk      instance, the TQM823L systems are available without (standard)
51092729af9dSwdenk      or with LCD support. You can select such additional "features"
511011ccc33fSMarcel Ziswiler      when choosing the configuration, i. e.
5111c609719bSwdenk
5112ab584d67SHolger Freyther      make TQM823L_defconfig
51132729af9dSwdenk	- will configure for a plain TQM823L, i. e. no LCD support
5114c609719bSwdenk
5115ab584d67SHolger Freyther      make TQM823L_LCD_defconfig
5116c609719bSwdenk	- will configure for a TQM823L with U-Boot console on LCD
5117c609719bSwdenk
5118c609719bSwdenk      etc.
5119c609719bSwdenk
5120c609719bSwdenk
5121c609719bSwdenkFinally, type "make all", and you should get some working U-Boot
51227152b1d0Swdenkimages ready for download to / installation on your system:
5123c609719bSwdenk
5124c609719bSwdenk- "u-boot.bin" is a raw binary image
5125c609719bSwdenk- "u-boot" is an image in ELF binary format
5126c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format
5127c609719bSwdenk
5128baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved
5129baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change
5130baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory:
5131baf31249SMarian Balakowicz
5132baf31249SMarian Balakowicz1. Add O= to the make command line invocations:
5133baf31249SMarian Balakowicz
5134baf31249SMarian Balakowicz	make O=/tmp/build distclean
5135ab584d67SHolger Freyther	make O=/tmp/build NAME_defconfig
5136baf31249SMarian Balakowicz	make O=/tmp/build all
5137baf31249SMarian Balakowicz
5138adbba996STimo Ketola2. Set environment variable KBUILD_OUTPUT to point to the desired location:
5139baf31249SMarian Balakowicz
5140adbba996STimo Ketola	export KBUILD_OUTPUT=/tmp/build
5141baf31249SMarian Balakowicz	make distclean
5142ab584d67SHolger Freyther	make NAME_defconfig
5143baf31249SMarian Balakowicz	make all
5144baf31249SMarian Balakowicz
5145adbba996STimo KetolaNote that the command line "O=" setting overrides the KBUILD_OUTPUT environment
5146baf31249SMarian Balakowiczvariable.
5147baf31249SMarian Balakowicz
5148c609719bSwdenk
5149c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so
5150c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of
5151c609719bSwdenknative "make".
5152c609719bSwdenk
5153c609719bSwdenk
5154c609719bSwdenkIf the system board that you have is not listed, then you will need
5155c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these
5156c609719bSwdenksteps:
5157c609719bSwdenk
5158c609719bSwdenk1.  Add a new configuration option for your board to the toplevel
51594d675ae6SMichael Jones    "boards.cfg" file, using the existing entries as examples.
51604d675ae6SMichael Jones    Follow the instructions there to keep the boards in order.
5161c609719bSwdenk2.  Create a new directory to hold your board specific code. Add any
516285ec0bccSwdenk    files you need. In your board directory, you will need at least
516385ec0bccSwdenk    the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
516485ec0bccSwdenk3.  Create a new configuration file "include/configs/<board>.h" for
516585ec0bccSwdenk    your board
5166c609719bSwdenk3.  If you're porting U-Boot to a new CPU, then also create a new
5167c609719bSwdenk    directory to hold your CPU specific code. Add any files you need.
5168ab584d67SHolger Freyther4.  Run "make <board>_defconfig" with your new name.
5169c609719bSwdenk5.  Type "make", and you should get a working "u-boot.srec" file
5170c609719bSwdenk    to be installed on your target system.
517185ec0bccSwdenk6.  Debug and solve any problems that might arise.
5172c609719bSwdenk    [Of course, this last step is much harder than it sounds.]
5173c609719bSwdenk
5174c609719bSwdenk
5175c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.:
5176c609719bSwdenk==============================================================
5177c609719bSwdenk
5178c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board
5179c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to
5180c609719bSwdenkprovide feedback to the other developers. The feedback normally takes
5181c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest
5182218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources.
5183c609719bSwdenk
5184c609719bSwdenkBut before you submit such a patch, please verify that your modifi-
5185c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of
5186c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so,
5187c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot
5188c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You can
51897152b1d0Swdenkselect which (cross) compiler to use by passing a `CROSS_COMPILE'
5190218ca724SWolfgang Denkenvironment variable to the script, i. e. to use the ELDK cross tools
5191218ca724SWolfgang Denkyou can type
5192c609719bSwdenk
5193c609719bSwdenk	CROSS_COMPILE=ppc_8xx- MAKEALL
5194c609719bSwdenk
5195c609719bSwdenkor to build on a native PowerPC system you can type
5196c609719bSwdenk
5197c609719bSwdenk	CROSS_COMPILE=' ' MAKEALL
5198c609719bSwdenk
5199218ca724SWolfgang DenkWhen using the MAKEALL script, the default behaviour is to build
5200218ca724SWolfgang DenkU-Boot in the source directory. This location can be changed by
5201218ca724SWolfgang Denksetting the BUILD_DIR environment variable. Also, for each target
5202218ca724SWolfgang Denkbuilt, the MAKEALL script saves two log files (<target>.ERR and
5203218ca724SWolfgang Denk<target>.MAKEALL) in the <source dir>/LOG directory. This default
5204218ca724SWolfgang Denklocation can be changed by setting the MAKEALL_LOGDIR environment
5205218ca724SWolfgang Denkvariable. For example:
5206baf31249SMarian Balakowicz
5207baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
5208baf31249SMarian Balakowicz	export MAKEALL_LOGDIR=/tmp/log
5209baf31249SMarian Balakowicz	CROSS_COMPILE=ppc_8xx- MAKEALL
5210baf31249SMarian Balakowicz
5211218ca724SWolfgang DenkWith the above settings build objects are saved in the /tmp/build,
5212218ca724SWolfgang Denklog files are saved in the /tmp/log and the source tree remains clean
5213218ca724SWolfgang Denkduring the whole build process.
5214baf31249SMarian Balakowicz
5215baf31249SMarian Balakowicz
5216c609719bSwdenkSee also "U-Boot Porting Guide" below.
5217c609719bSwdenk
5218c609719bSwdenk
5219c609719bSwdenkMonitor Commands - Overview:
5220c609719bSwdenk============================
5221c609719bSwdenk
5222c609719bSwdenkgo	- start application at address 'addr'
5223c609719bSwdenkrun	- run commands in an environment variable
5224c609719bSwdenkbootm	- boot application image from memory
5225c609719bSwdenkbootp	- boot image via network using BootP/TFTP protocol
522644f074c7SMarek Vasutbootz   - boot zImage from memory
5227c609719bSwdenktftpboot- boot image via network using TFTP protocol
5228c609719bSwdenk	       and env variables "ipaddr" and "serverip"
5229c609719bSwdenk	       (and eventually "gatewayip")
52301fb7cd49SSimon Glasstftpput - upload a file via network using TFTP protocol
5231c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol
5232c609719bSwdenkdiskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
5233c609719bSwdenkloads	- load S-Record file over serial line
5234c609719bSwdenkloadb	- load binary file over serial line (kermit mode)
5235c609719bSwdenkmd	- memory display
5236c609719bSwdenkmm	- memory modify (auto-incrementing)
5237c609719bSwdenknm	- memory modify (constant address)
5238c609719bSwdenkmw	- memory write (fill)
5239c609719bSwdenkcp	- memory copy
5240c609719bSwdenkcmp	- memory compare
5241c609719bSwdenkcrc32	- checksum calculation
52420f89c54bSPeter Tyseri2c	- I2C sub-system
5243c609719bSwdenksspi	- SPI utility commands
5244c609719bSwdenkbase	- print or set address offset
5245c609719bSwdenkprintenv- print environment variables
5246c609719bSwdenksetenv	- set environment variables
5247c609719bSwdenksaveenv - save environment variables to persistent storage
5248c609719bSwdenkprotect - enable or disable FLASH write protection
5249c609719bSwdenkerase	- erase FLASH memory
5250c609719bSwdenkflinfo	- print FLASH memory information
525110635afaSKarl O. Pincnand	- NAND memory operations (see doc/README.nand)
5252c609719bSwdenkbdinfo	- print Board Info structure
5253c609719bSwdenkiminfo	- print header information for application image
5254c609719bSwdenkconinfo - print console devices and informations
5255c609719bSwdenkide	- IDE sub-system
5256c609719bSwdenkloop	- infinite loop on address range
525756523f12Swdenkloopw	- infinite write loop on address range
5258c609719bSwdenkmtest	- simple RAM test
5259c609719bSwdenkicache	- enable or disable instruction cache
5260c609719bSwdenkdcache	- enable or disable data cache
5261c609719bSwdenkreset	- Perform RESET of the CPU
5262c609719bSwdenkecho	- echo args to console
5263c609719bSwdenkversion - print monitor version
5264c609719bSwdenkhelp	- print online help
5265c609719bSwdenk?	- alias for 'help'
5266c609719bSwdenk
5267c609719bSwdenk
5268c609719bSwdenkMonitor Commands - Detailed Description:
5269c609719bSwdenk========================================
5270c609719bSwdenk
5271c609719bSwdenkTODO.
5272c609719bSwdenk
5273c609719bSwdenkFor now: just type "help <command>".
5274c609719bSwdenk
5275c609719bSwdenk
5276c609719bSwdenkEnvironment Variables:
5277c609719bSwdenk======================
5278c609719bSwdenk
5279c609719bSwdenkU-Boot supports user configuration using Environment Variables which
5280c609719bSwdenkcan be made persistent by saving to Flash memory.
5281c609719bSwdenk
5282c609719bSwdenkEnvironment Variables are set using "setenv", printed using
5283c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv"
5284c609719bSwdenkwithout a value can be used to delete a variable from the
5285c609719bSwdenkenvironment. As long as you don't save the environment you are
5286c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the
5287c609719bSwdenkenvironment is erased by accident, a default environment is provided.
5288c609719bSwdenk
5289c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables.
5290c96f86eeSWolfgang Denk
5291c96f86eeSWolfgang DenkList of environment variables (most likely not complete):
5292c609719bSwdenk
5293c609719bSwdenk  baudrate	- see CONFIG_BAUDRATE
5294c609719bSwdenk
5295c609719bSwdenk  bootdelay	- see CONFIG_BOOTDELAY
5296c609719bSwdenk
5297c609719bSwdenk  bootcmd	- see CONFIG_BOOTCOMMAND
5298c609719bSwdenk
5299c609719bSwdenk  bootargs	- Boot arguments when booting an RTOS image
5300c609719bSwdenk
5301c609719bSwdenk  bootfile	- Name of the image to load with TFTP
5302c609719bSwdenk
53037d721e34SBartlomiej Sieka  bootm_low	- Memory range available for image processing in the bootm
53047d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
53057d721e34SBartlomiej Sieka		  a hexadecimal number and defines lowest address allowed
53067d721e34SBartlomiej Sieka		  for use by the bootm command. See also "bootm_size"
53077d721e34SBartlomiej Sieka		  environment variable. Address defined by "bootm_low" is
53087d721e34SBartlomiej Sieka		  also the base of the initial memory mapping for the Linux
5309c3624e6eSGrant Likely		  kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
5310c3624e6eSGrant Likely		  bootm_mapsize.
5311c3624e6eSGrant Likely
5312c3624e6eSGrant Likely  bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
5313c3624e6eSGrant Likely		  This variable is given as a hexadecimal number and it
5314c3624e6eSGrant Likely		  defines the size of the memory region starting at base
5315c3624e6eSGrant Likely		  address bootm_low that is accessible by the Linux kernel
5316c3624e6eSGrant Likely		  during early boot.  If unset, CONFIG_SYS_BOOTMAPSZ is used
5317c3624e6eSGrant Likely		  as the default value if it is defined, and bootm_size is
5318c3624e6eSGrant Likely		  used otherwise.
53197d721e34SBartlomiej Sieka
53207d721e34SBartlomiej Sieka  bootm_size	- Memory range available for image processing in the bootm
53217d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
53227d721e34SBartlomiej Sieka		  a hexadecimal number and defines the size of the region
53237d721e34SBartlomiej Sieka		  allowed for use by the bootm command. See also "bootm_low"
53247d721e34SBartlomiej Sieka		  environment variable.
53257d721e34SBartlomiej Sieka
53264bae9090SBartlomiej Sieka  updatefile	- Location of the software update file on a TFTP server, used
53274bae9090SBartlomiej Sieka		  by the automatic software update feature. Please refer to
53284bae9090SBartlomiej Sieka		  documentation in doc/README.update for more details.
53294bae9090SBartlomiej Sieka
5330c609719bSwdenk  autoload	- if set to "no" (any string beginning with 'n'),
5331c609719bSwdenk		  "bootp" will just load perform a lookup of the
5332c609719bSwdenk		  configuration from the BOOTP server, but not try to
5333c609719bSwdenk		  load any image using TFTP
5334c609719bSwdenk
5335c609719bSwdenk  autostart	- if set to "yes", an image loaded using the "bootp",
5336c609719bSwdenk		  "rarpboot", "tftpboot" or "diskboot" commands will
5337c609719bSwdenk		  be automatically started (by internally calling
5338c609719bSwdenk		  "bootm")
5339c609719bSwdenk
53404a6fd34bSwdenk		  If set to "no", a standalone image passed to the
53414a6fd34bSwdenk		  "bootm" command will be copied to the load address
53424a6fd34bSwdenk		  (and eventually uncompressed), but NOT be started.
53434a6fd34bSwdenk		  This can be used to load and uncompress arbitrary
53444a6fd34bSwdenk		  data.
53454a6fd34bSwdenk
5346a28afca5SDavid A. Long  fdt_high	- if set this restricts the maximum address that the
5347a28afca5SDavid A. Long		  flattened device tree will be copied into upon boot.
5348fa34f6b2SShawn Guo		  For example, if you have a system with 1 GB memory
5349fa34f6b2SShawn Guo		  at physical address 0x10000000, while Linux kernel
5350fa34f6b2SShawn Guo		  only recognizes the first 704 MB as low memory, you
5351fa34f6b2SShawn Guo		  may need to set fdt_high as 0x3C000000 to have the
5352fa34f6b2SShawn Guo		  device tree blob be copied to the maximum address
5353fa34f6b2SShawn Guo		  of the 704 MB low memory, so that Linux kernel can
5354fa34f6b2SShawn Guo		  access it during the boot procedure.
5355fa34f6b2SShawn Guo
5356a28afca5SDavid A. Long		  If this is set to the special value 0xFFFFFFFF then
5357a28afca5SDavid A. Long		  the fdt will not be copied at all on boot.  For this
5358a28afca5SDavid A. Long		  to work it must reside in writable memory, have
5359a28afca5SDavid A. Long		  sufficient padding on the end of it for u-boot to
5360a28afca5SDavid A. Long		  add the information it needs into it, and the memory
5361a28afca5SDavid A. Long		  must be accessible by the kernel.
5362a28afca5SDavid A. Long
5363eea63e05SSimon Glass  fdtcontroladdr- if set this is the address of the control flattened
5364eea63e05SSimon Glass		  device tree used by U-Boot when CONFIG_OF_CONTROL is
5365eea63e05SSimon Glass		  defined.
5366eea63e05SSimon Glass
536717ea1177Swdenk  i2cfast	- (PPC405GP|PPC405EP only)
536817ea1177Swdenk		  if set to 'y' configures Linux I2C driver for fast
536917ea1177Swdenk		  mode (400kHZ). This environment variable is used in
537017ea1177Swdenk		  initialization code. So, for changes to be effective
537117ea1177Swdenk		  it must be saved and board must be reset.
537217ea1177Swdenk
5373c609719bSwdenk  initrd_high	- restrict positioning of initrd images:
5374c609719bSwdenk		  If this variable is not set, initrd images will be
5375c609719bSwdenk		  copied to the highest possible address in RAM; this
5376c609719bSwdenk		  is usually what you want since it allows for
5377c609719bSwdenk		  maximum initrd size. If for some reason you want to
5378c609719bSwdenk		  make sure that the initrd image is loaded below the
53796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		  CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
5380c609719bSwdenk		  variable to a value of "no" or "off" or "0".
5381c609719bSwdenk		  Alternatively, you can set it to a maximum upper
5382c609719bSwdenk		  address to use (U-Boot will still check that it
5383c609719bSwdenk		  does not overwrite the U-Boot stack and data).
5384c609719bSwdenk
5385c609719bSwdenk		  For instance, when you have a system with 16 MB
53867152b1d0Swdenk		  RAM, and want to reserve 4 MB from use by Linux,
5387c609719bSwdenk		  you can do this by adding "mem=12M" to the value of
5388c609719bSwdenk		  the "bootargs" variable. However, now you must make
53897152b1d0Swdenk		  sure that the initrd image is placed in the first
5390c609719bSwdenk		  12 MB as well - this can be done with
5391c609719bSwdenk
5392c609719bSwdenk		  setenv initrd_high 00c00000
5393c609719bSwdenk
539438b99261Swdenk		  If you set initrd_high to 0xFFFFFFFF, this is an
539538b99261Swdenk		  indication to U-Boot that all addresses are legal
539638b99261Swdenk		  for the Linux kernel, including addresses in flash
539738b99261Swdenk		  memory. In this case U-Boot will NOT COPY the
539838b99261Swdenk		  ramdisk at all. This may be useful to reduce the
539938b99261Swdenk		  boot time on your system, but requires that this
540038b99261Swdenk		  feature is supported by your Linux kernel.
540138b99261Swdenk
5402c609719bSwdenk  ipaddr	- IP address; needed for tftpboot command
5403c609719bSwdenk
5404c609719bSwdenk  loadaddr	- Default load address for commands like "bootp",
5405dc7c9a1aSwdenk		  "rarpboot", "tftpboot", "loadb" or "diskboot"
5406c609719bSwdenk
5407c609719bSwdenk  loads_echo	- see CONFIG_LOADS_ECHO
5408c609719bSwdenk
5409c609719bSwdenk  serverip	- TFTP server IP address; needed for tftpboot command
5410c609719bSwdenk
5411c609719bSwdenk  bootretry	- see CONFIG_BOOT_RETRY_TIME
5412c609719bSwdenk
5413c609719bSwdenk  bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
5414c609719bSwdenk
5415c609719bSwdenk  bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
5416c609719bSwdenk
5417e2a53458SMike Frysinger  ethprime	- controls which interface is used first.
5418a3d991bdSwdenk
5419e2a53458SMike Frysinger  ethact	- controls which interface is currently active.
5420e2a53458SMike Frysinger		  For example you can do the following
5421a3d991bdSwdenk
542248690d80SHeiko Schocher		  => setenv ethact FEC
542348690d80SHeiko Schocher		  => ping 192.168.0.1 # traffic sent on FEC
542448690d80SHeiko Schocher		  => setenv ethact SCC
542548690d80SHeiko Schocher		  => ping 10.0.0.1 # traffic sent on SCC
5426a3d991bdSwdenk
5427e1692577SMatthias Fuchs  ethrotate	- When set to "no" U-Boot does not go through all
5428e1692577SMatthias Fuchs		  available network interfaces.
5429e1692577SMatthias Fuchs		  It just stays at the currently selected interface.
5430e1692577SMatthias Fuchs
5431a3d991bdSwdenk  netretry	- When set to "no" each network operation will
5432a3d991bdSwdenk		  either succeed or fail without retrying.
54336e592385Swdenk		  When set to "once" the network operation will
54346e592385Swdenk		  fail when all the available network interfaces
54356e592385Swdenk		  are tried once without success.
5436a3d991bdSwdenk		  Useful on scripts which control the retry operation
5437a3d991bdSwdenk		  themselves.
5438a3d991bdSwdenk
5439b4e2f89dSJean-Christophe PLAGNIOL-VILLARD  npe_ucode	- set load address for the NPE microcode
5440a1cf027aSJean-Christophe PLAGNIOL-VILLARD
54418d51aacdSSimon Glass  silent_linux  - If set then linux will be told to boot silently, by
54428d51aacdSSimon Glass		  changing the console to be empty. If "yes" it will be
54438d51aacdSSimon Glass		  made silent. If "no" it will not be made silent. If
54448d51aacdSSimon Glass		  unset, then it will be made silent if the U-Boot console
54458d51aacdSSimon Glass		  is silent.
54468d51aacdSSimon Glass
544728cb9375SWolfgang Denk  tftpsrcport	- If this is set, the value is used for TFTP's
5448ecb0ccd9SWolfgang Denk		  UDP source port.
5449ecb0ccd9SWolfgang Denk
545028cb9375SWolfgang Denk  tftpdstport	- If this is set, the value is used for TFTP's UDP
545128cb9375SWolfgang Denk		  destination port instead of the Well Know Port 69.
545228cb9375SWolfgang Denk
5453c96f86eeSWolfgang Denk  tftpblocksize - Block size to use for TFTP transfers; if not set,
5454c96f86eeSWolfgang Denk		  we use the TFTP server's default block size
5455c96f86eeSWolfgang Denk
5456c96f86eeSWolfgang Denk  tftptimeout	- Retransmission timeout for TFTP packets (in milli-
5457c96f86eeSWolfgang Denk		  seconds, minimum value is 1000 = 1 second). Defines
5458c96f86eeSWolfgang Denk		  when a packet is considered to be lost so it has to
5459c96f86eeSWolfgang Denk		  be retransmitted. The default is 5000 = 5 seconds.
5460c96f86eeSWolfgang Denk		  Lowering this value may make downloads succeed
5461c96f86eeSWolfgang Denk		  faster in networks with high packet loss rates or
5462c96f86eeSWolfgang Denk		  with unreliable TFTP servers.
5463c96f86eeSWolfgang Denk
5464a3d991bdSwdenk  vlan		- When set to a value < 4095 the traffic over
546511ccc33fSMarcel Ziswiler		  Ethernet is encapsulated/received over 802.1q
5466a3d991bdSwdenk		  VLAN tagged frames.
5467c609719bSwdenk
5468dc0b7b0eSJason HobbsThe following image location variables contain the location of images
5469dc0b7b0eSJason Hobbsused in booting. The "Image" column gives the role of the image and is
5470dc0b7b0eSJason Hobbsnot an environment variable name. The other columns are environment
5471dc0b7b0eSJason Hobbsvariable names. "File Name" gives the name of the file on a TFTP
5472dc0b7b0eSJason Hobbsserver, "RAM Address" gives the location in RAM the image will be
5473dc0b7b0eSJason Hobbsloaded to, and "Flash Location" gives the image's address in NOR
5474dc0b7b0eSJason Hobbsflash or offset in NAND flash.
5475dc0b7b0eSJason Hobbs
5476dc0b7b0eSJason Hobbs*Note* - these variables don't have to be defined for all boards, some
5477dc0b7b0eSJason Hobbsboards currenlty use other variables for these purposes, and some
5478dc0b7b0eSJason Hobbsboards use these variables for other purposes.
5479dc0b7b0eSJason Hobbs
5480dc0b7b0eSJason HobbsImage		    File Name	     RAM Address       Flash Location
5481dc0b7b0eSJason Hobbs-----		    ---------	     -----------       --------------
5482dc0b7b0eSJason Hobbsu-boot		    u-boot	     u-boot_addr_r     u-boot_addr
5483dc0b7b0eSJason HobbsLinux kernel	    bootfile	     kernel_addr_r     kernel_addr
5484dc0b7b0eSJason Hobbsdevice tree blob    fdtfile	     fdt_addr_r	       fdt_addr
5485dc0b7b0eSJason Hobbsramdisk		    ramdiskfile	     ramdisk_addr_r    ramdisk_addr
5486dc0b7b0eSJason Hobbs
5487c609719bSwdenkThe following environment variables may be used and automatically
5488c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"),
5489c609719bSwdenkdepending the information provided by your boot server:
5490c609719bSwdenk
5491c609719bSwdenk  bootfile	- see above
5492c609719bSwdenk  dnsip		- IP address of your Domain Name Server
5493fe389a82Sstroese  dnsip2	- IP address of your secondary Domain Name Server
5494c609719bSwdenk  gatewayip	- IP address of the Gateway (Router) to use
5495c609719bSwdenk  hostname	- Target hostname
5496c609719bSwdenk  ipaddr	- see above
5497c609719bSwdenk  netmask	- Subnet Mask
5498c609719bSwdenk  rootpath	- Pathname of the root filesystem on the NFS server
5499c609719bSwdenk  serverip	- see above
5500c609719bSwdenk
5501c609719bSwdenk
5502c609719bSwdenkThere are two special Environment Variables:
5503c609719bSwdenk
5504c609719bSwdenk  serial#	- contains hardware identification information such
5505c609719bSwdenk		  as type string and/or serial number
5506c609719bSwdenk  ethaddr	- Ethernet address
5507c609719bSwdenk
5508c609719bSwdenkThese variables can be set only once (usually during manufacturing of
5509c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables
5510c609719bSwdenkonce they have been set once.
5511c609719bSwdenk
5512c609719bSwdenk
5513c1551ea8SstroeseFurther special Environment Variables:
5514c1551ea8Sstroese
5515c1551ea8Sstroese  ver		- Contains the U-Boot version string as printed
5516c1551ea8Sstroese		  with the "version" command. This variable is
5517c1551ea8Sstroese		  readonly (see CONFIG_VERSION_VARIABLE).
5518c1551ea8Sstroese
5519c1551ea8Sstroese
5520c609719bSwdenkPlease note that changes to some configuration parameters may take
5521c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-).
5522c609719bSwdenk
5523c609719bSwdenk
5524170ab110SJoe HershbergerCallback functions for environment variables:
5525170ab110SJoe Hershberger---------------------------------------------
5526170ab110SJoe Hershberger
5527170ab110SJoe HershbergerFor some environment variables, the behavior of u-boot needs to change
5528170ab110SJoe Hershbergerwhen their values are changed.  This functionailty allows functions to
5529170ab110SJoe Hershbergerbe associated with arbitrary variables.  On creation, overwrite, or
5530170ab110SJoe Hershbergerdeletion, the callback will provide the opportunity for some side
5531170ab110SJoe Hershbergereffect to happen or for the change to be rejected.
5532170ab110SJoe Hershberger
5533170ab110SJoe HershbergerThe callbacks are named and associated with a function using the
5534170ab110SJoe HershbergerU_BOOT_ENV_CALLBACK macro in your board or driver code.
5535170ab110SJoe Hershberger
5536170ab110SJoe HershbergerThese callbacks are associated with variables in one of two ways.  The
5537170ab110SJoe Hershbergerstatic list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
5538170ab110SJoe Hershbergerin the board configuration to a string that defines a list of
5539170ab110SJoe Hershbergerassociations.  The list must be in the following format:
5540170ab110SJoe Hershberger
5541170ab110SJoe Hershberger	entry = variable_name[:callback_name]
5542170ab110SJoe Hershberger	list = entry[,list]
5543170ab110SJoe Hershberger
5544170ab110SJoe HershbergerIf the callback name is not specified, then the callback is deleted.
5545170ab110SJoe HershbergerSpaces are also allowed anywhere in the list.
5546170ab110SJoe Hershberger
5547170ab110SJoe HershbergerCallbacks can also be associated by defining the ".callbacks" variable
5548170ab110SJoe Hershbergerwith the same list format above.  Any association in ".callbacks" will
5549170ab110SJoe Hershbergeroverride any association in the static list. You can define
5550170ab110SJoe HershbergerCONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
5551170ab110SJoe Hershberger".callbacks" envirnoment variable in the default or embedded environment.
5552170ab110SJoe Hershberger
5553170ab110SJoe Hershberger
5554f07771ccSwdenkCommand Line Parsing:
5555f07771ccSwdenk=====================
5556f07771ccSwdenk
5557f07771ccSwdenkThere are two different command line parsers available with U-Boot:
55587152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell:
5559f07771ccSwdenk
5560f07771ccSwdenkOld, simple command line parser:
5561f07771ccSwdenk--------------------------------
5562f07771ccSwdenk
5563f07771ccSwdenk- supports environment variables (through setenv / saveenv commands)
5564f07771ccSwdenk- several commands on one line, separated by ';'
5565fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax
5566f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\',
5567f07771ccSwdenk  for example:
5568fe126d8bSWolfgang Denk	setenv bootcmd bootm \${address}
5569f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example:
5570f07771ccSwdenk	setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
5571f07771ccSwdenk
5572f07771ccSwdenkHush shell:
5573f07771ccSwdenk-----------
5574f07771ccSwdenk
5575f07771ccSwdenk- similar to Bourne shell, with control structures like
5576f07771ccSwdenk  if...then...else...fi, for...do...done; while...do...done,
5577f07771ccSwdenk  until...do...done, ...
5578f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv
5579f07771ccSwdenk  commands) and local shell variables (through standard shell syntax
5580f07771ccSwdenk  "name=value"); only environment variables can be used with "run"
5581f07771ccSwdenk  command
5582f07771ccSwdenk
5583f07771ccSwdenkGeneral rules:
5584f07771ccSwdenk--------------
5585f07771ccSwdenk
5586f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run"
5587f07771ccSwdenk    command) contains several commands separated by semicolon, and
5588f07771ccSwdenk    one of these commands fails, then the remaining commands will be
5589f07771ccSwdenk    executed anyway.
5590f07771ccSwdenk
5591f07771ccSwdenk(2) If you execute several variables with one call to run (i. e.
559211ccc33fSMarcel Ziswiler    calling run with a list of variables as arguments), any failing
5593f07771ccSwdenk    command will cause "run" to terminate, i. e. the remaining
5594f07771ccSwdenk    variables are not executed.
5595f07771ccSwdenk
5596c609719bSwdenkNote for Redundant Ethernet Interfaces:
5597c609719bSwdenk=======================================
5598c609719bSwdenk
559911ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports
5600c609719bSwdenksuch configurations and is capable of automatic selection of a
56017152b1d0Swdenk"working" interface when needed. MAC assignment works as follows:
5602c609719bSwdenk
5603c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding
5604c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0),
5605c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ...
5606c609719bSwdenk
5607c609719bSwdenkIf the network interface stores some valid MAC address (for instance
5608c609719bSwdenkin SROM), this is used as default address if there is NO correspon-
5609c609719bSwdenkding setting in the environment; if the corresponding environment
5610c609719bSwdenkvariable is set, this overrides the settings in the card; that means:
5611c609719bSwdenk
5612c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the
5613c609719bSwdenk  environment, the SROM's address is used.
5614c609719bSwdenk
5615c609719bSwdenko If there is no valid address in the SROM, and a definition in the
5616c609719bSwdenk  environment exists, then the value from the environment variable is
5617c609719bSwdenk  used.
5618c609719bSwdenk
5619c609719bSwdenko If both the SROM and the environment contain a MAC address, and
5620c609719bSwdenk  both addresses are the same, this MAC address is used.
5621c609719bSwdenk
5622c609719bSwdenko If both the SROM and the environment contain a MAC address, and the
5623c609719bSwdenk  addresses differ, the value from the environment is used and a
5624c609719bSwdenk  warning is printed.
5625c609719bSwdenk
5626c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error
5627c609719bSwdenk  is raised.
5628c609719bSwdenk
5629ecee9324SBen WarrenIf Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
5630ecee9324SBen Warrenwill be programmed into hardware as part of the initialization process.	 This
5631ecee9324SBen Warrenmay be skipped by setting the appropriate 'ethmacskip' environment variable.
5632ecee9324SBen WarrenThe naming convention is as follows:
5633ecee9324SBen Warren"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
5634c609719bSwdenk
5635c609719bSwdenkImage Formats:
5636c609719bSwdenk==============
5637c609719bSwdenk
56383310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on)
56393310c549SMarian Balakowiczimages in two formats:
56403310c549SMarian Balakowicz
56413310c549SMarian BalakowiczNew uImage format (FIT)
56423310c549SMarian Balakowicz-----------------------
56433310c549SMarian Balakowicz
56443310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar
56453310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple
56463310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by
56473310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
56483310c549SMarian Balakowicz
56493310c549SMarian Balakowicz
56503310c549SMarian BalakowiczOld uImage format
56513310c549SMarian Balakowicz-----------------
56523310c549SMarian Balakowicz
56533310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything,
56543310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for
56553310c549SMarian Balakowiczdetails; basically, the header defines the following image properties:
5656c609719bSwdenk
5657c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5658c609719bSwdenk  4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
5659f5ed9e39SPeter Tyser  LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5660f5ed9e39SPeter Tyser  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5661f5ed9e39SPeter Tyser  INTEGRITY).
56627b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
5663afc1ce82SMacpaul Lin  IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5664afc1ce82SMacpaul Lin  Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
5665c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2)
5666c609719bSwdenk* Load Address
5667c609719bSwdenk* Entry Point
5668c609719bSwdenk* Image Name
5669c609719bSwdenk* Image Timestamp
5670c609719bSwdenk
5671c609719bSwdenkThe header is marked by a special Magic Number, and both the header
5672c609719bSwdenkand the data portions of the image are secured against corruption by
5673c609719bSwdenkCRC32 checksums.
5674c609719bSwdenk
5675c609719bSwdenk
5676c609719bSwdenkLinux Support:
5677c609719bSwdenk==============
5678c609719bSwdenk
5679c609719bSwdenkAlthough U-Boot should support any OS or standalone application
56807152b1d0Swdenkeasily, the main focus has always been on Linux during the design of
5681c609719bSwdenkU-Boot.
5682c609719bSwdenk
5683c609719bSwdenkU-Boot includes many features that so far have been part of some
5684c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any
5685c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image;
5686c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation
56877152b1d0Swdenkserves several purposes:
5688c609719bSwdenk
5689c609719bSwdenk- the same features can be used for other OS or standalone
5690c609719bSwdenk  applications (for instance: using compressed images to reduce the
5691c609719bSwdenk  Flash memory footprint)
5692c609719bSwdenk
5693c609719bSwdenk- it becomes much easier to port new Linux kernel versions because
56947152b1d0Swdenk  lots of low-level, hardware dependent stuff are done by U-Boot
5695c609719bSwdenk
5696c609719bSwdenk- the same Linux kernel image can now be used with different "initrd"
5697c609719bSwdenk  images; of course this also means that different kernel images can
5698c609719bSwdenk  be run with the same "initrd". This makes testing easier (you don't
5699c609719bSwdenk  have to build a new "zImage.initrd" Linux image when you just
5700c609719bSwdenk  change a file in your "initrd"). Also, a field-upgrade of the
5701c609719bSwdenk  software is easier now.
5702c609719bSwdenk
5703c609719bSwdenk
5704c609719bSwdenkLinux HOWTO:
5705c609719bSwdenk============
5706c609719bSwdenk
5707c609719bSwdenkPorting Linux to U-Boot based systems:
5708c609719bSwdenk---------------------------------------
5709c609719bSwdenk
5710c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to
5711c609719bSwdenkconfigure the Linux device drivers for use with your target hardware
5712c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to
5713c609719bSwdenkLinux :-).
5714c609719bSwdenk
5715a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
5716c609719bSwdenk
5717c609719bSwdenkJust make sure your machine specific header file (for instance
5718c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board
57191dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h,
57201dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value
57216d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR.
5722c609719bSwdenk
57232eb31b13SSimon GlassNote that U-Boot now has a driver model, a unified model for drivers.
57242eb31b13SSimon GlassIf you are adding a new driver, plumb it into driver model. If there
57252eb31b13SSimon Glassis no uclass available, you are encouraged to create one. See
57262eb31b13SSimon Glassdoc/driver-model.
57272eb31b13SSimon Glass
5728c609719bSwdenk
5729c609719bSwdenkConfiguring the Linux kernel:
5730c609719bSwdenk-----------------------------
5731c609719bSwdenk
5732c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root
5733c609719bSwdenkdevice (initial ramdisk, NFS) for your target system.
5734c609719bSwdenk
5735c609719bSwdenk
5736c609719bSwdenkBuilding a Linux Image:
5737c609719bSwdenk-----------------------
5738c609719bSwdenk
573924ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are
574024ee89b9Swdenknot used. If you use recent kernel source, a new build target
574124ee89b9Swdenk"uImage" will exist which automatically builds an image usable by
574224ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target,
574324ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a
574424ee89b9Swdenk100% compatible format.
5745c609719bSwdenk
5746c609719bSwdenkExample:
5747c609719bSwdenk
5748ab584d67SHolger Freyther	make TQM850L_defconfig
5749c609719bSwdenk	make oldconfig
5750c609719bSwdenk	make dep
575124ee89b9Swdenk	make uImage
5752c609719bSwdenk
575324ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to
575424ee89b9Swdenkencapsulate a compressed Linux kernel image with header	 information,
575524ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing:
5756c609719bSwdenk
575724ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format):
575824ee89b9Swdenk
575924ee89b9Swdenk* convert the kernel into a raw binary image:
576024ee89b9Swdenk
576124ee89b9Swdenk	${CROSS_COMPILE}-objcopy -O binary \
576224ee89b9Swdenk				 -R .note -R .comment \
576324ee89b9Swdenk				 -S vmlinux linux.bin
576424ee89b9Swdenk
576524ee89b9Swdenk* compress the binary image:
576624ee89b9Swdenk
576724ee89b9Swdenk	gzip -9 linux.bin
576824ee89b9Swdenk
576924ee89b9Swdenk* package compressed binary image for U-Boot:
577024ee89b9Swdenk
577124ee89b9Swdenk	mkimage -A ppc -O linux -T kernel -C gzip \
577224ee89b9Swdenk		-a 0 -e 0 -n "Linux Kernel Image" \
577324ee89b9Swdenk		-d linux.bin.gz uImage
577424ee89b9Swdenk
577524ee89b9Swdenk
577624ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use
577724ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or
577824ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64
577924ee89b9Swdenkbyte header containing information about target architecture,
578024ee89b9Swdenkoperating system, image type, compression method, entry points, time
578124ee89b9Swdenkstamp, CRC32 checksums, etc.
578224ee89b9Swdenk
578324ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and
578424ee89b9Swdenkprint the header information, or to build new images.
5785c609719bSwdenk
5786c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information
5787c609719bSwdenkcontained in the header of an existing U-Boot image; this includes
5788c609719bSwdenkchecksum verification:
5789c609719bSwdenk
5790c609719bSwdenk	tools/mkimage -l image
5791c609719bSwdenk	  -l ==> list image header information
5792c609719bSwdenk
5793c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image
5794c609719bSwdenkfrom a "data file" which is used as image payload:
5795c609719bSwdenk
5796c609719bSwdenk	tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5797c609719bSwdenk		      -n name -d data_file image
5798c609719bSwdenk	  -A ==> set architecture to 'arch'
5799c609719bSwdenk	  -O ==> set operating system to 'os'
5800c609719bSwdenk	  -T ==> set image type to 'type'
5801c609719bSwdenk	  -C ==> set compression type 'comp'
5802c609719bSwdenk	  -a ==> set load address to 'addr' (hex)
5803c609719bSwdenk	  -e ==> set entry point to 'ep' (hex)
5804c609719bSwdenk	  -n ==> set image name to 'name'
5805c609719bSwdenk	  -d ==> use image data from 'datafile'
5806c609719bSwdenk
580769459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load
580869459791Swdenkaddress (0x00000000), but the entry point address depends on the
580969459791Swdenkkernel version:
5810c609719bSwdenk
5811c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C,
581224ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000.
5813c609719bSwdenk
5814c609719bSwdenkSo a typical call to build a U-Boot image would read:
5815c609719bSwdenk
581624ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
581724ee89b9Swdenk	> -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
5818a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
581924ee89b9Swdenk	> examples/uImage.TQM850L
582024ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5821c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5822c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
5823c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
5824c609719bSwdenk	Load Address: 0x00000000
582524ee89b9Swdenk	Entry Point:  0x00000000
5826c609719bSwdenk
5827c609719bSwdenkTo verify the contents of the image (or check for corruption):
5828c609719bSwdenk
582924ee89b9Swdenk	-> tools/mkimage -l examples/uImage.TQM850L
583024ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5831c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5832c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
5833c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
5834c609719bSwdenk	Load Address: 0x00000000
583524ee89b9Swdenk	Entry Point:  0x00000000
5836c609719bSwdenk
5837c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade
5838c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this
5839c609719bSwdenkneeds more space in Flash, but boots much faster since it does not
5840c609719bSwdenkneed to be uncompressed:
5841c609719bSwdenk
5842a47a12beSStefan Roese	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
584324ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
584424ee89b9Swdenk	> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
5845a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
584624ee89b9Swdenk	> examples/uImage.TQM850L-uncompressed
584724ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5848c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5849c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (uncompressed)
5850c609719bSwdenk	Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
5851c609719bSwdenk	Load Address: 0x00000000
585224ee89b9Swdenk	Entry Point:  0x00000000
5853c609719bSwdenk
5854c609719bSwdenk
5855c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file
5856c609719bSwdenkwhen your kernel is intended to use an initial ramdisk:
5857c609719bSwdenk
5858c609719bSwdenk	-> tools/mkimage -n 'Simple Ramdisk Image' \
5859c609719bSwdenk	> -A ppc -O linux -T ramdisk -C gzip \
5860c609719bSwdenk	> -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5861c609719bSwdenk	Image Name:   Simple Ramdisk Image
5862c609719bSwdenk	Created:      Wed Jan 12 14:01:50 2000
5863c609719bSwdenk	Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
5864c609719bSwdenk	Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
5865c609719bSwdenk	Load Address: 0x00000000
5866c609719bSwdenk	Entry Point:  0x00000000
5867c609719bSwdenk
5868a804b5ceSGuilherme Maciel FerreiraThe "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5869a804b5ceSGuilherme Maciel Ferreiraoption performs the converse operation of the mkimage's second form (the "-d"
5870a804b5ceSGuilherme Maciel Ferreiraoption). Given an image built by mkimage, the dumpimage extracts a "data file"
5871a804b5ceSGuilherme Maciel Ferreirafrom the image:
5872a804b5ceSGuilherme Maciel Ferreira
5873a804b5ceSGuilherme Maciel Ferreira	tools/dumpimage -i image -p position data_file
5874a804b5ceSGuilherme Maciel Ferreira	  -i ==> extract from the 'image' a specific 'data_file', \
5875a804b5ceSGuilherme Maciel Ferreira	   indexed by 'position'
5876a804b5ceSGuilherme Maciel Ferreira
5877c609719bSwdenk
5878c609719bSwdenkInstalling a Linux Image:
5879c609719bSwdenk-------------------------
5880c609719bSwdenk
5881c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface,
5882c609719bSwdenkyou must convert the image to S-Record format:
5883c609719bSwdenk
5884c609719bSwdenk	objcopy -I binary -O srec examples/image examples/image.srec
5885c609719bSwdenk
5886c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot
5887c609719bSwdenkimage header, so the resulting S-Record file will be relative to
5888c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to
5889c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads'
5890c609719bSwdenkcommand.
5891c609719bSwdenk
5892c609719bSwdenkExample: install the image to address 0x40100000 (which on the
5893c609719bSwdenkTQM8xxL is in the first Flash bank):
5894c609719bSwdenk
5895c609719bSwdenk	=> erase 40100000 401FFFFF
5896c609719bSwdenk
5897c609719bSwdenk	.......... done
5898c609719bSwdenk	Erased 8 sectors
5899c609719bSwdenk
5900c609719bSwdenk	=> loads 40100000
5901c609719bSwdenk	## Ready for S-Record download ...
5902c609719bSwdenk	~>examples/image.srec
5903c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5904c609719bSwdenk	...
5905c609719bSwdenk	15989 15990 15991 15992
5906c609719bSwdenk	[file transfer complete]
5907c609719bSwdenk	[connected]
5908c609719bSwdenk	## Start Addr = 0x00000000
5909c609719bSwdenk
5910c609719bSwdenk
5911c609719bSwdenkYou can check the success of the download using the 'iminfo' command;
5912c609719bSwdenkthis includes a checksum verification so you can be sure no data
5913c609719bSwdenkcorruption happened:
5914c609719bSwdenk
5915c609719bSwdenk	=> imi 40100000
5916c609719bSwdenk
5917c609719bSwdenk	## Checking Image at 40100000 ...
5918c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5919c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5920c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5921c609719bSwdenk	   Load Address: 00000000
5922c609719bSwdenk	   Entry Point:	 0000000c
5923c609719bSwdenk	   Verifying Checksum ... OK
5924c609719bSwdenk
5925c609719bSwdenk
5926c609719bSwdenkBoot Linux:
5927c609719bSwdenk-----------
5928c609719bSwdenk
5929c609719bSwdenkThe "bootm" command is used to boot an application that is stored in
5930c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents
5931c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as
5932c609719bSwdenkparameters. You can check and modify this variable using the
5933c609719bSwdenk"printenv" and "setenv" commands:
5934c609719bSwdenk
5935c609719bSwdenk
5936c609719bSwdenk	=> printenv bootargs
5937c609719bSwdenk	bootargs=root=/dev/ram
5938c609719bSwdenk
5939c609719bSwdenk	=> setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5940c609719bSwdenk
5941c609719bSwdenk	=> printenv bootargs
5942c609719bSwdenk	bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5943c609719bSwdenk
5944c609719bSwdenk	=> bootm 40020000
5945c609719bSwdenk	## Booting Linux kernel at 40020000 ...
5946c609719bSwdenk	   Image Name:	 2.2.13 for NFS on TQM850L
5947c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5948c609719bSwdenk	   Data Size:	 381681 Bytes = 372 kB = 0 MB
5949c609719bSwdenk	   Load Address: 00000000
5950c609719bSwdenk	   Entry Point:	 0000000c
5951c609719bSwdenk	   Verifying Checksum ... OK
5952c609719bSwdenk	   Uncompressing Kernel Image ... OK
5953c609719bSwdenk	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
5954c609719bSwdenk	Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5955c609719bSwdenk	time_init: decrementer frequency = 187500000/60
5956c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
5957c609719bSwdenk	Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5958c609719bSwdenk	...
5959c609719bSwdenk
596011ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass
59617152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT
5962c609719bSwdenkformat!) to the "bootm" command:
5963c609719bSwdenk
5964c609719bSwdenk	=> imi 40100000 40200000
5965c609719bSwdenk
5966c609719bSwdenk	## Checking Image at 40100000 ...
5967c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5968c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5969c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5970c609719bSwdenk	   Load Address: 00000000
5971c609719bSwdenk	   Entry Point:	 0000000c
5972c609719bSwdenk	   Verifying Checksum ... OK
5973c609719bSwdenk
5974c609719bSwdenk	## Checking Image at 40200000 ...
5975c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
5976c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
5977c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
5978c609719bSwdenk	   Load Address: 00000000
5979c609719bSwdenk	   Entry Point:	 00000000
5980c609719bSwdenk	   Verifying Checksum ... OK
5981c609719bSwdenk
5982c609719bSwdenk	=> bootm 40100000 40200000
5983c609719bSwdenk	## Booting Linux kernel at 40100000 ...
5984c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5985c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5986c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5987c609719bSwdenk	   Load Address: 00000000
5988c609719bSwdenk	   Entry Point:	 0000000c
5989c609719bSwdenk	   Verifying Checksum ... OK
5990c609719bSwdenk	   Uncompressing Kernel Image ... OK
5991c609719bSwdenk	## Loading RAMDisk Image at 40200000 ...
5992c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
5993c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
5994c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
5995c609719bSwdenk	   Load Address: 00000000
5996c609719bSwdenk	   Entry Point:	 00000000
5997c609719bSwdenk	   Verifying Checksum ... OK
5998c609719bSwdenk	   Loading Ramdisk ... OK
5999c609719bSwdenk	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
6000c609719bSwdenk	Boot arguments: root=/dev/ram
6001c609719bSwdenk	time_init: decrementer frequency = 187500000/60
6002c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
6003c609719bSwdenk	...
6004c609719bSwdenk	RAMDISK: Compressed image found at block 0
6005c609719bSwdenk	VFS: Mounted root (ext2 filesystem).
6006c609719bSwdenk
6007c609719bSwdenk	bash#
6008c609719bSwdenk
60090267768eSMatthew McClintockBoot Linux and pass a flat device tree:
60100267768eSMatthew McClintock-----------
60110267768eSMatthew McClintock
60120267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section
60130267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The
60140267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated
60150267768eSMatthew McClintockflat device tree:
60160267768eSMatthew McClintock
60170267768eSMatthew McClintock=> print oftaddr
60180267768eSMatthew McClintockoftaddr=0x300000
60190267768eSMatthew McClintock=> print oft
60200267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb
60210267768eSMatthew McClintock=> tftp $oftaddr $oft
60220267768eSMatthew McClintockSpeed: 1000, full duplex
60230267768eSMatthew McClintockUsing TSEC0 device
60240267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101
60250267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'.
60260267768eSMatthew McClintockLoad address: 0x300000
60270267768eSMatthew McClintockLoading: #
60280267768eSMatthew McClintockdone
60290267768eSMatthew McClintockBytes transferred = 4106 (100a hex)
60300267768eSMatthew McClintock=> tftp $loadaddr $bootfile
60310267768eSMatthew McClintockSpeed: 1000, full duplex
60320267768eSMatthew McClintockUsing TSEC0 device
60330267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2
60340267768eSMatthew McClintockFilename 'uImage'.
60350267768eSMatthew McClintockLoad address: 0x200000
60360267768eSMatthew McClintockLoading:############
60370267768eSMatthew McClintockdone
60380267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex)
60390267768eSMatthew McClintock=> print loadaddr
60400267768eSMatthew McClintockloadaddr=200000
60410267768eSMatthew McClintock=> print oftaddr
60420267768eSMatthew McClintockoftaddr=0x300000
60430267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr
60440267768eSMatthew McClintock## Booting image at 00200000 ...
60450267768eSMatthew McClintock   Image Name:	 Linux-2.6.17-dirty
60460267768eSMatthew McClintock   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
60470267768eSMatthew McClintock   Data Size:	 1029343 Bytes = 1005.2 kB
60480267768eSMatthew McClintock   Load Address: 00000000
60490267768eSMatthew McClintock   Entry Point:	 00000000
60500267768eSMatthew McClintock   Verifying Checksum ... OK
60510267768eSMatthew McClintock   Uncompressing Kernel Image ... OK
60520267768eSMatthew McClintockBooting using flat device tree at 0x300000
60530267768eSMatthew McClintockUsing MPC85xx ADS machine description
60540267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
60550267768eSMatthew McClintock[snip]
60560267768eSMatthew McClintock
60570267768eSMatthew McClintock
60586069ff26SwdenkMore About U-Boot Image Types:
60596069ff26Swdenk------------------------------
60606069ff26Swdenk
60616069ff26SwdenkU-Boot supports the following image types:
60626069ff26Swdenk
60636069ff26Swdenk   "Standalone Programs" are directly runnable in the environment
60646069ff26Swdenk	provided by U-Boot; it is expected that (if they behave
60656069ff26Swdenk	well) you can continue to work in U-Boot after return from
60666069ff26Swdenk	the Standalone Program.
60676069ff26Swdenk   "OS Kernel Images" are usually images of some Embedded OS which
60686069ff26Swdenk	will take over control completely. Usually these programs
60696069ff26Swdenk	will install their own set of exception handlers, device
60706069ff26Swdenk	drivers, set up the MMU, etc. - this means, that you cannot
60716069ff26Swdenk	expect to re-enter U-Boot except by resetting the CPU.
60726069ff26Swdenk   "RAMDisk Images" are more or less just data blocks, and their
60736069ff26Swdenk	parameters (address, size) are passed to an OS kernel that is
60746069ff26Swdenk	being started.
60756069ff26Swdenk   "Multi-File Images" contain several images, typically an OS
60766069ff26Swdenk	(Linux) kernel image and one or more data images like
60776069ff26Swdenk	RAMDisks. This construct is useful for instance when you want
60786069ff26Swdenk	to boot over the network using BOOTP etc., where the boot
60796069ff26Swdenk	server provides just a single image file, but you want to get
60806069ff26Swdenk	for instance an OS kernel and a RAMDisk image.
60816069ff26Swdenk
60826069ff26Swdenk	"Multi-File Images" start with a list of image sizes, each
60836069ff26Swdenk	image size (in bytes) specified by an "uint32_t" in network
60846069ff26Swdenk	byte order. This list is terminated by an "(uint32_t)0".
60856069ff26Swdenk	Immediately after the terminating 0 follow the images, one by
60866069ff26Swdenk	one, all aligned on "uint32_t" boundaries (size rounded up to
60876069ff26Swdenk	a multiple of 4 bytes).
60886069ff26Swdenk
60896069ff26Swdenk   "Firmware Images" are binary images containing firmware (like
60906069ff26Swdenk	U-Boot or FPGA images) which usually will be programmed to
60916069ff26Swdenk	flash memory.
60926069ff26Swdenk
60936069ff26Swdenk   "Script files" are command sequences that will be executed by
60946069ff26Swdenk	U-Boot's command interpreter; this feature is especially
60956069ff26Swdenk	useful when you configure U-Boot to use a real shell (hush)
60966069ff26Swdenk	as command interpreter.
60976069ff26Swdenk
609844f074c7SMarek VasutBooting the Linux zImage:
609944f074c7SMarek Vasut-------------------------
610044f074c7SMarek Vasut
610144f074c7SMarek VasutOn some platforms, it's possible to boot Linux zImage. This is done
610244f074c7SMarek Vasutusing the "bootz" command. The syntax of "bootz" command is the same
610344f074c7SMarek Vasutas the syntax of "bootm" command.
610444f074c7SMarek Vasut
61058ac28563STom RiniNote, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
6106017e1f3fSMarek Vasutkernel with raw initrd images. The syntax is slightly different, the
6107017e1f3fSMarek Vasutaddress of the initrd must be augmented by it's size, in the following
6108017e1f3fSMarek Vasutformat: "<initrd addres>:<initrd size>".
6109017e1f3fSMarek Vasut
6110c609719bSwdenk
6111c609719bSwdenkStandalone HOWTO:
6112c609719bSwdenk=================
6113c609719bSwdenk
6114c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and
6115c609719bSwdenkrun "standalone" applications, which can use some resources of
6116c609719bSwdenkU-Boot like console I/O functions or interrupt services.
6117c609719bSwdenk
6118c609719bSwdenkTwo simple examples are included with the sources:
6119c609719bSwdenk
6120c609719bSwdenk"Hello World" Demo:
6121c609719bSwdenk-------------------
6122c609719bSwdenk
6123c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo
6124c609719bSwdenkapplication; it is automatically compiled when you build U-Boot.
6125c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it
6126c609719bSwdenklike that:
6127c609719bSwdenk
6128c609719bSwdenk	=> loads
6129c609719bSwdenk	## Ready for S-Record download ...
6130c609719bSwdenk	~>examples/hello_world.srec
6131c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
6132c609719bSwdenk	[file transfer complete]
6133c609719bSwdenk	[connected]
6134c609719bSwdenk	## Start Addr = 0x00040004
6135c609719bSwdenk
6136c609719bSwdenk	=> go 40004 Hello World! This is a test.
6137c609719bSwdenk	## Starting application at 0x00040004 ...
6138c609719bSwdenk	Hello World
6139c609719bSwdenk	argc = 7
6140c609719bSwdenk	argv[0] = "40004"
6141c609719bSwdenk	argv[1] = "Hello"
6142c609719bSwdenk	argv[2] = "World!"
6143c609719bSwdenk	argv[3] = "This"
6144c609719bSwdenk	argv[4] = "is"
6145c609719bSwdenk	argv[5] = "a"
6146c609719bSwdenk	argv[6] = "test."
6147c609719bSwdenk	argv[7] = "<NULL>"
6148c609719bSwdenk	Hit any key to exit ...
6149c609719bSwdenk
6150c609719bSwdenk	## Application terminated, rc = 0x0
6151c609719bSwdenk
6152c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt
6153c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'.
6154c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second.
6155c609719bSwdenkThe interrupt service routine is trivial, just printing a '.'
6156c609719bSwdenkcharacter, but this is just a demo program. The application can be
6157c609719bSwdenkcontrolled by the following keys:
6158c609719bSwdenk
6159c609719bSwdenk	? - print current values og the CPM Timer registers
6160c609719bSwdenk	b - enable interrupts and start timer
6161c609719bSwdenk	e - stop timer and disable interrupts
6162c609719bSwdenk	q - quit application
6163c609719bSwdenk
6164c609719bSwdenk	=> loads
6165c609719bSwdenk	## Ready for S-Record download ...
6166c609719bSwdenk	~>examples/timer.srec
6167c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
6168c609719bSwdenk	[file transfer complete]
6169c609719bSwdenk	[connected]
6170c609719bSwdenk	## Start Addr = 0x00040004
6171c609719bSwdenk
6172c609719bSwdenk	=> go 40004
6173c609719bSwdenk	## Starting application at 0x00040004 ...
6174c609719bSwdenk	TIMERS=0xfff00980
6175c609719bSwdenk	Using timer 1
6176c609719bSwdenk	  tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
6177c609719bSwdenk
6178c609719bSwdenkHit 'b':
6179c609719bSwdenk	[q, b, e, ?] Set interval 1000000 us
6180c609719bSwdenk	Enabling timer
6181c609719bSwdenkHit '?':
6182c609719bSwdenk	[q, b, e, ?] ........
6183c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
6184c609719bSwdenkHit '?':
6185c609719bSwdenk	[q, b, e, ?] .
6186c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
6187c609719bSwdenkHit '?':
6188c609719bSwdenk	[q, b, e, ?] .
6189c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
6190c609719bSwdenkHit '?':
6191c609719bSwdenk	[q, b, e, ?] .
6192c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
6193c609719bSwdenkHit 'e':
6194c609719bSwdenk	[q, b, e, ?] ...Stopping timer
6195c609719bSwdenkHit 'q':
6196c609719bSwdenk	[q, b, e, ?] ## Application terminated, rc = 0x0
6197c609719bSwdenk
6198c609719bSwdenk
619985ec0bccSwdenkMinicom warning:
620085ec0bccSwdenk================
620185ec0bccSwdenk
62027152b1d0SwdenkOver time, many people have reported problems when trying to use the
620385ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd)
620485ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under
6205f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and
620685ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and
6207e53515a2SKarl O. Pincuse "cu" for S-Record download ("loads" command).  See
6208e53515a2SKarl O. Pinchttp://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
6209e53515a2SKarl O. Pincfor help with kermit.
6210e53515a2SKarl O. Pinc
621185ec0bccSwdenk
621252f52c14SwdenkNevertheless, if you absolutely want to use it try adding this
621352f52c14Swdenkconfiguration to your "File transfer protocols" section:
621452f52c14Swdenk
621552f52c14Swdenk	   Name	   Program			Name U/D FullScr IO-Red. Multi
621652f52c14Swdenk	X  kermit  /usr/bin/kermit -i -l %l -s	 Y    U	   Y	   N	  N
621752f52c14Swdenk	Y  kermit  /usr/bin/kermit -i -l %l -r	 N    D	   Y	   N	  N
621852f52c14Swdenk
621952f52c14Swdenk
6220c609719bSwdenkNetBSD Notes:
6221c609719bSwdenk=============
6222c609719bSwdenk
6223c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host
6224c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx).
6225c609719bSwdenk
6226c609719bSwdenkBuilding requires a cross environment; it is known to work on
6227c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
6228c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make).
6229c609719bSwdenkNote that the cross-powerpc package does not install include files;
6230c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is
6231c609719bSwdenkmissing.  This file has to be installed and patched manually:
6232c609719bSwdenk
6233c609719bSwdenk	# cd /usr/pkg/cross/powerpc-netbsd/include
6234c609719bSwdenk	# mkdir powerpc
6235c609719bSwdenk	# ln -s powerpc machine
6236c609719bSwdenk	# cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
6237c609719bSwdenk	# ${EDIT} powerpc/ansi.h	## must remove __va_list, _BSD_VA_LIST
6238c609719bSwdenk
6239c609719bSwdenkNative builds *don't* work due to incompatibilities between native
6240c609719bSwdenkand U-Boot include files.
6241c609719bSwdenk
6242c609719bSwdenkBooting assumes that (the first part of) the image booted is a
6243c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel
6244c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source
6245c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
62462a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
6247c609719bSwdenk
6248c609719bSwdenk
6249c609719bSwdenkImplementation Internals:
6250c609719bSwdenk=========================
6251c609719bSwdenk
6252c609719bSwdenkThe following is not intended to be a complete description of every
6253c609719bSwdenkimplementation detail. However, it should help to understand the
6254c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom
6255c609719bSwdenkhardware.
6256c609719bSwdenk
6257c609719bSwdenk
6258c609719bSwdenkInitial Stack, Global Data:
6259c609719bSwdenk---------------------------
6260c609719bSwdenk
6261c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot
6262c609719bSwdenkstarts running out of ROM (flash memory), usually without access to
6263c609719bSwdenksystem RAM (because the memory controller is not initialized yet).
6264c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS
6265c609719bSwdenkis not initialized as zero. To be able to get a C environment working
6266c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation
6267c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU
6268c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and
6269c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be
6270c609719bSwdenklocked as (mis-) used as memory, etc.
6271c609719bSwdenk
62727152b1d0Swdenk	Chris Hallinan posted a good summary of these issues to the
62730668236bSWolfgang Denk	U-Boot mailing list:
627443d9616cSwdenk
627543d9616cSwdenk	Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
627643d9616cSwdenk	From: "Chris Hallinan" <clh@net1plus.com>
627743d9616cSwdenk	Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
627843d9616cSwdenk	...
627943d9616cSwdenk
628043d9616cSwdenk	Correct me if I'm wrong, folks, but the way I understand it
628143d9616cSwdenk	is this: Using DCACHE as initial RAM for Stack, etc, does not
628243d9616cSwdenk	require any physical RAM backing up the cache. The cleverness
628343d9616cSwdenk	is that the cache is being used as a temporary supply of
628443d9616cSwdenk	necessary storage before the SDRAM controller is setup. It's
628511ccc33fSMarcel Ziswiler	beyond the scope of this list to explain the details, but you
628643d9616cSwdenk	can see how this works by studying the cache architecture and
628743d9616cSwdenk	operation in the architecture and processor-specific manuals.
628843d9616cSwdenk
628943d9616cSwdenk	OCM is On Chip Memory, which I believe the 405GP has 4K. It
629043d9616cSwdenk	is another option for the system designer to use as an
629111ccc33fSMarcel Ziswiler	initial stack/RAM area prior to SDRAM being available. Either
629243d9616cSwdenk	option should work for you. Using CS 4 should be fine if your
629343d9616cSwdenk	board designers haven't used it for something that would
629443d9616cSwdenk	cause you grief during the initial boot! It is frequently not
629543d9616cSwdenk	used.
629643d9616cSwdenk
62976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
629843d9616cSwdenk	with your processor/board/system design. The default value
629943d9616cSwdenk	you will find in any recent u-boot distribution in
63008a316c9bSStefan Roese	walnut.h should work for you. I'd set it to a value larger
630143d9616cSwdenk	than your SDRAM module. If you have a 64MB SDRAM module, set
630243d9616cSwdenk	it above 400_0000. Just make sure your board has no resources
630343d9616cSwdenk	that are supposed to respond to that address! That code in
630443d9616cSwdenk	start.S has been around a while and should work as is when
630543d9616cSwdenk	you get the config right.
630643d9616cSwdenk
630743d9616cSwdenk	-Chris Hallinan
630843d9616cSwdenk	DS4.COM, Inc.
630943d9616cSwdenk
6310c609719bSwdenkIt is essential to remember this, since it has some impact on the C
6311c609719bSwdenkcode for the initialization procedures:
6312c609719bSwdenk
6313c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt
6314c609719bSwdenk  to write it.
6315c609719bSwdenk
631611ccc33fSMarcel Ziswiler* Do not use any uninitialized global data (or implicitely initialized
6317c609719bSwdenk  as zero data - BSS segment) at all - this is undefined, initiali-
63187152b1d0Swdenk  zation is performed later (when relocating to RAM).
6319c609719bSwdenk
6320c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like
6321c609719bSwdenk  that.
6322c609719bSwdenk
6323c609719bSwdenkHaving only the stack as writable memory limits means we cannot use
6324c609719bSwdenknormal global data to share information beween the code. But it
6325c609719bSwdenkturned out that the implementation of U-Boot can be greatly
6326c609719bSwdenksimplified by making a global data structure (gd_t) available to all
6327c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_
6328c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of
6329c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we
6330c609719bSwdenkplace a pointer (gd) to the global data into a register which we
6331c609719bSwdenkreserve for this purpose.
6332c609719bSwdenk
63337152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the
6334c609719bSwdenkrelevant  (E)ABI  specifications for the current architecture, and by
6335c609719bSwdenkGCC's implementation.
6336c609719bSwdenk
6337c609719bSwdenkFor PowerPC, the following registers have specific use:
6338c609719bSwdenk	R1:	stack pointer
6339e7670f6cSWolfgang Denk	R2:	reserved for system use
6340c609719bSwdenk	R3-R4:	parameter passing and return values
6341c609719bSwdenk	R5-R10: parameter passing
6342c609719bSwdenk	R13:	small data area pointer
6343c609719bSwdenk	R30:	GOT pointer
6344c609719bSwdenk	R31:	frame pointer
6345c609719bSwdenk
6346e6bee808SJoakim Tjernlund	(U-Boot also uses R12 as internal GOT pointer. r12
6347e6bee808SJoakim Tjernlund	is a volatile register so r12 needs to be reset when
6348e6bee808SJoakim Tjernlund	going back and forth between asm and C)
6349c609719bSwdenk
6350e7670f6cSWolfgang Denk    ==> U-Boot will use R2 to hold a pointer to the global data
6351c609719bSwdenk
6352c609719bSwdenk    Note: on PPC, we could use a static initializer (since the
6353c609719bSwdenk    address of the global data structure is known at compile time),
6354c609719bSwdenk    but it turned out that reserving a register results in somewhat
6355c609719bSwdenk    smaller code - although the code savings are not that big (on
6356c609719bSwdenk    average for all boards 752 bytes for the whole U-Boot image,
6357c609719bSwdenk    624 text + 127 data).
6358c609719bSwdenk
6359c4db335cSRobin GetzOn Blackfin, the normal C ABI (except for P3) is followed as documented here:
63604c58eb55SMike Frysinger	http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
63614c58eb55SMike Frysinger
6362c4db335cSRobin Getz    ==> U-Boot will use P3 to hold a pointer to the global data
63634c58eb55SMike Frysinger
6364c609719bSwdenkOn ARM, the following registers are used:
6365c609719bSwdenk
6366c609719bSwdenk	R0:	function argument word/integer result
6367c609719bSwdenk	R1-R3:	function argument word
636812eba1b4SJeroen Hofstee	R9:	platform specific
636912eba1b4SJeroen Hofstee	R10:	stack limit (used only if stack checking is enabled)
6370c609719bSwdenk	R11:	argument (frame) pointer
6371c609719bSwdenk	R12:	temporary workspace
6372c609719bSwdenk	R13:	stack pointer
6373c609719bSwdenk	R14:	link register
6374c609719bSwdenk	R15:	program counter
6375c609719bSwdenk
637612eba1b4SJeroen Hofstee    ==> U-Boot will use R9 to hold a pointer to the global data
637712eba1b4SJeroen Hofstee
637812eba1b4SJeroen Hofstee    Note: on ARM, only R_ARM_RELATIVE relocations are supported.
6379c609719bSwdenk
63800df01fd3SThomas ChouOn Nios II, the ABI is documented here:
63810df01fd3SThomas Chou	http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
63820df01fd3SThomas Chou
63830df01fd3SThomas Chou    ==> U-Boot will use gp to hold a pointer to the global data
63840df01fd3SThomas Chou
63850df01fd3SThomas Chou    Note: on Nios II, we give "-G0" option to gcc and don't use gp
63860df01fd3SThomas Chou    to access small data sections, so gp is free.
63870df01fd3SThomas Chou
6388afc1ce82SMacpaul LinOn NDS32, the following registers are used:
6389afc1ce82SMacpaul Lin
6390afc1ce82SMacpaul Lin	R0-R1:	argument/return
6391afc1ce82SMacpaul Lin	R2-R5:	argument
6392afc1ce82SMacpaul Lin	R15:	temporary register for assembler
6393afc1ce82SMacpaul Lin	R16:	trampoline register
6394afc1ce82SMacpaul Lin	R28:	frame pointer (FP)
6395afc1ce82SMacpaul Lin	R29:	global pointer (GP)
6396afc1ce82SMacpaul Lin	R30:	link register (LP)
6397afc1ce82SMacpaul Lin	R31:	stack pointer (SP)
6398afc1ce82SMacpaul Lin	PC:	program counter (PC)
6399afc1ce82SMacpaul Lin
6400afc1ce82SMacpaul Lin    ==> U-Boot will use R10 to hold a pointer to the global data
6401afc1ce82SMacpaul Lin
6402d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
6403d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much.
6404c609719bSwdenk
6405c609719bSwdenkMemory Management:
6406c609719bSwdenk------------------
6407c609719bSwdenk
6408c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the
6409c609719bSwdenkMMU is not used either for address mapping nor for memory protection.
6410c609719bSwdenk
6411c609719bSwdenkThe available memory is mapped to fixed addresses using the memory
6412c609719bSwdenkcontroller. In this process, a contiguous block is formed for each
6413c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several
6414c609719bSwdenkphysical memory banks.
6415c609719bSwdenk
6416c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on
6417c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
6418c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself
6419c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some
64206d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
6421c609719bSwdenkconfiguration setting]. Below that, a structure with global Board
6422c609719bSwdenkInfo data is placed, followed by the stack (growing downward).
6423c609719bSwdenk
6424c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB
6425c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF).
6426c609719bSwdenk
6427c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like
6428c609719bSwdenkthis:
6429c609719bSwdenk
6430c609719bSwdenk	0x0000 0000	Exception Vector code
6431c609719bSwdenk	      :
6432c609719bSwdenk	0x0000 1FFF
6433c609719bSwdenk	0x0000 2000	Free for Application Use
6434c609719bSwdenk	      :
6435c609719bSwdenk	      :
6436c609719bSwdenk
6437c609719bSwdenk	      :
6438c609719bSwdenk	      :
6439c609719bSwdenk	0x00FB FF20	Monitor Stack (Growing downward)
6440c609719bSwdenk	0x00FB FFAC	Board Info Data and permanent copy of global data
6441c609719bSwdenk	0x00FC 0000	Malloc Arena
6442c609719bSwdenk	      :
6443c609719bSwdenk	0x00FD FFFF
6444c609719bSwdenk	0x00FE 0000	RAM Copy of Monitor Code
6445c609719bSwdenk	...		eventually: LCD or video framebuffer
6446c609719bSwdenk	...		eventually: pRAM (Protected RAM - unchanged by reset)
6447c609719bSwdenk	0x00FF FFFF	[End of RAM]
6448c609719bSwdenk
6449c609719bSwdenk
6450c609719bSwdenkSystem Initialization:
6451c609719bSwdenk----------------------
6452c609719bSwdenk
6453c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point
645411ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset
6455c609719bSwdenkconfiguration for CS0# this is a mirror of the onboard Flash memory.
64567152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address.
6457c609719bSwdenkTo be able to implement the initialization code in C, a (small!)
6458c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs
6459c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked
6460c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core,
6461c609719bSwdenkthe caches and the SIU.
6462c609719bSwdenk
6463c609719bSwdenkNext, all (potentially) available memory banks are mapped using a
6464c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries
6465c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
6466c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
6467c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a
6468c609719bSwdenksimple memory test is run that determines the size of the SDRAM
6469c609719bSwdenkbanks.
6470c609719bSwdenk
6471c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of
64727152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first
6473c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address
6474c609719bSwdenk0x00000000, with any additional banks following immediately to create
6475c609719bSwdenkcontiguous memory starting from 0.
6476c609719bSwdenk
6477c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area
6478c609719bSwdenkand allocates memory for use by malloc() and for the global Board
6479c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM
6480c609719bSwdenkpages, and the final stack is set up.
6481c609719bSwdenk
6482c609719bSwdenkOnly after this relocation will you have a "normal" C environment;
6483c609719bSwdenkuntil that you are restricted in several ways, mostly because you are
6484c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a
6485c609719bSwdenknew address in RAM.
6486c609719bSwdenk
6487c609719bSwdenk
6488c609719bSwdenkU-Boot Porting Guide:
6489c609719bSwdenk----------------------
6490c609719bSwdenk
6491c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
64926aff3115Swdenklist, October 2002]
6493c609719bSwdenk
6494c609719bSwdenk
6495c609719bSwdenkint main(int argc, char *argv[])
6496c609719bSwdenk{
6497c609719bSwdenk	sighandler_t no_more_time;
6498c609719bSwdenk
6499c609719bSwdenk	signal(SIGALRM, no_more_time);
6500c609719bSwdenk	alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
6501c609719bSwdenk
6502c609719bSwdenk	if (available_money > available_manpower) {
65036c3fef28SJerry Van Baren		Pay consultant to port U-Boot;
6504c609719bSwdenk		return 0;
6505c609719bSwdenk	}
6506c609719bSwdenk
6507c609719bSwdenk	Download latest U-Boot source;
6508c609719bSwdenk
65090668236bSWolfgang Denk	Subscribe to u-boot mailing list;
65106aff3115Swdenk
65116c3fef28SJerry Van Baren	if (clueless)
6512c609719bSwdenk		email("Hi, I am new to U-Boot, how do I get started?");
6513c609719bSwdenk
6514c609719bSwdenk	while (learning) {
6515c609719bSwdenk		Read the README file in the top level directory;
65167cb22f97Swdenk		Read http://www.denx.de/twiki/bin/view/DULG/Manual;
65176c3fef28SJerry Van Baren		Read applicable doc/*.README;
6518c609719bSwdenk		Read the source, Luke;
65196c3fef28SJerry Van Baren		/* find . -name "*.[chS]" | xargs grep -i <keyword> */
6520c609719bSwdenk	}
6521c609719bSwdenk
65226c3fef28SJerry Van Baren	if (available_money > toLocalCurrency ($2500))
65236c3fef28SJerry Van Baren		Buy a BDI3000;
65246c3fef28SJerry Van Baren	else
6525c609719bSwdenk		Add a lot of aggravation and time;
6526c609719bSwdenk
65276c3fef28SJerry Van Baren	if (a similar board exists) {	/* hopefully... */
65286c3fef28SJerry Van Baren		cp -a board/<similar> board/<myboard>
65296c3fef28SJerry Van Baren		cp include/configs/<similar>.h include/configs/<myboard>.h
65306c3fef28SJerry Van Baren	} else {
6531c609719bSwdenk		Create your own board support subdirectory;
65326c3fef28SJerry Van Baren		Create your own board include/configs/<myboard>.h file;
65336c3fef28SJerry Van Baren	}
65346c3fef28SJerry Van Baren	Edit new board/<myboard> files
65356c3fef28SJerry Van Baren	Edit new include/configs/<myboard>.h
6536c609719bSwdenk
65376c3fef28SJerry Van Baren	while (!accepted) {
6538c609719bSwdenk		while (!running) {
6539c609719bSwdenk			do {
6540c609719bSwdenk				Add / modify source code;
6541c609719bSwdenk			} until (compiles);
6542c609719bSwdenk			Debug;
6543c609719bSwdenk			if (clueless)
6544c609719bSwdenk				email("Hi, I am having problems...");
6545c609719bSwdenk		}
65466c3fef28SJerry Van Baren		Send patch file to the U-Boot email list;
65476c3fef28SJerry Van Baren		if (reasonable critiques)
65486c3fef28SJerry Van Baren			Incorporate improvements from email list code review;
65496c3fef28SJerry Van Baren		else
65506c3fef28SJerry Van Baren			Defend code as written;
65516c3fef28SJerry Van Baren	}
6552c609719bSwdenk
6553c609719bSwdenk	return 0;
6554c609719bSwdenk}
6555c609719bSwdenk
6556c609719bSwdenkvoid no_more_time (int sig)
6557c609719bSwdenk{
6558c609719bSwdenk      hire_a_guru();
6559c609719bSwdenk}
6560c609719bSwdenk
6561c609719bSwdenk
6562c609719bSwdenkCoding Standards:
6563c609719bSwdenk-----------------
6564c609719bSwdenk
6565c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel
65662c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script
65677ca9296eSWolfgang Denk"scripts/Lindent" in your Linux kernel source directory.
6568c609719bSwdenk
65692c051651SDetlev ZundelSource files originating from a different project (for example the
65702c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not
65712c051651SDetlev Zundelreformated to ease subsequent migration to newer versions of those
65722c051651SDetlev Zundelsources.
65732c051651SDetlev Zundel
65742c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in
65752c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//)
65762c051651SDetlev Zundelin your code.
6577c609719bSwdenk
6578c178d3daSwdenkPlease also stick to the following formatting rules:
6579180d3f74Swdenk- remove any trailing white space
65807ca9296eSWolfgang Denk- use TAB characters for indentation and vertical alignment, not spaces
6581180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds
65827ca9296eSWolfgang Denk- do not add more than 2 consecutive empty lines to source files
6583180d3f74Swdenk- do not add trailing empty lines to source files
6584180d3f74Swdenk
6585c609719bSwdenkSubmissions which do not conform to the standards may be returned
6586c609719bSwdenkwith a request to reformat the changes.
6587c609719bSwdenk
6588c609719bSwdenk
6589c609719bSwdenkSubmitting Patches:
6590c609719bSwdenk-------------------
6591c609719bSwdenk
6592c609719bSwdenkSince the number of patches for U-Boot is growing, we need to
6593c609719bSwdenkestablish some rules. Submissions which do not conform to these rules
6594c609719bSwdenkmay be rejected, even when they contain important and valuable stuff.
6595c609719bSwdenk
65960d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details.
6597218ca724SWolfgang Denk
65980668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
65990668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot
66000668236bSWolfgang Denk
6601c609719bSwdenkWhen you send a patch, please include the following information with
6602c609719bSwdenkit:
6603c609719bSwdenk
6604c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes
6605c609719bSwdenk  this bug. Please try to include a way of demonstrating that the
6606c609719bSwdenk  patch actually fixes something.
6607c609719bSwdenk
6608c609719bSwdenk* For new features: a description of the feature and your
6609c609719bSwdenk  implementation.
6610c609719bSwdenk
6611c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch)
6612c609719bSwdenk
6613c609719bSwdenk* For major contributions, your entry to the CREDITS file
6614c609719bSwdenk
661527af930eSAlbert ARIBAUD* When you add support for a new board, don't forget to add a
661627af930eSAlbert ARIBAUD  maintainer e-mail address to the boards.cfg file, too.
6617c609719bSwdenk
6618c609719bSwdenk* If your patch adds new configuration options, don't forget to
6619c609719bSwdenk  document these in the README file.
6620c609719bSwdenk
6621218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly*
6622218ca724SWolfgang Denk  recommended) you can easily generate the patch using the
66237ca9296eSWolfgang Denk  "git format-patch". If you then use "git send-email" to send it to
6624218ca724SWolfgang Denk  the U-Boot mailing list, you will avoid most of the common problems
6625218ca724SWolfgang Denk  with some other mail clients.
6626c609719bSwdenk
6627218ca724SWolfgang Denk  If you cannot use git, use "diff -purN OLD NEW". If your version of
6628218ca724SWolfgang Denk  diff does not support these options, then get the latest version of
6629218ca724SWolfgang Denk  GNU diff.
66306dff5529Swdenk
6631218ca724SWolfgang Denk  The current directory when running this command shall be the parent
6632218ca724SWolfgang Denk  directory of the U-Boot source tree (i. e. please make sure that
6633218ca724SWolfgang Denk  your patch includes sufficient directory information for the
6634218ca724SWolfgang Denk  affected files).
6635218ca724SWolfgang Denk
6636218ca724SWolfgang Denk  We prefer patches as plain text. MIME attachments are discouraged,
6637218ca724SWolfgang Denk  and compressed attachments must not be used.
6638c609719bSwdenk
663952f52c14Swdenk* If one logical set of modifications affects or creates several
664052f52c14Swdenk  files, all these changes shall be submitted in a SINGLE patch file.
664152f52c14Swdenk
664252f52c14Swdenk* Changesets that contain different, unrelated modifications shall be
664352f52c14Swdenk  submitted as SEPARATE patches, one patch per changeset.
664452f52c14Swdenk
664552f52c14Swdenk
6646c609719bSwdenkNotes:
6647c609719bSwdenk
6648c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched
6649c609719bSwdenk  source tree and make sure that no errors or warnings are reported
6650c609719bSwdenk  for any of the boards.
6651c609719bSwdenk
6652c609719bSwdenk* Keep your modifications to the necessary minimum: A patch
6653c609719bSwdenk  containing several unrelated changes or arbitrary reformats will be
6654c609719bSwdenk  returned with a request to re-formatting / split it.
6655c609719bSwdenk
6656c609719bSwdenk* If you modify existing code, make sure that your new code does not
6657c609719bSwdenk  add to the memory footprint of the code ;-) Small is beautiful!
6658c609719bSwdenk  When adding new features, these should compile conditionally only
6659c609719bSwdenk  (using #ifdef), and the resulting code with the new feature
6660c609719bSwdenk  disabled must not need more memory than the old code without your
6661c609719bSwdenk  modification.
666290dc6704Swdenk
66630668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the
66640668236bSWolfgang Denk  u-boot mailing list. Bigger patches will be moderated. If they are
66650668236bSWolfgang Denk  reasonable and not too big, they will be acknowledged. But patches
66660668236bSWolfgang Denk  bigger than the size limit should be avoided.
6667