xref: /openbmc/u-boot/README (revision 1117cbf2adac59050af1751af6c6a524afa5c3ef)
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
12993f19cc0SwdenkU-Boot uses a 3 level version number containing a version, a
13093f19cc0Swdenksub-version, and a patchlevel: "U-Boot-2.34.5" means version "2",
13193f19cc0Swdenksub-version "34", and patchlevel "4".
13293f19cc0Swdenk
13393f19cc0SwdenkThe patchlevel is used to indicate certain stages of development
13493f19cc0Swdenkbetween released versions, i. e. officially released versions of
13593f19cc0SwdenkU-Boot will always have a patchlevel of "0".
13693f19cc0Swdenk
13793f19cc0Swdenk
138c609719bSwdenkDirectory Hierarchy:
139c609719bSwdenk====================
140c609719bSwdenk
1418d321b81SPeter Tyser/arch			Architecture specific files
1428d321b81SPeter Tyser  /arm			Files generic to ARM architecture
1438d321b81SPeter Tyser    /cpu		CPU specific files
1448d321b81SPeter Tyser      /arm720t		Files specific to ARM 720 CPUs
1458d321b81SPeter Tyser      /arm920t		Files specific to ARM 920 CPUs
1468d321b81SPeter Tyser        /at91rm9200	Files specific to Atmel AT91RM9200 CPU
1478d321b81SPeter Tyser        /imx		Files specific to Freescale MC9328 i.MX CPUs
1488d321b81SPeter Tyser        /s3c24x0	Files specific to Samsung S3C24X0 CPUs
1498d321b81SPeter Tyser      /arm925t		Files specific to ARM 925 CPUs
1508d321b81SPeter Tyser      /arm926ejs	Files specific to ARM 926 CPUs
1518d321b81SPeter Tyser      /arm1136		Files specific to ARM 1136 CPUs
1528d321b81SPeter Tyser      /ixp		Files specific to Intel XScale IXP CPUs
1538d321b81SPeter Tyser      /pxa		Files specific to Intel XScale PXA CPUs
1548d321b81SPeter Tyser      /s3c44b0		Files specific to Samsung S3C44B0 CPUs
1558d321b81SPeter Tyser      /sa1100		Files specific to Intel StrongARM SA1100 CPUs
1568d321b81SPeter Tyser    /lib		Architecture specific library files
1578d321b81SPeter Tyser  /avr32		Files generic to AVR32 architecture
1588d321b81SPeter Tyser    /cpu		CPU specific files
1598d321b81SPeter Tyser    /lib		Architecture specific library files
1608d321b81SPeter Tyser  /blackfin		Files generic to Analog Devices Blackfin architecture
1618d321b81SPeter Tyser    /cpu		CPU specific files
1628d321b81SPeter Tyser    /lib		Architecture specific library files
1638d321b81SPeter Tyser  /i386			Files generic to i386 architecture
1648d321b81SPeter Tyser    /cpu		CPU specific files
1658d321b81SPeter Tyser    /lib		Architecture specific library files
1668d321b81SPeter Tyser  /m68k			Files generic to m68k architecture
1678d321b81SPeter Tyser    /cpu		CPU specific files
1688d321b81SPeter Tyser      /mcf52x2		Files specific to Freescale ColdFire MCF52x2 CPUs
1698d321b81SPeter Tyser      /mcf5227x		Files specific to Freescale ColdFire MCF5227x CPUs
1708d321b81SPeter Tyser      /mcf532x		Files specific to Freescale ColdFire MCF5329 CPUs
1718d321b81SPeter Tyser      /mcf5445x		Files specific to Freescale ColdFire MCF5445x CPUs
1728d321b81SPeter Tyser      /mcf547x_8x	Files specific to Freescale ColdFire MCF547x_8x CPUs
1738d321b81SPeter Tyser    /lib		Architecture specific library files
1748d321b81SPeter Tyser  /microblaze		Files generic to microblaze architecture
1758d321b81SPeter Tyser    /cpu		CPU specific files
1768d321b81SPeter Tyser    /lib		Architecture specific library files
1778d321b81SPeter Tyser  /mips			Files generic to MIPS architecture
1788d321b81SPeter Tyser    /cpu		CPU specific files
1798d321b81SPeter Tyser    /lib		Architecture specific library files
1808d321b81SPeter Tyser  /nios2		Files generic to Altera NIOS2 architecture
1818d321b81SPeter Tyser    /cpu		CPU specific files
1828d321b81SPeter Tyser    /lib		Architecture specific library files
183a47a12beSStefan Roese  /powerpc		Files generic to PowerPC architecture
1848d321b81SPeter Tyser    /cpu		CPU specific files
1858d321b81SPeter Tyser      /74xx_7xx		Files specific to Freescale MPC74xx and 7xx CPUs
1868d321b81SPeter Tyser      /mpc5xx		Files specific to Freescale MPC5xx CPUs
1878d321b81SPeter Tyser      /mpc5xxx		Files specific to Freescale MPC5xxx CPUs
1888d321b81SPeter Tyser      /mpc8xx		Files specific to Freescale MPC8xx CPUs
1898d321b81SPeter Tyser      /mpc8220		Files specific to Freescale MPC8220 CPUs
1908d321b81SPeter Tyser      /mpc824x		Files specific to Freescale MPC824x CPUs
1918d321b81SPeter Tyser      /mpc8260		Files specific to Freescale MPC8260 CPUs
1928d321b81SPeter Tyser      /mpc85xx		Files specific to Freescale MPC85xx CPUs
1938d321b81SPeter Tyser      /ppc4xx		Files specific to AMCC PowerPC 4xx CPUs
1948d321b81SPeter Tyser    /lib		Architecture specific library files
1958d321b81SPeter Tyser  /sh			Files generic to SH architecture
1968d321b81SPeter Tyser    /cpu		CPU specific files
1978d321b81SPeter Tyser      /sh2		Files specific to sh2 CPUs
1988d321b81SPeter Tyser      /sh3		Files specific to sh3 CPUs
1998d321b81SPeter Tyser      /sh4		Files specific to sh4 CPUs
2008d321b81SPeter Tyser    /lib		Architecture specific library files
2018d321b81SPeter Tyser  /sparc		Files generic to SPARC architecture
2028d321b81SPeter Tyser    /cpu		CPU specific files
2038d321b81SPeter Tyser      /leon2		Files specific to Gaisler LEON2 SPARC CPU
2048d321b81SPeter Tyser      /leon3		Files specific to Gaisler LEON3 SPARC CPU
2058d321b81SPeter Tyser    /lib		Architecture specific library files
2068d321b81SPeter Tyser/api			Machine/arch independent API for external apps
2078d321b81SPeter Tyser/board			Board dependent files
2088d321b81SPeter Tyser/common			Misc architecture independent functions
2098d321b81SPeter Tyser/disk			Code for disk drive partition handling
2108d321b81SPeter Tyser/doc			Documentation (don't expect too much)
2118d321b81SPeter Tyser/drivers		Commonly used device drivers
2128d321b81SPeter Tyser/examples		Example code for standalone applications, etc.
2138d321b81SPeter Tyser/fs			Filesystem code (cramfs, ext2, jffs2, etc.)
2148d321b81SPeter Tyser/include		Header Files
2158d321b81SPeter Tyser/lib			Files generic to all architectures
2168d321b81SPeter Tyser  /libfdt		Library files to support flattened device trees
2178d321b81SPeter Tyser  /lzma			Library files to support LZMA decompression
2188d321b81SPeter Tyser  /lzo			Library files to support LZO decompression
2198d321b81SPeter Tyser/net			Networking code
2208d321b81SPeter Tyser/post			Power On Self Test
2218d321b81SPeter Tyser/rtc			Real Time Clock drivers
2228d321b81SPeter Tyser/tools			Tools to build S-Record or U-Boot images, etc.
223c609719bSwdenk
224c609719bSwdenkSoftware Configuration:
225c609719bSwdenk=======================
226c609719bSwdenk
227c609719bSwdenkConfiguration is usually done using C preprocessor defines; the
228c609719bSwdenkrationale behind that is to avoid dead code whenever possible.
229c609719bSwdenk
230c609719bSwdenkThere are two classes of configuration variables:
231c609719bSwdenk
232c609719bSwdenk* Configuration _OPTIONS_:
233c609719bSwdenk  These are selectable by the user and have names beginning with
234c609719bSwdenk  "CONFIG_".
235c609719bSwdenk
236c609719bSwdenk* Configuration _SETTINGS_:
237c609719bSwdenk  These depend on the hardware etc. and should not be meddled with if
238c609719bSwdenk  you don't know what you're doing; they have names beginning with
2396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  "CONFIG_SYS_".
240c609719bSwdenk
241c609719bSwdenkLater we will add a configuration tool - probably similar to or even
242c609719bSwdenkidentical to what's used for the Linux kernel. Right now, we have to
243c609719bSwdenkdo the configuration by hand, which means creating some symbolic
244c609719bSwdenklinks and editing some configuration files. We use the TQM8xxL boards
245c609719bSwdenkas an example here.
246c609719bSwdenk
247c609719bSwdenk
248c609719bSwdenkSelection of Processor Architecture and Board Type:
249c609719bSwdenk---------------------------------------------------
250c609719bSwdenk
251c609719bSwdenkFor all supported boards there are ready-to-use default
252c609719bSwdenkconfigurations available; just type "make <board_name>_config".
253c609719bSwdenk
254c609719bSwdenkExample: For a TQM823L module type:
255c609719bSwdenk
256c609719bSwdenk	cd u-boot
257c609719bSwdenk	make TQM823L_config
258c609719bSwdenk
25911ccc33fSMarcel ZiswilerFor the Cogent platform, you need to specify the CPU type as well;
260c609719bSwdenke.g. "make cogent_mpc8xx_config". And also configure the cogent
261c609719bSwdenkdirectory according to the instructions in cogent/README.
262c609719bSwdenk
263c609719bSwdenk
264c609719bSwdenkConfiguration Options:
265c609719bSwdenk----------------------
266c609719bSwdenk
267c609719bSwdenkConfiguration depends on the combination of board and CPU type; all
268c609719bSwdenksuch information is kept in a configuration file
269c609719bSwdenk"include/configs/<board_name>.h".
270c609719bSwdenk
271c609719bSwdenkExample: For a TQM823L module, all configuration settings are in
272c609719bSwdenk"include/configs/TQM823L.h".
273c609719bSwdenk
274c609719bSwdenk
2757f6c2cbcSwdenkMany of the options are named exactly as the corresponding Linux
2767f6c2cbcSwdenkkernel configuration options. The intention is to make it easier to
2777f6c2cbcSwdenkbuild a config tool - later.
2787f6c2cbcSwdenk
2797f6c2cbcSwdenk
280c609719bSwdenkThe following options need to be configured:
281c609719bSwdenk
2822628114eSKim Phillips- CPU Type:	Define exactly one, e.g. CONFIG_MPC85XX.
283c609719bSwdenk
2842628114eSKim Phillips- Board Type:	Define exactly one, e.g. CONFIG_MPC8540ADS.
2856ccec449SWolfgang Denk
2866ccec449SWolfgang Denk- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
28709ea0de0SHaavard Skinnemoen		Define exactly one, e.g. CONFIG_ATSTK1002
288c609719bSwdenk
289c609719bSwdenk- CPU Module Type: (if CONFIG_COGENT is defined)
290c609719bSwdenk		Define exactly one of
291c609719bSwdenk		CONFIG_CMA286_60_OLD
292c609719bSwdenk--- FIXME --- not tested yet:
293c609719bSwdenk		CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
294c609719bSwdenk		CONFIG_CMA287_23, CONFIG_CMA287_50
295c609719bSwdenk
296c609719bSwdenk- Motherboard Type: (if CONFIG_COGENT is defined)
297c609719bSwdenk		Define exactly one of
298c609719bSwdenk		CONFIG_CMA101, CONFIG_CMA102
299c609719bSwdenk
300c609719bSwdenk- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
301c609719bSwdenk		Define one or more of
302c609719bSwdenk		CONFIG_CMA302
303c609719bSwdenk
304c609719bSwdenk- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
305c609719bSwdenk		Define one or more of
306c609719bSwdenk		CONFIG_LCD_HEARTBEAT	- update a character position on
30711ccc33fSMarcel Ziswiler					  the LCD display every second with
308c609719bSwdenk					  a "rotator" |\-/|\-/
309c609719bSwdenk
3102535d602Swdenk- Board flavour: (if CONFIG_MPC8260ADS is defined)
3112535d602Swdenk		CONFIG_ADSTYPE
3122535d602Swdenk		Possible values are:
3136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8260ADS	- original MPC8260ADS
3146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8266ADS	- MPC8266ADS
3156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_PQ2FADS	- PQ2FADS-ZU or PQ2FADS-VR
3166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8272ADS	- MPC8272ADS
3172535d602Swdenk
318c609719bSwdenk- MPC824X Family Member (if CONFIG_MPC824X is defined)
319c609719bSwdenk		Define exactly one of
320c609719bSwdenk		CONFIG_MPC8240, CONFIG_MPC8245
321c609719bSwdenk
32211ccc33fSMarcel Ziswiler- 8xx CPU Options: (if using an MPC8xx CPU)
32366ca92a5Swdenk		CONFIG_8xx_GCLK_FREQ	- deprecated: CPU clock if
32466ca92a5Swdenk					  get_gclk_freq() cannot work
3255da627a4Swdenk					  e.g. if there is no 32KHz
3265da627a4Swdenk					  reference PIT/RTC clock
32766ca92a5Swdenk		CONFIG_8xx_OSCLK	- PLL input clock (either EXTCLK
32866ca92a5Swdenk					  or XTAL/EXTAL)
329c609719bSwdenk
33066ca92a5Swdenk- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
3316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MIN
3326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MAX
33366ca92a5Swdenk		CONFIG_8xx_CPUCLK_DEFAULT
33475d1ea7fSwdenk			See doc/README.MPC866
33575d1ea7fSwdenk
3366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MEASURE_CPUCLK
33775d1ea7fSwdenk
33875d1ea7fSwdenk		Define this to measure the actual CPU clock instead
33975d1ea7fSwdenk		of relying on the correctness of the configured
34075d1ea7fSwdenk		values. Mostly useful for board bringup to make sure
34175d1ea7fSwdenk		the PLL is locked at the intended frequency. Note
34275d1ea7fSwdenk		that this requires a (stable) reference clock (32 kHz
3436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		RTC clock or CONFIG_SYS_8XX_XIN)
34475d1ea7fSwdenk
345506f3918SHeiko Schocher		CONFIG_SYS_DELAYED_ICACHE
346506f3918SHeiko Schocher
347506f3918SHeiko Schocher		Define this option if you want to enable the
348506f3918SHeiko Schocher		ICache only when Code runs from RAM.
349506f3918SHeiko Schocher
3500b953ffcSMarkus Klotzbuecher- Intel Monahans options:
3516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
3520b953ffcSMarkus Klotzbuecher
3530b953ffcSMarkus Klotzbuecher		Defines the Monahans run mode to oscillator
3540b953ffcSMarkus Klotzbuecher		ratio. Valid values are 8, 16, 24, 31. The core
3550b953ffcSMarkus Klotzbuecher		frequency is this value multiplied by 13 MHz.
3560b953ffcSMarkus Klotzbuecher
3576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
3580b953ffcSMarkus Klotzbuecher
3590b953ffcSMarkus Klotzbuecher		Defines the Monahans turbo mode to oscillator
3600b953ffcSMarkus Klotzbuecher		ratio. Valid values are 1 (default if undefined) and
3610b953ffcSMarkus Klotzbuecher		2. The core frequency as calculated above is multiplied
3620b953ffcSMarkus Klotzbuecher		by this value.
3630b953ffcSMarkus Klotzbuecher
3645da627a4Swdenk- Linux Kernel Interface:
365c609719bSwdenk		CONFIG_CLOCKS_IN_MHZ
366c609719bSwdenk
367c609719bSwdenk		U-Boot stores all clock information in Hz
368c609719bSwdenk		internally. For binary compatibility with older Linux
369c609719bSwdenk		kernels (which expect the clocks passed in the
370c609719bSwdenk		bd_info data to be in MHz) the environment variable
371c609719bSwdenk		"clocks_in_mhz" can be defined so that U-Boot
372c609719bSwdenk		converts clock data to MHZ before passing it to the
373c609719bSwdenk		Linux kernel.
374c609719bSwdenk		When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
375c609719bSwdenk		"clocks_in_mhz=1" is automatically included in the
376c609719bSwdenk		default environment.
377c609719bSwdenk
3785da627a4Swdenk		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]
3795da627a4Swdenk
38011ccc33fSMarcel Ziswiler		When transferring memsize parameter to linux, some versions
3815da627a4Swdenk		expect it to be in bytes, others in MB.
3825da627a4Swdenk		Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
3835da627a4Swdenk
384fec6d9eeSGerald Van Baren		CONFIG_OF_LIBFDT
385f57f70aaSWolfgang Denk
386f57f70aaSWolfgang Denk		New kernel versions are expecting firmware settings to be
387213bf8c8SGerald Van Baren		passed using flattened device trees (based on open firmware
388213bf8c8SGerald Van Baren		concepts).
389213bf8c8SGerald Van Baren
390213bf8c8SGerald Van Baren		CONFIG_OF_LIBFDT
391213bf8c8SGerald Van Baren		 * New libfdt-based support
392213bf8c8SGerald Van Baren		 * Adds the "fdt" command
3933bb342fcSKim Phillips		 * The bootm command automatically updates the fdt
394213bf8c8SGerald Van Baren
395b55ae402SMarcel Ziswiler		OF_CPU - The proper name of the cpus node (only required for
396b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
397b55ae402SMarcel Ziswiler		OF_SOC - The proper name of the soc node (only required for
398b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
399f57f70aaSWolfgang Denk		OF_TBCLK - The timebase frequency.
400c2871f03SKumar Gala		OF_STDOUT_PATH - The path to the console device
401f57f70aaSWolfgang Denk
40211ccc33fSMarcel Ziswiler		boards with QUICC Engines require OF_QE to set UCC MAC
40311ccc33fSMarcel Ziswiler		addresses
4043bb342fcSKim Phillips
4054e253137SKumar Gala		CONFIG_OF_BOARD_SETUP
4064e253137SKumar Gala
4074e253137SKumar Gala		Board code has addition modification that it wants to make
4084e253137SKumar Gala		to the flat device tree before handing it off to the kernel
4096705d81eSwdenk
4100267768eSMatthew McClintock		CONFIG_OF_BOOT_CPU
4110267768eSMatthew McClintock
41211ccc33fSMarcel Ziswiler		This define fills in the correct boot CPU in the boot
4130267768eSMatthew McClintock		param header, the default value is zero if undefined.
4140267768eSMatthew McClintock
4153887c3fbSHeiko Schocher		CONFIG_OF_IDE_FIXUP
4163887c3fbSHeiko Schocher
4173887c3fbSHeiko Schocher		U-Boot can detect if an IDE device is present or not.
4183887c3fbSHeiko Schocher		If not, and this new config option is activated, U-Boot
4193887c3fbSHeiko Schocher		removes the ATA node from the DTS before booting Linux,
4203887c3fbSHeiko Schocher		so the Linux IDE driver does not probe the device and
4213887c3fbSHeiko Schocher		crash. This is needed for buggy hardware (uc101) where
4223887c3fbSHeiko Schocher		no pull down resistor is connected to the signal IDE5V_DD7.
4233887c3fbSHeiko Schocher
4240b2f4ecaSNiklaus Giger- vxWorks boot parameters:
4250b2f4ecaSNiklaus Giger
4260b2f4ecaSNiklaus Giger		bootvx constructs a valid bootline using the following
4270b2f4ecaSNiklaus Giger		environments variables: bootfile, ipaddr, serverip, hostname.
4280b2f4ecaSNiklaus Giger		It loads the vxWorks image pointed bootfile.
4290b2f4ecaSNiklaus Giger
4300b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
4310b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
4320b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
4330b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
4340b2f4ecaSNiklaus Giger
4350b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_ADD_PARAMS
4360b2f4ecaSNiklaus Giger
4370b2f4ecaSNiklaus Giger		Add it at the end of the bootline. E.g "u=username pw=secret"
4380b2f4ecaSNiklaus Giger
4390b2f4ecaSNiklaus Giger		Note: If a "bootargs" environment is defined, it will overwride
4400b2f4ecaSNiklaus Giger		the defaults discussed just above.
4410b2f4ecaSNiklaus Giger
4426705d81eSwdenk- Serial Ports:
44348d0192fSAndreas Engel		CONFIG_PL010_SERIAL
4446705d81eSwdenk
4456705d81eSwdenk		Define this if you want support for Amba PrimeCell PL010 UARTs.
4466705d81eSwdenk
44748d0192fSAndreas Engel		CONFIG_PL011_SERIAL
4486705d81eSwdenk
4496705d81eSwdenk		Define this if you want support for Amba PrimeCell PL011 UARTs.
4506705d81eSwdenk
4516705d81eSwdenk		CONFIG_PL011_CLOCK
4526705d81eSwdenk
4536705d81eSwdenk		If you have Amba PrimeCell PL011 UARTs, set this variable to
4546705d81eSwdenk		the clock speed of the UARTs.
4556705d81eSwdenk
4566705d81eSwdenk		CONFIG_PL01x_PORTS
4576705d81eSwdenk
4586705d81eSwdenk		If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
4596705d81eSwdenk		define this to a list of base addresses for each (supported)
4606705d81eSwdenk		port. See e.g. include/configs/versatile.h
4616705d81eSwdenk
4626705d81eSwdenk
463c609719bSwdenk- Console Interface:
464c609719bSwdenk		Depending on board, define exactly one serial port
465c609719bSwdenk		(like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
466c609719bSwdenk		CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
467c609719bSwdenk		console by defining CONFIG_8xx_CONS_NONE
468c609719bSwdenk
469c609719bSwdenk		Note: if CONFIG_8xx_CONS_NONE is defined, the serial
470c609719bSwdenk		port routines must be defined elsewhere
471c609719bSwdenk		(i.e. serial_init(), serial_getc(), ...)
472c609719bSwdenk
473c609719bSwdenk		CONFIG_CFB_CONSOLE
474c609719bSwdenk		Enables console device for a color framebuffer. Needs following
475c609719bSwdenk		defines (cf. smiLynxEM, i8042, board/eltec/bab7xx)
476c609719bSwdenk			VIDEO_FB_LITTLE_ENDIAN	graphic memory organisation
477c609719bSwdenk						(default big endian)
478c609719bSwdenk			VIDEO_HW_RECTFILL	graphic chip supports
479c609719bSwdenk						rectangle fill
480c609719bSwdenk						(cf. smiLynxEM)
481c609719bSwdenk			VIDEO_HW_BITBLT		graphic chip supports
482c609719bSwdenk						bit-blit (cf. smiLynxEM)
483c609719bSwdenk			VIDEO_VISIBLE_COLS	visible pixel columns
484c609719bSwdenk						(cols=pitch)
485c609719bSwdenk			VIDEO_VISIBLE_ROWS	visible pixel rows
486c609719bSwdenk			VIDEO_PIXEL_SIZE	bytes per pixel
487c609719bSwdenk			VIDEO_DATA_FORMAT	graphic data format
488c609719bSwdenk						(0-5, cf. cfb_console.c)
489c609719bSwdenk			VIDEO_FB_ADRS		framebuffer address
490c609719bSwdenk			VIDEO_KBD_INIT_FCT	keyboard int fct
491c609719bSwdenk						(i.e. i8042_kbd_init())
492c609719bSwdenk			VIDEO_TSTC_FCT		test char fct
493c609719bSwdenk						(i.e. i8042_tstc)
494c609719bSwdenk			VIDEO_GETC_FCT		get char fct
495c609719bSwdenk						(i.e. i8042_getc)
496c609719bSwdenk			CONFIG_CONSOLE_CURSOR	cursor drawing on/off
497c609719bSwdenk						(requires blink timer
498c609719bSwdenk						cf. i8042.c)
4996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
500c609719bSwdenk			CONFIG_CONSOLE_TIME	display time/date info in
501c609719bSwdenk						upper right corner
502602ad3b3SJon Loeliger						(requires CONFIG_CMD_DATE)
503c609719bSwdenk			CONFIG_VIDEO_LOGO	display Linux logo in
504c609719bSwdenk						upper left corner
505a6c7ad2fSwdenk			CONFIG_VIDEO_BMP_LOGO	use bmp_logo.h instead of
506a6c7ad2fSwdenk						linux_logo.h for logo.
507a6c7ad2fSwdenk						Requires CONFIG_VIDEO_LOGO
508c609719bSwdenk			CONFIG_CONSOLE_EXTRA_INFO
50911ccc33fSMarcel Ziswiler						additional board info beside
510c609719bSwdenk						the logo
511c609719bSwdenk
512c609719bSwdenk		When CONFIG_CFB_CONSOLE is defined, video console is
513c609719bSwdenk		default i/o. Serial console can be forced with
514c609719bSwdenk		environment 'console=serial'.
515c609719bSwdenk
516a3ad8e26Swdenk		When CONFIG_SILENT_CONSOLE is defined, all console
517a3ad8e26Swdenk		messages (by U-Boot and Linux!) can be silenced with
518a3ad8e26Swdenk		the "silent" environment variable. See
519a3ad8e26Swdenk		doc/README.silent for more information.
520a3ad8e26Swdenk
521c609719bSwdenk- Console Baudrate:
522c609719bSwdenk		CONFIG_BAUDRATE - in bps
523c609719bSwdenk		Select one of the baudrates listed in
5246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
5256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
526c609719bSwdenk
527c92fac91SHeiko Schocher- Console Rx buffer length
528c92fac91SHeiko Schocher		With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
529c92fac91SHeiko Schocher		the maximum receive buffer length for the SMC.
5302b3f12c2SHeiko Schocher		This option is actual only for 82xx and 8xx possible.
531c92fac91SHeiko Schocher		If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
532c92fac91SHeiko Schocher		must be defined, to setup the maximum idle timeout for
533c92fac91SHeiko Schocher		the SMC.
534c92fac91SHeiko Schocher
535c609719bSwdenk- Interrupt driven serial port input:
536c609719bSwdenk		CONFIG_SERIAL_SOFTWARE_FIFO
537c609719bSwdenk
538c609719bSwdenk		PPC405GP only.
539c609719bSwdenk		Use an interrupt handler for receiving data on the
540c609719bSwdenk		serial port. It also enables using hardware handshake
541c609719bSwdenk		(RTS/CTS) and UART's built-in FIFO. Set the number of
542c609719bSwdenk		bytes the interrupt driven input buffer should have.
543c609719bSwdenk
544109c0e3aSwdenk		Leave undefined to disable this feature, including
545109c0e3aSwdenk		disable the buffer and hardware handshake.
546c609719bSwdenk
5471d49b1f3Sstroese- Console UART Number:
5481d49b1f3Sstroese		CONFIG_UART1_CONSOLE
5491d49b1f3Sstroese
5500c8721a4SWolfgang Denk		AMCC PPC4xx only.
5511d49b1f3Sstroese		If defined internal UART1 (and not UART0) is used
5521d49b1f3Sstroese		as default U-Boot console.
5531d49b1f3Sstroese
554c609719bSwdenk- Boot Delay:	CONFIG_BOOTDELAY - in seconds
555c609719bSwdenk		Delay before automatically booting the default image;
556c609719bSwdenk		set to -1 to disable autoboot.
557c609719bSwdenk
558c609719bSwdenk		See doc/README.autoboot for these options that
559c609719bSwdenk		work with CONFIG_BOOTDELAY. None are required.
560c609719bSwdenk		CONFIG_BOOT_RETRY_TIME
561c609719bSwdenk		CONFIG_BOOT_RETRY_MIN
562c609719bSwdenk		CONFIG_AUTOBOOT_KEYED
563c609719bSwdenk		CONFIG_AUTOBOOT_PROMPT
564c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR
565c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR
566c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR2
567c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR2
568c609719bSwdenk		CONFIG_ZERO_BOOTDELAY_CHECK
569c609719bSwdenk		CONFIG_RESET_TO_RETRY
570c609719bSwdenk
571c609719bSwdenk- Autoboot Command:
572c609719bSwdenk		CONFIG_BOOTCOMMAND
573c609719bSwdenk		Only needed when CONFIG_BOOTDELAY is enabled;
574c609719bSwdenk		define a command string that is automatically executed
575c609719bSwdenk		when no character is read on the console interface
576c609719bSwdenk		within "Boot Delay" after reset.
577c609719bSwdenk
578c609719bSwdenk		CONFIG_BOOTARGS
579c609719bSwdenk		This can be used to pass arguments to the bootm
580c609719bSwdenk		command. The value of CONFIG_BOOTARGS goes into the
581c609719bSwdenk		environment value "bootargs".
582c609719bSwdenk
583c609719bSwdenk		CONFIG_RAMBOOT and CONFIG_NFSBOOT
584c609719bSwdenk		The value of these goes into the environment as
585c609719bSwdenk		"ramboot" and "nfsboot" respectively, and can be used
586c609719bSwdenk		as a convenience, when switching between booting from
58711ccc33fSMarcel Ziswiler		RAM and NFS.
588c609719bSwdenk
589c609719bSwdenk- Pre-Boot Commands:
590c609719bSwdenk		CONFIG_PREBOOT
591c609719bSwdenk
592c609719bSwdenk		When this option is #defined, the existence of the
593c609719bSwdenk		environment variable "preboot" will be checked
594c609719bSwdenk		immediately before starting the CONFIG_BOOTDELAY
595c609719bSwdenk		countdown and/or running the auto-boot command resp.
596c609719bSwdenk		entering interactive mode.
597c609719bSwdenk
598c609719bSwdenk		This feature is especially useful when "preboot" is
599c609719bSwdenk		automatically generated or modified. For an example
600c609719bSwdenk		see the LWMON board specific code: here "preboot" is
601c609719bSwdenk		modified when the user holds down a certain
602c609719bSwdenk		combination of keys on the (special) keyboard when
603c609719bSwdenk		booting the systems
604c609719bSwdenk
605c609719bSwdenk- Serial Download Echo Mode:
606c609719bSwdenk		CONFIG_LOADS_ECHO
607c609719bSwdenk		If defined to 1, all characters received during a
608c609719bSwdenk		serial download (using the "loads" command) are
609c609719bSwdenk		echoed back. This might be needed by some terminal
610c609719bSwdenk		emulations (like "cu"), but may as well just take
611c609719bSwdenk		time on others. This setting #define's the initial
612c609719bSwdenk		value of the "loads_echo" environment variable.
613c609719bSwdenk
614602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
615c609719bSwdenk		CONFIG_KGDB_BAUDRATE
616c609719bSwdenk		Select one of the baudrates listed in
6176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
618c609719bSwdenk
619c609719bSwdenk- Monitor Functions:
620602ad3b3SJon Loeliger		Monitor commands can be included or excluded
621602ad3b3SJon Loeliger		from the build by using the #include files
622602ad3b3SJon Loeliger		"config_cmd_all.h" and #undef'ing unwanted
623602ad3b3SJon Loeliger		commands, or using "config_cmd_default.h"
624602ad3b3SJon Loeliger		and augmenting with additional #define's
625602ad3b3SJon Loeliger		for wanted commands.
626c609719bSwdenk
627602ad3b3SJon Loeliger		The default command configuration includes all commands
628602ad3b3SJon Loeliger		except those marked below with a "*".
629602ad3b3SJon Loeliger
630602ad3b3SJon Loeliger		CONFIG_CMD_ASKENV	* ask for env variable
631602ad3b3SJon Loeliger		CONFIG_CMD_BDI		  bdinfo
632602ad3b3SJon Loeliger		CONFIG_CMD_BEDBUG	* Include BedBug Debugger
633602ad3b3SJon Loeliger		CONFIG_CMD_BMP		* BMP support
634602ad3b3SJon Loeliger		CONFIG_CMD_BSP		* Board specific commands
635602ad3b3SJon Loeliger		CONFIG_CMD_BOOTD	  bootd
636602ad3b3SJon Loeliger		CONFIG_CMD_CACHE	* icache, dcache
637602ad3b3SJon Loeliger		CONFIG_CMD_CONSOLE	  coninfo
638602ad3b3SJon Loeliger		CONFIG_CMD_DATE		* support for RTC, date/time...
639602ad3b3SJon Loeliger		CONFIG_CMD_DHCP		* DHCP support
640602ad3b3SJon Loeliger		CONFIG_CMD_DIAG		* Diagnostics
641a7c93104SPeter Tyser		CONFIG_CMD_DS4510	* ds4510 I2C gpio commands
642a7c93104SPeter Tyser		CONFIG_CMD_DS4510_INFO	* ds4510 I2C info command
643a7c93104SPeter Tyser		CONFIG_CMD_DS4510_MEM	* ds4510 I2C eeprom/sram commansd
644a7c93104SPeter Tyser		CONFIG_CMD_DS4510_RST	* ds4510 I2C rst command
645602ad3b3SJon Loeliger		CONFIG_CMD_DTT		* Digital Therm and Thermostat
646602ad3b3SJon Loeliger		CONFIG_CMD_ECHO		  echo arguments
647246c6922SPeter Tyser		CONFIG_CMD_EDITENV	  edit env variable
648602ad3b3SJon Loeliger		CONFIG_CMD_EEPROM	* EEPROM read/write support
649602ad3b3SJon Loeliger		CONFIG_CMD_ELF		* bootelf, bootvx
650bdab39d3SMike Frysinger		CONFIG_CMD_SAVEENV	  saveenv
651602ad3b3SJon Loeliger		CONFIG_CMD_FDC		* Floppy Disk Support
652602ad3b3SJon Loeliger		CONFIG_CMD_FAT		* FAT partition support
653602ad3b3SJon Loeliger		CONFIG_CMD_FDOS		* Dos diskette Support
654602ad3b3SJon Loeliger		CONFIG_CMD_FLASH	  flinfo, erase, protect
655602ad3b3SJon Loeliger		CONFIG_CMD_FPGA		  FPGA device initialization support
656602ad3b3SJon Loeliger		CONFIG_CMD_HWFLOW	* RTS/CTS hw flow control
657602ad3b3SJon Loeliger		CONFIG_CMD_I2C		* I2C serial bus support
658602ad3b3SJon Loeliger		CONFIG_CMD_IDE		* IDE harddisk support
659602ad3b3SJon Loeliger		CONFIG_CMD_IMI		  iminfo
660602ad3b3SJon Loeliger		CONFIG_CMD_IMLS		  List all found images
661602ad3b3SJon Loeliger		CONFIG_CMD_IMMAP	* IMMR dump support
662602ad3b3SJon Loeliger		CONFIG_CMD_IRQ		* irqinfo
663602ad3b3SJon Loeliger		CONFIG_CMD_ITEST	  Integer/string test of 2 values
664602ad3b3SJon Loeliger		CONFIG_CMD_JFFS2	* JFFS2 Support
665602ad3b3SJon Loeliger		CONFIG_CMD_KGDB		* kgdb
666602ad3b3SJon Loeliger		CONFIG_CMD_LOADB	  loadb
667602ad3b3SJon Loeliger		CONFIG_CMD_LOADS	  loads
66802c9aa1dSRobin Getz		CONFIG_CMD_MD5SUM	  print md5 message digest
66902c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
670602ad3b3SJon Loeliger		CONFIG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
67156523f12Swdenk					  loop, loopw, mtest
672602ad3b3SJon Loeliger		CONFIG_CMD_MISC		  Misc functions like sleep etc
673602ad3b3SJon Loeliger		CONFIG_CMD_MMC		* MMC memory mapped support
674602ad3b3SJon Loeliger		CONFIG_CMD_MII		* MII utility commands
67568d7d651SStefan Roese		CONFIG_CMD_MTDPARTS	* MTD partition support
676602ad3b3SJon Loeliger		CONFIG_CMD_NAND		* NAND support
677602ad3b3SJon Loeliger		CONFIG_CMD_NET		  bootp, tftpboot, rarpboot
678e92739d3SPeter Tyser		CONFIG_CMD_PCA953X	* PCA953x I2C gpio commands
679e92739d3SPeter Tyser		CONFIG_CMD_PCA953X_INFO	* PCA953x I2C gpio info command
680602ad3b3SJon Loeliger		CONFIG_CMD_PCI		* pciinfo
681602ad3b3SJon Loeliger		CONFIG_CMD_PCMCIA		* PCMCIA support
682602ad3b3SJon Loeliger		CONFIG_CMD_PING		* send ICMP ECHO_REQUEST to network
683602ad3b3SJon Loeliger					  host
684602ad3b3SJon Loeliger		CONFIG_CMD_PORTIO	* Port I/O
685602ad3b3SJon Loeliger		CONFIG_CMD_REGINFO	* Register dump
686602ad3b3SJon Loeliger		CONFIG_CMD_RUN		  run command in env variable
687602ad3b3SJon Loeliger		CONFIG_CMD_SAVES	* save S record dump
688602ad3b3SJon Loeliger		CONFIG_CMD_SCSI		* SCSI Support
689602ad3b3SJon Loeliger		CONFIG_CMD_SDRAM	* print SDRAM configuration information
690602ad3b3SJon Loeliger					  (requires CONFIG_CMD_I2C)
691602ad3b3SJon Loeliger		CONFIG_CMD_SETGETDCR	  Support for DCR Register access
692602ad3b3SJon Loeliger					  (4xx only)
69302c9aa1dSRobin Getz		CONFIG_CMD_SHA1		  print sha1 memory digest
69402c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY)
69574de7aefSWolfgang Denk		CONFIG_CMD_SOURCE	  "source" command Support
696602ad3b3SJon Loeliger		CONFIG_CMD_SPI		* SPI serial bus support
697602ad3b3SJon Loeliger		CONFIG_CMD_USB		* USB support
698602ad3b3SJon Loeliger		CONFIG_CMD_VFD		* VFD support (TRAB)
699602ad3b3SJon Loeliger		CONFIG_CMD_CDP		* Cisco Discover Protocol support
700602ad3b3SJon Loeliger		CONFIG_CMD_FSL		* Microblaze FSL support
701c609719bSwdenk
702c609719bSwdenk
703c609719bSwdenk		EXAMPLE: If you want all functions except of network
704c609719bSwdenk		support you can write:
705c609719bSwdenk
706602ad3b3SJon Loeliger		#include "config_cmd_all.h"
707602ad3b3SJon Loeliger		#undef CONFIG_CMD_NET
708c609719bSwdenk
709213bf8c8SGerald Van Baren	Other Commands:
710213bf8c8SGerald Van Baren		fdt (flattened device tree) command: CONFIG_OF_LIBFDT
711c609719bSwdenk
712c609719bSwdenk	Note:	Don't enable the "icache" and "dcache" commands
713602ad3b3SJon Loeliger		(configuration option CONFIG_CMD_CACHE) unless you know
714c609719bSwdenk		what you (and your U-Boot users) are doing. Data
715c609719bSwdenk		cache cannot be enabled on systems like the 8xx or
716c609719bSwdenk		8260 (where accesses to the IMMR region must be
717c609719bSwdenk		uncached), and it cannot be disabled on all other
718c609719bSwdenk		systems where we (mis-) use the data cache to hold an
719c609719bSwdenk		initial stack and some data.
720c609719bSwdenk
721c609719bSwdenk
722c609719bSwdenk		XXX - this list needs to get updated!
723c609719bSwdenk
724c609719bSwdenk- Watchdog:
725c609719bSwdenk		CONFIG_WATCHDOG
726c609719bSwdenk		If this variable is defined, it enables watchdog
7277152b1d0Swdenk		support. There must be support in the platform specific
728c609719bSwdenk		code for a watchdog. For the 8xx and 8260 CPUs, the
729c609719bSwdenk		SIU Watchdog feature is enabled in the SYPCR
730c609719bSwdenk		register.
731c609719bSwdenk
732c1551ea8Sstroese- U-Boot Version:
733c1551ea8Sstroese		CONFIG_VERSION_VARIABLE
734c1551ea8Sstroese		If this variable is defined, an environment variable
735c1551ea8Sstroese		named "ver" is created by U-Boot showing the U-Boot
736c1551ea8Sstroese		version as printed by the "version" command.
737c1551ea8Sstroese		This variable is readonly.
738c1551ea8Sstroese
739c609719bSwdenk- Real-Time Clock:
740c609719bSwdenk
741602ad3b3SJon Loeliger		When CONFIG_CMD_DATE is selected, the type of the RTC
742c609719bSwdenk		has to be selected, too. Define exactly one of the
743c609719bSwdenk		following options:
744c609719bSwdenk
745c609719bSwdenk		CONFIG_RTC_MPC8xx	- use internal RTC of MPC8xx
746c609719bSwdenk		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
7477ce63709SGuennadi Liakhovetski		CONFIG_RTC_MC13783	- use MC13783 RTC
748c609719bSwdenk		CONFIG_RTC_MC146818	- use MC146818 RTC
7491cb8e980Swdenk		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
750c609719bSwdenk		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
7517f70e853Swdenk		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
7523bac3513Swdenk		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
7539536dfccSTor Krill		CONFIG_RTC_ISL1208	- use Intersil ISL1208 RTC
7544c0d4c3bSwdenk		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
7556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_DS1337_NOOSC	- Turn off the OSC output for DS1337
756c609719bSwdenk
757b37c7e5eSwdenk		Note that if the RTC uses I2C, then the I2C interface
758b37c7e5eSwdenk		must also be configured. See I2C Support, below.
759b37c7e5eSwdenk
760e92739d3SPeter Tyser- GPIO Support:
761e92739d3SPeter Tyser		CONFIG_PCA953X		- use NXP's PCA953X series I2C GPIO
762e92739d3SPeter Tyser		CONFIG_PCA953X_INFO	- enable pca953x info command
763e92739d3SPeter Tyser
764e92739d3SPeter Tyser		Note that if the GPIO device uses I2C, then the I2C interface
765e92739d3SPeter Tyser		must also be configured. See I2C Support, below.
766e92739d3SPeter Tyser
767c609719bSwdenk- Timestamp Support:
768c609719bSwdenk
769c609719bSwdenk		When CONFIG_TIMESTAMP is selected, the timestamp
770c609719bSwdenk		(date and time) of an image is printed by image
771c609719bSwdenk		commands like bootm or iminfo. This option is
772602ad3b3SJon Loeliger		automatically enabled when you select CONFIG_CMD_DATE .
773c609719bSwdenk
774c609719bSwdenk- Partition Support:
775c609719bSwdenk		CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
77607f3d789Srichardretanubun		and/or CONFIG_ISO_PARTITION and/or CONFIG_EFI_PARTITION
777c609719bSwdenk
778602ad3b3SJon Loeliger		If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
779218ca724SWolfgang Denk		CONFIG_CMD_SCSI) you must configure support for at
780218ca724SWolfgang Denk		least one partition type as well.
781c609719bSwdenk
782c609719bSwdenk- IDE Reset method:
7834d13cbadSwdenk		CONFIG_IDE_RESET_ROUTINE - this is defined in several
7844d13cbadSwdenk		board configurations files but used nowhere!
785c609719bSwdenk
7864d13cbadSwdenk		CONFIG_IDE_RESET - is this is defined, IDE Reset will
7874d13cbadSwdenk		be performed by calling the function
7884d13cbadSwdenk			ide_set_reset(int reset)
7894d13cbadSwdenk		which has to be defined in a board specific file
790c609719bSwdenk
791c609719bSwdenk- ATAPI Support:
792c609719bSwdenk		CONFIG_ATAPI
793c609719bSwdenk
794c609719bSwdenk		Set this to enable ATAPI support.
795c609719bSwdenk
796c40b2956Swdenk- LBA48 Support
797c40b2956Swdenk		CONFIG_LBA48
798c40b2956Swdenk
799c40b2956Swdenk		Set this to enable support for disks larger than 137GB
8004b142febSHeiko Schocher		Also look at CONFIG_SYS_64BIT_LBA.
801c40b2956Swdenk		Whithout these , LBA48 support uses 32bit variables and will 'only'
802c40b2956Swdenk		support disks up to 2.1TB.
803c40b2956Swdenk
8046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_64BIT_LBA:
805c40b2956Swdenk			When enabled, makes the IDE subsystem use 64bit sector addresses.
806c40b2956Swdenk			Default is 32bit.
807c40b2956Swdenk
808c609719bSwdenk- SCSI Support:
809c609719bSwdenk		At the moment only there is only support for the
810c609719bSwdenk		SYM53C8XX SCSI controller; define
811c609719bSwdenk		CONFIG_SCSI_SYM53C8XX to enable it.
812c609719bSwdenk
8136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
8146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
8156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
816c609719bSwdenk		maximum numbers of LUNs, SCSI ID's and target
817c609719bSwdenk		devices.
8186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
819c609719bSwdenk
820c609719bSwdenk- NETWORK Support (PCI):
821682011ffSwdenk		CONFIG_E1000
822682011ffSwdenk		Support for Intel 8254x gigabit chips.
823682011ffSwdenk
824ac3315c2SAndre Schwarz		CONFIG_E1000_FALLBACK_MAC
82511ccc33fSMarcel Ziswiler		default MAC for empty EEPROM after production.
826ac3315c2SAndre Schwarz
827c609719bSwdenk		CONFIG_EEPRO100
828c609719bSwdenk		Support for Intel 82557/82559/82559ER chips.
82911ccc33fSMarcel Ziswiler		Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
830c609719bSwdenk		write routine for first time initialisation.
831c609719bSwdenk
832c609719bSwdenk		CONFIG_TULIP
833c609719bSwdenk		Support for Digital 2114x chips.
834c609719bSwdenk		Optional CONFIG_TULIP_SELECT_MEDIA for board specific
835c609719bSwdenk		modem chip initialisation (KS8761/QS6611).
836c609719bSwdenk
837c609719bSwdenk		CONFIG_NATSEMI
838c609719bSwdenk		Support for National dp83815 chips.
839c609719bSwdenk
840c609719bSwdenk		CONFIG_NS8382X
841c609719bSwdenk		Support for National dp8382[01] gigabit chips.
842c609719bSwdenk
84345219c46Swdenk- NETWORK Support (other):
84445219c46Swdenk
845c041e9d2SJens Scharsig		CONFIG_DRIVER_AT91EMAC
846c041e9d2SJens Scharsig		Support for AT91RM9200 EMAC.
847c041e9d2SJens Scharsig
848c041e9d2SJens Scharsig			CONFIG_RMII
849c041e9d2SJens Scharsig			Define this to use reduced MII inteface
850c041e9d2SJens Scharsig
851c041e9d2SJens Scharsig			CONFIG_DRIVER_AT91EMAC_QUIET
852c041e9d2SJens Scharsig			If this defined, the driver is quiet.
853c041e9d2SJens Scharsig			The driver doen't show link status messages.
854c041e9d2SJens Scharsig
85545219c46Swdenk		CONFIG_DRIVER_LAN91C96
85645219c46Swdenk		Support for SMSC's LAN91C96 chips.
85745219c46Swdenk
85845219c46Swdenk			CONFIG_LAN91C96_BASE
85945219c46Swdenk			Define this to hold the physical address
86045219c46Swdenk			of the LAN91C96's I/O space
86145219c46Swdenk
86245219c46Swdenk			CONFIG_LAN91C96_USE_32_BIT
86345219c46Swdenk			Define this to enable 32 bit addressing
86445219c46Swdenk
865f39748aeSwdenk		CONFIG_DRIVER_SMC91111
866f39748aeSwdenk		Support for SMSC's LAN91C111 chip
867f39748aeSwdenk
868f39748aeSwdenk			CONFIG_SMC91111_BASE
869f39748aeSwdenk			Define this to hold the physical address
870f39748aeSwdenk			of the device (I/O space)
871f39748aeSwdenk
872f39748aeSwdenk			CONFIG_SMC_USE_32_BIT
873f39748aeSwdenk			Define this if data bus is 32 bits
874f39748aeSwdenk
875f39748aeSwdenk			CONFIG_SMC_USE_IOFUNCS
876f39748aeSwdenk			Define this to use i/o functions instead of macros
877f39748aeSwdenk			(some hardware wont work with macros)
878f39748aeSwdenk
879c2fff331SMike Rapoport		CONFIG_SMC911X
880557b377dSJens Gehrlein		Support for SMSC's LAN911x and LAN921x chips
881557b377dSJens Gehrlein
882c2fff331SMike Rapoport			CONFIG_SMC911X_BASE
883557b377dSJens Gehrlein			Define this to hold the physical address
884557b377dSJens Gehrlein			of the device (I/O space)
885557b377dSJens Gehrlein
886c2fff331SMike Rapoport			CONFIG_SMC911X_32_BIT
887557b377dSJens Gehrlein			Define this if data bus is 32 bits
888557b377dSJens Gehrlein
889c2fff331SMike Rapoport			CONFIG_SMC911X_16_BIT
890557b377dSJens Gehrlein			Define this if data bus is 16 bits. If your processor
891557b377dSJens Gehrlein			automatically converts one 32 bit word to two 16 bit
892c2fff331SMike Rapoport			words you may also try CONFIG_SMC911X_32_BIT.
893557b377dSJens Gehrlein
894c609719bSwdenk- USB Support:
895c609719bSwdenk		At the moment only the UHCI host controller is
8964d13cbadSwdenk		supported (PIP405, MIP405, MPC5200); define
897c609719bSwdenk		CONFIG_USB_UHCI to enable it.
898c609719bSwdenk		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
89930d56faeSwdenk		and define CONFIG_USB_STORAGE to enable the USB
900c609719bSwdenk		storage devices.
901c609719bSwdenk		Note:
902c609719bSwdenk		Supported are USB Keyboards and USB Floppy drives
903c609719bSwdenk		(TEAC FD-05PUB).
9044d13cbadSwdenk		MPC5200 USB requires additional defines:
9054d13cbadSwdenk			CONFIG_USB_CLOCK
9064d13cbadSwdenk				for 528 MHz Clock: 0x0001bbbb
907307ecb6dSEric Millbrandt			CONFIG_PSC3_USB
908307ecb6dSEric Millbrandt				for USB on PSC3
9094d13cbadSwdenk			CONFIG_USB_CONFIG
9104d13cbadSwdenk				for differential drivers: 0x00001000
9114d13cbadSwdenk				for single ended drivers: 0x00005000
912307ecb6dSEric Millbrandt				for differential drivers on PSC3: 0x00000100
913307ecb6dSEric Millbrandt				for single ended drivers on PSC3: 0x00004100
9146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_USB_EVENT_POLL
915fdcfaa1bSZhang Wei				May be defined to allow interrupt polling
916fdcfaa1bSZhang Wei				instead of using asynchronous interrupts
9174d13cbadSwdenk
91816c8d5e7SWolfgang Denk- USB Device:
91916c8d5e7SWolfgang Denk		Define the below if you wish to use the USB console.
92016c8d5e7SWolfgang Denk		Once firmware is rebuilt from a serial console issue the
92116c8d5e7SWolfgang Denk		command "setenv stdin usbtty; setenv stdout usbtty" and
92211ccc33fSMarcel Ziswiler		attach your USB cable. The Unix command "dmesg" should print
92316c8d5e7SWolfgang Denk		it has found a new device. The environment variable usbtty
92416c8d5e7SWolfgang Denk		can be set to gserial or cdc_acm to enable your device to
92516c8d5e7SWolfgang Denk		appear to a USB host as a Linux gserial device or a
92616c8d5e7SWolfgang Denk		Common Device Class Abstract Control Model serial device.
92716c8d5e7SWolfgang Denk		If you select usbtty = gserial you should be able to enumerate
92816c8d5e7SWolfgang Denk		a Linux host by
92916c8d5e7SWolfgang Denk		# modprobe usbserial vendor=0xVendorID product=0xProductID
93016c8d5e7SWolfgang Denk		else if using cdc_acm, simply setting the environment
93116c8d5e7SWolfgang Denk		variable usbtty to be cdc_acm should suffice. The following
93216c8d5e7SWolfgang Denk		might be defined in YourBoardName.h
93316c8d5e7SWolfgang Denk
93416c8d5e7SWolfgang Denk			CONFIG_USB_DEVICE
93516c8d5e7SWolfgang Denk			Define this to build a UDC device
93616c8d5e7SWolfgang Denk
93716c8d5e7SWolfgang Denk			CONFIG_USB_TTY
93816c8d5e7SWolfgang Denk			Define this to have a tty type of device available to
93916c8d5e7SWolfgang Denk			talk to the UDC device
94016c8d5e7SWolfgang Denk
9416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_IS_IN_ENV
94216c8d5e7SWolfgang Denk			Define this if you want stdin, stdout &/or stderr to
94316c8d5e7SWolfgang Denk			be set to usbtty.
94416c8d5e7SWolfgang Denk
94516c8d5e7SWolfgang Denk			mpc8xx:
9466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_EXTC_CLK 0xBLAH
94716c8d5e7SWolfgang Denk				Derive USB clock from external clock "blah"
9486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_EXTC_CLK 0x02
94916c8d5e7SWolfgang Denk
9506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_BRG_CLK 0xBLAH
95116c8d5e7SWolfgang Denk				Derive USB clock from brgclk
9526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_BRG_CLK 0x04
95316c8d5e7SWolfgang Denk
95416c8d5e7SWolfgang Denk		If you have a USB-IF assigned VendorID then you may wish to
95516c8d5e7SWolfgang Denk		define your own vendor specific values either in BoardName.h
95616c8d5e7SWolfgang Denk		or directly in usbd_vendor_info.h. If you don't define
95716c8d5e7SWolfgang Denk		CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
95816c8d5e7SWolfgang Denk		CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
95916c8d5e7SWolfgang Denk		should pretend to be a Linux device to it's target host.
96016c8d5e7SWolfgang Denk
96116c8d5e7SWolfgang Denk			CONFIG_USBD_MANUFACTURER
96216c8d5e7SWolfgang Denk			Define this string as the name of your company for
96316c8d5e7SWolfgang Denk			- CONFIG_USBD_MANUFACTURER "my company"
96416c8d5e7SWolfgang Denk
96516c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCT_NAME
96616c8d5e7SWolfgang Denk			Define this string as the name of your product
96716c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCT_NAME "acme usb device"
96816c8d5e7SWolfgang Denk
96916c8d5e7SWolfgang Denk			CONFIG_USBD_VENDORID
97016c8d5e7SWolfgang Denk			Define this as your assigned Vendor ID from the USB
97116c8d5e7SWolfgang Denk			Implementors Forum. This *must* be a genuine Vendor ID
97216c8d5e7SWolfgang Denk			to avoid polluting the USB namespace.
97316c8d5e7SWolfgang Denk			- CONFIG_USBD_VENDORID 0xFFFF
97416c8d5e7SWolfgang Denk
97516c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCTID
97616c8d5e7SWolfgang Denk			Define this as the unique Product ID
97716c8d5e7SWolfgang Denk			for your device
97816c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCTID 0xFFFF
979c609719bSwdenk
980c609719bSwdenk
981c609719bSwdenk- MMC Support:
982c609719bSwdenk		The MMC controller on the Intel PXA is supported. To
983c609719bSwdenk		enable this define CONFIG_MMC. The MMC can be
984c609719bSwdenk		accessed from the boot prompt by mapping the device
985c609719bSwdenk		to physical memory similar to flash. Command line is
986602ad3b3SJon Loeliger		enabled with CONFIG_CMD_MMC. The MMC driver also works with
987602ad3b3SJon Loeliger		the FAT fs. This is enabled with CONFIG_CMD_FAT.
988c609719bSwdenk
9896705d81eSwdenk- Journaling Flash filesystem support:
9906705d81eSwdenk		CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
9916705d81eSwdenk		CONFIG_JFFS2_NAND_DEV
9926705d81eSwdenk		Define these for a default partition on a NAND device
9936705d81eSwdenk
9946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_SECTOR,
9956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
9966705d81eSwdenk		Define these for a default partition on a NOR device
9976705d81eSwdenk
9986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS_CUSTOM_PART
9996705d81eSwdenk		Define this to create an own partition. You have to provide a
10006705d81eSwdenk		function struct part_info* jffs2_part_info(int part_num)
10016705d81eSwdenk
10026705d81eSwdenk		If you define only one JFFS2 partition you may also want to
10036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_JFFS_SINGLE_PART	1
10046705d81eSwdenk		to disable the command chpart. This is the default when you
10056705d81eSwdenk		have not defined a custom partition
10066705d81eSwdenk
1007c609719bSwdenk- Keyboard Support:
1008c609719bSwdenk		CONFIG_ISA_KEYBOARD
1009c609719bSwdenk
1010c609719bSwdenk		Define this to enable standard (PC-Style) keyboard
1011c609719bSwdenk		support
1012c609719bSwdenk
1013c609719bSwdenk		CONFIG_I8042_KBD
1014c609719bSwdenk		Standard PC keyboard driver with US (is default) and
1015c609719bSwdenk		GERMAN key layout (switch via environment 'keymap=de') support.
1016c609719bSwdenk		Export function i8042_kbd_init, i8042_tstc and i8042_getc
1017c609719bSwdenk		for cfb_console. Supports cursor blinking.
1018c609719bSwdenk
1019c609719bSwdenk- Video support:
1020c609719bSwdenk		CONFIG_VIDEO
1021c609719bSwdenk
1022c609719bSwdenk		Define this to enable video support (for output to
1023c609719bSwdenk		video).
1024c609719bSwdenk
1025c609719bSwdenk		CONFIG_VIDEO_CT69000
1026c609719bSwdenk
1027c609719bSwdenk		Enable Chips & Technologies 69000 Video chip
1028c609719bSwdenk
1029c609719bSwdenk		CONFIG_VIDEO_SMI_LYNXEM
1030eeb1b77bSwdenk		Enable Silicon Motion SMI 712/710/810 Video chip. The
1031eeb1b77bSwdenk		video output is selected via environment 'videoout'
1032eeb1b77bSwdenk		(1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1033eeb1b77bSwdenk		assumed.
1034c609719bSwdenk
1035eeb1b77bSwdenk		For the CT69000 and SMI_LYNXEM drivers, videomode is
103611ccc33fSMarcel Ziswiler		selected via environment 'videomode'. Two different ways
1037eeb1b77bSwdenk		are possible:
1038eeb1b77bSwdenk		- "videomode=num"   'num' is a standard LiLo mode numbers.
1039eeb1b77bSwdenk		Following standard modes are supported	(* is default):
1040eeb1b77bSwdenk
1041eeb1b77bSwdenk		      Colors	640x480 800x600 1024x768 1152x864 1280x1024
1042eeb1b77bSwdenk		-------------+---------------------------------------------
1043eeb1b77bSwdenk		      8 bits |	0x301*	0x303	 0x305	  0x161	    0x307
1044eeb1b77bSwdenk		     15 bits |	0x310	0x313	 0x316	  0x162	    0x319
1045eeb1b77bSwdenk		     16 bits |	0x311	0x314	 0x317	  0x163	    0x31A
1046eeb1b77bSwdenk		     24 bits |	0x312	0x315	 0x318	    ?	    0x31B
1047eeb1b77bSwdenk		-------------+---------------------------------------------
1048c609719bSwdenk		(i.e. setenv videomode 317; saveenv; reset;)
1049c609719bSwdenk
1050eeb1b77bSwdenk		- "videomode=bootargs" all the video parameters are parsed
10517817cb20SMarcel Ziswiler		from the bootargs. (See drivers/video/videomodes.c)
1052eeb1b77bSwdenk
1053eeb1b77bSwdenk
1054a6c7ad2fSwdenk		CONFIG_VIDEO_SED13806
1055a6c7ad2fSwdenk		Enable Epson SED13806 driver. This driver supports 8bpp
1056a6c7ad2fSwdenk		and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1057a6c7ad2fSwdenk		or CONFIG_VIDEO_SED13806_16BPP
1058a6c7ad2fSwdenk
1059682011ffSwdenk- Keyboard Support:
1060682011ffSwdenk		CONFIG_KEYBOARD
1061682011ffSwdenk
1062682011ffSwdenk		Define this to enable a custom keyboard support.
1063682011ffSwdenk		This simply calls drv_keyboard_init() which must be
1064682011ffSwdenk		defined in your board-specific files.
1065682011ffSwdenk		The only board using this so far is RBC823.
1066a6c7ad2fSwdenk
1067c609719bSwdenk- LCD Support:	CONFIG_LCD
1068c609719bSwdenk
1069c609719bSwdenk		Define this to enable LCD support (for output to LCD
1070c609719bSwdenk		display); also select one of the supported displays
1071c609719bSwdenk		by defining one of these:
1072c609719bSwdenk
107339cf4804SStelian Pop		CONFIG_ATMEL_LCD:
107439cf4804SStelian Pop
107539cf4804SStelian Pop			HITACHI TX09D70VM1CCA, 3.5", 240x320.
107639cf4804SStelian Pop
1077fd3103bbSwdenk		CONFIG_NEC_NL6448AC33:
1078c609719bSwdenk
1079fd3103bbSwdenk			NEC NL6448AC33-18. Active, color, single scan.
1080c609719bSwdenk
1081fd3103bbSwdenk		CONFIG_NEC_NL6448BC20
1082c609719bSwdenk
1083fd3103bbSwdenk			NEC NL6448BC20-08. 6.5", 640x480.
1084fd3103bbSwdenk			Active, color, single scan.
1085fd3103bbSwdenk
1086fd3103bbSwdenk		CONFIG_NEC_NL6448BC33_54
1087fd3103bbSwdenk
1088fd3103bbSwdenk			NEC NL6448BC33-54. 10.4", 640x480.
1089c609719bSwdenk			Active, color, single scan.
1090c609719bSwdenk
1091c609719bSwdenk		CONFIG_SHARP_16x9
1092c609719bSwdenk
1093c609719bSwdenk			Sharp 320x240. Active, color, single scan.
1094c609719bSwdenk			It isn't 16x9, and I am not sure what it is.
1095c609719bSwdenk
1096c609719bSwdenk		CONFIG_SHARP_LQ64D341
1097c609719bSwdenk
1098c609719bSwdenk			Sharp LQ64D341 display, 640x480.
1099c609719bSwdenk			Active, color, single scan.
1100c609719bSwdenk
1101c609719bSwdenk		CONFIG_HLD1045
1102c609719bSwdenk
1103c609719bSwdenk			HLD1045 display, 640x480.
1104c609719bSwdenk			Active, color, single scan.
1105c609719bSwdenk
1106c609719bSwdenk		CONFIG_OPTREX_BW
1107c609719bSwdenk
1108c609719bSwdenk			Optrex	 CBL50840-2 NF-FW 99 22 M5
1109c609719bSwdenk			or
1110c609719bSwdenk			Hitachi	 LMG6912RPFC-00T
1111c609719bSwdenk			or
1112c609719bSwdenk			Hitachi	 SP14Q002
1113c609719bSwdenk
1114c609719bSwdenk			320x240. Black & white.
1115c609719bSwdenk
1116c609719bSwdenk		Normally display is black on white background; define
11176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
1118c609719bSwdenk
11197152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN
1120d791b1dcSwdenk
1121d791b1dcSwdenk		If this option is set, the environment is checked for
1122d791b1dcSwdenk		a variable "splashimage". If found, the usual display
1123d791b1dcSwdenk		of logo, copyright and system information on the LCD
1124e94d2cd9Swdenk		is suppressed and the BMP image at the address
1125d791b1dcSwdenk		specified in "splashimage" is loaded instead. The
1126d791b1dcSwdenk		console is redirected to the "nulldev", too. This
1127d791b1dcSwdenk		allows for a "silent" boot where a splash screen is
1128d791b1dcSwdenk		loaded very quickly after power-on.
1129d791b1dcSwdenk
11301ca298ceSMatthias Weisser		CONFIG_SPLASH_SCREEN_ALIGN
11311ca298ceSMatthias Weisser
11321ca298ceSMatthias Weisser		If this option is set the splash image can be freely positioned
11331ca298ceSMatthias Weisser		on the screen. Environment variable "splashpos" specifies the
11341ca298ceSMatthias Weisser		position as "x,y". If a positive number is given it is used as
11351ca298ceSMatthias Weisser		number of pixel from left/top. If a negative number is given it
11361ca298ceSMatthias Weisser		is used as number of pixel from right/bottom. You can also
11371ca298ceSMatthias Weisser		specify 'm' for centering the image.
11381ca298ceSMatthias Weisser
11391ca298ceSMatthias Weisser		Example:
11401ca298ceSMatthias Weisser		setenv splashpos m,m
11411ca298ceSMatthias Weisser			=> image at center of screen
11421ca298ceSMatthias Weisser
11431ca298ceSMatthias Weisser		setenv splashpos 30,20
11441ca298ceSMatthias Weisser			=> image at x = 30 and y = 20
11451ca298ceSMatthias Weisser
11461ca298ceSMatthias Weisser		setenv splashpos -10,m
11471ca298ceSMatthias Weisser			=> vertically centered image
11481ca298ceSMatthias Weisser			   at x = dspWidth - bmpWidth - 9
11491ca298ceSMatthias Weisser
115098f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
115198f4a3dfSStefan Roese
115298f4a3dfSStefan Roese		If this option is set, additionally to standard BMP
115398f4a3dfSStefan Roese		images, gzipped BMP images can be displayed via the
115498f4a3dfSStefan Roese		splashscreen support or the bmp command.
115598f4a3dfSStefan Roese
1156d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1157d5011762SAnatolij Gustschin
1158d5011762SAnatolij Gustschin		If this option is set, 8-bit RLE compressed BMP images
1159d5011762SAnatolij Gustschin		can be displayed via the splashscreen support or the
1160d5011762SAnatolij Gustschin		bmp command.
1161d5011762SAnatolij Gustschin
1162c29fdfc1Swdenk- Compression support:
1163c29fdfc1Swdenk		CONFIG_BZIP2
1164c29fdfc1Swdenk
1165c29fdfc1Swdenk		If this option is set, support for bzip2 compressed
1166c29fdfc1Swdenk		images is included. If not, only uncompressed and gzip
1167c29fdfc1Swdenk		compressed images are supported.
1168c29fdfc1Swdenk
1169c29fdfc1Swdenk		NOTE: the bzip2 algorithm requires a lot of RAM, so
11706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
1171c29fdfc1Swdenk		be at least 4MB.
1172d791b1dcSwdenk
1173fc9c1727SLuigi 'Comio' Mantellini		CONFIG_LZMA
1174fc9c1727SLuigi 'Comio' Mantellini
1175fc9c1727SLuigi 'Comio' Mantellini		If this option is set, support for lzma compressed
1176fc9c1727SLuigi 'Comio' Mantellini		images is included.
1177fc9c1727SLuigi 'Comio' Mantellini
1178fc9c1727SLuigi 'Comio' Mantellini		Note: The LZMA algorithm adds between 2 and 4KB of code and it
1179fc9c1727SLuigi 'Comio' Mantellini		requires an amount of dynamic memory that is given by the
1180fc9c1727SLuigi 'Comio' Mantellini		formula:
1181fc9c1727SLuigi 'Comio' Mantellini
1182fc9c1727SLuigi 'Comio' Mantellini			(1846 + 768 << (lc + lp)) * sizeof(uint16)
1183fc9c1727SLuigi 'Comio' Mantellini
1184fc9c1727SLuigi 'Comio' Mantellini		Where lc and lp stand for, respectively, Literal context bits
1185fc9c1727SLuigi 'Comio' Mantellini		and Literal pos bits.
1186fc9c1727SLuigi 'Comio' Mantellini
1187fc9c1727SLuigi 'Comio' Mantellini		This value is upper-bounded by 14MB in the worst case. Anyway,
1188fc9c1727SLuigi 'Comio' Mantellini		for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1189fc9c1727SLuigi 'Comio' Mantellini		total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1190fc9c1727SLuigi 'Comio' Mantellini		a very small buffer.
1191fc9c1727SLuigi 'Comio' Mantellini
1192fc9c1727SLuigi 'Comio' Mantellini		Use the lzmainfo tool to determinate the lc and lp values and
1193fc9c1727SLuigi 'Comio' Mantellini		then calculate the amount of needed dynamic memory (ensuring
11946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the appropriate CONFIG_SYS_MALLOC_LEN value).
1195fc9c1727SLuigi 'Comio' Mantellini
119617ea1177Swdenk- MII/PHY support:
119717ea1177Swdenk		CONFIG_PHY_ADDR
119817ea1177Swdenk
119917ea1177Swdenk		The address of PHY on MII bus.
120017ea1177Swdenk
120117ea1177Swdenk		CONFIG_PHY_CLOCK_FREQ (ppc4xx)
120217ea1177Swdenk
120317ea1177Swdenk		The clock frequency of the MII bus
120417ea1177Swdenk
120517ea1177Swdenk		CONFIG_PHY_GIGE
120617ea1177Swdenk
120717ea1177Swdenk		If this option is set, support for speed/duplex
120811ccc33fSMarcel Ziswiler		detection of gigabit PHY is included.
120917ea1177Swdenk
121017ea1177Swdenk		CONFIG_PHY_RESET_DELAY
121117ea1177Swdenk
121217ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
121317ea1177Swdenk		reset before any MII register access is possible.
121417ea1177Swdenk		For such PHY, set this option to the usec delay
121517ea1177Swdenk		required. (minimum 300usec for LXT971A)
121617ea1177Swdenk
121717ea1177Swdenk		CONFIG_PHY_CMD_DELAY (ppc4xx)
121817ea1177Swdenk
121917ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
122017ea1177Swdenk		command issued before MII status register can be read
122117ea1177Swdenk
1222c609719bSwdenk- Ethernet address:
1223c609719bSwdenk		CONFIG_ETHADDR
1224c68a05feSrichardretanubun		CONFIG_ETH1ADDR
1225c609719bSwdenk		CONFIG_ETH2ADDR
1226c609719bSwdenk		CONFIG_ETH3ADDR
1227c68a05feSrichardretanubun		CONFIG_ETH4ADDR
1228c68a05feSrichardretanubun		CONFIG_ETH5ADDR
1229c609719bSwdenk
123011ccc33fSMarcel Ziswiler		Define a default value for Ethernet address to use
123111ccc33fSMarcel Ziswiler		for the respective Ethernet interface, in case this
1232c609719bSwdenk		is not determined automatically.
1233c609719bSwdenk
1234c609719bSwdenk- IP address:
1235c609719bSwdenk		CONFIG_IPADDR
1236c609719bSwdenk
1237c609719bSwdenk		Define a default value for the IP address to use for
123811ccc33fSMarcel Ziswiler		the default Ethernet interface, in case this is not
1239c609719bSwdenk		determined through e.g. bootp.
1240c609719bSwdenk
1241c609719bSwdenk- Server IP address:
1242c609719bSwdenk		CONFIG_SERVERIP
1243c609719bSwdenk
1244c609719bSwdenk		Defines a default value for the IP address of a TFTP
1245c609719bSwdenk		server to contact when using the "tftboot" command.
1246c609719bSwdenk
124797cfe861SRobin Getz		CONFIG_KEEP_SERVERADDR
124897cfe861SRobin Getz
124997cfe861SRobin Getz		Keeps the server's MAC address, in the env 'serveraddr'
125097cfe861SRobin Getz		for passing to bootargs (like Linux's netconsole option)
125197cfe861SRobin Getz
125253a5c424SDavid Updegraff- Multicast TFTP Mode:
125353a5c424SDavid Updegraff		CONFIG_MCAST_TFTP
125453a5c424SDavid Updegraff
125553a5c424SDavid Updegraff		Defines whether you want to support multicast TFTP as per
125653a5c424SDavid Updegraff		rfc-2090; for example to work with atftp.  Lets lots of targets
125711ccc33fSMarcel Ziswiler		tftp down the same boot image concurrently.  Note: the Ethernet
125853a5c424SDavid Updegraff		driver in use must provide a function: mcast() to join/leave a
125953a5c424SDavid Updegraff		multicast group.
126053a5c424SDavid Updegraff
126153a5c424SDavid Updegraff		CONFIG_BOOTP_RANDOM_DELAY
1262c609719bSwdenk- BOOTP Recovery Mode:
1263c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY
1264c609719bSwdenk
1265c609719bSwdenk		If you have many targets in a network that try to
1266c609719bSwdenk		boot using BOOTP, you may want to avoid that all
1267c609719bSwdenk		systems send out BOOTP requests at precisely the same
1268c609719bSwdenk		moment (which would happen for instance at recovery
1269c609719bSwdenk		from a power failure, when all systems will try to
1270c609719bSwdenk		boot, thus flooding the BOOTP server. Defining
1271c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1272c609719bSwdenk		inserted before sending out BOOTP requests. The
12736c33c785SWolfgang Denk		following delays are inserted then:
1274c609719bSwdenk
1275c609719bSwdenk		1st BOOTP request:	delay 0 ... 1 sec
1276c609719bSwdenk		2nd BOOTP request:	delay 0 ... 2 sec
1277c609719bSwdenk		3rd BOOTP request:	delay 0 ... 4 sec
1278c609719bSwdenk		4th and following
1279c609719bSwdenk		BOOTP requests:		delay 0 ... 8 sec
1280c609719bSwdenk
1281fe389a82Sstroese- DHCP Advanced Options:
12821fe80d79SJon Loeliger		You can fine tune the DHCP functionality by defining
12831fe80d79SJon Loeliger		CONFIG_BOOTP_* symbols:
1284fe389a82Sstroese
12851fe80d79SJon Loeliger		CONFIG_BOOTP_SUBNETMASK
12861fe80d79SJon Loeliger		CONFIG_BOOTP_GATEWAY
12871fe80d79SJon Loeliger		CONFIG_BOOTP_HOSTNAME
12881fe80d79SJon Loeliger		CONFIG_BOOTP_NISDOMAIN
12891fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTPATH
12901fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTFILESIZE
12911fe80d79SJon Loeliger		CONFIG_BOOTP_DNS
12921fe80d79SJon Loeliger		CONFIG_BOOTP_DNS2
12931fe80d79SJon Loeliger		CONFIG_BOOTP_SEND_HOSTNAME
12941fe80d79SJon Loeliger		CONFIG_BOOTP_NTPSERVER
12951fe80d79SJon Loeliger		CONFIG_BOOTP_TIMEOFFSET
12961fe80d79SJon Loeliger		CONFIG_BOOTP_VENDOREX
1297fe389a82Sstroese
12985d110f0aSWilson Callan		CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
12995d110f0aSWilson Callan		environment variable, not the BOOTP server.
1300fe389a82Sstroese
1301fe389a82Sstroese		CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1302fe389a82Sstroese		serverip from a DHCP server, it is possible that more
1303fe389a82Sstroese		than one DNS serverip is offered to the client.
1304fe389a82Sstroese		If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1305fe389a82Sstroese		serverip will be stored in the additional environment
1306fe389a82Sstroese		variable "dnsip2". The first DNS serverip is always
1307fe389a82Sstroese		stored in the variable "dnsip", when CONFIG_BOOTP_DNS
13081fe80d79SJon Loeliger		is defined.
1309fe389a82Sstroese
1310fe389a82Sstroese		CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1311fe389a82Sstroese		to do a dynamic update of a DNS server. To do this, they
1312fe389a82Sstroese		need the hostname of the DHCP requester.
13135d110f0aSWilson Callan		If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
13141fe80d79SJon Loeliger		of the "hostname" environment variable is passed as
13151fe80d79SJon Loeliger		option 12 to the DHCP server.
1316fe389a82Sstroese
1317d9a2f416SAras Vaichas		CONFIG_BOOTP_DHCP_REQUEST_DELAY
1318d9a2f416SAras Vaichas
1319d9a2f416SAras Vaichas		A 32bit value in microseconds for a delay between
1320d9a2f416SAras Vaichas		receiving a "DHCP Offer" and sending the "DHCP Request".
1321d9a2f416SAras Vaichas		This fixes a problem with certain DHCP servers that don't
1322d9a2f416SAras Vaichas		respond 100% of the time to a "DHCP request". E.g. On an
1323d9a2f416SAras Vaichas		AT91RM9200 processor running at 180MHz, this delay needed
1324d9a2f416SAras Vaichas		to be *at least* 15,000 usec before a Windows Server 2003
1325d9a2f416SAras Vaichas		DHCP server would reply 100% of the time. I recommend at
1326d9a2f416SAras Vaichas		least 50,000 usec to be safe. The alternative is to hope
1327d9a2f416SAras Vaichas		that one of the retries will be successful but note that
1328d9a2f416SAras Vaichas		the DHCP timeout and retry process takes a longer than
1329d9a2f416SAras Vaichas		this delay.
1330d9a2f416SAras Vaichas
1331a3d991bdSwdenk - CDP Options:
1332a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID
1333a3d991bdSwdenk
1334a3d991bdSwdenk		The device id used in CDP trigger frames.
1335a3d991bdSwdenk
1336a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID_PREFIX
1337a3d991bdSwdenk
1338a3d991bdSwdenk		A two character string which is prefixed to the MAC address
1339a3d991bdSwdenk		of the device.
1340a3d991bdSwdenk
1341a3d991bdSwdenk		CONFIG_CDP_PORT_ID
1342a3d991bdSwdenk
1343a3d991bdSwdenk		A printf format string which contains the ascii name of
1344a3d991bdSwdenk		the port. Normally is set to "eth%d" which sets
134511ccc33fSMarcel Ziswiler		eth0 for the first Ethernet, eth1 for the second etc.
1346a3d991bdSwdenk
1347a3d991bdSwdenk		CONFIG_CDP_CAPABILITIES
1348a3d991bdSwdenk
1349a3d991bdSwdenk		A 32bit integer which indicates the device capabilities;
1350a3d991bdSwdenk		0x00000010 for a normal host which does not forwards.
1351a3d991bdSwdenk
1352a3d991bdSwdenk		CONFIG_CDP_VERSION
1353a3d991bdSwdenk
1354a3d991bdSwdenk		An ascii string containing the version of the software.
1355a3d991bdSwdenk
1356a3d991bdSwdenk		CONFIG_CDP_PLATFORM
1357a3d991bdSwdenk
1358a3d991bdSwdenk		An ascii string containing the name of the platform.
1359a3d991bdSwdenk
1360a3d991bdSwdenk		CONFIG_CDP_TRIGGER
1361a3d991bdSwdenk
1362a3d991bdSwdenk		A 32bit integer sent on the trigger.
1363a3d991bdSwdenk
1364a3d991bdSwdenk		CONFIG_CDP_POWER_CONSUMPTION
1365a3d991bdSwdenk
1366a3d991bdSwdenk		A 16bit integer containing the power consumption of the
1367a3d991bdSwdenk		device in .1 of milliwatts.
1368a3d991bdSwdenk
1369a3d991bdSwdenk		CONFIG_CDP_APPLIANCE_VLAN_TYPE
1370a3d991bdSwdenk
1371a3d991bdSwdenk		A byte containing the id of the VLAN.
1372a3d991bdSwdenk
1373c609719bSwdenk- Status LED:	CONFIG_STATUS_LED
1374c609719bSwdenk
1375c609719bSwdenk		Several configurations allow to display the current
1376c609719bSwdenk		status using a LED. For instance, the LED will blink
1377c609719bSwdenk		fast while running U-Boot code, stop blinking as
1378c609719bSwdenk		soon as a reply to a BOOTP request was received, and
1379c609719bSwdenk		start blinking slow once the Linux kernel is running
1380c609719bSwdenk		(supported by a status LED driver in the Linux
1381c609719bSwdenk		kernel). Defining CONFIG_STATUS_LED enables this
1382c609719bSwdenk		feature in U-Boot.
1383c609719bSwdenk
1384c609719bSwdenk- CAN Support:	CONFIG_CAN_DRIVER
1385c609719bSwdenk
1386c609719bSwdenk		Defining CONFIG_CAN_DRIVER enables CAN driver support
1387c609719bSwdenk		on those systems that support this (optional)
1388c609719bSwdenk		feature, like the TQM8xxL modules.
1389c609719bSwdenk
1390c609719bSwdenk- I2C Support:	CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1391c609719bSwdenk
1392b37c7e5eSwdenk		These enable I2C serial bus commands. Defining either of
1393b37c7e5eSwdenk		(but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
139411ccc33fSMarcel Ziswiler		include the appropriate I2C driver for the selected CPU.
1395c609719bSwdenk
1396b37c7e5eSwdenk		This will allow you to use i2c commands at the u-boot
1397602ad3b3SJon Loeliger		command line (as long as you set CONFIG_CMD_I2C in
1398b37c7e5eSwdenk		CONFIG_COMMANDS) and communicate with i2c based realtime
1399b37c7e5eSwdenk		clock chips. See common/cmd_i2c.c for a description of the
1400c609719bSwdenk		command line interface.
1401c609719bSwdenk
1402bb99ad6dSBen Warren		CONFIG_HARD_I2C selects a hardware I2C controller.
1403c609719bSwdenk
1404b37c7e5eSwdenk		CONFIG_SOFT_I2C configures u-boot to use a software (aka
1405b37c7e5eSwdenk		bit-banging) driver instead of CPM or similar hardware
1406b37c7e5eSwdenk		support for I2C.
1407c609719bSwdenk
1408b37c7e5eSwdenk		There are several other quantities that must also be
1409b37c7e5eSwdenk		defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
1410c609719bSwdenk
14116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		In both cases you will need to define CONFIG_SYS_I2C_SPEED
1412b37c7e5eSwdenk		to be the frequency (in Hz) at which you wish your i2c bus
14136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
141411ccc33fSMarcel Ziswiler		the CPU's i2c node address).
1415c609719bSwdenk
14168d321b81SPeter Tyser		Now, the u-boot i2c code for the mpc8xx
1417a47a12beSStefan Roese		(arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
14188d321b81SPeter Tyser		and so its address should therefore be cleared to 0 (See,
14198d321b81SPeter Tyser		eg, MPC823e User's Manual p.16-473). So, set
14208d321b81SPeter Tyser		CONFIG_SYS_I2C_SLAVE to 0.
1421b37c7e5eSwdenk
14225da71efaSEric Millbrandt		CONFIG_SYS_I2C_INIT_MPC5XXX
14235da71efaSEric Millbrandt
14245da71efaSEric Millbrandt		When a board is reset during an i2c bus transfer
14255da71efaSEric Millbrandt		chips might think that the current transfer is still
14265da71efaSEric Millbrandt		in progress.  Reset the slave devices by sending start
14275da71efaSEric Millbrandt		commands until the slave device responds.
14285da71efaSEric Millbrandt
1429b37c7e5eSwdenk		That's all that's required for CONFIG_HARD_I2C.
1430b37c7e5eSwdenk
1431b37c7e5eSwdenk		If you use the software i2c interface (CONFIG_SOFT_I2C)
1432b37c7e5eSwdenk		then the following macros need to be defined (examples are
1433b37c7e5eSwdenk		from include/configs/lwmon.h):
1434c609719bSwdenk
1435c609719bSwdenk		I2C_INIT
1436c609719bSwdenk
1437b37c7e5eSwdenk		(Optional). Any commands necessary to enable the I2C
1438c609719bSwdenk		controller or configure ports.
1439c609719bSwdenk
1440b37c7e5eSwdenk		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
1441b37c7e5eSwdenk
1442c609719bSwdenk		I2C_PORT
1443c609719bSwdenk
1444c609719bSwdenk		(Only for MPC8260 CPU). The I/O port to use (the code
1445c609719bSwdenk		assumes both bits are on the same port). Valid values
1446c609719bSwdenk		are 0..3 for ports A..D.
1447c609719bSwdenk
1448c609719bSwdenk		I2C_ACTIVE
1449c609719bSwdenk
1450c609719bSwdenk		The code necessary to make the I2C data line active
1451c609719bSwdenk		(driven).  If the data line is open collector, this
1452c609719bSwdenk		define can be null.
1453c609719bSwdenk
1454b37c7e5eSwdenk		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
1455b37c7e5eSwdenk
1456c609719bSwdenk		I2C_TRISTATE
1457c609719bSwdenk
1458c609719bSwdenk		The code necessary to make the I2C data line tri-stated
1459c609719bSwdenk		(inactive).  If the data line is open collector, this
1460c609719bSwdenk		define can be null.
1461c609719bSwdenk
1462b37c7e5eSwdenk		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1463b37c7e5eSwdenk
1464c609719bSwdenk		I2C_READ
1465c609719bSwdenk
1466c609719bSwdenk		Code that returns TRUE if the I2C data line is high,
1467c609719bSwdenk		FALSE if it is low.
1468c609719bSwdenk
1469b37c7e5eSwdenk		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1470b37c7e5eSwdenk
1471c609719bSwdenk		I2C_SDA(bit)
1472c609719bSwdenk
1473c609719bSwdenk		If <bit> is TRUE, sets the I2C data line high. If it
1474c609719bSwdenk		is FALSE, it clears it (low).
1475c609719bSwdenk
1476b37c7e5eSwdenk		eg: #define I2C_SDA(bit) \
1477b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
1478b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
1479b37c7e5eSwdenk
1480c609719bSwdenk		I2C_SCL(bit)
1481c609719bSwdenk
1482c609719bSwdenk		If <bit> is TRUE, sets the I2C clock line high. If it
1483c609719bSwdenk		is FALSE, it clears it (low).
1484c609719bSwdenk
1485b37c7e5eSwdenk		eg: #define I2C_SCL(bit) \
1486b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
1487b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
1488b37c7e5eSwdenk
1489c609719bSwdenk		I2C_DELAY
1490c609719bSwdenk
1491c609719bSwdenk		This delay is invoked four times per clock cycle so this
1492c609719bSwdenk		controls the rate of data transfer.  The data rate thus
1493b37c7e5eSwdenk		is 1 / (I2C_DELAY * 4). Often defined to be something
1494b37c7e5eSwdenk		like:
1495b37c7e5eSwdenk
1496b37c7e5eSwdenk		#define I2C_DELAY  udelay(2)
1497c609719bSwdenk
14986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_INIT_BOARD
149947cd00faSwdenk
150047cd00faSwdenk		When a board is reset during an i2c bus transfer
150147cd00faSwdenk		chips might think that the current transfer is still
150247cd00faSwdenk		in progress. On some boards it is possible to access
150347cd00faSwdenk		the i2c SCLK line directly, either by using the
150447cd00faSwdenk		processor pin as a GPIO or by having a second pin
150547cd00faSwdenk		connected to the bus. If this option is defined a
150647cd00faSwdenk		custom i2c_init_board() routine in boards/xxx/board.c
150747cd00faSwdenk		is run early in the boot sequence.
150847cd00faSwdenk
150926a33504SRichard Retanubun		CONFIG_SYS_I2C_BOARD_LATE_INIT
151026a33504SRichard Retanubun
151126a33504SRichard Retanubun		An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
151226a33504SRichard Retanubun		defined a custom i2c_board_late_init() routine in
151326a33504SRichard Retanubun		boards/xxx/board.c is run AFTER the operations in i2c_init()
151426a33504SRichard Retanubun		is completed. This callpoint can be used to unreset i2c bus
151526a33504SRichard Retanubun		using CPU i2c controller register accesses for CPUs whose i2c
151626a33504SRichard Retanubun		controller provide such a method. It is called at the end of
151726a33504SRichard Retanubun		i2c_init() to allow i2c_init operations to setup the i2c bus
151826a33504SRichard Retanubun		controller on the CPU (e.g. setting bus speed & slave address).
151926a33504SRichard Retanubun
152017ea1177Swdenk		CONFIG_I2CFAST (PPC405GP|PPC405EP only)
152117ea1177Swdenk
152217ea1177Swdenk		This option enables configuration of bi_iic_fast[] flags
152317ea1177Swdenk		in u-boot bd_info structure based on u-boot environment
152417ea1177Swdenk		variable "i2cfast". (see also i2cfast)
152517ea1177Swdenk
1526bb99ad6dSBen Warren		CONFIG_I2C_MULTI_BUS
1527bb99ad6dSBen Warren
1528bb99ad6dSBen Warren		This option allows the use of multiple I2C buses, each of which
1529bb99ad6dSBen Warren		must have a controller.  At any point in time, only one bus is
1530bb99ad6dSBen Warren		active.  To switch to a different bus, use the 'i2c dev' command.
1531bb99ad6dSBen Warren		Note that bus numbering is zero-based.
1532bb99ad6dSBen Warren
15336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_NOPROBES
1534bb99ad6dSBen Warren
1535bb99ad6dSBen Warren		This option specifies a list of I2C devices that will be skipped
15360f89c54bSPeter Tyser		when the 'i2c probe' command is issued.  If CONFIG_I2C_MULTI_BUS
15370f89c54bSPeter Tyser		is set, specify a list of bus-device pairs.  Otherwise, specify
15380f89c54bSPeter Tyser		a 1D array of device addresses
1539bb99ad6dSBen Warren
1540bb99ad6dSBen Warren		e.g.
1541bb99ad6dSBen Warren			#undef	CONFIG_I2C_MULTI_BUS
15426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_NOPROBES	{0x50,0x68}
1543bb99ad6dSBen Warren
1544bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on a board with one I2C bus
1545bb99ad6dSBen Warren
1546bb99ad6dSBen Warren			#define	CONFIG_I2C_MULTI_BUS
15476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_MULTI_NOPROBES	{{0,0x50},{0,0x68},{1,0x54}}
1548bb99ad6dSBen Warren
1549bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1550bb99ad6dSBen Warren
15516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SPD_BUS_NUM
1552be5e6181STimur Tabi
1553be5e6181STimur Tabi		If defined, then this indicates the I2C bus number for DDR SPD.
1554be5e6181STimur Tabi		If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1555be5e6181STimur Tabi
15566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_BUS_NUM
15570dc018ecSStefan Roese
15580dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the RTC.
15590dc018ecSStefan Roese		If not defined, then U-Boot assumes that RTC is on I2C bus 0.
15600dc018ecSStefan Roese
15616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_DTT_BUS_NUM
15620dc018ecSStefan Roese
15630dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the DTT.
15640dc018ecSStefan Roese		If not defined, then U-Boot assumes that DTT is on I2C bus 0.
15650dc018ecSStefan Roese
15666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_DTT_ADDR:
15679ebbb54fSVictor Gallardo
15689ebbb54fSVictor Gallardo		If defined, specifies the I2C address of the DTT device.
15699ebbb54fSVictor Gallardo		If not defined, then U-Boot uses predefined value for
15709ebbb54fSVictor Gallardo		specified DTT device.
15719ebbb54fSVictor Gallardo
1572be5e6181STimur Tabi		CONFIG_FSL_I2C
1573be5e6181STimur Tabi
1574be5e6181STimur Tabi		Define this option if you want to use Freescale's I2C driver in
15757817cb20SMarcel Ziswiler		drivers/i2c/fsl_i2c.c.
1576be5e6181STimur Tabi
157767b23a32SHeiko Schocher		CONFIG_I2C_MUX
157867b23a32SHeiko Schocher
157967b23a32SHeiko Schocher		Define this option if you have I2C devices reached over 1 .. n
158067b23a32SHeiko Schocher		I2C Muxes like the pca9544a. This option addes a new I2C
158167b23a32SHeiko Schocher		Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
158267b23a32SHeiko Schocher		new I2C Bus to the existing I2C Busses. If you select the
158367b23a32SHeiko Schocher		new Bus with "i2c dev", u-bbot sends first the commandos for
158467b23a32SHeiko Schocher		the muxes to activate this new "bus".
158567b23a32SHeiko Schocher
158667b23a32SHeiko Schocher		CONFIG_I2C_MULTI_BUS must be also defined, to use this
158767b23a32SHeiko Schocher		feature!
158867b23a32SHeiko Schocher
158967b23a32SHeiko Schocher		Example:
159067b23a32SHeiko Schocher		Adding a new I2C Bus reached over 2 pca9544a muxes
159167b23a32SHeiko Schocher			The First mux with address 70 and channel 6
159267b23a32SHeiko Schocher			The Second mux with address 71 and channel 4
159367b23a32SHeiko Schocher
159467b23a32SHeiko Schocher		=> i2c bus pca9544a:70:6:pca9544a:71:4
159567b23a32SHeiko Schocher
159667b23a32SHeiko Schocher		Use the "i2c bus" command without parameter, to get a list
159767b23a32SHeiko Schocher		of I2C Busses with muxes:
159867b23a32SHeiko Schocher
159967b23a32SHeiko Schocher		=> i2c bus
160067b23a32SHeiko Schocher		Busses reached over muxes:
160167b23a32SHeiko Schocher		Bus ID: 2
160267b23a32SHeiko Schocher		  reached over Mux(es):
160367b23a32SHeiko Schocher		    pca9544a@70 ch: 4
160467b23a32SHeiko Schocher		Bus ID: 3
160567b23a32SHeiko Schocher		  reached over Mux(es):
160667b23a32SHeiko Schocher		    pca9544a@70 ch: 6
160767b23a32SHeiko Schocher		    pca9544a@71 ch: 4
160867b23a32SHeiko Schocher		=>
160967b23a32SHeiko Schocher
161067b23a32SHeiko Schocher		If you now switch to the new I2C Bus 3 with "i2c dev 3"
161167b23a32SHeiko Schocher		u-boot sends First the Commando to the mux@70 to enable
161267b23a32SHeiko Schocher		channel 6, and then the Commando to the mux@71 to enable
161367b23a32SHeiko Schocher		the channel 4.
161467b23a32SHeiko Schocher
161567b23a32SHeiko Schocher		After that, you can use the "normal" i2c commands as
161667b23a32SHeiko Schocher		usual, to communicate with your I2C devices behind
161767b23a32SHeiko Schocher		the 2 muxes.
161867b23a32SHeiko Schocher
161967b23a32SHeiko Schocher		This option is actually implemented for the bitbanging
162067b23a32SHeiko Schocher		algorithm in common/soft_i2c.c and for the Hardware I2C
162167b23a32SHeiko Schocher		Bus on the MPC8260. But it should be not so difficult
162267b23a32SHeiko Schocher		to add this option to other architectures.
162367b23a32SHeiko Schocher
16242ac6985aSAndrew Dyer		CONFIG_SOFT_I2C_READ_REPEATED_START
16252ac6985aSAndrew Dyer
16262ac6985aSAndrew Dyer		defining this will force the i2c_read() function in
16272ac6985aSAndrew Dyer		the soft_i2c driver to perform an I2C repeated start
16282ac6985aSAndrew Dyer		between writing the address pointer and reading the
16292ac6985aSAndrew Dyer		data.  If this define is omitted the default behaviour
16302ac6985aSAndrew Dyer		of doing a stop-start sequence will be used.  Most I2C
16312ac6985aSAndrew Dyer		devices can use either method, but some require one or
16322ac6985aSAndrew Dyer		the other.
1633be5e6181STimur Tabi
1634c609719bSwdenk- SPI Support:	CONFIG_SPI
1635c609719bSwdenk
1636c609719bSwdenk		Enables SPI driver (so far only tested with
1637c609719bSwdenk		SPI EEPROM, also an instance works with Crystal A/D and
1638c609719bSwdenk		D/As on the SACSng board)
1639c609719bSwdenk
1640c609719bSwdenk		CONFIG_SPI_X
1641c609719bSwdenk
1642c609719bSwdenk		Enables extended (16-bit) SPI EEPROM addressing.
1643c609719bSwdenk		(symmetrical to CONFIG_I2C_X)
1644c609719bSwdenk
1645c609719bSwdenk		CONFIG_SOFT_SPI
1646c609719bSwdenk
1647c609719bSwdenk		Enables a software (bit-bang) SPI driver rather than
1648c609719bSwdenk		using hardware support. This is a general purpose
1649c609719bSwdenk		driver that only requires three general I/O port pins
1650c609719bSwdenk		(two outputs, one input) to function. If this is
1651c609719bSwdenk		defined, the board configuration must define several
1652c609719bSwdenk		SPI configuration items (port pins to use, etc). For
1653c609719bSwdenk		an example, see include/configs/sacsng.h.
1654c609719bSwdenk
165504a9e118SBen Warren		CONFIG_HARD_SPI
165604a9e118SBen Warren
165704a9e118SBen Warren		Enables a hardware SPI driver for general-purpose reads
165804a9e118SBen Warren		and writes.  As with CONFIG_SOFT_SPI, the board configuration
165904a9e118SBen Warren		must define a list of chip-select function pointers.
166004a9e118SBen Warren		Currently supported on some MPC8xxx processors.  For an
166104a9e118SBen Warren		example, see include/configs/mpc8349emds.h.
166204a9e118SBen Warren
166338254f45SGuennadi Liakhovetski		CONFIG_MXC_SPI
166438254f45SGuennadi Liakhovetski
166538254f45SGuennadi Liakhovetski		Enables the driver for the SPI controllers on i.MX and MXC
166638254f45SGuennadi Liakhovetski		SoCs. Currently only i.MX31 is supported.
166738254f45SGuennadi Liakhovetski
16680133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA
16690133502eSMatthias Fuchs
16700133502eSMatthias Fuchs		Enables FPGA subsystem.
16710133502eSMatthias Fuchs
16720133502eSMatthias Fuchs		CONFIG_FPGA_<vendor>
16730133502eSMatthias Fuchs
16740133502eSMatthias Fuchs		Enables support for specific chip vendors.
16750133502eSMatthias Fuchs		(ALTERA, XILINX)
16760133502eSMatthias Fuchs
16770133502eSMatthias Fuchs		CONFIG_FPGA_<family>
16780133502eSMatthias Fuchs
16790133502eSMatthias Fuchs		Enables support for FPGA family.
16800133502eSMatthias Fuchs		(SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
16810133502eSMatthias Fuchs
16820133502eSMatthias Fuchs		CONFIG_FPGA_COUNT
1683c609719bSwdenk
1684c609719bSwdenk		Specify the number of FPGA devices to support.
1685c609719bSwdenk
16866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_PROG_FEEDBACK
1687c609719bSwdenk
1688c609719bSwdenk		Enable printing of hash marks during FPGA configuration.
1689c609719bSwdenk
16906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_BUSY
1691c609719bSwdenk
1692c609719bSwdenk		Enable checks on FPGA configuration interface busy
1693c609719bSwdenk		status by the configuration function. This option
1694c609719bSwdenk		will require a board or device specific function to
1695c609719bSwdenk		be written.
1696c609719bSwdenk
1697c609719bSwdenk		CONFIG_FPGA_DELAY
1698c609719bSwdenk
1699c609719bSwdenk		If defined, a function that provides delays in the FPGA
1700c609719bSwdenk		configuration driver.
1701c609719bSwdenk
17026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_CTRLC
1703c609719bSwdenk		Allow Control-C to interrupt FPGA configuration
1704c609719bSwdenk
17056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_ERROR
1706c609719bSwdenk
1707c609719bSwdenk		Check for configuration errors during FPGA bitfile
1708c609719bSwdenk		loading. For example, abort during Virtex II
1709c609719bSwdenk		configuration if the INIT_B line goes low (which
1710c609719bSwdenk		indicated a CRC error).
1711c609719bSwdenk
17126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_INIT
1713c609719bSwdenk
1714c609719bSwdenk		Maximum time to wait for the INIT_B line to deassert
1715c609719bSwdenk		after PROB_B has been deasserted during a Virtex II
1716c609719bSwdenk		FPGA configuration sequence. The default time is 500
171711ccc33fSMarcel Ziswiler		ms.
1718c609719bSwdenk
17196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_BUSY
1720c609719bSwdenk
1721c609719bSwdenk		Maximum time to wait for BUSY to deassert during
172211ccc33fSMarcel Ziswiler		Virtex II FPGA configuration. The default is 5 ms.
1723c609719bSwdenk
17246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_CONFIG
1725c609719bSwdenk
1726c609719bSwdenk		Time to wait after FPGA configuration. The default is
172711ccc33fSMarcel Ziswiler		200 ms.
1728c609719bSwdenk
1729c609719bSwdenk- Configuration Management:
1730c609719bSwdenk		CONFIG_IDENT_STRING
1731c609719bSwdenk
1732c609719bSwdenk		If defined, this string will be added to the U-Boot
1733c609719bSwdenk		version information (U_BOOT_VERSION)
1734c609719bSwdenk
1735c609719bSwdenk- Vendor Parameter Protection:
1736c609719bSwdenk
1737c609719bSwdenk		U-Boot considers the values of the environment
1738c609719bSwdenk		variables "serial#" (Board Serial Number) and
17397152b1d0Swdenk		"ethaddr" (Ethernet Address) to be parameters that
1740c609719bSwdenk		are set once by the board vendor / manufacturer, and
1741c609719bSwdenk		protects these variables from casual modification by
1742c609719bSwdenk		the user. Once set, these variables are read-only,
1743c609719bSwdenk		and write or delete attempts are rejected. You can
174411ccc33fSMarcel Ziswiler		change this behaviour:
1745c609719bSwdenk
1746c609719bSwdenk		If CONFIG_ENV_OVERWRITE is #defined in your config
1747c609719bSwdenk		file, the write protection for vendor parameters is
174847cd00faSwdenk		completely disabled. Anybody can change or delete
1749c609719bSwdenk		these parameters.
1750c609719bSwdenk
1751c609719bSwdenk		Alternatively, if you #define _both_ CONFIG_ETHADDR
1752c609719bSwdenk		_and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
175311ccc33fSMarcel Ziswiler		Ethernet address is installed in the environment,
1754c609719bSwdenk		which can be changed exactly ONCE by the user. [The
1755c609719bSwdenk		serial# is unaffected by this, i. e. it remains
1756c609719bSwdenk		read-only.]
1757c609719bSwdenk
1758c609719bSwdenk- Protected RAM:
1759c609719bSwdenk		CONFIG_PRAM
1760c609719bSwdenk
1761c609719bSwdenk		Define this variable to enable the reservation of
1762c609719bSwdenk		"protected RAM", i. e. RAM which is not overwritten
1763c609719bSwdenk		by U-Boot. Define CONFIG_PRAM to hold the number of
1764c609719bSwdenk		kB you want to reserve for pRAM. You can overwrite
1765c609719bSwdenk		this default value by defining an environment
1766c609719bSwdenk		variable "pram" to the number of kB you want to
1767c609719bSwdenk		reserve. Note that the board info structure will
1768c609719bSwdenk		still show the full amount of RAM. If pRAM is
1769c609719bSwdenk		reserved, a new environment variable "mem" will
1770c609719bSwdenk		automatically be defined to hold the amount of
1771c609719bSwdenk		remaining RAM in a form that can be passed as boot
1772c609719bSwdenk		argument to Linux, for instance like that:
1773c609719bSwdenk
1774fe126d8bSWolfgang Denk			setenv bootargs ... mem=\${mem}
1775c609719bSwdenk			saveenv
1776c609719bSwdenk
1777c609719bSwdenk		This way you can tell Linux not to use this memory,
1778c609719bSwdenk		either, which results in a memory region that will
1779c609719bSwdenk		not be affected by reboots.
1780c609719bSwdenk
1781c609719bSwdenk		*WARNING* If your board configuration uses automatic
1782c609719bSwdenk		detection of the RAM size, you must make sure that
1783c609719bSwdenk		this memory test is non-destructive. So far, the
1784c609719bSwdenk		following board configurations are known to be
1785c609719bSwdenk		"pRAM-clean":
1786c609719bSwdenk
1787c609719bSwdenk			ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
1788c609719bSwdenk			HERMES, IP860, RPXlite, LWMON, LANTEC,
1789c609719bSwdenk			PCU_E, FLAGADM, TQM8260
1790c609719bSwdenk
1791c609719bSwdenk- Error Recovery:
1792c609719bSwdenk		CONFIG_PANIC_HANG
1793c609719bSwdenk
1794c609719bSwdenk		Define this variable to stop the system in case of a
1795c609719bSwdenk		fatal error, so that you have to reset it manually.
1796c609719bSwdenk		This is probably NOT a good idea for an embedded
179711ccc33fSMarcel Ziswiler		system where you want the system to reboot
1798c609719bSwdenk		automatically as fast as possible, but it may be
1799c609719bSwdenk		useful during development since you can try to debug
1800c609719bSwdenk		the conditions that lead to the situation.
1801c609719bSwdenk
1802c609719bSwdenk		CONFIG_NET_RETRY_COUNT
1803c609719bSwdenk
1804c609719bSwdenk		This variable defines the number of retries for
1805c609719bSwdenk		network operations like ARP, RARP, TFTP, or BOOTP
1806c609719bSwdenk		before giving up the operation. If not defined, a
1807c609719bSwdenk		default value of 5 is used.
1808c609719bSwdenk
180940cb90eeSGuennadi Liakhovetski		CONFIG_ARP_TIMEOUT
181040cb90eeSGuennadi Liakhovetski
181140cb90eeSGuennadi Liakhovetski		Timeout waiting for an ARP reply in milliseconds.
181240cb90eeSGuennadi Liakhovetski
1813c609719bSwdenk- Command Interpreter:
18148078f1a5SWolfgang Denk		CONFIG_AUTO_COMPLETE
181504a85b3bSwdenk
181604a85b3bSwdenk		Enable auto completion of commands using TAB.
181704a85b3bSwdenk
18188078f1a5SWolfgang Denk		Note that this feature has NOT been implemented yet
18198078f1a5SWolfgang Denk		for the "hush" shell.
18208078f1a5SWolfgang Denk
18218078f1a5SWolfgang Denk
18226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_HUSH_PARSER
1823c609719bSwdenk
1824c609719bSwdenk		Define this variable to enable the "hush" shell (from
1825c609719bSwdenk		Busybox) as command line interpreter, thus enabling
1826c609719bSwdenk		powerful command line syntax like
1827c609719bSwdenk		if...then...else...fi conditionals or `&&' and '||'
1828c609719bSwdenk		constructs ("shell scripts").
1829c609719bSwdenk
1830c609719bSwdenk		If undefined, you get the old, much simpler behaviour
1831c609719bSwdenk		with a somewhat smaller memory footprint.
1832c609719bSwdenk
1833c609719bSwdenk
18346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_PROMPT_HUSH_PS2
1835c609719bSwdenk
1836c609719bSwdenk		This defines the secondary prompt string, which is
1837c609719bSwdenk		printed when the command interpreter needs more input
1838c609719bSwdenk		to complete a command. Usually "> ".
1839c609719bSwdenk
1840c609719bSwdenk	Note:
1841c609719bSwdenk
1842c609719bSwdenk		In the current implementation, the local variables
1843c609719bSwdenk		space and global environment variables space are
1844c609719bSwdenk		separated. Local variables are those you define by
18453b57fe0aSwdenk		simply typing `name=value'. To access a local
1846c609719bSwdenk		variable later on, you have write `$name' or
18473b57fe0aSwdenk		`${name}'; to execute the contents of a variable
18483b57fe0aSwdenk		directly type `$name' at the command prompt.
1849c609719bSwdenk
1850c609719bSwdenk		Global environment variables are those you use
1851c609719bSwdenk		setenv/printenv to work with. To run a command stored
1852c609719bSwdenk		in such a variable, you need to use the run command,
1853c609719bSwdenk		and you must not use the '$' sign to access them.
1854c609719bSwdenk
1855c609719bSwdenk		To store commands and special characters in a
1856c609719bSwdenk		variable, please use double quotation marks
1857c609719bSwdenk		surrounding the whole text of the variable, instead
1858c609719bSwdenk		of the backslashes before semicolons and special
1859c609719bSwdenk		symbols.
1860c609719bSwdenk
1861aa0c71acSWolfgang Denk- Commandline Editing and History:
1862aa0c71acSWolfgang Denk		CONFIG_CMDLINE_EDITING
1863aa0c71acSWolfgang Denk
186411ccc33fSMarcel Ziswiler		Enable editing and History functions for interactive
1865aa0c71acSWolfgang Denk		commandline input operations
1866aa0c71acSWolfgang Denk
1867a8c7c708Swdenk- Default Environment:
1868c609719bSwdenk		CONFIG_EXTRA_ENV_SETTINGS
1869c609719bSwdenk
1870c609719bSwdenk		Define this to contain any number of null terminated
1871c609719bSwdenk		strings (variable = value pairs) that will be part of
18727152b1d0Swdenk		the default environment compiled into the boot image.
18732262cfeeSwdenk
1874c609719bSwdenk		For example, place something like this in your
1875c609719bSwdenk		board's config file:
1876c609719bSwdenk
1877c609719bSwdenk		#define CONFIG_EXTRA_ENV_SETTINGS \
1878c609719bSwdenk			"myvar1=value1\0" \
1879c609719bSwdenk			"myvar2=value2\0"
1880c609719bSwdenk
1881c609719bSwdenk		Warning: This method is based on knowledge about the
1882c609719bSwdenk		internal format how the environment is stored by the
18832262cfeeSwdenk		U-Boot code. This is NOT an official, exported
1884c609719bSwdenk		interface! Although it is unlikely that this format
18857152b1d0Swdenk		will change soon, there is no guarantee either.
1886c609719bSwdenk		You better know what you are doing here.
1887c609719bSwdenk
1888c609719bSwdenk		Note: overly (ab)use of the default environment is
1889c609719bSwdenk		discouraged. Make sure to check other ways to preset
189074de7aefSWolfgang Denk		the environment like the "source" command or the
1891c609719bSwdenk		boot command first.
1892c609719bSwdenk
1893a8c7c708Swdenk- DataFlash Support:
18942abbe075Swdenk		CONFIG_HAS_DATAFLASH
18952abbe075Swdenk
18962abbe075Swdenk		Defining this option enables DataFlash features and
18972abbe075Swdenk		allows to read/write in Dataflash via the standard
18982abbe075Swdenk		commands cp, md...
18992abbe075Swdenk
19003f85ce27Swdenk- SystemACE Support:
19013f85ce27Swdenk		CONFIG_SYSTEMACE
19023f85ce27Swdenk
19033f85ce27Swdenk		Adding this option adds support for Xilinx SystemACE
19043f85ce27Swdenk		chips attached via some sort of local bus. The address
190511ccc33fSMarcel Ziswiler		of the chip must also be defined in the
19066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SYSTEMACE_BASE macro. For example:
19073f85ce27Swdenk
19083f85ce27Swdenk		#define CONFIG_SYSTEMACE
19096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
19103f85ce27Swdenk
19113f85ce27Swdenk		When SystemACE support is added, the "ace" device type
19123f85ce27Swdenk		becomes available to the fat commands, i.e. fatls.
19133f85ce27Swdenk
1914ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port:
1915ecb0ccd9SWolfgang Denk		CONFIG_TFTP_PORT
1916ecb0ccd9SWolfgang Denk
191728cb9375SWolfgang Denk		If this is defined, the environment variable tftpsrcp
1918ecb0ccd9SWolfgang Denk		is used to supply the TFTP UDP source port value.
191928cb9375SWolfgang Denk		If tftpsrcp isn't defined, the normal pseudo-random port
1920ecb0ccd9SWolfgang Denk		number generator is used.
1921ecb0ccd9SWolfgang Denk
192228cb9375SWolfgang Denk		Also, the environment variable tftpdstp is used to supply
192328cb9375SWolfgang Denk		the TFTP UDP destination port value.  If tftpdstp isn't
192428cb9375SWolfgang Denk		defined, the normal port 69 is used.
192528cb9375SWolfgang Denk
192628cb9375SWolfgang Denk		The purpose for tftpsrcp is to allow a TFTP server to
1927ecb0ccd9SWolfgang Denk		blindly start the TFTP transfer using the pre-configured
1928ecb0ccd9SWolfgang Denk		target IP address and UDP port. This has the effect of
1929ecb0ccd9SWolfgang Denk		"punching through" the (Windows XP) firewall, allowing
1930ecb0ccd9SWolfgang Denk		the remainder of the TFTP transfer to proceed normally.
1931ecb0ccd9SWolfgang Denk		A better solution is to properly configure the firewall,
1932ecb0ccd9SWolfgang Denk		but sometimes that is not allowed.
1933ecb0ccd9SWolfgang Denk
1934a8c7c708Swdenk- Show boot progress:
1935c609719bSwdenk		CONFIG_SHOW_BOOT_PROGRESS
1936c609719bSwdenk
1937c609719bSwdenk		Defining this option allows to add some board-
1938c609719bSwdenk		specific code (calling a user-provided function
1939c609719bSwdenk		"show_boot_progress(int)") that enables you to show
1940c609719bSwdenk		the system's boot progress on some display (for
1941c609719bSwdenk		example, some LED's) on your board. At the moment,
1942c609719bSwdenk		the following checkpoints are implemented:
1943c609719bSwdenk
19441372cce2SMarian BalakowiczLegacy uImage format:
19451372cce2SMarian Balakowicz
1946c609719bSwdenk  Arg	Where			When
1947c609719bSwdenk    1	common/cmd_bootm.c	before attempting to boot an image
1948c609719bSwdenk   -1	common/cmd_bootm.c	Image header has bad	 magic number
1949c609719bSwdenk    2	common/cmd_bootm.c	Image header has correct magic number
1950c609719bSwdenk   -2	common/cmd_bootm.c	Image header has bad	 checksum
1951c609719bSwdenk    3	common/cmd_bootm.c	Image header has correct checksum
1952c609719bSwdenk   -3	common/cmd_bootm.c	Image data   has bad	 checksum
1953c609719bSwdenk    4	common/cmd_bootm.c	Image data   has correct checksum
1954c609719bSwdenk   -4	common/cmd_bootm.c	Image is for unsupported architecture
1955c609719bSwdenk    5	common/cmd_bootm.c	Architecture check OK
19561372cce2SMarian Balakowicz   -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi)
1957c609719bSwdenk    6	common/cmd_bootm.c	Image Type check OK
1958c609719bSwdenk   -6	common/cmd_bootm.c	gunzip uncompression error
1959c609719bSwdenk   -7	common/cmd_bootm.c	Unimplemented compression type
1960c609719bSwdenk    7	common/cmd_bootm.c	Uncompression OK
19611372cce2SMarian Balakowicz    8	common/cmd_bootm.c	No uncompress/copy overwrite error
1962c609719bSwdenk   -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
19631372cce2SMarian Balakowicz
19641372cce2SMarian Balakowicz    9	common/image.c		Start initial ramdisk verification
19651372cce2SMarian Balakowicz  -10	common/image.c		Ramdisk header has bad	   magic number
19661372cce2SMarian Balakowicz  -11	common/image.c		Ramdisk header has bad	   checksum
19671372cce2SMarian Balakowicz   10	common/image.c		Ramdisk header is OK
19681372cce2SMarian Balakowicz  -12	common/image.c		Ramdisk data   has bad	   checksum
19691372cce2SMarian Balakowicz   11	common/image.c		Ramdisk data   has correct checksum
19701372cce2SMarian Balakowicz   12	common/image.c		Ramdisk verification complete, start loading
197111ccc33fSMarcel Ziswiler  -13	common/image.c		Wrong Image Type (not PPC Linux ramdisk)
19721372cce2SMarian Balakowicz   13	common/image.c		Start multifile image verification
19731372cce2SMarian Balakowicz   14	common/image.c		No initial ramdisk, no multifile, continue.
19741372cce2SMarian Balakowicz
1975ea0364f1SPeter Tyser   15	arch/<arch>/lib/bootm.c	All preparation done, transferring control to OS
1976c609719bSwdenk
1977a47a12beSStefan Roese  -30	arch/powerpc/lib/board.c	Fatal error, hang the system
197863e73c9aSwdenk  -31	post/post.c		POST test failed, detected by post_output_backlog()
197963e73c9aSwdenk  -32	post/post.c		POST test failed, detected by post_run_single()
198063e73c9aSwdenk
1981566a494fSHeiko Schocher   34	common/cmd_doc.c	before loading a Image from a DOC device
1982566a494fSHeiko Schocher  -35	common/cmd_doc.c	Bad usage of "doc" command
1983566a494fSHeiko Schocher   35	common/cmd_doc.c	correct usage of "doc" command
1984566a494fSHeiko Schocher  -36	common/cmd_doc.c	No boot device
1985566a494fSHeiko Schocher   36	common/cmd_doc.c	correct boot device
1986566a494fSHeiko Schocher  -37	common/cmd_doc.c	Unknown Chip ID on boot device
1987566a494fSHeiko Schocher   37	common/cmd_doc.c	correct chip ID found, device available
1988566a494fSHeiko Schocher  -38	common/cmd_doc.c	Read Error on boot device
1989566a494fSHeiko Schocher   38	common/cmd_doc.c	reading Image header from DOC device OK
1990566a494fSHeiko Schocher  -39	common/cmd_doc.c	Image header has bad magic number
1991566a494fSHeiko Schocher   39	common/cmd_doc.c	Image header has correct magic number
1992566a494fSHeiko Schocher  -40	common/cmd_doc.c	Error reading Image from DOC device
1993566a494fSHeiko Schocher   40	common/cmd_doc.c	Image header has correct magic number
1994566a494fSHeiko Schocher   41	common/cmd_ide.c	before loading a Image from a IDE device
1995566a494fSHeiko Schocher  -42	common/cmd_ide.c	Bad usage of "ide" command
1996566a494fSHeiko Schocher   42	common/cmd_ide.c	correct usage of "ide" command
1997566a494fSHeiko Schocher  -43	common/cmd_ide.c	No boot device
1998566a494fSHeiko Schocher   43	common/cmd_ide.c	boot device found
1999566a494fSHeiko Schocher  -44	common/cmd_ide.c	Device not available
2000566a494fSHeiko Schocher   44	common/cmd_ide.c	Device available
2001566a494fSHeiko Schocher  -45	common/cmd_ide.c	wrong partition selected
2002566a494fSHeiko Schocher   45	common/cmd_ide.c	partition selected
2003566a494fSHeiko Schocher  -46	common/cmd_ide.c	Unknown partition table
2004566a494fSHeiko Schocher   46	common/cmd_ide.c	valid partition table found
2005566a494fSHeiko Schocher  -47	common/cmd_ide.c	Invalid partition type
2006566a494fSHeiko Schocher   47	common/cmd_ide.c	correct partition type
2007566a494fSHeiko Schocher  -48	common/cmd_ide.c	Error reading Image Header on boot device
2008566a494fSHeiko Schocher   48	common/cmd_ide.c	reading Image Header from IDE device OK
2009566a494fSHeiko Schocher  -49	common/cmd_ide.c	Image header has bad magic number
2010566a494fSHeiko Schocher   49	common/cmd_ide.c	Image header has correct magic number
2011566a494fSHeiko Schocher  -50	common/cmd_ide.c	Image header has bad	 checksum
2012566a494fSHeiko Schocher   50	common/cmd_ide.c	Image header has correct checksum
2013566a494fSHeiko Schocher  -51	common/cmd_ide.c	Error reading Image from IDE device
2014566a494fSHeiko Schocher   51	common/cmd_ide.c	reading Image from IDE device OK
2015566a494fSHeiko Schocher   52	common/cmd_nand.c	before loading a Image from a NAND device
2016566a494fSHeiko Schocher  -53	common/cmd_nand.c	Bad usage of "nand" command
2017566a494fSHeiko Schocher   53	common/cmd_nand.c	correct usage of "nand" command
2018566a494fSHeiko Schocher  -54	common/cmd_nand.c	No boot device
2019566a494fSHeiko Schocher   54	common/cmd_nand.c	boot device found
2020566a494fSHeiko Schocher  -55	common/cmd_nand.c	Unknown Chip ID on boot device
2021566a494fSHeiko Schocher   55	common/cmd_nand.c	correct chip ID found, device available
2022566a494fSHeiko Schocher  -56	common/cmd_nand.c	Error reading Image Header on boot device
2023566a494fSHeiko Schocher   56	common/cmd_nand.c	reading Image Header from NAND device OK
2024566a494fSHeiko Schocher  -57	common/cmd_nand.c	Image header has bad magic number
2025566a494fSHeiko Schocher   57	common/cmd_nand.c	Image header has correct magic number
2026566a494fSHeiko Schocher  -58	common/cmd_nand.c	Error reading Image from NAND device
2027566a494fSHeiko Schocher   58	common/cmd_nand.c	reading Image from NAND device OK
2028c609719bSwdenk
2029566a494fSHeiko Schocher  -60	common/env_common.c	Environment has a bad CRC, using default
2030c609719bSwdenk
2031566a494fSHeiko Schocher   64	net/eth.c		starting with Ethernet configuration.
2032566a494fSHeiko Schocher  -64	net/eth.c		no Ethernet found.
2033566a494fSHeiko Schocher   65	net/eth.c		Ethernet found.
2034206c60cbSwdenk
2035566a494fSHeiko Schocher  -80	common/cmd_net.c	usage wrong
2036566a494fSHeiko Schocher   80	common/cmd_net.c	before calling NetLoop()
203711ccc33fSMarcel Ziswiler  -81	common/cmd_net.c	some error in NetLoop() occurred
2038566a494fSHeiko Schocher   81	common/cmd_net.c	NetLoop() back without error
2039566a494fSHeiko Schocher  -82	common/cmd_net.c	size == 0 (File with size 0 loaded)
2040566a494fSHeiko Schocher   82	common/cmd_net.c	trying automatic boot
204174de7aefSWolfgang Denk   83	common/cmd_net.c	running "source" command
204274de7aefSWolfgang Denk  -83	common/cmd_net.c	some error in automatic boot or "source" command
2043566a494fSHeiko Schocher   84	common/cmd_net.c	end without errors
2044c609719bSwdenk
20451372cce2SMarian BalakowiczFIT uImage format:
20461372cce2SMarian Balakowicz
20471372cce2SMarian Balakowicz  Arg	Where			When
20481372cce2SMarian Balakowicz  100	common/cmd_bootm.c	Kernel FIT Image has correct format
20491372cce2SMarian Balakowicz -100	common/cmd_bootm.c	Kernel FIT Image has incorrect format
20501372cce2SMarian Balakowicz  101	common/cmd_bootm.c	No Kernel subimage unit name, using configuration
20511372cce2SMarian Balakowicz -101	common/cmd_bootm.c	Can't get configuration for kernel subimage
20521372cce2SMarian Balakowicz  102	common/cmd_bootm.c	Kernel unit name specified
20531372cce2SMarian Balakowicz -103	common/cmd_bootm.c	Can't get kernel subimage node offset
2054f773bea8SMarian Balakowicz  103	common/cmd_bootm.c	Found configuration node
20551372cce2SMarian Balakowicz  104	common/cmd_bootm.c	Got kernel subimage node offset
20561372cce2SMarian Balakowicz -104	common/cmd_bootm.c	Kernel subimage hash verification failed
20571372cce2SMarian Balakowicz  105	common/cmd_bootm.c	Kernel subimage hash verification OK
20581372cce2SMarian Balakowicz -105	common/cmd_bootm.c	Kernel subimage is for unsupported architecture
20591372cce2SMarian Balakowicz  106	common/cmd_bootm.c	Architecture check OK
206011ccc33fSMarcel Ziswiler -106	common/cmd_bootm.c	Kernel subimage has wrong type
206111ccc33fSMarcel Ziswiler  107	common/cmd_bootm.c	Kernel subimage type OK
20621372cce2SMarian Balakowicz -107	common/cmd_bootm.c	Can't get kernel subimage data/size
20631372cce2SMarian Balakowicz  108	common/cmd_bootm.c	Got kernel subimage data/size
20641372cce2SMarian Balakowicz -108	common/cmd_bootm.c	Wrong image type (not legacy, FIT)
20651372cce2SMarian Balakowicz -109	common/cmd_bootm.c	Can't get kernel subimage type
20661372cce2SMarian Balakowicz -110	common/cmd_bootm.c	Can't get kernel subimage comp
20671372cce2SMarian Balakowicz -111	common/cmd_bootm.c	Can't get kernel subimage os
20681372cce2SMarian Balakowicz -112	common/cmd_bootm.c	Can't get kernel subimage load address
20691372cce2SMarian Balakowicz -113	common/cmd_bootm.c	Image uncompress/copy overwrite error
20701372cce2SMarian Balakowicz
20711372cce2SMarian Balakowicz  120	common/image.c		Start initial ramdisk verification
20721372cce2SMarian Balakowicz -120	common/image.c		Ramdisk FIT image has incorrect format
20731372cce2SMarian Balakowicz  121	common/image.c		Ramdisk FIT image has correct format
207411ccc33fSMarcel Ziswiler  122	common/image.c		No ramdisk subimage unit name, using configuration
20751372cce2SMarian Balakowicz -122	common/image.c		Can't get configuration for ramdisk subimage
20761372cce2SMarian Balakowicz  123	common/image.c		Ramdisk unit name specified
20771372cce2SMarian Balakowicz -124	common/image.c		Can't get ramdisk subimage node offset
20781372cce2SMarian Balakowicz  125	common/image.c		Got ramdisk subimage node offset
20791372cce2SMarian Balakowicz -125	common/image.c		Ramdisk subimage hash verification failed
20801372cce2SMarian Balakowicz  126	common/image.c		Ramdisk subimage hash verification OK
20811372cce2SMarian Balakowicz -126	common/image.c		Ramdisk subimage for unsupported architecture
20821372cce2SMarian Balakowicz  127	common/image.c		Architecture check OK
20831372cce2SMarian Balakowicz -127	common/image.c		Can't get ramdisk subimage data/size
20841372cce2SMarian Balakowicz  128	common/image.c		Got ramdisk subimage data/size
20851372cce2SMarian Balakowicz  129	common/image.c		Can't get ramdisk load address
20861372cce2SMarian Balakowicz -129	common/image.c		Got ramdisk load address
20871372cce2SMarian Balakowicz
208811ccc33fSMarcel Ziswiler -130	common/cmd_doc.c	Incorrect FIT image format
20891372cce2SMarian Balakowicz  131	common/cmd_doc.c	FIT image format OK
20901372cce2SMarian Balakowicz
209111ccc33fSMarcel Ziswiler -140	common/cmd_ide.c	Incorrect FIT image format
20921372cce2SMarian Balakowicz  141	common/cmd_ide.c	FIT image format OK
20931372cce2SMarian Balakowicz
209411ccc33fSMarcel Ziswiler -150	common/cmd_nand.c	Incorrect FIT image format
20951372cce2SMarian Balakowicz  151	common/cmd_nand.c	FIT image format OK
20961372cce2SMarian Balakowicz
2097cccfc2abSDetlev Zundel- Automatic software updates via TFTP server
2098cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP
2099cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_CNT_MAX
2100cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_MSEC_MAX
2101cccfc2abSDetlev Zundel
2102cccfc2abSDetlev Zundel		These options enable and control the auto-update feature;
2103cccfc2abSDetlev Zundel		for a more detailed description refer to doc/README.update.
2104cccfc2abSDetlev Zundel
2105cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support)
2106cccfc2abSDetlev Zundel		CONFIG_MTD_DEVICE
2107cccfc2abSDetlev Zundel
2108cccfc2abSDetlev Zundel		Adds the MTD device infrastructure from the Linux kernel.
2109cccfc2abSDetlev Zundel		Needed for mtdparts command support.
2110cccfc2abSDetlev Zundel
2111cccfc2abSDetlev Zundel		CONFIG_MTD_PARTITIONS
2112cccfc2abSDetlev Zundel
2113cccfc2abSDetlev Zundel		Adds the MTD partitioning infrastructure from the Linux
2114cccfc2abSDetlev Zundel		kernel. Needed for UBI support.
2115cccfc2abSDetlev Zundel
21161372cce2SMarian Balakowicz
2117c609719bSwdenkModem Support:
2118c609719bSwdenk--------------
2119c609719bSwdenk
212085ec0bccSwdenk[so far only for SMDK2400 and TRAB boards]
2121c609719bSwdenk
212211ccc33fSMarcel Ziswiler- Modem support enable:
2123c609719bSwdenk		CONFIG_MODEM_SUPPORT
2124c609719bSwdenk
2125c609719bSwdenk- RTS/CTS Flow control enable:
2126c609719bSwdenk		CONFIG_HWFLOW
2127c609719bSwdenk
2128c609719bSwdenk- Modem debug support:
2129c609719bSwdenk		CONFIG_MODEM_SUPPORT_DEBUG
2130c609719bSwdenk
2131c609719bSwdenk		Enables debugging stuff (char screen[1024], dbg())
2132c609719bSwdenk		for modem support. Useful only with BDI2000.
2133c609719bSwdenk
2134a8c7c708Swdenk- Interrupt support (PPC):
2135a8c7c708Swdenk
2136a8c7c708Swdenk		There are common interrupt_init() and timer_interrupt()
2137a8c7c708Swdenk		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
213811ccc33fSMarcel Ziswiler		for CPU specific initialization. interrupt_init_cpu()
2139a8c7c708Swdenk		should set decrementer_count to appropriate value. If
214011ccc33fSMarcel Ziswiler		CPU resets decrementer automatically after interrupt
2141a8c7c708Swdenk		(ppc4xx) it should set decrementer_count to zero.
214211ccc33fSMarcel Ziswiler		timer_interrupt() calls timer_interrupt_cpu() for CPU
2143a8c7c708Swdenk		specific handling. If board has watchdog / status_led
2144a8c7c708Swdenk		/ other_activity_monitor it works automatically from
2145a8c7c708Swdenk		general timer_interrupt().
2146a8c7c708Swdenk
2147c609719bSwdenk- General:
2148c609719bSwdenk
2149c609719bSwdenk		In the target system modem support is enabled when a
2150c609719bSwdenk		specific key (key combination) is pressed during
2151c609719bSwdenk		power-on. Otherwise U-Boot will boot normally
215211ccc33fSMarcel Ziswiler		(autoboot). The key_pressed() function is called from
2153c609719bSwdenk		board_init(). Currently key_pressed() is a dummy
2154c609719bSwdenk		function, returning 1 and thus enabling modem
2155c609719bSwdenk		initialization.
2156c609719bSwdenk
2157c609719bSwdenk		If there are no modem init strings in the
2158c609719bSwdenk		environment, U-Boot proceed to autoboot; the
2159c609719bSwdenk		previous output (banner, info printfs) will be
216011ccc33fSMarcel Ziswiler		suppressed, though.
2161c609719bSwdenk
2162c609719bSwdenk		See also: doc/README.Modem
2163c609719bSwdenk
2164c609719bSwdenk
2165c609719bSwdenkConfiguration Settings:
2166c609719bSwdenk-----------------------
2167c609719bSwdenk
21686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
2169c609719bSwdenk		undefine this when you're short of memory.
2170c609719bSwdenk
21712fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
21722fb2604dSPeter Tyser		width of the commands listed in the 'help' command output.
21732fb2604dSPeter Tyser
21746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT:	This is what U-Boot prints on the console to
2175c609719bSwdenk		prompt for user input.
2176c609719bSwdenk
21776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE:	Buffer size for input from the Console
2178c609719bSwdenk
21796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE:	Buffer size for Console output
2180c609719bSwdenk
21816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS:	max. Number of arguments accepted for monitor commands
2182c609719bSwdenk
21836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
2184c609719bSwdenk		the application (usually a Linux kernel) when it is
2185c609719bSwdenk		booted
2186c609719bSwdenk
21876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE:
2188c609719bSwdenk		List of legal baudrate settings for this board.
2189c609719bSwdenk
21906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_INFO_QUIET
2191c609719bSwdenk		Suppress display of console information at boot.
2192c609719bSwdenk
21936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_IS_IN_ENV
2194c609719bSwdenk		If the board specific function
2195c609719bSwdenk			extern int overwrite_console (void);
2196c609719bSwdenk		returns 1, the stdin, stderr and stdout are switched to the
2197c609719bSwdenk		serial port, else the settings in the environment are used.
2198c609719bSwdenk
21996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
2200c609719bSwdenk		Enable the call to overwrite_console().
2201c609719bSwdenk
22026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
2203c609719bSwdenk		Enable overwrite of previous console environment settings.
2204c609719bSwdenk
22056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
2206c609719bSwdenk		Begin and End addresses of the area used by the
2207c609719bSwdenk		simple memory test.
2208c609719bSwdenk
22096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST:
2210c609719bSwdenk		Enable an alternate, more extensive memory test.
2211c609719bSwdenk
22126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH:
22135f535fe1Swdenk		Scratch address used by the alternate memory test
22145f535fe1Swdenk		You only need to set this if address zero isn't writeable
22155f535fe1Swdenk
22166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
22176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
221814f73ca6SStefan Roese		this specified memory area will get subtracted from the top
221911ccc33fSMarcel Ziswiler		(end) of RAM and won't get "touched" at all by U-Boot. By
222014f73ca6SStefan Roese		fixing up gd->ram_size the Linux kernel should gets passed
222114f73ca6SStefan Roese		the now "corrected" memory size and won't touch it either.
222214f73ca6SStefan Roese		This should work for arch/ppc and arch/powerpc. Only Linux
22235e12e75dSStefan Roese		board ports in arch/powerpc with bootwrapper support that
222414f73ca6SStefan Roese		recalculate the memory size from the SDRAM controller setup
22255e12e75dSStefan Roese		will have to get fixed in Linux additionally.
222614f73ca6SStefan Roese
222714f73ca6SStefan Roese		This option can be used as a workaround for the 440EPx/GRx
222814f73ca6SStefan Roese		CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
222914f73ca6SStefan Roese		be touched.
223014f73ca6SStefan Roese
223114f73ca6SStefan Roese		WARNING: Please make sure that this value is a multiple of
223214f73ca6SStefan Roese		the Linux page size (normally 4k). If this is not the case,
223314f73ca6SStefan Roese		then the end address of the Linux memory will be located at a
223414f73ca6SStefan Roese		non page size aligned address and this could cause major
223514f73ca6SStefan Roese		problems.
223614f73ca6SStefan Roese
22376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TFTP_LOADADDR:
2238c609719bSwdenk		Default load address for network file downloads
2239c609719bSwdenk
22406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE:
2241c609719bSwdenk		Enable temporary baudrate change while serial download
2242c609719bSwdenk
22436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE:
2244c609719bSwdenk		Physical start address of SDRAM. _Must_ be 0 here.
2245c609719bSwdenk
22466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MBIO_BASE:
2247c609719bSwdenk		Physical start address of Motherboard I/O (if using a
2248c609719bSwdenk		Cogent motherboard)
2249c609719bSwdenk
22506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE:
2251c609719bSwdenk		Physical start address of Flash memory.
2252c609719bSwdenk
22536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE:
2254c609719bSwdenk		Physical start address of boot monitor code (set by
2255c609719bSwdenk		make config files to be same as the text base address
2256c609719bSwdenk		(TEXT_BASE) used when linking) - same as
22576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FLASH_BASE when booting from flash.
2258c609719bSwdenk
22596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN:
22603b57fe0aSwdenk		Size of memory reserved for monitor code, used to
22613b57fe0aSwdenk		determine _at_compile_time_ (!) if the environment is
22623b57fe0aSwdenk		embedded within the U-Boot image, or in a separate
22633b57fe0aSwdenk		flash sector.
2264c609719bSwdenk
22656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN:
2266c609719bSwdenk		Size of DRAM reserved for malloc() use.
2267c609719bSwdenk
22686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN:
226915940c9aSStefan Roese		Normally compressed uImages are limited to an
227015940c9aSStefan Roese		uncompressed size of 8 MBytes. If this is not enough,
22716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		you can define CONFIG_SYS_BOOTM_LEN in your board config file
227215940c9aSStefan Roese		to adjust this setting to your needs.
2273c609719bSwdenk
22746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ:
2275c609719bSwdenk		Maximum size of memory mapped by the startup code of
2276c609719bSwdenk		the Linux kernel; all data that must be processed by
22777d721e34SBartlomiej Sieka		the Linux kernel (bd_info, boot arguments, FDT blob if
22787d721e34SBartlomiej Sieka		used) must be put below this limit, unless "bootm_low"
22797d721e34SBartlomiej Sieka		enviroment variable is defined and non-zero. In such case
22807d721e34SBartlomiej Sieka		all data for the Linux kernel must be between "bootm_low"
22816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.
2282c609719bSwdenk
22836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS:
2284c609719bSwdenk		Max number of Flash memory banks
2285c609719bSwdenk
22866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT:
2287c609719bSwdenk		Max number of sectors on a Flash chip
2288c609719bSwdenk
22896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT:
2290c609719bSwdenk		Timeout for Flash erase operations (in ms)
2291c609719bSwdenk
22926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT:
2293c609719bSwdenk		Timeout for Flash write operations (in ms)
2294c609719bSwdenk
22956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT
22968564acf9Swdenk		Timeout for Flash set sector lock bit operation (in ms)
22978564acf9Swdenk
22986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT
22998564acf9Swdenk		Timeout for Flash clear lock bits operation (in ms)
23008564acf9Swdenk
23016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION
23028564acf9Swdenk		If defined, hardware flash sectors protection is used
23038564acf9Swdenk		instead of U-Boot software protection.
23048564acf9Swdenk
23056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP:
2306c609719bSwdenk
2307c609719bSwdenk		Enable TFTP transfers directly to flash memory;
2308c609719bSwdenk		without this option such a download has to be
2309c609719bSwdenk		performed in two steps: (1) download to RAM, and (2)
2310c609719bSwdenk		copy from RAM to flash.
2311c609719bSwdenk
2312c609719bSwdenk		The two-step approach is usually more reliable, since
2313c609719bSwdenk		you can check if the download worked before you erase
231411ccc33fSMarcel Ziswiler		the flash, but in some situations (when system RAM is
231511ccc33fSMarcel Ziswiler		too limited to allow for a temporary copy of the
2316c609719bSwdenk		downloaded image) this option may be very useful.
2317c609719bSwdenk
23186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI:
2319c609719bSwdenk		Define if the flash driver uses extra elements in the
23205653fc33Swdenk		common flash structure for storing flash geometry.
23215653fc33Swdenk
232200b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER
23235653fc33Swdenk		This option also enables the building of the cfi_flash driver
23245653fc33Swdenk		in the drivers directory
232553cf9435Sstroese
232691809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD
232791809ed5SPiotr Ziecik		This option enables the building of the cfi_mtd driver
232891809ed5SPiotr Ziecik		in the drivers directory. The driver exports CFI flash
232991809ed5SPiotr Ziecik		to the MTD layer.
233091809ed5SPiotr Ziecik
23316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
233296ef831fSGuennadi Liakhovetski		Use buffered writes to flash.
233396ef831fSGuennadi Liakhovetski
233496ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N
233596ef831fSGuennadi Liakhovetski		s29ws-n MirrorBit flash has non-standard addresses for buffered
233696ef831fSGuennadi Liakhovetski		write commands.
233796ef831fSGuennadi Liakhovetski
23386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST
23395568e613SStefan Roese		If this option is defined, the common CFI flash doesn't
23405568e613SStefan Roese		print it's warning upon not recognized FLASH banks. This
23415568e613SStefan Roese		is useful, if some of the configured banks are only
23425568e613SStefan Roese		optionally available.
23435568e613SStefan Roese
23449a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS
23459a042e9cSJerry Van Baren		If defined (must be an integer), print out countdown
23469a042e9cSJerry Van Baren		digits and dots.  Recommended value: 45 (9..1) for 80
23479a042e9cSJerry Van Baren		column displays, 15 (3..1) for 40 column displays.
23489a042e9cSJerry Van Baren
23496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER:
235011ccc33fSMarcel Ziswiler		Defines the number of Ethernet receive buffers. On some
235111ccc33fSMarcel Ziswiler		Ethernet controllers it is recommended to set this value
235253cf9435Sstroese		to 8 or even higher (EEPRO100 or 405 EMAC), since all
235353cf9435Sstroese		buffers can be full shortly after enabling the interface
235411ccc33fSMarcel Ziswiler		on high Ethernet traffic.
235553cf9435Sstroese		Defaults to 4 if not defined.
2356c609719bSwdenk
2357c609719bSwdenkThe following definitions that deal with the placement and management
2358c609719bSwdenkof environment data (variable area); in general, we support the
2359c609719bSwdenkfollowing configurations:
2360c609719bSwdenk
23615a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH:
2362c609719bSwdenk
2363c609719bSwdenk	Define this if the environment is in flash memory.
2364c609719bSwdenk
2365c609719bSwdenk	a) The environment occupies one whole flash sector, which is
2366c609719bSwdenk	   "embedded" in the text segment with the U-Boot code. This
2367c609719bSwdenk	   happens usually with "bottom boot sector" or "top boot
2368c609719bSwdenk	   sector" type flash chips, which have several smaller
2369c609719bSwdenk	   sectors at the start or the end. For instance, such a
2370c609719bSwdenk	   layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
2371c609719bSwdenk	   such a case you would place the environment in one of the
2372c609719bSwdenk	   4 kB sectors - with U-Boot code before and after it. With
2373c609719bSwdenk	   "top boot sector" type flash chips, you would put the
2374c609719bSwdenk	   environment in one of the last sectors, leaving a gap
2375c609719bSwdenk	   between U-Boot and the environment.
2376c609719bSwdenk
23770e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
2378c609719bSwdenk
2379c609719bSwdenk	   Offset of environment data (variable area) to the
2380c609719bSwdenk	   beginning of flash memory; for instance, with bottom boot
2381c609719bSwdenk	   type flash chips the second sector can be used: the offset
2382c609719bSwdenk	   for this sector is given here.
2383c609719bSwdenk
23846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
2385c609719bSwdenk
23860e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
2387c609719bSwdenk
2388c609719bSwdenk	   This is just another way to specify the start address of
2389c609719bSwdenk	   the flash sector containing the environment (instead of
23900e8d1586SJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET).
2391c609719bSwdenk
23920e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SECT_SIZE:
2393c609719bSwdenk
2394c609719bSwdenk	   Size of the sector containing the environment.
2395c609719bSwdenk
2396c609719bSwdenk
2397c609719bSwdenk	b) Sometimes flash chips have few, equal sized, BIG sectors.
2398c609719bSwdenk	   In such a case you don't want to spend a whole sector for
2399c609719bSwdenk	   the environment.
2400c609719bSwdenk
24010e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
2402c609719bSwdenk
24035a1aceb0SJean-Christophe PLAGNIOL-VILLARD	   If you use this in combination with CONFIG_ENV_IS_IN_FLASH
24040e8d1586SJean-Christophe PLAGNIOL-VILLARD	   and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
2405c609719bSwdenk	   of this flash sector for the environment. This saves
2406c609719bSwdenk	   memory for the RAM copy of the environment.
2407c609719bSwdenk
2408c609719bSwdenk	   It may also save flash memory if you decide to use this
2409c609719bSwdenk	   when your environment is "embedded" within U-Boot code,
2410c609719bSwdenk	   since then the remainder of the flash sector could be used
2411c609719bSwdenk	   for U-Boot code. It should be pointed out that this is
2412c609719bSwdenk	   STRONGLY DISCOURAGED from a robustness point of view:
2413c609719bSwdenk	   updating the environment in flash makes it always
2414c609719bSwdenk	   necessary to erase the WHOLE sector. If something goes
2415c609719bSwdenk	   wrong before the contents has been restored from a copy in
2416c609719bSwdenk	   RAM, your target system will be dead.
2417c609719bSwdenk
24180e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR_REDUND
24190e8d1586SJean-Christophe PLAGNIOL-VILLARD	  CONFIG_ENV_SIZE_REDUND
2420c609719bSwdenk
2421c609719bSwdenk	   These settings describe a second storage area used to hold
242211ccc33fSMarcel Ziswiler	   a redundant copy of the environment data, so that there is
24233e38691eSwdenk	   a valid backup copy in case there is a power failure during
2424c609719bSwdenk	   a "saveenv" operation.
2425c609719bSwdenk
2426c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the
2427c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds*
2428c609719bSwdenkaccordingly!
2429c609719bSwdenk
2430c609719bSwdenk
24319314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM:
2432c609719bSwdenk
2433c609719bSwdenk	Define this if you have some non-volatile memory device
2434c609719bSwdenk	(NVRAM, battery buffered SRAM) which you want to use for the
2435c609719bSwdenk	environment.
2436c609719bSwdenk
24370e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
24380e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
2439c609719bSwdenk
244011ccc33fSMarcel Ziswiler	  These two #defines are used to determine the memory area you
2441c609719bSwdenk	  want to use for environment. It is assumed that this memory
2442c609719bSwdenk	  can just be read and written to, without any special
2443c609719bSwdenk	  provision.
2444c609719bSwdenk
2445c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early
2446c609719bSwdenkin U-Boot initalization (when we try to get the setting of for the
244711ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or
2448c609719bSwdenkU-Boot will hang.
2449c609719bSwdenk
2450c609719bSwdenkPlease note that even with NVRAM we still use a copy of the
2451c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to
2452c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv"
2453c609719bSwdenkto save the current settings.
2454c609719bSwdenk
2455c609719bSwdenk
2456bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM:
2457c609719bSwdenk
2458c609719bSwdenk	Use this if you have an EEPROM or similar serial access
2459c609719bSwdenk	device and a driver for it.
2460c609719bSwdenk
24610e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
24620e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
2463c609719bSwdenk
2464c609719bSwdenk	  These two #defines specify the offset and size of the
2465c609719bSwdenk	  environment area within the total memory of your EEPROM.
2466c609719bSwdenk
24676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR:
2468c609719bSwdenk	  If defined, specified the chip address of the EEPROM device.
2469c609719bSwdenk	  The default address is zero.
2470c609719bSwdenk
24716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
2472c609719bSwdenk	  If defined, the number of bits used to address bytes in a
2473c609719bSwdenk	  single page in the EEPROM device.  A 64 byte page, for example
2474c609719bSwdenk	  would require six bits.
2475c609719bSwdenk
24766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
2477c609719bSwdenk	  If defined, the number of milliseconds to delay between
2478c609719bSwdenk	  page writes.	The default is zero milliseconds.
2479c609719bSwdenk
24806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
2481c609719bSwdenk	  The length in bytes of the EEPROM memory array address.  Note
2482c609719bSwdenk	  that this is NOT the chip address length!
2483c609719bSwdenk
24846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
24855cf91d6bSwdenk	  EEPROM chips that implement "address overflow" are ones
24865cf91d6bSwdenk	  like Catalyst 24WC04/08/16 which has 9/10/11 bits of
24875cf91d6bSwdenk	  address and the extra bits end up in the "chip address" bit
24885cf91d6bSwdenk	  slots. This makes a 24WC08 (1Kbyte) chip look like four 256
24895cf91d6bSwdenk	  byte chips.
24905cf91d6bSwdenk
24915cf91d6bSwdenk	  Note that we consider the length of the address field to
24925cf91d6bSwdenk	  still be one byte because the extra address bits are hidden
24935cf91d6bSwdenk	  in the chip address.
24945cf91d6bSwdenk
24956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_SIZE:
2496c609719bSwdenk	  The size in bytes of the EEPROM device.
2497c609719bSwdenk
2498548738b4SHeiko Schocher	- CONFIG_ENV_EEPROM_IS_ON_I2C
2499548738b4SHeiko Schocher	  define this, if you have I2C and SPI activated, and your
2500548738b4SHeiko Schocher	  EEPROM, which holds the environment, is on the I2C bus.
2501548738b4SHeiko Schocher
2502548738b4SHeiko Schocher	- CONFIG_I2C_ENV_EEPROM_BUS
2503548738b4SHeiko Schocher	  if you have an Environment on an EEPROM reached over
2504548738b4SHeiko Schocher	  I2C muxes, you can define here, how to reach this
2505548738b4SHeiko Schocher	  EEPROM. For example:
2506548738b4SHeiko Schocher
2507548738b4SHeiko Schocher	  #define CONFIG_I2C_ENV_EEPROM_BUS       "pca9547:70:d\0"
2508548738b4SHeiko Schocher
2509548738b4SHeiko Schocher	  EEPROM which holds the environment, is reached over
2510548738b4SHeiko Schocher	  a pca9547 i2c mux with address 0x70, channel 3.
2511c609719bSwdenk
2512057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH:
25135779d8d9Swdenk
25145779d8d9Swdenk	Define this if you have a DataFlash memory device which you
25155779d8d9Swdenk	want to use for the environment.
25165779d8d9Swdenk
25170e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
25180e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
25190e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
25205779d8d9Swdenk
25215779d8d9Swdenk	  These three #defines specify the offset and size of the
25225779d8d9Swdenk	  environment area within the total memory of your DataFlash placed
25235779d8d9Swdenk	  at the specified address.
25245779d8d9Swdenk
252551bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND:
252613a5695bSwdenk
252713a5695bSwdenk	Define this if you have a NAND device which you want to use
252813a5695bSwdenk	for the environment.
252913a5695bSwdenk
25300e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
25310e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
253213a5695bSwdenk
253313a5695bSwdenk	  These two #defines specify the offset and size of the environment
253413a5695bSwdenk	  area within the first NAND device.
25355779d8d9Swdenk
25360e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET_REDUND
2537e443c944SMarkus Klotzbuecher
25380e8d1586SJean-Christophe PLAGNIOL-VILLARD	  This setting describes a second storage area of CONFIG_ENV_SIZE
2539e443c944SMarkus Klotzbuecher	  size used to hold a redundant copy of the environment data,
2540e443c944SMarkus Klotzbuecher	  so that there is a valid backup copy in case there is a
2541e443c944SMarkus Klotzbuecher	  power failure during a "saveenv" operation.
2542e443c944SMarkus Klotzbuecher
25430e8d1586SJean-Christophe PLAGNIOL-VILLARD	Note: CONFIG_ENV_OFFSET and CONFIG_ENV_OFFSET_REDUND must be aligned
25440e8d1586SJean-Christophe PLAGNIOL-VILLARD	to a block boundary, and CONFIG_ENV_SIZE must be a multiple of
2545e443c944SMarkus Klotzbuecher	the NAND devices block size.
2546e443c944SMarkus Klotzbuecher
2547b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST
2548b74ab737SGuennadi Liakhovetski
2549b74ab737SGuennadi Liakhovetski	Defines address in RAM to which the nand_spl code should copy the
2550b74ab737SGuennadi Liakhovetski	environment. If redundant environment is used, it will be copied to
2551b74ab737SGuennadi Liakhovetski	CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
2552b74ab737SGuennadi Liakhovetski
25536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET
2554c609719bSwdenk
2555c609719bSwdenk	Defines offset to the initial SPI buffer area in DPRAM. The
2556c609719bSwdenk	area is used at an early stage (ROM part) if the environment
2557c609719bSwdenk	is configured to reside in the SPI EEPROM: We need a 520 byte
2558c609719bSwdenk	scratch DPRAM area. It is used between the two initialization
2559c609719bSwdenk	calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
2560c609719bSwdenk	to be a good choice since it makes it far enough from the
2561c609719bSwdenk	start of the data area as well as from the stack pointer.
2562c609719bSwdenk
2563e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor
2564c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been
2565c609719bSwdenkcreated; also, when using EEPROM you will have to use getenv_r()
2566c609719bSwdenkuntil then to read environment variables.
2567c609719bSwdenk
256885ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor
256985ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working
257085ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is
257185ec0bccSwdenknecessary, because the first environment variable we need is the
257285ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't
257385ec0bccSwdenkhave any device yet where we could complain.]
2574c609719bSwdenk
2575c609719bSwdenkNote: once the monitor has been relocated, then it will complain if
2576c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you
257785ec0bccSwdenkuse the "saveenv" command to store a valid environment.
2578c609719bSwdenk
25796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
2580fc3e2165Swdenk		Echo the inverted Ethernet link state to the fault LED.
2581fc3e2165Swdenk
25826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
2583fc3e2165Swdenk		      also needs to be defined.
2584fc3e2165Swdenk
25856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR:
2586fc3e2165Swdenk		MII address of the PHY to check for the Ethernet link state.
2587c609719bSwdenk
2588f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS:
2589f5675aa5SRon Madrid		Define this if you desire to only have use of the NS16550_init
2590f5675aa5SRon Madrid		and NS16550_putc functions for the serial driver located at
2591f5675aa5SRon Madrid		drivers/serial/ns16550.c.  This option is useful for saving
2592f5675aa5SRon Madrid		space for already greatly restricted images, including but not
2593f5675aa5SRon Madrid		limited to NAND_SPL configurations.
2594f5675aa5SRon Madrid
2595c609719bSwdenkLow Level (hardware related) configuration options:
2596dc7c9a1aSwdenk---------------------------------------------------
2597c609719bSwdenk
25986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE:
2599c609719bSwdenk		Cache Line Size of the CPU.
2600c609719bSwdenk
26016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR:
2602c609719bSwdenk		Default address of the IMMR after system reset.
26032535d602Swdenk
26042535d602Swdenk		Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
26052535d602Swdenk		and RPXsuper) to be able to adjust the position of
26062535d602Swdenk		the IMMR register after a reset.
2607c609719bSwdenk
26087f6c2cbcSwdenk- Floppy Disk Support:
26096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER
26107f6c2cbcSwdenk
26117f6c2cbcSwdenk		the default drive number (default value 0)
26127f6c2cbcSwdenk
26136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_STRIDE
26147f6c2cbcSwdenk
261511ccc33fSMarcel Ziswiler		defines the spacing between FDC chipset registers
26167f6c2cbcSwdenk		(default value 1)
26177f6c2cbcSwdenk
26186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_OFFSET
26197f6c2cbcSwdenk
26207f6c2cbcSwdenk		defines the offset of register from address. It
26217f6c2cbcSwdenk		depends on which part of the data bus is connected to
262211ccc33fSMarcel Ziswiler		the FDC chipset. (default value 0)
26237f6c2cbcSwdenk
26246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
26256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
26267f6c2cbcSwdenk		default value.
26277f6c2cbcSwdenk
26286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		if CONFIG_SYS_FDC_HW_INIT is defined, then the function
26297f6c2cbcSwdenk		fdc_hw_init() is called at the beginning of the FDC
26307f6c2cbcSwdenk		setup. fdc_hw_init() must be provided by the board
26317f6c2cbcSwdenk		source code. It is used to make hardware dependant
26327f6c2cbcSwdenk		initializations.
26337f6c2cbcSwdenk
26346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR:	Physical address of the Internal Memory.
263525d6712aSwdenk		DO NOT CHANGE unless you know exactly what you're
263625d6712aSwdenk		doing! (11-4) [MPC8xx/82xx systems only]
2637c609719bSwdenk
26386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR:
2639c609719bSwdenk
26407152b1d0Swdenk		Start address of memory area that can be used for
2641c609719bSwdenk		initial data and stack; please note that this must be
2642c609719bSwdenk		writable memory that is working WITHOUT special
2643c609719bSwdenk		initialization, i. e. you CANNOT use normal RAM which
2644c609719bSwdenk		will become available only after programming the
2645c609719bSwdenk		memory controller and running certain initialization
2646c609719bSwdenk		sequences.
2647c609719bSwdenk
2648c609719bSwdenk		U-Boot uses the following memory types:
2649c609719bSwdenk		- MPC8xx and MPC8260: IMMR (internal memory of the CPU)
2650c609719bSwdenk		- MPC824X: data cache
2651c609719bSwdenk		- PPC4xx:  data cache
2652c609719bSwdenk
26536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET:
2654c609719bSwdenk
2655c609719bSwdenk		Offset of the initial data structure in the memory
26566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
26576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
2658c609719bSwdenk		data is located at the end of the available space
26596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		(sometimes written as (CONFIG_SYS_INIT_RAM_END -
26606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
26616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
26626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET) downward.
2663c609719bSwdenk
2664c609719bSwdenk	Note:
2665c609719bSwdenk		On the MPC824X (or other systems that use the data
2666c609719bSwdenk		cache for initial memory) the address chosen for
26676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
2668c609719bSwdenk		point to an otherwise UNUSED address space between
2669c609719bSwdenk		the top of RAM and the start of the PCI space.
2670c609719bSwdenk
26716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR:	SIU Module Configuration (11-6)
2672c609719bSwdenk
26736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR:	System Protection Control (11-9)
2674c609719bSwdenk
26756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR:	Time Base Status and Control (11-26)
2676c609719bSwdenk
26776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR:	Periodic Interrupt Status and Control (11-31)
2678c609719bSwdenk
26796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR:	PLL, Low-Power, and Reset Control Register (15-30)
2680c609719bSwdenk
26816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR:	System Clock and reset Control Register (15-27)
2682c609719bSwdenk
26836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM:
2684c609719bSwdenk		SDRAM timing
2685c609719bSwdenk
26866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA:
2687c609719bSwdenk		periodic timer for refresh
2688c609719bSwdenk
26896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER:	Debug Event Register (37-47)
2690c609719bSwdenk
26916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
26926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
26936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
26946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_BR1_PRELIM:
2695c609719bSwdenk		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
2696c609719bSwdenk
2697c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
26986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
26996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
2700c609719bSwdenk		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
2701c609719bSwdenk
27026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
27036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
2704c609719bSwdenk		Machine Mode Register and Memory Periodic Timer
2705c609719bSwdenk		Prescaler definitions (SDRAM timing)
2706c609719bSwdenk
27076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
2708c609719bSwdenk		enable I2C microcode relocation patch (MPC8xx);
2709c609719bSwdenk		define relocation offset in DPRAM [DSP2]
2710c609719bSwdenk
27116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
2712b423d055SHeiko Schocher		enable SMC microcode relocation patch (MPC8xx);
2713b423d055SHeiko Schocher		define relocation offset in DPRAM [SMC1]
2714b423d055SHeiko Schocher
27156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
2716c609719bSwdenk		enable SPI microcode relocation patch (MPC8xx);
2717c609719bSwdenk		define relocation offset in DPRAM [SCC4]
2718c609719bSwdenk
27196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_USE_OSCCLK:
2720c609719bSwdenk		Use OSCM clock mode on MBX8xx board. Be careful,
2721c609719bSwdenk		wrong setting might damage your board. Read
2722c609719bSwdenk		doc/README.MBX before setting this variable!
2723c609719bSwdenk
27246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
2725ea909b76Swdenk		Offset of the bootmode word in DPRAM used by post
2726ea909b76Swdenk		(Power On Self Tests). This definition overrides
2727ea909b76Swdenk		#define'd default value in commproc.h resp.
2728ea909b76Swdenk		cpm_8260.h.
2729ea909b76Swdenk
27306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
27316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
27326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
27336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
27346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
27356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
27366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
27376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
2738a47a12beSStefan Roese		Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
27395d232d0eSwdenk
27409cacf4fcSDirk Eibach- CONFIG_PCI_DISABLE_PCIE:
27419cacf4fcSDirk Eibach		Disable PCI-Express on systems where it is supported but not
27429cacf4fcSDirk Eibach		required.
27439cacf4fcSDirk Eibach
2744bb99ad6dSBen Warren- CONFIG_SPD_EEPROM
2745218ca724SWolfgang Denk		Get DDR timing information from an I2C EEPROM. Common
2746218ca724SWolfgang Denk		with pluggable memory modules such as SODIMMs
2747218ca724SWolfgang Denk
2748bb99ad6dSBen Warren  SPD_EEPROM_ADDRESS
2749bb99ad6dSBen Warren		I2C address of the SPD EEPROM
2750bb99ad6dSBen Warren
27516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM
2752218ca724SWolfgang Denk		If SPD EEPROM is on an I2C bus other than the first
2753218ca724SWolfgang Denk		one, specify here. Note that the value must resolve
2754218ca724SWolfgang Denk		to something your driver can deal with.
2755bb99ad6dSBen Warren
27566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0
2757218ca724SWolfgang Denk		Only for 83xx systems. If specified, then DDR should
2758218ca724SWolfgang Denk		be configured using CS0 and CS1 instead of CS2 and CS3.
27592ad6b513STimur Tabi
2760c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12]
2761c26e454dSwdenk		Define to enable FEC[12] on a 8xx series processor.
2762c26e454dSwdenk
2763c26e454dSwdenk- CONFIG_FEC[12]_PHY
2764c26e454dSwdenk		Define to the hardcoded PHY address which corresponds
27656e592385Swdenk		to the given FEC; i. e.
2766c26e454dSwdenk			#define CONFIG_FEC1_PHY 4
2767c26e454dSwdenk		means that the PHY with address 4 is connected to FEC1
2768c26e454dSwdenk
2769c26e454dSwdenk		When set to -1, means to probe for first available.
2770c26e454dSwdenk
2771c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR
2772c26e454dSwdenk		The PHY does not have a RXERR line (RMII only).
2773c26e454dSwdenk		(so program the FEC to ignore it).
2774c26e454dSwdenk
2775c26e454dSwdenk- CONFIG_RMII
2776c26e454dSwdenk		Enable RMII mode for all FECs.
2777c26e454dSwdenk		Note that this is a global option, we can't
2778c26e454dSwdenk		have one FEC in standard MII mode and another in RMII mode.
2779c26e454dSwdenk
27805cf91d6bSwdenk- CONFIG_CRC32_VERIFY
27815cf91d6bSwdenk		Add a verify option to the crc32 command.
27825cf91d6bSwdenk		The syntax is:
27835cf91d6bSwdenk
27845cf91d6bSwdenk		=> crc32 -v <address> <count> <crc32>
27855cf91d6bSwdenk
27865cf91d6bSwdenk		Where address/count indicate a memory area
27875cf91d6bSwdenk		and crc32 is the correct crc32 which the
27885cf91d6bSwdenk		area should have.
27895cf91d6bSwdenk
279056523f12Swdenk- CONFIG_LOOPW
279156523f12Swdenk		Add the "loopw" memory command. This only takes effect if
2792602ad3b3SJon Loeliger		the memory commands are activated globally (CONFIG_CMD_MEM).
279356523f12Swdenk
27947b466641Sstroese- CONFIG_MX_CYCLIC
27957b466641Sstroese		Add the "mdc" and "mwc" memory commands. These are cyclic
27967b466641Sstroese		"md/mw" commands.
27977b466641Sstroese		Examples:
27987b466641Sstroese
27997b466641Sstroese		=> mdc.b 10 4 500
28007b466641Sstroese		This command will print 4 bytes (10,11,12,13) each 500 ms.
28017b466641Sstroese
28027b466641Sstroese		=> mwc.l 100 12345678 10
28037b466641Sstroese		This command will write 12345678 to address 100 all 10 ms.
28047b466641Sstroese
28057b466641Sstroese		This only takes effect if the memory commands are activated
2806602ad3b3SJon Loeliger		globally (CONFIG_CMD_MEM).
28077b466641Sstroese
28088aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT
28098aa1a2d1Swdenk- CONFIG_SKIP_RELOCATE_UBOOT
28108aa1a2d1Swdenk
28118aa1a2d1Swdenk		[ARM only] If these variables are defined, then
28128aa1a2d1Swdenk		certain low level initializations (like setting up
28138aa1a2d1Swdenk		the memory controller) are omitted and/or U-Boot does
28148aa1a2d1Swdenk		not relocate itself into RAM.
28158aa1a2d1Swdenk		Normally these variables MUST NOT be defined. The
28168aa1a2d1Swdenk		only exception is when U-Boot is loaded (to RAM) by
28178aa1a2d1Swdenk		some other boot loader or by a debugger which
281811ccc33fSMarcel Ziswiler		performs these initializations itself.
28198aa1a2d1Swdenk
2820df81238bSMagnus Lilja- CONFIG_PRELOADER
2821df81238bSMagnus Lilja
2822df81238bSMagnus Lilja		Modifies the behaviour of start.S when compiling a loader
2823df81238bSMagnus Lilja		that is executed before the actual U-Boot. E.g. when
2824df81238bSMagnus Lilja		compiling a NAND SPL.
2825400558b5Swdenk
2826c609719bSwdenkBuilding the Software:
2827c609719bSwdenk======================
2828c609719bSwdenk
2829218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments
2830218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support
2831218ca724SWolfgang Denkall possibly existing versions of cross development tools in all
2832218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we
2833218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
2834218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot.
2835c609719bSwdenk
2836218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you
2837218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case,
2838218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell.
2839218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are
2840218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter:
2841c609719bSwdenk
2842218ca724SWolfgang Denk	$ CROSS_COMPILE=ppc_4xx-
2843218ca724SWolfgang Denk	$ export CROSS_COMPILE
2844c609719bSwdenk
28452f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in
28462f8d396bSPeter Tyser      the tools directory you can use the MinGW toolchain
28472f8d396bSPeter Tyser      (http://www.mingw.org).  Set your HOST tools to the MinGW
28482f8d396bSPeter Tyser      toolchain and execute 'make tools'.  For example:
28492f8d396bSPeter Tyser
28502f8d396bSPeter Tyser       $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
28512f8d396bSPeter Tyser
28522f8d396bSPeter Tyser      Binaries such as tools/mkimage.exe will be created which can
28532f8d396bSPeter Tyser      be executed on computers running Windows.
28542f8d396bSPeter Tyser
2855c609719bSwdenkU-Boot is intended to be simple to build. After installing the
2856c609719bSwdenksources you must configure U-Boot for one specific board type. This
2857c609719bSwdenkis done by typing:
2858c609719bSwdenk
2859c609719bSwdenk	make NAME_config
2860c609719bSwdenk
2861218ca724SWolfgang Denkwhere "NAME_config" is the name of one of the existing configu-
2862218ca724SWolfgang Denkrations; see the main Makefile for supported names.
286354387ac9Swdenk
2864c609719bSwdenkNote: for some board special configuration names may exist; check if
2865c609719bSwdenk      additional information is available from the board vendor; for
28662729af9dSwdenk      instance, the TQM823L systems are available without (standard)
28672729af9dSwdenk      or with LCD support. You can select such additional "features"
286811ccc33fSMarcel Ziswiler      when choosing the configuration, i. e.
2869c609719bSwdenk
28702729af9dSwdenk      make TQM823L_config
28712729af9dSwdenk	- will configure for a plain TQM823L, i. e. no LCD support
2872c609719bSwdenk
2873c609719bSwdenk      make TQM823L_LCD_config
2874c609719bSwdenk	- will configure for a TQM823L with U-Boot console on LCD
2875c609719bSwdenk
2876c609719bSwdenk      etc.
2877c609719bSwdenk
2878c609719bSwdenk
2879c609719bSwdenkFinally, type "make all", and you should get some working U-Boot
28807152b1d0Swdenkimages ready for download to / installation on your system:
2881c609719bSwdenk
2882c609719bSwdenk- "u-boot.bin" is a raw binary image
2883c609719bSwdenk- "u-boot" is an image in ELF binary format
2884c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format
2885c609719bSwdenk
2886baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved
2887baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change
2888baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory:
2889baf31249SMarian Balakowicz
2890baf31249SMarian Balakowicz1. Add O= to the make command line invocations:
2891baf31249SMarian Balakowicz
2892baf31249SMarian Balakowicz	make O=/tmp/build distclean
2893baf31249SMarian Balakowicz	make O=/tmp/build NAME_config
2894baf31249SMarian Balakowicz	make O=/tmp/build all
2895baf31249SMarian Balakowicz
2896baf31249SMarian Balakowicz2. Set environment variable BUILD_DIR to point to the desired location:
2897baf31249SMarian Balakowicz
2898baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
2899baf31249SMarian Balakowicz	make distclean
2900baf31249SMarian Balakowicz	make NAME_config
2901baf31249SMarian Balakowicz	make all
2902baf31249SMarian Balakowicz
2903baf31249SMarian BalakowiczNote that the command line "O=" setting overrides the BUILD_DIR environment
2904baf31249SMarian Balakowiczvariable.
2905baf31249SMarian Balakowicz
2906c609719bSwdenk
2907c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so
2908c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of
2909c609719bSwdenknative "make".
2910c609719bSwdenk
2911c609719bSwdenk
2912c609719bSwdenkIf the system board that you have is not listed, then you will need
2913c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these
2914c609719bSwdenksteps:
2915c609719bSwdenk
2916c609719bSwdenk1.  Add a new configuration option for your board to the toplevel
291785ec0bccSwdenk    "Makefile" and to the "MAKEALL" script, using the existing
291885ec0bccSwdenk    entries as examples. Note that here and at many other places
29197152b1d0Swdenk    boards and other names are listed in alphabetical sort order. Please
292085ec0bccSwdenk    keep this order.
2921c609719bSwdenk2.  Create a new directory to hold your board specific code. Add any
292285ec0bccSwdenk    files you need. In your board directory, you will need at least
292385ec0bccSwdenk    the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
292485ec0bccSwdenk3.  Create a new configuration file "include/configs/<board>.h" for
292585ec0bccSwdenk    your board
2926c609719bSwdenk3.  If you're porting U-Boot to a new CPU, then also create a new
2927c609719bSwdenk    directory to hold your CPU specific code. Add any files you need.
292885ec0bccSwdenk4.  Run "make <board>_config" with your new name.
2929c609719bSwdenk5.  Type "make", and you should get a working "u-boot.srec" file
2930c609719bSwdenk    to be installed on your target system.
293185ec0bccSwdenk6.  Debug and solve any problems that might arise.
2932c609719bSwdenk    [Of course, this last step is much harder than it sounds.]
2933c609719bSwdenk
2934c609719bSwdenk
2935c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.:
2936c609719bSwdenk==============================================================
2937c609719bSwdenk
2938c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board
2939c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to
2940c609719bSwdenkprovide feedback to the other developers. The feedback normally takes
2941c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest
2942218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources.
2943c609719bSwdenk
2944c609719bSwdenkBut before you submit such a patch, please verify that your modifi-
2945c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of
2946c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so,
2947c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot
2948c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You can
29497152b1d0Swdenkselect which (cross) compiler to use by passing a `CROSS_COMPILE'
2950218ca724SWolfgang Denkenvironment variable to the script, i. e. to use the ELDK cross tools
2951218ca724SWolfgang Denkyou can type
2952c609719bSwdenk
2953c609719bSwdenk	CROSS_COMPILE=ppc_8xx- MAKEALL
2954c609719bSwdenk
2955c609719bSwdenkor to build on a native PowerPC system you can type
2956c609719bSwdenk
2957c609719bSwdenk	CROSS_COMPILE=' ' MAKEALL
2958c609719bSwdenk
2959218ca724SWolfgang DenkWhen using the MAKEALL script, the default behaviour is to build
2960218ca724SWolfgang DenkU-Boot in the source directory. This location can be changed by
2961218ca724SWolfgang Denksetting the BUILD_DIR environment variable. Also, for each target
2962218ca724SWolfgang Denkbuilt, the MAKEALL script saves two log files (<target>.ERR and
2963218ca724SWolfgang Denk<target>.MAKEALL) in the <source dir>/LOG directory. This default
2964218ca724SWolfgang Denklocation can be changed by setting the MAKEALL_LOGDIR environment
2965218ca724SWolfgang Denkvariable. For example:
2966baf31249SMarian Balakowicz
2967baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
2968baf31249SMarian Balakowicz	export MAKEALL_LOGDIR=/tmp/log
2969baf31249SMarian Balakowicz	CROSS_COMPILE=ppc_8xx- MAKEALL
2970baf31249SMarian Balakowicz
2971218ca724SWolfgang DenkWith the above settings build objects are saved in the /tmp/build,
2972218ca724SWolfgang Denklog files are saved in the /tmp/log and the source tree remains clean
2973218ca724SWolfgang Denkduring the whole build process.
2974baf31249SMarian Balakowicz
2975baf31249SMarian Balakowicz
2976c609719bSwdenkSee also "U-Boot Porting Guide" below.
2977c609719bSwdenk
2978c609719bSwdenk
2979c609719bSwdenkMonitor Commands - Overview:
2980c609719bSwdenk============================
2981c609719bSwdenk
2982c609719bSwdenkgo	- start application at address 'addr'
2983c609719bSwdenkrun	- run commands in an environment variable
2984c609719bSwdenkbootm	- boot application image from memory
2985c609719bSwdenkbootp	- boot image via network using BootP/TFTP protocol
2986c609719bSwdenktftpboot- boot image via network using TFTP protocol
2987c609719bSwdenk	       and env variables "ipaddr" and "serverip"
2988c609719bSwdenk	       (and eventually "gatewayip")
2989c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol
2990c609719bSwdenkdiskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
2991c609719bSwdenkloads	- load S-Record file over serial line
2992c609719bSwdenkloadb	- load binary file over serial line (kermit mode)
2993c609719bSwdenkmd	- memory display
2994c609719bSwdenkmm	- memory modify (auto-incrementing)
2995c609719bSwdenknm	- memory modify (constant address)
2996c609719bSwdenkmw	- memory write (fill)
2997c609719bSwdenkcp	- memory copy
2998c609719bSwdenkcmp	- memory compare
2999c609719bSwdenkcrc32	- checksum calculation
30000f89c54bSPeter Tyseri2c	- I2C sub-system
3001c609719bSwdenksspi	- SPI utility commands
3002c609719bSwdenkbase	- print or set address offset
3003c609719bSwdenkprintenv- print environment variables
3004c609719bSwdenksetenv	- set environment variables
3005c609719bSwdenksaveenv - save environment variables to persistent storage
3006c609719bSwdenkprotect - enable or disable FLASH write protection
3007c609719bSwdenkerase	- erase FLASH memory
3008c609719bSwdenkflinfo	- print FLASH memory information
3009c609719bSwdenkbdinfo	- print Board Info structure
3010c609719bSwdenkiminfo	- print header information for application image
3011c609719bSwdenkconinfo - print console devices and informations
3012c609719bSwdenkide	- IDE sub-system
3013c609719bSwdenkloop	- infinite loop on address range
301456523f12Swdenkloopw	- infinite write loop on address range
3015c609719bSwdenkmtest	- simple RAM test
3016c609719bSwdenkicache	- enable or disable instruction cache
3017c609719bSwdenkdcache	- enable or disable data cache
3018c609719bSwdenkreset	- Perform RESET of the CPU
3019c609719bSwdenkecho	- echo args to console
3020c609719bSwdenkversion - print monitor version
3021c609719bSwdenkhelp	- print online help
3022c609719bSwdenk?	- alias for 'help'
3023c609719bSwdenk
3024c609719bSwdenk
3025c609719bSwdenkMonitor Commands - Detailed Description:
3026c609719bSwdenk========================================
3027c609719bSwdenk
3028c609719bSwdenkTODO.
3029c609719bSwdenk
3030c609719bSwdenkFor now: just type "help <command>".
3031c609719bSwdenk
3032c609719bSwdenk
3033c609719bSwdenkEnvironment Variables:
3034c609719bSwdenk======================
3035c609719bSwdenk
3036c609719bSwdenkU-Boot supports user configuration using Environment Variables which
3037c609719bSwdenkcan be made persistent by saving to Flash memory.
3038c609719bSwdenk
3039c609719bSwdenkEnvironment Variables are set using "setenv", printed using
3040c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv"
3041c609719bSwdenkwithout a value can be used to delete a variable from the
3042c609719bSwdenkenvironment. As long as you don't save the environment you are
3043c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the
3044c609719bSwdenkenvironment is erased by accident, a default environment is provided.
3045c609719bSwdenk
3046c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables.
3047c96f86eeSWolfgang Denk
3048c96f86eeSWolfgang DenkList of environment variables (most likely not complete):
3049c609719bSwdenk
3050c609719bSwdenk  baudrate	- see CONFIG_BAUDRATE
3051c609719bSwdenk
3052c609719bSwdenk  bootdelay	- see CONFIG_BOOTDELAY
3053c609719bSwdenk
3054c609719bSwdenk  bootcmd	- see CONFIG_BOOTCOMMAND
3055c609719bSwdenk
3056c609719bSwdenk  bootargs	- Boot arguments when booting an RTOS image
3057c609719bSwdenk
3058c609719bSwdenk  bootfile	- Name of the image to load with TFTP
3059c609719bSwdenk
30607d721e34SBartlomiej Sieka  bootm_low	- Memory range available for image processing in the bootm
30617d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
30627d721e34SBartlomiej Sieka		  a hexadecimal number and defines lowest address allowed
30637d721e34SBartlomiej Sieka		  for use by the bootm command. See also "bootm_size"
30647d721e34SBartlomiej Sieka		  environment variable. Address defined by "bootm_low" is
30657d721e34SBartlomiej Sieka		  also the base of the initial memory mapping for the Linux
30666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		  kernel -- see the description of CONFIG_SYS_BOOTMAPSZ.
30677d721e34SBartlomiej Sieka
30687d721e34SBartlomiej Sieka  bootm_size	- Memory range available for image processing in the bootm
30697d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
30707d721e34SBartlomiej Sieka		  a hexadecimal number and defines the size of the region
30717d721e34SBartlomiej Sieka		  allowed for use by the bootm command. See also "bootm_low"
30727d721e34SBartlomiej Sieka		  environment variable.
30737d721e34SBartlomiej Sieka
30744bae9090SBartlomiej Sieka  updatefile	- Location of the software update file on a TFTP server, used
30754bae9090SBartlomiej Sieka		  by the automatic software update feature. Please refer to
30764bae9090SBartlomiej Sieka		  documentation in doc/README.update for more details.
30774bae9090SBartlomiej Sieka
3078c609719bSwdenk  autoload	- if set to "no" (any string beginning with 'n'),
3079c609719bSwdenk		  "bootp" will just load perform a lookup of the
3080c609719bSwdenk		  configuration from the BOOTP server, but not try to
3081c609719bSwdenk		  load any image using TFTP
3082c609719bSwdenk
3083c609719bSwdenk  autostart	- if set to "yes", an image loaded using the "bootp",
3084c609719bSwdenk		  "rarpboot", "tftpboot" or "diskboot" commands will
3085c609719bSwdenk		  be automatically started (by internally calling
3086c609719bSwdenk		  "bootm")
3087c609719bSwdenk
30884a6fd34bSwdenk		  If set to "no", a standalone image passed to the
30894a6fd34bSwdenk		  "bootm" command will be copied to the load address
30904a6fd34bSwdenk		  (and eventually uncompressed), but NOT be started.
30914a6fd34bSwdenk		  This can be used to load and uncompress arbitrary
30924a6fd34bSwdenk		  data.
30934a6fd34bSwdenk
309417ea1177Swdenk  i2cfast	- (PPC405GP|PPC405EP only)
309517ea1177Swdenk		  if set to 'y' configures Linux I2C driver for fast
309617ea1177Swdenk		  mode (400kHZ). This environment variable is used in
309717ea1177Swdenk		  initialization code. So, for changes to be effective
309817ea1177Swdenk		  it must be saved and board must be reset.
309917ea1177Swdenk
3100c609719bSwdenk  initrd_high	- restrict positioning of initrd images:
3101c609719bSwdenk		  If this variable is not set, initrd images will be
3102c609719bSwdenk		  copied to the highest possible address in RAM; this
3103c609719bSwdenk		  is usually what you want since it allows for
3104c609719bSwdenk		  maximum initrd size. If for some reason you want to
3105c609719bSwdenk		  make sure that the initrd image is loaded below the
31066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		  CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
3107c609719bSwdenk		  variable to a value of "no" or "off" or "0".
3108c609719bSwdenk		  Alternatively, you can set it to a maximum upper
3109c609719bSwdenk		  address to use (U-Boot will still check that it
3110c609719bSwdenk		  does not overwrite the U-Boot stack and data).
3111c609719bSwdenk
3112c609719bSwdenk		  For instance, when you have a system with 16 MB
31137152b1d0Swdenk		  RAM, and want to reserve 4 MB from use by Linux,
3114c609719bSwdenk		  you can do this by adding "mem=12M" to the value of
3115c609719bSwdenk		  the "bootargs" variable. However, now you must make
31167152b1d0Swdenk		  sure that the initrd image is placed in the first
3117c609719bSwdenk		  12 MB as well - this can be done with
3118c609719bSwdenk
3119c609719bSwdenk		  setenv initrd_high 00c00000
3120c609719bSwdenk
312138b99261Swdenk		  If you set initrd_high to 0xFFFFFFFF, this is an
312238b99261Swdenk		  indication to U-Boot that all addresses are legal
312338b99261Swdenk		  for the Linux kernel, including addresses in flash
312438b99261Swdenk		  memory. In this case U-Boot will NOT COPY the
312538b99261Swdenk		  ramdisk at all. This may be useful to reduce the
312638b99261Swdenk		  boot time on your system, but requires that this
312738b99261Swdenk		  feature is supported by your Linux kernel.
312838b99261Swdenk
3129c609719bSwdenk  ipaddr	- IP address; needed for tftpboot command
3130c609719bSwdenk
3131c609719bSwdenk  loadaddr	- Default load address for commands like "bootp",
3132dc7c9a1aSwdenk		  "rarpboot", "tftpboot", "loadb" or "diskboot"
3133c609719bSwdenk
3134c609719bSwdenk  loads_echo	- see CONFIG_LOADS_ECHO
3135c609719bSwdenk
3136c609719bSwdenk  serverip	- TFTP server IP address; needed for tftpboot command
3137c609719bSwdenk
3138c609719bSwdenk  bootretry	- see CONFIG_BOOT_RETRY_TIME
3139c609719bSwdenk
3140c609719bSwdenk  bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
3141c609719bSwdenk
3142c609719bSwdenk  bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
3143c609719bSwdenk
3144a3d991bdSwdenk  ethprime	- When CONFIG_NET_MULTI is enabled controls which
3145a3d991bdSwdenk		  interface is used first.
3146a3d991bdSwdenk
3147a3d991bdSwdenk  ethact	- When CONFIG_NET_MULTI is enabled controls which
3148a3d991bdSwdenk		  interface is currently active. For example you
3149a3d991bdSwdenk		  can do the following
3150a3d991bdSwdenk
3151a3d991bdSwdenk		  => setenv ethact FEC ETHERNET
3152a3d991bdSwdenk		  => ping 192.168.0.1 # traffic sent on FEC ETHERNET
3153a3d991bdSwdenk		  => setenv ethact SCC ETHERNET
3154a3d991bdSwdenk		  => ping 10.0.0.1 # traffic sent on SCC ETHERNET
3155a3d991bdSwdenk
3156e1692577SMatthias Fuchs  ethrotate	- When set to "no" U-Boot does not go through all
3157e1692577SMatthias Fuchs		  available network interfaces.
3158e1692577SMatthias Fuchs		  It just stays at the currently selected interface.
3159e1692577SMatthias Fuchs
3160a3d991bdSwdenk  netretry	- When set to "no" each network operation will
3161a3d991bdSwdenk		  either succeed or fail without retrying.
31626e592385Swdenk		  When set to "once" the network operation will
31636e592385Swdenk		  fail when all the available network interfaces
31646e592385Swdenk		  are tried once without success.
3165a3d991bdSwdenk		  Useful on scripts which control the retry operation
3166a3d991bdSwdenk		  themselves.
3167a3d991bdSwdenk
3168b4e2f89dSJean-Christophe PLAGNIOL-VILLARD  npe_ucode	- set load address for the NPE microcode
3169a1cf027aSJean-Christophe PLAGNIOL-VILLARD
317028cb9375SWolfgang Denk  tftpsrcport	- If this is set, the value is used for TFTP's
3171ecb0ccd9SWolfgang Denk		  UDP source port.
3172ecb0ccd9SWolfgang Denk
317328cb9375SWolfgang Denk  tftpdstport	- If this is set, the value is used for TFTP's UDP
317428cb9375SWolfgang Denk		  destination port instead of the Well Know Port 69.
317528cb9375SWolfgang Denk
3176c96f86eeSWolfgang Denk  tftpblocksize - Block size to use for TFTP transfers; if not set,
3177c96f86eeSWolfgang Denk		  we use the TFTP server's default block size
3178c96f86eeSWolfgang Denk
3179c96f86eeSWolfgang Denk  tftptimeout	- Retransmission timeout for TFTP packets (in milli-
3180c96f86eeSWolfgang Denk		  seconds, minimum value is 1000 = 1 second). Defines
3181c96f86eeSWolfgang Denk		  when a packet is considered to be lost so it has to
3182c96f86eeSWolfgang Denk		  be retransmitted. The default is 5000 = 5 seconds.
3183c96f86eeSWolfgang Denk		  Lowering this value may make downloads succeed
3184c96f86eeSWolfgang Denk		  faster in networks with high packet loss rates or
3185c96f86eeSWolfgang Denk		  with unreliable TFTP servers.
3186c96f86eeSWolfgang Denk
3187a3d991bdSwdenk  vlan		- When set to a value < 4095 the traffic over
318811ccc33fSMarcel Ziswiler		  Ethernet is encapsulated/received over 802.1q
3189a3d991bdSwdenk		  VLAN tagged frames.
3190c609719bSwdenk
3191c609719bSwdenkThe following environment variables may be used and automatically
3192c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"),
3193c609719bSwdenkdepending the information provided by your boot server:
3194c609719bSwdenk
3195c609719bSwdenk  bootfile	- see above
3196c609719bSwdenk  dnsip		- IP address of your Domain Name Server
3197fe389a82Sstroese  dnsip2	- IP address of your secondary Domain Name Server
3198c609719bSwdenk  gatewayip	- IP address of the Gateway (Router) to use
3199c609719bSwdenk  hostname	- Target hostname
3200c609719bSwdenk  ipaddr	- see above
3201c609719bSwdenk  netmask	- Subnet Mask
3202c609719bSwdenk  rootpath	- Pathname of the root filesystem on the NFS server
3203c609719bSwdenk  serverip	- see above
3204c609719bSwdenk
3205c609719bSwdenk
3206c609719bSwdenkThere are two special Environment Variables:
3207c609719bSwdenk
3208c609719bSwdenk  serial#	- contains hardware identification information such
3209c609719bSwdenk		  as type string and/or serial number
3210c609719bSwdenk  ethaddr	- Ethernet address
3211c609719bSwdenk
3212c609719bSwdenkThese variables can be set only once (usually during manufacturing of
3213c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables
3214c609719bSwdenkonce they have been set once.
3215c609719bSwdenk
3216c609719bSwdenk
3217c1551ea8SstroeseFurther special Environment Variables:
3218c1551ea8Sstroese
3219c1551ea8Sstroese  ver		- Contains the U-Boot version string as printed
3220c1551ea8Sstroese		  with the "version" command. This variable is
3221c1551ea8Sstroese		  readonly (see CONFIG_VERSION_VARIABLE).
3222c1551ea8Sstroese
3223c1551ea8Sstroese
3224c609719bSwdenkPlease note that changes to some configuration parameters may take
3225c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-).
3226c609719bSwdenk
3227c609719bSwdenk
3228f07771ccSwdenkCommand Line Parsing:
3229f07771ccSwdenk=====================
3230f07771ccSwdenk
3231f07771ccSwdenkThere are two different command line parsers available with U-Boot:
32327152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell:
3233f07771ccSwdenk
3234f07771ccSwdenkOld, simple command line parser:
3235f07771ccSwdenk--------------------------------
3236f07771ccSwdenk
3237f07771ccSwdenk- supports environment variables (through setenv / saveenv commands)
3238f07771ccSwdenk- several commands on one line, separated by ';'
3239fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax
3240f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\',
3241f07771ccSwdenk  for example:
3242fe126d8bSWolfgang Denk	setenv bootcmd bootm \${address}
3243f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example:
3244f07771ccSwdenk	setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
3245f07771ccSwdenk
3246f07771ccSwdenkHush shell:
3247f07771ccSwdenk-----------
3248f07771ccSwdenk
3249f07771ccSwdenk- similar to Bourne shell, with control structures like
3250f07771ccSwdenk  if...then...else...fi, for...do...done; while...do...done,
3251f07771ccSwdenk  until...do...done, ...
3252f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv
3253f07771ccSwdenk  commands) and local shell variables (through standard shell syntax
3254f07771ccSwdenk  "name=value"); only environment variables can be used with "run"
3255f07771ccSwdenk  command
3256f07771ccSwdenk
3257f07771ccSwdenkGeneral rules:
3258f07771ccSwdenk--------------
3259f07771ccSwdenk
3260f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run"
3261f07771ccSwdenk    command) contains several commands separated by semicolon, and
3262f07771ccSwdenk    one of these commands fails, then the remaining commands will be
3263f07771ccSwdenk    executed anyway.
3264f07771ccSwdenk
3265f07771ccSwdenk(2) If you execute several variables with one call to run (i. e.
326611ccc33fSMarcel Ziswiler    calling run with a list of variables as arguments), any failing
3267f07771ccSwdenk    command will cause "run" to terminate, i. e. the remaining
3268f07771ccSwdenk    variables are not executed.
3269f07771ccSwdenk
3270c609719bSwdenkNote for Redundant Ethernet Interfaces:
3271c609719bSwdenk=======================================
3272c609719bSwdenk
327311ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports
3274c609719bSwdenksuch configurations and is capable of automatic selection of a
32757152b1d0Swdenk"working" interface when needed. MAC assignment works as follows:
3276c609719bSwdenk
3277c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding
3278c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0),
3279c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ...
3280c609719bSwdenk
3281c609719bSwdenkIf the network interface stores some valid MAC address (for instance
3282c609719bSwdenkin SROM), this is used as default address if there is NO correspon-
3283c609719bSwdenkding setting in the environment; if the corresponding environment
3284c609719bSwdenkvariable is set, this overrides the settings in the card; that means:
3285c609719bSwdenk
3286c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the
3287c609719bSwdenk  environment, the SROM's address is used.
3288c609719bSwdenk
3289c609719bSwdenko If there is no valid address in the SROM, and a definition in the
3290c609719bSwdenk  environment exists, then the value from the environment variable is
3291c609719bSwdenk  used.
3292c609719bSwdenk
3293c609719bSwdenko If both the SROM and the environment contain a MAC address, and
3294c609719bSwdenk  both addresses are the same, this MAC address is used.
3295c609719bSwdenk
3296c609719bSwdenko If both the SROM and the environment contain a MAC address, and the
3297c609719bSwdenk  addresses differ, the value from the environment is used and a
3298c609719bSwdenk  warning is printed.
3299c609719bSwdenk
3300c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error
3301c609719bSwdenk  is raised.
3302c609719bSwdenk
3303ecee9324SBen WarrenIf Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
3304ecee9324SBen Warrenwill be programmed into hardware as part of the initialization process.  This
3305ecee9324SBen Warrenmay be skipped by setting the appropriate 'ethmacskip' environment variable.
3306ecee9324SBen WarrenThe naming convention is as follows:
3307ecee9324SBen Warren"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
3308c609719bSwdenk
3309c609719bSwdenkImage Formats:
3310c609719bSwdenk==============
3311c609719bSwdenk
33123310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on)
33133310c549SMarian Balakowiczimages in two formats:
33143310c549SMarian Balakowicz
33153310c549SMarian BalakowiczNew uImage format (FIT)
33163310c549SMarian Balakowicz-----------------------
33173310c549SMarian Balakowicz
33183310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar
33193310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple
33203310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by
33213310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
33223310c549SMarian Balakowicz
33233310c549SMarian Balakowicz
33243310c549SMarian BalakowiczOld uImage format
33253310c549SMarian Balakowicz-----------------
33263310c549SMarian Balakowicz
33273310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything,
33283310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for
33293310c549SMarian Balakowiczdetails; basically, the header defines the following image properties:
3330c609719bSwdenk
3331c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
3332c609719bSwdenk  4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
3333f5ed9e39SPeter Tyser  LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
3334f5ed9e39SPeter Tyser  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
3335f5ed9e39SPeter Tyser  INTEGRITY).
33367b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
3337*1117cbf2SThomas Chou  IA64, MIPS, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
3338*1117cbf2SThomas Chou  Currently supported: ARM, AVR32, Intel x86, MIPS, Nios II, PowerPC).
3339c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2)
3340c609719bSwdenk* Load Address
3341c609719bSwdenk* Entry Point
3342c609719bSwdenk* Image Name
3343c609719bSwdenk* Image Timestamp
3344c609719bSwdenk
3345c609719bSwdenkThe header is marked by a special Magic Number, and both the header
3346c609719bSwdenkand the data portions of the image are secured against corruption by
3347c609719bSwdenkCRC32 checksums.
3348c609719bSwdenk
3349c609719bSwdenk
3350c609719bSwdenkLinux Support:
3351c609719bSwdenk==============
3352c609719bSwdenk
3353c609719bSwdenkAlthough U-Boot should support any OS or standalone application
33547152b1d0Swdenkeasily, the main focus has always been on Linux during the design of
3355c609719bSwdenkU-Boot.
3356c609719bSwdenk
3357c609719bSwdenkU-Boot includes many features that so far have been part of some
3358c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any
3359c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image;
3360c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation
33617152b1d0Swdenkserves several purposes:
3362c609719bSwdenk
3363c609719bSwdenk- the same features can be used for other OS or standalone
3364c609719bSwdenk  applications (for instance: using compressed images to reduce the
3365c609719bSwdenk  Flash memory footprint)
3366c609719bSwdenk
3367c609719bSwdenk- it becomes much easier to port new Linux kernel versions because
33687152b1d0Swdenk  lots of low-level, hardware dependent stuff are done by U-Boot
3369c609719bSwdenk
3370c609719bSwdenk- the same Linux kernel image can now be used with different "initrd"
3371c609719bSwdenk  images; of course this also means that different kernel images can
3372c609719bSwdenk  be run with the same "initrd". This makes testing easier (you don't
3373c609719bSwdenk  have to build a new "zImage.initrd" Linux image when you just
3374c609719bSwdenk  change a file in your "initrd"). Also, a field-upgrade of the
3375c609719bSwdenk  software is easier now.
3376c609719bSwdenk
3377c609719bSwdenk
3378c609719bSwdenkLinux HOWTO:
3379c609719bSwdenk============
3380c609719bSwdenk
3381c609719bSwdenkPorting Linux to U-Boot based systems:
3382c609719bSwdenk---------------------------------------
3383c609719bSwdenk
3384c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to
3385c609719bSwdenkconfigure the Linux device drivers for use with your target hardware
3386c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to
3387c609719bSwdenkLinux :-).
3388c609719bSwdenk
3389a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
3390c609719bSwdenk
3391c609719bSwdenkJust make sure your machine specific header file (for instance
3392c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board
33931dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h,
33941dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value
33956d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR.
3396c609719bSwdenk
3397c609719bSwdenk
3398c609719bSwdenkConfiguring the Linux kernel:
3399c609719bSwdenk-----------------------------
3400c609719bSwdenk
3401c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root
3402c609719bSwdenkdevice (initial ramdisk, NFS) for your target system.
3403c609719bSwdenk
3404c609719bSwdenk
3405c609719bSwdenkBuilding a Linux Image:
3406c609719bSwdenk-----------------------
3407c609719bSwdenk
340824ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are
340924ee89b9Swdenknot used. If you use recent kernel source, a new build target
341024ee89b9Swdenk"uImage" will exist which automatically builds an image usable by
341124ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target,
341224ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a
341324ee89b9Swdenk100% compatible format.
3414c609719bSwdenk
3415c609719bSwdenkExample:
3416c609719bSwdenk
3417c609719bSwdenk	make TQM850L_config
3418c609719bSwdenk	make oldconfig
3419c609719bSwdenk	make dep
342024ee89b9Swdenk	make uImage
3421c609719bSwdenk
342224ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to
342324ee89b9Swdenkencapsulate a compressed Linux kernel image with header	 information,
342424ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing:
3425c609719bSwdenk
342624ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format):
342724ee89b9Swdenk
342824ee89b9Swdenk* convert the kernel into a raw binary image:
342924ee89b9Swdenk
343024ee89b9Swdenk	${CROSS_COMPILE}-objcopy -O binary \
343124ee89b9Swdenk				 -R .note -R .comment \
343224ee89b9Swdenk				 -S vmlinux linux.bin
343324ee89b9Swdenk
343424ee89b9Swdenk* compress the binary image:
343524ee89b9Swdenk
343624ee89b9Swdenk	gzip -9 linux.bin
343724ee89b9Swdenk
343824ee89b9Swdenk* package compressed binary image for U-Boot:
343924ee89b9Swdenk
344024ee89b9Swdenk	mkimage -A ppc -O linux -T kernel -C gzip \
344124ee89b9Swdenk		-a 0 -e 0 -n "Linux Kernel Image" \
344224ee89b9Swdenk		-d linux.bin.gz uImage
344324ee89b9Swdenk
344424ee89b9Swdenk
344524ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use
344624ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or
344724ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64
344824ee89b9Swdenkbyte header containing information about target architecture,
344924ee89b9Swdenkoperating system, image type, compression method, entry points, time
345024ee89b9Swdenkstamp, CRC32 checksums, etc.
345124ee89b9Swdenk
345224ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and
345324ee89b9Swdenkprint the header information, or to build new images.
3454c609719bSwdenk
3455c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information
3456c609719bSwdenkcontained in the header of an existing U-Boot image; this includes
3457c609719bSwdenkchecksum verification:
3458c609719bSwdenk
3459c609719bSwdenk	tools/mkimage -l image
3460c609719bSwdenk	  -l ==> list image header information
3461c609719bSwdenk
3462c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image
3463c609719bSwdenkfrom a "data file" which is used as image payload:
3464c609719bSwdenk
3465c609719bSwdenk	tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
3466c609719bSwdenk		      -n name -d data_file image
3467c609719bSwdenk	  -A ==> set architecture to 'arch'
3468c609719bSwdenk	  -O ==> set operating system to 'os'
3469c609719bSwdenk	  -T ==> set image type to 'type'
3470c609719bSwdenk	  -C ==> set compression type 'comp'
3471c609719bSwdenk	  -a ==> set load address to 'addr' (hex)
3472c609719bSwdenk	  -e ==> set entry point to 'ep' (hex)
3473c609719bSwdenk	  -n ==> set image name to 'name'
3474c609719bSwdenk	  -d ==> use image data from 'datafile'
3475c609719bSwdenk
347669459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load
347769459791Swdenkaddress (0x00000000), but the entry point address depends on the
347869459791Swdenkkernel version:
3479c609719bSwdenk
3480c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C,
348124ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000.
3482c609719bSwdenk
3483c609719bSwdenkSo a typical call to build a U-Boot image would read:
3484c609719bSwdenk
348524ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
348624ee89b9Swdenk	> -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
3487a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
348824ee89b9Swdenk	> examples/uImage.TQM850L
348924ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
3490c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
3491c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
3492c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
3493c609719bSwdenk	Load Address: 0x00000000
349424ee89b9Swdenk	Entry Point:  0x00000000
3495c609719bSwdenk
3496c609719bSwdenkTo verify the contents of the image (or check for corruption):
3497c609719bSwdenk
349824ee89b9Swdenk	-> tools/mkimage -l examples/uImage.TQM850L
349924ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
3500c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
3501c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
3502c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
3503c609719bSwdenk	Load Address: 0x00000000
350424ee89b9Swdenk	Entry Point:  0x00000000
3505c609719bSwdenk
3506c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade
3507c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this
3508c609719bSwdenkneeds more space in Flash, but boots much faster since it does not
3509c609719bSwdenkneed to be uncompressed:
3510c609719bSwdenk
3511a47a12beSStefan Roese	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
351224ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
351324ee89b9Swdenk	> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
3514a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
351524ee89b9Swdenk	> examples/uImage.TQM850L-uncompressed
351624ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
3517c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
3518c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (uncompressed)
3519c609719bSwdenk	Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
3520c609719bSwdenk	Load Address: 0x00000000
352124ee89b9Swdenk	Entry Point:  0x00000000
3522c609719bSwdenk
3523c609719bSwdenk
3524c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file
3525c609719bSwdenkwhen your kernel is intended to use an initial ramdisk:
3526c609719bSwdenk
3527c609719bSwdenk	-> tools/mkimage -n 'Simple Ramdisk Image' \
3528c609719bSwdenk	> -A ppc -O linux -T ramdisk -C gzip \
3529c609719bSwdenk	> -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
3530c609719bSwdenk	Image Name:   Simple Ramdisk Image
3531c609719bSwdenk	Created:      Wed Jan 12 14:01:50 2000
3532c609719bSwdenk	Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
3533c609719bSwdenk	Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
3534c609719bSwdenk	Load Address: 0x00000000
3535c609719bSwdenk	Entry Point:  0x00000000
3536c609719bSwdenk
3537c609719bSwdenk
3538c609719bSwdenkInstalling a Linux Image:
3539c609719bSwdenk-------------------------
3540c609719bSwdenk
3541c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface,
3542c609719bSwdenkyou must convert the image to S-Record format:
3543c609719bSwdenk
3544c609719bSwdenk	objcopy -I binary -O srec examples/image examples/image.srec
3545c609719bSwdenk
3546c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot
3547c609719bSwdenkimage header, so the resulting S-Record file will be relative to
3548c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to
3549c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads'
3550c609719bSwdenkcommand.
3551c609719bSwdenk
3552c609719bSwdenkExample: install the image to address 0x40100000 (which on the
3553c609719bSwdenkTQM8xxL is in the first Flash bank):
3554c609719bSwdenk
3555c609719bSwdenk	=> erase 40100000 401FFFFF
3556c609719bSwdenk
3557c609719bSwdenk	.......... done
3558c609719bSwdenk	Erased 8 sectors
3559c609719bSwdenk
3560c609719bSwdenk	=> loads 40100000
3561c609719bSwdenk	## Ready for S-Record download ...
3562c609719bSwdenk	~>examples/image.srec
3563c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 12 13 ...
3564c609719bSwdenk	...
3565c609719bSwdenk	15989 15990 15991 15992
3566c609719bSwdenk	[file transfer complete]
3567c609719bSwdenk	[connected]
3568c609719bSwdenk	## Start Addr = 0x00000000
3569c609719bSwdenk
3570c609719bSwdenk
3571c609719bSwdenkYou can check the success of the download using the 'iminfo' command;
3572c609719bSwdenkthis includes a checksum verification so you can be sure no data
3573c609719bSwdenkcorruption happened:
3574c609719bSwdenk
3575c609719bSwdenk	=> imi 40100000
3576c609719bSwdenk
3577c609719bSwdenk	## Checking Image at 40100000 ...
3578c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
3579c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3580c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
3581c609719bSwdenk	   Load Address: 00000000
3582c609719bSwdenk	   Entry Point:	 0000000c
3583c609719bSwdenk	   Verifying Checksum ... OK
3584c609719bSwdenk
3585c609719bSwdenk
3586c609719bSwdenkBoot Linux:
3587c609719bSwdenk-----------
3588c609719bSwdenk
3589c609719bSwdenkThe "bootm" command is used to boot an application that is stored in
3590c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents
3591c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as
3592c609719bSwdenkparameters. You can check and modify this variable using the
3593c609719bSwdenk"printenv" and "setenv" commands:
3594c609719bSwdenk
3595c609719bSwdenk
3596c609719bSwdenk	=> printenv bootargs
3597c609719bSwdenk	bootargs=root=/dev/ram
3598c609719bSwdenk
3599c609719bSwdenk	=> setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3600c609719bSwdenk
3601c609719bSwdenk	=> printenv bootargs
3602c609719bSwdenk	bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3603c609719bSwdenk
3604c609719bSwdenk	=> bootm 40020000
3605c609719bSwdenk	## Booting Linux kernel at 40020000 ...
3606c609719bSwdenk	   Image Name:	 2.2.13 for NFS on TQM850L
3607c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3608c609719bSwdenk	   Data Size:	 381681 Bytes = 372 kB = 0 MB
3609c609719bSwdenk	   Load Address: 00000000
3610c609719bSwdenk	   Entry Point:	 0000000c
3611c609719bSwdenk	   Verifying Checksum ... OK
3612c609719bSwdenk	   Uncompressing Kernel Image ... OK
3613c609719bSwdenk	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
3614c609719bSwdenk	Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3615c609719bSwdenk	time_init: decrementer frequency = 187500000/60
3616c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
3617c609719bSwdenk	Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
3618c609719bSwdenk	...
3619c609719bSwdenk
362011ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass
36217152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT
3622c609719bSwdenkformat!) to the "bootm" command:
3623c609719bSwdenk
3624c609719bSwdenk	=> imi 40100000 40200000
3625c609719bSwdenk
3626c609719bSwdenk	## Checking Image at 40100000 ...
3627c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
3628c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3629c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
3630c609719bSwdenk	   Load Address: 00000000
3631c609719bSwdenk	   Entry Point:	 0000000c
3632c609719bSwdenk	   Verifying Checksum ... OK
3633c609719bSwdenk
3634c609719bSwdenk	## Checking Image at 40200000 ...
3635c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
3636c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
3637c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
3638c609719bSwdenk	   Load Address: 00000000
3639c609719bSwdenk	   Entry Point:	 00000000
3640c609719bSwdenk	   Verifying Checksum ... OK
3641c609719bSwdenk
3642c609719bSwdenk	=> bootm 40100000 40200000
3643c609719bSwdenk	## Booting Linux kernel at 40100000 ...
3644c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
3645c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3646c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
3647c609719bSwdenk	   Load Address: 00000000
3648c609719bSwdenk	   Entry Point:	 0000000c
3649c609719bSwdenk	   Verifying Checksum ... OK
3650c609719bSwdenk	   Uncompressing Kernel Image ... OK
3651c609719bSwdenk	## Loading RAMDisk Image at 40200000 ...
3652c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
3653c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
3654c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
3655c609719bSwdenk	   Load Address: 00000000
3656c609719bSwdenk	   Entry Point:	 00000000
3657c609719bSwdenk	   Verifying Checksum ... OK
3658c609719bSwdenk	   Loading Ramdisk ... OK
3659c609719bSwdenk	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
3660c609719bSwdenk	Boot arguments: root=/dev/ram
3661c609719bSwdenk	time_init: decrementer frequency = 187500000/60
3662c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
3663c609719bSwdenk	...
3664c609719bSwdenk	RAMDISK: Compressed image found at block 0
3665c609719bSwdenk	VFS: Mounted root (ext2 filesystem).
3666c609719bSwdenk
3667c609719bSwdenk	bash#
3668c609719bSwdenk
36690267768eSMatthew McClintockBoot Linux and pass a flat device tree:
36700267768eSMatthew McClintock-----------
36710267768eSMatthew McClintock
36720267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section
36730267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The
36740267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated
36750267768eSMatthew McClintockflat device tree:
36760267768eSMatthew McClintock
36770267768eSMatthew McClintock=> print oftaddr
36780267768eSMatthew McClintockoftaddr=0x300000
36790267768eSMatthew McClintock=> print oft
36800267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb
36810267768eSMatthew McClintock=> tftp $oftaddr $oft
36820267768eSMatthew McClintockSpeed: 1000, full duplex
36830267768eSMatthew McClintockUsing TSEC0 device
36840267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101
36850267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'.
36860267768eSMatthew McClintockLoad address: 0x300000
36870267768eSMatthew McClintockLoading: #
36880267768eSMatthew McClintockdone
36890267768eSMatthew McClintockBytes transferred = 4106 (100a hex)
36900267768eSMatthew McClintock=> tftp $loadaddr $bootfile
36910267768eSMatthew McClintockSpeed: 1000, full duplex
36920267768eSMatthew McClintockUsing TSEC0 device
36930267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2
36940267768eSMatthew McClintockFilename 'uImage'.
36950267768eSMatthew McClintockLoad address: 0x200000
36960267768eSMatthew McClintockLoading:############
36970267768eSMatthew McClintockdone
36980267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex)
36990267768eSMatthew McClintock=> print loadaddr
37000267768eSMatthew McClintockloadaddr=200000
37010267768eSMatthew McClintock=> print oftaddr
37020267768eSMatthew McClintockoftaddr=0x300000
37030267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr
37040267768eSMatthew McClintock## Booting image at 00200000 ...
37050267768eSMatthew McClintock   Image Name:	 Linux-2.6.17-dirty
37060267768eSMatthew McClintock   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
37070267768eSMatthew McClintock   Data Size:	 1029343 Bytes = 1005.2 kB
37080267768eSMatthew McClintock   Load Address: 00000000
37090267768eSMatthew McClintock   Entry Point:	 00000000
37100267768eSMatthew McClintock   Verifying Checksum ... OK
37110267768eSMatthew McClintock   Uncompressing Kernel Image ... OK
37120267768eSMatthew McClintockBooting using flat device tree at 0x300000
37130267768eSMatthew McClintockUsing MPC85xx ADS machine description
37140267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
37150267768eSMatthew McClintock[snip]
37160267768eSMatthew McClintock
37170267768eSMatthew McClintock
37186069ff26SwdenkMore About U-Boot Image Types:
37196069ff26Swdenk------------------------------
37206069ff26Swdenk
37216069ff26SwdenkU-Boot supports the following image types:
37226069ff26Swdenk
37236069ff26Swdenk   "Standalone Programs" are directly runnable in the environment
37246069ff26Swdenk	provided by U-Boot; it is expected that (if they behave
37256069ff26Swdenk	well) you can continue to work in U-Boot after return from
37266069ff26Swdenk	the Standalone Program.
37276069ff26Swdenk   "OS Kernel Images" are usually images of some Embedded OS which
37286069ff26Swdenk	will take over control completely. Usually these programs
37296069ff26Swdenk	will install their own set of exception handlers, device
37306069ff26Swdenk	drivers, set up the MMU, etc. - this means, that you cannot
37316069ff26Swdenk	expect to re-enter U-Boot except by resetting the CPU.
37326069ff26Swdenk   "RAMDisk Images" are more or less just data blocks, and their
37336069ff26Swdenk	parameters (address, size) are passed to an OS kernel that is
37346069ff26Swdenk	being started.
37356069ff26Swdenk   "Multi-File Images" contain several images, typically an OS
37366069ff26Swdenk	(Linux) kernel image and one or more data images like
37376069ff26Swdenk	RAMDisks. This construct is useful for instance when you want
37386069ff26Swdenk	to boot over the network using BOOTP etc., where the boot
37396069ff26Swdenk	server provides just a single image file, but you want to get
37406069ff26Swdenk	for instance an OS kernel and a RAMDisk image.
37416069ff26Swdenk
37426069ff26Swdenk	"Multi-File Images" start with a list of image sizes, each
37436069ff26Swdenk	image size (in bytes) specified by an "uint32_t" in network
37446069ff26Swdenk	byte order. This list is terminated by an "(uint32_t)0".
37456069ff26Swdenk	Immediately after the terminating 0 follow the images, one by
37466069ff26Swdenk	one, all aligned on "uint32_t" boundaries (size rounded up to
37476069ff26Swdenk	a multiple of 4 bytes).
37486069ff26Swdenk
37496069ff26Swdenk   "Firmware Images" are binary images containing firmware (like
37506069ff26Swdenk	U-Boot or FPGA images) which usually will be programmed to
37516069ff26Swdenk	flash memory.
37526069ff26Swdenk
37536069ff26Swdenk   "Script files" are command sequences that will be executed by
37546069ff26Swdenk	U-Boot's command interpreter; this feature is especially
37556069ff26Swdenk	useful when you configure U-Boot to use a real shell (hush)
37566069ff26Swdenk	as command interpreter.
37576069ff26Swdenk
3758c609719bSwdenk
3759c609719bSwdenkStandalone HOWTO:
3760c609719bSwdenk=================
3761c609719bSwdenk
3762c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and
3763c609719bSwdenkrun "standalone" applications, which can use some resources of
3764c609719bSwdenkU-Boot like console I/O functions or interrupt services.
3765c609719bSwdenk
3766c609719bSwdenkTwo simple examples are included with the sources:
3767c609719bSwdenk
3768c609719bSwdenk"Hello World" Demo:
3769c609719bSwdenk-------------------
3770c609719bSwdenk
3771c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo
3772c609719bSwdenkapplication; it is automatically compiled when you build U-Boot.
3773c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it
3774c609719bSwdenklike that:
3775c609719bSwdenk
3776c609719bSwdenk	=> loads
3777c609719bSwdenk	## Ready for S-Record download ...
3778c609719bSwdenk	~>examples/hello_world.srec
3779c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
3780c609719bSwdenk	[file transfer complete]
3781c609719bSwdenk	[connected]
3782c609719bSwdenk	## Start Addr = 0x00040004
3783c609719bSwdenk
3784c609719bSwdenk	=> go 40004 Hello World! This is a test.
3785c609719bSwdenk	## Starting application at 0x00040004 ...
3786c609719bSwdenk	Hello World
3787c609719bSwdenk	argc = 7
3788c609719bSwdenk	argv[0] = "40004"
3789c609719bSwdenk	argv[1] = "Hello"
3790c609719bSwdenk	argv[2] = "World!"
3791c609719bSwdenk	argv[3] = "This"
3792c609719bSwdenk	argv[4] = "is"
3793c609719bSwdenk	argv[5] = "a"
3794c609719bSwdenk	argv[6] = "test."
3795c609719bSwdenk	argv[7] = "<NULL>"
3796c609719bSwdenk	Hit any key to exit ...
3797c609719bSwdenk
3798c609719bSwdenk	## Application terminated, rc = 0x0
3799c609719bSwdenk
3800c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt
3801c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'.
3802c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second.
3803c609719bSwdenkThe interrupt service routine is trivial, just printing a '.'
3804c609719bSwdenkcharacter, but this is just a demo program. The application can be
3805c609719bSwdenkcontrolled by the following keys:
3806c609719bSwdenk
3807c609719bSwdenk	? - print current values og the CPM Timer registers
3808c609719bSwdenk	b - enable interrupts and start timer
3809c609719bSwdenk	e - stop timer and disable interrupts
3810c609719bSwdenk	q - quit application
3811c609719bSwdenk
3812c609719bSwdenk	=> loads
3813c609719bSwdenk	## Ready for S-Record download ...
3814c609719bSwdenk	~>examples/timer.srec
3815c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
3816c609719bSwdenk	[file transfer complete]
3817c609719bSwdenk	[connected]
3818c609719bSwdenk	## Start Addr = 0x00040004
3819c609719bSwdenk
3820c609719bSwdenk	=> go 40004
3821c609719bSwdenk	## Starting application at 0x00040004 ...
3822c609719bSwdenk	TIMERS=0xfff00980
3823c609719bSwdenk	Using timer 1
3824c609719bSwdenk	  tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
3825c609719bSwdenk
3826c609719bSwdenkHit 'b':
3827c609719bSwdenk	[q, b, e, ?] Set interval 1000000 us
3828c609719bSwdenk	Enabling timer
3829c609719bSwdenkHit '?':
3830c609719bSwdenk	[q, b, e, ?] ........
3831c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
3832c609719bSwdenkHit '?':
3833c609719bSwdenk	[q, b, e, ?] .
3834c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
3835c609719bSwdenkHit '?':
3836c609719bSwdenk	[q, b, e, ?] .
3837c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
3838c609719bSwdenkHit '?':
3839c609719bSwdenk	[q, b, e, ?] .
3840c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
3841c609719bSwdenkHit 'e':
3842c609719bSwdenk	[q, b, e, ?] ...Stopping timer
3843c609719bSwdenkHit 'q':
3844c609719bSwdenk	[q, b, e, ?] ## Application terminated, rc = 0x0
3845c609719bSwdenk
3846c609719bSwdenk
384785ec0bccSwdenkMinicom warning:
384885ec0bccSwdenk================
384985ec0bccSwdenk
38507152b1d0SwdenkOver time, many people have reported problems when trying to use the
385185ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd)
385285ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under
3853f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and
385485ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and
385585ec0bccSwdenkuse "cu" for S-Record download ("loads" command).
385685ec0bccSwdenk
385752f52c14SwdenkNevertheless, if you absolutely want to use it try adding this
385852f52c14Swdenkconfiguration to your "File transfer protocols" section:
385952f52c14Swdenk
386052f52c14Swdenk	   Name	   Program			Name U/D FullScr IO-Red. Multi
386152f52c14Swdenk	X  kermit  /usr/bin/kermit -i -l %l -s	 Y    U	   Y	   N	  N
386252f52c14Swdenk	Y  kermit  /usr/bin/kermit -i -l %l -r	 N    D	   Y	   N	  N
386352f52c14Swdenk
386452f52c14Swdenk
3865c609719bSwdenkNetBSD Notes:
3866c609719bSwdenk=============
3867c609719bSwdenk
3868c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host
3869c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx).
3870c609719bSwdenk
3871c609719bSwdenkBuilding requires a cross environment; it is known to work on
3872c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
3873c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make).
3874c609719bSwdenkNote that the cross-powerpc package does not install include files;
3875c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is
3876c609719bSwdenkmissing.  This file has to be installed and patched manually:
3877c609719bSwdenk
3878c609719bSwdenk	# cd /usr/pkg/cross/powerpc-netbsd/include
3879c609719bSwdenk	# mkdir powerpc
3880c609719bSwdenk	# ln -s powerpc machine
3881c609719bSwdenk	# cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
3882c609719bSwdenk	# ${EDIT} powerpc/ansi.h	## must remove __va_list, _BSD_VA_LIST
3883c609719bSwdenk
3884c609719bSwdenkNative builds *don't* work due to incompatibilities between native
3885c609719bSwdenkand U-Boot include files.
3886c609719bSwdenk
3887c609719bSwdenkBooting assumes that (the first part of) the image booted is a
3888c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel
3889c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source
3890c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
38912a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
3892c609719bSwdenk
3893c609719bSwdenk
3894c609719bSwdenkImplementation Internals:
3895c609719bSwdenk=========================
3896c609719bSwdenk
3897c609719bSwdenkThe following is not intended to be a complete description of every
3898c609719bSwdenkimplementation detail. However, it should help to understand the
3899c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom
3900c609719bSwdenkhardware.
3901c609719bSwdenk
3902c609719bSwdenk
3903c609719bSwdenkInitial Stack, Global Data:
3904c609719bSwdenk---------------------------
3905c609719bSwdenk
3906c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot
3907c609719bSwdenkstarts running out of ROM (flash memory), usually without access to
3908c609719bSwdenksystem RAM (because the memory controller is not initialized yet).
3909c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS
3910c609719bSwdenkis not initialized as zero. To be able to get a C environment working
3911c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation
3912c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU
3913c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and
3914c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be
3915c609719bSwdenklocked as (mis-) used as memory, etc.
3916c609719bSwdenk
39177152b1d0Swdenk	Chris Hallinan posted a good summary of these issues to the
39180668236bSWolfgang Denk	U-Boot mailing list:
391943d9616cSwdenk
392043d9616cSwdenk	Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
392143d9616cSwdenk	From: "Chris Hallinan" <clh@net1plus.com>
392243d9616cSwdenk	Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
392343d9616cSwdenk	...
392443d9616cSwdenk
392543d9616cSwdenk	Correct me if I'm wrong, folks, but the way I understand it
392643d9616cSwdenk	is this: Using DCACHE as initial RAM for Stack, etc, does not
392743d9616cSwdenk	require any physical RAM backing up the cache. The cleverness
392843d9616cSwdenk	is that the cache is being used as a temporary supply of
392943d9616cSwdenk	necessary storage before the SDRAM controller is setup. It's
393011ccc33fSMarcel Ziswiler	beyond the scope of this list to explain the details, but you
393143d9616cSwdenk	can see how this works by studying the cache architecture and
393243d9616cSwdenk	operation in the architecture and processor-specific manuals.
393343d9616cSwdenk
393443d9616cSwdenk	OCM is On Chip Memory, which I believe the 405GP has 4K. It
393543d9616cSwdenk	is another option for the system designer to use as an
393611ccc33fSMarcel Ziswiler	initial stack/RAM area prior to SDRAM being available. Either
393743d9616cSwdenk	option should work for you. Using CS 4 should be fine if your
393843d9616cSwdenk	board designers haven't used it for something that would
393943d9616cSwdenk	cause you grief during the initial boot! It is frequently not
394043d9616cSwdenk	used.
394143d9616cSwdenk
39426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
394343d9616cSwdenk	with your processor/board/system design. The default value
394443d9616cSwdenk	you will find in any recent u-boot distribution in
39458a316c9bSStefan Roese	walnut.h should work for you. I'd set it to a value larger
394643d9616cSwdenk	than your SDRAM module. If you have a 64MB SDRAM module, set
394743d9616cSwdenk	it above 400_0000. Just make sure your board has no resources
394843d9616cSwdenk	that are supposed to respond to that address! That code in
394943d9616cSwdenk	start.S has been around a while and should work as is when
395043d9616cSwdenk	you get the config right.
395143d9616cSwdenk
395243d9616cSwdenk	-Chris Hallinan
395343d9616cSwdenk	DS4.COM, Inc.
395443d9616cSwdenk
3955c609719bSwdenkIt is essential to remember this, since it has some impact on the C
3956c609719bSwdenkcode for the initialization procedures:
3957c609719bSwdenk
3958c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt
3959c609719bSwdenk  to write it.
3960c609719bSwdenk
396111ccc33fSMarcel Ziswiler* Do not use any uninitialized global data (or implicitely initialized
3962c609719bSwdenk  as zero data - BSS segment) at all - this is undefined, initiali-
39637152b1d0Swdenk  zation is performed later (when relocating to RAM).
3964c609719bSwdenk
3965c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like
3966c609719bSwdenk  that.
3967c609719bSwdenk
3968c609719bSwdenkHaving only the stack as writable memory limits means we cannot use
3969c609719bSwdenknormal global data to share information beween the code. But it
3970c609719bSwdenkturned out that the implementation of U-Boot can be greatly
3971c609719bSwdenksimplified by making a global data structure (gd_t) available to all
3972c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_
3973c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of
3974c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we
3975c609719bSwdenkplace a pointer (gd) to the global data into a register which we
3976c609719bSwdenkreserve for this purpose.
3977c609719bSwdenk
39787152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the
3979c609719bSwdenkrelevant  (E)ABI  specifications for the current architecture, and by
3980c609719bSwdenkGCC's implementation.
3981c609719bSwdenk
3982c609719bSwdenkFor PowerPC, the following registers have specific use:
3983c609719bSwdenk	R1:	stack pointer
3984e7670f6cSWolfgang Denk	R2:	reserved for system use
3985c609719bSwdenk	R3-R4:	parameter passing and return values
3986c609719bSwdenk	R5-R10: parameter passing
3987c609719bSwdenk	R13:	small data area pointer
3988c609719bSwdenk	R30:	GOT pointer
3989c609719bSwdenk	R31:	frame pointer
3990c609719bSwdenk
3991e6bee808SJoakim Tjernlund	(U-Boot also uses R12 as internal GOT pointer. r12
3992e6bee808SJoakim Tjernlund	is a volatile register so r12 needs to be reset when
3993e6bee808SJoakim Tjernlund	going back and forth between asm and C)
3994c609719bSwdenk
3995e7670f6cSWolfgang Denk    ==> U-Boot will use R2 to hold a pointer to the global data
3996c609719bSwdenk
3997c609719bSwdenk    Note: on PPC, we could use a static initializer (since the
3998c609719bSwdenk    address of the global data structure is known at compile time),
3999c609719bSwdenk    but it turned out that reserving a register results in somewhat
4000c609719bSwdenk    smaller code - although the code savings are not that big (on
4001c609719bSwdenk    average for all boards 752 bytes for the whole U-Boot image,
4002c609719bSwdenk    624 text + 127 data).
4003c609719bSwdenk
4004c4db335cSRobin GetzOn Blackfin, the normal C ABI (except for P3) is followed as documented here:
40054c58eb55SMike Frysinger	http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
40064c58eb55SMike Frysinger
4007c4db335cSRobin Getz    ==> U-Boot will use P3 to hold a pointer to the global data
40084c58eb55SMike Frysinger
4009c609719bSwdenkOn ARM, the following registers are used:
4010c609719bSwdenk
4011c609719bSwdenk	R0:	function argument word/integer result
4012c609719bSwdenk	R1-R3:	function argument word
4013c609719bSwdenk	R9:	GOT pointer
4014c609719bSwdenk	R10:	stack limit (used only if stack checking if enabled)
4015c609719bSwdenk	R11:	argument (frame) pointer
4016c609719bSwdenk	R12:	temporary workspace
4017c609719bSwdenk	R13:	stack pointer
4018c609719bSwdenk	R14:	link register
4019c609719bSwdenk	R15:	program counter
4020c609719bSwdenk
4021c609719bSwdenk    ==> U-Boot will use R8 to hold a pointer to the global data
4022c609719bSwdenk
40230df01fd3SThomas ChouOn Nios II, the ABI is documented here:
40240df01fd3SThomas Chou	http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
40250df01fd3SThomas Chou
40260df01fd3SThomas Chou    ==> U-Boot will use gp to hold a pointer to the global data
40270df01fd3SThomas Chou
40280df01fd3SThomas Chou    Note: on Nios II, we give "-G0" option to gcc and don't use gp
40290df01fd3SThomas Chou    to access small data sections, so gp is free.
40300df01fd3SThomas Chou
4031d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
4032d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much.
4033c609719bSwdenk
4034c609719bSwdenkMemory Management:
4035c609719bSwdenk------------------
4036c609719bSwdenk
4037c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the
4038c609719bSwdenkMMU is not used either for address mapping nor for memory protection.
4039c609719bSwdenk
4040c609719bSwdenkThe available memory is mapped to fixed addresses using the memory
4041c609719bSwdenkcontroller. In this process, a contiguous block is formed for each
4042c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several
4043c609719bSwdenkphysical memory banks.
4044c609719bSwdenk
4045c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on
4046c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
4047c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself
4048c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some
40496d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
4050c609719bSwdenkconfiguration setting]. Below that, a structure with global Board
4051c609719bSwdenkInfo data is placed, followed by the stack (growing downward).
4052c609719bSwdenk
4053c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB
4054c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF).
4055c609719bSwdenk
4056c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like
4057c609719bSwdenkthis:
4058c609719bSwdenk
4059c609719bSwdenk	0x0000 0000	Exception Vector code
4060c609719bSwdenk	      :
4061c609719bSwdenk	0x0000 1FFF
4062c609719bSwdenk	0x0000 2000	Free for Application Use
4063c609719bSwdenk	      :
4064c609719bSwdenk	      :
4065c609719bSwdenk
4066c609719bSwdenk	      :
4067c609719bSwdenk	      :
4068c609719bSwdenk	0x00FB FF20	Monitor Stack (Growing downward)
4069c609719bSwdenk	0x00FB FFAC	Board Info Data and permanent copy of global data
4070c609719bSwdenk	0x00FC 0000	Malloc Arena
4071c609719bSwdenk	      :
4072c609719bSwdenk	0x00FD FFFF
4073c609719bSwdenk	0x00FE 0000	RAM Copy of Monitor Code
4074c609719bSwdenk	...		eventually: LCD or video framebuffer
4075c609719bSwdenk	...		eventually: pRAM (Protected RAM - unchanged by reset)
4076c609719bSwdenk	0x00FF FFFF	[End of RAM]
4077c609719bSwdenk
4078c609719bSwdenk
4079c609719bSwdenkSystem Initialization:
4080c609719bSwdenk----------------------
4081c609719bSwdenk
4082c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point
408311ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset
4084c609719bSwdenkconfiguration for CS0# this is a mirror of the onboard Flash memory.
40857152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address.
4086c609719bSwdenkTo be able to implement the initialization code in C, a (small!)
4087c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs
4088c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked
4089c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core,
4090c609719bSwdenkthe caches and the SIU.
4091c609719bSwdenk
4092c609719bSwdenkNext, all (potentially) available memory banks are mapped using a
4093c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries
4094c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
4095c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
4096c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a
4097c609719bSwdenksimple memory test is run that determines the size of the SDRAM
4098c609719bSwdenkbanks.
4099c609719bSwdenk
4100c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of
41017152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first
4102c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address
4103c609719bSwdenk0x00000000, with any additional banks following immediately to create
4104c609719bSwdenkcontiguous memory starting from 0.
4105c609719bSwdenk
4106c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area
4107c609719bSwdenkand allocates memory for use by malloc() and for the global Board
4108c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM
4109c609719bSwdenkpages, and the final stack is set up.
4110c609719bSwdenk
4111c609719bSwdenkOnly after this relocation will you have a "normal" C environment;
4112c609719bSwdenkuntil that you are restricted in several ways, mostly because you are
4113c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a
4114c609719bSwdenknew address in RAM.
4115c609719bSwdenk
4116c609719bSwdenk
4117c609719bSwdenkU-Boot Porting Guide:
4118c609719bSwdenk----------------------
4119c609719bSwdenk
4120c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
41216aff3115Swdenklist, October 2002]
4122c609719bSwdenk
4123c609719bSwdenk
4124c609719bSwdenkint main(int argc, char *argv[])
4125c609719bSwdenk{
4126c609719bSwdenk	sighandler_t no_more_time;
4127c609719bSwdenk
4128c609719bSwdenk	signal(SIGALRM, no_more_time);
4129c609719bSwdenk	alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
4130c609719bSwdenk
4131c609719bSwdenk	if (available_money > available_manpower) {
41326c3fef28SJerry Van Baren		Pay consultant to port U-Boot;
4133c609719bSwdenk		return 0;
4134c609719bSwdenk	}
4135c609719bSwdenk
4136c609719bSwdenk	Download latest U-Boot source;
4137c609719bSwdenk
41380668236bSWolfgang Denk	Subscribe to u-boot mailing list;
41396aff3115Swdenk
41406c3fef28SJerry Van Baren	if (clueless)
4141c609719bSwdenk		email("Hi, I am new to U-Boot, how do I get started?");
4142c609719bSwdenk
4143c609719bSwdenk	while (learning) {
4144c609719bSwdenk		Read the README file in the top level directory;
41457cb22f97Swdenk		Read http://www.denx.de/twiki/bin/view/DULG/Manual;
41466c3fef28SJerry Van Baren		Read applicable doc/*.README;
4147c609719bSwdenk		Read the source, Luke;
41486c3fef28SJerry Van Baren		/* find . -name "*.[chS]" | xargs grep -i <keyword> */
4149c609719bSwdenk	}
4150c609719bSwdenk
41516c3fef28SJerry Van Baren	if (available_money > toLocalCurrency ($2500))
41526c3fef28SJerry Van Baren		Buy a BDI3000;
41536c3fef28SJerry Van Baren	else
4154c609719bSwdenk		Add a lot of aggravation and time;
4155c609719bSwdenk
41566c3fef28SJerry Van Baren	if (a similar board exists) {	/* hopefully... */
41576c3fef28SJerry Van Baren		cp -a board/<similar> board/<myboard>
41586c3fef28SJerry Van Baren		cp include/configs/<similar>.h include/configs/<myboard>.h
41596c3fef28SJerry Van Baren	} else {
4160c609719bSwdenk		Create your own board support subdirectory;
41616c3fef28SJerry Van Baren		Create your own board include/configs/<myboard>.h file;
41626c3fef28SJerry Van Baren	}
41636c3fef28SJerry Van Baren	Edit new board/<myboard> files
41646c3fef28SJerry Van Baren	Edit new include/configs/<myboard>.h
4165c609719bSwdenk
41666c3fef28SJerry Van Baren	while (!accepted) {
4167c609719bSwdenk		while (!running) {
4168c609719bSwdenk			do {
4169c609719bSwdenk				Add / modify source code;
4170c609719bSwdenk			} until (compiles);
4171c609719bSwdenk			Debug;
4172c609719bSwdenk			if (clueless)
4173c609719bSwdenk				email("Hi, I am having problems...");
4174c609719bSwdenk		}
41756c3fef28SJerry Van Baren		Send patch file to the U-Boot email list;
41766c3fef28SJerry Van Baren		if (reasonable critiques)
41776c3fef28SJerry Van Baren			Incorporate improvements from email list code review;
41786c3fef28SJerry Van Baren		else
41796c3fef28SJerry Van Baren			Defend code as written;
41806c3fef28SJerry Van Baren	}
4181c609719bSwdenk
4182c609719bSwdenk	return 0;
4183c609719bSwdenk}
4184c609719bSwdenk
4185c609719bSwdenkvoid no_more_time (int sig)
4186c609719bSwdenk{
4187c609719bSwdenk      hire_a_guru();
4188c609719bSwdenk}
4189c609719bSwdenk
4190c609719bSwdenk
4191c609719bSwdenkCoding Standards:
4192c609719bSwdenk-----------------
4193c609719bSwdenk
4194c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel
41952c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script
41962c051651SDetlev Zundel"scripts/Lindent" in your Linux kernel source directory.  In sources
41972c051651SDetlev Zundeloriginating from U-Boot a style corresponding to "Lindent -pcs" (adding
41982c051651SDetlev Zundelspaces before parameters to function calls) is actually used.
4199c609719bSwdenk
42002c051651SDetlev ZundelSource files originating from a different project (for example the
42012c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not
42022c051651SDetlev Zundelreformated to ease subsequent migration to newer versions of those
42032c051651SDetlev Zundelsources.
42042c051651SDetlev Zundel
42052c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in
42062c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//)
42072c051651SDetlev Zundelin your code.
4208c609719bSwdenk
4209c178d3daSwdenkPlease also stick to the following formatting rules:
4210180d3f74Swdenk- remove any trailing white space
4211180d3f74Swdenk- use TAB characters for indentation, not spaces
4212180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds
4213180d3f74Swdenk- do not add more than 2 empty lines to source files
4214180d3f74Swdenk- do not add trailing empty lines to source files
4215180d3f74Swdenk
4216c609719bSwdenkSubmissions which do not conform to the standards may be returned
4217c609719bSwdenkwith a request to reformat the changes.
4218c609719bSwdenk
4219c609719bSwdenk
4220c609719bSwdenkSubmitting Patches:
4221c609719bSwdenk-------------------
4222c609719bSwdenk
4223c609719bSwdenkSince the number of patches for U-Boot is growing, we need to
4224c609719bSwdenkestablish some rules. Submissions which do not conform to these rules
4225c609719bSwdenkmay be rejected, even when they contain important and valuable stuff.
4226c609719bSwdenk
42270d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details.
4228218ca724SWolfgang Denk
42290668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
42300668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot
42310668236bSWolfgang Denk
4232c609719bSwdenkWhen you send a patch, please include the following information with
4233c609719bSwdenkit:
4234c609719bSwdenk
4235c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes
4236c609719bSwdenk  this bug. Please try to include a way of demonstrating that the
4237c609719bSwdenk  patch actually fixes something.
4238c609719bSwdenk
4239c609719bSwdenk* For new features: a description of the feature and your
4240c609719bSwdenk  implementation.
4241c609719bSwdenk
4242c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch)
4243c609719bSwdenk
4244c609719bSwdenk* For major contributions, your entry to the CREDITS file
4245c609719bSwdenk
4246c609719bSwdenk* When you add support for a new board, don't forget to add this
4247c609719bSwdenk  board to the MAKEALL script, too.
4248c609719bSwdenk
4249c609719bSwdenk* If your patch adds new configuration options, don't forget to
4250c609719bSwdenk  document these in the README file.
4251c609719bSwdenk
4252218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly*
4253218ca724SWolfgang Denk  recommended) you can easily generate the patch using the
4254218ca724SWolfgang Denk  "git-format-patch". If you then use "git-send-email" to send it to
4255218ca724SWolfgang Denk  the U-Boot mailing list, you will avoid most of the common problems
4256218ca724SWolfgang Denk  with some other mail clients.
4257c609719bSwdenk
4258218ca724SWolfgang Denk  If you cannot use git, use "diff -purN OLD NEW". If your version of
4259218ca724SWolfgang Denk  diff does not support these options, then get the latest version of
4260218ca724SWolfgang Denk  GNU diff.
42616dff5529Swdenk
4262218ca724SWolfgang Denk  The current directory when running this command shall be the parent
4263218ca724SWolfgang Denk  directory of the U-Boot source tree (i. e. please make sure that
4264218ca724SWolfgang Denk  your patch includes sufficient directory information for the
4265218ca724SWolfgang Denk  affected files).
4266218ca724SWolfgang Denk
4267218ca724SWolfgang Denk  We prefer patches as plain text. MIME attachments are discouraged,
4268218ca724SWolfgang Denk  and compressed attachments must not be used.
4269c609719bSwdenk
427052f52c14Swdenk* If one logical set of modifications affects or creates several
427152f52c14Swdenk  files, all these changes shall be submitted in a SINGLE patch file.
427252f52c14Swdenk
427352f52c14Swdenk* Changesets that contain different, unrelated modifications shall be
427452f52c14Swdenk  submitted as SEPARATE patches, one patch per changeset.
427552f52c14Swdenk
427652f52c14Swdenk
4277c609719bSwdenkNotes:
4278c609719bSwdenk
4279c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched
4280c609719bSwdenk  source tree and make sure that no errors or warnings are reported
4281c609719bSwdenk  for any of the boards.
4282c609719bSwdenk
4283c609719bSwdenk* Keep your modifications to the necessary minimum: A patch
4284c609719bSwdenk  containing several unrelated changes or arbitrary reformats will be
4285c609719bSwdenk  returned with a request to re-formatting / split it.
4286c609719bSwdenk
4287c609719bSwdenk* If you modify existing code, make sure that your new code does not
4288c609719bSwdenk  add to the memory footprint of the code ;-) Small is beautiful!
4289c609719bSwdenk  When adding new features, these should compile conditionally only
4290c609719bSwdenk  (using #ifdef), and the resulting code with the new feature
4291c609719bSwdenk  disabled must not need more memory than the old code without your
4292c609719bSwdenk  modification.
429390dc6704Swdenk
42940668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the
42950668236bSWolfgang Denk  u-boot mailing list. Bigger patches will be moderated. If they are
42960668236bSWolfgang Denk  reasonable and not too big, they will be acknowledged. But patches
42970668236bSWolfgang Denk  bigger than the size limit should be avoided.
4298