xref: /openbmc/u-boot/README (revision 5dec49ca2273bcf181071bc1c97a9901b155ebc1)
1c609719bSwdenk#
2cccfc2abSDetlev Zundel# (C) Copyright 2000 - 2009
3c609719bSwdenk# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4c609719bSwdenk#
5c609719bSwdenk# See file CREDITS for list of people who contributed to this
6c609719bSwdenk# project.
7c609719bSwdenk#
8c609719bSwdenk# This program is free software; you can redistribute it and/or
9c609719bSwdenk# modify it under the terms of the GNU General Public License as
10c609719bSwdenk# published by the Free Software Foundation; either version 2 of
11c609719bSwdenk# the License, or (at your option) any later version.
12c609719bSwdenk#
13c609719bSwdenk# This program is distributed in the hope that it will be useful,
14c609719bSwdenk# but WITHOUT ANY WARRANTY; without even the implied warranty of
15c609719bSwdenk# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	See the
16c609719bSwdenk# GNU General Public License for more details.
17c609719bSwdenk#
18c609719bSwdenk# You should have received a copy of the GNU General Public License
19c609719bSwdenk# along with this program; if not, write to the Free Software
20c609719bSwdenk# Foundation, Inc., 59 Temple Place, Suite 330, Boston,
21c609719bSwdenk# MA 02111-1307 USA
22c609719bSwdenk#
23c609719bSwdenk
24c609719bSwdenkSummary:
25c609719bSwdenk========
26c609719bSwdenk
2724ee89b9SwdenkThis directory contains the source code for U-Boot, a boot loader for
28e86e5a07SwdenkEmbedded boards based on PowerPC, ARM, MIPS and several other
29e86e5a07Swdenkprocessors, which can be installed in a boot ROM and used to
30e86e5a07Swdenkinitialize and test the hardware or to download and run application
31e86e5a07Swdenkcode.
32c609719bSwdenk
33c609719bSwdenkThe development of U-Boot is closely related to Linux: some parts of
3424ee89b9Swdenkthe source code originate in the Linux source tree, we have some
3524ee89b9Swdenkheader files in common, and special provision has been made to
36c609719bSwdenksupport booting of Linux images.
37c609719bSwdenk
38c609719bSwdenkSome attention has been paid to make this software easily
39c609719bSwdenkconfigurable and extendable. For instance, all monitor commands are
40c609719bSwdenkimplemented with the same call interface, so that it's very easy to
41c609719bSwdenkadd new commands. Also, instead of permanently adding rarely used
42c609719bSwdenkcode (for instance hardware test utilities) to the monitor, you can
43c609719bSwdenkload and run it dynamically.
44c609719bSwdenk
45c609719bSwdenk
46c609719bSwdenkStatus:
47c609719bSwdenk=======
48c609719bSwdenk
49c609719bSwdenkIn general, all boards for which a configuration option exists in the
50c609719bSwdenkMakefile have been tested to some extent and can be considered
51c609719bSwdenk"working". In fact, many of them are used in production systems.
52c609719bSwdenk
53c609719bSwdenkIn case of problems see the CHANGELOG and CREDITS files to find out
54218ca724SWolfgang Denkwho contributed the specific port. The MAINTAINERS file lists board
55218ca724SWolfgang Denkmaintainers.
56c609719bSwdenk
57c609719bSwdenk
58c609719bSwdenkWhere to get help:
59c609719bSwdenk==================
60c609719bSwdenk
61c609719bSwdenkIn case you have questions about, problems with or contributions for
62c609719bSwdenkU-Boot you should send a message to the U-Boot mailing list at
630c32565fSPeter Tyser<u-boot@lists.denx.de>. There is also an archive of previous traffic
640c32565fSPeter Tyseron the mailing list - please search the archive before asking FAQ's.
650c32565fSPeter TyserPlease see http://lists.denx.de/pipermail/u-boot and
660c32565fSPeter Tyserhttp://dir.gmane.org/gmane.comp.boot-loaders.u-boot
67c609719bSwdenk
68c609719bSwdenk
69218ca724SWolfgang DenkWhere to get source code:
70218ca724SWolfgang Denk=========================
71218ca724SWolfgang Denk
72218ca724SWolfgang DenkThe U-Boot source code is maintained in the git repository at
73218ca724SWolfgang Denkgit://www.denx.de/git/u-boot.git ; you can browse it online at
74218ca724SWolfgang Denkhttp://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
75218ca724SWolfgang Denk
76218ca724SWolfgang DenkThe "snapshot" links on this page allow you to download tarballs of
7711ccc33fSMarcel Ziswilerany version you might be interested in. Official releases are also
78218ca724SWolfgang Denkavailable for FTP download from the ftp://ftp.denx.de/pub/u-boot/
79218ca724SWolfgang Denkdirectory.
80218ca724SWolfgang Denk
81d4ee711dSAnatolij GustschinPre-built (and tested) images are available from
82218ca724SWolfgang Denkftp://ftp.denx.de/pub/u-boot/images/
83218ca724SWolfgang Denk
84218ca724SWolfgang Denk
85c609719bSwdenkWhere we come from:
86c609719bSwdenk===================
87c609719bSwdenk
88c609719bSwdenk- start from 8xxrom sources
8924ee89b9Swdenk- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
90c609719bSwdenk- clean up code
91c609719bSwdenk- make it easier to add custom boards
92c609719bSwdenk- make it possible to add other [PowerPC] CPUs
93c609719bSwdenk- extend functions, especially:
94c609719bSwdenk  * Provide extended interface to Linux boot loader
95c609719bSwdenk  * S-Record download
96c609719bSwdenk  * network boot
9711ccc33fSMarcel Ziswiler  * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
9824ee89b9Swdenk- create ARMBoot project (http://sourceforge.net/projects/armboot)
99c609719bSwdenk- add other CPU families (starting with ARM)
10024ee89b9Swdenk- create U-Boot project (http://sourceforge.net/projects/u-boot)
1010d28f34bSMagnus Lilja- current project page: see http://www.denx.de/wiki/U-Boot
10224ee89b9Swdenk
10324ee89b9Swdenk
10424ee89b9SwdenkNames and Spelling:
10524ee89b9Swdenk===================
10624ee89b9Swdenk
10724ee89b9SwdenkThe "official" name of this project is "Das U-Boot". The spelling
10824ee89b9Swdenk"U-Boot" shall be used in all written text (documentation, comments
10924ee89b9Swdenkin source files etc.). Example:
11024ee89b9Swdenk
11124ee89b9Swdenk	This is the README file for the U-Boot project.
11224ee89b9Swdenk
11324ee89b9SwdenkFile names etc. shall be based on the string "u-boot". Examples:
11424ee89b9Swdenk
11524ee89b9Swdenk	include/asm-ppc/u-boot.h
11624ee89b9Swdenk
11724ee89b9Swdenk	#include <asm/u-boot.h>
11824ee89b9Swdenk
11924ee89b9SwdenkVariable names, preprocessor constants etc. shall be either based on
12024ee89b9Swdenkthe string "u_boot" or on "U_BOOT". Example:
12124ee89b9Swdenk
12224ee89b9Swdenk	U_BOOT_VERSION		u_boot_logo
12324ee89b9Swdenk	IH_OS_U_BOOT		u_boot_hush_start
124c609719bSwdenk
125c609719bSwdenk
12693f19cc0SwdenkVersioning:
12793f19cc0Swdenk===========
12893f19cc0Swdenk
129360d883aSThomas WeberStarting with the release in October 2008, the names of the releases
130360d883aSThomas Weberwere changed from numerical release numbers without deeper meaning
131360d883aSThomas Weberinto a time stamp based numbering. Regular releases are identified by
132360d883aSThomas Webernames consisting of the calendar year and month of the release date.
133360d883aSThomas WeberAdditional fields (if present) indicate release candidates or bug fix
134360d883aSThomas Weberreleases in "stable" maintenance trees.
13593f19cc0Swdenk
136360d883aSThomas WeberExamples:
137360d883aSThomas Weber	U-Boot v2009.11     - Release November 2009
138360d883aSThomas Weber	U-Boot v2009.11.1   - Release 1 in version November 2009 stable tree
139360d883aSThomas Weber	U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release
14093f19cc0Swdenk
14193f19cc0Swdenk
142c609719bSwdenkDirectory Hierarchy:
143c609719bSwdenk====================
144c609719bSwdenk
1458d321b81SPeter Tyser/arch			Architecture specific files
1468d321b81SPeter Tyser  /arm			Files generic to ARM architecture
1478d321b81SPeter Tyser    /cpu		CPU specific files
1488d321b81SPeter Tyser      /arm720t		Files specific to ARM 720 CPUs
1498d321b81SPeter Tyser      /arm920t		Files specific to ARM 920 CPUs
1508d321b81SPeter Tyser	/at91rm9200	Files specific to Atmel AT91RM9200 CPU
1518d321b81SPeter Tyser	/imx		Files specific to Freescale MC9328 i.MX CPUs
1528d321b81SPeter Tyser	/s3c24x0	Files specific to Samsung S3C24X0 CPUs
1538d321b81SPeter Tyser      /arm925t		Files specific to ARM 925 CPUs
1548d321b81SPeter Tyser      /arm926ejs	Files specific to ARM 926 CPUs
1558d321b81SPeter Tyser      /arm1136		Files specific to ARM 1136 CPUs
1568d321b81SPeter Tyser      /ixp		Files specific to Intel XScale IXP CPUs
1578d321b81SPeter Tyser      /pxa		Files specific to Intel XScale PXA CPUs
1588d321b81SPeter Tyser      /s3c44b0		Files specific to Samsung S3C44B0 CPUs
1598d321b81SPeter Tyser      /sa1100		Files specific to Intel StrongARM SA1100 CPUs
1608d321b81SPeter Tyser    /lib		Architecture specific library files
1618d321b81SPeter Tyser  /avr32		Files generic to AVR32 architecture
1628d321b81SPeter Tyser    /cpu		CPU specific files
1638d321b81SPeter Tyser    /lib		Architecture specific library files
1648d321b81SPeter Tyser  /blackfin		Files generic to Analog Devices Blackfin architecture
1658d321b81SPeter Tyser    /cpu		CPU specific files
1668d321b81SPeter Tyser    /lib		Architecture specific library files
1678d321b81SPeter Tyser  /i386			Files generic to i386 architecture
1688d321b81SPeter Tyser    /cpu		CPU specific files
1698d321b81SPeter Tyser    /lib		Architecture specific library files
1708d321b81SPeter Tyser  /m68k			Files generic to m68k architecture
1718d321b81SPeter Tyser    /cpu		CPU specific files
1728d321b81SPeter Tyser      /mcf52x2		Files specific to Freescale ColdFire MCF52x2 CPUs
1738d321b81SPeter Tyser      /mcf5227x		Files specific to Freescale ColdFire MCF5227x CPUs
1748d321b81SPeter Tyser      /mcf532x		Files specific to Freescale ColdFire MCF5329 CPUs
1758d321b81SPeter Tyser      /mcf5445x		Files specific to Freescale ColdFire MCF5445x CPUs
1768d321b81SPeter Tyser      /mcf547x_8x	Files specific to Freescale ColdFire MCF547x_8x CPUs
1778d321b81SPeter Tyser    /lib		Architecture specific library files
1788d321b81SPeter Tyser  /microblaze		Files generic to microblaze architecture
1798d321b81SPeter Tyser    /cpu		CPU specific files
1808d321b81SPeter Tyser    /lib		Architecture specific library files
1818d321b81SPeter Tyser  /mips			Files generic to MIPS architecture
1828d321b81SPeter Tyser    /cpu		CPU specific files
1838d321b81SPeter Tyser    /lib		Architecture specific library files
1848d321b81SPeter Tyser  /nios2		Files generic to Altera NIOS2 architecture
1858d321b81SPeter Tyser    /cpu		CPU specific files
1868d321b81SPeter Tyser    /lib		Architecture specific library files
187a47a12beSStefan Roese  /powerpc		Files generic to PowerPC architecture
1888d321b81SPeter Tyser    /cpu		CPU specific files
1898d321b81SPeter Tyser      /74xx_7xx		Files specific to Freescale MPC74xx and 7xx CPUs
1908d321b81SPeter Tyser      /mpc5xx		Files specific to Freescale MPC5xx CPUs
1918d321b81SPeter Tyser      /mpc5xxx		Files specific to Freescale MPC5xxx CPUs
1928d321b81SPeter Tyser      /mpc8xx		Files specific to Freescale MPC8xx CPUs
1938d321b81SPeter Tyser      /mpc8220		Files specific to Freescale MPC8220 CPUs
1948d321b81SPeter Tyser      /mpc824x		Files specific to Freescale MPC824x CPUs
1958d321b81SPeter Tyser      /mpc8260		Files specific to Freescale MPC8260 CPUs
1968d321b81SPeter Tyser      /mpc85xx		Files specific to Freescale MPC85xx CPUs
1978d321b81SPeter Tyser      /ppc4xx		Files specific to AMCC PowerPC 4xx CPUs
1988d321b81SPeter Tyser    /lib		Architecture specific library files
1998d321b81SPeter Tyser  /sh			Files generic to SH architecture
2008d321b81SPeter Tyser    /cpu		CPU specific files
2018d321b81SPeter Tyser      /sh2		Files specific to sh2 CPUs
2028d321b81SPeter Tyser      /sh3		Files specific to sh3 CPUs
2038d321b81SPeter Tyser      /sh4		Files specific to sh4 CPUs
2048d321b81SPeter Tyser    /lib		Architecture specific library files
2058d321b81SPeter Tyser  /sparc		Files generic to SPARC architecture
2068d321b81SPeter Tyser    /cpu		CPU specific files
2078d321b81SPeter Tyser      /leon2		Files specific to Gaisler LEON2 SPARC CPU
2088d321b81SPeter Tyser      /leon3		Files specific to Gaisler LEON3 SPARC CPU
2098d321b81SPeter Tyser    /lib		Architecture specific library files
2108d321b81SPeter Tyser/api			Machine/arch independent API for external apps
2118d321b81SPeter Tyser/board			Board dependent files
2128d321b81SPeter Tyser/common			Misc architecture independent functions
2138d321b81SPeter Tyser/disk			Code for disk drive partition handling
2148d321b81SPeter Tyser/doc			Documentation (don't expect too much)
2158d321b81SPeter Tyser/drivers		Commonly used device drivers
2168d321b81SPeter Tyser/examples		Example code for standalone applications, etc.
2178d321b81SPeter Tyser/fs			Filesystem code (cramfs, ext2, jffs2, etc.)
2188d321b81SPeter Tyser/include		Header Files
2198d321b81SPeter Tyser/lib			Files generic to all architectures
2208d321b81SPeter Tyser  /libfdt		Library files to support flattened device trees
2218d321b81SPeter Tyser  /lzma			Library files to support LZMA decompression
2228d321b81SPeter Tyser  /lzo			Library files to support LZO decompression
2238d321b81SPeter Tyser/net			Networking code
2248d321b81SPeter Tyser/post			Power On Self Test
2258d321b81SPeter Tyser/rtc			Real Time Clock drivers
2268d321b81SPeter Tyser/tools			Tools to build S-Record or U-Boot images, etc.
227c609719bSwdenk
228c609719bSwdenkSoftware Configuration:
229c609719bSwdenk=======================
230c609719bSwdenk
231c609719bSwdenkConfiguration is usually done using C preprocessor defines; the
232c609719bSwdenkrationale behind that is to avoid dead code whenever possible.
233c609719bSwdenk
234c609719bSwdenkThere are two classes of configuration variables:
235c609719bSwdenk
236c609719bSwdenk* Configuration _OPTIONS_:
237c609719bSwdenk  These are selectable by the user and have names beginning with
238c609719bSwdenk  "CONFIG_".
239c609719bSwdenk
240c609719bSwdenk* Configuration _SETTINGS_:
241c609719bSwdenk  These depend on the hardware etc. and should not be meddled with if
242c609719bSwdenk  you don't know what you're doing; they have names beginning with
2436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  "CONFIG_SYS_".
244c609719bSwdenk
245c609719bSwdenkLater we will add a configuration tool - probably similar to or even
246c609719bSwdenkidentical to what's used for the Linux kernel. Right now, we have to
247c609719bSwdenkdo the configuration by hand, which means creating some symbolic
248c609719bSwdenklinks and editing some configuration files. We use the TQM8xxL boards
249c609719bSwdenkas an example here.
250c609719bSwdenk
251c609719bSwdenk
252c609719bSwdenkSelection of Processor Architecture and Board Type:
253c609719bSwdenk---------------------------------------------------
254c609719bSwdenk
255c609719bSwdenkFor all supported boards there are ready-to-use default
256c609719bSwdenkconfigurations available; just type "make <board_name>_config".
257c609719bSwdenk
258c609719bSwdenkExample: For a TQM823L module type:
259c609719bSwdenk
260c609719bSwdenk	cd u-boot
261c609719bSwdenk	make TQM823L_config
262c609719bSwdenk
26311ccc33fSMarcel ZiswilerFor the Cogent platform, you need to specify the CPU type as well;
264c609719bSwdenke.g. "make cogent_mpc8xx_config". And also configure the cogent
265c609719bSwdenkdirectory according to the instructions in cogent/README.
266c609719bSwdenk
267c609719bSwdenk
268c609719bSwdenkConfiguration Options:
269c609719bSwdenk----------------------
270c609719bSwdenk
271c609719bSwdenkConfiguration depends on the combination of board and CPU type; all
272c609719bSwdenksuch information is kept in a configuration file
273c609719bSwdenk"include/configs/<board_name>.h".
274c609719bSwdenk
275c609719bSwdenkExample: For a TQM823L module, all configuration settings are in
276c609719bSwdenk"include/configs/TQM823L.h".
277c609719bSwdenk
278c609719bSwdenk
2797f6c2cbcSwdenkMany of the options are named exactly as the corresponding Linux
2807f6c2cbcSwdenkkernel configuration options. The intention is to make it easier to
2817f6c2cbcSwdenkbuild a config tool - later.
2827f6c2cbcSwdenk
2837f6c2cbcSwdenk
284c609719bSwdenkThe following options need to be configured:
285c609719bSwdenk
2862628114eSKim Phillips- CPU Type:	Define exactly one, e.g. CONFIG_MPC85XX.
287c609719bSwdenk
2882628114eSKim Phillips- Board Type:	Define exactly one, e.g. CONFIG_MPC8540ADS.
2896ccec449SWolfgang Denk
2906ccec449SWolfgang Denk- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
29109ea0de0SHaavard Skinnemoen		Define exactly one, e.g. CONFIG_ATSTK1002
292c609719bSwdenk
293c609719bSwdenk- CPU Module Type: (if CONFIG_COGENT is defined)
294c609719bSwdenk		Define exactly one of
295c609719bSwdenk		CONFIG_CMA286_60_OLD
296c609719bSwdenk--- FIXME --- not tested yet:
297c609719bSwdenk		CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
298c609719bSwdenk		CONFIG_CMA287_23, CONFIG_CMA287_50
299c609719bSwdenk
300c609719bSwdenk- Motherboard Type: (if CONFIG_COGENT is defined)
301c609719bSwdenk		Define exactly one of
302c609719bSwdenk		CONFIG_CMA101, CONFIG_CMA102
303c609719bSwdenk
304c609719bSwdenk- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
305c609719bSwdenk		Define one or more of
306c609719bSwdenk		CONFIG_CMA302
307c609719bSwdenk
308c609719bSwdenk- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
309c609719bSwdenk		Define one or more of
310c609719bSwdenk		CONFIG_LCD_HEARTBEAT	- update a character position on
31111ccc33fSMarcel Ziswiler					  the LCD display every second with
312c609719bSwdenk					  a "rotator" |\-/|\-/
313c609719bSwdenk
3142535d602Swdenk- Board flavour: (if CONFIG_MPC8260ADS is defined)
3152535d602Swdenk		CONFIG_ADSTYPE
3162535d602Swdenk		Possible values are:
3176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8260ADS	- original MPC8260ADS
3186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8266ADS	- MPC8266ADS
3196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_PQ2FADS	- PQ2FADS-ZU or PQ2FADS-VR
3206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8272ADS	- MPC8272ADS
3212535d602Swdenk
322c609719bSwdenk- MPC824X Family Member (if CONFIG_MPC824X is defined)
323c609719bSwdenk		Define exactly one of
324c609719bSwdenk		CONFIG_MPC8240, CONFIG_MPC8245
325c609719bSwdenk
32611ccc33fSMarcel Ziswiler- 8xx CPU Options: (if using an MPC8xx CPU)
32766ca92a5Swdenk		CONFIG_8xx_GCLK_FREQ	- deprecated: CPU clock if
32866ca92a5Swdenk					  get_gclk_freq() cannot work
3295da627a4Swdenk					  e.g. if there is no 32KHz
3305da627a4Swdenk					  reference PIT/RTC clock
33166ca92a5Swdenk		CONFIG_8xx_OSCLK	- PLL input clock (either EXTCLK
33266ca92a5Swdenk					  or XTAL/EXTAL)
333c609719bSwdenk
33466ca92a5Swdenk- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
3356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MIN
3366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MAX
33766ca92a5Swdenk		CONFIG_8xx_CPUCLK_DEFAULT
33875d1ea7fSwdenk			See doc/README.MPC866
33975d1ea7fSwdenk
3406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MEASURE_CPUCLK
34175d1ea7fSwdenk
34275d1ea7fSwdenk		Define this to measure the actual CPU clock instead
34375d1ea7fSwdenk		of relying on the correctness of the configured
34475d1ea7fSwdenk		values. Mostly useful for board bringup to make sure
34575d1ea7fSwdenk		the PLL is locked at the intended frequency. Note
34675d1ea7fSwdenk		that this requires a (stable) reference clock (32 kHz
3476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		RTC clock or CONFIG_SYS_8XX_XIN)
34875d1ea7fSwdenk
349506f3918SHeiko Schocher		CONFIG_SYS_DELAYED_ICACHE
350506f3918SHeiko Schocher
351506f3918SHeiko Schocher		Define this option if you want to enable the
352506f3918SHeiko Schocher		ICache only when Code runs from RAM.
353506f3918SHeiko Schocher
3540b953ffcSMarkus Klotzbuecher- Intel Monahans options:
3556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
3560b953ffcSMarkus Klotzbuecher
3570b953ffcSMarkus Klotzbuecher		Defines the Monahans run mode to oscillator
3580b953ffcSMarkus Klotzbuecher		ratio. Valid values are 8, 16, 24, 31. The core
3590b953ffcSMarkus Klotzbuecher		frequency is this value multiplied by 13 MHz.
3600b953ffcSMarkus Klotzbuecher
3616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
3620b953ffcSMarkus Klotzbuecher
3630b953ffcSMarkus Klotzbuecher		Defines the Monahans turbo mode to oscillator
3640b953ffcSMarkus Klotzbuecher		ratio. Valid values are 1 (default if undefined) and
3650b953ffcSMarkus Klotzbuecher		2. The core frequency as calculated above is multiplied
3660b953ffcSMarkus Klotzbuecher		by this value.
3670b953ffcSMarkus Klotzbuecher
3685da627a4Swdenk- Linux Kernel Interface:
369c609719bSwdenk		CONFIG_CLOCKS_IN_MHZ
370c609719bSwdenk
371c609719bSwdenk		U-Boot stores all clock information in Hz
372c609719bSwdenk		internally. For binary compatibility with older Linux
373c609719bSwdenk		kernels (which expect the clocks passed in the
374c609719bSwdenk		bd_info data to be in MHz) the environment variable
375c609719bSwdenk		"clocks_in_mhz" can be defined so that U-Boot
376c609719bSwdenk		converts clock data to MHZ before passing it to the
377c609719bSwdenk		Linux kernel.
378c609719bSwdenk		When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
379c609719bSwdenk		"clocks_in_mhz=1" is automatically included in the
380c609719bSwdenk		default environment.
381c609719bSwdenk
3825da627a4Swdenk		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]
3835da627a4Swdenk
38411ccc33fSMarcel Ziswiler		When transferring memsize parameter to linux, some versions
3855da627a4Swdenk		expect it to be in bytes, others in MB.
3865da627a4Swdenk		Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
3875da627a4Swdenk
388fec6d9eeSGerald Van Baren		CONFIG_OF_LIBFDT
389f57f70aaSWolfgang Denk
390f57f70aaSWolfgang Denk		New kernel versions are expecting firmware settings to be
391213bf8c8SGerald Van Baren		passed using flattened device trees (based on open firmware
392213bf8c8SGerald Van Baren		concepts).
393213bf8c8SGerald Van Baren
394213bf8c8SGerald Van Baren		CONFIG_OF_LIBFDT
395213bf8c8SGerald Van Baren		 * New libfdt-based support
396213bf8c8SGerald Van Baren		 * Adds the "fdt" command
3973bb342fcSKim Phillips		 * The bootm command automatically updates the fdt
398213bf8c8SGerald Van Baren
399b55ae402SMarcel Ziswiler		OF_CPU - The proper name of the cpus node (only required for
400b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
401b55ae402SMarcel Ziswiler		OF_SOC - The proper name of the soc node (only required for
402b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
403f57f70aaSWolfgang Denk		OF_TBCLK - The timebase frequency.
404c2871f03SKumar Gala		OF_STDOUT_PATH - The path to the console device
405f57f70aaSWolfgang Denk
40611ccc33fSMarcel Ziswiler		boards with QUICC Engines require OF_QE to set UCC MAC
40711ccc33fSMarcel Ziswiler		addresses
4083bb342fcSKim Phillips
4094e253137SKumar Gala		CONFIG_OF_BOARD_SETUP
4104e253137SKumar Gala
4114e253137SKumar Gala		Board code has addition modification that it wants to make
4124e253137SKumar Gala		to the flat device tree before handing it off to the kernel
4136705d81eSwdenk
4140267768eSMatthew McClintock		CONFIG_OF_BOOT_CPU
4150267768eSMatthew McClintock
41611ccc33fSMarcel Ziswiler		This define fills in the correct boot CPU in the boot
4170267768eSMatthew McClintock		param header, the default value is zero if undefined.
4180267768eSMatthew McClintock
4193887c3fbSHeiko Schocher		CONFIG_OF_IDE_FIXUP
4203887c3fbSHeiko Schocher
4213887c3fbSHeiko Schocher		U-Boot can detect if an IDE device is present or not.
4223887c3fbSHeiko Schocher		If not, and this new config option is activated, U-Boot
4233887c3fbSHeiko Schocher		removes the ATA node from the DTS before booting Linux,
4243887c3fbSHeiko Schocher		so the Linux IDE driver does not probe the device and
4253887c3fbSHeiko Schocher		crash. This is needed for buggy hardware (uc101) where
4263887c3fbSHeiko Schocher		no pull down resistor is connected to the signal IDE5V_DD7.
4273887c3fbSHeiko Schocher
4280b2f4ecaSNiklaus Giger- vxWorks boot parameters:
4290b2f4ecaSNiklaus Giger
4300b2f4ecaSNiklaus Giger		bootvx constructs a valid bootline using the following
4310b2f4ecaSNiklaus Giger		environments variables: bootfile, ipaddr, serverip, hostname.
4320b2f4ecaSNiklaus Giger		It loads the vxWorks image pointed bootfile.
4330b2f4ecaSNiklaus Giger
4340b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
4350b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
4360b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
4370b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
4380b2f4ecaSNiklaus Giger
4390b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_ADD_PARAMS
4400b2f4ecaSNiklaus Giger
4410b2f4ecaSNiklaus Giger		Add it at the end of the bootline. E.g "u=username pw=secret"
4420b2f4ecaSNiklaus Giger
4430b2f4ecaSNiklaus Giger		Note: If a "bootargs" environment is defined, it will overwride
4440b2f4ecaSNiklaus Giger		the defaults discussed just above.
4450b2f4ecaSNiklaus Giger
4466705d81eSwdenk- Serial Ports:
44748d0192fSAndreas Engel		CONFIG_PL010_SERIAL
4486705d81eSwdenk
4496705d81eSwdenk		Define this if you want support for Amba PrimeCell PL010 UARTs.
4506705d81eSwdenk
45148d0192fSAndreas Engel		CONFIG_PL011_SERIAL
4526705d81eSwdenk
4536705d81eSwdenk		Define this if you want support for Amba PrimeCell PL011 UARTs.
4546705d81eSwdenk
4556705d81eSwdenk		CONFIG_PL011_CLOCK
4566705d81eSwdenk
4576705d81eSwdenk		If you have Amba PrimeCell PL011 UARTs, set this variable to
4586705d81eSwdenk		the clock speed of the UARTs.
4596705d81eSwdenk
4606705d81eSwdenk		CONFIG_PL01x_PORTS
4616705d81eSwdenk
4626705d81eSwdenk		If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
4636705d81eSwdenk		define this to a list of base addresses for each (supported)
4646705d81eSwdenk		port. See e.g. include/configs/versatile.h
4656705d81eSwdenk
4666705d81eSwdenk
467c609719bSwdenk- Console Interface:
468c609719bSwdenk		Depending on board, define exactly one serial port
469c609719bSwdenk		(like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
470c609719bSwdenk		CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
471c609719bSwdenk		console by defining CONFIG_8xx_CONS_NONE
472c609719bSwdenk
473c609719bSwdenk		Note: if CONFIG_8xx_CONS_NONE is defined, the serial
474c609719bSwdenk		port routines must be defined elsewhere
475c609719bSwdenk		(i.e. serial_init(), serial_getc(), ...)
476c609719bSwdenk
477c609719bSwdenk		CONFIG_CFB_CONSOLE
478c609719bSwdenk		Enables console device for a color framebuffer. Needs following
479c609719bSwdenk		defines (cf. smiLynxEM, i8042, board/eltec/bab7xx)
480c609719bSwdenk			VIDEO_FB_LITTLE_ENDIAN	graphic memory organisation
481c609719bSwdenk						(default big endian)
482c609719bSwdenk			VIDEO_HW_RECTFILL	graphic chip supports
483c609719bSwdenk						rectangle fill
484c609719bSwdenk						(cf. smiLynxEM)
485c609719bSwdenk			VIDEO_HW_BITBLT		graphic chip supports
486c609719bSwdenk						bit-blit (cf. smiLynxEM)
487c609719bSwdenk			VIDEO_VISIBLE_COLS	visible pixel columns
488c609719bSwdenk						(cols=pitch)
489c609719bSwdenk			VIDEO_VISIBLE_ROWS	visible pixel rows
490c609719bSwdenk			VIDEO_PIXEL_SIZE	bytes per pixel
491c609719bSwdenk			VIDEO_DATA_FORMAT	graphic data format
492c609719bSwdenk						(0-5, cf. cfb_console.c)
493c609719bSwdenk			VIDEO_FB_ADRS		framebuffer address
494c609719bSwdenk			VIDEO_KBD_INIT_FCT	keyboard int fct
495c609719bSwdenk						(i.e. i8042_kbd_init())
496c609719bSwdenk			VIDEO_TSTC_FCT		test char fct
497c609719bSwdenk						(i.e. i8042_tstc)
498c609719bSwdenk			VIDEO_GETC_FCT		get char fct
499c609719bSwdenk						(i.e. i8042_getc)
500c609719bSwdenk			CONFIG_CONSOLE_CURSOR	cursor drawing on/off
501c609719bSwdenk						(requires blink timer
502c609719bSwdenk						cf. i8042.c)
5036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
504c609719bSwdenk			CONFIG_CONSOLE_TIME	display time/date info in
505c609719bSwdenk						upper right corner
506602ad3b3SJon Loeliger						(requires CONFIG_CMD_DATE)
507c609719bSwdenk			CONFIG_VIDEO_LOGO	display Linux logo in
508c609719bSwdenk						upper left corner
509a6c7ad2fSwdenk			CONFIG_VIDEO_BMP_LOGO	use bmp_logo.h instead of
510a6c7ad2fSwdenk						linux_logo.h for logo.
511a6c7ad2fSwdenk						Requires CONFIG_VIDEO_LOGO
512c609719bSwdenk			CONFIG_CONSOLE_EXTRA_INFO
51311ccc33fSMarcel Ziswiler						additional board info beside
514c609719bSwdenk						the logo
515c609719bSwdenk
516c609719bSwdenk		When CONFIG_CFB_CONSOLE is defined, video console is
517c609719bSwdenk		default i/o. Serial console can be forced with
518c609719bSwdenk		environment 'console=serial'.
519c609719bSwdenk
520a3ad8e26Swdenk		When CONFIG_SILENT_CONSOLE is defined, all console
521a3ad8e26Swdenk		messages (by U-Boot and Linux!) can be silenced with
522a3ad8e26Swdenk		the "silent" environment variable. See
523a3ad8e26Swdenk		doc/README.silent for more information.
524a3ad8e26Swdenk
525c609719bSwdenk- Console Baudrate:
526c609719bSwdenk		CONFIG_BAUDRATE - in bps
527c609719bSwdenk		Select one of the baudrates listed in
5286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
5296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
530c609719bSwdenk
531c92fac91SHeiko Schocher- Console Rx buffer length
532c92fac91SHeiko Schocher		With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
533c92fac91SHeiko Schocher		the maximum receive buffer length for the SMC.
5342b3f12c2SHeiko Schocher		This option is actual only for 82xx and 8xx possible.
535c92fac91SHeiko Schocher		If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
536c92fac91SHeiko Schocher		must be defined, to setup the maximum idle timeout for
537c92fac91SHeiko Schocher		the SMC.
538c92fac91SHeiko Schocher
539c609719bSwdenk- Boot Delay:	CONFIG_BOOTDELAY - in seconds
540c609719bSwdenk		Delay before automatically booting the default image;
541c609719bSwdenk		set to -1 to disable autoboot.
542c609719bSwdenk
543c609719bSwdenk		See doc/README.autoboot for these options that
544c609719bSwdenk		work with CONFIG_BOOTDELAY. None are required.
545c609719bSwdenk		CONFIG_BOOT_RETRY_TIME
546c609719bSwdenk		CONFIG_BOOT_RETRY_MIN
547c609719bSwdenk		CONFIG_AUTOBOOT_KEYED
548c609719bSwdenk		CONFIG_AUTOBOOT_PROMPT
549c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR
550c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR
551c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR2
552c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR2
553c609719bSwdenk		CONFIG_ZERO_BOOTDELAY_CHECK
554c609719bSwdenk		CONFIG_RESET_TO_RETRY
555c609719bSwdenk
556c609719bSwdenk- Autoboot Command:
557c609719bSwdenk		CONFIG_BOOTCOMMAND
558c609719bSwdenk		Only needed when CONFIG_BOOTDELAY is enabled;
559c609719bSwdenk		define a command string that is automatically executed
560c609719bSwdenk		when no character is read on the console interface
561c609719bSwdenk		within "Boot Delay" after reset.
562c609719bSwdenk
563c609719bSwdenk		CONFIG_BOOTARGS
564c609719bSwdenk		This can be used to pass arguments to the bootm
565c609719bSwdenk		command. The value of CONFIG_BOOTARGS goes into the
566c609719bSwdenk		environment value "bootargs".
567c609719bSwdenk
568c609719bSwdenk		CONFIG_RAMBOOT and CONFIG_NFSBOOT
569c609719bSwdenk		The value of these goes into the environment as
570c609719bSwdenk		"ramboot" and "nfsboot" respectively, and can be used
571c609719bSwdenk		as a convenience, when switching between booting from
57211ccc33fSMarcel Ziswiler		RAM and NFS.
573c609719bSwdenk
574c609719bSwdenk- Pre-Boot Commands:
575c609719bSwdenk		CONFIG_PREBOOT
576c609719bSwdenk
577c609719bSwdenk		When this option is #defined, the existence of the
578c609719bSwdenk		environment variable "preboot" will be checked
579c609719bSwdenk		immediately before starting the CONFIG_BOOTDELAY
580c609719bSwdenk		countdown and/or running the auto-boot command resp.
581c609719bSwdenk		entering interactive mode.
582c609719bSwdenk
583c609719bSwdenk		This feature is especially useful when "preboot" is
584c609719bSwdenk		automatically generated or modified. For an example
585c609719bSwdenk		see the LWMON board specific code: here "preboot" is
586c609719bSwdenk		modified when the user holds down a certain
587c609719bSwdenk		combination of keys on the (special) keyboard when
588c609719bSwdenk		booting the systems
589c609719bSwdenk
590c609719bSwdenk- Serial Download Echo Mode:
591c609719bSwdenk		CONFIG_LOADS_ECHO
592c609719bSwdenk		If defined to 1, all characters received during a
593c609719bSwdenk		serial download (using the "loads" command) are
594c609719bSwdenk		echoed back. This might be needed by some terminal
595c609719bSwdenk		emulations (like "cu"), but may as well just take
596c609719bSwdenk		time on others. This setting #define's the initial
597c609719bSwdenk		value of the "loads_echo" environment variable.
598c609719bSwdenk
599602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
600c609719bSwdenk		CONFIG_KGDB_BAUDRATE
601c609719bSwdenk		Select one of the baudrates listed in
6026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
603c609719bSwdenk
604c609719bSwdenk- Monitor Functions:
605602ad3b3SJon Loeliger		Monitor commands can be included or excluded
606602ad3b3SJon Loeliger		from the build by using the #include files
607602ad3b3SJon Loeliger		"config_cmd_all.h" and #undef'ing unwanted
608602ad3b3SJon Loeliger		commands, or using "config_cmd_default.h"
609602ad3b3SJon Loeliger		and augmenting with additional #define's
610602ad3b3SJon Loeliger		for wanted commands.
611c609719bSwdenk
612602ad3b3SJon Loeliger		The default command configuration includes all commands
613602ad3b3SJon Loeliger		except those marked below with a "*".
614602ad3b3SJon Loeliger
615602ad3b3SJon Loeliger		CONFIG_CMD_ASKENV	* ask for env variable
616602ad3b3SJon Loeliger		CONFIG_CMD_BDI		  bdinfo
617602ad3b3SJon Loeliger		CONFIG_CMD_BEDBUG	* Include BedBug Debugger
618602ad3b3SJon Loeliger		CONFIG_CMD_BMP		* BMP support
619602ad3b3SJon Loeliger		CONFIG_CMD_BSP		* Board specific commands
620602ad3b3SJon Loeliger		CONFIG_CMD_BOOTD	  bootd
621602ad3b3SJon Loeliger		CONFIG_CMD_CACHE	* icache, dcache
622602ad3b3SJon Loeliger		CONFIG_CMD_CONSOLE	  coninfo
623602ad3b3SJon Loeliger		CONFIG_CMD_DATE		* support for RTC, date/time...
624602ad3b3SJon Loeliger		CONFIG_CMD_DHCP		* DHCP support
625602ad3b3SJon Loeliger		CONFIG_CMD_DIAG		* Diagnostics
626a7c93104SPeter Tyser		CONFIG_CMD_DS4510	* ds4510 I2C gpio commands
627a7c93104SPeter Tyser		CONFIG_CMD_DS4510_INFO	* ds4510 I2C info command
628a7c93104SPeter Tyser		CONFIG_CMD_DS4510_MEM	* ds4510 I2C eeprom/sram commansd
629a7c93104SPeter Tyser		CONFIG_CMD_DS4510_RST	* ds4510 I2C rst command
630602ad3b3SJon Loeliger		CONFIG_CMD_DTT		* Digital Therm and Thermostat
631602ad3b3SJon Loeliger		CONFIG_CMD_ECHO		  echo arguments
632246c6922SPeter Tyser		CONFIG_CMD_EDITENV	  edit env variable
633602ad3b3SJon Loeliger		CONFIG_CMD_EEPROM	* EEPROM read/write support
634602ad3b3SJon Loeliger		CONFIG_CMD_ELF		* bootelf, bootvx
635bdab39d3SMike Frysinger		CONFIG_CMD_SAVEENV	  saveenv
636602ad3b3SJon Loeliger		CONFIG_CMD_FDC		* Floppy Disk Support
637602ad3b3SJon Loeliger		CONFIG_CMD_FAT		* FAT partition support
638602ad3b3SJon Loeliger		CONFIG_CMD_FDOS		* Dos diskette Support
639602ad3b3SJon Loeliger		CONFIG_CMD_FLASH	  flinfo, erase, protect
640602ad3b3SJon Loeliger		CONFIG_CMD_FPGA		  FPGA device initialization support
641602ad3b3SJon Loeliger		CONFIG_CMD_HWFLOW	* RTS/CTS hw flow control
642602ad3b3SJon Loeliger		CONFIG_CMD_I2C		* I2C serial bus support
643602ad3b3SJon Loeliger		CONFIG_CMD_IDE		* IDE harddisk support
644602ad3b3SJon Loeliger		CONFIG_CMD_IMI		  iminfo
645602ad3b3SJon Loeliger		CONFIG_CMD_IMLS		  List all found images
646602ad3b3SJon Loeliger		CONFIG_CMD_IMMAP	* IMMR dump support
647602ad3b3SJon Loeliger		CONFIG_CMD_IRQ		* irqinfo
648602ad3b3SJon Loeliger		CONFIG_CMD_ITEST	  Integer/string test of 2 values
649602ad3b3SJon Loeliger		CONFIG_CMD_JFFS2	* JFFS2 Support
650602ad3b3SJon Loeliger		CONFIG_CMD_KGDB		* kgdb
651602ad3b3SJon Loeliger		CONFIG_CMD_LOADB	  loadb
652602ad3b3SJon Loeliger		CONFIG_CMD_LOADS	  loads
65302c9aa1dSRobin Getz		CONFIG_CMD_MD5SUM	  print md5 message digest
65402c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
655602ad3b3SJon Loeliger		CONFIG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
65656523f12Swdenk					  loop, loopw, mtest
657602ad3b3SJon Loeliger		CONFIG_CMD_MISC		  Misc functions like sleep etc
658602ad3b3SJon Loeliger		CONFIG_CMD_MMC		* MMC memory mapped support
659602ad3b3SJon Loeliger		CONFIG_CMD_MII		* MII utility commands
66068d7d651SStefan Roese		CONFIG_CMD_MTDPARTS	* MTD partition support
661602ad3b3SJon Loeliger		CONFIG_CMD_NAND		* NAND support
662602ad3b3SJon Loeliger		CONFIG_CMD_NET		  bootp, tftpboot, rarpboot
663e92739d3SPeter Tyser		CONFIG_CMD_PCA953X	* PCA953x I2C gpio commands
664e92739d3SPeter Tyser		CONFIG_CMD_PCA953X_INFO	* PCA953x I2C gpio info command
665602ad3b3SJon Loeliger		CONFIG_CMD_PCI		* pciinfo
666602ad3b3SJon Loeliger		CONFIG_CMD_PCMCIA		* PCMCIA support
667602ad3b3SJon Loeliger		CONFIG_CMD_PING		* send ICMP ECHO_REQUEST to network
668602ad3b3SJon Loeliger					  host
669602ad3b3SJon Loeliger		CONFIG_CMD_PORTIO	* Port I/O
670602ad3b3SJon Loeliger		CONFIG_CMD_REGINFO	* Register dump
671602ad3b3SJon Loeliger		CONFIG_CMD_RUN		  run command in env variable
672602ad3b3SJon Loeliger		CONFIG_CMD_SAVES	* save S record dump
673602ad3b3SJon Loeliger		CONFIG_CMD_SCSI		* SCSI Support
674602ad3b3SJon Loeliger		CONFIG_CMD_SDRAM	* print SDRAM configuration information
675602ad3b3SJon Loeliger					  (requires CONFIG_CMD_I2C)
676602ad3b3SJon Loeliger		CONFIG_CMD_SETGETDCR	  Support for DCR Register access
677602ad3b3SJon Loeliger					  (4xx only)
67802c9aa1dSRobin Getz		CONFIG_CMD_SHA1		  print sha1 memory digest
67902c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY)
68074de7aefSWolfgang Denk		CONFIG_CMD_SOURCE	  "source" command Support
681602ad3b3SJon Loeliger		CONFIG_CMD_SPI		* SPI serial bus support
682602ad3b3SJon Loeliger		CONFIG_CMD_USB		* USB support
683602ad3b3SJon Loeliger		CONFIG_CMD_VFD		* VFD support (TRAB)
684602ad3b3SJon Loeliger		CONFIG_CMD_CDP		* Cisco Discover Protocol support
685602ad3b3SJon Loeliger		CONFIG_CMD_FSL		* Microblaze FSL support
686c609719bSwdenk
687c609719bSwdenk
688c609719bSwdenk		EXAMPLE: If you want all functions except of network
689c609719bSwdenk		support you can write:
690c609719bSwdenk
691602ad3b3SJon Loeliger		#include "config_cmd_all.h"
692602ad3b3SJon Loeliger		#undef CONFIG_CMD_NET
693c609719bSwdenk
694213bf8c8SGerald Van Baren	Other Commands:
695213bf8c8SGerald Van Baren		fdt (flattened device tree) command: CONFIG_OF_LIBFDT
696c609719bSwdenk
697c609719bSwdenk	Note:	Don't enable the "icache" and "dcache" commands
698602ad3b3SJon Loeliger		(configuration option CONFIG_CMD_CACHE) unless you know
699c609719bSwdenk		what you (and your U-Boot users) are doing. Data
700c609719bSwdenk		cache cannot be enabled on systems like the 8xx or
701c609719bSwdenk		8260 (where accesses to the IMMR region must be
702c609719bSwdenk		uncached), and it cannot be disabled on all other
703c609719bSwdenk		systems where we (mis-) use the data cache to hold an
704c609719bSwdenk		initial stack and some data.
705c609719bSwdenk
706c609719bSwdenk
707c609719bSwdenk		XXX - this list needs to get updated!
708c609719bSwdenk
709c609719bSwdenk- Watchdog:
710c609719bSwdenk		CONFIG_WATCHDOG
711c609719bSwdenk		If this variable is defined, it enables watchdog
7127152b1d0Swdenk		support. There must be support in the platform specific
713c609719bSwdenk		code for a watchdog. For the 8xx and 8260 CPUs, the
714c609719bSwdenk		SIU Watchdog feature is enabled in the SYPCR
715c609719bSwdenk		register.
716c609719bSwdenk
717c1551ea8Sstroese- U-Boot Version:
718c1551ea8Sstroese		CONFIG_VERSION_VARIABLE
719c1551ea8Sstroese		If this variable is defined, an environment variable
720c1551ea8Sstroese		named "ver" is created by U-Boot showing the U-Boot
721c1551ea8Sstroese		version as printed by the "version" command.
722c1551ea8Sstroese		This variable is readonly.
723c1551ea8Sstroese
724c609719bSwdenk- Real-Time Clock:
725c609719bSwdenk
726602ad3b3SJon Loeliger		When CONFIG_CMD_DATE is selected, the type of the RTC
727c609719bSwdenk		has to be selected, too. Define exactly one of the
728c609719bSwdenk		following options:
729c609719bSwdenk
730c609719bSwdenk		CONFIG_RTC_MPC8xx	- use internal RTC of MPC8xx
731c609719bSwdenk		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
7327ce63709SGuennadi Liakhovetski		CONFIG_RTC_MC13783	- use MC13783 RTC
733c609719bSwdenk		CONFIG_RTC_MC146818	- use MC146818 RTC
7341cb8e980Swdenk		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
735c609719bSwdenk		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
7367f70e853Swdenk		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
7373bac3513Swdenk		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
7389536dfccSTor Krill		CONFIG_RTC_ISL1208	- use Intersil ISL1208 RTC
7394c0d4c3bSwdenk		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
7406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_DS1337_NOOSC	- Turn off the OSC output for DS1337
741c609719bSwdenk
742b37c7e5eSwdenk		Note that if the RTC uses I2C, then the I2C interface
743b37c7e5eSwdenk		must also be configured. See I2C Support, below.
744b37c7e5eSwdenk
745e92739d3SPeter Tyser- GPIO Support:
746e92739d3SPeter Tyser		CONFIG_PCA953X		- use NXP's PCA953X series I2C GPIO
747e92739d3SPeter Tyser		CONFIG_PCA953X_INFO	- enable pca953x info command
748e92739d3SPeter Tyser
749*5dec49caSChris Packham		The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
750*5dec49caSChris Packham		chip-ngpio pairs that tell the PCA953X driver the number of
751*5dec49caSChris Packham		pins supported by a particular chip.
752*5dec49caSChris Packham
753e92739d3SPeter Tyser		Note that if the GPIO device uses I2C, then the I2C interface
754e92739d3SPeter Tyser		must also be configured. See I2C Support, below.
755e92739d3SPeter Tyser
756c609719bSwdenk- Timestamp Support:
757c609719bSwdenk
758c609719bSwdenk		When CONFIG_TIMESTAMP is selected, the timestamp
759c609719bSwdenk		(date and time) of an image is printed by image
760c609719bSwdenk		commands like bootm or iminfo. This option is
761602ad3b3SJon Loeliger		automatically enabled when you select CONFIG_CMD_DATE .
762c609719bSwdenk
763c609719bSwdenk- Partition Support:
764c609719bSwdenk		CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
76507f3d789Srichardretanubun		and/or CONFIG_ISO_PARTITION and/or CONFIG_EFI_PARTITION
766c609719bSwdenk
767602ad3b3SJon Loeliger		If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
768218ca724SWolfgang Denk		CONFIG_CMD_SCSI) you must configure support for at
769218ca724SWolfgang Denk		least one partition type as well.
770c609719bSwdenk
771c609719bSwdenk- IDE Reset method:
7724d13cbadSwdenk		CONFIG_IDE_RESET_ROUTINE - this is defined in several
7734d13cbadSwdenk		board configurations files but used nowhere!
774c609719bSwdenk
7754d13cbadSwdenk		CONFIG_IDE_RESET - is this is defined, IDE Reset will
7764d13cbadSwdenk		be performed by calling the function
7774d13cbadSwdenk			ide_set_reset(int reset)
7784d13cbadSwdenk		which has to be defined in a board specific file
779c609719bSwdenk
780c609719bSwdenk- ATAPI Support:
781c609719bSwdenk		CONFIG_ATAPI
782c609719bSwdenk
783c609719bSwdenk		Set this to enable ATAPI support.
784c609719bSwdenk
785c40b2956Swdenk- LBA48 Support
786c40b2956Swdenk		CONFIG_LBA48
787c40b2956Swdenk
788c40b2956Swdenk		Set this to enable support for disks larger than 137GB
7894b142febSHeiko Schocher		Also look at CONFIG_SYS_64BIT_LBA.
790c40b2956Swdenk		Whithout these , LBA48 support uses 32bit variables and will 'only'
791c40b2956Swdenk		support disks up to 2.1TB.
792c40b2956Swdenk
7936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_64BIT_LBA:
794c40b2956Swdenk			When enabled, makes the IDE subsystem use 64bit sector addresses.
795c40b2956Swdenk			Default is 32bit.
796c40b2956Swdenk
797c609719bSwdenk- SCSI Support:
798c609719bSwdenk		At the moment only there is only support for the
799c609719bSwdenk		SYM53C8XX SCSI controller; define
800c609719bSwdenk		CONFIG_SCSI_SYM53C8XX to enable it.
801c609719bSwdenk
8026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
8036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
8046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
805c609719bSwdenk		maximum numbers of LUNs, SCSI ID's and target
806c609719bSwdenk		devices.
8076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
808c609719bSwdenk
809c609719bSwdenk- NETWORK Support (PCI):
810682011ffSwdenk		CONFIG_E1000
811682011ffSwdenk		Support for Intel 8254x gigabit chips.
812682011ffSwdenk
813ac3315c2SAndre Schwarz		CONFIG_E1000_FALLBACK_MAC
81411ccc33fSMarcel Ziswiler		default MAC for empty EEPROM after production.
815ac3315c2SAndre Schwarz
816c609719bSwdenk		CONFIG_EEPRO100
817c609719bSwdenk		Support for Intel 82557/82559/82559ER chips.
81811ccc33fSMarcel Ziswiler		Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
819c609719bSwdenk		write routine for first time initialisation.
820c609719bSwdenk
821c609719bSwdenk		CONFIG_TULIP
822c609719bSwdenk		Support for Digital 2114x chips.
823c609719bSwdenk		Optional CONFIG_TULIP_SELECT_MEDIA for board specific
824c609719bSwdenk		modem chip initialisation (KS8761/QS6611).
825c609719bSwdenk
826c609719bSwdenk		CONFIG_NATSEMI
827c609719bSwdenk		Support for National dp83815 chips.
828c609719bSwdenk
829c609719bSwdenk		CONFIG_NS8382X
830c609719bSwdenk		Support for National dp8382[01] gigabit chips.
831c609719bSwdenk
83245219c46Swdenk- NETWORK Support (other):
83345219c46Swdenk
834c041e9d2SJens Scharsig		CONFIG_DRIVER_AT91EMAC
835c041e9d2SJens Scharsig		Support for AT91RM9200 EMAC.
836c041e9d2SJens Scharsig
837c041e9d2SJens Scharsig			CONFIG_RMII
838c041e9d2SJens Scharsig			Define this to use reduced MII inteface
839c041e9d2SJens Scharsig
840c041e9d2SJens Scharsig			CONFIG_DRIVER_AT91EMAC_QUIET
841c041e9d2SJens Scharsig			If this defined, the driver is quiet.
842c041e9d2SJens Scharsig			The driver doen't show link status messages.
843c041e9d2SJens Scharsig
84445219c46Swdenk		CONFIG_DRIVER_LAN91C96
84545219c46Swdenk		Support for SMSC's LAN91C96 chips.
84645219c46Swdenk
84745219c46Swdenk			CONFIG_LAN91C96_BASE
84845219c46Swdenk			Define this to hold the physical address
84945219c46Swdenk			of the LAN91C96's I/O space
85045219c46Swdenk
85145219c46Swdenk			CONFIG_LAN91C96_USE_32_BIT
85245219c46Swdenk			Define this to enable 32 bit addressing
85345219c46Swdenk
854f39748aeSwdenk		CONFIG_DRIVER_SMC91111
855f39748aeSwdenk		Support for SMSC's LAN91C111 chip
856f39748aeSwdenk
857f39748aeSwdenk			CONFIG_SMC91111_BASE
858f39748aeSwdenk			Define this to hold the physical address
859f39748aeSwdenk			of the device (I/O space)
860f39748aeSwdenk
861f39748aeSwdenk			CONFIG_SMC_USE_32_BIT
862f39748aeSwdenk			Define this if data bus is 32 bits
863f39748aeSwdenk
864f39748aeSwdenk			CONFIG_SMC_USE_IOFUNCS
865f39748aeSwdenk			Define this to use i/o functions instead of macros
866f39748aeSwdenk			(some hardware wont work with macros)
867f39748aeSwdenk
868c2fff331SMike Rapoport		CONFIG_SMC911X
869557b377dSJens Gehrlein		Support for SMSC's LAN911x and LAN921x chips
870557b377dSJens Gehrlein
871c2fff331SMike Rapoport			CONFIG_SMC911X_BASE
872557b377dSJens Gehrlein			Define this to hold the physical address
873557b377dSJens Gehrlein			of the device (I/O space)
874557b377dSJens Gehrlein
875c2fff331SMike Rapoport			CONFIG_SMC911X_32_BIT
876557b377dSJens Gehrlein			Define this if data bus is 32 bits
877557b377dSJens Gehrlein
878c2fff331SMike Rapoport			CONFIG_SMC911X_16_BIT
879557b377dSJens Gehrlein			Define this if data bus is 16 bits. If your processor
880557b377dSJens Gehrlein			automatically converts one 32 bit word to two 16 bit
881c2fff331SMike Rapoport			words you may also try CONFIG_SMC911X_32_BIT.
882557b377dSJens Gehrlein
883c609719bSwdenk- USB Support:
884c609719bSwdenk		At the moment only the UHCI host controller is
8854d13cbadSwdenk		supported (PIP405, MIP405, MPC5200); define
886c609719bSwdenk		CONFIG_USB_UHCI to enable it.
887c609719bSwdenk		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
88830d56faeSwdenk		and define CONFIG_USB_STORAGE to enable the USB
889c609719bSwdenk		storage devices.
890c609719bSwdenk		Note:
891c609719bSwdenk		Supported are USB Keyboards and USB Floppy drives
892c609719bSwdenk		(TEAC FD-05PUB).
8934d13cbadSwdenk		MPC5200 USB requires additional defines:
8944d13cbadSwdenk			CONFIG_USB_CLOCK
8954d13cbadSwdenk				for 528 MHz Clock: 0x0001bbbb
896307ecb6dSEric Millbrandt			CONFIG_PSC3_USB
897307ecb6dSEric Millbrandt				for USB on PSC3
8984d13cbadSwdenk			CONFIG_USB_CONFIG
8994d13cbadSwdenk				for differential drivers: 0x00001000
9004d13cbadSwdenk				for single ended drivers: 0x00005000
901307ecb6dSEric Millbrandt				for differential drivers on PSC3: 0x00000100
902307ecb6dSEric Millbrandt				for single ended drivers on PSC3: 0x00004100
9036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_USB_EVENT_POLL
904fdcfaa1bSZhang Wei				May be defined to allow interrupt polling
905fdcfaa1bSZhang Wei				instead of using asynchronous interrupts
9064d13cbadSwdenk
90716c8d5e7SWolfgang Denk- USB Device:
90816c8d5e7SWolfgang Denk		Define the below if you wish to use the USB console.
90916c8d5e7SWolfgang Denk		Once firmware is rebuilt from a serial console issue the
91016c8d5e7SWolfgang Denk		command "setenv stdin usbtty; setenv stdout usbtty" and
91111ccc33fSMarcel Ziswiler		attach your USB cable. The Unix command "dmesg" should print
91216c8d5e7SWolfgang Denk		it has found a new device. The environment variable usbtty
91316c8d5e7SWolfgang Denk		can be set to gserial or cdc_acm to enable your device to
91416c8d5e7SWolfgang Denk		appear to a USB host as a Linux gserial device or a
91516c8d5e7SWolfgang Denk		Common Device Class Abstract Control Model serial device.
91616c8d5e7SWolfgang Denk		If you select usbtty = gserial you should be able to enumerate
91716c8d5e7SWolfgang Denk		a Linux host by
91816c8d5e7SWolfgang Denk		# modprobe usbserial vendor=0xVendorID product=0xProductID
91916c8d5e7SWolfgang Denk		else if using cdc_acm, simply setting the environment
92016c8d5e7SWolfgang Denk		variable usbtty to be cdc_acm should suffice. The following
92116c8d5e7SWolfgang Denk		might be defined in YourBoardName.h
92216c8d5e7SWolfgang Denk
92316c8d5e7SWolfgang Denk			CONFIG_USB_DEVICE
92416c8d5e7SWolfgang Denk			Define this to build a UDC device
92516c8d5e7SWolfgang Denk
92616c8d5e7SWolfgang Denk			CONFIG_USB_TTY
92716c8d5e7SWolfgang Denk			Define this to have a tty type of device available to
92816c8d5e7SWolfgang Denk			talk to the UDC device
92916c8d5e7SWolfgang Denk
9306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_IS_IN_ENV
93116c8d5e7SWolfgang Denk			Define this if you want stdin, stdout &/or stderr to
93216c8d5e7SWolfgang Denk			be set to usbtty.
93316c8d5e7SWolfgang Denk
93416c8d5e7SWolfgang Denk			mpc8xx:
9356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_EXTC_CLK 0xBLAH
93616c8d5e7SWolfgang Denk				Derive USB clock from external clock "blah"
9376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_EXTC_CLK 0x02
93816c8d5e7SWolfgang Denk
9396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_BRG_CLK 0xBLAH
94016c8d5e7SWolfgang Denk				Derive USB clock from brgclk
9416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_BRG_CLK 0x04
94216c8d5e7SWolfgang Denk
94316c8d5e7SWolfgang Denk		If you have a USB-IF assigned VendorID then you may wish to
94416c8d5e7SWolfgang Denk		define your own vendor specific values either in BoardName.h
94516c8d5e7SWolfgang Denk		or directly in usbd_vendor_info.h. If you don't define
94616c8d5e7SWolfgang Denk		CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
94716c8d5e7SWolfgang Denk		CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
94816c8d5e7SWolfgang Denk		should pretend to be a Linux device to it's target host.
94916c8d5e7SWolfgang Denk
95016c8d5e7SWolfgang Denk			CONFIG_USBD_MANUFACTURER
95116c8d5e7SWolfgang Denk			Define this string as the name of your company for
95216c8d5e7SWolfgang Denk			- CONFIG_USBD_MANUFACTURER "my company"
95316c8d5e7SWolfgang Denk
95416c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCT_NAME
95516c8d5e7SWolfgang Denk			Define this string as the name of your product
95616c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCT_NAME "acme usb device"
95716c8d5e7SWolfgang Denk
95816c8d5e7SWolfgang Denk			CONFIG_USBD_VENDORID
95916c8d5e7SWolfgang Denk			Define this as your assigned Vendor ID from the USB
96016c8d5e7SWolfgang Denk			Implementors Forum. This *must* be a genuine Vendor ID
96116c8d5e7SWolfgang Denk			to avoid polluting the USB namespace.
96216c8d5e7SWolfgang Denk			- CONFIG_USBD_VENDORID 0xFFFF
96316c8d5e7SWolfgang Denk
96416c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCTID
96516c8d5e7SWolfgang Denk			Define this as the unique Product ID
96616c8d5e7SWolfgang Denk			for your device
96716c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCTID 0xFFFF
968c609719bSwdenk
969c609719bSwdenk
970c609719bSwdenk- MMC Support:
971c609719bSwdenk		The MMC controller on the Intel PXA is supported. To
972c609719bSwdenk		enable this define CONFIG_MMC. The MMC can be
973c609719bSwdenk		accessed from the boot prompt by mapping the device
974c609719bSwdenk		to physical memory similar to flash. Command line is
975602ad3b3SJon Loeliger		enabled with CONFIG_CMD_MMC. The MMC driver also works with
976602ad3b3SJon Loeliger		the FAT fs. This is enabled with CONFIG_CMD_FAT.
977c609719bSwdenk
9786705d81eSwdenk- Journaling Flash filesystem support:
9796705d81eSwdenk		CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
9806705d81eSwdenk		CONFIG_JFFS2_NAND_DEV
9816705d81eSwdenk		Define these for a default partition on a NAND device
9826705d81eSwdenk
9836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_SECTOR,
9846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
9856705d81eSwdenk		Define these for a default partition on a NOR device
9866705d81eSwdenk
9876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS_CUSTOM_PART
9886705d81eSwdenk		Define this to create an own partition. You have to provide a
9896705d81eSwdenk		function struct part_info* jffs2_part_info(int part_num)
9906705d81eSwdenk
9916705d81eSwdenk		If you define only one JFFS2 partition you may also want to
9926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_JFFS_SINGLE_PART	1
9936705d81eSwdenk		to disable the command chpart. This is the default when you
9946705d81eSwdenk		have not defined a custom partition
9956705d81eSwdenk
996c609719bSwdenk- Keyboard Support:
997c609719bSwdenk		CONFIG_ISA_KEYBOARD
998c609719bSwdenk
999c609719bSwdenk		Define this to enable standard (PC-Style) keyboard
1000c609719bSwdenk		support
1001c609719bSwdenk
1002c609719bSwdenk		CONFIG_I8042_KBD
1003c609719bSwdenk		Standard PC keyboard driver with US (is default) and
1004c609719bSwdenk		GERMAN key layout (switch via environment 'keymap=de') support.
1005c609719bSwdenk		Export function i8042_kbd_init, i8042_tstc and i8042_getc
1006c609719bSwdenk		for cfb_console. Supports cursor blinking.
1007c609719bSwdenk
1008c609719bSwdenk- Video support:
1009c609719bSwdenk		CONFIG_VIDEO
1010c609719bSwdenk
1011c609719bSwdenk		Define this to enable video support (for output to
1012c609719bSwdenk		video).
1013c609719bSwdenk
1014c609719bSwdenk		CONFIG_VIDEO_CT69000
1015c609719bSwdenk
1016c609719bSwdenk		Enable Chips & Technologies 69000 Video chip
1017c609719bSwdenk
1018c609719bSwdenk		CONFIG_VIDEO_SMI_LYNXEM
1019eeb1b77bSwdenk		Enable Silicon Motion SMI 712/710/810 Video chip. The
1020eeb1b77bSwdenk		video output is selected via environment 'videoout'
1021eeb1b77bSwdenk		(1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1022eeb1b77bSwdenk		assumed.
1023c609719bSwdenk
1024eeb1b77bSwdenk		For the CT69000 and SMI_LYNXEM drivers, videomode is
102511ccc33fSMarcel Ziswiler		selected via environment 'videomode'. Two different ways
1026eeb1b77bSwdenk		are possible:
1027eeb1b77bSwdenk		- "videomode=num"   'num' is a standard LiLo mode numbers.
1028eeb1b77bSwdenk		Following standard modes are supported	(* is default):
1029eeb1b77bSwdenk
1030eeb1b77bSwdenk		      Colors	640x480 800x600 1024x768 1152x864 1280x1024
1031eeb1b77bSwdenk		-------------+---------------------------------------------
1032eeb1b77bSwdenk		      8 bits |	0x301*	0x303	 0x305	  0x161	    0x307
1033eeb1b77bSwdenk		     15 bits |	0x310	0x313	 0x316	  0x162	    0x319
1034eeb1b77bSwdenk		     16 bits |	0x311	0x314	 0x317	  0x163	    0x31A
1035eeb1b77bSwdenk		     24 bits |	0x312	0x315	 0x318	    ?	    0x31B
1036eeb1b77bSwdenk		-------------+---------------------------------------------
1037c609719bSwdenk		(i.e. setenv videomode 317; saveenv; reset;)
1038c609719bSwdenk
1039eeb1b77bSwdenk		- "videomode=bootargs" all the video parameters are parsed
10407817cb20SMarcel Ziswiler		from the bootargs. (See drivers/video/videomodes.c)
1041eeb1b77bSwdenk
1042eeb1b77bSwdenk
1043a6c7ad2fSwdenk		CONFIG_VIDEO_SED13806
1044a6c7ad2fSwdenk		Enable Epson SED13806 driver. This driver supports 8bpp
1045a6c7ad2fSwdenk		and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1046a6c7ad2fSwdenk		or CONFIG_VIDEO_SED13806_16BPP
1047a6c7ad2fSwdenk
1048682011ffSwdenk- Keyboard Support:
1049682011ffSwdenk		CONFIG_KEYBOARD
1050682011ffSwdenk
1051682011ffSwdenk		Define this to enable a custom keyboard support.
1052682011ffSwdenk		This simply calls drv_keyboard_init() which must be
1053682011ffSwdenk		defined in your board-specific files.
1054682011ffSwdenk		The only board using this so far is RBC823.
1055a6c7ad2fSwdenk
1056c609719bSwdenk- LCD Support:	CONFIG_LCD
1057c609719bSwdenk
1058c609719bSwdenk		Define this to enable LCD support (for output to LCD
1059c609719bSwdenk		display); also select one of the supported displays
1060c609719bSwdenk		by defining one of these:
1061c609719bSwdenk
106239cf4804SStelian Pop		CONFIG_ATMEL_LCD:
106339cf4804SStelian Pop
106439cf4804SStelian Pop			HITACHI TX09D70VM1CCA, 3.5", 240x320.
106539cf4804SStelian Pop
1066fd3103bbSwdenk		CONFIG_NEC_NL6448AC33:
1067c609719bSwdenk
1068fd3103bbSwdenk			NEC NL6448AC33-18. Active, color, single scan.
1069c609719bSwdenk
1070fd3103bbSwdenk		CONFIG_NEC_NL6448BC20
1071c609719bSwdenk
1072fd3103bbSwdenk			NEC NL6448BC20-08. 6.5", 640x480.
1073fd3103bbSwdenk			Active, color, single scan.
1074fd3103bbSwdenk
1075fd3103bbSwdenk		CONFIG_NEC_NL6448BC33_54
1076fd3103bbSwdenk
1077fd3103bbSwdenk			NEC NL6448BC33-54. 10.4", 640x480.
1078c609719bSwdenk			Active, color, single scan.
1079c609719bSwdenk
1080c609719bSwdenk		CONFIG_SHARP_16x9
1081c609719bSwdenk
1082c609719bSwdenk			Sharp 320x240. Active, color, single scan.
1083c609719bSwdenk			It isn't 16x9, and I am not sure what it is.
1084c609719bSwdenk
1085c609719bSwdenk		CONFIG_SHARP_LQ64D341
1086c609719bSwdenk
1087c609719bSwdenk			Sharp LQ64D341 display, 640x480.
1088c609719bSwdenk			Active, color, single scan.
1089c609719bSwdenk
1090c609719bSwdenk		CONFIG_HLD1045
1091c609719bSwdenk
1092c609719bSwdenk			HLD1045 display, 640x480.
1093c609719bSwdenk			Active, color, single scan.
1094c609719bSwdenk
1095c609719bSwdenk		CONFIG_OPTREX_BW
1096c609719bSwdenk
1097c609719bSwdenk			Optrex	 CBL50840-2 NF-FW 99 22 M5
1098c609719bSwdenk			or
1099c609719bSwdenk			Hitachi	 LMG6912RPFC-00T
1100c609719bSwdenk			or
1101c609719bSwdenk			Hitachi	 SP14Q002
1102c609719bSwdenk
1103c609719bSwdenk			320x240. Black & white.
1104c609719bSwdenk
1105c609719bSwdenk		Normally display is black on white background; define
11066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
1107c609719bSwdenk
11087152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN
1109d791b1dcSwdenk
1110d791b1dcSwdenk		If this option is set, the environment is checked for
1111d791b1dcSwdenk		a variable "splashimage". If found, the usual display
1112d791b1dcSwdenk		of logo, copyright and system information on the LCD
1113e94d2cd9Swdenk		is suppressed and the BMP image at the address
1114d791b1dcSwdenk		specified in "splashimage" is loaded instead. The
1115d791b1dcSwdenk		console is redirected to the "nulldev", too. This
1116d791b1dcSwdenk		allows for a "silent" boot where a splash screen is
1117d791b1dcSwdenk		loaded very quickly after power-on.
1118d791b1dcSwdenk
11191ca298ceSMatthias Weisser		CONFIG_SPLASH_SCREEN_ALIGN
11201ca298ceSMatthias Weisser
11211ca298ceSMatthias Weisser		If this option is set the splash image can be freely positioned
11221ca298ceSMatthias Weisser		on the screen. Environment variable "splashpos" specifies the
11231ca298ceSMatthias Weisser		position as "x,y". If a positive number is given it is used as
11241ca298ceSMatthias Weisser		number of pixel from left/top. If a negative number is given it
11251ca298ceSMatthias Weisser		is used as number of pixel from right/bottom. You can also
11261ca298ceSMatthias Weisser		specify 'm' for centering the image.
11271ca298ceSMatthias Weisser
11281ca298ceSMatthias Weisser		Example:
11291ca298ceSMatthias Weisser		setenv splashpos m,m
11301ca298ceSMatthias Weisser			=> image at center of screen
11311ca298ceSMatthias Weisser
11321ca298ceSMatthias Weisser		setenv splashpos 30,20
11331ca298ceSMatthias Weisser			=> image at x = 30 and y = 20
11341ca298ceSMatthias Weisser
11351ca298ceSMatthias Weisser		setenv splashpos -10,m
11361ca298ceSMatthias Weisser			=> vertically centered image
11371ca298ceSMatthias Weisser			   at x = dspWidth - bmpWidth - 9
11381ca298ceSMatthias Weisser
113998f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
114098f4a3dfSStefan Roese
114198f4a3dfSStefan Roese		If this option is set, additionally to standard BMP
114298f4a3dfSStefan Roese		images, gzipped BMP images can be displayed via the
114398f4a3dfSStefan Roese		splashscreen support or the bmp command.
114498f4a3dfSStefan Roese
1145d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1146d5011762SAnatolij Gustschin
1147d5011762SAnatolij Gustschin		If this option is set, 8-bit RLE compressed BMP images
1148d5011762SAnatolij Gustschin		can be displayed via the splashscreen support or the
1149d5011762SAnatolij Gustschin		bmp command.
1150d5011762SAnatolij Gustschin
1151c29fdfc1Swdenk- Compression support:
1152c29fdfc1Swdenk		CONFIG_BZIP2
1153c29fdfc1Swdenk
1154c29fdfc1Swdenk		If this option is set, support for bzip2 compressed
1155c29fdfc1Swdenk		images is included. If not, only uncompressed and gzip
1156c29fdfc1Swdenk		compressed images are supported.
1157c29fdfc1Swdenk
1158c29fdfc1Swdenk		NOTE: the bzip2 algorithm requires a lot of RAM, so
11596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
1160c29fdfc1Swdenk		be at least 4MB.
1161d791b1dcSwdenk
1162fc9c1727SLuigi 'Comio' Mantellini		CONFIG_LZMA
1163fc9c1727SLuigi 'Comio' Mantellini
1164fc9c1727SLuigi 'Comio' Mantellini		If this option is set, support for lzma compressed
1165fc9c1727SLuigi 'Comio' Mantellini		images is included.
1166fc9c1727SLuigi 'Comio' Mantellini
1167fc9c1727SLuigi 'Comio' Mantellini		Note: The LZMA algorithm adds between 2 and 4KB of code and it
1168fc9c1727SLuigi 'Comio' Mantellini		requires an amount of dynamic memory that is given by the
1169fc9c1727SLuigi 'Comio' Mantellini		formula:
1170fc9c1727SLuigi 'Comio' Mantellini
1171fc9c1727SLuigi 'Comio' Mantellini			(1846 + 768 << (lc + lp)) * sizeof(uint16)
1172fc9c1727SLuigi 'Comio' Mantellini
1173fc9c1727SLuigi 'Comio' Mantellini		Where lc and lp stand for, respectively, Literal context bits
1174fc9c1727SLuigi 'Comio' Mantellini		and Literal pos bits.
1175fc9c1727SLuigi 'Comio' Mantellini
1176fc9c1727SLuigi 'Comio' Mantellini		This value is upper-bounded by 14MB in the worst case. Anyway,
1177fc9c1727SLuigi 'Comio' Mantellini		for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1178fc9c1727SLuigi 'Comio' Mantellini		total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1179fc9c1727SLuigi 'Comio' Mantellini		a very small buffer.
1180fc9c1727SLuigi 'Comio' Mantellini
1181fc9c1727SLuigi 'Comio' Mantellini		Use the lzmainfo tool to determinate the lc and lp values and
1182fc9c1727SLuigi 'Comio' Mantellini		then calculate the amount of needed dynamic memory (ensuring
11836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the appropriate CONFIG_SYS_MALLOC_LEN value).
1184fc9c1727SLuigi 'Comio' Mantellini
118517ea1177Swdenk- MII/PHY support:
118617ea1177Swdenk		CONFIG_PHY_ADDR
118717ea1177Swdenk
118817ea1177Swdenk		The address of PHY on MII bus.
118917ea1177Swdenk
119017ea1177Swdenk		CONFIG_PHY_CLOCK_FREQ (ppc4xx)
119117ea1177Swdenk
119217ea1177Swdenk		The clock frequency of the MII bus
119317ea1177Swdenk
119417ea1177Swdenk		CONFIG_PHY_GIGE
119517ea1177Swdenk
119617ea1177Swdenk		If this option is set, support for speed/duplex
119711ccc33fSMarcel Ziswiler		detection of gigabit PHY is included.
119817ea1177Swdenk
119917ea1177Swdenk		CONFIG_PHY_RESET_DELAY
120017ea1177Swdenk
120117ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
120217ea1177Swdenk		reset before any MII register access is possible.
120317ea1177Swdenk		For such PHY, set this option to the usec delay
120417ea1177Swdenk		required. (minimum 300usec for LXT971A)
120517ea1177Swdenk
120617ea1177Swdenk		CONFIG_PHY_CMD_DELAY (ppc4xx)
120717ea1177Swdenk
120817ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
120917ea1177Swdenk		command issued before MII status register can be read
121017ea1177Swdenk
1211c609719bSwdenk- Ethernet address:
1212c609719bSwdenk		CONFIG_ETHADDR
1213c68a05feSrichardretanubun		CONFIG_ETH1ADDR
1214c609719bSwdenk		CONFIG_ETH2ADDR
1215c609719bSwdenk		CONFIG_ETH3ADDR
1216c68a05feSrichardretanubun		CONFIG_ETH4ADDR
1217c68a05feSrichardretanubun		CONFIG_ETH5ADDR
1218c609719bSwdenk
121911ccc33fSMarcel Ziswiler		Define a default value for Ethernet address to use
122011ccc33fSMarcel Ziswiler		for the respective Ethernet interface, in case this
1221c609719bSwdenk		is not determined automatically.
1222c609719bSwdenk
1223c609719bSwdenk- IP address:
1224c609719bSwdenk		CONFIG_IPADDR
1225c609719bSwdenk
1226c609719bSwdenk		Define a default value for the IP address to use for
122711ccc33fSMarcel Ziswiler		the default Ethernet interface, in case this is not
1228c609719bSwdenk		determined through e.g. bootp.
1229c609719bSwdenk
1230c609719bSwdenk- Server IP address:
1231c609719bSwdenk		CONFIG_SERVERIP
1232c609719bSwdenk
1233c609719bSwdenk		Defines a default value for the IP address of a TFTP
1234c609719bSwdenk		server to contact when using the "tftboot" command.
1235c609719bSwdenk
123697cfe861SRobin Getz		CONFIG_KEEP_SERVERADDR
123797cfe861SRobin Getz
123897cfe861SRobin Getz		Keeps the server's MAC address, in the env 'serveraddr'
123997cfe861SRobin Getz		for passing to bootargs (like Linux's netconsole option)
124097cfe861SRobin Getz
124153a5c424SDavid Updegraff- Multicast TFTP Mode:
124253a5c424SDavid Updegraff		CONFIG_MCAST_TFTP
124353a5c424SDavid Updegraff
124453a5c424SDavid Updegraff		Defines whether you want to support multicast TFTP as per
124553a5c424SDavid Updegraff		rfc-2090; for example to work with atftp.  Lets lots of targets
124611ccc33fSMarcel Ziswiler		tftp down the same boot image concurrently.  Note: the Ethernet
124753a5c424SDavid Updegraff		driver in use must provide a function: mcast() to join/leave a
124853a5c424SDavid Updegraff		multicast group.
124953a5c424SDavid Updegraff
125053a5c424SDavid Updegraff		CONFIG_BOOTP_RANDOM_DELAY
1251c609719bSwdenk- BOOTP Recovery Mode:
1252c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY
1253c609719bSwdenk
1254c609719bSwdenk		If you have many targets in a network that try to
1255c609719bSwdenk		boot using BOOTP, you may want to avoid that all
1256c609719bSwdenk		systems send out BOOTP requests at precisely the same
1257c609719bSwdenk		moment (which would happen for instance at recovery
1258c609719bSwdenk		from a power failure, when all systems will try to
1259c609719bSwdenk		boot, thus flooding the BOOTP server. Defining
1260c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1261c609719bSwdenk		inserted before sending out BOOTP requests. The
12626c33c785SWolfgang Denk		following delays are inserted then:
1263c609719bSwdenk
1264c609719bSwdenk		1st BOOTP request:	delay 0 ... 1 sec
1265c609719bSwdenk		2nd BOOTP request:	delay 0 ... 2 sec
1266c609719bSwdenk		3rd BOOTP request:	delay 0 ... 4 sec
1267c609719bSwdenk		4th and following
1268c609719bSwdenk		BOOTP requests:		delay 0 ... 8 sec
1269c609719bSwdenk
1270fe389a82Sstroese- DHCP Advanced Options:
12711fe80d79SJon Loeliger		You can fine tune the DHCP functionality by defining
12721fe80d79SJon Loeliger		CONFIG_BOOTP_* symbols:
1273fe389a82Sstroese
12741fe80d79SJon Loeliger		CONFIG_BOOTP_SUBNETMASK
12751fe80d79SJon Loeliger		CONFIG_BOOTP_GATEWAY
12761fe80d79SJon Loeliger		CONFIG_BOOTP_HOSTNAME
12771fe80d79SJon Loeliger		CONFIG_BOOTP_NISDOMAIN
12781fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTPATH
12791fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTFILESIZE
12801fe80d79SJon Loeliger		CONFIG_BOOTP_DNS
12811fe80d79SJon Loeliger		CONFIG_BOOTP_DNS2
12821fe80d79SJon Loeliger		CONFIG_BOOTP_SEND_HOSTNAME
12831fe80d79SJon Loeliger		CONFIG_BOOTP_NTPSERVER
12841fe80d79SJon Loeliger		CONFIG_BOOTP_TIMEOFFSET
12851fe80d79SJon Loeliger		CONFIG_BOOTP_VENDOREX
1286fe389a82Sstroese
12875d110f0aSWilson Callan		CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
12885d110f0aSWilson Callan		environment variable, not the BOOTP server.
1289fe389a82Sstroese
1290fe389a82Sstroese		CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1291fe389a82Sstroese		serverip from a DHCP server, it is possible that more
1292fe389a82Sstroese		than one DNS serverip is offered to the client.
1293fe389a82Sstroese		If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1294fe389a82Sstroese		serverip will be stored in the additional environment
1295fe389a82Sstroese		variable "dnsip2". The first DNS serverip is always
1296fe389a82Sstroese		stored in the variable "dnsip", when CONFIG_BOOTP_DNS
12971fe80d79SJon Loeliger		is defined.
1298fe389a82Sstroese
1299fe389a82Sstroese		CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1300fe389a82Sstroese		to do a dynamic update of a DNS server. To do this, they
1301fe389a82Sstroese		need the hostname of the DHCP requester.
13025d110f0aSWilson Callan		If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
13031fe80d79SJon Loeliger		of the "hostname" environment variable is passed as
13041fe80d79SJon Loeliger		option 12 to the DHCP server.
1305fe389a82Sstroese
1306d9a2f416SAras Vaichas		CONFIG_BOOTP_DHCP_REQUEST_DELAY
1307d9a2f416SAras Vaichas
1308d9a2f416SAras Vaichas		A 32bit value in microseconds for a delay between
1309d9a2f416SAras Vaichas		receiving a "DHCP Offer" and sending the "DHCP Request".
1310d9a2f416SAras Vaichas		This fixes a problem with certain DHCP servers that don't
1311d9a2f416SAras Vaichas		respond 100% of the time to a "DHCP request". E.g. On an
1312d9a2f416SAras Vaichas		AT91RM9200 processor running at 180MHz, this delay needed
1313d9a2f416SAras Vaichas		to be *at least* 15,000 usec before a Windows Server 2003
1314d9a2f416SAras Vaichas		DHCP server would reply 100% of the time. I recommend at
1315d9a2f416SAras Vaichas		least 50,000 usec to be safe. The alternative is to hope
1316d9a2f416SAras Vaichas		that one of the retries will be successful but note that
1317d9a2f416SAras Vaichas		the DHCP timeout and retry process takes a longer than
1318d9a2f416SAras Vaichas		this delay.
1319d9a2f416SAras Vaichas
1320a3d991bdSwdenk - CDP Options:
1321a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID
1322a3d991bdSwdenk
1323a3d991bdSwdenk		The device id used in CDP trigger frames.
1324a3d991bdSwdenk
1325a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID_PREFIX
1326a3d991bdSwdenk
1327a3d991bdSwdenk		A two character string which is prefixed to the MAC address
1328a3d991bdSwdenk		of the device.
1329a3d991bdSwdenk
1330a3d991bdSwdenk		CONFIG_CDP_PORT_ID
1331a3d991bdSwdenk
1332a3d991bdSwdenk		A printf format string which contains the ascii name of
1333a3d991bdSwdenk		the port. Normally is set to "eth%d" which sets
133411ccc33fSMarcel Ziswiler		eth0 for the first Ethernet, eth1 for the second etc.
1335a3d991bdSwdenk
1336a3d991bdSwdenk		CONFIG_CDP_CAPABILITIES
1337a3d991bdSwdenk
1338a3d991bdSwdenk		A 32bit integer which indicates the device capabilities;
1339a3d991bdSwdenk		0x00000010 for a normal host which does not forwards.
1340a3d991bdSwdenk
1341a3d991bdSwdenk		CONFIG_CDP_VERSION
1342a3d991bdSwdenk
1343a3d991bdSwdenk		An ascii string containing the version of the software.
1344a3d991bdSwdenk
1345a3d991bdSwdenk		CONFIG_CDP_PLATFORM
1346a3d991bdSwdenk
1347a3d991bdSwdenk		An ascii string containing the name of the platform.
1348a3d991bdSwdenk
1349a3d991bdSwdenk		CONFIG_CDP_TRIGGER
1350a3d991bdSwdenk
1351a3d991bdSwdenk		A 32bit integer sent on the trigger.
1352a3d991bdSwdenk
1353a3d991bdSwdenk		CONFIG_CDP_POWER_CONSUMPTION
1354a3d991bdSwdenk
1355a3d991bdSwdenk		A 16bit integer containing the power consumption of the
1356a3d991bdSwdenk		device in .1 of milliwatts.
1357a3d991bdSwdenk
1358a3d991bdSwdenk		CONFIG_CDP_APPLIANCE_VLAN_TYPE
1359a3d991bdSwdenk
1360a3d991bdSwdenk		A byte containing the id of the VLAN.
1361a3d991bdSwdenk
1362c609719bSwdenk- Status LED:	CONFIG_STATUS_LED
1363c609719bSwdenk
1364c609719bSwdenk		Several configurations allow to display the current
1365c609719bSwdenk		status using a LED. For instance, the LED will blink
1366c609719bSwdenk		fast while running U-Boot code, stop blinking as
1367c609719bSwdenk		soon as a reply to a BOOTP request was received, and
1368c609719bSwdenk		start blinking slow once the Linux kernel is running
1369c609719bSwdenk		(supported by a status LED driver in the Linux
1370c609719bSwdenk		kernel). Defining CONFIG_STATUS_LED enables this
1371c609719bSwdenk		feature in U-Boot.
1372c609719bSwdenk
1373c609719bSwdenk- CAN Support:	CONFIG_CAN_DRIVER
1374c609719bSwdenk
1375c609719bSwdenk		Defining CONFIG_CAN_DRIVER enables CAN driver support
1376c609719bSwdenk		on those systems that support this (optional)
1377c609719bSwdenk		feature, like the TQM8xxL modules.
1378c609719bSwdenk
1379c609719bSwdenk- I2C Support:	CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1380c609719bSwdenk
1381b37c7e5eSwdenk		These enable I2C serial bus commands. Defining either of
1382b37c7e5eSwdenk		(but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
138311ccc33fSMarcel Ziswiler		include the appropriate I2C driver for the selected CPU.
1384c609719bSwdenk
1385b37c7e5eSwdenk		This will allow you to use i2c commands at the u-boot
1386602ad3b3SJon Loeliger		command line (as long as you set CONFIG_CMD_I2C in
1387b37c7e5eSwdenk		CONFIG_COMMANDS) and communicate with i2c based realtime
1388b37c7e5eSwdenk		clock chips. See common/cmd_i2c.c for a description of the
1389c609719bSwdenk		command line interface.
1390c609719bSwdenk
1391bb99ad6dSBen Warren		CONFIG_HARD_I2C selects a hardware I2C controller.
1392c609719bSwdenk
1393b37c7e5eSwdenk		CONFIG_SOFT_I2C configures u-boot to use a software (aka
1394b37c7e5eSwdenk		bit-banging) driver instead of CPM or similar hardware
1395b37c7e5eSwdenk		support for I2C.
1396c609719bSwdenk
1397b37c7e5eSwdenk		There are several other quantities that must also be
1398b37c7e5eSwdenk		defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
1399c609719bSwdenk
14006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		In both cases you will need to define CONFIG_SYS_I2C_SPEED
1401b37c7e5eSwdenk		to be the frequency (in Hz) at which you wish your i2c bus
14026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
140311ccc33fSMarcel Ziswiler		the CPU's i2c node address).
1404c609719bSwdenk
14058d321b81SPeter Tyser		Now, the u-boot i2c code for the mpc8xx
1406a47a12beSStefan Roese		(arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
14078d321b81SPeter Tyser		and so its address should therefore be cleared to 0 (See,
14088d321b81SPeter Tyser		eg, MPC823e User's Manual p.16-473). So, set
14098d321b81SPeter Tyser		CONFIG_SYS_I2C_SLAVE to 0.
1410b37c7e5eSwdenk
14115da71efaSEric Millbrandt		CONFIG_SYS_I2C_INIT_MPC5XXX
14125da71efaSEric Millbrandt
14135da71efaSEric Millbrandt		When a board is reset during an i2c bus transfer
14145da71efaSEric Millbrandt		chips might think that the current transfer is still
14155da71efaSEric Millbrandt		in progress.  Reset the slave devices by sending start
14165da71efaSEric Millbrandt		commands until the slave device responds.
14175da71efaSEric Millbrandt
1418b37c7e5eSwdenk		That's all that's required for CONFIG_HARD_I2C.
1419b37c7e5eSwdenk
1420b37c7e5eSwdenk		If you use the software i2c interface (CONFIG_SOFT_I2C)
1421b37c7e5eSwdenk		then the following macros need to be defined (examples are
1422b37c7e5eSwdenk		from include/configs/lwmon.h):
1423c609719bSwdenk
1424c609719bSwdenk		I2C_INIT
1425c609719bSwdenk
1426b37c7e5eSwdenk		(Optional). Any commands necessary to enable the I2C
1427c609719bSwdenk		controller or configure ports.
1428c609719bSwdenk
1429b37c7e5eSwdenk		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
1430b37c7e5eSwdenk
1431c609719bSwdenk		I2C_PORT
1432c609719bSwdenk
1433c609719bSwdenk		(Only for MPC8260 CPU). The I/O port to use (the code
1434c609719bSwdenk		assumes both bits are on the same port). Valid values
1435c609719bSwdenk		are 0..3 for ports A..D.
1436c609719bSwdenk
1437c609719bSwdenk		I2C_ACTIVE
1438c609719bSwdenk
1439c609719bSwdenk		The code necessary to make the I2C data line active
1440c609719bSwdenk		(driven).  If the data line is open collector, this
1441c609719bSwdenk		define can be null.
1442c609719bSwdenk
1443b37c7e5eSwdenk		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
1444b37c7e5eSwdenk
1445c609719bSwdenk		I2C_TRISTATE
1446c609719bSwdenk
1447c609719bSwdenk		The code necessary to make the I2C data line tri-stated
1448c609719bSwdenk		(inactive).  If the data line is open collector, this
1449c609719bSwdenk		define can be null.
1450c609719bSwdenk
1451b37c7e5eSwdenk		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1452b37c7e5eSwdenk
1453c609719bSwdenk		I2C_READ
1454c609719bSwdenk
1455c609719bSwdenk		Code that returns TRUE if the I2C data line is high,
1456c609719bSwdenk		FALSE if it is low.
1457c609719bSwdenk
1458b37c7e5eSwdenk		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1459b37c7e5eSwdenk
1460c609719bSwdenk		I2C_SDA(bit)
1461c609719bSwdenk
1462c609719bSwdenk		If <bit> is TRUE, sets the I2C data line high. If it
1463c609719bSwdenk		is FALSE, it clears it (low).
1464c609719bSwdenk
1465b37c7e5eSwdenk		eg: #define I2C_SDA(bit) \
1466b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
1467b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
1468b37c7e5eSwdenk
1469c609719bSwdenk		I2C_SCL(bit)
1470c609719bSwdenk
1471c609719bSwdenk		If <bit> is TRUE, sets the I2C clock line high. If it
1472c609719bSwdenk		is FALSE, it clears it (low).
1473c609719bSwdenk
1474b37c7e5eSwdenk		eg: #define I2C_SCL(bit) \
1475b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
1476b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
1477b37c7e5eSwdenk
1478c609719bSwdenk		I2C_DELAY
1479c609719bSwdenk
1480c609719bSwdenk		This delay is invoked four times per clock cycle so this
1481c609719bSwdenk		controls the rate of data transfer.  The data rate thus
1482b37c7e5eSwdenk		is 1 / (I2C_DELAY * 4). Often defined to be something
1483b37c7e5eSwdenk		like:
1484b37c7e5eSwdenk
1485b37c7e5eSwdenk		#define I2C_DELAY  udelay(2)
1486c609719bSwdenk
1487793b5726SMike Frysinger		CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1488793b5726SMike Frysinger
1489793b5726SMike Frysinger		If your arch supports the generic GPIO framework (asm/gpio.h),
1490793b5726SMike Frysinger		then you may alternatively define the two GPIOs that are to be
1491793b5726SMike Frysinger		used as SCL / SDA.  Any of the previous I2C_xxx macros will
1492793b5726SMike Frysinger		have GPIO-based defaults assigned to them as appropriate.
1493793b5726SMike Frysinger
1494793b5726SMike Frysinger		You should define these to the GPIO value as given directly to
1495793b5726SMike Frysinger		the generic GPIO functions.
1496793b5726SMike Frysinger
14976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_INIT_BOARD
149847cd00faSwdenk
149947cd00faSwdenk		When a board is reset during an i2c bus transfer
150047cd00faSwdenk		chips might think that the current transfer is still
150147cd00faSwdenk		in progress. On some boards it is possible to access
150247cd00faSwdenk		the i2c SCLK line directly, either by using the
150347cd00faSwdenk		processor pin as a GPIO or by having a second pin
150447cd00faSwdenk		connected to the bus. If this option is defined a
150547cd00faSwdenk		custom i2c_init_board() routine in boards/xxx/board.c
150647cd00faSwdenk		is run early in the boot sequence.
150747cd00faSwdenk
150826a33504SRichard Retanubun		CONFIG_SYS_I2C_BOARD_LATE_INIT
150926a33504SRichard Retanubun
151026a33504SRichard Retanubun		An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
151126a33504SRichard Retanubun		defined a custom i2c_board_late_init() routine in
151226a33504SRichard Retanubun		boards/xxx/board.c is run AFTER the operations in i2c_init()
151326a33504SRichard Retanubun		is completed. This callpoint can be used to unreset i2c bus
151426a33504SRichard Retanubun		using CPU i2c controller register accesses for CPUs whose i2c
151526a33504SRichard Retanubun		controller provide such a method. It is called at the end of
151626a33504SRichard Retanubun		i2c_init() to allow i2c_init operations to setup the i2c bus
151726a33504SRichard Retanubun		controller on the CPU (e.g. setting bus speed & slave address).
151826a33504SRichard Retanubun
151917ea1177Swdenk		CONFIG_I2CFAST (PPC405GP|PPC405EP only)
152017ea1177Swdenk
152117ea1177Swdenk		This option enables configuration of bi_iic_fast[] flags
152217ea1177Swdenk		in u-boot bd_info structure based on u-boot environment
152317ea1177Swdenk		variable "i2cfast". (see also i2cfast)
152417ea1177Swdenk
1525bb99ad6dSBen Warren		CONFIG_I2C_MULTI_BUS
1526bb99ad6dSBen Warren
1527bb99ad6dSBen Warren		This option allows the use of multiple I2C buses, each of which
1528bb99ad6dSBen Warren		must have a controller.  At any point in time, only one bus is
1529bb99ad6dSBen Warren		active.  To switch to a different bus, use the 'i2c dev' command.
1530bb99ad6dSBen Warren		Note that bus numbering is zero-based.
1531bb99ad6dSBen Warren
15326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_NOPROBES
1533bb99ad6dSBen Warren
1534bb99ad6dSBen Warren		This option specifies a list of I2C devices that will be skipped
15350f89c54bSPeter Tyser		when the 'i2c probe' command is issued.  If CONFIG_I2C_MULTI_BUS
15360f89c54bSPeter Tyser		is set, specify a list of bus-device pairs.  Otherwise, specify
15370f89c54bSPeter Tyser		a 1D array of device addresses
1538bb99ad6dSBen Warren
1539bb99ad6dSBen Warren		e.g.
1540bb99ad6dSBen Warren			#undef	CONFIG_I2C_MULTI_BUS
15416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_NOPROBES	{0x50,0x68}
1542bb99ad6dSBen Warren
1543bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on a board with one I2C bus
1544bb99ad6dSBen Warren
1545bb99ad6dSBen Warren			#define	CONFIG_I2C_MULTI_BUS
15466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_MULTI_NOPROBES	{{0,0x50},{0,0x68},{1,0x54}}
1547bb99ad6dSBen Warren
1548bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1549bb99ad6dSBen Warren
15506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SPD_BUS_NUM
1551be5e6181STimur Tabi
1552be5e6181STimur Tabi		If defined, then this indicates the I2C bus number for DDR SPD.
1553be5e6181STimur Tabi		If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1554be5e6181STimur Tabi
15556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_BUS_NUM
15560dc018ecSStefan Roese
15570dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the RTC.
15580dc018ecSStefan Roese		If not defined, then U-Boot assumes that RTC is on I2C bus 0.
15590dc018ecSStefan Roese
15606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_DTT_BUS_NUM
15610dc018ecSStefan Roese
15620dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the DTT.
15630dc018ecSStefan Roese		If not defined, then U-Boot assumes that DTT is on I2C bus 0.
15640dc018ecSStefan Roese
15656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_DTT_ADDR:
15669ebbb54fSVictor Gallardo
15679ebbb54fSVictor Gallardo		If defined, specifies the I2C address of the DTT device.
15689ebbb54fSVictor Gallardo		If not defined, then U-Boot uses predefined value for
15699ebbb54fSVictor Gallardo		specified DTT device.
15709ebbb54fSVictor Gallardo
1571be5e6181STimur Tabi		CONFIG_FSL_I2C
1572be5e6181STimur Tabi
1573be5e6181STimur Tabi		Define this option if you want to use Freescale's I2C driver in
15747817cb20SMarcel Ziswiler		drivers/i2c/fsl_i2c.c.
1575be5e6181STimur Tabi
157667b23a32SHeiko Schocher		CONFIG_I2C_MUX
157767b23a32SHeiko Schocher
157867b23a32SHeiko Schocher		Define this option if you have I2C devices reached over 1 .. n
157967b23a32SHeiko Schocher		I2C Muxes like the pca9544a. This option addes a new I2C
158067b23a32SHeiko Schocher		Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
158167b23a32SHeiko Schocher		new I2C Bus to the existing I2C Busses. If you select the
158267b23a32SHeiko Schocher		new Bus with "i2c dev", u-bbot sends first the commandos for
158367b23a32SHeiko Schocher		the muxes to activate this new "bus".
158467b23a32SHeiko Schocher
158567b23a32SHeiko Schocher		CONFIG_I2C_MULTI_BUS must be also defined, to use this
158667b23a32SHeiko Schocher		feature!
158767b23a32SHeiko Schocher
158867b23a32SHeiko Schocher		Example:
158967b23a32SHeiko Schocher		Adding a new I2C Bus reached over 2 pca9544a muxes
159067b23a32SHeiko Schocher			The First mux with address 70 and channel 6
159167b23a32SHeiko Schocher			The Second mux with address 71 and channel 4
159267b23a32SHeiko Schocher
159367b23a32SHeiko Schocher		=> i2c bus pca9544a:70:6:pca9544a:71:4
159467b23a32SHeiko Schocher
159567b23a32SHeiko Schocher		Use the "i2c bus" command without parameter, to get a list
159667b23a32SHeiko Schocher		of I2C Busses with muxes:
159767b23a32SHeiko Schocher
159867b23a32SHeiko Schocher		=> i2c bus
159967b23a32SHeiko Schocher		Busses reached over muxes:
160067b23a32SHeiko Schocher		Bus ID: 2
160167b23a32SHeiko Schocher		  reached over Mux(es):
160267b23a32SHeiko Schocher		    pca9544a@70 ch: 4
160367b23a32SHeiko Schocher		Bus ID: 3
160467b23a32SHeiko Schocher		  reached over Mux(es):
160567b23a32SHeiko Schocher		    pca9544a@70 ch: 6
160667b23a32SHeiko Schocher		    pca9544a@71 ch: 4
160767b23a32SHeiko Schocher		=>
160867b23a32SHeiko Schocher
160967b23a32SHeiko Schocher		If you now switch to the new I2C Bus 3 with "i2c dev 3"
161067b23a32SHeiko Schocher		u-boot sends First the Commando to the mux@70 to enable
161167b23a32SHeiko Schocher		channel 6, and then the Commando to the mux@71 to enable
161267b23a32SHeiko Schocher		the channel 4.
161367b23a32SHeiko Schocher
161467b23a32SHeiko Schocher		After that, you can use the "normal" i2c commands as
161567b23a32SHeiko Schocher		usual, to communicate with your I2C devices behind
161667b23a32SHeiko Schocher		the 2 muxes.
161767b23a32SHeiko Schocher
161867b23a32SHeiko Schocher		This option is actually implemented for the bitbanging
161967b23a32SHeiko Schocher		algorithm in common/soft_i2c.c and for the Hardware I2C
162067b23a32SHeiko Schocher		Bus on the MPC8260. But it should be not so difficult
162167b23a32SHeiko Schocher		to add this option to other architectures.
162267b23a32SHeiko Schocher
16232ac6985aSAndrew Dyer		CONFIG_SOFT_I2C_READ_REPEATED_START
16242ac6985aSAndrew Dyer
16252ac6985aSAndrew Dyer		defining this will force the i2c_read() function in
16262ac6985aSAndrew Dyer		the soft_i2c driver to perform an I2C repeated start
16272ac6985aSAndrew Dyer		between writing the address pointer and reading the
16282ac6985aSAndrew Dyer		data.  If this define is omitted the default behaviour
16292ac6985aSAndrew Dyer		of doing a stop-start sequence will be used.  Most I2C
16302ac6985aSAndrew Dyer		devices can use either method, but some require one or
16312ac6985aSAndrew Dyer		the other.
1632be5e6181STimur Tabi
1633c609719bSwdenk- SPI Support:	CONFIG_SPI
1634c609719bSwdenk
1635c609719bSwdenk		Enables SPI driver (so far only tested with
1636c609719bSwdenk		SPI EEPROM, also an instance works with Crystal A/D and
1637c609719bSwdenk		D/As on the SACSng board)
1638c609719bSwdenk
1639c609719bSwdenk		CONFIG_SPI_X
1640c609719bSwdenk
1641c609719bSwdenk		Enables extended (16-bit) SPI EEPROM addressing.
1642c609719bSwdenk		(symmetrical to CONFIG_I2C_X)
1643c609719bSwdenk
1644c609719bSwdenk		CONFIG_SOFT_SPI
1645c609719bSwdenk
1646c609719bSwdenk		Enables a software (bit-bang) SPI driver rather than
1647c609719bSwdenk		using hardware support. This is a general purpose
1648c609719bSwdenk		driver that only requires three general I/O port pins
1649c609719bSwdenk		(two outputs, one input) to function. If this is
1650c609719bSwdenk		defined, the board configuration must define several
1651c609719bSwdenk		SPI configuration items (port pins to use, etc). For
1652c609719bSwdenk		an example, see include/configs/sacsng.h.
1653c609719bSwdenk
165404a9e118SBen Warren		CONFIG_HARD_SPI
165504a9e118SBen Warren
165604a9e118SBen Warren		Enables a hardware SPI driver for general-purpose reads
165704a9e118SBen Warren		and writes.  As with CONFIG_SOFT_SPI, the board configuration
165804a9e118SBen Warren		must define a list of chip-select function pointers.
165904a9e118SBen Warren		Currently supported on some MPC8xxx processors.  For an
166004a9e118SBen Warren		example, see include/configs/mpc8349emds.h.
166104a9e118SBen Warren
166238254f45SGuennadi Liakhovetski		CONFIG_MXC_SPI
166338254f45SGuennadi Liakhovetski
166438254f45SGuennadi Liakhovetski		Enables the driver for the SPI controllers on i.MX and MXC
166538254f45SGuennadi Liakhovetski		SoCs. Currently only i.MX31 is supported.
166638254f45SGuennadi Liakhovetski
16670133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA
16680133502eSMatthias Fuchs
16690133502eSMatthias Fuchs		Enables FPGA subsystem.
16700133502eSMatthias Fuchs
16710133502eSMatthias Fuchs		CONFIG_FPGA_<vendor>
16720133502eSMatthias Fuchs
16730133502eSMatthias Fuchs		Enables support for specific chip vendors.
16740133502eSMatthias Fuchs		(ALTERA, XILINX)
16750133502eSMatthias Fuchs
16760133502eSMatthias Fuchs		CONFIG_FPGA_<family>
16770133502eSMatthias Fuchs
16780133502eSMatthias Fuchs		Enables support for FPGA family.
16790133502eSMatthias Fuchs		(SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
16800133502eSMatthias Fuchs
16810133502eSMatthias Fuchs		CONFIG_FPGA_COUNT
1682c609719bSwdenk
1683c609719bSwdenk		Specify the number of FPGA devices to support.
1684c609719bSwdenk
16856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_PROG_FEEDBACK
1686c609719bSwdenk
1687c609719bSwdenk		Enable printing of hash marks during FPGA configuration.
1688c609719bSwdenk
16896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_BUSY
1690c609719bSwdenk
1691c609719bSwdenk		Enable checks on FPGA configuration interface busy
1692c609719bSwdenk		status by the configuration function. This option
1693c609719bSwdenk		will require a board or device specific function to
1694c609719bSwdenk		be written.
1695c609719bSwdenk
1696c609719bSwdenk		CONFIG_FPGA_DELAY
1697c609719bSwdenk
1698c609719bSwdenk		If defined, a function that provides delays in the FPGA
1699c609719bSwdenk		configuration driver.
1700c609719bSwdenk
17016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_CTRLC
1702c609719bSwdenk		Allow Control-C to interrupt FPGA configuration
1703c609719bSwdenk
17046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_ERROR
1705c609719bSwdenk
1706c609719bSwdenk		Check for configuration errors during FPGA bitfile
1707c609719bSwdenk		loading. For example, abort during Virtex II
1708c609719bSwdenk		configuration if the INIT_B line goes low (which
1709c609719bSwdenk		indicated a CRC error).
1710c609719bSwdenk
17116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_INIT
1712c609719bSwdenk
1713c609719bSwdenk		Maximum time to wait for the INIT_B line to deassert
1714c609719bSwdenk		after PROB_B has been deasserted during a Virtex II
1715c609719bSwdenk		FPGA configuration sequence. The default time is 500
171611ccc33fSMarcel Ziswiler		ms.
1717c609719bSwdenk
17186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_BUSY
1719c609719bSwdenk
1720c609719bSwdenk		Maximum time to wait for BUSY to deassert during
172111ccc33fSMarcel Ziswiler		Virtex II FPGA configuration. The default is 5 ms.
1722c609719bSwdenk
17236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_CONFIG
1724c609719bSwdenk
1725c609719bSwdenk		Time to wait after FPGA configuration. The default is
172611ccc33fSMarcel Ziswiler		200 ms.
1727c609719bSwdenk
1728c609719bSwdenk- Configuration Management:
1729c609719bSwdenk		CONFIG_IDENT_STRING
1730c609719bSwdenk
1731c609719bSwdenk		If defined, this string will be added to the U-Boot
1732c609719bSwdenk		version information (U_BOOT_VERSION)
1733c609719bSwdenk
1734c609719bSwdenk- Vendor Parameter Protection:
1735c609719bSwdenk
1736c609719bSwdenk		U-Boot considers the values of the environment
1737c609719bSwdenk		variables "serial#" (Board Serial Number) and
17387152b1d0Swdenk		"ethaddr" (Ethernet Address) to be parameters that
1739c609719bSwdenk		are set once by the board vendor / manufacturer, and
1740c609719bSwdenk		protects these variables from casual modification by
1741c609719bSwdenk		the user. Once set, these variables are read-only,
1742c609719bSwdenk		and write or delete attempts are rejected. You can
174311ccc33fSMarcel Ziswiler		change this behaviour:
1744c609719bSwdenk
1745c609719bSwdenk		If CONFIG_ENV_OVERWRITE is #defined in your config
1746c609719bSwdenk		file, the write protection for vendor parameters is
174747cd00faSwdenk		completely disabled. Anybody can change or delete
1748c609719bSwdenk		these parameters.
1749c609719bSwdenk
1750c609719bSwdenk		Alternatively, if you #define _both_ CONFIG_ETHADDR
1751c609719bSwdenk		_and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
175211ccc33fSMarcel Ziswiler		Ethernet address is installed in the environment,
1753c609719bSwdenk		which can be changed exactly ONCE by the user. [The
1754c609719bSwdenk		serial# is unaffected by this, i. e. it remains
1755c609719bSwdenk		read-only.]
1756c609719bSwdenk
1757c609719bSwdenk- Protected RAM:
1758c609719bSwdenk		CONFIG_PRAM
1759c609719bSwdenk
1760c609719bSwdenk		Define this variable to enable the reservation of
1761c609719bSwdenk		"protected RAM", i. e. RAM which is not overwritten
1762c609719bSwdenk		by U-Boot. Define CONFIG_PRAM to hold the number of
1763c609719bSwdenk		kB you want to reserve for pRAM. You can overwrite
1764c609719bSwdenk		this default value by defining an environment
1765c609719bSwdenk		variable "pram" to the number of kB you want to
1766c609719bSwdenk		reserve. Note that the board info structure will
1767c609719bSwdenk		still show the full amount of RAM. If pRAM is
1768c609719bSwdenk		reserved, a new environment variable "mem" will
1769c609719bSwdenk		automatically be defined to hold the amount of
1770c609719bSwdenk		remaining RAM in a form that can be passed as boot
1771c609719bSwdenk		argument to Linux, for instance like that:
1772c609719bSwdenk
1773fe126d8bSWolfgang Denk			setenv bootargs ... mem=\${mem}
1774c609719bSwdenk			saveenv
1775c609719bSwdenk
1776c609719bSwdenk		This way you can tell Linux not to use this memory,
1777c609719bSwdenk		either, which results in a memory region that will
1778c609719bSwdenk		not be affected by reboots.
1779c609719bSwdenk
1780c609719bSwdenk		*WARNING* If your board configuration uses automatic
1781c609719bSwdenk		detection of the RAM size, you must make sure that
1782c609719bSwdenk		this memory test is non-destructive. So far, the
1783c609719bSwdenk		following board configurations are known to be
1784c609719bSwdenk		"pRAM-clean":
1785c609719bSwdenk
1786c609719bSwdenk			ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
1787c609719bSwdenk			HERMES, IP860, RPXlite, LWMON, LANTEC,
1788544d97e9SWolfgang Denk			FLAGADM, TQM8260
1789c609719bSwdenk
1790c609719bSwdenk- Error Recovery:
1791c609719bSwdenk		CONFIG_PANIC_HANG
1792c609719bSwdenk
1793c609719bSwdenk		Define this variable to stop the system in case of a
1794c609719bSwdenk		fatal error, so that you have to reset it manually.
1795c609719bSwdenk		This is probably NOT a good idea for an embedded
179611ccc33fSMarcel Ziswiler		system where you want the system to reboot
1797c609719bSwdenk		automatically as fast as possible, but it may be
1798c609719bSwdenk		useful during development since you can try to debug
1799c609719bSwdenk		the conditions that lead to the situation.
1800c609719bSwdenk
1801c609719bSwdenk		CONFIG_NET_RETRY_COUNT
1802c609719bSwdenk
1803c609719bSwdenk		This variable defines the number of retries for
1804c609719bSwdenk		network operations like ARP, RARP, TFTP, or BOOTP
1805c609719bSwdenk		before giving up the operation. If not defined, a
1806c609719bSwdenk		default value of 5 is used.
1807c609719bSwdenk
180840cb90eeSGuennadi Liakhovetski		CONFIG_ARP_TIMEOUT
180940cb90eeSGuennadi Liakhovetski
181040cb90eeSGuennadi Liakhovetski		Timeout waiting for an ARP reply in milliseconds.
181140cb90eeSGuennadi Liakhovetski
1812c609719bSwdenk- Command Interpreter:
18138078f1a5SWolfgang Denk		CONFIG_AUTO_COMPLETE
181404a85b3bSwdenk
181504a85b3bSwdenk		Enable auto completion of commands using TAB.
181604a85b3bSwdenk
18178078f1a5SWolfgang Denk		Note that this feature has NOT been implemented yet
18188078f1a5SWolfgang Denk		for the "hush" shell.
18198078f1a5SWolfgang Denk
18208078f1a5SWolfgang Denk
18216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_HUSH_PARSER
1822c609719bSwdenk
1823c609719bSwdenk		Define this variable to enable the "hush" shell (from
1824c609719bSwdenk		Busybox) as command line interpreter, thus enabling
1825c609719bSwdenk		powerful command line syntax like
1826c609719bSwdenk		if...then...else...fi conditionals or `&&' and '||'
1827c609719bSwdenk		constructs ("shell scripts").
1828c609719bSwdenk
1829c609719bSwdenk		If undefined, you get the old, much simpler behaviour
1830c609719bSwdenk		with a somewhat smaller memory footprint.
1831c609719bSwdenk
1832c609719bSwdenk
18336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_PROMPT_HUSH_PS2
1834c609719bSwdenk
1835c609719bSwdenk		This defines the secondary prompt string, which is
1836c609719bSwdenk		printed when the command interpreter needs more input
1837c609719bSwdenk		to complete a command. Usually "> ".
1838c609719bSwdenk
1839c609719bSwdenk	Note:
1840c609719bSwdenk
1841c609719bSwdenk		In the current implementation, the local variables
1842c609719bSwdenk		space and global environment variables space are
1843c609719bSwdenk		separated. Local variables are those you define by
18443b57fe0aSwdenk		simply typing `name=value'. To access a local
1845c609719bSwdenk		variable later on, you have write `$name' or
18463b57fe0aSwdenk		`${name}'; to execute the contents of a variable
18473b57fe0aSwdenk		directly type `$name' at the command prompt.
1848c609719bSwdenk
1849c609719bSwdenk		Global environment variables are those you use
1850c609719bSwdenk		setenv/printenv to work with. To run a command stored
1851c609719bSwdenk		in such a variable, you need to use the run command,
1852c609719bSwdenk		and you must not use the '$' sign to access them.
1853c609719bSwdenk
1854c609719bSwdenk		To store commands and special characters in a
1855c609719bSwdenk		variable, please use double quotation marks
1856c609719bSwdenk		surrounding the whole text of the variable, instead
1857c609719bSwdenk		of the backslashes before semicolons and special
1858c609719bSwdenk		symbols.
1859c609719bSwdenk
1860aa0c71acSWolfgang Denk- Commandline Editing and History:
1861aa0c71acSWolfgang Denk		CONFIG_CMDLINE_EDITING
1862aa0c71acSWolfgang Denk
186311ccc33fSMarcel Ziswiler		Enable editing and History functions for interactive
1864aa0c71acSWolfgang Denk		commandline input operations
1865aa0c71acSWolfgang Denk
1866a8c7c708Swdenk- Default Environment:
1867c609719bSwdenk		CONFIG_EXTRA_ENV_SETTINGS
1868c609719bSwdenk
1869c609719bSwdenk		Define this to contain any number of null terminated
1870c609719bSwdenk		strings (variable = value pairs) that will be part of
18717152b1d0Swdenk		the default environment compiled into the boot image.
18722262cfeeSwdenk
1873c609719bSwdenk		For example, place something like this in your
1874c609719bSwdenk		board's config file:
1875c609719bSwdenk
1876c609719bSwdenk		#define CONFIG_EXTRA_ENV_SETTINGS \
1877c609719bSwdenk			"myvar1=value1\0" \
1878c609719bSwdenk			"myvar2=value2\0"
1879c609719bSwdenk
1880c609719bSwdenk		Warning: This method is based on knowledge about the
1881c609719bSwdenk		internal format how the environment is stored by the
18822262cfeeSwdenk		U-Boot code. This is NOT an official, exported
1883c609719bSwdenk		interface! Although it is unlikely that this format
18847152b1d0Swdenk		will change soon, there is no guarantee either.
1885c609719bSwdenk		You better know what you are doing here.
1886c609719bSwdenk
1887c609719bSwdenk		Note: overly (ab)use of the default environment is
1888c609719bSwdenk		discouraged. Make sure to check other ways to preset
188974de7aefSWolfgang Denk		the environment like the "source" command or the
1890c609719bSwdenk		boot command first.
1891c609719bSwdenk
1892a8c7c708Swdenk- DataFlash Support:
18932abbe075Swdenk		CONFIG_HAS_DATAFLASH
18942abbe075Swdenk
18952abbe075Swdenk		Defining this option enables DataFlash features and
18962abbe075Swdenk		allows to read/write in Dataflash via the standard
18972abbe075Swdenk		commands cp, md...
18982abbe075Swdenk
18993f85ce27Swdenk- SystemACE Support:
19003f85ce27Swdenk		CONFIG_SYSTEMACE
19013f85ce27Swdenk
19023f85ce27Swdenk		Adding this option adds support for Xilinx SystemACE
19033f85ce27Swdenk		chips attached via some sort of local bus. The address
190411ccc33fSMarcel Ziswiler		of the chip must also be defined in the
19056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SYSTEMACE_BASE macro. For example:
19063f85ce27Swdenk
19073f85ce27Swdenk		#define CONFIG_SYSTEMACE
19086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
19093f85ce27Swdenk
19103f85ce27Swdenk		When SystemACE support is added, the "ace" device type
19113f85ce27Swdenk		becomes available to the fat commands, i.e. fatls.
19123f85ce27Swdenk
1913ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port:
1914ecb0ccd9SWolfgang Denk		CONFIG_TFTP_PORT
1915ecb0ccd9SWolfgang Denk
191628cb9375SWolfgang Denk		If this is defined, the environment variable tftpsrcp
1917ecb0ccd9SWolfgang Denk		is used to supply the TFTP UDP source port value.
191828cb9375SWolfgang Denk		If tftpsrcp isn't defined, the normal pseudo-random port
1919ecb0ccd9SWolfgang Denk		number generator is used.
1920ecb0ccd9SWolfgang Denk
192128cb9375SWolfgang Denk		Also, the environment variable tftpdstp is used to supply
192228cb9375SWolfgang Denk		the TFTP UDP destination port value.  If tftpdstp isn't
192328cb9375SWolfgang Denk		defined, the normal port 69 is used.
192428cb9375SWolfgang Denk
192528cb9375SWolfgang Denk		The purpose for tftpsrcp is to allow a TFTP server to
1926ecb0ccd9SWolfgang Denk		blindly start the TFTP transfer using the pre-configured
1927ecb0ccd9SWolfgang Denk		target IP address and UDP port. This has the effect of
1928ecb0ccd9SWolfgang Denk		"punching through" the (Windows XP) firewall, allowing
1929ecb0ccd9SWolfgang Denk		the remainder of the TFTP transfer to proceed normally.
1930ecb0ccd9SWolfgang Denk		A better solution is to properly configure the firewall,
1931ecb0ccd9SWolfgang Denk		but sometimes that is not allowed.
1932ecb0ccd9SWolfgang Denk
1933a8c7c708Swdenk- Show boot progress:
1934c609719bSwdenk		CONFIG_SHOW_BOOT_PROGRESS
1935c609719bSwdenk
1936c609719bSwdenk		Defining this option allows to add some board-
1937c609719bSwdenk		specific code (calling a user-provided function
1938c609719bSwdenk		"show_boot_progress(int)") that enables you to show
1939c609719bSwdenk		the system's boot progress on some display (for
1940c609719bSwdenk		example, some LED's) on your board. At the moment,
1941c609719bSwdenk		the following checkpoints are implemented:
1942c609719bSwdenk
19431372cce2SMarian BalakowiczLegacy uImage format:
19441372cce2SMarian Balakowicz
1945c609719bSwdenk  Arg	Where			When
1946c609719bSwdenk    1	common/cmd_bootm.c	before attempting to boot an image
1947c609719bSwdenk   -1	common/cmd_bootm.c	Image header has bad	 magic number
1948c609719bSwdenk    2	common/cmd_bootm.c	Image header has correct magic number
1949c609719bSwdenk   -2	common/cmd_bootm.c	Image header has bad	 checksum
1950c609719bSwdenk    3	common/cmd_bootm.c	Image header has correct checksum
1951c609719bSwdenk   -3	common/cmd_bootm.c	Image data   has bad	 checksum
1952c609719bSwdenk    4	common/cmd_bootm.c	Image data   has correct checksum
1953c609719bSwdenk   -4	common/cmd_bootm.c	Image is for unsupported architecture
1954c609719bSwdenk    5	common/cmd_bootm.c	Architecture check OK
19551372cce2SMarian Balakowicz   -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi)
1956c609719bSwdenk    6	common/cmd_bootm.c	Image Type check OK
1957c609719bSwdenk   -6	common/cmd_bootm.c	gunzip uncompression error
1958c609719bSwdenk   -7	common/cmd_bootm.c	Unimplemented compression type
1959c609719bSwdenk    7	common/cmd_bootm.c	Uncompression OK
19601372cce2SMarian Balakowicz    8	common/cmd_bootm.c	No uncompress/copy overwrite error
1961c609719bSwdenk   -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
19621372cce2SMarian Balakowicz
19631372cce2SMarian Balakowicz    9	common/image.c		Start initial ramdisk verification
19641372cce2SMarian Balakowicz  -10	common/image.c		Ramdisk header has bad	   magic number
19651372cce2SMarian Balakowicz  -11	common/image.c		Ramdisk header has bad	   checksum
19661372cce2SMarian Balakowicz   10	common/image.c		Ramdisk header is OK
19671372cce2SMarian Balakowicz  -12	common/image.c		Ramdisk data   has bad	   checksum
19681372cce2SMarian Balakowicz   11	common/image.c		Ramdisk data   has correct checksum
19691372cce2SMarian Balakowicz   12	common/image.c		Ramdisk verification complete, start loading
197011ccc33fSMarcel Ziswiler  -13	common/image.c		Wrong Image Type (not PPC Linux ramdisk)
19711372cce2SMarian Balakowicz   13	common/image.c		Start multifile image verification
19721372cce2SMarian Balakowicz   14	common/image.c		No initial ramdisk, no multifile, continue.
19731372cce2SMarian Balakowicz
1974ea0364f1SPeter Tyser   15	arch/<arch>/lib/bootm.c	All preparation done, transferring control to OS
1975c609719bSwdenk
1976a47a12beSStefan Roese  -30	arch/powerpc/lib/board.c	Fatal error, hang the system
197763e73c9aSwdenk  -31	post/post.c		POST test failed, detected by post_output_backlog()
197863e73c9aSwdenk  -32	post/post.c		POST test failed, detected by post_run_single()
197963e73c9aSwdenk
1980566a494fSHeiko Schocher   34	common/cmd_doc.c	before loading a Image from a DOC device
1981566a494fSHeiko Schocher  -35	common/cmd_doc.c	Bad usage of "doc" command
1982566a494fSHeiko Schocher   35	common/cmd_doc.c	correct usage of "doc" command
1983566a494fSHeiko Schocher  -36	common/cmd_doc.c	No boot device
1984566a494fSHeiko Schocher   36	common/cmd_doc.c	correct boot device
1985566a494fSHeiko Schocher  -37	common/cmd_doc.c	Unknown Chip ID on boot device
1986566a494fSHeiko Schocher   37	common/cmd_doc.c	correct chip ID found, device available
1987566a494fSHeiko Schocher  -38	common/cmd_doc.c	Read Error on boot device
1988566a494fSHeiko Schocher   38	common/cmd_doc.c	reading Image header from DOC device OK
1989566a494fSHeiko Schocher  -39	common/cmd_doc.c	Image header has bad magic number
1990566a494fSHeiko Schocher   39	common/cmd_doc.c	Image header has correct magic number
1991566a494fSHeiko Schocher  -40	common/cmd_doc.c	Error reading Image from DOC device
1992566a494fSHeiko Schocher   40	common/cmd_doc.c	Image header has correct magic number
1993566a494fSHeiko Schocher   41	common/cmd_ide.c	before loading a Image from a IDE device
1994566a494fSHeiko Schocher  -42	common/cmd_ide.c	Bad usage of "ide" command
1995566a494fSHeiko Schocher   42	common/cmd_ide.c	correct usage of "ide" command
1996566a494fSHeiko Schocher  -43	common/cmd_ide.c	No boot device
1997566a494fSHeiko Schocher   43	common/cmd_ide.c	boot device found
1998566a494fSHeiko Schocher  -44	common/cmd_ide.c	Device not available
1999566a494fSHeiko Schocher   44	common/cmd_ide.c	Device available
2000566a494fSHeiko Schocher  -45	common/cmd_ide.c	wrong partition selected
2001566a494fSHeiko Schocher   45	common/cmd_ide.c	partition selected
2002566a494fSHeiko Schocher  -46	common/cmd_ide.c	Unknown partition table
2003566a494fSHeiko Schocher   46	common/cmd_ide.c	valid partition table found
2004566a494fSHeiko Schocher  -47	common/cmd_ide.c	Invalid partition type
2005566a494fSHeiko Schocher   47	common/cmd_ide.c	correct partition type
2006566a494fSHeiko Schocher  -48	common/cmd_ide.c	Error reading Image Header on boot device
2007566a494fSHeiko Schocher   48	common/cmd_ide.c	reading Image Header from IDE device OK
2008566a494fSHeiko Schocher  -49	common/cmd_ide.c	Image header has bad magic number
2009566a494fSHeiko Schocher   49	common/cmd_ide.c	Image header has correct magic number
2010566a494fSHeiko Schocher  -50	common/cmd_ide.c	Image header has bad	 checksum
2011566a494fSHeiko Schocher   50	common/cmd_ide.c	Image header has correct checksum
2012566a494fSHeiko Schocher  -51	common/cmd_ide.c	Error reading Image from IDE device
2013566a494fSHeiko Schocher   51	common/cmd_ide.c	reading Image from IDE device OK
2014566a494fSHeiko Schocher   52	common/cmd_nand.c	before loading a Image from a NAND device
2015566a494fSHeiko Schocher  -53	common/cmd_nand.c	Bad usage of "nand" command
2016566a494fSHeiko Schocher   53	common/cmd_nand.c	correct usage of "nand" command
2017566a494fSHeiko Schocher  -54	common/cmd_nand.c	No boot device
2018566a494fSHeiko Schocher   54	common/cmd_nand.c	boot device found
2019566a494fSHeiko Schocher  -55	common/cmd_nand.c	Unknown Chip ID on boot device
2020566a494fSHeiko Schocher   55	common/cmd_nand.c	correct chip ID found, device available
2021566a494fSHeiko Schocher  -56	common/cmd_nand.c	Error reading Image Header on boot device
2022566a494fSHeiko Schocher   56	common/cmd_nand.c	reading Image Header from NAND device OK
2023566a494fSHeiko Schocher  -57	common/cmd_nand.c	Image header has bad magic number
2024566a494fSHeiko Schocher   57	common/cmd_nand.c	Image header has correct magic number
2025566a494fSHeiko Schocher  -58	common/cmd_nand.c	Error reading Image from NAND device
2026566a494fSHeiko Schocher   58	common/cmd_nand.c	reading Image from NAND device OK
2027c609719bSwdenk
2028566a494fSHeiko Schocher  -60	common/env_common.c	Environment has a bad CRC, using default
2029c609719bSwdenk
2030566a494fSHeiko Schocher   64	net/eth.c		starting with Ethernet configuration.
2031566a494fSHeiko Schocher  -64	net/eth.c		no Ethernet found.
2032566a494fSHeiko Schocher   65	net/eth.c		Ethernet found.
2033206c60cbSwdenk
2034566a494fSHeiko Schocher  -80	common/cmd_net.c	usage wrong
2035566a494fSHeiko Schocher   80	common/cmd_net.c	before calling NetLoop()
203611ccc33fSMarcel Ziswiler  -81	common/cmd_net.c	some error in NetLoop() occurred
2037566a494fSHeiko Schocher   81	common/cmd_net.c	NetLoop() back without error
2038566a494fSHeiko Schocher  -82	common/cmd_net.c	size == 0 (File with size 0 loaded)
2039566a494fSHeiko Schocher   82	common/cmd_net.c	trying automatic boot
204074de7aefSWolfgang Denk   83	common/cmd_net.c	running "source" command
204174de7aefSWolfgang Denk  -83	common/cmd_net.c	some error in automatic boot or "source" command
2042566a494fSHeiko Schocher   84	common/cmd_net.c	end without errors
2043c609719bSwdenk
20441372cce2SMarian BalakowiczFIT uImage format:
20451372cce2SMarian Balakowicz
20461372cce2SMarian Balakowicz  Arg	Where			When
20471372cce2SMarian Balakowicz  100	common/cmd_bootm.c	Kernel FIT Image has correct format
20481372cce2SMarian Balakowicz -100	common/cmd_bootm.c	Kernel FIT Image has incorrect format
20491372cce2SMarian Balakowicz  101	common/cmd_bootm.c	No Kernel subimage unit name, using configuration
20501372cce2SMarian Balakowicz -101	common/cmd_bootm.c	Can't get configuration for kernel subimage
20511372cce2SMarian Balakowicz  102	common/cmd_bootm.c	Kernel unit name specified
20521372cce2SMarian Balakowicz -103	common/cmd_bootm.c	Can't get kernel subimage node offset
2053f773bea8SMarian Balakowicz  103	common/cmd_bootm.c	Found configuration node
20541372cce2SMarian Balakowicz  104	common/cmd_bootm.c	Got kernel subimage node offset
20551372cce2SMarian Balakowicz -104	common/cmd_bootm.c	Kernel subimage hash verification failed
20561372cce2SMarian Balakowicz  105	common/cmd_bootm.c	Kernel subimage hash verification OK
20571372cce2SMarian Balakowicz -105	common/cmd_bootm.c	Kernel subimage is for unsupported architecture
20581372cce2SMarian Balakowicz  106	common/cmd_bootm.c	Architecture check OK
205911ccc33fSMarcel Ziswiler -106	common/cmd_bootm.c	Kernel subimage has wrong type
206011ccc33fSMarcel Ziswiler  107	common/cmd_bootm.c	Kernel subimage type OK
20611372cce2SMarian Balakowicz -107	common/cmd_bootm.c	Can't get kernel subimage data/size
20621372cce2SMarian Balakowicz  108	common/cmd_bootm.c	Got kernel subimage data/size
20631372cce2SMarian Balakowicz -108	common/cmd_bootm.c	Wrong image type (not legacy, FIT)
20641372cce2SMarian Balakowicz -109	common/cmd_bootm.c	Can't get kernel subimage type
20651372cce2SMarian Balakowicz -110	common/cmd_bootm.c	Can't get kernel subimage comp
20661372cce2SMarian Balakowicz -111	common/cmd_bootm.c	Can't get kernel subimage os
20671372cce2SMarian Balakowicz -112	common/cmd_bootm.c	Can't get kernel subimage load address
20681372cce2SMarian Balakowicz -113	common/cmd_bootm.c	Image uncompress/copy overwrite error
20691372cce2SMarian Balakowicz
20701372cce2SMarian Balakowicz  120	common/image.c		Start initial ramdisk verification
20711372cce2SMarian Balakowicz -120	common/image.c		Ramdisk FIT image has incorrect format
20721372cce2SMarian Balakowicz  121	common/image.c		Ramdisk FIT image has correct format
207311ccc33fSMarcel Ziswiler  122	common/image.c		No ramdisk subimage unit name, using configuration
20741372cce2SMarian Balakowicz -122	common/image.c		Can't get configuration for ramdisk subimage
20751372cce2SMarian Balakowicz  123	common/image.c		Ramdisk unit name specified
20761372cce2SMarian Balakowicz -124	common/image.c		Can't get ramdisk subimage node offset
20771372cce2SMarian Balakowicz  125	common/image.c		Got ramdisk subimage node offset
20781372cce2SMarian Balakowicz -125	common/image.c		Ramdisk subimage hash verification failed
20791372cce2SMarian Balakowicz  126	common/image.c		Ramdisk subimage hash verification OK
20801372cce2SMarian Balakowicz -126	common/image.c		Ramdisk subimage for unsupported architecture
20811372cce2SMarian Balakowicz  127	common/image.c		Architecture check OK
20821372cce2SMarian Balakowicz -127	common/image.c		Can't get ramdisk subimage data/size
20831372cce2SMarian Balakowicz  128	common/image.c		Got ramdisk subimage data/size
20841372cce2SMarian Balakowicz  129	common/image.c		Can't get ramdisk load address
20851372cce2SMarian Balakowicz -129	common/image.c		Got ramdisk load address
20861372cce2SMarian Balakowicz
208711ccc33fSMarcel Ziswiler -130	common/cmd_doc.c	Incorrect FIT image format
20881372cce2SMarian Balakowicz  131	common/cmd_doc.c	FIT image format OK
20891372cce2SMarian Balakowicz
209011ccc33fSMarcel Ziswiler -140	common/cmd_ide.c	Incorrect FIT image format
20911372cce2SMarian Balakowicz  141	common/cmd_ide.c	FIT image format OK
20921372cce2SMarian Balakowicz
209311ccc33fSMarcel Ziswiler -150	common/cmd_nand.c	Incorrect FIT image format
20941372cce2SMarian Balakowicz  151	common/cmd_nand.c	FIT image format OK
20951372cce2SMarian Balakowicz
2096cccfc2abSDetlev Zundel- Automatic software updates via TFTP server
2097cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP
2098cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_CNT_MAX
2099cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_MSEC_MAX
2100cccfc2abSDetlev Zundel
2101cccfc2abSDetlev Zundel		These options enable and control the auto-update feature;
2102cccfc2abSDetlev Zundel		for a more detailed description refer to doc/README.update.
2103cccfc2abSDetlev Zundel
2104cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support)
2105cccfc2abSDetlev Zundel		CONFIG_MTD_DEVICE
2106cccfc2abSDetlev Zundel
2107cccfc2abSDetlev Zundel		Adds the MTD device infrastructure from the Linux kernel.
2108cccfc2abSDetlev Zundel		Needed for mtdparts command support.
2109cccfc2abSDetlev Zundel
2110cccfc2abSDetlev Zundel		CONFIG_MTD_PARTITIONS
2111cccfc2abSDetlev Zundel
2112cccfc2abSDetlev Zundel		Adds the MTD partitioning infrastructure from the Linux
2113cccfc2abSDetlev Zundel		kernel. Needed for UBI support.
2114cccfc2abSDetlev Zundel
21151372cce2SMarian Balakowicz
2116c609719bSwdenkModem Support:
2117c609719bSwdenk--------------
2118c609719bSwdenk
211985ec0bccSwdenk[so far only for SMDK2400 and TRAB boards]
2120c609719bSwdenk
212111ccc33fSMarcel Ziswiler- Modem support enable:
2122c609719bSwdenk		CONFIG_MODEM_SUPPORT
2123c609719bSwdenk
2124c609719bSwdenk- RTS/CTS Flow control enable:
2125c609719bSwdenk		CONFIG_HWFLOW
2126c609719bSwdenk
2127c609719bSwdenk- Modem debug support:
2128c609719bSwdenk		CONFIG_MODEM_SUPPORT_DEBUG
2129c609719bSwdenk
2130c609719bSwdenk		Enables debugging stuff (char screen[1024], dbg())
2131c609719bSwdenk		for modem support. Useful only with BDI2000.
2132c609719bSwdenk
2133a8c7c708Swdenk- Interrupt support (PPC):
2134a8c7c708Swdenk
2135a8c7c708Swdenk		There are common interrupt_init() and timer_interrupt()
2136a8c7c708Swdenk		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
213711ccc33fSMarcel Ziswiler		for CPU specific initialization. interrupt_init_cpu()
2138a8c7c708Swdenk		should set decrementer_count to appropriate value. If
213911ccc33fSMarcel Ziswiler		CPU resets decrementer automatically after interrupt
2140a8c7c708Swdenk		(ppc4xx) it should set decrementer_count to zero.
214111ccc33fSMarcel Ziswiler		timer_interrupt() calls timer_interrupt_cpu() for CPU
2142a8c7c708Swdenk		specific handling. If board has watchdog / status_led
2143a8c7c708Swdenk		/ other_activity_monitor it works automatically from
2144a8c7c708Swdenk		general timer_interrupt().
2145a8c7c708Swdenk
2146c609719bSwdenk- General:
2147c609719bSwdenk
2148c609719bSwdenk		In the target system modem support is enabled when a
2149c609719bSwdenk		specific key (key combination) is pressed during
2150c609719bSwdenk		power-on. Otherwise U-Boot will boot normally
215111ccc33fSMarcel Ziswiler		(autoboot). The key_pressed() function is called from
2152c609719bSwdenk		board_init(). Currently key_pressed() is a dummy
2153c609719bSwdenk		function, returning 1 and thus enabling modem
2154c609719bSwdenk		initialization.
2155c609719bSwdenk
2156c609719bSwdenk		If there are no modem init strings in the
2157c609719bSwdenk		environment, U-Boot proceed to autoboot; the
2158c609719bSwdenk		previous output (banner, info printfs) will be
215911ccc33fSMarcel Ziswiler		suppressed, though.
2160c609719bSwdenk
2161c609719bSwdenk		See also: doc/README.Modem
2162c609719bSwdenk
2163c609719bSwdenk
2164c609719bSwdenkConfiguration Settings:
2165c609719bSwdenk-----------------------
2166c609719bSwdenk
21676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
2168c609719bSwdenk		undefine this when you're short of memory.
2169c609719bSwdenk
21702fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
21712fb2604dSPeter Tyser		width of the commands listed in the 'help' command output.
21722fb2604dSPeter Tyser
21736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT:	This is what U-Boot prints on the console to
2174c609719bSwdenk		prompt for user input.
2175c609719bSwdenk
21766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE:	Buffer size for input from the Console
2177c609719bSwdenk
21786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE:	Buffer size for Console output
2179c609719bSwdenk
21806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS:	max. Number of arguments accepted for monitor commands
2181c609719bSwdenk
21826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
2183c609719bSwdenk		the application (usually a Linux kernel) when it is
2184c609719bSwdenk		booted
2185c609719bSwdenk
21866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE:
2187c609719bSwdenk		List of legal baudrate settings for this board.
2188c609719bSwdenk
21896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_INFO_QUIET
2190c609719bSwdenk		Suppress display of console information at boot.
2191c609719bSwdenk
21926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_IS_IN_ENV
2193c609719bSwdenk		If the board specific function
2194c609719bSwdenk			extern int overwrite_console (void);
2195c609719bSwdenk		returns 1, the stdin, stderr and stdout are switched to the
2196c609719bSwdenk		serial port, else the settings in the environment are used.
2197c609719bSwdenk
21986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
2199c609719bSwdenk		Enable the call to overwrite_console().
2200c609719bSwdenk
22016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
2202c609719bSwdenk		Enable overwrite of previous console environment settings.
2203c609719bSwdenk
22046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
2205c609719bSwdenk		Begin and End addresses of the area used by the
2206c609719bSwdenk		simple memory test.
2207c609719bSwdenk
22086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST:
2209c609719bSwdenk		Enable an alternate, more extensive memory test.
2210c609719bSwdenk
22116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH:
22125f535fe1Swdenk		Scratch address used by the alternate memory test
22135f535fe1Swdenk		You only need to set this if address zero isn't writeable
22145f535fe1Swdenk
22156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
22166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
221714f73ca6SStefan Roese		this specified memory area will get subtracted from the top
221811ccc33fSMarcel Ziswiler		(end) of RAM and won't get "touched" at all by U-Boot. By
221914f73ca6SStefan Roese		fixing up gd->ram_size the Linux kernel should gets passed
222014f73ca6SStefan Roese		the now "corrected" memory size and won't touch it either.
222114f73ca6SStefan Roese		This should work for arch/ppc and arch/powerpc. Only Linux
22225e12e75dSStefan Roese		board ports in arch/powerpc with bootwrapper support that
222314f73ca6SStefan Roese		recalculate the memory size from the SDRAM controller setup
22245e12e75dSStefan Roese		will have to get fixed in Linux additionally.
222514f73ca6SStefan Roese
222614f73ca6SStefan Roese		This option can be used as a workaround for the 440EPx/GRx
222714f73ca6SStefan Roese		CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
222814f73ca6SStefan Roese		be touched.
222914f73ca6SStefan Roese
223014f73ca6SStefan Roese		WARNING: Please make sure that this value is a multiple of
223114f73ca6SStefan Roese		the Linux page size (normally 4k). If this is not the case,
223214f73ca6SStefan Roese		then the end address of the Linux memory will be located at a
223314f73ca6SStefan Roese		non page size aligned address and this could cause major
223414f73ca6SStefan Roese		problems.
223514f73ca6SStefan Roese
22366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TFTP_LOADADDR:
2237c609719bSwdenk		Default load address for network file downloads
2238c609719bSwdenk
22396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE:
2240c609719bSwdenk		Enable temporary baudrate change while serial download
2241c609719bSwdenk
22426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE:
2243c609719bSwdenk		Physical start address of SDRAM. _Must_ be 0 here.
2244c609719bSwdenk
22456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MBIO_BASE:
2246c609719bSwdenk		Physical start address of Motherboard I/O (if using a
2247c609719bSwdenk		Cogent motherboard)
2248c609719bSwdenk
22496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE:
2250c609719bSwdenk		Physical start address of Flash memory.
2251c609719bSwdenk
22526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE:
2253c609719bSwdenk		Physical start address of boot monitor code (set by
2254c609719bSwdenk		make config files to be same as the text base address
225514d0a02aSWolfgang Denk		(CONFIG_SYS_TEXT_BASE) used when linking) - same as
22566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FLASH_BASE when booting from flash.
2257c609719bSwdenk
22586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN:
22593b57fe0aSwdenk		Size of memory reserved for monitor code, used to
22603b57fe0aSwdenk		determine _at_compile_time_ (!) if the environment is
22613b57fe0aSwdenk		embedded within the U-Boot image, or in a separate
22623b57fe0aSwdenk		flash sector.
2263c609719bSwdenk
22646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN:
2265c609719bSwdenk		Size of DRAM reserved for malloc() use.
2266c609719bSwdenk
22676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN:
226815940c9aSStefan Roese		Normally compressed uImages are limited to an
226915940c9aSStefan Roese		uncompressed size of 8 MBytes. If this is not enough,
22706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		you can define CONFIG_SYS_BOOTM_LEN in your board config file
227115940c9aSStefan Roese		to adjust this setting to your needs.
2272c609719bSwdenk
22736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ:
2274c609719bSwdenk		Maximum size of memory mapped by the startup code of
2275c609719bSwdenk		the Linux kernel; all data that must be processed by
22767d721e34SBartlomiej Sieka		the Linux kernel (bd_info, boot arguments, FDT blob if
22777d721e34SBartlomiej Sieka		used) must be put below this limit, unless "bootm_low"
22787d721e34SBartlomiej Sieka		enviroment variable is defined and non-zero. In such case
22797d721e34SBartlomiej Sieka		all data for the Linux kernel must be between "bootm_low"
22806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.
2281c609719bSwdenk
2282fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_RAMDISK_HIGH:
2283fca43cc8SJohn Rigby		Enable initrd_high functionality.  If defined then the
2284fca43cc8SJohn Rigby		initrd_high feature is enabled and the bootm ramdisk subcommand
2285fca43cc8SJohn Rigby		is enabled.
2286fca43cc8SJohn Rigby
2287fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_CMDLINE:
2288fca43cc8SJohn Rigby		Enables allocating and saving kernel cmdline in space between
2289fca43cc8SJohn Rigby		"bootm_low" and "bootm_low" + BOOTMAPSZ.
2290fca43cc8SJohn Rigby
2291fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_KBD:
2292fca43cc8SJohn Rigby		Enables allocating and saving a kernel copy of the bd_info in
2293fca43cc8SJohn Rigby		space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
2294fca43cc8SJohn Rigby
22956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS:
2296c609719bSwdenk		Max number of Flash memory banks
2297c609719bSwdenk
22986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT:
2299c609719bSwdenk		Max number of sectors on a Flash chip
2300c609719bSwdenk
23016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT:
2302c609719bSwdenk		Timeout for Flash erase operations (in ms)
2303c609719bSwdenk
23046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT:
2305c609719bSwdenk		Timeout for Flash write operations (in ms)
2306c609719bSwdenk
23076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT
23088564acf9Swdenk		Timeout for Flash set sector lock bit operation (in ms)
23098564acf9Swdenk
23106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT
23118564acf9Swdenk		Timeout for Flash clear lock bits operation (in ms)
23128564acf9Swdenk
23136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION
23148564acf9Swdenk		If defined, hardware flash sectors protection is used
23158564acf9Swdenk		instead of U-Boot software protection.
23168564acf9Swdenk
23176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP:
2318c609719bSwdenk
2319c609719bSwdenk		Enable TFTP transfers directly to flash memory;
2320c609719bSwdenk		without this option such a download has to be
2321c609719bSwdenk		performed in two steps: (1) download to RAM, and (2)
2322c609719bSwdenk		copy from RAM to flash.
2323c609719bSwdenk
2324c609719bSwdenk		The two-step approach is usually more reliable, since
2325c609719bSwdenk		you can check if the download worked before you erase
232611ccc33fSMarcel Ziswiler		the flash, but in some situations (when system RAM is
232711ccc33fSMarcel Ziswiler		too limited to allow for a temporary copy of the
2328c609719bSwdenk		downloaded image) this option may be very useful.
2329c609719bSwdenk
23306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI:
2331c609719bSwdenk		Define if the flash driver uses extra elements in the
23325653fc33Swdenk		common flash structure for storing flash geometry.
23335653fc33Swdenk
233400b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER
23355653fc33Swdenk		This option also enables the building of the cfi_flash driver
23365653fc33Swdenk		in the drivers directory
233753cf9435Sstroese
233891809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD
233991809ed5SPiotr Ziecik		This option enables the building of the cfi_mtd driver
234091809ed5SPiotr Ziecik		in the drivers directory. The driver exports CFI flash
234191809ed5SPiotr Ziecik		to the MTD layer.
234291809ed5SPiotr Ziecik
23436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
234496ef831fSGuennadi Liakhovetski		Use buffered writes to flash.
234596ef831fSGuennadi Liakhovetski
234696ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N
234796ef831fSGuennadi Liakhovetski		s29ws-n MirrorBit flash has non-standard addresses for buffered
234896ef831fSGuennadi Liakhovetski		write commands.
234996ef831fSGuennadi Liakhovetski
23506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST
23515568e613SStefan Roese		If this option is defined, the common CFI flash doesn't
23525568e613SStefan Roese		print it's warning upon not recognized FLASH banks. This
23535568e613SStefan Roese		is useful, if some of the configured banks are only
23545568e613SStefan Roese		optionally available.
23555568e613SStefan Roese
23569a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS
23579a042e9cSJerry Van Baren		If defined (must be an integer), print out countdown
23589a042e9cSJerry Van Baren		digits and dots.  Recommended value: 45 (9..1) for 80
23599a042e9cSJerry Van Baren		column displays, 15 (3..1) for 40 column displays.
23609a042e9cSJerry Van Baren
23616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER:
236211ccc33fSMarcel Ziswiler		Defines the number of Ethernet receive buffers. On some
236311ccc33fSMarcel Ziswiler		Ethernet controllers it is recommended to set this value
236453cf9435Sstroese		to 8 or even higher (EEPRO100 or 405 EMAC), since all
236553cf9435Sstroese		buffers can be full shortly after enabling the interface
236611ccc33fSMarcel Ziswiler		on high Ethernet traffic.
236753cf9435Sstroese		Defaults to 4 if not defined.
2368c609719bSwdenk
2369ea882bafSWolfgang Denk- CONFIG_ENV_MAX_ENTRIES
2370ea882bafSWolfgang Denk
2371ea882bafSWolfgang Denk	Maximum number of entries in the hash table that is used
2372ea882bafSWolfgang Denk	internally to store the environment settings. The default
2373ea882bafSWolfgang Denk	setting is supposed to be generous and should work in most
2374ea882bafSWolfgang Denk	cases. This setting can be used to tune behaviour; see
2375ea882bafSWolfgang Denk	lib/hashtable.c for details.
2376ea882bafSWolfgang Denk
2377c609719bSwdenkThe following definitions that deal with the placement and management
2378c609719bSwdenkof environment data (variable area); in general, we support the
2379c609719bSwdenkfollowing configurations:
2380c609719bSwdenk
23815a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH:
2382c609719bSwdenk
2383c609719bSwdenk	Define this if the environment is in flash memory.
2384c609719bSwdenk
2385c609719bSwdenk	a) The environment occupies one whole flash sector, which is
2386c609719bSwdenk	   "embedded" in the text segment with the U-Boot code. This
2387c609719bSwdenk	   happens usually with "bottom boot sector" or "top boot
2388c609719bSwdenk	   sector" type flash chips, which have several smaller
2389c609719bSwdenk	   sectors at the start or the end. For instance, such a
2390c609719bSwdenk	   layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
2391c609719bSwdenk	   such a case you would place the environment in one of the
2392c609719bSwdenk	   4 kB sectors - with U-Boot code before and after it. With
2393c609719bSwdenk	   "top boot sector" type flash chips, you would put the
2394c609719bSwdenk	   environment in one of the last sectors, leaving a gap
2395c609719bSwdenk	   between U-Boot and the environment.
2396c609719bSwdenk
23970e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
2398c609719bSwdenk
2399c609719bSwdenk	   Offset of environment data (variable area) to the
2400c609719bSwdenk	   beginning of flash memory; for instance, with bottom boot
2401c609719bSwdenk	   type flash chips the second sector can be used: the offset
2402c609719bSwdenk	   for this sector is given here.
2403c609719bSwdenk
24046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
2405c609719bSwdenk
24060e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
2407c609719bSwdenk
2408c609719bSwdenk	   This is just another way to specify the start address of
2409c609719bSwdenk	   the flash sector containing the environment (instead of
24100e8d1586SJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET).
2411c609719bSwdenk
24120e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SECT_SIZE:
2413c609719bSwdenk
2414c609719bSwdenk	   Size of the sector containing the environment.
2415c609719bSwdenk
2416c609719bSwdenk
2417c609719bSwdenk	b) Sometimes flash chips have few, equal sized, BIG sectors.
2418c609719bSwdenk	   In such a case you don't want to spend a whole sector for
2419c609719bSwdenk	   the environment.
2420c609719bSwdenk
24210e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
2422c609719bSwdenk
24235a1aceb0SJean-Christophe PLAGNIOL-VILLARD	   If you use this in combination with CONFIG_ENV_IS_IN_FLASH
24240e8d1586SJean-Christophe PLAGNIOL-VILLARD	   and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
2425c609719bSwdenk	   of this flash sector for the environment. This saves
2426c609719bSwdenk	   memory for the RAM copy of the environment.
2427c609719bSwdenk
2428c609719bSwdenk	   It may also save flash memory if you decide to use this
2429c609719bSwdenk	   when your environment is "embedded" within U-Boot code,
2430c609719bSwdenk	   since then the remainder of the flash sector could be used
2431c609719bSwdenk	   for U-Boot code. It should be pointed out that this is
2432c609719bSwdenk	   STRONGLY DISCOURAGED from a robustness point of view:
2433c609719bSwdenk	   updating the environment in flash makes it always
2434c609719bSwdenk	   necessary to erase the WHOLE sector. If something goes
2435c609719bSwdenk	   wrong before the contents has been restored from a copy in
2436c609719bSwdenk	   RAM, your target system will be dead.
2437c609719bSwdenk
24380e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR_REDUND
24390e8d1586SJean-Christophe PLAGNIOL-VILLARD	  CONFIG_ENV_SIZE_REDUND
2440c609719bSwdenk
2441c609719bSwdenk	   These settings describe a second storage area used to hold
244211ccc33fSMarcel Ziswiler	   a redundant copy of the environment data, so that there is
24433e38691eSwdenk	   a valid backup copy in case there is a power failure during
2444c609719bSwdenk	   a "saveenv" operation.
2445c609719bSwdenk
2446c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the
2447c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds*
2448c609719bSwdenkaccordingly!
2449c609719bSwdenk
2450c609719bSwdenk
24519314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM:
2452c609719bSwdenk
2453c609719bSwdenk	Define this if you have some non-volatile memory device
2454c609719bSwdenk	(NVRAM, battery buffered SRAM) which you want to use for the
2455c609719bSwdenk	environment.
2456c609719bSwdenk
24570e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
24580e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
2459c609719bSwdenk
246011ccc33fSMarcel Ziswiler	  These two #defines are used to determine the memory area you
2461c609719bSwdenk	  want to use for environment. It is assumed that this memory
2462c609719bSwdenk	  can just be read and written to, without any special
2463c609719bSwdenk	  provision.
2464c609719bSwdenk
2465c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early
2466c609719bSwdenkin U-Boot initalization (when we try to get the setting of for the
246711ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or
2468c609719bSwdenkU-Boot will hang.
2469c609719bSwdenk
2470c609719bSwdenkPlease note that even with NVRAM we still use a copy of the
2471c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to
2472c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv"
2473c609719bSwdenkto save the current settings.
2474c609719bSwdenk
2475c609719bSwdenk
2476bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM:
2477c609719bSwdenk
2478c609719bSwdenk	Use this if you have an EEPROM or similar serial access
2479c609719bSwdenk	device and a driver for it.
2480c609719bSwdenk
24810e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
24820e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
2483c609719bSwdenk
2484c609719bSwdenk	  These two #defines specify the offset and size of the
2485c609719bSwdenk	  environment area within the total memory of your EEPROM.
2486c609719bSwdenk
24876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR:
2488c609719bSwdenk	  If defined, specified the chip address of the EEPROM device.
2489c609719bSwdenk	  The default address is zero.
2490c609719bSwdenk
24916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
2492c609719bSwdenk	  If defined, the number of bits used to address bytes in a
2493c609719bSwdenk	  single page in the EEPROM device.  A 64 byte page, for example
2494c609719bSwdenk	  would require six bits.
2495c609719bSwdenk
24966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
2497c609719bSwdenk	  If defined, the number of milliseconds to delay between
2498c609719bSwdenk	  page writes.	The default is zero milliseconds.
2499c609719bSwdenk
25006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
2501c609719bSwdenk	  The length in bytes of the EEPROM memory array address.  Note
2502c609719bSwdenk	  that this is NOT the chip address length!
2503c609719bSwdenk
25046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
25055cf91d6bSwdenk	  EEPROM chips that implement "address overflow" are ones
25065cf91d6bSwdenk	  like Catalyst 24WC04/08/16 which has 9/10/11 bits of
25075cf91d6bSwdenk	  address and the extra bits end up in the "chip address" bit
25085cf91d6bSwdenk	  slots. This makes a 24WC08 (1Kbyte) chip look like four 256
25095cf91d6bSwdenk	  byte chips.
25105cf91d6bSwdenk
25115cf91d6bSwdenk	  Note that we consider the length of the address field to
25125cf91d6bSwdenk	  still be one byte because the extra address bits are hidden
25135cf91d6bSwdenk	  in the chip address.
25145cf91d6bSwdenk
25156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_SIZE:
2516c609719bSwdenk	  The size in bytes of the EEPROM device.
2517c609719bSwdenk
2518548738b4SHeiko Schocher	- CONFIG_ENV_EEPROM_IS_ON_I2C
2519548738b4SHeiko Schocher	  define this, if you have I2C and SPI activated, and your
2520548738b4SHeiko Schocher	  EEPROM, which holds the environment, is on the I2C bus.
2521548738b4SHeiko Schocher
2522548738b4SHeiko Schocher	- CONFIG_I2C_ENV_EEPROM_BUS
2523548738b4SHeiko Schocher	  if you have an Environment on an EEPROM reached over
2524548738b4SHeiko Schocher	  I2C muxes, you can define here, how to reach this
2525548738b4SHeiko Schocher	  EEPROM. For example:
2526548738b4SHeiko Schocher
2527548738b4SHeiko Schocher	  #define CONFIG_I2C_ENV_EEPROM_BUS	  "pca9547:70:d\0"
2528548738b4SHeiko Schocher
2529548738b4SHeiko Schocher	  EEPROM which holds the environment, is reached over
2530548738b4SHeiko Schocher	  a pca9547 i2c mux with address 0x70, channel 3.
2531c609719bSwdenk
2532057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH:
25335779d8d9Swdenk
25345779d8d9Swdenk	Define this if you have a DataFlash memory device which you
25355779d8d9Swdenk	want to use for the environment.
25365779d8d9Swdenk
25370e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
25380e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
25390e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
25405779d8d9Swdenk
25415779d8d9Swdenk	  These three #defines specify the offset and size of the
25425779d8d9Swdenk	  environment area within the total memory of your DataFlash placed
25435779d8d9Swdenk	  at the specified address.
25445779d8d9Swdenk
254551bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND:
254613a5695bSwdenk
254713a5695bSwdenk	Define this if you have a NAND device which you want to use
254813a5695bSwdenk	for the environment.
254913a5695bSwdenk
25500e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
25510e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
255213a5695bSwdenk
255313a5695bSwdenk	  These two #defines specify the offset and size of the environment
2554fdd813deSScott Wood	  area within the first NAND device.  CONFIG_ENV_OFFSET must be
2555fdd813deSScott Wood	  aligned to an erase block boundary.
25565779d8d9Swdenk
2557fdd813deSScott Wood	- CONFIG_ENV_OFFSET_REDUND (optional):
2558e443c944SMarkus Klotzbuecher
25590e8d1586SJean-Christophe PLAGNIOL-VILLARD	  This setting describes a second storage area of CONFIG_ENV_SIZE
2560fdd813deSScott Wood	  size used to hold a redundant copy of the environment data, so
2561fdd813deSScott Wood	  that there is a valid backup copy in case there is a power failure
2562fdd813deSScott Wood	  during a "saveenv" operation.  CONFIG_ENV_OFFSET_RENDUND must be
2563fdd813deSScott Wood	  aligned to an erase block boundary.
2564e443c944SMarkus Klotzbuecher
2565fdd813deSScott Wood	- CONFIG_ENV_RANGE (optional):
2566fdd813deSScott Wood
2567fdd813deSScott Wood	  Specifies the length of the region in which the environment
2568fdd813deSScott Wood	  can be written.  This should be a multiple of the NAND device's
2569fdd813deSScott Wood	  block size.  Specifying a range with more erase blocks than
2570fdd813deSScott Wood	  are needed to hold CONFIG_ENV_SIZE allows bad blocks within
2571fdd813deSScott Wood	  the range to be avoided.
2572fdd813deSScott Wood
2573fdd813deSScott Wood	- CONFIG_ENV_OFFSET_OOB (optional):
2574fdd813deSScott Wood
2575fdd813deSScott Wood	  Enables support for dynamically retrieving the offset of the
2576fdd813deSScott Wood	  environment from block zero's out-of-band data.  The
2577fdd813deSScott Wood	  "nand env.oob" command can be used to record this offset.
2578fdd813deSScott Wood	  Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
2579fdd813deSScott Wood	  using CONFIG_ENV_OFFSET_OOB.
2580e443c944SMarkus Klotzbuecher
2581b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST
2582b74ab737SGuennadi Liakhovetski
2583b74ab737SGuennadi Liakhovetski	Defines address in RAM to which the nand_spl code should copy the
2584b74ab737SGuennadi Liakhovetski	environment. If redundant environment is used, it will be copied to
2585b74ab737SGuennadi Liakhovetski	CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
2586b74ab737SGuennadi Liakhovetski
25876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET
2588c609719bSwdenk
2589c609719bSwdenk	Defines offset to the initial SPI buffer area in DPRAM. The
2590c609719bSwdenk	area is used at an early stage (ROM part) if the environment
2591c609719bSwdenk	is configured to reside in the SPI EEPROM: We need a 520 byte
2592c609719bSwdenk	scratch DPRAM area. It is used between the two initialization
2593c609719bSwdenk	calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
2594c609719bSwdenk	to be a good choice since it makes it far enough from the
2595c609719bSwdenk	start of the data area as well as from the stack pointer.
2596c609719bSwdenk
2597e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor
2598c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been
2599cdb74977SWolfgang Denkcreated; also, when using EEPROM you will have to use getenv_f()
2600c609719bSwdenkuntil then to read environment variables.
2601c609719bSwdenk
260285ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor
260385ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working
260485ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is
260585ec0bccSwdenknecessary, because the first environment variable we need is the
260685ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't
260785ec0bccSwdenkhave any device yet where we could complain.]
2608c609719bSwdenk
2609c609719bSwdenkNote: once the monitor has been relocated, then it will complain if
2610c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you
261185ec0bccSwdenkuse the "saveenv" command to store a valid environment.
2612c609719bSwdenk
26136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
2614fc3e2165Swdenk		Echo the inverted Ethernet link state to the fault LED.
2615fc3e2165Swdenk
26166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
2617fc3e2165Swdenk		      also needs to be defined.
2618fc3e2165Swdenk
26196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR:
2620fc3e2165Swdenk		MII address of the PHY to check for the Ethernet link state.
2621c609719bSwdenk
2622f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS:
2623f5675aa5SRon Madrid		Define this if you desire to only have use of the NS16550_init
2624f5675aa5SRon Madrid		and NS16550_putc functions for the serial driver located at
2625f5675aa5SRon Madrid		drivers/serial/ns16550.c.  This option is useful for saving
2626f5675aa5SRon Madrid		space for already greatly restricted images, including but not
2627f5675aa5SRon Madrid		limited to NAND_SPL configurations.
2628f5675aa5SRon Madrid
2629c609719bSwdenkLow Level (hardware related) configuration options:
2630dc7c9a1aSwdenk---------------------------------------------------
2631c609719bSwdenk
26326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE:
2633c609719bSwdenk		Cache Line Size of the CPU.
2634c609719bSwdenk
26356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR:
2636c609719bSwdenk		Default address of the IMMR after system reset.
26372535d602Swdenk
26382535d602Swdenk		Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
26392535d602Swdenk		and RPXsuper) to be able to adjust the position of
26402535d602Swdenk		the IMMR register after a reset.
2641c609719bSwdenk
26427f6c2cbcSwdenk- Floppy Disk Support:
26436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER
26447f6c2cbcSwdenk
26457f6c2cbcSwdenk		the default drive number (default value 0)
26467f6c2cbcSwdenk
26476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_STRIDE
26487f6c2cbcSwdenk
264911ccc33fSMarcel Ziswiler		defines the spacing between FDC chipset registers
26507f6c2cbcSwdenk		(default value 1)
26517f6c2cbcSwdenk
26526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_OFFSET
26537f6c2cbcSwdenk
26547f6c2cbcSwdenk		defines the offset of register from address. It
26557f6c2cbcSwdenk		depends on which part of the data bus is connected to
265611ccc33fSMarcel Ziswiler		the FDC chipset. (default value 0)
26577f6c2cbcSwdenk
26586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
26596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
26607f6c2cbcSwdenk		default value.
26617f6c2cbcSwdenk
26626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		if CONFIG_SYS_FDC_HW_INIT is defined, then the function
26637f6c2cbcSwdenk		fdc_hw_init() is called at the beginning of the FDC
26647f6c2cbcSwdenk		setup. fdc_hw_init() must be provided by the board
26657f6c2cbcSwdenk		source code. It is used to make hardware dependant
26667f6c2cbcSwdenk		initializations.
26677f6c2cbcSwdenk
26686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR:	Physical address of the Internal Memory.
266925d6712aSwdenk		DO NOT CHANGE unless you know exactly what you're
267025d6712aSwdenk		doing! (11-4) [MPC8xx/82xx systems only]
2671c609719bSwdenk
26726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR:
2673c609719bSwdenk
26747152b1d0Swdenk		Start address of memory area that can be used for
2675c609719bSwdenk		initial data and stack; please note that this must be
2676c609719bSwdenk		writable memory that is working WITHOUT special
2677c609719bSwdenk		initialization, i. e. you CANNOT use normal RAM which
2678c609719bSwdenk		will become available only after programming the
2679c609719bSwdenk		memory controller and running certain initialization
2680c609719bSwdenk		sequences.
2681c609719bSwdenk
2682c609719bSwdenk		U-Boot uses the following memory types:
2683c609719bSwdenk		- MPC8xx and MPC8260: IMMR (internal memory of the CPU)
2684c609719bSwdenk		- MPC824X: data cache
2685c609719bSwdenk		- PPC4xx:  data cache
2686c609719bSwdenk
26876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET:
2688c609719bSwdenk
2689c609719bSwdenk		Offset of the initial data structure in the memory
26906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
26916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
2692c609719bSwdenk		data is located at the end of the available space
2693553f0982SWolfgang Denk		(sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
26946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
26956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
26966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET) downward.
2697c609719bSwdenk
2698c609719bSwdenk	Note:
2699c609719bSwdenk		On the MPC824X (or other systems that use the data
2700c609719bSwdenk		cache for initial memory) the address chosen for
27016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
2702c609719bSwdenk		point to an otherwise UNUSED address space between
2703c609719bSwdenk		the top of RAM and the start of the PCI space.
2704c609719bSwdenk
27056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR:	SIU Module Configuration (11-6)
2706c609719bSwdenk
27076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR:	System Protection Control (11-9)
2708c609719bSwdenk
27096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR:	Time Base Status and Control (11-26)
2710c609719bSwdenk
27116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR:	Periodic Interrupt Status and Control (11-31)
2712c609719bSwdenk
27136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR:	PLL, Low-Power, and Reset Control Register (15-30)
2714c609719bSwdenk
27156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR:	System Clock and reset Control Register (15-27)
2716c609719bSwdenk
27176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM:
2718c609719bSwdenk		SDRAM timing
2719c609719bSwdenk
27206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA:
2721c609719bSwdenk		periodic timer for refresh
2722c609719bSwdenk
27236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER:	Debug Event Register (37-47)
2724c609719bSwdenk
27256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
27266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
27276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
27286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_BR1_PRELIM:
2729c609719bSwdenk		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
2730c609719bSwdenk
2731c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
27326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
27336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
2734c609719bSwdenk		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
2735c609719bSwdenk
27366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
27376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
2738c609719bSwdenk		Machine Mode Register and Memory Periodic Timer
2739c609719bSwdenk		Prescaler definitions (SDRAM timing)
2740c609719bSwdenk
27416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
2742c609719bSwdenk		enable I2C microcode relocation patch (MPC8xx);
2743c609719bSwdenk		define relocation offset in DPRAM [DSP2]
2744c609719bSwdenk
27456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
2746b423d055SHeiko Schocher		enable SMC microcode relocation patch (MPC8xx);
2747b423d055SHeiko Schocher		define relocation offset in DPRAM [SMC1]
2748b423d055SHeiko Schocher
27496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
2750c609719bSwdenk		enable SPI microcode relocation patch (MPC8xx);
2751c609719bSwdenk		define relocation offset in DPRAM [SCC4]
2752c609719bSwdenk
27536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_USE_OSCCLK:
2754c609719bSwdenk		Use OSCM clock mode on MBX8xx board. Be careful,
2755c609719bSwdenk		wrong setting might damage your board. Read
2756c609719bSwdenk		doc/README.MBX before setting this variable!
2757c609719bSwdenk
27586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
2759ea909b76Swdenk		Offset of the bootmode word in DPRAM used by post
2760ea909b76Swdenk		(Power On Self Tests). This definition overrides
2761ea909b76Swdenk		#define'd default value in commproc.h resp.
2762ea909b76Swdenk		cpm_8260.h.
2763ea909b76Swdenk
27646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
27656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
27666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
27676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
27686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
27696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
27706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
27716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
2772a47a12beSStefan Roese		Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
27735d232d0eSwdenk
27749cacf4fcSDirk Eibach- CONFIG_PCI_DISABLE_PCIE:
27759cacf4fcSDirk Eibach		Disable PCI-Express on systems where it is supported but not
27769cacf4fcSDirk Eibach		required.
27779cacf4fcSDirk Eibach
2778bb99ad6dSBen Warren- CONFIG_SPD_EEPROM
2779218ca724SWolfgang Denk		Get DDR timing information from an I2C EEPROM. Common
2780218ca724SWolfgang Denk		with pluggable memory modules such as SODIMMs
2781218ca724SWolfgang Denk
2782bb99ad6dSBen Warren  SPD_EEPROM_ADDRESS
2783bb99ad6dSBen Warren		I2C address of the SPD EEPROM
2784bb99ad6dSBen Warren
27856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM
2786218ca724SWolfgang Denk		If SPD EEPROM is on an I2C bus other than the first
2787218ca724SWolfgang Denk		one, specify here. Note that the value must resolve
2788218ca724SWolfgang Denk		to something your driver can deal with.
2789bb99ad6dSBen Warren
27906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0
2791218ca724SWolfgang Denk		Only for 83xx systems. If specified, then DDR should
2792218ca724SWolfgang Denk		be configured using CS0 and CS1 instead of CS2 and CS3.
27932ad6b513STimur Tabi
2794c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12]
2795c26e454dSwdenk		Define to enable FEC[12] on a 8xx series processor.
2796c26e454dSwdenk
2797c26e454dSwdenk- CONFIG_FEC[12]_PHY
2798c26e454dSwdenk		Define to the hardcoded PHY address which corresponds
27996e592385Swdenk		to the given FEC; i. e.
2800c26e454dSwdenk			#define CONFIG_FEC1_PHY 4
2801c26e454dSwdenk		means that the PHY with address 4 is connected to FEC1
2802c26e454dSwdenk
2803c26e454dSwdenk		When set to -1, means to probe for first available.
2804c26e454dSwdenk
2805c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR
2806c26e454dSwdenk		The PHY does not have a RXERR line (RMII only).
2807c26e454dSwdenk		(so program the FEC to ignore it).
2808c26e454dSwdenk
2809c26e454dSwdenk- CONFIG_RMII
2810c26e454dSwdenk		Enable RMII mode for all FECs.
2811c26e454dSwdenk		Note that this is a global option, we can't
2812c26e454dSwdenk		have one FEC in standard MII mode and another in RMII mode.
2813c26e454dSwdenk
28145cf91d6bSwdenk- CONFIG_CRC32_VERIFY
28155cf91d6bSwdenk		Add a verify option to the crc32 command.
28165cf91d6bSwdenk		The syntax is:
28175cf91d6bSwdenk
28185cf91d6bSwdenk		=> crc32 -v <address> <count> <crc32>
28195cf91d6bSwdenk
28205cf91d6bSwdenk		Where address/count indicate a memory area
28215cf91d6bSwdenk		and crc32 is the correct crc32 which the
28225cf91d6bSwdenk		area should have.
28235cf91d6bSwdenk
282456523f12Swdenk- CONFIG_LOOPW
282556523f12Swdenk		Add the "loopw" memory command. This only takes effect if
2826602ad3b3SJon Loeliger		the memory commands are activated globally (CONFIG_CMD_MEM).
282756523f12Swdenk
28287b466641Sstroese- CONFIG_MX_CYCLIC
28297b466641Sstroese		Add the "mdc" and "mwc" memory commands. These are cyclic
28307b466641Sstroese		"md/mw" commands.
28317b466641Sstroese		Examples:
28327b466641Sstroese
28337b466641Sstroese		=> mdc.b 10 4 500
28347b466641Sstroese		This command will print 4 bytes (10,11,12,13) each 500 ms.
28357b466641Sstroese
28367b466641Sstroese		=> mwc.l 100 12345678 10
28377b466641Sstroese		This command will write 12345678 to address 100 all 10 ms.
28387b466641Sstroese
28397b466641Sstroese		This only takes effect if the memory commands are activated
2840602ad3b3SJon Loeliger		globally (CONFIG_CMD_MEM).
28417b466641Sstroese
28428aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT
2843e03f3169SWolfgang Denk		[ARM only] If this variable is defined, then certain
2844e03f3169SWolfgang Denk		low level initializations (like setting up the memory
2845e03f3169SWolfgang Denk		controller) are omitted and/or U-Boot does not
2846e03f3169SWolfgang Denk		relocate itself into RAM.
28478aa1a2d1Swdenk
2848e03f3169SWolfgang Denk		Normally this variable MUST NOT be defined. The only
2849e03f3169SWolfgang Denk		exception is when U-Boot is loaded (to RAM) by some
2850e03f3169SWolfgang Denk		other boot loader or by a debugger which performs
2851e03f3169SWolfgang Denk		these initializations itself.
28528aa1a2d1Swdenk
2853df81238bSMagnus Lilja- CONFIG_PRELOADER
2854df81238bSMagnus Lilja		Modifies the behaviour of start.S when compiling a loader
2855df81238bSMagnus Lilja		that is executed before the actual U-Boot. E.g. when
2856df81238bSMagnus Lilja		compiling a NAND SPL.
2857400558b5Swdenk
2858c609719bSwdenkBuilding the Software:
2859c609719bSwdenk======================
2860c609719bSwdenk
2861218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments
2862218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support
2863218ca724SWolfgang Denkall possibly existing versions of cross development tools in all
2864218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we
2865218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
2866218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot.
2867c609719bSwdenk
2868218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you
2869218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case,
2870218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell.
2871218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are
2872218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter:
2873c609719bSwdenk
2874218ca724SWolfgang Denk	$ CROSS_COMPILE=ppc_4xx-
2875218ca724SWolfgang Denk	$ export CROSS_COMPILE
2876c609719bSwdenk
28772f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in
28782f8d396bSPeter Tyser      the tools directory you can use the MinGW toolchain
28792f8d396bSPeter Tyser      (http://www.mingw.org).  Set your HOST tools to the MinGW
28802f8d396bSPeter Tyser      toolchain and execute 'make tools'.  For example:
28812f8d396bSPeter Tyser
28822f8d396bSPeter Tyser       $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
28832f8d396bSPeter Tyser
28842f8d396bSPeter Tyser      Binaries such as tools/mkimage.exe will be created which can
28852f8d396bSPeter Tyser      be executed on computers running Windows.
28862f8d396bSPeter Tyser
2887c609719bSwdenkU-Boot is intended to be simple to build. After installing the
2888c609719bSwdenksources you must configure U-Boot for one specific board type. This
2889c609719bSwdenkis done by typing:
2890c609719bSwdenk
2891c609719bSwdenk	make NAME_config
2892c609719bSwdenk
2893218ca724SWolfgang Denkwhere "NAME_config" is the name of one of the existing configu-
2894218ca724SWolfgang Denkrations; see the main Makefile for supported names.
289554387ac9Swdenk
2896c609719bSwdenkNote: for some board special configuration names may exist; check if
2897c609719bSwdenk      additional information is available from the board vendor; for
28982729af9dSwdenk      instance, the TQM823L systems are available without (standard)
28992729af9dSwdenk      or with LCD support. You can select such additional "features"
290011ccc33fSMarcel Ziswiler      when choosing the configuration, i. e.
2901c609719bSwdenk
29022729af9dSwdenk      make TQM823L_config
29032729af9dSwdenk	- will configure for a plain TQM823L, i. e. no LCD support
2904c609719bSwdenk
2905c609719bSwdenk      make TQM823L_LCD_config
2906c609719bSwdenk	- will configure for a TQM823L with U-Boot console on LCD
2907c609719bSwdenk
2908c609719bSwdenk      etc.
2909c609719bSwdenk
2910c609719bSwdenk
2911c609719bSwdenkFinally, type "make all", and you should get some working U-Boot
29127152b1d0Swdenkimages ready for download to / installation on your system:
2913c609719bSwdenk
2914c609719bSwdenk- "u-boot.bin" is a raw binary image
2915c609719bSwdenk- "u-boot" is an image in ELF binary format
2916c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format
2917c609719bSwdenk
2918baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved
2919baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change
2920baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory:
2921baf31249SMarian Balakowicz
2922baf31249SMarian Balakowicz1. Add O= to the make command line invocations:
2923baf31249SMarian Balakowicz
2924baf31249SMarian Balakowicz	make O=/tmp/build distclean
2925baf31249SMarian Balakowicz	make O=/tmp/build NAME_config
2926baf31249SMarian Balakowicz	make O=/tmp/build all
2927baf31249SMarian Balakowicz
2928baf31249SMarian Balakowicz2. Set environment variable BUILD_DIR to point to the desired location:
2929baf31249SMarian Balakowicz
2930baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
2931baf31249SMarian Balakowicz	make distclean
2932baf31249SMarian Balakowicz	make NAME_config
2933baf31249SMarian Balakowicz	make all
2934baf31249SMarian Balakowicz
2935baf31249SMarian BalakowiczNote that the command line "O=" setting overrides the BUILD_DIR environment
2936baf31249SMarian Balakowiczvariable.
2937baf31249SMarian Balakowicz
2938c609719bSwdenk
2939c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so
2940c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of
2941c609719bSwdenknative "make".
2942c609719bSwdenk
2943c609719bSwdenk
2944c609719bSwdenkIf the system board that you have is not listed, then you will need
2945c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these
2946c609719bSwdenksteps:
2947c609719bSwdenk
2948c609719bSwdenk1.  Add a new configuration option for your board to the toplevel
294985ec0bccSwdenk    "Makefile" and to the "MAKEALL" script, using the existing
295085ec0bccSwdenk    entries as examples. Note that here and at many other places
29517152b1d0Swdenk    boards and other names are listed in alphabetical sort order. Please
295285ec0bccSwdenk    keep this order.
2953c609719bSwdenk2.  Create a new directory to hold your board specific code. Add any
295485ec0bccSwdenk    files you need. In your board directory, you will need at least
295585ec0bccSwdenk    the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
295685ec0bccSwdenk3.  Create a new configuration file "include/configs/<board>.h" for
295785ec0bccSwdenk    your board
2958c609719bSwdenk3.  If you're porting U-Boot to a new CPU, then also create a new
2959c609719bSwdenk    directory to hold your CPU specific code. Add any files you need.
296085ec0bccSwdenk4.  Run "make <board>_config" with your new name.
2961c609719bSwdenk5.  Type "make", and you should get a working "u-boot.srec" file
2962c609719bSwdenk    to be installed on your target system.
296385ec0bccSwdenk6.  Debug and solve any problems that might arise.
2964c609719bSwdenk    [Of course, this last step is much harder than it sounds.]
2965c609719bSwdenk
2966c609719bSwdenk
2967c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.:
2968c609719bSwdenk==============================================================
2969c609719bSwdenk
2970c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board
2971c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to
2972c609719bSwdenkprovide feedback to the other developers. The feedback normally takes
2973c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest
2974218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources.
2975c609719bSwdenk
2976c609719bSwdenkBut before you submit such a patch, please verify that your modifi-
2977c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of
2978c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so,
2979c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot
2980c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You can
29817152b1d0Swdenkselect which (cross) compiler to use by passing a `CROSS_COMPILE'
2982218ca724SWolfgang Denkenvironment variable to the script, i. e. to use the ELDK cross tools
2983218ca724SWolfgang Denkyou can type
2984c609719bSwdenk
2985c609719bSwdenk	CROSS_COMPILE=ppc_8xx- MAKEALL
2986c609719bSwdenk
2987c609719bSwdenkor to build on a native PowerPC system you can type
2988c609719bSwdenk
2989c609719bSwdenk	CROSS_COMPILE=' ' MAKEALL
2990c609719bSwdenk
2991218ca724SWolfgang DenkWhen using the MAKEALL script, the default behaviour is to build
2992218ca724SWolfgang DenkU-Boot in the source directory. This location can be changed by
2993218ca724SWolfgang Denksetting the BUILD_DIR environment variable. Also, for each target
2994218ca724SWolfgang Denkbuilt, the MAKEALL script saves two log files (<target>.ERR and
2995218ca724SWolfgang Denk<target>.MAKEALL) in the <source dir>/LOG directory. This default
2996218ca724SWolfgang Denklocation can be changed by setting the MAKEALL_LOGDIR environment
2997218ca724SWolfgang Denkvariable. For example:
2998baf31249SMarian Balakowicz
2999baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
3000baf31249SMarian Balakowicz	export MAKEALL_LOGDIR=/tmp/log
3001baf31249SMarian Balakowicz	CROSS_COMPILE=ppc_8xx- MAKEALL
3002baf31249SMarian Balakowicz
3003218ca724SWolfgang DenkWith the above settings build objects are saved in the /tmp/build,
3004218ca724SWolfgang Denklog files are saved in the /tmp/log and the source tree remains clean
3005218ca724SWolfgang Denkduring the whole build process.
3006baf31249SMarian Balakowicz
3007baf31249SMarian Balakowicz
3008c609719bSwdenkSee also "U-Boot Porting Guide" below.
3009c609719bSwdenk
3010c609719bSwdenk
3011c609719bSwdenkMonitor Commands - Overview:
3012c609719bSwdenk============================
3013c609719bSwdenk
3014c609719bSwdenkgo	- start application at address 'addr'
3015c609719bSwdenkrun	- run commands in an environment variable
3016c609719bSwdenkbootm	- boot application image from memory
3017c609719bSwdenkbootp	- boot image via network using BootP/TFTP protocol
3018c609719bSwdenktftpboot- boot image via network using TFTP protocol
3019c609719bSwdenk	       and env variables "ipaddr" and "serverip"
3020c609719bSwdenk	       (and eventually "gatewayip")
3021c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol
3022c609719bSwdenkdiskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
3023c609719bSwdenkloads	- load S-Record file over serial line
3024c609719bSwdenkloadb	- load binary file over serial line (kermit mode)
3025c609719bSwdenkmd	- memory display
3026c609719bSwdenkmm	- memory modify (auto-incrementing)
3027c609719bSwdenknm	- memory modify (constant address)
3028c609719bSwdenkmw	- memory write (fill)
3029c609719bSwdenkcp	- memory copy
3030c609719bSwdenkcmp	- memory compare
3031c609719bSwdenkcrc32	- checksum calculation
30320f89c54bSPeter Tyseri2c	- I2C sub-system
3033c609719bSwdenksspi	- SPI utility commands
3034c609719bSwdenkbase	- print or set address offset
3035c609719bSwdenkprintenv- print environment variables
3036c609719bSwdenksetenv	- set environment variables
3037c609719bSwdenksaveenv - save environment variables to persistent storage
3038c609719bSwdenkprotect - enable or disable FLASH write protection
3039c609719bSwdenkerase	- erase FLASH memory
3040c609719bSwdenkflinfo	- print FLASH memory information
3041c609719bSwdenkbdinfo	- print Board Info structure
3042c609719bSwdenkiminfo	- print header information for application image
3043c609719bSwdenkconinfo - print console devices and informations
3044c609719bSwdenkide	- IDE sub-system
3045c609719bSwdenkloop	- infinite loop on address range
304656523f12Swdenkloopw	- infinite write loop on address range
3047c609719bSwdenkmtest	- simple RAM test
3048c609719bSwdenkicache	- enable or disable instruction cache
3049c609719bSwdenkdcache	- enable or disable data cache
3050c609719bSwdenkreset	- Perform RESET of the CPU
3051c609719bSwdenkecho	- echo args to console
3052c609719bSwdenkversion - print monitor version
3053c609719bSwdenkhelp	- print online help
3054c609719bSwdenk?	- alias for 'help'
3055c609719bSwdenk
3056c609719bSwdenk
3057c609719bSwdenkMonitor Commands - Detailed Description:
3058c609719bSwdenk========================================
3059c609719bSwdenk
3060c609719bSwdenkTODO.
3061c609719bSwdenk
3062c609719bSwdenkFor now: just type "help <command>".
3063c609719bSwdenk
3064c609719bSwdenk
3065c609719bSwdenkEnvironment Variables:
3066c609719bSwdenk======================
3067c609719bSwdenk
3068c609719bSwdenkU-Boot supports user configuration using Environment Variables which
3069c609719bSwdenkcan be made persistent by saving to Flash memory.
3070c609719bSwdenk
3071c609719bSwdenkEnvironment Variables are set using "setenv", printed using
3072c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv"
3073c609719bSwdenkwithout a value can be used to delete a variable from the
3074c609719bSwdenkenvironment. As long as you don't save the environment you are
3075c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the
3076c609719bSwdenkenvironment is erased by accident, a default environment is provided.
3077c609719bSwdenk
3078c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables.
3079c96f86eeSWolfgang Denk
3080c96f86eeSWolfgang DenkList of environment variables (most likely not complete):
3081c609719bSwdenk
3082c609719bSwdenk  baudrate	- see CONFIG_BAUDRATE
3083c609719bSwdenk
3084c609719bSwdenk  bootdelay	- see CONFIG_BOOTDELAY
3085c609719bSwdenk
3086c609719bSwdenk  bootcmd	- see CONFIG_BOOTCOMMAND
3087c609719bSwdenk
3088c609719bSwdenk  bootargs	- Boot arguments when booting an RTOS image
3089c609719bSwdenk
3090c609719bSwdenk  bootfile	- Name of the image to load with TFTP
3091c609719bSwdenk
30927d721e34SBartlomiej Sieka  bootm_low	- Memory range available for image processing in the bootm
30937d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
30947d721e34SBartlomiej Sieka		  a hexadecimal number and defines lowest address allowed
30957d721e34SBartlomiej Sieka		  for use by the bootm command. See also "bootm_size"
30967d721e34SBartlomiej Sieka		  environment variable. Address defined by "bootm_low" is
30977d721e34SBartlomiej Sieka		  also the base of the initial memory mapping for the Linux
30986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		  kernel -- see the description of CONFIG_SYS_BOOTMAPSZ.
30997d721e34SBartlomiej Sieka
31007d721e34SBartlomiej Sieka  bootm_size	- Memory range available for image processing in the bootm
31017d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
31027d721e34SBartlomiej Sieka		  a hexadecimal number and defines the size of the region
31037d721e34SBartlomiej Sieka		  allowed for use by the bootm command. See also "bootm_low"
31047d721e34SBartlomiej Sieka		  environment variable.
31057d721e34SBartlomiej Sieka
31064bae9090SBartlomiej Sieka  updatefile	- Location of the software update file on a TFTP server, used
31074bae9090SBartlomiej Sieka		  by the automatic software update feature. Please refer to
31084bae9090SBartlomiej Sieka		  documentation in doc/README.update for more details.
31094bae9090SBartlomiej Sieka
3110c609719bSwdenk  autoload	- if set to "no" (any string beginning with 'n'),
3111c609719bSwdenk		  "bootp" will just load perform a lookup of the
3112c609719bSwdenk		  configuration from the BOOTP server, but not try to
3113c609719bSwdenk		  load any image using TFTP
3114c609719bSwdenk
3115c609719bSwdenk  autostart	- if set to "yes", an image loaded using the "bootp",
3116c609719bSwdenk		  "rarpboot", "tftpboot" or "diskboot" commands will
3117c609719bSwdenk		  be automatically started (by internally calling
3118c609719bSwdenk		  "bootm")
3119c609719bSwdenk
31204a6fd34bSwdenk		  If set to "no", a standalone image passed to the
31214a6fd34bSwdenk		  "bootm" command will be copied to the load address
31224a6fd34bSwdenk		  (and eventually uncompressed), but NOT be started.
31234a6fd34bSwdenk		  This can be used to load and uncompress arbitrary
31244a6fd34bSwdenk		  data.
31254a6fd34bSwdenk
312617ea1177Swdenk  i2cfast	- (PPC405GP|PPC405EP only)
312717ea1177Swdenk		  if set to 'y' configures Linux I2C driver for fast
312817ea1177Swdenk		  mode (400kHZ). This environment variable is used in
312917ea1177Swdenk		  initialization code. So, for changes to be effective
313017ea1177Swdenk		  it must be saved and board must be reset.
313117ea1177Swdenk
3132c609719bSwdenk  initrd_high	- restrict positioning of initrd images:
3133c609719bSwdenk		  If this variable is not set, initrd images will be
3134c609719bSwdenk		  copied to the highest possible address in RAM; this
3135c609719bSwdenk		  is usually what you want since it allows for
3136c609719bSwdenk		  maximum initrd size. If for some reason you want to
3137c609719bSwdenk		  make sure that the initrd image is loaded below the
31386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		  CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
3139c609719bSwdenk		  variable to a value of "no" or "off" or "0".
3140c609719bSwdenk		  Alternatively, you can set it to a maximum upper
3141c609719bSwdenk		  address to use (U-Boot will still check that it
3142c609719bSwdenk		  does not overwrite the U-Boot stack and data).
3143c609719bSwdenk
3144c609719bSwdenk		  For instance, when you have a system with 16 MB
31457152b1d0Swdenk		  RAM, and want to reserve 4 MB from use by Linux,
3146c609719bSwdenk		  you can do this by adding "mem=12M" to the value of
3147c609719bSwdenk		  the "bootargs" variable. However, now you must make
31487152b1d0Swdenk		  sure that the initrd image is placed in the first
3149c609719bSwdenk		  12 MB as well - this can be done with
3150c609719bSwdenk
3151c609719bSwdenk		  setenv initrd_high 00c00000
3152c609719bSwdenk
315338b99261Swdenk		  If you set initrd_high to 0xFFFFFFFF, this is an
315438b99261Swdenk		  indication to U-Boot that all addresses are legal
315538b99261Swdenk		  for the Linux kernel, including addresses in flash
315638b99261Swdenk		  memory. In this case U-Boot will NOT COPY the
315738b99261Swdenk		  ramdisk at all. This may be useful to reduce the
315838b99261Swdenk		  boot time on your system, but requires that this
315938b99261Swdenk		  feature is supported by your Linux kernel.
316038b99261Swdenk
3161c609719bSwdenk  ipaddr	- IP address; needed for tftpboot command
3162c609719bSwdenk
3163c609719bSwdenk  loadaddr	- Default load address for commands like "bootp",
3164dc7c9a1aSwdenk		  "rarpboot", "tftpboot", "loadb" or "diskboot"
3165c609719bSwdenk
3166c609719bSwdenk  loads_echo	- see CONFIG_LOADS_ECHO
3167c609719bSwdenk
3168c609719bSwdenk  serverip	- TFTP server IP address; needed for tftpboot command
3169c609719bSwdenk
3170c609719bSwdenk  bootretry	- see CONFIG_BOOT_RETRY_TIME
3171c609719bSwdenk
3172c609719bSwdenk  bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
3173c609719bSwdenk
3174c609719bSwdenk  bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
3175c609719bSwdenk
3176a3d991bdSwdenk  ethprime	- When CONFIG_NET_MULTI is enabled controls which
3177a3d991bdSwdenk		  interface is used first.
3178a3d991bdSwdenk
3179a3d991bdSwdenk  ethact	- When CONFIG_NET_MULTI is enabled controls which
3180a3d991bdSwdenk		  interface is currently active. For example you
3181a3d991bdSwdenk		  can do the following
3182a3d991bdSwdenk
318348690d80SHeiko Schocher		  => setenv ethact FEC
318448690d80SHeiko Schocher		  => ping 192.168.0.1 # traffic sent on FEC
318548690d80SHeiko Schocher		  => setenv ethact SCC
318648690d80SHeiko Schocher		  => ping 10.0.0.1 # traffic sent on SCC
3187a3d991bdSwdenk
3188e1692577SMatthias Fuchs  ethrotate	- When set to "no" U-Boot does not go through all
3189e1692577SMatthias Fuchs		  available network interfaces.
3190e1692577SMatthias Fuchs		  It just stays at the currently selected interface.
3191e1692577SMatthias Fuchs
3192a3d991bdSwdenk  netretry	- When set to "no" each network operation will
3193a3d991bdSwdenk		  either succeed or fail without retrying.
31946e592385Swdenk		  When set to "once" the network operation will
31956e592385Swdenk		  fail when all the available network interfaces
31966e592385Swdenk		  are tried once without success.
3197a3d991bdSwdenk		  Useful on scripts which control the retry operation
3198a3d991bdSwdenk		  themselves.
3199a3d991bdSwdenk
3200b4e2f89dSJean-Christophe PLAGNIOL-VILLARD  npe_ucode	- set load address for the NPE microcode
3201a1cf027aSJean-Christophe PLAGNIOL-VILLARD
320228cb9375SWolfgang Denk  tftpsrcport	- If this is set, the value is used for TFTP's
3203ecb0ccd9SWolfgang Denk		  UDP source port.
3204ecb0ccd9SWolfgang Denk
320528cb9375SWolfgang Denk  tftpdstport	- If this is set, the value is used for TFTP's UDP
320628cb9375SWolfgang Denk		  destination port instead of the Well Know Port 69.
320728cb9375SWolfgang Denk
3208c96f86eeSWolfgang Denk  tftpblocksize - Block size to use for TFTP transfers; if not set,
3209c96f86eeSWolfgang Denk		  we use the TFTP server's default block size
3210c96f86eeSWolfgang Denk
3211c96f86eeSWolfgang Denk  tftptimeout	- Retransmission timeout for TFTP packets (in milli-
3212c96f86eeSWolfgang Denk		  seconds, minimum value is 1000 = 1 second). Defines
3213c96f86eeSWolfgang Denk		  when a packet is considered to be lost so it has to
3214c96f86eeSWolfgang Denk		  be retransmitted. The default is 5000 = 5 seconds.
3215c96f86eeSWolfgang Denk		  Lowering this value may make downloads succeed
3216c96f86eeSWolfgang Denk		  faster in networks with high packet loss rates or
3217c96f86eeSWolfgang Denk		  with unreliable TFTP servers.
3218c96f86eeSWolfgang Denk
3219a3d991bdSwdenk  vlan		- When set to a value < 4095 the traffic over
322011ccc33fSMarcel Ziswiler		  Ethernet is encapsulated/received over 802.1q
3221a3d991bdSwdenk		  VLAN tagged frames.
3222c609719bSwdenk
3223c609719bSwdenkThe following environment variables may be used and automatically
3224c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"),
3225c609719bSwdenkdepending the information provided by your boot server:
3226c609719bSwdenk
3227c609719bSwdenk  bootfile	- see above
3228c609719bSwdenk  dnsip		- IP address of your Domain Name Server
3229fe389a82Sstroese  dnsip2	- IP address of your secondary Domain Name Server
3230c609719bSwdenk  gatewayip	- IP address of the Gateway (Router) to use
3231c609719bSwdenk  hostname	- Target hostname
3232c609719bSwdenk  ipaddr	- see above
3233c609719bSwdenk  netmask	- Subnet Mask
3234c609719bSwdenk  rootpath	- Pathname of the root filesystem on the NFS server
3235c609719bSwdenk  serverip	- see above
3236c609719bSwdenk
3237c609719bSwdenk
3238c609719bSwdenkThere are two special Environment Variables:
3239c609719bSwdenk
3240c609719bSwdenk  serial#	- contains hardware identification information such
3241c609719bSwdenk		  as type string and/or serial number
3242c609719bSwdenk  ethaddr	- Ethernet address
3243c609719bSwdenk
3244c609719bSwdenkThese variables can be set only once (usually during manufacturing of
3245c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables
3246c609719bSwdenkonce they have been set once.
3247c609719bSwdenk
3248c609719bSwdenk
3249c1551ea8SstroeseFurther special Environment Variables:
3250c1551ea8Sstroese
3251c1551ea8Sstroese  ver		- Contains the U-Boot version string as printed
3252c1551ea8Sstroese		  with the "version" command. This variable is
3253c1551ea8Sstroese		  readonly (see CONFIG_VERSION_VARIABLE).
3254c1551ea8Sstroese
3255c1551ea8Sstroese
3256c609719bSwdenkPlease note that changes to some configuration parameters may take
3257c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-).
3258c609719bSwdenk
3259c609719bSwdenk
3260f07771ccSwdenkCommand Line Parsing:
3261f07771ccSwdenk=====================
3262f07771ccSwdenk
3263f07771ccSwdenkThere are two different command line parsers available with U-Boot:
32647152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell:
3265f07771ccSwdenk
3266f07771ccSwdenkOld, simple command line parser:
3267f07771ccSwdenk--------------------------------
3268f07771ccSwdenk
3269f07771ccSwdenk- supports environment variables (through setenv / saveenv commands)
3270f07771ccSwdenk- several commands on one line, separated by ';'
3271fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax
3272f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\',
3273f07771ccSwdenk  for example:
3274fe126d8bSWolfgang Denk	setenv bootcmd bootm \${address}
3275f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example:
3276f07771ccSwdenk	setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
3277f07771ccSwdenk
3278f07771ccSwdenkHush shell:
3279f07771ccSwdenk-----------
3280f07771ccSwdenk
3281f07771ccSwdenk- similar to Bourne shell, with control structures like
3282f07771ccSwdenk  if...then...else...fi, for...do...done; while...do...done,
3283f07771ccSwdenk  until...do...done, ...
3284f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv
3285f07771ccSwdenk  commands) and local shell variables (through standard shell syntax
3286f07771ccSwdenk  "name=value"); only environment variables can be used with "run"
3287f07771ccSwdenk  command
3288f07771ccSwdenk
3289f07771ccSwdenkGeneral rules:
3290f07771ccSwdenk--------------
3291f07771ccSwdenk
3292f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run"
3293f07771ccSwdenk    command) contains several commands separated by semicolon, and
3294f07771ccSwdenk    one of these commands fails, then the remaining commands will be
3295f07771ccSwdenk    executed anyway.
3296f07771ccSwdenk
3297f07771ccSwdenk(2) If you execute several variables with one call to run (i. e.
329811ccc33fSMarcel Ziswiler    calling run with a list of variables as arguments), any failing
3299f07771ccSwdenk    command will cause "run" to terminate, i. e. the remaining
3300f07771ccSwdenk    variables are not executed.
3301f07771ccSwdenk
3302c609719bSwdenkNote for Redundant Ethernet Interfaces:
3303c609719bSwdenk=======================================
3304c609719bSwdenk
330511ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports
3306c609719bSwdenksuch configurations and is capable of automatic selection of a
33077152b1d0Swdenk"working" interface when needed. MAC assignment works as follows:
3308c609719bSwdenk
3309c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding
3310c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0),
3311c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ...
3312c609719bSwdenk
3313c609719bSwdenkIf the network interface stores some valid MAC address (for instance
3314c609719bSwdenkin SROM), this is used as default address if there is NO correspon-
3315c609719bSwdenkding setting in the environment; if the corresponding environment
3316c609719bSwdenkvariable is set, this overrides the settings in the card; that means:
3317c609719bSwdenk
3318c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the
3319c609719bSwdenk  environment, the SROM's address is used.
3320c609719bSwdenk
3321c609719bSwdenko If there is no valid address in the SROM, and a definition in the
3322c609719bSwdenk  environment exists, then the value from the environment variable is
3323c609719bSwdenk  used.
3324c609719bSwdenk
3325c609719bSwdenko If both the SROM and the environment contain a MAC address, and
3326c609719bSwdenk  both addresses are the same, this MAC address is used.
3327c609719bSwdenk
3328c609719bSwdenko If both the SROM and the environment contain a MAC address, and the
3329c609719bSwdenk  addresses differ, the value from the environment is used and a
3330c609719bSwdenk  warning is printed.
3331c609719bSwdenk
3332c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error
3333c609719bSwdenk  is raised.
3334c609719bSwdenk
3335ecee9324SBen WarrenIf Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
3336ecee9324SBen Warrenwill be programmed into hardware as part of the initialization process.  This
3337ecee9324SBen Warrenmay be skipped by setting the appropriate 'ethmacskip' environment variable.
3338ecee9324SBen WarrenThe naming convention is as follows:
3339ecee9324SBen Warren"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
3340c609719bSwdenk
3341c609719bSwdenkImage Formats:
3342c609719bSwdenk==============
3343c609719bSwdenk
33443310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on)
33453310c549SMarian Balakowiczimages in two formats:
33463310c549SMarian Balakowicz
33473310c549SMarian BalakowiczNew uImage format (FIT)
33483310c549SMarian Balakowicz-----------------------
33493310c549SMarian Balakowicz
33503310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar
33513310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple
33523310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by
33533310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
33543310c549SMarian Balakowicz
33553310c549SMarian Balakowicz
33563310c549SMarian BalakowiczOld uImage format
33573310c549SMarian Balakowicz-----------------
33583310c549SMarian Balakowicz
33593310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything,
33603310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for
33613310c549SMarian Balakowiczdetails; basically, the header defines the following image properties:
3362c609719bSwdenk
3363c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
3364c609719bSwdenk  4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
3365f5ed9e39SPeter Tyser  LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
3366f5ed9e39SPeter Tyser  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
3367f5ed9e39SPeter Tyser  INTEGRITY).
33687b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
33691117cbf2SThomas Chou  IA64, MIPS, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
33701117cbf2SThomas Chou  Currently supported: ARM, AVR32, Intel x86, MIPS, Nios II, PowerPC).
3371c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2)
3372c609719bSwdenk* Load Address
3373c609719bSwdenk* Entry Point
3374c609719bSwdenk* Image Name
3375c609719bSwdenk* Image Timestamp
3376c609719bSwdenk
3377c609719bSwdenkThe header is marked by a special Magic Number, and both the header
3378c609719bSwdenkand the data portions of the image are secured against corruption by
3379c609719bSwdenkCRC32 checksums.
3380c609719bSwdenk
3381c609719bSwdenk
3382c609719bSwdenkLinux Support:
3383c609719bSwdenk==============
3384c609719bSwdenk
3385c609719bSwdenkAlthough U-Boot should support any OS or standalone application
33867152b1d0Swdenkeasily, the main focus has always been on Linux during the design of
3387c609719bSwdenkU-Boot.
3388c609719bSwdenk
3389c609719bSwdenkU-Boot includes many features that so far have been part of some
3390c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any
3391c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image;
3392c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation
33937152b1d0Swdenkserves several purposes:
3394c609719bSwdenk
3395c609719bSwdenk- the same features can be used for other OS or standalone
3396c609719bSwdenk  applications (for instance: using compressed images to reduce the
3397c609719bSwdenk  Flash memory footprint)
3398c609719bSwdenk
3399c609719bSwdenk- it becomes much easier to port new Linux kernel versions because
34007152b1d0Swdenk  lots of low-level, hardware dependent stuff are done by U-Boot
3401c609719bSwdenk
3402c609719bSwdenk- the same Linux kernel image can now be used with different "initrd"
3403c609719bSwdenk  images; of course this also means that different kernel images can
3404c609719bSwdenk  be run with the same "initrd". This makes testing easier (you don't
3405c609719bSwdenk  have to build a new "zImage.initrd" Linux image when you just
3406c609719bSwdenk  change a file in your "initrd"). Also, a field-upgrade of the
3407c609719bSwdenk  software is easier now.
3408c609719bSwdenk
3409c609719bSwdenk
3410c609719bSwdenkLinux HOWTO:
3411c609719bSwdenk============
3412c609719bSwdenk
3413c609719bSwdenkPorting Linux to U-Boot based systems:
3414c609719bSwdenk---------------------------------------
3415c609719bSwdenk
3416c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to
3417c609719bSwdenkconfigure the Linux device drivers for use with your target hardware
3418c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to
3419c609719bSwdenkLinux :-).
3420c609719bSwdenk
3421a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
3422c609719bSwdenk
3423c609719bSwdenkJust make sure your machine specific header file (for instance
3424c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board
34251dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h,
34261dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value
34276d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR.
3428c609719bSwdenk
3429c609719bSwdenk
3430c609719bSwdenkConfiguring the Linux kernel:
3431c609719bSwdenk-----------------------------
3432c609719bSwdenk
3433c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root
3434c609719bSwdenkdevice (initial ramdisk, NFS) for your target system.
3435c609719bSwdenk
3436c609719bSwdenk
3437c609719bSwdenkBuilding a Linux Image:
3438c609719bSwdenk-----------------------
3439c609719bSwdenk
344024ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are
344124ee89b9Swdenknot used. If you use recent kernel source, a new build target
344224ee89b9Swdenk"uImage" will exist which automatically builds an image usable by
344324ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target,
344424ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a
344524ee89b9Swdenk100% compatible format.
3446c609719bSwdenk
3447c609719bSwdenkExample:
3448c609719bSwdenk
3449c609719bSwdenk	make TQM850L_config
3450c609719bSwdenk	make oldconfig
3451c609719bSwdenk	make dep
345224ee89b9Swdenk	make uImage
3453c609719bSwdenk
345424ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to
345524ee89b9Swdenkencapsulate a compressed Linux kernel image with header	 information,
345624ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing:
3457c609719bSwdenk
345824ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format):
345924ee89b9Swdenk
346024ee89b9Swdenk* convert the kernel into a raw binary image:
346124ee89b9Swdenk
346224ee89b9Swdenk	${CROSS_COMPILE}-objcopy -O binary \
346324ee89b9Swdenk				 -R .note -R .comment \
346424ee89b9Swdenk				 -S vmlinux linux.bin
346524ee89b9Swdenk
346624ee89b9Swdenk* compress the binary image:
346724ee89b9Swdenk
346824ee89b9Swdenk	gzip -9 linux.bin
346924ee89b9Swdenk
347024ee89b9Swdenk* package compressed binary image for U-Boot:
347124ee89b9Swdenk
347224ee89b9Swdenk	mkimage -A ppc -O linux -T kernel -C gzip \
347324ee89b9Swdenk		-a 0 -e 0 -n "Linux Kernel Image" \
347424ee89b9Swdenk		-d linux.bin.gz uImage
347524ee89b9Swdenk
347624ee89b9Swdenk
347724ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use
347824ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or
347924ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64
348024ee89b9Swdenkbyte header containing information about target architecture,
348124ee89b9Swdenkoperating system, image type, compression method, entry points, time
348224ee89b9Swdenkstamp, CRC32 checksums, etc.
348324ee89b9Swdenk
348424ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and
348524ee89b9Swdenkprint the header information, or to build new images.
3486c609719bSwdenk
3487c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information
3488c609719bSwdenkcontained in the header of an existing U-Boot image; this includes
3489c609719bSwdenkchecksum verification:
3490c609719bSwdenk
3491c609719bSwdenk	tools/mkimage -l image
3492c609719bSwdenk	  -l ==> list image header information
3493c609719bSwdenk
3494c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image
3495c609719bSwdenkfrom a "data file" which is used as image payload:
3496c609719bSwdenk
3497c609719bSwdenk	tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
3498c609719bSwdenk		      -n name -d data_file image
3499c609719bSwdenk	  -A ==> set architecture to 'arch'
3500c609719bSwdenk	  -O ==> set operating system to 'os'
3501c609719bSwdenk	  -T ==> set image type to 'type'
3502c609719bSwdenk	  -C ==> set compression type 'comp'
3503c609719bSwdenk	  -a ==> set load address to 'addr' (hex)
3504c609719bSwdenk	  -e ==> set entry point to 'ep' (hex)
3505c609719bSwdenk	  -n ==> set image name to 'name'
3506c609719bSwdenk	  -d ==> use image data from 'datafile'
3507c609719bSwdenk
350869459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load
350969459791Swdenkaddress (0x00000000), but the entry point address depends on the
351069459791Swdenkkernel version:
3511c609719bSwdenk
3512c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C,
351324ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000.
3514c609719bSwdenk
3515c609719bSwdenkSo a typical call to build a U-Boot image would read:
3516c609719bSwdenk
351724ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
351824ee89b9Swdenk	> -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
3519a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
352024ee89b9Swdenk	> examples/uImage.TQM850L
352124ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
3522c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
3523c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
3524c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
3525c609719bSwdenk	Load Address: 0x00000000
352624ee89b9Swdenk	Entry Point:  0x00000000
3527c609719bSwdenk
3528c609719bSwdenkTo verify the contents of the image (or check for corruption):
3529c609719bSwdenk
353024ee89b9Swdenk	-> tools/mkimage -l examples/uImage.TQM850L
353124ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
3532c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
3533c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
3534c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
3535c609719bSwdenk	Load Address: 0x00000000
353624ee89b9Swdenk	Entry Point:  0x00000000
3537c609719bSwdenk
3538c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade
3539c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this
3540c609719bSwdenkneeds more space in Flash, but boots much faster since it does not
3541c609719bSwdenkneed to be uncompressed:
3542c609719bSwdenk
3543a47a12beSStefan Roese	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
354424ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
354524ee89b9Swdenk	> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
3546a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
354724ee89b9Swdenk	> examples/uImage.TQM850L-uncompressed
354824ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
3549c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
3550c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (uncompressed)
3551c609719bSwdenk	Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
3552c609719bSwdenk	Load Address: 0x00000000
355324ee89b9Swdenk	Entry Point:  0x00000000
3554c609719bSwdenk
3555c609719bSwdenk
3556c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file
3557c609719bSwdenkwhen your kernel is intended to use an initial ramdisk:
3558c609719bSwdenk
3559c609719bSwdenk	-> tools/mkimage -n 'Simple Ramdisk Image' \
3560c609719bSwdenk	> -A ppc -O linux -T ramdisk -C gzip \
3561c609719bSwdenk	> -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
3562c609719bSwdenk	Image Name:   Simple Ramdisk Image
3563c609719bSwdenk	Created:      Wed Jan 12 14:01:50 2000
3564c609719bSwdenk	Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
3565c609719bSwdenk	Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
3566c609719bSwdenk	Load Address: 0x00000000
3567c609719bSwdenk	Entry Point:  0x00000000
3568c609719bSwdenk
3569c609719bSwdenk
3570c609719bSwdenkInstalling a Linux Image:
3571c609719bSwdenk-------------------------
3572c609719bSwdenk
3573c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface,
3574c609719bSwdenkyou must convert the image to S-Record format:
3575c609719bSwdenk
3576c609719bSwdenk	objcopy -I binary -O srec examples/image examples/image.srec
3577c609719bSwdenk
3578c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot
3579c609719bSwdenkimage header, so the resulting S-Record file will be relative to
3580c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to
3581c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads'
3582c609719bSwdenkcommand.
3583c609719bSwdenk
3584c609719bSwdenkExample: install the image to address 0x40100000 (which on the
3585c609719bSwdenkTQM8xxL is in the first Flash bank):
3586c609719bSwdenk
3587c609719bSwdenk	=> erase 40100000 401FFFFF
3588c609719bSwdenk
3589c609719bSwdenk	.......... done
3590c609719bSwdenk	Erased 8 sectors
3591c609719bSwdenk
3592c609719bSwdenk	=> loads 40100000
3593c609719bSwdenk	## Ready for S-Record download ...
3594c609719bSwdenk	~>examples/image.srec
3595c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 12 13 ...
3596c609719bSwdenk	...
3597c609719bSwdenk	15989 15990 15991 15992
3598c609719bSwdenk	[file transfer complete]
3599c609719bSwdenk	[connected]
3600c609719bSwdenk	## Start Addr = 0x00000000
3601c609719bSwdenk
3602c609719bSwdenk
3603c609719bSwdenkYou can check the success of the download using the 'iminfo' command;
3604c609719bSwdenkthis includes a checksum verification so you can be sure no data
3605c609719bSwdenkcorruption happened:
3606c609719bSwdenk
3607c609719bSwdenk	=> imi 40100000
3608c609719bSwdenk
3609c609719bSwdenk	## Checking Image at 40100000 ...
3610c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
3611c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3612c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
3613c609719bSwdenk	   Load Address: 00000000
3614c609719bSwdenk	   Entry Point:	 0000000c
3615c609719bSwdenk	   Verifying Checksum ... OK
3616c609719bSwdenk
3617c609719bSwdenk
3618c609719bSwdenkBoot Linux:
3619c609719bSwdenk-----------
3620c609719bSwdenk
3621c609719bSwdenkThe "bootm" command is used to boot an application that is stored in
3622c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents
3623c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as
3624c609719bSwdenkparameters. You can check and modify this variable using the
3625c609719bSwdenk"printenv" and "setenv" commands:
3626c609719bSwdenk
3627c609719bSwdenk
3628c609719bSwdenk	=> printenv bootargs
3629c609719bSwdenk	bootargs=root=/dev/ram
3630c609719bSwdenk
3631c609719bSwdenk	=> setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3632c609719bSwdenk
3633c609719bSwdenk	=> printenv bootargs
3634c609719bSwdenk	bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3635c609719bSwdenk
3636c609719bSwdenk	=> bootm 40020000
3637c609719bSwdenk	## Booting Linux kernel at 40020000 ...
3638c609719bSwdenk	   Image Name:	 2.2.13 for NFS on TQM850L
3639c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3640c609719bSwdenk	   Data Size:	 381681 Bytes = 372 kB = 0 MB
3641c609719bSwdenk	   Load Address: 00000000
3642c609719bSwdenk	   Entry Point:	 0000000c
3643c609719bSwdenk	   Verifying Checksum ... OK
3644c609719bSwdenk	   Uncompressing Kernel Image ... OK
3645c609719bSwdenk	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
3646c609719bSwdenk	Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3647c609719bSwdenk	time_init: decrementer frequency = 187500000/60
3648c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
3649c609719bSwdenk	Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
3650c609719bSwdenk	...
3651c609719bSwdenk
365211ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass
36537152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT
3654c609719bSwdenkformat!) to the "bootm" command:
3655c609719bSwdenk
3656c609719bSwdenk	=> imi 40100000 40200000
3657c609719bSwdenk
3658c609719bSwdenk	## Checking Image at 40100000 ...
3659c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
3660c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3661c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
3662c609719bSwdenk	   Load Address: 00000000
3663c609719bSwdenk	   Entry Point:	 0000000c
3664c609719bSwdenk	   Verifying Checksum ... OK
3665c609719bSwdenk
3666c609719bSwdenk	## Checking Image at 40200000 ...
3667c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
3668c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
3669c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
3670c609719bSwdenk	   Load Address: 00000000
3671c609719bSwdenk	   Entry Point:	 00000000
3672c609719bSwdenk	   Verifying Checksum ... OK
3673c609719bSwdenk
3674c609719bSwdenk	=> bootm 40100000 40200000
3675c609719bSwdenk	## Booting Linux kernel at 40100000 ...
3676c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
3677c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3678c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
3679c609719bSwdenk	   Load Address: 00000000
3680c609719bSwdenk	   Entry Point:	 0000000c
3681c609719bSwdenk	   Verifying Checksum ... OK
3682c609719bSwdenk	   Uncompressing Kernel Image ... OK
3683c609719bSwdenk	## Loading RAMDisk Image at 40200000 ...
3684c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
3685c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
3686c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
3687c609719bSwdenk	   Load Address: 00000000
3688c609719bSwdenk	   Entry Point:	 00000000
3689c609719bSwdenk	   Verifying Checksum ... OK
3690c609719bSwdenk	   Loading Ramdisk ... OK
3691c609719bSwdenk	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
3692c609719bSwdenk	Boot arguments: root=/dev/ram
3693c609719bSwdenk	time_init: decrementer frequency = 187500000/60
3694c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
3695c609719bSwdenk	...
3696c609719bSwdenk	RAMDISK: Compressed image found at block 0
3697c609719bSwdenk	VFS: Mounted root (ext2 filesystem).
3698c609719bSwdenk
3699c609719bSwdenk	bash#
3700c609719bSwdenk
37010267768eSMatthew McClintockBoot Linux and pass a flat device tree:
37020267768eSMatthew McClintock-----------
37030267768eSMatthew McClintock
37040267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section
37050267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The
37060267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated
37070267768eSMatthew McClintockflat device tree:
37080267768eSMatthew McClintock
37090267768eSMatthew McClintock=> print oftaddr
37100267768eSMatthew McClintockoftaddr=0x300000
37110267768eSMatthew McClintock=> print oft
37120267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb
37130267768eSMatthew McClintock=> tftp $oftaddr $oft
37140267768eSMatthew McClintockSpeed: 1000, full duplex
37150267768eSMatthew McClintockUsing TSEC0 device
37160267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101
37170267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'.
37180267768eSMatthew McClintockLoad address: 0x300000
37190267768eSMatthew McClintockLoading: #
37200267768eSMatthew McClintockdone
37210267768eSMatthew McClintockBytes transferred = 4106 (100a hex)
37220267768eSMatthew McClintock=> tftp $loadaddr $bootfile
37230267768eSMatthew McClintockSpeed: 1000, full duplex
37240267768eSMatthew McClintockUsing TSEC0 device
37250267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2
37260267768eSMatthew McClintockFilename 'uImage'.
37270267768eSMatthew McClintockLoad address: 0x200000
37280267768eSMatthew McClintockLoading:############
37290267768eSMatthew McClintockdone
37300267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex)
37310267768eSMatthew McClintock=> print loadaddr
37320267768eSMatthew McClintockloadaddr=200000
37330267768eSMatthew McClintock=> print oftaddr
37340267768eSMatthew McClintockoftaddr=0x300000
37350267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr
37360267768eSMatthew McClintock## Booting image at 00200000 ...
37370267768eSMatthew McClintock   Image Name:	 Linux-2.6.17-dirty
37380267768eSMatthew McClintock   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
37390267768eSMatthew McClintock   Data Size:	 1029343 Bytes = 1005.2 kB
37400267768eSMatthew McClintock   Load Address: 00000000
37410267768eSMatthew McClintock   Entry Point:	 00000000
37420267768eSMatthew McClintock   Verifying Checksum ... OK
37430267768eSMatthew McClintock   Uncompressing Kernel Image ... OK
37440267768eSMatthew McClintockBooting using flat device tree at 0x300000
37450267768eSMatthew McClintockUsing MPC85xx ADS machine description
37460267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
37470267768eSMatthew McClintock[snip]
37480267768eSMatthew McClintock
37490267768eSMatthew McClintock
37506069ff26SwdenkMore About U-Boot Image Types:
37516069ff26Swdenk------------------------------
37526069ff26Swdenk
37536069ff26SwdenkU-Boot supports the following image types:
37546069ff26Swdenk
37556069ff26Swdenk   "Standalone Programs" are directly runnable in the environment
37566069ff26Swdenk	provided by U-Boot; it is expected that (if they behave
37576069ff26Swdenk	well) you can continue to work in U-Boot after return from
37586069ff26Swdenk	the Standalone Program.
37596069ff26Swdenk   "OS Kernel Images" are usually images of some Embedded OS which
37606069ff26Swdenk	will take over control completely. Usually these programs
37616069ff26Swdenk	will install their own set of exception handlers, device
37626069ff26Swdenk	drivers, set up the MMU, etc. - this means, that you cannot
37636069ff26Swdenk	expect to re-enter U-Boot except by resetting the CPU.
37646069ff26Swdenk   "RAMDisk Images" are more or less just data blocks, and their
37656069ff26Swdenk	parameters (address, size) are passed to an OS kernel that is
37666069ff26Swdenk	being started.
37676069ff26Swdenk   "Multi-File Images" contain several images, typically an OS
37686069ff26Swdenk	(Linux) kernel image and one or more data images like
37696069ff26Swdenk	RAMDisks. This construct is useful for instance when you want
37706069ff26Swdenk	to boot over the network using BOOTP etc., where the boot
37716069ff26Swdenk	server provides just a single image file, but you want to get
37726069ff26Swdenk	for instance an OS kernel and a RAMDisk image.
37736069ff26Swdenk
37746069ff26Swdenk	"Multi-File Images" start with a list of image sizes, each
37756069ff26Swdenk	image size (in bytes) specified by an "uint32_t" in network
37766069ff26Swdenk	byte order. This list is terminated by an "(uint32_t)0".
37776069ff26Swdenk	Immediately after the terminating 0 follow the images, one by
37786069ff26Swdenk	one, all aligned on "uint32_t" boundaries (size rounded up to
37796069ff26Swdenk	a multiple of 4 bytes).
37806069ff26Swdenk
37816069ff26Swdenk   "Firmware Images" are binary images containing firmware (like
37826069ff26Swdenk	U-Boot or FPGA images) which usually will be programmed to
37836069ff26Swdenk	flash memory.
37846069ff26Swdenk
37856069ff26Swdenk   "Script files" are command sequences that will be executed by
37866069ff26Swdenk	U-Boot's command interpreter; this feature is especially
37876069ff26Swdenk	useful when you configure U-Boot to use a real shell (hush)
37886069ff26Swdenk	as command interpreter.
37896069ff26Swdenk
3790c609719bSwdenk
3791c609719bSwdenkStandalone HOWTO:
3792c609719bSwdenk=================
3793c609719bSwdenk
3794c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and
3795c609719bSwdenkrun "standalone" applications, which can use some resources of
3796c609719bSwdenkU-Boot like console I/O functions or interrupt services.
3797c609719bSwdenk
3798c609719bSwdenkTwo simple examples are included with the sources:
3799c609719bSwdenk
3800c609719bSwdenk"Hello World" Demo:
3801c609719bSwdenk-------------------
3802c609719bSwdenk
3803c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo
3804c609719bSwdenkapplication; it is automatically compiled when you build U-Boot.
3805c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it
3806c609719bSwdenklike that:
3807c609719bSwdenk
3808c609719bSwdenk	=> loads
3809c609719bSwdenk	## Ready for S-Record download ...
3810c609719bSwdenk	~>examples/hello_world.srec
3811c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
3812c609719bSwdenk	[file transfer complete]
3813c609719bSwdenk	[connected]
3814c609719bSwdenk	## Start Addr = 0x00040004
3815c609719bSwdenk
3816c609719bSwdenk	=> go 40004 Hello World! This is a test.
3817c609719bSwdenk	## Starting application at 0x00040004 ...
3818c609719bSwdenk	Hello World
3819c609719bSwdenk	argc = 7
3820c609719bSwdenk	argv[0] = "40004"
3821c609719bSwdenk	argv[1] = "Hello"
3822c609719bSwdenk	argv[2] = "World!"
3823c609719bSwdenk	argv[3] = "This"
3824c609719bSwdenk	argv[4] = "is"
3825c609719bSwdenk	argv[5] = "a"
3826c609719bSwdenk	argv[6] = "test."
3827c609719bSwdenk	argv[7] = "<NULL>"
3828c609719bSwdenk	Hit any key to exit ...
3829c609719bSwdenk
3830c609719bSwdenk	## Application terminated, rc = 0x0
3831c609719bSwdenk
3832c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt
3833c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'.
3834c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second.
3835c609719bSwdenkThe interrupt service routine is trivial, just printing a '.'
3836c609719bSwdenkcharacter, but this is just a demo program. The application can be
3837c609719bSwdenkcontrolled by the following keys:
3838c609719bSwdenk
3839c609719bSwdenk	? - print current values og the CPM Timer registers
3840c609719bSwdenk	b - enable interrupts and start timer
3841c609719bSwdenk	e - stop timer and disable interrupts
3842c609719bSwdenk	q - quit application
3843c609719bSwdenk
3844c609719bSwdenk	=> loads
3845c609719bSwdenk	## Ready for S-Record download ...
3846c609719bSwdenk	~>examples/timer.srec
3847c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
3848c609719bSwdenk	[file transfer complete]
3849c609719bSwdenk	[connected]
3850c609719bSwdenk	## Start Addr = 0x00040004
3851c609719bSwdenk
3852c609719bSwdenk	=> go 40004
3853c609719bSwdenk	## Starting application at 0x00040004 ...
3854c609719bSwdenk	TIMERS=0xfff00980
3855c609719bSwdenk	Using timer 1
3856c609719bSwdenk	  tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
3857c609719bSwdenk
3858c609719bSwdenkHit 'b':
3859c609719bSwdenk	[q, b, e, ?] Set interval 1000000 us
3860c609719bSwdenk	Enabling timer
3861c609719bSwdenkHit '?':
3862c609719bSwdenk	[q, b, e, ?] ........
3863c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
3864c609719bSwdenkHit '?':
3865c609719bSwdenk	[q, b, e, ?] .
3866c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
3867c609719bSwdenkHit '?':
3868c609719bSwdenk	[q, b, e, ?] .
3869c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
3870c609719bSwdenkHit '?':
3871c609719bSwdenk	[q, b, e, ?] .
3872c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
3873c609719bSwdenkHit 'e':
3874c609719bSwdenk	[q, b, e, ?] ...Stopping timer
3875c609719bSwdenkHit 'q':
3876c609719bSwdenk	[q, b, e, ?] ## Application terminated, rc = 0x0
3877c609719bSwdenk
3878c609719bSwdenk
387985ec0bccSwdenkMinicom warning:
388085ec0bccSwdenk================
388185ec0bccSwdenk
38827152b1d0SwdenkOver time, many people have reported problems when trying to use the
388385ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd)
388485ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under
3885f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and
388685ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and
388785ec0bccSwdenkuse "cu" for S-Record download ("loads" command).
388885ec0bccSwdenk
388952f52c14SwdenkNevertheless, if you absolutely want to use it try adding this
389052f52c14Swdenkconfiguration to your "File transfer protocols" section:
389152f52c14Swdenk
389252f52c14Swdenk	   Name	   Program			Name U/D FullScr IO-Red. Multi
389352f52c14Swdenk	X  kermit  /usr/bin/kermit -i -l %l -s	 Y    U	   Y	   N	  N
389452f52c14Swdenk	Y  kermit  /usr/bin/kermit -i -l %l -r	 N    D	   Y	   N	  N
389552f52c14Swdenk
389652f52c14Swdenk
3897c609719bSwdenkNetBSD Notes:
3898c609719bSwdenk=============
3899c609719bSwdenk
3900c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host
3901c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx).
3902c609719bSwdenk
3903c609719bSwdenkBuilding requires a cross environment; it is known to work on
3904c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
3905c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make).
3906c609719bSwdenkNote that the cross-powerpc package does not install include files;
3907c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is
3908c609719bSwdenkmissing.  This file has to be installed and patched manually:
3909c609719bSwdenk
3910c609719bSwdenk	# cd /usr/pkg/cross/powerpc-netbsd/include
3911c609719bSwdenk	# mkdir powerpc
3912c609719bSwdenk	# ln -s powerpc machine
3913c609719bSwdenk	# cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
3914c609719bSwdenk	# ${EDIT} powerpc/ansi.h	## must remove __va_list, _BSD_VA_LIST
3915c609719bSwdenk
3916c609719bSwdenkNative builds *don't* work due to incompatibilities between native
3917c609719bSwdenkand U-Boot include files.
3918c609719bSwdenk
3919c609719bSwdenkBooting assumes that (the first part of) the image booted is a
3920c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel
3921c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source
3922c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
39232a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
3924c609719bSwdenk
3925c609719bSwdenk
3926c609719bSwdenkImplementation Internals:
3927c609719bSwdenk=========================
3928c609719bSwdenk
3929c609719bSwdenkThe following is not intended to be a complete description of every
3930c609719bSwdenkimplementation detail. However, it should help to understand the
3931c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom
3932c609719bSwdenkhardware.
3933c609719bSwdenk
3934c609719bSwdenk
3935c609719bSwdenkInitial Stack, Global Data:
3936c609719bSwdenk---------------------------
3937c609719bSwdenk
3938c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot
3939c609719bSwdenkstarts running out of ROM (flash memory), usually without access to
3940c609719bSwdenksystem RAM (because the memory controller is not initialized yet).
3941c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS
3942c609719bSwdenkis not initialized as zero. To be able to get a C environment working
3943c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation
3944c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU
3945c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and
3946c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be
3947c609719bSwdenklocked as (mis-) used as memory, etc.
3948c609719bSwdenk
39497152b1d0Swdenk	Chris Hallinan posted a good summary of these issues to the
39500668236bSWolfgang Denk	U-Boot mailing list:
395143d9616cSwdenk
395243d9616cSwdenk	Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
395343d9616cSwdenk	From: "Chris Hallinan" <clh@net1plus.com>
395443d9616cSwdenk	Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
395543d9616cSwdenk	...
395643d9616cSwdenk
395743d9616cSwdenk	Correct me if I'm wrong, folks, but the way I understand it
395843d9616cSwdenk	is this: Using DCACHE as initial RAM for Stack, etc, does not
395943d9616cSwdenk	require any physical RAM backing up the cache. The cleverness
396043d9616cSwdenk	is that the cache is being used as a temporary supply of
396143d9616cSwdenk	necessary storage before the SDRAM controller is setup. It's
396211ccc33fSMarcel Ziswiler	beyond the scope of this list to explain the details, but you
396343d9616cSwdenk	can see how this works by studying the cache architecture and
396443d9616cSwdenk	operation in the architecture and processor-specific manuals.
396543d9616cSwdenk
396643d9616cSwdenk	OCM is On Chip Memory, which I believe the 405GP has 4K. It
396743d9616cSwdenk	is another option for the system designer to use as an
396811ccc33fSMarcel Ziswiler	initial stack/RAM area prior to SDRAM being available. Either
396943d9616cSwdenk	option should work for you. Using CS 4 should be fine if your
397043d9616cSwdenk	board designers haven't used it for something that would
397143d9616cSwdenk	cause you grief during the initial boot! It is frequently not
397243d9616cSwdenk	used.
397343d9616cSwdenk
39746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
397543d9616cSwdenk	with your processor/board/system design. The default value
397643d9616cSwdenk	you will find in any recent u-boot distribution in
39778a316c9bSStefan Roese	walnut.h should work for you. I'd set it to a value larger
397843d9616cSwdenk	than your SDRAM module. If you have a 64MB SDRAM module, set
397943d9616cSwdenk	it above 400_0000. Just make sure your board has no resources
398043d9616cSwdenk	that are supposed to respond to that address! That code in
398143d9616cSwdenk	start.S has been around a while and should work as is when
398243d9616cSwdenk	you get the config right.
398343d9616cSwdenk
398443d9616cSwdenk	-Chris Hallinan
398543d9616cSwdenk	DS4.COM, Inc.
398643d9616cSwdenk
3987c609719bSwdenkIt is essential to remember this, since it has some impact on the C
3988c609719bSwdenkcode for the initialization procedures:
3989c609719bSwdenk
3990c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt
3991c609719bSwdenk  to write it.
3992c609719bSwdenk
399311ccc33fSMarcel Ziswiler* Do not use any uninitialized global data (or implicitely initialized
3994c609719bSwdenk  as zero data - BSS segment) at all - this is undefined, initiali-
39957152b1d0Swdenk  zation is performed later (when relocating to RAM).
3996c609719bSwdenk
3997c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like
3998c609719bSwdenk  that.
3999c609719bSwdenk
4000c609719bSwdenkHaving only the stack as writable memory limits means we cannot use
4001c609719bSwdenknormal global data to share information beween the code. But it
4002c609719bSwdenkturned out that the implementation of U-Boot can be greatly
4003c609719bSwdenksimplified by making a global data structure (gd_t) available to all
4004c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_
4005c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of
4006c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we
4007c609719bSwdenkplace a pointer (gd) to the global data into a register which we
4008c609719bSwdenkreserve for this purpose.
4009c609719bSwdenk
40107152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the
4011c609719bSwdenkrelevant  (E)ABI  specifications for the current architecture, and by
4012c609719bSwdenkGCC's implementation.
4013c609719bSwdenk
4014c609719bSwdenkFor PowerPC, the following registers have specific use:
4015c609719bSwdenk	R1:	stack pointer
4016e7670f6cSWolfgang Denk	R2:	reserved for system use
4017c609719bSwdenk	R3-R4:	parameter passing and return values
4018c609719bSwdenk	R5-R10: parameter passing
4019c609719bSwdenk	R13:	small data area pointer
4020c609719bSwdenk	R30:	GOT pointer
4021c609719bSwdenk	R31:	frame pointer
4022c609719bSwdenk
4023e6bee808SJoakim Tjernlund	(U-Boot also uses R12 as internal GOT pointer. r12
4024e6bee808SJoakim Tjernlund	is a volatile register so r12 needs to be reset when
4025e6bee808SJoakim Tjernlund	going back and forth between asm and C)
4026c609719bSwdenk
4027e7670f6cSWolfgang Denk    ==> U-Boot will use R2 to hold a pointer to the global data
4028c609719bSwdenk
4029c609719bSwdenk    Note: on PPC, we could use a static initializer (since the
4030c609719bSwdenk    address of the global data structure is known at compile time),
4031c609719bSwdenk    but it turned out that reserving a register results in somewhat
4032c609719bSwdenk    smaller code - although the code savings are not that big (on
4033c609719bSwdenk    average for all boards 752 bytes for the whole U-Boot image,
4034c609719bSwdenk    624 text + 127 data).
4035c609719bSwdenk
4036c4db335cSRobin GetzOn Blackfin, the normal C ABI (except for P3) is followed as documented here:
40374c58eb55SMike Frysinger	http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
40384c58eb55SMike Frysinger
4039c4db335cSRobin Getz    ==> U-Boot will use P3 to hold a pointer to the global data
40404c58eb55SMike Frysinger
4041c609719bSwdenkOn ARM, the following registers are used:
4042c609719bSwdenk
4043c609719bSwdenk	R0:	function argument word/integer result
4044c609719bSwdenk	R1-R3:	function argument word
4045c609719bSwdenk	R9:	GOT pointer
4046c609719bSwdenk	R10:	stack limit (used only if stack checking if enabled)
4047c609719bSwdenk	R11:	argument (frame) pointer
4048c609719bSwdenk	R12:	temporary workspace
4049c609719bSwdenk	R13:	stack pointer
4050c609719bSwdenk	R14:	link register
4051c609719bSwdenk	R15:	program counter
4052c609719bSwdenk
4053c609719bSwdenk    ==> U-Boot will use R8 to hold a pointer to the global data
4054c609719bSwdenk
40550df01fd3SThomas ChouOn Nios II, the ABI is documented here:
40560df01fd3SThomas Chou	http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
40570df01fd3SThomas Chou
40580df01fd3SThomas Chou    ==> U-Boot will use gp to hold a pointer to the global data
40590df01fd3SThomas Chou
40600df01fd3SThomas Chou    Note: on Nios II, we give "-G0" option to gcc and don't use gp
40610df01fd3SThomas Chou    to access small data sections, so gp is free.
40620df01fd3SThomas Chou
4063d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
4064d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much.
4065c609719bSwdenk
4066c609719bSwdenkMemory Management:
4067c609719bSwdenk------------------
4068c609719bSwdenk
4069c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the
4070c609719bSwdenkMMU is not used either for address mapping nor for memory protection.
4071c609719bSwdenk
4072c609719bSwdenkThe available memory is mapped to fixed addresses using the memory
4073c609719bSwdenkcontroller. In this process, a contiguous block is formed for each
4074c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several
4075c609719bSwdenkphysical memory banks.
4076c609719bSwdenk
4077c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on
4078c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
4079c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself
4080c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some
40816d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
4082c609719bSwdenkconfiguration setting]. Below that, a structure with global Board
4083c609719bSwdenkInfo data is placed, followed by the stack (growing downward).
4084c609719bSwdenk
4085c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB
4086c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF).
4087c609719bSwdenk
4088c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like
4089c609719bSwdenkthis:
4090c609719bSwdenk
4091c609719bSwdenk	0x0000 0000	Exception Vector code
4092c609719bSwdenk	      :
4093c609719bSwdenk	0x0000 1FFF
4094c609719bSwdenk	0x0000 2000	Free for Application Use
4095c609719bSwdenk	      :
4096c609719bSwdenk	      :
4097c609719bSwdenk
4098c609719bSwdenk	      :
4099c609719bSwdenk	      :
4100c609719bSwdenk	0x00FB FF20	Monitor Stack (Growing downward)
4101c609719bSwdenk	0x00FB FFAC	Board Info Data and permanent copy of global data
4102c609719bSwdenk	0x00FC 0000	Malloc Arena
4103c609719bSwdenk	      :
4104c609719bSwdenk	0x00FD FFFF
4105c609719bSwdenk	0x00FE 0000	RAM Copy of Monitor Code
4106c609719bSwdenk	...		eventually: LCD or video framebuffer
4107c609719bSwdenk	...		eventually: pRAM (Protected RAM - unchanged by reset)
4108c609719bSwdenk	0x00FF FFFF	[End of RAM]
4109c609719bSwdenk
4110c609719bSwdenk
4111c609719bSwdenkSystem Initialization:
4112c609719bSwdenk----------------------
4113c609719bSwdenk
4114c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point
411511ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset
4116c609719bSwdenkconfiguration for CS0# this is a mirror of the onboard Flash memory.
41177152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address.
4118c609719bSwdenkTo be able to implement the initialization code in C, a (small!)
4119c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs
4120c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked
4121c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core,
4122c609719bSwdenkthe caches and the SIU.
4123c609719bSwdenk
4124c609719bSwdenkNext, all (potentially) available memory banks are mapped using a
4125c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries
4126c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
4127c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
4128c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a
4129c609719bSwdenksimple memory test is run that determines the size of the SDRAM
4130c609719bSwdenkbanks.
4131c609719bSwdenk
4132c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of
41337152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first
4134c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address
4135c609719bSwdenk0x00000000, with any additional banks following immediately to create
4136c609719bSwdenkcontiguous memory starting from 0.
4137c609719bSwdenk
4138c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area
4139c609719bSwdenkand allocates memory for use by malloc() and for the global Board
4140c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM
4141c609719bSwdenkpages, and the final stack is set up.
4142c609719bSwdenk
4143c609719bSwdenkOnly after this relocation will you have a "normal" C environment;
4144c609719bSwdenkuntil that you are restricted in several ways, mostly because you are
4145c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a
4146c609719bSwdenknew address in RAM.
4147c609719bSwdenk
4148c609719bSwdenk
4149c609719bSwdenkU-Boot Porting Guide:
4150c609719bSwdenk----------------------
4151c609719bSwdenk
4152c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
41536aff3115Swdenklist, October 2002]
4154c609719bSwdenk
4155c609719bSwdenk
4156c609719bSwdenkint main(int argc, char *argv[])
4157c609719bSwdenk{
4158c609719bSwdenk	sighandler_t no_more_time;
4159c609719bSwdenk
4160c609719bSwdenk	signal(SIGALRM, no_more_time);
4161c609719bSwdenk	alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
4162c609719bSwdenk
4163c609719bSwdenk	if (available_money > available_manpower) {
41646c3fef28SJerry Van Baren		Pay consultant to port U-Boot;
4165c609719bSwdenk		return 0;
4166c609719bSwdenk	}
4167c609719bSwdenk
4168c609719bSwdenk	Download latest U-Boot source;
4169c609719bSwdenk
41700668236bSWolfgang Denk	Subscribe to u-boot mailing list;
41716aff3115Swdenk
41726c3fef28SJerry Van Baren	if (clueless)
4173c609719bSwdenk		email("Hi, I am new to U-Boot, how do I get started?");
4174c609719bSwdenk
4175c609719bSwdenk	while (learning) {
4176c609719bSwdenk		Read the README file in the top level directory;
41777cb22f97Swdenk		Read http://www.denx.de/twiki/bin/view/DULG/Manual;
41786c3fef28SJerry Van Baren		Read applicable doc/*.README;
4179c609719bSwdenk		Read the source, Luke;
41806c3fef28SJerry Van Baren		/* find . -name "*.[chS]" | xargs grep -i <keyword> */
4181c609719bSwdenk	}
4182c609719bSwdenk
41836c3fef28SJerry Van Baren	if (available_money > toLocalCurrency ($2500))
41846c3fef28SJerry Van Baren		Buy a BDI3000;
41856c3fef28SJerry Van Baren	else
4186c609719bSwdenk		Add a lot of aggravation and time;
4187c609719bSwdenk
41886c3fef28SJerry Van Baren	if (a similar board exists) {	/* hopefully... */
41896c3fef28SJerry Van Baren		cp -a board/<similar> board/<myboard>
41906c3fef28SJerry Van Baren		cp include/configs/<similar>.h include/configs/<myboard>.h
41916c3fef28SJerry Van Baren	} else {
4192c609719bSwdenk		Create your own board support subdirectory;
41936c3fef28SJerry Van Baren		Create your own board include/configs/<myboard>.h file;
41946c3fef28SJerry Van Baren	}
41956c3fef28SJerry Van Baren	Edit new board/<myboard> files
41966c3fef28SJerry Van Baren	Edit new include/configs/<myboard>.h
4197c609719bSwdenk
41986c3fef28SJerry Van Baren	while (!accepted) {
4199c609719bSwdenk		while (!running) {
4200c609719bSwdenk			do {
4201c609719bSwdenk				Add / modify source code;
4202c609719bSwdenk			} until (compiles);
4203c609719bSwdenk			Debug;
4204c609719bSwdenk			if (clueless)
4205c609719bSwdenk				email("Hi, I am having problems...");
4206c609719bSwdenk		}
42076c3fef28SJerry Van Baren		Send patch file to the U-Boot email list;
42086c3fef28SJerry Van Baren		if (reasonable critiques)
42096c3fef28SJerry Van Baren			Incorporate improvements from email list code review;
42106c3fef28SJerry Van Baren		else
42116c3fef28SJerry Van Baren			Defend code as written;
42126c3fef28SJerry Van Baren	}
4213c609719bSwdenk
4214c609719bSwdenk	return 0;
4215c609719bSwdenk}
4216c609719bSwdenk
4217c609719bSwdenkvoid no_more_time (int sig)
4218c609719bSwdenk{
4219c609719bSwdenk      hire_a_guru();
4220c609719bSwdenk}
4221c609719bSwdenk
4222c609719bSwdenk
4223c609719bSwdenkCoding Standards:
4224c609719bSwdenk-----------------
4225c609719bSwdenk
4226c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel
42272c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script
42282c051651SDetlev Zundel"scripts/Lindent" in your Linux kernel source directory.  In sources
42292c051651SDetlev Zundeloriginating from U-Boot a style corresponding to "Lindent -pcs" (adding
42302c051651SDetlev Zundelspaces before parameters to function calls) is actually used.
4231c609719bSwdenk
42322c051651SDetlev ZundelSource files originating from a different project (for example the
42332c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not
42342c051651SDetlev Zundelreformated to ease subsequent migration to newer versions of those
42352c051651SDetlev Zundelsources.
42362c051651SDetlev Zundel
42372c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in
42382c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//)
42392c051651SDetlev Zundelin your code.
4240c609719bSwdenk
4241c178d3daSwdenkPlease also stick to the following formatting rules:
4242180d3f74Swdenk- remove any trailing white space
4243180d3f74Swdenk- use TAB characters for indentation, not spaces
4244180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds
4245180d3f74Swdenk- do not add more than 2 empty lines to source files
4246180d3f74Swdenk- do not add trailing empty lines to source files
4247180d3f74Swdenk
4248c609719bSwdenkSubmissions which do not conform to the standards may be returned
4249c609719bSwdenkwith a request to reformat the changes.
4250c609719bSwdenk
4251c609719bSwdenk
4252c609719bSwdenkSubmitting Patches:
4253c609719bSwdenk-------------------
4254c609719bSwdenk
4255c609719bSwdenkSince the number of patches for U-Boot is growing, we need to
4256c609719bSwdenkestablish some rules. Submissions which do not conform to these rules
4257c609719bSwdenkmay be rejected, even when they contain important and valuable stuff.
4258c609719bSwdenk
42590d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details.
4260218ca724SWolfgang Denk
42610668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
42620668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot
42630668236bSWolfgang Denk
4264c609719bSwdenkWhen you send a patch, please include the following information with
4265c609719bSwdenkit:
4266c609719bSwdenk
4267c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes
4268c609719bSwdenk  this bug. Please try to include a way of demonstrating that the
4269c609719bSwdenk  patch actually fixes something.
4270c609719bSwdenk
4271c609719bSwdenk* For new features: a description of the feature and your
4272c609719bSwdenk  implementation.
4273c609719bSwdenk
4274c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch)
4275c609719bSwdenk
4276c609719bSwdenk* For major contributions, your entry to the CREDITS file
4277c609719bSwdenk
4278c609719bSwdenk* When you add support for a new board, don't forget to add this
4279c609719bSwdenk  board to the MAKEALL script, too.
4280c609719bSwdenk
4281c609719bSwdenk* If your patch adds new configuration options, don't forget to
4282c609719bSwdenk  document these in the README file.
4283c609719bSwdenk
4284218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly*
4285218ca724SWolfgang Denk  recommended) you can easily generate the patch using the
4286218ca724SWolfgang Denk  "git-format-patch". If you then use "git-send-email" to send it to
4287218ca724SWolfgang Denk  the U-Boot mailing list, you will avoid most of the common problems
4288218ca724SWolfgang Denk  with some other mail clients.
4289c609719bSwdenk
4290218ca724SWolfgang Denk  If you cannot use git, use "diff -purN OLD NEW". If your version of
4291218ca724SWolfgang Denk  diff does not support these options, then get the latest version of
4292218ca724SWolfgang Denk  GNU diff.
42936dff5529Swdenk
4294218ca724SWolfgang Denk  The current directory when running this command shall be the parent
4295218ca724SWolfgang Denk  directory of the U-Boot source tree (i. e. please make sure that
4296218ca724SWolfgang Denk  your patch includes sufficient directory information for the
4297218ca724SWolfgang Denk  affected files).
4298218ca724SWolfgang Denk
4299218ca724SWolfgang Denk  We prefer patches as plain text. MIME attachments are discouraged,
4300218ca724SWolfgang Denk  and compressed attachments must not be used.
4301c609719bSwdenk
430252f52c14Swdenk* If one logical set of modifications affects or creates several
430352f52c14Swdenk  files, all these changes shall be submitted in a SINGLE patch file.
430452f52c14Swdenk
430552f52c14Swdenk* Changesets that contain different, unrelated modifications shall be
430652f52c14Swdenk  submitted as SEPARATE patches, one patch per changeset.
430752f52c14Swdenk
430852f52c14Swdenk
4309c609719bSwdenkNotes:
4310c609719bSwdenk
4311c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched
4312c609719bSwdenk  source tree and make sure that no errors or warnings are reported
4313c609719bSwdenk  for any of the boards.
4314c609719bSwdenk
4315c609719bSwdenk* Keep your modifications to the necessary minimum: A patch
4316c609719bSwdenk  containing several unrelated changes or arbitrary reformats will be
4317c609719bSwdenk  returned with a request to re-formatting / split it.
4318c609719bSwdenk
4319c609719bSwdenk* If you modify existing code, make sure that your new code does not
4320c609719bSwdenk  add to the memory footprint of the code ;-) Small is beautiful!
4321c609719bSwdenk  When adding new features, these should compile conditionally only
4322c609719bSwdenk  (using #ifdef), and the resulting code with the new feature
4323c609719bSwdenk  disabled must not need more memory than the old code without your
4324c609719bSwdenk  modification.
432590dc6704Swdenk
43260668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the
43270668236bSWolfgang Denk  u-boot mailing list. Bigger patches will be moderated. If they are
43280668236bSWolfgang Denk  reasonable and not too big, they will be acknowledged. But patches
43290668236bSWolfgang Denk  bigger than the size limit should be avoided.
4330