xref: /openbmc/u-boot/README (revision 45ae2546ef157b647d8684845c6554283b80be92)
1c609719bSwdenk#
2eca3aeb3SWolfgang Denk# (C) Copyright 2000 - 2013
3c609719bSwdenk# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4c609719bSwdenk#
5eca3aeb3SWolfgang Denk# SPDX-License-Identifier:	GPL-2.0+
6c609719bSwdenk#
7c609719bSwdenk
8c609719bSwdenkSummary:
9c609719bSwdenk========
10c609719bSwdenk
1124ee89b9SwdenkThis directory contains the source code for U-Boot, a boot loader for
12e86e5a07SwdenkEmbedded boards based on PowerPC, ARM, MIPS and several other
13e86e5a07Swdenkprocessors, which can be installed in a boot ROM and used to
14e86e5a07Swdenkinitialize and test the hardware or to download and run application
15e86e5a07Swdenkcode.
16c609719bSwdenk
17c609719bSwdenkThe development of U-Boot is closely related to Linux: some parts of
1824ee89b9Swdenkthe source code originate in the Linux source tree, we have some
1924ee89b9Swdenkheader files in common, and special provision has been made to
20c609719bSwdenksupport booting of Linux images.
21c609719bSwdenk
22c609719bSwdenkSome attention has been paid to make this software easily
23c609719bSwdenkconfigurable and extendable. For instance, all monitor commands are
24c609719bSwdenkimplemented with the same call interface, so that it's very easy to
25c609719bSwdenkadd new commands. Also, instead of permanently adding rarely used
26c609719bSwdenkcode (for instance hardware test utilities) to the monitor, you can
27c609719bSwdenkload and run it dynamically.
28c609719bSwdenk
29c609719bSwdenk
30c609719bSwdenkStatus:
31c609719bSwdenk=======
32c609719bSwdenk
33c609719bSwdenkIn general, all boards for which a configuration option exists in the
34c609719bSwdenkMakefile have been tested to some extent and can be considered
35c609719bSwdenk"working". In fact, many of them are used in production systems.
36c609719bSwdenk
37c609719bSwdenkIn case of problems see the CHANGELOG and CREDITS files to find out
3827af930eSAlbert ARIBAUDwho contributed the specific port. The boards.cfg file lists board
39218ca724SWolfgang Denkmaintainers.
40c609719bSwdenk
41adb9d851SRobert P. J. DayNote: There is no CHANGELOG file in the actual U-Boot source tree;
42adb9d851SRobert P. J. Dayit can be created dynamically from the Git log using:
43adb9d851SRobert P. J. Day
44adb9d851SRobert P. J. Day	make CHANGELOG
45adb9d851SRobert P. J. Day
46c609719bSwdenk
47c609719bSwdenkWhere to get help:
48c609719bSwdenk==================
49c609719bSwdenk
50c609719bSwdenkIn case you have questions about, problems with or contributions for
51c609719bSwdenkU-Boot you should send a message to the U-Boot mailing list at
520c32565fSPeter Tyser<u-boot@lists.denx.de>. There is also an archive of previous traffic
530c32565fSPeter Tyseron the mailing list - please search the archive before asking FAQ's.
540c32565fSPeter TyserPlease see http://lists.denx.de/pipermail/u-boot and
550c32565fSPeter Tyserhttp://dir.gmane.org/gmane.comp.boot-loaders.u-boot
56c609719bSwdenk
57c609719bSwdenk
58218ca724SWolfgang DenkWhere to get source code:
59218ca724SWolfgang Denk=========================
60218ca724SWolfgang Denk
61218ca724SWolfgang DenkThe U-Boot source code is maintained in the git repository at
62218ca724SWolfgang Denkgit://www.denx.de/git/u-boot.git ; you can browse it online at
63218ca724SWolfgang Denkhttp://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
64218ca724SWolfgang Denk
65218ca724SWolfgang DenkThe "snapshot" links on this page allow you to download tarballs of
6611ccc33fSMarcel Ziswilerany version you might be interested in. Official releases are also
67218ca724SWolfgang Denkavailable for FTP download from the ftp://ftp.denx.de/pub/u-boot/
68218ca724SWolfgang Denkdirectory.
69218ca724SWolfgang Denk
70d4ee711dSAnatolij GustschinPre-built (and tested) images are available from
71218ca724SWolfgang Denkftp://ftp.denx.de/pub/u-boot/images/
72218ca724SWolfgang Denk
73218ca724SWolfgang Denk
74c609719bSwdenkWhere we come from:
75c609719bSwdenk===================
76c609719bSwdenk
77c609719bSwdenk- start from 8xxrom sources
7824ee89b9Swdenk- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
79c609719bSwdenk- clean up code
80c609719bSwdenk- make it easier to add custom boards
81c609719bSwdenk- make it possible to add other [PowerPC] CPUs
82c609719bSwdenk- extend functions, especially:
83c609719bSwdenk  * Provide extended interface to Linux boot loader
84c609719bSwdenk  * S-Record download
85c609719bSwdenk  * network boot
8611ccc33fSMarcel Ziswiler  * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
8724ee89b9Swdenk- create ARMBoot project (http://sourceforge.net/projects/armboot)
88c609719bSwdenk- add other CPU families (starting with ARM)
8924ee89b9Swdenk- create U-Boot project (http://sourceforge.net/projects/u-boot)
900d28f34bSMagnus Lilja- current project page: see http://www.denx.de/wiki/U-Boot
9124ee89b9Swdenk
9224ee89b9Swdenk
9324ee89b9SwdenkNames and Spelling:
9424ee89b9Swdenk===================
9524ee89b9Swdenk
9624ee89b9SwdenkThe "official" name of this project is "Das U-Boot". The spelling
9724ee89b9Swdenk"U-Boot" shall be used in all written text (documentation, comments
9824ee89b9Swdenkin source files etc.). Example:
9924ee89b9Swdenk
10024ee89b9Swdenk	This is the README file for the U-Boot project.
10124ee89b9Swdenk
10224ee89b9SwdenkFile names etc. shall be based on the string "u-boot". Examples:
10324ee89b9Swdenk
10424ee89b9Swdenk	include/asm-ppc/u-boot.h
10524ee89b9Swdenk
10624ee89b9Swdenk	#include <asm/u-boot.h>
10724ee89b9Swdenk
10824ee89b9SwdenkVariable names, preprocessor constants etc. shall be either based on
10924ee89b9Swdenkthe string "u_boot" or on "U_BOOT". Example:
11024ee89b9Swdenk
11124ee89b9Swdenk	U_BOOT_VERSION		u_boot_logo
11224ee89b9Swdenk	IH_OS_U_BOOT		u_boot_hush_start
113c609719bSwdenk
114c609719bSwdenk
11593f19cc0SwdenkVersioning:
11693f19cc0Swdenk===========
11793f19cc0Swdenk
118360d883aSThomas WeberStarting with the release in October 2008, the names of the releases
119360d883aSThomas Weberwere changed from numerical release numbers without deeper meaning
120360d883aSThomas Weberinto a time stamp based numbering. Regular releases are identified by
121360d883aSThomas Webernames consisting of the calendar year and month of the release date.
122360d883aSThomas WeberAdditional fields (if present) indicate release candidates or bug fix
123360d883aSThomas Weberreleases in "stable" maintenance trees.
12493f19cc0Swdenk
125360d883aSThomas WeberExamples:
126360d883aSThomas Weber	U-Boot v2009.11	    - Release November 2009
127360d883aSThomas Weber	U-Boot v2009.11.1   - Release 1 in version November 2009 stable tree
128360d883aSThomas Weber	U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release
12993f19cc0Swdenk
13093f19cc0Swdenk
131c609719bSwdenkDirectory Hierarchy:
132c609719bSwdenk====================
133c609719bSwdenk
1348d321b81SPeter Tyser/arch			Architecture specific files
1358d321b81SPeter Tyser  /arm			Files generic to ARM architecture
1368d321b81SPeter Tyser    /cpu		CPU specific files
1378d321b81SPeter Tyser      /arm720t		Files specific to ARM 720 CPUs
1388d321b81SPeter Tyser      /arm920t		Files specific to ARM 920 CPUs
1396eb0921aSAndreas Bießmann	/at91		Files specific to Atmel AT91RM9200 CPU
1408d321b81SPeter Tyser	/imx		Files specific to Freescale MC9328 i.MX CPUs
1418d321b81SPeter Tyser	/s3c24x0	Files specific to Samsung S3C24X0 CPUs
1428d321b81SPeter Tyser      /arm926ejs	Files specific to ARM 926 CPUs
1438d321b81SPeter Tyser      /arm1136		Files specific to ARM 1136 CPUs
1448d321b81SPeter Tyser      /ixp		Files specific to Intel XScale IXP CPUs
1458d321b81SPeter Tyser      /pxa		Files specific to Intel XScale PXA CPUs
1468d321b81SPeter Tyser      /sa1100		Files specific to Intel StrongARM SA1100 CPUs
1478d321b81SPeter Tyser    /lib		Architecture specific library files
1488d321b81SPeter Tyser  /avr32		Files generic to AVR32 architecture
1498d321b81SPeter Tyser    /cpu		CPU specific files
1508d321b81SPeter Tyser    /lib		Architecture specific library files
1518d321b81SPeter Tyser  /blackfin		Files generic to Analog Devices Blackfin architecture
1528d321b81SPeter Tyser    /cpu		CPU specific files
1538d321b81SPeter Tyser    /lib		Architecture specific library files
1548d321b81SPeter Tyser  /m68k			Files generic to m68k architecture
1558d321b81SPeter Tyser    /cpu		CPU specific files
1568d321b81SPeter Tyser      /mcf52x2		Files specific to Freescale ColdFire MCF52x2 CPUs
1578d321b81SPeter Tyser      /mcf5227x		Files specific to Freescale ColdFire MCF5227x CPUs
1588d321b81SPeter Tyser      /mcf532x		Files specific to Freescale ColdFire MCF5329 CPUs
1598d321b81SPeter Tyser      /mcf5445x		Files specific to Freescale ColdFire MCF5445x CPUs
1608d321b81SPeter Tyser      /mcf547x_8x	Files specific to Freescale ColdFire MCF547x_8x CPUs
1618d321b81SPeter Tyser    /lib		Architecture specific library files
1628d321b81SPeter Tyser  /microblaze		Files generic to microblaze architecture
1638d321b81SPeter Tyser    /cpu		CPU specific files
1648d321b81SPeter Tyser    /lib		Architecture specific library files
1658d321b81SPeter Tyser  /mips			Files generic to MIPS architecture
1668d321b81SPeter Tyser    /cpu		CPU specific files
16792bbd64eSDaniel Schwierzeck      /mips32		Files specific to MIPS32 CPUs
16880421fccSXiangfu Liu      /xburst		Files specific to Ingenic XBurst CPUs
1698d321b81SPeter Tyser    /lib		Architecture specific library files
170afc1ce82SMacpaul Lin  /nds32		Files generic to NDS32 architecture
171afc1ce82SMacpaul Lin    /cpu		CPU specific files
172afc1ce82SMacpaul Lin      /n1213		Files specific to Andes Technology N1213 CPUs
173afc1ce82SMacpaul Lin    /lib		Architecture specific library files
1748d321b81SPeter Tyser  /nios2		Files generic to Altera NIOS2 architecture
1758d321b81SPeter Tyser    /cpu		CPU specific files
1768d321b81SPeter Tyser    /lib		Architecture specific library files
17733c7731bSRobert P. J. Day  /openrisc		Files generic to OpenRISC architecture
17833c7731bSRobert P. J. Day    /cpu		CPU specific files
17933c7731bSRobert P. J. Day    /lib		Architecture specific library files
180a47a12beSStefan Roese  /powerpc		Files generic to PowerPC architecture
1818d321b81SPeter Tyser    /cpu		CPU specific files
1828d321b81SPeter Tyser      /74xx_7xx		Files specific to Freescale MPC74xx and 7xx CPUs
1838d321b81SPeter Tyser      /mpc5xx		Files specific to Freescale MPC5xx CPUs
1848d321b81SPeter Tyser      /mpc5xxx		Files specific to Freescale MPC5xxx CPUs
1858d321b81SPeter Tyser      /mpc8xx		Files specific to Freescale MPC8xx CPUs
1868d321b81SPeter Tyser      /mpc824x		Files specific to Freescale MPC824x CPUs
1878d321b81SPeter Tyser      /mpc8260		Files specific to Freescale MPC8260 CPUs
1888d321b81SPeter Tyser      /mpc85xx		Files specific to Freescale MPC85xx CPUs
1898d321b81SPeter Tyser      /ppc4xx		Files specific to AMCC PowerPC 4xx CPUs
1908d321b81SPeter Tyser    /lib		Architecture specific library files
1918d321b81SPeter Tyser  /sh			Files generic to SH architecture
1928d321b81SPeter Tyser    /cpu		CPU specific files
1938d321b81SPeter Tyser      /sh2		Files specific to sh2 CPUs
1948d321b81SPeter Tyser      /sh3		Files specific to sh3 CPUs
1958d321b81SPeter Tyser      /sh4		Files specific to sh4 CPUs
1968d321b81SPeter Tyser    /lib		Architecture specific library files
1978d321b81SPeter Tyser  /sparc		Files generic to SPARC architecture
1988d321b81SPeter Tyser    /cpu		CPU specific files
1998d321b81SPeter Tyser      /leon2		Files specific to Gaisler LEON2 SPARC CPU
2008d321b81SPeter Tyser      /leon3		Files specific to Gaisler LEON3 SPARC CPU
2018d321b81SPeter Tyser    /lib		Architecture specific library files
20233c7731bSRobert P. J. Day  /x86			Files generic to x86 architecture
20333c7731bSRobert P. J. Day    /cpu		CPU specific files
20433c7731bSRobert P. J. Day    /lib		Architecture specific library files
2058d321b81SPeter Tyser/api			Machine/arch independent API for external apps
2068d321b81SPeter Tyser/board			Board dependent files
2078d321b81SPeter Tyser/common			Misc architecture independent functions
2088d321b81SPeter Tyser/disk			Code for disk drive partition handling
2098d321b81SPeter Tyser/doc			Documentation (don't expect too much)
2108d321b81SPeter Tyser/drivers		Commonly used device drivers
21133c7731bSRobert P. J. Day/dts			Contains Makefile for building internal U-Boot fdt.
2128d321b81SPeter Tyser/examples		Example code for standalone applications, etc.
2138d321b81SPeter Tyser/fs			Filesystem code (cramfs, ext2, jffs2, etc.)
2148d321b81SPeter Tyser/include		Header Files
2158d321b81SPeter Tyser/lib			Files generic to all architectures
2168d321b81SPeter Tyser  /libfdt		Library files to support flattened device trees
2178d321b81SPeter Tyser  /lzma			Library files to support LZMA decompression
2188d321b81SPeter Tyser  /lzo			Library files to support LZO decompression
2198d321b81SPeter Tyser/net			Networking code
2208d321b81SPeter Tyser/post			Power On Self Test
22133c7731bSRobert P. J. Day/spl			Secondary Program Loader framework
2228d321b81SPeter Tyser/tools			Tools to build S-Record or U-Boot images, etc.
223c609719bSwdenk
224c609719bSwdenkSoftware Configuration:
225c609719bSwdenk=======================
226c609719bSwdenk
227c609719bSwdenkConfiguration is usually done using C preprocessor defines; the
228c609719bSwdenkrationale behind that is to avoid dead code whenever possible.
229c609719bSwdenk
230c609719bSwdenkThere are two classes of configuration variables:
231c609719bSwdenk
232c609719bSwdenk* Configuration _OPTIONS_:
233c609719bSwdenk  These are selectable by the user and have names beginning with
234c609719bSwdenk  "CONFIG_".
235c609719bSwdenk
236c609719bSwdenk* Configuration _SETTINGS_:
237c609719bSwdenk  These depend on the hardware etc. and should not be meddled with if
238c609719bSwdenk  you don't know what you're doing; they have names beginning with
2396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  "CONFIG_SYS_".
240c609719bSwdenk
241c609719bSwdenkLater we will add a configuration tool - probably similar to or even
242c609719bSwdenkidentical to what's used for the Linux kernel. Right now, we have to
243c609719bSwdenkdo the configuration by hand, which means creating some symbolic
244c609719bSwdenklinks and editing some configuration files. We use the TQM8xxL boards
245c609719bSwdenkas an example here.
246c609719bSwdenk
247c609719bSwdenk
248c609719bSwdenkSelection of Processor Architecture and Board Type:
249c609719bSwdenk---------------------------------------------------
250c609719bSwdenk
251c609719bSwdenkFor all supported boards there are ready-to-use default
252c609719bSwdenkconfigurations available; just type "make <board_name>_config".
253c609719bSwdenk
254c609719bSwdenkExample: For a TQM823L module type:
255c609719bSwdenk
256c609719bSwdenk	cd u-boot
257c609719bSwdenk	make TQM823L_config
258c609719bSwdenk
25911ccc33fSMarcel ZiswilerFor the Cogent platform, you need to specify the CPU type as well;
260c609719bSwdenke.g. "make cogent_mpc8xx_config". And also configure the cogent
261c609719bSwdenkdirectory according to the instructions in cogent/README.
262c609719bSwdenk
263c609719bSwdenk
264c609719bSwdenkConfiguration Options:
265c609719bSwdenk----------------------
266c609719bSwdenk
267c609719bSwdenkConfiguration depends on the combination of board and CPU type; all
268c609719bSwdenksuch information is kept in a configuration file
269c609719bSwdenk"include/configs/<board_name>.h".
270c609719bSwdenk
271c609719bSwdenkExample: For a TQM823L module, all configuration settings are in
272c609719bSwdenk"include/configs/TQM823L.h".
273c609719bSwdenk
274c609719bSwdenk
2757f6c2cbcSwdenkMany of the options are named exactly as the corresponding Linux
2767f6c2cbcSwdenkkernel configuration options. The intention is to make it easier to
2777f6c2cbcSwdenkbuild a config tool - later.
2787f6c2cbcSwdenk
2797f6c2cbcSwdenk
280c609719bSwdenkThe following options need to be configured:
281c609719bSwdenk
2822628114eSKim Phillips- CPU Type:	Define exactly one, e.g. CONFIG_MPC85XX.
283c609719bSwdenk
2842628114eSKim Phillips- Board Type:	Define exactly one, e.g. CONFIG_MPC8540ADS.
2856ccec449SWolfgang Denk
2866ccec449SWolfgang Denk- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
28709ea0de0SHaavard Skinnemoen		Define exactly one, e.g. CONFIG_ATSTK1002
288c609719bSwdenk
289c609719bSwdenk- CPU Module Type: (if CONFIG_COGENT is defined)
290c609719bSwdenk		Define exactly one of
291c609719bSwdenk		CONFIG_CMA286_60_OLD
292c609719bSwdenk--- FIXME --- not tested yet:
293c609719bSwdenk		CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
294c609719bSwdenk		CONFIG_CMA287_23, CONFIG_CMA287_50
295c609719bSwdenk
296c609719bSwdenk- Motherboard Type: (if CONFIG_COGENT is defined)
297c609719bSwdenk		Define exactly one of
298c609719bSwdenk		CONFIG_CMA101, CONFIG_CMA102
299c609719bSwdenk
300c609719bSwdenk- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
301c609719bSwdenk		Define one or more of
302c609719bSwdenk		CONFIG_CMA302
303c609719bSwdenk
304c609719bSwdenk- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
305c609719bSwdenk		Define one or more of
306c609719bSwdenk		CONFIG_LCD_HEARTBEAT	- update a character position on
30711ccc33fSMarcel Ziswiler					  the LCD display every second with
308c609719bSwdenk					  a "rotator" |\-/|\-/
309c609719bSwdenk
3102535d602Swdenk- Board flavour: (if CONFIG_MPC8260ADS is defined)
3112535d602Swdenk		CONFIG_ADSTYPE
3122535d602Swdenk		Possible values are:
3136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8260ADS	- original MPC8260ADS
3146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8266ADS	- MPC8266ADS
3156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_PQ2FADS	- PQ2FADS-ZU or PQ2FADS-VR
3166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8272ADS	- MPC8272ADS
3172535d602Swdenk
318cf946c6dSLei Wen- Marvell Family Member
319cf946c6dSLei Wen		CONFIG_SYS_MVFS		- define it if you want to enable
320cf946c6dSLei Wen					  multiple fs option at one time
321cf946c6dSLei Wen					  for marvell soc family
322cf946c6dSLei Wen
323c609719bSwdenk- MPC824X Family Member (if CONFIG_MPC824X is defined)
324c609719bSwdenk		Define exactly one of
325c609719bSwdenk		CONFIG_MPC8240, CONFIG_MPC8245
326c609719bSwdenk
32711ccc33fSMarcel Ziswiler- 8xx CPU Options: (if using an MPC8xx CPU)
32866ca92a5Swdenk		CONFIG_8xx_GCLK_FREQ	- deprecated: CPU clock if
32966ca92a5Swdenk					  get_gclk_freq() cannot work
3305da627a4Swdenk					  e.g. if there is no 32KHz
3315da627a4Swdenk					  reference PIT/RTC clock
33266ca92a5Swdenk		CONFIG_8xx_OSCLK	- PLL input clock (either EXTCLK
33366ca92a5Swdenk					  or XTAL/EXTAL)
334c609719bSwdenk
33566ca92a5Swdenk- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
3366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MIN
3376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MAX
33866ca92a5Swdenk		CONFIG_8xx_CPUCLK_DEFAULT
33975d1ea7fSwdenk			See doc/README.MPC866
34075d1ea7fSwdenk
3416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MEASURE_CPUCLK
34275d1ea7fSwdenk
34375d1ea7fSwdenk		Define this to measure the actual CPU clock instead
34475d1ea7fSwdenk		of relying on the correctness of the configured
34575d1ea7fSwdenk		values. Mostly useful for board bringup to make sure
34675d1ea7fSwdenk		the PLL is locked at the intended frequency. Note
34775d1ea7fSwdenk		that this requires a (stable) reference clock (32 kHz
3486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		RTC clock or CONFIG_SYS_8XX_XIN)
34975d1ea7fSwdenk
350506f3918SHeiko Schocher		CONFIG_SYS_DELAYED_ICACHE
351506f3918SHeiko Schocher
352506f3918SHeiko Schocher		Define this option if you want to enable the
353506f3918SHeiko Schocher		ICache only when Code runs from RAM.
354506f3918SHeiko Schocher
35566412c63SKumar Gala- 85xx CPU Options:
356ffd06e02SYork Sun		CONFIG_SYS_PPC64
357ffd06e02SYork Sun
358ffd06e02SYork Sun		Specifies that the core is a 64-bit PowerPC implementation (implements
359ffd06e02SYork Sun		the "64" category of the Power ISA). This is necessary for ePAPR
360ffd06e02SYork Sun		compliance, among other possible reasons.
361ffd06e02SYork Sun
36266412c63SKumar Gala		CONFIG_SYS_FSL_TBCLK_DIV
36366412c63SKumar Gala
36466412c63SKumar Gala		Defines the core time base clock divider ratio compared to the
36566412c63SKumar Gala		system clock.  On most PQ3 devices this is 8, on newer QorIQ
36666412c63SKumar Gala		devices it can be 16 or 32.  The ratio varies from SoC to Soc.
36766412c63SKumar Gala
3688f29084aSKumar Gala		CONFIG_SYS_FSL_PCIE_COMPAT
3698f29084aSKumar Gala
3708f29084aSKumar Gala		Defines the string to utilize when trying to match PCIe device
3718f29084aSKumar Gala		tree nodes for the given platform.
3728f29084aSKumar Gala
373afa6b551SPrabhakar Kushwaha		CONFIG_SYS_PPC_E500_DEBUG_TLB
374afa6b551SPrabhakar Kushwaha
375afa6b551SPrabhakar Kushwaha		Enables a temporary TLB entry to be used during boot to work
376afa6b551SPrabhakar Kushwaha		around limitations in e500v1 and e500v2 external debugger
377afa6b551SPrabhakar Kushwaha		support. This reduces the portions of the boot code where
378afa6b551SPrabhakar Kushwaha		breakpoints and single stepping do not work.  The value of this
379afa6b551SPrabhakar Kushwaha		symbol should be set to the TLB1 entry to be used for this
380afa6b551SPrabhakar Kushwaha		purpose.
381afa6b551SPrabhakar Kushwaha
38233eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510
38333eee330SScott Wood
38433eee330SScott Wood		Enables a workaround for erratum A004510.  If set,
38533eee330SScott Wood		then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
38633eee330SScott Wood		CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
38733eee330SScott Wood
38833eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
38933eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
39033eee330SScott Wood
39133eee330SScott Wood		Defines one or two SoC revisions (low 8 bits of SVR)
39233eee330SScott Wood		for which the A004510 workaround should be applied.
39333eee330SScott Wood
39433eee330SScott Wood		The rest of SVR is either not relevant to the decision
39533eee330SScott Wood		of whether the erratum is present (e.g. p2040 versus
39633eee330SScott Wood		p2041) or is implied by the build target, which controls
39733eee330SScott Wood		whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
39833eee330SScott Wood
39933eee330SScott Wood		See Freescale App Note 4493 for more information about
40033eee330SScott Wood		this erratum.
40133eee330SScott Wood
40274fa22edSPrabhakar Kushwaha		CONFIG_A003399_NOR_WORKAROUND
40374fa22edSPrabhakar Kushwaha		Enables a workaround for IFC erratum A003399. It is only
40474fa22edSPrabhakar Kushwaha		requred during NOR boot.
40574fa22edSPrabhakar Kushwaha
40633eee330SScott Wood		CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
40733eee330SScott Wood
40833eee330SScott Wood		This is the value to write into CCSR offset 0x18600
40933eee330SScott Wood		according to the A004510 workaround.
41033eee330SScott Wood
41164501c66SPriyanka Jain		CONFIG_SYS_FSL_DSP_DDR_ADDR
41264501c66SPriyanka Jain		This value denotes start offset of DDR memory which is
41364501c66SPriyanka Jain		connected exclusively to the DSP cores.
41464501c66SPriyanka Jain
415765b0bdbSPriyanka Jain		CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
416765b0bdbSPriyanka Jain		This value denotes start offset of M2 memory
417765b0bdbSPriyanka Jain		which is directly connected to the DSP core.
418765b0bdbSPriyanka Jain
41964501c66SPriyanka Jain		CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
42064501c66SPriyanka Jain		This value denotes start offset of M3 memory which is directly
42164501c66SPriyanka Jain		connected to the DSP core.
42264501c66SPriyanka Jain
423765b0bdbSPriyanka Jain		CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
424765b0bdbSPriyanka Jain		This value denotes start offset of DSP CCSR space.
425765b0bdbSPriyanka Jain
426cb93071bSYork Sun		CONFIG_SYS_FSL_DDR_EMU
427cb93071bSYork Sun		Specify emulator support for DDR. Some DDR features such as
428cb93071bSYork Sun		deskew training are not available.
429cb93071bSYork Sun
4306cb461b4SDaniel Schwierzeck- Generic CPU options:
4316cb461b4SDaniel Schwierzeck		CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
4326cb461b4SDaniel Schwierzeck
4336cb461b4SDaniel Schwierzeck		Defines the endianess of the CPU. Implementation of those
4346cb461b4SDaniel Schwierzeck		values is arch specific.
4356cb461b4SDaniel Schwierzeck
4360b953ffcSMarkus Klotzbuecher- Intel Monahans options:
4376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
4380b953ffcSMarkus Klotzbuecher
4390b953ffcSMarkus Klotzbuecher		Defines the Monahans run mode to oscillator
4400b953ffcSMarkus Klotzbuecher		ratio. Valid values are 8, 16, 24, 31. The core
4410b953ffcSMarkus Klotzbuecher		frequency is this value multiplied by 13 MHz.
4420b953ffcSMarkus Klotzbuecher
4436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
4440b953ffcSMarkus Klotzbuecher
4450b953ffcSMarkus Klotzbuecher		Defines the Monahans turbo mode to oscillator
4460b953ffcSMarkus Klotzbuecher		ratio. Valid values are 1 (default if undefined) and
4470b953ffcSMarkus Klotzbuecher		2. The core frequency as calculated above is multiplied
4480b953ffcSMarkus Klotzbuecher		by this value.
4490b953ffcSMarkus Klotzbuecher
45092bbd64eSDaniel Schwierzeck- MIPS CPU options:
45192bbd64eSDaniel Schwierzeck		CONFIG_SYS_INIT_SP_OFFSET
45292bbd64eSDaniel Schwierzeck
45392bbd64eSDaniel Schwierzeck		Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
45492bbd64eSDaniel Schwierzeck		pointer. This is needed for the temporary stack before
45592bbd64eSDaniel Schwierzeck		relocation.
45692bbd64eSDaniel Schwierzeck
45792bbd64eSDaniel Schwierzeck		CONFIG_SYS_MIPS_CACHE_MODE
45892bbd64eSDaniel Schwierzeck
45992bbd64eSDaniel Schwierzeck		Cache operation mode for the MIPS CPU.
46092bbd64eSDaniel Schwierzeck		See also arch/mips/include/asm/mipsregs.h.
46192bbd64eSDaniel Schwierzeck		Possible values are:
46292bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_NO_WA
46392bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_WA
46492bbd64eSDaniel Schwierzeck			CONF_CM_UNCACHED
46592bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_NONCOHERENT
46692bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_CE
46792bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_COW
46892bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_CUW
46992bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_ACCELERATED
47092bbd64eSDaniel Schwierzeck
47192bbd64eSDaniel Schwierzeck		CONFIG_SYS_XWAY_EBU_BOOTCFG
47292bbd64eSDaniel Schwierzeck
47392bbd64eSDaniel Schwierzeck		Special option for Lantiq XWAY SoCs for booting from NOR flash.
47492bbd64eSDaniel Schwierzeck		See also arch/mips/cpu/mips32/start.S.
47592bbd64eSDaniel Schwierzeck
47692bbd64eSDaniel Schwierzeck		CONFIG_XWAY_SWAP_BYTES
47792bbd64eSDaniel Schwierzeck
47892bbd64eSDaniel Schwierzeck		Enable compilation of tools/xway-swap-bytes needed for Lantiq
47992bbd64eSDaniel Schwierzeck		XWAY SoCs for booting from NOR flash. The U-Boot image needs to
48092bbd64eSDaniel Schwierzeck		be swapped if a flash programmer is used.
48192bbd64eSDaniel Schwierzeck
482b67d8816SChristian Riesch- ARM options:
483b67d8816SChristian Riesch		CONFIG_SYS_EXCEPTION_VECTORS_HIGH
484b67d8816SChristian Riesch
485b67d8816SChristian Riesch		Select high exception vectors of the ARM core, e.g., do not
486b67d8816SChristian Riesch		clear the V bit of the c1 register of CP15.
487b67d8816SChristian Riesch
4885356f545SAneesh V		CONFIG_SYS_THUMB_BUILD
4895356f545SAneesh V
4905356f545SAneesh V		Use this flag to build U-Boot using the Thumb instruction
4915356f545SAneesh V		set for ARM architectures. Thumb instruction set provides
4925356f545SAneesh V		better code density. For ARM architectures that support
4935356f545SAneesh V		Thumb2 this flag will result in Thumb2 code generated by
4945356f545SAneesh V		GCC.
4955356f545SAneesh V
496c5d4752cSStephen Warren		CONFIG_ARM_ERRATA_716044
4970678587fSStephen Warren		CONFIG_ARM_ERRATA_742230
4980678587fSStephen Warren		CONFIG_ARM_ERRATA_743622
4990678587fSStephen Warren		CONFIG_ARM_ERRATA_751472
5000678587fSStephen Warren
5010678587fSStephen Warren		If set, the workarounds for these ARM errata are applied early
5020678587fSStephen Warren		during U-Boot startup. Note that these options force the
5030678587fSStephen Warren		workarounds to be applied; no CPU-type/version detection
5040678587fSStephen Warren		exists, unlike the similar options in the Linux kernel. Do not
5050678587fSStephen Warren		set these options unless they apply!
5060678587fSStephen Warren
507795659dcSStephen Warren- CPU timer options:
508795659dcSStephen Warren		CONFIG_SYS_HZ
509795659dcSStephen Warren
510795659dcSStephen Warren		The frequency of the timer returned by get_timer().
511795659dcSStephen Warren		get_timer() must operate in milliseconds and this CONFIG
512795659dcSStephen Warren		option must be set to 1000.
513795659dcSStephen Warren
5145da627a4Swdenk- Linux Kernel Interface:
515c609719bSwdenk		CONFIG_CLOCKS_IN_MHZ
516c609719bSwdenk
517c609719bSwdenk		U-Boot stores all clock information in Hz
518c609719bSwdenk		internally. For binary compatibility with older Linux
519c609719bSwdenk		kernels (which expect the clocks passed in the
520c609719bSwdenk		bd_info data to be in MHz) the environment variable
521c609719bSwdenk		"clocks_in_mhz" can be defined so that U-Boot
522c609719bSwdenk		converts clock data to MHZ before passing it to the
523c609719bSwdenk		Linux kernel.
524c609719bSwdenk		When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
525c609719bSwdenk		"clocks_in_mhz=1" is automatically included in the
526c609719bSwdenk		default environment.
527c609719bSwdenk
5285da627a4Swdenk		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]
5295da627a4Swdenk
53011ccc33fSMarcel Ziswiler		When transferring memsize parameter to linux, some versions
5315da627a4Swdenk		expect it to be in bytes, others in MB.
5325da627a4Swdenk		Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
5335da627a4Swdenk
534fec6d9eeSGerald Van Baren		CONFIG_OF_LIBFDT
535f57f70aaSWolfgang Denk
536f57f70aaSWolfgang Denk		New kernel versions are expecting firmware settings to be
537213bf8c8SGerald Van Baren		passed using flattened device trees (based on open firmware
538213bf8c8SGerald Van Baren		concepts).
539213bf8c8SGerald Van Baren
540213bf8c8SGerald Van Baren		CONFIG_OF_LIBFDT
541213bf8c8SGerald Van Baren		 * New libfdt-based support
542213bf8c8SGerald Van Baren		 * Adds the "fdt" command
5433bb342fcSKim Phillips		 * The bootm command automatically updates the fdt
544213bf8c8SGerald Van Baren
545b55ae402SMarcel Ziswiler		OF_CPU - The proper name of the cpus node (only required for
546b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
547b55ae402SMarcel Ziswiler		OF_SOC - The proper name of the soc node (only required for
548b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
549f57f70aaSWolfgang Denk		OF_TBCLK - The timebase frequency.
550c2871f03SKumar Gala		OF_STDOUT_PATH - The path to the console device
551f57f70aaSWolfgang Denk
55211ccc33fSMarcel Ziswiler		boards with QUICC Engines require OF_QE to set UCC MAC
55311ccc33fSMarcel Ziswiler		addresses
5543bb342fcSKim Phillips
5554e253137SKumar Gala		CONFIG_OF_BOARD_SETUP
5564e253137SKumar Gala
5574e253137SKumar Gala		Board code has addition modification that it wants to make
5584e253137SKumar Gala		to the flat device tree before handing it off to the kernel
5596705d81eSwdenk
5600267768eSMatthew McClintock		CONFIG_OF_BOOT_CPU
5610267768eSMatthew McClintock
56211ccc33fSMarcel Ziswiler		This define fills in the correct boot CPU in the boot
5630267768eSMatthew McClintock		param header, the default value is zero if undefined.
5640267768eSMatthew McClintock
5653887c3fbSHeiko Schocher		CONFIG_OF_IDE_FIXUP
5663887c3fbSHeiko Schocher
5673887c3fbSHeiko Schocher		U-Boot can detect if an IDE device is present or not.
5683887c3fbSHeiko Schocher		If not, and this new config option is activated, U-Boot
5693887c3fbSHeiko Schocher		removes the ATA node from the DTS before booting Linux,
5703887c3fbSHeiko Schocher		so the Linux IDE driver does not probe the device and
5713887c3fbSHeiko Schocher		crash. This is needed for buggy hardware (uc101) where
5723887c3fbSHeiko Schocher		no pull down resistor is connected to the signal IDE5V_DD7.
5733887c3fbSHeiko Schocher
5747eb29398SIgor Grinberg		CONFIG_MACH_TYPE	[relevant for ARM only][mandatory]
5757eb29398SIgor Grinberg
5767eb29398SIgor Grinberg		This setting is mandatory for all boards that have only one
5777eb29398SIgor Grinberg		machine type and must be used to specify the machine type
5787eb29398SIgor Grinberg		number as it appears in the ARM machine registry
5797eb29398SIgor Grinberg		(see http://www.arm.linux.org.uk/developer/machines/).
5807eb29398SIgor Grinberg		Only boards that have multiple machine types supported
5817eb29398SIgor Grinberg		in a single configuration file and the machine type is
5827eb29398SIgor Grinberg		runtime discoverable, do not have to use this setting.
5837eb29398SIgor Grinberg
5840b2f4ecaSNiklaus Giger- vxWorks boot parameters:
5850b2f4ecaSNiklaus Giger
5860b2f4ecaSNiklaus Giger		bootvx constructs a valid bootline using the following
5870b2f4ecaSNiklaus Giger		environments variables: bootfile, ipaddr, serverip, hostname.
5880b2f4ecaSNiklaus Giger		It loads the vxWorks image pointed bootfile.
5890b2f4ecaSNiklaus Giger
5900b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
5910b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
5920b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
5930b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
5940b2f4ecaSNiklaus Giger
5950b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_ADD_PARAMS
5960b2f4ecaSNiklaus Giger
5970b2f4ecaSNiklaus Giger		Add it at the end of the bootline. E.g "u=username pw=secret"
5980b2f4ecaSNiklaus Giger
5990b2f4ecaSNiklaus Giger		Note: If a "bootargs" environment is defined, it will overwride
6000b2f4ecaSNiklaus Giger		the defaults discussed just above.
6010b2f4ecaSNiklaus Giger
6022c451f78SAneesh V- Cache Configuration:
6032c451f78SAneesh V		CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
6042c451f78SAneesh V		CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
6052c451f78SAneesh V		CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
6062c451f78SAneesh V
60793bc2193SAneesh V- Cache Configuration for ARM:
60893bc2193SAneesh V		CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
60993bc2193SAneesh V				      controller
61093bc2193SAneesh V		CONFIG_SYS_PL310_BASE - Physical base address of PL310
61193bc2193SAneesh V					controller register space
61293bc2193SAneesh V
6136705d81eSwdenk- Serial Ports:
61448d0192fSAndreas Engel		CONFIG_PL010_SERIAL
6156705d81eSwdenk
6166705d81eSwdenk		Define this if you want support for Amba PrimeCell PL010 UARTs.
6176705d81eSwdenk
61848d0192fSAndreas Engel		CONFIG_PL011_SERIAL
6196705d81eSwdenk
6206705d81eSwdenk		Define this if you want support for Amba PrimeCell PL011 UARTs.
6216705d81eSwdenk
6226705d81eSwdenk		CONFIG_PL011_CLOCK
6236705d81eSwdenk
6246705d81eSwdenk		If you have Amba PrimeCell PL011 UARTs, set this variable to
6256705d81eSwdenk		the clock speed of the UARTs.
6266705d81eSwdenk
6276705d81eSwdenk		CONFIG_PL01x_PORTS
6286705d81eSwdenk
6296705d81eSwdenk		If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
6306705d81eSwdenk		define this to a list of base addresses for each (supported)
6316705d81eSwdenk		port. See e.g. include/configs/versatile.h
6326705d81eSwdenk
633910f1ae3SJohn Rigby		CONFIG_PL011_SERIAL_RLCR
634910f1ae3SJohn Rigby
635910f1ae3SJohn Rigby		Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
636910f1ae3SJohn Rigby		have separate receive and transmit line control registers.  Set
637910f1ae3SJohn Rigby		this variable to initialize the extra register.
638910f1ae3SJohn Rigby
639910f1ae3SJohn Rigby		CONFIG_PL011_SERIAL_FLUSH_ON_INIT
640910f1ae3SJohn Rigby
641910f1ae3SJohn Rigby		On some platforms (e.g. U8500) U-Boot is loaded by a second stage
642910f1ae3SJohn Rigby		boot loader that has already initialized the UART.  Define this
643910f1ae3SJohn Rigby		variable to flush the UART at init time.
644910f1ae3SJohn Rigby
6456705d81eSwdenk
646c609719bSwdenk- Console Interface:
647c609719bSwdenk		Depending on board, define exactly one serial port
648c609719bSwdenk		(like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
649c609719bSwdenk		CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
650c609719bSwdenk		console by defining CONFIG_8xx_CONS_NONE
651c609719bSwdenk
652c609719bSwdenk		Note: if CONFIG_8xx_CONS_NONE is defined, the serial
653c609719bSwdenk		port routines must be defined elsewhere
654c609719bSwdenk		(i.e. serial_init(), serial_getc(), ...)
655c609719bSwdenk
656c609719bSwdenk		CONFIG_CFB_CONSOLE
657c609719bSwdenk		Enables console device for a color framebuffer. Needs following
658c53043b7SWolfgang Denk		defines (cf. smiLynxEM, i8042)
659c609719bSwdenk			VIDEO_FB_LITTLE_ENDIAN	graphic memory organisation
660c609719bSwdenk						(default big endian)
661c609719bSwdenk			VIDEO_HW_RECTFILL	graphic chip supports
662c609719bSwdenk						rectangle fill
663c609719bSwdenk						(cf. smiLynxEM)
664c609719bSwdenk			VIDEO_HW_BITBLT		graphic chip supports
665c609719bSwdenk						bit-blit (cf. smiLynxEM)
666c609719bSwdenk			VIDEO_VISIBLE_COLS	visible pixel columns
667c609719bSwdenk						(cols=pitch)
668c609719bSwdenk			VIDEO_VISIBLE_ROWS	visible pixel rows
669c609719bSwdenk			VIDEO_PIXEL_SIZE	bytes per pixel
670c609719bSwdenk			VIDEO_DATA_FORMAT	graphic data format
671c609719bSwdenk						(0-5, cf. cfb_console.c)
672c609719bSwdenk			VIDEO_FB_ADRS		framebuffer address
673c609719bSwdenk			VIDEO_KBD_INIT_FCT	keyboard int fct
674c609719bSwdenk						(i.e. i8042_kbd_init())
675c609719bSwdenk			VIDEO_TSTC_FCT		test char fct
676c609719bSwdenk						(i.e. i8042_tstc)
677c609719bSwdenk			VIDEO_GETC_FCT		get char fct
678c609719bSwdenk						(i.e. i8042_getc)
679c609719bSwdenk			CONFIG_CONSOLE_CURSOR	cursor drawing on/off
680c609719bSwdenk						(requires blink timer
681c609719bSwdenk						cf. i8042.c)
6826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
683c609719bSwdenk			CONFIG_CONSOLE_TIME	display time/date info in
684c609719bSwdenk						upper right corner
685602ad3b3SJon Loeliger						(requires CONFIG_CMD_DATE)
686c609719bSwdenk			CONFIG_VIDEO_LOGO	display Linux logo in
687c609719bSwdenk						upper left corner
688a6c7ad2fSwdenk			CONFIG_VIDEO_BMP_LOGO	use bmp_logo.h instead of
689a6c7ad2fSwdenk						linux_logo.h for logo.
690a6c7ad2fSwdenk						Requires CONFIG_VIDEO_LOGO
691c609719bSwdenk			CONFIG_CONSOLE_EXTRA_INFO
69211ccc33fSMarcel Ziswiler						additional board info beside
693c609719bSwdenk						the logo
694c609719bSwdenk
69533a35bbbSPali Rohár		When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
69633a35bbbSPali Rohár		a limited number of ANSI escape sequences (cursor control,
69733a35bbbSPali Rohár		erase functions and limited graphics rendition control).
69833a35bbbSPali Rohár
699c609719bSwdenk		When CONFIG_CFB_CONSOLE is defined, video console is
700c609719bSwdenk		default i/o. Serial console can be forced with
701c609719bSwdenk		environment 'console=serial'.
702c609719bSwdenk
703a3ad8e26Swdenk		When CONFIG_SILENT_CONSOLE is defined, all console
704a3ad8e26Swdenk		messages (by U-Boot and Linux!) can be silenced with
705a3ad8e26Swdenk		the "silent" environment variable. See
706a3ad8e26Swdenk		doc/README.silent for more information.
707a3ad8e26Swdenk
708*45ae2546SHeiko Schocher		CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default
709*45ae2546SHeiko Schocher			is 0x00.
710*45ae2546SHeiko Schocher		CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default
711*45ae2546SHeiko Schocher			is 0xa0.
712*45ae2546SHeiko Schocher
713c609719bSwdenk- Console Baudrate:
714c609719bSwdenk		CONFIG_BAUDRATE - in bps
715c609719bSwdenk		Select one of the baudrates listed in
7166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
7176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
718c609719bSwdenk
719c92fac91SHeiko Schocher- Console Rx buffer length
720c92fac91SHeiko Schocher		With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
721c92fac91SHeiko Schocher		the maximum receive buffer length for the SMC.
7222b3f12c2SHeiko Schocher		This option is actual only for 82xx and 8xx possible.
723c92fac91SHeiko Schocher		If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
724c92fac91SHeiko Schocher		must be defined, to setup the maximum idle timeout for
725c92fac91SHeiko Schocher		the SMC.
726c92fac91SHeiko Schocher
7279558b48aSGraeme Russ- Pre-Console Buffer:
7289558b48aSGraeme Russ		Prior to the console being initialised (i.e. serial UART
7299558b48aSGraeme Russ		initialised etc) all console output is silently discarded.
7309558b48aSGraeme Russ		Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
7319558b48aSGraeme Russ		buffer any console messages prior to the console being
7329558b48aSGraeme Russ		initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
7339558b48aSGraeme Russ		bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
7349558b48aSGraeme Russ		a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
7359558b48aSGraeme Russ		bytes are output before the console is initialised, the
7369558b48aSGraeme Russ		earlier bytes are discarded.
7379558b48aSGraeme Russ
7389558b48aSGraeme Russ		'Sane' compilers will generate smaller code if
7399558b48aSGraeme Russ		CONFIG_PRE_CON_BUF_SZ is a power of 2
7409558b48aSGraeme Russ
741046a37bdSSonny Rao- Safe printf() functions
742046a37bdSSonny Rao		Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
743046a37bdSSonny Rao		the printf() functions. These are defined in
744046a37bdSSonny Rao		include/vsprintf.h and include snprintf(), vsnprintf() and
745046a37bdSSonny Rao		so on. Code size increase is approximately 300-500 bytes.
746046a37bdSSonny Rao		If this option is not given then these functions will
747046a37bdSSonny Rao		silently discard their buffer size argument - this means
748046a37bdSSonny Rao		you are not getting any overflow checking in this case.
749046a37bdSSonny Rao
750c609719bSwdenk- Boot Delay:	CONFIG_BOOTDELAY - in seconds
751c609719bSwdenk		Delay before automatically booting the default image;
752c609719bSwdenk		set to -1 to disable autoboot.
75393d7212fSJoe Hershberger		set to -2 to autoboot with no delay and not check for abort
75493d7212fSJoe Hershberger		(even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
755c609719bSwdenk
756c609719bSwdenk		See doc/README.autoboot for these options that
757c609719bSwdenk		work with CONFIG_BOOTDELAY. None are required.
758c609719bSwdenk		CONFIG_BOOT_RETRY_TIME
759c609719bSwdenk		CONFIG_BOOT_RETRY_MIN
760c609719bSwdenk		CONFIG_AUTOBOOT_KEYED
761c609719bSwdenk		CONFIG_AUTOBOOT_PROMPT
762c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR
763c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR
764c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR2
765c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR2
766c609719bSwdenk		CONFIG_ZERO_BOOTDELAY_CHECK
767c609719bSwdenk		CONFIG_RESET_TO_RETRY
768c609719bSwdenk
769c609719bSwdenk- Autoboot Command:
770c609719bSwdenk		CONFIG_BOOTCOMMAND
771c609719bSwdenk		Only needed when CONFIG_BOOTDELAY is enabled;
772c609719bSwdenk		define a command string that is automatically executed
773c609719bSwdenk		when no character is read on the console interface
774c609719bSwdenk		within "Boot Delay" after reset.
775c609719bSwdenk
776c609719bSwdenk		CONFIG_BOOTARGS
777c609719bSwdenk		This can be used to pass arguments to the bootm
778c609719bSwdenk		command. The value of CONFIG_BOOTARGS goes into the
779c609719bSwdenk		environment value "bootargs".
780c609719bSwdenk
781c609719bSwdenk		CONFIG_RAMBOOT and CONFIG_NFSBOOT
782c609719bSwdenk		The value of these goes into the environment as
783c609719bSwdenk		"ramboot" and "nfsboot" respectively, and can be used
784c609719bSwdenk		as a convenience, when switching between booting from
78511ccc33fSMarcel Ziswiler		RAM and NFS.
786c609719bSwdenk
787c609719bSwdenk- Pre-Boot Commands:
788c609719bSwdenk		CONFIG_PREBOOT
789c609719bSwdenk
790c609719bSwdenk		When this option is #defined, the existence of the
791c609719bSwdenk		environment variable "preboot" will be checked
792c609719bSwdenk		immediately before starting the CONFIG_BOOTDELAY
793c609719bSwdenk		countdown and/or running the auto-boot command resp.
794c609719bSwdenk		entering interactive mode.
795c609719bSwdenk
796c609719bSwdenk		This feature is especially useful when "preboot" is
797c609719bSwdenk		automatically generated or modified. For an example
798c609719bSwdenk		see the LWMON board specific code: here "preboot" is
799c609719bSwdenk		modified when the user holds down a certain
800c609719bSwdenk		combination of keys on the (special) keyboard when
801c609719bSwdenk		booting the systems
802c609719bSwdenk
803c609719bSwdenk- Serial Download Echo Mode:
804c609719bSwdenk		CONFIG_LOADS_ECHO
805c609719bSwdenk		If defined to 1, all characters received during a
806c609719bSwdenk		serial download (using the "loads" command) are
807c609719bSwdenk		echoed back. This might be needed by some terminal
808c609719bSwdenk		emulations (like "cu"), but may as well just take
809c609719bSwdenk		time on others. This setting #define's the initial
810c609719bSwdenk		value of the "loads_echo" environment variable.
811c609719bSwdenk
812602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
813c609719bSwdenk		CONFIG_KGDB_BAUDRATE
814c609719bSwdenk		Select one of the baudrates listed in
8156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
816c609719bSwdenk
817c609719bSwdenk- Monitor Functions:
818602ad3b3SJon Loeliger		Monitor commands can be included or excluded
819602ad3b3SJon Loeliger		from the build by using the #include files
820c6c621bdSStephen Warren		<config_cmd_all.h> and #undef'ing unwanted
821c6c621bdSStephen Warren		commands, or using <config_cmd_default.h>
822602ad3b3SJon Loeliger		and augmenting with additional #define's
823602ad3b3SJon Loeliger		for wanted commands.
824c609719bSwdenk
825602ad3b3SJon Loeliger		The default command configuration includes all commands
826602ad3b3SJon Loeliger		except those marked below with a "*".
827602ad3b3SJon Loeliger
828602ad3b3SJon Loeliger		CONFIG_CMD_ASKENV	* ask for env variable
829602ad3b3SJon Loeliger		CONFIG_CMD_BDI		  bdinfo
830602ad3b3SJon Loeliger		CONFIG_CMD_BEDBUG	* Include BedBug Debugger
831602ad3b3SJon Loeliger		CONFIG_CMD_BMP		* BMP support
832602ad3b3SJon Loeliger		CONFIG_CMD_BSP		* Board specific commands
833602ad3b3SJon Loeliger		CONFIG_CMD_BOOTD	  bootd
834602ad3b3SJon Loeliger		CONFIG_CMD_CACHE	* icache, dcache
835602ad3b3SJon Loeliger		CONFIG_CMD_CONSOLE	  coninfo
836710b9938SMike Frysinger		CONFIG_CMD_CRC32	* crc32
837602ad3b3SJon Loeliger		CONFIG_CMD_DATE		* support for RTC, date/time...
838602ad3b3SJon Loeliger		CONFIG_CMD_DHCP		* DHCP support
839602ad3b3SJon Loeliger		CONFIG_CMD_DIAG		* Diagnostics
840a7c93104SPeter Tyser		CONFIG_CMD_DS4510	* ds4510 I2C gpio commands
841a7c93104SPeter Tyser		CONFIG_CMD_DS4510_INFO	* ds4510 I2C info command
842a7c93104SPeter Tyser		CONFIG_CMD_DS4510_MEM	* ds4510 I2C eeprom/sram commansd
843a7c93104SPeter Tyser		CONFIG_CMD_DS4510_RST	* ds4510 I2C rst command
844602ad3b3SJon Loeliger		CONFIG_CMD_DTT		* Digital Therm and Thermostat
845602ad3b3SJon Loeliger		CONFIG_CMD_ECHO		  echo arguments
846246c6922SPeter Tyser		CONFIG_CMD_EDITENV	  edit env variable
847602ad3b3SJon Loeliger		CONFIG_CMD_EEPROM	* EEPROM read/write support
848602ad3b3SJon Loeliger		CONFIG_CMD_ELF		* bootelf, bootvx
8495e2b3e0cSJoe Hershberger		CONFIG_CMD_ENV_CALLBACK	* display details about env callbacks
850fffad71bSJoe Hershberger		CONFIG_CMD_ENV_FLAGS	* display details about env flags
8510c79cda0SMike Frysinger		CONFIG_CMD_EXPORTENV	* export the environment
85203e2ecf6SStephen Warren		CONFIG_CMD_EXT2		* ext2 command support
85303e2ecf6SStephen Warren		CONFIG_CMD_EXT4		* ext4 command support
854bdab39d3SMike Frysinger		CONFIG_CMD_SAVEENV	  saveenv
855602ad3b3SJon Loeliger		CONFIG_CMD_FDC		* Floppy Disk Support
85603e2ecf6SStephen Warren		CONFIG_CMD_FAT		* FAT command support
857602ad3b3SJon Loeliger		CONFIG_CMD_FDOS		* Dos diskette Support
858602ad3b3SJon Loeliger		CONFIG_CMD_FLASH	  flinfo, erase, protect
859602ad3b3SJon Loeliger		CONFIG_CMD_FPGA		  FPGA device initialization support
8604d98b5c8SVincent Stehlé		CONFIG_CMD_FUSE		* Device fuse support
86153fdc7efSAnton Staaf		CONFIG_CMD_GETTIME	* Get time since boot
862a641b979SMike Frysinger		CONFIG_CMD_GO		* the 'go' command (exec code)
863a000b795SKim Phillips		CONFIG_CMD_GREPENV	* search environment
864bf36c5d5SSimon Glass		CONFIG_CMD_HASH		* calculate hash / digest
865602ad3b3SJon Loeliger		CONFIG_CMD_HWFLOW	* RTS/CTS hw flow control
866602ad3b3SJon Loeliger		CONFIG_CMD_I2C		* I2C serial bus support
867602ad3b3SJon Loeliger		CONFIG_CMD_IDE		* IDE harddisk support
868602ad3b3SJon Loeliger		CONFIG_CMD_IMI		  iminfo
8698fdf1e0fSVipin Kumar		CONFIG_CMD_IMLS		  List all images found in NOR flash
8704d98b5c8SVincent Stehlé		CONFIG_CMD_IMLS_NAND	* List all images found in NAND flash
871602ad3b3SJon Loeliger		CONFIG_CMD_IMMAP	* IMMR dump support
8720c79cda0SMike Frysinger		CONFIG_CMD_IMPORTENV	* import an environment
873c167cc02SJoe Hershberger		CONFIG_CMD_INI		* import data from an ini file into the env
874602ad3b3SJon Loeliger		CONFIG_CMD_IRQ		* irqinfo
875602ad3b3SJon Loeliger		CONFIG_CMD_ITEST	  Integer/string test of 2 values
876602ad3b3SJon Loeliger		CONFIG_CMD_JFFS2	* JFFS2 Support
877602ad3b3SJon Loeliger		CONFIG_CMD_KGDB		* kgdb
8784d98b5c8SVincent Stehlé		CONFIG_CMD_LDRINFO	* ldrinfo (display Blackfin loader)
879d22c338eSJoe Hershberger		CONFIG_CMD_LINK_LOCAL	* link-local IP address auto-configuration
880d22c338eSJoe Hershberger					  (169.254.*.*)
881602ad3b3SJon Loeliger		CONFIG_CMD_LOADB	  loadb
882602ad3b3SJon Loeliger		CONFIG_CMD_LOADS	  loads
8834d98b5c8SVincent Stehlé		CONFIG_CMD_MD5SUM	* print md5 message digest
88402c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
88515a33e49SSimon Glass		CONFIG_CMD_MEMINFO	* Display detailed memory information
886602ad3b3SJon Loeliger		CONFIG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
887a2681707SWolfgang Denk					  loop, loopw
8884d98b5c8SVincent Stehlé		CONFIG_CMD_MEMTEST	* mtest
889602ad3b3SJon Loeliger		CONFIG_CMD_MISC		  Misc functions like sleep etc
890602ad3b3SJon Loeliger		CONFIG_CMD_MMC		* MMC memory mapped support
891602ad3b3SJon Loeliger		CONFIG_CMD_MII		* MII utility commands
89268d7d651SStefan Roese		CONFIG_CMD_MTDPARTS	* MTD partition support
893602ad3b3SJon Loeliger		CONFIG_CMD_NAND		* NAND support
894602ad3b3SJon Loeliger		CONFIG_CMD_NET		  bootp, tftpboot, rarpboot
8954d98b5c8SVincent Stehlé		CONFIG_CMD_NFS		  NFS support
896e92739d3SPeter Tyser		CONFIG_CMD_PCA953X	* PCA953x I2C gpio commands
897e92739d3SPeter Tyser		CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
898602ad3b3SJon Loeliger		CONFIG_CMD_PCI		* pciinfo
899602ad3b3SJon Loeliger		CONFIG_CMD_PCMCIA		* PCMCIA support
900602ad3b3SJon Loeliger		CONFIG_CMD_PING		* send ICMP ECHO_REQUEST to network
901602ad3b3SJon Loeliger					  host
902602ad3b3SJon Loeliger		CONFIG_CMD_PORTIO	* Port I/O
903ff048ea9SKenneth Waters		CONFIG_CMD_READ		* Read raw data from partition
904602ad3b3SJon Loeliger		CONFIG_CMD_REGINFO	* Register dump
905602ad3b3SJon Loeliger		CONFIG_CMD_RUN		  run command in env variable
906d304931fSSimon Glass		CONFIG_CMD_SANDBOX	* sb command to access sandbox features
907602ad3b3SJon Loeliger		CONFIG_CMD_SAVES	* save S record dump
908602ad3b3SJon Loeliger		CONFIG_CMD_SCSI		* SCSI Support
909602ad3b3SJon Loeliger		CONFIG_CMD_SDRAM	* print SDRAM configuration information
910602ad3b3SJon Loeliger					  (requires CONFIG_CMD_I2C)
911602ad3b3SJon Loeliger		CONFIG_CMD_SETGETDCR	  Support for DCR Register access
912602ad3b3SJon Loeliger					  (4xx only)
913f61ec45eSEric Nelson		CONFIG_CMD_SF		* Read/write/erase SPI NOR flash
9144d98b5c8SVincent Stehlé		CONFIG_CMD_SHA1SUM	* print sha1 memory digest
91502c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY)
9167d861d95SBob Liu		CONFIG_CMD_SOFTSWITCH	* Soft switch setting command for BF60x
91774de7aefSWolfgang Denk		CONFIG_CMD_SOURCE	  "source" command Support
918602ad3b3SJon Loeliger		CONFIG_CMD_SPI		* SPI serial bus support
9197a83af07SLuca Ceresoli		CONFIG_CMD_TFTPSRV	* TFTP transfer in server mode
9201fb7cd49SSimon Glass		CONFIG_CMD_TFTPPUT	* TFTP put command (upload)
921da83bcd7SJoe Hershberger		CONFIG_CMD_TIME		* run command and report execution time (ARM specific)
922da83bcd7SJoe Hershberger		CONFIG_CMD_TIMER	* access to the system tick timer
923602ad3b3SJon Loeliger		CONFIG_CMD_USB		* USB support
924602ad3b3SJon Loeliger		CONFIG_CMD_CDP		* Cisco Discover Protocol support
925c8339f51SMarek Vasut		CONFIG_CMD_MFSL		* Microblaze FSL support
9264d98b5c8SVincent Stehlé		CONFIG_CMD_XIMG		  Load part of Multi Image
927c609719bSwdenk
928c609719bSwdenk
929c609719bSwdenk		EXAMPLE: If you want all functions except of network
930c609719bSwdenk		support you can write:
931c609719bSwdenk
932602ad3b3SJon Loeliger		#include "config_cmd_all.h"
933602ad3b3SJon Loeliger		#undef CONFIG_CMD_NET
934c609719bSwdenk
935213bf8c8SGerald Van Baren	Other Commands:
936213bf8c8SGerald Van Baren		fdt (flattened device tree) command: CONFIG_OF_LIBFDT
937c609719bSwdenk
938c609719bSwdenk	Note:	Don't enable the "icache" and "dcache" commands
939602ad3b3SJon Loeliger		(configuration option CONFIG_CMD_CACHE) unless you know
940c609719bSwdenk		what you (and your U-Boot users) are doing. Data
941c609719bSwdenk		cache cannot be enabled on systems like the 8xx or
942c609719bSwdenk		8260 (where accesses to the IMMR region must be
943c609719bSwdenk		uncached), and it cannot be disabled on all other
944c609719bSwdenk		systems where we (mis-) use the data cache to hold an
945c609719bSwdenk		initial stack and some data.
946c609719bSwdenk
947c609719bSwdenk
948c609719bSwdenk		XXX - this list needs to get updated!
949c609719bSwdenk
950a5ecbe62SWolfgang Denk- Regular expression support:
951a5ecbe62SWolfgang Denk		CONFIG_REGEX
952a5ecbe62SWolfgang Denk		If this variable is defined, U-Boot is linked against
953a5ecbe62SWolfgang Denk		the SLRE (Super Light Regular Expression) library,
954a5ecbe62SWolfgang Denk		which adds regex support to some commands, as for
955a5ecbe62SWolfgang Denk		example "env grep" and "setexpr".
956a5ecbe62SWolfgang Denk
95745ba8077SSimon Glass- Device tree:
95845ba8077SSimon Glass		CONFIG_OF_CONTROL
95945ba8077SSimon Glass		If this variable is defined, U-Boot will use a device tree
96045ba8077SSimon Glass		to configure its devices, instead of relying on statically
96145ba8077SSimon Glass		compiled #defines in the board file. This option is
96245ba8077SSimon Glass		experimental and only available on a few boards. The device
96345ba8077SSimon Glass		tree is available in the global data as gd->fdt_blob.
96445ba8077SSimon Glass
9652c0f79e4SSimon Glass		U-Boot needs to get its device tree from somewhere. This can
9662c0f79e4SSimon Glass		be done using one of the two options below:
967bbb0b128SSimon Glass
968bbb0b128SSimon Glass		CONFIG_OF_EMBED
969bbb0b128SSimon Glass		If this variable is defined, U-Boot will embed a device tree
970bbb0b128SSimon Glass		binary in its image. This device tree file should be in the
971bbb0b128SSimon Glass		board directory and called <soc>-<board>.dts. The binary file
972bbb0b128SSimon Glass		is then picked up in board_init_f() and made available through
973bbb0b128SSimon Glass		the global data structure as gd->blob.
97445ba8077SSimon Glass
9752c0f79e4SSimon Glass		CONFIG_OF_SEPARATE
9762c0f79e4SSimon Glass		If this variable is defined, U-Boot will build a device tree
9772c0f79e4SSimon Glass		binary. It will be called u-boot.dtb. Architecture-specific
9782c0f79e4SSimon Glass		code will locate it at run-time. Generally this works by:
9792c0f79e4SSimon Glass
9802c0f79e4SSimon Glass			cat u-boot.bin u-boot.dtb >image.bin
9812c0f79e4SSimon Glass
9822c0f79e4SSimon Glass		and in fact, U-Boot does this for you, creating a file called
9832c0f79e4SSimon Glass		u-boot-dtb.bin which is useful in the common case. You can
9842c0f79e4SSimon Glass		still use the individual files if you need something more
9852c0f79e4SSimon Glass		exotic.
9862c0f79e4SSimon Glass
987c609719bSwdenk- Watchdog:
988c609719bSwdenk		CONFIG_WATCHDOG
989c609719bSwdenk		If this variable is defined, it enables watchdog
9906abe6fb6SDetlev Zundel		support for the SoC. There must be support in the SoC
9916abe6fb6SDetlev Zundel		specific code for a watchdog. For the 8xx and 8260
9926abe6fb6SDetlev Zundel		CPUs, the SIU Watchdog feature is enabled in the SYPCR
9936abe6fb6SDetlev Zundel		register.  When supported for a specific SoC is
9946abe6fb6SDetlev Zundel		available, then no further board specific code should
9956abe6fb6SDetlev Zundel		be needed to use it.
9966abe6fb6SDetlev Zundel
9976abe6fb6SDetlev Zundel		CONFIG_HW_WATCHDOG
9986abe6fb6SDetlev Zundel		When using a watchdog circuitry external to the used
9996abe6fb6SDetlev Zundel		SoC, then define this variable and provide board
10006abe6fb6SDetlev Zundel		specific code for the "hw_watchdog_reset" function.
1001c609719bSwdenk
1002c1551ea8Sstroese- U-Boot Version:
1003c1551ea8Sstroese		CONFIG_VERSION_VARIABLE
1004c1551ea8Sstroese		If this variable is defined, an environment variable
1005c1551ea8Sstroese		named "ver" is created by U-Boot showing the U-Boot
1006c1551ea8Sstroese		version as printed by the "version" command.
1007a1ea8e51SBenoît Thébaudeau		Any change to this variable will be reverted at the
1008a1ea8e51SBenoît Thébaudeau		next reset.
1009c1551ea8Sstroese
1010c609719bSwdenk- Real-Time Clock:
1011c609719bSwdenk
1012602ad3b3SJon Loeliger		When CONFIG_CMD_DATE is selected, the type of the RTC
1013c609719bSwdenk		has to be selected, too. Define exactly one of the
1014c609719bSwdenk		following options:
1015c609719bSwdenk
1016c609719bSwdenk		CONFIG_RTC_MPC8xx	- use internal RTC of MPC8xx
1017c609719bSwdenk		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
10184e8b7544SFabio Estevam		CONFIG_RTC_MC13XXX	- use MC13783 or MC13892 RTC
1019c609719bSwdenk		CONFIG_RTC_MC146818	- use MC146818 RTC
10201cb8e980Swdenk		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
1021c609719bSwdenk		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
10227f70e853Swdenk		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
10233bac3513Swdenk		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
10249536dfccSTor Krill		CONFIG_RTC_ISL1208	- use Intersil ISL1208 RTC
10254c0d4c3bSwdenk		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
10266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_DS1337_NOOSC	- Turn off the OSC output for DS1337
102771d19f30SHeiko Schocher		CONFIG_SYS_RV3029_TCR	- enable trickle charger on
102871d19f30SHeiko Schocher					  RV3029 RTC.
1029c609719bSwdenk
1030b37c7e5eSwdenk		Note that if the RTC uses I2C, then the I2C interface
1031b37c7e5eSwdenk		must also be configured. See I2C Support, below.
1032b37c7e5eSwdenk
1033e92739d3SPeter Tyser- GPIO Support:
1034e92739d3SPeter Tyser		CONFIG_PCA953X		- use NXP's PCA953X series I2C GPIO
1035e92739d3SPeter Tyser		CONFIG_PCA953X_INFO	- enable pca953x info command
1036e92739d3SPeter Tyser
10375dec49caSChris Packham		The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
10385dec49caSChris Packham		chip-ngpio pairs that tell the PCA953X driver the number of
10395dec49caSChris Packham		pins supported by a particular chip.
10405dec49caSChris Packham
1041e92739d3SPeter Tyser		Note that if the GPIO device uses I2C, then the I2C interface
1042e92739d3SPeter Tyser		must also be configured. See I2C Support, below.
1043e92739d3SPeter Tyser
1044c609719bSwdenk- Timestamp Support:
1045c609719bSwdenk
1046c609719bSwdenk		When CONFIG_TIMESTAMP is selected, the timestamp
1047c609719bSwdenk		(date and time) of an image is printed by image
1048c609719bSwdenk		commands like bootm or iminfo. This option is
1049602ad3b3SJon Loeliger		automatically enabled when you select CONFIG_CMD_DATE .
1050c609719bSwdenk
1051923c46f9SKarl O. Pinc- Partition Labels (disklabels) Supported:
1052923c46f9SKarl O. Pinc		Zero or more of the following:
1053923c46f9SKarl O. Pinc		CONFIG_MAC_PARTITION   Apple's MacOS partition table.
1054923c46f9SKarl O. Pinc		CONFIG_DOS_PARTITION   MS Dos partition table, traditional on the
1055923c46f9SKarl O. Pinc				       Intel architecture, USB sticks, etc.
1056923c46f9SKarl O. Pinc		CONFIG_ISO_PARTITION   ISO partition table, used on CDROM etc.
1057923c46f9SKarl O. Pinc		CONFIG_EFI_PARTITION   GPT partition table, common when EFI is the
1058923c46f9SKarl O. Pinc				       bootloader.  Note 2TB partition limit; see
1059923c46f9SKarl O. Pinc				       disk/part_efi.c
1060923c46f9SKarl O. Pinc		CONFIG_MTD_PARTITIONS  Memory Technology Device partition table.
1061c609719bSwdenk
1062602ad3b3SJon Loeliger		If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1063218ca724SWolfgang Denk		CONFIG_CMD_SCSI) you must configure support for at
1064923c46f9SKarl O. Pinc		least one non-MTD partition type as well.
1065c609719bSwdenk
1066c609719bSwdenk- IDE Reset method:
10674d13cbadSwdenk		CONFIG_IDE_RESET_ROUTINE - this is defined in several
10684d13cbadSwdenk		board configurations files but used nowhere!
1069c609719bSwdenk
10704d13cbadSwdenk		CONFIG_IDE_RESET - is this is defined, IDE Reset will
10714d13cbadSwdenk		be performed by calling the function
10724d13cbadSwdenk			ide_set_reset(int reset)
10734d13cbadSwdenk		which has to be defined in a board specific file
1074c609719bSwdenk
1075c609719bSwdenk- ATAPI Support:
1076c609719bSwdenk		CONFIG_ATAPI
1077c609719bSwdenk
1078c609719bSwdenk		Set this to enable ATAPI support.
1079c609719bSwdenk
1080c40b2956Swdenk- LBA48 Support
1081c40b2956Swdenk		CONFIG_LBA48
1082c40b2956Swdenk
1083c40b2956Swdenk		Set this to enable support for disks larger than 137GB
10844b142febSHeiko Schocher		Also look at CONFIG_SYS_64BIT_LBA.
1085c40b2956Swdenk		Whithout these , LBA48 support uses 32bit variables and will 'only'
1086c40b2956Swdenk		support disks up to 2.1TB.
1087c40b2956Swdenk
10886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_64BIT_LBA:
1089c40b2956Swdenk			When enabled, makes the IDE subsystem use 64bit sector addresses.
1090c40b2956Swdenk			Default is 32bit.
1091c40b2956Swdenk
1092c609719bSwdenk- SCSI Support:
1093c609719bSwdenk		At the moment only there is only support for the
1094c609719bSwdenk		SYM53C8XX SCSI controller; define
1095c609719bSwdenk		CONFIG_SCSI_SYM53C8XX to enable it.
1096c609719bSwdenk
10976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
10986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
10996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
1100c609719bSwdenk		maximum numbers of LUNs, SCSI ID's and target
1101c609719bSwdenk		devices.
11026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
1103c609719bSwdenk
1104447c031bSStefan Reinauer		The environment variable 'scsidevs' is set to the number of
1105447c031bSStefan Reinauer		SCSI devices found during the last scan.
1106447c031bSStefan Reinauer
1107c609719bSwdenk- NETWORK Support (PCI):
1108682011ffSwdenk		CONFIG_E1000
1109ce5207e1SKyle Moffett		Support for Intel 8254x/8257x gigabit chips.
1110ce5207e1SKyle Moffett
1111ce5207e1SKyle Moffett		CONFIG_E1000_SPI
1112ce5207e1SKyle Moffett		Utility code for direct access to the SPI bus on Intel 8257x.
1113ce5207e1SKyle Moffett		This does not do anything useful unless you set at least one
1114ce5207e1SKyle Moffett		of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1115ce5207e1SKyle Moffett
1116ce5207e1SKyle Moffett		CONFIG_E1000_SPI_GENERIC
1117ce5207e1SKyle Moffett		Allow generic access to the SPI bus on the Intel 8257x, for
1118ce5207e1SKyle Moffett		example with the "sspi" command.
1119ce5207e1SKyle Moffett
1120ce5207e1SKyle Moffett		CONFIG_CMD_E1000
1121ce5207e1SKyle Moffett		Management command for E1000 devices.  When used on devices
1122ce5207e1SKyle Moffett		with SPI support you can reprogram the EEPROM from U-Boot.
1123682011ffSwdenk
1124ac3315c2SAndre Schwarz		CONFIG_E1000_FALLBACK_MAC
112511ccc33fSMarcel Ziswiler		default MAC for empty EEPROM after production.
1126ac3315c2SAndre Schwarz
1127c609719bSwdenk		CONFIG_EEPRO100
1128c609719bSwdenk		Support for Intel 82557/82559/82559ER chips.
112911ccc33fSMarcel Ziswiler		Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
1130c609719bSwdenk		write routine for first time initialisation.
1131c609719bSwdenk
1132c609719bSwdenk		CONFIG_TULIP
1133c609719bSwdenk		Support for Digital 2114x chips.
1134c609719bSwdenk		Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1135c609719bSwdenk		modem chip initialisation (KS8761/QS6611).
1136c609719bSwdenk
1137c609719bSwdenk		CONFIG_NATSEMI
1138c609719bSwdenk		Support for National dp83815 chips.
1139c609719bSwdenk
1140c609719bSwdenk		CONFIG_NS8382X
1141c609719bSwdenk		Support for National dp8382[01] gigabit chips.
1142c609719bSwdenk
114345219c46Swdenk- NETWORK Support (other):
114445219c46Swdenk
1145c041e9d2SJens Scharsig		CONFIG_DRIVER_AT91EMAC
1146c041e9d2SJens Scharsig		Support for AT91RM9200 EMAC.
1147c041e9d2SJens Scharsig
1148c041e9d2SJens Scharsig			CONFIG_RMII
1149c041e9d2SJens Scharsig			Define this to use reduced MII inteface
1150c041e9d2SJens Scharsig
1151c041e9d2SJens Scharsig			CONFIG_DRIVER_AT91EMAC_QUIET
1152c041e9d2SJens Scharsig			If this defined, the driver is quiet.
1153c041e9d2SJens Scharsig			The driver doen't show link status messages.
1154c041e9d2SJens Scharsig
1155efdd7319SRob Herring		CONFIG_CALXEDA_XGMAC
1156efdd7319SRob Herring		Support for the Calxeda XGMAC device
1157efdd7319SRob Herring
11583bb46d23SAshok		CONFIG_LAN91C96
115945219c46Swdenk		Support for SMSC's LAN91C96 chips.
116045219c46Swdenk
116145219c46Swdenk			CONFIG_LAN91C96_BASE
116245219c46Swdenk			Define this to hold the physical address
116345219c46Swdenk			of the LAN91C96's I/O space
116445219c46Swdenk
116545219c46Swdenk			CONFIG_LAN91C96_USE_32_BIT
116645219c46Swdenk			Define this to enable 32 bit addressing
116745219c46Swdenk
11683bb46d23SAshok		CONFIG_SMC91111
1169f39748aeSwdenk		Support for SMSC's LAN91C111 chip
1170f39748aeSwdenk
1171f39748aeSwdenk			CONFIG_SMC91111_BASE
1172f39748aeSwdenk			Define this to hold the physical address
1173f39748aeSwdenk			of the device (I/O space)
1174f39748aeSwdenk
1175f39748aeSwdenk			CONFIG_SMC_USE_32_BIT
1176f39748aeSwdenk			Define this if data bus is 32 bits
1177f39748aeSwdenk
1178f39748aeSwdenk			CONFIG_SMC_USE_IOFUNCS
1179f39748aeSwdenk			Define this to use i/o functions instead of macros
1180f39748aeSwdenk			(some hardware wont work with macros)
1181f39748aeSwdenk
1182dc02badaSHeiko Schocher		CONFIG_DRIVER_TI_EMAC
1183dc02badaSHeiko Schocher		Support for davinci emac
1184dc02badaSHeiko Schocher
1185dc02badaSHeiko Schocher			CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1186dc02badaSHeiko Schocher			Define this if you have more then 3 PHYs.
1187dc02badaSHeiko Schocher
1188b3dbf4a5SMacpaul Lin		CONFIG_FTGMAC100
1189b3dbf4a5SMacpaul Lin		Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1190b3dbf4a5SMacpaul Lin
1191b3dbf4a5SMacpaul Lin			CONFIG_FTGMAC100_EGIGA
1192b3dbf4a5SMacpaul Lin			Define this to use GE link update with gigabit PHY.
1193b3dbf4a5SMacpaul Lin			Define this if FTGMAC100 is connected to gigabit PHY.
1194b3dbf4a5SMacpaul Lin			If your system has 10/100 PHY only, it might not occur
1195b3dbf4a5SMacpaul Lin			wrong behavior. Because PHY usually return timeout or
1196b3dbf4a5SMacpaul Lin			useless data when polling gigabit status and gigabit
1197b3dbf4a5SMacpaul Lin			control registers. This behavior won't affect the
1198b3dbf4a5SMacpaul Lin			correctnessof 10/100 link speed update.
1199b3dbf4a5SMacpaul Lin
1200c2fff331SMike Rapoport		CONFIG_SMC911X
1201557b377dSJens Gehrlein		Support for SMSC's LAN911x and LAN921x chips
1202557b377dSJens Gehrlein
1203c2fff331SMike Rapoport			CONFIG_SMC911X_BASE
1204557b377dSJens Gehrlein			Define this to hold the physical address
1205557b377dSJens Gehrlein			of the device (I/O space)
1206557b377dSJens Gehrlein
1207c2fff331SMike Rapoport			CONFIG_SMC911X_32_BIT
1208557b377dSJens Gehrlein			Define this if data bus is 32 bits
1209557b377dSJens Gehrlein
1210c2fff331SMike Rapoport			CONFIG_SMC911X_16_BIT
1211557b377dSJens Gehrlein			Define this if data bus is 16 bits. If your processor
1212557b377dSJens Gehrlein			automatically converts one 32 bit word to two 16 bit
1213c2fff331SMike Rapoport			words you may also try CONFIG_SMC911X_32_BIT.
1214557b377dSJens Gehrlein
12153d0075faSYoshihiro Shimoda		CONFIG_SH_ETHER
12163d0075faSYoshihiro Shimoda		Support for Renesas on-chip Ethernet controller
12173d0075faSYoshihiro Shimoda
12183d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_USE_PORT
12193d0075faSYoshihiro Shimoda			Define the number of ports to be used
12203d0075faSYoshihiro Shimoda
12213d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_PHY_ADDR
12223d0075faSYoshihiro Shimoda			Define the ETH PHY's address
12233d0075faSYoshihiro Shimoda
122468260aabSYoshihiro Shimoda			CONFIG_SH_ETHER_CACHE_WRITEBACK
122568260aabSYoshihiro Shimoda			If this option is set, the driver enables cache flush.
122668260aabSYoshihiro Shimoda
12275e124724SVadim Bendebury- TPM Support:
122890899cc0SChe-liang Chiou		CONFIG_TPM
122990899cc0SChe-liang Chiou		Support TPM devices.
123090899cc0SChe-liang Chiou
12311b393db5STom Wai-Hong Tam		CONFIG_TPM_TIS_I2C
12321b393db5STom Wai-Hong Tam		Support for i2c bus TPM devices. Only one device
12331b393db5STom Wai-Hong Tam		per system is supported at this time.
12341b393db5STom Wai-Hong Tam
12351b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_BUS_NUMBER
12361b393db5STom Wai-Hong Tam			Define the the i2c bus number for the TPM device
12371b393db5STom Wai-Hong Tam
12381b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS
12391b393db5STom Wai-Hong Tam			Define the TPM's address on the i2c bus
12401b393db5STom Wai-Hong Tam
12411b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_BURST_LIMITATION
12421b393db5STom Wai-Hong Tam			Define the burst count bytes upper limit
12431b393db5STom Wai-Hong Tam
1244c01939c7SDirk Eibach		CONFIG_TPM_ATMEL_TWI
1245c01939c7SDirk Eibach		Support for Atmel TWI TPM device. Requires I2C support.
1246c01939c7SDirk Eibach
124790899cc0SChe-liang Chiou		CONFIG_TPM_TIS_LPC
12485e124724SVadim Bendebury		Support for generic parallel port TPM devices. Only one device
12495e124724SVadim Bendebury		per system is supported at this time.
12505e124724SVadim Bendebury
12515e124724SVadim Bendebury			CONFIG_TPM_TIS_BASE_ADDRESS
12525e124724SVadim Bendebury			Base address where the generic TPM device is mapped
12535e124724SVadim Bendebury			to. Contemporary x86 systems usually map it at
12545e124724SVadim Bendebury			0xfed40000.
12555e124724SVadim Bendebury
1256be6c1529SReinhard Pfau		CONFIG_CMD_TPM
1257be6c1529SReinhard Pfau		Add tpm monitor functions.
1258be6c1529SReinhard Pfau		Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1259be6c1529SReinhard Pfau		provides monitor access to authorized functions.
1260be6c1529SReinhard Pfau
1261be6c1529SReinhard Pfau		CONFIG_TPM
1262be6c1529SReinhard Pfau		Define this to enable the TPM support library which provides
1263be6c1529SReinhard Pfau		functional interfaces to some TPM commands.
1264be6c1529SReinhard Pfau		Requires support for a TPM device.
1265be6c1529SReinhard Pfau
1266be6c1529SReinhard Pfau		CONFIG_TPM_AUTH_SESSIONS
1267be6c1529SReinhard Pfau		Define this to enable authorized functions in the TPM library.
1268be6c1529SReinhard Pfau		Requires CONFIG_TPM and CONFIG_SHA1.
1269be6c1529SReinhard Pfau
1270c609719bSwdenk- USB Support:
1271c609719bSwdenk		At the moment only the UHCI host controller is
12724d13cbadSwdenk		supported (PIP405, MIP405, MPC5200); define
1273c609719bSwdenk		CONFIG_USB_UHCI to enable it.
1274c609719bSwdenk		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
127530d56faeSwdenk		and define CONFIG_USB_STORAGE to enable the USB
1276c609719bSwdenk		storage devices.
1277c609719bSwdenk		Note:
1278c609719bSwdenk		Supported are USB Keyboards and USB Floppy drives
1279c609719bSwdenk		(TEAC FD-05PUB).
12804d13cbadSwdenk		MPC5200 USB requires additional defines:
12814d13cbadSwdenk			CONFIG_USB_CLOCK
12824d13cbadSwdenk				for 528 MHz Clock: 0x0001bbbb
1283307ecb6dSEric Millbrandt			CONFIG_PSC3_USB
1284307ecb6dSEric Millbrandt				for USB on PSC3
12854d13cbadSwdenk			CONFIG_USB_CONFIG
12864d13cbadSwdenk				for differential drivers: 0x00001000
12874d13cbadSwdenk				for single ended drivers: 0x00005000
1288307ecb6dSEric Millbrandt				for differential drivers on PSC3: 0x00000100
1289307ecb6dSEric Millbrandt				for single ended drivers on PSC3: 0x00004100
12906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_USB_EVENT_POLL
1291fdcfaa1bSZhang Wei				May be defined to allow interrupt polling
1292fdcfaa1bSZhang Wei				instead of using asynchronous interrupts
12934d13cbadSwdenk
12949ab4ce22SSimon Glass		CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
12959ab4ce22SSimon Glass		txfilltuning field in the EHCI controller on reset.
12969ab4ce22SSimon Glass
1297aa155058SKuo-Jung Su		CONFIG_USB_HUB_MIN_POWER_ON_DELAY defines the minimum
1298aa155058SKuo-Jung Su		interval for usb hub power-on delay.(minimum 100msec)
1299aa155058SKuo-Jung Su
130016c8d5e7SWolfgang Denk- USB Device:
130116c8d5e7SWolfgang Denk		Define the below if you wish to use the USB console.
130216c8d5e7SWolfgang Denk		Once firmware is rebuilt from a serial console issue the
130316c8d5e7SWolfgang Denk		command "setenv stdin usbtty; setenv stdout usbtty" and
130411ccc33fSMarcel Ziswiler		attach your USB cable. The Unix command "dmesg" should print
130516c8d5e7SWolfgang Denk		it has found a new device. The environment variable usbtty
130616c8d5e7SWolfgang Denk		can be set to gserial or cdc_acm to enable your device to
130716c8d5e7SWolfgang Denk		appear to a USB host as a Linux gserial device or a
130816c8d5e7SWolfgang Denk		Common Device Class Abstract Control Model serial device.
130916c8d5e7SWolfgang Denk		If you select usbtty = gserial you should be able to enumerate
131016c8d5e7SWolfgang Denk		a Linux host by
131116c8d5e7SWolfgang Denk		# modprobe usbserial vendor=0xVendorID product=0xProductID
131216c8d5e7SWolfgang Denk		else if using cdc_acm, simply setting the environment
131316c8d5e7SWolfgang Denk		variable usbtty to be cdc_acm should suffice. The following
131416c8d5e7SWolfgang Denk		might be defined in YourBoardName.h
131516c8d5e7SWolfgang Denk
131616c8d5e7SWolfgang Denk			CONFIG_USB_DEVICE
131716c8d5e7SWolfgang Denk			Define this to build a UDC device
131816c8d5e7SWolfgang Denk
131916c8d5e7SWolfgang Denk			CONFIG_USB_TTY
132016c8d5e7SWolfgang Denk			Define this to have a tty type of device available to
132116c8d5e7SWolfgang Denk			talk to the UDC device
132216c8d5e7SWolfgang Denk
1323f9da0f89SVipin KUMAR			CONFIG_USBD_HS
1324f9da0f89SVipin KUMAR			Define this to enable the high speed support for usb
1325f9da0f89SVipin KUMAR			device and usbtty. If this feature is enabled, a routine
1326f9da0f89SVipin KUMAR			int is_usbd_high_speed(void)
1327f9da0f89SVipin KUMAR			also needs to be defined by the driver to dynamically poll
1328f9da0f89SVipin KUMAR			whether the enumeration has succeded at high speed or full
1329f9da0f89SVipin KUMAR			speed.
1330f9da0f89SVipin KUMAR
13316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_IS_IN_ENV
133216c8d5e7SWolfgang Denk			Define this if you want stdin, stdout &/or stderr to
133316c8d5e7SWolfgang Denk			be set to usbtty.
133416c8d5e7SWolfgang Denk
133516c8d5e7SWolfgang Denk			mpc8xx:
13366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_EXTC_CLK 0xBLAH
133716c8d5e7SWolfgang Denk				Derive USB clock from external clock "blah"
13386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_EXTC_CLK 0x02
133916c8d5e7SWolfgang Denk
13406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_BRG_CLK 0xBLAH
134116c8d5e7SWolfgang Denk				Derive USB clock from brgclk
13426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_BRG_CLK 0x04
134316c8d5e7SWolfgang Denk
134416c8d5e7SWolfgang Denk		If you have a USB-IF assigned VendorID then you may wish to
134516c8d5e7SWolfgang Denk		define your own vendor specific values either in BoardName.h
134616c8d5e7SWolfgang Denk		or directly in usbd_vendor_info.h. If you don't define
134716c8d5e7SWolfgang Denk		CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
134816c8d5e7SWolfgang Denk		CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
134916c8d5e7SWolfgang Denk		should pretend to be a Linux device to it's target host.
135016c8d5e7SWolfgang Denk
135116c8d5e7SWolfgang Denk			CONFIG_USBD_MANUFACTURER
135216c8d5e7SWolfgang Denk			Define this string as the name of your company for
135316c8d5e7SWolfgang Denk			- CONFIG_USBD_MANUFACTURER "my company"
135416c8d5e7SWolfgang Denk
135516c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCT_NAME
135616c8d5e7SWolfgang Denk			Define this string as the name of your product
135716c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCT_NAME "acme usb device"
135816c8d5e7SWolfgang Denk
135916c8d5e7SWolfgang Denk			CONFIG_USBD_VENDORID
136016c8d5e7SWolfgang Denk			Define this as your assigned Vendor ID from the USB
136116c8d5e7SWolfgang Denk			Implementors Forum. This *must* be a genuine Vendor ID
136216c8d5e7SWolfgang Denk			to avoid polluting the USB namespace.
136316c8d5e7SWolfgang Denk			- CONFIG_USBD_VENDORID 0xFFFF
136416c8d5e7SWolfgang Denk
136516c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCTID
136616c8d5e7SWolfgang Denk			Define this as the unique Product ID
136716c8d5e7SWolfgang Denk			for your device
136816c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCTID 0xFFFF
1369c609719bSwdenk
1370d70a560fSIgor Grinberg- ULPI Layer Support:
1371d70a560fSIgor Grinberg		The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1372d70a560fSIgor Grinberg		the generic ULPI layer. The generic layer accesses the ULPI PHY
1373d70a560fSIgor Grinberg		via the platform viewport, so you need both the genric layer and
1374d70a560fSIgor Grinberg		the viewport enabled. Currently only Chipidea/ARC based
1375d70a560fSIgor Grinberg		viewport is supported.
1376d70a560fSIgor Grinberg		To enable the ULPI layer support, define CONFIG_USB_ULPI and
1377d70a560fSIgor Grinberg		CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
13786d365ea0SLucas Stach		If your ULPI phy needs a different reference clock than the
13796d365ea0SLucas Stach		standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
13806d365ea0SLucas Stach		the appropriate value in Hz.
1381c609719bSwdenk
1382c609719bSwdenk- MMC Support:
1383c609719bSwdenk		The MMC controller on the Intel PXA is supported. To
1384c609719bSwdenk		enable this define CONFIG_MMC. The MMC can be
1385c609719bSwdenk		accessed from the boot prompt by mapping the device
1386c609719bSwdenk		to physical memory similar to flash. Command line is
1387602ad3b3SJon Loeliger		enabled with CONFIG_CMD_MMC. The MMC driver also works with
1388602ad3b3SJon Loeliger		the FAT fs. This is enabled with CONFIG_CMD_FAT.
1389c609719bSwdenk
1390afb35666SYoshihiro Shimoda		CONFIG_SH_MMCIF
1391afb35666SYoshihiro Shimoda		Support for Renesas on-chip MMCIF controller
1392afb35666SYoshihiro Shimoda
1393afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_ADDR
1394afb35666SYoshihiro Shimoda			Define the base address of MMCIF registers
1395afb35666SYoshihiro Shimoda
1396afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_CLK
1397afb35666SYoshihiro Shimoda			Define the clock frequency for MMCIF
1398afb35666SYoshihiro Shimoda
1399b3ba6e94STom Rini- USB Device Firmware Update (DFU) class support:
1400b3ba6e94STom Rini		CONFIG_DFU_FUNCTION
1401b3ba6e94STom Rini		This enables the USB portion of the DFU USB class
1402b3ba6e94STom Rini
1403b3ba6e94STom Rini		CONFIG_CMD_DFU
1404b3ba6e94STom Rini		This enables the command "dfu" which is used to have
1405b3ba6e94STom Rini		U-Boot create a DFU class device via USB.  This command
1406b3ba6e94STom Rini		requires that the "dfu_alt_info" environment variable be
1407b3ba6e94STom Rini		set and define the alt settings to expose to the host.
1408b3ba6e94STom Rini
1409b3ba6e94STom Rini		CONFIG_DFU_MMC
1410b3ba6e94STom Rini		This enables support for exposing (e)MMC devices via DFU.
1411b3ba6e94STom Rini
1412c6631764SPantelis Antoniou		CONFIG_DFU_NAND
1413c6631764SPantelis Antoniou		This enables support for exposing NAND devices via DFU.
1414c6631764SPantelis Antoniou
1415a9479f04SAfzal Mohammed		CONFIG_DFU_RAM
1416a9479f04SAfzal Mohammed		This enables support for exposing RAM via DFU.
1417a9479f04SAfzal Mohammed		Note: DFU spec refer to non-volatile memory usage, but
1418a9479f04SAfzal Mohammed		allow usages beyond the scope of spec - here RAM usage,
1419a9479f04SAfzal Mohammed		one that would help mostly the developer.
1420a9479f04SAfzal Mohammed
1421e7e75c70SHeiko Schocher		CONFIG_SYS_DFU_DATA_BUF_SIZE
1422e7e75c70SHeiko Schocher		Dfu transfer uses a buffer before writing data to the
1423e7e75c70SHeiko Schocher		raw storage device. Make the size (in bytes) of this buffer
1424e7e75c70SHeiko Schocher		configurable. The size of this buffer is also configurable
1425e7e75c70SHeiko Schocher		through the "dfu_bufsiz" environment variable.
1426e7e75c70SHeiko Schocher
1427ea2453d5SPantelis Antoniou		CONFIG_SYS_DFU_MAX_FILE_SIZE
1428ea2453d5SPantelis Antoniou		When updating files rather than the raw storage device,
1429ea2453d5SPantelis Antoniou		we use a static buffer to copy the file into and then write
1430ea2453d5SPantelis Antoniou		the buffer once we've been given the whole file.  Define
1431ea2453d5SPantelis Antoniou		this to the maximum filesize (in bytes) for the buffer.
1432ea2453d5SPantelis Antoniou		Default is 4 MiB if undefined.
1433ea2453d5SPantelis Antoniou
14346705d81eSwdenk- Journaling Flash filesystem support:
14356705d81eSwdenk		CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
14366705d81eSwdenk		CONFIG_JFFS2_NAND_DEV
14376705d81eSwdenk		Define these for a default partition on a NAND device
14386705d81eSwdenk
14396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_SECTOR,
14406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
14416705d81eSwdenk		Define these for a default partition on a NOR device
14426705d81eSwdenk
14436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS_CUSTOM_PART
14446705d81eSwdenk		Define this to create an own partition. You have to provide a
14456705d81eSwdenk		function struct part_info* jffs2_part_info(int part_num)
14466705d81eSwdenk
14476705d81eSwdenk		If you define only one JFFS2 partition you may also want to
14486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_JFFS_SINGLE_PART	1
14496705d81eSwdenk		to disable the command chpart. This is the default when you
14506705d81eSwdenk		have not defined a custom partition
14516705d81eSwdenk
1452c30a15e5SDonggeun Kim- FAT(File Allocation Table) filesystem write function support:
1453c30a15e5SDonggeun Kim		CONFIG_FAT_WRITE
1454656f4c65SDonggeun Kim
1455656f4c65SDonggeun Kim		Define this to enable support for saving memory data as a
1456656f4c65SDonggeun Kim		file in FAT formatted partition.
1457656f4c65SDonggeun Kim
1458656f4c65SDonggeun Kim		This will also enable the command "fatwrite" enabling the
1459656f4c65SDonggeun Kim		user to write files to FAT.
1460c30a15e5SDonggeun Kim
146184cd9327SGabe BlackCBFS (Coreboot Filesystem) support
146284cd9327SGabe Black		CONFIG_CMD_CBFS
146384cd9327SGabe Black
146484cd9327SGabe Black		Define this to enable support for reading from a Coreboot
146584cd9327SGabe Black		filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
146684cd9327SGabe Black		and cbfsload.
146784cd9327SGabe Black
1468c609719bSwdenk- Keyboard Support:
1469c609719bSwdenk		CONFIG_ISA_KEYBOARD
1470c609719bSwdenk
1471c609719bSwdenk		Define this to enable standard (PC-Style) keyboard
1472c609719bSwdenk		support
1473c609719bSwdenk
1474c609719bSwdenk		CONFIG_I8042_KBD
1475c609719bSwdenk		Standard PC keyboard driver with US (is default) and
1476c609719bSwdenk		GERMAN key layout (switch via environment 'keymap=de') support.
1477c609719bSwdenk		Export function i8042_kbd_init, i8042_tstc and i8042_getc
1478c609719bSwdenk		for cfb_console. Supports cursor blinking.
1479c609719bSwdenk
1480713cb680SHung-ying Tyan		CONFIG_CROS_EC_KEYB
1481713cb680SHung-ying Tyan		Enables a Chrome OS keyboard using the CROS_EC interface.
1482713cb680SHung-ying Tyan		This uses CROS_EC to communicate with a second microcontroller
1483713cb680SHung-ying Tyan		which provides key scans on request.
1484713cb680SHung-ying Tyan
1485c609719bSwdenk- Video support:
1486c609719bSwdenk		CONFIG_VIDEO
1487c609719bSwdenk
1488c609719bSwdenk		Define this to enable video support (for output to
1489c609719bSwdenk		video).
1490c609719bSwdenk
1491c609719bSwdenk		CONFIG_VIDEO_CT69000
1492c609719bSwdenk
1493c609719bSwdenk		Enable Chips & Technologies 69000 Video chip
1494c609719bSwdenk
1495c609719bSwdenk		CONFIG_VIDEO_SMI_LYNXEM
1496eeb1b77bSwdenk		Enable Silicon Motion SMI 712/710/810 Video chip. The
1497eeb1b77bSwdenk		video output is selected via environment 'videoout'
1498eeb1b77bSwdenk		(1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1499eeb1b77bSwdenk		assumed.
1500c609719bSwdenk
1501eeb1b77bSwdenk		For the CT69000 and SMI_LYNXEM drivers, videomode is
150211ccc33fSMarcel Ziswiler		selected via environment 'videomode'. Two different ways
1503eeb1b77bSwdenk		are possible:
1504eeb1b77bSwdenk		- "videomode=num"   'num' is a standard LiLo mode numbers.
1505eeb1b77bSwdenk		Following standard modes are supported	(* is default):
1506eeb1b77bSwdenk
1507eeb1b77bSwdenk		      Colors	640x480 800x600 1024x768 1152x864 1280x1024
1508eeb1b77bSwdenk		-------------+---------------------------------------------
1509eeb1b77bSwdenk		      8 bits |	0x301*	0x303	 0x305	  0x161	    0x307
1510eeb1b77bSwdenk		     15 bits |	0x310	0x313	 0x316	  0x162	    0x319
1511eeb1b77bSwdenk		     16 bits |	0x311	0x314	 0x317	  0x163	    0x31A
1512eeb1b77bSwdenk		     24 bits |	0x312	0x315	 0x318	    ?	    0x31B
1513eeb1b77bSwdenk		-------------+---------------------------------------------
1514c609719bSwdenk		(i.e. setenv videomode 317; saveenv; reset;)
1515c609719bSwdenk
1516eeb1b77bSwdenk		- "videomode=bootargs" all the video parameters are parsed
15177817cb20SMarcel Ziswiler		from the bootargs. (See drivers/video/videomodes.c)
1518eeb1b77bSwdenk
1519eeb1b77bSwdenk
1520a6c7ad2fSwdenk		CONFIG_VIDEO_SED13806
1521a6c7ad2fSwdenk		Enable Epson SED13806 driver. This driver supports 8bpp
1522a6c7ad2fSwdenk		and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1523a6c7ad2fSwdenk		or CONFIG_VIDEO_SED13806_16BPP
1524a6c7ad2fSwdenk
15257d3053fbSTimur Tabi		CONFIG_FSL_DIU_FB
15267d3053fbSTimur Tabi		Enable the Freescale DIU video driver.	Reference boards for
15277d3053fbSTimur Tabi		SOCs that have a DIU should define this macro to enable DIU
15287d3053fbSTimur Tabi		support, and should also define these other macros:
15297d3053fbSTimur Tabi
15307d3053fbSTimur Tabi			CONFIG_SYS_DIU_ADDR
15317d3053fbSTimur Tabi			CONFIG_VIDEO
15327d3053fbSTimur Tabi			CONFIG_CMD_BMP
15337d3053fbSTimur Tabi			CONFIG_CFB_CONSOLE
15347d3053fbSTimur Tabi			CONFIG_VIDEO_SW_CURSOR
15357d3053fbSTimur Tabi			CONFIG_VGA_AS_SINGLE_DEVICE
15367d3053fbSTimur Tabi			CONFIG_VIDEO_LOGO
15377d3053fbSTimur Tabi			CONFIG_VIDEO_BMP_LOGO
15387d3053fbSTimur Tabi
1539ba8e76bdSTimur Tabi		The DIU driver will look for the 'video-mode' environment
1540ba8e76bdSTimur Tabi		variable, and if defined, enable the DIU as a console during
1541ba8e76bdSTimur Tabi		boot.  See the documentation file README.video for a
1542ba8e76bdSTimur Tabi		description of this variable.
15437d3053fbSTimur Tabi
1544058d59b0SSimon Glass		CONFIG_VIDEO_VGA
1545058d59b0SSimon Glass
1546058d59b0SSimon Glass		Enable the VGA video / BIOS for x86. The alternative if you
1547058d59b0SSimon Glass		are using coreboot is to use the coreboot frame buffer
1548058d59b0SSimon Glass		driver.
1549058d59b0SSimon Glass
1550058d59b0SSimon Glass
1551682011ffSwdenk- Keyboard Support:
1552682011ffSwdenk		CONFIG_KEYBOARD
1553682011ffSwdenk
1554682011ffSwdenk		Define this to enable a custom keyboard support.
1555682011ffSwdenk		This simply calls drv_keyboard_init() which must be
1556682011ffSwdenk		defined in your board-specific files.
1557682011ffSwdenk		The only board using this so far is RBC823.
1558a6c7ad2fSwdenk
1559c609719bSwdenk- LCD Support:	CONFIG_LCD
1560c609719bSwdenk
1561c609719bSwdenk		Define this to enable LCD support (for output to LCD
1562c609719bSwdenk		display); also select one of the supported displays
1563c609719bSwdenk		by defining one of these:
1564c609719bSwdenk
156539cf4804SStelian Pop		CONFIG_ATMEL_LCD:
156639cf4804SStelian Pop
156739cf4804SStelian Pop			HITACHI TX09D70VM1CCA, 3.5", 240x320.
156839cf4804SStelian Pop
1569fd3103bbSwdenk		CONFIG_NEC_NL6448AC33:
1570c609719bSwdenk
1571fd3103bbSwdenk			NEC NL6448AC33-18. Active, color, single scan.
1572c609719bSwdenk
1573fd3103bbSwdenk		CONFIG_NEC_NL6448BC20
1574c609719bSwdenk
1575fd3103bbSwdenk			NEC NL6448BC20-08. 6.5", 640x480.
1576fd3103bbSwdenk			Active, color, single scan.
1577fd3103bbSwdenk
1578fd3103bbSwdenk		CONFIG_NEC_NL6448BC33_54
1579fd3103bbSwdenk
1580fd3103bbSwdenk			NEC NL6448BC33-54. 10.4", 640x480.
1581c609719bSwdenk			Active, color, single scan.
1582c609719bSwdenk
1583c609719bSwdenk		CONFIG_SHARP_16x9
1584c609719bSwdenk
1585c609719bSwdenk			Sharp 320x240. Active, color, single scan.
1586c609719bSwdenk			It isn't 16x9, and I am not sure what it is.
1587c609719bSwdenk
1588c609719bSwdenk		CONFIG_SHARP_LQ64D341
1589c609719bSwdenk
1590c609719bSwdenk			Sharp LQ64D341 display, 640x480.
1591c609719bSwdenk			Active, color, single scan.
1592c609719bSwdenk
1593c609719bSwdenk		CONFIG_HLD1045
1594c609719bSwdenk
1595c609719bSwdenk			HLD1045 display, 640x480.
1596c609719bSwdenk			Active, color, single scan.
1597c609719bSwdenk
1598c609719bSwdenk		CONFIG_OPTREX_BW
1599c609719bSwdenk
1600c609719bSwdenk			Optrex	 CBL50840-2 NF-FW 99 22 M5
1601c609719bSwdenk			or
1602c609719bSwdenk			Hitachi	 LMG6912RPFC-00T
1603c609719bSwdenk			or
1604c609719bSwdenk			Hitachi	 SP14Q002
1605c609719bSwdenk
1606c609719bSwdenk			320x240. Black & white.
1607c609719bSwdenk
1608c609719bSwdenk		Normally display is black on white background; define
16096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
1610c609719bSwdenk
1611676d319eSSimon Glass		CONFIG_LCD_ALIGNMENT
1612676d319eSSimon Glass
1613676d319eSSimon Glass		Normally the LCD is page-aligned (tyically 4KB). If this is
1614676d319eSSimon Glass		defined then the LCD will be aligned to this value instead.
1615676d319eSSimon Glass		For ARM it is sometimes useful to use MMU_SECTION_SIZE
1616676d319eSSimon Glass		here, since it is cheaper to change data cache settings on
1617676d319eSSimon Glass		a per-section basis.
1618676d319eSSimon Glass
16190d89efefSSimon Glass		CONFIG_CONSOLE_SCROLL_LINES
16200d89efefSSimon Glass
16210d89efefSSimon Glass		When the console need to be scrolled, this is the number of
16220d89efefSSimon Glass		lines to scroll by. It defaults to 1. Increasing this makes
16230d89efefSSimon Glass		the console jump but can help speed up operation when scrolling
16240d89efefSSimon Glass		is slow.
1625676d319eSSimon Glass
162645d7f525STom Wai-Hong Tam		CONFIG_LCD_BMP_RLE8
162745d7f525STom Wai-Hong Tam
162845d7f525STom Wai-Hong Tam		Support drawing of RLE8-compressed bitmaps on the LCD.
162945d7f525STom Wai-Hong Tam
1630735987c5STom Wai-Hong Tam		CONFIG_I2C_EDID
1631735987c5STom Wai-Hong Tam
1632735987c5STom Wai-Hong Tam		Enables an 'i2c edid' command which can read EDID
1633735987c5STom Wai-Hong Tam		information over I2C from an attached LCD display.
1634735987c5STom Wai-Hong Tam
16357152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN
1636d791b1dcSwdenk
1637d791b1dcSwdenk		If this option is set, the environment is checked for
1638d791b1dcSwdenk		a variable "splashimage". If found, the usual display
1639d791b1dcSwdenk		of logo, copyright and system information on the LCD
1640e94d2cd9Swdenk		is suppressed and the BMP image at the address
1641d791b1dcSwdenk		specified in "splashimage" is loaded instead. The
1642d791b1dcSwdenk		console is redirected to the "nulldev", too. This
1643d791b1dcSwdenk		allows for a "silent" boot where a splash screen is
1644d791b1dcSwdenk		loaded very quickly after power-on.
1645d791b1dcSwdenk
1646c0880485SNikita Kiryanov		CONFIG_SPLASHIMAGE_GUARD
1647c0880485SNikita Kiryanov
1648c0880485SNikita Kiryanov		If this option is set, then U-Boot will prevent the environment
1649c0880485SNikita Kiryanov		variable "splashimage" from being set to a problematic address
1650c0880485SNikita Kiryanov		(see README.displaying-bmps and README.arm-unaligned-accesses).
1651c0880485SNikita Kiryanov		This option is useful for targets where, due to alignment
1652c0880485SNikita Kiryanov		restrictions, an improperly aligned BMP image will cause a data
1653c0880485SNikita Kiryanov		abort. If you think you will not have problems with unaligned
1654c0880485SNikita Kiryanov		accesses (for example because your toolchain prevents them)
1655c0880485SNikita Kiryanov		there is no need to set this option.
1656c0880485SNikita Kiryanov
16571ca298ceSMatthias Weisser		CONFIG_SPLASH_SCREEN_ALIGN
16581ca298ceSMatthias Weisser
16591ca298ceSMatthias Weisser		If this option is set the splash image can be freely positioned
16601ca298ceSMatthias Weisser		on the screen. Environment variable "splashpos" specifies the
16611ca298ceSMatthias Weisser		position as "x,y". If a positive number is given it is used as
16621ca298ceSMatthias Weisser		number of pixel from left/top. If a negative number is given it
16631ca298ceSMatthias Weisser		is used as number of pixel from right/bottom. You can also
16641ca298ceSMatthias Weisser		specify 'm' for centering the image.
16651ca298ceSMatthias Weisser
16661ca298ceSMatthias Weisser		Example:
16671ca298ceSMatthias Weisser		setenv splashpos m,m
16681ca298ceSMatthias Weisser			=> image at center of screen
16691ca298ceSMatthias Weisser
16701ca298ceSMatthias Weisser		setenv splashpos 30,20
16711ca298ceSMatthias Weisser			=> image at x = 30 and y = 20
16721ca298ceSMatthias Weisser
16731ca298ceSMatthias Weisser		setenv splashpos -10,m
16741ca298ceSMatthias Weisser			=> vertically centered image
16751ca298ceSMatthias Weisser			   at x = dspWidth - bmpWidth - 9
16761ca298ceSMatthias Weisser
167798f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
167898f4a3dfSStefan Roese
167998f4a3dfSStefan Roese		If this option is set, additionally to standard BMP
168098f4a3dfSStefan Roese		images, gzipped BMP images can be displayed via the
168198f4a3dfSStefan Roese		splashscreen support or the bmp command.
168298f4a3dfSStefan Roese
1683d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1684d5011762SAnatolij Gustschin
1685d5011762SAnatolij Gustschin		If this option is set, 8-bit RLE compressed BMP images
1686d5011762SAnatolij Gustschin		can be displayed via the splashscreen support or the
1687d5011762SAnatolij Gustschin		bmp command.
1688d5011762SAnatolij Gustschin
1689f2b96dfbSLei Wen- Do compresssing for memory range:
1690f2b96dfbSLei Wen		CONFIG_CMD_ZIP
1691f2b96dfbSLei Wen
1692f2b96dfbSLei Wen		If this option is set, it would use zlib deflate method
1693f2b96dfbSLei Wen		to compress the specified memory at its best effort.
1694f2b96dfbSLei Wen
1695c29fdfc1Swdenk- Compression support:
16968ef70478SKees Cook		CONFIG_GZIP
16978ef70478SKees Cook
16988ef70478SKees Cook		Enabled by default to support gzip compressed images.
16998ef70478SKees Cook
1700c29fdfc1Swdenk		CONFIG_BZIP2
1701c29fdfc1Swdenk
1702c29fdfc1Swdenk		If this option is set, support for bzip2 compressed
1703c29fdfc1Swdenk		images is included. If not, only uncompressed and gzip
1704c29fdfc1Swdenk		compressed images are supported.
1705c29fdfc1Swdenk
1706c29fdfc1Swdenk		NOTE: the bzip2 algorithm requires a lot of RAM, so
17076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
1708c29fdfc1Swdenk		be at least 4MB.
1709d791b1dcSwdenk
1710fc9c1727SLuigi 'Comio' Mantellini		CONFIG_LZMA
1711fc9c1727SLuigi 'Comio' Mantellini
1712fc9c1727SLuigi 'Comio' Mantellini		If this option is set, support for lzma compressed
1713fc9c1727SLuigi 'Comio' Mantellini		images is included.
1714fc9c1727SLuigi 'Comio' Mantellini
1715fc9c1727SLuigi 'Comio' Mantellini		Note: The LZMA algorithm adds between 2 and 4KB of code and it
1716fc9c1727SLuigi 'Comio' Mantellini		requires an amount of dynamic memory that is given by the
1717fc9c1727SLuigi 'Comio' Mantellini		formula:
1718fc9c1727SLuigi 'Comio' Mantellini
1719fc9c1727SLuigi 'Comio' Mantellini			(1846 + 768 << (lc + lp)) * sizeof(uint16)
1720fc9c1727SLuigi 'Comio' Mantellini
1721fc9c1727SLuigi 'Comio' Mantellini		Where lc and lp stand for, respectively, Literal context bits
1722fc9c1727SLuigi 'Comio' Mantellini		and Literal pos bits.
1723fc9c1727SLuigi 'Comio' Mantellini
1724fc9c1727SLuigi 'Comio' Mantellini		This value is upper-bounded by 14MB in the worst case. Anyway,
1725fc9c1727SLuigi 'Comio' Mantellini		for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1726fc9c1727SLuigi 'Comio' Mantellini		total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1727fc9c1727SLuigi 'Comio' Mantellini		a very small buffer.
1728fc9c1727SLuigi 'Comio' Mantellini
1729fc9c1727SLuigi 'Comio' Mantellini		Use the lzmainfo tool to determinate the lc and lp values and
1730fc9c1727SLuigi 'Comio' Mantellini		then calculate the amount of needed dynamic memory (ensuring
17316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the appropriate CONFIG_SYS_MALLOC_LEN value).
1732fc9c1727SLuigi 'Comio' Mantellini
17338ef70478SKees Cook		CONFIG_LZO
17348ef70478SKees Cook
17358ef70478SKees Cook		If this option is set, support for LZO compressed images
17368ef70478SKees Cook		is included.
17378ef70478SKees Cook
173817ea1177Swdenk- MII/PHY support:
173917ea1177Swdenk		CONFIG_PHY_ADDR
174017ea1177Swdenk
174117ea1177Swdenk		The address of PHY on MII bus.
174217ea1177Swdenk
174317ea1177Swdenk		CONFIG_PHY_CLOCK_FREQ (ppc4xx)
174417ea1177Swdenk
174517ea1177Swdenk		The clock frequency of the MII bus
174617ea1177Swdenk
174717ea1177Swdenk		CONFIG_PHY_GIGE
174817ea1177Swdenk
174917ea1177Swdenk		If this option is set, support for speed/duplex
175011ccc33fSMarcel Ziswiler		detection of gigabit PHY is included.
175117ea1177Swdenk
175217ea1177Swdenk		CONFIG_PHY_RESET_DELAY
175317ea1177Swdenk
175417ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
175517ea1177Swdenk		reset before any MII register access is possible.
175617ea1177Swdenk		For such PHY, set this option to the usec delay
175717ea1177Swdenk		required. (minimum 300usec for LXT971A)
175817ea1177Swdenk
175917ea1177Swdenk		CONFIG_PHY_CMD_DELAY (ppc4xx)
176017ea1177Swdenk
176117ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
176217ea1177Swdenk		command issued before MII status register can be read
176317ea1177Swdenk
1764c609719bSwdenk- Ethernet address:
1765c609719bSwdenk		CONFIG_ETHADDR
1766c68a05feSrichardretanubun		CONFIG_ETH1ADDR
1767c609719bSwdenk		CONFIG_ETH2ADDR
1768c609719bSwdenk		CONFIG_ETH3ADDR
1769c68a05feSrichardretanubun		CONFIG_ETH4ADDR
1770c68a05feSrichardretanubun		CONFIG_ETH5ADDR
1771c609719bSwdenk
177211ccc33fSMarcel Ziswiler		Define a default value for Ethernet address to use
177311ccc33fSMarcel Ziswiler		for the respective Ethernet interface, in case this
1774c609719bSwdenk		is not determined automatically.
1775c609719bSwdenk
1776c609719bSwdenk- IP address:
1777c609719bSwdenk		CONFIG_IPADDR
1778c609719bSwdenk
1779c609719bSwdenk		Define a default value for the IP address to use for
178011ccc33fSMarcel Ziswiler		the default Ethernet interface, in case this is not
1781c609719bSwdenk		determined through e.g. bootp.
17821ebcd654SWolfgang Denk		(Environment variable "ipaddr")
1783c609719bSwdenk
1784c609719bSwdenk- Server IP address:
1785c609719bSwdenk		CONFIG_SERVERIP
1786c609719bSwdenk
1787c609719bSwdenk		Defines a default value for the IP address of a TFTP
1788c609719bSwdenk		server to contact when using the "tftboot" command.
17891ebcd654SWolfgang Denk		(Environment variable "serverip")
1790c609719bSwdenk
179197cfe861SRobin Getz		CONFIG_KEEP_SERVERADDR
179297cfe861SRobin Getz
179397cfe861SRobin Getz		Keeps the server's MAC address, in the env 'serveraddr'
179497cfe861SRobin Getz		for passing to bootargs (like Linux's netconsole option)
179597cfe861SRobin Getz
17961ebcd654SWolfgang Denk- Gateway IP address:
17971ebcd654SWolfgang Denk		CONFIG_GATEWAYIP
17981ebcd654SWolfgang Denk
17991ebcd654SWolfgang Denk		Defines a default value for the IP address of the
18001ebcd654SWolfgang Denk		default router where packets to other networks are
18011ebcd654SWolfgang Denk		sent to.
18021ebcd654SWolfgang Denk		(Environment variable "gatewayip")
18031ebcd654SWolfgang Denk
18041ebcd654SWolfgang Denk- Subnet mask:
18051ebcd654SWolfgang Denk		CONFIG_NETMASK
18061ebcd654SWolfgang Denk
18071ebcd654SWolfgang Denk		Defines a default value for the subnet mask (or
18081ebcd654SWolfgang Denk		routing prefix) which is used to determine if an IP
18091ebcd654SWolfgang Denk		address belongs to the local subnet or needs to be
18101ebcd654SWolfgang Denk		forwarded through a router.
18111ebcd654SWolfgang Denk		(Environment variable "netmask")
18121ebcd654SWolfgang Denk
181353a5c424SDavid Updegraff- Multicast TFTP Mode:
181453a5c424SDavid Updegraff		CONFIG_MCAST_TFTP
181553a5c424SDavid Updegraff
181653a5c424SDavid Updegraff		Defines whether you want to support multicast TFTP as per
181753a5c424SDavid Updegraff		rfc-2090; for example to work with atftp.  Lets lots of targets
181811ccc33fSMarcel Ziswiler		tftp down the same boot image concurrently.  Note: the Ethernet
181953a5c424SDavid Updegraff		driver in use must provide a function: mcast() to join/leave a
182053a5c424SDavid Updegraff		multicast group.
182153a5c424SDavid Updegraff
1822c609719bSwdenk- BOOTP Recovery Mode:
1823c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY
1824c609719bSwdenk
1825c609719bSwdenk		If you have many targets in a network that try to
1826c609719bSwdenk		boot using BOOTP, you may want to avoid that all
1827c609719bSwdenk		systems send out BOOTP requests at precisely the same
1828c609719bSwdenk		moment (which would happen for instance at recovery
1829c609719bSwdenk		from a power failure, when all systems will try to
1830c609719bSwdenk		boot, thus flooding the BOOTP server. Defining
1831c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1832c609719bSwdenk		inserted before sending out BOOTP requests. The
18336c33c785SWolfgang Denk		following delays are inserted then:
1834c609719bSwdenk
1835c609719bSwdenk		1st BOOTP request:	delay 0 ... 1 sec
1836c609719bSwdenk		2nd BOOTP request:	delay 0 ... 2 sec
1837c609719bSwdenk		3rd BOOTP request:	delay 0 ... 4 sec
1838c609719bSwdenk		4th and following
1839c609719bSwdenk		BOOTP requests:		delay 0 ... 8 sec
1840c609719bSwdenk
1841fe389a82Sstroese- DHCP Advanced Options:
18421fe80d79SJon Loeliger		You can fine tune the DHCP functionality by defining
18431fe80d79SJon Loeliger		CONFIG_BOOTP_* symbols:
1844fe389a82Sstroese
18451fe80d79SJon Loeliger		CONFIG_BOOTP_SUBNETMASK
18461fe80d79SJon Loeliger		CONFIG_BOOTP_GATEWAY
18471fe80d79SJon Loeliger		CONFIG_BOOTP_HOSTNAME
18481fe80d79SJon Loeliger		CONFIG_BOOTP_NISDOMAIN
18491fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTPATH
18501fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTFILESIZE
18511fe80d79SJon Loeliger		CONFIG_BOOTP_DNS
18521fe80d79SJon Loeliger		CONFIG_BOOTP_DNS2
18531fe80d79SJon Loeliger		CONFIG_BOOTP_SEND_HOSTNAME
18541fe80d79SJon Loeliger		CONFIG_BOOTP_NTPSERVER
18551fe80d79SJon Loeliger		CONFIG_BOOTP_TIMEOFFSET
18561fe80d79SJon Loeliger		CONFIG_BOOTP_VENDOREX
18572c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL
1858fe389a82Sstroese
18595d110f0aSWilson Callan		CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
18605d110f0aSWilson Callan		environment variable, not the BOOTP server.
1861fe389a82Sstroese
18622c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
18632c00e099SJoe Hershberger		after the configured retry count, the call will fail
18642c00e099SJoe Hershberger		instead of starting over.  This can be used to fail over
18652c00e099SJoe Hershberger		to Link-local IP address configuration if the DHCP server
18662c00e099SJoe Hershberger		is not available.
18672c00e099SJoe Hershberger
1868fe389a82Sstroese		CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1869fe389a82Sstroese		serverip from a DHCP server, it is possible that more
1870fe389a82Sstroese		than one DNS serverip is offered to the client.
1871fe389a82Sstroese		If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1872fe389a82Sstroese		serverip will be stored in the additional environment
1873fe389a82Sstroese		variable "dnsip2". The first DNS serverip is always
1874fe389a82Sstroese		stored in the variable "dnsip", when CONFIG_BOOTP_DNS
18751fe80d79SJon Loeliger		is defined.
1876fe389a82Sstroese
1877fe389a82Sstroese		CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1878fe389a82Sstroese		to do a dynamic update of a DNS server. To do this, they
1879fe389a82Sstroese		need the hostname of the DHCP requester.
18805d110f0aSWilson Callan		If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
18811fe80d79SJon Loeliger		of the "hostname" environment variable is passed as
18821fe80d79SJon Loeliger		option 12 to the DHCP server.
1883fe389a82Sstroese
1884d9a2f416SAras Vaichas		CONFIG_BOOTP_DHCP_REQUEST_DELAY
1885d9a2f416SAras Vaichas
1886d9a2f416SAras Vaichas		A 32bit value in microseconds for a delay between
1887d9a2f416SAras Vaichas		receiving a "DHCP Offer" and sending the "DHCP Request".
1888d9a2f416SAras Vaichas		This fixes a problem with certain DHCP servers that don't
1889d9a2f416SAras Vaichas		respond 100% of the time to a "DHCP request". E.g. On an
1890d9a2f416SAras Vaichas		AT91RM9200 processor running at 180MHz, this delay needed
1891d9a2f416SAras Vaichas		to be *at least* 15,000 usec before a Windows Server 2003
1892d9a2f416SAras Vaichas		DHCP server would reply 100% of the time. I recommend at
1893d9a2f416SAras Vaichas		least 50,000 usec to be safe. The alternative is to hope
1894d9a2f416SAras Vaichas		that one of the retries will be successful but note that
1895d9a2f416SAras Vaichas		the DHCP timeout and retry process takes a longer than
1896d9a2f416SAras Vaichas		this delay.
1897d9a2f416SAras Vaichas
1898d22c338eSJoe Hershberger - Link-local IP address negotiation:
1899d22c338eSJoe Hershberger		Negotiate with other link-local clients on the local network
1900d22c338eSJoe Hershberger		for an address that doesn't require explicit configuration.
1901d22c338eSJoe Hershberger		This is especially useful if a DHCP server cannot be guaranteed
1902d22c338eSJoe Hershberger		to exist in all environments that the device must operate.
1903d22c338eSJoe Hershberger
1904d22c338eSJoe Hershberger		See doc/README.link-local for more information.
1905d22c338eSJoe Hershberger
1906a3d991bdSwdenk - CDP Options:
1907a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID
1908a3d991bdSwdenk
1909a3d991bdSwdenk		The device id used in CDP trigger frames.
1910a3d991bdSwdenk
1911a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID_PREFIX
1912a3d991bdSwdenk
1913a3d991bdSwdenk		A two character string which is prefixed to the MAC address
1914a3d991bdSwdenk		of the device.
1915a3d991bdSwdenk
1916a3d991bdSwdenk		CONFIG_CDP_PORT_ID
1917a3d991bdSwdenk
1918a3d991bdSwdenk		A printf format string which contains the ascii name of
1919a3d991bdSwdenk		the port. Normally is set to "eth%d" which sets
192011ccc33fSMarcel Ziswiler		eth0 for the first Ethernet, eth1 for the second etc.
1921a3d991bdSwdenk
1922a3d991bdSwdenk		CONFIG_CDP_CAPABILITIES
1923a3d991bdSwdenk
1924a3d991bdSwdenk		A 32bit integer which indicates the device capabilities;
1925a3d991bdSwdenk		0x00000010 for a normal host which does not forwards.
1926a3d991bdSwdenk
1927a3d991bdSwdenk		CONFIG_CDP_VERSION
1928a3d991bdSwdenk
1929a3d991bdSwdenk		An ascii string containing the version of the software.
1930a3d991bdSwdenk
1931a3d991bdSwdenk		CONFIG_CDP_PLATFORM
1932a3d991bdSwdenk
1933a3d991bdSwdenk		An ascii string containing the name of the platform.
1934a3d991bdSwdenk
1935a3d991bdSwdenk		CONFIG_CDP_TRIGGER
1936a3d991bdSwdenk
1937a3d991bdSwdenk		A 32bit integer sent on the trigger.
1938a3d991bdSwdenk
1939a3d991bdSwdenk		CONFIG_CDP_POWER_CONSUMPTION
1940a3d991bdSwdenk
1941a3d991bdSwdenk		A 16bit integer containing the power consumption of the
1942a3d991bdSwdenk		device in .1 of milliwatts.
1943a3d991bdSwdenk
1944a3d991bdSwdenk		CONFIG_CDP_APPLIANCE_VLAN_TYPE
1945a3d991bdSwdenk
1946a3d991bdSwdenk		A byte containing the id of the VLAN.
1947a3d991bdSwdenk
1948c609719bSwdenk- Status LED:	CONFIG_STATUS_LED
1949c609719bSwdenk
1950c609719bSwdenk		Several configurations allow to display the current
1951c609719bSwdenk		status using a LED. For instance, the LED will blink
1952c609719bSwdenk		fast while running U-Boot code, stop blinking as
1953c609719bSwdenk		soon as a reply to a BOOTP request was received, and
1954c609719bSwdenk		start blinking slow once the Linux kernel is running
1955c609719bSwdenk		(supported by a status LED driver in the Linux
1956c609719bSwdenk		kernel). Defining CONFIG_STATUS_LED enables this
1957c609719bSwdenk		feature in U-Boot.
1958c609719bSwdenk
1959c609719bSwdenk- CAN Support:	CONFIG_CAN_DRIVER
1960c609719bSwdenk
1961c609719bSwdenk		Defining CONFIG_CAN_DRIVER enables CAN driver support
1962c609719bSwdenk		on those systems that support this (optional)
1963c609719bSwdenk		feature, like the TQM8xxL modules.
1964c609719bSwdenk
19653f4978c7SHeiko Schocher- I2C Support:	CONFIG_SYS_I2C
1966c609719bSwdenk
19673f4978c7SHeiko Schocher		This enable the NEW i2c subsystem, and will allow you to use
19683f4978c7SHeiko Schocher		i2c commands at the u-boot command line (as long as you set
19693f4978c7SHeiko Schocher		CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
19703f4978c7SHeiko Schocher		based realtime clock chips or other i2c devices. See
19713f4978c7SHeiko Schocher		common/cmd_i2c.c for a description of the command line
19723f4978c7SHeiko Schocher		interface.
19733f4978c7SHeiko Schocher
19743f4978c7SHeiko Schocher		ported i2c driver to the new framework:
1975ea818dbbSHeiko Schocher		- drivers/i2c/soft_i2c.c:
1976ea818dbbSHeiko Schocher		  - activate first bus with CONFIG_SYS_I2C_SOFT define
1977ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
1978ea818dbbSHeiko Schocher		    for defining speed and slave address
1979ea818dbbSHeiko Schocher		  - activate second bus with I2C_SOFT_DECLARATIONS2 define
1980ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
1981ea818dbbSHeiko Schocher		    for defining speed and slave address
1982ea818dbbSHeiko Schocher		  - activate third bus with I2C_SOFT_DECLARATIONS3 define
1983ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
1984ea818dbbSHeiko Schocher		    for defining speed and slave address
1985ea818dbbSHeiko Schocher		  - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
1986ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
1987ea818dbbSHeiko Schocher		    for defining speed and slave address
19883f4978c7SHeiko Schocher
198900f792e0SHeiko Schocher		- drivers/i2c/fsl_i2c.c:
199000f792e0SHeiko Schocher		  - activate i2c driver with CONFIG_SYS_I2C_FSL
199100f792e0SHeiko Schocher		    define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
199200f792e0SHeiko Schocher		    offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
199300f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
199400f792e0SHeiko Schocher		    bus.
199500f792e0SHeiko Schocher		  - If your board supports a second fsl i2c bus, define
199600f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
199700f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_SPEED for the speed and
199800f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
199900f792e0SHeiko Schocher		    second bus.
200000f792e0SHeiko Schocher
20011f2ba722SSimon Glass		- drivers/i2c/tegra_i2c.c:
20021f2ba722SSimon Glass		  - activate this driver with CONFIG_SYS_I2C_TEGRA
20031f2ba722SSimon Glass		  - This driver adds 4 i2c buses with a fix speed from
20041f2ba722SSimon Glass		    100000 and the slave addr 0!
20051f2ba722SSimon Glass
2006880540deSDirk Eibach		- drivers/i2c/ppc4xx_i2c.c
2007880540deSDirk Eibach		  - activate this driver with CONFIG_SYS_I2C_PPC4XX
2008880540deSDirk Eibach		  - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2009880540deSDirk Eibach		  - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2010880540deSDirk Eibach
2011fac96408Strem		- drivers/i2c/i2c_mxc.c
2012fac96408Strem		  - activate this driver with CONFIG_SYS_I2C_MXC
2013fac96408Strem		  - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2014fac96408Strem		  - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2015fac96408Strem		  - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2016fac96408Strem		  - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2017fac96408Strem		  - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2018fac96408Strem		  - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
2019fac96408Strem		If thoses defines are not set, default value is 100000
2020fac96408Strem		for speed, and 0 for slave.
2021fac96408Strem
20221086bfa9SNobuhiro Iwamatsu		- drivers/i2c/rcar_i2c.c:
20231086bfa9SNobuhiro Iwamatsu		  - activate this driver with CONFIG_SYS_I2C_RCAR
20241086bfa9SNobuhiro Iwamatsu		  - This driver adds 4 i2c buses
20251086bfa9SNobuhiro Iwamatsu
20261086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
20271086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
20281086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
20291086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
20301086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
20311086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
20321086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
20331086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
20341086bfa9SNobuhiro Iwamatsu		  - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
20351086bfa9SNobuhiro Iwamatsu
20363f4978c7SHeiko Schocher		additional defines:
20373f4978c7SHeiko Schocher
20383f4978c7SHeiko Schocher		CONFIG_SYS_NUM_I2C_BUSES
20393f4978c7SHeiko Schocher		Hold the number of i2c busses you want to use. If you
20403f4978c7SHeiko Schocher		don't use/have i2c muxes on your i2c bus, this
20413f4978c7SHeiko Schocher		is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
20423f4978c7SHeiko Schocher		omit this define.
20433f4978c7SHeiko Schocher
20443f4978c7SHeiko Schocher		CONFIG_SYS_I2C_DIRECT_BUS
20453f4978c7SHeiko Schocher		define this, if you don't use i2c muxes on your hardware.
20463f4978c7SHeiko Schocher		if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
20473f4978c7SHeiko Schocher		omit this define.
20483f4978c7SHeiko Schocher
20493f4978c7SHeiko Schocher		CONFIG_SYS_I2C_MAX_HOPS
20503f4978c7SHeiko Schocher		define how many muxes are maximal consecutively connected
20513f4978c7SHeiko Schocher		on one i2c bus. If you not use i2c muxes, omit this
20523f4978c7SHeiko Schocher		define.
20533f4978c7SHeiko Schocher
20543f4978c7SHeiko Schocher		CONFIG_SYS_I2C_BUSES
20553f4978c7SHeiko Schocher		hold a list of busses you want to use, only used if
20563f4978c7SHeiko Schocher		CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
20573f4978c7SHeiko Schocher		a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
20583f4978c7SHeiko Schocher		CONFIG_SYS_NUM_I2C_BUSES = 9:
20593f4978c7SHeiko Schocher
20603f4978c7SHeiko Schocher		 CONFIG_SYS_I2C_BUSES	{{0, {I2C_NULL_HOP}}, \
20613f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
20623f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
20633f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
20643f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
20653f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
20663f4978c7SHeiko Schocher					{1, {I2C_NULL_HOP}}, \
20673f4978c7SHeiko Schocher					{1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
20683f4978c7SHeiko Schocher					{1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
20693f4978c7SHeiko Schocher					}
20703f4978c7SHeiko Schocher
20713f4978c7SHeiko Schocher		which defines
20723f4978c7SHeiko Schocher			bus 0 on adapter 0 without a mux
2073ea818dbbSHeiko Schocher			bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2074ea818dbbSHeiko Schocher			bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2075ea818dbbSHeiko Schocher			bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2076ea818dbbSHeiko Schocher			bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2077ea818dbbSHeiko Schocher			bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
20783f4978c7SHeiko Schocher			bus 6 on adapter 1 without a mux
2079ea818dbbSHeiko Schocher			bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2080ea818dbbSHeiko Schocher			bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
20813f4978c7SHeiko Schocher
20823f4978c7SHeiko Schocher		If you do not have i2c muxes on your board, omit this define.
20833f4978c7SHeiko Schocher
2084ea818dbbSHeiko Schocher- Legacy I2C Support:	CONFIG_HARD_I2C
20853f4978c7SHeiko Schocher
20863f4978c7SHeiko Schocher		NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
20873f4978c7SHeiko Schocher		provides the following compelling advantages:
20883f4978c7SHeiko Schocher
20893f4978c7SHeiko Schocher		- more than one i2c adapter is usable
20903f4978c7SHeiko Schocher		- approved multibus support
20913f4978c7SHeiko Schocher		- better i2c mux support
20923f4978c7SHeiko Schocher
20933f4978c7SHeiko Schocher		** Please consider updating your I2C driver now. **
20943f4978c7SHeiko Schocher
2095ea818dbbSHeiko Schocher		These enable legacy I2C serial bus commands. Defining
2096ea818dbbSHeiko Schocher		CONFIG_HARD_I2C will include the appropriate I2C driver
2097ea818dbbSHeiko Schocher		for the selected CPU.
2098c609719bSwdenk
2099b37c7e5eSwdenk		This will allow you to use i2c commands at the u-boot
2100602ad3b3SJon Loeliger		command line (as long as you set CONFIG_CMD_I2C in
2101b37c7e5eSwdenk		CONFIG_COMMANDS) and communicate with i2c based realtime
2102b37c7e5eSwdenk		clock chips. See common/cmd_i2c.c for a description of the
2103c609719bSwdenk		command line interface.
2104c609719bSwdenk
2105bb99ad6dSBen Warren		CONFIG_HARD_I2C selects a hardware I2C controller.
2106c609719bSwdenk
2107b37c7e5eSwdenk		There are several other quantities that must also be
2108ea818dbbSHeiko Schocher		defined when you define CONFIG_HARD_I2C.
2109c609719bSwdenk
21106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		In both cases you will need to define CONFIG_SYS_I2C_SPEED
2111b37c7e5eSwdenk		to be the frequency (in Hz) at which you wish your i2c bus
21126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
211311ccc33fSMarcel Ziswiler		the CPU's i2c node address).
2114c609719bSwdenk
21158d321b81SPeter Tyser		Now, the u-boot i2c code for the mpc8xx
2116a47a12beSStefan Roese		(arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
21178d321b81SPeter Tyser		and so its address should therefore be cleared to 0 (See,
21188d321b81SPeter Tyser		eg, MPC823e User's Manual p.16-473). So, set
21198d321b81SPeter Tyser		CONFIG_SYS_I2C_SLAVE to 0.
2120b37c7e5eSwdenk
21215da71efaSEric Millbrandt		CONFIG_SYS_I2C_INIT_MPC5XXX
21225da71efaSEric Millbrandt
21235da71efaSEric Millbrandt		When a board is reset during an i2c bus transfer
21245da71efaSEric Millbrandt		chips might think that the current transfer is still
21255da71efaSEric Millbrandt		in progress.  Reset the slave devices by sending start
21265da71efaSEric Millbrandt		commands until the slave device responds.
21275da71efaSEric Millbrandt
2128b37c7e5eSwdenk		That's all that's required for CONFIG_HARD_I2C.
2129b37c7e5eSwdenk
2130ea818dbbSHeiko Schocher		If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
2131b37c7e5eSwdenk		then the following macros need to be defined (examples are
2132b37c7e5eSwdenk		from include/configs/lwmon.h):
2133c609719bSwdenk
2134c609719bSwdenk		I2C_INIT
2135c609719bSwdenk
2136b37c7e5eSwdenk		(Optional). Any commands necessary to enable the I2C
2137c609719bSwdenk		controller or configure ports.
2138c609719bSwdenk
2139b37c7e5eSwdenk		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
2140b37c7e5eSwdenk
2141c609719bSwdenk		I2C_PORT
2142c609719bSwdenk
2143c609719bSwdenk		(Only for MPC8260 CPU). The I/O port to use (the code
2144c609719bSwdenk		assumes both bits are on the same port). Valid values
2145c609719bSwdenk		are 0..3 for ports A..D.
2146c609719bSwdenk
2147c609719bSwdenk		I2C_ACTIVE
2148c609719bSwdenk
2149c609719bSwdenk		The code necessary to make the I2C data line active
2150c609719bSwdenk		(driven).  If the data line is open collector, this
2151c609719bSwdenk		define can be null.
2152c609719bSwdenk
2153b37c7e5eSwdenk		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
2154b37c7e5eSwdenk
2155c609719bSwdenk		I2C_TRISTATE
2156c609719bSwdenk
2157c609719bSwdenk		The code necessary to make the I2C data line tri-stated
2158c609719bSwdenk		(inactive).  If the data line is open collector, this
2159c609719bSwdenk		define can be null.
2160c609719bSwdenk
2161b37c7e5eSwdenk		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2162b37c7e5eSwdenk
2163c609719bSwdenk		I2C_READ
2164c609719bSwdenk
2165472d5460SYork Sun		Code that returns true if the I2C data line is high,
2166472d5460SYork Sun		false if it is low.
2167c609719bSwdenk
2168b37c7e5eSwdenk		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2169b37c7e5eSwdenk
2170c609719bSwdenk		I2C_SDA(bit)
2171c609719bSwdenk
2172472d5460SYork Sun		If <bit> is true, sets the I2C data line high. If it
2173472d5460SYork Sun		is false, it clears it (low).
2174c609719bSwdenk
2175b37c7e5eSwdenk		eg: #define I2C_SDA(bit) \
2176b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
2177b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
2178b37c7e5eSwdenk
2179c609719bSwdenk		I2C_SCL(bit)
2180c609719bSwdenk
2181472d5460SYork Sun		If <bit> is true, sets the I2C clock line high. If it
2182472d5460SYork Sun		is false, it clears it (low).
2183c609719bSwdenk
2184b37c7e5eSwdenk		eg: #define I2C_SCL(bit) \
2185b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
2186b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
2187b37c7e5eSwdenk
2188c609719bSwdenk		I2C_DELAY
2189c609719bSwdenk
2190c609719bSwdenk		This delay is invoked four times per clock cycle so this
2191c609719bSwdenk		controls the rate of data transfer.  The data rate thus
2192b37c7e5eSwdenk		is 1 / (I2C_DELAY * 4). Often defined to be something
2193b37c7e5eSwdenk		like:
2194b37c7e5eSwdenk
2195b37c7e5eSwdenk		#define I2C_DELAY  udelay(2)
2196c609719bSwdenk
2197793b5726SMike Frysinger		CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2198793b5726SMike Frysinger
2199793b5726SMike Frysinger		If your arch supports the generic GPIO framework (asm/gpio.h),
2200793b5726SMike Frysinger		then you may alternatively define the two GPIOs that are to be
2201793b5726SMike Frysinger		used as SCL / SDA.  Any of the previous I2C_xxx macros will
2202793b5726SMike Frysinger		have GPIO-based defaults assigned to them as appropriate.
2203793b5726SMike Frysinger
2204793b5726SMike Frysinger		You should define these to the GPIO value as given directly to
2205793b5726SMike Frysinger		the generic GPIO functions.
2206793b5726SMike Frysinger
22076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_INIT_BOARD
220847cd00faSwdenk
220947cd00faSwdenk		When a board is reset during an i2c bus transfer
221047cd00faSwdenk		chips might think that the current transfer is still
221147cd00faSwdenk		in progress. On some boards it is possible to access
221247cd00faSwdenk		the i2c SCLK line directly, either by using the
221347cd00faSwdenk		processor pin as a GPIO or by having a second pin
221447cd00faSwdenk		connected to the bus. If this option is defined a
221547cd00faSwdenk		custom i2c_init_board() routine in boards/xxx/board.c
221647cd00faSwdenk		is run early in the boot sequence.
221747cd00faSwdenk
221826a33504SRichard Retanubun		CONFIG_SYS_I2C_BOARD_LATE_INIT
221926a33504SRichard Retanubun
222026a33504SRichard Retanubun		An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
222126a33504SRichard Retanubun		defined a custom i2c_board_late_init() routine in
222226a33504SRichard Retanubun		boards/xxx/board.c is run AFTER the operations in i2c_init()
222326a33504SRichard Retanubun		is completed. This callpoint can be used to unreset i2c bus
222426a33504SRichard Retanubun		using CPU i2c controller register accesses for CPUs whose i2c
222526a33504SRichard Retanubun		controller provide such a method. It is called at the end of
222626a33504SRichard Retanubun		i2c_init() to allow i2c_init operations to setup the i2c bus
222726a33504SRichard Retanubun		controller on the CPU (e.g. setting bus speed & slave address).
222826a33504SRichard Retanubun
222917ea1177Swdenk		CONFIG_I2CFAST (PPC405GP|PPC405EP only)
223017ea1177Swdenk
223117ea1177Swdenk		This option enables configuration of bi_iic_fast[] flags
223217ea1177Swdenk		in u-boot bd_info structure based on u-boot environment
223317ea1177Swdenk		variable "i2cfast". (see also i2cfast)
223417ea1177Swdenk
2235bb99ad6dSBen Warren		CONFIG_I2C_MULTI_BUS
2236bb99ad6dSBen Warren
2237bb99ad6dSBen Warren		This option allows the use of multiple I2C buses, each of which
2238bb99ad6dSBen Warren		must have a controller.	 At any point in time, only one bus is
2239bb99ad6dSBen Warren		active.	 To switch to a different bus, use the 'i2c dev' command.
2240bb99ad6dSBen Warren		Note that bus numbering is zero-based.
2241bb99ad6dSBen Warren
22426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_NOPROBES
2243bb99ad6dSBen Warren
2244bb99ad6dSBen Warren		This option specifies a list of I2C devices that will be skipped
22450f89c54bSPeter Tyser		when the 'i2c probe' command is issued.	 If CONFIG_I2C_MULTI_BUS
22460f89c54bSPeter Tyser		is set, specify a list of bus-device pairs.  Otherwise, specify
22470f89c54bSPeter Tyser		a 1D array of device addresses
2248bb99ad6dSBen Warren
2249bb99ad6dSBen Warren		e.g.
2250bb99ad6dSBen Warren			#undef	CONFIG_I2C_MULTI_BUS
22516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
2252bb99ad6dSBen Warren
2253bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on a board with one I2C bus
2254bb99ad6dSBen Warren
2255bb99ad6dSBen Warren			#define CONFIG_I2C_MULTI_BUS
22566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_MULTI_NOPROBES	{{0,0x50},{0,0x68},{1,0x54}}
2257bb99ad6dSBen Warren
2258bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2259bb99ad6dSBen Warren
22606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SPD_BUS_NUM
2261be5e6181STimur Tabi
2262be5e6181STimur Tabi		If defined, then this indicates the I2C bus number for DDR SPD.
2263be5e6181STimur Tabi		If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2264be5e6181STimur Tabi
22656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_BUS_NUM
22660dc018ecSStefan Roese
22670dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the RTC.
22680dc018ecSStefan Roese		If not defined, then U-Boot assumes that RTC is on I2C bus 0.
22690dc018ecSStefan Roese
22706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_DTT_BUS_NUM
22710dc018ecSStefan Roese
22720dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the DTT.
22730dc018ecSStefan Roese		If not defined, then U-Boot assumes that DTT is on I2C bus 0.
22740dc018ecSStefan Roese
22756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_DTT_ADDR:
22769ebbb54fSVictor Gallardo
22779ebbb54fSVictor Gallardo		If defined, specifies the I2C address of the DTT device.
22789ebbb54fSVictor Gallardo		If not defined, then U-Boot uses predefined value for
22799ebbb54fSVictor Gallardo		specified DTT device.
22809ebbb54fSVictor Gallardo
22812ac6985aSAndrew Dyer		CONFIG_SOFT_I2C_READ_REPEATED_START
22822ac6985aSAndrew Dyer
22832ac6985aSAndrew Dyer		defining this will force the i2c_read() function in
22842ac6985aSAndrew Dyer		the soft_i2c driver to perform an I2C repeated start
22852ac6985aSAndrew Dyer		between writing the address pointer and reading the
22862ac6985aSAndrew Dyer		data.  If this define is omitted the default behaviour
22872ac6985aSAndrew Dyer		of doing a stop-start sequence will be used.  Most I2C
22882ac6985aSAndrew Dyer		devices can use either method, but some require one or
22892ac6985aSAndrew Dyer		the other.
2290be5e6181STimur Tabi
2291c609719bSwdenk- SPI Support:	CONFIG_SPI
2292c609719bSwdenk
2293c609719bSwdenk		Enables SPI driver (so far only tested with
2294c609719bSwdenk		SPI EEPROM, also an instance works with Crystal A/D and
2295c609719bSwdenk		D/As on the SACSng board)
2296c609719bSwdenk
22976639562eSYoshihiro Shimoda		CONFIG_SH_SPI
22986639562eSYoshihiro Shimoda
22996639562eSYoshihiro Shimoda		Enables the driver for SPI controller on SuperH. Currently
23006639562eSYoshihiro Shimoda		only SH7757 is supported.
23016639562eSYoshihiro Shimoda
2302c609719bSwdenk		CONFIG_SPI_X
2303c609719bSwdenk
2304c609719bSwdenk		Enables extended (16-bit) SPI EEPROM addressing.
2305c609719bSwdenk		(symmetrical to CONFIG_I2C_X)
2306c609719bSwdenk
2307c609719bSwdenk		CONFIG_SOFT_SPI
2308c609719bSwdenk
2309c609719bSwdenk		Enables a software (bit-bang) SPI driver rather than
2310c609719bSwdenk		using hardware support. This is a general purpose
2311c609719bSwdenk		driver that only requires three general I/O port pins
2312c609719bSwdenk		(two outputs, one input) to function. If this is
2313c609719bSwdenk		defined, the board configuration must define several
2314c609719bSwdenk		SPI configuration items (port pins to use, etc). For
2315c609719bSwdenk		an example, see include/configs/sacsng.h.
2316c609719bSwdenk
231704a9e118SBen Warren		CONFIG_HARD_SPI
231804a9e118SBen Warren
231904a9e118SBen Warren		Enables a hardware SPI driver for general-purpose reads
232004a9e118SBen Warren		and writes.  As with CONFIG_SOFT_SPI, the board configuration
232104a9e118SBen Warren		must define a list of chip-select function pointers.
232204a9e118SBen Warren		Currently supported on some MPC8xxx processors.	 For an
232304a9e118SBen Warren		example, see include/configs/mpc8349emds.h.
232404a9e118SBen Warren
232538254f45SGuennadi Liakhovetski		CONFIG_MXC_SPI
232638254f45SGuennadi Liakhovetski
232738254f45SGuennadi Liakhovetski		Enables the driver for the SPI controllers on i.MX and MXC
23282e3cd1cdSFabio Estevam		SoCs. Currently i.MX31/35/51 are supported.
232938254f45SGuennadi Liakhovetski
23300133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA
23310133502eSMatthias Fuchs
23320133502eSMatthias Fuchs		Enables FPGA subsystem.
23330133502eSMatthias Fuchs
23340133502eSMatthias Fuchs		CONFIG_FPGA_<vendor>
23350133502eSMatthias Fuchs
23360133502eSMatthias Fuchs		Enables support for specific chip vendors.
23370133502eSMatthias Fuchs		(ALTERA, XILINX)
23380133502eSMatthias Fuchs
23390133502eSMatthias Fuchs		CONFIG_FPGA_<family>
23400133502eSMatthias Fuchs
23410133502eSMatthias Fuchs		Enables support for FPGA family.
23420133502eSMatthias Fuchs		(SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
23430133502eSMatthias Fuchs
23440133502eSMatthias Fuchs		CONFIG_FPGA_COUNT
2345c609719bSwdenk
2346c609719bSwdenk		Specify the number of FPGA devices to support.
2347c609719bSwdenk
23486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_PROG_FEEDBACK
2349c609719bSwdenk
2350c609719bSwdenk		Enable printing of hash marks during FPGA configuration.
2351c609719bSwdenk
23526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_BUSY
2353c609719bSwdenk
2354c609719bSwdenk		Enable checks on FPGA configuration interface busy
2355c609719bSwdenk		status by the configuration function. This option
2356c609719bSwdenk		will require a board or device specific function to
2357c609719bSwdenk		be written.
2358c609719bSwdenk
2359c609719bSwdenk		CONFIG_FPGA_DELAY
2360c609719bSwdenk
2361c609719bSwdenk		If defined, a function that provides delays in the FPGA
2362c609719bSwdenk		configuration driver.
2363c609719bSwdenk
23646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_CTRLC
2365c609719bSwdenk		Allow Control-C to interrupt FPGA configuration
2366c609719bSwdenk
23676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_ERROR
2368c609719bSwdenk
2369c609719bSwdenk		Check for configuration errors during FPGA bitfile
2370c609719bSwdenk		loading. For example, abort during Virtex II
2371c609719bSwdenk		configuration if the INIT_B line goes low (which
2372c609719bSwdenk		indicated a CRC error).
2373c609719bSwdenk
23746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_INIT
2375c609719bSwdenk
2376c609719bSwdenk		Maximum time to wait for the INIT_B line to deassert
2377c609719bSwdenk		after PROB_B has been deasserted during a Virtex II
2378c609719bSwdenk		FPGA configuration sequence. The default time is 500
237911ccc33fSMarcel Ziswiler		ms.
2380c609719bSwdenk
23816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_BUSY
2382c609719bSwdenk
2383c609719bSwdenk		Maximum time to wait for BUSY to deassert during
238411ccc33fSMarcel Ziswiler		Virtex II FPGA configuration. The default is 5 ms.
2385c609719bSwdenk
23866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_CONFIG
2387c609719bSwdenk
2388c609719bSwdenk		Time to wait after FPGA configuration. The default is
238911ccc33fSMarcel Ziswiler		200 ms.
2390c609719bSwdenk
2391c609719bSwdenk- Configuration Management:
2392c609719bSwdenk		CONFIG_IDENT_STRING
2393c609719bSwdenk
2394c609719bSwdenk		If defined, this string will be added to the U-Boot
2395c609719bSwdenk		version information (U_BOOT_VERSION)
2396c609719bSwdenk
2397c609719bSwdenk- Vendor Parameter Protection:
2398c609719bSwdenk
2399c609719bSwdenk		U-Boot considers the values of the environment
2400c609719bSwdenk		variables "serial#" (Board Serial Number) and
24017152b1d0Swdenk		"ethaddr" (Ethernet Address) to be parameters that
2402c609719bSwdenk		are set once by the board vendor / manufacturer, and
2403c609719bSwdenk		protects these variables from casual modification by
2404c609719bSwdenk		the user. Once set, these variables are read-only,
2405c609719bSwdenk		and write or delete attempts are rejected. You can
240611ccc33fSMarcel Ziswiler		change this behaviour:
2407c609719bSwdenk
2408c609719bSwdenk		If CONFIG_ENV_OVERWRITE is #defined in your config
2409c609719bSwdenk		file, the write protection for vendor parameters is
241047cd00faSwdenk		completely disabled. Anybody can change or delete
2411c609719bSwdenk		these parameters.
2412c609719bSwdenk
2413c609719bSwdenk		Alternatively, if you #define _both_ CONFIG_ETHADDR
2414c609719bSwdenk		_and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
241511ccc33fSMarcel Ziswiler		Ethernet address is installed in the environment,
2416c609719bSwdenk		which can be changed exactly ONCE by the user. [The
2417c609719bSwdenk		serial# is unaffected by this, i. e. it remains
2418c609719bSwdenk		read-only.]
2419c609719bSwdenk
24202598090bSJoe Hershberger		The same can be accomplished in a more flexible way
24212598090bSJoe Hershberger		for any variable by configuring the type of access
24222598090bSJoe Hershberger		to allow for those variables in the ".flags" variable
24232598090bSJoe Hershberger		or define CONFIG_ENV_FLAGS_LIST_STATIC.
24242598090bSJoe Hershberger
2425c609719bSwdenk- Protected RAM:
2426c609719bSwdenk		CONFIG_PRAM
2427c609719bSwdenk
2428c609719bSwdenk		Define this variable to enable the reservation of
2429c609719bSwdenk		"protected RAM", i. e. RAM which is not overwritten
2430c609719bSwdenk		by U-Boot. Define CONFIG_PRAM to hold the number of
2431c609719bSwdenk		kB you want to reserve for pRAM. You can overwrite
2432c609719bSwdenk		this default value by defining an environment
2433c609719bSwdenk		variable "pram" to the number of kB you want to
2434c609719bSwdenk		reserve. Note that the board info structure will
2435c609719bSwdenk		still show the full amount of RAM. If pRAM is
2436c609719bSwdenk		reserved, a new environment variable "mem" will
2437c609719bSwdenk		automatically be defined to hold the amount of
2438c609719bSwdenk		remaining RAM in a form that can be passed as boot
2439c609719bSwdenk		argument to Linux, for instance like that:
2440c609719bSwdenk
2441fe126d8bSWolfgang Denk			setenv bootargs ... mem=\${mem}
2442c609719bSwdenk			saveenv
2443c609719bSwdenk
2444c609719bSwdenk		This way you can tell Linux not to use this memory,
2445c609719bSwdenk		either, which results in a memory region that will
2446c609719bSwdenk		not be affected by reboots.
2447c609719bSwdenk
2448c609719bSwdenk		*WARNING* If your board configuration uses automatic
2449c609719bSwdenk		detection of the RAM size, you must make sure that
2450c609719bSwdenk		this memory test is non-destructive. So far, the
2451c609719bSwdenk		following board configurations are known to be
2452c609719bSwdenk		"pRAM-clean":
2453c609719bSwdenk
24541b0757ecSWolfgang Denk			IVMS8, IVML24, SPD8xx, TQM8xxL,
24551b0757ecSWolfgang Denk			HERMES, IP860, RPXlite, LWMON,
2456544d97e9SWolfgang Denk			FLAGADM, TQM8260
2457c609719bSwdenk
245840fef049SGabe Black- Access to physical memory region (> 4GB)
245940fef049SGabe Black		Some basic support is provided for operations on memory not
246040fef049SGabe Black		normally accessible to U-Boot - e.g. some architectures
246140fef049SGabe Black		support access to more than 4GB of memory on 32-bit
246240fef049SGabe Black		machines using physical address extension or similar.
246340fef049SGabe Black		Define CONFIG_PHYSMEM to access this basic support, which
246440fef049SGabe Black		currently only supports clearing the memory.
246540fef049SGabe Black
2466c609719bSwdenk- Error Recovery:
2467c609719bSwdenk		CONFIG_PANIC_HANG
2468c609719bSwdenk
2469c609719bSwdenk		Define this variable to stop the system in case of a
2470c609719bSwdenk		fatal error, so that you have to reset it manually.
2471c609719bSwdenk		This is probably NOT a good idea for an embedded
247211ccc33fSMarcel Ziswiler		system where you want the system to reboot
2473c609719bSwdenk		automatically as fast as possible, but it may be
2474c609719bSwdenk		useful during development since you can try to debug
2475c609719bSwdenk		the conditions that lead to the situation.
2476c609719bSwdenk
2477c609719bSwdenk		CONFIG_NET_RETRY_COUNT
2478c609719bSwdenk
2479c609719bSwdenk		This variable defines the number of retries for
2480c609719bSwdenk		network operations like ARP, RARP, TFTP, or BOOTP
2481c609719bSwdenk		before giving up the operation. If not defined, a
2482c609719bSwdenk		default value of 5 is used.
2483c609719bSwdenk
248440cb90eeSGuennadi Liakhovetski		CONFIG_ARP_TIMEOUT
248540cb90eeSGuennadi Liakhovetski
248640cb90eeSGuennadi Liakhovetski		Timeout waiting for an ARP reply in milliseconds.
248740cb90eeSGuennadi Liakhovetski
248848a3e999STetsuyuki Kobayashi		CONFIG_NFS_TIMEOUT
248948a3e999STetsuyuki Kobayashi
249048a3e999STetsuyuki Kobayashi		Timeout in milliseconds used in NFS protocol.
249148a3e999STetsuyuki Kobayashi		If you encounter "ERROR: Cannot umount" in nfs command,
249248a3e999STetsuyuki Kobayashi		try longer timeout such as
249348a3e999STetsuyuki Kobayashi		#define CONFIG_NFS_TIMEOUT 10000UL
249448a3e999STetsuyuki Kobayashi
2495c609719bSwdenk- Command Interpreter:
24968078f1a5SWolfgang Denk		CONFIG_AUTO_COMPLETE
249704a85b3bSwdenk
249804a85b3bSwdenk		Enable auto completion of commands using TAB.
249904a85b3bSwdenk
25008078f1a5SWolfgang Denk		Note that this feature has NOT been implemented yet
25018078f1a5SWolfgang Denk		for the "hush" shell.
25028078f1a5SWolfgang Denk
25038078f1a5SWolfgang Denk
25046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_HUSH_PARSER
2505c609719bSwdenk
2506c609719bSwdenk		Define this variable to enable the "hush" shell (from
2507c609719bSwdenk		Busybox) as command line interpreter, thus enabling
2508c609719bSwdenk		powerful command line syntax like
2509c609719bSwdenk		if...then...else...fi conditionals or `&&' and '||'
2510c609719bSwdenk		constructs ("shell scripts").
2511c609719bSwdenk
2512c609719bSwdenk		If undefined, you get the old, much simpler behaviour
2513c609719bSwdenk		with a somewhat smaller memory footprint.
2514c609719bSwdenk
2515c609719bSwdenk
25166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_PROMPT_HUSH_PS2
2517c609719bSwdenk
2518c609719bSwdenk		This defines the secondary prompt string, which is
2519c609719bSwdenk		printed when the command interpreter needs more input
2520c609719bSwdenk		to complete a command. Usually "> ".
2521c609719bSwdenk
2522c609719bSwdenk	Note:
2523c609719bSwdenk
2524c609719bSwdenk		In the current implementation, the local variables
2525c609719bSwdenk		space and global environment variables space are
2526c609719bSwdenk		separated. Local variables are those you define by
25273b57fe0aSwdenk		simply typing `name=value'. To access a local
2528c609719bSwdenk		variable later on, you have write `$name' or
25293b57fe0aSwdenk		`${name}'; to execute the contents of a variable
25303b57fe0aSwdenk		directly type `$name' at the command prompt.
2531c609719bSwdenk
2532c609719bSwdenk		Global environment variables are those you use
2533c609719bSwdenk		setenv/printenv to work with. To run a command stored
2534c609719bSwdenk		in such a variable, you need to use the run command,
2535c609719bSwdenk		and you must not use the '$' sign to access them.
2536c609719bSwdenk
2537c609719bSwdenk		To store commands and special characters in a
2538c609719bSwdenk		variable, please use double quotation marks
2539c609719bSwdenk		surrounding the whole text of the variable, instead
2540c609719bSwdenk		of the backslashes before semicolons and special
2541c609719bSwdenk		symbols.
2542c609719bSwdenk
2543aa0c71acSWolfgang Denk- Commandline Editing and History:
2544aa0c71acSWolfgang Denk		CONFIG_CMDLINE_EDITING
2545aa0c71acSWolfgang Denk
254611ccc33fSMarcel Ziswiler		Enable editing and History functions for interactive
2547aa0c71acSWolfgang Denk		commandline input operations
2548aa0c71acSWolfgang Denk
2549a8c7c708Swdenk- Default Environment:
2550c609719bSwdenk		CONFIG_EXTRA_ENV_SETTINGS
2551c609719bSwdenk
2552c609719bSwdenk		Define this to contain any number of null terminated
2553c609719bSwdenk		strings (variable = value pairs) that will be part of
25547152b1d0Swdenk		the default environment compiled into the boot image.
25552262cfeeSwdenk
2556c609719bSwdenk		For example, place something like this in your
2557c609719bSwdenk		board's config file:
2558c609719bSwdenk
2559c609719bSwdenk		#define CONFIG_EXTRA_ENV_SETTINGS \
2560c609719bSwdenk			"myvar1=value1\0" \
2561c609719bSwdenk			"myvar2=value2\0"
2562c609719bSwdenk
2563c609719bSwdenk		Warning: This method is based on knowledge about the
2564c609719bSwdenk		internal format how the environment is stored by the
25652262cfeeSwdenk		U-Boot code. This is NOT an official, exported
2566c609719bSwdenk		interface! Although it is unlikely that this format
25677152b1d0Swdenk		will change soon, there is no guarantee either.
2568c609719bSwdenk		You better know what you are doing here.
2569c609719bSwdenk
2570c609719bSwdenk		Note: overly (ab)use of the default environment is
2571c609719bSwdenk		discouraged. Make sure to check other ways to preset
257274de7aefSWolfgang Denk		the environment like the "source" command or the
2573c609719bSwdenk		boot command first.
2574c609719bSwdenk
25755e724ca2SStephen Warren		CONFIG_ENV_VARS_UBOOT_CONFIG
25765e724ca2SStephen Warren
25775e724ca2SStephen Warren		Define this in order to add variables describing the
25785e724ca2SStephen Warren		U-Boot build configuration to the default environment.
25795e724ca2SStephen Warren		These will be named arch, cpu, board, vendor, and soc.
25805e724ca2SStephen Warren
25815e724ca2SStephen Warren		Enabling this option will cause the following to be defined:
25825e724ca2SStephen Warren
25835e724ca2SStephen Warren		- CONFIG_SYS_ARCH
25845e724ca2SStephen Warren		- CONFIG_SYS_CPU
25855e724ca2SStephen Warren		- CONFIG_SYS_BOARD
25865e724ca2SStephen Warren		- CONFIG_SYS_VENDOR
25875e724ca2SStephen Warren		- CONFIG_SYS_SOC
25885e724ca2SStephen Warren
25897e27f89fSTom Rini		CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
25907e27f89fSTom Rini
25917e27f89fSTom Rini		Define this in order to add variables describing certain
25927e27f89fSTom Rini		run-time determined information about the hardware to the
25937e27f89fSTom Rini		environment.  These will be named board_name, board_rev.
25947e27f89fSTom Rini
259506fd8538SSimon Glass		CONFIG_DELAY_ENVIRONMENT
259606fd8538SSimon Glass
259706fd8538SSimon Glass		Normally the environment is loaded when the board is
259806fd8538SSimon Glass		intialised so that it is available to U-Boot. This inhibits
259906fd8538SSimon Glass		that so that the environment is not available until
260006fd8538SSimon Glass		explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
260106fd8538SSimon Glass		this is instead controlled by the value of
260206fd8538SSimon Glass		/config/load-environment.
260306fd8538SSimon Glass
2604a8c7c708Swdenk- DataFlash Support:
26052abbe075Swdenk		CONFIG_HAS_DATAFLASH
26062abbe075Swdenk
26072abbe075Swdenk		Defining this option enables DataFlash features and
26082abbe075Swdenk		allows to read/write in Dataflash via the standard
26092abbe075Swdenk		commands cp, md...
26102abbe075Swdenk
2611f61ec45eSEric Nelson- Serial Flash support
2612f61ec45eSEric Nelson		CONFIG_CMD_SF
2613f61ec45eSEric Nelson
2614f61ec45eSEric Nelson		Defining this option enables SPI flash commands
2615f61ec45eSEric Nelson		'sf probe/read/write/erase/update'.
2616f61ec45eSEric Nelson
2617f61ec45eSEric Nelson		Usage requires an initial 'probe' to define the serial
2618f61ec45eSEric Nelson		flash parameters, followed by read/write/erase/update
2619f61ec45eSEric Nelson		commands.
2620f61ec45eSEric Nelson
2621f61ec45eSEric Nelson		The following defaults may be provided by the platform
2622f61ec45eSEric Nelson		to handle the common case when only a single serial
2623f61ec45eSEric Nelson		flash is present on the system.
2624f61ec45eSEric Nelson
2625f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_BUS		Bus identifier
2626f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_CS		Chip-select
2627f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_MODE 		(see include/spi.h)
2628f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_SPEED		in Hz
2629f61ec45eSEric Nelson
263024007273SSimon Glass		CONFIG_CMD_SF_TEST
263124007273SSimon Glass
263224007273SSimon Glass		Define this option to include a destructive SPI flash
263324007273SSimon Glass		test ('sf test').
263424007273SSimon Glass
26351dcd6d03SJagannadha Sutradharudu Teki		CONFIG_SPI_FLASH_BAR		Ban/Extended Addr Reg
26361dcd6d03SJagannadha Sutradharudu Teki
26371dcd6d03SJagannadha Sutradharudu Teki		Define this option to use the Bank addr/Extended addr
26381dcd6d03SJagannadha Sutradharudu Teki		support on SPI flashes which has size > 16Mbytes.
26391dcd6d03SJagannadha Sutradharudu Teki
26403f85ce27Swdenk- SystemACE Support:
26413f85ce27Swdenk		CONFIG_SYSTEMACE
26423f85ce27Swdenk
26433f85ce27Swdenk		Adding this option adds support for Xilinx SystemACE
26443f85ce27Swdenk		chips attached via some sort of local bus. The address
264511ccc33fSMarcel Ziswiler		of the chip must also be defined in the
26466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SYSTEMACE_BASE macro. For example:
26473f85ce27Swdenk
26483f85ce27Swdenk		#define CONFIG_SYSTEMACE
26496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
26503f85ce27Swdenk
26513f85ce27Swdenk		When SystemACE support is added, the "ace" device type
26523f85ce27Swdenk		becomes available to the fat commands, i.e. fatls.
26533f85ce27Swdenk
2654ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port:
2655ecb0ccd9SWolfgang Denk		CONFIG_TFTP_PORT
2656ecb0ccd9SWolfgang Denk
265728cb9375SWolfgang Denk		If this is defined, the environment variable tftpsrcp
2658ecb0ccd9SWolfgang Denk		is used to supply the TFTP UDP source port value.
265928cb9375SWolfgang Denk		If tftpsrcp isn't defined, the normal pseudo-random port
2660ecb0ccd9SWolfgang Denk		number generator is used.
2661ecb0ccd9SWolfgang Denk
266228cb9375SWolfgang Denk		Also, the environment variable tftpdstp is used to supply
266328cb9375SWolfgang Denk		the TFTP UDP destination port value.  If tftpdstp isn't
266428cb9375SWolfgang Denk		defined, the normal port 69 is used.
266528cb9375SWolfgang Denk
266628cb9375SWolfgang Denk		The purpose for tftpsrcp is to allow a TFTP server to
2667ecb0ccd9SWolfgang Denk		blindly start the TFTP transfer using the pre-configured
2668ecb0ccd9SWolfgang Denk		target IP address and UDP port. This has the effect of
2669ecb0ccd9SWolfgang Denk		"punching through" the (Windows XP) firewall, allowing
2670ecb0ccd9SWolfgang Denk		the remainder of the TFTP transfer to proceed normally.
2671ecb0ccd9SWolfgang Denk		A better solution is to properly configure the firewall,
2672ecb0ccd9SWolfgang Denk		but sometimes that is not allowed.
2673ecb0ccd9SWolfgang Denk
2674bf36c5d5SSimon Glass- Hashing support:
2675bf36c5d5SSimon Glass		CONFIG_CMD_HASH
2676bf36c5d5SSimon Glass
2677bf36c5d5SSimon Glass		This enables a generic 'hash' command which can produce
2678bf36c5d5SSimon Glass		hashes / digests from a few algorithms (e.g. SHA1, SHA256).
2679bf36c5d5SSimon Glass
2680bf36c5d5SSimon Glass		CONFIG_HASH_VERIFY
2681bf36c5d5SSimon Glass
2682bf36c5d5SSimon Glass		Enable the hash verify command (hash -v). This adds to code
2683bf36c5d5SSimon Glass		size a little.
2684bf36c5d5SSimon Glass
2685bf36c5d5SSimon Glass		CONFIG_SHA1 - support SHA1 hashing
2686bf36c5d5SSimon Glass		CONFIG_SHA256 - support SHA256 hashing
2687bf36c5d5SSimon Glass
2688bf36c5d5SSimon Glass		Note: There is also a sha1sum command, which should perhaps
2689bf36c5d5SSimon Glass		be deprecated in favour of 'hash sha1'.
2690bf36c5d5SSimon Glass
2691a11f1873SRobert Winkler- Freescale i.MX specific commands:
2692a11f1873SRobert Winkler		CONFIG_CMD_HDMIDETECT
2693a11f1873SRobert Winkler		This enables 'hdmidet' command which returns true if an
2694a11f1873SRobert Winkler		HDMI monitor is detected.  This command is i.MX 6 specific.
2695a11f1873SRobert Winkler
2696a11f1873SRobert Winkler		CONFIG_CMD_BMODE
2697a11f1873SRobert Winkler		This enables the 'bmode' (bootmode) command for forcing
2698a11f1873SRobert Winkler		a boot from specific media.
2699a11f1873SRobert Winkler
2700a11f1873SRobert Winkler		This is useful for forcing the ROM's usb downloader to
2701a11f1873SRobert Winkler		activate upon a watchdog reset which is nice when iterating
2702a11f1873SRobert Winkler		on U-Boot.  Using the reset button or running bmode normal
2703a11f1873SRobert Winkler		will set it back to normal.  This command currently
2704a11f1873SRobert Winkler		supports i.MX53 and i.MX6.
2705a11f1873SRobert Winkler
270619c402afSSimon Glass- Signing support:
270719c402afSSimon Glass		CONFIG_RSA
270819c402afSSimon Glass
270919c402afSSimon Glass		This enables the RSA algorithm used for FIT image verification
271019c402afSSimon Glass		in U-Boot. See doc/uImage/signature for more information.
271119c402afSSimon Glass
271219c402afSSimon Glass		The signing part is build into mkimage regardless of this
271319c402afSSimon Glass		option.
271419c402afSSimon Glass
271519c402afSSimon Glass
2716a8c7c708Swdenk- Show boot progress:
2717c609719bSwdenk		CONFIG_SHOW_BOOT_PROGRESS
2718c609719bSwdenk
2719c609719bSwdenk		Defining this option allows to add some board-
2720c609719bSwdenk		specific code (calling a user-provided function
2721c609719bSwdenk		"show_boot_progress(int)") that enables you to show
2722c609719bSwdenk		the system's boot progress on some display (for
2723c609719bSwdenk		example, some LED's) on your board. At the moment,
2724c609719bSwdenk		the following checkpoints are implemented:
2725c609719bSwdenk
27263a608ca0SSimon Glass- Detailed boot stage timing
27273a608ca0SSimon Glass		CONFIG_BOOTSTAGE
27283a608ca0SSimon Glass		Define this option to get detailed timing of each stage
27293a608ca0SSimon Glass		of the boot process.
27303a608ca0SSimon Glass
27313a608ca0SSimon Glass		CONFIG_BOOTSTAGE_USER_COUNT
27323a608ca0SSimon Glass		This is the number of available user bootstage records.
27333a608ca0SSimon Glass		Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
27343a608ca0SSimon Glass		a new ID will be allocated from this stash. If you exceed
27353a608ca0SSimon Glass		the limit, recording will stop.
27363a608ca0SSimon Glass
27373a608ca0SSimon Glass		CONFIG_BOOTSTAGE_REPORT
27383a608ca0SSimon Glass		Define this to print a report before boot, similar to this:
27393a608ca0SSimon Glass
27403a608ca0SSimon Glass		Timer summary in microseconds:
27413a608ca0SSimon Glass		       Mark    Elapsed  Stage
27423a608ca0SSimon Glass			  0          0  reset
27433a608ca0SSimon Glass		  3,575,678  3,575,678  board_init_f start
27443a608ca0SSimon Glass		  3,575,695         17  arch_cpu_init A9
27453a608ca0SSimon Glass		  3,575,777         82  arch_cpu_init done
27463a608ca0SSimon Glass		  3,659,598     83,821  board_init_r start
27473a608ca0SSimon Glass		  3,910,375    250,777  main_loop
27483a608ca0SSimon Glass		 29,916,167 26,005,792  bootm_start
27493a608ca0SSimon Glass		 30,361,327    445,160  start_kernel
27503a608ca0SSimon Glass
27512eba38cfSSimon Glass		CONFIG_CMD_BOOTSTAGE
27522eba38cfSSimon Glass		Add a 'bootstage' command which supports printing a report
27532eba38cfSSimon Glass		and un/stashing of bootstage data.
27542eba38cfSSimon Glass
275594fd1316SSimon Glass		CONFIG_BOOTSTAGE_FDT
275694fd1316SSimon Glass		Stash the bootstage information in the FDT. A root 'bootstage'
275794fd1316SSimon Glass		node is created with each bootstage id as a child. Each child
275894fd1316SSimon Glass		has a 'name' property and either 'mark' containing the
275994fd1316SSimon Glass		mark time in microsecond, or 'accum' containing the
276094fd1316SSimon Glass		accumulated time for that bootstage id in microseconds.
276194fd1316SSimon Glass		For example:
276294fd1316SSimon Glass
276394fd1316SSimon Glass		bootstage {
276494fd1316SSimon Glass			154 {
276594fd1316SSimon Glass				name = "board_init_f";
276694fd1316SSimon Glass				mark = <3575678>;
276794fd1316SSimon Glass			};
276894fd1316SSimon Glass			170 {
276994fd1316SSimon Glass				name = "lcd";
277094fd1316SSimon Glass				accum = <33482>;
277194fd1316SSimon Glass			};
277294fd1316SSimon Glass		};
277394fd1316SSimon Glass
277494fd1316SSimon Glass		Code in the Linux kernel can find this in /proc/devicetree.
277594fd1316SSimon Glass
27761372cce2SMarian BalakowiczLegacy uImage format:
27771372cce2SMarian Balakowicz
2778c609719bSwdenk  Arg	Where			When
2779c609719bSwdenk    1	common/cmd_bootm.c	before attempting to boot an image
2780c609719bSwdenk   -1	common/cmd_bootm.c	Image header has bad	 magic number
2781c609719bSwdenk    2	common/cmd_bootm.c	Image header has correct magic number
2782c609719bSwdenk   -2	common/cmd_bootm.c	Image header has bad	 checksum
2783c609719bSwdenk    3	common/cmd_bootm.c	Image header has correct checksum
2784c609719bSwdenk   -3	common/cmd_bootm.c	Image data   has bad	 checksum
2785c609719bSwdenk    4	common/cmd_bootm.c	Image data   has correct checksum
2786c609719bSwdenk   -4	common/cmd_bootm.c	Image is for unsupported architecture
2787c609719bSwdenk    5	common/cmd_bootm.c	Architecture check OK
27881372cce2SMarian Balakowicz   -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi)
2789c609719bSwdenk    6	common/cmd_bootm.c	Image Type check OK
2790c609719bSwdenk   -6	common/cmd_bootm.c	gunzip uncompression error
2791c609719bSwdenk   -7	common/cmd_bootm.c	Unimplemented compression type
2792c609719bSwdenk    7	common/cmd_bootm.c	Uncompression OK
27931372cce2SMarian Balakowicz    8	common/cmd_bootm.c	No uncompress/copy overwrite error
2794c609719bSwdenk   -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
27951372cce2SMarian Balakowicz
27961372cce2SMarian Balakowicz    9	common/image.c		Start initial ramdisk verification
27971372cce2SMarian Balakowicz  -10	common/image.c		Ramdisk header has bad	   magic number
27981372cce2SMarian Balakowicz  -11	common/image.c		Ramdisk header has bad	   checksum
27991372cce2SMarian Balakowicz   10	common/image.c		Ramdisk header is OK
28001372cce2SMarian Balakowicz  -12	common/image.c		Ramdisk data   has bad	   checksum
28011372cce2SMarian Balakowicz   11	common/image.c		Ramdisk data   has correct checksum
28021372cce2SMarian Balakowicz   12	common/image.c		Ramdisk verification complete, start loading
280311ccc33fSMarcel Ziswiler  -13	common/image.c		Wrong Image Type (not PPC Linux ramdisk)
28041372cce2SMarian Balakowicz   13	common/image.c		Start multifile image verification
28051372cce2SMarian Balakowicz   14	common/image.c		No initial ramdisk, no multifile, continue.
28061372cce2SMarian Balakowicz
2807ea0364f1SPeter Tyser   15	arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
2808c609719bSwdenk
2809a47a12beSStefan Roese  -30	arch/powerpc/lib/board.c	Fatal error, hang the system
281063e73c9aSwdenk  -31	post/post.c		POST test failed, detected by post_output_backlog()
281163e73c9aSwdenk  -32	post/post.c		POST test failed, detected by post_run_single()
281263e73c9aSwdenk
2813566a494fSHeiko Schocher   34	common/cmd_doc.c	before loading a Image from a DOC device
2814566a494fSHeiko Schocher  -35	common/cmd_doc.c	Bad usage of "doc" command
2815566a494fSHeiko Schocher   35	common/cmd_doc.c	correct usage of "doc" command
2816566a494fSHeiko Schocher  -36	common/cmd_doc.c	No boot device
2817566a494fSHeiko Schocher   36	common/cmd_doc.c	correct boot device
2818566a494fSHeiko Schocher  -37	common/cmd_doc.c	Unknown Chip ID on boot device
2819566a494fSHeiko Schocher   37	common/cmd_doc.c	correct chip ID found, device available
2820566a494fSHeiko Schocher  -38	common/cmd_doc.c	Read Error on boot device
2821566a494fSHeiko Schocher   38	common/cmd_doc.c	reading Image header from DOC device OK
2822566a494fSHeiko Schocher  -39	common/cmd_doc.c	Image header has bad magic number
2823566a494fSHeiko Schocher   39	common/cmd_doc.c	Image header has correct magic number
2824566a494fSHeiko Schocher  -40	common/cmd_doc.c	Error reading Image from DOC device
2825566a494fSHeiko Schocher   40	common/cmd_doc.c	Image header has correct magic number
2826566a494fSHeiko Schocher   41	common/cmd_ide.c	before loading a Image from a IDE device
2827566a494fSHeiko Schocher  -42	common/cmd_ide.c	Bad usage of "ide" command
2828566a494fSHeiko Schocher   42	common/cmd_ide.c	correct usage of "ide" command
2829566a494fSHeiko Schocher  -43	common/cmd_ide.c	No boot device
2830566a494fSHeiko Schocher   43	common/cmd_ide.c	boot device found
2831566a494fSHeiko Schocher  -44	common/cmd_ide.c	Device not available
2832566a494fSHeiko Schocher   44	common/cmd_ide.c	Device available
2833566a494fSHeiko Schocher  -45	common/cmd_ide.c	wrong partition selected
2834566a494fSHeiko Schocher   45	common/cmd_ide.c	partition selected
2835566a494fSHeiko Schocher  -46	common/cmd_ide.c	Unknown partition table
2836566a494fSHeiko Schocher   46	common/cmd_ide.c	valid partition table found
2837566a494fSHeiko Schocher  -47	common/cmd_ide.c	Invalid partition type
2838566a494fSHeiko Schocher   47	common/cmd_ide.c	correct partition type
2839566a494fSHeiko Schocher  -48	common/cmd_ide.c	Error reading Image Header on boot device
2840566a494fSHeiko Schocher   48	common/cmd_ide.c	reading Image Header from IDE device OK
2841566a494fSHeiko Schocher  -49	common/cmd_ide.c	Image header has bad magic number
2842566a494fSHeiko Schocher   49	common/cmd_ide.c	Image header has correct magic number
2843566a494fSHeiko Schocher  -50	common/cmd_ide.c	Image header has bad	 checksum
2844566a494fSHeiko Schocher   50	common/cmd_ide.c	Image header has correct checksum
2845566a494fSHeiko Schocher  -51	common/cmd_ide.c	Error reading Image from IDE device
2846566a494fSHeiko Schocher   51	common/cmd_ide.c	reading Image from IDE device OK
2847566a494fSHeiko Schocher   52	common/cmd_nand.c	before loading a Image from a NAND device
2848566a494fSHeiko Schocher  -53	common/cmd_nand.c	Bad usage of "nand" command
2849566a494fSHeiko Schocher   53	common/cmd_nand.c	correct usage of "nand" command
2850566a494fSHeiko Schocher  -54	common/cmd_nand.c	No boot device
2851566a494fSHeiko Schocher   54	common/cmd_nand.c	boot device found
2852566a494fSHeiko Schocher  -55	common/cmd_nand.c	Unknown Chip ID on boot device
2853566a494fSHeiko Schocher   55	common/cmd_nand.c	correct chip ID found, device available
2854566a494fSHeiko Schocher  -56	common/cmd_nand.c	Error reading Image Header on boot device
2855566a494fSHeiko Schocher   56	common/cmd_nand.c	reading Image Header from NAND device OK
2856566a494fSHeiko Schocher  -57	common/cmd_nand.c	Image header has bad magic number
2857566a494fSHeiko Schocher   57	common/cmd_nand.c	Image header has correct magic number
2858566a494fSHeiko Schocher  -58	common/cmd_nand.c	Error reading Image from NAND device
2859566a494fSHeiko Schocher   58	common/cmd_nand.c	reading Image from NAND device OK
2860c609719bSwdenk
2861566a494fSHeiko Schocher  -60	common/env_common.c	Environment has a bad CRC, using default
2862c609719bSwdenk
2863566a494fSHeiko Schocher   64	net/eth.c		starting with Ethernet configuration.
2864566a494fSHeiko Schocher  -64	net/eth.c		no Ethernet found.
2865566a494fSHeiko Schocher   65	net/eth.c		Ethernet found.
2866206c60cbSwdenk
2867566a494fSHeiko Schocher  -80	common/cmd_net.c	usage wrong
2868566a494fSHeiko Schocher   80	common/cmd_net.c	before calling NetLoop()
286911ccc33fSMarcel Ziswiler  -81	common/cmd_net.c	some error in NetLoop() occurred
2870566a494fSHeiko Schocher   81	common/cmd_net.c	NetLoop() back without error
2871566a494fSHeiko Schocher  -82	common/cmd_net.c	size == 0 (File with size 0 loaded)
2872566a494fSHeiko Schocher   82	common/cmd_net.c	trying automatic boot
287374de7aefSWolfgang Denk   83	common/cmd_net.c	running "source" command
287474de7aefSWolfgang Denk  -83	common/cmd_net.c	some error in automatic boot or "source" command
2875566a494fSHeiko Schocher   84	common/cmd_net.c	end without errors
2876c609719bSwdenk
28771372cce2SMarian BalakowiczFIT uImage format:
28781372cce2SMarian Balakowicz
28791372cce2SMarian Balakowicz  Arg	Where			When
28801372cce2SMarian Balakowicz  100	common/cmd_bootm.c	Kernel FIT Image has correct format
28811372cce2SMarian Balakowicz -100	common/cmd_bootm.c	Kernel FIT Image has incorrect format
28821372cce2SMarian Balakowicz  101	common/cmd_bootm.c	No Kernel subimage unit name, using configuration
28831372cce2SMarian Balakowicz -101	common/cmd_bootm.c	Can't get configuration for kernel subimage
28841372cce2SMarian Balakowicz  102	common/cmd_bootm.c	Kernel unit name specified
28851372cce2SMarian Balakowicz -103	common/cmd_bootm.c	Can't get kernel subimage node offset
2886f773bea8SMarian Balakowicz  103	common/cmd_bootm.c	Found configuration node
28871372cce2SMarian Balakowicz  104	common/cmd_bootm.c	Got kernel subimage node offset
28881372cce2SMarian Balakowicz -104	common/cmd_bootm.c	Kernel subimage hash verification failed
28891372cce2SMarian Balakowicz  105	common/cmd_bootm.c	Kernel subimage hash verification OK
28901372cce2SMarian Balakowicz -105	common/cmd_bootm.c	Kernel subimage is for unsupported architecture
28911372cce2SMarian Balakowicz  106	common/cmd_bootm.c	Architecture check OK
289211ccc33fSMarcel Ziswiler -106	common/cmd_bootm.c	Kernel subimage has wrong type
289311ccc33fSMarcel Ziswiler  107	common/cmd_bootm.c	Kernel subimage type OK
28941372cce2SMarian Balakowicz -107	common/cmd_bootm.c	Can't get kernel subimage data/size
28951372cce2SMarian Balakowicz  108	common/cmd_bootm.c	Got kernel subimage data/size
28961372cce2SMarian Balakowicz -108	common/cmd_bootm.c	Wrong image type (not legacy, FIT)
28971372cce2SMarian Balakowicz -109	common/cmd_bootm.c	Can't get kernel subimage type
28981372cce2SMarian Balakowicz -110	common/cmd_bootm.c	Can't get kernel subimage comp
28991372cce2SMarian Balakowicz -111	common/cmd_bootm.c	Can't get kernel subimage os
29001372cce2SMarian Balakowicz -112	common/cmd_bootm.c	Can't get kernel subimage load address
29011372cce2SMarian Balakowicz -113	common/cmd_bootm.c	Image uncompress/copy overwrite error
29021372cce2SMarian Balakowicz
29031372cce2SMarian Balakowicz  120	common/image.c		Start initial ramdisk verification
29041372cce2SMarian Balakowicz -120	common/image.c		Ramdisk FIT image has incorrect format
29051372cce2SMarian Balakowicz  121	common/image.c		Ramdisk FIT image has correct format
290611ccc33fSMarcel Ziswiler  122	common/image.c		No ramdisk subimage unit name, using configuration
29071372cce2SMarian Balakowicz -122	common/image.c		Can't get configuration for ramdisk subimage
29081372cce2SMarian Balakowicz  123	common/image.c		Ramdisk unit name specified
29091372cce2SMarian Balakowicz -124	common/image.c		Can't get ramdisk subimage node offset
29101372cce2SMarian Balakowicz  125	common/image.c		Got ramdisk subimage node offset
29111372cce2SMarian Balakowicz -125	common/image.c		Ramdisk subimage hash verification failed
29121372cce2SMarian Balakowicz  126	common/image.c		Ramdisk subimage hash verification OK
29131372cce2SMarian Balakowicz -126	common/image.c		Ramdisk subimage for unsupported architecture
29141372cce2SMarian Balakowicz  127	common/image.c		Architecture check OK
29151372cce2SMarian Balakowicz -127	common/image.c		Can't get ramdisk subimage data/size
29161372cce2SMarian Balakowicz  128	common/image.c		Got ramdisk subimage data/size
29171372cce2SMarian Balakowicz  129	common/image.c		Can't get ramdisk load address
29181372cce2SMarian Balakowicz -129	common/image.c		Got ramdisk load address
29191372cce2SMarian Balakowicz
292011ccc33fSMarcel Ziswiler -130	common/cmd_doc.c	Incorrect FIT image format
29211372cce2SMarian Balakowicz  131	common/cmd_doc.c	FIT image format OK
29221372cce2SMarian Balakowicz
292311ccc33fSMarcel Ziswiler -140	common/cmd_ide.c	Incorrect FIT image format
29241372cce2SMarian Balakowicz  141	common/cmd_ide.c	FIT image format OK
29251372cce2SMarian Balakowicz
292611ccc33fSMarcel Ziswiler -150	common/cmd_nand.c	Incorrect FIT image format
29271372cce2SMarian Balakowicz  151	common/cmd_nand.c	FIT image format OK
29281372cce2SMarian Balakowicz
2929d95f6ec7SGabe Black- FIT image support:
2930d95f6ec7SGabe Black		CONFIG_FIT
2931d95f6ec7SGabe Black		Enable support for the FIT uImage format.
2932d95f6ec7SGabe Black
2933d95f6ec7SGabe Black		CONFIG_FIT_BEST_MATCH
2934d95f6ec7SGabe Black		When no configuration is explicitly selected, default to the
2935d95f6ec7SGabe Black		one whose fdt's compatibility field best matches that of
2936d95f6ec7SGabe Black		U-Boot itself. A match is considered "best" if it matches the
2937d95f6ec7SGabe Black		most specific compatibility entry of U-Boot's fdt's root node.
2938d95f6ec7SGabe Black		The order of entries in the configuration's fdt is ignored.
2939d95f6ec7SGabe Black
29403e569a6bSSimon Glass		CONFIG_FIT_SIGNATURE
29413e569a6bSSimon Glass		This option enables signature verification of FIT uImages,
29423e569a6bSSimon Glass		using a hash signed and verified using RSA. See
29433e569a6bSSimon Glass		doc/uImage.FIT/signature.txt for more details.
29443e569a6bSSimon Glass
29454cf2609bSWolfgang Denk- Standalone program support:
29464cf2609bSWolfgang Denk		CONFIG_STANDALONE_LOAD_ADDR
29474cf2609bSWolfgang Denk
29486feff899SWolfgang Denk		This option defines a board specific value for the
29496feff899SWolfgang Denk		address where standalone program gets loaded, thus
29506feff899SWolfgang Denk		overwriting the architecture dependent default
29514cf2609bSWolfgang Denk		settings.
29524cf2609bSWolfgang Denk
29534cf2609bSWolfgang Denk- Frame Buffer Address:
29544cf2609bSWolfgang Denk		CONFIG_FB_ADDR
29554cf2609bSWolfgang Denk
29564cf2609bSWolfgang Denk		Define CONFIG_FB_ADDR if you want to use specific
295744a53b57SWolfgang Denk		address for frame buffer.  This is typically the case
295844a53b57SWolfgang Denk		when using a graphics controller has separate video
295944a53b57SWolfgang Denk		memory.  U-Boot will then place the frame buffer at
296044a53b57SWolfgang Denk		the given address instead of dynamically reserving it
296144a53b57SWolfgang Denk		in system RAM by calling lcd_setmem(), which grabs
296244a53b57SWolfgang Denk		the memory for the frame buffer depending on the
296344a53b57SWolfgang Denk		configured panel size.
29644cf2609bSWolfgang Denk
29654cf2609bSWolfgang Denk		Please see board_init_f function.
29664cf2609bSWolfgang Denk
2967cccfc2abSDetlev Zundel- Automatic software updates via TFTP server
2968cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP
2969cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_CNT_MAX
2970cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_MSEC_MAX
2971cccfc2abSDetlev Zundel
2972cccfc2abSDetlev Zundel		These options enable and control the auto-update feature;
2973cccfc2abSDetlev Zundel		for a more detailed description refer to doc/README.update.
2974cccfc2abSDetlev Zundel
2975cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support)
2976cccfc2abSDetlev Zundel		CONFIG_MTD_DEVICE
2977cccfc2abSDetlev Zundel
2978cccfc2abSDetlev Zundel		Adds the MTD device infrastructure from the Linux kernel.
2979cccfc2abSDetlev Zundel		Needed for mtdparts command support.
2980cccfc2abSDetlev Zundel
2981cccfc2abSDetlev Zundel		CONFIG_MTD_PARTITIONS
2982cccfc2abSDetlev Zundel
2983cccfc2abSDetlev Zundel		Adds the MTD partitioning infrastructure from the Linux
2984cccfc2abSDetlev Zundel		kernel. Needed for UBI support.
2985cccfc2abSDetlev Zundel
298670c219cdSJoe Hershberger- UBI support
298770c219cdSJoe Hershberger		CONFIG_CMD_UBI
298870c219cdSJoe Hershberger
298970c219cdSJoe Hershberger		Adds commands for interacting with MTD partitions formatted
299070c219cdSJoe Hershberger		with the UBI flash translation layer
299170c219cdSJoe Hershberger
299270c219cdSJoe Hershberger		Requires also defining CONFIG_RBTREE
299370c219cdSJoe Hershberger
2994147162daSJoe Hershberger		CONFIG_UBI_SILENCE_MSG
2995147162daSJoe Hershberger
2996147162daSJoe Hershberger		Make the verbose messages from UBI stop printing.  This leaves
2997147162daSJoe Hershberger		warnings and errors enabled.
2998147162daSJoe Hershberger
299970c219cdSJoe Hershberger- UBIFS support
300070c219cdSJoe Hershberger		CONFIG_CMD_UBIFS
300170c219cdSJoe Hershberger
300270c219cdSJoe Hershberger		Adds commands for interacting with UBI volumes formatted as
300370c219cdSJoe Hershberger		UBIFS.  UBIFS is read-only in u-boot.
300470c219cdSJoe Hershberger
300570c219cdSJoe Hershberger		Requires UBI support as well as CONFIG_LZO
300670c219cdSJoe Hershberger
3007147162daSJoe Hershberger		CONFIG_UBIFS_SILENCE_MSG
3008147162daSJoe Hershberger
3009147162daSJoe Hershberger		Make the verbose messages from UBIFS stop printing.  This leaves
3010147162daSJoe Hershberger		warnings and errors enabled.
3011147162daSJoe Hershberger
30126a11cf48SDaniel Schwierzeck- SPL framework
30136a11cf48SDaniel Schwierzeck		CONFIG_SPL
30146a11cf48SDaniel Schwierzeck		Enable building of SPL globally.
30156a11cf48SDaniel Schwierzeck
301695579793STom Rini		CONFIG_SPL_LDSCRIPT
301795579793STom Rini		LDSCRIPT for linking the SPL binary.
301895579793STom Rini
30196ebc3461SAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT
30206ebc3461SAlbert ARIBAUD		Maximum size in memory allocated to the SPL, BSS included.
30216ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual memory
30226ebc3461SAlbert ARIBAUD		used by SPL from _start to __bss_end does not exceed it.
30238960af8bSAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
30246ebc3461SAlbert ARIBAUD		must not be both defined at the same time.
30256ebc3461SAlbert ARIBAUD
302695579793STom Rini		CONFIG_SPL_MAX_SIZE
30276ebc3461SAlbert ARIBAUD		Maximum size of the SPL image (text, data, rodata, and
30286ebc3461SAlbert ARIBAUD		linker lists sections), BSS excluded.
30296ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual size does
30306ebc3461SAlbert ARIBAUD		not exceed it.
303195579793STom Rini
30326a11cf48SDaniel Schwierzeck		CONFIG_SPL_TEXT_BASE
30336a11cf48SDaniel Schwierzeck		TEXT_BASE for linking the SPL binary.
30346a11cf48SDaniel Schwierzeck
303594a45bb1SScott Wood		CONFIG_SPL_RELOC_TEXT_BASE
303694a45bb1SScott Wood		Address to relocate to.  If unspecified, this is equal to
303794a45bb1SScott Wood		CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
303894a45bb1SScott Wood
303995579793STom Rini		CONFIG_SPL_BSS_START_ADDR
304095579793STom Rini		Link address for the BSS within the SPL binary.
304195579793STom Rini
304295579793STom Rini		CONFIG_SPL_BSS_MAX_SIZE
30436ebc3461SAlbert ARIBAUD		Maximum size in memory allocated to the SPL BSS.
30446ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual memory used
30456ebc3461SAlbert ARIBAUD		by SPL from __bss_start to __bss_end does not exceed it.
30468960af8bSAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
30476ebc3461SAlbert ARIBAUD		must not be both defined at the same time.
304895579793STom Rini
304995579793STom Rini		CONFIG_SPL_STACK
305095579793STom Rini		Adress of the start of the stack SPL will use
305195579793STom Rini
305294a45bb1SScott Wood		CONFIG_SPL_RELOC_STACK
305394a45bb1SScott Wood		Adress of the start of the stack SPL will use after
305494a45bb1SScott Wood		relocation.  If unspecified, this is equal to
305594a45bb1SScott Wood		CONFIG_SPL_STACK.
305694a45bb1SScott Wood
305795579793STom Rini		CONFIG_SYS_SPL_MALLOC_START
305895579793STom Rini		Starting address of the malloc pool used in SPL.
305995579793STom Rini
306095579793STom Rini		CONFIG_SYS_SPL_MALLOC_SIZE
306195579793STom Rini		The size of the malloc pool used in SPL.
30626a11cf48SDaniel Schwierzeck
306347f7bcaeSTom Rini		CONFIG_SPL_FRAMEWORK
306447f7bcaeSTom Rini		Enable the SPL framework under common/.  This framework
306547f7bcaeSTom Rini		supports MMC, NAND and YMODEM loading of U-Boot and NAND
306647f7bcaeSTom Rini		NAND loading of the Linux Kernel.
306747f7bcaeSTom Rini
3068861a86f4STom Rini		CONFIG_SPL_DISPLAY_PRINT
3069861a86f4STom Rini		For ARM, enable an optional function to print more information
3070861a86f4STom Rini		about the running system.
3071861a86f4STom Rini
30724b919725SScott Wood		CONFIG_SPL_INIT_MINIMAL
30734b919725SScott Wood		Arch init code should be built for a very small image
30744b919725SScott Wood
30756a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBCOMMON_SUPPORT
30766a11cf48SDaniel Schwierzeck		Support for common/libcommon.o in SPL binary
30776a11cf48SDaniel Schwierzeck
30786a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBDISK_SUPPORT
30796a11cf48SDaniel Schwierzeck		Support for disk/libdisk.o in SPL binary
30806a11cf48SDaniel Schwierzeck
30816a11cf48SDaniel Schwierzeck		CONFIG_SPL_I2C_SUPPORT
30826a11cf48SDaniel Schwierzeck		Support for drivers/i2c/libi2c.o in SPL binary
30836a11cf48SDaniel Schwierzeck
30846a11cf48SDaniel Schwierzeck		CONFIG_SPL_GPIO_SUPPORT
30856a11cf48SDaniel Schwierzeck		Support for drivers/gpio/libgpio.o in SPL binary
30866a11cf48SDaniel Schwierzeck
30876a11cf48SDaniel Schwierzeck		CONFIG_SPL_MMC_SUPPORT
30886a11cf48SDaniel Schwierzeck		Support for drivers/mmc/libmmc.o in SPL binary
30896a11cf48SDaniel Schwierzeck
309095579793STom Rini		CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
309195579793STom Rini		CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
309295579793STom Rini		CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION
309395579793STom Rini		Address, size and partition on the MMC to load U-Boot from
309495579793STom Rini		when the MMC is being used in raw mode.
309595579793STom Rini
30962b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
30972b75b0adSPeter Korsgaard		Sector to load kernel uImage from when MMC is being
30982b75b0adSPeter Korsgaard		used in raw mode (for Falcon mode)
30992b75b0adSPeter Korsgaard
31002b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
31012b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
31022b75b0adSPeter Korsgaard		Sector and number of sectors to load kernel argument
31032b75b0adSPeter Korsgaard		parameters from when MMC is being used in raw mode
31042b75b0adSPeter Korsgaard		(for falcon mode)
31052b75b0adSPeter Korsgaard
310695579793STom Rini		CONFIG_SPL_FAT_SUPPORT
310795579793STom Rini		Support for fs/fat/libfat.o in SPL binary
310895579793STom Rini
310995579793STom Rini		CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME
311095579793STom Rini		Filename to read to load U-Boot when reading from FAT
311195579793STom Rini
31127ad2cc79SPeter Korsgaard		CONFIG_SPL_FAT_LOAD_KERNEL_NAME
31137ad2cc79SPeter Korsgaard		Filename to read to load kernel uImage when reading
31147ad2cc79SPeter Korsgaard		from FAT (for Falcon mode)
31157ad2cc79SPeter Korsgaard
31167ad2cc79SPeter Korsgaard		CONFIG_SPL_FAT_LOAD_ARGS_NAME
31177ad2cc79SPeter Korsgaard		Filename to read to load kernel argument parameters
31187ad2cc79SPeter Korsgaard		when reading from FAT (for Falcon mode)
31197ad2cc79SPeter Korsgaard
312006f60ae3SScott Wood		CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
312106f60ae3SScott Wood		Set this for NAND SPL on PPC mpc83xx targets, so that
312206f60ae3SScott Wood		start.S waits for the rest of the SPL to load before
312306f60ae3SScott Wood		continuing (the hardware starts execution after just
312406f60ae3SScott Wood		loading the first page rather than the full 4K).
312506f60ae3SScott Wood
31266f2f01b9SScott Wood		CONFIG_SPL_NAND_BASE
31276f2f01b9SScott Wood		Include nand_base.c in the SPL.  Requires
31286f2f01b9SScott Wood		CONFIG_SPL_NAND_DRIVERS.
31296f2f01b9SScott Wood
31306f2f01b9SScott Wood		CONFIG_SPL_NAND_DRIVERS
31316f2f01b9SScott Wood		SPL uses normal NAND drivers, not minimal drivers.
31326f2f01b9SScott Wood
31336f2f01b9SScott Wood		CONFIG_SPL_NAND_ECC
31346f2f01b9SScott Wood		Include standard software ECC in the SPL
31356f2f01b9SScott Wood
313695579793STom Rini		CONFIG_SPL_NAND_SIMPLE
31377d4b7955SScott Wood		Support for NAND boot using simple NAND drivers that
31387d4b7955SScott Wood		expose the cmd_ctrl() interface.
313995579793STom Rini
3140bb0dc108SYing Zhang		CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT
3141bb0dc108SYing Zhang		Set for the SPL on PPC mpc8xxx targets, support for
3142bb0dc108SYing Zhang		arch/powerpc/cpu/mpc8xxx/ddr/libddr.o in SPL binary.
3143bb0dc108SYing Zhang
31447c8eea59SYing Zhang		CONFIG_SPL_COMMON_INIT_DDR
31457c8eea59SYing Zhang		Set for common ddr init with serial presence detect in
31467c8eea59SYing Zhang		SPL binary.
31477c8eea59SYing Zhang
314895579793STom Rini		CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
314995579793STom Rini		CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
315095579793STom Rini		CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
315195579793STom Rini		CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
315295579793STom Rini		CONFIG_SYS_NAND_ECCBYTES
315395579793STom Rini		Defines the size and behavior of the NAND that SPL uses
31547d4b7955SScott Wood		to read U-Boot
315595579793STom Rini
315695579793STom Rini		CONFIG_SYS_NAND_U_BOOT_OFFS
31577d4b7955SScott Wood		Location in NAND to read U-Boot from
31587d4b7955SScott Wood
31597d4b7955SScott Wood		CONFIG_SYS_NAND_U_BOOT_DST
31607d4b7955SScott Wood		Location in memory to load U-Boot to
31617d4b7955SScott Wood
31627d4b7955SScott Wood		CONFIG_SYS_NAND_U_BOOT_SIZE
31637d4b7955SScott Wood		Size of image to load
316495579793STom Rini
316595579793STom Rini		CONFIG_SYS_NAND_U_BOOT_START
31667d4b7955SScott Wood		Entry point in loaded image to jump to
316795579793STom Rini
316895579793STom Rini		CONFIG_SYS_NAND_HW_ECC_OOBFIRST
316995579793STom Rini		Define this if you need to first read the OOB and then the
317095579793STom Rini		data. This is used for example on davinci plattforms.
317195579793STom Rini
317295579793STom Rini		CONFIG_SPL_OMAP3_ID_NAND
317395579793STom Rini		Support for an OMAP3-specific set of functions to return the
317495579793STom Rini		ID and MFR of the first attached NAND chip, if present.
317595579793STom Rini
31766a11cf48SDaniel Schwierzeck		CONFIG_SPL_SERIAL_SUPPORT
31776a11cf48SDaniel Schwierzeck		Support for drivers/serial/libserial.o in SPL binary
31786a11cf48SDaniel Schwierzeck
31796a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_FLASH_SUPPORT
31806a11cf48SDaniel Schwierzeck		Support for drivers/mtd/spi/libspi_flash.o in SPL binary
31816a11cf48SDaniel Schwierzeck
31826a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_SUPPORT
31836a11cf48SDaniel Schwierzeck		Support for drivers/spi/libspi.o in SPL binary
31846a11cf48SDaniel Schwierzeck
3185c57b953dSPavel Machek		CONFIG_SPL_RAM_DEVICE
3186c57b953dSPavel Machek		Support for running image already present in ram, in SPL binary
3187c57b953dSPavel Machek
31886a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBGENERIC_SUPPORT
31896a11cf48SDaniel Schwierzeck		Support for lib/libgeneric.o in SPL binary
31901372cce2SMarian Balakowicz
3191ba1bee43SYing Zhang		CONFIG_SPL_ENV_SUPPORT
3192ba1bee43SYing Zhang		Support for the environment operating in SPL binary
3193ba1bee43SYing Zhang
3194ba1bee43SYing Zhang		CONFIG_SPL_NET_SUPPORT
3195ba1bee43SYing Zhang		Support for the net/libnet.o in SPL binary.
3196ba1bee43SYing Zhang		It conflicts with SPL env from storage medium specified by
3197ba1bee43SYing Zhang		CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3198ba1bee43SYing Zhang
319974752baaSScott Wood		CONFIG_SPL_PAD_TO
32006113d3f2SBenoît Thébaudeau		Image offset to which the SPL should be padded before appending
32016113d3f2SBenoît Thébaudeau		the SPL payload. By default, this is defined as
32026113d3f2SBenoît Thébaudeau		CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
32036113d3f2SBenoît Thébaudeau		CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
32046113d3f2SBenoît Thébaudeau		payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
320574752baaSScott Wood
3206ca2fca22SScott Wood		CONFIG_SPL_TARGET
3207ca2fca22SScott Wood		Final target image containing SPL and payload.  Some SPLs
3208ca2fca22SScott Wood		use an arch-specific makefile fragment instead, for
3209ca2fca22SScott Wood		example if more than one image needs to be produced.
3210ca2fca22SScott Wood
321187ebee39SSimon Glass		CONFIG_FIT_SPL_PRINT
321287ebee39SSimon Glass		Printing information about a FIT image adds quite a bit of
321387ebee39SSimon Glass		code to SPL. So this is normally disabled in SPL. Use this
321487ebee39SSimon Glass		option to re-enable it. This will affect the output of the
321587ebee39SSimon Glass		bootm command when booting a FIT image.
321687ebee39SSimon Glass
32173aa29de0SYing Zhang- TPL framework
32183aa29de0SYing Zhang		CONFIG_TPL
32193aa29de0SYing Zhang		Enable building of TPL globally.
32203aa29de0SYing Zhang
32213aa29de0SYing Zhang		CONFIG_TPL_PAD_TO
32223aa29de0SYing Zhang		Image offset to which the TPL should be padded before appending
32233aa29de0SYing Zhang		the TPL payload. By default, this is defined as
32243aa29de0SYing Zhang		CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
32253aa29de0SYing Zhang		CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
32263aa29de0SYing Zhang		payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
32273aa29de0SYing Zhang
3228c609719bSwdenkModem Support:
3229c609719bSwdenk--------------
3230c609719bSwdenk
3231566e5cf4SWolfgang Denk[so far only for SMDK2400 boards]
3232c609719bSwdenk
323311ccc33fSMarcel Ziswiler- Modem support enable:
3234c609719bSwdenk		CONFIG_MODEM_SUPPORT
3235c609719bSwdenk
3236c609719bSwdenk- RTS/CTS Flow control enable:
3237c609719bSwdenk		CONFIG_HWFLOW
3238c609719bSwdenk
3239c609719bSwdenk- Modem debug support:
3240c609719bSwdenk		CONFIG_MODEM_SUPPORT_DEBUG
3241c609719bSwdenk
3242c609719bSwdenk		Enables debugging stuff (char screen[1024], dbg())
3243c609719bSwdenk		for modem support. Useful only with BDI2000.
3244c609719bSwdenk
3245a8c7c708Swdenk- Interrupt support (PPC):
3246a8c7c708Swdenk
3247a8c7c708Swdenk		There are common interrupt_init() and timer_interrupt()
3248a8c7c708Swdenk		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
324911ccc33fSMarcel Ziswiler		for CPU specific initialization. interrupt_init_cpu()
3250a8c7c708Swdenk		should set decrementer_count to appropriate value. If
325111ccc33fSMarcel Ziswiler		CPU resets decrementer automatically after interrupt
3252a8c7c708Swdenk		(ppc4xx) it should set decrementer_count to zero.
325311ccc33fSMarcel Ziswiler		timer_interrupt() calls timer_interrupt_cpu() for CPU
3254a8c7c708Swdenk		specific handling. If board has watchdog / status_led
3255a8c7c708Swdenk		/ other_activity_monitor it works automatically from
3256a8c7c708Swdenk		general timer_interrupt().
3257a8c7c708Swdenk
3258c609719bSwdenk- General:
3259c609719bSwdenk
3260c609719bSwdenk		In the target system modem support is enabled when a
3261c609719bSwdenk		specific key (key combination) is pressed during
3262c609719bSwdenk		power-on. Otherwise U-Boot will boot normally
326311ccc33fSMarcel Ziswiler		(autoboot). The key_pressed() function is called from
3264c609719bSwdenk		board_init(). Currently key_pressed() is a dummy
3265c609719bSwdenk		function, returning 1 and thus enabling modem
3266c609719bSwdenk		initialization.
3267c609719bSwdenk
3268c609719bSwdenk		If there are no modem init strings in the
3269c609719bSwdenk		environment, U-Boot proceed to autoboot; the
3270c609719bSwdenk		previous output (banner, info printfs) will be
327111ccc33fSMarcel Ziswiler		suppressed, though.
3272c609719bSwdenk
3273c609719bSwdenk		See also: doc/README.Modem
3274c609719bSwdenk
32759660e442SHelmut RaigerBoard initialization settings:
32769660e442SHelmut Raiger------------------------------
32779660e442SHelmut Raiger
32789660e442SHelmut RaigerDuring Initialization u-boot calls a number of board specific functions
32799660e442SHelmut Raigerto allow the preparation of board specific prerequisites, e.g. pin setup
32809660e442SHelmut Raigerbefore drivers are initialized. To enable these callbacks the
32819660e442SHelmut Raigerfollowing configuration macros have to be defined. Currently this is
32829660e442SHelmut Raigerarchitecture specific, so please check arch/your_architecture/lib/board.c
32839660e442SHelmut Raigertypically in board_init_f() and board_init_r().
32849660e442SHelmut Raiger
32859660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
32869660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
32879660e442SHelmut Raiger- CONFIG_BOARD_LATE_INIT: Call board_late_init()
32889660e442SHelmut Raiger- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
3289c609719bSwdenk
3290c609719bSwdenkConfiguration Settings:
3291c609719bSwdenk-----------------------
3292c609719bSwdenk
32936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
3294c609719bSwdenk		undefine this when you're short of memory.
3295c609719bSwdenk
32962fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
32972fb2604dSPeter Tyser		width of the commands listed in the 'help' command output.
32982fb2604dSPeter Tyser
32996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT:	This is what U-Boot prints on the console to
3300c609719bSwdenk		prompt for user input.
3301c609719bSwdenk
33026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE:	Buffer size for input from the Console
3303c609719bSwdenk
33046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE:	Buffer size for Console output
3305c609719bSwdenk
33066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS:	max. Number of arguments accepted for monitor commands
3307c609719bSwdenk
33086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
3309c609719bSwdenk		the application (usually a Linux kernel) when it is
3310c609719bSwdenk		booted
3311c609719bSwdenk
33126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE:
3313c609719bSwdenk		List of legal baudrate settings for this board.
3314c609719bSwdenk
33156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_INFO_QUIET
3316c609719bSwdenk		Suppress display of console information at boot.
3317c609719bSwdenk
33186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_IS_IN_ENV
3319c609719bSwdenk		If the board specific function
3320c609719bSwdenk			extern int overwrite_console (void);
3321c609719bSwdenk		returns 1, the stdin, stderr and stdout are switched to the
3322c609719bSwdenk		serial port, else the settings in the environment are used.
3323c609719bSwdenk
33246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
3325c609719bSwdenk		Enable the call to overwrite_console().
3326c609719bSwdenk
33276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
3328c609719bSwdenk		Enable overwrite of previous console environment settings.
3329c609719bSwdenk
33306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
3331c609719bSwdenk		Begin and End addresses of the area used by the
3332c609719bSwdenk		simple memory test.
3333c609719bSwdenk
33346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST:
3335c609719bSwdenk		Enable an alternate, more extensive memory test.
3336c609719bSwdenk
33376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH:
33385f535fe1Swdenk		Scratch address used by the alternate memory test
33395f535fe1Swdenk		You only need to set this if address zero isn't writeable
33405f535fe1Swdenk
33416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
33426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
334314f73ca6SStefan Roese		this specified memory area will get subtracted from the top
334411ccc33fSMarcel Ziswiler		(end) of RAM and won't get "touched" at all by U-Boot. By
334514f73ca6SStefan Roese		fixing up gd->ram_size the Linux kernel should gets passed
334614f73ca6SStefan Roese		the now "corrected" memory size and won't touch it either.
334714f73ca6SStefan Roese		This should work for arch/ppc and arch/powerpc. Only Linux
33485e12e75dSStefan Roese		board ports in arch/powerpc with bootwrapper support that
334914f73ca6SStefan Roese		recalculate the memory size from the SDRAM controller setup
33505e12e75dSStefan Roese		will have to get fixed in Linux additionally.
335114f73ca6SStefan Roese
335214f73ca6SStefan Roese		This option can be used as a workaround for the 440EPx/GRx
335314f73ca6SStefan Roese		CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
335414f73ca6SStefan Roese		be touched.
335514f73ca6SStefan Roese
335614f73ca6SStefan Roese		WARNING: Please make sure that this value is a multiple of
335714f73ca6SStefan Roese		the Linux page size (normally 4k). If this is not the case,
335814f73ca6SStefan Roese		then the end address of the Linux memory will be located at a
335914f73ca6SStefan Roese		non page size aligned address and this could cause major
336014f73ca6SStefan Roese		problems.
336114f73ca6SStefan Roese
33626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE:
3363c609719bSwdenk		Enable temporary baudrate change while serial download
3364c609719bSwdenk
33656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE:
3366c609719bSwdenk		Physical start address of SDRAM. _Must_ be 0 here.
3367c609719bSwdenk
33686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MBIO_BASE:
3369c609719bSwdenk		Physical start address of Motherboard I/O (if using a
3370c609719bSwdenk		Cogent motherboard)
3371c609719bSwdenk
33726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE:
3373c609719bSwdenk		Physical start address of Flash memory.
3374c609719bSwdenk
33756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE:
3376c609719bSwdenk		Physical start address of boot monitor code (set by
3377c609719bSwdenk		make config files to be same as the text base address
337814d0a02aSWolfgang Denk		(CONFIG_SYS_TEXT_BASE) used when linking) - same as
33796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FLASH_BASE when booting from flash.
3380c609719bSwdenk
33816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN:
33823b57fe0aSwdenk		Size of memory reserved for monitor code, used to
33833b57fe0aSwdenk		determine _at_compile_time_ (!) if the environment is
33843b57fe0aSwdenk		embedded within the U-Boot image, or in a separate
33853b57fe0aSwdenk		flash sector.
3386c609719bSwdenk
33876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN:
3388c609719bSwdenk		Size of DRAM reserved for malloc() use.
3389c609719bSwdenk
33906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN:
339115940c9aSStefan Roese		Normally compressed uImages are limited to an
339215940c9aSStefan Roese		uncompressed size of 8 MBytes. If this is not enough,
33936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		you can define CONFIG_SYS_BOOTM_LEN in your board config file
339415940c9aSStefan Roese		to adjust this setting to your needs.
3395c609719bSwdenk
33966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ:
3397c609719bSwdenk		Maximum size of memory mapped by the startup code of
3398c609719bSwdenk		the Linux kernel; all data that must be processed by
33997d721e34SBartlomiej Sieka		the Linux kernel (bd_info, boot arguments, FDT blob if
34007d721e34SBartlomiej Sieka		used) must be put below this limit, unless "bootm_low"
34011bce2aebSRobert P. J. Day		environment variable is defined and non-zero. In such case
34027d721e34SBartlomiej Sieka		all data for the Linux kernel must be between "bootm_low"
3403c3624e6eSGrant Likely		and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.	 The environment
3404c3624e6eSGrant Likely		variable "bootm_mapsize" will override the value of
3405c3624e6eSGrant Likely		CONFIG_SYS_BOOTMAPSZ.  If CONFIG_SYS_BOOTMAPSZ is undefined,
3406c3624e6eSGrant Likely		then the value in "bootm_size" will be used instead.
3407c609719bSwdenk
3408fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3409fca43cc8SJohn Rigby		Enable initrd_high functionality.  If defined then the
3410fca43cc8SJohn Rigby		initrd_high feature is enabled and the bootm ramdisk subcommand
3411fca43cc8SJohn Rigby		is enabled.
3412fca43cc8SJohn Rigby
3413fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_CMDLINE:
3414fca43cc8SJohn Rigby		Enables allocating and saving kernel cmdline in space between
3415fca43cc8SJohn Rigby		"bootm_low" and "bootm_low" + BOOTMAPSZ.
3416fca43cc8SJohn Rigby
3417fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_KBD:
3418fca43cc8SJohn Rigby		Enables allocating and saving a kernel copy of the bd_info in
3419fca43cc8SJohn Rigby		space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3420fca43cc8SJohn Rigby
34216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS:
3422c609719bSwdenk		Max number of Flash memory banks
3423c609719bSwdenk
34246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT:
3425c609719bSwdenk		Max number of sectors on a Flash chip
3426c609719bSwdenk
34276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT:
3428c609719bSwdenk		Timeout for Flash erase operations (in ms)
3429c609719bSwdenk
34306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT:
3431c609719bSwdenk		Timeout for Flash write operations (in ms)
3432c609719bSwdenk
34336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT
34348564acf9Swdenk		Timeout for Flash set sector lock bit operation (in ms)
34358564acf9Swdenk
34366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT
34378564acf9Swdenk		Timeout for Flash clear lock bits operation (in ms)
34388564acf9Swdenk
34396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION
34408564acf9Swdenk		If defined, hardware flash sectors protection is used
34418564acf9Swdenk		instead of U-Boot software protection.
34428564acf9Swdenk
34436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP:
3444c609719bSwdenk
3445c609719bSwdenk		Enable TFTP transfers directly to flash memory;
3446c609719bSwdenk		without this option such a download has to be
3447c609719bSwdenk		performed in two steps: (1) download to RAM, and (2)
3448c609719bSwdenk		copy from RAM to flash.
3449c609719bSwdenk
3450c609719bSwdenk		The two-step approach is usually more reliable, since
3451c609719bSwdenk		you can check if the download worked before you erase
345211ccc33fSMarcel Ziswiler		the flash, but in some situations (when system RAM is
345311ccc33fSMarcel Ziswiler		too limited to allow for a temporary copy of the
3454c609719bSwdenk		downloaded image) this option may be very useful.
3455c609719bSwdenk
34566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI:
3457c609719bSwdenk		Define if the flash driver uses extra elements in the
34585653fc33Swdenk		common flash structure for storing flash geometry.
34595653fc33Swdenk
346000b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER
34615653fc33Swdenk		This option also enables the building of the cfi_flash driver
34625653fc33Swdenk		in the drivers directory
346353cf9435Sstroese
346491809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD
346591809ed5SPiotr Ziecik		This option enables the building of the cfi_mtd driver
346691809ed5SPiotr Ziecik		in the drivers directory. The driver exports CFI flash
346791809ed5SPiotr Ziecik		to the MTD layer.
346891809ed5SPiotr Ziecik
34696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
347096ef831fSGuennadi Liakhovetski		Use buffered writes to flash.
347196ef831fSGuennadi Liakhovetski
347296ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N
347396ef831fSGuennadi Liakhovetski		s29ws-n MirrorBit flash has non-standard addresses for buffered
347496ef831fSGuennadi Liakhovetski		write commands.
347596ef831fSGuennadi Liakhovetski
34766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST
34775568e613SStefan Roese		If this option is defined, the common CFI flash doesn't
34785568e613SStefan Roese		print it's warning upon not recognized FLASH banks. This
34795568e613SStefan Roese		is useful, if some of the configured banks are only
34805568e613SStefan Roese		optionally available.
34815568e613SStefan Roese
34829a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS
34839a042e9cSJerry Van Baren		If defined (must be an integer), print out countdown
34849a042e9cSJerry Van Baren		digits and dots.  Recommended value: 45 (9..1) for 80
34859a042e9cSJerry Van Baren		column displays, 15 (3..1) for 40 column displays.
34869a042e9cSJerry Van Baren
3487352ef3f1SStefan Roese- CONFIG_FLASH_VERIFY
3488352ef3f1SStefan Roese		If defined, the content of the flash (destination) is compared
3489352ef3f1SStefan Roese		against the source after the write operation. An error message
3490352ef3f1SStefan Roese		will be printed when the contents are not identical.
3491352ef3f1SStefan Roese		Please note that this option is useless in nearly all cases,
3492352ef3f1SStefan Roese		since such flash programming errors usually are detected earlier
3493352ef3f1SStefan Roese		while unprotecting/erasing/programming. Please only enable
3494352ef3f1SStefan Roese		this option if you really know what you are doing.
3495352ef3f1SStefan Roese
34966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER:
349711ccc33fSMarcel Ziswiler		Defines the number of Ethernet receive buffers. On some
349811ccc33fSMarcel Ziswiler		Ethernet controllers it is recommended to set this value
349953cf9435Sstroese		to 8 or even higher (EEPRO100 or 405 EMAC), since all
350053cf9435Sstroese		buffers can be full shortly after enabling the interface
350111ccc33fSMarcel Ziswiler		on high Ethernet traffic.
350253cf9435Sstroese		Defaults to 4 if not defined.
3503c609719bSwdenk
3504ea882bafSWolfgang Denk- CONFIG_ENV_MAX_ENTRIES
3505ea882bafSWolfgang Denk
3506ea882bafSWolfgang Denk	Maximum number of entries in the hash table that is used
3507ea882bafSWolfgang Denk	internally to store the environment settings. The default
3508ea882bafSWolfgang Denk	setting is supposed to be generous and should work in most
3509ea882bafSWolfgang Denk	cases. This setting can be used to tune behaviour; see
3510ea882bafSWolfgang Denk	lib/hashtable.c for details.
3511ea882bafSWolfgang Denk
35122598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_DEFAULT
35132598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_STATIC
35141bce2aebSRobert P. J. Day	Enable validation of the values given to environment variables when
35152598090bSJoe Hershberger	calling env set.  Variables can be restricted to only decimal,
35162598090bSJoe Hershberger	hexadecimal, or boolean.  If CONFIG_CMD_NET is also defined,
35172598090bSJoe Hershberger	the variables can also be restricted to IP address or MAC address.
35182598090bSJoe Hershberger
35192598090bSJoe Hershberger	The format of the list is:
35202598090bSJoe Hershberger		type_attribute = [s|d|x|b|i|m]
3521267541f7SJoe Hershberger		access_atribute = [a|r|o|c]
3522267541f7SJoe Hershberger		attributes = type_attribute[access_atribute]
35232598090bSJoe Hershberger		entry = variable_name[:attributes]
35242598090bSJoe Hershberger		list = entry[,list]
35252598090bSJoe Hershberger
35262598090bSJoe Hershberger	The type attributes are:
35272598090bSJoe Hershberger		s - String (default)
35282598090bSJoe Hershberger		d - Decimal
35292598090bSJoe Hershberger		x - Hexadecimal
35302598090bSJoe Hershberger		b - Boolean ([1yYtT|0nNfF])
35312598090bSJoe Hershberger		i - IP address
35322598090bSJoe Hershberger		m - MAC address
35332598090bSJoe Hershberger
3534267541f7SJoe Hershberger	The access attributes are:
3535267541f7SJoe Hershberger		a - Any (default)
3536267541f7SJoe Hershberger		r - Read-only
3537267541f7SJoe Hershberger		o - Write-once
3538267541f7SJoe Hershberger		c - Change-default
3539267541f7SJoe Hershberger
35402598090bSJoe Hershberger	- CONFIG_ENV_FLAGS_LIST_DEFAULT
35412598090bSJoe Hershberger		Define this to a list (string) to define the ".flags"
35422598090bSJoe Hershberger		envirnoment variable in the default or embedded environment.
35432598090bSJoe Hershberger
35442598090bSJoe Hershberger	- CONFIG_ENV_FLAGS_LIST_STATIC
35452598090bSJoe Hershberger		Define this to a list (string) to define validation that
35462598090bSJoe Hershberger		should be done if an entry is not found in the ".flags"
35472598090bSJoe Hershberger		environment variable.  To override a setting in the static
35482598090bSJoe Hershberger		list, simply add an entry for the same variable name to the
35492598090bSJoe Hershberger		".flags" variable.
35502598090bSJoe Hershberger
3551267541f7SJoe Hershberger- CONFIG_ENV_ACCESS_IGNORE_FORCE
3552267541f7SJoe Hershberger	If defined, don't allow the -f switch to env set override variable
3553267541f7SJoe Hershberger	access flags.
3554267541f7SJoe Hershberger
35555c1a7ea6SSimon Glass- CONFIG_SYS_GENERIC_BOARD
35565c1a7ea6SSimon Glass	This selects the architecture-generic board system instead of the
35575c1a7ea6SSimon Glass	architecture-specific board files. It is intended to move boards
35585c1a7ea6SSimon Glass	to this new framework over time. Defining this will disable the
35595c1a7ea6SSimon Glass	arch/foo/lib/board.c file and use common/board_f.c and
35605c1a7ea6SSimon Glass	common/board_r.c instead. To use this option your architecture
35615c1a7ea6SSimon Glass	must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in
35625c1a7ea6SSimon Glass	its config.mk file). If you find problems enabling this option on
35635c1a7ea6SSimon Glass	your board please report the problem and send patches!
35645c1a7ea6SSimon Glass
3565632efa74SSimon Glass- CONFIG_SYS_SYM_OFFSETS
3566632efa74SSimon Glass	This is set by architectures that use offsets for link symbols
3567632efa74SSimon Glass	instead of absolute values. So bss_start is obtained using an
3568632efa74SSimon Glass	offset _bss_start_ofs from CONFIG_SYS_TEXT_BASE, rather than
3569632efa74SSimon Glass	directly. You should not need to touch this setting.
3570632efa74SSimon Glass
35710b1b60c7SLokesh Vutla- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
35720b1b60c7SLokesh Vutla	This is set by OMAP boards for the max time that reset should
35730b1b60c7SLokesh Vutla	be asserted. See doc/README.omap-reset-time for details on how
35740b1b60c7SLokesh Vutla	the value can be calulated on a given board.
3575632efa74SSimon Glass
3576c609719bSwdenkThe following definitions that deal with the placement and management
3577c609719bSwdenkof environment data (variable area); in general, we support the
3578c609719bSwdenkfollowing configurations:
3579c609719bSwdenk
3580c3eb3fe4SMike Frysinger- CONFIG_BUILD_ENVCRC:
3581c3eb3fe4SMike Frysinger
3582c3eb3fe4SMike Frysinger	Builds up envcrc with the target environment so that external utils
3583c3eb3fe4SMike Frysinger	may easily extract it and embed it in final U-Boot images.
3584c3eb3fe4SMike Frysinger
35855a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH:
3586c609719bSwdenk
3587c609719bSwdenk	Define this if the environment is in flash memory.
3588c609719bSwdenk
3589c609719bSwdenk	a) The environment occupies one whole flash sector, which is
3590c609719bSwdenk	   "embedded" in the text segment with the U-Boot code. This
3591c609719bSwdenk	   happens usually with "bottom boot sector" or "top boot
3592c609719bSwdenk	   sector" type flash chips, which have several smaller
3593c609719bSwdenk	   sectors at the start or the end. For instance, such a
3594c609719bSwdenk	   layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3595c609719bSwdenk	   such a case you would place the environment in one of the
3596c609719bSwdenk	   4 kB sectors - with U-Boot code before and after it. With
3597c609719bSwdenk	   "top boot sector" type flash chips, you would put the
3598c609719bSwdenk	   environment in one of the last sectors, leaving a gap
3599c609719bSwdenk	   between U-Boot and the environment.
3600c609719bSwdenk
36010e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
3602c609719bSwdenk
3603c609719bSwdenk	   Offset of environment data (variable area) to the
3604c609719bSwdenk	   beginning of flash memory; for instance, with bottom boot
3605c609719bSwdenk	   type flash chips the second sector can be used: the offset
3606c609719bSwdenk	   for this sector is given here.
3607c609719bSwdenk
36086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
3609c609719bSwdenk
36100e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
3611c609719bSwdenk
3612c609719bSwdenk	   This is just another way to specify the start address of
3613c609719bSwdenk	   the flash sector containing the environment (instead of
36140e8d1586SJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET).
3615c609719bSwdenk
36160e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SECT_SIZE:
3617c609719bSwdenk
3618c609719bSwdenk	   Size of the sector containing the environment.
3619c609719bSwdenk
3620c609719bSwdenk
3621c609719bSwdenk	b) Sometimes flash chips have few, equal sized, BIG sectors.
3622c609719bSwdenk	   In such a case you don't want to spend a whole sector for
3623c609719bSwdenk	   the environment.
3624c609719bSwdenk
36250e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3626c609719bSwdenk
36275a1aceb0SJean-Christophe PLAGNIOL-VILLARD	   If you use this in combination with CONFIG_ENV_IS_IN_FLASH
36280e8d1586SJean-Christophe PLAGNIOL-VILLARD	   and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
3629c609719bSwdenk	   of this flash sector for the environment. This saves
3630c609719bSwdenk	   memory for the RAM copy of the environment.
3631c609719bSwdenk
3632c609719bSwdenk	   It may also save flash memory if you decide to use this
3633c609719bSwdenk	   when your environment is "embedded" within U-Boot code,
3634c609719bSwdenk	   since then the remainder of the flash sector could be used
3635c609719bSwdenk	   for U-Boot code. It should be pointed out that this is
3636c609719bSwdenk	   STRONGLY DISCOURAGED from a robustness point of view:
3637c609719bSwdenk	   updating the environment in flash makes it always
3638c609719bSwdenk	   necessary to erase the WHOLE sector. If something goes
3639c609719bSwdenk	   wrong before the contents has been restored from a copy in
3640c609719bSwdenk	   RAM, your target system will be dead.
3641c609719bSwdenk
36420e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR_REDUND
36430e8d1586SJean-Christophe PLAGNIOL-VILLARD	  CONFIG_ENV_SIZE_REDUND
3644c609719bSwdenk
3645c609719bSwdenk	   These settings describe a second storage area used to hold
364611ccc33fSMarcel Ziswiler	   a redundant copy of the environment data, so that there is
36473e38691eSwdenk	   a valid backup copy in case there is a power failure during
3648c609719bSwdenk	   a "saveenv" operation.
3649c609719bSwdenk
3650c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the
3651c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds*
3652c609719bSwdenkaccordingly!
3653c609719bSwdenk
3654c609719bSwdenk
36559314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM:
3656c609719bSwdenk
3657c609719bSwdenk	Define this if you have some non-volatile memory device
3658c609719bSwdenk	(NVRAM, battery buffered SRAM) which you want to use for the
3659c609719bSwdenk	environment.
3660c609719bSwdenk
36610e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
36620e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3663c609719bSwdenk
366411ccc33fSMarcel Ziswiler	  These two #defines are used to determine the memory area you
3665c609719bSwdenk	  want to use for environment. It is assumed that this memory
3666c609719bSwdenk	  can just be read and written to, without any special
3667c609719bSwdenk	  provision.
3668c609719bSwdenk
3669c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early
3670c609719bSwdenkin U-Boot initalization (when we try to get the setting of for the
367111ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or
3672c609719bSwdenkU-Boot will hang.
3673c609719bSwdenk
3674c609719bSwdenkPlease note that even with NVRAM we still use a copy of the
3675c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to
3676c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv"
3677c609719bSwdenkto save the current settings.
3678c609719bSwdenk
3679c609719bSwdenk
3680bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM:
3681c609719bSwdenk
3682c609719bSwdenk	Use this if you have an EEPROM or similar serial access
3683c609719bSwdenk	device and a driver for it.
3684c609719bSwdenk
36850e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
36860e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3687c609719bSwdenk
3688c609719bSwdenk	  These two #defines specify the offset and size of the
3689c609719bSwdenk	  environment area within the total memory of your EEPROM.
3690c609719bSwdenk
36916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR:
3692c609719bSwdenk	  If defined, specified the chip address of the EEPROM device.
3693c609719bSwdenk	  The default address is zero.
3694c609719bSwdenk
36956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
3696c609719bSwdenk	  If defined, the number of bits used to address bytes in a
3697c609719bSwdenk	  single page in the EEPROM device.  A 64 byte page, for example
3698c609719bSwdenk	  would require six bits.
3699c609719bSwdenk
37006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
3701c609719bSwdenk	  If defined, the number of milliseconds to delay between
3702c609719bSwdenk	  page writes.	The default is zero milliseconds.
3703c609719bSwdenk
37046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
3705c609719bSwdenk	  The length in bytes of the EEPROM memory array address.  Note
3706c609719bSwdenk	  that this is NOT the chip address length!
3707c609719bSwdenk
37086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
37095cf91d6bSwdenk	  EEPROM chips that implement "address overflow" are ones
37105cf91d6bSwdenk	  like Catalyst 24WC04/08/16 which has 9/10/11 bits of
37115cf91d6bSwdenk	  address and the extra bits end up in the "chip address" bit
37125cf91d6bSwdenk	  slots. This makes a 24WC08 (1Kbyte) chip look like four 256
37135cf91d6bSwdenk	  byte chips.
37145cf91d6bSwdenk
37155cf91d6bSwdenk	  Note that we consider the length of the address field to
37165cf91d6bSwdenk	  still be one byte because the extra address bits are hidden
37175cf91d6bSwdenk	  in the chip address.
37185cf91d6bSwdenk
37196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_SIZE:
3720c609719bSwdenk	  The size in bytes of the EEPROM device.
3721c609719bSwdenk
3722548738b4SHeiko Schocher	- CONFIG_ENV_EEPROM_IS_ON_I2C
3723548738b4SHeiko Schocher	  define this, if you have I2C and SPI activated, and your
3724548738b4SHeiko Schocher	  EEPROM, which holds the environment, is on the I2C bus.
3725548738b4SHeiko Schocher
3726548738b4SHeiko Schocher	- CONFIG_I2C_ENV_EEPROM_BUS
3727548738b4SHeiko Schocher	  if you have an Environment on an EEPROM reached over
3728548738b4SHeiko Schocher	  I2C muxes, you can define here, how to reach this
3729548738b4SHeiko Schocher	  EEPROM. For example:
3730548738b4SHeiko Schocher
3731ea818dbbSHeiko Schocher	  #define CONFIG_I2C_ENV_EEPROM_BUS	  1
3732548738b4SHeiko Schocher
3733548738b4SHeiko Schocher	  EEPROM which holds the environment, is reached over
3734548738b4SHeiko Schocher	  a pca9547 i2c mux with address 0x70, channel 3.
3735c609719bSwdenk
3736057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH:
37375779d8d9Swdenk
37385779d8d9Swdenk	Define this if you have a DataFlash memory device which you
37395779d8d9Swdenk	want to use for the environment.
37405779d8d9Swdenk
37410e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
37420e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
37430e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
37445779d8d9Swdenk
37455779d8d9Swdenk	  These three #defines specify the offset and size of the
37465779d8d9Swdenk	  environment area within the total memory of your DataFlash placed
37475779d8d9Swdenk	  at the specified address.
37485779d8d9Swdenk
37490a85a9e7SLiu Gang- CONFIG_ENV_IS_IN_REMOTE:
37500a85a9e7SLiu Gang
37510a85a9e7SLiu Gang	Define this if you have a remote memory space which you
37520a85a9e7SLiu Gang	want to use for the local device's environment.
37530a85a9e7SLiu Gang
37540a85a9e7SLiu Gang	- CONFIG_ENV_ADDR:
37550a85a9e7SLiu Gang	- CONFIG_ENV_SIZE:
37560a85a9e7SLiu Gang
37570a85a9e7SLiu Gang	  These two #defines specify the address and size of the
37580a85a9e7SLiu Gang	  environment area within the remote memory space. The
37590a85a9e7SLiu Gang	  local device can get the environment from remote memory
3760fc54c7faSLiu Gang	  space by SRIO or PCIE links.
37610a85a9e7SLiu Gang
37620a85a9e7SLiu GangBE CAREFUL! For some special cases, the local device can not use
37630a85a9e7SLiu Gang"saveenv" command. For example, the local device will get the
3764fc54c7faSLiu Gangenvironment stored in a remote NOR flash by SRIO or PCIE link,
3765fc54c7faSLiu Gangbut it can not erase, write this NOR flash by SRIO or PCIE interface.
37660a85a9e7SLiu Gang
376751bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND:
376813a5695bSwdenk
376913a5695bSwdenk	Define this if you have a NAND device which you want to use
377013a5695bSwdenk	for the environment.
377113a5695bSwdenk
37720e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
37730e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
377413a5695bSwdenk
377513a5695bSwdenk	  These two #defines specify the offset and size of the environment
3776fdd813deSScott Wood	  area within the first NAND device.  CONFIG_ENV_OFFSET must be
3777fdd813deSScott Wood	  aligned to an erase block boundary.
37785779d8d9Swdenk
3779fdd813deSScott Wood	- CONFIG_ENV_OFFSET_REDUND (optional):
3780e443c944SMarkus Klotzbuecher
37810e8d1586SJean-Christophe PLAGNIOL-VILLARD	  This setting describes a second storage area of CONFIG_ENV_SIZE
3782fdd813deSScott Wood	  size used to hold a redundant copy of the environment data, so
3783fdd813deSScott Wood	  that there is a valid backup copy in case there is a power failure
3784fdd813deSScott Wood	  during a "saveenv" operation.	 CONFIG_ENV_OFFSET_RENDUND must be
3785fdd813deSScott Wood	  aligned to an erase block boundary.
3786e443c944SMarkus Klotzbuecher
3787fdd813deSScott Wood	- CONFIG_ENV_RANGE (optional):
3788fdd813deSScott Wood
3789fdd813deSScott Wood	  Specifies the length of the region in which the environment
3790fdd813deSScott Wood	  can be written.  This should be a multiple of the NAND device's
3791fdd813deSScott Wood	  block size.  Specifying a range with more erase blocks than
3792fdd813deSScott Wood	  are needed to hold CONFIG_ENV_SIZE allows bad blocks within
3793fdd813deSScott Wood	  the range to be avoided.
3794fdd813deSScott Wood
3795fdd813deSScott Wood	- CONFIG_ENV_OFFSET_OOB (optional):
3796fdd813deSScott Wood
3797fdd813deSScott Wood	  Enables support for dynamically retrieving the offset of the
3798fdd813deSScott Wood	  environment from block zero's out-of-band data.  The
3799fdd813deSScott Wood	  "nand env.oob" command can be used to record this offset.
3800fdd813deSScott Wood	  Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
3801fdd813deSScott Wood	  using CONFIG_ENV_OFFSET_OOB.
3802e443c944SMarkus Klotzbuecher
3803b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST
3804b74ab737SGuennadi Liakhovetski
3805b74ab737SGuennadi Liakhovetski	Defines address in RAM to which the nand_spl code should copy the
3806b74ab737SGuennadi Liakhovetski	environment. If redundant environment is used, it will be copied to
3807b74ab737SGuennadi Liakhovetski	CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3808b74ab737SGuennadi Liakhovetski
38092b74433fSJoe Hershberger- CONFIG_ENV_IS_IN_UBI:
38102b74433fSJoe Hershberger
38112b74433fSJoe Hershberger	Define this if you have an UBI volume that you want to use for the
38122b74433fSJoe Hershberger	environment.  This has the benefit of wear-leveling the environment
38132b74433fSJoe Hershberger	accesses, which is important on NAND.
38142b74433fSJoe Hershberger
38152b74433fSJoe Hershberger	- CONFIG_ENV_UBI_PART:
38162b74433fSJoe Hershberger
38172b74433fSJoe Hershberger	  Define this to a string that is the mtd partition containing the UBI.
38182b74433fSJoe Hershberger
38192b74433fSJoe Hershberger	- CONFIG_ENV_UBI_VOLUME:
38202b74433fSJoe Hershberger
38212b74433fSJoe Hershberger	  Define this to the name of the volume that you want to store the
38222b74433fSJoe Hershberger	  environment in.
38232b74433fSJoe Hershberger
3824785881f7SJoe Hershberger	- CONFIG_ENV_UBI_VOLUME_REDUND:
3825785881f7SJoe Hershberger
3826785881f7SJoe Hershberger	  Define this to the name of another volume to store a second copy of
3827785881f7SJoe Hershberger	  the environment in.  This will enable redundant environments in UBI.
3828785881f7SJoe Hershberger	  It is assumed that both volumes are in the same MTD partition.
3829785881f7SJoe Hershberger
38302b74433fSJoe Hershberger	- CONFIG_UBI_SILENCE_MSG
38312b74433fSJoe Hershberger	- CONFIG_UBIFS_SILENCE_MSG
38322b74433fSJoe Hershberger
38332b74433fSJoe Hershberger	  You will probably want to define these to avoid a really noisy system
38342b74433fSJoe Hershberger	  when storing the env in UBI.
38352b74433fSJoe Hershberger
383606e4ae5fSStephen Warren- CONFIG_ENV_IS_IN_MMC:
383706e4ae5fSStephen Warren
383806e4ae5fSStephen Warren	Define this if you have an MMC device which you want to use for the
383906e4ae5fSStephen Warren	environment.
384006e4ae5fSStephen Warren
384106e4ae5fSStephen Warren	- CONFIG_SYS_MMC_ENV_DEV:
384206e4ae5fSStephen Warren
384306e4ae5fSStephen Warren	  Specifies which MMC device the environment is stored in.
384406e4ae5fSStephen Warren
384506e4ae5fSStephen Warren	- CONFIG_SYS_MMC_ENV_PART (optional):
384606e4ae5fSStephen Warren
384706e4ae5fSStephen Warren	  Specifies which MMC partition the environment is stored in. If not
384806e4ae5fSStephen Warren	  set, defaults to partition 0, the user area. Common values might be
384906e4ae5fSStephen Warren	  1 (first MMC boot partition), 2 (second MMC boot partition).
385006e4ae5fSStephen Warren
385106e4ae5fSStephen Warren	- CONFIG_ENV_OFFSET:
385206e4ae5fSStephen Warren	- CONFIG_ENV_SIZE:
385306e4ae5fSStephen Warren
385406e4ae5fSStephen Warren	  These two #defines specify the offset and size of the environment
385506e4ae5fSStephen Warren	  area within the specified MMC device.
385606e4ae5fSStephen Warren
38575c088ee8SStephen Warren	  If offset is positive (the usual case), it is treated as relative to
38585c088ee8SStephen Warren	  the start of the MMC partition. If offset is negative, it is treated
38595c088ee8SStephen Warren	  as relative to the end of the MMC partition. This can be useful if
38605c088ee8SStephen Warren	  your board may be fitted with different MMC devices, which have
38615c088ee8SStephen Warren	  different sizes for the MMC partitions, and you always want the
38625c088ee8SStephen Warren	  environment placed at the very end of the partition, to leave the
38635c088ee8SStephen Warren	  maximum possible space before it, to store other data.
38645c088ee8SStephen Warren
386506e4ae5fSStephen Warren	  These two values are in units of bytes, but must be aligned to an
386606e4ae5fSStephen Warren	  MMC sector boundary.
386706e4ae5fSStephen Warren
386806e4ae5fSStephen Warren	- CONFIG_ENV_OFFSET_REDUND (optional):
386906e4ae5fSStephen Warren
387006e4ae5fSStephen Warren	  Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
387106e4ae5fSStephen Warren	  hold a redundant copy of the environment data. This provides a
387206e4ae5fSStephen Warren	  valid backup copy in case the other copy is corrupted, e.g. due
387306e4ae5fSStephen Warren	  to a power failure during a "saveenv" operation.
387406e4ae5fSStephen Warren
38755c088ee8SStephen Warren	  This value may also be positive or negative; this is handled in the
38765c088ee8SStephen Warren	  same way as CONFIG_ENV_OFFSET.
38775c088ee8SStephen Warren
387806e4ae5fSStephen Warren	  This value is also in units of bytes, but must also be aligned to
387906e4ae5fSStephen Warren	  an MMC sector boundary.
388006e4ae5fSStephen Warren
388106e4ae5fSStephen Warren	- CONFIG_ENV_SIZE_REDUND (optional):
388206e4ae5fSStephen Warren
388306e4ae5fSStephen Warren	  This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
388406e4ae5fSStephen Warren	  set. If this value is set, it must be set to the same value as
388506e4ae5fSStephen Warren	  CONFIG_ENV_SIZE.
388606e4ae5fSStephen Warren
38876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET
3888c609719bSwdenk
3889c609719bSwdenk	Defines offset to the initial SPI buffer area in DPRAM. The
3890c609719bSwdenk	area is used at an early stage (ROM part) if the environment
3891c609719bSwdenk	is configured to reside in the SPI EEPROM: We need a 520 byte
3892c609719bSwdenk	scratch DPRAM area. It is used between the two initialization
3893c609719bSwdenk	calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
3894c609719bSwdenk	to be a good choice since it makes it far enough from the
3895c609719bSwdenk	start of the data area as well as from the stack pointer.
3896c609719bSwdenk
3897e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor
3898c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been
3899cdb74977SWolfgang Denkcreated; also, when using EEPROM you will have to use getenv_f()
3900c609719bSwdenkuntil then to read environment variables.
3901c609719bSwdenk
390285ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor
390385ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working
390485ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is
390585ec0bccSwdenknecessary, because the first environment variable we need is the
390685ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't
390785ec0bccSwdenkhave any device yet where we could complain.]
3908c609719bSwdenk
3909c609719bSwdenkNote: once the monitor has been relocated, then it will complain if
3910c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you
391185ec0bccSwdenkuse the "saveenv" command to store a valid environment.
3912c609719bSwdenk
39136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
3914fc3e2165Swdenk		Echo the inverted Ethernet link state to the fault LED.
3915fc3e2165Swdenk
39166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
3917fc3e2165Swdenk		      also needs to be defined.
3918fc3e2165Swdenk
39196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR:
3920fc3e2165Swdenk		MII address of the PHY to check for the Ethernet link state.
3921c609719bSwdenk
3922f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS:
3923f5675aa5SRon Madrid		Define this if you desire to only have use of the NS16550_init
3924f5675aa5SRon Madrid		and NS16550_putc functions for the serial driver located at
3925f5675aa5SRon Madrid		drivers/serial/ns16550.c.  This option is useful for saving
3926f5675aa5SRon Madrid		space for already greatly restricted images, including but not
3927f5675aa5SRon Madrid		limited to NAND_SPL configurations.
3928f5675aa5SRon Madrid
3929b2b92f53SSimon Glass- CONFIG_DISPLAY_BOARDINFO
3930b2b92f53SSimon Glass		Display information about the board that U-Boot is running on
3931b2b92f53SSimon Glass		when U-Boot starts up. The board function checkboard() is called
3932b2b92f53SSimon Glass		to do this.
3933b2b92f53SSimon Glass
3934e2e3e2b1SSimon Glass- CONFIG_DISPLAY_BOARDINFO_LATE
3935e2e3e2b1SSimon Glass		Similar to the previous option, but display this information
3936e2e3e2b1SSimon Glass		later, once stdio is running and output goes to the LCD, if
3937e2e3e2b1SSimon Glass		present.
3938e2e3e2b1SSimon Glass
3939c609719bSwdenkLow Level (hardware related) configuration options:
3940dc7c9a1aSwdenk---------------------------------------------------
3941c609719bSwdenk
39426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE:
3943c609719bSwdenk		Cache Line Size of the CPU.
3944c609719bSwdenk
39456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR:
3946c609719bSwdenk		Default address of the IMMR after system reset.
39472535d602Swdenk
39482535d602Swdenk		Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
39492535d602Swdenk		and RPXsuper) to be able to adjust the position of
39502535d602Swdenk		the IMMR register after a reset.
3951c609719bSwdenk
3952e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_DEFAULT:
3953e46fedfeSTimur Tabi		Default (power-on reset) physical address of CCSR on Freescale
3954e46fedfeSTimur Tabi		PowerPC SOCs.
3955e46fedfeSTimur Tabi
3956e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR:
3957e46fedfeSTimur Tabi		Virtual address of CCSR.  On a 32-bit build, this is typically
3958e46fedfeSTimur Tabi		the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
3959e46fedfeSTimur Tabi
3960e46fedfeSTimur Tabi		CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
3961e46fedfeSTimur Tabi		for cross-platform code that uses that macro instead.
3962e46fedfeSTimur Tabi
3963e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS:
3964e46fedfeSTimur Tabi		Physical address of CCSR.  CCSR can be relocated to a new
3965e46fedfeSTimur Tabi		physical address, if desired.  In this case, this macro should
3966e46fedfeSTimur Tabi		be set to that address.	 Otherwise, it should be set to the
3967e46fedfeSTimur Tabi		same value as CONFIG_SYS_CCSRBAR_DEFAULT.  For example, CCSR
3968e46fedfeSTimur Tabi		is typically relocated on 36-bit builds.  It is recommended
3969e46fedfeSTimur Tabi		that this macro be defined via the _HIGH and _LOW macros:
3970e46fedfeSTimur Tabi
3971e46fedfeSTimur Tabi		#define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3972e46fedfeSTimur Tabi			* 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3973e46fedfeSTimur Tabi
3974e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
3975e46fedfeSTimur Tabi		Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS.	This value is typically
3976e46fedfeSTimur Tabi		either 0 (32-bit build) or 0xF (36-bit build).	This macro is
3977e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
3978e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
3979e46fedfeSTimur Tabi
3980e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_LOW:
3981e46fedfeSTimur Tabi		Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS.  This macro is
3982e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
3983e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
3984e46fedfeSTimur Tabi
3985e46fedfeSTimur Tabi- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
3986e46fedfeSTimur Tabi		If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
3987e46fedfeSTimur Tabi		forced to a value that ensures that CCSR is not relocated.
3988e46fedfeSTimur Tabi
39897f6c2cbcSwdenk- Floppy Disk Support:
39906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER
39917f6c2cbcSwdenk
39927f6c2cbcSwdenk		the default drive number (default value 0)
39937f6c2cbcSwdenk
39946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_STRIDE
39957f6c2cbcSwdenk
399611ccc33fSMarcel Ziswiler		defines the spacing between FDC chipset registers
39977f6c2cbcSwdenk		(default value 1)
39987f6c2cbcSwdenk
39996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_OFFSET
40007f6c2cbcSwdenk
40017f6c2cbcSwdenk		defines the offset of register from address. It
40027f6c2cbcSwdenk		depends on which part of the data bus is connected to
400311ccc33fSMarcel Ziswiler		the FDC chipset. (default value 0)
40047f6c2cbcSwdenk
40056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
40066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
40077f6c2cbcSwdenk		default value.
40087f6c2cbcSwdenk
40096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		if CONFIG_SYS_FDC_HW_INIT is defined, then the function
40107f6c2cbcSwdenk		fdc_hw_init() is called at the beginning of the FDC
40117f6c2cbcSwdenk		setup. fdc_hw_init() must be provided by the board
40127f6c2cbcSwdenk		source code. It is used to make hardware dependant
40137f6c2cbcSwdenk		initializations.
40147f6c2cbcSwdenk
40150abddf82SMacpaul Lin- CONFIG_IDE_AHB:
40160abddf82SMacpaul Lin		Most IDE controllers were designed to be connected with PCI
40170abddf82SMacpaul Lin		interface. Only few of them were designed for AHB interface.
40180abddf82SMacpaul Lin		When software is doing ATA command and data transfer to
40190abddf82SMacpaul Lin		IDE devices through IDE-AHB controller, some additional
40200abddf82SMacpaul Lin		registers accessing to these kind of IDE-AHB controller
40210abddf82SMacpaul Lin		is requierd.
40220abddf82SMacpaul Lin
40236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR:	Physical address of the Internal Memory.
402425d6712aSwdenk		DO NOT CHANGE unless you know exactly what you're
402525d6712aSwdenk		doing! (11-4) [MPC8xx/82xx systems only]
4026c609719bSwdenk
40276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR:
4028c609719bSwdenk
40297152b1d0Swdenk		Start address of memory area that can be used for
4030c609719bSwdenk		initial data and stack; please note that this must be
4031c609719bSwdenk		writable memory that is working WITHOUT special
4032c609719bSwdenk		initialization, i. e. you CANNOT use normal RAM which
4033c609719bSwdenk		will become available only after programming the
4034c609719bSwdenk		memory controller and running certain initialization
4035c609719bSwdenk		sequences.
4036c609719bSwdenk
4037c609719bSwdenk		U-Boot uses the following memory types:
4038c609719bSwdenk		- MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4039c609719bSwdenk		- MPC824X: data cache
4040c609719bSwdenk		- PPC4xx:  data cache
4041c609719bSwdenk
40426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET:
4043c609719bSwdenk
4044c609719bSwdenk		Offset of the initial data structure in the memory
40456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
40466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
4047c609719bSwdenk		data is located at the end of the available space
4048553f0982SWolfgang Denk		(sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
40496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
40506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
40516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET) downward.
4052c609719bSwdenk
4053c609719bSwdenk	Note:
4054c609719bSwdenk		On the MPC824X (or other systems that use the data
4055c609719bSwdenk		cache for initial memory) the address chosen for
40566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
4057c609719bSwdenk		point to an otherwise UNUSED address space between
4058c609719bSwdenk		the top of RAM and the start of the PCI space.
4059c609719bSwdenk
40606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR:	SIU Module Configuration (11-6)
4061c609719bSwdenk
40626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR:	System Protection Control (11-9)
4063c609719bSwdenk
40646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR:	Time Base Status and Control (11-26)
4065c609719bSwdenk
40666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR:	Periodic Interrupt Status and Control (11-31)
4067c609719bSwdenk
40686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR:	PLL, Low-Power, and Reset Control Register (15-30)
4069c609719bSwdenk
40706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR:	System Clock and reset Control Register (15-27)
4071c609719bSwdenk
40726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM:
4073c609719bSwdenk		SDRAM timing
4074c609719bSwdenk
40756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA:
4076c609719bSwdenk		periodic timer for refresh
4077c609719bSwdenk
40786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER:	Debug Event Register (37-47)
4079c609719bSwdenk
40806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
40816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
40826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
40836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_BR1_PRELIM:
4084c609719bSwdenk		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4085c609719bSwdenk
4086c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
40876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
40886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
4089c609719bSwdenk		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4090c609719bSwdenk
40916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
40926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
4093c609719bSwdenk		Machine Mode Register and Memory Periodic Timer
4094c609719bSwdenk		Prescaler definitions (SDRAM timing)
4095c609719bSwdenk
40966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
4097c609719bSwdenk		enable I2C microcode relocation patch (MPC8xx);
4098c609719bSwdenk		define relocation offset in DPRAM [DSP2]
4099c609719bSwdenk
41006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
4101b423d055SHeiko Schocher		enable SMC microcode relocation patch (MPC8xx);
4102b423d055SHeiko Schocher		define relocation offset in DPRAM [SMC1]
4103b423d055SHeiko Schocher
41046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
4105c609719bSwdenk		enable SPI microcode relocation patch (MPC8xx);
4106c609719bSwdenk		define relocation offset in DPRAM [SCC4]
4107c609719bSwdenk
41086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_USE_OSCCLK:
4109c609719bSwdenk		Use OSCM clock mode on MBX8xx board. Be careful,
4110c609719bSwdenk		wrong setting might damage your board. Read
4111c609719bSwdenk		doc/README.MBX before setting this variable!
4112c609719bSwdenk
41136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
4114ea909b76Swdenk		Offset of the bootmode word in DPRAM used by post
4115ea909b76Swdenk		(Power On Self Tests). This definition overrides
4116ea909b76Swdenk		#define'd default value in commproc.h resp.
4117ea909b76Swdenk		cpm_8260.h.
4118ea909b76Swdenk
41196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
41206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
41216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
41226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
41236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
41246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
41256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
41266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
4127a47a12beSStefan Roese		Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
41285d232d0eSwdenk
41299cacf4fcSDirk Eibach- CONFIG_PCI_DISABLE_PCIE:
41309cacf4fcSDirk Eibach		Disable PCI-Express on systems where it is supported but not
41319cacf4fcSDirk Eibach		required.
41329cacf4fcSDirk Eibach
413369fd2d3bSAndrew Sharp- CONFIG_PCI_ENUM_ONLY
413469fd2d3bSAndrew Sharp		Only scan through and get the devices on the busses.
413569fd2d3bSAndrew Sharp		Don't do any setup work, presumably because someone or
413669fd2d3bSAndrew Sharp		something has already done it, and we don't need to do it
413769fd2d3bSAndrew Sharp		a second time.	Useful for platforms that are pre-booted
413869fd2d3bSAndrew Sharp		by coreboot or similar.
413969fd2d3bSAndrew Sharp
4140842033e6SGabor Juhos- CONFIG_PCI_INDIRECT_BRIDGE:
4141842033e6SGabor Juhos		Enable support for indirect PCI bridges.
4142842033e6SGabor Juhos
4143a09b9b68SKumar Gala- CONFIG_SYS_SRIO:
4144a09b9b68SKumar Gala		Chip has SRIO or not
4145a09b9b68SKumar Gala
4146a09b9b68SKumar Gala- CONFIG_SRIO1:
4147a09b9b68SKumar Gala		Board has SRIO 1 port available
4148a09b9b68SKumar Gala
4149a09b9b68SKumar Gala- CONFIG_SRIO2:
4150a09b9b68SKumar Gala		Board has SRIO 2 port available
4151a09b9b68SKumar Gala
4152c8b28152SLiu Gang- CONFIG_SRIO_PCIE_BOOT_MASTER
4153c8b28152SLiu Gang		Board can support master function for Boot from SRIO and PCIE
4154c8b28152SLiu Gang
4155a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_VIRT:
4156a09b9b68SKumar Gala		Virtual Address of SRIO port 'n' memory region
4157a09b9b68SKumar Gala
4158a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_PHYS:
4159a09b9b68SKumar Gala		Physical Address of SRIO port 'n' memory region
4160a09b9b68SKumar Gala
4161a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_SIZE:
4162a09b9b68SKumar Gala		Size of SRIO port 'n' memory region
4163a09b9b68SKumar Gala
416466bd1846SFabio Estevam- CONFIG_SYS_NAND_BUSWIDTH_16BIT
416566bd1846SFabio Estevam		Defined to tell the NAND controller that the NAND chip is using
416666bd1846SFabio Estevam		a 16 bit bus.
416766bd1846SFabio Estevam		Not all NAND drivers use this symbol.
4168a430e916SFabio Estevam		Example of drivers that use it:
416966bd1846SFabio Estevam		- drivers/mtd/nand/ndfc.c
4170a430e916SFabio Estevam		- drivers/mtd/nand/mxc_nand.c
4171eced4626SAlex Waterman
4172eced4626SAlex Waterman- CONFIG_SYS_NDFC_EBC0_CFG
4173eced4626SAlex Waterman		Sets the EBC0_CFG register for the NDFC. If not defined
4174eced4626SAlex Waterman		a default value will be used.
4175eced4626SAlex Waterman
4176bb99ad6dSBen Warren- CONFIG_SPD_EEPROM
4177218ca724SWolfgang Denk		Get DDR timing information from an I2C EEPROM. Common
4178218ca724SWolfgang Denk		with pluggable memory modules such as SODIMMs
4179218ca724SWolfgang Denk
4180bb99ad6dSBen Warren  SPD_EEPROM_ADDRESS
4181bb99ad6dSBen Warren		I2C address of the SPD EEPROM
4182bb99ad6dSBen Warren
41836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM
4184218ca724SWolfgang Denk		If SPD EEPROM is on an I2C bus other than the first
4185218ca724SWolfgang Denk		one, specify here. Note that the value must resolve
4186218ca724SWolfgang Denk		to something your driver can deal with.
4187bb99ad6dSBen Warren
41881b3e3c4fSYork Sun- CONFIG_SYS_DDR_RAW_TIMING
41891b3e3c4fSYork Sun		Get DDR timing information from other than SPD. Common with
41901b3e3c4fSYork Sun		soldered DDR chips onboard without SPD. DDR raw timing
41911b3e3c4fSYork Sun		parameters are extracted from datasheet and hard-coded into
41921b3e3c4fSYork Sun		header files or board specific files.
41931b3e3c4fSYork Sun
41946f5e1dc5SYork Sun- CONFIG_FSL_DDR_INTERACTIVE
41956f5e1dc5SYork Sun		Enable interactive DDR debugging. See doc/README.fsl-ddr.
41966f5e1dc5SYork Sun
41976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0
4198218ca724SWolfgang Denk		Only for 83xx systems. If specified, then DDR should
4199218ca724SWolfgang Denk		be configured using CS0 and CS1 instead of CS2 and CS3.
42002ad6b513STimur Tabi
4201c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12]
4202c26e454dSwdenk		Define to enable FEC[12] on a 8xx series processor.
4203c26e454dSwdenk
4204c26e454dSwdenk- CONFIG_FEC[12]_PHY
4205c26e454dSwdenk		Define to the hardcoded PHY address which corresponds
42066e592385Swdenk		to the given FEC; i. e.
4207c26e454dSwdenk			#define CONFIG_FEC1_PHY 4
4208c26e454dSwdenk		means that the PHY with address 4 is connected to FEC1
4209c26e454dSwdenk
4210c26e454dSwdenk		When set to -1, means to probe for first available.
4211c26e454dSwdenk
4212c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR
4213c26e454dSwdenk		The PHY does not have a RXERR line (RMII only).
4214c26e454dSwdenk		(so program the FEC to ignore it).
4215c26e454dSwdenk
4216c26e454dSwdenk- CONFIG_RMII
4217c26e454dSwdenk		Enable RMII mode for all FECs.
4218c26e454dSwdenk		Note that this is a global option, we can't
4219c26e454dSwdenk		have one FEC in standard MII mode and another in RMII mode.
4220c26e454dSwdenk
42215cf91d6bSwdenk- CONFIG_CRC32_VERIFY
42225cf91d6bSwdenk		Add a verify option to the crc32 command.
42235cf91d6bSwdenk		The syntax is:
42245cf91d6bSwdenk
42255cf91d6bSwdenk		=> crc32 -v <address> <count> <crc32>
42265cf91d6bSwdenk
42275cf91d6bSwdenk		Where address/count indicate a memory area
42285cf91d6bSwdenk		and crc32 is the correct crc32 which the
42295cf91d6bSwdenk		area should have.
42305cf91d6bSwdenk
423156523f12Swdenk- CONFIG_LOOPW
423256523f12Swdenk		Add the "loopw" memory command. This only takes effect if
4233602ad3b3SJon Loeliger		the memory commands are activated globally (CONFIG_CMD_MEM).
423456523f12Swdenk
42357b466641Sstroese- CONFIG_MX_CYCLIC
42367b466641Sstroese		Add the "mdc" and "mwc" memory commands. These are cyclic
42377b466641Sstroese		"md/mw" commands.
42387b466641Sstroese		Examples:
42397b466641Sstroese
42407b466641Sstroese		=> mdc.b 10 4 500
42417b466641Sstroese		This command will print 4 bytes (10,11,12,13) each 500 ms.
42427b466641Sstroese
42437b466641Sstroese		=> mwc.l 100 12345678 10
42447b466641Sstroese		This command will write 12345678 to address 100 all 10 ms.
42457b466641Sstroese
42467b466641Sstroese		This only takes effect if the memory commands are activated
4247602ad3b3SJon Loeliger		globally (CONFIG_CMD_MEM).
42487b466641Sstroese
42498aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT
4250afc1ce82SMacpaul Lin		[ARM, NDS32, MIPS only] If this variable is defined, then certain
4251e03f3169SWolfgang Denk		low level initializations (like setting up the memory
4252e03f3169SWolfgang Denk		controller) are omitted and/or U-Boot does not
4253e03f3169SWolfgang Denk		relocate itself into RAM.
42548aa1a2d1Swdenk
4255e03f3169SWolfgang Denk		Normally this variable MUST NOT be defined. The only
4256e03f3169SWolfgang Denk		exception is when U-Boot is loaded (to RAM) by some
4257e03f3169SWolfgang Denk		other boot loader or by a debugger which performs
4258e03f3169SWolfgang Denk		these initializations itself.
42598aa1a2d1Swdenk
4260401bb30bSAneesh V- CONFIG_SPL_BUILD
4261df81238bSMagnus Lilja		Modifies the behaviour of start.S when compiling a loader
4262df81238bSMagnus Lilja		that is executed before the actual U-Boot. E.g. when
4263df81238bSMagnus Lilja		compiling a NAND SPL.
4264400558b5Swdenk
42653aa29de0SYing Zhang- CONFIG_TPL_BUILD
42663aa29de0SYing Zhang		Modifies the behaviour of start.S  when compiling a loader
42673aa29de0SYing Zhang		that is executed after the SPL and before the actual U-Boot.
42683aa29de0SYing Zhang		It is loaded by the SPL.
42693aa29de0SYing Zhang
42705df572f0SYing Zhang- CONFIG_SYS_MPC85XX_NO_RESETVEC
42715df572f0SYing Zhang		Only for 85xx systems. If this variable is specified, the section
42725df572f0SYing Zhang		.resetvec is not kept and the section .bootpg is placed in the
42735df572f0SYing Zhang		previous 4k of the .text section.
42745df572f0SYing Zhang
42754213fc29SSimon Glass- CONFIG_ARCH_MAP_SYSMEM
42764213fc29SSimon Glass		Generally U-Boot (and in particular the md command) uses
42774213fc29SSimon Glass		effective address. It is therefore not necessary to regard
42784213fc29SSimon Glass		U-Boot address as virtual addresses that need to be translated
42794213fc29SSimon Glass		to physical addresses. However, sandbox requires this, since
42804213fc29SSimon Glass		it maintains its own little RAM buffer which contains all
42814213fc29SSimon Glass		addressable memory. This option causes some memory accesses
42824213fc29SSimon Glass		to be mapped through map_sysmem() / unmap_sysmem().
42834213fc29SSimon Glass
4284d8834a13SMatthias Weisser- CONFIG_USE_ARCH_MEMCPY
4285d8834a13SMatthias Weisser  CONFIG_USE_ARCH_MEMSET
4286d8834a13SMatthias Weisser		If these options are used a optimized version of memcpy/memset will
4287d8834a13SMatthias Weisser		be used if available. These functions may be faster under some
4288d8834a13SMatthias Weisser		conditions but may increase the binary size.
4289d8834a13SMatthias Weisser
4290588a13f7SSimon Glass- CONFIG_X86_RESET_VECTOR
4291588a13f7SSimon Glass		If defined, the x86 reset vector code is included. This is not
4292588a13f7SSimon Glass		needed when U-Boot is running from Coreboot.
4293b16f521aSGabe Black
4294fc33705eSMark Jackson- CONFIG_SYS_MPUCLK
4295fc33705eSMark Jackson		Defines the MPU clock speed (in MHz).
4296fc33705eSMark Jackson
4297fc33705eSMark Jackson		NOTE : currently only supported on AM335x platforms.
42985b5ece9eSGabe Black
4299f2717b47STimur TabiFreescale QE/FMAN Firmware Support:
4300f2717b47STimur Tabi-----------------------------------
4301f2717b47STimur Tabi
4302f2717b47STimur TabiThe Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4303f2717b47STimur Tabiloading of "firmware", which is encoded in the QE firmware binary format.
4304f2717b47STimur TabiThis firmware often needs to be loaded during U-Boot booting, so macros
4305f2717b47STimur Tabiare used to identify the storage device (NOR flash, SPI, etc) and the address
4306f2717b47STimur Tabiwithin that device.
4307f2717b47STimur Tabi
4308f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_ADDR
4309f2717b47STimur Tabi	The address in the storage device where the firmware is located.  The
4310f2717b47STimur Tabi	meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4311f2717b47STimur Tabi	is also specified.
4312f2717b47STimur Tabi
4313f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_LENGTH
4314f2717b47STimur Tabi	The maximum possible size of the firmware.  The firmware binary format
4315f2717b47STimur Tabi	has a field that specifies the actual size of the firmware, but it
4316f2717b47STimur Tabi	might not be possible to read any part of the firmware unless some
4317f2717b47STimur Tabi	local storage is allocated to hold the entire firmware first.
4318f2717b47STimur Tabi
4319f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4320f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4321f2717b47STimur Tabi	normal addressable memory via the LBC.  CONFIG_SYS_FMAN_FW_ADDR is the
4322f2717b47STimur Tabi	virtual address in NOR flash.
4323f2717b47STimur Tabi
4324f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4325f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NAND flash.
4326f2717b47STimur Tabi	CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4327f2717b47STimur Tabi
4328f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4329f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SD/MMC
4330f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4331f2717b47STimur Tabi
4332f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
4333f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SPI
4334f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4335f2717b47STimur Tabi
4336292dc6c5SLiu Gang- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4337292dc6c5SLiu Gang	Specifies that QE/FMAN firmware is located in the remote (master)
4338292dc6c5SLiu Gang	memory space.	CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
4339fc54c7faSLiu Gang	can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4340fc54c7faSLiu Gang	window->master inbound window->master LAW->the ucode address in
4341fc54c7faSLiu Gang	master's memory space.
4342f2717b47STimur Tabi
4343c609719bSwdenkBuilding the Software:
4344c609719bSwdenk======================
4345c609719bSwdenk
4346218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments
4347218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support
4348218ca724SWolfgang Denkall possibly existing versions of cross development tools in all
4349218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we
4350218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4351218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot.
4352c609719bSwdenk
4353218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you
4354218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case,
4355218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell.
4356218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are
4357218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter:
4358c609719bSwdenk
4359218ca724SWolfgang Denk	$ CROSS_COMPILE=ppc_4xx-
4360218ca724SWolfgang Denk	$ export CROSS_COMPILE
4361c609719bSwdenk
43622f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in
43632f8d396bSPeter Tyser      the tools directory you can use the MinGW toolchain
43642f8d396bSPeter Tyser      (http://www.mingw.org).  Set your HOST tools to the MinGW
43652f8d396bSPeter Tyser      toolchain and execute 'make tools'.  For example:
43662f8d396bSPeter Tyser
43672f8d396bSPeter Tyser       $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
43682f8d396bSPeter Tyser
43692f8d396bSPeter Tyser      Binaries such as tools/mkimage.exe will be created which can
43702f8d396bSPeter Tyser      be executed on computers running Windows.
43712f8d396bSPeter Tyser
4372c609719bSwdenkU-Boot is intended to be simple to build. After installing the
4373c609719bSwdenksources you must configure U-Boot for one specific board type. This
4374c609719bSwdenkis done by typing:
4375c609719bSwdenk
4376c609719bSwdenk	make NAME_config
4377c609719bSwdenk
4378218ca724SWolfgang Denkwhere "NAME_config" is the name of one of the existing configu-
43794d675ae6SMichael Jonesrations; see boards.cfg for supported names.
438054387ac9Swdenk
4381c609719bSwdenkNote: for some board special configuration names may exist; check if
4382c609719bSwdenk      additional information is available from the board vendor; for
43832729af9dSwdenk      instance, the TQM823L systems are available without (standard)
43842729af9dSwdenk      or with LCD support. You can select such additional "features"
438511ccc33fSMarcel Ziswiler      when choosing the configuration, i. e.
4386c609719bSwdenk
43872729af9dSwdenk      make TQM823L_config
43882729af9dSwdenk	- will configure for a plain TQM823L, i. e. no LCD support
4389c609719bSwdenk
4390c609719bSwdenk      make TQM823L_LCD_config
4391c609719bSwdenk	- will configure for a TQM823L with U-Boot console on LCD
4392c609719bSwdenk
4393c609719bSwdenk      etc.
4394c609719bSwdenk
4395c609719bSwdenk
4396c609719bSwdenkFinally, type "make all", and you should get some working U-Boot
43977152b1d0Swdenkimages ready for download to / installation on your system:
4398c609719bSwdenk
4399c609719bSwdenk- "u-boot.bin" is a raw binary image
4400c609719bSwdenk- "u-boot" is an image in ELF binary format
4401c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format
4402c609719bSwdenk
4403baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved
4404baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change
4405baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory:
4406baf31249SMarian Balakowicz
4407baf31249SMarian Balakowicz1. Add O= to the make command line invocations:
4408baf31249SMarian Balakowicz
4409baf31249SMarian Balakowicz	make O=/tmp/build distclean
4410baf31249SMarian Balakowicz	make O=/tmp/build NAME_config
4411baf31249SMarian Balakowicz	make O=/tmp/build all
4412baf31249SMarian Balakowicz
4413baf31249SMarian Balakowicz2. Set environment variable BUILD_DIR to point to the desired location:
4414baf31249SMarian Balakowicz
4415baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
4416baf31249SMarian Balakowicz	make distclean
4417baf31249SMarian Balakowicz	make NAME_config
4418baf31249SMarian Balakowicz	make all
4419baf31249SMarian Balakowicz
4420baf31249SMarian BalakowiczNote that the command line "O=" setting overrides the BUILD_DIR environment
4421baf31249SMarian Balakowiczvariable.
4422baf31249SMarian Balakowicz
4423c609719bSwdenk
4424c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so
4425c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of
4426c609719bSwdenknative "make".
4427c609719bSwdenk
4428c609719bSwdenk
4429c609719bSwdenkIf the system board that you have is not listed, then you will need
4430c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these
4431c609719bSwdenksteps:
4432c609719bSwdenk
4433c609719bSwdenk1.  Add a new configuration option for your board to the toplevel
44344d675ae6SMichael Jones    "boards.cfg" file, using the existing entries as examples.
44354d675ae6SMichael Jones    Follow the instructions there to keep the boards in order.
4436c609719bSwdenk2.  Create a new directory to hold your board specific code. Add any
443785ec0bccSwdenk    files you need. In your board directory, you will need at least
443885ec0bccSwdenk    the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
443985ec0bccSwdenk3.  Create a new configuration file "include/configs/<board>.h" for
444085ec0bccSwdenk    your board
4441c609719bSwdenk3.  If you're porting U-Boot to a new CPU, then also create a new
4442c609719bSwdenk    directory to hold your CPU specific code. Add any files you need.
444385ec0bccSwdenk4.  Run "make <board>_config" with your new name.
4444c609719bSwdenk5.  Type "make", and you should get a working "u-boot.srec" file
4445c609719bSwdenk    to be installed on your target system.
444685ec0bccSwdenk6.  Debug and solve any problems that might arise.
4447c609719bSwdenk    [Of course, this last step is much harder than it sounds.]
4448c609719bSwdenk
4449c609719bSwdenk
4450c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.:
4451c609719bSwdenk==============================================================
4452c609719bSwdenk
4453c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board
4454c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to
4455c609719bSwdenkprovide feedback to the other developers. The feedback normally takes
4456c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest
4457218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources.
4458c609719bSwdenk
4459c609719bSwdenkBut before you submit such a patch, please verify that your modifi-
4460c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of
4461c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so,
4462c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot
4463c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You can
44647152b1d0Swdenkselect which (cross) compiler to use by passing a `CROSS_COMPILE'
4465218ca724SWolfgang Denkenvironment variable to the script, i. e. to use the ELDK cross tools
4466218ca724SWolfgang Denkyou can type
4467c609719bSwdenk
4468c609719bSwdenk	CROSS_COMPILE=ppc_8xx- MAKEALL
4469c609719bSwdenk
4470c609719bSwdenkor to build on a native PowerPC system you can type
4471c609719bSwdenk
4472c609719bSwdenk	CROSS_COMPILE=' ' MAKEALL
4473c609719bSwdenk
4474218ca724SWolfgang DenkWhen using the MAKEALL script, the default behaviour is to build
4475218ca724SWolfgang DenkU-Boot in the source directory. This location can be changed by
4476218ca724SWolfgang Denksetting the BUILD_DIR environment variable. Also, for each target
4477218ca724SWolfgang Denkbuilt, the MAKEALL script saves two log files (<target>.ERR and
4478218ca724SWolfgang Denk<target>.MAKEALL) in the <source dir>/LOG directory. This default
4479218ca724SWolfgang Denklocation can be changed by setting the MAKEALL_LOGDIR environment
4480218ca724SWolfgang Denkvariable. For example:
4481baf31249SMarian Balakowicz
4482baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
4483baf31249SMarian Balakowicz	export MAKEALL_LOGDIR=/tmp/log
4484baf31249SMarian Balakowicz	CROSS_COMPILE=ppc_8xx- MAKEALL
4485baf31249SMarian Balakowicz
4486218ca724SWolfgang DenkWith the above settings build objects are saved in the /tmp/build,
4487218ca724SWolfgang Denklog files are saved in the /tmp/log and the source tree remains clean
4488218ca724SWolfgang Denkduring the whole build process.
4489baf31249SMarian Balakowicz
4490baf31249SMarian Balakowicz
4491c609719bSwdenkSee also "U-Boot Porting Guide" below.
4492c609719bSwdenk
4493c609719bSwdenk
4494c609719bSwdenkMonitor Commands - Overview:
4495c609719bSwdenk============================
4496c609719bSwdenk
4497c609719bSwdenkgo	- start application at address 'addr'
4498c609719bSwdenkrun	- run commands in an environment variable
4499c609719bSwdenkbootm	- boot application image from memory
4500c609719bSwdenkbootp	- boot image via network using BootP/TFTP protocol
450144f074c7SMarek Vasutbootz   - boot zImage from memory
4502c609719bSwdenktftpboot- boot image via network using TFTP protocol
4503c609719bSwdenk	       and env variables "ipaddr" and "serverip"
4504c609719bSwdenk	       (and eventually "gatewayip")
45051fb7cd49SSimon Glasstftpput - upload a file via network using TFTP protocol
4506c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol
4507c609719bSwdenkdiskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
4508c609719bSwdenkloads	- load S-Record file over serial line
4509c609719bSwdenkloadb	- load binary file over serial line (kermit mode)
4510c609719bSwdenkmd	- memory display
4511c609719bSwdenkmm	- memory modify (auto-incrementing)
4512c609719bSwdenknm	- memory modify (constant address)
4513c609719bSwdenkmw	- memory write (fill)
4514c609719bSwdenkcp	- memory copy
4515c609719bSwdenkcmp	- memory compare
4516c609719bSwdenkcrc32	- checksum calculation
45170f89c54bSPeter Tyseri2c	- I2C sub-system
4518c609719bSwdenksspi	- SPI utility commands
4519c609719bSwdenkbase	- print or set address offset
4520c609719bSwdenkprintenv- print environment variables
4521c609719bSwdenksetenv	- set environment variables
4522c609719bSwdenksaveenv - save environment variables to persistent storage
4523c609719bSwdenkprotect - enable or disable FLASH write protection
4524c609719bSwdenkerase	- erase FLASH memory
4525c609719bSwdenkflinfo	- print FLASH memory information
452610635afaSKarl O. Pincnand	- NAND memory operations (see doc/README.nand)
4527c609719bSwdenkbdinfo	- print Board Info structure
4528c609719bSwdenkiminfo	- print header information for application image
4529c609719bSwdenkconinfo - print console devices and informations
4530c609719bSwdenkide	- IDE sub-system
4531c609719bSwdenkloop	- infinite loop on address range
453256523f12Swdenkloopw	- infinite write loop on address range
4533c609719bSwdenkmtest	- simple RAM test
4534c609719bSwdenkicache	- enable or disable instruction cache
4535c609719bSwdenkdcache	- enable or disable data cache
4536c609719bSwdenkreset	- Perform RESET of the CPU
4537c609719bSwdenkecho	- echo args to console
4538c609719bSwdenkversion - print monitor version
4539c609719bSwdenkhelp	- print online help
4540c609719bSwdenk?	- alias for 'help'
4541c609719bSwdenk
4542c609719bSwdenk
4543c609719bSwdenkMonitor Commands - Detailed Description:
4544c609719bSwdenk========================================
4545c609719bSwdenk
4546c609719bSwdenkTODO.
4547c609719bSwdenk
4548c609719bSwdenkFor now: just type "help <command>".
4549c609719bSwdenk
4550c609719bSwdenk
4551c609719bSwdenkEnvironment Variables:
4552c609719bSwdenk======================
4553c609719bSwdenk
4554c609719bSwdenkU-Boot supports user configuration using Environment Variables which
4555c609719bSwdenkcan be made persistent by saving to Flash memory.
4556c609719bSwdenk
4557c609719bSwdenkEnvironment Variables are set using "setenv", printed using
4558c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv"
4559c609719bSwdenkwithout a value can be used to delete a variable from the
4560c609719bSwdenkenvironment. As long as you don't save the environment you are
4561c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the
4562c609719bSwdenkenvironment is erased by accident, a default environment is provided.
4563c609719bSwdenk
4564c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables.
4565c96f86eeSWolfgang Denk
4566c96f86eeSWolfgang DenkList of environment variables (most likely not complete):
4567c609719bSwdenk
4568c609719bSwdenk  baudrate	- see CONFIG_BAUDRATE
4569c609719bSwdenk
4570c609719bSwdenk  bootdelay	- see CONFIG_BOOTDELAY
4571c609719bSwdenk
4572c609719bSwdenk  bootcmd	- see CONFIG_BOOTCOMMAND
4573c609719bSwdenk
4574c609719bSwdenk  bootargs	- Boot arguments when booting an RTOS image
4575c609719bSwdenk
4576c609719bSwdenk  bootfile	- Name of the image to load with TFTP
4577c609719bSwdenk
45787d721e34SBartlomiej Sieka  bootm_low	- Memory range available for image processing in the bootm
45797d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
45807d721e34SBartlomiej Sieka		  a hexadecimal number and defines lowest address allowed
45817d721e34SBartlomiej Sieka		  for use by the bootm command. See also "bootm_size"
45827d721e34SBartlomiej Sieka		  environment variable. Address defined by "bootm_low" is
45837d721e34SBartlomiej Sieka		  also the base of the initial memory mapping for the Linux
4584c3624e6eSGrant Likely		  kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4585c3624e6eSGrant Likely		  bootm_mapsize.
4586c3624e6eSGrant Likely
4587c3624e6eSGrant Likely  bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
4588c3624e6eSGrant Likely		  This variable is given as a hexadecimal number and it
4589c3624e6eSGrant Likely		  defines the size of the memory region starting at base
4590c3624e6eSGrant Likely		  address bootm_low that is accessible by the Linux kernel
4591c3624e6eSGrant Likely		  during early boot.  If unset, CONFIG_SYS_BOOTMAPSZ is used
4592c3624e6eSGrant Likely		  as the default value if it is defined, and bootm_size is
4593c3624e6eSGrant Likely		  used otherwise.
45947d721e34SBartlomiej Sieka
45957d721e34SBartlomiej Sieka  bootm_size	- Memory range available for image processing in the bootm
45967d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
45977d721e34SBartlomiej Sieka		  a hexadecimal number and defines the size of the region
45987d721e34SBartlomiej Sieka		  allowed for use by the bootm command. See also "bootm_low"
45997d721e34SBartlomiej Sieka		  environment variable.
46007d721e34SBartlomiej Sieka
46014bae9090SBartlomiej Sieka  updatefile	- Location of the software update file on a TFTP server, used
46024bae9090SBartlomiej Sieka		  by the automatic software update feature. Please refer to
46034bae9090SBartlomiej Sieka		  documentation in doc/README.update for more details.
46044bae9090SBartlomiej Sieka
4605c609719bSwdenk  autoload	- if set to "no" (any string beginning with 'n'),
4606c609719bSwdenk		  "bootp" will just load perform a lookup of the
4607c609719bSwdenk		  configuration from the BOOTP server, but not try to
4608c609719bSwdenk		  load any image using TFTP
4609c609719bSwdenk
4610c609719bSwdenk  autostart	- if set to "yes", an image loaded using the "bootp",
4611c609719bSwdenk		  "rarpboot", "tftpboot" or "diskboot" commands will
4612c609719bSwdenk		  be automatically started (by internally calling
4613c609719bSwdenk		  "bootm")
4614c609719bSwdenk
46154a6fd34bSwdenk		  If set to "no", a standalone image passed to the
46164a6fd34bSwdenk		  "bootm" command will be copied to the load address
46174a6fd34bSwdenk		  (and eventually uncompressed), but NOT be started.
46184a6fd34bSwdenk		  This can be used to load and uncompress arbitrary
46194a6fd34bSwdenk		  data.
46204a6fd34bSwdenk
4621a28afca5SDavid A. Long  fdt_high	- if set this restricts the maximum address that the
4622a28afca5SDavid A. Long		  flattened device tree will be copied into upon boot.
4623fa34f6b2SShawn Guo		  For example, if you have a system with 1 GB memory
4624fa34f6b2SShawn Guo		  at physical address 0x10000000, while Linux kernel
4625fa34f6b2SShawn Guo		  only recognizes the first 704 MB as low memory, you
4626fa34f6b2SShawn Guo		  may need to set fdt_high as 0x3C000000 to have the
4627fa34f6b2SShawn Guo		  device tree blob be copied to the maximum address
4628fa34f6b2SShawn Guo		  of the 704 MB low memory, so that Linux kernel can
4629fa34f6b2SShawn Guo		  access it during the boot procedure.
4630fa34f6b2SShawn Guo
4631a28afca5SDavid A. Long		  If this is set to the special value 0xFFFFFFFF then
4632a28afca5SDavid A. Long		  the fdt will not be copied at all on boot.  For this
4633a28afca5SDavid A. Long		  to work it must reside in writable memory, have
4634a28afca5SDavid A. Long		  sufficient padding on the end of it for u-boot to
4635a28afca5SDavid A. Long		  add the information it needs into it, and the memory
4636a28afca5SDavid A. Long		  must be accessible by the kernel.
4637a28afca5SDavid A. Long
4638eea63e05SSimon Glass  fdtcontroladdr- if set this is the address of the control flattened
4639eea63e05SSimon Glass		  device tree used by U-Boot when CONFIG_OF_CONTROL is
4640eea63e05SSimon Glass		  defined.
4641eea63e05SSimon Glass
464217ea1177Swdenk  i2cfast	- (PPC405GP|PPC405EP only)
464317ea1177Swdenk		  if set to 'y' configures Linux I2C driver for fast
464417ea1177Swdenk		  mode (400kHZ). This environment variable is used in
464517ea1177Swdenk		  initialization code. So, for changes to be effective
464617ea1177Swdenk		  it must be saved and board must be reset.
464717ea1177Swdenk
4648c609719bSwdenk  initrd_high	- restrict positioning of initrd images:
4649c609719bSwdenk		  If this variable is not set, initrd images will be
4650c609719bSwdenk		  copied to the highest possible address in RAM; this
4651c609719bSwdenk		  is usually what you want since it allows for
4652c609719bSwdenk		  maximum initrd size. If for some reason you want to
4653c609719bSwdenk		  make sure that the initrd image is loaded below the
46546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		  CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
4655c609719bSwdenk		  variable to a value of "no" or "off" or "0".
4656c609719bSwdenk		  Alternatively, you can set it to a maximum upper
4657c609719bSwdenk		  address to use (U-Boot will still check that it
4658c609719bSwdenk		  does not overwrite the U-Boot stack and data).
4659c609719bSwdenk
4660c609719bSwdenk		  For instance, when you have a system with 16 MB
46617152b1d0Swdenk		  RAM, and want to reserve 4 MB from use by Linux,
4662c609719bSwdenk		  you can do this by adding "mem=12M" to the value of
4663c609719bSwdenk		  the "bootargs" variable. However, now you must make
46647152b1d0Swdenk		  sure that the initrd image is placed in the first
4665c609719bSwdenk		  12 MB as well - this can be done with
4666c609719bSwdenk
4667c609719bSwdenk		  setenv initrd_high 00c00000
4668c609719bSwdenk
466938b99261Swdenk		  If you set initrd_high to 0xFFFFFFFF, this is an
467038b99261Swdenk		  indication to U-Boot that all addresses are legal
467138b99261Swdenk		  for the Linux kernel, including addresses in flash
467238b99261Swdenk		  memory. In this case U-Boot will NOT COPY the
467338b99261Swdenk		  ramdisk at all. This may be useful to reduce the
467438b99261Swdenk		  boot time on your system, but requires that this
467538b99261Swdenk		  feature is supported by your Linux kernel.
467638b99261Swdenk
4677c609719bSwdenk  ipaddr	- IP address; needed for tftpboot command
4678c609719bSwdenk
4679c609719bSwdenk  loadaddr	- Default load address for commands like "bootp",
4680dc7c9a1aSwdenk		  "rarpboot", "tftpboot", "loadb" or "diskboot"
4681c609719bSwdenk
4682c609719bSwdenk  loads_echo	- see CONFIG_LOADS_ECHO
4683c609719bSwdenk
4684c609719bSwdenk  serverip	- TFTP server IP address; needed for tftpboot command
4685c609719bSwdenk
4686c609719bSwdenk  bootretry	- see CONFIG_BOOT_RETRY_TIME
4687c609719bSwdenk
4688c609719bSwdenk  bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
4689c609719bSwdenk
4690c609719bSwdenk  bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
4691c609719bSwdenk
4692e2a53458SMike Frysinger  ethprime	- controls which interface is used first.
4693a3d991bdSwdenk
4694e2a53458SMike Frysinger  ethact	- controls which interface is currently active.
4695e2a53458SMike Frysinger		  For example you can do the following
4696a3d991bdSwdenk
469748690d80SHeiko Schocher		  => setenv ethact FEC
469848690d80SHeiko Schocher		  => ping 192.168.0.1 # traffic sent on FEC
469948690d80SHeiko Schocher		  => setenv ethact SCC
470048690d80SHeiko Schocher		  => ping 10.0.0.1 # traffic sent on SCC
4701a3d991bdSwdenk
4702e1692577SMatthias Fuchs  ethrotate	- When set to "no" U-Boot does not go through all
4703e1692577SMatthias Fuchs		  available network interfaces.
4704e1692577SMatthias Fuchs		  It just stays at the currently selected interface.
4705e1692577SMatthias Fuchs
4706a3d991bdSwdenk  netretry	- When set to "no" each network operation will
4707a3d991bdSwdenk		  either succeed or fail without retrying.
47086e592385Swdenk		  When set to "once" the network operation will
47096e592385Swdenk		  fail when all the available network interfaces
47106e592385Swdenk		  are tried once without success.
4711a3d991bdSwdenk		  Useful on scripts which control the retry operation
4712a3d991bdSwdenk		  themselves.
4713a3d991bdSwdenk
4714b4e2f89dSJean-Christophe PLAGNIOL-VILLARD  npe_ucode	- set load address for the NPE microcode
4715a1cf027aSJean-Christophe PLAGNIOL-VILLARD
47168d51aacdSSimon Glass  silent_linux  - If set then linux will be told to boot silently, by
47178d51aacdSSimon Glass		  changing the console to be empty. If "yes" it will be
47188d51aacdSSimon Glass		  made silent. If "no" it will not be made silent. If
47198d51aacdSSimon Glass		  unset, then it will be made silent if the U-Boot console
47208d51aacdSSimon Glass		  is silent.
47218d51aacdSSimon Glass
472228cb9375SWolfgang Denk  tftpsrcport	- If this is set, the value is used for TFTP's
4723ecb0ccd9SWolfgang Denk		  UDP source port.
4724ecb0ccd9SWolfgang Denk
472528cb9375SWolfgang Denk  tftpdstport	- If this is set, the value is used for TFTP's UDP
472628cb9375SWolfgang Denk		  destination port instead of the Well Know Port 69.
472728cb9375SWolfgang Denk
4728c96f86eeSWolfgang Denk  tftpblocksize - Block size to use for TFTP transfers; if not set,
4729c96f86eeSWolfgang Denk		  we use the TFTP server's default block size
4730c96f86eeSWolfgang Denk
4731c96f86eeSWolfgang Denk  tftptimeout	- Retransmission timeout for TFTP packets (in milli-
4732c96f86eeSWolfgang Denk		  seconds, minimum value is 1000 = 1 second). Defines
4733c96f86eeSWolfgang Denk		  when a packet is considered to be lost so it has to
4734c96f86eeSWolfgang Denk		  be retransmitted. The default is 5000 = 5 seconds.
4735c96f86eeSWolfgang Denk		  Lowering this value may make downloads succeed
4736c96f86eeSWolfgang Denk		  faster in networks with high packet loss rates or
4737c96f86eeSWolfgang Denk		  with unreliable TFTP servers.
4738c96f86eeSWolfgang Denk
4739a3d991bdSwdenk  vlan		- When set to a value < 4095 the traffic over
474011ccc33fSMarcel Ziswiler		  Ethernet is encapsulated/received over 802.1q
4741a3d991bdSwdenk		  VLAN tagged frames.
4742c609719bSwdenk
4743dc0b7b0eSJason HobbsThe following image location variables contain the location of images
4744dc0b7b0eSJason Hobbsused in booting. The "Image" column gives the role of the image and is
4745dc0b7b0eSJason Hobbsnot an environment variable name. The other columns are environment
4746dc0b7b0eSJason Hobbsvariable names. "File Name" gives the name of the file on a TFTP
4747dc0b7b0eSJason Hobbsserver, "RAM Address" gives the location in RAM the image will be
4748dc0b7b0eSJason Hobbsloaded to, and "Flash Location" gives the image's address in NOR
4749dc0b7b0eSJason Hobbsflash or offset in NAND flash.
4750dc0b7b0eSJason Hobbs
4751dc0b7b0eSJason Hobbs*Note* - these variables don't have to be defined for all boards, some
4752dc0b7b0eSJason Hobbsboards currenlty use other variables for these purposes, and some
4753dc0b7b0eSJason Hobbsboards use these variables for other purposes.
4754dc0b7b0eSJason Hobbs
4755dc0b7b0eSJason HobbsImage		    File Name	     RAM Address       Flash Location
4756dc0b7b0eSJason Hobbs-----		    ---------	     -----------       --------------
4757dc0b7b0eSJason Hobbsu-boot		    u-boot	     u-boot_addr_r     u-boot_addr
4758dc0b7b0eSJason HobbsLinux kernel	    bootfile	     kernel_addr_r     kernel_addr
4759dc0b7b0eSJason Hobbsdevice tree blob    fdtfile	     fdt_addr_r	       fdt_addr
4760dc0b7b0eSJason Hobbsramdisk		    ramdiskfile	     ramdisk_addr_r    ramdisk_addr
4761dc0b7b0eSJason Hobbs
4762c609719bSwdenkThe following environment variables may be used and automatically
4763c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"),
4764c609719bSwdenkdepending the information provided by your boot server:
4765c609719bSwdenk
4766c609719bSwdenk  bootfile	- see above
4767c609719bSwdenk  dnsip		- IP address of your Domain Name Server
4768fe389a82Sstroese  dnsip2	- IP address of your secondary Domain Name Server
4769c609719bSwdenk  gatewayip	- IP address of the Gateway (Router) to use
4770c609719bSwdenk  hostname	- Target hostname
4771c609719bSwdenk  ipaddr	- see above
4772c609719bSwdenk  netmask	- Subnet Mask
4773c609719bSwdenk  rootpath	- Pathname of the root filesystem on the NFS server
4774c609719bSwdenk  serverip	- see above
4775c609719bSwdenk
4776c609719bSwdenk
4777c609719bSwdenkThere are two special Environment Variables:
4778c609719bSwdenk
4779c609719bSwdenk  serial#	- contains hardware identification information such
4780c609719bSwdenk		  as type string and/or serial number
4781c609719bSwdenk  ethaddr	- Ethernet address
4782c609719bSwdenk
4783c609719bSwdenkThese variables can be set only once (usually during manufacturing of
4784c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables
4785c609719bSwdenkonce they have been set once.
4786c609719bSwdenk
4787c609719bSwdenk
4788c1551ea8SstroeseFurther special Environment Variables:
4789c1551ea8Sstroese
4790c1551ea8Sstroese  ver		- Contains the U-Boot version string as printed
4791c1551ea8Sstroese		  with the "version" command. This variable is
4792c1551ea8Sstroese		  readonly (see CONFIG_VERSION_VARIABLE).
4793c1551ea8Sstroese
4794c1551ea8Sstroese
4795c609719bSwdenkPlease note that changes to some configuration parameters may take
4796c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-).
4797c609719bSwdenk
4798c609719bSwdenk
4799170ab110SJoe HershbergerCallback functions for environment variables:
4800170ab110SJoe Hershberger---------------------------------------------
4801170ab110SJoe Hershberger
4802170ab110SJoe HershbergerFor some environment variables, the behavior of u-boot needs to change
4803170ab110SJoe Hershbergerwhen their values are changed.  This functionailty allows functions to
4804170ab110SJoe Hershbergerbe associated with arbitrary variables.  On creation, overwrite, or
4805170ab110SJoe Hershbergerdeletion, the callback will provide the opportunity for some side
4806170ab110SJoe Hershbergereffect to happen or for the change to be rejected.
4807170ab110SJoe Hershberger
4808170ab110SJoe HershbergerThe callbacks are named and associated with a function using the
4809170ab110SJoe HershbergerU_BOOT_ENV_CALLBACK macro in your board or driver code.
4810170ab110SJoe Hershberger
4811170ab110SJoe HershbergerThese callbacks are associated with variables in one of two ways.  The
4812170ab110SJoe Hershbergerstatic list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
4813170ab110SJoe Hershbergerin the board configuration to a string that defines a list of
4814170ab110SJoe Hershbergerassociations.  The list must be in the following format:
4815170ab110SJoe Hershberger
4816170ab110SJoe Hershberger	entry = variable_name[:callback_name]
4817170ab110SJoe Hershberger	list = entry[,list]
4818170ab110SJoe Hershberger
4819170ab110SJoe HershbergerIf the callback name is not specified, then the callback is deleted.
4820170ab110SJoe HershbergerSpaces are also allowed anywhere in the list.
4821170ab110SJoe Hershberger
4822170ab110SJoe HershbergerCallbacks can also be associated by defining the ".callbacks" variable
4823170ab110SJoe Hershbergerwith the same list format above.  Any association in ".callbacks" will
4824170ab110SJoe Hershbergeroverride any association in the static list. You can define
4825170ab110SJoe HershbergerCONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
4826170ab110SJoe Hershberger".callbacks" envirnoment variable in the default or embedded environment.
4827170ab110SJoe Hershberger
4828170ab110SJoe Hershberger
4829f07771ccSwdenkCommand Line Parsing:
4830f07771ccSwdenk=====================
4831f07771ccSwdenk
4832f07771ccSwdenkThere are two different command line parsers available with U-Boot:
48337152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell:
4834f07771ccSwdenk
4835f07771ccSwdenkOld, simple command line parser:
4836f07771ccSwdenk--------------------------------
4837f07771ccSwdenk
4838f07771ccSwdenk- supports environment variables (through setenv / saveenv commands)
4839f07771ccSwdenk- several commands on one line, separated by ';'
4840fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax
4841f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\',
4842f07771ccSwdenk  for example:
4843fe126d8bSWolfgang Denk	setenv bootcmd bootm \${address}
4844f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example:
4845f07771ccSwdenk	setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
4846f07771ccSwdenk
4847f07771ccSwdenkHush shell:
4848f07771ccSwdenk-----------
4849f07771ccSwdenk
4850f07771ccSwdenk- similar to Bourne shell, with control structures like
4851f07771ccSwdenk  if...then...else...fi, for...do...done; while...do...done,
4852f07771ccSwdenk  until...do...done, ...
4853f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv
4854f07771ccSwdenk  commands) and local shell variables (through standard shell syntax
4855f07771ccSwdenk  "name=value"); only environment variables can be used with "run"
4856f07771ccSwdenk  command
4857f07771ccSwdenk
4858f07771ccSwdenkGeneral rules:
4859f07771ccSwdenk--------------
4860f07771ccSwdenk
4861f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run"
4862f07771ccSwdenk    command) contains several commands separated by semicolon, and
4863f07771ccSwdenk    one of these commands fails, then the remaining commands will be
4864f07771ccSwdenk    executed anyway.
4865f07771ccSwdenk
4866f07771ccSwdenk(2) If you execute several variables with one call to run (i. e.
486711ccc33fSMarcel Ziswiler    calling run with a list of variables as arguments), any failing
4868f07771ccSwdenk    command will cause "run" to terminate, i. e. the remaining
4869f07771ccSwdenk    variables are not executed.
4870f07771ccSwdenk
4871c609719bSwdenkNote for Redundant Ethernet Interfaces:
4872c609719bSwdenk=======================================
4873c609719bSwdenk
487411ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports
4875c609719bSwdenksuch configurations and is capable of automatic selection of a
48767152b1d0Swdenk"working" interface when needed. MAC assignment works as follows:
4877c609719bSwdenk
4878c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding
4879c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0),
4880c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ...
4881c609719bSwdenk
4882c609719bSwdenkIf the network interface stores some valid MAC address (for instance
4883c609719bSwdenkin SROM), this is used as default address if there is NO correspon-
4884c609719bSwdenkding setting in the environment; if the corresponding environment
4885c609719bSwdenkvariable is set, this overrides the settings in the card; that means:
4886c609719bSwdenk
4887c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the
4888c609719bSwdenk  environment, the SROM's address is used.
4889c609719bSwdenk
4890c609719bSwdenko If there is no valid address in the SROM, and a definition in the
4891c609719bSwdenk  environment exists, then the value from the environment variable is
4892c609719bSwdenk  used.
4893c609719bSwdenk
4894c609719bSwdenko If both the SROM and the environment contain a MAC address, and
4895c609719bSwdenk  both addresses are the same, this MAC address is used.
4896c609719bSwdenk
4897c609719bSwdenko If both the SROM and the environment contain a MAC address, and the
4898c609719bSwdenk  addresses differ, the value from the environment is used and a
4899c609719bSwdenk  warning is printed.
4900c609719bSwdenk
4901c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error
4902c609719bSwdenk  is raised.
4903c609719bSwdenk
4904ecee9324SBen WarrenIf Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
4905ecee9324SBen Warrenwill be programmed into hardware as part of the initialization process.	 This
4906ecee9324SBen Warrenmay be skipped by setting the appropriate 'ethmacskip' environment variable.
4907ecee9324SBen WarrenThe naming convention is as follows:
4908ecee9324SBen Warren"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
4909c609719bSwdenk
4910c609719bSwdenkImage Formats:
4911c609719bSwdenk==============
4912c609719bSwdenk
49133310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on)
49143310c549SMarian Balakowiczimages in two formats:
49153310c549SMarian Balakowicz
49163310c549SMarian BalakowiczNew uImage format (FIT)
49173310c549SMarian Balakowicz-----------------------
49183310c549SMarian Balakowicz
49193310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar
49203310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple
49213310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by
49223310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
49233310c549SMarian Balakowicz
49243310c549SMarian Balakowicz
49253310c549SMarian BalakowiczOld uImage format
49263310c549SMarian Balakowicz-----------------
49273310c549SMarian Balakowicz
49283310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything,
49293310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for
49303310c549SMarian Balakowiczdetails; basically, the header defines the following image properties:
4931c609719bSwdenk
4932c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
4933c609719bSwdenk  4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
4934f5ed9e39SPeter Tyser  LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
4935f5ed9e39SPeter Tyser  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
4936f5ed9e39SPeter Tyser  INTEGRITY).
49377b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
4938afc1ce82SMacpaul Lin  IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
4939afc1ce82SMacpaul Lin  Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
4940c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2)
4941c609719bSwdenk* Load Address
4942c609719bSwdenk* Entry Point
4943c609719bSwdenk* Image Name
4944c609719bSwdenk* Image Timestamp
4945c609719bSwdenk
4946c609719bSwdenkThe header is marked by a special Magic Number, and both the header
4947c609719bSwdenkand the data portions of the image are secured against corruption by
4948c609719bSwdenkCRC32 checksums.
4949c609719bSwdenk
4950c609719bSwdenk
4951c609719bSwdenkLinux Support:
4952c609719bSwdenk==============
4953c609719bSwdenk
4954c609719bSwdenkAlthough U-Boot should support any OS or standalone application
49557152b1d0Swdenkeasily, the main focus has always been on Linux during the design of
4956c609719bSwdenkU-Boot.
4957c609719bSwdenk
4958c609719bSwdenkU-Boot includes many features that so far have been part of some
4959c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any
4960c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image;
4961c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation
49627152b1d0Swdenkserves several purposes:
4963c609719bSwdenk
4964c609719bSwdenk- the same features can be used for other OS or standalone
4965c609719bSwdenk  applications (for instance: using compressed images to reduce the
4966c609719bSwdenk  Flash memory footprint)
4967c609719bSwdenk
4968c609719bSwdenk- it becomes much easier to port new Linux kernel versions because
49697152b1d0Swdenk  lots of low-level, hardware dependent stuff are done by U-Boot
4970c609719bSwdenk
4971c609719bSwdenk- the same Linux kernel image can now be used with different "initrd"
4972c609719bSwdenk  images; of course this also means that different kernel images can
4973c609719bSwdenk  be run with the same "initrd". This makes testing easier (you don't
4974c609719bSwdenk  have to build a new "zImage.initrd" Linux image when you just
4975c609719bSwdenk  change a file in your "initrd"). Also, a field-upgrade of the
4976c609719bSwdenk  software is easier now.
4977c609719bSwdenk
4978c609719bSwdenk
4979c609719bSwdenkLinux HOWTO:
4980c609719bSwdenk============
4981c609719bSwdenk
4982c609719bSwdenkPorting Linux to U-Boot based systems:
4983c609719bSwdenk---------------------------------------
4984c609719bSwdenk
4985c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to
4986c609719bSwdenkconfigure the Linux device drivers for use with your target hardware
4987c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to
4988c609719bSwdenkLinux :-).
4989c609719bSwdenk
4990a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
4991c609719bSwdenk
4992c609719bSwdenkJust make sure your machine specific header file (for instance
4993c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board
49941dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h,
49951dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value
49966d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR.
4997c609719bSwdenk
4998c609719bSwdenk
4999c609719bSwdenkConfiguring the Linux kernel:
5000c609719bSwdenk-----------------------------
5001c609719bSwdenk
5002c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root
5003c609719bSwdenkdevice (initial ramdisk, NFS) for your target system.
5004c609719bSwdenk
5005c609719bSwdenk
5006c609719bSwdenkBuilding a Linux Image:
5007c609719bSwdenk-----------------------
5008c609719bSwdenk
500924ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are
501024ee89b9Swdenknot used. If you use recent kernel source, a new build target
501124ee89b9Swdenk"uImage" will exist which automatically builds an image usable by
501224ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target,
501324ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a
501424ee89b9Swdenk100% compatible format.
5015c609719bSwdenk
5016c609719bSwdenkExample:
5017c609719bSwdenk
5018c609719bSwdenk	make TQM850L_config
5019c609719bSwdenk	make oldconfig
5020c609719bSwdenk	make dep
502124ee89b9Swdenk	make uImage
5022c609719bSwdenk
502324ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to
502424ee89b9Swdenkencapsulate a compressed Linux kernel image with header	 information,
502524ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing:
5026c609719bSwdenk
502724ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format):
502824ee89b9Swdenk
502924ee89b9Swdenk* convert the kernel into a raw binary image:
503024ee89b9Swdenk
503124ee89b9Swdenk	${CROSS_COMPILE}-objcopy -O binary \
503224ee89b9Swdenk				 -R .note -R .comment \
503324ee89b9Swdenk				 -S vmlinux linux.bin
503424ee89b9Swdenk
503524ee89b9Swdenk* compress the binary image:
503624ee89b9Swdenk
503724ee89b9Swdenk	gzip -9 linux.bin
503824ee89b9Swdenk
503924ee89b9Swdenk* package compressed binary image for U-Boot:
504024ee89b9Swdenk
504124ee89b9Swdenk	mkimage -A ppc -O linux -T kernel -C gzip \
504224ee89b9Swdenk		-a 0 -e 0 -n "Linux Kernel Image" \
504324ee89b9Swdenk		-d linux.bin.gz uImage
504424ee89b9Swdenk
504524ee89b9Swdenk
504624ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use
504724ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or
504824ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64
504924ee89b9Swdenkbyte header containing information about target architecture,
505024ee89b9Swdenkoperating system, image type, compression method, entry points, time
505124ee89b9Swdenkstamp, CRC32 checksums, etc.
505224ee89b9Swdenk
505324ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and
505424ee89b9Swdenkprint the header information, or to build new images.
5055c609719bSwdenk
5056c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information
5057c609719bSwdenkcontained in the header of an existing U-Boot image; this includes
5058c609719bSwdenkchecksum verification:
5059c609719bSwdenk
5060c609719bSwdenk	tools/mkimage -l image
5061c609719bSwdenk	  -l ==> list image header information
5062c609719bSwdenk
5063c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image
5064c609719bSwdenkfrom a "data file" which is used as image payload:
5065c609719bSwdenk
5066c609719bSwdenk	tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5067c609719bSwdenk		      -n name -d data_file image
5068c609719bSwdenk	  -A ==> set architecture to 'arch'
5069c609719bSwdenk	  -O ==> set operating system to 'os'
5070c609719bSwdenk	  -T ==> set image type to 'type'
5071c609719bSwdenk	  -C ==> set compression type 'comp'
5072c609719bSwdenk	  -a ==> set load address to 'addr' (hex)
5073c609719bSwdenk	  -e ==> set entry point to 'ep' (hex)
5074c609719bSwdenk	  -n ==> set image name to 'name'
5075c609719bSwdenk	  -d ==> use image data from 'datafile'
5076c609719bSwdenk
507769459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load
507869459791Swdenkaddress (0x00000000), but the entry point address depends on the
507969459791Swdenkkernel version:
5080c609719bSwdenk
5081c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C,
508224ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000.
5083c609719bSwdenk
5084c609719bSwdenkSo a typical call to build a U-Boot image would read:
5085c609719bSwdenk
508624ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
508724ee89b9Swdenk	> -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
5088a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
508924ee89b9Swdenk	> examples/uImage.TQM850L
509024ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5091c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5092c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
5093c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
5094c609719bSwdenk	Load Address: 0x00000000
509524ee89b9Swdenk	Entry Point:  0x00000000
5096c609719bSwdenk
5097c609719bSwdenkTo verify the contents of the image (or check for corruption):
5098c609719bSwdenk
509924ee89b9Swdenk	-> tools/mkimage -l examples/uImage.TQM850L
510024ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5101c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5102c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
5103c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
5104c609719bSwdenk	Load Address: 0x00000000
510524ee89b9Swdenk	Entry Point:  0x00000000
5106c609719bSwdenk
5107c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade
5108c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this
5109c609719bSwdenkneeds more space in Flash, but boots much faster since it does not
5110c609719bSwdenkneed to be uncompressed:
5111c609719bSwdenk
5112a47a12beSStefan Roese	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
511324ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
511424ee89b9Swdenk	> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
5115a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
511624ee89b9Swdenk	> examples/uImage.TQM850L-uncompressed
511724ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5118c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5119c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (uncompressed)
5120c609719bSwdenk	Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
5121c609719bSwdenk	Load Address: 0x00000000
512224ee89b9Swdenk	Entry Point:  0x00000000
5123c609719bSwdenk
5124c609719bSwdenk
5125c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file
5126c609719bSwdenkwhen your kernel is intended to use an initial ramdisk:
5127c609719bSwdenk
5128c609719bSwdenk	-> tools/mkimage -n 'Simple Ramdisk Image' \
5129c609719bSwdenk	> -A ppc -O linux -T ramdisk -C gzip \
5130c609719bSwdenk	> -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5131c609719bSwdenk	Image Name:   Simple Ramdisk Image
5132c609719bSwdenk	Created:      Wed Jan 12 14:01:50 2000
5133c609719bSwdenk	Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
5134c609719bSwdenk	Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
5135c609719bSwdenk	Load Address: 0x00000000
5136c609719bSwdenk	Entry Point:  0x00000000
5137c609719bSwdenk
5138c609719bSwdenk
5139c609719bSwdenkInstalling a Linux Image:
5140c609719bSwdenk-------------------------
5141c609719bSwdenk
5142c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface,
5143c609719bSwdenkyou must convert the image to S-Record format:
5144c609719bSwdenk
5145c609719bSwdenk	objcopy -I binary -O srec examples/image examples/image.srec
5146c609719bSwdenk
5147c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot
5148c609719bSwdenkimage header, so the resulting S-Record file will be relative to
5149c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to
5150c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads'
5151c609719bSwdenkcommand.
5152c609719bSwdenk
5153c609719bSwdenkExample: install the image to address 0x40100000 (which on the
5154c609719bSwdenkTQM8xxL is in the first Flash bank):
5155c609719bSwdenk
5156c609719bSwdenk	=> erase 40100000 401FFFFF
5157c609719bSwdenk
5158c609719bSwdenk	.......... done
5159c609719bSwdenk	Erased 8 sectors
5160c609719bSwdenk
5161c609719bSwdenk	=> loads 40100000
5162c609719bSwdenk	## Ready for S-Record download ...
5163c609719bSwdenk	~>examples/image.srec
5164c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5165c609719bSwdenk	...
5166c609719bSwdenk	15989 15990 15991 15992
5167c609719bSwdenk	[file transfer complete]
5168c609719bSwdenk	[connected]
5169c609719bSwdenk	## Start Addr = 0x00000000
5170c609719bSwdenk
5171c609719bSwdenk
5172c609719bSwdenkYou can check the success of the download using the 'iminfo' command;
5173c609719bSwdenkthis includes a checksum verification so you can be sure no data
5174c609719bSwdenkcorruption happened:
5175c609719bSwdenk
5176c609719bSwdenk	=> imi 40100000
5177c609719bSwdenk
5178c609719bSwdenk	## Checking Image at 40100000 ...
5179c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5180c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5181c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5182c609719bSwdenk	   Load Address: 00000000
5183c609719bSwdenk	   Entry Point:	 0000000c
5184c609719bSwdenk	   Verifying Checksum ... OK
5185c609719bSwdenk
5186c609719bSwdenk
5187c609719bSwdenkBoot Linux:
5188c609719bSwdenk-----------
5189c609719bSwdenk
5190c609719bSwdenkThe "bootm" command is used to boot an application that is stored in
5191c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents
5192c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as
5193c609719bSwdenkparameters. You can check and modify this variable using the
5194c609719bSwdenk"printenv" and "setenv" commands:
5195c609719bSwdenk
5196c609719bSwdenk
5197c609719bSwdenk	=> printenv bootargs
5198c609719bSwdenk	bootargs=root=/dev/ram
5199c609719bSwdenk
5200c609719bSwdenk	=> setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5201c609719bSwdenk
5202c609719bSwdenk	=> printenv bootargs
5203c609719bSwdenk	bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5204c609719bSwdenk
5205c609719bSwdenk	=> bootm 40020000
5206c609719bSwdenk	## Booting Linux kernel at 40020000 ...
5207c609719bSwdenk	   Image Name:	 2.2.13 for NFS on TQM850L
5208c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5209c609719bSwdenk	   Data Size:	 381681 Bytes = 372 kB = 0 MB
5210c609719bSwdenk	   Load Address: 00000000
5211c609719bSwdenk	   Entry Point:	 0000000c
5212c609719bSwdenk	   Verifying Checksum ... OK
5213c609719bSwdenk	   Uncompressing Kernel Image ... OK
5214c609719bSwdenk	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
5215c609719bSwdenk	Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5216c609719bSwdenk	time_init: decrementer frequency = 187500000/60
5217c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
5218c609719bSwdenk	Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5219c609719bSwdenk	...
5220c609719bSwdenk
522111ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass
52227152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT
5223c609719bSwdenkformat!) to the "bootm" command:
5224c609719bSwdenk
5225c609719bSwdenk	=> imi 40100000 40200000
5226c609719bSwdenk
5227c609719bSwdenk	## Checking Image at 40100000 ...
5228c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5229c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5230c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5231c609719bSwdenk	   Load Address: 00000000
5232c609719bSwdenk	   Entry Point:	 0000000c
5233c609719bSwdenk	   Verifying Checksum ... OK
5234c609719bSwdenk
5235c609719bSwdenk	## Checking Image at 40200000 ...
5236c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
5237c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
5238c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
5239c609719bSwdenk	   Load Address: 00000000
5240c609719bSwdenk	   Entry Point:	 00000000
5241c609719bSwdenk	   Verifying Checksum ... OK
5242c609719bSwdenk
5243c609719bSwdenk	=> bootm 40100000 40200000
5244c609719bSwdenk	## Booting Linux kernel at 40100000 ...
5245c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5246c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5247c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5248c609719bSwdenk	   Load Address: 00000000
5249c609719bSwdenk	   Entry Point:	 0000000c
5250c609719bSwdenk	   Verifying Checksum ... OK
5251c609719bSwdenk	   Uncompressing Kernel Image ... OK
5252c609719bSwdenk	## Loading RAMDisk Image at 40200000 ...
5253c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
5254c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
5255c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
5256c609719bSwdenk	   Load Address: 00000000
5257c609719bSwdenk	   Entry Point:	 00000000
5258c609719bSwdenk	   Verifying Checksum ... OK
5259c609719bSwdenk	   Loading Ramdisk ... OK
5260c609719bSwdenk	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
5261c609719bSwdenk	Boot arguments: root=/dev/ram
5262c609719bSwdenk	time_init: decrementer frequency = 187500000/60
5263c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
5264c609719bSwdenk	...
5265c609719bSwdenk	RAMDISK: Compressed image found at block 0
5266c609719bSwdenk	VFS: Mounted root (ext2 filesystem).
5267c609719bSwdenk
5268c609719bSwdenk	bash#
5269c609719bSwdenk
52700267768eSMatthew McClintockBoot Linux and pass a flat device tree:
52710267768eSMatthew McClintock-----------
52720267768eSMatthew McClintock
52730267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section
52740267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The
52750267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated
52760267768eSMatthew McClintockflat device tree:
52770267768eSMatthew McClintock
52780267768eSMatthew McClintock=> print oftaddr
52790267768eSMatthew McClintockoftaddr=0x300000
52800267768eSMatthew McClintock=> print oft
52810267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb
52820267768eSMatthew McClintock=> tftp $oftaddr $oft
52830267768eSMatthew McClintockSpeed: 1000, full duplex
52840267768eSMatthew McClintockUsing TSEC0 device
52850267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101
52860267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'.
52870267768eSMatthew McClintockLoad address: 0x300000
52880267768eSMatthew McClintockLoading: #
52890267768eSMatthew McClintockdone
52900267768eSMatthew McClintockBytes transferred = 4106 (100a hex)
52910267768eSMatthew McClintock=> tftp $loadaddr $bootfile
52920267768eSMatthew McClintockSpeed: 1000, full duplex
52930267768eSMatthew McClintockUsing TSEC0 device
52940267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2
52950267768eSMatthew McClintockFilename 'uImage'.
52960267768eSMatthew McClintockLoad address: 0x200000
52970267768eSMatthew McClintockLoading:############
52980267768eSMatthew McClintockdone
52990267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex)
53000267768eSMatthew McClintock=> print loadaddr
53010267768eSMatthew McClintockloadaddr=200000
53020267768eSMatthew McClintock=> print oftaddr
53030267768eSMatthew McClintockoftaddr=0x300000
53040267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr
53050267768eSMatthew McClintock## Booting image at 00200000 ...
53060267768eSMatthew McClintock   Image Name:	 Linux-2.6.17-dirty
53070267768eSMatthew McClintock   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
53080267768eSMatthew McClintock   Data Size:	 1029343 Bytes = 1005.2 kB
53090267768eSMatthew McClintock   Load Address: 00000000
53100267768eSMatthew McClintock   Entry Point:	 00000000
53110267768eSMatthew McClintock   Verifying Checksum ... OK
53120267768eSMatthew McClintock   Uncompressing Kernel Image ... OK
53130267768eSMatthew McClintockBooting using flat device tree at 0x300000
53140267768eSMatthew McClintockUsing MPC85xx ADS machine description
53150267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
53160267768eSMatthew McClintock[snip]
53170267768eSMatthew McClintock
53180267768eSMatthew McClintock
53196069ff26SwdenkMore About U-Boot Image Types:
53206069ff26Swdenk------------------------------
53216069ff26Swdenk
53226069ff26SwdenkU-Boot supports the following image types:
53236069ff26Swdenk
53246069ff26Swdenk   "Standalone Programs" are directly runnable in the environment
53256069ff26Swdenk	provided by U-Boot; it is expected that (if they behave
53266069ff26Swdenk	well) you can continue to work in U-Boot after return from
53276069ff26Swdenk	the Standalone Program.
53286069ff26Swdenk   "OS Kernel Images" are usually images of some Embedded OS which
53296069ff26Swdenk	will take over control completely. Usually these programs
53306069ff26Swdenk	will install their own set of exception handlers, device
53316069ff26Swdenk	drivers, set up the MMU, etc. - this means, that you cannot
53326069ff26Swdenk	expect to re-enter U-Boot except by resetting the CPU.
53336069ff26Swdenk   "RAMDisk Images" are more or less just data blocks, and their
53346069ff26Swdenk	parameters (address, size) are passed to an OS kernel that is
53356069ff26Swdenk	being started.
53366069ff26Swdenk   "Multi-File Images" contain several images, typically an OS
53376069ff26Swdenk	(Linux) kernel image and one or more data images like
53386069ff26Swdenk	RAMDisks. This construct is useful for instance when you want
53396069ff26Swdenk	to boot over the network using BOOTP etc., where the boot
53406069ff26Swdenk	server provides just a single image file, but you want to get
53416069ff26Swdenk	for instance an OS kernel and a RAMDisk image.
53426069ff26Swdenk
53436069ff26Swdenk	"Multi-File Images" start with a list of image sizes, each
53446069ff26Swdenk	image size (in bytes) specified by an "uint32_t" in network
53456069ff26Swdenk	byte order. This list is terminated by an "(uint32_t)0".
53466069ff26Swdenk	Immediately after the terminating 0 follow the images, one by
53476069ff26Swdenk	one, all aligned on "uint32_t" boundaries (size rounded up to
53486069ff26Swdenk	a multiple of 4 bytes).
53496069ff26Swdenk
53506069ff26Swdenk   "Firmware Images" are binary images containing firmware (like
53516069ff26Swdenk	U-Boot or FPGA images) which usually will be programmed to
53526069ff26Swdenk	flash memory.
53536069ff26Swdenk
53546069ff26Swdenk   "Script files" are command sequences that will be executed by
53556069ff26Swdenk	U-Boot's command interpreter; this feature is especially
53566069ff26Swdenk	useful when you configure U-Boot to use a real shell (hush)
53576069ff26Swdenk	as command interpreter.
53586069ff26Swdenk
535944f074c7SMarek VasutBooting the Linux zImage:
536044f074c7SMarek Vasut-------------------------
536144f074c7SMarek Vasut
536244f074c7SMarek VasutOn some platforms, it's possible to boot Linux zImage. This is done
536344f074c7SMarek Vasutusing the "bootz" command. The syntax of "bootz" command is the same
536444f074c7SMarek Vasutas the syntax of "bootm" command.
536544f074c7SMarek Vasut
53668ac28563STom RiniNote, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
5367017e1f3fSMarek Vasutkernel with raw initrd images. The syntax is slightly different, the
5368017e1f3fSMarek Vasutaddress of the initrd must be augmented by it's size, in the following
5369017e1f3fSMarek Vasutformat: "<initrd addres>:<initrd size>".
5370017e1f3fSMarek Vasut
5371c609719bSwdenk
5372c609719bSwdenkStandalone HOWTO:
5373c609719bSwdenk=================
5374c609719bSwdenk
5375c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and
5376c609719bSwdenkrun "standalone" applications, which can use some resources of
5377c609719bSwdenkU-Boot like console I/O functions or interrupt services.
5378c609719bSwdenk
5379c609719bSwdenkTwo simple examples are included with the sources:
5380c609719bSwdenk
5381c609719bSwdenk"Hello World" Demo:
5382c609719bSwdenk-------------------
5383c609719bSwdenk
5384c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo
5385c609719bSwdenkapplication; it is automatically compiled when you build U-Boot.
5386c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it
5387c609719bSwdenklike that:
5388c609719bSwdenk
5389c609719bSwdenk	=> loads
5390c609719bSwdenk	## Ready for S-Record download ...
5391c609719bSwdenk	~>examples/hello_world.srec
5392c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
5393c609719bSwdenk	[file transfer complete]
5394c609719bSwdenk	[connected]
5395c609719bSwdenk	## Start Addr = 0x00040004
5396c609719bSwdenk
5397c609719bSwdenk	=> go 40004 Hello World! This is a test.
5398c609719bSwdenk	## Starting application at 0x00040004 ...
5399c609719bSwdenk	Hello World
5400c609719bSwdenk	argc = 7
5401c609719bSwdenk	argv[0] = "40004"
5402c609719bSwdenk	argv[1] = "Hello"
5403c609719bSwdenk	argv[2] = "World!"
5404c609719bSwdenk	argv[3] = "This"
5405c609719bSwdenk	argv[4] = "is"
5406c609719bSwdenk	argv[5] = "a"
5407c609719bSwdenk	argv[6] = "test."
5408c609719bSwdenk	argv[7] = "<NULL>"
5409c609719bSwdenk	Hit any key to exit ...
5410c609719bSwdenk
5411c609719bSwdenk	## Application terminated, rc = 0x0
5412c609719bSwdenk
5413c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt
5414c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'.
5415c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second.
5416c609719bSwdenkThe interrupt service routine is trivial, just printing a '.'
5417c609719bSwdenkcharacter, but this is just a demo program. The application can be
5418c609719bSwdenkcontrolled by the following keys:
5419c609719bSwdenk
5420c609719bSwdenk	? - print current values og the CPM Timer registers
5421c609719bSwdenk	b - enable interrupts and start timer
5422c609719bSwdenk	e - stop timer and disable interrupts
5423c609719bSwdenk	q - quit application
5424c609719bSwdenk
5425c609719bSwdenk	=> loads
5426c609719bSwdenk	## Ready for S-Record download ...
5427c609719bSwdenk	~>examples/timer.srec
5428c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
5429c609719bSwdenk	[file transfer complete]
5430c609719bSwdenk	[connected]
5431c609719bSwdenk	## Start Addr = 0x00040004
5432c609719bSwdenk
5433c609719bSwdenk	=> go 40004
5434c609719bSwdenk	## Starting application at 0x00040004 ...
5435c609719bSwdenk	TIMERS=0xfff00980
5436c609719bSwdenk	Using timer 1
5437c609719bSwdenk	  tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
5438c609719bSwdenk
5439c609719bSwdenkHit 'b':
5440c609719bSwdenk	[q, b, e, ?] Set interval 1000000 us
5441c609719bSwdenk	Enabling timer
5442c609719bSwdenkHit '?':
5443c609719bSwdenk	[q, b, e, ?] ........
5444c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
5445c609719bSwdenkHit '?':
5446c609719bSwdenk	[q, b, e, ?] .
5447c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
5448c609719bSwdenkHit '?':
5449c609719bSwdenk	[q, b, e, ?] .
5450c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
5451c609719bSwdenkHit '?':
5452c609719bSwdenk	[q, b, e, ?] .
5453c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
5454c609719bSwdenkHit 'e':
5455c609719bSwdenk	[q, b, e, ?] ...Stopping timer
5456c609719bSwdenkHit 'q':
5457c609719bSwdenk	[q, b, e, ?] ## Application terminated, rc = 0x0
5458c609719bSwdenk
5459c609719bSwdenk
546085ec0bccSwdenkMinicom warning:
546185ec0bccSwdenk================
546285ec0bccSwdenk
54637152b1d0SwdenkOver time, many people have reported problems when trying to use the
546485ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd)
546585ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under
5466f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and
546785ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and
5468e53515a2SKarl O. Pincuse "cu" for S-Record download ("loads" command).  See
5469e53515a2SKarl O. Pinchttp://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
5470e53515a2SKarl O. Pincfor help with kermit.
5471e53515a2SKarl O. Pinc
547285ec0bccSwdenk
547352f52c14SwdenkNevertheless, if you absolutely want to use it try adding this
547452f52c14Swdenkconfiguration to your "File transfer protocols" section:
547552f52c14Swdenk
547652f52c14Swdenk	   Name	   Program			Name U/D FullScr IO-Red. Multi
547752f52c14Swdenk	X  kermit  /usr/bin/kermit -i -l %l -s	 Y    U	   Y	   N	  N
547852f52c14Swdenk	Y  kermit  /usr/bin/kermit -i -l %l -r	 N    D	   Y	   N	  N
547952f52c14Swdenk
548052f52c14Swdenk
5481c609719bSwdenkNetBSD Notes:
5482c609719bSwdenk=============
5483c609719bSwdenk
5484c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host
5485c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx).
5486c609719bSwdenk
5487c609719bSwdenkBuilding requires a cross environment; it is known to work on
5488c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5489c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make).
5490c609719bSwdenkNote that the cross-powerpc package does not install include files;
5491c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is
5492c609719bSwdenkmissing.  This file has to be installed and patched manually:
5493c609719bSwdenk
5494c609719bSwdenk	# cd /usr/pkg/cross/powerpc-netbsd/include
5495c609719bSwdenk	# mkdir powerpc
5496c609719bSwdenk	# ln -s powerpc machine
5497c609719bSwdenk	# cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
5498c609719bSwdenk	# ${EDIT} powerpc/ansi.h	## must remove __va_list, _BSD_VA_LIST
5499c609719bSwdenk
5500c609719bSwdenkNative builds *don't* work due to incompatibilities between native
5501c609719bSwdenkand U-Boot include files.
5502c609719bSwdenk
5503c609719bSwdenkBooting assumes that (the first part of) the image booted is a
5504c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel
5505c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source
5506c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
55072a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
5508c609719bSwdenk
5509c609719bSwdenk
5510c609719bSwdenkImplementation Internals:
5511c609719bSwdenk=========================
5512c609719bSwdenk
5513c609719bSwdenkThe following is not intended to be a complete description of every
5514c609719bSwdenkimplementation detail. However, it should help to understand the
5515c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom
5516c609719bSwdenkhardware.
5517c609719bSwdenk
5518c609719bSwdenk
5519c609719bSwdenkInitial Stack, Global Data:
5520c609719bSwdenk---------------------------
5521c609719bSwdenk
5522c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot
5523c609719bSwdenkstarts running out of ROM (flash memory), usually without access to
5524c609719bSwdenksystem RAM (because the memory controller is not initialized yet).
5525c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS
5526c609719bSwdenkis not initialized as zero. To be able to get a C environment working
5527c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation
5528c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU
5529c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and
5530c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be
5531c609719bSwdenklocked as (mis-) used as memory, etc.
5532c609719bSwdenk
55337152b1d0Swdenk	Chris Hallinan posted a good summary of these issues to the
55340668236bSWolfgang Denk	U-Boot mailing list:
553543d9616cSwdenk
553643d9616cSwdenk	Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
553743d9616cSwdenk	From: "Chris Hallinan" <clh@net1plus.com>
553843d9616cSwdenk	Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
553943d9616cSwdenk	...
554043d9616cSwdenk
554143d9616cSwdenk	Correct me if I'm wrong, folks, but the way I understand it
554243d9616cSwdenk	is this: Using DCACHE as initial RAM for Stack, etc, does not
554343d9616cSwdenk	require any physical RAM backing up the cache. The cleverness
554443d9616cSwdenk	is that the cache is being used as a temporary supply of
554543d9616cSwdenk	necessary storage before the SDRAM controller is setup. It's
554611ccc33fSMarcel Ziswiler	beyond the scope of this list to explain the details, but you
554743d9616cSwdenk	can see how this works by studying the cache architecture and
554843d9616cSwdenk	operation in the architecture and processor-specific manuals.
554943d9616cSwdenk
555043d9616cSwdenk	OCM is On Chip Memory, which I believe the 405GP has 4K. It
555143d9616cSwdenk	is another option for the system designer to use as an
555211ccc33fSMarcel Ziswiler	initial stack/RAM area prior to SDRAM being available. Either
555343d9616cSwdenk	option should work for you. Using CS 4 should be fine if your
555443d9616cSwdenk	board designers haven't used it for something that would
555543d9616cSwdenk	cause you grief during the initial boot! It is frequently not
555643d9616cSwdenk	used.
555743d9616cSwdenk
55586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
555943d9616cSwdenk	with your processor/board/system design. The default value
556043d9616cSwdenk	you will find in any recent u-boot distribution in
55618a316c9bSStefan Roese	walnut.h should work for you. I'd set it to a value larger
556243d9616cSwdenk	than your SDRAM module. If you have a 64MB SDRAM module, set
556343d9616cSwdenk	it above 400_0000. Just make sure your board has no resources
556443d9616cSwdenk	that are supposed to respond to that address! That code in
556543d9616cSwdenk	start.S has been around a while and should work as is when
556643d9616cSwdenk	you get the config right.
556743d9616cSwdenk
556843d9616cSwdenk	-Chris Hallinan
556943d9616cSwdenk	DS4.COM, Inc.
557043d9616cSwdenk
5571c609719bSwdenkIt is essential to remember this, since it has some impact on the C
5572c609719bSwdenkcode for the initialization procedures:
5573c609719bSwdenk
5574c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt
5575c609719bSwdenk  to write it.
5576c609719bSwdenk
557711ccc33fSMarcel Ziswiler* Do not use any uninitialized global data (or implicitely initialized
5578c609719bSwdenk  as zero data - BSS segment) at all - this is undefined, initiali-
55797152b1d0Swdenk  zation is performed later (when relocating to RAM).
5580c609719bSwdenk
5581c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like
5582c609719bSwdenk  that.
5583c609719bSwdenk
5584c609719bSwdenkHaving only the stack as writable memory limits means we cannot use
5585c609719bSwdenknormal global data to share information beween the code. But it
5586c609719bSwdenkturned out that the implementation of U-Boot can be greatly
5587c609719bSwdenksimplified by making a global data structure (gd_t) available to all
5588c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_
5589c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of
5590c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we
5591c609719bSwdenkplace a pointer (gd) to the global data into a register which we
5592c609719bSwdenkreserve for this purpose.
5593c609719bSwdenk
55947152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the
5595c609719bSwdenkrelevant  (E)ABI  specifications for the current architecture, and by
5596c609719bSwdenkGCC's implementation.
5597c609719bSwdenk
5598c609719bSwdenkFor PowerPC, the following registers have specific use:
5599c609719bSwdenk	R1:	stack pointer
5600e7670f6cSWolfgang Denk	R2:	reserved for system use
5601c609719bSwdenk	R3-R4:	parameter passing and return values
5602c609719bSwdenk	R5-R10: parameter passing
5603c609719bSwdenk	R13:	small data area pointer
5604c609719bSwdenk	R30:	GOT pointer
5605c609719bSwdenk	R31:	frame pointer
5606c609719bSwdenk
5607e6bee808SJoakim Tjernlund	(U-Boot also uses R12 as internal GOT pointer. r12
5608e6bee808SJoakim Tjernlund	is a volatile register so r12 needs to be reset when
5609e6bee808SJoakim Tjernlund	going back and forth between asm and C)
5610c609719bSwdenk
5611e7670f6cSWolfgang Denk    ==> U-Boot will use R2 to hold a pointer to the global data
5612c609719bSwdenk
5613c609719bSwdenk    Note: on PPC, we could use a static initializer (since the
5614c609719bSwdenk    address of the global data structure is known at compile time),
5615c609719bSwdenk    but it turned out that reserving a register results in somewhat
5616c609719bSwdenk    smaller code - although the code savings are not that big (on
5617c609719bSwdenk    average for all boards 752 bytes for the whole U-Boot image,
5618c609719bSwdenk    624 text + 127 data).
5619c609719bSwdenk
5620c4db335cSRobin GetzOn Blackfin, the normal C ABI (except for P3) is followed as documented here:
56214c58eb55SMike Frysinger	http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
56224c58eb55SMike Frysinger
5623c4db335cSRobin Getz    ==> U-Boot will use P3 to hold a pointer to the global data
56244c58eb55SMike Frysinger
5625c609719bSwdenkOn ARM, the following registers are used:
5626c609719bSwdenk
5627c609719bSwdenk	R0:	function argument word/integer result
5628c609719bSwdenk	R1-R3:	function argument word
562912eba1b4SJeroen Hofstee	R9:	platform specific
563012eba1b4SJeroen Hofstee	R10:	stack limit (used only if stack checking is enabled)
5631c609719bSwdenk	R11:	argument (frame) pointer
5632c609719bSwdenk	R12:	temporary workspace
5633c609719bSwdenk	R13:	stack pointer
5634c609719bSwdenk	R14:	link register
5635c609719bSwdenk	R15:	program counter
5636c609719bSwdenk
563712eba1b4SJeroen Hofstee    ==> U-Boot will use R9 to hold a pointer to the global data
563812eba1b4SJeroen Hofstee
563912eba1b4SJeroen Hofstee    Note: on ARM, only R_ARM_RELATIVE relocations are supported.
5640c609719bSwdenk
56410df01fd3SThomas ChouOn Nios II, the ABI is documented here:
56420df01fd3SThomas Chou	http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
56430df01fd3SThomas Chou
56440df01fd3SThomas Chou    ==> U-Boot will use gp to hold a pointer to the global data
56450df01fd3SThomas Chou
56460df01fd3SThomas Chou    Note: on Nios II, we give "-G0" option to gcc and don't use gp
56470df01fd3SThomas Chou    to access small data sections, so gp is free.
56480df01fd3SThomas Chou
5649afc1ce82SMacpaul LinOn NDS32, the following registers are used:
5650afc1ce82SMacpaul Lin
5651afc1ce82SMacpaul Lin	R0-R1:	argument/return
5652afc1ce82SMacpaul Lin	R2-R5:	argument
5653afc1ce82SMacpaul Lin	R15:	temporary register for assembler
5654afc1ce82SMacpaul Lin	R16:	trampoline register
5655afc1ce82SMacpaul Lin	R28:	frame pointer (FP)
5656afc1ce82SMacpaul Lin	R29:	global pointer (GP)
5657afc1ce82SMacpaul Lin	R30:	link register (LP)
5658afc1ce82SMacpaul Lin	R31:	stack pointer (SP)
5659afc1ce82SMacpaul Lin	PC:	program counter (PC)
5660afc1ce82SMacpaul Lin
5661afc1ce82SMacpaul Lin    ==> U-Boot will use R10 to hold a pointer to the global data
5662afc1ce82SMacpaul Lin
5663d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5664d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much.
5665c609719bSwdenk
5666c609719bSwdenkMemory Management:
5667c609719bSwdenk------------------
5668c609719bSwdenk
5669c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the
5670c609719bSwdenkMMU is not used either for address mapping nor for memory protection.
5671c609719bSwdenk
5672c609719bSwdenkThe available memory is mapped to fixed addresses using the memory
5673c609719bSwdenkcontroller. In this process, a contiguous block is formed for each
5674c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several
5675c609719bSwdenkphysical memory banks.
5676c609719bSwdenk
5677c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on
5678c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5679c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself
5680c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some
56816d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
5682c609719bSwdenkconfiguration setting]. Below that, a structure with global Board
5683c609719bSwdenkInfo data is placed, followed by the stack (growing downward).
5684c609719bSwdenk
5685c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB
5686c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF).
5687c609719bSwdenk
5688c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like
5689c609719bSwdenkthis:
5690c609719bSwdenk
5691c609719bSwdenk	0x0000 0000	Exception Vector code
5692c609719bSwdenk	      :
5693c609719bSwdenk	0x0000 1FFF
5694c609719bSwdenk	0x0000 2000	Free for Application Use
5695c609719bSwdenk	      :
5696c609719bSwdenk	      :
5697c609719bSwdenk
5698c609719bSwdenk	      :
5699c609719bSwdenk	      :
5700c609719bSwdenk	0x00FB FF20	Monitor Stack (Growing downward)
5701c609719bSwdenk	0x00FB FFAC	Board Info Data and permanent copy of global data
5702c609719bSwdenk	0x00FC 0000	Malloc Arena
5703c609719bSwdenk	      :
5704c609719bSwdenk	0x00FD FFFF
5705c609719bSwdenk	0x00FE 0000	RAM Copy of Monitor Code
5706c609719bSwdenk	...		eventually: LCD or video framebuffer
5707c609719bSwdenk	...		eventually: pRAM (Protected RAM - unchanged by reset)
5708c609719bSwdenk	0x00FF FFFF	[End of RAM]
5709c609719bSwdenk
5710c609719bSwdenk
5711c609719bSwdenkSystem Initialization:
5712c609719bSwdenk----------------------
5713c609719bSwdenk
5714c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point
571511ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset
5716c609719bSwdenkconfiguration for CS0# this is a mirror of the onboard Flash memory.
57177152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address.
5718c609719bSwdenkTo be able to implement the initialization code in C, a (small!)
5719c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs
5720c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked
5721c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core,
5722c609719bSwdenkthe caches and the SIU.
5723c609719bSwdenk
5724c609719bSwdenkNext, all (potentially) available memory banks are mapped using a
5725c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries
5726c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5727c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5728c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a
5729c609719bSwdenksimple memory test is run that determines the size of the SDRAM
5730c609719bSwdenkbanks.
5731c609719bSwdenk
5732c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of
57337152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first
5734c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address
5735c609719bSwdenk0x00000000, with any additional banks following immediately to create
5736c609719bSwdenkcontiguous memory starting from 0.
5737c609719bSwdenk
5738c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area
5739c609719bSwdenkand allocates memory for use by malloc() and for the global Board
5740c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM
5741c609719bSwdenkpages, and the final stack is set up.
5742c609719bSwdenk
5743c609719bSwdenkOnly after this relocation will you have a "normal" C environment;
5744c609719bSwdenkuntil that you are restricted in several ways, mostly because you are
5745c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a
5746c609719bSwdenknew address in RAM.
5747c609719bSwdenk
5748c609719bSwdenk
5749c609719bSwdenkU-Boot Porting Guide:
5750c609719bSwdenk----------------------
5751c609719bSwdenk
5752c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
57536aff3115Swdenklist, October 2002]
5754c609719bSwdenk
5755c609719bSwdenk
5756c609719bSwdenkint main(int argc, char *argv[])
5757c609719bSwdenk{
5758c609719bSwdenk	sighandler_t no_more_time;
5759c609719bSwdenk
5760c609719bSwdenk	signal(SIGALRM, no_more_time);
5761c609719bSwdenk	alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
5762c609719bSwdenk
5763c609719bSwdenk	if (available_money > available_manpower) {
57646c3fef28SJerry Van Baren		Pay consultant to port U-Boot;
5765c609719bSwdenk		return 0;
5766c609719bSwdenk	}
5767c609719bSwdenk
5768c609719bSwdenk	Download latest U-Boot source;
5769c609719bSwdenk
57700668236bSWolfgang Denk	Subscribe to u-boot mailing list;
57716aff3115Swdenk
57726c3fef28SJerry Van Baren	if (clueless)
5773c609719bSwdenk		email("Hi, I am new to U-Boot, how do I get started?");
5774c609719bSwdenk
5775c609719bSwdenk	while (learning) {
5776c609719bSwdenk		Read the README file in the top level directory;
57777cb22f97Swdenk		Read http://www.denx.de/twiki/bin/view/DULG/Manual;
57786c3fef28SJerry Van Baren		Read applicable doc/*.README;
5779c609719bSwdenk		Read the source, Luke;
57806c3fef28SJerry Van Baren		/* find . -name "*.[chS]" | xargs grep -i <keyword> */
5781c609719bSwdenk	}
5782c609719bSwdenk
57836c3fef28SJerry Van Baren	if (available_money > toLocalCurrency ($2500))
57846c3fef28SJerry Van Baren		Buy a BDI3000;
57856c3fef28SJerry Van Baren	else
5786c609719bSwdenk		Add a lot of aggravation and time;
5787c609719bSwdenk
57886c3fef28SJerry Van Baren	if (a similar board exists) {	/* hopefully... */
57896c3fef28SJerry Van Baren		cp -a board/<similar> board/<myboard>
57906c3fef28SJerry Van Baren		cp include/configs/<similar>.h include/configs/<myboard>.h
57916c3fef28SJerry Van Baren	} else {
5792c609719bSwdenk		Create your own board support subdirectory;
57936c3fef28SJerry Van Baren		Create your own board include/configs/<myboard>.h file;
57946c3fef28SJerry Van Baren	}
57956c3fef28SJerry Van Baren	Edit new board/<myboard> files
57966c3fef28SJerry Van Baren	Edit new include/configs/<myboard>.h
5797c609719bSwdenk
57986c3fef28SJerry Van Baren	while (!accepted) {
5799c609719bSwdenk		while (!running) {
5800c609719bSwdenk			do {
5801c609719bSwdenk				Add / modify source code;
5802c609719bSwdenk			} until (compiles);
5803c609719bSwdenk			Debug;
5804c609719bSwdenk			if (clueless)
5805c609719bSwdenk				email("Hi, I am having problems...");
5806c609719bSwdenk		}
58076c3fef28SJerry Van Baren		Send patch file to the U-Boot email list;
58086c3fef28SJerry Van Baren		if (reasonable critiques)
58096c3fef28SJerry Van Baren			Incorporate improvements from email list code review;
58106c3fef28SJerry Van Baren		else
58116c3fef28SJerry Van Baren			Defend code as written;
58126c3fef28SJerry Van Baren	}
5813c609719bSwdenk
5814c609719bSwdenk	return 0;
5815c609719bSwdenk}
5816c609719bSwdenk
5817c609719bSwdenkvoid no_more_time (int sig)
5818c609719bSwdenk{
5819c609719bSwdenk      hire_a_guru();
5820c609719bSwdenk}
5821c609719bSwdenk
5822c609719bSwdenk
5823c609719bSwdenkCoding Standards:
5824c609719bSwdenk-----------------
5825c609719bSwdenk
5826c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel
58272c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script
58287ca9296eSWolfgang Denk"scripts/Lindent" in your Linux kernel source directory.
5829c609719bSwdenk
58302c051651SDetlev ZundelSource files originating from a different project (for example the
58312c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not
58322c051651SDetlev Zundelreformated to ease subsequent migration to newer versions of those
58332c051651SDetlev Zundelsources.
58342c051651SDetlev Zundel
58352c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in
58362c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//)
58372c051651SDetlev Zundelin your code.
5838c609719bSwdenk
5839c178d3daSwdenkPlease also stick to the following formatting rules:
5840180d3f74Swdenk- remove any trailing white space
58417ca9296eSWolfgang Denk- use TAB characters for indentation and vertical alignment, not spaces
5842180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds
58437ca9296eSWolfgang Denk- do not add more than 2 consecutive empty lines to source files
5844180d3f74Swdenk- do not add trailing empty lines to source files
5845180d3f74Swdenk
5846c609719bSwdenkSubmissions which do not conform to the standards may be returned
5847c609719bSwdenkwith a request to reformat the changes.
5848c609719bSwdenk
5849c609719bSwdenk
5850c609719bSwdenkSubmitting Patches:
5851c609719bSwdenk-------------------
5852c609719bSwdenk
5853c609719bSwdenkSince the number of patches for U-Boot is growing, we need to
5854c609719bSwdenkestablish some rules. Submissions which do not conform to these rules
5855c609719bSwdenkmay be rejected, even when they contain important and valuable stuff.
5856c609719bSwdenk
58570d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details.
5858218ca724SWolfgang Denk
58590668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
58600668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot
58610668236bSWolfgang Denk
5862c609719bSwdenkWhen you send a patch, please include the following information with
5863c609719bSwdenkit:
5864c609719bSwdenk
5865c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes
5866c609719bSwdenk  this bug. Please try to include a way of demonstrating that the
5867c609719bSwdenk  patch actually fixes something.
5868c609719bSwdenk
5869c609719bSwdenk* For new features: a description of the feature and your
5870c609719bSwdenk  implementation.
5871c609719bSwdenk
5872c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch)
5873c609719bSwdenk
5874c609719bSwdenk* For major contributions, your entry to the CREDITS file
5875c609719bSwdenk
587627af930eSAlbert ARIBAUD* When you add support for a new board, don't forget to add a
587727af930eSAlbert ARIBAUD  maintainer e-mail address to the boards.cfg file, too.
5878c609719bSwdenk
5879c609719bSwdenk* If your patch adds new configuration options, don't forget to
5880c609719bSwdenk  document these in the README file.
5881c609719bSwdenk
5882218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly*
5883218ca724SWolfgang Denk  recommended) you can easily generate the patch using the
58847ca9296eSWolfgang Denk  "git format-patch". If you then use "git send-email" to send it to
5885218ca724SWolfgang Denk  the U-Boot mailing list, you will avoid most of the common problems
5886218ca724SWolfgang Denk  with some other mail clients.
5887c609719bSwdenk
5888218ca724SWolfgang Denk  If you cannot use git, use "diff -purN OLD NEW". If your version of
5889218ca724SWolfgang Denk  diff does not support these options, then get the latest version of
5890218ca724SWolfgang Denk  GNU diff.
58916dff5529Swdenk
5892218ca724SWolfgang Denk  The current directory when running this command shall be the parent
5893218ca724SWolfgang Denk  directory of the U-Boot source tree (i. e. please make sure that
5894218ca724SWolfgang Denk  your patch includes sufficient directory information for the
5895218ca724SWolfgang Denk  affected files).
5896218ca724SWolfgang Denk
5897218ca724SWolfgang Denk  We prefer patches as plain text. MIME attachments are discouraged,
5898218ca724SWolfgang Denk  and compressed attachments must not be used.
5899c609719bSwdenk
590052f52c14Swdenk* If one logical set of modifications affects or creates several
590152f52c14Swdenk  files, all these changes shall be submitted in a SINGLE patch file.
590252f52c14Swdenk
590352f52c14Swdenk* Changesets that contain different, unrelated modifications shall be
590452f52c14Swdenk  submitted as SEPARATE patches, one patch per changeset.
590552f52c14Swdenk
590652f52c14Swdenk
5907c609719bSwdenkNotes:
5908c609719bSwdenk
5909c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched
5910c609719bSwdenk  source tree and make sure that no errors or warnings are reported
5911c609719bSwdenk  for any of the boards.
5912c609719bSwdenk
5913c609719bSwdenk* Keep your modifications to the necessary minimum: A patch
5914c609719bSwdenk  containing several unrelated changes or arbitrary reformats will be
5915c609719bSwdenk  returned with a request to re-formatting / split it.
5916c609719bSwdenk
5917c609719bSwdenk* If you modify existing code, make sure that your new code does not
5918c609719bSwdenk  add to the memory footprint of the code ;-) Small is beautiful!
5919c609719bSwdenk  When adding new features, these should compile conditionally only
5920c609719bSwdenk  (using #ifdef), and the resulting code with the new feature
5921c609719bSwdenk  disabled must not need more memory than the old code without your
5922c609719bSwdenk  modification.
592390dc6704Swdenk
59240668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the
59250668236bSWolfgang Denk  u-boot mailing list. Bigger patches will be moderated. If they are
59260668236bSWolfgang Denk  reasonable and not too big, they will be acknowledged. But patches
59270668236bSWolfgang Denk  bigger than the size limit should be avoided.
5928