xref: /openbmc/u-boot/README (revision a47a12becf66f02a56da91c161e2edb625e9f20c)
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  /nios			Files generic to Altera NIOS architecture
1818d321b81SPeter Tyser    /cpu		CPU specific files
1828d321b81SPeter Tyser    /lib		Architecture specific library files
1838d321b81SPeter Tyser  /nios2		Files generic to Altera NIOS2 architecture
1848d321b81SPeter Tyser    /cpu		CPU specific files
1858d321b81SPeter Tyser    /lib		Architecture specific library files
186*a47a12beSStefan Roese  /powerpc		Files generic to PowerPC architecture
1878d321b81SPeter Tyser    /cpu		CPU specific files
1888d321b81SPeter Tyser      /74xx_7xx		Files specific to Freescale MPC74xx and 7xx CPUs
1898d321b81SPeter Tyser      /mpc5xx		Files specific to Freescale MPC5xx CPUs
1908d321b81SPeter Tyser      /mpc5xxx		Files specific to Freescale MPC5xxx CPUs
1918d321b81SPeter Tyser      /mpc8xx		Files specific to Freescale MPC8xx CPUs
1928d321b81SPeter Tyser      /mpc8220		Files specific to Freescale MPC8220 CPUs
1938d321b81SPeter Tyser      /mpc824x		Files specific to Freescale MPC824x CPUs
1948d321b81SPeter Tyser      /mpc8260		Files specific to Freescale MPC8260 CPUs
1958d321b81SPeter Tyser      /mpc85xx		Files specific to Freescale MPC85xx CPUs
1968d321b81SPeter Tyser      /ppc4xx		Files specific to AMCC PowerPC 4xx CPUs
1978d321b81SPeter Tyser    /lib		Architecture specific library files
1988d321b81SPeter Tyser  /sh			Files generic to SH architecture
1998d321b81SPeter Tyser    /cpu		CPU specific files
2008d321b81SPeter Tyser      /sh2		Files specific to sh2 CPUs
2018d321b81SPeter Tyser      /sh3		Files specific to sh3 CPUs
2028d321b81SPeter Tyser      /sh4		Files specific to sh4 CPUs
2038d321b81SPeter Tyser    /lib		Architecture specific library files
2048d321b81SPeter Tyser  /sparc		Files generic to SPARC architecture
2058d321b81SPeter Tyser    /cpu		CPU specific files
2068d321b81SPeter Tyser      /leon2		Files specific to Gaisler LEON2 SPARC CPU
2078d321b81SPeter Tyser      /leon3		Files specific to Gaisler LEON3 SPARC CPU
2088d321b81SPeter Tyser    /lib		Architecture specific library files
2098d321b81SPeter Tyser/api			Machine/arch independent API for external apps
2108d321b81SPeter Tyser/board			Board dependent files
2118d321b81SPeter Tyser/common			Misc architecture independent functions
2128d321b81SPeter Tyser/disk			Code for disk drive partition handling
2138d321b81SPeter Tyser/doc			Documentation (don't expect too much)
2148d321b81SPeter Tyser/drivers		Commonly used device drivers
2158d321b81SPeter Tyser/examples		Example code for standalone applications, etc.
2168d321b81SPeter Tyser/fs			Filesystem code (cramfs, ext2, jffs2, etc.)
2178d321b81SPeter Tyser/include		Header Files
2188d321b81SPeter Tyser/lib			Files generic to all architectures
2198d321b81SPeter Tyser  /libfdt		Library files to support flattened device trees
2208d321b81SPeter Tyser  /lzma			Library files to support LZMA decompression
2218d321b81SPeter Tyser  /lzo			Library files to support LZO decompression
2228d321b81SPeter Tyser/net			Networking code
2238d321b81SPeter Tyser/post			Power On Self Test
2248d321b81SPeter Tyser/rtc			Real Time Clock drivers
2258d321b81SPeter Tyser/tools			Tools to build S-Record or U-Boot images, etc.
226c609719bSwdenk
227c609719bSwdenkSoftware Configuration:
228c609719bSwdenk=======================
229c609719bSwdenk
230c609719bSwdenkConfiguration is usually done using C preprocessor defines; the
231c609719bSwdenkrationale behind that is to avoid dead code whenever possible.
232c609719bSwdenk
233c609719bSwdenkThere are two classes of configuration variables:
234c609719bSwdenk
235c609719bSwdenk* Configuration _OPTIONS_:
236c609719bSwdenk  These are selectable by the user and have names beginning with
237c609719bSwdenk  "CONFIG_".
238c609719bSwdenk
239c609719bSwdenk* Configuration _SETTINGS_:
240c609719bSwdenk  These depend on the hardware etc. and should not be meddled with if
241c609719bSwdenk  you don't know what you're doing; they have names beginning with
2426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  "CONFIG_SYS_".
243c609719bSwdenk
244c609719bSwdenkLater we will add a configuration tool - probably similar to or even
245c609719bSwdenkidentical to what's used for the Linux kernel. Right now, we have to
246c609719bSwdenkdo the configuration by hand, which means creating some symbolic
247c609719bSwdenklinks and editing some configuration files. We use the TQM8xxL boards
248c609719bSwdenkas an example here.
249c609719bSwdenk
250c609719bSwdenk
251c609719bSwdenkSelection of Processor Architecture and Board Type:
252c609719bSwdenk---------------------------------------------------
253c609719bSwdenk
254c609719bSwdenkFor all supported boards there are ready-to-use default
255c609719bSwdenkconfigurations available; just type "make <board_name>_config".
256c609719bSwdenk
257c609719bSwdenkExample: For a TQM823L module type:
258c609719bSwdenk
259c609719bSwdenk	cd u-boot
260c609719bSwdenk	make TQM823L_config
261c609719bSwdenk
26211ccc33fSMarcel ZiswilerFor the Cogent platform, you need to specify the CPU type as well;
263c609719bSwdenke.g. "make cogent_mpc8xx_config". And also configure the cogent
264c609719bSwdenkdirectory according to the instructions in cogent/README.
265c609719bSwdenk
266c609719bSwdenk
267c609719bSwdenkConfiguration Options:
268c609719bSwdenk----------------------
269c609719bSwdenk
270c609719bSwdenkConfiguration depends on the combination of board and CPU type; all
271c609719bSwdenksuch information is kept in a configuration file
272c609719bSwdenk"include/configs/<board_name>.h".
273c609719bSwdenk
274c609719bSwdenkExample: For a TQM823L module, all configuration settings are in
275c609719bSwdenk"include/configs/TQM823L.h".
276c609719bSwdenk
277c609719bSwdenk
2787f6c2cbcSwdenkMany of the options are named exactly as the corresponding Linux
2797f6c2cbcSwdenkkernel configuration options. The intention is to make it easier to
2807f6c2cbcSwdenkbuild a config tool - later.
2817f6c2cbcSwdenk
2827f6c2cbcSwdenk
283c609719bSwdenkThe following options need to be configured:
284c609719bSwdenk
2852628114eSKim Phillips- CPU Type:	Define exactly one, e.g. CONFIG_MPC85XX.
286c609719bSwdenk
2872628114eSKim Phillips- Board Type:	Define exactly one, e.g. CONFIG_MPC8540ADS.
2886ccec449SWolfgang Denk
2896ccec449SWolfgang Denk- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
29009ea0de0SHaavard Skinnemoen		Define exactly one, e.g. CONFIG_ATSTK1002
291c609719bSwdenk
292c609719bSwdenk- CPU Module Type: (if CONFIG_COGENT is defined)
293c609719bSwdenk		Define exactly one of
294c609719bSwdenk		CONFIG_CMA286_60_OLD
295c609719bSwdenk--- FIXME --- not tested yet:
296c609719bSwdenk		CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
297c609719bSwdenk		CONFIG_CMA287_23, CONFIG_CMA287_50
298c609719bSwdenk
299c609719bSwdenk- Motherboard Type: (if CONFIG_COGENT is defined)
300c609719bSwdenk		Define exactly one of
301c609719bSwdenk		CONFIG_CMA101, CONFIG_CMA102
302c609719bSwdenk
303c609719bSwdenk- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
304c609719bSwdenk		Define one or more of
305c609719bSwdenk		CONFIG_CMA302
306c609719bSwdenk
307c609719bSwdenk- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
308c609719bSwdenk		Define one or more of
309c609719bSwdenk		CONFIG_LCD_HEARTBEAT	- update a character position on
31011ccc33fSMarcel Ziswiler					  the LCD display every second with
311c609719bSwdenk					  a "rotator" |\-/|\-/
312c609719bSwdenk
3132535d602Swdenk- Board flavour: (if CONFIG_MPC8260ADS is defined)
3142535d602Swdenk		CONFIG_ADSTYPE
3152535d602Swdenk		Possible values are:
3166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8260ADS	- original MPC8260ADS
3176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8266ADS	- MPC8266ADS
3186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_PQ2FADS	- PQ2FADS-ZU or PQ2FADS-VR
3196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8272ADS	- MPC8272ADS
3202535d602Swdenk
321c609719bSwdenk- MPC824X Family Member (if CONFIG_MPC824X is defined)
322c609719bSwdenk		Define exactly one of
323c609719bSwdenk		CONFIG_MPC8240, CONFIG_MPC8245
324c609719bSwdenk
32511ccc33fSMarcel Ziswiler- 8xx CPU Options: (if using an MPC8xx CPU)
32666ca92a5Swdenk		CONFIG_8xx_GCLK_FREQ	- deprecated: CPU clock if
32766ca92a5Swdenk					  get_gclk_freq() cannot work
3285da627a4Swdenk					  e.g. if there is no 32KHz
3295da627a4Swdenk					  reference PIT/RTC clock
33066ca92a5Swdenk		CONFIG_8xx_OSCLK	- PLL input clock (either EXTCLK
33166ca92a5Swdenk					  or XTAL/EXTAL)
332c609719bSwdenk
33366ca92a5Swdenk- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
3346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MIN
3356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MAX
33666ca92a5Swdenk		CONFIG_8xx_CPUCLK_DEFAULT
33775d1ea7fSwdenk			See doc/README.MPC866
33875d1ea7fSwdenk
3396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MEASURE_CPUCLK
34075d1ea7fSwdenk
34175d1ea7fSwdenk		Define this to measure the actual CPU clock instead
34275d1ea7fSwdenk		of relying on the correctness of the configured
34375d1ea7fSwdenk		values. Mostly useful for board bringup to make sure
34475d1ea7fSwdenk		the PLL is locked at the intended frequency. Note
34575d1ea7fSwdenk		that this requires a (stable) reference clock (32 kHz
3466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		RTC clock or CONFIG_SYS_8XX_XIN)
34775d1ea7fSwdenk
348506f3918SHeiko Schocher		CONFIG_SYS_DELAYED_ICACHE
349506f3918SHeiko Schocher
350506f3918SHeiko Schocher		Define this option if you want to enable the
351506f3918SHeiko Schocher		ICache only when Code runs from RAM.
352506f3918SHeiko Schocher
3530b953ffcSMarkus Klotzbuecher- Intel Monahans options:
3546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
3550b953ffcSMarkus Klotzbuecher
3560b953ffcSMarkus Klotzbuecher		Defines the Monahans run mode to oscillator
3570b953ffcSMarkus Klotzbuecher		ratio. Valid values are 8, 16, 24, 31. The core
3580b953ffcSMarkus Klotzbuecher		frequency is this value multiplied by 13 MHz.
3590b953ffcSMarkus Klotzbuecher
3606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
3610b953ffcSMarkus Klotzbuecher
3620b953ffcSMarkus Klotzbuecher		Defines the Monahans turbo mode to oscillator
3630b953ffcSMarkus Klotzbuecher		ratio. Valid values are 1 (default if undefined) and
3640b953ffcSMarkus Klotzbuecher		2. The core frequency as calculated above is multiplied
3650b953ffcSMarkus Klotzbuecher		by this value.
3660b953ffcSMarkus Klotzbuecher
3675da627a4Swdenk- Linux Kernel Interface:
368c609719bSwdenk		CONFIG_CLOCKS_IN_MHZ
369c609719bSwdenk
370c609719bSwdenk		U-Boot stores all clock information in Hz
371c609719bSwdenk		internally. For binary compatibility with older Linux
372c609719bSwdenk		kernels (which expect the clocks passed in the
373c609719bSwdenk		bd_info data to be in MHz) the environment variable
374c609719bSwdenk		"clocks_in_mhz" can be defined so that U-Boot
375c609719bSwdenk		converts clock data to MHZ before passing it to the
376c609719bSwdenk		Linux kernel.
377c609719bSwdenk		When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
378c609719bSwdenk		"clocks_in_mhz=1" is automatically included in the
379c609719bSwdenk		default environment.
380c609719bSwdenk
3815da627a4Swdenk		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]
3825da627a4Swdenk
38311ccc33fSMarcel Ziswiler		When transferring memsize parameter to linux, some versions
3845da627a4Swdenk		expect it to be in bytes, others in MB.
3855da627a4Swdenk		Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
3865da627a4Swdenk
387fec6d9eeSGerald Van Baren		CONFIG_OF_LIBFDT
388f57f70aaSWolfgang Denk
389f57f70aaSWolfgang Denk		New kernel versions are expecting firmware settings to be
390213bf8c8SGerald Van Baren		passed using flattened device trees (based on open firmware
391213bf8c8SGerald Van Baren		concepts).
392213bf8c8SGerald Van Baren
393213bf8c8SGerald Van Baren		CONFIG_OF_LIBFDT
394213bf8c8SGerald Van Baren		 * New libfdt-based support
395213bf8c8SGerald Van Baren		 * Adds the "fdt" command
3963bb342fcSKim Phillips		 * The bootm command automatically updates the fdt
397213bf8c8SGerald Van Baren
398b55ae402SMarcel Ziswiler		OF_CPU - The proper name of the cpus node (only required for
399b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
400b55ae402SMarcel Ziswiler		OF_SOC - The proper name of the soc node (only required for
401b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
402f57f70aaSWolfgang Denk		OF_TBCLK - The timebase frequency.
403c2871f03SKumar Gala		OF_STDOUT_PATH - The path to the console device
404f57f70aaSWolfgang Denk
40511ccc33fSMarcel Ziswiler		boards with QUICC Engines require OF_QE to set UCC MAC
40611ccc33fSMarcel Ziswiler		addresses
4073bb342fcSKim Phillips
4084e253137SKumar Gala		CONFIG_OF_BOARD_SETUP
4094e253137SKumar Gala
4104e253137SKumar Gala		Board code has addition modification that it wants to make
4114e253137SKumar Gala		to the flat device tree before handing it off to the kernel
4126705d81eSwdenk
4130267768eSMatthew McClintock		CONFIG_OF_BOOT_CPU
4140267768eSMatthew McClintock
41511ccc33fSMarcel Ziswiler		This define fills in the correct boot CPU in the boot
4160267768eSMatthew McClintock		param header, the default value is zero if undefined.
4170267768eSMatthew McClintock
4183887c3fbSHeiko Schocher		CONFIG_OF_IDE_FIXUP
4193887c3fbSHeiko Schocher
4203887c3fbSHeiko Schocher		U-Boot can detect if an IDE device is present or not.
4213887c3fbSHeiko Schocher		If not, and this new config option is activated, U-Boot
4223887c3fbSHeiko Schocher		removes the ATA node from the DTS before booting Linux,
4233887c3fbSHeiko Schocher		so the Linux IDE driver does not probe the device and
4243887c3fbSHeiko Schocher		crash. This is needed for buggy hardware (uc101) where
4253887c3fbSHeiko Schocher		no pull down resistor is connected to the signal IDE5V_DD7.
4263887c3fbSHeiko Schocher
4270b2f4ecaSNiklaus Giger- vxWorks boot parameters:
4280b2f4ecaSNiklaus Giger
4290b2f4ecaSNiklaus Giger		bootvx constructs a valid bootline using the following
4300b2f4ecaSNiklaus Giger		environments variables: bootfile, ipaddr, serverip, hostname.
4310b2f4ecaSNiklaus Giger		It loads the vxWorks image pointed bootfile.
4320b2f4ecaSNiklaus Giger
4330b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
4340b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
4350b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
4360b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
4370b2f4ecaSNiklaus Giger
4380b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_ADD_PARAMS
4390b2f4ecaSNiklaus Giger
4400b2f4ecaSNiklaus Giger		Add it at the end of the bootline. E.g "u=username pw=secret"
4410b2f4ecaSNiklaus Giger
4420b2f4ecaSNiklaus Giger		Note: If a "bootargs" environment is defined, it will overwride
4430b2f4ecaSNiklaus Giger		the defaults discussed just above.
4440b2f4ecaSNiklaus Giger
4456705d81eSwdenk- Serial Ports:
44648d0192fSAndreas Engel		CONFIG_PL010_SERIAL
4476705d81eSwdenk
4486705d81eSwdenk		Define this if you want support for Amba PrimeCell PL010 UARTs.
4496705d81eSwdenk
45048d0192fSAndreas Engel		CONFIG_PL011_SERIAL
4516705d81eSwdenk
4526705d81eSwdenk		Define this if you want support for Amba PrimeCell PL011 UARTs.
4536705d81eSwdenk
4546705d81eSwdenk		CONFIG_PL011_CLOCK
4556705d81eSwdenk
4566705d81eSwdenk		If you have Amba PrimeCell PL011 UARTs, set this variable to
4576705d81eSwdenk		the clock speed of the UARTs.
4586705d81eSwdenk
4596705d81eSwdenk		CONFIG_PL01x_PORTS
4606705d81eSwdenk
4616705d81eSwdenk		If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
4626705d81eSwdenk		define this to a list of base addresses for each (supported)
4636705d81eSwdenk		port. See e.g. include/configs/versatile.h
4646705d81eSwdenk
4656705d81eSwdenk
466c609719bSwdenk- Console Interface:
467c609719bSwdenk		Depending on board, define exactly one serial port
468c609719bSwdenk		(like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
469c609719bSwdenk		CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
470c609719bSwdenk		console by defining CONFIG_8xx_CONS_NONE
471c609719bSwdenk
472c609719bSwdenk		Note: if CONFIG_8xx_CONS_NONE is defined, the serial
473c609719bSwdenk		port routines must be defined elsewhere
474c609719bSwdenk		(i.e. serial_init(), serial_getc(), ...)
475c609719bSwdenk
476c609719bSwdenk		CONFIG_CFB_CONSOLE
477c609719bSwdenk		Enables console device for a color framebuffer. Needs following
478c609719bSwdenk		defines (cf. smiLynxEM, i8042, board/eltec/bab7xx)
479c609719bSwdenk			VIDEO_FB_LITTLE_ENDIAN	graphic memory organisation
480c609719bSwdenk						(default big endian)
481c609719bSwdenk			VIDEO_HW_RECTFILL	graphic chip supports
482c609719bSwdenk						rectangle fill
483c609719bSwdenk						(cf. smiLynxEM)
484c609719bSwdenk			VIDEO_HW_BITBLT		graphic chip supports
485c609719bSwdenk						bit-blit (cf. smiLynxEM)
486c609719bSwdenk			VIDEO_VISIBLE_COLS	visible pixel columns
487c609719bSwdenk						(cols=pitch)
488c609719bSwdenk			VIDEO_VISIBLE_ROWS	visible pixel rows
489c609719bSwdenk			VIDEO_PIXEL_SIZE	bytes per pixel
490c609719bSwdenk			VIDEO_DATA_FORMAT	graphic data format
491c609719bSwdenk						(0-5, cf. cfb_console.c)
492c609719bSwdenk			VIDEO_FB_ADRS		framebuffer address
493c609719bSwdenk			VIDEO_KBD_INIT_FCT	keyboard int fct
494c609719bSwdenk						(i.e. i8042_kbd_init())
495c609719bSwdenk			VIDEO_TSTC_FCT		test char fct
496c609719bSwdenk						(i.e. i8042_tstc)
497c609719bSwdenk			VIDEO_GETC_FCT		get char fct
498c609719bSwdenk						(i.e. i8042_getc)
499c609719bSwdenk			CONFIG_CONSOLE_CURSOR	cursor drawing on/off
500c609719bSwdenk						(requires blink timer
501c609719bSwdenk						cf. i8042.c)
5026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
503c609719bSwdenk			CONFIG_CONSOLE_TIME	display time/date info in
504c609719bSwdenk						upper right corner
505602ad3b3SJon Loeliger						(requires CONFIG_CMD_DATE)
506c609719bSwdenk			CONFIG_VIDEO_LOGO	display Linux logo in
507c609719bSwdenk						upper left corner
508a6c7ad2fSwdenk			CONFIG_VIDEO_BMP_LOGO	use bmp_logo.h instead of
509a6c7ad2fSwdenk						linux_logo.h for logo.
510a6c7ad2fSwdenk						Requires CONFIG_VIDEO_LOGO
511c609719bSwdenk			CONFIG_CONSOLE_EXTRA_INFO
51211ccc33fSMarcel Ziswiler						additional board info beside
513c609719bSwdenk						the logo
514c609719bSwdenk
515c609719bSwdenk		When CONFIG_CFB_CONSOLE is defined, video console is
516c609719bSwdenk		default i/o. Serial console can be forced with
517c609719bSwdenk		environment 'console=serial'.
518c609719bSwdenk
519a3ad8e26Swdenk		When CONFIG_SILENT_CONSOLE is defined, all console
520a3ad8e26Swdenk		messages (by U-Boot and Linux!) can be silenced with
521a3ad8e26Swdenk		the "silent" environment variable. See
522a3ad8e26Swdenk		doc/README.silent for more information.
523a3ad8e26Swdenk
524c609719bSwdenk- Console Baudrate:
525c609719bSwdenk		CONFIG_BAUDRATE - in bps
526c609719bSwdenk		Select one of the baudrates listed in
5276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
5286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
529c609719bSwdenk
530c92fac91SHeiko Schocher- Console Rx buffer length
531c92fac91SHeiko Schocher		With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
532c92fac91SHeiko Schocher		the maximum receive buffer length for the SMC.
5332b3f12c2SHeiko Schocher		This option is actual only for 82xx and 8xx possible.
534c92fac91SHeiko Schocher		If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
535c92fac91SHeiko Schocher		must be defined, to setup the maximum idle timeout for
536c92fac91SHeiko Schocher		the SMC.
537c92fac91SHeiko Schocher
538c609719bSwdenk- Interrupt driven serial port input:
539c609719bSwdenk		CONFIG_SERIAL_SOFTWARE_FIFO
540c609719bSwdenk
541c609719bSwdenk		PPC405GP only.
542c609719bSwdenk		Use an interrupt handler for receiving data on the
543c609719bSwdenk		serial port. It also enables using hardware handshake
544c609719bSwdenk		(RTS/CTS) and UART's built-in FIFO. Set the number of
545c609719bSwdenk		bytes the interrupt driven input buffer should have.
546c609719bSwdenk
547109c0e3aSwdenk		Leave undefined to disable this feature, including
548109c0e3aSwdenk		disable the buffer and hardware handshake.
549c609719bSwdenk
5501d49b1f3Sstroese- Console UART Number:
5511d49b1f3Sstroese		CONFIG_UART1_CONSOLE
5521d49b1f3Sstroese
5530c8721a4SWolfgang Denk		AMCC PPC4xx only.
5541d49b1f3Sstroese		If defined internal UART1 (and not UART0) is used
5551d49b1f3Sstroese		as default U-Boot console.
5561d49b1f3Sstroese
557c609719bSwdenk- Boot Delay:	CONFIG_BOOTDELAY - in seconds
558c609719bSwdenk		Delay before automatically booting the default image;
559c609719bSwdenk		set to -1 to disable autoboot.
560c609719bSwdenk
561c609719bSwdenk		See doc/README.autoboot for these options that
562c609719bSwdenk		work with CONFIG_BOOTDELAY. None are required.
563c609719bSwdenk		CONFIG_BOOT_RETRY_TIME
564c609719bSwdenk		CONFIG_BOOT_RETRY_MIN
565c609719bSwdenk		CONFIG_AUTOBOOT_KEYED
566c609719bSwdenk		CONFIG_AUTOBOOT_PROMPT
567c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR
568c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR
569c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR2
570c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR2
571c609719bSwdenk		CONFIG_ZERO_BOOTDELAY_CHECK
572c609719bSwdenk		CONFIG_RESET_TO_RETRY
573c609719bSwdenk
574c609719bSwdenk- Autoboot Command:
575c609719bSwdenk		CONFIG_BOOTCOMMAND
576c609719bSwdenk		Only needed when CONFIG_BOOTDELAY is enabled;
577c609719bSwdenk		define a command string that is automatically executed
578c609719bSwdenk		when no character is read on the console interface
579c609719bSwdenk		within "Boot Delay" after reset.
580c609719bSwdenk
581c609719bSwdenk		CONFIG_BOOTARGS
582c609719bSwdenk		This can be used to pass arguments to the bootm
583c609719bSwdenk		command. The value of CONFIG_BOOTARGS goes into the
584c609719bSwdenk		environment value "bootargs".
585c609719bSwdenk
586c609719bSwdenk		CONFIG_RAMBOOT and CONFIG_NFSBOOT
587c609719bSwdenk		The value of these goes into the environment as
588c609719bSwdenk		"ramboot" and "nfsboot" respectively, and can be used
589c609719bSwdenk		as a convenience, when switching between booting from
59011ccc33fSMarcel Ziswiler		RAM and NFS.
591c609719bSwdenk
592c609719bSwdenk- Pre-Boot Commands:
593c609719bSwdenk		CONFIG_PREBOOT
594c609719bSwdenk
595c609719bSwdenk		When this option is #defined, the existence of the
596c609719bSwdenk		environment variable "preboot" will be checked
597c609719bSwdenk		immediately before starting the CONFIG_BOOTDELAY
598c609719bSwdenk		countdown and/or running the auto-boot command resp.
599c609719bSwdenk		entering interactive mode.
600c609719bSwdenk
601c609719bSwdenk		This feature is especially useful when "preboot" is
602c609719bSwdenk		automatically generated or modified. For an example
603c609719bSwdenk		see the LWMON board specific code: here "preboot" is
604c609719bSwdenk		modified when the user holds down a certain
605c609719bSwdenk		combination of keys on the (special) keyboard when
606c609719bSwdenk		booting the systems
607c609719bSwdenk
608c609719bSwdenk- Serial Download Echo Mode:
609c609719bSwdenk		CONFIG_LOADS_ECHO
610c609719bSwdenk		If defined to 1, all characters received during a
611c609719bSwdenk		serial download (using the "loads" command) are
612c609719bSwdenk		echoed back. This might be needed by some terminal
613c609719bSwdenk		emulations (like "cu"), but may as well just take
614c609719bSwdenk		time on others. This setting #define's the initial
615c609719bSwdenk		value of the "loads_echo" environment variable.
616c609719bSwdenk
617602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
618c609719bSwdenk		CONFIG_KGDB_BAUDRATE
619c609719bSwdenk		Select one of the baudrates listed in
6206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
621c609719bSwdenk
622c609719bSwdenk- Monitor Functions:
623602ad3b3SJon Loeliger		Monitor commands can be included or excluded
624602ad3b3SJon Loeliger		from the build by using the #include files
625602ad3b3SJon Loeliger		"config_cmd_all.h" and #undef'ing unwanted
626602ad3b3SJon Loeliger		commands, or using "config_cmd_default.h"
627602ad3b3SJon Loeliger		and augmenting with additional #define's
628602ad3b3SJon Loeliger		for wanted commands.
629c609719bSwdenk
630602ad3b3SJon Loeliger		The default command configuration includes all commands
631602ad3b3SJon Loeliger		except those marked below with a "*".
632602ad3b3SJon Loeliger
633602ad3b3SJon Loeliger		CONFIG_CMD_ASKENV	* ask for env variable
634602ad3b3SJon Loeliger		CONFIG_CMD_BDI		  bdinfo
635602ad3b3SJon Loeliger		CONFIG_CMD_BEDBUG	* Include BedBug Debugger
636602ad3b3SJon Loeliger		CONFIG_CMD_BMP		* BMP support
637602ad3b3SJon Loeliger		CONFIG_CMD_BSP		* Board specific commands
638602ad3b3SJon Loeliger		CONFIG_CMD_BOOTD	  bootd
639602ad3b3SJon Loeliger		CONFIG_CMD_CACHE	* icache, dcache
640602ad3b3SJon Loeliger		CONFIG_CMD_CONSOLE	  coninfo
641602ad3b3SJon Loeliger		CONFIG_CMD_DATE		* support for RTC, date/time...
642602ad3b3SJon Loeliger		CONFIG_CMD_DHCP		* DHCP support
643602ad3b3SJon Loeliger		CONFIG_CMD_DIAG		* Diagnostics
644a7c93104SPeter Tyser		CONFIG_CMD_DS4510	* ds4510 I2C gpio commands
645a7c93104SPeter Tyser		CONFIG_CMD_DS4510_INFO	* ds4510 I2C info command
646a7c93104SPeter Tyser		CONFIG_CMD_DS4510_MEM	* ds4510 I2C eeprom/sram commansd
647a7c93104SPeter Tyser		CONFIG_CMD_DS4510_RST	* ds4510 I2C rst command
648602ad3b3SJon Loeliger		CONFIG_CMD_DTT		* Digital Therm and Thermostat
649602ad3b3SJon Loeliger		CONFIG_CMD_ECHO		  echo arguments
650246c6922SPeter Tyser		CONFIG_CMD_EDITENV	  edit env variable
651602ad3b3SJon Loeliger		CONFIG_CMD_EEPROM	* EEPROM read/write support
652602ad3b3SJon Loeliger		CONFIG_CMD_ELF		* bootelf, bootvx
653bdab39d3SMike Frysinger		CONFIG_CMD_SAVEENV	  saveenv
654602ad3b3SJon Loeliger		CONFIG_CMD_FDC		* Floppy Disk Support
655602ad3b3SJon Loeliger		CONFIG_CMD_FAT		* FAT partition support
656602ad3b3SJon Loeliger		CONFIG_CMD_FDOS		* Dos diskette Support
657602ad3b3SJon Loeliger		CONFIG_CMD_FLASH	  flinfo, erase, protect
658602ad3b3SJon Loeliger		CONFIG_CMD_FPGA		  FPGA device initialization support
659602ad3b3SJon Loeliger		CONFIG_CMD_HWFLOW	* RTS/CTS hw flow control
660602ad3b3SJon Loeliger		CONFIG_CMD_I2C		* I2C serial bus support
661602ad3b3SJon Loeliger		CONFIG_CMD_IDE		* IDE harddisk support
662602ad3b3SJon Loeliger		CONFIG_CMD_IMI		  iminfo
663602ad3b3SJon Loeliger		CONFIG_CMD_IMLS		  List all found images
664602ad3b3SJon Loeliger		CONFIG_CMD_IMMAP	* IMMR dump support
665602ad3b3SJon Loeliger		CONFIG_CMD_IRQ		* irqinfo
666602ad3b3SJon Loeliger		CONFIG_CMD_ITEST	  Integer/string test of 2 values
667602ad3b3SJon Loeliger		CONFIG_CMD_JFFS2	* JFFS2 Support
668602ad3b3SJon Loeliger		CONFIG_CMD_KGDB		* kgdb
669602ad3b3SJon Loeliger		CONFIG_CMD_LOADB	  loadb
670602ad3b3SJon Loeliger		CONFIG_CMD_LOADS	  loads
67102c9aa1dSRobin Getz		CONFIG_CMD_MD5SUM	  print md5 message digest
67202c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
673602ad3b3SJon Loeliger		CONFIG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
67456523f12Swdenk					  loop, loopw, mtest
675602ad3b3SJon Loeliger		CONFIG_CMD_MISC		  Misc functions like sleep etc
676602ad3b3SJon Loeliger		CONFIG_CMD_MMC		* MMC memory mapped support
677602ad3b3SJon Loeliger		CONFIG_CMD_MII		* MII utility commands
67868d7d651SStefan Roese		CONFIG_CMD_MTDPARTS	* MTD partition support
679602ad3b3SJon Loeliger		CONFIG_CMD_NAND		* NAND support
680602ad3b3SJon Loeliger		CONFIG_CMD_NET		  bootp, tftpboot, rarpboot
681e92739d3SPeter Tyser		CONFIG_CMD_PCA953X	* PCA953x I2C gpio commands
682e92739d3SPeter Tyser		CONFIG_CMD_PCA953X_INFO	* PCA953x I2C gpio info command
683602ad3b3SJon Loeliger		CONFIG_CMD_PCI		* pciinfo
684602ad3b3SJon Loeliger		CONFIG_CMD_PCMCIA		* PCMCIA support
685602ad3b3SJon Loeliger		CONFIG_CMD_PING		* send ICMP ECHO_REQUEST to network
686602ad3b3SJon Loeliger					  host
687602ad3b3SJon Loeliger		CONFIG_CMD_PORTIO	* Port I/O
688602ad3b3SJon Loeliger		CONFIG_CMD_REGINFO	* Register dump
689602ad3b3SJon Loeliger		CONFIG_CMD_RUN		  run command in env variable
690602ad3b3SJon Loeliger		CONFIG_CMD_SAVES	* save S record dump
691602ad3b3SJon Loeliger		CONFIG_CMD_SCSI		* SCSI Support
692602ad3b3SJon Loeliger		CONFIG_CMD_SDRAM	* print SDRAM configuration information
693602ad3b3SJon Loeliger					  (requires CONFIG_CMD_I2C)
694602ad3b3SJon Loeliger		CONFIG_CMD_SETGETDCR	  Support for DCR Register access
695602ad3b3SJon Loeliger					  (4xx only)
69602c9aa1dSRobin Getz		CONFIG_CMD_SHA1		  print sha1 memory digest
69702c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY)
69874de7aefSWolfgang Denk		CONFIG_CMD_SOURCE	  "source" command Support
699602ad3b3SJon Loeliger		CONFIG_CMD_SPI		* SPI serial bus support
700602ad3b3SJon Loeliger		CONFIG_CMD_USB		* USB support
701602ad3b3SJon Loeliger		CONFIG_CMD_VFD		* VFD support (TRAB)
702602ad3b3SJon Loeliger		CONFIG_CMD_CDP		* Cisco Discover Protocol support
703602ad3b3SJon Loeliger		CONFIG_CMD_FSL		* Microblaze FSL support
704c609719bSwdenk
705c609719bSwdenk
706c609719bSwdenk		EXAMPLE: If you want all functions except of network
707c609719bSwdenk		support you can write:
708c609719bSwdenk
709602ad3b3SJon Loeliger		#include "config_cmd_all.h"
710602ad3b3SJon Loeliger		#undef CONFIG_CMD_NET
711c609719bSwdenk
712213bf8c8SGerald Van Baren	Other Commands:
713213bf8c8SGerald Van Baren		fdt (flattened device tree) command: CONFIG_OF_LIBFDT
714c609719bSwdenk
715c609719bSwdenk	Note:	Don't enable the "icache" and "dcache" commands
716602ad3b3SJon Loeliger		(configuration option CONFIG_CMD_CACHE) unless you know
717c609719bSwdenk		what you (and your U-Boot users) are doing. Data
718c609719bSwdenk		cache cannot be enabled on systems like the 8xx or
719c609719bSwdenk		8260 (where accesses to the IMMR region must be
720c609719bSwdenk		uncached), and it cannot be disabled on all other
721c609719bSwdenk		systems where we (mis-) use the data cache to hold an
722c609719bSwdenk		initial stack and some data.
723c609719bSwdenk
724c609719bSwdenk
725c609719bSwdenk		XXX - this list needs to get updated!
726c609719bSwdenk
727c609719bSwdenk- Watchdog:
728c609719bSwdenk		CONFIG_WATCHDOG
729c609719bSwdenk		If this variable is defined, it enables watchdog
7307152b1d0Swdenk		support. There must be support in the platform specific
731c609719bSwdenk		code for a watchdog. For the 8xx and 8260 CPUs, the
732c609719bSwdenk		SIU Watchdog feature is enabled in the SYPCR
733c609719bSwdenk		register.
734c609719bSwdenk
735c1551ea8Sstroese- U-Boot Version:
736c1551ea8Sstroese		CONFIG_VERSION_VARIABLE
737c1551ea8Sstroese		If this variable is defined, an environment variable
738c1551ea8Sstroese		named "ver" is created by U-Boot showing the U-Boot
739c1551ea8Sstroese		version as printed by the "version" command.
740c1551ea8Sstroese		This variable is readonly.
741c1551ea8Sstroese
742c609719bSwdenk- Real-Time Clock:
743c609719bSwdenk
744602ad3b3SJon Loeliger		When CONFIG_CMD_DATE is selected, the type of the RTC
745c609719bSwdenk		has to be selected, too. Define exactly one of the
746c609719bSwdenk		following options:
747c609719bSwdenk
748c609719bSwdenk		CONFIG_RTC_MPC8xx	- use internal RTC of MPC8xx
749c609719bSwdenk		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
7507ce63709SGuennadi Liakhovetski		CONFIG_RTC_MC13783	- use MC13783 RTC
751c609719bSwdenk		CONFIG_RTC_MC146818	- use MC146818 RTC
7521cb8e980Swdenk		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
753c609719bSwdenk		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
7547f70e853Swdenk		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
7553bac3513Swdenk		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
7569536dfccSTor Krill		CONFIG_RTC_ISL1208	- use Intersil ISL1208 RTC
7574c0d4c3bSwdenk		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
7586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_DS1337_NOOSC	- Turn off the OSC output for DS1337
759c609719bSwdenk
760b37c7e5eSwdenk		Note that if the RTC uses I2C, then the I2C interface
761b37c7e5eSwdenk		must also be configured. See I2C Support, below.
762b37c7e5eSwdenk
763e92739d3SPeter Tyser- GPIO Support:
764e92739d3SPeter Tyser		CONFIG_PCA953X		- use NXP's PCA953X series I2C GPIO
765e92739d3SPeter Tyser		CONFIG_PCA953X_INFO	- enable pca953x info command
766e92739d3SPeter Tyser
767e92739d3SPeter Tyser		Note that if the GPIO device uses I2C, then the I2C interface
768e92739d3SPeter Tyser		must also be configured. See I2C Support, below.
769e92739d3SPeter Tyser
770c609719bSwdenk- Timestamp Support:
771c609719bSwdenk
772c609719bSwdenk		When CONFIG_TIMESTAMP is selected, the timestamp
773c609719bSwdenk		(date and time) of an image is printed by image
774c609719bSwdenk		commands like bootm or iminfo. This option is
775602ad3b3SJon Loeliger		automatically enabled when you select CONFIG_CMD_DATE .
776c609719bSwdenk
777c609719bSwdenk- Partition Support:
778c609719bSwdenk		CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
77907f3d789Srichardretanubun		and/or CONFIG_ISO_PARTITION and/or CONFIG_EFI_PARTITION
780c609719bSwdenk
781602ad3b3SJon Loeliger		If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
782218ca724SWolfgang Denk		CONFIG_CMD_SCSI) you must configure support for at
783218ca724SWolfgang Denk		least one partition type as well.
784c609719bSwdenk
785c609719bSwdenk- IDE Reset method:
7864d13cbadSwdenk		CONFIG_IDE_RESET_ROUTINE - this is defined in several
7874d13cbadSwdenk		board configurations files but used nowhere!
788c609719bSwdenk
7894d13cbadSwdenk		CONFIG_IDE_RESET - is this is defined, IDE Reset will
7904d13cbadSwdenk		be performed by calling the function
7914d13cbadSwdenk			ide_set_reset(int reset)
7924d13cbadSwdenk		which has to be defined in a board specific file
793c609719bSwdenk
794c609719bSwdenk- ATAPI Support:
795c609719bSwdenk		CONFIG_ATAPI
796c609719bSwdenk
797c609719bSwdenk		Set this to enable ATAPI support.
798c609719bSwdenk
799c40b2956Swdenk- LBA48 Support
800c40b2956Swdenk		CONFIG_LBA48
801c40b2956Swdenk
802c40b2956Swdenk		Set this to enable support for disks larger than 137GB
8034b142febSHeiko Schocher		Also look at CONFIG_SYS_64BIT_LBA.
804c40b2956Swdenk		Whithout these , LBA48 support uses 32bit variables and will 'only'
805c40b2956Swdenk		support disks up to 2.1TB.
806c40b2956Swdenk
8076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_64BIT_LBA:
808c40b2956Swdenk			When enabled, makes the IDE subsystem use 64bit sector addresses.
809c40b2956Swdenk			Default is 32bit.
810c40b2956Swdenk
811c609719bSwdenk- SCSI Support:
812c609719bSwdenk		At the moment only there is only support for the
813c609719bSwdenk		SYM53C8XX SCSI controller; define
814c609719bSwdenk		CONFIG_SCSI_SYM53C8XX to enable it.
815c609719bSwdenk
8166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
8176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
8186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
819c609719bSwdenk		maximum numbers of LUNs, SCSI ID's and target
820c609719bSwdenk		devices.
8216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
822c609719bSwdenk
823c609719bSwdenk- NETWORK Support (PCI):
824682011ffSwdenk		CONFIG_E1000
825682011ffSwdenk		Support for Intel 8254x gigabit chips.
826682011ffSwdenk
827ac3315c2SAndre Schwarz		CONFIG_E1000_FALLBACK_MAC
82811ccc33fSMarcel Ziswiler		default MAC for empty EEPROM after production.
829ac3315c2SAndre Schwarz
830c609719bSwdenk		CONFIG_EEPRO100
831c609719bSwdenk		Support for Intel 82557/82559/82559ER chips.
83211ccc33fSMarcel Ziswiler		Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
833c609719bSwdenk		write routine for first time initialisation.
834c609719bSwdenk
835c609719bSwdenk		CONFIG_TULIP
836c609719bSwdenk		Support for Digital 2114x chips.
837c609719bSwdenk		Optional CONFIG_TULIP_SELECT_MEDIA for board specific
838c609719bSwdenk		modem chip initialisation (KS8761/QS6611).
839c609719bSwdenk
840c609719bSwdenk		CONFIG_NATSEMI
841c609719bSwdenk		Support for National dp83815 chips.
842c609719bSwdenk
843c609719bSwdenk		CONFIG_NS8382X
844c609719bSwdenk		Support for National dp8382[01] gigabit chips.
845c609719bSwdenk
84645219c46Swdenk- NETWORK Support (other):
84745219c46Swdenk
848c041e9d2SJens Scharsig		CONFIG_DRIVER_AT91EMAC
849c041e9d2SJens Scharsig		Support for AT91RM9200 EMAC.
850c041e9d2SJens Scharsig
851c041e9d2SJens Scharsig			CONFIG_RMII
852c041e9d2SJens Scharsig			Define this to use reduced MII inteface
853c041e9d2SJens Scharsig
854c041e9d2SJens Scharsig			CONFIG_DRIVER_AT91EMAC_QUIET
855c041e9d2SJens Scharsig			If this defined, the driver is quiet.
856c041e9d2SJens Scharsig			The driver doen't show link status messages.
857c041e9d2SJens Scharsig
85845219c46Swdenk		CONFIG_DRIVER_LAN91C96
85945219c46Swdenk		Support for SMSC's LAN91C96 chips.
86045219c46Swdenk
86145219c46Swdenk			CONFIG_LAN91C96_BASE
86245219c46Swdenk			Define this to hold the physical address
86345219c46Swdenk			of the LAN91C96's I/O space
86445219c46Swdenk
86545219c46Swdenk			CONFIG_LAN91C96_USE_32_BIT
86645219c46Swdenk			Define this to enable 32 bit addressing
86745219c46Swdenk
868f39748aeSwdenk		CONFIG_DRIVER_SMC91111
869f39748aeSwdenk		Support for SMSC's LAN91C111 chip
870f39748aeSwdenk
871f39748aeSwdenk			CONFIG_SMC91111_BASE
872f39748aeSwdenk			Define this to hold the physical address
873f39748aeSwdenk			of the device (I/O space)
874f39748aeSwdenk
875f39748aeSwdenk			CONFIG_SMC_USE_32_BIT
876f39748aeSwdenk			Define this if data bus is 32 bits
877f39748aeSwdenk
878f39748aeSwdenk			CONFIG_SMC_USE_IOFUNCS
879f39748aeSwdenk			Define this to use i/o functions instead of macros
880f39748aeSwdenk			(some hardware wont work with macros)
881f39748aeSwdenk
882c2fff331SMike Rapoport		CONFIG_SMC911X
883557b377dSJens Gehrlein		Support for SMSC's LAN911x and LAN921x chips
884557b377dSJens Gehrlein
885c2fff331SMike Rapoport			CONFIG_SMC911X_BASE
886557b377dSJens Gehrlein			Define this to hold the physical address
887557b377dSJens Gehrlein			of the device (I/O space)
888557b377dSJens Gehrlein
889c2fff331SMike Rapoport			CONFIG_SMC911X_32_BIT
890557b377dSJens Gehrlein			Define this if data bus is 32 bits
891557b377dSJens Gehrlein
892c2fff331SMike Rapoport			CONFIG_SMC911X_16_BIT
893557b377dSJens Gehrlein			Define this if data bus is 16 bits. If your processor
894557b377dSJens Gehrlein			automatically converts one 32 bit word to two 16 bit
895c2fff331SMike Rapoport			words you may also try CONFIG_SMC911X_32_BIT.
896557b377dSJens Gehrlein
897c609719bSwdenk- USB Support:
898c609719bSwdenk		At the moment only the UHCI host controller is
8994d13cbadSwdenk		supported (PIP405, MIP405, MPC5200); define
900c609719bSwdenk		CONFIG_USB_UHCI to enable it.
901c609719bSwdenk		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
90230d56faeSwdenk		and define CONFIG_USB_STORAGE to enable the USB
903c609719bSwdenk		storage devices.
904c609719bSwdenk		Note:
905c609719bSwdenk		Supported are USB Keyboards and USB Floppy drives
906c609719bSwdenk		(TEAC FD-05PUB).
9074d13cbadSwdenk		MPC5200 USB requires additional defines:
9084d13cbadSwdenk			CONFIG_USB_CLOCK
9094d13cbadSwdenk				for 528 MHz Clock: 0x0001bbbb
910307ecb6dSEric Millbrandt			CONFIG_PSC3_USB
911307ecb6dSEric Millbrandt				for USB on PSC3
9124d13cbadSwdenk			CONFIG_USB_CONFIG
9134d13cbadSwdenk				for differential drivers: 0x00001000
9144d13cbadSwdenk				for single ended drivers: 0x00005000
915307ecb6dSEric Millbrandt				for differential drivers on PSC3: 0x00000100
916307ecb6dSEric Millbrandt				for single ended drivers on PSC3: 0x00004100
9176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_USB_EVENT_POLL
918fdcfaa1bSZhang Wei				May be defined to allow interrupt polling
919fdcfaa1bSZhang Wei				instead of using asynchronous interrupts
9204d13cbadSwdenk
92116c8d5e7SWolfgang Denk- USB Device:
92216c8d5e7SWolfgang Denk		Define the below if you wish to use the USB console.
92316c8d5e7SWolfgang Denk		Once firmware is rebuilt from a serial console issue the
92416c8d5e7SWolfgang Denk		command "setenv stdin usbtty; setenv stdout usbtty" and
92511ccc33fSMarcel Ziswiler		attach your USB cable. The Unix command "dmesg" should print
92616c8d5e7SWolfgang Denk		it has found a new device. The environment variable usbtty
92716c8d5e7SWolfgang Denk		can be set to gserial or cdc_acm to enable your device to
92816c8d5e7SWolfgang Denk		appear to a USB host as a Linux gserial device or a
92916c8d5e7SWolfgang Denk		Common Device Class Abstract Control Model serial device.
93016c8d5e7SWolfgang Denk		If you select usbtty = gserial you should be able to enumerate
93116c8d5e7SWolfgang Denk		a Linux host by
93216c8d5e7SWolfgang Denk		# modprobe usbserial vendor=0xVendorID product=0xProductID
93316c8d5e7SWolfgang Denk		else if using cdc_acm, simply setting the environment
93416c8d5e7SWolfgang Denk		variable usbtty to be cdc_acm should suffice. The following
93516c8d5e7SWolfgang Denk		might be defined in YourBoardName.h
93616c8d5e7SWolfgang Denk
93716c8d5e7SWolfgang Denk			CONFIG_USB_DEVICE
93816c8d5e7SWolfgang Denk			Define this to build a UDC device
93916c8d5e7SWolfgang Denk
94016c8d5e7SWolfgang Denk			CONFIG_USB_TTY
94116c8d5e7SWolfgang Denk			Define this to have a tty type of device available to
94216c8d5e7SWolfgang Denk			talk to the UDC device
94316c8d5e7SWolfgang Denk
9446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_IS_IN_ENV
94516c8d5e7SWolfgang Denk			Define this if you want stdin, stdout &/or stderr to
94616c8d5e7SWolfgang Denk			be set to usbtty.
94716c8d5e7SWolfgang Denk
94816c8d5e7SWolfgang Denk			mpc8xx:
9496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_EXTC_CLK 0xBLAH
95016c8d5e7SWolfgang Denk				Derive USB clock from external clock "blah"
9516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_EXTC_CLK 0x02
95216c8d5e7SWolfgang Denk
9536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_BRG_CLK 0xBLAH
95416c8d5e7SWolfgang Denk				Derive USB clock from brgclk
9556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_BRG_CLK 0x04
95616c8d5e7SWolfgang Denk
95716c8d5e7SWolfgang Denk		If you have a USB-IF assigned VendorID then you may wish to
95816c8d5e7SWolfgang Denk		define your own vendor specific values either in BoardName.h
95916c8d5e7SWolfgang Denk		or directly in usbd_vendor_info.h. If you don't define
96016c8d5e7SWolfgang Denk		CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
96116c8d5e7SWolfgang Denk		CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
96216c8d5e7SWolfgang Denk		should pretend to be a Linux device to it's target host.
96316c8d5e7SWolfgang Denk
96416c8d5e7SWolfgang Denk			CONFIG_USBD_MANUFACTURER
96516c8d5e7SWolfgang Denk			Define this string as the name of your company for
96616c8d5e7SWolfgang Denk			- CONFIG_USBD_MANUFACTURER "my company"
96716c8d5e7SWolfgang Denk
96816c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCT_NAME
96916c8d5e7SWolfgang Denk			Define this string as the name of your product
97016c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCT_NAME "acme usb device"
97116c8d5e7SWolfgang Denk
97216c8d5e7SWolfgang Denk			CONFIG_USBD_VENDORID
97316c8d5e7SWolfgang Denk			Define this as your assigned Vendor ID from the USB
97416c8d5e7SWolfgang Denk			Implementors Forum. This *must* be a genuine Vendor ID
97516c8d5e7SWolfgang Denk			to avoid polluting the USB namespace.
97616c8d5e7SWolfgang Denk			- CONFIG_USBD_VENDORID 0xFFFF
97716c8d5e7SWolfgang Denk
97816c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCTID
97916c8d5e7SWolfgang Denk			Define this as the unique Product ID
98016c8d5e7SWolfgang Denk			for your device
98116c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCTID 0xFFFF
982c609719bSwdenk
983c609719bSwdenk
984c609719bSwdenk- MMC Support:
985c609719bSwdenk		The MMC controller on the Intel PXA is supported. To
986c609719bSwdenk		enable this define CONFIG_MMC. The MMC can be
987c609719bSwdenk		accessed from the boot prompt by mapping the device
988c609719bSwdenk		to physical memory similar to flash. Command line is
989602ad3b3SJon Loeliger		enabled with CONFIG_CMD_MMC. The MMC driver also works with
990602ad3b3SJon Loeliger		the FAT fs. This is enabled with CONFIG_CMD_FAT.
991c609719bSwdenk
9926705d81eSwdenk- Journaling Flash filesystem support:
9936705d81eSwdenk		CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
9946705d81eSwdenk		CONFIG_JFFS2_NAND_DEV
9956705d81eSwdenk		Define these for a default partition on a NAND device
9966705d81eSwdenk
9976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_SECTOR,
9986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
9996705d81eSwdenk		Define these for a default partition on a NOR device
10006705d81eSwdenk
10016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS_CUSTOM_PART
10026705d81eSwdenk		Define this to create an own partition. You have to provide a
10036705d81eSwdenk		function struct part_info* jffs2_part_info(int part_num)
10046705d81eSwdenk
10056705d81eSwdenk		If you define only one JFFS2 partition you may also want to
10066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_JFFS_SINGLE_PART	1
10076705d81eSwdenk		to disable the command chpart. This is the default when you
10086705d81eSwdenk		have not defined a custom partition
10096705d81eSwdenk
1010c609719bSwdenk- Keyboard Support:
1011c609719bSwdenk		CONFIG_ISA_KEYBOARD
1012c609719bSwdenk
1013c609719bSwdenk		Define this to enable standard (PC-Style) keyboard
1014c609719bSwdenk		support
1015c609719bSwdenk
1016c609719bSwdenk		CONFIG_I8042_KBD
1017c609719bSwdenk		Standard PC keyboard driver with US (is default) and
1018c609719bSwdenk		GERMAN key layout (switch via environment 'keymap=de') support.
1019c609719bSwdenk		Export function i8042_kbd_init, i8042_tstc and i8042_getc
1020c609719bSwdenk		for cfb_console. Supports cursor blinking.
1021c609719bSwdenk
1022c609719bSwdenk- Video support:
1023c609719bSwdenk		CONFIG_VIDEO
1024c609719bSwdenk
1025c609719bSwdenk		Define this to enable video support (for output to
1026c609719bSwdenk		video).
1027c609719bSwdenk
1028c609719bSwdenk		CONFIG_VIDEO_CT69000
1029c609719bSwdenk
1030c609719bSwdenk		Enable Chips & Technologies 69000 Video chip
1031c609719bSwdenk
1032c609719bSwdenk		CONFIG_VIDEO_SMI_LYNXEM
1033eeb1b77bSwdenk		Enable Silicon Motion SMI 712/710/810 Video chip. The
1034eeb1b77bSwdenk		video output is selected via environment 'videoout'
1035eeb1b77bSwdenk		(1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1036eeb1b77bSwdenk		assumed.
1037c609719bSwdenk
1038eeb1b77bSwdenk		For the CT69000 and SMI_LYNXEM drivers, videomode is
103911ccc33fSMarcel Ziswiler		selected via environment 'videomode'. Two different ways
1040eeb1b77bSwdenk		are possible:
1041eeb1b77bSwdenk		- "videomode=num"   'num' is a standard LiLo mode numbers.
1042eeb1b77bSwdenk		Following standard modes are supported	(* is default):
1043eeb1b77bSwdenk
1044eeb1b77bSwdenk		      Colors	640x480 800x600 1024x768 1152x864 1280x1024
1045eeb1b77bSwdenk		-------------+---------------------------------------------
1046eeb1b77bSwdenk		      8 bits |	0x301*	0x303	 0x305	  0x161	    0x307
1047eeb1b77bSwdenk		     15 bits |	0x310	0x313	 0x316	  0x162	    0x319
1048eeb1b77bSwdenk		     16 bits |	0x311	0x314	 0x317	  0x163	    0x31A
1049eeb1b77bSwdenk		     24 bits |	0x312	0x315	 0x318	    ?	    0x31B
1050eeb1b77bSwdenk		-------------+---------------------------------------------
1051c609719bSwdenk		(i.e. setenv videomode 317; saveenv; reset;)
1052c609719bSwdenk
1053eeb1b77bSwdenk		- "videomode=bootargs" all the video parameters are parsed
10547817cb20SMarcel Ziswiler		from the bootargs. (See drivers/video/videomodes.c)
1055eeb1b77bSwdenk
1056eeb1b77bSwdenk
1057a6c7ad2fSwdenk		CONFIG_VIDEO_SED13806
1058a6c7ad2fSwdenk		Enable Epson SED13806 driver. This driver supports 8bpp
1059a6c7ad2fSwdenk		and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1060a6c7ad2fSwdenk		or CONFIG_VIDEO_SED13806_16BPP
1061a6c7ad2fSwdenk
1062682011ffSwdenk- Keyboard Support:
1063682011ffSwdenk		CONFIG_KEYBOARD
1064682011ffSwdenk
1065682011ffSwdenk		Define this to enable a custom keyboard support.
1066682011ffSwdenk		This simply calls drv_keyboard_init() which must be
1067682011ffSwdenk		defined in your board-specific files.
1068682011ffSwdenk		The only board using this so far is RBC823.
1069a6c7ad2fSwdenk
1070c609719bSwdenk- LCD Support:	CONFIG_LCD
1071c609719bSwdenk
1072c609719bSwdenk		Define this to enable LCD support (for output to LCD
1073c609719bSwdenk		display); also select one of the supported displays
1074c609719bSwdenk		by defining one of these:
1075c609719bSwdenk
107639cf4804SStelian Pop		CONFIG_ATMEL_LCD:
107739cf4804SStelian Pop
107839cf4804SStelian Pop			HITACHI TX09D70VM1CCA, 3.5", 240x320.
107939cf4804SStelian Pop
1080fd3103bbSwdenk		CONFIG_NEC_NL6448AC33:
1081c609719bSwdenk
1082fd3103bbSwdenk			NEC NL6448AC33-18. Active, color, single scan.
1083c609719bSwdenk
1084fd3103bbSwdenk		CONFIG_NEC_NL6448BC20
1085c609719bSwdenk
1086fd3103bbSwdenk			NEC NL6448BC20-08. 6.5", 640x480.
1087fd3103bbSwdenk			Active, color, single scan.
1088fd3103bbSwdenk
1089fd3103bbSwdenk		CONFIG_NEC_NL6448BC33_54
1090fd3103bbSwdenk
1091fd3103bbSwdenk			NEC NL6448BC33-54. 10.4", 640x480.
1092c609719bSwdenk			Active, color, single scan.
1093c609719bSwdenk
1094c609719bSwdenk		CONFIG_SHARP_16x9
1095c609719bSwdenk
1096c609719bSwdenk			Sharp 320x240. Active, color, single scan.
1097c609719bSwdenk			It isn't 16x9, and I am not sure what it is.
1098c609719bSwdenk
1099c609719bSwdenk		CONFIG_SHARP_LQ64D341
1100c609719bSwdenk
1101c609719bSwdenk			Sharp LQ64D341 display, 640x480.
1102c609719bSwdenk			Active, color, single scan.
1103c609719bSwdenk
1104c609719bSwdenk		CONFIG_HLD1045
1105c609719bSwdenk
1106c609719bSwdenk			HLD1045 display, 640x480.
1107c609719bSwdenk			Active, color, single scan.
1108c609719bSwdenk
1109c609719bSwdenk		CONFIG_OPTREX_BW
1110c609719bSwdenk
1111c609719bSwdenk			Optrex	 CBL50840-2 NF-FW 99 22 M5
1112c609719bSwdenk			or
1113c609719bSwdenk			Hitachi	 LMG6912RPFC-00T
1114c609719bSwdenk			or
1115c609719bSwdenk			Hitachi	 SP14Q002
1116c609719bSwdenk
1117c609719bSwdenk			320x240. Black & white.
1118c609719bSwdenk
1119c609719bSwdenk		Normally display is black on white background; define
11206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
1121c609719bSwdenk
11227152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN
1123d791b1dcSwdenk
1124d791b1dcSwdenk		If this option is set, the environment is checked for
1125d791b1dcSwdenk		a variable "splashimage". If found, the usual display
1126d791b1dcSwdenk		of logo, copyright and system information on the LCD
1127e94d2cd9Swdenk		is suppressed and the BMP image at the address
1128d791b1dcSwdenk		specified in "splashimage" is loaded instead. The
1129d791b1dcSwdenk		console is redirected to the "nulldev", too. This
1130d791b1dcSwdenk		allows for a "silent" boot where a splash screen is
1131d791b1dcSwdenk		loaded very quickly after power-on.
1132d791b1dcSwdenk
11331ca298ceSMatthias Weisser		CONFIG_SPLASH_SCREEN_ALIGN
11341ca298ceSMatthias Weisser
11351ca298ceSMatthias Weisser		If this option is set the splash image can be freely positioned
11361ca298ceSMatthias Weisser		on the screen. Environment variable "splashpos" specifies the
11371ca298ceSMatthias Weisser		position as "x,y". If a positive number is given it is used as
11381ca298ceSMatthias Weisser		number of pixel from left/top. If a negative number is given it
11391ca298ceSMatthias Weisser		is used as number of pixel from right/bottom. You can also
11401ca298ceSMatthias Weisser		specify 'm' for centering the image.
11411ca298ceSMatthias Weisser
11421ca298ceSMatthias Weisser		Example:
11431ca298ceSMatthias Weisser		setenv splashpos m,m
11441ca298ceSMatthias Weisser			=> image at center of screen
11451ca298ceSMatthias Weisser
11461ca298ceSMatthias Weisser		setenv splashpos 30,20
11471ca298ceSMatthias Weisser			=> image at x = 30 and y = 20
11481ca298ceSMatthias Weisser
11491ca298ceSMatthias Weisser		setenv splashpos -10,m
11501ca298ceSMatthias Weisser			=> vertically centered image
11511ca298ceSMatthias Weisser			   at x = dspWidth - bmpWidth - 9
11521ca298ceSMatthias Weisser
115398f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
115498f4a3dfSStefan Roese
115598f4a3dfSStefan Roese		If this option is set, additionally to standard BMP
115698f4a3dfSStefan Roese		images, gzipped BMP images can be displayed via the
115798f4a3dfSStefan Roese		splashscreen support or the bmp command.
115898f4a3dfSStefan Roese
1159d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1160d5011762SAnatolij Gustschin
1161d5011762SAnatolij Gustschin		If this option is set, 8-bit RLE compressed BMP images
1162d5011762SAnatolij Gustschin		can be displayed via the splashscreen support or the
1163d5011762SAnatolij Gustschin		bmp command.
1164d5011762SAnatolij Gustschin
1165c29fdfc1Swdenk- Compression support:
1166c29fdfc1Swdenk		CONFIG_BZIP2
1167c29fdfc1Swdenk
1168c29fdfc1Swdenk		If this option is set, support for bzip2 compressed
1169c29fdfc1Swdenk		images is included. If not, only uncompressed and gzip
1170c29fdfc1Swdenk		compressed images are supported.
1171c29fdfc1Swdenk
1172c29fdfc1Swdenk		NOTE: the bzip2 algorithm requires a lot of RAM, so
11736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
1174c29fdfc1Swdenk		be at least 4MB.
1175d791b1dcSwdenk
1176fc9c1727SLuigi 'Comio' Mantellini		CONFIG_LZMA
1177fc9c1727SLuigi 'Comio' Mantellini
1178fc9c1727SLuigi 'Comio' Mantellini		If this option is set, support for lzma compressed
1179fc9c1727SLuigi 'Comio' Mantellini		images is included.
1180fc9c1727SLuigi 'Comio' Mantellini
1181fc9c1727SLuigi 'Comio' Mantellini		Note: The LZMA algorithm adds between 2 and 4KB of code and it
1182fc9c1727SLuigi 'Comio' Mantellini		requires an amount of dynamic memory that is given by the
1183fc9c1727SLuigi 'Comio' Mantellini		formula:
1184fc9c1727SLuigi 'Comio' Mantellini
1185fc9c1727SLuigi 'Comio' Mantellini			(1846 + 768 << (lc + lp)) * sizeof(uint16)
1186fc9c1727SLuigi 'Comio' Mantellini
1187fc9c1727SLuigi 'Comio' Mantellini		Where lc and lp stand for, respectively, Literal context bits
1188fc9c1727SLuigi 'Comio' Mantellini		and Literal pos bits.
1189fc9c1727SLuigi 'Comio' Mantellini
1190fc9c1727SLuigi 'Comio' Mantellini		This value is upper-bounded by 14MB in the worst case. Anyway,
1191fc9c1727SLuigi 'Comio' Mantellini		for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1192fc9c1727SLuigi 'Comio' Mantellini		total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1193fc9c1727SLuigi 'Comio' Mantellini		a very small buffer.
1194fc9c1727SLuigi 'Comio' Mantellini
1195fc9c1727SLuigi 'Comio' Mantellini		Use the lzmainfo tool to determinate the lc and lp values and
1196fc9c1727SLuigi 'Comio' Mantellini		then calculate the amount of needed dynamic memory (ensuring
11976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the appropriate CONFIG_SYS_MALLOC_LEN value).
1198fc9c1727SLuigi 'Comio' Mantellini
119917ea1177Swdenk- MII/PHY support:
120017ea1177Swdenk		CONFIG_PHY_ADDR
120117ea1177Swdenk
120217ea1177Swdenk		The address of PHY on MII bus.
120317ea1177Swdenk
120417ea1177Swdenk		CONFIG_PHY_CLOCK_FREQ (ppc4xx)
120517ea1177Swdenk
120617ea1177Swdenk		The clock frequency of the MII bus
120717ea1177Swdenk
120817ea1177Swdenk		CONFIG_PHY_GIGE
120917ea1177Swdenk
121017ea1177Swdenk		If this option is set, support for speed/duplex
121111ccc33fSMarcel Ziswiler		detection of gigabit PHY is included.
121217ea1177Swdenk
121317ea1177Swdenk		CONFIG_PHY_RESET_DELAY
121417ea1177Swdenk
121517ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
121617ea1177Swdenk		reset before any MII register access is possible.
121717ea1177Swdenk		For such PHY, set this option to the usec delay
121817ea1177Swdenk		required. (minimum 300usec for LXT971A)
121917ea1177Swdenk
122017ea1177Swdenk		CONFIG_PHY_CMD_DELAY (ppc4xx)
122117ea1177Swdenk
122217ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
122317ea1177Swdenk		command issued before MII status register can be read
122417ea1177Swdenk
1225c609719bSwdenk- Ethernet address:
1226c609719bSwdenk		CONFIG_ETHADDR
1227c68a05feSrichardretanubun		CONFIG_ETH1ADDR
1228c609719bSwdenk		CONFIG_ETH2ADDR
1229c609719bSwdenk		CONFIG_ETH3ADDR
1230c68a05feSrichardretanubun		CONFIG_ETH4ADDR
1231c68a05feSrichardretanubun		CONFIG_ETH5ADDR
1232c609719bSwdenk
123311ccc33fSMarcel Ziswiler		Define a default value for Ethernet address to use
123411ccc33fSMarcel Ziswiler		for the respective Ethernet interface, in case this
1235c609719bSwdenk		is not determined automatically.
1236c609719bSwdenk
1237c609719bSwdenk- IP address:
1238c609719bSwdenk		CONFIG_IPADDR
1239c609719bSwdenk
1240c609719bSwdenk		Define a default value for the IP address to use for
124111ccc33fSMarcel Ziswiler		the default Ethernet interface, in case this is not
1242c609719bSwdenk		determined through e.g. bootp.
1243c609719bSwdenk
1244c609719bSwdenk- Server IP address:
1245c609719bSwdenk		CONFIG_SERVERIP
1246c609719bSwdenk
1247c609719bSwdenk		Defines a default value for the IP address of a TFTP
1248c609719bSwdenk		server to contact when using the "tftboot" command.
1249c609719bSwdenk
125097cfe861SRobin Getz		CONFIG_KEEP_SERVERADDR
125197cfe861SRobin Getz
125297cfe861SRobin Getz		Keeps the server's MAC address, in the env 'serveraddr'
125397cfe861SRobin Getz		for passing to bootargs (like Linux's netconsole option)
125497cfe861SRobin Getz
125553a5c424SDavid Updegraff- Multicast TFTP Mode:
125653a5c424SDavid Updegraff		CONFIG_MCAST_TFTP
125753a5c424SDavid Updegraff
125853a5c424SDavid Updegraff		Defines whether you want to support multicast TFTP as per
125953a5c424SDavid Updegraff		rfc-2090; for example to work with atftp.  Lets lots of targets
126011ccc33fSMarcel Ziswiler		tftp down the same boot image concurrently.  Note: the Ethernet
126153a5c424SDavid Updegraff		driver in use must provide a function: mcast() to join/leave a
126253a5c424SDavid Updegraff		multicast group.
126353a5c424SDavid Updegraff
126453a5c424SDavid Updegraff		CONFIG_BOOTP_RANDOM_DELAY
1265c609719bSwdenk- BOOTP Recovery Mode:
1266c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY
1267c609719bSwdenk
1268c609719bSwdenk		If you have many targets in a network that try to
1269c609719bSwdenk		boot using BOOTP, you may want to avoid that all
1270c609719bSwdenk		systems send out BOOTP requests at precisely the same
1271c609719bSwdenk		moment (which would happen for instance at recovery
1272c609719bSwdenk		from a power failure, when all systems will try to
1273c609719bSwdenk		boot, thus flooding the BOOTP server. Defining
1274c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1275c609719bSwdenk		inserted before sending out BOOTP requests. The
12766c33c785SWolfgang Denk		following delays are inserted then:
1277c609719bSwdenk
1278c609719bSwdenk		1st BOOTP request:	delay 0 ... 1 sec
1279c609719bSwdenk		2nd BOOTP request:	delay 0 ... 2 sec
1280c609719bSwdenk		3rd BOOTP request:	delay 0 ... 4 sec
1281c609719bSwdenk		4th and following
1282c609719bSwdenk		BOOTP requests:		delay 0 ... 8 sec
1283c609719bSwdenk
1284fe389a82Sstroese- DHCP Advanced Options:
12851fe80d79SJon Loeliger		You can fine tune the DHCP functionality by defining
12861fe80d79SJon Loeliger		CONFIG_BOOTP_* symbols:
1287fe389a82Sstroese
12881fe80d79SJon Loeliger		CONFIG_BOOTP_SUBNETMASK
12891fe80d79SJon Loeliger		CONFIG_BOOTP_GATEWAY
12901fe80d79SJon Loeliger		CONFIG_BOOTP_HOSTNAME
12911fe80d79SJon Loeliger		CONFIG_BOOTP_NISDOMAIN
12921fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTPATH
12931fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTFILESIZE
12941fe80d79SJon Loeliger		CONFIG_BOOTP_DNS
12951fe80d79SJon Loeliger		CONFIG_BOOTP_DNS2
12961fe80d79SJon Loeliger		CONFIG_BOOTP_SEND_HOSTNAME
12971fe80d79SJon Loeliger		CONFIG_BOOTP_NTPSERVER
12981fe80d79SJon Loeliger		CONFIG_BOOTP_TIMEOFFSET
12991fe80d79SJon Loeliger		CONFIG_BOOTP_VENDOREX
1300fe389a82Sstroese
13015d110f0aSWilson Callan		CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
13025d110f0aSWilson Callan		environment variable, not the BOOTP server.
1303fe389a82Sstroese
1304fe389a82Sstroese		CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1305fe389a82Sstroese		serverip from a DHCP server, it is possible that more
1306fe389a82Sstroese		than one DNS serverip is offered to the client.
1307fe389a82Sstroese		If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1308fe389a82Sstroese		serverip will be stored in the additional environment
1309fe389a82Sstroese		variable "dnsip2". The first DNS serverip is always
1310fe389a82Sstroese		stored in the variable "dnsip", when CONFIG_BOOTP_DNS
13111fe80d79SJon Loeliger		is defined.
1312fe389a82Sstroese
1313fe389a82Sstroese		CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1314fe389a82Sstroese		to do a dynamic update of a DNS server. To do this, they
1315fe389a82Sstroese		need the hostname of the DHCP requester.
13165d110f0aSWilson Callan		If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
13171fe80d79SJon Loeliger		of the "hostname" environment variable is passed as
13181fe80d79SJon Loeliger		option 12 to the DHCP server.
1319fe389a82Sstroese
1320d9a2f416SAras Vaichas		CONFIG_BOOTP_DHCP_REQUEST_DELAY
1321d9a2f416SAras Vaichas
1322d9a2f416SAras Vaichas		A 32bit value in microseconds for a delay between
1323d9a2f416SAras Vaichas		receiving a "DHCP Offer" and sending the "DHCP Request".
1324d9a2f416SAras Vaichas		This fixes a problem with certain DHCP servers that don't
1325d9a2f416SAras Vaichas		respond 100% of the time to a "DHCP request". E.g. On an
1326d9a2f416SAras Vaichas		AT91RM9200 processor running at 180MHz, this delay needed
1327d9a2f416SAras Vaichas		to be *at least* 15,000 usec before a Windows Server 2003
1328d9a2f416SAras Vaichas		DHCP server would reply 100% of the time. I recommend at
1329d9a2f416SAras Vaichas		least 50,000 usec to be safe. The alternative is to hope
1330d9a2f416SAras Vaichas		that one of the retries will be successful but note that
1331d9a2f416SAras Vaichas		the DHCP timeout and retry process takes a longer than
1332d9a2f416SAras Vaichas		this delay.
1333d9a2f416SAras Vaichas
1334a3d991bdSwdenk - CDP Options:
1335a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID
1336a3d991bdSwdenk
1337a3d991bdSwdenk		The device id used in CDP trigger frames.
1338a3d991bdSwdenk
1339a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID_PREFIX
1340a3d991bdSwdenk
1341a3d991bdSwdenk		A two character string which is prefixed to the MAC address
1342a3d991bdSwdenk		of the device.
1343a3d991bdSwdenk
1344a3d991bdSwdenk		CONFIG_CDP_PORT_ID
1345a3d991bdSwdenk
1346a3d991bdSwdenk		A printf format string which contains the ascii name of
1347a3d991bdSwdenk		the port. Normally is set to "eth%d" which sets
134811ccc33fSMarcel Ziswiler		eth0 for the first Ethernet, eth1 for the second etc.
1349a3d991bdSwdenk
1350a3d991bdSwdenk		CONFIG_CDP_CAPABILITIES
1351a3d991bdSwdenk
1352a3d991bdSwdenk		A 32bit integer which indicates the device capabilities;
1353a3d991bdSwdenk		0x00000010 for a normal host which does not forwards.
1354a3d991bdSwdenk
1355a3d991bdSwdenk		CONFIG_CDP_VERSION
1356a3d991bdSwdenk
1357a3d991bdSwdenk		An ascii string containing the version of the software.
1358a3d991bdSwdenk
1359a3d991bdSwdenk		CONFIG_CDP_PLATFORM
1360a3d991bdSwdenk
1361a3d991bdSwdenk		An ascii string containing the name of the platform.
1362a3d991bdSwdenk
1363a3d991bdSwdenk		CONFIG_CDP_TRIGGER
1364a3d991bdSwdenk
1365a3d991bdSwdenk		A 32bit integer sent on the trigger.
1366a3d991bdSwdenk
1367a3d991bdSwdenk		CONFIG_CDP_POWER_CONSUMPTION
1368a3d991bdSwdenk
1369a3d991bdSwdenk		A 16bit integer containing the power consumption of the
1370a3d991bdSwdenk		device in .1 of milliwatts.
1371a3d991bdSwdenk
1372a3d991bdSwdenk		CONFIG_CDP_APPLIANCE_VLAN_TYPE
1373a3d991bdSwdenk
1374a3d991bdSwdenk		A byte containing the id of the VLAN.
1375a3d991bdSwdenk
1376c609719bSwdenk- Status LED:	CONFIG_STATUS_LED
1377c609719bSwdenk
1378c609719bSwdenk		Several configurations allow to display the current
1379c609719bSwdenk		status using a LED. For instance, the LED will blink
1380c609719bSwdenk		fast while running U-Boot code, stop blinking as
1381c609719bSwdenk		soon as a reply to a BOOTP request was received, and
1382c609719bSwdenk		start blinking slow once the Linux kernel is running
1383c609719bSwdenk		(supported by a status LED driver in the Linux
1384c609719bSwdenk		kernel). Defining CONFIG_STATUS_LED enables this
1385c609719bSwdenk		feature in U-Boot.
1386c609719bSwdenk
1387c609719bSwdenk- CAN Support:	CONFIG_CAN_DRIVER
1388c609719bSwdenk
1389c609719bSwdenk		Defining CONFIG_CAN_DRIVER enables CAN driver support
1390c609719bSwdenk		on those systems that support this (optional)
1391c609719bSwdenk		feature, like the TQM8xxL modules.
1392c609719bSwdenk
1393c609719bSwdenk- I2C Support:	CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1394c609719bSwdenk
1395b37c7e5eSwdenk		These enable I2C serial bus commands. Defining either of
1396b37c7e5eSwdenk		(but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
139711ccc33fSMarcel Ziswiler		include the appropriate I2C driver for the selected CPU.
1398c609719bSwdenk
1399b37c7e5eSwdenk		This will allow you to use i2c commands at the u-boot
1400602ad3b3SJon Loeliger		command line (as long as you set CONFIG_CMD_I2C in
1401b37c7e5eSwdenk		CONFIG_COMMANDS) and communicate with i2c based realtime
1402b37c7e5eSwdenk		clock chips. See common/cmd_i2c.c for a description of the
1403c609719bSwdenk		command line interface.
1404c609719bSwdenk
1405bb99ad6dSBen Warren		CONFIG_HARD_I2C selects a hardware I2C controller.
1406c609719bSwdenk
1407b37c7e5eSwdenk		CONFIG_SOFT_I2C configures u-boot to use a software (aka
1408b37c7e5eSwdenk		bit-banging) driver instead of CPM or similar hardware
1409b37c7e5eSwdenk		support for I2C.
1410c609719bSwdenk
1411b37c7e5eSwdenk		There are several other quantities that must also be
1412b37c7e5eSwdenk		defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
1413c609719bSwdenk
14146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		In both cases you will need to define CONFIG_SYS_I2C_SPEED
1415b37c7e5eSwdenk		to be the frequency (in Hz) at which you wish your i2c bus
14166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
141711ccc33fSMarcel Ziswiler		the CPU's i2c node address).
1418c609719bSwdenk
14198d321b81SPeter Tyser		Now, the u-boot i2c code for the mpc8xx
1420*a47a12beSStefan Roese		(arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
14218d321b81SPeter Tyser		and so its address should therefore be cleared to 0 (See,
14228d321b81SPeter Tyser		eg, MPC823e User's Manual p.16-473). So, set
14238d321b81SPeter Tyser		CONFIG_SYS_I2C_SLAVE to 0.
1424b37c7e5eSwdenk
14255da71efaSEric Millbrandt		CONFIG_SYS_I2C_INIT_MPC5XXX
14265da71efaSEric Millbrandt
14275da71efaSEric Millbrandt		When a board is reset during an i2c bus transfer
14285da71efaSEric Millbrandt		chips might think that the current transfer is still
14295da71efaSEric Millbrandt		in progress.  Reset the slave devices by sending start
14305da71efaSEric Millbrandt		commands until the slave device responds.
14315da71efaSEric Millbrandt
1432b37c7e5eSwdenk		That's all that's required for CONFIG_HARD_I2C.
1433b37c7e5eSwdenk
1434b37c7e5eSwdenk		If you use the software i2c interface (CONFIG_SOFT_I2C)
1435b37c7e5eSwdenk		then the following macros need to be defined (examples are
1436b37c7e5eSwdenk		from include/configs/lwmon.h):
1437c609719bSwdenk
1438c609719bSwdenk		I2C_INIT
1439c609719bSwdenk
1440b37c7e5eSwdenk		(Optional). Any commands necessary to enable the I2C
1441c609719bSwdenk		controller or configure ports.
1442c609719bSwdenk
1443b37c7e5eSwdenk		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
1444b37c7e5eSwdenk
1445c609719bSwdenk		I2C_PORT
1446c609719bSwdenk
1447c609719bSwdenk		(Only for MPC8260 CPU). The I/O port to use (the code
1448c609719bSwdenk		assumes both bits are on the same port). Valid values
1449c609719bSwdenk		are 0..3 for ports A..D.
1450c609719bSwdenk
1451c609719bSwdenk		I2C_ACTIVE
1452c609719bSwdenk
1453c609719bSwdenk		The code necessary to make the I2C data line active
1454c609719bSwdenk		(driven).  If the data line is open collector, this
1455c609719bSwdenk		define can be null.
1456c609719bSwdenk
1457b37c7e5eSwdenk		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
1458b37c7e5eSwdenk
1459c609719bSwdenk		I2C_TRISTATE
1460c609719bSwdenk
1461c609719bSwdenk		The code necessary to make the I2C data line tri-stated
1462c609719bSwdenk		(inactive).  If the data line is open collector, this
1463c609719bSwdenk		define can be null.
1464c609719bSwdenk
1465b37c7e5eSwdenk		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1466b37c7e5eSwdenk
1467c609719bSwdenk		I2C_READ
1468c609719bSwdenk
1469c609719bSwdenk		Code that returns TRUE if the I2C data line is high,
1470c609719bSwdenk		FALSE if it is low.
1471c609719bSwdenk
1472b37c7e5eSwdenk		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1473b37c7e5eSwdenk
1474c609719bSwdenk		I2C_SDA(bit)
1475c609719bSwdenk
1476c609719bSwdenk		If <bit> is TRUE, sets the I2C data line high. If it
1477c609719bSwdenk		is FALSE, it clears it (low).
1478c609719bSwdenk
1479b37c7e5eSwdenk		eg: #define I2C_SDA(bit) \
1480b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
1481b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
1482b37c7e5eSwdenk
1483c609719bSwdenk		I2C_SCL(bit)
1484c609719bSwdenk
1485c609719bSwdenk		If <bit> is TRUE, sets the I2C clock line high. If it
1486c609719bSwdenk		is FALSE, it clears it (low).
1487c609719bSwdenk
1488b37c7e5eSwdenk		eg: #define I2C_SCL(bit) \
1489b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
1490b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
1491b37c7e5eSwdenk
1492c609719bSwdenk		I2C_DELAY
1493c609719bSwdenk
1494c609719bSwdenk		This delay is invoked four times per clock cycle so this
1495c609719bSwdenk		controls the rate of data transfer.  The data rate thus
1496b37c7e5eSwdenk		is 1 / (I2C_DELAY * 4). Often defined to be something
1497b37c7e5eSwdenk		like:
1498b37c7e5eSwdenk
1499b37c7e5eSwdenk		#define I2C_DELAY  udelay(2)
1500c609719bSwdenk
15016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_INIT_BOARD
150247cd00faSwdenk
150347cd00faSwdenk		When a board is reset during an i2c bus transfer
150447cd00faSwdenk		chips might think that the current transfer is still
150547cd00faSwdenk		in progress. On some boards it is possible to access
150647cd00faSwdenk		the i2c SCLK line directly, either by using the
150747cd00faSwdenk		processor pin as a GPIO or by having a second pin
150847cd00faSwdenk		connected to the bus. If this option is defined a
150947cd00faSwdenk		custom i2c_init_board() routine in boards/xxx/board.c
151047cd00faSwdenk		is run early in the boot sequence.
151147cd00faSwdenk
151217ea1177Swdenk		CONFIG_I2CFAST (PPC405GP|PPC405EP only)
151317ea1177Swdenk
151417ea1177Swdenk		This option enables configuration of bi_iic_fast[] flags
151517ea1177Swdenk		in u-boot bd_info structure based on u-boot environment
151617ea1177Swdenk		variable "i2cfast". (see also i2cfast)
151717ea1177Swdenk
1518bb99ad6dSBen Warren		CONFIG_I2C_MULTI_BUS
1519bb99ad6dSBen Warren
1520bb99ad6dSBen Warren		This option allows the use of multiple I2C buses, each of which
1521bb99ad6dSBen Warren		must have a controller.  At any point in time, only one bus is
1522bb99ad6dSBen Warren		active.  To switch to a different bus, use the 'i2c dev' command.
1523bb99ad6dSBen Warren		Note that bus numbering is zero-based.
1524bb99ad6dSBen Warren
15256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_NOPROBES
1526bb99ad6dSBen Warren
1527bb99ad6dSBen Warren		This option specifies a list of I2C devices that will be skipped
15280f89c54bSPeter Tyser		when the 'i2c probe' command is issued.  If CONFIG_I2C_MULTI_BUS
15290f89c54bSPeter Tyser		is set, specify a list of bus-device pairs.  Otherwise, specify
15300f89c54bSPeter Tyser		a 1D array of device addresses
1531bb99ad6dSBen Warren
1532bb99ad6dSBen Warren		e.g.
1533bb99ad6dSBen Warren			#undef	CONFIG_I2C_MULTI_BUS
15346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_NOPROBES	{0x50,0x68}
1535bb99ad6dSBen Warren
1536bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on a board with one I2C bus
1537bb99ad6dSBen Warren
1538bb99ad6dSBen Warren			#define	CONFIG_I2C_MULTI_BUS
15396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_MULTI_NOPROBES	{{0,0x50},{0,0x68},{1,0x54}}
1540bb99ad6dSBen Warren
1541bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1542bb99ad6dSBen Warren
15436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SPD_BUS_NUM
1544be5e6181STimur Tabi
1545be5e6181STimur Tabi		If defined, then this indicates the I2C bus number for DDR SPD.
1546be5e6181STimur Tabi		If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1547be5e6181STimur Tabi
15486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_BUS_NUM
15490dc018ecSStefan Roese
15500dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the RTC.
15510dc018ecSStefan Roese		If not defined, then U-Boot assumes that RTC is on I2C bus 0.
15520dc018ecSStefan Roese
15536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_DTT_BUS_NUM
15540dc018ecSStefan Roese
15550dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the DTT.
15560dc018ecSStefan Roese		If not defined, then U-Boot assumes that DTT is on I2C bus 0.
15570dc018ecSStefan Roese
15586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_DTT_ADDR:
15599ebbb54fSVictor Gallardo
15609ebbb54fSVictor Gallardo		If defined, specifies the I2C address of the DTT device.
15619ebbb54fSVictor Gallardo		If not defined, then U-Boot uses predefined value for
15629ebbb54fSVictor Gallardo		specified DTT device.
15639ebbb54fSVictor Gallardo
1564be5e6181STimur Tabi		CONFIG_FSL_I2C
1565be5e6181STimur Tabi
1566be5e6181STimur Tabi		Define this option if you want to use Freescale's I2C driver in
15677817cb20SMarcel Ziswiler		drivers/i2c/fsl_i2c.c.
1568be5e6181STimur Tabi
156967b23a32SHeiko Schocher		CONFIG_I2C_MUX
157067b23a32SHeiko Schocher
157167b23a32SHeiko Schocher		Define this option if you have I2C devices reached over 1 .. n
157267b23a32SHeiko Schocher		I2C Muxes like the pca9544a. This option addes a new I2C
157367b23a32SHeiko Schocher		Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
157467b23a32SHeiko Schocher		new I2C Bus to the existing I2C Busses. If you select the
157567b23a32SHeiko Schocher		new Bus with "i2c dev", u-bbot sends first the commandos for
157667b23a32SHeiko Schocher		the muxes to activate this new "bus".
157767b23a32SHeiko Schocher
157867b23a32SHeiko Schocher		CONFIG_I2C_MULTI_BUS must be also defined, to use this
157967b23a32SHeiko Schocher		feature!
158067b23a32SHeiko Schocher
158167b23a32SHeiko Schocher		Example:
158267b23a32SHeiko Schocher		Adding a new I2C Bus reached over 2 pca9544a muxes
158367b23a32SHeiko Schocher			The First mux with address 70 and channel 6
158467b23a32SHeiko Schocher			The Second mux with address 71 and channel 4
158567b23a32SHeiko Schocher
158667b23a32SHeiko Schocher		=> i2c bus pca9544a:70:6:pca9544a:71:4
158767b23a32SHeiko Schocher
158867b23a32SHeiko Schocher		Use the "i2c bus" command without parameter, to get a list
158967b23a32SHeiko Schocher		of I2C Busses with muxes:
159067b23a32SHeiko Schocher
159167b23a32SHeiko Schocher		=> i2c bus
159267b23a32SHeiko Schocher		Busses reached over muxes:
159367b23a32SHeiko Schocher		Bus ID: 2
159467b23a32SHeiko Schocher		  reached over Mux(es):
159567b23a32SHeiko Schocher		    pca9544a@70 ch: 4
159667b23a32SHeiko Schocher		Bus ID: 3
159767b23a32SHeiko Schocher		  reached over Mux(es):
159867b23a32SHeiko Schocher		    pca9544a@70 ch: 6
159967b23a32SHeiko Schocher		    pca9544a@71 ch: 4
160067b23a32SHeiko Schocher		=>
160167b23a32SHeiko Schocher
160267b23a32SHeiko Schocher		If you now switch to the new I2C Bus 3 with "i2c dev 3"
160367b23a32SHeiko Schocher		u-boot sends First the Commando to the mux@70 to enable
160467b23a32SHeiko Schocher		channel 6, and then the Commando to the mux@71 to enable
160567b23a32SHeiko Schocher		the channel 4.
160667b23a32SHeiko Schocher
160767b23a32SHeiko Schocher		After that, you can use the "normal" i2c commands as
160867b23a32SHeiko Schocher		usual, to communicate with your I2C devices behind
160967b23a32SHeiko Schocher		the 2 muxes.
161067b23a32SHeiko Schocher
161167b23a32SHeiko Schocher		This option is actually implemented for the bitbanging
161267b23a32SHeiko Schocher		algorithm in common/soft_i2c.c and for the Hardware I2C
161367b23a32SHeiko Schocher		Bus on the MPC8260. But it should be not so difficult
161467b23a32SHeiko Schocher		to add this option to other architectures.
161567b23a32SHeiko Schocher
16162ac6985aSAndrew Dyer		CONFIG_SOFT_I2C_READ_REPEATED_START
16172ac6985aSAndrew Dyer
16182ac6985aSAndrew Dyer		defining this will force the i2c_read() function in
16192ac6985aSAndrew Dyer		the soft_i2c driver to perform an I2C repeated start
16202ac6985aSAndrew Dyer		between writing the address pointer and reading the
16212ac6985aSAndrew Dyer		data.  If this define is omitted the default behaviour
16222ac6985aSAndrew Dyer		of doing a stop-start sequence will be used.  Most I2C
16232ac6985aSAndrew Dyer		devices can use either method, but some require one or
16242ac6985aSAndrew Dyer		the other.
1625be5e6181STimur Tabi
1626c609719bSwdenk- SPI Support:	CONFIG_SPI
1627c609719bSwdenk
1628c609719bSwdenk		Enables SPI driver (so far only tested with
1629c609719bSwdenk		SPI EEPROM, also an instance works with Crystal A/D and
1630c609719bSwdenk		D/As on the SACSng board)
1631c609719bSwdenk
1632c609719bSwdenk		CONFIG_SPI_X
1633c609719bSwdenk
1634c609719bSwdenk		Enables extended (16-bit) SPI EEPROM addressing.
1635c609719bSwdenk		(symmetrical to CONFIG_I2C_X)
1636c609719bSwdenk
1637c609719bSwdenk		CONFIG_SOFT_SPI
1638c609719bSwdenk
1639c609719bSwdenk		Enables a software (bit-bang) SPI driver rather than
1640c609719bSwdenk		using hardware support. This is a general purpose
1641c609719bSwdenk		driver that only requires three general I/O port pins
1642c609719bSwdenk		(two outputs, one input) to function. If this is
1643c609719bSwdenk		defined, the board configuration must define several
1644c609719bSwdenk		SPI configuration items (port pins to use, etc). For
1645c609719bSwdenk		an example, see include/configs/sacsng.h.
1646c609719bSwdenk
164704a9e118SBen Warren		CONFIG_HARD_SPI
164804a9e118SBen Warren
164904a9e118SBen Warren		Enables a hardware SPI driver for general-purpose reads
165004a9e118SBen Warren		and writes.  As with CONFIG_SOFT_SPI, the board configuration
165104a9e118SBen Warren		must define a list of chip-select function pointers.
165204a9e118SBen Warren		Currently supported on some MPC8xxx processors.  For an
165304a9e118SBen Warren		example, see include/configs/mpc8349emds.h.
165404a9e118SBen Warren
165538254f45SGuennadi Liakhovetski		CONFIG_MXC_SPI
165638254f45SGuennadi Liakhovetski
165738254f45SGuennadi Liakhovetski		Enables the driver for the SPI controllers on i.MX and MXC
165838254f45SGuennadi Liakhovetski		SoCs. Currently only i.MX31 is supported.
165938254f45SGuennadi Liakhovetski
16600133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA
16610133502eSMatthias Fuchs
16620133502eSMatthias Fuchs		Enables FPGA subsystem.
16630133502eSMatthias Fuchs
16640133502eSMatthias Fuchs		CONFIG_FPGA_<vendor>
16650133502eSMatthias Fuchs
16660133502eSMatthias Fuchs		Enables support for specific chip vendors.
16670133502eSMatthias Fuchs		(ALTERA, XILINX)
16680133502eSMatthias Fuchs
16690133502eSMatthias Fuchs		CONFIG_FPGA_<family>
16700133502eSMatthias Fuchs
16710133502eSMatthias Fuchs		Enables support for FPGA family.
16720133502eSMatthias Fuchs		(SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
16730133502eSMatthias Fuchs
16740133502eSMatthias Fuchs		CONFIG_FPGA_COUNT
1675c609719bSwdenk
1676c609719bSwdenk		Specify the number of FPGA devices to support.
1677c609719bSwdenk
16786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_PROG_FEEDBACK
1679c609719bSwdenk
1680c609719bSwdenk		Enable printing of hash marks during FPGA configuration.
1681c609719bSwdenk
16826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_BUSY
1683c609719bSwdenk
1684c609719bSwdenk		Enable checks on FPGA configuration interface busy
1685c609719bSwdenk		status by the configuration function. This option
1686c609719bSwdenk		will require a board or device specific function to
1687c609719bSwdenk		be written.
1688c609719bSwdenk
1689c609719bSwdenk		CONFIG_FPGA_DELAY
1690c609719bSwdenk
1691c609719bSwdenk		If defined, a function that provides delays in the FPGA
1692c609719bSwdenk		configuration driver.
1693c609719bSwdenk
16946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_CTRLC
1695c609719bSwdenk		Allow Control-C to interrupt FPGA configuration
1696c609719bSwdenk
16976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_ERROR
1698c609719bSwdenk
1699c609719bSwdenk		Check for configuration errors during FPGA bitfile
1700c609719bSwdenk		loading. For example, abort during Virtex II
1701c609719bSwdenk		configuration if the INIT_B line goes low (which
1702c609719bSwdenk		indicated a CRC error).
1703c609719bSwdenk
17046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_INIT
1705c609719bSwdenk
1706c609719bSwdenk		Maximum time to wait for the INIT_B line to deassert
1707c609719bSwdenk		after PROB_B has been deasserted during a Virtex II
1708c609719bSwdenk		FPGA configuration sequence. The default time is 500
170911ccc33fSMarcel Ziswiler		ms.
1710c609719bSwdenk
17116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_BUSY
1712c609719bSwdenk
1713c609719bSwdenk		Maximum time to wait for BUSY to deassert during
171411ccc33fSMarcel Ziswiler		Virtex II FPGA configuration. The default is 5 ms.
1715c609719bSwdenk
17166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_CONFIG
1717c609719bSwdenk
1718c609719bSwdenk		Time to wait after FPGA configuration. The default is
171911ccc33fSMarcel Ziswiler		200 ms.
1720c609719bSwdenk
1721c609719bSwdenk- Configuration Management:
1722c609719bSwdenk		CONFIG_IDENT_STRING
1723c609719bSwdenk
1724c609719bSwdenk		If defined, this string will be added to the U-Boot
1725c609719bSwdenk		version information (U_BOOT_VERSION)
1726c609719bSwdenk
1727c609719bSwdenk- Vendor Parameter Protection:
1728c609719bSwdenk
1729c609719bSwdenk		U-Boot considers the values of the environment
1730c609719bSwdenk		variables "serial#" (Board Serial Number) and
17317152b1d0Swdenk		"ethaddr" (Ethernet Address) to be parameters that
1732c609719bSwdenk		are set once by the board vendor / manufacturer, and
1733c609719bSwdenk		protects these variables from casual modification by
1734c609719bSwdenk		the user. Once set, these variables are read-only,
1735c609719bSwdenk		and write or delete attempts are rejected. You can
173611ccc33fSMarcel Ziswiler		change this behaviour:
1737c609719bSwdenk
1738c609719bSwdenk		If CONFIG_ENV_OVERWRITE is #defined in your config
1739c609719bSwdenk		file, the write protection for vendor parameters is
174047cd00faSwdenk		completely disabled. Anybody can change or delete
1741c609719bSwdenk		these parameters.
1742c609719bSwdenk
1743c609719bSwdenk		Alternatively, if you #define _both_ CONFIG_ETHADDR
1744c609719bSwdenk		_and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
174511ccc33fSMarcel Ziswiler		Ethernet address is installed in the environment,
1746c609719bSwdenk		which can be changed exactly ONCE by the user. [The
1747c609719bSwdenk		serial# is unaffected by this, i. e. it remains
1748c609719bSwdenk		read-only.]
1749c609719bSwdenk
1750c609719bSwdenk- Protected RAM:
1751c609719bSwdenk		CONFIG_PRAM
1752c609719bSwdenk
1753c609719bSwdenk		Define this variable to enable the reservation of
1754c609719bSwdenk		"protected RAM", i. e. RAM which is not overwritten
1755c609719bSwdenk		by U-Boot. Define CONFIG_PRAM to hold the number of
1756c609719bSwdenk		kB you want to reserve for pRAM. You can overwrite
1757c609719bSwdenk		this default value by defining an environment
1758c609719bSwdenk		variable "pram" to the number of kB you want to
1759c609719bSwdenk		reserve. Note that the board info structure will
1760c609719bSwdenk		still show the full amount of RAM. If pRAM is
1761c609719bSwdenk		reserved, a new environment variable "mem" will
1762c609719bSwdenk		automatically be defined to hold the amount of
1763c609719bSwdenk		remaining RAM in a form that can be passed as boot
1764c609719bSwdenk		argument to Linux, for instance like that:
1765c609719bSwdenk
1766fe126d8bSWolfgang Denk			setenv bootargs ... mem=\${mem}
1767c609719bSwdenk			saveenv
1768c609719bSwdenk
1769c609719bSwdenk		This way you can tell Linux not to use this memory,
1770c609719bSwdenk		either, which results in a memory region that will
1771c609719bSwdenk		not be affected by reboots.
1772c609719bSwdenk
1773c609719bSwdenk		*WARNING* If your board configuration uses automatic
1774c609719bSwdenk		detection of the RAM size, you must make sure that
1775c609719bSwdenk		this memory test is non-destructive. So far, the
1776c609719bSwdenk		following board configurations are known to be
1777c609719bSwdenk		"pRAM-clean":
1778c609719bSwdenk
1779c609719bSwdenk			ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
1780c609719bSwdenk			HERMES, IP860, RPXlite, LWMON, LANTEC,
1781c609719bSwdenk			PCU_E, FLAGADM, TQM8260
1782c609719bSwdenk
1783c609719bSwdenk- Error Recovery:
1784c609719bSwdenk		CONFIG_PANIC_HANG
1785c609719bSwdenk
1786c609719bSwdenk		Define this variable to stop the system in case of a
1787c609719bSwdenk		fatal error, so that you have to reset it manually.
1788c609719bSwdenk		This is probably NOT a good idea for an embedded
178911ccc33fSMarcel Ziswiler		system where you want the system to reboot
1790c609719bSwdenk		automatically as fast as possible, but it may be
1791c609719bSwdenk		useful during development since you can try to debug
1792c609719bSwdenk		the conditions that lead to the situation.
1793c609719bSwdenk
1794c609719bSwdenk		CONFIG_NET_RETRY_COUNT
1795c609719bSwdenk
1796c609719bSwdenk		This variable defines the number of retries for
1797c609719bSwdenk		network operations like ARP, RARP, TFTP, or BOOTP
1798c609719bSwdenk		before giving up the operation. If not defined, a
1799c609719bSwdenk		default value of 5 is used.
1800c609719bSwdenk
180140cb90eeSGuennadi Liakhovetski		CONFIG_ARP_TIMEOUT
180240cb90eeSGuennadi Liakhovetski
180340cb90eeSGuennadi Liakhovetski		Timeout waiting for an ARP reply in milliseconds.
180440cb90eeSGuennadi Liakhovetski
1805c609719bSwdenk- Command Interpreter:
18068078f1a5SWolfgang Denk		CONFIG_AUTO_COMPLETE
180704a85b3bSwdenk
180804a85b3bSwdenk		Enable auto completion of commands using TAB.
180904a85b3bSwdenk
18108078f1a5SWolfgang Denk		Note that this feature has NOT been implemented yet
18118078f1a5SWolfgang Denk		for the "hush" shell.
18128078f1a5SWolfgang Denk
18138078f1a5SWolfgang Denk
18146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_HUSH_PARSER
1815c609719bSwdenk
1816c609719bSwdenk		Define this variable to enable the "hush" shell (from
1817c609719bSwdenk		Busybox) as command line interpreter, thus enabling
1818c609719bSwdenk		powerful command line syntax like
1819c609719bSwdenk		if...then...else...fi conditionals or `&&' and '||'
1820c609719bSwdenk		constructs ("shell scripts").
1821c609719bSwdenk
1822c609719bSwdenk		If undefined, you get the old, much simpler behaviour
1823c609719bSwdenk		with a somewhat smaller memory footprint.
1824c609719bSwdenk
1825c609719bSwdenk
18266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_PROMPT_HUSH_PS2
1827c609719bSwdenk
1828c609719bSwdenk		This defines the secondary prompt string, which is
1829c609719bSwdenk		printed when the command interpreter needs more input
1830c609719bSwdenk		to complete a command. Usually "> ".
1831c609719bSwdenk
1832c609719bSwdenk	Note:
1833c609719bSwdenk
1834c609719bSwdenk		In the current implementation, the local variables
1835c609719bSwdenk		space and global environment variables space are
1836c609719bSwdenk		separated. Local variables are those you define by
18373b57fe0aSwdenk		simply typing `name=value'. To access a local
1838c609719bSwdenk		variable later on, you have write `$name' or
18393b57fe0aSwdenk		`${name}'; to execute the contents of a variable
18403b57fe0aSwdenk		directly type `$name' at the command prompt.
1841c609719bSwdenk
1842c609719bSwdenk		Global environment variables are those you use
1843c609719bSwdenk		setenv/printenv to work with. To run a command stored
1844c609719bSwdenk		in such a variable, you need to use the run command,
1845c609719bSwdenk		and you must not use the '$' sign to access them.
1846c609719bSwdenk
1847c609719bSwdenk		To store commands and special characters in a
1848c609719bSwdenk		variable, please use double quotation marks
1849c609719bSwdenk		surrounding the whole text of the variable, instead
1850c609719bSwdenk		of the backslashes before semicolons and special
1851c609719bSwdenk		symbols.
1852c609719bSwdenk
1853aa0c71acSWolfgang Denk- Commandline Editing and History:
1854aa0c71acSWolfgang Denk		CONFIG_CMDLINE_EDITING
1855aa0c71acSWolfgang Denk
185611ccc33fSMarcel Ziswiler		Enable editing and History functions for interactive
1857aa0c71acSWolfgang Denk		commandline input operations
1858aa0c71acSWolfgang Denk
1859a8c7c708Swdenk- Default Environment:
1860c609719bSwdenk		CONFIG_EXTRA_ENV_SETTINGS
1861c609719bSwdenk
1862c609719bSwdenk		Define this to contain any number of null terminated
1863c609719bSwdenk		strings (variable = value pairs) that will be part of
18647152b1d0Swdenk		the default environment compiled into the boot image.
18652262cfeeSwdenk
1866c609719bSwdenk		For example, place something like this in your
1867c609719bSwdenk		board's config file:
1868c609719bSwdenk
1869c609719bSwdenk		#define CONFIG_EXTRA_ENV_SETTINGS \
1870c609719bSwdenk			"myvar1=value1\0" \
1871c609719bSwdenk			"myvar2=value2\0"
1872c609719bSwdenk
1873c609719bSwdenk		Warning: This method is based on knowledge about the
1874c609719bSwdenk		internal format how the environment is stored by the
18752262cfeeSwdenk		U-Boot code. This is NOT an official, exported
1876c609719bSwdenk		interface! Although it is unlikely that this format
18777152b1d0Swdenk		will change soon, there is no guarantee either.
1878c609719bSwdenk		You better know what you are doing here.
1879c609719bSwdenk
1880c609719bSwdenk		Note: overly (ab)use of the default environment is
1881c609719bSwdenk		discouraged. Make sure to check other ways to preset
188274de7aefSWolfgang Denk		the environment like the "source" command or the
1883c609719bSwdenk		boot command first.
1884c609719bSwdenk
1885a8c7c708Swdenk- DataFlash Support:
18862abbe075Swdenk		CONFIG_HAS_DATAFLASH
18872abbe075Swdenk
18882abbe075Swdenk		Defining this option enables DataFlash features and
18892abbe075Swdenk		allows to read/write in Dataflash via the standard
18902abbe075Swdenk		commands cp, md...
18912abbe075Swdenk
18923f85ce27Swdenk- SystemACE Support:
18933f85ce27Swdenk		CONFIG_SYSTEMACE
18943f85ce27Swdenk
18953f85ce27Swdenk		Adding this option adds support for Xilinx SystemACE
18963f85ce27Swdenk		chips attached via some sort of local bus. The address
189711ccc33fSMarcel Ziswiler		of the chip must also be defined in the
18986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SYSTEMACE_BASE macro. For example:
18993f85ce27Swdenk
19003f85ce27Swdenk		#define CONFIG_SYSTEMACE
19016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
19023f85ce27Swdenk
19033f85ce27Swdenk		When SystemACE support is added, the "ace" device type
19043f85ce27Swdenk		becomes available to the fat commands, i.e. fatls.
19053f85ce27Swdenk
1906ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port:
1907ecb0ccd9SWolfgang Denk		CONFIG_TFTP_PORT
1908ecb0ccd9SWolfgang Denk
190928cb9375SWolfgang Denk		If this is defined, the environment variable tftpsrcp
1910ecb0ccd9SWolfgang Denk		is used to supply the TFTP UDP source port value.
191128cb9375SWolfgang Denk		If tftpsrcp isn't defined, the normal pseudo-random port
1912ecb0ccd9SWolfgang Denk		number generator is used.
1913ecb0ccd9SWolfgang Denk
191428cb9375SWolfgang Denk		Also, the environment variable tftpdstp is used to supply
191528cb9375SWolfgang Denk		the TFTP UDP destination port value.  If tftpdstp isn't
191628cb9375SWolfgang Denk		defined, the normal port 69 is used.
191728cb9375SWolfgang Denk
191828cb9375SWolfgang Denk		The purpose for tftpsrcp is to allow a TFTP server to
1919ecb0ccd9SWolfgang Denk		blindly start the TFTP transfer using the pre-configured
1920ecb0ccd9SWolfgang Denk		target IP address and UDP port. This has the effect of
1921ecb0ccd9SWolfgang Denk		"punching through" the (Windows XP) firewall, allowing
1922ecb0ccd9SWolfgang Denk		the remainder of the TFTP transfer to proceed normally.
1923ecb0ccd9SWolfgang Denk		A better solution is to properly configure the firewall,
1924ecb0ccd9SWolfgang Denk		but sometimes that is not allowed.
1925ecb0ccd9SWolfgang Denk
1926a8c7c708Swdenk- Show boot progress:
1927c609719bSwdenk		CONFIG_SHOW_BOOT_PROGRESS
1928c609719bSwdenk
1929c609719bSwdenk		Defining this option allows to add some board-
1930c609719bSwdenk		specific code (calling a user-provided function
1931c609719bSwdenk		"show_boot_progress(int)") that enables you to show
1932c609719bSwdenk		the system's boot progress on some display (for
1933c609719bSwdenk		example, some LED's) on your board. At the moment,
1934c609719bSwdenk		the following checkpoints are implemented:
1935c609719bSwdenk
19361372cce2SMarian BalakowiczLegacy uImage format:
19371372cce2SMarian Balakowicz
1938c609719bSwdenk  Arg	Where			When
1939c609719bSwdenk    1	common/cmd_bootm.c	before attempting to boot an image
1940c609719bSwdenk   -1	common/cmd_bootm.c	Image header has bad	 magic number
1941c609719bSwdenk    2	common/cmd_bootm.c	Image header has correct magic number
1942c609719bSwdenk   -2	common/cmd_bootm.c	Image header has bad	 checksum
1943c609719bSwdenk    3	common/cmd_bootm.c	Image header has correct checksum
1944c609719bSwdenk   -3	common/cmd_bootm.c	Image data   has bad	 checksum
1945c609719bSwdenk    4	common/cmd_bootm.c	Image data   has correct checksum
1946c609719bSwdenk   -4	common/cmd_bootm.c	Image is for unsupported architecture
1947c609719bSwdenk    5	common/cmd_bootm.c	Architecture check OK
19481372cce2SMarian Balakowicz   -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi)
1949c609719bSwdenk    6	common/cmd_bootm.c	Image Type check OK
1950c609719bSwdenk   -6	common/cmd_bootm.c	gunzip uncompression error
1951c609719bSwdenk   -7	common/cmd_bootm.c	Unimplemented compression type
1952c609719bSwdenk    7	common/cmd_bootm.c	Uncompression OK
19531372cce2SMarian Balakowicz    8	common/cmd_bootm.c	No uncompress/copy overwrite error
1954c609719bSwdenk   -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
19551372cce2SMarian Balakowicz
19561372cce2SMarian Balakowicz    9	common/image.c		Start initial ramdisk verification
19571372cce2SMarian Balakowicz  -10	common/image.c		Ramdisk header has bad	   magic number
19581372cce2SMarian Balakowicz  -11	common/image.c		Ramdisk header has bad	   checksum
19591372cce2SMarian Balakowicz   10	common/image.c		Ramdisk header is OK
19601372cce2SMarian Balakowicz  -12	common/image.c		Ramdisk data   has bad	   checksum
19611372cce2SMarian Balakowicz   11	common/image.c		Ramdisk data   has correct checksum
19621372cce2SMarian Balakowicz   12	common/image.c		Ramdisk verification complete, start loading
196311ccc33fSMarcel Ziswiler  -13	common/image.c		Wrong Image Type (not PPC Linux ramdisk)
19641372cce2SMarian Balakowicz   13	common/image.c		Start multifile image verification
19651372cce2SMarian Balakowicz   14	common/image.c		No initial ramdisk, no multifile, continue.
19661372cce2SMarian Balakowicz
1967ea0364f1SPeter Tyser   15	arch/<arch>/lib/bootm.c	All preparation done, transferring control to OS
1968c609719bSwdenk
1969*a47a12beSStefan Roese  -30	arch/powerpc/lib/board.c	Fatal error, hang the system
197063e73c9aSwdenk  -31	post/post.c		POST test failed, detected by post_output_backlog()
197163e73c9aSwdenk  -32	post/post.c		POST test failed, detected by post_run_single()
197263e73c9aSwdenk
1973566a494fSHeiko Schocher   34	common/cmd_doc.c	before loading a Image from a DOC device
1974566a494fSHeiko Schocher  -35	common/cmd_doc.c	Bad usage of "doc" command
1975566a494fSHeiko Schocher   35	common/cmd_doc.c	correct usage of "doc" command
1976566a494fSHeiko Schocher  -36	common/cmd_doc.c	No boot device
1977566a494fSHeiko Schocher   36	common/cmd_doc.c	correct boot device
1978566a494fSHeiko Schocher  -37	common/cmd_doc.c	Unknown Chip ID on boot device
1979566a494fSHeiko Schocher   37	common/cmd_doc.c	correct chip ID found, device available
1980566a494fSHeiko Schocher  -38	common/cmd_doc.c	Read Error on boot device
1981566a494fSHeiko Schocher   38	common/cmd_doc.c	reading Image header from DOC device OK
1982566a494fSHeiko Schocher  -39	common/cmd_doc.c	Image header has bad magic number
1983566a494fSHeiko Schocher   39	common/cmd_doc.c	Image header has correct magic number
1984566a494fSHeiko Schocher  -40	common/cmd_doc.c	Error reading Image from DOC device
1985566a494fSHeiko Schocher   40	common/cmd_doc.c	Image header has correct magic number
1986566a494fSHeiko Schocher   41	common/cmd_ide.c	before loading a Image from a IDE device
1987566a494fSHeiko Schocher  -42	common/cmd_ide.c	Bad usage of "ide" command
1988566a494fSHeiko Schocher   42	common/cmd_ide.c	correct usage of "ide" command
1989566a494fSHeiko Schocher  -43	common/cmd_ide.c	No boot device
1990566a494fSHeiko Schocher   43	common/cmd_ide.c	boot device found
1991566a494fSHeiko Schocher  -44	common/cmd_ide.c	Device not available
1992566a494fSHeiko Schocher   44	common/cmd_ide.c	Device available
1993566a494fSHeiko Schocher  -45	common/cmd_ide.c	wrong partition selected
1994566a494fSHeiko Schocher   45	common/cmd_ide.c	partition selected
1995566a494fSHeiko Schocher  -46	common/cmd_ide.c	Unknown partition table
1996566a494fSHeiko Schocher   46	common/cmd_ide.c	valid partition table found
1997566a494fSHeiko Schocher  -47	common/cmd_ide.c	Invalid partition type
1998566a494fSHeiko Schocher   47	common/cmd_ide.c	correct partition type
1999566a494fSHeiko Schocher  -48	common/cmd_ide.c	Error reading Image Header on boot device
2000566a494fSHeiko Schocher   48	common/cmd_ide.c	reading Image Header from IDE device OK
2001566a494fSHeiko Schocher  -49	common/cmd_ide.c	Image header has bad magic number
2002566a494fSHeiko Schocher   49	common/cmd_ide.c	Image header has correct magic number
2003566a494fSHeiko Schocher  -50	common/cmd_ide.c	Image header has bad	 checksum
2004566a494fSHeiko Schocher   50	common/cmd_ide.c	Image header has correct checksum
2005566a494fSHeiko Schocher  -51	common/cmd_ide.c	Error reading Image from IDE device
2006566a494fSHeiko Schocher   51	common/cmd_ide.c	reading Image from IDE device OK
2007566a494fSHeiko Schocher   52	common/cmd_nand.c	before loading a Image from a NAND device
2008566a494fSHeiko Schocher  -53	common/cmd_nand.c	Bad usage of "nand" command
2009566a494fSHeiko Schocher   53	common/cmd_nand.c	correct usage of "nand" command
2010566a494fSHeiko Schocher  -54	common/cmd_nand.c	No boot device
2011566a494fSHeiko Schocher   54	common/cmd_nand.c	boot device found
2012566a494fSHeiko Schocher  -55	common/cmd_nand.c	Unknown Chip ID on boot device
2013566a494fSHeiko Schocher   55	common/cmd_nand.c	correct chip ID found, device available
2014566a494fSHeiko Schocher  -56	common/cmd_nand.c	Error reading Image Header on boot device
2015566a494fSHeiko Schocher   56	common/cmd_nand.c	reading Image Header from NAND device OK
2016566a494fSHeiko Schocher  -57	common/cmd_nand.c	Image header has bad magic number
2017566a494fSHeiko Schocher   57	common/cmd_nand.c	Image header has correct magic number
2018566a494fSHeiko Schocher  -58	common/cmd_nand.c	Error reading Image from NAND device
2019566a494fSHeiko Schocher   58	common/cmd_nand.c	reading Image from NAND device OK
2020c609719bSwdenk
2021566a494fSHeiko Schocher  -60	common/env_common.c	Environment has a bad CRC, using default
2022c609719bSwdenk
2023566a494fSHeiko Schocher   64	net/eth.c		starting with Ethernet configuration.
2024566a494fSHeiko Schocher  -64	net/eth.c		no Ethernet found.
2025566a494fSHeiko Schocher   65	net/eth.c		Ethernet found.
2026206c60cbSwdenk
2027566a494fSHeiko Schocher  -80	common/cmd_net.c	usage wrong
2028566a494fSHeiko Schocher   80	common/cmd_net.c	before calling NetLoop()
202911ccc33fSMarcel Ziswiler  -81	common/cmd_net.c	some error in NetLoop() occurred
2030566a494fSHeiko Schocher   81	common/cmd_net.c	NetLoop() back without error
2031566a494fSHeiko Schocher  -82	common/cmd_net.c	size == 0 (File with size 0 loaded)
2032566a494fSHeiko Schocher   82	common/cmd_net.c	trying automatic boot
203374de7aefSWolfgang Denk   83	common/cmd_net.c	running "source" command
203474de7aefSWolfgang Denk  -83	common/cmd_net.c	some error in automatic boot or "source" command
2035566a494fSHeiko Schocher   84	common/cmd_net.c	end without errors
2036c609719bSwdenk
20371372cce2SMarian BalakowiczFIT uImage format:
20381372cce2SMarian Balakowicz
20391372cce2SMarian Balakowicz  Arg	Where			When
20401372cce2SMarian Balakowicz  100	common/cmd_bootm.c	Kernel FIT Image has correct format
20411372cce2SMarian Balakowicz -100	common/cmd_bootm.c	Kernel FIT Image has incorrect format
20421372cce2SMarian Balakowicz  101	common/cmd_bootm.c	No Kernel subimage unit name, using configuration
20431372cce2SMarian Balakowicz -101	common/cmd_bootm.c	Can't get configuration for kernel subimage
20441372cce2SMarian Balakowicz  102	common/cmd_bootm.c	Kernel unit name specified
20451372cce2SMarian Balakowicz -103	common/cmd_bootm.c	Can't get kernel subimage node offset
2046f773bea8SMarian Balakowicz  103	common/cmd_bootm.c	Found configuration node
20471372cce2SMarian Balakowicz  104	common/cmd_bootm.c	Got kernel subimage node offset
20481372cce2SMarian Balakowicz -104	common/cmd_bootm.c	Kernel subimage hash verification failed
20491372cce2SMarian Balakowicz  105	common/cmd_bootm.c	Kernel subimage hash verification OK
20501372cce2SMarian Balakowicz -105	common/cmd_bootm.c	Kernel subimage is for unsupported architecture
20511372cce2SMarian Balakowicz  106	common/cmd_bootm.c	Architecture check OK
205211ccc33fSMarcel Ziswiler -106	common/cmd_bootm.c	Kernel subimage has wrong type
205311ccc33fSMarcel Ziswiler  107	common/cmd_bootm.c	Kernel subimage type OK
20541372cce2SMarian Balakowicz -107	common/cmd_bootm.c	Can't get kernel subimage data/size
20551372cce2SMarian Balakowicz  108	common/cmd_bootm.c	Got kernel subimage data/size
20561372cce2SMarian Balakowicz -108	common/cmd_bootm.c	Wrong image type (not legacy, FIT)
20571372cce2SMarian Balakowicz -109	common/cmd_bootm.c	Can't get kernel subimage type
20581372cce2SMarian Balakowicz -110	common/cmd_bootm.c	Can't get kernel subimage comp
20591372cce2SMarian Balakowicz -111	common/cmd_bootm.c	Can't get kernel subimage os
20601372cce2SMarian Balakowicz -112	common/cmd_bootm.c	Can't get kernel subimage load address
20611372cce2SMarian Balakowicz -113	common/cmd_bootm.c	Image uncompress/copy overwrite error
20621372cce2SMarian Balakowicz
20631372cce2SMarian Balakowicz  120	common/image.c		Start initial ramdisk verification
20641372cce2SMarian Balakowicz -120	common/image.c		Ramdisk FIT image has incorrect format
20651372cce2SMarian Balakowicz  121	common/image.c		Ramdisk FIT image has correct format
206611ccc33fSMarcel Ziswiler  122	common/image.c		No ramdisk subimage unit name, using configuration
20671372cce2SMarian Balakowicz -122	common/image.c		Can't get configuration for ramdisk subimage
20681372cce2SMarian Balakowicz  123	common/image.c		Ramdisk unit name specified
20691372cce2SMarian Balakowicz -124	common/image.c		Can't get ramdisk subimage node offset
20701372cce2SMarian Balakowicz  125	common/image.c		Got ramdisk subimage node offset
20711372cce2SMarian Balakowicz -125	common/image.c		Ramdisk subimage hash verification failed
20721372cce2SMarian Balakowicz  126	common/image.c		Ramdisk subimage hash verification OK
20731372cce2SMarian Balakowicz -126	common/image.c		Ramdisk subimage for unsupported architecture
20741372cce2SMarian Balakowicz  127	common/image.c		Architecture check OK
20751372cce2SMarian Balakowicz -127	common/image.c		Can't get ramdisk subimage data/size
20761372cce2SMarian Balakowicz  128	common/image.c		Got ramdisk subimage data/size
20771372cce2SMarian Balakowicz  129	common/image.c		Can't get ramdisk load address
20781372cce2SMarian Balakowicz -129	common/image.c		Got ramdisk load address
20791372cce2SMarian Balakowicz
208011ccc33fSMarcel Ziswiler -130	common/cmd_doc.c	Incorrect FIT image format
20811372cce2SMarian Balakowicz  131	common/cmd_doc.c	FIT image format OK
20821372cce2SMarian Balakowicz
208311ccc33fSMarcel Ziswiler -140	common/cmd_ide.c	Incorrect FIT image format
20841372cce2SMarian Balakowicz  141	common/cmd_ide.c	FIT image format OK
20851372cce2SMarian Balakowicz
208611ccc33fSMarcel Ziswiler -150	common/cmd_nand.c	Incorrect FIT image format
20871372cce2SMarian Balakowicz  151	common/cmd_nand.c	FIT image format OK
20881372cce2SMarian Balakowicz
2089cccfc2abSDetlev Zundel- Automatic software updates via TFTP server
2090cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP
2091cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_CNT_MAX
2092cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_MSEC_MAX
2093cccfc2abSDetlev Zundel
2094cccfc2abSDetlev Zundel		These options enable and control the auto-update feature;
2095cccfc2abSDetlev Zundel		for a more detailed description refer to doc/README.update.
2096cccfc2abSDetlev Zundel
2097cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support)
2098cccfc2abSDetlev Zundel		CONFIG_MTD_DEVICE
2099cccfc2abSDetlev Zundel
2100cccfc2abSDetlev Zundel		Adds the MTD device infrastructure from the Linux kernel.
2101cccfc2abSDetlev Zundel		Needed for mtdparts command support.
2102cccfc2abSDetlev Zundel
2103cccfc2abSDetlev Zundel		CONFIG_MTD_PARTITIONS
2104cccfc2abSDetlev Zundel
2105cccfc2abSDetlev Zundel		Adds the MTD partitioning infrastructure from the Linux
2106cccfc2abSDetlev Zundel		kernel. Needed for UBI support.
2107cccfc2abSDetlev Zundel
21081372cce2SMarian Balakowicz
2109c609719bSwdenkModem Support:
2110c609719bSwdenk--------------
2111c609719bSwdenk
211285ec0bccSwdenk[so far only for SMDK2400 and TRAB boards]
2113c609719bSwdenk
211411ccc33fSMarcel Ziswiler- Modem support enable:
2115c609719bSwdenk		CONFIG_MODEM_SUPPORT
2116c609719bSwdenk
2117c609719bSwdenk- RTS/CTS Flow control enable:
2118c609719bSwdenk		CONFIG_HWFLOW
2119c609719bSwdenk
2120c609719bSwdenk- Modem debug support:
2121c609719bSwdenk		CONFIG_MODEM_SUPPORT_DEBUG
2122c609719bSwdenk
2123c609719bSwdenk		Enables debugging stuff (char screen[1024], dbg())
2124c609719bSwdenk		for modem support. Useful only with BDI2000.
2125c609719bSwdenk
2126a8c7c708Swdenk- Interrupt support (PPC):
2127a8c7c708Swdenk
2128a8c7c708Swdenk		There are common interrupt_init() and timer_interrupt()
2129a8c7c708Swdenk		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
213011ccc33fSMarcel Ziswiler		for CPU specific initialization. interrupt_init_cpu()
2131a8c7c708Swdenk		should set decrementer_count to appropriate value. If
213211ccc33fSMarcel Ziswiler		CPU resets decrementer automatically after interrupt
2133a8c7c708Swdenk		(ppc4xx) it should set decrementer_count to zero.
213411ccc33fSMarcel Ziswiler		timer_interrupt() calls timer_interrupt_cpu() for CPU
2135a8c7c708Swdenk		specific handling. If board has watchdog / status_led
2136a8c7c708Swdenk		/ other_activity_monitor it works automatically from
2137a8c7c708Swdenk		general timer_interrupt().
2138a8c7c708Swdenk
2139c609719bSwdenk- General:
2140c609719bSwdenk
2141c609719bSwdenk		In the target system modem support is enabled when a
2142c609719bSwdenk		specific key (key combination) is pressed during
2143c609719bSwdenk		power-on. Otherwise U-Boot will boot normally
214411ccc33fSMarcel Ziswiler		(autoboot). The key_pressed() function is called from
2145c609719bSwdenk		board_init(). Currently key_pressed() is a dummy
2146c609719bSwdenk		function, returning 1 and thus enabling modem
2147c609719bSwdenk		initialization.
2148c609719bSwdenk
2149c609719bSwdenk		If there are no modem init strings in the
2150c609719bSwdenk		environment, U-Boot proceed to autoboot; the
2151c609719bSwdenk		previous output (banner, info printfs) will be
215211ccc33fSMarcel Ziswiler		suppressed, though.
2153c609719bSwdenk
2154c609719bSwdenk		See also: doc/README.Modem
2155c609719bSwdenk
2156c609719bSwdenk
2157c609719bSwdenkConfiguration Settings:
2158c609719bSwdenk-----------------------
2159c609719bSwdenk
21606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
2161c609719bSwdenk		undefine this when you're short of memory.
2162c609719bSwdenk
21632fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
21642fb2604dSPeter Tyser		width of the commands listed in the 'help' command output.
21652fb2604dSPeter Tyser
21666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT:	This is what U-Boot prints on the console to
2167c609719bSwdenk		prompt for user input.
2168c609719bSwdenk
21696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE:	Buffer size for input from the Console
2170c609719bSwdenk
21716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE:	Buffer size for Console output
2172c609719bSwdenk
21736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS:	max. Number of arguments accepted for monitor commands
2174c609719bSwdenk
21756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
2176c609719bSwdenk		the application (usually a Linux kernel) when it is
2177c609719bSwdenk		booted
2178c609719bSwdenk
21796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE:
2180c609719bSwdenk		List of legal baudrate settings for this board.
2181c609719bSwdenk
21826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_INFO_QUIET
2183c609719bSwdenk		Suppress display of console information at boot.
2184c609719bSwdenk
21856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_IS_IN_ENV
2186c609719bSwdenk		If the board specific function
2187c609719bSwdenk			extern int overwrite_console (void);
2188c609719bSwdenk		returns 1, the stdin, stderr and stdout are switched to the
2189c609719bSwdenk		serial port, else the settings in the environment are used.
2190c609719bSwdenk
21916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
2192c609719bSwdenk		Enable the call to overwrite_console().
2193c609719bSwdenk
21946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
2195c609719bSwdenk		Enable overwrite of previous console environment settings.
2196c609719bSwdenk
21976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
2198c609719bSwdenk		Begin and End addresses of the area used by the
2199c609719bSwdenk		simple memory test.
2200c609719bSwdenk
22016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST:
2202c609719bSwdenk		Enable an alternate, more extensive memory test.
2203c609719bSwdenk
22046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH:
22055f535fe1Swdenk		Scratch address used by the alternate memory test
22065f535fe1Swdenk		You only need to set this if address zero isn't writeable
22075f535fe1Swdenk
22086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
22096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
221014f73ca6SStefan Roese		this specified memory area will get subtracted from the top
221111ccc33fSMarcel Ziswiler		(end) of RAM and won't get "touched" at all by U-Boot. By
221214f73ca6SStefan Roese		fixing up gd->ram_size the Linux kernel should gets passed
221314f73ca6SStefan Roese		the now "corrected" memory size and won't touch it either.
221414f73ca6SStefan Roese		This should work for arch/ppc and arch/powerpc. Only Linux
22155e12e75dSStefan Roese		board ports in arch/powerpc with bootwrapper support that
221614f73ca6SStefan Roese		recalculate the memory size from the SDRAM controller setup
22175e12e75dSStefan Roese		will have to get fixed in Linux additionally.
221814f73ca6SStefan Roese
221914f73ca6SStefan Roese		This option can be used as a workaround for the 440EPx/GRx
222014f73ca6SStefan Roese		CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
222114f73ca6SStefan Roese		be touched.
222214f73ca6SStefan Roese
222314f73ca6SStefan Roese		WARNING: Please make sure that this value is a multiple of
222414f73ca6SStefan Roese		the Linux page size (normally 4k). If this is not the case,
222514f73ca6SStefan Roese		then the end address of the Linux memory will be located at a
222614f73ca6SStefan Roese		non page size aligned address and this could cause major
222714f73ca6SStefan Roese		problems.
222814f73ca6SStefan Roese
22296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TFTP_LOADADDR:
2230c609719bSwdenk		Default load address for network file downloads
2231c609719bSwdenk
22326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE:
2233c609719bSwdenk		Enable temporary baudrate change while serial download
2234c609719bSwdenk
22356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE:
2236c609719bSwdenk		Physical start address of SDRAM. _Must_ be 0 here.
2237c609719bSwdenk
22386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MBIO_BASE:
2239c609719bSwdenk		Physical start address of Motherboard I/O (if using a
2240c609719bSwdenk		Cogent motherboard)
2241c609719bSwdenk
22426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE:
2243c609719bSwdenk		Physical start address of Flash memory.
2244c609719bSwdenk
22456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE:
2246c609719bSwdenk		Physical start address of boot monitor code (set by
2247c609719bSwdenk		make config files to be same as the text base address
2248c609719bSwdenk		(TEXT_BASE) used when linking) - same as
22496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FLASH_BASE when booting from flash.
2250c609719bSwdenk
22516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN:
22523b57fe0aSwdenk		Size of memory reserved for monitor code, used to
22533b57fe0aSwdenk		determine _at_compile_time_ (!) if the environment is
22543b57fe0aSwdenk		embedded within the U-Boot image, or in a separate
22553b57fe0aSwdenk		flash sector.
2256c609719bSwdenk
22576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN:
2258c609719bSwdenk		Size of DRAM reserved for malloc() use.
2259c609719bSwdenk
22606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN:
226115940c9aSStefan Roese		Normally compressed uImages are limited to an
226215940c9aSStefan Roese		uncompressed size of 8 MBytes. If this is not enough,
22636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		you can define CONFIG_SYS_BOOTM_LEN in your board config file
226415940c9aSStefan Roese		to adjust this setting to your needs.
2265c609719bSwdenk
22666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ:
2267c609719bSwdenk		Maximum size of memory mapped by the startup code of
2268c609719bSwdenk		the Linux kernel; all data that must be processed by
22697d721e34SBartlomiej Sieka		the Linux kernel (bd_info, boot arguments, FDT blob if
22707d721e34SBartlomiej Sieka		used) must be put below this limit, unless "bootm_low"
22717d721e34SBartlomiej Sieka		enviroment variable is defined and non-zero. In such case
22727d721e34SBartlomiej Sieka		all data for the Linux kernel must be between "bootm_low"
22736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.
2274c609719bSwdenk
22756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS:
2276c609719bSwdenk		Max number of Flash memory banks
2277c609719bSwdenk
22786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT:
2279c609719bSwdenk		Max number of sectors on a Flash chip
2280c609719bSwdenk
22816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT:
2282c609719bSwdenk		Timeout for Flash erase operations (in ms)
2283c609719bSwdenk
22846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT:
2285c609719bSwdenk		Timeout for Flash write operations (in ms)
2286c609719bSwdenk
22876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT
22888564acf9Swdenk		Timeout for Flash set sector lock bit operation (in ms)
22898564acf9Swdenk
22906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT
22918564acf9Swdenk		Timeout for Flash clear lock bits operation (in ms)
22928564acf9Swdenk
22936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION
22948564acf9Swdenk		If defined, hardware flash sectors protection is used
22958564acf9Swdenk		instead of U-Boot software protection.
22968564acf9Swdenk
22976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP:
2298c609719bSwdenk
2299c609719bSwdenk		Enable TFTP transfers directly to flash memory;
2300c609719bSwdenk		without this option such a download has to be
2301c609719bSwdenk		performed in two steps: (1) download to RAM, and (2)
2302c609719bSwdenk		copy from RAM to flash.
2303c609719bSwdenk
2304c609719bSwdenk		The two-step approach is usually more reliable, since
2305c609719bSwdenk		you can check if the download worked before you erase
230611ccc33fSMarcel Ziswiler		the flash, but in some situations (when system RAM is
230711ccc33fSMarcel Ziswiler		too limited to allow for a temporary copy of the
2308c609719bSwdenk		downloaded image) this option may be very useful.
2309c609719bSwdenk
23106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI:
2311c609719bSwdenk		Define if the flash driver uses extra elements in the
23125653fc33Swdenk		common flash structure for storing flash geometry.
23135653fc33Swdenk
231400b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER
23155653fc33Swdenk		This option also enables the building of the cfi_flash driver
23165653fc33Swdenk		in the drivers directory
231753cf9435Sstroese
231891809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD
231991809ed5SPiotr Ziecik		This option enables the building of the cfi_mtd driver
232091809ed5SPiotr Ziecik		in the drivers directory. The driver exports CFI flash
232191809ed5SPiotr Ziecik		to the MTD layer.
232291809ed5SPiotr Ziecik
23236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
232496ef831fSGuennadi Liakhovetski		Use buffered writes to flash.
232596ef831fSGuennadi Liakhovetski
232696ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N
232796ef831fSGuennadi Liakhovetski		s29ws-n MirrorBit flash has non-standard addresses for buffered
232896ef831fSGuennadi Liakhovetski		write commands.
232996ef831fSGuennadi Liakhovetski
23306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST
23315568e613SStefan Roese		If this option is defined, the common CFI flash doesn't
23325568e613SStefan Roese		print it's warning upon not recognized FLASH banks. This
23335568e613SStefan Roese		is useful, if some of the configured banks are only
23345568e613SStefan Roese		optionally available.
23355568e613SStefan Roese
23369a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS
23379a042e9cSJerry Van Baren		If defined (must be an integer), print out countdown
23389a042e9cSJerry Van Baren		digits and dots.  Recommended value: 45 (9..1) for 80
23399a042e9cSJerry Van Baren		column displays, 15 (3..1) for 40 column displays.
23409a042e9cSJerry Van Baren
23416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER:
234211ccc33fSMarcel Ziswiler		Defines the number of Ethernet receive buffers. On some
234311ccc33fSMarcel Ziswiler		Ethernet controllers it is recommended to set this value
234453cf9435Sstroese		to 8 or even higher (EEPRO100 or 405 EMAC), since all
234553cf9435Sstroese		buffers can be full shortly after enabling the interface
234611ccc33fSMarcel Ziswiler		on high Ethernet traffic.
234753cf9435Sstroese		Defaults to 4 if not defined.
2348c609719bSwdenk
2349c609719bSwdenkThe following definitions that deal with the placement and management
2350c609719bSwdenkof environment data (variable area); in general, we support the
2351c609719bSwdenkfollowing configurations:
2352c609719bSwdenk
23535a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH:
2354c609719bSwdenk
2355c609719bSwdenk	Define this if the environment is in flash memory.
2356c609719bSwdenk
2357c609719bSwdenk	a) The environment occupies one whole flash sector, which is
2358c609719bSwdenk	   "embedded" in the text segment with the U-Boot code. This
2359c609719bSwdenk	   happens usually with "bottom boot sector" or "top boot
2360c609719bSwdenk	   sector" type flash chips, which have several smaller
2361c609719bSwdenk	   sectors at the start or the end. For instance, such a
2362c609719bSwdenk	   layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
2363c609719bSwdenk	   such a case you would place the environment in one of the
2364c609719bSwdenk	   4 kB sectors - with U-Boot code before and after it. With
2365c609719bSwdenk	   "top boot sector" type flash chips, you would put the
2366c609719bSwdenk	   environment in one of the last sectors, leaving a gap
2367c609719bSwdenk	   between U-Boot and the environment.
2368c609719bSwdenk
23690e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
2370c609719bSwdenk
2371c609719bSwdenk	   Offset of environment data (variable area) to the
2372c609719bSwdenk	   beginning of flash memory; for instance, with bottom boot
2373c609719bSwdenk	   type flash chips the second sector can be used: the offset
2374c609719bSwdenk	   for this sector is given here.
2375c609719bSwdenk
23766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
2377c609719bSwdenk
23780e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
2379c609719bSwdenk
2380c609719bSwdenk	   This is just another way to specify the start address of
2381c609719bSwdenk	   the flash sector containing the environment (instead of
23820e8d1586SJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET).
2383c609719bSwdenk
23840e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SECT_SIZE:
2385c609719bSwdenk
2386c609719bSwdenk	   Size of the sector containing the environment.
2387c609719bSwdenk
2388c609719bSwdenk
2389c609719bSwdenk	b) Sometimes flash chips have few, equal sized, BIG sectors.
2390c609719bSwdenk	   In such a case you don't want to spend a whole sector for
2391c609719bSwdenk	   the environment.
2392c609719bSwdenk
23930e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
2394c609719bSwdenk
23955a1aceb0SJean-Christophe PLAGNIOL-VILLARD	   If you use this in combination with CONFIG_ENV_IS_IN_FLASH
23960e8d1586SJean-Christophe PLAGNIOL-VILLARD	   and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
2397c609719bSwdenk	   of this flash sector for the environment. This saves
2398c609719bSwdenk	   memory for the RAM copy of the environment.
2399c609719bSwdenk
2400c609719bSwdenk	   It may also save flash memory if you decide to use this
2401c609719bSwdenk	   when your environment is "embedded" within U-Boot code,
2402c609719bSwdenk	   since then the remainder of the flash sector could be used
2403c609719bSwdenk	   for U-Boot code. It should be pointed out that this is
2404c609719bSwdenk	   STRONGLY DISCOURAGED from a robustness point of view:
2405c609719bSwdenk	   updating the environment in flash makes it always
2406c609719bSwdenk	   necessary to erase the WHOLE sector. If something goes
2407c609719bSwdenk	   wrong before the contents has been restored from a copy in
2408c609719bSwdenk	   RAM, your target system will be dead.
2409c609719bSwdenk
24100e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR_REDUND
24110e8d1586SJean-Christophe PLAGNIOL-VILLARD	  CONFIG_ENV_SIZE_REDUND
2412c609719bSwdenk
2413c609719bSwdenk	   These settings describe a second storage area used to hold
241411ccc33fSMarcel Ziswiler	   a redundant copy of the environment data, so that there is
24153e38691eSwdenk	   a valid backup copy in case there is a power failure during
2416c609719bSwdenk	   a "saveenv" operation.
2417c609719bSwdenk
2418c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the
2419c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds*
2420c609719bSwdenkaccordingly!
2421c609719bSwdenk
2422c609719bSwdenk
24239314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM:
2424c609719bSwdenk
2425c609719bSwdenk	Define this if you have some non-volatile memory device
2426c609719bSwdenk	(NVRAM, battery buffered SRAM) which you want to use for the
2427c609719bSwdenk	environment.
2428c609719bSwdenk
24290e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
24300e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
2431c609719bSwdenk
243211ccc33fSMarcel Ziswiler	  These two #defines are used to determine the memory area you
2433c609719bSwdenk	  want to use for environment. It is assumed that this memory
2434c609719bSwdenk	  can just be read and written to, without any special
2435c609719bSwdenk	  provision.
2436c609719bSwdenk
2437c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early
2438c609719bSwdenkin U-Boot initalization (when we try to get the setting of for the
243911ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or
2440c609719bSwdenkU-Boot will hang.
2441c609719bSwdenk
2442c609719bSwdenkPlease note that even with NVRAM we still use a copy of the
2443c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to
2444c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv"
2445c609719bSwdenkto save the current settings.
2446c609719bSwdenk
2447c609719bSwdenk
2448bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM:
2449c609719bSwdenk
2450c609719bSwdenk	Use this if you have an EEPROM or similar serial access
2451c609719bSwdenk	device and a driver for it.
2452c609719bSwdenk
24530e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
24540e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
2455c609719bSwdenk
2456c609719bSwdenk	  These two #defines specify the offset and size of the
2457c609719bSwdenk	  environment area within the total memory of your EEPROM.
2458c609719bSwdenk
24596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR:
2460c609719bSwdenk	  If defined, specified the chip address of the EEPROM device.
2461c609719bSwdenk	  The default address is zero.
2462c609719bSwdenk
24636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
2464c609719bSwdenk	  If defined, the number of bits used to address bytes in a
2465c609719bSwdenk	  single page in the EEPROM device.  A 64 byte page, for example
2466c609719bSwdenk	  would require six bits.
2467c609719bSwdenk
24686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
2469c609719bSwdenk	  If defined, the number of milliseconds to delay between
2470c609719bSwdenk	  page writes.	The default is zero milliseconds.
2471c609719bSwdenk
24726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
2473c609719bSwdenk	  The length in bytes of the EEPROM memory array address.  Note
2474c609719bSwdenk	  that this is NOT the chip address length!
2475c609719bSwdenk
24766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
24775cf91d6bSwdenk	  EEPROM chips that implement "address overflow" are ones
24785cf91d6bSwdenk	  like Catalyst 24WC04/08/16 which has 9/10/11 bits of
24795cf91d6bSwdenk	  address and the extra bits end up in the "chip address" bit
24805cf91d6bSwdenk	  slots. This makes a 24WC08 (1Kbyte) chip look like four 256
24815cf91d6bSwdenk	  byte chips.
24825cf91d6bSwdenk
24835cf91d6bSwdenk	  Note that we consider the length of the address field to
24845cf91d6bSwdenk	  still be one byte because the extra address bits are hidden
24855cf91d6bSwdenk	  in the chip address.
24865cf91d6bSwdenk
24876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_SIZE:
2488c609719bSwdenk	  The size in bytes of the EEPROM device.
2489c609719bSwdenk
2490548738b4SHeiko Schocher	- CONFIG_ENV_EEPROM_IS_ON_I2C
2491548738b4SHeiko Schocher	  define this, if you have I2C and SPI activated, and your
2492548738b4SHeiko Schocher	  EEPROM, which holds the environment, is on the I2C bus.
2493548738b4SHeiko Schocher
2494548738b4SHeiko Schocher	- CONFIG_I2C_ENV_EEPROM_BUS
2495548738b4SHeiko Schocher	  if you have an Environment on an EEPROM reached over
2496548738b4SHeiko Schocher	  I2C muxes, you can define here, how to reach this
2497548738b4SHeiko Schocher	  EEPROM. For example:
2498548738b4SHeiko Schocher
2499548738b4SHeiko Schocher	  #define CONFIG_I2C_ENV_EEPROM_BUS       "pca9547:70:d\0"
2500548738b4SHeiko Schocher
2501548738b4SHeiko Schocher	  EEPROM which holds the environment, is reached over
2502548738b4SHeiko Schocher	  a pca9547 i2c mux with address 0x70, channel 3.
2503c609719bSwdenk
2504057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH:
25055779d8d9Swdenk
25065779d8d9Swdenk	Define this if you have a DataFlash memory device which you
25075779d8d9Swdenk	want to use for the environment.
25085779d8d9Swdenk
25090e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
25100e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
25110e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
25125779d8d9Swdenk
25135779d8d9Swdenk	  These three #defines specify the offset and size of the
25145779d8d9Swdenk	  environment area within the total memory of your DataFlash placed
25155779d8d9Swdenk	  at the specified address.
25165779d8d9Swdenk
251751bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND:
251813a5695bSwdenk
251913a5695bSwdenk	Define this if you have a NAND device which you want to use
252013a5695bSwdenk	for the environment.
252113a5695bSwdenk
25220e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
25230e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
252413a5695bSwdenk
252513a5695bSwdenk	  These two #defines specify the offset and size of the environment
252613a5695bSwdenk	  area within the first NAND device.
25275779d8d9Swdenk
25280e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET_REDUND
2529e443c944SMarkus Klotzbuecher
25300e8d1586SJean-Christophe PLAGNIOL-VILLARD	  This setting describes a second storage area of CONFIG_ENV_SIZE
2531e443c944SMarkus Klotzbuecher	  size used to hold a redundant copy of the environment data,
2532e443c944SMarkus Klotzbuecher	  so that there is a valid backup copy in case there is a
2533e443c944SMarkus Klotzbuecher	  power failure during a "saveenv" operation.
2534e443c944SMarkus Klotzbuecher
25350e8d1586SJean-Christophe PLAGNIOL-VILLARD	Note: CONFIG_ENV_OFFSET and CONFIG_ENV_OFFSET_REDUND must be aligned
25360e8d1586SJean-Christophe PLAGNIOL-VILLARD	to a block boundary, and CONFIG_ENV_SIZE must be a multiple of
2537e443c944SMarkus Klotzbuecher	the NAND devices block size.
2538e443c944SMarkus Klotzbuecher
2539b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST
2540b74ab737SGuennadi Liakhovetski
2541b74ab737SGuennadi Liakhovetski	Defines address in RAM to which the nand_spl code should copy the
2542b74ab737SGuennadi Liakhovetski	environment. If redundant environment is used, it will be copied to
2543b74ab737SGuennadi Liakhovetski	CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
2544b74ab737SGuennadi Liakhovetski
25456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET
2546c609719bSwdenk
2547c609719bSwdenk	Defines offset to the initial SPI buffer area in DPRAM. The
2548c609719bSwdenk	area is used at an early stage (ROM part) if the environment
2549c609719bSwdenk	is configured to reside in the SPI EEPROM: We need a 520 byte
2550c609719bSwdenk	scratch DPRAM area. It is used between the two initialization
2551c609719bSwdenk	calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
2552c609719bSwdenk	to be a good choice since it makes it far enough from the
2553c609719bSwdenk	start of the data area as well as from the stack pointer.
2554c609719bSwdenk
2555e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor
2556c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been
2557c609719bSwdenkcreated; also, when using EEPROM you will have to use getenv_r()
2558c609719bSwdenkuntil then to read environment variables.
2559c609719bSwdenk
256085ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor
256185ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working
256285ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is
256385ec0bccSwdenknecessary, because the first environment variable we need is the
256485ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't
256585ec0bccSwdenkhave any device yet where we could complain.]
2566c609719bSwdenk
2567c609719bSwdenkNote: once the monitor has been relocated, then it will complain if
2568c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you
256985ec0bccSwdenkuse the "saveenv" command to store a valid environment.
2570c609719bSwdenk
25716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
2572fc3e2165Swdenk		Echo the inverted Ethernet link state to the fault LED.
2573fc3e2165Swdenk
25746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
2575fc3e2165Swdenk		      also needs to be defined.
2576fc3e2165Swdenk
25776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR:
2578fc3e2165Swdenk		MII address of the PHY to check for the Ethernet link state.
2579c609719bSwdenk
2580f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS:
2581f5675aa5SRon Madrid		Define this if you desire to only have use of the NS16550_init
2582f5675aa5SRon Madrid		and NS16550_putc functions for the serial driver located at
2583f5675aa5SRon Madrid		drivers/serial/ns16550.c.  This option is useful for saving
2584f5675aa5SRon Madrid		space for already greatly restricted images, including but not
2585f5675aa5SRon Madrid		limited to NAND_SPL configurations.
2586f5675aa5SRon Madrid
2587c609719bSwdenkLow Level (hardware related) configuration options:
2588dc7c9a1aSwdenk---------------------------------------------------
2589c609719bSwdenk
25906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE:
2591c609719bSwdenk		Cache Line Size of the CPU.
2592c609719bSwdenk
25936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR:
2594c609719bSwdenk		Default address of the IMMR after system reset.
25952535d602Swdenk
25962535d602Swdenk		Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
25972535d602Swdenk		and RPXsuper) to be able to adjust the position of
25982535d602Swdenk		the IMMR register after a reset.
2599c609719bSwdenk
26007f6c2cbcSwdenk- Floppy Disk Support:
26016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER
26027f6c2cbcSwdenk
26037f6c2cbcSwdenk		the default drive number (default value 0)
26047f6c2cbcSwdenk
26056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_STRIDE
26067f6c2cbcSwdenk
260711ccc33fSMarcel Ziswiler		defines the spacing between FDC chipset registers
26087f6c2cbcSwdenk		(default value 1)
26097f6c2cbcSwdenk
26106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_OFFSET
26117f6c2cbcSwdenk
26127f6c2cbcSwdenk		defines the offset of register from address. It
26137f6c2cbcSwdenk		depends on which part of the data bus is connected to
261411ccc33fSMarcel Ziswiler		the FDC chipset. (default value 0)
26157f6c2cbcSwdenk
26166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
26176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
26187f6c2cbcSwdenk		default value.
26197f6c2cbcSwdenk
26206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		if CONFIG_SYS_FDC_HW_INIT is defined, then the function
26217f6c2cbcSwdenk		fdc_hw_init() is called at the beginning of the FDC
26227f6c2cbcSwdenk		setup. fdc_hw_init() must be provided by the board
26237f6c2cbcSwdenk		source code. It is used to make hardware dependant
26247f6c2cbcSwdenk		initializations.
26257f6c2cbcSwdenk
26266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR:	Physical address of the Internal Memory.
262725d6712aSwdenk		DO NOT CHANGE unless you know exactly what you're
262825d6712aSwdenk		doing! (11-4) [MPC8xx/82xx systems only]
2629c609719bSwdenk
26306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR:
2631c609719bSwdenk
26327152b1d0Swdenk		Start address of memory area that can be used for
2633c609719bSwdenk		initial data and stack; please note that this must be
2634c609719bSwdenk		writable memory that is working WITHOUT special
2635c609719bSwdenk		initialization, i. e. you CANNOT use normal RAM which
2636c609719bSwdenk		will become available only after programming the
2637c609719bSwdenk		memory controller and running certain initialization
2638c609719bSwdenk		sequences.
2639c609719bSwdenk
2640c609719bSwdenk		U-Boot uses the following memory types:
2641c609719bSwdenk		- MPC8xx and MPC8260: IMMR (internal memory of the CPU)
2642c609719bSwdenk		- MPC824X: data cache
2643c609719bSwdenk		- PPC4xx:  data cache
2644c609719bSwdenk
26456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET:
2646c609719bSwdenk
2647c609719bSwdenk		Offset of the initial data structure in the memory
26486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
26496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
2650c609719bSwdenk		data is located at the end of the available space
26516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		(sometimes written as (CONFIG_SYS_INIT_RAM_END -
26526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
26536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
26546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET) downward.
2655c609719bSwdenk
2656c609719bSwdenk	Note:
2657c609719bSwdenk		On the MPC824X (or other systems that use the data
2658c609719bSwdenk		cache for initial memory) the address chosen for
26596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
2660c609719bSwdenk		point to an otherwise UNUSED address space between
2661c609719bSwdenk		the top of RAM and the start of the PCI space.
2662c609719bSwdenk
26636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR:	SIU Module Configuration (11-6)
2664c609719bSwdenk
26656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR:	System Protection Control (11-9)
2666c609719bSwdenk
26676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR:	Time Base Status and Control (11-26)
2668c609719bSwdenk
26696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR:	Periodic Interrupt Status and Control (11-31)
2670c609719bSwdenk
26716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR:	PLL, Low-Power, and Reset Control Register (15-30)
2672c609719bSwdenk
26736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR:	System Clock and reset Control Register (15-27)
2674c609719bSwdenk
26756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM:
2676c609719bSwdenk		SDRAM timing
2677c609719bSwdenk
26786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA:
2679c609719bSwdenk		periodic timer for refresh
2680c609719bSwdenk
26816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER:	Debug Event Register (37-47)
2682c609719bSwdenk
26836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
26846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
26856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
26866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_BR1_PRELIM:
2687c609719bSwdenk		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
2688c609719bSwdenk
2689c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
26906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
26916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
2692c609719bSwdenk		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
2693c609719bSwdenk
26946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
26956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
2696c609719bSwdenk		Machine Mode Register and Memory Periodic Timer
2697c609719bSwdenk		Prescaler definitions (SDRAM timing)
2698c609719bSwdenk
26996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
2700c609719bSwdenk		enable I2C microcode relocation patch (MPC8xx);
2701c609719bSwdenk		define relocation offset in DPRAM [DSP2]
2702c609719bSwdenk
27036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
2704b423d055SHeiko Schocher		enable SMC microcode relocation patch (MPC8xx);
2705b423d055SHeiko Schocher		define relocation offset in DPRAM [SMC1]
2706b423d055SHeiko Schocher
27076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
2708c609719bSwdenk		enable SPI microcode relocation patch (MPC8xx);
2709c609719bSwdenk		define relocation offset in DPRAM [SCC4]
2710c609719bSwdenk
27116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_USE_OSCCLK:
2712c609719bSwdenk		Use OSCM clock mode on MBX8xx board. Be careful,
2713c609719bSwdenk		wrong setting might damage your board. Read
2714c609719bSwdenk		doc/README.MBX before setting this variable!
2715c609719bSwdenk
27166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
2717ea909b76Swdenk		Offset of the bootmode word in DPRAM used by post
2718ea909b76Swdenk		(Power On Self Tests). This definition overrides
2719ea909b76Swdenk		#define'd default value in commproc.h resp.
2720ea909b76Swdenk		cpm_8260.h.
2721ea909b76Swdenk
27226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
27236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
27246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
27256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
27266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
27276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
27286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
27296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
2730*a47a12beSStefan Roese		Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
27315d232d0eSwdenk
27329cacf4fcSDirk Eibach- CONFIG_PCI_DISABLE_PCIE:
27339cacf4fcSDirk Eibach		Disable PCI-Express on systems where it is supported but not
27349cacf4fcSDirk Eibach		required.
27359cacf4fcSDirk Eibach
2736bb99ad6dSBen Warren- CONFIG_SPD_EEPROM
2737218ca724SWolfgang Denk		Get DDR timing information from an I2C EEPROM. Common
2738218ca724SWolfgang Denk		with pluggable memory modules such as SODIMMs
2739218ca724SWolfgang Denk
2740bb99ad6dSBen Warren  SPD_EEPROM_ADDRESS
2741bb99ad6dSBen Warren		I2C address of the SPD EEPROM
2742bb99ad6dSBen Warren
27436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM
2744218ca724SWolfgang Denk		If SPD EEPROM is on an I2C bus other than the first
2745218ca724SWolfgang Denk		one, specify here. Note that the value must resolve
2746218ca724SWolfgang Denk		to something your driver can deal with.
2747bb99ad6dSBen Warren
27486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0
2749218ca724SWolfgang Denk		Only for 83xx systems. If specified, then DDR should
2750218ca724SWolfgang Denk		be configured using CS0 and CS1 instead of CS2 and CS3.
27512ad6b513STimur Tabi
2752c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12]
2753c26e454dSwdenk		Define to enable FEC[12] on a 8xx series processor.
2754c26e454dSwdenk
2755c26e454dSwdenk- CONFIG_FEC[12]_PHY
2756c26e454dSwdenk		Define to the hardcoded PHY address which corresponds
27576e592385Swdenk		to the given FEC; i. e.
2758c26e454dSwdenk			#define CONFIG_FEC1_PHY 4
2759c26e454dSwdenk		means that the PHY with address 4 is connected to FEC1
2760c26e454dSwdenk
2761c26e454dSwdenk		When set to -1, means to probe for first available.
2762c26e454dSwdenk
2763c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR
2764c26e454dSwdenk		The PHY does not have a RXERR line (RMII only).
2765c26e454dSwdenk		(so program the FEC to ignore it).
2766c26e454dSwdenk
2767c26e454dSwdenk- CONFIG_RMII
2768c26e454dSwdenk		Enable RMII mode for all FECs.
2769c26e454dSwdenk		Note that this is a global option, we can't
2770c26e454dSwdenk		have one FEC in standard MII mode and another in RMII mode.
2771c26e454dSwdenk
27725cf91d6bSwdenk- CONFIG_CRC32_VERIFY
27735cf91d6bSwdenk		Add a verify option to the crc32 command.
27745cf91d6bSwdenk		The syntax is:
27755cf91d6bSwdenk
27765cf91d6bSwdenk		=> crc32 -v <address> <count> <crc32>
27775cf91d6bSwdenk
27785cf91d6bSwdenk		Where address/count indicate a memory area
27795cf91d6bSwdenk		and crc32 is the correct crc32 which the
27805cf91d6bSwdenk		area should have.
27815cf91d6bSwdenk
278256523f12Swdenk- CONFIG_LOOPW
278356523f12Swdenk		Add the "loopw" memory command. This only takes effect if
2784602ad3b3SJon Loeliger		the memory commands are activated globally (CONFIG_CMD_MEM).
278556523f12Swdenk
27867b466641Sstroese- CONFIG_MX_CYCLIC
27877b466641Sstroese		Add the "mdc" and "mwc" memory commands. These are cyclic
27887b466641Sstroese		"md/mw" commands.
27897b466641Sstroese		Examples:
27907b466641Sstroese
27917b466641Sstroese		=> mdc.b 10 4 500
27927b466641Sstroese		This command will print 4 bytes (10,11,12,13) each 500 ms.
27937b466641Sstroese
27947b466641Sstroese		=> mwc.l 100 12345678 10
27957b466641Sstroese		This command will write 12345678 to address 100 all 10 ms.
27967b466641Sstroese
27977b466641Sstroese		This only takes effect if the memory commands are activated
2798602ad3b3SJon Loeliger		globally (CONFIG_CMD_MEM).
27997b466641Sstroese
28008aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT
28018aa1a2d1Swdenk- CONFIG_SKIP_RELOCATE_UBOOT
28028aa1a2d1Swdenk
28038aa1a2d1Swdenk		[ARM only] If these variables are defined, then
28048aa1a2d1Swdenk		certain low level initializations (like setting up
28058aa1a2d1Swdenk		the memory controller) are omitted and/or U-Boot does
28068aa1a2d1Swdenk		not relocate itself into RAM.
28078aa1a2d1Swdenk		Normally these variables MUST NOT be defined. The
28088aa1a2d1Swdenk		only exception is when U-Boot is loaded (to RAM) by
28098aa1a2d1Swdenk		some other boot loader or by a debugger which
281011ccc33fSMarcel Ziswiler		performs these initializations itself.
28118aa1a2d1Swdenk
2812df81238bSMagnus Lilja- CONFIG_PRELOADER
2813df81238bSMagnus Lilja
2814df81238bSMagnus Lilja		Modifies the behaviour of start.S when compiling a loader
2815df81238bSMagnus Lilja		that is executed before the actual U-Boot. E.g. when
2816df81238bSMagnus Lilja		compiling a NAND SPL.
2817400558b5Swdenk
2818c609719bSwdenkBuilding the Software:
2819c609719bSwdenk======================
2820c609719bSwdenk
2821218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments
2822218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support
2823218ca724SWolfgang Denkall possibly existing versions of cross development tools in all
2824218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we
2825218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
2826218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot.
2827c609719bSwdenk
2828218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you
2829218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case,
2830218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell.
2831218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are
2832218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter:
2833c609719bSwdenk
2834218ca724SWolfgang Denk	$ CROSS_COMPILE=ppc_4xx-
2835218ca724SWolfgang Denk	$ export CROSS_COMPILE
2836c609719bSwdenk
28372f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in
28382f8d396bSPeter Tyser      the tools directory you can use the MinGW toolchain
28392f8d396bSPeter Tyser      (http://www.mingw.org).  Set your HOST tools to the MinGW
28402f8d396bSPeter Tyser      toolchain and execute 'make tools'.  For example:
28412f8d396bSPeter Tyser
28422f8d396bSPeter Tyser       $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
28432f8d396bSPeter Tyser
28442f8d396bSPeter Tyser      Binaries such as tools/mkimage.exe will be created which can
28452f8d396bSPeter Tyser      be executed on computers running Windows.
28462f8d396bSPeter Tyser
2847c609719bSwdenkU-Boot is intended to be simple to build. After installing the
2848c609719bSwdenksources you must configure U-Boot for one specific board type. This
2849c609719bSwdenkis done by typing:
2850c609719bSwdenk
2851c609719bSwdenk	make NAME_config
2852c609719bSwdenk
2853218ca724SWolfgang Denkwhere "NAME_config" is the name of one of the existing configu-
2854218ca724SWolfgang Denkrations; see the main Makefile for supported names.
285554387ac9Swdenk
2856c609719bSwdenkNote: for some board special configuration names may exist; check if
2857c609719bSwdenk      additional information is available from the board vendor; for
28582729af9dSwdenk      instance, the TQM823L systems are available without (standard)
28592729af9dSwdenk      or with LCD support. You can select such additional "features"
286011ccc33fSMarcel Ziswiler      when choosing the configuration, i. e.
2861c609719bSwdenk
28622729af9dSwdenk      make TQM823L_config
28632729af9dSwdenk	- will configure for a plain TQM823L, i. e. no LCD support
2864c609719bSwdenk
2865c609719bSwdenk      make TQM823L_LCD_config
2866c609719bSwdenk	- will configure for a TQM823L with U-Boot console on LCD
2867c609719bSwdenk
2868c609719bSwdenk      etc.
2869c609719bSwdenk
2870c609719bSwdenk
2871c609719bSwdenkFinally, type "make all", and you should get some working U-Boot
28727152b1d0Swdenkimages ready for download to / installation on your system:
2873c609719bSwdenk
2874c609719bSwdenk- "u-boot.bin" is a raw binary image
2875c609719bSwdenk- "u-boot" is an image in ELF binary format
2876c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format
2877c609719bSwdenk
2878baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved
2879baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change
2880baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory:
2881baf31249SMarian Balakowicz
2882baf31249SMarian Balakowicz1. Add O= to the make command line invocations:
2883baf31249SMarian Balakowicz
2884baf31249SMarian Balakowicz	make O=/tmp/build distclean
2885baf31249SMarian Balakowicz	make O=/tmp/build NAME_config
2886baf31249SMarian Balakowicz	make O=/tmp/build all
2887baf31249SMarian Balakowicz
2888baf31249SMarian Balakowicz2. Set environment variable BUILD_DIR to point to the desired location:
2889baf31249SMarian Balakowicz
2890baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
2891baf31249SMarian Balakowicz	make distclean
2892baf31249SMarian Balakowicz	make NAME_config
2893baf31249SMarian Balakowicz	make all
2894baf31249SMarian Balakowicz
2895baf31249SMarian BalakowiczNote that the command line "O=" setting overrides the BUILD_DIR environment
2896baf31249SMarian Balakowiczvariable.
2897baf31249SMarian Balakowicz
2898c609719bSwdenk
2899c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so
2900c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of
2901c609719bSwdenknative "make".
2902c609719bSwdenk
2903c609719bSwdenk
2904c609719bSwdenkIf the system board that you have is not listed, then you will need
2905c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these
2906c609719bSwdenksteps:
2907c609719bSwdenk
2908c609719bSwdenk1.  Add a new configuration option for your board to the toplevel
290985ec0bccSwdenk    "Makefile" and to the "MAKEALL" script, using the existing
291085ec0bccSwdenk    entries as examples. Note that here and at many other places
29117152b1d0Swdenk    boards and other names are listed in alphabetical sort order. Please
291285ec0bccSwdenk    keep this order.
2913c609719bSwdenk2.  Create a new directory to hold your board specific code. Add any
291485ec0bccSwdenk    files you need. In your board directory, you will need at least
291585ec0bccSwdenk    the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
291685ec0bccSwdenk3.  Create a new configuration file "include/configs/<board>.h" for
291785ec0bccSwdenk    your board
2918c609719bSwdenk3.  If you're porting U-Boot to a new CPU, then also create a new
2919c609719bSwdenk    directory to hold your CPU specific code. Add any files you need.
292085ec0bccSwdenk4.  Run "make <board>_config" with your new name.
2921c609719bSwdenk5.  Type "make", and you should get a working "u-boot.srec" file
2922c609719bSwdenk    to be installed on your target system.
292385ec0bccSwdenk6.  Debug and solve any problems that might arise.
2924c609719bSwdenk    [Of course, this last step is much harder than it sounds.]
2925c609719bSwdenk
2926c609719bSwdenk
2927c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.:
2928c609719bSwdenk==============================================================
2929c609719bSwdenk
2930c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board
2931c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to
2932c609719bSwdenkprovide feedback to the other developers. The feedback normally takes
2933c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest
2934218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources.
2935c609719bSwdenk
2936c609719bSwdenkBut before you submit such a patch, please verify that your modifi-
2937c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of
2938c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so,
2939c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot
2940c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You can
29417152b1d0Swdenkselect which (cross) compiler to use by passing a `CROSS_COMPILE'
2942218ca724SWolfgang Denkenvironment variable to the script, i. e. to use the ELDK cross tools
2943218ca724SWolfgang Denkyou can type
2944c609719bSwdenk
2945c609719bSwdenk	CROSS_COMPILE=ppc_8xx- MAKEALL
2946c609719bSwdenk
2947c609719bSwdenkor to build on a native PowerPC system you can type
2948c609719bSwdenk
2949c609719bSwdenk	CROSS_COMPILE=' ' MAKEALL
2950c609719bSwdenk
2951218ca724SWolfgang DenkWhen using the MAKEALL script, the default behaviour is to build
2952218ca724SWolfgang DenkU-Boot in the source directory. This location can be changed by
2953218ca724SWolfgang Denksetting the BUILD_DIR environment variable. Also, for each target
2954218ca724SWolfgang Denkbuilt, the MAKEALL script saves two log files (<target>.ERR and
2955218ca724SWolfgang Denk<target>.MAKEALL) in the <source dir>/LOG directory. This default
2956218ca724SWolfgang Denklocation can be changed by setting the MAKEALL_LOGDIR environment
2957218ca724SWolfgang Denkvariable. For example:
2958baf31249SMarian Balakowicz
2959baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
2960baf31249SMarian Balakowicz	export MAKEALL_LOGDIR=/tmp/log
2961baf31249SMarian Balakowicz	CROSS_COMPILE=ppc_8xx- MAKEALL
2962baf31249SMarian Balakowicz
2963218ca724SWolfgang DenkWith the above settings build objects are saved in the /tmp/build,
2964218ca724SWolfgang Denklog files are saved in the /tmp/log and the source tree remains clean
2965218ca724SWolfgang Denkduring the whole build process.
2966baf31249SMarian Balakowicz
2967baf31249SMarian Balakowicz
2968c609719bSwdenkSee also "U-Boot Porting Guide" below.
2969c609719bSwdenk
2970c609719bSwdenk
2971c609719bSwdenkMonitor Commands - Overview:
2972c609719bSwdenk============================
2973c609719bSwdenk
2974c609719bSwdenkgo	- start application at address 'addr'
2975c609719bSwdenkrun	- run commands in an environment variable
2976c609719bSwdenkbootm	- boot application image from memory
2977c609719bSwdenkbootp	- boot image via network using BootP/TFTP protocol
2978c609719bSwdenktftpboot- boot image via network using TFTP protocol
2979c609719bSwdenk	       and env variables "ipaddr" and "serverip"
2980c609719bSwdenk	       (and eventually "gatewayip")
2981c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol
2982c609719bSwdenkdiskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
2983c609719bSwdenkloads	- load S-Record file over serial line
2984c609719bSwdenkloadb	- load binary file over serial line (kermit mode)
2985c609719bSwdenkmd	- memory display
2986c609719bSwdenkmm	- memory modify (auto-incrementing)
2987c609719bSwdenknm	- memory modify (constant address)
2988c609719bSwdenkmw	- memory write (fill)
2989c609719bSwdenkcp	- memory copy
2990c609719bSwdenkcmp	- memory compare
2991c609719bSwdenkcrc32	- checksum calculation
29920f89c54bSPeter Tyseri2c	- I2C sub-system
2993c609719bSwdenksspi	- SPI utility commands
2994c609719bSwdenkbase	- print or set address offset
2995c609719bSwdenkprintenv- print environment variables
2996c609719bSwdenksetenv	- set environment variables
2997c609719bSwdenksaveenv - save environment variables to persistent storage
2998c609719bSwdenkprotect - enable or disable FLASH write protection
2999c609719bSwdenkerase	- erase FLASH memory
3000c609719bSwdenkflinfo	- print FLASH memory information
3001c609719bSwdenkbdinfo	- print Board Info structure
3002c609719bSwdenkiminfo	- print header information for application image
3003c609719bSwdenkconinfo - print console devices and informations
3004c609719bSwdenkide	- IDE sub-system
3005c609719bSwdenkloop	- infinite loop on address range
300656523f12Swdenkloopw	- infinite write loop on address range
3007c609719bSwdenkmtest	- simple RAM test
3008c609719bSwdenkicache	- enable or disable instruction cache
3009c609719bSwdenkdcache	- enable or disable data cache
3010c609719bSwdenkreset	- Perform RESET of the CPU
3011c609719bSwdenkecho	- echo args to console
3012c609719bSwdenkversion - print monitor version
3013c609719bSwdenkhelp	- print online help
3014c609719bSwdenk?	- alias for 'help'
3015c609719bSwdenk
3016c609719bSwdenk
3017c609719bSwdenkMonitor Commands - Detailed Description:
3018c609719bSwdenk========================================
3019c609719bSwdenk
3020c609719bSwdenkTODO.
3021c609719bSwdenk
3022c609719bSwdenkFor now: just type "help <command>".
3023c609719bSwdenk
3024c609719bSwdenk
3025c609719bSwdenkEnvironment Variables:
3026c609719bSwdenk======================
3027c609719bSwdenk
3028c609719bSwdenkU-Boot supports user configuration using Environment Variables which
3029c609719bSwdenkcan be made persistent by saving to Flash memory.
3030c609719bSwdenk
3031c609719bSwdenkEnvironment Variables are set using "setenv", printed using
3032c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv"
3033c609719bSwdenkwithout a value can be used to delete a variable from the
3034c609719bSwdenkenvironment. As long as you don't save the environment you are
3035c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the
3036c609719bSwdenkenvironment is erased by accident, a default environment is provided.
3037c609719bSwdenk
3038c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables.
3039c96f86eeSWolfgang Denk
3040c96f86eeSWolfgang DenkList of environment variables (most likely not complete):
3041c609719bSwdenk
3042c609719bSwdenk  baudrate	- see CONFIG_BAUDRATE
3043c609719bSwdenk
3044c609719bSwdenk  bootdelay	- see CONFIG_BOOTDELAY
3045c609719bSwdenk
3046c609719bSwdenk  bootcmd	- see CONFIG_BOOTCOMMAND
3047c609719bSwdenk
3048c609719bSwdenk  bootargs	- Boot arguments when booting an RTOS image
3049c609719bSwdenk
3050c609719bSwdenk  bootfile	- Name of the image to load with TFTP
3051c609719bSwdenk
30527d721e34SBartlomiej Sieka  bootm_low	- Memory range available for image processing in the bootm
30537d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
30547d721e34SBartlomiej Sieka		  a hexadecimal number and defines lowest address allowed
30557d721e34SBartlomiej Sieka		  for use by the bootm command. See also "bootm_size"
30567d721e34SBartlomiej Sieka		  environment variable. Address defined by "bootm_low" is
30577d721e34SBartlomiej Sieka		  also the base of the initial memory mapping for the Linux
30586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		  kernel -- see the description of CONFIG_SYS_BOOTMAPSZ.
30597d721e34SBartlomiej Sieka
30607d721e34SBartlomiej Sieka  bootm_size	- 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 the size of the region
30637d721e34SBartlomiej Sieka		  allowed for use by the bootm command. See also "bootm_low"
30647d721e34SBartlomiej Sieka		  environment variable.
30657d721e34SBartlomiej Sieka
30664bae9090SBartlomiej Sieka  updatefile	- Location of the software update file on a TFTP server, used
30674bae9090SBartlomiej Sieka		  by the automatic software update feature. Please refer to
30684bae9090SBartlomiej Sieka		  documentation in doc/README.update for more details.
30694bae9090SBartlomiej Sieka
3070c609719bSwdenk  autoload	- if set to "no" (any string beginning with 'n'),
3071c609719bSwdenk		  "bootp" will just load perform a lookup of the
3072c609719bSwdenk		  configuration from the BOOTP server, but not try to
3073c609719bSwdenk		  load any image using TFTP
3074c609719bSwdenk
3075c609719bSwdenk  autostart	- if set to "yes", an image loaded using the "bootp",
3076c609719bSwdenk		  "rarpboot", "tftpboot" or "diskboot" commands will
3077c609719bSwdenk		  be automatically started (by internally calling
3078c609719bSwdenk		  "bootm")
3079c609719bSwdenk
30804a6fd34bSwdenk		  If set to "no", a standalone image passed to the
30814a6fd34bSwdenk		  "bootm" command will be copied to the load address
30824a6fd34bSwdenk		  (and eventually uncompressed), but NOT be started.
30834a6fd34bSwdenk		  This can be used to load and uncompress arbitrary
30844a6fd34bSwdenk		  data.
30854a6fd34bSwdenk
308617ea1177Swdenk  i2cfast	- (PPC405GP|PPC405EP only)
308717ea1177Swdenk		  if set to 'y' configures Linux I2C driver for fast
308817ea1177Swdenk		  mode (400kHZ). This environment variable is used in
308917ea1177Swdenk		  initialization code. So, for changes to be effective
309017ea1177Swdenk		  it must be saved and board must be reset.
309117ea1177Swdenk
3092c609719bSwdenk  initrd_high	- restrict positioning of initrd images:
3093c609719bSwdenk		  If this variable is not set, initrd images will be
3094c609719bSwdenk		  copied to the highest possible address in RAM; this
3095c609719bSwdenk		  is usually what you want since it allows for
3096c609719bSwdenk		  maximum initrd size. If for some reason you want to
3097c609719bSwdenk		  make sure that the initrd image is loaded below the
30986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		  CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
3099c609719bSwdenk		  variable to a value of "no" or "off" or "0".
3100c609719bSwdenk		  Alternatively, you can set it to a maximum upper
3101c609719bSwdenk		  address to use (U-Boot will still check that it
3102c609719bSwdenk		  does not overwrite the U-Boot stack and data).
3103c609719bSwdenk
3104c609719bSwdenk		  For instance, when you have a system with 16 MB
31057152b1d0Swdenk		  RAM, and want to reserve 4 MB from use by Linux,
3106c609719bSwdenk		  you can do this by adding "mem=12M" to the value of
3107c609719bSwdenk		  the "bootargs" variable. However, now you must make
31087152b1d0Swdenk		  sure that the initrd image is placed in the first
3109c609719bSwdenk		  12 MB as well - this can be done with
3110c609719bSwdenk
3111c609719bSwdenk		  setenv initrd_high 00c00000
3112c609719bSwdenk
311338b99261Swdenk		  If you set initrd_high to 0xFFFFFFFF, this is an
311438b99261Swdenk		  indication to U-Boot that all addresses are legal
311538b99261Swdenk		  for the Linux kernel, including addresses in flash
311638b99261Swdenk		  memory. In this case U-Boot will NOT COPY the
311738b99261Swdenk		  ramdisk at all. This may be useful to reduce the
311838b99261Swdenk		  boot time on your system, but requires that this
311938b99261Swdenk		  feature is supported by your Linux kernel.
312038b99261Swdenk
3121c609719bSwdenk  ipaddr	- IP address; needed for tftpboot command
3122c609719bSwdenk
3123c609719bSwdenk  loadaddr	- Default load address for commands like "bootp",
3124dc7c9a1aSwdenk		  "rarpboot", "tftpboot", "loadb" or "diskboot"
3125c609719bSwdenk
3126c609719bSwdenk  loads_echo	- see CONFIG_LOADS_ECHO
3127c609719bSwdenk
3128c609719bSwdenk  serverip	- TFTP server IP address; needed for tftpboot command
3129c609719bSwdenk
3130c609719bSwdenk  bootretry	- see CONFIG_BOOT_RETRY_TIME
3131c609719bSwdenk
3132c609719bSwdenk  bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
3133c609719bSwdenk
3134c609719bSwdenk  bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
3135c609719bSwdenk
3136a3d991bdSwdenk  ethprime	- When CONFIG_NET_MULTI is enabled controls which
3137a3d991bdSwdenk		  interface is used first.
3138a3d991bdSwdenk
3139a3d991bdSwdenk  ethact	- When CONFIG_NET_MULTI is enabled controls which
3140a3d991bdSwdenk		  interface is currently active. For example you
3141a3d991bdSwdenk		  can do the following
3142a3d991bdSwdenk
3143a3d991bdSwdenk		  => setenv ethact FEC ETHERNET
3144a3d991bdSwdenk		  => ping 192.168.0.1 # traffic sent on FEC ETHERNET
3145a3d991bdSwdenk		  => setenv ethact SCC ETHERNET
3146a3d991bdSwdenk		  => ping 10.0.0.1 # traffic sent on SCC ETHERNET
3147a3d991bdSwdenk
3148e1692577SMatthias Fuchs  ethrotate	- When set to "no" U-Boot does not go through all
3149e1692577SMatthias Fuchs		  available network interfaces.
3150e1692577SMatthias Fuchs		  It just stays at the currently selected interface.
3151e1692577SMatthias Fuchs
3152a3d991bdSwdenk  netretry	- When set to "no" each network operation will
3153a3d991bdSwdenk		  either succeed or fail without retrying.
31546e592385Swdenk		  When set to "once" the network operation will
31556e592385Swdenk		  fail when all the available network interfaces
31566e592385Swdenk		  are tried once without success.
3157a3d991bdSwdenk		  Useful on scripts which control the retry operation
3158a3d991bdSwdenk		  themselves.
3159a3d991bdSwdenk
3160b4e2f89dSJean-Christophe PLAGNIOL-VILLARD  npe_ucode	- set load address for the NPE microcode
3161a1cf027aSJean-Christophe PLAGNIOL-VILLARD
316228cb9375SWolfgang Denk  tftpsrcport	- If this is set, the value is used for TFTP's
3163ecb0ccd9SWolfgang Denk		  UDP source port.
3164ecb0ccd9SWolfgang Denk
316528cb9375SWolfgang Denk  tftpdstport	- If this is set, the value is used for TFTP's UDP
316628cb9375SWolfgang Denk		  destination port instead of the Well Know Port 69.
316728cb9375SWolfgang Denk
3168c96f86eeSWolfgang Denk  tftpblocksize - Block size to use for TFTP transfers; if not set,
3169c96f86eeSWolfgang Denk		  we use the TFTP server's default block size
3170c96f86eeSWolfgang Denk
3171c96f86eeSWolfgang Denk  tftptimeout	- Retransmission timeout for TFTP packets (in milli-
3172c96f86eeSWolfgang Denk		  seconds, minimum value is 1000 = 1 second). Defines
3173c96f86eeSWolfgang Denk		  when a packet is considered to be lost so it has to
3174c96f86eeSWolfgang Denk		  be retransmitted. The default is 5000 = 5 seconds.
3175c96f86eeSWolfgang Denk		  Lowering this value may make downloads succeed
3176c96f86eeSWolfgang Denk		  faster in networks with high packet loss rates or
3177c96f86eeSWolfgang Denk		  with unreliable TFTP servers.
3178c96f86eeSWolfgang Denk
3179a3d991bdSwdenk  vlan		- When set to a value < 4095 the traffic over
318011ccc33fSMarcel Ziswiler		  Ethernet is encapsulated/received over 802.1q
3181a3d991bdSwdenk		  VLAN tagged frames.
3182c609719bSwdenk
3183c609719bSwdenkThe following environment variables may be used and automatically
3184c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"),
3185c609719bSwdenkdepending the information provided by your boot server:
3186c609719bSwdenk
3187c609719bSwdenk  bootfile	- see above
3188c609719bSwdenk  dnsip		- IP address of your Domain Name Server
3189fe389a82Sstroese  dnsip2	- IP address of your secondary Domain Name Server
3190c609719bSwdenk  gatewayip	- IP address of the Gateway (Router) to use
3191c609719bSwdenk  hostname	- Target hostname
3192c609719bSwdenk  ipaddr	- see above
3193c609719bSwdenk  netmask	- Subnet Mask
3194c609719bSwdenk  rootpath	- Pathname of the root filesystem on the NFS server
3195c609719bSwdenk  serverip	- see above
3196c609719bSwdenk
3197c609719bSwdenk
3198c609719bSwdenkThere are two special Environment Variables:
3199c609719bSwdenk
3200c609719bSwdenk  serial#	- contains hardware identification information such
3201c609719bSwdenk		  as type string and/or serial number
3202c609719bSwdenk  ethaddr	- Ethernet address
3203c609719bSwdenk
3204c609719bSwdenkThese variables can be set only once (usually during manufacturing of
3205c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables
3206c609719bSwdenkonce they have been set once.
3207c609719bSwdenk
3208c609719bSwdenk
3209c1551ea8SstroeseFurther special Environment Variables:
3210c1551ea8Sstroese
3211c1551ea8Sstroese  ver		- Contains the U-Boot version string as printed
3212c1551ea8Sstroese		  with the "version" command. This variable is
3213c1551ea8Sstroese		  readonly (see CONFIG_VERSION_VARIABLE).
3214c1551ea8Sstroese
3215c1551ea8Sstroese
3216c609719bSwdenkPlease note that changes to some configuration parameters may take
3217c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-).
3218c609719bSwdenk
3219c609719bSwdenk
3220f07771ccSwdenkCommand Line Parsing:
3221f07771ccSwdenk=====================
3222f07771ccSwdenk
3223f07771ccSwdenkThere are two different command line parsers available with U-Boot:
32247152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell:
3225f07771ccSwdenk
3226f07771ccSwdenkOld, simple command line parser:
3227f07771ccSwdenk--------------------------------
3228f07771ccSwdenk
3229f07771ccSwdenk- supports environment variables (through setenv / saveenv commands)
3230f07771ccSwdenk- several commands on one line, separated by ';'
3231fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax
3232f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\',
3233f07771ccSwdenk  for example:
3234fe126d8bSWolfgang Denk	setenv bootcmd bootm \${address}
3235f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example:
3236f07771ccSwdenk	setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
3237f07771ccSwdenk
3238f07771ccSwdenkHush shell:
3239f07771ccSwdenk-----------
3240f07771ccSwdenk
3241f07771ccSwdenk- similar to Bourne shell, with control structures like
3242f07771ccSwdenk  if...then...else...fi, for...do...done; while...do...done,
3243f07771ccSwdenk  until...do...done, ...
3244f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv
3245f07771ccSwdenk  commands) and local shell variables (through standard shell syntax
3246f07771ccSwdenk  "name=value"); only environment variables can be used with "run"
3247f07771ccSwdenk  command
3248f07771ccSwdenk
3249f07771ccSwdenkGeneral rules:
3250f07771ccSwdenk--------------
3251f07771ccSwdenk
3252f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run"
3253f07771ccSwdenk    command) contains several commands separated by semicolon, and
3254f07771ccSwdenk    one of these commands fails, then the remaining commands will be
3255f07771ccSwdenk    executed anyway.
3256f07771ccSwdenk
3257f07771ccSwdenk(2) If you execute several variables with one call to run (i. e.
325811ccc33fSMarcel Ziswiler    calling run with a list of variables as arguments), any failing
3259f07771ccSwdenk    command will cause "run" to terminate, i. e. the remaining
3260f07771ccSwdenk    variables are not executed.
3261f07771ccSwdenk
3262c609719bSwdenkNote for Redundant Ethernet Interfaces:
3263c609719bSwdenk=======================================
3264c609719bSwdenk
326511ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports
3266c609719bSwdenksuch configurations and is capable of automatic selection of a
32677152b1d0Swdenk"working" interface when needed. MAC assignment works as follows:
3268c609719bSwdenk
3269c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding
3270c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0),
3271c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ...
3272c609719bSwdenk
3273c609719bSwdenkIf the network interface stores some valid MAC address (for instance
3274c609719bSwdenkin SROM), this is used as default address if there is NO correspon-
3275c609719bSwdenkding setting in the environment; if the corresponding environment
3276c609719bSwdenkvariable is set, this overrides the settings in the card; that means:
3277c609719bSwdenk
3278c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the
3279c609719bSwdenk  environment, the SROM's address is used.
3280c609719bSwdenk
3281c609719bSwdenko If there is no valid address in the SROM, and a definition in the
3282c609719bSwdenk  environment exists, then the value from the environment variable is
3283c609719bSwdenk  used.
3284c609719bSwdenk
3285c609719bSwdenko If both the SROM and the environment contain a MAC address, and
3286c609719bSwdenk  both addresses are the same, this MAC address is used.
3287c609719bSwdenk
3288c609719bSwdenko If both the SROM and the environment contain a MAC address, and the
3289c609719bSwdenk  addresses differ, the value from the environment is used and a
3290c609719bSwdenk  warning is printed.
3291c609719bSwdenk
3292c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error
3293c609719bSwdenk  is raised.
3294c609719bSwdenk
3295c609719bSwdenk
3296c609719bSwdenkImage Formats:
3297c609719bSwdenk==============
3298c609719bSwdenk
32993310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on)
33003310c549SMarian Balakowiczimages in two formats:
33013310c549SMarian Balakowicz
33023310c549SMarian BalakowiczNew uImage format (FIT)
33033310c549SMarian Balakowicz-----------------------
33043310c549SMarian Balakowicz
33053310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar
33063310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple
33073310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by
33083310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
33093310c549SMarian Balakowicz
33103310c549SMarian Balakowicz
33113310c549SMarian BalakowiczOld uImage format
33123310c549SMarian Balakowicz-----------------
33133310c549SMarian Balakowicz
33143310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything,
33153310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for
33163310c549SMarian Balakowiczdetails; basically, the header defines the following image properties:
3317c609719bSwdenk
3318c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
3319c609719bSwdenk  4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
3320f5ed9e39SPeter Tyser  LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
3321f5ed9e39SPeter Tyser  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
3322f5ed9e39SPeter Tyser  INTEGRITY).
33237b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
33243d1e8a9dSwdenk  IA64, MIPS, NIOS, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
33257b64fef3SWolfgang Denk  Currently supported: ARM, AVR32, Intel x86, MIPS, NIOS, PowerPC).
3326c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2)
3327c609719bSwdenk* Load Address
3328c609719bSwdenk* Entry Point
3329c609719bSwdenk* Image Name
3330c609719bSwdenk* Image Timestamp
3331c609719bSwdenk
3332c609719bSwdenkThe header is marked by a special Magic Number, and both the header
3333c609719bSwdenkand the data portions of the image are secured against corruption by
3334c609719bSwdenkCRC32 checksums.
3335c609719bSwdenk
3336c609719bSwdenk
3337c609719bSwdenkLinux Support:
3338c609719bSwdenk==============
3339c609719bSwdenk
3340c609719bSwdenkAlthough U-Boot should support any OS or standalone application
33417152b1d0Swdenkeasily, the main focus has always been on Linux during the design of
3342c609719bSwdenkU-Boot.
3343c609719bSwdenk
3344c609719bSwdenkU-Boot includes many features that so far have been part of some
3345c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any
3346c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image;
3347c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation
33487152b1d0Swdenkserves several purposes:
3349c609719bSwdenk
3350c609719bSwdenk- the same features can be used for other OS or standalone
3351c609719bSwdenk  applications (for instance: using compressed images to reduce the
3352c609719bSwdenk  Flash memory footprint)
3353c609719bSwdenk
3354c609719bSwdenk- it becomes much easier to port new Linux kernel versions because
33557152b1d0Swdenk  lots of low-level, hardware dependent stuff are done by U-Boot
3356c609719bSwdenk
3357c609719bSwdenk- the same Linux kernel image can now be used with different "initrd"
3358c609719bSwdenk  images; of course this also means that different kernel images can
3359c609719bSwdenk  be run with the same "initrd". This makes testing easier (you don't
3360c609719bSwdenk  have to build a new "zImage.initrd" Linux image when you just
3361c609719bSwdenk  change a file in your "initrd"). Also, a field-upgrade of the
3362c609719bSwdenk  software is easier now.
3363c609719bSwdenk
3364c609719bSwdenk
3365c609719bSwdenkLinux HOWTO:
3366c609719bSwdenk============
3367c609719bSwdenk
3368c609719bSwdenkPorting Linux to U-Boot based systems:
3369c609719bSwdenk---------------------------------------
3370c609719bSwdenk
3371c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to
3372c609719bSwdenkconfigure the Linux device drivers for use with your target hardware
3373c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to
3374c609719bSwdenkLinux :-).
3375c609719bSwdenk
3376*a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
3377c609719bSwdenk
3378c609719bSwdenkJust make sure your machine specific header file (for instance
3379c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board
33801dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h,
33811dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value
33826d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR.
3383c609719bSwdenk
3384c609719bSwdenk
3385c609719bSwdenkConfiguring the Linux kernel:
3386c609719bSwdenk-----------------------------
3387c609719bSwdenk
3388c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root
3389c609719bSwdenkdevice (initial ramdisk, NFS) for your target system.
3390c609719bSwdenk
3391c609719bSwdenk
3392c609719bSwdenkBuilding a Linux Image:
3393c609719bSwdenk-----------------------
3394c609719bSwdenk
339524ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are
339624ee89b9Swdenknot used. If you use recent kernel source, a new build target
339724ee89b9Swdenk"uImage" will exist which automatically builds an image usable by
339824ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target,
339924ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a
340024ee89b9Swdenk100% compatible format.
3401c609719bSwdenk
3402c609719bSwdenkExample:
3403c609719bSwdenk
3404c609719bSwdenk	make TQM850L_config
3405c609719bSwdenk	make oldconfig
3406c609719bSwdenk	make dep
340724ee89b9Swdenk	make uImage
3408c609719bSwdenk
340924ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to
341024ee89b9Swdenkencapsulate a compressed Linux kernel image with header	 information,
341124ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing:
3412c609719bSwdenk
341324ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format):
341424ee89b9Swdenk
341524ee89b9Swdenk* convert the kernel into a raw binary image:
341624ee89b9Swdenk
341724ee89b9Swdenk	${CROSS_COMPILE}-objcopy -O binary \
341824ee89b9Swdenk				 -R .note -R .comment \
341924ee89b9Swdenk				 -S vmlinux linux.bin
342024ee89b9Swdenk
342124ee89b9Swdenk* compress the binary image:
342224ee89b9Swdenk
342324ee89b9Swdenk	gzip -9 linux.bin
342424ee89b9Swdenk
342524ee89b9Swdenk* package compressed binary image for U-Boot:
342624ee89b9Swdenk
342724ee89b9Swdenk	mkimage -A ppc -O linux -T kernel -C gzip \
342824ee89b9Swdenk		-a 0 -e 0 -n "Linux Kernel Image" \
342924ee89b9Swdenk		-d linux.bin.gz uImage
343024ee89b9Swdenk
343124ee89b9Swdenk
343224ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use
343324ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or
343424ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64
343524ee89b9Swdenkbyte header containing information about target architecture,
343624ee89b9Swdenkoperating system, image type, compression method, entry points, time
343724ee89b9Swdenkstamp, CRC32 checksums, etc.
343824ee89b9Swdenk
343924ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and
344024ee89b9Swdenkprint the header information, or to build new images.
3441c609719bSwdenk
3442c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information
3443c609719bSwdenkcontained in the header of an existing U-Boot image; this includes
3444c609719bSwdenkchecksum verification:
3445c609719bSwdenk
3446c609719bSwdenk	tools/mkimage -l image
3447c609719bSwdenk	  -l ==> list image header information
3448c609719bSwdenk
3449c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image
3450c609719bSwdenkfrom a "data file" which is used as image payload:
3451c609719bSwdenk
3452c609719bSwdenk	tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
3453c609719bSwdenk		      -n name -d data_file image
3454c609719bSwdenk	  -A ==> set architecture to 'arch'
3455c609719bSwdenk	  -O ==> set operating system to 'os'
3456c609719bSwdenk	  -T ==> set image type to 'type'
3457c609719bSwdenk	  -C ==> set compression type 'comp'
3458c609719bSwdenk	  -a ==> set load address to 'addr' (hex)
3459c609719bSwdenk	  -e ==> set entry point to 'ep' (hex)
3460c609719bSwdenk	  -n ==> set image name to 'name'
3461c609719bSwdenk	  -d ==> use image data from 'datafile'
3462c609719bSwdenk
346369459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load
346469459791Swdenkaddress (0x00000000), but the entry point address depends on the
346569459791Swdenkkernel version:
3466c609719bSwdenk
3467c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C,
346824ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000.
3469c609719bSwdenk
3470c609719bSwdenkSo a typical call to build a U-Boot image would read:
3471c609719bSwdenk
347224ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
347324ee89b9Swdenk	> -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
3474*a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
347524ee89b9Swdenk	> examples/uImage.TQM850L
347624ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
3477c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
3478c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
3479c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
3480c609719bSwdenk	Load Address: 0x00000000
348124ee89b9Swdenk	Entry Point:  0x00000000
3482c609719bSwdenk
3483c609719bSwdenkTo verify the contents of the image (or check for corruption):
3484c609719bSwdenk
348524ee89b9Swdenk	-> tools/mkimage -l examples/uImage.TQM850L
348624ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
3487c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
3488c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
3489c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
3490c609719bSwdenk	Load Address: 0x00000000
349124ee89b9Swdenk	Entry Point:  0x00000000
3492c609719bSwdenk
3493c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade
3494c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this
3495c609719bSwdenkneeds more space in Flash, but boots much faster since it does not
3496c609719bSwdenkneed to be uncompressed:
3497c609719bSwdenk
3498*a47a12beSStefan Roese	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
349924ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
350024ee89b9Swdenk	> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
3501*a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
350224ee89b9Swdenk	> examples/uImage.TQM850L-uncompressed
350324ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
3504c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
3505c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (uncompressed)
3506c609719bSwdenk	Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
3507c609719bSwdenk	Load Address: 0x00000000
350824ee89b9Swdenk	Entry Point:  0x00000000
3509c609719bSwdenk
3510c609719bSwdenk
3511c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file
3512c609719bSwdenkwhen your kernel is intended to use an initial ramdisk:
3513c609719bSwdenk
3514c609719bSwdenk	-> tools/mkimage -n 'Simple Ramdisk Image' \
3515c609719bSwdenk	> -A ppc -O linux -T ramdisk -C gzip \
3516c609719bSwdenk	> -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
3517c609719bSwdenk	Image Name:   Simple Ramdisk Image
3518c609719bSwdenk	Created:      Wed Jan 12 14:01:50 2000
3519c609719bSwdenk	Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
3520c609719bSwdenk	Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
3521c609719bSwdenk	Load Address: 0x00000000
3522c609719bSwdenk	Entry Point:  0x00000000
3523c609719bSwdenk
3524c609719bSwdenk
3525c609719bSwdenkInstalling a Linux Image:
3526c609719bSwdenk-------------------------
3527c609719bSwdenk
3528c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface,
3529c609719bSwdenkyou must convert the image to S-Record format:
3530c609719bSwdenk
3531c609719bSwdenk	objcopy -I binary -O srec examples/image examples/image.srec
3532c609719bSwdenk
3533c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot
3534c609719bSwdenkimage header, so the resulting S-Record file will be relative to
3535c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to
3536c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads'
3537c609719bSwdenkcommand.
3538c609719bSwdenk
3539c609719bSwdenkExample: install the image to address 0x40100000 (which on the
3540c609719bSwdenkTQM8xxL is in the first Flash bank):
3541c609719bSwdenk
3542c609719bSwdenk	=> erase 40100000 401FFFFF
3543c609719bSwdenk
3544c609719bSwdenk	.......... done
3545c609719bSwdenk	Erased 8 sectors
3546c609719bSwdenk
3547c609719bSwdenk	=> loads 40100000
3548c609719bSwdenk	## Ready for S-Record download ...
3549c609719bSwdenk	~>examples/image.srec
3550c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 12 13 ...
3551c609719bSwdenk	...
3552c609719bSwdenk	15989 15990 15991 15992
3553c609719bSwdenk	[file transfer complete]
3554c609719bSwdenk	[connected]
3555c609719bSwdenk	## Start Addr = 0x00000000
3556c609719bSwdenk
3557c609719bSwdenk
3558c609719bSwdenkYou can check the success of the download using the 'iminfo' command;
3559c609719bSwdenkthis includes a checksum verification so you can be sure no data
3560c609719bSwdenkcorruption happened:
3561c609719bSwdenk
3562c609719bSwdenk	=> imi 40100000
3563c609719bSwdenk
3564c609719bSwdenk	## Checking Image at 40100000 ...
3565c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
3566c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3567c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
3568c609719bSwdenk	   Load Address: 00000000
3569c609719bSwdenk	   Entry Point:	 0000000c
3570c609719bSwdenk	   Verifying Checksum ... OK
3571c609719bSwdenk
3572c609719bSwdenk
3573c609719bSwdenkBoot Linux:
3574c609719bSwdenk-----------
3575c609719bSwdenk
3576c609719bSwdenkThe "bootm" command is used to boot an application that is stored in
3577c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents
3578c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as
3579c609719bSwdenkparameters. You can check and modify this variable using the
3580c609719bSwdenk"printenv" and "setenv" commands:
3581c609719bSwdenk
3582c609719bSwdenk
3583c609719bSwdenk	=> printenv bootargs
3584c609719bSwdenk	bootargs=root=/dev/ram
3585c609719bSwdenk
3586c609719bSwdenk	=> setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3587c609719bSwdenk
3588c609719bSwdenk	=> printenv bootargs
3589c609719bSwdenk	bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3590c609719bSwdenk
3591c609719bSwdenk	=> bootm 40020000
3592c609719bSwdenk	## Booting Linux kernel at 40020000 ...
3593c609719bSwdenk	   Image Name:	 2.2.13 for NFS on TQM850L
3594c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3595c609719bSwdenk	   Data Size:	 381681 Bytes = 372 kB = 0 MB
3596c609719bSwdenk	   Load Address: 00000000
3597c609719bSwdenk	   Entry Point:	 0000000c
3598c609719bSwdenk	   Verifying Checksum ... OK
3599c609719bSwdenk	   Uncompressing Kernel Image ... OK
3600c609719bSwdenk	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
3601c609719bSwdenk	Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3602c609719bSwdenk	time_init: decrementer frequency = 187500000/60
3603c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
3604c609719bSwdenk	Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
3605c609719bSwdenk	...
3606c609719bSwdenk
360711ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass
36087152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT
3609c609719bSwdenkformat!) to the "bootm" command:
3610c609719bSwdenk
3611c609719bSwdenk	=> imi 40100000 40200000
3612c609719bSwdenk
3613c609719bSwdenk	## Checking Image at 40100000 ...
3614c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
3615c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3616c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
3617c609719bSwdenk	   Load Address: 00000000
3618c609719bSwdenk	   Entry Point:	 0000000c
3619c609719bSwdenk	   Verifying Checksum ... OK
3620c609719bSwdenk
3621c609719bSwdenk	## Checking Image at 40200000 ...
3622c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
3623c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
3624c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
3625c609719bSwdenk	   Load Address: 00000000
3626c609719bSwdenk	   Entry Point:	 00000000
3627c609719bSwdenk	   Verifying Checksum ... OK
3628c609719bSwdenk
3629c609719bSwdenk	=> bootm 40100000 40200000
3630c609719bSwdenk	## Booting Linux kernel at 40100000 ...
3631c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
3632c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3633c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
3634c609719bSwdenk	   Load Address: 00000000
3635c609719bSwdenk	   Entry Point:	 0000000c
3636c609719bSwdenk	   Verifying Checksum ... OK
3637c609719bSwdenk	   Uncompressing Kernel Image ... OK
3638c609719bSwdenk	## Loading RAMDisk Image at 40200000 ...
3639c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
3640c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
3641c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
3642c609719bSwdenk	   Load Address: 00000000
3643c609719bSwdenk	   Entry Point:	 00000000
3644c609719bSwdenk	   Verifying Checksum ... OK
3645c609719bSwdenk	   Loading Ramdisk ... OK
3646c609719bSwdenk	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
3647c609719bSwdenk	Boot arguments: root=/dev/ram
3648c609719bSwdenk	time_init: decrementer frequency = 187500000/60
3649c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
3650c609719bSwdenk	...
3651c609719bSwdenk	RAMDISK: Compressed image found at block 0
3652c609719bSwdenk	VFS: Mounted root (ext2 filesystem).
3653c609719bSwdenk
3654c609719bSwdenk	bash#
3655c609719bSwdenk
36560267768eSMatthew McClintockBoot Linux and pass a flat device tree:
36570267768eSMatthew McClintock-----------
36580267768eSMatthew McClintock
36590267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section
36600267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The
36610267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated
36620267768eSMatthew McClintockflat device tree:
36630267768eSMatthew McClintock
36640267768eSMatthew McClintock=> print oftaddr
36650267768eSMatthew McClintockoftaddr=0x300000
36660267768eSMatthew McClintock=> print oft
36670267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb
36680267768eSMatthew McClintock=> tftp $oftaddr $oft
36690267768eSMatthew McClintockSpeed: 1000, full duplex
36700267768eSMatthew McClintockUsing TSEC0 device
36710267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101
36720267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'.
36730267768eSMatthew McClintockLoad address: 0x300000
36740267768eSMatthew McClintockLoading: #
36750267768eSMatthew McClintockdone
36760267768eSMatthew McClintockBytes transferred = 4106 (100a hex)
36770267768eSMatthew McClintock=> tftp $loadaddr $bootfile
36780267768eSMatthew McClintockSpeed: 1000, full duplex
36790267768eSMatthew McClintockUsing TSEC0 device
36800267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2
36810267768eSMatthew McClintockFilename 'uImage'.
36820267768eSMatthew McClintockLoad address: 0x200000
36830267768eSMatthew McClintockLoading:############
36840267768eSMatthew McClintockdone
36850267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex)
36860267768eSMatthew McClintock=> print loadaddr
36870267768eSMatthew McClintockloadaddr=200000
36880267768eSMatthew McClintock=> print oftaddr
36890267768eSMatthew McClintockoftaddr=0x300000
36900267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr
36910267768eSMatthew McClintock## Booting image at 00200000 ...
36920267768eSMatthew McClintock   Image Name:	 Linux-2.6.17-dirty
36930267768eSMatthew McClintock   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
36940267768eSMatthew McClintock   Data Size:	 1029343 Bytes = 1005.2 kB
36950267768eSMatthew McClintock   Load Address: 00000000
36960267768eSMatthew McClintock   Entry Point:	 00000000
36970267768eSMatthew McClintock   Verifying Checksum ... OK
36980267768eSMatthew McClintock   Uncompressing Kernel Image ... OK
36990267768eSMatthew McClintockBooting using flat device tree at 0x300000
37000267768eSMatthew McClintockUsing MPC85xx ADS machine description
37010267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
37020267768eSMatthew McClintock[snip]
37030267768eSMatthew McClintock
37040267768eSMatthew McClintock
37056069ff26SwdenkMore About U-Boot Image Types:
37066069ff26Swdenk------------------------------
37076069ff26Swdenk
37086069ff26SwdenkU-Boot supports the following image types:
37096069ff26Swdenk
37106069ff26Swdenk   "Standalone Programs" are directly runnable in the environment
37116069ff26Swdenk	provided by U-Boot; it is expected that (if they behave
37126069ff26Swdenk	well) you can continue to work in U-Boot after return from
37136069ff26Swdenk	the Standalone Program.
37146069ff26Swdenk   "OS Kernel Images" are usually images of some Embedded OS which
37156069ff26Swdenk	will take over control completely. Usually these programs
37166069ff26Swdenk	will install their own set of exception handlers, device
37176069ff26Swdenk	drivers, set up the MMU, etc. - this means, that you cannot
37186069ff26Swdenk	expect to re-enter U-Boot except by resetting the CPU.
37196069ff26Swdenk   "RAMDisk Images" are more or less just data blocks, and their
37206069ff26Swdenk	parameters (address, size) are passed to an OS kernel that is
37216069ff26Swdenk	being started.
37226069ff26Swdenk   "Multi-File Images" contain several images, typically an OS
37236069ff26Swdenk	(Linux) kernel image and one or more data images like
37246069ff26Swdenk	RAMDisks. This construct is useful for instance when you want
37256069ff26Swdenk	to boot over the network using BOOTP etc., where the boot
37266069ff26Swdenk	server provides just a single image file, but you want to get
37276069ff26Swdenk	for instance an OS kernel and a RAMDisk image.
37286069ff26Swdenk
37296069ff26Swdenk	"Multi-File Images" start with a list of image sizes, each
37306069ff26Swdenk	image size (in bytes) specified by an "uint32_t" in network
37316069ff26Swdenk	byte order. This list is terminated by an "(uint32_t)0".
37326069ff26Swdenk	Immediately after the terminating 0 follow the images, one by
37336069ff26Swdenk	one, all aligned on "uint32_t" boundaries (size rounded up to
37346069ff26Swdenk	a multiple of 4 bytes).
37356069ff26Swdenk
37366069ff26Swdenk   "Firmware Images" are binary images containing firmware (like
37376069ff26Swdenk	U-Boot or FPGA images) which usually will be programmed to
37386069ff26Swdenk	flash memory.
37396069ff26Swdenk
37406069ff26Swdenk   "Script files" are command sequences that will be executed by
37416069ff26Swdenk	U-Boot's command interpreter; this feature is especially
37426069ff26Swdenk	useful when you configure U-Boot to use a real shell (hush)
37436069ff26Swdenk	as command interpreter.
37446069ff26Swdenk
3745c609719bSwdenk
3746c609719bSwdenkStandalone HOWTO:
3747c609719bSwdenk=================
3748c609719bSwdenk
3749c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and
3750c609719bSwdenkrun "standalone" applications, which can use some resources of
3751c609719bSwdenkU-Boot like console I/O functions or interrupt services.
3752c609719bSwdenk
3753c609719bSwdenkTwo simple examples are included with the sources:
3754c609719bSwdenk
3755c609719bSwdenk"Hello World" Demo:
3756c609719bSwdenk-------------------
3757c609719bSwdenk
3758c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo
3759c609719bSwdenkapplication; it is automatically compiled when you build U-Boot.
3760c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it
3761c609719bSwdenklike that:
3762c609719bSwdenk
3763c609719bSwdenk	=> loads
3764c609719bSwdenk	## Ready for S-Record download ...
3765c609719bSwdenk	~>examples/hello_world.srec
3766c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
3767c609719bSwdenk	[file transfer complete]
3768c609719bSwdenk	[connected]
3769c609719bSwdenk	## Start Addr = 0x00040004
3770c609719bSwdenk
3771c609719bSwdenk	=> go 40004 Hello World! This is a test.
3772c609719bSwdenk	## Starting application at 0x00040004 ...
3773c609719bSwdenk	Hello World
3774c609719bSwdenk	argc = 7
3775c609719bSwdenk	argv[0] = "40004"
3776c609719bSwdenk	argv[1] = "Hello"
3777c609719bSwdenk	argv[2] = "World!"
3778c609719bSwdenk	argv[3] = "This"
3779c609719bSwdenk	argv[4] = "is"
3780c609719bSwdenk	argv[5] = "a"
3781c609719bSwdenk	argv[6] = "test."
3782c609719bSwdenk	argv[7] = "<NULL>"
3783c609719bSwdenk	Hit any key to exit ...
3784c609719bSwdenk
3785c609719bSwdenk	## Application terminated, rc = 0x0
3786c609719bSwdenk
3787c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt
3788c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'.
3789c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second.
3790c609719bSwdenkThe interrupt service routine is trivial, just printing a '.'
3791c609719bSwdenkcharacter, but this is just a demo program. The application can be
3792c609719bSwdenkcontrolled by the following keys:
3793c609719bSwdenk
3794c609719bSwdenk	? - print current values og the CPM Timer registers
3795c609719bSwdenk	b - enable interrupts and start timer
3796c609719bSwdenk	e - stop timer and disable interrupts
3797c609719bSwdenk	q - quit application
3798c609719bSwdenk
3799c609719bSwdenk	=> loads
3800c609719bSwdenk	## Ready for S-Record download ...
3801c609719bSwdenk	~>examples/timer.srec
3802c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
3803c609719bSwdenk	[file transfer complete]
3804c609719bSwdenk	[connected]
3805c609719bSwdenk	## Start Addr = 0x00040004
3806c609719bSwdenk
3807c609719bSwdenk	=> go 40004
3808c609719bSwdenk	## Starting application at 0x00040004 ...
3809c609719bSwdenk	TIMERS=0xfff00980
3810c609719bSwdenk	Using timer 1
3811c609719bSwdenk	  tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
3812c609719bSwdenk
3813c609719bSwdenkHit 'b':
3814c609719bSwdenk	[q, b, e, ?] Set interval 1000000 us
3815c609719bSwdenk	Enabling timer
3816c609719bSwdenkHit '?':
3817c609719bSwdenk	[q, b, e, ?] ........
3818c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
3819c609719bSwdenkHit '?':
3820c609719bSwdenk	[q, b, e, ?] .
3821c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
3822c609719bSwdenkHit '?':
3823c609719bSwdenk	[q, b, e, ?] .
3824c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
3825c609719bSwdenkHit '?':
3826c609719bSwdenk	[q, b, e, ?] .
3827c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
3828c609719bSwdenkHit 'e':
3829c609719bSwdenk	[q, b, e, ?] ...Stopping timer
3830c609719bSwdenkHit 'q':
3831c609719bSwdenk	[q, b, e, ?] ## Application terminated, rc = 0x0
3832c609719bSwdenk
3833c609719bSwdenk
383485ec0bccSwdenkMinicom warning:
383585ec0bccSwdenk================
383685ec0bccSwdenk
38377152b1d0SwdenkOver time, many people have reported problems when trying to use the
383885ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd)
383985ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under
3840f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and
384185ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and
384285ec0bccSwdenkuse "cu" for S-Record download ("loads" command).
384385ec0bccSwdenk
384452f52c14SwdenkNevertheless, if you absolutely want to use it try adding this
384552f52c14Swdenkconfiguration to your "File transfer protocols" section:
384652f52c14Swdenk
384752f52c14Swdenk	   Name	   Program			Name U/D FullScr IO-Red. Multi
384852f52c14Swdenk	X  kermit  /usr/bin/kermit -i -l %l -s	 Y    U	   Y	   N	  N
384952f52c14Swdenk	Y  kermit  /usr/bin/kermit -i -l %l -r	 N    D	   Y	   N	  N
385052f52c14Swdenk
385152f52c14Swdenk
3852c609719bSwdenkNetBSD Notes:
3853c609719bSwdenk=============
3854c609719bSwdenk
3855c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host
3856c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx).
3857c609719bSwdenk
3858c609719bSwdenkBuilding requires a cross environment; it is known to work on
3859c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
3860c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make).
3861c609719bSwdenkNote that the cross-powerpc package does not install include files;
3862c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is
3863c609719bSwdenkmissing.  This file has to be installed and patched manually:
3864c609719bSwdenk
3865c609719bSwdenk	# cd /usr/pkg/cross/powerpc-netbsd/include
3866c609719bSwdenk	# mkdir powerpc
3867c609719bSwdenk	# ln -s powerpc machine
3868c609719bSwdenk	# cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
3869c609719bSwdenk	# ${EDIT} powerpc/ansi.h	## must remove __va_list, _BSD_VA_LIST
3870c609719bSwdenk
3871c609719bSwdenkNative builds *don't* work due to incompatibilities between native
3872c609719bSwdenkand U-Boot include files.
3873c609719bSwdenk
3874c609719bSwdenkBooting assumes that (the first part of) the image booted is a
3875c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel
3876c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source
3877c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
38782a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
3879c609719bSwdenk
3880c609719bSwdenk
3881c609719bSwdenkImplementation Internals:
3882c609719bSwdenk=========================
3883c609719bSwdenk
3884c609719bSwdenkThe following is not intended to be a complete description of every
3885c609719bSwdenkimplementation detail. However, it should help to understand the
3886c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom
3887c609719bSwdenkhardware.
3888c609719bSwdenk
3889c609719bSwdenk
3890c609719bSwdenkInitial Stack, Global Data:
3891c609719bSwdenk---------------------------
3892c609719bSwdenk
3893c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot
3894c609719bSwdenkstarts running out of ROM (flash memory), usually without access to
3895c609719bSwdenksystem RAM (because the memory controller is not initialized yet).
3896c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS
3897c609719bSwdenkis not initialized as zero. To be able to get a C environment working
3898c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation
3899c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU
3900c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and
3901c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be
3902c609719bSwdenklocked as (mis-) used as memory, etc.
3903c609719bSwdenk
39047152b1d0Swdenk	Chris Hallinan posted a good summary of these issues to the
39050668236bSWolfgang Denk	U-Boot mailing list:
390643d9616cSwdenk
390743d9616cSwdenk	Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
390843d9616cSwdenk	From: "Chris Hallinan" <clh@net1plus.com>
390943d9616cSwdenk	Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
391043d9616cSwdenk	...
391143d9616cSwdenk
391243d9616cSwdenk	Correct me if I'm wrong, folks, but the way I understand it
391343d9616cSwdenk	is this: Using DCACHE as initial RAM for Stack, etc, does not
391443d9616cSwdenk	require any physical RAM backing up the cache. The cleverness
391543d9616cSwdenk	is that the cache is being used as a temporary supply of
391643d9616cSwdenk	necessary storage before the SDRAM controller is setup. It's
391711ccc33fSMarcel Ziswiler	beyond the scope of this list to explain the details, but you
391843d9616cSwdenk	can see how this works by studying the cache architecture and
391943d9616cSwdenk	operation in the architecture and processor-specific manuals.
392043d9616cSwdenk
392143d9616cSwdenk	OCM is On Chip Memory, which I believe the 405GP has 4K. It
392243d9616cSwdenk	is another option for the system designer to use as an
392311ccc33fSMarcel Ziswiler	initial stack/RAM area prior to SDRAM being available. Either
392443d9616cSwdenk	option should work for you. Using CS 4 should be fine if your
392543d9616cSwdenk	board designers haven't used it for something that would
392643d9616cSwdenk	cause you grief during the initial boot! It is frequently not
392743d9616cSwdenk	used.
392843d9616cSwdenk
39296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
393043d9616cSwdenk	with your processor/board/system design. The default value
393143d9616cSwdenk	you will find in any recent u-boot distribution in
39328a316c9bSStefan Roese	walnut.h should work for you. I'd set it to a value larger
393343d9616cSwdenk	than your SDRAM module. If you have a 64MB SDRAM module, set
393443d9616cSwdenk	it above 400_0000. Just make sure your board has no resources
393543d9616cSwdenk	that are supposed to respond to that address! That code in
393643d9616cSwdenk	start.S has been around a while and should work as is when
393743d9616cSwdenk	you get the config right.
393843d9616cSwdenk
393943d9616cSwdenk	-Chris Hallinan
394043d9616cSwdenk	DS4.COM, Inc.
394143d9616cSwdenk
3942c609719bSwdenkIt is essential to remember this, since it has some impact on the C
3943c609719bSwdenkcode for the initialization procedures:
3944c609719bSwdenk
3945c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt
3946c609719bSwdenk  to write it.
3947c609719bSwdenk
394811ccc33fSMarcel Ziswiler* Do not use any uninitialized global data (or implicitely initialized
3949c609719bSwdenk  as zero data - BSS segment) at all - this is undefined, initiali-
39507152b1d0Swdenk  zation is performed later (when relocating to RAM).
3951c609719bSwdenk
3952c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like
3953c609719bSwdenk  that.
3954c609719bSwdenk
3955c609719bSwdenkHaving only the stack as writable memory limits means we cannot use
3956c609719bSwdenknormal global data to share information beween the code. But it
3957c609719bSwdenkturned out that the implementation of U-Boot can be greatly
3958c609719bSwdenksimplified by making a global data structure (gd_t) available to all
3959c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_
3960c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of
3961c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we
3962c609719bSwdenkplace a pointer (gd) to the global data into a register which we
3963c609719bSwdenkreserve for this purpose.
3964c609719bSwdenk
39657152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the
3966c609719bSwdenkrelevant  (E)ABI  specifications for the current architecture, and by
3967c609719bSwdenkGCC's implementation.
3968c609719bSwdenk
3969c609719bSwdenkFor PowerPC, the following registers have specific use:
3970c609719bSwdenk	R1:	stack pointer
3971e7670f6cSWolfgang Denk	R2:	reserved for system use
3972c609719bSwdenk	R3-R4:	parameter passing and return values
3973c609719bSwdenk	R5-R10: parameter passing
3974c609719bSwdenk	R13:	small data area pointer
3975c609719bSwdenk	R30:	GOT pointer
3976c609719bSwdenk	R31:	frame pointer
3977c609719bSwdenk
3978e6bee808SJoakim Tjernlund	(U-Boot also uses R12 as internal GOT pointer. r12
3979e6bee808SJoakim Tjernlund	is a volatile register so r12 needs to be reset when
3980e6bee808SJoakim Tjernlund	going back and forth between asm and C)
3981c609719bSwdenk
3982e7670f6cSWolfgang Denk    ==> U-Boot will use R2 to hold a pointer to the global data
3983c609719bSwdenk
3984c609719bSwdenk    Note: on PPC, we could use a static initializer (since the
3985c609719bSwdenk    address of the global data structure is known at compile time),
3986c609719bSwdenk    but it turned out that reserving a register results in somewhat
3987c609719bSwdenk    smaller code - although the code savings are not that big (on
3988c609719bSwdenk    average for all boards 752 bytes for the whole U-Boot image,
3989c609719bSwdenk    624 text + 127 data).
3990c609719bSwdenk
3991c4db335cSRobin GetzOn Blackfin, the normal C ABI (except for P3) is followed as documented here:
39924c58eb55SMike Frysinger	http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
39934c58eb55SMike Frysinger
3994c4db335cSRobin Getz    ==> U-Boot will use P3 to hold a pointer to the global data
39954c58eb55SMike Frysinger
3996c609719bSwdenkOn ARM, the following registers are used:
3997c609719bSwdenk
3998c609719bSwdenk	R0:	function argument word/integer result
3999c609719bSwdenk	R1-R3:	function argument word
4000c609719bSwdenk	R9:	GOT pointer
4001c609719bSwdenk	R10:	stack limit (used only if stack checking if enabled)
4002c609719bSwdenk	R11:	argument (frame) pointer
4003c609719bSwdenk	R12:	temporary workspace
4004c609719bSwdenk	R13:	stack pointer
4005c609719bSwdenk	R14:	link register
4006c609719bSwdenk	R15:	program counter
4007c609719bSwdenk
4008c609719bSwdenk    ==> U-Boot will use R8 to hold a pointer to the global data
4009c609719bSwdenk
4010d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
4011d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much.
4012c609719bSwdenk
4013c609719bSwdenkMemory Management:
4014c609719bSwdenk------------------
4015c609719bSwdenk
4016c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the
4017c609719bSwdenkMMU is not used either for address mapping nor for memory protection.
4018c609719bSwdenk
4019c609719bSwdenkThe available memory is mapped to fixed addresses using the memory
4020c609719bSwdenkcontroller. In this process, a contiguous block is formed for each
4021c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several
4022c609719bSwdenkphysical memory banks.
4023c609719bSwdenk
4024c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on
4025c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
4026c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself
4027c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some
40286d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
4029c609719bSwdenkconfiguration setting]. Below that, a structure with global Board
4030c609719bSwdenkInfo data is placed, followed by the stack (growing downward).
4031c609719bSwdenk
4032c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB
4033c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF).
4034c609719bSwdenk
4035c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like
4036c609719bSwdenkthis:
4037c609719bSwdenk
4038c609719bSwdenk	0x0000 0000	Exception Vector code
4039c609719bSwdenk	      :
4040c609719bSwdenk	0x0000 1FFF
4041c609719bSwdenk	0x0000 2000	Free for Application Use
4042c609719bSwdenk	      :
4043c609719bSwdenk	      :
4044c609719bSwdenk
4045c609719bSwdenk	      :
4046c609719bSwdenk	      :
4047c609719bSwdenk	0x00FB FF20	Monitor Stack (Growing downward)
4048c609719bSwdenk	0x00FB FFAC	Board Info Data and permanent copy of global data
4049c609719bSwdenk	0x00FC 0000	Malloc Arena
4050c609719bSwdenk	      :
4051c609719bSwdenk	0x00FD FFFF
4052c609719bSwdenk	0x00FE 0000	RAM Copy of Monitor Code
4053c609719bSwdenk	...		eventually: LCD or video framebuffer
4054c609719bSwdenk	...		eventually: pRAM (Protected RAM - unchanged by reset)
4055c609719bSwdenk	0x00FF FFFF	[End of RAM]
4056c609719bSwdenk
4057c609719bSwdenk
4058c609719bSwdenkSystem Initialization:
4059c609719bSwdenk----------------------
4060c609719bSwdenk
4061c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point
406211ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset
4063c609719bSwdenkconfiguration for CS0# this is a mirror of the onboard Flash memory.
40647152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address.
4065c609719bSwdenkTo be able to implement the initialization code in C, a (small!)
4066c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs
4067c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked
4068c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core,
4069c609719bSwdenkthe caches and the SIU.
4070c609719bSwdenk
4071c609719bSwdenkNext, all (potentially) available memory banks are mapped using a
4072c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries
4073c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
4074c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
4075c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a
4076c609719bSwdenksimple memory test is run that determines the size of the SDRAM
4077c609719bSwdenkbanks.
4078c609719bSwdenk
4079c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of
40807152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first
4081c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address
4082c609719bSwdenk0x00000000, with any additional banks following immediately to create
4083c609719bSwdenkcontiguous memory starting from 0.
4084c609719bSwdenk
4085c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area
4086c609719bSwdenkand allocates memory for use by malloc() and for the global Board
4087c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM
4088c609719bSwdenkpages, and the final stack is set up.
4089c609719bSwdenk
4090c609719bSwdenkOnly after this relocation will you have a "normal" C environment;
4091c609719bSwdenkuntil that you are restricted in several ways, mostly because you are
4092c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a
4093c609719bSwdenknew address in RAM.
4094c609719bSwdenk
4095c609719bSwdenk
4096c609719bSwdenkU-Boot Porting Guide:
4097c609719bSwdenk----------------------
4098c609719bSwdenk
4099c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
41006aff3115Swdenklist, October 2002]
4101c609719bSwdenk
4102c609719bSwdenk
4103c609719bSwdenkint main(int argc, char *argv[])
4104c609719bSwdenk{
4105c609719bSwdenk	sighandler_t no_more_time;
4106c609719bSwdenk
4107c609719bSwdenk	signal(SIGALRM, no_more_time);
4108c609719bSwdenk	alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
4109c609719bSwdenk
4110c609719bSwdenk	if (available_money > available_manpower) {
41116c3fef28SJerry Van Baren		Pay consultant to port U-Boot;
4112c609719bSwdenk		return 0;
4113c609719bSwdenk	}
4114c609719bSwdenk
4115c609719bSwdenk	Download latest U-Boot source;
4116c609719bSwdenk
41170668236bSWolfgang Denk	Subscribe to u-boot mailing list;
41186aff3115Swdenk
41196c3fef28SJerry Van Baren	if (clueless)
4120c609719bSwdenk		email("Hi, I am new to U-Boot, how do I get started?");
4121c609719bSwdenk
4122c609719bSwdenk	while (learning) {
4123c609719bSwdenk		Read the README file in the top level directory;
41247cb22f97Swdenk		Read http://www.denx.de/twiki/bin/view/DULG/Manual;
41256c3fef28SJerry Van Baren		Read applicable doc/*.README;
4126c609719bSwdenk		Read the source, Luke;
41276c3fef28SJerry Van Baren		/* find . -name "*.[chS]" | xargs grep -i <keyword> */
4128c609719bSwdenk	}
4129c609719bSwdenk
41306c3fef28SJerry Van Baren	if (available_money > toLocalCurrency ($2500))
41316c3fef28SJerry Van Baren		Buy a BDI3000;
41326c3fef28SJerry Van Baren	else
4133c609719bSwdenk		Add a lot of aggravation and time;
4134c609719bSwdenk
41356c3fef28SJerry Van Baren	if (a similar board exists) {	/* hopefully... */
41366c3fef28SJerry Van Baren		cp -a board/<similar> board/<myboard>
41376c3fef28SJerry Van Baren		cp include/configs/<similar>.h include/configs/<myboard>.h
41386c3fef28SJerry Van Baren	} else {
4139c609719bSwdenk		Create your own board support subdirectory;
41406c3fef28SJerry Van Baren		Create your own board include/configs/<myboard>.h file;
41416c3fef28SJerry Van Baren	}
41426c3fef28SJerry Van Baren	Edit new board/<myboard> files
41436c3fef28SJerry Van Baren	Edit new include/configs/<myboard>.h
4144c609719bSwdenk
41456c3fef28SJerry Van Baren	while (!accepted) {
4146c609719bSwdenk		while (!running) {
4147c609719bSwdenk			do {
4148c609719bSwdenk				Add / modify source code;
4149c609719bSwdenk			} until (compiles);
4150c609719bSwdenk			Debug;
4151c609719bSwdenk			if (clueless)
4152c609719bSwdenk				email("Hi, I am having problems...");
4153c609719bSwdenk		}
41546c3fef28SJerry Van Baren		Send patch file to the U-Boot email list;
41556c3fef28SJerry Van Baren		if (reasonable critiques)
41566c3fef28SJerry Van Baren			Incorporate improvements from email list code review;
41576c3fef28SJerry Van Baren		else
41586c3fef28SJerry Van Baren			Defend code as written;
41596c3fef28SJerry Van Baren	}
4160c609719bSwdenk
4161c609719bSwdenk	return 0;
4162c609719bSwdenk}
4163c609719bSwdenk
4164c609719bSwdenkvoid no_more_time (int sig)
4165c609719bSwdenk{
4166c609719bSwdenk      hire_a_guru();
4167c609719bSwdenk}
4168c609719bSwdenk
4169c609719bSwdenk
4170c609719bSwdenkCoding Standards:
4171c609719bSwdenk-----------------
4172c609719bSwdenk
4173c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel
41742c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script
41752c051651SDetlev Zundel"scripts/Lindent" in your Linux kernel source directory.  In sources
41762c051651SDetlev Zundeloriginating from U-Boot a style corresponding to "Lindent -pcs" (adding
41772c051651SDetlev Zundelspaces before parameters to function calls) is actually used.
4178c609719bSwdenk
41792c051651SDetlev ZundelSource files originating from a different project (for example the
41802c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not
41812c051651SDetlev Zundelreformated to ease subsequent migration to newer versions of those
41822c051651SDetlev Zundelsources.
41832c051651SDetlev Zundel
41842c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in
41852c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//)
41862c051651SDetlev Zundelin your code.
4187c609719bSwdenk
4188c178d3daSwdenkPlease also stick to the following formatting rules:
4189180d3f74Swdenk- remove any trailing white space
4190180d3f74Swdenk- use TAB characters for indentation, not spaces
4191180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds
4192180d3f74Swdenk- do not add more than 2 empty lines to source files
4193180d3f74Swdenk- do not add trailing empty lines to source files
4194180d3f74Swdenk
4195c609719bSwdenkSubmissions which do not conform to the standards may be returned
4196c609719bSwdenkwith a request to reformat the changes.
4197c609719bSwdenk
4198c609719bSwdenk
4199c609719bSwdenkSubmitting Patches:
4200c609719bSwdenk-------------------
4201c609719bSwdenk
4202c609719bSwdenkSince the number of patches for U-Boot is growing, we need to
4203c609719bSwdenkestablish some rules. Submissions which do not conform to these rules
4204c609719bSwdenkmay be rejected, even when they contain important and valuable stuff.
4205c609719bSwdenk
42060d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details.
4207218ca724SWolfgang Denk
42080668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
42090668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot
42100668236bSWolfgang Denk
4211c609719bSwdenkWhen you send a patch, please include the following information with
4212c609719bSwdenkit:
4213c609719bSwdenk
4214c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes
4215c609719bSwdenk  this bug. Please try to include a way of demonstrating that the
4216c609719bSwdenk  patch actually fixes something.
4217c609719bSwdenk
4218c609719bSwdenk* For new features: a description of the feature and your
4219c609719bSwdenk  implementation.
4220c609719bSwdenk
4221c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch)
4222c609719bSwdenk
4223c609719bSwdenk* For major contributions, your entry to the CREDITS file
4224c609719bSwdenk
4225c609719bSwdenk* When you add support for a new board, don't forget to add this
4226c609719bSwdenk  board to the MAKEALL script, too.
4227c609719bSwdenk
4228c609719bSwdenk* If your patch adds new configuration options, don't forget to
4229c609719bSwdenk  document these in the README file.
4230c609719bSwdenk
4231218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly*
4232218ca724SWolfgang Denk  recommended) you can easily generate the patch using the
4233218ca724SWolfgang Denk  "git-format-patch". If you then use "git-send-email" to send it to
4234218ca724SWolfgang Denk  the U-Boot mailing list, you will avoid most of the common problems
4235218ca724SWolfgang Denk  with some other mail clients.
4236c609719bSwdenk
4237218ca724SWolfgang Denk  If you cannot use git, use "diff -purN OLD NEW". If your version of
4238218ca724SWolfgang Denk  diff does not support these options, then get the latest version of
4239218ca724SWolfgang Denk  GNU diff.
42406dff5529Swdenk
4241218ca724SWolfgang Denk  The current directory when running this command shall be the parent
4242218ca724SWolfgang Denk  directory of the U-Boot source tree (i. e. please make sure that
4243218ca724SWolfgang Denk  your patch includes sufficient directory information for the
4244218ca724SWolfgang Denk  affected files).
4245218ca724SWolfgang Denk
4246218ca724SWolfgang Denk  We prefer patches as plain text. MIME attachments are discouraged,
4247218ca724SWolfgang Denk  and compressed attachments must not be used.
4248c609719bSwdenk
424952f52c14Swdenk* If one logical set of modifications affects or creates several
425052f52c14Swdenk  files, all these changes shall be submitted in a SINGLE patch file.
425152f52c14Swdenk
425252f52c14Swdenk* Changesets that contain different, unrelated modifications shall be
425352f52c14Swdenk  submitted as SEPARATE patches, one patch per changeset.
425452f52c14Swdenk
425552f52c14Swdenk
4256c609719bSwdenkNotes:
4257c609719bSwdenk
4258c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched
4259c609719bSwdenk  source tree and make sure that no errors or warnings are reported
4260c609719bSwdenk  for any of the boards.
4261c609719bSwdenk
4262c609719bSwdenk* Keep your modifications to the necessary minimum: A patch
4263c609719bSwdenk  containing several unrelated changes or arbitrary reformats will be
4264c609719bSwdenk  returned with a request to re-formatting / split it.
4265c609719bSwdenk
4266c609719bSwdenk* If you modify existing code, make sure that your new code does not
4267c609719bSwdenk  add to the memory footprint of the code ;-) Small is beautiful!
4268c609719bSwdenk  When adding new features, these should compile conditionally only
4269c609719bSwdenk  (using #ifdef), and the resulting code with the new feature
4270c609719bSwdenk  disabled must not need more memory than the old code without your
4271c609719bSwdenk  modification.
427290dc6704Swdenk
42730668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the
42740668236bSWolfgang Denk  u-boot mailing list. Bigger patches will be moderated. If they are
42750668236bSWolfgang Denk  reasonable and not too big, they will be acknowledged. But patches
42760668236bSWolfgang Denk  bigger than the size limit should be avoided.
4277