xref: /openbmc/u-boot/README (revision fea25720013f84427a0ba8833a38614fcaf488ba)
1c609719bSwdenk#
2cccfc2abSDetlev Zundel# (C) Copyright 2000 - 2009
3c609719bSwdenk# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4c609719bSwdenk#
5c609719bSwdenk# See file CREDITS for list of people who contributed to this
6c609719bSwdenk# project.
7c609719bSwdenk#
8c609719bSwdenk# This program is free software; you can redistribute it and/or
9c609719bSwdenk# modify it under the terms of the GNU General Public License as
10c609719bSwdenk# published by the Free Software Foundation; either version 2 of
11c609719bSwdenk# the License, or (at your option) any later version.
12c609719bSwdenk#
13c609719bSwdenk# This program is distributed in the hope that it will be useful,
14c609719bSwdenk# but WITHOUT ANY WARRANTY; without even the implied warranty of
15c609719bSwdenk# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	See the
16c609719bSwdenk# GNU General Public License for more details.
17c609719bSwdenk#
18c609719bSwdenk# You should have received a copy of the GNU General Public License
19c609719bSwdenk# along with this program; if not, write to the Free Software
20c609719bSwdenk# Foundation, Inc., 59 Temple Place, Suite 330, Boston,
21c609719bSwdenk# MA 02111-1307 USA
22c609719bSwdenk#
23c609719bSwdenk
24c609719bSwdenkSummary:
25c609719bSwdenk========
26c609719bSwdenk
2724ee89b9SwdenkThis directory contains the source code for U-Boot, a boot loader for
28e86e5a07SwdenkEmbedded boards based on PowerPC, ARM, MIPS and several other
29e86e5a07Swdenkprocessors, which can be installed in a boot ROM and used to
30e86e5a07Swdenkinitialize and test the hardware or to download and run application
31e86e5a07Swdenkcode.
32c609719bSwdenk
33c609719bSwdenkThe development of U-Boot is closely related to Linux: some parts of
3424ee89b9Swdenkthe source code originate in the Linux source tree, we have some
3524ee89b9Swdenkheader files in common, and special provision has been made to
36c609719bSwdenksupport booting of Linux images.
37c609719bSwdenk
38c609719bSwdenkSome attention has been paid to make this software easily
39c609719bSwdenkconfigurable and extendable. For instance, all monitor commands are
40c609719bSwdenkimplemented with the same call interface, so that it's very easy to
41c609719bSwdenkadd new commands. Also, instead of permanently adding rarely used
42c609719bSwdenkcode (for instance hardware test utilities) to the monitor, you can
43c609719bSwdenkload and run it dynamically.
44c609719bSwdenk
45c609719bSwdenk
46c609719bSwdenkStatus:
47c609719bSwdenk=======
48c609719bSwdenk
49c609719bSwdenkIn general, all boards for which a configuration option exists in the
50c609719bSwdenkMakefile have been tested to some extent and can be considered
51c609719bSwdenk"working". In fact, many of them are used in production systems.
52c609719bSwdenk
53c609719bSwdenkIn case of problems see the CHANGELOG and CREDITS files to find out
54218ca724SWolfgang Denkwho contributed the specific port. The MAINTAINERS file lists board
55218ca724SWolfgang Denkmaintainers.
56c609719bSwdenk
57c609719bSwdenk
58c609719bSwdenkWhere to get help:
59c609719bSwdenk==================
60c609719bSwdenk
61c609719bSwdenkIn case you have questions about, problems with or contributions for
62c609719bSwdenkU-Boot you should send a message to the U-Boot mailing list at
630c32565fSPeter Tyser<u-boot@lists.denx.de>. There is also an archive of previous traffic
640c32565fSPeter Tyseron the mailing list - please search the archive before asking FAQ's.
650c32565fSPeter TyserPlease see http://lists.denx.de/pipermail/u-boot and
660c32565fSPeter Tyserhttp://dir.gmane.org/gmane.comp.boot-loaders.u-boot
67c609719bSwdenk
68c609719bSwdenk
69218ca724SWolfgang DenkWhere to get source code:
70218ca724SWolfgang Denk=========================
71218ca724SWolfgang Denk
72218ca724SWolfgang DenkThe U-Boot source code is maintained in the git repository at
73218ca724SWolfgang Denkgit://www.denx.de/git/u-boot.git ; you can browse it online at
74218ca724SWolfgang Denkhttp://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
75218ca724SWolfgang Denk
76218ca724SWolfgang DenkThe "snapshot" links on this page allow you to download tarballs of
7711ccc33fSMarcel Ziswilerany version you might be interested in. Official releases are also
78218ca724SWolfgang Denkavailable for FTP download from the ftp://ftp.denx.de/pub/u-boot/
79218ca724SWolfgang Denkdirectory.
80218ca724SWolfgang Denk
81d4ee711dSAnatolij GustschinPre-built (and tested) images are available from
82218ca724SWolfgang Denkftp://ftp.denx.de/pub/u-boot/images/
83218ca724SWolfgang Denk
84218ca724SWolfgang Denk
85c609719bSwdenkWhere we come from:
86c609719bSwdenk===================
87c609719bSwdenk
88c609719bSwdenk- start from 8xxrom sources
8924ee89b9Swdenk- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
90c609719bSwdenk- clean up code
91c609719bSwdenk- make it easier to add custom boards
92c609719bSwdenk- make it possible to add other [PowerPC] CPUs
93c609719bSwdenk- extend functions, especially:
94c609719bSwdenk  * Provide extended interface to Linux boot loader
95c609719bSwdenk  * S-Record download
96c609719bSwdenk  * network boot
9711ccc33fSMarcel Ziswiler  * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
9824ee89b9Swdenk- create ARMBoot project (http://sourceforge.net/projects/armboot)
99c609719bSwdenk- add other CPU families (starting with ARM)
10024ee89b9Swdenk- create U-Boot project (http://sourceforge.net/projects/u-boot)
1010d28f34bSMagnus Lilja- current project page: see http://www.denx.de/wiki/U-Boot
10224ee89b9Swdenk
10324ee89b9Swdenk
10424ee89b9SwdenkNames and Spelling:
10524ee89b9Swdenk===================
10624ee89b9Swdenk
10724ee89b9SwdenkThe "official" name of this project is "Das U-Boot". The spelling
10824ee89b9Swdenk"U-Boot" shall be used in all written text (documentation, comments
10924ee89b9Swdenkin source files etc.). Example:
11024ee89b9Swdenk
11124ee89b9Swdenk	This is the README file for the U-Boot project.
11224ee89b9Swdenk
11324ee89b9SwdenkFile names etc. shall be based on the string "u-boot". Examples:
11424ee89b9Swdenk
11524ee89b9Swdenk	include/asm-ppc/u-boot.h
11624ee89b9Swdenk
11724ee89b9Swdenk	#include <asm/u-boot.h>
11824ee89b9Swdenk
11924ee89b9SwdenkVariable names, preprocessor constants etc. shall be either based on
12024ee89b9Swdenkthe string "u_boot" or on "U_BOOT". Example:
12124ee89b9Swdenk
12224ee89b9Swdenk	U_BOOT_VERSION		u_boot_logo
12324ee89b9Swdenk	IH_OS_U_BOOT		u_boot_hush_start
124c609719bSwdenk
125c609719bSwdenk
12693f19cc0SwdenkVersioning:
12793f19cc0Swdenk===========
12893f19cc0Swdenk
129360d883aSThomas WeberStarting with the release in October 2008, the names of the releases
130360d883aSThomas Weberwere changed from numerical release numbers without deeper meaning
131360d883aSThomas Weberinto a time stamp based numbering. Regular releases are identified by
132360d883aSThomas Webernames consisting of the calendar year and month of the release date.
133360d883aSThomas WeberAdditional fields (if present) indicate release candidates or bug fix
134360d883aSThomas Weberreleases in "stable" maintenance trees.
13593f19cc0Swdenk
136360d883aSThomas WeberExamples:
137360d883aSThomas Weber	U-Boot v2009.11     - Release November 2009
138360d883aSThomas Weber	U-Boot v2009.11.1   - Release 1 in version November 2009 stable tree
139360d883aSThomas Weber	U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release
14093f19cc0Swdenk
14193f19cc0Swdenk
142c609719bSwdenkDirectory Hierarchy:
143c609719bSwdenk====================
144c609719bSwdenk
1458d321b81SPeter Tyser/arch			Architecture specific files
1468d321b81SPeter Tyser  /arm			Files generic to ARM architecture
1478d321b81SPeter Tyser    /cpu		CPU specific files
1488d321b81SPeter Tyser      /arm720t		Files specific to ARM 720 CPUs
1498d321b81SPeter Tyser      /arm920t		Files specific to ARM 920 CPUs
1508d321b81SPeter Tyser	/at91rm9200	Files specific to Atmel AT91RM9200 CPU
1518d321b81SPeter Tyser	/imx		Files specific to Freescale MC9328 i.MX CPUs
1528d321b81SPeter Tyser	/s3c24x0	Files specific to Samsung S3C24X0 CPUs
1538d321b81SPeter Tyser      /arm925t		Files specific to ARM 925 CPUs
1548d321b81SPeter Tyser      /arm926ejs	Files specific to ARM 926 CPUs
1558d321b81SPeter Tyser      /arm1136		Files specific to ARM 1136 CPUs
1568d321b81SPeter Tyser      /ixp		Files specific to Intel XScale IXP CPUs
1578d321b81SPeter Tyser      /pxa		Files specific to Intel XScale PXA CPUs
1588d321b81SPeter Tyser      /s3c44b0		Files specific to Samsung S3C44B0 CPUs
1598d321b81SPeter Tyser      /sa1100		Files specific to Intel StrongARM SA1100 CPUs
1608d321b81SPeter Tyser    /lib		Architecture specific library files
1618d321b81SPeter Tyser  /avr32		Files generic to AVR32 architecture
1628d321b81SPeter Tyser    /cpu		CPU specific files
1638d321b81SPeter Tyser    /lib		Architecture specific library files
1648d321b81SPeter Tyser  /blackfin		Files generic to Analog Devices Blackfin architecture
1658d321b81SPeter Tyser    /cpu		CPU specific files
1668d321b81SPeter Tyser    /lib		Architecture specific library files
167*fea25720SGraeme Russ  /x86			Files generic to x86 architecture
1688d321b81SPeter Tyser    /cpu		CPU specific files
1698d321b81SPeter Tyser    /lib		Architecture specific library files
1708d321b81SPeter Tyser  /m68k			Files generic to m68k architecture
1718d321b81SPeter Tyser    /cpu		CPU specific files
1728d321b81SPeter Tyser      /mcf52x2		Files specific to Freescale ColdFire MCF52x2 CPUs
1738d321b81SPeter Tyser      /mcf5227x		Files specific to Freescale ColdFire MCF5227x CPUs
1748d321b81SPeter Tyser      /mcf532x		Files specific to Freescale ColdFire MCF5329 CPUs
1758d321b81SPeter Tyser      /mcf5445x		Files specific to Freescale ColdFire MCF5445x CPUs
1768d321b81SPeter Tyser      /mcf547x_8x	Files specific to Freescale ColdFire MCF547x_8x CPUs
1778d321b81SPeter Tyser    /lib		Architecture specific library files
1788d321b81SPeter Tyser  /microblaze		Files generic to microblaze architecture
1798d321b81SPeter Tyser    /cpu		CPU specific files
1808d321b81SPeter Tyser    /lib		Architecture specific library files
1818d321b81SPeter Tyser  /mips			Files generic to MIPS architecture
1828d321b81SPeter Tyser    /cpu		CPU specific files
1838d321b81SPeter Tyser    /lib		Architecture specific library files
1848d321b81SPeter Tyser  /nios2		Files generic to Altera NIOS2 architecture
1858d321b81SPeter Tyser    /cpu		CPU specific files
1868d321b81SPeter Tyser    /lib		Architecture specific library files
187a47a12beSStefan Roese  /powerpc		Files generic to PowerPC architecture
1888d321b81SPeter Tyser    /cpu		CPU specific files
1898d321b81SPeter Tyser      /74xx_7xx		Files specific to Freescale MPC74xx and 7xx CPUs
1908d321b81SPeter Tyser      /mpc5xx		Files specific to Freescale MPC5xx CPUs
1918d321b81SPeter Tyser      /mpc5xxx		Files specific to Freescale MPC5xxx CPUs
1928d321b81SPeter Tyser      /mpc8xx		Files specific to Freescale MPC8xx CPUs
1938d321b81SPeter Tyser      /mpc8220		Files specific to Freescale MPC8220 CPUs
1948d321b81SPeter Tyser      /mpc824x		Files specific to Freescale MPC824x CPUs
1958d321b81SPeter Tyser      /mpc8260		Files specific to Freescale MPC8260 CPUs
1968d321b81SPeter Tyser      /mpc85xx		Files specific to Freescale MPC85xx CPUs
1978d321b81SPeter Tyser      /ppc4xx		Files specific to AMCC PowerPC 4xx CPUs
1988d321b81SPeter Tyser    /lib		Architecture specific library files
1998d321b81SPeter Tyser  /sh			Files generic to SH architecture
2008d321b81SPeter Tyser    /cpu		CPU specific files
2018d321b81SPeter Tyser      /sh2		Files specific to sh2 CPUs
2028d321b81SPeter Tyser      /sh3		Files specific to sh3 CPUs
2038d321b81SPeter Tyser      /sh4		Files specific to sh4 CPUs
2048d321b81SPeter Tyser    /lib		Architecture specific library files
2058d321b81SPeter Tyser  /sparc		Files generic to SPARC architecture
2068d321b81SPeter Tyser    /cpu		CPU specific files
2078d321b81SPeter Tyser      /leon2		Files specific to Gaisler LEON2 SPARC CPU
2088d321b81SPeter Tyser      /leon3		Files specific to Gaisler LEON3 SPARC CPU
2098d321b81SPeter Tyser    /lib		Architecture specific library files
2108d321b81SPeter Tyser/api			Machine/arch independent API for external apps
2118d321b81SPeter Tyser/board			Board dependent files
2128d321b81SPeter Tyser/common			Misc architecture independent functions
2138d321b81SPeter Tyser/disk			Code for disk drive partition handling
2148d321b81SPeter Tyser/doc			Documentation (don't expect too much)
2158d321b81SPeter Tyser/drivers		Commonly used device drivers
2168d321b81SPeter Tyser/examples		Example code for standalone applications, etc.
2178d321b81SPeter Tyser/fs			Filesystem code (cramfs, ext2, jffs2, etc.)
2188d321b81SPeter Tyser/include		Header Files
2198d321b81SPeter Tyser/lib			Files generic to all architectures
2208d321b81SPeter Tyser  /libfdt		Library files to support flattened device trees
2218d321b81SPeter Tyser  /lzma			Library files to support LZMA decompression
2228d321b81SPeter Tyser  /lzo			Library files to support LZO decompression
2238d321b81SPeter Tyser/net			Networking code
2248d321b81SPeter Tyser/post			Power On Self Test
2258d321b81SPeter Tyser/rtc			Real Time Clock drivers
2268d321b81SPeter Tyser/tools			Tools to build S-Record or U-Boot images, etc.
227c609719bSwdenk
228c609719bSwdenkSoftware Configuration:
229c609719bSwdenk=======================
230c609719bSwdenk
231c609719bSwdenkConfiguration is usually done using C preprocessor defines; the
232c609719bSwdenkrationale behind that is to avoid dead code whenever possible.
233c609719bSwdenk
234c609719bSwdenkThere are two classes of configuration variables:
235c609719bSwdenk
236c609719bSwdenk* Configuration _OPTIONS_:
237c609719bSwdenk  These are selectable by the user and have names beginning with
238c609719bSwdenk  "CONFIG_".
239c609719bSwdenk
240c609719bSwdenk* Configuration _SETTINGS_:
241c609719bSwdenk  These depend on the hardware etc. and should not be meddled with if
242c609719bSwdenk  you don't know what you're doing; they have names beginning with
2436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  "CONFIG_SYS_".
244c609719bSwdenk
245c609719bSwdenkLater we will add a configuration tool - probably similar to or even
246c609719bSwdenkidentical to what's used for the Linux kernel. Right now, we have to
247c609719bSwdenkdo the configuration by hand, which means creating some symbolic
248c609719bSwdenklinks and editing some configuration files. We use the TQM8xxL boards
249c609719bSwdenkas an example here.
250c609719bSwdenk
251c609719bSwdenk
252c609719bSwdenkSelection of Processor Architecture and Board Type:
253c609719bSwdenk---------------------------------------------------
254c609719bSwdenk
255c609719bSwdenkFor all supported boards there are ready-to-use default
256c609719bSwdenkconfigurations available; just type "make <board_name>_config".
257c609719bSwdenk
258c609719bSwdenkExample: For a TQM823L module type:
259c609719bSwdenk
260c609719bSwdenk	cd u-boot
261c609719bSwdenk	make TQM823L_config
262c609719bSwdenk
26311ccc33fSMarcel ZiswilerFor the Cogent platform, you need to specify the CPU type as well;
264c609719bSwdenke.g. "make cogent_mpc8xx_config". And also configure the cogent
265c609719bSwdenkdirectory according to the instructions in cogent/README.
266c609719bSwdenk
267c609719bSwdenk
268c609719bSwdenkConfiguration Options:
269c609719bSwdenk----------------------
270c609719bSwdenk
271c609719bSwdenkConfiguration depends on the combination of board and CPU type; all
272c609719bSwdenksuch information is kept in a configuration file
273c609719bSwdenk"include/configs/<board_name>.h".
274c609719bSwdenk
275c609719bSwdenkExample: For a TQM823L module, all configuration settings are in
276c609719bSwdenk"include/configs/TQM823L.h".
277c609719bSwdenk
278c609719bSwdenk
2797f6c2cbcSwdenkMany of the options are named exactly as the corresponding Linux
2807f6c2cbcSwdenkkernel configuration options. The intention is to make it easier to
2817f6c2cbcSwdenkbuild a config tool - later.
2827f6c2cbcSwdenk
2837f6c2cbcSwdenk
284c609719bSwdenkThe following options need to be configured:
285c609719bSwdenk
2862628114eSKim Phillips- CPU Type:	Define exactly one, e.g. CONFIG_MPC85XX.
287c609719bSwdenk
2882628114eSKim Phillips- Board Type:	Define exactly one, e.g. CONFIG_MPC8540ADS.
2896ccec449SWolfgang Denk
2906ccec449SWolfgang Denk- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
29109ea0de0SHaavard Skinnemoen		Define exactly one, e.g. CONFIG_ATSTK1002
292c609719bSwdenk
293c609719bSwdenk- CPU Module Type: (if CONFIG_COGENT is defined)
294c609719bSwdenk		Define exactly one of
295c609719bSwdenk		CONFIG_CMA286_60_OLD
296c609719bSwdenk--- FIXME --- not tested yet:
297c609719bSwdenk		CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
298c609719bSwdenk		CONFIG_CMA287_23, CONFIG_CMA287_50
299c609719bSwdenk
300c609719bSwdenk- Motherboard Type: (if CONFIG_COGENT is defined)
301c609719bSwdenk		Define exactly one of
302c609719bSwdenk		CONFIG_CMA101, CONFIG_CMA102
303c609719bSwdenk
304c609719bSwdenk- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
305c609719bSwdenk		Define one or more of
306c609719bSwdenk		CONFIG_CMA302
307c609719bSwdenk
308c609719bSwdenk- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
309c609719bSwdenk		Define one or more of
310c609719bSwdenk		CONFIG_LCD_HEARTBEAT	- update a character position on
31111ccc33fSMarcel Ziswiler					  the LCD display every second with
312c609719bSwdenk					  a "rotator" |\-/|\-/
313c609719bSwdenk
3142535d602Swdenk- Board flavour: (if CONFIG_MPC8260ADS is defined)
3152535d602Swdenk		CONFIG_ADSTYPE
3162535d602Swdenk		Possible values are:
3176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8260ADS	- original MPC8260ADS
3186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8266ADS	- MPC8266ADS
3196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_PQ2FADS	- PQ2FADS-ZU or PQ2FADS-VR
3206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8272ADS	- MPC8272ADS
3212535d602Swdenk
322cf946c6dSLei Wen- Marvell Family Member
323cf946c6dSLei Wen		CONFIG_SYS_MVFS		- define it if you want to enable
324cf946c6dSLei Wen					  multiple fs option at one time
325cf946c6dSLei Wen					  for marvell soc family
326cf946c6dSLei Wen
327c609719bSwdenk- MPC824X Family Member (if CONFIG_MPC824X is defined)
328c609719bSwdenk		Define exactly one of
329c609719bSwdenk		CONFIG_MPC8240, CONFIG_MPC8245
330c609719bSwdenk
33111ccc33fSMarcel Ziswiler- 8xx CPU Options: (if using an MPC8xx CPU)
33266ca92a5Swdenk		CONFIG_8xx_GCLK_FREQ	- deprecated: CPU clock if
33366ca92a5Swdenk					  get_gclk_freq() cannot work
3345da627a4Swdenk					  e.g. if there is no 32KHz
3355da627a4Swdenk					  reference PIT/RTC clock
33666ca92a5Swdenk		CONFIG_8xx_OSCLK	- PLL input clock (either EXTCLK
33766ca92a5Swdenk					  or XTAL/EXTAL)
338c609719bSwdenk
33966ca92a5Swdenk- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
3406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MIN
3416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MAX
34266ca92a5Swdenk		CONFIG_8xx_CPUCLK_DEFAULT
34375d1ea7fSwdenk			See doc/README.MPC866
34475d1ea7fSwdenk
3456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MEASURE_CPUCLK
34675d1ea7fSwdenk
34775d1ea7fSwdenk		Define this to measure the actual CPU clock instead
34875d1ea7fSwdenk		of relying on the correctness of the configured
34975d1ea7fSwdenk		values. Mostly useful for board bringup to make sure
35075d1ea7fSwdenk		the PLL is locked at the intended frequency. Note
35175d1ea7fSwdenk		that this requires a (stable) reference clock (32 kHz
3526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		RTC clock or CONFIG_SYS_8XX_XIN)
35375d1ea7fSwdenk
354506f3918SHeiko Schocher		CONFIG_SYS_DELAYED_ICACHE
355506f3918SHeiko Schocher
356506f3918SHeiko Schocher		Define this option if you want to enable the
357506f3918SHeiko Schocher		ICache only when Code runs from RAM.
358506f3918SHeiko Schocher
3590b953ffcSMarkus Klotzbuecher- Intel Monahans options:
3606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
3610b953ffcSMarkus Klotzbuecher
3620b953ffcSMarkus Klotzbuecher		Defines the Monahans run mode to oscillator
3630b953ffcSMarkus Klotzbuecher		ratio. Valid values are 8, 16, 24, 31. The core
3640b953ffcSMarkus Klotzbuecher		frequency is this value multiplied by 13 MHz.
3650b953ffcSMarkus Klotzbuecher
3666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
3670b953ffcSMarkus Klotzbuecher
3680b953ffcSMarkus Klotzbuecher		Defines the Monahans turbo mode to oscillator
3690b953ffcSMarkus Klotzbuecher		ratio. Valid values are 1 (default if undefined) and
3700b953ffcSMarkus Klotzbuecher		2. The core frequency as calculated above is multiplied
3710b953ffcSMarkus Klotzbuecher		by this value.
3720b953ffcSMarkus Klotzbuecher
3735da627a4Swdenk- Linux Kernel Interface:
374c609719bSwdenk		CONFIG_CLOCKS_IN_MHZ
375c609719bSwdenk
376c609719bSwdenk		U-Boot stores all clock information in Hz
377c609719bSwdenk		internally. For binary compatibility with older Linux
378c609719bSwdenk		kernels (which expect the clocks passed in the
379c609719bSwdenk		bd_info data to be in MHz) the environment variable
380c609719bSwdenk		"clocks_in_mhz" can be defined so that U-Boot
381c609719bSwdenk		converts clock data to MHZ before passing it to the
382c609719bSwdenk		Linux kernel.
383c609719bSwdenk		When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
384c609719bSwdenk		"clocks_in_mhz=1" is automatically included in the
385c609719bSwdenk		default environment.
386c609719bSwdenk
3875da627a4Swdenk		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]
3885da627a4Swdenk
38911ccc33fSMarcel Ziswiler		When transferring memsize parameter to linux, some versions
3905da627a4Swdenk		expect it to be in bytes, others in MB.
3915da627a4Swdenk		Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
3925da627a4Swdenk
393fec6d9eeSGerald Van Baren		CONFIG_OF_LIBFDT
394f57f70aaSWolfgang Denk
395f57f70aaSWolfgang Denk		New kernel versions are expecting firmware settings to be
396213bf8c8SGerald Van Baren		passed using flattened device trees (based on open firmware
397213bf8c8SGerald Van Baren		concepts).
398213bf8c8SGerald Van Baren
399213bf8c8SGerald Van Baren		CONFIG_OF_LIBFDT
400213bf8c8SGerald Van Baren		 * New libfdt-based support
401213bf8c8SGerald Van Baren		 * Adds the "fdt" command
4023bb342fcSKim Phillips		 * The bootm command automatically updates the fdt
403213bf8c8SGerald Van Baren
404b55ae402SMarcel Ziswiler		OF_CPU - The proper name of the cpus node (only required for
405b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
406b55ae402SMarcel Ziswiler		OF_SOC - The proper name of the soc node (only required for
407b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
408f57f70aaSWolfgang Denk		OF_TBCLK - The timebase frequency.
409c2871f03SKumar Gala		OF_STDOUT_PATH - The path to the console device
410f57f70aaSWolfgang Denk
41111ccc33fSMarcel Ziswiler		boards with QUICC Engines require OF_QE to set UCC MAC
41211ccc33fSMarcel Ziswiler		addresses
4133bb342fcSKim Phillips
4144e253137SKumar Gala		CONFIG_OF_BOARD_SETUP
4154e253137SKumar Gala
4164e253137SKumar Gala		Board code has addition modification that it wants to make
4174e253137SKumar Gala		to the flat device tree before handing it off to the kernel
4186705d81eSwdenk
4190267768eSMatthew McClintock		CONFIG_OF_BOOT_CPU
4200267768eSMatthew McClintock
42111ccc33fSMarcel Ziswiler		This define fills in the correct boot CPU in the boot
4220267768eSMatthew McClintock		param header, the default value is zero if undefined.
4230267768eSMatthew McClintock
4243887c3fbSHeiko Schocher		CONFIG_OF_IDE_FIXUP
4253887c3fbSHeiko Schocher
4263887c3fbSHeiko Schocher		U-Boot can detect if an IDE device is present or not.
4273887c3fbSHeiko Schocher		If not, and this new config option is activated, U-Boot
4283887c3fbSHeiko Schocher		removes the ATA node from the DTS before booting Linux,
4293887c3fbSHeiko Schocher		so the Linux IDE driver does not probe the device and
4303887c3fbSHeiko Schocher		crash. This is needed for buggy hardware (uc101) where
4313887c3fbSHeiko Schocher		no pull down resistor is connected to the signal IDE5V_DD7.
4323887c3fbSHeiko Schocher
4330b2f4ecaSNiklaus Giger- vxWorks boot parameters:
4340b2f4ecaSNiklaus Giger
4350b2f4ecaSNiklaus Giger		bootvx constructs a valid bootline using the following
4360b2f4ecaSNiklaus Giger		environments variables: bootfile, ipaddr, serverip, hostname.
4370b2f4ecaSNiklaus Giger		It loads the vxWorks image pointed bootfile.
4380b2f4ecaSNiklaus Giger
4390b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
4400b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
4410b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
4420b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
4430b2f4ecaSNiklaus Giger
4440b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_ADD_PARAMS
4450b2f4ecaSNiklaus Giger
4460b2f4ecaSNiklaus Giger		Add it at the end of the bootline. E.g "u=username pw=secret"
4470b2f4ecaSNiklaus Giger
4480b2f4ecaSNiklaus Giger		Note: If a "bootargs" environment is defined, it will overwride
4490b2f4ecaSNiklaus Giger		the defaults discussed just above.
4500b2f4ecaSNiklaus Giger
4516705d81eSwdenk- Serial Ports:
45248d0192fSAndreas Engel		CONFIG_PL010_SERIAL
4536705d81eSwdenk
4546705d81eSwdenk		Define this if you want support for Amba PrimeCell PL010 UARTs.
4556705d81eSwdenk
45648d0192fSAndreas Engel		CONFIG_PL011_SERIAL
4576705d81eSwdenk
4586705d81eSwdenk		Define this if you want support for Amba PrimeCell PL011 UARTs.
4596705d81eSwdenk
4606705d81eSwdenk		CONFIG_PL011_CLOCK
4616705d81eSwdenk
4626705d81eSwdenk		If you have Amba PrimeCell PL011 UARTs, set this variable to
4636705d81eSwdenk		the clock speed of the UARTs.
4646705d81eSwdenk
4656705d81eSwdenk		CONFIG_PL01x_PORTS
4666705d81eSwdenk
4676705d81eSwdenk		If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
4686705d81eSwdenk		define this to a list of base addresses for each (supported)
4696705d81eSwdenk		port. See e.g. include/configs/versatile.h
4706705d81eSwdenk
4716705d81eSwdenk
472c609719bSwdenk- Console Interface:
473c609719bSwdenk		Depending on board, define exactly one serial port
474c609719bSwdenk		(like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
475c609719bSwdenk		CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
476c609719bSwdenk		console by defining CONFIG_8xx_CONS_NONE
477c609719bSwdenk
478c609719bSwdenk		Note: if CONFIG_8xx_CONS_NONE is defined, the serial
479c609719bSwdenk		port routines must be defined elsewhere
480c609719bSwdenk		(i.e. serial_init(), serial_getc(), ...)
481c609719bSwdenk
482c609719bSwdenk		CONFIG_CFB_CONSOLE
483c609719bSwdenk		Enables console device for a color framebuffer. Needs following
484c609719bSwdenk		defines (cf. smiLynxEM, i8042, board/eltec/bab7xx)
485c609719bSwdenk			VIDEO_FB_LITTLE_ENDIAN	graphic memory organisation
486c609719bSwdenk						(default big endian)
487c609719bSwdenk			VIDEO_HW_RECTFILL	graphic chip supports
488c609719bSwdenk						rectangle fill
489c609719bSwdenk						(cf. smiLynxEM)
490c609719bSwdenk			VIDEO_HW_BITBLT		graphic chip supports
491c609719bSwdenk						bit-blit (cf. smiLynxEM)
492c609719bSwdenk			VIDEO_VISIBLE_COLS	visible pixel columns
493c609719bSwdenk						(cols=pitch)
494c609719bSwdenk			VIDEO_VISIBLE_ROWS	visible pixel rows
495c609719bSwdenk			VIDEO_PIXEL_SIZE	bytes per pixel
496c609719bSwdenk			VIDEO_DATA_FORMAT	graphic data format
497c609719bSwdenk						(0-5, cf. cfb_console.c)
498c609719bSwdenk			VIDEO_FB_ADRS		framebuffer address
499c609719bSwdenk			VIDEO_KBD_INIT_FCT	keyboard int fct
500c609719bSwdenk						(i.e. i8042_kbd_init())
501c609719bSwdenk			VIDEO_TSTC_FCT		test char fct
502c609719bSwdenk						(i.e. i8042_tstc)
503c609719bSwdenk			VIDEO_GETC_FCT		get char fct
504c609719bSwdenk						(i.e. i8042_getc)
505c609719bSwdenk			CONFIG_CONSOLE_CURSOR	cursor drawing on/off
506c609719bSwdenk						(requires blink timer
507c609719bSwdenk						cf. i8042.c)
5086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
509c609719bSwdenk			CONFIG_CONSOLE_TIME	display time/date info in
510c609719bSwdenk						upper right corner
511602ad3b3SJon Loeliger						(requires CONFIG_CMD_DATE)
512c609719bSwdenk			CONFIG_VIDEO_LOGO	display Linux logo in
513c609719bSwdenk						upper left corner
514a6c7ad2fSwdenk			CONFIG_VIDEO_BMP_LOGO	use bmp_logo.h instead of
515a6c7ad2fSwdenk						linux_logo.h for logo.
516a6c7ad2fSwdenk						Requires CONFIG_VIDEO_LOGO
517c609719bSwdenk			CONFIG_CONSOLE_EXTRA_INFO
51811ccc33fSMarcel Ziswiler						additional board info beside
519c609719bSwdenk						the logo
520c609719bSwdenk
521c609719bSwdenk		When CONFIG_CFB_CONSOLE is defined, video console is
522c609719bSwdenk		default i/o. Serial console can be forced with
523c609719bSwdenk		environment 'console=serial'.
524c609719bSwdenk
525a3ad8e26Swdenk		When CONFIG_SILENT_CONSOLE is defined, all console
526a3ad8e26Swdenk		messages (by U-Boot and Linux!) can be silenced with
527a3ad8e26Swdenk		the "silent" environment variable. See
528a3ad8e26Swdenk		doc/README.silent for more information.
529a3ad8e26Swdenk
530c609719bSwdenk- Console Baudrate:
531c609719bSwdenk		CONFIG_BAUDRATE - in bps
532c609719bSwdenk		Select one of the baudrates listed in
5336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
5346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
535c609719bSwdenk
536c92fac91SHeiko Schocher- Console Rx buffer length
537c92fac91SHeiko Schocher		With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
538c92fac91SHeiko Schocher		the maximum receive buffer length for the SMC.
5392b3f12c2SHeiko Schocher		This option is actual only for 82xx and 8xx possible.
540c92fac91SHeiko Schocher		If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
541c92fac91SHeiko Schocher		must be defined, to setup the maximum idle timeout for
542c92fac91SHeiko Schocher		the SMC.
543c92fac91SHeiko Schocher
544c609719bSwdenk- Boot Delay:	CONFIG_BOOTDELAY - in seconds
545c609719bSwdenk		Delay before automatically booting the default image;
546c609719bSwdenk		set to -1 to disable autoboot.
547c609719bSwdenk
548c609719bSwdenk		See doc/README.autoboot for these options that
549c609719bSwdenk		work with CONFIG_BOOTDELAY. None are required.
550c609719bSwdenk		CONFIG_BOOT_RETRY_TIME
551c609719bSwdenk		CONFIG_BOOT_RETRY_MIN
552c609719bSwdenk		CONFIG_AUTOBOOT_KEYED
553c609719bSwdenk		CONFIG_AUTOBOOT_PROMPT
554c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR
555c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR
556c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR2
557c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR2
558c609719bSwdenk		CONFIG_ZERO_BOOTDELAY_CHECK
559c609719bSwdenk		CONFIG_RESET_TO_RETRY
560c609719bSwdenk
561c609719bSwdenk- Autoboot Command:
562c609719bSwdenk		CONFIG_BOOTCOMMAND
563c609719bSwdenk		Only needed when CONFIG_BOOTDELAY is enabled;
564c609719bSwdenk		define a command string that is automatically executed
565c609719bSwdenk		when no character is read on the console interface
566c609719bSwdenk		within "Boot Delay" after reset.
567c609719bSwdenk
568c609719bSwdenk		CONFIG_BOOTARGS
569c609719bSwdenk		This can be used to pass arguments to the bootm
570c609719bSwdenk		command. The value of CONFIG_BOOTARGS goes into the
571c609719bSwdenk		environment value "bootargs".
572c609719bSwdenk
573c609719bSwdenk		CONFIG_RAMBOOT and CONFIG_NFSBOOT
574c609719bSwdenk		The value of these goes into the environment as
575c609719bSwdenk		"ramboot" and "nfsboot" respectively, and can be used
576c609719bSwdenk		as a convenience, when switching between booting from
57711ccc33fSMarcel Ziswiler		RAM and NFS.
578c609719bSwdenk
579c609719bSwdenk- Pre-Boot Commands:
580c609719bSwdenk		CONFIG_PREBOOT
581c609719bSwdenk
582c609719bSwdenk		When this option is #defined, the existence of the
583c609719bSwdenk		environment variable "preboot" will be checked
584c609719bSwdenk		immediately before starting the CONFIG_BOOTDELAY
585c609719bSwdenk		countdown and/or running the auto-boot command resp.
586c609719bSwdenk		entering interactive mode.
587c609719bSwdenk
588c609719bSwdenk		This feature is especially useful when "preboot" is
589c609719bSwdenk		automatically generated or modified. For an example
590c609719bSwdenk		see the LWMON board specific code: here "preboot" is
591c609719bSwdenk		modified when the user holds down a certain
592c609719bSwdenk		combination of keys on the (special) keyboard when
593c609719bSwdenk		booting the systems
594c609719bSwdenk
595c609719bSwdenk- Serial Download Echo Mode:
596c609719bSwdenk		CONFIG_LOADS_ECHO
597c609719bSwdenk		If defined to 1, all characters received during a
598c609719bSwdenk		serial download (using the "loads" command) are
599c609719bSwdenk		echoed back. This might be needed by some terminal
600c609719bSwdenk		emulations (like "cu"), but may as well just take
601c609719bSwdenk		time on others. This setting #define's the initial
602c609719bSwdenk		value of the "loads_echo" environment variable.
603c609719bSwdenk
604602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
605c609719bSwdenk		CONFIG_KGDB_BAUDRATE
606c609719bSwdenk		Select one of the baudrates listed in
6076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
608c609719bSwdenk
609c609719bSwdenk- Monitor Functions:
610602ad3b3SJon Loeliger		Monitor commands can be included or excluded
611602ad3b3SJon Loeliger		from the build by using the #include files
612602ad3b3SJon Loeliger		"config_cmd_all.h" and #undef'ing unwanted
613602ad3b3SJon Loeliger		commands, or using "config_cmd_default.h"
614602ad3b3SJon Loeliger		and augmenting with additional #define's
615602ad3b3SJon Loeliger		for wanted commands.
616c609719bSwdenk
617602ad3b3SJon Loeliger		The default command configuration includes all commands
618602ad3b3SJon Loeliger		except those marked below with a "*".
619602ad3b3SJon Loeliger
620602ad3b3SJon Loeliger		CONFIG_CMD_ASKENV	* ask for env variable
621602ad3b3SJon Loeliger		CONFIG_CMD_BDI		  bdinfo
622602ad3b3SJon Loeliger		CONFIG_CMD_BEDBUG	* Include BedBug Debugger
623602ad3b3SJon Loeliger		CONFIG_CMD_BMP		* BMP support
624602ad3b3SJon Loeliger		CONFIG_CMD_BSP		* Board specific commands
625602ad3b3SJon Loeliger		CONFIG_CMD_BOOTD	  bootd
626602ad3b3SJon Loeliger		CONFIG_CMD_CACHE	* icache, dcache
627602ad3b3SJon Loeliger		CONFIG_CMD_CONSOLE	  coninfo
628602ad3b3SJon Loeliger		CONFIG_CMD_DATE		* support for RTC, date/time...
629602ad3b3SJon Loeliger		CONFIG_CMD_DHCP		* DHCP support
630602ad3b3SJon Loeliger		CONFIG_CMD_DIAG		* Diagnostics
631a7c93104SPeter Tyser		CONFIG_CMD_DS4510	* ds4510 I2C gpio commands
632a7c93104SPeter Tyser		CONFIG_CMD_DS4510_INFO	* ds4510 I2C info command
633a7c93104SPeter Tyser		CONFIG_CMD_DS4510_MEM	* ds4510 I2C eeprom/sram commansd
634a7c93104SPeter Tyser		CONFIG_CMD_DS4510_RST	* ds4510 I2C rst command
635602ad3b3SJon Loeliger		CONFIG_CMD_DTT		* Digital Therm and Thermostat
636602ad3b3SJon Loeliger		CONFIG_CMD_ECHO		  echo arguments
637246c6922SPeter Tyser		CONFIG_CMD_EDITENV	  edit env variable
638602ad3b3SJon Loeliger		CONFIG_CMD_EEPROM	* EEPROM read/write support
639602ad3b3SJon Loeliger		CONFIG_CMD_ELF		* bootelf, bootvx
640bdab39d3SMike Frysinger		CONFIG_CMD_SAVEENV	  saveenv
641602ad3b3SJon Loeliger		CONFIG_CMD_FDC		* Floppy Disk Support
642602ad3b3SJon Loeliger		CONFIG_CMD_FAT		* FAT partition support
643602ad3b3SJon Loeliger		CONFIG_CMD_FDOS		* Dos diskette Support
644602ad3b3SJon Loeliger		CONFIG_CMD_FLASH	  flinfo, erase, protect
645602ad3b3SJon Loeliger		CONFIG_CMD_FPGA		  FPGA device initialization support
646602ad3b3SJon Loeliger		CONFIG_CMD_HWFLOW	* RTS/CTS hw flow control
647602ad3b3SJon Loeliger		CONFIG_CMD_I2C		* I2C serial bus support
648602ad3b3SJon Loeliger		CONFIG_CMD_IDE		* IDE harddisk support
649602ad3b3SJon Loeliger		CONFIG_CMD_IMI		  iminfo
650602ad3b3SJon Loeliger		CONFIG_CMD_IMLS		  List all found images
651602ad3b3SJon Loeliger		CONFIG_CMD_IMMAP	* IMMR dump support
652602ad3b3SJon Loeliger		CONFIG_CMD_IRQ		* irqinfo
653602ad3b3SJon Loeliger		CONFIG_CMD_ITEST	  Integer/string test of 2 values
654602ad3b3SJon Loeliger		CONFIG_CMD_JFFS2	* JFFS2 Support
655602ad3b3SJon Loeliger		CONFIG_CMD_KGDB		* kgdb
6561ba7fd25SMike Frysinger		CONFIG_CMD_LDRINFO	  ldrinfo (display Blackfin loader)
657602ad3b3SJon Loeliger		CONFIG_CMD_LOADB	  loadb
658602ad3b3SJon Loeliger		CONFIG_CMD_LOADS	  loads
65902c9aa1dSRobin Getz		CONFIG_CMD_MD5SUM	  print md5 message digest
66002c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
661602ad3b3SJon Loeliger		CONFIG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
66256523f12Swdenk					  loop, loopw, mtest
663602ad3b3SJon Loeliger		CONFIG_CMD_MISC		  Misc functions like sleep etc
664602ad3b3SJon Loeliger		CONFIG_CMD_MMC		* MMC memory mapped support
665602ad3b3SJon Loeliger		CONFIG_CMD_MII		* MII utility commands
66668d7d651SStefan Roese		CONFIG_CMD_MTDPARTS	* MTD partition support
667602ad3b3SJon Loeliger		CONFIG_CMD_NAND		* NAND support
668602ad3b3SJon Loeliger		CONFIG_CMD_NET		  bootp, tftpboot, rarpboot
669e92739d3SPeter Tyser		CONFIG_CMD_PCA953X	* PCA953x I2C gpio commands
670e92739d3SPeter Tyser		CONFIG_CMD_PCA953X_INFO	* PCA953x I2C gpio info command
671602ad3b3SJon Loeliger		CONFIG_CMD_PCI		* pciinfo
672602ad3b3SJon Loeliger		CONFIG_CMD_PCMCIA		* PCMCIA support
673602ad3b3SJon Loeliger		CONFIG_CMD_PING		* send ICMP ECHO_REQUEST to network
674602ad3b3SJon Loeliger					  host
675602ad3b3SJon Loeliger		CONFIG_CMD_PORTIO	* Port I/O
676602ad3b3SJon Loeliger		CONFIG_CMD_REGINFO	* Register dump
677602ad3b3SJon Loeliger		CONFIG_CMD_RUN		  run command in env variable
678602ad3b3SJon Loeliger		CONFIG_CMD_SAVES	* save S record dump
679602ad3b3SJon Loeliger		CONFIG_CMD_SCSI		* SCSI Support
680602ad3b3SJon Loeliger		CONFIG_CMD_SDRAM	* print SDRAM configuration information
681602ad3b3SJon Loeliger					  (requires CONFIG_CMD_I2C)
682602ad3b3SJon Loeliger		CONFIG_CMD_SETGETDCR	  Support for DCR Register access
683602ad3b3SJon Loeliger					  (4xx only)
684c6b1ee66SAlexander Holler		CONFIG_CMD_SHA1SUM	  print sha1 memory digest
68502c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY)
68674de7aefSWolfgang Denk		CONFIG_CMD_SOURCE	  "source" command Support
687602ad3b3SJon Loeliger		CONFIG_CMD_SPI		* SPI serial bus support
688602ad3b3SJon Loeliger		CONFIG_CMD_USB		* USB support
689602ad3b3SJon Loeliger		CONFIG_CMD_VFD		* VFD support (TRAB)
690602ad3b3SJon Loeliger		CONFIG_CMD_CDP		* Cisco Discover Protocol support
691602ad3b3SJon Loeliger		CONFIG_CMD_FSL		* Microblaze FSL support
692c609719bSwdenk
693c609719bSwdenk
694c609719bSwdenk		EXAMPLE: If you want all functions except of network
695c609719bSwdenk		support you can write:
696c609719bSwdenk
697602ad3b3SJon Loeliger		#include "config_cmd_all.h"
698602ad3b3SJon Loeliger		#undef CONFIG_CMD_NET
699c609719bSwdenk
700213bf8c8SGerald Van Baren	Other Commands:
701213bf8c8SGerald Van Baren		fdt (flattened device tree) command: CONFIG_OF_LIBFDT
702c609719bSwdenk
703c609719bSwdenk	Note:	Don't enable the "icache" and "dcache" commands
704602ad3b3SJon Loeliger		(configuration option CONFIG_CMD_CACHE) unless you know
705c609719bSwdenk		what you (and your U-Boot users) are doing. Data
706c609719bSwdenk		cache cannot be enabled on systems like the 8xx or
707c609719bSwdenk		8260 (where accesses to the IMMR region must be
708c609719bSwdenk		uncached), and it cannot be disabled on all other
709c609719bSwdenk		systems where we (mis-) use the data cache to hold an
710c609719bSwdenk		initial stack and some data.
711c609719bSwdenk
712c609719bSwdenk
713c609719bSwdenk		XXX - this list needs to get updated!
714c609719bSwdenk
715c609719bSwdenk- Watchdog:
716c609719bSwdenk		CONFIG_WATCHDOG
717c609719bSwdenk		If this variable is defined, it enables watchdog
7187152b1d0Swdenk		support. There must be support in the platform specific
719c609719bSwdenk		code for a watchdog. For the 8xx and 8260 CPUs, the
720c609719bSwdenk		SIU Watchdog feature is enabled in the SYPCR
721c609719bSwdenk		register.
722c609719bSwdenk
723c1551ea8Sstroese- U-Boot Version:
724c1551ea8Sstroese		CONFIG_VERSION_VARIABLE
725c1551ea8Sstroese		If this variable is defined, an environment variable
726c1551ea8Sstroese		named "ver" is created by U-Boot showing the U-Boot
727c1551ea8Sstroese		version as printed by the "version" command.
728c1551ea8Sstroese		This variable is readonly.
729c1551ea8Sstroese
730c609719bSwdenk- Real-Time Clock:
731c609719bSwdenk
732602ad3b3SJon Loeliger		When CONFIG_CMD_DATE is selected, the type of the RTC
733c609719bSwdenk		has to be selected, too. Define exactly one of the
734c609719bSwdenk		following options:
735c609719bSwdenk
736c609719bSwdenk		CONFIG_RTC_MPC8xx	- use internal RTC of MPC8xx
737c609719bSwdenk		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
7387ce63709SGuennadi Liakhovetski		CONFIG_RTC_MC13783	- use MC13783 RTC
739c609719bSwdenk		CONFIG_RTC_MC146818	- use MC146818 RTC
7401cb8e980Swdenk		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
741c609719bSwdenk		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
7427f70e853Swdenk		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
7433bac3513Swdenk		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
7449536dfccSTor Krill		CONFIG_RTC_ISL1208	- use Intersil ISL1208 RTC
7454c0d4c3bSwdenk		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
7466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_DS1337_NOOSC	- Turn off the OSC output for DS1337
747c609719bSwdenk
748b37c7e5eSwdenk		Note that if the RTC uses I2C, then the I2C interface
749b37c7e5eSwdenk		must also be configured. See I2C Support, below.
750b37c7e5eSwdenk
751e92739d3SPeter Tyser- GPIO Support:
752e92739d3SPeter Tyser		CONFIG_PCA953X		- use NXP's PCA953X series I2C GPIO
753e92739d3SPeter Tyser		CONFIG_PCA953X_INFO	- enable pca953x info command
754e92739d3SPeter Tyser
7555dec49caSChris Packham		The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
7565dec49caSChris Packham		chip-ngpio pairs that tell the PCA953X driver the number of
7575dec49caSChris Packham		pins supported by a particular chip.
7585dec49caSChris Packham
759e92739d3SPeter Tyser		Note that if the GPIO device uses I2C, then the I2C interface
760e92739d3SPeter Tyser		must also be configured. See I2C Support, below.
761e92739d3SPeter Tyser
762c609719bSwdenk- Timestamp Support:
763c609719bSwdenk
764c609719bSwdenk		When CONFIG_TIMESTAMP is selected, the timestamp
765c609719bSwdenk		(date and time) of an image is printed by image
766c609719bSwdenk		commands like bootm or iminfo. This option is
767602ad3b3SJon Loeliger		automatically enabled when you select CONFIG_CMD_DATE .
768c609719bSwdenk
769c609719bSwdenk- Partition Support:
770c609719bSwdenk		CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
77107f3d789Srichardretanubun		and/or CONFIG_ISO_PARTITION and/or CONFIG_EFI_PARTITION
772c609719bSwdenk
773602ad3b3SJon Loeliger		If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
774218ca724SWolfgang Denk		CONFIG_CMD_SCSI) you must configure support for at
775218ca724SWolfgang Denk		least one partition type as well.
776c609719bSwdenk
777c609719bSwdenk- IDE Reset method:
7784d13cbadSwdenk		CONFIG_IDE_RESET_ROUTINE - this is defined in several
7794d13cbadSwdenk		board configurations files but used nowhere!
780c609719bSwdenk
7814d13cbadSwdenk		CONFIG_IDE_RESET - is this is defined, IDE Reset will
7824d13cbadSwdenk		be performed by calling the function
7834d13cbadSwdenk			ide_set_reset(int reset)
7844d13cbadSwdenk		which has to be defined in a board specific file
785c609719bSwdenk
786c609719bSwdenk- ATAPI Support:
787c609719bSwdenk		CONFIG_ATAPI
788c609719bSwdenk
789c609719bSwdenk		Set this to enable ATAPI support.
790c609719bSwdenk
791c40b2956Swdenk- LBA48 Support
792c40b2956Swdenk		CONFIG_LBA48
793c40b2956Swdenk
794c40b2956Swdenk		Set this to enable support for disks larger than 137GB
7954b142febSHeiko Schocher		Also look at CONFIG_SYS_64BIT_LBA.
796c40b2956Swdenk		Whithout these , LBA48 support uses 32bit variables and will 'only'
797c40b2956Swdenk		support disks up to 2.1TB.
798c40b2956Swdenk
7996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_64BIT_LBA:
800c40b2956Swdenk			When enabled, makes the IDE subsystem use 64bit sector addresses.
801c40b2956Swdenk			Default is 32bit.
802c40b2956Swdenk
803c609719bSwdenk- SCSI Support:
804c609719bSwdenk		At the moment only there is only support for the
805c609719bSwdenk		SYM53C8XX SCSI controller; define
806c609719bSwdenk		CONFIG_SCSI_SYM53C8XX to enable it.
807c609719bSwdenk
8086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
8096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
8106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
811c609719bSwdenk		maximum numbers of LUNs, SCSI ID's and target
812c609719bSwdenk		devices.
8136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
814c609719bSwdenk
815c609719bSwdenk- NETWORK Support (PCI):
816682011ffSwdenk		CONFIG_E1000
817682011ffSwdenk		Support for Intel 8254x gigabit chips.
818682011ffSwdenk
819ac3315c2SAndre Schwarz		CONFIG_E1000_FALLBACK_MAC
82011ccc33fSMarcel Ziswiler		default MAC for empty EEPROM after production.
821ac3315c2SAndre Schwarz
822c609719bSwdenk		CONFIG_EEPRO100
823c609719bSwdenk		Support for Intel 82557/82559/82559ER chips.
82411ccc33fSMarcel Ziswiler		Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
825c609719bSwdenk		write routine for first time initialisation.
826c609719bSwdenk
827c609719bSwdenk		CONFIG_TULIP
828c609719bSwdenk		Support for Digital 2114x chips.
829c609719bSwdenk		Optional CONFIG_TULIP_SELECT_MEDIA for board specific
830c609719bSwdenk		modem chip initialisation (KS8761/QS6611).
831c609719bSwdenk
832c609719bSwdenk		CONFIG_NATSEMI
833c609719bSwdenk		Support for National dp83815 chips.
834c609719bSwdenk
835c609719bSwdenk		CONFIG_NS8382X
836c609719bSwdenk		Support for National dp8382[01] gigabit chips.
837c609719bSwdenk
83845219c46Swdenk- NETWORK Support (other):
83945219c46Swdenk
840c041e9d2SJens Scharsig		CONFIG_DRIVER_AT91EMAC
841c041e9d2SJens Scharsig		Support for AT91RM9200 EMAC.
842c041e9d2SJens Scharsig
843c041e9d2SJens Scharsig			CONFIG_RMII
844c041e9d2SJens Scharsig			Define this to use reduced MII inteface
845c041e9d2SJens Scharsig
846c041e9d2SJens Scharsig			CONFIG_DRIVER_AT91EMAC_QUIET
847c041e9d2SJens Scharsig			If this defined, the driver is quiet.
848c041e9d2SJens Scharsig			The driver doen't show link status messages.
849c041e9d2SJens Scharsig
85045219c46Swdenk		CONFIG_DRIVER_LAN91C96
85145219c46Swdenk		Support for SMSC's LAN91C96 chips.
85245219c46Swdenk
85345219c46Swdenk			CONFIG_LAN91C96_BASE
85445219c46Swdenk			Define this to hold the physical address
85545219c46Swdenk			of the LAN91C96's I/O space
85645219c46Swdenk
85745219c46Swdenk			CONFIG_LAN91C96_USE_32_BIT
85845219c46Swdenk			Define this to enable 32 bit addressing
85945219c46Swdenk
860f39748aeSwdenk		CONFIG_DRIVER_SMC91111
861f39748aeSwdenk		Support for SMSC's LAN91C111 chip
862f39748aeSwdenk
863f39748aeSwdenk			CONFIG_SMC91111_BASE
864f39748aeSwdenk			Define this to hold the physical address
865f39748aeSwdenk			of the device (I/O space)
866f39748aeSwdenk
867f39748aeSwdenk			CONFIG_SMC_USE_32_BIT
868f39748aeSwdenk			Define this if data bus is 32 bits
869f39748aeSwdenk
870f39748aeSwdenk			CONFIG_SMC_USE_IOFUNCS
871f39748aeSwdenk			Define this to use i/o functions instead of macros
872f39748aeSwdenk			(some hardware wont work with macros)
873f39748aeSwdenk
874b3dbf4a5SMacpaul Lin		CONFIG_FTGMAC100
875b3dbf4a5SMacpaul Lin		Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
876b3dbf4a5SMacpaul Lin
877b3dbf4a5SMacpaul Lin			CONFIG_FTGMAC100_EGIGA
878b3dbf4a5SMacpaul Lin			Define this to use GE link update with gigabit PHY.
879b3dbf4a5SMacpaul Lin			Define this if FTGMAC100 is connected to gigabit PHY.
880b3dbf4a5SMacpaul Lin			If your system has 10/100 PHY only, it might not occur
881b3dbf4a5SMacpaul Lin			wrong behavior. Because PHY usually return timeout or
882b3dbf4a5SMacpaul Lin			useless data when polling gigabit status and gigabit
883b3dbf4a5SMacpaul Lin			control registers. This behavior won't affect the
884b3dbf4a5SMacpaul Lin			correctnessof 10/100 link speed update.
885b3dbf4a5SMacpaul Lin
886c2fff331SMike Rapoport		CONFIG_SMC911X
887557b377dSJens Gehrlein		Support for SMSC's LAN911x and LAN921x chips
888557b377dSJens Gehrlein
889c2fff331SMike Rapoport			CONFIG_SMC911X_BASE
890557b377dSJens Gehrlein			Define this to hold the physical address
891557b377dSJens Gehrlein			of the device (I/O space)
892557b377dSJens Gehrlein
893c2fff331SMike Rapoport			CONFIG_SMC911X_32_BIT
894557b377dSJens Gehrlein			Define this if data bus is 32 bits
895557b377dSJens Gehrlein
896c2fff331SMike Rapoport			CONFIG_SMC911X_16_BIT
897557b377dSJens Gehrlein			Define this if data bus is 16 bits. If your processor
898557b377dSJens Gehrlein			automatically converts one 32 bit word to two 16 bit
899c2fff331SMike Rapoport			words you may also try CONFIG_SMC911X_32_BIT.
900557b377dSJens Gehrlein
9013d0075faSYoshihiro Shimoda		CONFIG_SH_ETHER
9023d0075faSYoshihiro Shimoda		Support for Renesas on-chip Ethernet controller
9033d0075faSYoshihiro Shimoda
9043d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_USE_PORT
9053d0075faSYoshihiro Shimoda			Define the number of ports to be used
9063d0075faSYoshihiro Shimoda
9073d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_PHY_ADDR
9083d0075faSYoshihiro Shimoda			Define the ETH PHY's address
9093d0075faSYoshihiro Shimoda
91068260aabSYoshihiro Shimoda			CONFIG_SH_ETHER_CACHE_WRITEBACK
91168260aabSYoshihiro Shimoda			If this option is set, the driver enables cache flush.
91268260aabSYoshihiro Shimoda
913c609719bSwdenk- USB Support:
914c609719bSwdenk		At the moment only the UHCI host controller is
9154d13cbadSwdenk		supported (PIP405, MIP405, MPC5200); define
916c609719bSwdenk		CONFIG_USB_UHCI to enable it.
917c609719bSwdenk		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
91830d56faeSwdenk		and define CONFIG_USB_STORAGE to enable the USB
919c609719bSwdenk		storage devices.
920c609719bSwdenk		Note:
921c609719bSwdenk		Supported are USB Keyboards and USB Floppy drives
922c609719bSwdenk		(TEAC FD-05PUB).
9234d13cbadSwdenk		MPC5200 USB requires additional defines:
9244d13cbadSwdenk			CONFIG_USB_CLOCK
9254d13cbadSwdenk				for 528 MHz Clock: 0x0001bbbb
926307ecb6dSEric Millbrandt			CONFIG_PSC3_USB
927307ecb6dSEric Millbrandt				for USB on PSC3
9284d13cbadSwdenk			CONFIG_USB_CONFIG
9294d13cbadSwdenk				for differential drivers: 0x00001000
9304d13cbadSwdenk				for single ended drivers: 0x00005000
931307ecb6dSEric Millbrandt				for differential drivers on PSC3: 0x00000100
932307ecb6dSEric Millbrandt				for single ended drivers on PSC3: 0x00004100
9336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_USB_EVENT_POLL
934fdcfaa1bSZhang Wei				May be defined to allow interrupt polling
935fdcfaa1bSZhang Wei				instead of using asynchronous interrupts
9364d13cbadSwdenk
93716c8d5e7SWolfgang Denk- USB Device:
93816c8d5e7SWolfgang Denk		Define the below if you wish to use the USB console.
93916c8d5e7SWolfgang Denk		Once firmware is rebuilt from a serial console issue the
94016c8d5e7SWolfgang Denk		command "setenv stdin usbtty; setenv stdout usbtty" and
94111ccc33fSMarcel Ziswiler		attach your USB cable. The Unix command "dmesg" should print
94216c8d5e7SWolfgang Denk		it has found a new device. The environment variable usbtty
94316c8d5e7SWolfgang Denk		can be set to gserial or cdc_acm to enable your device to
94416c8d5e7SWolfgang Denk		appear to a USB host as a Linux gserial device or a
94516c8d5e7SWolfgang Denk		Common Device Class Abstract Control Model serial device.
94616c8d5e7SWolfgang Denk		If you select usbtty = gserial you should be able to enumerate
94716c8d5e7SWolfgang Denk		a Linux host by
94816c8d5e7SWolfgang Denk		# modprobe usbserial vendor=0xVendorID product=0xProductID
94916c8d5e7SWolfgang Denk		else if using cdc_acm, simply setting the environment
95016c8d5e7SWolfgang Denk		variable usbtty to be cdc_acm should suffice. The following
95116c8d5e7SWolfgang Denk		might be defined in YourBoardName.h
95216c8d5e7SWolfgang Denk
95316c8d5e7SWolfgang Denk			CONFIG_USB_DEVICE
95416c8d5e7SWolfgang Denk			Define this to build a UDC device
95516c8d5e7SWolfgang Denk
95616c8d5e7SWolfgang Denk			CONFIG_USB_TTY
95716c8d5e7SWolfgang Denk			Define this to have a tty type of device available to
95816c8d5e7SWolfgang Denk			talk to the UDC device
95916c8d5e7SWolfgang Denk
9606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_IS_IN_ENV
96116c8d5e7SWolfgang Denk			Define this if you want stdin, stdout &/or stderr to
96216c8d5e7SWolfgang Denk			be set to usbtty.
96316c8d5e7SWolfgang Denk
96416c8d5e7SWolfgang Denk			mpc8xx:
9656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_EXTC_CLK 0xBLAH
96616c8d5e7SWolfgang Denk				Derive USB clock from external clock "blah"
9676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_EXTC_CLK 0x02
96816c8d5e7SWolfgang Denk
9696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_BRG_CLK 0xBLAH
97016c8d5e7SWolfgang Denk				Derive USB clock from brgclk
9716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_BRG_CLK 0x04
97216c8d5e7SWolfgang Denk
97316c8d5e7SWolfgang Denk		If you have a USB-IF assigned VendorID then you may wish to
97416c8d5e7SWolfgang Denk		define your own vendor specific values either in BoardName.h
97516c8d5e7SWolfgang Denk		or directly in usbd_vendor_info.h. If you don't define
97616c8d5e7SWolfgang Denk		CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
97716c8d5e7SWolfgang Denk		CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
97816c8d5e7SWolfgang Denk		should pretend to be a Linux device to it's target host.
97916c8d5e7SWolfgang Denk
98016c8d5e7SWolfgang Denk			CONFIG_USBD_MANUFACTURER
98116c8d5e7SWolfgang Denk			Define this string as the name of your company for
98216c8d5e7SWolfgang Denk			- CONFIG_USBD_MANUFACTURER "my company"
98316c8d5e7SWolfgang Denk
98416c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCT_NAME
98516c8d5e7SWolfgang Denk			Define this string as the name of your product
98616c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCT_NAME "acme usb device"
98716c8d5e7SWolfgang Denk
98816c8d5e7SWolfgang Denk			CONFIG_USBD_VENDORID
98916c8d5e7SWolfgang Denk			Define this as your assigned Vendor ID from the USB
99016c8d5e7SWolfgang Denk			Implementors Forum. This *must* be a genuine Vendor ID
99116c8d5e7SWolfgang Denk			to avoid polluting the USB namespace.
99216c8d5e7SWolfgang Denk			- CONFIG_USBD_VENDORID 0xFFFF
99316c8d5e7SWolfgang Denk
99416c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCTID
99516c8d5e7SWolfgang Denk			Define this as the unique Product ID
99616c8d5e7SWolfgang Denk			for your device
99716c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCTID 0xFFFF
998c609719bSwdenk
999c609719bSwdenk
1000c609719bSwdenk- MMC Support:
1001c609719bSwdenk		The MMC controller on the Intel PXA is supported. To
1002c609719bSwdenk		enable this define CONFIG_MMC. The MMC can be
1003c609719bSwdenk		accessed from the boot prompt by mapping the device
1004c609719bSwdenk		to physical memory similar to flash. Command line is
1005602ad3b3SJon Loeliger		enabled with CONFIG_CMD_MMC. The MMC driver also works with
1006602ad3b3SJon Loeliger		the FAT fs. This is enabled with CONFIG_CMD_FAT.
1007c609719bSwdenk
10086705d81eSwdenk- Journaling Flash filesystem support:
10096705d81eSwdenk		CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
10106705d81eSwdenk		CONFIG_JFFS2_NAND_DEV
10116705d81eSwdenk		Define these for a default partition on a NAND device
10126705d81eSwdenk
10136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_SECTOR,
10146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
10156705d81eSwdenk		Define these for a default partition on a NOR device
10166705d81eSwdenk
10176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS_CUSTOM_PART
10186705d81eSwdenk		Define this to create an own partition. You have to provide a
10196705d81eSwdenk		function struct part_info* jffs2_part_info(int part_num)
10206705d81eSwdenk
10216705d81eSwdenk		If you define only one JFFS2 partition you may also want to
10226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_JFFS_SINGLE_PART	1
10236705d81eSwdenk		to disable the command chpart. This is the default when you
10246705d81eSwdenk		have not defined a custom partition
10256705d81eSwdenk
1026c609719bSwdenk- Keyboard Support:
1027c609719bSwdenk		CONFIG_ISA_KEYBOARD
1028c609719bSwdenk
1029c609719bSwdenk		Define this to enable standard (PC-Style) keyboard
1030c609719bSwdenk		support
1031c609719bSwdenk
1032c609719bSwdenk		CONFIG_I8042_KBD
1033c609719bSwdenk		Standard PC keyboard driver with US (is default) and
1034c609719bSwdenk		GERMAN key layout (switch via environment 'keymap=de') support.
1035c609719bSwdenk		Export function i8042_kbd_init, i8042_tstc and i8042_getc
1036c609719bSwdenk		for cfb_console. Supports cursor blinking.
1037c609719bSwdenk
1038c609719bSwdenk- Video support:
1039c609719bSwdenk		CONFIG_VIDEO
1040c609719bSwdenk
1041c609719bSwdenk		Define this to enable video support (for output to
1042c609719bSwdenk		video).
1043c609719bSwdenk
1044c609719bSwdenk		CONFIG_VIDEO_CT69000
1045c609719bSwdenk
1046c609719bSwdenk		Enable Chips & Technologies 69000 Video chip
1047c609719bSwdenk
1048c609719bSwdenk		CONFIG_VIDEO_SMI_LYNXEM
1049eeb1b77bSwdenk		Enable Silicon Motion SMI 712/710/810 Video chip. The
1050eeb1b77bSwdenk		video output is selected via environment 'videoout'
1051eeb1b77bSwdenk		(1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1052eeb1b77bSwdenk		assumed.
1053c609719bSwdenk
1054eeb1b77bSwdenk		For the CT69000 and SMI_LYNXEM drivers, videomode is
105511ccc33fSMarcel Ziswiler		selected via environment 'videomode'. Two different ways
1056eeb1b77bSwdenk		are possible:
1057eeb1b77bSwdenk		- "videomode=num"   'num' is a standard LiLo mode numbers.
1058eeb1b77bSwdenk		Following standard modes are supported	(* is default):
1059eeb1b77bSwdenk
1060eeb1b77bSwdenk		      Colors	640x480 800x600 1024x768 1152x864 1280x1024
1061eeb1b77bSwdenk		-------------+---------------------------------------------
1062eeb1b77bSwdenk		      8 bits |	0x301*	0x303	 0x305	  0x161	    0x307
1063eeb1b77bSwdenk		     15 bits |	0x310	0x313	 0x316	  0x162	    0x319
1064eeb1b77bSwdenk		     16 bits |	0x311	0x314	 0x317	  0x163	    0x31A
1065eeb1b77bSwdenk		     24 bits |	0x312	0x315	 0x318	    ?	    0x31B
1066eeb1b77bSwdenk		-------------+---------------------------------------------
1067c609719bSwdenk		(i.e. setenv videomode 317; saveenv; reset;)
1068c609719bSwdenk
1069eeb1b77bSwdenk		- "videomode=bootargs" all the video parameters are parsed
10707817cb20SMarcel Ziswiler		from the bootargs. (See drivers/video/videomodes.c)
1071eeb1b77bSwdenk
1072eeb1b77bSwdenk
1073a6c7ad2fSwdenk		CONFIG_VIDEO_SED13806
1074a6c7ad2fSwdenk		Enable Epson SED13806 driver. This driver supports 8bpp
1075a6c7ad2fSwdenk		and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1076a6c7ad2fSwdenk		or CONFIG_VIDEO_SED13806_16BPP
1077a6c7ad2fSwdenk
10787d3053fbSTimur Tabi		CONFIG_FSL_DIU_FB
10797d3053fbSTimur Tabi		Enable the Freescale DIU video driver.  Reference boards for
10807d3053fbSTimur Tabi		SOCs that have a DIU should define this macro to enable DIU
10817d3053fbSTimur Tabi		support, and should also define these other macros:
10827d3053fbSTimur Tabi
10837d3053fbSTimur Tabi			CONFIG_SYS_DIU_ADDR
10847d3053fbSTimur Tabi			CONFIG_VIDEO
10857d3053fbSTimur Tabi			CONFIG_CMD_BMP
10867d3053fbSTimur Tabi			CONFIG_CFB_CONSOLE
10877d3053fbSTimur Tabi			CONFIG_VIDEO_SW_CURSOR
10887d3053fbSTimur Tabi			CONFIG_VGA_AS_SINGLE_DEVICE
10897d3053fbSTimur Tabi			CONFIG_VIDEO_LOGO
10907d3053fbSTimur Tabi			CONFIG_VIDEO_BMP_LOGO
10917d3053fbSTimur Tabi
10927d3053fbSTimur Tabi		The DIU driver will look for the 'monitor' environment variable,
10937d3053fbSTimur Tabi		and if defined, enable the DIU as a console during boot.  This
10947d3053fbSTimur Tabi		variable should be set to one of these values:
10957d3053fbSTimur Tabi
10967d3053fbSTimur Tabi			'0'	Output video to the DVI connector
10977d3053fbSTimur Tabi			'1'	Output video to the LVDS connector
10987d3053fbSTimur Tabi			'2'	Output video to the Dual-Link LVDS connector
10997d3053fbSTimur Tabi
1100682011ffSwdenk- Keyboard Support:
1101682011ffSwdenk		CONFIG_KEYBOARD
1102682011ffSwdenk
1103682011ffSwdenk		Define this to enable a custom keyboard support.
1104682011ffSwdenk		This simply calls drv_keyboard_init() which must be
1105682011ffSwdenk		defined in your board-specific files.
1106682011ffSwdenk		The only board using this so far is RBC823.
1107a6c7ad2fSwdenk
1108c609719bSwdenk- LCD Support:	CONFIG_LCD
1109c609719bSwdenk
1110c609719bSwdenk		Define this to enable LCD support (for output to LCD
1111c609719bSwdenk		display); also select one of the supported displays
1112c609719bSwdenk		by defining one of these:
1113c609719bSwdenk
111439cf4804SStelian Pop		CONFIG_ATMEL_LCD:
111539cf4804SStelian Pop
111639cf4804SStelian Pop			HITACHI TX09D70VM1CCA, 3.5", 240x320.
111739cf4804SStelian Pop
1118fd3103bbSwdenk		CONFIG_NEC_NL6448AC33:
1119c609719bSwdenk
1120fd3103bbSwdenk			NEC NL6448AC33-18. Active, color, single scan.
1121c609719bSwdenk
1122fd3103bbSwdenk		CONFIG_NEC_NL6448BC20
1123c609719bSwdenk
1124fd3103bbSwdenk			NEC NL6448BC20-08. 6.5", 640x480.
1125fd3103bbSwdenk			Active, color, single scan.
1126fd3103bbSwdenk
1127fd3103bbSwdenk		CONFIG_NEC_NL6448BC33_54
1128fd3103bbSwdenk
1129fd3103bbSwdenk			NEC NL6448BC33-54. 10.4", 640x480.
1130c609719bSwdenk			Active, color, single scan.
1131c609719bSwdenk
1132c609719bSwdenk		CONFIG_SHARP_16x9
1133c609719bSwdenk
1134c609719bSwdenk			Sharp 320x240. Active, color, single scan.
1135c609719bSwdenk			It isn't 16x9, and I am not sure what it is.
1136c609719bSwdenk
1137c609719bSwdenk		CONFIG_SHARP_LQ64D341
1138c609719bSwdenk
1139c609719bSwdenk			Sharp LQ64D341 display, 640x480.
1140c609719bSwdenk			Active, color, single scan.
1141c609719bSwdenk
1142c609719bSwdenk		CONFIG_HLD1045
1143c609719bSwdenk
1144c609719bSwdenk			HLD1045 display, 640x480.
1145c609719bSwdenk			Active, color, single scan.
1146c609719bSwdenk
1147c609719bSwdenk		CONFIG_OPTREX_BW
1148c609719bSwdenk
1149c609719bSwdenk			Optrex	 CBL50840-2 NF-FW 99 22 M5
1150c609719bSwdenk			or
1151c609719bSwdenk			Hitachi	 LMG6912RPFC-00T
1152c609719bSwdenk			or
1153c609719bSwdenk			Hitachi	 SP14Q002
1154c609719bSwdenk
1155c609719bSwdenk			320x240. Black & white.
1156c609719bSwdenk
1157c609719bSwdenk		Normally display is black on white background; define
11586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
1159c609719bSwdenk
11607152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN
1161d791b1dcSwdenk
1162d791b1dcSwdenk		If this option is set, the environment is checked for
1163d791b1dcSwdenk		a variable "splashimage". If found, the usual display
1164d791b1dcSwdenk		of logo, copyright and system information on the LCD
1165e94d2cd9Swdenk		is suppressed and the BMP image at the address
1166d791b1dcSwdenk		specified in "splashimage" is loaded instead. The
1167d791b1dcSwdenk		console is redirected to the "nulldev", too. This
1168d791b1dcSwdenk		allows for a "silent" boot where a splash screen is
1169d791b1dcSwdenk		loaded very quickly after power-on.
1170d791b1dcSwdenk
11711ca298ceSMatthias Weisser		CONFIG_SPLASH_SCREEN_ALIGN
11721ca298ceSMatthias Weisser
11731ca298ceSMatthias Weisser		If this option is set the splash image can be freely positioned
11741ca298ceSMatthias Weisser		on the screen. Environment variable "splashpos" specifies the
11751ca298ceSMatthias Weisser		position as "x,y". If a positive number is given it is used as
11761ca298ceSMatthias Weisser		number of pixel from left/top. If a negative number is given it
11771ca298ceSMatthias Weisser		is used as number of pixel from right/bottom. You can also
11781ca298ceSMatthias Weisser		specify 'm' for centering the image.
11791ca298ceSMatthias Weisser
11801ca298ceSMatthias Weisser		Example:
11811ca298ceSMatthias Weisser		setenv splashpos m,m
11821ca298ceSMatthias Weisser			=> image at center of screen
11831ca298ceSMatthias Weisser
11841ca298ceSMatthias Weisser		setenv splashpos 30,20
11851ca298ceSMatthias Weisser			=> image at x = 30 and y = 20
11861ca298ceSMatthias Weisser
11871ca298ceSMatthias Weisser		setenv splashpos -10,m
11881ca298ceSMatthias Weisser			=> vertically centered image
11891ca298ceSMatthias Weisser			   at x = dspWidth - bmpWidth - 9
11901ca298ceSMatthias Weisser
119198f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
119298f4a3dfSStefan Roese
119398f4a3dfSStefan Roese		If this option is set, additionally to standard BMP
119498f4a3dfSStefan Roese		images, gzipped BMP images can be displayed via the
119598f4a3dfSStefan Roese		splashscreen support or the bmp command.
119698f4a3dfSStefan Roese
1197d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1198d5011762SAnatolij Gustschin
1199d5011762SAnatolij Gustschin		If this option is set, 8-bit RLE compressed BMP images
1200d5011762SAnatolij Gustschin		can be displayed via the splashscreen support or the
1201d5011762SAnatolij Gustschin		bmp command.
1202d5011762SAnatolij Gustschin
1203c29fdfc1Swdenk- Compression support:
1204c29fdfc1Swdenk		CONFIG_BZIP2
1205c29fdfc1Swdenk
1206c29fdfc1Swdenk		If this option is set, support for bzip2 compressed
1207c29fdfc1Swdenk		images is included. If not, only uncompressed and gzip
1208c29fdfc1Swdenk		compressed images are supported.
1209c29fdfc1Swdenk
1210c29fdfc1Swdenk		NOTE: the bzip2 algorithm requires a lot of RAM, so
12116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
1212c29fdfc1Swdenk		be at least 4MB.
1213d791b1dcSwdenk
1214fc9c1727SLuigi 'Comio' Mantellini		CONFIG_LZMA
1215fc9c1727SLuigi 'Comio' Mantellini
1216fc9c1727SLuigi 'Comio' Mantellini		If this option is set, support for lzma compressed
1217fc9c1727SLuigi 'Comio' Mantellini		images is included.
1218fc9c1727SLuigi 'Comio' Mantellini
1219fc9c1727SLuigi 'Comio' Mantellini		Note: The LZMA algorithm adds between 2 and 4KB of code and it
1220fc9c1727SLuigi 'Comio' Mantellini		requires an amount of dynamic memory that is given by the
1221fc9c1727SLuigi 'Comio' Mantellini		formula:
1222fc9c1727SLuigi 'Comio' Mantellini
1223fc9c1727SLuigi 'Comio' Mantellini			(1846 + 768 << (lc + lp)) * sizeof(uint16)
1224fc9c1727SLuigi 'Comio' Mantellini
1225fc9c1727SLuigi 'Comio' Mantellini		Where lc and lp stand for, respectively, Literal context bits
1226fc9c1727SLuigi 'Comio' Mantellini		and Literal pos bits.
1227fc9c1727SLuigi 'Comio' Mantellini
1228fc9c1727SLuigi 'Comio' Mantellini		This value is upper-bounded by 14MB in the worst case. Anyway,
1229fc9c1727SLuigi 'Comio' Mantellini		for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1230fc9c1727SLuigi 'Comio' Mantellini		total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1231fc9c1727SLuigi 'Comio' Mantellini		a very small buffer.
1232fc9c1727SLuigi 'Comio' Mantellini
1233fc9c1727SLuigi 'Comio' Mantellini		Use the lzmainfo tool to determinate the lc and lp values and
1234fc9c1727SLuigi 'Comio' Mantellini		then calculate the amount of needed dynamic memory (ensuring
12356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the appropriate CONFIG_SYS_MALLOC_LEN value).
1236fc9c1727SLuigi 'Comio' Mantellini
123717ea1177Swdenk- MII/PHY support:
123817ea1177Swdenk		CONFIG_PHY_ADDR
123917ea1177Swdenk
124017ea1177Swdenk		The address of PHY on MII bus.
124117ea1177Swdenk
124217ea1177Swdenk		CONFIG_PHY_CLOCK_FREQ (ppc4xx)
124317ea1177Swdenk
124417ea1177Swdenk		The clock frequency of the MII bus
124517ea1177Swdenk
124617ea1177Swdenk		CONFIG_PHY_GIGE
124717ea1177Swdenk
124817ea1177Swdenk		If this option is set, support for speed/duplex
124911ccc33fSMarcel Ziswiler		detection of gigabit PHY is included.
125017ea1177Swdenk
125117ea1177Swdenk		CONFIG_PHY_RESET_DELAY
125217ea1177Swdenk
125317ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
125417ea1177Swdenk		reset before any MII register access is possible.
125517ea1177Swdenk		For such PHY, set this option to the usec delay
125617ea1177Swdenk		required. (minimum 300usec for LXT971A)
125717ea1177Swdenk
125817ea1177Swdenk		CONFIG_PHY_CMD_DELAY (ppc4xx)
125917ea1177Swdenk
126017ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
126117ea1177Swdenk		command issued before MII status register can be read
126217ea1177Swdenk
1263c609719bSwdenk- Ethernet address:
1264c609719bSwdenk		CONFIG_ETHADDR
1265c68a05feSrichardretanubun		CONFIG_ETH1ADDR
1266c609719bSwdenk		CONFIG_ETH2ADDR
1267c609719bSwdenk		CONFIG_ETH3ADDR
1268c68a05feSrichardretanubun		CONFIG_ETH4ADDR
1269c68a05feSrichardretanubun		CONFIG_ETH5ADDR
1270c609719bSwdenk
127111ccc33fSMarcel Ziswiler		Define a default value for Ethernet address to use
127211ccc33fSMarcel Ziswiler		for the respective Ethernet interface, in case this
1273c609719bSwdenk		is not determined automatically.
1274c609719bSwdenk
1275c609719bSwdenk- IP address:
1276c609719bSwdenk		CONFIG_IPADDR
1277c609719bSwdenk
1278c609719bSwdenk		Define a default value for the IP address to use for
127911ccc33fSMarcel Ziswiler		the default Ethernet interface, in case this is not
1280c609719bSwdenk		determined through e.g. bootp.
1281c609719bSwdenk
1282c609719bSwdenk- Server IP address:
1283c609719bSwdenk		CONFIG_SERVERIP
1284c609719bSwdenk
1285c609719bSwdenk		Defines a default value for the IP address of a TFTP
1286c609719bSwdenk		server to contact when using the "tftboot" command.
1287c609719bSwdenk
128897cfe861SRobin Getz		CONFIG_KEEP_SERVERADDR
128997cfe861SRobin Getz
129097cfe861SRobin Getz		Keeps the server's MAC address, in the env 'serveraddr'
129197cfe861SRobin Getz		for passing to bootargs (like Linux's netconsole option)
129297cfe861SRobin Getz
129353a5c424SDavid Updegraff- Multicast TFTP Mode:
129453a5c424SDavid Updegraff		CONFIG_MCAST_TFTP
129553a5c424SDavid Updegraff
129653a5c424SDavid Updegraff		Defines whether you want to support multicast TFTP as per
129753a5c424SDavid Updegraff		rfc-2090; for example to work with atftp.  Lets lots of targets
129811ccc33fSMarcel Ziswiler		tftp down the same boot image concurrently.  Note: the Ethernet
129953a5c424SDavid Updegraff		driver in use must provide a function: mcast() to join/leave a
130053a5c424SDavid Updegraff		multicast group.
130153a5c424SDavid Updegraff
130253a5c424SDavid Updegraff		CONFIG_BOOTP_RANDOM_DELAY
1303c609719bSwdenk- BOOTP Recovery Mode:
1304c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY
1305c609719bSwdenk
1306c609719bSwdenk		If you have many targets in a network that try to
1307c609719bSwdenk		boot using BOOTP, you may want to avoid that all
1308c609719bSwdenk		systems send out BOOTP requests at precisely the same
1309c609719bSwdenk		moment (which would happen for instance at recovery
1310c609719bSwdenk		from a power failure, when all systems will try to
1311c609719bSwdenk		boot, thus flooding the BOOTP server. Defining
1312c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1313c609719bSwdenk		inserted before sending out BOOTP requests. The
13146c33c785SWolfgang Denk		following delays are inserted then:
1315c609719bSwdenk
1316c609719bSwdenk		1st BOOTP request:	delay 0 ... 1 sec
1317c609719bSwdenk		2nd BOOTP request:	delay 0 ... 2 sec
1318c609719bSwdenk		3rd BOOTP request:	delay 0 ... 4 sec
1319c609719bSwdenk		4th and following
1320c609719bSwdenk		BOOTP requests:		delay 0 ... 8 sec
1321c609719bSwdenk
1322fe389a82Sstroese- DHCP Advanced Options:
13231fe80d79SJon Loeliger		You can fine tune the DHCP functionality by defining
13241fe80d79SJon Loeliger		CONFIG_BOOTP_* symbols:
1325fe389a82Sstroese
13261fe80d79SJon Loeliger		CONFIG_BOOTP_SUBNETMASK
13271fe80d79SJon Loeliger		CONFIG_BOOTP_GATEWAY
13281fe80d79SJon Loeliger		CONFIG_BOOTP_HOSTNAME
13291fe80d79SJon Loeliger		CONFIG_BOOTP_NISDOMAIN
13301fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTPATH
13311fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTFILESIZE
13321fe80d79SJon Loeliger		CONFIG_BOOTP_DNS
13331fe80d79SJon Loeliger		CONFIG_BOOTP_DNS2
13341fe80d79SJon Loeliger		CONFIG_BOOTP_SEND_HOSTNAME
13351fe80d79SJon Loeliger		CONFIG_BOOTP_NTPSERVER
13361fe80d79SJon Loeliger		CONFIG_BOOTP_TIMEOFFSET
13371fe80d79SJon Loeliger		CONFIG_BOOTP_VENDOREX
1338fe389a82Sstroese
13395d110f0aSWilson Callan		CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
13405d110f0aSWilson Callan		environment variable, not the BOOTP server.
1341fe389a82Sstroese
1342fe389a82Sstroese		CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1343fe389a82Sstroese		serverip from a DHCP server, it is possible that more
1344fe389a82Sstroese		than one DNS serverip is offered to the client.
1345fe389a82Sstroese		If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1346fe389a82Sstroese		serverip will be stored in the additional environment
1347fe389a82Sstroese		variable "dnsip2". The first DNS serverip is always
1348fe389a82Sstroese		stored in the variable "dnsip", when CONFIG_BOOTP_DNS
13491fe80d79SJon Loeliger		is defined.
1350fe389a82Sstroese
1351fe389a82Sstroese		CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1352fe389a82Sstroese		to do a dynamic update of a DNS server. To do this, they
1353fe389a82Sstroese		need the hostname of the DHCP requester.
13545d110f0aSWilson Callan		If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
13551fe80d79SJon Loeliger		of the "hostname" environment variable is passed as
13561fe80d79SJon Loeliger		option 12 to the DHCP server.
1357fe389a82Sstroese
1358d9a2f416SAras Vaichas		CONFIG_BOOTP_DHCP_REQUEST_DELAY
1359d9a2f416SAras Vaichas
1360d9a2f416SAras Vaichas		A 32bit value in microseconds for a delay between
1361d9a2f416SAras Vaichas		receiving a "DHCP Offer" and sending the "DHCP Request".
1362d9a2f416SAras Vaichas		This fixes a problem with certain DHCP servers that don't
1363d9a2f416SAras Vaichas		respond 100% of the time to a "DHCP request". E.g. On an
1364d9a2f416SAras Vaichas		AT91RM9200 processor running at 180MHz, this delay needed
1365d9a2f416SAras Vaichas		to be *at least* 15,000 usec before a Windows Server 2003
1366d9a2f416SAras Vaichas		DHCP server would reply 100% of the time. I recommend at
1367d9a2f416SAras Vaichas		least 50,000 usec to be safe. The alternative is to hope
1368d9a2f416SAras Vaichas		that one of the retries will be successful but note that
1369d9a2f416SAras Vaichas		the DHCP timeout and retry process takes a longer than
1370d9a2f416SAras Vaichas		this delay.
1371d9a2f416SAras Vaichas
1372a3d991bdSwdenk - CDP Options:
1373a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID
1374a3d991bdSwdenk
1375a3d991bdSwdenk		The device id used in CDP trigger frames.
1376a3d991bdSwdenk
1377a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID_PREFIX
1378a3d991bdSwdenk
1379a3d991bdSwdenk		A two character string which is prefixed to the MAC address
1380a3d991bdSwdenk		of the device.
1381a3d991bdSwdenk
1382a3d991bdSwdenk		CONFIG_CDP_PORT_ID
1383a3d991bdSwdenk
1384a3d991bdSwdenk		A printf format string which contains the ascii name of
1385a3d991bdSwdenk		the port. Normally is set to "eth%d" which sets
138611ccc33fSMarcel Ziswiler		eth0 for the first Ethernet, eth1 for the second etc.
1387a3d991bdSwdenk
1388a3d991bdSwdenk		CONFIG_CDP_CAPABILITIES
1389a3d991bdSwdenk
1390a3d991bdSwdenk		A 32bit integer which indicates the device capabilities;
1391a3d991bdSwdenk		0x00000010 for a normal host which does not forwards.
1392a3d991bdSwdenk
1393a3d991bdSwdenk		CONFIG_CDP_VERSION
1394a3d991bdSwdenk
1395a3d991bdSwdenk		An ascii string containing the version of the software.
1396a3d991bdSwdenk
1397a3d991bdSwdenk		CONFIG_CDP_PLATFORM
1398a3d991bdSwdenk
1399a3d991bdSwdenk		An ascii string containing the name of the platform.
1400a3d991bdSwdenk
1401a3d991bdSwdenk		CONFIG_CDP_TRIGGER
1402a3d991bdSwdenk
1403a3d991bdSwdenk		A 32bit integer sent on the trigger.
1404a3d991bdSwdenk
1405a3d991bdSwdenk		CONFIG_CDP_POWER_CONSUMPTION
1406a3d991bdSwdenk
1407a3d991bdSwdenk		A 16bit integer containing the power consumption of the
1408a3d991bdSwdenk		device in .1 of milliwatts.
1409a3d991bdSwdenk
1410a3d991bdSwdenk		CONFIG_CDP_APPLIANCE_VLAN_TYPE
1411a3d991bdSwdenk
1412a3d991bdSwdenk		A byte containing the id of the VLAN.
1413a3d991bdSwdenk
1414c609719bSwdenk- Status LED:	CONFIG_STATUS_LED
1415c609719bSwdenk
1416c609719bSwdenk		Several configurations allow to display the current
1417c609719bSwdenk		status using a LED. For instance, the LED will blink
1418c609719bSwdenk		fast while running U-Boot code, stop blinking as
1419c609719bSwdenk		soon as a reply to a BOOTP request was received, and
1420c609719bSwdenk		start blinking slow once the Linux kernel is running
1421c609719bSwdenk		(supported by a status LED driver in the Linux
1422c609719bSwdenk		kernel). Defining CONFIG_STATUS_LED enables this
1423c609719bSwdenk		feature in U-Boot.
1424c609719bSwdenk
1425c609719bSwdenk- CAN Support:	CONFIG_CAN_DRIVER
1426c609719bSwdenk
1427c609719bSwdenk		Defining CONFIG_CAN_DRIVER enables CAN driver support
1428c609719bSwdenk		on those systems that support this (optional)
1429c609719bSwdenk		feature, like the TQM8xxL modules.
1430c609719bSwdenk
1431c609719bSwdenk- I2C Support:	CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1432c609719bSwdenk
1433b37c7e5eSwdenk		These enable I2C serial bus commands. Defining either of
1434b37c7e5eSwdenk		(but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
143511ccc33fSMarcel Ziswiler		include the appropriate I2C driver for the selected CPU.
1436c609719bSwdenk
1437b37c7e5eSwdenk		This will allow you to use i2c commands at the u-boot
1438602ad3b3SJon Loeliger		command line (as long as you set CONFIG_CMD_I2C in
1439b37c7e5eSwdenk		CONFIG_COMMANDS) and communicate with i2c based realtime
1440b37c7e5eSwdenk		clock chips. See common/cmd_i2c.c for a description of the
1441c609719bSwdenk		command line interface.
1442c609719bSwdenk
1443bb99ad6dSBen Warren		CONFIG_HARD_I2C selects a hardware I2C controller.
1444c609719bSwdenk
1445b37c7e5eSwdenk		CONFIG_SOFT_I2C configures u-boot to use a software (aka
1446b37c7e5eSwdenk		bit-banging) driver instead of CPM or similar hardware
1447b37c7e5eSwdenk		support for I2C.
1448c609719bSwdenk
1449b37c7e5eSwdenk		There are several other quantities that must also be
1450b37c7e5eSwdenk		defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
1451c609719bSwdenk
14526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		In both cases you will need to define CONFIG_SYS_I2C_SPEED
1453b37c7e5eSwdenk		to be the frequency (in Hz) at which you wish your i2c bus
14546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
145511ccc33fSMarcel Ziswiler		the CPU's i2c node address).
1456c609719bSwdenk
14578d321b81SPeter Tyser		Now, the u-boot i2c code for the mpc8xx
1458a47a12beSStefan Roese		(arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
14598d321b81SPeter Tyser		and so its address should therefore be cleared to 0 (See,
14608d321b81SPeter Tyser		eg, MPC823e User's Manual p.16-473). So, set
14618d321b81SPeter Tyser		CONFIG_SYS_I2C_SLAVE to 0.
1462b37c7e5eSwdenk
14635da71efaSEric Millbrandt		CONFIG_SYS_I2C_INIT_MPC5XXX
14645da71efaSEric Millbrandt
14655da71efaSEric Millbrandt		When a board is reset during an i2c bus transfer
14665da71efaSEric Millbrandt		chips might think that the current transfer is still
14675da71efaSEric Millbrandt		in progress.  Reset the slave devices by sending start
14685da71efaSEric Millbrandt		commands until the slave device responds.
14695da71efaSEric Millbrandt
1470b37c7e5eSwdenk		That's all that's required for CONFIG_HARD_I2C.
1471b37c7e5eSwdenk
1472b37c7e5eSwdenk		If you use the software i2c interface (CONFIG_SOFT_I2C)
1473b37c7e5eSwdenk		then the following macros need to be defined (examples are
1474b37c7e5eSwdenk		from include/configs/lwmon.h):
1475c609719bSwdenk
1476c609719bSwdenk		I2C_INIT
1477c609719bSwdenk
1478b37c7e5eSwdenk		(Optional). Any commands necessary to enable the I2C
1479c609719bSwdenk		controller or configure ports.
1480c609719bSwdenk
1481b37c7e5eSwdenk		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
1482b37c7e5eSwdenk
1483c609719bSwdenk		I2C_PORT
1484c609719bSwdenk
1485c609719bSwdenk		(Only for MPC8260 CPU). The I/O port to use (the code
1486c609719bSwdenk		assumes both bits are on the same port). Valid values
1487c609719bSwdenk		are 0..3 for ports A..D.
1488c609719bSwdenk
1489c609719bSwdenk		I2C_ACTIVE
1490c609719bSwdenk
1491c609719bSwdenk		The code necessary to make the I2C data line active
1492c609719bSwdenk		(driven).  If the data line is open collector, this
1493c609719bSwdenk		define can be null.
1494c609719bSwdenk
1495b37c7e5eSwdenk		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
1496b37c7e5eSwdenk
1497c609719bSwdenk		I2C_TRISTATE
1498c609719bSwdenk
1499c609719bSwdenk		The code necessary to make the I2C data line tri-stated
1500c609719bSwdenk		(inactive).  If the data line is open collector, this
1501c609719bSwdenk		define can be null.
1502c609719bSwdenk
1503b37c7e5eSwdenk		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1504b37c7e5eSwdenk
1505c609719bSwdenk		I2C_READ
1506c609719bSwdenk
1507c609719bSwdenk		Code that returns TRUE if the I2C data line is high,
1508c609719bSwdenk		FALSE if it is low.
1509c609719bSwdenk
1510b37c7e5eSwdenk		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1511b37c7e5eSwdenk
1512c609719bSwdenk		I2C_SDA(bit)
1513c609719bSwdenk
1514c609719bSwdenk		If <bit> is TRUE, sets the I2C data line high. If it
1515c609719bSwdenk		is FALSE, it clears it (low).
1516c609719bSwdenk
1517b37c7e5eSwdenk		eg: #define I2C_SDA(bit) \
1518b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
1519b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
1520b37c7e5eSwdenk
1521c609719bSwdenk		I2C_SCL(bit)
1522c609719bSwdenk
1523c609719bSwdenk		If <bit> is TRUE, sets the I2C clock line high. If it
1524c609719bSwdenk		is FALSE, it clears it (low).
1525c609719bSwdenk
1526b37c7e5eSwdenk		eg: #define I2C_SCL(bit) \
1527b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
1528b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
1529b37c7e5eSwdenk
1530c609719bSwdenk		I2C_DELAY
1531c609719bSwdenk
1532c609719bSwdenk		This delay is invoked four times per clock cycle so this
1533c609719bSwdenk		controls the rate of data transfer.  The data rate thus
1534b37c7e5eSwdenk		is 1 / (I2C_DELAY * 4). Often defined to be something
1535b37c7e5eSwdenk		like:
1536b37c7e5eSwdenk
1537b37c7e5eSwdenk		#define I2C_DELAY  udelay(2)
1538c609719bSwdenk
1539793b5726SMike Frysinger		CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1540793b5726SMike Frysinger
1541793b5726SMike Frysinger		If your arch supports the generic GPIO framework (asm/gpio.h),
1542793b5726SMike Frysinger		then you may alternatively define the two GPIOs that are to be
1543793b5726SMike Frysinger		used as SCL / SDA.  Any of the previous I2C_xxx macros will
1544793b5726SMike Frysinger		have GPIO-based defaults assigned to them as appropriate.
1545793b5726SMike Frysinger
1546793b5726SMike Frysinger		You should define these to the GPIO value as given directly to
1547793b5726SMike Frysinger		the generic GPIO functions.
1548793b5726SMike Frysinger
15496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_INIT_BOARD
155047cd00faSwdenk
155147cd00faSwdenk		When a board is reset during an i2c bus transfer
155247cd00faSwdenk		chips might think that the current transfer is still
155347cd00faSwdenk		in progress. On some boards it is possible to access
155447cd00faSwdenk		the i2c SCLK line directly, either by using the
155547cd00faSwdenk		processor pin as a GPIO or by having a second pin
155647cd00faSwdenk		connected to the bus. If this option is defined a
155747cd00faSwdenk		custom i2c_init_board() routine in boards/xxx/board.c
155847cd00faSwdenk		is run early in the boot sequence.
155947cd00faSwdenk
156026a33504SRichard Retanubun		CONFIG_SYS_I2C_BOARD_LATE_INIT
156126a33504SRichard Retanubun
156226a33504SRichard Retanubun		An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
156326a33504SRichard Retanubun		defined a custom i2c_board_late_init() routine in
156426a33504SRichard Retanubun		boards/xxx/board.c is run AFTER the operations in i2c_init()
156526a33504SRichard Retanubun		is completed. This callpoint can be used to unreset i2c bus
156626a33504SRichard Retanubun		using CPU i2c controller register accesses for CPUs whose i2c
156726a33504SRichard Retanubun		controller provide such a method. It is called at the end of
156826a33504SRichard Retanubun		i2c_init() to allow i2c_init operations to setup the i2c bus
156926a33504SRichard Retanubun		controller on the CPU (e.g. setting bus speed & slave address).
157026a33504SRichard Retanubun
157117ea1177Swdenk		CONFIG_I2CFAST (PPC405GP|PPC405EP only)
157217ea1177Swdenk
157317ea1177Swdenk		This option enables configuration of bi_iic_fast[] flags
157417ea1177Swdenk		in u-boot bd_info structure based on u-boot environment
157517ea1177Swdenk		variable "i2cfast". (see also i2cfast)
157617ea1177Swdenk
1577bb99ad6dSBen Warren		CONFIG_I2C_MULTI_BUS
1578bb99ad6dSBen Warren
1579bb99ad6dSBen Warren		This option allows the use of multiple I2C buses, each of which
1580bb99ad6dSBen Warren		must have a controller.  At any point in time, only one bus is
1581bb99ad6dSBen Warren		active.  To switch to a different bus, use the 'i2c dev' command.
1582bb99ad6dSBen Warren		Note that bus numbering is zero-based.
1583bb99ad6dSBen Warren
15846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_NOPROBES
1585bb99ad6dSBen Warren
1586bb99ad6dSBen Warren		This option specifies a list of I2C devices that will be skipped
15870f89c54bSPeter Tyser		when the 'i2c probe' command is issued.  If CONFIG_I2C_MULTI_BUS
15880f89c54bSPeter Tyser		is set, specify a list of bus-device pairs.  Otherwise, specify
15890f89c54bSPeter Tyser		a 1D array of device addresses
1590bb99ad6dSBen Warren
1591bb99ad6dSBen Warren		e.g.
1592bb99ad6dSBen Warren			#undef	CONFIG_I2C_MULTI_BUS
15936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_NOPROBES	{0x50,0x68}
1594bb99ad6dSBen Warren
1595bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on a board with one I2C bus
1596bb99ad6dSBen Warren
1597bb99ad6dSBen Warren			#define	CONFIG_I2C_MULTI_BUS
15986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_MULTI_NOPROBES	{{0,0x50},{0,0x68},{1,0x54}}
1599bb99ad6dSBen Warren
1600bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1601bb99ad6dSBen Warren
16026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SPD_BUS_NUM
1603be5e6181STimur Tabi
1604be5e6181STimur Tabi		If defined, then this indicates the I2C bus number for DDR SPD.
1605be5e6181STimur Tabi		If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1606be5e6181STimur Tabi
16076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_BUS_NUM
16080dc018ecSStefan Roese
16090dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the RTC.
16100dc018ecSStefan Roese		If not defined, then U-Boot assumes that RTC is on I2C bus 0.
16110dc018ecSStefan Roese
16126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_DTT_BUS_NUM
16130dc018ecSStefan Roese
16140dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the DTT.
16150dc018ecSStefan Roese		If not defined, then U-Boot assumes that DTT is on I2C bus 0.
16160dc018ecSStefan Roese
16176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_DTT_ADDR:
16189ebbb54fSVictor Gallardo
16199ebbb54fSVictor Gallardo		If defined, specifies the I2C address of the DTT device.
16209ebbb54fSVictor Gallardo		If not defined, then U-Boot uses predefined value for
16219ebbb54fSVictor Gallardo		specified DTT device.
16229ebbb54fSVictor Gallardo
1623be5e6181STimur Tabi		CONFIG_FSL_I2C
1624be5e6181STimur Tabi
1625be5e6181STimur Tabi		Define this option if you want to use Freescale's I2C driver in
16267817cb20SMarcel Ziswiler		drivers/i2c/fsl_i2c.c.
1627be5e6181STimur Tabi
162867b23a32SHeiko Schocher		CONFIG_I2C_MUX
162967b23a32SHeiko Schocher
163067b23a32SHeiko Schocher		Define this option if you have I2C devices reached over 1 .. n
163167b23a32SHeiko Schocher		I2C Muxes like the pca9544a. This option addes a new I2C
163267b23a32SHeiko Schocher		Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
163367b23a32SHeiko Schocher		new I2C Bus to the existing I2C Busses. If you select the
163467b23a32SHeiko Schocher		new Bus with "i2c dev", u-bbot sends first the commandos for
163567b23a32SHeiko Schocher		the muxes to activate this new "bus".
163667b23a32SHeiko Schocher
163767b23a32SHeiko Schocher		CONFIG_I2C_MULTI_BUS must be also defined, to use this
163867b23a32SHeiko Schocher		feature!
163967b23a32SHeiko Schocher
164067b23a32SHeiko Schocher		Example:
164167b23a32SHeiko Schocher		Adding a new I2C Bus reached over 2 pca9544a muxes
164267b23a32SHeiko Schocher			The First mux with address 70 and channel 6
164367b23a32SHeiko Schocher			The Second mux with address 71 and channel 4
164467b23a32SHeiko Schocher
164567b23a32SHeiko Schocher		=> i2c bus pca9544a:70:6:pca9544a:71:4
164667b23a32SHeiko Schocher
164767b23a32SHeiko Schocher		Use the "i2c bus" command without parameter, to get a list
164867b23a32SHeiko Schocher		of I2C Busses with muxes:
164967b23a32SHeiko Schocher
165067b23a32SHeiko Schocher		=> i2c bus
165167b23a32SHeiko Schocher		Busses reached over muxes:
165267b23a32SHeiko Schocher		Bus ID: 2
165367b23a32SHeiko Schocher		  reached over Mux(es):
165467b23a32SHeiko Schocher		    pca9544a@70 ch: 4
165567b23a32SHeiko Schocher		Bus ID: 3
165667b23a32SHeiko Schocher		  reached over Mux(es):
165767b23a32SHeiko Schocher		    pca9544a@70 ch: 6
165867b23a32SHeiko Schocher		    pca9544a@71 ch: 4
165967b23a32SHeiko Schocher		=>
166067b23a32SHeiko Schocher
166167b23a32SHeiko Schocher		If you now switch to the new I2C Bus 3 with "i2c dev 3"
166267b23a32SHeiko Schocher		u-boot sends First the Commando to the mux@70 to enable
166367b23a32SHeiko Schocher		channel 6, and then the Commando to the mux@71 to enable
166467b23a32SHeiko Schocher		the channel 4.
166567b23a32SHeiko Schocher
166667b23a32SHeiko Schocher		After that, you can use the "normal" i2c commands as
166767b23a32SHeiko Schocher		usual, to communicate with your I2C devices behind
166867b23a32SHeiko Schocher		the 2 muxes.
166967b23a32SHeiko Schocher
167067b23a32SHeiko Schocher		This option is actually implemented for the bitbanging
167167b23a32SHeiko Schocher		algorithm in common/soft_i2c.c and for the Hardware I2C
167267b23a32SHeiko Schocher		Bus on the MPC8260. But it should be not so difficult
167367b23a32SHeiko Schocher		to add this option to other architectures.
167467b23a32SHeiko Schocher
16752ac6985aSAndrew Dyer		CONFIG_SOFT_I2C_READ_REPEATED_START
16762ac6985aSAndrew Dyer
16772ac6985aSAndrew Dyer		defining this will force the i2c_read() function in
16782ac6985aSAndrew Dyer		the soft_i2c driver to perform an I2C repeated start
16792ac6985aSAndrew Dyer		between writing the address pointer and reading the
16802ac6985aSAndrew Dyer		data.  If this define is omitted the default behaviour
16812ac6985aSAndrew Dyer		of doing a stop-start sequence will be used.  Most I2C
16822ac6985aSAndrew Dyer		devices can use either method, but some require one or
16832ac6985aSAndrew Dyer		the other.
1684be5e6181STimur Tabi
1685c609719bSwdenk- SPI Support:	CONFIG_SPI
1686c609719bSwdenk
1687c609719bSwdenk		Enables SPI driver (so far only tested with
1688c609719bSwdenk		SPI EEPROM, also an instance works with Crystal A/D and
1689c609719bSwdenk		D/As on the SACSng board)
1690c609719bSwdenk
16916639562eSYoshihiro Shimoda		CONFIG_SH_SPI
16926639562eSYoshihiro Shimoda
16936639562eSYoshihiro Shimoda		Enables the driver for SPI controller on SuperH. Currently
16946639562eSYoshihiro Shimoda		only SH7757 is supported.
16956639562eSYoshihiro Shimoda
1696c609719bSwdenk		CONFIG_SPI_X
1697c609719bSwdenk
1698c609719bSwdenk		Enables extended (16-bit) SPI EEPROM addressing.
1699c609719bSwdenk		(symmetrical to CONFIG_I2C_X)
1700c609719bSwdenk
1701c609719bSwdenk		CONFIG_SOFT_SPI
1702c609719bSwdenk
1703c609719bSwdenk		Enables a software (bit-bang) SPI driver rather than
1704c609719bSwdenk		using hardware support. This is a general purpose
1705c609719bSwdenk		driver that only requires three general I/O port pins
1706c609719bSwdenk		(two outputs, one input) to function. If this is
1707c609719bSwdenk		defined, the board configuration must define several
1708c609719bSwdenk		SPI configuration items (port pins to use, etc). For
1709c609719bSwdenk		an example, see include/configs/sacsng.h.
1710c609719bSwdenk
171104a9e118SBen Warren		CONFIG_HARD_SPI
171204a9e118SBen Warren
171304a9e118SBen Warren		Enables a hardware SPI driver for general-purpose reads
171404a9e118SBen Warren		and writes.  As with CONFIG_SOFT_SPI, the board configuration
171504a9e118SBen Warren		must define a list of chip-select function pointers.
171604a9e118SBen Warren		Currently supported on some MPC8xxx processors.  For an
171704a9e118SBen Warren		example, see include/configs/mpc8349emds.h.
171804a9e118SBen Warren
171938254f45SGuennadi Liakhovetski		CONFIG_MXC_SPI
172038254f45SGuennadi Liakhovetski
172138254f45SGuennadi Liakhovetski		Enables the driver for the SPI controllers on i.MX and MXC
172238254f45SGuennadi Liakhovetski		SoCs. Currently only i.MX31 is supported.
172338254f45SGuennadi Liakhovetski
17240133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA
17250133502eSMatthias Fuchs
17260133502eSMatthias Fuchs		Enables FPGA subsystem.
17270133502eSMatthias Fuchs
17280133502eSMatthias Fuchs		CONFIG_FPGA_<vendor>
17290133502eSMatthias Fuchs
17300133502eSMatthias Fuchs		Enables support for specific chip vendors.
17310133502eSMatthias Fuchs		(ALTERA, XILINX)
17320133502eSMatthias Fuchs
17330133502eSMatthias Fuchs		CONFIG_FPGA_<family>
17340133502eSMatthias Fuchs
17350133502eSMatthias Fuchs		Enables support for FPGA family.
17360133502eSMatthias Fuchs		(SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
17370133502eSMatthias Fuchs
17380133502eSMatthias Fuchs		CONFIG_FPGA_COUNT
1739c609719bSwdenk
1740c609719bSwdenk		Specify the number of FPGA devices to support.
1741c609719bSwdenk
17426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_PROG_FEEDBACK
1743c609719bSwdenk
1744c609719bSwdenk		Enable printing of hash marks during FPGA configuration.
1745c609719bSwdenk
17466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_BUSY
1747c609719bSwdenk
1748c609719bSwdenk		Enable checks on FPGA configuration interface busy
1749c609719bSwdenk		status by the configuration function. This option
1750c609719bSwdenk		will require a board or device specific function to
1751c609719bSwdenk		be written.
1752c609719bSwdenk
1753c609719bSwdenk		CONFIG_FPGA_DELAY
1754c609719bSwdenk
1755c609719bSwdenk		If defined, a function that provides delays in the FPGA
1756c609719bSwdenk		configuration driver.
1757c609719bSwdenk
17586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_CTRLC
1759c609719bSwdenk		Allow Control-C to interrupt FPGA configuration
1760c609719bSwdenk
17616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_ERROR
1762c609719bSwdenk
1763c609719bSwdenk		Check for configuration errors during FPGA bitfile
1764c609719bSwdenk		loading. For example, abort during Virtex II
1765c609719bSwdenk		configuration if the INIT_B line goes low (which
1766c609719bSwdenk		indicated a CRC error).
1767c609719bSwdenk
17686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_INIT
1769c609719bSwdenk
1770c609719bSwdenk		Maximum time to wait for the INIT_B line to deassert
1771c609719bSwdenk		after PROB_B has been deasserted during a Virtex II
1772c609719bSwdenk		FPGA configuration sequence. The default time is 500
177311ccc33fSMarcel Ziswiler		ms.
1774c609719bSwdenk
17756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_BUSY
1776c609719bSwdenk
1777c609719bSwdenk		Maximum time to wait for BUSY to deassert during
177811ccc33fSMarcel Ziswiler		Virtex II FPGA configuration. The default is 5 ms.
1779c609719bSwdenk
17806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_CONFIG
1781c609719bSwdenk
1782c609719bSwdenk		Time to wait after FPGA configuration. The default is
178311ccc33fSMarcel Ziswiler		200 ms.
1784c609719bSwdenk
1785c609719bSwdenk- Configuration Management:
1786c609719bSwdenk		CONFIG_IDENT_STRING
1787c609719bSwdenk
1788c609719bSwdenk		If defined, this string will be added to the U-Boot
1789c609719bSwdenk		version information (U_BOOT_VERSION)
1790c609719bSwdenk
1791c609719bSwdenk- Vendor Parameter Protection:
1792c609719bSwdenk
1793c609719bSwdenk		U-Boot considers the values of the environment
1794c609719bSwdenk		variables "serial#" (Board Serial Number) and
17957152b1d0Swdenk		"ethaddr" (Ethernet Address) to be parameters that
1796c609719bSwdenk		are set once by the board vendor / manufacturer, and
1797c609719bSwdenk		protects these variables from casual modification by
1798c609719bSwdenk		the user. Once set, these variables are read-only,
1799c609719bSwdenk		and write or delete attempts are rejected. You can
180011ccc33fSMarcel Ziswiler		change this behaviour:
1801c609719bSwdenk
1802c609719bSwdenk		If CONFIG_ENV_OVERWRITE is #defined in your config
1803c609719bSwdenk		file, the write protection for vendor parameters is
180447cd00faSwdenk		completely disabled. Anybody can change or delete
1805c609719bSwdenk		these parameters.
1806c609719bSwdenk
1807c609719bSwdenk		Alternatively, if you #define _both_ CONFIG_ETHADDR
1808c609719bSwdenk		_and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
180911ccc33fSMarcel Ziswiler		Ethernet address is installed in the environment,
1810c609719bSwdenk		which can be changed exactly ONCE by the user. [The
1811c609719bSwdenk		serial# is unaffected by this, i. e. it remains
1812c609719bSwdenk		read-only.]
1813c609719bSwdenk
1814c609719bSwdenk- Protected RAM:
1815c609719bSwdenk		CONFIG_PRAM
1816c609719bSwdenk
1817c609719bSwdenk		Define this variable to enable the reservation of
1818c609719bSwdenk		"protected RAM", i. e. RAM which is not overwritten
1819c609719bSwdenk		by U-Boot. Define CONFIG_PRAM to hold the number of
1820c609719bSwdenk		kB you want to reserve for pRAM. You can overwrite
1821c609719bSwdenk		this default value by defining an environment
1822c609719bSwdenk		variable "pram" to the number of kB you want to
1823c609719bSwdenk		reserve. Note that the board info structure will
1824c609719bSwdenk		still show the full amount of RAM. If pRAM is
1825c609719bSwdenk		reserved, a new environment variable "mem" will
1826c609719bSwdenk		automatically be defined to hold the amount of
1827c609719bSwdenk		remaining RAM in a form that can be passed as boot
1828c609719bSwdenk		argument to Linux, for instance like that:
1829c609719bSwdenk
1830fe126d8bSWolfgang Denk			setenv bootargs ... mem=\${mem}
1831c609719bSwdenk			saveenv
1832c609719bSwdenk
1833c609719bSwdenk		This way you can tell Linux not to use this memory,
1834c609719bSwdenk		either, which results in a memory region that will
1835c609719bSwdenk		not be affected by reboots.
1836c609719bSwdenk
1837c609719bSwdenk		*WARNING* If your board configuration uses automatic
1838c609719bSwdenk		detection of the RAM size, you must make sure that
1839c609719bSwdenk		this memory test is non-destructive. So far, the
1840c609719bSwdenk		following board configurations are known to be
1841c609719bSwdenk		"pRAM-clean":
1842c609719bSwdenk
1843c609719bSwdenk			ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
1844c609719bSwdenk			HERMES, IP860, RPXlite, LWMON, LANTEC,
1845544d97e9SWolfgang Denk			FLAGADM, TQM8260
1846c609719bSwdenk
1847c609719bSwdenk- Error Recovery:
1848c609719bSwdenk		CONFIG_PANIC_HANG
1849c609719bSwdenk
1850c609719bSwdenk		Define this variable to stop the system in case of a
1851c609719bSwdenk		fatal error, so that you have to reset it manually.
1852c609719bSwdenk		This is probably NOT a good idea for an embedded
185311ccc33fSMarcel Ziswiler		system where you want the system to reboot
1854c609719bSwdenk		automatically as fast as possible, but it may be
1855c609719bSwdenk		useful during development since you can try to debug
1856c609719bSwdenk		the conditions that lead to the situation.
1857c609719bSwdenk
1858c609719bSwdenk		CONFIG_NET_RETRY_COUNT
1859c609719bSwdenk
1860c609719bSwdenk		This variable defines the number of retries for
1861c609719bSwdenk		network operations like ARP, RARP, TFTP, or BOOTP
1862c609719bSwdenk		before giving up the operation. If not defined, a
1863c609719bSwdenk		default value of 5 is used.
1864c609719bSwdenk
186540cb90eeSGuennadi Liakhovetski		CONFIG_ARP_TIMEOUT
186640cb90eeSGuennadi Liakhovetski
186740cb90eeSGuennadi Liakhovetski		Timeout waiting for an ARP reply in milliseconds.
186840cb90eeSGuennadi Liakhovetski
1869c609719bSwdenk- Command Interpreter:
18708078f1a5SWolfgang Denk		CONFIG_AUTO_COMPLETE
187104a85b3bSwdenk
187204a85b3bSwdenk		Enable auto completion of commands using TAB.
187304a85b3bSwdenk
18748078f1a5SWolfgang Denk		Note that this feature has NOT been implemented yet
18758078f1a5SWolfgang Denk		for the "hush" shell.
18768078f1a5SWolfgang Denk
18778078f1a5SWolfgang Denk
18786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_HUSH_PARSER
1879c609719bSwdenk
1880c609719bSwdenk		Define this variable to enable the "hush" shell (from
1881c609719bSwdenk		Busybox) as command line interpreter, thus enabling
1882c609719bSwdenk		powerful command line syntax like
1883c609719bSwdenk		if...then...else...fi conditionals or `&&' and '||'
1884c609719bSwdenk		constructs ("shell scripts").
1885c609719bSwdenk
1886c609719bSwdenk		If undefined, you get the old, much simpler behaviour
1887c609719bSwdenk		with a somewhat smaller memory footprint.
1888c609719bSwdenk
1889c609719bSwdenk
18906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_PROMPT_HUSH_PS2
1891c609719bSwdenk
1892c609719bSwdenk		This defines the secondary prompt string, which is
1893c609719bSwdenk		printed when the command interpreter needs more input
1894c609719bSwdenk		to complete a command. Usually "> ".
1895c609719bSwdenk
1896c609719bSwdenk	Note:
1897c609719bSwdenk
1898c609719bSwdenk		In the current implementation, the local variables
1899c609719bSwdenk		space and global environment variables space are
1900c609719bSwdenk		separated. Local variables are those you define by
19013b57fe0aSwdenk		simply typing `name=value'. To access a local
1902c609719bSwdenk		variable later on, you have write `$name' or
19033b57fe0aSwdenk		`${name}'; to execute the contents of a variable
19043b57fe0aSwdenk		directly type `$name' at the command prompt.
1905c609719bSwdenk
1906c609719bSwdenk		Global environment variables are those you use
1907c609719bSwdenk		setenv/printenv to work with. To run a command stored
1908c609719bSwdenk		in such a variable, you need to use the run command,
1909c609719bSwdenk		and you must not use the '$' sign to access them.
1910c609719bSwdenk
1911c609719bSwdenk		To store commands and special characters in a
1912c609719bSwdenk		variable, please use double quotation marks
1913c609719bSwdenk		surrounding the whole text of the variable, instead
1914c609719bSwdenk		of the backslashes before semicolons and special
1915c609719bSwdenk		symbols.
1916c609719bSwdenk
1917aa0c71acSWolfgang Denk- Commandline Editing and History:
1918aa0c71acSWolfgang Denk		CONFIG_CMDLINE_EDITING
1919aa0c71acSWolfgang Denk
192011ccc33fSMarcel Ziswiler		Enable editing and History functions for interactive
1921aa0c71acSWolfgang Denk		commandline input operations
1922aa0c71acSWolfgang Denk
1923a8c7c708Swdenk- Default Environment:
1924c609719bSwdenk		CONFIG_EXTRA_ENV_SETTINGS
1925c609719bSwdenk
1926c609719bSwdenk		Define this to contain any number of null terminated
1927c609719bSwdenk		strings (variable = value pairs) that will be part of
19287152b1d0Swdenk		the default environment compiled into the boot image.
19292262cfeeSwdenk
1930c609719bSwdenk		For example, place something like this in your
1931c609719bSwdenk		board's config file:
1932c609719bSwdenk
1933c609719bSwdenk		#define CONFIG_EXTRA_ENV_SETTINGS \
1934c609719bSwdenk			"myvar1=value1\0" \
1935c609719bSwdenk			"myvar2=value2\0"
1936c609719bSwdenk
1937c609719bSwdenk		Warning: This method is based on knowledge about the
1938c609719bSwdenk		internal format how the environment is stored by the
19392262cfeeSwdenk		U-Boot code. This is NOT an official, exported
1940c609719bSwdenk		interface! Although it is unlikely that this format
19417152b1d0Swdenk		will change soon, there is no guarantee either.
1942c609719bSwdenk		You better know what you are doing here.
1943c609719bSwdenk
1944c609719bSwdenk		Note: overly (ab)use of the default environment is
1945c609719bSwdenk		discouraged. Make sure to check other ways to preset
194674de7aefSWolfgang Denk		the environment like the "source" command or the
1947c609719bSwdenk		boot command first.
1948c609719bSwdenk
1949a8c7c708Swdenk- DataFlash Support:
19502abbe075Swdenk		CONFIG_HAS_DATAFLASH
19512abbe075Swdenk
19522abbe075Swdenk		Defining this option enables DataFlash features and
19532abbe075Swdenk		allows to read/write in Dataflash via the standard
19542abbe075Swdenk		commands cp, md...
19552abbe075Swdenk
19563f85ce27Swdenk- SystemACE Support:
19573f85ce27Swdenk		CONFIG_SYSTEMACE
19583f85ce27Swdenk
19593f85ce27Swdenk		Adding this option adds support for Xilinx SystemACE
19603f85ce27Swdenk		chips attached via some sort of local bus. The address
196111ccc33fSMarcel Ziswiler		of the chip must also be defined in the
19626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SYSTEMACE_BASE macro. For example:
19633f85ce27Swdenk
19643f85ce27Swdenk		#define CONFIG_SYSTEMACE
19656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
19663f85ce27Swdenk
19673f85ce27Swdenk		When SystemACE support is added, the "ace" device type
19683f85ce27Swdenk		becomes available to the fat commands, i.e. fatls.
19693f85ce27Swdenk
1970ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port:
1971ecb0ccd9SWolfgang Denk		CONFIG_TFTP_PORT
1972ecb0ccd9SWolfgang Denk
197328cb9375SWolfgang Denk		If this is defined, the environment variable tftpsrcp
1974ecb0ccd9SWolfgang Denk		is used to supply the TFTP UDP source port value.
197528cb9375SWolfgang Denk		If tftpsrcp isn't defined, the normal pseudo-random port
1976ecb0ccd9SWolfgang Denk		number generator is used.
1977ecb0ccd9SWolfgang Denk
197828cb9375SWolfgang Denk		Also, the environment variable tftpdstp is used to supply
197928cb9375SWolfgang Denk		the TFTP UDP destination port value.  If tftpdstp isn't
198028cb9375SWolfgang Denk		defined, the normal port 69 is used.
198128cb9375SWolfgang Denk
198228cb9375SWolfgang Denk		The purpose for tftpsrcp is to allow a TFTP server to
1983ecb0ccd9SWolfgang Denk		blindly start the TFTP transfer using the pre-configured
1984ecb0ccd9SWolfgang Denk		target IP address and UDP port. This has the effect of
1985ecb0ccd9SWolfgang Denk		"punching through" the (Windows XP) firewall, allowing
1986ecb0ccd9SWolfgang Denk		the remainder of the TFTP transfer to proceed normally.
1987ecb0ccd9SWolfgang Denk		A better solution is to properly configure the firewall,
1988ecb0ccd9SWolfgang Denk		but sometimes that is not allowed.
1989ecb0ccd9SWolfgang Denk
1990a8c7c708Swdenk- Show boot progress:
1991c609719bSwdenk		CONFIG_SHOW_BOOT_PROGRESS
1992c609719bSwdenk
1993c609719bSwdenk		Defining this option allows to add some board-
1994c609719bSwdenk		specific code (calling a user-provided function
1995c609719bSwdenk		"show_boot_progress(int)") that enables you to show
1996c609719bSwdenk		the system's boot progress on some display (for
1997c609719bSwdenk		example, some LED's) on your board. At the moment,
1998c609719bSwdenk		the following checkpoints are implemented:
1999c609719bSwdenk
20008ae86b76SWolfgang Denk- Standalone program support:
20018ae86b76SWolfgang Denk		CONFIG_STANDALONE_LOAD_ADDR
20028ae86b76SWolfgang Denk
20038ae86b76SWolfgang Denk		This option allows to define board specific values
20048ae86b76SWolfgang Denk		for the address where standalone program gets loaded,
20058ae86b76SWolfgang Denk		thus overwriting the architecutre dependent default
20068ae86b76SWolfgang Denk		settings.
20078ae86b76SWolfgang Denk
20081372cce2SMarian BalakowiczLegacy uImage format:
20091372cce2SMarian Balakowicz
2010c609719bSwdenk  Arg	Where			When
2011c609719bSwdenk    1	common/cmd_bootm.c	before attempting to boot an image
2012c609719bSwdenk   -1	common/cmd_bootm.c	Image header has bad	 magic number
2013c609719bSwdenk    2	common/cmd_bootm.c	Image header has correct magic number
2014c609719bSwdenk   -2	common/cmd_bootm.c	Image header has bad	 checksum
2015c609719bSwdenk    3	common/cmd_bootm.c	Image header has correct checksum
2016c609719bSwdenk   -3	common/cmd_bootm.c	Image data   has bad	 checksum
2017c609719bSwdenk    4	common/cmd_bootm.c	Image data   has correct checksum
2018c609719bSwdenk   -4	common/cmd_bootm.c	Image is for unsupported architecture
2019c609719bSwdenk    5	common/cmd_bootm.c	Architecture check OK
20201372cce2SMarian Balakowicz   -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi)
2021c609719bSwdenk    6	common/cmd_bootm.c	Image Type check OK
2022c609719bSwdenk   -6	common/cmd_bootm.c	gunzip uncompression error
2023c609719bSwdenk   -7	common/cmd_bootm.c	Unimplemented compression type
2024c609719bSwdenk    7	common/cmd_bootm.c	Uncompression OK
20251372cce2SMarian Balakowicz    8	common/cmd_bootm.c	No uncompress/copy overwrite error
2026c609719bSwdenk   -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
20271372cce2SMarian Balakowicz
20281372cce2SMarian Balakowicz    9	common/image.c		Start initial ramdisk verification
20291372cce2SMarian Balakowicz  -10	common/image.c		Ramdisk header has bad	   magic number
20301372cce2SMarian Balakowicz  -11	common/image.c		Ramdisk header has bad	   checksum
20311372cce2SMarian Balakowicz   10	common/image.c		Ramdisk header is OK
20321372cce2SMarian Balakowicz  -12	common/image.c		Ramdisk data   has bad	   checksum
20331372cce2SMarian Balakowicz   11	common/image.c		Ramdisk data   has correct checksum
20341372cce2SMarian Balakowicz   12	common/image.c		Ramdisk verification complete, start loading
203511ccc33fSMarcel Ziswiler  -13	common/image.c		Wrong Image Type (not PPC Linux ramdisk)
20361372cce2SMarian Balakowicz   13	common/image.c		Start multifile image verification
20371372cce2SMarian Balakowicz   14	common/image.c		No initial ramdisk, no multifile, continue.
20381372cce2SMarian Balakowicz
2039ea0364f1SPeter Tyser   15	arch/<arch>/lib/bootm.c	All preparation done, transferring control to OS
2040c609719bSwdenk
2041a47a12beSStefan Roese  -30	arch/powerpc/lib/board.c	Fatal error, hang the system
204263e73c9aSwdenk  -31	post/post.c		POST test failed, detected by post_output_backlog()
204363e73c9aSwdenk  -32	post/post.c		POST test failed, detected by post_run_single()
204463e73c9aSwdenk
2045566a494fSHeiko Schocher   34	common/cmd_doc.c	before loading a Image from a DOC device
2046566a494fSHeiko Schocher  -35	common/cmd_doc.c	Bad usage of "doc" command
2047566a494fSHeiko Schocher   35	common/cmd_doc.c	correct usage of "doc" command
2048566a494fSHeiko Schocher  -36	common/cmd_doc.c	No boot device
2049566a494fSHeiko Schocher   36	common/cmd_doc.c	correct boot device
2050566a494fSHeiko Schocher  -37	common/cmd_doc.c	Unknown Chip ID on boot device
2051566a494fSHeiko Schocher   37	common/cmd_doc.c	correct chip ID found, device available
2052566a494fSHeiko Schocher  -38	common/cmd_doc.c	Read Error on boot device
2053566a494fSHeiko Schocher   38	common/cmd_doc.c	reading Image header from DOC device OK
2054566a494fSHeiko Schocher  -39	common/cmd_doc.c	Image header has bad magic number
2055566a494fSHeiko Schocher   39	common/cmd_doc.c	Image header has correct magic number
2056566a494fSHeiko Schocher  -40	common/cmd_doc.c	Error reading Image from DOC device
2057566a494fSHeiko Schocher   40	common/cmd_doc.c	Image header has correct magic number
2058566a494fSHeiko Schocher   41	common/cmd_ide.c	before loading a Image from a IDE device
2059566a494fSHeiko Schocher  -42	common/cmd_ide.c	Bad usage of "ide" command
2060566a494fSHeiko Schocher   42	common/cmd_ide.c	correct usage of "ide" command
2061566a494fSHeiko Schocher  -43	common/cmd_ide.c	No boot device
2062566a494fSHeiko Schocher   43	common/cmd_ide.c	boot device found
2063566a494fSHeiko Schocher  -44	common/cmd_ide.c	Device not available
2064566a494fSHeiko Schocher   44	common/cmd_ide.c	Device available
2065566a494fSHeiko Schocher  -45	common/cmd_ide.c	wrong partition selected
2066566a494fSHeiko Schocher   45	common/cmd_ide.c	partition selected
2067566a494fSHeiko Schocher  -46	common/cmd_ide.c	Unknown partition table
2068566a494fSHeiko Schocher   46	common/cmd_ide.c	valid partition table found
2069566a494fSHeiko Schocher  -47	common/cmd_ide.c	Invalid partition type
2070566a494fSHeiko Schocher   47	common/cmd_ide.c	correct partition type
2071566a494fSHeiko Schocher  -48	common/cmd_ide.c	Error reading Image Header on boot device
2072566a494fSHeiko Schocher   48	common/cmd_ide.c	reading Image Header from IDE device OK
2073566a494fSHeiko Schocher  -49	common/cmd_ide.c	Image header has bad magic number
2074566a494fSHeiko Schocher   49	common/cmd_ide.c	Image header has correct magic number
2075566a494fSHeiko Schocher  -50	common/cmd_ide.c	Image header has bad	 checksum
2076566a494fSHeiko Schocher   50	common/cmd_ide.c	Image header has correct checksum
2077566a494fSHeiko Schocher  -51	common/cmd_ide.c	Error reading Image from IDE device
2078566a494fSHeiko Schocher   51	common/cmd_ide.c	reading Image from IDE device OK
2079566a494fSHeiko Schocher   52	common/cmd_nand.c	before loading a Image from a NAND device
2080566a494fSHeiko Schocher  -53	common/cmd_nand.c	Bad usage of "nand" command
2081566a494fSHeiko Schocher   53	common/cmd_nand.c	correct usage of "nand" command
2082566a494fSHeiko Schocher  -54	common/cmd_nand.c	No boot device
2083566a494fSHeiko Schocher   54	common/cmd_nand.c	boot device found
2084566a494fSHeiko Schocher  -55	common/cmd_nand.c	Unknown Chip ID on boot device
2085566a494fSHeiko Schocher   55	common/cmd_nand.c	correct chip ID found, device available
2086566a494fSHeiko Schocher  -56	common/cmd_nand.c	Error reading Image Header on boot device
2087566a494fSHeiko Schocher   56	common/cmd_nand.c	reading Image Header from NAND device OK
2088566a494fSHeiko Schocher  -57	common/cmd_nand.c	Image header has bad magic number
2089566a494fSHeiko Schocher   57	common/cmd_nand.c	Image header has correct magic number
2090566a494fSHeiko Schocher  -58	common/cmd_nand.c	Error reading Image from NAND device
2091566a494fSHeiko Schocher   58	common/cmd_nand.c	reading Image from NAND device OK
2092c609719bSwdenk
2093566a494fSHeiko Schocher  -60	common/env_common.c	Environment has a bad CRC, using default
2094c609719bSwdenk
2095566a494fSHeiko Schocher   64	net/eth.c		starting with Ethernet configuration.
2096566a494fSHeiko Schocher  -64	net/eth.c		no Ethernet found.
2097566a494fSHeiko Schocher   65	net/eth.c		Ethernet found.
2098206c60cbSwdenk
2099566a494fSHeiko Schocher  -80	common/cmd_net.c	usage wrong
2100566a494fSHeiko Schocher   80	common/cmd_net.c	before calling NetLoop()
210111ccc33fSMarcel Ziswiler  -81	common/cmd_net.c	some error in NetLoop() occurred
2102566a494fSHeiko Schocher   81	common/cmd_net.c	NetLoop() back without error
2103566a494fSHeiko Schocher  -82	common/cmd_net.c	size == 0 (File with size 0 loaded)
2104566a494fSHeiko Schocher   82	common/cmd_net.c	trying automatic boot
210574de7aefSWolfgang Denk   83	common/cmd_net.c	running "source" command
210674de7aefSWolfgang Denk  -83	common/cmd_net.c	some error in automatic boot or "source" command
2107566a494fSHeiko Schocher   84	common/cmd_net.c	end without errors
2108c609719bSwdenk
21091372cce2SMarian BalakowiczFIT uImage format:
21101372cce2SMarian Balakowicz
21111372cce2SMarian Balakowicz  Arg	Where			When
21121372cce2SMarian Balakowicz  100	common/cmd_bootm.c	Kernel FIT Image has correct format
21131372cce2SMarian Balakowicz -100	common/cmd_bootm.c	Kernel FIT Image has incorrect format
21141372cce2SMarian Balakowicz  101	common/cmd_bootm.c	No Kernel subimage unit name, using configuration
21151372cce2SMarian Balakowicz -101	common/cmd_bootm.c	Can't get configuration for kernel subimage
21161372cce2SMarian Balakowicz  102	common/cmd_bootm.c	Kernel unit name specified
21171372cce2SMarian Balakowicz -103	common/cmd_bootm.c	Can't get kernel subimage node offset
2118f773bea8SMarian Balakowicz  103	common/cmd_bootm.c	Found configuration node
21191372cce2SMarian Balakowicz  104	common/cmd_bootm.c	Got kernel subimage node offset
21201372cce2SMarian Balakowicz -104	common/cmd_bootm.c	Kernel subimage hash verification failed
21211372cce2SMarian Balakowicz  105	common/cmd_bootm.c	Kernel subimage hash verification OK
21221372cce2SMarian Balakowicz -105	common/cmd_bootm.c	Kernel subimage is for unsupported architecture
21231372cce2SMarian Balakowicz  106	common/cmd_bootm.c	Architecture check OK
212411ccc33fSMarcel Ziswiler -106	common/cmd_bootm.c	Kernel subimage has wrong type
212511ccc33fSMarcel Ziswiler  107	common/cmd_bootm.c	Kernel subimage type OK
21261372cce2SMarian Balakowicz -107	common/cmd_bootm.c	Can't get kernel subimage data/size
21271372cce2SMarian Balakowicz  108	common/cmd_bootm.c	Got kernel subimage data/size
21281372cce2SMarian Balakowicz -108	common/cmd_bootm.c	Wrong image type (not legacy, FIT)
21291372cce2SMarian Balakowicz -109	common/cmd_bootm.c	Can't get kernel subimage type
21301372cce2SMarian Balakowicz -110	common/cmd_bootm.c	Can't get kernel subimage comp
21311372cce2SMarian Balakowicz -111	common/cmd_bootm.c	Can't get kernel subimage os
21321372cce2SMarian Balakowicz -112	common/cmd_bootm.c	Can't get kernel subimage load address
21331372cce2SMarian Balakowicz -113	common/cmd_bootm.c	Image uncompress/copy overwrite error
21341372cce2SMarian Balakowicz
21351372cce2SMarian Balakowicz  120	common/image.c		Start initial ramdisk verification
21361372cce2SMarian Balakowicz -120	common/image.c		Ramdisk FIT image has incorrect format
21371372cce2SMarian Balakowicz  121	common/image.c		Ramdisk FIT image has correct format
213811ccc33fSMarcel Ziswiler  122	common/image.c		No ramdisk subimage unit name, using configuration
21391372cce2SMarian Balakowicz -122	common/image.c		Can't get configuration for ramdisk subimage
21401372cce2SMarian Balakowicz  123	common/image.c		Ramdisk unit name specified
21411372cce2SMarian Balakowicz -124	common/image.c		Can't get ramdisk subimage node offset
21421372cce2SMarian Balakowicz  125	common/image.c		Got ramdisk subimage node offset
21431372cce2SMarian Balakowicz -125	common/image.c		Ramdisk subimage hash verification failed
21441372cce2SMarian Balakowicz  126	common/image.c		Ramdisk subimage hash verification OK
21451372cce2SMarian Balakowicz -126	common/image.c		Ramdisk subimage for unsupported architecture
21461372cce2SMarian Balakowicz  127	common/image.c		Architecture check OK
21471372cce2SMarian Balakowicz -127	common/image.c		Can't get ramdisk subimage data/size
21481372cce2SMarian Balakowicz  128	common/image.c		Got ramdisk subimage data/size
21491372cce2SMarian Balakowicz  129	common/image.c		Can't get ramdisk load address
21501372cce2SMarian Balakowicz -129	common/image.c		Got ramdisk load address
21511372cce2SMarian Balakowicz
215211ccc33fSMarcel Ziswiler -130	common/cmd_doc.c	Incorrect FIT image format
21531372cce2SMarian Balakowicz  131	common/cmd_doc.c	FIT image format OK
21541372cce2SMarian Balakowicz
215511ccc33fSMarcel Ziswiler -140	common/cmd_ide.c	Incorrect FIT image format
21561372cce2SMarian Balakowicz  141	common/cmd_ide.c	FIT image format OK
21571372cce2SMarian Balakowicz
215811ccc33fSMarcel Ziswiler -150	common/cmd_nand.c	Incorrect FIT image format
21591372cce2SMarian Balakowicz  151	common/cmd_nand.c	FIT image format OK
21601372cce2SMarian Balakowicz
2161cccfc2abSDetlev Zundel- Automatic software updates via TFTP server
2162cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP
2163cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_CNT_MAX
2164cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_MSEC_MAX
2165cccfc2abSDetlev Zundel
2166cccfc2abSDetlev Zundel		These options enable and control the auto-update feature;
2167cccfc2abSDetlev Zundel		for a more detailed description refer to doc/README.update.
2168cccfc2abSDetlev Zundel
2169cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support)
2170cccfc2abSDetlev Zundel		CONFIG_MTD_DEVICE
2171cccfc2abSDetlev Zundel
2172cccfc2abSDetlev Zundel		Adds the MTD device infrastructure from the Linux kernel.
2173cccfc2abSDetlev Zundel		Needed for mtdparts command support.
2174cccfc2abSDetlev Zundel
2175cccfc2abSDetlev Zundel		CONFIG_MTD_PARTITIONS
2176cccfc2abSDetlev Zundel
2177cccfc2abSDetlev Zundel		Adds the MTD partitioning infrastructure from the Linux
2178cccfc2abSDetlev Zundel		kernel. Needed for UBI support.
2179cccfc2abSDetlev Zundel
21801372cce2SMarian Balakowicz
2181c609719bSwdenkModem Support:
2182c609719bSwdenk--------------
2183c609719bSwdenk
218485ec0bccSwdenk[so far only for SMDK2400 and TRAB boards]
2185c609719bSwdenk
218611ccc33fSMarcel Ziswiler- Modem support enable:
2187c609719bSwdenk		CONFIG_MODEM_SUPPORT
2188c609719bSwdenk
2189c609719bSwdenk- RTS/CTS Flow control enable:
2190c609719bSwdenk		CONFIG_HWFLOW
2191c609719bSwdenk
2192c609719bSwdenk- Modem debug support:
2193c609719bSwdenk		CONFIG_MODEM_SUPPORT_DEBUG
2194c609719bSwdenk
2195c609719bSwdenk		Enables debugging stuff (char screen[1024], dbg())
2196c609719bSwdenk		for modem support. Useful only with BDI2000.
2197c609719bSwdenk
2198a8c7c708Swdenk- Interrupt support (PPC):
2199a8c7c708Swdenk
2200a8c7c708Swdenk		There are common interrupt_init() and timer_interrupt()
2201a8c7c708Swdenk		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
220211ccc33fSMarcel Ziswiler		for CPU specific initialization. interrupt_init_cpu()
2203a8c7c708Swdenk		should set decrementer_count to appropriate value. If
220411ccc33fSMarcel Ziswiler		CPU resets decrementer automatically after interrupt
2205a8c7c708Swdenk		(ppc4xx) it should set decrementer_count to zero.
220611ccc33fSMarcel Ziswiler		timer_interrupt() calls timer_interrupt_cpu() for CPU
2207a8c7c708Swdenk		specific handling. If board has watchdog / status_led
2208a8c7c708Swdenk		/ other_activity_monitor it works automatically from
2209a8c7c708Swdenk		general timer_interrupt().
2210a8c7c708Swdenk
2211c609719bSwdenk- General:
2212c609719bSwdenk
2213c609719bSwdenk		In the target system modem support is enabled when a
2214c609719bSwdenk		specific key (key combination) is pressed during
2215c609719bSwdenk		power-on. Otherwise U-Boot will boot normally
221611ccc33fSMarcel Ziswiler		(autoboot). The key_pressed() function is called from
2217c609719bSwdenk		board_init(). Currently key_pressed() is a dummy
2218c609719bSwdenk		function, returning 1 and thus enabling modem
2219c609719bSwdenk		initialization.
2220c609719bSwdenk
2221c609719bSwdenk		If there are no modem init strings in the
2222c609719bSwdenk		environment, U-Boot proceed to autoboot; the
2223c609719bSwdenk		previous output (banner, info printfs) will be
222411ccc33fSMarcel Ziswiler		suppressed, though.
2225c609719bSwdenk
2226c609719bSwdenk		See also: doc/README.Modem
2227c609719bSwdenk
2228c609719bSwdenk
2229c609719bSwdenkConfiguration Settings:
2230c609719bSwdenk-----------------------
2231c609719bSwdenk
22326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
2233c609719bSwdenk		undefine this when you're short of memory.
2234c609719bSwdenk
22352fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
22362fb2604dSPeter Tyser		width of the commands listed in the 'help' command output.
22372fb2604dSPeter Tyser
22386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT:	This is what U-Boot prints on the console to
2239c609719bSwdenk		prompt for user input.
2240c609719bSwdenk
22416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE:	Buffer size for input from the Console
2242c609719bSwdenk
22436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE:	Buffer size for Console output
2244c609719bSwdenk
22456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS:	max. Number of arguments accepted for monitor commands
2246c609719bSwdenk
22476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
2248c609719bSwdenk		the application (usually a Linux kernel) when it is
2249c609719bSwdenk		booted
2250c609719bSwdenk
22516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE:
2252c609719bSwdenk		List of legal baudrate settings for this board.
2253c609719bSwdenk
22546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_INFO_QUIET
2255c609719bSwdenk		Suppress display of console information at boot.
2256c609719bSwdenk
22576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_IS_IN_ENV
2258c609719bSwdenk		If the board specific function
2259c609719bSwdenk			extern int overwrite_console (void);
2260c609719bSwdenk		returns 1, the stdin, stderr and stdout are switched to the
2261c609719bSwdenk		serial port, else the settings in the environment are used.
2262c609719bSwdenk
22636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
2264c609719bSwdenk		Enable the call to overwrite_console().
2265c609719bSwdenk
22666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
2267c609719bSwdenk		Enable overwrite of previous console environment settings.
2268c609719bSwdenk
22696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
2270c609719bSwdenk		Begin and End addresses of the area used by the
2271c609719bSwdenk		simple memory test.
2272c609719bSwdenk
22736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST:
2274c609719bSwdenk		Enable an alternate, more extensive memory test.
2275c609719bSwdenk
22766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH:
22775f535fe1Swdenk		Scratch address used by the alternate memory test
22785f535fe1Swdenk		You only need to set this if address zero isn't writeable
22795f535fe1Swdenk
22806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
22816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
228214f73ca6SStefan Roese		this specified memory area will get subtracted from the top
228311ccc33fSMarcel Ziswiler		(end) of RAM and won't get "touched" at all by U-Boot. By
228414f73ca6SStefan Roese		fixing up gd->ram_size the Linux kernel should gets passed
228514f73ca6SStefan Roese		the now "corrected" memory size and won't touch it either.
228614f73ca6SStefan Roese		This should work for arch/ppc and arch/powerpc. Only Linux
22875e12e75dSStefan Roese		board ports in arch/powerpc with bootwrapper support that
228814f73ca6SStefan Roese		recalculate the memory size from the SDRAM controller setup
22895e12e75dSStefan Roese		will have to get fixed in Linux additionally.
229014f73ca6SStefan Roese
229114f73ca6SStefan Roese		This option can be used as a workaround for the 440EPx/GRx
229214f73ca6SStefan Roese		CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
229314f73ca6SStefan Roese		be touched.
229414f73ca6SStefan Roese
229514f73ca6SStefan Roese		WARNING: Please make sure that this value is a multiple of
229614f73ca6SStefan Roese		the Linux page size (normally 4k). If this is not the case,
229714f73ca6SStefan Roese		then the end address of the Linux memory will be located at a
229814f73ca6SStefan Roese		non page size aligned address and this could cause major
229914f73ca6SStefan Roese		problems.
230014f73ca6SStefan Roese
23016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TFTP_LOADADDR:
2302c609719bSwdenk		Default load address for network file downloads
2303c609719bSwdenk
23046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE:
2305c609719bSwdenk		Enable temporary baudrate change while serial download
2306c609719bSwdenk
23076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE:
2308c609719bSwdenk		Physical start address of SDRAM. _Must_ be 0 here.
2309c609719bSwdenk
23106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MBIO_BASE:
2311c609719bSwdenk		Physical start address of Motherboard I/O (if using a
2312c609719bSwdenk		Cogent motherboard)
2313c609719bSwdenk
23146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE:
2315c609719bSwdenk		Physical start address of Flash memory.
2316c609719bSwdenk
23176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE:
2318c609719bSwdenk		Physical start address of boot monitor code (set by
2319c609719bSwdenk		make config files to be same as the text base address
232014d0a02aSWolfgang Denk		(CONFIG_SYS_TEXT_BASE) used when linking) - same as
23216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FLASH_BASE when booting from flash.
2322c609719bSwdenk
23236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN:
23243b57fe0aSwdenk		Size of memory reserved for monitor code, used to
23253b57fe0aSwdenk		determine _at_compile_time_ (!) if the environment is
23263b57fe0aSwdenk		embedded within the U-Boot image, or in a separate
23273b57fe0aSwdenk		flash sector.
2328c609719bSwdenk
23296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN:
2330c609719bSwdenk		Size of DRAM reserved for malloc() use.
2331c609719bSwdenk
23326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN:
233315940c9aSStefan Roese		Normally compressed uImages are limited to an
233415940c9aSStefan Roese		uncompressed size of 8 MBytes. If this is not enough,
23356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		you can define CONFIG_SYS_BOOTM_LEN in your board config file
233615940c9aSStefan Roese		to adjust this setting to your needs.
2337c609719bSwdenk
23386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ:
2339c609719bSwdenk		Maximum size of memory mapped by the startup code of
2340c609719bSwdenk		the Linux kernel; all data that must be processed by
23417d721e34SBartlomiej Sieka		the Linux kernel (bd_info, boot arguments, FDT blob if
23427d721e34SBartlomiej Sieka		used) must be put below this limit, unless "bootm_low"
23437d721e34SBartlomiej Sieka		enviroment variable is defined and non-zero. In such case
23447d721e34SBartlomiej Sieka		all data for the Linux kernel must be between "bootm_low"
23456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.
2346c609719bSwdenk
2347fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_RAMDISK_HIGH:
2348fca43cc8SJohn Rigby		Enable initrd_high functionality.  If defined then the
2349fca43cc8SJohn Rigby		initrd_high feature is enabled and the bootm ramdisk subcommand
2350fca43cc8SJohn Rigby		is enabled.
2351fca43cc8SJohn Rigby
2352fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_CMDLINE:
2353fca43cc8SJohn Rigby		Enables allocating and saving kernel cmdline in space between
2354fca43cc8SJohn Rigby		"bootm_low" and "bootm_low" + BOOTMAPSZ.
2355fca43cc8SJohn Rigby
2356fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_KBD:
2357fca43cc8SJohn Rigby		Enables allocating and saving a kernel copy of the bd_info in
2358fca43cc8SJohn Rigby		space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
2359fca43cc8SJohn Rigby
23606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS:
2361c609719bSwdenk		Max number of Flash memory banks
2362c609719bSwdenk
23636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT:
2364c609719bSwdenk		Max number of sectors on a Flash chip
2365c609719bSwdenk
23666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT:
2367c609719bSwdenk		Timeout for Flash erase operations (in ms)
2368c609719bSwdenk
23696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT:
2370c609719bSwdenk		Timeout for Flash write operations (in ms)
2371c609719bSwdenk
23726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT
23738564acf9Swdenk		Timeout for Flash set sector lock bit operation (in ms)
23748564acf9Swdenk
23756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT
23768564acf9Swdenk		Timeout for Flash clear lock bits operation (in ms)
23778564acf9Swdenk
23786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION
23798564acf9Swdenk		If defined, hardware flash sectors protection is used
23808564acf9Swdenk		instead of U-Boot software protection.
23818564acf9Swdenk
23826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP:
2383c609719bSwdenk
2384c609719bSwdenk		Enable TFTP transfers directly to flash memory;
2385c609719bSwdenk		without this option such a download has to be
2386c609719bSwdenk		performed in two steps: (1) download to RAM, and (2)
2387c609719bSwdenk		copy from RAM to flash.
2388c609719bSwdenk
2389c609719bSwdenk		The two-step approach is usually more reliable, since
2390c609719bSwdenk		you can check if the download worked before you erase
239111ccc33fSMarcel Ziswiler		the flash, but in some situations (when system RAM is
239211ccc33fSMarcel Ziswiler		too limited to allow for a temporary copy of the
2393c609719bSwdenk		downloaded image) this option may be very useful.
2394c609719bSwdenk
23956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI:
2396c609719bSwdenk		Define if the flash driver uses extra elements in the
23975653fc33Swdenk		common flash structure for storing flash geometry.
23985653fc33Swdenk
239900b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER
24005653fc33Swdenk		This option also enables the building of the cfi_flash driver
24015653fc33Swdenk		in the drivers directory
240253cf9435Sstroese
240391809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD
240491809ed5SPiotr Ziecik		This option enables the building of the cfi_mtd driver
240591809ed5SPiotr Ziecik		in the drivers directory. The driver exports CFI flash
240691809ed5SPiotr Ziecik		to the MTD layer.
240791809ed5SPiotr Ziecik
24086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
240996ef831fSGuennadi Liakhovetski		Use buffered writes to flash.
241096ef831fSGuennadi Liakhovetski
241196ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N
241296ef831fSGuennadi Liakhovetski		s29ws-n MirrorBit flash has non-standard addresses for buffered
241396ef831fSGuennadi Liakhovetski		write commands.
241496ef831fSGuennadi Liakhovetski
24156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST
24165568e613SStefan Roese		If this option is defined, the common CFI flash doesn't
24175568e613SStefan Roese		print it's warning upon not recognized FLASH banks. This
24185568e613SStefan Roese		is useful, if some of the configured banks are only
24195568e613SStefan Roese		optionally available.
24205568e613SStefan Roese
24219a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS
24229a042e9cSJerry Van Baren		If defined (must be an integer), print out countdown
24239a042e9cSJerry Van Baren		digits and dots.  Recommended value: 45 (9..1) for 80
24249a042e9cSJerry Van Baren		column displays, 15 (3..1) for 40 column displays.
24259a042e9cSJerry Van Baren
24266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER:
242711ccc33fSMarcel Ziswiler		Defines the number of Ethernet receive buffers. On some
242811ccc33fSMarcel Ziswiler		Ethernet controllers it is recommended to set this value
242953cf9435Sstroese		to 8 or even higher (EEPRO100 or 405 EMAC), since all
243053cf9435Sstroese		buffers can be full shortly after enabling the interface
243111ccc33fSMarcel Ziswiler		on high Ethernet traffic.
243253cf9435Sstroese		Defaults to 4 if not defined.
2433c609719bSwdenk
2434ea882bafSWolfgang Denk- CONFIG_ENV_MAX_ENTRIES
2435ea882bafSWolfgang Denk
2436ea882bafSWolfgang Denk	Maximum number of entries in the hash table that is used
2437ea882bafSWolfgang Denk	internally to store the environment settings. The default
2438ea882bafSWolfgang Denk	setting is supposed to be generous and should work in most
2439ea882bafSWolfgang Denk	cases. This setting can be used to tune behaviour; see
2440ea882bafSWolfgang Denk	lib/hashtable.c for details.
2441ea882bafSWolfgang Denk
2442c609719bSwdenkThe following definitions that deal with the placement and management
2443c609719bSwdenkof environment data (variable area); in general, we support the
2444c609719bSwdenkfollowing configurations:
2445c609719bSwdenk
24465a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH:
2447c609719bSwdenk
2448c609719bSwdenk	Define this if the environment is in flash memory.
2449c609719bSwdenk
2450c609719bSwdenk	a) The environment occupies one whole flash sector, which is
2451c609719bSwdenk	   "embedded" in the text segment with the U-Boot code. This
2452c609719bSwdenk	   happens usually with "bottom boot sector" or "top boot
2453c609719bSwdenk	   sector" type flash chips, which have several smaller
2454c609719bSwdenk	   sectors at the start or the end. For instance, such a
2455c609719bSwdenk	   layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
2456c609719bSwdenk	   such a case you would place the environment in one of the
2457c609719bSwdenk	   4 kB sectors - with U-Boot code before and after it. With
2458c609719bSwdenk	   "top boot sector" type flash chips, you would put the
2459c609719bSwdenk	   environment in one of the last sectors, leaving a gap
2460c609719bSwdenk	   between U-Boot and the environment.
2461c609719bSwdenk
24620e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
2463c609719bSwdenk
2464c609719bSwdenk	   Offset of environment data (variable area) to the
2465c609719bSwdenk	   beginning of flash memory; for instance, with bottom boot
2466c609719bSwdenk	   type flash chips the second sector can be used: the offset
2467c609719bSwdenk	   for this sector is given here.
2468c609719bSwdenk
24696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
2470c609719bSwdenk
24710e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
2472c609719bSwdenk
2473c609719bSwdenk	   This is just another way to specify the start address of
2474c609719bSwdenk	   the flash sector containing the environment (instead of
24750e8d1586SJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET).
2476c609719bSwdenk
24770e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SECT_SIZE:
2478c609719bSwdenk
2479c609719bSwdenk	   Size of the sector containing the environment.
2480c609719bSwdenk
2481c609719bSwdenk
2482c609719bSwdenk	b) Sometimes flash chips have few, equal sized, BIG sectors.
2483c609719bSwdenk	   In such a case you don't want to spend a whole sector for
2484c609719bSwdenk	   the environment.
2485c609719bSwdenk
24860e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
2487c609719bSwdenk
24885a1aceb0SJean-Christophe PLAGNIOL-VILLARD	   If you use this in combination with CONFIG_ENV_IS_IN_FLASH
24890e8d1586SJean-Christophe PLAGNIOL-VILLARD	   and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
2490c609719bSwdenk	   of this flash sector for the environment. This saves
2491c609719bSwdenk	   memory for the RAM copy of the environment.
2492c609719bSwdenk
2493c609719bSwdenk	   It may also save flash memory if you decide to use this
2494c609719bSwdenk	   when your environment is "embedded" within U-Boot code,
2495c609719bSwdenk	   since then the remainder of the flash sector could be used
2496c609719bSwdenk	   for U-Boot code. It should be pointed out that this is
2497c609719bSwdenk	   STRONGLY DISCOURAGED from a robustness point of view:
2498c609719bSwdenk	   updating the environment in flash makes it always
2499c609719bSwdenk	   necessary to erase the WHOLE sector. If something goes
2500c609719bSwdenk	   wrong before the contents has been restored from a copy in
2501c609719bSwdenk	   RAM, your target system will be dead.
2502c609719bSwdenk
25030e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR_REDUND
25040e8d1586SJean-Christophe PLAGNIOL-VILLARD	  CONFIG_ENV_SIZE_REDUND
2505c609719bSwdenk
2506c609719bSwdenk	   These settings describe a second storage area used to hold
250711ccc33fSMarcel Ziswiler	   a redundant copy of the environment data, so that there is
25083e38691eSwdenk	   a valid backup copy in case there is a power failure during
2509c609719bSwdenk	   a "saveenv" operation.
2510c609719bSwdenk
2511c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the
2512c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds*
2513c609719bSwdenkaccordingly!
2514c609719bSwdenk
2515c609719bSwdenk
25169314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM:
2517c609719bSwdenk
2518c609719bSwdenk	Define this if you have some non-volatile memory device
2519c609719bSwdenk	(NVRAM, battery buffered SRAM) which you want to use for the
2520c609719bSwdenk	environment.
2521c609719bSwdenk
25220e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
25230e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
2524c609719bSwdenk
252511ccc33fSMarcel Ziswiler	  These two #defines are used to determine the memory area you
2526c609719bSwdenk	  want to use for environment. It is assumed that this memory
2527c609719bSwdenk	  can just be read and written to, without any special
2528c609719bSwdenk	  provision.
2529c609719bSwdenk
2530c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early
2531c609719bSwdenkin U-Boot initalization (when we try to get the setting of for the
253211ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or
2533c609719bSwdenkU-Boot will hang.
2534c609719bSwdenk
2535c609719bSwdenkPlease note that even with NVRAM we still use a copy of the
2536c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to
2537c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv"
2538c609719bSwdenkto save the current settings.
2539c609719bSwdenk
2540c609719bSwdenk
2541bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM:
2542c609719bSwdenk
2543c609719bSwdenk	Use this if you have an EEPROM or similar serial access
2544c609719bSwdenk	device and a driver for it.
2545c609719bSwdenk
25460e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
25470e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
2548c609719bSwdenk
2549c609719bSwdenk	  These two #defines specify the offset and size of the
2550c609719bSwdenk	  environment area within the total memory of your EEPROM.
2551c609719bSwdenk
25526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR:
2553c609719bSwdenk	  If defined, specified the chip address of the EEPROM device.
2554c609719bSwdenk	  The default address is zero.
2555c609719bSwdenk
25566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
2557c609719bSwdenk	  If defined, the number of bits used to address bytes in a
2558c609719bSwdenk	  single page in the EEPROM device.  A 64 byte page, for example
2559c609719bSwdenk	  would require six bits.
2560c609719bSwdenk
25616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
2562c609719bSwdenk	  If defined, the number of milliseconds to delay between
2563c609719bSwdenk	  page writes.	The default is zero milliseconds.
2564c609719bSwdenk
25656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
2566c609719bSwdenk	  The length in bytes of the EEPROM memory array address.  Note
2567c609719bSwdenk	  that this is NOT the chip address length!
2568c609719bSwdenk
25696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
25705cf91d6bSwdenk	  EEPROM chips that implement "address overflow" are ones
25715cf91d6bSwdenk	  like Catalyst 24WC04/08/16 which has 9/10/11 bits of
25725cf91d6bSwdenk	  address and the extra bits end up in the "chip address" bit
25735cf91d6bSwdenk	  slots. This makes a 24WC08 (1Kbyte) chip look like four 256
25745cf91d6bSwdenk	  byte chips.
25755cf91d6bSwdenk
25765cf91d6bSwdenk	  Note that we consider the length of the address field to
25775cf91d6bSwdenk	  still be one byte because the extra address bits are hidden
25785cf91d6bSwdenk	  in the chip address.
25795cf91d6bSwdenk
25806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_SIZE:
2581c609719bSwdenk	  The size in bytes of the EEPROM device.
2582c609719bSwdenk
2583548738b4SHeiko Schocher	- CONFIG_ENV_EEPROM_IS_ON_I2C
2584548738b4SHeiko Schocher	  define this, if you have I2C and SPI activated, and your
2585548738b4SHeiko Schocher	  EEPROM, which holds the environment, is on the I2C bus.
2586548738b4SHeiko Schocher
2587548738b4SHeiko Schocher	- CONFIG_I2C_ENV_EEPROM_BUS
2588548738b4SHeiko Schocher	  if you have an Environment on an EEPROM reached over
2589548738b4SHeiko Schocher	  I2C muxes, you can define here, how to reach this
2590548738b4SHeiko Schocher	  EEPROM. For example:
2591548738b4SHeiko Schocher
2592548738b4SHeiko Schocher	  #define CONFIG_I2C_ENV_EEPROM_BUS	  "pca9547:70:d\0"
2593548738b4SHeiko Schocher
2594548738b4SHeiko Schocher	  EEPROM which holds the environment, is reached over
2595548738b4SHeiko Schocher	  a pca9547 i2c mux with address 0x70, channel 3.
2596c609719bSwdenk
2597057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH:
25985779d8d9Swdenk
25995779d8d9Swdenk	Define this if you have a DataFlash memory device which you
26005779d8d9Swdenk	want to use for the environment.
26015779d8d9Swdenk
26020e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
26030e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
26040e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
26055779d8d9Swdenk
26065779d8d9Swdenk	  These three #defines specify the offset and size of the
26075779d8d9Swdenk	  environment area within the total memory of your DataFlash placed
26085779d8d9Swdenk	  at the specified address.
26095779d8d9Swdenk
261051bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND:
261113a5695bSwdenk
261213a5695bSwdenk	Define this if you have a NAND device which you want to use
261313a5695bSwdenk	for the environment.
261413a5695bSwdenk
26150e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
26160e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
261713a5695bSwdenk
261813a5695bSwdenk	  These two #defines specify the offset and size of the environment
2619fdd813deSScott Wood	  area within the first NAND device.  CONFIG_ENV_OFFSET must be
2620fdd813deSScott Wood	  aligned to an erase block boundary.
26215779d8d9Swdenk
2622fdd813deSScott Wood	- CONFIG_ENV_OFFSET_REDUND (optional):
2623e443c944SMarkus Klotzbuecher
26240e8d1586SJean-Christophe PLAGNIOL-VILLARD	  This setting describes a second storage area of CONFIG_ENV_SIZE
2625fdd813deSScott Wood	  size used to hold a redundant copy of the environment data, so
2626fdd813deSScott Wood	  that there is a valid backup copy in case there is a power failure
2627fdd813deSScott Wood	  during a "saveenv" operation.  CONFIG_ENV_OFFSET_RENDUND must be
2628fdd813deSScott Wood	  aligned to an erase block boundary.
2629e443c944SMarkus Klotzbuecher
2630fdd813deSScott Wood	- CONFIG_ENV_RANGE (optional):
2631fdd813deSScott Wood
2632fdd813deSScott Wood	  Specifies the length of the region in which the environment
2633fdd813deSScott Wood	  can be written.  This should be a multiple of the NAND device's
2634fdd813deSScott Wood	  block size.  Specifying a range with more erase blocks than
2635fdd813deSScott Wood	  are needed to hold CONFIG_ENV_SIZE allows bad blocks within
2636fdd813deSScott Wood	  the range to be avoided.
2637fdd813deSScott Wood
2638fdd813deSScott Wood	- CONFIG_ENV_OFFSET_OOB (optional):
2639fdd813deSScott Wood
2640fdd813deSScott Wood	  Enables support for dynamically retrieving the offset of the
2641fdd813deSScott Wood	  environment from block zero's out-of-band data.  The
2642fdd813deSScott Wood	  "nand env.oob" command can be used to record this offset.
2643fdd813deSScott Wood	  Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
2644fdd813deSScott Wood	  using CONFIG_ENV_OFFSET_OOB.
2645e443c944SMarkus Klotzbuecher
2646b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST
2647b74ab737SGuennadi Liakhovetski
2648b74ab737SGuennadi Liakhovetski	Defines address in RAM to which the nand_spl code should copy the
2649b74ab737SGuennadi Liakhovetski	environment. If redundant environment is used, it will be copied to
2650b74ab737SGuennadi Liakhovetski	CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
2651b74ab737SGuennadi Liakhovetski
26526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET
2653c609719bSwdenk
2654c609719bSwdenk	Defines offset to the initial SPI buffer area in DPRAM. The
2655c609719bSwdenk	area is used at an early stage (ROM part) if the environment
2656c609719bSwdenk	is configured to reside in the SPI EEPROM: We need a 520 byte
2657c609719bSwdenk	scratch DPRAM area. It is used between the two initialization
2658c609719bSwdenk	calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
2659c609719bSwdenk	to be a good choice since it makes it far enough from the
2660c609719bSwdenk	start of the data area as well as from the stack pointer.
2661c609719bSwdenk
2662e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor
2663c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been
2664cdb74977SWolfgang Denkcreated; also, when using EEPROM you will have to use getenv_f()
2665c609719bSwdenkuntil then to read environment variables.
2666c609719bSwdenk
266785ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor
266885ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working
266985ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is
267085ec0bccSwdenknecessary, because the first environment variable we need is the
267185ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't
267285ec0bccSwdenkhave any device yet where we could complain.]
2673c609719bSwdenk
2674c609719bSwdenkNote: once the monitor has been relocated, then it will complain if
2675c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you
267685ec0bccSwdenkuse the "saveenv" command to store a valid environment.
2677c609719bSwdenk
26786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
2679fc3e2165Swdenk		Echo the inverted Ethernet link state to the fault LED.
2680fc3e2165Swdenk
26816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
2682fc3e2165Swdenk		      also needs to be defined.
2683fc3e2165Swdenk
26846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR:
2685fc3e2165Swdenk		MII address of the PHY to check for the Ethernet link state.
2686c609719bSwdenk
2687f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS:
2688f5675aa5SRon Madrid		Define this if you desire to only have use of the NS16550_init
2689f5675aa5SRon Madrid		and NS16550_putc functions for the serial driver located at
2690f5675aa5SRon Madrid		drivers/serial/ns16550.c.  This option is useful for saving
2691f5675aa5SRon Madrid		space for already greatly restricted images, including but not
2692f5675aa5SRon Madrid		limited to NAND_SPL configurations.
2693f5675aa5SRon Madrid
2694c609719bSwdenkLow Level (hardware related) configuration options:
2695dc7c9a1aSwdenk---------------------------------------------------
2696c609719bSwdenk
26976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE:
2698c609719bSwdenk		Cache Line Size of the CPU.
2699c609719bSwdenk
27006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR:
2701c609719bSwdenk		Default address of the IMMR after system reset.
27022535d602Swdenk
27032535d602Swdenk		Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
27042535d602Swdenk		and RPXsuper) to be able to adjust the position of
27052535d602Swdenk		the IMMR register after a reset.
2706c609719bSwdenk
27077f6c2cbcSwdenk- Floppy Disk Support:
27086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER
27097f6c2cbcSwdenk
27107f6c2cbcSwdenk		the default drive number (default value 0)
27117f6c2cbcSwdenk
27126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_STRIDE
27137f6c2cbcSwdenk
271411ccc33fSMarcel Ziswiler		defines the spacing between FDC chipset registers
27157f6c2cbcSwdenk		(default value 1)
27167f6c2cbcSwdenk
27176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_OFFSET
27187f6c2cbcSwdenk
27197f6c2cbcSwdenk		defines the offset of register from address. It
27207f6c2cbcSwdenk		depends on which part of the data bus is connected to
272111ccc33fSMarcel Ziswiler		the FDC chipset. (default value 0)
27227f6c2cbcSwdenk
27236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
27246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
27257f6c2cbcSwdenk		default value.
27267f6c2cbcSwdenk
27276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		if CONFIG_SYS_FDC_HW_INIT is defined, then the function
27287f6c2cbcSwdenk		fdc_hw_init() is called at the beginning of the FDC
27297f6c2cbcSwdenk		setup. fdc_hw_init() must be provided by the board
27307f6c2cbcSwdenk		source code. It is used to make hardware dependant
27317f6c2cbcSwdenk		initializations.
27327f6c2cbcSwdenk
27336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR:	Physical address of the Internal Memory.
273425d6712aSwdenk		DO NOT CHANGE unless you know exactly what you're
273525d6712aSwdenk		doing! (11-4) [MPC8xx/82xx systems only]
2736c609719bSwdenk
27376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR:
2738c609719bSwdenk
27397152b1d0Swdenk		Start address of memory area that can be used for
2740c609719bSwdenk		initial data and stack; please note that this must be
2741c609719bSwdenk		writable memory that is working WITHOUT special
2742c609719bSwdenk		initialization, i. e. you CANNOT use normal RAM which
2743c609719bSwdenk		will become available only after programming the
2744c609719bSwdenk		memory controller and running certain initialization
2745c609719bSwdenk		sequences.
2746c609719bSwdenk
2747c609719bSwdenk		U-Boot uses the following memory types:
2748c609719bSwdenk		- MPC8xx and MPC8260: IMMR (internal memory of the CPU)
2749c609719bSwdenk		- MPC824X: data cache
2750c609719bSwdenk		- PPC4xx:  data cache
2751c609719bSwdenk
27526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET:
2753c609719bSwdenk
2754c609719bSwdenk		Offset of the initial data structure in the memory
27556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
27566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
2757c609719bSwdenk		data is located at the end of the available space
2758553f0982SWolfgang Denk		(sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
27596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
27606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
27616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET) downward.
2762c609719bSwdenk
2763c609719bSwdenk	Note:
2764c609719bSwdenk		On the MPC824X (or other systems that use the data
2765c609719bSwdenk		cache for initial memory) the address chosen for
27666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
2767c609719bSwdenk		point to an otherwise UNUSED address space between
2768c609719bSwdenk		the top of RAM and the start of the PCI space.
2769c609719bSwdenk
27706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR:	SIU Module Configuration (11-6)
2771c609719bSwdenk
27726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR:	System Protection Control (11-9)
2773c609719bSwdenk
27746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR:	Time Base Status and Control (11-26)
2775c609719bSwdenk
27766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR:	Periodic Interrupt Status and Control (11-31)
2777c609719bSwdenk
27786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR:	PLL, Low-Power, and Reset Control Register (15-30)
2779c609719bSwdenk
27806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR:	System Clock and reset Control Register (15-27)
2781c609719bSwdenk
27826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM:
2783c609719bSwdenk		SDRAM timing
2784c609719bSwdenk
27856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA:
2786c609719bSwdenk		periodic timer for refresh
2787c609719bSwdenk
27886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER:	Debug Event Register (37-47)
2789c609719bSwdenk
27906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
27916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
27926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
27936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_BR1_PRELIM:
2794c609719bSwdenk		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
2795c609719bSwdenk
2796c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
27976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
27986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
2799c609719bSwdenk		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
2800c609719bSwdenk
28016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
28026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
2803c609719bSwdenk		Machine Mode Register and Memory Periodic Timer
2804c609719bSwdenk		Prescaler definitions (SDRAM timing)
2805c609719bSwdenk
28066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
2807c609719bSwdenk		enable I2C microcode relocation patch (MPC8xx);
2808c609719bSwdenk		define relocation offset in DPRAM [DSP2]
2809c609719bSwdenk
28106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
2811b423d055SHeiko Schocher		enable SMC microcode relocation patch (MPC8xx);
2812b423d055SHeiko Schocher		define relocation offset in DPRAM [SMC1]
2813b423d055SHeiko Schocher
28146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
2815c609719bSwdenk		enable SPI microcode relocation patch (MPC8xx);
2816c609719bSwdenk		define relocation offset in DPRAM [SCC4]
2817c609719bSwdenk
28186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_USE_OSCCLK:
2819c609719bSwdenk		Use OSCM clock mode on MBX8xx board. Be careful,
2820c609719bSwdenk		wrong setting might damage your board. Read
2821c609719bSwdenk		doc/README.MBX before setting this variable!
2822c609719bSwdenk
28236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
2824ea909b76Swdenk		Offset of the bootmode word in DPRAM used by post
2825ea909b76Swdenk		(Power On Self Tests). This definition overrides
2826ea909b76Swdenk		#define'd default value in commproc.h resp.
2827ea909b76Swdenk		cpm_8260.h.
2828ea909b76Swdenk
28296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
28306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
28316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
28326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
28336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
28346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
28356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
28366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
2837a47a12beSStefan Roese		Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
28385d232d0eSwdenk
28399cacf4fcSDirk Eibach- CONFIG_PCI_DISABLE_PCIE:
28409cacf4fcSDirk Eibach		Disable PCI-Express on systems where it is supported but not
28419cacf4fcSDirk Eibach		required.
28429cacf4fcSDirk Eibach
2843a09b9b68SKumar Gala- CONFIG_SYS_SRIO:
2844a09b9b68SKumar Gala		Chip has SRIO or not
2845a09b9b68SKumar Gala
2846a09b9b68SKumar Gala- CONFIG_SRIO1:
2847a09b9b68SKumar Gala		Board has SRIO 1 port available
2848a09b9b68SKumar Gala
2849a09b9b68SKumar Gala- CONFIG_SRIO2:
2850a09b9b68SKumar Gala		Board has SRIO 2 port available
2851a09b9b68SKumar Gala
2852a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_VIRT:
2853a09b9b68SKumar Gala		Virtual Address of SRIO port 'n' memory region
2854a09b9b68SKumar Gala
2855a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_PHYS:
2856a09b9b68SKumar Gala		Physical Address of SRIO port 'n' memory region
2857a09b9b68SKumar Gala
2858a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_SIZE:
2859a09b9b68SKumar Gala		Size of SRIO port 'n' memory region
2860a09b9b68SKumar Gala
2861bb99ad6dSBen Warren- CONFIG_SPD_EEPROM
2862218ca724SWolfgang Denk		Get DDR timing information from an I2C EEPROM. Common
2863218ca724SWolfgang Denk		with pluggable memory modules such as SODIMMs
2864218ca724SWolfgang Denk
2865bb99ad6dSBen Warren  SPD_EEPROM_ADDRESS
2866bb99ad6dSBen Warren		I2C address of the SPD EEPROM
2867bb99ad6dSBen Warren
28686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM
2869218ca724SWolfgang Denk		If SPD EEPROM is on an I2C bus other than the first
2870218ca724SWolfgang Denk		one, specify here. Note that the value must resolve
2871218ca724SWolfgang Denk		to something your driver can deal with.
2872bb99ad6dSBen Warren
28736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0
2874218ca724SWolfgang Denk		Only for 83xx systems. If specified, then DDR should
2875218ca724SWolfgang Denk		be configured using CS0 and CS1 instead of CS2 and CS3.
28762ad6b513STimur Tabi
2877c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12]
2878c26e454dSwdenk		Define to enable FEC[12] on a 8xx series processor.
2879c26e454dSwdenk
2880c26e454dSwdenk- CONFIG_FEC[12]_PHY
2881c26e454dSwdenk		Define to the hardcoded PHY address which corresponds
28826e592385Swdenk		to the given FEC; i. e.
2883c26e454dSwdenk			#define CONFIG_FEC1_PHY 4
2884c26e454dSwdenk		means that the PHY with address 4 is connected to FEC1
2885c26e454dSwdenk
2886c26e454dSwdenk		When set to -1, means to probe for first available.
2887c26e454dSwdenk
2888c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR
2889c26e454dSwdenk		The PHY does not have a RXERR line (RMII only).
2890c26e454dSwdenk		(so program the FEC to ignore it).
2891c26e454dSwdenk
2892c26e454dSwdenk- CONFIG_RMII
2893c26e454dSwdenk		Enable RMII mode for all FECs.
2894c26e454dSwdenk		Note that this is a global option, we can't
2895c26e454dSwdenk		have one FEC in standard MII mode and another in RMII mode.
2896c26e454dSwdenk
28975cf91d6bSwdenk- CONFIG_CRC32_VERIFY
28985cf91d6bSwdenk		Add a verify option to the crc32 command.
28995cf91d6bSwdenk		The syntax is:
29005cf91d6bSwdenk
29015cf91d6bSwdenk		=> crc32 -v <address> <count> <crc32>
29025cf91d6bSwdenk
29035cf91d6bSwdenk		Where address/count indicate a memory area
29045cf91d6bSwdenk		and crc32 is the correct crc32 which the
29055cf91d6bSwdenk		area should have.
29065cf91d6bSwdenk
290756523f12Swdenk- CONFIG_LOOPW
290856523f12Swdenk		Add the "loopw" memory command. This only takes effect if
2909602ad3b3SJon Loeliger		the memory commands are activated globally (CONFIG_CMD_MEM).
291056523f12Swdenk
29117b466641Sstroese- CONFIG_MX_CYCLIC
29127b466641Sstroese		Add the "mdc" and "mwc" memory commands. These are cyclic
29137b466641Sstroese		"md/mw" commands.
29147b466641Sstroese		Examples:
29157b466641Sstroese
29167b466641Sstroese		=> mdc.b 10 4 500
29177b466641Sstroese		This command will print 4 bytes (10,11,12,13) each 500 ms.
29187b466641Sstroese
29197b466641Sstroese		=> mwc.l 100 12345678 10
29207b466641Sstroese		This command will write 12345678 to address 100 all 10 ms.
29217b466641Sstroese
29227b466641Sstroese		This only takes effect if the memory commands are activated
2923602ad3b3SJon Loeliger		globally (CONFIG_CMD_MEM).
29247b466641Sstroese
29258aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT
2926e03f3169SWolfgang Denk		[ARM only] If this variable is defined, then certain
2927e03f3169SWolfgang Denk		low level initializations (like setting up the memory
2928e03f3169SWolfgang Denk		controller) are omitted and/or U-Boot does not
2929e03f3169SWolfgang Denk		relocate itself into RAM.
29308aa1a2d1Swdenk
2931e03f3169SWolfgang Denk		Normally this variable MUST NOT be defined. The only
2932e03f3169SWolfgang Denk		exception is when U-Boot is loaded (to RAM) by some
2933e03f3169SWolfgang Denk		other boot loader or by a debugger which performs
2934e03f3169SWolfgang Denk		these initializations itself.
29358aa1a2d1Swdenk
2936df81238bSMagnus Lilja- CONFIG_PRELOADER
2937df81238bSMagnus Lilja		Modifies the behaviour of start.S when compiling a loader
2938df81238bSMagnus Lilja		that is executed before the actual U-Boot. E.g. when
2939df81238bSMagnus Lilja		compiling a NAND SPL.
2940400558b5Swdenk
2941c609719bSwdenkBuilding the Software:
2942c609719bSwdenk======================
2943c609719bSwdenk
2944218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments
2945218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support
2946218ca724SWolfgang Denkall possibly existing versions of cross development tools in all
2947218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we
2948218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
2949218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot.
2950c609719bSwdenk
2951218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you
2952218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case,
2953218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell.
2954218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are
2955218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter:
2956c609719bSwdenk
2957218ca724SWolfgang Denk	$ CROSS_COMPILE=ppc_4xx-
2958218ca724SWolfgang Denk	$ export CROSS_COMPILE
2959c609719bSwdenk
29602f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in
29612f8d396bSPeter Tyser      the tools directory you can use the MinGW toolchain
29622f8d396bSPeter Tyser      (http://www.mingw.org).  Set your HOST tools to the MinGW
29632f8d396bSPeter Tyser      toolchain and execute 'make tools'.  For example:
29642f8d396bSPeter Tyser
29652f8d396bSPeter Tyser       $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
29662f8d396bSPeter Tyser
29672f8d396bSPeter Tyser      Binaries such as tools/mkimage.exe will be created which can
29682f8d396bSPeter Tyser      be executed on computers running Windows.
29692f8d396bSPeter Tyser
2970c609719bSwdenkU-Boot is intended to be simple to build. After installing the
2971c609719bSwdenksources you must configure U-Boot for one specific board type. This
2972c609719bSwdenkis done by typing:
2973c609719bSwdenk
2974c609719bSwdenk	make NAME_config
2975c609719bSwdenk
2976218ca724SWolfgang Denkwhere "NAME_config" is the name of one of the existing configu-
2977218ca724SWolfgang Denkrations; see the main Makefile for supported names.
297854387ac9Swdenk
2979c609719bSwdenkNote: for some board special configuration names may exist; check if
2980c609719bSwdenk      additional information is available from the board vendor; for
29812729af9dSwdenk      instance, the TQM823L systems are available without (standard)
29822729af9dSwdenk      or with LCD support. You can select such additional "features"
298311ccc33fSMarcel Ziswiler      when choosing the configuration, i. e.
2984c609719bSwdenk
29852729af9dSwdenk      make TQM823L_config
29862729af9dSwdenk	- will configure for a plain TQM823L, i. e. no LCD support
2987c609719bSwdenk
2988c609719bSwdenk      make TQM823L_LCD_config
2989c609719bSwdenk	- will configure for a TQM823L with U-Boot console on LCD
2990c609719bSwdenk
2991c609719bSwdenk      etc.
2992c609719bSwdenk
2993c609719bSwdenk
2994c609719bSwdenkFinally, type "make all", and you should get some working U-Boot
29957152b1d0Swdenkimages ready for download to / installation on your system:
2996c609719bSwdenk
2997c609719bSwdenk- "u-boot.bin" is a raw binary image
2998c609719bSwdenk- "u-boot" is an image in ELF binary format
2999c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format
3000c609719bSwdenk
3001baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved
3002baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change
3003baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory:
3004baf31249SMarian Balakowicz
3005baf31249SMarian Balakowicz1. Add O= to the make command line invocations:
3006baf31249SMarian Balakowicz
3007baf31249SMarian Balakowicz	make O=/tmp/build distclean
3008baf31249SMarian Balakowicz	make O=/tmp/build NAME_config
3009baf31249SMarian Balakowicz	make O=/tmp/build all
3010baf31249SMarian Balakowicz
3011baf31249SMarian Balakowicz2. Set environment variable BUILD_DIR to point to the desired location:
3012baf31249SMarian Balakowicz
3013baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
3014baf31249SMarian Balakowicz	make distclean
3015baf31249SMarian Balakowicz	make NAME_config
3016baf31249SMarian Balakowicz	make all
3017baf31249SMarian Balakowicz
3018baf31249SMarian BalakowiczNote that the command line "O=" setting overrides the BUILD_DIR environment
3019baf31249SMarian Balakowiczvariable.
3020baf31249SMarian Balakowicz
3021c609719bSwdenk
3022c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so
3023c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of
3024c609719bSwdenknative "make".
3025c609719bSwdenk
3026c609719bSwdenk
3027c609719bSwdenkIf the system board that you have is not listed, then you will need
3028c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these
3029c609719bSwdenksteps:
3030c609719bSwdenk
3031c609719bSwdenk1.  Add a new configuration option for your board to the toplevel
303285ec0bccSwdenk    "Makefile" and to the "MAKEALL" script, using the existing
303385ec0bccSwdenk    entries as examples. Note that here and at many other places
30347152b1d0Swdenk    boards and other names are listed in alphabetical sort order. Please
303585ec0bccSwdenk    keep this order.
3036c609719bSwdenk2.  Create a new directory to hold your board specific code. Add any
303785ec0bccSwdenk    files you need. In your board directory, you will need at least
303885ec0bccSwdenk    the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
303985ec0bccSwdenk3.  Create a new configuration file "include/configs/<board>.h" for
304085ec0bccSwdenk    your board
3041c609719bSwdenk3.  If you're porting U-Boot to a new CPU, then also create a new
3042c609719bSwdenk    directory to hold your CPU specific code. Add any files you need.
304385ec0bccSwdenk4.  Run "make <board>_config" with your new name.
3044c609719bSwdenk5.  Type "make", and you should get a working "u-boot.srec" file
3045c609719bSwdenk    to be installed on your target system.
304685ec0bccSwdenk6.  Debug and solve any problems that might arise.
3047c609719bSwdenk    [Of course, this last step is much harder than it sounds.]
3048c609719bSwdenk
3049c609719bSwdenk
3050c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.:
3051c609719bSwdenk==============================================================
3052c609719bSwdenk
3053c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board
3054c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to
3055c609719bSwdenkprovide feedback to the other developers. The feedback normally takes
3056c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest
3057218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources.
3058c609719bSwdenk
3059c609719bSwdenkBut before you submit such a patch, please verify that your modifi-
3060c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of
3061c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so,
3062c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot
3063c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You can
30647152b1d0Swdenkselect which (cross) compiler to use by passing a `CROSS_COMPILE'
3065218ca724SWolfgang Denkenvironment variable to the script, i. e. to use the ELDK cross tools
3066218ca724SWolfgang Denkyou can type
3067c609719bSwdenk
3068c609719bSwdenk	CROSS_COMPILE=ppc_8xx- MAKEALL
3069c609719bSwdenk
3070c609719bSwdenkor to build on a native PowerPC system you can type
3071c609719bSwdenk
3072c609719bSwdenk	CROSS_COMPILE=' ' MAKEALL
3073c609719bSwdenk
3074218ca724SWolfgang DenkWhen using the MAKEALL script, the default behaviour is to build
3075218ca724SWolfgang DenkU-Boot in the source directory. This location can be changed by
3076218ca724SWolfgang Denksetting the BUILD_DIR environment variable. Also, for each target
3077218ca724SWolfgang Denkbuilt, the MAKEALL script saves two log files (<target>.ERR and
3078218ca724SWolfgang Denk<target>.MAKEALL) in the <source dir>/LOG directory. This default
3079218ca724SWolfgang Denklocation can be changed by setting the MAKEALL_LOGDIR environment
3080218ca724SWolfgang Denkvariable. For example:
3081baf31249SMarian Balakowicz
3082baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
3083baf31249SMarian Balakowicz	export MAKEALL_LOGDIR=/tmp/log
3084baf31249SMarian Balakowicz	CROSS_COMPILE=ppc_8xx- MAKEALL
3085baf31249SMarian Balakowicz
3086218ca724SWolfgang DenkWith the above settings build objects are saved in the /tmp/build,
3087218ca724SWolfgang Denklog files are saved in the /tmp/log and the source tree remains clean
3088218ca724SWolfgang Denkduring the whole build process.
3089baf31249SMarian Balakowicz
3090baf31249SMarian Balakowicz
3091c609719bSwdenkSee also "U-Boot Porting Guide" below.
3092c609719bSwdenk
3093c609719bSwdenk
3094c609719bSwdenkMonitor Commands - Overview:
3095c609719bSwdenk============================
3096c609719bSwdenk
3097c609719bSwdenkgo	- start application at address 'addr'
3098c609719bSwdenkrun	- run commands in an environment variable
3099c609719bSwdenkbootm	- boot application image from memory
3100c609719bSwdenkbootp	- boot image via network using BootP/TFTP protocol
3101c609719bSwdenktftpboot- boot image via network using TFTP protocol
3102c609719bSwdenk	       and env variables "ipaddr" and "serverip"
3103c609719bSwdenk	       (and eventually "gatewayip")
3104c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol
3105c609719bSwdenkdiskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
3106c609719bSwdenkloads	- load S-Record file over serial line
3107c609719bSwdenkloadb	- load binary file over serial line (kermit mode)
3108c609719bSwdenkmd	- memory display
3109c609719bSwdenkmm	- memory modify (auto-incrementing)
3110c609719bSwdenknm	- memory modify (constant address)
3111c609719bSwdenkmw	- memory write (fill)
3112c609719bSwdenkcp	- memory copy
3113c609719bSwdenkcmp	- memory compare
3114c609719bSwdenkcrc32	- checksum calculation
31150f89c54bSPeter Tyseri2c	- I2C sub-system
3116c609719bSwdenksspi	- SPI utility commands
3117c609719bSwdenkbase	- print or set address offset
3118c609719bSwdenkprintenv- print environment variables
3119c609719bSwdenksetenv	- set environment variables
3120c609719bSwdenksaveenv - save environment variables to persistent storage
3121c609719bSwdenkprotect - enable or disable FLASH write protection
3122c609719bSwdenkerase	- erase FLASH memory
3123c609719bSwdenkflinfo	- print FLASH memory information
3124c609719bSwdenkbdinfo	- print Board Info structure
3125c609719bSwdenkiminfo	- print header information for application image
3126c609719bSwdenkconinfo - print console devices and informations
3127c609719bSwdenkide	- IDE sub-system
3128c609719bSwdenkloop	- infinite loop on address range
312956523f12Swdenkloopw	- infinite write loop on address range
3130c609719bSwdenkmtest	- simple RAM test
3131c609719bSwdenkicache	- enable or disable instruction cache
3132c609719bSwdenkdcache	- enable or disable data cache
3133c609719bSwdenkreset	- Perform RESET of the CPU
3134c609719bSwdenkecho	- echo args to console
3135c609719bSwdenkversion - print monitor version
3136c609719bSwdenkhelp	- print online help
3137c609719bSwdenk?	- alias for 'help'
3138c609719bSwdenk
3139c609719bSwdenk
3140c609719bSwdenkMonitor Commands - Detailed Description:
3141c609719bSwdenk========================================
3142c609719bSwdenk
3143c609719bSwdenkTODO.
3144c609719bSwdenk
3145c609719bSwdenkFor now: just type "help <command>".
3146c609719bSwdenk
3147c609719bSwdenk
3148c609719bSwdenkEnvironment Variables:
3149c609719bSwdenk======================
3150c609719bSwdenk
3151c609719bSwdenkU-Boot supports user configuration using Environment Variables which
3152c609719bSwdenkcan be made persistent by saving to Flash memory.
3153c609719bSwdenk
3154c609719bSwdenkEnvironment Variables are set using "setenv", printed using
3155c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv"
3156c609719bSwdenkwithout a value can be used to delete a variable from the
3157c609719bSwdenkenvironment. As long as you don't save the environment you are
3158c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the
3159c609719bSwdenkenvironment is erased by accident, a default environment is provided.
3160c609719bSwdenk
3161c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables.
3162c96f86eeSWolfgang Denk
3163c96f86eeSWolfgang DenkList of environment variables (most likely not complete):
3164c609719bSwdenk
3165c609719bSwdenk  baudrate	- see CONFIG_BAUDRATE
3166c609719bSwdenk
3167c609719bSwdenk  bootdelay	- see CONFIG_BOOTDELAY
3168c609719bSwdenk
3169c609719bSwdenk  bootcmd	- see CONFIG_BOOTCOMMAND
3170c609719bSwdenk
3171c609719bSwdenk  bootargs	- Boot arguments when booting an RTOS image
3172c609719bSwdenk
3173c609719bSwdenk  bootfile	- Name of the image to load with TFTP
3174c609719bSwdenk
31757d721e34SBartlomiej Sieka  bootm_low	- Memory range available for image processing in the bootm
31767d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
31777d721e34SBartlomiej Sieka		  a hexadecimal number and defines lowest address allowed
31787d721e34SBartlomiej Sieka		  for use by the bootm command. See also "bootm_size"
31797d721e34SBartlomiej Sieka		  environment variable. Address defined by "bootm_low" is
31807d721e34SBartlomiej Sieka		  also the base of the initial memory mapping for the Linux
31816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		  kernel -- see the description of CONFIG_SYS_BOOTMAPSZ.
31827d721e34SBartlomiej Sieka
31837d721e34SBartlomiej Sieka  bootm_size	- Memory range available for image processing in the bootm
31847d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
31857d721e34SBartlomiej Sieka		  a hexadecimal number and defines the size of the region
31867d721e34SBartlomiej Sieka		  allowed for use by the bootm command. See also "bootm_low"
31877d721e34SBartlomiej Sieka		  environment variable.
31887d721e34SBartlomiej Sieka
31894bae9090SBartlomiej Sieka  updatefile	- Location of the software update file on a TFTP server, used
31904bae9090SBartlomiej Sieka		  by the automatic software update feature. Please refer to
31914bae9090SBartlomiej Sieka		  documentation in doc/README.update for more details.
31924bae9090SBartlomiej Sieka
3193c609719bSwdenk  autoload	- if set to "no" (any string beginning with 'n'),
3194c609719bSwdenk		  "bootp" will just load perform a lookup of the
3195c609719bSwdenk		  configuration from the BOOTP server, but not try to
3196c609719bSwdenk		  load any image using TFTP
3197c609719bSwdenk
3198c609719bSwdenk  autostart	- if set to "yes", an image loaded using the "bootp",
3199c609719bSwdenk		  "rarpboot", "tftpboot" or "diskboot" commands will
3200c609719bSwdenk		  be automatically started (by internally calling
3201c609719bSwdenk		  "bootm")
3202c609719bSwdenk
32034a6fd34bSwdenk		  If set to "no", a standalone image passed to the
32044a6fd34bSwdenk		  "bootm" command will be copied to the load address
32054a6fd34bSwdenk		  (and eventually uncompressed), but NOT be started.
32064a6fd34bSwdenk		  This can be used to load and uncompress arbitrary
32074a6fd34bSwdenk		  data.
32084a6fd34bSwdenk
320917ea1177Swdenk  i2cfast	- (PPC405GP|PPC405EP only)
321017ea1177Swdenk		  if set to 'y' configures Linux I2C driver for fast
321117ea1177Swdenk		  mode (400kHZ). This environment variable is used in
321217ea1177Swdenk		  initialization code. So, for changes to be effective
321317ea1177Swdenk		  it must be saved and board must be reset.
321417ea1177Swdenk
3215c609719bSwdenk  initrd_high	- restrict positioning of initrd images:
3216c609719bSwdenk		  If this variable is not set, initrd images will be
3217c609719bSwdenk		  copied to the highest possible address in RAM; this
3218c609719bSwdenk		  is usually what you want since it allows for
3219c609719bSwdenk		  maximum initrd size. If for some reason you want to
3220c609719bSwdenk		  make sure that the initrd image is loaded below the
32216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		  CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
3222c609719bSwdenk		  variable to a value of "no" or "off" or "0".
3223c609719bSwdenk		  Alternatively, you can set it to a maximum upper
3224c609719bSwdenk		  address to use (U-Boot will still check that it
3225c609719bSwdenk		  does not overwrite the U-Boot stack and data).
3226c609719bSwdenk
3227c609719bSwdenk		  For instance, when you have a system with 16 MB
32287152b1d0Swdenk		  RAM, and want to reserve 4 MB from use by Linux,
3229c609719bSwdenk		  you can do this by adding "mem=12M" to the value of
3230c609719bSwdenk		  the "bootargs" variable. However, now you must make
32317152b1d0Swdenk		  sure that the initrd image is placed in the first
3232c609719bSwdenk		  12 MB as well - this can be done with
3233c609719bSwdenk
3234c609719bSwdenk		  setenv initrd_high 00c00000
3235c609719bSwdenk
323638b99261Swdenk		  If you set initrd_high to 0xFFFFFFFF, this is an
323738b99261Swdenk		  indication to U-Boot that all addresses are legal
323838b99261Swdenk		  for the Linux kernel, including addresses in flash
323938b99261Swdenk		  memory. In this case U-Boot will NOT COPY the
324038b99261Swdenk		  ramdisk at all. This may be useful to reduce the
324138b99261Swdenk		  boot time on your system, but requires that this
324238b99261Swdenk		  feature is supported by your Linux kernel.
324338b99261Swdenk
3244c609719bSwdenk  ipaddr	- IP address; needed for tftpboot command
3245c609719bSwdenk
3246c609719bSwdenk  loadaddr	- Default load address for commands like "bootp",
3247dc7c9a1aSwdenk		  "rarpboot", "tftpboot", "loadb" or "diskboot"
3248c609719bSwdenk
3249c609719bSwdenk  loads_echo	- see CONFIG_LOADS_ECHO
3250c609719bSwdenk
3251c609719bSwdenk  serverip	- TFTP server IP address; needed for tftpboot command
3252c609719bSwdenk
3253c609719bSwdenk  bootretry	- see CONFIG_BOOT_RETRY_TIME
3254c609719bSwdenk
3255c609719bSwdenk  bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
3256c609719bSwdenk
3257c609719bSwdenk  bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
3258c609719bSwdenk
3259a3d991bdSwdenk  ethprime	- When CONFIG_NET_MULTI is enabled controls which
3260a3d991bdSwdenk		  interface is used first.
3261a3d991bdSwdenk
3262a3d991bdSwdenk  ethact	- When CONFIG_NET_MULTI is enabled controls which
3263a3d991bdSwdenk		  interface is currently active. For example you
3264a3d991bdSwdenk		  can do the following
3265a3d991bdSwdenk
326648690d80SHeiko Schocher		  => setenv ethact FEC
326748690d80SHeiko Schocher		  => ping 192.168.0.1 # traffic sent on FEC
326848690d80SHeiko Schocher		  => setenv ethact SCC
326948690d80SHeiko Schocher		  => ping 10.0.0.1 # traffic sent on SCC
3270a3d991bdSwdenk
3271e1692577SMatthias Fuchs  ethrotate	- When set to "no" U-Boot does not go through all
3272e1692577SMatthias Fuchs		  available network interfaces.
3273e1692577SMatthias Fuchs		  It just stays at the currently selected interface.
3274e1692577SMatthias Fuchs
3275a3d991bdSwdenk  netretry	- When set to "no" each network operation will
3276a3d991bdSwdenk		  either succeed or fail without retrying.
32776e592385Swdenk		  When set to "once" the network operation will
32786e592385Swdenk		  fail when all the available network interfaces
32796e592385Swdenk		  are tried once without success.
3280a3d991bdSwdenk		  Useful on scripts which control the retry operation
3281a3d991bdSwdenk		  themselves.
3282a3d991bdSwdenk
3283b4e2f89dSJean-Christophe PLAGNIOL-VILLARD  npe_ucode	- set load address for the NPE microcode
3284a1cf027aSJean-Christophe PLAGNIOL-VILLARD
328528cb9375SWolfgang Denk  tftpsrcport	- If this is set, the value is used for TFTP's
3286ecb0ccd9SWolfgang Denk		  UDP source port.
3287ecb0ccd9SWolfgang Denk
328828cb9375SWolfgang Denk  tftpdstport	- If this is set, the value is used for TFTP's UDP
328928cb9375SWolfgang Denk		  destination port instead of the Well Know Port 69.
329028cb9375SWolfgang Denk
3291c96f86eeSWolfgang Denk  tftpblocksize - Block size to use for TFTP transfers; if not set,
3292c96f86eeSWolfgang Denk		  we use the TFTP server's default block size
3293c96f86eeSWolfgang Denk
3294c96f86eeSWolfgang Denk  tftptimeout	- Retransmission timeout for TFTP packets (in milli-
3295c96f86eeSWolfgang Denk		  seconds, minimum value is 1000 = 1 second). Defines
3296c96f86eeSWolfgang Denk		  when a packet is considered to be lost so it has to
3297c96f86eeSWolfgang Denk		  be retransmitted. The default is 5000 = 5 seconds.
3298c96f86eeSWolfgang Denk		  Lowering this value may make downloads succeed
3299c96f86eeSWolfgang Denk		  faster in networks with high packet loss rates or
3300c96f86eeSWolfgang Denk		  with unreliable TFTP servers.
3301c96f86eeSWolfgang Denk
3302a3d991bdSwdenk  vlan		- When set to a value < 4095 the traffic over
330311ccc33fSMarcel Ziswiler		  Ethernet is encapsulated/received over 802.1q
3304a3d991bdSwdenk		  VLAN tagged frames.
3305c609719bSwdenk
3306c609719bSwdenkThe following environment variables may be used and automatically
3307c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"),
3308c609719bSwdenkdepending the information provided by your boot server:
3309c609719bSwdenk
3310c609719bSwdenk  bootfile	- see above
3311c609719bSwdenk  dnsip		- IP address of your Domain Name Server
3312fe389a82Sstroese  dnsip2	- IP address of your secondary Domain Name Server
3313c609719bSwdenk  gatewayip	- IP address of the Gateway (Router) to use
3314c609719bSwdenk  hostname	- Target hostname
3315c609719bSwdenk  ipaddr	- see above
3316c609719bSwdenk  netmask	- Subnet Mask
3317c609719bSwdenk  rootpath	- Pathname of the root filesystem on the NFS server
3318c609719bSwdenk  serverip	- see above
3319c609719bSwdenk
3320c609719bSwdenk
3321c609719bSwdenkThere are two special Environment Variables:
3322c609719bSwdenk
3323c609719bSwdenk  serial#	- contains hardware identification information such
3324c609719bSwdenk		  as type string and/or serial number
3325c609719bSwdenk  ethaddr	- Ethernet address
3326c609719bSwdenk
3327c609719bSwdenkThese variables can be set only once (usually during manufacturing of
3328c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables
3329c609719bSwdenkonce they have been set once.
3330c609719bSwdenk
3331c609719bSwdenk
3332c1551ea8SstroeseFurther special Environment Variables:
3333c1551ea8Sstroese
3334c1551ea8Sstroese  ver		- Contains the U-Boot version string as printed
3335c1551ea8Sstroese		  with the "version" command. This variable is
3336c1551ea8Sstroese		  readonly (see CONFIG_VERSION_VARIABLE).
3337c1551ea8Sstroese
3338c1551ea8Sstroese
3339c609719bSwdenkPlease note that changes to some configuration parameters may take
3340c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-).
3341c609719bSwdenk
3342c609719bSwdenk
3343f07771ccSwdenkCommand Line Parsing:
3344f07771ccSwdenk=====================
3345f07771ccSwdenk
3346f07771ccSwdenkThere are two different command line parsers available with U-Boot:
33477152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell:
3348f07771ccSwdenk
3349f07771ccSwdenkOld, simple command line parser:
3350f07771ccSwdenk--------------------------------
3351f07771ccSwdenk
3352f07771ccSwdenk- supports environment variables (through setenv / saveenv commands)
3353f07771ccSwdenk- several commands on one line, separated by ';'
3354fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax
3355f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\',
3356f07771ccSwdenk  for example:
3357fe126d8bSWolfgang Denk	setenv bootcmd bootm \${address}
3358f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example:
3359f07771ccSwdenk	setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
3360f07771ccSwdenk
3361f07771ccSwdenkHush shell:
3362f07771ccSwdenk-----------
3363f07771ccSwdenk
3364f07771ccSwdenk- similar to Bourne shell, with control structures like
3365f07771ccSwdenk  if...then...else...fi, for...do...done; while...do...done,
3366f07771ccSwdenk  until...do...done, ...
3367f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv
3368f07771ccSwdenk  commands) and local shell variables (through standard shell syntax
3369f07771ccSwdenk  "name=value"); only environment variables can be used with "run"
3370f07771ccSwdenk  command
3371f07771ccSwdenk
3372f07771ccSwdenkGeneral rules:
3373f07771ccSwdenk--------------
3374f07771ccSwdenk
3375f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run"
3376f07771ccSwdenk    command) contains several commands separated by semicolon, and
3377f07771ccSwdenk    one of these commands fails, then the remaining commands will be
3378f07771ccSwdenk    executed anyway.
3379f07771ccSwdenk
3380f07771ccSwdenk(2) If you execute several variables with one call to run (i. e.
338111ccc33fSMarcel Ziswiler    calling run with a list of variables as arguments), any failing
3382f07771ccSwdenk    command will cause "run" to terminate, i. e. the remaining
3383f07771ccSwdenk    variables are not executed.
3384f07771ccSwdenk
3385c609719bSwdenkNote for Redundant Ethernet Interfaces:
3386c609719bSwdenk=======================================
3387c609719bSwdenk
338811ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports
3389c609719bSwdenksuch configurations and is capable of automatic selection of a
33907152b1d0Swdenk"working" interface when needed. MAC assignment works as follows:
3391c609719bSwdenk
3392c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding
3393c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0),
3394c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ...
3395c609719bSwdenk
3396c609719bSwdenkIf the network interface stores some valid MAC address (for instance
3397c609719bSwdenkin SROM), this is used as default address if there is NO correspon-
3398c609719bSwdenkding setting in the environment; if the corresponding environment
3399c609719bSwdenkvariable is set, this overrides the settings in the card; that means:
3400c609719bSwdenk
3401c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the
3402c609719bSwdenk  environment, the SROM's address is used.
3403c609719bSwdenk
3404c609719bSwdenko If there is no valid address in the SROM, and a definition in the
3405c609719bSwdenk  environment exists, then the value from the environment variable is
3406c609719bSwdenk  used.
3407c609719bSwdenk
3408c609719bSwdenko If both the SROM and the environment contain a MAC address, and
3409c609719bSwdenk  both addresses are the same, this MAC address is used.
3410c609719bSwdenk
3411c609719bSwdenko If both the SROM and the environment contain a MAC address, and the
3412c609719bSwdenk  addresses differ, the value from the environment is used and a
3413c609719bSwdenk  warning is printed.
3414c609719bSwdenk
3415c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error
3416c609719bSwdenk  is raised.
3417c609719bSwdenk
3418ecee9324SBen WarrenIf Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
3419ecee9324SBen Warrenwill be programmed into hardware as part of the initialization process.  This
3420ecee9324SBen Warrenmay be skipped by setting the appropriate 'ethmacskip' environment variable.
3421ecee9324SBen WarrenThe naming convention is as follows:
3422ecee9324SBen Warren"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
3423c609719bSwdenk
3424c609719bSwdenkImage Formats:
3425c609719bSwdenk==============
3426c609719bSwdenk
34273310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on)
34283310c549SMarian Balakowiczimages in two formats:
34293310c549SMarian Balakowicz
34303310c549SMarian BalakowiczNew uImage format (FIT)
34313310c549SMarian Balakowicz-----------------------
34323310c549SMarian Balakowicz
34333310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar
34343310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple
34353310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by
34363310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
34373310c549SMarian Balakowicz
34383310c549SMarian Balakowicz
34393310c549SMarian BalakowiczOld uImage format
34403310c549SMarian Balakowicz-----------------
34413310c549SMarian Balakowicz
34423310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything,
34433310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for
34443310c549SMarian Balakowiczdetails; basically, the header defines the following image properties:
3445c609719bSwdenk
3446c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
3447c609719bSwdenk  4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
3448f5ed9e39SPeter Tyser  LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
3449f5ed9e39SPeter Tyser  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
3450f5ed9e39SPeter Tyser  INTEGRITY).
34517b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
34521117cbf2SThomas Chou  IA64, MIPS, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
34531117cbf2SThomas Chou  Currently supported: ARM, AVR32, Intel x86, MIPS, Nios II, PowerPC).
3454c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2)
3455c609719bSwdenk* Load Address
3456c609719bSwdenk* Entry Point
3457c609719bSwdenk* Image Name
3458c609719bSwdenk* Image Timestamp
3459c609719bSwdenk
3460c609719bSwdenkThe header is marked by a special Magic Number, and both the header
3461c609719bSwdenkand the data portions of the image are secured against corruption by
3462c609719bSwdenkCRC32 checksums.
3463c609719bSwdenk
3464c609719bSwdenk
3465c609719bSwdenkLinux Support:
3466c609719bSwdenk==============
3467c609719bSwdenk
3468c609719bSwdenkAlthough U-Boot should support any OS or standalone application
34697152b1d0Swdenkeasily, the main focus has always been on Linux during the design of
3470c609719bSwdenkU-Boot.
3471c609719bSwdenk
3472c609719bSwdenkU-Boot includes many features that so far have been part of some
3473c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any
3474c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image;
3475c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation
34767152b1d0Swdenkserves several purposes:
3477c609719bSwdenk
3478c609719bSwdenk- the same features can be used for other OS or standalone
3479c609719bSwdenk  applications (for instance: using compressed images to reduce the
3480c609719bSwdenk  Flash memory footprint)
3481c609719bSwdenk
3482c609719bSwdenk- it becomes much easier to port new Linux kernel versions because
34837152b1d0Swdenk  lots of low-level, hardware dependent stuff are done by U-Boot
3484c609719bSwdenk
3485c609719bSwdenk- the same Linux kernel image can now be used with different "initrd"
3486c609719bSwdenk  images; of course this also means that different kernel images can
3487c609719bSwdenk  be run with the same "initrd". This makes testing easier (you don't
3488c609719bSwdenk  have to build a new "zImage.initrd" Linux image when you just
3489c609719bSwdenk  change a file in your "initrd"). Also, a field-upgrade of the
3490c609719bSwdenk  software is easier now.
3491c609719bSwdenk
3492c609719bSwdenk
3493c609719bSwdenkLinux HOWTO:
3494c609719bSwdenk============
3495c609719bSwdenk
3496c609719bSwdenkPorting Linux to U-Boot based systems:
3497c609719bSwdenk---------------------------------------
3498c609719bSwdenk
3499c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to
3500c609719bSwdenkconfigure the Linux device drivers for use with your target hardware
3501c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to
3502c609719bSwdenkLinux :-).
3503c609719bSwdenk
3504a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
3505c609719bSwdenk
3506c609719bSwdenkJust make sure your machine specific header file (for instance
3507c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board
35081dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h,
35091dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value
35106d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR.
3511c609719bSwdenk
3512c609719bSwdenk
3513c609719bSwdenkConfiguring the Linux kernel:
3514c609719bSwdenk-----------------------------
3515c609719bSwdenk
3516c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root
3517c609719bSwdenkdevice (initial ramdisk, NFS) for your target system.
3518c609719bSwdenk
3519c609719bSwdenk
3520c609719bSwdenkBuilding a Linux Image:
3521c609719bSwdenk-----------------------
3522c609719bSwdenk
352324ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are
352424ee89b9Swdenknot used. If you use recent kernel source, a new build target
352524ee89b9Swdenk"uImage" will exist which automatically builds an image usable by
352624ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target,
352724ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a
352824ee89b9Swdenk100% compatible format.
3529c609719bSwdenk
3530c609719bSwdenkExample:
3531c609719bSwdenk
3532c609719bSwdenk	make TQM850L_config
3533c609719bSwdenk	make oldconfig
3534c609719bSwdenk	make dep
353524ee89b9Swdenk	make uImage
3536c609719bSwdenk
353724ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to
353824ee89b9Swdenkencapsulate a compressed Linux kernel image with header	 information,
353924ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing:
3540c609719bSwdenk
354124ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format):
354224ee89b9Swdenk
354324ee89b9Swdenk* convert the kernel into a raw binary image:
354424ee89b9Swdenk
354524ee89b9Swdenk	${CROSS_COMPILE}-objcopy -O binary \
354624ee89b9Swdenk				 -R .note -R .comment \
354724ee89b9Swdenk				 -S vmlinux linux.bin
354824ee89b9Swdenk
354924ee89b9Swdenk* compress the binary image:
355024ee89b9Swdenk
355124ee89b9Swdenk	gzip -9 linux.bin
355224ee89b9Swdenk
355324ee89b9Swdenk* package compressed binary image for U-Boot:
355424ee89b9Swdenk
355524ee89b9Swdenk	mkimage -A ppc -O linux -T kernel -C gzip \
355624ee89b9Swdenk		-a 0 -e 0 -n "Linux Kernel Image" \
355724ee89b9Swdenk		-d linux.bin.gz uImage
355824ee89b9Swdenk
355924ee89b9Swdenk
356024ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use
356124ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or
356224ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64
356324ee89b9Swdenkbyte header containing information about target architecture,
356424ee89b9Swdenkoperating system, image type, compression method, entry points, time
356524ee89b9Swdenkstamp, CRC32 checksums, etc.
356624ee89b9Swdenk
356724ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and
356824ee89b9Swdenkprint the header information, or to build new images.
3569c609719bSwdenk
3570c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information
3571c609719bSwdenkcontained in the header of an existing U-Boot image; this includes
3572c609719bSwdenkchecksum verification:
3573c609719bSwdenk
3574c609719bSwdenk	tools/mkimage -l image
3575c609719bSwdenk	  -l ==> list image header information
3576c609719bSwdenk
3577c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image
3578c609719bSwdenkfrom a "data file" which is used as image payload:
3579c609719bSwdenk
3580c609719bSwdenk	tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
3581c609719bSwdenk		      -n name -d data_file image
3582c609719bSwdenk	  -A ==> set architecture to 'arch'
3583c609719bSwdenk	  -O ==> set operating system to 'os'
3584c609719bSwdenk	  -T ==> set image type to 'type'
3585c609719bSwdenk	  -C ==> set compression type 'comp'
3586c609719bSwdenk	  -a ==> set load address to 'addr' (hex)
3587c609719bSwdenk	  -e ==> set entry point to 'ep' (hex)
3588c609719bSwdenk	  -n ==> set image name to 'name'
3589c609719bSwdenk	  -d ==> use image data from 'datafile'
3590c609719bSwdenk
359169459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load
359269459791Swdenkaddress (0x00000000), but the entry point address depends on the
359369459791Swdenkkernel version:
3594c609719bSwdenk
3595c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C,
359624ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000.
3597c609719bSwdenk
3598c609719bSwdenkSo a typical call to build a U-Boot image would read:
3599c609719bSwdenk
360024ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
360124ee89b9Swdenk	> -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
3602a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
360324ee89b9Swdenk	> examples/uImage.TQM850L
360424ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
3605c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
3606c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
3607c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
3608c609719bSwdenk	Load Address: 0x00000000
360924ee89b9Swdenk	Entry Point:  0x00000000
3610c609719bSwdenk
3611c609719bSwdenkTo verify the contents of the image (or check for corruption):
3612c609719bSwdenk
361324ee89b9Swdenk	-> tools/mkimage -l examples/uImage.TQM850L
361424ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
3615c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
3616c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
3617c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
3618c609719bSwdenk	Load Address: 0x00000000
361924ee89b9Swdenk	Entry Point:  0x00000000
3620c609719bSwdenk
3621c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade
3622c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this
3623c609719bSwdenkneeds more space in Flash, but boots much faster since it does not
3624c609719bSwdenkneed to be uncompressed:
3625c609719bSwdenk
3626a47a12beSStefan Roese	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
362724ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
362824ee89b9Swdenk	> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
3629a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
363024ee89b9Swdenk	> examples/uImage.TQM850L-uncompressed
363124ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
3632c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
3633c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (uncompressed)
3634c609719bSwdenk	Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
3635c609719bSwdenk	Load Address: 0x00000000
363624ee89b9Swdenk	Entry Point:  0x00000000
3637c609719bSwdenk
3638c609719bSwdenk
3639c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file
3640c609719bSwdenkwhen your kernel is intended to use an initial ramdisk:
3641c609719bSwdenk
3642c609719bSwdenk	-> tools/mkimage -n 'Simple Ramdisk Image' \
3643c609719bSwdenk	> -A ppc -O linux -T ramdisk -C gzip \
3644c609719bSwdenk	> -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
3645c609719bSwdenk	Image Name:   Simple Ramdisk Image
3646c609719bSwdenk	Created:      Wed Jan 12 14:01:50 2000
3647c609719bSwdenk	Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
3648c609719bSwdenk	Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
3649c609719bSwdenk	Load Address: 0x00000000
3650c609719bSwdenk	Entry Point:  0x00000000
3651c609719bSwdenk
3652c609719bSwdenk
3653c609719bSwdenkInstalling a Linux Image:
3654c609719bSwdenk-------------------------
3655c609719bSwdenk
3656c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface,
3657c609719bSwdenkyou must convert the image to S-Record format:
3658c609719bSwdenk
3659c609719bSwdenk	objcopy -I binary -O srec examples/image examples/image.srec
3660c609719bSwdenk
3661c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot
3662c609719bSwdenkimage header, so the resulting S-Record file will be relative to
3663c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to
3664c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads'
3665c609719bSwdenkcommand.
3666c609719bSwdenk
3667c609719bSwdenkExample: install the image to address 0x40100000 (which on the
3668c609719bSwdenkTQM8xxL is in the first Flash bank):
3669c609719bSwdenk
3670c609719bSwdenk	=> erase 40100000 401FFFFF
3671c609719bSwdenk
3672c609719bSwdenk	.......... done
3673c609719bSwdenk	Erased 8 sectors
3674c609719bSwdenk
3675c609719bSwdenk	=> loads 40100000
3676c609719bSwdenk	## Ready for S-Record download ...
3677c609719bSwdenk	~>examples/image.srec
3678c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 12 13 ...
3679c609719bSwdenk	...
3680c609719bSwdenk	15989 15990 15991 15992
3681c609719bSwdenk	[file transfer complete]
3682c609719bSwdenk	[connected]
3683c609719bSwdenk	## Start Addr = 0x00000000
3684c609719bSwdenk
3685c609719bSwdenk
3686c609719bSwdenkYou can check the success of the download using the 'iminfo' command;
3687c609719bSwdenkthis includes a checksum verification so you can be sure no data
3688c609719bSwdenkcorruption happened:
3689c609719bSwdenk
3690c609719bSwdenk	=> imi 40100000
3691c609719bSwdenk
3692c609719bSwdenk	## Checking Image at 40100000 ...
3693c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
3694c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3695c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
3696c609719bSwdenk	   Load Address: 00000000
3697c609719bSwdenk	   Entry Point:	 0000000c
3698c609719bSwdenk	   Verifying Checksum ... OK
3699c609719bSwdenk
3700c609719bSwdenk
3701c609719bSwdenkBoot Linux:
3702c609719bSwdenk-----------
3703c609719bSwdenk
3704c609719bSwdenkThe "bootm" command is used to boot an application that is stored in
3705c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents
3706c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as
3707c609719bSwdenkparameters. You can check and modify this variable using the
3708c609719bSwdenk"printenv" and "setenv" commands:
3709c609719bSwdenk
3710c609719bSwdenk
3711c609719bSwdenk	=> printenv bootargs
3712c609719bSwdenk	bootargs=root=/dev/ram
3713c609719bSwdenk
3714c609719bSwdenk	=> setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3715c609719bSwdenk
3716c609719bSwdenk	=> printenv bootargs
3717c609719bSwdenk	bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3718c609719bSwdenk
3719c609719bSwdenk	=> bootm 40020000
3720c609719bSwdenk	## Booting Linux kernel at 40020000 ...
3721c609719bSwdenk	   Image Name:	 2.2.13 for NFS on TQM850L
3722c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3723c609719bSwdenk	   Data Size:	 381681 Bytes = 372 kB = 0 MB
3724c609719bSwdenk	   Load Address: 00000000
3725c609719bSwdenk	   Entry Point:	 0000000c
3726c609719bSwdenk	   Verifying Checksum ... OK
3727c609719bSwdenk	   Uncompressing Kernel Image ... OK
3728c609719bSwdenk	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
3729c609719bSwdenk	Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3730c609719bSwdenk	time_init: decrementer frequency = 187500000/60
3731c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
3732c609719bSwdenk	Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
3733c609719bSwdenk	...
3734c609719bSwdenk
373511ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass
37367152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT
3737c609719bSwdenkformat!) to the "bootm" command:
3738c609719bSwdenk
3739c609719bSwdenk	=> imi 40100000 40200000
3740c609719bSwdenk
3741c609719bSwdenk	## Checking Image at 40100000 ...
3742c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
3743c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3744c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
3745c609719bSwdenk	   Load Address: 00000000
3746c609719bSwdenk	   Entry Point:	 0000000c
3747c609719bSwdenk	   Verifying Checksum ... OK
3748c609719bSwdenk
3749c609719bSwdenk	## Checking Image at 40200000 ...
3750c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
3751c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
3752c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
3753c609719bSwdenk	   Load Address: 00000000
3754c609719bSwdenk	   Entry Point:	 00000000
3755c609719bSwdenk	   Verifying Checksum ... OK
3756c609719bSwdenk
3757c609719bSwdenk	=> bootm 40100000 40200000
3758c609719bSwdenk	## Booting Linux kernel at 40100000 ...
3759c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
3760c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3761c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
3762c609719bSwdenk	   Load Address: 00000000
3763c609719bSwdenk	   Entry Point:	 0000000c
3764c609719bSwdenk	   Verifying Checksum ... OK
3765c609719bSwdenk	   Uncompressing Kernel Image ... OK
3766c609719bSwdenk	## Loading RAMDisk Image at 40200000 ...
3767c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
3768c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
3769c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
3770c609719bSwdenk	   Load Address: 00000000
3771c609719bSwdenk	   Entry Point:	 00000000
3772c609719bSwdenk	   Verifying Checksum ... OK
3773c609719bSwdenk	   Loading Ramdisk ... OK
3774c609719bSwdenk	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
3775c609719bSwdenk	Boot arguments: root=/dev/ram
3776c609719bSwdenk	time_init: decrementer frequency = 187500000/60
3777c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
3778c609719bSwdenk	...
3779c609719bSwdenk	RAMDISK: Compressed image found at block 0
3780c609719bSwdenk	VFS: Mounted root (ext2 filesystem).
3781c609719bSwdenk
3782c609719bSwdenk	bash#
3783c609719bSwdenk
37840267768eSMatthew McClintockBoot Linux and pass a flat device tree:
37850267768eSMatthew McClintock-----------
37860267768eSMatthew McClintock
37870267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section
37880267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The
37890267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated
37900267768eSMatthew McClintockflat device tree:
37910267768eSMatthew McClintock
37920267768eSMatthew McClintock=> print oftaddr
37930267768eSMatthew McClintockoftaddr=0x300000
37940267768eSMatthew McClintock=> print oft
37950267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb
37960267768eSMatthew McClintock=> tftp $oftaddr $oft
37970267768eSMatthew McClintockSpeed: 1000, full duplex
37980267768eSMatthew McClintockUsing TSEC0 device
37990267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101
38000267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'.
38010267768eSMatthew McClintockLoad address: 0x300000
38020267768eSMatthew McClintockLoading: #
38030267768eSMatthew McClintockdone
38040267768eSMatthew McClintockBytes transferred = 4106 (100a hex)
38050267768eSMatthew McClintock=> tftp $loadaddr $bootfile
38060267768eSMatthew McClintockSpeed: 1000, full duplex
38070267768eSMatthew McClintockUsing TSEC0 device
38080267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2
38090267768eSMatthew McClintockFilename 'uImage'.
38100267768eSMatthew McClintockLoad address: 0x200000
38110267768eSMatthew McClintockLoading:############
38120267768eSMatthew McClintockdone
38130267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex)
38140267768eSMatthew McClintock=> print loadaddr
38150267768eSMatthew McClintockloadaddr=200000
38160267768eSMatthew McClintock=> print oftaddr
38170267768eSMatthew McClintockoftaddr=0x300000
38180267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr
38190267768eSMatthew McClintock## Booting image at 00200000 ...
38200267768eSMatthew McClintock   Image Name:	 Linux-2.6.17-dirty
38210267768eSMatthew McClintock   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
38220267768eSMatthew McClintock   Data Size:	 1029343 Bytes = 1005.2 kB
38230267768eSMatthew McClintock   Load Address: 00000000
38240267768eSMatthew McClintock   Entry Point:	 00000000
38250267768eSMatthew McClintock   Verifying Checksum ... OK
38260267768eSMatthew McClintock   Uncompressing Kernel Image ... OK
38270267768eSMatthew McClintockBooting using flat device tree at 0x300000
38280267768eSMatthew McClintockUsing MPC85xx ADS machine description
38290267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
38300267768eSMatthew McClintock[snip]
38310267768eSMatthew McClintock
38320267768eSMatthew McClintock
38336069ff26SwdenkMore About U-Boot Image Types:
38346069ff26Swdenk------------------------------
38356069ff26Swdenk
38366069ff26SwdenkU-Boot supports the following image types:
38376069ff26Swdenk
38386069ff26Swdenk   "Standalone Programs" are directly runnable in the environment
38396069ff26Swdenk	provided by U-Boot; it is expected that (if they behave
38406069ff26Swdenk	well) you can continue to work in U-Boot after return from
38416069ff26Swdenk	the Standalone Program.
38426069ff26Swdenk   "OS Kernel Images" are usually images of some Embedded OS which
38436069ff26Swdenk	will take over control completely. Usually these programs
38446069ff26Swdenk	will install their own set of exception handlers, device
38456069ff26Swdenk	drivers, set up the MMU, etc. - this means, that you cannot
38466069ff26Swdenk	expect to re-enter U-Boot except by resetting the CPU.
38476069ff26Swdenk   "RAMDisk Images" are more or less just data blocks, and their
38486069ff26Swdenk	parameters (address, size) are passed to an OS kernel that is
38496069ff26Swdenk	being started.
38506069ff26Swdenk   "Multi-File Images" contain several images, typically an OS
38516069ff26Swdenk	(Linux) kernel image and one or more data images like
38526069ff26Swdenk	RAMDisks. This construct is useful for instance when you want
38536069ff26Swdenk	to boot over the network using BOOTP etc., where the boot
38546069ff26Swdenk	server provides just a single image file, but you want to get
38556069ff26Swdenk	for instance an OS kernel and a RAMDisk image.
38566069ff26Swdenk
38576069ff26Swdenk	"Multi-File Images" start with a list of image sizes, each
38586069ff26Swdenk	image size (in bytes) specified by an "uint32_t" in network
38596069ff26Swdenk	byte order. This list is terminated by an "(uint32_t)0".
38606069ff26Swdenk	Immediately after the terminating 0 follow the images, one by
38616069ff26Swdenk	one, all aligned on "uint32_t" boundaries (size rounded up to
38626069ff26Swdenk	a multiple of 4 bytes).
38636069ff26Swdenk
38646069ff26Swdenk   "Firmware Images" are binary images containing firmware (like
38656069ff26Swdenk	U-Boot or FPGA images) which usually will be programmed to
38666069ff26Swdenk	flash memory.
38676069ff26Swdenk
38686069ff26Swdenk   "Script files" are command sequences that will be executed by
38696069ff26Swdenk	U-Boot's command interpreter; this feature is especially
38706069ff26Swdenk	useful when you configure U-Boot to use a real shell (hush)
38716069ff26Swdenk	as command interpreter.
38726069ff26Swdenk
3873c609719bSwdenk
3874c609719bSwdenkStandalone HOWTO:
3875c609719bSwdenk=================
3876c609719bSwdenk
3877c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and
3878c609719bSwdenkrun "standalone" applications, which can use some resources of
3879c609719bSwdenkU-Boot like console I/O functions or interrupt services.
3880c609719bSwdenk
3881c609719bSwdenkTwo simple examples are included with the sources:
3882c609719bSwdenk
3883c609719bSwdenk"Hello World" Demo:
3884c609719bSwdenk-------------------
3885c609719bSwdenk
3886c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo
3887c609719bSwdenkapplication; it is automatically compiled when you build U-Boot.
3888c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it
3889c609719bSwdenklike that:
3890c609719bSwdenk
3891c609719bSwdenk	=> loads
3892c609719bSwdenk	## Ready for S-Record download ...
3893c609719bSwdenk	~>examples/hello_world.srec
3894c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
3895c609719bSwdenk	[file transfer complete]
3896c609719bSwdenk	[connected]
3897c609719bSwdenk	## Start Addr = 0x00040004
3898c609719bSwdenk
3899c609719bSwdenk	=> go 40004 Hello World! This is a test.
3900c609719bSwdenk	## Starting application at 0x00040004 ...
3901c609719bSwdenk	Hello World
3902c609719bSwdenk	argc = 7
3903c609719bSwdenk	argv[0] = "40004"
3904c609719bSwdenk	argv[1] = "Hello"
3905c609719bSwdenk	argv[2] = "World!"
3906c609719bSwdenk	argv[3] = "This"
3907c609719bSwdenk	argv[4] = "is"
3908c609719bSwdenk	argv[5] = "a"
3909c609719bSwdenk	argv[6] = "test."
3910c609719bSwdenk	argv[7] = "<NULL>"
3911c609719bSwdenk	Hit any key to exit ...
3912c609719bSwdenk
3913c609719bSwdenk	## Application terminated, rc = 0x0
3914c609719bSwdenk
3915c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt
3916c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'.
3917c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second.
3918c609719bSwdenkThe interrupt service routine is trivial, just printing a '.'
3919c609719bSwdenkcharacter, but this is just a demo program. The application can be
3920c609719bSwdenkcontrolled by the following keys:
3921c609719bSwdenk
3922c609719bSwdenk	? - print current values og the CPM Timer registers
3923c609719bSwdenk	b - enable interrupts and start timer
3924c609719bSwdenk	e - stop timer and disable interrupts
3925c609719bSwdenk	q - quit application
3926c609719bSwdenk
3927c609719bSwdenk	=> loads
3928c609719bSwdenk	## Ready for S-Record download ...
3929c609719bSwdenk	~>examples/timer.srec
3930c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
3931c609719bSwdenk	[file transfer complete]
3932c609719bSwdenk	[connected]
3933c609719bSwdenk	## Start Addr = 0x00040004
3934c609719bSwdenk
3935c609719bSwdenk	=> go 40004
3936c609719bSwdenk	## Starting application at 0x00040004 ...
3937c609719bSwdenk	TIMERS=0xfff00980
3938c609719bSwdenk	Using timer 1
3939c609719bSwdenk	  tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
3940c609719bSwdenk
3941c609719bSwdenkHit 'b':
3942c609719bSwdenk	[q, b, e, ?] Set interval 1000000 us
3943c609719bSwdenk	Enabling timer
3944c609719bSwdenkHit '?':
3945c609719bSwdenk	[q, b, e, ?] ........
3946c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
3947c609719bSwdenkHit '?':
3948c609719bSwdenk	[q, b, e, ?] .
3949c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
3950c609719bSwdenkHit '?':
3951c609719bSwdenk	[q, b, e, ?] .
3952c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
3953c609719bSwdenkHit '?':
3954c609719bSwdenk	[q, b, e, ?] .
3955c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
3956c609719bSwdenkHit 'e':
3957c609719bSwdenk	[q, b, e, ?] ...Stopping timer
3958c609719bSwdenkHit 'q':
3959c609719bSwdenk	[q, b, e, ?] ## Application terminated, rc = 0x0
3960c609719bSwdenk
3961c609719bSwdenk
396285ec0bccSwdenkMinicom warning:
396385ec0bccSwdenk================
396485ec0bccSwdenk
39657152b1d0SwdenkOver time, many people have reported problems when trying to use the
396685ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd)
396785ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under
3968f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and
396985ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and
397085ec0bccSwdenkuse "cu" for S-Record download ("loads" command).
397185ec0bccSwdenk
397252f52c14SwdenkNevertheless, if you absolutely want to use it try adding this
397352f52c14Swdenkconfiguration to your "File transfer protocols" section:
397452f52c14Swdenk
397552f52c14Swdenk	   Name	   Program			Name U/D FullScr IO-Red. Multi
397652f52c14Swdenk	X  kermit  /usr/bin/kermit -i -l %l -s	 Y    U	   Y	   N	  N
397752f52c14Swdenk	Y  kermit  /usr/bin/kermit -i -l %l -r	 N    D	   Y	   N	  N
397852f52c14Swdenk
397952f52c14Swdenk
3980c609719bSwdenkNetBSD Notes:
3981c609719bSwdenk=============
3982c609719bSwdenk
3983c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host
3984c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx).
3985c609719bSwdenk
3986c609719bSwdenkBuilding requires a cross environment; it is known to work on
3987c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
3988c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make).
3989c609719bSwdenkNote that the cross-powerpc package does not install include files;
3990c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is
3991c609719bSwdenkmissing.  This file has to be installed and patched manually:
3992c609719bSwdenk
3993c609719bSwdenk	# cd /usr/pkg/cross/powerpc-netbsd/include
3994c609719bSwdenk	# mkdir powerpc
3995c609719bSwdenk	# ln -s powerpc machine
3996c609719bSwdenk	# cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
3997c609719bSwdenk	# ${EDIT} powerpc/ansi.h	## must remove __va_list, _BSD_VA_LIST
3998c609719bSwdenk
3999c609719bSwdenkNative builds *don't* work due to incompatibilities between native
4000c609719bSwdenkand U-Boot include files.
4001c609719bSwdenk
4002c609719bSwdenkBooting assumes that (the first part of) the image booted is a
4003c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel
4004c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source
4005c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
40062a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
4007c609719bSwdenk
4008c609719bSwdenk
4009c609719bSwdenkImplementation Internals:
4010c609719bSwdenk=========================
4011c609719bSwdenk
4012c609719bSwdenkThe following is not intended to be a complete description of every
4013c609719bSwdenkimplementation detail. However, it should help to understand the
4014c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom
4015c609719bSwdenkhardware.
4016c609719bSwdenk
4017c609719bSwdenk
4018c609719bSwdenkInitial Stack, Global Data:
4019c609719bSwdenk---------------------------
4020c609719bSwdenk
4021c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot
4022c609719bSwdenkstarts running out of ROM (flash memory), usually without access to
4023c609719bSwdenksystem RAM (because the memory controller is not initialized yet).
4024c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS
4025c609719bSwdenkis not initialized as zero. To be able to get a C environment working
4026c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation
4027c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU
4028c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and
4029c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be
4030c609719bSwdenklocked as (mis-) used as memory, etc.
4031c609719bSwdenk
40327152b1d0Swdenk	Chris Hallinan posted a good summary of these issues to the
40330668236bSWolfgang Denk	U-Boot mailing list:
403443d9616cSwdenk
403543d9616cSwdenk	Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
403643d9616cSwdenk	From: "Chris Hallinan" <clh@net1plus.com>
403743d9616cSwdenk	Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
403843d9616cSwdenk	...
403943d9616cSwdenk
404043d9616cSwdenk	Correct me if I'm wrong, folks, but the way I understand it
404143d9616cSwdenk	is this: Using DCACHE as initial RAM for Stack, etc, does not
404243d9616cSwdenk	require any physical RAM backing up the cache. The cleverness
404343d9616cSwdenk	is that the cache is being used as a temporary supply of
404443d9616cSwdenk	necessary storage before the SDRAM controller is setup. It's
404511ccc33fSMarcel Ziswiler	beyond the scope of this list to explain the details, but you
404643d9616cSwdenk	can see how this works by studying the cache architecture and
404743d9616cSwdenk	operation in the architecture and processor-specific manuals.
404843d9616cSwdenk
404943d9616cSwdenk	OCM is On Chip Memory, which I believe the 405GP has 4K. It
405043d9616cSwdenk	is another option for the system designer to use as an
405111ccc33fSMarcel Ziswiler	initial stack/RAM area prior to SDRAM being available. Either
405243d9616cSwdenk	option should work for you. Using CS 4 should be fine if your
405343d9616cSwdenk	board designers haven't used it for something that would
405443d9616cSwdenk	cause you grief during the initial boot! It is frequently not
405543d9616cSwdenk	used.
405643d9616cSwdenk
40576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
405843d9616cSwdenk	with your processor/board/system design. The default value
405943d9616cSwdenk	you will find in any recent u-boot distribution in
40608a316c9bSStefan Roese	walnut.h should work for you. I'd set it to a value larger
406143d9616cSwdenk	than your SDRAM module. If you have a 64MB SDRAM module, set
406243d9616cSwdenk	it above 400_0000. Just make sure your board has no resources
406343d9616cSwdenk	that are supposed to respond to that address! That code in
406443d9616cSwdenk	start.S has been around a while and should work as is when
406543d9616cSwdenk	you get the config right.
406643d9616cSwdenk
406743d9616cSwdenk	-Chris Hallinan
406843d9616cSwdenk	DS4.COM, Inc.
406943d9616cSwdenk
4070c609719bSwdenkIt is essential to remember this, since it has some impact on the C
4071c609719bSwdenkcode for the initialization procedures:
4072c609719bSwdenk
4073c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt
4074c609719bSwdenk  to write it.
4075c609719bSwdenk
407611ccc33fSMarcel Ziswiler* Do not use any uninitialized global data (or implicitely initialized
4077c609719bSwdenk  as zero data - BSS segment) at all - this is undefined, initiali-
40787152b1d0Swdenk  zation is performed later (when relocating to RAM).
4079c609719bSwdenk
4080c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like
4081c609719bSwdenk  that.
4082c609719bSwdenk
4083c609719bSwdenkHaving only the stack as writable memory limits means we cannot use
4084c609719bSwdenknormal global data to share information beween the code. But it
4085c609719bSwdenkturned out that the implementation of U-Boot can be greatly
4086c609719bSwdenksimplified by making a global data structure (gd_t) available to all
4087c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_
4088c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of
4089c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we
4090c609719bSwdenkplace a pointer (gd) to the global data into a register which we
4091c609719bSwdenkreserve for this purpose.
4092c609719bSwdenk
40937152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the
4094c609719bSwdenkrelevant  (E)ABI  specifications for the current architecture, and by
4095c609719bSwdenkGCC's implementation.
4096c609719bSwdenk
4097c609719bSwdenkFor PowerPC, the following registers have specific use:
4098c609719bSwdenk	R1:	stack pointer
4099e7670f6cSWolfgang Denk	R2:	reserved for system use
4100c609719bSwdenk	R3-R4:	parameter passing and return values
4101c609719bSwdenk	R5-R10: parameter passing
4102c609719bSwdenk	R13:	small data area pointer
4103c609719bSwdenk	R30:	GOT pointer
4104c609719bSwdenk	R31:	frame pointer
4105c609719bSwdenk
4106e6bee808SJoakim Tjernlund	(U-Boot also uses R12 as internal GOT pointer. r12
4107e6bee808SJoakim Tjernlund	is a volatile register so r12 needs to be reset when
4108e6bee808SJoakim Tjernlund	going back and forth between asm and C)
4109c609719bSwdenk
4110e7670f6cSWolfgang Denk    ==> U-Boot will use R2 to hold a pointer to the global data
4111c609719bSwdenk
4112c609719bSwdenk    Note: on PPC, we could use a static initializer (since the
4113c609719bSwdenk    address of the global data structure is known at compile time),
4114c609719bSwdenk    but it turned out that reserving a register results in somewhat
4115c609719bSwdenk    smaller code - although the code savings are not that big (on
4116c609719bSwdenk    average for all boards 752 bytes for the whole U-Boot image,
4117c609719bSwdenk    624 text + 127 data).
4118c609719bSwdenk
4119c4db335cSRobin GetzOn Blackfin, the normal C ABI (except for P3) is followed as documented here:
41204c58eb55SMike Frysinger	http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
41214c58eb55SMike Frysinger
4122c4db335cSRobin Getz    ==> U-Boot will use P3 to hold a pointer to the global data
41234c58eb55SMike Frysinger
4124c609719bSwdenkOn ARM, the following registers are used:
4125c609719bSwdenk
4126c609719bSwdenk	R0:	function argument word/integer result
4127c609719bSwdenk	R1-R3:	function argument word
4128c609719bSwdenk	R9:	GOT pointer
4129c609719bSwdenk	R10:	stack limit (used only if stack checking if enabled)
4130c609719bSwdenk	R11:	argument (frame) pointer
4131c609719bSwdenk	R12:	temporary workspace
4132c609719bSwdenk	R13:	stack pointer
4133c609719bSwdenk	R14:	link register
4134c609719bSwdenk	R15:	program counter
4135c609719bSwdenk
4136c609719bSwdenk    ==> U-Boot will use R8 to hold a pointer to the global data
4137c609719bSwdenk
41380df01fd3SThomas ChouOn Nios II, the ABI is documented here:
41390df01fd3SThomas Chou	http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
41400df01fd3SThomas Chou
41410df01fd3SThomas Chou    ==> U-Boot will use gp to hold a pointer to the global data
41420df01fd3SThomas Chou
41430df01fd3SThomas Chou    Note: on Nios II, we give "-G0" option to gcc and don't use gp
41440df01fd3SThomas Chou    to access small data sections, so gp is free.
41450df01fd3SThomas Chou
4146d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
4147d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much.
4148c609719bSwdenk
4149c609719bSwdenkMemory Management:
4150c609719bSwdenk------------------
4151c609719bSwdenk
4152c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the
4153c609719bSwdenkMMU is not used either for address mapping nor for memory protection.
4154c609719bSwdenk
4155c609719bSwdenkThe available memory is mapped to fixed addresses using the memory
4156c609719bSwdenkcontroller. In this process, a contiguous block is formed for each
4157c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several
4158c609719bSwdenkphysical memory banks.
4159c609719bSwdenk
4160c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on
4161c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
4162c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself
4163c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some
41646d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
4165c609719bSwdenkconfiguration setting]. Below that, a structure with global Board
4166c609719bSwdenkInfo data is placed, followed by the stack (growing downward).
4167c609719bSwdenk
4168c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB
4169c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF).
4170c609719bSwdenk
4171c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like
4172c609719bSwdenkthis:
4173c609719bSwdenk
4174c609719bSwdenk	0x0000 0000	Exception Vector code
4175c609719bSwdenk	      :
4176c609719bSwdenk	0x0000 1FFF
4177c609719bSwdenk	0x0000 2000	Free for Application Use
4178c609719bSwdenk	      :
4179c609719bSwdenk	      :
4180c609719bSwdenk
4181c609719bSwdenk	      :
4182c609719bSwdenk	      :
4183c609719bSwdenk	0x00FB FF20	Monitor Stack (Growing downward)
4184c609719bSwdenk	0x00FB FFAC	Board Info Data and permanent copy of global data
4185c609719bSwdenk	0x00FC 0000	Malloc Arena
4186c609719bSwdenk	      :
4187c609719bSwdenk	0x00FD FFFF
4188c609719bSwdenk	0x00FE 0000	RAM Copy of Monitor Code
4189c609719bSwdenk	...		eventually: LCD or video framebuffer
4190c609719bSwdenk	...		eventually: pRAM (Protected RAM - unchanged by reset)
4191c609719bSwdenk	0x00FF FFFF	[End of RAM]
4192c609719bSwdenk
4193c609719bSwdenk
4194c609719bSwdenkSystem Initialization:
4195c609719bSwdenk----------------------
4196c609719bSwdenk
4197c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point
419811ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset
4199c609719bSwdenkconfiguration for CS0# this is a mirror of the onboard Flash memory.
42007152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address.
4201c609719bSwdenkTo be able to implement the initialization code in C, a (small!)
4202c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs
4203c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked
4204c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core,
4205c609719bSwdenkthe caches and the SIU.
4206c609719bSwdenk
4207c609719bSwdenkNext, all (potentially) available memory banks are mapped using a
4208c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries
4209c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
4210c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
4211c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a
4212c609719bSwdenksimple memory test is run that determines the size of the SDRAM
4213c609719bSwdenkbanks.
4214c609719bSwdenk
4215c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of
42167152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first
4217c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address
4218c609719bSwdenk0x00000000, with any additional banks following immediately to create
4219c609719bSwdenkcontiguous memory starting from 0.
4220c609719bSwdenk
4221c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area
4222c609719bSwdenkand allocates memory for use by malloc() and for the global Board
4223c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM
4224c609719bSwdenkpages, and the final stack is set up.
4225c609719bSwdenk
4226c609719bSwdenkOnly after this relocation will you have a "normal" C environment;
4227c609719bSwdenkuntil that you are restricted in several ways, mostly because you are
4228c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a
4229c609719bSwdenknew address in RAM.
4230c609719bSwdenk
4231c609719bSwdenk
4232c609719bSwdenkU-Boot Porting Guide:
4233c609719bSwdenk----------------------
4234c609719bSwdenk
4235c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
42366aff3115Swdenklist, October 2002]
4237c609719bSwdenk
4238c609719bSwdenk
4239c609719bSwdenkint main(int argc, char *argv[])
4240c609719bSwdenk{
4241c609719bSwdenk	sighandler_t no_more_time;
4242c609719bSwdenk
4243c609719bSwdenk	signal(SIGALRM, no_more_time);
4244c609719bSwdenk	alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
4245c609719bSwdenk
4246c609719bSwdenk	if (available_money > available_manpower) {
42476c3fef28SJerry Van Baren		Pay consultant to port U-Boot;
4248c609719bSwdenk		return 0;
4249c609719bSwdenk	}
4250c609719bSwdenk
4251c609719bSwdenk	Download latest U-Boot source;
4252c609719bSwdenk
42530668236bSWolfgang Denk	Subscribe to u-boot mailing list;
42546aff3115Swdenk
42556c3fef28SJerry Van Baren	if (clueless)
4256c609719bSwdenk		email("Hi, I am new to U-Boot, how do I get started?");
4257c609719bSwdenk
4258c609719bSwdenk	while (learning) {
4259c609719bSwdenk		Read the README file in the top level directory;
42607cb22f97Swdenk		Read http://www.denx.de/twiki/bin/view/DULG/Manual;
42616c3fef28SJerry Van Baren		Read applicable doc/*.README;
4262c609719bSwdenk		Read the source, Luke;
42636c3fef28SJerry Van Baren		/* find . -name "*.[chS]" | xargs grep -i <keyword> */
4264c609719bSwdenk	}
4265c609719bSwdenk
42666c3fef28SJerry Van Baren	if (available_money > toLocalCurrency ($2500))
42676c3fef28SJerry Van Baren		Buy a BDI3000;
42686c3fef28SJerry Van Baren	else
4269c609719bSwdenk		Add a lot of aggravation and time;
4270c609719bSwdenk
42716c3fef28SJerry Van Baren	if (a similar board exists) {	/* hopefully... */
42726c3fef28SJerry Van Baren		cp -a board/<similar> board/<myboard>
42736c3fef28SJerry Van Baren		cp include/configs/<similar>.h include/configs/<myboard>.h
42746c3fef28SJerry Van Baren	} else {
4275c609719bSwdenk		Create your own board support subdirectory;
42766c3fef28SJerry Van Baren		Create your own board include/configs/<myboard>.h file;
42776c3fef28SJerry Van Baren	}
42786c3fef28SJerry Van Baren	Edit new board/<myboard> files
42796c3fef28SJerry Van Baren	Edit new include/configs/<myboard>.h
4280c609719bSwdenk
42816c3fef28SJerry Van Baren	while (!accepted) {
4282c609719bSwdenk		while (!running) {
4283c609719bSwdenk			do {
4284c609719bSwdenk				Add / modify source code;
4285c609719bSwdenk			} until (compiles);
4286c609719bSwdenk			Debug;
4287c609719bSwdenk			if (clueless)
4288c609719bSwdenk				email("Hi, I am having problems...");
4289c609719bSwdenk		}
42906c3fef28SJerry Van Baren		Send patch file to the U-Boot email list;
42916c3fef28SJerry Van Baren		if (reasonable critiques)
42926c3fef28SJerry Van Baren			Incorporate improvements from email list code review;
42936c3fef28SJerry Van Baren		else
42946c3fef28SJerry Van Baren			Defend code as written;
42956c3fef28SJerry Van Baren	}
4296c609719bSwdenk
4297c609719bSwdenk	return 0;
4298c609719bSwdenk}
4299c609719bSwdenk
4300c609719bSwdenkvoid no_more_time (int sig)
4301c609719bSwdenk{
4302c609719bSwdenk      hire_a_guru();
4303c609719bSwdenk}
4304c609719bSwdenk
4305c609719bSwdenk
4306c609719bSwdenkCoding Standards:
4307c609719bSwdenk-----------------
4308c609719bSwdenk
4309c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel
43102c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script
43112c051651SDetlev Zundel"scripts/Lindent" in your Linux kernel source directory.  In sources
43122c051651SDetlev Zundeloriginating from U-Boot a style corresponding to "Lindent -pcs" (adding
43132c051651SDetlev Zundelspaces before parameters to function calls) is actually used.
4314c609719bSwdenk
43152c051651SDetlev ZundelSource files originating from a different project (for example the
43162c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not
43172c051651SDetlev Zundelreformated to ease subsequent migration to newer versions of those
43182c051651SDetlev Zundelsources.
43192c051651SDetlev Zundel
43202c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in
43212c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//)
43222c051651SDetlev Zundelin your code.
4323c609719bSwdenk
4324c178d3daSwdenkPlease also stick to the following formatting rules:
4325180d3f74Swdenk- remove any trailing white space
4326180d3f74Swdenk- use TAB characters for indentation, not spaces
4327180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds
4328180d3f74Swdenk- do not add more than 2 empty lines to source files
4329180d3f74Swdenk- do not add trailing empty lines to source files
4330180d3f74Swdenk
4331c609719bSwdenkSubmissions which do not conform to the standards may be returned
4332c609719bSwdenkwith a request to reformat the changes.
4333c609719bSwdenk
4334c609719bSwdenk
4335c609719bSwdenkSubmitting Patches:
4336c609719bSwdenk-------------------
4337c609719bSwdenk
4338c609719bSwdenkSince the number of patches for U-Boot is growing, we need to
4339c609719bSwdenkestablish some rules. Submissions which do not conform to these rules
4340c609719bSwdenkmay be rejected, even when they contain important and valuable stuff.
4341c609719bSwdenk
43420d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details.
4343218ca724SWolfgang Denk
43440668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
43450668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot
43460668236bSWolfgang Denk
4347c609719bSwdenkWhen you send a patch, please include the following information with
4348c609719bSwdenkit:
4349c609719bSwdenk
4350c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes
4351c609719bSwdenk  this bug. Please try to include a way of demonstrating that the
4352c609719bSwdenk  patch actually fixes something.
4353c609719bSwdenk
4354c609719bSwdenk* For new features: a description of the feature and your
4355c609719bSwdenk  implementation.
4356c609719bSwdenk
4357c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch)
4358c609719bSwdenk
4359c609719bSwdenk* For major contributions, your entry to the CREDITS file
4360c609719bSwdenk
4361c609719bSwdenk* When you add support for a new board, don't forget to add this
4362c609719bSwdenk  board to the MAKEALL script, too.
4363c609719bSwdenk
4364c609719bSwdenk* If your patch adds new configuration options, don't forget to
4365c609719bSwdenk  document these in the README file.
4366c609719bSwdenk
4367218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly*
4368218ca724SWolfgang Denk  recommended) you can easily generate the patch using the
4369218ca724SWolfgang Denk  "git-format-patch". If you then use "git-send-email" to send it to
4370218ca724SWolfgang Denk  the U-Boot mailing list, you will avoid most of the common problems
4371218ca724SWolfgang Denk  with some other mail clients.
4372c609719bSwdenk
4373218ca724SWolfgang Denk  If you cannot use git, use "diff -purN OLD NEW". If your version of
4374218ca724SWolfgang Denk  diff does not support these options, then get the latest version of
4375218ca724SWolfgang Denk  GNU diff.
43766dff5529Swdenk
4377218ca724SWolfgang Denk  The current directory when running this command shall be the parent
4378218ca724SWolfgang Denk  directory of the U-Boot source tree (i. e. please make sure that
4379218ca724SWolfgang Denk  your patch includes sufficient directory information for the
4380218ca724SWolfgang Denk  affected files).
4381218ca724SWolfgang Denk
4382218ca724SWolfgang Denk  We prefer patches as plain text. MIME attachments are discouraged,
4383218ca724SWolfgang Denk  and compressed attachments must not be used.
4384c609719bSwdenk
438552f52c14Swdenk* If one logical set of modifications affects or creates several
438652f52c14Swdenk  files, all these changes shall be submitted in a SINGLE patch file.
438752f52c14Swdenk
438852f52c14Swdenk* Changesets that contain different, unrelated modifications shall be
438952f52c14Swdenk  submitted as SEPARATE patches, one patch per changeset.
439052f52c14Swdenk
439152f52c14Swdenk
4392c609719bSwdenkNotes:
4393c609719bSwdenk
4394c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched
4395c609719bSwdenk  source tree and make sure that no errors or warnings are reported
4396c609719bSwdenk  for any of the boards.
4397c609719bSwdenk
4398c609719bSwdenk* Keep your modifications to the necessary minimum: A patch
4399c609719bSwdenk  containing several unrelated changes or arbitrary reformats will be
4400c609719bSwdenk  returned with a request to re-formatting / split it.
4401c609719bSwdenk
4402c609719bSwdenk* If you modify existing code, make sure that your new code does not
4403c609719bSwdenk  add to the memory footprint of the code ;-) Small is beautiful!
4404c609719bSwdenk  When adding new features, these should compile conditionally only
4405c609719bSwdenk  (using #ifdef), and the resulting code with the new feature
4406c609719bSwdenk  disabled must not need more memory than the old code without your
4407c609719bSwdenk  modification.
440890dc6704Swdenk
44090668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the
44100668236bSWolfgang Denk  u-boot mailing list. Bigger patches will be moderated. If they are
44110668236bSWolfgang Denk  reasonable and not too big, they will be acknowledged. But patches
44120668236bSWolfgang Denk  bigger than the size limit should be avoided.
4413